-/* +------------------------------------+
- * | Inspire Internet Relay Chat Daemon |
- * +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
*
- * InspIRCd: (C) 2002-2008 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ * Copyright (C) 2014 Attila Molnar <attilamolnar@hush.com>
+ * Copyright (C) 2013, 2021 Sadie Powell <sadie@witchery.services>
+ * Copyright (C) 2012 Robby <robby@chatbelgie.be>
+ * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
+ * Copyright (C) 2008, 2010 Craig Edwards <brain@inspircd.org>
*
- * This program is free but copyrighted software; see
- * the file COPYING for details.
+ * This file is part of InspIRCd. InspIRCd is free software: you can
+ * redistribute it and/or modify it under the terms of the GNU General Public
+ * License as published by the Free Software Foundation, version 2.
*
- * ---------------------------------------------------
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-#ifndef __THREADENGINE_PTHREAD__
-#define __THREADENGINE_PTHREAD__
-#include <pthread.h>
-#include "inspircd_config.h"
-#include "base.h"
-#include "threadengine.h"
+#pragma once
-class InspIRCd;
+#include <pthread.h>
-class CoreExport PThreadEngine : public ThreadEngine
+class Thread;
+
+/** The ThreadEngine class has the responsibility of initialising
+ * Thread derived classes. It does this by creating operating system
+ * level threads which are then associated with the class transparently.
+ * This allows Thread classes to be derived without needing to know how
+ * the OS implements threads. You should ensure that any sections of code
+ * that use threads are threadsafe and do not interact with any other
+ * parts of the code which are NOT known threadsafe! If you really MUST
+ * access non-threadsafe code from a Thread, use the Mutex class to wrap
+ * access to the code carefully.
+ */
+class CoreExport ThreadEngine
{
public:
-
- PThreadEngine(InspIRCd* Instance);
-
- virtual ~PThreadEngine();
-
- bool Mutex(bool enable);
-
- void Run();
-
- static void* Entry(void* parameter);
-
- void Create(Thread* thread_to_init);
-
- void FreeThread(Thread* thread);
-
- const std::string GetName()
+ /** Per-thread state, present in each Thread object, managed by the ThreadEngine
+ */
+ struct ThreadState
{
- return "posix-thread";
- }
+ pthread_t pthread_id;
+ };
+
+ /** Create a new thread. This takes an already allocated
+ * Thread* pointer and initializes it to use this threading
+ * engine. On failure, this function may throw a CoreException.
+ * @param thread_to_init Pointer to a newly allocated Thread
+ * derived object.
+ */
+ void Start(Thread* thread_to_init);
+
+ /** Stop a thread gracefully.
+ * First, this function asks the thread to terminate by calling Thread::SetExitFlag().
+ * Next, it waits until the thread terminates (on the operating system level). Finally,
+ * all OS-level resources associated with the thread are released. The Thread instance
+ * passed to the function is NOT freed.
+ * When this function returns, the thread is stopped and you can destroy it or restart it
+ * at a later point.
+ * Stopping a thread that is not running is a bug.
+ * @param thread The thread to stop.
+ */
+ void Stop(Thread* thread);
};
-class CoreExport ThreadEngineFactory : public classbase
+/** The Mutex class represents a mutex, which can be used to keep threads
+ * properly synchronised. Use mutexes sparingly, as they are a good source
+ * of thread deadlocks etc, and should be avoided except where absolutely
+ * necessary. Note that the internal behaviour of the mutex varies from OS
+ * to OS depending on the thread engine, for example in windows a Mutex
+ * in InspIRCd uses critical sections, as they are faster and simpler to
+ * manage.
+ */
+class CoreExport Mutex
{
+ protected:
+ pthread_mutex_t putex;
public:
- ThreadEngine* Create(InspIRCd* ServerInstance)
+ /** Constructor.
+ */
+ Mutex()
+ {
+ pthread_mutex_init(&putex, NULL);
+ }
+ /** Enter/enable the mutex lock.
+ */
+ void Lock()
{
- return new PThreadEngine(ServerInstance);
+ pthread_mutex_lock(&putex);
+ }
+ /** Leave/disable the mutex lock.
+ */
+ void Unlock()
+ {
+ pthread_mutex_unlock(&putex);
+ }
+ /** Destructor
+ */
+ ~Mutex()
+ {
+ pthread_mutex_destroy(&putex);
}
};
-class CoreExport PosixMutex : public Mutex
+class ThreadQueueData : public Mutex
{
- private:
- pthread_mutex_t putex;
+ pthread_cond_t cond;
public:
- PosixMutex(InspIRCd* Instance);
- virtual void Enable(bool enable);
- ~PosixMutex();
+ ThreadQueueData()
+ {
+ pthread_cond_init(&cond, NULL);
+ }
+
+ ~ThreadQueueData()
+ {
+ pthread_cond_destroy(&cond);
+ }
+
+ void Wakeup()
+ {
+ pthread_cond_signal(&cond);
+ }
+
+ void Wait()
+ {
+ pthread_cond_wait(&cond, &putex);
+ }
};
-class CoreExport MutexEngine : public Extensible
+class ThreadSignalSocket;
+class ThreadSignalData
{
- protected:
- InspIRCd* ServerInstance;
public:
- MutexEngine(InspIRCd* Instance);
- Mutex* CreateMutex();
+ ThreadSignalSocket* sock;
};
-
-#endif
projects / user / henk / code / inspircd.git / blobdiff