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         /** Create a new thread. This takes an already allocated
  40          * Thread* pointer and initializes it to use this threading
  41          * engine. On failure, this function may throw a CoreException.
  42          * @param thread_to_init Pointer to a newly allocated Thread
  43          * derived object.
  44          */
  45         void Start(Thread* thread_to_init);
  46 };
  47
  48 class CoreExport ThreadData
  49 {
  50  public:
  51         pthread_t pthread_id;
  52         void FreeThread(Thread* toFree);
  53 };
  54
  55 /** The Mutex class represents a mutex, which can be used to keep threads
  56  * properly synchronised. Use mutexes sparingly, as they are a good source
  57  * of thread deadlocks etc, and should be avoided except where absolutely
  58  * neccessary. Note that the internal behaviour of the mutex varies from OS
  59  * to OS depending on the thread engine, for example in windows a Mutex
  60  * in InspIRCd uses critical sections, as they are faster and simpler to
  61  * manage.
  62  */
  63 class CoreExport Mutex
  64 {
  65  private:
  66         pthread_mutex_t putex;
  67  public:
  68         /** Constructor.
  69          */
  70         Mutex()
  71         {
  72                 pthread_mutex_init(&putex, NULL);
  73         }
  74         /** Enter/enable the mutex lock.
  75          */
  76         void Lock()
  77         {
  78                 pthread_mutex_lock(&putex);
  79         }
  80         /** Leave/disable the mutex lock.
  81          */
  82         void Unlock()
  83         {
  84                 pthread_mutex_unlock(&putex);
  85         }
  86         /** Destructor
  87          */
  88         ~Mutex()
  89         {
  90                 pthread_mutex_destroy(&putex);
  91         }
  92 };
  93
  94 class ThreadQueueData
  95 {
  96         pthread_mutex_t mutex;
  97         pthread_cond_t cond;
  98  public:
  99         ThreadQueueData()
 100         {
 101                 pthread_mutex_init(&mutex, NULL);
 102                 pthread_cond_init(&cond, NULL);
 103         }
 104
 105         ~ThreadQueueData()
 106         {
 107                 pthread_mutex_destroy(&mutex);
 108                 pthread_cond_destroy(&cond);
 109         }
 110
 111         void Lock()
 112         {
 113                 pthread_mutex_lock(&mutex);
 114         }
 115
 116         void Unlock()
 117         {
 118                 pthread_mutex_unlock(&mutex);
 119         }
 120
 121         void Wakeup()
 122         {
 123                 pthread_cond_signal(&cond);
 124         }
 125
 126         void Wait()
 127         {
 128                 pthread_cond_wait(&cond, &mutex);
 129         }
 130 };
 131
 132 class ThreadSignalSocket;
 133 class ThreadSignalData
 134 {
 135  public:
 136         ThreadSignalSocket* sock;
 137 };