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 static void
  69 handle_new_client_fd (DBusServer *server,
  70                       int         client_fd)
  71 {
  72   DBusConnection *connection;
  73   DBusTransport *transport;
  74
  75   _dbus_verbose ("Creating new client connection with fd %d\n", client_fd);
  76
  77   if (!_dbus_set_fd_nonblocking (client_fd, NULL))
  78     return;
  79
  80   transport = _dbus_transport_new_for_fd (client_fd, TRUE);
  81   if (transport == NULL)
  82     {
  83       close (client_fd);
  84       return;
  85     }
  86
  87   /* note that client_fd is now owned by the transport, and will be
  88    * closed on transport disconnection/finalization
  89    */
  90
  91   connection = _dbus_connection_new_for_transport (transport);
  92   _dbus_transport_unref (transport);
  93
  94   if (connection == NULL)
  95     return;
  96
  97   /* See if someone wants to handle this new connection,
  98    * self-referencing for paranoia
  99    */
 100   if (server->new_connection_function)
 101     {
 102       dbus_server_ref (server);
 103
 104       (* server->new_connection_function) (server, connection,
 105                                            server->new_connection_data);
 106       dbus_server_unref (server);
 107     }
 108
 109   /* If no one grabbed a reference, the connection will die. */
 110   dbus_connection_unref (connection);
 111 }
 112
 113 static void
 114 unix_handle_watch (DBusServer  *server,
 115                    DBusWatch   *watch,
 116                    unsigned int flags)
 117 {
 118   DBusServerUnix *unix_server = (DBusServerUnix*) server;
 119
 120   _dbus_assert (watch == unix_server->watch);
 121
 122   _dbus_verbose ("Handling client connection, flags 0x%x\n", flags);
 123
 124   if (flags & DBUS_WATCH_READABLE)
 125     {
 126       int client_fd;
 127       int listen_fd;
 128
 129       listen_fd = dbus_watch_get_fd (watch);
 130
 131       client_fd = _dbus_accept (listen_fd);
 132
 133       if (client_fd < 0)
 134         {
 135           /* EINTR handled for us */
 136
 137           if (errno == EAGAIN || errno == EWOULDBLOCK)
 138             _dbus_verbose ("No client available to accept after all\n");
 139           else
 140             _dbus_verbose ("Failed to accept a client connection: %s\n",
 141                            _dbus_strerror (errno));
 142         }
 143       else
 144         {
 145           handle_new_client_fd (server, client_fd);
 146         }
 147     }
 148
 149   if (flags & DBUS_WATCH_ERROR)
 150     _dbus_verbose ("Error on server listening socket\n");
 151
 152   if (flags & DBUS_WATCH_HANGUP)
 153     _dbus_verbose ("Hangup on server listening socket\n");
 154 }
 155
 156 static void
 157 unix_disconnect (DBusServer *server)
 158 {
 159   DBusServerUnix *unix_server = (DBusServerUnix*) server;
 160
 161   if (unix_server->watch)
 162     {
 163       _dbus_server_remove_watch (server,
 164                                  unix_server->watch);
 165       _dbus_watch_unref (unix_server->watch);
 166       unix_server->watch = NULL;
 167     }
 168
 169   close (unix_server->fd);
 170   unix_server->fd = -1;
 171 }
 172
 173 static DBusServerVTable unix_vtable = {
 174   unix_finalize,
 175   unix_handle_watch,
 176   unix_disconnect
 177 };
 178
 179 /**
 180  * Creates a new server listening on the given file descriptor.  The
 181  * file descriptor should be nonblocking (use
 182  * _dbus_set_fd_nonblocking() to make it so). The file descriptor
 183  * should be listening for connections, that is, listen() should have
 184  * been successfully invoked on it. The server will use accept() to
 185  * accept new client connections.
 186  *
 187  * @param fd the file descriptor.
 188  * @returns the new server, or #NULL if no memory.
 189  *
 190  */
 191 DBusServer*
 192 _dbus_server_new_for_fd (int fd)
 193 {
 194   DBusServerUnix *unix_server;
 195   DBusWatch *watch;
 196
 197   watch = _dbus_watch_new (fd,
 198                            DBUS_WATCH_READABLE);
 199   if (watch == NULL)
 200     return NULL;
 201
 202   unix_server = dbus_new0 (DBusServerUnix, 1);
 203   if (unix_server == NULL)
 204     {
 205       _dbus_watch_unref (watch);
 206       return NULL;
 207     }
 208
 209   if (!_dbus_server_init_base (&unix_server->base,
 210                                &unix_vtable))
 211     {
 212       _dbus_watch_unref (watch);
 213       dbus_free (unix_server);
 214       return NULL;
 215     }
 216
 217   if (!_dbus_server_add_watch (&unix_server->base,
 218                                watch))
 219     {
 220       _dbus_server_finalize_base (&unix_server->base);
 221       _dbus_watch_unref (watch);
 222       dbus_free (unix_server);
 223       return NULL;
 224     }
 225
 226   unix_server->fd = fd;
 227   unix_server->watch = watch;
 228
 229   return (DBusServer*) unix_server;
 230 }
 231
 232 /**
 233  * Creates a new server listening on the given Unix domain socket.
 234  *
 235  * @param path the path for the domain socket.
 236  * @param result location to store reason for failure.
 237  * @returns the new server, or #NULL on failure.
 238  */
 239 DBusServer*
 240 _dbus_server_new_for_domain_socket (const char     *path,
 241                                     DBusResultCode *result)
 242 {
 243   DBusServer *server;
 244   int listen_fd;
 245
 246   listen_fd = _dbus_listen_unix_socket (path, result);
 247   if (listen_fd < 0)
 248     return NULL;
 249
 250   server = _dbus_server_new_for_fd (listen_fd);
 251   if (server == NULL)
 252     {
 253       dbus_set_result (result, DBUS_RESULT_NO_MEMORY);
 254       close (listen_fd);
 255       return NULL;
 256     }
 257
 258   return server;
 259 }
 260
 261 /** @} */
 262