dbus/dbus-server.c

   1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
   2 /* dbus-server.c DBusServer object
   3  *
   4  * Copyright (C) 2002, 2003, 2004, 2005 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
  24 #include <config.h>
  25 #include "dbus-server.h"
  26 #include "dbus-server-unix.h"
  27 #include "dbus-server-socket.h"
  28 #include "dbus-string.h"
  29 #ifdef DBUS_ENABLE_EMBEDDED_TESTS
  30 #include "dbus-server-debug-pipe.h"
  31 #endif
  32 #include "dbus-address.h"
  33 #include "dbus-protocol.h"
  34
  35 /**
  36  * @defgroup DBusServer DBusServer
  37  * @ingroup  DBus
  38  * @brief Server that listens for new connections.
  39  *
  40  * A DBusServer represents a server that other applications
  41  * can connect to. Each connection from another application
  42  * is represented by a #DBusConnection.
  43  *
  44  * @todo Thread safety hasn't been tested much for #DBusServer
  45  * @todo Need notification to apps of disconnection, may matter for some transports
  46  */
  47
  48 /**
  49  * @defgroup DBusServerInternals DBusServer implementation details
  50  * @ingroup  DBusInternals
  51  * @brief Implementation details of DBusServer
  52  *
  53  * @{
  54  */
  55
  56 #ifndef _dbus_server_trace_ref
  57 void
  58 _dbus_server_trace_ref (DBusServer *server,
  59     int old_refcount,
  60     int new_refcount,
  61     const char *why)
  62 {
  63   static int enabled = -1;
  64
  65   _dbus_trace_ref ("DBusServer", server, old_refcount, new_refcount, why,
  66       "DBUS_SERVER_TRACE", &enabled);
  67 }
  68 #endif
  69
  70 /* this is a little fragile since it assumes the address doesn't
  71  * already have a guid, but it shouldn't
  72  */
  73 static char*
  74 copy_address_with_guid_appended (const DBusString *address,
  75                                  const DBusString *guid_hex)
  76 {
  77   DBusString with_guid;
  78   char *retval;
  79
  80   if (!_dbus_string_init (&with_guid))
  81     return NULL;
  82
  83   if (!_dbus_string_copy (address, 0, &with_guid,
  84                           _dbus_string_get_length (&with_guid)) ||
  85       !_dbus_string_append (&with_guid, ",guid=") ||
  86       !_dbus_string_copy (guid_hex, 0,
  87                           &with_guid, _dbus_string_get_length (&with_guid)))
  88     {
  89       _dbus_string_free (&with_guid);
  90       return NULL;
  91     }
  92
  93   retval = NULL;
  94   _dbus_string_steal_data (&with_guid, &retval);
  95
  96   _dbus_string_free (&with_guid);
  97
  98   return retval; /* may be NULL if steal_data failed */
  99 }
 100
 101 /**
 102  * Initializes the members of the DBusServer base class.
 103  * Chained up to by subclass constructors.
 104  *
 105  * @param server the server.
 106  * @param vtable the vtable for the subclass.
 107  * @param address the server's address
 108  * @returns #TRUE on success.
 109  */
 110 dbus_bool_t
 111 _dbus_server_init_base (DBusServer             *server,
 112                         const DBusServerVTable *vtable,
 113                         const DBusString       *address)
 114 {
 115   server->vtable = vtable;
 116
 117 #ifdef DBUS_DISABLE_ASSERT
 118   _dbus_atomic_inc (&server->refcount);
 119 #else
 120     {
 121       dbus_int32_t old_refcount = _dbus_atomic_inc (&server->refcount);
 122
 123       _dbus_assert (old_refcount == 0);
 124     }
 125 #endif
 126
 127   server->address = NULL;
 128   server->watches = NULL;
 129   server->timeouts = NULL;
 130   server->published_address = FALSE;
 131
 132   if (!_dbus_string_init (&server->guid_hex))
 133     return FALSE;
 134
 135   _dbus_generate_uuid (&server->guid);
 136
 137   if (!_dbus_uuid_encode (&server->guid, &server->guid_hex))
 138     goto failed;
 139
 140   server->address = copy_address_with_guid_appended (address,
 141                                                      &server->guid_hex);
 142   if (server->address == NULL)
 143     goto failed;
 144
 145   _dbus_rmutex_new_at_location (&server->mutex);
 146   if (server->mutex == NULL)
 147     goto failed;
 148
 149   server->watches = _dbus_watch_list_new ();
 150   if (server->watches == NULL)
 151     goto failed;
 152
 153   server->timeouts = _dbus_timeout_list_new ();
 154   if (server->timeouts == NULL)
 155     goto failed;
 156
 157   _dbus_data_slot_list_init (&server->slot_list);
 158
 159   _dbus_verbose ("Initialized server on address %s\n", server->address);
 160
 161   return TRUE;
 162
 163  failed:
 164   _dbus_rmutex_free_at_location (&server->mutex);
 165   server->mutex = NULL;
 166   if (server->watches)
 167     {
 168       _dbus_watch_list_free (server->watches);
 169       server->watches = NULL;
 170     }
 171   if (server->timeouts)
 172     {
 173       _dbus_timeout_list_free (server->timeouts);
 174       server->timeouts = NULL;
 175     }
 176   if (server->address)
 177     {
 178       dbus_free (server->address);
 179       server->address = NULL;
 180     }
 181   _dbus_string_free (&server->guid_hex);
 182
 183   return FALSE;
 184 }
 185
 186 DBusServer*
 187 dbus_server_init_mini (char* address)
 188 {
 189         DBusServer *server;
 190
 191         server = dbus_new0(struct DBusServer, 1);
 192         if(server == NULL)
 193                 return NULL;
 194
 195         memset(server, 0, sizeof(struct DBusServer));
 196         _dbus_rmutex_new_at_location (&server->mutex);
 197         if (server->mutex == NULL)
 198             goto failed;
 199         server->address = address;
 200
 201         return server;
 202
 203 failed:
 204         dbus_free(server);
 205         return NULL;
 206 }
 207
 208
 209 /**
 210  * Finalizes the members of the DBusServer base class.
 211  * Chained up to by subclass finalizers.
 212  *
 213  * @param server the server.
 214  */
 215 void
 216 _dbus_server_finalize_base (DBusServer *server)
 217 {
 218   /* We don't have the lock, but nobody should be accessing
 219    * concurrently since they don't have a ref
 220    */
 221 #ifndef DBUS_DISABLE_CHECKS
 222   _dbus_assert (!server->have_server_lock);
 223 #endif
 224   _dbus_assert (server->disconnected);
 225
 226   /* calls out to application code... */
 227   _dbus_data_slot_list_free (&server->slot_list);
 228
 229   dbus_server_set_new_connection_function (server, NULL, NULL, NULL);
 230
 231   _dbus_watch_list_free (server->watches);
 232   _dbus_timeout_list_free (server->timeouts);
 233
 234   _dbus_rmutex_free_at_location (&server->mutex);
 235
 236   dbus_free (server->address);
 237
 238   dbus_free_string_array (server->auth_mechanisms);
 239
 240   _dbus_string_free (&server->guid_hex);
 241 }
 242
 243
 244 /** Function to be called in protected_change_watch() with refcount held */
 245 typedef dbus_bool_t (* DBusWatchAddFunction)     (DBusWatchList *list,
 246                                                   DBusWatch     *watch);
 247 /** Function to be called in protected_change_watch() with refcount held */
 248 typedef void        (* DBusWatchRemoveFunction)  (DBusWatchList *list,
 249                                                   DBusWatch     *watch);
 250 /** Function to be called in protected_change_watch() with refcount held */
 251 typedef void        (* DBusWatchToggleFunction)  (DBusWatchList *list,
 252                                                   DBusWatch     *watch,
 253                                                   dbus_bool_t    enabled);
 254
 255 static dbus_bool_t
 256 protected_change_watch (DBusServer             *server,
 257                         DBusWatch              *watch,
 258                         DBusWatchAddFunction    add_function,
 259                         DBusWatchRemoveFunction remove_function,
 260                         DBusWatchToggleFunction toggle_function,
 261                         dbus_bool_t             enabled)
 262 {
 263   DBusWatchList *watches;
 264   dbus_bool_t retval;
 265
 266   HAVE_LOCK_CHECK (server);
 267
 268   /* This isn't really safe or reasonable; a better pattern is the "do
 269    * everything, then drop lock and call out" one; but it has to be
 270    * propagated up through all callers
 271    */
 272
 273   watches = server->watches;
 274   if (watches)
 275     {
 276       server->watches = NULL;
 277       _dbus_server_ref_unlocked (server);
 278       SERVER_UNLOCK (server);
 279
 280       if (add_function)
 281         retval = (* add_function) (watches, watch);
 282       else if (remove_function)
 283         {
 284           retval = TRUE;
 285           (* remove_function) (watches, watch);
 286         }
 287       else
 288         {
 289           retval = TRUE;
 290           (* toggle_function) (watches, watch, enabled);
 291         }
 292
 293       SERVER_LOCK (server);
 294       server->watches = watches;
 295       _dbus_server_unref_unlocked (server);
 296
 297       return retval;
 298     }
 299   else
 300     return FALSE;
 301 }
 302
 303 /**
 304  * Adds a watch for this server, chaining out to application-provided
 305  * watch handlers.
 306  *
 307  * @param server the server.
 308  * @param watch the watch to add.
 309  */
 310 dbus_bool_t
 311 _dbus_server_add_watch (DBusServer *server,
 312                         DBusWatch  *watch)
 313 {
 314   HAVE_LOCK_CHECK (server);
 315   return protected_change_watch (server, watch,
 316                                  _dbus_watch_list_add_watch,
 317                                  NULL, NULL, FALSE);
 318 }
 319
 320 /**
 321  * Removes a watch previously added with _dbus_server_remove_watch().
 322  *
 323  * @param server the server.
 324  * @param watch the watch to remove.
 325  */
 326 void
 327 _dbus_server_remove_watch  (DBusServer *server,
 328                             DBusWatch  *watch)
 329 {
 330   HAVE_LOCK_CHECK (server);
 331   protected_change_watch (server, watch,
 332                           NULL,
 333                           _dbus_watch_list_remove_watch,
 334                           NULL, FALSE);
 335 }
 336
 337 /**
 338  * Toggles a watch and notifies app via server's
 339  * DBusWatchToggledFunction if available. It's an error to call this
 340  * function on a watch that was not previously added.
 341  *
 342  * @param server the server.
 343  * @param watch the watch to toggle.
 344  * @param enabled whether to enable or disable
 345  */
 346 void
 347 _dbus_server_toggle_watch (DBusServer  *server,
 348                            DBusWatch   *watch,
 349                            dbus_bool_t  enabled)
 350 {
 351   _dbus_assert (watch != NULL);
 352
 353   HAVE_LOCK_CHECK (server);
 354   protected_change_watch (server, watch,
 355                           NULL, NULL,
 356                           _dbus_watch_list_toggle_watch,
 357                           enabled);
 358 }
 359
 360 /** Function to be called in protected_change_timeout() with refcount held */
 361 typedef dbus_bool_t (* DBusTimeoutAddFunction)    (DBusTimeoutList *list,
 362                                                    DBusTimeout     *timeout);
 363 /** Function to be called in protected_change_timeout() with refcount held */
 364 typedef void        (* DBusTimeoutRemoveFunction) (DBusTimeoutList *list,
 365                                                    DBusTimeout     *timeout);
 366 /** Function to be called in protected_change_timeout() with refcount held */
 367 typedef void        (* DBusTimeoutToggleFunction) (DBusTimeoutList *list,
 368                                                    DBusTimeout     *timeout,
 369                                                    dbus_bool_t      enabled);
 370
 371
 372 static dbus_bool_t
 373 protected_change_timeout (DBusServer               *server,
 374                           DBusTimeout              *timeout,
 375                           DBusTimeoutAddFunction    add_function,
 376                           DBusTimeoutRemoveFunction remove_function,
 377                           DBusTimeoutToggleFunction toggle_function,
 378                           dbus_bool_t               enabled)
 379 {
 380   DBusTimeoutList *timeouts;
 381   dbus_bool_t retval;
 382
 383   HAVE_LOCK_CHECK (server);
 384
 385   /* This isn't really safe or reasonable; a better pattern is the "do everything, then
 386    * drop lock and call out" one; but it has to be propagated up through all callers
 387    */
 388
 389   timeouts = server->timeouts;
 390   if (timeouts)
 391     {
 392       server->timeouts = NULL;
 393       _dbus_server_ref_unlocked (server);
 394       SERVER_UNLOCK (server);
 395
 396       if (add_function)
 397         retval = (* add_function) (timeouts, timeout);
 398       else if (remove_function)
 399         {
 400           retval = TRUE;
 401           (* remove_function) (timeouts, timeout);
 402         }
 403       else
 404         {
 405           retval = TRUE;
 406           (* toggle_function) (timeouts, timeout, enabled);
 407         }
 408
 409       SERVER_LOCK (server);
 410       server->timeouts = timeouts;
 411       _dbus_server_unref_unlocked (server);
 412
 413       return retval;
 414     }
 415   else
 416     return FALSE;
 417 }
 418
 419 /**
 420  * Adds a timeout for this server, chaining out to
 421  * application-provided timeout handlers. The timeout should be
 422  * repeatedly handled with dbus_timeout_handle() at its given interval
 423  * until it is removed.
 424  *
 425  * @param server the server.
 426  * @param timeout the timeout to add.
 427  */
 428 dbus_bool_t
 429 _dbus_server_add_timeout (DBusServer  *server,
 430                           DBusTimeout *timeout)
 431 {
 432   return protected_change_timeout (server, timeout,
 433                                    _dbus_timeout_list_add_timeout,
 434                                    NULL, NULL, FALSE);
 435 }
 436
 437 /**
 438  * Removes a timeout previously added with _dbus_server_add_timeout().
 439  *
 440  * @param server the server.
 441  * @param timeout the timeout to remove.
 442  */
 443 void
 444 _dbus_server_remove_timeout (DBusServer  *server,
 445                              DBusTimeout *timeout)
 446 {
 447   protected_change_timeout (server, timeout,
 448                             NULL,
 449                             _dbus_timeout_list_remove_timeout,
 450                             NULL, FALSE);
 451 }
 452
 453 /**
 454  * Toggles a timeout and notifies app via server's
 455  * DBusTimeoutToggledFunction if available. It's an error to call this
 456  * function on a timeout that was not previously added.
 457  *
 458  * @param server the server.
 459  * @param timeout the timeout to toggle.
 460  * @param enabled whether to enable or disable
 461  */
 462 void
 463 _dbus_server_toggle_timeout (DBusServer  *server,
 464                              DBusTimeout *timeout,
 465                              dbus_bool_t  enabled)
 466 {
 467   protected_change_timeout (server, timeout,
 468                             NULL, NULL,
 469                             _dbus_timeout_list_toggle_timeout,
 470                             enabled);
 471 }
 472
 473
 474 /**
 475  * Like dbus_server_ref() but does not acquire the lock (must already be held)
 476  *
 477  * @param server the server.
 478  */
 479 void
 480 _dbus_server_ref_unlocked (DBusServer *server)
 481 {
 482   dbus_int32_t old_refcount;
 483
 484   _dbus_assert (server != NULL);
 485   HAVE_LOCK_CHECK (server);
 486
 487   old_refcount = _dbus_atomic_inc (&server->refcount);
 488   _dbus_assert (old_refcount > 0);
 489   _dbus_server_trace_ref (server, old_refcount, old_refcount + 1,
 490       "ref_unlocked");
 491 }
 492
 493 /**
 494  * Like dbus_server_unref() but does not acquire the lock (must already be held)
 495  *
 496  * @param server the server.
 497  */
 498 void
 499 _dbus_server_unref_unlocked (DBusServer *server)
 500 {
 501   dbus_int32_t old_refcount;
 502
 503   /* Keep this in sync with dbus_server_unref */
 504
 505   _dbus_assert (server != NULL);
 506
 507   HAVE_LOCK_CHECK (server);
 508
 509   old_refcount = _dbus_atomic_dec (&server->refcount);
 510   _dbus_assert (old_refcount > 0);
 511
 512   _dbus_server_trace_ref (server, old_refcount, old_refcount - 1,
 513       "unref_unlocked");
 514
 515   if (old_refcount == 1)
 516     {
 517       _dbus_assert (server->disconnected);
 518
 519       SERVER_UNLOCK (server);
 520
 521       _dbus_assert (server->vtable->finalize != NULL);
 522
 523       (* server->vtable->finalize) (server);
 524     }
 525 }
 526
 527 /** @} */
 528
 529 /**
 530  * @addtogroup DBusServer
 531  *
 532  * @{
 533  */
 534
 535
 536 /**
 537  * @typedef DBusServer
 538  *
 539  * An opaque object representing a server that listens for
 540  * connections from other applications. Each time a connection
 541  * is made, a new DBusConnection is created and made available
 542  * via an application-provided DBusNewConnectionFunction.
 543  * The DBusNewConnectionFunction is provided with
 544  * dbus_server_set_new_connection_function().
 545  *
 546  */
 547
 548 static const struct {
 549   DBusServerListenResult (* func) (DBusAddressEntry *entry,
 550                                    DBusServer      **server_p,
 551                                    DBusError        *error);
 552 } listen_funcs[] = {
 553   { _dbus_server_listen_socket }
 554   , { _dbus_server_listen_platform_specific }
 555 #ifdef DBUS_ENABLE_EMBEDDED_TESTS
 556   , { _dbus_server_listen_debug_pipe }
 557 #endif
 558 };
 559
 560 /**
 561  * Listens for new connections on the given address.  If there are
 562  * multiple semicolon-separated address entries in the address, tries
 563  * each one and listens on the first one that works.
 564  *
 565  * Returns #NULL and sets error if listening fails for any reason.
 566  * Otherwise returns a new #DBusServer.
 567  * dbus_server_set_new_connection_function(),
 568  * dbus_server_set_watch_functions(), and
 569  * dbus_server_set_timeout_functions() should be called immediately to
 570  * render the server fully functional.
 571  *
 572  * To free the server, applications must call first
 573  * dbus_server_disconnect() and then dbus_server_unref().
 574  *
 575  * @param address the address of this server.
 576  * @param error location to store reason for failure.
 577  * @returns a new #DBusServer, or #NULL on failure.
 578  *
 579  */
 580 DBusServer*
 581 dbus_server_listen (const char     *address,
 582                     DBusError      *error)
 583 {
 584   DBusServer *server;
 585   DBusAddressEntry **entries;
 586   int len, i;
 587   DBusError first_connect_error = DBUS_ERROR_INIT;
 588   dbus_bool_t handled_once;
 589
 590   _dbus_return_val_if_fail (address != NULL, NULL);
 591   _dbus_return_val_if_error_is_set (error, NULL);
 592
 593   if (!dbus_parse_address (address, &entries, &len, error))
 594     return NULL;
 595
 596   server = NULL;
 597   handled_once = FALSE;
 598
 599   for (i = 0; i < len; i++)
 600     {
 601       int j;
 602
 603       for (j = 0; j < (int) _DBUS_N_ELEMENTS (listen_funcs); ++j)
 604         {
 605           DBusServerListenResult result;
 606           DBusError tmp_error = DBUS_ERROR_INIT;
 607
 608           result = (* listen_funcs[j].func) (entries[i],
 609                                              &server,
 610                                              &tmp_error);
 611
 612           if (result == DBUS_SERVER_LISTEN_OK)
 613             {
 614               _dbus_assert (server != NULL);
 615               _DBUS_ASSERT_ERROR_IS_CLEAR (&tmp_error);
 616               handled_once = TRUE;
 617               goto out;
 618             }
 619           else if (result == DBUS_SERVER_LISTEN_ADDRESS_ALREADY_USED)
 620             {
 621               _dbus_assert (server == NULL);
 622               dbus_set_error (error,
 623                        DBUS_ERROR_ADDRESS_IN_USE,
 624                        "Address '%s' already used",
 625                        dbus_address_entry_get_method (entries[0]));
 626               handled_once = TRUE;
 627               goto out;
 628             }
 629           else if (result == DBUS_SERVER_LISTEN_BAD_ADDRESS)
 630             {
 631               _dbus_assert (server == NULL);
 632               _DBUS_ASSERT_ERROR_IS_SET (&tmp_error);
 633               dbus_move_error (&tmp_error, error);
 634               handled_once = TRUE;
 635               goto out;
 636             }
 637           else if (result == DBUS_SERVER_LISTEN_NOT_HANDLED)
 638             {
 639               _dbus_assert (server == NULL);
 640               _DBUS_ASSERT_ERROR_IS_CLEAR (&tmp_error);
 641
 642               /* keep trying addresses */
 643             }
 644           else if (result == DBUS_SERVER_LISTEN_DID_NOT_CONNECT)
 645             {
 646               _dbus_assert (server == NULL);
 647               _DBUS_ASSERT_ERROR_IS_SET (&tmp_error);
 648               if (!dbus_error_is_set (&first_connect_error))
 649                 dbus_move_error (&tmp_error, &first_connect_error);
 650               else
 651                 dbus_error_free (&tmp_error);
 652
 653               handled_once = TRUE;
 654
 655               /* keep trying addresses */
 656             }
 657         }
 658
 659       _dbus_assert (server == NULL);
 660       _DBUS_ASSERT_ERROR_IS_CLEAR (error);
 661     }
 662
 663  out:
 664
 665   if (!handled_once)
 666     {
 667       _DBUS_ASSERT_ERROR_IS_CLEAR (error);
 668       if (len > 0)
 669         dbus_set_error (error,
 670                        DBUS_ERROR_BAD_ADDRESS,
 671                        "Unknown address type '%s'",
 672                        dbus_address_entry_get_method (entries[0]));
 673       else
 674         dbus_set_error (error,
 675                         DBUS_ERROR_BAD_ADDRESS,
 676                         "Empty address '%s'",
 677                         address);
 678     }
 679
 680   dbus_address_entries_free (entries);
 681
 682   if (server == NULL)
 683     {
 684       _dbus_assert (error == NULL || dbus_error_is_set (&first_connect_error) ||
 685                    dbus_error_is_set (error));
 686
 687       if (error && dbus_error_is_set (error))
 688         {
 689           /* already set the error */
 690         }
 691       else
 692         {
 693           /* didn't set the error but either error should be
 694            * NULL or first_connect_error should be set.
 695            */
 696           _dbus_assert (error == NULL || dbus_error_is_set (&first_connect_error));
 697           dbus_move_error (&first_connect_error, error);
 698         }
 699
 700       _DBUS_ASSERT_ERROR_IS_CLEAR (&first_connect_error); /* be sure we freed it */
 701       _DBUS_ASSERT_ERROR_IS_SET (error);
 702
 703       return NULL;
 704     }
 705   else
 706     {
 707       _DBUS_ASSERT_ERROR_IS_CLEAR (error);
 708       return server;
 709     }
 710 }
 711
 712 /**
 713  * Increments the reference count of a DBusServer.
 714  *
 715  * @param server the server.
 716  * @returns the server
 717  */
 718 DBusServer *
 719 dbus_server_ref (DBusServer *server)
 720 {
 721   dbus_int32_t old_refcount;
 722
 723   _dbus_return_val_if_fail (server != NULL, NULL);
 724
 725   old_refcount = _dbus_atomic_inc (&server->refcount);
 726
 727 #ifndef DBUS_DISABLE_CHECKS
 728   if (_DBUS_UNLIKELY (old_refcount <= 0))
 729     {
 730       _dbus_atomic_dec (&server->refcount);
 731       _dbus_warn_check_failed (_dbus_return_if_fail_warning_format,
 732                                _DBUS_FUNCTION_NAME, "old_refcount > 0",
 733                                __FILE__, __LINE__);
 734       return NULL;
 735     }
 736 #endif
 737
 738   _dbus_server_trace_ref (server, old_refcount, old_refcount + 1, "ref");
 739
 740   return server;
 741 }
 742
 743 /**
 744  * Decrements the reference count of a DBusServer.  Finalizes the
 745  * server if the reference count reaches zero.
 746  *
 747  * The server must be disconnected before the refcount reaches zero.
 748  *
 749  * @param server the server.
 750  */
 751 void
 752 dbus_server_unref (DBusServer *server)
 753 {
 754   dbus_int32_t old_refcount;
 755
 756   /* keep this in sync with unref_unlocked */
 757
 758   _dbus_return_if_fail (server != NULL);
 759
 760   old_refcount = _dbus_atomic_dec (&server->refcount);
 761
 762 #ifndef DBUS_DISABLE_CHECKS
 763   if (_DBUS_UNLIKELY (old_refcount <= 0))
 764     {
 765       /* undo side-effect first
 766        * please do not try to simplify the code here by using
 767        * _dbus_atomic_get(), why we don't use it is
 768        * because it issues another atomic operation even though
 769        * DBUS_DISABLE_CHECKS defined.
 770        * Bug: https://bugs.freedesktop.org/show_bug.cgi?id=68303
 771        */
 772       _dbus_atomic_inc (&server->refcount);
 773       _dbus_warn_check_failed (_dbus_return_if_fail_warning_format,
 774                                _DBUS_FUNCTION_NAME, "old_refcount > 0",
 775                                __FILE__, __LINE__);
 776       return;
 777     }
 778 #endif
 779
 780   _dbus_server_trace_ref (server, old_refcount, old_refcount - 1, "unref");
 781
 782   if (old_refcount == 1)
 783     {
 784       /* lock not held! */
 785       _dbus_assert (server->disconnected);
 786
 787       _dbus_assert (server->vtable->finalize != NULL);
 788
 789       (* server->vtable->finalize) (server);
 790     }
 791 }
 792
 793 /**
 794  * Releases the server's address and stops listening for
 795  * new clients. If called more than once, only the first
 796  * call has an effect. Does not modify the server's
 797  * reference count.
 798  *
 799  * @param server the server.
 800  */
 801 void
 802 dbus_server_disconnect (DBusServer *server)
 803 {
 804   _dbus_return_if_fail (server != NULL);
 805
 806   dbus_server_ref (server);
 807   SERVER_LOCK (server);
 808
 809   _dbus_assert (server->vtable->disconnect != NULL);
 810
 811   if (!server->disconnected)
 812     {
 813       /* this has to be first so recursive calls to disconnect don't happen */
 814       server->disconnected = TRUE;
 815
 816       (* server->vtable->disconnect) (server);
 817     }
 818
 819   SERVER_UNLOCK (server);
 820   dbus_server_unref (server);
 821 }
 822
 823 /**
 824  * Returns #TRUE if the server is still listening for new connections.
 825  *
 826  * @param server the server.
 827  */
 828 dbus_bool_t
 829 dbus_server_get_is_connected (DBusServer *server)
 830 {
 831   dbus_bool_t retval;
 832
 833   _dbus_return_val_if_fail (server != NULL, FALSE);
 834
 835   SERVER_LOCK (server);
 836   retval = !server->disconnected;
 837   SERVER_UNLOCK (server);
 838
 839   return retval;
 840 }
 841
 842 /**
 843  * Returns the address of the server, as a newly-allocated
 844  * string which must be freed by the caller.
 845  *
 846  * @param server the server
 847  * @returns the address or #NULL if no memory
 848  */
 849 char*
 850 dbus_server_get_address (DBusServer *server)
 851 {
 852   char *retval;
 853
 854   _dbus_return_val_if_fail (server != NULL, NULL);
 855
 856   SERVER_LOCK (server);
 857   retval = _dbus_strdup (server->address);
 858   SERVER_UNLOCK (server);
 859
 860   return retval;
 861 }
 862
 863 /**
 864  * Returns the unique ID of the server, as a newly-allocated
 865  * string which must be freed by the caller. This ID is
 866  * normally used by clients to tell when two #DBusConnection
 867  * would be equivalent (because the server address passed
 868  * to dbus_connection_open() will have the same guid in the
 869  * two cases). dbus_connection_open() can re-use an existing
 870  * connection with the same ID instead of opening a new
 871  * connection.
 872  *
 873  * This is an ID unique to each #DBusServer. Remember that
 874  * a #DBusServer represents only one mode of connecting,
 875  * so e.g. a bus daemon can listen on multiple addresses
 876  * which will mean it has multiple #DBusServer each with
 877  * their own ID.
 878  *
 879  * The ID is not a UUID in the sense of RFC4122; the details
 880  * are explained in the D-Bus specification.
 881  *
 882  * @param server the server
 883  * @returns the id of the server or #NULL if no memory
 884  */
 885 char*
 886 dbus_server_get_id (DBusServer *server)
 887 {
 888   char *retval;
 889
 890   _dbus_return_val_if_fail (server != NULL, NULL);
 891
 892   SERVER_LOCK (server);
 893   retval = NULL;
 894   _dbus_string_copy_data (&server->guid_hex, &retval);
 895   SERVER_UNLOCK (server);
 896
 897   return retval;
 898 }
 899
 900 /**
 901  * Sets a function to be used for handling new connections.  The given
 902  * function is passed each new connection as the connection is
 903  * created. If the new connection function increments the connection's
 904  * reference count, the connection will stay alive. Otherwise, the
 905  * connection will be unreferenced and closed. The new connection
 906  * function may also close the connection itself, which is considered
 907  * good form if the connection is not wanted.
 908  *
 909  * The connection here is private in the sense of
 910  * dbus_connection_open_private(), so if the new connection function
 911  * keeps a reference it must arrange for the connection to be closed.
 912  * i.e. libdbus does not own this connection once the new connection
 913  * function takes a reference.
 914  *
 915  * @param server the server.
 916  * @param function a function to handle new connections.
 917  * @param data data to pass to the new connection handler.
 918  * @param free_data_function function to free the data.
 919  */
 920 void
 921 dbus_server_set_new_connection_function (DBusServer                *server,
 922                                          DBusNewConnectionFunction  function,
 923                                          void                      *data,
 924                                          DBusFreeFunction           free_data_function)
 925 {
 926   DBusFreeFunction old_free_function;
 927   void *old_data;
 928
 929   _dbus_return_if_fail (server != NULL);
 930
 931   SERVER_LOCK (server);
 932   old_free_function = server->new_connection_free_data_function;
 933   old_data = server->new_connection_data;
 934
 935   server->new_connection_function = function;
 936   server->new_connection_data = data;
 937   server->new_connection_free_data_function = free_data_function;
 938   SERVER_UNLOCK (server);
 939
 940   if (old_free_function != NULL)
 941     (* old_free_function) (old_data);
 942 }
 943
 944 /**
 945  * Sets the watch functions for the server. These functions are
 946  * responsible for making the application's main loop aware of file
 947  * descriptors that need to be monitored for events.
 948  *
 949  * This function behaves exactly like dbus_connection_set_watch_functions();
 950  * see the documentation for that routine.
 951  *
 952  * @param server the server.
 953  * @param add_function function to begin monitoring a new descriptor.
 954  * @param remove_function function to stop monitoring a descriptor.
 955  * @param toggled_function function to notify when the watch is enabled/disabled
 956  * @param data data to pass to add_function and remove_function.
 957  * @param free_data_function function to be called to free the data.
 958  * @returns #FALSE on failure (no memory)
 959  */
 960 dbus_bool_t
 961 dbus_server_set_watch_functions (DBusServer              *server,
 962                                  DBusAddWatchFunction     add_function,
 963                                  DBusRemoveWatchFunction  remove_function,
 964                                  DBusWatchToggledFunction toggled_function,
 965                                  void                    *data,
 966                                  DBusFreeFunction         free_data_function)
 967 {
 968   dbus_bool_t result;
 969   DBusWatchList *watches;
 970
 971   _dbus_return_val_if_fail (server != NULL, FALSE);
 972
 973   SERVER_LOCK (server);
 974   watches = server->watches;
 975   server->watches = NULL;
 976   if (watches)
 977     {
 978       SERVER_UNLOCK (server);
 979       result = _dbus_watch_list_set_functions (watches,
 980                                                add_function,
 981                                                remove_function,
 982                                                toggled_function,
 983                                                data,
 984                                                free_data_function);
 985       SERVER_LOCK (server);
 986     }
 987   else
 988     {
 989       _dbus_warn_check_failed ("Re-entrant call to %s\n", _DBUS_FUNCTION_NAME);
 990       result = FALSE;
 991     }
 992   server->watches = watches;
 993   SERVER_UNLOCK (server);
 994
 995   return result;
 996 }
 997
 998 /**
 999  * Sets the timeout functions for the server. These functions are
1000  * responsible for making the application's main loop aware of timeouts.
1001  *
1002  * This function behaves exactly like dbus_connection_set_timeout_functions();
1003  * see the documentation for that routine.
1004  *
1005  * @param server the server.
1006  * @param add_function function to add a timeout.
1007  * @param remove_function function to remove a timeout.
1008  * @param toggled_function function to notify when the timeout is enabled/disabled
1009  * @param data data to pass to add_function and remove_function.
1010  * @param free_data_function function to be called to free the data.
1011  * @returns #FALSE on failure (no memory)
1012  */
1013 dbus_bool_t
1014 dbus_server_set_timeout_functions (DBusServer                *server,
1015                                    DBusAddTimeoutFunction     add_function,
1016                                    DBusRemoveTimeoutFunction  remove_function,
1017                                    DBusTimeoutToggledFunction toggled_function,
1018                                    void                      *data,
1019                                    DBusFreeFunction           free_data_function)
1020 {
1021   dbus_bool_t result;
1022   DBusTimeoutList *timeouts;
1023
1024   _dbus_return_val_if_fail (server != NULL, FALSE);
1025
1026   SERVER_LOCK (server);
1027   timeouts = server->timeouts;
1028   server->timeouts = NULL;
1029   if (timeouts)
1030     {
1031       SERVER_UNLOCK (server);
1032       result = _dbus_timeout_list_set_functions (timeouts,
1033                                                  add_function,
1034                                                  remove_function,
1035                                                  toggled_function,
1036                                                  data,
1037                                                  free_data_function);
1038       SERVER_LOCK (server);
1039     }
1040   else
1041     {
1042       _dbus_warn_check_failed ("Re-entrant call to %s\n", _DBUS_FUNCTION_NAME);
1043       result = FALSE;
1044     }
1045   server->timeouts = timeouts;
1046   SERVER_UNLOCK (server);
1047
1048   return result;
1049 }
1050
1051 /**
1052  * Sets the authentication mechanisms that this server offers to
1053  * clients, as a #NULL-terminated array of mechanism names. This
1054  * function only affects connections created <em>after</em> it is
1055  * called.  Pass #NULL instead of an array to use all available
1056  * mechanisms (this is the default behavior).
1057  *
1058  * The D-Bus specification describes some of the supported mechanisms.
1059  *
1060  * @param server the server
1061  * @param mechanisms #NULL-terminated array of mechanisms
1062  * @returns #FALSE if no memory
1063  */
1064 dbus_bool_t
1065 dbus_server_set_auth_mechanisms (DBusServer  *server,
1066                                  const char **mechanisms)
1067 {
1068   char **copy;
1069
1070   _dbus_return_val_if_fail (server != NULL, FALSE);
1071
1072   SERVER_LOCK (server);
1073
1074   if (mechanisms != NULL)
1075     {
1076       copy = _dbus_dup_string_array (mechanisms);
1077       if (copy == NULL)
1078         return FALSE;
1079     }
1080   else
1081     copy = NULL;
1082
1083   dbus_free_string_array (server->auth_mechanisms);
1084   server->auth_mechanisms = copy;
1085
1086   SERVER_UNLOCK (server);
1087
1088   return TRUE;
1089 }
1090
1091 static DBusDataSlotAllocator slot_allocator =
1092   _DBUS_DATA_SLOT_ALLOCATOR_INIT (_DBUS_LOCK_NAME (server_slots));
1093
1094 /**
1095  * Allocates an integer ID to be used for storing application-specific
1096  * data on any DBusServer. The allocated ID may then be used
1097  * with dbus_server_set_data() and dbus_server_get_data().
1098  * The slot must be initialized with -1. If a nonnegative
1099  * slot is passed in, the refcount is incremented on that
1100  * slot, rather than creating a new slot.
1101  *
1102  * The allocated slot is global, i.e. all DBusServer objects will have
1103  * a slot with the given integer ID reserved.
1104  *
1105  * @param slot_p address of global variable storing the slot ID
1106  * @returns #FALSE on no memory
1107  */
1108 dbus_bool_t
1109 dbus_server_allocate_data_slot (dbus_int32_t *slot_p)
1110 {
1111   return _dbus_data_slot_allocator_alloc (&slot_allocator,
1112                                           slot_p);
1113 }
1114
1115 /**
1116  * Deallocates a global ID for server data slots.
1117  * dbus_server_get_data() and dbus_server_set_data()
1118  * may no longer be used with this slot.
1119  * Existing data stored on existing DBusServer objects
1120  * will be freed when the server is finalized,
1121  * but may not be retrieved (and may only be replaced
1122  * if someone else reallocates the slot).
1123  *
1124  * @param slot_p address of the slot to deallocate
1125  */
1126 void
1127 dbus_server_free_data_slot (dbus_int32_t *slot_p)
1128 {
1129   _dbus_return_if_fail (*slot_p >= 0);
1130
1131   _dbus_data_slot_allocator_free (&slot_allocator, slot_p);
1132 }
1133
1134 /**
1135  * Stores a pointer on a DBusServer, along
1136  * with an optional function to be used for freeing
1137  * the data when the data is set again, or when
1138  * the server is finalized. The slot number
1139  * must have been allocated with dbus_server_allocate_data_slot().
1140  *
1141  * @param server the server
1142  * @param slot the slot number
1143  * @param data the data to store
1144  * @param free_data_func finalizer function for the data
1145  * @returns #TRUE if there was enough memory to store the data
1146  */
1147 dbus_bool_t
1148 dbus_server_set_data (DBusServer       *server,
1149                       int               slot,
1150                       void             *data,
1151                       DBusFreeFunction  free_data_func)
1152 {
1153   DBusFreeFunction old_free_func;
1154   void *old_data;
1155   dbus_bool_t retval;
1156
1157   _dbus_return_val_if_fail (server != NULL, FALSE);
1158
1159   SERVER_LOCK (server);
1160
1161   retval = _dbus_data_slot_list_set (&slot_allocator,
1162                                      &server->slot_list,
1163                                      slot, data, free_data_func,
1164                                      &old_free_func, &old_data);
1165
1166
1167   SERVER_UNLOCK (server);
1168
1169   if (retval)
1170     {
1171       /* Do the actual free outside the server lock */
1172       if (old_free_func)
1173         (* old_free_func) (old_data);
1174     }
1175
1176   return retval;
1177 }
1178
1179 /**
1180  * Retrieves data previously set with dbus_server_set_data().
1181  * The slot must still be allocated (must not have been freed).
1182  *
1183  * @param server the server
1184  * @param slot the slot to get data from
1185  * @returns the data, or #NULL if not found
1186  */
1187 void*
1188 dbus_server_get_data (DBusServer   *server,
1189                       int           slot)
1190 {
1191   void *res;
1192
1193   _dbus_return_val_if_fail (server != NULL, NULL);
1194
1195   SERVER_LOCK (server);
1196
1197   res = _dbus_data_slot_list_get (&slot_allocator,
1198                                   &server->slot_list,
1199                                   slot);
1200
1201   SERVER_UNLOCK (server);
1202
1203   return res;
1204 }
1205
1206 /** @} */
1207
1208 #ifdef DBUS_ENABLE_EMBEDDED_TESTS
1209 #include "dbus-test.h"
1210 #include <string.h>
1211
1212 dbus_bool_t
1213 _dbus_server_test (void)
1214 {
1215   const char *valid_addresses[] = {
1216     "tcp:port=1234",
1217     "tcp:host=localhost,port=1234",
1218     "tcp:host=localhost,port=1234;tcp:port=5678",
1219 #ifdef DBUS_UNIX
1220     "unix:path=./boogie",
1221     "tcp:port=1234;unix:path=./boogie",
1222 #endif
1223   };
1224
1225   DBusServer *server;
1226   int i;
1227
1228   for (i = 0; i < _DBUS_N_ELEMENTS (valid_addresses); i++)
1229     {
1230       DBusError error = DBUS_ERROR_INIT;
1231       char *address;
1232       char *id;
1233
1234       server = dbus_server_listen (valid_addresses[i], &error);
1235       if (server == NULL)
1236         {
1237           _dbus_warn ("server listen error: %s: %s\n", error.name, error.message);
1238           dbus_error_free (&error);
1239           _dbus_assert_not_reached ("Failed to listen for valid address.");
1240         }
1241
1242       id = dbus_server_get_id (server);
1243       _dbus_assert (id != NULL);
1244       address = dbus_server_get_address (server);
1245       _dbus_assert (address != NULL);
1246
1247       if (strstr (address, id) == NULL)
1248         {
1249           _dbus_warn ("server id '%s' is not in the server address '%s'\n",
1250                       id, address);
1251           _dbus_assert_not_reached ("bad server id or address");
1252         }
1253
1254       dbus_free (id);
1255       dbus_free (address);
1256
1257       dbus_server_disconnect (server);
1258       dbus_server_unref (server);
1259     }
1260
1261   return TRUE;
1262 }
1263
1264 #endif /* DBUS_ENABLE_EMBEDDED_TESTS */