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 #define G_MUTEX_INIT { PTHREAD_MUTEX_INITIALIZER }
  86 struct _GMutex
  87 {
  88   pthread_mutex_t impl;
  89 };
  90
  91 #define G_RW_LOCK_INIT { PTHREAD_RWLOCK_INITIALIZER }
  92 struct _GRWLock
  93 {
  94   pthread_rwlock_t impl;
  95 };
  96
  97 #define G_COND_INIT { PTHREAD_COND_INITIALIZER }
  98 struct _GCond
  99 {
 100   pthread_cond_t impl;
 101 };
 102
 103 #endif
 104
 105 #define G_REC_MUTEX_INIT { NULL }
 106 struct _GRecMutex
 107 {
 108   gpointer impl;
 109 };
 110
 111 /* initializes the mutex/cond/private implementation for glib, might
 112  * only be called once, and must not be called directly or indirectly
 113  * from another glib-function, e.g. as a callback.
 114  */
 115 void    g_thread_init   (gpointer vtable);
 116
 117 /* Checks if thread support is initialized.  Identical to the
 118  * g_thread_supported macro but provided for language bindings.
 119  */
 120 gboolean g_thread_get_initialized (void);
 121
 122 GLIB_VAR gboolean               g_threads_got_initialized;
 123
 124 /* internal function for fallback static mutex implementation */
 125 GMutex* g_static_mutex_get_mutex_impl   (GMutex **mutex);
 126
 127 #if defined(G_THREADS_MANDATORY)
 128 #define g_thread_supported()     1
 129 #else
 130 #define g_thread_supported()    (g_threads_got_initialized)
 131 #endif
 132
 133 GThread *g_thread_create                 (GThreadFunc   func,
 134                                           gpointer      data,
 135                                           gboolean      joinable,
 136                                           GError      **error);
 137
 138 GThread *g_thread_create_with_stack_size (GThreadFunc   func,
 139                                           gpointer      data,
 140                                           gboolean      joinable,
 141                                           gsize         stack_size,
 142                                           GError      **error);
 143
 144 GThread* g_thread_self                   (void);
 145 void     g_thread_exit                   (gpointer      retval);
 146 gpointer g_thread_join                   (GThread      *thread);
 147 void     g_thread_yield                  (void);
 148
 149 void     g_thread_foreach                (GFunc         thread_func,
 150                                           gpointer      user_data);
 151
 152 struct _GStaticPrivate
 153 {
 154   /*< private >*/
 155   guint index;
 156 };
 157 #define G_STATIC_PRIVATE_INIT { 0 }
 158 void     g_static_private_init           (GStaticPrivate   *private_key);
 159 gpointer g_static_private_get            (GStaticPrivate   *private_key);
 160 void     g_static_private_set            (GStaticPrivate   *private_key,
 161                                           gpointer          data,
 162                                           GDestroyNotify    notify);
 163 void     g_static_private_free           (GStaticPrivate   *private_key);
 164
 165 typedef enum
 166 {
 167   G_ONCE_STATUS_NOTCALLED,
 168   G_ONCE_STATUS_PROGRESS,
 169   G_ONCE_STATUS_READY
 170 } GOnceStatus;
 171
 172 typedef struct _GOnce GOnce;
 173 struct _GOnce
 174 {
 175   volatile GOnceStatus status;
 176   volatile gpointer retval;
 177 };
 178
 179 #define G_ONCE_INIT { G_ONCE_STATUS_NOTCALLED, NULL }
 180
 181 gpointer g_once_impl (GOnce *once, GThreadFunc func, gpointer arg);
 182
 183 #ifdef G_ATOMIC_OP_MEMORY_BARRIER_NEEDED
 184 # define g_once(once, func, arg) g_once_impl ((once), (func), (arg))
 185 #else /* !G_ATOMIC_OP_MEMORY_BARRIER_NEEDED*/
 186 # define g_once(once, func, arg) \
 187   (((once)->status == G_ONCE_STATUS_READY) ? \
 188    (once)->retval : \
 189    g_once_impl ((once), (func), (arg)))
 190 #endif /* G_ATOMIC_OP_MEMORY_BARRIER_NEEDED */
 191
 192 /* initialize-once guards, keyed by value_location */
 193 G_INLINE_FUNC gboolean  g_once_init_enter       (volatile gsize *value_location);
 194 gboolean                g_once_init_enter_impl  (volatile gsize *value_location);
 195 void                    g_once_init_leave       (volatile gsize *value_location,
 196                                                  gsize           initialization_value);
 197 #if defined (G_CAN_INLINE) || defined (__G_THREAD_C__)
 198 G_INLINE_FUNC gboolean
 199 g_once_init_enter (volatile gsize *value_location)
 200 {
 201   if G_LIKELY ((gpointer) g_atomic_pointer_get (value_location) != NULL)
 202     return FALSE;
 203   else
 204     return g_once_init_enter_impl (value_location);
 205 }
 206 #endif /* G_CAN_INLINE || __G_THREAD_C__ */
 207
 208 #define G_LOCK_NAME(name)               g__ ## name ## _lock
 209 #define G_LOCK_DEFINE_STATIC(name)    static G_LOCK_DEFINE (name)
 210 #define G_LOCK_DEFINE(name)           \
 211   GMutex G_LOCK_NAME (name) = G_MUTEX_INIT
 212 #define G_LOCK_EXTERN(name)           extern GMutex G_LOCK_NAME (name)
 213
 214 #ifdef G_DEBUG_LOCKS
 215 #  define G_LOCK(name)                G_STMT_START{             \
 216       g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG,                   \
 217              "file %s: line %d (%s): locking: %s ",             \
 218              __FILE__,        __LINE__, G_STRFUNC,              \
 219              #name);                                            \
 220       g_mutex_lock (&G_LOCK_NAME (name));                       \
 221    }G_STMT_END
 222 #  define G_UNLOCK(name)              G_STMT_START{             \
 223       g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG,                   \
 224              "file %s: line %d (%s): unlocking: %s ",           \
 225              __FILE__,        __LINE__, G_STRFUNC,              \
 226              #name);                                            \
 227      g_mutex_unlock (&G_LOCK_NAME (name));                      \
 228    }G_STMT_END
 229 #  define G_TRYLOCK(name)                                       \
 230       (g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG,                  \
 231              "file %s: line %d (%s): try locking: %s ",         \
 232              __FILE__,        __LINE__, G_STRFUNC,              \
 233              #name), g_mutex_trylock (&G_LOCK_NAME (name)))
 234 #else  /* !G_DEBUG_LOCKS */
 235 #  define G_LOCK(name) g_mutex_lock       (&G_LOCK_NAME (name))
 236 #  define G_UNLOCK(name) g_mutex_unlock   (&G_LOCK_NAME (name))
 237 #  define G_TRYLOCK(name) g_mutex_trylock (&G_LOCK_NAME (name))
 238 #endif /* !G_DEBUG_LOCKS */
 239
 240
 241 GMutex *                g_mutex_new                                     (void);
 242 void                    g_mutex_free                                    (GMutex         *mutex);
 243 void                    g_mutex_init                                    (GMutex         *mutex);
 244 void                    g_mutex_clear                                   (GMutex         *mutex);
 245
 246 void                    g_mutex_lock                                    (GMutex         *mutex);
 247 void                    g_mutex_unlock                                  (GMutex         *mutex);
 248 gboolean                g_mutex_trylock                                 (GMutex         *mutex);
 249
 250 void                    g_rw_lock_init                                  (GRWLock        *lock);
 251 void                    g_rw_lock_clear                                 (GRWLock        *lock);
 252 void                    g_rw_lock_writer_lock                           (GRWLock        *lock);
 253 gboolean                g_rw_lock_writer_trylock                        (GRWLock        *lock);
 254 void                    g_rw_lock_writer_unlock                         (GRWLock        *lock);
 255 void                    g_rw_lock_reader_lock                           (GRWLock        *lock);
 256 gboolean                g_rw_lock_reader_trylock                        (GRWLock        *lock);
 257 void                    g_rw_lock_reader_unlock                         (GRWLock        *lock);
 258
 259 void                    g_rec_mutex_init                                (GRecMutex      *rec_mutex);
 260 void                    g_rec_mutex_clear                               (GRecMutex      *rec_mutex);
 261 void                    g_rec_mutex_lock                                (GRecMutex      *rec_mutex);
 262 gboolean                g_rec_mutex_trylock                             (GRecMutex      *rec_mutex);
 263 void                    g_rec_mutex_unlock                              (GRecMutex      *rec_mutex);
 264
 265 GCond *                 g_cond_new                                      (void);
 266 void                    g_cond_free                                     (GCond          *cond);
 267 void                    g_cond_init                                     (GCond          *cond);
 268 void                    g_cond_clear                                    (GCond          *cond);
 269
 270 void                    g_cond_wait                                     (GCond          *cond,
 271                                                                          GMutex         *mutex);
 272 void                    g_cond_signal                                   (GCond          *cond);
 273 void                    g_cond_broadcast                                (GCond          *cond);
 274 gboolean                g_cond_timed_wait                               (GCond          *cond,
 275                                                                          GMutex         *mutex,
 276                                                                          GTimeVal       *timeval);
 277 gboolean                g_cond_timedwait                                (GCond          *cond,
 278                                                                          GMutex         *mutex,
 279                                                                          gint64          abs_time);
 280
 281 GPrivate *              g_private_new                                   (GDestroyNotify  notify);
 282 gpointer                g_private_get                                   (GPrivate       *key);
 283 void                    g_private_set                                   (GPrivate       *key,
 284                                                                          gpointer        value);
 285
 286 G_END_DECLS
 287
 288 #endif /* __G_THREAD_H__ */