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 typedef struct _GThread GThread;
55 typedef struct _GMutex GMutex;
56 typedef struct _GRecMutex GRecMutex;
57 typedef struct _GRWLock GRWLock;
58 typedef struct _GCond GCond;
59 typedef struct _GPrivate GPrivate;
60 typedef struct _GStaticPrivate GStaticPrivate;
64 #define G_MUTEX_INIT { NULL }
70 #define G_RW_LOCK_INIT { NULL }
76 #define G_COND_INIT { NULL }
85 #ifdef PTHREAD_ADAPTIVE_MUTEX_INITIALIZER_NP
86 #define G_MUTEX_INIT { PTHREAD_ADAPTIVE_MUTEX_INITIALIZER_NP }
88 #define G_MUTEX_INIT { PTHREAD_MUTEX_INITIALIZER }
95 #define G_RW_LOCK_INIT { PTHREAD_RWLOCK_INITIALIZER }
98 pthread_rwlock_t impl;
101 #define G_COND_INIT { PTHREAD_COND_INITIALIZER }
109 #define G_REC_MUTEX_INIT { NULL }
115 void g_thread_init (gpointer vtable);
117 gboolean g_thread_get_initialized (void);
119 GLIB_VAR gboolean g_threads_got_initialized;
121 #if defined(G_THREADS_MANDATORY)
122 #define g_thread_supported() 1
124 #define g_thread_supported() (g_threads_got_initialized)
127 GMutex* g_static_mutex_get_mutex_impl (GMutex **mutex);
129 GThread *g_thread_create (GThreadFunc func,
134 GThread *g_thread_create_with_stack_size (GThreadFunc func,
140 GThread* g_thread_self (void);
141 void g_thread_exit (gpointer retval);
142 gpointer g_thread_join (GThread *thread);
143 void g_thread_yield (void);
145 void g_thread_foreach (GFunc thread_func,
148 struct _GStaticPrivate
153 #define G_STATIC_PRIVATE_INIT { 0 }
154 void g_static_private_init (GStaticPrivate *private_key);
155 gpointer g_static_private_get (GStaticPrivate *private_key);
156 void g_static_private_set (GStaticPrivate *private_key,
158 GDestroyNotify notify);
159 void g_static_private_free (GStaticPrivate *private_key);
163 G_ONCE_STATUS_NOTCALLED,
164 G_ONCE_STATUS_PROGRESS,
168 typedef struct _GOnce GOnce;
171 volatile GOnceStatus status;
172 volatile gpointer retval;
175 #define G_ONCE_INIT { G_ONCE_STATUS_NOTCALLED, NULL }
177 gpointer g_once_impl (GOnce *once, GThreadFunc func, gpointer arg);
179 #ifdef G_ATOMIC_OP_MEMORY_BARRIER_NEEDED
180 # define g_once(once, func, arg) g_once_impl ((once), (func), (arg))
181 #else /* !G_ATOMIC_OP_MEMORY_BARRIER_NEEDED*/
182 # define g_once(once, func, arg) \
183 (((once)->status == G_ONCE_STATUS_READY) ? \
185 g_once_impl ((once), (func), (arg)))
186 #endif /* G_ATOMIC_OP_MEMORY_BARRIER_NEEDED */
188 /* initialize-once guards, keyed by value_location */
189 G_INLINE_FUNC gboolean g_once_init_enter (volatile gsize *value_location);
190 gboolean g_once_init_enter_impl (volatile gsize *value_location);
191 void g_once_init_leave (volatile gsize *value_location,
192 gsize initialization_value);
193 #if defined (G_CAN_INLINE) || defined (__G_THREAD_C__)
194 G_INLINE_FUNC gboolean
195 g_once_init_enter (volatile gsize *value_location)
197 if G_LIKELY ((gpointer) g_atomic_pointer_get (value_location) != NULL)
200 return g_once_init_enter_impl (value_location);
202 #endif /* G_CAN_INLINE || __G_THREAD_C__ */
204 #define G_LOCK_NAME(name) g__ ## name ## _lock
205 #define G_LOCK_DEFINE_STATIC(name) static G_LOCK_DEFINE (name)
206 #define G_LOCK_DEFINE(name) \
207 GMutex G_LOCK_NAME (name) = G_MUTEX_INIT
208 #define G_LOCK_EXTERN(name) extern GMutex G_LOCK_NAME (name)
211 # define G_LOCK(name) G_STMT_START{ \
212 g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG, \
213 "file %s: line %d (%s): locking: %s ", \
214 __FILE__, __LINE__, G_STRFUNC, \
216 g_mutex_lock (&G_LOCK_NAME (name)); \
218 # define G_UNLOCK(name) G_STMT_START{ \
219 g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG, \
220 "file %s: line %d (%s): unlocking: %s ", \
221 __FILE__, __LINE__, G_STRFUNC, \
223 g_mutex_unlock (&G_LOCK_NAME (name)); \
225 # define G_TRYLOCK(name) \
226 (g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG, \
227 "file %s: line %d (%s): try locking: %s ", \
228 __FILE__, __LINE__, G_STRFUNC, \
229 #name), g_mutex_trylock (&G_LOCK_NAME (name)))
230 #else /* !G_DEBUG_LOCKS */
231 # define G_LOCK(name) g_mutex_lock (&G_LOCK_NAME (name))
232 # define G_UNLOCK(name) g_mutex_unlock (&G_LOCK_NAME (name))
233 # define G_TRYLOCK(name) g_mutex_trylock (&G_LOCK_NAME (name))
234 #endif /* !G_DEBUG_LOCKS */
237 GMutex * g_mutex_new (void);
238 void g_mutex_free (GMutex *mutex);
239 void g_mutex_init (GMutex *mutex);
240 void g_mutex_clear (GMutex *mutex);
242 void g_mutex_lock (GMutex *mutex);
243 void g_mutex_unlock (GMutex *mutex);
244 gboolean g_mutex_trylock (GMutex *mutex);
246 void g_rw_lock_init (GRWLock *lock);
247 void g_rw_lock_clear (GRWLock *lock);
248 void g_rw_lock_writer_lock (GRWLock *lock);
249 gboolean g_rw_lock_writer_trylock (GRWLock *lock);
250 void g_rw_lock_writer_unlock (GRWLock *lock);
251 void g_rw_lock_reader_lock (GRWLock *lock);
252 gboolean g_rw_lock_reader_trylock (GRWLock *lock);
253 void g_rw_lock_reader_unlock (GRWLock *lock);
255 void g_rec_mutex_init (GRecMutex *rec_mutex);
256 void g_rec_mutex_clear (GRecMutex *rec_mutex);
257 void g_rec_mutex_lock (GRecMutex *rec_mutex);
258 gboolean g_rec_mutex_trylock (GRecMutex *rec_mutex);
259 void g_rec_mutex_unlock (GRecMutex *rec_mutex);
261 GCond * g_cond_new (void);
262 void g_cond_free (GCond *cond);
263 void g_cond_init (GCond *cond);
264 void g_cond_clear (GCond *cond);
266 void g_cond_wait (GCond *cond,
268 void g_cond_signal (GCond *cond);
269 void g_cond_broadcast (GCond *cond);
270 gboolean g_cond_timed_wait (GCond *cond,
273 gboolean g_cond_timedwait (GCond *cond,
277 GPrivate * g_private_new (GDestroyNotify notify);
278 gpointer g_private_get (GPrivate *key);
279 void g_private_set (GPrivate *key,
284 #endif /* __G_THREAD_H__ */