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 "glib/gstdio.h"
43 #include "gsocketcontrolmessage.h"
44 #include "gsocketconnection.h"
45 #include "gkdbusconnection.h"
46 #include "gsocketoutputstream.h"
49 #include "gunixfdmessage.h"
50 #include "gunixconnection.h"
51 #include "gunixcredentialsmessage.h"
60 static gboolean _g_dbus_worker_do_initial_read (gpointer data);
62 /* ---------------------------------------------------------------------------------------------------- */
65 _g_dbus_hexdump (const gchar *data, gsize len, guint indent)
70 ret = g_string_new (NULL);
72 for (n = 0; n < len; n += 16)
74 g_string_append_printf (ret, "%*s%04x: ", indent, "", n);
76 for (m = n; m < n + 16; m++)
78 if (m > n && (m%4) == 0)
79 g_string_append_c (ret, ' ');
81 g_string_append_printf (ret, "%02x ", (guchar) data[m]);
83 g_string_append (ret, " ");
86 g_string_append (ret, " ");
88 for (m = n; m < len && m < n + 16; m++)
89 g_string_append_c (ret, g_ascii_isprint (data[m]) ? data[m] : '.');
91 g_string_append_c (ret, '\n');
94 return g_string_free (ret, FALSE);
97 /* ---------------------------------------------------------------------------------------------------- */
99 /* Unfortunately ancillary messages are discarded when reading from a
100 * socket using the GSocketInputStream abstraction. So we provide a
101 * very GInputStream-ish API that uses GSocket in this case (very
102 * similar to GSocketInputStream).
108 GCancellable *cancellable;
113 GSocketControlMessage ***messages;
116 GSimpleAsyncResult *simple;
118 gboolean from_mainloop;
119 } ReadWithControlData;
122 read_with_control_data_free (ReadWithControlData *data)
124 g_object_unref (data->socket);
125 if (data->cancellable != NULL)
126 g_object_unref (data->cancellable);
127 g_object_unref (data->simple);
132 _g_socket_read_with_control_messages_ready (GSocket *socket,
133 GIOCondition condition,
136 ReadWithControlData *data = user_data;
142 vector.buffer = data->buffer;
143 vector.size = data->count;
144 result = g_socket_receive_message (data->socket,
155 g_simple_async_result_set_op_res_gssize (data->simple, result);
159 g_assert (error != NULL);
160 g_simple_async_result_take_error (data->simple, error);
163 if (data->from_mainloop)
164 g_simple_async_result_complete (data->simple);
166 g_simple_async_result_complete_in_idle (data->simple);
172 _g_socket_read_with_control_messages (GSocket *socket,
175 GSocketControlMessage ***messages,
178 GCancellable *cancellable,
179 GAsyncReadyCallback callback,
182 ReadWithControlData *data;
184 data = g_new0 (ReadWithControlData, 1);
185 data->socket = g_object_ref (socket);
186 data->cancellable = cancellable != NULL ? g_object_ref (cancellable) : NULL;
187 data->buffer = buffer;
189 data->messages = messages;
190 data->num_messages = num_messages;
192 data->simple = g_simple_async_result_new (G_OBJECT (socket),
195 _g_socket_read_with_control_messages);
196 g_simple_async_result_set_check_cancellable (data->simple, cancellable);
198 if (!g_socket_condition_check (socket, G_IO_IN))
201 data->from_mainloop = TRUE;
202 source = g_socket_create_source (data->socket,
203 G_IO_IN | G_IO_HUP | G_IO_ERR,
205 g_source_set_callback (source,
206 (GSourceFunc) _g_socket_read_with_control_messages_ready,
208 (GDestroyNotify) read_with_control_data_free);
209 g_source_attach (source, g_main_context_get_thread_default ());
210 g_source_unref (source);
214 _g_socket_read_with_control_messages_ready (data->socket, G_IO_IN, data);
215 read_with_control_data_free (data);
220 _g_socket_read_with_control_messages_finish (GSocket *socket,
221 GAsyncResult *result,
224 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
226 g_return_val_if_fail (G_IS_SOCKET (socket), -1);
227 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == _g_socket_read_with_control_messages);
229 if (g_simple_async_result_propagate_error (simple, error))
232 return g_simple_async_result_get_op_res_gssize (simple);
235 /* ---------------------------------------------------------------------------------------------------- */
237 /* Work-around for https://bugzilla.gnome.org/show_bug.cgi?id=627724 */
239 static GPtrArray *ensured_classes = NULL;
242 ensure_type (GType gtype)
244 g_ptr_array_add (ensured_classes, g_type_class_ref (gtype));
248 release_required_types (void)
250 g_ptr_array_foreach (ensured_classes, (GFunc) g_type_class_unref, NULL);
251 g_ptr_array_unref (ensured_classes);
252 ensured_classes = NULL;
256 ensure_required_types (void)
258 g_assert (ensured_classes == NULL);
259 ensured_classes = g_ptr_array_new ();
260 ensure_type (G_TYPE_SIMPLE_ASYNC_RESULT);
261 ensure_type (G_TYPE_MEMORY_INPUT_STREAM);
263 /* ---------------------------------------------------------------------------------------------------- */
267 volatile gint refcount;
269 GMainContext *context;
274 gdbus_shared_thread_func (gpointer user_data)
276 SharedThreadData *data = user_data;
278 g_main_context_push_thread_default (data->context);
279 g_main_loop_run (data->loop);
280 g_main_context_pop_thread_default (data->context);
282 release_required_types ();
287 /* ---------------------------------------------------------------------------------------------------- */
289 static SharedThreadData *
290 _g_dbus_shared_thread_ref (void)
292 static gsize shared_thread_data = 0;
293 SharedThreadData *ret;
295 if (g_once_init_enter (&shared_thread_data))
297 SharedThreadData *data;
299 /* Work-around for https://bugzilla.gnome.org/show_bug.cgi?id=627724 */
300 ensure_required_types ();
302 data = g_new0 (SharedThreadData, 1);
305 data->context = g_main_context_new ();
306 data->loop = g_main_loop_new (data->context, FALSE);
307 data->thread = g_thread_new ("gdbus",
308 gdbus_shared_thread_func,
310 /* We can cast between gsize and gpointer safely */
311 g_once_init_leave (&shared_thread_data, (gsize) data);
314 ret = (SharedThreadData*) shared_thread_data;
315 g_atomic_int_inc (&ret->refcount);
320 _g_dbus_shared_thread_unref (SharedThreadData *data)
322 /* TODO: actually destroy the shared thread here */
324 g_assert (data != NULL);
325 if (g_atomic_int_dec_and_test (&data->refcount))
327 g_main_loop_quit (data->loop);
328 //g_thread_join (data->thread);
329 g_main_loop_unref (data->loop);
330 g_main_context_unref (data->context);
335 /* ---------------------------------------------------------------------------------------------------- */
346 volatile gint ref_count;
348 SharedThreadData *shared_thread_data;
350 /* really a boolean, but GLib 2.28 lacks atomic boolean ops */
351 volatile gint stopped;
353 /* TODO: frozen (e.g. G_DBUS_CONNECTION_FLAGS_DELAY_MESSAGE_PROCESSING) currently
354 * only affects messages received from the other peer (since GDBusServer is the
355 * only user) - we might want it to affect messages sent to the other peer too?
358 GDBusCapabilityFlags capabilities;
359 GQueue *received_messages_while_frozen;
362 GCancellable *cancellable;
363 GDBusWorkerMessageReceivedCallback message_received_callback;
364 GDBusWorkerMessageAboutToBeSentCallback message_about_to_be_sent_callback;
365 GDBusWorkerDisconnectedCallback disconnected_callback;
368 /* if GSocket and GKdbus are NULL, stream is GSocketConnection */
372 /* used for reading */
375 gsize read_buffer_allocated_size;
376 gsize read_buffer_cur_size;
377 gsize read_buffer_bytes_wanted;
378 GUnixFDList *read_fd_list;
379 GSocketControlMessage **read_ancillary_messages;
380 gint read_num_ancillary_messages;
382 /* Whether an async write, flush or close, or none of those, is pending.
383 * Only the worker thread may change its value, and only with the write_lock.
384 * Other threads may read its value when holding the write_lock.
385 * The worker thread may read its value at any time.
387 OutputPending output_pending;
388 /* used for writing */
390 /* queue of MessageToWriteData, protected by write_lock */
392 /* protected by write_lock */
393 guint64 write_num_messages_written;
394 /* number of messages we'd written out last time we flushed;
395 * protected by write_lock
397 guint64 write_num_messages_flushed;
398 /* list of FlushData, protected by write_lock */
399 GList *write_pending_flushes;
400 /* list of CloseData, protected by write_lock */
401 GList *pending_close_attempts;
402 /* no lock - only used from the worker thread */
403 gboolean close_expected;
406 static void _g_dbus_worker_unref (GDBusWorker *worker);
408 /* ---------------------------------------------------------------------------------------------------- */
414 guint64 number_to_wait_for;
418 struct _MessageToWriteData ;
419 typedef struct _MessageToWriteData MessageToWriteData;
421 static void message_to_write_data_free (MessageToWriteData *data);
423 static void read_message_print_transport_debug (gssize bytes_read,
424 GDBusWorker *worker);
426 static void write_message_print_transport_debug (gssize bytes_written,
427 MessageToWriteData *data);
431 GCancellable *cancellable;
432 GSimpleAsyncResult *result;
435 static void close_data_free (CloseData *close_data)
437 if (close_data->cancellable != NULL)
438 g_object_unref (close_data->cancellable);
440 if (close_data->result != NULL)
441 g_object_unref (close_data->result);
443 _g_dbus_worker_unref (close_data->worker);
444 g_slice_free (CloseData, close_data);
447 /* ---------------------------------------------------------------------------------------------------- */
450 _g_dbus_worker_ref (GDBusWorker *worker)
452 g_atomic_int_inc (&worker->ref_count);
457 _g_dbus_worker_unref (GDBusWorker *worker)
459 if (g_atomic_int_dec_and_test (&worker->ref_count))
461 g_assert (worker->write_pending_flushes == NULL);
463 _g_dbus_shared_thread_unref (worker->shared_thread_data);
465 g_object_unref (worker->stream);
467 g_mutex_clear (&worker->read_lock);
468 g_object_unref (worker->cancellable);
469 if (worker->read_fd_list != NULL)
470 g_object_unref (worker->read_fd_list);
472 g_queue_free_full (worker->received_messages_while_frozen, (GDestroyNotify) g_object_unref);
473 g_mutex_clear (&worker->write_lock);
474 g_queue_free_full (worker->write_queue, (GDestroyNotify) message_to_write_data_free);
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);
627 (void) g_close (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 determining 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
971 on_socket_ready (GSocket *socket,
972 GIOCondition condition,
975 MessageToWriteData *data = user_data;
976 write_message_continue_writing (data);
977 return FALSE; /* remove source */
981 /* called in private thread shared by all GDBusConnection instances
983 * write-lock is not held on entry
984 * output_pending is PENDING_WRITE on entry
987 write_message_continue_writing (MessageToWriteData *data)
990 GSimpleAsyncResult *simple;
991 simple = data->simple;
994 if (G_IS_KDBUS_CONNECTION (data->worker->stream))
996 g_print("THIS IS KDBUS!\n");
1000 GOutputStream *ostream;
1002 GUnixFDList *fd_list;
1005 ostream = g_io_stream_get_output_stream (data->worker->stream);
1007 fd_list = g_dbus_message_get_unix_fd_list (data->message);
1010 g_assert (!g_output_stream_has_pending (ostream));
1011 g_assert_cmpint (data->total_written, <, data->blob_size);
1017 else if (G_IS_SOCKET_OUTPUT_STREAM (ostream) && data->total_written == 0)
1019 GOutputVector vector;
1020 GSocketControlMessage *control_message;
1021 gssize bytes_written;
1024 vector.buffer = data->blob;
1025 vector.size = data->blob_size;
1027 control_message = NULL;
1028 if (fd_list != NULL && g_unix_fd_list_get_length (fd_list) > 0)
1030 if (!(data->worker->capabilities & G_DBUS_CAPABILITY_FLAGS_UNIX_FD_PASSING))
1032 g_simple_async_result_set_error (simple,
1035 "Tried sending a file descriptor but remote peer does not support this capability");
1036 g_simple_async_result_complete (simple);
1037 g_object_unref (simple);
1040 control_message = g_unix_fd_message_new_with_fd_list (fd_list);
1044 bytes_written = g_socket_send_message (data->worker->socket,
1048 control_message != NULL ? &control_message : NULL,
1049 control_message != NULL ? 1 : 0,
1051 data->worker->cancellable,
1053 if (control_message != NULL)
1054 g_object_unref (control_message);
1056 if (bytes_written == -1)
1058 /* Handle WOULD_BLOCK by waiting until there's room in the buffer */
1059 if (g_error_matches (error, G_IO_ERROR, G_IO_ERROR_WOULD_BLOCK))
1062 source = g_socket_create_source (data->worker->socket,
1063 G_IO_OUT | G_IO_HUP | G_IO_ERR,
1064 data->worker->cancellable);
1065 g_source_set_callback (source,
1066 (GSourceFunc) on_socket_ready,
1068 NULL); /* GDestroyNotify */
1069 g_source_attach (source, g_main_context_get_thread_default ());
1070 g_source_unref (source);
1071 g_error_free (error);
1074 g_simple_async_result_take_error (simple, error);
1075 g_simple_async_result_complete (simple);
1076 g_object_unref (simple);
1079 g_assert (bytes_written > 0); /* zero is never returned */
1081 write_message_print_transport_debug (bytes_written, data);
1083 data->total_written += bytes_written;
1084 g_assert (data->total_written <= data->blob_size);
1085 if (data->total_written == data->blob_size)
1087 g_simple_async_result_complete (simple);
1088 g_object_unref (simple);
1092 write_message_continue_writing (data);
1098 if (fd_list != NULL)
1100 g_simple_async_result_set_error (simple,
1103 "Tried sending a file descriptor on unsupported stream of type %s",
1104 g_type_name (G_TYPE_FROM_INSTANCE (ostream)));
1105 g_simple_async_result_complete (simple);
1106 g_object_unref (simple);
1111 g_output_stream_write_async (ostream,
1112 (const gchar *) data->blob + data->total_written,
1113 data->blob_size - data->total_written,
1115 data->worker->cancellable,
1116 write_message_async_cb,
1126 /* called in private thread shared by all GDBusConnection instances
1128 * write-lock is not held on entry
1129 * output_pending is PENDING_WRITE on entry
1132 write_message_async (GDBusWorker *worker,
1133 MessageToWriteData *data,
1134 GAsyncReadyCallback callback,
1137 data->simple = g_simple_async_result_new (NULL,
1140 write_message_async);
1141 data->total_written = 0;
1142 write_message_continue_writing (data);
1145 /* called in private thread shared by all GDBusConnection instances (with write-lock held) */
1147 write_message_finish (GAsyncResult *res,
1150 g_warn_if_fail (g_simple_async_result_get_source_tag (G_SIMPLE_ASYNC_RESULT (res)) == write_message_async);
1151 if (g_simple_async_result_propagate_error (G_SIMPLE_ASYNC_RESULT (res), error))
1156 /* ---------------------------------------------------------------------------------------------------- */
1158 static void continue_writing (GDBusWorker *worker);
1162 GDBusWorker *worker;
1167 flush_data_list_complete (const GList *flushers,
1168 const GError *error)
1172 for (l = flushers; l != NULL; l = l->next)
1174 FlushData *f = l->data;
1176 f->error = error != NULL ? g_error_copy (error) : NULL;
1178 g_mutex_lock (&f->mutex);
1179 g_cond_signal (&f->cond);
1180 g_mutex_unlock (&f->mutex);
1184 /* called in private thread shared by all GDBusConnection instances
1186 * write-lock is not held on entry
1187 * output_pending is PENDING_FLUSH on entry
1190 ostream_flush_cb (GObject *source_object,
1194 FlushAsyncData *data = user_data;
1198 g_output_stream_flush_finish (G_OUTPUT_STREAM (source_object),
1204 if (G_UNLIKELY (_g_dbus_debug_transport ()))
1206 _g_dbus_debug_print_lock ();
1207 g_print ("========================================================================\n"
1208 "GDBus-debug:Transport:\n"
1209 " ---- FLUSHED stream of type %s\n",
1210 g_type_name (G_TYPE_FROM_INSTANCE (g_io_stream_get_output_stream (data->worker->stream))));
1211 _g_dbus_debug_print_unlock ();
1215 g_assert (data->flushers != NULL);
1216 flush_data_list_complete (data->flushers, error);
1217 g_list_free (data->flushers);
1220 g_error_free (error);
1222 /* Make sure we tell folks that we don't have additional
1224 g_mutex_lock (&data->worker->write_lock);
1225 data->worker->write_num_messages_flushed = data->worker->write_num_messages_written;
1226 g_assert (data->worker->output_pending == PENDING_FLUSH);
1227 data->worker->output_pending = PENDING_NONE;
1228 g_mutex_unlock (&data->worker->write_lock);
1230 /* OK, cool, finally kick off the next write */
1231 continue_writing (data->worker);
1233 _g_dbus_worker_unref (data->worker);
1237 /* called in private thread shared by all GDBusConnection instances
1239 * write-lock is not held on entry
1240 * output_pending is PENDING_FLUSH on entry
1243 start_flush (FlushAsyncData *data)
1245 g_output_stream_flush_async (g_io_stream_get_output_stream (data->worker->stream),
1247 data->worker->cancellable,
1252 /* called in private thread shared by all GDBusConnection instances
1254 * write-lock is held on entry
1255 * output_pending is PENDING_NONE on entry
1258 message_written_unlocked (GDBusWorker *worker,
1259 MessageToWriteData *message_data)
1261 if (G_UNLIKELY (_g_dbus_debug_message ()))
1264 _g_dbus_debug_print_lock ();
1265 g_print ("========================================================================\n"
1266 "GDBus-debug:Message:\n"
1267 " >>>> SENT D-Bus message (%" G_GSIZE_FORMAT " bytes)\n",
1268 message_data->blob_size);
1269 s = g_dbus_message_print (message_data->message, 2);
1272 if (G_UNLIKELY (_g_dbus_debug_payload ()))
1274 s = _g_dbus_hexdump (message_data->blob, message_data->blob_size, 2);
1275 g_print ("%s\n", s);
1278 _g_dbus_debug_print_unlock ();
1281 worker->write_num_messages_written += 1;
1284 /* called in private thread shared by all GDBusConnection instances
1286 * write-lock is held on entry
1287 * output_pending is PENDING_NONE on entry
1289 * Returns: non-%NULL, setting @output_pending, if we need to flush now
1291 static FlushAsyncData *
1292 prepare_flush_unlocked (GDBusWorker *worker)
1299 for (l = worker->write_pending_flushes; l != NULL; l = ll)
1301 FlushData *f = l->data;
1304 if (f->number_to_wait_for == worker->write_num_messages_written)
1306 flushers = g_list_append (flushers, f);
1307 worker->write_pending_flushes = g_list_delete_link (worker->write_pending_flushes, l);
1310 if (flushers != NULL)
1312 g_assert (worker->output_pending == PENDING_NONE);
1313 worker->output_pending = PENDING_FLUSH;
1316 if (flushers != NULL)
1318 FlushAsyncData *data;
1320 data = g_new0 (FlushAsyncData, 1);
1321 data->worker = _g_dbus_worker_ref (worker);
1322 data->flushers = flushers;
1329 /* called in private thread shared by all GDBusConnection instances
1331 * write-lock is not held on entry
1332 * output_pending is PENDING_WRITE on entry
1335 write_message_cb (GObject *source_object,
1339 MessageToWriteData *data = user_data;
1342 g_mutex_lock (&data->worker->write_lock);
1343 g_assert (data->worker->output_pending == PENDING_WRITE);
1344 data->worker->output_pending = PENDING_NONE;
1347 if (!write_message_finish (res, &error))
1349 g_mutex_unlock (&data->worker->write_lock);
1352 _g_dbus_worker_emit_disconnected (data->worker, TRUE, error);
1353 g_error_free (error);
1355 g_mutex_lock (&data->worker->write_lock);
1358 message_written_unlocked (data->worker, data);
1360 g_mutex_unlock (&data->worker->write_lock);
1362 continue_writing (data->worker);
1364 message_to_write_data_free (data);
1367 /* called in private thread shared by all GDBusConnection instances
1369 * write-lock is not held on entry
1370 * output_pending is PENDING_CLOSE on entry
1373 iostream_close_cb (GObject *source_object,
1377 GDBusWorker *worker = user_data;
1378 GError *error = NULL;
1379 GList *pending_close_attempts, *pending_flush_attempts;
1382 g_io_stream_close_finish (worker->stream, res, &error);
1384 g_mutex_lock (&worker->write_lock);
1386 pending_close_attempts = worker->pending_close_attempts;
1387 worker->pending_close_attempts = NULL;
1389 pending_flush_attempts = worker->write_pending_flushes;
1390 worker->write_pending_flushes = NULL;
1392 send_queue = worker->write_queue;
1393 worker->write_queue = g_queue_new ();
1395 g_assert (worker->output_pending == PENDING_CLOSE);
1396 worker->output_pending = PENDING_NONE;
1398 g_mutex_unlock (&worker->write_lock);
1400 while (pending_close_attempts != NULL)
1402 CloseData *close_data = pending_close_attempts->data;
1404 pending_close_attempts = g_list_delete_link (pending_close_attempts,
1405 pending_close_attempts);
1407 if (close_data->result != NULL)
1410 g_simple_async_result_set_from_error (close_data->result, error);
1412 /* this must be in an idle because the result is likely to be
1413 * intended for another thread
1415 g_simple_async_result_complete_in_idle (close_data->result);
1418 close_data_free (close_data);
1421 g_clear_error (&error);
1423 /* all messages queued for sending are discarded */
1424 g_queue_free_full (send_queue, (GDestroyNotify) message_to_write_data_free);
1425 /* all queued flushes fail */
1426 error = g_error_new (G_IO_ERROR, G_IO_ERROR_CANCELLED,
1427 _("Operation was cancelled"));
1428 flush_data_list_complete (pending_flush_attempts, error);
1429 g_list_free (pending_flush_attempts);
1430 g_clear_error (&error);
1432 _g_dbus_worker_unref (worker);
1435 /* called in private thread shared by all GDBusConnection instances
1437 * write-lock is not held on entry
1438 * output_pending must be PENDING_NONE on entry
1441 continue_writing (GDBusWorker *worker)
1443 MessageToWriteData *data;
1444 FlushAsyncData *flush_async_data;
1447 /* we mustn't try to write two things at once */
1448 g_assert (worker->output_pending == PENDING_NONE);
1450 g_mutex_lock (&worker->write_lock);
1453 flush_async_data = NULL;
1455 /* if we want to close the connection, that takes precedence */
1456 if (worker->pending_close_attempts != NULL)
1458 worker->close_expected = TRUE;
1459 worker->output_pending = PENDING_CLOSE;
1461 g_io_stream_close_async (worker->stream, G_PRIORITY_DEFAULT,
1462 NULL, iostream_close_cb,
1463 _g_dbus_worker_ref (worker));
1467 flush_async_data = prepare_flush_unlocked (worker);
1469 if (flush_async_data == NULL)
1471 data = g_queue_pop_head (worker->write_queue);
1474 worker->output_pending = PENDING_WRITE;
1478 g_mutex_unlock (&worker->write_lock);
1480 /* Note that write_lock is only used for protecting the @write_queue
1481 * and @output_pending fields of the GDBusWorker struct ... which we
1482 * need to modify from arbitrary threads in _g_dbus_worker_send_message().
1484 * Therefore, it's fine to drop it here when calling back into user
1485 * code and then writing the message out onto the GIOStream since this
1486 * function only runs on the worker thread.
1489 if (flush_async_data != NULL)
1491 start_flush (flush_async_data);
1492 g_assert (data == NULL);
1494 else if (data != NULL)
1496 GDBusMessage *old_message;
1498 gsize new_blob_size;
1501 old_message = data->message;
1502 data->message = _g_dbus_worker_emit_message_about_to_be_sent (worker, data->message);
1503 if (data->message == old_message)
1505 /* filters had no effect - do nothing */
1507 else if (data->message == NULL)
1509 /* filters dropped message */
1510 g_mutex_lock (&worker->write_lock);
1511 worker->output_pending = PENDING_NONE;
1512 g_mutex_unlock (&worker->write_lock);
1513 message_to_write_data_free (data);
1518 /* filters altered the message -> reencode */
1520 new_blob = g_dbus_message_to_blob (data->message,
1522 worker->capabilities,
1524 if (new_blob == NULL)
1526 /* if filter make the GDBusMessage unencodeable, just complain on stderr and send
1527 * the old message instead
1529 g_warning ("Error encoding GDBusMessage with serial %d altered by filter function: %s",
1530 g_dbus_message_get_serial (data->message),
1532 g_error_free (error);
1536 g_free (data->blob);
1537 data->blob = (gchar *) new_blob;
1538 data->blob_size = new_blob_size;
1542 write_message_async (worker,
1549 /* called in private thread shared by all GDBusConnection instances
1551 * write-lock is not held on entry
1552 * output_pending may be anything
1555 continue_writing_in_idle_cb (gpointer user_data)
1557 GDBusWorker *worker = user_data;
1559 /* Because this is the worker thread, we can read this struct member
1560 * without holding the lock: no other thread ever modifies it.
1562 if (worker->output_pending == PENDING_NONE)
1563 continue_writing (worker);
1569 * @write_data: (transfer full) (allow-none):
1570 * @flush_data: (transfer full) (allow-none):
1571 * @close_data: (transfer full) (allow-none):
1573 * Can be called from any thread
1575 * write_lock is held on entry
1576 * output_pending may be anything
1579 schedule_writing_unlocked (GDBusWorker *worker,
1580 MessageToWriteData *write_data,
1581 FlushData *flush_data,
1582 CloseData *close_data)
1584 if (write_data != NULL)
1585 g_queue_push_tail (worker->write_queue, write_data);
1587 if (flush_data != NULL)
1588 worker->write_pending_flushes = g_list_prepend (worker->write_pending_flushes, flush_data);
1590 if (close_data != NULL)
1591 worker->pending_close_attempts = g_list_prepend (worker->pending_close_attempts,
1594 /* If we had output pending, the next bit of output will happen
1595 * automatically when it finishes, so we only need to do this
1596 * if nothing was pending.
1598 * The idle callback will re-check that output_pending is still
1599 * PENDING_NONE, to guard against output starting before the idle.
1601 if (worker->output_pending == PENDING_NONE)
1603 GSource *idle_source;
1604 idle_source = g_idle_source_new ();
1605 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
1606 g_source_set_callback (idle_source,
1607 continue_writing_in_idle_cb,
1608 _g_dbus_worker_ref (worker),
1609 (GDestroyNotify) _g_dbus_worker_unref);
1610 g_source_attach (idle_source, worker->shared_thread_data->context);
1611 g_source_unref (idle_source);
1615 /* ---------------------------------------------------------------------------------------------------- */
1617 /* can be called from any thread - steals blob
1619 * write_lock is not held on entry
1620 * output_pending may be anything
1623 _g_dbus_worker_send_message (GDBusWorker *worker,
1624 GDBusMessage *message,
1628 MessageToWriteData *data;
1630 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
1631 g_return_if_fail (blob != NULL);
1632 g_return_if_fail (blob_len > 16);
1634 data = g_new0 (MessageToWriteData, 1);
1635 data->worker = _g_dbus_worker_ref (worker);
1636 data->message = g_object_ref (message);
1637 data->blob = blob; /* steal! */
1638 data->blob_size = blob_len;
1640 g_mutex_lock (&worker->write_lock);
1641 schedule_writing_unlocked (worker, data, NULL, NULL);
1642 g_mutex_unlock (&worker->write_lock);
1645 /* ---------------------------------------------------------------------------------------------------- */
1648 _g_dbus_worker_new (GIOStream *stream,
1649 GDBusCapabilityFlags capabilities,
1650 gboolean initially_frozen,
1651 GDBusWorkerMessageReceivedCallback message_received_callback,
1652 GDBusWorkerMessageAboutToBeSentCallback message_about_to_be_sent_callback,
1653 GDBusWorkerDisconnectedCallback disconnected_callback,
1656 GDBusWorker *worker;
1657 GSource *idle_source;
1659 g_return_val_if_fail (G_IS_IO_STREAM (stream), NULL);
1660 g_return_val_if_fail (message_received_callback != NULL, NULL);
1661 g_return_val_if_fail (message_about_to_be_sent_callback != NULL, NULL);
1662 g_return_val_if_fail (disconnected_callback != NULL, NULL);
1664 worker = g_new0 (GDBusWorker, 1);
1665 worker->ref_count = 1;
1667 g_mutex_init (&worker->read_lock);
1668 worker->message_received_callback = message_received_callback;
1669 worker->message_about_to_be_sent_callback = message_about_to_be_sent_callback;
1670 worker->disconnected_callback = disconnected_callback;
1671 worker->user_data = user_data;
1672 worker->stream = g_object_ref (stream);
1673 worker->capabilities = capabilities;
1674 worker->cancellable = g_cancellable_new ();
1675 worker->output_pending = PENDING_NONE;
1677 worker->frozen = initially_frozen;
1678 worker->received_messages_while_frozen = g_queue_new ();
1680 g_mutex_init (&worker->write_lock);
1681 worker->write_queue = g_queue_new ();
1683 if (G_IS_SOCKET_CONNECTION (worker->stream))
1684 worker->socket = g_socket_connection_get_socket (G_SOCKET_CONNECTION (worker->stream));
1686 if (G_IS_KDBUS_CONNECTION (worker->stream))
1687 worker->kdbus = g_kdbus_connection_get_kdbus (G_KDBUS_CONNECTION (worker->stream));
1689 worker->shared_thread_data = _g_dbus_shared_thread_ref ();
1692 idle_source = g_idle_source_new ();
1693 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
1694 g_source_set_callback (idle_source,
1695 _g_dbus_worker_do_initial_read,
1696 _g_dbus_worker_ref (worker),
1697 (GDestroyNotify) _g_dbus_worker_unref);
1698 g_source_attach (idle_source, worker->shared_thread_data->context);
1699 g_source_unref (idle_source);
1704 /* ---------------------------------------------------------------------------------------------------- */
1706 /* can be called from any thread
1708 * write_lock is not held on entry
1709 * output_pending may be anything
1712 _g_dbus_worker_close (GDBusWorker *worker,
1713 GCancellable *cancellable,
1714 GSimpleAsyncResult *result)
1716 CloseData *close_data;
1718 close_data = g_slice_new0 (CloseData);
1719 close_data->worker = _g_dbus_worker_ref (worker);
1720 close_data->cancellable =
1721 (cancellable == NULL ? NULL : g_object_ref (cancellable));
1722 close_data->result = (result == NULL ? NULL : g_object_ref (result));
1724 /* Don't set worker->close_expected here - we're in the wrong thread.
1725 * It'll be set before the actual close happens.
1727 g_cancellable_cancel (worker->cancellable);
1728 g_mutex_lock (&worker->write_lock);
1729 schedule_writing_unlocked (worker, NULL, NULL, close_data);
1730 g_mutex_unlock (&worker->write_lock);
1733 /* This can be called from any thread - frees worker. Note that
1734 * callbacks might still happen if called from another thread than the
1735 * worker - use your own synchronization primitive in the callbacks.
1737 * write_lock is not held on entry
1738 * output_pending may be anything
1741 _g_dbus_worker_stop (GDBusWorker *worker)
1743 g_atomic_int_set (&worker->stopped, TRUE);
1745 /* Cancel any pending operations and schedule a close of the underlying I/O
1746 * stream in the worker thread
1748 _g_dbus_worker_close (worker, NULL, NULL);
1750 /* _g_dbus_worker_close holds a ref until after an idle in the worker
1751 * thread has run, so we no longer need to unref in an idle like in
1754 _g_dbus_worker_unref (worker);
1757 /* ---------------------------------------------------------------------------------------------------- */
1759 /* can be called from any thread (except the worker thread) - blocks
1760 * calling thread until all queued outgoing messages are written and
1761 * the transport has been flushed
1763 * write_lock is not held on entry
1764 * output_pending may be anything
1767 _g_dbus_worker_flush_sync (GDBusWorker *worker,
1768 GCancellable *cancellable,
1773 guint64 pending_writes;
1778 g_mutex_lock (&worker->write_lock);
1780 /* if the queue is empty, no write is in-flight and we haven't written
1781 * anything since the last flush, then there's nothing to wait for
1783 pending_writes = g_queue_get_length (worker->write_queue);
1785 /* if a write is in-flight, we shouldn't be satisfied until the first
1786 * flush operation that follows it
1788 if (worker->output_pending == PENDING_WRITE)
1789 pending_writes += 1;
1791 if (pending_writes > 0 ||
1792 worker->write_num_messages_written != worker->write_num_messages_flushed)
1794 data = g_new0 (FlushData, 1);
1795 g_mutex_init (&data->mutex);
1796 g_cond_init (&data->cond);
1797 data->number_to_wait_for = worker->write_num_messages_written + pending_writes;
1798 g_mutex_lock (&data->mutex);
1800 schedule_writing_unlocked (worker, NULL, data, NULL);
1802 g_mutex_unlock (&worker->write_lock);
1806 g_cond_wait (&data->cond, &data->mutex);
1807 g_mutex_unlock (&data->mutex);
1809 /* note:the element is removed from worker->write_pending_flushes in flush_cb() above */
1810 g_cond_clear (&data->cond);
1811 g_mutex_clear (&data->mutex);
1812 if (data->error != NULL)
1815 g_propagate_error (error, data->error);
1823 /* ---------------------------------------------------------------------------------------------------- */
1825 #define G_DBUS_DEBUG_AUTHENTICATION (1<<0)
1826 #define G_DBUS_DEBUG_TRANSPORT (1<<1)
1827 #define G_DBUS_DEBUG_MESSAGE (1<<2)
1828 #define G_DBUS_DEBUG_PAYLOAD (1<<3)
1829 #define G_DBUS_DEBUG_CALL (1<<4)
1830 #define G_DBUS_DEBUG_SIGNAL (1<<5)
1831 #define G_DBUS_DEBUG_INCOMING (1<<6)
1832 #define G_DBUS_DEBUG_RETURN (1<<7)
1833 #define G_DBUS_DEBUG_EMISSION (1<<8)
1834 #define G_DBUS_DEBUG_ADDRESS (1<<9)
1836 static gint _gdbus_debug_flags = 0;
1839 _g_dbus_debug_authentication (void)
1841 _g_dbus_initialize ();
1842 return (_gdbus_debug_flags & G_DBUS_DEBUG_AUTHENTICATION) != 0;
1846 _g_dbus_debug_transport (void)
1848 _g_dbus_initialize ();
1849 return (_gdbus_debug_flags & G_DBUS_DEBUG_TRANSPORT) != 0;
1853 _g_dbus_debug_message (void)
1855 _g_dbus_initialize ();
1856 return (_gdbus_debug_flags & G_DBUS_DEBUG_MESSAGE) != 0;
1860 _g_dbus_debug_payload (void)
1862 _g_dbus_initialize ();
1863 return (_gdbus_debug_flags & G_DBUS_DEBUG_PAYLOAD) != 0;
1867 _g_dbus_debug_call (void)
1869 _g_dbus_initialize ();
1870 return (_gdbus_debug_flags & G_DBUS_DEBUG_CALL) != 0;
1874 _g_dbus_debug_signal (void)
1876 _g_dbus_initialize ();
1877 return (_gdbus_debug_flags & G_DBUS_DEBUG_SIGNAL) != 0;
1881 _g_dbus_debug_incoming (void)
1883 _g_dbus_initialize ();
1884 return (_gdbus_debug_flags & G_DBUS_DEBUG_INCOMING) != 0;
1888 _g_dbus_debug_return (void)
1890 _g_dbus_initialize ();
1891 return (_gdbus_debug_flags & G_DBUS_DEBUG_RETURN) != 0;
1895 _g_dbus_debug_emission (void)
1897 _g_dbus_initialize ();
1898 return (_gdbus_debug_flags & G_DBUS_DEBUG_EMISSION) != 0;
1902 _g_dbus_debug_address (void)
1904 _g_dbus_initialize ();
1905 return (_gdbus_debug_flags & G_DBUS_DEBUG_ADDRESS) != 0;
1908 G_LOCK_DEFINE_STATIC (print_lock);
1911 _g_dbus_debug_print_lock (void)
1913 G_LOCK (print_lock);
1917 _g_dbus_debug_print_unlock (void)
1919 G_UNLOCK (print_lock);
1923 * _g_dbus_initialize:
1925 * Does various one-time init things such as
1927 * - registering the G_DBUS_ERROR error domain
1928 * - parses the G_DBUS_DEBUG environment variable
1931 _g_dbus_initialize (void)
1933 static volatile gsize initialized = 0;
1935 if (g_once_init_enter (&initialized))
1937 volatile GQuark g_dbus_error_domain;
1940 g_dbus_error_domain = G_DBUS_ERROR;
1941 (g_dbus_error_domain); /* To avoid -Wunused-but-set-variable */
1943 debug = g_getenv ("G_DBUS_DEBUG");
1946 const GDebugKey keys[] = {
1947 { "authentication", G_DBUS_DEBUG_AUTHENTICATION },
1948 { "transport", G_DBUS_DEBUG_TRANSPORT },
1949 { "message", G_DBUS_DEBUG_MESSAGE },
1950 { "payload", G_DBUS_DEBUG_PAYLOAD },
1951 { "call", G_DBUS_DEBUG_CALL },
1952 { "signal", G_DBUS_DEBUG_SIGNAL },
1953 { "incoming", G_DBUS_DEBUG_INCOMING },
1954 { "return", G_DBUS_DEBUG_RETURN },
1955 { "emission", G_DBUS_DEBUG_EMISSION },
1956 { "address", G_DBUS_DEBUG_ADDRESS }
1959 _gdbus_debug_flags = g_parse_debug_string (debug, keys, G_N_ELEMENTS (keys));
1960 if (_gdbus_debug_flags & G_DBUS_DEBUG_PAYLOAD)
1961 _gdbus_debug_flags |= G_DBUS_DEBUG_MESSAGE;
1964 g_once_init_leave (&initialized, 1);
1968 /* ---------------------------------------------------------------------------------------------------- */
1971 _g_dbus_compute_complete_signature (GDBusArgInfo **args)
1973 const GVariantType *arg_types[256];
1977 for (n = 0; args[n] != NULL; n++)
1979 /* DBus places a hard limit of 255 on signature length.
1980 * therefore number of args must be less than 256.
1984 arg_types[n] = G_VARIANT_TYPE (args[n]->signature);
1986 if G_UNLIKELY (arg_types[n] == NULL)
1992 return g_variant_type_new_tuple (arg_types, n);
1995 /* ---------------------------------------------------------------------------------------------------- */
1999 extern BOOL WINAPI ConvertSidToStringSidA (PSID Sid, LPSTR *StringSid);
2002 _g_dbus_win32_get_user_sid (void)
2006 DWORD token_information_len;
2013 h = INVALID_HANDLE_VALUE;
2015 if (!OpenProcessToken (GetCurrentProcess (), TOKEN_QUERY, &h))
2017 g_warning ("OpenProcessToken failed with error code %d", (gint) GetLastError ());
2021 /* Get length of buffer */
2022 token_information_len = 0;
2023 if (!GetTokenInformation (h, TokenUser, NULL, 0, &token_information_len))
2025 if (GetLastError () != ERROR_INSUFFICIENT_BUFFER)
2027 g_warning ("GetTokenInformation() failed with error code %d", (gint) GetLastError ());
2031 user = g_malloc (token_information_len);
2032 if (!GetTokenInformation (h, TokenUser, user, token_information_len, &token_information_len))
2034 g_warning ("GetTokenInformation() failed with error code %d", (gint) GetLastError ());
2038 psid = user->User.Sid;
2039 if (!IsValidSid (psid))
2041 g_warning ("Invalid SID");
2045 if (!ConvertSidToStringSidA (psid, &sid))
2047 g_warning ("Invalid SID");
2051 ret = g_strdup (sid);
2056 if (h != INVALID_HANDLE_VALUE)
2062 /* ---------------------------------------------------------------------------------------------------- */
2065 _g_dbus_get_machine_id (GError **error)
2068 HW_PROFILE_INFOA info;
2069 char *src, *dest, *res;
2072 if (!GetCurrentHwProfileA (&info))
2074 char *message = g_win32_error_message (GetLastError ());
2078 _("Unable to get Hardware profile: %s"), message);
2083 /* Form: {12340001-4980-1920-6788-123456789012} */
2084 src = &info.szHwProfileGuid[0];
2086 res = g_malloc (32+1);
2090 for (i = 0; i < 8; i++)
2093 for (i = 0; i < 4; i++)
2096 for (i = 0; i < 4; i++)
2099 for (i = 0; i < 4; i++)
2102 for (i = 0; i < 12; i++)
2109 GError *first_error;
2110 /* TODO: use PACKAGE_LOCALSTATEDIR ? */
2113 if (!g_file_get_contents ("/var/lib/dbus/machine-id",
2117 !g_file_get_contents ("/etc/machine-id",
2122 g_propagate_prefixed_error (error, first_error,
2123 _("Unable to load /var/lib/dbus/machine-id or /etc/machine-id: "));
2127 /* ignore the error from the first try, if any */
2128 g_clear_error (&first_error);
2129 /* TODO: validate value */
2136 /* ---------------------------------------------------------------------------------------------------- */
2139 _g_dbus_enum_to_string (GType enum_type, gint value)
2143 GEnumValue *enum_value;
2145 klass = g_type_class_ref (enum_type);
2146 enum_value = g_enum_get_value (klass, value);
2147 if (enum_value != NULL)
2148 ret = g_strdup (enum_value->value_nick);
2150 ret = g_strdup_printf ("unknown (value %d)", value);
2151 g_type_class_unref (klass);
2155 /* ---------------------------------------------------------------------------------------------------- */
2158 write_message_print_transport_debug (gssize bytes_written,
2159 MessageToWriteData *data)
2161 if (G_LIKELY (!_g_dbus_debug_transport ()))
2164 _g_dbus_debug_print_lock ();
2165 g_print ("========================================================================\n"
2166 "GDBus-debug:Transport:\n"
2167 " >>>> WROTE %" G_GSIZE_FORMAT " bytes of message with serial %d and\n"
2168 " size %" G_GSIZE_FORMAT " from offset %" G_GSIZE_FORMAT " on a %s\n",
2170 g_dbus_message_get_serial (data->message),
2172 data->total_written,
2173 g_type_name (G_TYPE_FROM_INSTANCE (g_io_stream_get_output_stream (data->worker->stream))));
2174 _g_dbus_debug_print_unlock ();
2179 /* ---------------------------------------------------------------------------------------------------- */
2182 read_message_print_transport_debug (gssize bytes_read,
2183 GDBusWorker *worker)
2187 gint32 message_length;
2189 if (G_LIKELY (!_g_dbus_debug_transport ()))
2192 size = bytes_read + worker->read_buffer_cur_size;
2196 message_length = g_dbus_message_bytes_needed ((guchar *) worker->read_buffer, size, NULL);
2199 switch (worker->read_buffer[0])
2203 serial = GUINT32_FROM_LE (((guint32 *) worker->read_buffer)[2]);
2207 serial = GUINT32_FROM_BE (((guint32 *) worker->read_buffer)[2]);
2210 /* an error will be set elsewhere if this happens */
2215 _g_dbus_debug_print_lock ();
2216 g_print ("========================================================================\n"
2217 "GDBus-debug:Transport:\n"
2218 " <<<< READ %" G_GSIZE_FORMAT " bytes of message with serial %d and\n"
2219 " size %d to offset %" G_GSIZE_FORMAT " from a %s\n",
2223 worker->read_buffer_cur_size,
2224 g_type_name (G_TYPE_FROM_INSTANCE (g_io_stream_get_input_stream (worker->stream))));
2225 _g_dbus_debug_print_unlock ();
2230 /* ---------------------------------------------------------------------------------------------------- */
2233 _g_signal_accumulator_false_handled (GSignalInvocationHint *ihint,
2234 GValue *return_accu,
2235 const GValue *handler_return,
2238 gboolean continue_emission;
2239 gboolean signal_return;
2241 signal_return = g_value_get_boolean (handler_return);
2242 g_value_set_boolean (return_accu, signal_return);
2243 continue_emission = signal_return;
2245 return continue_emission;