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 union _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;
90 #define G_PRIVATE_INIT(notify) { NULL, (notify), { NULL, NULL } }
94 GDestroyNotify notify;
98 void g_thread_init (gpointer vtable);
100 gboolean g_thread_get_initialized (void);
102 GLIB_VAR gboolean g_threads_got_initialized;
104 #if defined(G_THREADS_MANDATORY)
105 #define g_thread_supported() 1
107 #define g_thread_supported() (g_threads_got_initialized)
110 GMutex* g_static_mutex_get_mutex_impl (GMutex **mutex);
112 GThread *g_thread_new (const gchar *name,
118 GThread *g_thread_new_full (const gchar *name,
125 GThread* g_thread_self (void);
126 void g_thread_exit (gpointer retval);
127 gpointer g_thread_join (GThread *thread);
128 void g_thread_yield (void);
132 G_ONCE_STATUS_NOTCALLED,
133 G_ONCE_STATUS_PROGRESS,
137 typedef struct _GOnce GOnce;
140 volatile GOnceStatus status;
141 volatile gpointer retval;
144 #define G_ONCE_INIT { G_ONCE_STATUS_NOTCALLED, NULL }
146 gpointer g_once_impl (GOnce *once, GThreadFunc func, gpointer arg);
148 #ifdef G_ATOMIC_OP_MEMORY_BARRIER_NEEDED
149 # define g_once(once, func, arg) g_once_impl ((once), (func), (arg))
150 #else /* !G_ATOMIC_OP_MEMORY_BARRIER_NEEDED*/
151 # define g_once(once, func, arg) \
152 (((once)->status == G_ONCE_STATUS_READY) ? \
154 g_once_impl ((once), (func), (arg)))
155 #endif /* G_ATOMIC_OP_MEMORY_BARRIER_NEEDED */
157 /* initialize-once guards, keyed by value_location */
158 G_INLINE_FUNC gboolean g_once_init_enter (volatile gsize *value_location);
159 gboolean g_once_init_enter_impl (volatile gsize *value_location);
160 void g_once_init_leave (volatile gsize *value_location,
161 gsize initialization_value);
162 #if defined (G_CAN_INLINE) || defined (__G_THREAD_C__)
163 G_INLINE_FUNC gboolean
164 g_once_init_enter (volatile gsize *value_location)
166 if G_LIKELY ((gpointer) g_atomic_pointer_get (value_location) != NULL)
169 return g_once_init_enter_impl (value_location);
171 #endif /* G_CAN_INLINE || __G_THREAD_C__ */
173 #define G_LOCK_NAME(name) g__ ## name ## _lock
174 #define G_LOCK_DEFINE_STATIC(name) static G_LOCK_DEFINE (name)
175 #define G_LOCK_DEFINE(name) GMutex G_LOCK_NAME (name)
176 #define G_LOCK_EXTERN(name) extern GMutex G_LOCK_NAME (name)
179 # define G_LOCK(name) G_STMT_START{ \
180 g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG, \
181 "file %s: line %d (%s): locking: %s ", \
182 __FILE__, __LINE__, G_STRFUNC, \
184 g_mutex_lock (&G_LOCK_NAME (name)); \
186 # define G_UNLOCK(name) G_STMT_START{ \
187 g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG, \
188 "file %s: line %d (%s): unlocking: %s ", \
189 __FILE__, __LINE__, G_STRFUNC, \
191 g_mutex_unlock (&G_LOCK_NAME (name)); \
193 # define G_TRYLOCK(name) \
194 (g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG, \
195 "file %s: line %d (%s): try locking: %s ", \
196 __FILE__, __LINE__, G_STRFUNC, \
197 #name), g_mutex_trylock (&G_LOCK_NAME (name)))
198 #else /* !G_DEBUG_LOCKS */
199 # define G_LOCK(name) g_mutex_lock (&G_LOCK_NAME (name))
200 # define G_UNLOCK(name) g_mutex_unlock (&G_LOCK_NAME (name))
201 # define G_TRYLOCK(name) g_mutex_trylock (&G_LOCK_NAME (name))
202 #endif /* !G_DEBUG_LOCKS */
205 GMutex * g_mutex_new (void);
206 void g_mutex_free (GMutex *mutex);
207 void g_mutex_init (GMutex *mutex);
208 void g_mutex_clear (GMutex *mutex);
210 void g_mutex_lock (GMutex *mutex);
211 void g_mutex_unlock (GMutex *mutex);
212 gboolean g_mutex_trylock (GMutex *mutex);
214 void g_rw_lock_init (GRWLock *rw_lock);
215 void g_rw_lock_clear (GRWLock *rw_lock);
216 void g_rw_lock_writer_lock (GRWLock *rw_lock);
217 gboolean g_rw_lock_writer_trylock (GRWLock *rw_lock);
218 void g_rw_lock_writer_unlock (GRWLock *rw_lock);
219 void g_rw_lock_reader_lock (GRWLock *rw_lock);
220 gboolean g_rw_lock_reader_trylock (GRWLock *rw_lock);
221 void g_rw_lock_reader_unlock (GRWLock *rw_lock);
223 void g_rec_mutex_init (GRecMutex *rec_mutex);
224 void g_rec_mutex_clear (GRecMutex *rec_mutex);
225 void g_rec_mutex_lock (GRecMutex *rec_mutex);
226 gboolean g_rec_mutex_trylock (GRecMutex *rec_mutex);
227 void g_rec_mutex_unlock (GRecMutex *rec_mutex);
229 GCond * g_cond_new (void);
230 void g_cond_free (GCond *cond);
231 void g_cond_init (GCond *cond);
232 void g_cond_clear (GCond *cond);
234 void g_cond_wait (GCond *cond,
236 void g_cond_signal (GCond *cond);
237 void g_cond_broadcast (GCond *cond);
238 gboolean g_cond_timed_wait (GCond *cond,
241 gboolean g_cond_timedwait (GCond *cond,
245 gpointer g_private_get (GPrivate *key);
246 void g_private_set (GPrivate *key,
248 void g_private_replace (GPrivate *key,
253 #endif /* __G_THREAD_H__ */