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"
32 #include <stdio.h> //todo to remove
35 * @defgroup DBusTransportSocket DBusTransport implementations for sockets
36 * @ingroup DBusInternals
37 * @brief Implementation details of DBusTransport on sockets
43 * Opaque object representing a socket file descriptor transport.
45 typedef struct DBusTransportSocket DBusTransportSocket;
48 * Implementation details of DBusTransportSocket. All members are private.
50 struct DBusTransportSocket
52 DBusTransport base; /**< Parent instance */
53 int fd; /**< File descriptor. */
54 DBusWatch *read_watch; /**< Watch for readability. */
55 DBusWatch *write_watch; /**< Watch for writability. */
57 int max_bytes_read_per_iteration; /**< To avoid blocking too long. */
58 int max_bytes_written_per_iteration; /**< To avoid blocking too long. */
60 int message_bytes_written; /**< Number of bytes of current
61 * outgoing message that have
64 DBusString encoded_outgoing; /**< Encoded version of current
67 DBusString encoded_incoming; /**< Encoded version of current
73 free_watches (DBusTransport *transport)
75 DBusTransportSocket *socket_transport = (DBusTransportSocket*) transport;
77 _dbus_verbose ("start\n");
79 if (socket_transport->read_watch)
81 if (transport->connection)
82 _dbus_connection_remove_watch_unlocked (transport->connection,
83 socket_transport->read_watch);
84 _dbus_watch_invalidate (socket_transport->read_watch);
85 _dbus_watch_unref (socket_transport->read_watch);
86 socket_transport->read_watch = NULL;
89 if (socket_transport->write_watch)
91 if (transport->connection)
92 _dbus_connection_remove_watch_unlocked (transport->connection,
93 socket_transport->write_watch);
94 _dbus_watch_invalidate (socket_transport->write_watch);
95 _dbus_watch_unref (socket_transport->write_watch);
96 socket_transport->write_watch = NULL;
99 _dbus_verbose ("end\n");
103 socket_finalize (DBusTransport *transport)
105 DBusTransportSocket *socket_transport = (DBusTransportSocket*) transport;
107 _dbus_verbose ("\n");
109 free_watches (transport);
111 _dbus_string_free (&socket_transport->encoded_outgoing);
112 _dbus_string_free (&socket_transport->encoded_incoming);
114 _dbus_transport_finalize_base (transport);
116 _dbus_assert (socket_transport->read_watch == NULL);
117 _dbus_assert (socket_transport->write_watch == NULL);
119 dbus_free (transport);
123 check_write_watch (DBusTransport *transport)
125 DBusTransportSocket *socket_transport = (DBusTransportSocket*) transport;
128 if (transport->connection == NULL)
131 if (transport->disconnected)
133 _dbus_assert (socket_transport->write_watch == NULL);
137 _dbus_transport_ref (transport);
139 if (_dbus_transport_get_is_authenticated (transport))
140 needed = _dbus_connection_has_messages_to_send_unlocked (transport->connection);
143 if (transport->send_credentials_pending)
147 DBusAuthState auth_state;
149 auth_state = _dbus_auth_do_work (transport->auth);
151 /* If we need memory we install the write watch just in case,
152 * if there's no need for it, it will get de-installed
153 * next time we try reading.
155 if (auth_state == DBUS_AUTH_STATE_HAVE_BYTES_TO_SEND ||
156 auth_state == DBUS_AUTH_STATE_WAITING_FOR_MEMORY)
163 _dbus_verbose ("check_write_watch(): needed = %d on connection %p watch %p fd = %d outgoing messages exist %d\n",
164 needed, transport->connection, socket_transport->write_watch,
165 socket_transport->fd,
166 _dbus_connection_has_messages_to_send_unlocked (transport->connection));
168 _dbus_connection_toggle_watch_unlocked (transport->connection,
169 socket_transport->write_watch,
172 _dbus_transport_unref (transport);
176 check_read_watch (DBusTransport *transport)
178 DBusTransportSocket *socket_transport = (DBusTransportSocket*) transport;
179 dbus_bool_t need_read_watch;
181 _dbus_verbose ("fd = %d\n",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;
535 if (total > socket_transport->max_bytes_written_per_iteration)
537 _dbus_verbose ("%d bytes exceeds %d bytes written per iteration, returning\n",
538 total, socket_transport->max_bytes_written_per_iteration);
542 message = _dbus_connection_get_message_to_send (transport->connection);
543 _dbus_assert (message != NULL);
544 dbus_message_lock (message);
547 _dbus_verbose ("writing message %p\n", message);
550 _dbus_message_get_network_data (message,
553 header_len = _dbus_string_get_length (header);
554 body_len = _dbus_string_get_length (body);
556 /* fprintf (stderr, "\nheader:\n"); //todo for test - to remove together wit int i declaration above
557 for(i=0; i < header_len; i++)
559 fprintf (stderr, "%02x", _dbus_string_get_byte(header,i));
561 fprintf (stderr,"\n");
562 for(i=0; i < header_len; i++)
564 fprintf (stderr, "%c", _dbus_string_get_byte(header,i));
566 fprintf (stderr, "\nret size: %u, i: %u\n", header_len, i);
569 fprintf (stderr, "\nbody:\n");
570 for(i=0; i < body_len; i++)
572 fprintf (stderr, "%02x", _dbus_string_get_byte(body,i));
574 fprintf (stderr, "\nret size: %u, i: %u\n", body_len, i);
575 fprintf (stderr,"\n");
576 for(i=0; i < body_len; i++)
578 fprintf (stderr, "%c", _dbus_string_get_byte(body,i));
580 fprintf (stderr, "\nret size: %u, i: %u\n", body_len, i);*/
582 if (_dbus_auth_needs_encoding (transport->auth))
584 /* Does fd passing even make sense with encoded data? */
585 _dbus_assert(!DBUS_TRANSPORT_CAN_SEND_UNIX_FD(transport));
587 if (_dbus_string_get_length (&socket_transport->encoded_outgoing) == 0)
589 if (!_dbus_auth_encode_data (transport->auth,
590 header, &socket_transport->encoded_outgoing))
596 if (!_dbus_auth_encode_data (transport->auth,
597 body, &socket_transport->encoded_outgoing))
599 _dbus_string_set_length (&socket_transport->encoded_outgoing, 0);
605 total_bytes_to_write = _dbus_string_get_length (&socket_transport->encoded_outgoing);
608 _dbus_verbose ("encoded message is %d bytes\n",
609 total_bytes_to_write);
613 _dbus_write_socket (socket_transport->fd,
614 &socket_transport->encoded_outgoing,
615 socket_transport->message_bytes_written,
616 total_bytes_to_write - socket_transport->message_bytes_written);
620 total_bytes_to_write = header_len + body_len;
623 _dbus_verbose ("message is %d bytes\n",
624 total_bytes_to_write);
627 #ifdef HAVE_UNIX_FD_PASSING
628 if (socket_transport->message_bytes_written <= 0 && DBUS_TRANSPORT_CAN_SEND_UNIX_FD(transport))
630 /* Send the fds along with the first byte of the message */
634 _dbus_message_get_unix_fds(message, &unix_fds, &n);
637 _dbus_write_socket_with_unix_fds_two (socket_transport->fd,
639 socket_transport->message_bytes_written,
640 header_len - socket_transport->message_bytes_written,
646 if (bytes_written > 0 && n > 0)
647 _dbus_verbose("Wrote %i unix fds\n", n);
652 if (socket_transport->message_bytes_written < header_len)
655 _dbus_write_socket_two (socket_transport->fd,
657 socket_transport->message_bytes_written,
658 header_len - socket_transport->message_bytes_written,
665 _dbus_write_socket (socket_transport->fd,
667 (socket_transport->message_bytes_written - header_len),
669 (socket_transport->message_bytes_written - header_len));
674 if (bytes_written < 0)
676 /* EINTR already handled for us */
678 /* For some discussion of why we also ignore EPIPE here, see
679 * http://lists.freedesktop.org/archives/dbus/2008-March/009526.html
682 if (_dbus_get_is_errno_eagain_or_ewouldblock () || _dbus_get_is_errno_epipe ())
686 _dbus_verbose ("Error writing to remote app: %s\n",
687 _dbus_strerror_from_errno ());
688 do_io_error (transport);
694 _dbus_verbose (" wrote %d bytes of %d\n", bytes_written,
695 total_bytes_to_write);
697 total += bytes_written;
698 socket_transport->message_bytes_written += bytes_written;
700 _dbus_assert (socket_transport->message_bytes_written <=
701 total_bytes_to_write);
703 if (socket_transport->message_bytes_written == total_bytes_to_write)
705 socket_transport->message_bytes_written = 0;
706 _dbus_string_set_length (&socket_transport->encoded_outgoing, 0);
707 _dbus_string_compact (&socket_transport->encoded_outgoing, 2048);
709 _dbus_connection_message_sent_unlocked (transport->connection,
722 /* returns false on out-of-memory */
724 do_reading (DBusTransport *transport)
726 DBusTransportSocket *socket_transport = (DBusTransportSocket*) transport;
732 _dbus_verbose ("fd = %d\n",socket_transport->fd);
734 /* No messages without authentication! */
735 if (!_dbus_transport_get_is_authenticated (transport))
744 /* See if we've exceeded max messages and need to disable reading */
745 check_read_watch (transport);
747 if (total > socket_transport->max_bytes_read_per_iteration)
749 _dbus_verbose ("%d bytes exceeds %d bytes read per iteration, returning\n",
750 total, socket_transport->max_bytes_read_per_iteration);
754 _dbus_assert (socket_transport->read_watch != NULL ||
755 transport->disconnected);
757 if (transport->disconnected)
760 if (!dbus_watch_get_enabled (socket_transport->read_watch))
763 if (_dbus_auth_needs_decoding (transport->auth))
765 /* Does fd passing even make sense with encoded data? */
766 _dbus_assert(!DBUS_TRANSPORT_CAN_SEND_UNIX_FD(transport));
768 if (_dbus_string_get_length (&socket_transport->encoded_incoming) > 0)
769 bytes_read = _dbus_string_get_length (&socket_transport->encoded_incoming);
771 bytes_read = _dbus_read_socket (socket_transport->fd,
772 &socket_transport->encoded_incoming,
773 socket_transport->max_bytes_read_per_iteration);
775 _dbus_assert (_dbus_string_get_length (&socket_transport->encoded_incoming) ==
782 _dbus_message_loader_get_buffer (transport->loader,
785 orig_len = _dbus_string_get_length (buffer);
787 if (!_dbus_auth_decode_data (transport->auth,
788 &socket_transport->encoded_incoming,
791 _dbus_verbose ("Out of memory decoding incoming data\n");
792 _dbus_message_loader_return_buffer (transport->loader,
794 _dbus_string_get_length (buffer) - orig_len);
800 _dbus_message_loader_return_buffer (transport->loader,
802 _dbus_string_get_length (buffer) - orig_len);
804 _dbus_string_set_length (&socket_transport->encoded_incoming, 0);
805 _dbus_string_compact (&socket_transport->encoded_incoming, 2048);
810 _dbus_message_loader_get_buffer (transport->loader,
813 #ifdef HAVE_UNIX_FD_PASSING
814 if (DBUS_TRANSPORT_CAN_SEND_UNIX_FD(transport))
818 if (!_dbus_message_loader_get_unix_fds(transport->loader, &fds, &n_fds))
820 _dbus_verbose ("Out of memory reading file descriptors\n");
821 _dbus_message_loader_return_buffer (transport->loader, buffer, 0);
826 bytes_read = _dbus_read_socket_with_unix_fds(socket_transport->fd,
828 socket_transport->max_bytes_read_per_iteration,
831 if (bytes_read >= 0 && n_fds > 0)
832 _dbus_verbose("Read %i unix fds\n", n_fds);
834 _dbus_message_loader_return_unix_fds(transport->loader, fds, bytes_read < 0 ? 0 : n_fds);
839 bytes_read = _dbus_read_socket (socket_transport->fd,
840 buffer, socket_transport->max_bytes_read_per_iteration);
843 _dbus_message_loader_return_buffer (transport->loader,
845 bytes_read < 0 ? 0 : bytes_read);
850 /* EINTR already handled for us */
852 if (_dbus_get_is_errno_enomem ())
854 _dbus_verbose ("Out of memory in read()/do_reading()\n");
858 else if (_dbus_get_is_errno_eagain_or_ewouldblock ())
862 _dbus_verbose ("Error reading from remote app: %s\n",
863 _dbus_strerror_from_errno ());
864 do_io_error (transport);
868 else if (bytes_read == 0)
870 _dbus_verbose ("Disconnected from remote app\n");
871 do_io_error (transport);
876 _dbus_verbose (" read %d bytes\n", bytes_read);
880 if (!_dbus_transport_queue_messages (transport))
883 _dbus_verbose (" out of memory when queueing messages we just read in the transport\n");
887 /* Try reading more data until we get EAGAIN and return, or
888 * exceed max bytes per iteration. If in blocking mode of
889 * course we'll block instead of returning.
902 unix_error_with_read_to_come (DBusTransport *itransport,
906 DBusTransportSocket *transport = (DBusTransportSocket *) itransport;
908 if (!(flags & DBUS_WATCH_HANGUP || flags & DBUS_WATCH_ERROR))
911 /* If we have a read watch enabled ...
912 we -might have data incoming ... => handle the HANGUP there */
913 if (watch != transport->read_watch &&
914 _dbus_watch_get_enabled (transport->read_watch))
921 socket_handle_watch (DBusTransport *transport,
925 DBusTransportSocket *socket_transport = (DBusTransportSocket*) transport;
927 _dbus_assert (watch == socket_transport->read_watch ||
928 watch == socket_transport->write_watch);
929 _dbus_assert (watch != NULL);
931 /* If we hit an error here on a write watch, don't disconnect the transport yet because data can
932 * still be in the buffer and do_reading may need several iteration to read
933 * it all (because of its max_bytes_read_per_iteration limit).
935 if (!(flags & DBUS_WATCH_READABLE) && unix_error_with_read_to_come (transport, watch, flags))
937 _dbus_verbose ("Hang up or error on watch\n");
938 _dbus_transport_disconnect (transport);
942 if (watch == socket_transport->read_watch &&
943 (flags & DBUS_WATCH_READABLE))
945 dbus_bool_t auth_finished;
947 _dbus_verbose ("handling read watch %p flags = %x\n",
950 if (!do_authentication (transport, TRUE, FALSE, &auth_finished))
953 /* We don't want to do a read immediately following
954 * a successful authentication. This is so we
955 * have a chance to propagate the authentication
956 * state further up. Specifically, we need to
957 * process any pending data from the auth object.
961 if (!do_reading (transport))
963 _dbus_verbose ("no memory to read\n");
969 _dbus_verbose ("Not reading anything since we just completed the authentication\n");
972 else if (watch == socket_transport->write_watch &&
973 (flags & DBUS_WATCH_WRITABLE))
976 _dbus_verbose ("handling write watch, have_outgoing_messages = %d\n",
977 _dbus_connection_has_messages_to_send_unlocked (transport->connection));
979 if (!do_authentication (transport, FALSE, TRUE, NULL))
982 if (!do_writing (transport))
984 _dbus_verbose ("no memory to write\n");
988 /* See if we still need the write watch */
989 check_write_watch (transport);
991 #ifdef DBUS_ENABLE_VERBOSE_MODE
994 if (watch == socket_transport->read_watch)
995 _dbus_verbose ("asked to handle read watch with non-read condition 0x%x\n",
997 else if (watch == socket_transport->write_watch)
998 _dbus_verbose ("asked to handle write watch with non-write condition 0x%x\n",
1001 _dbus_verbose ("asked to handle watch %p on fd %d that we don't recognize\n",
1002 watch, dbus_watch_get_socket (watch));
1004 #endif /* DBUS_ENABLE_VERBOSE_MODE */
1010 socket_disconnect (DBusTransport *transport)
1012 DBusTransportSocket *socket_transport = (DBusTransportSocket*) transport;
1014 _dbus_verbose ("\n");
1016 free_watches (transport);
1018 _dbus_close_socket (socket_transport->fd, NULL);
1019 socket_transport->fd = -1;
1023 socket_connection_set (DBusTransport *transport)
1025 DBusTransportSocket *socket_transport = (DBusTransportSocket*) transport;
1027 _dbus_watch_set_handler (socket_transport->write_watch,
1028 _dbus_connection_handle_watch,
1029 transport->connection, NULL);
1031 _dbus_watch_set_handler (socket_transport->read_watch,
1032 _dbus_connection_handle_watch,
1033 transport->connection, NULL);
1035 if (!_dbus_connection_add_watch_unlocked (transport->connection,
1036 socket_transport->write_watch))
1039 if (!_dbus_connection_add_watch_unlocked (transport->connection,
1040 socket_transport->read_watch))
1042 _dbus_connection_remove_watch_unlocked (transport->connection,
1043 socket_transport->write_watch);
1047 check_read_watch (transport);
1048 check_write_watch (transport);
1054 * @todo We need to have a way to wake up the select sleep if
1055 * a new iteration request comes in with a flag (read/write) that
1056 * we're not currently serving. Otherwise a call that just reads
1057 * could block a write call forever (if there are no incoming
1061 socket_do_iteration (DBusTransport *transport,
1063 int timeout_milliseconds)
1065 DBusTransportSocket *socket_transport = (DBusTransportSocket*) transport;
1070 _dbus_verbose (" iteration flags = %s%s timeout = %d read_watch = %p write_watch = %p fd = %d\n",
1071 flags & DBUS_ITERATION_DO_READING ? "read" : "",
1072 flags & DBUS_ITERATION_DO_WRITING ? "write" : "",
1073 timeout_milliseconds,
1074 socket_transport->read_watch,
1075 socket_transport->write_watch,
1076 socket_transport->fd);
1078 /* the passed in DO_READING/DO_WRITING flags indicate whether to
1079 * read/write messages, but regardless of those we may need to block
1080 * for reading/writing to do auth. But if we do reading for auth,
1081 * we don't want to read any messages yet if not given DO_READING.
1084 poll_fd.fd = socket_transport->fd;
1087 if (_dbus_transport_get_is_authenticated (transport))
1089 /* This is kind of a hack; if we have stuff to write, then try
1090 * to avoid the poll. This is probably about a 5% speedup on an
1091 * echo client/server.
1093 * If both reading and writing were requested, we want to avoid this
1094 * since it could have funky effects:
1095 * - both ends spinning waiting for the other one to read
1096 * data so they can finish writing
1097 * - prioritizing all writing ahead of reading
1099 if ((flags & DBUS_ITERATION_DO_WRITING) &&
1100 !(flags & (DBUS_ITERATION_DO_READING | DBUS_ITERATION_BLOCK)) &&
1101 !transport->disconnected &&
1102 _dbus_connection_has_messages_to_send_unlocked (transport->connection))
1104 do_writing (transport);
1106 if (transport->disconnected ||
1107 !_dbus_connection_has_messages_to_send_unlocked (transport->connection))
1111 /* If we get here, we decided to do the poll() after all */
1112 _dbus_assert (socket_transport->read_watch);
1113 if (flags & DBUS_ITERATION_DO_READING)
1114 poll_fd.events |= _DBUS_POLLIN;
1116 _dbus_assert (socket_transport->write_watch);
1117 if (flags & DBUS_ITERATION_DO_WRITING)
1118 poll_fd.events |= _DBUS_POLLOUT;
1122 DBusAuthState auth_state;
1124 auth_state = _dbus_auth_do_work (transport->auth);
1126 if (transport->receive_credentials_pending ||
1127 auth_state == DBUS_AUTH_STATE_WAITING_FOR_INPUT)
1128 poll_fd.events |= _DBUS_POLLIN;
1130 if (transport->send_credentials_pending ||
1131 auth_state == DBUS_AUTH_STATE_HAVE_BYTES_TO_SEND)
1132 poll_fd.events |= _DBUS_POLLOUT;
1137 if (flags & DBUS_ITERATION_BLOCK)
1138 poll_timeout = timeout_milliseconds;
1142 /* For blocking selects we drop the connection lock here
1143 * to avoid blocking out connection access during a potentially
1144 * indefinite blocking call. The io path is still protected
1145 * by the io_path_cond condvar, so we won't reenter this.
1147 if (flags & DBUS_ITERATION_BLOCK)
1149 _dbus_verbose ("unlock pre poll\n");
1150 _dbus_connection_unlock (transport->connection);
1154 poll_res = _dbus_poll (&poll_fd, 1, poll_timeout);
1156 if (poll_res < 0 && _dbus_get_is_errno_eintr ())
1159 if (flags & DBUS_ITERATION_BLOCK)
1161 _dbus_verbose ("lock post poll\n");
1162 _dbus_connection_lock (transport->connection);
1168 poll_fd.revents = 0; /* some concern that posix does not guarantee this;
1169 * valgrind flags it as an error. though it probably
1170 * is guaranteed on linux at least.
1173 if (poll_fd.revents & _DBUS_POLLERR)
1174 do_io_error (transport);
1177 dbus_bool_t need_read = (poll_fd.revents & _DBUS_POLLIN) > 0;
1178 dbus_bool_t need_write = (poll_fd.revents & _DBUS_POLLOUT) > 0;
1179 dbus_bool_t authentication_completed;
1181 _dbus_verbose ("in iteration, need_read=%d need_write=%d\n",
1182 need_read, need_write);
1183 do_authentication (transport, need_read, need_write,
1184 &authentication_completed);
1186 /* See comment in socket_handle_watch. */
1187 if (authentication_completed)
1190 if (need_read && (flags & DBUS_ITERATION_DO_READING))
1191 do_reading (transport);
1192 if (need_write && (flags & DBUS_ITERATION_DO_WRITING))
1193 do_writing (transport);
1198 _dbus_verbose ("Error from _dbus_poll(): %s\n",
1199 _dbus_strerror_from_errno ());
1205 /* We need to install the write watch only if we did not
1206 * successfully write everything. Note we need to be careful that we
1207 * don't call check_write_watch *before* do_writing, since it's
1208 * inefficient to add the write watch, and we can avoid it most of
1209 * the time since we can write immediately.
1211 * However, we MUST always call check_write_watch(); DBusConnection code
1212 * relies on the fact that running an iteration will notice that
1213 * messages are pending.
1215 check_write_watch (transport);
1217 _dbus_verbose (" ... leaving do_iteration()\n");
1221 socket_live_messages_changed (DBusTransport *transport)
1223 /* See if we should look for incoming messages again */
1224 check_read_watch (transport);
1229 socket_get_socket_fd (DBusTransport *transport,
1232 DBusTransportSocket *socket_transport = (DBusTransportSocket*) transport;
1234 *fd_p = socket_transport->fd;
1239 static const DBusTransportVTable socket_vtable = {
1241 socket_handle_watch,
1243 socket_connection_set,
1244 socket_do_iteration,
1245 socket_live_messages_changed,
1246 socket_get_socket_fd
1250 * Creates a new transport for the given socket file descriptor. The file
1251 * descriptor must be nonblocking (use _dbus_set_fd_nonblocking() to
1252 * make it so). This function is shared by various transports that
1253 * boil down to a full duplex file descriptor.
1255 * @param fd the file descriptor.
1256 * @param server_guid non-#NULL if this transport is on the server side of a connection
1257 * @param address the transport's address
1258 * @returns the new transport, or #NULL if no memory.
1261 _dbus_transport_new_for_socket (int fd,
1262 const DBusString *server_guid,
1263 const DBusString *address)
1265 DBusTransportSocket *socket_transport;
1267 socket_transport = dbus_new0 (DBusTransportSocket, 1);
1268 if (socket_transport == NULL)
1271 if (!_dbus_string_init (&socket_transport->encoded_outgoing))
1274 if (!_dbus_string_init (&socket_transport->encoded_incoming))
1277 socket_transport->write_watch = _dbus_watch_new (fd,
1278 DBUS_WATCH_WRITABLE,
1281 if (socket_transport->write_watch == NULL)
1284 socket_transport->read_watch = _dbus_watch_new (fd,
1285 DBUS_WATCH_READABLE,
1288 if (socket_transport->read_watch == NULL)
1291 if (!_dbus_transport_init_base (&socket_transport->base,
1293 server_guid, address))
1296 #ifdef HAVE_UNIX_FD_PASSING
1297 _dbus_auth_set_unix_fd_possible(socket_transport->base.auth, _dbus_socket_can_pass_unix_fd(fd));
1300 socket_transport->fd = fd;
1301 socket_transport->message_bytes_written = 0;
1303 /* These values should probably be tunable or something. */
1304 socket_transport->max_bytes_read_per_iteration = 2048;
1305 socket_transport->max_bytes_written_per_iteration = 2048;
1307 return (DBusTransport*) socket_transport;
1310 _dbus_watch_invalidate (socket_transport->read_watch);
1311 _dbus_watch_unref (socket_transport->read_watch);
1313 _dbus_watch_invalidate (socket_transport->write_watch);
1314 _dbus_watch_unref (socket_transport->write_watch);
1316 _dbus_string_free (&socket_transport->encoded_incoming);
1318 _dbus_string_free (&socket_transport->encoded_outgoing);
1320 dbus_free (socket_transport);
1325 * Creates a new transport for the given hostname and port.
1326 * If host is NULL, it will default to localhost
1328 * @param host the host to connect to
1329 * @param port the port to connect to
1330 * @param family the address family to connect to
1331 * @param path to nonce file
1332 * @param error location to store reason for failure.
1333 * @returns a new transport, or #NULL on failure.
1336 _dbus_transport_new_for_tcp_socket (const char *host,
1339 const char *noncefile,
1343 DBusTransport *transport;
1346 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1348 if (!_dbus_string_init (&address))
1350 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1357 if (!_dbus_string_append (&address, noncefile ? "nonce-tcp:" : "tcp:"))
1360 if (!_dbus_string_append (&address, "host=") ||
1361 !_dbus_string_append (&address, host))
1364 if (!_dbus_string_append (&address, ",port=") ||
1365 !_dbus_string_append (&address, port))
1368 if (family != NULL &&
1369 (!_dbus_string_append (&address, ",family=") ||
1370 !_dbus_string_append (&address, family)))
1373 if (noncefile != NULL &&
1374 (!_dbus_string_append (&address, ",noncefile=") ||
1375 !_dbus_string_append (&address, noncefile)))
1378 fd = _dbus_connect_tcp_socket_with_nonce (host, port, family, noncefile, error);
1381 _DBUS_ASSERT_ERROR_IS_SET (error);
1382 _dbus_string_free (&address);
1386 _dbus_verbose ("Successfully connected to tcp socket %s:%s\n",
1389 transport = _dbus_transport_new_for_socket (fd, NULL, &address);
1390 _dbus_string_free (&address);
1391 if (transport == NULL)
1393 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1394 _dbus_close_socket (fd, NULL);
1401 _dbus_string_free (&address);
1402 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1407 * Opens a TCP socket transport.
1409 * @param entry the address entry to try opening as a tcp transport.
1410 * @param transport_p return location for the opened transport
1411 * @param error error to be set
1412 * @returns result of the attempt
1414 DBusTransportOpenResult
1415 _dbus_transport_open_socket(DBusAddressEntry *entry,
1416 DBusTransport **transport_p,
1421 dbus_bool_t isNonceTcp;
1423 method = dbus_address_entry_get_method (entry);
1424 _dbus_assert (method != NULL);
1426 isTcp = strcmp (method, "tcp") == 0;
1427 isNonceTcp = strcmp (method, "nonce-tcp") == 0;
1429 if (isTcp || isNonceTcp)
1431 const char *host = dbus_address_entry_get_value (entry, "host");
1432 const char *port = dbus_address_entry_get_value (entry, "port");
1433 const char *family = dbus_address_entry_get_value (entry, "family");
1434 const char *noncefile = dbus_address_entry_get_value (entry, "noncefile");
1436 if ((isNonceTcp == TRUE) != (noncefile != NULL)) {
1437 _dbus_set_bad_address (error, method, "noncefile", NULL);
1438 return DBUS_TRANSPORT_OPEN_BAD_ADDRESS;
1443 _dbus_set_bad_address (error, method, "port", NULL);
1444 return DBUS_TRANSPORT_OPEN_BAD_ADDRESS;
1447 *transport_p = _dbus_transport_new_for_tcp_socket (host, port, family, noncefile, error);
1448 if (*transport_p == NULL)
1450 _DBUS_ASSERT_ERROR_IS_SET (error);
1451 return DBUS_TRANSPORT_OPEN_DID_NOT_CONNECT;
1455 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1456 return DBUS_TRANSPORT_OPEN_OK;
1461 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1462 return DBUS_TRANSPORT_OPEN_NOT_HANDLED;