glib/gthread.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: MT safety related functions
   5  * Copyright 1998 Sebastian Wilhelmi; University of Karlsruhe
   6  *                Owen Taylor
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with this library; if not, write to the
  20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  21  * Boston, MA 02111-1307, USA.
  22  */
  23
  24 /* Prelude {{{1 ----------------------------------------------------------- */
  25
  26 /*
  27  * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
  28  * file for a list of people on the GLib Team.  See the ChangeLog
  29  * files for a list of changes.  These files are distributed with
  30  * GLib at ftp://ftp.gtk.org/pub/gtk/.
  31  */
  32
  33 /*
  34  * MT safe
  35  */
  36
  37 /* implement gthread.h's inline functions */
  38 #define G_IMPLEMENT_INLINES 1
  39 #define __G_THREAD_C__
  40
  41 #include "config.h"
  42
  43 #include "gthread.h"
  44 #include "gthreadprivate.h"
  45
  46 #include <string.h>
  47
  48 #ifdef HAVE_UNISTD_H
  49 #include <unistd.h>
  50 #endif
  51
  52 #ifndef G_OS_WIN32
  53 #include <sys/time.h>
  54 #include <time.h>
  55 #else
  56 #include <windows.h>
  57 #endif /* G_OS_WIN32 */
  58
  59 #include "gslice.h"
  60 #include "gtestutils.h"
  61
  62 /**
  63  * SECTION:threads
  64  * @title: Threads
  65  * @short_description: portable support for threads, mutexes, locks,
  66  *     conditions and thread private data
  67  * @see_also: #GThreadPool, #GAsyncQueue
  68  *
  69  * Threads act almost like processes, but unlike processes all threads
  70  * of one process share the same memory. This is good, as it provides
  71  * easy communication between the involved threads via this shared
  72  * memory, and it is bad, because strange things (so called
  73  * "Heisenbugs") might happen if the program is not carefully designed.
  74  * In particular, due to the concurrent nature of threads, no
  75  * assumptions on the order of execution of code running in different
  76  * threads can be made, unless order is explicitly forced by the
  77  * programmer through synchronization primitives.
  78  *
  79  * The aim of the thread-related functions in GLib is to provide a
  80  * portable means for writing multi-threaded software. There are
  81  * primitives for mutexes to protect the access to portions of memory
  82  * (#GMutex, #GRecMutex and #GRWLock). There is a facility to use
  83  * individual bits for locks (g_bit_lock()). There are primitives
  84  * for condition variables to allow synchronization of threads (#GCond).
  85  * There are primitives for thread-private data - data that every thread
  86  * has a private instance of (#GPrivate). There are
  87  * facilities for one-time initialization (#GOnce, g_once_init_enter()).
  88  * Finally there are primitives to create and manage threads (#GThread).
  89  *
  90  * The GLib threading system used to be initialized with g_thread_init().
  91  * This is no longer necessary. Since version 2.32, the GLib threading
  92  * system is automatically initialized at the start of your program,
  93  * and all thread-creation functions and synchronization primitives
  94  * are available right away. It is still possible to do thread-unsafe
  95  * initialization and setup at the beginning of your program, before
  96  * creating the first threads.
  97  *
  98  * GLib is internally completely thread-safe (all global data is
  99  * automatically locked), but individual data structure instances are
 100  * not automatically locked for performance reasons. For example,
 101  * you must coordinate accesses to the same #GHashTable from multiple
 102  * threads. The two notable exceptions from this rule are #GMainLoop
 103  * and #GAsyncQueue, which <emphasis>are</emphasis> thread-safe and
 104  * need no further application-level locking to be accessed from
 105  * multiple threads. Most refcounting functions such as g_object_ref()
 106  * are also thread-safe.
 107  */
 108
 109 /* G_LOCK Documentation {{{1 ---------------------------------------------- */
 110
 111 /**
 112  * G_LOCK_DEFINE:
 113  * @name: the name of the lock
 114  *
 115  * The %G_LOCK_* macros provide a convenient interface to #GMutex.
 116  * #G_LOCK_DEFINE defines a lock. It can appear in any place where
 117  * variable definitions may appear in programs, i.e. in the first block
 118  * of a function or outside of functions. The @name parameter will be
 119  * mangled to get the name of the #GMutex. This means that you
 120  * can use names of existing variables as the parameter - e.g. the name
 121  * of the variable you intend to protect with the lock. Look at our
 122  * <function>give_me_next_number()</function> example using the
 123  * %G_LOCK_* macros:
 124  *
 125  * <example>
 126  *  <title>Using the %G_LOCK_* convenience macros</title>
 127  *  <programlisting>
 128  *   G_LOCK_DEFINE (current_number);
 129  *
 130  *   int
 131  *   give_me_next_number (void)
 132  *   {
 133  *     static int current_number = 0;
 134  *     int ret_val;
 135  *
 136  *     G_LOCK (current_number);
 137  *     ret_val = current_number = calc_next_number (current_number);
 138  *     G_UNLOCK (current_number);
 139  *
 140  *     return ret_val;
 141  *   }
 142  *  </programlisting>
 143  * </example>
 144  */
 145
 146 /**
 147  * G_LOCK_DEFINE_STATIC:
 148  * @name: the name of the lock
 149  *
 150  * This works like #G_LOCK_DEFINE, but it creates a static object.
 151  */
 152
 153 /**
 154  * G_LOCK_EXTERN:
 155  * @name: the name of the lock
 156  *
 157  * This declares a lock, that is defined with #G_LOCK_DEFINE in another
 158  * module.
 159  */
 160
 161 /**
 162  * G_LOCK:
 163  * @name: the name of the lock
 164  *
 165  * Works like g_mutex_lock(), but for a lock defined with
 166  * #G_LOCK_DEFINE.
 167  */
 168
 169 /**
 170  * G_TRYLOCK:
 171  * @name: the name of the lock
 172  * @Returns: %TRUE, if the lock could be locked.
 173  *
 174  * Works like g_mutex_trylock(), but for a lock defined with
 175  * #G_LOCK_DEFINE.
 176  */
 177
 178 /**
 179  * G_UNLOCK:
 180  * @name: the name of the lock
 181  *
 182  * Works like g_mutex_unlock(), but for a lock defined with
 183  * #G_LOCK_DEFINE.
 184  */
 185
 186 /* GMutex Documentation {{{1 ------------------------------------------ */
 187
 188 /**
 189  * GMutex:
 190  *
 191  * The #GMutex struct is an opaque data structure to represent a mutex
 192  * (mutual exclusion). It can be used to protect data against shared
 193  * access. Take for example the following function:
 194  *
 195  * <example>
 196  *  <title>A function which will not work in a threaded environment</title>
 197  *  <programlisting>
 198  *   int
 199  *   give_me_next_number (void)
 200  *   {
 201  *     static int current_number = 0;
 202  *
 203  *     /<!-- -->* now do a very complicated calculation to calculate the new
 204  *      * number, this might for example be a random number generator
 205  *      *<!-- -->/
 206  *     current_number = calc_next_number (current_number);
 207  *
 208  *     return current_number;
 209  *   }
 210  *  </programlisting>
 211  * </example>
 212  *
 213  * It is easy to see that this won't work in a multi-threaded
 214  * application. There current_number must be protected against shared
 215  * access. A #GMutex can be used as a solution to this problem:
 216  *
 217  * <example>
 218  *  <title>Using GMutex to protected a shared variable</title>
 219  *  <programlisting>
 220  *   int
 221  *   give_me_next_number (void)
 222  *   {
 223  *     static GMutex mutex;
 224  *     static int current_number = 0;
 225  *     int ret_val;
 226  *
 227  *     g_mutex_lock (&amp;mutex);
 228  *     ret_val = current_number = calc_next_number (current_number);
 229  *     g_mutex_unlock (&amp;mutex);
 230  *
 231  *     return ret_val;
 232  *   }
 233  *  </programlisting>
 234  * </example>
 235  *
 236  * Notice that the #GMutex is not initialised to any particular value.
 237  * Its placement in static storage ensures that it will be initialised
 238  * to all-zeros, which is appropriate.
 239  *
 240  * If a #GMutex is placed in other contexts (eg: embedded in a struct)
 241  * then it must be explicitly initialised using g_mutex_init().
 242  *
 243  * A #GMutex should only be accessed via <function>g_mutex_</function>
 244  * functions.
 245  */
 246
 247 /* GRecMutex Documentation {{{1 -------------------------------------- */
 248
 249 /**
 250  * GRecMutex:
 251  *
 252  * The GRecMutex struct is an opaque data structure to represent a
 253  * recursive mutex. It is similar to a #GMutex with the difference
 254  * that it is possible to lock a GRecMutex multiple times in the same
 255  * thread without deadlock. When doing so, care has to be taken to
 256  * unlock the recursive mutex as often as it has been locked.
 257  *
 258  * If a #GRecMutex is allocated in static storage then it can be used
 259  * without initialisation.  Otherwise, you should call
 260  * g_rec_mutex_init() on it and g_rec_mutex_clear() when done.
 261  *
 262  * A GRecMutex should only be accessed with the
 263  * <function>g_rec_mutex_</function> functions.
 264  *
 265  * Since: 2.32
 266  */
 267
 268 /* GRWLock Documentation {{{1 ---------------------------------------- */
 269
 270 /**
 271  * GRWLock:
 272  *
 273  * The GRWLock struct is an opaque data structure to represent a
 274  * reader-writer lock. It is similar to a #GMutex in that it allows
 275  * multiple threads to coordinate access to a shared resource.
 276  *
 277  * The difference to a mutex is that a reader-writer lock discriminates
 278  * between read-only ('reader') and full ('writer') access. While only
 279  * one thread at a time is allowed write access (by holding the 'writer'
 280  * lock via g_rw_lock_writer_lock()), multiple threads can gain
 281  * simultaneous read-only access (by holding the 'reader' lock via
 282  * g_rw_lock_reader_lock()).
 283  *
 284  * <example>
 285  *  <title>An array with access functions</title>
 286  *  <programlisting>
 287  *   GRWLock lock;
 288  *   GPtrArray *array;
 289  *
 290  *   gpointer
 291  *   my_array_get (guint index)
 292  *   {
 293  *     gpointer retval = NULL;
 294  *
 295  *     if (!array)
 296  *       return NULL;
 297  *
 298  *     g_rw_lock_reader_lock (&amp;lock);
 299  *     if (index &lt; array->len)
 300  *       retval = g_ptr_array_index (array, index);
 301  *     g_rw_lock_reader_unlock (&amp;lock);
 302  *
 303  *     return retval;
 304  *   }
 305  *
 306  *   void
 307  *   my_array_set (guint index, gpointer data)
 308  *   {
 309  *     g_rw_lock_writer_lock (&amp;lock);
 310  *
 311  *     if (!array)
 312  *       array = g_ptr_array_new (<!-- -->);
 313  *
 314  *     if (index >= array->len)
 315  *       g_ptr_array_set_size (array, index+1);
 316  *     g_ptr_array_index (array, index) = data;
 317  *
 318  *     g_rw_lock_writer_unlock (&amp;lock);
 319  *   }
 320  *  </programlisting>
 321  *  <para>
 322  *    This example shows an array which can be accessed by many readers
 323  *    (the <function>my_array_get()</function> function) simultaneously,
 324  *    whereas the writers (the <function>my_array_set()</function>
 325  *    function) will only be allowed once at a time and only if no readers
 326  *    currently access the array. This is because of the potentially
 327  *    dangerous resizing of the array. Using these functions is fully
 328  *    multi-thread safe now.
 329  *  </para>
 330  * </example>
 331  *
 332  * If a #GRWLock is allocated in static storage then it can be used
 333  * without initialisation.  Otherwise, you should call
 334  * g_rw_lock_init() on it and g_rw_lock_clear() when done.
 335  *
 336  * A GRWLock should only be accessed with the
 337  * <function>g_rw_lock_</function> functions.
 338  *
 339  * Since: 2.32
 340  */
 341
 342 /* GCond Documentation {{{1 ------------------------------------------ */
 343
 344 /**
 345  * GCond:
 346  *
 347  * The #GCond struct is an opaque data structure that represents a
 348  * condition. Threads can block on a #GCond if they find a certain
 349  * condition to be false. If other threads change the state of this
 350  * condition they signal the #GCond, and that causes the waiting
 351  * threads to be woken up.
 352  *
 353  * <example>
 354  *  <title>
 355  *   Using GCond to block a thread until a condition is satisfied
 356  *  </title>
 357  *  <programlisting>
 358  *   GCond* data_cond = NULL; /<!-- -->* Must be initialized somewhere *<!-- -->/
 359  *   GMutex* data_mutex = NULL; /<!-- -->* Must be initialized somewhere *<!-- -->/
 360  *   gpointer current_data = NULL;
 361  *
 362  *   void
 363  *   push_data (gpointer data)
 364  *   {
 365  *     g_mutex_lock (data_mutex);
 366  *     current_data = data;
 367  *     g_cond_signal (data_cond);
 368  *     g_mutex_unlock (data_mutex);
 369  *   }
 370  *
 371  *   gpointer
 372  *   pop_data (void)
 373  *   {
 374  *     gpointer data;
 375  *
 376  *     g_mutex_lock (data_mutex);
 377  *     while (!current_data)
 378  *       g_cond_wait (data_cond, data_mutex);
 379  *     data = current_data;
 380  *     current_data = NULL;
 381  *     g_mutex_unlock (data_mutex);
 382  *
 383  *     return data;
 384  *   }
 385  *  </programlisting>
 386  * </example>
 387  *
 388  * Whenever a thread calls pop_data() now, it will wait until
 389  * current_data is non-%NULL, i.e. until some other thread
 390  * has called push_data().
 391  *
 392  * <note><para>It is important to use the g_cond_wait() and
 393  * g_cond_timed_wait() functions only inside a loop which checks for the
 394  * condition to be true.  It is not guaranteed that the waiting thread
 395  * will find the condition fulfilled after it wakes up, even if the
 396  * signaling thread left the condition in that state: another thread may
 397  * have altered the condition before the waiting thread got the chance
 398  * to be woken up, even if the condition itself is protected by a
 399  * #GMutex, like above.</para></note>
 400  *
 401  * If a #GCond is allocated in static storage then it can be used
 402  * without initialisation.  Otherwise, you should call g_cond_init() on
 403  * it and g_cond_clear() when done.
 404  *
 405  * A #GCond should only be accessed via the <function>g_cond_</function>
 406  * functions.
 407  */
 408
 409 /* GThread Documentation {{{1 ---------------------------------------- */
 410
 411 /**
 412  * GThread:
 413  *
 414  * The #GThread struct represents a running thread. This struct
 415  * is returned by g_thread_new() or g_thread_new_full(). You can
 416  * obtain the #GThread struct representing the current thead by
 417  * calling g_thread_self().
 418  *
 419  * The structure is opaque -- none of its fields may be directly
 420  * accessed.
 421  */
 422
 423 /**
 424  * GThreadFunc:
 425  * @data: data passed to the thread
 426  *
 427  * Specifies the type of the @func functions passed to
 428  * g_thread_new() or g_thread_new_full().
 429  *
 430  * If the thread is joinable, the return value of this function
 431  * is returned by a g_thread_join() call waiting for the thread.
 432  * If the thread is not joinable, the return value is ignored.
 433  *
 434  * Returns: the return value of the thread
 435  */
 436
 437 /**
 438  * g_thread_supported:
 439  *
 440  * This macro returns %TRUE if the thread system is initialized,
 441  * and %FALSE if it is not.
 442  *
 443  * For language bindings, g_thread_get_initialized() provides
 444  * the same functionality as a function.
 445  *
 446  * Returns: %TRUE, if the thread system is initialized
 447  */
 448
 449 /* GThreadError {{{1 ------------------------------------------------------- */
 450 /**
 451  * GThreadError:
 452  * @G_THREAD_ERROR_AGAIN: a thread couldn't be created due to resource
 453  *                        shortage. Try again later.
 454  *
 455  * Possible errors of thread related functions.
 456  **/
 457
 458 /**
 459  * G_THREAD_ERROR:
 460  *
 461  * The error domain of the GLib thread subsystem.
 462  **/
 463 GQuark
 464 g_thread_error_quark (void)
 465 {
 466   return g_quark_from_static_string ("g_thread_error");
 467 }
 468
 469 /* Local Data {{{1 -------------------------------------------------------- */
 470
 471 GMutex           g_once_mutex;
 472 static GCond     g_once_cond;
 473 static GSList   *g_once_init_list = NULL;
 474
 475 static void g_thread_cleanup (gpointer data);
 476 static GPrivate     g_thread_specific_private = G_PRIVATE_INIT (g_thread_cleanup);
 477
 478 G_LOCK_DEFINE_STATIC (g_thread_new);
 479
 480 /* GOnce {{{1 ------------------------------------------------------------- */
 481
 482 /**
 483  * GOnce:
 484  * @status: the status of the #GOnce
 485  * @retval: the value returned by the call to the function, if @status
 486  *          is %G_ONCE_STATUS_READY
 487  *
 488  * A #GOnce struct controls a one-time initialization function. Any
 489  * one-time initialization function must have its own unique #GOnce
 490  * struct.
 491  *
 492  * Since: 2.4
 493  */
 494
 495 /**
 496  * G_ONCE_INIT:
 497  *
 498  * A #GOnce must be initialized with this macro before it can be used.
 499  *
 500  * |[
 501  *   GOnce my_once = G_ONCE_INIT;
 502  * ]|
 503  *
 504  * Since: 2.4
 505  */
 506
 507 /**
 508  * GOnceStatus:
 509  * @G_ONCE_STATUS_NOTCALLED: the function has not been called yet.
 510  * @G_ONCE_STATUS_PROGRESS: the function call is currently in progress.
 511  * @G_ONCE_STATUS_READY: the function has been called.
 512  *
 513  * The possible statuses of a one-time initialization function
 514  * controlled by a #GOnce struct.
 515  *
 516  * Since: 2.4
 517  */
 518
 519 /**
 520  * g_once:
 521  * @once: a #GOnce structure
 522  * @func: the #GThreadFunc function associated to @once. This function
 523  *        is called only once, regardless of the number of times it and
 524  *        its associated #GOnce struct are passed to g_once().
 525  * @arg: data to be passed to @func
 526  *
 527  * The first call to this routine by a process with a given #GOnce
 528  * struct calls @func with the given argument. Thereafter, subsequent
 529  * calls to g_once()  with the same #GOnce struct do not call @func
 530  * again, but return the stored result of the first call. On return
 531  * from g_once(), the status of @once will be %G_ONCE_STATUS_READY.
 532  *
 533  * For example, a mutex or a thread-specific data key must be created
 534  * exactly once. In a threaded environment, calling g_once() ensures
 535  * that the initialization is serialized across multiple threads.
 536  *
 537  * Calling g_once() recursively on the same #GOnce struct in
 538  * @func will lead to a deadlock.
 539  *
 540  * |[
 541  *   gpointer
 542  *   get_debug_flags (void)
 543  *   {
 544  *     static GOnce my_once = G_ONCE_INIT;
 545  *
 546  *     g_once (&my_once, parse_debug_flags, NULL);
 547  *
 548  *     return my_once.retval;
 549  *   }
 550  * ]|
 551  *
 552  * Since: 2.4
 553  */
 554 gpointer
 555 g_once_impl (GOnce       *once,
 556              GThreadFunc  func,
 557              gpointer     arg)
 558 {
 559   g_mutex_lock (&g_once_mutex);
 560
 561   while (once->status == G_ONCE_STATUS_PROGRESS)
 562     g_cond_wait (&g_once_cond, &g_once_mutex);
 563
 564   if (once->status != G_ONCE_STATUS_READY)
 565     {
 566       once->status = G_ONCE_STATUS_PROGRESS;
 567       g_mutex_unlock (&g_once_mutex);
 568
 569       once->retval = func (arg);
 570
 571       g_mutex_lock (&g_once_mutex);
 572       once->status = G_ONCE_STATUS_READY;
 573       g_cond_broadcast (&g_once_cond);
 574     }
 575
 576   g_mutex_unlock (&g_once_mutex);
 577
 578   return once->retval;
 579 }
 580
 581 /**
 582  * g_once_init_enter:
 583  * @value_location: location of a static initializable variable
 584  *     containing 0
 585  *
 586  * Function to be called when starting a critical initialization
 587  * section. The argument @value_location must point to a static
 588  * 0-initialized variable that will be set to a value other than 0 at
 589  * the end of the initialization section. In combination with
 590  * g_once_init_leave() and the unique address @value_location, it can
 591  * be ensured that an initialization section will be executed only once
 592  * during a program's life time, and that concurrent threads are
 593  * blocked until initialization completed. To be used in constructs
 594  * like this:
 595  *
 596  * |[
 597  *   static gsize initialization_value = 0;
 598  *
 599  *   if (g_once_init_enter (&amp;initialization_value))
 600  *     {
 601  *       gsize setup_value = 42; /&ast;* initialization code here *&ast;/
 602  *
 603  *       g_once_init_leave (&amp;initialization_value, setup_value);
 604  *     }
 605  *
 606  *   /&ast;* use initialization_value here *&ast;/
 607  * ]|
 608  *
 609  * Returns: %TRUE if the initialization section should be entered,
 610  *     %FALSE and blocks otherwise
 611  *
 612  * Since: 2.14
 613  */
 614 gboolean
 615 (g_once_init_enter) (volatile void *pointer)
 616 {
 617   volatile gsize *value_location = pointer;
 618   gboolean need_init = FALSE;
 619   g_mutex_lock (&g_once_mutex);
 620   if (g_atomic_pointer_get (value_location) == NULL)
 621     {
 622       if (!g_slist_find (g_once_init_list, (void*) value_location))
 623         {
 624           need_init = TRUE;
 625           g_once_init_list = g_slist_prepend (g_once_init_list, (void*) value_location);
 626         }
 627       else
 628         do
 629           g_cond_wait (&g_once_cond, &g_once_mutex);
 630         while (g_slist_find (g_once_init_list, (void*) value_location));
 631     }
 632   g_mutex_unlock (&g_once_mutex);
 633   return need_init;
 634 }
 635
 636 /**
 637  * g_once_init_leave:
 638  * @value_location: location of a static initializable variable
 639  *     containing 0
 640  * @result: new non-0 value for *@value_location
 641  *
 642  * Counterpart to g_once_init_enter(). Expects a location of a static
 643  * 0-initialized initialization variable, and an initialization value
 644  * other than 0. Sets the variable to the initialization value, and
 645  * releases concurrent threads blocking in g_once_init_enter() on this
 646  * initialization variable.
 647  *
 648  * Since: 2.14
 649  */
 650 void
 651 (g_once_init_leave) (volatile void *pointer,
 652                      gsize          result)
 653 {
 654   volatile gsize *value_location = pointer;
 655
 656   g_return_if_fail (g_atomic_pointer_get (value_location) == NULL);
 657   g_return_if_fail (result != 0);
 658   g_return_if_fail (g_once_init_list != NULL);
 659
 660   g_atomic_pointer_set (value_location, result);
 661   g_mutex_lock (&g_once_mutex);
 662   g_once_init_list = g_slist_remove (g_once_init_list, (void*) value_location);
 663   g_cond_broadcast (&g_once_cond);
 664   g_mutex_unlock (&g_once_mutex);
 665 }
 666
 667 /* GThread {{{1 -------------------------------------------------------- */
 668
 669 static void
 670 g_thread_cleanup (gpointer data)
 671 {
 672   if (data)
 673     {
 674       GRealThread* thread = data;
 675
 676       /* We only free the thread structure if it isn't joinable.
 677        * If it is, the structure is freed in g_thread_join()
 678        */
 679       if (!thread->thread.joinable)
 680         {
 681           /* Just to make sure, this isn't used any more */
 682           g_system_thread_assign (thread->system_thread, zero_thread);
 683           g_free (thread);
 684         }
 685     }
 686 }
 687
 688 static gpointer
 689 g_thread_create_proxy (gpointer data)
 690 {
 691   GRealThread* thread = data;
 692
 693   g_assert (data);
 694
 695   if (thread->name)
 696     g_system_thread_set_name (thread->name);
 697
 698   /* This has to happen before G_LOCK, as that might call g_thread_self */
 699   g_private_set (&g_thread_specific_private, data);
 700
 701   if (thread->setup_func)
 702     thread->setup_func (thread);
 703
 704   /* The lock makes sure that thread->system_thread is written,
 705    * before thread->thread.func is called. See g_thread_new_internal().
 706    */
 707   G_LOCK (g_thread_new);
 708   G_UNLOCK (g_thread_new);
 709
 710   thread->retval = thread->thread.func (thread->thread.data);
 711
 712   return NULL;
 713 }
 714
 715 /**
 716  * g_thread_new:
 717  * @name: a name for the new thread
 718  * @func: a function to execute in the new thread
 719  * @data: an argument to supply to the new thread
 720  * @joinable: should this thread be joinable?
 721  * @error: return location for error
 722  *
 723  * This function creates a new thread. The new thread starts by invoking
 724  * @func with the argument data. The thread will run until @func returns
 725  * or until g_thread_exit() is called from the new thread.
 726  *
 727  * The @name can be useful for discriminating threads in
 728  * a debugger. Some systems restrict the length of @name to
 729  * 16 bytes.
 730  *
 731  * If @joinable is %TRUE, you can wait for this thread's termination
 732  * calling g_thread_join(). Resources for a joinable thread are not
 733  * fully released until g_thread_join() is called for that thread.
 734  * Otherwise the thread will just disappear when it terminates.
 735  *
 736  * @error can be %NULL to ignore errors, or non-%NULL to report errors.
 737  * The error is set, if and only if the function returns %NULL.
 738  *
 739  * Returns: the new #GThread, or %NULL if an error occurred
 740  *
 741  * Since: 2.32
 742  */
 743 GThread *
 744 g_thread_new (const gchar  *name,
 745               GThreadFunc   func,
 746               gpointer      data,
 747               gboolean      joinable,
 748               GError      **error)
 749 {
 750   return g_thread_new_internal (name, func, data, joinable, 0, FALSE, error);
 751 }
 752
 753 /**
 754  * g_thread_new_full:
 755  * @name: a name for the new thread
 756  * @func: a function to execute in the new thread
 757  * @data: an argument to supply to the new thread
 758  * @joinable: should this thread be joinable?
 759  * @stack_size: a stack size for the new thread
 760  * @error: return location for error
 761  *
 762  * This function creates a new thread. The new thread starts by
 763  * invoking @func with the argument data. The thread will run
 764  * until @func returns or until g_thread_exit() is called.
 765  *
 766  * The @name can be useful for discriminating threads in
 767  * a debugger. Some systems restrict the length of @name to
 768  * 16 bytes.
 769  *
 770  * If the underlying thread implementation supports it, the thread
 771  * gets a stack size of @stack_size or the default value for the
 772  * current platform, if @stack_size is 0. Note that you should only
 773  * use a non-zero @stack_size if you really can't use the default.
 774  * In most cases, using g_thread_new() (which doesn't take a
 775  * @stack_size) is better.
 776  *
 777  * If @joinable is %TRUE, you can wait for this thread's termination
 778  * calling g_thread_join(). Resources for a joinable thread are not
 779  * fully released until g_thread_join() is called for that thread.
 780  * Otherwise the thread will just disappear when it terminates.
 781  *
 782  * @error can be %NULL to ignore errors, or non-%NULL to report errors.
 783  * The error is set, if and only if the function returns %NULL.
 784  *
 785  * Returns: the new #GThread, or %NULL if an error occurred
 786  *
 787  * Since: 2.32
 788  */
 789 GThread *
 790 g_thread_new_full (const gchar  *name,
 791                    GThreadFunc   func,
 792                    gpointer      data,
 793                    gboolean      joinable,
 794                    gsize         stack_size,
 795                    GError      **error)
 796 {
 797   return g_thread_new_internal (name, func, data, joinable, stack_size, FALSE, error);
 798 }
 799
 800 GThread *
 801 g_thread_new_internal (const gchar   *name,
 802                        GThreadFunc    func,
 803                        gpointer       data,
 804                        gboolean       joinable,
 805                        gsize          stack_size,
 806                        GThreadSetup   setup_func,
 807                        GError       **error)
 808 {
 809   GRealThread *result;
 810   GError *local_error = NULL;
 811
 812   g_return_val_if_fail (func != NULL, NULL);
 813
 814   result = g_new0 (GRealThread, 1);
 815
 816   result->thread.joinable = joinable;
 817   result->thread.func = func;
 818   result->thread.data = data;
 819   result->setup_func = setup_func;
 820   result->name = name;
 821   G_LOCK (g_thread_new);
 822   g_system_thread_create (g_thread_create_proxy, result,
 823                           stack_size, joinable,
 824                           &result->system_thread, &local_error);
 825   G_UNLOCK (g_thread_new);
 826
 827   if (local_error)
 828     {
 829       g_propagate_error (error, local_error);
 830       g_free (result);
 831       return NULL;
 832     }
 833
 834   return (GThread*) result;
 835 }
 836
 837 /**
 838  * g_thread_exit:
 839  * @retval: the return value of this thread
 840  *
 841  * Terminates the current thread.
 842  *
 843  * If another thread is waiting for that thread using g_thread_join()
 844  * and the current thread is joinable, the waiting thread will be woken
 845  * up and get @retval as the return value of g_thread_join(). If the
 846  * current thread is not joinable, @retval is ignored.
 847  *
 848  * Calling <literal>g_thread_exit (retval)</literal> is equivalent to
 849  * returning @retval from the function @func, as given to g_thread_new().
 850  *
 851  * <note><para>Never call g_thread_exit() from within a thread of a
 852  * #GThreadPool, as that will mess up the bookkeeping and lead to funny
 853  * and unwanted results.</para></note>
 854  */
 855 void
 856 g_thread_exit (gpointer retval)
 857 {
 858   GRealThread* real = (GRealThread*) g_thread_self ();
 859   real->retval = retval;
 860
 861   g_system_thread_exit ();
 862 }
 863
 864 /**
 865  * g_thread_join:
 866  * @thread: a joinable #GThread
 867  *
 868  * Waits until @thread finishes, i.e. the function @func, as
 869  * given to g_thread_new(), returns or g_thread_exit() is called.
 870  * If @thread has already terminated, then g_thread_join()
 871  * returns immediately. @thread must be joinable.
 872  *
 873  * Any thread can wait for any other (joinable) thread by calling
 874  * g_thread_join(), not just its 'creator'. Calling g_thread_join()
 875  * from multiple threads for the same @thread leads to undefined
 876  * behaviour.
 877  *
 878  * The value returned by @func or given to g_thread_exit() is
 879  * returned by this function.
 880  *
 881  * All resources of @thread including the #GThread struct are
 882  * released before g_thread_join() returns.
 883  *
 884  * Returns: the return value of the thread
 885  */
 886 gpointer
 887 g_thread_join (GThread *thread)
 888 {
 889   GRealThread *real = (GRealThread*) thread;
 890   gpointer retval;
 891
 892   g_return_val_if_fail (thread, NULL);
 893   g_return_val_if_fail (thread->joinable, NULL);
 894   g_return_val_if_fail (!g_system_thread_equal (&real->system_thread, &zero_thread), NULL);
 895
 896   g_system_thread_join (&real->system_thread);
 897
 898   retval = real->retval;
 899
 900   /* Just to make sure, this isn't used any more */
 901   thread->joinable = 0;
 902   g_system_thread_assign (real->system_thread, zero_thread);
 903
 904   /* the thread structure for non-joinable threads is freed upon
 905    * thread end. We free the memory here. This will leave a loose end,
 906    * if a joinable thread is not joined.
 907    */
 908   g_free (thread);
 909
 910   return retval;
 911 }
 912
 913 /**
 914  * g_thread_self:
 915  *
 916  * This functions returns the #GThread corresponding to the
 917  * current thread.
 918  *
 919  * Returns: the #GThread representing the current thread
 920  */
 921 GThread*
 922 g_thread_self (void)
 923 {
 924   GRealThread* thread = g_private_get (&g_thread_specific_private);
 925
 926   if (!thread)
 927     {
 928       /* If no thread data is available, provide and set one.
 929        * This can happen for the main thread and for threads
 930        * that are not created by GLib.
 931        */
 932       thread = g_new0 (GRealThread, 1);
 933       thread->thread.joinable = FALSE; /* This is a safe guess */
 934       thread->thread.func = NULL;
 935       thread->thread.data = NULL;
 936
 937       g_system_thread_self (&thread->system_thread);
 938
 939       g_private_set (&g_thread_specific_private, thread);
 940     }
 941
 942   return (GThread*)thread;
 943 }
 944
 945 /* Epilogue {{{1 */
 946 /* vim: set foldmethod=marker: */