glib/gthread-posix.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: posix thread system implementation
   5  * Copyright 1998 Sebastian Wilhelmi; University of Karlsruhe
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  */
  22
  23 /*
  24  * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
  25  * file for a list of people on the GLib Team.  See the ChangeLog
  26  * files for a list of changes.  These files are distributed with
  27  * GLib at ftp://ftp.gtk.org/pub/gtk/.
  28  */
  29
  30 /* The GMutex, GCond and GPrivate implementations in this file are some
  31  * of the lowest-level code in GLib.  All other parts of GLib (messages,
  32  * memory, slices, etc) assume that they can freely use these facilities
  33  * without risking recursion.
  34  *
  35  * As such, these functions are NOT permitted to call any other part of
  36  * GLib.
  37  *
  38  * The thread manipulation functions (create, exit, join, etc.) have
  39  * more freedom -- they can do as they please.
  40  */
  41
  42 #include "config.h"
  43
  44 #include "gthread.h"
  45
  46 #include "gthreadprivate.h"
  47 #include "gslice.h"
  48 #include "gmessages.h"
  49 #include "gstrfuncs.h"
  50
  51 #include <stdlib.h>
  52 #include <stdio.h>
  53 #include <string.h>
  54 #include <errno.h>
  55 #include <pthread.h>
  56
  57 #ifdef HAVE_SYS_TIME_H
  58 # include <sys/time.h>
  59 #endif
  60 #ifdef HAVE_UNISTD_H
  61 # include <unistd.h>
  62 #endif
  63 #ifdef HAVE_SCHED_H
  64 #include <sched.h>
  65 #endif
  66 #ifdef HAVE_SYS_PRCTL_H
  67 #include <sys/prctl.h>
  68 #endif
  69
  70 static void
  71 g_thread_abort (gint         status,
  72                 const gchar *function)
  73 {
  74   fprintf (stderr, "GLib (gthread-posix.c): Unexpected error from C library during '%s': %s.  Aborting.\n",
  75            function, strerror (status));
  76   abort ();
  77 }
  78
  79 /* {{{1 GMutex */
  80
  81 static pthread_mutex_t *
  82 g_mutex_impl_new (void)
  83 {
  84   pthread_mutexattr_t *pattr = NULL;
  85   pthread_mutex_t *mutex;
  86   gint status;
  87
  88   mutex = malloc (sizeof (pthread_mutex_t));
  89   if G_UNLIKELY (mutex == NULL)
  90     g_thread_abort (errno, "malloc");
  91
  92 #ifdef PTHREAD_ADAPTIVE_MUTEX_INITIALIZER_NP
  93   {
  94     pthread_mutexattr_t attr;
  95     pthread_mutexattr_init (&attr);
  96     pthread_mutexattr_settype (&attr, PTHREAD_MUTEX_ADAPTIVE_NP);
  97     pattr = &attr;
  98   }
  99 #endif
 100
 101   if G_UNLIKELY ((status = pthread_mutex_init (mutex, pattr)) != 0)
 102     g_thread_abort (status, "pthread_mutex_init");
 103
 104 #ifdef PTHREAD_ADAPTIVE_MUTEX_NP
 105   pthread_mutexattr_destroy (&attr);
 106 #endif
 107
 108   return mutex;
 109 }
 110
 111 static void
 112 g_mutex_impl_free (pthread_mutex_t *mutex)
 113 {
 114   pthread_mutex_destroy (mutex);
 115   free (mutex);
 116 }
 117
 118 static pthread_mutex_t *
 119 g_mutex_get_impl (GMutex *mutex)
 120 {
 121   pthread_mutex_t *impl = g_atomic_pointer_get (&mutex->p);
 122
 123   if G_UNLIKELY (impl == NULL)
 124     {
 125       impl = g_mutex_impl_new ();
 126       if (!g_atomic_pointer_compare_and_exchange (&mutex->p, NULL, impl))
 127         g_mutex_impl_free (impl);
 128       impl = mutex->p;
 129     }
 130
 131   return impl;
 132 }
 133
 134
 135 /**
 136  * g_mutex_init:
 137  * @mutex: an uninitialized #GMutex
 138  *
 139  * Initializes a #GMutex so that it can be used.
 140  *
 141  * This function is useful to initialize a mutex that has been
 142  * allocated on the stack, or as part of a larger structure.
 143  * It is not necessary to initialize a mutex that has been
 144  * statically allocated.
 145  *
 146  * |[
 147  *   typedef struct {
 148  *     GMutex m;
 149  *     ...
 150  *   } Blob;
 151  *
 152  * Blob *b;
 153  *
 154  * b = g_new (Blob, 1);
 155  * g_mutex_init (&b->m);
 156  * ]|
 157  *
 158  * To undo the effect of g_mutex_init() when a mutex is no longer
 159  * needed, use g_mutex_clear().
 160  *
 161  * Calling g_mutex_init() on an already initialized #GMutex leads
 162  * to undefined behaviour.
 163  *
 164  * Since: 2.32
 165  */
 166 void
 167 g_mutex_init (GMutex *mutex)
 168 {
 169   mutex->p = g_mutex_impl_new ();
 170 }
 171
 172 /**
 173  * g_mutex_clear:
 174  * @mutex: an initialized #GMutex
 175  *
 176  * Frees the resources allocated to a mutex with g_mutex_init().
 177  *
 178  * This function should not be used with a #GMutex that has been
 179  * statically allocated.
 180  *
 181  * Calling g_mutex_clear() on a locked mutex leads to undefined
 182  * behaviour.
 183  *
 184  * Sine: 2.32
 185  */
 186 void
 187 g_mutex_clear (GMutex *mutex)
 188 {
 189   g_mutex_impl_free (mutex->p);
 190 }
 191
 192 /**
 193  * g_mutex_lock:
 194  * @mutex: a #GMutex
 195  *
 196  * Locks @mutex. If @mutex is already locked by another thread, the
 197  * current thread will block until @mutex is unlocked by the other
 198  * thread.
 199  *
 200  * <note>#GMutex is neither guaranteed to be recursive nor to be
 201  * non-recursive.  As such, calling g_mutex_lock() on a #GMutex that has
 202  * already been locked by the same thread results in undefined behaviour
 203  * (including but not limited to deadlocks).</note>
 204  */
 205 void
 206 g_mutex_lock (GMutex *mutex)
 207 {
 208   gint status;
 209
 210   if G_UNLIKELY ((status = pthread_mutex_lock (g_mutex_get_impl (mutex))) != 0)
 211     g_thread_abort (status, "pthread_mutex_lock");
 212 }
 213
 214 /**
 215  * g_mutex_unlock:
 216  * @mutex: a #GMutex
 217  *
 218  * Unlocks @mutex. If another thread is blocked in a g_mutex_lock()
 219  * call for @mutex, it will become unblocked and can lock @mutex itself.
 220  *
 221  * Calling g_mutex_unlock() on a mutex that is not locked by the
 222  * current thread leads to undefined behaviour.
 223  */
 224 void
 225 g_mutex_unlock (GMutex *mutex)
 226 {
 227   gint status;
 228
 229   if G_UNLIKELY ((status = pthread_mutex_unlock (g_mutex_get_impl (mutex))) != 0)
 230     g_thread_abort (status, "pthread_mutex_unlock");
 231 }
 232
 233 /**
 234  * g_mutex_trylock:
 235  * @mutex: a #GMutex
 236  *
 237  * Tries to lock @mutex. If @mutex is already locked by another thread,
 238  * it immediately returns %FALSE. Otherwise it locks @mutex and returns
 239  * %TRUE.
 240  *
 241  * <note>#GMutex is neither guaranteed to be recursive nor to be
 242  * non-recursive.  As such, calling g_mutex_lock() on a #GMutex that has
 243  * already been locked by the same thread results in undefined behaviour
 244  * (including but not limited to deadlocks or arbitrary return values).
 245  * </note>
 246
 247  * Returns: %TRUE if @mutex could be locked
 248  */
 249 gboolean
 250 g_mutex_trylock (GMutex *mutex)
 251 {
 252   gint status;
 253
 254   if G_LIKELY ((status = pthread_mutex_trylock (g_mutex_get_impl (mutex))) == 0)
 255     return TRUE;
 256
 257   if G_UNLIKELY (status != EBUSY)
 258     g_thread_abort (status, "pthread_mutex_trylock");
 259
 260   return FALSE;
 261 }
 262
 263 /* {{{1 GRecMutex */
 264
 265 static pthread_mutex_t *
 266 g_rec_mutex_impl_new (void)
 267 {
 268   pthread_mutexattr_t attr;
 269   pthread_mutex_t *mutex;
 270
 271   mutex = g_slice_new (pthread_mutex_t);
 272   pthread_mutexattr_init (&attr);
 273   pthread_mutexattr_settype (&attr, PTHREAD_MUTEX_RECURSIVE);
 274   pthread_mutex_init (mutex, &attr);
 275   pthread_mutexattr_destroy (&attr);
 276
 277   return mutex;
 278 }
 279
 280 static void
 281 g_rec_mutex_impl_free (pthread_mutex_t *mutex)
 282 {
 283   pthread_mutex_destroy (mutex);
 284   g_slice_free (pthread_mutex_t, mutex);
 285 }
 286
 287 static pthread_mutex_t *
 288 g_rec_mutex_get_impl (GRecMutex *rec_mutex)
 289 {
 290   pthread_mutex_t *impl = g_atomic_pointer_get (&rec_mutex->p);
 291
 292   if G_UNLIKELY (impl == NULL)
 293     {
 294       impl = g_rec_mutex_impl_new ();
 295       if (!g_atomic_pointer_compare_and_exchange (&rec_mutex->p, NULL, impl))
 296         g_rec_mutex_impl_free (impl);
 297       impl = rec_mutex->p;
 298     }
 299
 300   return impl;
 301 }
 302
 303 /**
 304  * g_rec_mutex_init:
 305  * @rec_mutex: an uninitialized #GRecMutex
 306  *
 307  * Initializes a #GRecMutex so that it can be used.
 308  *
 309  * This function is useful to initialize a recursive mutex
 310  * that has been allocated on the stack, or as part of a larger
 311  * structure.
 312  *
 313  * It is not necessary to initialise a recursive mutex that has been
 314  * statically allocated.
 315  *
 316  * |[
 317  *   typedef struct {
 318  *     GRecMutex m;
 319  *     ...
 320  *   } Blob;
 321  *
 322  * Blob *b;
 323  *
 324  * b = g_new (Blob, 1);
 325  * g_rec_mutex_init (&b->m);
 326  * ]|
 327  *
 328  * Calling g_rec_mutex_init() on an already initialized #GRecMutex
 329  * leads to undefined behaviour.
 330  *
 331  * To undo the effect of g_rec_mutex_init() when a recursive mutex
 332  * is no longer needed, use g_rec_mutex_clear().
 333  *
 334  * Since: 2.32
 335  */
 336 void
 337 g_rec_mutex_init (GRecMutex *rec_mutex)
 338 {
 339   rec_mutex->p = g_rec_mutex_impl_new ();
 340 }
 341
 342 /**
 343  * g_rec_mutex_clear:
 344  * @rec_mutex: an initialized #GRecMutex
 345  *
 346  * Frees the resources allocated to a recursive mutex with
 347  * g_rec_mutex_init().
 348  *
 349  * This function should not be used with a #GRecMutex that has been
 350  * statically allocated.
 351  *
 352  * Calling g_rec_mutex_clear() on a locked recursive mutex leads
 353  * to undefined behaviour.
 354  *
 355  * Sine: 2.32
 356  */
 357 void
 358 g_rec_mutex_clear (GRecMutex *rec_mutex)
 359 {
 360   g_rec_mutex_impl_free (rec_mutex->p);
 361 }
 362
 363 /**
 364  * g_rec_mutex_lock:
 365  * @rec_mutex: a #GRecMutex
 366  *
 367  * Locks @rec_mutex. If @rec_mutex is already locked by another
 368  * thread, the current thread will block until @rec_mutex is
 369  * unlocked by the other thread. If @rec_mutex is already locked
 370  * by the current thread, the 'lock count' of @rec_mutex is increased.
 371  * The mutex will only become available again when it is unlocked
 372  * as many times as it has been locked.
 373  *
 374  * Since: 2.32
 375  */
 376 void
 377 g_rec_mutex_lock (GRecMutex *mutex)
 378 {
 379   pthread_mutex_lock (g_rec_mutex_get_impl (mutex));
 380 }
 381
 382 /**
 383  * g_rec_mutex_unlock:
 384  * @rec_mutex: a #GRecMutex
 385  *
 386  * Unlocks @rec_mutex. If another thread is blocked in a
 387  * g_rec_mutex_lock() call for @rec_mutex, it will become unblocked
 388  * and can lock @rec_mutex itself.
 389  *
 390  * Calling g_rec_mutex_unlock() on a recursive mutex that is not
 391  * locked by the current thread leads to undefined behaviour.
 392  *
 393  * Since: 2.32
 394  */
 395 void
 396 g_rec_mutex_unlock (GRecMutex *rec_mutex)
 397 {
 398   pthread_mutex_unlock (rec_mutex->p);
 399 }
 400
 401 /**
 402  * g_rec_mutex_trylock:
 403  * @rec_mutex: a #GRecMutex
 404  *
 405  * Tries to lock @rec_mutex. If @rec_mutex is already locked
 406  * by another thread, it immediately returns %FALSE. Otherwise
 407  * it locks @rec_mutex and returns %TRUE.
 408  *
 409  * Returns: %TRUE if @rec_mutex could be locked
 410  *
 411  * Since: 2.32
 412  */
 413 gboolean
 414 g_rec_mutex_trylock (GRecMutex *rec_mutex)
 415 {
 416   if (pthread_mutex_trylock (g_rec_mutex_get_impl (rec_mutex)) != 0)
 417     return FALSE;
 418
 419   return TRUE;
 420 }
 421
 422 /* {{{1 GRWLock */
 423
 424 static pthread_rwlock_t *
 425 g_rw_lock_impl_new (void)
 426 {
 427   pthread_rwlock_t *rwlock;
 428   gint status;
 429
 430   rwlock = malloc (sizeof (pthread_rwlock_t));
 431   if G_UNLIKELY (rwlock == NULL)
 432     g_thread_abort (errno, "malloc");
 433
 434   if G_UNLIKELY ((status = pthread_rwlock_init (rwlock, NULL)) != 0)
 435     g_thread_abort (status, "pthread_rwlock_init");
 436
 437   return rwlock;
 438 }
 439
 440 static void
 441 g_rw_lock_impl_free (pthread_rwlock_t *rwlock)
 442 {
 443   pthread_rwlock_destroy (rwlock);
 444   free (rwlock);
 445 }
 446
 447 static pthread_rwlock_t *
 448 g_rw_lock_get_impl (GRWLock *lock)
 449 {
 450   pthread_rwlock_t *impl = g_atomic_pointer_get (&lock->p);
 451
 452   if G_UNLIKELY (impl == NULL)
 453     {
 454       impl = g_rw_lock_impl_new ();
 455       if (!g_atomic_pointer_compare_and_exchange (&lock->p, NULL, impl))
 456         g_rw_lock_impl_free (impl);
 457       impl = lock->p;
 458     }
 459
 460   return impl;
 461 }
 462
 463 /**
 464  * g_rw_lock_init:
 465  * @rw_lock: an uninitialized #GRWLock
 466  *
 467  * Initializes a #GRWLock so that it can be used.
 468  *
 469  * This function is useful to initialize a lock that has been
 470  * allocated on the stack, or as part of a larger structure.  It is not
 471  * necessary to initialise a reader-writer lock that has been statically
 472  * allocated.
 473  *
 474  * |[
 475  *   typedef struct {
 476  *     GRWLock l;
 477  *     ...
 478  *   } Blob;
 479  *
 480  * Blob *b;
 481  *
 482  * b = g_new (Blob, 1);
 483  * g_rw_lock_init (&b->l);
 484  * ]|
 485  *
 486  * To undo the effect of g_rw_lock_init() when a lock is no longer
 487  * needed, use g_rw_lock_clear().
 488  *
 489  * Calling g_rw_lock_init() on an already initialized #GRWLock leads
 490  * to undefined behaviour.
 491  *
 492  * Since: 2.32
 493  */
 494 void
 495 g_rw_lock_init (GRWLock *rw_lock)
 496 {
 497   rw_lock->p = g_rw_lock_impl_new ();
 498 }
 499
 500 /**
 501  * g_rw_lock_clear:
 502  * @rw_lock: an initialized #GRWLock
 503  *
 504  * Frees the resources allocated to a lock with g_rw_lock_init().
 505  *
 506  * This function should not be used with a #GRWLock that has been
 507  * statically allocated.
 508  *
 509  * Calling g_rw_lock_clear() when any thread holds the lock
 510  * leads to undefined behaviour.
 511  *
 512  * Sine: 2.32
 513  */
 514 void
 515 g_rw_lock_clear (GRWLock *rw_lock)
 516 {
 517   g_rw_lock_impl_free (rw_lock->p);
 518 }
 519
 520 /**
 521  * g_rw_lock_writer_lock:
 522  * @rw_lock: a #GRWLock
 523  *
 524  * Obtain a write lock on @rw_lock. If any thread already holds
 525  * a read or write lock on @rw_lock, the current thread will block
 526  * until all other threads have dropped their locks on @rw_lock.
 527  *
 528  * Since: 2.32
 529  */
 530 void
 531 g_rw_lock_writer_lock (GRWLock *rw_lock)
 532 {
 533   pthread_rwlock_wrlock (g_rw_lock_get_impl (rw_lock));
 534 }
 535
 536 /**
 537  * g_rw_lock_writer_trylock:
 538  * @rw_lock: a #GRWLock
 539  *
 540  * Tries to obtain a write lock on @rw_lock. If any other thread holds
 541  * a read or write lock on @rw_lock, it immediately returns %FALSE.
 542  * Otherwise it locks @rw_lock and returns %TRUE.
 543  *
 544  * Returns: %TRUE if @rw_lock could be locked
 545  *
 546  * Since: 2.32
 547  */
 548 gboolean
 549 g_rw_lock_writer_trylock (GRWLock *rw_lock)
 550 {
 551   if (pthread_rwlock_trywrlock (g_rw_lock_get_impl (rw_lock)) != 0)
 552     return FALSE;
 553
 554   return TRUE;
 555 }
 556
 557 /**
 558  * g_rw_lock_writer_unlock:
 559  * @rw_lock: a #GRWLock
 560  *
 561  * Release a write lock on @rw_lock.
 562  *
 563  * Calling g_rw_lock_writer_unlock() on a lock that is not held
 564  * by the current thread leads to undefined behaviour.
 565  *
 566  * Since: 2.32
 567  */
 568 void
 569 g_rw_lock_writer_unlock (GRWLock *rw_lock)
 570 {
 571   pthread_rwlock_unlock (g_rw_lock_get_impl (rw_lock));
 572 }
 573
 574 /**
 575  * g_rw_lock_reader_lock:
 576  * @rw_lock: a #GRWLock
 577  *
 578  * Obtain a read lock on @rw_lock. If another thread currently holds
 579  * the write lock on @rw_lock or blocks waiting for it, the current
 580  * thread will block. Read locks can be taken recursively.
 581  *
 582  * It is implementation-defined how many threads are allowed to
 583  * hold read locks on the same lock simultaneously.
 584  *
 585  * Since: 2.32
 586  */
 587 void
 588 g_rw_lock_reader_lock (GRWLock *rw_lock)
 589 {
 590   pthread_rwlock_rdlock (g_rw_lock_get_impl (rw_lock));
 591 }
 592
 593 /**
 594  * g_rw_lock_reader_trylock:
 595  * @rw_lock: a #GRWLock
 596  *
 597  * Tries to obtain a read lock on @rw_lock and returns %TRUE if
 598  * the read lock was successfully obtained. Otherwise it
 599  * returns %FALSE.
 600  *
 601  * Returns: %TRUE if @rw_lock could be locked
 602  *
 603  * Since: 2.32
 604  */
 605 gboolean
 606 g_rw_lock_reader_trylock (GRWLock *rw_lock)
 607 {
 608   if (pthread_rwlock_tryrdlock (g_rw_lock_get_impl (rw_lock)) != 0)
 609     return FALSE;
 610
 611   return TRUE;
 612 }
 613
 614 /**
 615  * g_rw_lock_reader_unlock:
 616  * @rw_lock: a #GRWLock
 617  *
 618  * Release a read lock on @rw_lock.
 619  *
 620  * Calling g_rw_lock_reader_unlock() on a lock that is not held
 621  * by the current thread leads to undefined behaviour.
 622  *
 623  * Since: 2.32
 624  */
 625 void
 626 g_rw_lock_reader_unlock (GRWLock *rw_lock)
 627 {
 628   pthread_rwlock_unlock (g_rw_lock_get_impl (rw_lock));
 629 }
 630
 631 /* {{{1 GCond */
 632
 633 static pthread_cond_t *
 634 g_cond_impl_new (void)
 635 {
 636   pthread_condattr_t attr;
 637   pthread_cond_t *cond;
 638   gint status;
 639
 640   pthread_condattr_init (&attr);
 641 #if defined (HAVE_PTHREAD_CONDATTR_SETCLOCK) && defined (CLOCK_MONOTONIC)
 642   pthread_condattr_setclock (&attr, CLOCK_MONOTONIC);
 643 #endif
 644
 645   cond = malloc (sizeof (pthread_cond_t));
 646   if G_UNLIKELY (cond == NULL)
 647     g_thread_abort (errno, "malloc");
 648
 649   if G_UNLIKELY ((status = pthread_cond_init (cond, &attr)) != 0)
 650     g_thread_abort (status, "pthread_cond_init");
 651
 652   pthread_condattr_destroy (&attr);
 653
 654   return cond;
 655 }
 656
 657 static void
 658 g_cond_impl_free (pthread_cond_t *cond)
 659 {
 660   pthread_cond_destroy (cond);
 661   free (cond);
 662 }
 663
 664 static pthread_cond_t *
 665 g_cond_get_impl (GCond *cond)
 666 {
 667   pthread_cond_t *impl = g_atomic_pointer_get (&cond->p);
 668
 669   if G_UNLIKELY (impl == NULL)
 670     {
 671       impl = g_cond_impl_new ();
 672       if (!g_atomic_pointer_compare_and_exchange (&cond->p, NULL, impl))
 673         g_cond_impl_free (impl);
 674       impl = cond->p;
 675     }
 676
 677   return impl;
 678 }
 679
 680 /**
 681  * g_cond_init:
 682  * @cond: an uninitialized #GCond
 683  *
 684  * Initialises a #GCond so that it can be used.
 685  *
 686  * This function is useful to initialise a #GCond that has been
 687  * allocated as part of a larger structure.  It is not necessary to
 688  * initialise a #GCond that has been statically allocated.
 689  *
 690  * To undo the effect of g_cond_init() when a #GCond is no longer
 691  * needed, use g_cond_clear().
 692  *
 693  * Calling g_cond_init() on an already-initialised #GCond leads
 694  * to undefined behaviour.
 695  *
 696  * Since: 2.32
 697  */
 698 void
 699 g_cond_init (GCond *cond)
 700 {
 701   cond->p = g_cond_impl_new ();
 702 }
 703
 704 /**
 705  * g_cond_clear:
 706  * @cond: an initialised #GCond
 707  *
 708  * Frees the resources allocated to a #GCond with g_cond_init().
 709  *
 710  * This function should not be used with a #GCond that has been
 711  * statically allocated.
 712  *
 713  * Calling g_cond_clear() for a #GCond on which threads are
 714  * blocking leads to undefined behaviour.
 715  *
 716  * Since: 2.32
 717  */
 718 void
 719 g_cond_clear (GCond *cond)
 720 {
 721   g_cond_impl_free (cond->p);
 722 }
 723
 724 /**
 725  * g_cond_wait:
 726  * @cond: a #GCond
 727  * @mutex: a #GMutex that is currently locked
 728  *
 729  * Atomically releases @mutex and waits until @cond is signalled.
 730  * When this function returns, @mutex is locked again and owned by the
 731  * calling thread.
 732  *
 733  * When using condition variables, it is possible that a spurious wakeup
 734  * may occur (ie: g_cond_wait() returns even though g_cond_signal() was
 735  * not called).  It's also possible that a stolen wakeup may occur.
 736  * This is when g_cond_signal() is called, but another thread acquires
 737  * @mutex before this thread and modifies the state of the program in
 738  * such a way that when g_cond_wait() is able to return, the expected
 739  * condition is no longer met.
 740  *
 741  * For this reason, g_cond_wait() must always be used in a loop.  See
 742  * the documentation for #GCond for a complete example.
 743  **/
 744 void
 745 g_cond_wait (GCond  *cond,
 746              GMutex *mutex)
 747 {
 748   gint status;
 749
 750   if G_UNLIKELY ((status = pthread_cond_wait (g_cond_get_impl (cond), g_mutex_get_impl (mutex))) != 0)
 751     g_thread_abort (status, "pthread_cond_wait");
 752 }
 753
 754 /**
 755  * g_cond_signal:
 756  * @cond: a #GCond
 757  *
 758  * If threads are waiting for @cond, at least one of them is unblocked.
 759  * If no threads are waiting for @cond, this function has no effect.
 760  * It is good practice to hold the same lock as the waiting thread
 761  * while calling this function, though not required.
 762  */
 763 void
 764 g_cond_signal (GCond *cond)
 765 {
 766   gint status;
 767
 768   if G_UNLIKELY ((status = pthread_cond_signal (g_cond_get_impl (cond))) != 0)
 769     g_thread_abort (status, "pthread_cond_signal");
 770 }
 771
 772 /**
 773  * g_cond_broadcast:
 774  * @cond: a #GCond
 775  *
 776  * If threads are waiting for @cond, all of them are unblocked.
 777  * If no threads are waiting for @cond, this function has no effect.
 778  * It is good practice to lock the same mutex as the waiting threads
 779  * while calling this function, though not required.
 780  */
 781 void
 782 g_cond_broadcast (GCond *cond)
 783 {
 784   gint status;
 785
 786   if G_UNLIKELY ((status = pthread_cond_broadcast (g_cond_get_impl (cond))) != 0)
 787     g_thread_abort (status, "pthread_cond_broadcast");
 788 }
 789
 790 /**
 791  * g_cond_wait_until:
 792  * @cond: a #GCond
 793  * @mutex: a #GMutex that is currently locked
 794  * @end_time: the monotonic time to wait until
 795  *
 796  * Waits until either @cond is signalled or @end_time has passed.
 797  *
 798  * As with g_cond_wait() it is possible that a spurious or stolen wakeup
 799  * could occur.  For that reason, waiting on a condition variable should
 800  * always be in a loop, based on an explicitly-checked predicate.
 801  *
 802  * %TRUE is returned if the condition variable was signalled (or in the
 803  * case of a spurious wakeup).  %FALSE is returned if @end_time has
 804  * passed.
 805  *
 806  * The following code shows how to correctly perform a timed wait on a
 807  * condition variable (extended the example presented in the
 808  * documentation for #GCond):
 809  *
 810  * |[
 811  * gpointer
 812  * pop_data_timed (void)
 813  * {
 814  *   gint64 end_time;
 815  *   gpointer data;
 816  *
 817  *   g_mutex_lock (&data_mutex);
 818  *
 819  *   end_time = g_get_monotonic_time () + 5 * G_TIME_SPAN_SECOND;
 820  *   while (!current_data)
 821  *     if (!g_cond_wait_until (&data_cond, &data_mutex, end_time))
 822  *       {
 823  *         // timeout has passed.
 824  *         g_mutex_unlock (&data_mutex);
 825  *         return NULL;
 826  *       }
 827  *
 828  *   // there is data for us
 829  *   data = current_data;
 830  *   current_data = NULL;
 831  *
 832  *   g_mutex_unlock (&data_mutex);
 833  *
 834  *   return data;
 835  * }
 836  * ]|
 837  *
 838  * Notice that the end time is calculated once, before entering the
 839  * loop and reused.  This is the motivation behind the use of absolute
 840  * time on this API -- if a relative time of 5 seconds were passed
 841  * directly to the call and a spurious wakeup occurred, the program would
 842  * have to start over waiting again (which would lead to a total wait
 843  * time of more than 5 seconds).
 844  *
 845  * Returns: %TRUE on a signal, %FALSE on a timeout
 846  * Since: 2.32
 847  **/
 848 gboolean
 849 g_cond_wait_until (GCond  *cond,
 850                    GMutex *mutex,
 851                    gint64  end_time)
 852 {
 853   struct timespec ts;
 854   gint status;
 855
 856   ts.tv_sec = end_time / 1000000;
 857   ts.tv_nsec = (end_time % 1000000) * 1000;
 858
 859   if ((status = pthread_cond_timedwait (g_cond_get_impl (cond), g_mutex_get_impl (mutex), &ts)) == 0)
 860     return TRUE;
 861
 862   if G_UNLIKELY (status != ETIMEDOUT)
 863     g_thread_abort (status, "pthread_cond_timedwait");
 864
 865   return FALSE;
 866 }
 867
 868 /* {{{1 GPrivate */
 869
 870 /**
 871  * GPrivate:
 872  *
 873  * The #GPrivate struct is an opaque data structure to represent a
 874  * thread-local data key. It is approximately equivalent to the
 875  * pthread_setspecific()/pthread_getspecific() APIs on POSIX and to
 876  * TlsSetValue()/TlsGetValue() on Windows.
 877  *
 878  * If you don't already know why you might want this functionality,
 879  * then you probably don't need it.
 880  *
 881  * #GPrivate is a very limited resource (as far as 128 per program,
 882  * shared between all libraries). It is also not possible to destroy a
 883  * #GPrivate after it has been used. As such, it is only ever acceptable
 884  * to use #GPrivate in static scope, and even then sparingly so.
 885  *
 886  * See G_PRIVATE_INIT() for a couple of examples.
 887  *
 888  * The #GPrivate structure should be considered opaque.  It should only
 889  * be accessed via the <function>g_private_</function> functions.
 890  */
 891
 892 /**
 893  * G_PRIVATE_INIT:
 894  * @notify: a #GDestroyNotify
 895  *
 896  * A macro to assist with the static initialisation of a #GPrivate.
 897  *
 898  * This macro is useful for the case that a #GDestroyNotify function
 899  * should be associated the key.  This is needed when the key will be
 900  * used to point at memory that should be deallocated when the thread
 901  * exits.
 902  *
 903  * Additionally, the #GDestroyNotify will also be called on the previous
 904  * value stored in the key when g_private_replace() is used.
 905  *
 906  * If no #GDestroyNotify is needed, then use of this macro is not
 907  * required -- if the #GPrivate is declared in static scope then it will
 908  * be properly initialised by default (ie: to all zeros).  See the
 909  * examples below.
 910  *
 911  * |[
 912  * static GPrivate name_key = G_PRIVATE_INIT (g_free);
 913  *
 914  * // return value should not be freed
 915  * const gchar *
 916  * get_local_name (void)
 917  * {
 918  *   return g_private_get (&name_key);
 919  * }
 920  *
 921  * void
 922  * set_local_name (const gchar *name)
 923  * {
 924  *   g_private_replace (&name_key, g_strdup (name));
 925  * }
 926  *
 927  *
 928  * static GPrivate count_key;   // no free function
 929  *
 930  * gint
 931  * get_local_count (void)
 932  * {
 933  *   return GPOINTER_TO_INT (g_private_get (&count_key));
 934  * }
 935  *
 936  * void
 937  * set_local_count (gint count)
 938  * {
 939  *   g_private_set (&count_key, GINT_TO_POINTER (count));
 940  * }
 941  * ]|
 942  *
 943  * Since: 2.32
 944  **/
 945
 946 static pthread_key_t *
 947 g_private_impl_new (GDestroyNotify notify)
 948 {
 949   pthread_key_t *key;
 950   gint status;
 951
 952   key = malloc (sizeof (pthread_key_t));
 953   if G_UNLIKELY (key == NULL)
 954     g_thread_abort (errno, "malloc");
 955   status = pthread_key_create (key, notify);
 956   if G_UNLIKELY (status != 0)
 957     g_thread_abort (status, "pthread_key_create");
 958
 959   return key;
 960 }
 961
 962 static void
 963 g_private_impl_free (pthread_key_t *key)
 964 {
 965   gint status;
 966
 967   status = pthread_key_delete (*key);
 968   if G_UNLIKELY (status != 0)
 969     g_thread_abort (status, "pthread_key_delete");
 970   free (key);
 971 }
 972
 973 static pthread_key_t *
 974 g_private_get_impl (GPrivate *key)
 975 {
 976   pthread_key_t *impl = g_atomic_pointer_get (&key->p);
 977
 978   if G_UNLIKELY (impl == NULL)
 979     {
 980       impl = g_private_impl_new (key->notify);
 981       if (!g_atomic_pointer_compare_and_exchange (&key->p, NULL, impl))
 982         {
 983           g_private_impl_free (impl);
 984           impl = key->p;
 985         }
 986     }
 987
 988   return impl;
 989 }
 990
 991 /**
 992  * g_private_get:
 993  * @key: a #GPrivate
 994  *
 995  * Returns the current value of the thread local variable @key.
 996  *
 997  * If the value has not yet been set in this thread, %NULL is returned.
 998  * Values are never copied between threads (when a new thread is
 999  * created, for example).
1000  *
1001  * Returns: the thread-local value
1002  */
1003 gpointer
1004 g_private_get (GPrivate *key)
1005 {
1006   /* quote POSIX: No errors are returned from pthread_getspecific(). */
1007   return pthread_getspecific (*g_private_get_impl (key));
1008 }
1009
1010 /**
1011  * g_private_set:
1012  * @key: a #GPrivate
1013  * @value: the new value
1014  *
1015  * Sets the thread local variable @key to have the value @value in the
1016  * current thread.
1017  *
1018  * This function differs from g_private_replace() in the following way:
1019  * the #GDestroyNotify for @key is not called on the old value.
1020  */
1021 void
1022 g_private_set (GPrivate *key,
1023                gpointer  value)
1024 {
1025   gint status;
1026
1027   if G_UNLIKELY ((status = pthread_setspecific (*g_private_get_impl (key), value)) != 0)
1028     g_thread_abort (status, "pthread_setspecific");
1029 }
1030
1031 /**
1032  * g_private_replace:
1033  * @key: a #GPrivate
1034  * @value: the new value
1035  *
1036  * Sets the thread local variable @key to have the value @value in the
1037  * current thread.
1038  *
1039  * This function differs from g_private_set() in the following way: if
1040  * the previous value was non-%NULL then the #GDestroyNotify handler for
1041  * @key is run on it.
1042  *
1043  * Since: 2.32
1044  **/
1045 void
1046 g_private_replace (GPrivate *key,
1047                    gpointer  value)
1048 {
1049   pthread_key_t *impl = g_private_get_impl (key);
1050   gpointer old;
1051   gint status;
1052
1053   old = pthread_getspecific (*impl);
1054   if (old && key->notify)
1055     key->notify (old);
1056
1057   if G_UNLIKELY ((status = pthread_setspecific (*impl, value)) != 0)
1058     g_thread_abort (status, "pthread_setspecific");
1059 }
1060
1061 /* {{{1 GThread */
1062
1063 #define posix_check_err(err, name) G_STMT_START{                        \
1064   int error = (err);                                                    \
1065   if (error)                                                            \
1066     g_error ("file %s: line %d (%s): error '%s' during '%s'",           \
1067            __FILE__, __LINE__, G_STRFUNC,                               \
1068            g_strerror (error), name);                                   \
1069   }G_STMT_END
1070
1071 #define posix_check_cmd(cmd) posix_check_err (cmd, #cmd)
1072
1073 typedef struct
1074 {
1075   GRealThread thread;
1076
1077   pthread_t system_thread;
1078   gboolean  joined;
1079   GMutex    lock;
1080 } GThreadPosix;
1081
1082 void
1083 g_system_thread_free (GRealThread *thread)
1084 {
1085   GThreadPosix *pt = (GThreadPosix *) thread;
1086
1087   if (!pt->joined)
1088     pthread_detach (pt->system_thread);
1089
1090   g_mutex_clear (&pt->lock);
1091
1092   g_slice_free (GThreadPosix, pt);
1093 }
1094
1095 GRealThread *
1096 g_system_thread_new (GThreadFunc   thread_func,
1097                      gulong        stack_size,
1098                      GError      **error)
1099 {
1100   GThreadPosix *thread;
1101   pthread_attr_t attr;
1102   gint ret;
1103
1104   thread = g_slice_new0 (GThreadPosix);
1105
1106   posix_check_cmd (pthread_attr_init (&attr));
1107
1108 #ifdef HAVE_PTHREAD_ATTR_SETSTACKSIZE
1109   if (stack_size)
1110     {
1111 #ifdef _SC_THREAD_STACK_MIN
1112       stack_size = MAX (sysconf (_SC_THREAD_STACK_MIN), stack_size);
1113 #endif /* _SC_THREAD_STACK_MIN */
1114       /* No error check here, because some systems can't do it and
1115        * we simply don't want threads to fail because of that. */
1116       pthread_attr_setstacksize (&attr, stack_size);
1117     }
1118 #endif /* HAVE_PTHREAD_ATTR_SETSTACKSIZE */
1119
1120   ret = pthread_create (&thread->system_thread, &attr, (void* (*)(void*))thread_func, thread);
1121
1122   posix_check_cmd (pthread_attr_destroy (&attr));
1123
1124   if (ret == EAGAIN)
1125     {
1126       g_set_error (error, G_THREAD_ERROR, G_THREAD_ERROR_AGAIN,
1127                    "Error creating thread: %s", g_strerror (ret));
1128       g_slice_free (GThreadPosix, thread);
1129       return NULL;
1130     }
1131
1132   posix_check_err (ret, "pthread_create");
1133
1134   g_mutex_init (&thread->lock);
1135
1136   return (GRealThread *) thread;
1137 }
1138
1139 /**
1140  * g_thread_yield:
1141  *
1142  * Causes the calling thread to voluntarily relinquish the CPU, so
1143  * that other threads can run.
1144  *
1145  * This function is often used as a method to make busy wait less evil.
1146  */
1147 void
1148 g_thread_yield (void)
1149 {
1150   sched_yield ();
1151 }
1152
1153 void
1154 g_system_thread_wait (GRealThread *thread)
1155 {
1156   GThreadPosix *pt = (GThreadPosix *) thread;
1157
1158   g_mutex_lock (&pt->lock);
1159
1160   if (!pt->joined)
1161     {
1162       posix_check_cmd (pthread_join (pt->system_thread, NULL));
1163       pt->joined = TRUE;
1164     }
1165
1166   g_mutex_unlock (&pt->lock);
1167 }
1168
1169 void
1170 g_system_thread_exit (void)
1171 {
1172   pthread_exit (NULL);
1173 }
1174
1175 void
1176 g_system_thread_set_name (const gchar *name)
1177 {
1178 #ifdef HAVE_SYS_PRCTL_H
1179 #ifdef PR_SET_NAME
1180   prctl (PR_SET_NAME, name, 0, 0, 0, 0);
1181 #endif
1182 #endif
1183 }
1184
1185 /* {{{1 Epilogue */
1186 /* vim:set foldmethod=marker: */