blob: 3d765c2c2ed182d6cf9bff00e854459d0b50fbf5 [file] [log] [blame]
Sebastian Wilhelmib1d15582000-10-12 11:52:07 +00001/* GLIB - Library of useful routines for C programming
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
3 *
Sébastien Wilmetf9faac72017-01-05 12:47:07 +01004 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2.1 of the License, or (at your option) any later version.
Sebastian Wilhelmib1d15582000-10-12 11:52:07 +00008 *
Ryan Lortie08a6d812011-10-04 20:31:33 -04009 * This library is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Sebastian Wilhelmib1d15582000-10-12 11:52:07 +000012 * Lesser General Public License for more details.
13 *
14 * You should have received a copy of the GNU Lesser General Public
Daniel Mustieles078dbda2014-01-23 12:58:29 +010015 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
Sebastian Wilhelmib1d15582000-10-12 11:52:07 +000016 */
17
18/*
19 * Modified by the GLib Team and others 1997-2000. See the AUTHORS
20 * file for a list of people on the GLib Team. See the ChangeLog
21 * files for a list of changes. These files are distributed with
Michael Nattererf4bb21a2008-03-14 19:30:38 +000022 * GLib at ftp://ftp.gtk.org/pub/gtk/.
Sebastian Wilhelmib1d15582000-10-12 11:52:07 +000023 */
24
Matthias Clasene1b99b22012-12-27 23:43:14 -050025#ifndef __G_THREAD_H__
26#define __G_THREAD_H__
27
Matthias Clasen7455dd32011-10-12 00:24:46 -040028#if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
Michael Nattererf4bb21a2008-03-14 19:30:38 +000029#error "Only <glib.h> can be included directly."
30#endif
31
Ryan Lortie08a6d812011-10-04 20:31:33 -040032#include <glib/gatomic.h>
Owen Taylor2fd6b002001-06-26 16:01:21 +000033#include <glib/gerror.h>
Chun-wei Fan433fc942015-02-09 15:42:01 +080034#include <glib/gutils.h>
Sebastian Wilhelmib1d15582000-10-12 11:52:07 +000035
36G_BEGIN_DECLS
37
Sebastian Wilhelmi41e20012001-02-13 15:57:44 +000038#define G_THREAD_ERROR g_thread_error_quark ()
Ryan Lortie01560922012-12-06 14:04:59 -050039GLIB_AVAILABLE_IN_ALL
Ryan Lortie08a6d812011-10-04 20:31:33 -040040GQuark g_thread_error_quark (void);
Sebastian Wilhelmib1d15582000-10-12 11:52:07 +000041
42typedef enum
43{
44 G_THREAD_ERROR_AGAIN /* Resource temporarily unavailable */
45} GThreadError;
46
Sebastian Wilhelmia8c9dad2001-05-09 12:51:21 +000047typedef gpointer (*GThreadFunc) (gpointer data);
Sebastian Wilhelmib1d15582000-10-12 11:52:07 +000048
Sebastian Wilhelmib1d15582000-10-12 11:52:07 +000049typedef struct _GThread GThread;
Sebastian Wilhelmib1d15582000-10-12 11:52:07 +000050
Ryan Lortiec5634df2011-10-02 20:59:15 -040051typedef union _GMutex GMutex;
Ryan Lortiead187e32011-09-21 14:36:53 -040052typedef struct _GRecMutex GRecMutex;
Ryan Lortie3d410272011-09-21 10:19:36 -040053typedef struct _GRWLock GRWLock;
Sebastian Wilhelmib1d15582000-10-12 11:52:07 +000054typedef struct _GCond GCond;
55typedef struct _GPrivate GPrivate;
Ryan Lortie08a6d812011-10-04 20:31:33 -040056typedef struct _GOnce GOnce;
Sebastian Wilhelmib1d15582000-10-12 11:52:07 +000057
Ryan Lortiec5634df2011-10-02 20:59:15 -040058union _GMutex
Ryan Lortie80730bc2011-09-16 18:05:23 -040059{
Ryan Lortiec5634df2011-10-02 20:59:15 -040060 /*< private >*/
61 gpointer p;
62 guint i[2];
Ryan Lortie3d410272011-09-21 10:19:36 -040063};
64
Ryan Lortie3d410272011-09-21 10:19:36 -040065struct _GRWLock
66{
Ryan Lortiec5634df2011-10-02 20:59:15 -040067 /*< private >*/
68 gpointer p;
69 guint i[2];
Ryan Lortie80730bc2011-09-16 18:05:23 -040070};
71
Ryan Lortie80730bc2011-09-16 18:05:23 -040072struct _GCond
73{
Ryan Lortiec5634df2011-10-02 20:59:15 -040074 /*< private >*/
75 gpointer p;
76 guint i[2];
Ryan Lortie80730bc2011-09-16 18:05:23 -040077};
Ryan Lortie80730bc2011-09-16 18:05:23 -040078
Ryan Lortiead187e32011-09-21 14:36:53 -040079struct _GRecMutex
80{
Ryan Lortiec5634df2011-10-02 20:59:15 -040081 /*< private >*/
82 gpointer p;
83 guint i[2];
Ryan Lortiead187e32011-09-21 14:36:53 -040084};
85
Ryan Lortie8e434702011-09-30 14:22:04 -040086#define G_PRIVATE_INIT(notify) { NULL, (notify), { NULL, NULL } }
87struct _GPrivate
88{
Ryan Lortie083812f2011-10-06 12:19:58 -040089 /*< private >*/
Ryan Lortie8e434702011-09-30 14:22:04 -040090 gpointer p;
91 GDestroyNotify notify;
92 gpointer future[2];
93};
94
Matthias Clasen876f9072003-07-08 23:43:48 +000095typedef enum
96{
97 G_ONCE_STATUS_NOTCALLED,
98 G_ONCE_STATUS_PROGRESS,
Matthias Clasen81e395b2011-09-25 01:32:41 -040099 G_ONCE_STATUS_READY
Matthias Clasen876f9072003-07-08 23:43:48 +0000100} GOnceStatus;
101
Ryan Lortie08a6d812011-10-04 20:31:33 -0400102#define G_ONCE_INIT { G_ONCE_STATUS_NOTCALLED, NULL }
Matthias Clasen876f9072003-07-08 23:43:48 +0000103struct _GOnce
104{
105 volatile GOnceStatus status;
106 volatile gpointer retval;
107};
108
Ryan Lortie08a6d812011-10-04 20:31:33 -0400109#define G_LOCK_NAME(name) g__ ## name ## _lock
Dan Winship5bc77292011-08-31 14:01:45 -0400110#define G_LOCK_DEFINE_STATIC(name) static G_LOCK_DEFINE (name)
Ryan Lortie2a677d12011-10-02 20:51:38 -0400111#define G_LOCK_DEFINE(name) GMutex G_LOCK_NAME (name)
Ryan Lortiecf26a6f2011-09-17 18:33:25 -0400112#define G_LOCK_EXTERN(name) extern GMutex G_LOCK_NAME (name)
Sebastian Wilhelmib1d15582000-10-12 11:52:07 +0000113
Dan Winship5bc77292011-08-31 14:01:45 -0400114#ifdef G_DEBUG_LOCKS
115# define G_LOCK(name) G_STMT_START{ \
116 g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG, \
117 "file %s: line %d (%s): locking: %s ", \
118 __FILE__, __LINE__, G_STRFUNC, \
119 #name); \
Ryan Lortiecf26a6f2011-09-17 18:33:25 -0400120 g_mutex_lock (&G_LOCK_NAME (name)); \
Dan Winship5bc77292011-08-31 14:01:45 -0400121 }G_STMT_END
122# define G_UNLOCK(name) G_STMT_START{ \
123 g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG, \
124 "file %s: line %d (%s): unlocking: %s ", \
125 __FILE__, __LINE__, G_STRFUNC, \
126 #name); \
Ryan Lortiecf26a6f2011-09-17 18:33:25 -0400127 g_mutex_unlock (&G_LOCK_NAME (name)); \
Dan Winship5bc77292011-08-31 14:01:45 -0400128 }G_STMT_END
129# define G_TRYLOCK(name) \
130 (g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG, \
131 "file %s: line %d (%s): try locking: %s ", \
132 __FILE__, __LINE__, G_STRFUNC, \
Ryan Lortiecf26a6f2011-09-17 18:33:25 -0400133 #name), g_mutex_trylock (&G_LOCK_NAME (name)))
Dan Winship5bc77292011-08-31 14:01:45 -0400134#else /* !G_DEBUG_LOCKS */
Ryan Lortiecf26a6f2011-09-17 18:33:25 -0400135# define G_LOCK(name) g_mutex_lock (&G_LOCK_NAME (name))
136# define G_UNLOCK(name) g_mutex_unlock (&G_LOCK_NAME (name))
137# define G_TRYLOCK(name) g_mutex_trylock (&G_LOCK_NAME (name))
Dan Winship5bc77292011-08-31 14:01:45 -0400138#endif /* !G_DEBUG_LOCKS */
Sebastian Wilhelmib1d15582000-10-12 11:52:07 +0000139
Will Thompson5ff999242012-11-14 14:59:42 +0000140GLIB_AVAILABLE_IN_2_32
Ryan Lortieb0e73ca2011-10-13 00:29:04 -0400141GThread * g_thread_ref (GThread *thread);
Will Thompson5ff999242012-11-14 14:59:42 +0000142GLIB_AVAILABLE_IN_2_32
Ryan Lortieb0e73ca2011-10-13 00:29:04 -0400143void g_thread_unref (GThread *thread);
Will Thompson5ff999242012-11-14 14:59:42 +0000144GLIB_AVAILABLE_IN_2_32
Ryan Lortie08a6d812011-10-04 20:31:33 -0400145GThread * g_thread_new (const gchar *name,
146 GThreadFunc func,
Ryan Lortie430c5632011-10-13 01:00:57 -0400147 gpointer data);
Will Thompson5ff999242012-11-14 14:59:42 +0000148GLIB_AVAILABLE_IN_2_32
Ryan Lortiee75e9c32011-10-15 09:48:10 -0400149GThread * g_thread_try_new (const gchar *name,
Ryan Lortie430c5632011-10-13 01:00:57 -0400150 GThreadFunc func,
Ryan Lortie08a6d812011-10-04 20:31:33 -0400151 gpointer data,
Ryan Lortie08a6d812011-10-04 20:31:33 -0400152 GError **error);
Ryan Lortie01560922012-12-06 14:04:59 -0500153GLIB_AVAILABLE_IN_ALL
Ryan Lortie08a6d812011-10-04 20:31:33 -0400154GThread * g_thread_self (void);
Ryan Lortie01560922012-12-06 14:04:59 -0500155GLIB_AVAILABLE_IN_ALL
Ryan Lortie08a6d812011-10-04 20:31:33 -0400156void g_thread_exit (gpointer retval);
Ryan Lortie01560922012-12-06 14:04:59 -0500157GLIB_AVAILABLE_IN_ALL
Ryan Lortie08a6d812011-10-04 20:31:33 -0400158gpointer g_thread_join (GThread *thread);
Ryan Lortie01560922012-12-06 14:04:59 -0500159GLIB_AVAILABLE_IN_ALL
Ryan Lortie08a6d812011-10-04 20:31:33 -0400160void g_thread_yield (void);
Ryan Lortie80730bc2011-09-16 18:05:23 -0400161
Ryan Lortie80730bc2011-09-16 18:05:23 -0400162
Will Thompson5ff999242012-11-14 14:59:42 +0000163GLIB_AVAILABLE_IN_2_32
Ryan Lortie08a6d812011-10-04 20:31:33 -0400164void g_mutex_init (GMutex *mutex);
Will Thompson5ff999242012-11-14 14:59:42 +0000165GLIB_AVAILABLE_IN_2_32
Ryan Lortie08a6d812011-10-04 20:31:33 -0400166void g_mutex_clear (GMutex *mutex);
Ryan Lortie01560922012-12-06 14:04:59 -0500167GLIB_AVAILABLE_IN_ALL
Ryan Lortie08a6d812011-10-04 20:31:33 -0400168void g_mutex_lock (GMutex *mutex);
Ryan Lortie01560922012-12-06 14:04:59 -0500169GLIB_AVAILABLE_IN_ALL
Ryan Lortie08a6d812011-10-04 20:31:33 -0400170gboolean g_mutex_trylock (GMutex *mutex);
Ryan Lortie01560922012-12-06 14:04:59 -0500171GLIB_AVAILABLE_IN_ALL
Ryan Lortie08a6d812011-10-04 20:31:33 -0400172void g_mutex_unlock (GMutex *mutex);
Ryan Lortie80730bc2011-09-16 18:05:23 -0400173
Will Thompson5ff999242012-11-14 14:59:42 +0000174GLIB_AVAILABLE_IN_2_32
Ryan Lortie08a6d812011-10-04 20:31:33 -0400175void g_rw_lock_init (GRWLock *rw_lock);
Will Thompson5ff999242012-11-14 14:59:42 +0000176GLIB_AVAILABLE_IN_2_32
Ryan Lortie08a6d812011-10-04 20:31:33 -0400177void g_rw_lock_clear (GRWLock *rw_lock);
Will Thompson5ff999242012-11-14 14:59:42 +0000178GLIB_AVAILABLE_IN_2_32
Ryan Lortie08a6d812011-10-04 20:31:33 -0400179void g_rw_lock_writer_lock (GRWLock *rw_lock);
Will Thompson5ff999242012-11-14 14:59:42 +0000180GLIB_AVAILABLE_IN_2_32
Ryan Lortie08a6d812011-10-04 20:31:33 -0400181gboolean g_rw_lock_writer_trylock (GRWLock *rw_lock);
Will Thompson5ff999242012-11-14 14:59:42 +0000182GLIB_AVAILABLE_IN_2_32
Ryan Lortie08a6d812011-10-04 20:31:33 -0400183void g_rw_lock_writer_unlock (GRWLock *rw_lock);
Will Thompson5ff999242012-11-14 14:59:42 +0000184GLIB_AVAILABLE_IN_2_32
Ryan Lortie08a6d812011-10-04 20:31:33 -0400185void g_rw_lock_reader_lock (GRWLock *rw_lock);
Will Thompson5ff999242012-11-14 14:59:42 +0000186GLIB_AVAILABLE_IN_2_32
Ryan Lortie08a6d812011-10-04 20:31:33 -0400187gboolean g_rw_lock_reader_trylock (GRWLock *rw_lock);
Will Thompson5ff999242012-11-14 14:59:42 +0000188GLIB_AVAILABLE_IN_2_32
Ryan Lortie08a6d812011-10-04 20:31:33 -0400189void g_rw_lock_reader_unlock (GRWLock *rw_lock);
Ryan Lortie3d410272011-09-21 10:19:36 -0400190
Will Thompson5ff999242012-11-14 14:59:42 +0000191GLIB_AVAILABLE_IN_2_32
Ryan Lortie08a6d812011-10-04 20:31:33 -0400192void g_rec_mutex_init (GRecMutex *rec_mutex);
Will Thompson5ff999242012-11-14 14:59:42 +0000193GLIB_AVAILABLE_IN_2_32
Ryan Lortie08a6d812011-10-04 20:31:33 -0400194void g_rec_mutex_clear (GRecMutex *rec_mutex);
Will Thompson5ff999242012-11-14 14:59:42 +0000195GLIB_AVAILABLE_IN_2_32
Ryan Lortie08a6d812011-10-04 20:31:33 -0400196void g_rec_mutex_lock (GRecMutex *rec_mutex);
Will Thompson5ff999242012-11-14 14:59:42 +0000197GLIB_AVAILABLE_IN_2_32
Ryan Lortie08a6d812011-10-04 20:31:33 -0400198gboolean g_rec_mutex_trylock (GRecMutex *rec_mutex);
Will Thompson5ff999242012-11-14 14:59:42 +0000199GLIB_AVAILABLE_IN_2_32
Ryan Lortie08a6d812011-10-04 20:31:33 -0400200void g_rec_mutex_unlock (GRecMutex *rec_mutex);
Ryan Lortiead187e32011-09-21 14:36:53 -0400201
Will Thompson5ff999242012-11-14 14:59:42 +0000202GLIB_AVAILABLE_IN_2_32
Ryan Lortie08a6d812011-10-04 20:31:33 -0400203void g_cond_init (GCond *cond);
Will Thompson5ff999242012-11-14 14:59:42 +0000204GLIB_AVAILABLE_IN_2_32
Ryan Lortie08a6d812011-10-04 20:31:33 -0400205void g_cond_clear (GCond *cond);
Ryan Lortie01560922012-12-06 14:04:59 -0500206GLIB_AVAILABLE_IN_ALL
Ryan Lortie08a6d812011-10-04 20:31:33 -0400207void g_cond_wait (GCond *cond,
208 GMutex *mutex);
Ryan Lortie01560922012-12-06 14:04:59 -0500209GLIB_AVAILABLE_IN_ALL
Ryan Lortie08a6d812011-10-04 20:31:33 -0400210void g_cond_signal (GCond *cond);
Ryan Lortie01560922012-12-06 14:04:59 -0500211GLIB_AVAILABLE_IN_ALL
Ryan Lortie08a6d812011-10-04 20:31:33 -0400212void g_cond_broadcast (GCond *cond);
Will Thompson5ff999242012-11-14 14:59:42 +0000213GLIB_AVAILABLE_IN_2_32
Ryan Lortie4033c612011-10-13 23:24:23 -0400214gboolean g_cond_wait_until (GCond *cond,
Ryan Lortie08a6d812011-10-04 20:31:33 -0400215 GMutex *mutex,
Matthias Clasen117e5342011-10-15 16:50:23 -0400216 gint64 end_time);
Ryan Lortie80730bc2011-09-16 18:05:23 -0400217
Ryan Lortie01560922012-12-06 14:04:59 -0500218GLIB_AVAILABLE_IN_ALL
Ryan Lortie08a6d812011-10-04 20:31:33 -0400219gpointer g_private_get (GPrivate *key);
Ryan Lortie01560922012-12-06 14:04:59 -0500220GLIB_AVAILABLE_IN_ALL
Ryan Lortie08a6d812011-10-04 20:31:33 -0400221void g_private_set (GPrivate *key,
222 gpointer value);
Will Thompson5ff999242012-11-14 14:59:42 +0000223GLIB_AVAILABLE_IN_2_32
Ryan Lortie08a6d812011-10-04 20:31:33 -0400224void g_private_replace (GPrivate *key,
225 gpointer value);
Ryan Lortie80730bc2011-09-16 18:05:23 -0400226
Ryan Lortie01560922012-12-06 14:04:59 -0500227GLIB_AVAILABLE_IN_ALL
Ryan Lortie08a6d812011-10-04 20:31:33 -0400228gpointer g_once_impl (GOnce *once,
229 GThreadFunc func,
230 gpointer arg);
Ryan Lortie01560922012-12-06 14:04:59 -0500231GLIB_AVAILABLE_IN_ALL
Ryan Lortie08a6d812011-10-04 20:31:33 -0400232gboolean g_once_init_enter (volatile void *location);
Ryan Lortie01560922012-12-06 14:04:59 -0500233GLIB_AVAILABLE_IN_ALL
Ryan Lortie08a6d812011-10-04 20:31:33 -0400234void g_once_init_leave (volatile void *location,
235 gsize result);
236
237#ifdef G_ATOMIC_OP_MEMORY_BARRIER_NEEDED
238# define g_once(once, func, arg) g_once_impl ((once), (func), (arg))
239#else /* !G_ATOMIC_OP_MEMORY_BARRIER_NEEDED*/
240# define g_once(once, func, arg) \
241 (((once)->status == G_ONCE_STATUS_READY) ? \
242 (once)->retval : \
243 g_once_impl ((once), (func), (arg)))
244#endif /* G_ATOMIC_OP_MEMORY_BARRIER_NEEDED */
245
246#ifdef __GNUC__
247# define g_once_init_enter(location) \
248 (G_GNUC_EXTENSION ({ \
249 G_STATIC_ASSERT (sizeof *(location) == sizeof (gpointer)); \
250 (void) (0 ? (gpointer) *(location) : 0); \
251 (!g_atomic_pointer_get (location) && \
252 g_once_init_enter (location)); \
253 }))
254# define g_once_init_leave(location, result) \
255 (G_GNUC_EXTENSION ({ \
256 G_STATIC_ASSERT (sizeof *(location) == sizeof (gpointer)); \
257 (void) (0 ? *(location) = (result) : 0); \
258 g_once_init_leave ((location), (gsize) (result)); \
259 }))
260#else
261# define g_once_init_enter(location) \
262 (g_once_init_enter((location)))
263# define g_once_init_leave(location, result) \
264 (g_once_init_leave((location), (gsize) (result)))
265#endif
Ryan Lortieb0d83572011-09-17 22:00:27 -0400266
Colin Walters2149b292012-12-17 10:47:53 -0500267GLIB_AVAILABLE_IN_2_36
268guint g_get_num_processors (void);
269
Xavier Claessens1404d3e2015-02-05 10:35:42 -0500270/**
271 * GMutexLocker:
272 *
273 * Opaque type. See g_mutex_locker_new() for details.
274 * Since: 2.44
275 */
276typedef void GMutexLocker;
277
278/**
279 * g_mutex_locker_new:
280 * @mutex: a mutex to lock
281 *
282 * Lock @mutex and return a new #GMutexLocker. Unlock with
283 * g_mutex_locker_free(). Using g_mutex_unlock() on @mutex
284 * while a #GMutexLocker exists can lead to undefined behaviour.
285 *
286 * This is intended to be used with g_autoptr(). Note that g_autoptr()
287 * is only available when using GCC or clang, so the following example
288 * will only work with those compilers:
289 * |[
290 * typedef struct
291 * {
292 * ...
293 * GMutex mutex;
294 * ...
295 * } MyObject;
296 *
297 * static void
298 * my_object_do_stuff (MyObject *self)
299 * {
300 * g_autoptr(GMutexLocker) locker = g_mutex_locker_new (&self->mutex);
301 *
302 * // Code with mutex locked here
303 *
304 * if (cond)
305 * // No need to unlock
306 * return;
307 *
308 * // Optionally early unlock
309 * g_clear_pointer (&locker, g_mutex_locker_free);
310 *
311 * // Code with mutex unlocked here
312 * }
313 * ]|
314 *
315 * Returns: a #GMutexLocker
316 * Since: 2.44
317 */
318static inline GMutexLocker *
319g_mutex_locker_new (GMutex *mutex)
320{
321 g_mutex_lock (mutex);
322 return (GMutexLocker *) mutex;
323}
324
325/**
326 * g_mutex_locker_free:
327 * @locker: a GMutexLocker
328 *
329 * Unlock @locker's mutex. See g_mutex_locker_new() for details.
330 *
331 * Since: 2.44
332 */
333static inline void
334g_mutex_locker_free (GMutexLocker *locker)
335{
336 g_mutex_unlock ((GMutex *) locker);
337}
338
Sebastian Wilhelmib1d15582000-10-12 11:52:07 +0000339G_END_DECLS
340
341#endif /* __G_THREAD_H__ */