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 G_LOCK_DEFINE_STATIC (shared_thread_lock);
238 GMainContext *context;
242 static SharedThreadData *shared_thread_data = NULL;
245 shared_thread_func (gpointer data)
247 g_main_context_push_thread_default (shared_thread_data->context);
248 g_main_loop_run (shared_thread_data->loop);
249 g_main_context_pop_thread_default (shared_thread_data->context);
253 typedef void (*GDBusSharedThreadFunc) (gpointer user_data);
257 GDBusSharedThreadFunc func;
263 invoke_caller (gpointer user_data)
265 CallerData *data = user_data;
266 data->func (data->user_data);
272 _g_dbus_shared_thread_ref (GDBusSharedThreadFunc func,
276 GSource *idle_source;
279 G_LOCK (shared_thread_lock);
281 if (shared_thread_data != NULL)
283 shared_thread_data->num_users += 1;
287 shared_thread_data = g_new0 (SharedThreadData, 1);
288 shared_thread_data->num_users = 1;
291 shared_thread_data->context = g_main_context_new ();
292 shared_thread_data->loop = g_main_loop_new (shared_thread_data->context, FALSE);
293 shared_thread_data->thread = g_thread_create (shared_thread_func,
297 g_assert_no_error (error);
301 data = g_new0 (CallerData, 1);
303 data->user_data = user_data;
306 idle_source = g_idle_source_new ();
307 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
308 g_source_set_callback (idle_source,
312 g_source_attach (idle_source, shared_thread_data->context);
313 g_source_unref (idle_source);
315 /* wait for the user code to run.. hmm.. probably use a condition variable instead */
321 G_UNLOCK (shared_thread_lock);
325 _g_dbus_shared_thread_unref (void)
327 /* TODO: actually destroy the shared thread here */
329 G_LOCK (shared_thread_lock);
330 g_assert (shared_thread_data != NULL);
331 shared_thread_data->num_users -= 1;
332 if (shared_thread_data->num_users == 0)
334 g_main_loop_quit (shared_thread_data->loop);
335 //g_thread_join (shared_thread_data->thread);
336 g_main_loop_unref (shared_thread_data->loop);
337 g_main_context_unref (shared_thread_data->context);
338 g_free (shared_thread_data);
339 shared_thread_data = NULL;
340 G_UNLOCK (shared_thread_lock);
344 G_UNLOCK (shared_thread_lock);
349 /* ---------------------------------------------------------------------------------------------------- */
353 volatile gint ref_count;
357 /* TODO: frozen (e.g. G_DBUS_CONNECTION_FLAGS_DELAY_MESSAGE_PROCESSING) currently
358 * only affects messages received from the other peer (since GDBusServer is the
359 * only user) - we might want it to affect messages sent to the other peer too?
362 GQueue *received_messages_while_frozen;
365 GDBusCapabilityFlags capabilities;
366 GCancellable *cancellable;
367 GDBusWorkerMessageReceivedCallback message_received_callback;
368 GDBusWorkerMessageAboutToBeSentCallback message_about_to_be_sent_callback;
369 GDBusWorkerDisconnectedCallback disconnected_callback;
374 /* if not NULL, stream is GSocketConnection */
377 /* used for reading */
380 gsize read_buffer_allocated_size;
381 gsize read_buffer_cur_size;
382 gsize read_buffer_bytes_wanted;
383 GUnixFDList *read_fd_list;
384 GSocketControlMessage **read_ancillary_messages;
385 gint read_num_ancillary_messages;
387 /* used for writing */
390 gint num_writes_pending;
391 guint64 write_num_messages_written;
392 GList *write_pending_flushes;
395 /* ---------------------------------------------------------------------------------------------------- */
401 guint64 number_to_wait_for;
405 struct _MessageToWriteData ;
406 typedef struct _MessageToWriteData MessageToWriteData;
408 static void message_to_write_data_free (MessageToWriteData *data);
410 static void read_message_print_transport_debug (gssize bytes_read,
411 GDBusWorker *worker);
413 static void write_message_print_transport_debug (gssize bytes_written,
414 MessageToWriteData *data);
416 /* ---------------------------------------------------------------------------------------------------- */
419 _g_dbus_worker_ref (GDBusWorker *worker)
421 g_atomic_int_inc (&worker->ref_count);
426 _g_dbus_worker_unref (GDBusWorker *worker)
428 if (g_atomic_int_dec_and_test (&worker->ref_count))
430 g_assert (worker->write_pending_flushes == NULL);
432 _g_dbus_shared_thread_unref ();
434 g_object_unref (worker->stream);
436 g_mutex_free (worker->read_lock);
437 g_object_unref (worker->cancellable);
438 if (worker->read_fd_list != NULL)
439 g_object_unref (worker->read_fd_list);
441 g_queue_foreach (worker->received_messages_while_frozen, (GFunc) g_object_unref, NULL);
442 g_queue_free (worker->received_messages_while_frozen);
444 g_mutex_free (worker->write_lock);
445 g_queue_foreach (worker->write_queue, (GFunc) message_to_write_data_free, NULL);
446 g_queue_free (worker->write_queue);
448 g_free (worker->read_buffer);
455 _g_dbus_worker_emit_disconnected (GDBusWorker *worker,
456 gboolean remote_peer_vanished,
459 if (!worker->stopped)
460 worker->disconnected_callback (worker, remote_peer_vanished, error, worker->user_data);
464 _g_dbus_worker_emit_message_received (GDBusWorker *worker,
465 GDBusMessage *message)
467 if (!worker->stopped)
468 worker->message_received_callback (worker, message, worker->user_data);
471 static GDBusMessageFilterResult
472 _g_dbus_worker_emit_message_about_to_be_sent (GDBusWorker *worker,
473 GDBusMessage *message)
475 GDBusMessageFilterResult ret;
476 ret = G_DBUS_MESSAGE_FILTER_RESULT_NO_EFFECT;
477 if (!worker->stopped)
478 ret = worker->message_about_to_be_sent_callback (worker, message, worker->user_data);
482 /* can only be called from private thread with read-lock held - takes ownership of @message */
484 _g_dbus_worker_queue_or_deliver_received_message (GDBusWorker *worker,
485 GDBusMessage *message)
487 if (worker->frozen || g_queue_get_length (worker->received_messages_while_frozen) > 0)
490 g_queue_push_tail (worker->received_messages_while_frozen, message);
494 /* not frozen, nor anything in queue */
495 _g_dbus_worker_emit_message_received (worker, message);
496 g_object_unref (message);
500 /* called in private thread shared by all GDBusConnection instances (without read-lock held) */
502 unfreeze_in_idle_cb (gpointer user_data)
504 GDBusWorker *worker = user_data;
505 GDBusMessage *message;
507 g_mutex_lock (worker->read_lock);
510 while ((message = g_queue_pop_head (worker->received_messages_while_frozen)) != NULL)
512 _g_dbus_worker_emit_message_received (worker, message);
513 g_object_unref (message);
515 worker->frozen = FALSE;
519 g_assert (g_queue_get_length (worker->received_messages_while_frozen) == 0);
521 g_mutex_unlock (worker->read_lock);
525 /* can be called from any thread */
527 _g_dbus_worker_unfreeze (GDBusWorker *worker)
529 GSource *idle_source;
530 idle_source = g_idle_source_new ();
531 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
532 g_source_set_callback (idle_source,
534 _g_dbus_worker_ref (worker),
535 (GDestroyNotify) _g_dbus_worker_unref);
536 g_source_attach (idle_source, shared_thread_data->context);
537 g_source_unref (idle_source);
540 /* ---------------------------------------------------------------------------------------------------- */
542 static void _g_dbus_worker_do_read_unlocked (GDBusWorker *worker);
544 /* called in private thread shared by all GDBusConnection instances (without read-lock held) */
546 _g_dbus_worker_do_read_cb (GInputStream *input_stream,
550 GDBusWorker *worker = user_data;
554 g_mutex_lock (worker->read_lock);
556 /* If already stopped, don't even process the reply */
561 if (worker->socket == NULL)
562 bytes_read = g_input_stream_read_finish (g_io_stream_get_input_stream (worker->stream),
566 bytes_read = _g_socket_read_with_control_messages_finish (worker->socket,
569 if (worker->read_num_ancillary_messages > 0)
572 for (n = 0; n < worker->read_num_ancillary_messages; n++)
574 GSocketControlMessage *control_message = G_SOCKET_CONTROL_MESSAGE (worker->read_ancillary_messages[n]);
580 else if (G_IS_UNIX_FD_MESSAGE (control_message))
582 GUnixFDMessage *fd_message;
586 fd_message = G_UNIX_FD_MESSAGE (control_message);
587 fds = g_unix_fd_message_steal_fds (fd_message, &num_fds);
588 if (worker->read_fd_list == NULL)
590 worker->read_fd_list = g_unix_fd_list_new_from_array (fds, num_fds);
595 for (n = 0; n < num_fds; n++)
597 /* TODO: really want a append_steal() */
598 g_unix_fd_list_append (worker->read_fd_list, fds[n], NULL);
604 else if (G_IS_UNIX_CREDENTIALS_MESSAGE (control_message))
616 "Unexpected ancillary message of type %s received from peer",
617 g_type_name (G_TYPE_FROM_INSTANCE (control_message)));
618 _g_dbus_worker_emit_disconnected (worker, TRUE, error);
619 g_error_free (error);
620 g_object_unref (control_message);
622 while (n < worker->read_num_ancillary_messages)
623 g_object_unref (worker->read_ancillary_messages[n++]);
624 g_free (worker->read_ancillary_messages);
628 g_object_unref (control_message);
630 g_free (worker->read_ancillary_messages);
633 if (bytes_read == -1)
635 _g_dbus_worker_emit_disconnected (worker, TRUE, error);
636 g_error_free (error);
641 g_debug ("read %d bytes (is_closed=%d blocking=%d condition=0x%02x) stream %p, %p",
643 g_socket_is_closed (g_socket_connection_get_socket (G_SOCKET_CONNECTION (worker->stream))),
644 g_socket_get_blocking (g_socket_connection_get_socket (G_SOCKET_CONNECTION (worker->stream))),
645 g_socket_condition_check (g_socket_connection_get_socket (G_SOCKET_CONNECTION (worker->stream)),
646 G_IO_IN | G_IO_OUT | G_IO_HUP),
651 /* TODO: hmm, hmm... */
657 "Underlying GIOStream returned 0 bytes on an async read");
658 _g_dbus_worker_emit_disconnected (worker, TRUE, error);
659 g_error_free (error);
663 read_message_print_transport_debug (bytes_read, worker);
665 worker->read_buffer_cur_size += bytes_read;
666 if (worker->read_buffer_bytes_wanted == worker->read_buffer_cur_size)
668 /* OK, got what we asked for! */
669 if (worker->read_buffer_bytes_wanted == 16)
672 /* OK, got the header - determine how many more bytes are needed */
674 message_len = g_dbus_message_bytes_needed ((guchar *) worker->read_buffer,
677 if (message_len == -1)
679 g_warning ("_g_dbus_worker_do_read_cb: error determing bytes needed: %s", error->message);
680 _g_dbus_worker_emit_disconnected (worker, FALSE, error);
681 g_error_free (error);
685 worker->read_buffer_bytes_wanted = message_len;
686 _g_dbus_worker_do_read_unlocked (worker);
690 GDBusMessage *message;
693 /* TODO: use connection->priv->auth to decode the message */
695 message = g_dbus_message_new_from_blob ((guchar *) worker->read_buffer,
696 worker->read_buffer_cur_size,
697 worker->capabilities,
702 s = _g_dbus_hexdump (worker->read_buffer, worker->read_buffer_cur_size, 2);
703 g_warning ("Error decoding D-Bus message of %" G_GSIZE_FORMAT " bytes\n"
705 "The payload is as follows:\n"
707 worker->read_buffer_cur_size,
711 _g_dbus_worker_emit_disconnected (worker, FALSE, error);
712 g_error_free (error);
717 if (worker->read_fd_list != NULL)
719 g_dbus_message_set_unix_fd_list (message, worker->read_fd_list);
720 g_object_unref (worker->read_fd_list);
721 worker->read_fd_list = NULL;
725 if (G_UNLIKELY (_g_dbus_debug_message ()))
728 _g_dbus_debug_print_lock ();
729 g_print ("========================================================================\n"
730 "GDBus-debug:Message:\n"
731 " <<<< RECEIVED D-Bus message (%" G_GSIZE_FORMAT " bytes)\n",
732 worker->read_buffer_cur_size);
733 s = g_dbus_message_print (message, 2);
736 if (G_UNLIKELY (_g_dbus_debug_payload ()))
738 s = _g_dbus_hexdump (worker->read_buffer, worker->read_buffer_cur_size, 2);
742 _g_dbus_debug_print_unlock ();
745 /* yay, got a message, go deliver it */
746 _g_dbus_worker_queue_or_deliver_received_message (worker, message);
748 /* start reading another message! */
749 worker->read_buffer_bytes_wanted = 0;
750 worker->read_buffer_cur_size = 0;
751 _g_dbus_worker_do_read_unlocked (worker);
756 /* didn't get all the bytes we requested - so repeat the request... */
757 _g_dbus_worker_do_read_unlocked (worker);
761 g_mutex_unlock (worker->read_lock);
763 /* gives up the reference acquired when calling g_input_stream_read_async() */
764 _g_dbus_worker_unref (worker);
767 /* called in private thread shared by all GDBusConnection instances (with read-lock held) */
769 _g_dbus_worker_do_read_unlocked (GDBusWorker *worker)
771 /* if bytes_wanted is zero, it means start reading a message */
772 if (worker->read_buffer_bytes_wanted == 0)
774 worker->read_buffer_cur_size = 0;
775 worker->read_buffer_bytes_wanted = 16;
778 /* ensure we have a (big enough) buffer */
779 if (worker->read_buffer == NULL || worker->read_buffer_bytes_wanted > worker->read_buffer_allocated_size)
781 /* TODO: 4096 is randomly chosen; might want a better chosen default minimum */
782 worker->read_buffer_allocated_size = MAX (worker->read_buffer_bytes_wanted, 4096);
783 worker->read_buffer = g_realloc (worker->read_buffer, worker->read_buffer_allocated_size);
786 if (worker->socket == NULL)
787 g_input_stream_read_async (g_io_stream_get_input_stream (worker->stream),
788 worker->read_buffer + worker->read_buffer_cur_size,
789 worker->read_buffer_bytes_wanted - worker->read_buffer_cur_size,
792 (GAsyncReadyCallback) _g_dbus_worker_do_read_cb,
793 _g_dbus_worker_ref (worker));
796 worker->read_ancillary_messages = NULL;
797 worker->read_num_ancillary_messages = 0;
798 _g_socket_read_with_control_messages (worker->socket,
799 worker->read_buffer + worker->read_buffer_cur_size,
800 worker->read_buffer_bytes_wanted - worker->read_buffer_cur_size,
801 &worker->read_ancillary_messages,
802 &worker->read_num_ancillary_messages,
805 (GAsyncReadyCallback) _g_dbus_worker_do_read_cb,
806 _g_dbus_worker_ref (worker));
810 /* called in private thread shared by all GDBusConnection instances (without read-lock held) */
812 _g_dbus_worker_do_read (GDBusWorker *worker)
814 g_mutex_lock (worker->read_lock);
815 _g_dbus_worker_do_read_unlocked (worker);
816 g_mutex_unlock (worker->read_lock);
819 /* ---------------------------------------------------------------------------------------------------- */
821 struct _MessageToWriteData
824 GDBusMessage *message;
829 GSimpleAsyncResult *simple;
834 message_to_write_data_free (MessageToWriteData *data)
836 _g_dbus_worker_unref (data->worker);
837 g_object_unref (data->message);
842 /* ---------------------------------------------------------------------------------------------------- */
844 static void write_message_continue_writing (MessageToWriteData *data);
846 /* called in private thread shared by all GDBusConnection instances (without write-lock held) */
848 write_message_async_cb (GObject *source_object,
852 MessageToWriteData *data = user_data;
853 GSimpleAsyncResult *simple;
854 gssize bytes_written;
857 /* Note: we can't access data->simple after calling g_async_result_complete () because the
858 * callback can free @data and we're not completing in idle. So use a copy of the pointer.
860 simple = data->simple;
863 bytes_written = g_output_stream_write_finish (G_OUTPUT_STREAM (source_object),
866 if (bytes_written == -1)
868 g_simple_async_result_set_from_error (simple, error);
869 g_error_free (error);
870 g_simple_async_result_complete (simple);
871 g_object_unref (simple);
874 g_assert (bytes_written > 0); /* zero is never returned */
876 write_message_print_transport_debug (bytes_written, data);
878 data->total_written += bytes_written;
879 g_assert (data->total_written <= data->blob_size);
880 if (data->total_written == data->blob_size)
882 g_simple_async_result_complete (simple);
883 g_object_unref (simple);
887 write_message_continue_writing (data);
893 /* called in private thread shared by all GDBusConnection instances (without write-lock held) */
895 on_socket_ready (GSocket *socket,
896 GIOCondition condition,
899 MessageToWriteData *data = user_data;
900 write_message_continue_writing (data);
901 return FALSE; /* remove source */
904 /* called in private thread shared by all GDBusConnection instances (without write-lock held) */
906 write_message_continue_writing (MessageToWriteData *data)
908 GOutputStream *ostream;
909 GSimpleAsyncResult *simple;
911 GUnixFDList *fd_list;
914 /* Note: we can't access data->simple after calling g_async_result_complete () because the
915 * callback can free @data and we're not completing in idle. So use a copy of the pointer.
917 simple = data->simple;
919 ostream = g_io_stream_get_output_stream (data->worker->stream);
921 fd_list = g_dbus_message_get_unix_fd_list (data->message);
924 g_assert (!g_output_stream_has_pending (ostream));
925 g_assert_cmpint (data->total_written, <, data->blob_size);
931 else if (G_IS_SOCKET_OUTPUT_STREAM (ostream) && data->total_written == 0)
933 GOutputVector vector;
934 GSocketControlMessage *control_message;
935 gssize bytes_written;
938 vector.buffer = data->blob;
939 vector.size = data->blob_size;
941 control_message = NULL;
942 if (fd_list != NULL && g_unix_fd_list_get_length (fd_list) > 0)
944 if (!(data->worker->capabilities & G_DBUS_CAPABILITY_FLAGS_UNIX_FD_PASSING))
946 g_simple_async_result_set_error (simple,
949 "Tried sending a file descriptor but remote peer does not support this capability");
950 g_simple_async_result_complete (simple);
951 g_object_unref (simple);
954 control_message = g_unix_fd_message_new_with_fd_list (fd_list);
958 bytes_written = g_socket_send_message (data->worker->socket,
962 control_message != NULL ? &control_message : NULL,
963 control_message != NULL ? 1 : 0,
965 data->worker->cancellable,
967 if (control_message != NULL)
968 g_object_unref (control_message);
970 if (bytes_written == -1)
972 /* Handle WOULD_BLOCK by waiting until there's room in the buffer */
973 if (g_error_matches (error, G_IO_ERROR, G_IO_ERROR_WOULD_BLOCK))
976 source = g_socket_create_source (data->worker->socket,
977 G_IO_OUT | G_IO_HUP | G_IO_ERR,
978 data->worker->cancellable);
979 g_source_set_callback (source,
980 (GSourceFunc) on_socket_ready,
982 NULL); /* GDestroyNotify */
983 g_source_attach (source, g_main_context_get_thread_default ());
984 g_source_unref (source);
985 g_error_free (error);
988 g_simple_async_result_set_from_error (simple, error);
989 g_error_free (error);
990 g_simple_async_result_complete (simple);
991 g_object_unref (simple);
994 g_assert (bytes_written > 0); /* zero is never returned */
996 write_message_print_transport_debug (bytes_written, data);
998 data->total_written += bytes_written;
999 g_assert (data->total_written <= data->blob_size);
1000 if (data->total_written == data->blob_size)
1002 g_simple_async_result_complete (simple);
1003 g_object_unref (simple);
1007 write_message_continue_writing (data);
1013 if (fd_list != NULL)
1015 g_simple_async_result_set_error (simple,
1018 "Tried sending a file descriptor on unsupported stream of type %s",
1019 g_type_name (G_TYPE_FROM_INSTANCE (ostream)));
1020 g_simple_async_result_complete (simple);
1021 g_object_unref (simple);
1026 g_output_stream_write_async (ostream,
1027 (const gchar *) data->blob + data->total_written,
1028 data->blob_size - data->total_written,
1030 data->worker->cancellable,
1031 write_message_async_cb,
1038 /* called in private thread shared by all GDBusConnection instances (without write-lock held) */
1040 write_message_async (GDBusWorker *worker,
1041 MessageToWriteData *data,
1042 GAsyncReadyCallback callback,
1045 data->simple = g_simple_async_result_new (NULL,
1048 write_message_async);
1049 data->total_written = 0;
1050 write_message_continue_writing (data);
1053 /* called in private thread shared by all GDBusConnection instances (without write-lock held) */
1055 write_message_finish (GAsyncResult *res,
1058 g_warn_if_fail (g_simple_async_result_get_source_tag (G_SIMPLE_ASYNC_RESULT (res)) == write_message_async);
1059 if (g_simple_async_result_propagate_error (G_SIMPLE_ASYNC_RESULT (res), error))
1064 /* ---------------------------------------------------------------------------------------------------- */
1066 static void maybe_write_next_message (GDBusWorker *worker);
1070 GDBusWorker *worker;
1074 /* called in private thread shared by all GDBusConnection instances (without write-lock held) */
1076 ostream_flush_cb (GObject *source_object,
1080 FlushAsyncData *data = user_data;
1085 g_output_stream_flush_finish (G_OUTPUT_STREAM (source_object),
1091 if (G_UNLIKELY (_g_dbus_debug_transport ()))
1093 _g_dbus_debug_print_lock ();
1094 g_print ("========================================================================\n"
1095 "GDBus-debug:Transport:\n"
1096 " ---- FLUSHED stream of type %s\n",
1097 g_type_name (G_TYPE_FROM_INSTANCE (g_io_stream_get_output_stream (data->worker->stream))));
1098 _g_dbus_debug_print_unlock ();
1102 g_assert (data->flushers != NULL);
1103 for (l = data->flushers; l != NULL; l = l->next)
1105 FlushData *f = l->data;
1107 f->error = error != NULL ? g_error_copy (error) : NULL;
1109 g_mutex_lock (f->mutex);
1110 g_cond_signal (f->cond);
1111 g_mutex_unlock (f->mutex);
1113 g_list_free (data->flushers);
1116 g_error_free (error);
1118 /* OK, cool, finally kick off the next write */
1119 maybe_write_next_message (data->worker);
1121 _g_dbus_worker_unref (data->worker);
1125 /* called in private thread shared by all GDBusConnection instances (without write-lock held) */
1127 message_written (GDBusWorker *worker,
1128 MessageToWriteData *message_data)
1134 /* first log the fact that we wrote a message */
1135 if (G_UNLIKELY (_g_dbus_debug_message ()))
1138 _g_dbus_debug_print_lock ();
1139 g_print ("========================================================================\n"
1140 "GDBus-debug:Message:\n"
1141 " >>>> SENT D-Bus message (%" G_GSIZE_FORMAT " bytes)\n",
1142 message_data->blob_size);
1143 s = g_dbus_message_print (message_data->message, 2);
1146 if (G_UNLIKELY (_g_dbus_debug_payload ()))
1148 s = _g_dbus_hexdump (message_data->blob, message_data->blob_size, 2);
1149 g_print ("%s\n", s);
1152 _g_dbus_debug_print_unlock ();
1155 /* then first wake up pending flushes and, if needed, flush the stream */
1157 g_mutex_lock (worker->write_lock);
1158 worker->write_num_messages_written += 1;
1159 for (l = worker->write_pending_flushes; l != NULL; l = ll)
1161 FlushData *f = l->data;
1164 if (f->number_to_wait_for == worker->write_num_messages_written)
1166 flushers = g_list_append (flushers, f);
1167 worker->write_pending_flushes = g_list_delete_link (worker->write_pending_flushes, l);
1170 g_mutex_unlock (worker->write_lock);
1172 if (flushers != NULL)
1174 FlushAsyncData *data;
1175 data = g_new0 (FlushAsyncData, 1);
1176 data->worker = _g_dbus_worker_ref (worker);
1177 data->flushers = flushers;
1178 /* flush the stream before writing the next message */
1179 g_output_stream_flush_async (g_io_stream_get_output_stream (worker->stream),
1181 worker->cancellable,
1187 /* kick off the next write! */
1188 maybe_write_next_message (worker);
1192 /* called in private thread shared by all GDBusConnection instances (without write-lock held) */
1194 write_message_cb (GObject *source_object,
1198 MessageToWriteData *data = user_data;
1201 g_mutex_lock (data->worker->write_lock);
1202 data->worker->num_writes_pending -= 1;
1203 g_mutex_unlock (data->worker->write_lock);
1206 if (!write_message_finish (res, &error))
1209 _g_dbus_worker_emit_disconnected (data->worker, TRUE, error);
1210 g_error_free (error);
1213 /* this function will also kick of the next write (it might need to
1214 * flush so writing the next message might happen much later
1217 message_written (data->worker, data);
1219 message_to_write_data_free (data);
1222 /* called in private thread shared by all GDBusConnection instances (without write-lock held) */
1224 maybe_write_next_message (GDBusWorker *worker)
1226 MessageToWriteData *data;
1230 g_mutex_lock (worker->write_lock);
1231 data = g_queue_pop_head (worker->write_queue);
1233 worker->num_writes_pending += 1;
1234 g_mutex_unlock (worker->write_lock);
1236 /* Note that write_lock is only used for protecting the @write_queue
1237 * and @num_writes_pending fields of the GDBusWorker struct ... which we
1238 * need to modify from arbitrary threads in _g_dbus_worker_send_message().
1240 * Therefore, it's fine to drop it here when calling back into user
1241 * code and then writing the message out onto the GIOStream since this
1242 * function only runs on the worker thread.
1246 GDBusMessageFilterResult filter_result;
1248 gsize new_blob_size;
1251 filter_result = _g_dbus_worker_emit_message_about_to_be_sent (worker, data->message);
1252 switch (filter_result)
1254 case G_DBUS_MESSAGE_FILTER_RESULT_NO_EFFECT:
1258 case G_DBUS_MESSAGE_FILTER_RESULT_MESSAGE_CONSUMED:
1260 g_mutex_lock (worker->write_lock);
1261 worker->num_writes_pending -= 1;
1262 g_mutex_unlock (worker->write_lock);
1263 message_to_write_data_free (data);
1266 case G_DBUS_MESSAGE_FILTER_RESULT_MESSAGE_ALTERED:
1267 /* reencode altered message */
1269 new_blob = g_dbus_message_to_blob (data->message,
1271 worker->capabilities,
1273 if (new_blob == NULL)
1275 /* if filter make the GDBusMessage unencodeable, just complain on stderr and send
1276 * the old message instead
1278 g_warning ("Error encoding GDBusMessage with serial %d altered by filter function: %s",
1279 g_dbus_message_get_serial (data->message),
1281 g_error_free (error);
1285 g_free (data->blob);
1286 data->blob = (gchar *) new_blob;
1287 data->blob_size = new_blob_size;
1292 write_message_async (worker,
1299 /* called in private thread shared by all GDBusConnection instances (without write-lock held) */
1301 write_message_in_idle_cb (gpointer user_data)
1303 GDBusWorker *worker = user_data;
1304 if (worker->num_writes_pending == 0)
1305 maybe_write_next_message (worker);
1309 /* ---------------------------------------------------------------------------------------------------- */
1311 /* can be called from any thread - steals blob */
1313 _g_dbus_worker_send_message (GDBusWorker *worker,
1314 GDBusMessage *message,
1318 MessageToWriteData *data;
1320 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
1321 g_return_if_fail (blob != NULL);
1322 g_return_if_fail (blob_len > 16);
1324 data = g_new0 (MessageToWriteData, 1);
1325 data->worker = _g_dbus_worker_ref (worker);
1326 data->message = g_object_ref (message);
1327 data->blob = blob; /* steal! */
1328 data->blob_size = blob_len;
1330 g_mutex_lock (worker->write_lock);
1331 g_queue_push_tail (worker->write_queue, data);
1332 if (worker->num_writes_pending == 0)
1334 GSource *idle_source;
1335 idle_source = g_idle_source_new ();
1336 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
1337 g_source_set_callback (idle_source,
1338 write_message_in_idle_cb,
1339 _g_dbus_worker_ref (worker),
1340 (GDestroyNotify) _g_dbus_worker_unref);
1341 g_source_attach (idle_source, shared_thread_data->context);
1342 g_source_unref (idle_source);
1344 g_mutex_unlock (worker->write_lock);
1347 /* ---------------------------------------------------------------------------------------------------- */
1350 _g_dbus_worker_thread_begin_func (gpointer user_data)
1352 GDBusWorker *worker = user_data;
1354 worker->thread = g_thread_self ();
1357 _g_dbus_worker_do_read (worker);
1361 _g_dbus_worker_new (GIOStream *stream,
1362 GDBusCapabilityFlags capabilities,
1363 gboolean initially_frozen,
1364 GDBusWorkerMessageReceivedCallback message_received_callback,
1365 GDBusWorkerMessageAboutToBeSentCallback message_about_to_be_sent_callback,
1366 GDBusWorkerDisconnectedCallback disconnected_callback,
1369 GDBusWorker *worker;
1371 g_return_val_if_fail (G_IS_IO_STREAM (stream), NULL);
1372 g_return_val_if_fail (message_received_callback != NULL, NULL);
1373 g_return_val_if_fail (message_about_to_be_sent_callback != NULL, NULL);
1374 g_return_val_if_fail (disconnected_callback != NULL, NULL);
1376 worker = g_new0 (GDBusWorker, 1);
1377 worker->ref_count = 1;
1379 worker->read_lock = g_mutex_new ();
1380 worker->message_received_callback = message_received_callback;
1381 worker->message_about_to_be_sent_callback = message_about_to_be_sent_callback;
1382 worker->disconnected_callback = disconnected_callback;
1383 worker->user_data = user_data;
1384 worker->stream = g_object_ref (stream);
1385 worker->capabilities = capabilities;
1386 worker->cancellable = g_cancellable_new ();
1388 worker->frozen = initially_frozen;
1389 worker->received_messages_while_frozen = g_queue_new ();
1391 worker->write_lock = g_mutex_new ();
1392 worker->write_queue = g_queue_new ();
1394 if (G_IS_SOCKET_CONNECTION (worker->stream))
1395 worker->socket = g_socket_connection_get_socket (G_SOCKET_CONNECTION (worker->stream));
1397 _g_dbus_shared_thread_ref (_g_dbus_worker_thread_begin_func, worker);
1402 /* ---------------------------------------------------------------------------------------------------- */
1404 /* This can be called from any thread - frees worker - guarantees no callbacks
1405 * will ever be issued again
1408 _g_dbus_worker_stop (GDBusWorker *worker)
1410 /* If we're called in the worker thread it means we are called from
1411 * a worker callback. This is fine, we just can't lock in that case since
1412 * we're already holding the lock...
1414 if (g_thread_self () != worker->thread)
1415 g_mutex_lock (worker->read_lock);
1416 worker->stopped = TRUE;
1417 if (g_thread_self () != worker->thread)
1418 g_mutex_unlock (worker->read_lock);
1420 g_cancellable_cancel (worker->cancellable);
1421 _g_dbus_worker_unref (worker);
1424 /* ---------------------------------------------------------------------------------------------------- */
1426 /* can be called from any thread (except the worker thread) - blocks
1427 * calling thread until all queued outgoing messages are written and
1428 * the transport has been flushed
1431 _g_dbus_worker_flush_sync (GDBusWorker *worker,
1432 GCancellable *cancellable,
1441 /* if the queue is empty, there's nothing to wait for */
1442 g_mutex_lock (worker->write_lock);
1443 if (g_queue_get_length (worker->write_queue) > 0)
1445 data = g_new0 (FlushData, 1);
1446 data->mutex = g_mutex_new ();
1447 data->cond = g_cond_new ();
1448 data->number_to_wait_for = worker->write_num_messages_written + g_queue_get_length (worker->write_queue);
1449 g_mutex_lock (data->mutex);
1450 worker->write_pending_flushes = g_list_prepend (worker->write_pending_flushes, data);
1452 g_mutex_unlock (worker->write_lock);
1456 g_cond_wait (data->cond, data->mutex);
1457 g_mutex_unlock (data->mutex);
1459 /* note:the element is removed from worker->write_pending_flushes in flush_cb() above */
1460 g_cond_free (data->cond);
1461 g_mutex_free (data->mutex);
1462 if (data->error != NULL)
1465 g_propagate_error (error, data->error);
1473 /* ---------------------------------------------------------------------------------------------------- */
1475 #define G_DBUS_DEBUG_AUTHENTICATION (1<<0)
1476 #define G_DBUS_DEBUG_TRANSPORT (1<<1)
1477 #define G_DBUS_DEBUG_MESSAGE (1<<2)
1478 #define G_DBUS_DEBUG_PAYLOAD (1<<3)
1479 #define G_DBUS_DEBUG_CALL (1<<4)
1480 #define G_DBUS_DEBUG_SIGNAL (1<<5)
1481 #define G_DBUS_DEBUG_INCOMING (1<<6)
1482 #define G_DBUS_DEBUG_RETURN (1<<7)
1483 #define G_DBUS_DEBUG_EMISSION (1<<8)
1484 #define G_DBUS_DEBUG_ADDRESS (1<<9)
1486 static gint _gdbus_debug_flags = 0;
1489 _g_dbus_debug_authentication (void)
1491 _g_dbus_initialize ();
1492 return (_gdbus_debug_flags & G_DBUS_DEBUG_AUTHENTICATION) != 0;
1496 _g_dbus_debug_transport (void)
1498 _g_dbus_initialize ();
1499 return (_gdbus_debug_flags & G_DBUS_DEBUG_TRANSPORT) != 0;
1503 _g_dbus_debug_message (void)
1505 _g_dbus_initialize ();
1506 return (_gdbus_debug_flags & G_DBUS_DEBUG_MESSAGE) != 0;
1510 _g_dbus_debug_payload (void)
1512 _g_dbus_initialize ();
1513 return (_gdbus_debug_flags & G_DBUS_DEBUG_PAYLOAD) != 0;
1517 _g_dbus_debug_call (void)
1519 _g_dbus_initialize ();
1520 return (_gdbus_debug_flags & G_DBUS_DEBUG_CALL) != 0;
1524 _g_dbus_debug_signal (void)
1526 _g_dbus_initialize ();
1527 return (_gdbus_debug_flags & G_DBUS_DEBUG_SIGNAL) != 0;
1531 _g_dbus_debug_incoming (void)
1533 _g_dbus_initialize ();
1534 return (_gdbus_debug_flags & G_DBUS_DEBUG_INCOMING) != 0;
1538 _g_dbus_debug_return (void)
1540 _g_dbus_initialize ();
1541 return (_gdbus_debug_flags & G_DBUS_DEBUG_RETURN) != 0;
1545 _g_dbus_debug_emission (void)
1547 _g_dbus_initialize ();
1548 return (_gdbus_debug_flags & G_DBUS_DEBUG_EMISSION) != 0;
1552 _g_dbus_debug_address (void)
1554 _g_dbus_initialize ();
1555 return (_gdbus_debug_flags & G_DBUS_DEBUG_ADDRESS) != 0;
1558 G_LOCK_DEFINE_STATIC (print_lock);
1561 _g_dbus_debug_print_lock (void)
1563 G_LOCK (print_lock);
1567 _g_dbus_debug_print_unlock (void)
1569 G_UNLOCK (print_lock);
1573 * _g_dbus_initialize:
1575 * Does various one-time init things such as
1577 * - registering the G_DBUS_ERROR error domain
1578 * - parses the G_DBUS_DEBUG environment variable
1581 _g_dbus_initialize (void)
1583 static volatile gsize initialized = 0;
1585 if (g_once_init_enter (&initialized))
1587 volatile GQuark g_dbus_error_domain;
1590 g_dbus_error_domain = G_DBUS_ERROR;
1592 debug = g_getenv ("G_DBUS_DEBUG");
1595 const GDebugKey keys[] = {
1596 { "authentication", G_DBUS_DEBUG_AUTHENTICATION },
1597 { "transport", G_DBUS_DEBUG_TRANSPORT },
1598 { "message", G_DBUS_DEBUG_MESSAGE },
1599 { "payload", G_DBUS_DEBUG_PAYLOAD },
1600 { "call", G_DBUS_DEBUG_CALL },
1601 { "signal", G_DBUS_DEBUG_SIGNAL },
1602 { "incoming", G_DBUS_DEBUG_INCOMING },
1603 { "return", G_DBUS_DEBUG_RETURN },
1604 { "emission", G_DBUS_DEBUG_EMISSION },
1605 { "address", G_DBUS_DEBUG_ADDRESS }
1608 _gdbus_debug_flags = g_parse_debug_string (debug, keys, G_N_ELEMENTS (keys));
1609 if (_gdbus_debug_flags & G_DBUS_DEBUG_PAYLOAD)
1610 _gdbus_debug_flags |= G_DBUS_DEBUG_MESSAGE;
1613 g_once_init_leave (&initialized, 1);
1617 /* ---------------------------------------------------------------------------------------------------- */
1620 _g_dbus_compute_complete_signature (GDBusArgInfo **args)
1622 const GVariantType *arg_types[256];
1626 for (n = 0; args[n] != NULL; n++)
1628 /* DBus places a hard limit of 255 on signature length.
1629 * therefore number of args must be less than 256.
1633 arg_types[n] = G_VARIANT_TYPE (args[n]->signature);
1635 if G_UNLIKELY (arg_types[n] == NULL)
1641 return g_variant_type_new_tuple (arg_types, n);
1644 /* ---------------------------------------------------------------------------------------------------- */
1648 extern BOOL WINAPI ConvertSidToStringSidA (PSID Sid, LPSTR *StringSid);
1651 _g_dbus_win32_get_user_sid (void)
1655 DWORD token_information_len;
1662 h = INVALID_HANDLE_VALUE;
1664 if (!OpenProcessToken (GetCurrentProcess (), TOKEN_QUERY, &h))
1666 g_warning ("OpenProcessToken failed with error code %d", (gint) GetLastError ());
1670 /* Get length of buffer */
1671 token_information_len = 0;
1672 if (!GetTokenInformation (h, TokenUser, NULL, 0, &token_information_len))
1674 if (GetLastError () != ERROR_INSUFFICIENT_BUFFER)
1676 g_warning ("GetTokenInformation() failed with error code %d", (gint) GetLastError ());
1680 user = g_malloc (token_information_len);
1681 if (!GetTokenInformation (h, TokenUser, user, token_information_len, &token_information_len))
1683 g_warning ("GetTokenInformation() failed with error code %d", (gint) GetLastError ());
1687 psid = user->User.Sid;
1688 if (!IsValidSid (psid))
1690 g_warning ("Invalid SID");
1694 if (!ConvertSidToStringSidA (psid, &sid))
1696 g_warning ("Invalid SID");
1700 ret = g_strdup (sid);
1705 if (h != INVALID_HANDLE_VALUE)
1711 /* ---------------------------------------------------------------------------------------------------- */
1714 _g_dbus_get_machine_id (GError **error)
1717 /* TODO: use PACKAGE_LOCALSTATEDIR ? */
1719 if (!g_file_get_contents ("/var/lib/dbus/machine-id",
1724 g_prefix_error (error, _("Unable to load /var/lib/dbus/machine-id: "));
1728 /* TODO: validate value */
1734 /* ---------------------------------------------------------------------------------------------------- */
1737 _g_dbus_enum_to_string (GType enum_type, gint value)
1741 GEnumValue *enum_value;
1743 klass = g_type_class_ref (enum_type);
1744 enum_value = g_enum_get_value (klass, value);
1745 if (enum_value != NULL)
1746 ret = g_strdup (enum_value->value_nick);
1748 ret = g_strdup_printf ("unknown (value %d)", value);
1749 g_type_class_unref (klass);
1753 /* ---------------------------------------------------------------------------------------------------- */
1756 write_message_print_transport_debug (gssize bytes_written,
1757 MessageToWriteData *data)
1759 if (G_LIKELY (!_g_dbus_debug_transport ()))
1762 _g_dbus_debug_print_lock ();
1763 g_print ("========================================================================\n"
1764 "GDBus-debug:Transport:\n"
1765 " >>>> WROTE %" G_GSIZE_FORMAT " bytes of message with serial %d and\n"
1766 " size %" G_GSIZE_FORMAT " from offset %" G_GSIZE_FORMAT " on a %s\n",
1768 g_dbus_message_get_serial (data->message),
1770 data->total_written,
1771 g_type_name (G_TYPE_FROM_INSTANCE (g_io_stream_get_output_stream (data->worker->stream))));
1772 _g_dbus_debug_print_unlock ();
1777 /* ---------------------------------------------------------------------------------------------------- */
1780 read_message_print_transport_debug (gssize bytes_read,
1781 GDBusWorker *worker)
1785 gint32 message_length;
1787 if (G_LIKELY (!_g_dbus_debug_transport ()))
1790 size = bytes_read + worker->read_buffer_cur_size;
1794 message_length = g_dbus_message_bytes_needed ((guchar *) worker->read_buffer, size, NULL);
1797 switch (worker->read_buffer[0])
1801 serial = GUINT32_FROM_LE (((guint32 *) worker->read_buffer)[2]);
1805 serial = GUINT32_FROM_BE (((guint32 *) worker->read_buffer)[2]);
1808 /* an error will be set elsewhere if this happens */
1813 _g_dbus_debug_print_lock ();
1814 g_print ("========================================================================\n"
1815 "GDBus-debug:Transport:\n"
1816 " <<<< READ %" G_GSIZE_FORMAT " bytes of message with serial %d and\n"
1817 " size %d to offset %" G_GSIZE_FORMAT " from a %s\n",
1821 worker->read_buffer_cur_size,
1822 g_type_name (G_TYPE_FROM_INSTANCE (g_io_stream_get_input_stream (worker->stream))));
1823 _g_dbus_debug_print_unlock ();