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 #ifndef THREADENGINE_PTHREAD_H
  22 #define THREADENGINE_PTHREAD_H
  23
  24 #include <pthread.h>
  25 #include "typedefs.h"
  26
  27 /** The ThreadEngine class has the responsibility of initialising
  28  * Thread derived classes. It does this by creating operating system
  29  * level threads which are then associated with the class transparently.
  30  * This allows Thread classes to be derived without needing to know how
  31  * the OS implements threads. You should ensure that any sections of code
  32  * that use threads are threadsafe and do not interact with any other
  33  * parts of the code which are NOT known threadsafe! If you really MUST
  34  * access non-threadsafe code from a Thread, use the Mutex class to wrap
  35  * access to the code carefully.
  36  */
  37 class CoreExport ThreadEngine
  38 {
  39  public:
  40
  41         /** Constructor.
  42          */
  43         ThreadEngine();
  44
  45         /** Destructor
  46          */
  47         virtual ~ThreadEngine();
  48
  49         /** Create a new thread. This takes an already allocated
  50          * Thread* pointer and initializes it to use this threading
  51          * engine. On failure, this function may throw a CoreException.
  52          * @param thread_to_init Pointer to a newly allocated Thread
  53          * derived object.
  54          */
  55         void Start(Thread* thread_to_init);
  56
  57         /** Returns the thread engine's name for display purposes
  58          * @return The thread engine name
  59          */
  60         const std::string GetName()
  61         {
  62                 return "posix-thread";
  63         }
  64 };
  65
  66 class CoreExport ThreadData
  67 {
  68  public:
  69         pthread_t pthread_id;
  70         void FreeThread(Thread* toFree);
  71 };
  72
  73 /** The Mutex class represents a mutex, which can be used to keep threads
  74  * properly synchronised. Use mutexes sparingly, as they are a good source
  75  * of thread deadlocks etc, and should be avoided except where absolutely
  76  * neccessary. Note that the internal behaviour of the mutex varies from OS
  77  * to OS depending on the thread engine, for example in windows a Mutex
  78  * in InspIRCd uses critical sections, as they are faster and simpler to
  79  * manage.
  80  */
  81 class CoreExport Mutex
  82 {
  83  private:
  84         pthread_mutex_t putex;
  85  public:
  86         /** Constructor.
  87          */
  88         Mutex()
  89         {
  90                 pthread_mutex_init(&putex, NULL);
  91         }
  92         /** Enter/enable the mutex lock.
  93          */
  94         void Lock()
  95         {
  96                 pthread_mutex_lock(&putex);
  97         }
  98         /** Leave/disable the mutex lock.
  99          */
 100         void Unlock()
 101         {
 102                 pthread_mutex_unlock(&putex);
 103         }
 104         /** Destructor
 105          */
 106         ~Mutex()
 107         {
 108                 pthread_mutex_destroy(&putex);
 109         }
 110 };
 111
 112 class ThreadQueueData
 113 {
 114         pthread_mutex_t mutex;
 115         pthread_cond_t cond;
 116  public:
 117         ThreadQueueData()
 118         {
 119                 pthread_mutex_init(&mutex, NULL);
 120                 pthread_cond_init(&cond, NULL);
 121         }
 122
 123         ~ThreadQueueData()
 124         {
 125                 pthread_mutex_destroy(&mutex);
 126                 pthread_cond_destroy(&cond);
 127         }
 128
 129         void Lock()
 130         {
 131                 pthread_mutex_lock(&mutex);
 132         }
 133
 134         void Unlock()
 135         {
 136                 pthread_mutex_unlock(&mutex);
 137         }
 138
 139         void Wakeup()
 140         {
 141                 pthread_cond_signal(&cond);
 142         }
 143
 144         void Wait()
 145         {
 146                 pthread_cond_wait(&cond, &mutex);
 147         }
 148 };
 149
 150 class ThreadSignalSocket;
 151 class ThreadSignalData
 152 {
 153  public:
 154         ThreadSignalSocket* sock;
 155 };
 156
 157
 158 #endif