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