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  *
 537  * @param connection the connection.
 538  * @returns #TRUE if the outgoing queue is non-empty.
 539  */
 540 dbus_bool_t
 541 dbus_connection_has_messages_to_send (DBusConnection *connection)
 542 {
 543   dbus_bool_t v;
 544
 545   _dbus_return_val_if_fail (connection != NULL, FALSE);
 546
 547   CONNECTION_LOCK (connection);
 548   v = _dbus_connection_has_messages_to_send_unlocked (connection);
 549   CONNECTION_UNLOCK (connection);
 550
 551   return v;
 552 }
 553
 554 /**
 555  * Gets the next outgoing message. The message remains in the
 556  * queue, and the caller does not own a reference to it.
 557  *
 558  * @param connection the connection.
 559  * @returns the message to be sent.
 560  */
 561 DBusMessage*
 562 _dbus_connection_get_message_to_send (DBusConnection *connection)
 563 {
 564   HAVE_LOCK_CHECK (connection);
 565
 566   return _dbus_list_get_last (&connection->outgoing_messages);
 567 }
 568
 569 /**
 570  * Notifies the connection that a message has been sent, so the
 571  * message can be removed from the outgoing queue.
 572  * Called with the connection lock held.
 573  *
 574  * @param connection the connection.
 575  * @param message the message that was sent.
 576  */
 577 void
 578 _dbus_connection_message_sent (DBusConnection *connection,
 579                                DBusMessage    *message)
 580 {
 581   DBusList *link;
 582
 583   HAVE_LOCK_CHECK (connection);
 584
 585   /* This can be called before we even complete authentication, since
 586    * it's called on disconnect to clean up the outgoing queue.
 587    * It's also called as we successfully send each message.
 588    */
 589
 590   link = _dbus_list_get_last_link (&connection->outgoing_messages);
 591   _dbus_assert (link != NULL);
 592   _dbus_assert (link->data == message);
 593
 594   /* Save this link in the link cache */
 595   _dbus_list_unlink (&connection->outgoing_messages,
 596                      link);
 597   _dbus_list_prepend_link (&connection->link_cache, link);
 598
 599   connection->n_outgoing -= 1;
 600
 601   _dbus_verbose ("Message %p (%d %s %s %s '%s') removed from outgoing queue %p, %d left to send\n",
 602                  message,
 603                  dbus_message_get_type (message),
 604                  dbus_message_get_path (message) ?
 605                  dbus_message_get_path (message) :
 606                  "no path",
 607                  dbus_message_get_interface (message) ?
 608                  dbus_message_get_interface (message) :
 609                  "no interface",
 610                  dbus_message_get_member (message) ?
 611                  dbus_message_get_member (message) :
 612                  "no member",
 613                  dbus_message_get_signature (message),
 614                  connection, connection->n_outgoing);
 615
 616   /* Save this link in the link cache also */
 617   _dbus_message_remove_size_counter (message, connection->outgoing_counter,
 618                                      &link);
 619   _dbus_list_prepend_link (&connection->link_cache, link);
 620
 621   dbus_message_unref (message);
 622 }
 623
 624 /** Function to be called in protected_change_watch() with refcount held */
 625 typedef dbus_bool_t (* DBusWatchAddFunction)     (DBusWatchList *list,
 626                                                   DBusWatch     *watch);
 627 /** Function to be called in protected_change_watch() with refcount held */
 628 typedef void        (* DBusWatchRemoveFunction)  (DBusWatchList *list,
 629                                                   DBusWatch     *watch);
 630 /** Function to be called in protected_change_watch() with refcount held */
 631 typedef void        (* DBusWatchToggleFunction)  (DBusWatchList *list,
 632                                                   DBusWatch     *watch,
 633                                                   dbus_bool_t    enabled);
 634
 635 static dbus_bool_t
 636 protected_change_watch (DBusConnection         *connection,
 637                         DBusWatch              *watch,
 638                         DBusWatchAddFunction    add_function,
 639                         DBusWatchRemoveFunction remove_function,
 640                         DBusWatchToggleFunction toggle_function,
 641                         dbus_bool_t             enabled)
 642 {
 643   DBusWatchList *watches;
 644   dbus_bool_t retval;
 645
 646   HAVE_LOCK_CHECK (connection);
 647
 648   /* This isn't really safe or reasonable; a better pattern is the "do everything, then
 649    * drop lock and call out" one; but it has to be propagated up through all callers
 650    */
 651
 652   watches = connection->watches;
 653   if (watches)
 654     {
 655       connection->watches = NULL;
 656       _dbus_connection_ref_unlocked (connection);
 657       CONNECTION_UNLOCK (connection);
 658
 659       if (add_function)
 660         retval = (* add_function) (watches, watch);
 661       else if (remove_function)
 662         {
 663           retval = TRUE;
 664           (* remove_function) (watches, watch);
 665         }
 666       else
 667         {
 668           retval = TRUE;
 669           (* toggle_function) (watches, watch, enabled);
 670         }
 671
 672       CONNECTION_LOCK (connection);
 673       connection->watches = watches;
 674       _dbus_connection_unref_unlocked (connection);
 675
 676       return retval;
 677     }
 678   else
 679     return FALSE;
 680 }
 681
 682
 683 /**
 684  * Adds a watch using the connection's DBusAddWatchFunction if
 685  * available. Otherwise records the watch to be added when said
 686  * function is available. Also re-adds the watch if the
 687  * DBusAddWatchFunction changes. May fail due to lack of memory.
 688  * Connection lock should be held when calling this.
 689  *
 690  * @param connection the connection.
 691  * @param watch the watch to add.
 692  * @returns #TRUE on success.
 693  */
 694 dbus_bool_t
 695 _dbus_connection_add_watch_unlocked (DBusConnection *connection,
 696                                      DBusWatch      *watch)
 697 {
 698   return protected_change_watch (connection, watch,
 699                                  _dbus_watch_list_add_watch,
 700                                  NULL, NULL, FALSE);
 701 }
 702
 703 /**
 704  * Removes a watch using the connection's DBusRemoveWatchFunction
 705  * if available. It's an error to call this function on a watch
 706  * that was not previously added.
 707  * Connection lock should be held when calling this.
 708  *
 709  * @param connection the connection.
 710  * @param watch the watch to remove.
 711  */
 712 void
 713 _dbus_connection_remove_watch_unlocked (DBusConnection *connection,
 714                                         DBusWatch      *watch)
 715 {
 716   protected_change_watch (connection, watch,
 717                           NULL,
 718                           _dbus_watch_list_remove_watch,
 719                           NULL, FALSE);
 720 }
 721
 722 /**
 723  * Toggles a watch and notifies app via connection's
 724  * DBusWatchToggledFunction if available. It's an error to call this
 725  * function on a watch that was not previously added.
 726  * Connection lock should be held when calling this.
 727  *
 728  * @param connection the connection.
 729  * @param watch the watch to toggle.
 730  * @param enabled whether to enable or disable
 731  */
 732 void
 733 _dbus_connection_toggle_watch_unlocked (DBusConnection *connection,
 734                                         DBusWatch      *watch,
 735                                         dbus_bool_t     enabled)
 736 {
 737   _dbus_assert (watch != NULL);
 738
 739   protected_change_watch (connection, watch,
 740                           NULL, NULL,
 741                           _dbus_watch_list_toggle_watch,
 742                           enabled);
 743 }
 744
 745 /** Function to be called in protected_change_timeout() with refcount held */
 746 typedef dbus_bool_t (* DBusTimeoutAddFunction)    (DBusTimeoutList *list,
 747                                                    DBusTimeout     *timeout);
 748 /** Function to be called in protected_change_timeout() with refcount held */
 749 typedef void        (* DBusTimeoutRemoveFunction) (DBusTimeoutList *list,
 750                                                    DBusTimeout     *timeout);
 751 /** Function to be called in protected_change_timeout() with refcount held */
 752 typedef void        (* DBusTimeoutToggleFunction) (DBusTimeoutList *list,
 753                                                    DBusTimeout     *timeout,
 754                                                    dbus_bool_t      enabled);
 755
 756 static dbus_bool_t
 757 protected_change_timeout (DBusConnection           *connection,
 758                           DBusTimeout              *timeout,
 759                           DBusTimeoutAddFunction    add_function,
 760                           DBusTimeoutRemoveFunction remove_function,
 761                           DBusTimeoutToggleFunction toggle_function,
 762                           dbus_bool_t               enabled)
 763 {
 764   DBusTimeoutList *timeouts;
 765   dbus_bool_t retval;
 766
 767   HAVE_LOCK_CHECK (connection);
 768
 769   /* This isn't really safe or reasonable; a better pattern is the "do everything, then
 770    * drop lock and call out" one; but it has to be propagated up through all callers
 771    */
 772
 773   timeouts = connection->timeouts;
 774   if (timeouts)
 775     {
 776       connection->timeouts = NULL;
 777       _dbus_connection_ref_unlocked (connection);
 778       CONNECTION_UNLOCK (connection);
 779
 780       if (add_function)
 781         retval = (* add_function) (timeouts, timeout);
 782       else if (remove_function)
 783         {
 784           retval = TRUE;
 785           (* remove_function) (timeouts, timeout);
 786         }
 787       else
 788         {
 789           retval = TRUE;
 790           (* toggle_function) (timeouts, timeout, enabled);
 791         }
 792
 793       CONNECTION_LOCK (connection);
 794       connection->timeouts = timeouts;
 795       _dbus_connection_unref_unlocked (connection);
 796
 797       return retval;
 798     }
 799   else
 800     return FALSE;
 801 }
 802
 803 /**
 804  * Adds a timeout using the connection's DBusAddTimeoutFunction if
 805  * available. Otherwise records the timeout to be added when said
 806  * function is available. Also re-adds the timeout if the
 807  * DBusAddTimeoutFunction changes. May fail due to lack of memory.
 808  * The timeout will fire repeatedly until removed.
 809  * Connection lock should be held when calling this.
 810  *
 811  * @param connection the connection.
 812  * @param timeout the timeout to add.
 813  * @returns #TRUE on success.
 814  */
 815 dbus_bool_t
 816 _dbus_connection_add_timeout_unlocked (DBusConnection *connection,
 817                                        DBusTimeout    *timeout)
 818 {
 819   return protected_change_timeout (connection, timeout,
 820                                    _dbus_timeout_list_add_timeout,
 821                                    NULL, NULL, FALSE);
 822 }
 823
 824 /**
 825  * Removes a timeout using the connection's DBusRemoveTimeoutFunction
 826  * if available. It's an error to call this function on a timeout
 827  * that was not previously added.
 828  * Connection lock should be held when calling this.
 829  *
 830  * @param connection the connection.
 831  * @param timeout the timeout to remove.
 832  */
 833 void
 834 _dbus_connection_remove_timeout_unlocked (DBusConnection *connection,
 835                                           DBusTimeout    *timeout)
 836 {
 837   protected_change_timeout (connection, timeout,
 838                             NULL,
 839                             _dbus_timeout_list_remove_timeout,
 840                             NULL, FALSE);
 841 }
 842
 843 /**
 844  * Toggles a timeout and notifies app via connection's
 845  * DBusTimeoutToggledFunction if available. It's an error to call this
 846  * function on a timeout that was not previously added.
 847  * Connection lock should be held when calling this.
 848  *
 849  * @param connection the connection.
 850  * @param timeout the timeout to toggle.
 851  * @param enabled whether to enable or disable
 852  */
 853 void
 854 _dbus_connection_toggle_timeout_unlocked (DBusConnection   *connection,
 855                                           DBusTimeout      *timeout,
 856                                           dbus_bool_t       enabled)
 857 {
 858   protected_change_timeout (connection, timeout,
 859                             NULL, NULL,
 860                             _dbus_timeout_list_toggle_timeout,
 861                             enabled);
 862 }
 863
 864 static dbus_bool_t
 865 _dbus_connection_attach_pending_call_unlocked (DBusConnection  *connection,
 866                                                DBusPendingCall *pending)
 867 {
 868   dbus_uint32_t reply_serial;
 869   DBusTimeout *timeout;
 870
 871   HAVE_LOCK_CHECK (connection);
 872
 873   reply_serial = _dbus_pending_call_get_reply_serial_unlocked (pending);
 874
 875   _dbus_assert (reply_serial != 0);
 876
 877   timeout = _dbus_pending_call_get_timeout_unlocked (pending);
 878
 879   if (!_dbus_connection_add_timeout_unlocked (connection, timeout))
 880     return FALSE;
 881
 882   if (!_dbus_hash_table_insert_int (connection->pending_replies,
 883                                     reply_serial,
 884                                     pending))
 885     {
 886       _dbus_connection_remove_timeout_unlocked (connection, timeout);
 887
 888       _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
 889       HAVE_LOCK_CHECK (connection);
 890       return FALSE;
 891     }
 892
 893   _dbus_pending_call_set_timeout_added_unlocked (pending, TRUE);
 894
 895   _dbus_pending_call_ref_unlocked (pending);
 896
 897   HAVE_LOCK_CHECK (connection);
 898
 899   return TRUE;
 900 }
 901
 902 static void
 903 free_pending_call_on_hash_removal (void *data)
 904 {
 905   DBusPendingCall *pending;
 906   DBusConnection  *connection;
 907
 908   if (data == NULL)
 909     return;
 910
 911   pending = data;
 912
 913   connection = _dbus_pending_call_get_connection_unlocked (pending);
 914
 915   HAVE_LOCK_CHECK (connection);
 916
 917   if (_dbus_pending_call_is_timeout_added_unlocked (pending))
 918     {
 919       _dbus_connection_remove_timeout_unlocked (connection,
 920                                                 _dbus_pending_call_get_timeout_unlocked (pending));
 921
 922       _dbus_pending_call_set_timeout_added_unlocked (pending, FALSE);
 923     }
 924
 925   /* FIXME 1.0? this is sort of dangerous and undesirable to drop the lock
 926    * here, but the pending call finalizer could in principle call out to
 927    * application code so we pretty much have to... some larger code reorg
 928    * might be needed.
 929    */
 930   _dbus_connection_ref_unlocked (connection);
 931   _dbus_pending_call_unref_and_unlock (pending);
 932   CONNECTION_LOCK (connection);
 933   _dbus_connection_unref_unlocked (connection);
 934 }
 935
 936 static void
 937 _dbus_connection_detach_pending_call_unlocked (DBusConnection  *connection,
 938                                                DBusPendingCall *pending)
 939 {
 940   /* This ends up unlocking to call the pending call finalizer, which is unexpected to
 941    * say the least.
 942    */
 943   _dbus_hash_table_remove_int (connection->pending_replies,
 944                                _dbus_pending_call_get_reply_serial_unlocked (pending));
 945 }
 946
 947 static void
 948 _dbus_connection_detach_pending_call_and_unlock (DBusConnection  *connection,
 949                                                  DBusPendingCall *pending)
 950 {
 951   /* The idea here is to avoid finalizing the pending call
 952    * with the lock held, since there's a destroy notifier
 953    * in pending call that goes out to application code.
 954    *
 955    * There's an extra unlock inside the hash table
 956    * "free pending call" function FIXME...
 957    */
 958   _dbus_pending_call_ref_unlocked (pending);
 959   _dbus_hash_table_remove_int (connection->pending_replies,
 960                                _dbus_pending_call_get_reply_serial_unlocked (pending));
 961   _dbus_pending_call_unref_and_unlock (pending);
 962 }
 963
 964 /**
 965  * Removes a pending call from the connection, such that
 966  * the pending reply will be ignored. May drop the last
 967  * reference to the pending call.
 968  *
 969  * @param connection the connection
 970  * @param pending the pending call
 971  */
 972 void
 973 _dbus_connection_remove_pending_call (DBusConnection  *connection,
 974                                       DBusPendingCall *pending)
 975 {
 976   CONNECTION_LOCK (connection);
 977   _dbus_connection_detach_pending_call_and_unlock (connection, pending);
 978 }
 979
 980 /**
 981  * Acquire the transporter I/O path. This must be done before
 982  * doing any I/O in the transporter. May sleep and drop the
 983  * IO path mutex while waiting for the I/O path.
 984  *
 985  * @param connection the connection.
 986  * @param timeout_milliseconds maximum blocking time, or -1 for no limit.
 987  * @returns TRUE if the I/O path was acquired.
 988  */
 989 static dbus_bool_t
 990 _dbus_connection_acquire_io_path (DBusConnection *connection,
 991                                   int timeout_milliseconds)
 992 {
 993   dbus_bool_t we_acquired;
 994
 995   HAVE_LOCK_CHECK (connection);
 996
 997   /* We don't want the connection to vanish */
 998   _dbus_connection_ref_unlocked (connection);
 999
1000   /* We will only touch io_path_acquired which is protected by our mutex */
1001   CONNECTION_UNLOCK (connection);
1002
1003   _dbus_verbose ("%s locking io_path_mutex\n", _DBUS_FUNCTION_NAME);
1004   _dbus_mutex_lock (connection->io_path_mutex);
1005
1006   _dbus_verbose ("%s start connection->io_path_acquired = %d timeout = %d\n",
1007                  _DBUS_FUNCTION_NAME, connection->io_path_acquired, timeout_milliseconds);
1008
1009   we_acquired = FALSE;
1010
1011   if (connection->io_path_acquired)
1012     {
1013       if (timeout_milliseconds != -1)
1014         {
1015           _dbus_verbose ("%s waiting %d for IO path to be acquirable\n",
1016                          _DBUS_FUNCTION_NAME, timeout_milliseconds);
1017           _dbus_condvar_wait_timeout (connection->io_path_cond,
1018                                       connection->io_path_mutex,
1019                                       timeout_milliseconds);
1020         }
1021       else
1022         {
1023           while (connection->io_path_acquired)
1024             {
1025               _dbus_verbose ("%s waiting for IO path to be acquirable\n", _DBUS_FUNCTION_NAME);
1026               _dbus_condvar_wait (connection->io_path_cond,
1027                                   connection->io_path_mutex);
1028             }
1029         }
1030     }
1031
1032   if (!connection->io_path_acquired)
1033     {
1034       we_acquired = TRUE;
1035       connection->io_path_acquired = TRUE;
1036     }
1037
1038   _dbus_verbose ("%s end connection->io_path_acquired = %d we_acquired = %d\n",
1039                  _DBUS_FUNCTION_NAME, connection->io_path_acquired, we_acquired);
1040
1041   _dbus_verbose ("%s unlocking io_path_mutex\n", _DBUS_FUNCTION_NAME);
1042   _dbus_mutex_unlock (connection->io_path_mutex);
1043
1044   CONNECTION_LOCK (connection);
1045
1046   HAVE_LOCK_CHECK (connection);
1047
1048   _dbus_connection_unref_unlocked (connection);
1049
1050   return we_acquired;
1051 }
1052
1053 /**
1054  * Release the I/O path when you're done with it. Only call
1055  * after you've acquired the I/O. Wakes up at most one thread
1056  * currently waiting to acquire the I/O path.
1057  *
1058  * @param connection the connection.
1059  */
1060 static void
1061 _dbus_connection_release_io_path (DBusConnection *connection)
1062 {
1063   HAVE_LOCK_CHECK (connection);
1064
1065   _dbus_verbose ("%s locking io_path_mutex\n", _DBUS_FUNCTION_NAME);
1066   _dbus_mutex_lock (connection->io_path_mutex);
1067
1068   _dbus_assert (connection->io_path_acquired);
1069
1070   _dbus_verbose ("%s start connection->io_path_acquired = %d\n",
1071                  _DBUS_FUNCTION_NAME, connection->io_path_acquired);
1072
1073   connection->io_path_acquired = FALSE;
1074   _dbus_condvar_wake_one (connection->io_path_cond);
1075
1076   _dbus_verbose ("%s unlocking io_path_mutex\n", _DBUS_FUNCTION_NAME);
1077   _dbus_mutex_unlock (connection->io_path_mutex);
1078 }
1079
1080 /**
1081  * Queues incoming messages and sends outgoing messages for this
1082  * connection, optionally blocking in the process. Each call to
1083  * _dbus_connection_do_iteration_unlocked() will call select() or poll() one
1084  * time and then read or write data if possible.
1085  *
1086  * The purpose of this function is to be able to flush outgoing
1087  * messages or queue up incoming messages without returning
1088  * control to the application and causing reentrancy weirdness.
1089  *
1090  * The flags parameter allows you to specify whether to
1091  * read incoming messages, write outgoing messages, or both,
1092  * and whether to block if no immediate action is possible.
1093  *
1094  * The timeout_milliseconds parameter does nothing unless the
1095  * iteration is blocking.
1096  *
1097  * If there are no outgoing messages and DBUS_ITERATION_DO_READING
1098  * wasn't specified, then it's impossible to block, even if
1099  * you specify DBUS_ITERATION_BLOCK; in that case the function
1100  * returns immediately.
1101  *
1102  * Called with connection lock held.
1103  *
1104  * @param connection the connection.
1105  * @param flags iteration flags.
1106  * @param timeout_milliseconds maximum blocking time, or -1 for no limit.
1107  */
1108 void
1109 _dbus_connection_do_iteration_unlocked (DBusConnection *connection,
1110                                         unsigned int    flags,
1111                                         int             timeout_milliseconds)
1112 {
1113   _dbus_verbose ("%s start\n", _DBUS_FUNCTION_NAME);
1114
1115   HAVE_LOCK_CHECK (connection);
1116
1117   if (connection->n_outgoing == 0)
1118     flags &= ~DBUS_ITERATION_DO_WRITING;
1119
1120   if (_dbus_connection_acquire_io_path (connection,
1121                                         (flags & DBUS_ITERATION_BLOCK) ? timeout_milliseconds : 0))
1122     {
1123       HAVE_LOCK_CHECK (connection);
1124
1125       _dbus_transport_do_iteration (connection->transport,
1126                                     flags, timeout_milliseconds);
1127       _dbus_connection_release_io_path (connection);
1128     }
1129
1130   HAVE_LOCK_CHECK (connection);
1131
1132   _dbus_verbose ("%s end\n", _DBUS_FUNCTION_NAME);
1133 }
1134
1135 /**
1136  * Creates a new connection for the given transport.  A transport
1137  * represents a message stream that uses some concrete mechanism, such
1138  * as UNIX domain sockets. May return #NULL if insufficient
1139  * memory exists to create the connection.
1140  *
1141  * @param transport the transport.
1142  * @returns the new connection, or #NULL on failure.
1143  */
1144 DBusConnection*
1145 _dbus_connection_new_for_transport (DBusTransport *transport)
1146 {
1147   DBusConnection *connection;
1148   DBusWatchList *watch_list;
1149   DBusTimeoutList *timeout_list;
1150   DBusHashTable *pending_replies;
1151   DBusList *disconnect_link;
1152   DBusMessage *disconnect_message;
1153   DBusCounter *outgoing_counter;
1154   DBusObjectTree *objects;
1155
1156   watch_list = NULL;
1157   connection = NULL;
1158   pending_replies = NULL;
1159   timeout_list = NULL;
1160   disconnect_link = NULL;
1161   disconnect_message = NULL;
1162   outgoing_counter = NULL;
1163   objects = NULL;
1164
1165   watch_list = _dbus_watch_list_new ();
1166   if (watch_list == NULL)
1167     goto error;
1168
1169   timeout_list = _dbus_timeout_list_new ();
1170   if (timeout_list == NULL)
1171     goto error;
1172
1173   pending_replies =
1174     _dbus_hash_table_new (DBUS_HASH_INT,
1175                           NULL,
1176                           (DBusFreeFunction)free_pending_call_on_hash_removal);
1177   if (pending_replies == NULL)
1178     goto error;
1179
1180   connection = dbus_new0 (DBusConnection, 1);
1181   if (connection == NULL)
1182     goto error;
1183
1184   _dbus_mutex_new_at_location (&connection->mutex);
1185   if (connection->mutex == NULL)
1186     goto error;
1187
1188   _dbus_mutex_new_at_location (&connection->io_path_mutex);
1189   if (connection->io_path_mutex == NULL)
1190     goto error;
1191
1192   _dbus_mutex_new_at_location (&connection->dispatch_mutex);
1193   if (connection->dispatch_mutex == NULL)
1194     goto error;
1195
1196   _dbus_condvar_new_at_location (&connection->dispatch_cond);
1197   if (connection->dispatch_cond == NULL)
1198     goto error;
1199
1200   _dbus_condvar_new_at_location (&connection->io_path_cond);
1201   if (connection->io_path_cond == NULL)
1202     goto error;
1203
1204   disconnect_message = dbus_message_new_signal (DBUS_PATH_LOCAL,
1205                                                 DBUS_INTERFACE_LOCAL,
1206                                                 "Disconnected");
1207
1208   if (disconnect_message == NULL)
1209     goto error;
1210
1211   disconnect_link = _dbus_list_alloc_link (disconnect_message);
1212   if (disconnect_link == NULL)
1213     goto error;
1214
1215   outgoing_counter = _dbus_counter_new ();
1216   if (outgoing_counter == NULL)
1217     goto error;
1218
1219   objects = _dbus_object_tree_new (connection);
1220   if (objects == NULL)
1221     goto error;
1222
1223   if (_dbus_modify_sigpipe)
1224     _dbus_disable_sigpipe ();
1225
1226   connection->refcount.value = 1;
1227   connection->transport = transport;
1228   connection->watches = watch_list;
1229   connection->timeouts = timeout_list;
1230   connection->pending_replies = pending_replies;
1231   connection->outgoing_counter = outgoing_counter;
1232   connection->filter_list = NULL;
1233   connection->last_dispatch_status = DBUS_DISPATCH_COMPLETE; /* so we're notified first time there's data */
1234   connection->objects = objects;
1235   connection->exit_on_disconnect = FALSE;
1236   connection->shareable = FALSE;
1237   connection->route_peer_messages = FALSE;
1238   connection->disconnected_message_arrived = FALSE;
1239   connection->disconnected_message_processed = FALSE;
1240
1241 #ifndef DBUS_DISABLE_CHECKS
1242   connection->generation = _dbus_current_generation;
1243 #endif
1244
1245   _dbus_data_slot_list_init (&connection->slot_list);
1246
1247   connection->client_serial = 1;
1248
1249   connection->disconnect_message_link = disconnect_link;
1250
1251   CONNECTION_LOCK (connection);
1252
1253   if (!_dbus_transport_set_connection (transport, connection))
1254     {
1255       CONNECTION_UNLOCK (connection);
1256
1257       goto error;
1258     }
1259
1260   _dbus_transport_ref (transport);
1261
1262   CONNECTION_UNLOCK (connection);
1263
1264   return connection;
1265
1266  error:
1267   if (disconnect_message != NULL)
1268     dbus_message_unref (disconnect_message);
1269
1270   if (disconnect_link != NULL)
1271     _dbus_list_free_link (disconnect_link);
1272
1273   if (connection != NULL)
1274     {
1275       _dbus_condvar_free_at_location (&connection->io_path_cond);
1276       _dbus_condvar_free_at_location (&connection->dispatch_cond);
1277       _dbus_mutex_free_at_location (&connection->mutex);
1278       _dbus_mutex_free_at_location (&connection->io_path_mutex);
1279       _dbus_mutex_free_at_location (&connection->dispatch_mutex);
1280       dbus_free (connection);
1281     }
1282   if (pending_replies)
1283     _dbus_hash_table_unref (pending_replies);
1284
1285   if (watch_list)
1286     _dbus_watch_list_free (watch_list);
1287
1288   if (timeout_list)
1289     _dbus_timeout_list_free (timeout_list);
1290
1291   if (outgoing_counter)
1292     _dbus_counter_unref (outgoing_counter);
1293
1294   if (objects)
1295     _dbus_object_tree_unref (objects);
1296
1297   return NULL;
1298 }
1299
1300 /**
1301  * Increments the reference count of a DBusConnection.
1302  * Requires that the caller already holds the connection lock.
1303  *
1304  * @param connection the connection.
1305  * @returns the connection.
1306  */
1307 DBusConnection *
1308 _dbus_connection_ref_unlocked (DBusConnection *connection)
1309 {
1310   _dbus_assert (connection != NULL);
1311   _dbus_assert (connection->generation == _dbus_current_generation);
1312
1313   HAVE_LOCK_CHECK (connection);
1314
1315 #ifdef DBUS_HAVE_ATOMIC_INT
1316   _dbus_atomic_inc (&connection->refcount);
1317 #else
1318   _dbus_assert (connection->refcount.value > 0);
1319   connection->refcount.value += 1;
1320 #endif
1321
1322   return connection;
1323 }
1324
1325 /**
1326  * Decrements the reference count of a DBusConnection.
1327  * Requires that the caller already holds the connection lock.
1328  *
1329  * @param connection the connection.
1330  */
1331 void
1332 _dbus_connection_unref_unlocked (DBusConnection *connection)
1333 {
1334   dbus_bool_t last_unref;
1335
1336   HAVE_LOCK_CHECK (connection);
1337
1338   _dbus_assert (connection != NULL);
1339
1340   /* The connection lock is better than the global
1341    * lock in the atomic increment fallback
1342    */
1343
1344 #ifdef DBUS_HAVE_ATOMIC_INT
1345   last_unref = (_dbus_atomic_dec (&connection->refcount) == 1);
1346 #else
1347   _dbus_assert (connection->refcount.value > 0);
1348
1349   connection->refcount.value -= 1;
1350   last_unref = (connection->refcount.value == 0);
1351 #if 0
1352   printf ("unref_unlocked() connection %p count = %d\n", connection, connection->refcount.value);
1353 #endif
1354 #endif
1355
1356   if (last_unref)
1357     _dbus_connection_last_unref (connection);
1358 }
1359
1360 static dbus_uint32_t
1361 _dbus_connection_get_next_client_serial (DBusConnection *connection)
1362 {
1363   int serial;
1364
1365   serial = connection->client_serial++;
1366
1367   if (connection->client_serial < 0)
1368     connection->client_serial = 1;
1369
1370   return serial;
1371 }
1372
1373 /**
1374  * A callback for use with dbus_watch_new() to create a DBusWatch.
1375  *
1376  * @todo This is basically a hack - we could delete _dbus_transport_handle_watch()
1377  * and the virtual handle_watch in DBusTransport if we got rid of it.
1378  * The reason this is some work is threading, see the _dbus_connection_handle_watch()
1379  * implementation.
1380  *
1381  * @param watch the watch.
1382  * @param condition the current condition of the file descriptors being watched.
1383  * @param data must be a pointer to a #DBusConnection
1384  * @returns #FALSE if the IO condition may not have been fully handled due to lack of memory
1385  */
1386 dbus_bool_t
1387 _dbus_connection_handle_watch (DBusWatch                   *watch,
1388                                unsigned int                 condition,
1389                                void                        *data)
1390 {
1391   DBusConnection *connection;
1392   dbus_bool_t retval;
1393   DBusDispatchStatus status;
1394
1395   connection = data;
1396
1397   _dbus_verbose ("%s start\n", _DBUS_FUNCTION_NAME);
1398
1399   CONNECTION_LOCK (connection);
1400   _dbus_connection_acquire_io_path (connection, -1);
1401   HAVE_LOCK_CHECK (connection);
1402   retval = _dbus_transport_handle_watch (connection->transport,
1403                                          watch, condition);
1404
1405   _dbus_connection_release_io_path (connection);
1406
1407   HAVE_LOCK_CHECK (connection);
1408
1409   _dbus_verbose ("%s middle\n", _DBUS_FUNCTION_NAME);
1410
1411   status = _dbus_connection_get_dispatch_status_unlocked (connection);
1412
1413   /* this calls out to user code */
1414   _dbus_connection_update_dispatch_status_and_unlock (connection, status);
1415
1416   _dbus_verbose ("%s end\n", _DBUS_FUNCTION_NAME);
1417
1418   return retval;
1419 }
1420
1421 _DBUS_DEFINE_GLOBAL_LOCK (shared_connections);
1422 static DBusHashTable *shared_connections = NULL;
1423
1424 static void
1425 shared_connections_shutdown (void *data)
1426 {
1427   int n_entries;
1428
1429   _DBUS_LOCK (shared_connections);
1430
1431   /* This is a little bit unpleasant... better ideas? */
1432   while ((n_entries = _dbus_hash_table_get_n_entries (shared_connections)) > 0)
1433     {
1434       DBusConnection *connection;
1435       DBusMessage *message;
1436       DBusHashIter iter;
1437
1438       _dbus_hash_iter_init (shared_connections, &iter);
1439       _dbus_hash_iter_next (&iter);
1440
1441       connection = _dbus_hash_iter_get_value (&iter);
1442
1443       _DBUS_UNLOCK (shared_connections);
1444
1445       dbus_connection_ref (connection);
1446       _dbus_connection_close_possibly_shared (connection);
1447
1448       /* Churn through to the Disconnected message */
1449       while ((message = dbus_connection_pop_message (connection)))
1450         {
1451           dbus_message_unref (message);
1452         }
1453       dbus_connection_unref (connection);
1454
1455       _DBUS_LOCK (shared_connections);
1456
1457       /* The connection should now be dead and not in our hash ... */
1458       _dbus_assert (_dbus_hash_table_get_n_entries (shared_connections) < n_entries);
1459     }
1460
1461   _dbus_assert (_dbus_hash_table_get_n_entries (shared_connections) == 0);
1462
1463   _dbus_hash_table_unref (shared_connections);
1464   shared_connections = NULL;
1465
1466   _DBUS_UNLOCK (shared_connections);
1467 }
1468
1469 static dbus_bool_t
1470 connection_lookup_shared (DBusAddressEntry  *entry,
1471                           DBusConnection   **result)
1472 {
1473   _dbus_verbose ("checking for existing connection\n");
1474
1475   *result = NULL;
1476
1477   _DBUS_LOCK (shared_connections);
1478
1479   if (shared_connections == NULL)
1480     {
1481       _dbus_verbose ("creating shared_connections hash table\n");
1482
1483       shared_connections = _dbus_hash_table_new (DBUS_HASH_STRING,
1484                                                  dbus_free,
1485                                                  NULL);
1486       if (shared_connections == NULL)
1487         {
1488           _DBUS_UNLOCK (shared_connections);
1489           return FALSE;
1490         }
1491
1492       if (!_dbus_register_shutdown_func (shared_connections_shutdown, NULL))
1493         {
1494           _dbus_hash_table_unref (shared_connections);
1495           shared_connections = NULL;
1496           _DBUS_UNLOCK (shared_connections);
1497           return FALSE;
1498         }
1499
1500       _dbus_verbose ("  successfully created shared_connections\n");
1501
1502       _DBUS_UNLOCK (shared_connections);
1503       return TRUE; /* no point looking up in the hash we just made */
1504     }
1505   else
1506     {
1507       const char *guid;
1508
1509       guid = dbus_address_entry_get_value (entry, "guid");
1510
1511       if (guid != NULL)
1512         {
1513           DBusConnection *connection;
1514
1515           connection = _dbus_hash_table_lookup_string (shared_connections,
1516                                                        guid);
1517
1518           if (connection)
1519             {
1520               /* The DBusConnection can't be finalized without taking
1521                * the shared_connections lock to remove it from the
1522                * hash.  So it's safe to ref the connection here.
1523                * However, it may be disconnected if the Disconnected
1524                * message hasn't been processed yet, in which case we
1525                * want to pretend it isn't in the hash and avoid
1526                * returning it.
1527                *
1528                * The idea is to avoid ever returning a disconnected connection
1529                * from dbus_connection_open(). We could just synchronously
1530                * drop our shared ref to the connection on connection disconnect,
1531                * and then assert here that the connection is connected, but
1532                * that causes reentrancy headaches.
1533                */
1534               CONNECTION_LOCK (connection);
1535               if (_dbus_connection_get_is_connected_unlocked (connection))
1536                 {
1537                   _dbus_connection_ref_unlocked (connection);
1538                   *result = connection;
1539                   _dbus_verbose ("looked up existing connection to server guid %s\n",
1540                                  guid);
1541                 }
1542               else
1543                 {
1544                   _dbus_verbose ("looked up existing connection to server guid %s but it was disconnected so ignoring it\n",
1545                                  guid);
1546                 }
1547               CONNECTION_UNLOCK (connection);
1548             }
1549         }
1550
1551       _DBUS_UNLOCK (shared_connections);
1552       return TRUE;
1553     }
1554 }
1555
1556 static dbus_bool_t
1557 connection_record_shared_unlocked (DBusConnection *connection,
1558                                    const char     *guid)
1559 {
1560   char *guid_key;
1561   char *guid_in_connection;
1562
1563   HAVE_LOCK_CHECK (connection);
1564   _dbus_assert (connection->server_guid == NULL);
1565   _dbus_assert (connection->shareable);
1566
1567   /* get a hard ref on this connection, even if
1568    * we won't in fact store it in the hash, we still
1569    * need to hold a ref on it until it's disconnected.
1570    */
1571   _dbus_connection_ref_unlocked (connection);
1572
1573   if (guid == NULL)
1574     return TRUE; /* don't store in the hash */
1575
1576   /* A separate copy of the key is required in the hash table, because
1577    * we don't have a lock on the connection when we are doing a hash
1578    * lookup.
1579    */
1580
1581   guid_key = _dbus_strdup (guid);
1582   if (guid_key == NULL)
1583     return FALSE;
1584
1585   guid_in_connection = _dbus_strdup (guid);
1586   if (guid_in_connection == NULL)
1587     {
1588       dbus_free (guid_key);
1589       return FALSE;
1590     }
1591
1592   _DBUS_LOCK (shared_connections);
1593   _dbus_assert (shared_connections != NULL);
1594
1595   if (!_dbus_hash_table_insert_string (shared_connections,
1596                                        guid_key, connection))
1597     {
1598       dbus_free (guid_key);
1599       dbus_free (guid_in_connection);
1600       _DBUS_UNLOCK (shared_connections);
1601       return FALSE;
1602     }
1603
1604   connection->server_guid = guid_in_connection;
1605
1606   _dbus_verbose ("stored connection to %s to be shared\n",
1607                  connection->server_guid);
1608
1609   _DBUS_UNLOCK (shared_connections);
1610
1611   _dbus_assert (connection->server_guid != NULL);
1612
1613   return TRUE;
1614 }
1615
1616 static void
1617 connection_forget_shared_unlocked (DBusConnection *connection)
1618 {
1619   HAVE_LOCK_CHECK (connection);
1620
1621   if (!connection->shareable)
1622     return;
1623
1624   if (connection->server_guid != NULL)
1625     {
1626       _dbus_verbose ("dropping connection to %s out of the shared table\n",
1627                      connection->server_guid);
1628
1629       _DBUS_LOCK (shared_connections);
1630
1631       if (!_dbus_hash_table_remove_string (shared_connections,
1632                                            connection->server_guid))
1633         _dbus_assert_not_reached ("connection was not in the shared table");
1634
1635       dbus_free (connection->server_guid);
1636       connection->server_guid = NULL;
1637       _DBUS_UNLOCK (shared_connections);
1638     }
1639
1640   /* remove our reference held on all shareable connections */
1641   _dbus_connection_unref_unlocked (connection);
1642 }
1643
1644 static DBusConnection*
1645 connection_try_from_address_entry (DBusAddressEntry *entry,
1646                                    DBusError        *error)
1647 {
1648   DBusTransport *transport;
1649   DBusConnection *connection;
1650
1651   transport = _dbus_transport_open (entry, error);
1652
1653   if (transport == NULL)
1654     {
1655       _DBUS_ASSERT_ERROR_IS_SET (error);
1656       return NULL;
1657     }
1658
1659   connection = _dbus_connection_new_for_transport (transport);
1660
1661   _dbus_transport_unref (transport);
1662
1663   if (connection == NULL)
1664     {
1665       _DBUS_SET_OOM (error);
1666       return NULL;
1667     }
1668
1669 #ifndef DBUS_DISABLE_CHECKS
1670   _dbus_assert (!connection->have_connection_lock);
1671 #endif
1672   return connection;
1673 }
1674
1675 /*
1676  * If the shared parameter is true, then any existing connection will
1677  * be used (and if a new connection is created, it will be available
1678  * for use by others). If the shared parameter is false, a new
1679  * connection will always be created, and the new connection will
1680  * never be returned to other callers.
1681  *
1682  * @param address the address
1683  * @param shared whether the connection is shared or private
1684  * @param error error return
1685  * @returns the connection or #NULL on error
1686  */
1687 static DBusConnection*
1688 _dbus_connection_open_internal (const char     *address,
1689                                 dbus_bool_t     shared,
1690                                 DBusError      *error)
1691 {
1692   DBusConnection *connection;
1693   DBusAddressEntry **entries;
1694   DBusError tmp_error;
1695   DBusError first_error;
1696   int len, i;
1697
1698   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1699
1700   _dbus_verbose ("opening %s connection to: %s\n",
1701                  shared ? "shared" : "private", address);
1702
1703   if (!dbus_parse_address (address, &entries, &len, error))
1704     return NULL;
1705
1706   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1707
1708   connection = NULL;
1709
1710   dbus_error_init (&tmp_error);
1711   dbus_error_init (&first_error);
1712   for (i = 0; i < len; i++)
1713     {
1714       if (shared)
1715         {
1716           if (!connection_lookup_shared (entries[i], &connection))
1717             _DBUS_SET_OOM (&tmp_error);
1718         }
1719
1720       if (connection == NULL)
1721         {
1722           connection = connection_try_from_address_entry (entries[i],
1723                                                           &tmp_error);
1724
1725           if (connection != NULL)
1726             {
1727               CONNECTION_LOCK (connection);
1728
1729               if (shared)
1730                 {
1731                   const char *guid;
1732
1733                   connection->shareable = TRUE;
1734
1735                   /* guid may be NULL */
1736                   guid = dbus_address_entry_get_value (entries[i], "guid");
1737
1738                   if (!connection_record_shared_unlocked (connection, guid))
1739                     {
1740                       _DBUS_SET_OOM (&tmp_error);
1741                       _dbus_connection_close_possibly_shared_and_unlock (connection);
1742                       dbus_connection_unref (connection);
1743                       connection = NULL;
1744                     }
1745
1746                   /* Note: as of now the connection is possibly shared
1747                    * since another thread could have pulled it from the table.
1748                    * However, we still have it locked so that thread isn't
1749                    * doing anything more than blocking on the lock.
1750                    */
1751                 }
1752             }
1753         }
1754
1755       if (connection)
1756         {
1757           HAVE_LOCK_CHECK (connection);
1758           break;
1759         }
1760
1761       _DBUS_ASSERT_ERROR_IS_SET (&tmp_error);
1762
1763       if (i == 0)
1764         dbus_move_error (&tmp_error, &first_error);
1765       else
1766         dbus_error_free (&tmp_error);
1767     }
1768
1769   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1770   _DBUS_ASSERT_ERROR_IS_CLEAR (&tmp_error);
1771
1772   if (connection == NULL)
1773     {
1774       _DBUS_ASSERT_ERROR_IS_SET (&first_error);
1775       dbus_move_error (&first_error, error);
1776     }
1777   else
1778     {
1779       dbus_error_free (&first_error);
1780
1781       CONNECTION_UNLOCK (connection);
1782     }
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_message(),
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 after any filters, but
3000  * before any object instances or other handlers. A #DBusPendingCall
3001  * will always see exactly one reply message, unless it's cancelled
3002  * with dbus_pending_call_cancel().
3003  *
3004  * If a filter filters out the reply before the handler sees it, the
3005  * reply is immediately timed out and a timeout error reply is
3006  * generated. If a filter removes the timeout error reply then the
3007  * #DBusPendingCall will get confused. Filtering the timeout error
3008  * is thus considered a bug and will print a warning.
3009  *
3010  * If #NULL is passed for the pending_return, the #DBusPendingCall
3011  * will still be generated internally, and used to track
3012  * the message reply timeout. This means a timeout error will
3013  * occur if no reply arrives, unlike with dbus_connection_send().
3014  *
3015  * If -1 is passed for the timeout, a sane default timeout is used. -1
3016  * is typically the best value for the timeout for this reason, unless
3017  * you want a very short or very long timeout.  There is no way to
3018  * avoid a timeout entirely, other than passing INT_MAX for the
3019  * timeout to postpone it indefinitely.
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 do non-reentrant "method
3124  * calls."
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. If something else goes wrong,
3131  * result is set to whatever is appropriate, such as
3132  * #DBUS_ERROR_NO_MEMORY or #DBUS_ERROR_DISCONNECTED.
3133  *
3134  * @param connection the connection
3135  * @param message the message to send
3136  * @param timeout_milliseconds timeout in milliseconds or -1 for default
3137  * @param error return location for error message
3138  * @returns the message that is the reply or #NULL with an error code if the
3139  * function fails.
3140  */
3141 DBusMessage*
3142 dbus_connection_send_with_reply_and_block (DBusConnection     *connection,
3143                                            DBusMessage        *message,
3144                                            int                 timeout_milliseconds,
3145                                            DBusError          *error)
3146 {
3147   DBusMessage *reply;
3148   DBusPendingCall *pending;
3149
3150   _dbus_return_val_if_fail (connection != NULL, NULL);
3151   _dbus_return_val_if_fail (message != NULL, NULL);
3152   _dbus_return_val_if_fail (timeout_milliseconds >= 0 || timeout_milliseconds == -1, NULL);
3153   _dbus_return_val_if_error_is_set (error, NULL);
3154
3155   if (!dbus_connection_send_with_reply (connection, message,
3156                                         &pending, timeout_milliseconds))
3157     {
3158       _DBUS_SET_OOM (error);
3159       return NULL;
3160     }
3161
3162   if (pending == NULL)
3163     {
3164       dbus_set_error (error, DBUS_ERROR_DISCONNECTED, "Connection is closed");
3165       return NULL;
3166     }
3167
3168   dbus_pending_call_block (pending);
3169
3170   reply = dbus_pending_call_steal_reply (pending);
3171   dbus_pending_call_unref (pending);
3172
3173   /* call_complete_and_unlock() called from pending_call_block() should
3174    * always fill this in.
3175    */
3176   _dbus_assert (reply != NULL);
3177
3178    if (dbus_set_error_from_message (error, reply))
3179     {
3180       dbus_message_unref (reply);
3181       return NULL;
3182     }
3183   else
3184     return reply;
3185 }
3186
3187 /**
3188  * Blocks until the outgoing message queue is empty.
3189  * Assumes connection lock already held.
3190  *
3191  * If you call this, you MUST call update_dispatch_status afterword...
3192  *
3193  * @param connection the connection.
3194  */
3195 DBusDispatchStatus
3196 _dbus_connection_flush_unlocked (DBusConnection *connection)
3197 {
3198   /* We have to specify DBUS_ITERATION_DO_READING here because
3199    * otherwise we could have two apps deadlock if they are both doing
3200    * a flush(), and the kernel buffers fill up. This could change the
3201    * dispatch status.
3202    */
3203   DBusDispatchStatus status;
3204
3205   HAVE_LOCK_CHECK (connection);
3206
3207   while (connection->n_outgoing > 0 &&
3208          _dbus_connection_get_is_connected_unlocked (connection))
3209     {
3210       _dbus_verbose ("doing iteration in %s\n", _DBUS_FUNCTION_NAME);
3211       HAVE_LOCK_CHECK (connection);
3212       _dbus_connection_do_iteration_unlocked (connection,
3213                                               DBUS_ITERATION_DO_READING |
3214                                               DBUS_ITERATION_DO_WRITING |
3215                                               DBUS_ITERATION_BLOCK,
3216                                               -1);
3217     }
3218
3219   HAVE_LOCK_CHECK (connection);
3220   _dbus_verbose ("%s middle\n", _DBUS_FUNCTION_NAME);
3221   status = _dbus_connection_get_dispatch_status_unlocked (connection);
3222
3223   HAVE_LOCK_CHECK (connection);
3224   return status;
3225 }
3226
3227 /**
3228  * Blocks until the outgoing message queue is empty.
3229  *
3230  * @param connection the connection.
3231  */
3232 void
3233 dbus_connection_flush (DBusConnection *connection)
3234 {
3235   /* We have to specify DBUS_ITERATION_DO_READING here because
3236    * otherwise we could have two apps deadlock if they are both doing
3237    * a flush(), and the kernel buffers fill up. This could change the
3238    * dispatch status.
3239    */
3240   DBusDispatchStatus status;
3241
3242   _dbus_return_if_fail (connection != NULL);
3243
3244   CONNECTION_LOCK (connection);
3245
3246   status = _dbus_connection_flush_unlocked (connection);
3247
3248   HAVE_LOCK_CHECK (connection);
3249   /* Unlocks and calls out to user code */
3250   _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3251
3252   _dbus_verbose ("%s end\n", _DBUS_FUNCTION_NAME);
3253 }
3254
3255 /**
3256  * This function implements dbus_connection_read_write_dispatch() and
3257  * dbus_connection_read_write() (they pass a different value for the
3258  * dispatch parameter).
3259  *
3260  * @param connection the connection
3261  * @param timeout_milliseconds max time to block or -1 for infinite
3262  * @param dispatch dispatch new messages or leave them on the incoming queue
3263  * @returns #TRUE if the disconnect message has not been processed
3264  */
3265 static dbus_bool_t
3266 _dbus_connection_read_write_dispatch (DBusConnection *connection,
3267                                      int             timeout_milliseconds,
3268                                      dbus_bool_t     dispatch)
3269 {
3270   DBusDispatchStatus dstatus;
3271   dbus_bool_t no_progress_possible;
3272
3273   dstatus = dbus_connection_get_dispatch_status (connection);
3274
3275   if (dispatch && dstatus == DBUS_DISPATCH_DATA_REMAINS)
3276     {
3277       _dbus_verbose ("doing dispatch in %s\n", _DBUS_FUNCTION_NAME);
3278       dbus_connection_dispatch (connection);
3279       CONNECTION_LOCK (connection);
3280     }
3281   else if (dstatus == DBUS_DISPATCH_NEED_MEMORY)
3282     {
3283       _dbus_verbose ("pausing for memory in %s\n", _DBUS_FUNCTION_NAME);
3284       _dbus_memory_pause_based_on_timeout (timeout_milliseconds);
3285       CONNECTION_LOCK (connection);
3286     }
3287   else
3288     {
3289       CONNECTION_LOCK (connection);
3290       if (_dbus_connection_get_is_connected_unlocked (connection))
3291         {
3292           _dbus_verbose ("doing iteration in %s\n", _DBUS_FUNCTION_NAME);
3293           _dbus_connection_do_iteration_unlocked (connection,
3294                                                   DBUS_ITERATION_DO_READING |
3295                                                   DBUS_ITERATION_DO_WRITING |
3296                                                   DBUS_ITERATION_BLOCK,
3297                                                   timeout_milliseconds);
3298         }
3299     }
3300
3301   HAVE_LOCK_CHECK (connection);
3302   /* If we can dispatch, we can make progress until the Disconnected message
3303    * has been processed; if we can only read/write, we can make progress
3304    * as long as the transport is open.
3305    */
3306   if (dispatch)
3307     no_progress_possible = connection->n_incoming == 0 &&
3308       connection->disconnect_message_link == NULL;
3309   else
3310     no_progress_possible = _dbus_connection_get_is_connected_unlocked (connection);
3311   CONNECTION_UNLOCK (connection);
3312   return !no_progress_possible; /* TRUE if we can make more progress */
3313 }
3314
3315
3316 /**
3317  * This function is intended for use with applications that don't want
3318  * to write a main loop and deal with #DBusWatch and #DBusTimeout. An
3319  * example usage would be:
3320  *
3321  * @code
3322  *   while (dbus_connection_read_write_dispatch (connection, -1))
3323  *     ; // empty loop body
3324  * @endcode
3325  *
3326  * In this usage you would normally have set up a filter function to look
3327  * at each message as it is dispatched. The loop terminates when the last
3328  * message from the connection (the disconnected signal) is processed.
3329  *
3330  * If there are messages to dispatch, this function will
3331  * dbus_connection_dispatch() once, and return. If there are no
3332  * messages to dispatch, this function will block until it can read or
3333  * write, then read or write, then return.
3334  *
3335  * The way to think of this function is that it either makes some sort
3336  * of progress, or it blocks.
3337  *
3338  * The return value indicates whether the disconnect message has been
3339  * processed, NOT whether the connection is connected. This is
3340  * important because even after disconnecting, you want to process any
3341  * messages you received prior to the disconnect.
3342  *
3343  * @param connection the connection
3344  * @param timeout_milliseconds max time to block or -1 for infinite
3345  * @returns #TRUE if the disconnect message has not been processed
3346  */
3347 dbus_bool_t
3348 dbus_connection_read_write_dispatch (DBusConnection *connection,
3349                                      int             timeout_milliseconds)
3350 {
3351   _dbus_return_val_if_fail (connection != NULL, FALSE);
3352   _dbus_return_val_if_fail (timeout_milliseconds >= 0 || timeout_milliseconds == -1, FALSE);
3353    return _dbus_connection_read_write_dispatch(connection, timeout_milliseconds, TRUE);
3354 }
3355
3356 /**
3357  * This function is intended for use with applications that don't want to
3358  * write a main loop and deal with #DBusWatch and #DBusTimeout. See also
3359  * dbus_connection_read_write_dispatch().
3360  *
3361  * As long as the connection is open, this function will block until it can
3362  * read or write, then read or write, then return #TRUE.
3363  *
3364  * If the connection is closed, the function returns #FALSE.
3365  *
3366  * The return value indicates whether reading or writing is still
3367  * possible, i.e. whether the connection is connected.
3368  *
3369  * Note that even after disconnection, messages may remain in the
3370  * incoming queue that need to be
3371  * processed. dbus_connection_read_write_dispatch() dispatches
3372  * incoming messages for you; with dbus_connection_read_write() you
3373  * have to arrange to drain the incoming queue yourself.
3374  *
3375  * @param connection the connection
3376  * @param timeout_milliseconds max time to block or -1 for infinite
3377  * @returns #TRUE if still connected
3378  */
3379 dbus_bool_t
3380 dbus_connection_read_write (DBusConnection *connection,
3381                             int             timeout_milliseconds)
3382 {
3383   _dbus_return_val_if_fail (connection != NULL, FALSE);
3384   _dbus_return_val_if_fail (timeout_milliseconds >= 0 || timeout_milliseconds == -1, FALSE);
3385    return _dbus_connection_read_write_dispatch(connection, timeout_milliseconds, FALSE);
3386 }
3387
3388 /* We need to call this anytime we pop the head of the queue, and then
3389  * update_dispatch_status_and_unlock needs to be called afterward
3390  * which will "process" the disconnected message and set
3391  * disconnected_message_processed.
3392  */
3393 static void
3394 check_disconnected_message_arrived_unlocked (DBusConnection *connection,
3395                                              DBusMessage    *head_of_queue)
3396 {
3397   HAVE_LOCK_CHECK (connection);
3398
3399   /* checking that the link is NULL is an optimization to avoid the is_signal call */
3400   if (connection->disconnect_message_link == NULL &&
3401       dbus_message_is_signal (head_of_queue,
3402                               DBUS_INTERFACE_LOCAL,
3403                               "Disconnected"))
3404     {
3405       connection->disconnected_message_arrived = TRUE;
3406     }
3407 }
3408
3409 /**
3410  * Returns the first-received message from the incoming message queue,
3411  * leaving it in the queue. If the queue is empty, returns #NULL.
3412  *
3413  * The caller does not own a reference to the returned message, and
3414  * must either return it using dbus_connection_return_message() or
3415  * keep it after calling dbus_connection_steal_borrowed_message(). No
3416  * one can get at the message while its borrowed, so return it as
3417  * quickly as possible and don't keep a reference to it after
3418  * returning it. If you need to keep the message, make a copy of it.
3419  *
3420  * dbus_connection_dispatch() will block if called while a borrowed
3421  * message is outstanding; only one piece of code can be playing with
3422  * the incoming queue at a time. This function will block if called
3423  * during a dbus_connection_dispatch().
3424  *
3425  * @param connection the connection.
3426  * @returns next message in the incoming queue.
3427  */
3428 DBusMessage*
3429 dbus_connection_borrow_message (DBusConnection *connection)
3430 {
3431   DBusDispatchStatus status;
3432   DBusMessage *message;
3433
3434   _dbus_return_val_if_fail (connection != NULL, NULL);
3435
3436   _dbus_verbose ("%s start\n", _DBUS_FUNCTION_NAME);
3437
3438   /* this is called for the side effect that it queues
3439    * up any messages from the transport
3440    */
3441   status = dbus_connection_get_dispatch_status (connection);
3442   if (status != DBUS_DISPATCH_DATA_REMAINS)
3443     return NULL;
3444
3445   CONNECTION_LOCK (connection);
3446
3447   _dbus_connection_acquire_dispatch (connection);
3448
3449   /* While a message is outstanding, the dispatch lock is held */
3450   _dbus_assert (connection->message_borrowed == NULL);
3451
3452   connection->message_borrowed = _dbus_list_get_first (&connection->incoming_messages);
3453
3454   message = connection->message_borrowed;
3455
3456   check_disconnected_message_arrived_unlocked (connection, message);
3457
3458   /* Note that we KEEP the dispatch lock until the message is returned */
3459   if (message == NULL)
3460     _dbus_connection_release_dispatch (connection);
3461
3462   CONNECTION_UNLOCK (connection);
3463
3464   /* We don't update dispatch status until it's returned or stolen */
3465
3466   return message;
3467 }
3468
3469 /**
3470  * Used to return a message after peeking at it using
3471  * dbus_connection_borrow_message(). Only called if
3472  * message from dbus_connection_borrow_message() was non-#NULL.
3473  *
3474  * @param connection the connection
3475  * @param message the message from dbus_connection_borrow_message()
3476  */
3477 void
3478 dbus_connection_return_message (DBusConnection *connection,
3479                                 DBusMessage    *message)
3480 {
3481   DBusDispatchStatus status;
3482
3483   _dbus_return_if_fail (connection != NULL);
3484   _dbus_return_if_fail (message != NULL);
3485   _dbus_return_if_fail (message == connection->message_borrowed);
3486   _dbus_return_if_fail (connection->dispatch_acquired);
3487
3488   CONNECTION_LOCK (connection);
3489
3490   _dbus_assert (message == connection->message_borrowed);
3491
3492   connection->message_borrowed = NULL;
3493
3494   _dbus_connection_release_dispatch (connection);
3495
3496   status = _dbus_connection_get_dispatch_status_unlocked (connection);
3497   _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3498 }
3499
3500 /**
3501  * Used to keep a message after peeking at it using
3502  * dbus_connection_borrow_message(). Before using this function, see
3503  * the caveats/warnings in the documentation for
3504  * dbus_connection_pop_message().
3505  *
3506  * @param connection the connection
3507  * @param message the message from dbus_connection_borrow_message()
3508  */
3509 void
3510 dbus_connection_steal_borrowed_message (DBusConnection *connection,
3511                                         DBusMessage    *message)
3512 {
3513   DBusMessage *pop_message;
3514   DBusDispatchStatus status;
3515
3516   _dbus_return_if_fail (connection != NULL);
3517   _dbus_return_if_fail (message != NULL);
3518   _dbus_return_if_fail (message == connection->message_borrowed);
3519   _dbus_return_if_fail (connection->dispatch_acquired);
3520
3521   CONNECTION_LOCK (connection);
3522
3523   _dbus_assert (message == connection->message_borrowed);
3524
3525   pop_message = _dbus_list_pop_first (&connection->incoming_messages);
3526   _dbus_assert (message == pop_message);
3527
3528   connection->n_incoming -= 1;
3529
3530   _dbus_verbose ("Incoming message %p stolen from queue, %d incoming\n",
3531                  message, connection->n_incoming);
3532
3533   connection->message_borrowed = NULL;
3534
3535   _dbus_connection_release_dispatch (connection);
3536
3537   status = _dbus_connection_get_dispatch_status_unlocked (connection);
3538   _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3539 }
3540
3541 /* See dbus_connection_pop_message, but requires the caller to own
3542  * the lock before calling. May drop the lock while running.
3543  */
3544 static DBusList*
3545 _dbus_connection_pop_message_link_unlocked (DBusConnection *connection)
3546 {
3547   HAVE_LOCK_CHECK (connection);
3548
3549   _dbus_assert (connection->message_borrowed == NULL);
3550
3551   if (connection->n_incoming > 0)
3552     {
3553       DBusList *link;
3554
3555       link = _dbus_list_pop_first_link (&connection->incoming_messages);
3556       connection->n_incoming -= 1;
3557
3558       _dbus_verbose ("Message %p (%d %s %s %s '%s') removed from incoming queue %p, %d incoming\n",
3559                      link->data,
3560                      dbus_message_get_type (link->data),
3561                      dbus_message_get_path (link->data) ?
3562                      dbus_message_get_path (link->data) :
3563                      "no path",
3564                      dbus_message_get_interface (link->data) ?
3565                      dbus_message_get_interface (link->data) :
3566                      "no interface",
3567                      dbus_message_get_member (link->data) ?
3568                      dbus_message_get_member (link->data) :
3569                      "no member",
3570                      dbus_message_get_signature (link->data),
3571                      connection, connection->n_incoming);
3572
3573       check_disconnected_message_arrived_unlocked (connection, link->data);
3574
3575       return link;
3576     }
3577   else
3578     return NULL;
3579 }
3580
3581 /* See dbus_connection_pop_message, but requires the caller to own
3582  * the lock before calling. May drop the lock while running.
3583  */
3584 static DBusMessage*
3585 _dbus_connection_pop_message_unlocked (DBusConnection *connection)
3586 {
3587   DBusList *link;
3588
3589   HAVE_LOCK_CHECK (connection);
3590
3591   link = _dbus_connection_pop_message_link_unlocked (connection);
3592
3593   if (link != NULL)
3594     {
3595       DBusMessage *message;
3596
3597       message = link->data;
3598
3599       _dbus_list_free_link (link);
3600
3601       return message;
3602     }
3603   else
3604     return NULL;
3605 }
3606
3607 static void
3608 _dbus_connection_putback_message_link_unlocked (DBusConnection *connection,
3609                                                 DBusList       *message_link)
3610 {
3611   HAVE_LOCK_CHECK (connection);
3612
3613   _dbus_assert (message_link != NULL);
3614   /* You can't borrow a message while a link is outstanding */
3615   _dbus_assert (connection->message_borrowed == NULL);
3616   /* We had to have the dispatch lock across the pop/putback */
3617   _dbus_assert (connection->dispatch_acquired);
3618
3619   _dbus_list_prepend_link (&connection->incoming_messages,
3620                            message_link);
3621   connection->n_incoming += 1;
3622
3623   _dbus_verbose ("Message %p (%d %s %s '%s') put back into queue %p, %d incoming\n",
3624                  message_link->data,
3625                  dbus_message_get_type (message_link->data),
3626                  dbus_message_get_interface (message_link->data) ?
3627                  dbus_message_get_interface (message_link->data) :
3628                  "no interface",
3629                  dbus_message_get_member (message_link->data) ?
3630                  dbus_message_get_member (message_link->data) :
3631                  "no member",
3632                  dbus_message_get_signature (message_link->data),
3633                  connection, connection->n_incoming);
3634 }
3635
3636 /**
3637  * Returns the first-received message from the incoming message queue,
3638  * removing it from the queue. The caller owns a reference to the
3639  * returned message. If the queue is empty, returns #NULL.
3640  *
3641  * This function bypasses any message handlers that are registered,
3642  * and so using it is usually wrong. Instead, let the main loop invoke
3643  * dbus_connection_dispatch(). Popping messages manually is only
3644  * useful in very simple programs that don't share a #DBusConnection
3645  * with any libraries or other modules.
3646  *
3647  * There is a lock that covers all ways of accessing the incoming message
3648  * queue, so dbus_connection_dispatch(), dbus_connection_pop_message(),
3649  * dbus_connection_borrow_message(), etc. will all block while one of the others
3650  * in the group is running.
3651  *
3652  * @param connection the connection.
3653  * @returns next message in the incoming queue.
3654  */
3655 DBusMessage*
3656 dbus_connection_pop_message (DBusConnection *connection)
3657 {
3658   DBusMessage *message;
3659   DBusDispatchStatus status;
3660
3661   _dbus_verbose ("%s start\n", _DBUS_FUNCTION_NAME);
3662
3663   /* this is called for the side effect that it queues
3664    * up any messages from the transport
3665    */
3666   status = dbus_connection_get_dispatch_status (connection);
3667   if (status != DBUS_DISPATCH_DATA_REMAINS)
3668     return NULL;
3669
3670   CONNECTION_LOCK (connection);
3671   _dbus_connection_acquire_dispatch (connection);
3672   HAVE_LOCK_CHECK (connection);
3673
3674   message = _dbus_connection_pop_message_unlocked (connection);
3675
3676   _dbus_verbose ("Returning popped message %p\n", message);
3677
3678   _dbus_connection_release_dispatch (connection);
3679
3680   status = _dbus_connection_get_dispatch_status_unlocked (connection);
3681   _dbus_connection_update_dispatch_status_and_unlock (connection, status);
3682
3683   return message;
3684 }
3685
3686 /**
3687  * Acquire the dispatcher. This is a separate lock so the main
3688  * connection lock can be dropped to call out to application dispatch
3689  * handlers.
3690  *
3691  * @param connection the connection.
3692  */
3693 static void
3694 _dbus_connection_acquire_dispatch (DBusConnection *connection)
3695 {
3696   HAVE_LOCK_CHECK (connection);
3697
3698   _dbus_connection_ref_unlocked (connection);
3699   CONNECTION_UNLOCK (connection);
3700
3701   _dbus_verbose ("%s locking dispatch_mutex\n", _DBUS_FUNCTION_NAME);
3702   _dbus_mutex_lock (connection->dispatch_mutex);
3703
3704   while (connection->dispatch_acquired)
3705     {
3706       _dbus_verbose ("%s waiting for dispatch to be acquirable\n", _DBUS_FUNCTION_NAME);
3707       _dbus_condvar_wait (connection->dispatch_cond,
3708                           connection->dispatch_mutex);
3709     }
3710
3711   _dbus_assert (!connection->dispatch_acquired);
3712
3713   connection->dispatch_acquired = TRUE;
3714
3715   _dbus_verbose ("%s unlocking dispatch_mutex\n", _DBUS_FUNCTION_NAME);
3716   _dbus_mutex_unlock (connection->dispatch_mutex);
3717
3718   CONNECTION_LOCK (connection);
3719   _dbus_connection_unref_unlocked (connection);
3720 }
3721
3722 /**
3723  * Release the dispatcher when you're done with it. Only call
3724  * after you've acquired the dispatcher. Wakes up at most one
3725  * thread currently waiting to acquire the dispatcher.
3726  *
3727  * @param connection the connection.
3728  */
3729 static void
3730 _dbus_connection_release_dispatch (DBusConnection *connection)
3731 {
3732   HAVE_LOCK_CHECK (connection);
3733
3734   _dbus_verbose ("%s locking dispatch_mutex\n", _DBUS_FUNCTION_NAME);
3735   _dbus_mutex_lock (connection->dispatch_mutex);
3736
3737   _dbus_assert (connection->dispatch_acquired);
3738
3739   connection->dispatch_acquired = FALSE;
3740   _dbus_condvar_wake_one (connection->dispatch_cond);
3741
3742   _dbus_verbose ("%s unlocking dispatch_mutex\n", _DBUS_FUNCTION_NAME);
3743   _dbus_mutex_unlock (connection->dispatch_mutex);
3744 }
3745
3746 static void
3747 _dbus_connection_failed_pop (DBusConnection *connection,
3748                              DBusList       *message_link)
3749 {
3750   _dbus_list_prepend_link (&connection->incoming_messages,
3751                            message_link);
3752   connection->n_incoming += 1;
3753 }
3754
3755 /* Note this may be called multiple times since we don't track whether we already did it */
3756 static void
3757 notify_disconnected_unlocked (DBusConnection *connection)
3758 {
3759   HAVE_LOCK_CHECK (connection);
3760
3761   /* Set the weakref in dbus-bus.c to NULL, so nobody will get a disconnected
3762    * connection from dbus_bus_get(). We make the same guarantee for
3763    * dbus_connection_open() but in a different way since we don't want to
3764    * unref right here; we instead check for connectedness before returning
3765    * the connection from the hash.
3766    */
3767   _dbus_bus_notify_shared_connection_disconnected_unlocked (connection);
3768
3769   /* Dump the outgoing queue, we aren't going to be able to
3770    * send it now, and we'd like accessors like
3771    * dbus_connection_get_outgoing_size() to be accurate.
3772    */
3773   if (connection->n_outgoing > 0)
3774     {
3775       DBusList *link;
3776
3777       _dbus_verbose ("Dropping %d outgoing messages since we're disconnected\n",
3778                      connection->n_outgoing);
3779
3780       while ((link = _dbus_list_get_last_link (&connection->outgoing_messages)))
3781         {
3782           _dbus_connection_message_sent (connection, link->data);
3783         }
3784     }
3785 }
3786
3787 /* Note this may be called multiple times since we don't track whether we already did it */
3788 static DBusDispatchStatus
3789 notify_disconnected_and_dispatch_complete_unlocked (DBusConnection *connection)
3790 {
3791   HAVE_LOCK_CHECK (connection);
3792
3793   if (connection->disconnect_message_link != NULL)
3794     {
3795       _dbus_verbose ("Sending disconnect message from %s\n",
3796                      _DBUS_FUNCTION_NAME);
3797
3798       /* If we have pending calls, queue their timeouts - we want the Disconnected
3799        * to be the last message, after these timeouts.
3800        */
3801       connection_timeout_and_complete_all_pending_calls_unlocked (connection);
3802
3803       /* We haven't sent the disconnect message already,
3804        * and all real messages have been queued up.
3805        */
3806       _dbus_connection_queue_synthesized_message_link (connection,
3807                                                        connection->disconnect_message_link);
3808       connection->disconnect_message_link = NULL;
3809
3810       return DBUS_DISPATCH_DATA_REMAINS;
3811     }
3812
3813   return DBUS_DISPATCH_COMPLETE;
3814 }
3815
3816 static DBusDispatchStatus
3817 _dbus_connection_get_dispatch_status_unlocked (DBusConnection *connection)
3818 {
3819   HAVE_LOCK_CHECK (connection);
3820
3821   if (connection->n_incoming > 0)
3822     return DBUS_DISPATCH_DATA_REMAINS;
3823   else if (!_dbus_transport_queue_messages (connection->transport))
3824     return DBUS_DISPATCH_NEED_MEMORY;
3825   else
3826     {
3827       DBusDispatchStatus status;
3828       dbus_bool_t is_connected;
3829
3830       status = _dbus_transport_get_dispatch_status (connection->transport);
3831       is_connected = _dbus_transport_get_is_connected (connection->transport);
3832
3833       _dbus_verbose ("dispatch status = %s is_connected = %d\n",
3834                      DISPATCH_STATUS_NAME (status), is_connected);
3835
3836       if (!is_connected)
3837         {
3838           /* It's possible this would be better done by having an explicit
3839            * notification from _dbus_transport_disconnect() that would
3840            * synchronously do this, instead of waiting for the next dispatch
3841            * status check. However, probably not good to change until it causes
3842            * a problem.
3843            */
3844           notify_disconnected_unlocked (connection);
3845
3846           /* I'm not sure this is needed; the idea is that we want to
3847            * queue the Disconnected only after we've read all the
3848            * messages, but if we're disconnected maybe we are guaranteed
3849            * to have read them all ?
3850            */
3851           if (status == DBUS_DISPATCH_COMPLETE)
3852             status = notify_disconnected_and_dispatch_complete_unlocked (connection);
3853         }
3854
3855       if (status != DBUS_DISPATCH_COMPLETE)
3856         return status;
3857       else if (connection->n_incoming > 0)
3858         return DBUS_DISPATCH_DATA_REMAINS;
3859       else
3860         return DBUS_DISPATCH_COMPLETE;
3861     }
3862 }
3863
3864 static void
3865 _dbus_connection_update_dispatch_status_and_unlock (DBusConnection    *connection,
3866                                                     DBusDispatchStatus new_status)
3867 {
3868   dbus_bool_t changed;
3869   DBusDispatchStatusFunction function;
3870   void *data;
3871
3872   HAVE_LOCK_CHECK (connection);
3873
3874   _dbus_connection_ref_unlocked (connection);
3875
3876   changed = new_status != connection->last_dispatch_status;
3877
3878   connection->last_dispatch_status = new_status;
3879
3880   function = connection->dispatch_status_function;
3881   data = connection->dispatch_status_data;
3882
3883   if (connection->disconnected_message_arrived &&
3884       !connection->disconnected_message_processed)
3885     {
3886       connection->disconnected_message_processed = TRUE;
3887
3888       /* this does an unref, but we have a ref
3889        * so we should not run the finalizer here
3890        * inside the lock.
3891        */
3892       connection_forget_shared_unlocked (connection);
3893
3894       if (connection->exit_on_disconnect)
3895         {
3896           CONNECTION_UNLOCK (connection);
3897
3898           _dbus_verbose ("Exiting on Disconnected signal\n");
3899           _dbus_exit (1);
3900           _dbus_assert_not_reached ("Call to exit() returned");
3901         }
3902     }
3903
3904   /* We drop the lock */
3905   CONNECTION_UNLOCK (connection);
3906
3907   if (changed && function)
3908     {
3909       _dbus_verbose ("Notifying of change to dispatch status of %p now %d (%s)\n",
3910                      connection, new_status,
3911                      DISPATCH_STATUS_NAME (new_status));
3912       (* function) (connection, new_status, data);
3913     }
3914
3915   dbus_connection_unref (connection);
3916 }
3917
3918 /**
3919  * Gets the current state of the incoming message queue.
3920  * #DBUS_DISPATCH_DATA_REMAINS indicates that the message queue
3921  * may contain messages. #DBUS_DISPATCH_COMPLETE indicates that the
3922  * incoming queue is empty. #DBUS_DISPATCH_NEED_MEMORY indicates that
3923  * there could be data, but we can't know for sure without more
3924  * memory.
3925  *
3926  * To process the incoming message queue, use dbus_connection_dispatch()
3927  * or (in rare cases) dbus_connection_pop_message().
3928  *
3929  * Note, #DBUS_DISPATCH_DATA_REMAINS really means that either we
3930  * have messages in the queue, or we have raw bytes buffered up
3931  * that need to be parsed. When these bytes are parsed, they
3932  * may not add up to an entire message. Thus, it's possible
3933  * to see a status of #DBUS_DISPATCH_DATA_REMAINS but not
3934  * have a message yet.
3935  *
3936  * In particular this happens on initial connection, because all sorts
3937  * of authentication protocol stuff has to be parsed before the
3938  * first message arrives.
3939  *
3940  * @param connection the connection.
3941  * @returns current dispatch status
3942  */
3943 DBusDispatchStatus
3944 dbus_connection_get_dispatch_status (DBusConnection *connection)
3945 {
3946   DBusDispatchStatus status;
3947
3948   _dbus_return_val_if_fail (connection != NULL, DBUS_DISPATCH_COMPLETE);
3949
3950   _dbus_verbose ("%s start\n", _DBUS_FUNCTION_NAME);
3951
3952   CONNECTION_LOCK (connection);
3953
3954   status = _dbus_connection_get_dispatch_status_unlocked (connection);
3955
3956   CONNECTION_UNLOCK (connection);
3957
3958   return status;
3959 }
3960
3961 /**
3962  * Filter funtion for handling the Peer standard interface.
3963  */
3964 static DBusHandlerResult
3965 _dbus_connection_peer_filter_unlocked_no_update (DBusConnection *connection,
3966                                                  DBusMessage    *message)
3967 {
3968   if (connection->route_peer_messages && dbus_message_get_destination (message) != NULL)
3969     {
3970       /* This means we're letting the bus route this message */
3971       return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
3972     }
3973   else if (dbus_message_is_method_call (message,
3974                                         DBUS_INTERFACE_PEER,
3975                                         "Ping"))
3976     {
3977       DBusMessage *ret;
3978       dbus_bool_t sent;
3979
3980       ret = dbus_message_new_method_return (message);
3981       if (ret == NULL)
3982         return DBUS_HANDLER_RESULT_NEED_MEMORY;
3983
3984       sent = _dbus_connection_send_unlocked_no_update (connection, ret, NULL);
3985
3986       dbus_message_unref (ret);
3987
3988       if (!sent)
3989         return DBUS_HANDLER_RESULT_NEED_MEMORY;
3990
3991       return DBUS_HANDLER_RESULT_HANDLED;
3992     }
3993   else if (dbus_message_is_method_call (message,
3994                                         DBUS_INTERFACE_PEER,
3995                                         "GetMachineId"))
3996     {
3997       DBusMessage *ret;
3998       dbus_bool_t sent;
3999       DBusString uuid;
4000
4001       ret = dbus_message_new_method_return (message);
4002       if (ret == NULL)
4003         return DBUS_HANDLER_RESULT_NEED_MEMORY;
4004
4005       sent = FALSE;
4006       _dbus_string_init (&uuid);
4007       if (_dbus_get_local_machine_uuid_encoded (&uuid))
4008         {
4009           const char *v_STRING = _dbus_string_get_const_data (&uuid);
4010           if (dbus_message_append_args (ret,
4011                                         DBUS_TYPE_STRING, &v_STRING,
4012                                         DBUS_TYPE_INVALID))
4013             {
4014               sent = _dbus_connection_send_unlocked_no_update (connection, ret, NULL);
4015             }
4016         }
4017       _dbus_string_free (&uuid);
4018
4019       dbus_message_unref (ret);
4020
4021       if (!sent)
4022         return DBUS_HANDLER_RESULT_NEED_MEMORY;
4023
4024       return DBUS_HANDLER_RESULT_HANDLED;
4025     }
4026   else if (dbus_message_has_interface (message, DBUS_INTERFACE_PEER))
4027     {
4028       /* We need to bounce anything else with this interface, otherwise apps
4029        * could start extending the interface and when we added extensions
4030        * here to DBusConnection we'd break those apps.
4031        */
4032
4033       DBusMessage *ret;
4034       dbus_bool_t sent;
4035
4036       ret = dbus_message_new_error (message,
4037                                     DBUS_ERROR_UNKNOWN_METHOD,
4038                                     "Unknown method invoked on org.freedesktop.DBus.Peer interface");
4039       if (ret == NULL)
4040         return DBUS_HANDLER_RESULT_NEED_MEMORY;
4041
4042       sent = _dbus_connection_send_unlocked_no_update (connection, ret, NULL);
4043
4044       dbus_message_unref (ret);
4045
4046       if (!sent)
4047         return DBUS_HANDLER_RESULT_NEED_MEMORY;
4048
4049       return DBUS_HANDLER_RESULT_HANDLED;
4050     }
4051   else
4052     {
4053       return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
4054     }
4055 }
4056
4057 /**
4058 * Processes all builtin filter functions
4059 *
4060 * If the spec specifies a standard interface
4061 * they should be processed from this method
4062 **/
4063 static DBusHandlerResult
4064 _dbus_connection_run_builtin_filters_unlocked_no_update (DBusConnection *connection,
4065                                                            DBusMessage    *message)
4066 {
4067   /* We just run one filter for now but have the option to run more
4068      if the spec calls for it in the future */
4069
4070   return _dbus_connection_peer_filter_unlocked_no_update (connection, message);
4071 }
4072
4073 /**
4074  * Processes any incoming data.
4075  *
4076  * If there are messages in the incoming queue,
4077  * dbus_connection_dispatch() removes one message from the queue and
4078  * runs any handlers for it (handlers are added with
4079  * dbus_connection_add_filter() or
4080  * dbus_connection_register_object_path() for example).
4081  *
4082  * If there's incoming raw data that has not yet been parsed, it is
4083  * parsed, which may or may not result in adding messages to the
4084  * incoming queue.
4085  *
4086  * The incoming message queue is filled when the connection
4087  * reads from its underlying transport (such as a socket).
4088  * Reading usually happens in dbus_watch_handle() or
4089  * dbus_connection_read_write().
4090  *
4091  * If any data has been read from the underlying transport, but not
4092  * yet dispatched, the dispatch status will be
4093  * #DBUS_DISPATCH_DATA_REMAINS. See dbus_connection_get_dispatch_status()
4094  * for more on dispatch statuses.
4095  *
4096  * Be careful about calling dbus_connection_dispatch() from inside a
4097  * message handler, i.e. calling dbus_connection_dispatch()
4098  * recursively.  If threads have been initialized with a recursive
4099  * mutex function, then this will not deadlock; however, it can
4100  * certainly confuse your application.
4101  *
4102  * @todo some FIXME in here about handling DBUS_HANDLER_RESULT_NEED_MEMORY
4103  *
4104  * @param connection the connection
4105  * @returns dispatch status, see dbus_connection_get_dispatch_status()
4106  */
4107 DBusDispatchStatus
4108 dbus_connection_dispatch (DBusConnection *connection)
4109 {
4110   DBusMessage *message;
4111   DBusList *link, *filter_list_copy, *message_link;
4112   DBusHandlerResult result;
4113   DBusPendingCall *pending;
4114   dbus_int32_t reply_serial;
4115   DBusDispatchStatus status;
4116
4117   _dbus_return_val_if_fail (connection != NULL, DBUS_DISPATCH_COMPLETE);
4118
4119   _dbus_verbose ("%s\n", _DBUS_FUNCTION_NAME);
4120
4121   CONNECTION_LOCK (connection);
4122   status = _dbus_connection_get_dispatch_status_unlocked (connection);
4123   if (status != DBUS_DISPATCH_DATA_REMAINS)
4124     {
4125       /* unlocks and calls out to user code */
4126       _dbus_connection_update_dispatch_status_and_unlock (connection, status);
4127       return status;
4128     }
4129
4130   /* We need to ref the connection since the callback could potentially
4131    * drop the last ref to it
4132    */
4133   _dbus_connection_ref_unlocked (connection);
4134
4135   _dbus_connection_acquire_dispatch (connection);
4136   HAVE_LOCK_CHECK (connection);
4137
4138   message_link = _dbus_connection_pop_message_link_unlocked (connection);
4139   if (message_link == NULL)
4140     {
4141       /* another thread dispatched our stuff */
4142
4143       _dbus_verbose ("another thread dispatched message (during acquire_dispatch above)\n");
4144
4145       _dbus_connection_release_dispatch (connection);
4146
4147       status = _dbus_connection_get_dispatch_status_unlocked (connection);
4148
4149       _dbus_connection_update_dispatch_status_and_unlock (connection, status);
4150
4151       dbus_connection_unref (connection);
4152
4153       return status;
4154     }
4155
4156   message = message_link->data;
4157
4158   _dbus_verbose (" dispatching message %p (%d %s %s '%s')\n",
4159                  message,
4160                  dbus_message_get_type (message),
4161                  dbus_message_get_interface (message) ?
4162                  dbus_message_get_interface (message) :
4163                  "no interface",
4164                  dbus_message_get_member (message) ?
4165                  dbus_message_get_member (message) :
4166                  "no member",
4167                  dbus_message_get_signature (message));
4168
4169   result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
4170
4171   /* Pending call handling must be first, because if you do
4172    * dbus_connection_send_with_reply_and_block() or
4173    * dbus_pending_call_block() then no handlers/filters will be run on
4174    * the reply. We want consistent semantics in the case where we
4175    * dbus_connection_dispatch() the reply.
4176    */
4177
4178   reply_serial = dbus_message_get_reply_serial (message);
4179   pending = _dbus_hash_table_lookup_int (connection->pending_replies,
4180                                          reply_serial);
4181   if (pending)
4182     {
4183       _dbus_verbose ("Dispatching a pending reply\n");
4184       complete_pending_call_and_unlock (connection, pending, message);
4185       pending = NULL; /* it's probably unref'd */
4186
4187       CONNECTION_LOCK (connection);
4188       _dbus_verbose ("pending call completed in dispatch\n");
4189       result = DBUS_HANDLER_RESULT_HANDLED;
4190       goto out;
4191     }
4192
4193   result = _dbus_connection_run_builtin_filters_unlocked_no_update (connection, message);
4194   if (result != DBUS_HANDLER_RESULT_NOT_YET_HANDLED)
4195     goto out;
4196
4197   if (!_dbus_list_copy (&connection->filter_list, &filter_list_copy))
4198     {
4199       _dbus_connection_release_dispatch (connection);
4200       HAVE_LOCK_CHECK (connection);
4201
4202       _dbus_connection_failed_pop (connection, message_link);
4203
4204       /* unlocks and calls user code */
4205       _dbus_connection_update_dispatch_status_and_unlock (connection,
4206                                                           DBUS_DISPATCH_NEED_MEMORY);
4207
4208       if (pending)
4209         dbus_pending_call_unref (pending);
4210       dbus_connection_unref (connection);
4211
4212       return DBUS_DISPATCH_NEED_MEMORY;
4213     }
4214
4215   _dbus_list_foreach (&filter_list_copy,
4216                       (DBusForeachFunction)_dbus_message_filter_ref,
4217                       NULL);
4218
4219   /* We're still protected from dispatch() reentrancy here
4220    * since we acquired the dispatcher
4221    */
4222   CONNECTION_UNLOCK (connection);
4223
4224   link = _dbus_list_get_first_link (&filter_list_copy);
4225   while (link != NULL)
4226     {
4227       DBusMessageFilter *filter = link->data;
4228       DBusList *next = _dbus_list_get_next_link (&filter_list_copy, link);
4229
4230       if (filter->function == NULL)
4231         {
4232           _dbus_verbose ("  filter was removed in a callback function\n");
4233           link = next;
4234           continue;
4235         }
4236
4237       _dbus_verbose ("  running filter on message %p\n", message);
4238       result = (* filter->function) (connection, message, filter->user_data);
4239
4240       if (result != DBUS_HANDLER_RESULT_NOT_YET_HANDLED)
4241         break;
4242
4243       link = next;
4244     }
4245
4246   _dbus_list_foreach (&filter_list_copy,
4247                       (DBusForeachFunction)_dbus_message_filter_unref,
4248                       NULL);
4249   _dbus_list_clear (&filter_list_copy);
4250
4251   CONNECTION_LOCK (connection);
4252
4253   if (result == DBUS_HANDLER_RESULT_NEED_MEMORY)
4254     {
4255       _dbus_verbose ("No memory in %s\n", _DBUS_FUNCTION_NAME);
4256       goto out;
4257     }
4258   else if (result == DBUS_HANDLER_RESULT_HANDLED)
4259     {
4260       _dbus_verbose ("filter handled message in dispatch\n");
4261       goto out;
4262     }
4263
4264   /* We're still protected from dispatch() reentrancy here
4265    * since we acquired the dispatcher
4266    */
4267   _dbus_verbose ("  running object path dispatch on message %p (%d %s %s '%s')\n",
4268                  message,
4269                  dbus_message_get_type (message),
4270                  dbus_message_get_interface (message) ?
4271                  dbus_message_get_interface (message) :
4272                  "no interface",
4273                  dbus_message_get_member (message) ?
4274                  dbus_message_get_member (message) :
4275                  "no member",
4276                  dbus_message_get_signature (message));
4277
4278   HAVE_LOCK_CHECK (connection);
4279   result = _dbus_object_tree_dispatch_and_unlock (connection->objects,
4280                                                   message);
4281
4282   CONNECTION_LOCK (connection);
4283
4284   if (result != DBUS_HANDLER_RESULT_NOT_YET_HANDLED)
4285     {
4286       _dbus_verbose ("object tree handled message in dispatch\n");
4287       goto out;
4288     }
4289
4290   if (dbus_message_get_type (message) == DBUS_MESSAGE_TYPE_METHOD_CALL)
4291     {
4292       DBusMessage *reply;
4293       DBusString str;
4294       DBusPreallocatedSend *preallocated;
4295
4296       _dbus_verbose ("  sending error %s\n",
4297                      DBUS_ERROR_UNKNOWN_METHOD);
4298
4299       if (!_dbus_string_init (&str))
4300         {
4301           result = DBUS_HANDLER_RESULT_NEED_MEMORY;
4302           _dbus_verbose ("no memory for error string in dispatch\n");
4303           goto out;
4304         }
4305
4306       if (!_dbus_string_append_printf (&str,
4307                                        "Method \"%s\" with signature \"%s\" on interface \"%s\" doesn't exist\n",
4308                                        dbus_message_get_member (message),
4309                                        dbus_message_get_signature (message),
4310                                        dbus_message_get_interface (message)))
4311         {
4312           _dbus_string_free (&str);
4313           result = DBUS_HANDLER_RESULT_NEED_MEMORY;
4314           _dbus_verbose ("no memory for error string in dispatch\n");
4315           goto out;
4316         }
4317
4318       reply = dbus_message_new_error (message,
4319                                       DBUS_ERROR_UNKNOWN_METHOD,
4320                                       _dbus_string_get_const_data (&str));
4321       _dbus_string_free (&str);
4322
4323       if (reply == NULL)
4324         {
4325           result = DBUS_HANDLER_RESULT_NEED_MEMORY;
4326           _dbus_verbose ("no memory for error reply in dispatch\n");
4327           goto out;
4328         }
4329
4330       preallocated = _dbus_connection_preallocate_send_unlocked (connection);
4331
4332       if (preallocated == NULL)
4333         {
4334           dbus_message_unref (reply);
4335           result = DBUS_HANDLER_RESULT_NEED_MEMORY;
4336           _dbus_verbose ("no memory for error send in dispatch\n");
4337           goto out;
4338         }
4339
4340       _dbus_connection_send_preallocated_unlocked_no_update (connection, preallocated,
4341                                                              reply, NULL);
4342
4343       dbus_message_unref (reply);
4344
4345       result = DBUS_HANDLER_RESULT_HANDLED;
4346     }
4347
4348   _dbus_verbose ("  done dispatching %p (%d %s %s '%s') on connection %p\n", message,
4349                  dbus_message_get_type (message),
4350                  dbus_message_get_interface (message) ?
4351                  dbus_message_get_interface (message) :
4352                  "no interface",
4353                  dbus_message_get_member (message) ?
4354                  dbus_message_get_member (message) :
4355                  "no member",
4356                  dbus_message_get_signature (message),
4357                  connection);
4358
4359  out:
4360   if (result == DBUS_HANDLER_RESULT_NEED_MEMORY)
4361     {
4362       _dbus_verbose ("out of memory in %s\n", _DBUS_FUNCTION_NAME);
4363
4364       /* Put message back, and we'll start over.
4365        * Yes this means handlers must be idempotent if they
4366        * don't return HANDLED; c'est la vie.
4367        */
4368       _dbus_connection_putback_message_link_unlocked (connection,
4369                                                       message_link);
4370     }
4371   else
4372     {
4373       _dbus_verbose (" ... done dispatching in %s\n", _DBUS_FUNCTION_NAME);
4374
4375       _dbus_list_free_link (message_link);
4376       dbus_message_unref (message); /* don't want the message to count in max message limits
4377                                      * in computing dispatch status below
4378                                      */
4379     }
4380
4381   _dbus_connection_release_dispatch (connection);
4382   HAVE_LOCK_CHECK (connection);
4383
4384   _dbus_verbose ("%s before final status update\n", _DBUS_FUNCTION_NAME);
4385   status = _dbus_connection_get_dispatch_status_unlocked (connection);
4386
4387   /* unlocks and calls user code */
4388   _dbus_connection_update_dispatch_status_and_unlock (connection, status);
4389
4390   dbus_connection_unref (connection);
4391
4392   return status;
4393 }
4394
4395 /**
4396  * Sets the watch functions for the connection. These functions are
4397  * responsible for making the application's main loop aware of file
4398  * descriptors that need to be monitored for events, using select() or
4399  * poll(). When using Qt, typically the DBusAddWatchFunction would
4400  * create a QSocketNotifier. When using GLib, the DBusAddWatchFunction
4401  * could call g_io_add_watch(), or could be used as part of a more
4402  * elaborate GSource. Note that when a watch is added, it may
4403  * not be enabled.
4404  *
4405  * The DBusWatchToggledFunction notifies the application that the
4406  * watch has been enabled or disabled. Call dbus_watch_get_enabled()
4407  * to check this. A disabled watch should have no effect, and enabled
4408  * watch should be added to the main loop. This feature is used
4409  * instead of simply adding/removing the watch because
4410  * enabling/disabling can be done without memory allocation.  The
4411  * toggled function may be NULL if a main loop re-queries
4412  * dbus_watch_get_enabled() every time anyway.
4413  *
4414  * The DBusWatch can be queried for the file descriptor to watch using
4415  * dbus_watch_get_fd(), and for the events to watch for using
4416  * dbus_watch_get_flags(). The flags returned by
4417  * dbus_watch_get_flags() will only contain DBUS_WATCH_READABLE and
4418  * DBUS_WATCH_WRITABLE, never DBUS_WATCH_HANGUP or DBUS_WATCH_ERROR;
4419  * all watches implicitly include a watch for hangups, errors, and
4420  * other exceptional conditions.
4421  *
4422  * Once a file descriptor becomes readable or writable, or an exception
4423  * occurs, dbus_watch_handle() should be called to
4424  * notify the connection of the file descriptor's condition.
4425  *
4426  * dbus_watch_handle() cannot be called during the
4427  * DBusAddWatchFunction, as the connection will not be ready to handle
4428  * that watch yet.
4429  *
4430  * It is not allowed to reference a DBusWatch after it has been passed
4431  * to remove_function.
4432  *
4433  * If #FALSE is returned due to lack of memory, the failure may be due
4434  * to a #FALSE return from the new add_function. If so, the
4435  * add_function may have been called successfully one or more times,
4436  * but the remove_function will also have been called to remove any
4437  * successful adds. i.e. if #FALSE is returned the net result
4438  * should be that dbus_connection_set_watch_functions() has no effect,
4439  * but the add_function and remove_function may have been called.
4440  *
4441  * @todo We need to drop the lock when we call the
4442  * add/remove/toggled functions which can be a side effect
4443  * of setting the watch functions.
4444  *
4445  * @param connection the connection.
4446  * @param add_function function to begin monitoring a new descriptor.
4447  * @param remove_function function to stop monitoring a descriptor.
4448  * @param toggled_function function to notify of enable/disable
4449  * @param data data to pass to add_function and remove_function.
4450  * @param free_data_function function to be called to free the data.
4451  * @returns #FALSE on failure (no memory)
4452  */
4453 dbus_bool_t
4454 dbus_connection_set_watch_functions (DBusConnection              *connection,
4455                                      DBusAddWatchFunction         add_function,
4456                                      DBusRemoveWatchFunction      remove_function,
4457                                      DBusWatchToggledFunction     toggled_function,
4458                                      void                        *data,
4459                                      DBusFreeFunction             free_data_function)
4460 {
4461   dbus_bool_t retval;
4462   DBusWatchList *watches;
4463
4464   _dbus_return_val_if_fail (connection != NULL, FALSE);
4465
4466   CONNECTION_LOCK (connection);
4467
4468 #ifndef DBUS_DISABLE_CHECKS
4469   if (connection->watches == NULL)
4470     {
4471       _dbus_warn_check_failed ("Re-entrant call to %s is not allowed\n",
4472                                _DBUS_FUNCTION_NAME);
4473       return FALSE;
4474     }
4475 #endif
4476
4477   /* ref connection for slightly better reentrancy */
4478   _dbus_connection_ref_unlocked (connection);
4479
4480   /* This can call back into user code, and we need to drop the
4481    * connection lock when it does. This is kind of a lame
4482    * way to do it.
4483    */
4484   watches = connection->watches;
4485   connection->watches = NULL;
4486   CONNECTION_UNLOCK (connection);
4487
4488   retval = _dbus_watch_list_set_functions (watches,
4489                                            add_function, remove_function,
4490                                            toggled_function,
4491                                            data, free_data_function);
4492   CONNECTION_LOCK (connection);
4493   connection->watches = watches;
4494
4495   CONNECTION_UNLOCK (connection);
4496   /* drop our paranoid refcount */
4497   dbus_connection_unref (connection);
4498
4499   return retval;
4500 }
4501
4502 /**
4503  * Sets the timeout functions for the connection. These functions are
4504  * responsible for making the application's main loop aware of timeouts.
4505  * When using Qt, typically the DBusAddTimeoutFunction would create a
4506  * QTimer. When using GLib, the DBusAddTimeoutFunction would call
4507  * g_timeout_add.
4508  *
4509  * The DBusTimeoutToggledFunction notifies the application that the
4510  * timeout has been enabled or disabled. Call
4511  * dbus_timeout_get_enabled() to check this. A disabled timeout should
4512  * have no effect, and enabled timeout should be added to the main
4513  * loop. This feature is used instead of simply adding/removing the
4514  * timeout because enabling/disabling can be done without memory
4515  * allocation. With Qt, QTimer::start() and QTimer::stop() can be used
4516  * to enable and disable. The toggled function may be NULL if a main
4517  * loop re-queries dbus_timeout_get_enabled() every time anyway.
4518  * Whenever a timeout is toggled, its interval may change.
4519  *
4520  * The DBusTimeout can be queried for the timer interval using
4521  * dbus_timeout_get_interval(). dbus_timeout_handle() should be called
4522  * repeatedly, each time the interval elapses, starting after it has
4523  * elapsed once. The timeout stops firing when it is removed with the
4524  * given remove_function.  The timer interval may change whenever the
4525  * timeout is added, removed, or toggled.
4526  *
4527  * @param connection the connection.
4528  * @param add_function function to add a timeout.
4529  * @param remove_function function to remove a timeout.
4530  * @param toggled_function function to notify of enable/disable
4531  * @param data data to pass to add_function and remove_function.
4532  * @param free_data_function function to be called to free the data.
4533  * @returns #FALSE on failure (no memory)
4534  */
4535 dbus_bool_t
4536 dbus_connection_set_timeout_functions   (DBusConnection            *connection,
4537                                          DBusAddTimeoutFunction     add_function,
4538                                          DBusRemoveTimeoutFunction  remove_function,
4539                                          DBusTimeoutToggledFunction toggled_function,
4540                                          void                      *data,
4541                                          DBusFreeFunction           free_data_function)
4542 {
4543   dbus_bool_t retval;
4544   DBusTimeoutList *timeouts;
4545
4546   _dbus_return_val_if_fail (connection != NULL, FALSE);
4547
4548   CONNECTION_LOCK (connection);
4549
4550 #ifndef DBUS_DISABLE_CHECKS
4551   if (connection->timeouts == NULL)
4552     {
4553       _dbus_warn_check_failed ("Re-entrant call to %s is not allowed\n",
4554                                _DBUS_FUNCTION_NAME);
4555       return FALSE;
4556     }
4557 #endif
4558
4559   /* ref connection for slightly better reentrancy */
4560   _dbus_connection_ref_unlocked (connection);
4561
4562   timeouts = connection->timeouts;
4563   connection->timeouts = NULL;
4564   CONNECTION_UNLOCK (connection);
4565
4566   retval = _dbus_timeout_list_set_functions (timeouts,
4567                                              add_function, remove_function,
4568                                              toggled_function,
4569                                              data, free_data_function);
4570   CONNECTION_LOCK (connection);
4571   connection->timeouts = timeouts;
4572
4573   CONNECTION_UNLOCK (connection);
4574   /* drop our paranoid refcount */
4575   dbus_connection_unref (connection);
4576
4577   return retval;
4578 }
4579
4580 /**
4581  * Sets the mainloop wakeup function for the connection. This function
4582  * is responsible for waking up the main loop (if its sleeping in
4583  * another thread) when some some change has happened to the
4584  * connection that the mainloop needs to reconsider (e.g. a message
4585  * has been queued for writing).  When using Qt, this typically
4586  * results in a call to QEventLoop::wakeUp().  When using GLib, it
4587  * would call g_main_context_wakeup().
4588  *
4589  * @param connection the connection.
4590  * @param wakeup_main_function function to wake up the mainloop
4591  * @param data data to pass wakeup_main_function
4592  * @param free_data_function function to be called to free the data.
4593  */
4594 void
4595 dbus_connection_set_wakeup_main_function (DBusConnection            *connection,
4596                                           DBusWakeupMainFunction     wakeup_main_function,
4597                                           void                      *data,
4598                                           DBusFreeFunction           free_data_function)
4599 {
4600   void *old_data;
4601   DBusFreeFunction old_free_data;
4602
4603   _dbus_return_if_fail (connection != NULL);
4604
4605   CONNECTION_LOCK (connection);
4606   old_data = connection->wakeup_main_data;
4607   old_free_data = connection->free_wakeup_main_data;
4608
4609   connection->wakeup_main_function = wakeup_main_function;
4610   connection->wakeup_main_data = data;
4611   connection->free_wakeup_main_data = free_data_function;
4612
4613   CONNECTION_UNLOCK (connection);
4614
4615   /* Callback outside the lock */
4616   if (old_free_data)
4617     (*old_free_data) (old_data);
4618 }
4619
4620 /**
4621  * Set a function to be invoked when the dispatch status changes.
4622  * If the dispatch status is #DBUS_DISPATCH_DATA_REMAINS, then
4623  * dbus_connection_dispatch() needs to be called to process incoming
4624  * messages. However, dbus_connection_dispatch() MUST NOT BE CALLED
4625  * from inside the DBusDispatchStatusFunction. Indeed, almost
4626  * any reentrancy in this function is a bad idea. Instead,
4627  * the DBusDispatchStatusFunction should simply save an indication
4628  * that messages should be dispatched later, when the main loop
4629  * is re-entered.
4630  *
4631  * If you don't set a dispatch status function, you have to be sure to
4632  * dispatch on every iteration of your main loop, especially if
4633  * dbus_watch_handle() or dbus_timeout_handle() were called.
4634  *
4635  * @param connection the connection
4636  * @param function function to call on dispatch status changes
4637  * @param data data for function
4638  * @param free_data_function free the function data
4639  */
4640 void
4641 dbus_connection_set_dispatch_status_function (DBusConnection             *connection,
4642                                               DBusDispatchStatusFunction  function,
4643                                               void                       *data,
4644                                               DBusFreeFunction            free_data_function)
4645 {
4646   void *old_data;
4647   DBusFreeFunction old_free_data;
4648
4649   _dbus_return_if_fail (connection != NULL);
4650
4651   CONNECTION_LOCK (connection);
4652   old_data = connection->dispatch_status_data;
4653   old_free_data = connection->free_dispatch_status_data;
4654
4655   connection->dispatch_status_function = function;
4656   connection->dispatch_status_data = data;
4657   connection->free_dispatch_status_data = free_data_function;
4658
4659   CONNECTION_UNLOCK (connection);
4660
4661   /* Callback outside the lock */
4662   if (old_free_data)
4663     (*old_free_data) (old_data);
4664 }
4665
4666 /**
4667  * Get the UNIX file descriptor of the connection, if any.  This can
4668  * be used for SELinux access control checks with getpeercon() for
4669  * example. DO NOT read or write to the file descriptor, or try to
4670  * select() on it; use DBusWatch for main loop integration. Not all
4671  * connections will have a file descriptor. So for adding descriptors
4672  * to the main loop, use dbus_watch_get_fd() and so forth.
4673  *
4674  * If the connection is socket-based, you can also use
4675  * dbus_connection_get_socket(), which will work on Windows too.
4676  * This function always fails on Windows.
4677  *
4678  * Right now the returned descriptor is always a socket, but
4679  * that is not guaranteed.
4680  *
4681  * @param connection the connection
4682  * @param fd return location for the file descriptor.
4683  * @returns #TRUE if fd is successfully obtained.
4684  */
4685 dbus_bool_t
4686 dbus_connection_get_unix_fd (DBusConnection *connection,
4687                              int            *fd)
4688 {
4689   _dbus_return_val_if_fail (connection != NULL, FALSE);
4690   _dbus_return_val_if_fail (connection->transport != NULL, FALSE);
4691
4692 #ifdef DBUS_WIN
4693   /* FIXME do this on a lower level */
4694   return FALSE;
4695 #endif
4696
4697   return dbus_connection_get_socket(connection, fd);
4698 }
4699
4700 /**
4701  * Gets the underlying Windows or UNIX socket file descriptor
4702  * of the connection, if any. DO NOT read or write to the file descriptor, or try to
4703  * select() on it; use DBusWatch for main loop integration. Not all
4704  * connections will have a socket. So for adding descriptors
4705  * to the main loop, use dbus_watch_get_fd() and so forth.
4706  *
4707  * If the connection is not socket-based, this function will return FALSE,
4708  * even if the connection does have a file descriptor of some kind.
4709  * i.e. this function always returns specifically a socket file descriptor.
4710  *
4711  * @param connection the connection
4712  * @param fd return location for the file descriptor.
4713  * @returns #TRUE if fd is successfully obtained.
4714  */
4715 dbus_bool_t
4716 dbus_connection_get_socket(DBusConnection              *connection,
4717                            int                         *fd)
4718 {
4719   dbus_bool_t retval;
4720
4721   _dbus_return_val_if_fail (connection != NULL, FALSE);
4722   _dbus_return_val_if_fail (connection->transport != NULL, FALSE);
4723
4724   CONNECTION_LOCK (connection);
4725
4726   retval = _dbus_transport_get_socket_fd (connection->transport,
4727                                           fd);
4728
4729   CONNECTION_UNLOCK (connection);
4730
4731   return retval;
4732 }
4733
4734
4735 /**
4736  * Gets the UNIX user ID of the connection if any.
4737  * Returns #TRUE if the uid is filled in.
4738  * Always returns #FALSE on non-UNIX platforms.
4739  * Always returns #FALSE prior to authenticating the
4740  * connection.
4741  *
4742  * @param connection the connection
4743  * @param uid return location for the user ID
4744  * @returns #TRUE if uid is filled in with a valid user ID
4745  */
4746 dbus_bool_t
4747 dbus_connection_get_unix_user (DBusConnection *connection,
4748                                unsigned long  *uid)
4749 {
4750   dbus_bool_t result;
4751
4752   _dbus_return_val_if_fail (connection != NULL, FALSE);
4753   _dbus_return_val_if_fail (uid != NULL, FALSE);
4754
4755 #ifdef DBUS_WIN
4756   /* FIXME this should be done at a lower level, but it's kind of hard,
4757    * just want to be sure we don't ship with this API returning
4758    * some weird internal fake uid for 1.0
4759    */
4760   return FALSE;
4761 #endif
4762
4763   CONNECTION_LOCK (connection);
4764
4765   if (!_dbus_transport_get_is_authenticated (connection->transport))
4766     result = FALSE;
4767   else
4768     result = _dbus_transport_get_unix_user (connection->transport,
4769                                             uid);
4770   CONNECTION_UNLOCK (connection);
4771
4772   return result;
4773 }
4774
4775 /**
4776  * Gets the process ID of the connection if any.
4777  * Returns #TRUE if the uid is filled in.
4778  * Always returns #FALSE prior to authenticating the
4779  * connection.
4780  *
4781  * @param connection the connection
4782  * @param pid return location for the process ID
4783  * @returns #TRUE if uid is filled in with a valid process ID
4784  */
4785 dbus_bool_t
4786 dbus_connection_get_unix_process_id (DBusConnection *connection,
4787                                      unsigned long  *pid)
4788 {
4789   dbus_bool_t result;
4790
4791   _dbus_return_val_if_fail (connection != NULL, FALSE);
4792   _dbus_return_val_if_fail (pid != NULL, FALSE);
4793
4794 #ifdef DBUS_WIN
4795   /* FIXME this should be done at a lower level, but it's kind of hard,
4796    * just want to be sure we don't ship with this API returning
4797    * some weird internal fake uid for 1.0
4798    */
4799   return FALSE;
4800 #endif
4801
4802   CONNECTION_LOCK (connection);
4803
4804   if (!_dbus_transport_get_is_authenticated (connection->transport))
4805     result = FALSE;
4806   else
4807     result = _dbus_transport_get_unix_process_id (connection->transport,
4808                                                   pid);
4809   CONNECTION_UNLOCK (connection);
4810
4811   return result;
4812 }
4813
4814 /**
4815  * Sets a predicate function used to determine whether a given user ID
4816  * is allowed to connect. When an incoming connection has
4817  * authenticated with a particular user ID, this function is called;
4818  * if it returns #TRUE, the connection is allowed to proceed,
4819  * otherwise the connection is disconnected.
4820  *
4821  * If the function is set to #NULL (as it is by default), then
4822  * only the same UID as the server process will be allowed to
4823  * connect.
4824  *
4825  * On Windows, the function will be set and its free_data_function will
4826  * be invoked when the connection is freed or a new function is set.
4827  * However, the function will never be called, because there are
4828  * no UNIX user ids to pass to it.
4829  *
4830  * @todo add a Windows API analogous to dbus_connection_set_unix_user_function()
4831  *
4832  * @param connection the connection
4833  * @param function the predicate
4834  * @param data data to pass to the predicate
4835  * @param free_data_function function to free the data
4836  */
4837 void
4838 dbus_connection_set_unix_user_function (DBusConnection             *connection,
4839                                         DBusAllowUnixUserFunction   function,
4840                                         void                       *data,
4841                                         DBusFreeFunction            free_data_function)
4842 {
4843   void *old_data = NULL;
4844   DBusFreeFunction old_free_function = NULL;
4845
4846   _dbus_return_if_fail (connection != NULL);
4847
4848   CONNECTION_LOCK (connection);
4849   _dbus_transport_set_unix_user_function (connection->transport,
4850                                           function, data, free_data_function,
4851                                           &old_data, &old_free_function);
4852   CONNECTION_UNLOCK (connection);
4853
4854   if (old_free_function != NULL)
4855     (* old_free_function) (old_data);
4856 }
4857
4858 /**
4859  *
4860  * Normally #DBusConnection automatically handles all messages to the
4861  * org.freedesktop.DBus.Peer interface. However, the message bus wants
4862  * to be able to route methods on that interface through the bus and
4863  * to other applications. If routing peer messages is enabled, then
4864  * messages with the org.freedesktop.DBus.Peer interface that also
4865  * have a bus destination name set will not be automatically
4866  * handled by the #DBusConnection and instead will be dispatched
4867  * normally to the application.
4868  *
4869  *
4870  * If a normal application sets this flag, it can break things badly.
4871  * So don't set this unless you are the message bus.
4872  *
4873  * @param connection the connection
4874  * @param value #TRUE to pass through org.freedesktop.DBus.Peer messages with a bus name set
4875  */
4876 void
4877 dbus_connection_set_route_peer_messages (DBusConnection             *connection,
4878                                          dbus_bool_t                 value)
4879 {
4880   _dbus_return_if_fail (connection != NULL);
4881
4882   CONNECTION_LOCK (connection);
4883   connection->route_peer_messages = TRUE;
4884   CONNECTION_UNLOCK (connection);
4885 }
4886
4887 /**
4888  * Adds a message filter. Filters are handlers that are run on all
4889  * incoming messages, prior to the objects registered with
4890  * dbus_connection_register_object_path().  Filters are run in the
4891  * order that they were added.  The same handler can be added as a
4892  * filter more than once, in which case it will be run more than once.
4893  * Filters added during a filter callback won't be run on the message
4894  * being processed.
4895  *
4896  * @todo we don't run filters on messages while blocking without
4897  * entering the main loop, since filters are run as part of
4898  * dbus_connection_dispatch(). This is probably a feature, as filters
4899  * could create arbitrary reentrancy. But kind of sucks if you're
4900  * trying to filter METHOD_RETURN for some reason.
4901  *
4902  * @param connection the connection
4903  * @param function function to handle messages
4904  * @param user_data user data to pass to the function
4905  * @param free_data_function function to use for freeing user data
4906  * @returns #TRUE on success, #FALSE if not enough memory.
4907  */
4908 dbus_bool_t
4909 dbus_connection_add_filter (DBusConnection            *connection,
4910                             DBusHandleMessageFunction  function,
4911                             void                      *user_data,
4912                             DBusFreeFunction           free_data_function)
4913 {
4914   DBusMessageFilter *filter;
4915
4916   _dbus_return_val_if_fail (connection != NULL, FALSE);
4917   _dbus_return_val_if_fail (function != NULL, FALSE);
4918
4919   filter = dbus_new0 (DBusMessageFilter, 1);
4920   if (filter == NULL)
4921     return FALSE;
4922
4923   filter->refcount.value = 1;
4924
4925   CONNECTION_LOCK (connection);
4926
4927   if (!_dbus_list_append (&connection->filter_list,
4928                           filter))
4929     {
4930       _dbus_message_filter_unref (filter);
4931       CONNECTION_UNLOCK (connection);
4932       return FALSE;
4933     }
4934
4935   /* Fill in filter after all memory allocated,
4936    * so we don't run the free_user_data_function
4937    * if the add_filter() fails
4938    */
4939
4940   filter->function = function;
4941   filter->user_data = user_data;
4942   filter->free_user_data_function = free_data_function;
4943
4944   CONNECTION_UNLOCK (connection);
4945   return TRUE;
4946 }
4947
4948 /**
4949  * Removes a previously-added message filter. It is a programming
4950  * error to call this function for a handler that has not been added
4951  * as a filter. If the given handler was added more than once, only
4952  * one instance of it will be removed (the most recently-added
4953  * instance).
4954  *
4955  * @param connection the connection
4956  * @param function the handler to remove
4957  * @param user_data user data for the handler to remove
4958  *
4959  */
4960 void
4961 dbus_connection_remove_filter (DBusConnection            *connection,
4962                                DBusHandleMessageFunction  function,
4963                                void                      *user_data)
4964 {
4965   DBusList *link;
4966   DBusMessageFilter *filter;
4967
4968   _dbus_return_if_fail (connection != NULL);
4969   _dbus_return_if_fail (function != NULL);
4970
4971   CONNECTION_LOCK (connection);
4972
4973   filter = NULL;
4974
4975   link = _dbus_list_get_last_link (&connection->filter_list);
4976   while (link != NULL)
4977     {
4978       filter = link->data;
4979
4980       if (filter->function == function &&
4981           filter->user_data == user_data)
4982         {
4983           _dbus_list_remove_link (&connection->filter_list, link);
4984           filter->function = NULL;
4985
4986           break;
4987         }
4988
4989       link = _dbus_list_get_prev_link (&connection->filter_list, link);
4990     }
4991
4992   CONNECTION_UNLOCK (connection);
4993
4994 #ifndef DBUS_DISABLE_CHECKS
4995   if (filter == NULL)
4996     {
4997       _dbus_warn_check_failed ("Attempt to remove filter function %p user data %p, but no such filter has been added\n",
4998                                function, user_data);
4999       return;
5000     }
5001 #endif
5002
5003   /* Call application code */
5004   if (filter->free_user_data_function)
5005     (* filter->free_user_data_function) (filter->user_data);
5006
5007   filter->free_user_data_function = NULL;
5008   filter->user_data = NULL;
5009
5010   _dbus_message_filter_unref (filter);
5011 }
5012
5013 /**
5014  * Registers a handler for a given path in the object hierarchy.
5015  * The given vtable handles messages sent to exactly the given path.
5016  *
5017  *
5018  * @param connection the connection
5019  * @param path a '/' delimited string of path elements
5020  * @param vtable the virtual table
5021  * @param user_data data to pass to functions in the vtable
5022  * @returns #FALSE if not enough memory
5023  */
5024 dbus_bool_t
5025 dbus_connection_register_object_path (DBusConnection              *connection,
5026                                       const char                  *path,
5027                                       const DBusObjectPathVTable  *vtable,
5028                                       void                        *user_data)
5029 {
5030   char **decomposed_path;
5031   dbus_bool_t retval;
5032
5033   _dbus_return_val_if_fail (connection != NULL, FALSE);
5034   _dbus_return_val_if_fail (path != NULL, FALSE);
5035   _dbus_return_val_if_fail (path[0] == '/', FALSE);
5036   _dbus_return_val_if_fail (vtable != NULL, FALSE);
5037
5038   if (!_dbus_decompose_path (path, strlen (path), &decomposed_path, NULL))
5039     return FALSE;
5040
5041   CONNECTION_LOCK (connection);
5042
5043   retval = _dbus_object_tree_register (connection->objects,
5044                                        FALSE,
5045                                        (const char **) decomposed_path, vtable,
5046                                        user_data);
5047
5048   CONNECTION_UNLOCK (connection);
5049
5050   dbus_free_string_array (decomposed_path);
5051
5052   return retval;
5053 }
5054
5055 /**
5056  * Registers a fallback handler for a given subsection of the object
5057  * hierarchy.  The given vtable handles messages at or below the given
5058  * path. You can use this to establish a default message handling
5059  * policy for a whole "subdirectory."
5060  *
5061  * @param connection the connection
5062  * @param path a '/' delimited string of path elements
5063  * @param vtable the virtual table
5064  * @param user_data data to pass to functions in the vtable
5065  * @returns #FALSE if not enough memory
5066  */
5067 dbus_bool_t
5068 dbus_connection_register_fallback (DBusConnection              *connection,
5069                                    const char                  *path,
5070                                    const DBusObjectPathVTable  *vtable,
5071                                    void                        *user_data)
5072 {
5073   char **decomposed_path;
5074   dbus_bool_t retval;
5075
5076   _dbus_return_val_if_fail (connection != NULL, FALSE);
5077   _dbus_return_val_if_fail (path != NULL, FALSE);
5078   _dbus_return_val_if_fail (path[0] == '/', FALSE);
5079   _dbus_return_val_if_fail (vtable != NULL, FALSE);
5080
5081   if (!_dbus_decompose_path (path, strlen (path), &decomposed_path, NULL))
5082     return FALSE;
5083
5084   CONNECTION_LOCK (connection);
5085
5086   retval = _dbus_object_tree_register (connection->objects,
5087                                        TRUE,
5088                                        (const char **) decomposed_path, vtable,
5089                                        user_data);
5090
5091   CONNECTION_UNLOCK (connection);
5092
5093   dbus_free_string_array (decomposed_path);
5094
5095   return retval;
5096 }
5097
5098 /**
5099  * Unregisters the handler registered with exactly the given path.
5100  * It's a bug to call this function for a path that isn't registered.
5101  * Can unregister both fallback paths and object paths.
5102  *
5103  * @param connection the connection
5104  * @param path a '/' delimited string of path elements
5105  * @returns #FALSE if not enough memory
5106  */
5107 dbus_bool_t
5108 dbus_connection_unregister_object_path (DBusConnection              *connection,
5109                                         const char                  *path)
5110 {
5111   char **decomposed_path;
5112
5113   _dbus_return_val_if_fail (connection != NULL, FALSE);
5114   _dbus_return_val_if_fail (path != NULL, FALSE);
5115   _dbus_return_val_if_fail (path[0] == '/', FALSE);
5116
5117   if (!_dbus_decompose_path (path, strlen (path), &decomposed_path, NULL))
5118       return FALSE;
5119
5120   CONNECTION_LOCK (connection);
5121
5122   _dbus_object_tree_unregister_and_unlock (connection->objects, (const char **) decomposed_path);
5123
5124   dbus_free_string_array (decomposed_path);
5125
5126   return TRUE;
5127 }
5128
5129 /**
5130  * Gets the user data passed to dbus_connection_register_object_path()
5131  * or dbus_connection_register_fallback(). If nothing was registered
5132  * at this path, the data is filled in with #NULL.
5133  *
5134  * @param connection the connection
5135  * @param path the path you registered with
5136  * @param data_p location to store the user data, or #NULL
5137  * @returns #FALSE if not enough memory
5138  */
5139 dbus_bool_t
5140 dbus_connection_get_object_path_data (DBusConnection *connection,
5141                                       const char     *path,
5142                                       void          **data_p)
5143 {
5144   char **decomposed_path;
5145
5146   _dbus_return_val_if_fail (connection != NULL, FALSE);
5147   _dbus_return_val_if_fail (path != NULL, FALSE);
5148   _dbus_return_val_if_fail (data_p != NULL, FALSE);
5149
5150   *data_p = NULL;
5151
5152   if (!_dbus_decompose_path (path, strlen (path), &decomposed_path, NULL))
5153     return FALSE;
5154
5155   CONNECTION_LOCK (connection);
5156
5157   *data_p = _dbus_object_tree_get_user_data_unlocked (connection->objects, (const char**) decomposed_path);
5158
5159   CONNECTION_UNLOCK (connection);
5160
5161   dbus_free_string_array (decomposed_path);
5162
5163   return TRUE;
5164 }
5165
5166 /**
5167  * Lists the registered fallback handlers and object path handlers at
5168  * the given parent_path. The returned array should be freed with
5169  * dbus_free_string_array().
5170  *
5171  * @param connection the connection
5172  * @param parent_path the path to list the child handlers of
5173  * @param child_entries returns #NULL-terminated array of children
5174  * @returns #FALSE if no memory to allocate the child entries
5175  */
5176 dbus_bool_t
5177 dbus_connection_list_registered (DBusConnection              *connection,
5178                                  const char                  *parent_path,
5179                                  char                      ***child_entries)
5180 {
5181   char **decomposed_path;
5182   dbus_bool_t retval;
5183   _dbus_return_val_if_fail (connection != NULL, FALSE);
5184   _dbus_return_val_if_fail (parent_path != NULL, FALSE);
5185   _dbus_return_val_if_fail (parent_path[0] == '/', FALSE);
5186   _dbus_return_val_if_fail (child_entries != NULL, FALSE);
5187
5188   if (!_dbus_decompose_path (parent_path, strlen (parent_path), &decomposed_path, NULL))
5189     return FALSE;
5190
5191   CONNECTION_LOCK (connection);
5192
5193   retval = _dbus_object_tree_list_registered_and_unlock (connection->objects,
5194                                                          (const char **) decomposed_path,
5195                                                          child_entries);
5196   dbus_free_string_array (decomposed_path);
5197
5198   return retval;
5199 }
5200
5201 static DBusDataSlotAllocator slot_allocator;
5202 _DBUS_DEFINE_GLOBAL_LOCK (connection_slots);
5203
5204 /**
5205  * Allocates an integer ID to be used for storing application-specific
5206  * data on any DBusConnection. The allocated ID may then be used
5207  * with dbus_connection_set_data() and dbus_connection_get_data().
5208  * The passed-in slot must be initialized to -1, and is filled in
5209  * with the slot ID. If the passed-in slot is not -1, it's assumed
5210  * to be already allocated, and its refcount is incremented.
5211  *
5212  * The allocated slot is global, i.e. all DBusConnection objects will
5213  * have a slot with the given integer ID reserved.
5214  *
5215  * @param slot_p address of a global variable storing the slot
5216  * @returns #FALSE on failure (no memory)
5217  */
5218 dbus_bool_t
5219 dbus_connection_allocate_data_slot (dbus_int32_t *slot_p)
5220 {
5221   return _dbus_data_slot_allocator_alloc (&slot_allocator,
5222                                           &_DBUS_LOCK_NAME (connection_slots),
5223                                           slot_p);
5224 }
5225
5226 /**
5227  * Deallocates a global ID for connection data slots.
5228  * dbus_connection_get_data() and dbus_connection_set_data() may no
5229  * longer be used with this slot.  Existing data stored on existing
5230  * DBusConnection objects will be freed when the connection is
5231  * finalized, but may not be retrieved (and may only be replaced if
5232  * someone else reallocates the slot).  When the refcount on the
5233  * passed-in slot reaches 0, it is set to -1.
5234  *
5235  * @param slot_p address storing the slot to deallocate
5236  */
5237 void
5238 dbus_connection_free_data_slot (dbus_int32_t *slot_p)
5239 {
5240   _dbus_return_if_fail (*slot_p >= 0);
5241
5242   _dbus_data_slot_allocator_free (&slot_allocator, slot_p);
5243 }
5244
5245 /**
5246  * Stores a pointer on a DBusConnection, along
5247  * with an optional function to be used for freeing
5248  * the data when the data is set again, or when
5249  * the connection is finalized. The slot number
5250  * must have been allocated with dbus_connection_allocate_data_slot().
5251  *
5252  * @param connection the connection
5253  * @param slot the slot number
5254  * @param data the data to store
5255  * @param free_data_func finalizer function for the data
5256  * @returns #TRUE if there was enough memory to store the data
5257  */
5258 dbus_bool_t
5259 dbus_connection_set_data (DBusConnection   *connection,
5260                           dbus_int32_t      slot,
5261                           void             *data,
5262                           DBusFreeFunction  free_data_func)
5263 {
5264   DBusFreeFunction old_free_func;
5265   void *old_data;
5266   dbus_bool_t retval;
5267
5268   _dbus_return_val_if_fail (connection != NULL, FALSE);
5269   _dbus_return_val_if_fail (slot >= 0, FALSE);
5270
5271   CONNECTION_LOCK (connection);
5272
5273   retval = _dbus_data_slot_list_set (&slot_allocator,
5274                                      &connection->slot_list,
5275                                      slot, data, free_data_func,
5276                                      &old_free_func, &old_data);
5277
5278   CONNECTION_UNLOCK (connection);
5279
5280   if (retval)
5281     {
5282       /* Do the actual free outside the connection lock */
5283       if (old_free_func)
5284         (* old_free_func) (old_data);
5285     }
5286
5287   return retval;
5288 }
5289
5290 /**
5291  * Retrieves data previously set with dbus_connection_set_data().
5292  * The slot must still be allocated (must not have been freed).
5293  *
5294  * @param connection the connection
5295  * @param slot the slot to get data from
5296  * @returns the data, or #NULL if not found
5297  */
5298 void*
5299 dbus_connection_get_data (DBusConnection   *connection,
5300                           dbus_int32_t      slot)
5301 {
5302   void *res;
5303
5304   _dbus_return_val_if_fail (connection != NULL, NULL);
5305
5306   CONNECTION_LOCK (connection);
5307
5308   res = _dbus_data_slot_list_get (&slot_allocator,
5309                                   &connection->slot_list,
5310                                   slot);
5311
5312   CONNECTION_UNLOCK (connection);
5313
5314   return res;
5315 }
5316
5317 /**
5318  * This function sets a global flag for whether dbus_connection_new()
5319  * will set SIGPIPE behavior to SIG_IGN.
5320  *
5321  * @param will_modify_sigpipe #TRUE to allow sigpipe to be set to SIG_IGN
5322  */
5323 void
5324 dbus_connection_set_change_sigpipe (dbus_bool_t will_modify_sigpipe)
5325 {
5326   _dbus_modify_sigpipe = will_modify_sigpipe != FALSE;
5327 }
5328
5329 /**
5330  * Specifies the maximum size message this connection is allowed to
5331  * receive. Larger messages will result in disconnecting the
5332  * connection.
5333  *
5334  * @param connection a #DBusConnection
5335  * @param size maximum message size the connection can receive, in bytes
5336  */
5337 void
5338 dbus_connection_set_max_message_size (DBusConnection *connection,
5339                                       long            size)
5340 {
5341   _dbus_return_if_fail (connection != NULL);
5342
5343   CONNECTION_LOCK (connection);
5344   _dbus_transport_set_max_message_size (connection->transport,
5345                                         size);
5346   CONNECTION_UNLOCK (connection);
5347 }
5348
5349 /**
5350  * Gets the value set by dbus_connection_set_max_message_size().
5351  *
5352  * @param connection the connection
5353  * @returns the max size of a single message
5354  */
5355 long
5356 dbus_connection_get_max_message_size (DBusConnection *connection)
5357 {
5358   long res;
5359
5360   _dbus_return_val_if_fail (connection != NULL, 0);
5361
5362   CONNECTION_LOCK (connection);
5363   res = _dbus_transport_get_max_message_size (connection->transport);
5364   CONNECTION_UNLOCK (connection);
5365   return res;
5366 }
5367
5368 /**
5369  * Sets the maximum total number of bytes that can be used for all messages
5370  * received on this connection. Messages count toward the maximum until
5371  * they are finalized. When the maximum is reached, the connection will
5372  * not read more data until some messages are finalized.
5373  *
5374  * The semantics of the maximum are: if outstanding messages are
5375  * already above the maximum, additional messages will not be read.
5376  * The semantics are not: if the next message would cause us to exceed
5377  * the maximum, we don't read it. The reason is that we don't know the
5378  * size of a message until after we read it.
5379  *
5380  * Thus, the max live messages size can actually be exceeded
5381  * by up to the maximum size of a single message.
5382  *
5383  * Also, if we read say 1024 bytes off the wire in a single read(),
5384  * and that contains a half-dozen small messages, we may exceed the
5385  * size max by that amount. But this should be inconsequential.
5386  *
5387  * This does imply that we can't call read() with a buffer larger
5388  * than we're willing to exceed this limit by.
5389  *
5390  * @param connection the connection
5391  * @param size the maximum size in bytes of all outstanding messages
5392  */
5393 void
5394 dbus_connection_set_max_received_size (DBusConnection *connection,
5395                                        long            size)
5396 {
5397   _dbus_return_if_fail (connection != NULL);
5398
5399   CONNECTION_LOCK (connection);
5400   _dbus_transport_set_max_received_size (connection->transport,
5401                                          size);
5402   CONNECTION_UNLOCK (connection);
5403 }
5404
5405 /**
5406  * Gets the value set by dbus_connection_set_max_received_size().
5407  *
5408  * @param connection the connection
5409  * @returns the max size of all live messages
5410  */
5411 long
5412 dbus_connection_get_max_received_size (DBusConnection *connection)
5413 {
5414   long res;
5415
5416   _dbus_return_val_if_fail (connection != NULL, 0);
5417
5418   CONNECTION_LOCK (connection);
5419   res = _dbus_transport_get_max_received_size (connection->transport);
5420   CONNECTION_UNLOCK (connection);
5421   return res;
5422 }
5423
5424 /**
5425  * Gets the approximate size in bytes of all messages in the outgoing
5426  * message queue. The size is approximate in that you shouldn't use
5427  * it to decide how many bytes to read off the network or anything
5428  * of that nature, as optimizations may choose to tell small white lies
5429  * to avoid performance overhead.
5430  *
5431  * @param connection the connection
5432  * @returns the number of bytes that have been queued up but not sent
5433  */
5434 long
5435 dbus_connection_get_outgoing_size (DBusConnection *connection)
5436 {
5437   long res;
5438
5439   _dbus_return_val_if_fail (connection != NULL, 0);
5440
5441   CONNECTION_LOCK (connection);
5442   res = _dbus_counter_get_value (connection->outgoing_counter);
5443   CONNECTION_UNLOCK (connection);
5444   return res;
5445 }
5446
5447 /**
5448  * Obtains the machine UUID of the machine this process is running on.
5449  *
5450  * The returned string must be freed with dbus_free().
5451  *
5452  * This UUID is guaranteed to remain the same until the next reboot
5453  * (unless the sysadmin foolishly changes it and screws themselves).
5454  * It will usually remain the same across reboots also, but hardware
5455  * configuration changes or rebuilding the machine could break that.
5456  *
5457  * The idea is that two processes with the same machine ID should be
5458  * able to use shared memory, UNIX domain sockets, process IDs, and other
5459  * features of the OS that require both processes to be running
5460  * on the same OS kernel instance.
5461  *
5462  * The machine ID can also be used to create unique per-machine
5463  * instances. For example, you could use it in bus names or
5464  * X selection names.
5465  *
5466  * The machine ID is preferred over the machine hostname, because
5467  * the hostname is frequently set to "localhost.localdomain" and
5468  * may also change at runtime.
5469  *
5470  * You can get the machine ID of a remote application by invoking the
5471  * method GetMachineId from interface org.freedesktop.DBus.Peer.
5472  *
5473  * If the remote application has the same machine ID as the one
5474  * returned by this function, then the remote application is on the
5475  * same machine as your application.
5476  *
5477  * @returns a 32-byte-long hex-encoded UUID string, or #NULL if insufficient memory
5478  */
5479 char*
5480 dbus_get_local_machine_id (void)
5481 {
5482   DBusString uuid;
5483   char *s;
5484
5485   s = NULL;
5486   _dbus_string_init (&uuid);
5487   if (!_dbus_get_local_machine_uuid_encoded (&uuid) ||
5488       !_dbus_string_steal_data (&uuid, &s))
5489     {
5490       _dbus_string_free (&uuid);
5491       return FALSE;
5492     }
5493   else
5494     {
5495       _dbus_string_free (&uuid);
5496       return s;
5497     }
5498
5499 }
5500
5501 /** @} */