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 "gsocketoutputstream.h"
48 #include "gunixfdmessage.h"
49 #include "gunixconnection.h"
50 #include "gunixcredentialsmessage.h"
59 static gboolean
_g_dbus_worker_do_initial_read (gpointer data
);
61 /* ---------------------------------------------------------------------------------------------------- */
64 _g_dbus_hexdump (const gchar
*data
, gsize len
, guint indent
)
69 ret
= g_string_new (NULL
);
71 for (n
= 0; n
< len
; n
+= 16)
73 g_string_append_printf (ret
, "%*s%04x: ", indent
, "", n
);
75 for (m
= n
; m
< n
+ 16; m
++)
77 if (m
> n
&& (m
%4) == 0)
78 g_string_append_c (ret
, ' ');
80 g_string_append_printf (ret
, "%02x ", (guchar
) data
[m
]);
82 g_string_append (ret
, " ");
85 g_string_append (ret
, " ");
87 for (m
= n
; m
< len
&& m
< n
+ 16; m
++)
88 g_string_append_c (ret
, g_ascii_isprint (data
[m
]) ? data
[m
] : '.');
90 g_string_append_c (ret
, '\n');
93 return g_string_free (ret
, FALSE
);
96 /* ---------------------------------------------------------------------------------------------------- */
98 /* Unfortunately ancillary messages are discarded when reading from a
99 * socket using the GSocketInputStream abstraction. So we provide a
100 * very GInputStream-ish API that uses GSocket in this case (very
101 * similar to GSocketInputStream).
107 GCancellable
*cancellable
;
112 GSocketControlMessage
***messages
;
115 GSimpleAsyncResult
*simple
;
117 gboolean from_mainloop
;
118 } ReadWithControlData
;
121 read_with_control_data_free (ReadWithControlData
*data
)
123 g_object_unref (data
->socket
);
124 if (data
->cancellable
!= NULL
)
125 g_object_unref (data
->cancellable
);
126 g_object_unref (data
->simple
);
131 _g_socket_read_with_control_messages_ready (GSocket
*socket
,
132 GIOCondition condition
,
135 ReadWithControlData
*data
= user_data
;
141 vector
.buffer
= data
->buffer
;
142 vector
.size
= data
->count
;
143 result
= g_socket_receive_message (data
->socket
,
154 g_simple_async_result_set_op_res_gssize (data
->simple
, result
);
158 g_assert (error
!= NULL
);
159 g_simple_async_result_take_error (data
->simple
, error
);
162 if (data
->from_mainloop
)
163 g_simple_async_result_complete (data
->simple
);
165 g_simple_async_result_complete_in_idle (data
->simple
);
171 _g_socket_read_with_control_messages (GSocket
*socket
,
174 GSocketControlMessage
***messages
,
177 GCancellable
*cancellable
,
178 GAsyncReadyCallback callback
,
181 ReadWithControlData
*data
;
183 data
= g_new0 (ReadWithControlData
, 1);
184 data
->socket
= g_object_ref (socket
);
185 data
->cancellable
= cancellable
!= NULL
? g_object_ref (cancellable
) : NULL
;
186 data
->buffer
= buffer
;
188 data
->messages
= messages
;
189 data
->num_messages
= num_messages
;
191 data
->simple
= g_simple_async_result_new (G_OBJECT (socket
),
194 _g_socket_read_with_control_messages
);
195 g_simple_async_result_set_check_cancellable (data
->simple
, cancellable
);
197 if (!g_socket_condition_check (socket
, G_IO_IN
))
200 data
->from_mainloop
= TRUE
;
201 source
= g_socket_create_source (data
->socket
,
202 G_IO_IN
| G_IO_HUP
| G_IO_ERR
,
204 g_source_set_callback (source
,
205 (GSourceFunc
) _g_socket_read_with_control_messages_ready
,
207 (GDestroyNotify
) read_with_control_data_free
);
208 g_source_attach (source
, g_main_context_get_thread_default ());
209 g_source_unref (source
);
213 _g_socket_read_with_control_messages_ready (data
->socket
, G_IO_IN
, data
);
214 read_with_control_data_free (data
);
219 _g_socket_read_with_control_messages_finish (GSocket
*socket
,
220 GAsyncResult
*result
,
223 GSimpleAsyncResult
*simple
= G_SIMPLE_ASYNC_RESULT (result
);
225 g_return_val_if_fail (G_IS_SOCKET (socket
), -1);
226 g_warn_if_fail (g_simple_async_result_get_source_tag (simple
) == _g_socket_read_with_control_messages
);
228 if (g_simple_async_result_propagate_error (simple
, error
))
231 return g_simple_async_result_get_op_res_gssize (simple
);
234 /* ---------------------------------------------------------------------------------------------------- */
236 /* Work-around for https://bugzilla.gnome.org/show_bug.cgi?id=627724 */
238 static GPtrArray
*ensured_classes
= NULL
;
241 ensure_type (GType gtype
)
243 g_ptr_array_add (ensured_classes
, g_type_class_ref (gtype
));
247 release_required_types (void)
249 g_ptr_array_foreach (ensured_classes
, (GFunc
) g_type_class_unref
, NULL
);
250 g_ptr_array_unref (ensured_classes
);
251 ensured_classes
= NULL
;
255 ensure_required_types (void)
257 g_assert (ensured_classes
== NULL
);
258 ensured_classes
= g_ptr_array_new ();
259 ensure_type (G_TYPE_SIMPLE_ASYNC_RESULT
);
260 ensure_type (G_TYPE_MEMORY_INPUT_STREAM
);
262 /* ---------------------------------------------------------------------------------------------------- */
266 volatile gint refcount
;
268 GMainContext
*context
;
273 gdbus_shared_thread_func (gpointer user_data
)
275 SharedThreadData
*data
= user_data
;
277 g_main_context_push_thread_default (data
->context
);
278 g_main_loop_run (data
->loop
);
279 g_main_context_pop_thread_default (data
->context
);
281 release_required_types ();
286 /* ---------------------------------------------------------------------------------------------------- */
288 static SharedThreadData
*
289 _g_dbus_shared_thread_ref (void)
291 static gsize shared_thread_data
= 0;
292 SharedThreadData
*ret
;
294 if (g_once_init_enter (&shared_thread_data
))
296 SharedThreadData
*data
;
298 /* Work-around for https://bugzilla.gnome.org/show_bug.cgi?id=627724 */
299 ensure_required_types ();
301 data
= g_new0 (SharedThreadData
, 1);
304 data
->context
= g_main_context_new ();
305 data
->loop
= g_main_loop_new (data
->context
, FALSE
);
306 data
->thread
= g_thread_new ("gdbus",
307 gdbus_shared_thread_func
,
309 /* We can cast between gsize and gpointer safely */
310 g_once_init_leave (&shared_thread_data
, (gsize
) data
);
313 ret
= (SharedThreadData
*) shared_thread_data
;
314 g_atomic_int_inc (&ret
->refcount
);
319 _g_dbus_shared_thread_unref (SharedThreadData
*data
)
321 /* TODO: actually destroy the shared thread here */
323 g_assert (data
!= NULL
);
324 if (g_atomic_int_dec_and_test (&data
->refcount
))
326 g_main_loop_quit (data
->loop
);
327 //g_thread_join (data->thread);
328 g_main_loop_unref (data
->loop
);
329 g_main_context_unref (data
->context
);
334 /* ---------------------------------------------------------------------------------------------------- */
345 volatile gint ref_count
;
347 SharedThreadData
*shared_thread_data
;
349 /* really a boolean, but GLib 2.28 lacks atomic boolean ops */
350 volatile gint stopped
;
352 /* TODO: frozen (e.g. G_DBUS_CONNECTION_FLAGS_DELAY_MESSAGE_PROCESSING) currently
353 * only affects messages received from the other peer (since GDBusServer is the
354 * only user) - we might want it to affect messages sent to the other peer too?
357 GDBusCapabilityFlags capabilities
;
358 GQueue
*received_messages_while_frozen
;
361 GCancellable
*cancellable
;
362 GDBusWorkerMessageReceivedCallback message_received_callback
;
363 GDBusWorkerMessageAboutToBeSentCallback message_about_to_be_sent_callback
;
364 GDBusWorkerDisconnectedCallback disconnected_callback
;
367 /* if not NULL, stream is GSocketConnection */
370 /* used for reading */
373 gsize read_buffer_allocated_size
;
374 gsize read_buffer_cur_size
;
375 gsize read_buffer_bytes_wanted
;
376 GUnixFDList
*read_fd_list
;
377 GSocketControlMessage
**read_ancillary_messages
;
378 gint read_num_ancillary_messages
;
380 /* Whether an async write, flush or close, or none of those, is pending.
381 * Only the worker thread may change its value, and only with the write_lock.
382 * Other threads may read its value when holding the write_lock.
383 * The worker thread may read its value at any time.
385 OutputPending output_pending
;
386 /* used for writing */
388 /* queue of MessageToWriteData, protected by write_lock */
390 /* protected by write_lock */
391 guint64 write_num_messages_written
;
392 /* number of messages we'd written out last time we flushed;
393 * protected by write_lock
395 guint64 write_num_messages_flushed
;
396 /* list of FlushData, protected by write_lock */
397 GList
*write_pending_flushes
;
398 /* list of CloseData, protected by write_lock */
399 GList
*pending_close_attempts
;
400 /* no lock - only used from the worker thread */
401 gboolean close_expected
;
404 static void _g_dbus_worker_unref (GDBusWorker
*worker
);
406 /* ---------------------------------------------------------------------------------------------------- */
412 guint64 number_to_wait_for
;
416 struct _MessageToWriteData
;
417 typedef struct _MessageToWriteData MessageToWriteData
;
419 static void message_to_write_data_free (MessageToWriteData
*data
);
421 static void read_message_print_transport_debug (gssize bytes_read
,
422 GDBusWorker
*worker
);
424 static void write_message_print_transport_debug (gssize bytes_written
,
425 MessageToWriteData
*data
);
429 GCancellable
*cancellable
;
430 GSimpleAsyncResult
*result
;
433 static void close_data_free (CloseData
*close_data
)
435 if (close_data
->cancellable
!= NULL
)
436 g_object_unref (close_data
->cancellable
);
438 if (close_data
->result
!= NULL
)
439 g_object_unref (close_data
->result
);
441 _g_dbus_worker_unref (close_data
->worker
);
442 g_slice_free (CloseData
, close_data
);
445 /* ---------------------------------------------------------------------------------------------------- */
448 _g_dbus_worker_ref (GDBusWorker
*worker
)
450 g_atomic_int_inc (&worker
->ref_count
);
455 _g_dbus_worker_unref (GDBusWorker
*worker
)
457 if (g_atomic_int_dec_and_test (&worker
->ref_count
))
459 g_assert (worker
->write_pending_flushes
== NULL
);
461 _g_dbus_shared_thread_unref (worker
->shared_thread_data
);
463 g_object_unref (worker
->stream
);
465 g_mutex_clear (&worker
->read_lock
);
466 g_object_unref (worker
->cancellable
);
467 if (worker
->read_fd_list
!= NULL
)
468 g_object_unref (worker
->read_fd_list
);
470 g_queue_free_full (worker
->received_messages_while_frozen
, (GDestroyNotify
) g_object_unref
);
471 g_mutex_clear (&worker
->write_lock
);
472 g_queue_free_full (worker
->write_queue
, (GDestroyNotify
) message_to_write_data_free
);
473 g_free (worker
->read_buffer
);
480 _g_dbus_worker_emit_disconnected (GDBusWorker
*worker
,
481 gboolean remote_peer_vanished
,
484 if (!g_atomic_int_get (&worker
->stopped
))
485 worker
->disconnected_callback (worker
, remote_peer_vanished
, error
, worker
->user_data
);
489 _g_dbus_worker_emit_message_received (GDBusWorker
*worker
,
490 GDBusMessage
*message
)
492 if (!g_atomic_int_get (&worker
->stopped
))
493 worker
->message_received_callback (worker
, message
, worker
->user_data
);
496 static GDBusMessage
*
497 _g_dbus_worker_emit_message_about_to_be_sent (GDBusWorker
*worker
,
498 GDBusMessage
*message
)
501 if (!g_atomic_int_get (&worker
->stopped
))
502 ret
= worker
->message_about_to_be_sent_callback (worker
, message
, worker
->user_data
);
508 /* can only be called from private thread with read-lock held - takes ownership of @message */
510 _g_dbus_worker_queue_or_deliver_received_message (GDBusWorker
*worker
,
511 GDBusMessage
*message
)
513 if (worker
->frozen
|| g_queue_get_length (worker
->received_messages_while_frozen
) > 0)
516 g_queue_push_tail (worker
->received_messages_while_frozen
, message
);
520 /* not frozen, nor anything in queue */
521 _g_dbus_worker_emit_message_received (worker
, message
);
522 g_object_unref (message
);
526 /* called in private thread shared by all GDBusConnection instances (without read-lock held) */
528 unfreeze_in_idle_cb (gpointer user_data
)
530 GDBusWorker
*worker
= user_data
;
531 GDBusMessage
*message
;
533 g_mutex_lock (&worker
->read_lock
);
536 while ((message
= g_queue_pop_head (worker
->received_messages_while_frozen
)) != NULL
)
538 _g_dbus_worker_emit_message_received (worker
, message
);
539 g_object_unref (message
);
541 worker
->frozen
= FALSE
;
545 g_assert (g_queue_get_length (worker
->received_messages_while_frozen
) == 0);
547 g_mutex_unlock (&worker
->read_lock
);
551 /* can be called from any thread */
553 _g_dbus_worker_unfreeze (GDBusWorker
*worker
)
555 GSource
*idle_source
;
556 idle_source
= g_idle_source_new ();
557 g_source_set_priority (idle_source
, G_PRIORITY_DEFAULT
);
558 g_source_set_callback (idle_source
,
560 _g_dbus_worker_ref (worker
),
561 (GDestroyNotify
) _g_dbus_worker_unref
);
562 g_source_attach (idle_source
, worker
->shared_thread_data
->context
);
563 g_source_unref (idle_source
);
566 /* ---------------------------------------------------------------------------------------------------- */
568 static void _g_dbus_worker_do_read_unlocked (GDBusWorker
*worker
);
570 /* called in private thread shared by all GDBusConnection instances (without read-lock held) */
572 _g_dbus_worker_do_read_cb (GInputStream
*input_stream
,
576 GDBusWorker
*worker
= user_data
;
580 g_mutex_lock (&worker
->read_lock
);
582 /* If already stopped, don't even process the reply */
583 if (g_atomic_int_get (&worker
->stopped
))
587 if (worker
->socket
== NULL
)
588 bytes_read
= g_input_stream_read_finish (g_io_stream_get_input_stream (worker
->stream
),
592 bytes_read
= _g_socket_read_with_control_messages_finish (worker
->socket
,
595 if (worker
->read_num_ancillary_messages
> 0)
598 for (n
= 0; n
< worker
->read_num_ancillary_messages
; n
++)
600 GSocketControlMessage
*control_message
= G_SOCKET_CONTROL_MESSAGE (worker
->read_ancillary_messages
[n
]);
606 else if (G_IS_UNIX_FD_MESSAGE (control_message
))
608 GUnixFDMessage
*fd_message
;
612 fd_message
= G_UNIX_FD_MESSAGE (control_message
);
613 fds
= g_unix_fd_message_steal_fds (fd_message
, &num_fds
);
614 if (worker
->read_fd_list
== NULL
)
616 worker
->read_fd_list
= g_unix_fd_list_new_from_array (fds
, num_fds
);
621 for (n
= 0; n
< num_fds
; n
++)
623 /* TODO: really want a append_steal() */
624 g_unix_fd_list_append (worker
->read_fd_list
, fds
[n
], NULL
);
625 (void) g_close (fds
[n
], NULL
);
630 else if (G_IS_UNIX_CREDENTIALS_MESSAGE (control_message
))
642 "Unexpected ancillary message of type %s received from peer",
643 g_type_name (G_TYPE_FROM_INSTANCE (control_message
)));
644 _g_dbus_worker_emit_disconnected (worker
, TRUE
, error
);
645 g_error_free (error
);
646 g_object_unref (control_message
);
648 while (n
< worker
->read_num_ancillary_messages
)
649 g_object_unref (worker
->read_ancillary_messages
[n
++]);
650 g_free (worker
->read_ancillary_messages
);
654 g_object_unref (control_message
);
656 g_free (worker
->read_ancillary_messages
);
659 if (bytes_read
== -1)
661 if (G_UNLIKELY (_g_dbus_debug_transport ()))
663 _g_dbus_debug_print_lock ();
664 g_print ("========================================================================\n"
665 "GDBus-debug:Transport:\n"
666 " ---- READ ERROR on stream of type %s:\n"
668 g_type_name (G_TYPE_FROM_INSTANCE (g_io_stream_get_input_stream (worker
->stream
))),
669 g_quark_to_string (error
->domain
), error
->code
,
671 _g_dbus_debug_print_unlock ();
674 /* Every async read that uses this callback uses worker->cancellable
675 * as its GCancellable. worker->cancellable gets cancelled if and only
676 * if the GDBusConnection tells us to close (either via
677 * _g_dbus_worker_stop, which is called on last-unref, or directly),
678 * so a cancelled read must mean our connection was closed locally.
680 * If we're closing, other errors are possible - notably,
681 * G_IO_ERROR_CLOSED can be seen if we close the stream with an async
682 * read in-flight. It seems sensible to treat all read errors during
683 * closing as an expected thing that doesn't trip exit-on-close.
685 * Because close_expected can't be set until we get into the worker
686 * thread, but the cancellable is signalled sooner (from another
687 * thread), we do still need to check the error.
689 if (worker
->close_expected
||
690 g_error_matches (error
, G_IO_ERROR
, G_IO_ERROR_CANCELLED
))
691 _g_dbus_worker_emit_disconnected (worker
, FALSE
, NULL
);
693 _g_dbus_worker_emit_disconnected (worker
, TRUE
, error
);
695 g_error_free (error
);
700 g_debug ("read %d bytes (is_closed=%d blocking=%d condition=0x%02x) stream %p, %p",
702 g_socket_is_closed (g_socket_connection_get_socket (G_SOCKET_CONNECTION (worker
->stream
))),
703 g_socket_get_blocking (g_socket_connection_get_socket (G_SOCKET_CONNECTION (worker
->stream
))),
704 g_socket_condition_check (g_socket_connection_get_socket (G_SOCKET_CONNECTION (worker
->stream
)),
705 G_IO_IN
| G_IO_OUT
| G_IO_HUP
),
710 /* TODO: hmm, hmm... */
716 "Underlying GIOStream returned 0 bytes on an async read");
717 _g_dbus_worker_emit_disconnected (worker
, TRUE
, error
);
718 g_error_free (error
);
722 read_message_print_transport_debug (bytes_read
, worker
);
724 worker
->read_buffer_cur_size
+= bytes_read
;
725 if (worker
->read_buffer_bytes_wanted
== worker
->read_buffer_cur_size
)
727 /* OK, got what we asked for! */
728 if (worker
->read_buffer_bytes_wanted
== 16)
731 /* OK, got the header - determine how many more bytes are needed */
733 message_len
= g_dbus_message_bytes_needed ((guchar
*) worker
->read_buffer
,
736 if (message_len
== -1)
738 g_warning ("_g_dbus_worker_do_read_cb: error determining bytes needed: %s", error
->message
);
739 _g_dbus_worker_emit_disconnected (worker
, FALSE
, error
);
740 g_error_free (error
);
744 worker
->read_buffer_bytes_wanted
= message_len
;
745 _g_dbus_worker_do_read_unlocked (worker
);
749 GDBusMessage
*message
;
752 /* TODO: use connection->priv->auth to decode the message */
754 message
= g_dbus_message_new_from_blob ((guchar
*) worker
->read_buffer
,
755 worker
->read_buffer_cur_size
,
756 worker
->capabilities
,
761 s
= _g_dbus_hexdump (worker
->read_buffer
, worker
->read_buffer_cur_size
, 2);
762 g_warning ("Error decoding D-Bus message of %" G_GSIZE_FORMAT
" bytes\n"
764 "The payload is as follows:\n"
766 worker
->read_buffer_cur_size
,
770 _g_dbus_worker_emit_disconnected (worker
, FALSE
, error
);
771 g_error_free (error
);
776 if (worker
->read_fd_list
!= NULL
)
778 g_dbus_message_set_unix_fd_list (message
, worker
->read_fd_list
);
779 g_object_unref (worker
->read_fd_list
);
780 worker
->read_fd_list
= NULL
;
784 if (G_UNLIKELY (_g_dbus_debug_message ()))
787 _g_dbus_debug_print_lock ();
788 g_print ("========================================================================\n"
789 "GDBus-debug:Message:\n"
790 " <<<< RECEIVED D-Bus message (%" G_GSIZE_FORMAT
" bytes)\n",
791 worker
->read_buffer_cur_size
);
792 s
= g_dbus_message_print (message
, 2);
795 if (G_UNLIKELY (_g_dbus_debug_payload ()))
797 s
= _g_dbus_hexdump (worker
->read_buffer
, worker
->read_buffer_cur_size
, 2);
801 _g_dbus_debug_print_unlock ();
804 /* yay, got a message, go deliver it */
805 _g_dbus_worker_queue_or_deliver_received_message (worker
, message
);
807 /* start reading another message! */
808 worker
->read_buffer_bytes_wanted
= 0;
809 worker
->read_buffer_cur_size
= 0;
810 _g_dbus_worker_do_read_unlocked (worker
);
815 /* didn't get all the bytes we requested - so repeat the request... */
816 _g_dbus_worker_do_read_unlocked (worker
);
820 g_mutex_unlock (&worker
->read_lock
);
822 /* gives up the reference acquired when calling g_input_stream_read_async() */
823 _g_dbus_worker_unref (worker
);
826 /* called in private thread shared by all GDBusConnection instances (with read-lock held) */
828 _g_dbus_worker_do_read_unlocked (GDBusWorker
*worker
)
830 /* Note that we do need to keep trying to read even if close_expected is
831 * true, because only failing a read causes us to signal 'closed'.
834 /* if bytes_wanted is zero, it means start reading a message */
835 if (worker
->read_buffer_bytes_wanted
== 0)
837 worker
->read_buffer_cur_size
= 0;
838 worker
->read_buffer_bytes_wanted
= 16;
841 /* ensure we have a (big enough) buffer */
842 if (worker
->read_buffer
== NULL
|| worker
->read_buffer_bytes_wanted
> worker
->read_buffer_allocated_size
)
844 /* TODO: 4096 is randomly chosen; might want a better chosen default minimum */
845 worker
->read_buffer_allocated_size
= MAX (worker
->read_buffer_bytes_wanted
, 4096);
846 worker
->read_buffer
= g_realloc (worker
->read_buffer
, worker
->read_buffer_allocated_size
);
849 if (worker
->socket
== NULL
)
850 g_input_stream_read_async (g_io_stream_get_input_stream (worker
->stream
),
851 worker
->read_buffer
+ worker
->read_buffer_cur_size
,
852 worker
->read_buffer_bytes_wanted
- worker
->read_buffer_cur_size
,
855 (GAsyncReadyCallback
) _g_dbus_worker_do_read_cb
,
856 _g_dbus_worker_ref (worker
));
859 worker
->read_ancillary_messages
= NULL
;
860 worker
->read_num_ancillary_messages
= 0;
861 _g_socket_read_with_control_messages (worker
->socket
,
862 worker
->read_buffer
+ worker
->read_buffer_cur_size
,
863 worker
->read_buffer_bytes_wanted
- worker
->read_buffer_cur_size
,
864 &worker
->read_ancillary_messages
,
865 &worker
->read_num_ancillary_messages
,
868 (GAsyncReadyCallback
) _g_dbus_worker_do_read_cb
,
869 _g_dbus_worker_ref (worker
));
873 /* called in private thread shared by all GDBusConnection instances (without read-lock held) */
875 _g_dbus_worker_do_initial_read (gpointer data
)
877 GDBusWorker
*worker
= data
;
878 g_mutex_lock (&worker
->read_lock
);
879 _g_dbus_worker_do_read_unlocked (worker
);
880 g_mutex_unlock (&worker
->read_lock
);
884 /* ---------------------------------------------------------------------------------------------------- */
886 struct _MessageToWriteData
889 GDBusMessage
*message
;
894 GSimpleAsyncResult
*simple
;
899 message_to_write_data_free (MessageToWriteData
*data
)
901 _g_dbus_worker_unref (data
->worker
);
903 g_object_unref (data
->message
);
908 /* ---------------------------------------------------------------------------------------------------- */
910 static void write_message_continue_writing (MessageToWriteData
*data
);
912 /* called in private thread shared by all GDBusConnection instances
914 * write-lock is not held on entry
915 * output_pending is PENDING_WRITE on entry
918 write_message_async_cb (GObject
*source_object
,
922 MessageToWriteData
*data
= user_data
;
923 GSimpleAsyncResult
*simple
;
924 gssize bytes_written
;
927 /* Note: we can't access data->simple after calling g_async_result_complete () because the
928 * callback can free @data and we're not completing in idle. So use a copy of the pointer.
930 simple
= data
->simple
;
933 bytes_written
= g_output_stream_write_finish (G_OUTPUT_STREAM (source_object
),
936 if (bytes_written
== -1)
938 g_simple_async_result_take_error (simple
, error
);
939 g_simple_async_result_complete (simple
);
940 g_object_unref (simple
);
943 g_assert (bytes_written
> 0); /* zero is never returned */
945 write_message_print_transport_debug (bytes_written
, data
);
947 data
->total_written
+= bytes_written
;
948 g_assert (data
->total_written
<= data
->blob_size
);
949 if (data
->total_written
== data
->blob_size
)
951 g_simple_async_result_complete (simple
);
952 g_object_unref (simple
);
956 write_message_continue_writing (data
);
962 /* called in private thread shared by all GDBusConnection instances
964 * write-lock is not held on entry
965 * output_pending is PENDING_WRITE on entry
969 on_socket_ready (GSocket
*socket
,
970 GIOCondition condition
,
973 MessageToWriteData
*data
= user_data
;
974 write_message_continue_writing (data
);
975 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
;
989 GSimpleAsyncResult
*simple
;
990 GUnixFDList
*fd_list
;
994 /* Note: we can't access data->simple after calling g_async_result_complete () because the
995 * callback can free @data and we're not completing in idle. So use a copy of the pointer.
997 simple
= data
->simple
;
1000 ostream
= g_io_stream_get_output_stream (data
->worker
->stream
);
1002 fd_list
= g_dbus_message_get_unix_fd_list (data
->message
);
1005 g_assert (!g_output_stream_has_pending (ostream
));
1006 g_assert_cmpint (data
->total_written
, <, data
->blob_size
);
1012 else if (G_IS_SOCKET_OUTPUT_STREAM (ostream
) && data
->total_written
== 0)
1014 GOutputVector vector
;
1015 GSocketControlMessage
*control_message
;
1016 gssize bytes_written
;
1019 vector
.buffer
= data
->blob
;
1020 vector
.size
= data
->blob_size
;
1022 control_message
= NULL
;
1023 if (fd_list
!= NULL
&& g_unix_fd_list_get_length (fd_list
) > 0)
1025 if (!(data
->worker
->capabilities
& G_DBUS_CAPABILITY_FLAGS_UNIX_FD_PASSING
))
1027 g_simple_async_result_set_error (simple
,
1030 "Tried sending a file descriptor but remote peer does not support this capability");
1031 g_simple_async_result_complete (simple
);
1032 g_object_unref (simple
);
1035 control_message
= g_unix_fd_message_new_with_fd_list (fd_list
);
1039 bytes_written
= g_socket_send_message (data
->worker
->socket
,
1043 control_message
!= NULL
? &control_message
: NULL
,
1044 control_message
!= NULL
? 1 : 0,
1046 data
->worker
->cancellable
,
1048 if (control_message
!= NULL
)
1049 g_object_unref (control_message
);
1051 if (bytes_written
== -1)
1053 /* Handle WOULD_BLOCK by waiting until there's room in the buffer */
1054 if (g_error_matches (error
, G_IO_ERROR
, G_IO_ERROR_WOULD_BLOCK
))
1057 source
= g_socket_create_source (data
->worker
->socket
,
1058 G_IO_OUT
| G_IO_HUP
| G_IO_ERR
,
1059 data
->worker
->cancellable
);
1060 g_source_set_callback (source
,
1061 (GSourceFunc
) on_socket_ready
,
1063 NULL
); /* GDestroyNotify */
1064 g_source_attach (source
, g_main_context_get_thread_default ());
1065 g_source_unref (source
);
1066 g_error_free (error
);
1069 g_simple_async_result_take_error (simple
, error
);
1070 g_simple_async_result_complete (simple
);
1071 g_object_unref (simple
);
1074 g_assert (bytes_written
> 0); /* zero is never returned */
1076 write_message_print_transport_debug (bytes_written
, data
);
1078 data
->total_written
+= bytes_written
;
1079 g_assert (data
->total_written
<= data
->blob_size
);
1080 if (data
->total_written
== data
->blob_size
)
1082 g_simple_async_result_complete (simple
);
1083 g_object_unref (simple
);
1087 write_message_continue_writing (data
);
1093 if (fd_list
!= NULL
)
1095 g_simple_async_result_set_error (simple
,
1098 "Tried sending a file descriptor on unsupported stream of type %s",
1099 g_type_name (G_TYPE_FROM_INSTANCE (ostream
)));
1100 g_simple_async_result_complete (simple
);
1101 g_object_unref (simple
);
1106 g_output_stream_write_async (ostream
,
1107 (const gchar
*) data
->blob
+ data
->total_written
,
1108 data
->blob_size
- data
->total_written
,
1110 data
->worker
->cancellable
,
1111 write_message_async_cb
,
1120 /* called in private thread shared by all GDBusConnection instances
1122 * write-lock is not held on entry
1123 * output_pending is PENDING_WRITE on entry
1126 write_message_async (GDBusWorker
*worker
,
1127 MessageToWriteData
*data
,
1128 GAsyncReadyCallback callback
,
1131 data
->simple
= g_simple_async_result_new (NULL
,
1134 write_message_async
);
1135 data
->total_written
= 0;
1136 write_message_continue_writing (data
);
1139 /* called in private thread shared by all GDBusConnection instances (with write-lock held) */
1141 write_message_finish (GAsyncResult
*res
,
1144 g_warn_if_fail (g_simple_async_result_get_source_tag (G_SIMPLE_ASYNC_RESULT (res
)) == write_message_async
);
1145 if (g_simple_async_result_propagate_error (G_SIMPLE_ASYNC_RESULT (res
), error
))
1150 /* ---------------------------------------------------------------------------------------------------- */
1152 static void continue_writing (GDBusWorker
*worker
);
1156 GDBusWorker
*worker
;
1161 flush_data_list_complete (const GList
*flushers
,
1162 const GError
*error
)
1166 for (l
= flushers
; l
!= NULL
; l
= l
->next
)
1168 FlushData
*f
= l
->data
;
1170 f
->error
= error
!= NULL
? g_error_copy (error
) : NULL
;
1172 g_mutex_lock (&f
->mutex
);
1173 g_cond_signal (&f
->cond
);
1174 g_mutex_unlock (&f
->mutex
);
1178 /* called in private thread shared by all GDBusConnection instances
1180 * write-lock is not held on entry
1181 * output_pending is PENDING_FLUSH on entry
1184 ostream_flush_cb (GObject
*source_object
,
1188 FlushAsyncData
*data
= user_data
;
1192 g_output_stream_flush_finish (G_OUTPUT_STREAM (source_object
),
1198 if (G_UNLIKELY (_g_dbus_debug_transport ()))
1200 _g_dbus_debug_print_lock ();
1201 g_print ("========================================================================\n"
1202 "GDBus-debug:Transport:\n"
1203 " ---- FLUSHED stream of type %s\n",
1204 g_type_name (G_TYPE_FROM_INSTANCE (g_io_stream_get_output_stream (data
->worker
->stream
))));
1205 _g_dbus_debug_print_unlock ();
1209 g_assert (data
->flushers
!= NULL
);
1210 flush_data_list_complete (data
->flushers
, error
);
1211 g_list_free (data
->flushers
);
1214 g_error_free (error
);
1216 /* Make sure we tell folks that we don't have additional
1218 g_mutex_lock (&data
->worker
->write_lock
);
1219 data
->worker
->write_num_messages_flushed
= data
->worker
->write_num_messages_written
;
1220 g_assert (data
->worker
->output_pending
== PENDING_FLUSH
);
1221 data
->worker
->output_pending
= PENDING_NONE
;
1222 g_mutex_unlock (&data
->worker
->write_lock
);
1224 /* OK, cool, finally kick off the next write */
1225 continue_writing (data
->worker
);
1227 _g_dbus_worker_unref (data
->worker
);
1231 /* called in private thread shared by all GDBusConnection instances
1233 * write-lock is not held on entry
1234 * output_pending is PENDING_FLUSH on entry
1237 start_flush (FlushAsyncData
*data
)
1239 g_output_stream_flush_async (g_io_stream_get_output_stream (data
->worker
->stream
),
1241 data
->worker
->cancellable
,
1246 /* called in private thread shared by all GDBusConnection instances
1248 * write-lock is held on entry
1249 * output_pending is PENDING_NONE on entry
1252 message_written_unlocked (GDBusWorker
*worker
,
1253 MessageToWriteData
*message_data
)
1255 if (G_UNLIKELY (_g_dbus_debug_message ()))
1258 _g_dbus_debug_print_lock ();
1259 g_print ("========================================================================\n"
1260 "GDBus-debug:Message:\n"
1261 " >>>> SENT D-Bus message (%" G_GSIZE_FORMAT
" bytes)\n",
1262 message_data
->blob_size
);
1263 s
= g_dbus_message_print (message_data
->message
, 2);
1266 if (G_UNLIKELY (_g_dbus_debug_payload ()))
1268 s
= _g_dbus_hexdump (message_data
->blob
, message_data
->blob_size
, 2);
1269 g_print ("%s\n", s
);
1272 _g_dbus_debug_print_unlock ();
1275 worker
->write_num_messages_written
+= 1;
1278 /* called in private thread shared by all GDBusConnection instances
1280 * write-lock is held on entry
1281 * output_pending is PENDING_NONE on entry
1283 * Returns: non-%NULL, setting @output_pending, if we need to flush now
1285 static FlushAsyncData
*
1286 prepare_flush_unlocked (GDBusWorker
*worker
)
1293 for (l
= worker
->write_pending_flushes
; l
!= NULL
; l
= ll
)
1295 FlushData
*f
= l
->data
;
1298 if (f
->number_to_wait_for
== worker
->write_num_messages_written
)
1300 flushers
= g_list_append (flushers
, f
);
1301 worker
->write_pending_flushes
= g_list_delete_link (worker
->write_pending_flushes
, l
);
1304 if (flushers
!= NULL
)
1306 g_assert (worker
->output_pending
== PENDING_NONE
);
1307 worker
->output_pending
= PENDING_FLUSH
;
1310 if (flushers
!= NULL
)
1312 FlushAsyncData
*data
;
1314 data
= g_new0 (FlushAsyncData
, 1);
1315 data
->worker
= _g_dbus_worker_ref (worker
);
1316 data
->flushers
= flushers
;
1323 /* called in private thread shared by all GDBusConnection instances
1325 * write-lock is not held on entry
1326 * output_pending is PENDING_WRITE on entry
1329 write_message_cb (GObject
*source_object
,
1333 MessageToWriteData
*data
= user_data
;
1336 g_mutex_lock (&data
->worker
->write_lock
);
1337 g_assert (data
->worker
->output_pending
== PENDING_WRITE
);
1338 data
->worker
->output_pending
= PENDING_NONE
;
1341 if (!write_message_finish (res
, &error
))
1343 g_mutex_unlock (&data
->worker
->write_lock
);
1346 _g_dbus_worker_emit_disconnected (data
->worker
, TRUE
, error
);
1347 g_error_free (error
);
1349 g_mutex_lock (&data
->worker
->write_lock
);
1352 message_written_unlocked (data
->worker
, data
);
1354 g_mutex_unlock (&data
->worker
->write_lock
);
1356 continue_writing (data
->worker
);
1358 message_to_write_data_free (data
);
1361 /* called in private thread shared by all GDBusConnection instances
1363 * write-lock is not held on entry
1364 * output_pending is PENDING_CLOSE on entry
1367 iostream_close_cb (GObject
*source_object
,
1371 GDBusWorker
*worker
= user_data
;
1372 GError
*error
= NULL
;
1373 GList
*pending_close_attempts
, *pending_flush_attempts
;
1376 g_io_stream_close_finish (worker
->stream
, res
, &error
);
1378 g_mutex_lock (&worker
->write_lock
);
1380 pending_close_attempts
= worker
->pending_close_attempts
;
1381 worker
->pending_close_attempts
= NULL
;
1383 pending_flush_attempts
= worker
->write_pending_flushes
;
1384 worker
->write_pending_flushes
= NULL
;
1386 send_queue
= worker
->write_queue
;
1387 worker
->write_queue
= g_queue_new ();
1389 g_assert (worker
->output_pending
== PENDING_CLOSE
);
1390 worker
->output_pending
= PENDING_NONE
;
1392 g_mutex_unlock (&worker
->write_lock
);
1394 while (pending_close_attempts
!= NULL
)
1396 CloseData
*close_data
= pending_close_attempts
->data
;
1398 pending_close_attempts
= g_list_delete_link (pending_close_attempts
,
1399 pending_close_attempts
);
1401 if (close_data
->result
!= NULL
)
1404 g_simple_async_result_set_from_error (close_data
->result
, error
);
1406 /* this must be in an idle because the result is likely to be
1407 * intended for another thread
1409 g_simple_async_result_complete_in_idle (close_data
->result
);
1412 close_data_free (close_data
);
1415 g_clear_error (&error
);
1417 /* all messages queued for sending are discarded */
1418 g_queue_free_full (send_queue
, (GDestroyNotify
) message_to_write_data_free
);
1419 /* all queued flushes fail */
1420 error
= g_error_new (G_IO_ERROR
, G_IO_ERROR_CANCELLED
,
1421 _("Operation was cancelled"));
1422 flush_data_list_complete (pending_flush_attempts
, error
);
1423 g_list_free (pending_flush_attempts
);
1424 g_clear_error (&error
);
1426 _g_dbus_worker_unref (worker
);
1429 /* called in private thread shared by all GDBusConnection instances
1431 * write-lock is not held on entry
1432 * output_pending must be PENDING_NONE on entry
1435 continue_writing (GDBusWorker
*worker
)
1437 MessageToWriteData
*data
;
1438 FlushAsyncData
*flush_async_data
;
1441 /* we mustn't try to write two things at once */
1442 g_assert (worker
->output_pending
== PENDING_NONE
);
1444 g_mutex_lock (&worker
->write_lock
);
1447 flush_async_data
= NULL
;
1449 /* if we want to close the connection, that takes precedence */
1450 if (worker
->pending_close_attempts
!= NULL
)
1452 worker
->close_expected
= TRUE
;
1453 worker
->output_pending
= PENDING_CLOSE
;
1455 g_io_stream_close_async (worker
->stream
, G_PRIORITY_DEFAULT
,
1456 NULL
, iostream_close_cb
,
1457 _g_dbus_worker_ref (worker
));
1461 flush_async_data
= prepare_flush_unlocked (worker
);
1463 if (flush_async_data
== NULL
)
1465 data
= g_queue_pop_head (worker
->write_queue
);
1468 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 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 HW_PROFILE_INFOA info
;
2060 char *src
, *dest
, *res
;
2063 if (!GetCurrentHwProfileA (&info
))
2065 char *message
= g_win32_error_message (GetLastError ());
2069 _("Unable to get Hardware profile: %s"), message
);
2074 /* Form: {12340001-4980-1920-6788-123456789012} */
2075 src
= &info
.szHwProfileGuid
[0];
2077 res
= g_malloc (32+1);
2081 for (i
= 0; i
< 8; i
++)
2084 for (i
= 0; i
< 4; i
++)
2087 for (i
= 0; i
< 4; i
++)
2090 for (i
= 0; i
< 4; i
++)
2093 for (i
= 0; i
< 12; i
++)
2100 GError
*first_error
;
2101 /* TODO: use PACKAGE_LOCALSTATEDIR ? */
2104 if (!g_file_get_contents ("/var/lib/dbus/machine-id",
2108 !g_file_get_contents ("/etc/machine-id",
2113 g_propagate_prefixed_error (error
, first_error
,
2114 _("Unable to load /var/lib/dbus/machine-id or /etc/machine-id: "));
2118 /* ignore the error from the first try, if any */
2119 g_clear_error (&first_error
);
2120 /* TODO: validate value */
2127 /* ---------------------------------------------------------------------------------------------------- */
2130 _g_dbus_enum_to_string (GType enum_type
, gint value
)
2134 GEnumValue
*enum_value
;
2136 klass
= g_type_class_ref (enum_type
);
2137 enum_value
= g_enum_get_value (klass
, value
);
2138 if (enum_value
!= NULL
)
2139 ret
= g_strdup (enum_value
->value_nick
);
2141 ret
= g_strdup_printf ("unknown (value %d)", value
);
2142 g_type_class_unref (klass
);
2146 /* ---------------------------------------------------------------------------------------------------- */
2149 write_message_print_transport_debug (gssize bytes_written
,
2150 MessageToWriteData
*data
)
2152 if (G_LIKELY (!_g_dbus_debug_transport ()))
2155 _g_dbus_debug_print_lock ();
2156 g_print ("========================================================================\n"
2157 "GDBus-debug:Transport:\n"
2158 " >>>> WROTE %" G_GSSIZE_FORMAT
" bytes of message with serial %d and\n"
2159 " size %" G_GSIZE_FORMAT
" from offset %" G_GSIZE_FORMAT
" on a %s\n",
2161 g_dbus_message_get_serial (data
->message
),
2163 data
->total_written
,
2164 g_type_name (G_TYPE_FROM_INSTANCE (g_io_stream_get_output_stream (data
->worker
->stream
))));
2165 _g_dbus_debug_print_unlock ();
2170 /* ---------------------------------------------------------------------------------------------------- */
2173 read_message_print_transport_debug (gssize bytes_read
,
2174 GDBusWorker
*worker
)
2178 gint32 message_length
;
2180 if (G_LIKELY (!_g_dbus_debug_transport ()))
2183 size
= bytes_read
+ worker
->read_buffer_cur_size
;
2187 message_length
= g_dbus_message_bytes_needed ((guchar
*) worker
->read_buffer
, size
, NULL
);
2190 switch (worker
->read_buffer
[0])
2194 serial
= GUINT32_FROM_LE (((guint32
*) worker
->read_buffer
)[2]);
2198 serial
= GUINT32_FROM_BE (((guint32
*) worker
->read_buffer
)[2]);
2201 /* an error will be set elsewhere if this happens */
2206 _g_dbus_debug_print_lock ();
2207 g_print ("========================================================================\n"
2208 "GDBus-debug:Transport:\n"
2209 " <<<< READ %" G_GSSIZE_FORMAT
" bytes of message with serial %d and\n"
2210 " size %d to offset %" G_GSIZE_FORMAT
" from a %s\n",
2214 worker
->read_buffer_cur_size
,
2215 g_type_name (G_TYPE_FROM_INSTANCE (g_io_stream_get_input_stream (worker
->stream
))));
2216 _g_dbus_debug_print_unlock ();
2221 /* ---------------------------------------------------------------------------------------------------- */
2224 _g_signal_accumulator_false_handled (GSignalInvocationHint
*ihint
,
2225 GValue
*return_accu
,
2226 const GValue
*handler_return
,
2229 gboolean continue_emission
;
2230 gboolean signal_return
;
2232 signal_return
= g_value_get_boolean (handler_return
);
2233 g_value_set_boolean (return_accu
, signal_return
);
2234 continue_emission
= signal_return
;
2236 return continue_emission
;