UnixPlatformRunnableThread.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
/*=============================================================================================
    UnixRunnableThread.h: Unix platform threading functions
==============================================================================================*/
 
#pragma once
 
#include "CoreTypes.h"
#include "HAL/PThreadRunnableThread.h"
#include <signal.h> // for SIGSTKSZ
 
class Error;
 
class FRunnableThreadUnix : public FRunnableThreadPThread
{
    struct EConstants
    {
        enum
        {
            UnixThreadNameLimit = 15,           // the limit for thread name is just 15 chars :( http://man7.org/linux/man-pages/man3/pthread_setname_np.3.html
 
            CrashHandlerStackSize = SIGSTKSZ + 192 * 1024,  // should be at least SIGSTKSIZE, plus 192K because we do logging and symbolication in crash handler
            CrashHandlerStackSizeMin = SIGSTKSZ + 8 * 1024  // minimum allowed stack size
        };
    };
 
    void* ThreadCrashHandlingStack;
 
    void* StackGuardPageAddress;
 
    int BaselineNiceValue;
 
    bool bGotBaselineNiceValue;
 
public:
 
    static void *MainThreadSignalHandlerStack;
 
    static void *AllocCrashHandlerStack();
    static void FreeCrashHandlerStack(void *StackBuffer);
    static uint64 GetCrashHandlerStackSize();
 
    FRunnableThreadUnix()
        :   FRunnableThreadPThread()
        ,   ThreadCrashHandlingStack(nullptr)
        ,   StackGuardPageAddress(nullptr)
        ,   BaselineNiceValue(0)
        ,   bGotBaselineNiceValue(false)
    {
    }
 
    ~FRunnableThreadUnix()
    {
        // Call the parent destructor body before the parent does it - see comment on that function for explanation why.
        FRunnableThreadPThread_DestructorBody();
    }
 
    static bool SetupSignalHandlerStack(void* StackBuffer, const size_t StackBufferSize, void** OutStackGuardPageAddress);
 
protected:
 
    int32 TranslateThreadPriority(EThreadPriority Priority) override;
 
    void SetThreadPriority(EThreadPriority NewPriority) override;
 
    void SetThreadPriority(pthread_t InThread, EThreadPriority NewPriority) override;
 
private:
 
    void PreRun() override;
 
    void PostRun() override;
 
    uint32 AdjustStackSize(uint32 InStackSize) override;
};