move 'Since:' tags down
[platform/upstream/glib.git] / 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 #ifdef HAVE_UNISTD_H
47 #include <unistd.h>
48 #endif
49
50 #ifndef G_OS_WIN32
51 #include <sys/time.h>
52 #include <time.h>
53 #else
54 #include <windows.h>
55 #endif /* G_OS_WIN32 */
56
57 #include <string.h>
58
59 #include "garray.h"
60 #include "gbitlock.h"
61 #include "gslist.h"
62 #include "gtestutils.h"
63 #include "gtimer.h"
64
65 /**
66  * SECTION:threads
67  * @title: Threads
68  * @short_description: thread abstraction; including threads, different
69  *                     mutexes, conditions and thread private data
70  * @see_also: #GThreadPool, #GAsyncQueue
71  *
72  * Threads act almost like processes, but unlike processes all threads
73  * of one process share the same memory. This is good, as it provides
74  * easy communication between the involved threads via this shared
75  * memory, and it is bad, because strange things (so called
76  * "Heisenbugs") might happen if the program is not carefully designed.
77  * In particular, due to the concurrent nature of threads, no
78  * assumptions on the order of execution of code running in different
79  * threads can be made, unless order is explicitly forced by the
80  * programmer through synchronization primitives.
81  *
82  * The aim of the thread related functions in GLib is to provide a
83  * portable means for writing multi-threaded software. There are
84  * primitives for mutexes to protect the access to portions of memory
85  * (#GMutex, #GStaticMutex, #G_LOCK_DEFINE, #GStaticRecMutex and
86  * #GStaticRWLock). There is a facility to use individual bits for
87  * locks (g_bit_lock()). There are primitives for condition variables to
88  * allow synchronization of threads (#GCond).  There are primitives for
89  * thread-private data - data that every thread has a private instance
90  * of (#GPrivate, #GStaticPrivate). There are facilities for one-time
91  * initialization (#GOnce, g_once_init_enter()). Last but definitely
92  * not least there are primitives to portably create and manage
93  * threads (#GThread).
94  *
95  * The threading system is initialized with g_thread_init(), which
96  * takes an optional custom thread implementation or %NULL for the
97  * default implementation. If you want to call g_thread_init() with a
98  * non-%NULL argument this must be done before executing any other GLib
99  * functions (except g_mem_set_vtable()). This is a requirement even if
100  * no threads are in fact ever created by the process.
101  *
102  * Calling g_thread_init() with a %NULL argument is somewhat more
103  * relaxed. You may call any other glib functions in the main thread
104  * before g_thread_init() as long as g_thread_init() is not called from
105  * a glib callback, or with any locks held. However, many libraries
106  * above glib does not support late initialization of threads, so doing
107  * this should be avoided if possible.
108  *
109  * Please note that since version 2.24 the GObject initialization
110  * function g_type_init() initializes threads (with a %NULL argument),
111  * so most applications, including those using Gtk+ will run with
112  * threads enabled. If you want a special thread implementation, make
113  * sure you call g_thread_init() before g_type_init() is called.
114  *
115  * After calling g_thread_init(), GLib is completely thread safe (all
116  * global data is automatically locked), but individual data structure
117  * instances are not automatically locked for performance reasons. So,
118  * for example you must coordinate accesses to the same #GHashTable
119  * from multiple threads.  The two notable exceptions from this rule
120  * are #GMainLoop and #GAsyncQueue, which <emphasis>are</emphasis>
121  * threadsafe and need no further application-level locking to be
122  * accessed from multiple threads.
123  *
124  * To help debugging problems in multithreaded applications, GLib
125  * supports error-checking mutexes that will give you helpful error
126  * messages on common problems. To use error-checking mutexes, define
127  * the symbol #G_ERRORCHECK_MUTEXES when compiling the application.
128  **/
129
130 /**
131  * G_THREADS_IMPL_POSIX:
132  *
133  * This macro is defined if POSIX style threads are used.
134  **/
135
136 /**
137  * G_THREADS_ENABLED:
138  *
139  * This macro is defined if GLib was compiled with thread support. This
140  * does not necessarily mean that there is a thread implementation
141  * available, but it does mean that the infrastructure is in place and
142  * that once you provide a thread implementation to g_thread_init(),
143  * GLib will be multi-thread safe. If #G_THREADS_ENABLED is not
144  * defined, then Glib is not, and cannot be, multi-thread safe.
145  **/
146
147 /**
148  * G_THREADS_IMPL_NONE:
149  *
150  * This macro is defined if no thread implementation is used. You can,
151  * however, provide one to g_thread_init() to make GLib multi-thread
152  * safe.
153  **/
154
155 /* G_LOCK Documentation {{{1 ---------------------------------------------- */
156
157 /* IMPLEMENTATION NOTE:
158  *
159  * G_LOCK_DEFINE and friends are convenience macros defined in
160  * gthread.h.  Their documentation lives here.
161  */
162
163 /**
164  * G_LOCK_DEFINE:
165  * @name: the name of the lock.
166  *
167  * The %G_LOCK_* macros provide a convenient interface to #GStaticMutex
168  * with the advantage that they will expand to nothing in programs
169  * compiled against a thread-disabled GLib, saving code and memory
170  * there. #G_LOCK_DEFINE defines a lock. It can appear anywhere
171  * variable definitions may appear in programs, i.e. in the first block
172  * of a function or outside of functions. The @name parameter will be
173  * mangled to get the name of the #GStaticMutex. This means that you
174  * can use names of existing variables as the parameter - e.g. the name
175  * of the variable you intent to protect with the lock. Look at our
176  * <function>give_me_next_number()</function> example using the
177  * %G_LOCK_* macros:
178  *
179  * <example>
180  *  <title>Using the %G_LOCK_* convenience macros</title>
181  *  <programlisting>
182  *   G_LOCK_DEFINE (current_number);
183  *
184  *   int
185  *   give_me_next_number (void)
186  *   {
187  *     static int current_number = 0;
188  *     int ret_val;
189  *
190  *     G_LOCK (current_number);
191  *     ret_val = current_number = calc_next_number (current_number);
192  *     G_UNLOCK (current_number);
193  *
194  *     return ret_val;
195  *   }
196  *  </programlisting>
197  * </example>
198  **/
199
200 /**
201  * G_LOCK_DEFINE_STATIC:
202  * @name: the name of the lock.
203  *
204  * This works like #G_LOCK_DEFINE, but it creates a static object.
205  **/
206
207 /**
208  * G_LOCK_EXTERN:
209  * @name: the name of the lock.
210  *
211  * This declares a lock, that is defined with #G_LOCK_DEFINE in another
212  * module.
213  **/
214
215 /**
216  * G_LOCK:
217  * @name: the name of the lock.
218  *
219  * Works like g_mutex_lock(), but for a lock defined with
220  * #G_LOCK_DEFINE.
221  **/
222
223 /**
224  * G_TRYLOCK:
225  * @name: the name of the lock.
226  * @Returns: %TRUE, if the lock could be locked.
227  *
228  * Works like g_mutex_trylock(), but for a lock defined with
229  * #G_LOCK_DEFINE.
230  **/
231
232 /**
233  * G_UNLOCK:
234  * @name: the name of the lock.
235  *
236  * Works like g_mutex_unlock(), but for a lock defined with
237  * #G_LOCK_DEFINE.
238  **/
239
240 /* GThreadError {{{1 ------------------------------------------------------- */
241 /**
242  * GThreadError:
243  * @G_THREAD_ERROR_AGAIN: a thread couldn't be created due to resource
244  *                        shortage. Try again later.
245  *
246  * Possible errors of thread related functions.
247  **/
248
249 /**
250  * G_THREAD_ERROR:
251  *
252  * The error domain of the GLib thread subsystem.
253  **/
254 GQuark
255 g_thread_error_quark (void)
256 {
257   return g_quark_from_static_string ("g_thread_error");
258 }
259
260 /* Miscellaneous Structures {{{1 ------------------------------------------ */
261 typedef struct _GRealThread GRealThread;
262 struct  _GRealThread
263 {
264   GThread thread;
265   /* Bit 0 protects private_data. To avoid deadlocks, do not block while
266    * holding this (particularly on the g_thread lock). */
267   volatile gint private_data_lock;
268   GArray *private_data;
269   GRealThread *next;
270   gpointer retval;
271   GSystemThread system_thread;
272 };
273
274 #define LOCK_PRIVATE_DATA(self)   g_bit_lock (&(self)->private_data_lock, 0)
275 #define UNLOCK_PRIVATE_DATA(self) g_bit_unlock (&(self)->private_data_lock, 0)
276
277 typedef struct _GStaticPrivateNode GStaticPrivateNode;
278 struct _GStaticPrivateNode
279 {
280   gpointer       data;
281   GDestroyNotify destroy;
282 };
283
284 static void    g_thread_cleanup (gpointer data);
285 static void    g_thread_fail (void);
286 static guint64 gettime (void);
287
288 guint64        (*g_thread_gettime) (void) = gettime;
289
290 /* Global Variables {{{1 -------------------------------------------------- */
291
292 static GSystemThread zero_thread; /* This is initialized to all zero */
293 gboolean g_thread_use_default_impl = TRUE;
294
295 /**
296  * g_thread_supported:
297  * @Returns: %TRUE, if the thread system is initialized.
298  *
299  * This function returns %TRUE if the thread system is initialized, and
300  * %FALSE if it is not.
301  *
302  * <note><para>This function is actually a macro. Apart from taking the
303  * address of it you can however use it as if it was a
304  * function.</para></note>
305  **/
306
307 /* IMPLEMENTATION NOTE:
308  *
309  * g_thread_supported() is just returns g_threads_got_initialized
310  */
311 gboolean g_threads_got_initialized = FALSE;
312
313
314 /* Thread Implementation Virtual Function Table {{{1 ---------------------- */
315 /* Virtual Function Table Documentation {{{2 ------------------------------ */
316 /**
317  * GThreadFunctions:
318  * @mutex_new: virtual function pointer for g_mutex_new()
319  * @mutex_lock: virtual function pointer for g_mutex_lock()
320  * @mutex_trylock: virtual function pointer for g_mutex_trylock()
321  * @mutex_unlock: virtual function pointer for g_mutex_unlock()
322  * @mutex_free: virtual function pointer for g_mutex_free()
323  * @cond_new: virtual function pointer for g_cond_new()
324  * @cond_signal: virtual function pointer for g_cond_signal()
325  * @cond_broadcast: virtual function pointer for g_cond_broadcast()
326  * @cond_wait: virtual function pointer for g_cond_wait()
327  * @cond_timed_wait: virtual function pointer for g_cond_timed_wait()
328  * @cond_free: virtual function pointer for g_cond_free()
329  * @private_new: virtual function pointer for g_private_new()
330  * @private_get: virtual function pointer for g_private_get()
331  * @private_set: virtual function pointer for g_private_set()
332  * @thread_create: virtual function pointer for g_thread_create()
333  * @thread_yield: virtual function pointer for g_thread_yield()
334  * @thread_join: virtual function pointer for g_thread_join()
335  * @thread_exit: virtual function pointer for g_thread_exit()
336  * @thread_set_priority: virtual function pointer for
337  *                       g_thread_set_priority()
338  * @thread_self: virtual function pointer for g_thread_self()
339  * @thread_equal: used internally by recursive mutex locks and by some
340  *                assertion checks
341  *
342  * This function table is used by g_thread_init() to initialize the
343  * thread system. The functions in the table are directly used by their
344  * g_* prepended counterparts (described in this document).  For
345  * example, if you call g_mutex_new() then mutex_new() from the table
346  * provided to g_thread_init() will be called.
347  *
348  * <note><para>Do not use this struct unless you know what you are
349  * doing.</para></note>
350  **/
351
352 /* IMPLEMENTATION NOTE:
353  *
354  * g_thread_functions_for_glib_use is a global symbol that gets used by
355  * most of the "primative" threading calls.  g_mutex_lock(), for
356  * example, is just a macro that calls the appropriate virtual function
357  * out of this table.
358  *
359  * For that reason, all of those macros are documented here.
360  */
361 GThreadFunctions g_thread_functions_for_glib_use = {
362 /* GMutex Virtual Functions {{{2 ------------------------------------------ */
363
364 /**
365  * GMutex:
366  *
367  * The #GMutex struct is an opaque data structure to represent a mutex
368  * (mutual exclusion). It can be used to protect data against shared
369  * access. Take for example the following function:
370  *
371  * <example>
372  *  <title>A function which will not work in a threaded environment</title>
373  *  <programlisting>
374  *   int
375  *   give_me_next_number (void)
376  *   {
377  *     static int current_number = 0;
378  *
379  *     /<!-- -->* now do a very complicated calculation to calculate the new
380  *      * number, this might for example be a random number generator
381  *      *<!-- -->/
382  *     current_number = calc_next_number (current_number);
383  *
384  *     return current_number;
385  *   }
386  *  </programlisting>
387  * </example>
388  *
389  * It is easy to see that this won't work in a multi-threaded
390  * application. There current_number must be protected against shared
391  * access. A first naive implementation would be:
392  *
393  * <example>
394  *  <title>The wrong way to write a thread-safe function</title>
395  *  <programlisting>
396  *   int
397  *   give_me_next_number (void)
398  *   {
399  *     static int current_number = 0;
400  *     int ret_val;
401  *     static GMutex * mutex = NULL;
402  *
403  *     if (!mutex) mutex = g_mutex_new (<!-- -->);
404  *
405  *     g_mutex_lock (mutex);
406  *     ret_val = current_number = calc_next_number (current_number);
407  *     g_mutex_unlock (mutex);
408  *
409  *     return ret_val;
410  *   }
411  *  </programlisting>
412  * </example>
413  *
414  * This looks like it would work, but there is a race condition while
415  * constructing the mutex and this code cannot work reliable. Please do
416  * not use such constructs in your own programs! One working solution
417  * is:
418  *
419  * <example>
420  *  <title>A correct thread-safe function</title>
421  *  <programlisting>
422  *   static GMutex *give_me_next_number_mutex = NULL;
423  *
424  *   /<!-- -->* this function must be called before any call to
425  *    * give_me_next_number(<!-- -->)
426  *    *
427  *    * it must be called exactly once.
428  *    *<!-- -->/
429  *   void
430  *   init_give_me_next_number (void)
431  *   {
432  *     g_assert (give_me_next_number_mutex == NULL);
433  *     give_me_next_number_mutex = g_mutex_new (<!-- -->);
434  *   }
435  *
436  *   int
437  *   give_me_next_number (void)
438  *   {
439  *     static int current_number = 0;
440  *     int ret_val;
441  *
442  *     g_mutex_lock (give_me_next_number_mutex);
443  *     ret_val = current_number = calc_next_number (current_number);
444  *     g_mutex_unlock (give_me_next_number_mutex);
445  *
446  *     return ret_val;
447  *   }
448  *  </programlisting>
449  * </example>
450  *
451  * #GStaticMutex provides a simpler and safer way of doing this.
452  *
453  * If you want to use a mutex, and your code should also work without
454  * calling g_thread_init() first, then you cannot use a #GMutex, as
455  * g_mutex_new() requires that the thread system be initialized. Use a
456  * #GStaticMutex instead.
457  *
458  * A #GMutex should only be accessed via the following functions.
459  *
460  * <note><para>All of the <function>g_mutex_*</function> functions are
461  * actually macros. Apart from taking their addresses, you can however
462  * use them as if they were functions.</para></note>
463  **/
464
465 /**
466  * g_mutex_new:
467  * @Returns: a new #GMutex.
468  *
469  * Creates a new #GMutex.
470  *
471  * <note><para>This function will abort if g_thread_init() has not been
472  * called yet.</para></note>
473  **/
474   (GMutex*(*)())g_thread_fail,
475
476 /**
477  * g_mutex_lock:
478  * @mutex: a #GMutex.
479  *
480  * Locks @mutex. If @mutex is already locked by another thread, the
481  * current thread will block until @mutex is unlocked by the other
482  * thread.
483  *
484  * This function can be used even if g_thread_init() has not yet been
485  * called, and, in that case, will do nothing.
486  *
487  * <note><para>#GMutex is neither guaranteed to be recursive nor to be
488  * non-recursive, i.e. a thread could deadlock while calling
489  * g_mutex_lock(), if it already has locked @mutex. Use
490  * #GStaticRecMutex, if you need recursive mutexes.</para></note>
491  **/
492   NULL,
493
494 /**
495  * g_mutex_trylock:
496  * @mutex: a #GMutex.
497  * @Returns: %TRUE, if @mutex could be locked.
498  *
499  * Tries to lock @mutex. If @mutex is already locked by another thread,
500  * it immediately returns %FALSE. Otherwise it locks @mutex and returns
501  * %TRUE.
502  *
503  * This function can be used even if g_thread_init() has not yet been
504  * called, and, in that case, will immediately return %TRUE.
505  *
506  * <note><para>#GMutex is neither guaranteed to be recursive nor to be
507  * non-recursive, i.e. the return value of g_mutex_trylock() could be
508  * both %FALSE or %TRUE, if the current thread already has locked
509  * @mutex. Use #GStaticRecMutex, if you need recursive
510  * mutexes.</para></note>
511  **/
512   NULL,
513
514 /**
515  * g_mutex_unlock:
516  * @mutex: a #GMutex.
517  *
518  * Unlocks @mutex. If another thread is blocked in a g_mutex_lock()
519  * call for @mutex, it will be woken and can lock @mutex itself.
520  *
521  * This function can be used even if g_thread_init() has not yet been
522  * called, and, in that case, will do nothing.
523  **/
524   NULL,
525
526 /**
527  * g_mutex_free:
528  * @mutex: a #GMutex.
529  *
530  * Destroys @mutex.
531  *
532  * <note><para>Calling g_mutex_free() on a locked mutex may result in
533  * undefined behaviour.</para></note>
534  **/
535   NULL,
536
537 /* GCond Virtual Functions {{{2 ------------------------------------------ */
538
539 /**
540  * GCond:
541  *
542  * The #GCond struct is an opaque data structure that represents a
543  * condition. Threads can block on a #GCond if they find a certain
544  * condition to be false. If other threads change the state of this
545  * condition they signal the #GCond, and that causes the waiting
546  * threads to be woken up.
547  *
548  * <example>
549  *  <title>
550  *   Using GCond to block a thread until a condition is satisfied
551  *  </title>
552  *  <programlisting>
553  *   GCond* data_cond = NULL; /<!-- -->* Must be initialized somewhere *<!-- -->/
554  *   GMutex* data_mutex = NULL; /<!-- -->* Must be initialized somewhere *<!-- -->/
555  *   gpointer current_data = NULL;
556  *
557  *   void
558  *   push_data (gpointer data)
559  *   {
560  *     g_mutex_lock (data_mutex);
561  *     current_data = data;
562  *     g_cond_signal (data_cond);
563  *     g_mutex_unlock (data_mutex);
564  *   }
565  *
566  *   gpointer
567  *   pop_data (void)
568  *   {
569  *     gpointer data;
570  *
571  *     g_mutex_lock (data_mutex);
572  *     while (!current_data)
573  *       g_cond_wait (data_cond, data_mutex);
574  *     data = current_data;
575  *     current_data = NULL;
576  *     g_mutex_unlock (data_mutex);
577  *
578  *     return data;
579  *   }
580  *  </programlisting>
581  * </example>
582  *
583  * Whenever a thread calls <function>pop_data()</function> now, it will
584  * wait until current_data is non-%NULL, i.e. until some other thread
585  * has called <function>push_data()</function>.
586  *
587  * <note><para>It is important to use the g_cond_wait() and
588  * g_cond_timed_wait() functions only inside a loop which checks for the
589  * condition to be true.  It is not guaranteed that the waiting thread
590  * will find the condition fulfilled after it wakes up, even if the
591  * signaling thread left the condition in that state: another thread may
592  * have altered the condition before the waiting thread got the chance
593  * to be woken up, even if the condition itself is protected by a
594  * #GMutex, like above.</para></note>
595  *
596  * A #GCond should only be accessed via the following functions.
597  *
598  * <note><para>All of the <function>g_cond_*</function> functions are
599  * actually macros. Apart from taking their addresses, you can however
600  * use them as if they were functions.</para></note>
601  **/
602
603 /**
604  * g_cond_new:
605  * @Returns: a new #GCond.
606  *
607  * Creates a new #GCond. This function will abort, if g_thread_init()
608  * has not been called yet.
609  **/
610   (GCond*(*)())g_thread_fail,
611
612 /**
613  * g_cond_signal:
614  * @cond: a #GCond.
615  *
616  * If threads are waiting for @cond, exactly one of them is woken up.
617  * It is good practice to hold the same lock as the waiting thread
618  * while calling this function, though not required.
619  *
620  * This function can be used even if g_thread_init() has not yet been
621  * called, and, in that case, will do nothing.
622  **/
623   NULL,
624
625 /**
626  * g_cond_broadcast:
627  * @cond: a #GCond.
628  *
629  * If threads are waiting for @cond, all of them are woken up. It is
630  * good practice to lock the same mutex as the waiting threads, while
631  * calling this function, though not required.
632  *
633  * This function can be used even if g_thread_init() has not yet been
634  * called, and, in that case, will do nothing.
635  **/
636   NULL,
637
638 /**
639  * g_cond_wait:
640  * @cond: a #GCond.
641  * @mutex: a #GMutex, that is currently locked.
642  *
643  * Waits until this thread is woken up on @cond. The @mutex is unlocked
644  * before falling asleep and locked again before resuming.
645  *
646  * This function can be used even if g_thread_init() has not yet been
647  * called, and, in that case, will immediately return.
648  **/
649   NULL,
650
651 /**
652  * g_cond_timed_wait:
653  * @cond: a #GCond.
654  * @mutex: a #GMutex that is currently locked.
655  * @abs_time: a #GTimeVal, determining the final time.
656  * @Returns: %TRUE if @cond was signalled, or %FALSE on timeout.
657  *
658  * Waits until this thread is woken up on @cond, but not longer than
659  * until the time specified by @abs_time. The @mutex is unlocked before
660  * falling asleep and locked again before resuming.
661  *
662  * If @abs_time is %NULL, g_cond_timed_wait() acts like g_cond_wait().
663  *
664  * This function can be used even if g_thread_init() has not yet been
665  * called, and, in that case, will immediately return %TRUE.
666  *
667  * To easily calculate @abs_time a combination of g_get_current_time()
668  * and g_time_val_add() can be used.
669  **/
670   NULL,
671
672 /**
673  * g_cond_free:
674  * @cond: a #GCond.
675  *
676  * Destroys the #GCond.
677  **/
678   NULL,
679
680 /* GPrivate Virtual Functions {{{2 --------------------------------------- */
681
682 /**
683  * GPrivate:
684  *
685  * <note><para>
686  * #GStaticPrivate is a better choice for most uses.
687  * </para></note>
688  *
689  * The #GPrivate struct is an opaque data structure to represent a
690  * thread private data key. Threads can thereby obtain and set a
691  * pointer which is private to the current thread. Take our
692  * <function>give_me_next_number(<!-- -->)</function> example from
693  * above.  Suppose we don't want <literal>current_number</literal> to be
694  * shared between the threads, but instead to be private to each thread.
695  * This can be done as follows:
696  *
697  * <example>
698  *  <title>Using GPrivate for per-thread data</title>
699  *  <programlisting>
700  *   GPrivate* current_number_key = NULL; /<!-- -->* Must be initialized somewhere
701  *                                           with g_private_new (g_free); *<!-- -->/
702  *
703  *   int
704  *   give_me_next_number (void)
705  *   {
706  *     int *current_number = g_private_get (current_number_key);
707  *
708  *     if (!current_number)
709  *       {
710  *         current_number = g_new (int, 1);
711  *         *current_number = 0;
712  *         g_private_set (current_number_key, current_number);
713  *       }
714  *
715  *     *current_number = calc_next_number (*current_number);
716  *
717  *     return *current_number;
718  *   }
719  *  </programlisting>
720  * </example>
721  *
722  * Here the pointer belonging to the key
723  * <literal>current_number_key</literal> is read. If it is %NULL, it has
724  * not been set yet. Then get memory for an integer value, assign this
725  * memory to the pointer and write the pointer back. Now we have an
726  * integer value that is private to the current thread.
727  *
728  * The #GPrivate struct should only be accessed via the following
729  * functions.
730  *
731  * <note><para>All of the <function>g_private_*</function> functions are
732  * actually macros. Apart from taking their addresses, you can however
733  * use them as if they were functions.</para></note>
734  **/
735
736 /**
737  * g_private_new:
738  * @destructor: a function to destroy the data keyed to #GPrivate when
739  *              a thread ends.
740  * @Returns: a new #GPrivate.
741  *
742  * Creates a new #GPrivate. If @destructor is non-%NULL, it is a
743  * pointer to a destructor function. Whenever a thread ends and the
744  * corresponding pointer keyed to this instance of #GPrivate is
745  * non-%NULL, the destructor is called with this pointer as the
746  * argument.
747  *
748  * <note><para>
749  * #GStaticPrivate is a better choice for most uses.
750  * </para></note>
751  *
752  * <note><para>@destructor is used quite differently from @notify in
753  * g_static_private_set().</para></note>
754  *
755  * <note><para>A #GPrivate cannot be freed. Reuse it instead, if you
756  * can, to avoid shortage, or use #GStaticPrivate.</para></note>
757  *
758  * <note><para>This function will abort if g_thread_init() has not been
759  * called yet.</para></note>
760  **/
761   (GPrivate*(*)(GDestroyNotify))g_thread_fail,
762
763 /**
764  * g_private_get:
765  * @private_key: a #GPrivate.
766  * @Returns: the corresponding pointer.
767  *
768  * Returns the pointer keyed to @private_key for the current thread. If
769  * g_private_set() hasn't been called for the current @private_key and
770  * thread yet, this pointer will be %NULL.
771  *
772  * This function can be used even if g_thread_init() has not yet been
773  * called, and, in that case, will return the value of @private_key
774  * casted to #gpointer. Note however, that private data set
775  * <emphasis>before</emphasis> g_thread_init() will
776  * <emphasis>not</emphasis> be retained <emphasis>after</emphasis> the
777  * call. Instead, %NULL will be returned in all threads directly after
778  * g_thread_init(), regardless of any g_private_set() calls issued
779  * before threading system intialization.
780  **/
781   NULL,
782
783 /**
784  * g_private_set:
785  * @private_key: a #GPrivate.
786  * @data: the new pointer.
787  *
788  * Sets the pointer keyed to @private_key for the current thread.
789  *
790  * This function can be used even if g_thread_init() has not yet been
791  * called, and, in that case, will set @private_key to @data casted to
792  * #GPrivate*. See g_private_get() for resulting caveats.
793  **/
794   NULL,
795
796 /* GThread Virtual Functions {{{2 ---------------------------------------- */
797 /**
798  * GThread:
799  *
800  * The #GThread struct represents a running thread. It has three public
801  * read-only members, but the underlying struct is bigger, so you must
802  * not copy this struct.
803  *
804  * <note><para>Resources for a joinable thread are not fully released
805  * until g_thread_join() is called for that thread.</para></note>
806  **/
807
808 /**
809  * GThreadFunc:
810  * @data: data passed to the thread.
811  * @Returns: the return value of the thread, which will be returned by
812  *           g_thread_join().
813  *
814  * Specifies the type of the @func functions passed to
815  * g_thread_create() or g_thread_create_full().
816  **/
817
818 /**
819  * GThreadPriority:
820  * @G_THREAD_PRIORITY_LOW: a priority lower than normal
821  * @G_THREAD_PRIORITY_NORMAL: the default priority
822  * @G_THREAD_PRIORITY_HIGH: a priority higher than normal
823  * @G_THREAD_PRIORITY_URGENT: the highest priority
824  *
825  * Specifies the priority of a thread.
826  *
827  * <note><para>It is not guaranteed that threads with different priorities
828  * really behave accordingly. On some systems (e.g. Linux) there are no
829  * thread priorities. On other systems (e.g. Solaris) there doesn't
830  * seem to be different scheduling for different priorities. All in all
831  * try to avoid being dependent on priorities.</para></note>
832  **/
833
834 /**
835  * g_thread_create:
836  * @func: a function to execute in the new thread.
837  * @data: an argument to supply to the new thread.
838  * @joinable: should this thread be joinable?
839  * @error: return location for error.
840  * @Returns: the new #GThread on success.
841  *
842  * This function creates a new thread with the default priority.
843  *
844  * If @joinable is %TRUE, you can wait for this threads termination
845  * calling g_thread_join(). Otherwise the thread will just disappear
846  * when it terminates.
847  *
848  * The new thread executes the function @func with the argument @data.
849  * If the thread was created successfully, it is returned.
850  *
851  * @error can be %NULL to ignore errors, or non-%NULL to report errors.
852  * The error is set, if and only if the function returns %NULL.
853  **/
854   (void(*)(GThreadFunc, gpointer, gulong,
855            gboolean, gboolean, GThreadPriority,
856            gpointer, GError**))g_thread_fail,
857
858 /**
859  * g_thread_yield:
860  *
861  * Gives way to other threads waiting to be scheduled.
862  *
863  * This function is often used as a method to make busy wait less evil.
864  * But in most cases you will encounter, there are better methods to do
865  * that. So in general you shouldn't use this function.
866  **/
867   NULL,
868
869   NULL,                                        /* thread_join */
870   NULL,                                        /* thread_exit */
871   NULL,                                        /* thread_set_priority */
872   NULL,                                        /* thread_self */
873   NULL                                         /* thread_equal */
874 };
875
876 /* Local Data {{{1 -------------------------------------------------------- */
877
878 static GMutex   *g_once_mutex = NULL;
879 static GCond    *g_once_cond = NULL;
880 static GPrivate *g_thread_specific_private = NULL;
881 static GRealThread *g_thread_all_threads = NULL;
882 static GSList   *g_thread_free_indices = NULL;
883 static GSList*   g_once_init_list = NULL;
884
885 G_LOCK_DEFINE_STATIC (g_thread);
886
887 /* Initialisation {{{1 ---------------------------------------------------- */
888
889 #ifdef G_THREADS_ENABLED
890 /**
891  * g_thread_init:
892  * @vtable: a function table of type #GThreadFunctions, that provides
893  *          the entry points to the thread system to be used.
894  *
895  * If you use GLib from more than one thread, you must initialize the
896  * thread system by calling g_thread_init(). Most of the time you will
897  * only have to call <literal>g_thread_init (NULL)</literal>.
898  *
899  * <note><para>Do not call g_thread_init() with a non-%NULL parameter unless
900  * you really know what you are doing.</para></note>
901  *
902  * <note><para>g_thread_init() must not be called directly or indirectly as a
903  * callback from GLib. Also no mutexes may be currently locked while
904  * calling g_thread_init().</para></note>
905  *
906  * <note><para>g_thread_init() changes the way in which #GTimer measures
907  * elapsed time. As a consequence, timers that are running while
908  * g_thread_init() is called may report unreliable times.</para></note>
909  *
910  * Calling g_thread_init() multiple times is allowed (since version
911  * 2.24), but nothing happens except for the first call. If the
912  * argument is non-%NULL on such a call a warning will be printed, but
913  * otherwise the argument is ignored.
914  *
915  * If no thread system is available and @vtable is %NULL or if not all
916  * elements of @vtable are non-%NULL, then g_thread_init() will abort.
917  *
918  * <note><para>To use g_thread_init() in your program, you have to link with
919  * the libraries that the command <command>pkg-config --libs
920  * gthread-2.0</command> outputs. This is not the case for all the
921  * other thread related functions of GLib. Those can be used without
922  * having to link with the thread libraries.</para></note>
923  **/
924
925 /* This must be called only once, before any threads are created.
926  * It will only be called from g_thread_init() in -lgthread.
927  */
928 void
929 g_thread_init_glib (void)
930 {
931   /* We let the main thread (the one that calls g_thread_init) inherit
932    * the static_private data set before calling g_thread_init
933    */
934   GRealThread* main_thread = (GRealThread*) g_thread_self ();
935
936   /* mutex and cond creation works without g_threads_got_initialized */
937   g_once_mutex = g_mutex_new ();
938   g_once_cond = g_cond_new ();
939
940   /* we may only create mutex and cond in here */
941   _g_mem_thread_init_noprivate_nomessage ();
942
943   /* setup the basic threading system */
944   g_threads_got_initialized = TRUE;
945   g_thread_specific_private = g_private_new (g_thread_cleanup);
946   g_private_set (g_thread_specific_private, main_thread);
947   G_THREAD_UF (thread_self, (&main_thread->system_thread));
948
949   /* complete memory system initialization, g_private_*() works now */
950   _g_slice_thread_init_nomessage ();
951
952   /* accomplish log system initialization to enable messaging */
953   _g_messages_thread_init_nomessage ();
954
955   /* we may run full-fledged initializers from here */
956   _g_convert_thread_init ();
957   _g_rand_thread_init ();
958   _g_main_thread_init ();
959   _g_utils_thread_init ();
960   _g_futex_thread_init ();
961 #ifdef G_OS_WIN32
962   _g_win32_thread_init ();
963 #endif
964 }
965 #endif /* G_THREADS_ENABLED */
966
967 /* The following sections implement: GOnce, GStaticMutex, GStaticRecMutex,
968  * GStaticPrivate, 
969  **/
970
971 /* GOnce {{{1 ------------------------------------------------------------- */
972
973 /**
974  * GOnce:
975  * @status: the status of the #GOnce
976  * @retval: the value returned by the call to the function, if @status
977  *          is %G_ONCE_STATUS_READY
978  *
979  * A #GOnce struct controls a one-time initialization function. Any
980  * one-time initialization function must have its own unique #GOnce
981  * struct.
982  *
983  * Since: 2.4
984  **/
985
986 /**
987  * G_ONCE_INIT:
988  *
989  * A #GOnce must be initialized with this macro before it can be used.
990  *
991  * <informalexample>
992  *  <programlisting>
993  *   GOnce my_once = G_ONCE_INIT;
994  *  </programlisting>
995  * </informalexample>
996  *
997  * Since: 2.4
998  **/
999
1000 /**
1001  * GOnceStatus:
1002  * @G_ONCE_STATUS_NOTCALLED: the function has not been called yet.
1003  * @G_ONCE_STATUS_PROGRESS: the function call is currently in progress.
1004  * @G_ONCE_STATUS_READY: the function has been called.
1005  *
1006  * The possible statuses of a one-time initialization function
1007  * controlled by a #GOnce struct.
1008  *
1009  * Since: 2.4
1010  **/
1011
1012 /**
1013  * g_once:
1014  * @once: a #GOnce structure
1015  * @func: the #GThreadFunc function associated to @once. This function
1016  *        is called only once, regardless of the number of times it and
1017  *        its associated #GOnce struct are passed to g_once().
1018  * @arg: data to be passed to @func
1019  *
1020  * The first call to this routine by a process with a given #GOnce
1021  * struct calls @func with the given argument. Thereafter, subsequent
1022  * calls to g_once()  with the same #GOnce struct do not call @func
1023  * again, but return the stored result of the first call. On return
1024  * from g_once(), the status of @once will be %G_ONCE_STATUS_READY.
1025  *
1026  * For example, a mutex or a thread-specific data key must be created
1027  * exactly once. In a threaded environment, calling g_once() ensures
1028  * that the initialization is serialized across multiple threads.
1029  *
1030  * <note><para>Calling g_once() recursively on the same #GOnce struct in
1031  * @func will lead to a deadlock.</para></note>
1032  *
1033  * <informalexample>
1034  *  <programlisting>
1035  *   gpointer
1036  *   get_debug_flags (void)
1037  *   {
1038  *     static GOnce my_once = G_ONCE_INIT;
1039  *
1040  *     g_once (&my_once, parse_debug_flags, NULL);
1041  *
1042  *     return my_once.retval;
1043  *   }
1044  *  </programlisting>
1045  * </informalexample>
1046  *
1047  * Since: 2.4
1048  **/
1049 gpointer
1050 g_once_impl (GOnce       *once,
1051              GThreadFunc  func,
1052              gpointer     arg)
1053 {
1054   g_mutex_lock (g_once_mutex);
1055
1056   while (once->status == G_ONCE_STATUS_PROGRESS)
1057     g_cond_wait (g_once_cond, g_once_mutex);
1058
1059   if (once->status != G_ONCE_STATUS_READY)
1060     {
1061       once->status = G_ONCE_STATUS_PROGRESS;
1062       g_mutex_unlock (g_once_mutex);
1063
1064       once->retval = func (arg);
1065
1066       g_mutex_lock (g_once_mutex);
1067       once->status = G_ONCE_STATUS_READY;
1068       g_cond_broadcast (g_once_cond);
1069     }
1070
1071   g_mutex_unlock (g_once_mutex);
1072
1073   return once->retval;
1074 }
1075
1076 /**
1077  * g_once_init_enter:
1078  * @value_location: location of a static initializable variable
1079  *                  containing 0.
1080  * @Returns: %TRUE if the initialization section should be entered,
1081  *           %FALSE and blocks otherwise
1082  *
1083  * Function to be called when starting a critical initialization
1084  * section. The argument @value_location must point to a static
1085  * 0-initialized variable that will be set to a value other than 0 at
1086  * the end of the initialization section. In combination with
1087  * g_once_init_leave() and the unique address @value_location, it can
1088  * be ensured that an initialization section will be executed only once
1089  * during a program's life time, and that concurrent threads are
1090  * blocked until initialization completed. To be used in constructs
1091  * like this:
1092  *
1093  * <informalexample>
1094  *  <programlisting>
1095  *   static gsize initialization_value = 0;
1096  *
1097  *   if (g_once_init_enter (&amp;initialization_value))
1098  *     {
1099  *       gsize setup_value = 42; /<!-- -->* initialization code here *<!-- -->/
1100  *
1101  *       g_once_init_leave (&amp;initialization_value, setup_value);
1102  *     }
1103  *
1104  *   /<!-- -->* use initialization_value here *<!-- -->/
1105  *  </programlisting>
1106  * </informalexample>
1107  *
1108  * Since: 2.14
1109  **/
1110 gboolean
1111 g_once_init_enter_impl (volatile gsize *value_location)
1112 {
1113   gboolean need_init = FALSE;
1114   g_mutex_lock (g_once_mutex);
1115   if (g_atomic_pointer_get (value_location) == NULL)
1116     {
1117       if (!g_slist_find (g_once_init_list, (void*) value_location))
1118         {
1119           need_init = TRUE;
1120           g_once_init_list = g_slist_prepend (g_once_init_list, (void*) value_location);
1121         }
1122       else
1123         do
1124           g_cond_wait (g_once_cond, g_once_mutex);
1125         while (g_slist_find (g_once_init_list, (void*) value_location));
1126     }
1127   g_mutex_unlock (g_once_mutex);
1128   return need_init;
1129 }
1130
1131 /**
1132  * g_once_init_leave:
1133  * @value_location: location of a static initializable variable
1134  *                  containing 0.
1135  * @initialization_value: new non-0 value for *@value_location.
1136  *
1137  * Counterpart to g_once_init_enter(). Expects a location of a static
1138  * 0-initialized initialization variable, and an initialization value
1139  * other than 0. Sets the variable to the initialization value, and
1140  * releases concurrent threads blocking in g_once_init_enter() on this
1141  * initialization variable.
1142  *
1143  * Since: 2.14
1144  **/
1145 void
1146 g_once_init_leave (volatile gsize *value_location,
1147                    gsize           initialization_value)
1148 {
1149   g_return_if_fail (g_atomic_pointer_get (value_location) == NULL);
1150   g_return_if_fail (initialization_value != 0);
1151   g_return_if_fail (g_once_init_list != NULL);
1152
1153   g_atomic_pointer_set (value_location, initialization_value);
1154   g_mutex_lock (g_once_mutex);
1155   g_once_init_list = g_slist_remove (g_once_init_list, (void*) value_location);
1156   g_cond_broadcast (g_once_cond);
1157   g_mutex_unlock (g_once_mutex);
1158 }
1159
1160 /* GStaticMutex {{{1 ------------------------------------------------------ */
1161
1162 /**
1163  * GStaticMutex:
1164  *
1165  * A #GStaticMutex works like a #GMutex, but it has one significant
1166  * advantage. It doesn't need to be created at run-time like a #GMutex,
1167  * but can be defined at compile-time. Here is a shorter, easier and
1168  * safer version of our <function>give_me_next_number()</function>
1169  * example:
1170  *
1171  * <example>
1172  *  <title>
1173  *   Using <structname>GStaticMutex</structname>
1174  *   to simplify thread-safe programming
1175  *  </title>
1176  *  <programlisting>
1177  *   int
1178  *   give_me_next_number (void)
1179  *   {
1180  *     static int current_number = 0;
1181  *     int ret_val;
1182  *     static GStaticMutex mutex = G_STATIC_MUTEX_INIT;
1183  *
1184  *     g_static_mutex_lock (&amp;mutex);
1185  *     ret_val = current_number = calc_next_number (current_number);
1186  *     g_static_mutex_unlock (&amp;mutex);
1187  *
1188  *     return ret_val;
1189  *   }
1190  *  </programlisting>
1191  * </example>
1192  *
1193  * Sometimes you would like to dynamically create a mutex. If you don't
1194  * want to require prior calling to g_thread_init(), because your code
1195  * should also be usable in non-threaded programs, you are not able to
1196  * use g_mutex_new() and thus #GMutex, as that requires a prior call to
1197  * g_thread_init(). In theses cases you can also use a #GStaticMutex.
1198  * It must be initialized with g_static_mutex_init() before using it
1199  * and freed with with g_static_mutex_free() when not needed anymore to
1200  * free up any allocated resources.
1201  *
1202  * Even though #GStaticMutex is not opaque, it should only be used with
1203  * the following functions, as it is defined differently on different
1204  * platforms.
1205  *
1206  * All of the <function>g_static_mutex_*</function> functions apart
1207  * from <function>g_static_mutex_get_mutex</function> can also be used
1208  * even if g_thread_init() has not yet been called. Then they do
1209  * nothing, apart from <function>g_static_mutex_trylock</function>,
1210  * which does nothing but returning %TRUE.
1211  *
1212  * <note><para>All of the <function>g_static_mutex_*</function>
1213  * functions are actually macros. Apart from taking their addresses, you
1214  * can however use them as if they were functions.</para></note>
1215  **/
1216
1217 /**
1218  * G_STATIC_MUTEX_INIT:
1219  *
1220  * A #GStaticMutex must be initialized with this macro, before it can
1221  * be used. This macro can used be to initialize a variable, but it
1222  * cannot be assigned to a variable. In that case you have to use
1223  * g_static_mutex_init().
1224  *
1225  * <informalexample>
1226  *  <programlisting>
1227  *   GStaticMutex my_mutex = G_STATIC_MUTEX_INIT;
1228  *  </programlisting>
1229  * </informalexample>
1230  **/
1231
1232 /**
1233  * g_static_mutex_init:
1234  * @mutex: a #GStaticMutex to be initialized.
1235  *
1236  * Initializes @mutex. Alternatively you can initialize it with
1237  * #G_STATIC_MUTEX_INIT.
1238  **/
1239 void
1240 g_static_mutex_init (GStaticMutex *mutex)
1241 {
1242   static const GStaticMutex init_mutex = G_STATIC_MUTEX_INIT;
1243
1244   g_return_if_fail (mutex);
1245
1246   *mutex = init_mutex;
1247 }
1248
1249 /* IMPLEMENTATION NOTE:
1250  *
1251  * On some platforms a GStaticMutex is actually a normal GMutex stored
1252  * inside of a structure instead of being allocated dynamically.  We can
1253  * only do this for platforms on which we know, in advance, how to
1254  * allocate (size) and initialise (value) that memory.
1255  *
1256  * On other platforms, a GStaticMutex is nothing more than a pointer to
1257  * a GMutex.  In that case, the first access we make to the static mutex
1258  * must first allocate the normal GMutex and store it into the pointer.
1259  *
1260  * configure.ac writes macros into glibconfig.h to determine if
1261  * g_static_mutex_get_mutex() accesses the sturcture in memory directly
1262  * (on platforms where we are able to do that) or if it ends up here,
1263  * where we may have to allocate the GMutex before returning it.
1264  */
1265
1266 /**
1267  * g_static_mutex_get_mutex:
1268  * @mutex: a #GStaticMutex.
1269  * @Returns: the #GMutex corresponding to @mutex.
1270  *
1271  * For some operations (like g_cond_wait()) you must have a #GMutex
1272  * instead of a #GStaticMutex. This function will return the
1273  * corresponding #GMutex for @mutex.
1274  **/
1275 GMutex *
1276 g_static_mutex_get_mutex_impl (GMutex** mutex)
1277 {
1278   GMutex *result;
1279
1280   if (!g_thread_supported ())
1281     return NULL;
1282
1283   result = g_atomic_pointer_get (mutex);
1284
1285   if (!result)
1286     {
1287       g_assert (g_once_mutex);
1288
1289       g_mutex_lock (g_once_mutex);
1290
1291       result = *mutex;
1292       if (!result)
1293         {
1294           result = g_mutex_new ();
1295           g_atomic_pointer_set (mutex, result);
1296         }
1297
1298       g_mutex_unlock (g_once_mutex);
1299     }
1300
1301   return result;
1302 }
1303
1304 /* IMPLEMENTATION NOTE:
1305  *
1306  * g_static_mutex_lock(), g_static_mutex_trylock() and
1307  * g_static_mutex_unlock() are all preprocessor macros that wrap the
1308  * corresponding g_mutex_*() function around a call to
1309  * g_static_mutex_get_mutex().
1310  */
1311
1312 /**
1313  * g_static_mutex_lock:
1314  * @mutex: a #GStaticMutex.
1315  *
1316  * Works like g_mutex_lock(), but for a #GStaticMutex.
1317  **/
1318
1319 /**
1320  * g_static_mutex_trylock:
1321  * @mutex: a #GStaticMutex.
1322  * @Returns: %TRUE, if the #GStaticMutex could be locked.
1323  *
1324  * Works like g_mutex_trylock(), but for a #GStaticMutex.
1325  **/
1326
1327 /**
1328  * g_static_mutex_unlock:
1329  * @mutex: a #GStaticMutex.
1330  *
1331  * Works like g_mutex_unlock(), but for a #GStaticMutex.
1332  **/
1333
1334 /**
1335  * g_static_mutex_free:
1336  * @mutex: a #GStaticMutex to be freed.
1337  *
1338  * Releases all resources allocated to @mutex.
1339  *
1340  * You don't have to call this functions for a #GStaticMutex with an
1341  * unbounded lifetime, i.e. objects declared 'static', but if you have
1342  * a #GStaticMutex as a member of a structure and the structure is
1343  * freed, you should also free the #GStaticMutex.
1344  *
1345  * <note><para>Calling g_static_mutex_free() on a locked mutex may
1346  * result in undefined behaviour.</para></note>
1347  **/
1348 void
1349 g_static_mutex_free (GStaticMutex* mutex)
1350 {
1351   GMutex **runtime_mutex;
1352
1353   g_return_if_fail (mutex);
1354
1355   /* The runtime_mutex is the first (or only) member of GStaticMutex,
1356    * see both versions (of glibconfig.h) in configure.ac. Note, that
1357    * this variable is NULL, if g_thread_init() hasn't been called or
1358    * if we're using the default thread implementation and it provides
1359    * static mutexes. */
1360   runtime_mutex = ((GMutex**)mutex);
1361
1362   if (*runtime_mutex)
1363     g_mutex_free (*runtime_mutex);
1364
1365   *runtime_mutex = NULL;
1366 }
1367
1368 /* ------------------------------------------------------------------------ */
1369
1370 /**
1371  * GStaticRecMutex:
1372  *
1373  * A #GStaticRecMutex works like a #GStaticMutex, but it can be locked
1374  * multiple times by one thread. If you enter it n times, you have to
1375  * unlock it n times again to let other threads lock it. An exception
1376  * is the function g_static_rec_mutex_unlock_full(): that allows you to
1377  * unlock a #GStaticRecMutex completely returning the depth, (i.e. the
1378  * number of times this mutex was locked). The depth can later be used
1379  * to restore the state of the #GStaticRecMutex by calling
1380  * g_static_rec_mutex_lock_full().
1381  *
1382  * Even though #GStaticRecMutex is not opaque, it should only be used
1383  * with the following functions.
1384  *
1385  * All of the <function>g_static_rec_mutex_*</function> functions can
1386  * be used even if g_thread_init() has not been called. Then they do
1387  * nothing, apart from <function>g_static_rec_mutex_trylock</function>,
1388  * which does nothing but returning %TRUE.
1389  **/
1390
1391 /**
1392  * G_STATIC_REC_MUTEX_INIT:
1393  *
1394  * A #GStaticRecMutex must be initialized with this macro before it can
1395  * be used. This macro can used be to initialize a variable, but it
1396  * cannot be assigned to a variable. In that case you have to use
1397  * g_static_rec_mutex_init().
1398  *
1399  * <informalexample>
1400  *  <programlisting>
1401  *   GStaticRecMutex my_mutex = G_STATIC_REC_MUTEX_INIT;
1402  * </programlisting>
1403  </informalexample>
1404  **/
1405
1406 /**
1407  * g_static_rec_mutex_init:
1408  * @mutex: a #GStaticRecMutex to be initialized.
1409  *
1410  * A #GStaticRecMutex must be initialized with this function before it
1411  * can be used. Alternatively you can initialize it with
1412  * #G_STATIC_REC_MUTEX_INIT.
1413  **/
1414 void
1415 g_static_rec_mutex_init (GStaticRecMutex *mutex)
1416 {
1417   static const GStaticRecMutex init_mutex = G_STATIC_REC_MUTEX_INIT;
1418
1419   g_return_if_fail (mutex);
1420
1421   *mutex = init_mutex;
1422 }
1423
1424 /**
1425  * g_static_rec_mutex_lock:
1426  * @mutex: a #GStaticRecMutex to lock.
1427  *
1428  * Locks @mutex. If @mutex is already locked by another thread, the
1429  * current thread will block until @mutex is unlocked by the other
1430  * thread. If @mutex is already locked by the calling thread, this
1431  * functions increases the depth of @mutex and returns immediately.
1432  **/
1433 void
1434 g_static_rec_mutex_lock (GStaticRecMutex* mutex)
1435 {
1436   GSystemThread self;
1437
1438   g_return_if_fail (mutex);
1439
1440   if (!g_thread_supported ())
1441     return;
1442
1443   G_THREAD_UF (thread_self, (&self));
1444
1445   if (g_system_thread_equal (self, mutex->owner))
1446     {
1447       mutex->depth++;
1448       return;
1449     }
1450   g_static_mutex_lock (&mutex->mutex);
1451   g_system_thread_assign (mutex->owner, self);
1452   mutex->depth = 1;
1453 }
1454
1455 /**
1456  * g_static_rec_mutex_trylock:
1457  * @mutex: a #GStaticRecMutex to lock.
1458  * @Returns: %TRUE, if @mutex could be locked.
1459  *
1460  * Tries to lock @mutex. If @mutex is already locked by another thread,
1461  * it immediately returns %FALSE. Otherwise it locks @mutex and returns
1462  * %TRUE. If @mutex is already locked by the calling thread, this
1463  * functions increases the depth of @mutex and immediately returns
1464  * %TRUE.
1465  **/
1466 gboolean
1467 g_static_rec_mutex_trylock (GStaticRecMutex* mutex)
1468 {
1469   GSystemThread self;
1470
1471   g_return_val_if_fail (mutex, FALSE);
1472
1473   if (!g_thread_supported ())
1474     return TRUE;
1475
1476   G_THREAD_UF (thread_self, (&self));
1477
1478   if (g_system_thread_equal (self, mutex->owner))
1479     {
1480       mutex->depth++;
1481       return TRUE;
1482     }
1483
1484   if (!g_static_mutex_trylock (&mutex->mutex))
1485     return FALSE;
1486
1487   g_system_thread_assign (mutex->owner, self);
1488   mutex->depth = 1;
1489   return TRUE;
1490 }
1491
1492 /**
1493  * g_static_rec_mutex_unlock:
1494  * @mutex: a #GStaticRecMutex to unlock.
1495  *
1496  * Unlocks @mutex. Another thread will be allowed to lock @mutex only
1497  * when it has been unlocked as many times as it had been locked
1498  * before. If @mutex is completely unlocked and another thread is
1499  * blocked in a g_static_rec_mutex_lock() call for @mutex, it will be
1500  * woken and can lock @mutex itself.
1501  **/
1502 void
1503 g_static_rec_mutex_unlock (GStaticRecMutex* mutex)
1504 {
1505   g_return_if_fail (mutex);
1506
1507   if (!g_thread_supported ())
1508     return;
1509
1510   if (mutex->depth > 1)
1511     {
1512       mutex->depth--;
1513       return;
1514     }
1515   g_system_thread_assign (mutex->owner, zero_thread);
1516   g_static_mutex_unlock (&mutex->mutex);
1517 }
1518
1519 /**
1520  * g_static_rec_mutex_lock_full:
1521  * @mutex: a #GStaticRecMutex to lock.
1522  * @depth: number of times this mutex has to be unlocked to be
1523  *         completely unlocked.
1524  *
1525  * Works like calling g_static_rec_mutex_lock() for @mutex @depth times.
1526  **/
1527 void
1528 g_static_rec_mutex_lock_full   (GStaticRecMutex *mutex,
1529                                 guint            depth)
1530 {
1531   GSystemThread self;
1532   g_return_if_fail (mutex);
1533
1534   if (!g_thread_supported ())
1535     return;
1536
1537   if (depth == 0)
1538     return;
1539
1540   G_THREAD_UF (thread_self, (&self));
1541
1542   if (g_system_thread_equal (self, mutex->owner))
1543     {
1544       mutex->depth += depth;
1545       return;
1546     }
1547   g_static_mutex_lock (&mutex->mutex);
1548   g_system_thread_assign (mutex->owner, self);
1549   mutex->depth = depth;
1550 }
1551
1552 /**
1553  * g_static_rec_mutex_unlock_full:
1554  * @mutex: a #GStaticRecMutex to completely unlock.
1555  * @Returns: number of times @mutex has been locked by the current
1556  *           thread.
1557  *
1558  * Completely unlocks @mutex. If another thread is blocked in a
1559  * g_static_rec_mutex_lock() call for @mutex, it will be woken and can
1560  * lock @mutex itself. This function returns the number of times that
1561  * @mutex has been locked by the current thread. To restore the state
1562  * before the call to g_static_rec_mutex_unlock_full() you can call
1563  * g_static_rec_mutex_lock_full() with the depth returned by this
1564  * function.
1565  **/
1566 guint
1567 g_static_rec_mutex_unlock_full (GStaticRecMutex *mutex)
1568 {
1569   guint depth;
1570
1571   g_return_val_if_fail (mutex, 0);
1572
1573   if (!g_thread_supported ())
1574     return 1;
1575
1576   depth = mutex->depth;
1577
1578   g_system_thread_assign (mutex->owner, zero_thread);
1579   mutex->depth = 0;
1580   g_static_mutex_unlock (&mutex->mutex);
1581
1582   return depth;
1583 }
1584
1585 /**
1586  * g_static_rec_mutex_free:
1587  * @mutex: a #GStaticRecMutex to be freed.
1588  *
1589  * Releases all resources allocated to a #GStaticRecMutex.
1590  *
1591  * You don't have to call this functions for a #GStaticRecMutex with an
1592  * unbounded lifetime, i.e. objects declared 'static', but if you have
1593  * a #GStaticRecMutex as a member of a structure and the structure is
1594  * freed, you should also free the #GStaticRecMutex.
1595  **/
1596 void
1597 g_static_rec_mutex_free (GStaticRecMutex *mutex)
1598 {
1599   g_return_if_fail (mutex);
1600
1601   g_static_mutex_free (&mutex->mutex);
1602 }
1603
1604 /* GStaticPrivate {{{1 ---------------------------------------------------- */
1605
1606 /**
1607  * GStaticPrivate:
1608  *
1609  * A #GStaticPrivate works almost like a #GPrivate, but it has one
1610  * significant advantage. It doesn't need to be created at run-time
1611  * like a #GPrivate, but can be defined at compile-time. This is
1612  * similar to the difference between #GMutex and #GStaticMutex. Now
1613  * look at our <function>give_me_next_number()</function> example with
1614  * #GStaticPrivate:
1615  *
1616  * <example>
1617  *  <title>Using GStaticPrivate for per-thread data</title>
1618  *  <programlisting>
1619  *   int
1620  *   give_me_next_number (<!-- -->)
1621  *   {
1622  *     static GStaticPrivate current_number_key = G_STATIC_PRIVATE_INIT;
1623  *     int *current_number = g_static_private_get (&amp;current_number_key);
1624  *
1625  *     if (!current_number)
1626  *       {
1627  *         current_number = g_new (int,1);
1628  *         *current_number = 0;
1629  *         g_static_private_set (&amp;current_number_key, current_number, g_free);
1630  *       }
1631  *
1632  *     *current_number = calc_next_number (*current_number);
1633  *
1634  *     return *current_number;
1635  *   }
1636  *  </programlisting>
1637  * </example>
1638  **/
1639
1640 /**
1641  * G_STATIC_PRIVATE_INIT:
1642  *
1643  * Every #GStaticPrivate must be initialized with this macro, before it
1644  * can be used.
1645  *
1646  * <informalexample>
1647  *  <programlisting>
1648  *   GStaticPrivate my_private = G_STATIC_PRIVATE_INIT;
1649  *  </programlisting>
1650  * </informalexample>
1651  **/
1652
1653 /**
1654  * g_static_private_init:
1655  * @private_key: a #GStaticPrivate to be initialized.
1656  *
1657  * Initializes @private_key. Alternatively you can initialize it with
1658  * #G_STATIC_PRIVATE_INIT.
1659  **/
1660 void
1661 g_static_private_init (GStaticPrivate *private_key)
1662 {
1663   private_key->index = 0;
1664 }
1665
1666 /**
1667  * g_static_private_get:
1668  * @private_key: a #GStaticPrivate.
1669  * @Returns: the corresponding pointer.
1670  *
1671  * Works like g_private_get() only for a #GStaticPrivate.
1672  *
1673  * This function works even if g_thread_init() has not yet been called.
1674  **/
1675 gpointer
1676 g_static_private_get (GStaticPrivate *private_key)
1677 {
1678   GRealThread *self = (GRealThread*) g_thread_self ();
1679   GArray *array;
1680   gpointer ret = NULL;
1681
1682   LOCK_PRIVATE_DATA (self);
1683
1684   array = self->private_data;
1685
1686   if (array && private_key->index != 0 && private_key->index <= array->len)
1687     ret = g_array_index (array, GStaticPrivateNode,
1688                          private_key->index - 1).data;
1689
1690   UNLOCK_PRIVATE_DATA (self);
1691   return ret;
1692 }
1693
1694 /**
1695  * g_static_private_set:
1696  * @private_key: a #GStaticPrivate.
1697  * @data: the new pointer.
1698  * @notify: a function to be called with the pointer whenever the
1699  *          current thread ends or sets this pointer again.
1700  *
1701  * Sets the pointer keyed to @private_key for the current thread and
1702  * the function @notify to be called with that pointer (%NULL or
1703  * non-%NULL), whenever the pointer is set again or whenever the
1704  * current thread ends.
1705  *
1706  * This function works even if g_thread_init() has not yet been called.
1707  * If g_thread_init() is called later, the @data keyed to @private_key
1708  * will be inherited only by the main thread, i.e. the one that called
1709  * g_thread_init().
1710  *
1711  * <note><para>@notify is used quite differently from @destructor in
1712  * g_private_new().</para></note>
1713  **/
1714 void
1715 g_static_private_set (GStaticPrivate *private_key,
1716                       gpointer        data,
1717                       GDestroyNotify  notify)
1718 {
1719   GRealThread *self = (GRealThread*) g_thread_self ();
1720   GArray *array;
1721   static guint next_index = 0;
1722   GStaticPrivateNode *node;
1723   gpointer ddata = NULL;
1724   GDestroyNotify ddestroy = NULL;
1725
1726   if (!private_key->index)
1727     {
1728       G_LOCK (g_thread);
1729
1730       if (!private_key->index)
1731         {
1732           if (g_thread_free_indices)
1733             {
1734               private_key->index =
1735                 GPOINTER_TO_UINT (g_thread_free_indices->data);
1736               g_thread_free_indices =
1737                 g_slist_delete_link (g_thread_free_indices,
1738                                      g_thread_free_indices);
1739             }
1740           else
1741             private_key->index = ++next_index;
1742         }
1743
1744       G_UNLOCK (g_thread);
1745     }
1746
1747   LOCK_PRIVATE_DATA (self);
1748
1749   array = self->private_data;
1750   if (!array)
1751     {
1752       array = g_array_new (FALSE, TRUE, sizeof (GStaticPrivateNode));
1753       self->private_data = array;
1754     }
1755
1756   if (private_key->index > array->len)
1757     g_array_set_size (array, private_key->index);
1758
1759   node = &g_array_index (array, GStaticPrivateNode, private_key->index - 1);
1760
1761   ddata = node->data;
1762   ddestroy = node->destroy;
1763
1764   node->data = data;
1765   node->destroy = notify;
1766
1767   UNLOCK_PRIVATE_DATA (self);
1768
1769   if (ddestroy)
1770     ddestroy (ddata);
1771 }
1772
1773 /**
1774  * g_static_private_free:
1775  * @private_key: a #GStaticPrivate to be freed.
1776  *
1777  * Releases all resources allocated to @private_key.
1778  *
1779  * You don't have to call this functions for a #GStaticPrivate with an
1780  * unbounded lifetime, i.e. objects declared 'static', but if you have
1781  * a #GStaticPrivate as a member of a structure and the structure is
1782  * freed, you should also free the #GStaticPrivate.
1783  **/
1784 void
1785 g_static_private_free (GStaticPrivate *private_key)
1786 {
1787   guint idx = private_key->index;
1788   GRealThread *thread, *next;
1789   GArray *garbage = NULL;
1790
1791   if (!idx)
1792     return;
1793
1794   private_key->index = 0;
1795
1796   G_LOCK (g_thread);
1797
1798   thread = g_thread_all_threads;
1799
1800   for (thread = g_thread_all_threads; thread; thread = next)
1801     {
1802       GArray *array;
1803
1804       next = thread->next;
1805
1806       LOCK_PRIVATE_DATA (thread);
1807
1808       array = thread->private_data;
1809
1810       if (array && idx <= array->len)
1811         {
1812           GStaticPrivateNode *node = &g_array_index (array,
1813                                                      GStaticPrivateNode,
1814                                                      idx - 1);
1815           gpointer ddata = node->data;
1816           GDestroyNotify ddestroy = node->destroy;
1817
1818           node->data = NULL;
1819           node->destroy = NULL;
1820
1821           if (ddestroy)
1822             {
1823               /* defer non-trivial destruction til after we've finished
1824                * iterating, since we must continue to hold the lock */
1825               if (garbage == NULL)
1826                 garbage = g_array_new (FALSE, TRUE,
1827                                        sizeof (GStaticPrivateNode));
1828
1829               g_array_set_size (garbage, garbage->len + 1);
1830
1831               node = &g_array_index (garbage, GStaticPrivateNode,
1832                                      garbage->len - 1);
1833               node->data = ddata;
1834               node->destroy = ddestroy;
1835             }
1836         }
1837
1838       UNLOCK_PRIVATE_DATA (thread);
1839     }
1840   g_thread_free_indices = g_slist_prepend (g_thread_free_indices,
1841                                            GUINT_TO_POINTER (idx));
1842   G_UNLOCK (g_thread);
1843
1844   if (garbage)
1845     {
1846       guint i;
1847
1848       for (i = 0; i < garbage->len; i++)
1849         {
1850           GStaticPrivateNode *node;
1851
1852           node = &g_array_index (garbage, GStaticPrivateNode, i);
1853           node->destroy (node->data);
1854         }
1855
1856       g_array_free (garbage, TRUE);
1857     }
1858 }
1859
1860 /* GThread Extra Functions {{{1 ------------------------------------------- */
1861 static void
1862 g_thread_cleanup (gpointer data)
1863 {
1864   if (data)
1865     {
1866       GRealThread* thread = data;
1867       GArray *array;
1868
1869       LOCK_PRIVATE_DATA (thread);
1870       array = thread->private_data;
1871       thread->private_data = NULL;
1872       UNLOCK_PRIVATE_DATA (thread);
1873
1874       if (array)
1875         {
1876           guint i;
1877
1878           for (i = 0; i < array->len; i++ )
1879             {
1880               GStaticPrivateNode *node =
1881                 &g_array_index (array, GStaticPrivateNode, i);
1882               if (node->destroy)
1883                 node->destroy (node->data);
1884             }
1885           g_array_free (array, TRUE);
1886         }
1887
1888       /* We only free the thread structure, if it isn't joinable. If
1889          it is, the structure is freed in g_thread_join */
1890       if (!thread->thread.joinable)
1891         {
1892           GRealThread *t, *p;
1893
1894           G_LOCK (g_thread);
1895           for (t = g_thread_all_threads, p = NULL; t; p = t, t = t->next)
1896             {
1897               if (t == thread)
1898                 {
1899                   if (p)
1900                     p->next = t->next;
1901                   else
1902                     g_thread_all_threads = t->next;
1903                   break;
1904                 }
1905             }
1906           G_UNLOCK (g_thread);
1907
1908           /* Just to make sure, this isn't used any more */
1909           g_system_thread_assign (thread->system_thread, zero_thread);
1910           g_free (thread);
1911         }
1912     }
1913 }
1914
1915 static void
1916 g_thread_fail (void)
1917 {
1918   g_error ("The thread system is not yet initialized.");
1919 }
1920
1921 #define G_NSEC_PER_SEC 1000000000
1922
1923 static guint64
1924 gettime (void)
1925 {
1926 #ifdef G_OS_WIN32
1927   guint64 v;
1928
1929   /* Returns 100s of nanoseconds since start of 1601 */
1930   GetSystemTimeAsFileTime ((FILETIME *)&v);
1931
1932   /* Offset to Unix epoch */
1933   v -= G_GINT64_CONSTANT (116444736000000000);
1934   /* Convert to nanoseconds */
1935   v *= 100;
1936
1937   return v;
1938 #else
1939   struct timeval tv;
1940
1941   gettimeofday (&tv, NULL);
1942
1943   return (guint64) tv.tv_sec * G_NSEC_PER_SEC + tv.tv_usec * (G_NSEC_PER_SEC / G_USEC_PER_SEC); 
1944 #endif
1945 }
1946
1947 static gpointer
1948 g_thread_create_proxy (gpointer data)
1949 {
1950   GRealThread* thread = data;
1951
1952   g_assert (data);
1953
1954   /* This has to happen before G_LOCK, as that might call g_thread_self */
1955   g_private_set (g_thread_specific_private, data);
1956
1957   /* the lock makes sure, that thread->system_thread is written,
1958      before thread->thread.func is called. See g_thread_create. */
1959   G_LOCK (g_thread);
1960   G_UNLOCK (g_thread);
1961
1962   thread->retval = thread->thread.func (thread->thread.data);
1963
1964   return NULL;
1965 }
1966
1967 /**
1968  * g_thread_create_full:
1969  * @func: a function to execute in the new thread.
1970  * @data: an argument to supply to the new thread.
1971  * @stack_size: a stack size for the new thread.
1972  * @joinable: should this thread be joinable?
1973  * @bound: should this thread be bound to a system thread?
1974  * @priority: a priority for the thread.
1975  * @error: return location for error.
1976  * @Returns: the new #GThread on success.
1977  *
1978  * This function creates a new thread with the priority @priority. If
1979  * the underlying thread implementation supports it, the thread gets a
1980  * stack size of @stack_size or the default value for the current
1981  * platform, if @stack_size is 0.
1982  *
1983  * If @joinable is %TRUE, you can wait for this threads termination
1984  * calling g_thread_join(). Otherwise the thread will just disappear
1985  * when it terminates. If @bound is %TRUE, this thread will be
1986  * scheduled in the system scope, otherwise the implementation is free
1987  * to do scheduling in the process scope. The first variant is more
1988  * expensive resource-wise, but generally faster. On some systems (e.g.
1989  * Linux) all threads are bound.
1990  *
1991  * The new thread executes the function @func with the argument @data.
1992  * If the thread was created successfully, it is returned.
1993  *
1994  * @error can be %NULL to ignore errors, or non-%NULL to report errors.
1995  * The error is set, if and only if the function returns %NULL.
1996  *
1997  * <note><para>It is not guaranteed that threads with different priorities
1998  * really behave accordingly. On some systems (e.g. Linux) there are no
1999  * thread priorities. On other systems (e.g. Solaris) there doesn't
2000  * seem to be different scheduling for different priorities. All in all
2001  * try to avoid being dependent on priorities. Use
2002  * %G_THREAD_PRIORITY_NORMAL here as a default.</para></note>
2003  *
2004  * <note><para>Only use g_thread_create_full() if you really can't use
2005  * g_thread_create() instead. g_thread_create() does not take
2006  * @stack_size, @bound, and @priority as arguments, as they should only
2007  * be used in cases in which it is unavoidable.</para></note>
2008  **/
2009 GThread*
2010 g_thread_create_full (GThreadFunc       func,
2011                       gpointer          data,
2012                       gulong            stack_size,
2013                       gboolean          joinable,
2014                       gboolean          bound,
2015                       GThreadPriority   priority,
2016                       GError          **error)
2017 {
2018   GRealThread* result;
2019   GError *local_error = NULL;
2020   g_return_val_if_fail (func, NULL);
2021   g_return_val_if_fail (priority >= G_THREAD_PRIORITY_LOW, NULL);
2022   g_return_val_if_fail (priority <= G_THREAD_PRIORITY_URGENT, NULL);
2023
2024   result = g_new0 (GRealThread, 1);
2025
2026   result->thread.joinable = joinable;
2027   result->thread.priority = priority;
2028   result->thread.func = func;
2029   result->thread.data = data;
2030   result->private_data = NULL;
2031   G_LOCK (g_thread);
2032   G_THREAD_UF (thread_create, (g_thread_create_proxy, result,
2033                                stack_size, joinable, bound, priority,
2034                                &result->system_thread, &local_error));
2035   if (!local_error)
2036     {
2037       result->next = g_thread_all_threads;
2038       g_thread_all_threads = result;
2039     }
2040   G_UNLOCK (g_thread);
2041
2042   if (local_error)
2043     {
2044       g_propagate_error (error, local_error);
2045       g_free (result);
2046       return NULL;
2047     }
2048
2049   return (GThread*) result;
2050 }
2051
2052 /**
2053  * g_thread_exit:
2054  * @retval: the return value of this thread.
2055  *
2056  * Exits the current thread. If another thread is waiting for that
2057  * thread using g_thread_join() and the current thread is joinable, the
2058  * waiting thread will be woken up and get @retval as the return value
2059  * of g_thread_join(). If the current thread is not joinable, @retval
2060  * is ignored. Calling
2061  *
2062  * <informalexample>
2063  *  <programlisting>
2064  *   g_thread_exit (retval);
2065  *  </programlisting>
2066  * </informalexample>
2067  *
2068  * is equivalent to returning @retval from the function @func, as given
2069  * to g_thread_create().
2070  *
2071  * <note><para>Never call g_thread_exit() from within a thread of a
2072  * #GThreadPool, as that will mess up the bookkeeping and lead to funny
2073  * and unwanted results.</para></note>
2074  **/
2075 void
2076 g_thread_exit (gpointer retval)
2077 {
2078   GRealThread* real = (GRealThread*) g_thread_self ();
2079   real->retval = retval;
2080   G_THREAD_CF (thread_exit, (void)0, ());
2081 }
2082
2083 /**
2084  * g_thread_join:
2085  * @thread: a #GThread to be waited for.
2086  * @Returns: the return value of the thread.
2087  *
2088  * Waits until @thread finishes, i.e. the function @func, as given to
2089  * g_thread_create(), returns or g_thread_exit() is called by @thread.
2090  * All resources of @thread including the #GThread struct are released.
2091  * @thread must have been created with @joinable=%TRUE in
2092  * g_thread_create(). The value returned by @func or given to
2093  * g_thread_exit() by @thread is returned by this function.
2094  **/
2095 gpointer
2096 g_thread_join (GThread* thread)
2097 {
2098   GRealThread* real = (GRealThread*) thread;
2099   GRealThread *p, *t;
2100   gpointer retval;
2101
2102   g_return_val_if_fail (thread, NULL);
2103   g_return_val_if_fail (thread->joinable, NULL);
2104   g_return_val_if_fail (!g_system_thread_equal (real->system_thread,
2105                                                 zero_thread), NULL);
2106
2107   G_THREAD_UF (thread_join, (&real->system_thread));
2108
2109   retval = real->retval;
2110
2111   G_LOCK (g_thread);
2112   for (t = g_thread_all_threads, p = NULL; t; p = t, t = t->next)
2113     {
2114       if (t == (GRealThread*) thread)
2115         {
2116           if (p)
2117             p->next = t->next;
2118           else
2119             g_thread_all_threads = t->next;
2120           break;
2121         }
2122     }
2123   G_UNLOCK (g_thread);
2124
2125   /* Just to make sure, this isn't used any more */
2126   thread->joinable = 0;
2127   g_system_thread_assign (real->system_thread, zero_thread);
2128
2129   /* the thread structure for non-joinable threads is freed upon
2130      thread end. We free the memory here. This will leave a loose end,
2131      if a joinable thread is not joined. */
2132
2133   g_free (thread);
2134
2135   return retval;
2136 }
2137
2138 /**
2139  * g_thread_set_priority:
2140  * @thread: a #GThread.
2141  * @priority: a new priority for @thread.
2142  *
2143  * Changes the priority of @thread to @priority.
2144  *
2145  * <note><para>It is not guaranteed that threads with different
2146  * priorities really behave accordingly. On some systems (e.g. Linux)
2147  * there are no thread priorities. On other systems (e.g. Solaris) there
2148  * doesn't seem to be different scheduling for different priorities. All
2149  * in all try to avoid being dependent on priorities.</para></note>
2150  **/
2151 void
2152 g_thread_set_priority (GThread* thread,
2153                        GThreadPriority priority)
2154 {
2155   GRealThread* real = (GRealThread*) thread;
2156
2157   g_return_if_fail (thread);
2158   g_return_if_fail (!g_system_thread_equal (real->system_thread, zero_thread));
2159   g_return_if_fail (priority >= G_THREAD_PRIORITY_LOW);
2160   g_return_if_fail (priority <= G_THREAD_PRIORITY_URGENT);
2161
2162   thread->priority = priority;
2163
2164   G_THREAD_CF (thread_set_priority, (void)0,
2165                (&real->system_thread, priority));
2166 }
2167
2168 /**
2169  * g_thread_self:
2170  * @Returns: the current thread.
2171  *
2172  * This functions returns the #GThread corresponding to the calling
2173  * thread.
2174  **/
2175 GThread*
2176 g_thread_self (void)
2177 {
2178   GRealThread* thread = g_private_get (g_thread_specific_private);
2179
2180   if (!thread)
2181     {
2182       /* If no thread data is available, provide and set one.  This
2183          can happen for the main thread and for threads, that are not
2184          created by GLib. */
2185       thread = g_new0 (GRealThread, 1);
2186       thread->thread.joinable = FALSE; /* This is a save guess */
2187       thread->thread.priority = G_THREAD_PRIORITY_NORMAL; /* This is
2188                                                              just a guess */
2189       thread->thread.func = NULL;
2190       thread->thread.data = NULL;
2191       thread->private_data = NULL;
2192
2193       if (g_thread_supported ())
2194         G_THREAD_UF (thread_self, (&thread->system_thread));
2195
2196       g_private_set (g_thread_specific_private, thread);
2197
2198       G_LOCK (g_thread);
2199       thread->next = g_thread_all_threads;
2200       g_thread_all_threads = thread;
2201       G_UNLOCK (g_thread);
2202     }
2203
2204   return (GThread*)thread;
2205 }
2206
2207 /* GStaticRWLock {{{1 ----------------------------------------------------- */
2208
2209 /**
2210  * GStaticRWLock:
2211  *
2212  * The #GStaticRWLock struct represents a read-write lock. A read-write
2213  * lock can be used for protecting data that some portions of code only
2214  * read from, while others also write. In such situations it is
2215  * desirable that several readers can read at once, whereas of course
2216  * only one writer may write at a time. Take a look at the following
2217  * example:
2218  *
2219  * <example>
2220  *  <title>An array with access functions</title>
2221  *  <programlisting>
2222  *   GStaticRWLock rwlock = G_STATIC_RW_LOCK_INIT;
2223  *   GPtrArray *array;
2224  *
2225  *   gpointer
2226  *   my_array_get (guint index)
2227  *   {
2228  *     gpointer retval = NULL;
2229  *
2230  *     if (!array)
2231  *       return NULL;
2232  *
2233  *     g_static_rw_lock_reader_lock (&amp;rwlock);
2234  *     if (index &lt; array->len)
2235  *       retval = g_ptr_array_index (array, index);
2236  *     g_static_rw_lock_reader_unlock (&amp;rwlock);
2237  *
2238  *     return retval;
2239  *   }
2240  *
2241  *   void
2242  *   my_array_set (guint index, gpointer data)
2243  *   {
2244  *     g_static_rw_lock_writer_lock (&amp;rwlock);
2245  *
2246  *     if (!array)
2247  *       array = g_ptr_array_new (<!-- -->);
2248  *
2249  *     if (index >= array->len)
2250  *       g_ptr_array_set_size (array, index+1);
2251  *     g_ptr_array_index (array, index) = data;
2252  *
2253  *     g_static_rw_lock_writer_unlock (&amp;rwlock);
2254  *   }
2255  *  </programlisting>
2256  * </example>
2257  *
2258  * This example shows an array which can be accessed by many readers
2259  * (the <function>my_array_get()</function> function) simultaneously,
2260  * whereas the writers (the <function>my_array_set()</function>
2261  * function) will only be allowed once at a time and only if no readers
2262  * currently access the array. This is because of the potentially
2263  * dangerous resizing of the array. Using these functions is fully
2264  * multi-thread safe now.
2265  *
2266  * Most of the time, writers should have precedence over readers. That
2267  * means, for this implementation, that as soon as a writer wants to
2268  * lock the data, no other reader is allowed to lock the data, whereas,
2269  * of course, the readers that already have locked the data are allowed
2270  * to finish their operation. As soon as the last reader unlocks the
2271  * data, the writer will lock it.
2272  *
2273  * Even though #GStaticRWLock is not opaque, it should only be used
2274  * with the following functions.
2275  *
2276  * All of the <function>g_static_rw_lock_*</function> functions can be
2277  * used even if g_thread_init() has not been called. Then they do
2278  * nothing, apart from <function>g_static_rw_lock_*_trylock</function>,
2279  * which does nothing but returning %TRUE.
2280  *
2281  * <note><para>A read-write lock has a higher overhead than a mutex. For
2282  * example, both g_static_rw_lock_reader_lock() and
2283  * g_static_rw_lock_reader_unlock() have to lock and unlock a
2284  * #GStaticMutex, so it takes at least twice the time to lock and unlock
2285  * a #GStaticRWLock that it does to lock and unlock a #GStaticMutex. So
2286  * only data structures that are accessed by multiple readers, and which
2287  * keep the lock for a considerable time justify a #GStaticRWLock. The
2288  * above example most probably would fare better with a
2289  * #GStaticMutex.</para></note>
2290  **/
2291
2292 /**
2293  * G_STATIC_RW_LOCK_INIT:
2294  *
2295  * A #GStaticRWLock must be initialized with this macro before it can
2296  * be used. This macro can used be to initialize a variable, but it
2297  * cannot be assigned to a variable. In that case you have to use
2298  * g_static_rw_lock_init().
2299  *
2300  * <informalexample>
2301  *  <programlisting>
2302  *   GStaticRWLock my_lock = G_STATIC_RW_LOCK_INIT;
2303  *  </programlisting>
2304  * </informalexample>
2305  **/
2306
2307 /**
2308  * g_static_rw_lock_init:
2309  * @lock: a #GStaticRWLock to be initialized.
2310  *
2311  * A #GStaticRWLock must be initialized with this function before it
2312  * can be used. Alternatively you can initialize it with
2313  * #G_STATIC_RW_LOCK_INIT.
2314  **/
2315 void
2316 g_static_rw_lock_init (GStaticRWLock* lock)
2317 {
2318   static const GStaticRWLock init_lock = G_STATIC_RW_LOCK_INIT;
2319
2320   g_return_if_fail (lock);
2321
2322   *lock = init_lock;
2323 }
2324
2325 inline static void
2326 g_static_rw_lock_wait (GCond** cond, GStaticMutex* mutex)
2327 {
2328   if (!*cond)
2329       *cond = g_cond_new ();
2330   g_cond_wait (*cond, g_static_mutex_get_mutex (mutex));
2331 }
2332
2333 inline static void
2334 g_static_rw_lock_signal (GStaticRWLock* lock)
2335 {
2336   if (lock->want_to_write && lock->write_cond)
2337     g_cond_signal (lock->write_cond);
2338   else if (lock->want_to_read && lock->read_cond)
2339     g_cond_broadcast (lock->read_cond);
2340 }
2341
2342 /**
2343  * g_static_rw_lock_reader_lock:
2344  * @lock: a #GStaticRWLock to lock for reading.
2345  *
2346  * Locks @lock for reading. There may be unlimited concurrent locks for
2347  * reading of a #GStaticRWLock at the same time.  If @lock is already
2348  * locked for writing by another thread or if another thread is already
2349  * waiting to lock @lock for writing, this function will block until
2350  * @lock is unlocked by the other writing thread and no other writing
2351  * threads want to lock @lock. This lock has to be unlocked by
2352  * g_static_rw_lock_reader_unlock().
2353  *
2354  * #GStaticRWLock is not recursive. It might seem to be possible to
2355  * recursively lock for reading, but that can result in a deadlock, due
2356  * to writer preference.
2357  **/
2358 void
2359 g_static_rw_lock_reader_lock (GStaticRWLock* lock)
2360 {
2361   g_return_if_fail (lock);
2362
2363   if (!g_threads_got_initialized)
2364     return;
2365
2366   g_static_mutex_lock (&lock->mutex);
2367   lock->want_to_read++;
2368   while (lock->have_writer || lock->want_to_write)
2369     g_static_rw_lock_wait (&lock->read_cond, &lock->mutex);
2370   lock->want_to_read--;
2371   lock->read_counter++;
2372   g_static_mutex_unlock (&lock->mutex);
2373 }
2374
2375 /**
2376  * g_static_rw_lock_reader_trylock:
2377  * @lock: a #GStaticRWLock to lock for reading.
2378  * @Returns: %TRUE, if @lock could be locked for reading.
2379  *
2380  * Tries to lock @lock for reading. If @lock is already locked for
2381  * writing by another thread or if another thread is already waiting to
2382  * lock @lock for writing, immediately returns %FALSE. Otherwise locks
2383  * @lock for reading and returns %TRUE. This lock has to be unlocked by
2384  * g_static_rw_lock_reader_unlock().
2385  **/
2386 gboolean
2387 g_static_rw_lock_reader_trylock (GStaticRWLock* lock)
2388 {
2389   gboolean ret_val = FALSE;
2390
2391   g_return_val_if_fail (lock, FALSE);
2392
2393   if (!g_threads_got_initialized)
2394     return TRUE;
2395
2396   g_static_mutex_lock (&lock->mutex);
2397   if (!lock->have_writer && !lock->want_to_write)
2398     {
2399       lock->read_counter++;
2400       ret_val = TRUE;
2401     }
2402   g_static_mutex_unlock (&lock->mutex);
2403   return ret_val;
2404 }
2405
2406 /**
2407  * g_static_rw_lock_reader_unlock:
2408  * @lock: a #GStaticRWLock to unlock after reading.
2409  *
2410  * Unlocks @lock. If a thread waits to lock @lock for writing and all
2411  * locks for reading have been unlocked, the waiting thread is woken up
2412  * and can lock @lock for writing.
2413  **/
2414 void
2415 g_static_rw_lock_reader_unlock  (GStaticRWLock* lock)
2416 {
2417   g_return_if_fail (lock);
2418
2419   if (!g_threads_got_initialized)
2420     return;
2421
2422   g_static_mutex_lock (&lock->mutex);
2423   lock->read_counter--;
2424   if (lock->read_counter == 0)
2425     g_static_rw_lock_signal (lock);
2426   g_static_mutex_unlock (&lock->mutex);
2427 }
2428
2429 /**
2430  * g_static_rw_lock_writer_lock:
2431  * @lock: a #GStaticRWLock to lock for writing.
2432  *
2433  * Locks @lock for writing. If @lock is already locked for writing or
2434  * reading by other threads, this function will block until @lock is
2435  * completely unlocked and then lock @lock for writing. While this
2436  * functions waits to lock @lock, no other thread can lock @lock for
2437  * reading. When @lock is locked for writing, no other thread can lock
2438  * @lock (neither for reading nor writing). This lock has to be
2439  * unlocked by g_static_rw_lock_writer_unlock().
2440  **/
2441 void
2442 g_static_rw_lock_writer_lock (GStaticRWLock* lock)
2443 {
2444   g_return_if_fail (lock);
2445
2446   if (!g_threads_got_initialized)
2447     return;
2448
2449   g_static_mutex_lock (&lock->mutex);
2450   lock->want_to_write++;
2451   while (lock->have_writer || lock->read_counter)
2452     g_static_rw_lock_wait (&lock->write_cond, &lock->mutex);
2453   lock->want_to_write--;
2454   lock->have_writer = TRUE;
2455   g_static_mutex_unlock (&lock->mutex);
2456 }
2457
2458 /**
2459  * g_static_rw_lock_writer_trylock:
2460  * @lock: a #GStaticRWLock to lock for writing.
2461  * @Returns: %TRUE, if @lock could be locked for writing.
2462  *
2463  * Tries to lock @lock for writing. If @lock is already locked (for
2464  * either reading or writing) by another thread, it immediately returns
2465  * %FALSE. Otherwise it locks @lock for writing and returns %TRUE. This
2466  * lock has to be unlocked by g_static_rw_lock_writer_unlock().
2467  **/
2468 gboolean
2469 g_static_rw_lock_writer_trylock (GStaticRWLock* lock)
2470 {
2471   gboolean ret_val = FALSE;
2472
2473   g_return_val_if_fail (lock, FALSE);
2474
2475   if (!g_threads_got_initialized)
2476     return TRUE;
2477
2478   g_static_mutex_lock (&lock->mutex);
2479   if (!lock->have_writer && !lock->read_counter)
2480     {
2481       lock->have_writer = TRUE;
2482       ret_val = TRUE;
2483     }
2484   g_static_mutex_unlock (&lock->mutex);
2485   return ret_val;
2486 }
2487
2488 /**
2489  * g_static_rw_lock_writer_unlock:
2490  * @lock: a #GStaticRWLock to unlock after writing.
2491  *
2492  * Unlocks @lock. If a thread is waiting to lock @lock for writing and
2493  * all locks for reading have been unlocked, the waiting thread is
2494  * woken up and can lock @lock for writing. If no thread is waiting to
2495  * lock @lock for writing, and some thread or threads are waiting to
2496  * lock @lock for reading, the waiting threads are woken up and can
2497  * lock @lock for reading.
2498  **/
2499 void
2500 g_static_rw_lock_writer_unlock (GStaticRWLock* lock)
2501 {
2502   g_return_if_fail (lock);
2503
2504   if (!g_threads_got_initialized)
2505     return;
2506
2507   g_static_mutex_lock (&lock->mutex);
2508   lock->have_writer = FALSE;
2509   g_static_rw_lock_signal (lock);
2510   g_static_mutex_unlock (&lock->mutex);
2511 }
2512
2513 /**
2514  * g_static_rw_lock_free:
2515  * @lock: a #GStaticRWLock to be freed.
2516  *
2517  * Releases all resources allocated to @lock.
2518  *
2519  * You don't have to call this functions for a #GStaticRWLock with an
2520  * unbounded lifetime, i.e. objects declared 'static', but if you have
2521  * a #GStaticRWLock as a member of a structure, and the structure is
2522  * freed, you should also free the #GStaticRWLock.
2523  **/
2524 void
2525 g_static_rw_lock_free (GStaticRWLock* lock)
2526 {
2527   g_return_if_fail (lock);
2528
2529   if (lock->read_cond)
2530     {
2531       g_cond_free (lock->read_cond);
2532       lock->read_cond = NULL;
2533     }
2534   if (lock->write_cond)
2535     {
2536       g_cond_free (lock->write_cond);
2537       lock->write_cond = NULL;
2538     }
2539   g_static_mutex_free (&lock->mutex);
2540 }
2541
2542 /* Unsorted {{{1 ---------------------------------------------------------- */
2543
2544 /**
2545  * g_thread_foreach
2546  * @thread_func: function to call for all GThread structures
2547  * @user_data:   second argument to @thread_func
2548  *
2549  * Call @thread_func on all existing #GThread structures. Note that
2550  * threads may decide to exit while @thread_func is running, so
2551  * without intimate knowledge about the lifetime of foreign threads,
2552  * @thread_func shouldn't access the GThread* pointer passed in as
2553  * first argument. However, @thread_func will not be called for threads
2554  * which are known to have exited already.
2555  *
2556  * Due to thread lifetime checks, this function has an execution complexity
2557  * which is quadratic in the number of existing threads.
2558  *
2559  * Since: 2.10
2560  */
2561 void
2562 g_thread_foreach (GFunc    thread_func,
2563                   gpointer user_data)
2564 {
2565   GSList *slist = NULL;
2566   GRealThread *thread;
2567   g_return_if_fail (thread_func != NULL);
2568   /* snapshot the list of threads for iteration */
2569   G_LOCK (g_thread);
2570   for (thread = g_thread_all_threads; thread; thread = thread->next)
2571     slist = g_slist_prepend (slist, thread);
2572   G_UNLOCK (g_thread);
2573   /* walk the list, skipping non-existant threads */
2574   while (slist)
2575     {
2576       GSList *node = slist;
2577       slist = node->next;
2578       /* check whether the current thread still exists */
2579       G_LOCK (g_thread);
2580       for (thread = g_thread_all_threads; thread; thread = thread->next)
2581         if (thread == node->data)
2582           break;
2583       G_UNLOCK (g_thread);
2584       if (thread)
2585         thread_func (thread, user_data);
2586       g_slist_free_1 (node);
2587     }
2588 }
2589
2590 /**
2591  * g_thread_get_initialized
2592  *
2593  * Indicates if g_thread_init() has been called.
2594  *
2595  * Returns: %TRUE if threads have been initialized.
2596  *
2597  * Since: 2.20
2598  */
2599 gboolean
2600 g_thread_get_initialized ()
2601 {
2602   return g_thread_supported ();
2603 }