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
  42         ThreadEngine();
  43
  44         virtual ~ThreadEngine();
  45
  46         static DWORD WINAPI Entry(void* parameter);
  47
  48         /** Create a new thread. This takes an already allocated
  49           * Thread* pointer and initializes it to use this threading
  50           * engine. On failure, this function may throw a CoreException.
  51           * @param thread_to_init Pointer to a newly allocated Thread
  52           * derived object.
  53           */
  54         void Start(Thread* thread_to_init);
  55
  56         /** Returns the thread engine's name for display purposes
  57          * @return The thread engine name
  58          */
  59         const std::string GetName()
  60         {
  61                 return "windows-thread";
  62         }
  63 };
  64
  65 class CoreExport ThreadData
  66 {
  67  public:
  68         HANDLE handle;
  69         void FreeThread(Thread* toFree);
  70 };
  71
  72 /** The Mutex class represents a mutex, which can be used to keep threads
  73  * properly synchronised. Use mutexes sparingly, as they are a good source
  74  * of thread deadlocks etc, and should be avoided except where absolutely
  75  * neccessary. Note that the internal behaviour of the mutex varies from OS
  76  * to OS depending on the thread engine, for example in windows a Mutex
  77  * in InspIRCd uses critical sections, as they are faster and simpler to
  78  * manage.
  79  */
  80 class CoreExport Mutex
  81 {
  82  private:
  83         CRITICAL_SECTION wutex;
  84  public:
  85         Mutex()
  86         {
  87                 InitializeCriticalSection(&wutex);
  88         }
  89         void Lock()
  90         {
  91                 EnterCriticalSection(&wutex);
  92         }
  93         void Unlock()
  94         {
  95                 LeaveCriticalSection(&wutex);
  96         }
  97         ~Mutex()
  98         {
  99                 DeleteCriticalSection(&wutex);
 100         }
 101 };
 102
 103 class ThreadQueueData
 104 {
 105         CRITICAL_SECTION mutex;
 106         HANDLE event;
 107  public:
 108         ThreadQueueData()
 109         {
 110                 event = CreateEvent(NULL, false, false, NULL);
 111                 if (event == NULL)
 112                         throw CoreException("CreateEvent() failed in ThreadQueueData::ThreadQueueData()!");
 113                 InitializeCriticalSection(&mutex);
 114         }
 115
 116         ~ThreadQueueData()
 117         {
 118                 CloseHandle(event);
 119                 DeleteCriticalSection(&mutex);
 120         }
 121
 122         void Lock()
 123         {
 124                 EnterCriticalSection(&mutex);
 125         }
 126
 127         void Unlock()
 128         {
 129                 LeaveCriticalSection(&mutex);
 130         }
 131
 132         void Wakeup()
 133         {
 134                 PulseEvent(event);
 135         }
 136
 137         void Wait()
 138         {
 139                 LeaveCriticalSection(&mutex);
 140                 WaitForSingleObject(event, INFINITE);
 141                 EnterCriticalSection(&mutex);
 142         }
 143 };
 144
 145 class ThreadSignalData
 146 {
 147  public:
 148         int connFD;
 149         ThreadSignalData()
 150         {
 151                 connFD = -1;
 152         }
 153 };