include/threadengines/threadengine_pthread.h

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2014 Attila Molnar <attilamolnar@hush.com>
   5  *   Copyright (C) 2013, 2021 Sadie Powell <sadie@witchery.services>
   6  *   Copyright (C) 2012 Robby <robby@chatbelgie.be>
   7  *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
   8  *   Copyright (C) 2008, 2010 Craig Edwards <brain@inspircd.org>
   9  *
  10  * This file is part of InspIRCd.  InspIRCd is free software: you can
  11  * redistribute it and/or modify it under the terms of the GNU General Public
  12  * License as published by the Free Software Foundation, version 2.
  13  *
  14  * This program is distributed in the hope that it will be useful, but WITHOUT
  15  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  16  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  17  * details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  */
  22
  23
  24 #pragma once
  25
  26 #include <pthread.h>
  27
  28 class Thread;
  29
  30 /** The ThreadEngine class has the responsibility of initialising
  31  * Thread derived classes. It does this by creating operating system
  32  * level threads which are then associated with the class transparently.
  33  * This allows Thread classes to be derived without needing to know how
  34  * the OS implements threads. You should ensure that any sections of code
  35  * that use threads are threadsafe and do not interact with any other
  36  * parts of the code which are NOT known threadsafe! If you really MUST
  37  * access non-threadsafe code from a Thread, use the Mutex class to wrap
  38  * access to the code carefully.
  39  */
  40 class CoreExport ThreadEngine
  41 {
  42  public:
  43         /** Per-thread state, present in each Thread object, managed by the ThreadEngine
  44          */
  45         struct ThreadState
  46         {
  47                 pthread_t pthread_id;
  48         };
  49
  50         /** Create a new thread. This takes an already allocated
  51          * Thread* pointer and initializes it to use this threading
  52          * engine. On failure, this function may throw a CoreException.
  53          * @param thread_to_init Pointer to a newly allocated Thread
  54          * derived object.
  55          */
  56         void Start(Thread* thread_to_init);
  57
  58         /** Stop a thread gracefully.
  59          * First, this function asks the thread to terminate by calling Thread::SetExitFlag().
  60          * Next, it waits until the thread terminates (on the operating system level). Finally,
  61          * all OS-level resources associated with the thread are released. The Thread instance
  62          * passed to the function is NOT freed.
  63          * When this function returns, the thread is stopped and you can destroy it or restart it
  64          * at a later point.
  65          * Stopping a thread that is not running is a bug.
  66          * @param thread The thread to stop.
  67          */
  68         void Stop(Thread* thread);
  69 };
  70
  71 /** The Mutex class represents a mutex, which can be used to keep threads
  72  * properly synchronised. Use mutexes sparingly, as they are a good source
  73  * of thread deadlocks etc, and should be avoided except where absolutely
  74  * necessary. Note that the internal behaviour of the mutex varies from OS
  75  * to OS depending on the thread engine, for example in windows a Mutex
  76  * in InspIRCd uses critical sections, as they are faster and simpler to
  77  * manage.
  78  */
  79 class CoreExport Mutex
  80 {
  81  protected:
  82         pthread_mutex_t putex;
  83  public:
  84         /** Constructor.
  85          */
  86         Mutex()
  87         {
  88                 pthread_mutex_init(&putex, NULL);
  89         }
  90         /** Enter/enable the mutex lock.
  91          */
  92         void Lock()
  93         {
  94                 pthread_mutex_lock(&putex);
  95         }
  96         /** Leave/disable the mutex lock.
  97          */
  98         void Unlock()
  99         {
 100                 pthread_mutex_unlock(&putex);
 101         }
 102         /** Destructor
 103          */
 104         ~Mutex()
 105         {
 106                 pthread_mutex_destroy(&putex);
 107         }
 108 };
 109
 110 class ThreadQueueData : public Mutex
 111 {
 112         pthread_cond_t cond;
 113  public:
 114         ThreadQueueData()
 115         {
 116                 pthread_cond_init(&cond, NULL);
 117         }
 118
 119         ~ThreadQueueData()
 120         {
 121                 pthread_cond_destroy(&cond);
 122         }
 123
 124         void Wakeup()
 125         {
 126                 pthread_cond_signal(&cond);
 127         }
 128
 129         void Wait()
 130         {
 131                 pthread_cond_wait(&cond, &putex);
 132         }
 133 };
 134
 135 class ThreadSignalSocket;
 136 class ThreadSignalData
 137 {
 138  public:
 139         ThreadSignalSocket* sock;
 140 };