summaryrefslogtreecommitdiff
path: root/glib/gthread.h
blob: 67106e541ccbec55e6e17b910c4bb22d6ba13b60 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
/* GLIB - Library of useful routines for C programming
 * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

/*
 * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
 * file for a list of people on the GLib Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
 * GLib at ftp://ftp.gtk.org/pub/gtk/.
 */

#if defined(G_DISABLE_SINGLE_INCLUDES) && !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
#error "Only <glib.h> can be included directly."
#endif

#ifndef __G_THREAD_H__
#define __G_THREAD_H__

#include <glib/gerror.h>
#include <glib/gutils.h>        /* for G_INLINE_FUNC */
#include <glib/gatomic.h>       /* for g_atomic_pointer_get */

G_BEGIN_DECLS

/* GLib Thread support
 */

extern GQuark g_thread_error_quark (void);
#define G_THREAD_ERROR g_thread_error_quark ()

typedef enum
{
  G_THREAD_ERROR_AGAIN /* Resource temporarily unavailable */
} GThreadError;

typedef gpointer (*GThreadFunc) (gpointer data);

typedef struct _GThread         GThread;

typedef struct _GMutex          GMutex;
typedef struct _GRecMutex       GRecMutex;
typedef struct _GRWLock         GRWLock;
typedef struct _GCond           GCond;
typedef struct _GPrivate        GPrivate;
typedef struct _GStaticPrivate  GStaticPrivate;

#ifdef G_OS_WIN32

#define G_MUTEX_INIT { NULL }
struct _GMutex
{
  gpointer impl;
};

#define G_RW_LOCK_INIT { NULL }
struct _GRWLock
{
  gpointer impl;
};

#define G_COND_INIT { NULL }
struct _GCond
{
  gpointer impl;
};
#else

#include <pthread.h>

#ifdef PTHREAD_ADAPTIVE_MUTEX_INITIALIZER_NP
#define G_MUTEX_INIT { PTHREAD_ADAPTIVE_MUTEX_INITIALIZER_NP }
#else
#define G_MUTEX_INIT { PTHREAD_MUTEX_INITIALIZER }
#endif
struct _GMutex
{
  pthread_mutex_t impl;
};

#define G_RW_LOCK_INIT { PTHREAD_RWLOCK_INITIALIZER }
struct _GRWLock
{
  pthread_rwlock_t impl;
};

#define G_COND_INIT { PTHREAD_COND_INITIALIZER }
struct _GCond
{
  pthread_cond_t impl;
};

#endif

#define G_REC_MUTEX_INIT { NULL }
struct _GRecMutex
{
  gpointer impl;
};

#define G_PRIVATE_INIT(notify) { NULL, (notify), { NULL, NULL } }
struct _GPrivate
{
  gpointer       p;
  GDestroyNotify notify;
  gpointer future[2];
};

void     g_thread_init   (gpointer vtable);

gboolean g_thread_get_initialized (void);

GLIB_VAR gboolean g_threads_got_initialized;

#if defined(G_THREADS_MANDATORY)
#define g_thread_supported()     1
#else
#define g_thread_supported()    (g_threads_got_initialized)
#endif

GMutex* g_static_mutex_get_mutex_impl   (GMutex **mutex);

GThread *g_thread_create                 (GThreadFunc   func,
                                          gpointer      data,
                                          gboolean      joinable,
                                          GError      **error);

GThread *g_thread_create_with_stack_size (GThreadFunc   func,
                                          gpointer      data,
                                          gboolean      joinable,
                                          gsize         stack_size,
                                          GError      **error);

GThread* g_thread_self                   (void);
void     g_thread_exit                   (gpointer      retval);
gpointer g_thread_join                   (GThread      *thread);
void     g_thread_yield                  (void);

void     g_thread_foreach                (GFunc         thread_func,
                                          gpointer      user_data);

struct _GStaticPrivate
{
  /*< private >*/
  guint index;
};
#define G_STATIC_PRIVATE_INIT { 0 }
void     g_static_private_init           (GStaticPrivate   *private_key);
gpointer g_static_private_get            (GStaticPrivate   *private_key);
void     g_static_private_set            (GStaticPrivate   *private_key,
					  gpointer          data,
					  GDestroyNotify    notify);
void     g_static_private_free           (GStaticPrivate   *private_key);

typedef enum
{
  G_ONCE_STATUS_NOTCALLED,
  G_ONCE_STATUS_PROGRESS,
  G_ONCE_STATUS_READY
} GOnceStatus;

typedef struct _GOnce GOnce;
struct _GOnce
{
  volatile GOnceStatus status;
  volatile gpointer retval;
};

#define G_ONCE_INIT { G_ONCE_STATUS_NOTCALLED, NULL }

gpointer g_once_impl (GOnce *once, GThreadFunc func, gpointer arg);

#ifdef G_ATOMIC_OP_MEMORY_BARRIER_NEEDED
# define g_once(once, func, arg) g_once_impl ((once), (func), (arg))
#else /* !G_ATOMIC_OP_MEMORY_BARRIER_NEEDED*/
# define g_once(once, func, arg) \
  (((once)->status == G_ONCE_STATUS_READY) ? \
   (once)->retval : \
   g_once_impl ((once), (func), (arg)))
