gthread/gthread-impl.c

   1 /* GLIB - Library of useful routines for C programming
   2  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   4  * gthread.c: thread related functions
   5  * Copyright 1998 Sebastian Wilhelmi; University of Karlsruhe
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  */
  22
  23 /*
  24  * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
  25  * file for a list of people on the GLib Team.  See the ChangeLog
  26  * files for a list of changes.  These files are distributed with
  27  * GLib at ftp://ftp.gtk.org/pub/gtk/.
  28  */
  29
  30 /*
  31  * MT safe
  32  */
  33
  34 #ifdef HAVE_CONFIG_H
  35 #include <config.h>
  36 #endif
  37
  38 #include <glib.h>
  39
  40 static gboolean thread_system_already_initialized = FALSE;
  41 static gint g_thread_priority_map [G_THREAD_PRIORITY_URGENT + 1];
  42
  43 #include G_THREAD_SOURCE
  44
  45 #ifndef PRIORITY_LOW_VALUE
  46 # define PRIORITY_LOW_VALUE 0
  47 #endif
  48
  49 #ifndef PRIORITY_URGENT_VALUE
  50 # define PRIORITY_URGENT_VALUE 0
  51 #endif
  52
  53 #ifndef PRIORITY_NORMAL_VALUE
  54 # define PRIORITY_NORMAL_VALUE                                          \
  55   (PRIORITY_LOW_VALUE + (PRIORITY_URGENT_VALUE - PRIORITY_LOW_VALUE) * 4 / 10)
  56 #endif /* PRIORITY_NORMAL_VALUE */
  57
  58 #ifndef PRIORITY_HIGH_VALUE
  59 # define PRIORITY_HIGH_VALUE                                            \
  60   (PRIORITY_LOW_VALUE + (PRIORITY_URGENT_VALUE - PRIORITY_LOW_VALUE) * 8 / 10)
  61 #endif /* PRIORITY_HIGH_VALUE */
  62
  63 void g_mutex_init (void);
  64 void g_mem_init (void);
  65 void g_messages_init (void);
  66
  67 #define G_MUTEX_DEBUG_INFO(mutex) (*((gpointer*)(((char*)mutex)+G_MUTEX_SIZE)))
  68
  69 typedef struct _ErrorCheckInfo ErrorCheckInfo;
  70 struct _ErrorCheckInfo
  71 {
  72   gchar *location;
  73   GThread *owner;
  74 };
  75
  76 static GMutex *
  77 g_mutex_new_errorcheck_impl (void)
  78 {
  79   GMutex *retval = g_thread_functions_for_glib_use_default.mutex_new ();
  80   retval = g_realloc (retval, G_MUTEX_SIZE + sizeof (gpointer));
  81   G_MUTEX_DEBUG_INFO (retval) = NULL;
  82   return retval;
  83 }
  84
  85 static void
  86 g_mutex_lock_errorcheck_impl (GMutex *mutex,
  87                               gulong magic,
  88                               gchar *location)
  89 {
  90   ErrorCheckInfo *info;
  91   GThread *self = g_thread_self ();
  92
  93   if (magic != G_MUTEX_DEBUG_MAGIC)
  94     location = "unknown";
  95
  96   if (G_MUTEX_DEBUG_INFO (mutex) == NULL)
  97     {
  98       /* if the debug info is NULL, we have not yet locked that mutex,
  99        * so we do it now */
 100       g_thread_functions_for_glib_use_default.mutex_lock (mutex);
 101       /* Now we have to check again, because another thread might have
 102        * tried to lock the mutex at the same time we did. This
 103        * technique is not 100% save on systems without decent cache
 104        * coherence, but we have no choice */
 105       if (G_MUTEX_DEBUG_INFO (mutex) == NULL)
 106         {
 107           info = G_MUTEX_DEBUG_INFO (mutex) = g_new0 (ErrorCheckInfo, 1);
 108         }
 109       g_thread_functions_for_glib_use_default.mutex_unlock (mutex);
 110     }
 111
 112   info = G_MUTEX_DEBUG_INFO (mutex);
 113   if (info->owner == self)
 114     g_error ("Trying to recursivly lock a mutex at '%s', "
 115              "previously locked at '%s'",
 116              location, info->location);
 117
 118   g_thread_functions_for_glib_use_default.mutex_lock (mutex);
 119
 120   info->owner = self;
 121   info->location = location;
 122 }
 123
 124 static gboolean
 125 g_mutex_trylock_errorcheck_impl (GMutex *mutex,
 126                                  gulong magic,
 127                                  gchar *location)
 128 {
 129   ErrorCheckInfo *info = G_MUTEX_DEBUG_INFO (mutex);
 130   GThread *self = g_thread_self ();
 131
 132   if (magic != G_MUTEX_DEBUG_MAGIC)
 133     location = "unknown";
 134
 135   if (!info)
 136     {
 137       /* This mutex has not yet been used, so simply lock and return TRUE */
 138       g_mutex_lock_errorcheck_impl (mutex, magic, location);
 139       return TRUE;
 140     }
 141
 142   if (info->owner == self)
 143     g_error ("Trying to recursivly lock a mutex at '%s', "
 144              "previously locked at '%s'",
 145              location, info->location);
 146
 147   if (!g_thread_functions_for_glib_use_default.mutex_trylock (mutex))
 148     return FALSE;
 149
 150   info->owner = self;
 151   info->location = location;
 152
 153   return TRUE;
 154 }
 155
 156 static void
 157 g_mutex_unlock_errorcheck_impl (GMutex *mutex,
 158                                 gulong magic,
 159                                 gchar *location)
 160 {
 161   ErrorCheckInfo *info = G_MUTEX_DEBUG_INFO (mutex);
 162   GThread *self = g_thread_self ();
 163
 164   if (magic != G_MUTEX_DEBUG_MAGIC)
 165     location = "unknown";
 166
 167   if (!info || info->owner == NULL)
 168     g_error ("Trying to unlock an unlocked mutex at '%s'", location);
 169
 170   if (info->owner != self)
 171     g_warning ("Trying to unlock a mutex at '%s', "
 172                "previously locked by a different thread at '%s'",
 173                location, info->location);
 174
 175   info->owner = NULL;
 176   info->location = NULL;
 177
 178   g_thread_functions_for_glib_use_default.mutex_unlock (mutex);
 179 }
 180
 181 static void
 182 g_mutex_free_errorcheck_impl (GMutex *mutex,
 183                               gulong magic,
 184                               gchar *location)
 185 {
 186   ErrorCheckInfo *info = G_MUTEX_DEBUG_INFO (mutex);
 187
 188   if (magic != G_MUTEX_DEBUG_MAGIC)
 189     location = "unknown";
 190
 191   if (info && info->owner != NULL)
 192     g_error ("Trying to free a locked mutex at '%s', "
 193              "which was previously locked at '%s'",
 194              location, info->location);
 195
 196   g_free (G_MUTEX_DEBUG_INFO (mutex));
 197   g_thread_functions_for_glib_use_default.mutex_free (mutex);
 198 }
 199
 200 static void
 201 g_cond_wait_errorcheck_impl (GCond *cond,
 202                              GMutex *mutex,
 203                              gulong magic,
 204                              gchar *location)
 205 {
 206
 207   ErrorCheckInfo *info = G_MUTEX_DEBUG_INFO (mutex);
 208   GThread *self = g_thread_self ();
 209
 210   if (magic != G_MUTEX_DEBUG_MAGIC)
 211     location = "unknown";
 212
 213   if (!info || info->owner == NULL)
 214     g_error ("Trying to use an unlocked mutex in g_cond_wait() at '%s'",
 215              location);
 216
 217   if (info->owner != self)
 218     g_error ("Trying to use a mutex locked by another thread in "
 219              "g_cond_wait() at '%s'", location);
 220
 221   info->owner = NULL;
 222   location = info->location;
 223
 224   g_thread_functions_for_glib_use_default.cond_wait (cond, mutex);
 225
 226   info->owner = self;
 227   info->location = location;
 228 }
 229
 230
 231 static gboolean
 232 g_cond_timed_wait_errorcheck_impl (GCond *cond,
 233                                    GMutex *mutex,
 234                                    GTimeVal *end_time,
 235                                    gulong magic,
 236                                    gchar *location)
 237 {
 238   ErrorCheckInfo *info = G_MUTEX_DEBUG_INFO (mutex);
 239   GThread *self = g_thread_self ();
 240   gboolean retval;
 241
 242   if (magic != G_MUTEX_DEBUG_MAGIC)
 243     location = "unknown";
 244
 245   if (!info || info->owner == NULL)
 246     g_error ("Trying to use an unlocked mutex in g_cond_timed_wait() at '%s'",
 247              location);
 248
 249   if (info->owner != self)
 250     g_error ("Trying to use a mutex locked by another thread in "
 251              "g_cond_timed_wait() at '%s'", location);
 252
 253   info->owner = NULL;
 254   location = info->location;
 255
 256   retval = g_thread_functions_for_glib_use_default.cond_timed_wait (cond,
 257                                                                     mutex,
 258                                                                     end_time);
 259
 260   info->owner = self;
 261   info->location = location;
 262
 263   return retval;
 264 }
 265
 266
 267 /* unshadow function declaration. See gthread.h */
 268 #undef g_thread_init
 269
 270 void
 271 g_thread_init_with_errorcheck_mutexes (GThreadFunctions* init)
 272 {
 273   GThreadFunctions errorcheck_functions;
 274   if (init)
 275     g_error ("Errorcheck mutexes can only be used for native "
 276              "thread implementations. Sorry." );
 277   errorcheck_functions = g_thread_functions_for_glib_use_default;
 278   errorcheck_functions.mutex_new = g_mutex_new_errorcheck_impl;
 279   errorcheck_functions.mutex_lock =
 280     (void (*)(GMutex *)) g_mutex_lock_errorcheck_impl;
 281   errorcheck_functions.mutex_trylock =
 282     (gboolean (*)(GMutex *)) g_mutex_trylock_errorcheck_impl;
 283   errorcheck_functions.mutex_unlock =
 284     (void (*)(GMutex *)) g_mutex_unlock_errorcheck_impl;
 285   errorcheck_functions.mutex_free =
 286     (void (*)(GMutex *)) g_mutex_free_errorcheck_impl;
 287   errorcheck_functions.cond_wait =
 288     (void (*)(GCond *, GMutex *)) g_cond_wait_errorcheck_impl;
 289   errorcheck_functions.cond_timed_wait =
 290     (gboolean (*)(GCond *, GMutex *, GTimeVal *))
 291     g_cond_timed_wait_errorcheck_impl;
 292
 293 #ifdef HAVE_G_THREAD_IMPL_INIT
 294   /* This isn't called in g_thread_init, as it doesn't think to get
 295    * the default implementation, so we have to call it on our own. */
 296   g_thread_impl_init();
 297 #endif
 298
 299   g_thread_init (&errorcheck_functions);
 300 }
 301
 302 void
 303 g_thread_init (GThreadFunctions* init)
 304 {
 305   gboolean supported;
 306
 307 #ifndef G_THREADS_ENABLED
 308   g_error ("GLib thread support is disabled.");
 309 #endif  /* !G_THREADS_ENABLED */
 310
 311   if (thread_system_already_initialized)
 312     g_error ("GThread system may only be initialized once.");
 313
 314   thread_system_already_initialized = TRUE;
 315
 316   if (init == NULL)
 317     {
 318 #ifdef HAVE_G_THREAD_IMPL_INIT
 319       /* now do any initialization stuff required by the
 320        * implementation, but only if called with a NULL argument, of
 321        * course. Otherwise it's up to the user to do so. */
 322       g_thread_impl_init();
 323 #endif /* HAVE_G_THREAD_IMPL_INIT */
 324       init = &g_thread_functions_for_glib_use_default;
 325     }
 326   else
 327     g_thread_use_default_impl = FALSE;
 328
 329   g_thread_functions_for_glib_use = *init;
 330
 331   /* It is important, that g_threads_got_initialized is not set before the
 332    * thread initialization functions of the different modules are called
 333    */
 334   supported = (init->mutex_new &&
 335                init->mutex_lock &&
 336                init->mutex_trylock &&
 337                init->mutex_unlock &&
 338                init->mutex_free &&
 339                init->cond_new &&
 340                init->cond_signal &&
 341                init->cond_broadcast &&
 342                init->cond_wait &&
 343                init->cond_timed_wait &&
 344                init->cond_free &&
 345                init->private_new &&
 346                init->private_get &&
 347                init->private_get &&
 348                init->thread_create &&
 349                init->thread_yield &&
 350                init->thread_join &&
 351                init->thread_exit &&
 352                init->thread_set_priority &&
 353                init->thread_self);
 354
 355   /* if somebody is calling g_thread_init (), it means that he wants to
 356    * have thread support, so check this
 357    */
 358   if (!supported)
 359     {
 360       if (g_thread_use_default_impl)
 361         g_error ("Threads are not supported on this platform.");
 362       else
 363         g_error ("The supplied thread function vector is invalid.");
 364     }
 365
 366   g_thread_priority_map [G_THREAD_PRIORITY_LOW] = PRIORITY_LOW_VALUE;
 367   g_thread_priority_map [G_THREAD_PRIORITY_NORMAL] = PRIORITY_NORMAL_VALUE;
 368   g_thread_priority_map [G_THREAD_PRIORITY_HIGH] = PRIORITY_HIGH_VALUE;
 369   g_thread_priority_map [G_THREAD_PRIORITY_URGENT] = PRIORITY_URGENT_VALUE;
 370
 371   /* now call the thread initialization functions of the different
 372    * glib modules. order does matter, g_mutex_init MUST come first.
 373    */
 374   g_mutex_init ();
 375   g_mem_init ();
 376   g_messages_init ();
 377
 378   /* now we can set g_threads_got_initialized and thus enable
 379    * all the thread functions
 380    */
 381   g_threads_got_initialized = TRUE;
 382
 383   /* we want the main thread to run with normal priority */
 384   g_thread_set_priority (g_thread_self(), G_THREAD_PRIORITY_NORMAL);
 385 }