dbus/dbus-threads.c

   1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
   2 /* dbus-threads.h  D-Bus threads handling
   3  *
   4  * Copyright (C) 2002, 2003, 2006 Red Hat Inc.
   5  *
   6  * Licensed under the Academic Free License version 2.1
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program 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
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  21  *
  22  */
  23 #include "dbus-threads.h"
  24 #include "dbus-internals.h"
  25 #include "dbus-threads-internal.h"
  26 #include "dbus-list.h"
  27
  28 static DBusThreadFunctions thread_functions =
  29 {
  30   0,
  31   NULL, NULL, NULL, NULL, NULL,
  32   NULL, NULL, NULL, NULL, NULL,
  33   NULL, NULL, NULL, NULL,
  34
  35   NULL, NULL, NULL, NULL
  36 };
  37
  38 static int thread_init_generation = 0;
  39
  40 static DBusList *uninitialized_mutex_list = NULL;
  41 static DBusList *uninitialized_condvar_list = NULL;
  42
  43 /** This is used for the no-op default mutex pointer, just to be distinct from #NULL */
  44 #define _DBUS_DUMMY_MUTEX ((DBusMutex*)0xABCDEF)
  45
  46 /** This is used for the no-op default mutex pointer, just to be distinct from #NULL */
  47 #define _DBUS_DUMMY_CONDVAR ((DBusCondVar*)0xABCDEF2)
  48
  49 /**
  50  * @defgroup DBusThreadsInternals Thread functions
  51  * @ingroup  DBusInternals
  52  * @brief _dbus_mutex_lock(), etc.
  53  *
  54  * Functions and macros related to threads and thread locks.
  55  *
  56  * @{
  57  */
  58
  59 /**
  60  * Creates a new mutex using the function supplied to dbus_threads_init(),
  61  * or creates a no-op mutex if threads are not initialized.
  62  * May return #NULL even if threads are initialized, indicating
  63  * out-of-memory.
  64  *
  65  * @returns new mutex or #NULL
  66  */
  67 DBusMutex*
  68 _dbus_mutex_new (void)
  69 {
  70   if (thread_functions.recursive_mutex_new)
  71     return (* thread_functions.recursive_mutex_new) ();
  72   else if (thread_functions.mutex_new)
  73     return (* thread_functions.mutex_new) ();
  74   else
  75     return _DBUS_DUMMY_MUTEX;
  76 }
  77
  78 /**
  79  * This does the same thing as _dbus_mutex_new.  It however
  80  * gives another level of indirection by allocating a pointer
  81  * to point to the mutex location.  This allows the threading
  82  * module to swap out dummy mutexes for real a real mutex so libraries
  83  * can initialize threads even after the D-Bus API has been used.
  84  *
  85  * @param location_p the location of the new mutex, can return #NULL on OOM
  86  */
  87 void
  88 _dbus_mutex_new_at_location (DBusMutex **location_p)
  89 {
  90   _dbus_assert (location_p != NULL);
  91
  92   *location_p = _dbus_mutex_new();
  93
  94   if (thread_init_generation != _dbus_current_generation && *location_p)
  95     {
  96       if (!_dbus_list_append (&uninitialized_mutex_list, location_p))
  97         {
  98           _dbus_mutex_free (*location_p);
  99           *location_p = NULL;
 100         }
 101     }
 102 }
 103
 104 /**
 105  * Frees a mutex created with dbus_mutex_new(); does
 106  * nothing if passed a #NULL pointer.
 107  */
 108 void
 109 _dbus_mutex_free (DBusMutex *mutex)
 110 {
 111   if (mutex)
 112     {
 113       if (mutex && thread_functions.recursive_mutex_free)
 114         (* thread_functions.recursive_mutex_free) (mutex);
 115       else if (mutex && thread_functions.mutex_free)
 116         (* thread_functions.mutex_free) (mutex);
 117     }
 118 }
 119
 120 /**
 121  * Frees a mutex and removes it from the
 122  * uninitialized_mutex_list;
 123  * does nothing if passed a #NULL pointer.
 124  */
 125 void
 126 _dbus_mutex_free_at_location (DBusMutex **location_p)
 127 {
 128   if (location_p)
 129     {
 130       if (thread_init_generation != _dbus_current_generation)
 131         _dbus_list_remove (&uninitialized_mutex_list, location_p);
 132
 133       _dbus_mutex_free (*location_p);
 134     }
 135 }
 136
 137 /**
 138  * Locks a mutex. Does nothing if passed a #NULL pointer.
 139  * Locks may be recursive if threading implementation initialized
 140  * recursive locks.
 141  */
 142 void
 143 _dbus_mutex_lock (DBusMutex *mutex)
 144 {
 145   if (mutex)
 146     {
 147       if (thread_functions.recursive_mutex_lock)
 148         (* thread_functions.recursive_mutex_lock) (mutex);
 149       else if (thread_functions.mutex_lock)
 150         (* thread_functions.mutex_lock) (mutex);
 151     }
 152 }
 153
 154 /**
 155  * Unlocks a mutex. Does nothing if passed a #NULL pointer.
 156  *
 157  * @returns #TRUE on success
 158  */
 159 void
 160 _dbus_mutex_unlock (DBusMutex *mutex)
 161 {
 162   if (mutex)
 163     {
 164       if (thread_functions.recursive_mutex_unlock)
 165         (* thread_functions.recursive_mutex_unlock) (mutex);
 166       else if (thread_functions.mutex_unlock)
 167         (* thread_functions.mutex_unlock) (mutex);
 168     }
 169 }
 170
 171 /**
 172  * Creates a new condition variable using the function supplied
 173  * to dbus_threads_init(), or creates a no-op condition variable
 174  * if threads are not initialized. May return #NULL even if
 175  * threads are initialized, indicating out-of-memory.
 176  *
 177  * @returns new mutex or #NULL
 178  */
 179 DBusCondVar *
 180 _dbus_condvar_new (void)
 181 {
 182   if (thread_functions.condvar_new)
 183     return (* thread_functions.condvar_new) ();
 184   else
 185     return _DBUS_DUMMY_CONDVAR;
 186 }
 187
 188
 189 /**
 190  * This does the same thing as _dbus_condvar_new.  It however
 191  * gives another level of indirection by allocating a pointer
 192  * to point to the condvar location.  This allows the threading
 193  * module to swap out dummy condvars for real a real condvar so libraries
 194  * can initialize threads even after the D-Bus API has been used.
 195  *
 196  * @returns the location of a new condvar or #NULL on OOM
 197  */
 198
 199 void
 200 _dbus_condvar_new_at_location (DBusCondVar **location_p)
 201 {
 202   *location_p = _dbus_condvar_new();
 203
 204   if (thread_init_generation != _dbus_current_generation && *location_p)
 205     {
 206       if (!_dbus_list_append (&uninitialized_condvar_list, location_p))
 207         {
 208           _dbus_condvar_free (*location_p);
 209           *location_p = NULL;
 210         }
 211     }
 212 }
 213
 214
 215 /**
 216  * Frees a conditional variable created with dbus_condvar_new(); does
 217  * nothing if passed a #NULL pointer.
 218  */
 219 void
 220 _dbus_condvar_free (DBusCondVar *cond)
 221 {
 222   if (cond && thread_functions.condvar_free)
 223     (* thread_functions.condvar_free) (cond);
 224 }
 225
 226 /**
 227  * Frees a conditional variable and removes it from the
 228  * uninitialized_condvar_list;
 229  * does nothing if passed a #NULL pointer.
 230  */
 231 void
 232 _dbus_condvar_free_at_location (DBusCondVar **location_p)
 233 {
 234   if (location_p)
 235     {
 236       if (thread_init_generation != _dbus_current_generation)
 237         _dbus_list_remove (&uninitialized_condvar_list, location_p);
 238
 239       _dbus_condvar_free (*location_p);
 240     }
 241 }
 242
 243 /**
 244  * Atomically unlocks the mutex and waits for the conditions
 245  * variable to be signalled. Locks the mutex again before
 246  * returning.
 247  * Does nothing if passed a #NULL pointer.
 248  */
 249 void
 250 _dbus_condvar_wait (DBusCondVar *cond,
 251                     DBusMutex   *mutex)
 252 {
 253   if (cond && mutex && thread_functions.condvar_wait)
 254     (* thread_functions.condvar_wait) (cond, mutex);
 255 }
 256
 257 /**
 258  * Atomically unlocks the mutex and waits for the conditions variable
 259  * to be signalled, or for a timeout. Locks the mutex again before
 260  * returning.  Does nothing if passed a #NULL pointer.  Return value
 261  * is #FALSE if we timed out, #TRUE otherwise.
 262  *
 263  * @param cond the condition variable
 264  * @param mutex the mutex
 265  * @param timeout_milliseconds the maximum time to wait
 266  * @returns #FALSE if the timeout occurred, #TRUE if not
 267  */
 268 dbus_bool_t
 269 _dbus_condvar_wait_timeout (DBusCondVar               *cond,
 270                             DBusMutex                 *mutex,
 271                             int                        timeout_milliseconds)
 272 {
 273   if (cond && mutex && thread_functions.condvar_wait)
 274     return (* thread_functions.condvar_wait_timeout) (cond, mutex, timeout_milliseconds);
 275   else
 276     return TRUE;
 277 }
 278
 279 /**
 280  * If there are threads waiting on the condition variable, wake
 281  * up exactly one.
 282  * Does nothing if passed a #NULL pointer.
 283  */
 284 void
 285 _dbus_condvar_wake_one (DBusCondVar *cond)
 286 {
 287   if (cond && thread_functions.condvar_wake_one)
 288     (* thread_functions.condvar_wake_one) (cond);
 289 }
 290
 291 /**
 292  * If there are threads waiting on the condition variable, wake
 293  * up all of them.
 294  * Does nothing if passed a #NULL pointer.
 295  */
 296 void
 297 _dbus_condvar_wake_all (DBusCondVar *cond)
 298 {
 299   if (cond && thread_functions.condvar_wake_all)
 300     (* thread_functions.condvar_wake_all) (cond);
 301 }
 302
 303 static void
 304 shutdown_global_locks (void *data)
 305 {
 306   DBusMutex ***locks = data;
 307   int i;
 308
 309   i = 0;
 310   while (i < _DBUS_N_GLOBAL_LOCKS)
 311     {
 312       _dbus_mutex_free (*(locks[i]));
 313       *(locks[i]) = NULL;
 314       ++i;
 315     }
 316
 317   dbus_free (locks);
 318 }
 319
 320 static void
 321 shutdown_uninitialized_locks (void *data)
 322 {
 323   _dbus_list_clear (&uninitialized_mutex_list);
 324   _dbus_list_clear (&uninitialized_condvar_list);
 325 }
 326
 327 static dbus_bool_t
 328 init_uninitialized_locks (void)
 329 {
 330   DBusList *link;
 331
 332   _dbus_assert (thread_init_generation != _dbus_current_generation);
 333
 334   link = uninitialized_mutex_list;
 335   while (link != NULL)
 336     {
 337       DBusMutex **mp;
 338
 339       mp = (DBusMutex **)link->data;
 340       _dbus_assert (*mp == _DBUS_DUMMY_MUTEX);
 341
 342       *mp = _dbus_mutex_new ();
 343       if (*mp == NULL)
 344         goto fail_mutex;
 345
 346       link = _dbus_list_get_next_link (&uninitialized_mutex_list, link);
 347     }
 348
 349   link = uninitialized_condvar_list;
 350   while (link != NULL)
 351     {
 352       DBusCondVar **cp;
 353
 354       cp = (DBusCondVar **)link->data;
 355       _dbus_assert (*cp == _DBUS_DUMMY_CONDVAR);
 356
 357       *cp = _dbus_condvar_new ();
 358       if (*cp == NULL)
 359         goto fail_condvar;
 360
 361       link = _dbus_list_get_next_link (&uninitialized_condvar_list, link);
 362     }
 363
 364   _dbus_list_clear (&uninitialized_mutex_list);
 365   _dbus_list_clear (&uninitialized_condvar_list);
 366
 367   if (!_dbus_register_shutdown_func (shutdown_uninitialized_locks,
 368                                      NULL))
 369     goto fail_condvar;
 370
 371   return TRUE;
 372
 373  fail_condvar:
 374   link = uninitialized_condvar_list;
 375   while (link != NULL)
 376     {
 377       DBusCondVar **cp;
 378
 379       cp = (DBusCondVar **)link->data;
 380
 381       if (*cp != _DBUS_DUMMY_CONDVAR)
 382         _dbus_condvar_free (*cp);
 383       else
 384         break;
 385
 386       *cp = _DBUS_DUMMY_CONDVAR;
 387
 388       link = _dbus_list_get_next_link (&uninitialized_condvar_list, link);
 389     }
 390
 391  fail_mutex:
 392   link = uninitialized_mutex_list;
 393   while (link != NULL)
 394     {
 395       DBusMutex **mp;
 396
 397       mp = (DBusMutex **)link->data;
 398
 399       if (*mp != _DBUS_DUMMY_MUTEX)
 400         _dbus_mutex_free (*mp);
 401       else
 402         break;
 403
 404       *mp = _DBUS_DUMMY_MUTEX;
 405
 406       link = _dbus_list_get_next_link (&uninitialized_mutex_list, link);
 407     }
 408
 409   return FALSE;
 410 }
 411
 412 static dbus_bool_t
 413 init_locks (void)
 414 {
 415   int i;
 416   DBusMutex ***dynamic_global_locks;
 417
 418   DBusMutex **global_locks[] = {
 419 #define LOCK_ADDR(name) (& _dbus_lock_##name)
 420     LOCK_ADDR (win_fds),
 421     LOCK_ADDR (sid_atom_cache),
 422     LOCK_ADDR (list),
 423     LOCK_ADDR (connection_slots),
 424     LOCK_ADDR (pending_call_slots),
 425     LOCK_ADDR (server_slots),
 426     LOCK_ADDR (message_slots),
 427 #if !DBUS_USE_SYNC
 428     LOCK_ADDR (atomic),
 429 #endif
 430     LOCK_ADDR (bus),
 431     LOCK_ADDR (bus_datas),
 432     LOCK_ADDR (shutdown_funcs),
 433     LOCK_ADDR (system_users),
 434     LOCK_ADDR (message_cache),
 435     LOCK_ADDR (shared_connections),
 436     LOCK_ADDR (machine_uuid)
 437 #undef LOCK_ADDR
 438   };
 439
 440   _dbus_assert (_DBUS_N_ELEMENTS (global_locks) ==
 441                 _DBUS_N_GLOBAL_LOCKS);
 442
 443   i = 0;
 444
 445   dynamic_global_locks = dbus_new (DBusMutex**, _DBUS_N_GLOBAL_LOCKS);
 446   if (dynamic_global_locks == NULL)
 447     goto failed;
 448
 449   while (i < _DBUS_N_ELEMENTS (global_locks))
 450     {
 451       *global_locks[i] = _dbus_mutex_new ();
 452
 453       if (*global_locks[i] == NULL)
 454         goto failed;
 455
 456       dynamic_global_locks[i] = global_locks[i];
 457
 458       ++i;
 459     }
 460
 461   if (!_dbus_register_shutdown_func (shutdown_global_locks,
 462                                      dynamic_global_locks))
 463     goto failed;
 464
 465   if (!init_uninitialized_locks ())
 466     goto failed;
 467
 468   return TRUE;
 469
 470  failed:
 471   dbus_free (dynamic_global_locks);
 472
 473   for (i = i - 1; i >= 0; i--)
 474     {
 475       _dbus_mutex_free (*global_locks[i]);
 476       *global_locks[i] = NULL;
 477     }
 478   return FALSE;
 479 }
 480
 481 /** @} */ /* end of internals */
 482
 483 /**
 484  * @defgroup DBusThreads Thread functions
 485  * @ingroup  DBus
 486  * @brief dbus_threads_init() and dbus_threads_init_default()
 487  *
 488  * Functions and macros related to threads and thread locks.
 489  *
 490  * If threads are initialized, the D-Bus library has locks on all
 491  * global data structures.  In addition, each #DBusConnection has a
 492  * lock, so only one thread at a time can touch the connection.  (See
 493  * @ref DBusConnection for more on connection locking.)
 494  *
 495  * Most other objects, however, do not have locks - they can only be
 496  * used from a single thread at a time, unless you lock them yourself.
 497  * For example, a #DBusMessage can't be modified from two threads
 498  * at once.
 499  *
 500  * @{
 501  */
 502
 503 /**
 504  *
 505  * Initializes threads. If this function is not called, the D-Bus
 506  * library will not lock any data structures.  If it is called, D-Bus
 507  * will do locking, at some cost in efficiency. Note that this
 508  * function must be called BEFORE the second thread is started.
 509  *
 510  * Almost always, you should use dbus_threads_init_default() instead.
 511  * The raw dbus_threads_init() is only useful if you require a
 512  * particular thread implementation for some reason.
 513  *
 514  * A possible reason to use dbus_threads_init() rather than
 515  * dbus_threads_init_default() is to insert debugging checks or print
 516  * statements.
 517  *
 518  * dbus_threads_init() may be called more than once.  The first one
 519  * wins and subsequent calls are ignored. (Unless you use
 520  * dbus_shutdown() to reset libdbus, which will let you re-init
 521  * threads.)
 522  *
 523  * Either recursive or nonrecursive mutex functions must be specified,
 524  * but not both. New code should provide only the recursive functions
 525  * - specifying the nonrecursive ones is deprecated.
 526  *
 527  * Because this function effectively sets global state, all code
 528  * running in a given application must agree on the thread
 529  * implementation. Most code won't care which thread implementation is
 530  * used, so there's no problem. However, usually libraries should not
 531  * call dbus_threads_init() or dbus_threads_init_default(), instead
 532  * leaving this policy choice to applications.
 533  *
 534  * The exception is for application frameworks (GLib, Qt, etc.)  and
 535  * D-Bus bindings based on application frameworks. These frameworks
 536  * define a cross-platform thread abstraction and can assume
 537  * applications using the framework are OK with using that thread
 538  * abstraction.
 539  *
 540  * However, even these app frameworks may find it easier to simply call
 541  * dbus_threads_init_default(), and there's no reason they shouldn't.
 542  *
 543  * @param functions functions for using threads
 544  * @returns #TRUE on success, #FALSE if no memory
 545  */
 546 dbus_bool_t
 547 dbus_threads_init (const DBusThreadFunctions *functions)
 548 {
 549   dbus_bool_t mutex_set;
 550   dbus_bool_t recursive_mutex_set;
 551
 552   _dbus_assert (functions != NULL);
 553
 554   /* these base functions are required. Future additions to
 555    * DBusThreadFunctions may be optional.
 556    */
 557   _dbus_assert (functions->mask & DBUS_THREAD_FUNCTIONS_CONDVAR_NEW_MASK);
 558   _dbus_assert (functions->mask & DBUS_THREAD_FUNCTIONS_CONDVAR_FREE_MASK);
 559   _dbus_assert (functions->mask & DBUS_THREAD_FUNCTIONS_CONDVAR_WAIT_MASK);
 560   _dbus_assert (functions->mask & DBUS_THREAD_FUNCTIONS_CONDVAR_WAIT_TIMEOUT_MASK);
 561   _dbus_assert (functions->mask & DBUS_THREAD_FUNCTIONS_CONDVAR_WAKE_ONE_MASK);
 562   _dbus_assert (functions->mask & DBUS_THREAD_FUNCTIONS_CONDVAR_WAKE_ALL_MASK);
 563   _dbus_assert (functions->condvar_new != NULL);
 564   _dbus_assert (functions->condvar_free != NULL);
 565   _dbus_assert (functions->condvar_wait != NULL);
 566   _dbus_assert (functions->condvar_wait_timeout != NULL);
 567   _dbus_assert (functions->condvar_wake_one != NULL);
 568   _dbus_assert (functions->condvar_wake_all != NULL);
 569
 570   /* Either the mutex function set or recursive mutex set needs
 571    * to be available but not both
 572    */
 573   mutex_set = (functions->mask & DBUS_THREAD_FUNCTIONS_MUTEX_NEW_MASK) &&
 574               (functions->mask & DBUS_THREAD_FUNCTIONS_MUTEX_FREE_MASK) &&
 575               (functions->mask & DBUS_THREAD_FUNCTIONS_MUTEX_LOCK_MASK) &&
 576               (functions->mask & DBUS_THREAD_FUNCTIONS_MUTEX_UNLOCK_MASK) &&
 577                functions->mutex_new &&
 578                functions->mutex_free &&
 579                functions->mutex_lock &&
 580                functions->mutex_unlock;
 581
 582   recursive_mutex_set =
 583               (functions->mask & DBUS_THREAD_FUNCTIONS_RECURSIVE_MUTEX_NEW_MASK) &&
 584               (functions->mask & DBUS_THREAD_FUNCTIONS_RECURSIVE_MUTEX_FREE_MASK) &&
 585               (functions->mask & DBUS_THREAD_FUNCTIONS_RECURSIVE_MUTEX_LOCK_MASK) &&
 586               (functions->mask & DBUS_THREAD_FUNCTIONS_RECURSIVE_MUTEX_UNLOCK_MASK) &&
 587                 functions->recursive_mutex_new &&
 588                 functions->recursive_mutex_free &&
 589                 functions->recursive_mutex_lock &&
 590                 functions->recursive_mutex_unlock;
 591
 592   if (!(mutex_set || recursive_mutex_set))
 593     _dbus_assert_not_reached ("Either the nonrecusrive or recursive mutex "
 594                               "functions sets should be passed into "
 595                               "dbus_threads_init. Neither sets were passed.");
 596
 597   if (mutex_set && recursive_mutex_set)
 598     _dbus_assert_not_reached ("Either the nonrecusrive or recursive mutex "
 599                               "functions sets should be passed into "
 600                               "dbus_threads_init. Both sets were passed. "
 601                               "You most likely just want to set the recursive "
 602                               "mutex functions to avoid deadlocks in D-Bus.");
 603
 604   /* Check that all bits in the mask actually are valid mask bits.
 605    * ensures people won't write code that breaks when we add
 606    * new bits.
 607    */
 608   _dbus_assert ((functions->mask & ~DBUS_THREAD_FUNCTIONS_ALL_MASK) == 0);
 609
 610   if (thread_init_generation != _dbus_current_generation)
 611     thread_functions.mask = 0; /* allow re-init in new generation */
 612
 613   /* Silently allow multiple init
 614    * First init wins and D-Bus will always use its threading system
 615    */
 616   if (thread_functions.mask != 0)
 617     return TRUE;
 618
 619   thread_functions.mutex_new = functions->mutex_new;
 620   thread_functions.mutex_free = functions->mutex_free;
 621   thread_functions.mutex_lock = functions->mutex_lock;
 622   thread_functions.mutex_unlock = functions->mutex_unlock;
 623
 624   thread_functions.condvar_new = functions->condvar_new;
 625   thread_functions.condvar_free = functions->condvar_free;
 626   thread_functions.condvar_wait = functions->condvar_wait;
 627   thread_functions.condvar_wait_timeout = functions->condvar_wait_timeout;
 628   thread_functions.condvar_wake_one = functions->condvar_wake_one;
 629   thread_functions.condvar_wake_all = functions->condvar_wake_all;
 630
 631   if (functions->mask & DBUS_THREAD_FUNCTIONS_RECURSIVE_MUTEX_NEW_MASK)
 632     thread_functions.recursive_mutex_new = functions->recursive_mutex_new;
 633
 634   if (functions->mask & DBUS_THREAD_FUNCTIONS_RECURSIVE_MUTEX_FREE_MASK)
 635     thread_functions.recursive_mutex_free = functions->recursive_mutex_free;
 636
 637   if (functions->mask & DBUS_THREAD_FUNCTIONS_RECURSIVE_MUTEX_LOCK_MASK)
 638     thread_functions.recursive_mutex_lock = functions->recursive_mutex_lock;
 639
 640   if (functions->mask & DBUS_THREAD_FUNCTIONS_RECURSIVE_MUTEX_UNLOCK_MASK)
 641     thread_functions.recursive_mutex_unlock = functions->recursive_mutex_unlock;
 642
 643   thread_functions.mask = functions->mask;
 644
 645   if (!init_locks ())
 646     return FALSE;
 647
 648   thread_init_generation = _dbus_current_generation;
 649
 650   return TRUE;
 651 }
 652
 653
 654
 655 /* Default thread implemenation */
 656
 657 /**
 658  *
 659  * Calls dbus_threads_init() with a default set of
 660  * #DBusThreadFunctions appropriate for the platform.
 661  *
 662  * Most applications should use this rather than dbus_threads_init().
 663  *
 664  * It's safe to call dbus_threads_init_default() as many times as you
 665  * want, but only the first time will have an effect.
 666  *
 667  * dbus_shutdown() reverses the effects of this function when it
 668  * resets all global state in libdbus.
 669  *
 670  * @returns #TRUE on success, #FALSE if not enough memory
 671  */
 672 dbus_bool_t
 673 dbus_threads_init_default (void)
 674 {
 675   return _dbus_threads_init_platform_specific ();
 676 }
 677
 678
 679 /** @} */
 680
 681 #ifdef DBUS_BUILD_TESTS
 682 /** Fake mutex used for debugging */
 683 typedef struct DBusFakeMutex DBusFakeMutex;
 684 /** Fake mutex used for debugging */
 685 struct DBusFakeMutex
 686 {
 687   dbus_bool_t locked; /**< Mutex is "locked" */
 688 };
 689
 690 static DBusMutex *  dbus_fake_mutex_new            (void);
 691 static void         dbus_fake_mutex_free           (DBusMutex   *mutex);
 692 static dbus_bool_t  dbus_fake_mutex_lock           (DBusMutex   *mutex);
 693 static dbus_bool_t  dbus_fake_mutex_unlock         (DBusMutex   *mutex);
 694 static DBusCondVar* dbus_fake_condvar_new          (void);
 695 static void         dbus_fake_condvar_free         (DBusCondVar *cond);
 696 static void         dbus_fake_condvar_wait         (DBusCondVar *cond,
 697                                                     DBusMutex   *mutex);
 698 static dbus_bool_t  dbus_fake_condvar_wait_timeout (DBusCondVar *cond,
 699                                                     DBusMutex   *mutex,
 700                                                     int          timeout_msec);
 701 static void         dbus_fake_condvar_wake_one     (DBusCondVar *cond);
 702 static void         dbus_fake_condvar_wake_all     (DBusCondVar *cond);
 703
 704
 705 static const DBusThreadFunctions fake_functions =
 706 {
 707   DBUS_THREAD_FUNCTIONS_MUTEX_NEW_MASK |
 708   DBUS_THREAD_FUNCTIONS_MUTEX_FREE_MASK |
 709   DBUS_THREAD_FUNCTIONS_MUTEX_LOCK_MASK |
 710   DBUS_THREAD_FUNCTIONS_MUTEX_UNLOCK_MASK |
 711   DBUS_THREAD_FUNCTIONS_CONDVAR_NEW_MASK |
 712   DBUS_THREAD_FUNCTIONS_CONDVAR_FREE_MASK |
 713   DBUS_THREAD_FUNCTIONS_CONDVAR_WAIT_MASK |
 714   DBUS_THREAD_FUNCTIONS_CONDVAR_WAIT_TIMEOUT_MASK |
 715   DBUS_THREAD_FUNCTIONS_CONDVAR_WAKE_ONE_MASK|
 716   DBUS_THREAD_FUNCTIONS_CONDVAR_WAKE_ALL_MASK,
 717   dbus_fake_mutex_new,
 718   dbus_fake_mutex_free,
 719   dbus_fake_mutex_lock,
 720   dbus_fake_mutex_unlock,
 721   dbus_fake_condvar_new,
 722   dbus_fake_condvar_free,
 723   dbus_fake_condvar_wait,
 724   dbus_fake_condvar_wait_timeout,
 725   dbus_fake_condvar_wake_one,
 726   dbus_fake_condvar_wake_all
 727 };
 728
 729 static DBusMutex *
 730 dbus_fake_mutex_new (void)
 731 {
 732   DBusFakeMutex *mutex;
 733
 734   mutex = dbus_new0 (DBusFakeMutex, 1);
 735
 736   return (DBusMutex *)mutex;
 737 }
 738
 739 static void
 740 dbus_fake_mutex_free (DBusMutex *mutex)
 741 {
 742   DBusFakeMutex *fake = (DBusFakeMutex*) mutex;
 743
 744   _dbus_assert (!fake->locked);
 745
 746   dbus_free (fake);
 747 }
 748
 749 static dbus_bool_t
 750 dbus_fake_mutex_lock (DBusMutex *mutex)
 751 {
 752   DBusFakeMutex *fake = (DBusFakeMutex*) mutex;
 753
 754   _dbus_assert (!fake->locked);
 755
 756   fake->locked = TRUE;
 757
 758   return TRUE;
 759 }
 760
 761 static dbus_bool_t
 762 dbus_fake_mutex_unlock (DBusMutex *mutex)
 763 {
 764   DBusFakeMutex *fake = (DBusFakeMutex*) mutex;
 765
 766   _dbus_assert (fake->locked);
 767
 768   fake->locked = FALSE;
 769
 770   return TRUE;
 771 }
 772
 773 static DBusCondVar*
 774 dbus_fake_condvar_new (void)
 775 {
 776   return (DBusCondVar*) _dbus_strdup ("FakeCondvar");
 777 }
 778
 779 static void
 780 dbus_fake_condvar_free (DBusCondVar *cond)
 781 {
 782   dbus_free (cond);
 783 }
 784
 785 static void
 786 dbus_fake_condvar_wait (DBusCondVar *cond,
 787                         DBusMutex   *mutex)
 788 {
 789
 790 }
 791
 792 static dbus_bool_t
 793 dbus_fake_condvar_wait_timeout (DBusCondVar *cond,
 794                                 DBusMutex   *mutex,
 795                                 int         timeout_msec)
 796 {
 797   return TRUE;
 798 }
 799
 800 static void
 801 dbus_fake_condvar_wake_one (DBusCondVar *cond)
 802 {
 803
 804 }
 805
 806 static void
 807 dbus_fake_condvar_wake_all (DBusCondVar *cond)
 808 {
 809
 810 }
 811
 812 dbus_bool_t
 813 _dbus_threads_init_debug (void)
 814 {
 815 #ifdef DBUS_WIN
 816   return _dbus_threads_init_platform_specific();
 817 #else
 818   return dbus_threads_init (&fake_functions);
 819 #endif
 820 }
 821
 822 #endif /* DBUS_BUILD_TESTS */