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 struct _GMutex
  63 {
  64   gpointer impl;
  65 };
  66
  67 struct _GRWLock
  68 {
  69   gpointer impl;
  70 };
  71
  72 struct _GCond
  73 {
  74   gpointer impl;
  75 };
  76
  77 struct _GRecMutex
  78 {
  79   gpointer impl;
  80 };
  81
  82 #define G_PRIVATE_INIT(notify) { NULL, (notify), { NULL, NULL } }
  83 struct _GPrivate
  84 {
  85   gpointer       p;
  86   GDestroyNotify notify;
  87   gpointer future[2];
  88 };
  89
  90 void     g_thread_init   (gpointer vtable);
  91
  92 gboolean g_thread_get_initialized (void);
  93
  94 GLIB_VAR gboolean g_threads_got_initialized;
  95
  96 #if defined(G_THREADS_MANDATORY)
  97 #define g_thread_supported()     1
  98 #else
  99 #define g_thread_supported()    (g_threads_got_initialized)
 100 #endif
 101
 102 GMutex* g_static_mutex_get_mutex_impl   (GMutex **mutex);
 103
 104 GThread *g_thread_new                    (const gchar  *name,
 105                                           GThreadFunc   func,
 106                                           gpointer      data,
 107                                           gboolean      joinable,
 108                                           GError      **error);
 109
 110 GThread *g_thread_new_full               (const gchar  *name,
 111                                           GThreadFunc   func,
 112                                           gpointer      data,
 113                                           gboolean      joinable,
 114                                           gsize         stack_size,
 115                                           GError      **error);
 116
 117 GThread* g_thread_self                   (void);
 118 void     g_thread_exit                   (gpointer      retval);
 119 gpointer g_thread_join                   (GThread      *thread);
 120 void     g_thread_yield                  (void);
 121
 122 typedef enum
 123 {
 124   G_ONCE_STATUS_NOTCALLED,
 125   G_ONCE_STATUS_PROGRESS,
 126   G_ONCE_STATUS_READY
 127 } GOnceStatus;
 128
 129 typedef struct _GOnce GOnce;
 130 struct _GOnce
 131 {
 132   volatile GOnceStatus status;
 133   volatile gpointer retval;
 134 };
 135
 136 #define G_ONCE_INIT { G_ONCE_STATUS_NOTCALLED, NULL }
 137
 138 gpointer g_once_impl (GOnce *once, GThreadFunc func, gpointer arg);
 139
 140 #ifdef G_ATOMIC_OP_MEMORY_BARRIER_NEEDED
 141 # define g_once(once, func, arg) g_once_impl ((once), (func), (arg))
 142 #else /* !G_ATOMIC_OP_MEMORY_BARRIER_NEEDED*/
 143 # define g_once(once, func, arg) \
 144   (((once)->status == G_ONCE_STATUS_READY) ? \
 145    (once)->retval : \
 146    g_once_impl ((once), (func), (arg)))
 147 #endif /* G_ATOMIC_OP_MEMORY_BARRIER_NEEDED */
 148
 149 /* initialize-once guards, keyed by value_location */
 150 G_INLINE_FUNC gboolean  g_once_init_enter       (volatile gsize *value_location);
 151 gboolean                g_once_init_enter_impl  (volatile gsize *value_location);
 152 void                    g_once_init_leave       (volatile gsize *value_location,
 153                                                  gsize           initialization_value);
 154 #if defined (G_CAN_INLINE) || defined (__G_THREAD_C__)
 155 G_INLINE_FUNC gboolean
 156 g_once_init_enter (volatile gsize *value_location)
 157 {
 158   if G_LIKELY ((gpointer) g_atomic_pointer_get (value_location) != NULL)
 159     return FALSE;
 160   else
 161     return g_once_init_enter_impl (value_location);
 162 }
 163 #endif /* G_CAN_INLINE || __G_THREAD_C__ */
 164
 165 #define G_LOCK_NAME(name)               g__ ## name ## _lock
 166 #define G_LOCK_DEFINE_STATIC(name)    static G_LOCK_DEFINE (name)
 167 #define G_LOCK_DEFINE(name)           GMutex G_LOCK_NAME (name)
 168 #define G_LOCK_EXTERN(name)           extern GMutex G_LOCK_NAME (name)
 169
 170 #ifdef G_DEBUG_LOCKS
 171 #  define G_LOCK(name)                G_STMT_START{             \
 172       g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG,                   \
 173              "file %s: line %d (%s): locking: %s ",             \
 174              __FILE__,        __LINE__, G_STRFUNC,              \
 175              #name);                                            \
 176       g_mutex_lock (&G_LOCK_NAME (name));                       \
 177    }G_STMT_END
 178 #  define G_UNLOCK(name)              G_STMT_START{             \
 179       g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG,                   \
 180              "file %s: line %d (%s): unlocking: %s ",           \
 181              __FILE__,        __LINE__, G_STRFUNC,              \
 182              #name);                                            \
 183      g_mutex_unlock (&G_LOCK_NAME (name));                      \
 184    }G_STMT_END
 185 #  define G_TRYLOCK(name)                                       \
 186       (g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG,                  \
 187              "file %s: line %d (%s): try locking: %s ",         \
 188              __FILE__,        __LINE__, G_STRFUNC,              \
 189              #name), g_mutex_trylock (&G_LOCK_NAME (name)))
 190 #else  /* !G_DEBUG_LOCKS */
 191 #  define G_LOCK(name) g_mutex_lock       (&G_LOCK_NAME (name))
 192 #  define G_UNLOCK(name) g_mutex_unlock   (&G_LOCK_NAME (name))
 193 #  define G_TRYLOCK(name) g_mutex_trylock (&G_LOCK_NAME (name))
 194 #endif /* !G_DEBUG_LOCKS */
 195
 196
 197 GMutex *                g_mutex_new                                     (void);
 198 void                    g_mutex_free                                    (GMutex         *mutex);
 199 void                    g_mutex_init                                    (GMutex         *mutex);
 200 void                    g_mutex_clear                                   (GMutex         *mutex);
 201
 202 void                    g_mutex_lock                                    (GMutex         *mutex);
 203 void                    g_mutex_unlock                                  (GMutex         *mutex);
 204 gboolean                g_mutex_trylock                                 (GMutex         *mutex);
 205
 206 void                    g_rw_lock_init                                  (GRWLock        *rw_lock);
 207 void                    g_rw_lock_clear                                 (GRWLock        *rw_lock);
 208 void                    g_rw_lock_writer_lock                           (GRWLock        *rw_lock);
 209 gboolean                g_rw_lock_writer_trylock                        (GRWLock        *rw_lock);
 210 void                    g_rw_lock_writer_unlock                         (GRWLock        *rw_lock);
 211 void                    g_rw_lock_reader_lock                           (GRWLock        *rw_lock);
 212 gboolean                g_rw_lock_reader_trylock                        (GRWLock        *rw_lock);
 213 void                    g_rw_lock_reader_unlock                         (GRWLock        *rw_lock);
 214
 215 void                    g_rec_mutex_init                                (GRecMutex      *rec_mutex);
 216 void                    g_rec_mutex_clear                               (GRecMutex      *rec_mutex);
 217 void                    g_rec_mutex_lock                                (GRecMutex      *rec_mutex);
 218 gboolean                g_rec_mutex_trylock                             (GRecMutex      *rec_mutex);
 219 void                    g_rec_mutex_unlock                              (GRecMutex      *rec_mutex);
 220
 221 GCond *                 g_cond_new                                      (void);
 222 void                    g_cond_free                                     (GCond          *cond);
 223 void                    g_cond_init                                     (GCond          *cond);
 224 void                    g_cond_clear                                    (GCond          *cond);
 225
 226 void                    g_cond_wait                                     (GCond          *cond,
 227                                                                          GMutex         *mutex);
 228 void                    g_cond_signal                                   (GCond          *cond);
 229 void                    g_cond_broadcast                                (GCond          *cond);
 230 gboolean                g_cond_timed_wait                               (GCond          *cond,
 231                                                                          GMutex         *mutex,
 232                                                                          GTimeVal       *timeval);
 233 gboolean                g_cond_timedwait                                (GCond          *cond,
 234                                                                          GMutex         *mutex,
 235                                                                          gint64          abs_time);
 236
 237 gpointer                g_private_get                                   (GPrivate       *key);
 238 void                    g_private_set                                   (GPrivate       *key,
 239                                                                          gpointer        value);
 240 void                    g_private_replace                               (GPrivate       *key,
 241                                                                          gpointer        value);
 242
 243 G_END_DECLS
 244
 245 #endif /* __G_THREAD_H__ */