1 /* GDBus - GLib D-Bus Library
3 * Copyright (C) 2008-2010 Red Hat, Inc.
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General
16 * Public License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
18 * Boston, MA 02111-1307, USA.
20 * Author: David Zeuthen <davidz@redhat.com>
33 #include "gdbusprivate.h"
34 #include "gdbusmessage.h"
35 #include "gdbuserror.h"
36 #include "gdbusintrospection.h"
37 #include "gasyncresult.h"
38 #include "gsimpleasyncresult.h"
39 #include "ginputstream.h"
40 #include "giostream.h"
41 #include "gsocketcontrolmessage.h"
42 #include "gsocketconnection.h"
45 #include "gunixfdmessage.h"
46 #include "gunixconnection.h"
47 #include "gunixcredentialsmessage.h"
57 /* ---------------------------------------------------------------------------------------------------- */
60 _g_dbus_hexdump (const gchar *data, gsize len, guint indent)
65 ret = g_string_new (NULL);
67 for (n = 0; n < len; n += 16)
69 g_string_append_printf (ret, "%*s%04x: ", indent, "", n);
71 for (m = n; m < n + 16; m++)
73 if (m > n && (m%4) == 0)
74 g_string_append_c (ret, ' ');
76 g_string_append_printf (ret, "%02x ", (guchar) data[m]);
78 g_string_append (ret, " ");
81 g_string_append (ret, " ");
83 for (m = n; m < len && m < n + 16; m++)
84 g_string_append_c (ret, g_ascii_isprint (data[m]) ? data[m] : '.');
86 g_string_append_c (ret, '\n');
89 return g_string_free (ret, FALSE);
92 /* ---------------------------------------------------------------------------------------------------- */
94 /* Unfortunately ancillary messages are discarded when reading from a
95 * socket using the GSocketInputStream abstraction. So we provide a
96 * very GInputStream-ish API that uses GSocket in this case (very
97 * similar to GSocketInputStream).
103 GCancellable *cancellable;
108 GSocketControlMessage ***messages;
111 GSimpleAsyncResult *simple;
113 gboolean from_mainloop;
114 } ReadWithControlData;
117 read_with_control_data_free (ReadWithControlData *data)
119 g_object_unref (data->socket);
120 if (data->cancellable != NULL)
121 g_object_unref (data->cancellable);
122 g_object_unref (data->simple);
127 _g_socket_read_with_control_messages_ready (GSocket *socket,
128 GIOCondition condition,
131 ReadWithControlData *data = user_data;
137 vector.buffer = data->buffer;
138 vector.size = data->count;
139 result = g_socket_receive_message (data->socket,
150 g_simple_async_result_set_op_res_gssize (data->simple, result);
154 g_assert (error != NULL);
155 g_simple_async_result_set_from_error (data->simple, error);
156 g_error_free (error);
159 if (data->from_mainloop)
160 g_simple_async_result_complete (data->simple);
162 g_simple_async_result_complete_in_idle (data->simple);
168 _g_socket_read_with_control_messages (GSocket *socket,
171 GSocketControlMessage ***messages,
174 GCancellable *cancellable,
175 GAsyncReadyCallback callback,
178 ReadWithControlData *data;
180 data = g_new0 (ReadWithControlData, 1);
181 data->socket = g_object_ref (socket);
182 data->cancellable = cancellable != NULL ? g_object_ref (cancellable) : NULL;
183 data->buffer = buffer;
185 data->messages = messages;
186 data->num_messages = num_messages;
188 data->simple = g_simple_async_result_new (G_OBJECT (socket),
191 _g_socket_read_with_control_messages);
193 if (!g_socket_condition_check (socket, G_IO_IN))
196 data->from_mainloop = TRUE;
197 source = g_socket_create_source (data->socket,
198 G_IO_IN | G_IO_HUP | G_IO_ERR,
200 g_source_set_callback (source,
201 (GSourceFunc) _g_socket_read_with_control_messages_ready,
203 (GDestroyNotify) read_with_control_data_free);
204 g_source_attach (source, g_main_context_get_thread_default ());
205 g_source_unref (source);
209 _g_socket_read_with_control_messages_ready (data->socket, G_IO_IN, data);
210 read_with_control_data_free (data);
215 _g_socket_read_with_control_messages_finish (GSocket *socket,
216 GAsyncResult *result,
219 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
221 g_return_val_if_fail (G_IS_SOCKET (socket), -1);
222 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == _g_socket_read_with_control_messages);
224 if (g_simple_async_result_propagate_error (simple, error))
227 return g_simple_async_result_get_op_res_gssize (simple);
230 /* ---------------------------------------------------------------------------------------------------- */
232 G_LOCK_DEFINE_STATIC (shared_thread_lock);
238 GMainContext *context;
242 static SharedThreadData *shared_thread_data = NULL;
245 shared_thread_func (gpointer data)
247 g_main_context_push_thread_default (shared_thread_data->context);
248 g_main_loop_run (shared_thread_data->loop);
249 g_main_context_pop_thread_default (shared_thread_data->context);
253 typedef void (*GDBusSharedThreadFunc) (gpointer user_data);
257 GDBusSharedThreadFunc func;
263 invoke_caller (gpointer user_data)
265 CallerData *data = user_data;
266 data->func (data->user_data);
272 _g_dbus_shared_thread_ref (GDBusSharedThreadFunc func,
276 GSource *idle_source;
279 G_LOCK (shared_thread_lock);
281 if (shared_thread_data != NULL)
283 shared_thread_data->num_users += 1;
287 shared_thread_data = g_new0 (SharedThreadData, 1);
288 shared_thread_data->num_users = 1;
291 shared_thread_data->context = g_main_context_new ();
292 shared_thread_data->loop = g_main_loop_new (shared_thread_data->context, FALSE);
293 shared_thread_data->thread = g_thread_create (shared_thread_func,
297 g_assert_no_error (error);
301 data = g_new0 (CallerData, 1);
303 data->user_data = user_data;
306 idle_source = g_idle_source_new ();
307 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
308 g_source_set_callback (idle_source,
312 g_source_attach (idle_source, shared_thread_data->context);
313 g_source_unref (idle_source);
315 /* wait for the user code to run.. hmm.. probably use a condition variable instead */
321 G_UNLOCK (shared_thread_lock);
325 _g_dbus_shared_thread_unref (void)
327 /* TODO: actually destroy the shared thread here */
329 G_LOCK (shared_thread_lock);
330 g_assert (shared_thread_data != NULL);
331 shared_thread_data->num_users -= 1;
332 if (shared_thread_data->num_users == 0)
334 g_main_loop_quit (shared_thread_data->loop);
335 //g_thread_join (shared_thread_data->thread);
336 g_main_loop_unref (shared_thread_data->loop);
337 g_main_context_unref (shared_thread_data->context);
338 g_free (shared_thread_data);
339 shared_thread_data = NULL;
340 G_UNLOCK (shared_thread_lock);
344 G_UNLOCK (shared_thread_lock);
349 /* ---------------------------------------------------------------------------------------------------- */
353 volatile gint ref_count;
357 /* TODO: frozen (e.g. G_DBUS_CONNECTION_FLAGS_DELAY_MESSAGE_PROCESSING) currently
358 * only affects messages received from the other peer (since GDBusServer is the
359 * only user) - we might want it to affect messages sent to the other peer too?
362 GQueue *received_messages_while_frozen;
365 GDBusCapabilityFlags capabilities;
366 GCancellable *cancellable;
367 GDBusWorkerMessageReceivedCallback message_received_callback;
368 GDBusWorkerMessageAboutToBeSentCallback message_about_to_be_sent_callback;
369 GDBusWorkerDisconnectedCallback disconnected_callback;
374 /* if not NULL, stream is GSocketConnection */
377 /* used for reading */
380 gsize read_buffer_allocated_size;
381 gsize read_buffer_cur_size;
382 gsize read_buffer_bytes_wanted;
383 GUnixFDList *read_fd_list;
384 GSocketControlMessage **read_ancillary_messages;
385 gint read_num_ancillary_messages;
387 /* used for writing */
390 gboolean write_is_pending;
391 guint64 write_num_messages_written;
392 GList *write_pending_flushes;
399 guint64 number_to_wait_for;
402 struct _MessageToWriteData ;
403 typedef struct _MessageToWriteData MessageToWriteData;
405 static void message_to_write_data_free (MessageToWriteData *data);
408 _g_dbus_worker_ref (GDBusWorker *worker)
410 g_atomic_int_inc (&worker->ref_count);
415 _g_dbus_worker_unref (GDBusWorker *worker)
417 if (g_atomic_int_dec_and_test (&worker->ref_count))
419 g_assert (worker->write_pending_flushes == NULL);
421 _g_dbus_shared_thread_unref ();
423 g_object_unref (worker->stream);
425 g_mutex_free (worker->read_lock);
426 g_object_unref (worker->cancellable);
427 if (worker->read_fd_list != NULL)
428 g_object_unref (worker->read_fd_list);
430 g_queue_foreach (worker->received_messages_while_frozen, (GFunc) g_object_unref, NULL);
431 g_queue_free (worker->received_messages_while_frozen);
433 g_mutex_free (worker->write_lock);
434 g_queue_foreach (worker->write_queue, (GFunc) message_to_write_data_free, NULL);
435 g_queue_free (worker->write_queue);
442 _g_dbus_worker_emit_disconnected (GDBusWorker *worker,
443 gboolean remote_peer_vanished,
446 if (!worker->stopped)
447 worker->disconnected_callback (worker, remote_peer_vanished, error, worker->user_data);
451 _g_dbus_worker_emit_message_received (GDBusWorker *worker,
452 GDBusMessage *message)
454 if (!worker->stopped)
455 worker->message_received_callback (worker, message, worker->user_data);
459 _g_dbus_worker_emit_message_about_to_be_sent (GDBusWorker *worker,
460 GDBusMessage *message)
464 if (!worker->stopped)
465 ret = worker->message_about_to_be_sent_callback (worker, message, worker->user_data);
469 /* can only be called from private thread with read-lock held - takes ownership of @message */
471 _g_dbus_worker_queue_or_deliver_received_message (GDBusWorker *worker,
472 GDBusMessage *message)
474 if (worker->frozen || g_queue_get_length (worker->received_messages_while_frozen) > 0)
477 g_queue_push_tail (worker->received_messages_while_frozen, message);
481 /* not frozen, nor anything in queue */
482 _g_dbus_worker_emit_message_received (worker, message);
483 g_object_unref (message);
487 /* called in private thread shared by all GDBusConnection instances (without read-lock held) */
489 unfreeze_in_idle_cb (gpointer user_data)
491 GDBusWorker *worker = user_data;
492 GDBusMessage *message;
494 g_mutex_lock (worker->read_lock);
497 while ((message = g_queue_pop_head (worker->received_messages_while_frozen)) != NULL)
499 _g_dbus_worker_emit_message_received (worker, message);
500 g_object_unref (message);
502 worker->frozen = FALSE;
506 g_assert (g_queue_get_length (worker->received_messages_while_frozen) == 0);
508 g_mutex_unlock (worker->read_lock);
512 /* can be called from any thread */
514 _g_dbus_worker_unfreeze (GDBusWorker *worker)
516 GSource *idle_source;
517 idle_source = g_idle_source_new ();
518 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
519 g_source_set_callback (idle_source,
521 _g_dbus_worker_ref (worker),
522 (GDestroyNotify) _g_dbus_worker_unref);
523 g_source_attach (idle_source, shared_thread_data->context);
524 g_source_unref (idle_source);
527 /* ---------------------------------------------------------------------------------------------------- */
529 static void _g_dbus_worker_do_read_unlocked (GDBusWorker *worker);
531 /* called in private thread shared by all GDBusConnection instances (without read-lock held) */
533 _g_dbus_worker_do_read_cb (GInputStream *input_stream,
537 GDBusWorker *worker = user_data;
541 g_mutex_lock (worker->read_lock);
543 /* If already stopped, don't even process the reply */
548 if (worker->socket == NULL)
549 bytes_read = g_input_stream_read_finish (g_io_stream_get_input_stream (worker->stream),
553 bytes_read = _g_socket_read_with_control_messages_finish (worker->socket,
556 if (worker->read_num_ancillary_messages > 0)
559 for (n = 0; n < worker->read_num_ancillary_messages; n++)
561 GSocketControlMessage *control_message = G_SOCKET_CONTROL_MESSAGE (worker->read_ancillary_messages[n]);
567 else if (G_IS_UNIX_FD_MESSAGE (control_message))
569 GUnixFDMessage *fd_message;
573 fd_message = G_UNIX_FD_MESSAGE (control_message);
574 fds = g_unix_fd_message_steal_fds (fd_message, &num_fds);
575 if (worker->read_fd_list == NULL)
577 worker->read_fd_list = g_unix_fd_list_new_from_array (fds, num_fds);
582 for (n = 0; n < num_fds; n++)
584 /* TODO: really want a append_steal() */
585 g_unix_fd_list_append (worker->read_fd_list, fds[n], NULL);
591 else if (G_IS_UNIX_CREDENTIALS_MESSAGE (control_message))
603 "Unexpected ancillary message of type %s received from peer",
604 g_type_name (G_TYPE_FROM_INSTANCE (control_message)));
605 _g_dbus_worker_emit_disconnected (worker, TRUE, error);
606 g_error_free (error);
607 g_object_unref (control_message);
609 while (n < worker->read_num_ancillary_messages)
610 g_object_unref (worker->read_ancillary_messages[n++]);
611 g_free (worker->read_ancillary_messages);
615 g_object_unref (control_message);
617 g_free (worker->read_ancillary_messages);
620 if (bytes_read == -1)
622 _g_dbus_worker_emit_disconnected (worker, TRUE, error);
623 g_error_free (error);
628 g_debug ("read %d bytes (is_closed=%d blocking=%d condition=0x%02x) stream %p, %p",
630 g_socket_is_closed (g_socket_connection_get_socket (G_SOCKET_CONNECTION (worker->stream))),
631 g_socket_get_blocking (g_socket_connection_get_socket (G_SOCKET_CONNECTION (worker->stream))),
632 g_socket_condition_check (g_socket_connection_get_socket (G_SOCKET_CONNECTION (worker->stream)),
633 G_IO_IN | G_IO_OUT | G_IO_HUP),
638 /* TODO: hmm, hmm... */
644 "Underlying GIOStream returned 0 bytes on an async read");
645 _g_dbus_worker_emit_disconnected (worker, TRUE, error);
646 g_error_free (error);
650 worker->read_buffer_cur_size += bytes_read;
651 if (worker->read_buffer_bytes_wanted == worker->read_buffer_cur_size)
653 /* OK, got what we asked for! */
654 if (worker->read_buffer_bytes_wanted == 16)
657 /* OK, got the header - determine how many more bytes are needed */
659 message_len = g_dbus_message_bytes_needed ((guchar *) worker->read_buffer,
662 if (message_len == -1)
664 g_warning ("_g_dbus_worker_do_read_cb: error determing bytes needed: %s", error->message);
665 _g_dbus_worker_emit_disconnected (worker, FALSE, error);
666 g_error_free (error);
670 worker->read_buffer_bytes_wanted = message_len;
671 _g_dbus_worker_do_read_unlocked (worker);
675 GDBusMessage *message;
678 /* TODO: use connection->priv->auth to decode the message */
680 message = g_dbus_message_new_from_blob ((guchar *) worker->read_buffer,
681 worker->read_buffer_cur_size,
682 worker->capabilities,
687 s = _g_dbus_hexdump (worker->read_buffer, worker->read_buffer_cur_size, 2);
688 g_warning ("Error decoding D-Bus message of %" G_GSIZE_FORMAT " bytes\n"
690 "The payload is as follows:\n"
692 worker->read_buffer_cur_size,
696 _g_dbus_worker_emit_disconnected (worker, FALSE, error);
697 g_error_free (error);
702 if (worker->read_fd_list != NULL)
704 g_dbus_message_set_unix_fd_list (message, worker->read_fd_list);
705 worker->read_fd_list = NULL;
709 if (G_UNLIKELY (_g_dbus_debug_message ()))
712 _g_dbus_debug_print_lock ();
713 g_print ("========================================================================\n"
714 "GDBus-debug:Message:\n"
715 " <<<< RECEIVED D-Bus message (%" G_GSIZE_FORMAT " bytes)\n",
716 worker->read_buffer_cur_size);
717 s = g_dbus_message_print (message, 2);
720 if (G_UNLIKELY (_g_dbus_debug_payload ()))
722 s = _g_dbus_hexdump (worker->read_buffer, worker->read_buffer_cur_size, 2);
726 _g_dbus_debug_print_unlock ();
729 /* yay, got a message, go deliver it */
730 _g_dbus_worker_queue_or_deliver_received_message (worker, message);
732 /* start reading another message! */
733 worker->read_buffer_bytes_wanted = 0;
734 worker->read_buffer_cur_size = 0;
735 _g_dbus_worker_do_read_unlocked (worker);
740 /* didn't get all the bytes we requested - so repeat the request... */
741 _g_dbus_worker_do_read_unlocked (worker);
745 g_mutex_unlock (worker->read_lock);
747 /* gives up the reference acquired when calling g_input_stream_read_async() */
748 _g_dbus_worker_unref (worker);
751 /* called in private thread shared by all GDBusConnection instances (with read-lock held) */
753 _g_dbus_worker_do_read_unlocked (GDBusWorker *worker)
755 /* if bytes_wanted is zero, it means start reading a message */
756 if (worker->read_buffer_bytes_wanted == 0)
758 worker->read_buffer_cur_size = 0;
759 worker->read_buffer_bytes_wanted = 16;
762 /* ensure we have a (big enough) buffer */
763 if (worker->read_buffer == NULL || worker->read_buffer_bytes_wanted > worker->read_buffer_allocated_size)
765 /* TODO: 4096 is randomly chosen; might want a better chosen default minimum */
766 worker->read_buffer_allocated_size = MAX (worker->read_buffer_bytes_wanted, 4096);
767 worker->read_buffer = g_realloc (worker->read_buffer, worker->read_buffer_allocated_size);
770 if (worker->socket == NULL)
771 g_input_stream_read_async (g_io_stream_get_input_stream (worker->stream),
772 worker->read_buffer + worker->read_buffer_cur_size,
773 worker->read_buffer_bytes_wanted - worker->read_buffer_cur_size,
776 (GAsyncReadyCallback) _g_dbus_worker_do_read_cb,
777 _g_dbus_worker_ref (worker));
780 worker->read_ancillary_messages = NULL;
781 worker->read_num_ancillary_messages = 0;
782 _g_socket_read_with_control_messages (worker->socket,
783 worker->read_buffer + worker->read_buffer_cur_size,
784 worker->read_buffer_bytes_wanted - worker->read_buffer_cur_size,
785 &worker->read_ancillary_messages,
786 &worker->read_num_ancillary_messages,
789 (GAsyncReadyCallback) _g_dbus_worker_do_read_cb,
790 _g_dbus_worker_ref (worker));
794 /* called in private thread shared by all GDBusConnection instances (without read-lock held) */
796 _g_dbus_worker_do_read (GDBusWorker *worker)
798 g_mutex_lock (worker->read_lock);
799 _g_dbus_worker_do_read_unlocked (worker);
800 g_mutex_unlock (worker->read_lock);
803 /* ---------------------------------------------------------------------------------------------------- */
805 struct _MessageToWriteData
807 GDBusMessage *message;
813 message_to_write_data_free (MessageToWriteData *data)
815 g_object_unref (data->message);
820 /* ---------------------------------------------------------------------------------------------------- */
822 /* called in private thread shared by all GDBusConnection instances (without write-lock held) */
824 write_message (GDBusWorker *worker,
825 MessageToWriteData *data,
832 g_return_val_if_fail (data->blob_size > 16, FALSE);
836 /* First, the initial 16 bytes - special case UNIX sockets here
837 * since it may involve writing an ancillary message with file
842 GOutputVector vector;
843 GSocketControlMessage *message;
844 GUnixFDList *fd_list;
845 gssize bytes_written;
847 fd_list = g_dbus_message_get_unix_fd_list (data->message);
852 if (!G_IS_UNIX_CONNECTION (worker->stream))
856 G_IO_ERROR_INVALID_ARGUMENT,
857 "Tried sending a file descriptor on unsupported stream of type %s",
858 g_type_name (G_TYPE_FROM_INSTANCE (worker->stream)));
861 else if (!(worker->capabilities & G_DBUS_CAPABILITY_FLAGS_UNIX_FD_PASSING))
863 g_set_error_literal (error,
865 G_IO_ERROR_INVALID_ARGUMENT,
866 "Tried sending a file descriptor but remote peer does not support this capability");
869 message = g_unix_fd_message_new_with_fd_list (fd_list);
872 vector.buffer = data->blob;
875 bytes_written = g_socket_send_message (worker->socket,
879 message != NULL ? &message : NULL,
880 message != NULL ? 1 : 0,
884 if (bytes_written == -1)
886 g_prefix_error (error, _("Error writing first 16 bytes of message to socket: "));
888 g_object_unref (message);
892 g_object_unref (message);
894 if (bytes_written < 16)
896 /* TODO: I think this needs to be handled ... are we guaranteed that the ancillary
899 g_assert_not_reached ();
903 /* write the first 16 bytes (guaranteed to return an error if everything can't be written) */
904 if (!g_output_stream_write_all (g_io_stream_get_output_stream (worker->stream),
905 (const gchar *) data->blob,
907 NULL, /* bytes_written */
908 worker->cancellable, /* cancellable */
913 /* Then write the rest of the message (guaranteed to return an error if everything can't be written) */
914 if (!g_output_stream_write_all (g_io_stream_get_output_stream (worker->stream),
915 (const gchar *) data->blob + 16,
916 data->blob_size - 16,
917 NULL, /* bytes_written */
918 worker->cancellable, /* cancellable */
924 /* wake up pending flushes */
925 g_mutex_lock (worker->write_lock);
926 worker->write_num_messages_written += 1;
927 for (l = worker->write_pending_flushes; l != NULL; l = ll)
929 FlushData *f = l->data;
932 if (f->number_to_wait_for == worker->write_num_messages_written)
934 g_mutex_lock (f->mutex);
935 g_cond_signal (f->cond);
936 g_mutex_unlock (f->mutex);
937 worker->write_pending_flushes = g_list_delete_link (worker->write_pending_flushes, l);
940 g_mutex_unlock (worker->write_lock);
942 if (G_UNLIKELY (_g_dbus_debug_message ()))
945 _g_dbus_debug_print_lock ();
946 g_print ("========================================================================\n"
947 "GDBus-debug:Message:\n"
948 " >>>> SENT D-Bus message (%" G_GSIZE_FORMAT " bytes)\n",
950 s = g_dbus_message_print (data->message, 2);
953 if (G_UNLIKELY (_g_dbus_debug_payload ()))
955 s = _g_dbus_hexdump (data->blob, data->blob_size, 2);
959 _g_dbus_debug_print_unlock ();
966 /* ---------------------------------------------------------------------------------------------------- */
968 /* called in private thread shared by all GDBusConnection instances (without write-lock held) */
970 write_message_in_idle_cb (gpointer user_data)
972 GDBusWorker *worker = user_data;
973 gboolean more_writes_are_pending;
974 MessageToWriteData *data;
975 gboolean message_was_dropped;
978 g_mutex_lock (worker->write_lock);
979 data = g_queue_pop_head (worker->write_queue);
980 g_assert (data != NULL);
981 more_writes_are_pending = (g_queue_get_length (worker->write_queue) > 0);
982 worker->write_is_pending = more_writes_are_pending;
983 g_mutex_unlock (worker->write_lock);
985 /* Note that write_lock is only used for protecting the @write_queue
986 * and @write_is_pending fields of the GDBusWorker struct ... which we
987 * need to modify from arbitrary threads in _g_dbus_worker_send_message().
989 * Therefore, it's fine to drop it here when calling back into user
990 * code and then writing the message out onto the GIOStream since this
991 * function only runs on the worker thread.
993 message_was_dropped = _g_dbus_worker_emit_message_about_to_be_sent (worker, data->message);
994 if (G_LIKELY (!message_was_dropped))
997 if (!write_message (worker,
1002 _g_dbus_worker_emit_disconnected (worker, TRUE, error);
1003 g_error_free (error);
1006 message_to_write_data_free (data);
1008 return more_writes_are_pending;
1011 /* ---------------------------------------------------------------------------------------------------- */
1013 /* can be called from any thread - steals blob */
1015 _g_dbus_worker_send_message (GDBusWorker *worker,
1016 GDBusMessage *message,
1020 MessageToWriteData *data;
1022 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
1023 g_return_if_fail (blob != NULL);
1024 g_return_if_fail (blob_len > 16);
1026 data = g_new0 (MessageToWriteData, 1);
1027 data->message = g_object_ref (message);
1028 data->blob = blob; /* steal! */
1029 data->blob_size = blob_len;
1031 g_mutex_lock (worker->write_lock);
1032 g_queue_push_tail (worker->write_queue, data);
1033 if (!worker->write_is_pending)
1035 GSource *idle_source;
1037 worker->write_is_pending = TRUE;
1039 idle_source = g_idle_source_new ();
1040 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
1041 g_source_set_callback (idle_source,
1042 write_message_in_idle_cb,
1043 _g_dbus_worker_ref (worker),
1044 (GDestroyNotify) _g_dbus_worker_unref);
1045 g_source_attach (idle_source, shared_thread_data->context);
1046 g_source_unref (idle_source);
1048 g_mutex_unlock (worker->write_lock);
1051 /* ---------------------------------------------------------------------------------------------------- */
1054 _g_dbus_worker_thread_begin_func (gpointer user_data)
1056 GDBusWorker *worker = user_data;
1058 worker->thread = g_thread_self ();
1061 _g_dbus_worker_do_read (worker);
1065 _g_dbus_worker_new (GIOStream *stream,
1066 GDBusCapabilityFlags capabilities,
1067 gboolean initially_frozen,
1068 GDBusWorkerMessageReceivedCallback message_received_callback,
1069 GDBusWorkerMessageAboutToBeSentCallback message_about_to_be_sent_callback,
1070 GDBusWorkerDisconnectedCallback disconnected_callback,
1073 GDBusWorker *worker;
1075 g_return_val_if_fail (G_IS_IO_STREAM (stream), NULL);
1076 g_return_val_if_fail (message_received_callback != NULL, NULL);
1077 g_return_val_if_fail (message_about_to_be_sent_callback != NULL, NULL);
1078 g_return_val_if_fail (disconnected_callback != NULL, NULL);
1080 worker = g_new0 (GDBusWorker, 1);
1081 worker->ref_count = 1;
1083 worker->read_lock = g_mutex_new ();
1084 worker->message_received_callback = message_received_callback;
1085 worker->message_about_to_be_sent_callback = message_about_to_be_sent_callback;
1086 worker->disconnected_callback = disconnected_callback;
1087 worker->user_data = user_data;
1088 worker->stream = g_object_ref (stream);
1089 worker->capabilities = capabilities;
1090 worker->cancellable = g_cancellable_new ();
1092 worker->frozen = initially_frozen;
1093 worker->received_messages_while_frozen = g_queue_new ();
1095 worker->write_lock = g_mutex_new ();
1096 worker->write_queue = g_queue_new ();
1098 if (G_IS_SOCKET_CONNECTION (worker->stream))
1099 worker->socket = g_socket_connection_get_socket (G_SOCKET_CONNECTION (worker->stream));
1101 _g_dbus_shared_thread_ref (_g_dbus_worker_thread_begin_func, worker);
1106 /* ---------------------------------------------------------------------------------------------------- */
1108 /* This can be called from any thread - frees worker - guarantees no callbacks
1109 * will ever be issued again
1112 _g_dbus_worker_stop (GDBusWorker *worker)
1114 /* If we're called in the worker thread it means we are called from
1115 * a worker callback. This is fine, we just can't lock in that case since
1116 * we're already holding the lock...
1118 if (g_thread_self () != worker->thread)
1119 g_mutex_lock (worker->read_lock);
1120 worker->stopped = TRUE;
1121 if (g_thread_self () != worker->thread)
1122 g_mutex_unlock (worker->read_lock);
1124 g_cancellable_cancel (worker->cancellable);
1125 _g_dbus_worker_unref (worker);
1128 /* ---------------------------------------------------------------------------------------------------- */
1130 /* can be called from any thread (except the worker thread) - blocks
1131 * calling thread until all queued outgoing messages are written and
1132 * the transport has been flushed
1135 _g_dbus_worker_flush_sync (GDBusWorker *worker,
1136 GCancellable *cancellable,
1144 /* if the queue is empty, there's nothing to wait for */
1145 g_mutex_lock (worker->write_lock);
1146 if (g_queue_get_length (worker->write_queue) > 0)
1148 data = g_new0 (FlushData, 1);
1149 data->mutex = g_mutex_new ();
1150 data->cond = g_cond_new ();
1151 data->number_to_wait_for = worker->write_num_messages_written + g_queue_get_length (worker->write_queue);
1152 g_mutex_lock (data->mutex);
1153 worker->write_pending_flushes = g_list_prepend (worker->write_pending_flushes, data);
1155 g_mutex_unlock (worker->write_lock);
1159 g_cond_wait (data->cond, data->mutex);
1160 g_mutex_unlock (data->mutex);
1162 /* note:the element is removed from worker->write_pending_flushes in write_message() */
1163 g_cond_free (data->cond);
1164 g_mutex_free (data->mutex);
1168 ret = g_output_stream_flush (g_io_stream_get_output_stream (worker->stream),
1174 /* ---------------------------------------------------------------------------------------------------- */
1176 #define G_DBUS_DEBUG_AUTHENTICATION (1<<0)
1177 #define G_DBUS_DEBUG_MESSAGE (1<<1)
1178 #define G_DBUS_DEBUG_PAYLOAD (1<<2)
1179 #define G_DBUS_DEBUG_CALL (1<<3)
1180 #define G_DBUS_DEBUG_SIGNAL (1<<4)
1181 #define G_DBUS_DEBUG_INCOMING (1<<5)
1182 #define G_DBUS_DEBUG_EMISSION (1<<6)
1183 #define G_DBUS_DEBUG_ADDRESS (1<<7)
1184 #define G_DBUS_DEBUG_ALL 0xffffffff
1185 static gint _gdbus_debug_flags = 0;
1188 _g_dbus_debug_authentication (void)
1190 _g_dbus_initialize ();
1191 return (_gdbus_debug_flags & G_DBUS_DEBUG_AUTHENTICATION) != 0;
1195 _g_dbus_debug_message (void)
1197 _g_dbus_initialize ();
1198 return (_gdbus_debug_flags & G_DBUS_DEBUG_MESSAGE) != 0;
1202 _g_dbus_debug_payload (void)
1204 _g_dbus_initialize ();
1205 return (_gdbus_debug_flags & G_DBUS_DEBUG_PAYLOAD) != 0;
1209 _g_dbus_debug_call (void)
1211 _g_dbus_initialize ();
1212 return (_gdbus_debug_flags & G_DBUS_DEBUG_CALL) != 0;
1216 _g_dbus_debug_signal (void)
1218 _g_dbus_initialize ();
1219 return (_gdbus_debug_flags & G_DBUS_DEBUG_SIGNAL) != 0;
1223 _g_dbus_debug_incoming (void)
1225 _g_dbus_initialize ();
1226 return (_gdbus_debug_flags & G_DBUS_DEBUG_INCOMING) != 0;
1230 _g_dbus_debug_emission (void)
1232 _g_dbus_initialize ();
1233 return (_gdbus_debug_flags & G_DBUS_DEBUG_EMISSION) != 0;
1237 _g_dbus_debug_address (void)
1239 _g_dbus_initialize ();
1240 return (_gdbus_debug_flags & G_DBUS_DEBUG_ADDRESS) != 0;
1243 G_LOCK_DEFINE_STATIC (print_lock);
1246 _g_dbus_debug_print_lock (void)
1248 G_LOCK (print_lock);
1252 _g_dbus_debug_print_unlock (void)
1254 G_UNLOCK (print_lock);
1258 * _g_dbus_initialize:
1260 * Does various one-time init things such as
1262 * - registering the G_DBUS_ERROR error domain
1263 * - parses the G_DBUS_DEBUG environment variable
1266 _g_dbus_initialize (void)
1268 static volatile gsize initialized = 0;
1270 if (g_once_init_enter (&initialized))
1272 volatile GQuark g_dbus_error_domain;
1275 g_dbus_error_domain = G_DBUS_ERROR;
1277 debug = g_getenv ("G_DBUS_DEBUG");
1282 tokens = g_strsplit (debug, ",", 0);
1283 for (n = 0; tokens[n] != NULL; n++)
1285 if (g_strcmp0 (tokens[n], "authentication") == 0)
1286 _gdbus_debug_flags |= G_DBUS_DEBUG_AUTHENTICATION;
1287 else if (g_strcmp0 (tokens[n], "message") == 0)
1288 _gdbus_debug_flags |= G_DBUS_DEBUG_MESSAGE;
1289 else if (g_strcmp0 (tokens[n], "payload") == 0) /* implies `message' */
1290 _gdbus_debug_flags |= (G_DBUS_DEBUG_MESSAGE | G_DBUS_DEBUG_PAYLOAD);
1291 else if (g_strcmp0 (tokens[n], "call") == 0)
1292 _gdbus_debug_flags |= G_DBUS_DEBUG_CALL;
1293 else if (g_strcmp0 (tokens[n], "signal") == 0)
1294 _gdbus_debug_flags |= G_DBUS_DEBUG_SIGNAL;
1295 else if (g_strcmp0 (tokens[n], "incoming") == 0)
1296 _gdbus_debug_flags |= G_DBUS_DEBUG_INCOMING;
1297 else if (g_strcmp0 (tokens[n], "emission") == 0)
1298 _gdbus_debug_flags |= G_DBUS_DEBUG_EMISSION;
1299 else if (g_strcmp0 (tokens[n], "address") == 0)
1300 _gdbus_debug_flags |= G_DBUS_DEBUG_ADDRESS;
1301 else if (g_strcmp0 (tokens[n], "all") == 0)
1302 _gdbus_debug_flags |= G_DBUS_DEBUG_ALL;
1304 g_strfreev (tokens);
1307 g_once_init_leave (&initialized, 1);
1311 /* ---------------------------------------------------------------------------------------------------- */
1314 _g_dbus_compute_complete_signature (GDBusArgInfo **args)
1316 const GVariantType *arg_types[256];
1320 for (n = 0; args[n] != NULL; n++)
1322 /* DBus places a hard limit of 255 on signature length.
1323 * therefore number of args must be less than 256.
1327 arg_types[n] = G_VARIANT_TYPE (args[n]->signature);
1329 if G_UNLIKELY (arg_types[n] == NULL)
1335 return g_variant_type_new_tuple (arg_types, n);
1338 /* ---------------------------------------------------------------------------------------------------- */
1342 extern BOOL WINAPI ConvertSidToStringSidA (PSID Sid, LPSTR *StringSid);
1345 _g_dbus_win32_get_user_sid (void)
1349 DWORD token_information_len;
1356 h = INVALID_HANDLE_VALUE;
1358 if (!OpenProcessToken (GetCurrentProcess (), TOKEN_QUERY, &h))
1360 g_warning ("OpenProcessToken failed with error code %d", (gint) GetLastError ());
1364 /* Get length of buffer */
1365 token_information_len = 0;
1366 if (!GetTokenInformation (h, TokenUser, NULL, 0, &token_information_len))
1368 if (GetLastError () != ERROR_INSUFFICIENT_BUFFER)
1370 g_warning ("GetTokenInformation() failed with error code %d", (gint) GetLastError ());
1374 user = g_malloc (token_information_len);
1375 if (!GetTokenInformation (h, TokenUser, user, token_information_len, &token_information_len))
1377 g_warning ("GetTokenInformation() failed with error code %d", (gint) GetLastError ());
1381 psid = user->User.Sid;
1382 if (!IsValidSid (psid))
1384 g_warning ("Invalid SID");
1388 if (!ConvertSidToStringSidA (psid, &sid))
1390 g_warning ("Invalid SID");
1394 ret = g_strdup (sid);
1399 if (h != INVALID_HANDLE_VALUE)
1405 /* ---------------------------------------------------------------------------------------------------- */
1408 _g_dbus_get_machine_id (GError **error)
1411 /* TODO: use PACKAGE_LOCALSTATEDIR ? */
1413 if (!g_file_get_contents ("/var/lib/dbus/machine-id",
1418 g_prefix_error (error, _("Unable to load /var/lib/dbus/machine-id: "));
1422 /* TODO: validate value */
1428 /* ---------------------------------------------------------------------------------------------------- */
1431 _g_dbus_enum_to_string (GType enum_type, gint value)
1435 GEnumValue *enum_value;
1437 klass = g_type_class_ref (enum_type);
1438 enum_value = g_enum_get_value (klass, value);
1439 if (enum_value != NULL)
1440 ret = g_strdup (enum_value->value_nick);
1442 ret = g_strdup_printf ("unknown (value %d)", value);
1443 g_type_class_unref (klass);
1447 /* ---------------------------------------------------------------------------------------------------- */
1449 #define __G_DBUS_PRIVATE_C__
1450 #include "gioaliasdef.c"