#endif /* G_ATOMIC_OP_MEMORY_BARRIER_NEEDED */

/* initialize-once guards, keyed by value_location */
G_INLINE_FUNC gboolean  g_once_init_enter       (volatile gsize *value_location);
gboolean                g_once_init_enter_impl  (volatile gsize *value_location);
void                    g_once_init_leave       (volatile gsize *value_location,
                                                 gsize           initialization_value);
#if defined (G_CAN_INLINE) || defined (__G_THREAD_C__)
G_INLINE_FUNC gboolean
g_once_init_enter (volatile gsize *value_location)
{
  if G_LIKELY ((gpointer) g_atomic_pointer_get (value_location) != NULL)
    return FALSE;
  else
    return g_once_init_enter_impl (value_location);
}
#endif /* G_CAN_INLINE || __G_THREAD_C__ */

#define G_LOCK_NAME(name)               g__ ## name ## _lock
#define G_LOCK_DEFINE_STATIC(name)    static G_LOCK_DEFINE (name)
#define G_LOCK_DEFINE(name)           \
  GMutex G_LOCK_NAME (name) = G_MUTEX_INIT
#define G_LOCK_EXTERN(name)           extern GMutex G_LOCK_NAME (name)

#ifdef G_DEBUG_LOCKS
#  define G_LOCK(name)                G_STMT_START{             \
      g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG,                   \
             "file %s: line %d (%s): locking: %s ",             \
             __FILE__,        __LINE__, G_STRFUNC,              \
             #name);                                            \
      g_mutex_lock (&G_LOCK_NAME (name));                       \
   }G_STMT_END
#  define G_UNLOCK(name)              G_STMT_START{             \
      g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG,                   \
             "file %s: line %d (%s): unlocking: %s ",           \
             __FILE__,        __LINE__, G_STRFUNC,              \
             #name);                                            \
     g_mutex_unlock (&G_LOCK_NAME (name));                      \
   }G_STMT_END
#  define G_TRYLOCK(name)                                       \
      (g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG,                  \
             "file %s: line %d (%s): try locking: %s ",         \
             __FILE__,        __LINE__, G_STRFUNC,              \
             #name), g_mutex_trylock (&G_LOCK_NAME (name)))
#else  /* !G_DEBUG_LOCKS */
#  define G_LOCK(name) g_mutex_lock       (&G_LOCK_NAME (name))
#  define G_UNLOCK(name) g_mutex_unlock   (&G_LOCK_NAME (name))
#  define G_TRYLOCK(name) g_mutex_trylock (&G_LOCK_NAME (name))
#endif /* !G_DEBUG_LOCKS */


GMutex *                g_mutex_new                                     (void);
void                    g_mutex_free                                    (GMutex         *mutex);
void                    g_mutex_init                                    (GMutex         *mutex);
void                    g_mutex_clear                                   (GMutex         *mutex);

void                    g_mutex_lock                                    (GMutex         *mutex);
void                    g_mutex_unlock                                  (GMutex         *mutex);
gboolean                g_mutex_trylock                                 (GMutex         *mutex);

void                    g_rw_lock_init                                  (GRWLock        *lock);
void                    g_rw_lock_clear                                 (GRWLock        *lock);
void                    g_rw_lock_writer_lock                           (GRWLock        *lock);
gboolean                g_rw_lock_writer_trylock                        (GRWLock        *lock);
void                    g_rw_lock_writer_unlock                         (GRWLock        *lock);
void                    g_rw_lock_reader_lock                           (GRWLock        *lock);
gboolean                g_rw_lock_reader_trylock                        (GRWLock        *lock);
void                    g_rw_lock_reader_unlock                         (GRWLock        *lock);

void                    g_rec_mutex_init                                (GRecMutex      *rec_mutex);
void                    g_rec_mutex_clear                               (GRecMutex      *rec_mutex);
void                    g_rec_mutex_lock                                (GRecMutex      *rec_mutex);
gboolean                g_rec_mutex_trylock                             (GRecMutex      *rec_mutex);
void                    g_rec_mutex_unlock                              (GRecMutex      *rec_mutex);

GCond *                 g_cond_new                                      (void);
void                    g_cond_free                                     (GCond          *cond);
void                    g_cond_init                                     (GCond          *cond);
void                    g_cond_clear                                    (GCond          *cond);

void                    g_cond_wait                                     (GCond          *cond,
                                                                         GMutex         *mutex);
void                    g_cond_signal                                   (GCond          *cond);
void                    g_cond_broadcast                                (GCond          *cond);
gboolean                g_cond_timed_wait                               (GCond          *cond,
                                                                         GMutex         *mutex,
                                                                         GTimeVal       *timeval);
gboolean                g_cond_timedwait                                (GCond          *cond,
                                                                         GMutex         *mutex,
                                                                         gint64          abs_time);

gpointer                g_private_get                                   (GPrivate       *key);
void                    g_private_set                                   (GPrivate       *key,
                                                                         gpointer        value);
void                    g_private_replace                               (GPrivate       *key,
                                                                         gpointer        value);

G_END_DECLS

#endif /* __G_THREAD_H__ */