DeadlockDetect.h

Go to the documentation of this file.

 
// DeadlockDetect.h
 
// Declares the cDeadlockDetect class that tries to detect deadlocks and aborts the server when it detects one
 
/*
This class simply monitors each world's m_WorldAge, which is expected to grow on each tick.
If the world age doesn't grow for several seconds, it's either because the server is Super-overloaded,
or because the world tick thread hangs in a deadlock. We presume the latter and therefore kill the server.
Once we learn to write crashdumps programmatically, we should do so just before killing, to enable debugging.
*/
 
 
 
#pragma once
 
#include "OSSupport/IsThread.h"
 
 
 
 
 
class cDeadlockDetect:
    public cIsThread
{
    using Super = cIsThread;
 
public:
 
    cDeadlockDetect();
    virtual ~cDeadlockDetect() override;
 
    void Start(int a_IntervalSec);
 
    void TrackCriticalSection(cCriticalSection & a_CS, const AString & a_Name);
 
    void UntrackCriticalSection(cCriticalSection & a_CS);
 
protected:
    struct sWorldAge
    {
        cTickTimeLong m_Age;
 
        int m_NumCyclesSame;
    } ;
 
    typedef std::map<AString, sWorldAge> WorldAges;
 
    cCriticalSection m_CS;
 
    std::vector<std::pair<cCriticalSection *, AString>> m_TrackedCriticalSections;
 
    WorldAges m_WorldAges;
 
    int m_IntervalSec;
 
 
    // cIsThread overrides:
    virtual void Execute(void) override;
 
    void SetWorldAge(const AString & a_WorldName, cTickTimeLong a_Age);
 
    void CheckWorldAge(const AString & a_WorldName, cTickTimeLong a_Age);
 
    [[noreturn]] void DeadlockDetected(const AString & a_WorldName, cTickTimeLong a_WorldAge);
 
    void ListTrackedCSs();
} ;