include/threadengines/threadengine_pthread.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 <pthread.h>
  24 #include "typedefs.h"
  25
  26 /** The ThreadEngine class has the responsibility of initialising
  27  * Thread derived classes. It does this by creating operating system
  28  * level threads which are then associated with the class transparently.
  29  * This allows Thread classes to be derived without needing to know how
  30  * the OS implements threads. You should ensure that any sections of code
  31  * that use threads are threadsafe and do not interact with any other
  32  * parts of the code which are NOT known threadsafe! If you really MUST
  33  * access non-threadsafe code from a Thread, use the Mutex class to wrap
  34  * access to the code carefully.
  35  */
  36 class CoreExport ThreadEngine
  37 {
  38  public:
  39
  40         /** Constructor.
  41          */
  42         ThreadEngine();
  43
  44         /** Destructor
  45          */
  46         virtual ~ThreadEngine();
  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 "posix-thread";
  62         }
  63 };
  64
  65 class CoreExport ThreadData
  66 {
  67  public:
  68         pthread_t pthread_id;
  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         pthread_mutex_t putex;
  84  public:
  85         /** Constructor.
  86          */
  87         Mutex()
  88         {
  89                 pthread_mutex_init(&putex, NULL);
  90         }
  91         /** Enter/enable the mutex lock.
  92          */
  93         void Lock()
  94         {
  95                 pthread_mutex_lock(&putex);
  96         }
  97         /** Leave/disable the mutex lock.
  98          */
  99         void Unlock()
 100         {
 101                 pthread_mutex_unlock(&putex);
 102         }
 103         /** Destructor
 104          */
 105         ~Mutex()
 106         {
 107                 pthread_mutex_destroy(&putex);
 108         }
 109 };
 110
 111 class ThreadQueueData
 112 {
 113         pthread_mutex_t mutex;
 114         pthread_cond_t cond;
 115  public:
 116         ThreadQueueData()
 117         {
 118                 pthread_mutex_init(&mutex, NULL);
 119                 pthread_cond_init(&cond, NULL);
 120         }
 121
 122         ~ThreadQueueData()
 123         {
 124                 pthread_mutex_destroy(&mutex);
 125                 pthread_cond_destroy(&cond);
 126         }
 127
 128         void Lock()
 129         {
 130                 pthread_mutex_lock(&mutex);
 131         }
 132
 133         void Unlock()
 134         {
 135                 pthread_mutex_unlock(&mutex);
 136         }
 137
 138         void Wakeup()
 139         {
 140                 pthread_cond_signal(&cond);
 141         }
 142
 143         void Wait()
 144         {
 145                 pthread_cond_wait(&cond, &mutex);
 146         }
 147 };
 148
 149 class ThreadSignalSocket;
 150 class ThreadSignalData
 151 {
 152  public:
 153         ThreadSignalSocket* sock;
 154 };