D-Bus 1.10.18

dbus-transport-socket.c
1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2 /* dbus-transport-socket.c Socket subclasses of DBusTransport
3 *
4 * Copyright (C) 2002, 2003, 2004, 2006 Red Hat Inc.
5 *
6 * Licensed under the Academic Free License version 2.1
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 *
22 */
23
24 #include <config.h>
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
44 typedef struct DBusTransportSocket DBusTransportSocket;
45
49 struct DBusTransportSocket
50 {
51 DBusTransport base;
52 DBusSocket fd;
53 DBusWatch *read_watch;
54 DBusWatch *write_watch;
56 int max_bytes_read_per_iteration;
57 int max_bytes_written_per_iteration;
59 int message_bytes_written;
63 DBusString encoded_outgoing;
66 DBusString encoded_incoming;
69 };
70
71 static void
72 free_watches (DBusTransport *transport)
73 {
74 DBusTransportSocket *socket_transport = (DBusTransportSocket*) transport;
75
76 _dbus_verbose ("start\n");
77
78 if (socket_transport->read_watch)
79 {
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;
86 }
87
88 if (socket_transport->write_watch)
89 {
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;
96 }
97
98 _dbus_verbose ("end\n");
99 }
100
101 static void
102 socket_finalize (DBusTransport *transport)
103 {
104 DBusTransportSocket *socket_transport = (DBusTransportSocket*) transport;
105
106 _dbus_verbose ("\n");
107
108 free_watches (transport);
109
110 _dbus_string_free (&socket_transport->encoded_outgoing);
111 _dbus_string_free (&socket_transport->encoded_incoming);
112
113 _dbus_transport_finalize_base (transport);
114
115 _dbus_assert (socket_transport->read_watch == NULL);
116 _dbus_assert (socket_transport->write_watch == NULL);
117
118 dbus_free (transport);
119 }
120
121 static void
122 check_write_watch (DBusTransport *transport)
123 {
124 DBusTransportSocket *socket_transport = (DBusTransportSocket*) transport;
125 dbus_bool_t needed;
126
127 if (transport->connection == NULL)
128 return;
129
130 if (transport->disconnected)
131 {
132 _dbus_assert (socket_transport->write_watch == NULL);
133 return;
134 }
135
136 _dbus_transport_ref (transport);
137
138 if (_dbus_transport_try_to_authenticate (transport))
139 needed = _dbus_connection_has_messages_to_send_unlocked (transport->connection);
140 else
141 {
142 if (transport->send_credentials_pending)
143 needed = TRUE;
144 else
145 {
146 DBusAuthState auth_state;
147
148 auth_state = _dbus_auth_do_work (transport->auth);
149
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.
153 */
154 if (auth_state == DBUS_AUTH_STATE_HAVE_BYTES_TO_SEND ||
155 auth_state == DBUS_AUTH_STATE_WAITING_FOR_MEMORY)
156 needed = TRUE;
157 else
158 needed = FALSE;
159 }
160 }
161
162 _dbus_verbose ("check_write_watch(): needed = %d on connection %p watch %p fd = %" DBUS_SOCKET_FORMAT " outgoing messages exist %d\n",
163 needed, transport->connection, socket_transport->write_watch,
164 _dbus_socket_printable (socket_transport->fd),
165 _dbus_connection_has_messages_to_send_unlocked (transport->connection));
166
167 _dbus_connection_toggle_watch_unlocked (transport->connection,
168 socket_transport->write_watch,
169 needed);
170
171 _dbus_transport_unref (transport);
172 }
173
174 static void
175 check_read_watch (DBusTransport *transport)
176 {
177 DBusTransportSocket *socket_transport = (DBusTransportSocket*) transport;
178 dbus_bool_t need_read_watch;
179
180 _dbus_verbose ("fd = %" DBUS_SOCKET_FORMAT "\n",
181 _dbus_socket_printable (socket_transport->fd));
182
183 if (transport->connection == NULL)
184 return;
185
186 if (transport->disconnected)
187 {
188 _dbus_assert (socket_transport->read_watch == NULL);
189 return;
190 }
191
192 _dbus_transport_ref (transport);
193
194 if (_dbus_transport_try_to_authenticate (transport))
195 need_read_watch =
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);
198 else
199 {
200 if (transport->receive_credentials_pending)
201 need_read_watch = TRUE;
202 else
203 {
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
207 */
208 DBusAuthState auth_state;
209
210 auth_state = _dbus_auth_do_work (transport->auth);
211
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
216 * authenticated.
217 */
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;
222 else
223 need_read_watch = FALSE;
224 }
225 }
226
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,
230 need_read_watch);
231
232 _dbus_transport_unref (transport);
233 }
234
235 static void
236 do_io_error (DBusTransport *transport)
237 {
238 _dbus_transport_ref (transport);
239 _dbus_transport_disconnect (transport);
240 _dbus_transport_unref (transport);
241 }
242
243 /* return value is whether we successfully read any new data. */
244 static dbus_bool_t
245 read_data_into_auth (DBusTransport *transport,
246 dbus_bool_t *oom)
247 {
248 DBusTransportSocket *socket_transport = (DBusTransportSocket*) transport;
249 DBusString *buffer;
250 int bytes_read;
251 int saved_errno;
252
253 *oom = FALSE;
254
255 _dbus_auth_get_buffer (transport->auth, &buffer);
256
257 bytes_read = _dbus_read_socket (socket_transport->fd,
258 buffer, socket_transport->max_bytes_read_per_iteration);
259 saved_errno = _dbus_save_socket_errno ();
260
261 _dbus_auth_return_buffer (transport->auth, buffer);
262
263 if (bytes_read > 0)
264 {
265 _dbus_verbose (" read %d bytes in auth phase\n", bytes_read);
266
267 return TRUE;
268 }
269 else if (bytes_read < 0)
270 {
271 /* EINTR already handled for us */
272
273 if (_dbus_get_is_errno_enomem (saved_errno))
274 {
275 *oom = TRUE;
276 }
277 else if (_dbus_get_is_errno_eagain_or_ewouldblock (saved_errno))
278 ; /* do nothing, just return FALSE below */
279 else
280 {
281 _dbus_verbose ("Error reading from remote app: %s\n",
282 _dbus_strerror (saved_errno));
283 do_io_error (transport);
284 }
285
286 return FALSE;
287 }
288 else
289 {
290 _dbus_assert (bytes_read == 0);
291
292 _dbus_verbose ("Disconnected from remote app\n");
293 do_io_error (transport);
294
295 return FALSE;
296 }
297 }
298
299 /* Return value is whether we successfully wrote any bytes */
300 static dbus_bool_t
301 write_data_from_auth (DBusTransport *transport)
302 {
303 DBusTransportSocket *socket_transport = (DBusTransportSocket*) transport;
304 int bytes_written;
305 int saved_errno;
306 const DBusString *buffer;
307
308 if (!_dbus_auth_get_bytes_to_send (transport->auth,
309 &buffer))
310 return FALSE;
311
312 bytes_written = _dbus_write_socket (socket_transport->fd,
313 buffer,
314 0, _dbus_string_get_length (buffer));
315 saved_errno = _dbus_save_socket_errno ();
316
317 if (bytes_written > 0)
318 {
319 _dbus_auth_bytes_sent (transport->auth, bytes_written);
320 return TRUE;
321 }
322 else if (bytes_written < 0)
323 {
324 /* EINTR already handled for us */
325
326 if (_dbus_get_is_errno_eagain_or_ewouldblock (saved_errno))
327 ;
328 else
329 {
330 _dbus_verbose ("Error writing to remote app: %s\n",
331 _dbus_strerror (saved_errno));
332 do_io_error (transport);
333 }
334 }
335
336 return FALSE;
337 }
338
339 /* FALSE on OOM */
340 static dbus_bool_t
341 exchange_credentials (DBusTransport *transport,
342 dbus_bool_t do_reading,
343 dbus_bool_t do_writing)
344 {
345 DBusTransportSocket *socket_transport = (DBusTransportSocket*) transport;
346 DBusError error = DBUS_ERROR_INIT;
347
348 _dbus_verbose ("exchange_credentials: do_reading = %d, do_writing = %d\n",
349 do_reading, do_writing);
350
351 if (do_writing && transport->send_credentials_pending)
352 {
353 if (_dbus_send_credentials_socket (socket_transport->fd,
354 &error))
355 {
356 transport->send_credentials_pending = FALSE;
357 }
358 else
359 {
360 _dbus_verbose ("Failed to write credentials: %s\n", error.message);
361 dbus_error_free (&error);
362 do_io_error (transport);
363 }
364 }
365
366 if (do_reading && transport->receive_credentials_pending)
367 {
368 /* FIXME this can fail due to IO error _or_ OOM, broken
369 * (somewhat tricky to fix since the OOM error can be set after
370 * we already read the credentials byte, so basically we need to
371 * separate reading the byte and storing it in the
372 * transport->credentials). Does not really matter for now
373 * because storing in credentials never actually fails on unix.
374 */
375 if (_dbus_read_credentials_socket (socket_transport->fd,
376 transport->credentials,
377 &error))
378 {
379 transport->receive_credentials_pending = FALSE;
380 }
381 else
382 {
383 _dbus_verbose ("Failed to read credentials %s\n", error.message);
384 dbus_error_free (&error);
385 do_io_error (transport);
386 }
387 }
388
389 if (!(transport->send_credentials_pending ||
390 transport->receive_credentials_pending))
391 {
392 if (!_dbus_auth_set_credentials (transport->auth,
393 transport->credentials))
394 return FALSE;
395 }
396
397 return TRUE;
398 }
399
400 static dbus_bool_t
401 do_authentication (DBusTransport *transport,
402 dbus_bool_t do_reading,
403 dbus_bool_t do_writing,
404 dbus_bool_t *auth_completed)
405 {
406 dbus_bool_t oom;
407 dbus_bool_t orig_auth_state;
408
409 oom = FALSE;
410
411 orig_auth_state = _dbus_transport_try_to_authenticate (transport);
412
413 /* This is essential to avoid the check_write_watch() at the end,
414 * we don't want to add a write watch in do_iteration before
415 * we try writing and get EAGAIN
416 */
417 if (orig_auth_state)
418 {
419 if (auth_completed)
420 *auth_completed = FALSE;
421 return TRUE;
422 }
423
424 _dbus_transport_ref (transport);
425
426 while (!_dbus_transport_try_to_authenticate (transport) &&
427 _dbus_transport_get_is_connected (transport))
428 {
429 if (!exchange_credentials (transport, do_reading, do_writing))
430 {
431 /* OOM */
432 oom = TRUE;
433 goto out;
434 }
435
436 if (transport->send_credentials_pending ||
437 transport->receive_credentials_pending)
438 {
439 _dbus_verbose ("send_credentials_pending = %d receive_credentials_pending = %d\n",
440 transport->send_credentials_pending,
441 transport->receive_credentials_pending);
442 goto out;
443 }
444
445 #define TRANSPORT_SIDE(t) ((t)->is_server ? "server" : "client")
446 switch (_dbus_auth_do_work (transport->auth))
447 {
448 case DBUS_AUTH_STATE_WAITING_FOR_INPUT:
449 _dbus_verbose (" %s auth state: waiting for input\n",
450 TRANSPORT_SIDE (transport));
451 if (!do_reading || !read_data_into_auth (transport, &oom))
452 goto out;
453 break;
454
455 case DBUS_AUTH_STATE_WAITING_FOR_MEMORY:
456 _dbus_verbose (" %s auth state: waiting for memory\n",
457 TRANSPORT_SIDE (transport));
458 oom = TRUE;
459 goto out;
460 break;
461
462 case DBUS_AUTH_STATE_HAVE_BYTES_TO_SEND:
463 _dbus_verbose (" %s auth state: bytes to send\n",
464 TRANSPORT_SIDE (transport));
465 if (!do_writing || !write_data_from_auth (transport))
466 goto out;
467 break;
468
469 case DBUS_AUTH_STATE_NEED_DISCONNECT:
470 _dbus_verbose (" %s auth state: need to disconnect\n",
471 TRANSPORT_SIDE (transport));
472 do_io_error (transport);
473 break;
474
475 case DBUS_AUTH_STATE_AUTHENTICATED:
476 _dbus_verbose (" %s auth state: authenticated\n",
477 TRANSPORT_SIDE (transport));
478 break;
479 }
480 }
481
482 out:
483 if (auth_completed)
484 *auth_completed = (orig_auth_state != _dbus_transport_try_to_authenticate (transport));
485
486 check_read_watch (transport);
487 check_write_watch (transport);
488 _dbus_transport_unref (transport);
489
490 if (oom)
491 return FALSE;
492 else
493 return TRUE;
494 }
495
496 /* returns false on oom */
497 static dbus_bool_t
498 do_writing (DBusTransport *transport)
499 {
500 int total;
501 DBusTransportSocket *socket_transport = (DBusTransportSocket*) transport;
502 dbus_bool_t oom;
503
504 /* No messages without authentication! */
505 if (!_dbus_transport_try_to_authenticate (transport))
506 {
507 _dbus_verbose ("Not authenticated, not writing anything\n");
508 return TRUE;
509 }
510
511 if (transport->disconnected)
512 {
513 _dbus_verbose ("Not connected, not writing anything\n");
514 return TRUE;
515 }
516
517 #if 1
518 _dbus_verbose ("do_writing(), have_messages = %d, fd = %" DBUS_SOCKET_FORMAT "\n",
519 _dbus_connection_has_messages_to_send_unlocked (transport->connection),
520 _dbus_socket_printable (socket_transport->fd));
521 #endif
522
523 oom = FALSE;
524 total = 0;
525
526 while (!transport->disconnected &&
527 _dbus_connection_has_messages_to_send_unlocked (transport->connection))
528 {
529 int bytes_written;
530 DBusMessage *message;
531 const DBusString *header;
532 const DBusString *body;
533 int header_len, body_len;
534 int total_bytes_to_write;
535 int saved_errno;
536
537 if (total > socket_transport->max_bytes_written_per_iteration)
538 {
539 _dbus_verbose ("%d bytes exceeds %d bytes written per iteration, returning\n",
540 total, socket_transport->max_bytes_written_per_iteration);
541 goto out;
542 }
543
544 message = _dbus_connection_get_message_to_send (transport->connection);
545 _dbus_assert (message != NULL);
546 dbus_message_lock (message);
547
548 #if 0
549 _dbus_verbose ("writing message %p\n", message);
550 #endif
551
552 _dbus_message_get_network_data (message,
553 &header, &body);
554
555 header_len = _dbus_string_get_length (header);
556 body_len = _dbus_string_get_length (body);
557
558 if (_dbus_auth_needs_encoding (transport->auth))
559 {
560 /* Does fd passing even make sense with encoded data? */
561 _dbus_assert(!DBUS_TRANSPORT_CAN_SEND_UNIX_FD(transport));
562
563 if (_dbus_string_get_length (&socket_transport->encoded_outgoing) == 0)
564 {
565 if (!_dbus_auth_encode_data (transport->auth,
566 header, &socket_transport->encoded_outgoing))
567 {
568 oom = TRUE;
569 goto out;
570 }
571
572 if (!_dbus_auth_encode_data (transport->auth,
573 body, &socket_transport->encoded_outgoing))
574 {
575 _dbus_string_set_length (&socket_transport->encoded_outgoing, 0);
576 oom = TRUE;
577 goto out;
578 }
579 }
580
581 total_bytes_to_write = _dbus_string_get_length (&socket_transport->encoded_outgoing);
582
583 #if 0
584 _dbus_verbose ("encoded message is %d bytes\n",
585 total_bytes_to_write);
586 #endif
587
588 bytes_written =
589 _dbus_write_socket (socket_transport->fd,
590 &socket_transport->encoded_outgoing,
591 socket_transport->message_bytes_written,
592 total_bytes_to_write - socket_transport->message_bytes_written);
593 saved_errno = _dbus_save_socket_errno ();
594 }
595 else
596 {
597 total_bytes_to_write = header_len + body_len;
598
599 #if 0
600 _dbus_verbose ("message is %d bytes\n",
601 total_bytes_to_write);
602 #endif
603
604 #ifdef HAVE_UNIX_FD_PASSING
605 if (socket_transport->message_bytes_written <= 0 && DBUS_TRANSPORT_CAN_SEND_UNIX_FD(transport))
606 {
607 /* Send the fds along with the first byte of the message */
608 const int *unix_fds;
609 unsigned n;
610
611 _dbus_message_get_unix_fds(message, &unix_fds, &n);
612
613 bytes_written =
614 _dbus_write_socket_with_unix_fds_two (socket_transport->fd,
615 header,
616 socket_transport->message_bytes_written,
617 header_len - socket_transport->message_bytes_written,
618 body,
619 0, body_len,
620 unix_fds,
621 n);
622 saved_errno = _dbus_save_socket_errno ();
623
624 if (bytes_written > 0 && n > 0)
625 _dbus_verbose("Wrote %i unix fds\n", n);
626 }
627 else
628 #endif
629 {
630 if (socket_transport->message_bytes_written < header_len)
631 {
632 bytes_written =
633 _dbus_write_socket_two (socket_transport->fd,
634 header,
635 socket_transport->message_bytes_written,
636 header_len - socket_transport->message_bytes_written,
637 body,
638 0, body_len);
639 }
640 else
641 {
642 bytes_written =
643 _dbus_write_socket (socket_transport->fd,
644 body,
645 (socket_transport->message_bytes_written - header_len),
646 body_len -
647 (socket_transport->message_bytes_written - header_len));
648 }
649
650 saved_errno = _dbus_save_socket_errno ();
651 }
652 }
653
654 if (bytes_written < 0)
655 {
656 /* EINTR already handled for us */
657
658 /* If the other end closed the socket with close() or shutdown(), we
659 * receive EPIPE here but we must not close the socket yet: there
660 * might still be some data to read. See:
661 * http://lists.freedesktop.org/archives/dbus/2008-March/009526.html
662 */
663
664 if (_dbus_get_is_errno_eagain_or_ewouldblock (saved_errno) || _dbus_get_is_errno_epipe (saved_errno))
665 goto out;
666
667 /* Since Linux commit 25888e (from 2.6.37-rc4, Nov 2010), sendmsg()
668 * on Unix sockets returns -1 errno=ETOOMANYREFS when the passfd
669 * mechanism (SCM_RIGHTS) is used recursively with a recursion level
670 * of maximum 4. The kernel does not have an API to check whether
671 * the passed fds can be forwarded and it can change asynchronously.
672 * See:
673 * https://bugs.freedesktop.org/show_bug.cgi?id=80163
674 */
675
676 else if (_dbus_get_is_errno_etoomanyrefs (saved_errno))
677 {
678 /* We only send fds in the first byte of the message.
679 * ETOOMANYREFS cannot happen after.
680 */
681 _dbus_assert (socket_transport->message_bytes_written == 0);
682
683 _dbus_verbose (" discard message of %d bytes due to ETOOMANYREFS\n",
684 total_bytes_to_write);
685
686 socket_transport->message_bytes_written = 0;
687 _dbus_string_set_length (&socket_transport->encoded_outgoing, 0);
688 _dbus_string_compact (&socket_transport->encoded_outgoing, 2048);
689
690 /* The message was not actually sent but it needs to be removed
691 * from the outgoing queue
692 */
693 _dbus_connection_message_sent_unlocked (transport->connection,
694 message);
695 }
696 else
697 {
698 _dbus_verbose ("Error writing to remote app: %s\n",
699 _dbus_strerror (saved_errno));
700 do_io_error (transport);
701 goto out;
702 }
703 }
704 else
705 {
706 _dbus_verbose (" wrote %d bytes of %d\n", bytes_written,
707 total_bytes_to_write);
708
709 total += bytes_written;
710 socket_transport->message_bytes_written += bytes_written;
711
712 _dbus_assert (socket_transport->message_bytes_written <=
713 total_bytes_to_write);
714
715 if (socket_transport->message_bytes_written == total_bytes_to_write)
716 {
717 socket_transport->message_bytes_written = 0;
718 _dbus_string_set_length (&socket_transport->encoded_outgoing, 0);
719 _dbus_string_compact (&socket_transport->encoded_outgoing, 2048);
720
721 _dbus_connection_message_sent_unlocked (transport->connection,
722 message);
723 }
724 }
725 }
726
727 out:
728 if (oom)
729 return FALSE;
730 else
731 return TRUE;
732 }
733
734 /* returns false on out-of-memory */
735 static dbus_bool_t
736 do_reading (DBusTransport *transport)
737 {
738 DBusTransportSocket *socket_transport = (DBusTransportSocket*) transport;
739 DBusString *buffer;
740 int bytes_read;
741 int total;
742 dbus_bool_t oom;
743 int saved_errno;
744
745 _dbus_verbose ("fd = %" DBUS_SOCKET_FORMAT "\n",
746 _dbus_socket_printable (socket_transport->fd));
747
748 /* No messages without authentication! */
749 if (!_dbus_transport_try_to_authenticate (transport))
750 return TRUE;
751
752 oom = FALSE;
753
754 total = 0;
755
756 again:
757
758 /* See if we've exceeded max messages and need to disable reading */
759 check_read_watch (transport);
760
761 if (total > socket_transport->max_bytes_read_per_iteration)
762 {
763 _dbus_verbose ("%d bytes exceeds %d bytes read per iteration, returning\n",
764 total, socket_transport->max_bytes_read_per_iteration);
765 goto out;
766 }
767
768 _dbus_assert (socket_transport->read_watch != NULL ||
769 transport->disconnected);
770
771 if (transport->disconnected)
772 goto out;
773
774 if (!dbus_watch_get_enabled (socket_transport->read_watch))
775 return TRUE;
776
777 if (_dbus_auth_needs_decoding (transport->auth))
778 {
779 /* Does fd passing even make sense with encoded data? */
780 _dbus_assert(!DBUS_TRANSPORT_CAN_SEND_UNIX_FD(transport));
781
782 if (_dbus_string_get_length (&socket_transport->encoded_incoming) > 0)
783 bytes_read = _dbus_string_get_length (&socket_transport->encoded_incoming);
784 else
785 bytes_read = _dbus_read_socket (socket_transport->fd,
786 &socket_transport->encoded_incoming,
787 socket_transport->max_bytes_read_per_iteration);
788
789 saved_errno = _dbus_save_socket_errno ();
790
791 _dbus_assert (_dbus_string_get_length (&socket_transport->encoded_incoming) ==
792 bytes_read);
793
794 if (bytes_read > 0)
795 {
796 _dbus_message_loader_get_buffer (transport->loader,
797 &buffer);
798
799 if (!_dbus_auth_decode_data (transport->auth,
800 &socket_transport->encoded_incoming,
801 buffer))
802 {
803 _dbus_verbose ("Out of memory decoding incoming data\n");
804 _dbus_message_loader_return_buffer (transport->loader,
805 buffer);
806
807 oom = TRUE;
808 goto out;
809 }
810
811 _dbus_message_loader_return_buffer (transport->loader,
812 buffer);
813
814 _dbus_string_set_length (&socket_transport->encoded_incoming, 0);
815 _dbus_string_compact (&socket_transport->encoded_incoming, 2048);
816 }
817 }
818 else
819 {
820 _dbus_message_loader_get_buffer (transport->loader,
821 &buffer);
822
823 #ifdef HAVE_UNIX_FD_PASSING
824 if (DBUS_TRANSPORT_CAN_SEND_UNIX_FD(transport))
825 {
826 int *fds, n_fds;
827
828 if (!_dbus_message_loader_get_unix_fds(transport->loader, &fds, &n_fds))
829 {
830 _dbus_verbose ("Out of memory reading file descriptors\n");
831 _dbus_message_loader_return_buffer (transport->loader, buffer);
832 oom = TRUE;
833 goto out;
834 }
835
836 bytes_read = _dbus_read_socket_with_unix_fds(socket_transport->fd,
837 buffer,
838 socket_transport->max_bytes_read_per_iteration,
839 fds, &n_fds);
840 saved_errno = _dbus_save_socket_errno ();
841
842 if (bytes_read >= 0 && n_fds > 0)
843 _dbus_verbose("Read %i unix fds\n", n_fds);
844
845 _dbus_message_loader_return_unix_fds(transport->loader, fds, bytes_read < 0 ? 0 : n_fds);
846 }
847 else
848 #endif
849 {
850 bytes_read = _dbus_read_socket (socket_transport->fd,
851 buffer, socket_transport->max_bytes_read_per_iteration);
852 saved_errno = _dbus_save_socket_errno ();
853 }
854
855 _dbus_message_loader_return_buffer (transport->loader,
856 buffer);
857 }
858
859 if (bytes_read < 0)
860 {
861 /* EINTR already handled for us */
862
863 if (_dbus_get_is_errno_enomem (saved_errno))
864 {
865 _dbus_verbose ("Out of memory in read()/do_reading()\n");
866 oom = TRUE;
867 goto out;
868 }
869 else if (_dbus_get_is_errno_eagain_or_ewouldblock (saved_errno))
870 goto out;
871 else
872 {
873 _dbus_verbose ("Error reading from remote app: %s\n",
874 _dbus_strerror (saved_errno));
875 do_io_error (transport);
876 goto out;
877 }
878 }
879 else if (bytes_read == 0)
880 {
881 _dbus_verbose ("Disconnected from remote app\n");
882 do_io_error (transport);
883 goto out;
884 }
885 else
886 {
887 _dbus_verbose (" read %d bytes\n", bytes_read);
888
889 total += bytes_read;
890
891 if (!_dbus_transport_queue_messages (transport))
892 {
893 oom = TRUE;
894 _dbus_verbose (" out of memory when queueing messages we just read in the transport\n");
895 goto out;
896 }
897
898 /* Try reading more data until we get EAGAIN and return, or
899 * exceed max bytes per iteration. If in blocking mode of
900 * course we'll block instead of returning.
901 */
902 goto again;
903 }
904
905 out:
906 if (oom)
907 return FALSE;
908 else
909 return TRUE;
910 }
911
912 static dbus_bool_t
913 unix_error_with_read_to_come (DBusTransport *itransport,
914 DBusWatch *watch,
915 unsigned int flags)
916 {
917 DBusTransportSocket *transport = (DBusTransportSocket *) itransport;
918
919 if (!(flags & DBUS_WATCH_HANGUP || flags & DBUS_WATCH_ERROR))
920 return FALSE;
921
922 /* If we have a read watch enabled ...
923 we -might have data incoming ... => handle the HANGUP there */
924 if (watch != transport->read_watch &&
925 _dbus_watch_get_enabled (transport->read_watch))
926 return FALSE;
927
928 return TRUE;
929 }
930
931 static dbus_bool_t
932 socket_handle_watch (DBusTransport *transport,
933 DBusWatch *watch,
934 unsigned int flags)
935 {
936 DBusTransportSocket *socket_transport = (DBusTransportSocket*) transport;
937
938 _dbus_assert (watch == socket_transport->read_watch ||
939 watch == socket_transport->write_watch);
940 _dbus_assert (watch != NULL);
941
942 /* If we hit an error here on a write watch, don't disconnect the transport yet because data can
943 * still be in the buffer and do_reading may need several iteration to read
944 * it all (because of its max_bytes_read_per_iteration limit).
945 */
946 if (!(flags & DBUS_WATCH_READABLE) && unix_error_with_read_to_come (transport, watch, flags))
947 {
948 _dbus_verbose ("Hang up or error on watch\n");
949 _dbus_transport_disconnect (transport);
950 return TRUE;
951 }
952
953 if (watch == socket_transport->read_watch &&
954 (flags & DBUS_WATCH_READABLE))
955 {
956 dbus_bool_t auth_finished;
957 #if 1
958 _dbus_verbose ("handling read watch %p flags = %x\n",
959 watch, flags);
960 #endif
961 if (!do_authentication (transport, TRUE, FALSE, &auth_finished))
962 return FALSE;
963
964 /* We don't want to do a read immediately following
965 * a successful authentication. This is so we
966 * have a chance to propagate the authentication
967 * state further up. Specifically, we need to
968 * process any pending data from the auth object.
969 */
970 if (!auth_finished)
971 {
972 if (!do_reading (transport))
973 {
974 _dbus_verbose ("no memory to read\n");
975 return FALSE;
976 }
977 }
978 else
979 {
980 _dbus_verbose ("Not reading anything since we just completed the authentication\n");
981 }
982 }
983 else if (watch == socket_transport->write_watch &&
984 (flags & DBUS_WATCH_WRITABLE))
985 {
986 #if 1
987 _dbus_verbose ("handling write watch, have_outgoing_messages = %d\n",
988 _dbus_connection_has_messages_to_send_unlocked (transport->connection));
989 #endif
990 if (!do_authentication (transport, FALSE, TRUE, NULL))
991 return FALSE;
992
993 if (!do_writing (transport))
994 {
995 _dbus_verbose ("no memory to write\n");
996 return FALSE;
997 }
998
999 /* See if we still need the write watch */
1000 check_write_watch (transport);
1001 }
1002 #ifdef DBUS_ENABLE_VERBOSE_MODE
1003 else
1004 {
1005 if (watch == socket_transport->read_watch)
1006 _dbus_verbose ("asked to handle read watch with non-read condition 0x%x\n",
1007 flags);
1008 else if (watch == socket_transport->write_watch)
1009 _dbus_verbose ("asked to handle write watch with non-write condition 0x%x\n",
1010 flags);
1011 else
1012 _dbus_verbose ("asked to handle watch %p on fd %" DBUS_SOCKET_FORMAT " that we don't recognize\n",
1013 watch, dbus_watch_get_socket (watch));
1014 }
1015 #endif /* DBUS_ENABLE_VERBOSE_MODE */
1016
1017 return TRUE;
1018 }
1019
1020 static void
1021 socket_disconnect (DBusTransport *transport)
1022 {
1023 DBusTransportSocket *socket_transport = (DBusTransportSocket*) transport;
1024
1025 _dbus_verbose ("\n");
1026
1027 free_watches (transport);
1028
1029 _dbus_close_socket (socket_transport->fd, NULL);
1030 _dbus_socket_invalidate (&socket_transport->fd);
1031 }
1032
1033 static dbus_bool_t
1034 socket_connection_set (DBusTransport *transport)
1035 {
1036 DBusTransportSocket *socket_transport = (DBusTransportSocket*) transport;
1037
1038 _dbus_watch_set_handler (socket_transport->write_watch,
1039 _dbus_connection_handle_watch,
1040 transport->connection, NULL);
1041
1042 _dbus_watch_set_handler (socket_transport->read_watch,
1043 _dbus_connection_handle_watch,
1044 transport->connection, NULL);
1045
1046 if (!_dbus_connection_add_watch_unlocked (transport->connection,
1047 socket_transport->write_watch))
1048 return FALSE;
1049
1050 if (!_dbus_connection_add_watch_unlocked (transport->connection,
1051 socket_transport->read_watch))
1052 {
1053 _dbus_connection_remove_watch_unlocked (transport->connection,
1054 socket_transport->write_watch);
1055 return FALSE;
1056 }
1057
1058 check_read_watch (transport);
1059 check_write_watch (transport);
1060
1061 return TRUE;
1062 }
1063
1071 static void
1072 socket_do_iteration (DBusTransport *transport,
1073 unsigned int flags,
1074 int timeout_milliseconds)
1075 {
1076 DBusTransportSocket *socket_transport = (DBusTransportSocket*) transport;
1077 DBusPollFD poll_fd;
1078 int poll_res;
1079 int poll_timeout;
1080
1081 _dbus_verbose (" iteration flags = %s%s timeout = %d read_watch = %p write_watch = %p fd = %" DBUS_SOCKET_FORMAT "\n",
1082 flags & DBUS_ITERATION_DO_READING ? "read" : "",
1083 flags & DBUS_ITERATION_DO_WRITING ? "write" : "",
1084 timeout_milliseconds,
1085 socket_transport->read_watch,
1086 socket_transport->write_watch,
1087 _dbus_socket_printable (socket_transport->fd));
1088
1089 /* the passed in DO_READING/DO_WRITING flags indicate whether to
1090 * read/write messages, but regardless of those we may need to block
1091 * for reading/writing to do auth. But if we do reading for auth,
1092 * we don't want to read any messages yet if not given DO_READING.
1093 */
1094
1095 poll_fd.fd = _dbus_socket_get_pollable (socket_transport->fd);
1096 poll_fd.events = 0;
1097
1098 if (_dbus_transport_try_to_authenticate (transport))
1099 {
1100 /* This is kind of a hack; if we have stuff to write, then try
1101 * to avoid the poll. This is probably about a 5% speedup on an
1102 * echo client/server.
1103 *
1104 * If both reading and writing were requested, we want to avoid this
1105 * since it could have funky effects:
1106 * - both ends spinning waiting for the other one to read
1107 * data so they can finish writing
1108 * - prioritizing all writing ahead of reading
1109 */
1110 if ((flags & DBUS_ITERATION_DO_WRITING) &&
1111 !(flags & (DBUS_ITERATION_DO_READING | DBUS_ITERATION_BLOCK)) &&
1112 !transport->disconnected &&
1113 _dbus_connection_has_messages_to_send_unlocked (transport->connection))
1114 {
1115 do_writing (transport);
1116
1117 if (transport->disconnected ||
1118 !_dbus_connection_has_messages_to_send_unlocked (transport->connection))
1119 goto out;
1120 }
1121
1122 /* If we get here, we decided to do the poll() after all */
1123 _dbus_assert (socket_transport->read_watch);
1124 if (flags & DBUS_ITERATION_DO_READING)
1125 poll_fd.events |= _DBUS_POLLIN;
1126
1127 _dbus_assert (socket_transport->write_watch);
1128 if (flags & DBUS_ITERATION_DO_WRITING)
1129 poll_fd.events |= _DBUS_POLLOUT;
1130 }
1131 else
1132 {
1133 DBusAuthState auth_state;
1134
1135 auth_state = _dbus_auth_do_work (transport->auth);
1136
1137 if (transport->receive_credentials_pending ||
1138 auth_state == DBUS_AUTH_STATE_WAITING_FOR_INPUT)
1139 poll_fd.events |= _DBUS_POLLIN;
1140
1141 if (transport->send_credentials_pending ||
1142 auth_state == DBUS_AUTH_STATE_HAVE_BYTES_TO_SEND)
1143 poll_fd.events |= _DBUS_POLLOUT;
1144 }
1145
1146 if (poll_fd.events)
1147 {
1148 int saved_errno;
1149
1150 if (flags & DBUS_ITERATION_BLOCK)
1151 poll_timeout = timeout_milliseconds;
1152 else
1153 poll_timeout = 0;
1154
1155 /* For blocking selects we drop the connection lock here
1156 * to avoid blocking out connection access during a potentially
1157 * indefinite blocking call. The io path is still protected
1158 * by the io_path_cond condvar, so we won't reenter this.
1159 */
1160 if (flags & DBUS_ITERATION_BLOCK)
1161 {
1162 _dbus_verbose ("unlock pre poll\n");
1163 _dbus_connection_unlock (transport->connection);
1164 }
1165
1166 again:
1167 poll_res = _dbus_poll (&poll_fd, 1, poll_timeout);
1168 saved_errno = _dbus_save_socket_errno ();
1169
1170 if (poll_res < 0 && _dbus_get_is_errno_eintr (saved_errno))
1171 goto again;
1172
1173 if (flags & DBUS_ITERATION_BLOCK)
1174 {
1175 _dbus_verbose ("lock post poll\n");
1176 _dbus_connection_lock (transport->connection);
1177 }
1178
1179 if (poll_res >= 0)
1180 {
1181 if (poll_res == 0)
1182 poll_fd.revents = 0; /* some concern that posix does not guarantee this;
1183 * valgrind flags it as an error. though it probably
1184 * is guaranteed on linux at least.
1185 */
1186
1187 if (poll_fd.revents & _DBUS_POLLERR)
1188 do_io_error (transport);
1189 else
1190 {
1191 dbus_bool_t need_read = (poll_fd.revents & _DBUS_POLLIN) > 0;
1192 dbus_bool_t need_write = (poll_fd.revents & _DBUS_POLLOUT) > 0;
1193 dbus_bool_t authentication_completed;
1194
1195 _dbus_verbose ("in iteration, need_read=%d need_write=%d\n",
1196 need_read, need_write);
1197 do_authentication (transport, need_read, need_write,
1198 &authentication_completed);
1199
1200 /* See comment in socket_handle_watch. */
1201 if (authentication_completed)
1202 goto out;
1203
1204 if (need_read && (flags & DBUS_ITERATION_DO_READING))
1205 do_reading (transport);
1206 if (need_write && (flags & DBUS_ITERATION_DO_WRITING))
1207 do_writing (transport);
1208 }
1209 }
1210 else
1211 {
1212 _dbus_verbose ("Error from _dbus_poll(): %s\n",
1213 _dbus_strerror (saved_errno));
1214 }
1215 }
1216
1217
1218 out:
1219 /* We need to install the write watch only if we did not
1220 * successfully write everything. Note we need to be careful that we
1221 * don't call check_write_watch *before* do_writing, since it's
1222 * inefficient to add the write watch, and we can avoid it most of
1223 * the time since we can write immediately.
1224 *
1225 * However, we MUST always call check_write_watch(); DBusConnection code
1226 * relies on the fact that running an iteration will notice that
1227 * messages are pending.
1228 */
1229 check_write_watch (transport);
1230
1231 _dbus_verbose (" ... leaving do_iteration()\n");
1232 }
1233
1234 static void
1235 socket_live_messages_changed (DBusTransport *transport)
1236 {
1237 /* See if we should look for incoming messages again */
1238 check_read_watch (transport);
1239 }
1240
1241
1242 static dbus_bool_t
1243 socket_get_socket_fd (DBusTransport *transport,
1244 DBusSocket *fd_p)
1245 {
1246 DBusTransportSocket *socket_transport = (DBusTransportSocket*) transport;
1247
1248 *fd_p = socket_transport->fd;
1249
1250 return TRUE;
1251 }
1252
1253 static const DBusTransportVTable socket_vtable = {
1254 socket_finalize,
1255 socket_handle_watch,
1256 socket_disconnect,
1257 socket_connection_set,
1258 socket_do_iteration,
1259 socket_live_messages_changed,
1260 socket_get_socket_fd
1261 };
1262
1274 DBusTransport*
1275 _dbus_transport_new_for_socket (DBusSocket fd,
1276 const DBusString *server_guid,
1277 const DBusString *address)
1278 {
1279 DBusTransportSocket *socket_transport;
1280
1281 socket_transport = dbus_new0 (DBusTransportSocket, 1);
1282 if (socket_transport == NULL)
1283 return NULL;
1284
1285 if (!_dbus_string_init (&socket_transport->encoded_outgoing))
1286 goto failed_0;
1287
1288 if (!_dbus_string_init (&socket_transport->encoded_incoming))
1289 goto failed_1;
1290
1291 socket_transport->write_watch = _dbus_watch_new (_dbus_socket_get_pollable (fd),
1292 DBUS_WATCH_WRITABLE,
1293 FALSE,
1294 NULL, NULL, NULL);
1295 if (socket_transport->write_watch == NULL)
1296 goto failed_2;
1297
1298 socket_transport->read_watch = _dbus_watch_new (_dbus_socket_get_pollable (fd),
1299 DBUS_WATCH_READABLE,
1300 FALSE,
1301 NULL, NULL, NULL);
1302 if (socket_transport->read_watch == NULL)
1303 goto failed_3;
1304
1305 if (!_dbus_transport_init_base (&socket_transport->base,
1306 &socket_vtable,
1307 server_guid, address))
1308 goto failed_4;
1309
1310 #ifdef HAVE_UNIX_FD_PASSING
1311 _dbus_auth_set_unix_fd_possible(socket_transport->base.auth, _dbus_socket_can_pass_unix_fd(fd));
1312 #endif
1313
1314 socket_transport->fd = fd;
1315 socket_transport->message_bytes_written = 0;
1316
1317 /* These values should probably be tunable or something. */
1318 socket_transport->max_bytes_read_per_iteration = 2048;
1319 socket_transport->max_bytes_written_per_iteration = 2048;
1320
1321 return (DBusTransport*) socket_transport;
1322
1323 failed_4:
1324 _dbus_watch_invalidate (socket_transport->read_watch);
1325 _dbus_watch_unref (socket_transport->read_watch);
1326 failed_3:
1327 _dbus_watch_invalidate (socket_transport->write_watch);
1328 _dbus_watch_unref (socket_transport->write_watch);
1329 failed_2:
1330 _dbus_string_free (&socket_transport->encoded_incoming);
1331 failed_1:
1332 _dbus_string_free (&socket_transport->encoded_outgoing);
1333 failed_0:
1334 dbus_free (socket_transport);
1335 return NULL;
1336 }
1337
1349 DBusTransport*
1350 _dbus_transport_new_for_tcp_socket (const char *host,
1351 const char *port,
1352 const char *family,
1353 const char *noncefile,
1354 DBusError *error)
1355 {
1356 DBusSocket fd;
1357 DBusTransport *transport;
1358 DBusString address;
1359
1360 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1361
1362 if (!_dbus_string_init (&address))
1363 {
1364 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1365 return NULL;
1366 }
1367
1368 if (host == NULL)
1369 host = "localhost";
1370
1371 if (!_dbus_string_append (&address, noncefile ? "nonce-tcp:" : "tcp:"))
1372 goto error;
1373
1374 if (!_dbus_string_append (&address, "host=") ||
1375 !_dbus_string_append (&address, host))
1376 goto error;
1377
1378 if (!_dbus_string_append (&address, ",port=") ||
1379 !_dbus_string_append (&address, port))
1380 goto error;
1381
1382 if (family != NULL &&
1383 (!_dbus_string_append (&address, ",family=") ||
1384 !_dbus_string_append (&address, family)))
1385 goto error;
1386
1387 if (noncefile != NULL &&
1388 (!_dbus_string_append (&address, ",noncefile=") ||
1389 !_dbus_string_append (&address, noncefile)))
1390 goto error;
1391
1392 fd = _dbus_connect_tcp_socket_with_nonce (host, port, family, noncefile, error);
1393 if (!_dbus_socket_is_valid (fd))
1394 {
1395 _DBUS_ASSERT_ERROR_IS_SET (error);
1396 _dbus_string_free (&address);
1397 return NULL;
1398 }
1399
1400 _dbus_verbose ("Successfully connected to tcp socket %s:%s\n",
1401 host, port);
1402
1403 transport = _dbus_transport_new_for_socket (fd, NULL, &address);
1404 _dbus_string_free (&address);
1405 if (transport == NULL)
1406 {
1407 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1408 _dbus_close_socket (fd, NULL);
1409 _dbus_socket_invalidate (&fd);
1410 }
1411
1412 return transport;
1413
1414 error:
1415 _dbus_string_free (&address);
1416 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1417 return NULL;
1418 }
1419
1428 DBusTransportOpenResult
1429 _dbus_transport_open_socket(DBusAddressEntry *entry,
1430 DBusTransport **transport_p,
1431 DBusError *error)
1432 {
1433 const char *method;
1434 dbus_bool_t isTcp;
1435 dbus_bool_t isNonceTcp;
1436
1437 method = dbus_address_entry_get_method (entry);
1438 _dbus_assert (method != NULL);
1439
1440 isTcp = strcmp (method, "tcp") == 0;
1441 isNonceTcp = strcmp (method, "nonce-tcp") == 0;
1442
1443 if (isTcp || isNonceTcp)
1444 {
1445 const char *host = dbus_address_entry_get_value (entry, "host");
1446 const char *port = dbus_address_entry_get_value (entry, "port");
1447 const char *family = dbus_address_entry_get_value (entry, "family");
1448 const char *noncefile = dbus_address_entry_get_value (entry, "noncefile");
1449
1450 if ((isNonceTcp == TRUE) != (noncefile != NULL)) {
1451 _dbus_set_bad_address (error, method, "noncefile", NULL);
1452 return DBUS_TRANSPORT_OPEN_BAD_ADDRESS;
1453 }
1454
1455 if (port == NULL)
1456 {
1457 _dbus_set_bad_address (error, method, "port", NULL);
1458 return DBUS_TRANSPORT_OPEN_BAD_ADDRESS;
1459 }
1460
1461 *transport_p = _dbus_transport_new_for_tcp_socket (host, port, family, noncefile, error);
1462 if (*transport_p == NULL)
1463 {
1464 _DBUS_ASSERT_ERROR_IS_SET (error);
1465 return DBUS_TRANSPORT_OPEN_DID_NOT_CONNECT;
1466 }
1467 else
1468 {
1469 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1470 return DBUS_TRANSPORT_OPEN_OK;
1471 }
1472 }
1473 else
1474 {
1475 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1476 return DBUS_TRANSPORT_OPEN_NOT_HANDLED;
1477 }
1478 }
1479
DBusTransportSocket
Implementation details of DBusTransportSocket.
Definition: dbus-transport-socket.c:49
_dbus_string_append
dbus_bool_t _dbus_string_append(DBusString *str, const char *buffer)
Appends a nul-terminated C-style string to a DBusString.
Definition: dbus-string.c:935
dbus_message_lock
void dbus_message_lock(DBusMessage *message)
Locks a message.
Definition: dbus-message.c:407
DBusTransportSocket::base
DBusTransport base
Parent instance.
Definition: dbus-transport-socket.c:51
_dbus_connection_toggle_watch_unlocked
void _dbus_connection_toggle_watch_unlocked(DBusConnection *connection, DBusWatch *watch, dbus_bool_t enabled)
Toggles a watch and notifies app via connection&#39;s DBusWatchToggledFunction if available.
Definition: dbus-connection.c:781
DBusTransport::max_live_messages_unix_fds
long max_live_messages_unix_fds
Max total unix fds of received messages.
Definition: dbus-transport-protected.h:95
DBusError::message
const char * message
public error message field
Definition: dbus-errors.h:51
_dbus_watch_new
DBusWatch * _dbus_watch_new(DBusPollable fd, unsigned int flags, dbus_bool_t enabled, DBusWatchHandler handler, void *data, DBusFreeFunction free_data_function)
Creates a new DBusWatch.
Definition: dbus-watch.c:88
DBusWatch
Implementation of DBusWatch.
Definition: dbus-watch.c:40
_dbus_transport_new_for_tcp_socket
DBusTransport * _dbus_transport_new_for_tcp_socket(const char *host, const char *port, const char *family, const char *noncefile, DBusError *error)
Creates a new transport for the given hostname and port.
Definition: dbus-transport-socket.c:1350
NULL
#define NULL
A null pointer, defined appropriately for C or C++.
_dbus_message_loader_return_buffer
DBUS_PRIVATE_EXPORT void _dbus_message_loader_return_buffer(DBusMessageLoader *loader, DBusString *buffer)
Returns a buffer obtained from _dbus_message_loader_get_buffer(), indicating to the loader how many b...
Definition: dbus-message.c:4059
DBusTransport::auth
DBusAuth * auth
Authentication conversation.
Definition: dbus-transport-protected.h:90
DBusTransport::disconnected
unsigned int disconnected
TRUE if we are disconnected.
Definition: dbus-transport-protected.h:113
dbus_free
void dbus_free(void *memory)
Frees a block of memory previously allocated by dbus_malloc() or dbus_malloc0().
Definition: dbus-memory.c:701
_dbus_message_loader_return_unix_fds
DBUS_PRIVATE_EXPORT void _dbus_message_loader_return_unix_fds(DBusMessageLoader *loader, int *fds, unsigned n_fds)
Returns a buffer obtained from _dbus_message_loader_get_unix_fds().
Definition: dbus-message.c:4128
_dbus_auth_needs_decoding
dbus_bool_t _dbus_auth_needs_decoding(DBusAuth *auth)
Called post-authentication, indicates whether we need to decode the message stream with _dbus_auth_de...
Definition: dbus-auth.c:2684
DBusTransport::max_live_messages_size
long max_live_messages_size
Max total size of received messages.
Definition: dbus-transport-protected.h:94
_dbus_connection_lock
DBUS_PRIVATE_EXPORT void _dbus_connection_lock(DBusConnection *connection)
Acquires the connection lock.
Definition: dbus-connection.c:388
_dbus_auth_encode_data
dbus_bool_t _dbus_auth_encode_data(DBusAuth *auth, const DBusString *plaintext, DBusString *encoded)
Called post-authentication, encodes a block of bytes for sending to the peer.
Definition: dbus-auth.c:2652
dbus_watch_get_enabled
DBUS_EXPORT dbus_bool_t dbus_watch_get_enabled(DBusWatch *watch)
Returns whether a watch is enabled or not.
Definition: dbus-watch.c:703
_dbus_assert
#define _dbus_assert(condition)
Aborts with an error message if the condition is false.
Definition: dbus-internals.h:148
DBUS_ERROR_INIT
#define DBUS_ERROR_INIT
Expands to a suitable initializer for a DBusError on the stack.
Definition: dbus-errors.h:62
dbus_address_entry_get_method
const char * dbus_address_entry_get_method(DBusAddressEntry *entry)
Returns the method string of an address entry.
Definition: dbus-address.c:227
_dbus_transport_open_socket
DBusTransportOpenResult _dbus_transport_open_socket(DBusAddressEntry *entry, DBusTransport **transport_p, DBusError *error)
Opens a TCP socket transport.
Definition: dbus-transport-socket.c:1429
_dbus_transport_queue_messages
dbus_bool_t _dbus_transport_queue_messages(DBusTransport *transport)
Processes data we&#39;ve read while handling a watch, potentially converting some of it to messages and q...
Definition: dbus-transport.c:1140
_dbus_auth_return_buffer
void _dbus_auth_return_buffer(DBusAuth *auth, DBusString *buffer)
Returns a buffer with new data read into it.
Definition: dbus-auth.c:2572
_dbus_auth_do_work
DBusAuthState _dbus_auth_do_work(DBusAuth *auth)
Analyzes buffered input and moves the auth conversation forward, returning the new state of the auth ...
Definition: dbus-auth.c:2465
dbus_error_free
void dbus_error_free(DBusError *error)
Frees an error that&#39;s been set (or just initialized), then reinitializes the error as in dbus_error_i...
Definition: dbus-errors.c:211
DBusPollFD
Definition: dbus-sysdeps.h:380
DBusTransportSocket::max_bytes_written_per_iteration
int max_bytes_written_per_iteration
To avoid blocking too long.
Definition: dbus-transport-socket.c:57
DBusTransport::connection
DBusConnection * connection
Connection owning this transport.
Definition: dbus-transport-protected.h:86
_DBUS_POLLIN
#define _DBUS_POLLIN
There is data to read.
Definition: dbus-sysdeps.h:388
DBusTransport::send_credentials_pending
unsigned int send_credentials_pending
TRUE if we need to send credentials
Definition: dbus-transport-protected.h:115
_dbus_read_socket
int _dbus_read_socket(DBusSocket fd, DBusString *buffer, int count)
Like _dbus_read(), but only works on sockets so is available on Windows.
Definition: dbus-sysdeps-unix.c:299
_dbus_string_init
dbus_bool_t _dbus_string_init(DBusString *str)
Initializes a string.
Definition: dbus-string.c:175
_dbus_connection_get_message_to_send
DBusMessage * _dbus_connection_get_message_to_send(DBusConnection *connection)
Gets the next outgoing message.
Definition: dbus-connection.c:609
DBusPollFD::events
short events
Events to poll for.
Definition: dbus-sysdeps.h:383
DBusTransportSocket::encoded_incoming
DBusString encoded_incoming
Encoded version of current incoming data.
Definition: dbus-transport-socket.c:66
_dbus_send_credentials_socket
dbus_bool_t _dbus_send_credentials_socket(DBusSocket server_fd, DBusError *error)
Sends a single nul byte with our UNIX credentials as ancillary data.
Definition: dbus-sysdeps-unix.c:2199
_dbus_close_socket
dbus_bool_t _dbus_close_socket(DBusSocket fd, DBusError *error)
Closes a socket.
Definition: dbus-sysdeps-unix.c:283
_dbus_get_is_errno_etoomanyrefs
dbus_bool_t _dbus_get_is_errno_etoomanyrefs(int e)
See if errno is ETOOMANYREFS.
Definition: dbus-sysdeps.c:735
_dbus_transport_get_is_connected
dbus_bool_t _dbus_transport_get_is_connected(DBusTransport *transport)
Returns TRUE if the transport has not been disconnected.
Definition: dbus-transport.c:527
_dbus_transport_init_base
dbus_bool_t _dbus_transport_init_base(DBusTransport *transport, const DBusTransportVTable *vtable, const DBusString *server_guid, const DBusString *address)
Initializes the base class members of DBusTransport.
Definition: dbus-transport.c:102
_dbus_read_socket_with_unix_fds
int _dbus_read_socket_with_unix_fds(DBusSocket fd, DBusString *buffer, int count, int *fds, int *n_fds)
Like _dbus_read_socket() but also tries to read unix fds from the socket.
Definition: dbus-sysdeps-unix.c:355
DBusSocket
Socket interface.
Definition: dbus-sysdeps.h:148
_dbus_auth_get_buffer
void _dbus_auth_get_buffer(DBusAuth *auth, DBusString **buffer)
Get a buffer to be used for reading bytes from the peer we&#39;re conversing with.
Definition: dbus-auth.c:2554
DBusMessage
Internals of DBusMessage.
Definition: dbus-message-private.h:99
_dbus_auth_decode_data
dbus_bool_t _dbus_auth_decode_data(DBusAuth *auth, const DBusString *encoded, DBusString *plaintext)
Called post-authentication, decodes a block of bytes received from the peer.
Definition: dbus-auth.c:2715
dbus_address_entry_get_value
const char * dbus_address_entry_get_value(DBusAddressEntry *entry, const char *key)
Returns a value from a key of an entry.
Definition: dbus-address.c:244
DBusTransportSocket::fd
DBusSocket fd
File descriptor.
Definition: dbus-transport-socket.c:52
_dbus_transport_new_for_socket
DBusTransport * _dbus_transport_new_for_socket(DBusSocket fd, const DBusString *server_guid, const DBusString *address)
Creates a new transport for the given socket file descriptor.
Definition: dbus-transport-socket.c:1275
_dbus_get_is_errno_epipe
dbus_bool_t _dbus_get_is_errno_epipe(int e)
See if errno is EPIPE.
Definition: dbus-sysdeps.c:725
dbus_new0
#define dbus_new0(type, count)
Safe macro for using dbus_malloc0().
Definition: dbus-memory.h:59
_dbus_auth_bytes_sent
void _dbus_auth_bytes_sent(DBusAuth *auth, int bytes_sent)
Notifies the auth conversation object that the given number of bytes of the outgoing buffer have been...
Definition: dbus-auth.c:2534
_dbus_connection_remove_watch_unlocked
void _dbus_connection_remove_watch_unlocked(DBusConnection *connection, DBusWatch *watch)
Removes a watch using the connection&#39;s DBusRemoveWatchFunction if available.
Definition: dbus-connection.c:761
_dbus_string_compact
dbus_bool_t _dbus_string_compact(DBusString *str, int max_waste)
Compacts the string to avoid wasted memory.
Definition: dbus-string.c:389
DBusTransport::receive_credentials_pending
unsigned int receive_credentials_pending
TRUE if we need to receive credentials
Definition: dbus-transport-protected.h:116
DBUS_WATCH_WRITABLE
As in POLLOUT.
Definition: dbus-connection.h:61
DBusString
Definition: dbus-string.h:42
DBusTransport::live_messages
DBusCounter * live_messages
Counter for size/unix fds of all live messages.
Definition: dbus-transport-protected.h:97
_dbus_get_is_errno_eagain_or_ewouldblock
dbus_bool_t _dbus_get_is_errno_eagain_or_ewouldblock(int e)
See if errno is EAGAIN or EWOULDBLOCK (this has to be done differently for Winsock so is abstracted) ...
Definition: dbus-sysdeps-unix.c:4267
dbus_bool_t
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:35
_dbus_connection_has_messages_to_send_unlocked
dbus_bool_t _dbus_connection_has_messages_to_send_unlocked(DBusConnection *connection)
Checks whether there are messages in the outgoing message queue.
Definition: dbus-connection.c:572
dbus_watch_get_socket
DBUS_EXPORT int dbus_watch_get_socket(DBusWatch *watch)
Returns a socket to be watched, on UNIX this will return -1 if our transport is not socket-based so d...
Definition: dbus-watch.c:594
_DBUS_POLLOUT
#define _DBUS_POLLOUT
Writing now will not block.
Definition: dbus-sysdeps.h:392
_dbus_write_socket_two
int _dbus_write_socket_two(DBusSocket fd, const DBusString *buffer1, int start1, int len1, const DBusString *buffer2, int start2, int len2)
Like _dbus_write_two() but only works on sockets and is thus available on Windows.
Definition: dbus-sysdeps-unix.c:628
DBusAddressEntry
Internals of DBusAddressEntry.
Definition: dbus-address.c:43
_dbus_read_credentials_socket
dbus_bool_t _dbus_read_credentials_socket(DBusSocket client_fd, DBusCredentials *credentials, DBusError *error)
Reads a single byte which must be nul (an error occurs otherwise), and reads unix credentials if avai...
Definition: dbus-sysdeps-unix.c:1886
DBusTransportSocket::write_watch
DBusWatch * write_watch
Watch for writability.
Definition: dbus-transport-socket.c:54
_dbus_watch_invalidate
void _dbus_watch_invalidate(DBusWatch *watch)
Clears the file descriptor from a now-invalid watch object so that no one tries to use it...
Definition: dbus-watch.c:169
_dbus_set_bad_address
void _dbus_set_bad_address(DBusError *error, const char *address_problem_type, const char *address_problem_field, const char *address_problem_other)
Sets DBUS_ERROR_BAD_ADDRESS.
Definition: dbus-address.c:65
_dbus_connection_handle_watch
dbus_bool_t _dbus_connection_handle_watch(DBusWatch *watch, unsigned int condition, void *data)
A callback for use with dbus_watch_new() to create a DBusWatch.
Definition: dbus-connection.c:1486
_dbus_get_is_errno_eintr
dbus_bool_t _dbus_get_is_errno_eintr(int e)
See if errno is EINTR.
Definition: dbus-sysdeps.c:715
DBusError
Object representing an exception.
Definition: dbus-errors.h:48
_dbus_connection_add_watch_unlocked
dbus_bool_t _dbus_connection_add_watch_unlocked(DBusConnection *connection, DBusWatch *watch)
Adds a watch using the connection&#39;s DBusAddWatchFunction if available.
Definition: dbus-connection.c:743
dbus_set_error
void dbus_set_error(DBusError *error, const char *name, const char *format,...)
Assigns an error name and message to a DBusError.
Definition: dbus-errors.c:354
DBusTransportVTable
The virtual table that must be implemented to create a new kind of transport.
Definition: dbus-transport-protected.h:41
DBusTransportSocket::message_bytes_written
int message_bytes_written
Number of bytes of current outgoing message that have been written.
Definition: dbus-transport-socket.c:59
_dbus_connection_message_sent_unlocked
void _dbus_connection_message_sent_unlocked(DBusConnection *connection, DBusMessage *message)
Notifies the connection that a message has been sent, so the message can be removed from the outgoing...
Definition: dbus-connection.c:625
DBUS_WATCH_ERROR
As in POLLERR (can&#39;t watch for this, but can be present in current state passed to dbus_watch_handle(...
Definition: dbus-connection.h:62
_dbus_string_free
void _dbus_string_free(DBusString *str)
Frees a string created by _dbus_string_init().
Definition: dbus-string.c:259
TRUE
#define TRUE
Expands to "1".
DBusPollFD::fd
DBusPollable fd
File descriptor.
Definition: dbus-sysdeps.h:382
DBusTransport::loader
DBusMessageLoader * loader
Message-loading buffer.
Definition: dbus-transport-protected.h:88
DBUS_WATCH_HANGUP
As in POLLHUP (can&#39;t watch for it, but can be present in current state passed to dbus_watch_handle())...
Definition: dbus-connection.h:67
_dbus_message_get_network_data
void _dbus_message_get_network_data(DBusMessage *message, const DBusString **header, const DBusString **body)
Gets the data to be sent over the network for this message.
Definition: dbus-message.c:231
DBusTransport
Object representing a transport such as a socket.
Definition: dbus-transport-protected.h:80
_dbus_auth_set_credentials
dbus_bool_t _dbus_auth_set_credentials(DBusAuth *auth, DBusCredentials *credentials)
Sets credentials received via reliable means from the operating system.
Definition: dbus-auth.c:2747
_dbus_auth_set_unix_fd_possible
void _dbus_auth_set_unix_fd_possible(DBusAuth *auth, dbus_bool_t b)
Sets whether unix fd passing is potentially on the transport and hence shall be negotiated.
Definition: dbus-auth.c:2823
_dbus_message_loader_get_unix_fds
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_message_loader_get_unix_fds(DBusMessageLoader *loader, int **fds, unsigned *max_n_fds)
Gets the buffer to use for reading unix fds from the network.
Definition: dbus-message.c:4079
_dbus_transport_ref
DBusTransport * _dbus_transport_ref(DBusTransport *transport)
Increments the reference count for the transport.
Definition: dbus-transport.c:460
_dbus_transport_try_to_authenticate
dbus_bool_t _dbus_transport_try_to_authenticate(DBusTransport *transport)
Returns TRUE if we have been authenticated.
Definition: dbus-transport.c:724
_dbus_message_loader_get_buffer
DBUS_PRIVATE_EXPORT void _dbus_message_loader_get_buffer(DBusMessageLoader *loader, DBusString **buffer)
Gets the buffer to use for reading data from the network.
Definition: dbus-message.c:4039
_dbus_auth_get_bytes_to_send
dbus_bool_t _dbus_auth_get_bytes_to_send(DBusAuth *auth, const DBusString **str)
Gets bytes that need to be sent to the peer we&#39;re conversing with.
Definition: dbus-auth.c:2509
_dbus_watch_unref
void _dbus_watch_unref(DBusWatch *watch)
Decrements the reference count of a DBusWatch object and finalizes the object if the count reaches ze...
Definition: dbus-watch.c:138
DBusTransportSocket::read_watch
DBusWatch * read_watch
Watch for readability.
Definition: dbus-transport-socket.c:53
DBUS_ERROR_NO_MEMORY
#define DBUS_ERROR_NO_MEMORY
There was not enough memory to complete an operation.
Definition: dbus-protocol.h:357
FALSE
#define FALSE
Expands to "0".
DBusTransport::credentials
DBusCredentials * credentials
Credentials of other end read from the socket.
Definition: dbus-transport-protected.h:92
_dbus_string_set_length
dbus_bool_t _dbus_string_set_length(DBusString *str, int length)
Sets the length of a string.
Definition: dbus-string.c:802
DBusTransportSocket::max_bytes_read_per_iteration
int max_bytes_read_per_iteration
To avoid blocking too long.
Definition: dbus-transport-socket.c:56
_dbus_write_socket
int _dbus_write_socket(DBusSocket fd, const DBusString *buffer, int start, int len)
Like _dbus_write(), but only supports sockets and is thus available on Windows.
Definition: dbus-sysdeps-unix.c:317
_dbus_auth_needs_encoding
dbus_bool_t _dbus_auth_needs_encoding(DBusAuth *auth)
Called post-authentication, indicates whether we need to encode the message stream with _dbus_auth_en...
Definition: dbus-auth.c:2625
DBUS_WATCH_READABLE
As in POLLIN.
Definition: dbus-connection.h:60
_dbus_message_get_unix_fds
DBUS_PRIVATE_EXPORT void _dbus_message_get_unix_fds(DBusMessage *message, const int **fds, unsigned *n_fds)
Gets the unix fds to be sent over the network for this message.
Definition: dbus-message.c:250
_dbus_watch_set_handler
void _dbus_watch_set_handler(DBusWatch *watch, DBusWatchHandler handler, void *data, DBusFreeFunction free_data_function)
Sets the handler for the watch.
Definition: dbus-watch.c:499
_dbus_transport_disconnect
void _dbus_transport_disconnect(DBusTransport *transport)
Closes our end of the connection to a remote application.
Definition: dbus-transport.c:502
_dbus_socket_can_pass_unix_fd
dbus_bool_t _dbus_socket_can_pass_unix_fd(DBusSocket fd)
Checks whether file descriptors may be passed via the socket.
Definition: dbus-sysdeps-unix.c:4308
_dbus_transport_finalize_base
void _dbus_transport_finalize_base(DBusTransport *transport)
Finalizes base class members of DBusTransport.
Definition: dbus-transport.c:216
_dbus_poll
int _dbus_poll(DBusPollFD *fds, int n_fds, int timeout_milliseconds)
Wrapper for poll().
Definition: dbus-sysdeps-unix.c:2825
_dbus_connection_unlock
DBUS_PRIVATE_EXPORT void _dbus_connection_unlock(DBusConnection *connection)
Releases the connection lock.
Definition: dbus-connection.c:399
DBusPollFD::revents
short revents
Events that occurred.
Definition: dbus-sysdeps.h:384
_dbus_transport_unref
void _dbus_transport_unref(DBusTransport *transport)
Decrements the reference count for the transport.
Definition: dbus-transport.c:477
_dbus_counter_get_unix_fd_value
long _dbus_counter_get_unix_fd_value(DBusCounter *counter)
Gets the current value of the unix fd counter.
Definition: dbus-resources.c:286
_dbus_get_is_errno_enomem
dbus_bool_t _dbus_get_is_errno_enomem(int e)
See if errno is ENOMEM.
Definition: dbus-sysdeps.c:705
_DBUS_POLLERR
#define _DBUS_POLLERR
Error condition.
Definition: dbus-sysdeps.h:394
DBusTransportSocket::encoded_outgoing
DBusString encoded_outgoing
Encoded version of current outgoing message.
Definition: dbus-transport-socket.c:63
_dbus_counter_get_size_value
long _dbus_counter_get_size_value(DBusCounter *counter)
Gets the current value of the size counter.
Definition: dbus-resources.c:274