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