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 "gmemoryinputstream.h"
41 #include "giostream.h"
42 #include "gsocketcontrolmessage.h"
43 #include "gsocketconnection.h"
44 #include "gsocketoutputstream.h"
47 #include "gunixfdmessage.h"
48 #include "gunixconnection.h"
49 #include "gunixcredentialsmessage.h"
58 static gboolean _g_dbus_worker_do_initial_read (gpointer data);
60 /* ---------------------------------------------------------------------------------------------------- */
63 _g_dbus_hexdump (const gchar *data, gsize len, guint indent)
68 ret = g_string_new (NULL);
70 for (n = 0; n < len; n += 16)
72 g_string_append_printf (ret, "%*s%04x: ", indent, "", n);
74 for (m = n; m < n + 16; m++)
76 if (m > n && (m%4) == 0)
77 g_string_append_c (ret, ' ');
79 g_string_append_printf (ret, "%02x ", (guchar) data[m]);
81 g_string_append (ret, " ");
84 g_string_append (ret, " ");
86 for (m = n; m < len && m < n + 16; m++)
87 g_string_append_c (ret, g_ascii_isprint (data[m]) ? data[m] : '.');
89 g_string_append_c (ret, '\n');
92 return g_string_free (ret, FALSE);
95 /* ---------------------------------------------------------------------------------------------------- */
97 /* Unfortunately ancillary messages are discarded when reading from a
98 * socket using the GSocketInputStream abstraction. So we provide a
99 * very GInputStream-ish API that uses GSocket in this case (very
100 * similar to GSocketInputStream).
106 GCancellable *cancellable;
111 GSocketControlMessage ***messages;
114 GSimpleAsyncResult *simple;
116 gboolean from_mainloop;
117 } ReadWithControlData;
120 read_with_control_data_free (ReadWithControlData *data)
122 g_object_unref (data->socket);
123 if (data->cancellable != NULL)
124 g_object_unref (data->cancellable);
125 g_object_unref (data->simple);
130 _g_socket_read_with_control_messages_ready (GSocket *socket,
131 GIOCondition condition,
134 ReadWithControlData *data = user_data;
140 vector.buffer = data->buffer;
141 vector.size = data->count;
142 result = g_socket_receive_message (data->socket,
153 g_simple_async_result_set_op_res_gssize (data->simple, result);
157 g_assert (error != NULL);
158 g_simple_async_result_take_error (data->simple, error);
161 if (data->from_mainloop)
162 g_simple_async_result_complete (data->simple);
164 g_simple_async_result_complete_in_idle (data->simple);
170 _g_socket_read_with_control_messages (GSocket *socket,
173 GSocketControlMessage ***messages,
176 GCancellable *cancellable,
177 GAsyncReadyCallback callback,
180 ReadWithControlData *data;
182 data = g_new0 (ReadWithControlData, 1);
183 data->socket = g_object_ref (socket);
184 data->cancellable = cancellable != NULL ? g_object_ref (cancellable) : NULL;
185 data->buffer = buffer;
187 data->messages = messages;
188 data->num_messages = num_messages;
190 data->simple = g_simple_async_result_new (G_OBJECT (socket),
193 _g_socket_read_with_control_messages);
195 if (!g_socket_condition_check (socket, G_IO_IN))
198 data->from_mainloop = TRUE;
199 source = g_socket_create_source (data->socket,
200 G_IO_IN | G_IO_HUP | G_IO_ERR,
202 g_source_set_callback (source,
203 (GSourceFunc) _g_socket_read_with_control_messages_ready,
205 (GDestroyNotify) read_with_control_data_free);
206 g_source_attach (source, g_main_context_get_thread_default ());
207 g_source_unref (source);
211 _g_socket_read_with_control_messages_ready (data->socket, G_IO_IN, data);
212 read_with_control_data_free (data);
217 _g_socket_read_with_control_messages_finish (GSocket *socket,
218 GAsyncResult *result,
221 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
223 g_return_val_if_fail (G_IS_SOCKET (socket), -1);
224 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == _g_socket_read_with_control_messages);
226 if (g_simple_async_result_propagate_error (simple, error))
229 return g_simple_async_result_get_op_res_gssize (simple);
232 /* ---------------------------------------------------------------------------------------------------- */
234 /* Work-around for https://bugzilla.gnome.org/show_bug.cgi?id=627724 */
236 static GPtrArray *ensured_classes = NULL;
239 ensure_type (GType gtype)
241 g_ptr_array_add (ensured_classes, g_type_class_ref (gtype));
245 release_required_types (void)
247 g_ptr_array_foreach (ensured_classes, (GFunc) g_type_class_unref, NULL);
248 g_ptr_array_unref (ensured_classes);
249 ensured_classes = NULL;
253 ensure_required_types (void)
255 g_assert (ensured_classes == NULL);
256 ensured_classes = g_ptr_array_new ();
257 ensure_type (G_TYPE_SIMPLE_ASYNC_RESULT);
258 ensure_type (G_TYPE_MEMORY_INPUT_STREAM);
260 /* ---------------------------------------------------------------------------------------------------- */
264 volatile gint refcount;
266 GMainContext *context;
271 gdbus_shared_thread_func (gpointer user_data)
273 SharedThreadData *data = user_data;
275 g_main_context_push_thread_default (data->context);
276 g_main_loop_run (data->loop);
277 g_main_context_pop_thread_default (data->context);
279 release_required_types ();
284 /* ---------------------------------------------------------------------------------------------------- */
286 static SharedThreadData *
287 _g_dbus_shared_thread_ref (void)
289 static gsize shared_thread_data = 0;
290 SharedThreadData *ret;
292 if (g_once_init_enter (&shared_thread_data))
294 SharedThreadData *data;
296 /* Work-around for https://bugzilla.gnome.org/show_bug.cgi?id=627724 */
297 ensure_required_types ();
299 data = g_new0 (SharedThreadData, 1);
302 data->context = g_main_context_new ();
303 data->loop = g_main_loop_new (data->context, FALSE);
304 data->thread = g_thread_new ("gdbus",
305 gdbus_shared_thread_func,
307 /* We can cast between gsize and gpointer safely */
308 g_once_init_leave (&shared_thread_data, (gsize) data);
311 ret = (SharedThreadData*) shared_thread_data;
312 g_atomic_int_inc (&ret->refcount);
317 _g_dbus_shared_thread_unref (SharedThreadData *data)
319 /* TODO: actually destroy the shared thread here */
321 g_assert (data != NULL);
322 if (g_atomic_int_dec_and_test (&data->refcount))
324 g_main_loop_quit (data->loop);
325 //g_thread_join (data->thread);
326 g_main_loop_unref (data->loop);
327 g_main_context_unref (data->context);
332 /* ---------------------------------------------------------------------------------------------------- */
343 volatile gint ref_count;
345 SharedThreadData *shared_thread_data;
347 /* really a boolean, but GLib 2.28 lacks atomic boolean ops */
348 volatile gint stopped;
350 /* TODO: frozen (e.g. G_DBUS_CONNECTION_FLAGS_DELAY_MESSAGE_PROCESSING) currently
351 * only affects messages received from the other peer (since GDBusServer is the
352 * only user) - we might want it to affect messages sent to the other peer too?
355 GDBusCapabilityFlags capabilities;
356 GQueue *received_messages_while_frozen;
359 GCancellable *cancellable;
360 GDBusWorkerMessageReceivedCallback message_received_callback;
361 GDBusWorkerMessageAboutToBeSentCallback message_about_to_be_sent_callback;
362 GDBusWorkerDisconnectedCallback disconnected_callback;
365 /* if not NULL, stream is GSocketConnection */
368 /* used for reading */
371 gsize read_buffer_allocated_size;
372 gsize read_buffer_cur_size;
373 gsize read_buffer_bytes_wanted;
374 GUnixFDList *read_fd_list;
375 GSocketControlMessage **read_ancillary_messages;
376 gint read_num_ancillary_messages;
378 /* Whether an async write, flush or close, or none of those, is pending.
379 * Only the worker thread may change its value, and only with the write_lock.
380 * Other threads may read its value when holding the write_lock.
381 * The worker thread may read its value at any time.
383 OutputPending output_pending;
384 /* used for writing */
386 /* queue of MessageToWriteData, protected by write_lock */
388 /* protected by write_lock */
389 guint64 write_num_messages_written;
390 /* number of messages we'd written out last time we flushed;
391 * protected by write_lock
393 guint64 write_num_messages_flushed;
394 /* list of FlushData, protected by write_lock */
395 GList *write_pending_flushes;
396 /* list of CloseData, protected by write_lock */
397 GList *pending_close_attempts;
398 /* no lock - only used from the worker thread */
399 gboolean close_expected;
402 static void _g_dbus_worker_unref (GDBusWorker *worker);
404 /* ---------------------------------------------------------------------------------------------------- */
410 guint64 number_to_wait_for;
414 struct _MessageToWriteData ;
415 typedef struct _MessageToWriteData MessageToWriteData;
417 static void message_to_write_data_free (MessageToWriteData *data);
419 static void read_message_print_transport_debug (gssize bytes_read,
420 GDBusWorker *worker);
422 static void write_message_print_transport_debug (gssize bytes_written,
423 MessageToWriteData *data);
427 GCancellable *cancellable;
428 GSimpleAsyncResult *result;
431 static void close_data_free (CloseData *close_data)
433 if (close_data->cancellable != NULL)
434 g_object_unref (close_data->cancellable);
436 if (close_data->result != NULL)
437 g_object_unref (close_data->result);
439 _g_dbus_worker_unref (close_data->worker);
440 g_slice_free (CloseData, close_data);
443 /* ---------------------------------------------------------------------------------------------------- */
446 _g_dbus_worker_ref (GDBusWorker *worker)
448 g_atomic_int_inc (&worker->ref_count);
453 _g_dbus_worker_unref (GDBusWorker *worker)
455 if (g_atomic_int_dec_and_test (&worker->ref_count))
457 g_assert (worker->write_pending_flushes == NULL);
459 _g_dbus_shared_thread_unref (worker->shared_thread_data);
461 g_object_unref (worker->stream);
463 g_mutex_clear (&worker->read_lock);
464 g_object_unref (worker->cancellable);
465 if (worker->read_fd_list != NULL)
466 g_object_unref (worker->read_fd_list);
468 g_queue_foreach (worker->received_messages_while_frozen, (GFunc) g_object_unref, NULL);
469 g_queue_free (worker->received_messages_while_frozen);
471 g_mutex_clear (&worker->write_lock);
472 g_queue_foreach (worker->write_queue, (GFunc) message_to_write_data_free, NULL);
473 g_queue_free (worker->write_queue);
475 g_free (worker->read_buffer);
482 _g_dbus_worker_emit_disconnected (GDBusWorker *worker,
483 gboolean remote_peer_vanished,
486 if (!g_atomic_int_get (&worker->stopped))
487 worker->disconnected_callback (worker, remote_peer_vanished, error, worker->user_data);
491 _g_dbus_worker_emit_message_received (GDBusWorker *worker,
492 GDBusMessage *message)
494 if (!g_atomic_int_get (&worker->stopped))
495 worker->message_received_callback (worker, message, worker->user_data);
498 static GDBusMessage *
499 _g_dbus_worker_emit_message_about_to_be_sent (GDBusWorker *worker,
500 GDBusMessage *message)
503 if (!g_atomic_int_get (&worker->stopped))
504 ret = worker->message_about_to_be_sent_callback (worker, message, worker->user_data);
510 /* can only be called from private thread with read-lock held - takes ownership of @message */
512 _g_dbus_worker_queue_or_deliver_received_message (GDBusWorker *worker,
513 GDBusMessage *message)
515 if (worker->frozen || g_queue_get_length (worker->received_messages_while_frozen) > 0)
518 g_queue_push_tail (worker->received_messages_while_frozen, message);
522 /* not frozen, nor anything in queue */
523 _g_dbus_worker_emit_message_received (worker, message);
524 g_object_unref (message);
528 /* called in private thread shared by all GDBusConnection instances (without read-lock held) */
530 unfreeze_in_idle_cb (gpointer user_data)
532 GDBusWorker *worker = user_data;
533 GDBusMessage *message;
535 g_mutex_lock (&worker->read_lock);
538 while ((message = g_queue_pop_head (worker->received_messages_while_frozen)) != NULL)
540 _g_dbus_worker_emit_message_received (worker, message);
541 g_object_unref (message);
543 worker->frozen = FALSE;
547 g_assert (g_queue_get_length (worker->received_messages_while_frozen) == 0);
549 g_mutex_unlock (&worker->read_lock);
553 /* can be called from any thread */
555 _g_dbus_worker_unfreeze (GDBusWorker *worker)
557 GSource *idle_source;
558 idle_source = g_idle_source_new ();
559 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
560 g_source_set_callback (idle_source,
562 _g_dbus_worker_ref (worker),
563 (GDestroyNotify) _g_dbus_worker_unref);
564 g_source_attach (idle_source, worker->shared_thread_data->context);
565 g_source_unref (idle_source);
568 /* ---------------------------------------------------------------------------------------------------- */
570 static void _g_dbus_worker_do_read_unlocked (GDBusWorker *worker);
572 /* called in private thread shared by all GDBusConnection instances (without read-lock held) */
574 _g_dbus_worker_do_read_cb (GInputStream *input_stream,
578 GDBusWorker *worker = user_data;
582 g_mutex_lock (&worker->read_lock);
584 /* If already stopped, don't even process the reply */
585 if (g_atomic_int_get (&worker->stopped))
589 if (worker->socket == NULL)
590 bytes_read = g_input_stream_read_finish (g_io_stream_get_input_stream (worker->stream),
594 bytes_read = _g_socket_read_with_control_messages_finish (worker->socket,
597 if (worker->read_num_ancillary_messages > 0)
600 for (n = 0; n < worker->read_num_ancillary_messages; n++)
602 GSocketControlMessage *control_message = G_SOCKET_CONTROL_MESSAGE (worker->read_ancillary_messages[n]);
608 else if (G_IS_UNIX_FD_MESSAGE (control_message))
610 GUnixFDMessage *fd_message;
614 fd_message = G_UNIX_FD_MESSAGE (control_message);
615 fds = g_unix_fd_message_steal_fds (fd_message, &num_fds);
616 if (worker->read_fd_list == NULL)
618 worker->read_fd_list = g_unix_fd_list_new_from_array (fds, num_fds);
623 for (n = 0; n < num_fds; n++)
625 /* TODO: really want a append_steal() */
626 g_unix_fd_list_append (worker->read_fd_list, fds[n], NULL);
632 else if (G_IS_UNIX_CREDENTIALS_MESSAGE (control_message))
644 "Unexpected ancillary message of type %s received from peer",
645 g_type_name (G_TYPE_FROM_INSTANCE (control_message)));
646 _g_dbus_worker_emit_disconnected (worker, TRUE, error);
647 g_error_free (error);
648 g_object_unref (control_message);
650 while (n < worker->read_num_ancillary_messages)
651 g_object_unref (worker->read_ancillary_messages[n++]);
652 g_free (worker->read_ancillary_messages);
656 g_object_unref (control_message);
658 g_free (worker->read_ancillary_messages);
661 if (bytes_read == -1)
663 if (G_UNLIKELY (_g_dbus_debug_transport ()))
665 _g_dbus_debug_print_lock ();
666 g_print ("========================================================================\n"
667 "GDBus-debug:Transport:\n"
668 " ---- READ ERROR on stream of type %s:\n"
670 g_type_name (G_TYPE_FROM_INSTANCE (g_io_stream_get_input_stream (worker->stream))),
671 g_quark_to_string (error->domain), error->code,
673 _g_dbus_debug_print_unlock ();
676 /* Every async read that uses this callback uses worker->cancellable
677 * as its GCancellable. worker->cancellable gets cancelled if and only
678 * if the GDBusConnection tells us to close (either via
679 * _g_dbus_worker_stop, which is called on last-unref, or directly),
680 * so a cancelled read must mean our connection was closed locally.
682 * If we're closing, other errors are possible - notably,
683 * G_IO_ERROR_CLOSED can be seen if we close the stream with an async
684 * read in-flight. It seems sensible to treat all read errors during
685 * closing as an expected thing that doesn't trip exit-on-close.
687 * Because close_expected can't be set until we get into the worker
688 * thread, but the cancellable is signalled sooner (from another
689 * thread), we do still need to check the error.
691 if (worker->close_expected ||
692 g_error_matches (error, G_IO_ERROR, G_IO_ERROR_CANCELLED))
693 _g_dbus_worker_emit_disconnected (worker, FALSE, NULL);
695 _g_dbus_worker_emit_disconnected (worker, TRUE, error);
697 g_error_free (error);
702 g_debug ("read %d bytes (is_closed=%d blocking=%d condition=0x%02x) stream %p, %p",
704 g_socket_is_closed (g_socket_connection_get_socket (G_SOCKET_CONNECTION (worker->stream))),
705 g_socket_get_blocking (g_socket_connection_get_socket (G_SOCKET_CONNECTION (worker->stream))),
706 g_socket_condition_check (g_socket_connection_get_socket (G_SOCKET_CONNECTION (worker->stream)),
707 G_IO_IN | G_IO_OUT | G_IO_HUP),
712 /* TODO: hmm, hmm... */
718 "Underlying GIOStream returned 0 bytes on an async read");
719 _g_dbus_worker_emit_disconnected (worker, TRUE, error);
720 g_error_free (error);
724 read_message_print_transport_debug (bytes_read, worker);
726 worker->read_buffer_cur_size += bytes_read;
727 if (worker->read_buffer_bytes_wanted == worker->read_buffer_cur_size)
729 /* OK, got what we asked for! */
730 if (worker->read_buffer_bytes_wanted == 16)
733 /* OK, got the header - determine how many more bytes are needed */
735 message_len = g_dbus_message_bytes_needed ((guchar *) worker->read_buffer,
738 if (message_len == -1)
740 g_warning ("_g_dbus_worker_do_read_cb: error determing bytes needed: %s", error->message);
741 _g_dbus_worker_emit_disconnected (worker, FALSE, error);
742 g_error_free (error);
746 worker->read_buffer_bytes_wanted = message_len;
747 _g_dbus_worker_do_read_unlocked (worker);
751 GDBusMessage *message;
754 /* TODO: use connection->priv->auth to decode the message */
756 message = g_dbus_message_new_from_blob ((guchar *) worker->read_buffer,
757 worker->read_buffer_cur_size,
758 worker->capabilities,
763 s = _g_dbus_hexdump (worker->read_buffer, worker->read_buffer_cur_size, 2);
764 g_warning ("Error decoding D-Bus message of %" G_GSIZE_FORMAT " bytes\n"
766 "The payload is as follows:\n"
768 worker->read_buffer_cur_size,
772 _g_dbus_worker_emit_disconnected (worker, FALSE, error);
773 g_error_free (error);
778 if (worker->read_fd_list != NULL)
780 g_dbus_message_set_unix_fd_list (message, worker->read_fd_list);
781 g_object_unref (worker->read_fd_list);
782 worker->read_fd_list = NULL;
786 if (G_UNLIKELY (_g_dbus_debug_message ()))
789 _g_dbus_debug_print_lock ();
790 g_print ("========================================================================\n"
791 "GDBus-debug:Message:\n"
792 " <<<< RECEIVED D-Bus message (%" G_GSIZE_FORMAT " bytes)\n",
793 worker->read_buffer_cur_size);
794 s = g_dbus_message_print (message, 2);
797 if (G_UNLIKELY (_g_dbus_debug_payload ()))
799 s = _g_dbus_hexdump (worker->read_buffer, worker->read_buffer_cur_size, 2);
803 _g_dbus_debug_print_unlock ();
806 /* yay, got a message, go deliver it */
807 _g_dbus_worker_queue_or_deliver_received_message (worker, message);
809 /* start reading another message! */
810 worker->read_buffer_bytes_wanted = 0;
811 worker->read_buffer_cur_size = 0;
812 _g_dbus_worker_do_read_unlocked (worker);
817 /* didn't get all the bytes we requested - so repeat the request... */
818 _g_dbus_worker_do_read_unlocked (worker);
822 g_mutex_unlock (&worker->read_lock);
824 /* gives up the reference acquired when calling g_input_stream_read_async() */
825 _g_dbus_worker_unref (worker);
828 /* called in private thread shared by all GDBusConnection instances (with read-lock held) */
830 _g_dbus_worker_do_read_unlocked (GDBusWorker *worker)
832 /* Note that we do need to keep trying to read even if close_expected is
833 * true, because only failing a read causes us to signal 'closed'.
836 /* if bytes_wanted is zero, it means start reading a message */
837 if (worker->read_buffer_bytes_wanted == 0)
839 worker->read_buffer_cur_size = 0;
840 worker->read_buffer_bytes_wanted = 16;
843 /* ensure we have a (big enough) buffer */
844 if (worker->read_buffer == NULL || worker->read_buffer_bytes_wanted > worker->read_buffer_allocated_size)
846 /* TODO: 4096 is randomly chosen; might want a better chosen default minimum */
847 worker->read_buffer_allocated_size = MAX (worker->read_buffer_bytes_wanted, 4096);
848 worker->read_buffer = g_realloc (worker->read_buffer, worker->read_buffer_allocated_size);
851 if (worker->socket == NULL)
852 g_input_stream_read_async (g_io_stream_get_input_stream (worker->stream),
853 worker->read_buffer + worker->read_buffer_cur_size,
854 worker->read_buffer_bytes_wanted - worker->read_buffer_cur_size,
857 (GAsyncReadyCallback) _g_dbus_worker_do_read_cb,
858 _g_dbus_worker_ref (worker));
861 worker->read_ancillary_messages = NULL;
862 worker->read_num_ancillary_messages = 0;
863 _g_socket_read_with_control_messages (worker->socket,
864 worker->read_buffer + worker->read_buffer_cur_size,
865 worker->read_buffer_bytes_wanted - worker->read_buffer_cur_size,
866 &worker->read_ancillary_messages,
867 &worker->read_num_ancillary_messages,
870 (GAsyncReadyCallback) _g_dbus_worker_do_read_cb,
871 _g_dbus_worker_ref (worker));
875 /* called in private thread shared by all GDBusConnection instances (without read-lock held) */
877 _g_dbus_worker_do_initial_read (gpointer data)
879 GDBusWorker *worker = data;
880 g_mutex_lock (&worker->read_lock);
881 _g_dbus_worker_do_read_unlocked (worker);
882 g_mutex_unlock (&worker->read_lock);
886 /* ---------------------------------------------------------------------------------------------------- */
888 struct _MessageToWriteData
891 GDBusMessage *message;
896 GSimpleAsyncResult *simple;
901 message_to_write_data_free (MessageToWriteData *data)
903 _g_dbus_worker_unref (data->worker);
905 g_object_unref (data->message);
910 /* ---------------------------------------------------------------------------------------------------- */
912 static void write_message_continue_writing (MessageToWriteData *data);
914 /* called in private thread shared by all GDBusConnection instances
916 * write-lock is not held on entry
917 * output_pending is PENDING_WRITE on entry
920 write_message_async_cb (GObject *source_object,
924 MessageToWriteData *data = user_data;
925 GSimpleAsyncResult *simple;
926 gssize bytes_written;
929 /* Note: we can't access data->simple after calling g_async_result_complete () because the
930 * callback can free @data and we're not completing in idle. So use a copy of the pointer.
932 simple = data->simple;
935 bytes_written = g_output_stream_write_finish (G_OUTPUT_STREAM (source_object),
938 if (bytes_written == -1)
940 g_simple_async_result_take_error (simple, error);
941 g_simple_async_result_complete (simple);
942 g_object_unref (simple);
945 g_assert (bytes_written > 0); /* zero is never returned */
947 write_message_print_transport_debug (bytes_written, data);
949 data->total_written += bytes_written;
950 g_assert (data->total_written <= data->blob_size);
951 if (data->total_written == data->blob_size)
953 g_simple_async_result_complete (simple);
954 g_object_unref (simple);
958 write_message_continue_writing (data);
964 /* called in private thread shared by all GDBusConnection instances
966 * write-lock is not held on entry
967 * output_pending is PENDING_WRITE on entry
970 on_socket_ready (GSocket *socket,
971 GIOCondition condition,
974 MessageToWriteData *data = user_data;
975 write_message_continue_writing (data);
976 return FALSE; /* remove source */
979 /* called in private thread shared by all GDBusConnection instances
981 * write-lock is not held on entry
982 * output_pending is PENDING_WRITE on entry
985 write_message_continue_writing (MessageToWriteData *data)
987 GOutputStream *ostream;
988 GSimpleAsyncResult *simple;
990 GUnixFDList *fd_list;
993 /* Note: we can't access data->simple after calling g_async_result_complete () because the
994 * callback can free @data and we're not completing in idle. So use a copy of the pointer.
996 simple = data->simple;
998 ostream = g_io_stream_get_output_stream (data->worker->stream);
1000 fd_list = g_dbus_message_get_unix_fd_list (data->message);
1003 g_assert (!g_output_stream_has_pending (ostream));
1004 g_assert_cmpint (data->total_written, <, data->blob_size);
1010 else if (G_IS_SOCKET_OUTPUT_STREAM (ostream) && data->total_written == 0)
1012 GOutputVector vector;
1013 GSocketControlMessage *control_message;
1014 gssize bytes_written;
1017 vector.buffer = data->blob;
1018 vector.size = data->blob_size;
1020 control_message = NULL;
1021 if (fd_list != NULL && g_unix_fd_list_get_length (fd_list) > 0)
1023 if (!(data->worker->capabilities & G_DBUS_CAPABILITY_FLAGS_UNIX_FD_PASSING))
1025 g_simple_async_result_set_error (simple,
1028 "Tried sending a file descriptor but remote peer does not support this capability");
1029 g_simple_async_result_complete (simple);
1030 g_object_unref (simple);
1033 control_message = g_unix_fd_message_new_with_fd_list (fd_list);
1037 bytes_written = g_socket_send_message (data->worker->socket,
1041 control_message != NULL ? &control_message : NULL,
1042 control_message != NULL ? 1 : 0,
1044 data->worker->cancellable,
1046 if (control_message != NULL)
1047 g_object_unref (control_message);
1049 if (bytes_written == -1)
1051 /* Handle WOULD_BLOCK by waiting until there's room in the buffer */
1052 if (g_error_matches (error, G_IO_ERROR, G_IO_ERROR_WOULD_BLOCK))
1055 source = g_socket_create_source (data->worker->socket,
1056 G_IO_OUT | G_IO_HUP | G_IO_ERR,
1057 data->worker->cancellable);
1058 g_source_set_callback (source,
1059 (GSourceFunc) on_socket_ready,
1061 NULL); /* GDestroyNotify */
1062 g_source_attach (source, g_main_context_get_thread_default ());
1063 g_source_unref (source);
1064 g_error_free (error);
1067 g_simple_async_result_take_error (simple, error);
1068 g_simple_async_result_complete (simple);
1069 g_object_unref (simple);
1072 g_assert (bytes_written > 0); /* zero is never returned */
1074 write_message_print_transport_debug (bytes_written, data);
1076 data->total_written += bytes_written;
1077 g_assert (data->total_written <= data->blob_size);
1078 if (data->total_written == data->blob_size)
1080 g_simple_async_result_complete (simple);
1081 g_object_unref (simple);
1085 write_message_continue_writing (data);
1091 if (fd_list != NULL)
1093 g_simple_async_result_set_error (simple,
1096 "Tried sending a file descriptor on unsupported stream of type %s",
1097 g_type_name (G_TYPE_FROM_INSTANCE (ostream)));
1098 g_simple_async_result_complete (simple);
1099 g_object_unref (simple);
1104 g_output_stream_write_async (ostream,
1105 (const gchar *) data->blob + data->total_written,
1106 data->blob_size - data->total_written,
1108 data->worker->cancellable,
1109 write_message_async_cb,
1116 /* called in private thread shared by all GDBusConnection instances
1118 * write-lock is not held on entry
1119 * output_pending is PENDING_WRITE on entry
1122 write_message_async (GDBusWorker *worker,
1123 MessageToWriteData *data,
1124 GAsyncReadyCallback callback,
1127 data->simple = g_simple_async_result_new (NULL,
1130 write_message_async);
1131 data->total_written = 0;
1132 write_message_continue_writing (data);
1135 /* called in private thread shared by all GDBusConnection instances (with write-lock held) */
1137 write_message_finish (GAsyncResult *res,
1140 g_warn_if_fail (g_simple_async_result_get_source_tag (G_SIMPLE_ASYNC_RESULT (res)) == write_message_async);
1141 if (g_simple_async_result_propagate_error (G_SIMPLE_ASYNC_RESULT (res), error))
1146 /* ---------------------------------------------------------------------------------------------------- */
1148 static void continue_writing (GDBusWorker *worker);
1152 GDBusWorker *worker;
1157 flush_data_list_complete (const GList *flushers,
1158 const GError *error)
1162 for (l = flushers; l != NULL; l = l->next)
1164 FlushData *f = l->data;
1166 f->error = error != NULL ? g_error_copy (error) : NULL;
1168 g_mutex_lock (&f->mutex);
1169 g_cond_signal (&f->cond);
1170 g_mutex_unlock (&f->mutex);
1174 /* called in private thread shared by all GDBusConnection instances
1176 * write-lock is not held on entry
1177 * output_pending is PENDING_FLUSH on entry
1180 ostream_flush_cb (GObject *source_object,
1184 FlushAsyncData *data = user_data;
1188 g_output_stream_flush_finish (G_OUTPUT_STREAM (source_object),
1194 if (G_UNLIKELY (_g_dbus_debug_transport ()))
1196 _g_dbus_debug_print_lock ();
1197 g_print ("========================================================================\n"
1198 "GDBus-debug:Transport:\n"
1199 " ---- FLUSHED stream of type %s\n",
1200 g_type_name (G_TYPE_FROM_INSTANCE (g_io_stream_get_output_stream (data->worker->stream))));
1201 _g_dbus_debug_print_unlock ();
1205 g_assert (data->flushers != NULL);
1206 flush_data_list_complete (data->flushers, error);
1207 g_list_free (data->flushers);
1210 g_error_free (error);
1212 /* Make sure we tell folks that we don't have additional
1214 g_mutex_lock (&data->worker->write_lock);
1215 data->worker->write_num_messages_flushed = data->worker->write_num_messages_written;
1216 g_assert (data->worker->output_pending == PENDING_FLUSH);
1217 data->worker->output_pending = PENDING_NONE;
1218 g_mutex_unlock (&data->worker->write_lock);
1220 /* OK, cool, finally kick off the next write */
1221 continue_writing (data->worker);
1223 _g_dbus_worker_unref (data->worker);
1227 /* called in private thread shared by all GDBusConnection instances
1229 * write-lock is not held on entry
1230 * output_pending is PENDING_FLUSH on entry
1233 start_flush (FlushAsyncData *data)
1235 g_output_stream_flush_async (g_io_stream_get_output_stream (data->worker->stream),
1237 data->worker->cancellable,
1242 /* called in private thread shared by all GDBusConnection instances
1244 * write-lock is held on entry
1245 * output_pending is PENDING_NONE on entry
1248 message_written_unlocked (GDBusWorker *worker,
1249 MessageToWriteData *message_data)
1251 if (G_UNLIKELY (_g_dbus_debug_message ()))
1254 _g_dbus_debug_print_lock ();
1255 g_print ("========================================================================\n"
1256 "GDBus-debug:Message:\n"
1257 " >>>> SENT D-Bus message (%" G_GSIZE_FORMAT " bytes)\n",
1258 message_data->blob_size);
1259 s = g_dbus_message_print (message_data->message, 2);
1262 if (G_UNLIKELY (_g_dbus_debug_payload ()))
1264 s = _g_dbus_hexdump (message_data->blob, message_data->blob_size, 2);
1265 g_print ("%s\n", s);
1268 _g_dbus_debug_print_unlock ();
1271 worker->write_num_messages_written += 1;
1274 /* called in private thread shared by all GDBusConnection instances
1276 * write-lock is held on entry
1277 * output_pending is PENDING_NONE on entry
1279 * Returns: non-%NULL, setting @output_pending, if we need to flush now
1281 static FlushAsyncData *
1282 prepare_flush_unlocked (GDBusWorker *worker)
1289 for (l = worker->write_pending_flushes; l != NULL; l = ll)
1291 FlushData *f = l->data;
1294 if (f->number_to_wait_for == worker->write_num_messages_written)
1296 flushers = g_list_append (flushers, f);
1297 worker->write_pending_flushes = g_list_delete_link (worker->write_pending_flushes, l);
1300 if (flushers != NULL)
1302 g_assert (worker->output_pending == PENDING_NONE);
1303 worker->output_pending = PENDING_FLUSH;
1306 if (flushers != NULL)
1308 FlushAsyncData *data;
1310 data = g_new0 (FlushAsyncData, 1);
1311 data->worker = _g_dbus_worker_ref (worker);
1312 data->flushers = flushers;
1319 /* called in private thread shared by all GDBusConnection instances
1321 * write-lock is not held on entry
1322 * output_pending is PENDING_WRITE on entry
1325 write_message_cb (GObject *source_object,
1329 MessageToWriteData *data = user_data;
1332 g_mutex_lock (&data->worker->write_lock);
1333 g_assert (data->worker->output_pending == PENDING_WRITE);
1334 data->worker->output_pending = PENDING_NONE;
1337 if (!write_message_finish (res, &error))
1339 g_mutex_unlock (&data->worker->write_lock);
1342 _g_dbus_worker_emit_disconnected (data->worker, TRUE, error);
1343 g_error_free (error);
1345 g_mutex_lock (&data->worker->write_lock);
1348 message_written_unlocked (data->worker, data);
1350 g_mutex_unlock (&data->worker->write_lock);
1352 continue_writing (data->worker);
1354 message_to_write_data_free (data);
1357 /* called in private thread shared by all GDBusConnection instances
1359 * write-lock is not held on entry
1360 * output_pending is PENDING_CLOSE on entry
1363 iostream_close_cb (GObject *source_object,
1367 GDBusWorker *worker = user_data;
1368 GError *error = NULL;
1369 GList *pending_close_attempts, *pending_flush_attempts;
1372 g_io_stream_close_finish (worker->stream, res, &error);
1374 g_mutex_lock (&worker->write_lock);
1376 pending_close_attempts = worker->pending_close_attempts;
1377 worker->pending_close_attempts = NULL;
1379 pending_flush_attempts = worker->write_pending_flushes;
1380 worker->write_pending_flushes = NULL;
1382 send_queue = worker->write_queue;
1383 worker->write_queue = g_queue_new ();
1385 g_assert (worker->output_pending == PENDING_CLOSE);
1386 worker->output_pending = PENDING_NONE;
1388 g_mutex_unlock (&worker->write_lock);
1390 while (pending_close_attempts != NULL)
1392 CloseData *close_data = pending_close_attempts->data;
1394 pending_close_attempts = g_list_delete_link (pending_close_attempts,
1395 pending_close_attempts);
1397 if (close_data->result != NULL)
1400 g_simple_async_result_set_from_error (close_data->result, error);
1402 /* this must be in an idle because the result is likely to be
1403 * intended for another thread
1405 g_simple_async_result_complete_in_idle (close_data->result);
1408 close_data_free (close_data);
1411 g_clear_error (&error);
1413 /* all messages queued for sending are discarded */
1414 g_queue_foreach (send_queue, (GFunc) message_to_write_data_free, NULL);
1415 g_queue_free (send_queue);
1417 /* all queued flushes fail */
1418 error = g_error_new (G_IO_ERROR, G_IO_ERROR_CANCELLED,
1419 _("Operation was cancelled"));
1420 flush_data_list_complete (pending_flush_attempts, error);
1421 g_list_free (pending_flush_attempts);
1422 g_clear_error (&error);
1424 _g_dbus_worker_unref (worker);
1427 /* called in private thread shared by all GDBusConnection instances
1429 * write-lock is not held on entry
1430 * output_pending must be PENDING_NONE on entry
1433 continue_writing (GDBusWorker *worker)
1435 MessageToWriteData *data;
1436 FlushAsyncData *flush_async_data;
1439 /* we mustn't try to write two things at once */
1440 g_assert (worker->output_pending == PENDING_NONE);
1442 g_mutex_lock (&worker->write_lock);
1444 /* if we want to close the connection, that takes precedence */
1445 if (worker->pending_close_attempts != NULL)
1447 worker->close_expected = TRUE;
1448 worker->output_pending = PENDING_CLOSE;
1450 g_io_stream_close_async (worker->stream, G_PRIORITY_DEFAULT,
1451 NULL, iostream_close_cb,
1452 _g_dbus_worker_ref (worker));
1457 flush_async_data = prepare_flush_unlocked (worker);
1459 if (flush_async_data == NULL)
1461 data = g_queue_pop_head (worker->write_queue);
1464 worker->output_pending = PENDING_WRITE;
1472 g_mutex_unlock (&worker->write_lock);
1474 /* Note that write_lock is only used for protecting the @write_queue
1475 * and @output_pending fields of the GDBusWorker struct ... which we
1476 * need to modify from arbitrary threads in _g_dbus_worker_send_message().
1478 * Therefore, it's fine to drop it here when calling back into user
1479 * code and then writing the message out onto the GIOStream since this
1480 * function only runs on the worker thread.
1483 if (flush_async_data != NULL)
1485 start_flush (flush_async_data);
1486 g_assert (data == NULL);
1488 else if (data != NULL)
1490 GDBusMessage *old_message;
1492 gsize new_blob_size;
1495 old_message = data->message;
1496 data->message = _g_dbus_worker_emit_message_about_to_be_sent (worker, data->message);
1497 if (data->message == old_message)
1499 /* filters had no effect - do nothing */
1501 else if (data->message == NULL)
1503 /* filters dropped message */
1504 g_mutex_lock (&worker->write_lock);
1505 worker->output_pending = PENDING_NONE;
1506 g_mutex_unlock (&worker->write_lock);
1507 message_to_write_data_free (data);
1512 /* filters altered the message -> reencode */
1514 new_blob = g_dbus_message_to_blob (data->message,
1516 worker->capabilities,
1518 if (new_blob == NULL)
1520 /* if filter make the GDBusMessage unencodeable, just complain on stderr and send
1521 * the old message instead
1523 g_warning ("Error encoding GDBusMessage with serial %d altered by filter function: %s",
1524 g_dbus_message_get_serial (data->message),
1526 g_error_free (error);
1530 g_free (data->blob);
1531 data->blob = (gchar *) new_blob;
1532 data->blob_size = new_blob_size;
1536 write_message_async (worker,
1543 /* called in private thread shared by all GDBusConnection instances
1545 * write-lock is not held on entry
1546 * output_pending may be anything
1549 continue_writing_in_idle_cb (gpointer user_data)
1551 GDBusWorker *worker = user_data;
1553 /* Because this is the worker thread, we can read this struct member
1554 * without holding the lock: no other thread ever modifies it.
1556 if (worker->output_pending == PENDING_NONE)
1557 continue_writing (worker);
1563 * @write_data: (transfer full) (allow-none):
1564 * @flush_data: (transfer full) (allow-none):
1565 * @close_data: (transfer full) (allow-none):
1567 * Can be called from any thread
1569 * write_lock is held on entry
1570 * output_pending may be anything
1573 schedule_writing_unlocked (GDBusWorker *worker,
1574 MessageToWriteData *write_data,
1575 FlushData *flush_data,
1576 CloseData *close_data)
1578 if (write_data != NULL)
1579 g_queue_push_tail (worker->write_queue, write_data);
1581 if (flush_data != NULL)
1582 worker->write_pending_flushes = g_list_prepend (worker->write_pending_flushes, flush_data);
1584 if (close_data != NULL)
1585 worker->pending_close_attempts = g_list_prepend (worker->pending_close_attempts,
1588 /* If we had output pending, the next bit of output will happen
1589 * automatically when it finishes, so we only need to do this
1590 * if nothing was pending.
1592 * The idle callback will re-check that output_pending is still
1593 * PENDING_NONE, to guard against output starting before the idle.
1595 if (worker->output_pending == PENDING_NONE)
1597 GSource *idle_source;
1598 idle_source = g_idle_source_new ();
1599 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
1600 g_source_set_callback (idle_source,
1601 continue_writing_in_idle_cb,
1602 _g_dbus_worker_ref (worker),
1603 (GDestroyNotify) _g_dbus_worker_unref);
1604 g_source_attach (idle_source, worker->shared_thread_data->context);
1605 g_source_unref (idle_source);
1609 /* ---------------------------------------------------------------------------------------------------- */
1611 /* can be called from any thread - steals blob
1613 * write_lock is not held on entry
1614 * output_pending may be anything
1617 _g_dbus_worker_send_message (GDBusWorker *worker,
1618 GDBusMessage *message,
1622 MessageToWriteData *data;
1624 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
1625 g_return_if_fail (blob != NULL);
1626 g_return_if_fail (blob_len > 16);
1628 data = g_new0 (MessageToWriteData, 1);
1629 data->worker = _g_dbus_worker_ref (worker);
1630 data->message = g_object_ref (message);
1631 data->blob = blob; /* steal! */
1632 data->blob_size = blob_len;
1634 g_mutex_lock (&worker->write_lock);
1635 schedule_writing_unlocked (worker, data, NULL, NULL);
1636 g_mutex_unlock (&worker->write_lock);
1639 /* ---------------------------------------------------------------------------------------------------- */
1642 _g_dbus_worker_new (GIOStream *stream,
1643 GDBusCapabilityFlags capabilities,
1644 gboolean initially_frozen,
1645 GDBusWorkerMessageReceivedCallback message_received_callback,
1646 GDBusWorkerMessageAboutToBeSentCallback message_about_to_be_sent_callback,
1647 GDBusWorkerDisconnectedCallback disconnected_callback,
1650 GDBusWorker *worker;
1651 GSource *idle_source;
1653 g_return_val_if_fail (G_IS_IO_STREAM (stream), NULL);
1654 g_return_val_if_fail (message_received_callback != NULL, NULL);
1655 g_return_val_if_fail (message_about_to_be_sent_callback != NULL, NULL);
1656 g_return_val_if_fail (disconnected_callback != NULL, NULL);
1658 worker = g_new0 (GDBusWorker, 1);
1659 worker->ref_count = 1;
1661 g_mutex_init (&worker->read_lock);
1662 worker->message_received_callback = message_received_callback;
1663 worker->message_about_to_be_sent_callback = message_about_to_be_sent_callback;
1664 worker->disconnected_callback = disconnected_callback;
1665 worker->user_data = user_data;
1666 worker->stream = g_object_ref (stream);
1667 worker->capabilities = capabilities;
1668 worker->cancellable = g_cancellable_new ();
1669 worker->output_pending = PENDING_NONE;
1671 worker->frozen = initially_frozen;
1672 worker->received_messages_while_frozen = g_queue_new ();
1674 g_mutex_init (&worker->write_lock);
1675 worker->write_queue = g_queue_new ();
1677 if (G_IS_SOCKET_CONNECTION (worker->stream))
1678 worker->socket = g_socket_connection_get_socket (G_SOCKET_CONNECTION (worker->stream));
1680 worker->shared_thread_data = _g_dbus_shared_thread_ref ();
1683 idle_source = g_idle_source_new ();
1684 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
1685 g_source_set_callback (idle_source,
1686 _g_dbus_worker_do_initial_read,
1687 _g_dbus_worker_ref (worker),
1688 (GDestroyNotify) _g_dbus_worker_unref);
1689 g_source_attach (idle_source, worker->shared_thread_data->context);
1690 g_source_unref (idle_source);
1695 /* ---------------------------------------------------------------------------------------------------- */
1697 /* can be called from any thread
1699 * write_lock is not held on entry
1700 * output_pending may be anything
1703 _g_dbus_worker_close (GDBusWorker *worker,
1704 GCancellable *cancellable,
1705 GSimpleAsyncResult *result)
1707 CloseData *close_data;
1709 close_data = g_slice_new0 (CloseData);
1710 close_data->worker = _g_dbus_worker_ref (worker);
1711 close_data->cancellable =
1712 (cancellable == NULL ? NULL : g_object_ref (cancellable));
1713 close_data->result = (result == NULL ? NULL : g_object_ref (result));
1715 /* Don't set worker->close_expected here - we're in the wrong thread.
1716 * It'll be set before the actual close happens.
1718 g_cancellable_cancel (worker->cancellable);
1719 g_mutex_lock (&worker->write_lock);
1720 schedule_writing_unlocked (worker, NULL, NULL, close_data);
1721 g_mutex_unlock (&worker->write_lock);
1724 /* This can be called from any thread - frees worker. Note that
1725 * callbacks might still happen if called from another thread than the
1726 * worker - use your own synchronization primitive in the callbacks.
1728 * write_lock is not held on entry
1729 * output_pending may be anything
1732 _g_dbus_worker_stop (GDBusWorker *worker)
1734 g_atomic_int_set (&worker->stopped, TRUE);
1736 /* Cancel any pending operations and schedule a close of the underlying I/O
1737 * stream in the worker thread
1739 _g_dbus_worker_close (worker, NULL, NULL);
1741 /* _g_dbus_worker_close holds a ref until after an idle in the the worker
1742 * thread has run, so we no longer need to unref in an idle like in
1745 _g_dbus_worker_unref (worker);
1748 /* ---------------------------------------------------------------------------------------------------- */
1750 /* can be called from any thread (except the worker thread) - blocks
1751 * calling thread until all queued outgoing messages are written and
1752 * the transport has been flushed
1754 * write_lock is not held on entry
1755 * output_pending may be anything
1758 _g_dbus_worker_flush_sync (GDBusWorker *worker,
1759 GCancellable *cancellable,
1764 guint64 pending_writes;
1769 g_mutex_lock (&worker->write_lock);
1771 /* if the queue is empty, no write is in-flight and we haven't written
1772 * anything since the last flush, then there's nothing to wait for
1774 pending_writes = g_queue_get_length (worker->write_queue);
1776 /* if a write is in-flight, we shouldn't be satisfied until the first
1777 * flush operation that follows it
1779 if (worker->output_pending == PENDING_WRITE)
1780 pending_writes += 1;
1782 if (pending_writes > 0 ||
1783 worker->write_num_messages_written != worker->write_num_messages_flushed)
1785 data = g_new0 (FlushData, 1);
1786 g_mutex_init (&data->mutex);
1787 g_cond_init (&data->cond);
1788 data->number_to_wait_for = worker->write_num_messages_written + pending_writes;
1789 g_mutex_lock (&data->mutex);
1791 schedule_writing_unlocked (worker, NULL, data, NULL);
1793 g_mutex_unlock (&worker->write_lock);
1797 g_cond_wait (&data->cond, &data->mutex);
1798 g_mutex_unlock (&data->mutex);
1800 /* note:the element is removed from worker->write_pending_flushes in flush_cb() above */
1801 g_cond_clear (&data->cond);
1802 g_mutex_clear (&data->mutex);
1803 if (data->error != NULL)
1806 g_propagate_error (error, data->error);
1814 /* ---------------------------------------------------------------------------------------------------- */
1816 #define G_DBUS_DEBUG_AUTHENTICATION (1<<0)
1817 #define G_DBUS_DEBUG_TRANSPORT (1<<1)
1818 #define G_DBUS_DEBUG_MESSAGE (1<<2)
1819 #define G_DBUS_DEBUG_PAYLOAD (1<<3)
1820 #define G_DBUS_DEBUG_CALL (1<<4)
1821 #define G_DBUS_DEBUG_SIGNAL (1<<5)
1822 #define G_DBUS_DEBUG_INCOMING (1<<6)
1823 #define G_DBUS_DEBUG_RETURN (1<<7)
1824 #define G_DBUS_DEBUG_EMISSION (1<<8)
1825 #define G_DBUS_DEBUG_ADDRESS (1<<9)
1827 static gint _gdbus_debug_flags = 0;
1830 _g_dbus_debug_authentication (void)
1832 _g_dbus_initialize ();
1833 return (_gdbus_debug_flags & G_DBUS_DEBUG_AUTHENTICATION) != 0;
1837 _g_dbus_debug_transport (void)
1839 _g_dbus_initialize ();
1840 return (_gdbus_debug_flags & G_DBUS_DEBUG_TRANSPORT) != 0;
1844 _g_dbus_debug_message (void)
1846 _g_dbus_initialize ();
1847 return (_gdbus_debug_flags & G_DBUS_DEBUG_MESSAGE) != 0;
1851 _g_dbus_debug_payload (void)
1853 _g_dbus_initialize ();
1854 return (_gdbus_debug_flags & G_DBUS_DEBUG_PAYLOAD) != 0;
1858 _g_dbus_debug_call (void)
1860 _g_dbus_initialize ();
1861 return (_gdbus_debug_flags & G_DBUS_DEBUG_CALL) != 0;
1865 _g_dbus_debug_signal (void)
1867 _g_dbus_initialize ();
1868 return (_gdbus_debug_flags & G_DBUS_DEBUG_SIGNAL) != 0;
1872 _g_dbus_debug_incoming (void)
1874 _g_dbus_initialize ();
1875 return (_gdbus_debug_flags & G_DBUS_DEBUG_INCOMING) != 0;
1879 _g_dbus_debug_return (void)
1881 _g_dbus_initialize ();
1882 return (_gdbus_debug_flags & G_DBUS_DEBUG_RETURN) != 0;
1886 _g_dbus_debug_emission (void)
1888 _g_dbus_initialize ();
1889 return (_gdbus_debug_flags & G_DBUS_DEBUG_EMISSION) != 0;
1893 _g_dbus_debug_address (void)
1895 _g_dbus_initialize ();
1896 return (_gdbus_debug_flags & G_DBUS_DEBUG_ADDRESS) != 0;
1899 G_LOCK_DEFINE_STATIC (print_lock);
1902 _g_dbus_debug_print_lock (void)
1904 G_LOCK (print_lock);
1908 _g_dbus_debug_print_unlock (void)
1910 G_UNLOCK (print_lock);
1914 * _g_dbus_initialize:
1916 * Does various one-time init things such as
1918 * - registering the G_DBUS_ERROR error domain
1919 * - parses the G_DBUS_DEBUG environment variable
1922 _g_dbus_initialize (void)
1924 static volatile gsize initialized = 0;
1926 if (g_once_init_enter (&initialized))
1928 volatile GQuark g_dbus_error_domain;
1931 g_dbus_error_domain = G_DBUS_ERROR;
1932 (g_dbus_error_domain); /* To avoid -Wunused-but-set-variable */
1934 debug = g_getenv ("G_DBUS_DEBUG");
1937 const GDebugKey keys[] = {
1938 { "authentication", G_DBUS_DEBUG_AUTHENTICATION },
1939 { "transport", G_DBUS_DEBUG_TRANSPORT },
1940 { "message", G_DBUS_DEBUG_MESSAGE },
1941 { "payload", G_DBUS_DEBUG_PAYLOAD },
1942 { "call", G_DBUS_DEBUG_CALL },
1943 { "signal", G_DBUS_DEBUG_SIGNAL },
1944 { "incoming", G_DBUS_DEBUG_INCOMING },
1945 { "return", G_DBUS_DEBUG_RETURN },
1946 { "emission", G_DBUS_DEBUG_EMISSION },
1947 { "address", G_DBUS_DEBUG_ADDRESS }
1950 _gdbus_debug_flags = g_parse_debug_string (debug, keys, G_N_ELEMENTS (keys));
1951 if (_gdbus_debug_flags & G_DBUS_DEBUG_PAYLOAD)
1952 _gdbus_debug_flags |= G_DBUS_DEBUG_MESSAGE;
1955 g_once_init_leave (&initialized, 1);
1959 /* ---------------------------------------------------------------------------------------------------- */
1962 _g_dbus_compute_complete_signature (GDBusArgInfo **args)
1964 const GVariantType *arg_types[256];
1968 for (n = 0; args[n] != NULL; n++)
1970 /* DBus places a hard limit of 255 on signature length.
1971 * therefore number of args must be less than 256.
1975 arg_types[n] = G_VARIANT_TYPE (args[n]->signature);
1977 if G_UNLIKELY (arg_types[n] == NULL)
1983 return g_variant_type_new_tuple (arg_types, n);
1986 /* ---------------------------------------------------------------------------------------------------- */
1990 extern BOOL WINAPI ConvertSidToStringSidA (PSID Sid, LPSTR *StringSid);
1993 _g_dbus_win32_get_user_sid (void)
1997 DWORD token_information_len;
2004 h = INVALID_HANDLE_VALUE;
2006 if (!OpenProcessToken (GetCurrentProcess (), TOKEN_QUERY, &h))
2008 g_warning ("OpenProcessToken failed with error code %d", (gint) GetLastError ());
2012 /* Get length of buffer */
2013 token_information_len = 0;
2014 if (!GetTokenInformation (h, TokenUser, NULL, 0, &token_information_len))
2016 if (GetLastError () != ERROR_INSUFFICIENT_BUFFER)
2018 g_warning ("GetTokenInformation() failed with error code %d", (gint) GetLastError ());
2022 user = g_malloc (token_information_len);
2023 if (!GetTokenInformation (h, TokenUser, user, token_information_len, &token_information_len))
2025 g_warning ("GetTokenInformation() failed with error code %d", (gint) GetLastError ());
2029 psid = user->User.Sid;
2030 if (!IsValidSid (psid))
2032 g_warning ("Invalid SID");
2036 if (!ConvertSidToStringSidA (psid, &sid))
2038 g_warning ("Invalid SID");
2042 ret = g_strdup (sid);
2047 if (h != INVALID_HANDLE_VALUE)
2053 /* ---------------------------------------------------------------------------------------------------- */
2056 _g_dbus_get_machine_id (GError **error)
2059 GError *first_error;
2060 /* TODO: use PACKAGE_LOCALSTATEDIR ? */
2063 if (!g_file_get_contents ("/var/lib/dbus/machine-id",
2067 !g_file_get_contents ("/etc/machine-id",
2072 g_propagate_prefixed_error (error, first_error,
2073 _("Unable to load /var/lib/dbus/machine-id or /etc/machine-id: "));
2077 /* ignore the error from the first try, if any */
2078 g_clear_error (&first_error);
2079 /* TODO: validate value */
2085 /* ---------------------------------------------------------------------------------------------------- */
2088 _g_dbus_enum_to_string (GType enum_type, gint value)
2092 GEnumValue *enum_value;
2094 klass = g_type_class_ref (enum_type);
2095 enum_value = g_enum_get_value (klass, value);
2096 if (enum_value != NULL)
2097 ret = g_strdup (enum_value->value_nick);
2099 ret = g_strdup_printf ("unknown (value %d)", value);
2100 g_type_class_unref (klass);
2104 /* ---------------------------------------------------------------------------------------------------- */
2107 write_message_print_transport_debug (gssize bytes_written,
2108 MessageToWriteData *data)
2110 if (G_LIKELY (!_g_dbus_debug_transport ()))
2113 _g_dbus_debug_print_lock ();
2114 g_print ("========================================================================\n"
2115 "GDBus-debug:Transport:\n"
2116 " >>>> WROTE %" G_GSIZE_FORMAT " bytes of message with serial %d and\n"
2117 " size %" G_GSIZE_FORMAT " from offset %" G_GSIZE_FORMAT " on a %s\n",
2119 g_dbus_message_get_serial (data->message),
2121 data->total_written,
2122 g_type_name (G_TYPE_FROM_INSTANCE (g_io_stream_get_output_stream (data->worker->stream))));
2123 _g_dbus_debug_print_unlock ();
2128 /* ---------------------------------------------------------------------------------------------------- */
2131 read_message_print_transport_debug (gssize bytes_read,
2132 GDBusWorker *worker)
2136 gint32 message_length;
2138 if (G_LIKELY (!_g_dbus_debug_transport ()))
2141 size = bytes_read + worker->read_buffer_cur_size;
2145 message_length = g_dbus_message_bytes_needed ((guchar *) worker->read_buffer, size, NULL);
2148 switch (worker->read_buffer[0])
2152 serial = GUINT32_FROM_LE (((guint32 *) worker->read_buffer)[2]);
2156 serial = GUINT32_FROM_BE (((guint32 *) worker->read_buffer)[2]);
2159 /* an error will be set elsewhere if this happens */
2164 _g_dbus_debug_print_lock ();
2165 g_print ("========================================================================\n"
2166 "GDBus-debug:Transport:\n"
2167 " <<<< READ %" G_GSIZE_FORMAT " bytes of message with serial %d and\n"
2168 " size %d to offset %" G_GSIZE_FORMAT " from a %s\n",
2172 worker->read_buffer_cur_size,
2173 g_type_name (G_TYPE_FROM_INSTANCE (g_io_stream_get_input_stream (worker->stream))));
2174 _g_dbus_debug_print_unlock ();
2179 /* ---------------------------------------------------------------------------------------------------- */
2182 _g_signal_accumulator_false_handled (GSignalInvocationHint *ihint,
2183 GValue *return_accu,
2184 const GValue *handler_return,
2187 gboolean continue_emission;
2188 gboolean signal_return;
2190 signal_return = g_value_get_boolean (handler_return);
2191 g_value_set_boolean (return_accu, signal_return);
2192 continue_emission = signal_return;
2194 return continue_emission;