dbus/dbus-server-unix.c

   1 /* -*- mode: C; c-file-style: "gnu" -*- */
   2 /* dbus-server-unix.c Server implementation for Unix network protocols.
   3  *
   4  * Copyright (C) 2002  Red Hat Inc.
   5  *
   6  * Licensed under the Academic Free License version 1.2
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  *
  22  */
  23
  24 #include "dbus-internals.h"
  25 #include "dbus-server-unix.h"
  26 #include "dbus-transport-unix.h"
  27 #include "dbus-connection-internal.h"
  28 #include <sys/types.h>
  29 #include <unistd.h>
  30
  31 /**
  32  * @defgroup DBusServerUnix DBusServer implementations for UNIX
  33  * @ingroup  DBusInternals
  34  * @brief Implementation details of DBusServer on UNIX
  35  *
  36  * @{
  37  */
  38 /**
  39  *
  40  * Opaque object representing a Unix server implementation.
  41  */
  42 typedef struct DBusServerUnix DBusServerUnix;
  43
  44 /**
  45  * Implementation details of DBusServerUnix. All members
  46  * are private.
  47  */
  48 struct DBusServerUnix
  49 {
  50   DBusServer base;  /**< Parent class members. */
  51   int fd;           /**< File descriptor or -1 if disconnected. */
  52   DBusWatch *watch; /**< File descriptor watch. */
  53 };
  54
  55 static void
  56 unix_finalize (DBusServer *server)
  57 {
  58   DBusServerUnix *unix_server = (DBusServerUnix*) server;
  59
  60   _dbus_server_finalize_base (server);
  61
  62   if (unix_server->watch)
  63     _dbus_watch_unref (unix_server->watch);
  64
  65   dbus_free (server);
  66 }
  67
  68 /**
  69  * @todo unreffing the connection at the end may cause
  70  * us to drop the last ref to the connection before
  71  * disconnecting it. That is invalid.
  72  */
  73 static void
  74 handle_new_client_fd (DBusServer *server,
  75                       int         client_fd)
  76 {
  77   DBusConnection *connection;
  78   DBusTransport *transport;
  79
  80   _dbus_verbose ("Creating new client connection with fd %d\n", client_fd);
  81
  82   if (!_dbus_set_fd_nonblocking (client_fd, NULL))
  83     return;
  84
  85   transport = _dbus_transport_new_for_fd (client_fd, TRUE);
  86   if (transport == NULL)
  87     {
  88       close (client_fd);
  89       return;
  90     }
  91
  92   /* note that client_fd is now owned by the transport, and will be
  93    * closed on transport disconnection/finalization
  94    */
  95
  96   connection = _dbus_connection_new_for_transport (transport);
  97   _dbus_transport_unref (transport);
  98
  99   if (connection == NULL)
 100     return;
 101
 102   _dbus_connection_set_connection_counter (connection,
 103                                            server->connection_counter);
 104
 105   /* See if someone wants to handle this new connection,
 106    * self-referencing for paranoia
 107    */
 108   if (server->new_connection_function)
 109     {
 110       dbus_server_ref (server);
 111
 112       (* server->new_connection_function) (server, connection,
 113                                            server->new_connection_data);
 114       dbus_server_unref (server);
 115     }
 116
 117   /* If no one grabbed a reference, the connection will die. */
 118   dbus_connection_unref (connection);
 119 }
 120
 121 static void
 122 unix_handle_watch (DBusServer  *server,
 123                    DBusWatch   *watch,
 124                    unsigned int flags)
 125 {
 126   DBusServerUnix *unix_server = (DBusServerUnix*) server;
 127
 128   _dbus_assert (watch == unix_server->watch);
 129
 130   _dbus_verbose ("Handling client connection, flags 0x%x\n", flags);
 131
 132   if (flags & DBUS_WATCH_READABLE)
 133     {
 134       int client_fd;
 135       int listen_fd;
 136
 137       listen_fd = dbus_watch_get_fd (watch);
 138
 139       client_fd = _dbus_accept (listen_fd);
 140
 141       if (client_fd < 0)
 142         {
 143           /* EINTR handled for us */
 144
 145           if (errno == EAGAIN || errno == EWOULDBLOCK)
 146             _dbus_verbose ("No client available to accept after all\n");
 147           else
 148             _dbus_verbose ("Failed to accept a client connection: %s\n",
 149                            _dbus_strerror (errno));
 150         }
 151       else
 152         {
 153           _dbus_fd_set_close_on_exec (client_fd);
 154           handle_new_client_fd (server, client_fd);
 155         }
 156     }
 157
 158   if (flags & DBUS_WATCH_ERROR)
 159     _dbus_verbose ("Error on server listening socket\n");
 160
 161   if (flags & DBUS_WATCH_HANGUP)
 162     _dbus_verbose ("Hangup on server listening socket\n");
 163 }
 164
 165 static void
 166 unix_disconnect (DBusServer *server)
 167 {
 168   DBusServerUnix *unix_server = (DBusServerUnix*) server;
 169
 170   if (unix_server->watch)
 171     {
 172       _dbus_server_remove_watch (server,
 173                                  unix_server->watch);
 174       _dbus_watch_unref (unix_server->watch);
 175       unix_server->watch = NULL;
 176     }
 177
 178   close (unix_server->fd);
 179   unix_server->fd = -1;
 180 }
 181
 182 static DBusServerVTable unix_vtable = {
 183   unix_finalize,
 184   unix_handle_watch,
 185   unix_disconnect
 186 };
 187
 188 /**
 189  * Creates a new server listening on the given file descriptor.  The
 190  * file descriptor should be nonblocking (use
 191  * _dbus_set_fd_nonblocking() to make it so). The file descriptor
 192  * should be listening for connections, that is, listen() should have
 193  * been successfully invoked on it. The server will use accept() to
 194  * accept new client connections.
 195  *
 196  * @param fd the file descriptor.
 197  * @returns the new server, or #NULL if no memory.
 198  *
 199  */
 200 DBusServer*
 201 _dbus_server_new_for_fd (int fd)
 202 {
 203   DBusServerUnix *unix_server;
 204   DBusWatch *watch;
 205
 206   watch = _dbus_watch_new (fd,
 207                            DBUS_WATCH_READABLE,
 208                            TRUE);
 209   if (watch == NULL)
 210     return NULL;
 211
 212   unix_server = dbus_new0 (DBusServerUnix, 1);
 213   if (unix_server == NULL)
 214     {
 215       _dbus_watch_unref (watch);
 216       return NULL;
 217     }
 218
 219   if (!_dbus_server_init_base (&unix_server->base,
 220                                &unix_vtable))
 221     {
 222       _dbus_watch_unref (watch);
 223       dbus_free (unix_server);
 224       return NULL;
 225     }
 226
 227   if (!_dbus_server_add_watch (&unix_server->base,
 228                                watch))
 229     {
 230       _dbus_server_finalize_base (&unix_server->base);
 231       _dbus_watch_unref (watch);
 232       dbus_free (unix_server);
 233       return NULL;
 234     }
 235
 236   unix_server->fd = fd;
 237   unix_server->watch = watch;
 238
 239   return (DBusServer*) unix_server;
 240 }
 241
 242 /**
 243  * Creates a new server listening on the given Unix domain socket.
 244  *
 245  * @param path the path for the domain socket.
 246  * @param result location to store reason for failure.
 247  * @returns the new server, or #NULL on failure.
 248  */
 249 DBusServer*
 250 _dbus_server_new_for_domain_socket (const char     *path,
 251                                     DBusResultCode *result)
 252 {
 253   DBusServer *server;
 254   int listen_fd;
 255
 256   listen_fd = _dbus_listen_unix_socket (path, result);
 257   _dbus_fd_set_close_on_exec (listen_fd);
 258
 259   if (listen_fd < 0)
 260     return NULL;
 261
 262   server = _dbus_server_new_for_fd (listen_fd);
 263   if (server == NULL)
 264     {
 265       dbus_set_result (result, DBUS_RESULT_NO_MEMORY);
 266       close (listen_fd);
 267       return NULL;
 268     }
 269
 270   return server;
 271 }
 272
 273 /**
 274  * Creates a new server listening on the given hostname and port
 275  *
 276  * @param host the hostname to listen on.
 277  * @param port the port to listen on.
 278  * @param result location to store reason for failure.
 279  * @returns the new server, or #NULL on failure.
 280  */
 281 DBusServer*
 282 _dbus_server_new_for_tcp_socket (const char     *host,
 283                                  dbus_uint32_t   port,
 284                                  DBusResultCode *result)
 285 {
 286   DBusServer *server;
 287   int listen_fd;
 288
 289   listen_fd = _dbus_listen_tcp_socket (host, port, result);
 290   _dbus_fd_set_close_on_exec (listen_fd);
 291
 292   if (listen_fd < 0)
 293     return NULL;
 294
 295   server = _dbus_server_new_for_fd (listen_fd);
 296   if (server == NULL)
 297     {
 298       dbus_set_result (result, DBUS_RESULT_NO_MEMORY);
 299       close (listen_fd);
 300       return NULL;
 301     }
 302
 303   return server;
 304
 305
 306 }
 307
 308 /** @} */
 309