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