X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fthreadengines%2Fthreadengine_pthread.h;h=cabb6ebd2ceb08d58ca821b5f9696e3e13c16ef3;hb=635cb9d65f6d7f6758ae8ed874da00c8d94b6e39;hp=e8f7a4087f89a21f6bad2fe18364d1614206964e;hpb=21193e2e625859978e98b278beda00181fcd317c;p=user%2Fhenk%2Fcode%2Finspircd.git

diff --git a/include/threadengines/threadengine_pthread.h b/include/threadengines/threadengine_pthread.h
index e8f7a4087..cabb6ebd2 100644
--- a/include/threadengines/threadengine_pthread.h
+++ b/include/threadengines/threadengine_pthread.h
@@ -1,51 +1,140 @@
-/*       +------------------------------------+
- *       | 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 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__
+
+#pragma once
 
 #include <pthread.h>
-#include "inspircd_config.h"
-#include "base.h"
-#include "threadengine.h"
 
-class InspIRCd;
+class Thread;
 
-class CoreExport PThreadEngine : public ThreadEngine
+/** 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:
+	/** Per-thread state, present in each Thread object, managed by the ThreadEngine
+	 */
+	struct ThreadState
+	{
+		pthread_t pthread_id;
+	};
 
-	PThreadEngine(InspIRCd* Instance);
-
-	virtual ~PThreadEngine();
+	/** 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);
 
-	bool Mutex(bool enable);
+	/** 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);
+};
 
-	void Run();
+/** 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:
+	/** Constructor.
+	 */
+	Mutex()
+	{
+		pthread_mutex_init(&putex, NULL);
+	}
+	/** Enter/enable the mutex lock.
+	 */
+	void Lock()
+	{
+		pthread_mutex_lock(&putex);
+	}
+	/** Leave/disable the mutex lock.
+	 */
+	void Unlock()
+	{
+		pthread_mutex_unlock(&putex);
+	}
+	/** Destructor
+	 */
+	~Mutex()
+	{
+		pthread_mutex_destroy(&putex);
+	}
+};
 
-	static void* Entry(void* parameter);
+class ThreadQueueData : public Mutex
+{
+	pthread_cond_t cond;
+ public:
+	ThreadQueueData()
+	{
+		pthread_cond_init(&cond, NULL);
+	}
 
-	void Create(Thread* thread_to_init);
+	~ThreadQueueData()
+	{
+		pthread_cond_destroy(&cond);
+	}
 
-	void FreeThread(Thread* thread);
-};
+	void Wakeup()
+	{
+		pthread_cond_signal(&cond);
+	}
 
-class ThreadEngineFactory : public classbase
-{
-	ThreadEngine* Create(InspIRCd* ServerInstance)
+	void Wait()
 	{
-		return new PThreadEngine(ServerInstance);
+		pthread_cond_wait(&cond, &putex);
 	}
 };
 
-#endif
+class ThreadSignalSocket;
+class ThreadSignalData
+{
+ public:
+	ThreadSignalSocket* sock;
+};