emufutex: remove init from g_thread_init_glib
[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 }
967
968 /* The following sections implement: GOnce, GStaticMutex, GStaticRecMutex,
969  * GStaticPrivate, 
970  **/
971
972 /* GOnce {{{1 ------------------------------------------------------------- */
973
974 /**
975  * GOnce:
976  * @status: the status of the #GOnce
977  * @retval: the value returned by the call to the function, if @status
978  *          is %G_ONCE_STATUS_READY
979  *
980  * A #GOnce struct controls a one-time initialization function. Any
981  * one-time initialization function must have its own unique #GOnce
982  * struct.
983  *
984  * Since: 2.4
985  **/
986
987 /**
988  * G_ONCE_INIT:
989  *
990  * A #GOnce must be initialized with this macro before it can be used.
991  *
992  * <informalexample>
993  *  <programlisting>
994  *   GOnce my_once = G_ONCE_INIT;
995  *  </programlisting>
996  * </informalexample>
997  *
998  * Since: 2.4
999  **/
1000
1001 /**
1002  * GOnceStatus:
1003  * @G_ONCE_STATUS_NOTCALLED: the function has not been called yet.
1004  * @G_ONCE_STATUS_PROGRESS: the function call is currently in progress.
1005  * @G_ONCE_STATUS_READY: the function has been called.
1006  *
1007  * The possible statuses of a one-time initialization function
1008  * controlled by a #GOnce struct.
1009  *
1010  * Since: 2.4
1011  **/
1012
1013 /**
1014  * g_once:
1015  * @once: a #GOnce structure
1016  * @func: the #GThreadFunc function associated to @once. This function
1017  *        is called only once, regardless of the number of times it and
1018  *        its associated #GOnce struct are passed to g_once().
1019  * @arg: data to be passed to @func
1020  *
1021  * The first call to this routine by a process with a given #GOnce
1022  * struct calls @func with the given argument. Thereafter, subsequent
1023  * calls to g_once()  with the same #GOnce struct do not call @func
1024  * again, but return the stored result of the first call. On return
1025  * from g_once(), the status of @once will be %G_ONCE_STATUS_READY.
1026  *
1027  * For example, a mutex or a thread-specific data key must be created
1028  * exactly once. In a threaded environment, calling g_once() ensures
1029  * that the initialization is serialized across multiple threads.
1030  *
1031  * <note><para>Calling g_once() recursively on the same #GOnce struct in
1032  * @func will lead to a deadlock.</para></note>
1033  *
1034  * <informalexample>
1035  *  <programlisting>
1036  *   gpointer
1037  *   get_debug_flags (void)
1038  *   {
1039  *     static GOnce my_once = G_ONCE_INIT;
1040  *
1041  *     g_once (&my_once, parse_debug_flags, NULL);
1042  *
1043  *     return my_once.retval;
1044  *   }
1045  *  </programlisting>
1046  * </informalexample>
1047  *
1048  * Since: 2.4
1049  **/
1050 gpointer
1051 g_once_impl (GOnce       *once,
1052              GThreadFunc  func,
1053              gpointer     arg)
1054 {
1055   g_mutex_lock (g_once_mutex);
1056
1057   while (once->status == G_ONCE_STATUS_PROGRESS)
1058     g_cond_wait (g_once_cond, g_once_mutex);
1059
1060   if (once->status != G_ONCE_STATUS_READY)
1061     {
1062       once->status = G_ONCE_STATUS_PROGRESS;
1063       g_mutex_unlock (g_once_mutex);
1064
1065       once->retval = func (arg);
1066
1067       g_mutex_lock (g_once_mutex);
1068       once->status = G_ONCE_STATUS_READY;
1069       g_cond_broadcast (g_once_cond);
1070     }
1071
1072   g_mutex_unlock (g_once_mutex);
1073
1074   return once->retval;
1075 }
1076
1077 /**
1078  * g_once_init_enter:
1079  * @value_location: location of a static initializable variable
1080  *                  containing 0.
1081  * @Returns: %TRUE if the initialization section should be entered,
1082  *           %FALSE and blocks otherwise
1083  *
1084  * Function to be called when starting a critical initialization
1085  * section. The argument @value_location must point to a static
1086  * 0-initialized variable that will be set to a value other than 0 at
1087  * the end of the initialization section. In combination with
1088  * g_once_init_leave() and the unique address @value_location, it can
1089  * be ensured that an initialization section will be executed only once
1090  * during a program's life time, and that concurrent threads are
1091  * blocked until initialization completed. To be used in constructs
1092  * like this:
1093  *
1094  * <informalexample>
1095  *  <programlisting>
1096  *   static gsize initialization_value = 0;
1097  *
1098  *   if (g_once_init_enter (&amp;initialization_value))
1099  *     {
1100  *       gsize setup_value = 42; /<!-- -->* initialization code here *<!-- -->/
1101  *
1102  *       g_once_init_leave (&amp;initialization_value, setup_value);
1103  *     }
1104  *
1105  *   /<!-- -->* use initialization_value here *<!-- -->/
1106  *  </programlisting>
1107  * </informalexample>
1108  *
1109  * Since: 2.14
1110  **/
1111 gboolean
1112 g_once_init_enter_impl (volatile gsize *value_location)
1113 {
1114   gboolean need_init = FALSE;
1115   g_mutex_lock (g_once_mutex);
1116   if (g_atomic_pointer_get (value_location) == NULL)
1117     {
1118       if (!g_slist_find (g_once_init_list, (void*) value_location))
1119         {
1120           need_init = TRUE;
1121           g_once_init_list = g_slist_prepend (g_once_init_list, (void*) value_location);
1122         }
1123       else
1124         do
1125           g_cond_wait (g_once_cond, g_once_mutex);
1126         while (g_slist_find (g_once_init_list, (void*) value_location));
1127     }
1128   g_mutex_unlock (g_once_mutex);
1129   return need_init;
1130 }
1131
1132 /**
1133  * g_once_init_leave:
1134  * @value_location: location of a static initializable variable
1135  *                  containing 0.
1136  * @initialization_value: new non-0 value for *@value_location.
1137  *
1138  * Counterpart to g_once_init_enter(). Expects a location of a static
1139  * 0-initialized initialization variable, and an initialization value
1140  * other than 0. Sets the variable to the initialization value, and
1141  * releases concurrent threads blocking in g_once_init_enter() on this
1142  * initialization variable.
1143  *
1144  * Since: 2.14
1145  **/
1146 void
1147 g_once_init_leave (volatile gsize *value_location,
1148                    gsize           initialization_value)
1149 {
1150   g_return_if_fail (g_atomic_pointer_get (value_location) == NULL);
1151   g_return_if_fail (initialization_value != 0);
1152   g_return_if_fail (g_once_init_list != NULL);
1153
1154   g_atomic_pointer_set (value_location, initialization_value);
1155   g_mutex_lock (g_once_mutex);
1156   g_once_init_list = g_slist_remove (g_once_init_list, (void*) value_location);
1157   g_cond_broadcast (g_once_cond);
1158   g_mutex_unlock (g_once_mutex);
1159 }
1160
1161 /* GStaticMutex {{{1 ------------------------------------------------------ */
1162
1163 /**
1164  * GStaticMutex:
1165  *
1166  * A #GStaticMutex works like a #GMutex, but it has one significant
1167  * advantage. It doesn't need to be created at run-time like a #GMutex,
1168  * but can be defined at compile-time. Here is a shorter, easier and
1169  * safer version of our <function>give_me_next_number()</function>
1170  * example:
1171  *
1172  * <example>
1173  *  <title>
1174  *   Using <structname>GStaticMutex</structname>
1175  *   to simplify thread-safe programming
1176  *  </title>
1177  *  <programlisting>
1178  *   int
1179  *   give_me_next_number (void)
1180  *   {
1181  *     static int current_number = 0;
1182  *     int ret_val;
1183  *     static GStaticMutex mutex = G_STATIC_MUTEX_INIT;
1184  *
1185  *     g_static_mutex_lock (&amp;mutex);
1186  *     ret_val = current_number = calc_next_number (current_number);
1187  *     g_static_mutex_unlock (&amp;mutex);
1188  *
1189  *     return ret_val;
1190  *   }
1191  *  </programlisting>
1192  * </example>
1193  *
1194  * Sometimes you would like to dynamically create a mutex. If you don't
1195  * want to require prior calling to g_thread_init(), because your code
1196  * should also be usable in non-threaded programs, you are not able to
1197  * use g_mutex_new() and thus #GMutex, as that requires a prior call to
1198  * g_thread_init(). In theses cases you can also use a #GStaticMutex.
1199  * It must be initialized with g_static_mutex_init() before using it
1200  * and freed with with g_static_mutex_free() when not needed anymore to
1201  * free up any allocated resources.
1202  *
1203  * Even though #GStaticMutex is not opaque, it should only be used with
1204  * the following functions, as it is defined differently on different
1205  * platforms.
1206  *
1207  * All of the <function>g_static_mutex_*</function> functions apart
1208  * from <function>g_static_mutex_get_mutex</function> can also be used
1209  * even if g_thread_init() has not yet been called. Then they do
1210  * nothing, apart from <function>g_static_mutex_trylock</function>,
1211  * which does nothing but returning %TRUE.
1212  *
1213  * <note><para>All of the <function>g_static_mutex_*</function>
1214  * functions are actually macros. Apart from taking their addresses, you
1215  * can however use them as if they were functions.</para></note>
1216  **/
1217
1218 /**
1219  * G_STATIC_MUTEX_INIT:
1220  *
1221  * A #GStaticMutex must be initialized with this macro, before it can
1222  * be used. This macro can used be to initialize a variable, but it
1223  * cannot be assigned to a variable. In that case you have to use
1224  * g_static_mutex_init().
1225  *
1226  * <informalexample>
1227  *  <programlisting>
1228  *   GStaticMutex my_mutex = G_STATIC_MUTEX_INIT;
1229  *  </programlisting>
1230  * </informalexample>
1231  **/
1232
1233 /**
1234  * g_static_mutex_init:
1235  * @mutex: a #GStaticMutex to be initialized.
1236  *
1237  * Initializes @mutex. Alternatively you can initialize it with
1238  * #G_STATIC_MUTEX_INIT.
1239  **/
1240 void
1241 g_static_mutex_init (GStaticMutex *mutex)
1242 {
1243   static const GStaticMutex init_mutex = G_STATIC_MUTEX_INIT;
1244
1245   g_return_if_fail (mutex);
1246
1247   *mutex = init_mutex;
1248 }
1249
1250 /* IMPLEMENTATION NOTE:
1251  *
1252  * On some platforms a GStaticMutex is actually a normal GMutex stored
1253  * inside of a structure instead of being allocated dynamically.  We can
1254  * only do this for platforms on which we know, in advance, how to
1255  * allocate (size) and initialise (value) that memory.
1256  *
1257  * On other platforms, a GStaticMutex is nothing more than a pointer to
1258  * a GMutex.  In that case, the first access we make to the static mutex
1259  * must first allocate the normal GMutex and store it into the pointer.
1260  *
1261  * configure.ac writes macros into glibconfig.h to determine if
1262  * g_static_mutex_get_mutex() accesses the structure in memory directly
1263  * (on platforms where we are able to do that) or if it ends up here,
1264  * where we may have to allocate the GMutex before returning it.
1265  */
1266
1267 /**
1268  * g_static_mutex_get_mutex:
1269  * @mutex: a #GStaticMutex.
1270  * @Returns: the #GMutex corresponding to @mutex.
1271  *
1272  * For some operations (like g_cond_wait()) you must have a #GMutex
1273  * instead of a #GStaticMutex. This function will return the
1274  * corresponding #GMutex for @mutex.
1275  **/
1276 GMutex *
1277 g_static_mutex_get_mutex_impl (GMutex** mutex)
1278 {
1279   GMutex *result;
1280
1281   if (!g_thread_supported ())
1282     return NULL;
1283
1284   result = g_atomic_pointer_get (mutex);
1285
1286   if (!result)
1287     {
1288       g_assert (g_once_mutex);
1289
1290       g_mutex_lock (g_once_mutex);
1291
1292       result = *mutex;
1293       if (!result)
1294         {
1295           result = g_mutex_new ();
1296           g_atomic_pointer_set (mutex, result);
1297         }
1298
1299       g_mutex_unlock (g_once_mutex);
1300     }
1301
1302   return result;
1303 }
1304
1305 /* IMPLEMENTATION NOTE:
1306  *
1307  * g_static_mutex_lock(), g_static_mutex_trylock() and
1308  * g_static_mutex_unlock() are all preprocessor macros that wrap the
1309  * corresponding g_mutex_*() function around a call to
1310  * g_static_mutex_get_mutex().
1311  */
1312
1313 /**
1314  * g_static_mutex_lock:
1315  * @mutex: a #GStaticMutex.
1316  *
1317  * Works like g_mutex_lock(), but for a #GStaticMutex.
1318  **/
1319
1320 /**
1321  * g_static_mutex_trylock:
1322  * @mutex: a #GStaticMutex.
1323  * @Returns: %TRUE, if the #GStaticMutex could be locked.
1324  *
1325  * Works like g_mutex_trylock(), but for a #GStaticMutex.
1326  **/
1327
1328 /**
1329  * g_static_mutex_unlock:
1330  * @mutex: a #GStaticMutex.
1331  *
1332  * Works like g_mutex_unlock(), but for a #GStaticMutex.
1333  **/
1334
1335 /**
1336  * g_static_mutex_free:
1337  * @mutex: a #GStaticMutex to be freed.
1338  *
1339  * Releases all resources allocated to @mutex.
1340  *
1341  * You don't have to call this functions for a #GStaticMutex with an
1342  * unbounded lifetime, i.e. objects declared 'static', but if you have
1343  * a #GStaticMutex as a member of a structure and the structure is
1344  * freed, you should also free the #GStaticMutex.
1345  *
1346  * <note><para>Calling g_static_mutex_free() on a locked mutex may
1347  * result in undefined behaviour.</para></note>
1348  **/
1349 void
1350 g_static_mutex_free (GStaticMutex* mutex)
1351 {
1352   GMutex **runtime_mutex;
1353
1354   g_return_if_fail (mutex);
1355
1356   /* The runtime_mutex is the first (or only) member of GStaticMutex,
1357    * see both versions (of glibconfig.h) in configure.ac. Note, that
1358    * this variable is NULL, if g_thread_init() hasn't been called or
1359    * if we're using the default thread implementation and it provides
1360    * static mutexes. */
1361   runtime_mutex = ((GMutex**)mutex);
1362
1363   if (*runtime_mutex)
1364     g_mutex_free (*runtime_mutex);
1365
1366   *runtime_mutex = NULL;
1367 }
1368
1369 /* ------------------------------------------------------------------------ */
1370
1371 /**
1372  * GStaticRecMutex:
1373  *
1374  * A #GStaticRecMutex works like a #GStaticMutex, but it can be locked
1375  * multiple times by one thread. If you enter it n times, you have to
1376  * unlock it n times again to let other threads lock it. An exception
1377  * is the function g_static_rec_mutex_unlock_full(): that allows you to
1378  * unlock a #GStaticRecMutex completely returning the depth, (i.e. the
1379  * number of times this mutex was locked). The depth can later be used
1380  * to restore the state of the #GStaticRecMutex by calling
1381  * g_static_rec_mutex_lock_full().
1382  *
1383  * Even though #GStaticRecMutex is not opaque, it should only be used
1384  * with the following functions.
1385  *
1386  * All of the <function>g_static_rec_mutex_*</function> functions can
1387  * be used even if g_thread_init() has not been called. Then they do
1388  * nothing, apart from <function>g_static_rec_mutex_trylock</function>,
1389  * which does nothing but returning %TRUE.
1390  **/
1391
1392 /**
1393  * G_STATIC_REC_MUTEX_INIT:
1394  *
1395  * A #GStaticRecMutex must be initialized with this macro before it can
1396  * be used. This macro can used be to initialize a variable, but it
1397  * cannot be assigned to a variable. In that case you have to use
1398  * g_static_rec_mutex_init().
1399  *
1400  * <informalexample>
1401  *  <programlisting>
1402  *   GStaticRecMutex my_mutex = G_STATIC_REC_MUTEX_INIT;
1403  * </programlisting>
1404  </informalexample>
1405  **/
1406
1407 /**
1408  * g_static_rec_mutex_init:
1409  * @mutex: a #GStaticRecMutex to be initialized.
1410  *
1411  * A #GStaticRecMutex must be initialized with this function before it
1412  * can be used. Alternatively you can initialize it with
1413  * #G_STATIC_REC_MUTEX_INIT.
1414  **/
1415 void
1416 g_static_rec_mutex_init (GStaticRecMutex *mutex)
1417 {
1418   static const GStaticRecMutex init_mutex = G_STATIC_REC_MUTEX_INIT;
1419
1420   g_return_if_fail (mutex);
1421
1422   *mutex = init_mutex;
1423 }
1424
1425 /**
1426  * g_static_rec_mutex_lock:
1427  * @mutex: a #GStaticRecMutex to lock.
1428  *
1429  * Locks @mutex. If @mutex is already locked by another thread, the
1430  * current thread will block until @mutex is unlocked by the other
1431  * thread. If @mutex is already locked by the calling thread, this
1432  * functions increases the depth of @mutex and returns immediately.
1433  **/
1434 void
1435 g_static_rec_mutex_lock (GStaticRecMutex* mutex)
1436 {
1437   GSystemThread self;
1438
1439   g_return_if_fail (mutex);
1440
1441   if (!g_thread_supported ())
1442     return;
1443
1444   G_THREAD_UF (thread_self, (&self));
1445
1446   if (g_system_thread_equal (self, mutex->owner))
1447     {
1448       mutex->depth++;
1449       return;
1450     }
1451   g_static_mutex_lock (&mutex->mutex);
1452   g_system_thread_assign (mutex->owner, self);
1453   mutex->depth = 1;
1454 }
1455
1456 /**
1457  * g_static_rec_mutex_trylock:
1458  * @mutex: a #GStaticRecMutex to lock.
1459  * @Returns: %TRUE, if @mutex could be locked.
1460  *
1461  * Tries to lock @mutex. If @mutex is already locked by another thread,
1462  * it immediately returns %FALSE. Otherwise it locks @mutex and returns
1463  * %TRUE. If @mutex is already locked by the calling thread, this
1464  * functions increases the depth of @mutex and immediately returns
1465  * %TRUE.
1466  **/
1467 gboolean
1468 g_static_rec_mutex_trylock (GStaticRecMutex* mutex)
1469 {
1470   GSystemThread self;
1471
1472   g_return_val_if_fail (mutex, FALSE);
1473
1474   if (!g_thread_supported ())
1475     return TRUE;
1476
1477   G_THREAD_UF (thread_self, (&self));
1478
1479   if (g_system_thread_equal (self, mutex->owner))
1480     {
1481       mutex->depth++;
1482       return TRUE;
1483     }
1484
1485   if (!g_static_mutex_trylock (&mutex->mutex))
1486     return FALSE;
1487
1488   g_system_thread_assign (mutex->owner, self);
1489   mutex->depth = 1;
1490   return TRUE;
1491 }
1492
1493 /**
1494  * g_static_rec_mutex_unlock:
1495  * @mutex: a #GStaticRecMutex to unlock.
1496  *
1497  * Unlocks @mutex. Another thread will be allowed to lock @mutex only
1498  * when it has been unlocked as many times as it had been locked
1499  * before. If @mutex is completely unlocked and another thread is
1500  * blocked in a g_static_rec_mutex_lock() call for @mutex, it will be
1501  * woken and can lock @mutex itself.
1502  **/
1503 void
1504 g_static_rec_mutex_unlock (GStaticRecMutex* mutex)
1505 {
1506   g_return_if_fail (mutex);
1507
1508   if (!g_thread_supported ())
1509     return;
1510
1511   if (mutex->depth > 1)
1512     {
1513       mutex->depth--;
1514       return;
1515     }
1516   g_system_thread_assign (mutex->owner, zero_thread);
1517   g_static_mutex_unlock (&mutex->mutex);
1518 }
1519
1520 /**
1521  * g_static_rec_mutex_lock_full:
1522  * @mutex: a #GStaticRecMutex to lock.
1523  * @depth: number of times this mutex has to be unlocked to be
1524  *         completely unlocked.
1525  *
1526  * Works like calling g_static_rec_mutex_lock() for @mutex @depth times.
1527  **/
1528 void
1529 g_static_rec_mutex_lock_full   (GStaticRecMutex *mutex,
1530                                 guint            depth)
1531 {
1532   GSystemThread self;
1533   g_return_if_fail (mutex);
1534
1535   if (!g_thread_supported ())
1536     return;
1537
1538   if (depth == 0)
1539     return;
1540
1541   G_THREAD_UF (thread_self, (&self));
1542
1543   if (g_system_thread_equal (self, mutex->owner))
1544     {
1545       mutex->depth += depth;
1546       return;
1547     }
1548   g_static_mutex_lock (&mutex->mutex);
1549   g_system_thread_assign (mutex->owner, self);
1550   mutex->depth = depth;
1551 }
1552
1553 /**
1554  * g_static_rec_mutex_unlock_full:
1555  * @mutex: a #GStaticRecMutex to completely unlock.
1556  * @Returns: number of times @mutex has been locked by the current
1557  *           thread.
1558  *
1559  * Completely unlocks @mutex. If another thread is blocked in a
1560  * g_static_rec_mutex_lock() call for @mutex, it will be woken and can
1561  * lock @mutex itself. This function returns the number of times that
1562  * @mutex has been locked by the current thread. To restore the state
1563  * before the call to g_static_rec_mutex_unlock_full() you can call
1564  * g_static_rec_mutex_lock_full() with the depth returned by this
1565  * function.
1566  **/
1567 guint
1568 g_static_rec_mutex_unlock_full (GStaticRecMutex *mutex)
1569 {
1570   guint depth;
1571
1572   g_return_val_if_fail (mutex, 0);
1573
1574   if (!g_thread_supported ())
1575     return 1;
1576
1577   depth = mutex->depth;
1578
1579   g_system_thread_assign (mutex->owner, zero_thread);
1580   mutex->depth = 0;
1581   g_static_mutex_unlock (&mutex->mutex);
1582
1583   return depth;
1584 }
1585
1586 /**
1587  * g_static_rec_mutex_free:
1588  * @mutex: a #GStaticRecMutex to be freed.
1589  *
1590  * Releases all resources allocated to a #GStaticRecMutex.
1591  *
1592  * You don't have to call this functions for a #GStaticRecMutex with an
1593  * unbounded lifetime, i.e. objects declared 'static', but if you have
1594  * a #GStaticRecMutex as a member of a structure and the structure is
1595  * freed, you should also free the #GStaticRecMutex.
1596  **/
1597 void
1598 g_static_rec_mutex_free (GStaticRecMutex *mutex)
1599 {
1600   g_return_if_fail (mutex);
1601
1602   g_static_mutex_free (&mutex->mutex);
1603 }
1604
1605 /* GStaticPrivate {{{1 ---------------------------------------------------- */
1606
1607 /**
1608  * GStaticPrivate:
1609  *
1610  * A #GStaticPrivate works almost like a #GPrivate, but it has one
1611  * significant advantage. It doesn't need to be created at run-time
1612  * like a #GPrivate, but can be defined at compile-time. This is
1613  * similar to the difference between #GMutex and #GStaticMutex. Now
1614  * look at our <function>give_me_next_number()</function> example with
1615  * #GStaticPrivate:
1616  *
1617  * <example>
1618  *  <title>Using GStaticPrivate for per-thread data</title>
1619  *  <programlisting>
1620  *   int
1621  *   give_me_next_number (<!-- -->)
1622  *   {
1623  *     static GStaticPrivate current_number_key = G_STATIC_PRIVATE_INIT;
1624  *     int *current_number = g_static_private_get (&amp;current_number_key);
1625  *
1626  *     if (!current_number)
1627  *       {
1628  *         current_number = g_new (int,1);
1629  *         *current_number = 0;
1630  *         g_static_private_set (&amp;current_number_key, current_number, g_free);
1631  *       }
1632  *
1633  *     *current_number = calc_next_number (*current_number);
1634  *
1635  *     return *current_number;
1636  *   }
1637  *  </programlisting>
1638  * </example>
1639  **/
1640
1641 /**
1642  * G_STATIC_PRIVATE_INIT:
1643  *
1644  * Every #GStaticPrivate must be initialized with this macro, before it
1645  * can be used.
1646  *
1647  * <informalexample>
1648  *  <programlisting>
1649  *   GStaticPrivate my_private = G_STATIC_PRIVATE_INIT;
1650  *  </programlisting>
1651  * </informalexample>
1652  **/
1653
1654 /**
1655  * g_static_private_init:
1656  * @private_key: a #GStaticPrivate to be initialized.
1657  *
1658  * Initializes @private_key. Alternatively you can initialize it with
1659  * #G_STATIC_PRIVATE_INIT.
1660  **/
1661 void
1662 g_static_private_init (GStaticPrivate *private_key)
1663 {
1664   private_key->index = 0;
1665 }
1666
1667 /**
1668  * g_static_private_get:
1669  * @private_key: a #GStaticPrivate.
1670  * @Returns: the corresponding pointer.
1671  *
1672  * Works like g_private_get() only for a #GStaticPrivate.
1673  *
1674  * This function works even if g_thread_init() has not yet been called.
1675  **/
1676 gpointer
1677 g_static_private_get (GStaticPrivate *private_key)
1678 {
1679   GRealThread *self = (GRealThread*) g_thread_self ();
1680   GArray *array;
1681   gpointer ret = NULL;
1682
1683   LOCK_PRIVATE_DATA (self);
1684
1685   array = self->private_data;
1686
1687   if (array && private_key->index != 0 && private_key->index <= array->len)
1688     ret = g_array_index (array, GStaticPrivateNode,
1689                          private_key->index - 1).data;
1690
1691   UNLOCK_PRIVATE_DATA (self);
1692   return ret;
1693 }
1694
1695 /**
1696  * g_static_private_set:
1697  * @private_key: a #GStaticPrivate.
1698  * @data: the new pointer.
1699  * @notify: a function to be called with the pointer whenever the
1700  *          current thread ends or sets this pointer again.
1701  *
1702  * Sets the pointer keyed to @private_key for the current thread and
1703  * the function @notify to be called with that pointer (%NULL or
1704  * non-%NULL), whenever the pointer is set again or whenever the
1705  * current thread ends.
1706  *
1707  * This function works even if g_thread_init() has not yet been called.
1708  * If g_thread_init() is called later, the @data keyed to @private_key
1709  * will be inherited only by the main thread, i.e. the one that called
1710  * g_thread_init().
1711  *
1712  * <note><para>@notify is used quite differently from @destructor in
1713  * g_private_new().</para></note>
1714  **/
1715 void
1716 g_static_private_set (GStaticPrivate *private_key,
1717                       gpointer        data,
1718                       GDestroyNotify  notify)
1719 {
1720   GRealThread *self = (GRealThread*) g_thread_self ();
1721   GArray *array;
1722   static guint next_index = 0;
1723   GStaticPrivateNode *node;
1724   gpointer ddata = NULL;
1725   GDestroyNotify ddestroy = NULL;
1726
1727   if (!private_key->index)
1728     {
1729       G_LOCK (g_thread);
1730
1731       if (!private_key->index)
1732         {
1733           if (g_thread_free_indices)
1734             {
1735               private_key->index =
1736                 GPOINTER_TO_UINT (g_thread_free_indices->data);
1737               g_thread_free_indices =
1738                 g_slist_delete_link (g_thread_free_indices,
1739                                      g_thread_free_indices);
1740             }
1741           else
1742             private_key->index = ++next_index;
1743         }
1744
1745       G_UNLOCK (g_thread);
1746     }
1747
1748   LOCK_PRIVATE_DATA (self);
1749
1750   array = self->private_data;
1751   if (!array)
1752     {
1753       array = g_array_new (FALSE, TRUE, sizeof (GStaticPrivateNode));
1754       self->private_data = array;
1755     }
1756
1757   if (private_key->index > array->len)
1758     g_array_set_size (array, private_key->index);
1759
1760   node = &g_array_index (array, GStaticPrivateNode, private_key->index - 1);
1761
1762   ddata = node->data;
1763   ddestroy = node->destroy;
1764
1765   node->data = data;
1766   node->destroy = notify;
1767
1768   UNLOCK_PRIVATE_DATA (self);
1769
1770   if (ddestroy)
1771     ddestroy (ddata);
1772 }
1773
1774 /**
1775  * g_static_private_free:
1776  * @private_key: a #GStaticPrivate to be freed.
1777  *
1778  * Releases all resources allocated to @private_key.
1779  *
1780  * You don't have to call this functions for a #GStaticPrivate with an
1781  * unbounded lifetime, i.e. objects declared 'static', but if you have
1782  * a #GStaticPrivate as a member of a structure and the structure is
1783  * freed, you should also free the #GStaticPrivate.
1784  **/
1785 void
1786 g_static_private_free (GStaticPrivate *private_key)
1787 {
1788   guint idx = private_key->index;
1789   GRealThread *thread, *next;
1790   GArray *garbage = NULL;
1791
1792   if (!idx)
1793     return;
1794
1795   private_key->index = 0;
1796
1797   G_LOCK (g_thread);
1798
1799   thread = g_thread_all_threads;
1800
1801   for (thread = g_thread_all_threads; thread; thread = next)
1802     {
1803       GArray *array;
1804
1805       next = thread->next;
1806
1807       LOCK_PRIVATE_DATA (thread);
1808
1809       array = thread->private_data;
1810
1811       if (array && idx <= array->len)
1812         {
1813           GStaticPrivateNode *node = &g_array_index (array,
1814                                                      GStaticPrivateNode,
1815                                                      idx - 1);
1816           gpointer ddata = node->data;
1817           GDestroyNotify ddestroy = node->destroy;
1818
1819           node->data = NULL;
1820           node->destroy = NULL;
1821
1822           if (ddestroy)
1823             {
1824               /* defer non-trivial destruction til after we've finished
1825                * iterating, since we must continue to hold the lock */
1826               if (garbage == NULL)
1827                 garbage = g_array_new (FALSE, TRUE,
1828                                        sizeof (GStaticPrivateNode));
1829
1830               g_array_set_size (garbage, garbage->len + 1);
1831
1832               node = &g_array_index (garbage, GStaticPrivateNode,
1833                                      garbage->len - 1);
1834               node->data = ddata;
1835               node->destroy = ddestroy;
1836             }
1837         }
1838
1839       UNLOCK_PRIVATE_DATA (thread);
1840     }
1841   g_thread_free_indices = g_slist_prepend (g_thread_free_indices,
1842                                            GUINT_TO_POINTER (idx));
1843   G_UNLOCK (g_thread);
1844
1845   if (garbage)
1846     {
1847       guint i;
1848
1849       for (i = 0; i < garbage->len; i++)
1850         {
1851           GStaticPrivateNode *node;
1852
1853           node = &g_array_index (garbage, GStaticPrivateNode, i);
1854           node->destroy (node->data);
1855         }
1856
1857       g_array_free (garbage, TRUE);
1858     }
1859 }
1860
1861 /* GThread Extra Functions {{{1 ------------------------------------------- */
1862 static void
1863 g_thread_cleanup (gpointer data)
1864 {
1865   if (data)
1866     {
1867       GRealThread* thread = data;
1868       GArray *array;
1869
1870       LOCK_PRIVATE_DATA (thread);
1871       array = thread->private_data;
1872       thread->private_data = NULL;
1873       UNLOCK_PRIVATE_DATA (thread);
1874
1875       if (array)
1876         {
1877           guint i;
1878
1879           for (i = 0; i < array->len; i++ )
1880             {
1881               GStaticPrivateNode *node =
1882                 &g_array_index (array, GStaticPrivateNode, i);
1883               if (node->destroy)
1884                 node->destroy (node->data);
1885             }
1886           g_array_free (array, TRUE);
1887         }
1888
1889       /* We only free the thread structure, if it isn't joinable. If
1890          it is, the structure is freed in g_thread_join */
1891       if (!thread->thread.joinable)
1892         {
1893           GRealThread *t, *p;
1894
1895           G_LOCK (g_thread);
1896           for (t = g_thread_all_threads, p = NULL; t; p = t, t = t->next)
1897             {
1898               if (t == thread)
1899                 {
1900                   if (p)
1901                     p->next = t->next;
1902                   else
1903                     g_thread_all_threads = t->next;
1904                   break;
1905                 }
1906             }
1907           G_UNLOCK (g_thread);
1908
1909           /* Just to make sure, this isn't used any more */
1910           g_system_thread_assign (thread->system_thread, zero_thread);
1911           g_free (thread);
1912         }
1913     }
1914 }
1915
1916 static void
1917 g_thread_fail (void)
1918 {
1919   g_error ("The thread system is not yet initialized.");
1920 }
1921
1922 #define G_NSEC_PER_SEC 1000000000
1923
1924 static guint64
1925 gettime (void)
1926 {
1927   return g_get_monotonic_time () * 1000;
1928 }
1929
1930 static gpointer
1931 g_thread_create_proxy (gpointer data)
1932 {
1933   GRealThread* thread = data;
1934
1935   g_assert (data);
1936
1937   /* This has to happen before G_LOCK, as that might call g_thread_self */
1938   g_private_set (g_thread_specific_private, data);
1939
1940   /* the lock makes sure, that thread->system_thread is written,
1941      before thread->thread.func is called. See g_thread_create. */
1942   G_LOCK (g_thread);
1943   G_UNLOCK (g_thread);
1944
1945   thread->retval = thread->thread.func (thread->thread.data);
1946
1947   return NULL;
1948 }
1949
1950 /**
1951  * g_thread_create_full:
1952  * @func: a function to execute in the new thread.
1953  * @data: an argument to supply to the new thread.
1954  * @stack_size: a stack size for the new thread.
1955  * @joinable: should this thread be joinable?
1956  * @bound: should this thread be bound to a system thread?
1957  * @priority: a priority for the thread.
1958  * @error: return location for error.
1959  * @Returns: the new #GThread on success.
1960  *
1961  * This function creates a new thread with the priority @priority. If
1962  * the underlying thread implementation supports it, the thread gets a
1963  * stack size of @stack_size or the default value for the current
1964  * platform, if @stack_size is 0.
1965  *
1966  * If @joinable is %TRUE, you can wait for this threads termination
1967  * calling g_thread_join(). Otherwise the thread will just disappear
1968  * when it terminates. If @bound is %TRUE, this thread will be
1969  * scheduled in the system scope, otherwise the implementation is free
1970  * to do scheduling in the process scope. The first variant is more
1971  * expensive resource-wise, but generally faster. On some systems (e.g.
1972  * Linux) all threads are bound.
1973  *
1974  * The new thread executes the function @func with the argument @data.
1975  * If the thread was created successfully, it is returned.
1976  *
1977  * @error can be %NULL to ignore errors, or non-%NULL to report errors.
1978  * The error is set, if and only if the function returns %NULL.
1979  *
1980  * <note><para>It is not guaranteed that threads with different priorities
1981  * really behave accordingly. On some systems (e.g. Linux) there are no
1982  * thread priorities. On other systems (e.g. Solaris) there doesn't
1983  * seem to be different scheduling for different priorities. All in all
1984  * try to avoid being dependent on priorities. Use
1985  * %G_THREAD_PRIORITY_NORMAL here as a default.</para></note>
1986  *
1987  * <note><para>Only use g_thread_create_full() if you really can't use
1988  * g_thread_create() instead. g_thread_create() does not take
1989  * @stack_size, @bound, and @priority as arguments, as they should only
1990  * be used in cases in which it is unavoidable.</para></note>
1991  **/
1992 GThread*
1993 g_thread_create_full (GThreadFunc       func,
1994                       gpointer          data,
1995                       gulong            stack_size,
1996                       gboolean          joinable,
1997                       gboolean          bound,
1998                       GThreadPriority   priority,
1999                       GError          **error)
2000 {
2001   GRealThread* result;
2002   GError *local_error = NULL;
2003   g_return_val_if_fail (func, NULL);
2004   g_return_val_if_fail (priority >= G_THREAD_PRIORITY_LOW, NULL);
2005   g_return_val_if_fail (priority <= G_THREAD_PRIORITY_URGENT, NULL);
2006
2007   result = g_new0 (GRealThread, 1);
2008
2009   result->thread.joinable = joinable;
2010   result->thread.priority = priority;
2011   result->thread.func = func;
2012   result->thread.data = data;
2013   result->private_data = NULL;
2014   G_LOCK (g_thread);
2015   G_THREAD_UF (thread_create, (g_thread_create_proxy, result,
2016                                stack_size, joinable, bound, priority,
2017                                &result->system_thread, &local_error));
2018   if (!local_error)
2019     {
2020       result->next = g_thread_all_threads;
2021       g_thread_all_threads = result;
2022     }
2023   G_UNLOCK (g_thread);
2024
2025   if (local_error)
2026     {
2027       g_propagate_error (error, local_error);
2028       g_free (result);
2029       return NULL;
2030     }
2031
2032   return (GThread*) result;
2033 }
2034
2035 /**
2036  * g_thread_exit:
2037  * @retval: the return value of this thread.
2038  *
2039  * Exits the current thread. If another thread is waiting for that
2040  * thread using g_thread_join() and the current thread is joinable, the
2041  * waiting thread will be woken up and get @retval as the return value
2042  * of g_thread_join(). If the current thread is not joinable, @retval
2043  * is ignored. Calling
2044  *
2045  * <informalexample>
2046  *  <programlisting>
2047  *   g_thread_exit (retval);
2048  *  </programlisting>
2049  * </informalexample>
2050  *
2051  * is equivalent to returning @retval from the function @func, as given
2052  * to g_thread_create().
2053  *
2054  * <note><para>Never call g_thread_exit() from within a thread of a
2055  * #GThreadPool, as that will mess up the bookkeeping and lead to funny
2056  * and unwanted results.</para></note>
2057  **/
2058 void
2059 g_thread_exit (gpointer retval)
2060 {
2061   GRealThread* real = (GRealThread*) g_thread_self ();
2062   real->retval = retval;
2063   G_THREAD_CF (thread_exit, (void)0, ());
2064 }
2065
2066 /**
2067  * g_thread_join:
2068  * @thread: a #GThread to be waited for.
2069  * @Returns: the return value of the thread.
2070  *
2071  * Waits until @thread finishes, i.e. the function @func, as given to
2072  * g_thread_create(), returns or g_thread_exit() is called by @thread.
2073  * All resources of @thread including the #GThread struct are released.
2074  * @thread must have been created with @joinable=%TRUE in
2075  * g_thread_create(). The value returned by @func or given to
2076  * g_thread_exit() by @thread is returned by this function.
2077  **/
2078 gpointer
2079 g_thread_join (GThread* thread)
2080 {
2081   GRealThread* real = (GRealThread*) thread;
2082   GRealThread *p, *t;
2083   gpointer retval;
2084
2085   g_return_val_if_fail (thread, NULL);
2086   g_return_val_if_fail (thread->joinable, NULL);
2087   g_return_val_if_fail (!g_system_thread_equal (real->system_thread,
2088                                                 zero_thread), NULL);
2089
2090   G_THREAD_UF (thread_join, (&real->system_thread));
2091
2092   retval = real->retval;
2093
2094   G_LOCK (g_thread);
2095   for (t = g_thread_all_threads, p = NULL; t; p = t, t = t->next)
2096     {
2097       if (t == (GRealThread*) thread)
2098         {
2099           if (p)
2100             p->next = t->next;
2101           else
2102             g_thread_all_threads = t->next;
2103           break;
2104         }
2105     }
2106   G_UNLOCK (g_thread);
2107
2108   /* Just to make sure, this isn't used any more */
2109   thread->joinable = 0;
2110   g_system_thread_assign (real->system_thread, zero_thread);
2111
2112   /* the thread structure for non-joinable threads is freed upon
2113      thread end. We free the memory here. This will leave a loose end,
2114      if a joinable thread is not joined. */
2115
2116   g_free (thread);
2117
2118   return retval;
2119 }
2120
2121 /**
2122  * g_thread_set_priority:
2123  * @thread: a #GThread.
2124  * @priority: a new priority for @thread.
2125  *
2126  * Changes the priority of @thread to @priority.
2127  *
2128  * <note><para>It is not guaranteed that threads with different
2129  * priorities really behave accordingly. On some systems (e.g. Linux)
2130  * there are no thread priorities. On other systems (e.g. Solaris) there
2131  * doesn't seem to be different scheduling for different priorities. All
2132  * in all try to avoid being dependent on priorities.</para></note>
2133  **/
2134 void
2135 g_thread_set_priority (GThread* thread,
2136                        GThreadPriority priority)
2137 {
2138   GRealThread* real = (GRealThread*) thread;
2139
2140   g_return_if_fail (thread);
2141   g_return_if_fail (!g_system_thread_equal (real->system_thread, zero_thread));
2142   g_return_if_fail (priority >= G_THREAD_PRIORITY_LOW);
2143   g_return_if_fail (priority <= G_THREAD_PRIORITY_URGENT);
2144
2145   thread->priority = priority;
2146
2147   G_THREAD_CF (thread_set_priority, (void)0,
2148                (&real->system_thread, priority));
2149 }
2150
2151 /**
2152  * g_thread_self:
2153  * @Returns: the current thread.
2154  *
2155  * This functions returns the #GThread corresponding to the calling
2156  * thread.
2157  **/
2158 GThread*
2159 g_thread_self (void)
2160 {
2161   GRealThread* thread = g_private_get (g_thread_specific_private);
2162
2163   if (!thread)
2164     {
2165       /* If no thread data is available, provide and set one.  This
2166          can happen for the main thread and for threads, that are not
2167          created by GLib. */
2168       thread = g_new0 (GRealThread, 1);
2169       thread->thread.joinable = FALSE; /* This is a save guess */
2170       thread->thread.priority = G_THREAD_PRIORITY_NORMAL; /* This is
2171                                                              just a guess */
2172       thread->thread.func = NULL;
2173       thread->thread.data = NULL;
2174       thread->private_data = NULL;
2175
2176       if (g_thread_supported ())
2177         G_THREAD_UF (thread_self, (&thread->system_thread));
2178
2179       g_private_set (g_thread_specific_private, thread);
2180
2181       G_LOCK (g_thread);
2182       thread->next = g_thread_all_threads;
2183       g_thread_all_threads = thread;
2184       G_UNLOCK (g_thread);
2185     }
2186
2187   return (GThread*)thread;
2188 }
2189
2190 /* GStaticRWLock {{{1 ----------------------------------------------------- */
2191
2192 /**
2193  * GStaticRWLock:
2194  *
2195  * The #GStaticRWLock struct represents a read-write lock. A read-write
2196  * lock can be used for protecting data that some portions of code only
2197  * read from, while others also write. In such situations it is
2198  * desirable that several readers can read at once, whereas of course
2199  * only one writer may write at a time. Take a look at the following
2200  * example:
2201  *
2202  * <example>
2203  *  <title>An array with access functions</title>
2204  *  <programlisting>
2205  *   GStaticRWLock rwlock = G_STATIC_RW_LOCK_INIT;
2206  *   GPtrArray *array;
2207  *
2208  *   gpointer
2209  *   my_array_get (guint index)
2210  *   {
2211  *     gpointer retval = NULL;
2212  *
2213  *     if (!array)
2214  *       return NULL;
2215  *
2216  *     g_static_rw_lock_reader_lock (&amp;rwlock);
2217  *     if (index &lt; array->len)
2218  *       retval = g_ptr_array_index (array, index);
2219  *     g_static_rw_lock_reader_unlock (&amp;rwlock);
2220  *
2221  *     return retval;
2222  *   }
2223  *
2224  *   void
2225  *   my_array_set (guint index, gpointer data)
2226  *   {
2227  *     g_static_rw_lock_writer_lock (&amp;rwlock);
2228  *
2229  *     if (!array)
2230  *       array = g_ptr_array_new (<!-- -->);
2231  *
2232  *     if (index >= array->len)
2233  *       g_ptr_array_set_size (array, index+1);
2234  *     g_ptr_array_index (array, index) = data;
2235  *
2236  *     g_static_rw_lock_writer_unlock (&amp;rwlock);
2237  *   }
2238  *  </programlisting>
2239  * </example>
2240  *
2241  * This example shows an array which can be accessed by many readers
2242  * (the <function>my_array_get()</function> function) simultaneously,
2243  * whereas the writers (the <function>my_array_set()</function>
2244  * function) will only be allowed once at a time and only if no readers
2245  * currently access the array. This is because of the potentially
2246  * dangerous resizing of the array. Using these functions is fully
2247  * multi-thread safe now.
2248  *
2249  * Most of the time, writers should have precedence over readers. That
2250  * means, for this implementation, that as soon as a writer wants to
2251  * lock the data, no other reader is allowed to lock the data, whereas,
2252  * of course, the readers that already have locked the data are allowed
2253  * to finish their operation. As soon as the last reader unlocks the
2254  * data, the writer will lock it.
2255  *
2256  * Even though #GStaticRWLock is not opaque, it should only be used
2257  * with the following functions.
2258  *
2259  * All of the <function>g_static_rw_lock_*</function> functions can be
2260  * used even if g_thread_init() has not been called. Then they do
2261  * nothing, apart from <function>g_static_rw_lock_*_trylock</function>,
2262  * which does nothing but returning %TRUE.
2263  *
2264  * <note><para>A read-write lock has a higher overhead than a mutex. For
2265  * example, both g_static_rw_lock_reader_lock() and
2266  * g_static_rw_lock_reader_unlock() have to lock and unlock a
2267  * #GStaticMutex, so it takes at least twice the time to lock and unlock
2268  * a #GStaticRWLock that it does to lock and unlock a #GStaticMutex. So
2269  * only data structures that are accessed by multiple readers, and which
2270  * keep the lock for a considerable time justify a #GStaticRWLock. The
2271  * above example most probably would fare better with a
2272  * #GStaticMutex.</para></note>
2273  **/
2274
2275 /**
2276  * G_STATIC_RW_LOCK_INIT:
2277  *
2278  * A #GStaticRWLock must be initialized with this macro before it can
2279  * be used. This macro can used be to initialize a variable, but it
2280  * cannot be assigned to a variable. In that case you have to use
2281  * g_static_rw_lock_init().
2282  *
2283  * <informalexample>
2284  *  <programlisting>
2285  *   GStaticRWLock my_lock = G_STATIC_RW_LOCK_INIT;
2286  *  </programlisting>
2287  * </informalexample>
2288  **/
2289
2290 /**
2291  * g_static_rw_lock_init:
2292  * @lock: a #GStaticRWLock to be initialized.
2293  *
2294  * A #GStaticRWLock must be initialized with this function before it
2295  * can be used. Alternatively you can initialize it with
2296  * #G_STATIC_RW_LOCK_INIT.
2297  **/
2298 void
2299 g_static_rw_lock_init (GStaticRWLock* lock)
2300 {
2301   static const GStaticRWLock init_lock = G_STATIC_RW_LOCK_INIT;
2302
2303   g_return_if_fail (lock);
2304
2305   *lock = init_lock;
2306 }
2307
2308 inline static void
2309 g_static_rw_lock_wait (GCond** cond, GStaticMutex* mutex)
2310 {
2311   if (!*cond)
2312       *cond = g_cond_new ();
2313   g_cond_wait (*cond, g_static_mutex_get_mutex (mutex));
2314 }
2315
2316 inline static void
2317 g_static_rw_lock_signal (GStaticRWLock* lock)
2318 {
2319   if (lock->want_to_write && lock->write_cond)
2320     g_cond_signal (lock->write_cond);
2321   else if (lock->want_to_read && lock->read_cond)
2322     g_cond_broadcast (lock->read_cond);
2323 }
2324
2325 /**
2326  * g_static_rw_lock_reader_lock:
2327  * @lock: a #GStaticRWLock to lock for reading.
2328  *
2329  * Locks @lock for reading. There may be unlimited concurrent locks for
2330  * reading of a #GStaticRWLock at the same time.  If @lock is already
2331  * locked for writing by another thread or if another thread is already
2332  * waiting to lock @lock for writing, this function will block until
2333  * @lock is unlocked by the other writing thread and no other writing
2334  * threads want to lock @lock. This lock has to be unlocked by
2335  * g_static_rw_lock_reader_unlock().
2336  *
2337  * #GStaticRWLock is not recursive. It might seem to be possible to
2338  * recursively lock for reading, but that can result in a deadlock, due
2339  * to writer preference.
2340  **/
2341 void
2342 g_static_rw_lock_reader_lock (GStaticRWLock* lock)
2343 {
2344   g_return_if_fail (lock);
2345
2346   if (!g_threads_got_initialized)
2347     return;
2348
2349   g_static_mutex_lock (&lock->mutex);
2350   lock->want_to_read++;
2351   while (lock->have_writer || lock->want_to_write)
2352     g_static_rw_lock_wait (&lock->read_cond, &lock->mutex);
2353   lock->want_to_read--;
2354   lock->read_counter++;
2355   g_static_mutex_unlock (&lock->mutex);
2356 }
2357
2358 /**
2359  * g_static_rw_lock_reader_trylock:
2360  * @lock: a #GStaticRWLock to lock for reading.
2361  * @Returns: %TRUE, if @lock could be locked for reading.
2362  *
2363  * Tries to lock @lock for reading. If @lock is already locked for
2364  * writing by another thread or if another thread is already waiting to
2365  * lock @lock for writing, immediately returns %FALSE. Otherwise locks
2366  * @lock for reading and returns %TRUE. This lock has to be unlocked by
2367  * g_static_rw_lock_reader_unlock().
2368  **/
2369 gboolean
2370 g_static_rw_lock_reader_trylock (GStaticRWLock* lock)
2371 {
2372   gboolean ret_val = FALSE;
2373
2374   g_return_val_if_fail (lock, FALSE);
2375
2376   if (!g_threads_got_initialized)
2377     return TRUE;
2378
2379   g_static_mutex_lock (&lock->mutex);
2380   if (!lock->have_writer && !lock->want_to_write)
2381     {
2382       lock->read_counter++;
2383       ret_val = TRUE;
2384     }
2385   g_static_mutex_unlock (&lock->mutex);
2386   return ret_val;
2387 }
2388
2389 /**
2390  * g_static_rw_lock_reader_unlock:
2391  * @lock: a #GStaticRWLock to unlock after reading.
2392  *
2393  * Unlocks @lock. If a thread waits to lock @lock for writing and all
2394  * locks for reading have been unlocked, the waiting thread is woken up
2395  * and can lock @lock for writing.
2396  **/
2397 void
2398 g_static_rw_lock_reader_unlock  (GStaticRWLock* lock)
2399 {
2400   g_return_if_fail (lock);
2401
2402   if (!g_threads_got_initialized)
2403     return;
2404
2405   g_static_mutex_lock (&lock->mutex);
2406   lock->read_counter--;
2407   if (lock->read_counter == 0)
2408     g_static_rw_lock_signal (lock);
2409   g_static_mutex_unlock (&lock->mutex);
2410 }
2411
2412 /**
2413  * g_static_rw_lock_writer_lock:
2414  * @lock: a #GStaticRWLock to lock for writing.
2415  *
2416  * Locks @lock for writing. If @lock is already locked for writing or
2417  * reading by other threads, this function will block until @lock is
2418  * completely unlocked and then lock @lock for writing. While this
2419  * functions waits to lock @lock, no other thread can lock @lock for
2420  * reading. When @lock is locked for writing, no other thread can lock
2421  * @lock (neither for reading nor writing). This lock has to be
2422  * unlocked by g_static_rw_lock_writer_unlock().
2423  **/
2424 void
2425 g_static_rw_lock_writer_lock (GStaticRWLock* lock)
2426 {
2427   g_return_if_fail (lock);
2428
2429   if (!g_threads_got_initialized)
2430     return;
2431
2432   g_static_mutex_lock (&lock->mutex);
2433   lock->want_to_write++;
2434   while (lock->have_writer || lock->read_counter)
2435     g_static_rw_lock_wait (&lock->write_cond, &lock->mutex);
2436   lock->want_to_write--;
2437   lock->have_writer = TRUE;
2438   g_static_mutex_unlock (&lock->mutex);
2439 }
2440
2441 /**
2442  * g_static_rw_lock_writer_trylock:
2443  * @lock: a #GStaticRWLock to lock for writing.
2444  * @Returns: %TRUE, if @lock could be locked for writing.
2445  *
2446  * Tries to lock @lock for writing. If @lock is already locked (for
2447  * either reading or writing) by another thread, it immediately returns
2448  * %FALSE. Otherwise it locks @lock for writing and returns %TRUE. This
2449  * lock has to be unlocked by g_static_rw_lock_writer_unlock().
2450  **/
2451 gboolean
2452 g_static_rw_lock_writer_trylock (GStaticRWLock* lock)
2453 {
2454   gboolean ret_val = FALSE;
2455
2456   g_return_val_if_fail (lock, FALSE);
2457
2458   if (!g_threads_got_initialized)
2459     return TRUE;
2460
2461   g_static_mutex_lock (&lock->mutex);
2462   if (!lock->have_writer && !lock->read_counter)
2463     {
2464       lock->have_writer = TRUE;
2465       ret_val = TRUE;
2466     }
2467   g_static_mutex_unlock (&lock->mutex);
2468   return ret_val;
2469 }
2470
2471 /**
2472  * g_static_rw_lock_writer_unlock:
2473  * @lock: a #GStaticRWLock to unlock after writing.
2474  *
2475  * Unlocks @lock. If a thread is waiting to lock @lock for writing and
2476  * all locks for reading have been unlocked, the waiting thread is
2477  * woken up and can lock @lock for writing. If no thread is waiting to
2478  * lock @lock for writing, and some thread or threads are waiting to
2479  * lock @lock for reading, the waiting threads are woken up and can
2480  * lock @lock for reading.
2481  **/
2482 void
2483 g_static_rw_lock_writer_unlock (GStaticRWLock* lock)
2484 {
2485   g_return_if_fail (lock);
2486
2487   if (!g_threads_got_initialized)
2488     return;
2489
2490   g_static_mutex_lock (&lock->mutex);
2491   lock->have_writer = FALSE;
2492   g_static_rw_lock_signal (lock);
2493   g_static_mutex_unlock (&lock->mutex);
2494 }
2495
2496 /**
2497  * g_static_rw_lock_free:
2498  * @lock: a #GStaticRWLock to be freed.
2499  *
2500  * Releases all resources allocated to @lock.
2501  *
2502  * You don't have to call this functions for a #GStaticRWLock with an
2503  * unbounded lifetime, i.e. objects declared 'static', but if you have
2504  * a #GStaticRWLock as a member of a structure, and the structure is
2505  * freed, you should also free the #GStaticRWLock.
2506  **/
2507 void
2508 g_static_rw_lock_free (GStaticRWLock* lock)
2509 {
2510   g_return_if_fail (lock);
2511
2512   if (lock->read_cond)
2513     {
2514       g_cond_free (lock->read_cond);
2515       lock->read_cond = NULL;
2516     }
2517   if (lock->write_cond)
2518     {
2519       g_cond_free (lock->write_cond);
2520       lock->write_cond = NULL;
2521     }
2522   g_static_mutex_free (&lock->mutex);
2523 }
2524
2525 /* Unsorted {{{1 ---------------------------------------------------------- */
2526
2527 /**
2528  * g_thread_foreach
2529  * @thread_func: function to call for all GThread structures
2530  * @user_data:   second argument to @thread_func
2531  *
2532  * Call @thread_func on all existing #GThread structures. Note that
2533  * threads may decide to exit while @thread_func is running, so
2534  * without intimate knowledge about the lifetime of foreign threads,
2535  * @thread_func shouldn't access the GThread* pointer passed in as
2536  * first argument. However, @thread_func will not be called for threads
2537  * which are known to have exited already.
2538  *
2539  * Due to thread lifetime checks, this function has an execution complexity
2540  * which is quadratic in the number of existing threads.
2541  *
2542  * Since: 2.10
2543  */
2544 void
2545 g_thread_foreach (GFunc    thread_func,
2546                   gpointer user_data)
2547 {
2548   GSList *slist = NULL;
2549   GRealThread *thread;
2550   g_return_if_fail (thread_func != NULL);
2551   /* snapshot the list of threads for iteration */
2552   G_LOCK (g_thread);
2553   for (thread = g_thread_all_threads; thread; thread = thread->next)
2554     slist = g_slist_prepend (slist, thread);
2555   G_UNLOCK (g_thread);
2556   /* walk the list, skipping non-existent threads */
2557   while (slist)
2558     {
2559       GSList *node = slist;
2560       slist = node->next;
2561       /* check whether the current thread still exists */
2562       G_LOCK (g_thread);
2563       for (thread = g_thread_all_threads; thread; thread = thread->next)
2564         if (thread == node->data)
2565           break;
2566       G_UNLOCK (g_thread);
2567       if (thread)
2568         thread_func (thread, user_data);
2569       g_slist_free_1 (node);
2570     }
2571 }
2572
2573 /**
2574  * g_thread_get_initialized
2575  *
2576  * Indicates if g_thread_init() has been called.
2577  *
2578  * Returns: %TRUE if threads have been initialized.
2579  *
2580  * Since: 2.20
2581  */
2582 gboolean
2583 g_thread_get_initialized ()
2584 {
2585   return g_thread_supported ();
2586 }