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
26 #include "dbus-internals.h"
27 #include "dbus-server-debug-pipe.h"
28 #include "dbus-transport-socket.h"
29 #include "dbus-connection-internal.h"
30 #include "dbus-hash.h"
31 #include "dbus-string.h"
32 #include "dbus-protocol.h"
34 #ifdef DBUS_ENABLE_EMBEDDED_TESTS
37 * @defgroup DBusServerDebugPipe DBusServerDebugPipe
38 * @ingroup DBusInternals
39 * @brief In-process pipe debug server used in unit tests.
41 * Types and functions related to DBusServerDebugPipe.
42 * This is used for unit testing.
48 * Opaque object representing a debug server implementation.
50 typedef struct DBusServerDebugPipe DBusServerDebugPipe;
53 * Implementation details of DBusServerDebugPipe. All members
56 struct DBusServerDebugPipe
58 DBusServer base; /**< Parent class members. */
60 char *name; /**< Server name. */
62 dbus_bool_t disconnected; /**< TRUE if disconnect has been called */
65 /* FIXME not threadsafe (right now the test suite doesn't use threads anyhow ) */
66 static DBusHashTable *server_pipe_hash;
67 static int server_pipe_hash_refcount = 0;
72 if (!server_pipe_hash)
74 _dbus_assert (server_pipe_hash_refcount == 0);
76 server_pipe_hash = _dbus_hash_table_new (DBUS_HASH_STRING, NULL, NULL);
78 if (!server_pipe_hash)
82 server_pipe_hash_refcount = 1;
88 pipe_hash_unref (void)
90 _dbus_assert (server_pipe_hash != NULL);
91 _dbus_assert (server_pipe_hash_refcount > 0);
93 server_pipe_hash_refcount -= 1;
94 if (server_pipe_hash_refcount == 0)
96 _dbus_hash_table_unref (server_pipe_hash);
97 server_pipe_hash = NULL;
102 debug_finalize (DBusServer *server)
104 DBusServerDebugPipe *debug_server = (DBusServerDebugPipe*) server;
108 _dbus_server_finalize_base (server);
110 dbus_free (debug_server->name);
115 debug_disconnect (DBusServer *server)
117 ((DBusServerDebugPipe*)server)->disconnected = TRUE;
120 static DBusServerVTable debug_vtable = {
126 * Creates a new debug server using an in-process pipe
128 * @param server_name the name of the server.
129 * @param error address where an error can be returned.
130 * @returns a new server, or #NULL on failure.
133 _dbus_server_debug_pipe_new (const char *server_name,
136 DBusServerDebugPipe *debug_server;
140 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
142 if (!pipe_hash_ref ())
145 if (_dbus_hash_table_lookup_string (server_pipe_hash, server_name) != NULL)
147 dbus_set_error (error, DBUS_ERROR_ADDRESS_IN_USE, NULL);
152 debug_server = dbus_new0 (DBusServerDebugPipe, 1);
153 if (debug_server == NULL)
156 if (!_dbus_string_init (&address))
159 _dbus_string_init_const (&name_str, server_name);
160 if (!_dbus_string_append (&address, "debug-pipe:name=") ||
161 !_dbus_address_append_escaped (&address, &name_str))
164 debug_server->name = _dbus_strdup (server_name);
165 if (debug_server->name == NULL)
168 if (!_dbus_server_init_base (&debug_server->base,
169 &debug_vtable, &address,
173 if (!_dbus_hash_table_insert_string (server_pipe_hash,
178 _dbus_string_free (&address);
180 /* server keeps the pipe hash ref */
182 _dbus_server_trace_ref (&debug_server->base, 0, 1, "debug_pipe_new");
183 return (DBusServer *)debug_server;
186 _dbus_server_finalize_base (&debug_server->base);
188 dbus_free (debug_server->name);
190 _dbus_string_free (&address);
192 dbus_free (debug_server);
195 if (error != NULL && !dbus_error_is_set (error))
196 _DBUS_SET_OOM (error);
201 * Creates the client-side transport for
202 * a debug-pipe connection connected to the
203 * given debug-pipe server name.
205 * @param server_name name of server to connect to
206 * @param error address where an error can be returned.
207 * @returns #NULL on no memory or transport
210 _dbus_transport_debug_pipe_new (const char *server_name,
213 DBusTransport *client_transport;
214 DBusTransport *server_transport;
215 DBusConnection *connection;
216 DBusSocket client_fd, server_fd;
220 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
222 if (server_pipe_hash == NULL)
224 dbus_set_error (error, DBUS_ERROR_NO_SERVER, NULL);
228 server = _dbus_hash_table_lookup_string (server_pipe_hash,
230 if (server == NULL ||
231 ((DBusServerDebugPipe*)server)->disconnected)
233 dbus_set_error (error, DBUS_ERROR_NO_SERVER, NULL);
237 if (!_dbus_string_init (&address))
239 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
243 if (!_dbus_string_append (&address, "debug-pipe:name=") ||
244 !_dbus_string_append (&address, server_name))
246 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
247 _dbus_string_free (&address);
251 if (!_dbus_socketpair (&client_fd, &server_fd, FALSE, NULL))
253 _dbus_verbose ("failed to create full duplex pipe\n");
254 dbus_set_error (error, DBUS_ERROR_FAILED, "Could not create full-duplex pipe");
255 _dbus_string_free (&address);
259 client_transport = _dbus_transport_new_for_socket (client_fd,
261 if (client_transport == NULL)
263 _dbus_close_socket (client_fd, NULL);
264 _dbus_close_socket (server_fd, NULL);
265 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
266 _dbus_string_free (&address);
270 _dbus_string_free (&address);
272 _dbus_socket_invalidate (&client_fd);
274 server_transport = _dbus_transport_new_for_socket (server_fd,
275 &server->guid_hex, NULL);
276 if (server_transport == NULL)
278 _dbus_transport_unref (client_transport);
279 _dbus_close_socket (server_fd, NULL);
280 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
284 _dbus_socket_invalidate (&server_fd);
286 if (!_dbus_transport_set_auth_mechanisms (server_transport,
287 (const char**) server->auth_mechanisms))
289 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
290 _dbus_transport_unref (server_transport);
291 _dbus_transport_unref (client_transport);
295 connection = _dbus_connection_new_for_transport (server_transport);
296 _dbus_transport_unref (server_transport);
297 server_transport = NULL;
299 if (connection == NULL)
301 _dbus_transport_unref (client_transport);
302 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
306 /* See if someone wants to handle this new connection,
307 * self-referencing for paranoia
309 if (server->new_connection_function)
311 dbus_server_ref (server);
312 (* server->new_connection_function) (server, connection,
313 server->new_connection_data);
314 dbus_server_unref (server);
317 /* If no one grabbed a reference, the connection will die,
318 * and the client transport will get an immediate disconnect
320 _dbus_connection_close_if_only_one_ref (connection);
321 dbus_connection_unref (connection);
323 return client_transport;
327 * Tries to interpret the address entry as a debug pipe entry.
329 * Sets error if the result is not OK.
331 * @param entry an address entry
332 * @param server_p location to store a new DBusServer, or #NULL on failure.
333 * @param error location to store rationale for failure on bad address
334 * @returns the outcome
337 DBusServerListenResult
338 _dbus_server_listen_debug_pipe (DBusAddressEntry *entry,
339 DBusServer **server_p,
346 method = dbus_address_entry_get_method (entry);
348 if (strcmp (method, "debug-pipe") == 0)
350 const char *name = dbus_address_entry_get_value (entry, "name");
354 _dbus_set_bad_address(error, "debug-pipe", "name",
356 return DBUS_SERVER_LISTEN_BAD_ADDRESS;
359 *server_p = _dbus_server_debug_pipe_new (name, error);
363 _DBUS_ASSERT_ERROR_IS_CLEAR(error);
364 return DBUS_SERVER_LISTEN_OK;
368 _DBUS_ASSERT_ERROR_IS_SET(error);
369 return DBUS_SERVER_LISTEN_DID_NOT_CONNECT;
374 _DBUS_ASSERT_ERROR_IS_CLEAR(error);
375 return DBUS_SERVER_LISTEN_NOT_HANDLED;
380 * Opens a debug pipe transport, used in the test suite.
382 * @param entry the address entry to try opening as debug-pipe
383 * @param transport_p return location for the opened transport
384 * @param error error to be set
385 * @returns result of the attempt
387 DBusTransportOpenResult
388 _dbus_transport_open_debug_pipe (DBusAddressEntry *entry,
389 DBusTransport **transport_p,
394 method = dbus_address_entry_get_method (entry);
395 _dbus_assert (method != NULL);
397 if (strcmp (method, "debug-pipe") == 0)
399 const char *name = dbus_address_entry_get_value (entry, "name");
403 _dbus_set_bad_address (error, "debug-pipe", "name",
405 return DBUS_TRANSPORT_OPEN_BAD_ADDRESS;
408 *transport_p = _dbus_transport_debug_pipe_new (name, error);
410 if (*transport_p == NULL)
412 _DBUS_ASSERT_ERROR_IS_SET (error);
413 return DBUS_TRANSPORT_OPEN_DID_NOT_CONNECT;
417 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
418 return DBUS_TRANSPORT_OPEN_OK;
423 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
424 return DBUS_TRANSPORT_OPEN_NOT_HANDLED;
431 #endif /* DBUS_ENABLE_EMBEDDED_TESTS */