dbus/dbus-connection.c

   1 /* -*- mode: C; c-file-style: "gnu" -*- */
   2 /* dbus-connection.c DBusConnection object
   3  *
   4  * Copyright (C) 2002-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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  *
  22  */
  23
  24 #include <config.h>
  25 #include "dbus-shared.h"
  26 #include "dbus-connection.h"
  27 #include "dbus-list.h"
  28 #include "dbus-timeout.h"
  29 #include "dbus-transport.h"
  30 #include "dbus-watch.h"
  31 #include "dbus-connection-internal.h"
  32 #include "dbus-pending-call-internal.h"
  33 #include "dbus-list.h"
  34 #include "dbus-hash.h"
  35 #include "dbus-message-internal.h"
  36 #include "dbus-threads.h"
  37 #include "dbus-protocol.h"
  38 #include "dbus-dataslot.h"
  39 #include "dbus-string.h"
  40 #include "dbus-pending-call.h"
  41 #include "dbus-object-tree.h"
  42 #include "dbus-threads-internal.h"
  43 #include "dbus-bus.h"
  44
  45 #ifdef DBUS_DISABLE_CHECKS
  46 #define TOOK_LOCK_CHECK(connection)
  47 #define RELEASING_LOCK_CHECK(connection)
  48 #define HAVE_LOCK_CHECK(connection)
  49 #else
  50 #define TOOK_LOCK_CHECK(connection) do {                \
  51     _dbus_assert (!(connection)->have_connection_lock); \
  52     (connection)->have_connection_lock = TRUE;          \
  53   } while (0)
  54 #define RELEASING_LOCK_CHECK(connection) do {            \
  55     _dbus_assert ((connection)->have_connection_lock);   \
  56     (connection)->have_connection_lock = FALSE;          \
  57   } while (0)
  58 #define HAVE_LOCK_CHECK(connection)        _dbus_assert ((connection)->have_connection_lock)
  59 /* A "DO_NOT_HAVE_LOCK_CHECK" is impossible since we need the lock to check the flag */
  60 #endif
  61
  62 #define TRACE_LOCKS 1
  63
  64 #define CONNECTION_LOCK(connection)   do {                                      \
  65     if (TRACE_LOCKS) { _dbus_verbose ("  LOCK: %s\n", _DBUS_FUNCTION_NAME); }   \
  66     _dbus_mutex_lock ((connection)->mutex);                                      \
  67     TOOK_LOCK_CHECK (connection);                                               \
  68   } while (0)
  69
  70 #define CONNECTION_UNLOCK(connection) do {                                              \
  71     if (TRACE_LOCKS) { _dbus_verbose ("  UNLOCK: %s\n", _DBUS_FUNCTION_NAME);  }        \
  72     RELEASING_LOCK_CHECK (connection);                                                  \
  73     _dbus_mutex_unlock ((connection)->mutex);                                            \
  74   } while (0)
  75
  76 #define DISPATCH_STATUS_NAME(s)                                            \
  77                      ((s) == DBUS_DISPATCH_COMPLETE ? "complete" :         \
  78                       (s) == DBUS_DISPATCH_DATA_REMAINS ? "data remains" : \
  79                       (s) == DBUS_DISPATCH_NEED_MEMORY ? "need memory" :   \
  80                       "???")
  81
  82 /**
  83  * @defgroup DBusConnection DBusConnection
  84  * @ingroup  DBus
  85  * @brief Connection to another application
  86  *
  87  * A DBusConnection represents a connection to another
  88  * application. Messages can be sent and received via this connection.
  89  * The other application may be a message bus; for convenience, the
  90  * function dbus_bus_get() is provided to automatically open a
  91  * connection to the well-known message buses.
  92  *
  93  * In brief a DBusConnection is a message queue associated with some
  94  * message transport mechanism such as a socket.  The connection
  95  * maintains a queue of incoming messages and a queue of outgoing
  96  * messages.
  97  *
  98  * Several functions use the following terms:
  99  * <ul>
 100  * <li><b>read</b> means to fill the incoming message queue by reading from the socket</li>
 101  * <li><b>write</b> means to drain the outgoing queue by writing to the socket</li>
 102  * <li><b>dispatch</b> means to drain the incoming queue by invoking application-provided message handlers</li>
 103  * </ul>
 104  *
 105  * The function dbus_connection_read_write_dispatch() for example does all
 106  * three of these things, offering a simple alternative to a main loop.
 107  *
 108  * In an application with a main loop, the read/write/dispatch
 109  * operations are usually separate.
 110  *
 111  * The connection provides #DBusWatch and #DBusTimeout objects to
 112  * the main loop. These are used to know when reading, writing, or
 113  * dispatching should be performed.
 114  *
 115  * Incoming messages are processed
 116  * by calling dbus_connection_dispatch(). dbus_connection_dispatch()
 117  * runs any handlers registered for the topmost message in the message
 118  * queue, then discards the message, then returns.
 119  *
 120  * dbus_connection_get_dispatch_status() indicates whether
 121  * messages are currently in the queue that need dispatching.
 122  * dbus_connection_set_dispatch_status_function() allows
 123  * you to set a function to be used to monitor the dispatch status.
 124  *
 125  * If you're using GLib or Qt add-on libraries for D-Bus, there are
 126  * special convenience APIs in those libraries that hide
 127  * all the details of dispatch and watch/timeout monitoring.
 128  * For example, dbus_connection_setup_with_g_main().
 129  *
 130  * If you aren't using these add-on libraries, but want to process
 131  * messages asynchronously, you must manually call
 132  * dbus_connection_set_dispatch_status_function(),
 133  * dbus_connection_set_watch_functions(),
 134  * dbus_connection_set_timeout_functions() providing appropriate
 135  * functions to integrate the connection with your application's main
 136  * loop. This can be tricky to get right; main loops are not simple.
 137  *
 138  * If you don't need to be asynchronous, you can ignore #DBusWatch,
 139  * #DBusTimeout, and dbus_connection_dispatch().  Instead,
 140  * dbus_connection_read_write_dispatch() can be used.
 141  *
 142  * Or, in <em>very</em> simple applications,
 143  * dbus_connection_pop_message() may be all you need, allowing you to
 144  * avoid setting up any handler functions (see
 145  * dbus_connection_add_filter(),
 146  * dbus_connection_register_object_path() for more on handlers).
 147  *
 148  * When you use dbus_connection_send() or one of its variants to send
 149  * a message, the message is added to the outgoing queue.  It's
 150  * actually written to the network later; either in
 151  * dbus_watch_handle() invoked by your main loop, or in
 152  * dbus_connection_flush() which blocks until it can write out the
 153  * entire outgoing queue. The GLib/Qt add-on libraries again
 154  * handle the details here for you by setting up watch functions.
 155  *
 156  * When a connection is disconnected, you are guaranteed to get a
 157  * signal "Disconnected" from the interface
 158  * #DBUS_INTERFACE_LOCAL, path
 159  * #DBUS_PATH_LOCAL.
 160  *
 161  * You may not drop the last reference to a #DBusConnection
 162  * until that connection has been disconnected.
 163  *
 164  * You may dispatch the unprocessed incoming message queue even if the
 165  * connection is disconnected. However, "Disconnected" will always be
 166  * the last message in the queue (obviously no messages are received
 167  * after disconnection).
 168  *
 169  * After calling dbus_threads_init(), #DBusConnection has thread
 170  * locks and drops them when invoking user callbacks, so in general is
 171  * transparently threadsafe. However, #DBusMessage does NOT have
 172  * thread locks; you must not send the same message to multiple
 173  * #DBusConnection if those connections will be used from different threads,
 174  * for example.
 175  *
 176  * Also, if you dispatch or pop messages from multiple threads, it
 177  * may work in the sense that it won't crash, but it's tough to imagine
 178  * sane results; it will be completely unpredictable which messages
 179  * go to which threads.
 180  *
 181  * It's recommended to dispatch from a single thread.
 182  *
 183  * The most useful function to call from multiple threads at once
 184  * is dbus_connection_send_with_reply_and_block(). That is,
 185  * multiple threads can make method calls at the same time.
 186  *
 187  * If you aren't using threads, you can use a main loop and
 188  * dbus_pending_call_set_notify() to achieve a similar result.
 189  */
 190
 191 /**
 192  * @defgroup DBusConnectionInternals DBusConnection implementation details
 193  * @ingroup  DBusInternals
 194  * @brief Implementation details of DBusConnection
 195  *
 196  * @{
 197  */
 198
 199 /**
 200  * Internal struct representing a message filter function
 201  */
 202 typedef struct DBusMessageFilter DBusMessageFilter;
 203
 204 /**
 205  * Internal struct representing a message filter function
 206  */
 207 struct DBusMessageFilter
 208 {
 209   DBusAtomic refcount; /**< Reference count */
 210   DBusHandleMessageFunction function; /**< Function to call to filter */
 211   void *user_data; /**< User data for the function */
 212   DBusFreeFunction free_user_data_function; /**< Function to free the user data */
 213 };
 214
 215
 216 /**
 217  * Internals of DBusPreallocatedSend
 218  */
 219 struct DBusPreallocatedSend
 220 {
 221   DBusConnection *connection; /**< Connection we'd send the message to */
 222   DBusList *queue_link;       /**< Preallocated link in the queue */
 223   DBusList *counter_link;     /**< Preallocated link in the resource counter */
 224 };
 225
 226 static dbus_bool_t _dbus_modify_sigpipe = TRUE;
 227
 228 /**
 229  * Implementation details of DBusConnection. All fields are private.
 230  */
 231 struct DBusConnection
 232 {
 233   DBusAtomic refcount; /**< Reference count. */
 234
 235   DBusMutex *mutex; /**< Lock on the entire DBusConnection */
 236
 237   DBusMutex *dispatch_mutex;     /**< Protects dispatch_acquired */
 238   DBusCondVar *dispatch_cond;    /**< Notify when dispatch_acquired is available */
 239   DBusMutex *io_path_mutex;      /**< Protects io_path_acquired */
 240   DBusCondVar *io_path_cond;     /**< Notify when io_path_acquired is available */
 241
 242   DBusList *outgoing_messages; /**< Queue of messages we need to send, send the end of the list first. */
 243   DBusList *incoming_messages; /**< Queue of messages we have received, end of the list received most recently. */
 244
 245   DBusMessage *message_borrowed; /**< Filled in if the first incoming message has been borrowed;
 246                                   *   dispatch_acquired will be set by the borrower
 247                                   */
 248
 249   int n_outgoing;              /**< Length of outgoing queue. */
 250   int n_incoming;              /**< Length of incoming queue. */
 251
 252   DBusCounter *outgoing_counter; /**< Counts size of outgoing messages. */
 253
 254   DBusTransport *transport;    /**< Object that sends/receives messages over network. */
 255   DBusWatchList *watches;      /**< Stores active watches. */
 256   DBusTimeoutList *timeouts;   /**< Stores active timeouts. */
 257
 258   DBusList *filter_list;        /**< List of filters. */
 259
 260   DBusDataSlotList slot_list;   /**< Data stored by allocated integer ID */
 261
 262   DBusHashTable *pending_replies;  /**< Hash of message serials to #DBusPendingCall. */
 263
 264   dbus_uint32_t client_serial;       /**< Client serial. Increments each time a message is sent  */
 265   DBusList *disconnect_message_link; /**< Preallocated list node for queueing the disconnection message */
 266
 267   DBusWakeupMainFunction wakeup_main_function; /**< Function to wake up the mainloop  */
 268   void *wakeup_main_data; /**< Application data for wakeup_main_function */
 269   DBusFreeFunction free_wakeup_main_data; /**< free wakeup_main_data */
 270
 271   DBusDispatchStatusFunction dispatch_status_function; /**< Function on dispatch status changes  */
 272   void *dispatch_status_data; /**< Application data for dispatch_status_function */
 273   DBusFreeFunction free_dispatch_status_data; /**< free dispatch_status_data */
 274
 275   DBusDispatchStatus last_dispatch_status; /**< The last dispatch status we reported to the application. */
 276
 277   DBusList *link_cache; /**< A cache of linked list links to prevent contention
 278                          *   for the global linked list mempool lock
 279                          */
 280   DBusObjectTree *objects; /**< Object path handlers registered with this connection */
 281
 282   char *server_guid; /**< GUID of server if we are in shared_connections, #NULL if server GUID is unknown or connection is private */
 283
 284   unsigned int shareable : 1; /**< #TRUE if libdbus owns a reference to the connection and can return it from dbus_connection_open() more than once */
 285
 286   unsigned int dispatch_acquired : 1; /**< Someone has dispatch path (can drain incoming queue) */
 287   unsigned int io_path_acquired : 1;  /**< Someone has transport io path (can use the transport to read/write messages) */
 288
 289   unsigned int exit_on_disconnect : 1; /**< If #TRUE, exit after handling disconnect signal */
 290
 291   unsigned int route_peer_messages : 1; /**< If #TRUE, if org.freedesktop.DBus.Peer messages have a bus name, don't handle them automatically */
 292
 293   unsigned int disconnected_message_arrived : 1;   /**< We popped or are dispatching the disconnected message.
 294                                                     * if the disconnect_message_link is NULL then we queued it, but
 295                                                     * this flag is whether it got to the head of the queue.
 296                                                     */
 297   unsigned int disconnected_message_processed : 1; /**< We did our default handling of the disconnected message,
 298                                                     * such as closing the connection.
 299                                                     */
 300
 301 #ifndef DBUS_DISABLE_CHECKS
 302   unsigned int have_connection_lock : 1; /**< Used to check locking */
 303 #endif
 304
 305 #ifndef DBUS_DISABLE_CHECKS
 306   int generation; /**< _dbus_current_generation that should correspond to this connection */
 307 #endif
 308 };
 309
 310 static DBusDispatchStatus _dbus_connection_get_dispatch_status_unlocked      (DBusConnection     *connection);
 311 static void               _dbus_connection_update_dispatch_status_and_unlock (DBusConnection     *connection,
 312                                                                               DBusDispatchStatus  new_status);
 313 static void               _dbus_connection_last_unref                        (DBusConnection     *connection);
 314 static void               _dbus_connection_acquire_dispatch                  (DBusConnection     *connection);
 315 static void               _dbus_connection_release_dispatch                  (DBusConnection     *connection);
 316 static DBusDispatchStatus _dbus_connection_flush_unlocked                    (DBusConnection     *connection);
 317 static void               _dbus_connection_close_possibly_shared_and_unlock  (DBusConnection     *connection);
 318 static dbus_bool_t        _dbus_connection_get_is_connected_unlocked         (DBusConnection     *connection);
 319
 320 static DBusMessageFilter *
 321 _dbus_message_filter_ref (DBusMessageFilter *filter)
 322 {
 323   _dbus_assert (filter->refcount.value > 0);
 324   _dbus_atomic_inc (&filter->refcount);
 325
 326   return filter;
 327 }
 328
 329 static void
 330 _dbus_message_filter_unref (DBusMessageFilter *filter)
 331 {
 332   _dbus_assert (filter->refcount.value > 0);
 333
 334   if (_dbus_atomic_dec (&filter->refcount) == 1)
 335     {
 336       if (filter->free_user_data_function)
 337         (* filter->free_user_data_function) (filter->user_data);
 338
 339       dbus_free (filter);
 340     }
 341 }
 342
 343 /**
 344  * Acquires the connection lock.
 345  *
 346  * @param connection the connection.
 347  */
 348 void
 349 _dbus_connection_lock (DBusConnection *connection)
 350 {
 351   CONNECTION_LOCK (connection);
 352 }
 353
 354 /**
 355  * Releases the connection lock.
 356  *
 357  * @param connection the connection.
 358  */
 359 void
 360 _dbus_connection_unlock (DBusConnection *connection)
 361 {
 362   CONNECTION_UNLOCK (connection);
 363 }
 364
 365 /**
 366  * Wakes up the main loop if it is sleeping
 367  * Needed if we're e.g. queueing outgoing messages
 368  * on a thread while the mainloop sleeps.
 369  *
 370  * @param connection the connection.
 371  */
 372 static void
 373 _dbus_connection_wakeup_mainloop (DBusConnection *connection)
 374 {
 375   if (connection->wakeup_main_function)
 376     (*connection->wakeup_main_function) (connection->wakeup_main_data);
 377 }
 378
 379 #ifdef DBUS_BUILD_TESTS
 380 /* For now this function isn't used */
 381 /**
 382  * Adds a message to the incoming message queue, returning #FALSE
 383  * if there's insufficient memory to queue the message.
 384  * Does not take over refcount of the message.
 385  *
 386  * @param connection the connection.
 387  * @param message the message to queue.
 388  * @returns #TRUE on success.
 389  */
 390 dbus_bool_t
 391 _dbus_connection_queue_received_message (DBusConnection *connection,
 392                                          DBusMessage    *message)
 393 {
 394   DBusList *link;
 395
 396   link = _dbus_list_alloc_link (message);
 397   if (link == NULL)
 398     return FALSE;
 399
 400   dbus_message_ref (message);
 401   _dbus_connection_queue_received_message_link (connection, link);
 402
 403   return TRUE;
 404 }
 405
 406 /**
 407  * Gets the locks so we can examine them
 408  *
 409  * @param connection the connection.
 410  * @param mutex_loc return for the location of the main mutex pointer
 411  * @param dispatch_mutex_loc return location of the dispatch mutex pointer
 412  * @param io_path_mutex_loc return location of the io_path mutex pointer
 413  * @param dispatch_cond_loc return location of the dispatch conditional
 414  *        variable pointer
 415  * @param io_path_cond_loc return location of the io_path conditional
 416  *        variable pointer
 417  */
 418 void
 419 _dbus_connection_test_get_locks (DBusConnection *connection,
 420                                  DBusMutex     **mutex_loc,
 421                                  DBusMutex     **dispatch_mutex_loc,
 422                                  DBusMutex     **io_path_mutex_loc,
 423                                  DBusCondVar   **dispatch_cond_loc,
 424                                  DBusCondVar   **io_path_cond_loc)
 425 {
 426   *mutex_loc = connection->mutex;
 427   *dispatch_mutex_loc = connection->dispatch_mutex;
 428   *io_path_mutex_loc = connection->io_path_mutex;
 429   *dispatch_cond_loc = connection->dispatch_cond;
 430   *io_path_cond_loc = connection->io_path_cond;
 431 }
 432 #endif
 433
 434 /**
 435  * Adds a message-containing list link to the incoming message queue,
 436  * taking ownership of the link and the message's current refcount.
 437  * Cannot fail due to lack of memory.
 438  *
 439  * @param connection the connection.
 440  * @param link the message link to queue.
 441  */
 442 void
 443 _dbus_connection_queue_received_message_link (DBusConnection  *connection,
 444                                               DBusList        *link)
 445 {
 446   DBusPendingCall *pending;
 447   dbus_int32_t reply_serial;
 448   DBusMessage *message;
 449
 450   _dbus_assert (_dbus_transport_get_is_authenticated (connection->transport));
 451
 452   _dbus_list_append_link (&connection->incoming_messages,
 453                           link);
 454   message = link->data;
 455
 456   /* If this is a reply we're waiting on, remove timeout for it */
 457   reply_serial = dbus_message_get_reply_serial (message);
 458   if (reply_serial != -1)
 459     {
 460       pending = _dbus_hash_table_lookup_int (connection->pending_replies,
 461                                              reply_serial);
 462       if (pending != NULL)
 463         {
 464           if (_dbus_pending_call_is_timeout_added_unlocked (pending))
 465             _dbus_connection_remove_timeout_unlocked (connection,
 466                                                       _dbus_pending_call_get_timeout_unlocked (pending));
 467
 468           _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
 469         }
 470     }
 471
 472
 473
 474   connection->n_incoming += 1;
 475
 476   _dbus_connection_wakeup_mainloop (connection);
 477
 478   _dbus_verbose ("Message %p (%d %s %s %s '%s' reply to %u) added to incoming queue %p, %d incoming\n",
 479                  message,
 480                  dbus_message_get_type (message),
 481                  dbus_message_get_path (message) ?
 482                  dbus_message_get_path (message) :
 483                  "no path",
 484                  dbus_message_get_interface (message) ?
 485                  dbus_message_get_interface (message) :
 486                  "no interface",
 487                  dbus_message_get_member (message) ?
 488                  dbus_message_get_member (message) :
 489                  "no member",
 490                  dbus_message_get_signature (message),
 491                  dbus_message_get_reply_serial (message),
 492                  connection,
 493                  connection->n_incoming);}
 494
 495 /**
 496  * Adds a link + message to the incoming message queue.
 497  * Can't fail. Takes ownership of both link and message.
 498  *
 499  * @param connection the connection.
 500  * @param link the list node and message to queue.
 501  *
 502  */
 503 void
 504 _dbus_connection_queue_synthesized_message_link (DBusConnection *connection,
 505                                                  DBusList *link)
 506 {
 507   HAVE_LOCK_CHECK (connection);
 508
 509   _dbus_list_append_link (&connection->incoming_messages, link);
 510
 511   connection->n_incoming += 1;
 512
 513   _dbus_connection_wakeup_mainloop (connection);
 514
 515   _dbus_verbose ("Synthesized message %p added to incoming queue %p, %d incoming\n",
 516                  link->data, connection, connection->n_incoming);
 517 }
 518
 519
 520 /**
 521  * Checks whether there are messages in the outgoing message queue.
 522  * Called with connection lock held.
 523  *
 524  * @param connection the connection.
 525  * @returns #TRUE if the outgoing queue is non-empty.
 526  */
 527 dbus_bool_t
 528 _dbus_connection_has_messages_to_send_unlocked (DBusConnection *connection)
 529 {
 530   HAVE_LOCK_CHECK (connection);
 531   return connection->outgoing_messages != NULL;
 532 }
 533
 534 /**
 535  * Checks whether there are messages in the outgoing message queue.
 536  * Use dbus_connection_flush() to block until all outgoing
 537  * messages have been written to the underlying transport
 538  * (such as a socket).
 539  *
 540  * @param connection the connection.
 541  * @returns #TRUE if the outgoing queue is non-empty.
 542  */
 543 dbus_bool_t
 544 dbus_connection_has_messages_to_send (DBusConnection *connection)
 545 {
 546   dbus_bool_t v;
 547
 548   _dbus_return_val_if_fail (connection != NULL, FALSE);
 549
 550   CONNECTION_LOCK (connection);
 551   v = _dbus_connection_has_messages_to_send_unlocked (connection);
 552   CONNECTION_UNLOCK (connection);
 553
 554   return v;
 555 }
 556
 557 /**
 558  * Gets the next outgoing message. The message remains in the
 559  * queue, and the caller does not own a reference to it.
 560  *
 561  * @param connection the connection.
 562  * @returns the message to be sent.
 563  */
 564 DBusMessage*
 565 _dbus_connection_get_message_to_send (DBusConnection *connection)
 566 {
 567   HAVE_LOCK_CHECK (connection);
 568
 569   return _dbus_list_get_last (&connection->outgoing_messages);
 570 }
 571
 572 /**
 573  * Notifies the connection that a message has been sent, so the
 574  * message can be removed from the outgoing queue.
 575  * Called with the connection lock held.
 576  *
 577  * @param connection the connection.
 578  * @param message the message that was sent.
 579  */
 580 void
 581 _dbus_connection_message_sent (DBusConnection *connection,
 582                                DBusMessage    *message)
 583 {
 584   DBusList *link;
 585
 586   HAVE_LOCK_CHECK (connection);
 587
 588   /* This can be called before we even complete authentication, since
 589    * it's called on disconnect to clean up the outgoing queue.
 590    * It's also called as we successfully send each message.
 591    */
 592
 593   link = _dbus_list_get_last_link (&connection->outgoing_messages);
 594   _dbus_assert (link != NULL);
 595   _dbus_assert (link->data == message);
 596
 597   /* Save this link in the link cache */
 598   _dbus_list_unlink (&connection->outgoing_messages,
 599                      link);
 600   _dbus_list_prepend_link (&connection->link_cache, link);
 601
 602   connection->n_outgoing -= 1;
 603
 604   _dbus_verbose ("Message %p (%d %s %s %s '%s') removed from outgoing queue %p, %d left to send\n",
 605                  message,
 606                  dbus_message_get_type (message),
 607                  dbus_message_get_path (message) ?
 608                  dbus_message_get_path (message) :
 609                  "no path",
 610                  dbus_message_get_interface (message) ?
 611                  dbus_message_get_interface (message) :
 612                  "no interface",
 613                  dbus_message_get_member (message) ?
 614                  dbus_message_get_member (message) :
 615                  "no member",
 616                  dbus_message_get_signature (message),
 617                  connection, connection->n_outgoing);
 618
 619   /* Save this link in the link cache also */
 620   _dbus_message_remove_size_counter (message, connection->outgoing_counter,
 621                                      &link);
 622   _dbus_list_prepend_link (&connection->link_cache, link);
 623
 624   dbus_message_unref (message);
 625 }
 626
 627 /** Function to be called in protected_change_watch() with refcount held */
 628 typedef dbus_bool_t (* DBusWatchAddFunction)     (DBusWatchList *list,
 629                                                   DBusWatch     *watch);
 630 /** Function to be called in protected_change_watch() with refcount held */
 631 typedef void        (* DBusWatchRemoveFunction)  (DBusWatchList *list,
 632                                                   DBusWatch     *watch);
 633 /** Function to be called in protected_change_watch() with refcount held */
 634 typedef void        (* DBusWatchToggleFunction)  (DBusWatchList *list,
 635                                                   DBusWatch     *watch,
 636                                                   dbus_bool_t    enabled);
 637
 638 static dbus_bool_t
 639 protected_change_watch (DBusConnection         *connection,
 640                         DBusWatch              *watch,
 641                         DBusWatchAddFunction    add_function,
 642                         DBusWatchRemoveFunction remove_function,
 643                         DBusWatchToggleFunction toggle_function,
 644                         dbus_bool_t             enabled)
 645 {
 646   DBusWatchList *watches;
 647   dbus_bool_t retval;
 648
 649   HAVE_LOCK_CHECK (connection);
 650
 651   /* This isn't really safe or reasonable; a better pattern is the "do everything, then
 652    * drop lock and call out" one; but it has to be propagated up through all callers
 653    */
 654
 655   watches = connection->watches;
 656   if (watches)
 657     {
 658       connection->watches = NULL;
 659       _dbus_connection_ref_unlocked (connection);
 660       CONNECTION_UNLOCK (connection);
 661
 662       if (add_function)
 663         retval = (* add_function) (watches, watch);
 664       else if (remove_function)
 665         {
 666           retval = TRUE;
 667           (* remove_function) (watches, watch);
 668         }
 669       else
 670         {
 671           retval = TRUE;
 672           (* toggle_function) (watches, watch, enabled);
 673         }
 674
 675       CONNECTION_LOCK (connection);
 676       connection->watches = watches;
 677       _dbus_connection_unref_unlocked (connection);
 678
 679       return retval;
 680     }
 681   else
 682     return FALSE;
 683 }
 684
 685
 686 /**
 687  * Adds a watch using the connection's DBusAddWatchFunction if
 688  * available. Otherwise records the watch to be added when said
 689  * function is available. Also re-adds the watch if the
 690  * DBusAddWatchFunction changes. May fail due to lack of memory.
 691  * Connection lock should be held when calling this.
 692  *
 693  * @param connection the connection.
 694  * @param watch the watch to add.
 695  * @returns #TRUE on success.
 696  */
 697 dbus_bool_t
 698 _dbus_connection_add_watch_unlocked (DBusConnection *connection,
 699                                      DBusWatch      *watch)
 700 {
 701   return protected_change_watch (connection, watch,
 702                                  _dbus_watch_list_add_watch,
 703                                  NULL, NULL, FALSE);
 704 }
 705
 706 /**
 707  * Removes a watch using the connection's DBusRemoveWatchFunction
 708  * if available. It's an error to call this function on a watch
 709  * that was not previously added.
 710  * Connection lock should be held when calling this.
 711  *
 712  * @param connection the connection.
 713  * @param watch the watch to remove.
 714  */
 715 void
 716 _dbus_connection_remove_watch_unlocked (DBusConnection *connection,
 717                                         DBusWatch      *watch)
 718 {
 719   protected_change_watch (connection, watch,
 720                           NULL,
 721                           _dbus_watch_list_remove_watch,
 722                           NULL, FALSE);
 723 }
 724
 725 /**
 726  * Toggles a watch and notifies app via connection's
 727  * DBusWatchToggledFunction if available. It's an error to call this
 728  * function on a watch that was not previously added.
 729  * Connection lock should be held when calling this.
 730  *
 731  * @param connection the connection.
 732  * @param watch the watch to toggle.
 733  * @param enabled whether to enable or disable
 734  */
 735 void
 736 _dbus_connection_toggle_watch_unlocked (DBusConnection *connection,
 737                                         DBusWatch      *watch,
 738                                         dbus_bool_t     enabled)
 739 {
 740   _dbus_assert (watch != NULL);
 741
 742   protected_change_watch (connection, watch,
 743                           NULL, NULL,
 744                           _dbus_watch_list_toggle_watch,
 745                           enabled);
 746 }
 747
 748 /** Function to be called in protected_change_timeout() with refcount held */
 749 typedef dbus_bool_t (* DBusTimeoutAddFunction)    (DBusTimeoutList *list,
 750                                                    DBusTimeout     *timeout);
 751 /** Function to be called in protected_change_timeout() with refcount held */
 752 typedef void        (* DBusTimeoutRemoveFunction) (DBusTimeoutList *list,
 753                                                    DBusTimeout     *timeout);
 754 /** Function to be called in protected_change_timeout() with refcount held */
 755 typedef void        (* DBusTimeoutToggleFunction) (DBusTimeoutList *list,
 756                                                    DBusTimeout     *timeout,
 757                                                    dbus_bool_t      enabled);
 758
 759 static dbus_bool_t
 760 protected_change_timeout (DBusConnection           *connection,
 761                           DBusTimeout              *timeout,
 762                           DBusTimeoutAddFunction    add_function,
 763                           DBusTimeoutRemoveFunction remove_function,
 764                           DBusTimeoutToggleFunction toggle_function,
 765                           dbus_bool_t               enabled)
 766 {
 767   DBusTimeoutList *timeouts;
 768   dbus_bool_t retval;
 769
 770   HAVE_LOCK_CHECK (connection);
 771
 772   /* This isn't really safe or reasonable; a better pattern is the "do everything, then
 773    * drop lock and call out" one; but it has to be propagated up through all callers
 774    */
 775
 776   timeouts = connection->timeouts;
 777   if (timeouts)
 778     {
 779       connection->timeouts = NULL;
 780       _dbus_connection_ref_unlocked (connection);
 781       CONNECTION_UNLOCK (connection);
 782
 783       if (add_function)
 784         retval = (* add_function) (timeouts, timeout);
 785       else if (remove_function)
 786         {
 787           retval = TRUE;
 788           (* remove_function) (timeouts, timeout);
 789         }
 790       else
 791         {
 792           retval = TRUE;
 793           (* toggle_function) (timeouts, timeout, enabled);
 794         }
 795
 796       CONNECTION_LOCK (connection);
 797       connection->timeouts = timeouts;
 798       _dbus_connection_unref_unlocked (connection);
 799
 800       return retval;
 801     }
 802   else
 803     return FALSE;
 804 }
 805
 806 /**
 807  * Adds a timeout using the connection's DBusAddTimeoutFunction if
 808  * available. Otherwise records the timeout to be added when said
 809  * function is available. Also re-adds the timeout if the
 810  * DBusAddTimeoutFunction changes. May fail due to lack of memory.
 811  * The timeout will fire repeatedly until removed.
 812  * Connection lock should be held when calling this.
 813  *
 814  * @param connection the connection.
 815  * @param timeout the timeout to add.
 816  * @returns #TRUE on success.
 817  */
 818 dbus_bool_t
 819 _dbus_connection_add_timeout_unlocked (DBusConnection *connection,
 820                                        DBusTimeout    *timeout)
 821 {
 822   return protected_change_timeout (connection, timeout,
 823                                    _dbus_timeout_list_add_timeout,
 824                                    NULL, NULL, FALSE);
 825 }
 826
 827 /**
 828  * Removes a timeout using the connection's DBusRemoveTimeoutFunction
 829  * if available. It's an error to call this function on a timeout
 830  * that was not previously added.
 831  * Connection lock should be held when calling this.
 832  *
 833  * @param connection the connection.
 834  * @param timeout the timeout to remove.
 835  */
 836 void
 837 _dbus_connection_remove_timeout_unlocked (DBusConnection *connection,
 838                                           DBusTimeout    *timeout)
 839 {
 840   protected_change_timeout (connection, timeout,
 841                             NULL,
 842                             _dbus_timeout_list_remove_timeout,
 843                             NULL, FALSE);
 844 }
 845
 846 /**
 847  * Toggles a timeout and notifies app via connection's
 848  * DBusTimeoutToggledFunction if available. It's an error to call this
 849  * function on a timeout that was not previously added.
 850  * Connection lock should be held when calling this.
 851  *
 852  * @param connection the connection.
 853  * @param timeout the timeout to toggle.
 854  * @param enabled whether to enable or disable
 855  */
 856 void
 857 _dbus_connection_toggle_timeout_unlocked (DBusConnection   *connection,
 858                                           DBusTimeout      *timeout,
 859                                           dbus_bool_t       enabled)
 860 {
 861   protected_change_timeout (connection, timeout,
 862                             NULL, NULL,
 863                             _dbus_timeout_list_toggle_timeout,
 864                             enabled);
 865 }
 866
 867 static dbus_bool_t
 868 _dbus_connection_attach_pending_call_unlocked (DBusConnection  *connection,
 869                                                DBusPendingCall *pending)
 870 {
 871   dbus_uint32_t reply_serial;
 872   DBusTimeout *timeout;
 873
 874   HAVE_LOCK_CHECK (connection);
 875
 876   reply_serial = _dbus_pending_call_get_reply_serial_unlocked (pending);
 877
 878   _dbus_assert (reply_serial != 0);
 879
 880   timeout = _dbus_pending_call_get_timeout_unlocked (pending);
 881
 882   if (!_dbus_connection_add_timeout_unlocked (connection, timeout))
 883     return FALSE;
 884
 885   if (!_dbus_hash_table_insert_int (connection->pending_replies,
 886                                     reply_serial,
 887                                     pending))
 888     {
 889       _dbus_connection_remove_timeout_unlocked (connection, timeout);
 890
 891       _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
 892       HAVE_LOCK_CHECK (connection);
 893       return FALSE;
 894     }
 895
 896   _dbus_pending_call_set_timeout_added_unlocked (pending, TRUE);
 897
 898   _dbus_pending_call_ref_unlocked (pending);
 899
 900   HAVE_LOCK_CHECK (connection);
 901
 902   return TRUE;
 903 }
 904
 905 static void
 906 free_pending_call_on_hash_removal (void *data)
 907 {
 908   DBusPendingCall *pending;
 909   DBusConnection  *connection;
 910
 911   if (data == NULL)
 912     return;
 913
 914   pending = data;
 915
 916   connection = _dbus_pending_call_get_connection_unlocked (pending);
 917
 918   HAVE_LOCK_CHECK (connection);
 919
 920   if (_dbus_pending_call_is_timeout_added_unlocked (pending))
 921     {
 922       _dbus_connection_remove_timeout_unlocked (connection,
 923                                                 _dbus_pending_call_get_timeout_unlocked (pending));
 924
 925       _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
 926     }
 927
 928   /* FIXME 1.0? this is sort of dangerous and undesirable to drop the lock
 929    * here, but the pending call finalizer could in principle call out to
 930    * application code so we pretty much have to... some larger code reorg
 931    * might be needed.
 932    */
 933   _dbus_connection_ref_unlocked (connection);
 934   _dbus_pending_call_unref_and_unlock (pending);
 935   CONNECTION_LOCK (connection);
 936   _dbus_connection_unref_unlocked (connection);
 937 }
 938
 939 static void
 940 _dbus_connection_detach_pending_call_unlocked (DBusConnection  *connection,
 941                                                DBusPendingCall *pending)
 942 {
 943   /* This ends up unlocking to call the pending call finalizer, which is unexpected to
 944    * say the least.
 945    */
 946   _dbus_hash_table_remove_int (connection->pending_replies,
 947                                _dbus_pending_call_get_reply_serial_unlocked (pending));
 948 }
 949
 950 static void
 951 _dbus_connection_detach_pending_call_and_unlock (DBusConnection  *connection,
 952                                                  DBusPendingCall *pending)
 953 {
 954   /* The idea here is to avoid finalizing the pending call
 955    * with the lock held, since there's a destroy notifier
 956    * in pending call that goes out to application code.
 957    *
 958    * There's an extra unlock inside the hash table
 959    * "free pending call" function FIXME...
 960    */
 961   _dbus_pending_call_ref_unlocked (pending);
 962   _dbus_hash_table_remove_int (connection->pending_replies,
 963                                _dbus_pending_call_get_reply_serial_unlocked (pending));
 964   _dbus_pending_call_unref_and_unlock (pending);
 965 }
 966
 967 /**
 968  * Removes a pending call from the connection, such that
 969  * the pending reply will be ignored. May drop the last
 970  * reference to the pending call.
 971  *
 972  * @param connection the connection
 973  * @param pending the pending call
 974  */
 975 void
 976 _dbus_connection_remove_pending_call (DBusConnection  *connection,
 977                                       DBusPendingCall *pending)
 978 {
 979   CONNECTION_LOCK (connection);
 980   _dbus_connection_detach_pending_call_and_unlock (connection, pending);
 981 }
 982
 983 /**
 984  * Acquire the transporter I/O path. This must be done before
 985  * doing any I/O in the transporter. May sleep and drop the
 986  * IO path mutex while waiting for the I/O path.
 987  *
 988  * @param connection the connection.
 989  * @param timeout_milliseconds maximum blocking time, or -1 for no limit.
 990  * @returns TRUE if the I/O path was acquired.
 991  */
 992 static dbus_bool_t
 993 _dbus_connection_acquire_io_path (DBusConnection *connection,
 994                                   int             timeout_milliseconds)
 995 {
 996   dbus_bool_t we_acquired;
 997
 998   HAVE_LOCK_CHECK (connection);
 999
1000   /* We don't want the connection to vanish */
1001   _dbus_connection_ref_unlocked (connection);
1002
1003   /* We will only touch io_path_acquired which is protected by our mutex */
1004   CONNECTION_UNLOCK (connection);
1005
1006   _dbus_verbose ("%s locking io_path_mutex\n", _DBUS_FUNCTION_NAME);
1007   _dbus_mutex_lock (connection->io_path_mutex);
1008
1009   _dbus_verbose ("%s start connection->io_path_acquired = %d timeout = %d\n",
1010                  _DBUS_FUNCTION_NAME, connection->io_path_acquired, timeout_milliseconds);
1011
1012   we_acquired = FALSE;
1013
1014   if (connection->io_path_acquired)
1015     {
1016       if (timeout_milliseconds != -1)
1017         {
1018           _dbus_verbose ("%s waiting %d for IO path to be acquirable\n",
1019                          _DBUS_FUNCTION_NAME, timeout_milliseconds);
1020
1021           if (!_dbus_condvar_wait_timeout (connection->io_path_cond,
1022                                            connection->io_path_mutex,
1023                                            timeout_milliseconds))
1024             {
1025               /* We timed out before anyone signaled. */
1026               /* (writing the loop to handle the !timedout case by
1027                * waiting longer if needed is a pain since dbus
1028                * wraps pthread_cond_timedwait to take a relative
1029                * time instead of absolute, something kind of stupid
1030                * on our part. for now it doesn't matter, we will just
1031                * end up back here eventually.)
1032                */
1033             }
1034         }
1035       else
1036         {
1037           while (connection->io_path_acquired)
1038             {
1039               _dbus_verbose ("%s waiting for IO path to be acquirable\n", _DBUS_FUNCTION_NAME);
1040               _dbus_condvar_wait (connection->io_path_cond,
1041                                   connection->io_path_mutex);
1042             }
1043         }
1044     }
1045
1046   if (!connection->io_path_acquired)
1047     {
1048       we_acquired = TRUE;
1049       connection->io_path_acquired = TRUE;
1050     }
1051
1052   _dbus_verbose ("%s end connection->io_path_acquired = %d we_acquired = %d\n",
1053                  _DBUS_FUNCTION_NAME, connection->io_path_acquired, we_acquired);
1054
1055   _dbus_verbose ("%s unlocking io_path_mutex\n", _DBUS_FUNCTION_NAME);
1056   _dbus_mutex_unlock (connection->io_path_mutex);
1057
1058   CONNECTION_LOCK (connection);
1059
1060   HAVE_LOCK_CHECK (connection);
1061
1062   _dbus_connection_unref_unlocked (connection);
1063
1064   return we_acquired;
1065 }
1066
1067 /**
1068  * Release the I/O path when you're done with it. Only call
1069  * after you've acquired the I/O. Wakes up at most one thread
1070  * currently waiting to acquire the I/O path.
1071  *
1072  * @param connection the connection.
1073  */
1074 static void
1075 _dbus_connection_release_io_path (DBusConnection *connection)
1076 {
1077   HAVE_LOCK_CHECK (connection);
1078
1079   _dbus_verbose ("%s locking io_path_mutex\n", _DBUS_FUNCTION_NAME);
1080   _dbus_mutex_lock (connection->io_path_mutex);
1081
1082   _dbus_assert (connection->io_path_acquired);
1083
1084   _dbus_verbose ("%s start connection->io_path_acquired = %d\n",
1085                  _DBUS_FUNCTION_NAME, connection->io_path_acquired);
1086
1087   connection->io_path_acquired = FALSE;
1088   _dbus_condvar_wake_one (connection->io_path_cond);
1089
1090   _dbus_verbose ("%s unlocking io_path_mutex\n", _DBUS_FUNCTION_NAME);
1091   _dbus_mutex_unlock (connection->io_path_mutex);
1092 }
1093
1094 /**
1095  * Queues incoming messages and sends outgoing messages for this
1096  * connection, optionally blocking in the process. Each call to
1097  * _dbus_connection_do_iteration_unlocked() will call select() or poll() one
1098  * time and then read or write data if possible.
1099  *
1100  * The purpose of this function is to be able to flush outgoing
1101  * messages or queue up incoming messages without returning
1102  * control to the application and causing reentrancy weirdness.
1103  *
1104  * The flags parameter allows you to specify whether to
1105  * read incoming messages, write outgoing messages, or both,
1106  * and whether to block if no immediate action is possible.
1107  *
1108  * The timeout_milliseconds parameter does nothing unless the
1109  * iteration is blocking.
1110  *
1111  * If there are no outgoing messages and DBUS_ITERATION_DO_READING
1112  * wasn't specified, then it's impossible to block, even if
1113  * you specify DBUS_ITERATION_BLOCK; in that case the function
1114  * returns immediately.
1115  *
1116  * Called with connection lock held.
1117  *
1118  * @param connection the connection.
1119  * @param flags iteration flags.
1120  * @param timeout_milliseconds maximum blocking time, or -1 for no limit.
1121  */
1122 void
1123 _dbus_connection_do_iteration_unlocked (DBusConnection *connection,
1124                                         unsigned int    flags,
1125                                         int             timeout_milliseconds)
1126 {
1127   _dbus_verbose ("%s start\n", _DBUS_FUNCTION_NAME);
1128
1129   HAVE_LOCK_CHECK (connection);
1130
1131   if (connection->n_outgoing == 0)
1132     flags &= ~DBUS_ITERATION_DO_WRITING;
1133
1134   if (_dbus_connection_acquire_io_path (connection,
1135                                         (flags & DBUS_ITERATION_BLOCK) ? timeout_milliseconds : 0))
1136     {
1137       HAVE_LOCK_CHECK (connection);
1138
1139       _dbus_transport_do_iteration (connection->transport,
1140                                     flags, timeout_milliseconds);
1141       _dbus_connection_release_io_path (connection);
1142     }
1143
1144   HAVE_LOCK_CHECK (connection);
1145
1146   _dbus_verbose ("%s end\n", _DBUS_FUNCTION_NAME);
1147 }
1148
1149 /**
1150  * Creates a new connection for the given transport.  A transport
1151  * represents a message stream that uses some concrete mechanism, such
1152  * as UNIX domain sockets. May return #NULL if insufficient
1153  * memory exists to create the connection.
1154  *
1155  * @param transport the transport.
1156  * @returns the new connection, or #NULL on failure.
1157  */
1158 DBusConnection*
1159 _dbus_connection_new_for_transport (DBusTransport *transport)
1160 {
1161   DBusConnection *connection;
1162   DBusWatchList *watch_list;
1163   DBusTimeoutList *timeout_list;
1164   DBusHashTable *pending_replies;
1165   DBusList *disconnect_link;
1166   DBusMessage *disconnect_message;
1167   DBusCounter *outgoing_counter;
1168   DBusObjectTree *objects;
1169
1170   watch_list = NULL;
1171   connection = NULL;
1172   pending_replies = NULL;
1173   timeout_list = NULL;
1174   disconnect_link = NULL;
1175   disconnect_message = NULL;
1176   outgoing_counter = NULL;
1177   objects = NULL;
1178
1179   watch_list = _dbus_watch_list_new ();
1180   if (watch_list == NULL)
1181     goto error;
1182
1183   timeout_list = _dbus_timeout_list_new ();
1184   if (timeout_list == NULL)
1185     goto error;
1186
1187   pending_replies =
1188     _dbus_hash_table_new (DBUS_HASH_INT,
1189                           NULL,
1190                           (DBusFreeFunction)free_pending_call_on_hash_removal);
1191   if (pending_replies == NULL)
1192     goto error;
1193
1194   connection = dbus_new0 (DBusConnection, 1);
1195   if (connection == NULL)
1196     goto error;
1197
1198   _dbus_mutex_new_at_location (&connection->mutex);
1199   if (connection->mutex == NULL)
1200     goto error;
1201
1202   _dbus_mutex_new_at_location (&connection->io_path_mutex);
1203   if (connection->io_path_mutex == NULL)
1204     goto error;
1205
1206   _dbus_mutex_new_at_location (&connection->dispatch_mutex);
1207   if (connection->dispatch_mutex == NULL)
1208     goto error;
1209
1210   _dbus_condvar_new_at_location (&connection->dispatch_cond);
1211   if (connection->dispatch_cond == NULL)
1212     goto error;
1213
1214   _dbus_condvar_new_at_location (&connection->io_path_cond);
1215   if (connection->io_path_cond == NULL)
1216     goto error;
1217
1218   disconnect_message = dbus_message_new_signal (DBUS_PATH_LOCAL,
1219                                                 DBUS_INTERFACE_LOCAL,
1220                                                 "Disconnected");
1221
1222   if (disconnect_message == NULL)
1223     goto error;
1224
1225   disconnect_link = _dbus_list_alloc_link (disconnect_message);
1226   if (disconnect_link == NULL)
1227     goto error;
1228
1229   outgoing_counter = _dbus_counter_new ();
1230   if (outgoing_counter == NULL)
1231     goto error;
1232
1233   objects = _dbus_object_tree_new (connection);
1234   if (objects == NULL)
1235     goto error;
1236
1237   if (_dbus_modify_sigpipe)
1238     _dbus_disable_sigpipe ();
1239
1240   connection->refcount.value = 1;
1241   connection->transport = transport;
1242   connection->watches = watch_list;
1243   connection->timeouts = timeout_list;
1244   connection->pending_replies = pending_replies;
1245   connection->outgoing_counter = outgoing_counter;
1246   connection->filter_list = NULL;
1247   connection->last_dispatch_status = DBUS_DISPATCH_COMPLETE; /* so we're notified first time there's data */
1248   connection->objects = objects;
1249   connection->exit_on_disconnect = FALSE;
1250   connection->shareable = FALSE;
1251   connection->route_peer_messages = FALSE;
1252   connection->disconnected_message_arrived = FALSE;
1253   connection->disconnected_message_processed = FALSE;
1254
1255 #ifndef DBUS_DISABLE_CHECKS
1256   connection->generation = _dbus_current_generation;
1257 #endif
1258
1259   _dbus_data_slot_list_init (&connection->slot_list);
1260
1261   connection->client_serial = 1;
1262
1263   connection->disconnect_message_link = disconnect_link;
1264
1265   CONNECTION_LOCK (connection);
1266
1267   if (!_dbus_transport_set_connection (transport, connection))
1268     {
1269       CONNECTION_UNLOCK (connection);
1270
1271       goto error;
1272     }
1273
1274   _dbus_transport_ref (transport);
1275
1276   CONNECTION_UNLOCK (connection);
1277
1278   return connection;
1279
1280  error:
1281   if (disconnect_message != NULL)
1282     dbus_message_unref (disconnect_message);
1283
1284   if (disconnect_link != NULL)
1285     _dbus_list_free_link (disconnect_link);
1286
1287   if (connection != NULL)
1288     {
1289       _dbus_condvar_free_at_location (&connection->io_path_cond);
1290       _dbus_condvar_free_at_location (&connection->dispatch_cond);
1291       _dbus_mutex_free_at_location (&connection->mutex);
1292       _dbus_mutex_free_at_location (&connection->io_path_mutex);
1293       _dbus_mutex_free_at_location (&connection->dispatch_mutex);
1294       dbus_free (connection);
1295     }
1296   if (pending_replies)
1297     _dbus_hash_table_unref (pending_replies);
1298
1299   if (watch_list)
1300     _dbus_watch_list_free (watch_list);
1301
1302   if (timeout_list)
1303     _dbus_timeout_list_free (timeout_list);
1304
1305   if (outgoing_counter)
1306     _dbus_counter_unref (outgoing_counter);
1307
1308   if (objects)
1309     _dbus_object_tree_unref (objects);
1310
1311   return NULL;
1312 }
1313
1314 /**
1315  * Increments the reference count of a DBusConnection.
1316  * Requires that the caller already holds the connection lock.
1317  *
1318  * @param connection the connection.
1319  * @returns the connection.
1320  */
1321 DBusConnection *
1322 _dbus_connection_ref_unlocked (DBusConnection *connection)
1323 {
1324   _dbus_assert (connection != NULL);
1325   _dbus_assert (connection->generation == _dbus_current_generation);
1326
1327   HAVE_LOCK_CHECK (connection);
1328
1329 #ifdef DBUS_HAVE_ATOMIC_INT
1330   _dbus_atomic_inc (&connection->refcount);
1331 #else
1332   _dbus_assert (connection->refcount.value > 0);
1333   connection->refcount.value += 1;
1334 #endif
1335
1336   return connection;
1337 }
1338
1339 /**
1340  * Decrements the reference count of a DBusConnection.
1341  * Requires that the caller already holds the connection lock.
1342  *
1343  * @param connection the connection.
1344  */
1345 void
1346 _dbus_connection_unref_unlocked (DBusConnection *connection)
1347 {
1348   dbus_bool_t last_unref;
1349
1350   HAVE_LOCK_CHECK (connection);
1351
1352   _dbus_assert (connection != NULL);
1353
1354   /* The connection lock is better than the global
1355    * lock in the atomic increment fallback
1356    */
1357
1358 #ifdef DBUS_HAVE_ATOMIC_INT
1359   last_unref = (_dbus_atomic_dec (&connection->refcount) == 1);
1360 #else
1361   _dbus_assert (connection->refcount.value > 0);
1362
1363   connection->refcount.value -= 1;
1364   last_unref = (connection->refcount.value == 0);
1365 #if 0
1366   printf ("unref_unlocked() connection %p count = %d\n", connection, connection->refcount.value);
1367 #endif
1368 #endif
1369
1370   if (last_unref)
1371     _dbus_connection_last_unref (connection);
1372 }
1373
1374 static dbus_uint32_t
1375 _dbus_connection_get_next_client_serial (DBusConnection *connection)
1376 {
1377   int serial;
1378
1379   serial = connection->client_serial++;
1380
1381   if (connection->client_serial < 0)
1382     connection->client_serial = 1;
1383
1384   return serial;
1385 }
1386
1387 /**
1388  * A callback for use with dbus_watch_new() to create a DBusWatch.
1389  *
1390  * @todo This is basically a hack - we could delete _dbus_transport_handle_watch()
1391  * and the virtual handle_watch in DBusTransport if we got rid of it.
1392  * The reason this is some work is threading, see the _dbus_connection_handle_watch()
1393  * implementation.
1394  *
1395  * @param watch the watch.
1396  * @param condition the current condition of the file descriptors being watched.
1397  * @param data must be a pointer to a #DBusConnection
1398  * @returns #FALSE if the IO condition may not have been fully handled due to lack of memory
1399  */
1400 dbus_bool_t
1401 _dbus_connection_handle_watch (DBusWatch                   *watch,
1402                                unsigned int                 condition,
1403                                void                        *data)
1404 {
1405   DBusConnection *connection;
1406   dbus_bool_t retval;
1407   DBusDispatchStatus status;
1408
1409   connection = data;
1410
1411   _dbus_verbose ("%s start\n", _DBUS_FUNCTION_NAME);
1412
1413   CONNECTION_LOCK (connection);
1414   _dbus_connection_acquire_io_path (connection, -1);
1415   HAVE_LOCK_CHECK (connection);
1416   retval = _dbus_transport_handle_watch (connection->transport,
1417                                          watch, condition);
1418
1419   _dbus_connection_release_io_path (connection);
1420
1421   HAVE_LOCK_CHECK (connection);
1422
1423   _dbus_verbose ("%s middle\n", _DBUS_FUNCTION_NAME);
1424
1425   status = _dbus_connection_get_dispatch_status_unlocked (connection);
1426
1427   /* this calls out to user code */
1428   _dbus_connection_update_dispatch_status_and_unlock (connection, status);
1429
1430   _dbus_verbose ("%s end\n", _DBUS_FUNCTION_NAME);
1431
1432   return retval;
1433 }
1434
1435 _DBUS_DEFINE_GLOBAL_LOCK (shared_connections);
1436 static DBusHashTable *shared_connections = NULL;
1437
1438 static void
1439 shared_connections_shutdown (void *data)
1440 {
1441   int n_entries;
1442
1443   _DBUS_LOCK (shared_connections);
1444
1445   /* This is a little bit unpleasant... better ideas? */
1446   while ((n_entries = _dbus_hash_table_get_n_entries (shared_connections)) > 0)
1447     {
1448       DBusConnection *connection;
1449       DBusMessage *message;
1450       DBusHashIter iter;
1451
1452       _dbus_hash_iter_init (shared_connections, &iter);
1453       _dbus_hash_iter_next (&iter);
1454
1455       connection = _dbus_hash_iter_get_value (&iter);
1456
1457       _DBUS_UNLOCK (shared_connections);
1458
1459       dbus_connection_ref (connection);
1460       _dbus_connection_close_possibly_shared (connection);
1461
1462       /* Churn through to the Disconnected message */
1463       while ((message = dbus_connection_pop_message (connection)))
1464         {
1465           dbus_message_unref (message);
1466         }
1467       dbus_connection_unref (connection);
1468
1469       _DBUS_LOCK (shared_connections);
1470
1471       /* The connection should now be dead and not in our hash ... */
1472       _dbus_assert (_dbus_hash_table_get_n_entries (shared_connections) < n_entries);
1473     }
1474
1475   _dbus_assert (_dbus_hash_table_get_n_entries (shared_connections) == 0);
1476
1477   _dbus_hash_table_unref (shared_connections);
1478   shared_connections = NULL;
1479
1480   _DBUS_UNLOCK (shared_connections);
1481 }
1482
1483 static dbus_bool_t
1484 connection_lookup_shared (DBusAddressEntry  *entry,
1485                           DBusConnection   **result)
1486 {
1487   _dbus_verbose ("checking for existing connection\n");
1488
1489   *result = NULL;
1490
1491   _DBUS_LOCK (shared_connections);
1492
1493   if (shared_connections == NULL)
1494     {
1495       _dbus_verbose ("creating shared_connections hash table\n");
1496
1497       shared_connections = _dbus_hash_table_new (DBUS_HASH_STRING,
1498                                                  dbus_free,
1499                                                  NULL);
1500       if (shared_connections == NULL)
1501         {
1502           _DBUS_UNLOCK (shared_connections);
1503           return FALSE;
1504         }
1505
1506       if (!_dbus_register_shutdown_func (shared_connections_shutdown, NULL))
1507         {
1508           _dbus_hash_table_unref (shared_connections);
1509           shared_connections = NULL;
1510           _DBUS_UNLOCK (shared_connections);
1511           return FALSE;
1512         }
1513
1514       _dbus_verbose ("  successfully created shared_connections\n");
1515
1516       _DBUS_UNLOCK (shared_connections);
1517       return TRUE; /* no point looking up in the hash we just made */
1518     }
1519   else
1520     {
1521       const char *guid;
1522
1523       guid = dbus_address_entry_get_value (entry, "guid");
1524
1525       if (guid != NULL)
1526         {
1527           DBusConnection *connection;
1528
1529           connection = _dbus_hash_table_lookup_string (shared_connections,
1530                                                        guid);
1531
1532           if (connection)
1533             {
1534               /* The DBusConnection can't be finalized without taking
1535                * the shared_connections lock to remove it from the
1536                * hash.  So it's safe to ref the connection here.
1537                * However, it may be disconnected if the Disconnected
1538                * message hasn't been processed yet, in which case we
1539                * want to pretend it isn't in the hash and avoid
1540                * returning it.
1541                *
1542                * The idea is to avoid ever returning a disconnected connection
1543                * from dbus_connection_open(). We could just synchronously
1544                * drop our shared ref to the connection on connection disconnect,
1545                * and then assert here that the connection is connected, but
1546                * that causes reentrancy headaches.
1547                */
1548               CONNECTION_LOCK (connection);
1549               if (_dbus_connection_get_is_connected_unlocked (connection))
1550                 {
1551                   _dbus_connection_ref_unlocked (connection);
1552                   *result = connection;
1553                   _dbus_verbose ("looked up existing connection to server guid %s\n",
1554                                  guid);
1555                 }
1556               else
1557                 {
1558                   _dbus_verbose ("looked up existing connection to server guid %s but it was disconnected so ignoring it\n",
1559                                  guid);
1560                 }
1561               CONNECTION_UNLOCK (connection);
1562             }
1563         }
1564
1565       _DBUS_UNLOCK (shared_connections);
1566       return TRUE;
1567     }
1568 }
1569
1570 static dbus_bool_t
1571 connection_record_shared_unlocked (DBusConnection *connection,
1572                                    const char     *guid)
1573 {
1574   char *guid_key;
1575   char *guid_in_connection;
1576
1577   HAVE_LOCK_CHECK (connection);
1578   _dbus_assert (connection->server_guid == NULL);
1579   _dbus_assert (connection->shareable);
1580
1581   /* get a hard ref on this connection, even if
1582    * we won't in fact store it in the hash, we still
1583    * need to hold a ref on it until it's disconnected.
1584    */
1585   _dbus_connection_ref_unlocked (connection);
1586
1587   if (guid == NULL)
1588     return TRUE; /* don't store in the hash */
1589
1590   /* A separate copy of the key is required in the hash table, because
1591    * we don't have a lock on the connection when we are doing a hash
1592    * lookup.
1593    */
1594
1595   guid_key = _dbus_strdup (guid);
1596   if (guid_key == NULL)
1597     return FALSE;
1598
1599   guid_in_connection = _dbus_strdup (guid);
1600   if (guid_in_connection == NULL)
1601     {
1602       dbus_free (guid_key);
1603       return FALSE;
1604     }
1605
1606   _DBUS_LOCK (shared_connections);
1607   _dbus_assert (shared_connections != NULL);
1608
1609   if (!_dbus_hash_table_insert_string (shared_connections,
1610                                        guid_key, connection))
1611     {
1612       dbus_free (guid_key);
1613       dbus_free (guid_in_connection);
1614       _DBUS_UNLOCK (shared_connections);
1615       return FALSE;
1616     }
1617
1618   connection->server_guid = guid_in_connection;
1619
1620   _dbus_verbose ("stored connection to %s to be shared\n",
1621                  connection->server_guid);
1622
1623   _DBUS_UNLOCK (shared_connections);
1624
1625   _dbus_assert (connection->server_guid != NULL);
1626
1627   return TRUE;
1628 }
1629
1630 static void
1631 connection_forget_shared_unlocked (DBusConnection *connection)
1632 {
1633   HAVE_LOCK_CHECK (connection);
1634
1635   if (!connection->shareable)
1636     return;
1637
1638   if (connection->server_guid != NULL)
1639     {
1640       _dbus_verbose ("dropping connection to %s out of the shared table\n",
1641                      connection->server_guid);
1642
1643       _DBUS_LOCK (shared_connections);
1644
1645       if (!_dbus_hash_table_remove_string (shared_connections,
1646                                            connection->server_guid))
1647         _dbus_assert_not_reached ("connection was not in the shared table");
1648
1649       dbus_free (connection->server_guid);
1650       connection->server_guid = NULL;
1651       _DBUS_UNLOCK (shared_connections);
1652     }
1653
1654   /* remove our reference held on all shareable connections */
1655   _dbus_connection_unref_unlocked (connection);
1656 }
1657
1658 static DBusConnection*
1659 connection_try_from_address_entry (DBusAddressEntry *entry,
1660                                    DBusError        *error)
1661 {
1662   DBusTransport *transport;
1663   DBusConnection *connection;
1664
1665   transport = _dbus_transport_open (entry, error);
1666
1667   if (transport == NULL)
1668     {
1669       _DBUS_ASSERT_ERROR_IS_SET (error);
1670       return NULL;
1671     }
1672
1673   connection = _dbus_connection_new_for_transport (transport);
1674
1675   _dbus_transport_unref (transport);
1676
1677   if (connection == NULL)
1678     {
1679       _DBUS_SET_OOM (error);
1680       return NULL;
1681     }
1682
1683 #ifndef DBUS_DISABLE_CHECKS
1684   _dbus_assert (!connection->have_connection_lock);
1685 #endif
1686   return connection;
1687 }
1688
1689 /*
1690  * If the shared parameter is true, then any existing connection will
1691  * be used (and if a new connection is created, it will be available
1692  * for use by others). If the shared parameter is false, a new
1693  * connection will always be created, and the new connection will
1694  * never be returned to other callers.
1695  *
1696  * @param address the address
1697  * @param shared whether the connection is shared or private
1698  * @param error error return
1699  * @returns the connection or #NULL on error
1700  */
1701 static DBusConnection*
1702 _dbus_connection_open_internal (const char     *address,
1703                                 dbus_bool_t     shared,
1704                                 DBusError      *error)
1705 {
1706   DBusConnection *connection;
1707   DBusAddressEntry **entries;
1708   DBusError tmp_error;
1709   DBusError first_error;
1710   int len, i;
1711
1712   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1713
1714   _dbus_verbose ("opening %s connection to: %s\n",
1715                  shared ? "shared" : "private", address);
1716
1717   if (!dbus_parse_address (address, &entries, &len, error))
1718     return NULL;
1719
1720   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1721
1722   connection = NULL;
1723
1724   dbus_error_init (&tmp_error);
1725   dbus_error_init (&first_error);
1726   for (i = 0; i < len; i++)
1727     {
1728       if (shared)
1729         {
1730           if (!connection_lookup_shared (entries[i], &connection))
1731             _DBUS_SET_OOM (&tmp_error);
1732         }
1733
1734       if (connection == NULL)
1735         {
1736           connection = connection_try_from_address_entry (entries[i],
1737                                                           &tmp_error);
1738
1739           if (connection != NULL && shared)
1740             {
1741               const char *guid;
1742
1743               connection->shareable = TRUE;
1744
1745               /* guid may be NULL */
1746               guid = dbus_address_entry_get_value (entries[i], "guid");
1747
1748               CONNECTION_LOCK (connection);
1749
1750               if (!connection_record_shared_unlocked (connection, guid))
1751                 {
1752                   _DBUS_SET_OOM (&tmp_error);
1753                   _dbus_connection_close_possibly_shared_and_unlock (connection);
1754                   dbus_connection_unref (connection);
1755                   connection = NULL;
1756                 }
1757               else
1758                 CONNECTION_UNLOCK (connection);
1759             }
1760         }
1761
1762       if (connection)
1763         break;
1764
1765       _DBUS_ASSERT_ERROR_IS_SET (&tmp_error);
1766
1767       if (i == 0)
1768         dbus_move_error (&tmp_error, &first_error);
1769       else
1770         dbus_error_free (&tmp_error);
1771     }
1772
1773   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1774   _DBUS_ASSERT_ERROR_IS_CLEAR (&tmp_error);
1775
1776   if (connection == NULL)
1777     {
1778       _DBUS_ASSERT_ERROR_IS_SET (&first_error);
1779       dbus_move_error (&first_error, error);
1780     }
1781   else
1782     dbus_error_free (&first_error);
1783
1784   dbus_address_entries_free (entries);
1785   return connection;
1786 }
1787
1788 /**
1789  * Closes a shared OR private connection, while dbus_connection_close() can
1790  * only be used on private connections. Should only be called by the
1791  * dbus code that owns the connection - an owner must be known,
1792  * the open/close state is like malloc/free, not like ref/unref.
1793  *
1794  * @param connection the connection
1795  */
1796 void
1797 _dbus_connection_close_possibly_shared (DBusConnection *connection)
1798 {
1799   _dbus_assert (connection != NULL);
1800   _dbus_assert (connection->generation == _dbus_current_generation);
1801
1802   CONNECTION_LOCK (connection);
1803   _dbus_connection_close_possibly_shared_and_unlock (connection);
1804 }
1805
1806 static DBusPreallocatedSend*
1807 _dbus_connection_preallocate_send_unlocked (DBusConnection *connection)
1808 {
1809   DBusPreallocatedSend *preallocated;
1810
1811   HAVE_LOCK_CHECK (connection);
1812
1813   _dbus_assert (connection != NULL);
1814
1815   preallocated = dbus_new (DBusPreallocatedSend, 1);
1816   if (preallocated == NULL)
1817     return NULL;
1818
1819   if (connection->link_cache != NULL)
1820     {
1821       preallocated->queue_link =
1822         _dbus_list_pop_first_link (&connection->link_cache);
1823       preallocated->queue_link->data = NULL;
1824     }
1825   else
1826     {
1827       preallocated->queue_link = _dbus_list_alloc_link (NULL);
1828       if (preallocated->queue_link == NULL)
1829         goto failed_0;
1830     }
1831
1832   if (connection->link_cache != NULL)
1833     {
1834       preallocated->counter_link =
1835         _dbus_list_pop_first_link (&connection->link_cache);
1836       preallocated->counter_link->data = connection->outgoing_counter;
1837     }
1838   else
1839     {
1840       preallocated->counter_link = _dbus_list_alloc_link (connection->outgoing_counter);
1841       if (preallocated->counter_link == NULL)
1842         goto failed_1;
1843     }
1844
1845   _dbus_counter_ref (preallocated->counter_link->data);
1846
1847   preallocated->connection = connection;
1848
1849   return preallocated;
1850
1851  failed_1:
1852   _dbus_list_free_link (preallocated->queue_link);
1853  failed_0:
1854   dbus_free (preallocated);
1855
1856   return NULL;
1857 }
1858
1859 /* Called with lock held, does not update dispatch status */
1860 static void
1861 _dbus_connection_send_preallocated_unlocked_no_update (DBusConnection       *connection,
1862                                                        DBusPreallocatedSend *preallocated,
1863                                                        DBusMessage          *message,
1864                                                        dbus_uint32_t        *client_serial)
1865 {
1866   dbus_uint32_t serial;
1867   const char *sig;
1868
1869   preallocated->queue_link->data = message;
1870   _dbus_list_prepend_link (&connection->outgoing_messages,
1871                            preallocated->queue_link);
1872
1873   _dbus_message_add_size_counter_link (message,
1874                                        preallocated->counter_link);
1875
1876   dbus_free (preallocated);
1877   preallocated = NULL;
1878
1879   dbus_message_ref (message);
1880
1881   connection->n_outgoing += 1;
1882
1883   sig = dbus_message_get_signature (message);
1884
1885   _dbus_verbose ("Message %p (%d %s %s %s '%s') for %s added to outgoing queue %p, %d pending to send\n",
1886                  message,
1887                  dbus_message_get_type (message),
1888                  dbus_message_get_path (message) ?
1889                  dbus_message_get_path (message) :
1890                  "no path",
1891                  dbus_message_get_interface (message) ?
1892                  dbus_message_get_interface (message) :
1893                  "no interface",
1894                  dbus_message_get_member (message) ?
1895                  dbus_message_get_member (message) :
1896                  "no member",
1897                  sig,
1898                  dbus_message_get_destination (message) ?
1899                  dbus_message_get_destination (message) :
1900                  "null",
1901                  connection,
1902                  connection->n_outgoing);
1903
1904   if (dbus_message_get_serial (message) == 0)
1905     {
1906       serial = _dbus_connection_get_next_client_serial (connection);
1907       _dbus_message_set_serial (message, serial);
1908       if (client_serial)
1909         *client_serial = serial;
1910     }
1911   else
1912     {
1913       if (client_serial)
1914         *client_serial = dbus_message_get_serial (message);
1915     }
1916
1917   _dbus_verbose ("Message %p serial is %u\n",
1918                  message, dbus_message_get_serial (message));
1919
1920   _dbus_message_lock (message);
1921
1922   /* Now we need to run an iteration to hopefully just write the messages
1923    * out immediately, and otherwise get them queued up
1924    */
1925   _dbus_connection_do_iteration_unlocked (connection,
1926                                           DBUS_ITERATION_DO_WRITING,
1927                                           -1);
1928
1929   /* If stuff is still queued up, be sure we wake up the main loop */
1930   if (connection->n_outgoing > 0)
1931     _dbus_connection_wakeup_mainloop (connection);
1932 }
1933
1934 static void
1935 _dbus_connection_send_preallocated_and_unlock (DBusConnection       *connection,
1936                                                DBusPreallocatedSend *preallocated,
1937                                                DBusMessage          *message,
1938                                                dbus_uint32_t        *client_serial)
1939 {
1940   DBusDispatchStatus status;
1941
1942   HAVE_LOCK_CHECK (connection);
1943
1944   _dbus_connection_send_preallocated_unlocked_no_update (connection,
1945                                                          preallocated,
1946                                                          message, client_serial);
1947
1948   _dbus_verbose ("%s middle\n", _DBUS_FUNCTION_NAME);
1949   status = _dbus_connection_get_dispatch_status_unlocked (connection);
1950
1951   /* this calls out to user code */
1952   _dbus_connection_update_dispatch_status_and_unlock (connection, status);
1953 }
1954
1955 /**
1956  * Like dbus_connection_send(), but assumes the connection
1957  * is already locked on function entry, and unlocks before returning.
1958  *
1959  * @param connection the connection
1960  * @param message the message to send
1961  * @param client_serial return location for client serial of sent message
1962  * @returns #FALSE on out-of-memory
1963  */
1964 dbus_bool_t
1965 _dbus_connection_send_and_unlock (DBusConnection *connection,
1966                                   DBusMessage    *message,
1967                                   dbus_uint32_t  *client_serial)
1968 {
1969   DBusPreallocatedSend *preallocated;
1970
1971   _dbus_assert (connection != NULL);
1972   _dbus_assert (message != NULL);
1973
1974   preallocated = _dbus_connection_preallocate_send_unlocked (connection);
1975   if (preallocated == NULL)
1976     {
1977       CONNECTION_UNLOCK (connection);
1978       return FALSE;
1979     }
1980
1981   _dbus_connection_send_preallocated_and_unlock (connection,
1982                                                  preallocated,
1983                                                  message,
1984                                                  client_serial);
1985   return TRUE;
1986 }
1987
1988 /**
1989  * Used internally to handle the semantics of dbus_server_set_new_connection_function().
1990  * If the new connection function does not ref the connection, we want to close it.
1991  *
1992  * A bit of a hack, probably the new connection function should have returned a value
1993  * for whether to close, or should have had to close the connection itself if it
1994  * didn't want it.
1995  *
1996  * But, this works OK as long as the new connection function doesn't do anything
1997  * crazy like keep the connection around without ref'ing it.
1998  *
1999  * We have to lock the connection across refcount check and close in case
2000  * the new connection function spawns a thread that closes and unrefs.
2001  * In that case, if the app thread
2002  * closes and unrefs first, we'll harmlessly close again; if the app thread
2003  * still has the ref, we'll close and then the app will close harmlessly.
2004  * If the app unrefs without closing, the app is broken since if the
2005  * app refs from the new connection function it is supposed to also close.
2006  *
2007  * If we didn't atomically check the refcount and close with the lock held
2008  * though, we could screw this up.
2009  *
2010  * @param connection the connection
2011  */
2012 void
2013 _dbus_connection_close_if_only_one_ref (DBusConnection *connection)
2014 {
2015   CONNECTION_LOCK (connection);
2016
2017   _dbus_assert (connection->refcount.value > 0);
2018
2019   if (connection->refcount.value == 1)
2020     _dbus_connection_close_possibly_shared_and_unlock (connection);
2021   else
2022     CONNECTION_UNLOCK (connection);
2023 }
2024
2025
2026 /**
2027  * When a function that blocks has been called with a timeout, and we
2028  * run out of memory, the time to wait for memory is based on the
2029  * timeout. If the caller was willing to block a long time we wait a
2030  * relatively long time for memory, if they were only willing to block
2031  * briefly then we retry for memory at a rapid rate.
2032  *
2033  * @timeout_milliseconds the timeout requested for blocking
2034  */
2035 static void
2036 _dbus_memory_pause_based_on_timeout (int timeout_milliseconds)
2037 {
2038   if (timeout_milliseconds == -1)
2039     _dbus_sleep_milliseconds (1000);
2040   else if (timeout_milliseconds < 100)
2041     ; /* just busy loop */
2042   else if (timeout_milliseconds <= 1000)
2043     _dbus_sleep_milliseconds (timeout_milliseconds / 3);
2044   else
2045     _dbus_sleep_milliseconds (1000);
2046 }
2047
2048 static DBusMessage *
2049 generate_local_error_message (dbus_uint32_t serial,
2050                               char *error_name,
2051                               char *error_msg)
2052 {
2053   DBusMessage *message;
2054   message = dbus_message_new (DBUS_MESSAGE_TYPE_ERROR);
2055   if (!message)
2056     goto out;
2057
2058   if (!dbus_message_set_error_name (message, error_name))
2059     {
2060       dbus_message_unref (message);
2061       message = NULL;
2062       goto out;
2063     }
2064
2065   dbus_message_set_no_reply (message, TRUE);
2066
2067   if (!dbus_message_set_reply_serial (message,
2068                                       serial))
2069     {
2070       dbus_message_unref (message);
2071       message = NULL;
2072       goto out;
2073     }
2074
2075   if (error_msg != NULL)
2076     {
2077       DBusMessageIter iter;
2078
2079       dbus_message_iter_init_append (message, &iter);
2080       if (!dbus_message_iter_append_basic (&iter,
2081                                            DBUS_TYPE_STRING,
2082                                            &error_msg))
2083         {
2084           dbus_message_unref (message);
2085           message = NULL;
2086           goto out;
2087         }
2088     }
2089
2090  out:
2091   return message;
2092 }
2093
2094
2095 /* This is slightly strange since we can pop a message here without
2096  * the dispatch lock.
2097  */
2098 static DBusMessage*
2099 check_for_reply_unlocked (DBusConnection *connection,
2100                           dbus_uint32_t   client_serial)
2101 {
2102   DBusList *link;
2103
2104   HAVE_LOCK_CHECK (connection);
2105
2106   link = _dbus_list_get_first_link (&connection->incoming_messages);
2107
2108   while (link != NULL)
2109     {
2110       DBusMessage *reply = link->data;
2111
2112       if (dbus_message_get_reply_serial (reply) == client_serial)
2113         {
2114           _dbus_list_remove_link (&connection->incoming_messages, link);
2115           connection->n_incoming  -= 1;
2116           return reply;
2117         }
2118       link = _dbus_list_get_next_link (&connection->incoming_messages, link);
2119     }
2120
2121   return NULL;
2122 }
2123
2124 static void
2125 connection_timeout_and_complete_all_pending_calls_unlocked (DBusConnection *connection)
2126 {
2127    /* We can't iterate over the hash in the normal way since we'll be
2128     * dropping the lock for each item. So we restart the
2129     * iter each time as we drain the hash table.
2130     */
2131
2132    while (_dbus_hash_table_get_n_entries (connection->pending_replies) > 0)
2133     {
2134       DBusPendingCall *pending;
2135       DBusHashIter iter;
2136
2137       _dbus_hash_iter_init (connection->pending_replies, &iter);
2138       _dbus_hash_iter_next (&iter);
2139
2140       pending = _dbus_hash_iter_get_value (&iter);
2141       _dbus_pending_call_ref_unlocked (pending);
2142
2143       _dbus_pending_call_queue_timeout_error_unlocked (pending,
2144                                                        connection);
2145       _dbus_connection_remove_timeout_unlocked (connection,
2146                                                 _dbus_pending_call_get_timeout_unlocked (pending));
2147       _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
2148       _dbus_hash_iter_remove_entry (&iter);
2149
2150       _dbus_pending_call_unref_and_unlock (pending);
2151       CONNECTION_LOCK (connection);
2152     }
2153   HAVE_LOCK_CHECK (connection);
2154 }
2155
2156 static void
2157 complete_pending_call_and_unlock (DBusConnection  *connection,
2158                                   DBusPendingCall *pending,
2159                                   DBusMessage     *message)
2160 {
2161   _dbus_pending_call_set_reply_unlocked (pending, message);
2162   _dbus_pending_call_ref_unlocked (pending); /* in case there's no app with a ref held */
2163   _dbus_connection_detach_pending_call_and_unlock (connection, pending);
2164
2165   /* Must be called unlocked since it invokes app callback */
2166   _dbus_pending_call_complete (pending);
2167   dbus_pending_call_unref (pending);
2168 }
2169
2170 static dbus_bool_t
2171 check_for_reply_and_update_dispatch_unlocked (DBusConnection  *connection,
2172                                               DBusPendingCall *pending)
2173 {
2174   DBusMessage *reply;
2175   DBusDispatchStatus status;
2176
2177   reply = check_for_reply_unlocked (connection,
2178                                     _dbus_pending_call_get_reply_serial_unlocked (pending));
2179   if (reply != NULL)
2180     {
2181       _dbus_verbose ("%s checked for reply\n", _DBUS_FUNCTION_NAME);
2182
2183       _dbus_verbose ("dbus_connection_send_with_reply_and_block(): got reply\n");
2184
2185       complete_pending_call_and_unlock (connection, pending, reply);
2186       dbus_message_unref (reply);
2187
2188       CONNECTION_LOCK (connection);
2189       status = _dbus_connection_get_dispatch_status_unlocked (connection);
2190       _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2191       dbus_pending_call_unref (pending);
2192
2193       return TRUE;
2194     }
2195
2196   return FALSE;
2197 }
2198
2199 /**
2200  * Blocks until a pending call times out or gets a reply.
2201  *
2202  * Does not re-enter the main loop or run filter/path-registered
2203  * callbacks. The reply to the message will not be seen by
2204  * filter callbacks.
2205  *
2206  * Returns immediately if pending call already got a reply.
2207  *
2208  * @todo could use performance improvements (it keeps scanning
2209  * the whole message queue for example)
2210  *
2211  * @param pending the pending call we block for a reply on
2212  */
2213 void
2214 _dbus_connection_block_pending_call (DBusPendingCall *pending)
2215 {
2216   long start_tv_sec, start_tv_usec;
2217   long end_tv_sec, end_tv_usec;
2218   long tv_sec, tv_usec;
2219   DBusDispatchStatus status;
2220   DBusConnection *connection;
2221   dbus_uint32_t client_serial;
2222   int timeout_milliseconds;
2223
2224   _dbus_assert (pending != NULL);
2225
2226   if (dbus_pending_call_get_completed (pending))
2227     return;
2228
2229   dbus_pending_call_ref (pending); /* necessary because the call could be canceled */
2230
2231   connection = _dbus_pending_call_get_connection_and_lock (pending);
2232
2233   /* Flush message queue - note, can affect dispatch status */
2234   _dbus_connection_flush_unlocked (connection);
2235
2236   client_serial = _dbus_pending_call_get_reply_serial_unlocked (pending);
2237
2238   /* note that timeout_milliseconds is limited to a smallish value
2239    * in _dbus_pending_call_new() so overflows aren't possible
2240    * below
2241    */
2242   timeout_milliseconds = dbus_timeout_get_interval (_dbus_pending_call_get_timeout_unlocked (pending));
2243
2244   _dbus_get_current_time (&start_tv_sec, &start_tv_usec);
2245   end_tv_sec = start_tv_sec + timeout_milliseconds / 1000;
2246   end_tv_usec = start_tv_usec + (timeout_milliseconds % 1000) * 1000;
2247   end_tv_sec += end_tv_usec / _DBUS_USEC_PER_SECOND;
2248   end_tv_usec = end_tv_usec % _DBUS_USEC_PER_SECOND;
2249
2250   _dbus_verbose ("dbus_connection_send_with_reply_and_block(): will block %d milliseconds for reply serial %u from %ld sec %ld usec to %ld sec %ld usec\n",
2251                  timeout_milliseconds,
2252                  client_serial,
2253                  start_tv_sec, start_tv_usec,
2254                  end_tv_sec, end_tv_usec);
2255
2256   /* check to see if we already got the data off the socket */
2257   /* from another blocked pending call */
2258   if (check_for_reply_and_update_dispatch_unlocked (connection, pending))
2259     return;
2260
2261   /* Now we wait... */
2262   /* always block at least once as we know we don't have the reply yet */
2263   _dbus_connection_do_iteration_unlocked (connection,
2264                                           DBUS_ITERATION_DO_READING |
2265                                           DBUS_ITERATION_BLOCK,
2266                                           timeout_milliseconds);
2267
2268  recheck_status:
2269
2270   _dbus_verbose ("%s top of recheck\n", _DBUS_FUNCTION_NAME);
2271
2272   HAVE_LOCK_CHECK (connection);
2273
2274   /* queue messages and get status */
2275
2276   status = _dbus_connection_get_dispatch_status_unlocked (connection);
2277
2278   /* the get_completed() is in case a dispatch() while we were blocking
2279    * got the reply instead of us.
2280    */
2281   if (_dbus_pending_call_get_completed_unlocked (pending))
2282     {
2283       _dbus_verbose ("Pending call completed by dispatch in %s\n", _DBUS_FUNCTION_NAME);
2284       _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2285       dbus_pending_call_unref (pending);
2286       return;
2287     }
2288
2289   if (status == DBUS_DISPATCH_DATA_REMAINS) {
2290     if (check_for_reply_and_update_dispatch_unlocked (connection, pending))
2291       return;
2292   }
2293
2294   _dbus_get_current_time (&tv_sec, &tv_usec);
2295
2296   if (!_dbus_connection_get_is_connected_unlocked (connection))
2297     {
2298       DBusMessage *error_msg;
2299
2300       error_msg = generate_local_error_message (client_serial,
2301                                                 DBUS_ERROR_DISCONNECTED,
2302                                                 "Connection was disconnected before a reply was received");
2303
2304       /* on OOM error_msg is set to NULL */
2305       complete_pending_call_and_unlock (connection, pending, error_msg);
2306       dbus_pending_call_unref (pending);
2307       return;
2308     }
2309   else if (tv_sec < start_tv_sec)
2310     _dbus_verbose ("dbus_connection_send_with_reply_and_block(): clock set backward\n");
2311   else if (connection->disconnect_message_link == NULL)
2312     _dbus_verbose ("dbus_connection_send_with_reply_and_block(): disconnected\n");
2313   else if (tv_sec < end_tv_sec ||
2314            (tv_sec == end_tv_sec && tv_usec < end_tv_usec))
2315     {
2316       timeout_milliseconds = (end_tv_sec - tv_sec) * 1000 +
2317         (end_tv_usec - tv_usec) / 1000;
2318       _dbus_verbose ("dbus_connection_send_with_reply_and_block(): %d milliseconds remain\n", timeout_milliseconds);
2319       _dbus_assert (timeout_milliseconds >= 0);
2320
2321       if (status == DBUS_DISPATCH_NEED_MEMORY)
2322         {
2323           /* Try sleeping a bit, as we aren't sure we need to block for reading,
2324            * we may already have a reply in the buffer and just can't process
2325            * it.
2326            */
2327           _dbus_verbose ("dbus_connection_send_with_reply_and_block() waiting for more memory\n");
2328
2329           _dbus_memory_pause_based_on_timeout (timeout_milliseconds);
2330         }
2331       else
2332         {
2333           /* block again, we don't have the reply buffered yet. */
2334           _dbus_connection_do_iteration_unlocked (connection,
2335                                                   DBUS_ITERATION_DO_READING |
2336                                                   DBUS_ITERATION_BLOCK,
2337                                                   timeout_milliseconds);
2338         }
2339
2340       goto recheck_status;
2341     }
2342
2343   _dbus_verbose ("dbus_connection_send_with_reply_and_block(): Waited %ld milliseconds and got no reply\n",
2344                  (tv_sec - start_tv_sec) * 1000 + (tv_usec - start_tv_usec) / 1000);
2345
2346   _dbus_assert (!_dbus_pending_call_get_completed_unlocked (pending));
2347
2348   /* unlock and call user code */
2349   complete_pending_call_and_unlock (connection, pending, NULL);
2350
2351   /* update user code on dispatch status */
2352   CONNECTION_LOCK (connection);
2353   status = _dbus_connection_get_dispatch_status_unlocked (connection);
2354   _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2355   dbus_pending_call_unref (pending);
2356 }
2357
2358 /** @} */
2359
2360 /**
2361  * @addtogroup DBusConnection
2362  *
2363  * @{
2364  */
2365
2366 /**
2367  * Gets a connection to a remote address. If a connection to the given
2368  * address already exists, returns the existing connection with its
2369  * reference count incremented.  Otherwise, returns a new connection
2370  * and saves the new connection for possible re-use if a future call
2371  * to dbus_connection_open() asks to connect to the same server.
2372  *
2373  * Use dbus_connection_open_private() to get a dedicated connection
2374  * not shared with other callers of dbus_connection_open().
2375  *
2376  * If the open fails, the function returns #NULL, and provides a
2377  * reason for the failure in the error parameter. Pass #NULL for the
2378  * error parameter if you aren't interested in the reason for
2379  * failure.
2380  *
2381  * Because this connection is shared, no user of the connection
2382  * may call dbus_connection_close(). However, when you are done with the
2383  * connection you should call dbus_connection_unref().
2384  *
2385  * @param address the address.
2386  * @param error address where an error can be returned.
2387  * @returns new connection, or #NULL on failure.
2388  */
2389 DBusConnection*
2390 dbus_connection_open (const char     *address,
2391                       DBusError      *error)
2392 {
2393   DBusConnection *connection;
2394
2395   _dbus_return_val_if_fail (address != NULL, NULL);
2396   _dbus_return_val_if_error_is_set (error, NULL);
2397
2398   connection = _dbus_connection_open_internal (address,
2399                                                TRUE,
2400                                                error);
2401
2402   return connection;
2403 }
2404
2405 /**
2406  * Opens a new, dedicated connection to a remote address. Unlike
2407  * dbus_connection_open(), always creates a new connection.
2408  * This connection will not be saved or recycled by libdbus.
2409  *
2410  * If the open fails, the function returns #NULL, and provides a
2411  * reason for the failure in the error parameter. Pass #NULL for the
2412  * error parameter if you aren't interested in the reason for
2413  * failure.
2414  *
2415  * When you are done with this connection, you must
2416  * dbus_connection_close() to disconnect it,
2417  * and dbus_connection_unref() to free the connection object.
2418  *
2419  * (The dbus_connection_close() can be skipped if the
2420  * connection is already known to be disconnected, for example
2421  * if you are inside a handler for the Disconnected signal.)
2422  *
2423  * @param address the address.
2424  * @param error address where an error can be returned.
2425  * @returns new connection, or #NULL on failure.
2426  */
2427 DBusConnection*
2428 dbus_connection_open_private (const char     *address,
2429                               DBusError      *error)
2430 {
2431   DBusConnection *connection;
2432
2433   _dbus_return_val_if_fail (address != NULL, NULL);
2434   _dbus_return_val_if_error_is_set (error, NULL);
2435
2436   connection = _dbus_connection_open_internal (address,
2437                                                FALSE,
2438                                                error);
2439
2440   return connection;
2441 }
2442
2443 /**
2444  * Increments the reference count of a DBusConnection.
2445  *
2446  * @param connection the connection.
2447  * @returns the connection.
2448  */
2449 DBusConnection *
2450 dbus_connection_ref (DBusConnection *connection)
2451 {
2452   _dbus_return_val_if_fail (connection != NULL, NULL);
2453   _dbus_return_val_if_fail (connection->generation == _dbus_current_generation, NULL);
2454
2455   /* The connection lock is better than the global
2456    * lock in the atomic increment fallback
2457    */
2458
2459 #ifdef DBUS_HAVE_ATOMIC_INT
2460   _dbus_atomic_inc (&connection->refcount);
2461 #else
2462   CONNECTION_LOCK (connection);
2463   _dbus_assert (connection->refcount.value > 0);
2464
2465   connection->refcount.value += 1;
2466   CONNECTION_UNLOCK (connection);
2467 #endif
2468
2469   return connection;
2470 }
2471
2472 static void
2473 free_outgoing_message (void *element,
2474                        void *data)
2475 {
2476   DBusMessage *message = element;
2477   DBusConnection *connection = data;
2478
2479   _dbus_message_remove_size_counter (message,
2480                                      connection->outgoing_counter,
2481                                      NULL);
2482   dbus_message_unref (message);
2483 }
2484
2485 /* This is run without the mutex held, but after the last reference
2486  * to the connection has been dropped we should have no thread-related
2487  * problems
2488  */
2489 static void
2490 _dbus_connection_last_unref (DBusConnection *connection)
2491 {
2492   DBusList *link;
2493
2494   _dbus_verbose ("Finalizing connection %p\n", connection);
2495
2496   _dbus_assert (connection->refcount.value == 0);
2497
2498   /* You have to disconnect the connection before unref:ing it. Otherwise
2499    * you won't get the disconnected message.
2500    */
2501   _dbus_assert (!_dbus_transport_get_is_connected (connection->transport));
2502   _dbus_assert (connection->server_guid == NULL);
2503
2504   /* ---- We're going to call various application callbacks here, hope it doesn't break anything... */
2505   _dbus_object_tree_free_all_unlocked (connection->objects);
2506
2507   dbus_connection_set_dispatch_status_function (connection, NULL, NULL, NULL);
2508   dbus_connection_set_wakeup_main_function (connection, NULL, NULL, NULL);
2509   dbus_connection_set_unix_user_function (connection, NULL, NULL, NULL);
2510
2511   _dbus_watch_list_free (connection->watches);
2512   connection->watches = NULL;
2513
2514   _dbus_timeout_list_free (connection->timeouts);
2515   connection->timeouts = NULL;
2516
2517   _dbus_data_slot_list_free (&connection->slot_list);
2518
2519   link = _dbus_list_get_first_link (&connection->filter_list);
2520   while (link != NULL)
2521     {
2522       DBusMessageFilter *filter = link->data;
2523       DBusList *next = _dbus_list_get_next_link (&connection->filter_list, link);
2524
2525       filter->function = NULL;
2526       _dbus_message_filter_unref (filter); /* calls app callback */
2527       link->data = NULL;
2528
2529       link = next;
2530     }
2531   _dbus_list_clear (&connection->filter_list);
2532
2533   /* ---- Done with stuff that invokes application callbacks */
2534
2535   _dbus_object_tree_unref (connection->objects);
2536
2537   _dbus_hash_table_unref (connection->pending_replies);
2538   connection->pending_replies = NULL;
2539
2540   _dbus_list_clear (&connection->filter_list);
2541
2542   _dbus_list_foreach (&connection->outgoing_messages,
2543                       free_outgoing_message,
2544                       connection);
2545   _dbus_list_clear (&connection->outgoing_messages);
2546
2547   _dbus_list_foreach (&connection->incoming_messages,
2548                       (DBusForeachFunction) dbus_message_unref,
2549                       NULL);
2550   _dbus_list_clear (&connection->incoming_messages);
2551
2552   _dbus_counter_unref (connection->outgoing_counter);
2553
2554   _dbus_transport_unref (connection->transport);
2555
2556   if (connection->disconnect_message_link)
2557     {
2558       DBusMessage *message = connection->disconnect_message_link->data;
2559       dbus_message_unref (message);
2560       _dbus_list_free_link (connection->disconnect_message_link);
2561     }
2562
2563   _dbus_list_clear (&connection->link_cache);
2564
2565   _dbus_condvar_free_at_location (&connection->dispatch_cond);
2566   _dbus_condvar_free_at_location (&connection->io_path_cond);
2567
2568   _dbus_mutex_free_at_location (&connection->io_path_mutex);
2569   _dbus_mutex_free_at_location (&connection->dispatch_mutex);
2570
2571   _dbus_mutex_free_at_location (&connection->mutex);
2572
2573   dbus_free (connection);
2574 }
2575
2576 /**
2577  * Decrements the reference count of a DBusConnection, and finalizes
2578  * it if the count reaches zero.
2579  *
2580  * Note: it is a bug to drop the last reference to a connection that
2581  * is still connected.
2582  *
2583  * For shared connections, libdbus will own a reference
2584  * as long as the connection is connected, so you can know that either
2585  * you don't have the last reference, or it's OK to drop the last reference.
2586  * Most connections are shared. dbus_connection_open() and dbus_bus_get()
2587  * return shared connections.
2588  *
2589  * For private connections, the creator of the connection must arrange for
2590  * dbus_connection_close() to be called prior to dropping the last reference.
2591  * Private connections come from dbus_connection_open_private() or dbus_bus_get_private().
2592  *
2593  * @param connection the connection.
2594  */
2595 void
2596 dbus_connection_unref (DBusConnection *connection)
2597 {
2598   dbus_bool_t last_unref;
2599
2600   _dbus_return_if_fail (connection != NULL);
2601   _dbus_return_if_fail (connection->generation == _dbus_current_generation);
2602
2603   /* The connection lock is better than the global
2604    * lock in the atomic increment fallback
2605    */
2606
2607 #ifdef DBUS_HAVE_ATOMIC_INT
2608   last_unref = (_dbus_atomic_dec (&connection->refcount) == 1);
2609 #else
2610   CONNECTION_LOCK (connection);
2611
2612   _dbus_assert (connection->refcount.value > 0);
2613
2614   connection->refcount.value -= 1;
2615   last_unref = (connection->refcount.value == 0);
2616
2617 #if 0
2618   printf ("unref() connection %p count = %d\n", connection, connection->refcount.value);
2619 #endif
2620
2621   CONNECTION_UNLOCK (connection);
2622 #endif
2623
2624   if (last_unref)
2625     {
2626 #ifndef DBUS_DISABLE_CHECKS
2627       if (_dbus_transport_get_is_connected (connection->transport))
2628         {
2629           _dbus_warn_check_failed ("The last reference on a connection was dropped without closing the connection. This is a bug in an application. See dbus_connection_unref() documentation for details.\n%s",
2630                                    connection->shareable ?
2631                                    "Most likely, the application called unref() too many times and removed a reference belonging to libdbus, since this is a shared connection.\n" :
2632                                     "Most likely, the application was supposed to call dbus_connection_close(), since this is a private connection.\n");
2633           return;
2634         }
2635 #endif
2636       _dbus_connection_last_unref (connection);
2637     }
2638 }
2639
2640 /*
2641  * Note that the transport can disconnect itself (other end drops us)
2642  * and in that case this function never runs. So this function must
2643  * not do anything more than disconnect the transport and update the
2644  * dispatch status.
2645  *
2646  * If the transport self-disconnects, then we assume someone will
2647  * dispatch the connection to cause the dispatch status update.
2648  */
2649 static void
2650 _dbus_connection_close_possibly_shared_and_unlock (DBusConnection *connection)
2651 {
2652   DBusDispatchStatus status;
2653
2654   HAVE_LOCK_CHECK (connection);
2655
2656   _dbus_verbose ("Disconnecting %p\n", connection);
2657
2658   /* We need to ref because update_dispatch_status_and_unlock will unref
2659    * the connection if it was shared and libdbus was the only remaining
2660    * refcount holder.
2661    */
2662   _dbus_connection_ref_unlocked (connection);
2663
2664   _dbus_transport_disconnect (connection->transport);
2665
2666   /* This has the side effect of queuing the disconnect message link
2667    * (unless we don't have enough memory, possibly, so don't assert it).
2668    * After the disconnect message link is queued, dbus_bus_get/dbus_connection_open
2669    * should never again return the newly-disconnected connection.
2670    *
2671    * However, we only unref the shared connection and exit_on_disconnect when
2672    * the disconnect message reaches the head of the message queue,
2673    * NOT when it's first queued.
2674    */
2675   status = _dbus_connection_get_dispatch_status_unlocked (connection);
2676
2677   /* This calls out to user code */
2678   _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2679
2680   /* Could also call out to user code */
2681   dbus_connection_unref (connection);
2682 }
2683
2684 /**
2685  * Closes a private connection, so no further data can be sent or received.
2686  * This disconnects the transport (such as a socket) underlying the
2687  * connection.
2688  *
2689  * Attempts to send messages after closing a connection are safe, but will result in
2690  * error replies generated locally in libdbus.
2691  *
2692  * This function does not affect the connection's reference count.  It's
2693  * safe to close a connection more than once; all calls after the
2694  * first do nothing. It's impossible to "reopen" a connection, a
2695  * new connection must be created. This function may result in a call
2696  * to the DBusDispatchStatusFunction set with
2697  * dbus_connection_set_dispatch_status_function(), as the disconnect
2698  * message it generates needs to be dispatched.
2699  *
2700  * If a connection is dropped by the remote application, it will
2701  * close itself.
2702  *
2703  * You must close a connection prior to releasing the last reference to
2704  * the connection. If you dbus_connection_unref() for the last time
2705  * without closing the connection, the results are undefined; it
2706  * is a bug in your program and libdbus will try to print a warning.
2707  *
2708  * You may not close a shared connection. Connections created with
2709  * dbus_connection_open() or dbus_bus_get() are shared.
2710  * These connections are owned by libdbus, and applications should
2711  * only unref them, never close them. Applications can know it is
2712  * safe to unref these connections because libdbus will be holding a
2713  * reference as long as the connection is open. Thus, either the
2714  * connection is closed and it is OK to drop the last reference,
2715  * or the connection is open and the app knows it does not have the
2716  * last reference.
2717  *
2718  * Connections created with dbus_connection_open_private() or
2719  * dbus_bus_get_private() are not kept track of or referenced by
2720  * libdbus. The creator of these connections is responsible for
2721  * calling dbus_connection_close() prior to releasing the last
2722  * reference, if the connection is not already disconnected.
2723  *
2724  * @param connection the private (unshared) connection to close
2725  */
2726 void
2727 dbus_connection_close (DBusConnection *connection)
2728 {
2729   _dbus_return_if_fail (connection != NULL);
2730   _dbus_return_if_fail (connection->generation == _dbus_current_generation);
2731
2732   CONNECTION_LOCK (connection);
2733
2734 #ifndef DBUS_DISABLE_CHECKS
2735   if (connection->shareable)
2736     {
2737       CONNECTION_UNLOCK (connection);
2738
2739       _dbus_warn_check_failed ("Applications must not close shared connections - see dbus_connection_close() docs. This is a bug in the application.\n");
2740       return;
2741     }
2742 #endif
2743
2744   _dbus_connection_close_possibly_shared_and_unlock (connection);
2745 }
2746
2747 static dbus_bool_t
2748 _dbus_connection_get_is_connected_unlocked (DBusConnection *connection)
2749 {
2750   HAVE_LOCK_CHECK (connection);
2751   return _dbus_transport_get_is_connected (connection->transport);
2752 }
2753
2754 /**
2755  * Gets whether the connection is currently open.  A connection may
2756  * become disconnected when the remote application closes its end, or
2757  * exits; a connection may also be disconnected with
2758  * dbus_connection_close().
2759  *
2760  * There are not separate states for "closed" and "disconnected," the two
2761  * terms are synonymous. This function should really be called
2762  * get_is_open() but for historical reasons is not.
2763  *
2764  * @param connection the connection.
2765  * @returns #TRUE if the connection is still alive.
2766  */
2767 dbus_bool_t
2768 dbus_connection_get_is_connected (DBusConnection *connection)
2769 {
2770   dbus_bool_t res;
2771
2772   _dbus_return_val_if_fail (connection != NULL, FALSE);
2773
2774   CONNECTION_LOCK (connection);
2775   res = _dbus_connection_get_is_connected_unlocked (connection);
2776   CONNECTION_UNLOCK (connection);
2777
2778   return res;
2779 }
2780
2781 /**
2782  * Gets whether the connection was authenticated. (Note that
2783  * if the connection was authenticated then disconnected,
2784  * this function still returns #TRUE)
2785  *
2786  * @param connection the connection
2787  * @returns #TRUE if the connection was ever authenticated
2788  */
2789 dbus_bool_t
2790 dbus_connection_get_is_authenticated (DBusConnection *connection)
2791 {
2792   dbus_bool_t res;
2793
2794   _dbus_return_val_if_fail (connection != NULL, FALSE);
2795
2796   CONNECTION_LOCK (connection);
2797   res = _dbus_transport_get_is_authenticated (connection->transport);
2798   CONNECTION_UNLOCK (connection);
2799
2800   return res;
2801 }
2802
2803 /**
2804  * Set whether _exit() should be called when the connection receives a
2805  * disconnect signal. The call to _exit() comes after any handlers for
2806  * the disconnect signal run; handlers can cancel the exit by calling
2807  * this function.
2808  *
2809  * By default, exit_on_disconnect is #FALSE; but for message bus
2810  * connections returned from dbus_bus_get() it will be toggled on
2811  * by default.
2812  *
2813  * @param connection the connection
2814  * @param exit_on_disconnect #TRUE if _exit() should be called after a disconnect signal
2815  */
2816 void
2817 dbus_connection_set_exit_on_disconnect (DBusConnection *connection,
2818                                         dbus_bool_t     exit_on_disconnect)
2819 {
2820   _dbus_return_if_fail (connection != NULL);
2821
2822   CONNECTION_LOCK (connection);
2823   connection->exit_on_disconnect = exit_on_disconnect != FALSE;
2824   CONNECTION_UNLOCK (connection);
2825 }
2826
2827 /**
2828  * Preallocates resources needed to send a message, allowing the message
2829  * to be sent without the possibility of memory allocation failure.
2830  * Allows apps to create a future guarantee that they can send
2831  * a message regardless of memory shortages.
2832  *
2833  * @param connection the connection we're preallocating for.
2834  * @returns the preallocated resources, or #NULL
2835  */
2836 DBusPreallocatedSend*
2837 dbus_connection_preallocate_send (DBusConnection *connection)
2838 {
2839   DBusPreallocatedSend *preallocated;
2840
2841   _dbus_return_val_if_fail (connection != NULL, NULL);
2842
2843   CONNECTION_LOCK (connection);
2844
2845   preallocated =
2846     _dbus_connection_preallocate_send_unlocked (connection);
2847
2848   CONNECTION_UNLOCK (connection);
2849
2850   return preallocated;
2851 }
2852
2853 /**
2854  * Frees preallocated message-sending resources from
2855  * dbus_connection_preallocate_send(). Should only
2856  * be called if the preallocated resources are not used
2857  * to send a message.
2858  *
2859  * @param connection the connection
2860  * @param preallocated the resources
2861  */
2862 void
2863 dbus_connection_free_preallocated_send (DBusConnection       *connection,
2864                                         DBusPreallocatedSend *preallocated)
2865 {
2866   _dbus_return_if_fail (connection != NULL);
2867   _dbus_return_if_fail (preallocated != NULL);
2868   _dbus_return_if_fail (connection == preallocated->connection);
2869
2870   _dbus_list_free_link (preallocated->queue_link);
2871   _dbus_counter_unref (preallocated->counter_link->data);
2872   _dbus_list_free_link (preallocated->counter_link);
2873   dbus_free (preallocated);
2874 }
2875
2876 /**
2877  * Sends a message using preallocated resources. This function cannot fail.
2878  * It works identically to dbus_connection_send() in other respects.
2879  * Preallocated resources comes from dbus_connection_preallocate_send().
2880  * This function "consumes" the preallocated resources, they need not
2881  * be freed separately.
2882  *
2883  * @param connection the connection
2884  * @param preallocated the preallocated resources
2885  * @param message the message to send
2886  * @param client_serial return location for client serial assigned to the message
2887  */
2888 void
2889 dbus_connection_send_preallocated (DBusConnection       *connection,
2890                                    DBusPreallocatedSend *preallocated,
2891                                    DBusMessage          *message,
2892                                    dbus_uint32_t        *client_serial)
2893 {
2894   _dbus_return_if_fail (connection != NULL);
2895   _dbus_return_if_fail (preallocated != NULL);
2896   _dbus_return_if_fail (message != NULL);
2897   _dbus_return_if_fail (preallocated->connection == connection);
2898   _dbus_return_if_fail (dbus_message_get_type (message) != DBUS_MESSAGE_TYPE_METHOD_CALL ||
2899                         dbus_message_get_member (message) != NULL);
2900   _dbus_return_if_fail (dbus_message_get_type (message) != DBUS_MESSAGE_TYPE_SIGNAL ||
2901                         (dbus_message_get_interface (message) != NULL &&
2902                          dbus_message_get_member (message) != NULL));
2903
2904   CONNECTION_LOCK (connection);
2905   _dbus_connection_send_preallocated_and_unlock (connection,
2906                                                  preallocated,
2907                                                  message, client_serial);
2908 }
2909
2910 static dbus_bool_t
2911 _dbus_connection_send_unlocked_no_update (DBusConnection *connection,
2912                                           DBusMessage    *message,
2913                                           dbus_uint32_t  *client_serial)
2914 {
2915   DBusPreallocatedSend *preallocated;
2916
2917   _dbus_assert (connection != NULL);
2918   _dbus_assert (message != NULL);
2919
2920   preallocated = _dbus_connection_preallocate_send_unlocked (connection);
2921   if (preallocated == NULL)
2922     return FALSE;
2923
2924   _dbus_connection_send_preallocated_unlocked_no_update (connection,
2925                                                          preallocated,
2926                                                          message,
2927                                                          client_serial);
2928   return TRUE;
2929 }
2930
2931 /**
2932  * Adds a message to the outgoing message queue. Does not block to
2933  * write the message to the network; that happens asynchronously. To
2934  * force the message to be written, call dbus_connection_flush().
2935  * Because this only queues the message, the only reason it can
2936  * fail is lack of memory. Even if the connection is disconnected,
2937  * no error will be returned.
2938  *
2939  * If the function fails due to lack of memory, it returns #FALSE.
2940  * The function will never fail for other reasons; even if the
2941  * connection is disconnected, you can queue an outgoing message,
2942  * though obviously it won't be sent.
2943  *
2944  * The message serial is used by the remote application to send a
2945  * reply; see dbus_message_get_serial() or the D-Bus specification.
2946  *
2947  * @param connection the connection.
2948  * @param message the message to write.
2949  * @param serial return location for message serial, or #NULL if you don't care
2950  * @returns #TRUE on success.
2951  */
2952 dbus_bool_t
2953 dbus_connection_send (DBusConnection *connection,
2954                       DBusMessage    *message,
2955                       dbus_uint32_t  *serial)
2956 {
2957   _dbus_return_val_if_fail (connection != NULL, FALSE);
2958   _dbus_return_val_if_fail (message != NULL, FALSE);
2959
2960   CONNECTION_LOCK (connection);
2961
2962   return _dbus_connection_send_and_unlock (connection,
2963                                            message,
2964                                            serial);
2965 }
2966
2967 static dbus_bool_t
2968 reply_handler_timeout (void *data)
2969 {
2970   DBusConnection *connection;
2971   DBusDispatchStatus status;
2972   DBusPendingCall *pending = data;
2973
2974   connection = _dbus_pending_call_get_connection_and_lock (pending);
2975
2976   _dbus_pending_call_queue_timeout_error_unlocked (pending,
2977                                                    connection);
2978   _dbus_connection_remove_timeout_unlocked (connection,
2979                                             _dbus_pending_call_get_timeout_unlocked (pending));
2980   _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
2981
2982   _dbus_verbose ("%s middle\n", _DBUS_FUNCTION_NAME);
2983   status = _dbus_connection_get_dispatch_status_unlocked (connection);
2984
2985   /* Unlocks, and calls out to user code */
2986   _dbus_connection_update_dispatch_status_and_unlock (connection, status);
2987
2988   return TRUE;
2989 }
2990
2991 /**
2992  * Queues a message to send, as with dbus_connection_send(),
2993  * but also returns a #DBusPendingCall used to receive a reply to the
2994  * message. If no reply is received in the given timeout_milliseconds,
2995  * this function expires the pending reply and generates a synthetic
2996  * error reply (generated in-process, not by the remote application)
2997  * indicating that a timeout occurred.
2998  *
2999  * A #DBusPendingCall will see a reply message before any filters or
3000  * registered object path handlers. See dbus_connection_dispatch() for
3001  * details on when handlers are run.
3002  *
3003  * A #DBusPendingCall will always see exactly one reply message,
3004  * unless it's cancelled with dbus_pending_call_cancel().
3005  *
3006  * If #NULL is passed for the pending_return, the #DBusPendingCall
3007  * will still be generated internally, and used to track
3008  * the message reply timeout. This means a timeout error will
3009  * occur if no reply arrives, unlike with dbus_connection_send().
3010  *
3011  * If -1 is passed for the timeout, a sane default timeout is used. -1
3012  * is typically the best value for the timeout for this reason, unless
3013  * you want a very short or very long timeout.  There is no way to
3014  * avoid a timeout entirely, other than passing INT_MAX for the
3015  * timeout to mean "very long timeout." libdbus clamps an INT_MAX
3016  * timeout down to a few hours timeout though.
3017  *
3018  * @warning if the connection is disconnected, the #DBusPendingCall
3019  * will be set to #NULL, so be careful with this.
3020  *
3021  * @param connection the connection
3022  * @param message the message to send
3023  * @param pending_return return location for a #DBusPendingCall object, or #NULL if connection is disconnected
3024  * @param timeout_milliseconds timeout in milliseconds or -1 for default
3025  * @returns #FALSE if no memory, #TRUE otherwise.
3026  *
3027  */
3028 dbus_bool_t
3029 dbus_connection_send_with_reply (DBusConnection     *connection,
3030                                  DBusMessage        *message,
3031                                  DBusPendingCall   **pending_return,
3032                                  int                 timeout_milliseconds)
3033 {
3034   DBusPendingCall *pending;
3035   dbus_int32_t serial = -1;
3036   DBusDispatchStatus status;
3037
3038   _dbus_return_val_if_fail (connection != NULL, FALSE);
3039   _dbus_return_val_if_fail (message != NULL, FALSE);
3040   _dbus_return_val_if_fail (timeout_milliseconds >= 0 || timeout_milliseconds == -1, FALSE);
3041
3042   if (pending_return)
3043     *pending_return = NULL;
3044
3045   CONNECTION_LOCK (connection);
3046
3047    if (!_dbus_connection_get_is_connected_unlocked (connection))
3048     {
3049       CONNECTION_UNLOCK (connection);
3050
3051       *pending_return = NULL;
3052
3053       return TRUE;
3054     }
3055
3056   pending = _dbus_pending_call_new_unlocked (connection,
3057                                              timeout_milliseconds,
3058                                              reply_handler_timeout);
3059
3060   if (pending == NULL)
3061     {
3062       CONNECTION_UNLOCK (connection);
3063       return FALSE;
3064     }
3065
3066   /* Assign a serial to the message */
3067   serial = dbus_message_get_serial (message);
3068   if (serial == 0)
3069     {
3070       serial = _dbus_connection_get_next_client_serial (connection);
3071       _dbus_message_set_serial (message, serial);
3072     }
3073
3074   if (!_dbus_pending_call_set_timeout_error_unlocked (pending, message, serial))
3075     goto error;
3076
3077   /* Insert the serial in the pending replies hash;
3078    * hash takes a refcount on DBusPendingCall.
3079    * Also, add the timeout.
3080    */
3081   if (!_dbus_connection_attach_pending_call_unlocked (connection,
3082                                                       pending))
3083     goto error;
3084
3085   if (!_dbus_connection_send_unlocked_no_update (connection, message, NULL))
3086     {
3087       _dbus_connection_detach_pending_call_and_unlock (connection,
3088                                                        pending);
3089       goto error_unlocked;
3090     }
3091
3092   if (pending_return)
3093     *pending_return = pending; /* hand off refcount */
3094   else
3095     {
3096       _dbus_connection_detach_pending_call_unlocked (connection, pending);
3097       /* we still have a ref to the pending call in this case, we unref
3098        * after unlocking, below
3099        */
3100     }
3101
3102   status = _dbus_connection_get_dispatch_status_unlocked (connection);
3103
3104   /* this calls out to user code */
3105   _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3106
3107   if (pending_return == NULL)
3108     dbus_pending_call_unref (pending);
3109
3110   return TRUE;
3111
3112  error:
3113   CONNECTION_UNLOCK (connection);
3114  error_unlocked:
3115   dbus_pending_call_unref (pending);
3116   return FALSE;
3117 }
3118
3119 /**
3120  * Sends a message and blocks a certain time period while waiting for
3121  * a reply.  This function does not reenter the main loop,
3122  * i.e. messages other than the reply are queued up but not
3123  * processed. This function is used to invoke method calls on a
3124  * remote object.
3125  *
3126  * If a normal reply is received, it is returned, and removed from the
3127  * incoming message queue. If it is not received, #NULL is returned
3128  * and the error is set to #DBUS_ERROR_NO_REPLY.  If an error reply is
3129  * received, it is converted to a #DBusError and returned as an error,
3130  * then the reply message is deleted and #NULL is returned. If
3131  * something else goes wrong, result is set to whatever is
3132  * appropriate, such as #DBUS_ERROR_NO_MEMORY or
3133  * #DBUS_ERROR_DISCONNECTED.
3134  *
3135  * @warning While this function blocks the calling thread will not be
3136  * processing the incoming message queue. This means you can end up
3137  * deadlocked if the application you're talking to needs you to reply
3138  * to a method. To solve this, either avoid the situation, block in a
3139  * separate thread from the main connection-dispatching thread, or use
3140  * dbus_pending_call_set_notify() to avoid blocking.
3141  *
3142  * @param connection the connection
3143  * @param message the message to send
3144  * @param timeout_milliseconds timeout in milliseconds or -1 for default
3145  * @param error return location for error message
3146  * @returns the message that is the reply or #NULL with an error code if the
3147  * function fails.
3148  */
3149 DBusMessage*
3150 dbus_connection_send_with_reply_and_block (DBusConnection     *connection,
3151                                            DBusMessage        *message,
3152                                            int                 timeout_milliseconds,
3153                                            DBusError          *error)
3154 {
3155   DBusMessage *reply;
3156   DBusPendingCall *pending;
3157
3158   _dbus_return_val_if_fail (connection != NULL, NULL);
3159   _dbus_return_val_if_fail (message != NULL, NULL);
3160   _dbus_return_val_if_fail (timeout_milliseconds >= 0 || timeout_milliseconds == -1, NULL);
3161   _dbus_return_val_if_error_is_set (error, NULL);
3162
3163   if (!dbus_connection_send_with_reply (connection, message,
3164                                         &pending, timeout_milliseconds))
3165     {
3166       _DBUS_SET_OOM (error);
3167       return NULL;
3168     }
3169
3170   if (pending == NULL)
3171     {
3172       dbus_set_error (error, DBUS_ERROR_DISCONNECTED, "Connection is closed");
3173       return NULL;
3174     }
3175
3176   dbus_pending_call_block (pending);
3177
3178   reply = dbus_pending_call_steal_reply (pending);
3179   dbus_pending_call_unref (pending);
3180
3181   /* call_complete_and_unlock() called from pending_call_block() should
3182    * always fill this in.
3183    */
3184   _dbus_assert (reply != NULL);
3185
3186    if (dbus_set_error_from_message (error, reply))
3187     {
3188       dbus_message_unref (reply);
3189       return NULL;
3190     }
3191   else
3192     return reply;
3193 }
3194
3195 /**
3196  * Blocks until the outgoing message queue is empty.
3197  * Assumes connection lock already held.
3198  *
3199  * If you call this, you MUST call update_dispatch_status afterword...
3200  *
3201  * @param connection the connection.
3202  */
3203 DBusDispatchStatus
3204 _dbus_connection_flush_unlocked (DBusConnection *connection)
3205 {
3206   /* We have to specify DBUS_ITERATION_DO_READING here because
3207    * otherwise we could have two apps deadlock if they are both doing
3208    * a flush(), and the kernel buffers fill up. This could change the
3209    * dispatch status.
3210    */
3211   DBusDispatchStatus status;
3212
3213   HAVE_LOCK_CHECK (connection);
3214
3215   while (connection->n_outgoing > 0 &&
3216          _dbus_connection_get_is_connected_unlocked (connection))
3217     {
3218       _dbus_verbose ("doing iteration in %s\n", _DBUS_FUNCTION_NAME);
3219       HAVE_LOCK_CHECK (connection);
3220       _dbus_connection_do_iteration_unlocked (connection,
3221                                               DBUS_ITERATION_DO_READING |
3222                                               DBUS_ITERATION_DO_WRITING |
3223                                               DBUS_ITERATION_BLOCK,
3224                                               -1);
3225     }
3226
3227   HAVE_LOCK_CHECK (connection);
3228   _dbus_verbose ("%s middle\n", _DBUS_FUNCTION_NAME);
3229   status = _dbus_connection_get_dispatch_status_unlocked (connection);
3230
3231   HAVE_LOCK_CHECK (connection);
3232   return status;
3233 }
3234
3235 /**
3236  * Blocks until the outgoing message queue is empty.
3237  *
3238  * @param connection the connection.
3239  */
3240 void
3241 dbus_connection_flush (DBusConnection *connection)
3242 {
3243   /* We have to specify DBUS_ITERATION_DO_READING here because
3244    * otherwise we could have two apps deadlock if they are both doing
3245    * a flush(), and the kernel buffers fill up. This could change the
3246    * dispatch status.
3247    */
3248   DBusDispatchStatus status;
3249
3250   _dbus_return_if_fail (connection != NULL);
3251
3252   CONNECTION_LOCK (connection);
3253
3254   status = _dbus_connection_flush_unlocked (connection);
3255
3256   HAVE_LOCK_CHECK (connection);
3257   /* Unlocks and calls out to user code */
3258   _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3259
3260   _dbus_verbose ("%s end\n", _DBUS_FUNCTION_NAME);
3261 }
3262
3263 /**
3264  * This function implements dbus_connection_read_write_dispatch() and
3265  * dbus_connection_read_write() (they pass a different value for the
3266  * dispatch parameter).
3267  *
3268  * @param connection the connection
3269  * @param timeout_milliseconds max time to block or -1 for infinite
3270  * @param dispatch dispatch new messages or leave them on the incoming queue
3271  * @returns #TRUE if the disconnect message has not been processed
3272  */
3273 static dbus_bool_t
3274 _dbus_connection_read_write_dispatch (DBusConnection *connection,
3275                                      int             timeout_milliseconds,
3276                                      dbus_bool_t     dispatch)
3277 {
3278   DBusDispatchStatus dstatus;
3279   dbus_bool_t no_progress_possible;
3280
3281   dstatus = dbus_connection_get_dispatch_status (connection);
3282
3283   if (dispatch && dstatus == DBUS_DISPATCH_DATA_REMAINS)
3284     {
3285       _dbus_verbose ("doing dispatch in %s\n", _DBUS_FUNCTION_NAME);
3286       dbus_connection_dispatch (connection);
3287       CONNECTION_LOCK (connection);
3288     }
3289   else if (dstatus == DBUS_DISPATCH_NEED_MEMORY)
3290     {
3291       _dbus_verbose ("pausing for memory in %s\n", _DBUS_FUNCTION_NAME);
3292       _dbus_memory_pause_based_on_timeout (timeout_milliseconds);
3293       CONNECTION_LOCK (connection);
3294     }
3295   else
3296     {
3297       CONNECTION_LOCK (connection);
3298       if (_dbus_connection_get_is_connected_unlocked (connection))
3299         {
3300           _dbus_verbose ("doing iteration in %s\n", _DBUS_FUNCTION_NAME);
3301           _dbus_connection_do_iteration_unlocked (connection,
3302                                                   DBUS_ITERATION_DO_READING |
3303                                                   DBUS_ITERATION_DO_WRITING |
3304                                                   DBUS_ITERATION_BLOCK,
3305                                                   timeout_milliseconds);
3306         }
3307     }
3308
3309   HAVE_LOCK_CHECK (connection);
3310   /* If we can dispatch, we can make progress until the Disconnected message
3311    * has been processed; if we can only read/write, we can make progress
3312    * as long as the transport is open.
3313    */
3314   if (dispatch)
3315     no_progress_possible = connection->n_incoming == 0 &&
3316       connection->disconnect_message_link == NULL;
3317   else
3318     no_progress_possible = _dbus_connection_get_is_connected_unlocked (connection);
3319   CONNECTION_UNLOCK (connection);
3320   return !no_progress_possible; /* TRUE if we can make more progress */
3321 }
3322
3323
3324 /**
3325  * This function is intended for use with applications that don't want
3326  * to write a main loop and deal with #DBusWatch and #DBusTimeout. An
3327  * example usage would be:
3328  *
3329  * @code
3330  *   while (dbus_connection_read_write_dispatch (connection, -1))
3331  *     ; // empty loop body
3332  * @endcode
3333  *
3334  * In this usage you would normally have set up a filter function to look
3335  * at each message as it is dispatched. The loop terminates when the last
3336  * message from the connection (the disconnected signal) is processed.
3337  *
3338  * If there are messages to dispatch, this function will
3339  * dbus_connection_dispatch() once, and return. If there are no
3340  * messages to dispatch, this function will block until it can read or
3341  * write, then read or write, then return.
3342  *
3343  * The way to think of this function is that it either makes some sort
3344  * of progress, or it blocks. Note that, while it is blocked on I/O, it
3345  * cannot be interrupted (even by other threads), which makes this function
3346  * unsuitable for applications that do more than just react to received
3347  * messages.
3348  *
3349  * The return value indicates whether the disconnect message has been
3350  * processed, NOT whether the connection is connected. This is
3351  * important because even after disconnecting, you want to process any
3352  * messages you received prior to the disconnect.
3353  *
3354  * @param connection the connection
3355  * @param timeout_milliseconds max time to block or -1 for infinite
3356  * @returns #TRUE if the disconnect message has not been processed
3357  */
3358 dbus_bool_t
3359 dbus_connection_read_write_dispatch (DBusConnection *connection,
3360                                      int             timeout_milliseconds)
3361 {
3362   _dbus_return_val_if_fail (connection != NULL, FALSE);
3363   _dbus_return_val_if_fail (timeout_milliseconds >= 0 || timeout_milliseconds == -1, FALSE);
3364    return _dbus_connection_read_write_dispatch(connection, timeout_milliseconds, TRUE);
3365 }
3366
3367 /**
3368  * This function is intended for use with applications that don't want to
3369  * write a main loop and deal with #DBusWatch and #DBusTimeout. See also
3370  * dbus_connection_read_write_dispatch().
3371  *
3372  * As long as the connection is open, this function will block until it can
3373  * read or write, then read or write, then return #TRUE.
3374  *
3375  * If the connection is closed, the function returns #FALSE.
3376  *
3377  * The return value indicates whether reading or writing is still
3378  * possible, i.e. whether the connection is connected.
3379  *
3380  * Note that even after disconnection, messages may remain in the
3381  * incoming queue that need to be
3382  * processed. dbus_connection_read_write_dispatch() dispatches
3383  * incoming messages for you; with dbus_connection_read_write() you
3384  * have to arrange to drain the incoming queue yourself.
3385  *
3386  * @param connection the connection
3387  * @param timeout_milliseconds max time to block or -1 for infinite
3388  * @returns #TRUE if still connected
3389  */
3390 dbus_bool_t
3391 dbus_connection_read_write (DBusConnection *connection,
3392                             int             timeout_milliseconds)
3393 {
3394   _dbus_return_val_if_fail (connection != NULL, FALSE);
3395   _dbus_return_val_if_fail (timeout_milliseconds >= 0 || timeout_milliseconds == -1, FALSE);
3396    return _dbus_connection_read_write_dispatch(connection, timeout_milliseconds, FALSE);
3397 }
3398
3399 /* We need to call this anytime we pop the head of the queue, and then
3400  * update_dispatch_status_and_unlock needs to be called afterward
3401  * which will "process" the disconnected message and set
3402  * disconnected_message_processed.
3403  */
3404 static void
3405 check_disconnected_message_arrived_unlocked (DBusConnection *connection,
3406                                              DBusMessage    *head_of_queue)
3407 {
3408   HAVE_LOCK_CHECK (connection);
3409
3410   /* checking that the link is NULL is an optimization to avoid the is_signal call */
3411   if (connection->disconnect_message_link == NULL &&
3412       dbus_message_is_signal (head_of_queue,
3413                               DBUS_INTERFACE_LOCAL,
3414                               "Disconnected"))
3415     {
3416       connection->disconnected_message_arrived = TRUE;
3417     }
3418 }
3419
3420 /**
3421  * Returns the first-received message from the incoming message queue,
3422  * leaving it in the queue. If the queue is empty, returns #NULL.
3423  *
3424  * The caller does not own a reference to the returned message, and
3425  * must either return it using dbus_connection_return_message() or
3426  * keep it after calling dbus_connection_steal_borrowed_message(). No
3427  * one can get at the message while its borrowed, so return it as
3428  * quickly as possible and don't keep a reference to it after
3429  * returning it. If you need to keep the message, make a copy of it.
3430  *
3431  * dbus_connection_dispatch() will block if called while a borrowed
3432  * message is outstanding; only one piece of code can be playing with
3433  * the incoming queue at a time. This function will block if called
3434  * during a dbus_connection_dispatch().
3435  *
3436  * @param connection the connection.
3437  * @returns next message in the incoming queue.
3438  */
3439 DBusMessage*
3440 dbus_connection_borrow_message (DBusConnection *connection)
3441 {
3442   DBusDispatchStatus status;
3443   DBusMessage *message;
3444
3445   _dbus_return_val_if_fail (connection != NULL, NULL);
3446
3447   _dbus_verbose ("%s start\n", _DBUS_FUNCTION_NAME);
3448
3449   /* this is called for the side effect that it queues
3450    * up any messages from the transport
3451    */
3452   status = dbus_connection_get_dispatch_status (connection);
3453   if (status != DBUS_DISPATCH_DATA_REMAINS)
3454     return NULL;
3455
3456   CONNECTION_LOCK (connection);
3457
3458   _dbus_connection_acquire_dispatch (connection);
3459
3460   /* While a message is outstanding, the dispatch lock is held */
3461   _dbus_assert (connection->message_borrowed == NULL);
3462
3463   connection->message_borrowed = _dbus_list_get_first (&connection->incoming_messages);
3464
3465   message = connection->message_borrowed;
3466
3467   check_disconnected_message_arrived_unlocked (connection, message);
3468
3469   /* Note that we KEEP the dispatch lock until the message is returned */
3470   if (message == NULL)
3471     _dbus_connection_release_dispatch (connection);
3472
3473   CONNECTION_UNLOCK (connection);
3474
3475   /* We don't update dispatch status until it's returned or stolen */
3476
3477   return message;
3478 }
3479
3480 /**
3481  * Used to return a message after peeking at it using
3482  * dbus_connection_borrow_message(). Only called if
3483  * message from dbus_connection_borrow_message() was non-#NULL.
3484  *
3485  * @param connection the connection
3486  * @param message the message from dbus_connection_borrow_message()
3487  */
3488 void
3489 dbus_connection_return_message (DBusConnection *connection,
3490                                 DBusMessage    *message)
3491 {
3492   DBusDispatchStatus status;
3493
3494   _dbus_return_if_fail (connection != NULL);
3495   _dbus_return_if_fail (message != NULL);
3496   _dbus_return_if_fail (message == connection->message_borrowed);
3497   _dbus_return_if_fail (connection->dispatch_acquired);
3498
3499   CONNECTION_LOCK (connection);
3500
3501   _dbus_assert (message == connection->message_borrowed);
3502
3503   connection->message_borrowed = NULL;
3504
3505   _dbus_connection_release_dispatch (connection);
3506
3507   status = _dbus_connection_get_dispatch_status_unlocked (connection);
3508   _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3509 }
3510
3511 /**
3512  * Used to keep a message after peeking at it using
3513  * dbus_connection_borrow_message(). Before using this function, see
3514  * the caveats/warnings in the documentation for
3515  * dbus_connection_pop_message().
3516  *
3517  * @param connection the connection
3518  * @param message the message from dbus_connection_borrow_message()
3519  */
3520 void
3521 dbus_connection_steal_borrowed_message (DBusConnection *connection,
3522                                         DBusMessage    *message)
3523 {
3524   DBusMessage *pop_message;
3525   DBusDispatchStatus status;
3526
3527   _dbus_return_if_fail (connection != NULL);
3528   _dbus_return_if_fail (message != NULL);
3529   _dbus_return_if_fail (message == connection->message_borrowed);
3530   _dbus_return_if_fail (connection->dispatch_acquired);
3531
3532   CONNECTION_LOCK (connection);
3533
3534   _dbus_assert (message == connection->message_borrowed);
3535
3536   pop_message = _dbus_list_pop_first (&connection->incoming_messages);
3537   _dbus_assert (message == pop_message);
3538
3539   connection->n_incoming -= 1;
3540
3541   _dbus_verbose ("Incoming message %p stolen from queue, %d incoming\n",
3542                  message, connection->n_incoming);
3543
3544   connection->message_borrowed = NULL;
3545
3546   _dbus_connection_release_dispatch (connection);
3547
3548   status = _dbus_connection_get_dispatch_status_unlocked (connection);
3549   _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3550 }
3551
3552 /* See dbus_connection_pop_message, but requires the caller to own
3553  * the lock before calling. May drop the lock while running.
3554  */
3555 static DBusList*
3556 _dbus_connection_pop_message_link_unlocked (DBusConnection *connection)
3557 {
3558   HAVE_LOCK_CHECK (connection);
3559
3560   _dbus_assert (connection->message_borrowed == NULL);
3561
3562   if (connection->n_incoming > 0)
3563     {
3564       DBusList *link;
3565
3566       link = _dbus_list_pop_first_link (&connection->incoming_messages);
3567       connection->n_incoming -= 1;
3568
3569       _dbus_verbose ("Message %p (%d %s %s %s '%s') removed from incoming queue %p, %d incoming\n",
3570                      link->data,
3571                      dbus_message_get_type (link->data),
3572                      dbus_message_get_path (link->data) ?
3573                      dbus_message_get_path (link->data) :
3574                      "no path",
3575                      dbus_message_get_interface (link->data) ?
3576                      dbus_message_get_interface (link->data) :
3577                      "no interface",
3578                      dbus_message_get_member (link->data) ?
3579                      dbus_message_get_member (link->data) :
3580                      "no member",
3581                      dbus_message_get_signature (link->data),
3582                      connection, connection->n_incoming);
3583
3584       check_disconnected_message_arrived_unlocked (connection, link->data);
3585
3586       return link;
3587     }
3588   else
3589     return NULL;
3590 }
3591
3592 /* See dbus_connection_pop_message, but requires the caller to own
3593  * the lock before calling. May drop the lock while running.
3594  */
3595 static DBusMessage*
3596 _dbus_connection_pop_message_unlocked (DBusConnection *connection)
3597 {
3598   DBusList *link;
3599
3600   HAVE_LOCK_CHECK (connection);
3601
3602   link = _dbus_connection_pop_message_link_unlocked (connection);
3603
3604   if (link != NULL)
3605     {
3606       DBusMessage *message;
3607
3608       message = link->data;
3609
3610       _dbus_list_free_link (link);
3611
3612       return message;
3613     }
3614   else
3615     return NULL;
3616 }
3617
3618 static void
3619 _dbus_connection_putback_message_link_unlocked (DBusConnection *connection,
3620                                                 DBusList       *message_link)
3621 {
3622   HAVE_LOCK_CHECK (connection);
3623
3624   _dbus_assert (message_link != NULL);
3625   /* You can't borrow a message while a link is outstanding */
3626   _dbus_assert (connection->message_borrowed == NULL);
3627   /* We had to have the dispatch lock across the pop/putback */
3628   _dbus_assert (connection->dispatch_acquired);
3629
3630   _dbus_list_prepend_link (&connection->incoming_messages,
3631                            message_link);
3632   connection->n_incoming += 1;
3633
3634   _dbus_verbose ("Message %p (%d %s %s '%s') put back into queue %p, %d incoming\n",
3635                  message_link->data,
3636                  dbus_message_get_type (message_link->data),
3637                  dbus_message_get_interface (message_link->data) ?
3638                  dbus_message_get_interface (message_link->data) :
3639                  "no interface",
3640                  dbus_message_get_member (message_link->data) ?
3641                  dbus_message_get_member (message_link->data) :
3642                  "no member",
3643                  dbus_message_get_signature (message_link->data),
3644                  connection, connection->n_incoming);
3645 }
3646
3647 /**
3648  * Returns the first-received message from the incoming message queue,
3649  * removing it from the queue. The caller owns a reference to the
3650  * returned message. If the queue is empty, returns #NULL.
3651  *
3652  * This function bypasses any message handlers that are registered,
3653  * and so using it is usually wrong. Instead, let the main loop invoke
3654  * dbus_connection_dispatch(). Popping messages manually is only
3655  * useful in very simple programs that don't share a #DBusConnection
3656  * with any libraries or other modules.
3657  *
3658  * There is a lock that covers all ways of accessing the incoming message
3659  * queue, so dbus_connection_dispatch(), dbus_connection_pop_message(),
3660  * dbus_connection_borrow_message(), etc. will all block while one of the others
3661  * in the group is running.
3662  *
3663  * @param connection the connection.
3664  * @returns next message in the incoming queue.
3665  */
3666 DBusMessage*
3667 dbus_connection_pop_message (DBusConnection *connection)
3668 {
3669   DBusMessage *message;
3670   DBusDispatchStatus status;
3671
3672   _dbus_verbose ("%s start\n", _DBUS_FUNCTION_NAME);
3673
3674   /* this is called for the side effect that it queues
3675    * up any messages from the transport
3676    */
3677   status = dbus_connection_get_dispatch_status (connection);
3678   if (status != DBUS_DISPATCH_DATA_REMAINS)
3679     return NULL;
3680
3681   CONNECTION_LOCK (connection);
3682   _dbus_connection_acquire_dispatch (connection);
3683   HAVE_LOCK_CHECK (connection);
3684
3685   message = _dbus_connection_pop_message_unlocked (connection);
3686
3687   _dbus_verbose ("Returning popped message %p\n", message);
3688
3689   _dbus_connection_release_dispatch (connection);
3690
3691   status = _dbus_connection_get_dispatch_status_unlocked (connection);
3692   _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3693
3694   return message;
3695 }
3696
3697 /**
3698  * Acquire the dispatcher. This is a separate lock so the main
3699  * connection lock can be dropped to call out to application dispatch
3700  * handlers.
3701  *
3702  * @param connection the connection.
3703  */
3704 static void
3705 _dbus_connection_acquire_dispatch (DBusConnection *connection)
3706 {
3707   HAVE_LOCK_CHECK (connection);
3708
3709   _dbus_connection_ref_unlocked (connection);
3710   CONNECTION_UNLOCK (connection);
3711
3712   _dbus_verbose ("%s locking dispatch_mutex\n", _DBUS_FUNCTION_NAME);
3713   _dbus_mutex_lock (connection->dispatch_mutex);
3714
3715   while (connection->dispatch_acquired)
3716     {
3717       _dbus_verbose ("%s waiting for dispatch to be acquirable\n", _DBUS_FUNCTION_NAME);
3718       _dbus_condvar_wait (connection->dispatch_cond,
3719                           connection->dispatch_mutex);
3720     }
3721
3722   _dbus_assert (!connection->dispatch_acquired);
3723
3724   connection->dispatch_acquired = TRUE;
3725
3726   _dbus_verbose ("%s unlocking dispatch_mutex\n", _DBUS_FUNCTION_NAME);
3727   _dbus_mutex_unlock (connection->dispatch_mutex);
3728
3729   CONNECTION_LOCK (connection);
3730   _dbus_connection_unref_unlocked (connection);
3731 }
3732
3733 /**
3734  * Release the dispatcher when you're done with it. Only call
3735  * after you've acquired the dispatcher. Wakes up at most one
3736  * thread currently waiting to acquire the dispatcher.
3737  *
3738  * @param connection the connection.
3739  */
3740 static void
3741 _dbus_connection_release_dispatch (DBusConnection *connection)
3742 {
3743   HAVE_LOCK_CHECK (connection);
3744
3745   _dbus_verbose ("%s locking dispatch_mutex\n", _DBUS_FUNCTION_NAME);
3746   _dbus_mutex_lock (connection->dispatch_mutex);
3747
3748   _dbus_assert (connection->dispatch_acquired);
3749
3750   connection->dispatch_acquired = FALSE;
3751   _dbus_condvar_wake_one (connection->dispatch_cond);
3752
3753   _dbus_verbose ("%s unlocking dispatch_mutex\n", _DBUS_FUNCTION_NAME);
3754   _dbus_mutex_unlock (connection->dispatch_mutex);
3755 }
3756
3757 static void
3758 _dbus_connection_failed_pop (DBusConnection *connection,
3759                              DBusList       *message_link)
3760 {
3761   _dbus_list_prepend_link (&connection->incoming_messages,
3762                            message_link);
3763   connection->n_incoming += 1;
3764 }
3765
3766 /* Note this may be called multiple times since we don't track whether we already did it */
3767 static void
3768 notify_disconnected_unlocked (DBusConnection *connection)
3769 {
3770   HAVE_LOCK_CHECK (connection);
3771
3772   /* Set the weakref in dbus-bus.c to NULL, so nobody will get a disconnected
3773    * connection from dbus_bus_get(). We make the same guarantee for
3774    * dbus_connection_open() but in a different way since we don't want to
3775    * unref right here; we instead check for connectedness before returning
3776    * the connection from the hash.
3777    */
3778   _dbus_bus_notify_shared_connection_disconnected_unlocked (connection);
3779
3780   /* Dump the outgoing queue, we aren't going to be able to
3781    * send it now, and we'd like accessors like
3782    * dbus_connection_get_outgoing_size() to be accurate.
3783    */
3784   if (connection->n_outgoing > 0)
3785     {
3786       DBusList *link;
3787
3788       _dbus_verbose ("Dropping %d outgoing messages since we're disconnected\n",
3789                      connection->n_outgoing);
3790
3791       while ((link = _dbus_list_get_last_link (&connection->outgoing_messages)))
3792         {
3793           _dbus_connection_message_sent (connection, link->data);
3794         }
3795     }
3796 }
3797
3798 /* Note this may be called multiple times since we don't track whether we already did it */
3799 static DBusDispatchStatus
3800 notify_disconnected_and_dispatch_complete_unlocked (DBusConnection *connection)
3801 {
3802   HAVE_LOCK_CHECK (connection);
3803
3804   if (connection->disconnect_message_link != NULL)
3805     {
3806       _dbus_verbose ("Sending disconnect message from %s\n",
3807                      _DBUS_FUNCTION_NAME);
3808
3809       /* If we have pending calls, queue their timeouts - we want the Disconnected
3810        * to be the last message, after these timeouts.
3811        */
3812       connection_timeout_and_complete_all_pending_calls_unlocked (connection);
3813
3814       /* We haven't sent the disconnect message already,
3815        * and all real messages have been queued up.
3816        */
3817       _dbus_connection_queue_synthesized_message_link (connection,
3818                                                        connection->disconnect_message_link);
3819       connection->disconnect_message_link = NULL;
3820
3821       return DBUS_DISPATCH_DATA_REMAINS;
3822     }
3823
3824   return DBUS_DISPATCH_COMPLETE;
3825 }
3826
3827 static DBusDispatchStatus
3828 _dbus_connection_get_dispatch_status_unlocked (DBusConnection *connection)
3829 {
3830   HAVE_LOCK_CHECK (connection);
3831
3832   if (connection->n_incoming > 0)
3833     return DBUS_DISPATCH_DATA_REMAINS;
3834   else if (!_dbus_transport_queue_messages (connection->transport))
3835     return DBUS_DISPATCH_NEED_MEMORY;
3836   else
3837     {
3838       DBusDispatchStatus status;
3839       dbus_bool_t is_connected;
3840
3841       status = _dbus_transport_get_dispatch_status (connection->transport);
3842       is_connected = _dbus_transport_get_is_connected (connection->transport);
3843
3844       _dbus_verbose ("dispatch status = %s is_connected = %d\n",
3845                      DISPATCH_STATUS_NAME (status), is_connected);
3846
3847       if (!is_connected)
3848         {
3849           /* It's possible this would be better done by having an explicit
3850            * notification from _dbus_transport_disconnect() that would
3851            * synchronously do this, instead of waiting for the next dispatch
3852            * status check. However, probably not good to change until it causes
3853            * a problem.
3854            */
3855           notify_disconnected_unlocked (connection);
3856
3857           /* I'm not sure this is needed; the idea is that we want to
3858            * queue the Disconnected only after we've read all the
3859            * messages, but if we're disconnected maybe we are guaranteed
3860            * to have read them all ?
3861            */
3862           if (status == DBUS_DISPATCH_COMPLETE)
3863             status = notify_disconnected_and_dispatch_complete_unlocked (connection);
3864         }
3865
3866       if (status != DBUS_DISPATCH_COMPLETE)
3867         return status;
3868       else if (connection->n_incoming > 0)
3869         return DBUS_DISPATCH_DATA_REMAINS;
3870       else
3871         return DBUS_DISPATCH_COMPLETE;
3872     }
3873 }
3874
3875 static void
3876 _dbus_connection_update_dispatch_status_and_unlock (DBusConnection    *connection,
3877                                                     DBusDispatchStatus new_status)
3878 {
3879   dbus_bool_t changed;
3880   DBusDispatchStatusFunction function;
3881   void *data;
3882
3883   HAVE_LOCK_CHECK (connection);
3884
3885   _dbus_connection_ref_unlocked (connection);
3886
3887   changed = new_status != connection->last_dispatch_status;
3888
3889   connection->last_dispatch_status = new_status;
3890
3891   function = connection->dispatch_status_function;
3892   data = connection->dispatch_status_data;
3893
3894   if (connection->disconnected_message_arrived &&
3895       !connection->disconnected_message_processed)
3896     {
3897       connection->disconnected_message_processed = TRUE;
3898
3899       /* this does an unref, but we have a ref
3900        * so we should not run the finalizer here
3901        * inside the lock.
3902        */
3903       connection_forget_shared_unlocked (connection);
3904
3905       if (connection->exit_on_disconnect)
3906         {
3907           CONNECTION_UNLOCK (connection);
3908
3909           _dbus_verbose ("Exiting on Disconnected signal\n");
3910           _dbus_exit (1);
3911           _dbus_assert_not_reached ("Call to exit() returned");
3912         }
3913     }
3914
3915   /* We drop the lock */
3916   CONNECTION_UNLOCK (connection);
3917
3918   if (changed && function)
3919     {
3920       _dbus_verbose ("Notifying of change to dispatch status of %p now %d (%s)\n",
3921                      connection, new_status,
3922                      DISPATCH_STATUS_NAME (new_status));
3923       (* function) (connection, new_status, data);
3924     }
3925
3926   dbus_connection_unref (connection);
3927 }
3928
3929 /**
3930  * Gets the current state of the incoming message queue.
3931  * #DBUS_DISPATCH_DATA_REMAINS indicates that the message queue
3932  * may contain messages. #DBUS_DISPATCH_COMPLETE indicates that the
3933  * incoming queue is empty. #DBUS_DISPATCH_NEED_MEMORY indicates that
3934  * there could be data, but we can't know for sure without more
3935  * memory.
3936  *
3937  * To process the incoming message queue, use dbus_connection_dispatch()
3938  * or (in rare cases) dbus_connection_pop_message().
3939  *
3940  * Note, #DBUS_DISPATCH_DATA_REMAINS really means that either we
3941  * have messages in the queue, or we have raw bytes buffered up
3942  * that need to be parsed. When these bytes are parsed, they
3943  * may not add up to an entire message. Thus, it's possible
3944  * to see a status of #DBUS_DISPATCH_DATA_REMAINS but not
3945  * have a message yet.
3946  *
3947  * In particular this happens on initial connection, because all sorts
3948  * of authentication protocol stuff has to be parsed before the
3949  * first message arrives.
3950  *
3951  * @param connection the connection.
3952  * @returns current dispatch status
3953  */
3954 DBusDispatchStatus
3955 dbus_connection_get_dispatch_status (DBusConnection *connection)
3956 {
3957   DBusDispatchStatus status;
3958
3959   _dbus_return_val_if_fail (connection != NULL, DBUS_DISPATCH_COMPLETE);
3960
3961   _dbus_verbose ("%s start\n", _DBUS_FUNCTION_NAME);
3962
3963   CONNECTION_LOCK (connection);
3964
3965   status = _dbus_connection_get_dispatch_status_unlocked (connection);
3966
3967   CONNECTION_UNLOCK (connection);
3968
3969   return status;
3970 }
3971
3972 /**
3973  * Filter funtion for handling the Peer standard interface.
3974  */
3975 static DBusHandlerResult
3976 _dbus_connection_peer_filter_unlocked_no_update (DBusConnection *connection,
3977                                                  DBusMessage    *message)
3978 {
3979   if (connection->route_peer_messages && dbus_message_get_destination (message) != NULL)
3980     {
3981       /* This means we're letting the bus route this message */
3982       return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
3983     }
3984   else if (dbus_message_is_method_call (message,
3985                                         DBUS_INTERFACE_PEER,
3986                                         "Ping"))
3987     {
3988       DBusMessage *ret;
3989       dbus_bool_t sent;
3990
3991       ret = dbus_message_new_method_return (message);
3992       if (ret == NULL)
3993         return DBUS_HANDLER_RESULT_NEED_MEMORY;
3994
3995       sent = _dbus_connection_send_unlocked_no_update (connection, ret, NULL);
3996
3997       dbus_message_unref (ret);
3998
3999       if (!sent)
4000         return DBUS_HANDLER_RESULT_NEED_MEMORY;
4001
4002       return DBUS_HANDLER_RESULT_HANDLED;
4003     }
4004   else if (dbus_message_is_method_call (message,
4005                                         DBUS_INTERFACE_PEER,
4006                                         "GetMachineId"))
4007     {
4008       DBusMessage *ret;
4009       dbus_bool_t sent;
4010       DBusString uuid;
4011
4012       ret = dbus_message_new_method_return (message);
4013       if (ret == NULL)
4014         return DBUS_HANDLER_RESULT_NEED_MEMORY;
4015
4016       sent = FALSE;
4017       _dbus_string_init (&uuid);
4018       if (_dbus_get_local_machine_uuid_encoded (&uuid))
4019         {
4020           const char *v_STRING = _dbus_string_get_const_data (&uuid);
4021           if (dbus_message_append_args (ret,
4022                                         DBUS_TYPE_STRING, &v_STRING,
4023                                         DBUS_TYPE_INVALID))
4024             {
4025               sent = _dbus_connection_send_unlocked_no_update (connection, ret, NULL);
4026             }
4027         }
4028       _dbus_string_free (&uuid);
4029
4030       dbus_message_unref (ret);
4031
4032       if (!sent)
4033         return DBUS_HANDLER_RESULT_NEED_MEMORY;
4034
4035       return DBUS_HANDLER_RESULT_HANDLED;
4036     }
4037   else if (dbus_message_has_interface (message, DBUS_INTERFACE_PEER))
4038     {
4039       /* We need to bounce anything else with this interface, otherwise apps
4040        * could start extending the interface and when we added extensions
4041        * here to DBusConnection we'd break those apps.
4042        */
4043
4044       DBusMessage *ret;
4045       dbus_bool_t sent;
4046
4047       ret = dbus_message_new_error (message,
4048                                     DBUS_ERROR_UNKNOWN_METHOD,
4049                                     "Unknown method invoked on org.freedesktop.DBus.Peer interface");
4050       if (ret == NULL)
4051         return DBUS_HANDLER_RESULT_NEED_MEMORY;
4052
4053       sent = _dbus_connection_send_unlocked_no_update (connection, ret, NULL);
4054
4055       dbus_message_unref (ret);
4056
4057       if (!sent)
4058         return DBUS_HANDLER_RESULT_NEED_MEMORY;
4059
4060       return DBUS_HANDLER_RESULT_HANDLED;
4061     }
4062   else
4063     {
4064       return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
4065     }
4066 }
4067
4068 /**
4069 * Processes all builtin filter functions
4070 *
4071 * If the spec specifies a standard interface
4072 * they should be processed from this method
4073 **/
4074 static DBusHandlerResult
4075 _dbus_connection_run_builtin_filters_unlocked_no_update (DBusConnection *connection,
4076                                                            DBusMessage    *message)
4077 {
4078   /* We just run one filter for now but have the option to run more
4079      if the spec calls for it in the future */
4080
4081   return _dbus_connection_peer_filter_unlocked_no_update (connection, message);
4082 }
4083
4084 /**
4085  * Processes any incoming data.
4086  *
4087  * If there's incoming raw data that has not yet been parsed, it is
4088  * parsed, which may or may not result in adding messages to the
4089  * incoming queue.
4090  *
4091  * The incoming data buffer is filled when the connection reads from
4092  * its underlying transport (such as a socket).  Reading usually
4093  * happens in dbus_watch_handle() or dbus_connection_read_write().
4094  *
4095  * If there are complete messages in the incoming queue,
4096  * dbus_connection_dispatch() removes one message from the queue and
4097  * processes it. Processing has three steps.
4098  *
4099  * First, any method replies are passed to #DBusPendingCall or
4100  * dbus_connection_send_with_reply_and_block() in order to
4101  * complete the pending method call.
4102  *
4103  * Second, any filters registered with dbus_connection_add_filter()
4104  * are run. If any filter returns #DBUS_HANDLER_RESULT_HANDLED
4105  * then processing stops after that filter.
4106  *
4107  * Third, if the message is a method call it is forwarded to
4108  * any registered object path handlers added with
4109  * dbus_connection_register_object_path() or
4110  * dbus_connection_register_fallback().
4111  *
4112  * A single call to dbus_connection_dispatch() will process at most
4113  * one message; it will not clear the entire message queue.
4114  *
4115  * Be careful about calling dbus_connection_dispatch() from inside a
4116  * message handler, i.e. calling dbus_connection_dispatch()
4117  * recursively.  If threads have been initialized with a recursive
4118  * mutex function, then this will not deadlock; however, it can
4119  * certainly confuse your application.
4120  *
4121  * @todo some FIXME in here about handling DBUS_HANDLER_RESULT_NEED_MEMORY
4122  *
4123  * @param connection the connection
4124  * @returns dispatch status, see dbus_connection_get_dispatch_status()
4125  */
4126 DBusDispatchStatus
4127 dbus_connection_dispatch (DBusConnection *connection)
4128 {
4129   DBusMessage *message;
4130   DBusList *link, *filter_list_copy, *message_link;
4131   DBusHandlerResult result;
4132   DBusPendingCall *pending;
4133   dbus_int32_t reply_serial;
4134   DBusDispatchStatus status;
4135
4136   _dbus_return_val_if_fail (connection != NULL, DBUS_DISPATCH_COMPLETE);
4137
4138   _dbus_verbose ("%s\n", _DBUS_FUNCTION_NAME);
4139
4140   CONNECTION_LOCK (connection);
4141   status = _dbus_connection_get_dispatch_status_unlocked (connection);
4142   if (status != DBUS_DISPATCH_DATA_REMAINS)
4143     {
4144       /* unlocks and calls out to user code */
4145       _dbus_connection_update_dispatch_status_and_unlock (connection, status);
4146       return status;
4147     }
4148
4149   /* We need to ref the connection since the callback could potentially
4150    * drop the last ref to it
4151    */
4152   _dbus_connection_ref_unlocked (connection);
4153
4154   _dbus_connection_acquire_dispatch (connection);
4155   HAVE_LOCK_CHECK (connection);
4156
4157   message_link = _dbus_connection_pop_message_link_unlocked (connection);
4158   if (message_link == NULL)
4159     {
4160       /* another thread dispatched our stuff */
4161
4162       _dbus_verbose ("another thread dispatched message (during acquire_dispatch above)\n");
4163
4164       _dbus_connection_release_dispatch (connection);
4165
4166       status = _dbus_connection_get_dispatch_status_unlocked (connection);
4167
4168       _dbus_connection_update_dispatch_status_and_unlock (connection, status);
4169
4170       dbus_connection_unref (connection);
4171
4172       return status;
4173     }
4174
4175   message = message_link->data;
4176
4177   _dbus_verbose (" dispatching message %p (%d %s %s '%s')\n",
4178                  message,
4179                  dbus_message_get_type (message),
4180                  dbus_message_get_interface (message) ?
4181                  dbus_message_get_interface (message) :
4182                  "no interface",
4183                  dbus_message_get_member (message) ?
4184                  dbus_message_get_member (message) :
4185                  "no member",
4186                  dbus_message_get_signature (message));
4187
4188   result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
4189
4190   /* Pending call handling must be first, because if you do
4191    * dbus_connection_send_with_reply_and_block() or
4192    * dbus_pending_call_block() then no handlers/filters will be run on
4193    * the reply. We want consistent semantics in the case where we
4194    * dbus_connection_dispatch() the reply.
4195    */
4196
4197   reply_serial = dbus_message_get_reply_serial (message);
4198   pending = _dbus_hash_table_lookup_int (connection->pending_replies,
4199                                          reply_serial);
4200   if (pending)
4201     {
4202       _dbus_verbose ("Dispatching a pending reply\n");
4203       complete_pending_call_and_unlock (connection, pending, message);
4204       pending = NULL; /* it's probably unref'd */
4205
4206       CONNECTION_LOCK (connection);
4207       _dbus_verbose ("pending call completed in dispatch\n");
4208       result = DBUS_HANDLER_RESULT_HANDLED;
4209       goto out;
4210     }
4211
4212   result = _dbus_connection_run_builtin_filters_unlocked_no_update (connection, message);
4213   if (result != DBUS_HANDLER_RESULT_NOT_YET_HANDLED)
4214     goto out;
4215
4216   if (!_dbus_list_copy (&connection->filter_list, &filter_list_copy))
4217     {
4218       _dbus_connection_release_dispatch (connection);
4219       HAVE_LOCK_CHECK (connection);
4220
4221       _dbus_connection_failed_pop (connection, message_link);
4222
4223       /* unlocks and calls user code */
4224       _dbus_connection_update_dispatch_status_and_unlock (connection,
4225                                                           DBUS_DISPATCH_NEED_MEMORY);
4226
4227       if (pending)
4228         dbus_pending_call_unref (pending);
4229       dbus_connection_unref (connection);
4230
4231       return DBUS_DISPATCH_NEED_MEMORY;
4232     }
4233
4234   _dbus_list_foreach (&filter_list_copy,
4235                       (DBusForeachFunction)_dbus_message_filter_ref,
4236                       NULL);
4237
4238   /* We're still protected from dispatch() reentrancy here
4239    * since we acquired the dispatcher
4240    */
4241   CONNECTION_UNLOCK (connection);
4242
4243   link = _dbus_list_get_first_link (&filter_list_copy);
4244   while (link != NULL)
4245     {
4246       DBusMessageFilter *filter = link->data;
4247       DBusList *next = _dbus_list_get_next_link (&filter_list_copy, link);
4248
4249       if (filter->function == NULL)
4250         {
4251           _dbus_verbose ("  filter was removed in a callback function\n");
4252           link = next;
4253           continue;
4254         }
4255
4256       _dbus_verbose ("  running filter on message %p\n", message);
4257       result = (* filter->function) (connection, message, filter->user_data);
4258
4259       if (result != DBUS_HANDLER_RESULT_NOT_YET_HANDLED)
4260         break;
4261
4262       link = next;
4263     }
4264
4265   _dbus_list_foreach (&filter_list_copy,
4266                       (DBusForeachFunction)_dbus_message_filter_unref,
4267                       NULL);
4268   _dbus_list_clear (&filter_list_copy);
4269
4270   CONNECTION_LOCK (connection);
4271
4272   if (result == DBUS_HANDLER_RESULT_NEED_MEMORY)
4273     {
4274       _dbus_verbose ("No memory in %s\n", _DBUS_FUNCTION_NAME);
4275       goto out;
4276     }
4277   else if (result == DBUS_HANDLER_RESULT_HANDLED)
4278     {
4279       _dbus_verbose ("filter handled message in dispatch\n");
4280       goto out;
4281     }
4282
4283   /* We're still protected from dispatch() reentrancy here
4284    * since we acquired the dispatcher
4285    */
4286   _dbus_verbose ("  running object path dispatch on message %p (%d %s %s '%s')\n",
4287                  message,
4288                  dbus_message_get_type (message),
4289                  dbus_message_get_interface (message) ?
4290                  dbus_message_get_interface (message) :
4291                  "no interface",
4292                  dbus_message_get_member (message) ?
4293                  dbus_message_get_member (message) :
4294                  "no member",
4295                  dbus_message_get_signature (message));
4296
4297   HAVE_LOCK_CHECK (connection);
4298   result = _dbus_object_tree_dispatch_and_unlock (connection->objects,
4299                                                   message);
4300
4301   CONNECTION_LOCK (connection);
4302
4303   if (result != DBUS_HANDLER_RESULT_NOT_YET_HANDLED)
4304     {
4305       _dbus_verbose ("object tree handled message in dispatch\n");
4306       goto out;
4307     }
4308
4309   if (dbus_message_get_type (message) == DBUS_MESSAGE_TYPE_METHOD_CALL)
4310     {
4311       DBusMessage *reply;
4312       DBusString str;
4313       DBusPreallocatedSend *preallocated;
4314
4315       _dbus_verbose ("  sending error %s\n",
4316                      DBUS_ERROR_UNKNOWN_METHOD);
4317
4318       if (!_dbus_string_init (&str))
4319         {
4320           result = DBUS_HANDLER_RESULT_NEED_MEMORY;
4321           _dbus_verbose ("no memory for error string in dispatch\n");
4322           goto out;
4323         }
4324
4325       if (!_dbus_string_append_printf (&str,
4326                                        "Method \"%s\" with signature \"%s\" on interface \"%s\" doesn't exist\n",
4327                                        dbus_message_get_member (message),
4328                                        dbus_message_get_signature (message),
4329                                        dbus_message_get_interface (message)))
4330         {
4331           _dbus_string_free (&str);
4332           result = DBUS_HANDLER_RESULT_NEED_MEMORY;
4333           _dbus_verbose ("no memory for error string in dispatch\n");
4334           goto out;
4335         }
4336
4337       reply = dbus_message_new_error (message,
4338                                       DBUS_ERROR_UNKNOWN_METHOD,
4339                                       _dbus_string_get_const_data (&str));
4340       _dbus_string_free (&str);
4341
4342       if (reply == NULL)
4343         {
4344           result = DBUS_HANDLER_RESULT_NEED_MEMORY;
4345           _dbus_verbose ("no memory for error reply in dispatch\n");
4346           goto out;
4347         }
4348
4349       preallocated = _dbus_connection_preallocate_send_unlocked (connection);
4350
4351       if (preallocated == NULL)
4352         {
4353           dbus_message_unref (reply);
4354           result = DBUS_HANDLER_RESULT_NEED_MEMORY;
4355           _dbus_verbose ("no memory for error send in dispatch\n");
4356           goto out;
4357         }
4358
4359       _dbus_connection_send_preallocated_unlocked_no_update (connection, preallocated,
4360                                                              reply, NULL);
4361
4362       dbus_message_unref (reply);
4363
4364       result = DBUS_HANDLER_RESULT_HANDLED;
4365     }
4366
4367   _dbus_verbose ("  done dispatching %p (%d %s %s '%s') on connection %p\n", message,
4368                  dbus_message_get_type (message),
4369                  dbus_message_get_interface (message) ?
4370                  dbus_message_get_interface (message) :
4371                  "no interface",
4372                  dbus_message_get_member (message) ?
4373                  dbus_message_get_member (message) :
4374                  "no member",
4375                  dbus_message_get_signature (message),
4376                  connection);
4377
4378  out:
4379   if (result == DBUS_HANDLER_RESULT_NEED_MEMORY)
4380     {
4381       _dbus_verbose ("out of memory in %s\n", _DBUS_FUNCTION_NAME);
4382
4383       /* Put message back, and we'll start over.
4384        * Yes this means handlers must be idempotent if they
4385        * don't return HANDLED; c'est la vie.
4386        */
4387       _dbus_connection_putback_message_link_unlocked (connection,
4388                                                       message_link);
4389     }
4390   else
4391     {
4392       _dbus_verbose (" ... done dispatching in %s\n", _DBUS_FUNCTION_NAME);
4393
4394       _dbus_list_free_link (message_link);
4395       dbus_message_unref (message); /* don't want the message to count in max message limits
4396                                      * in computing dispatch status below
4397                                      */
4398     }
4399
4400   _dbus_connection_release_dispatch (connection);
4401   HAVE_LOCK_CHECK (connection);
4402
4403   _dbus_verbose ("%s before final status update\n", _DBUS_FUNCTION_NAME);
4404   status = _dbus_connection_get_dispatch_status_unlocked (connection);
4405
4406   /* unlocks and calls user code */
4407   _dbus_connection_update_dispatch_status_and_unlock (connection, status);
4408
4409   dbus_connection_unref (connection);
4410
4411   return status;
4412 }
4413
4414 /**
4415  * Sets the watch functions for the connection. These functions are
4416  * responsible for making the application's main loop aware of file
4417  * descriptors that need to be monitored for events, using select() or
4418  * poll(). When using Qt, typically the DBusAddWatchFunction would
4419  * create a QSocketNotifier. When using GLib, the DBusAddWatchFunction
4420  * could call g_io_add_watch(), or could be used as part of a more
4421  * elaborate GSource. Note that when a watch is added, it may
4422  * not be enabled.
4423  *
4424  * The DBusWatchToggledFunction notifies the application that the
4425  * watch has been enabled or disabled. Call dbus_watch_get_enabled()
4426  * to check this. A disabled watch should have no effect, and enabled
4427  * watch should be added to the main loop. This feature is used
4428  * instead of simply adding/removing the watch because
4429  * enabling/disabling can be done without memory allocation.  The
4430  * toggled function may be NULL if a main loop re-queries
4431  * dbus_watch_get_enabled() every time anyway.
4432  *
4433  * The DBusWatch can be queried for the file descriptor to watch using
4434  * dbus_watch_get_fd(), and for the events to watch for using
4435  * dbus_watch_get_flags(). The flags returned by
4436  * dbus_watch_get_flags() will only contain DBUS_WATCH_READABLE and
4437  * DBUS_WATCH_WRITABLE, never DBUS_WATCH_HANGUP or DBUS_WATCH_ERROR;
4438  * all watches implicitly include a watch for hangups, errors, and
4439  * other exceptional conditions.
4440  *
4441  * Once a file descriptor becomes readable or writable, or an exception
4442  * occurs, dbus_watch_handle() should be called to
4443  * notify the connection of the file descriptor's condition.
4444  *
4445  * dbus_watch_handle() cannot be called during the
4446  * DBusAddWatchFunction, as the connection will not be ready to handle
4447  * that watch yet.
4448  *
4449  * It is not allowed to reference a DBusWatch after it has been passed
4450  * to remove_function.
4451  *
4452  * If #FALSE is returned due to lack of memory, the failure may be due
4453  * to a #FALSE return from the new add_function. If so, the
4454  * add_function may have been called successfully one or more times,
4455  * but the remove_function will also have been called to remove any
4456  * successful adds. i.e. if #FALSE is returned the net result
4457  * should be that dbus_connection_set_watch_functions() has no effect,
4458  * but the add_function and remove_function may have been called.
4459  *
4460  * @todo We need to drop the lock when we call the
4461  * add/remove/toggled functions which can be a side effect
4462  * of setting the watch functions.
4463  *
4464  * @param connection the connection.
4465  * @param add_function function to begin monitoring a new descriptor.
4466  * @param remove_function function to stop monitoring a descriptor.
4467  * @param toggled_function function to notify of enable/disable
4468  * @param data data to pass to add_function and remove_function.
4469  * @param free_data_function function to be called to free the data.
4470  * @returns #FALSE on failure (no memory)
4471  */
4472 dbus_bool_t
4473 dbus_connection_set_watch_functions (DBusConnection              *connection,
4474                                      DBusAddWatchFunction         add_function,
4475                                      DBusRemoveWatchFunction      remove_function,
4476                                      DBusWatchToggledFunction     toggled_function,
4477                                      void                        *data,
4478                                      DBusFreeFunction             free_data_function)
4479 {
4480   dbus_bool_t retval;
4481   DBusWatchList *watches;
4482
4483   _dbus_return_val_if_fail (connection != NULL, FALSE);
4484
4485   CONNECTION_LOCK (connection);
4486
4487 #ifndef DBUS_DISABLE_CHECKS
4488   if (connection->watches == NULL)
4489     {
4490       _dbus_warn_check_failed ("Re-entrant call to %s is not allowed\n",
4491                                _DBUS_FUNCTION_NAME);
4492       return FALSE;
4493     }
4494 #endif
4495
4496   /* ref connection for slightly better reentrancy */
4497   _dbus_connection_ref_unlocked (connection);
4498
4499   /* This can call back into user code, and we need to drop the
4500    * connection lock when it does. This is kind of a lame
4501    * way to do it.
4502    */
4503   watches = connection->watches;
4504   connection->watches = NULL;
4505   CONNECTION_UNLOCK (connection);
4506
4507   retval = _dbus_watch_list_set_functions (watches,
4508                                            add_function, remove_function,
4509                                            toggled_function,
4510                                            data, free_data_function);
4511   CONNECTION_LOCK (connection);
4512   connection->watches = watches;
4513
4514   CONNECTION_UNLOCK (connection);
4515   /* drop our paranoid refcount */
4516   dbus_connection_unref (connection);
4517
4518   return retval;
4519 }
4520
4521 /**
4522  * Sets the timeout functions for the connection. These functions are
4523  * responsible for making the application's main loop aware of timeouts.
4524  * When using Qt, typically the DBusAddTimeoutFunction would create a
4525  * QTimer. When using GLib, the DBusAddTimeoutFunction would call
4526  * g_timeout_add.
4527  *
4528  * The DBusTimeoutToggledFunction notifies the application that the
4529  * timeout has been enabled or disabled. Call
4530  * dbus_timeout_get_enabled() to check this. A disabled timeout should
4531  * have no effect, and enabled timeout should be added to the main
4532  * loop. This feature is used instead of simply adding/removing the
4533  * timeout because enabling/disabling can be done without memory
4534  * allocation. With Qt, QTimer::start() and QTimer::stop() can be used
4535  * to enable and disable. The toggled function may be NULL if a main
4536  * loop re-queries dbus_timeout_get_enabled() every time anyway.
4537  * Whenever a timeout is toggled, its interval may change.
4538  *
4539  * The DBusTimeout can be queried for the timer interval using
4540  * dbus_timeout_get_interval(). dbus_timeout_handle() should be called
4541  * repeatedly, each time the interval elapses, starting after it has
4542  * elapsed once. The timeout stops firing when it is removed with the
4543  * given remove_function.  The timer interval may change whenever the
4544  * timeout is added, removed, or toggled.
4545  *
4546  * @param connection the connection.
4547  * @param add_function function to add a timeout.
4548  * @param remove_function function to remove a timeout.
4549  * @param toggled_function function to notify of enable/disable
4550  * @param data data to pass to add_function and remove_function.
4551  * @param free_data_function function to be called to free the data.
4552  * @returns #FALSE on failure (no memory)
4553  */
4554 dbus_bool_t
4555 dbus_connection_set_timeout_functions   (DBusConnection            *connection,
4556                                          DBusAddTimeoutFunction     add_function,
4557                                          DBusRemoveTimeoutFunction  remove_function,
4558                                          DBusTimeoutToggledFunction toggled_function,
4559                                          void                      *data,
4560                                          DBusFreeFunction           free_data_function)
4561 {
4562   dbus_bool_t retval;
4563   DBusTimeoutList *timeouts;
4564
4565   _dbus_return_val_if_fail (connection != NULL, FALSE);
4566
4567   CONNECTION_LOCK (connection);
4568
4569 #ifndef DBUS_DISABLE_CHECKS
4570   if (connection->timeouts == NULL)
4571     {
4572       _dbus_warn_check_failed ("Re-entrant call to %s is not allowed\n",
4573                                _DBUS_FUNCTION_NAME);
4574       return FALSE;
4575     }
4576 #endif
4577
4578   /* ref connection for slightly better reentrancy */
4579   _dbus_connection_ref_unlocked (connection);
4580
4581   timeouts = connection->timeouts;
4582   connection->timeouts = NULL;
4583   CONNECTION_UNLOCK (connection);
4584
4585   retval = _dbus_timeout_list_set_functions (timeouts,
4586                                              add_function, remove_function,
4587                                              toggled_function,
4588                                              data, free_data_function);
4589   CONNECTION_LOCK (connection);
4590   connection->timeouts = timeouts;
4591
4592   CONNECTION_UNLOCK (connection);
4593   /* drop our paranoid refcount */
4594   dbus_connection_unref (connection);
4595
4596   return retval;
4597 }
4598
4599 /**
4600  * Sets the mainloop wakeup function for the connection. This function
4601  * is responsible for waking up the main loop (if its sleeping in
4602  * another thread) when some some change has happened to the
4603  * connection that the mainloop needs to reconsider (e.g. a message
4604  * has been queued for writing).  When using Qt, this typically
4605  * results in a call to QEventLoop::wakeUp().  When using GLib, it
4606  * would call g_main_context_wakeup().
4607  *
4608  * @param connection the connection.
4609  * @param wakeup_main_function function to wake up the mainloop
4610  * @param data data to pass wakeup_main_function
4611  * @param free_data_function function to be called to free the data.
4612  */
4613 void
4614 dbus_connection_set_wakeup_main_function (DBusConnection            *connection,
4615                                           DBusWakeupMainFunction     wakeup_main_function,
4616                                           void                      *data,
4617                                           DBusFreeFunction           free_data_function)
4618 {
4619   void *old_data;
4620   DBusFreeFunction old_free_data;
4621
4622   _dbus_return_if_fail (connection != NULL);
4623
4624   CONNECTION_LOCK (connection);
4625   old_data = connection->wakeup_main_data;
4626   old_free_data = connection->free_wakeup_main_data;
4627
4628   connection->wakeup_main_function = wakeup_main_function;
4629   connection->wakeup_main_data = data;
4630   connection->free_wakeup_main_data = free_data_function;
4631
4632   CONNECTION_UNLOCK (connection);
4633
4634   /* Callback outside the lock */
4635   if (old_free_data)
4636     (*old_free_data) (old_data);
4637 }
4638
4639 /**
4640  * Set a function to be invoked when the dispatch status changes.
4641  * If the dispatch status is #DBUS_DISPATCH_DATA_REMAINS, then
4642  * dbus_connection_dispatch() needs to be called to process incoming
4643  * messages. However, dbus_connection_dispatch() MUST NOT BE CALLED
4644  * from inside the DBusDispatchStatusFunction. Indeed, almost
4645  * any reentrancy in this function is a bad idea. Instead,
4646  * the DBusDispatchStatusFunction should simply save an indication
4647  * that messages should be dispatched later, when the main loop
4648  * is re-entered.
4649  *
4650  * If you don't set a dispatch status function, you have to be sure to
4651  * dispatch on every iteration of your main loop, especially if
4652  * dbus_watch_handle() or dbus_timeout_handle() were called.
4653  *
4654  * @param connection the connection
4655  * @param function function to call on dispatch status changes
4656  * @param data data for function
4657  * @param free_data_function free the function data
4658  */
4659 void
4660 dbus_connection_set_dispatch_status_function (DBusConnection             *connection,
4661                                               DBusDispatchStatusFunction  function,
4662                                               void                       *data,
4663                                               DBusFreeFunction            free_data_function)
4664 {
4665   void *old_data;
4666   DBusFreeFunction old_free_data;
4667
4668   _dbus_return_if_fail (connection != NULL);
4669
4670   CONNECTION_LOCK (connection);
4671   old_data = connection->dispatch_status_data;
4672   old_free_data = connection->free_dispatch_status_data;
4673
4674   connection->dispatch_status_function = function;
4675   connection->dispatch_status_data = data;
4676   connection->free_dispatch_status_data = free_data_function;
4677
4678   CONNECTION_UNLOCK (connection);
4679
4680   /* Callback outside the lock */
4681   if (old_free_data)
4682     (*old_free_data) (old_data);
4683 }
4684
4685 /**
4686  * Get the UNIX file descriptor of the connection, if any.  This can
4687  * be used for SELinux access control checks with getpeercon() for
4688  * example. DO NOT read or write to the file descriptor, or try to
4689  * select() on it; use DBusWatch for main loop integration. Not all
4690  * connections will have a file descriptor. So for adding descriptors
4691  * to the main loop, use dbus_watch_get_fd() and so forth.
4692  *
4693  * If the connection is socket-based, you can also use
4694  * dbus_connection_get_socket(), which will work on Windows too.
4695  * This function always fails on Windows.
4696  *
4697  * Right now the returned descriptor is always a socket, but
4698  * that is not guaranteed.
4699  *
4700  * @param connection the connection
4701  * @param fd return location for the file descriptor.
4702  * @returns #TRUE if fd is successfully obtained.
4703  */
4704 dbus_bool_t
4705 dbus_connection_get_unix_fd (DBusConnection *connection,
4706                              int            *fd)
4707 {
4708   _dbus_return_val_if_fail (connection != NULL, FALSE);
4709   _dbus_return_val_if_fail (connection->transport != NULL, FALSE);
4710
4711 #ifdef DBUS_WIN
4712   /* FIXME do this on a lower level */
4713   return FALSE;
4714 #endif
4715
4716   return dbus_connection_get_socket(connection, fd);
4717 }
4718
4719 /**
4720  * Gets the underlying Windows or UNIX socket file descriptor
4721  * of the connection, if any. DO NOT read or write to the file descriptor, or try to
4722  * select() on it; use DBusWatch for main loop integration. Not all
4723  * connections will have a socket. So for adding descriptors
4724  * to the main loop, use dbus_watch_get_fd() and so forth.
4725  *
4726  * If the connection is not socket-based, this function will return FALSE,
4727  * even if the connection does have a file descriptor of some kind.
4728  * i.e. this function always returns specifically a socket file descriptor.
4729  *
4730  * @param connection the connection
4731  * @param fd return location for the file descriptor.
4732  * @returns #TRUE if fd is successfully obtained.
4733  */
4734 dbus_bool_t
4735 dbus_connection_get_socket(DBusConnection              *connection,
4736                            int                         *fd)
4737 {
4738   dbus_bool_t retval;
4739
4740   _dbus_return_val_if_fail (connection != NULL, FALSE);
4741   _dbus_return_val_if_fail (connection->transport != NULL, FALSE);
4742
4743   CONNECTION_LOCK (connection);
4744
4745   retval = _dbus_transport_get_socket_fd (connection->transport,
4746                                           fd);
4747
4748   CONNECTION_UNLOCK (connection);
4749
4750   return retval;
4751 }
4752
4753
4754 /**
4755  * Gets the UNIX user ID of the connection if known.  Returns #TRUE if
4756  * the uid is filled in.  Always returns #FALSE on non-UNIX platforms.
4757  * Always returns #FALSE prior to authenticating the connection.
4758  *
4759  * The UID is only read by servers from clients; clients can't usually
4760  * get the UID of servers, because servers do not authenticate to
4761  * clients.  The returned UID is the UID the connection authenticated
4762  * as.
4763  *
4764  * The message bus is a server and the apps connecting to the bus
4765  * are clients.
4766  *
4767  * You can ask the bus to tell you the UID of another connection though
4768  * if you like; this is done with dbus_bus_get_unix_user().
4769  *
4770  * @param connection the connection
4771  * @param uid return location for the user ID
4772  * @returns #TRUE if uid is filled in with a valid user ID
4773  */
4774 dbus_bool_t
4775 dbus_connection_get_unix_user (DBusConnection *connection,
4776                                unsigned long  *uid)
4777 {
4778   dbus_bool_t result;
4779
4780   _dbus_return_val_if_fail (connection != NULL, FALSE);
4781   _dbus_return_val_if_fail (uid != NULL, FALSE);
4782
4783 #ifdef DBUS_WIN
4784   /* FIXME this should be done at a lower level, but it's kind of hard,
4785    * just want to be sure we don't ship with this API returning
4786    * some weird internal fake uid for 1.0
4787    */
4788   return FALSE;
4789 #endif
4790
4791   CONNECTION_LOCK (connection);
4792
4793   if (!_dbus_transport_get_is_authenticated (connection->transport))
4794     result = FALSE;
4795   else
4796     result = _dbus_transport_get_unix_user (connection->transport,
4797                                             uid);
4798   CONNECTION_UNLOCK (connection);
4799
4800   return result;
4801 }
4802
4803 /**
4804  * Gets the process ID of the connection if any.
4805  * Returns #TRUE if the uid is filled in.
4806  * Always returns #FALSE prior to authenticating the
4807  * connection.
4808  *
4809  * @param connection the connection
4810  * @param pid return location for the process ID
4811  * @returns #TRUE if uid is filled in with a valid process ID
4812  */
4813 dbus_bool_t
4814 dbus_connection_get_unix_process_id (DBusConnection *connection,
4815                                      unsigned long  *pid)
4816 {
4817   dbus_bool_t result;
4818
4819   _dbus_return_val_if_fail (connection != NULL, FALSE);
4820   _dbus_return_val_if_fail (pid != NULL, FALSE);
4821
4822 #ifdef DBUS_WIN
4823   /* FIXME this should be done at a lower level, but it's kind of hard,
4824    * just want to be sure we don't ship with this API returning
4825    * some weird internal fake uid for 1.0
4826    */
4827   return FALSE;
4828 #endif
4829
4830   CONNECTION_LOCK (connection);
4831
4832   if (!_dbus_transport_get_is_authenticated (connection->transport))
4833     result = FALSE;
4834   else
4835     result = _dbus_transport_get_unix_process_id (connection->transport,
4836                                                   pid);
4837   CONNECTION_UNLOCK (connection);
4838
4839   return result;
4840 }
4841
4842 /**
4843  * Sets a predicate function used to determine whether a given user ID
4844  * is allowed to connect. When an incoming connection has
4845  * authenticated with a particular user ID, this function is called;
4846  * if it returns #TRUE, the connection is allowed to proceed,
4847  * otherwise the connection is disconnected.
4848  *
4849  * If the function is set to #NULL (as it is by default), then
4850  * only the same UID as the server process will be allowed to
4851  * connect.
4852  *
4853  * On Windows, the function will be set and its free_data_function will
4854  * be invoked when the connection is freed or a new function is set.
4855  * However, the function will never be called, because there are
4856  * no UNIX user ids to pass to it.
4857  *
4858  * @todo add a Windows API analogous to dbus_connection_set_unix_user_function()
4859  *
4860  * @param connection the connection
4861  * @param function the predicate
4862  * @param data data to pass to the predicate
4863  * @param free_data_function function to free the data
4864  */
4865 void
4866 dbus_connection_set_unix_user_function (DBusConnection             *connection,
4867                                         DBusAllowUnixUserFunction   function,
4868                                         void                       *data,
4869                                         DBusFreeFunction            free_data_function)
4870 {
4871   void *old_data = NULL;
4872   DBusFreeFunction old_free_function = NULL;
4873
4874   _dbus_return_if_fail (connection != NULL);
4875
4876   CONNECTION_LOCK (connection);
4877   _dbus_transport_set_unix_user_function (connection->transport,
4878                                           function, data, free_data_function,
4879                                           &old_data, &old_free_function);
4880   CONNECTION_UNLOCK (connection);
4881
4882   if (old_free_function != NULL)
4883     (* old_free_function) (old_data);
4884 }
4885
4886 /**
4887  *
4888  * Normally #DBusConnection automatically handles all messages to the
4889  * org.freedesktop.DBus.Peer interface. However, the message bus wants
4890  * to be able to route methods on that interface through the bus and
4891  * to other applications. If routing peer messages is enabled, then
4892  * messages with the org.freedesktop.DBus.Peer interface that also
4893  * have a bus destination name set will not be automatically
4894  * handled by the #DBusConnection and instead will be dispatched
4895  * normally to the application.
4896  *
4897  *
4898  * If a normal application sets this flag, it can break things badly.
4899  * So don't set this unless you are the message bus.
4900  *
4901  * @param connection the connection
4902  * @param value #TRUE to pass through org.freedesktop.DBus.Peer messages with a bus name set
4903  */
4904 void
4905 dbus_connection_set_route_peer_messages (DBusConnection             *connection,
4906                                          dbus_bool_t                 value)
4907 {
4908   _dbus_return_if_fail (connection != NULL);
4909
4910   CONNECTION_LOCK (connection);
4911   connection->route_peer_messages = TRUE;
4912   CONNECTION_UNLOCK (connection);
4913 }
4914
4915 /**
4916  * Adds a message filter. Filters are handlers that are run on all
4917  * incoming messages, prior to the objects registered with
4918  * dbus_connection_register_object_path().  Filters are run in the
4919  * order that they were added.  The same handler can be added as a
4920  * filter more than once, in which case it will be run more than once.
4921  * Filters added during a filter callback won't be run on the message
4922  * being processed.
4923  *
4924  * @todo we don't run filters on messages while blocking without
4925  * entering the main loop, since filters are run as part of
4926  * dbus_connection_dispatch(). This is probably a feature, as filters
4927  * could create arbitrary reentrancy. But kind of sucks if you're
4928  * trying to filter METHOD_RETURN for some reason.
4929  *
4930  * @param connection the connection
4931  * @param function function to handle messages
4932  * @param user_data user data to pass to the function
4933  * @param free_data_function function to use for freeing user data
4934  * @returns #TRUE on success, #FALSE if not enough memory.
4935  */
4936 dbus_bool_t
4937 dbus_connection_add_filter (DBusConnection            *connection,
4938                             DBusHandleMessageFunction  function,
4939                             void                      *user_data,
4940                             DBusFreeFunction           free_data_function)
4941 {
4942   DBusMessageFilter *filter;
4943
4944   _dbus_return_val_if_fail (connection != NULL, FALSE);
4945   _dbus_return_val_if_fail (function != NULL, FALSE);
4946
4947   filter = dbus_new0 (DBusMessageFilter, 1);
4948   if (filter == NULL)
4949     return FALSE;
4950
4951   filter->refcount.value = 1;
4952
4953   CONNECTION_LOCK (connection);
4954
4955   if (!_dbus_list_append (&connection->filter_list,
4956                           filter))
4957     {
4958       _dbus_message_filter_unref (filter);
4959       CONNECTION_UNLOCK (connection);
4960       return FALSE;
4961     }
4962
4963   /* Fill in filter after all memory allocated,
4964    * so we don't run the free_user_data_function
4965    * if the add_filter() fails
4966    */
4967
4968   filter->function = function;
4969   filter->user_data = user_data;
4970   filter->free_user_data_function = free_data_function;
4971
4972   CONNECTION_UNLOCK (connection);
4973   return TRUE;
4974 }
4975
4976 /**
4977  * Removes a previously-added message filter. It is a programming
4978  * error to call this function for a handler that has not been added
4979  * as a filter. If the given handler was added more than once, only
4980  * one instance of it will be removed (the most recently-added
4981  * instance).
4982  *
4983  * @param connection the connection
4984  * @param function the handler to remove
4985  * @param user_data user data for the handler to remove
4986  *
4987  */
4988 void
4989 dbus_connection_remove_filter (DBusConnection            *connection,
4990                                DBusHandleMessageFunction  function,
4991                                void                      *user_data)
4992 {
4993   DBusList *link;
4994   DBusMessageFilter *filter;
4995
4996   _dbus_return_if_fail (connection != NULL);
4997   _dbus_return_if_fail (function != NULL);
4998
4999   CONNECTION_LOCK (connection);
5000
5001   filter = NULL;
5002
5003   link = _dbus_list_get_last_link (&connection->filter_list);
5004   while (link != NULL)
5005     {
5006       filter = link->data;
5007
5008       if (filter->function == function &&
5009           filter->user_data == user_data)
5010         {
5011           _dbus_list_remove_link (&connection->filter_list, link);
5012           filter->function = NULL;
5013
5014           break;
5015         }
5016
5017       link = _dbus_list_get_prev_link (&connection->filter_list, link);
5018     }
5019
5020   CONNECTION_UNLOCK (connection);
5021
5022 #ifndef DBUS_DISABLE_CHECKS
5023   if (filter == NULL)
5024     {
5025       _dbus_warn_check_failed ("Attempt to remove filter function %p user data %p, but no such filter has been added\n",
5026                                function, user_data);
5027       return;
5028     }
5029 #endif
5030
5031   /* Call application code */
5032   if (filter->free_user_data_function)
5033     (* filter->free_user_data_function) (filter->user_data);
5034
5035   filter->free_user_data_function = NULL;
5036   filter->user_data = NULL;
5037
5038   _dbus_message_filter_unref (filter);
5039 }
5040
5041 /**
5042  * Registers a handler for a given path in the object hierarchy.
5043  * The given vtable handles messages sent to exactly the given path.
5044  *
5045  *
5046  * @param connection the connection
5047  * @param path a '/' delimited string of path elements
5048  * @param vtable the virtual table
5049  * @param user_data data to pass to functions in the vtable
5050  * @returns #FALSE if not enough memory
5051  */
5052 dbus_bool_t
5053 dbus_connection_register_object_path (DBusConnection              *connection,
5054                                       const char                  *path,
5055                                       const DBusObjectPathVTable  *vtable,
5056                                       void                        *user_data)
5057 {
5058   char **decomposed_path;
5059   dbus_bool_t retval;
5060
5061   _dbus_return_val_if_fail (connection != NULL, FALSE);
5062   _dbus_return_val_if_fail (path != NULL, FALSE);
5063   _dbus_return_val_if_fail (path[0] == '/', FALSE);
5064   _dbus_return_val_if_fail (vtable != NULL, FALSE);
5065
5066   if (!_dbus_decompose_path (path, strlen (path), &decomposed_path, NULL))
5067     return FALSE;
5068
5069   CONNECTION_LOCK (connection);
5070
5071   retval = _dbus_object_tree_register (connection->objects,
5072                                        FALSE,
5073                                        (const char **) decomposed_path, vtable,
5074                                        user_data);
5075
5076   CONNECTION_UNLOCK (connection);
5077
5078   dbus_free_string_array (decomposed_path);
5079
5080   return retval;
5081 }
5082
5083 /**
5084  * Registers a fallback handler for a given subsection of the object
5085  * hierarchy.  The given vtable handles messages at or below the given
5086  * path. You can use this to establish a default message handling
5087  * policy for a whole "subdirectory."
5088  *
5089  * @param connection the connection
5090  * @param path a '/' delimited string of path elements
5091  * @param vtable the virtual table
5092  * @param user_data data to pass to functions in the vtable
5093  * @returns #FALSE if not enough memory
5094  */
5095 dbus_bool_t
5096 dbus_connection_register_fallback (DBusConnection              *connection,
5097                                    const char                  *path,
5098                                    const DBusObjectPathVTable  *vtable,
5099                                    void                        *user_data)
5100 {
5101   char **decomposed_path;
5102   dbus_bool_t retval;
5103
5104   _dbus_return_val_if_fail (connection != NULL, FALSE);
5105   _dbus_return_val_if_fail (path != NULL, FALSE);
5106   _dbus_return_val_if_fail (path[0] == '/', FALSE);
5107   _dbus_return_val_if_fail (vtable != NULL, FALSE);
5108
5109   if (!_dbus_decompose_path (path, strlen (path), &decomposed_path, NULL))
5110     return FALSE;
5111
5112   CONNECTION_LOCK (connection);
5113
5114   retval = _dbus_object_tree_register (connection->objects,
5115                                        TRUE,
5116                                        (const char **) decomposed_path, vtable,
5117                                        user_data);
5118
5119   CONNECTION_UNLOCK (connection);
5120
5121   dbus_free_string_array (decomposed_path);
5122
5123   return retval;
5124 }
5125
5126 /**
5127  * Unregisters the handler registered with exactly the given path.
5128  * It's a bug to call this function for a path that isn't registered.
5129  * Can unregister both fallback paths and object paths.
5130  *
5131  * @param connection the connection
5132  * @param path a '/' delimited string of path elements
5133  * @returns #FALSE if not enough memory
5134  */
5135 dbus_bool_t
5136 dbus_connection_unregister_object_path (DBusConnection              *connection,
5137                                         const char                  *path)
5138 {
5139   char **decomposed_path;
5140
5141   _dbus_return_val_if_fail (connection != NULL, FALSE);
5142   _dbus_return_val_if_fail (path != NULL, FALSE);
5143   _dbus_return_val_if_fail (path[0] == '/', FALSE);
5144
5145   if (!_dbus_decompose_path (path, strlen (path), &decomposed_path, NULL))
5146       return FALSE;
5147
5148   CONNECTION_LOCK (connection);
5149
5150   _dbus_object_tree_unregister_and_unlock (connection->objects, (const char **) decomposed_path);
5151
5152   dbus_free_string_array (decomposed_path);
5153
5154   return TRUE;
5155 }
5156
5157 /**
5158  * Gets the user data passed to dbus_connection_register_object_path()
5159  * or dbus_connection_register_fallback(). If nothing was registered
5160  * at this path, the data is filled in with #NULL.
5161  *
5162  * @param connection the connection
5163  * @param path the path you registered with
5164  * @param data_p location to store the user data, or #NULL
5165  * @returns #FALSE if not enough memory
5166  */
5167 dbus_bool_t
5168 dbus_connection_get_object_path_data (DBusConnection *connection,
5169                                       const char     *path,
5170                                       void          **data_p)
5171 {
5172   char **decomposed_path;
5173
5174   _dbus_return_val_if_fail (connection != NULL, FALSE);
5175   _dbus_return_val_if_fail (path != NULL, FALSE);
5176   _dbus_return_val_if_fail (data_p != NULL, FALSE);
5177
5178   *data_p = NULL;
5179
5180   if (!_dbus_decompose_path (path, strlen (path), &decomposed_path, NULL))
5181     return FALSE;
5182
5183   CONNECTION_LOCK (connection);
5184
5185   *data_p = _dbus_object_tree_get_user_data_unlocked (connection->objects, (const char**) decomposed_path);
5186
5187   CONNECTION_UNLOCK (connection);
5188
5189   dbus_free_string_array (decomposed_path);
5190
5191   return TRUE;
5192 }
5193
5194 /**
5195  * Lists the registered fallback handlers and object path handlers at
5196  * the given parent_path. The returned array should be freed with
5197  * dbus_free_string_array().
5198  *
5199  * @param connection the connection
5200  * @param parent_path the path to list the child handlers of
5201  * @param child_entries returns #NULL-terminated array of children
5202  * @returns #FALSE if no memory to allocate the child entries
5203  */
5204 dbus_bool_t
5205 dbus_connection_list_registered (DBusConnection              *connection,
5206                                  const char                  *parent_path,
5207                                  char                      ***child_entries)
5208 {
5209   char **decomposed_path;
5210   dbus_bool_t retval;
5211   _dbus_return_val_if_fail (connection != NULL, FALSE);
5212   _dbus_return_val_if_fail (parent_path != NULL, FALSE);
5213   _dbus_return_val_if_fail (parent_path[0] == '/', FALSE);
5214   _dbus_return_val_if_fail (child_entries != NULL, FALSE);
5215
5216   if (!_dbus_decompose_path (parent_path, strlen (parent_path), &decomposed_path, NULL))
5217     return FALSE;
5218
5219   CONNECTION_LOCK (connection);
5220
5221   retval = _dbus_object_tree_list_registered_and_unlock (connection->objects,
5222                                                          (const char **) decomposed_path,
5223                                                          child_entries);
5224   dbus_free_string_array (decomposed_path);
5225
5226   return retval;
5227 }
5228
5229 static DBusDataSlotAllocator slot_allocator;
5230 _DBUS_DEFINE_GLOBAL_LOCK (connection_slots);
5231
5232 /**
5233  * Allocates an integer ID to be used for storing application-specific
5234  * data on any DBusConnection. The allocated ID may then be used
5235  * with dbus_connection_set_data() and dbus_connection_get_data().
5236  * The passed-in slot must be initialized to -1, and is filled in
5237  * with the slot ID. If the passed-in slot is not -1, it's assumed
5238  * to be already allocated, and its refcount is incremented.
5239  *
5240  * The allocated slot is global, i.e. all DBusConnection objects will
5241  * have a slot with the given integer ID reserved.
5242  *
5243  * @param slot_p address of a global variable storing the slot
5244  * @returns #FALSE on failure (no memory)
5245  */
5246 dbus_bool_t
5247 dbus_connection_allocate_data_slot (dbus_int32_t *slot_p)
5248 {
5249   return _dbus_data_slot_allocator_alloc (&slot_allocator,
5250                                           &_DBUS_LOCK_NAME (connection_slots),
5251                                           slot_p);
5252 }
5253
5254 /**
5255  * Deallocates a global ID for connection data slots.
5256  * dbus_connection_get_data() and dbus_connection_set_data() may no
5257  * longer be used with this slot.  Existing data stored on existing
5258  * DBusConnection objects will be freed when the connection is
5259  * finalized, but may not be retrieved (and may only be replaced if
5260  * someone else reallocates the slot).  When the refcount on the
5261  * passed-in slot reaches 0, it is set to -1.
5262  *
5263  * @param slot_p address storing the slot to deallocate
5264  */
5265 void
5266 dbus_connection_free_data_slot (dbus_int32_t *slot_p)
5267 {
5268   _dbus_return_if_fail (*slot_p >= 0);
5269
5270   _dbus_data_slot_allocator_free (&slot_allocator, slot_p);
5271 }
5272
5273 /**
5274  * Stores a pointer on a DBusConnection, along
5275  * with an optional function to be used for freeing
5276  * the data when the data is set again, or when
5277  * the connection is finalized. The slot number
5278  * must have been allocated with dbus_connection_allocate_data_slot().
5279  *
5280  * @param connection the connection
5281  * @param slot the slot number
5282  * @param data the data to store
5283  * @param free_data_func finalizer function for the data
5284  * @returns #TRUE if there was enough memory to store the data
5285  */
5286 dbus_bool_t
5287 dbus_connection_set_data (DBusConnection   *connection,
5288                           dbus_int32_t      slot,
5289                           void             *data,
5290                           DBusFreeFunction  free_data_func)
5291 {
5292   DBusFreeFunction old_free_func;
5293   void *old_data;
5294   dbus_bool_t retval;
5295
5296   _dbus_return_val_if_fail (connection != NULL, FALSE);
5297   _dbus_return_val_if_fail (slot >= 0, FALSE);
5298
5299   CONNECTION_LOCK (connection);
5300
5301   retval = _dbus_data_slot_list_set (&slot_allocator,
5302                                      &connection->slot_list,
5303                                      slot, data, free_data_func,
5304                                      &old_free_func, &old_data);
5305
5306   CONNECTION_UNLOCK (connection);
5307
5308   if (retval)
5309     {
5310       /* Do the actual free outside the connection lock */
5311       if (old_free_func)
5312         (* old_free_func) (old_data);
5313     }
5314
5315   return retval;
5316 }
5317
5318 /**
5319  * Retrieves data previously set with dbus_connection_set_data().
5320  * The slot must still be allocated (must not have been freed).
5321  *
5322  * @param connection the connection
5323  * @param slot the slot to get data from
5324  * @returns the data, or #NULL if not found
5325  */
5326 void*
5327 dbus_connection_get_data (DBusConnection   *connection,
5328                           dbus_int32_t      slot)
5329 {
5330   void *res;
5331
5332   _dbus_return_val_if_fail (connection != NULL, NULL);
5333
5334   CONNECTION_LOCK (connection);
5335
5336   res = _dbus_data_slot_list_get (&slot_allocator,
5337                                   &connection->slot_list,
5338                                   slot);
5339
5340   CONNECTION_UNLOCK (connection);
5341
5342   return res;
5343 }
5344
5345 /**
5346  * This function sets a global flag for whether dbus_connection_new()
5347  * will set SIGPIPE behavior to SIG_IGN.
5348  *
5349  * @param will_modify_sigpipe #TRUE to allow sigpipe to be set to SIG_IGN
5350  */
5351 void
5352 dbus_connection_set_change_sigpipe (dbus_bool_t will_modify_sigpipe)
5353 {
5354   _dbus_modify_sigpipe = will_modify_sigpipe != FALSE;
5355 }
5356
5357 /**
5358  * Specifies the maximum size message this connection is allowed to
5359  * receive. Larger messages will result in disconnecting the
5360  * connection.
5361  *
5362  * @param connection a #DBusConnection
5363  * @param size maximum message size the connection can receive, in bytes
5364  */
5365 void
5366 dbus_connection_set_max_message_size (DBusConnection *connection,
5367                                       long            size)
5368 {
5369   _dbus_return_if_fail (connection != NULL);
5370
5371   CONNECTION_LOCK (connection);
5372   _dbus_transport_set_max_message_size (connection->transport,
5373                                         size);
5374   CONNECTION_UNLOCK (connection);
5375 }
5376
5377 /**
5378  * Gets the value set by dbus_connection_set_max_message_size().
5379  *
5380  * @param connection the connection
5381  * @returns the max size of a single message
5382  */
5383 long
5384 dbus_connection_get_max_message_size (DBusConnection *connection)
5385 {
5386   long res;
5387
5388   _dbus_return_val_if_fail (connection != NULL, 0);
5389
5390   CONNECTION_LOCK (connection);
5391   res = _dbus_transport_get_max_message_size (connection->transport);
5392   CONNECTION_UNLOCK (connection);
5393   return res;
5394 }
5395
5396 /**
5397  * Sets the maximum total number of bytes that can be used for all messages
5398  * received on this connection. Messages count toward the maximum until
5399  * they are finalized. When the maximum is reached, the connection will
5400  * not read more data until some messages are finalized.
5401  *
5402  * The semantics of the maximum are: if outstanding messages are
5403  * already above the maximum, additional messages will not be read.
5404  * The semantics are not: if the next message would cause us to exceed
5405  * the maximum, we don't read it. The reason is that we don't know the
5406  * size of a message until after we read it.
5407  *
5408  * Thus, the max live messages size can actually be exceeded
5409  * by up to the maximum size of a single message.
5410  *
5411  * Also, if we read say 1024 bytes off the wire in a single read(),
5412  * and that contains a half-dozen small messages, we may exceed the
5413  * size max by that amount. But this should be inconsequential.
5414  *
5415  * This does imply that we can't call read() with a buffer larger
5416  * than we're willing to exceed this limit by.
5417  *
5418  * @param connection the connection
5419  * @param size the maximum size in bytes of all outstanding messages
5420  */
5421 void
5422 dbus_connection_set_max_received_size (DBusConnection *connection,
5423                                        long            size)
5424 {
5425   _dbus_return_if_fail (connection != NULL);
5426
5427   CONNECTION_LOCK (connection);
5428   _dbus_transport_set_max_received_size (connection->transport,
5429                                          size);
5430   CONNECTION_UNLOCK (connection);
5431 }
5432
5433 /**
5434  * Gets the value set by dbus_connection_set_max_received_size().
5435  *
5436  * @param connection the connection
5437  * @returns the max size of all live messages
5438  */
5439 long
5440 dbus_connection_get_max_received_size (DBusConnection *connection)
5441 {
5442   long res;
5443
5444   _dbus_return_val_if_fail (connection != NULL, 0);
5445
5446   CONNECTION_LOCK (connection);
5447   res = _dbus_transport_get_max_received_size (connection->transport);
5448   CONNECTION_UNLOCK (connection);
5449   return res;
5450 }
5451
5452 /**
5453  * Gets the approximate size in bytes of all messages in the outgoing
5454  * message queue. The size is approximate in that you shouldn't use
5455  * it to decide how many bytes to read off the network or anything
5456  * of that nature, as optimizations may choose to tell small white lies
5457  * to avoid performance overhead.
5458  *
5459  * @param connection the connection
5460  * @returns the number of bytes that have been queued up but not sent
5461  */
5462 long
5463 dbus_connection_get_outgoing_size (DBusConnection *connection)
5464 {
5465   long res;
5466
5467   _dbus_return_val_if_fail (connection != NULL, 0);
5468
5469   CONNECTION_LOCK (connection);
5470   res = _dbus_counter_get_value (connection->outgoing_counter);
5471   CONNECTION_UNLOCK (connection);
5472   return res;
5473 }
5474
5475 /**
5476  * Obtains the machine UUID of the machine this process is running on.
5477  *
5478  * The returned string must be freed with dbus_free().
5479  *
5480  * This UUID is guaranteed to remain the same until the next reboot
5481  * (unless the sysadmin foolishly changes it and screws themselves).
5482  * It will usually remain the same across reboots also, but hardware
5483  * configuration changes or rebuilding the machine could break that.
5484  *
5485  * The idea is that two processes with the same machine ID should be
5486  * able to use shared memory, UNIX domain sockets, process IDs, and other
5487  * features of the OS that require both processes to be running
5488  * on the same OS kernel instance.
5489  *
5490  * The machine ID can also be used to create unique per-machine
5491  * instances. For example, you could use it in bus names or
5492  * X selection names.
5493  *
5494  * The machine ID is preferred over the machine hostname, because
5495  * the hostname is frequently set to "localhost.localdomain" and
5496  * may also change at runtime.
5497  *
5498  * You can get the machine ID of a remote application by invoking the
5499  * method GetMachineId from interface org.freedesktop.DBus.Peer.
5500  *
5501  * If the remote application has the same machine ID as the one
5502  * returned by this function, then the remote application is on the
5503  * same machine as your application.
5504  *
5505  * @returns a 32-byte-long hex-encoded UUID string, or #NULL if insufficient memory
5506  */
5507 char*
5508 dbus_get_local_machine_id (void)
5509 {
5510   DBusString uuid;
5511   char *s;
5512
5513   s = NULL;
5514   _dbus_string_init (&uuid);
5515   if (!_dbus_get_local_machine_uuid_encoded (&uuid) ||
5516       !_dbus_string_steal_data (&uuid, &s))
5517     {
5518       _dbus_string_free (&uuid);
5519       return FALSE;
5520     }
5521   else
5522     {
5523       _dbus_string_free (&uuid);
5524       return s;
5525     }
5526
5527 }
5528
5529 /** @} */