1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
|
/*
* InspIRCd -- Internet Relay Chat Daemon
*
* 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 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/>.
*/
#pragma once
#include <pthread.h>
#include "typedefs.h"
/** 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;
};
/** 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);
};
/** 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);
}
};
class ThreadQueueData : public Mutex
{
pthread_cond_t cond;
public:
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 ThreadSignalSocket;
class ThreadSignalData
{
public:
ThreadSignalSocket* sock;
};
|
