X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fthreadengines%2Fthreadengine_pthread.h;h=76886a35a841da95239bee5fc1bd6bb669089ba2;hb=e94b673532f7833aaa4789f834e61d68e0b4fc56;hp=4a8ab241e4bc41cc81cd59e223e72baabd1145f9;hpb=76619990ad82501afc95d0c76f057a2841862de9;p=user%2Fhenk%2Fcode%2Finspircd.git

diff --git a/include/threadengines/threadengine_pthread.h b/include/threadengines/threadengine_pthread.h
index 4a8ab241e..76886a35a 100644
--- a/include/threadengines/threadengine_pthread.h
+++ b/include/threadengines/threadengine_pthread.h
@@ -1,21 +1,31 @@
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2010 InspIRCd Development Team
- * See: http://wiki.inspircd.org/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_H
-#define THREADENGINE_PTHREAD_H
+
+#pragma once
 
 #include <pthread.h>
-#include "typedefs.h"
+
+class Thread;
 
 /** The ThreadEngine class has the responsibility of initialising
  * Thread derived classes. It does this by creating operating system
@@ -30,15 +40,12 @@
 class CoreExport ThreadEngine
 {
  public:
-
-	/** Constructor.
-	 * @param Instance Creator object
+	/** Per-thread state, present in each Thread object, managed by the ThreadEngine
 	 */
-	ThreadEngine();
-
-	/** Destructor
-	 */
-	virtual ~ThreadEngine();
+	struct ThreadState
+	{
+		pthread_t pthread_id;
+	};
 
 	/** Create a new thread. This takes an already allocated
 	 * Thread* pointer and initializes it to use this threading
@@ -48,33 +55,30 @@ class CoreExport ThreadEngine
 	 */
 	void Start(Thread* thread_to_init);
 
-	/** Returns the thread engine's name for display purposes
-	 * @return The thread engine name
+	/** 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.
 	 */
-	const std::string GetName()
-	{
-		return "posix-thread";
-	}
-};
-
-class CoreExport ThreadData
-{
- public:
-	pthread_t pthread_id;
-	void FreeThread(Thread* toFree);
+	void Stop(Thread* thread);
 };
 
 /** 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
- * neccessary. Note that the internal behaviour of the mutex varies from OS
+ * 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
 {
- private:
+ protected:
 	pthread_mutex_t putex;
  public:
 	/** Constructor.
@@ -103,33 +107,20 @@ class CoreExport Mutex
 	}
 };
 
-class ThreadQueueData
+class ThreadQueueData : public Mutex
 {
-	pthread_mutex_t mutex;
 	pthread_cond_t cond;
  public:
 	ThreadQueueData()
 	{
-		pthread_mutex_init(&mutex, NULL);
 		pthread_cond_init(&cond, NULL);
 	}
 
 	~ThreadQueueData()
 	{
-		pthread_mutex_destroy(&mutex);
 		pthread_cond_destroy(&cond);
 	}
 
-	void Lock()
-	{
-		pthread_mutex_lock(&mutex);
-	}
-
-	void Unlock()
-	{
-		pthread_mutex_unlock(&mutex);
-	}
-
 	void Wakeup()
 	{
 		pthread_cond_signal(&cond);
@@ -137,7 +128,7 @@ class ThreadQueueData
 
 	void Wait()
 	{
-		pthread_cond_wait(&cond, &mutex);
+		pthread_cond_wait(&cond, &putex);
 	}
 };
 
@@ -147,6 +138,3 @@ class ThreadSignalData
  public:
 	ThreadSignalSocket* sock;
 };
-
-
-#endif