dbus/dbus-server-debug-pipe.c

   1 /* -*- mode: C; c-file-style: "gnu" -*- */
   2 /* dbus-server-debug-pipe.c In-proc debug server implementation
   3  *
   4  * Copyright (C) 2003  CodeFactory AB
   5  * Copyright (C) 2003  Red Hat, Inc.
   6  *
   7  * Licensed under the Academic Free License version 1.2
   8  *
   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.
  13  *
  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.
  18  *
  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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  22  *
  23  */
  24
  25 #include "dbus-internals.h"
  26 #include "dbus-server-debug-pipe.h"
  27 #include "dbus-transport-unix.h"
  28 #include "dbus-connection-internal.h"
  29 #include "dbus-hash.h"
  30
  31 #ifdef DBUS_BUILD_TESTS
  32
  33 /**
  34  * @defgroup DBusServerDebugPipe DBusServerDebugPipe
  35  * @ingroup  DBusInternals
  36  * @brief In-process pipe debug server used in unit tests.
  37  *
  38  * Types and functions related to DBusServerDebugPipe.
  39  * This is used for unit testing.
  40  *
  41  * @{
  42  */
  43
  44 /**
  45  * Opaque object representing a debug server implementation.
  46  */
  47 typedef struct DBusServerDebugPipe DBusServerDebugPipe;
  48
  49 /**
  50  * Implementation details of DBusServerDebugPipe. All members
  51  * are private.
  52  */
  53 struct DBusServerDebugPipe
  54 {
  55   DBusServer base;  /**< Parent class members. */
  56
  57   char *name; /**< Server name. */
  58
  59   dbus_bool_t disconnected; /**< TRUE if disconnect has been called */
  60 };
  61
  62 /* FIXME not threadsafe (right now the test suite doesn't use threads anyhow ) */
  63 static DBusHashTable *server_pipe_hash;
  64 static int server_pipe_hash_refcount = 0;
  65
  66 static dbus_bool_t
  67 pipe_hash_ref (void)
  68 {
  69   if (!server_pipe_hash)
  70     {
  71       _dbus_assert (server_pipe_hash_refcount == 0);
  72
  73       server_pipe_hash = _dbus_hash_table_new (DBUS_HASH_STRING, NULL, NULL);
  74
  75       if (!server_pipe_hash)
  76         return FALSE;
  77     }
  78
  79   server_pipe_hash_refcount = 1;
  80
  81   return TRUE;
  82 }
  83
  84 static void
  85 pipe_hash_unref (void)
  86 {
  87   _dbus_assert (server_pipe_hash != NULL);
  88   _dbus_assert (server_pipe_hash_refcount > 0);
  89
  90   server_pipe_hash_refcount -= 1;
  91   if (server_pipe_hash_refcount == 0)
  92     {
  93       _dbus_hash_table_unref (server_pipe_hash);
  94       server_pipe_hash = NULL;
  95     }
  96 }
  97
  98 static void
  99 debug_finalize (DBusServer *server)
 100 {
 101   DBusServerDebugPipe *debug_server = (DBusServerDebugPipe*) server;
 102
 103   pipe_hash_unref ();
 104
 105   _dbus_server_finalize_base (server);
 106
 107   dbus_free (debug_server->name);
 108   dbus_free (server);
 109 }
 110
 111 static void
 112 debug_disconnect (DBusServer *server)
 113 {
 114   ((DBusServerDebugPipe*)server)->disconnected = TRUE;
 115 }
 116
 117 static DBusServerVTable debug_vtable = {
 118   debug_finalize,
 119   debug_disconnect
 120 };
 121
 122 /**
 123  * Creates a new debug server using an in-process pipe
 124  *
 125  * @param server_name the name of the server.
 126  * @param error address where an error can be returned.
 127  * @returns a new server, or #NULL on failure.
 128  */
 129 DBusServer*
 130 _dbus_server_debug_pipe_new (const char     *server_name,
 131                              DBusError      *error)
 132 {
 133   DBusServerDebugPipe *debug_server;
 134   DBusString address;
 135
 136   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
 137
 138   if (!pipe_hash_ref ())
 139     return NULL;
 140
 141   if (_dbus_hash_table_lookup_string (server_pipe_hash, server_name) != NULL)
 142     {
 143       dbus_set_error (error, DBUS_ERROR_ADDRESS_IN_USE, NULL);
 144       pipe_hash_unref ();
 145       return NULL;
 146     }
 147
 148   debug_server = dbus_new0 (DBusServerDebugPipe, 1);
 149   if (debug_server == NULL)
 150     goto nomem_0;
 151
 152   if (!_dbus_string_init (&address))
 153     goto nomem_1;
 154
 155   if (!_dbus_string_append (&address, "debug-pipe:name=") ||
 156       !_dbus_string_append (&address, server_name))
 157     goto nomem_2;
 158
 159   debug_server->name = _dbus_strdup (server_name);
 160   if (debug_server->name == NULL)
 161     goto nomem_2;
 162
 163   if (!_dbus_server_init_base (&debug_server->base,
 164                                &debug_vtable, &address))
 165     goto nomem_3;
 166
 167   if (!_dbus_hash_table_insert_string (server_pipe_hash,
 168                                        debug_server->name,
 169                                        debug_server))
 170     goto nomem_4;
 171
 172   _dbus_string_free (&address);
 173
 174   /* server keeps the pipe hash ref */
 175
 176   return (DBusServer *)debug_server;
 177
 178  nomem_4:
 179   _dbus_server_finalize_base (&debug_server->base);
 180  nomem_3:
 181   dbus_free (debug_server->name);
 182  nomem_2:
 183   _dbus_string_free (&address);
 184  nomem_1:
 185   dbus_free (debug_server);
 186  nomem_0:
 187   pipe_hash_unref ();
 188   dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 189   return NULL;
 190 }
 191
 192 /**
 193  * Creates the client-side transport for
 194  * a debug-pipe connection connected to the
 195  * given debug-pipe server name.
 196  *
 197  * @param server_name name of server to connect to
 198  * @param error address where an error can be returned.
 199  * @returns #NULL on no memory or transport
 200  */
 201 DBusTransport*
 202 _dbus_transport_debug_pipe_new (const char     *server_name,
 203                                 DBusError      *error)
 204 {
 205   DBusTransport *client_transport;
 206   DBusTransport *server_transport;
 207   DBusConnection *connection;
 208   int client_fd, server_fd;
 209   DBusServer *server;
 210   DBusString address;
 211
 212   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
 213
 214   if (server_pipe_hash == NULL)
 215     {
 216       dbus_set_error (error, DBUS_ERROR_NO_SERVER, NULL);
 217       return NULL;
 218     }
 219
 220   server = _dbus_hash_table_lookup_string (server_pipe_hash,
 221                                            server_name);
 222   if (server == NULL ||
 223       ((DBusServerDebugPipe*)server)->disconnected)
 224     {
 225       dbus_set_error (error, DBUS_ERROR_NO_SERVER, NULL);
 226       return NULL;
 227     }
 228
 229   if (!_dbus_string_init (&address))
 230     {
 231       dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 232       return NULL;
 233     }
 234
 235   if (!_dbus_string_append (&address, "debug-pipe:name=") ||
 236       !_dbus_string_append (&address, server_name))
 237     {
 238       dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 239       _dbus_string_free (&address);
 240       return NULL;
 241     }
 242
 243   if (!_dbus_full_duplex_pipe (&client_fd, &server_fd, FALSE,
 244                                NULL))
 245     {
 246       _dbus_verbose ("failed to create full duplex pipe\n");
 247       dbus_set_error (error, DBUS_ERROR_FAILED, "Could not create full-duplex pipe");
 248       _dbus_string_free (&address);
 249       return NULL;
 250     }
 251
 252   _dbus_fd_set_close_on_exec (client_fd);
 253   _dbus_fd_set_close_on_exec (server_fd);
 254
 255   client_transport = _dbus_transport_new_for_fd (client_fd,
 256                                                  FALSE, &address);
 257   if (client_transport == NULL)
 258     {
 259       _dbus_close (client_fd, NULL);
 260       _dbus_close (server_fd, NULL);
 261       dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 262       _dbus_string_free (&address);
 263       return NULL;
 264     }
 265
 266   _dbus_string_free (&address);
 267
 268   client_fd = -1;
 269
 270   server_transport = _dbus_transport_new_for_fd (server_fd,
 271                                                  TRUE, NULL);
 272   if (server_transport == NULL)
 273     {
 274       _dbus_transport_unref (client_transport);
 275       _dbus_close (server_fd, NULL);
 276       dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 277       return NULL;
 278     }
 279
 280   server_fd = -1;
 281
 282   if (!_dbus_transport_set_auth_mechanisms (server_transport,
 283                                             (const char**) server->auth_mechanisms))
 284     {
 285       dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 286       _dbus_transport_unref (server_transport);
 287       _dbus_transport_unref (client_transport);
 288       return FALSE;
 289     }
 290
 291   connection = _dbus_connection_new_for_transport (server_transport);
 292   _dbus_transport_unref (server_transport);
 293   server_transport = NULL;
 294
 295   if (connection == NULL)
 296     {
 297       _dbus_transport_unref (client_transport);
 298       dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 299       return NULL;
 300     }
 301
 302   /* See if someone wants to handle this new connection,
 303    * self-referencing for paranoia
 304    */
 305   if (server->new_connection_function)
 306     {
 307       dbus_server_ref (server);
 308       (* server->new_connection_function) (server, connection,
 309                                            server->new_connection_data);
 310       dbus_server_unref (server);
 311     }
 312
 313   /* If no one grabbed a reference, the connection will die,
 314    * and the client transport will get an immediate disconnect
 315    */
 316   dbus_connection_unref (connection);
 317
 318   return client_transport;
 319 }
 320
 321
 322 /** @} */
 323
 324 #endif /* DBUS_BUILD_TESTS */
 325