include/threadengines/threadengine_win32.h

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2008 Craig Edwards <craigedwards@brainbox.cc>
   6  *
   7  * This file is part of InspIRCd.  InspIRCd is free software: you can
   8  * redistribute it and/or modify it under the terms of the GNU General Public
   9  * License as published by the Free Software Foundation, version 2.
  10  *
  11  * This program is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  13  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  14  * details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20
  21 #pragma once
  22
  23 #include "config.h"
  24 #include "base.h"
  25
  26 class Thread;
  27
  28 /** The ThreadEngine class has the responsibility of initialising
  29  * Thread derived classes. It does this by creating operating system
  30  * level threads which are then associated with the class transparently.
  31  * This allows Thread classes to be derived without needing to know how
  32  * the OS implements threads. You should ensure that any sections of code
  33  * that use threads are threadsafe and do not interact with any other
  34  * parts of the code which are NOT known threadsafe! If you really MUST
  35  * access non-threadsafe code from a Thread, use the Mutex class to wrap
  36  * access to the code carefully.
  37  */
  38 class CoreExport ThreadEngine
  39 {
  40  public:
  41         /** Per-thread state, present in each Thread object, managed by the ThreadEngine
  42          */
  43         struct ThreadState
  44         {
  45                 HANDLE handle;
  46         };
  47
  48         static DWORD WINAPI Entry(void* parameter);
  49
  50         /** Create a new thread. This takes an already allocated
  51           * Thread* pointer and initializes it to use this threading
  52           * engine. On failure, this function may throw a CoreException.
  53           * @param thread_to_init Pointer to a newly allocated Thread
  54           * derived object.
  55           */
  56         void Start(Thread* thread_to_init);
  57
  58         /** Stop a thread gracefully.
  59          * First, this function asks the thread to terminate by calling Thread::SetExitFlag().
  60          * Next, it waits until the thread terminates (on the operating system level). Finally,
  61          * all OS-level resources associated with the thread are released. The Thread instance
  62          * passed to the function is NOT freed.
  63          * When this function returns, the thread is stopped and you can destroy it or restart it
  64          * at a later point.
  65          * Stopping a thread that is not running is a bug.
  66          * @param thread The thread to stop.
  67          */
  68         void Stop(Thread* thread);
  69 };
  70
  71 /** The Mutex class represents a mutex, which can be used to keep threads
  72  * properly synchronised. Use mutexes sparingly, as they are a good source
  73  * of thread deadlocks etc, and should be avoided except where absolutely
  74  * neccessary. Note that the internal behaviour of the mutex varies from OS
  75  * to OS depending on the thread engine, for example in windows a Mutex
  76  * in InspIRCd uses critical sections, as they are faster and simpler to
  77  * manage.
  78  */
  79 class CoreExport Mutex
  80 {
  81  private:
  82         CRITICAL_SECTION wutex;
  83  public:
  84         Mutex()
  85         {
  86                 InitializeCriticalSection(&wutex);
  87         }
  88         void Lock()
  89         {
  90                 EnterCriticalSection(&wutex);
  91         }
  92         void Unlock()
  93         {
  94                 LeaveCriticalSection(&wutex);
  95         }
  96         ~Mutex()
  97         {
  98                 DeleteCriticalSection(&wutex);
  99         }
 100 };
 101
 102 class ThreadQueueData : public Mutex
 103 {
 104         HANDLE event;
 105  public:
 106         ThreadQueueData()
 107         {
 108                 event = CreateEvent(NULL, false, false, NULL);
 109                 if (event == NULL)
 110                         throw CoreException("CreateEvent() failed in ThreadQueueData::ThreadQueueData()!");
 111         }
 112
 113         ~ThreadQueueData()
 114         {
 115                 CloseHandle(event);
 116         }
 117
 118         void Wakeup()
 119         {
 120                 PulseEvent(event);
 121         }
 122
 123         void Wait()
 124         {
 125                 Unlock();
 126                 WaitForSingleObject(event, INFINITE);
 127                 Lock();
 128         }
 129 };
 130
 131 class ThreadSignalData
 132 {
 133  public:
 134         int connFD;
 135         ThreadSignalData()
 136         {
 137                 connFD = -1;
 138         }
 139 };