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