1 /* GLIB - Library of useful routines for C programming
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * gmain.c: Main loop abstraction, timeouts, and idle functions
5 * Copyright 1998 Owen Taylor
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
22 * Modified by the GLib Team and others 1997-2000. See the AUTHORS
23 * file for a list of people on the GLib Team. See the ChangeLog
24 * files for a list of changes. These files are distributed with
25 * GLib at ftp://ftp.gtk.org/pub/gtk/.
33 #include "glibconfig.h"
35 /* Uncomment the next line (and the corresponding line in gpoll.c) to
36 * enable debugging printouts if the environment variable
37 * G_MAIN_POLL_DEBUG is set to some value.
39 /* #define G_MAIN_POLL_DEBUG */
42 /* Always enable debugging printout on Windows, as it is more often
45 #define G_MAIN_POLL_DEBUG
49 #include "glib-unix.h"
52 #include <sys/eventfd.h>
57 #include <sys/types.h>
60 #ifdef HAVE_SYS_TIME_H
62 #endif /* HAVE_SYS_TIME_H */
65 #endif /* G_OS_UNIX */
72 #endif /* G_OS_WIN32 */
74 #ifdef HAVE_MACH_MACH_TIME_H
75 #include <mach/mach_time.h>
78 #include "glib_trace.h"
83 #include "giochannel.h"
87 #include "gstrfuncs.h"
88 #include "gtestutils.h"
94 #ifdef G_MAIN_POLL_DEBUG
99 #include "gmain-internal.h"
100 #include "glib-init.h"
101 #include "glib-private.h"
105 * @title: The Main Event Loop
106 * @short_description: manages all available sources of events
108 * The main event loop manages all the available sources of events for
109 * GLib and GTK+ applications. These events can come from any number of
110 * different types of sources such as file descriptors (plain files,
111 * pipes or sockets) and timeouts. New types of event sources can also
112 * be added using g_source_attach().
114 * To allow multiple independent sets of sources to be handled in
115 * different threads, each source is associated with a #GMainContext.
116 * A GMainContext can only be running in a single thread, but
117 * sources can be added to it and removed from it from other threads.
119 * Each event source is assigned a priority. The default priority,
120 * #G_PRIORITY_DEFAULT, is 0. Values less than 0 denote higher priorities.
121 * Values greater than 0 denote lower priorities. Events from high priority
122 * sources are always processed before events from lower priority sources.
124 * Idle functions can also be added, and assigned a priority. These will
125 * be run whenever no events with a higher priority are ready to be processed.
127 * The #GMainLoop data type represents a main event loop. A GMainLoop is
128 * created with g_main_loop_new(). After adding the initial event sources,
129 * g_main_loop_run() is called. This continuously checks for new events from
130 * each of the event sources and dispatches them. Finally, the processing of
131 * an event from one of the sources leads to a call to g_main_loop_quit() to
132 * exit the main loop, and g_main_loop_run() returns.
134 * It is possible to create new instances of #GMainLoop recursively.
135 * This is often used in GTK+ applications when showing modal dialog
136 * boxes. Note that event sources are associated with a particular
137 * #GMainContext, and will be checked and dispatched for all main
138 * loops associated with that GMainContext.
140 * GTK+ contains wrappers of some of these functions, e.g. gtk_main(),
141 * gtk_main_quit() and gtk_events_pending().
143 * ## Creating new source types
145 * One of the unusual features of the #GMainLoop functionality
146 * is that new types of event source can be created and used in
147 * addition to the builtin type of event source. A new event source
148 * type is used for handling GDK events. A new source type is created
149 * by "deriving" from the #GSource structure. The derived type of
150 * source is represented by a structure that has the #GSource structure
151 * as a first element, and other elements specific to the new source
152 * type. To create an instance of the new source type, call
153 * g_source_new() passing in the size of the derived structure and
154 * a table of functions. These #GSourceFuncs determine the behavior of
155 * the new source type.
157 * New source types basically interact with the main context
158 * in two ways. Their prepare function in #GSourceFuncs can set a timeout
159 * to determine the maximum amount of time that the main loop will sleep
160 * before checking the source again. In addition, or as well, the source
161 * can add file descriptors to the set that the main context checks using
162 * g_source_add_poll().
164 * ## Customizing the main loop iteration
166 * Single iterations of a #GMainContext can be run with
167 * g_main_context_iteration(). In some cases, more detailed control
168 * of exactly how the details of the main loop work is desired, for
169 * instance, when integrating the #GMainLoop with an external main loop.
170 * In such cases, you can call the component functions of
171 * g_main_context_iteration() directly. These functions are
172 * g_main_context_prepare(), g_main_context_query(),
173 * g_main_context_check() and g_main_context_dispatch().
175 * ## State of a Main Context # {#mainloop-states}
177 * The operation of these functions can best be seen in terms
178 * of a state diagram, as shown in this image.
180 * ![](mainloop-states.gif)
182 * On UNIX, the GLib mainloop is incompatible with fork(). Any program
183 * using the mainloop must either exec() or exit() from the child
184 * without returning to the mainloop.
189 typedef struct _GTimeoutSource GTimeoutSource;
190 typedef struct _GChildWatchSource GChildWatchSource;
191 typedef struct _GUnixSignalWatchSource GUnixSignalWatchSource;
192 typedef struct _GPollRec GPollRec;
193 typedef struct _GSourceCallback GSourceCallback;
197 G_SOURCE_READY = 1 << G_HOOK_FLAG_USER_SHIFT,
198 G_SOURCE_CAN_RECURSE = 1 << (G_HOOK_FLAG_USER_SHIFT + 1),
199 G_SOURCE_BLOCKED = 1 << (G_HOOK_FLAG_USER_SHIFT + 2)
202 typedef struct _GSourceList GSourceList;
206 GSource *head, *tail;
210 typedef struct _GMainWaiter GMainWaiter;
218 typedef struct _GMainDispatch GMainDispatch;
220 struct _GMainDispatch
226 #ifdef G_MAIN_POLL_DEBUG
227 gboolean _g_main_poll_debug = FALSE;
232 /* The following lock is used for both the list of sources
233 * and the list of poll records
243 GHashTable *sources; /* guint -> GSource */
245 GPtrArray *pending_dispatches;
246 gint timeout; /* Timeout for current iteration */
250 gint in_check_or_prepare;
252 GPollRec *poll_records, *poll_records_tail;
253 guint n_poll_records;
254 GPollFD *cached_poll_array;
255 guint cached_poll_array_size;
261 /* Flag indicating whether the set of fd's changed during a poll */
262 gboolean poll_changed;
267 gboolean time_is_fresh;
270 struct _GSourceCallback
275 GDestroyNotify notify;
280 GMainContext *context;
285 struct _GTimeoutSource
292 struct _GChildWatchSource
299 #else /* G_OS_WIN32 */
300 gboolean child_exited;
301 #endif /* G_OS_WIN32 */
304 struct _GUnixSignalWatchSource
319 struct _GSourcePrivate
321 GSList *child_sources;
322 GSource *parent_source;
326 /* This is currently only used on UNIX, but we always declare it (and
327 * let it remain empty on Windows) to avoid #ifdef all over the place.
332 typedef struct _GSourceIter
334 GMainContext *context;
340 #define LOCK_CONTEXT(context) g_mutex_lock (&context->mutex)
341 #define UNLOCK_CONTEXT(context) g_mutex_unlock (&context->mutex)
342 #define G_THREAD_SELF g_thread_self ()
344 #define SOURCE_DESTROYED(source) (((source)->flags & G_HOOK_FLAG_ACTIVE) == 0)
345 #define SOURCE_BLOCKED(source) (((source)->flags & G_SOURCE_BLOCKED) != 0)
347 #define SOURCE_UNREF(source, context) \
349 if ((source)->ref_count > 1) \
350 (source)->ref_count--; \
352 g_source_unref_internal ((source), (context), TRUE); \
356 /* Forward declarations */
358 static void g_source_unref_internal (GSource *source,
359 GMainContext *context,
361 static void g_source_destroy_internal (GSource *source,
362 GMainContext *context,
364 static void g_source_set_priority_unlocked (GSource *source,
365 GMainContext *context,
367 static void g_child_source_remove_internal (GSource *child_source,
368 GMainContext *context);
370 static void g_main_context_poll (GMainContext *context,
375 static void g_main_context_add_poll_unlocked (GMainContext *context,
378 static void g_main_context_remove_poll_unlocked (GMainContext *context,
381 static void g_source_iter_init (GSourceIter *iter,
382 GMainContext *context,
383 gboolean may_modify);
384 static gboolean g_source_iter_next (GSourceIter *iter,
386 static void g_source_iter_clear (GSourceIter *iter);
388 static gboolean g_timeout_dispatch (GSource *source,
389 GSourceFunc callback,
391 static gboolean g_child_watch_prepare (GSource *source,
393 static gboolean g_child_watch_check (GSource *source);
394 static gboolean g_child_watch_dispatch (GSource *source,
395 GSourceFunc callback,
397 static void g_child_watch_finalize (GSource *source);
399 static void g_unix_signal_handler (int signum);
400 static gboolean g_unix_signal_watch_prepare (GSource *source,
402 static gboolean g_unix_signal_watch_check (GSource *source);
403 static gboolean g_unix_signal_watch_dispatch (GSource *source,
404 GSourceFunc callback,
406 static void g_unix_signal_watch_finalize (GSource *source);
408 static gboolean g_idle_prepare (GSource *source,
410 static gboolean g_idle_check (GSource *source);
411 static gboolean g_idle_dispatch (GSource *source,
412 GSourceFunc callback,
415 static void block_source (GSource *source);
417 static GMainContext *glib_worker_context;
419 G_LOCK_DEFINE_STATIC (main_loop);
420 static GMainContext *default_main_context;
425 /* UNIX signals work by marking one of these variables then waking the
426 * worker context to check on them and dispatch accordingly.
428 #ifdef HAVE_SIG_ATOMIC_T
429 static volatile sig_atomic_t unix_signal_pending[NSIG];
430 static volatile sig_atomic_t any_unix_signal_pending;
432 static volatile int unix_signal_pending[NSIG];
433 static volatile int any_unix_signal_pending;
435 static volatile guint unix_signal_refcount[NSIG];
437 /* Guards all the data below */
438 G_LOCK_DEFINE_STATIC (unix_signal_lock);
439 static GSList *unix_signal_watches;
440 static GSList *unix_child_watches;
442 GSourceFuncs g_unix_signal_funcs =
444 g_unix_signal_watch_prepare,
445 g_unix_signal_watch_check,
446 g_unix_signal_watch_dispatch,
447 g_unix_signal_watch_finalize
449 #endif /* !G_OS_WIN32 */
450 G_LOCK_DEFINE_STATIC (main_context_list);
451 static GSList *main_context_list = NULL;
453 GSourceFuncs g_timeout_funcs =
461 GSourceFuncs g_child_watch_funcs =
463 g_child_watch_prepare,
465 g_child_watch_dispatch,
466 g_child_watch_finalize
469 GSourceFuncs g_idle_funcs =
478 * g_main_context_ref:
479 * @context: a #GMainContext
481 * Increases the reference count on a #GMainContext object by one.
483 * Returns: the @context that was passed in (since 2.6)
486 g_main_context_ref (GMainContext *context)
488 g_return_val_if_fail (context != NULL, NULL);
489 g_return_val_if_fail (g_atomic_int_get (&context->ref_count) > 0, NULL);
491 g_atomic_int_inc (&context->ref_count);
497 poll_rec_list_free (GMainContext *context,
500 g_slice_free_chain (GPollRec, list, next);
504 * g_main_context_unref:
505 * @context: a #GMainContext
507 * Decreases the reference count on a #GMainContext object by one. If
508 * the result is zero, free the context and free all associated memory.
511 g_main_context_unref (GMainContext *context)
519 g_return_if_fail (context != NULL);
520 g_return_if_fail (g_atomic_int_get (&context->ref_count) > 0);
522 if (!g_atomic_int_dec_and_test (&context->ref_count))
525 G_LOCK (main_context_list);
526 main_context_list = g_slist_remove (main_context_list, context);
527 G_UNLOCK (main_context_list);
529 /* Free pending dispatches */
530 for (i = 0; i < context->pending_dispatches->len; i++)
531 g_source_unref_internal (context->pending_dispatches->pdata[i], context, FALSE);
533 /* g_source_iter_next() assumes the context is locked. */
534 LOCK_CONTEXT (context);
535 g_source_iter_init (&iter, context, TRUE);
536 while (g_source_iter_next (&iter, &source))
538 source->context = NULL;
539 g_source_destroy_internal (source, context, TRUE);
541 UNLOCK_CONTEXT (context);
543 for (sl_iter = context->source_lists; sl_iter; sl_iter = sl_iter->next)
545 list = sl_iter->data;
546 g_slice_free (GSourceList, list);
548 g_list_free (context->source_lists);
550 g_hash_table_destroy (context->sources);
552 g_mutex_clear (&context->mutex);
554 g_ptr_array_free (context->pending_dispatches, TRUE);
555 g_free (context->cached_poll_array);
557 poll_rec_list_free (context, context->poll_records);
559 g_wakeup_free (context->wakeup);
560 g_cond_clear (&context->cond);
565 /* Helper function used by mainloop/overflow test.
568 g_main_context_new_with_next_id (guint next_id)
570 GMainContext *ret = g_main_context_new ();
572 ret->next_id = next_id;
578 * g_main_context_new:
580 * Creates a new #GMainContext structure.
582 * Returns: the new #GMainContext
585 g_main_context_new (void)
587 static gsize initialised;
588 GMainContext *context;
590 if (g_once_init_enter (&initialised))
592 #ifdef G_MAIN_POLL_DEBUG
593 if (getenv ("G_MAIN_POLL_DEBUG") != NULL)
594 _g_main_poll_debug = TRUE;
597 g_once_init_leave (&initialised, TRUE);
600 context = g_new0 (GMainContext, 1);
602 g_mutex_init (&context->mutex);
603 g_cond_init (&context->cond);
605 context->sources = g_hash_table_new (NULL, NULL);
606 context->owner = NULL;
607 context->waiters = NULL;
609 context->ref_count = 1;
611 context->next_id = 1;
613 context->source_lists = NULL;
615 context->poll_func = g_poll;
617 context->cached_poll_array = NULL;
618 context->cached_poll_array_size = 0;
620 context->pending_dispatches = g_ptr_array_new ();
622 context->time_is_fresh = FALSE;
624 context->wakeup = g_wakeup_new ();
625 g_wakeup_get_pollfd (context->wakeup, &context->wake_up_rec);
626 g_main_context_add_poll_unlocked (context, 0, &context->wake_up_rec);
628 G_LOCK (main_context_list);
629 main_context_list = g_slist_append (main_context_list, context);
631 #ifdef G_MAIN_POLL_DEBUG
632 if (_g_main_poll_debug)
633 g_print ("created context=%p\n", context);
636 G_UNLOCK (main_context_list);
642 * g_main_context_default:
644 * Returns the global default main context. This is the main context
645 * used for main loop functions when a main loop is not explicitly
646 * specified, and corresponds to the "main" main loop. See also
647 * g_main_context_get_thread_default().
649 * Returns: (transfer none): the global default main context.
652 g_main_context_default (void)
658 if (!default_main_context)
660 default_main_context = g_main_context_new ();
661 #ifdef G_MAIN_POLL_DEBUG
662 if (_g_main_poll_debug)
663 g_print ("default context=%p\n", default_main_context);
667 G_UNLOCK (main_loop);
669 return default_main_context;
673 free_context (gpointer data)
675 GMainContext *context = data;
677 g_main_context_release (context);
679 g_main_context_unref (context);
683 free_context_stack (gpointer data)
685 g_queue_free_full((GQueue *) data, (GDestroyNotify) free_context);
688 static GPrivate thread_context_stack = G_PRIVATE_INIT (free_context_stack);
691 * g_main_context_push_thread_default:
692 * @context: (allow-none): a #GMainContext, or %NULL for the global default context
694 * Acquires @context and sets it as the thread-default context for the
695 * current thread. This will cause certain asynchronous operations
696 * (such as most [gio][gio]-based I/O) which are
697 * started in this thread to run under @context and deliver their
698 * results to its main loop, rather than running under the global
699 * default context in the main thread. Note that calling this function
700 * changes the context returned by g_main_context_get_thread_default(),
701 * not the one returned by g_main_context_default(), so it does not affect
702 * the context used by functions like g_idle_add().
704 * Normally you would call this function shortly after creating a new
705 * thread, passing it a #GMainContext which will be run by a
706 * #GMainLoop in that thread, to set a new default context for all
707 * async operations in that thread. (In this case, you don't need to
708 * ever call g_main_context_pop_thread_default().) In some cases
709 * however, you may want to schedule a single operation in a
710 * non-default context, or temporarily use a non-default context in
711 * the main thread. In that case, you can wrap the call to the
712 * asynchronous operation inside a
713 * g_main_context_push_thread_default() /
714 * g_main_context_pop_thread_default() pair, but it is up to you to
715 * ensure that no other asynchronous operations accidentally get
716 * started while the non-default context is active.
718 * Beware that libraries that predate this function may not correctly
719 * handle being used from a thread with a thread-default context. Eg,
720 * see g_file_supports_thread_contexts().
725 g_main_context_push_thread_default (GMainContext *context)
728 gboolean acquired_context;
730 acquired_context = g_main_context_acquire (context);
731 g_return_if_fail (acquired_context);
733 if (context == g_main_context_default ())
736 g_main_context_ref (context);
738 stack = g_private_get (&thread_context_stack);
741 stack = g_queue_new ();
742 g_private_set (&thread_context_stack, stack);
745 g_queue_push_head (stack, context);
749 * g_main_context_pop_thread_default:
750 * @context: (allow-none): a #GMainContext object, or %NULL
752 * Pops @context off the thread-default context stack (verifying that
753 * it was on the top of the stack).
758 g_main_context_pop_thread_default (GMainContext *context)
762 if (context == g_main_context_default ())
765 stack = g_private_get (&thread_context_stack);
767 g_return_if_fail (stack != NULL);
768 g_return_if_fail (g_queue_peek_head (stack) == context);
770 g_queue_pop_head (stack);
772 g_main_context_release (context);
774 g_main_context_unref (context);
778 * g_main_context_get_thread_default:
780 * Gets the thread-default #GMainContext for this thread. Asynchronous
781 * operations that want to be able to be run in contexts other than
782 * the default one should call this method or
783 * g_main_context_ref_thread_default() to get a #GMainContext to add
784 * their #GSources to. (Note that even in single-threaded
785 * programs applications may sometimes want to temporarily push a
786 * non-default context, so it is not safe to assume that this will
787 * always return %NULL if you are running in the default thread.)
789 * If you need to hold a reference on the context, use
790 * g_main_context_ref_thread_default() instead.
792 * Returns: (transfer none): the thread-default #GMainContext, or
793 * %NULL if the thread-default context is the global default context.
798 g_main_context_get_thread_default (void)
802 stack = g_private_get (&thread_context_stack);
804 return g_queue_peek_head (stack);
810 * g_main_context_ref_thread_default:
812 * Gets the thread-default #GMainContext for this thread, as with
813 * g_main_context_get_thread_default(), but also adds a reference to
814 * it with g_main_context_ref(). In addition, unlike
815 * g_main_context_get_thread_default(), if the thread-default context
816 * is the global default context, this will return that #GMainContext
817 * (with a ref added to it) rather than returning %NULL.
819 * Returns: (transfer full): the thread-default #GMainContext. Unref
820 * with g_main_context_unref() when you are done with it.
825 g_main_context_ref_thread_default (void)
827 GMainContext *context;
829 context = g_main_context_get_thread_default ();
831 context = g_main_context_default ();
832 return g_main_context_ref (context);
835 /* Hooks for adding to the main loop */
839 * @source_funcs: structure containing functions that implement
840 * the sources behavior.
841 * @struct_size: size of the #GSource structure to create.
843 * Creates a new #GSource structure. The size is specified to
844 * allow creating structures derived from #GSource that contain
845 * additional data. The size passed in must be at least
846 * `sizeof (GSource)`.
848 * The source will not initially be associated with any #GMainContext
849 * and must be added to one with g_source_attach() before it will be
852 * Returns: the newly-created #GSource.
855 g_source_new (GSourceFuncs *source_funcs,
860 g_return_val_if_fail (source_funcs != NULL, NULL);
861 g_return_val_if_fail (struct_size >= sizeof (GSource), NULL);
863 source = (GSource*) g_malloc0 (struct_size);
864 source->priv = g_slice_new0 (GSourcePrivate);
865 source->source_funcs = source_funcs;
866 source->ref_count = 1;
868 source->priority = G_PRIORITY_DEFAULT;
870 source->flags = G_HOOK_FLAG_ACTIVE;
872 source->priv->ready_time = -1;
874 /* NULL/0 initialization for all other fields */
879 /* Holds context's lock */
881 g_source_iter_init (GSourceIter *iter,
882 GMainContext *context,
885 iter->context = context;
886 iter->current_list = NULL;
888 iter->may_modify = may_modify;
891 /* Holds context's lock */
893 g_source_iter_next (GSourceIter *iter, GSource **source)
895 GSource *next_source;
898 next_source = iter->source->next;
904 if (iter->current_list)
905 iter->current_list = iter->current_list->next;
907 iter->current_list = iter->context->source_lists;
909 if (iter->current_list)
911 GSourceList *source_list = iter->current_list->data;
913 next_source = source_list->head;
917 /* Note: unreffing iter->source could potentially cause its
918 * GSourceList to be removed from source_lists (if iter->source is
919 * the only source in its list, and it is destroyed), so we have to
920 * keep it reffed until after we advance iter->current_list, above.
923 if (iter->source && iter->may_modify)
924 SOURCE_UNREF (iter->source, iter->context);
925 iter->source = next_source;
926 if (iter->source && iter->may_modify)
927 iter->source->ref_count++;
929 *source = iter->source;
930 return *source != NULL;
933 /* Holds context's lock. Only necessary to call if you broke out of
934 * the g_source_iter_next() loop early.
937 g_source_iter_clear (GSourceIter *iter)
939 if (iter->source && iter->may_modify)
941 SOURCE_UNREF (iter->source, iter->context);
946 /* Holds context's lock
949 find_source_list_for_priority (GMainContext *context,
954 GSourceList *source_list;
957 for (iter = context->source_lists; iter != NULL; last = iter, iter = iter->next)
959 source_list = iter->data;
961 if (source_list->priority == priority)
964 if (source_list->priority > priority)
969 source_list = g_slice_new0 (GSourceList);
970 source_list->priority = priority;
971 context->source_lists = g_list_insert_before (context->source_lists,
981 source_list = g_slice_new0 (GSourceList);
982 source_list->priority = priority;
985 context->source_lists = g_list_append (NULL, source_list);
988 /* This just appends source_list to the end of
989 * context->source_lists without having to walk the list again.
991 last = g_list_append (last, source_list);
996 /* Holds context's lock
999 source_add_to_context (GSource *source,
1000 GMainContext *context)
1002 GSourceList *source_list;
1003 GSource *prev, *next;
1005 source_list = find_source_list_for_priority (context, source->priority, TRUE);
1007 if (source->priv->parent_source)
1009 g_assert (source_list->head != NULL);
1011 /* Put the source immediately before its parent */
1012 prev = source->priv->parent_source->prev;
1013 next = source->priv->parent_source;
1017 prev = source_list->tail;
1021 source->next = next;
1023 next->prev = source;
1025 source_list->tail = source;
1027 source->prev = prev;
1029 prev->next = source;
1031 source_list->head = source;
1034 /* Holds context's lock
1037 source_remove_from_context (GSource *source,
1038 GMainContext *context)
1040 GSourceList *source_list;
1042 source_list = find_source_list_for_priority (context, source->priority, FALSE);
1043 g_return_if_fail (source_list != NULL);
1046 source->prev->next = source->next;
1048 source_list->head = source->next;
1051 source->next->prev = source->prev;
1053 source_list->tail = source->prev;
1055 source->prev = NULL;
1056 source->next = NULL;
1058 if (source_list->head == NULL)
1060 context->source_lists = g_list_remove (context->source_lists, source_list);
1061 g_slice_free (GSourceList, source_list);
1066 g_source_attach_unlocked (GSource *source,
1067 GMainContext *context,
1073 /* The counter may have wrapped, so we must ensure that we do not
1074 * reuse the source id of an existing source.
1077 id = context->next_id++;
1078 while (id == 0 || g_hash_table_contains (context->sources, GUINT_TO_POINTER (id)));
1080 source->context = context;
1081 source->source_id = id;
1082 source->ref_count++;
1084 g_hash_table_insert (context->sources, GUINT_TO_POINTER (id), source);
1086 source_add_to_context (source, context);
1088 if (!SOURCE_BLOCKED (source))
1090 tmp_list = source->poll_fds;
1093 g_main_context_add_poll_unlocked (context, source->priority, tmp_list->data);
1094 tmp_list = tmp_list->next;
1097 for (tmp_list = source->priv->fds; tmp_list; tmp_list = tmp_list->next)
1098 g_main_context_add_poll_unlocked (context, source->priority, tmp_list->data);
1101 tmp_list = source->priv->child_sources;
1104 g_source_attach_unlocked (tmp_list->data, context, FALSE);
1105 tmp_list = tmp_list->next;
1108 /* If another thread has acquired the context, wake it up since it
1109 * might be in poll() right now.
1111 if (do_wakeup && context->owner && context->owner != G_THREAD_SELF)
1112 g_wakeup_signal (context->wakeup);
1114 return source->source_id;
1119 * @source: a #GSource
1120 * @context: (allow-none): a #GMainContext (if %NULL, the default context will be used)
1122 * Adds a #GSource to a @context so that it will be executed within
1123 * that context. Remove it by calling g_source_destroy().
1125 * Returns: the ID (greater than 0) for the source within the
1129 g_source_attach (GSource *source,
1130 GMainContext *context)
1134 g_return_val_if_fail (source->context == NULL, 0);
1135 g_return_val_if_fail (!SOURCE_DESTROYED (source), 0);
1137 TRACE (GLIB_MAIN_SOURCE_ATTACH (g_source_get_name (source)));
1140 context = g_main_context_default ();
1142 LOCK_CONTEXT (context);
1144 result = g_source_attach_unlocked (source, context, TRUE);
1146 UNLOCK_CONTEXT (context);
1152 g_source_destroy_internal (GSource *source,
1153 GMainContext *context,
1156 TRACE (GLIB_MAIN_SOURCE_DESTROY (g_source_get_name (source)));
1159 LOCK_CONTEXT (context);
1161 if (!SOURCE_DESTROYED (source))
1164 gpointer old_cb_data;
1165 GSourceCallbackFuncs *old_cb_funcs;
1167 source->flags &= ~G_HOOK_FLAG_ACTIVE;
1169 old_cb_data = source->callback_data;
1170 old_cb_funcs = source->callback_funcs;
1172 source->callback_data = NULL;
1173 source->callback_funcs = NULL;
1177 UNLOCK_CONTEXT (context);
1178 old_cb_funcs->unref (old_cb_data);
1179 LOCK_CONTEXT (context);
1182 if (!SOURCE_BLOCKED (source))
1184 tmp_list = source->poll_fds;
1187 g_main_context_remove_poll_unlocked (context, tmp_list->data);
1188 tmp_list = tmp_list->next;
1191 for (tmp_list = source->priv->fds; tmp_list; tmp_list = tmp_list->next)
1192 g_main_context_remove_poll_unlocked (context, tmp_list->data);
1195 while (source->priv->child_sources)
1196 g_child_source_remove_internal (source->priv->child_sources->data, context);
1198 if (source->priv->parent_source)
1199 g_child_source_remove_internal (source, context);
1201 g_source_unref_internal (source, context, TRUE);
1205 UNLOCK_CONTEXT (context);
1210 * @source: a #GSource
1212 * Removes a source from its #GMainContext, if any, and mark it as
1213 * destroyed. The source cannot be subsequently added to another
1214 * context. It is safe to call this on sources which have already been
1215 * removed from their context.
1218 g_source_destroy (GSource *source)
1220 GMainContext *context;
1222 g_return_if_fail (source != NULL);
1224 context = source->context;
1227 g_source_destroy_internal (source, context, FALSE);
1229 source->flags &= ~G_HOOK_FLAG_ACTIVE;
1234 * @source: a #GSource
1236 * Returns the numeric ID for a particular source. The ID of a source
1237 * is a positive integer which is unique within a particular main loop
1238 * context. The reverse
1239 * mapping from ID to source is done by g_main_context_find_source_by_id().
1241 * Returns: the ID (greater than 0) for the source
1244 g_source_get_id (GSource *source)
1248 g_return_val_if_fail (source != NULL, 0);
1249 g_return_val_if_fail (source->context != NULL, 0);
1251 LOCK_CONTEXT (source->context);
1252 result = source->source_id;
1253 UNLOCK_CONTEXT (source->context);
1259 * g_source_get_context:
1260 * @source: a #GSource
1262 * Gets the #GMainContext with which the source is associated.
1264 * You can call this on a source that has been destroyed, provided
1265 * that the #GMainContext it was attached to still exists (in which
1266 * case it will return that #GMainContext). In particular, you can
1267 * always call this function on the source returned from
1268 * g_main_current_source(). But calling this function on a source
1269 * whose #GMainContext has been destroyed is an error.
1271 * Returns: (transfer none) (allow-none): the #GMainContext with which the
1272 * source is associated, or %NULL if the context has not
1273 * yet been added to a source.
1276 g_source_get_context (GSource *source)
1278 g_return_val_if_fail (source->context != NULL || !SOURCE_DESTROYED (source), NULL);
1280 return source->context;
1284 * g_source_add_poll:
1285 * @source:a #GSource
1286 * @fd: a #GPollFD structure holding information about a file
1287 * descriptor to watch.
1289 * Adds a file descriptor to the set of file descriptors polled for
1290 * this source. This is usually combined with g_source_new() to add an
1291 * event source. The event source's check function will typically test
1292 * the @revents field in the #GPollFD struct and return %TRUE if events need
1295 * This API is only intended to be used by implementations of #GSource.
1296 * Do not call this API on a #GSource that you did not create.
1298 * Using this API forces the linear scanning of event sources on each
1299 * main loop iteration. Newly-written event sources should try to use
1300 * g_source_add_unix_fd() instead of this API.
1303 g_source_add_poll (GSource *source,
1306 GMainContext *context;
1308 g_return_if_fail (source != NULL);
1309 g_return_if_fail (fd != NULL);
1310 g_return_if_fail (!SOURCE_DESTROYED (source));
1312 context = source->context;
1315 LOCK_CONTEXT (context);
1317 source->poll_fds = g_slist_prepend (source->poll_fds, fd);
1321 if (!SOURCE_BLOCKED (source))
1322 g_main_context_add_poll_unlocked (context, source->priority, fd);
1323 UNLOCK_CONTEXT (context);
1328 * g_source_remove_poll:
1329 * @source:a #GSource
1330 * @fd: a #GPollFD structure previously passed to g_source_add_poll().
1332 * Removes a file descriptor from the set of file descriptors polled for
1335 * This API is only intended to be used by implementations of #GSource.
1336 * Do not call this API on a #GSource that you did not create.
1339 g_source_remove_poll (GSource *source,
1342 GMainContext *context;
1344 g_return_if_fail (source != NULL);
1345 g_return_if_fail (fd != NULL);
1346 g_return_if_fail (!SOURCE_DESTROYED (source));
1348 context = source->context;
1351 LOCK_CONTEXT (context);
1353 source->poll_fds = g_slist_remove (source->poll_fds, fd);
1357 if (!SOURCE_BLOCKED (source))
1358 g_main_context_remove_poll_unlocked (context, fd);
1359 UNLOCK_CONTEXT (context);
1364 * g_source_add_child_source:
1365 * @source:a #GSource
1366 * @child_source: a second #GSource that @source should "poll"
1368 * Adds @child_source to @source as a "polled" source; when @source is
1369 * added to a #GMainContext, @child_source will be automatically added
1370 * with the same priority, when @child_source is triggered, it will
1371 * cause @source to dispatch (in addition to calling its own
1372 * callback), and when @source is destroyed, it will destroy
1373 * @child_source as well. (@source will also still be dispatched if
1374 * its own prepare/check functions indicate that it is ready.)
1376 * If you don't need @child_source to do anything on its own when it
1377 * triggers, you can call g_source_set_dummy_callback() on it to set a
1378 * callback that does nothing (except return %TRUE if appropriate).
1380 * @source will hold a reference on @child_source while @child_source
1381 * is attached to it.
1383 * This API is only intended to be used by implementations of #GSource.
1384 * Do not call this API on a #GSource that you did not create.
1389 g_source_add_child_source (GSource *source,
1390 GSource *child_source)
1392 GMainContext *context;
1394 g_return_if_fail (source != NULL);
1395 g_return_if_fail (child_source != NULL);
1396 g_return_if_fail (!SOURCE_DESTROYED (source));
1397 g_return_if_fail (!SOURCE_DESTROYED (child_source));
1398 g_return_if_fail (child_source->context == NULL);
1399 g_return_if_fail (child_source->priv->parent_source == NULL);
1401 context = source->context;
1404 LOCK_CONTEXT (context);
1406 source->priv->child_sources = g_slist_prepend (source->priv->child_sources,
1407 g_source_ref (child_source));
1408 child_source->priv->parent_source = source;
1409 g_source_set_priority_unlocked (child_source, NULL, source->priority);
1410 if (SOURCE_BLOCKED (source))
1411 block_source (child_source);
1415 g_source_attach_unlocked (child_source, context, TRUE);
1416 UNLOCK_CONTEXT (context);
1421 g_child_source_remove_internal (GSource *child_source,
1422 GMainContext *context)
1424 GSource *parent_source = child_source->priv->parent_source;
1426 parent_source->priv->child_sources =
1427 g_slist_remove (parent_source->priv->child_sources, child_source);
1428 child_source->priv->parent_source = NULL;
1430 g_source_destroy_internal (child_source, context, TRUE);
1431 g_source_unref_internal (child_source, context, TRUE);
1435 * g_source_remove_child_source:
1436 * @source:a #GSource
1437 * @child_source: a #GSource previously passed to
1438 * g_source_add_child_source().
1440 * Detaches @child_source from @source and destroys it.
1442 * This API is only intended to be used by implementations of #GSource.
1443 * Do not call this API on a #GSource that you did not create.
1448 g_source_remove_child_source (GSource *source,
1449 GSource *child_source)
1451 GMainContext *context;
1453 g_return_if_fail (source != NULL);
1454 g_return_if_fail (child_source != NULL);
1455 g_return_if_fail (child_source->priv->parent_source == source);
1456 g_return_if_fail (!SOURCE_DESTROYED (source));
1457 g_return_if_fail (!SOURCE_DESTROYED (child_source));
1459 context = source->context;
1462 LOCK_CONTEXT (context);
1464 g_child_source_remove_internal (child_source, context);
1467 UNLOCK_CONTEXT (context);
1471 * g_source_set_callback_indirect:
1472 * @source: the source
1473 * @callback_data: pointer to callback data "object"
1474 * @callback_funcs: functions for reference counting @callback_data
1475 * and getting the callback and data
1477 * Sets the callback function storing the data as a refcounted callback
1478 * "object". This is used internally. Note that calling
1479 * g_source_set_callback_indirect() assumes
1480 * an initial reference count on @callback_data, and thus
1481 * @callback_funcs->unref will eventually be called once more
1482 * than @callback_funcs->ref.
1485 g_source_set_callback_indirect (GSource *source,
1486 gpointer callback_data,
1487 GSourceCallbackFuncs *callback_funcs)
1489 GMainContext *context;
1490 gpointer old_cb_data;
1491 GSourceCallbackFuncs *old_cb_funcs;
1493 g_return_if_fail (source != NULL);
1494 g_return_if_fail (callback_funcs != NULL || callback_data == NULL);
1496 context = source->context;
1499 LOCK_CONTEXT (context);
1501 old_cb_data = source->callback_data;
1502 old_cb_funcs = source->callback_funcs;
1504 source->callback_data = callback_data;
1505 source->callback_funcs = callback_funcs;
1508 UNLOCK_CONTEXT (context);
1511 old_cb_funcs->unref (old_cb_data);
1515 g_source_callback_ref (gpointer cb_data)
1517 GSourceCallback *callback = cb_data;
1519 callback->ref_count++;
1524 g_source_callback_unref (gpointer cb_data)
1526 GSourceCallback *callback = cb_data;
1528 callback->ref_count--;
1529 if (callback->ref_count == 0)
1531 if (callback->notify)
1532 callback->notify (callback->data);
1538 g_source_callback_get (gpointer cb_data,
1543 GSourceCallback *callback = cb_data;
1545 *func = callback->func;
1546 *data = callback->data;
1549 static GSourceCallbackFuncs g_source_callback_funcs = {
1550 g_source_callback_ref,
1551 g_source_callback_unref,
1552 g_source_callback_get,
1556 * g_source_set_callback:
1557 * @source: the source
1558 * @func: a callback function
1559 * @data: the data to pass to callback function
1560 * @notify: (allow-none): a function to call when @data is no longer in use, or %NULL.
1562 * Sets the callback function for a source. The callback for a source is
1563 * called from the source's dispatch function.
1565 * The exact type of @func depends on the type of source; ie. you
1566 * should not count on @func being called with @data as its first
1569 * Typically, you won't use this function. Instead use functions specific
1570 * to the type of source you are using.
1573 g_source_set_callback (GSource *source,
1576 GDestroyNotify notify)
1578 GSourceCallback *new_callback;
1580 g_return_if_fail (source != NULL);
1582 new_callback = g_new (GSourceCallback, 1);
1584 new_callback->ref_count = 1;
1585 new_callback->func = func;
1586 new_callback->data = data;
1587 new_callback->notify = notify;
1589 g_source_set_callback_indirect (source, new_callback, &g_source_callback_funcs);
1594 * g_source_set_funcs:
1595 * @source: a #GSource
1596 * @funcs: the new #GSourceFuncs
1598 * Sets the source functions (can be used to override
1599 * default implementations) of an unattached source.
1604 g_source_set_funcs (GSource *source,
1605 GSourceFuncs *funcs)
1607 g_return_if_fail (source != NULL);
1608 g_return_if_fail (source->context == NULL);
1609 g_return_if_fail (source->ref_count > 0);
1610 g_return_if_fail (funcs != NULL);
1612 source->source_funcs = funcs;
1616 g_source_set_priority_unlocked (GSource *source,
1617 GMainContext *context,
1622 g_return_if_fail (source->priv->parent_source == NULL ||
1623 source->priv->parent_source->priority == priority);
1627 /* Remove the source from the context's source and then
1628 * add it back after so it is sorted in the correct place
1630 source_remove_from_context (source, source->context);
1633 source->priority = priority;
1637 source_add_to_context (source, source->context);
1639 if (!SOURCE_BLOCKED (source))
1641 tmp_list = source->poll_fds;
1644 g_main_context_remove_poll_unlocked (context, tmp_list->data);
1645 g_main_context_add_poll_unlocked (context, priority, tmp_list->data);
1647 tmp_list = tmp_list->next;
1650 for (tmp_list = source->priv->fds; tmp_list; tmp_list = tmp_list->next)
1652 g_main_context_remove_poll_unlocked (context, tmp_list->data);
1653 g_main_context_add_poll_unlocked (context, priority, tmp_list->data);
1658 if (source->priv->child_sources)
1660 tmp_list = source->priv->child_sources;
1663 g_source_set_priority_unlocked (tmp_list->data, context, priority);
1664 tmp_list = tmp_list->next;
1670 * g_source_set_priority:
1671 * @source: a #GSource
1672 * @priority: the new priority.
1674 * Sets the priority of a source. While the main loop is being run, a
1675 * source will be dispatched if it is ready to be dispatched and no
1676 * sources at a higher (numerically smaller) priority are ready to be
1679 * A child source always has the same priority as its parent. It is not
1680 * permitted to change the priority of a source once it has been added
1681 * as a child of another source.
1684 g_source_set_priority (GSource *source,
1687 GMainContext *context;
1689 g_return_if_fail (source != NULL);
1690 g_return_if_fail (source->priv->parent_source == NULL);
1692 context = source->context;
1695 LOCK_CONTEXT (context);
1696 g_source_set_priority_unlocked (source, context, priority);
1698 UNLOCK_CONTEXT (source->context);
1702 * g_source_get_priority:
1703 * @source: a #GSource
1705 * Gets the priority of a source.
1707 * Returns: the priority of the source
1710 g_source_get_priority (GSource *source)
1712 g_return_val_if_fail (source != NULL, 0);
1714 return source->priority;
1718 * g_source_set_ready_time:
1719 * @source: a #GSource
1720 * @ready_time: the monotonic time at which the source will be ready,
1721 * 0 for "immediately", -1 for "never"
1723 * Sets a #GSource to be dispatched when the given monotonic time is
1724 * reached (or passed). If the monotonic time is in the past (as it
1725 * always will be if @ready_time is 0) then the source will be
1726 * dispatched immediately.
1728 * If @ready_time is -1 then the source is never woken up on the basis
1729 * of the passage of time.
1731 * Dispatching the source does not reset the ready time. You should do
1732 * so yourself, from the source dispatch function.
1734 * Note that if you have a pair of sources where the ready time of one
1735 * suggests that it will be delivered first but the priority for the
1736 * other suggests that it would be delivered first, and the ready time
1737 * for both sources is reached during the same main context iteration
1738 * then the order of dispatch is undefined.
1740 * This API is only intended to be used by implementations of #GSource.
1741 * Do not call this API on a #GSource that you did not create.
1746 g_source_set_ready_time (GSource *source,
1749 GMainContext *context;
1751 g_return_if_fail (source != NULL);
1752 g_return_if_fail (source->ref_count > 0);
1754 if (source->priv->ready_time == ready_time)
1757 context = source->context;
1760 LOCK_CONTEXT (context);
1762 source->priv->ready_time = ready_time;
1766 /* Quite likely that we need to change the timeout on the poll */
1767 if (!SOURCE_BLOCKED (source))
1768 g_wakeup_signal (context->wakeup);
1769 UNLOCK_CONTEXT (context);
1774 * g_source_get_ready_time:
1775 * @source: a #GSource
1777 * Gets the "ready time" of @source, as set by
1778 * g_source_set_ready_time().
1780 * Any time before the current monotonic time (including 0) is an
1781 * indication that the source will fire immediately.
1783 * Returns: the monotonic ready time, -1 for "never"
1786 g_source_get_ready_time (GSource *source)
1788 g_return_val_if_fail (source != NULL, -1);
1790 return source->priv->ready_time;
1794 * g_source_set_can_recurse:
1795 * @source: a #GSource
1796 * @can_recurse: whether recursion is allowed for this source
1798 * Sets whether a source can be called recursively. If @can_recurse is
1799 * %TRUE, then while the source is being dispatched then this source
1800 * will be processed normally. Otherwise, all processing of this
1801 * source is blocked until the dispatch function returns.
1804 g_source_set_can_recurse (GSource *source,
1805 gboolean can_recurse)
1807 GMainContext *context;
1809 g_return_if_fail (source != NULL);
1811 context = source->context;
1814 LOCK_CONTEXT (context);
1817 source->flags |= G_SOURCE_CAN_RECURSE;
1819 source->flags &= ~G_SOURCE_CAN_RECURSE;
1822 UNLOCK_CONTEXT (context);
1826 * g_source_get_can_recurse:
1827 * @source: a #GSource
1829 * Checks whether a source is allowed to be called recursively.
1830 * see g_source_set_can_recurse().
1832 * Returns: whether recursion is allowed.
1835 g_source_get_can_recurse (GSource *source)
1837 g_return_val_if_fail (source != NULL, FALSE);
1839 return (source->flags & G_SOURCE_CAN_RECURSE) != 0;
1844 * g_source_set_name:
1845 * @source: a #GSource
1846 * @name: debug name for the source
1848 * Sets a name for the source, used in debugging and profiling.
1849 * The name defaults to #NULL.
1851 * The source name should describe in a human-readable way
1852 * what the source does. For example, "X11 event queue"
1853 * or "GTK+ repaint idle handler" or whatever it is.
1855 * It is permitted to call this function multiple times, but is not
1856 * recommended due to the potential performance impact. For example,
1857 * one could change the name in the "check" function of a #GSourceFuncs
1858 * to include details like the event type in the source name.
1863 g_source_set_name (GSource *source,
1866 g_return_if_fail (source != NULL);
1868 /* setting back to NULL is allowed, just because it's
1869 * weird if get_name can return NULL but you can't
1873 g_free (source->name);
1874 source->name = g_strdup (name);
1878 * g_source_get_name:
1879 * @source: a #GSource
1881 * Gets a name for the source, used in debugging and profiling.
1882 * The name may be #NULL if it has never been set with
1883 * g_source_set_name().
1885 * Returns: the name of the source
1889 g_source_get_name (GSource *source)
1891 g_return_val_if_fail (source != NULL, NULL);
1893 return source->name;
1897 * g_source_set_name_by_id:
1898 * @tag: a #GSource ID
1899 * @name: debug name for the source
1901 * Sets the name of a source using its ID.
1903 * This is a convenience utility to set source names from the return
1904 * value of g_idle_add(), g_timeout_add(), etc.
1906 * It is a programmer error to attempt to set the name of a non-existent
1909 * More specifically: source IDs can be reissued after a source has been
1910 * destroyed and therefore it is never valid to use this function with a
1911 * source ID which may have already been removed. An example is when
1912 * scheduling an idle to run in another thread with g_idle_add(): the
1913 * idle may already have run and been removed by the time this function
1914 * is called on its (now invalid) source ID. This source ID may have
1915 * been reissued, leading to the operation being performed against the
1921 g_source_set_name_by_id (guint tag,
1926 g_return_if_fail (tag > 0);
1928 source = g_main_context_find_source_by_id (NULL, tag);
1932 g_source_set_name (source, name);
1938 * @source: a #GSource
1940 * Increases the reference count on a source by one.
1945 g_source_ref (GSource *source)
1947 GMainContext *context;
1949 g_return_val_if_fail (source != NULL, NULL);
1951 context = source->context;
1954 LOCK_CONTEXT (context);
1956 source->ref_count++;
1959 UNLOCK_CONTEXT (context);
1964 /* g_source_unref() but possible to call within context lock
1967 g_source_unref_internal (GSource *source,
1968 GMainContext *context,
1971 gpointer old_cb_data = NULL;
1972 GSourceCallbackFuncs *old_cb_funcs = NULL;
1974 g_return_if_fail (source != NULL);
1976 if (!have_lock && context)
1977 LOCK_CONTEXT (context);
1979 source->ref_count--;
1980 if (source->ref_count == 0)
1982 old_cb_data = source->callback_data;
1983 old_cb_funcs = source->callback_funcs;
1985 source->callback_data = NULL;
1986 source->callback_funcs = NULL;
1990 if (!SOURCE_DESTROYED (source))
1991 g_warning (G_STRLOC ": ref_count == 0, but source was still attached to a context!");
1992 source_remove_from_context (source, context);
1994 g_hash_table_remove (context->sources, GUINT_TO_POINTER (source->source_id));
1997 if (source->source_funcs->finalize)
2000 UNLOCK_CONTEXT (context);
2001 source->source_funcs->finalize (source);
2003 LOCK_CONTEXT (context);
2006 g_free (source->name);
2007 source->name = NULL;
2009 g_slist_free (source->poll_fds);
2010 source->poll_fds = NULL;
2012 g_slist_free_full (source->priv->fds, g_free);
2014 g_slice_free (GSourcePrivate, source->priv);
2015 source->priv = NULL;
2020 if (!have_lock && context)
2021 UNLOCK_CONTEXT (context);
2026 UNLOCK_CONTEXT (context);
2028 old_cb_funcs->unref (old_cb_data);
2031 LOCK_CONTEXT (context);
2037 * @source: a #GSource
2039 * Decreases the reference count of a source by one. If the
2040 * resulting reference count is zero the source and associated
2041 * memory will be destroyed.
2044 g_source_unref (GSource *source)
2046 g_return_if_fail (source != NULL);
2048 g_source_unref_internal (source, source->context, FALSE);
2052 * g_main_context_find_source_by_id:
2053 * @context: (allow-none): a #GMainContext (if %NULL, the default context will be used)
2054 * @source_id: the source ID, as returned by g_source_get_id().
2056 * Finds a #GSource given a pair of context and ID.
2058 * It is a programmer error to attempt to lookup a non-existent source.
2060 * More specifically: source IDs can be reissued after a source has been
2061 * destroyed and therefore it is never valid to use this function with a
2062 * source ID which may have already been removed. An example is when
2063 * scheduling an idle to run in another thread with g_idle_add(): the
2064 * idle may already have run and been removed by the time this function
2065 * is called on its (now invalid) source ID. This source ID may have
2066 * been reissued, leading to the operation being performed against the
2069 * Returns: (transfer none): the #GSource
2072 g_main_context_find_source_by_id (GMainContext *context,
2077 g_return_val_if_fail (source_id > 0, NULL);
2079 if (context == NULL)
2080 context = g_main_context_default ();
2082 LOCK_CONTEXT (context);
2083 source = g_hash_table_lookup (context->sources, GUINT_TO_POINTER (source_id));
2084 UNLOCK_CONTEXT (context);
2086 if (source && SOURCE_DESTROYED (source))
2093 * g_main_context_find_source_by_funcs_user_data:
2094 * @context: (allow-none): a #GMainContext (if %NULL, the default context will be used).
2095 * @funcs: the @source_funcs passed to g_source_new().
2096 * @user_data: the user data from the callback.
2098 * Finds a source with the given source functions and user data. If
2099 * multiple sources exist with the same source function and user data,
2100 * the first one found will be returned.
2102 * Returns: (transfer none): the source, if one was found, otherwise %NULL
2105 g_main_context_find_source_by_funcs_user_data (GMainContext *context,
2106 GSourceFuncs *funcs,
2112 g_return_val_if_fail (funcs != NULL, NULL);
2114 if (context == NULL)
2115 context = g_main_context_default ();
2117 LOCK_CONTEXT (context);
2119 g_source_iter_init (&iter, context, FALSE);
2120 while (g_source_iter_next (&iter, &source))
2122 if (!SOURCE_DESTROYED (source) &&
2123 source->source_funcs == funcs &&
2124 source->callback_funcs)
2126 GSourceFunc callback;
2127 gpointer callback_data;
2129 source->callback_funcs->get (source->callback_data, source, &callback, &callback_data);
2131 if (callback_data == user_data)
2135 g_source_iter_clear (&iter);
2137 UNLOCK_CONTEXT (context);
2143 * g_main_context_find_source_by_user_data:
2144 * @context: a #GMainContext
2145 * @user_data: the user_data for the callback.
2147 * Finds a source with the given user data for the callback. If
2148 * multiple sources exist with the same user data, the first
2149 * one found will be returned.
2151 * Returns: (transfer none): the source, if one was found, otherwise %NULL
2154 g_main_context_find_source_by_user_data (GMainContext *context,
2160 if (context == NULL)
2161 context = g_main_context_default ();
2163 LOCK_CONTEXT (context);
2165 g_source_iter_init (&iter, context, FALSE);
2166 while (g_source_iter_next (&iter, &source))
2168 if (!SOURCE_DESTROYED (source) &&
2169 source->callback_funcs)
2171 GSourceFunc callback;
2172 gpointer callback_data = NULL;
2174 source->callback_funcs->get (source->callback_data, source, &callback, &callback_data);
2176 if (callback_data == user_data)
2180 g_source_iter_clear (&iter);
2182 UNLOCK_CONTEXT (context);
2189 * @tag: the ID of the source to remove.
2191 * Removes the source with the given id from the default main context.
2193 * The id of a #GSource is given by g_source_get_id(), or will be
2194 * returned by the functions g_source_attach(), g_idle_add(),
2195 * g_idle_add_full(), g_timeout_add(), g_timeout_add_full(),
2196 * g_child_watch_add(), g_child_watch_add_full(), g_io_add_watch(), and
2197 * g_io_add_watch_full().
2199 * See also g_source_destroy(). You must use g_source_destroy() for sources
2200 * added to a non-default main context.
2202 * It is a programmer error to attempt to remove a non-existent source.
2204 * More specifically: source IDs can be reissued after a source has been
2205 * destroyed and therefore it is never valid to use this function with a
2206 * source ID which may have already been removed. An example is when
2207 * scheduling an idle to run in another thread with g_idle_add(): the
2208 * idle may already have run and been removed by the time this function
2209 * is called on its (now invalid) source ID. This source ID may have
2210 * been reissued, leading to the operation being performed against the
2213 * Returns: For historical reasons, this function always returns %TRUE
2216 g_source_remove (guint tag)
2220 g_return_val_if_fail (tag > 0, FALSE);
2222 source = g_main_context_find_source_by_id (NULL, tag);
2224 g_source_destroy (source);
2226 g_critical ("Source ID %u was not found when attempting to remove it", tag);
2228 return source != NULL;
2232 * g_source_remove_by_user_data:
2233 * @user_data: the user_data for the callback.
2235 * Removes a source from the default main loop context given the user
2236 * data for the callback. If multiple sources exist with the same user
2237 * data, only one will be destroyed.
2239 * Returns: %TRUE if a source was found and removed.
2242 g_source_remove_by_user_data (gpointer user_data)
2246 source = g_main_context_find_source_by_user_data (NULL, user_data);
2249 g_source_destroy (source);
2257 * g_source_remove_by_funcs_user_data:
2258 * @funcs: The @source_funcs passed to g_source_new()
2259 * @user_data: the user data for the callback
2261 * Removes a source from the default main loop context given the
2262 * source functions and user data. If multiple sources exist with the
2263 * same source functions and user data, only one will be destroyed.
2265 * Returns: %TRUE if a source was found and removed.
2268 g_source_remove_by_funcs_user_data (GSourceFuncs *funcs,
2273 g_return_val_if_fail (funcs != NULL, FALSE);
2275 source = g_main_context_find_source_by_funcs_user_data (NULL, funcs, user_data);
2278 g_source_destroy (source);
2287 * g_source_add_unix_fd:
2288 * @source: a #GSource
2289 * @fd: the fd to monitor
2290 * @events: an event mask
2292 * Monitors @fd for the IO events in @events.
2294 * The tag returned by this function can be used to remove or modify the
2295 * monitoring of the fd using g_source_remove_unix_fd() or
2296 * g_source_modify_unix_fd().
2298 * It is not necessary to remove the fd before destroying the source; it
2299 * will be cleaned up automatically.
2301 * This API is only intended to be used by implementations of #GSource.
2302 * Do not call this API on a #GSource that you did not create.
2304 * As the name suggests, this function is not available on Windows.
2306 * Returns: an opaque tag
2311 g_source_add_unix_fd (GSource *source,
2313 GIOCondition events)
2315 GMainContext *context;
2318 g_return_val_if_fail (source != NULL, NULL);
2319 g_return_val_if_fail (!SOURCE_DESTROYED (source), NULL);
2321 poll_fd = g_new (GPollFD, 1);
2323 poll_fd->events = events;
2324 poll_fd->revents = 0;
2326 context = source->context;
2329 LOCK_CONTEXT (context);
2331 source->priv->fds = g_slist_prepend (source->priv->fds, poll_fd);
2335 if (!SOURCE_BLOCKED (source))
2336 g_main_context_add_poll_unlocked (context, source->priority, poll_fd);
2337 UNLOCK_CONTEXT (context);
2344 * g_source_modify_unix_fd:
2345 * @source: a #GSource
2346 * @tag: the tag from g_source_add_unix_fd()
2347 * @new_events: the new event mask to watch
2349 * Updates the event mask to watch for the fd identified by @tag.
2351 * @tag is the tag returned from g_source_add_unix_fd().
2353 * If you want to remove a fd, don't set its event mask to zero.
2354 * Instead, call g_source_remove_unix_fd().
2356 * This API is only intended to be used by implementations of #GSource.
2357 * Do not call this API on a #GSource that you did not create.
2359 * As the name suggests, this function is not available on Windows.
2364 g_source_modify_unix_fd (GSource *source,
2366 GIOCondition new_events)
2368 GMainContext *context;
2371 g_return_if_fail (source != NULL);
2372 g_return_if_fail (g_slist_find (source->priv->fds, tag));
2374 context = source->context;
2377 poll_fd->events = new_events;
2380 g_main_context_wakeup (context);
2384 * g_source_remove_unix_fd:
2385 * @source: a #GSource
2386 * @tag: the tag from g_source_add_unix_fd()
2388 * Reverses the effect of a previous call to g_source_add_unix_fd().
2390 * You only need to call this if you want to remove an fd from being
2391 * watched while keeping the same source around. In the normal case you
2392 * will just want to destroy the source.
2394 * This API is only intended to be used by implementations of #GSource.
2395 * Do not call this API on a #GSource that you did not create.
2397 * As the name suggests, this function is not available on Windows.
2402 g_source_remove_unix_fd (GSource *source,
2405 GMainContext *context;
2408 g_return_if_fail (source != NULL);
2409 g_return_if_fail (g_slist_find (source->priv->fds, tag));
2411 context = source->context;
2415 LOCK_CONTEXT (context);
2417 source->priv->fds = g_slist_remove (source->priv->fds, poll_fd);
2421 if (!SOURCE_BLOCKED (source))
2422 g_main_context_remove_poll_unlocked (context, poll_fd);
2424 UNLOCK_CONTEXT (context);
2431 * g_source_query_unix_fd:
2432 * @source: a #GSource
2433 * @tag: the tag from g_source_add_unix_fd()
2435 * Queries the events reported for the fd corresponding to @tag on
2436 * @source during the last poll.
2438 * The return value of this function is only defined when the function
2439 * is called from the check or dispatch functions for @source.
2441 * This API is only intended to be used by implementations of #GSource.
2442 * Do not call this API on a #GSource that you did not create.
2444 * As the name suggests, this function is not available on Windows.
2446 * Returns: the conditions reported on the fd
2451 g_source_query_unix_fd (GSource *source,
2456 g_return_val_if_fail (source != NULL, 0);
2457 g_return_val_if_fail (g_slist_find (source->priv->fds, tag), 0);
2461 return poll_fd->revents;
2463 #endif /* G_OS_UNIX */
2466 * g_get_current_time:
2467 * @result: #GTimeVal structure in which to store current time.
2469 * Equivalent to the UNIX gettimeofday() function, but portable.
2471 * You may find g_get_real_time() to be more convenient.
2474 g_get_current_time (GTimeVal *result)
2479 g_return_if_fail (result != NULL);
2481 /*this is required on alpha, there the timeval structs are int's
2482 not longs and a cast only would fail horribly*/
2483 gettimeofday (&r, NULL);
2484 result->tv_sec = r.tv_sec;
2485 result->tv_usec = r.tv_usec;
2490 g_return_if_fail (result != NULL);
2492 GetSystemTimeAsFileTime (&ft);
2493 memmove (&time64, &ft, sizeof (FILETIME));
2495 /* Convert from 100s of nanoseconds since 1601-01-01
2496 * to Unix epoch. Yes, this is Y2038 unsafe.
2498 time64 -= G_GINT64_CONSTANT (116444736000000000);
2501 result->tv_sec = time64 / 1000000;
2502 result->tv_usec = time64 % 1000000;
2509 * Queries the system wall-clock time.
2511 * This call is functionally equivalent to g_get_current_time() except
2512 * that the return value is often more convenient than dealing with a
2515 * You should only use this call if you are actually interested in the real
2516 * wall-clock time. g_get_monotonic_time() is probably more useful for
2517 * measuring intervals.
2519 * Returns: the number of microseconds since January 1, 1970 UTC.
2524 g_get_real_time (void)
2528 g_get_current_time (&tv);
2530 return (((gint64) tv.tv_sec) * 1000000) + tv.tv_usec;
2534 * g_get_monotonic_time:
2536 * Queries the system monotonic time.
2538 * The monotonic clock will always increase and doesn't suffer
2539 * discontinuities when the user (or NTP) changes the system time. It
2540 * may or may not continue to tick during times where the machine is
2543 * We try to use the clock that corresponds as closely as possible to
2544 * the passage of time as measured by system calls such as poll() but it
2545 * may not always be possible to do this.
2547 * Returns: the monotonic time, in microseconds
2551 #if defined (G_OS_WIN32)
2552 static ULONGLONG (*g_GetTickCount64) (void) = NULL;
2553 static guint32 g_win32_tick_epoch = 0;
2556 g_clock_win32_init (void)
2560 g_GetTickCount64 = NULL;
2561 kernel32 = GetModuleHandle ("KERNEL32.DLL");
2562 if (kernel32 != NULL)
2563 g_GetTickCount64 = (void *) GetProcAddress (kernel32, "GetTickCount64");
2564 g_win32_tick_epoch = ((guint32)GetTickCount()) >> 31;
2568 g_get_monotonic_time (void)
2573 /* There are four sources for the monotonic time on Windows:
2575 * Three are based on a (1 msec accuracy, but only read periodically) clock chip:
2576 * - GetTickCount (GTC)
2577 * 32bit msec counter, updated each ~15msec, wraps in ~50 days
2578 * - GetTickCount64 (GTC64)
2579 * Same as GetTickCount, but extended to 64bit, so no wrap
2580 * Only available in Vista or later
2581 * - timeGetTime (TGT)
2582 * similar to GetTickCount by default: 15msec, 50 day wrap.
2583 * available in winmm.dll (thus known as the multimedia timers)
2584 * However apps can raise the system timer clock frequency using timeBeginPeriod()
2585 * increasing the accuracy up to 1 msec, at a cost in general system performance
2588 * One is based on high precision clocks:
2589 * - QueryPrecisionCounter (QPC)
2590 * This has much higher accuracy, but is not guaranteed monotonic, and
2591 * has lots of complications like clock jumps and different times on different
2592 * CPUs. It also has lower long term accuracy (i.e. it will drift compared to
2593 * the low precision clocks.
2595 * Additionally, the precision available in the timer-based wakeup such as
2596 * MsgWaitForMultipleObjectsEx (which is what the mainloop is based on) is based
2597 * on the TGT resolution, so by default it is ~15msec, but can be increased by apps.
2599 * The QPC timer has too many issues to be used as is. The only way it could be used
2600 * is to use it to interpolate the lower precision clocks. Firefox does something like
2602 * https://bugzilla.mozilla.org/show_bug.cgi?id=363258
2604 * However this seems quite complicated, so we're not doing this right now.
2606 * The approach we take instead is to use the TGT timer, extending it to 64bit
2607 * either by using the GTC64 value, or if that is not available, a process local
2608 * time epoch that we increment when we detect a timer wrap (assumes that we read
2609 * the time at least once every 50 days).
2612 * - We have a globally consistent monotonic clock on Vista and later
2613 * - We have a locally monotonic clock on XP
2614 * - Apps that need higher precision in timeouts and clock reads can call
2615 * timeBeginPeriod() to increase it as much as they want
2618 if (g_GetTickCount64 != NULL)
2620 guint32 ticks_as_32bit;
2622 ticks = g_GetTickCount64 ();
2623 ticks32 = timeGetTime();
2625 /* GTC64 and TGT are sampled at different times, however they
2626 * have the same base and source (msecs since system boot).
2627 * They can differ by as much as -16 to +16 msecs.
2628 * We can't just inject the low bits into the 64bit counter
2629 * as one of the counters can have wrapped in 32bit space and
2630 * the other not. Instead we calculate the signed difference
2631 * in 32bit space and apply that difference to the 64bit counter.
2633 ticks_as_32bit = (guint32)ticks;
2635 /* We could do some 2's complement hack, but we play it safe */
2636 if (ticks32 - ticks_as_32bit <= G_MAXINT32)
2637 ticks += ticks32 - ticks_as_32bit;
2639 ticks -= ticks_as_32bit - ticks32;
2645 epoch = g_atomic_int_get (&g_win32_tick_epoch);
2647 /* Must read ticks after the epoch. Then we're guaranteed
2648 * that the ticks value we read is higher or equal to any
2649 * previous ones that lead to the writing of the epoch.
2651 ticks32 = timeGetTime();
2653 /* We store the MSB of the current time as the LSB
2654 * of the epoch. Comparing these bits lets us detect when
2655 * the 32bit counter has wrapped so we can increase the
2658 * This will work as long as this function is called at
2659 * least once every ~24 days, which is half the wrap time
2660 * of a 32bit msec counter. I think this is pretty likely.
2662 * Note that g_win32_tick_epoch is a process local state,
2663 * so the monotonic clock will not be the same between
2666 if ((ticks32 >> 31) != (epoch & 1))
2669 g_atomic_int_set (&g_win32_tick_epoch, epoch);
2673 ticks = (guint64)ticks32 | ((guint64)epoch) << 31;
2676 return ticks * 1000;
2678 #elif defined(HAVE_MACH_MACH_TIME_H) /* Mac OS */
2680 g_get_monotonic_time (void)
2682 static mach_timebase_info_data_t timebase_info;
2684 if (timebase_info.denom == 0)
2686 /* This is a fraction that we must use to scale
2687 * mach_absolute_time() by in order to reach nanoseconds.
2689 * We've only ever observed this to be 1/1, but maybe it could be
2690 * 1000/1 if mach time is microseconds already, or 1/1000 if
2691 * picoseconds. Try to deal nicely with that.
2693 mach_timebase_info (&timebase_info);
2695 /* We actually want microseconds... */
2696 if (timebase_info.numer % 1000 == 0)
2697 timebase_info.numer /= 1000;
2699 timebase_info.denom *= 1000;
2701 /* We want to make the numer 1 to avoid having to multiply... */
2702 if (timebase_info.denom % timebase_info.numer == 0)
2704 timebase_info.denom /= timebase_info.numer;
2705 timebase_info.numer = 1;
2709 /* We could just multiply by timebase_info.numer below, but why
2710 * bother for a case that may never actually exist...
2712 * Plus -- performing the multiplication would risk integer
2713 * overflow. If we ever actually end up in this situation, we
2714 * should more carefully evaluate the correct course of action.
2716 mach_timebase_info (&timebase_info); /* Get a fresh copy for a better message */
2717 g_error ("Got weird mach timebase info of %d/%d. Please file a bug against GLib.",
2718 timebase_info.numer, timebase_info.denom);
2722 return mach_absolute_time () / timebase_info.denom;
2726 g_get_monotonic_time (void)
2731 result = clock_gettime (CLOCK_MONOTONIC, &ts);
2733 if G_UNLIKELY (result != 0)
2734 g_error ("GLib requires working CLOCK_MONOTONIC");
2736 return (((gint64) ts.tv_sec) * 1000000) + (ts.tv_nsec / 1000);
2741 g_main_dispatch_free (gpointer dispatch)
2743 g_slice_free (GMainDispatch, dispatch);
2746 /* Running the main loop */
2748 static GMainDispatch *
2751 static GPrivate depth_private = G_PRIVATE_INIT (g_main_dispatch_free);
2752 GMainDispatch *dispatch;
2754 dispatch = g_private_get (&depth_private);
2758 dispatch = g_slice_new0 (GMainDispatch);
2759 g_private_set (&depth_private, dispatch);
2768 * Returns the depth of the stack of calls to
2769 * g_main_context_dispatch() on any #GMainContext in the current thread.
2770 * That is, when called from the toplevel, it gives 0. When
2771 * called from within a callback from g_main_context_iteration()
2772 * (or g_main_loop_run(), etc.) it returns 1. When called from within
2773 * a callback to a recursive call to g_main_context_iteration(),
2774 * it returns 2. And so forth.
2776 * This function is useful in a situation like the following:
2777 * Imagine an extremely simple "garbage collected" system.
2779 * |[<!-- language="C" -->
2780 * static GList *free_list;
2783 * allocate_memory (gsize size)
2785 * gpointer result = g_malloc (size);
2786 * free_list = g_list_prepend (free_list, result);
2791 * free_allocated_memory (void)
2794 * for (l = free_list; l; l = l->next);
2796 * g_list_free (free_list);
2804 * g_main_context_iteration (NULL, TRUE);
2805 * free_allocated_memory();
2809 * This works from an application, however, if you want to do the same
2810 * thing from a library, it gets more difficult, since you no longer
2811 * control the main loop. You might think you can simply use an idle
2812 * function to make the call to free_allocated_memory(), but that
2813 * doesn't work, since the idle function could be called from a
2814 * recursive callback. This can be fixed by using g_main_depth()
2816 * |[<!-- language="C" -->
2818 * allocate_memory (gsize size)
2820 * FreeListBlock *block = g_new (FreeListBlock, 1);
2821 * block->mem = g_malloc (size);
2822 * block->depth = g_main_depth ();
2823 * free_list = g_list_prepend (free_list, block);
2824 * return block->mem;
2828 * free_allocated_memory (void)
2832 * int depth = g_main_depth ();
2833 * for (l = free_list; l; );
2835 * GList *next = l->next;
2836 * FreeListBlock *block = l->data;
2837 * if (block->depth > depth)
2839 * g_free (block->mem);
2841 * free_list = g_list_delete_link (free_list, l);
2849 * There is a temptation to use g_main_depth() to solve
2850 * problems with reentrancy. For instance, while waiting for data
2851 * to be received from the network in response to a menu item,
2852 * the menu item might be selected again. It might seem that
2853 * one could make the menu item's callback return immediately
2854 * and do nothing if g_main_depth() returns a value greater than 1.
2855 * However, this should be avoided since the user then sees selecting
2856 * the menu item do nothing. Furthermore, you'll find yourself adding
2857 * these checks all over your code, since there are doubtless many,
2858 * many things that the user could do. Instead, you can use the
2859 * following techniques:
2861 * 1. Use gtk_widget_set_sensitive() or modal dialogs to prevent
2862 * the user from interacting with elements while the main
2863 * loop is recursing.
2865 * 2. Avoid main loop recursion in situations where you can't handle
2866 * arbitrary callbacks. Instead, structure your code so that you
2867 * simply return to the main loop and then get called again when
2868 * there is more work to do.
2870 * Returns: The main loop recursion level in the current thread
2875 GMainDispatch *dispatch = get_dispatch ();
2876 return dispatch->depth;
2880 * g_main_current_source:
2882 * Returns the currently firing source for this thread.
2884 * Returns: (transfer none): The currently firing source or %NULL.
2889 g_main_current_source (void)
2891 GMainDispatch *dispatch = get_dispatch ();
2892 return dispatch->source;
2896 * g_source_is_destroyed:
2897 * @source: a #GSource
2899 * Returns whether @source has been destroyed.
2901 * This is important when you operate upon your objects
2902 * from within idle handlers, but may have freed the object
2903 * before the dispatch of your idle handler.
2905 * |[<!-- language="C" -->
2907 * idle_callback (gpointer data)
2909 * SomeWidget *self = data;
2911 * GDK_THREADS_ENTER ();
2912 * // do stuff with self
2913 * self->idle_id = 0;
2914 * GDK_THREADS_LEAVE ();
2916 * return G_SOURCE_REMOVE;
2920 * some_widget_do_stuff_later (SomeWidget *self)
2922 * self->idle_id = g_idle_add (idle_callback, self);
2926 * some_widget_finalize (GObject *object)
2928 * SomeWidget *self = SOME_WIDGET (object);
2930 * if (self->idle_id)
2931 * g_source_remove (self->idle_id);
2933 * G_OBJECT_CLASS (parent_class)->finalize (object);
2937 * This will fail in a multi-threaded application if the
2938 * widget is destroyed before the idle handler fires due
2939 * to the use after free in the callback. A solution, to
2940 * this particular problem, is to check to if the source
2941 * has already been destroy within the callback.
2943 * |[<!-- language="C" -->
2945 * idle_callback (gpointer data)
2947 * SomeWidget *self = data;
2949 * GDK_THREADS_ENTER ();
2950 * if (!g_source_is_destroyed (g_main_current_source ()))
2952 * // do stuff with self
2954 * GDK_THREADS_LEAVE ();
2960 * Returns: %TRUE if the source has been destroyed
2965 g_source_is_destroyed (GSource *source)
2967 return SOURCE_DESTROYED (source);
2970 /* Temporarily remove all this source's file descriptors from the
2971 * poll(), so that if data comes available for one of the file descriptors
2972 * we don't continually spin in the poll()
2974 /* HOLDS: source->context's lock */
2976 block_source (GSource *source)
2980 g_return_if_fail (!SOURCE_BLOCKED (source));
2982 source->flags |= G_SOURCE_BLOCKED;
2984 if (source->context)
2986 tmp_list = source->poll_fds;
2989 g_main_context_remove_poll_unlocked (source->context, tmp_list->data);
2990 tmp_list = tmp_list->next;
2993 for (tmp_list = source->priv->fds; tmp_list; tmp_list = tmp_list->next)
2994 g_main_context_remove_poll_unlocked (source->context, tmp_list->data);
2997 if (source->priv && source->priv->child_sources)
2999 tmp_list = source->priv->child_sources;
3002 block_source (tmp_list->data);
3003 tmp_list = tmp_list->next;
3008 /* HOLDS: source->context's lock */
3010 unblock_source (GSource *source)
3014 g_return_if_fail (SOURCE_BLOCKED (source)); /* Source already unblocked */
3015 g_return_if_fail (!SOURCE_DESTROYED (source));
3017 source->flags &= ~G_SOURCE_BLOCKED;
3019 tmp_list = source->poll_fds;
3022 g_main_context_add_poll_unlocked (source->context, source->priority, tmp_list->data);
3023 tmp_list = tmp_list->next;
3026 for (tmp_list = source->priv->fds; tmp_list; tmp_list = tmp_list->next)
3027 g_main_context_add_poll_unlocked (source->context, source->priority, tmp_list->data);
3029 if (source->priv && source->priv->child_sources)
3031 tmp_list = source->priv->child_sources;
3034 unblock_source (tmp_list->data);
3035 tmp_list = tmp_list->next;
3040 /* HOLDS: context's lock */
3042 g_main_dispatch (GMainContext *context)
3044 GMainDispatch *current = get_dispatch ();
3047 for (i = 0; i < context->pending_dispatches->len; i++)
3049 GSource *source = context->pending_dispatches->pdata[i];
3051 context->pending_dispatches->pdata[i] = NULL;
3054 source->flags &= ~G_SOURCE_READY;
3056 if (!SOURCE_DESTROYED (source))
3058 gboolean was_in_call;
3059 gpointer user_data = NULL;
3060 GSourceFunc callback = NULL;
3061 GSourceCallbackFuncs *cb_funcs;
3063 gboolean need_destroy;
3065 gboolean (*dispatch) (GSource *,
3068 GSource *prev_source;
3070 dispatch = source->source_funcs->dispatch;
3071 cb_funcs = source->callback_funcs;
3072 cb_data = source->callback_data;
3075 cb_funcs->ref (cb_data);
3077 if ((source->flags & G_SOURCE_CAN_RECURSE) == 0)
3078 block_source (source);
3080 was_in_call = source->flags & G_HOOK_FLAG_IN_CALL;
3081 source->flags |= G_HOOK_FLAG_IN_CALL;
3084 cb_funcs->get (cb_data, source, &callback, &user_data);
3086 UNLOCK_CONTEXT (context);
3088 /* These operations are safe because 'current' is thread-local
3089 * and not modified from anywhere but this function.
3091 prev_source = current->source;
3092 current->source = source;
3095 TRACE( GLIB_MAIN_BEFORE_DISPATCH (g_source_get_name (source)));
3096 need_destroy = !(* dispatch) (source, callback, user_data);
3097 TRACE( GLIB_MAIN_AFTER_DISPATCH (g_source_get_name (source)));
3099 current->source = prev_source;
3103 cb_funcs->unref (cb_data);
3105 LOCK_CONTEXT (context);
3108 source->flags &= ~G_HOOK_FLAG_IN_CALL;
3110 if (SOURCE_BLOCKED (source) && !SOURCE_DESTROYED (source))
3111 unblock_source (source);
3113 /* Note: this depends on the fact that we can't switch
3114 * sources from one main context to another
3116 if (need_destroy && !SOURCE_DESTROYED (source))
3118 g_assert (source->context == context);
3119 g_source_destroy_internal (source, context, TRUE);
3123 SOURCE_UNREF (source, context);
3126 g_ptr_array_set_size (context->pending_dispatches, 0);
3130 * g_main_context_acquire:
3131 * @context: a #GMainContext
3133 * Tries to become the owner of the specified context.
3134 * If some other thread is the owner of the context,
3135 * returns %FALSE immediately. Ownership is properly
3136 * recursive: the owner can require ownership again
3137 * and will release ownership when g_main_context_release()
3138 * is called as many times as g_main_context_acquire().
3140 * You must be the owner of a context before you
3141 * can call g_main_context_prepare(), g_main_context_query(),
3142 * g_main_context_check(), g_main_context_dispatch().
3144 * Returns: %TRUE if the operation succeeded, and
3145 * this thread is now the owner of @context.
3148 g_main_context_acquire (GMainContext *context)
3150 gboolean result = FALSE;
3151 GThread *self = G_THREAD_SELF;
3153 if (context == NULL)
3154 context = g_main_context_default ();
3156 LOCK_CONTEXT (context);
3158 if (!context->owner)
3160 context->owner = self;
3161 g_assert (context->owner_count == 0);
3164 if (context->owner == self)
3166 context->owner_count++;
3170 UNLOCK_CONTEXT (context);
3176 * g_main_context_release:
3177 * @context: a #GMainContext
3179 * Releases ownership of a context previously acquired by this thread
3180 * with g_main_context_acquire(). If the context was acquired multiple
3181 * times, the ownership will be released only when g_main_context_release()
3182 * is called as many times as it was acquired.
3185 g_main_context_release (GMainContext *context)
3187 if (context == NULL)
3188 context = g_main_context_default ();
3190 LOCK_CONTEXT (context);
3192 context->owner_count--;
3193 if (context->owner_count == 0)
3195 context->owner = NULL;
3197 if (context->waiters)
3199 GMainWaiter *waiter = context->waiters->data;
3200 gboolean loop_internal_waiter = (waiter->mutex == &context->mutex);
3201 context->waiters = g_slist_delete_link (context->waiters,
3203 if (!loop_internal_waiter)
3204 g_mutex_lock (waiter->mutex);
3206 g_cond_signal (waiter->cond);
3208 if (!loop_internal_waiter)
3209 g_mutex_unlock (waiter->mutex);
3213 UNLOCK_CONTEXT (context);
3217 * g_main_context_wait:
3218 * @context: a #GMainContext
3219 * @cond: a condition variable
3220 * @mutex: a mutex, currently held
3222 * Tries to become the owner of the specified context,
3223 * as with g_main_context_acquire(). But if another thread
3224 * is the owner, atomically drop @mutex and wait on @cond until
3225 * that owner releases ownership or until @cond is signaled, then
3226 * try again (once) to become the owner.
3228 * Returns: %TRUE if the operation succeeded, and
3229 * this thread is now the owner of @context.
3232 g_main_context_wait (GMainContext *context,
3236 gboolean result = FALSE;
3237 GThread *self = G_THREAD_SELF;
3238 gboolean loop_internal_waiter;
3240 if (context == NULL)
3241 context = g_main_context_default ();
3243 if G_UNLIKELY (cond != &context->cond || mutex != &context->mutex)
3245 static gboolean warned;
3249 g_critical ("WARNING!! g_main_context_wait() will be removed in a future release. "
3250 "If you see this message, please file a bug immediately.");
3255 loop_internal_waiter = (mutex == &context->mutex);
3257 if (!loop_internal_waiter)
3258 LOCK_CONTEXT (context);
3260 if (context->owner && context->owner != self)
3265 waiter.mutex = mutex;
3267 context->waiters = g_slist_append (context->waiters, &waiter);
3269 if (!loop_internal_waiter)
3270 UNLOCK_CONTEXT (context);
3271 g_cond_wait (cond, mutex);
3272 if (!loop_internal_waiter)
3273 LOCK_CONTEXT (context);
3275 context->waiters = g_slist_remove (context->waiters, &waiter);
3278 if (!context->owner)
3280 context->owner = self;
3281 g_assert (context->owner_count == 0);
3284 if (context->owner == self)
3286 context->owner_count++;
3290 if (!loop_internal_waiter)
3291 UNLOCK_CONTEXT (context);
3297 * g_main_context_prepare:
3298 * @context: a #GMainContext
3299 * @priority: location to store priority of highest priority
3300 * source already ready.
3302 * Prepares to poll sources within a main loop. The resulting information
3303 * for polling is determined by calling g_main_context_query ().
3305 * You must have successfully acquired the context with
3306 * g_main_context_acquire() before you may call this function.
3308 * Returns: %TRUE if some source is ready to be dispatched
3312 g_main_context_prepare (GMainContext *context,
3317 gint current_priority = G_MAXINT;
3321 if (context == NULL)
3322 context = g_main_context_default ();
3324 LOCK_CONTEXT (context);
3326 context->time_is_fresh = FALSE;
3328 if (context->in_check_or_prepare)
3330 g_warning ("g_main_context_prepare() called recursively from within a source's check() or "
3331 "prepare() member.");
3332 UNLOCK_CONTEXT (context);
3337 /* If recursing, finish up current dispatch, before starting over */
3338 if (context->pending_dispatches)
3341 g_main_dispatch (context, ¤t_time);
3343 UNLOCK_CONTEXT (context);
3348 /* If recursing, clear list of pending dispatches */
3350 for (i = 0; i < context->pending_dispatches->len; i++)
3352 if (context->pending_dispatches->pdata[i])
3353 SOURCE_UNREF ((GSource *)context->pending_dispatches->pdata[i], context);
3355 g_ptr_array_set_size (context->pending_dispatches, 0);
3357 /* Prepare all sources */
3359 context->timeout = -1;
3361 g_source_iter_init (&iter, context, TRUE);
3362 while (g_source_iter_next (&iter, &source))
3364 gint source_timeout = -1;
3366 if (SOURCE_DESTROYED (source) || SOURCE_BLOCKED (source))
3368 if ((n_ready > 0) && (source->priority > current_priority))
3371 if (!(source->flags & G_SOURCE_READY))
3374 gboolean (* prepare) (GSource *source,
3377 prepare = source->source_funcs->prepare;
3381 context->in_check_or_prepare++;
3382 UNLOCK_CONTEXT (context);
3384 result = (* prepare) (source, &source_timeout);
3386 LOCK_CONTEXT (context);
3387 context->in_check_or_prepare--;
3391 source_timeout = -1;
3395 if (result == FALSE && source->priv->ready_time != -1)
3397 if (!context->time_is_fresh)
3399 context->time = g_get_monotonic_time ();
3400 context->time_is_fresh = TRUE;
3403 if (source->priv->ready_time <= context->time)
3412 /* rounding down will lead to spinning, so always round up */
3413 timeout = (source->priv->ready_time - context->time + 999) / 1000;
3415 if (source_timeout < 0 || timeout < source_timeout)
3416 source_timeout = timeout;
3422 GSource *ready_source = source;
3424 while (ready_source)
3426 ready_source->flags |= G_SOURCE_READY;
3427 ready_source = ready_source->priv->parent_source;
3432 if (source->flags & G_SOURCE_READY)
3435 current_priority = source->priority;
3436 context->timeout = 0;
3439 if (source_timeout >= 0)
3441 if (context->timeout < 0)
3442 context->timeout = source_timeout;
3444 context->timeout = MIN (context->timeout, source_timeout);
3447 g_source_iter_clear (&iter);
3449 UNLOCK_CONTEXT (context);
3452 *priority = current_priority;
3454 return (n_ready > 0);
3458 * g_main_context_query:
3459 * @context: a #GMainContext
3460 * @max_priority: maximum priority source to check
3461 * @timeout_: (out): location to store timeout to be used in polling
3462 * @fds: (out caller-allocates) (array length=n_fds): location to
3463 * store #GPollFD records that need to be polled.
3464 * @n_fds: length of @fds.
3466 * Determines information necessary to poll this main loop.
3468 * You must have successfully acquired the context with
3469 * g_main_context_acquire() before you may call this function.
3471 * Returns: the number of records actually stored in @fds,
3472 * or, if more than @n_fds records need to be stored, the number
3473 * of records that need to be stored.
3476 g_main_context_query (GMainContext *context,
3485 LOCK_CONTEXT (context);
3487 pollrec = context->poll_records;
3489 while (pollrec && max_priority >= pollrec->priority)
3491 /* We need to include entries with fd->events == 0 in the array because
3492 * otherwise if the application changes fd->events behind our back and
3493 * makes it non-zero, we'll be out of sync when we check the fds[] array.
3494 * (Changing fd->events after adding an FD wasn't an anticipated use of
3495 * this API, but it occurs in practice.) */
3498 fds[n_poll].fd = pollrec->fd->fd;
3499 /* In direct contradiction to the Unix98 spec, IRIX runs into
3500 * difficulty if you pass in POLLERR, POLLHUP or POLLNVAL
3501 * flags in the events field of the pollfd while it should
3502 * just ignoring them. So we mask them out here.
3504 fds[n_poll].events = pollrec->fd->events & ~(G_IO_ERR|G_IO_HUP|G_IO_NVAL);
3505 fds[n_poll].revents = 0;
3508 pollrec = pollrec->next;
3512 context->poll_changed = FALSE;
3516 *timeout = context->timeout;
3518 context->time_is_fresh = FALSE;
3521 UNLOCK_CONTEXT (context);
3527 * g_main_context_check:
3528 * @context: a #GMainContext
3529 * @max_priority: the maximum numerical priority of sources to check
3530 * @fds: (array length=n_fds): array of #GPollFD's that was passed to
3531 * the last call to g_main_context_query()
3532 * @n_fds: return value of g_main_context_query()
3534 * Passes the results of polling back to the main loop.
3536 * You must have successfully acquired the context with
3537 * g_main_context_acquire() before you may call this function.
3539 * Returns: %TRUE if some sources are ready to be dispatched.
3542 g_main_context_check (GMainContext *context,
3553 LOCK_CONTEXT (context);
3555 if (context->in_check_or_prepare)
3557 g_warning ("g_main_context_check() called recursively from within a source's check() or "
3558 "prepare() member.");
3559 UNLOCK_CONTEXT (context);
3563 if (context->wake_up_rec.revents)
3564 g_wakeup_acknowledge (context->wakeup);
3566 /* If the set of poll file descriptors changed, bail out
3567 * and let the main loop rerun
3569 if (context->poll_changed)
3571 UNLOCK_CONTEXT (context);
3575 pollrec = context->poll_records;
3579 if (pollrec->fd->events)
3580 pollrec->fd->revents = fds[i].revents;
3582 pollrec = pollrec->next;
3586 g_source_iter_init (&iter, context, TRUE);
3587 while (g_source_iter_next (&iter, &source))
3589 if (SOURCE_DESTROYED (source) || SOURCE_BLOCKED (source))
3591 if ((n_ready > 0) && (source->priority > max_priority))
3594 if (!(source->flags & G_SOURCE_READY))
3597 gboolean (* check) (GSource *source);
3599 check = source->source_funcs->check;
3603 /* If the check function is set, call it. */
3604 context->in_check_or_prepare++;
3605 UNLOCK_CONTEXT (context);
3607 result = (* check) (source);
3609 LOCK_CONTEXT (context);
3610 context->in_check_or_prepare--;
3615 if (result == FALSE)
3619 /* If not already explicitly flagged ready by ->check()
3620 * (or if we have no check) then we can still be ready if
3621 * any of our fds poll as ready.
3623 for (tmp_list = source->priv->fds; tmp_list; tmp_list = tmp_list->next)
3625 GPollFD *pollfd = tmp_list->data;
3627 if (pollfd->revents)
3635 if (result == FALSE && source->priv->ready_time != -1)
3637 if (!context->time_is_fresh)
3639 context->time = g_get_monotonic_time ();
3640 context->time_is_fresh = TRUE;
3643 if (source->priv->ready_time <= context->time)
3649 GSource *ready_source = source;
3651 while (ready_source)
3653 ready_source->flags |= G_SOURCE_READY;
3654 ready_source = ready_source->priv->parent_source;
3659 if (source->flags & G_SOURCE_READY)
3661 source->ref_count++;
3662 g_ptr_array_add (context->pending_dispatches, source);
3666 /* never dispatch sources with less priority than the first
3667 * one we choose to dispatch
3669 max_priority = source->priority;
3672 g_source_iter_clear (&iter);
3674 UNLOCK_CONTEXT (context);
3680 * g_main_context_dispatch:
3681 * @context: a #GMainContext
3683 * Dispatches all pending sources.
3685 * You must have successfully acquired the context with
3686 * g_main_context_acquire() before you may call this function.
3689 g_main_context_dispatch (GMainContext *context)
3691 LOCK_CONTEXT (context);
3693 if (context->pending_dispatches->len > 0)
3695 g_main_dispatch (context);
3698 UNLOCK_CONTEXT (context);
3701 /* HOLDS context lock */
3703 g_main_context_iterate (GMainContext *context,
3710 gboolean some_ready;
3711 gint nfds, allocated_nfds;
3712 GPollFD *fds = NULL;
3714 UNLOCK_CONTEXT (context);
3716 if (!g_main_context_acquire (context))
3718 gboolean got_ownership;
3720 LOCK_CONTEXT (context);
3725 got_ownership = g_main_context_wait (context,
3733 LOCK_CONTEXT (context);
3735 if (!context->cached_poll_array)
3737 context->cached_poll_array_size = context->n_poll_records;
3738 context->cached_poll_array = g_new (GPollFD, context->n_poll_records);
3741 allocated_nfds = context->cached_poll_array_size;
3742 fds = context->cached_poll_array;
3744 UNLOCK_CONTEXT (context);
3746 g_main_context_prepare (context, &max_priority);
3748 while ((nfds = g_main_context_query (context, max_priority, &timeout, fds,
3749 allocated_nfds)) > allocated_nfds)
3751 LOCK_CONTEXT (context);
3753 context->cached_poll_array_size = allocated_nfds = nfds;
3754 context->cached_poll_array = fds = g_new (GPollFD, nfds);
3755 UNLOCK_CONTEXT (context);
3761 g_main_context_poll (context, timeout, max_priority, fds, nfds);
3763 some_ready = g_main_context_check (context, max_priority, fds, nfds);
3766 g_main_context_dispatch (context);
3768 g_main_context_release (context);
3770 LOCK_CONTEXT (context);
3776 * g_main_context_pending:
3777 * @context: (allow-none): a #GMainContext (if %NULL, the default context will be used)
3779 * Checks if any sources have pending events for the given context.
3781 * Returns: %TRUE if events are pending.
3784 g_main_context_pending (GMainContext *context)
3789 context = g_main_context_default();
3791 LOCK_CONTEXT (context);
3792 retval = g_main_context_iterate (context, FALSE, FALSE, G_THREAD_SELF);
3793 UNLOCK_CONTEXT (context);
3799 * g_main_context_iteration:
3800 * @context: (allow-none): a #GMainContext (if %NULL, the default context will be used)
3801 * @may_block: whether the call may block.
3803 * Runs a single iteration for the given main loop. This involves
3804 * checking to see if any event sources are ready to be processed,
3805 * then if no events sources are ready and @may_block is %TRUE, waiting
3806 * for a source to become ready, then dispatching the highest priority
3807 * events sources that are ready. Otherwise, if @may_block is %FALSE
3808 * sources are not waited to become ready, only those highest priority
3809 * events sources will be dispatched (if any), that are ready at this
3810 * given moment without further waiting.
3812 * Note that even when @may_block is %TRUE, it is still possible for
3813 * g_main_context_iteration() to return %FALSE, since the wait may
3814 * be interrupted for other reasons than an event source becoming ready.
3816 * Returns: %TRUE if events were dispatched.
3819 g_main_context_iteration (GMainContext *context, gboolean may_block)
3824 context = g_main_context_default();
3826 LOCK_CONTEXT (context);
3827 retval = g_main_context_iterate (context, may_block, TRUE, G_THREAD_SELF);
3828 UNLOCK_CONTEXT (context);
3835 * @context: (allow-none): a #GMainContext (if %NULL, the default context will be used).
3836 * @is_running: set to %TRUE to indicate that the loop is running. This
3837 * is not very important since calling g_main_loop_run() will set this to
3840 * Creates a new #GMainLoop structure.
3842 * Returns: a new #GMainLoop.
3845 g_main_loop_new (GMainContext *context,
3846 gboolean is_running)
3851 context = g_main_context_default();
3853 g_main_context_ref (context);
3855 loop = g_new0 (GMainLoop, 1);
3856 loop->context = context;
3857 loop->is_running = is_running != FALSE;
3858 loop->ref_count = 1;
3865 * @loop: a #GMainLoop
3867 * Increases the reference count on a #GMainLoop object by one.
3872 g_main_loop_ref (GMainLoop *loop)
3874 g_return_val_if_fail (loop != NULL, NULL);
3875 g_return_val_if_fail (g_atomic_int_get (&loop->ref_count) > 0, NULL);
3877 g_atomic_int_inc (&loop->ref_count);
3883 * g_main_loop_unref:
3884 * @loop: a #GMainLoop
3886 * Decreases the reference count on a #GMainLoop object by one. If
3887 * the result is zero, free the loop and free all associated memory.
3890 g_main_loop_unref (GMainLoop *loop)
3892 g_return_if_fail (loop != NULL);
3893 g_return_if_fail (g_atomic_int_get (&loop->ref_count) > 0);
3895 if (!g_atomic_int_dec_and_test (&loop->ref_count))
3898 g_main_context_unref (loop->context);
3904 * @loop: a #GMainLoop
3906 * Runs a main loop until g_main_loop_quit() is called on the loop.
3907 * If this is called for the thread of the loop's #GMainContext,
3908 * it will process events from the loop, otherwise it will
3912 g_main_loop_run (GMainLoop *loop)
3914 GThread *self = G_THREAD_SELF;
3916 g_return_if_fail (loop != NULL);
3917 g_return_if_fail (g_atomic_int_get (&loop->ref_count) > 0);
3919 if (!g_main_context_acquire (loop->context))
3921 gboolean got_ownership = FALSE;
3923 /* Another thread owns this context */
3924 LOCK_CONTEXT (loop->context);
3926 g_atomic_int_inc (&loop->ref_count);
3928 if (!loop->is_running)
3929 loop->is_running = TRUE;
3931 while (loop->is_running && !got_ownership)
3932 got_ownership = g_main_context_wait (loop->context,
3933 &loop->context->cond,
3934 &loop->context->mutex);
3936 if (!loop->is_running)
3938 UNLOCK_CONTEXT (loop->context);
3940 g_main_context_release (loop->context);
3941 g_main_loop_unref (loop);
3945 g_assert (got_ownership);
3948 LOCK_CONTEXT (loop->context);
3950 if (loop->context->in_check_or_prepare)
3952 g_warning ("g_main_loop_run(): called recursively from within a source's "
3953 "check() or prepare() member, iteration not possible.");
3957 g_atomic_int_inc (&loop->ref_count);
3958 loop->is_running = TRUE;
3959 while (loop->is_running)
3960 g_main_context_iterate (loop->context, TRUE, TRUE, self);
3962 UNLOCK_CONTEXT (loop->context);
3964 g_main_context_release (loop->context);
3966 g_main_loop_unref (loop);
3971 * @loop: a #GMainLoop
3973 * Stops a #GMainLoop from running. Any calls to g_main_loop_run()
3974 * for the loop will return.
3976 * Note that sources that have already been dispatched when
3977 * g_main_loop_quit() is called will still be executed.
3980 g_main_loop_quit (GMainLoop *loop)
3982 g_return_if_fail (loop != NULL);
3983 g_return_if_fail (g_atomic_int_get (&loop->ref_count) > 0);
3985 LOCK_CONTEXT (loop->context);
3986 loop->is_running = FALSE;
3987 g_wakeup_signal (loop->context->wakeup);
3989 g_cond_broadcast (&loop->context->cond);
3991 UNLOCK_CONTEXT (loop->context);
3995 * g_main_loop_is_running:
3996 * @loop: a #GMainLoop.
3998 * Checks to see if the main loop is currently being run via g_main_loop_run().
4000 * Returns: %TRUE if the mainloop is currently being run.
4003 g_main_loop_is_running (GMainLoop *loop)
4005 g_return_val_if_fail (loop != NULL, FALSE);
4006 g_return_val_if_fail (g_atomic_int_get (&loop->ref_count) > 0, FALSE);
4008 return loop->is_running;
4012 * g_main_loop_get_context:
4013 * @loop: a #GMainLoop.
4015 * Returns the #GMainContext of @loop.
4017 * Returns: (transfer none): the #GMainContext of @loop
4020 g_main_loop_get_context (GMainLoop *loop)
4022 g_return_val_if_fail (loop != NULL, NULL);
4023 g_return_val_if_fail (g_atomic_int_get (&loop->ref_count) > 0, NULL);
4025 return loop->context;
4028 /* HOLDS: context's lock */
4030 g_main_context_poll (GMainContext *context,
4036 #ifdef G_MAIN_POLL_DEBUG
4042 GPollFunc poll_func;
4044 if (n_fds || timeout != 0)
4046 #ifdef G_MAIN_POLL_DEBUG
4048 if (_g_main_poll_debug)
4050 g_print ("polling context=%p n=%d timeout=%d\n",
4051 context, n_fds, timeout);
4052 poll_timer = g_timer_new ();
4056 LOCK_CONTEXT (context);
4058 poll_func = context->poll_func;
4060 UNLOCK_CONTEXT (context);
4061 if ((*poll_func) (fds, n_fds, timeout) < 0 && errno != EINTR)
4064 g_warning ("poll(2) failed due to: %s.",
4065 g_strerror (errno));
4067 /* If g_poll () returns -1, it has already called g_warning() */
4071 #ifdef G_MAIN_POLL_DEBUG
4072 if (_g_main_poll_debug)
4074 LOCK_CONTEXT (context);
4076 g_print ("g_main_poll(%d) timeout: %d - elapsed %12.10f seconds",
4079 g_timer_elapsed (poll_timer, NULL));
4080 g_timer_destroy (poll_timer);
4081 pollrec = context->poll_records;
4083 while (pollrec != NULL)
4088 if (fds[i].fd == pollrec->fd->fd &&
4089 pollrec->fd->events &&
4092 g_print (" [" G_POLLFD_FORMAT " :", fds[i].fd);
4093 if (fds[i].revents & G_IO_IN)
4095 if (fds[i].revents & G_IO_OUT)
4097 if (fds[i].revents & G_IO_PRI)
4099 if (fds[i].revents & G_IO_ERR)
4101 if (fds[i].revents & G_IO_HUP)
4103 if (fds[i].revents & G_IO_NVAL)
4109 pollrec = pollrec->next;
4113 UNLOCK_CONTEXT (context);
4116 } /* if (n_fds || timeout != 0) */
4120 * g_main_context_add_poll:
4121 * @context: (allow-none): a #GMainContext (or %NULL for the default context)
4122 * @fd: a #GPollFD structure holding information about a file
4123 * descriptor to watch.
4124 * @priority: the priority for this file descriptor which should be
4125 * the same as the priority used for g_source_attach() to ensure that the
4126 * file descriptor is polled whenever the results may be needed.
4128 * Adds a file descriptor to the set of file descriptors polled for
4129 * this context. This will very seldom be used directly. Instead
4130 * a typical event source will use g_source_add_unix_fd() instead.
4133 g_main_context_add_poll (GMainContext *context,
4138 context = g_main_context_default ();
4140 g_return_if_fail (g_atomic_int_get (&context->ref_count) > 0);
4141 g_return_if_fail (fd);
4143 LOCK_CONTEXT (context);
4144 g_main_context_add_poll_unlocked (context, priority, fd);
4145 UNLOCK_CONTEXT (context);
4148 /* HOLDS: main_loop_lock */
4150 g_main_context_add_poll_unlocked (GMainContext *context,
4154 GPollRec *prevrec, *nextrec;
4155 GPollRec *newrec = g_slice_new (GPollRec);
4157 /* This file descriptor may be checked before we ever poll */
4160 newrec->priority = priority;
4162 prevrec = context->poll_records_tail;
4164 while (prevrec && priority < prevrec->priority)
4167 prevrec = prevrec->prev;
4171 prevrec->next = newrec;
4173 context->poll_records = newrec;
4175 newrec->prev = prevrec;
4176 newrec->next = nextrec;
4179 nextrec->prev = newrec;
4181 context->poll_records_tail = newrec;
4183 context->n_poll_records++;
4185 context->poll_changed = TRUE;
4187 /* Now wake up the main loop if it is waiting in the poll() */
4188 g_wakeup_signal (context->wakeup);
4192 * g_main_context_remove_poll:
4193 * @context:a #GMainContext
4194 * @fd: a #GPollFD descriptor previously added with g_main_context_add_poll()
4196 * Removes file descriptor from the set of file descriptors to be
4197 * polled for a particular context.
4200 g_main_context_remove_poll (GMainContext *context,
4204 context = g_main_context_default ();
4206 g_return_if_fail (g_atomic_int_get (&context->ref_count) > 0);
4207 g_return_if_fail (fd);
4209 LOCK_CONTEXT (context);
4210 g_main_context_remove_poll_unlocked (context, fd);
4211 UNLOCK_CONTEXT (context);
4215 g_main_context_remove_poll_unlocked (GMainContext *context,
4218 GPollRec *pollrec, *prevrec, *nextrec;
4221 pollrec = context->poll_records;
4225 nextrec = pollrec->next;
4226 if (pollrec->fd == fd)
4228 if (prevrec != NULL)
4229 prevrec->next = nextrec;
4231 context->poll_records = nextrec;
4233 if (nextrec != NULL)
4234 nextrec->prev = prevrec;
4236 context->poll_records_tail = prevrec;
4238 g_slice_free (GPollRec, pollrec);
4240 context->n_poll_records--;
4247 context->poll_changed = TRUE;
4249 /* Now wake up the main loop if it is waiting in the poll() */
4250 g_wakeup_signal (context->wakeup);
4254 * g_source_get_current_time:
4255 * @source: a #GSource
4256 * @timeval: #GTimeVal structure in which to store current time.
4258 * This function ignores @source and is otherwise the same as
4259 * g_get_current_time().
4261 * Deprecated: 2.28: use g_source_get_time() instead
4264 g_source_get_current_time (GSource *source,
4267 g_get_current_time (timeval);
4271 * g_source_get_time:
4272 * @source: a #GSource
4274 * Gets the time to be used when checking this source. The advantage of
4275 * calling this function over calling g_get_monotonic_time() directly is
4276 * that when checking multiple sources, GLib can cache a single value
4277 * instead of having to repeatedly get the system monotonic time.
4279 * The time here is the system monotonic time, if available, or some
4280 * other reasonable alternative otherwise. See g_get_monotonic_time().
4282 * Returns: the monotonic time in microseconds
4287 g_source_get_time (GSource *source)
4289 GMainContext *context;
4292 g_return_val_if_fail (source->context != NULL, 0);
4294 context = source->context;
4296 LOCK_CONTEXT (context);
4298 if (!context->time_is_fresh)
4300 context->time = g_get_monotonic_time ();
4301 context->time_is_fresh = TRUE;
4304 result = context->time;
4306 UNLOCK_CONTEXT (context);
4312 * g_main_context_set_poll_func:
4313 * @context: a #GMainContext
4314 * @func: the function to call to poll all file descriptors
4316 * Sets the function to use to handle polling of file descriptors. It
4317 * will be used instead of the poll() system call
4318 * (or GLib's replacement function, which is used where
4319 * poll() isn't available).
4321 * This function could possibly be used to integrate the GLib event
4322 * loop with an external event loop.
4325 g_main_context_set_poll_func (GMainContext *context,
4329 context = g_main_context_default ();
4331 g_return_if_fail (g_atomic_int_get (&context->ref_count) > 0);
4333 LOCK_CONTEXT (context);
4336 context->poll_func = func;
4338 context->poll_func = g_poll;
4340 UNLOCK_CONTEXT (context);
4344 * g_main_context_get_poll_func:
4345 * @context: a #GMainContext
4347 * Gets the poll function set by g_main_context_set_poll_func().
4349 * Returns: the poll function
4352 g_main_context_get_poll_func (GMainContext *context)
4357 context = g_main_context_default ();
4359 g_return_val_if_fail (g_atomic_int_get (&context->ref_count) > 0, NULL);
4361 LOCK_CONTEXT (context);
4362 result = context->poll_func;
4363 UNLOCK_CONTEXT (context);
4369 * g_main_context_wakeup:
4370 * @context: a #GMainContext
4372 * If @context is currently blocking in g_main_context_iteration()
4373 * waiting for a source to become ready, cause it to stop blocking
4374 * and return. Otherwise, cause the next invocation of
4375 * g_main_context_iteration() to return without blocking.
4377 * This API is useful for low-level control over #GMainContext; for
4378 * example, integrating it with main loop implementations such as
4381 * Another related use for this function is when implementing a main
4382 * loop with a termination condition, computed from multiple threads:
4384 * |[<!-- language="C" -->
4385 * #define NUM_TASKS 10
4386 * static volatile gint tasks_remaining = NUM_TASKS;
4389 * while (g_atomic_int_get (&tasks_remaining) != 0)
4390 * g_main_context_iteration (NULL, TRUE);
4394 * |[<!-- language="C" -->
4397 * if (g_atomic_int_dec_and_test (&tasks_remaining))
4398 * g_main_context_wakeup (NULL);
4402 g_main_context_wakeup (GMainContext *context)
4405 context = g_main_context_default ();
4407 g_return_if_fail (g_atomic_int_get (&context->ref_count) > 0);
4409 g_wakeup_signal (context->wakeup);
4413 * g_main_context_is_owner:
4414 * @context: a #GMainContext
4416 * Determines whether this thread holds the (recursive)
4417 * ownership of this #GMainContext. This is useful to
4418 * know before waiting on another thread that may be
4419 * blocking to get ownership of @context.
4421 * Returns: %TRUE if current thread is owner of @context.
4426 g_main_context_is_owner (GMainContext *context)
4431 context = g_main_context_default ();
4433 LOCK_CONTEXT (context);
4434 is_owner = context->owner == G_THREAD_SELF;
4435 UNLOCK_CONTEXT (context);
4443 g_timeout_set_expiration (GTimeoutSource *timeout_source,
4444 gint64 current_time)
4448 expiration = current_time + (guint64) timeout_source->interval * 1000;
4450 if (timeout_source->seconds)
4453 static gint timer_perturb = -1;
4455 if (timer_perturb == -1)
4458 * we want a per machine/session unique 'random' value; try the dbus
4459 * address first, that has a UUID in it. If there is no dbus, use the
4460 * hostname for hashing.
4462 const char *session_bus_address = g_getenv ("DBUS_SESSION_BUS_ADDRESS");
4463 if (!session_bus_address)
4464 session_bus_address = g_getenv ("HOSTNAME");
4465 if (session_bus_address)
4466 timer_perturb = ABS ((gint) g_str_hash (session_bus_address)) % 1000000;
4471 /* We want the microseconds part of the timeout to land on the
4472 * 'timer_perturb' mark, but we need to make sure we don't try to
4473 * set the timeout in the past. We do this by ensuring that we
4474 * always only *increase* the expiration time by adding a full
4475 * second in the case that the microsecond portion decreases.
4477 expiration -= timer_perturb;
4479 remainder = expiration % 1000000;
4480 if (remainder >= 1000000/4)
4481 expiration += 1000000;
4483 expiration -= remainder;
4484 expiration += timer_perturb;
4487 g_source_set_ready_time ((GSource *) timeout_source, expiration);
4491 g_timeout_dispatch (GSource *source,
4492 GSourceFunc callback,
4495 GTimeoutSource *timeout_source = (GTimeoutSource *)source;
4500 g_warning ("Timeout source dispatched without callback\n"
4501 "You must call g_source_set_callback().");
4505 again = callback (user_data);
4508 g_timeout_set_expiration (timeout_source, g_source_get_time (source));
4514 * g_timeout_source_new:
4515 * @interval: the timeout interval in milliseconds.
4517 * Creates a new timeout source.
4519 * The source will not initially be associated with any #GMainContext
4520 * and must be added to one with g_source_attach() before it will be
4523 * The interval given is in terms of monotonic time, not wall clock
4524 * time. See g_get_monotonic_time().
4526 * Returns: the newly-created timeout source
4529 g_timeout_source_new (guint interval)
4531 GSource *source = g_source_new (&g_timeout_funcs, sizeof (GTimeoutSource));
4532 GTimeoutSource *timeout_source = (GTimeoutSource *)source;
4534 timeout_source->interval = interval;
4535 g_timeout_set_expiration (timeout_source, g_get_monotonic_time ());
4541 * g_timeout_source_new_seconds:
4542 * @interval: the timeout interval in seconds
4544 * Creates a new timeout source.
4546 * The source will not initially be associated with any #GMainContext
4547 * and must be added to one with g_source_attach() before it will be
4550 * The scheduling granularity/accuracy of this timeout source will be
4553 * The interval given in terms of monotonic time, not wall clock time.
4554 * See g_get_monotonic_time().
4556 * Returns: the newly-created timeout source
4561 g_timeout_source_new_seconds (guint interval)
4563 GSource *source = g_source_new (&g_timeout_funcs, sizeof (GTimeoutSource));
4564 GTimeoutSource *timeout_source = (GTimeoutSource *)source;
4566 timeout_source->interval = 1000 * interval;
4567 timeout_source->seconds = TRUE;
4569 g_timeout_set_expiration (timeout_source, g_get_monotonic_time ());
4576 * g_timeout_add_full:
4577 * @priority: the priority of the timeout source. Typically this will be in
4578 * the range between #G_PRIORITY_DEFAULT and #G_PRIORITY_HIGH.
4579 * @interval: the time between calls to the function, in milliseconds
4580 * (1/1000ths of a second)
4581 * @function: function to call
4582 * @data: data to pass to @function
4583 * @notify: (allow-none): function to call when the timeout is removed, or %NULL
4585 * Sets a function to be called at regular intervals, with the given
4586 * priority. The function is called repeatedly until it returns
4587 * %FALSE, at which point the timeout is automatically destroyed and
4588 * the function will not be called again. The @notify function is
4589 * called when the timeout is destroyed. The first call to the
4590 * function will be at the end of the first @interval.
4592 * Note that timeout functions may be delayed, due to the processing of other
4593 * event sources. Thus they should not be relied on for precise timing.
4594 * After each call to the timeout function, the time of the next
4595 * timeout is recalculated based on the current time and the given interval
4596 * (it does not try to 'catch up' time lost in delays).
4598 * This internally creates a main loop source using g_timeout_source_new()
4599 * and attaches it to the main loop context using g_source_attach(). You can
4600 * do these steps manually if you need greater control.
4602 * The interval given in terms of monotonic time, not wall clock time.
4603 * See g_get_monotonic_time().
4605 * Returns: the ID (greater than 0) of the event source.
4606 * Rename to: g_timeout_add
4609 g_timeout_add_full (gint priority,
4611 GSourceFunc function,
4613 GDestroyNotify notify)
4618 g_return_val_if_fail (function != NULL, 0);
4620 source = g_timeout_source_new (interval);
4622 if (priority != G_PRIORITY_DEFAULT)
4623 g_source_set_priority (source, priority);
4625 g_source_set_callback (source, function, data, notify);
4626 id = g_source_attach (source, NULL);
4627 g_source_unref (source);
4634 * @interval: the time between calls to the function, in milliseconds
4635 * (1/1000ths of a second)
4636 * @function: function to call
4637 * @data: data to pass to @function
4639 * Sets a function to be called at regular intervals, with the default
4640 * priority, #G_PRIORITY_DEFAULT. The function is called repeatedly
4641 * until it returns %FALSE, at which point the timeout is automatically
4642 * destroyed and the function will not be called again. The first call
4643 * to the function will be at the end of the first @interval.
4645 * Note that timeout functions may be delayed, due to the processing of other
4646 * event sources. Thus they should not be relied on for precise timing.
4647 * After each call to the timeout function, the time of the next
4648 * timeout is recalculated based on the current time and the given interval
4649 * (it does not try to 'catch up' time lost in delays).
4651 * If you want to have a timer in the "seconds" range and do not care
4652 * about the exact time of the first call of the timer, use the
4653 * g_timeout_add_seconds() function; this function allows for more
4654 * optimizations and more efficient system power usage.
4656 * This internally creates a main loop source using g_timeout_source_new()
4657 * and attaches it to the main loop context using g_source_attach(). You can
4658 * do these steps manually if you need greater control.
4660 * The interval given is in terms of monotonic time, not wall clock
4661 * time. See g_get_monotonic_time().
4663 * Returns: the ID (greater than 0) of the event source.
4666 g_timeout_add (guint32 interval,
4667 GSourceFunc function,
4670 return g_timeout_add_full (G_PRIORITY_DEFAULT,
4671 interval, function, data, NULL);
4675 * g_timeout_add_seconds_full:
4676 * @priority: the priority of the timeout source. Typically this will be in
4677 * the range between #G_PRIORITY_DEFAULT and #G_PRIORITY_HIGH.
4678 * @interval: the time between calls to the function, in seconds
4679 * @function: function to call
4680 * @data: data to pass to @function
4681 * @notify: (allow-none): function to call when the timeout is removed, or %NULL
4683 * Sets a function to be called at regular intervals, with @priority.
4684 * The function is called repeatedly until it returns %FALSE, at which
4685 * point the timeout is automatically destroyed and the function will
4686 * not be called again.
4688 * Unlike g_timeout_add(), this function operates at whole second granularity.
4689 * The initial starting point of the timer is determined by the implementation
4690 * and the implementation is expected to group multiple timers together so that
4691 * they fire all at the same time.
4692 * To allow this grouping, the @interval to the first timer is rounded
4693 * and can deviate up to one second from the specified interval.
4694 * Subsequent timer iterations will generally run at the specified interval.
4696 * Note that timeout functions may be delayed, due to the processing of other
4697 * event sources. Thus they should not be relied on for precise timing.
4698 * After each call to the timeout function, the time of the next
4699 * timeout is recalculated based on the current time and the given @interval
4701 * If you want timing more precise than whole seconds, use g_timeout_add()
4704 * The grouping of timers to fire at the same time results in a more power
4705 * and CPU efficient behavior so if your timer is in multiples of seconds
4706 * and you don't require the first timer exactly one second from now, the
4707 * use of g_timeout_add_seconds() is preferred over g_timeout_add().
4709 * This internally creates a main loop source using
4710 * g_timeout_source_new_seconds() and attaches it to the main loop context
4711 * using g_source_attach(). You can do these steps manually if you need
4714 * The interval given is in terms of monotonic time, not wall clock
4715 * time. See g_get_monotonic_time().
4717 * Returns: the ID (greater than 0) of the event source.
4719 * Rename to: g_timeout_add_seconds
4723 g_timeout_add_seconds_full (gint priority,
4725 GSourceFunc function,
4727 GDestroyNotify notify)
4732 g_return_val_if_fail (function != NULL, 0);
4734 source = g_timeout_source_new_seconds (interval);
4736 if (priority != G_PRIORITY_DEFAULT)
4737 g_source_set_priority (source, priority);
4739 g_source_set_callback (source, function, data, notify);
4740 id = g_source_attach (source, NULL);
4741 g_source_unref (source);
4747 * g_timeout_add_seconds:
4748 * @interval: the time between calls to the function, in seconds
4749 * @function: function to call
4750 * @data: data to pass to @function
4752 * Sets a function to be called at regular intervals with the default
4753 * priority, #G_PRIORITY_DEFAULT. The function is called repeatedly until
4754 * it returns %FALSE, at which point the timeout is automatically destroyed
4755 * and the function will not be called again.
4757 * This internally creates a main loop source using
4758 * g_timeout_source_new_seconds() and attaches it to the main loop context
4759 * using g_source_attach(). You can do these steps manually if you need
4760 * greater control. Also see g_timeout_add_seconds_full().
4762 * Note that the first call of the timer may not be precise for timeouts
4763 * of one second. If you need finer precision and have such a timeout,
4764 * you may want to use g_timeout_add() instead.
4766 * The interval given is in terms of monotonic time, not wall clock
4767 * time. See g_get_monotonic_time().
4769 * Returns: the ID (greater than 0) of the event source.
4774 g_timeout_add_seconds (guint interval,
4775 GSourceFunc function,
4778 g_return_val_if_fail (function != NULL, 0);
4780 return g_timeout_add_seconds_full (G_PRIORITY_DEFAULT, interval, function, data, NULL);
4783 /* Child watch functions */
4788 g_child_watch_prepare (GSource *source,
4796 g_child_watch_check (GSource *source)
4798 GChildWatchSource *child_watch_source;
4799 gboolean child_exited;
4801 child_watch_source = (GChildWatchSource *) source;
4803 child_exited = child_watch_source->poll.revents & G_IO_IN;
4810 * Note: We do _not_ check for the special value of STILL_ACTIVE
4811 * since we know that the process has exited and doing so runs into
4812 * problems if the child process "happens to return STILL_ACTIVE(259)"
4813 * as Microsoft's Platform SDK puts it.
4815 if (!GetExitCodeProcess (child_watch_source->pid, &child_status))
4817 gchar *emsg = g_win32_error_message (GetLastError ());
4818 g_warning (G_STRLOC ": GetExitCodeProcess() failed: %s", emsg);
4821 child_watch_source->child_status = -1;
4824 child_watch_source->child_status = child_status;
4827 return child_exited;
4831 g_child_watch_finalize (GSource *source)
4835 #else /* G_OS_WIN32 */
4838 wake_source (GSource *source)
4840 GMainContext *context;
4842 /* This should be thread-safe:
4844 * - if the source is currently being added to a context, that
4845 * context will be woken up anyway
4847 * - if the source is currently being destroyed, we simply need not
4850 * - the memory for the source will remain valid until after the
4851 * source finalize function was called (which would remove the
4852 * source from the global list which we are currently holding the
4855 * - the GMainContext will either be NULL or point to a live
4858 * - the GMainContext will remain valid since we hold the
4859 * main_context_list lock
4861 * Since we are holding a lot of locks here, don't try to enter any
4862 * more GMainContext functions for fear of dealock -- just hit the
4863 * GWakeup and run. Even if that's safe now, it could easily become
4864 * unsafe with some very minor changes in the future, and signal
4865 * handling is not the most well-tested codepath.
4867 G_LOCK(main_context_list);
4868 context = source->context;
4870 g_wakeup_signal (context->wakeup);
4871 G_UNLOCK(main_context_list);
4875 dispatch_unix_signals_unlocked (void)
4877 gboolean pending[NSIG];
4881 /* clear this first incase another one arrives while we're processing */
4882 any_unix_signal_pending = FALSE;
4884 /* We atomically test/clear the bit from the global array in case
4885 * other signals arrive while we are dispatching.
4887 * We then can safely use our own array below without worrying about
4890 for (i = 0; i < NSIG; i++)
4892 /* Be very careful with (the volatile) unix_signal_pending.
4894 * We must ensure that it's not possible that we clear it without
4895 * handling the signal. We therefore must ensure that our pending
4896 * array has a field set (ie: we will do something about the
4897 * signal) before we clear the item in unix_signal_pending.
4899 * Note specifically: we must check _our_ array.
4901 pending[i] = unix_signal_pending[i];
4903 unix_signal_pending[i] = FALSE;
4906 /* handle GChildWatchSource instances */
4907 if (pending[SIGCHLD])
4909 /* The only way we can do this is to scan all of the children.
4911 * The docs promise that we will not reap children that we are not
4912 * explicitly watching, so that ties our hands from calling
4913 * waitpid(-1). We also can't use siginfo's si_pid field since if
4914 * multiple SIGCHLD arrive at the same time, one of them can be
4915 * dropped (since a given UNIX signal can only be pending once).
4917 for (node = unix_child_watches; node; node = node->next)
4919 GChildWatchSource *source = node->data;
4921 if (!source->child_exited)
4926 g_assert (source->pid > 0);
4928 pid = waitpid (source->pid, &source->child_status, WNOHANG);
4931 source->child_exited = TRUE;
4932 wake_source ((GSource *) source);
4934 else if (pid == -1 && errno == ECHILD)
4936 g_warning ("GChildWatchSource: Exit status of a child process was requested but ECHILD was received by waitpid(). Most likely the process is ignoring SIGCHLD, or some other thread is invoking waitpid() with a nonpositive first argument; either behavior can break applications that use g_child_watch_add()/g_spawn_sync() either directly or indirectly.");
4937 source->child_exited = TRUE;
4938 source->child_status = 0;
4939 wake_source ((GSource *) source);
4942 while (pid == -1 && errno == EINTR);
4947 /* handle GUnixSignalWatchSource instances */
4948 for (node = unix_signal_watches; node; node = node->next)
4950 GUnixSignalWatchSource *source = node->data;
4952 if (!source->pending)
4954 if (pending[source->signum])
4956 source->pending = TRUE;
4958 wake_source ((GSource *) source);
4966 dispatch_unix_signals (void)
4968 G_LOCK(unix_signal_lock);
4969 dispatch_unix_signals_unlocked ();
4970 G_UNLOCK(unix_signal_lock);
4974 g_child_watch_prepare (GSource *source,
4977 GChildWatchSource *child_watch_source;
4979 child_watch_source = (GChildWatchSource *) source;
4981 return child_watch_source->child_exited;
4985 g_child_watch_check (GSource *source)
4987 GChildWatchSource *child_watch_source;
4989 child_watch_source = (GChildWatchSource *) source;
4991 return child_watch_source->child_exited;
4995 g_unix_signal_watch_prepare (GSource *source,
4998 GUnixSignalWatchSource *unix_signal_source;
5000 unix_signal_source = (GUnixSignalWatchSource *) source;
5002 return unix_signal_source->pending;
5006 g_unix_signal_watch_check (GSource *source)
5008 GUnixSignalWatchSource *unix_signal_source;
5010 unix_signal_source = (GUnixSignalWatchSource *) source;
5012 return unix_signal_source->pending;
5016 g_unix_signal_watch_dispatch (GSource *source,
5017 GSourceFunc callback,
5020 GUnixSignalWatchSource *unix_signal_source;
5023 unix_signal_source = (GUnixSignalWatchSource *) source;
5027 g_warning ("Unix signal source dispatched without callback\n"
5028 "You must call g_source_set_callback().");
5032 again = (callback) (user_data);
5034 unix_signal_source->pending = FALSE;
5040 ref_unix_signal_handler_unlocked (int signum)
5042 /* Ensure we have the worker context */
5043 g_get_worker_context ();
5044 unix_signal_refcount[signum]++;
5045 if (unix_signal_refcount[signum] == 1)
5047 struct sigaction action;
5048 action.sa_handler = g_unix_signal_handler;
5049 sigemptyset (&action.sa_mask);
5051 action.sa_flags = SA_RESTART | SA_NOCLDSTOP;
5053 action.sa_flags = SA_NOCLDSTOP;
5055 sigaction (signum, &action, NULL);
5060 unref_unix_signal_handler_unlocked (int signum)
5062 unix_signal_refcount[signum]--;
5063 if (unix_signal_refcount[signum] == 0)
5065 struct sigaction action;
5066 memset (&action, 0, sizeof (action));
5067 action.sa_handler = SIG_DFL;
5068 sigemptyset (&action.sa_mask);
5069 sigaction (signum, &action, NULL);
5074 _g_main_create_unix_signal_watch (int signum)
5077 GUnixSignalWatchSource *unix_signal_source;
5079 source = g_source_new (&g_unix_signal_funcs, sizeof (GUnixSignalWatchSource));
5080 unix_signal_source = (GUnixSignalWatchSource *) source;
5082 unix_signal_source->signum = signum;
5083 unix_signal_source->pending = FALSE;
5085 G_LOCK (unix_signal_lock);
5086 ref_unix_signal_handler_unlocked (signum);
5087 unix_signal_watches = g_slist_prepend (unix_signal_watches, unix_signal_source);
5088 dispatch_unix_signals_unlocked ();
5089 G_UNLOCK (unix_signal_lock);
5095 g_unix_signal_watch_finalize (GSource *source)
5097 GUnixSignalWatchSource *unix_signal_source;
5099 unix_signal_source = (GUnixSignalWatchSource *) source;
5101 G_LOCK (unix_signal_lock);
5102 unref_unix_signal_handler_unlocked (unix_signal_source->signum);
5103 unix_signal_watches = g_slist_remove (unix_signal_watches, source);
5104 G_UNLOCK (unix_signal_lock);
5108 g_child_watch_finalize (GSource *source)
5110 G_LOCK (unix_signal_lock);
5111 unix_child_watches = g_slist_remove (unix_child_watches, source);
5112 unref_unix_signal_handler_unlocked (SIGCHLD);
5113 G_UNLOCK (unix_signal_lock);
5116 #endif /* G_OS_WIN32 */
5119 g_child_watch_dispatch (GSource *source,
5120 GSourceFunc callback,
5123 GChildWatchSource *child_watch_source;
5124 GChildWatchFunc child_watch_callback = (GChildWatchFunc) callback;
5126 child_watch_source = (GChildWatchSource *) source;
5130 g_warning ("Child watch source dispatched without callback\n"
5131 "You must call g_source_set_callback().");
5135 (child_watch_callback) (child_watch_source->pid, child_watch_source->child_status, user_data);
5137 /* We never keep a child watch source around as the child is gone */
5144 g_unix_signal_handler (int signum)
5146 unix_signal_pending[signum] = TRUE;
5147 any_unix_signal_pending = TRUE;
5149 g_wakeup_signal (glib_worker_context->wakeup);
5152 #endif /* !G_OS_WIN32 */
5155 * g_child_watch_source_new:
5156 * @pid: process to watch. On POSIX the positive pid of a child process. On
5157 * Windows a handle for a process (which doesn't have to be a child).
5159 * Creates a new child_watch source.
5161 * The source will not initially be associated with any #GMainContext
5162 * and must be added to one with g_source_attach() before it will be
5165 * Note that child watch sources can only be used in conjunction with
5166 * `g_spawn...` when the %G_SPAWN_DO_NOT_REAP_CHILD flag is used.
5168 * Note that on platforms where #GPid must be explicitly closed
5169 * (see g_spawn_close_pid()) @pid must not be closed while the
5170 * source is still active. Typically, you will want to call
5171 * g_spawn_close_pid() in the callback function for the source.
5173 * Note further that using g_child_watch_source_new() is not
5174 * compatible with calling `waitpid` with a nonpositive first
5175 * argument in the application. Calling waitpid() for individual
5176 * pids will still work fine.
5178 * Similarly, on POSIX platforms, the @pid passed to this function must
5179 * be greater than 0 (i.e. this function must wait for a specific child,
5180 * and cannot wait for one of many children by using a nonpositive argument).
5182 * Returns: the newly-created child watch source
5187 g_child_watch_source_new (GPid pid)
5190 GChildWatchSource *child_watch_source;
5193 g_return_val_if_fail (pid > 0, NULL);
5196 source = g_source_new (&g_child_watch_funcs, sizeof (GChildWatchSource));
5197 child_watch_source = (GChildWatchSource *)source;
5199 child_watch_source->pid = pid;
5202 child_watch_source->poll.fd = (gintptr) pid;
5203 child_watch_source->poll.events = G_IO_IN;
5205 g_source_add_poll (source, &child_watch_source->poll);
5206 #else /* G_OS_WIN32 */
5207 G_LOCK (unix_signal_lock);
5208 ref_unix_signal_handler_unlocked (SIGCHLD);
5209 unix_child_watches = g_slist_prepend (unix_child_watches, child_watch_source);
5210 if (waitpid (pid, &child_watch_source->child_status, WNOHANG) > 0)
5211 child_watch_source->child_exited = TRUE;
5212 G_UNLOCK (unix_signal_lock);
5213 #endif /* G_OS_WIN32 */
5219 * g_child_watch_add_full:
5220 * @priority: the priority of the idle source. Typically this will be in the
5221 * range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE.
5222 * @pid: process to watch. On POSIX the positive pid of a child process. On
5223 * Windows a handle for a process (which doesn't have to be a child).
5224 * @function: function to call
5225 * @data: data to pass to @function
5226 * @notify: (allow-none): function to call when the idle is removed, or %NULL
5228 * Sets a function to be called when the child indicated by @pid
5229 * exits, at the priority @priority.
5231 * If you obtain @pid from g_spawn_async() or g_spawn_async_with_pipes()
5232 * you will need to pass #G_SPAWN_DO_NOT_REAP_CHILD as flag to
5233 * the spawn function for the child watching to work.
5235 * In many programs, you will want to call g_spawn_check_exit_status()
5236 * in the callback to determine whether or not the child exited
5239 * Also, note that on platforms where #GPid must be explicitly closed
5240 * (see g_spawn_close_pid()) @pid must not be closed while the source
5241 * is still active. Typically, you should invoke g_spawn_close_pid()
5242 * in the callback function for the source.
5244 * GLib supports only a single callback per process id.
5246 * This internally creates a main loop source using
5247 * g_child_watch_source_new() and attaches it to the main loop context
5248 * using g_source_attach(). You can do these steps manually if you
5249 * need greater control.
5251 * Returns: the ID (greater than 0) of the event source.
5253 * Rename to: g_child_watch_add
5257 g_child_watch_add_full (gint priority,
5259 GChildWatchFunc function,
5261 GDestroyNotify notify)
5266 g_return_val_if_fail (function != NULL, 0);
5268 g_return_val_if_fail (pid > 0, 0);
5271 source = g_child_watch_source_new (pid);
5273 if (priority != G_PRIORITY_DEFAULT)
5274 g_source_set_priority (source, priority);
5276 g_source_set_callback (source, (GSourceFunc) function, data, notify);
5277 id = g_source_attach (source, NULL);
5278 g_source_unref (source);
5284 * g_child_watch_add:
5285 * @pid: process id to watch. On POSIX the positive pid of a child
5286 * process. On Windows a handle for a process (which doesn't have to be
5288 * @function: function to call
5289 * @data: data to pass to @function
5291 * Sets a function to be called when the child indicated by @pid
5292 * exits, at a default priority, #G_PRIORITY_DEFAULT.
5294 * If you obtain @pid from g_spawn_async() or g_spawn_async_with_pipes()
5295 * you will need to pass #G_SPAWN_DO_NOT_REAP_CHILD as flag to
5296 * the spawn function for the child watching to work.
5298 * Note that on platforms where #GPid must be explicitly closed
5299 * (see g_spawn_close_pid()) @pid must not be closed while the
5300 * source is still active. Typically, you will want to call
5301 * g_spawn_close_pid() in the callback function for the source.
5303 * GLib supports only a single callback per process id.
5305 * This internally creates a main loop source using
5306 * g_child_watch_source_new() and attaches it to the main loop context
5307 * using g_source_attach(). You can do these steps manually if you
5308 * need greater control.
5310 * Returns: the ID (greater than 0) of the event source.
5315 g_child_watch_add (GPid pid,
5316 GChildWatchFunc function,
5319 return g_child_watch_add_full (G_PRIORITY_DEFAULT, pid, function, data, NULL);
5323 /* Idle functions */
5326 g_idle_prepare (GSource *source,
5335 g_idle_check (GSource *source)
5341 g_idle_dispatch (GSource *source,
5342 GSourceFunc callback,
5347 g_warning ("Idle source dispatched without callback\n"
5348 "You must call g_source_set_callback().");
5352 return callback (user_data);
5356 * g_idle_source_new:
5358 * Creates a new idle source.
5360 * The source will not initially be associated with any #GMainContext
5361 * and must be added to one with g_source_attach() before it will be
5362 * executed. Note that the default priority for idle sources is
5363 * %G_PRIORITY_DEFAULT_IDLE, as compared to other sources which
5364 * have a default priority of %G_PRIORITY_DEFAULT.
5366 * Returns: the newly-created idle source
5369 g_idle_source_new (void)
5373 source = g_source_new (&g_idle_funcs, sizeof (GSource));
5374 g_source_set_priority (source, G_PRIORITY_DEFAULT_IDLE);
5381 * @priority: the priority of the idle source. Typically this will be in the
5382 * range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE.
5383 * @function: function to call
5384 * @data: data to pass to @function
5385 * @notify: (allow-none): function to call when the idle is removed, or %NULL
5387 * Adds a function to be called whenever there are no higher priority
5388 * events pending. If the function returns %FALSE it is automatically
5389 * removed from the list of event sources and will not be called again.
5391 * This internally creates a main loop source using g_idle_source_new()
5392 * and attaches it to the main loop context using g_source_attach().
5393 * You can do these steps manually if you need greater control.
5395 * Returns: the ID (greater than 0) of the event source.
5396 * Rename to: g_idle_add
5399 g_idle_add_full (gint priority,
5400 GSourceFunc function,
5402 GDestroyNotify notify)
5407 g_return_val_if_fail (function != NULL, 0);
5409 source = g_idle_source_new ();
5411 if (priority != G_PRIORITY_DEFAULT_IDLE)
5412 g_source_set_priority (source, priority);
5414 g_source_set_callback (source, function, data, notify);
5415 id = g_source_attach (source, NULL);
5416 g_source_unref (source);
5423 * @function: function to call
5424 * @data: data to pass to @function.
5426 * Adds a function to be called whenever there are no higher priority
5427 * events pending to the default main loop. The function is given the
5428 * default idle priority, #G_PRIORITY_DEFAULT_IDLE. If the function
5429 * returns %FALSE it is automatically removed from the list of event
5430 * sources and will not be called again.
5432 * This internally creates a main loop source using g_idle_source_new()
5433 * and attaches it to the main loop context using g_source_attach().
5434 * You can do these steps manually if you need greater control.
5436 * Returns: the ID (greater than 0) of the event source.
5439 g_idle_add (GSourceFunc function,
5442 return g_idle_add_full (G_PRIORITY_DEFAULT_IDLE, function, data, NULL);
5446 * g_idle_remove_by_data:
5447 * @data: the data for the idle source's callback.
5449 * Removes the idle function with the given data.
5451 * Returns: %TRUE if an idle source was found and removed.
5454 g_idle_remove_by_data (gpointer data)
5456 return g_source_remove_by_funcs_user_data (&g_idle_funcs, data);
5460 * g_main_context_invoke:
5461 * @context: (allow-none): a #GMainContext, or %NULL
5462 * @function: function to call
5463 * @data: data to pass to @function
5465 * Invokes a function in such a way that @context is owned during the
5466 * invocation of @function.
5468 * If @context is %NULL then the global default main context — as
5469 * returned by g_main_context_default() — is used.
5471 * If @context is owned by the current thread, @function is called
5472 * directly. Otherwise, if @context is the thread-default main context
5473 * of the current thread and g_main_context_acquire() succeeds, then
5474 * @function is called and g_main_context_release() is called
5477 * In any other case, an idle source is created to call @function and
5478 * that source is attached to @context (presumably to be run in another
5479 * thread). The idle source is attached with #G_PRIORITY_DEFAULT
5480 * priority. If you want a different priority, use
5481 * g_main_context_invoke_full().
5483 * Note that, as with normal idle functions, @function should probably
5484 * return %FALSE. If it returns %TRUE, it will be continuously run in a
5485 * loop (and may prevent this call from returning).
5490 g_main_context_invoke (GMainContext *context,
5491 GSourceFunc function,
5494 g_main_context_invoke_full (context,
5496 function, data, NULL);
5500 * g_main_context_invoke_full:
5501 * @context: (allow-none): a #GMainContext, or %NULL
5502 * @priority: the priority at which to run @function
5503 * @function: function to call
5504 * @data: data to pass to @function
5505 * @notify: (allow-none): a function to call when @data is no longer in use, or %NULL.
5507 * Invokes a function in such a way that @context is owned during the
5508 * invocation of @function.
5510 * This function is the same as g_main_context_invoke() except that it
5511 * lets you specify the priority incase @function ends up being
5512 * scheduled as an idle and also lets you give a #GDestroyNotify for @data.
5514 * @notify should not assume that it is called from any particular
5515 * thread or with any particular context acquired.
5520 g_main_context_invoke_full (GMainContext *context,
5522 GSourceFunc function,
5524 GDestroyNotify notify)
5526 g_return_if_fail (function != NULL);
5529 context = g_main_context_default ();
5531 if (g_main_context_is_owner (context))
5533 while (function (data));
5540 GMainContext *thread_default;
5542 thread_default = g_main_context_get_thread_default ();
5544 if (!thread_default)
5545 thread_default = g_main_context_default ();
5547 if (thread_default == context && g_main_context_acquire (context))
5549 while (function (data));
5551 g_main_context_release (context);
5560 source = g_idle_source_new ();
5561 g_source_set_priority (source, priority);
5562 g_source_set_callback (source, function, data, notify);
5563 g_source_attach (source, context);
5564 g_source_unref (source);
5570 glib_worker_main (gpointer data)
5574 g_main_context_iteration (glib_worker_context, TRUE);
5577 if (any_unix_signal_pending)
5578 dispatch_unix_signals ();
5582 return NULL; /* worst GCC warning message ever... */
5586 g_get_worker_context (void)
5588 static gsize initialised;
5590 if (g_once_init_enter (&initialised))
5592 /* mask all signals in the worker thread */
5598 pthread_sigmask (SIG_SETMASK, &all, &prev_mask);
5600 glib_worker_context = g_main_context_new ();
5601 g_thread_new ("gmain", glib_worker_main, NULL);
5603 pthread_sigmask (SIG_SETMASK, &prev_mask, NULL);
5605 g_once_init_leave (&initialised, TRUE);
5608 return glib_worker_context;