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 #ifndef __G_THREAD_H__
  28 #define __G_THREAD_H__
  29
  30 #include <glib/gerror.h>
  31 #include <glib/gtypes.h>
  32 #include <glib/gutils.h>        /* for G_INLINE_FUNC */
  33 #include <glib/gatomic.h>       /* for g_atomic_pointer_get */
  34
  35 G_BEGIN_DECLS
  36
  37 /* GLib Thread support
  38  */
  39
  40 extern GQuark g_thread_error_quark (void);
  41 #define G_THREAD_ERROR g_thread_error_quark ()
  42
  43 typedef enum
  44 {
  45   G_THREAD_ERROR_AGAIN /* Resource temporarily unavailable */
  46 } GThreadError;
  47
  48 typedef gpointer (*GThreadFunc) (gpointer data);
  49
  50 typedef enum
  51 {
  52   G_THREAD_PRIORITY_LOW,
  53   G_THREAD_PRIORITY_NORMAL,
  54   G_THREAD_PRIORITY_HIGH,
  55   G_THREAD_PRIORITY_URGENT
  56 } GThreadPriority;
  57
  58 typedef struct _GThread         GThread;
  59 struct  _GThread
  60 {
  61   /*< private >*/
  62   GThreadFunc func;
  63   gpointer data;
  64   gboolean joinable;
  65   GThreadPriority priority;
  66 };
  67
  68 typedef struct _GMutex          GMutex;
  69 typedef struct _GCond           GCond;
  70 typedef struct _GPrivate        GPrivate;
  71 typedef struct _GStaticPrivate  GStaticPrivate;
  72
  73 typedef struct _GThreadFunctions GThreadFunctions;
  74 struct _GThreadFunctions
  75 {
  76   GMutex*  (*mutex_new)           (void);
  77   void     (*mutex_lock)          (GMutex               *mutex);
  78   gboolean (*mutex_trylock)       (GMutex               *mutex);
  79   void     (*mutex_unlock)        (GMutex               *mutex);
  80   void     (*mutex_free)          (GMutex               *mutex);
  81   GCond*   (*cond_new)            (void);
  82   void     (*cond_signal)         (GCond                *cond);
  83   void     (*cond_broadcast)      (GCond                *cond);
  84   void     (*cond_wait)           (GCond                *cond,
  85                                    GMutex               *mutex);
  86   gboolean (*cond_timed_wait)     (GCond                *cond,
  87                                    GMutex               *mutex,
  88                                    GTimeVal             *end_time);
  89   void      (*cond_free)          (GCond                *cond);
  90   GPrivate* (*private_new)        (GDestroyNotify        destructor);
  91   gpointer  (*private_get)        (GPrivate             *private_key);
  92   void      (*private_set)        (GPrivate             *private_key,
  93                                    gpointer              data);
  94   void      (*thread_create)      (GThreadFunc           func,
  95                                    gpointer              data,
  96                                    gulong                stack_size,
  97                                    gboolean              joinable,
  98                                    gboolean              bound,
  99                                    GThreadPriority       priority,
 100                                    gpointer              thread,
 101                                    GError              **error);
 102   void      (*thread_yield)       (void);
 103   void      (*thread_join)        (gpointer              thread);
 104   void      (*thread_exit)        (void);
 105   void      (*thread_set_priority)(gpointer              thread,
 106                                    GThreadPriority       priority);
 107   void      (*thread_self)        (gpointer              thread);
 108   gboolean  (*thread_equal)       (gpointer              thread1,
 109                                    gpointer              thread2);
 110 };
 111
 112 GLIB_VAR GThreadFunctions       g_thread_functions_for_glib_use;
 113 GLIB_VAR gboolean               g_thread_use_default_impl;
 114 GLIB_VAR gboolean               g_threads_got_initialized;
 115
 116 GLIB_VAR guint64   (*g_thread_gettime) (void);
 117
 118 /* initializes the mutex/cond/private implementation for glib, might
 119  * only be called once, and must not be called directly or indirectly
 120  * from another glib-function, e.g. as a callback.
 121  */
 122 void    g_thread_init   (GThreadFunctions       *vtable);
 123
 124 /* Errorcheck mutexes. If you define G_ERRORCHECK_MUTEXES, then all
 125  * mutexes will check for re-locking and re-unlocking */
 126
 127 /* Initialize thread system with errorcheck mutexes. vtable must be
 128  * NULL. Do not call directly. Use #define G_ERRORCHECK_MUTEXES
 129  * instead.
 130  */
 131 void    g_thread_init_with_errorcheck_mutexes (GThreadFunctions* vtable);
 132
 133 /* A random number to recognize debug calls to g_mutex_... */
 134 #define G_MUTEX_DEBUG_MAGIC 0xf8e18ad7
 135
 136 #ifdef G_ERRORCHECK_MUTEXES
 137 #define g_thread_init(vtable) g_thread_init_with_errorcheck_mutexes (vtable)
 138 #endif
 139
 140 /* internal function for fallback static mutex implementation */
 141 GMutex* g_static_mutex_get_mutex_impl   (GMutex **mutex);
 142
 143 #define g_static_mutex_get_mutex_impl_shortcut(mutex) \
 144   (g_atomic_pointer_get ((gpointer*)(void*)mutex) ? *(mutex) : \
 145    g_static_mutex_get_mutex_impl (mutex))
 146
 147 /* shorthands for conditional and unconditional function calls */
 148
 149 #define G_THREAD_UF(op, arglist)                                        \
 150     (*g_thread_functions_for_glib_use . op) arglist
 151 #define G_THREAD_CF(op, fail, arg)                                      \
 152     (g_thread_supported () ? G_THREAD_UF (op, arg) : (fail))
 153 #define G_THREAD_ECF(op, fail, mutex, type)                             \
 154     (g_thread_supported () ?                                            \
 155       ((type(*)(GMutex*, const gulong, gchar const*))                   \
 156       (*g_thread_functions_for_glib_use . op))                          \
 157      (mutex, G_MUTEX_DEBUG_MAGIC, G_STRLOC) : (fail))
 158
 159 #ifndef G_ERRORCHECK_MUTEXES
 160 # define g_mutex_lock(mutex)                                            \
 161     G_THREAD_CF (mutex_lock,     (void)0, (mutex))
 162 # define g_mutex_trylock(mutex)                                         \
 163     G_THREAD_CF (mutex_trylock,  TRUE,    (mutex))
 164 # define g_mutex_unlock(mutex)                                          \
 165     G_THREAD_CF (mutex_unlock,   (void)0, (mutex))
 166 # define g_mutex_free(mutex)                                            \
 167     G_THREAD_CF (mutex_free,     (void)0, (mutex))
 168 # define g_cond_wait(cond, mutex)                                       \
 169     G_THREAD_CF (cond_wait,      (void)0, (cond, mutex))
 170 # define g_cond_timed_wait(cond, mutex, abs_time)                       \
 171     G_THREAD_CF (cond_timed_wait, TRUE,   (cond, mutex, abs_time))
 172 #else /* G_ERRORCHECK_MUTEXES */
 173 # define g_mutex_lock(mutex)                                            \
 174     G_THREAD_ECF (mutex_lock,    (void)0, (mutex), void)
 175 # define g_mutex_trylock(mutex)                                         \
 176     G_THREAD_ECF (mutex_trylock, TRUE,    (mutex), gboolean)
 177 # define g_mutex_unlock(mutex)                                          \
 178     G_THREAD_ECF (mutex_unlock,  (void)0, (mutex), void)
 179 # define g_mutex_free(mutex)                                            \
 180     G_THREAD_ECF (mutex_free,    (void)0, (mutex), void)
 181 # define g_cond_wait(cond, mutex)                                       \
 182     (g_thread_supported () ? ((void(*)(GCond*, GMutex*, gulong, gchar*))\
 183       g_thread_functions_for_glib_use.cond_wait)                        \
 184         (cond, mutex, G_MUTEX_DEBUG_MAGIC, G_STRLOC) : (void) 0)
 185 # define g_cond_timed_wait(cond, mutex, abs_time)                       \
 186     (g_thread_supported () ?                                            \
 187       ((gboolean(*)(GCond*, GMutex*, GTimeVal*, gulong, gchar*))        \
 188         g_thread_functions_for_glib_use.cond_timed_wait)                \
 189           (cond, mutex, abs_time, G_MUTEX_DEBUG_MAGIC, G_STRLOC) : TRUE)
 190 #endif /* G_ERRORCHECK_MUTEXES */
 191
 192 #define g_thread_supported()    (g_threads_got_initialized)
 193 #define g_mutex_new()            G_THREAD_UF (mutex_new,      ())
 194 #define g_cond_new()             G_THREAD_UF (cond_new,       ())
 195 #define g_cond_signal(cond)      G_THREAD_CF (cond_signal,    (void)0, (cond))
 196 #define g_cond_broadcast(cond)   G_THREAD_CF (cond_broadcast, (void)0, (cond))
 197 #define g_cond_free(cond)        G_THREAD_CF (cond_free,      (void)0, (cond))
 198 #define g_private_new(destructor) G_THREAD_UF (private_new, (destructor))
 199 #define g_private_get(private_key) G_THREAD_CF (private_get, \
 200                                                 ((gpointer)private_key), \
 201                                                 (private_key))
 202 #define g_private_set(private_key, value) G_THREAD_CF (private_set, \
 203                                                        (void) (private_key = \
 204                                                         (GPrivate*) (value)), \
 205                                                        (private_key, value))
 206 #define g_thread_yield()              G_THREAD_CF (thread_yield, (void)0, ())
 207
 208 #define g_thread_create(func, data, joinable, error)                    \
 209   (g_thread_create_full (func, data, 0, joinable, FALSE,                \
 210                          G_THREAD_PRIORITY_NORMAL, error))
 211
 212 GThread* g_thread_create_full  (GThreadFunc            func,
 213                                 gpointer               data,
 214                                 gulong                 stack_size,
 215                                 gboolean               joinable,
 216                                 gboolean               bound,
 217                                 GThreadPriority        priority,
 218                                 GError               **error);
 219 GThread* g_thread_self         (void);
 220 void     g_thread_exit         (gpointer               retval);
 221 gpointer g_thread_join         (GThread               *thread);
 222
 223 void     g_thread_set_priority (GThread               *thread,
 224                                 GThreadPriority        priority);
 225
 226 /* GStaticMutexes can be statically initialized with the value
 227  * G_STATIC_MUTEX_INIT, and then they can directly be used, that is
 228  * much easier, than having to explicitly allocate the mutex before
 229  * use
 230  */
 231 #define g_static_mutex_lock(mutex) \
 232     g_mutex_lock (g_static_mutex_get_mutex (mutex))
 233 #define g_static_mutex_trylock(mutex) \
 234     g_mutex_trylock (g_static_mutex_get_mutex (mutex))
 235 #define g_static_mutex_unlock(mutex) \
 236     g_mutex_unlock (g_static_mutex_get_mutex (mutex))
 237 void g_static_mutex_init (GStaticMutex *mutex);
 238 void g_static_mutex_free (GStaticMutex *mutex);
 239
 240 struct _GStaticPrivate
 241 {
 242   /*< private >*/
 243   guint index;
 244 };
 245 #define G_STATIC_PRIVATE_INIT { 0 }
 246 void     g_static_private_init           (GStaticPrivate   *private_key);
 247 gpointer g_static_private_get            (GStaticPrivate   *private_key);
 248 void     g_static_private_set            (GStaticPrivate   *private_key,
 249                                           gpointer          data,
 250                                           GDestroyNotify    notify);
 251 void     g_static_private_free           (GStaticPrivate   *private_key);
 252
 253 typedef struct _GStaticRecMutex GStaticRecMutex;
 254 struct _GStaticRecMutex
 255 {
 256   /*< private >*/
 257   GStaticMutex mutex;
 258   guint depth;
 259   GSystemThread owner;
 260 };
 261
 262 #define G_STATIC_REC_MUTEX_INIT { G_STATIC_MUTEX_INIT }
 263 void     g_static_rec_mutex_init        (GStaticRecMutex *mutex);
 264 void     g_static_rec_mutex_lock        (GStaticRecMutex *mutex);
 265 gboolean g_static_rec_mutex_trylock     (GStaticRecMutex *mutex);
 266 void     g_static_rec_mutex_unlock      (GStaticRecMutex *mutex);
 267 void     g_static_rec_mutex_lock_full   (GStaticRecMutex *mutex,
 268                                          guint            depth);
 269 guint    g_static_rec_mutex_unlock_full (GStaticRecMutex *mutex);
 270 void     g_static_rec_mutex_free        (GStaticRecMutex *mutex);
 271
 272 typedef struct _GStaticRWLock GStaticRWLock;
 273 struct _GStaticRWLock
 274 {
 275   /*< private >*/
 276   GStaticMutex mutex;
 277   GCond *read_cond;
 278   GCond *write_cond;
 279   guint read_counter;
 280   gboolean have_writer;
 281   guint want_to_read;
 282   guint want_to_write;
 283 };
 284
 285 #define G_STATIC_RW_LOCK_INIT { G_STATIC_MUTEX_INIT, NULL, NULL, 0, FALSE, 0, 0 }
 286
 287 void      g_static_rw_lock_init           (GStaticRWLock* lock);
 288 void      g_static_rw_lock_reader_lock    (GStaticRWLock* lock);
 289 gboolean  g_static_rw_lock_reader_trylock (GStaticRWLock* lock);
 290 void      g_static_rw_lock_reader_unlock  (GStaticRWLock* lock);
 291 void      g_static_rw_lock_writer_lock    (GStaticRWLock* lock);
 292 gboolean  g_static_rw_lock_writer_trylock (GStaticRWLock* lock);
 293 void      g_static_rw_lock_writer_unlock  (GStaticRWLock* lock);
 294 void      g_static_rw_lock_free           (GStaticRWLock* lock);
 295
 296 void      g_thread_foreach                (GFunc          thread_func,
 297                                            gpointer       user_data);
 298
 299 typedef enum
 300 {
 301   G_ONCE_STATUS_NOTCALLED,
 302   G_ONCE_STATUS_PROGRESS,
 303   G_ONCE_STATUS_READY
 304 } GOnceStatus;
 305
 306 typedef struct _GOnce GOnce;
 307 struct _GOnce
 308 {
 309   volatile GOnceStatus status;
 310   volatile gpointer retval;
 311 };
 312
 313 #define G_ONCE_INIT { G_ONCE_STATUS_NOTCALLED, NULL }
 314
 315 gpointer g_once_impl (GOnce *once, GThreadFunc func, gpointer arg);
 316
 317 #ifdef G_ATOMIC_OP_MEMORY_BARRIER_NEEDED
 318 # define g_once(once, func, arg) g_once_impl ((once), (func), (arg))
 319 #else /* !G_ATOMIC_OP_MEMORY_BARRIER_NEEDED*/
 320 # define g_once(once, func, arg) \
 321   (((once)->status == G_ONCE_STATUS_READY) ? \
 322    (once)->retval : \
 323    g_once_impl ((once), (func), (arg)))
 324 #endif /* G_ATOMIC_OP_MEMORY_BARRIER_NEEDED */
 325
 326 /* initialize-once guards, keyed by value_location */
 327 G_INLINE_FUNC gboolean  g_once_init_enter       (volatile gsize *value_location);
 328 gboolean                g_once_init_enter_impl  (volatile gsize *value_location);
 329 void                    g_once_init_leave       (volatile gsize *value_location,
 330                                                  gsize           initialization_value);
 331 #if defined (G_CAN_INLINE) || defined (__G_THREAD_C__)
 332 G_INLINE_FUNC gboolean
 333 g_once_init_enter (volatile gsize *value_location)
 334 {
 335   if G_LIKELY (g_atomic_pointer_get ((void*volatile*) value_location) != NULL)
 336     return FALSE;
 337   else
 338     return g_once_init_enter_impl (value_location);
 339 }
 340 #endif /* G_CAN_INLINE || __G_THREAD_C__ */
 341
 342 /* these are some convenience macros that expand to nothing if GLib
 343  * was configured with --disable-threads. for using StaticMutexes,
 344  * you define them with G_LOCK_DEFINE_STATIC (name) or G_LOCK_DEFINE (name)
 345  * if you need to export the mutex. With G_LOCK_EXTERN (name) you can
 346  * declare such an globally defined lock. name is a unique identifier
 347  * for the protected varibale or code portion. locking, testing and
 348  * unlocking of such mutexes can be done with G_LOCK(), G_UNLOCK() and
 349  * G_TRYLOCK() respectively.
 350  */
 351 extern void glib_dummy_decl (void);
 352 #define G_LOCK_NAME(name)               g__ ## name ## _lock
 353 #ifdef  G_THREADS_ENABLED
 354 #  define G_LOCK_DEFINE_STATIC(name)    static G_LOCK_DEFINE (name)
 355 #  define G_LOCK_DEFINE(name)           \
 356     GStaticMutex G_LOCK_NAME (name) = G_STATIC_MUTEX_INIT
 357 #  define G_LOCK_EXTERN(name)           extern GStaticMutex G_LOCK_NAME (name)
 358
 359 #  ifdef G_DEBUG_LOCKS
 360 #    define G_LOCK(name)                G_STMT_START{             \
 361         g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG,                   \
 362                "file %s: line %d (%s): locking: %s ",             \
 363                __FILE__,        __LINE__, G_GNUC_PRETTY_FUNCTION, \
 364                #name);                                            \
 365         g_static_mutex_lock (&G_LOCK_NAME (name));                \
 366      }G_STMT_END
 367 #    define G_UNLOCK(name)              G_STMT_START{             \
 368         g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG,                   \
 369                "file %s: line %d (%s): unlocking: %s ",           \
 370                __FILE__,        __LINE__, G_GNUC_PRETTY_FUNCTION, \
 371                #name);                                            \
 372        g_static_mutex_unlock (&G_LOCK_NAME (name));               \
 373      }G_STMT_END
 374 #    define G_TRYLOCK(name)                                       \
 375         (g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG,                  \
 376                "file %s: line %d (%s): try locking: %s ",         \
 377                __FILE__,        __LINE__, G_GNUC_PRETTY_FUNCTION, \
 378                #name), g_static_mutex_trylock (&G_LOCK_NAME (name)))
 379 #  else  /* !G_DEBUG_LOCKS */
 380 #    define G_LOCK(name) g_static_mutex_lock       (&G_LOCK_NAME (name))
 381 #    define G_UNLOCK(name) g_static_mutex_unlock   (&G_LOCK_NAME (name))
 382 #    define G_TRYLOCK(name) g_static_mutex_trylock (&G_LOCK_NAME (name))
 383 #  endif /* !G_DEBUG_LOCKS */
 384 #else   /* !G_THREADS_ENABLED */
 385 #  define G_LOCK_DEFINE_STATIC(name)    extern void glib_dummy_decl (void)
 386 #  define G_LOCK_DEFINE(name)           extern void glib_dummy_decl (void)
 387 #  define G_LOCK_EXTERN(name)           extern void glib_dummy_decl (void)
 388 #  define G_LOCK(name)
 389 #  define G_UNLOCK(name)
 390 #  define G_TRYLOCK(name)               (TRUE)
 391 #endif  /* !G_THREADS_ENABLED */
 392
 393
 394 G_END_DECLS
 395
 396 #endif /* __G_THREAD_H__ */