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