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