1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2 /* dbus-server-debug-pipe.c In-proc debug server implementation
4 * Copyright (C) 2003 CodeFactory AB
5 * Copyright (C) 2003, 2004 Red Hat, Inc.
7 * Licensed under the Academic Free License version 2.1
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
25 #include "dbus-internals.h"
26 #include "dbus-server-debug-pipe.h"
27 #include "dbus-transport-socket.h"
28 #include "dbus-connection-internal.h"
29 #include "dbus-hash.h"
30 #include "dbus-string.h"
31 #include "dbus-protocol.h"
33 #ifdef DBUS_BUILD_TESTS
36 * @defgroup DBusServerDebugPipe DBusServerDebugPipe
37 * @ingroup DBusInternals
38 * @brief In-process pipe debug server used in unit tests.
40 * Types and functions related to DBusServerDebugPipe.
41 * This is used for unit testing.
47 * Opaque object representing a debug server implementation.
49 typedef struct DBusServerDebugPipe DBusServerDebugPipe;
52 * Implementation details of DBusServerDebugPipe. All members
55 struct DBusServerDebugPipe
57 DBusServer base; /**< Parent class members. */
59 char *name; /**< Server name. */
61 dbus_bool_t disconnected; /**< TRUE if disconnect has been called */
64 /* FIXME not threadsafe (right now the test suite doesn't use threads anyhow ) */
65 static DBusHashTable *server_pipe_hash;
66 static int server_pipe_hash_refcount = 0;
71 if (!server_pipe_hash)
73 _dbus_assert (server_pipe_hash_refcount == 0);
75 server_pipe_hash = _dbus_hash_table_new (DBUS_HASH_STRING, NULL, NULL);
77 if (!server_pipe_hash)
81 server_pipe_hash_refcount = 1;
87 pipe_hash_unref (void)
89 _dbus_assert (server_pipe_hash != NULL);
90 _dbus_assert (server_pipe_hash_refcount > 0);
92 server_pipe_hash_refcount -= 1;
93 if (server_pipe_hash_refcount == 0)
95 _dbus_hash_table_unref (server_pipe_hash);
96 server_pipe_hash = NULL;
101 debug_finalize (DBusServer *server)
103 DBusServerDebugPipe *debug_server = (DBusServerDebugPipe*) server;
107 _dbus_server_finalize_base (server);
109 dbus_free (debug_server->name);
114 debug_disconnect (DBusServer *server)
116 ((DBusServerDebugPipe*)server)->disconnected = TRUE;
119 static DBusServerVTable debug_vtable = {
125 * Creates a new debug server using an in-process pipe
127 * @param server_name the name of the server.
128 * @param error address where an error can be returned.
129 * @returns a new server, or #NULL on failure.
132 _dbus_server_debug_pipe_new (const char *server_name,
135 DBusServerDebugPipe *debug_server;
139 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
141 if (!pipe_hash_ref ())
144 if (_dbus_hash_table_lookup_string (server_pipe_hash, server_name) != NULL)
146 dbus_set_error (error, DBUS_ERROR_ADDRESS_IN_USE, NULL);
151 debug_server = dbus_new0 (DBusServerDebugPipe, 1);
152 if (debug_server == NULL)
155 if (!_dbus_string_init (&address))
158 _dbus_string_init_const (&name_str, server_name);
159 if (!_dbus_string_append (&address, "debug-pipe:name=") ||
160 !_dbus_address_append_escaped (&address, &name_str))
163 debug_server->name = _dbus_strdup (server_name);
164 if (debug_server->name == NULL)
167 if (!_dbus_server_init_base (&debug_server->base,
168 &debug_vtable, &address))
171 if (!_dbus_hash_table_insert_string (server_pipe_hash,
176 _dbus_string_free (&address);
178 /* server keeps the pipe hash ref */
180 return (DBusServer *)debug_server;
183 _dbus_server_finalize_base (&debug_server->base);
185 dbus_free (debug_server->name);
187 _dbus_string_free (&address);
189 dbus_free (debug_server);
192 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
197 * Creates the client-side transport for
198 * a debug-pipe connection connected to the
199 * given debug-pipe server name.
201 * @param server_name name of server to connect to
202 * @param error address where an error can be returned.
203 * @returns #NULL on no memory or transport
206 _dbus_transport_debug_pipe_new (const char *server_name,
209 DBusTransport *client_transport;
210 DBusTransport *server_transport;
211 DBusConnection *connection;
212 int client_fd, server_fd;
216 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
218 if (server_pipe_hash == NULL)
220 dbus_set_error (error, DBUS_ERROR_NO_SERVER, NULL);
224 server = _dbus_hash_table_lookup_string (server_pipe_hash,
226 if (server == NULL ||
227 ((DBusServerDebugPipe*)server)->disconnected)
229 dbus_set_error (error, DBUS_ERROR_NO_SERVER, NULL);
233 if (!_dbus_string_init (&address))
235 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
239 if (!_dbus_string_append (&address, "debug-pipe:name=") ||
240 !_dbus_string_append (&address, server_name))
242 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
243 _dbus_string_free (&address);
247 if (!_dbus_full_duplex_pipe (&client_fd, &server_fd, FALSE,
250 _dbus_verbose ("failed to create full duplex pipe\n");
251 dbus_set_error (error, DBUS_ERROR_FAILED, "Could not create full-duplex pipe");
252 _dbus_string_free (&address);
256 client_transport = _dbus_transport_new_for_socket (client_fd,
258 if (client_transport == NULL)
260 _dbus_close_socket (client_fd, NULL);
261 _dbus_close_socket (server_fd, NULL);
262 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
263 _dbus_string_free (&address);
267 _dbus_string_free (&address);
271 server_transport = _dbus_transport_new_for_socket (server_fd,
272 &server->guid_hex, NULL);
273 if (server_transport == NULL)
275 _dbus_transport_unref (client_transport);
276 _dbus_close_socket (server_fd, NULL);
277 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
283 if (!_dbus_transport_set_auth_mechanisms (server_transport,
284 (const char**) server->auth_mechanisms))
286 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
287 _dbus_transport_unref (server_transport);
288 _dbus_transport_unref (client_transport);
292 connection = _dbus_connection_new_for_transport (server_transport);
293 _dbus_transport_unref (server_transport);
294 server_transport = NULL;
296 if (connection == NULL)
298 _dbus_transport_unref (client_transport);
299 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
303 /* See if someone wants to handle this new connection,
304 * self-referencing for paranoia
306 if (server->new_connection_function)
308 dbus_server_ref (server);
309 (* server->new_connection_function) (server, connection,
310 server->new_connection_data);
311 dbus_server_unref (server);
314 /* If no one grabbed a reference, the connection will die,
315 * and the client transport will get an immediate disconnect
317 _dbus_connection_close_if_only_one_ref (connection);
318 dbus_connection_unref (connection);
320 return client_transport;
324 * Tries to interpret the address entry as a debug pipe entry.
326 * Sets error if the result is not OK.
328 * @param entry an address entry
329 * @param server_p location to store a new DBusServer, or #NULL on failure.
330 * @param error location to store rationale for failure on bad address
331 * @returns the outcome
334 DBusServerListenResult
335 _dbus_server_listen_debug_pipe (DBusAddressEntry *entry,
336 DBusServer **server_p,
343 method = dbus_address_entry_get_method (entry);
345 if (strcmp (method, "debug-pipe") == 0)
347 const char *name = dbus_address_entry_get_value (entry, "name");
351 _dbus_set_bad_address(error, "debug-pipe", "name",
353 return DBUS_SERVER_LISTEN_BAD_ADDRESS;
356 *server_p = _dbus_server_debug_pipe_new (name, error);
360 _DBUS_ASSERT_ERROR_IS_CLEAR(error);
361 return DBUS_SERVER_LISTEN_OK;
365 _DBUS_ASSERT_ERROR_IS_SET(error);
366 return DBUS_SERVER_LISTEN_DID_NOT_CONNECT;
371 _DBUS_ASSERT_ERROR_IS_CLEAR(error);
372 return DBUS_SERVER_LISTEN_NOT_HANDLED;
377 * Opens a debug pipe transport, used in the test suite.
379 * @param entry the address entry to try opening as debug-pipe
380 * @param transport_p return location for the opened transport
381 * @param error error to be set
382 * @returns result of the attempt
384 DBusTransportOpenResult
385 _dbus_transport_open_debug_pipe (DBusAddressEntry *entry,
386 DBusTransport **transport_p,
391 method = dbus_address_entry_get_method (entry);
392 _dbus_assert (method != NULL);
394 if (strcmp (method, "debug-pipe") == 0)
396 const char *name = dbus_address_entry_get_value (entry, "name");
400 _dbus_set_bad_address (error, "debug-pipe", "name",
402 return DBUS_TRANSPORT_OPEN_BAD_ADDRESS;
405 *transport_p = _dbus_transport_debug_pipe_new (name, error);
407 if (*transport_p == NULL)
409 _DBUS_ASSERT_ERROR_IS_SET (error);
410 return DBUS_TRANSPORT_OPEN_DID_NOT_CONNECT;
414 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
415 return DBUS_TRANSPORT_OPEN_OK;
420 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
421 return DBUS_TRANSPORT_OPEN_NOT_HANDLED;
428 #endif /* DBUS_BUILD_TESTS */