Stop dithering over GPrivate
[platform/upstream/glib.git] / glib / gthread.h
1 /* GLIB - Library of useful routines for C programming
2  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
3  *
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.
8  *
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.
13  *
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.
18  */
19
20 /*
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/.
25  */
26
27 #if defined(G_DISABLE_SINGLE_INCLUDES) && !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
28 #error "Only <glib.h> can be included directly."
29 #endif
30
31 #ifndef __G_THREAD_H__
32 #define __G_THREAD_H__
33
34 #include <glib/gerror.h>
35 #include <glib/gutils.h>        /* for G_INLINE_FUNC */
36 #include <glib/gatomic.h>       /* for g_atomic_pointer_get */
37
38 G_BEGIN_DECLS
39
40 /* GLib Thread support
41  */
42
43 extern GQuark g_thread_error_quark (void);
44 #define G_THREAD_ERROR g_thread_error_quark ()
45
46 typedef enum
47 {
48   G_THREAD_ERROR_AGAIN /* Resource temporarily unavailable */
49 } GThreadError;
50
51 typedef gpointer (*GThreadFunc) (gpointer data);
52
53 typedef struct _GThread         GThread;
54
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;
61
62 #ifdef G_OS_WIN32
63
64 #define G_MUTEX_INIT { NULL }
65 struct _GMutex
66 {
67   gpointer impl;
68 };
69
70 #define G_RW_LOCK_INIT { NULL }
71 struct _GRWLock
72 {
73   gpointer impl;
74 };
75
76 #define G_COND_INIT { NULL }
77 struct _GCond
78 {
79   gpointer impl;
80 };
81 #else
82
83 #include <pthread.h>
84
85 #ifdef PTHREAD_ADAPTIVE_MUTEX_INITIALIZER_NP
86 #define G_MUTEX_INIT { PTHREAD_ADAPTIVE_MUTEX_INITIALIZER_NP }
87 #else
88 #define G_MUTEX_INIT { PTHREAD_MUTEX_INITIALIZER }
89 #endif
90 struct _GMutex
91 {
92   pthread_mutex_t impl;
93 };
94
95 #define G_RW_LOCK_INIT { PTHREAD_RWLOCK_INITIALIZER }
96 struct _GRWLock
97 {
98   pthread_rwlock_t impl;
99 };
100
101 #define G_COND_INIT { PTHREAD_COND_INITIALIZER }
102 struct _GCond
103 {
104   pthread_cond_t impl;
105 };
106
107 #endif
108
109 #define G_REC_MUTEX_INIT { NULL }
110 struct _GRecMutex
111 {
112   gpointer impl;
113 };
114
115 #define G_PRIVATE_INIT(notify) { NULL, (notify), { NULL, NULL } }
116 struct _GPrivate
117 {
118   gpointer       p;
119   GDestroyNotify notify;
120   gpointer future[2];
121 };
122
123 void     g_thread_init   (gpointer vtable);
124
125 gboolean g_thread_get_initialized (void);
126
127 GLIB_VAR gboolean g_threads_got_initialized;
128
129 #if defined(G_THREADS_MANDATORY)
130 #define g_thread_supported()     1
131 #else
132 #define g_thread_supported()    (g_threads_got_initialized)
133 #endif
134
135 GMutex* g_static_mutex_get_mutex_impl   (GMutex **mutex);
136
137 GThread *g_thread_create                 (GThreadFunc   func,
138                                           gpointer      data,
139                                           gboolean      joinable,
140                                           GError      **error);
141
142 GThread *g_thread_create_with_stack_size (GThreadFunc   func,
143                                           gpointer      data,
144                                           gboolean      joinable,
145                                           gsize         stack_size,
146                                           GError      **error);
147
148 GThread* g_thread_self                   (void);
149 void     g_thread_exit                   (gpointer      retval);
150 gpointer g_thread_join                   (GThread      *thread);
151 void     g_thread_yield                  (void);
152
153 void     g_thread_foreach                (GFunc         thread_func,
154                                           gpointer      user_data);
155
156 struct _GStaticPrivate
157 {
158   /*< private >*/
159   guint index;
160 };
161 #define G_STATIC_PRIVATE_INIT { 0 }
162 void     g_static_private_init           (GStaticPrivate   *private_key);
163 gpointer g_static_private_get            (GStaticPrivate   *private_key);
164 void     g_static_private_set            (GStaticPrivate   *private_key,
165                                           gpointer          data,
166                                           GDestroyNotify    notify);
167 void     g_static_private_free           (GStaticPrivate   *private_key);
168
169 typedef enum
170 {
171   G_ONCE_STATUS_NOTCALLED,
172   G_ONCE_STATUS_PROGRESS,
173   G_ONCE_STATUS_READY
174 } GOnceStatus;
175
176 typedef struct _GOnce GOnce;
177 struct _GOnce
178 {
179   volatile GOnceStatus status;
180   volatile gpointer retval;
181 };
182
183 #define G_ONCE_INIT { G_ONCE_STATUS_NOTCALLED, NULL }
184
185 gpointer g_once_impl (GOnce *once, GThreadFunc func, gpointer arg);
186
187 #ifdef G_ATOMIC_OP_MEMORY_BARRIER_NEEDED
188 # define g_once(once, func, arg) g_once_impl ((once), (func), (arg))
189 #else /* !G_ATOMIC_OP_MEMORY_BARRIER_NEEDED*/
190 # define g_once(once, func, arg) \
191   (((once)->status == G_ONCE_STATUS_READY) ? \
192    (once)->retval : \
193    g_once_impl ((once), (func), (arg)))
194 #endif /* G_ATOMIC_OP_MEMORY_BARRIER_NEEDED */
195
196 /* initialize-once guards, keyed by value_location */
197 G_INLINE_FUNC gboolean  g_once_init_enter       (volatile gsize *value_location);
198 gboolean                g_once_init_enter_impl  (volatile gsize *value_location);
199 void                    g_once_init_leave       (volatile gsize *value_location,
200                                                  gsize           initialization_value);
201 #if defined (G_CAN_INLINE) || defined (__G_THREAD_C__)
202 G_INLINE_FUNC gboolean
203 g_once_init_enter (volatile gsize *value_location)
204 {
205   if G_LIKELY ((gpointer) g_atomic_pointer_get (value_location) != NULL)
206     return FALSE;
207   else
208     return g_once_init_enter_impl (value_location);
209 }
210 #endif /* G_CAN_INLINE || __G_THREAD_C__ */
211
212 #define G_LOCK_NAME(name)               g__ ## name ## _lock
213 #define G_LOCK_DEFINE_STATIC(name)    static G_LOCK_DEFINE (name)
214 #define G_LOCK_DEFINE(name)           \
215   GMutex G_LOCK_NAME (name) = G_MUTEX_INIT
216 #define G_LOCK_EXTERN(name)           extern GMutex G_LOCK_NAME (name)
217
218 #ifdef G_DEBUG_LOCKS
219 #  define G_LOCK(name)                G_STMT_START{             \
220       g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG,                   \
221              "file %s: line %d (%s): locking: %s ",             \
222              __FILE__,        __LINE__, G_STRFUNC,              \
223              #name);                                            \
224       g_mutex_lock (&G_LOCK_NAME (name));                       \
225    }G_STMT_END
226 #  define G_UNLOCK(name)              G_STMT_START{             \
227       g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG,                   \
228              "file %s: line %d (%s): unlocking: %s ",           \
229              __FILE__,        __LINE__, G_STRFUNC,              \
230              #name);                                            \
231      g_mutex_unlock (&G_LOCK_NAME (name));                      \
232    }G_STMT_END
233 #  define G_TRYLOCK(name)                                       \
234       (g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG,                  \
235              "file %s: line %d (%s): try locking: %s ",         \
236              __FILE__,        __LINE__, G_STRFUNC,              \
237              #name), g_mutex_trylock (&G_LOCK_NAME (name)))
238 #else  /* !G_DEBUG_LOCKS */
239 #  define G_LOCK(name) g_mutex_lock       (&G_LOCK_NAME (name))
240 #  define G_UNLOCK(name) g_mutex_unlock   (&G_LOCK_NAME (name))
241 #  define G_TRYLOCK(name) g_mutex_trylock (&G_LOCK_NAME (name))
242 #endif /* !G_DEBUG_LOCKS */
243
244
245 GMutex *                g_mutex_new                                     (void);
246 void                    g_mutex_free                                    (GMutex         *mutex);
247 void                    g_mutex_init                                    (GMutex         *mutex);
248 void                    g_mutex_clear                                   (GMutex         *mutex);
249
250 void                    g_mutex_lock                                    (GMutex         *mutex);
251 void                    g_mutex_unlock                                  (GMutex         *mutex);
252 gboolean                g_mutex_trylock                                 (GMutex         *mutex);
253
254 void                    g_rw_lock_init                                  (GRWLock        *lock);
255 void                    g_rw_lock_clear                                 (GRWLock        *lock);
256 void                    g_rw_lock_writer_lock                           (GRWLock        *lock);
257 gboolean                g_rw_lock_writer_trylock                        (GRWLock        *lock);
258 void                    g_rw_lock_writer_unlock                         (GRWLock        *lock);
259 void                    g_rw_lock_reader_lock                           (GRWLock        *lock);
260 gboolean                g_rw_lock_reader_trylock                        (GRWLock        *lock);
261 void                    g_rw_lock_reader_unlock                         (GRWLock        *lock);
262
263 void                    g_rec_mutex_init                                (GRecMutex      *rec_mutex);
264 void                    g_rec_mutex_clear                               (GRecMutex      *rec_mutex);
265 void                    g_rec_mutex_lock                                (GRecMutex      *rec_mutex);
266 gboolean                g_rec_mutex_trylock                             (GRecMutex      *rec_mutex);
267 void                    g_rec_mutex_unlock                              (GRecMutex      *rec_mutex);
268
269 GCond *                 g_cond_new                                      (void);
270 void                    g_cond_free                                     (GCond          *cond);
271 void                    g_cond_init                                     (GCond          *cond);
272 void                    g_cond_clear                                    (GCond          *cond);
273
274 void                    g_cond_wait                                     (GCond          *cond,
275                                                                          GMutex         *mutex);
276 void                    g_cond_signal                                   (GCond          *cond);
277 void                    g_cond_broadcast                                (GCond          *cond);
278 gboolean                g_cond_timed_wait                               (GCond          *cond,
279                                                                          GMutex         *mutex,
280                                                                          GTimeVal       *timeval);
281 gboolean                g_cond_timedwait                                (GCond          *cond,
282                                                                          GMutex         *mutex,
283                                                                          gint64          abs_time);
284
285 gpointer                g_private_get                                   (GPrivate       *key);
286 void                    g_private_set                                   (GPrivate       *key,
287                                                                          gpointer        value);
288 void                    g_private_replace                               (GPrivate       *key,
289                                                                          gpointer        value);
290
291 G_END_DECLS
292
293 #endif /* __G_THREAD_H__ */