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