-/* -*- mode: C; c-file-style: "gnu" -*- */
+/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
/* dbus-server.c DBusServer object
*
- * Copyright (C) 2002, 2003 Red Hat Inc.
+ * Copyright (C) 2002, 2003, 2004, 2005 Red Hat Inc.
*
- * Licensed under the Academic Free License version 1.2
+ * Licensed under the Academic Free License version 2.1
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
*/
+#include <config.h>
#include "dbus-server.h"
#include "dbus-server-unix.h"
-#ifdef DBUS_BUILD_TESTS
-#include "dbus-server-debug.h"
+#include "dbus-server-socket.h"
+#include "dbus-string.h"
+#ifdef DBUS_ENABLE_EMBEDDED_TESTS
#include "dbus-server-debug-pipe.h"
#endif
#include "dbus-address.h"
+#include "dbus-protocol.h"
/**
* @defgroup DBusServer DBusServer
* @ingroup DBus
* @brief Server that listens for new connections.
*
- * Types and functions related to DBusServer.
* A DBusServer represents a server that other applications
* can connect to. Each connection from another application
- * is represented by a DBusConnection.
+ * is represented by a #DBusConnection.
*
- * @todo Thread safety hasn't been looked at for #DBusServer
+ * @todo Thread safety hasn't been tested much for #DBusServer
* @todo Need notification to apps of disconnection, may matter for some transports
*/
* @{
*/
+#ifndef _dbus_server_trace_ref
+void
+_dbus_server_trace_ref (DBusServer *server,
+ int old_refcount,
+ int new_refcount,
+ const char *why)
+{
+ static int enabled = -1;
+
+ _dbus_trace_ref ("DBusServer", server, old_refcount, new_refcount, why,
+ "DBUS_SERVER_TRACE", &enabled);
+}
+#endif
+
+/* this is a little fragile since it assumes the address doesn't
+ * already have a guid, but it shouldn't
+ */
+static char*
+copy_address_with_guid_appended (const DBusString *address,
+ const DBusString *guid_hex)
+{
+ DBusString with_guid;
+ char *retval;
+
+ if (!_dbus_string_init (&with_guid))
+ return NULL;
+
+ if (!_dbus_string_copy (address, 0, &with_guid,
+ _dbus_string_get_length (&with_guid)) ||
+ !_dbus_string_append (&with_guid, ",guid=") ||
+ !_dbus_string_copy (guid_hex, 0,
+ &with_guid, _dbus_string_get_length (&with_guid)))
+ {
+ _dbus_string_free (&with_guid);
+ return NULL;
+ }
+
+ retval = NULL;
+ _dbus_string_steal_data (&with_guid, &retval);
+
+ _dbus_string_free (&with_guid);
+
+ return retval; /* may be NULL if steal_data failed */
+}
+
/**
* Initializes the members of the DBusServer base class.
* Chained up to by subclass constructors.
const DBusString *address)
{
server->vtable = vtable;
- server->refcount = 1;
+
+#ifdef DBUS_DISABLE_ASSERT
+ _dbus_atomic_inc (&server->refcount);
+#else
+ {
+ dbus_int32_t old_refcount = _dbus_atomic_inc (&server->refcount);
+
+ _dbus_assert (old_refcount == 0);
+ }
+#endif
server->address = NULL;
server->watches = NULL;
server->timeouts = NULL;
+ server->published_address = FALSE;
+
+ if (!_dbus_string_init (&server->guid_hex))
+ return FALSE;
+
+ _dbus_generate_uuid (&server->guid);
+
+ if (!_dbus_uuid_encode (&server->guid, &server->guid_hex))
+ goto failed;
+
+ server->address = copy_address_with_guid_appended (address,
+ &server->guid_hex);
+ if (server->address == NULL)
+ goto failed;
- if (!_dbus_string_copy_data (address, &server->address))
+ _dbus_rmutex_new_at_location (&server->mutex);
+ if (server->mutex == NULL)
goto failed;
server->watches = _dbus_watch_list_new ();
return TRUE;
failed:
+ _dbus_rmutex_free_at_location (&server->mutex);
+ server->mutex = NULL;
if (server->watches)
{
_dbus_watch_list_free (server->watches);
dbus_free (server->address);
server->address = NULL;
}
+ _dbus_string_free (&server->guid_hex);
return FALSE;
}
+#ifdef ENABLE_KDBUS_TRANSPORT
+static void mini_vtable_dummy_func(DBusServer *server)
+{
+ // Used to prevent assert errors. Pointer to function is passed to
+ // DBusServerVTable which is passed to server->vtable in
+ // dbus_server_init_mini function.
+}
+
+DBusServer*
+dbus_server_init_mini (char* address)
+{
+ DBusServer *server;
+
+ static const DBusServerVTable dbus_server_init_mini_vtable = {
+ mini_vtable_dummy_func,
+ mini_vtable_dummy_func
+ };
+
+ server = dbus_new0(struct DBusServer, 1);
+ if(server == NULL)
+ return NULL;
+
+ memset(server, 0, sizeof(struct DBusServer));
+ _dbus_rmutex_new_at_location (&server->mutex);
+ if (server->mutex == NULL)
+ goto failed;
+ server->address = address;
+
+ server->vtable = &dbus_server_init_mini_vtable;
+
+ _dbus_atomic_inc (&server->refcount);
+
+ server->watches = _dbus_watch_list_new ();
+ if (server->watches == NULL)
+ goto failed;
+
+ server->timeouts = _dbus_timeout_list_new();
+ if (server->timeouts == NULL)
+ goto failed;
+
+ return server;
+
+failed:
+ dbus_free(server);
+ return NULL;
+}
+#endif
+
+
/**
* Finalizes the members of the DBusServer base class.
* Chained up to by subclass finalizers.
void
_dbus_server_finalize_base (DBusServer *server)
{
+ /* We don't have the lock, but nobody should be accessing
+ * concurrently since they don't have a ref
+ */
+#ifndef DBUS_DISABLE_CHECKS
+ _dbus_assert (!server->have_server_lock);
+#endif
+ _dbus_assert (server->disconnected);
+
/* calls out to application code... */
_dbus_data_slot_list_free (&server->slot_list);
dbus_server_set_new_connection_function (server, NULL, NULL, NULL);
- if (!server->disconnected)
- dbus_server_disconnect (server);
-
_dbus_watch_list_free (server->watches);
_dbus_timeout_list_free (server->timeouts);
+ _dbus_rmutex_free_at_location (&server->mutex);
+
dbus_free (server->address);
dbus_free_string_array (server->auth_mechanisms);
+
+ _dbus_string_free (&server->guid_hex);
+}
+
+
+/** Function to be called in protected_change_watch() with refcount held */
+typedef dbus_bool_t (* DBusWatchAddFunction) (DBusWatchList *list,
+ DBusWatch *watch);
+/** Function to be called in protected_change_watch() with refcount held */
+typedef void (* DBusWatchRemoveFunction) (DBusWatchList *list,
+ DBusWatch *watch);
+/** Function to be called in protected_change_watch() with refcount held */
+typedef void (* DBusWatchToggleFunction) (DBusWatchList *list,
+ DBusWatch *watch,
+ dbus_bool_t enabled);
+
+static dbus_bool_t
+protected_change_watch (DBusServer *server,
+ DBusWatch *watch,
+ DBusWatchAddFunction add_function,
+ DBusWatchRemoveFunction remove_function,
+ DBusWatchToggleFunction toggle_function,
+ dbus_bool_t enabled)
+{
+ DBusWatchList *watches;
+ dbus_bool_t retval;
+
+ HAVE_LOCK_CHECK (server);
+
+ /* This isn't really safe or reasonable; a better pattern is the "do
+ * everything, then drop lock and call out" one; but it has to be
+ * propagated up through all callers
+ */
+
+ watches = server->watches;
+ if (watches)
+ {
+ server->watches = NULL;
+ _dbus_server_ref_unlocked (server);
+ SERVER_UNLOCK (server);
+
+ if (add_function)
+ retval = (* add_function) (watches, watch);
+ else if (remove_function)
+ {
+ retval = TRUE;
+ (* remove_function) (watches, watch);
+ }
+ else
+ {
+ retval = TRUE;
+ (* toggle_function) (watches, watch, enabled);
+ }
+
+ SERVER_LOCK (server);
+ server->watches = watches;
+ _dbus_server_unref_unlocked (server);
+
+ return retval;
+ }
+ else
+ return FALSE;
}
/**
_dbus_server_add_watch (DBusServer *server,
DBusWatch *watch)
{
- return _dbus_watch_list_add_watch (server->watches, watch);
+ HAVE_LOCK_CHECK (server);
+ return protected_change_watch (server, watch,
+ _dbus_watch_list_add_watch,
+ NULL, NULL, FALSE);
}
/**
_dbus_server_remove_watch (DBusServer *server,
DBusWatch *watch)
{
- _dbus_watch_list_remove_watch (server->watches, watch);
+ HAVE_LOCK_CHECK (server);
+ protected_change_watch (server, watch,
+ NULL,
+ _dbus_watch_list_remove_watch,
+ NULL, FALSE);
}
/**
DBusWatch *watch,
dbus_bool_t enabled)
{
- if (server->watches) /* null during finalize */
- _dbus_watch_list_toggle_watch (server->watches,
- watch, enabled);
+ _dbus_assert (watch != NULL);
+
+ HAVE_LOCK_CHECK (server);
+ protected_change_watch (server, watch,
+ NULL, NULL,
+ _dbus_watch_list_toggle_watch,
+ enabled);
+}
+
+/** Function to be called in protected_change_timeout() with refcount held */
+typedef dbus_bool_t (* DBusTimeoutAddFunction) (DBusTimeoutList *list,
+ DBusTimeout *timeout);
+/** Function to be called in protected_change_timeout() with refcount held */
+typedef void (* DBusTimeoutRemoveFunction) (DBusTimeoutList *list,
+ DBusTimeout *timeout);
+/** Function to be called in protected_change_timeout() with refcount held */
+typedef void (* DBusTimeoutToggleFunction) (DBusTimeoutList *list,
+ DBusTimeout *timeout,
+ dbus_bool_t enabled);
+
+
+static dbus_bool_t
+protected_change_timeout (DBusServer *server,
+ DBusTimeout *timeout,
+ DBusTimeoutAddFunction add_function,
+ DBusTimeoutRemoveFunction remove_function,
+ DBusTimeoutToggleFunction toggle_function,
+ dbus_bool_t enabled)
+{
+ DBusTimeoutList *timeouts;
+ dbus_bool_t retval;
+
+ HAVE_LOCK_CHECK (server);
+
+ /* This isn't really safe or reasonable; a better pattern is the "do everything, then
+ * drop lock and call out" one; but it has to be propagated up through all callers
+ */
+
+ timeouts = server->timeouts;
+ if (timeouts)
+ {
+ server->timeouts = NULL;
+ _dbus_server_ref_unlocked (server);
+ SERVER_UNLOCK (server);
+
+ if (add_function)
+ retval = (* add_function) (timeouts, timeout);
+ else if (remove_function)
+ {
+ retval = TRUE;
+ (* remove_function) (timeouts, timeout);
+ }
+ else
+ {
+ retval = TRUE;
+ (* toggle_function) (timeouts, timeout, enabled);
+ }
+
+ SERVER_LOCK (server);
+ server->timeouts = timeouts;
+ _dbus_server_unref_unlocked (server);
+
+ return retval;
+ }
+ else
+ return FALSE;
}
/**
_dbus_server_add_timeout (DBusServer *server,
DBusTimeout *timeout)
{
- return _dbus_timeout_list_add_timeout (server->timeouts, timeout);
+ return protected_change_timeout (server, timeout,
+ _dbus_timeout_list_add_timeout,
+ NULL, NULL, FALSE);
}
/**
_dbus_server_remove_timeout (DBusServer *server,
DBusTimeout *timeout)
{
- _dbus_timeout_list_remove_timeout (server->timeouts, timeout);
+ protected_change_timeout (server, timeout,
+ NULL,
+ _dbus_timeout_list_remove_timeout,
+ NULL, FALSE);
}
/**
DBusTimeout *timeout,
dbus_bool_t enabled)
{
- if (server->timeouts) /* null during finalize */
- _dbus_timeout_list_toggle_timeout (server->timeouts,
- timeout, enabled);
+ protected_change_timeout (server, timeout,
+ NULL, NULL,
+ _dbus_timeout_list_toggle_timeout,
+ enabled);
}
+/**
+ * Like dbus_server_ref() but does not acquire the lock (must already be held)
+ *
+ * @param server the server.
+ */
+void
+_dbus_server_ref_unlocked (DBusServer *server)
+{
+ dbus_int32_t old_refcount;
+
+ _dbus_assert (server != NULL);
+ HAVE_LOCK_CHECK (server);
+
+ old_refcount = _dbus_atomic_inc (&server->refcount);
+ _dbus_assert (old_refcount > 0);
+ _dbus_server_trace_ref (server, old_refcount, old_refcount + 1,
+ "ref_unlocked");
+}
+
+/**
+ * Like dbus_server_unref() but does not acquire the lock (must already be held)
+ *
+ * @param server the server.
+ */
+void
+_dbus_server_unref_unlocked (DBusServer *server)
+{
+ dbus_int32_t old_refcount;
+
+ /* Keep this in sync with dbus_server_unref */
+
+ _dbus_assert (server != NULL);
+
+ HAVE_LOCK_CHECK (server);
+
+ old_refcount = _dbus_atomic_dec (&server->refcount);
+ _dbus_assert (old_refcount > 0);
+
+ _dbus_server_trace_ref (server, old_refcount, old_refcount - 1,
+ "unref_unlocked");
+
+ if (old_refcount == 1)
+ {
+ _dbus_assert (server->disconnected);
+
+ SERVER_UNLOCK (server);
+
+ _dbus_assert (server->vtable->finalize != NULL);
+
+ (* server->vtable->finalize) (server);
+ }
+}
+
/** @} */
/**
*
*/
+static const struct {
+ DBusServerListenResult (* func) (DBusAddressEntry *entry,
+ DBusServer **server_p,
+ DBusError *error);
+} listen_funcs[] = {
+ { _dbus_server_listen_socket }
+ , { _dbus_server_listen_platform_specific }
+#ifdef DBUS_ENABLE_EMBEDDED_TESTS
+ , { _dbus_server_listen_debug_pipe }
+#endif
+};
+
/**
- * Listens for new connections on the given address.
- * Returns #NULL if listening fails for any reason.
+ * Listens for new connections on the given address. If there are
+ * multiple semicolon-separated address entries in the address, tries
+ * each one and listens on the first one that works.
+ *
+ * Returns #NULL and sets error if listening fails for any reason.
* Otherwise returns a new #DBusServer.
- * dbus_server_set_new_connection_function() and
- * dbus_server_set_watch_functions() should be called
- * immediately to render the server fully functional.
- *
- * @todo error messages on bad address could really be better.
- * DBusResultCode is a bit limiting here.
+ * dbus_server_set_new_connection_function(),
+ * dbus_server_set_watch_functions(), and
+ * dbus_server_set_timeout_functions() should be called immediately to
+ * render the server fully functional.
*
+ * To free the server, applications must call first
+ * dbus_server_disconnect() and then dbus_server_unref().
+ *
* @param address the address of this server.
- * @param error location to store rationale for failure.
- * @returns a new DBusServer, or #NULL on failure.
+ * @param error location to store reason for failure.
+ * @returns a new #DBusServer, or #NULL on failure.
*
*/
DBusServer*
DBusServer *server;
DBusAddressEntry **entries;
int len, i;
- const char *address_problem_type;
- const char *address_problem_field;
- const char *address_problem_other;
-
- _DBUS_ASSERT_ERROR_IS_CLEAR (error);
+ DBusError first_connect_error = DBUS_ERROR_INIT;
+ dbus_bool_t handled_once;
+
+ _dbus_return_val_if_fail (address != NULL, NULL);
+ _dbus_return_val_if_error_is_set (error, NULL);
if (!dbus_parse_address (address, &entries, &len, error))
return NULL;
server = NULL;
- address_problem_type = NULL;
- address_problem_field = NULL;
- address_problem_other = NULL;
-
+ handled_once = FALSE;
+
for (i = 0; i < len; i++)
{
- const char *method = dbus_address_entry_get_method (entries[i]);
-
- if (strcmp (method, "unix") == 0)
- {
- const char *path = dbus_address_entry_get_value (entries[i], "path");
- const char *tmpdir = dbus_address_entry_get_value (entries[i], "tmpdir");
-
- if (path == NULL && tmpdir == NULL)
- {
- address_problem_type = "unix";
- address_problem_field = "path or tmpdir";
- goto bad_address;
- }
+ int j;
- if (path && tmpdir)
- {
- address_problem_other = "cannot specify both \"path\" and \"tmpdir\" at the same time";
- goto bad_address;
- }
+ for (j = 0; j < (int) _DBUS_N_ELEMENTS (listen_funcs); ++j)
+ {
+ DBusServerListenResult result;
+ DBusError tmp_error = DBUS_ERROR_INIT;
- if (tmpdir != NULL)
- {
- DBusString full_path;
- DBusString filename;
-
- if (!_dbus_string_init (&full_path))
- {
- dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
- goto out;
- }
-
- if (!_dbus_string_init (&filename))
- {
- _dbus_string_free (&full_path);
- dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
- goto out;
- }
-
- if (!_dbus_string_append (&filename,
- "dbus-") ||
- !_dbus_generate_random_ascii (&filename, 10) ||
- !_dbus_string_append (&full_path, tmpdir) ||
- !_dbus_concat_dir_and_file (&full_path, &filename))
- {
- _dbus_string_free (&full_path);
- _dbus_string_free (&filename);
- dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
- goto out;
- }
-
- /* FIXME - we will unconditionally unlink() the path.
- * unlink() does not follow symlinks, but would like
- * independent confirmation this is safe enough. See
- * also _dbus_listen_unix_socket() and comments therein.
- */
-
- server =
- _dbus_server_new_for_domain_socket (_dbus_string_get_const_data (&full_path),
- error);
+ result = (* listen_funcs[j].func) (entries[i],
+ &server,
+ &tmp_error);
- _dbus_string_free (&full_path);
- _dbus_string_free (&filename);
- }
- else
+ if (result == DBUS_SERVER_LISTEN_OK)
{
- server = _dbus_server_new_for_domain_socket (path, error);
+ _dbus_assert (server != NULL);
+ _DBUS_ASSERT_ERROR_IS_CLEAR (&tmp_error);
+ handled_once = TRUE;
+ goto out;
}
- }
- else if (strcmp (method, "tcp") == 0)
- {
- const char *host = dbus_address_entry_get_value (entries[i], "host");
- const char *port = dbus_address_entry_get_value (entries[i], "port");
- DBusString str;
- long lport;
- dbus_bool_t sresult;
-
- if (port == NULL)
+ else if (result == DBUS_SERVER_LISTEN_ADDRESS_ALREADY_USED)
{
- address_problem_type = "tcp";
- address_problem_field = "port";
- goto bad_address;
+ _dbus_assert (server == NULL);
+ dbus_set_error (error,
+ DBUS_ERROR_ADDRESS_IN_USE,
+ "Address '%s' already used",
+ dbus_address_entry_get_method (entries[0]));
+ handled_once = TRUE;
+ goto out;
}
-
- _dbus_string_init_const (&str, port);
- sresult = _dbus_string_parse_int (&str, 0, &lport, NULL);
- _dbus_string_free (&str);
-
- if (sresult == FALSE || lport <= 0 || lport > 65535)
+ else if (result == DBUS_SERVER_LISTEN_BAD_ADDRESS)
{
- address_problem_other = "Port is not an integer between 0 and 65535";
- goto bad_address;
+ _dbus_assert (server == NULL);
+ _DBUS_ASSERT_ERROR_IS_SET (&tmp_error);
+ dbus_move_error (&tmp_error, error);
+ handled_once = TRUE;
+ goto out;
}
-
- server = _dbus_server_new_for_tcp_socket (host, lport, error);
-
- if (server)
- break;
- }
-#ifdef DBUS_BUILD_TESTS
- else if (strcmp (method, "debug") == 0)
- {
- const char *name = dbus_address_entry_get_value (entries[i], "name");
-
- if (name == NULL)
+ else if (result == DBUS_SERVER_LISTEN_NOT_HANDLED)
{
- address_problem_type = "debug";
- address_problem_field = "name";
- goto bad_address;
- }
-
- server = _dbus_server_debug_new (name, error);
- }
- else if (strcmp (method, "debug-pipe") == 0)
- {
- const char *name = dbus_address_entry_get_value (entries[i], "name");
+ _dbus_assert (server == NULL);
+ _DBUS_ASSERT_ERROR_IS_CLEAR (&tmp_error);
- if (name == NULL)
+ /* keep trying addresses */
+ }
+ else if (result == DBUS_SERVER_LISTEN_DID_NOT_CONNECT)
{
- address_problem_type = "debug-pipe";
- address_problem_field = "name";
- goto bad_address;
+ _dbus_assert (server == NULL);
+ _DBUS_ASSERT_ERROR_IS_SET (&tmp_error);
+ if (!dbus_error_is_set (&first_connect_error))
+ dbus_move_error (&tmp_error, &first_connect_error);
+ else
+ dbus_error_free (&tmp_error);
+
+ handled_once = TRUE;
+
+ /* keep trying addresses */
}
-
- server = _dbus_server_debug_pipe_new (name, error);
- }
-#endif
- else
- {
- address_problem_other = "Unknown address type (examples of valid types are \"unix\" and \"tcp\")";
- goto bad_address;
}
-
- if (server)
- break;
+
+ _dbus_assert (server == NULL);
+ _DBUS_ASSERT_ERROR_IS_CLEAR (error);
}
out:
+
+ if (!handled_once)
+ {
+ _DBUS_ASSERT_ERROR_IS_CLEAR (error);
+ if (len > 0)
+ dbus_set_error (error,
+ DBUS_ERROR_BAD_ADDRESS,
+ "Unknown address type '%s'",
+ dbus_address_entry_get_method (entries[0]));
+ else
+ dbus_set_error (error,
+ DBUS_ERROR_BAD_ADDRESS,
+ "Empty address '%s'",
+ address);
+ }
dbus_address_entries_free (entries);
- return server;
- bad_address:
- dbus_address_entries_free (entries);
- if (address_problem_type != NULL)
- dbus_set_error (error, DBUS_ERROR_BAD_ADDRESS,
- "Server address of type %s was missing argument %s",
- address_problem_type, address_problem_field);
- else
- dbus_set_error (error, DBUS_ERROR_BAD_ADDRESS,
- "Could not parse server address: %s",
- address_problem_other);
+ if (server == NULL)
+ {
+ _dbus_assert (error == NULL || dbus_error_is_set (&first_connect_error) ||
+ dbus_error_is_set (error));
+
+ if (error && dbus_error_is_set (error))
+ {
+ /* already set the error */
+ }
+ else
+ {
+ /* didn't set the error but either error should be
+ * NULL or first_connect_error should be set.
+ */
+ _dbus_assert (error == NULL || dbus_error_is_set (&first_connect_error));
+ dbus_move_error (&first_connect_error, error);
+ }
- return NULL;
+ _DBUS_ASSERT_ERROR_IS_CLEAR (&first_connect_error); /* be sure we freed it */
+ _DBUS_ASSERT_ERROR_IS_SET (error);
+
+ return NULL;
+ }
+ else
+ {
+ _DBUS_ASSERT_ERROR_IS_CLEAR (error);
+ return server;
+ }
}
/**
* Increments the reference count of a DBusServer.
*
* @param server the server.
+ * @returns the server
*/
-void
+DBusServer *
dbus_server_ref (DBusServer *server)
{
- server->refcount += 1;
+ dbus_int32_t old_refcount;
+
+ _dbus_return_val_if_fail (server != NULL, NULL);
+
+ old_refcount = _dbus_atomic_inc (&server->refcount);
+
+#ifndef DBUS_DISABLE_CHECKS
+ if (_DBUS_UNLIKELY (old_refcount <= 0))
+ {
+ _dbus_atomic_dec (&server->refcount);
+ _dbus_warn_check_failed (_dbus_return_if_fail_warning_format,
+ _DBUS_FUNCTION_NAME, "old_refcount > 0",
+ __FILE__, __LINE__);
+ return NULL;
+ }
+#endif
+
+ _dbus_server_trace_ref (server, old_refcount, old_refcount + 1, "ref");
+
+ return server;
}
/**
* Decrements the reference count of a DBusServer. Finalizes the
- * server if the reference count reaches zero. The server connection
- * will be closed as with dbus_server_disconnect() when the server is
- * finalized.
+ * server if the reference count reaches zero.
+ *
+ * The server must be disconnected before the refcount reaches zero.
*
* @param server the server.
*/
void
dbus_server_unref (DBusServer *server)
{
- _dbus_assert (server != NULL);
- _dbus_assert (server->refcount > 0);
+ dbus_int32_t old_refcount;
+
+ /* keep this in sync with unref_unlocked */
+
+ _dbus_return_if_fail (server != NULL);
+
+ old_refcount = _dbus_atomic_dec (&server->refcount);
+
+#ifndef DBUS_DISABLE_CHECKS
+ if (_DBUS_UNLIKELY (old_refcount <= 0))
+ {
+ /* undo side-effect first
+ * please do not try to simplify the code here by using
+ * _dbus_atomic_get(), why we don't use it is
+ * because it issues another atomic operation even though
+ * DBUS_DISABLE_CHECKS defined.
+ * Bug: https://bugs.freedesktop.org/show_bug.cgi?id=68303
+ */
+ _dbus_atomic_inc (&server->refcount);
+ _dbus_warn_check_failed (_dbus_return_if_fail_warning_format,
+ _DBUS_FUNCTION_NAME, "old_refcount > 0",
+ __FILE__, __LINE__);
+ return;
+ }
+#endif
+
+ _dbus_server_trace_ref (server, old_refcount, old_refcount - 1, "unref");
- server->refcount -= 1;
- if (server->refcount == 0)
+ if (old_refcount == 1)
{
+ /* lock not held! */
+ _dbus_assert (server->disconnected);
+
_dbus_assert (server->vtable->finalize != NULL);
(* server->vtable->finalize) (server);
void
dbus_server_disconnect (DBusServer *server)
{
+ _dbus_return_if_fail (server != NULL);
+
+ dbus_server_ref (server);
+ SERVER_LOCK (server);
+
_dbus_assert (server->vtable->disconnect != NULL);
- if (server->disconnected)
- return;
-
- (* server->vtable->disconnect) (server);
- server->disconnected = TRUE;
+ if (!server->disconnected)
+ {
+ /* this has to be first so recursive calls to disconnect don't happen */
+ server->disconnected = TRUE;
+
+ (* server->vtable->disconnect) (server);
+ }
+
+ SERVER_UNLOCK (server);
+ dbus_server_unref (server);
}
/**
dbus_bool_t
dbus_server_get_is_connected (DBusServer *server)
{
- return !server->disconnected;
+ dbus_bool_t retval;
+
+ _dbus_return_val_if_fail (server != NULL, FALSE);
+
+ SERVER_LOCK (server);
+ retval = !server->disconnected;
+ SERVER_UNLOCK (server);
+
+ return retval;
}
/**
char*
dbus_server_get_address (DBusServer *server)
{
- return _dbus_strdup (server->address);
+ char *retval;
+
+ _dbus_return_val_if_fail (server != NULL, NULL);
+
+ SERVER_LOCK (server);
+ retval = _dbus_strdup (server->address);
+ SERVER_UNLOCK (server);
+
+ return retval;
+}
+
+/**
+ * Returns the unique ID of the server, as a newly-allocated
+ * string which must be freed by the caller. This ID is
+ * normally used by clients to tell when two #DBusConnection
+ * would be equivalent (because the server address passed
+ * to dbus_connection_open() will have the same guid in the
+ * two cases). dbus_connection_open() can re-use an existing
+ * connection with the same ID instead of opening a new
+ * connection.
+ *
+ * This is an ID unique to each #DBusServer. Remember that
+ * a #DBusServer represents only one mode of connecting,
+ * so e.g. a bus daemon can listen on multiple addresses
+ * which will mean it has multiple #DBusServer each with
+ * their own ID.
+ *
+ * The ID is not a UUID in the sense of RFC4122; the details
+ * are explained in the D-Bus specification.
+ *
+ * @param server the server
+ * @returns the id of the server or #NULL if no memory
+ */
+char*
+dbus_server_get_id (DBusServer *server)
+{
+ char *retval;
+
+ _dbus_return_val_if_fail (server != NULL, NULL);
+
+ SERVER_LOCK (server);
+ retval = NULL;
+ _dbus_string_copy_data (&server->guid_hex, &retval);
+ SERVER_UNLOCK (server);
+
+ return retval;
}
/**
* function is passed each new connection as the connection is
* created. If the new connection function increments the connection's
* reference count, the connection will stay alive. Otherwise, the
- * connection will be unreferenced and closed.
+ * connection will be unreferenced and closed. The new connection
+ * function may also close the connection itself, which is considered
+ * good form if the connection is not wanted.
+ *
+ * The connection here is private in the sense of
+ * dbus_connection_open_private(), so if the new connection function
+ * keeps a reference it must arrange for the connection to be closed.
+ * i.e. libdbus does not own this connection once the new connection
+ * function takes a reference.
*
* @param server the server.
* @param function a function to handle new connections.
void *data,
DBusFreeFunction free_data_function)
{
- if (server->new_connection_free_data_function != NULL)
- (* server->new_connection_free_data_function) (server->new_connection_data);
+ DBusFreeFunction old_free_function;
+ void *old_data;
+
+ _dbus_return_if_fail (server != NULL);
+
+ SERVER_LOCK (server);
+ old_free_function = server->new_connection_free_data_function;
+ old_data = server->new_connection_data;
server->new_connection_function = function;
server->new_connection_data = data;
server->new_connection_free_data_function = free_data_function;
+ SERVER_UNLOCK (server);
+
+ if (old_free_function != NULL)
+ (* old_free_function) (old_data);
}
/**
- * Sets the watch functions for the connection. These functions are
+ * Sets the watch functions for the server. These functions are
* responsible for making the application's main loop aware of file
* descriptors that need to be monitored for events.
*
void *data,
DBusFreeFunction free_data_function)
{
- return _dbus_watch_list_set_functions (server->watches,
- add_function,
- remove_function,
- toggled_function,
- data,
- free_data_function);
+ dbus_bool_t result;
+ DBusWatchList *watches;
+
+ _dbus_return_val_if_fail (server != NULL, FALSE);
+
+ SERVER_LOCK (server);
+ watches = server->watches;
+ server->watches = NULL;
+ if (watches)
+ {
+ SERVER_UNLOCK (server);
+ result = _dbus_watch_list_set_functions (watches,
+ add_function,
+ remove_function,
+ toggled_function,
+ data,
+ free_data_function);
+ SERVER_LOCK (server);
+ }
+ else
+ {
+ _dbus_warn_check_failed ("Re-entrant call to %s\n", _DBUS_FUNCTION_NAME);
+ result = FALSE;
+ }
+ server->watches = watches;
+ SERVER_UNLOCK (server);
+
+ return result;
}
/**
- * Sets the timeout functions for the connection. These functions are
+ * Sets the timeout functions for the server. These functions are
* responsible for making the application's main loop aware of timeouts.
*
* This function behaves exactly like dbus_connection_set_timeout_functions();
void *data,
DBusFreeFunction free_data_function)
{
- return _dbus_timeout_list_set_functions (server->timeouts,
- add_function, remove_function,
- toggled_function,
- data, free_data_function);
-}
-
-/**
- * Called to notify the server when a previously-added watch
- * is ready for reading or writing, or has an exception such
- * as a hangup.
- *
- * If this function returns #FALSE, then the file descriptor may still
- * be ready for reading or writing, but more memory is needed in order
- * to do the reading or writing. If you ignore the #FALSE return, your
- * application may spin in a busy loop on the file descriptor until
- * memory becomes available, but nothing more catastrophic should
- * happen.
- *
- * @param server the server.
- * @param watch the watch.
- * @param condition the current condition of the file descriptors being watched.
- */
-dbus_bool_t
-dbus_server_handle_watch (DBusServer *server,
- DBusWatch *watch,
- unsigned int condition)
-{
- _dbus_assert (server->vtable->handle_watch != NULL);
+ dbus_bool_t result;
+ DBusTimeoutList *timeouts;
+
+ _dbus_return_val_if_fail (server != NULL, FALSE);
- _dbus_watch_sanitize_condition (watch, &condition);
+ SERVER_LOCK (server);
+ timeouts = server->timeouts;
+ server->timeouts = NULL;
+ if (timeouts)
+ {
+ SERVER_UNLOCK (server);
+ result = _dbus_timeout_list_set_functions (timeouts,
+ add_function,
+ remove_function,
+ toggled_function,
+ data,
+ free_data_function);
+ SERVER_LOCK (server);
+ }
+ else
+ {
+ _dbus_warn_check_failed ("Re-entrant call to %s\n", _DBUS_FUNCTION_NAME);
+ result = FALSE;
+ }
+ server->timeouts = timeouts;
+ SERVER_UNLOCK (server);
- return (* server->vtable->handle_watch) (server, watch, condition);
+ return result;
}
/**
- * Sets the authentication mechanisms that this server offers
- * to clients, as a list of SASL mechanisms. This function
- * only affects connections created *after* it is called.
- * Pass #NULL instead of an array to use all available mechanisms.
+ * Sets the authentication mechanisms that this server offers to
+ * clients, as a #NULL-terminated array of mechanism names. This
+ * function only affects connections created <em>after</em> it is
+ * called. Pass #NULL instead of an array to use all available
+ * mechanisms (this is the default behavior).
+ *
+ * The D-Bus specification describes some of the supported mechanisms.
*
* @param server the server
* @param mechanisms #NULL-terminated array of mechanisms
{
char **copy;
+ _dbus_return_val_if_fail (server != NULL, FALSE);
+
+ SERVER_LOCK (server);
+
if (mechanisms != NULL)
{
copy = _dbus_dup_string_array (mechanisms);
dbus_free_string_array (server->auth_mechanisms);
server->auth_mechanisms = copy;
+ SERVER_UNLOCK (server);
+
return TRUE;
}
-
-static DBusDataSlotAllocator slot_allocator;
-_DBUS_DEFINE_GLOBAL_LOCK (server_slots);
+static DBusDataSlotAllocator slot_allocator =
+ _DBUS_DATA_SLOT_ALLOCATOR_INIT (_DBUS_LOCK_NAME (server_slots));
/**
* Allocates an integer ID to be used for storing application-specific
* data on any DBusServer. The allocated ID may then be used
* with dbus_server_set_data() and dbus_server_get_data().
- * If allocation fails, -1 is returned. Again, the allocated
- * slot is global, i.e. all DBusServer objects will
- * have a slot with the given integer ID reserved.
+ * The slot must be initialized with -1. If a nonnegative
+ * slot is passed in, the refcount is incremented on that
+ * slot, rather than creating a new slot.
+ *
+ * The allocated slot is global, i.e. all DBusServer objects will have
+ * a slot with the given integer ID reserved.
*
- * @returns -1 on failure, otherwise the data slot ID
+ * @param slot_p address of global variable storing the slot ID
+ * @returns #FALSE on no memory
*/
-int
-dbus_server_allocate_data_slot (void)
+dbus_bool_t
+dbus_server_allocate_data_slot (dbus_int32_t *slot_p)
{
return _dbus_data_slot_allocator_alloc (&slot_allocator,
- _DBUS_LOCK_NAME (server_slots));
+ slot_p);
}
/**
* but may not be retrieved (and may only be replaced
* if someone else reallocates the slot).
*
- * @param slot the slot to deallocate
+ * @param slot_p address of the slot to deallocate
*/
void
-dbus_server_free_data_slot (int slot)
+dbus_server_free_data_slot (dbus_int32_t *slot_p)
{
- _dbus_data_slot_allocator_free (&slot_allocator, slot);
+ _dbus_return_if_fail (*slot_p >= 0);
+
+ _dbus_data_slot_allocator_free (&slot_allocator, slot_p);
}
/**
* @returns #TRUE if there was enough memory to store the data
*/
dbus_bool_t
-dbus_server_set_data (DBusServer *server,
+dbus_server_set_data (DBusServer *server,
int slot,
void *data,
DBusFreeFunction free_data_func)
void *old_data;
dbus_bool_t retval;
-#if 0
- dbus_mutex_lock (server->mutex);
-#endif
+ _dbus_return_val_if_fail (server != NULL, FALSE);
+
+ SERVER_LOCK (server);
retval = _dbus_data_slot_list_set (&slot_allocator,
&server->slot_list,
slot, data, free_data_func,
&old_free_func, &old_data);
-#if 0
- dbus_mutex_unlock (server->mutex);
-#endif
+
+ SERVER_UNLOCK (server);
if (retval)
{
*/
void*
dbus_server_get_data (DBusServer *server,
- int slot)
+ int slot)
{
void *res;
+
+ _dbus_return_val_if_fail (server != NULL, NULL);
-#if 0
- dbus_mutex_lock (server->mutex);
-#endif
+ SERVER_LOCK (server);
res = _dbus_data_slot_list_get (&slot_allocator,
&server->slot_list,
slot);
-#if 0
- dbus_mutex_unlock (server->mutex);
-#endif
+ SERVER_UNLOCK (server);
return res;
}
/** @} */
+#ifdef DBUS_ENABLE_EMBEDDED_TESTS
+#include "dbus-test.h"
+#include <string.h>
+
+dbus_bool_t
+_dbus_server_test (void)
+{
+ const char *valid_addresses[] = {
+ "tcp:port=1234",
+ "tcp:host=localhost,port=1234",
+ "tcp:host=localhost,port=1234;tcp:port=5678",
+#ifdef DBUS_UNIX
+ "unix:path=./boogie",
+ "tcp:port=1234;unix:path=./boogie",
+#endif
+ };
+
+ DBusServer *server;
+ int i;
+
+ for (i = 0; i < _DBUS_N_ELEMENTS (valid_addresses); i++)
+ {
+ DBusError error = DBUS_ERROR_INIT;
+ char *address;
+ char *id;
+
+ server = dbus_server_listen (valid_addresses[i], &error);
+ if (server == NULL)
+ {
+ _dbus_warn ("server listen error: %s: %s\n", error.name, error.message);
+ dbus_error_free (&error);
+ _dbus_assert_not_reached ("Failed to listen for valid address.");
+ }
+
+ id = dbus_server_get_id (server);
+ _dbus_assert (id != NULL);
+ address = dbus_server_get_address (server);
+ _dbus_assert (address != NULL);
+
+ if (strstr (address, id) == NULL)
+ {
+ _dbus_warn ("server id '%s' is not in the server address '%s'\n",
+ id, address);
+ _dbus_assert_not_reached ("bad server id or address");
+ }
+
+ dbus_free (id);
+ dbus_free (address);
+
+ dbus_server_disconnect (server);
+ dbus_server_unref (server);
+ }
+
+ return TRUE;
+}
+
+#endif /* DBUS_ENABLE_EMBEDDED_TESTS */
projects / platform / upstream / dbus.git / blobdiff