From f9e6de5284aaacd55aa389445cd595bdcaa8339e Mon Sep 17 00:00:00 2001 From: danieldg Date: Mon, 23 Mar 2009 18:48:42 +0000 Subject: ThreadEngine: remove MutexFactory, mutexes should be constructed using their constructor git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@11250 e03df62e-2008-0410-955e-edbf42e46eb7 --- include/threadengines/threadengine_pthread.h | 91 +++++++++++++++++++--------- include/threadengines/threadengine_win32.h | 76 ++++++++++++++--------- 2 files changed, 111 insertions(+), 56 deletions(-) (limited to 'include/threadengines') diff --git a/include/threadengines/threadengine_pthread.h b/include/threadengines/threadengine_pthread.h index 72fa1d219..2aba4cb15 100644 --- a/include/threadengines/threadengine_pthread.h +++ b/include/threadengines/threadengine_pthread.h @@ -17,61 +17,94 @@ #include #include "inspircd_config.h" #include "base.h" -#include "threadengine.h" class InspIRCd; +class Thread; -class CoreExport PThreadEngine : public ThreadEngine +/** The ThreadEngine class has the responsibility of initialising + * Thread derived classes. It does this by creating operating system + * level threads which are then associated with the class transparently. + * This allows Thread classes to be derived without needing to know how + * the OS implements threads. You should ensure that any sections of code + * that use threads are threadsafe and do not interact with any other + * parts of the code which are NOT known threadsafe! If you really MUST + * access non-threadsafe code from a Thread, use the Mutex class to wrap + * access to the code carefully. + */ +class CoreExport ThreadEngine : public Extensible { public: - PThreadEngine(InspIRCd* Instance); + /** Constructor. + * @param Instance Creator object + */ + ThreadEngine(InspIRCd* Instance); - virtual ~PThreadEngine(); + /** Destructor + */ + virtual ~ThreadEngine(); + /** Create a new thread. This takes an already allocated + * Thread* pointer and initializes it to use this threading + * engine. On failure, this function may throw a CoreException. + * @param thread_to_init Pointer to a newly allocated Thread + * derived object. + */ void Start(Thread* thread_to_init); - void FreeThread(Thread* thread); - + /** Returns the thread engine's name for display purposes + * @return The thread engine name + */ const std::string GetName() { return "posix-thread"; } }; -class CoreExport ThreadEngineFactory : public classbase -{ - public: - ThreadEngine* Create(InspIRCd* ServerInstance) - { - return new PThreadEngine(ServerInstance); - } -}; - -class CoreExport PThreadData : public ThreadData +class CoreExport ThreadData { public: pthread_t pthread_id; void FreeThread(Thread* toFree); }; -class CoreExport PosixMutex : public Mutex +/** The Mutex class represents a mutex, which can be used to keep threads + * properly synchronised. Use mutexes sparingly, as they are a good source + * of thread deadlocks etc, and should be avoided except where absolutely + * neccessary. Note that the internal behaviour of the mutex varies from OS + * to OS depending on the thread engine, for example in windows a Mutex + * in InspIRCd uses critical sections, as they are faster and simpler to + * manage. + */ +class CoreExport Mutex { private: pthread_mutex_t putex; public: - PosixMutex(); - virtual void Enable(bool enable); - ~PosixMutex(); -}; - -class CoreExport MutexFactory : public Extensible -{ - protected: - InspIRCd* ServerInstance; - public: - MutexFactory(InspIRCd* Instance); - Mutex* CreateMutex(); + /** Constructor. + */ + Mutex() + { + pthread_mutex_init(&putex, NULL); + } + /** Enter/enable the mutex lock. + */ + void Lock() + { + pthread_mutex_lock(&putex); + } + /** Leave/disable the mutex lock. + */ + void Unlock() + { + pthread_mutex_unlock(&putex); + } + /** Destructor + */ + ~Mutex() + { + pthread_mutex_destroy(&putex); + } }; #endif diff --git a/include/threadengines/threadengine_win32.h b/include/threadengines/threadengine_win32.h index 3388cead0..c1f9f2cce 100644 --- a/include/threadengines/threadengine_win32.h +++ b/include/threadengines/threadengine_win32.h @@ -16,61 +16,83 @@ #include "inspircd_config.h" #include "base.h" -#include "threadengine.h" class InspIRCd; +class Thread; -class CoreExport Win32ThreadEngine : public ThreadEngine +/** The ThreadEngine class has the responsibility of initialising + * Thread derived classes. It does this by creating operating system + * level threads which are then associated with the class transparently. + * This allows Thread classes to be derived without needing to know how + * the OS implements threads. You should ensure that any sections of code + * that use threads are threadsafe and do not interact with any other + * parts of the code which are NOT known threadsafe! If you really MUST + * access non-threadsafe code from a Thread, use the Mutex class to wrap + * access to the code carefully. + */ +class CoreExport ThreadEngine : public Extensible { public: - Win32ThreadEngine(InspIRCd* Instance); + ThreadEngine(InspIRCd* Instance); - virtual ~Win32ThreadEngine(); + virtual ~ThreadEngine(); static DWORD WINAPI Entry(void* parameter); + /** Create a new thread. This takes an already allocated + * Thread* pointer and initializes it to use this threading + * engine. On failure, this function may throw a CoreException. + * @param thread_to_init Pointer to a newly allocated Thread + * derived object. + */ void Start(Thread* thread_to_init); + /** Returns the thread engine's name for display purposes + * @return The thread engine name + */ const std::string GetName() { return "windows-thread"; } }; -class CoreExport ThreadEngineFactory : public classbase -{ - public: - ThreadEngine* Create(InspIRCd* ServerInstance) - { - return new Win32ThreadEngine(ServerInstance); - } -}; - -class CoreExport Win32ThreadData : public ThreadData +class CoreExport ThreadData { public: HANDLE handle; void FreeThread(Thread* toFree); }; -class CoreExport Win32Mutex : public Mutex +/** The Mutex class represents a mutex, which can be used to keep threads + * properly synchronised. Use mutexes sparingly, as they are a good source + * of thread deadlocks etc, and should be avoided except where absolutely + * neccessary. Note that the internal behaviour of the mutex varies from OS + * to OS depending on the thread engine, for example in windows a Mutex + * in InspIRCd uses critical sections, as they are faster and simpler to + * manage. + */ +class CoreExport Mutex { private: CRITICAL_SECTION wutex; public: - Win32Mutex(); - virtual void Enable(bool enable); - ~Win32Mutex(); -}; - -class CoreExport MutexFactory : public Extensible -{ - protected: - InspIRCd* ServerInstance; - public: - MutexFactory(InspIRCd* Instance); - virtual Mutex* CreateMutex(); + Win32Mutex() + { + InitializeCriticalSection(&wutex); + } + void Lock() + { + EnterCriticalSection(&wutex); + } + void Unlock() + { + LeaveCriticalSection(&wutex); + } + ~Win32Mutex() + { + DeleteCriticalSection(&wutex); + } }; #endif -- cgit v1.2.3