1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2 /* dbus-transport-socket.c Socket subclasses of DBusTransport
4 * Copyright (C) 2002, 2003, 2004, 2006 Red Hat Inc.
6 * Licensed under the Academic Free License version 2.1
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
25 #include "dbus-internals.h"
26 #include "dbus-connection-internal.h"
27 #include "dbus-nonce.h"
28 #include "dbus-transport-socket.h"
29 #include "dbus-transport-protected.h"
30 #include "dbus-watch.h"
31 #include "dbus-credentials.h"
34 * @defgroup DBusTransportSocket DBusTransport implementations for sockets
35 * @ingroup DBusInternals
36 * @brief Implementation details of DBusTransport on sockets
42 * Opaque object representing a socket file descriptor transport.
44 typedef struct DBusTransportSocket DBusTransportSocket;
47 * Implementation details of DBusTransportSocket. All members are private.
49 struct DBusTransportSocket
51 DBusTransport base; /**< Parent instance */
52 int fd; /**< File descriptor. */
53 DBusWatch *read_watch; /**< Watch for readability. */
54 DBusWatch *write_watch; /**< Watch for writability. */
56 int max_bytes_read_per_iteration; /**< To avoid blocking too long. */
57 int max_bytes_written_per_iteration; /**< To avoid blocking too long. */
59 int message_bytes_written; /**< Number of bytes of current
60 * outgoing message that have
63 DBusString encoded_outgoing; /**< Encoded version of current
66 DBusString encoded_incoming; /**< Encoded version of current
72 free_watches (DBusTransport *transport)
74 DBusTransportSocket *socket_transport = (DBusTransportSocket*) transport;
76 _dbus_verbose ("%s start\n", _DBUS_FUNCTION_NAME);
78 if (socket_transport->read_watch)
80 if (transport->connection)
81 _dbus_connection_remove_watch_unlocked (transport->connection,
82 socket_transport->read_watch);
83 _dbus_watch_invalidate (socket_transport->read_watch);
84 _dbus_watch_unref (socket_transport->read_watch);
85 socket_transport->read_watch = NULL;
88 if (socket_transport->write_watch)
90 if (transport->connection)
91 _dbus_connection_remove_watch_unlocked (transport->connection,
92 socket_transport->write_watch);
93 _dbus_watch_invalidate (socket_transport->write_watch);
94 _dbus_watch_unref (socket_transport->write_watch);
95 socket_transport->write_watch = NULL;
98 _dbus_verbose ("%s end\n", _DBUS_FUNCTION_NAME);
102 socket_finalize (DBusTransport *transport)
104 DBusTransportSocket *socket_transport = (DBusTransportSocket*) transport;
106 _dbus_verbose ("%s\n", _DBUS_FUNCTION_NAME);
108 free_watches (transport);
110 _dbus_string_free (&socket_transport->encoded_outgoing);
111 _dbus_string_free (&socket_transport->encoded_incoming);
113 _dbus_transport_finalize_base (transport);
115 _dbus_assert (socket_transport->read_watch == NULL);
116 _dbus_assert (socket_transport->write_watch == NULL);
118 dbus_free (transport);
122 check_write_watch (DBusTransport *transport)
124 DBusTransportSocket *socket_transport = (DBusTransportSocket*) transport;
127 if (transport->connection == NULL)
130 if (transport->disconnected)
132 _dbus_assert (socket_transport->write_watch == NULL);
136 _dbus_transport_ref (transport);
138 if (_dbus_transport_get_is_authenticated (transport))
139 needed = _dbus_connection_has_messages_to_send_unlocked (transport->connection);
142 if (transport->send_credentials_pending)
146 DBusAuthState auth_state;
148 auth_state = _dbus_auth_do_work (transport->auth);
150 /* If we need memory we install the write watch just in case,
151 * if there's no need for it, it will get de-installed
152 * next time we try reading.
154 if (auth_state == DBUS_AUTH_STATE_HAVE_BYTES_TO_SEND ||
155 auth_state == DBUS_AUTH_STATE_WAITING_FOR_MEMORY)
162 _dbus_verbose ("check_write_watch(): needed = %d on connection %p watch %p fd = %d outgoing messages exist %d\n",
163 needed, transport->connection, socket_transport->write_watch,
164 socket_transport->fd,
165 _dbus_connection_has_messages_to_send_unlocked (transport->connection));
167 _dbus_connection_toggle_watch_unlocked (transport->connection,
168 socket_transport->write_watch,
171 _dbus_transport_unref (transport);
175 check_read_watch (DBusTransport *transport)
177 DBusTransportSocket *socket_transport = (DBusTransportSocket*) transport;
178 dbus_bool_t need_read_watch;
180 _dbus_verbose ("%s: fd = %d\n",
181 _DBUS_FUNCTION_NAME, socket_transport->fd);
183 if (transport->connection == NULL)
186 if (transport->disconnected)
188 _dbus_assert (socket_transport->read_watch == NULL);
192 _dbus_transport_ref (transport);
194 if (_dbus_transport_get_is_authenticated (transport))
196 (_dbus_counter_get_size_value (transport->live_messages) < transport->max_live_messages_size) &&
197 (_dbus_counter_get_unix_fd_value (transport->live_messages) < transport->max_live_messages_unix_fds);
200 if (transport->receive_credentials_pending)
201 need_read_watch = TRUE;
204 /* The reason to disable need_read_watch when not WAITING_FOR_INPUT
205 * is to avoid spinning on the file descriptor when we're waiting
206 * to write or for some other part of the auth process
208 DBusAuthState auth_state;
210 auth_state = _dbus_auth_do_work (transport->auth);
212 /* If we need memory we install the read watch just in case,
213 * if there's no need for it, it will get de-installed
214 * next time we try reading. If we're authenticated we
215 * install it since we normally have it installed while
218 if (auth_state == DBUS_AUTH_STATE_WAITING_FOR_INPUT ||
219 auth_state == DBUS_AUTH_STATE_WAITING_FOR_MEMORY ||
220 auth_state == DBUS_AUTH_STATE_AUTHENTICATED)
221 need_read_watch = TRUE;
223 need_read_watch = FALSE;
227 _dbus_verbose (" setting read watch enabled = %d\n", need_read_watch);
228 _dbus_connection_toggle_watch_unlocked (transport->connection,
229 socket_transport->read_watch,
232 _dbus_transport_unref (transport);
236 do_io_error (DBusTransport *transport)
238 _dbus_transport_ref (transport);
239 _dbus_transport_disconnect (transport);
240 _dbus_transport_unref (transport);
243 /* return value is whether we successfully read any new data. */
245 read_data_into_auth (DBusTransport *transport,
248 DBusTransportSocket *socket_transport = (DBusTransportSocket*) transport;
254 _dbus_auth_get_buffer (transport->auth, &buffer);
256 bytes_read = _dbus_read_socket (socket_transport->fd,
257 buffer, socket_transport->max_bytes_read_per_iteration);
259 _dbus_auth_return_buffer (transport->auth, buffer,
260 bytes_read > 0 ? bytes_read : 0);
264 _dbus_verbose (" read %d bytes in auth phase\n", bytes_read);
268 else if (bytes_read < 0)
270 /* EINTR already handled for us */
272 if (_dbus_get_is_errno_enomem ())
276 else if (_dbus_get_is_errno_eagain_or_ewouldblock ())
277 ; /* do nothing, just return FALSE below */
280 _dbus_verbose ("Error reading from remote app: %s\n",
281 _dbus_strerror_from_errno ());
282 do_io_error (transport);
289 _dbus_assert (bytes_read == 0);
291 _dbus_verbose ("Disconnected from remote app\n");
292 do_io_error (transport);
298 /* Return value is whether we successfully wrote any bytes */
300 write_data_from_auth (DBusTransport *transport)
302 DBusTransportSocket *socket_transport = (DBusTransportSocket*) transport;
304 const DBusString *buffer;
306 if (!_dbus_auth_get_bytes_to_send (transport->auth,
310 bytes_written = _dbus_write_socket (socket_transport->fd,
312 0, _dbus_string_get_length (buffer));
314 if (bytes_written > 0)
316 _dbus_auth_bytes_sent (transport->auth, bytes_written);
319 else if (bytes_written < 0)
321 /* EINTR already handled for us */
323 if (_dbus_get_is_errno_eagain_or_ewouldblock ())
327 _dbus_verbose ("Error writing to remote app: %s\n",
328 _dbus_strerror_from_errno ());
329 do_io_error (transport);
338 exchange_credentials (DBusTransport *transport,
339 dbus_bool_t do_reading,
340 dbus_bool_t do_writing)
342 DBusTransportSocket *socket_transport = (DBusTransportSocket*) transport;
343 DBusError error = DBUS_ERROR_INIT;
345 _dbus_verbose ("exchange_credentials: do_reading = %d, do_writing = %d\n",
346 do_reading, do_writing);
348 if (do_writing && transport->send_credentials_pending)
350 if (_dbus_send_credentials_socket (socket_transport->fd,
353 transport->send_credentials_pending = FALSE;
357 _dbus_verbose ("Failed to write credentials: %s\n", error.message);
358 dbus_error_free (&error);
359 do_io_error (transport);
363 if (do_reading && transport->receive_credentials_pending)
365 /* FIXME this can fail due to IO error _or_ OOM, broken
366 * (somewhat tricky to fix since the OOM error can be set after
367 * we already read the credentials byte, so basically we need to
368 * separate reading the byte and storing it in the
369 * transport->credentials). Does not really matter for now
370 * because storing in credentials never actually fails on unix.
372 if (_dbus_read_credentials_socket (socket_transport->fd,
373 transport->credentials,
376 transport->receive_credentials_pending = FALSE;
380 _dbus_verbose ("Failed to read credentials %s\n", error.message);
381 dbus_error_free (&error);
382 do_io_error (transport);
386 if (!(transport->send_credentials_pending ||
387 transport->receive_credentials_pending))
389 if (!_dbus_auth_set_credentials (transport->auth,
390 transport->credentials))
398 do_authentication (DBusTransport *transport,
399 dbus_bool_t do_reading,
400 dbus_bool_t do_writing,
401 dbus_bool_t *auth_completed)
404 dbus_bool_t orig_auth_state;
408 orig_auth_state = _dbus_transport_get_is_authenticated (transport);
410 /* This is essential to avoid the check_write_watch() at the end,
411 * we don't want to add a write watch in do_iteration before
412 * we try writing and get EAGAIN
417 *auth_completed = FALSE;
421 _dbus_transport_ref (transport);
423 while (!_dbus_transport_get_is_authenticated (transport) &&
424 _dbus_transport_get_is_connected (transport))
426 if (!exchange_credentials (transport, do_reading, do_writing))
433 if (transport->send_credentials_pending ||
434 transport->receive_credentials_pending)
436 _dbus_verbose ("send_credentials_pending = %d receive_credentials_pending = %d\n",
437 transport->send_credentials_pending,
438 transport->receive_credentials_pending);
442 #define TRANSPORT_SIDE(t) ((t)->is_server ? "server" : "client")
443 switch (_dbus_auth_do_work (transport->auth))
445 case DBUS_AUTH_STATE_WAITING_FOR_INPUT:
446 _dbus_verbose (" %s auth state: waiting for input\n",
447 TRANSPORT_SIDE (transport));
448 if (!do_reading || !read_data_into_auth (transport, &oom))
452 case DBUS_AUTH_STATE_WAITING_FOR_MEMORY:
453 _dbus_verbose (" %s auth state: waiting for memory\n",
454 TRANSPORT_SIDE (transport));
459 case DBUS_AUTH_STATE_HAVE_BYTES_TO_SEND:
460 _dbus_verbose (" %s auth state: bytes to send\n",
461 TRANSPORT_SIDE (transport));
462 if (!do_writing || !write_data_from_auth (transport))
466 case DBUS_AUTH_STATE_NEED_DISCONNECT:
467 _dbus_verbose (" %s auth state: need to disconnect\n",
468 TRANSPORT_SIDE (transport));
469 do_io_error (transport);
472 case DBUS_AUTH_STATE_AUTHENTICATED:
473 _dbus_verbose (" %s auth state: authenticated\n",
474 TRANSPORT_SIDE (transport));
481 *auth_completed = (orig_auth_state != _dbus_transport_get_is_authenticated (transport));
483 check_read_watch (transport);
484 check_write_watch (transport);
485 _dbus_transport_unref (transport);
493 /* returns false on oom */
495 do_writing (DBusTransport *transport)
498 DBusTransportSocket *socket_transport = (DBusTransportSocket*) transport;
501 /* No messages without authentication! */
502 if (!_dbus_transport_get_is_authenticated (transport))
504 _dbus_verbose ("Not authenticated, not writing anything\n");
508 if (transport->disconnected)
510 _dbus_verbose ("Not connected, not writing anything\n");
515 _dbus_verbose ("do_writing(), have_messages = %d, fd = %d\n",
516 _dbus_connection_has_messages_to_send_unlocked (transport->connection),
517 socket_transport->fd);
523 while (!transport->disconnected &&
524 _dbus_connection_has_messages_to_send_unlocked (transport->connection))
527 DBusMessage *message;
528 const DBusString *header;
529 const DBusString *body;
530 int header_len, body_len;
531 int total_bytes_to_write;
533 if (total > socket_transport->max_bytes_written_per_iteration)
535 _dbus_verbose ("%d bytes exceeds %d bytes written per iteration, returning\n",
536 total, socket_transport->max_bytes_written_per_iteration);
540 message = _dbus_connection_get_message_to_send (transport->connection);
541 _dbus_assert (message != NULL);
542 dbus_message_lock (message);
545 _dbus_verbose ("writing message %p\n", message);
548 _dbus_message_get_network_data (message,
551 header_len = _dbus_string_get_length (header);
552 body_len = _dbus_string_get_length (body);
554 if (_dbus_auth_needs_encoding (transport->auth))
556 /* Does fd passing even make sense with encoded data? */
557 _dbus_assert(!DBUS_TRANSPORT_CAN_SEND_UNIX_FD(transport));
559 if (_dbus_string_get_length (&socket_transport->encoded_outgoing) == 0)
561 if (!_dbus_auth_encode_data (transport->auth,
562 header, &socket_transport->encoded_outgoing))
568 if (!_dbus_auth_encode_data (transport->auth,
569 body, &socket_transport->encoded_outgoing))
571 _dbus_string_set_length (&socket_transport->encoded_outgoing, 0);
577 total_bytes_to_write = _dbus_string_get_length (&socket_transport->encoded_outgoing);
580 _dbus_verbose ("encoded message is %d bytes\n",
581 total_bytes_to_write);
585 _dbus_write_socket (socket_transport->fd,
586 &socket_transport->encoded_outgoing,
587 socket_transport->message_bytes_written,
588 total_bytes_to_write - socket_transport->message_bytes_written);
592 total_bytes_to_write = header_len + body_len;
595 _dbus_verbose ("message is %d bytes\n",
596 total_bytes_to_write);
599 #ifdef HAVE_UNIX_FD_PASSING
600 if (socket_transport->message_bytes_written <= 0 && DBUS_TRANSPORT_CAN_SEND_UNIX_FD(transport))
602 /* Send the fds along with the first byte of the message */
606 _dbus_message_get_unix_fds(message, &unix_fds, &n);
609 _dbus_write_socket_with_unix_fds_two (socket_transport->fd,
611 socket_transport->message_bytes_written,
612 header_len - socket_transport->message_bytes_written,
618 if (bytes_written > 0 && n > 0)
619 _dbus_verbose("Wrote %i unix fds\n", n);
624 if (socket_transport->message_bytes_written < header_len)
627 _dbus_write_socket_two (socket_transport->fd,
629 socket_transport->message_bytes_written,
630 header_len - socket_transport->message_bytes_written,
637 _dbus_write_socket (socket_transport->fd,
639 (socket_transport->message_bytes_written - header_len),
641 (socket_transport->message_bytes_written - header_len));
646 if (bytes_written < 0)
648 /* EINTR already handled for us */
650 /* For some discussion of why we also ignore EPIPE here, see
651 * http://lists.freedesktop.org/archives/dbus/2008-March/009526.html
654 if (_dbus_get_is_errno_eagain_or_ewouldblock () || _dbus_get_is_errno_epipe ())
658 _dbus_verbose ("Error writing to remote app: %s\n",
659 _dbus_strerror_from_errno ());
660 do_io_error (transport);
666 _dbus_verbose (" wrote %d bytes of %d\n", bytes_written,
667 total_bytes_to_write);
669 total += bytes_written;
670 socket_transport->message_bytes_written += bytes_written;
672 _dbus_assert (socket_transport->message_bytes_written <=
673 total_bytes_to_write);
675 if (socket_transport->message_bytes_written == total_bytes_to_write)
677 socket_transport->message_bytes_written = 0;
678 _dbus_string_set_length (&socket_transport->encoded_outgoing, 0);
679 _dbus_string_compact (&socket_transport->encoded_outgoing, 2048);
681 _dbus_connection_message_sent (transport->connection,
694 /* returns false on out-of-memory */
696 do_reading (DBusTransport *transport)
698 DBusTransportSocket *socket_transport = (DBusTransportSocket*) transport;
704 _dbus_verbose ("%s: fd = %d\n", _DBUS_FUNCTION_NAME,
705 socket_transport->fd);
707 /* No messages without authentication! */
708 if (!_dbus_transport_get_is_authenticated (transport))
717 /* See if we've exceeded max messages and need to disable reading */
718 check_read_watch (transport);
720 if (total > socket_transport->max_bytes_read_per_iteration)
722 _dbus_verbose ("%d bytes exceeds %d bytes read per iteration, returning\n",
723 total, socket_transport->max_bytes_read_per_iteration);
727 _dbus_assert (socket_transport->read_watch != NULL ||
728 transport->disconnected);
730 if (transport->disconnected)
733 if (!dbus_watch_get_enabled (socket_transport->read_watch))
736 if (_dbus_auth_needs_decoding (transport->auth))
738 /* Does fd passing even make sense with encoded data? */
739 _dbus_assert(!DBUS_TRANSPORT_CAN_SEND_UNIX_FD(transport));
741 if (_dbus_string_get_length (&socket_transport->encoded_incoming) > 0)
742 bytes_read = _dbus_string_get_length (&socket_transport->encoded_incoming);
744 bytes_read = _dbus_read_socket (socket_transport->fd,
745 &socket_transport->encoded_incoming,
746 socket_transport->max_bytes_read_per_iteration);
748 _dbus_assert (_dbus_string_get_length (&socket_transport->encoded_incoming) ==
755 _dbus_message_loader_get_buffer (transport->loader,
758 orig_len = _dbus_string_get_length (buffer);
760 if (!_dbus_auth_decode_data (transport->auth,
761 &socket_transport->encoded_incoming,
764 _dbus_verbose ("Out of memory decoding incoming data\n");
765 _dbus_message_loader_return_buffer (transport->loader,
767 _dbus_string_get_length (buffer) - orig_len);
773 _dbus_message_loader_return_buffer (transport->loader,
775 _dbus_string_get_length (buffer) - orig_len);
777 _dbus_string_set_length (&socket_transport->encoded_incoming, 0);
778 _dbus_string_compact (&socket_transport->encoded_incoming, 2048);
783 _dbus_message_loader_get_buffer (transport->loader,
786 #ifdef HAVE_UNIX_FD_PASSING
787 if (DBUS_TRANSPORT_CAN_SEND_UNIX_FD(transport))
791 if (!_dbus_message_loader_get_unix_fds(transport->loader, &fds, &n_fds))
793 _dbus_verbose ("Out of memory reading file descriptors\n");
794 _dbus_message_loader_return_buffer (transport->loader, buffer, 0);
799 bytes_read = _dbus_read_socket_with_unix_fds(socket_transport->fd,
801 socket_transport->max_bytes_read_per_iteration,
804 if (bytes_read >= 0 && n_fds > 0)
805 _dbus_verbose("Read %i unix fds\n", n_fds);
807 _dbus_message_loader_return_unix_fds(transport->loader, fds, bytes_read < 0 ? 0 : n_fds);
812 bytes_read = _dbus_read_socket (socket_transport->fd,
813 buffer, socket_transport->max_bytes_read_per_iteration);
816 _dbus_message_loader_return_buffer (transport->loader,
818 bytes_read < 0 ? 0 : bytes_read);
823 /* EINTR already handled for us */
825 if (_dbus_get_is_errno_enomem ())
827 _dbus_verbose ("Out of memory in read()/do_reading()\n");
831 else if (_dbus_get_is_errno_eagain_or_ewouldblock ())
835 _dbus_verbose ("Error reading from remote app: %s\n",
836 _dbus_strerror_from_errno ());
837 do_io_error (transport);
841 else if (bytes_read == 0)
843 _dbus_verbose ("Disconnected from remote app\n");
844 do_io_error (transport);
849 _dbus_verbose (" read %d bytes\n", bytes_read);
853 if (!_dbus_transport_queue_messages (transport))
856 _dbus_verbose (" out of memory when queueing messages we just read in the transport\n");
860 /* Try reading more data until we get EAGAIN and return, or
861 * exceed max bytes per iteration. If in blocking mode of
862 * course we'll block instead of returning.
875 unix_error_with_read_to_come (DBusTransport *itransport,
879 DBusTransportSocket *transport = (DBusTransportSocket *) itransport;
881 if (!(flags & DBUS_WATCH_HANGUP || flags & DBUS_WATCH_ERROR))
884 /* If we have a read watch enabled ...
885 we -might have data incoming ... => handle the HANGUP there */
886 if (watch != transport->read_watch &&
887 _dbus_watch_get_enabled (transport->read_watch))
894 socket_handle_watch (DBusTransport *transport,
898 DBusTransportSocket *socket_transport = (DBusTransportSocket*) transport;
900 _dbus_assert (watch == socket_transport->read_watch ||
901 watch == socket_transport->write_watch);
902 _dbus_assert (watch != NULL);
904 /* If we hit an error here on a write watch, don't disconnect the transport yet because data can
905 * still be in the buffer and do_reading may need several iteration to read
906 * it all (because of its max_bytes_read_per_iteration limit).
908 if (!(flags & DBUS_WATCH_READABLE) && unix_error_with_read_to_come (transport, watch, flags))
910 _dbus_verbose ("Hang up or error on watch\n");
911 _dbus_transport_disconnect (transport);
915 if (watch == socket_transport->read_watch &&
916 (flags & DBUS_WATCH_READABLE))
918 dbus_bool_t auth_finished;
920 _dbus_verbose ("handling read watch %p flags = %x\n",
923 if (!do_authentication (transport, TRUE, FALSE, &auth_finished))
926 /* We don't want to do a read immediately following
927 * a successful authentication. This is so we
928 * have a chance to propagate the authentication
929 * state further up. Specifically, we need to
930 * process any pending data from the auth object.
934 if (!do_reading (transport))
936 _dbus_verbose ("no memory to read\n");
942 _dbus_verbose ("Not reading anything since we just completed the authentication\n");
945 else if (watch == socket_transport->write_watch &&
946 (flags & DBUS_WATCH_WRITABLE))
949 _dbus_verbose ("handling write watch, have_outgoing_messages = %d\n",
950 _dbus_connection_has_messages_to_send_unlocked (transport->connection));
952 if (!do_authentication (transport, FALSE, TRUE, NULL))
955 if (!do_writing (transport))
957 _dbus_verbose ("no memory to write\n");
961 /* See if we still need the write watch */
962 check_write_watch (transport);
964 #ifdef DBUS_ENABLE_VERBOSE_MODE
967 if (watch == socket_transport->read_watch)
968 _dbus_verbose ("asked to handle read watch with non-read condition 0x%x\n",
970 else if (watch == socket_transport->write_watch)
971 _dbus_verbose ("asked to handle write watch with non-write condition 0x%x\n",
974 _dbus_verbose ("asked to handle watch %p on fd %d that we don't recognize\n",
975 watch, dbus_watch_get_socket (watch));
977 #endif /* DBUS_ENABLE_VERBOSE_MODE */
983 socket_disconnect (DBusTransport *transport)
985 DBusTransportSocket *socket_transport = (DBusTransportSocket*) transport;
987 _dbus_verbose ("%s\n", _DBUS_FUNCTION_NAME);
989 free_watches (transport);
991 _dbus_close_socket (socket_transport->fd, NULL);
992 socket_transport->fd = -1;
996 socket_connection_set (DBusTransport *transport)
998 DBusTransportSocket *socket_transport = (DBusTransportSocket*) transport;
1000 _dbus_watch_set_handler (socket_transport->write_watch,
1001 _dbus_connection_handle_watch,
1002 transport->connection, NULL);
1004 _dbus_watch_set_handler (socket_transport->read_watch,
1005 _dbus_connection_handle_watch,
1006 transport->connection, NULL);
1008 if (!_dbus_connection_add_watch_unlocked (transport->connection,
1009 socket_transport->write_watch))
1012 if (!_dbus_connection_add_watch_unlocked (transport->connection,
1013 socket_transport->read_watch))
1015 _dbus_connection_remove_watch_unlocked (transport->connection,
1016 socket_transport->write_watch);
1020 check_read_watch (transport);
1021 check_write_watch (transport);
1027 * @todo We need to have a way to wake up the select sleep if
1028 * a new iteration request comes in with a flag (read/write) that
1029 * we're not currently serving. Otherwise a call that just reads
1030 * could block a write call forever (if there are no incoming
1034 socket_do_iteration (DBusTransport *transport,
1036 int timeout_milliseconds)
1038 DBusTransportSocket *socket_transport = (DBusTransportSocket*) transport;
1043 _dbus_verbose (" iteration flags = %s%s timeout = %d read_watch = %p write_watch = %p fd = %d\n",
1044 flags & DBUS_ITERATION_DO_READING ? "read" : "",
1045 flags & DBUS_ITERATION_DO_WRITING ? "write" : "",
1046 timeout_milliseconds,
1047 socket_transport->read_watch,
1048 socket_transport->write_watch,
1049 socket_transport->fd);
1051 /* the passed in DO_READING/DO_WRITING flags indicate whether to
1052 * read/write messages, but regardless of those we may need to block
1053 * for reading/writing to do auth. But if we do reading for auth,
1054 * we don't want to read any messages yet if not given DO_READING.
1057 poll_fd.fd = socket_transport->fd;
1060 if (_dbus_transport_get_is_authenticated (transport))
1062 /* This is kind of a hack; if we have stuff to write, then try
1063 * to avoid the poll. This is probably about a 5% speedup on an
1064 * echo client/server.
1066 * If both reading and writing were requested, we want to avoid this
1067 * since it could have funky effects:
1068 * - both ends spinning waiting for the other one to read
1069 * data so they can finish writing
1070 * - prioritizing all writing ahead of reading
1072 if ((flags & DBUS_ITERATION_DO_WRITING) &&
1073 !(flags & (DBUS_ITERATION_DO_READING | DBUS_ITERATION_BLOCK)) &&
1074 !transport->disconnected &&
1075 _dbus_connection_has_messages_to_send_unlocked (transport->connection))
1077 do_writing (transport);
1079 if (transport->disconnected ||
1080 !_dbus_connection_has_messages_to_send_unlocked (transport->connection))
1084 /* If we get here, we decided to do the poll() after all */
1085 _dbus_assert (socket_transport->read_watch);
1086 if (flags & DBUS_ITERATION_DO_READING)
1087 poll_fd.events |= _DBUS_POLLIN;
1089 _dbus_assert (socket_transport->write_watch);
1090 if (flags & DBUS_ITERATION_DO_WRITING)
1091 poll_fd.events |= _DBUS_POLLOUT;
1095 DBusAuthState auth_state;
1097 auth_state = _dbus_auth_do_work (transport->auth);
1099 if (transport->receive_credentials_pending ||
1100 auth_state == DBUS_AUTH_STATE_WAITING_FOR_INPUT)
1101 poll_fd.events |= _DBUS_POLLIN;
1103 if (transport->send_credentials_pending ||
1104 auth_state == DBUS_AUTH_STATE_HAVE_BYTES_TO_SEND)
1105 poll_fd.events |= _DBUS_POLLOUT;
1110 if (flags & DBUS_ITERATION_BLOCK)
1111 poll_timeout = timeout_milliseconds;
1115 /* For blocking selects we drop the connection lock here
1116 * to avoid blocking out connection access during a potentially
1117 * indefinite blocking call. The io path is still protected
1118 * by the io_path_cond condvar, so we won't reenter this.
1120 if (flags & DBUS_ITERATION_BLOCK)
1122 _dbus_verbose ("unlock %s pre poll\n", _DBUS_FUNCTION_NAME);
1123 _dbus_connection_unlock (transport->connection);
1127 poll_res = _dbus_poll (&poll_fd, 1, poll_timeout);
1129 if (poll_res < 0 && _dbus_get_is_errno_eintr ())
1132 if (flags & DBUS_ITERATION_BLOCK)
1134 _dbus_verbose ("lock %s post poll\n", _DBUS_FUNCTION_NAME);
1135 _dbus_connection_lock (transport->connection);
1141 poll_fd.revents = 0; /* some concern that posix does not guarantee this;
1142 * valgrind flags it as an error. though it probably
1143 * is guaranteed on linux at least.
1146 if (poll_fd.revents & _DBUS_POLLERR)
1147 do_io_error (transport);
1150 dbus_bool_t need_read = (poll_fd.revents & _DBUS_POLLIN) > 0;
1151 dbus_bool_t need_write = (poll_fd.revents & _DBUS_POLLOUT) > 0;
1152 dbus_bool_t authentication_completed;
1154 _dbus_verbose ("in iteration, need_read=%d need_write=%d\n",
1155 need_read, need_write);
1156 do_authentication (transport, need_read, need_write,
1157 &authentication_completed);
1159 /* See comment in socket_handle_watch. */
1160 if (authentication_completed)
1163 if (need_read && (flags & DBUS_ITERATION_DO_READING))
1164 do_reading (transport);
1165 if (need_write && (flags & DBUS_ITERATION_DO_WRITING))
1166 do_writing (transport);
1171 _dbus_verbose ("Error from _dbus_poll(): %s\n",
1172 _dbus_strerror_from_errno ());
1178 /* We need to install the write watch only if we did not
1179 * successfully write everything. Note we need to be careful that we
1180 * don't call check_write_watch *before* do_writing, since it's
1181 * inefficient to add the write watch, and we can avoid it most of
1182 * the time since we can write immediately.
1184 * However, we MUST always call check_write_watch(); DBusConnection code
1185 * relies on the fact that running an iteration will notice that
1186 * messages are pending.
1188 check_write_watch (transport);
1190 _dbus_verbose (" ... leaving do_iteration()\n");
1194 socket_live_messages_changed (DBusTransport *transport)
1196 /* See if we should look for incoming messages again */
1197 check_read_watch (transport);
1202 socket_get_socket_fd (DBusTransport *transport,
1205 DBusTransportSocket *socket_transport = (DBusTransportSocket*) transport;
1207 *fd_p = socket_transport->fd;
1212 static const DBusTransportVTable socket_vtable = {
1214 socket_handle_watch,
1216 socket_connection_set,
1217 socket_do_iteration,
1218 socket_live_messages_changed,
1219 socket_get_socket_fd
1223 * Creates a new transport for the given socket file descriptor. The file
1224 * descriptor must be nonblocking (use _dbus_set_fd_nonblocking() to
1225 * make it so). This function is shared by various transports that
1226 * boil down to a full duplex file descriptor.
1228 * @param fd the file descriptor.
1229 * @param server_guid non-#NULL if this transport is on the server side of a connection
1230 * @param address the transport's address
1231 * @returns the new transport, or #NULL if no memory.
1234 _dbus_transport_new_for_socket (int fd,
1235 const DBusString *server_guid,
1236 const DBusString *address)
1238 DBusTransportSocket *socket_transport;
1240 socket_transport = dbus_new0 (DBusTransportSocket, 1);
1241 if (socket_transport == NULL)
1244 if (!_dbus_string_init (&socket_transport->encoded_outgoing))
1247 if (!_dbus_string_init (&socket_transport->encoded_incoming))
1250 socket_transport->write_watch = _dbus_watch_new (fd,
1251 DBUS_WATCH_WRITABLE,
1254 if (socket_transport->write_watch == NULL)
1257 socket_transport->read_watch = _dbus_watch_new (fd,
1258 DBUS_WATCH_READABLE,
1261 if (socket_transport->read_watch == NULL)
1264 if (!_dbus_transport_init_base (&socket_transport->base,
1266 server_guid, address))
1269 #ifdef HAVE_UNIX_FD_PASSING
1270 _dbus_auth_set_unix_fd_possible(socket_transport->base.auth, _dbus_socket_can_pass_unix_fd(fd));
1273 socket_transport->fd = fd;
1274 socket_transport->message_bytes_written = 0;
1276 /* These values should probably be tunable or something. */
1277 socket_transport->max_bytes_read_per_iteration = 2048;
1278 socket_transport->max_bytes_written_per_iteration = 2048;
1280 return (DBusTransport*) socket_transport;
1283 _dbus_watch_unref (socket_transport->read_watch);
1285 _dbus_watch_unref (socket_transport->write_watch);
1287 _dbus_string_free (&socket_transport->encoded_incoming);
1289 _dbus_string_free (&socket_transport->encoded_outgoing);
1291 dbus_free (socket_transport);
1296 * Creates a new transport for the given hostname and port.
1297 * If host is NULL, it will default to localhost
1299 * @param host the host to connect to
1300 * @param port the port to connect to
1301 * @param family the address family to connect to
1302 * @param path to nonce file
1303 * @param error location to store reason for failure.
1304 * @returns a new transport, or #NULL on failure.
1307 _dbus_transport_new_for_tcp_socket (const char *host,
1310 const char *noncefile,
1314 DBusTransport *transport;
1317 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1319 if (!_dbus_string_init (&address))
1321 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1328 if (!_dbus_string_append (&address, noncefile ? "nonce-tcp:" : "tcp:"))
1331 if (!_dbus_string_append (&address, "host=") ||
1332 !_dbus_string_append (&address, host))
1335 if (!_dbus_string_append (&address, ",port=") ||
1336 !_dbus_string_append (&address, port))
1339 if (family != NULL &&
1340 (!_dbus_string_append (&address, "family=") ||
1341 !_dbus_string_append (&address, family)))
1344 if (noncefile != NULL &&
1345 (!_dbus_string_append (&address, "noncefile=") ||
1346 !_dbus_string_append (&address, noncefile)))
1349 fd = _dbus_connect_tcp_socket_with_nonce (host, port, family, noncefile, error);
1352 _DBUS_ASSERT_ERROR_IS_SET (error);
1353 _dbus_string_free (&address);
1357 _dbus_verbose ("Successfully connected to tcp socket %s:%s\n",
1360 transport = _dbus_transport_new_for_socket (fd, NULL, &address);
1361 _dbus_string_free (&address);
1362 if (transport == NULL)
1364 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1365 _dbus_close_socket (fd, NULL);
1372 _dbus_string_free (&address);
1373 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1378 * Opens a TCP socket transport.
1380 * @param entry the address entry to try opening as a tcp transport.
1381 * @param transport_p return location for the opened transport
1382 * @param error error to be set
1383 * @returns result of the attempt
1385 DBusTransportOpenResult
1386 _dbus_transport_open_socket(DBusAddressEntry *entry,
1387 DBusTransport **transport_p,
1392 dbus_bool_t isNonceTcp;
1394 method = dbus_address_entry_get_method (entry);
1395 _dbus_assert (method != NULL);
1397 isTcp = strcmp (method, "tcp") == 0;
1398 isNonceTcp = strcmp (method, "nonce-tcp") == 0;
1400 if (isTcp || isNonceTcp)
1402 const char *host = dbus_address_entry_get_value (entry, "host");
1403 const char *port = dbus_address_entry_get_value (entry, "port");
1404 const char *family = dbus_address_entry_get_value (entry, "family");
1405 const char *noncefile = dbus_address_entry_get_value (entry, "noncefile");
1407 if ((isNonceTcp == TRUE) != (noncefile != NULL)) {
1408 _dbus_set_bad_address (error, method, "noncefile", NULL);
1409 return DBUS_TRANSPORT_OPEN_BAD_ADDRESS;
1414 _dbus_set_bad_address (error, method, "port", NULL);
1415 return DBUS_TRANSPORT_OPEN_BAD_ADDRESS;
1418 *transport_p = _dbus_transport_new_for_tcp_socket (host, port, family, noncefile, error);
1419 if (*transport_p == NULL)
1421 _DBUS_ASSERT_ERROR_IS_SET (error);
1422 return DBUS_TRANSPORT_OPEN_DID_NOT_CONNECT;
1426 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1427 return DBUS_TRANSPORT_OPEN_OK;
1432 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1433 return DBUS_TRANSPORT_OPEN_NOT_HANDLED;