dbus/dbus-server.c

   1 /* -*- mode: C; c-file-style: "gnu" -*- */
   2 /* dbus-server.c DBusServer object
   3  *
   4  * Copyright (C) 2002, 2003 Red Hat Inc.
   5  *
   6  * Licensed under the Academic Free License version 1.2
   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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  *
  22  */
  23
  24 #include "dbus-server.h"
  25 #include "dbus-server-unix.h"
  26 #ifdef DBUS_BUILD_TESTS
  27 #include "dbus-server-debug.h"
  28 #endif
  29 #include "dbus-address.h"
  30
  31 /**
  32  * @defgroup DBusServer DBusServer
  33  * @ingroup  DBus
  34  * @brief Server that listens for new connections.
  35  *
  36  * Types and functions related to DBusServer.
  37  * A DBusServer represents a server that other applications
  38  * can connect to. Each connection from another application
  39  * is represented by a DBusConnection.
  40  *
  41  * @todo Thread safety hasn't been looked at for #DBusServer
  42  * @todo Need notification to apps of disconnection, may matter for some transports
  43  */
  44
  45 /**
  46  * @defgroup DBusServerInternals DBusServer implementation details
  47  * @ingroup  DBusInternals
  48  * @brief Implementation details of DBusServer
  49  *
  50  * @{
  51  */
  52
  53 /**
  54  * Initializes the members of the DBusServer base class.
  55  * Chained up to by subclass constructors.
  56  *
  57  * @param server the server.
  58  * @param vtable the vtable for the subclass.
  59  * @returns #TRUE on success.
  60  */
  61 dbus_bool_t
  62 _dbus_server_init_base (DBusServer             *server,
  63                         const DBusServerVTable *vtable)
  64 {
  65   server->vtable = vtable;
  66   server->refcount = 1;
  67
  68   server->watches = _dbus_watch_list_new ();
  69   if (server->watches == NULL)
  70     return FALSE;
  71
  72   server->timeouts = _dbus_timeout_list_new ();
  73   if (server->timeouts == NULL)
  74     {
  75       _dbus_watch_list_free (server->watches);
  76       server->watches = NULL;
  77       return FALSE;
  78     }
  79
  80   server->connection_counter = _dbus_counter_new ();
  81   if (server->connection_counter == NULL)
  82     {
  83       _dbus_watch_list_free (server->watches);
  84       server->watches = NULL;
  85       _dbus_timeout_list_free (server->timeouts);
  86       server->timeouts = NULL;
  87
  88       return FALSE;
  89     }
  90
  91   server->max_connections = 256; /* same as an X server, seems like a nice default */
  92
  93   _dbus_data_slot_list_init (&server->slot_list);
  94
  95   return TRUE;
  96 }
  97
  98 /**
  99  * Finalizes the members of the DBusServer base class.
 100  * Chained up to by subclass finalizers.
 101  *
 102  * @param server the server.
 103  */
 104 void
 105 _dbus_server_finalize_base (DBusServer *server)
 106 {
 107   /* calls out to application code... */
 108   _dbus_data_slot_list_free (&server->slot_list);
 109
 110   dbus_server_set_new_connection_function (server, NULL, NULL, NULL);
 111
 112   if (!server->disconnected)
 113     dbus_server_disconnect (server);
 114
 115   _dbus_watch_list_free (server->watches);
 116   _dbus_timeout_list_free (server->timeouts);
 117   _dbus_counter_unref (server->connection_counter);
 118 }
 119
 120 /**
 121  * Adds a watch for this server, chaining out to application-provided
 122  * watch handlers.
 123  *
 124  * @param server the server.
 125  * @param watch the watch to add.
 126  */
 127 dbus_bool_t
 128 _dbus_server_add_watch (DBusServer *server,
 129                         DBusWatch  *watch)
 130 {
 131   return _dbus_watch_list_add_watch (server->watches, watch);
 132 }
 133
 134 /**
 135  * Removes a watch previously added with _dbus_server_remove_watch().
 136  *
 137  * @param server the server.
 138  * @param watch the watch to remove.
 139  */
 140 void
 141 _dbus_server_remove_watch  (DBusServer *server,
 142                             DBusWatch  *watch)
 143 {
 144   _dbus_watch_list_remove_watch (server->watches, watch);
 145 }
 146
 147 /**
 148  * Adds a timeout for this server, chaining out to
 149  * application-provided timeout handlers. The timeout should be
 150  * repeatedly handled with dbus_timeout_handle() at its given interval
 151  * until it is removed.
 152  *
 153  * @param server the server.
 154  * @param timeout the timeout to add.
 155  */
 156 dbus_bool_t
 157 _dbus_server_add_timeout (DBusServer  *server,
 158                           DBusTimeout *timeout)
 159 {
 160   return _dbus_timeout_list_add_timeout (server->timeouts, timeout);
 161 }
 162
 163 /**
 164  * Removes a timeout previously added with _dbus_server_add_timeout().
 165  *
 166  * @param server the server.
 167  * @param timeout the timeout to remove.
 168  */
 169 void
 170 _dbus_server_remove_timeout (DBusServer  *server,
 171                              DBusTimeout *timeout)
 172 {
 173   _dbus_timeout_list_remove_timeout (server->timeouts, timeout);
 174 }
 175
 176 /** @} */
 177
 178 /**
 179  * @addtogroup DBusServer
 180  *
 181  * @{
 182  */
 183
 184
 185 /**
 186  * @typedef DBusServer
 187  *
 188  * An opaque object representing a server that listens for
 189  * connections from other applications. Each time a connection
 190  * is made, a new DBusConnection is created and made available
 191  * via an application-provided DBusNewConnectionFunction.
 192  * The DBusNewConnectionFunction is provided with
 193  * dbus_server_set_new_connection_function().
 194  *
 195  */
 196
 197 /**
 198  * Listens for new connections on the given address.
 199  * Returns #NULL if listening fails for any reason.
 200  * Otherwise returns a new #DBusServer.
 201  * dbus_server_set_new_connection_function() and
 202  * dbus_server_set_watch_functions() should be called
 203  * immediately to render the server fully functional.
 204  *
 205  * @todo error messages on bad address could really be better.
 206  * DBusResultCode is a bit limiting here.
 207  *
 208  * @param address the address of this server.
 209  * @param result location to store rationale for failure.
 210  * @returns a new DBusServer, or #NULL on failure.
 211  *
 212  */
 213 DBusServer*
 214 dbus_server_listen (const char     *address,
 215                     DBusResultCode *result)
 216 {
 217   DBusServer *server;
 218   DBusAddressEntry **entries;
 219   int len, i;
 220
 221   if (!dbus_parse_address (address, &entries, &len, result))
 222     return NULL;
 223
 224   server = NULL;
 225
 226   for (i = 0; i < len; i++)
 227     {
 228       const char *method = dbus_address_entry_get_method (entries[i]);
 229
 230       if (strcmp (method, "unix") == 0)
 231         {
 232           const char *path = dbus_address_entry_get_value (entries[i], "path");
 233
 234           if (path == NULL)
 235             goto bad_address;
 236
 237           server = _dbus_server_new_for_domain_socket (path, result);
 238
 239           if (server)
 240             break;
 241         }
 242       else if (strcmp (method, "tcp") == 0)
 243         {
 244           const char *host = dbus_address_entry_get_value (entries[i], "host");
 245           const char *port = dbus_address_entry_get_value (entries[i], "port");
 246           DBusString  str;
 247           long lport;
 248           dbus_bool_t sresult;
 249
 250           if (port == NULL)
 251             goto bad_address;
 252
 253           _dbus_string_init_const (&str, port);
 254           sresult = _dbus_string_parse_int (&str, 0, &lport, NULL);
 255           _dbus_string_free (&str);
 256
 257           if (sresult == FALSE || lport <= 0 || lport > 65535)
 258             goto bad_address;
 259
 260           server = _dbus_server_new_for_tcp_socket (host, lport, result);
 261
 262           if (server)
 263             break;
 264         }
 265 #ifdef DBUS_BUILD_TESTS
 266       else if (strcmp (method, "debug") == 0)
 267         {
 268           const char *name = dbus_address_entry_get_value (entries[i], "name");
 269
 270           if (name == NULL)
 271             goto bad_address;
 272
 273           server = _dbus_server_debug_new (name, result);
 274
 275           if (server)
 276             break;
 277         }
 278 #endif
 279       else
 280         goto bad_address;
 281     }
 282
 283   dbus_address_entries_free (entries);
 284   return server;
 285
 286  bad_address:
 287   dbus_address_entries_free (entries);
 288   dbus_set_result (result, DBUS_RESULT_BAD_ADDRESS);
 289
 290   return NULL;
 291 }
 292
 293 /**
 294  * Increments the reference count of a DBusServer.
 295  *
 296  * @param server the server.
 297  */
 298 void
 299 dbus_server_ref (DBusServer *server)
 300 {
 301   server->refcount += 1;
 302 }
 303
 304 /**
 305  * Decrements the reference count of a DBusServer.  Finalizes the
 306  * server if the reference count reaches zero. The server connection
 307  * will be closed as with dbus_server_disconnect() when the server is
 308  * finalized.
 309  *
 310  * @param server the server.
 311  */
 312 void
 313 dbus_server_unref (DBusServer *server)
 314 {
 315   _dbus_assert (server != NULL);
 316   _dbus_assert (server->refcount > 0);
 317
 318   server->refcount -= 1;
 319   if (server->refcount == 0)
 320     {
 321       _dbus_assert (server->vtable->finalize != NULL);
 322
 323       (* server->vtable->finalize) (server);
 324     }
 325 }
 326
 327 /**
 328  * Releases the server's address and stops listening for
 329  * new clients. If called more than once, only the first
 330  * call has an effect. Does not modify the server's
 331  * reference count.
 332  *
 333  * @param server the server.
 334  */
 335 void
 336 dbus_server_disconnect (DBusServer *server)
 337 {
 338   _dbus_assert (server->vtable->disconnect != NULL);
 339
 340   if (server->disconnected)
 341     return;
 342
 343   (* server->vtable->disconnect) (server);
 344   server->disconnected = TRUE;
 345 }
 346
 347 /**
 348  * Returns #TRUE if the server is still listening for new connections.
 349  *
 350  * @param server the server.
 351  */
 352 dbus_bool_t
 353 dbus_server_get_is_connected (DBusServer *server)
 354 {
 355   return !server->disconnected;
 356 }
 357
 358 /**
 359  * Sets a function to be used for handling new connections.  The given
 360  * function is passed each new connection as the connection is
 361  * created. If the new connection function increments the connection's
 362  * reference count, the connection will stay alive. Otherwise, the
 363  * connection will be unreferenced and closed.
 364  *
 365  * @param server the server.
 366  * @param function a function to handle new connections.
 367  * @param data data to pass to the new connection handler.
 368  * @param free_data_function function to free the data.
 369  */
 370 void
 371 dbus_server_set_new_connection_function (DBusServer                *server,
 372                                          DBusNewConnectionFunction  function,
 373                                          void                      *data,
 374                                          DBusFreeFunction           free_data_function)
 375 {
 376   if (server->new_connection_free_data_function != NULL)
 377     (* server->new_connection_free_data_function) (server->new_connection_data);
 378
 379   server->new_connection_function = function;
 380   server->new_connection_data = data;
 381   server->new_connection_free_data_function = free_data_function;
 382 }
 383
 384 /**
 385  * Sets the watch functions for the connection. These functions are
 386  * responsible for making the application's main loop aware of file
 387  * descriptors that need to be monitored for events.
 388  *
 389  * This function behaves exactly like dbus_connection_set_watch_functions();
 390  * see the documentation for that routine.
 391  *
 392  * @param server the server.
 393  * @param add_function function to begin monitoring a new descriptor.
 394  * @param remove_function function to stop monitoring a descriptor.
 395  * @param data data to pass to add_function and remove_function.
 396  * @param free_data_function function to be called to free the data.
 397  * @returns #FALSE on failure (no memory)
 398  */
 399 dbus_bool_t
 400 dbus_server_set_watch_functions (DBusServer              *server,
 401                                  DBusAddWatchFunction     add_function,
 402                                  DBusRemoveWatchFunction  remove_function,
 403                                  void                    *data,
 404                                  DBusFreeFunction         free_data_function)
 405 {
 406   return _dbus_watch_list_set_functions (server->watches,
 407                                          add_function,
 408                                          remove_function,
 409                                          data,
 410                                          free_data_function);
 411 }
 412
 413 /**
 414  * Sets the timeout functions for the connection. These functions are
 415  * responsible for making the application's main loop aware of timeouts.
 416  *
 417  * This function behaves exactly like dbus_connection_set_timeout_functions();
 418  * see the documentation for that routine.
 419  *
 420  * @param server the server.
 421  * @param add_function function to add a timeout.
 422  * @param remove_function function to remove a timeout.
 423  * @param data data to pass to add_function and remove_function.
 424  * @param free_data_function function to be called to free the data.
 425  * @returns #FALSE on failure (no memory)
 426  */
 427 dbus_bool_t
 428 dbus_server_set_timeout_functions (DBusServer                *server,
 429                                    DBusAddTimeoutFunction     add_function,
 430                                    DBusRemoveTimeoutFunction  remove_function,
 431                                    void                      *data,
 432                                    DBusFreeFunction           free_data_function)
 433 {
 434   return _dbus_timeout_list_set_functions (server->timeouts,
 435                                            add_function, remove_function,
 436                                            data, free_data_function);
 437 }
 438
 439 /**
 440  * Called to notify the server when a previously-added watch
 441  * is ready for reading or writing, or has an exception such
 442  * as a hangup.
 443  *
 444  * @param server the server.
 445  * @param watch the watch.
 446  * @param condition the current condition of the file descriptors being watched.
 447  */
 448 void
 449 dbus_server_handle_watch (DBusServer              *server,
 450                           DBusWatch               *watch,
 451                           unsigned int             condition)
 452 {
 453   _dbus_assert (server->vtable->handle_watch != NULL);
 454
 455   _dbus_watch_sanitize_condition (watch, &condition);
 456
 457   (* server->vtable->handle_watch) (server, watch, condition);
 458 }
 459
 460 /**
 461  * Sets the maximum number of connections that can be open at one
 462  * time for this server. If the maximum is reached, and another
 463  * client tries to connect, then the oldest unauthenticated client
 464  * will be dropped. If no unauthenticated client exists, then
 465  * the new connection will be refused.
 466  *
 467  * If the maximum is set to a number lower than the current
 468  * number of connections, no current connections are
 469  * disconnected.
 470  *
 471  * @todo honoring max_connections has not been implemented
 472  * yet. The only real work involved is keeping a list
 473  * of live connections on the DBusServer so the oldest
 474  * unauthenticated client can be located when required.
 475  *
 476  * @todo for a systemwide daemon, we need a max number of connections
 477  * per user, since any user can authenticate a bunch of connections
 478  * and create a DOS.
 479  *
 480  * @todo a single process might listen on multiple mechanisms
 481  * (multiple DBusServer) and might want the max connections
 482  * value to span all those servers. Should consider
 483  * changing the API accordingly, though I'm inclined to
 484  * punt this to the app that wants to do it instead of
 485  * putting it in the library.
 486  *
 487  * @param server the server
 488  * @param max_connections maximum number of connections allowed
 489  */
 490 void
 491 dbus_server_set_max_connections (DBusServer *server,
 492                                  int         max_connections)
 493 {
 494   server->max_connections = max_connections;
 495 }
 496
 497 /**
 498  * Gets the maximum number of connections that can be active
 499  * at a time for this server.
 500  *
 501  * @param server the server
 502  * @returns maximum number of connections at once
 503  */
 504 int
 505 dbus_server_get_max_connections (DBusServer *server)
 506 {
 507   return server->max_connections;
 508 }
 509
 510 /**
 511  * Gets the number of #DBusConnection to this server that
 512  * have not yet been finalized. i.e. all #DBusConnection that
 513  * were passed to #DBusNewConnectionFunction and have not yet been
 514  * finalized will count in this total.
 515  *
 516  * @param server the server
 517  * @returns the number of connections
 518  */
 519 int
 520 dbus_server_get_n_connections (DBusServer *server)
 521 {
 522   return _dbus_counter_get_value (server->connection_counter);
 523 }
 524
 525
 526 static DBusDataSlotAllocator slot_allocator;
 527
 528 /**
 529  * Initialize the mutex used for #DBusConnection data
 530  * slot reservations.
 531  *
 532  * @returns the mutex
 533  */
 534 DBusMutex *
 535 _dbus_server_slots_init_lock (void)
 536 {
 537   if (!_dbus_data_slot_allocator_init (&slot_allocator))
 538     return NULL;
 539   else
 540     return slot_allocator.lock;
 541 }
 542
 543 /**
 544  * Allocates an integer ID to be used for storing application-specific
 545  * data on any DBusServer. The allocated ID may then be used
 546  * with dbus_server_set_data() and dbus_server_get_data().
 547  * If allocation fails, -1 is returned. Again, the allocated
 548  * slot is global, i.e. all DBusServer objects will
 549  * have a slot with the given integer ID reserved.
 550  *
 551  * @returns -1 on failure, otherwise the data slot ID
 552  */
 553 int
 554 dbus_server_allocate_data_slot (void)
 555 {
 556   return _dbus_data_slot_allocator_alloc (&slot_allocator);
 557 }
 558
 559 /**
 560  * Deallocates a global ID for server data slots.
 561  * dbus_server_get_data() and dbus_server_set_data()
 562  * may no longer be used with this slot.
 563  * Existing data stored on existing DBusServer objects
 564  * will be freed when the server is finalized,
 565  * but may not be retrieved (and may only be replaced
 566  * if someone else reallocates the slot).
 567  *
 568  * @param slot the slot to deallocate
 569  */
 570 void
 571 dbus_server_free_data_slot (int slot)
 572 {
 573   _dbus_data_slot_allocator_free (&slot_allocator, slot);
 574 }
 575
 576 /**
 577  * Stores a pointer on a DBusServer, along
 578  * with an optional function to be used for freeing
 579  * the data when the data is set again, or when
 580  * the server is finalized. The slot number
 581  * must have been allocated with dbus_server_allocate_data_slot().
 582  *
 583  * @param server the server
 584  * @param slot the slot number
 585  * @param data the data to store
 586  * @param free_data_func finalizer function for the data
 587  * @returns #TRUE if there was enough memory to store the data
 588  */
 589 dbus_bool_t
 590 dbus_server_set_data (DBusServer   *server,
 591                       int               slot,
 592                       void             *data,
 593                       DBusFreeFunction  free_data_func)
 594 {
 595   DBusFreeFunction old_free_func;
 596   void *old_data;
 597   dbus_bool_t retval;
 598
 599 #if 0
 600   dbus_mutex_lock (server->mutex);
 601 #endif
 602
 603   retval = _dbus_data_slot_list_set (&slot_allocator,
 604                                      &server->slot_list,
 605                                      slot, data, free_data_func,
 606                                      &old_free_func, &old_data);
 607
 608 #if 0
 609   dbus_mutex_unlock (server->mutex);
 610 #endif
 611
 612   if (retval)
 613     {
 614       /* Do the actual free outside the server lock */
 615       if (old_free_func)
 616         (* old_free_func) (old_data);
 617     }
 618
 619   return retval;
 620 }
 621
 622 /**
 623  * Retrieves data previously set with dbus_server_set_data().
 624  * The slot must still be allocated (must not have been freed).
 625  *
 626  * @param server the server
 627  * @param slot the slot to get data from
 628  * @returns the data, or #NULL if not found
 629  */
 630 void*
 631 dbus_server_get_data (DBusServer   *server,
 632                       int               slot)
 633 {
 634   void *res;
 635
 636 #if 0
 637   dbus_mutex_lock (server->mutex);
 638 #endif
 639
 640   res = _dbus_data_slot_list_get (&slot_allocator,
 641                                   &server->slot_list,
 642                                   slot);
 643
 644 #if 0
 645   dbus_mutex_unlock (server->mutex);
 646 #endif
 647
 648   return res;
 649 }
 650
 651 /** @} */
 652