1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-server-unix.c Server implementation for Unix network protocols.
4 * Copyright (C) 2002 Red Hat Inc.
6 * Licensed under the Academic Free License version 1.2
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.
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.
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
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>
32 * @defgroup DBusServerUnix DBusServer implementations for UNIX
33 * @ingroup DBusInternals
34 * @brief Implementation details of DBusServer on UNIX
40 * Opaque object representing a Unix server implementation.
42 typedef struct DBusServerUnix DBusServerUnix;
45 * Implementation details of DBusServerUnix. All members
50 DBusServer base; /**< Parent class members. */
51 int fd; /**< File descriptor or -1 if disconnected. */
52 DBusWatch *watch; /**< File descriptor watch. */
56 unix_finalize (DBusServer *server)
58 DBusServerUnix *unix_server = (DBusServerUnix*) server;
60 _dbus_server_finalize_base (server);
62 if (unix_server->watch)
63 _dbus_watch_unref (unix_server->watch);
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.
73 /* Return value is just for memory, not other failures. */
75 handle_new_client_fd (DBusServer *server,
78 DBusConnection *connection;
79 DBusTransport *transport;
81 _dbus_verbose ("Creating new client connection with fd %d\n", client_fd);
83 if (!_dbus_set_fd_nonblocking (client_fd, NULL))
86 transport = _dbus_transport_new_for_fd (client_fd, TRUE, NULL);
87 if (transport == NULL)
93 /* note that client_fd is now owned by the transport, and will be
94 * closed on transport disconnection/finalization
97 connection = _dbus_connection_new_for_transport (transport);
98 _dbus_transport_unref (transport);
100 if (connection == NULL)
103 _dbus_connection_set_connection_counter (connection,
104 server->connection_counter);
106 /* See if someone wants to handle this new connection,
107 * self-referencing for paranoia
109 if (server->new_connection_function)
111 dbus_server_ref (server);
113 (* server->new_connection_function) (server, connection,
114 server->new_connection_data);
115 dbus_server_unref (server);
118 /* If no one grabbed a reference, the connection will die. */
119 dbus_connection_unref (connection);
125 unix_handle_watch (DBusServer *server,
129 DBusServerUnix *unix_server = (DBusServerUnix*) server;
131 _dbus_assert (watch == unix_server->watch);
133 _dbus_verbose ("Handling client connection, flags 0x%x\n", flags);
135 if (flags & DBUS_WATCH_READABLE)
140 listen_fd = dbus_watch_get_fd (watch);
142 client_fd = _dbus_accept (listen_fd);
146 /* EINTR handled for us */
148 if (errno == EAGAIN || errno == EWOULDBLOCK)
149 _dbus_verbose ("No client available to accept after all\n");
151 _dbus_verbose ("Failed to accept a client connection: %s\n",
152 _dbus_strerror (errno));
156 _dbus_fd_set_close_on_exec (client_fd);
158 if (!handle_new_client_fd (server, client_fd))
159 _dbus_verbose ("Rejected client connection due to lack of memory\n");
163 if (flags & DBUS_WATCH_ERROR)
164 _dbus_verbose ("Error on server listening socket\n");
166 if (flags & DBUS_WATCH_HANGUP)
167 _dbus_verbose ("Hangup on server listening socket\n");
173 unix_disconnect (DBusServer *server)
175 DBusServerUnix *unix_server = (DBusServerUnix*) server;
177 if (unix_server->watch)
179 _dbus_server_remove_watch (server,
181 _dbus_watch_unref (unix_server->watch);
182 unix_server->watch = NULL;
185 close (unix_server->fd);
186 unix_server->fd = -1;
189 static DBusServerVTable unix_vtable = {
196 * Creates a new server listening on the given file descriptor. The
197 * file descriptor should be nonblocking (use
198 * _dbus_set_fd_nonblocking() to make it so). The file descriptor
199 * should be listening for connections, that is, listen() should have
200 * been successfully invoked on it. The server will use accept() to
201 * accept new client connections.
203 * @param fd the file descriptor.
204 * @param address the server's address
205 * @returns the new server, or #NULL if no memory.
209 _dbus_server_new_for_fd (int fd,
210 const DBusString *address)
212 DBusServerUnix *unix_server;
215 watch = _dbus_watch_new (fd,
221 unix_server = dbus_new0 (DBusServerUnix, 1);
222 if (unix_server == NULL)
224 _dbus_watch_unref (watch);
228 if (!_dbus_server_init_base (&unix_server->base,
229 &unix_vtable, address))
231 _dbus_watch_unref (watch);
232 dbus_free (unix_server);
236 if (!_dbus_server_add_watch (&unix_server->base,
239 _dbus_server_finalize_base (&unix_server->base);
240 _dbus_watch_unref (watch);
241 dbus_free (unix_server);
245 unix_server->fd = fd;
246 unix_server->watch = watch;
248 return (DBusServer*) unix_server;
252 * Creates a new server listening on the given Unix domain socket.
254 * @param path the path for the domain socket.
255 * @param error location to store reason for failure.
256 * @returns the new server, or #NULL on failure.
259 _dbus_server_new_for_domain_socket (const char *path,
266 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
268 if (!_dbus_string_init (&address, _DBUS_INT_MAX))
270 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
274 if (!_dbus_string_append (&address, "unix:path=") ||
275 !_dbus_string_append (&address, path))
277 _dbus_string_free (&address);
278 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
282 listen_fd = _dbus_listen_unix_socket (path, error);
283 _dbus_fd_set_close_on_exec (listen_fd);
287 _dbus_string_free (&address);
291 server = _dbus_server_new_for_fd (listen_fd, &address);
294 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
296 _dbus_string_free (&address);
300 _dbus_string_free (&address);
306 * Creates a new server listening on the given hostname and port.
307 * If the hostname is NULL, listens on localhost.
309 * @param host the hostname to listen on.
310 * @param port the port to listen on.
311 * @param error location to store reason for failure.
312 * @returns the new server, or #NULL on failure.
315 _dbus_server_new_for_tcp_socket (const char *host,
323 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
325 if (!_dbus_string_init (&address, _DBUS_INT_MAX))
327 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
331 if (!_dbus_string_append (&address, "tcp:host=") ||
332 !_dbus_string_append (&address, host) ||
333 !_dbus_string_append (&address, ",port=") ||
334 !_dbus_string_append_int (&address, port))
336 _dbus_string_free (&address);
337 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
341 listen_fd = _dbus_listen_tcp_socket (host, port, error);
342 _dbus_fd_set_close_on_exec (listen_fd);
346 _dbus_string_free (&address);
350 server = _dbus_server_new_for_fd (listen_fd, &address);
353 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
355 _dbus_string_free (&address);
359 _dbus_string_free (&address);