| Qore Programming Language - C/C++ Library 1.12.2

qore_thread.h
Go to the documentation of this file.
1 /* -*- mode: c++; indent-tabs-mode: nil -*- */
2 /*
3 qore_thread.h
4
5 POSIX thread library for Qore
6
7 Qore Programming Language
8
9 Copyright (C) 2003 - 2022 Qore Technologies, s.r.o.
10
11 Permission is hereby granted, free of charge, to any person obtaining a
12 copy of this software and associated documentation files (the "Software"),
13 to deal in the Software without restriction, including without limitation
14 the rights to use, copy, modify, merge, publish, distribute, sublicense,
15 and/or sell copies of the Software, and to permit persons to whom the
16 Software is furnished to do so, subject to the following conditions:
17
18 The above copyright notice and this permission notice shall be included in
19 all copies or substantial portions of the Software.
20
21 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
26 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
27 DEALINGS IN THE SOFTWARE.
28
29 Note that the Qore library is released under a choice of three open-source
30 licenses: MIT (as above), LGPL 2+, or GPL 2+; see README-LICENSE for more
31 information.
32 */
33
34 #ifndef _QORE_QORE_THREAD_H
35 #define _QORE_QORE_THREAD_H
36
41 #include <cstdio>
42 #include <pthread.h>
43
44 #include <functional>
45
46 class QoreProgram;
47 class AbstractQoreZoneInfo;
48 class ThreadCleanupNode;
49 class AbstractThreadResource;
50
52 typedef void (*qtdest_t)(void *);
53
55 typedef void (*qtrdest_t)(void *, ExceptionSink *);
56
58 typedef void (*q_thread_t)(ExceptionSink* xsink, void* arg);
59
61
67 DLLEXPORT bool is_valid_qore_thread();
68
70
72 DLLEXPORT int q_gettid() noexcept;
73
75 DLLEXPORT QoreProgram* getProgram();
76
78 DLLEXPORT const AbstractQoreZoneInfo* currentTZ();
79
81
83 DLLEXPORT void set_thread_resource(AbstractThreadResource* atr);
84
86
89 DLLEXPORT int remove_thread_resource(AbstractThreadResource* atr);
90
92
95 DLLEXPORT bool check_thread_resource(AbstractThreadResource* atr);
96
98
101 DLLEXPORT void set_thread_resource(const ResolvedCallReferenceNode* rcr, const QoreValue arg);
102
104
109 DLLEXPORT int remove_thread_resource(const ResolvedCallReferenceNode* rcr, ExceptionSink* xsink);
110
111 #if 0
113
119 DLLEXPORT void set_thread_resource_id(q_trid_t trid, AbstractThreadResource *atr);
120
122
127 DLLEXPORT int remove_thread_resource_id(q_trid_t trid);
128
130
133 DLLEXPORT bool check_thread_resource_id(q_trid_t trid);
134 #endif
135
137 DLLEXPORT q_trid_t qore_get_trid();
138
140
147 class ThreadCleanupList {
148 private:
149 static ThreadCleanupNode *head;
150
151 public:
152 DLLLOCAL ThreadCleanupList();
153 DLLLOCAL ~ThreadCleanupList();
154 DLLLOCAL void exec();
155
157
160 DLLEXPORT void push(qtdest_t func, void *arg);
161
163
165 DLLEXPORT void pop(bool exec = true);
166 };
167
169 DLLEXPORT extern ThreadCleanupList tclist;
170
174 #define QFT_OK 0
175 #define QFT_ERROR -1
176 #define QFT_REGISTERED -2
178
180
195 DLLEXPORT int q_register_foreign_thread();
196
198
207 DLLEXPORT int q_deregister_foreign_thread();
208
210
214 DLLEXPORT int q_reserve_foreign_thread_id();
215
217
223 DLLEXPORT int q_release_reserved_foreign_thread_id(int tid);
224
226
232 DLLEXPORT int q_register_reserved_foreign_thread(int tid);
233
235
239 DLLEXPORT int q_deregister_reserved_foreign_thread();
240
242
250 int q_start_thread(ExceptionSink* xsink, q_thread_t f, void* arg = nullptr);
251
253
255 class QoreForeignThreadHelper {
256 public:
258
263 DLLEXPORT QoreForeignThreadHelper();
264
266
269 DLLEXPORT explicit QoreForeignThreadHelper(int tid);
270
272
276 DLLEXPORT ~QoreForeignThreadHelper();
277
279 DLLEXPORT operator bool() const;
280
281 protected:
282 class qore_foreign_thread_priv* priv;
283
284 private:
285 DLLLOCAL QoreForeignThreadHelper& operator=(const QoreForeignThreadHelper&) = delete;
286 DLLLOCAL QoreForeignThreadHelper(const QoreForeignThreadHelper&) = delete;
287 DLLLOCAL void* operator new(size_t) = delete;
288 };
289
290 typedef std::function<void(void*)> q_thread_local_destructor;
291
293
295 struct q_user_tld {
296 void* data;
297 q_thread_local_destructor destructor;
298
299 DLLLOCAL q_user_tld(void* data, q_thread_local_destructor destructor);
300 DLLLOCAL q_user_tld(q_user_tld&& old) = default;
301 DLLLOCAL q_user_tld(const q_user_tld& old) = default;
302 DLLLOCAL q_user_tld& operator=(const q_user_tld& other) = default;
303 };
304
306
308 DLLEXPORT int q_get_unique_thread_local_data_key();
309
311
315 DLLEXPORT void q_save_thread_local_data(int key, void* data, q_thread_local_destructor destructor = nullptr);
316
318
322 DLLEXPORT void* q_swap_thread_local_data(int key, void* new_data, q_thread_local_destructor destructor = nullptr, bool run_destructor = true);
323
325
329 DLLEXPORT void* q_get_thread_local_data(int key);
330
332
340 DLLEXPORT q_user_tld* q_get_thread_local_data_all(int key);
341
343
353 DLLEXPORT int q_remove_thread_local_data(int key, q_user_tld& data, bool run_destructor = true);
354
355 #endif // ifndef _QORE_THREAD_H
AbstractThreadResource
base class for saving data using Qore's thread resource management system
Definition: AbstractThreadResource.h:51
ExceptionSink
container for holding Qore-language exception information and also for registering a "thread_exit" ca...
Definition: ExceptionSink.h:48
QoreForeignThreadHelper
use this class to temporarily register and deregister a foreign thread to allow Qore code to be execu...
Definition: qore_thread.h:255
QoreForeignThreadHelper::~QoreForeignThreadHelper
DLLEXPORT ~QoreForeignThreadHelper()
deregisters the current thread
QoreForeignThreadHelper::QoreForeignThreadHelper
DLLEXPORT QoreForeignThreadHelper()
registers the current thread as a foreign thread
QoreProgram
supports parsing and executing Qore-language code, reference counted, dynamically-allocated only
Definition: QoreProgram.h:127
ResolvedCallReferenceNode
base class for resolved call references
Definition: CallReferenceNode.h:109
ThreadCleanupList
list of functions to be run when a thread ends; required for some external libraries that require exp...
Definition: qore_thread.h:147
ThreadCleanupList::push
DLLEXPORT void push(qtdest_t func, void *arg)
must only be called in the module initialization function
ThreadCleanupList::pop
DLLEXPORT void pop(bool exec=true)
must only be called in the module destructor/deletion function
q_trid_t
unsigned q_trid_t
type for thread resource IDs (unique within a single running qore library process)
Definition: common.h:455
q_register_reserved_foreign_thread
DLLEXPORT int q_register_reserved_foreign_thread(int tid)
registers a foreign qore thread as a Qore thread with a reserved TID
check_thread_resource
DLLEXPORT bool check_thread_resource(AbstractThreadResource *atr)
check if a thread resouce has been saved
q_release_reserved_foreign_thread_id
DLLEXPORT int q_release_reserved_foreign_thread_id(int tid)
releases a TID reserved with q_reserve_foreign_thread_id()
qore_get_trid
DLLEXPORT q_trid_t qore_get_trid()
get a thread resource ID
q_get_thread_local_data
DLLEXPORT void * q_get_thread_local_data(int key)
returns thread-local data
q_reserve_foreign_thread_id
DLLEXPORT int q_reserve_foreign_thread_id()
reserves a thread ID for later registration and returns the TID reserved; use q_release_reserved_fore...
getProgram
DLLEXPORT QoreProgram * getProgram()
returns the current QoreProgram
q_get_unique_thread_local_data_key
DLLEXPORT int q_get_unique_thread_local_data_key()
returns a unique ID to use with thread_local_data APIs
q_thread_t
void(* q_thread_t)(ExceptionSink *xsink, void *arg)
pointer to a function that can be started with q_start_thread()
Definition: qore_thread.h:58
q_remove_thread_local_data
DLLEXPORT int q_remove_thread_local_data(int key, q_user_tld &data, bool run_destructor=true)
returns and removes thread-local data
q_get_thread_local_data_all
DLLEXPORT q_user_tld * q_get_thread_local_data_all(int key)
returns thread-local data
q_save_thread_local_data
DLLEXPORT void q_save_thread_local_data(int key, void *data, q_thread_local_destructor destructor=nullptr)
saves thread-local data
q_deregister_foreign_thread
DLLEXPORT int q_deregister_foreign_thread()
deregisters the current thread as a foreign thread
is_valid_qore_thread
DLLEXPORT bool is_valid_qore_thread()
returns true if the current thread is a valid qore thread; it is not safe to call most Qore functions...
q_register_foreign_thread
DLLEXPORT int q_register_foreign_thread()
registers the current thread as a Qore thread
q_start_thread
int q_start_thread(ExceptionSink *xsink, q_thread_t f, void *arg=nullptr)
starts a new thread with the given arguments, when the thread terminates, it deregisters itself
qtrdest_t
void(* qtrdest_t)(void *, ExceptionSink *)
pointer to a qore thread resource destructor function
Definition: qore_thread.h:55
q_deregister_reserved_foreign_thread
DLLEXPORT int q_deregister_reserved_foreign_thread()
deregisters a foreign qore thread but retains the TID as reserved
tclist
DLLEXPORT ThreadCleanupList tclist
the interface to the thread cleanup list
q_swap_thread_local_data
DLLEXPORT void * q_swap_thread_local_data(int key, void *new_data, q_thread_local_destructor destructor=nullptr, bool run_destructor=true)
swaps thread-local data
set_thread_resource
DLLEXPORT void set_thread_resource(AbstractThreadResource *atr)
save a resource against a thread for thread resource handling
currentTZ
DLLEXPORT const AbstractQoreZoneInfo * currentTZ()
returns the current local time zone, note that if 0 = UTC
remove_thread_resource
DLLEXPORT int remove_thread_resource(AbstractThreadResource *atr)
remove the resource from the thread resource list for the current thread
q_gettid
DLLEXPORT int q_gettid() noexcept
returns the current TID number
qtdest_t
void(* qtdest_t)(void *)
pointer to a qore thread destructor function
Definition: qore_thread.h:52
QoreValue
The main value class in Qore, designed to be passed by value.
Definition: QoreValue.h:275
q_user_tld
data structure for user thread-local data
Definition: qore_thread.h:295