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