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