glib/deprecated/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_DEPRECATED_THREAD_H__
  32 #define __G_DEPRECATED_THREAD_H__
  33
  34 #include <glib/gthread.h>
  35
  36 G_BEGIN_DECLS
  37
  38 typedef enum
  39 {
  40   G_THREAD_PRIORITY_LOW,
  41   G_THREAD_PRIORITY_NORMAL,
  42   G_THREAD_PRIORITY_HIGH,
  43   G_THREAD_PRIORITY_URGENT
  44 } GThreadPriority;
  45
  46 struct  _GThread
  47 {
  48   /*< private >*/
  49   GThreadFunc func;
  50   gpointer data;
  51   gboolean joinable;
  52   GThreadPriority priority;
  53 };
  54
  55 typedef struct _GThreadFunctions GThreadFunctions;
  56 struct _GThreadFunctions
  57 {
  58   GMutex*  (*mutex_new)           (void);
  59   void     (*mutex_lock)          (GMutex               *mutex);
  60   gboolean (*mutex_trylock)       (GMutex               *mutex);
  61   void     (*mutex_unlock)        (GMutex               *mutex);
  62   void     (*mutex_free)          (GMutex               *mutex);
  63   GCond*   (*cond_new)            (void);
  64   void     (*cond_signal)         (GCond                *cond);
  65   void     (*cond_broadcast)      (GCond                *cond);
  66   void     (*cond_wait)           (GCond                *cond,
  67                                    GMutex               *mutex);
  68   gboolean (*cond_timed_wait)     (GCond                *cond,
  69                                    GMutex               *mutex,
  70                                    GTimeVal             *end_time);
  71   void      (*cond_free)          (GCond                *cond);
  72   GPrivate* (*private_new)        (GDestroyNotify        destructor);
  73   gpointer  (*private_get)        (GPrivate             *private_key);
  74   void      (*private_set)        (GPrivate             *private_key,
  75                                    gpointer              data);
  76   void      (*thread_create)      (GThreadFunc           func,
  77                                    gpointer              data,
  78                                    gulong                stack_size,
  79                                    gboolean              joinable,
  80                                    gboolean              bound,
  81                                    GThreadPriority       priority,
  82                                    gpointer              thread,
  83                                    GError              **error);
  84   void      (*thread_yield)       (void);
  85   void      (*thread_join)        (gpointer              thread);
  86   void      (*thread_exit)        (void);
  87   void      (*thread_set_priority)(gpointer              thread,
  88                                    GThreadPriority       priority);
  89   void      (*thread_self)        (gpointer              thread);
  90   gboolean  (*thread_equal)       (gpointer              thread1,
  91                                    gpointer              thread2);
  92 };
  93
  94 GLIB_VAR GThreadFunctions       g_thread_functions_for_glib_use;
  95 GLIB_VAR gboolean               g_thread_use_default_impl;
  96
  97 GLIB_VAR guint64   (*g_thread_gettime) (void);
  98
  99 /* internal function for fallback static mutex implementation */
 100 GMutex* g_static_mutex_get_mutex_impl   (GMutex **mutex);
 101
 102 GThread* g_thread_create       (GThreadFunc            func,
 103                                 gpointer               data,
 104                                 gboolean               joinable,
 105                                 GError               **error);
 106 GThread* g_thread_create_full  (GThreadFunc            func,
 107                                 gpointer               data,
 108                                 gulong                 stack_size,
 109                                 gboolean               joinable,
 110                                 gboolean               bound,
 111                                 GThreadPriority        priority,
 112                                 GError               **error);
 113
 114 void g_thread_set_priority     (GThread         *thread,
 115                                 GThreadPriority  priority);
 116
 117 void     g_thread_foreach      (GFunc         thread_func,
 118                                 gpointer      user_data);
 119
 120 #ifdef G_OS_WIN32
 121 typedef GMutex * GStaticMutex;
 122 #define G_STATIC_MUTEX_INIT NULL
 123 #define g_static_mutex_get_mutex g_static_mutex_get_mutex_impl
 124 #else /* G_OS_WIN32 */
 125 typedef struct {
 126   GMutex *unused;
 127   GMutex mutex;
 128 } GStaticMutex;
 129 #define G_STATIC_MUTEX_INIT { NULL, { NULL } }
 130 #define g_static_mutex_get_mutex(s) (&(s)->mutex)
 131 #endif /* G_OS_WIN32 */
 132
 133 #define g_static_mutex_lock(mutex) \
 134     g_mutex_lock (g_static_mutex_get_mutex (mutex))
 135 #define g_static_mutex_trylock(mutex) \
 136     g_mutex_trylock (g_static_mutex_get_mutex (mutex))
 137 #define g_static_mutex_unlock(mutex) \
 138     g_mutex_unlock (g_static_mutex_get_mutex (mutex))
 139 void g_static_mutex_init (GStaticMutex *mutex);
 140 void g_static_mutex_free (GStaticMutex *mutex);
 141
 142 typedef struct _GStaticRecMutex GStaticRecMutex;
 143 struct _GStaticRecMutex
 144 {
 145   /*< private >*/
 146   GStaticMutex mutex;
 147   guint depth;
 148   GSystemThread owner;
 149 };
 150
 151 #define G_STATIC_REC_MUTEX_INIT { G_STATIC_MUTEX_INIT, 0, {{0, 0, 0, 0}} }
 152 void     g_static_rec_mutex_init        (GStaticRecMutex *mutex);
 153 void     g_static_rec_mutex_lock        (GStaticRecMutex *mutex);
 154 gboolean g_static_rec_mutex_trylock     (GStaticRecMutex *mutex);
 155 void     g_static_rec_mutex_unlock      (GStaticRecMutex *mutex);
 156 void     g_static_rec_mutex_lock_full   (GStaticRecMutex *mutex,
 157                                          guint            depth);
 158 guint    g_static_rec_mutex_unlock_full (GStaticRecMutex *mutex);
 159 void     g_static_rec_mutex_free        (GStaticRecMutex *mutex);
 160
 161 typedef struct _GStaticRWLock GStaticRWLock;
 162 struct _GStaticRWLock
 163 {
 164   /*< private >*/
 165   GStaticMutex mutex;
 166   GCond *read_cond;
 167   GCond *write_cond;
 168   guint read_counter;
 169   gboolean have_writer;
 170   guint want_to_read;
 171   guint want_to_write;
 172 };
 173
 174 #define G_STATIC_RW_LOCK_INIT { G_STATIC_MUTEX_INIT, NULL, NULL, 0, FALSE, 0, 0 }
 175
 176 void      g_static_rw_lock_init           (GStaticRWLock* lock);
 177 void      g_static_rw_lock_reader_lock    (GStaticRWLock* lock);
 178 gboolean  g_static_rw_lock_reader_trylock (GStaticRWLock* lock);
 179 void      g_static_rw_lock_reader_unlock  (GStaticRWLock* lock);
 180 void      g_static_rw_lock_writer_lock    (GStaticRWLock* lock);
 181 gboolean  g_static_rw_lock_writer_trylock (GStaticRWLock* lock);
 182 void      g_static_rw_lock_writer_unlock  (GStaticRWLock* lock);
 183 void      g_static_rw_lock_free           (GStaticRWLock* lock);
 184
 185 GPrivate *      g_private_new             (GDestroyNotify  notify);
 186
 187 typedef struct _GStaticPrivate  GStaticPrivate;
 188 struct _GStaticPrivate
 189 {
 190   /*< private >*/
 191   guint index;
 192 };
 193
 194 #define G_STATIC_PRIVATE_INIT { 0 }
 195 void     g_static_private_init           (GStaticPrivate   *private_key);
 196 gpointer g_static_private_get            (GStaticPrivate   *private_key);
 197 void     g_static_private_set            (GStaticPrivate   *private_key,
 198                                           gpointer          data,
 199                                           GDestroyNotify    notify);
 200 void     g_static_private_free           (GStaticPrivate   *private_key);
 201
 202 gboolean g_once_init_enter_impl          (volatile gsize   *location);
 203
 204 void     g_thread_init   (gpointer vtable);
 205
 206 gboolean g_thread_get_initialized (void);
 207
 208 GLIB_VAR gboolean g_threads_got_initialized;
 209
 210 #if defined(G_THREADS_MANDATORY)
 211 #define g_thread_supported()     1
 212 #else
 213 #define g_thread_supported()    (g_threads_got_initialized)
 214 #endif
 215
 216 GMutex* g_static_mutex_get_mutex_impl   (GMutex **mutex);
 217
 218 GMutex *                g_mutex_new                                     (void);
 219 void                    g_mutex_free                                    (GMutex         *mutex);
 220 GCond *                 g_cond_new                                      (void);
 221 void                    g_cond_free                                     (GCond          *cond);
 222
 223 G_END_DECLS
 224
 225 #endif /* __G_DEPRECATED_THREAD_H__ */