1 /* GLIB - Library of useful routines for C programming
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * 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 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * Modified by the GLib Team and others 1997-2000. See the AUTHORS
22 * file for a list of people on the GLib Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GLib at ftp://ftp.gtk.org/pub/gtk/.
27 #if defined(G_DISABLE_SINGLE_INCLUDES) && !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
28 #error "Only <glib.h> can be included directly."
31 #ifndef __G_THREAD_H__
32 #define __G_THREAD_H__
34 #include <glib/gerror.h>
35 #include <glib/gutils.h> /* for G_INLINE_FUNC */
36 #include <glib/gatomic.h> /* for g_atomic_pointer_get */
40 /* GLib Thread support
43 extern GQuark g_thread_error_quark (void);
44 #define G_THREAD_ERROR g_thread_error_quark ()
48 G_THREAD_ERROR_AGAIN /* Resource temporarily unavailable */
51 typedef gpointer (*GThreadFunc) (gpointer data);
53 /* This is "deprecated", but we can't actually remove it since
54 * g_thread_create_full takes it.
58 G_THREAD_PRIORITY_LOW,
59 G_THREAD_PRIORITY_NORMAL,
60 G_THREAD_PRIORITY_HIGH,
61 G_THREAD_PRIORITY_URGENT
64 typedef struct _GThread GThread;
71 GThreadPriority priority;
74 typedef struct _GMutex GMutex;
75 typedef struct _GCond GCond;
76 typedef struct _GPrivate GPrivate;
77 typedef struct _GStaticPrivate GStaticPrivate;
81 #define G_MUTEX_INIT { NULL }
87 #define G_COND_INIT { NULL }
96 #define G_MUTEX_INIT { PTHREAD_MUTEX_INITIALIZER }
102 #define G_COND_INIT { PTHREAD_COND_INITIALIZER }
110 typedef struct _GThreadFunctions GThreadFunctions;
111 struct _GThreadFunctions
113 GMutex* (*mutex_new) (void);
114 void (*mutex_lock) (GMutex *mutex);
115 gboolean (*mutex_trylock) (GMutex *mutex);
116 void (*mutex_unlock) (GMutex *mutex);
117 void (*mutex_free) (GMutex *mutex);
118 GCond* (*cond_new) (void);
119 void (*cond_signal) (GCond *cond);
120 void (*cond_broadcast) (GCond *cond);
121 void (*cond_wait) (GCond *cond,
123 gboolean (*cond_timed_wait) (GCond *cond,
126 void (*cond_free) (GCond *cond);
127 GPrivate* (*private_new) (GDestroyNotify destructor);
128 gpointer (*private_get) (GPrivate *private_key);
129 void (*private_set) (GPrivate *private_key,
131 void (*thread_create) (GThreadFunc func,
136 GThreadPriority priority,
139 void (*thread_yield) (void);
140 void (*thread_join) (gpointer thread);
141 void (*thread_exit) (void);
142 void (*thread_set_priority)(gpointer thread,
143 GThreadPriority priority);
144 void (*thread_self) (gpointer thread);
145 gboolean (*thread_equal) (gpointer thread1,
149 GLIB_VAR GThreadFunctions g_thread_functions_for_glib_use;
150 GLIB_VAR gboolean g_thread_use_default_impl;
151 GLIB_VAR gboolean g_threads_got_initialized;
153 #ifndef G_DISABLE_DEPRECATED
154 GLIB_VAR guint64 (*g_thread_gettime) (void);
157 /* initializes the mutex/cond/private implementation for glib, might
158 * only be called once, and must not be called directly or indirectly
159 * from another glib-function, e.g. as a callback.
161 void g_thread_init (GThreadFunctions *vtable);
163 /* Checks if thread support is initialized. Identical to the
164 * g_thread_supported macro but provided for language bindings.
166 gboolean g_thread_get_initialized (void);
168 /* internal function for fallback static mutex implementation */
169 GMutex* g_static_mutex_get_mutex_impl (GMutex **mutex);
171 #if defined(G_THREADS_MANDATORY)
172 #define g_thread_supported() 1
174 #define g_thread_supported() (g_threads_got_initialized)
177 #ifndef G_DISABLE_DEPRECATED
178 GThread* g_thread_create_full (GThreadFunc func,
183 GThreadPriority priority,
187 GThread * g_thread_create (GThreadFunc func,
192 GThread * g_thread_create_with_stack_size (GThreadFunc func,
198 GThread* g_thread_self (void);
199 void g_thread_exit (gpointer retval);
200 gpointer g_thread_join (GThread *thread);
201 void g_thread_yield (void);
203 #ifndef G_DISABLE_DEPRECATED
204 void g_thread_set_priority (GThread *thread,
205 GThreadPriority priority);
209 typedef GMutex * GStaticMutex;
210 #define G_STATIC_MUTEX_INIT NULL
211 #define g_static_mutex_get_mutex g_static_mutex_get_mutex_impl
212 #else /* G_OS_WIN32 */
214 struct _GMutex *unused;
217 #define G_STATIC_MUTEX_INIT { NULL, G_MUTEX_INIT }
218 #define g_static_mutex_get_mutex(s) (&(s)->mutex)
219 #endif /* G_OS_WIN32 */
221 #define g_static_mutex_lock(mutex) \
222 g_mutex_lock (g_static_mutex_get_mutex (mutex))
223 #define g_static_mutex_trylock(mutex) \
224 g_mutex_trylock (g_static_mutex_get_mutex (mutex))
225 #define g_static_mutex_unlock(mutex) \
226 g_mutex_unlock (g_static_mutex_get_mutex (mutex))
227 void g_static_mutex_init (GStaticMutex *mutex);
228 void g_static_mutex_free (GStaticMutex *mutex);
230 struct _GStaticPrivate
235 #define G_STATIC_PRIVATE_INIT { 0 }
236 void g_static_private_init (GStaticPrivate *private_key);
237 gpointer g_static_private_get (GStaticPrivate *private_key);
238 void g_static_private_set (GStaticPrivate *private_key,
240 GDestroyNotify notify);
241 void g_static_private_free (GStaticPrivate *private_key);
243 typedef struct _GStaticRecMutex GStaticRecMutex;
244 struct _GStaticRecMutex
252 #define G_STATIC_REC_MUTEX_INIT { G_STATIC_MUTEX_INIT, 0, {{0, 0, 0, 0}} }
253 void g_static_rec_mutex_init (GStaticRecMutex *mutex);
254 void g_static_rec_mutex_lock (GStaticRecMutex *mutex);
255 gboolean g_static_rec_mutex_trylock (GStaticRecMutex *mutex);
256 void g_static_rec_mutex_unlock (GStaticRecMutex *mutex);
257 void g_static_rec_mutex_lock_full (GStaticRecMutex *mutex,
259 guint g_static_rec_mutex_unlock_full (GStaticRecMutex *mutex);
260 void g_static_rec_mutex_free (GStaticRecMutex *mutex);
262 typedef struct _GStaticRWLock GStaticRWLock;
263 struct _GStaticRWLock
270 gboolean have_writer;
275 #define G_STATIC_RW_LOCK_INIT { G_STATIC_MUTEX_INIT, NULL, NULL, 0, FALSE, 0, 0 }
277 void g_static_rw_lock_init (GStaticRWLock* lock);
278 void g_static_rw_lock_reader_lock (GStaticRWLock* lock);
279 gboolean g_static_rw_lock_reader_trylock (GStaticRWLock* lock);
280 void g_static_rw_lock_reader_unlock (GStaticRWLock* lock);
281 void g_static_rw_lock_writer_lock (GStaticRWLock* lock);
282 gboolean g_static_rw_lock_writer_trylock (GStaticRWLock* lock);
283 void g_static_rw_lock_writer_unlock (GStaticRWLock* lock);
284 void g_static_rw_lock_free (GStaticRWLock* lock);
286 void g_thread_foreach (GFunc thread_func,
291 G_ONCE_STATUS_NOTCALLED,
292 G_ONCE_STATUS_PROGRESS,
296 typedef struct _GOnce GOnce;
299 volatile GOnceStatus status;
300 volatile gpointer retval;
303 #define G_ONCE_INIT { G_ONCE_STATUS_NOTCALLED, NULL }
305 gpointer g_once_impl (GOnce *once, GThreadFunc func, gpointer arg);
307 #ifdef G_ATOMIC_OP_MEMORY_BARRIER_NEEDED
308 # define g_once(once, func, arg) g_once_impl ((once), (func), (arg))
309 #else /* !G_ATOMIC_OP_MEMORY_BARRIER_NEEDED*/
310 # define g_once(once, func, arg) \
311 (((once)->status == G_ONCE_STATUS_READY) ? \
313 g_once_impl ((once), (func), (arg)))
314 #endif /* G_ATOMIC_OP_MEMORY_BARRIER_NEEDED */
316 /* initialize-once guards, keyed by value_location */
317 G_INLINE_FUNC gboolean g_once_init_enter (volatile gsize *value_location);
318 gboolean g_once_init_enter_impl (volatile gsize *value_location);
319 void g_once_init_leave (volatile gsize *value_location,
320 gsize initialization_value);
321 #if defined (G_CAN_INLINE) || defined (__G_THREAD_C__)
322 G_INLINE_FUNC gboolean
323 g_once_init_enter (volatile gsize *value_location)
325 if G_LIKELY ((gpointer) g_atomic_pointer_get (value_location) != NULL)
328 return g_once_init_enter_impl (value_location);
330 #endif /* G_CAN_INLINE || __G_THREAD_C__ */
332 /* these are some convenience macros that expand to nothing if GLib
333 * was configured with --disable-threads. for using StaticMutexes,
334 * you define them with G_LOCK_DEFINE_STATIC (name) or G_LOCK_DEFINE (name)
335 * if you need to export the mutex. With G_LOCK_EXTERN (name) you can
336 * declare such an globally defined lock. name is a unique identifier
337 * for the protected varibale or code portion. locking, testing and
338 * unlocking of such mutexes can be done with G_LOCK(), G_UNLOCK() and
339 * G_TRYLOCK() respectively.
341 extern void glib_dummy_decl (void);
342 #define G_LOCK_NAME(name) g__ ## name ## _lock
343 #define G_LOCK_DEFINE_STATIC(name) static G_LOCK_DEFINE (name)
344 #define G_LOCK_DEFINE(name) \
345 GMutex G_LOCK_NAME (name) = G_MUTEX_INIT
346 #define G_LOCK_EXTERN(name) extern GMutex G_LOCK_NAME (name)
349 # define G_LOCK(name) G_STMT_START{ \
350 g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG, \
351 "file %s: line %d (%s): locking: %s ", \
352 __FILE__, __LINE__, G_STRFUNC, \
354 g_mutex_lock (&G_LOCK_NAME (name)); \
356 # define G_UNLOCK(name) G_STMT_START{ \
357 g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG, \
358 "file %s: line %d (%s): unlocking: %s ", \
359 __FILE__, __LINE__, G_STRFUNC, \
361 g_mutex_unlock (&G_LOCK_NAME (name)); \
363 # define G_TRYLOCK(name) \
364 (g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG, \
365 "file %s: line %d (%s): try locking: %s ", \
366 __FILE__, __LINE__, G_STRFUNC, \
367 #name), g_mutex_trylock (&G_LOCK_NAME (name)))
368 #else /* !G_DEBUG_LOCKS */
369 # define G_LOCK(name) g_mutex_lock (&G_LOCK_NAME (name))
370 # define G_UNLOCK(name) g_mutex_unlock (&G_LOCK_NAME (name))
371 # define G_TRYLOCK(name) g_mutex_trylock (&G_LOCK_NAME (name))
372 #endif /* !G_DEBUG_LOCKS */
375 void g_mutex_init (GMutex *mutex);
376 void g_mutex_clear (GMutex *mutex);
378 void g_mutex_lock (GMutex *mutex);
379 void g_mutex_unlock (GMutex *mutex);
380 gboolean g_mutex_trylock (GMutex *mutex);
382 void g_cond_init (GCond *cond);
383 void g_cond_clear (GCond *cond);
385 void g_cond_wait (GCond *cond,
387 void g_cond_signal (GCond *cond);
388 void g_cond_broadcast (GCond *cond);
389 gboolean g_cond_timed_wait (GCond *cond,
392 gboolean g_cond_timedwait (GCond *cond,
396 GMutex * g_mutex_new (void);
397 void g_mutex_free (GMutex *mutex);
398 GCond * g_cond_new (void);
399 void g_cond_free (GCond *cond);
401 GPrivate * g_private_new (GDestroyNotify notify);
402 gpointer g_private_get (GPrivate *key);
403 void g_private_set (GPrivate *key,
408 #endif /* __G_THREAD_H__ */