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 static DBusHashTable *server_pipe_hash;
  63
  64
  65 static void
  66 debug_finalize (DBusServer *server)
  67 {
  68   _dbus_server_finalize_base (server);
  69
  70   dbus_free (server);
  71 }
  72
  73 static void
  74 debug_handle_watch (DBusServer  *server,
  75                     DBusWatch   *watch,
  76                     unsigned int flags)
  77 {
  78
  79 }
  80
  81 static void
  82 debug_disconnect (DBusServer *server)
  83 {
  84   ((DBusServerDebugPipe*)server)->disconnected = TRUE;
  85 }
  86
  87 static DBusServerVTable debug_vtable = {
  88   debug_finalize,
  89   debug_handle_watch,
  90   debug_disconnect
  91 };
  92
  93 /**
  94  * Creates a new debug server using an in-process pipe
  95  *
  96  * @param server_name the name of the server.
  97  * @param result address where a result code can be returned.
  98  * @returns a new server, or #NULL on failure.
  99  */
 100 DBusServer*
 101 _dbus_server_debug_pipe_new (const char     *server_name,
 102                              DBusResultCode *result)
 103 {
 104   DBusServerDebugPipe *debug_server;
 105
 106   if (!server_pipe_hash)
 107     {
 108       server_pipe_hash = _dbus_hash_table_new (DBUS_HASH_STRING, NULL, NULL);
 109
 110       if (!server_pipe_hash)
 111         {
 112           dbus_set_result (result, DBUS_RESULT_NO_MEMORY);
 113           return NULL;
 114         }
 115     }
 116
 117   if (_dbus_hash_table_lookup_string (server_pipe_hash, server_name) != NULL)
 118     {
 119       dbus_set_result (result, DBUS_RESULT_ADDRESS_IN_USE);
 120       return NULL;
 121     }
 122
 123   debug_server = dbus_new0 (DBusServerDebugPipe, 1);
 124
 125   if (debug_server == NULL)
 126     return NULL;
 127
 128   debug_server->name = _dbus_strdup (server_name);
 129   if (debug_server->name == NULL)
 130     {
 131       dbus_free (debug_server->name);
 132       dbus_free (debug_server);
 133
 134       dbus_set_result (result, DBUS_RESULT_NO_MEMORY);
 135     }
 136
 137   if (!_dbus_server_init_base (&debug_server->base,
 138                                &debug_vtable))
 139     {
 140       dbus_free (debug_server->name);
 141       dbus_free (debug_server);
 142
 143       dbus_set_result (result, DBUS_RESULT_NO_MEMORY);
 144
 145       return NULL;
 146     }
 147
 148   if (!_dbus_hash_table_insert_string (server_pipe_hash,
 149                                        debug_server->name,
 150                                        debug_server))
 151     {
 152       _dbus_server_finalize_base (&debug_server->base);
 153       dbus_free (debug_server->name);
 154       dbus_free (debug_server);
 155
 156       dbus_set_result (result, DBUS_RESULT_NO_MEMORY);
 157
 158       return NULL;
 159     }
 160
 161   dbus_set_result (result, DBUS_RESULT_SUCCESS);
 162
 163   return (DBusServer *)debug_server;
 164 }
 165
 166 /**
 167  * Creates the client-side transport for
 168  * a debug-pipe connection connected to the
 169  * given debug-pipe server name.
 170  *
 171  * @param server_name name of server to connect to
 172  * @param result return location for result
 173  * @returns #NULL on no memory or transport
 174  */
 175 DBusTransport*
 176 _dbus_transport_debug_pipe_new (const char     *server_name,
 177                                 DBusResultCode *result)
 178 {
 179   DBusTransport *client_transport;
 180   DBusTransport *server_transport;
 181   DBusConnection *connection;
 182   int client_fd, server_fd;
 183   DBusServer *server;
 184
 185   server = _dbus_hash_table_lookup_string (server_pipe_hash,
 186                                            server_name);
 187   if (server == NULL ||
 188       ((DBusServerDebugPipe*)server)->disconnected)
 189     {
 190       dbus_set_result (result, DBUS_RESULT_BAD_ADDRESS);
 191       return NULL;
 192     }
 193
 194   if (!_dbus_full_duplex_pipe (&client_fd, &server_fd,
 195                                NULL))
 196     {
 197       _dbus_verbose ("failed to create full duplex pipe\n");
 198       dbus_set_result (result, DBUS_RESULT_FAILED);
 199       return NULL;
 200     }
 201
 202   _dbus_fd_set_close_on_exec (client_fd);
 203   _dbus_fd_set_close_on_exec (server_fd);
 204
 205   client_transport = _dbus_transport_new_for_fd (client_fd,
 206                                                  FALSE);
 207   if (client_transport == NULL)
 208     {
 209       _dbus_close (client_fd, NULL);
 210       _dbus_close (server_fd, NULL);
 211       return NULL;
 212     }
 213
 214   client_fd = -1;
 215
 216   server_transport = _dbus_transport_new_for_fd (server_fd,
 217                                                  TRUE);
 218   if (server_transport == NULL)
 219     {
 220       _dbus_transport_unref (client_transport);
 221       _dbus_close (server_fd, NULL);
 222       return NULL;
 223     }
 224
 225   server_fd = -1;
 226
 227   connection = _dbus_connection_new_for_transport (server_transport);
 228   _dbus_transport_unref (server_transport);
 229   server_transport = NULL;
 230
 231   if (connection == NULL)
 232     {
 233       _dbus_transport_unref (client_transport);
 234       return NULL;
 235     }
 236
 237   /* See if someone wants to handle this new connection,
 238    * self-referencing for paranoia
 239    */
 240   if (server->new_connection_function)
 241     {
 242       dbus_server_ref (server);
 243       (* server->new_connection_function) (server, connection,
 244                                            server->new_connection_data);
 245       dbus_server_unref (server);
 246     }
 247
 248   /* If no one grabbed a reference, the connection will die,
 249    * and the client transport will get an immediate disconnect
 250    */
 251   dbus_connection_unref (connection);
 252
 253   return client_transport;
 254 }
 255
 256
 257 /** @} */
 258
 259 #endif /* DBUS_BUILD_TESTS */
 260