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 #ifndef __G_THREAD_H__
28 #define __G_THREAD_H__
30 #include <glib/gerror.h>
31 #include <glib/gtypes.h>
35 /* GLib Thread support
38 extern GQuark g_thread_error_quark (void);
39 #define G_THREAD_ERROR g_thread_error_quark ()
43 G_THREAD_ERROR_AGAIN /* Resource temporarily unavailable */
46 typedef gpointer (*GThreadFunc) (gpointer data);
50 G_THREAD_PRIORITY_LOW,
51 G_THREAD_PRIORITY_NORMAL,
52 G_THREAD_PRIORITY_HIGH,
53 G_THREAD_PRIORITY_URGENT
56 typedef struct _GThread GThread;
63 GThreadPriority priority;
66 typedef struct _GMutex GMutex;
67 typedef struct _GCond GCond;
68 typedef struct _GPrivate GPrivate;
69 typedef struct _GStaticPrivate GStaticPrivate;
71 typedef struct _GThreadFunctions GThreadFunctions;
72 struct _GThreadFunctions
74 GMutex* (*mutex_new) (void);
75 void (*mutex_lock) (GMutex *mutex);
76 gboolean (*mutex_trylock) (GMutex *mutex);
77 void (*mutex_unlock) (GMutex *mutex);
78 void (*mutex_free) (GMutex *mutex);
79 GCond* (*cond_new) (void);
80 void (*cond_signal) (GCond *cond);
81 void (*cond_broadcast) (GCond *cond);
82 void (*cond_wait) (GCond *cond,
84 gboolean (*cond_timed_wait) (GCond *cond,
87 void (*cond_free) (GCond *cond);
88 GPrivate* (*private_new) (GDestroyNotify destructor);
89 gpointer (*private_get) (GPrivate *private_key);
90 void (*private_set) (GPrivate *private_key,
92 void (*thread_create) (GThreadFunc func,
97 GThreadPriority priority,
100 void (*thread_yield) (void);
101 void (*thread_join) (gpointer thread);
102 void (*thread_exit) (void);
103 void (*thread_set_priority)(gpointer thread,
104 GThreadPriority priority);
105 void (*thread_self) (gpointer thread);
106 gboolean (*thread_equal) (gpointer thread1,
110 GLIB_VAR GThreadFunctions g_thread_functions_for_glib_use;
111 GLIB_VAR gboolean g_thread_use_default_impl;
112 GLIB_VAR gboolean g_threads_got_initialized;
114 /* initializes the mutex/cond/private implementation for glib, might
115 * only be called once, and must not be called directly or indirectly
116 * from another glib-function, e.g. as a callback.
118 void g_thread_init (GThreadFunctions *vtable);
120 /* Errorcheck mutexes. If you define G_ERRORCHECK_MUTEXES, then all
121 * mutexes will check for re-locking and re-unlocking */
123 /* Initialize thread system with errorcheck mutexes. vtable must be
124 * NULL. Do not call directly. Use #define G_ERRORCHECK_MUTEXES
127 void g_thread_init_with_errorcheck_mutexes (GThreadFunctions* vtable);
129 /* A random number to recognize debug calls to g_mutex_... */
130 #define G_MUTEX_DEBUG_MAGIC 0xf8e18ad7
132 #ifdef G_ERRORCHECK_MUTEXES
133 #define g_thread_init(vtable) g_thread_init_with_errorcheck_mutexes (vtable)
136 /* internal function for fallback static mutex implementation */
137 GMutex* g_static_mutex_get_mutex_impl (GMutex **mutex);
139 /* shorthands for conditional and unconditional function calls */
141 #define G_THREAD_UF(op, arglist) \
142 (*g_thread_functions_for_glib_use . op) arglist
143 #define G_THREAD_CF(op, fail, arg) \
144 (g_thread_supported () ? G_THREAD_UF (op, arg) : (fail))
145 #define G_THREAD_ECF(op, fail, mutex, type) \
146 (g_thread_supported () ? ((type(*)(GMutex*, gulong, gchar*)) \
147 (*g_thread_functions_for_glib_use . op)) \
148 (mutex, G_MUTEX_DEBUG_MAGIC, G_STRLOC) : (fail))
150 #ifndef G_ERRORCHECK_MUTEXES
151 # define g_mutex_lock(mutex) \
152 G_THREAD_CF (mutex_lock, (void)0, (mutex))
153 # define g_mutex_trylock(mutex) \
154 G_THREAD_CF (mutex_trylock, TRUE, (mutex))
155 # define g_mutex_unlock(mutex) \
156 G_THREAD_CF (mutex_unlock, (void)0, (mutex))
157 # define g_mutex_free(mutex) \
158 G_THREAD_CF (mutex_free, (void)0, (mutex))
159 # define g_cond_wait(cond, mutex) \
160 G_THREAD_CF (cond_wait, (void)0, (cond, mutex))
161 # define g_cond_timed_wait(cond, mutex, abs_time) \
162 G_THREAD_CF (cond_timed_wait, TRUE, (cond, mutex, abs_time))
163 #else /* G_ERRORCHECK_MUTEXES */
164 # define g_mutex_lock(mutex) \
165 G_THREAD_ECF (mutex_lock, (void)0, (mutex), void)
166 # define g_mutex_trylock(mutex) \
167 G_THREAD_ECF (mutex_trylock, TRUE, (mutex), gboolean)
168 # define g_mutex_unlock(mutex) \
169 G_THREAD_ECF (mutex_unlock, (void)0, (mutex), void)
170 # define g_mutex_free(mutex) \
171 G_THREAD_ECF (mutex_free, (void)0, (mutex), void)
172 # define g_cond_wait(cond, mutex) \
173 (g_thread_supported () ? ((void(*)(GCond*, GMutex*, gulong, gchar*))\
174 g_thread_functions_for_glib_use.cond_wait) \
175 (cond, mutex, G_MUTEX_DEBUG_MAGIC, G_STRLOC) : (void) 0)
176 # define g_cond_timed_wait(cond, mutex, abs_time) \
177 (g_thread_supported () ? \
178 ((gboolean(*)(GCond*, GMutex*, GTimeVal*, gulong, gchar*)) \
179 g_thread_functions_for_glib_use.cond_timed_wait) \
180 (cond, mutex, abs_time, G_MUTEX_DEBUG_MAGIC, G_STRLOC) : TRUE)
181 #endif /* G_ERRORCHECK_MUTEXES */
183 #define g_thread_supported() (g_threads_got_initialized)
184 #define g_mutex_new() G_THREAD_UF (mutex_new, ())
185 #define g_cond_new() G_THREAD_UF (cond_new, ())
186 #define g_cond_signal(cond) G_THREAD_CF (cond_signal, (void)0, (cond))
187 #define g_cond_broadcast(cond) G_THREAD_CF (cond_broadcast, (void)0, (cond))
188 #define g_cond_free(cond) G_THREAD_CF (cond_free, (void)0, (cond))
189 #define g_private_new(destructor) G_THREAD_UF (private_new, (destructor))
190 #define g_private_get(private_key) G_THREAD_CF (private_get, \
191 ((gpointer)private_key), \
193 #define g_private_set(private_key, value) G_THREAD_CF (private_set, \
194 (void) (private_key = \
195 (GPrivate*) (value)), \
196 (private_key, value))
197 #define g_thread_yield() G_THREAD_CF (thread_yield, (void)0, ())
199 #define g_thread_create(func, data, joinable, error) \
200 (g_thread_create_full (func, data, 0, joinable, FALSE, \
201 G_THREAD_PRIORITY_NORMAL, error))
203 GThread* g_thread_create_full (GThreadFunc func,
208 GThreadPriority priority,
210 GThread* g_thread_self (void);
211 void g_thread_exit (gpointer retval);
212 gpointer g_thread_join (GThread *thread);
214 void g_thread_set_priority (GThread *thread,
215 GThreadPriority priority);
217 /* GStaticMutexes can be statically initialized with the value
218 * G_STATIC_MUTEX_INIT, and then they can directly be used, that is
219 * much easier, than having to explicitly allocate the mutex before
222 #define g_static_mutex_lock(mutex) \
223 g_mutex_lock (g_static_mutex_get_mutex (mutex))
224 #define g_static_mutex_trylock(mutex) \
225 g_mutex_trylock (g_static_mutex_get_mutex (mutex))
226 #define g_static_mutex_unlock(mutex) \
227 g_mutex_unlock (g_static_mutex_get_mutex (mutex))
228 void g_static_mutex_init (GStaticMutex *mutex);
229 void g_static_mutex_free (GStaticMutex *mutex);
231 struct _GStaticPrivate
236 #define G_STATIC_PRIVATE_INIT { 0 }
237 void g_static_private_init (GStaticPrivate *private_key);
238 gpointer g_static_private_get (GStaticPrivate *private_key);
239 void g_static_private_set (GStaticPrivate *private_key,
241 GDestroyNotify notify);
242 void g_static_private_free (GStaticPrivate *private_key);
244 typedef struct _GStaticRecMutex GStaticRecMutex;
245 struct _GStaticRecMutex
253 #define G_STATIC_REC_MUTEX_INIT { G_STATIC_MUTEX_INIT }
254 void g_static_rec_mutex_init (GStaticRecMutex *mutex);
255 void g_static_rec_mutex_lock (GStaticRecMutex *mutex);
256 gboolean g_static_rec_mutex_trylock (GStaticRecMutex *mutex);
257 void g_static_rec_mutex_unlock (GStaticRecMutex *mutex);
258 void g_static_rec_mutex_lock_full (GStaticRecMutex *mutex,
260 guint g_static_rec_mutex_unlock_full (GStaticRecMutex *mutex);
261 void g_static_rec_mutex_free (GStaticRecMutex *mutex);
263 typedef struct _GStaticRWLock GStaticRWLock;
264 struct _GStaticRWLock
271 gboolean have_writer;
276 #define G_STATIC_RW_LOCK_INIT { G_STATIC_MUTEX_INIT, NULL, NULL, 0, FALSE, 0, 0 }
278 void g_static_rw_lock_init (GStaticRWLock* lock);
279 void g_static_rw_lock_reader_lock (GStaticRWLock* lock);
280 gboolean g_static_rw_lock_reader_trylock (GStaticRWLock* lock);
281 void g_static_rw_lock_reader_unlock (GStaticRWLock* lock);
282 void g_static_rw_lock_writer_lock (GStaticRWLock* lock);
283 gboolean g_static_rw_lock_writer_trylock (GStaticRWLock* lock);
284 void g_static_rw_lock_writer_unlock (GStaticRWLock* lock);
285 void g_static_rw_lock_free (GStaticRWLock* lock);
287 /* these are some convenience macros that expand to nothing if GLib
288 * was configured with --disable-threads. for using StaticMutexes,
289 * you define them with G_LOCK_DEFINE_STATIC (name) or G_LOCK_DEFINE (name)
290 * if you need to export the mutex. With G_LOCK_EXTERN (name) you can
291 * declare such an globally defined lock. name is a unique identifier
292 * for the protected varibale or code portion. locking, testing and
293 * unlocking of such mutexes can be done with G_LOCK(), G_UNLOCK() and
294 * G_TRYLOCK() respectively.
296 extern void glib_dummy_decl (void);
297 #define G_LOCK_NAME(name) g__ ## name ## _lock
298 #ifdef G_THREADS_ENABLED
299 # define G_LOCK_DEFINE_STATIC(name) static G_LOCK_DEFINE (name)
300 # define G_LOCK_DEFINE(name) \
301 GStaticMutex G_LOCK_NAME (name) = G_STATIC_MUTEX_INIT
302 # define G_LOCK_EXTERN(name) extern GStaticMutex G_LOCK_NAME (name)
304 # ifdef G_DEBUG_LOCKS
305 # define G_LOCK(name) G_STMT_START{ \
306 g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG, \
307 "file %s: line %d (%s): locking: %s ", \
308 __FILE__, __LINE__, G_GNUC_PRETTY_FUNCTION, \
310 g_static_mutex_lock (&G_LOCK_NAME (name)); \
312 # define G_UNLOCK(name) G_STMT_START{ \
313 g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG, \
314 "file %s: line %d (%s): unlocking: %s ", \
315 __FILE__, __LINE__, G_GNUC_PRETTY_FUNCTION, \
317 g_static_mutex_unlock (&G_LOCK_NAME (name)); \
319 # define G_TRYLOCK(name) \
320 (g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG, \
321 "file %s: line %d (%s): try locking: %s ", \
322 __FILE__, __LINE__, G_GNUC_PRETTY_FUNCTION, \
323 #name), g_static_mutex_trylock (&G_LOCK_NAME (name)))
324 # else /* !G_DEBUG_LOCKS */
325 # define G_LOCK(name) g_static_mutex_lock (&G_LOCK_NAME (name))
326 # define G_UNLOCK(name) g_static_mutex_unlock (&G_LOCK_NAME (name))
327 # define G_TRYLOCK(name) g_static_mutex_trylock (&G_LOCK_NAME (name))
328 # endif /* !G_DEBUG_LOCKS */
329 #else /* !G_THREADS_ENABLED */
330 # define G_LOCK_DEFINE_STATIC(name) extern void glib_dummy_decl (void)
331 # define G_LOCK_DEFINE(name) extern void glib_dummy_decl (void)
332 # define G_LOCK_EXTERN(name) extern void glib_dummy_decl (void)
333 # define G_LOCK(name)
334 # define G_UNLOCK(name)
335 # define G_TRYLOCK(name) (TRUE)
336 #endif /* !G_THREADS_ENABLED */
340 #endif /* __G_THREAD_H__ */