genesis-3d_engine/Engine/foundation/threading/win360/win360thread.h

227 lines
6.8 KiB
C
Raw Normal View History

#pragma once
/****************************************************************************
Copyright (c) 2006, Radon Labs GmbH
Copyright (c) 2011-2013,WebJet Business Division,CYOU
http://www.genesis-3d.com.cn
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
****************************************************************************/
#include "core/refcounted.h"
#include "threading/win360/win360event.h"
#include "threading/threadid.h"
#include "threading/ThreadRuntimeInfo.h"
#include "system/cpu.h"
#include "util/localstringatomtable.h"
//------------------------------------------------------------------------------
namespace Win360
{
class Win360Thread : public Core::RefCounted
{
__DeclareClass(Win360Thread);
public:
/// thread priorities
enum Priority
{
Low,
Normal,
High,
};
/// constructor
Win360Thread();
/// destructor
virtual ~Win360Thread();
/// set the thread priority
void SetPriority(Priority p);
/// get the thread priority
Priority GetPriority() const;
/// set cpu core on which the thread should be running
void SetCoreId(System::Cpu::CoreId coreId);
/// get the cpu core on which the thread should be running
System::Cpu::CoreId GetCoreId() const;
/// set stack size in bytes (default is 4 KByte)
void SetStackSize(SizeT s);
/// get stack size
SizeT GetStackSize() const;
/// set thread name
void SetName(const Util::String& n);
/// get thread name
const Util::String& GetName() const;
/// start executing the thread code, returns when thread has actually started
void Start();
/// request threading code to stop, returns when thread has actually finished
void Stop();
/// return true if thread has been started
bool IsRunning() const;
/// yield the thread (gives up current time slice)
static void YieldThread();
/// <20><><EFBFBD><EFBFBD><EFBFBD>̶߳<DFB3><CCB6><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ʱ<EFBFBD><CAB1><EFBFBD><EFBFBD>,ÿ<><C3BF><EFBFBD>߳<EFBFBD>ֻ<EFBFBD><D6BB><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>һ<EFBFBD>Ρ<EFBFBD><CEA1><EFBFBD><EFBFBD>̱߳<DFB3><CCB1><EFBFBD><EFBFBD>ڹ<EFBFBD><DAB9><EFBFBD><EFBFBD>̺߳ʹ<CCBA><CDB4><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>֮ǰ<D6AE><C7B0><EFBFBD>á<EFBFBD><C3A1><EFBFBD><EFBFBD><EFBFBD><EFBFBD>̱߳<DFB3><CCB1><EFBFBD><EFBFBD>ڸո<DAB8><D5B8><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ʹ<EFBFBD><CDB4><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>֮ǰ<D6AE><C7B0><EFBFBD>á<EFBFBD>
static void SetupMyThreadRunTime( const char* threadName );
/// <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>߳<EFBFBD><DFB3><EFBFBD><EFBFBD><EFBFBD>ʱ<EFBFBD><CAB1><EFBFBD><EFBFBD>.<2E><><EFBFBD>̱߳<DFB3><CCB1><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
static void DestoryThreadRunTime( bool isMainThread = false );
/// obtain name of thread from within thread context
static const char* GetMyThreadName();
/// get the thread ID of this thread
static Threading::ThreadId GetMyThreadId();
#if NEBULA3_DEBUG
struct ThreadDebugInfo
{
Util::String threadName;
Win360Thread::Priority threadPriority;
System::Cpu::CoreId threadCoreId;
SizeT threadStackSize;
};
/// query thread stats (debug mode only)
static Util::Array<ThreadDebugInfo> GetRunningThreadDebugInfos();
#endif
protected:
/// override this method if your thread loop needs a wakeup call before stopping
virtual void EmitWakeupSignal();
/// this method runs in the thread context
virtual void DoWork();
/// check if stop is requested, call from DoWork() to see if the thread proc should quit
bool ThreadStopRequested() const;
private:
/// internal thread proc helper function
static DWORD WINAPI ThreadProc(LPVOID self);
HANDLE threadHandle;
Win360Event threadStartedEvent;
Win360Event stopRequestEvent;
Priority priority;
SizeT stackSize;
Util::String name;
System::Cpu::CoreId coreId;
#if NEBULA3_DEBUG
static Threading::CriticalSection criticalSection;
static Util::List<Win360Thread*> ThreadList;
Util::List<Win360Thread*>::Iterator threadListIterator;
#endif
};
//------------------------------------------------------------------------------
/**
*/
inline void
Win360Thread::SetPriority(Priority p)
{
this->priority = p;
}
//------------------------------------------------------------------------------
/**
*/
inline Win360Thread::Priority
Win360Thread::GetPriority() const
{
return this->priority;
}
//------------------------------------------------------------------------------
/**
*/
inline void
Win360Thread::SetStackSize(SizeT s)
{
this->stackSize = s;
}
//------------------------------------------------------------------------------
/**
*/
inline SizeT
Win360Thread::GetStackSize() const
{
return this->stackSize;
}
//------------------------------------------------------------------------------
/**
If the derived DoWork() method is running in a loop it must regularly
check if the process wants the thread to terminate by calling
ThreadStopRequested() and simply return if the result is true. This
will cause the thread to shut down.
*/
inline bool
Win360Thread::ThreadStopRequested() const
{
return this->stopRequestEvent.Peek();
}
//------------------------------------------------------------------------------
/**
Set the thread's name. To obtain the current thread's name from anywhere
in the thread's execution context, call the static method
Thread::GetMyThreadName().
*/
inline void
Win360Thread::SetName(const Util::String& n)
{
n_assert(n.IsValid());
this->name = n;
}
//------------------------------------------------------------------------------
/**
Get the thread's name. This is the vanilla method which
returns the name member. To obtain the current thread's name from anywhere
in the thread's execution context, call the static method
Thread::GetMyThreadName().
*/
inline const Util::String&
Win360Thread::GetName() const
{
return this->name;
}
//------------------------------------------------------------------------------
/**
*/
inline void
Win360Thread::SetCoreId(System::Cpu::CoreId id)
{
this->coreId = id;
}
//------------------------------------------------------------------------------
/**
*/
inline System::Cpu::CoreId
Win360Thread::GetCoreId() const
{
return this->coreId;
}
//------------------------------------------------------------------------
}; // namespace Win360
//------------------------------------------------------------------------------