1 /* GDBus - GLib D-Bus Library
3 * Copyright (C) 2008-2010 Red Hat, Inc.
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General
16 * Public License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
18 * Boston, MA 02111-1307, USA.
20 * Author: David Zeuthen <davidz@redhat.com>
33 #include "gdbusprivate.h"
34 #include "gdbusmessage.h"
35 #include "gdbuserror.h"
36 #include "gdbusintrospection.h"
37 #include "gasyncresult.h"
38 #include "gsimpleasyncresult.h"
39 #include "ginputstream.h"
40 #include "giostream.h"
41 #include "gsocketcontrolmessage.h"
42 #include "gsocketconnection.h"
43 #include "gsocketoutputstream.h"
46 #include "gunixfdmessage.h"
47 #include "gunixconnection.h"
48 #include "gunixcredentialsmessage.h"
57 /* ---------------------------------------------------------------------------------------------------- */
60 _g_dbus_hexdump (const gchar *data, gsize len, guint indent)
65 ret = g_string_new (NULL);
67 for (n = 0; n < len; n += 16)
69 g_string_append_printf (ret, "%*s%04x: ", indent, "", n);
71 for (m = n; m < n + 16; m++)
73 if (m > n && (m%4) == 0)
74 g_string_append_c (ret, ' ');
76 g_string_append_printf (ret, "%02x ", (guchar) data[m]);
78 g_string_append (ret, " ");
81 g_string_append (ret, " ");
83 for (m = n; m < len && m < n + 16; m++)
84 g_string_append_c (ret, g_ascii_isprint (data[m]) ? data[m] : '.');
86 g_string_append_c (ret, '\n');
89 return g_string_free (ret, FALSE);
92 /* ---------------------------------------------------------------------------------------------------- */
94 /* Unfortunately ancillary messages are discarded when reading from a
95 * socket using the GSocketInputStream abstraction. So we provide a
96 * very GInputStream-ish API that uses GSocket in this case (very
97 * similar to GSocketInputStream).
103 GCancellable *cancellable;
108 GSocketControlMessage ***messages;
111 GSimpleAsyncResult *simple;
113 gboolean from_mainloop;
114 } ReadWithControlData;
117 read_with_control_data_free (ReadWithControlData *data)
119 g_object_unref (data->socket);
120 if (data->cancellable != NULL)
121 g_object_unref (data->cancellable);
122 g_object_unref (data->simple);
127 _g_socket_read_with_control_messages_ready (GSocket *socket,
128 GIOCondition condition,
131 ReadWithControlData *data = user_data;
137 vector.buffer = data->buffer;
138 vector.size = data->count;
139 result = g_socket_receive_message (data->socket,
150 g_simple_async_result_set_op_res_gssize (data->simple, result);
154 g_assert (error != NULL);
155 g_simple_async_result_set_from_error (data->simple, error);
156 g_error_free (error);
159 if (data->from_mainloop)
160 g_simple_async_result_complete (data->simple);
162 g_simple_async_result_complete_in_idle (data->simple);
168 _g_socket_read_with_control_messages (GSocket *socket,
171 GSocketControlMessage ***messages,
174 GCancellable *cancellable,
175 GAsyncReadyCallback callback,
178 ReadWithControlData *data;
180 data = g_new0 (ReadWithControlData, 1);
181 data->socket = g_object_ref (socket);
182 data->cancellable = cancellable != NULL ? g_object_ref (cancellable) : NULL;
183 data->buffer = buffer;
185 data->messages = messages;
186 data->num_messages = num_messages;
188 data->simple = g_simple_async_result_new (G_OBJECT (socket),
191 _g_socket_read_with_control_messages);
193 if (!g_socket_condition_check (socket, G_IO_IN))
196 data->from_mainloop = TRUE;
197 source = g_socket_create_source (data->socket,
198 G_IO_IN | G_IO_HUP | G_IO_ERR,
200 g_source_set_callback (source,
201 (GSourceFunc) _g_socket_read_with_control_messages_ready,
203 (GDestroyNotify) read_with_control_data_free);
204 g_source_attach (source, g_main_context_get_thread_default ());
205 g_source_unref (source);
209 _g_socket_read_with_control_messages_ready (data->socket, G_IO_IN, data);
210 read_with_control_data_free (data);
215 _g_socket_read_with_control_messages_finish (GSocket *socket,
216 GAsyncResult *result,
219 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
221 g_return_val_if_fail (G_IS_SOCKET (socket), -1);
222 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == _g_socket_read_with_control_messages);
224 if (g_simple_async_result_propagate_error (simple, error))
227 return g_simple_async_result_get_op_res_gssize (simple);
230 /* ---------------------------------------------------------------------------------------------------- */
232 /* Work-around for https://bugzilla.gnome.org/show_bug.cgi?id=627724 */
234 static GPtrArray *ensured_classes = NULL;
237 ensure_type (GType gtype)
239 g_ptr_array_add (ensured_classes, g_type_class_ref (gtype));
243 released_required_types (void)
245 g_ptr_array_foreach (ensured_classes, (GFunc) g_type_class_unref, NULL);
246 g_ptr_array_unref (ensured_classes);
247 ensured_classes = NULL;
251 ensure_required_types (void)
253 g_assert (ensured_classes == NULL);
254 ensured_classes = g_ptr_array_new ();
255 ensure_type (G_TYPE_SIMPLE_ASYNC_RESULT);
256 ensure_type (G_TYPE_MEMORY_INPUT_STREAM);
258 /* ---------------------------------------------------------------------------------------------------- */
260 G_LOCK_DEFINE_STATIC (shared_thread_lock);
266 GMainContext *context;
270 static SharedThreadData *shared_thread_data = NULL;
273 gdbus_shared_thread_func (gpointer data)
275 g_main_context_push_thread_default (shared_thread_data->context);
276 g_main_loop_run (shared_thread_data->loop);
277 g_main_context_pop_thread_default (shared_thread_data->context);
281 typedef void (*GDBusSharedThreadFunc) (gpointer user_data);
285 GDBusSharedThreadFunc func;
291 invoke_caller (gpointer user_data)
293 CallerData *data = user_data;
294 data->func (data->user_data);
299 /* ---------------------------------------------------------------------------------------------------- */
302 _g_dbus_shared_thread_ref (GDBusSharedThreadFunc func,
306 GSource *idle_source;
308 gboolean release_types;
310 G_LOCK (shared_thread_lock);
312 release_types = FALSE;
314 if (shared_thread_data != NULL)
316 shared_thread_data->num_users += 1;
320 shared_thread_data = g_new0 (SharedThreadData, 1);
321 shared_thread_data->num_users = 1;
323 /* Work-around for https://bugzilla.gnome.org/show_bug.cgi?id=627724 */
324 ensure_required_types ();
325 release_types = TRUE;
328 shared_thread_data->context = g_main_context_new ();
329 shared_thread_data->loop = g_main_loop_new (shared_thread_data->context, FALSE);
330 shared_thread_data->thread = g_thread_create (gdbus_shared_thread_func,
334 g_assert_no_error (error);
338 data = g_new0 (CallerData, 1);
340 data->user_data = user_data;
343 idle_source = g_idle_source_new ();
344 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
345 g_source_set_callback (idle_source,
349 g_source_attach (idle_source, shared_thread_data->context);
350 g_source_unref (idle_source);
352 /* wait for the user code to run.. hmm.. probably use a condition variable instead */
357 released_required_types ();
361 G_UNLOCK (shared_thread_lock);
365 _g_dbus_shared_thread_unref (void)
367 /* TODO: actually destroy the shared thread here */
369 G_LOCK (shared_thread_lock);
370 g_assert (shared_thread_data != NULL);
371 shared_thread_data->num_users -= 1;
372 if (shared_thread_data->num_users == 0)
374 g_main_loop_quit (shared_thread_data->loop);
375 //g_thread_join (shared_thread_data->thread);
376 g_main_loop_unref (shared_thread_data->loop);
377 g_main_context_unref (shared_thread_data->context);
378 g_free (shared_thread_data);
379 shared_thread_data = NULL;
380 G_UNLOCK (shared_thread_lock);
384 G_UNLOCK (shared_thread_lock);
389 /* ---------------------------------------------------------------------------------------------------- */
393 volatile gint ref_count;
397 /* TODO: frozen (e.g. G_DBUS_CONNECTION_FLAGS_DELAY_MESSAGE_PROCESSING) currently
398 * only affects messages received from the other peer (since GDBusServer is the
399 * only user) - we might want it to affect messages sent to the other peer too?
402 GQueue *received_messages_while_frozen;
405 GDBusCapabilityFlags capabilities;
406 GCancellable *cancellable;
407 GDBusWorkerMessageReceivedCallback message_received_callback;
408 GDBusWorkerMessageAboutToBeSentCallback message_about_to_be_sent_callback;
409 GDBusWorkerDisconnectedCallback disconnected_callback;
414 /* if not NULL, stream is GSocketConnection */
417 /* used for reading */
420 gsize read_buffer_allocated_size;
421 gsize read_buffer_cur_size;
422 gsize read_buffer_bytes_wanted;
423 GUnixFDList *read_fd_list;
424 GSocketControlMessage **read_ancillary_messages;
425 gint read_num_ancillary_messages;
427 /* used for writing */
430 gint num_writes_pending;
431 guint64 write_num_messages_written;
432 GList *write_pending_flushes;
435 /* ---------------------------------------------------------------------------------------------------- */
441 guint64 number_to_wait_for;
445 struct _MessageToWriteData ;
446 typedef struct _MessageToWriteData MessageToWriteData;
448 static void message_to_write_data_free (MessageToWriteData *data);
450 static void read_message_print_transport_debug (gssize bytes_read,
451 GDBusWorker *worker);
453 static void write_message_print_transport_debug (gssize bytes_written,
454 MessageToWriteData *data);
456 /* ---------------------------------------------------------------------------------------------------- */
459 _g_dbus_worker_ref (GDBusWorker *worker)
461 g_atomic_int_inc (&worker->ref_count);
466 _g_dbus_worker_unref (GDBusWorker *worker)
468 if (g_atomic_int_dec_and_test (&worker->ref_count))
470 g_assert (worker->write_pending_flushes == NULL);
472 _g_dbus_shared_thread_unref ();
474 g_object_unref (worker->stream);
476 g_mutex_free (worker->read_lock);
477 g_object_unref (worker->cancellable);
478 if (worker->read_fd_list != NULL)
479 g_object_unref (worker->read_fd_list);
481 g_queue_foreach (worker->received_messages_while_frozen, (GFunc) g_object_unref, NULL);
482 g_queue_free (worker->received_messages_while_frozen);
484 g_mutex_free (worker->write_lock);
485 g_queue_foreach (worker->write_queue, (GFunc) message_to_write_data_free, NULL);
486 g_queue_free (worker->write_queue);
488 g_free (worker->read_buffer);
495 _g_dbus_worker_emit_disconnected (GDBusWorker *worker,
496 gboolean remote_peer_vanished,
499 if (!worker->stopped)
500 worker->disconnected_callback (worker, remote_peer_vanished, error, worker->user_data);
504 _g_dbus_worker_emit_message_received (GDBusWorker *worker,
505 GDBusMessage *message)
507 if (!worker->stopped)
508 worker->message_received_callback (worker, message, worker->user_data);
511 static GDBusMessage *
512 _g_dbus_worker_emit_message_about_to_be_sent (GDBusWorker *worker,
513 GDBusMessage *message)
516 if (!worker->stopped)
517 ret = worker->message_about_to_be_sent_callback (worker, message, worker->user_data);
523 /* can only be called from private thread with read-lock held - takes ownership of @message */
525 _g_dbus_worker_queue_or_deliver_received_message (GDBusWorker *worker,
526 GDBusMessage *message)
528 if (worker->frozen || g_queue_get_length (worker->received_messages_while_frozen) > 0)
531 g_queue_push_tail (worker->received_messages_while_frozen, message);
535 /* not frozen, nor anything in queue */
536 _g_dbus_worker_emit_message_received (worker, message);
537 g_object_unref (message);
541 /* called in private thread shared by all GDBusConnection instances (without read-lock held) */
543 unfreeze_in_idle_cb (gpointer user_data)
545 GDBusWorker *worker = user_data;
546 GDBusMessage *message;
548 g_mutex_lock (worker->read_lock);
551 while ((message = g_queue_pop_head (worker->received_messages_while_frozen)) != NULL)
553 _g_dbus_worker_emit_message_received (worker, message);
554 g_object_unref (message);
556 worker->frozen = FALSE;
560 g_assert (g_queue_get_length (worker->received_messages_while_frozen) == 0);
562 g_mutex_unlock (worker->read_lock);
566 /* can be called from any thread */
568 _g_dbus_worker_unfreeze (GDBusWorker *worker)
570 GSource *idle_source;
571 idle_source = g_idle_source_new ();
572 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
573 g_source_set_callback (idle_source,
575 _g_dbus_worker_ref (worker),
576 (GDestroyNotify) _g_dbus_worker_unref);
577 g_source_attach (idle_source, shared_thread_data->context);
578 g_source_unref (idle_source);
581 /* ---------------------------------------------------------------------------------------------------- */
583 static void _g_dbus_worker_do_read_unlocked (GDBusWorker *worker);
585 /* called in private thread shared by all GDBusConnection instances (without read-lock held) */
587 _g_dbus_worker_do_read_cb (GInputStream *input_stream,
591 GDBusWorker *worker = user_data;
595 g_mutex_lock (worker->read_lock);
597 /* If already stopped, don't even process the reply */
602 if (worker->socket == NULL)
603 bytes_read = g_input_stream_read_finish (g_io_stream_get_input_stream (worker->stream),
607 bytes_read = _g_socket_read_with_control_messages_finish (worker->socket,
610 if (worker->read_num_ancillary_messages > 0)
613 for (n = 0; n < worker->read_num_ancillary_messages; n++)
615 GSocketControlMessage *control_message = G_SOCKET_CONTROL_MESSAGE (worker->read_ancillary_messages[n]);
621 else if (G_IS_UNIX_FD_MESSAGE (control_message))
623 GUnixFDMessage *fd_message;
627 fd_message = G_UNIX_FD_MESSAGE (control_message);
628 fds = g_unix_fd_message_steal_fds (fd_message, &num_fds);
629 if (worker->read_fd_list == NULL)
631 worker->read_fd_list = g_unix_fd_list_new_from_array (fds, num_fds);
636 for (n = 0; n < num_fds; n++)
638 /* TODO: really want a append_steal() */
639 g_unix_fd_list_append (worker->read_fd_list, fds[n], NULL);
645 else if (G_IS_UNIX_CREDENTIALS_MESSAGE (control_message))
657 "Unexpected ancillary message of type %s received from peer",
658 g_type_name (G_TYPE_FROM_INSTANCE (control_message)));
659 _g_dbus_worker_emit_disconnected (worker, TRUE, error);
660 g_error_free (error);
661 g_object_unref (control_message);
663 while (n < worker->read_num_ancillary_messages)
664 g_object_unref (worker->read_ancillary_messages[n++]);
665 g_free (worker->read_ancillary_messages);
669 g_object_unref (control_message);
671 g_free (worker->read_ancillary_messages);
674 if (bytes_read == -1)
676 _g_dbus_worker_emit_disconnected (worker, TRUE, error);
677 g_error_free (error);
682 g_debug ("read %d bytes (is_closed=%d blocking=%d condition=0x%02x) stream %p, %p",
684 g_socket_is_closed (g_socket_connection_get_socket (G_SOCKET_CONNECTION (worker->stream))),
685 g_socket_get_blocking (g_socket_connection_get_socket (G_SOCKET_CONNECTION (worker->stream))),
686 g_socket_condition_check (g_socket_connection_get_socket (G_SOCKET_CONNECTION (worker->stream)),
687 G_IO_IN | G_IO_OUT | G_IO_HUP),
692 /* TODO: hmm, hmm... */
698 "Underlying GIOStream returned 0 bytes on an async read");
699 _g_dbus_worker_emit_disconnected (worker, TRUE, error);
700 g_error_free (error);
704 read_message_print_transport_debug (bytes_read, worker);
706 worker->read_buffer_cur_size += bytes_read;
707 if (worker->read_buffer_bytes_wanted == worker->read_buffer_cur_size)
709 /* OK, got what we asked for! */
710 if (worker->read_buffer_bytes_wanted == 16)
713 /* OK, got the header - determine how many more bytes are needed */
715 message_len = g_dbus_message_bytes_needed ((guchar *) worker->read_buffer,
718 if (message_len == -1)
720 g_warning ("_g_dbus_worker_do_read_cb: error determing bytes needed: %s", error->message);
721 _g_dbus_worker_emit_disconnected (worker, FALSE, error);
722 g_error_free (error);
726 worker->read_buffer_bytes_wanted = message_len;
727 _g_dbus_worker_do_read_unlocked (worker);
731 GDBusMessage *message;
734 /* TODO: use connection->priv->auth to decode the message */
736 message = g_dbus_message_new_from_blob ((guchar *) worker->read_buffer,
737 worker->read_buffer_cur_size,
738 worker->capabilities,
743 s = _g_dbus_hexdump (worker->read_buffer, worker->read_buffer_cur_size, 2);
744 g_warning ("Error decoding D-Bus message of %" G_GSIZE_FORMAT " bytes\n"
746 "The payload is as follows:\n"
748 worker->read_buffer_cur_size,
752 _g_dbus_worker_emit_disconnected (worker, FALSE, error);
753 g_error_free (error);
758 if (worker->read_fd_list != NULL)
760 g_dbus_message_set_unix_fd_list (message, worker->read_fd_list);
761 g_object_unref (worker->read_fd_list);
762 worker->read_fd_list = NULL;
766 if (G_UNLIKELY (_g_dbus_debug_message ()))
769 _g_dbus_debug_print_lock ();
770 g_print ("========================================================================\n"
771 "GDBus-debug:Message:\n"
772 " <<<< RECEIVED D-Bus message (%" G_GSIZE_FORMAT " bytes)\n",
773 worker->read_buffer_cur_size);
774 s = g_dbus_message_print (message, 2);
777 if (G_UNLIKELY (_g_dbus_debug_payload ()))
779 s = _g_dbus_hexdump (worker->read_buffer, worker->read_buffer_cur_size, 2);
783 _g_dbus_debug_print_unlock ();
786 /* yay, got a message, go deliver it */
787 _g_dbus_worker_queue_or_deliver_received_message (worker, message);
789 /* start reading another message! */
790 worker->read_buffer_bytes_wanted = 0;
791 worker->read_buffer_cur_size = 0;
792 _g_dbus_worker_do_read_unlocked (worker);
797 /* didn't get all the bytes we requested - so repeat the request... */
798 _g_dbus_worker_do_read_unlocked (worker);
802 g_mutex_unlock (worker->read_lock);
804 /* gives up the reference acquired when calling g_input_stream_read_async() */
805 _g_dbus_worker_unref (worker);
808 /* called in private thread shared by all GDBusConnection instances (with read-lock held) */
810 _g_dbus_worker_do_read_unlocked (GDBusWorker *worker)
812 /* if bytes_wanted is zero, it means start reading a message */
813 if (worker->read_buffer_bytes_wanted == 0)
815 worker->read_buffer_cur_size = 0;
816 worker->read_buffer_bytes_wanted = 16;
819 /* ensure we have a (big enough) buffer */
820 if (worker->read_buffer == NULL || worker->read_buffer_bytes_wanted > worker->read_buffer_allocated_size)
822 /* TODO: 4096 is randomly chosen; might want a better chosen default minimum */
823 worker->read_buffer_allocated_size = MAX (worker->read_buffer_bytes_wanted, 4096);
824 worker->read_buffer = g_realloc (worker->read_buffer, worker->read_buffer_allocated_size);
827 if (worker->socket == NULL)
828 g_input_stream_read_async (g_io_stream_get_input_stream (worker->stream),
829 worker->read_buffer + worker->read_buffer_cur_size,
830 worker->read_buffer_bytes_wanted - worker->read_buffer_cur_size,
833 (GAsyncReadyCallback) _g_dbus_worker_do_read_cb,
834 _g_dbus_worker_ref (worker));
837 worker->read_ancillary_messages = NULL;
838 worker->read_num_ancillary_messages = 0;
839 _g_socket_read_with_control_messages (worker->socket,
840 worker->read_buffer + worker->read_buffer_cur_size,
841 worker->read_buffer_bytes_wanted - worker->read_buffer_cur_size,
842 &worker->read_ancillary_messages,
843 &worker->read_num_ancillary_messages,
846 (GAsyncReadyCallback) _g_dbus_worker_do_read_cb,
847 _g_dbus_worker_ref (worker));
851 /* called in private thread shared by all GDBusConnection instances (without read-lock held) */
853 _g_dbus_worker_do_read (GDBusWorker *worker)
855 g_mutex_lock (worker->read_lock);
856 _g_dbus_worker_do_read_unlocked (worker);
857 g_mutex_unlock (worker->read_lock);
860 /* ---------------------------------------------------------------------------------------------------- */
862 struct _MessageToWriteData
865 GDBusMessage *message;
870 GSimpleAsyncResult *simple;
875 message_to_write_data_free (MessageToWriteData *data)
877 _g_dbus_worker_unref (data->worker);
878 g_object_unref (data->message);
883 /* ---------------------------------------------------------------------------------------------------- */
885 static void write_message_continue_writing (MessageToWriteData *data);
887 /* called in private thread shared by all GDBusConnection instances (without write-lock held) */
889 write_message_async_cb (GObject *source_object,
893 MessageToWriteData *data = user_data;
894 GSimpleAsyncResult *simple;
895 gssize bytes_written;
898 /* Note: we can't access data->simple after calling g_async_result_complete () because the
899 * callback can free @data and we're not completing in idle. So use a copy of the pointer.
901 simple = data->simple;
904 bytes_written = g_output_stream_write_finish (G_OUTPUT_STREAM (source_object),
907 if (bytes_written == -1)
909 g_simple_async_result_set_from_error (simple, error);
910 g_error_free (error);
911 g_simple_async_result_complete (simple);
912 g_object_unref (simple);
915 g_assert (bytes_written > 0); /* zero is never returned */
917 write_message_print_transport_debug (bytes_written, data);
919 data->total_written += bytes_written;
920 g_assert (data->total_written <= data->blob_size);
921 if (data->total_written == data->blob_size)
923 g_simple_async_result_complete (simple);
924 g_object_unref (simple);
928 write_message_continue_writing (data);
934 /* called in private thread shared by all GDBusConnection instances (without write-lock held) */
936 on_socket_ready (GSocket *socket,
937 GIOCondition condition,
940 MessageToWriteData *data = user_data;
941 write_message_continue_writing (data);
942 return FALSE; /* remove source */
945 /* called in private thread shared by all GDBusConnection instances (without write-lock held) */
947 write_message_continue_writing (MessageToWriteData *data)
949 GOutputStream *ostream;
950 GSimpleAsyncResult *simple;
952 GUnixFDList *fd_list;
955 /* Note: we can't access data->simple after calling g_async_result_complete () because the
956 * callback can free @data and we're not completing in idle. So use a copy of the pointer.
958 simple = data->simple;
960 ostream = g_io_stream_get_output_stream (data->worker->stream);
962 fd_list = g_dbus_message_get_unix_fd_list (data->message);
965 g_assert (!g_output_stream_has_pending (ostream));
966 g_assert_cmpint (data->total_written, <, data->blob_size);
972 else if (G_IS_SOCKET_OUTPUT_STREAM (ostream) && data->total_written == 0)
974 GOutputVector vector;
975 GSocketControlMessage *control_message;
976 gssize bytes_written;
979 vector.buffer = data->blob;
980 vector.size = data->blob_size;
982 control_message = NULL;
983 if (fd_list != NULL && g_unix_fd_list_get_length (fd_list) > 0)
985 if (!(data->worker->capabilities & G_DBUS_CAPABILITY_FLAGS_UNIX_FD_PASSING))
987 g_simple_async_result_set_error (simple,
990 "Tried sending a file descriptor but remote peer does not support this capability");
991 g_simple_async_result_complete (simple);
992 g_object_unref (simple);
995 control_message = g_unix_fd_message_new_with_fd_list (fd_list);
999 bytes_written = g_socket_send_message (data->worker->socket,
1003 control_message != NULL ? &control_message : NULL,
1004 control_message != NULL ? 1 : 0,
1006 data->worker->cancellable,
1008 if (control_message != NULL)
1009 g_object_unref (control_message);
1011 if (bytes_written == -1)
1013 /* Handle WOULD_BLOCK by waiting until there's room in the buffer */
1014 if (g_error_matches (error, G_IO_ERROR, G_IO_ERROR_WOULD_BLOCK))
1017 source = g_socket_create_source (data->worker->socket,
1018 G_IO_OUT | G_IO_HUP | G_IO_ERR,
1019 data->worker->cancellable);
1020 g_source_set_callback (source,
1021 (GSourceFunc) on_socket_ready,
1023 NULL); /* GDestroyNotify */
1024 g_source_attach (source, g_main_context_get_thread_default ());
1025 g_source_unref (source);
1026 g_error_free (error);
1029 g_simple_async_result_set_from_error (simple, error);
1030 g_error_free (error);
1031 g_simple_async_result_complete (simple);
1032 g_object_unref (simple);
1035 g_assert (bytes_written > 0); /* zero is never returned */
1037 write_message_print_transport_debug (bytes_written, data);
1039 data->total_written += bytes_written;
1040 g_assert (data->total_written <= data->blob_size);
1041 if (data->total_written == data->blob_size)
1043 g_simple_async_result_complete (simple);
1044 g_object_unref (simple);
1048 write_message_continue_writing (data);
1054 if (fd_list != NULL)
1056 g_simple_async_result_set_error (simple,
1059 "Tried sending a file descriptor on unsupported stream of type %s",
1060 g_type_name (G_TYPE_FROM_INSTANCE (ostream)));
1061 g_simple_async_result_complete (simple);
1062 g_object_unref (simple);
1067 g_output_stream_write_async (ostream,
1068 (const gchar *) data->blob + data->total_written,
1069 data->blob_size - data->total_written,
1071 data->worker->cancellable,
1072 write_message_async_cb,
1079 /* called in private thread shared by all GDBusConnection instances (without write-lock held) */
1081 write_message_async (GDBusWorker *worker,
1082 MessageToWriteData *data,
1083 GAsyncReadyCallback callback,
1086 data->simple = g_simple_async_result_new (NULL,
1089 write_message_async);
1090 data->total_written = 0;
1091 write_message_continue_writing (data);
1094 /* called in private thread shared by all GDBusConnection instances (without write-lock held) */
1096 write_message_finish (GAsyncResult *res,
1099 g_warn_if_fail (g_simple_async_result_get_source_tag (G_SIMPLE_ASYNC_RESULT (res)) == write_message_async);
1100 if (g_simple_async_result_propagate_error (G_SIMPLE_ASYNC_RESULT (res), error))
1105 /* ---------------------------------------------------------------------------------------------------- */
1107 static void maybe_write_next_message (GDBusWorker *worker);
1111 GDBusWorker *worker;
1115 /* called in private thread shared by all GDBusConnection instances (without write-lock held) */
1117 ostream_flush_cb (GObject *source_object,
1121 FlushAsyncData *data = user_data;
1126 g_output_stream_flush_finish (G_OUTPUT_STREAM (source_object),
1132 if (G_UNLIKELY (_g_dbus_debug_transport ()))
1134 _g_dbus_debug_print_lock ();
1135 g_print ("========================================================================\n"
1136 "GDBus-debug:Transport:\n"
1137 " ---- FLUSHED stream of type %s\n",
1138 g_type_name (G_TYPE_FROM_INSTANCE (g_io_stream_get_output_stream (data->worker->stream))));
1139 _g_dbus_debug_print_unlock ();
1143 g_assert (data->flushers != NULL);
1144 for (l = data->flushers; l != NULL; l = l->next)
1146 FlushData *f = l->data;
1148 f->error = error != NULL ? g_error_copy (error) : NULL;
1150 g_mutex_lock (f->mutex);
1151 g_cond_signal (f->cond);
1152 g_mutex_unlock (f->mutex);
1154 g_list_free (data->flushers);
1157 g_error_free (error);
1159 /* OK, cool, finally kick off the next write */
1160 maybe_write_next_message (data->worker);
1162 _g_dbus_worker_unref (data->worker);
1166 /* called in private thread shared by all GDBusConnection instances (without write-lock held) */
1168 message_written (GDBusWorker *worker,
1169 MessageToWriteData *message_data)
1175 /* first log the fact that we wrote a message */
1176 if (G_UNLIKELY (_g_dbus_debug_message ()))
1179 _g_dbus_debug_print_lock ();
1180 g_print ("========================================================================\n"
1181 "GDBus-debug:Message:\n"
1182 " >>>> SENT D-Bus message (%" G_GSIZE_FORMAT " bytes)\n",
1183 message_data->blob_size);
1184 s = g_dbus_message_print (message_data->message, 2);
1187 if (G_UNLIKELY (_g_dbus_debug_payload ()))
1189 s = _g_dbus_hexdump (message_data->blob, message_data->blob_size, 2);
1190 g_print ("%s\n", s);
1193 _g_dbus_debug_print_unlock ();
1196 /* then first wake up pending flushes and, if needed, flush the stream */
1198 g_mutex_lock (worker->write_lock);
1199 worker->write_num_messages_written += 1;
1200 for (l = worker->write_pending_flushes; l != NULL; l = ll)
1202 FlushData *f = l->data;
1205 if (f->number_to_wait_for == worker->write_num_messages_written)
1207 flushers = g_list_append (flushers, f);
1208 worker->write_pending_flushes = g_list_delete_link (worker->write_pending_flushes, l);
1211 g_mutex_unlock (worker->write_lock);
1213 if (flushers != NULL)
1215 FlushAsyncData *data;
1216 data = g_new0 (FlushAsyncData, 1);
1217 data->worker = _g_dbus_worker_ref (worker);
1218 data->flushers = flushers;
1219 /* flush the stream before writing the next message */
1220 g_output_stream_flush_async (g_io_stream_get_output_stream (worker->stream),
1222 worker->cancellable,
1228 /* kick off the next write! */
1229 maybe_write_next_message (worker);
1233 /* called in private thread shared by all GDBusConnection instances (without write-lock held) */
1235 write_message_cb (GObject *source_object,
1239 MessageToWriteData *data = user_data;
1242 g_mutex_lock (data->worker->write_lock);
1243 data->worker->num_writes_pending -= 1;
1244 g_mutex_unlock (data->worker->write_lock);
1247 if (!write_message_finish (res, &error))
1250 _g_dbus_worker_emit_disconnected (data->worker, TRUE, error);
1251 g_error_free (error);
1254 /* this function will also kick of the next write (it might need to
1255 * flush so writing the next message might happen much later
1258 message_written (data->worker, data);
1260 message_to_write_data_free (data);
1263 /* called in private thread shared by all GDBusConnection instances (without write-lock held) */
1265 maybe_write_next_message (GDBusWorker *worker)
1267 MessageToWriteData *data;
1271 g_mutex_lock (worker->write_lock);
1272 data = g_queue_pop_head (worker->write_queue);
1274 worker->num_writes_pending += 1;
1275 g_mutex_unlock (worker->write_lock);
1277 /* Note that write_lock is only used for protecting the @write_queue
1278 * and @num_writes_pending fields of the GDBusWorker struct ... which we
1279 * need to modify from arbitrary threads in _g_dbus_worker_send_message().
1281 * Therefore, it's fine to drop it here when calling back into user
1282 * code and then writing the message out onto the GIOStream since this
1283 * function only runs on the worker thread.
1287 GDBusMessage *old_message;
1289 gsize new_blob_size;
1292 old_message = data->message;
1293 data->message = _g_dbus_worker_emit_message_about_to_be_sent (worker, data->message);
1294 if (data->message == old_message)
1296 /* filters had no effect - do nothing */
1298 else if (data->message == NULL)
1300 /* filters dropped message */
1301 g_mutex_lock (worker->write_lock);
1302 worker->num_writes_pending -= 1;
1303 g_mutex_unlock (worker->write_lock);
1304 message_to_write_data_free (data);
1309 /* filters altered the message -> reencode */
1311 new_blob = g_dbus_message_to_blob (data->message,
1313 worker->capabilities,
1315 if (new_blob == NULL)
1317 /* if filter make the GDBusMessage unencodeable, just complain on stderr and send
1318 * the old message instead
1320 g_warning ("Error encoding GDBusMessage with serial %d altered by filter function: %s",
1321 g_dbus_message_get_serial (data->message),
1323 g_error_free (error);
1327 g_free (data->blob);
1328 data->blob = (gchar *) new_blob;
1329 data->blob_size = new_blob_size;
1333 write_message_async (worker,
1340 /* called in private thread shared by all GDBusConnection instances (without write-lock held) */
1342 write_message_in_idle_cb (gpointer user_data)
1344 GDBusWorker *worker = user_data;
1345 if (worker->num_writes_pending == 0)
1346 maybe_write_next_message (worker);
1350 /* ---------------------------------------------------------------------------------------------------- */
1352 /* can be called from any thread - steals blob */
1354 _g_dbus_worker_send_message (GDBusWorker *worker,
1355 GDBusMessage *message,
1359 MessageToWriteData *data;
1361 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
1362 g_return_if_fail (blob != NULL);
1363 g_return_if_fail (blob_len > 16);
1365 data = g_new0 (MessageToWriteData, 1);
1366 data->worker = _g_dbus_worker_ref (worker);
1367 data->message = g_object_ref (message);
1368 data->blob = blob; /* steal! */
1369 data->blob_size = blob_len;
1371 g_mutex_lock (worker->write_lock);
1372 g_queue_push_tail (worker->write_queue, data);
1373 if (worker->num_writes_pending == 0)
1375 GSource *idle_source;
1376 idle_source = g_idle_source_new ();
1377 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
1378 g_source_set_callback (idle_source,
1379 write_message_in_idle_cb,
1380 _g_dbus_worker_ref (worker),
1381 (GDestroyNotify) _g_dbus_worker_unref);
1382 g_source_attach (idle_source, shared_thread_data->context);
1383 g_source_unref (idle_source);
1385 g_mutex_unlock (worker->write_lock);
1388 /* ---------------------------------------------------------------------------------------------------- */
1391 _g_dbus_worker_thread_begin_func (gpointer user_data)
1393 GDBusWorker *worker = user_data;
1395 worker->thread = g_thread_self ();
1398 _g_dbus_worker_do_read (worker);
1402 _g_dbus_worker_new (GIOStream *stream,
1403 GDBusCapabilityFlags capabilities,
1404 gboolean initially_frozen,
1405 GDBusWorkerMessageReceivedCallback message_received_callback,
1406 GDBusWorkerMessageAboutToBeSentCallback message_about_to_be_sent_callback,
1407 GDBusWorkerDisconnectedCallback disconnected_callback,
1410 GDBusWorker *worker;
1412 g_return_val_if_fail (G_IS_IO_STREAM (stream), NULL);
1413 g_return_val_if_fail (message_received_callback != NULL, NULL);
1414 g_return_val_if_fail (message_about_to_be_sent_callback != NULL, NULL);
1415 g_return_val_if_fail (disconnected_callback != NULL, NULL);
1417 worker = g_new0 (GDBusWorker, 1);
1418 worker->ref_count = 1;
1420 worker->read_lock = g_mutex_new ();
1421 worker->message_received_callback = message_received_callback;
1422 worker->message_about_to_be_sent_callback = message_about_to_be_sent_callback;
1423 worker->disconnected_callback = disconnected_callback;
1424 worker->user_data = user_data;
1425 worker->stream = g_object_ref (stream);
1426 worker->capabilities = capabilities;
1427 worker->cancellable = g_cancellable_new ();
1429 worker->frozen = initially_frozen;
1430 worker->received_messages_while_frozen = g_queue_new ();
1432 worker->write_lock = g_mutex_new ();
1433 worker->write_queue = g_queue_new ();
1435 if (G_IS_SOCKET_CONNECTION (worker->stream))
1436 worker->socket = g_socket_connection_get_socket (G_SOCKET_CONNECTION (worker->stream));
1438 _g_dbus_shared_thread_ref (_g_dbus_worker_thread_begin_func, worker);
1443 /* ---------------------------------------------------------------------------------------------------- */
1445 /* This can be called from any thread - frees worker - guarantees no callbacks
1446 * will ever be issued again
1449 _g_dbus_worker_stop (GDBusWorker *worker)
1451 /* If we're called in the worker thread it means we are called from
1452 * a worker callback. This is fine, we just can't lock in that case since
1453 * we're already holding the lock...
1455 if (g_thread_self () != worker->thread)
1456 g_mutex_lock (worker->read_lock);
1457 worker->stopped = TRUE;
1458 if (g_thread_self () != worker->thread)
1459 g_mutex_unlock (worker->read_lock);
1461 g_cancellable_cancel (worker->cancellable);
1462 _g_dbus_worker_unref (worker);
1465 /* ---------------------------------------------------------------------------------------------------- */
1467 /* can be called from any thread (except the worker thread) - blocks
1468 * calling thread until all queued outgoing messages are written and
1469 * the transport has been flushed
1472 _g_dbus_worker_flush_sync (GDBusWorker *worker,
1473 GCancellable *cancellable,
1482 /* if the queue is empty, there's nothing to wait for */
1483 g_mutex_lock (worker->write_lock);
1484 if (g_queue_get_length (worker->write_queue) > 0)
1486 data = g_new0 (FlushData, 1);
1487 data->mutex = g_mutex_new ();
1488 data->cond = g_cond_new ();
1489 data->number_to_wait_for = worker->write_num_messages_written + g_queue_get_length (worker->write_queue);
1490 g_mutex_lock (data->mutex);
1491 worker->write_pending_flushes = g_list_prepend (worker->write_pending_flushes, data);
1493 g_mutex_unlock (worker->write_lock);
1497 g_cond_wait (data->cond, data->mutex);
1498 g_mutex_unlock (data->mutex);
1500 /* note:the element is removed from worker->write_pending_flushes in flush_cb() above */
1501 g_cond_free (data->cond);
1502 g_mutex_free (data->mutex);
1503 if (data->error != NULL)
1506 g_propagate_error (error, data->error);
1514 /* ---------------------------------------------------------------------------------------------------- */
1516 #define G_DBUS_DEBUG_AUTHENTICATION (1<<0)
1517 #define G_DBUS_DEBUG_TRANSPORT (1<<1)
1518 #define G_DBUS_DEBUG_MESSAGE (1<<2)
1519 #define G_DBUS_DEBUG_PAYLOAD (1<<3)
1520 #define G_DBUS_DEBUG_CALL (1<<4)
1521 #define G_DBUS_DEBUG_SIGNAL (1<<5)
1522 #define G_DBUS_DEBUG_INCOMING (1<<6)
1523 #define G_DBUS_DEBUG_RETURN (1<<7)
1524 #define G_DBUS_DEBUG_EMISSION (1<<8)
1525 #define G_DBUS_DEBUG_ADDRESS (1<<9)
1527 static gint _gdbus_debug_flags = 0;
1530 _g_dbus_debug_authentication (void)
1532 _g_dbus_initialize ();
1533 return (_gdbus_debug_flags & G_DBUS_DEBUG_AUTHENTICATION) != 0;
1537 _g_dbus_debug_transport (void)
1539 _g_dbus_initialize ();
1540 return (_gdbus_debug_flags & G_DBUS_DEBUG_TRANSPORT) != 0;
1544 _g_dbus_debug_message (void)
1546 _g_dbus_initialize ();
1547 return (_gdbus_debug_flags & G_DBUS_DEBUG_MESSAGE) != 0;
1551 _g_dbus_debug_payload (void)
1553 _g_dbus_initialize ();
1554 return (_gdbus_debug_flags & G_DBUS_DEBUG_PAYLOAD) != 0;
1558 _g_dbus_debug_call (void)
1560 _g_dbus_initialize ();
1561 return (_gdbus_debug_flags & G_DBUS_DEBUG_CALL) != 0;
1565 _g_dbus_debug_signal (void)
1567 _g_dbus_initialize ();
1568 return (_gdbus_debug_flags & G_DBUS_DEBUG_SIGNAL) != 0;
1572 _g_dbus_debug_incoming (void)
1574 _g_dbus_initialize ();
1575 return (_gdbus_debug_flags & G_DBUS_DEBUG_INCOMING) != 0;
1579 _g_dbus_debug_return (void)
1581 _g_dbus_initialize ();
1582 return (_gdbus_debug_flags & G_DBUS_DEBUG_RETURN) != 0;
1586 _g_dbus_debug_emission (void)
1588 _g_dbus_initialize ();
1589 return (_gdbus_debug_flags & G_DBUS_DEBUG_EMISSION) != 0;
1593 _g_dbus_debug_address (void)
1595 _g_dbus_initialize ();
1596 return (_gdbus_debug_flags & G_DBUS_DEBUG_ADDRESS) != 0;
1599 G_LOCK_DEFINE_STATIC (print_lock);
1602 _g_dbus_debug_print_lock (void)
1604 G_LOCK (print_lock);
1608 _g_dbus_debug_print_unlock (void)
1610 G_UNLOCK (print_lock);
1614 * _g_dbus_initialize:
1616 * Does various one-time init things such as
1618 * - registering the G_DBUS_ERROR error domain
1619 * - parses the G_DBUS_DEBUG environment variable
1622 _g_dbus_initialize (void)
1624 static volatile gsize initialized = 0;
1626 if (g_once_init_enter (&initialized))
1628 volatile GQuark g_dbus_error_domain;
1631 g_dbus_error_domain = G_DBUS_ERROR;
1633 debug = g_getenv ("G_DBUS_DEBUG");
1636 const GDebugKey keys[] = {
1637 { "authentication", G_DBUS_DEBUG_AUTHENTICATION },
1638 { "transport", G_DBUS_DEBUG_TRANSPORT },
1639 { "message", G_DBUS_DEBUG_MESSAGE },
1640 { "payload", G_DBUS_DEBUG_PAYLOAD },
1641 { "call", G_DBUS_DEBUG_CALL },
1642 { "signal", G_DBUS_DEBUG_SIGNAL },
1643 { "incoming", G_DBUS_DEBUG_INCOMING },
1644 { "return", G_DBUS_DEBUG_RETURN },
1645 { "emission", G_DBUS_DEBUG_EMISSION },
1646 { "address", G_DBUS_DEBUG_ADDRESS }
1649 _gdbus_debug_flags = g_parse_debug_string (debug, keys, G_N_ELEMENTS (keys));
1650 if (_gdbus_debug_flags & G_DBUS_DEBUG_PAYLOAD)
1651 _gdbus_debug_flags |= G_DBUS_DEBUG_MESSAGE;
1654 g_once_init_leave (&initialized, 1);
1658 /* ---------------------------------------------------------------------------------------------------- */
1661 _g_dbus_compute_complete_signature (GDBusArgInfo **args)
1663 const GVariantType *arg_types[256];
1667 for (n = 0; args[n] != NULL; n++)
1669 /* DBus places a hard limit of 255 on signature length.
1670 * therefore number of args must be less than 256.
1674 arg_types[n] = G_VARIANT_TYPE (args[n]->signature);
1676 if G_UNLIKELY (arg_types[n] == NULL)
1682 return g_variant_type_new_tuple (arg_types, n);
1685 /* ---------------------------------------------------------------------------------------------------- */
1689 extern BOOL WINAPI ConvertSidToStringSidA (PSID Sid, LPSTR *StringSid);
1692 _g_dbus_win32_get_user_sid (void)
1696 DWORD token_information_len;
1703 h = INVALID_HANDLE_VALUE;
1705 if (!OpenProcessToken (GetCurrentProcess (), TOKEN_QUERY, &h))
1707 g_warning ("OpenProcessToken failed with error code %d", (gint) GetLastError ());
1711 /* Get length of buffer */
1712 token_information_len = 0;
1713 if (!GetTokenInformation (h, TokenUser, NULL, 0, &token_information_len))
1715 if (GetLastError () != ERROR_INSUFFICIENT_BUFFER)
1717 g_warning ("GetTokenInformation() failed with error code %d", (gint) GetLastError ());
1721 user = g_malloc (token_information_len);
1722 if (!GetTokenInformation (h, TokenUser, user, token_information_len, &token_information_len))
1724 g_warning ("GetTokenInformation() failed with error code %d", (gint) GetLastError ());
1728 psid = user->User.Sid;
1729 if (!IsValidSid (psid))
1731 g_warning ("Invalid SID");
1735 if (!ConvertSidToStringSidA (psid, &sid))
1737 g_warning ("Invalid SID");
1741 ret = g_strdup (sid);
1746 if (h != INVALID_HANDLE_VALUE)
1752 /* ---------------------------------------------------------------------------------------------------- */
1755 _g_dbus_get_machine_id (GError **error)
1758 /* TODO: use PACKAGE_LOCALSTATEDIR ? */
1760 if (!g_file_get_contents ("/var/lib/dbus/machine-id",
1765 g_prefix_error (error, _("Unable to load /var/lib/dbus/machine-id: "));
1769 /* TODO: validate value */
1775 /* ---------------------------------------------------------------------------------------------------- */
1778 _g_dbus_enum_to_string (GType enum_type, gint value)
1782 GEnumValue *enum_value;
1784 klass = g_type_class_ref (enum_type);
1785 enum_value = g_enum_get_value (klass, value);
1786 if (enum_value != NULL)
1787 ret = g_strdup (enum_value->value_nick);
1789 ret = g_strdup_printf ("unknown (value %d)", value);
1790 g_type_class_unref (klass);
1794 /* ---------------------------------------------------------------------------------------------------- */
1797 write_message_print_transport_debug (gssize bytes_written,
1798 MessageToWriteData *data)
1800 if (G_LIKELY (!_g_dbus_debug_transport ()))
1803 _g_dbus_debug_print_lock ();
1804 g_print ("========================================================================\n"
1805 "GDBus-debug:Transport:\n"
1806 " >>>> WROTE %" G_GSIZE_FORMAT " bytes of message with serial %d and\n"
1807 " size %" G_GSIZE_FORMAT " from offset %" G_GSIZE_FORMAT " on a %s\n",
1809 g_dbus_message_get_serial (data->message),
1811 data->total_written,
1812 g_type_name (G_TYPE_FROM_INSTANCE (g_io_stream_get_output_stream (data->worker->stream))));
1813 _g_dbus_debug_print_unlock ();
1818 /* ---------------------------------------------------------------------------------------------------- */
1821 read_message_print_transport_debug (gssize bytes_read,
1822 GDBusWorker *worker)
1826 gint32 message_length;
1828 if (G_LIKELY (!_g_dbus_debug_transport ()))
1831 size = bytes_read + worker->read_buffer_cur_size;
1835 message_length = g_dbus_message_bytes_needed ((guchar *) worker->read_buffer, size, NULL);
1838 switch (worker->read_buffer[0])
1842 serial = GUINT32_FROM_LE (((guint32 *) worker->read_buffer)[2]);
1846 serial = GUINT32_FROM_BE (((guint32 *) worker->read_buffer)[2]);
1849 /* an error will be set elsewhere if this happens */
1854 _g_dbus_debug_print_lock ();
1855 g_print ("========================================================================\n"
1856 "GDBus-debug:Transport:\n"
1857 " <<<< READ %" G_GSIZE_FORMAT " bytes of message with serial %d and\n"
1858 " size %d to offset %" G_GSIZE_FORMAT " from a %s\n",
1862 worker->read_buffer_cur_size,
1863 g_type_name (G_TYPE_FROM_INSTANCE (g_io_stream_get_input_stream (worker->stream))));
1864 _g_dbus_debug_print_unlock ();