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