dbus/dbus-connection.c

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