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, write to the
19 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, USA.
24 * Modified by the GLib Team and others 1997-2000. See the AUTHORS
25 * file for a list of people on the GLib Team. See the ChangeLog
26 * files for a list of changes. These files are distributed with
27 * GLib at ftp://ftp.gtk.org/pub/gtk/.
35 #include "glibconfig.h"
37 /* Uncomment the next line (and the corresponding line in gpoll.c) to
38 * enable debugging printouts if the environment variable
39 * G_MAIN_POLL_DEBUG is set to some value.
41 /* #define G_MAIN_POLL_DEBUG */
44 /* Always enable debugging printout on Windows, as it is more often
47 #define G_MAIN_POLL_DEBUG
51 #include "glib-unix.h"
53 #include <sys/eventfd.h>
58 #include <sys/types.h>
61 #ifdef HAVE_SYS_TIME_H
63 #endif /* HAVE_SYS_TIME_H */
66 #endif /* HAVE_UNISTD_H */
73 #endif /* G_OS_WIN32 */
76 #include <sys/socket.h>
78 #endif /* G_OS_BEOS */
83 #include "giochannel.h"
87 #include "gstrfuncs.h"
88 #include "gtestutils.h"
89 #include "gthreadprivate.h"
95 #ifdef G_MAIN_POLL_DEBUG
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 * <refsect2><title>Creating new source types</title>
144 * <para>One of the unusual features of the #GMainLoop functionality
145 * is that new types of event source can be created and used in
146 * addition to the builtin type of event source. A new event source
147 * type is used for handling GDK events. A new source type is created
148 * by <firstterm>deriving</firstterm> from the #GSource structure.
149 * The derived type of source is represented by a structure that has
150 * the #GSource structure as a first element, and other elements specific
151 * to the new source type. To create an instance of the new source type,
152 * call g_source_new() passing in the size of the derived structure and
153 * a table of functions. These #GSourceFuncs determine the behavior of
154 * the new source type.</para>
155 * <para>New source types basically interact with the main context
156 * in two ways. Their prepare function in #GSourceFuncs can set a timeout
157 * to determine the maximum amount of time that the main loop will sleep
158 * before checking the source again. In addition, or as well, the source
159 * can add file descriptors to the set that the main context checks using
160 * g_source_add_poll().</para>
162 * <refsect2><title>Customizing the main loop iteration</title>
163 * <para>Single iterations of a #GMainContext can be run with
164 * g_main_context_iteration(). In some cases, more detailed control
165 * of exactly how the details of the main loop work is desired, for
166 * instance, when integrating the #GMainLoop with an external main loop.
167 * In such cases, you can call the component functions of
168 * g_main_context_iteration() directly. These functions are
169 * g_main_context_prepare(), g_main_context_query(),
170 * g_main_context_check() and g_main_context_dispatch().</para>
171 * <para>The operation of these functions can best be seen in terms
172 * of a state diagram, as shown in <xref linkend="mainloop-states"/>.</para>
173 * <figure id="mainloop-states"><title>States of a Main Context</title>
174 * <graphic fileref="mainloop-states.gif" format="GIF"></graphic>
181 typedef struct _GTimeoutSource GTimeoutSource;
182 typedef struct _GChildWatchSource GChildWatchSource;
183 typedef struct _GUnixSignalWatchSource GUnixSignalWatchSource;
184 typedef struct _GPollRec GPollRec;
185 typedef struct _GSourceCallback GSourceCallback;
189 G_SOURCE_READY = 1 << G_HOOK_FLAG_USER_SHIFT,
190 G_SOURCE_CAN_RECURSE = 1 << (G_HOOK_FLAG_USER_SHIFT + 1)
193 typedef struct _GMainWaiter GMainWaiter;
201 typedef struct _GMainDispatch GMainDispatch;
203 struct _GMainDispatch
206 GSList *dispatching_sources; /* stack of current sources */
209 #ifdef G_MAIN_POLL_DEBUG
210 gboolean _g_main_poll_debug = FALSE;
215 /* The following lock is used for both the list of sources
216 * and the list of poll records
226 GPtrArray *pending_dispatches;
227 gint timeout; /* Timeout for current iteration */
230 GSource *source_list;
231 gint in_check_or_prepare;
233 GPollRec *poll_records, *poll_records_tail;
234 guint n_poll_records;
235 GPollFD *cached_poll_array;
236 guint cached_poll_array_size;
241 gboolean poll_waiting;
243 /* Flag indicating whether the set of fd's changed during a poll */
244 gboolean poll_changed;
249 gboolean time_is_fresh;
252 struct _GSourceCallback
257 GDestroyNotify notify;
262 GMainContext *context;
267 struct _GTimeoutSource
275 struct _GChildWatchSource
282 #else /* G_OS_WIN32 */
283 gboolean child_exited;
284 #endif /* G_OS_WIN32 */
287 struct _GUnixSignalWatchSource
302 struct _GSourcePrivate
304 GSList *child_sources;
305 GSource *parent_source;
308 #define LOCK_CONTEXT(context) g_static_mutex_lock (&context->mutex)
309 #define UNLOCK_CONTEXT(context) g_static_mutex_unlock (&context->mutex)
310 #define G_THREAD_SELF g_thread_self ()
312 #define SOURCE_DESTROYED(source) (((source)->flags & G_HOOK_FLAG_ACTIVE) == 0)
313 #define SOURCE_BLOCKED(source) (((source)->flags & G_HOOK_FLAG_IN_CALL) != 0 && \
314 ((source)->flags & G_SOURCE_CAN_RECURSE) == 0)
316 #define SOURCE_UNREF(source, context) \
318 if ((source)->ref_count > 1) \
319 (source)->ref_count--; \
321 g_source_unref_internal ((source), (context), TRUE); \
325 /* Forward declarations */
327 static void g_source_unref_internal (GSource *source,
328 GMainContext *context,
330 static void g_source_destroy_internal (GSource *source,
331 GMainContext *context,
333 static void g_source_set_priority_unlocked (GSource *source,
334 GMainContext *context,
336 static void g_main_context_poll (GMainContext *context,
341 static void g_main_context_add_poll_unlocked (GMainContext *context,
344 static void g_main_context_remove_poll_unlocked (GMainContext *context,
346 static void g_main_context_wakeup_unlocked (GMainContext *context);
348 static gboolean g_timeout_prepare (GSource *source,
350 static gboolean g_timeout_check (GSource *source);
351 static gboolean g_timeout_dispatch (GSource *source,
352 GSourceFunc callback,
354 static gboolean g_child_watch_prepare (GSource *source,
356 static gboolean g_child_watch_check (GSource *source);
357 static gboolean g_child_watch_dispatch (GSource *source,
358 GSourceFunc callback,
360 static void g_child_watch_finalize (GSource *source);
362 static void g_unix_signal_handler (int signum);
363 static gboolean g_unix_signal_watch_prepare (GSource *source,
365 static gboolean g_unix_signal_watch_check (GSource *source);
366 static gboolean g_unix_signal_watch_dispatch (GSource *source,
367 GSourceFunc callback,
369 static void g_unix_signal_watch_finalize (GSource *source);
371 static gboolean g_idle_prepare (GSource *source,
373 static gboolean g_idle_check (GSource *source);
374 static gboolean g_idle_dispatch (GSource *source,
375 GSourceFunc callback,
378 static GMainContext *glib_worker_context;
380 G_LOCK_DEFINE_STATIC (main_loop);
381 static GMainContext *default_main_context;
386 /* UNIX signals work by marking one of these variables then waking the
387 * worker context to check on them and dispatch accordingly.
389 static volatile gchar unix_signal_pending[NSIG];
390 static volatile gboolean any_unix_signal_pending;
392 /* Guards all the data below */
393 G_LOCK_DEFINE_STATIC (unix_signal_lock);
394 static GSList *unix_signal_watches;
395 static GSList *unix_child_watches;
397 static GSourceFuncs g_unix_signal_funcs =
399 g_unix_signal_watch_prepare,
400 g_unix_signal_watch_check,
401 g_unix_signal_watch_dispatch,
402 g_unix_signal_watch_finalize
404 #endif /* !G_OS_WIN32 */
405 G_LOCK_DEFINE_STATIC (main_context_list);
406 static GSList *main_context_list = NULL;
408 GSourceFuncs g_timeout_funcs =
416 GSourceFuncs g_child_watch_funcs =
418 g_child_watch_prepare,
420 g_child_watch_dispatch,
421 g_child_watch_finalize
424 GSourceFuncs g_idle_funcs =
433 * g_main_context_ref:
434 * @context: a #GMainContext
436 * Increases the reference count on a #GMainContext object by one.
438 * Returns: the @context that was passed in (since 2.6)
441 g_main_context_ref (GMainContext *context)
443 g_return_val_if_fail (context != NULL, NULL);
444 g_return_val_if_fail (g_atomic_int_get (&context->ref_count) > 0, NULL);
446 g_atomic_int_inc (&context->ref_count);
452 poll_rec_list_free (GMainContext *context,
455 g_slice_free_chain (GPollRec, list, next);
459 * g_main_context_unref:
460 * @context: a #GMainContext
462 * Decreases the reference count on a #GMainContext object by one. If
463 * the result is zero, free the context and free all associated memory.
466 g_main_context_unref (GMainContext *context)
469 g_return_if_fail (context != NULL);
470 g_return_if_fail (g_atomic_int_get (&context->ref_count) > 0);
472 if (!g_atomic_int_dec_and_test (&context->ref_count))
475 G_LOCK (main_context_list);
476 main_context_list = g_slist_remove (main_context_list, context);
477 G_UNLOCK (main_context_list);
479 source = context->source_list;
482 GSource *next = source->next;
483 g_source_destroy_internal (source, context, FALSE);
487 g_static_mutex_free (&context->mutex);
489 g_ptr_array_free (context->pending_dispatches, TRUE);
490 g_free (context->cached_poll_array);
492 poll_rec_list_free (context, context->poll_records);
494 g_wakeup_free (context->wakeup);
496 if (context->cond != NULL)
497 g_cond_free (context->cond);
503 g_main_context_init_pipe (GMainContext *context)
505 context->wakeup = g_wakeup_new ();
506 g_wakeup_get_pollfd (context->wakeup, &context->wake_up_rec);
507 g_main_context_add_poll_unlocked (context, 0, &context->wake_up_rec);
511 * g_main_context_new:
513 * Creates a new #GMainContext structure.
515 * Return value: the new #GMainContext
518 g_main_context_new (void)
520 GMainContext *context;
522 g_thread_init_glib ();
524 context = g_new0 (GMainContext, 1);
526 #ifdef G_MAIN_POLL_DEBUG
528 static gboolean beenhere = FALSE;
532 if (getenv ("G_MAIN_POLL_DEBUG") != NULL)
533 _g_main_poll_debug = TRUE;
539 g_static_mutex_init (&context->mutex);
541 context->owner = NULL;
542 context->waiters = NULL;
544 context->ref_count = 1;
546 context->next_id = 1;
548 context->source_list = NULL;
550 context->poll_func = g_poll;
552 context->cached_poll_array = NULL;
553 context->cached_poll_array_size = 0;
555 context->pending_dispatches = g_ptr_array_new ();
557 context->time_is_fresh = FALSE;
559 g_main_context_init_pipe (context);
561 G_LOCK (main_context_list);
562 main_context_list = g_slist_append (main_context_list, context);
564 #ifdef G_MAIN_POLL_DEBUG
565 if (_g_main_poll_debug)
566 g_print ("created context=%p\n", context);
569 G_UNLOCK (main_context_list);
575 * g_main_context_default:
577 * Returns the global default main context. This is the main context
578 * used for main loop functions when a main loop is not explicitly
579 * specified, and corresponds to the "main" main loop. See also
580 * g_main_context_get_thread_default().
582 * Return value: (transfer none): the global default main context.
585 g_main_context_default (void)
591 if (!default_main_context)
593 default_main_context = g_main_context_new ();
594 #ifdef G_MAIN_POLL_DEBUG
595 if (_g_main_poll_debug)
596 g_print ("default context=%p\n", default_main_context);
600 G_UNLOCK (main_loop);
602 return default_main_context;
605 static GStaticPrivate thread_context_stack = G_STATIC_PRIVATE_INIT;
608 free_context_stack (gpointer data)
610 GQueue *stack = data;
611 GMainContext *context;
613 while (!g_queue_is_empty (stack))
615 context = g_queue_pop_head (stack);
616 g_main_context_release (context);
618 g_main_context_unref (context);
620 g_queue_free (stack);
624 * g_main_context_push_thread_default:
625 * @context: a #GMainContext, or %NULL for the global default context
627 * Acquires @context and sets it as the thread-default context for the
628 * current thread. This will cause certain asynchronous operations
629 * (such as most <link linkend="gio">gio</link>-based I/O) which are
630 * started in this thread to run under @context and deliver their
631 * results to its main loop, rather than running under the global
632 * default context in the main thread. Note that calling this function
633 * changes the context returned by
634 * g_main_context_get_thread_default(), <emphasis>not</emphasis> the
635 * one returned by g_main_context_default(), so it does not affect the
636 * context used by functions like g_idle_add().
638 * Normally you would call this function shortly after creating a new
639 * thread, passing it a #GMainContext which will be run by a
640 * #GMainLoop in that thread, to set a new default context for all
641 * async operations in that thread. (In this case, you don't need to
642 * ever call g_main_context_pop_thread_default().) In some cases
643 * however, you may want to schedule a single operation in a
644 * non-default context, or temporarily use a non-default context in
645 * the main thread. In that case, you can wrap the call to the
646 * asynchronous operation inside a
647 * g_main_context_push_thread_default() /
648 * g_main_context_pop_thread_default() pair, but it is up to you to
649 * ensure that no other asynchronous operations accidentally get
650 * started while the non-default context is active.
652 * Beware that libraries that predate this function may not correctly
653 * handle being used from a thread with a thread-default context. Eg,
654 * see g_file_supports_thread_contexts().
659 g_main_context_push_thread_default (GMainContext *context)
662 gboolean acquired_context;
664 acquired_context = g_main_context_acquire (context);
665 g_return_if_fail (acquired_context);
667 if (context == g_main_context_default ())
670 g_main_context_ref (context);
672 stack = g_static_private_get (&thread_context_stack);
675 stack = g_queue_new ();
676 g_static_private_set (&thread_context_stack, stack,
680 g_queue_push_head (stack, context);
684 * g_main_context_pop_thread_default:
685 * @context: a #GMainContext object, or %NULL
687 * Pops @context off the thread-default context stack (verifying that
688 * it was on the top of the stack).
693 g_main_context_pop_thread_default (GMainContext *context)
697 if (context == g_main_context_default ())
700 stack = g_static_private_get (&thread_context_stack);
702 g_return_if_fail (stack != NULL);
703 g_return_if_fail (g_queue_peek_head (stack) == context);
705 g_queue_pop_head (stack);
707 g_main_context_release (context);
709 g_main_context_unref (context);
713 * g_main_context_get_thread_default:
715 * Gets the thread-default #GMainContext for this thread. Asynchronous
716 * operations that want to be able to be run in contexts other than
717 * the default one should call this method to get a #GMainContext to
718 * add their #GSource<!-- -->s to. (Note that even in single-threaded
719 * programs applications may sometimes want to temporarily push a
720 * non-default context, so it is not safe to assume that this will
721 * always return %NULL if threads are not initialized.)
723 * Returns: (transfer none): the thread-default #GMainContext, or
724 * %NULL if the thread-default context is the global default context.
729 g_main_context_get_thread_default (void)
733 stack = g_static_private_get (&thread_context_stack);
735 return g_queue_peek_head (stack);
740 /* Hooks for adding to the main loop */
744 * @source_funcs: structure containing functions that implement
745 * the sources behavior.
746 * @struct_size: size of the #GSource structure to create.
748 * Creates a new #GSource structure. The size is specified to
749 * allow creating structures derived from #GSource that contain
750 * additional data. The size passed in must be at least
751 * <literal>sizeof (GSource)</literal>.
753 * The source will not initially be associated with any #GMainContext
754 * and must be added to one with g_source_attach() before it will be
757 * Return value: the newly-created #GSource.
760 g_source_new (GSourceFuncs *source_funcs,
765 g_return_val_if_fail (source_funcs != NULL, NULL);
766 g_return_val_if_fail (struct_size >= sizeof (GSource), NULL);
768 source = (GSource*) g_malloc0 (struct_size);
770 source->source_funcs = source_funcs;
771 source->ref_count = 1;
773 source->priority = G_PRIORITY_DEFAULT;
775 source->flags = G_HOOK_FLAG_ACTIVE;
777 /* NULL/0 initialization for all other fields */
782 /* Holds context's lock
785 g_source_list_add (GSource *source,
786 GMainContext *context)
788 GSource *tmp_source, *last_source;
790 if (source->priv && source->priv->parent_source)
792 /* Put the source immediately before its parent */
793 tmp_source = source->priv->parent_source;
794 last_source = source->priv->parent_source->prev;
799 tmp_source = context->source_list;
800 while (tmp_source && tmp_source->priority <= source->priority)
802 last_source = tmp_source;
803 tmp_source = tmp_source->next;
807 source->next = tmp_source;
809 tmp_source->prev = source;
811 source->prev = last_source;
813 last_source->next = source;
815 context->source_list = source;
818 /* Holds context's lock
821 g_source_list_remove (GSource *source,
822 GMainContext *context)
825 source->prev->next = source->next;
827 context->source_list = source->next;
830 source->next->prev = source->prev;
837 g_source_attach_unlocked (GSource *source,
838 GMainContext *context)
843 source->context = context;
844 result = source->source_id = context->next_id++;
847 g_source_list_add (source, context);
849 tmp_list = source->poll_fds;
852 g_main_context_add_poll_unlocked (context, source->priority, tmp_list->data);
853 tmp_list = tmp_list->next;
858 tmp_list = source->priv->child_sources;
861 g_source_attach_unlocked (tmp_list->data, context);
862 tmp_list = tmp_list->next;
871 * @source: a #GSource
872 * @context: a #GMainContext (if %NULL, the default context will be used)
874 * Adds a #GSource to a @context so that it will be executed within
875 * that context. Remove it by calling g_source_destroy().
877 * Return value: the ID (greater than 0) for the source within the
881 g_source_attach (GSource *source,
882 GMainContext *context)
886 g_return_val_if_fail (source->context == NULL, 0);
887 g_return_val_if_fail (!SOURCE_DESTROYED (source), 0);
890 context = g_main_context_default ();
892 LOCK_CONTEXT (context);
894 result = g_source_attach_unlocked (source, context);
896 /* Now wake up the main loop if it is waiting in the poll() */
897 g_main_context_wakeup_unlocked (context);
899 UNLOCK_CONTEXT (context);
905 g_source_destroy_internal (GSource *source,
906 GMainContext *context,
910 LOCK_CONTEXT (context);
912 if (!SOURCE_DESTROYED (source))
915 gpointer old_cb_data;
916 GSourceCallbackFuncs *old_cb_funcs;
918 source->flags &= ~G_HOOK_FLAG_ACTIVE;
920 old_cb_data = source->callback_data;
921 old_cb_funcs = source->callback_funcs;
923 source->callback_data = NULL;
924 source->callback_funcs = NULL;
928 UNLOCK_CONTEXT (context);
929 old_cb_funcs->unref (old_cb_data);
930 LOCK_CONTEXT (context);
933 if (!SOURCE_BLOCKED (source))
935 tmp_list = source->poll_fds;
938 g_main_context_remove_poll_unlocked (context, tmp_list->data);
939 tmp_list = tmp_list->next;
943 if (source->priv && source->priv->child_sources)
945 /* This is safe because even if a child_source finalizer or
946 * closure notify tried to modify source->priv->child_sources
947 * from outside the lock, it would fail since
948 * SOURCE_DESTROYED(source) is now TRUE.
950 tmp_list = source->priv->child_sources;
953 g_source_destroy_internal (tmp_list->data, context, TRUE);
954 g_source_unref_internal (tmp_list->data, context, TRUE);
955 tmp_list = tmp_list->next;
957 g_slist_free (source->priv->child_sources);
958 source->priv->child_sources = NULL;
961 g_source_unref_internal (source, context, TRUE);
965 UNLOCK_CONTEXT (context);
970 * @source: a #GSource
972 * Removes a source from its #GMainContext, if any, and mark it as
973 * destroyed. The source cannot be subsequently added to another
977 g_source_destroy (GSource *source)
979 GMainContext *context;
981 g_return_if_fail (source != NULL);
983 context = source->context;
986 g_source_destroy_internal (source, context, FALSE);
988 source->flags &= ~G_HOOK_FLAG_ACTIVE;
993 * @source: a #GSource
995 * Returns the numeric ID for a particular source. The ID of a source
996 * is a positive integer which is unique within a particular main loop
997 * context. The reverse
998 * mapping from ID to source is done by g_main_context_find_source_by_id().
1000 * Return value: the ID (greater than 0) for the source
1003 g_source_get_id (GSource *source)
1007 g_return_val_if_fail (source != NULL, 0);
1008 g_return_val_if_fail (source->context != NULL, 0);
1010 LOCK_CONTEXT (source->context);
1011 result = source->source_id;
1012 UNLOCK_CONTEXT (source->context);
1018 * g_source_get_context:
1019 * @source: a #GSource
1021 * Gets the #GMainContext with which the source is associated.
1022 * Calling this function on a destroyed source is an error.
1024 * Return value: (transfer none): the #GMainContext with which the
1025 * source is associated, or %NULL if the context has not
1026 * yet been added to a source.
1029 g_source_get_context (GSource *source)
1031 g_return_val_if_fail (!SOURCE_DESTROYED (source), NULL);
1033 return source->context;
1037 * g_source_add_poll:
1038 * @source:a #GSource
1039 * @fd: a #GPollFD structure holding information about a file
1040 * descriptor to watch.
1042 * Adds a file descriptor to the set of file descriptors polled for
1043 * this source. This is usually combined with g_source_new() to add an
1044 * event source. The event source's check function will typically test
1045 * the @revents field in the #GPollFD struct and return %TRUE if events need
1049 g_source_add_poll (GSource *source,
1052 GMainContext *context;
1054 g_return_if_fail (source != NULL);
1055 g_return_if_fail (fd != NULL);
1056 g_return_if_fail (!SOURCE_DESTROYED (source));
1058 context = source->context;
1061 LOCK_CONTEXT (context);
1063 source->poll_fds = g_slist_prepend (source->poll_fds, fd);
1067 if (!SOURCE_BLOCKED (source))
1068 g_main_context_add_poll_unlocked (context, source->priority, fd);
1069 UNLOCK_CONTEXT (context);
1074 * g_source_remove_poll:
1075 * @source:a #GSource
1076 * @fd: a #GPollFD structure previously passed to g_source_add_poll().
1078 * Removes a file descriptor from the set of file descriptors polled for
1082 g_source_remove_poll (GSource *source,
1085 GMainContext *context;
1087 g_return_if_fail (source != NULL);
1088 g_return_if_fail (fd != NULL);
1089 g_return_if_fail (!SOURCE_DESTROYED (source));
1091 context = source->context;
1094 LOCK_CONTEXT (context);
1096 source->poll_fds = g_slist_remove (source->poll_fds, fd);
1100 if (!SOURCE_BLOCKED (source))
1101 g_main_context_remove_poll_unlocked (context, fd);
1102 UNLOCK_CONTEXT (context);
1107 * g_source_add_child_source:
1108 * @source:a #GSource
1109 * @child_source: a second #GSource that @source should "poll"
1111 * Adds @child_source to @source as a "polled" source; when @source is
1112 * added to a #GMainContext, @child_source will be automatically added
1113 * with the same priority, when @child_source is triggered, it will
1114 * cause @source to dispatch (in addition to calling its own
1115 * callback), and when @source is destroyed, it will destroy
1116 * @child_source as well. (@source will also still be dispatched if
1117 * its own prepare/check functions indicate that it is ready.)
1119 * If you don't need @child_source to do anything on its own when it
1120 * triggers, you can call g_source_set_dummy_callback() on it to set a
1121 * callback that does nothing (except return %TRUE if appropriate).
1123 * @source will hold a reference on @child_source while @child_source
1124 * is attached to it.
1129 g_source_add_child_source (GSource *source,
1130 GSource *child_source)
1132 GMainContext *context;
1134 g_return_if_fail (source != NULL);
1135 g_return_if_fail (child_source != NULL);
1136 g_return_if_fail (!SOURCE_DESTROYED (source));
1137 g_return_if_fail (!SOURCE_DESTROYED (child_source));
1138 g_return_if_fail (child_source->context == NULL);
1139 g_return_if_fail (child_source->priv == NULL || child_source->priv->parent_source == NULL);
1141 context = source->context;
1144 LOCK_CONTEXT (context);
1147 source->priv = g_slice_new0 (GSourcePrivate);
1148 if (!child_source->priv)
1149 child_source->priv = g_slice_new0 (GSourcePrivate);
1151 source->priv->child_sources = g_slist_prepend (source->priv->child_sources,
1152 g_source_ref (child_source));
1153 child_source->priv->parent_source = source;
1154 g_source_set_priority_unlocked (child_source, context, source->priority);
1158 UNLOCK_CONTEXT (context);
1159 g_source_attach (child_source, context);
1164 * g_source_remove_child_source:
1165 * @source:a #GSource
1166 * @child_source: a #GSource previously passed to
1167 * g_source_add_child_source().
1169 * Detaches @child_source from @source and destroys it.
1174 g_source_remove_child_source (GSource *source,
1175 GSource *child_source)
1177 GMainContext *context;
1179 g_return_if_fail (source != NULL);
1180 g_return_if_fail (child_source != NULL);
1181 g_return_if_fail (child_source->priv != NULL && child_source->priv->parent_source == source);
1182 g_return_if_fail (!SOURCE_DESTROYED (source));
1183 g_return_if_fail (!SOURCE_DESTROYED (child_source));
1185 context = source->context;
1188 LOCK_CONTEXT (context);
1190 source->priv->child_sources = g_slist_remove (source->priv->child_sources, child_source);
1191 g_source_destroy_internal (child_source, context, TRUE);
1192 g_source_unref_internal (child_source, context, TRUE);
1195 UNLOCK_CONTEXT (context);
1199 * g_source_set_callback_indirect:
1200 * @source: the source
1201 * @callback_data: pointer to callback data "object"
1202 * @callback_funcs: functions for reference counting @callback_data
1203 * and getting the callback and data
1205 * Sets the callback function storing the data as a refcounted callback
1206 * "object". This is used internally. Note that calling
1207 * g_source_set_callback_indirect() assumes
1208 * an initial reference count on @callback_data, and thus
1209 * @callback_funcs->unref will eventually be called once more
1210 * than @callback_funcs->ref.
1213 g_source_set_callback_indirect (GSource *source,
1214 gpointer callback_data,
1215 GSourceCallbackFuncs *callback_funcs)
1217 GMainContext *context;
1218 gpointer old_cb_data;
1219 GSourceCallbackFuncs *old_cb_funcs;
1221 g_return_if_fail (source != NULL);
1222 g_return_if_fail (callback_funcs != NULL || callback_data == NULL);
1224 context = source->context;
1227 LOCK_CONTEXT (context);
1229 old_cb_data = source->callback_data;
1230 old_cb_funcs = source->callback_funcs;
1232 source->callback_data = callback_data;
1233 source->callback_funcs = callback_funcs;
1236 UNLOCK_CONTEXT (context);
1239 old_cb_funcs->unref (old_cb_data);
1243 g_source_callback_ref (gpointer cb_data)
1245 GSourceCallback *callback = cb_data;
1247 callback->ref_count++;
1252 g_source_callback_unref (gpointer cb_data)
1254 GSourceCallback *callback = cb_data;
1256 callback->ref_count--;
1257 if (callback->ref_count == 0)
1259 if (callback->notify)
1260 callback->notify (callback->data);
1266 g_source_callback_get (gpointer cb_data,
1271 GSourceCallback *callback = cb_data;
1273 *func = callback->func;
1274 *data = callback->data;
1277 static GSourceCallbackFuncs g_source_callback_funcs = {
1278 g_source_callback_ref,
1279 g_source_callback_unref,
1280 g_source_callback_get,
1284 * g_source_set_callback:
1285 * @source: the source
1286 * @func: a callback function
1287 * @data: the data to pass to callback function
1288 * @notify: a function to call when @data is no longer in use, or %NULL.
1290 * Sets the callback function for a source. The callback for a source is
1291 * called from the source's dispatch function.
1293 * The exact type of @func depends on the type of source; ie. you
1294 * should not count on @func being called with @data as its first
1297 * Typically, you won't use this function. Instead use functions specific
1298 * to the type of source you are using.
1301 g_source_set_callback (GSource *source,
1304 GDestroyNotify notify)
1306 GSourceCallback *new_callback;
1308 g_return_if_fail (source != NULL);
1310 new_callback = g_new (GSourceCallback, 1);
1312 new_callback->ref_count = 1;
1313 new_callback->func = func;
1314 new_callback->data = data;
1315 new_callback->notify = notify;
1317 g_source_set_callback_indirect (source, new_callback, &g_source_callback_funcs);
1322 * g_source_set_funcs:
1323 * @source: a #GSource
1324 * @funcs: the new #GSourceFuncs
1326 * Sets the source functions (can be used to override
1327 * default implementations) of an unattached source.
1332 g_source_set_funcs (GSource *source,
1333 GSourceFuncs *funcs)
1335 g_return_if_fail (source != NULL);
1336 g_return_if_fail (source->context == NULL);
1337 g_return_if_fail (source->ref_count > 0);
1338 g_return_if_fail (funcs != NULL);
1340 source->source_funcs = funcs;
1344 g_source_set_priority_unlocked (GSource *source,
1345 GMainContext *context,
1350 source->priority = priority;
1354 /* Remove the source from the context's source and then
1355 * add it back so it is sorted in the correct place
1357 g_source_list_remove (source, source->context);
1358 g_source_list_add (source, source->context);
1360 if (!SOURCE_BLOCKED (source))
1362 tmp_list = source->poll_fds;
1365 g_main_context_remove_poll_unlocked (context, tmp_list->data);
1366 g_main_context_add_poll_unlocked (context, priority, tmp_list->data);
1368 tmp_list = tmp_list->next;
1373 if (source->priv && source->priv->child_sources)
1375 tmp_list = source->priv->child_sources;
1378 g_source_set_priority_unlocked (tmp_list->data, context, priority);
1379 tmp_list = tmp_list->next;
1385 * g_source_set_priority:
1386 * @source: a #GSource
1387 * @priority: the new priority.
1389 * Sets the priority of a source. While the main loop is being run, a
1390 * source will be dispatched if it is ready to be dispatched and no
1391 * sources at a higher (numerically smaller) priority are ready to be
1395 g_source_set_priority (GSource *source,
1398 GMainContext *context;
1400 g_return_if_fail (source != NULL);
1402 context = source->context;
1405 LOCK_CONTEXT (context);
1406 g_source_set_priority_unlocked (source, context, priority);
1408 UNLOCK_CONTEXT (source->context);
1412 * g_source_get_priority:
1413 * @source: a #GSource
1415 * Gets the priority of a source.
1417 * Return value: the priority of the source
1420 g_source_get_priority (GSource *source)
1422 g_return_val_if_fail (source != NULL, 0);
1424 return source->priority;
1428 * g_source_set_can_recurse:
1429 * @source: a #GSource
1430 * @can_recurse: whether recursion is allowed for this source
1432 * Sets whether a source can be called recursively. If @can_recurse is
1433 * %TRUE, then while the source is being dispatched then this source
1434 * will be processed normally. Otherwise, all processing of this
1435 * source is blocked until the dispatch function returns.
1438 g_source_set_can_recurse (GSource *source,
1439 gboolean can_recurse)
1441 GMainContext *context;
1443 g_return_if_fail (source != NULL);
1445 context = source->context;
1448 LOCK_CONTEXT (context);
1451 source->flags |= G_SOURCE_CAN_RECURSE;
1453 source->flags &= ~G_SOURCE_CAN_RECURSE;
1456 UNLOCK_CONTEXT (context);
1460 * g_source_get_can_recurse:
1461 * @source: a #GSource
1463 * Checks whether a source is allowed to be called recursively.
1464 * see g_source_set_can_recurse().
1466 * Return value: whether recursion is allowed.
1469 g_source_get_can_recurse (GSource *source)
1471 g_return_val_if_fail (source != NULL, FALSE);
1473 return (source->flags & G_SOURCE_CAN_RECURSE) != 0;
1478 * g_source_set_name:
1479 * @source: a #GSource
1480 * @name: debug name for the source
1482 * Sets a name for the source, used in debugging and profiling.
1483 * The name defaults to #NULL.
1485 * The source name should describe in a human-readable way
1486 * what the source does. For example, "X11 event queue"
1487 * or "GTK+ repaint idle handler" or whatever it is.
1489 * It is permitted to call this function multiple times, but is not
1490 * recommended due to the potential performance impact. For example,
1491 * one could change the name in the "check" function of a #GSourceFuncs
1492 * to include details like the event type in the source name.
1497 g_source_set_name (GSource *source,
1500 g_return_if_fail (source != NULL);
1502 /* setting back to NULL is allowed, just because it's
1503 * weird if get_name can return NULL but you can't
1507 g_free (source->name);
1508 source->name = g_strdup (name);
1512 * g_source_get_name:
1513 * @source: a #GSource
1515 * Gets a name for the source, used in debugging and profiling.
1516 * The name may be #NULL if it has never been set with
1517 * g_source_set_name().
1519 * Return value: the name of the source
1523 g_source_get_name (GSource *source)
1525 g_return_val_if_fail (source != NULL, NULL);
1527 return source->name;
1531 * g_source_set_name_by_id:
1532 * @tag: a #GSource ID
1533 * @name: debug name for the source
1535 * Sets the name of a source using its ID.
1537 * This is a convenience utility to set source names from the return
1538 * value of g_idle_add(), g_timeout_add(), etc.
1543 g_source_set_name_by_id (guint tag,
1548 g_return_if_fail (tag > 0);
1550 source = g_main_context_find_source_by_id (NULL, tag);
1554 g_source_set_name (source, name);
1560 * @source: a #GSource
1562 * Increases the reference count on a source by one.
1564 * Return value: @source
1567 g_source_ref (GSource *source)
1569 GMainContext *context;
1571 g_return_val_if_fail (source != NULL, NULL);
1573 context = source->context;
1576 LOCK_CONTEXT (context);
1578 source->ref_count++;
1581 UNLOCK_CONTEXT (context);
1586 /* g_source_unref() but possible to call within context lock
1589 g_source_unref_internal (GSource *source,
1590 GMainContext *context,
1593 gpointer old_cb_data = NULL;
1594 GSourceCallbackFuncs *old_cb_funcs = NULL;
1596 g_return_if_fail (source != NULL);
1598 if (!have_lock && context)
1599 LOCK_CONTEXT (context);
1601 source->ref_count--;
1602 if (source->ref_count == 0)
1604 old_cb_data = source->callback_data;
1605 old_cb_funcs = source->callback_funcs;
1607 source->callback_data = NULL;
1608 source->callback_funcs = NULL;
1612 if (!SOURCE_DESTROYED (source))
1613 g_warning (G_STRLOC ": ref_count == 0, but source was still attached to a context!");
1614 g_source_list_remove (source, context);
1617 if (source->source_funcs->finalize)
1620 UNLOCK_CONTEXT (context);
1621 source->source_funcs->finalize (source);
1623 LOCK_CONTEXT (context);
1626 g_free (source->name);
1627 source->name = NULL;
1629 g_slist_free (source->poll_fds);
1630 source->poll_fds = NULL;
1634 g_slice_free (GSourcePrivate, source->priv);
1635 source->priv = NULL;
1641 if (!have_lock && context)
1642 UNLOCK_CONTEXT (context);
1647 UNLOCK_CONTEXT (context);
1649 old_cb_funcs->unref (old_cb_data);
1652 LOCK_CONTEXT (context);
1658 * @source: a #GSource
1660 * Decreases the reference count of a source by one. If the
1661 * resulting reference count is zero the source and associated
1662 * memory will be destroyed.
1665 g_source_unref (GSource *source)
1667 g_return_if_fail (source != NULL);
1669 g_source_unref_internal (source, source->context, FALSE);
1673 * g_main_context_find_source_by_id:
1674 * @context: a #GMainContext (if %NULL, the default context will be used)
1675 * @source_id: the source ID, as returned by g_source_get_id().
1677 * Finds a #GSource given a pair of context and ID.
1679 * Return value: (transfer none): the #GSource if found, otherwise, %NULL
1682 g_main_context_find_source_by_id (GMainContext *context,
1687 g_return_val_if_fail (source_id > 0, NULL);
1689 if (context == NULL)
1690 context = g_main_context_default ();
1692 LOCK_CONTEXT (context);
1694 source = context->source_list;
1697 if (!SOURCE_DESTROYED (source) &&
1698 source->source_id == source_id)
1700 source = source->next;
1703 UNLOCK_CONTEXT (context);
1709 * g_main_context_find_source_by_funcs_user_data:
1710 * @context: a #GMainContext (if %NULL, the default context will be used).
1711 * @funcs: the @source_funcs passed to g_source_new().
1712 * @user_data: the user data from the callback.
1714 * Finds a source with the given source functions and user data. If
1715 * multiple sources exist with the same source function and user data,
1716 * the first one found will be returned.
1718 * Return value: (transfer none): the source, if one was found, otherwise %NULL
1721 g_main_context_find_source_by_funcs_user_data (GMainContext *context,
1722 GSourceFuncs *funcs,
1727 g_return_val_if_fail (funcs != NULL, NULL);
1729 if (context == NULL)
1730 context = g_main_context_default ();
1732 LOCK_CONTEXT (context);
1734 source = context->source_list;
1737 if (!SOURCE_DESTROYED (source) &&
1738 source->source_funcs == funcs &&
1739 source->callback_funcs)
1741 GSourceFunc callback;
1742 gpointer callback_data;
1744 source->callback_funcs->get (source->callback_data, source, &callback, &callback_data);
1746 if (callback_data == user_data)
1749 source = source->next;
1752 UNLOCK_CONTEXT (context);
1758 * g_main_context_find_source_by_user_data:
1759 * @context: a #GMainContext
1760 * @user_data: the user_data for the callback.
1762 * Finds a source with the given user data for the callback. If
1763 * multiple sources exist with the same user data, the first
1764 * one found will be returned.
1766 * Return value: (transfer none): the source, if one was found, otherwise %NULL
1769 g_main_context_find_source_by_user_data (GMainContext *context,
1774 if (context == NULL)
1775 context = g_main_context_default ();
1777 LOCK_CONTEXT (context);
1779 source = context->source_list;
1782 if (!SOURCE_DESTROYED (source) &&
1783 source->callback_funcs)
1785 GSourceFunc callback;
1786 gpointer callback_data = NULL;
1788 source->callback_funcs->get (source->callback_data, source, &callback, &callback_data);
1790 if (callback_data == user_data)
1793 source = source->next;
1796 UNLOCK_CONTEXT (context);
1803 * @tag: the ID of the source to remove.
1805 * Removes the source with the given id from the default main context.
1807 * a #GSource is given by g_source_get_id(), or will be returned by the
1808 * functions g_source_attach(), g_idle_add(), g_idle_add_full(),
1809 * g_timeout_add(), g_timeout_add_full(), g_child_watch_add(),
1810 * g_child_watch_add_full(), g_io_add_watch(), and g_io_add_watch_full().
1812 * See also g_source_destroy(). You must use g_source_destroy() for sources
1813 * added to a non-default main context.
1815 * Return value: %TRUE if the source was found and removed.
1818 g_source_remove (guint tag)
1822 g_return_val_if_fail (tag > 0, FALSE);
1824 source = g_main_context_find_source_by_id (NULL, tag);
1826 g_source_destroy (source);
1828 return source != NULL;
1832 * g_source_remove_by_user_data:
1833 * @user_data: the user_data for the callback.
1835 * Removes a source from the default main loop context given the user
1836 * data for the callback. If multiple sources exist with the same user
1837 * data, only one will be destroyed.
1839 * Return value: %TRUE if a source was found and removed.
1842 g_source_remove_by_user_data (gpointer user_data)
1846 source = g_main_context_find_source_by_user_data (NULL, user_data);
1849 g_source_destroy (source);
1857 * g_source_remove_by_funcs_user_data:
1858 * @funcs: The @source_funcs passed to g_source_new()
1859 * @user_data: the user data for the callback
1861 * Removes a source from the default main loop context given the
1862 * source functions and user data. If multiple sources exist with the
1863 * same source functions and user data, only one will be destroyed.
1865 * Return value: %TRUE if a source was found and removed.
1868 g_source_remove_by_funcs_user_data (GSourceFuncs *funcs,
1873 g_return_val_if_fail (funcs != NULL, FALSE);
1875 source = g_main_context_find_source_by_funcs_user_data (NULL, funcs, user_data);
1878 g_source_destroy (source);
1886 * g_get_current_time:
1887 * @result: #GTimeVal structure in which to store current time.
1889 * Equivalent to the UNIX gettimeofday() function, but portable.
1891 * You may find g_get_real_time() to be more convenient.
1894 g_get_current_time (GTimeVal *result)
1899 g_return_if_fail (result != NULL);
1901 /*this is required on alpha, there the timeval structs are int's
1902 not longs and a cast only would fail horribly*/
1903 gettimeofday (&r, NULL);
1904 result->tv_sec = r.tv_sec;
1905 result->tv_usec = r.tv_usec;
1910 g_return_if_fail (result != NULL);
1912 GetSystemTimeAsFileTime (&ft);
1913 memmove (&time64, &ft, sizeof (FILETIME));
1915 /* Convert from 100s of nanoseconds since 1601-01-01
1916 * to Unix epoch. Yes, this is Y2038 unsafe.
1918 time64 -= G_GINT64_CONSTANT (116444736000000000);
1921 result->tv_sec = time64 / 1000000;
1922 result->tv_usec = time64 % 1000000;
1929 * Queries the system wall-clock time.
1931 * This call is functionally equivalent to g_get_current_time() except
1932 * that the return value is often more convenient than dealing with a
1935 * You should only use this call if you are actually interested in the real
1936 * wall-clock time. g_get_monotonic_time() is probably more useful for
1937 * measuring intervals.
1939 * Returns: the number of microseconds since January 1, 1970 UTC.
1944 g_get_real_time (void)
1948 g_get_current_time (&tv);
1950 return (((gint64) tv.tv_sec) * 1000000) + tv.tv_usec;
1954 * g_get_monotonic_time:
1956 * Queries the system monotonic time, if available.
1958 * On POSIX systems with clock_gettime() and %CLOCK_MONOTONIC this call
1959 * is a very shallow wrapper for that. Otherwise, we make a best effort
1960 * that probably involves returning the wall clock time (with at least
1961 * microsecond accuracy, subject to the limitations of the OS kernel).
1963 * It's important to note that POSIX %CLOCK_MONOTONIC does not count
1964 * time spent while the machine is suspended.
1966 * On Windows, "limitations of the OS kernel" is a rather substantial
1967 * statement. Depending on the configuration of the system, the wall
1968 * clock time is updated as infrequently as 64 times a second (which
1969 * is approximately every 16ms).
1971 * Returns: the monotonic time, in microseconds
1976 g_get_monotonic_time (void)
1978 #ifdef HAVE_CLOCK_GETTIME
1979 /* librt clock_gettime() is our first choice */
1981 #ifdef HAVE_MONOTONIC_CLOCK
1982 static volatile gsize clockid = 0;
1984 static clockid_t clockid = CLOCK_REALTIME;
1988 #ifdef HAVE_MONOTONIC_CLOCK
1989 if (g_once_init_enter (&clockid))
1991 clockid_t best_clockid;
1993 if (sysconf (_SC_MONOTONIC_CLOCK) >= 0)
1994 best_clockid = CLOCK_MONOTONIC;
1996 best_clockid = CLOCK_REALTIME;
1997 g_once_init_leave (&clockid, (gsize)best_clockid);
2001 clock_gettime (clockid, &ts);
2003 /* In theory monotonic time can have any epoch.
2005 * glib presently assumes the following:
2007 * 1) The epoch comes some time after the birth of Jesus of Nazareth, but
2008 * not more than 10000 years later.
2010 * 2) The current time also falls sometime within this range.
2012 * These two reasonable assumptions leave us with a maximum deviation from
2013 * the epoch of 10000 years, or 315569520000000000 seconds.
2015 * If we restrict ourselves to this range then the number of microseconds
2016 * will always fit well inside the constraints of a int64 (by a factor of
2019 * If you actually hit the following assertion, probably you should file a
2020 * bug against your operating system for being excessively silly.
2022 g_assert (G_GINT64_CONSTANT (-315569520000000000) < ts.tv_sec &&
2023 ts.tv_sec < G_GINT64_CONSTANT (315569520000000000));
2025 return (((gint64) ts.tv_sec) * 1000000) + (ts.tv_nsec / 1000);
2028 /* It may look like we are discarding accuracy on Windows (since its
2029 * current time is expressed in 100s of nanoseconds) but according to
2030 * many sources, the time is only updated 64 times per second, so
2031 * microsecond accuracy is more than enough.
2036 g_get_current_time (&tv);
2038 return (((gint64) tv.tv_sec) * 1000000) + tv.tv_usec;
2044 g_main_dispatch_free (gpointer dispatch)
2046 g_slice_free (GMainDispatch, dispatch);
2049 /* Running the main loop */
2051 static GMainDispatch *
2054 static GStaticPrivate depth_private = G_STATIC_PRIVATE_INIT;
2055 GMainDispatch *dispatch = g_static_private_get (&depth_private);
2058 dispatch = g_slice_new0 (GMainDispatch);
2059 g_static_private_set (&depth_private, dispatch, g_main_dispatch_free);
2068 * Returns the depth of the stack of calls to
2069 * g_main_context_dispatch() on any #GMainContext in the current thread.
2070 * That is, when called from the toplevel, it gives 0. When
2071 * called from within a callback from g_main_context_iteration()
2072 * (or g_main_loop_run(), etc.) it returns 1. When called from within
2073 * a callback to a recursive call to g_main_context_iteration(),
2074 * it returns 2. And so forth.
2076 * This function is useful in a situation like the following:
2077 * Imagine an extremely simple "garbage collected" system.
2080 * static GList *free_list;
2083 * allocate_memory (gsize size)
2085 * gpointer result = g_malloc (size);
2086 * free_list = g_list_prepend (free_list, result);
2091 * free_allocated_memory (void)
2094 * for (l = free_list; l; l = l->next);
2096 * g_list_free (free_list);
2104 * g_main_context_iteration (NULL, TRUE);
2105 * free_allocated_memory();
2109 * This works from an application, however, if you want to do the same
2110 * thing from a library, it gets more difficult, since you no longer
2111 * control the main loop. You might think you can simply use an idle
2112 * function to make the call to free_allocated_memory(), but that
2113 * doesn't work, since the idle function could be called from a
2114 * recursive callback. This can be fixed by using g_main_depth()
2118 * allocate_memory (gsize size)
2120 * FreeListBlock *block = g_new (FreeListBlock, 1);
2121 * block->mem = g_malloc (size);
2122 * block->depth = g_main_depth ();
2123 * free_list = g_list_prepend (free_list, block);
2124 * return block->mem;
2128 * free_allocated_memory (void)
2132 * int depth = g_main_depth ();
2133 * for (l = free_list; l; );
2135 * GList *next = l->next;
2136 * FreeListBlock *block = l->data;
2137 * if (block->depth > depth)
2139 * g_free (block->mem);
2141 * free_list = g_list_delete_link (free_list, l);
2149 * There is a temptation to use g_main_depth() to solve
2150 * problems with reentrancy. For instance, while waiting for data
2151 * to be received from the network in response to a menu item,
2152 * the menu item might be selected again. It might seem that
2153 * one could make the menu item's callback return immediately
2154 * and do nothing if g_main_depth() returns a value greater than 1.
2155 * However, this should be avoided since the user then sees selecting
2156 * the menu item do nothing. Furthermore, you'll find yourself adding
2157 * these checks all over your code, since there are doubtless many,
2158 * many things that the user could do. Instead, you can use the
2159 * following techniques:
2164 * Use gtk_widget_set_sensitive() or modal dialogs to prevent
2165 * the user from interacting with elements while the main
2166 * loop is recursing.
2171 * Avoid main loop recursion in situations where you can't handle
2172 * arbitrary callbacks. Instead, structure your code so that you
2173 * simply return to the main loop and then get called again when
2174 * there is more work to do.
2179 * Return value: The main loop recursion level in the current thread
2184 GMainDispatch *dispatch = get_dispatch ();
2185 return dispatch->depth;
2189 * g_main_current_source:
2191 * Returns the currently firing source for this thread.
2193 * Return value: (transfer none): The currently firing source or %NULL.
2198 g_main_current_source (void)
2200 GMainDispatch *dispatch = get_dispatch ();
2201 return dispatch->dispatching_sources ? dispatch->dispatching_sources->data : NULL;
2205 * g_source_is_destroyed:
2206 * @source: a #GSource
2208 * Returns whether @source has been destroyed.
2210 * This is important when you operate upon your objects
2211 * from within idle handlers, but may have freed the object
2212 * before the dispatch of your idle handler.
2216 * idle_callback (gpointer data)
2218 * SomeWidget *self = data;
2220 * GDK_THREADS_ENTER (<!-- -->);
2221 * /<!-- -->* do stuff with self *<!-- -->/
2222 * self->idle_id = 0;
2223 * GDK_THREADS_LEAVE (<!-- -->);
2229 * some_widget_do_stuff_later (SomeWidget *self)
2231 * self->idle_id = g_idle_add (idle_callback, self);
2235 * some_widget_finalize (GObject *object)
2237 * SomeWidget *self = SOME_WIDGET (object);
2239 * if (self->idle_id)
2240 * g_source_remove (self->idle_id);
2242 * G_OBJECT_CLASS (parent_class)->finalize (object);
2246 * This will fail in a multi-threaded application if the
2247 * widget is destroyed before the idle handler fires due
2248 * to the use after free in the callback. A solution, to
2249 * this particular problem, is to check to if the source
2250 * has already been destroy within the callback.
2254 * idle_callback (gpointer data)
2256 * SomeWidget *self = data;
2258 * GDK_THREADS_ENTER ();
2259 * if (!g_source_is_destroyed (g_main_current_source ()))
2261 * /<!-- -->* do stuff with self *<!-- -->/
2263 * GDK_THREADS_LEAVE ();
2269 * Return value: %TRUE if the source has been destroyed
2274 g_source_is_destroyed (GSource *source)
2276 return SOURCE_DESTROYED (source);
2279 /* Temporarily remove all this source's file descriptors from the
2280 * poll(), so that if data comes available for one of the file descriptors
2281 * we don't continually spin in the poll()
2283 /* HOLDS: source->context's lock */
2285 block_source (GSource *source)
2289 g_return_if_fail (!SOURCE_BLOCKED (source));
2291 tmp_list = source->poll_fds;
2294 g_main_context_remove_poll_unlocked (source->context, tmp_list->data);
2295 tmp_list = tmp_list->next;
2299 /* HOLDS: source->context's lock */
2301 unblock_source (GSource *source)
2305 g_return_if_fail (!SOURCE_BLOCKED (source)); /* Source already unblocked */
2306 g_return_if_fail (!SOURCE_DESTROYED (source));
2308 tmp_list = source->poll_fds;
2311 g_main_context_add_poll_unlocked (source->context, source->priority, tmp_list->data);
2312 tmp_list = tmp_list->next;
2316 /* HOLDS: context's lock */
2318 g_main_dispatch (GMainContext *context)
2320 GMainDispatch *current = get_dispatch ();
2323 for (i = 0; i < context->pending_dispatches->len; i++)
2325 GSource *source = context->pending_dispatches->pdata[i];
2327 context->pending_dispatches->pdata[i] = NULL;
2330 source->flags &= ~G_SOURCE_READY;
2332 if (!SOURCE_DESTROYED (source))
2334 gboolean was_in_call;
2335 gpointer user_data = NULL;
2336 GSourceFunc callback = NULL;
2337 GSourceCallbackFuncs *cb_funcs;
2339 gboolean need_destroy;
2341 gboolean (*dispatch) (GSource *,
2344 GSList current_source_link;
2346 dispatch = source->source_funcs->dispatch;
2347 cb_funcs = source->callback_funcs;
2348 cb_data = source->callback_data;
2351 cb_funcs->ref (cb_data);
2353 if ((source->flags & G_SOURCE_CAN_RECURSE) == 0)
2354 block_source (source);
2356 was_in_call = source->flags & G_HOOK_FLAG_IN_CALL;
2357 source->flags |= G_HOOK_FLAG_IN_CALL;
2360 cb_funcs->get (cb_data, source, &callback, &user_data);
2362 UNLOCK_CONTEXT (context);
2365 /* The on-stack allocation of the GSList is unconventional, but
2366 * we know that the lifetime of the link is bounded to this
2367 * function as the link is kept in a thread specific list and
2368 * not manipulated outside of this function and its descendants.
2369 * Avoiding the overhead of a g_slist_alloc() is useful as many
2370 * applications do little more than dispatch events.
2372 * This is a performance hack - do not revert to g_slist_prepend()!
2374 current_source_link.data = source;
2375 current_source_link.next = current->dispatching_sources;
2376 current->dispatching_sources = ¤t_source_link;
2377 need_destroy = ! dispatch (source,
2380 g_assert (current->dispatching_sources == ¤t_source_link);
2381 current->dispatching_sources = current_source_link.next;
2385 cb_funcs->unref (cb_data);
2387 LOCK_CONTEXT (context);
2390 source->flags &= ~G_HOOK_FLAG_IN_CALL;
2392 if ((source->flags & G_SOURCE_CAN_RECURSE) == 0 &&
2393 !SOURCE_DESTROYED (source))
2394 unblock_source (source);
2396 /* Note: this depends on the fact that we can't switch
2397 * sources from one main context to another
2399 if (need_destroy && !SOURCE_DESTROYED (source))
2401 g_assert (source->context == context);
2402 g_source_destroy_internal (source, context, TRUE);
2406 SOURCE_UNREF (source, context);
2409 g_ptr_array_set_size (context->pending_dispatches, 0);
2412 /* Holds context's lock */
2413 static inline GSource *
2414 next_valid_source (GMainContext *context,
2417 GSource *new_source = source ? source->next : context->source_list;
2421 if (!SOURCE_DESTROYED (new_source))
2423 new_source->ref_count++;
2427 new_source = new_source->next;
2431 SOURCE_UNREF (source, context);
2437 * g_main_context_acquire:
2438 * @context: a #GMainContext
2440 * Tries to become the owner of the specified context.
2441 * If some other thread is the owner of the context,
2442 * returns %FALSE immediately. Ownership is properly
2443 * recursive: the owner can require ownership again
2444 * and will release ownership when g_main_context_release()
2445 * is called as many times as g_main_context_acquire().
2447 * You must be the owner of a context before you
2448 * can call g_main_context_prepare(), g_main_context_query(),
2449 * g_main_context_check(), g_main_context_dispatch().
2451 * Return value: %TRUE if the operation succeeded, and
2452 * this thread is now the owner of @context.
2455 g_main_context_acquire (GMainContext *context)
2457 gboolean result = FALSE;
2458 GThread *self = G_THREAD_SELF;
2460 if (context == NULL)
2461 context = g_main_context_default ();
2463 LOCK_CONTEXT (context);
2465 if (!context->owner)
2467 context->owner = self;
2468 g_assert (context->owner_count == 0);
2471 if (context->owner == self)
2473 context->owner_count++;
2477 UNLOCK_CONTEXT (context);
2483 * g_main_context_release:
2484 * @context: a #GMainContext
2486 * Releases ownership of a context previously acquired by this thread
2487 * with g_main_context_acquire(). If the context was acquired multiple
2488 * times, the ownership will be released only when g_main_context_release()
2489 * is called as many times as it was acquired.
2492 g_main_context_release (GMainContext *context)
2494 if (context == NULL)
2495 context = g_main_context_default ();
2497 LOCK_CONTEXT (context);
2499 context->owner_count--;
2500 if (context->owner_count == 0)
2502 context->owner = NULL;
2504 if (context->waiters)
2506 GMainWaiter *waiter = context->waiters->data;
2507 gboolean loop_internal_waiter =
2508 (waiter->mutex == g_static_mutex_get_mutex (&context->mutex));
2509 context->waiters = g_slist_delete_link (context->waiters,
2511 if (!loop_internal_waiter)
2512 g_mutex_lock (waiter->mutex);
2514 g_cond_signal (waiter->cond);
2516 if (!loop_internal_waiter)
2517 g_mutex_unlock (waiter->mutex);
2521 UNLOCK_CONTEXT (context);
2525 * g_main_context_wait:
2526 * @context: a #GMainContext
2527 * @cond: a condition variable
2528 * @mutex: a mutex, currently held
2530 * Tries to become the owner of the specified context,
2531 * as with g_main_context_acquire(). But if another thread
2532 * is the owner, atomically drop @mutex and wait on @cond until
2533 * that owner releases ownership or until @cond is signaled, then
2534 * try again (once) to become the owner.
2536 * Return value: %TRUE if the operation succeeded, and
2537 * this thread is now the owner of @context.
2540 g_main_context_wait (GMainContext *context,
2544 gboolean result = FALSE;
2545 GThread *self = G_THREAD_SELF;
2546 gboolean loop_internal_waiter;
2548 if (context == NULL)
2549 context = g_main_context_default ();
2551 loop_internal_waiter = (mutex == g_static_mutex_get_mutex (&context->mutex));
2553 if (!loop_internal_waiter)
2554 LOCK_CONTEXT (context);
2556 if (context->owner && context->owner != self)
2561 waiter.mutex = mutex;
2563 context->waiters = g_slist_append (context->waiters, &waiter);
2565 if (!loop_internal_waiter)
2566 UNLOCK_CONTEXT (context);
2567 g_cond_wait (cond, mutex);
2568 if (!loop_internal_waiter)
2569 LOCK_CONTEXT (context);
2571 context->waiters = g_slist_remove (context->waiters, &waiter);
2574 if (!context->owner)
2576 context->owner = self;
2577 g_assert (context->owner_count == 0);
2580 if (context->owner == self)
2582 context->owner_count++;
2586 if (!loop_internal_waiter)
2587 UNLOCK_CONTEXT (context);
2593 * g_main_context_prepare:
2594 * @context: a #GMainContext
2595 * @priority: location to store priority of highest priority
2596 * source already ready.
2598 * Prepares to poll sources within a main loop. The resulting information
2599 * for polling is determined by calling g_main_context_query ().
2601 * Return value: %TRUE if some source is ready to be dispatched
2605 g_main_context_prepare (GMainContext *context,
2610 gint current_priority = G_MAXINT;
2613 if (context == NULL)
2614 context = g_main_context_default ();
2616 LOCK_CONTEXT (context);
2618 context->time_is_fresh = FALSE;
2620 if (context->in_check_or_prepare)
2622 g_warning ("g_main_context_prepare() called recursively from within a source's check() or "
2623 "prepare() member.");
2624 UNLOCK_CONTEXT (context);
2628 if (context->poll_waiting)
2630 g_warning("g_main_context_prepare(): main loop already active in another thread");
2631 UNLOCK_CONTEXT (context);
2635 context->poll_waiting = TRUE;
2638 /* If recursing, finish up current dispatch, before starting over */
2639 if (context->pending_dispatches)
2642 g_main_dispatch (context, ¤t_time);
2644 UNLOCK_CONTEXT (context);
2649 /* If recursing, clear list of pending dispatches */
2651 for (i = 0; i < context->pending_dispatches->len; i++)
2653 if (context->pending_dispatches->pdata[i])
2654 SOURCE_UNREF ((GSource *)context->pending_dispatches->pdata[i], context);
2656 g_ptr_array_set_size (context->pending_dispatches, 0);
2658 /* Prepare all sources */
2660 context->timeout = -1;
2662 source = next_valid_source (context, NULL);
2665 gint source_timeout = -1;
2667 if ((n_ready > 0) && (source->priority > current_priority))
2669 SOURCE_UNREF (source, context);
2672 if (SOURCE_BLOCKED (source))
2675 if (!(source->flags & G_SOURCE_READY))
2678 gboolean (*prepare) (GSource *source,
2681 prepare = source->source_funcs->prepare;
2682 context->in_check_or_prepare++;
2683 UNLOCK_CONTEXT (context);
2685 result = (*prepare) (source, &source_timeout);
2687 LOCK_CONTEXT (context);
2688 context->in_check_or_prepare--;
2692 GSource *ready_source = source;
2694 while (ready_source)
2696 ready_source->flags |= G_SOURCE_READY;
2697 ready_source = ready_source->priv ? ready_source->priv->parent_source : NULL;
2702 if (source->flags & G_SOURCE_READY)
2705 current_priority = source->priority;
2706 context->timeout = 0;
2709 if (source_timeout >= 0)
2711 if (context->timeout < 0)
2712 context->timeout = source_timeout;
2714 context->timeout = MIN (context->timeout, source_timeout);
2718 source = next_valid_source (context, source);
2721 UNLOCK_CONTEXT (context);
2724 *priority = current_priority;
2726 return (n_ready > 0);
2730 * g_main_context_query:
2731 * @context: a #GMainContext
2732 * @max_priority: maximum priority source to check
2733 * @timeout_: (out): location to store timeout to be used in polling
2734 * @fds: (out caller-allocates) (array length=n_fds): location to
2735 * store #GPollFD records that need to be polled.
2736 * @n_fds: length of @fds.
2738 * Determines information necessary to poll this main loop.
2740 * Return value: the number of records actually stored in @fds,
2741 * or, if more than @n_fds records need to be stored, the number
2742 * of records that need to be stored.
2745 g_main_context_query (GMainContext *context,
2754 LOCK_CONTEXT (context);
2756 pollrec = context->poll_records;
2758 while (pollrec && max_priority >= pollrec->priority)
2760 /* We need to include entries with fd->events == 0 in the array because
2761 * otherwise if the application changes fd->events behind our back and
2762 * makes it non-zero, we'll be out of sync when we check the fds[] array.
2763 * (Changing fd->events after adding an FD wasn't an anticipated use of
2764 * this API, but it occurs in practice.) */
2767 fds[n_poll].fd = pollrec->fd->fd;
2768 /* In direct contradiction to the Unix98 spec, IRIX runs into
2769 * difficulty if you pass in POLLERR, POLLHUP or POLLNVAL
2770 * flags in the events field of the pollfd while it should
2771 * just ignoring them. So we mask them out here.
2773 fds[n_poll].events = pollrec->fd->events & ~(G_IO_ERR|G_IO_HUP|G_IO_NVAL);
2774 fds[n_poll].revents = 0;
2777 pollrec = pollrec->next;
2781 context->poll_changed = FALSE;
2785 *timeout = context->timeout;
2787 context->time_is_fresh = FALSE;
2790 UNLOCK_CONTEXT (context);
2796 * g_main_context_check:
2797 * @context: a #GMainContext
2798 * @max_priority: the maximum numerical priority of sources to check
2799 * @fds: (array length=n_fds): array of #GPollFD's that was passed to
2800 * the last call to g_main_context_query()
2801 * @n_fds: return value of g_main_context_query()
2803 * Passes the results of polling back to the main loop.
2805 * Return value: %TRUE if some sources are ready to be dispatched.
2808 g_main_context_check (GMainContext *context,
2818 LOCK_CONTEXT (context);
2820 if (context->in_check_or_prepare)
2822 g_warning ("g_main_context_check() called recursively from within a source's check() or "
2823 "prepare() member.");
2824 UNLOCK_CONTEXT (context);
2828 if (context->wake_up_rec.events)
2829 g_wakeup_acknowledge (context->wakeup);
2831 context->poll_waiting = FALSE;
2833 /* If the set of poll file descriptors changed, bail out
2834 * and let the main loop rerun
2836 if (context->poll_changed)
2838 UNLOCK_CONTEXT (context);
2842 pollrec = context->poll_records;
2846 if (pollrec->fd->events)
2847 pollrec->fd->revents = fds[i].revents;
2849 pollrec = pollrec->next;
2853 source = next_valid_source (context, NULL);
2856 if ((n_ready > 0) && (source->priority > max_priority))
2858 SOURCE_UNREF (source, context);
2861 if (SOURCE_BLOCKED (source))
2864 if (!(source->flags & G_SOURCE_READY))
2867 gboolean (*check) (GSource *source);
2869 check = source->source_funcs->check;
2871 context->in_check_or_prepare++;
2872 UNLOCK_CONTEXT (context);
2874 result = (*check) (source);
2876 LOCK_CONTEXT (context);
2877 context->in_check_or_prepare--;
2881 GSource *ready_source = source;
2883 while (ready_source)
2885 ready_source->flags |= G_SOURCE_READY;
2886 ready_source = ready_source->priv ? ready_source->priv->parent_source : NULL;
2891 if (source->flags & G_SOURCE_READY)
2893 source->ref_count++;
2894 g_ptr_array_add (context->pending_dispatches, source);
2898 /* never dispatch sources with less priority than the first
2899 * one we choose to dispatch
2901 max_priority = source->priority;
2905 source = next_valid_source (context, source);
2908 UNLOCK_CONTEXT (context);
2914 * g_main_context_dispatch:
2915 * @context: a #GMainContext
2917 * Dispatches all pending sources.
2920 g_main_context_dispatch (GMainContext *context)
2922 LOCK_CONTEXT (context);
2924 if (context->pending_dispatches->len > 0)
2926 g_main_dispatch (context);
2929 UNLOCK_CONTEXT (context);
2932 /* HOLDS context lock */
2934 g_main_context_iterate (GMainContext *context,
2941 gboolean some_ready;
2942 gint nfds, allocated_nfds;
2943 GPollFD *fds = NULL;
2945 UNLOCK_CONTEXT (context);
2947 if (!g_main_context_acquire (context))
2949 gboolean got_ownership;
2951 LOCK_CONTEXT (context);
2957 context->cond = g_cond_new ();
2959 got_ownership = g_main_context_wait (context,
2961 g_static_mutex_get_mutex (&context->mutex));
2967 LOCK_CONTEXT (context);
2969 if (!context->cached_poll_array)
2971 context->cached_poll_array_size = context->n_poll_records;
2972 context->cached_poll_array = g_new (GPollFD, context->n_poll_records);
2975 allocated_nfds = context->cached_poll_array_size;
2976 fds = context->cached_poll_array;
2978 UNLOCK_CONTEXT (context);
2980 g_main_context_prepare (context, &max_priority);
2982 while ((nfds = g_main_context_query (context, max_priority, &timeout, fds,
2983 allocated_nfds)) > allocated_nfds)
2985 LOCK_CONTEXT (context);
2987 context->cached_poll_array_size = allocated_nfds = nfds;
2988 context->cached_poll_array = fds = g_new (GPollFD, nfds);
2989 UNLOCK_CONTEXT (context);
2995 g_main_context_poll (context, timeout, max_priority, fds, nfds);
2997 some_ready = g_main_context_check (context, max_priority, fds, nfds);
3000 g_main_context_dispatch (context);
3002 g_main_context_release (context);
3004 LOCK_CONTEXT (context);
3010 * g_main_context_pending:
3011 * @context: a #GMainContext (if %NULL, the default context will be used)
3013 * Checks if any sources have pending events for the given context.
3015 * Return value: %TRUE if events are pending.
3018 g_main_context_pending (GMainContext *context)
3023 context = g_main_context_default();
3025 LOCK_CONTEXT (context);
3026 retval = g_main_context_iterate (context, FALSE, FALSE, G_THREAD_SELF);
3027 UNLOCK_CONTEXT (context);
3033 * g_main_context_iteration:
3034 * @context: a #GMainContext (if %NULL, the default context will be used)
3035 * @may_block: whether the call may block.
3037 * Runs a single iteration for the given main loop. This involves
3038 * checking to see if any event sources are ready to be processed,
3039 * then if no events sources are ready and @may_block is %TRUE, waiting
3040 * for a source to become ready, then dispatching the highest priority
3041 * events sources that are ready. Otherwise, if @may_block is %FALSE
3042 * sources are not waited to become ready, only those highest priority
3043 * events sources will be dispatched (if any), that are ready at this
3044 * given moment without further waiting.
3046 * Note that even when @may_block is %TRUE, it is still possible for
3047 * g_main_context_iteration() to return %FALSE, since the the wait may
3048 * be interrupted for other reasons than an event source becoming ready.
3050 * Return value: %TRUE if events were dispatched.
3053 g_main_context_iteration (GMainContext *context, gboolean may_block)
3058 context = g_main_context_default();
3060 LOCK_CONTEXT (context);
3061 retval = g_main_context_iterate (context, may_block, TRUE, G_THREAD_SELF);
3062 UNLOCK_CONTEXT (context);
3069 * @context: (allow-none): a #GMainContext (if %NULL, the default context will be used).
3070 * @is_running: set to %TRUE to indicate that the loop is running. This
3071 * is not very important since calling g_main_loop_run() will set this to
3074 * Creates a new #GMainLoop structure.
3076 * Return value: a new #GMainLoop.
3079 g_main_loop_new (GMainContext *context,
3080 gboolean is_running)
3085 context = g_main_context_default();
3087 g_main_context_ref (context);
3089 loop = g_new0 (GMainLoop, 1);
3090 loop->context = context;
3091 loop->is_running = is_running != FALSE;
3092 loop->ref_count = 1;
3099 * @loop: a #GMainLoop
3101 * Increases the reference count on a #GMainLoop object by one.
3103 * Return value: @loop
3106 g_main_loop_ref (GMainLoop *loop)
3108 g_return_val_if_fail (loop != NULL, NULL);
3109 g_return_val_if_fail (g_atomic_int_get (&loop->ref_count) > 0, NULL);
3111 g_atomic_int_inc (&loop->ref_count);
3117 * g_main_loop_unref:
3118 * @loop: a #GMainLoop
3120 * Decreases the reference count on a #GMainLoop object by one. If
3121 * the result is zero, free the loop and free all associated memory.
3124 g_main_loop_unref (GMainLoop *loop)
3126 g_return_if_fail (loop != NULL);
3127 g_return_if_fail (g_atomic_int_get (&loop->ref_count) > 0);
3129 if (!g_atomic_int_dec_and_test (&loop->ref_count))
3132 g_main_context_unref (loop->context);
3138 * @loop: a #GMainLoop
3140 * Runs a main loop until g_main_loop_quit() is called on the loop.
3141 * If this is called for the thread of the loop's #GMainContext,
3142 * it will process events from the loop, otherwise it will
3146 g_main_loop_run (GMainLoop *loop)
3148 GThread *self = G_THREAD_SELF;
3150 g_return_if_fail (loop != NULL);
3151 g_return_if_fail (g_atomic_int_get (&loop->ref_count) > 0);
3153 if (!g_main_context_acquire (loop->context))
3155 gboolean got_ownership = FALSE;
3157 /* Another thread owns this context */
3158 LOCK_CONTEXT (loop->context);
3160 g_atomic_int_inc (&loop->ref_count);
3162 if (!loop->is_running)
3163 loop->is_running = TRUE;
3165 if (!loop->context->cond)
3166 loop->context->cond = g_cond_new ();
3168 while (loop->is_running && !got_ownership)
3169 got_ownership = g_main_context_wait (loop->context,
3170 loop->context->cond,
3171 g_static_mutex_get_mutex (&loop->context->mutex));
3173 if (!loop->is_running)
3175 UNLOCK_CONTEXT (loop->context);
3177 g_main_context_release (loop->context);
3178 g_main_loop_unref (loop);
3182 g_assert (got_ownership);
3185 LOCK_CONTEXT (loop->context);
3187 if (loop->context->in_check_or_prepare)
3189 g_warning ("g_main_loop_run(): called recursively from within a source's "
3190 "check() or prepare() member, iteration not possible.");
3194 g_atomic_int_inc (&loop->ref_count);
3195 loop->is_running = TRUE;
3196 while (loop->is_running)
3197 g_main_context_iterate (loop->context, TRUE, TRUE, self);
3199 UNLOCK_CONTEXT (loop->context);
3201 g_main_context_release (loop->context);
3203 g_main_loop_unref (loop);
3208 * @loop: a #GMainLoop
3210 * Stops a #GMainLoop from running. Any calls to g_main_loop_run()
3211 * for the loop will return.
3213 * Note that sources that have already been dispatched when
3214 * g_main_loop_quit() is called will still be executed.
3217 g_main_loop_quit (GMainLoop *loop)
3219 g_return_if_fail (loop != NULL);
3220 g_return_if_fail (g_atomic_int_get (&loop->ref_count) > 0);
3222 LOCK_CONTEXT (loop->context);
3223 loop->is_running = FALSE;
3224 g_main_context_wakeup_unlocked (loop->context);
3226 if (loop->context->cond)
3227 g_cond_broadcast (loop->context->cond);
3229 UNLOCK_CONTEXT (loop->context);
3233 * g_main_loop_is_running:
3234 * @loop: a #GMainLoop.
3236 * Checks to see if the main loop is currently being run via g_main_loop_run().
3238 * Return value: %TRUE if the mainloop is currently being run.
3241 g_main_loop_is_running (GMainLoop *loop)
3243 g_return_val_if_fail (loop != NULL, FALSE);
3244 g_return_val_if_fail (g_atomic_int_get (&loop->ref_count) > 0, FALSE);
3246 return loop->is_running;
3250 * g_main_loop_get_context:
3251 * @loop: a #GMainLoop.
3253 * Returns the #GMainContext of @loop.
3255 * Return value: (transfer none): the #GMainContext of @loop
3258 g_main_loop_get_context (GMainLoop *loop)
3260 g_return_val_if_fail (loop != NULL, NULL);
3261 g_return_val_if_fail (g_atomic_int_get (&loop->ref_count) > 0, NULL);
3263 return loop->context;
3266 /* HOLDS: context's lock */
3268 g_main_context_poll (GMainContext *context,
3274 #ifdef G_MAIN_POLL_DEBUG
3280 GPollFunc poll_func;
3282 if (n_fds || timeout != 0)
3284 #ifdef G_MAIN_POLL_DEBUG
3285 if (_g_main_poll_debug)
3287 g_print ("polling context=%p n=%d timeout=%d\n",
3288 context, n_fds, timeout);
3289 poll_timer = g_timer_new ();
3293 LOCK_CONTEXT (context);
3295 poll_func = context->poll_func;
3297 UNLOCK_CONTEXT (context);
3298 if ((*poll_func) (fds, n_fds, timeout) < 0 && errno != EINTR)
3301 g_warning ("poll(2) failed due to: %s.",
3302 g_strerror (errno));
3304 /* If g_poll () returns -1, it has already called g_warning() */
3308 #ifdef G_MAIN_POLL_DEBUG
3309 if (_g_main_poll_debug)
3311 LOCK_CONTEXT (context);
3313 g_print ("g_main_poll(%d) timeout: %d - elapsed %12.10f seconds",
3316 g_timer_elapsed (poll_timer, NULL));
3317 g_timer_destroy (poll_timer);
3318 pollrec = context->poll_records;
3320 while (pollrec != NULL)
3325 if (fds[i].fd == pollrec->fd->fd &&
3326 pollrec->fd->events &&
3329 g_print (" [" G_POLLFD_FORMAT " :", fds[i].fd);
3330 if (fds[i].revents & G_IO_IN)
3332 if (fds[i].revents & G_IO_OUT)
3334 if (fds[i].revents & G_IO_PRI)
3336 if (fds[i].revents & G_IO_ERR)
3338 if (fds[i].revents & G_IO_HUP)
3340 if (fds[i].revents & G_IO_NVAL)
3346 pollrec = pollrec->next;
3350 UNLOCK_CONTEXT (context);
3353 } /* if (n_fds || timeout != 0) */
3357 * g_main_context_add_poll:
3358 * @context: a #GMainContext (or %NULL for the default context)
3359 * @fd: a #GPollFD structure holding information about a file
3360 * descriptor to watch.
3361 * @priority: the priority for this file descriptor which should be
3362 * the same as the priority used for g_source_attach() to ensure that the
3363 * file descriptor is polled whenever the results may be needed.
3365 * Adds a file descriptor to the set of file descriptors polled for
3366 * this context. This will very seldom be used directly. Instead
3367 * a typical event source will use g_source_add_poll() instead.
3370 g_main_context_add_poll (GMainContext *context,
3375 context = g_main_context_default ();
3377 g_return_if_fail (g_atomic_int_get (&context->ref_count) > 0);
3378 g_return_if_fail (fd);
3380 LOCK_CONTEXT (context);
3381 g_main_context_add_poll_unlocked (context, priority, fd);
3382 UNLOCK_CONTEXT (context);
3385 /* HOLDS: main_loop_lock */
3387 g_main_context_add_poll_unlocked (GMainContext *context,
3391 GPollRec *prevrec, *nextrec;
3392 GPollRec *newrec = g_slice_new (GPollRec);
3394 /* This file descriptor may be checked before we ever poll */
3397 newrec->priority = priority;
3399 prevrec = context->poll_records_tail;
3401 while (prevrec && priority < prevrec->priority)
3404 prevrec = prevrec->prev;
3408 prevrec->next = newrec;
3410 context->poll_records = newrec;
3412 newrec->prev = prevrec;
3413 newrec->next = nextrec;
3416 nextrec->prev = newrec;
3418 context->poll_records_tail = newrec;
3420 context->n_poll_records++;
3422 context->poll_changed = TRUE;
3424 /* Now wake up the main loop if it is waiting in the poll() */
3425 g_main_context_wakeup_unlocked (context);
3429 * g_main_context_remove_poll:
3430 * @context:a #GMainContext
3431 * @fd: a #GPollFD descriptor previously added with g_main_context_add_poll()
3433 * Removes file descriptor from the set of file descriptors to be
3434 * polled for a particular context.
3437 g_main_context_remove_poll (GMainContext *context,
3441 context = g_main_context_default ();
3443 g_return_if_fail (g_atomic_int_get (&context->ref_count) > 0);
3444 g_return_if_fail (fd);
3446 LOCK_CONTEXT (context);
3447 g_main_context_remove_poll_unlocked (context, fd);
3448 UNLOCK_CONTEXT (context);
3452 g_main_context_remove_poll_unlocked (GMainContext *context,
3455 GPollRec *pollrec, *prevrec, *nextrec;
3458 pollrec = context->poll_records;
3462 nextrec = pollrec->next;
3463 if (pollrec->fd == fd)
3465 if (prevrec != NULL)
3466 prevrec->next = nextrec;
3468 context->poll_records = nextrec;
3470 if (nextrec != NULL)
3471 nextrec->prev = prevrec;
3473 context->poll_records_tail = prevrec;
3475 g_slice_free (GPollRec, pollrec);
3477 context->n_poll_records--;
3484 context->poll_changed = TRUE;
3486 /* Now wake up the main loop if it is waiting in the poll() */
3487 g_main_context_wakeup_unlocked (context);
3491 * g_source_get_current_time:
3492 * @source: a #GSource
3493 * @timeval: #GTimeVal structure in which to store current time.
3495 * This function ignores @source and is otherwise the same as
3496 * g_get_current_time().
3498 * Deprecated: 2.28: use g_source_get_time() instead
3501 g_source_get_current_time (GSource *source,
3504 g_get_current_time (timeval);
3508 * g_source_get_time:
3509 * @source: a #GSource
3511 * Gets the time to be used when checking this source. The advantage of
3512 * calling this function over calling g_get_monotonic_time() directly is
3513 * that when checking multiple sources, GLib can cache a single value
3514 * instead of having to repeatedly get the system monotonic time.
3516 * The time here is the system monotonic time, if available, or some
3517 * other reasonable alternative otherwise. See g_get_monotonic_time().
3519 * Returns: the monotonic time in microseconds
3524 g_source_get_time (GSource *source)
3526 GMainContext *context;
3529 g_return_val_if_fail (source->context != NULL, 0);
3531 context = source->context;
3533 LOCK_CONTEXT (context);
3535 if (!context->time_is_fresh)
3537 context->time = g_get_monotonic_time ();
3538 context->time_is_fresh = TRUE;
3541 result = context->time;
3543 UNLOCK_CONTEXT (context);
3549 * g_main_context_set_poll_func:
3550 * @context: a #GMainContext
3551 * @func: the function to call to poll all file descriptors
3553 * Sets the function to use to handle polling of file descriptors. It
3554 * will be used instead of the poll() system call
3555 * (or GLib's replacement function, which is used where
3556 * poll() isn't available).
3558 * This function could possibly be used to integrate the GLib event
3559 * loop with an external event loop.
3562 g_main_context_set_poll_func (GMainContext *context,
3566 context = g_main_context_default ();
3568 g_return_if_fail (g_atomic_int_get (&context->ref_count) > 0);
3570 LOCK_CONTEXT (context);
3573 context->poll_func = func;
3575 context->poll_func = g_poll;
3577 UNLOCK_CONTEXT (context);
3581 * g_main_context_get_poll_func:
3582 * @context: a #GMainContext
3584 * Gets the poll function set by g_main_context_set_poll_func().
3586 * Return value: the poll function
3589 g_main_context_get_poll_func (GMainContext *context)
3594 context = g_main_context_default ();
3596 g_return_val_if_fail (g_atomic_int_get (&context->ref_count) > 0, NULL);
3598 LOCK_CONTEXT (context);
3599 result = context->poll_func;
3600 UNLOCK_CONTEXT (context);
3605 /* HOLDS: context's lock */
3606 /* Wake the main loop up from a poll() */
3608 g_main_context_wakeup_unlocked (GMainContext *context)
3610 if (context->poll_waiting)
3612 context->poll_waiting = FALSE;
3613 g_wakeup_signal (context->wakeup);
3618 * g_main_context_wakeup:
3619 * @context: a #GMainContext
3621 * If @context is currently waiting in a poll(), interrupt
3622 * the poll(), and continue the iteration process.
3625 g_main_context_wakeup (GMainContext *context)
3628 context = g_main_context_default ();
3630 g_return_if_fail (g_atomic_int_get (&context->ref_count) > 0);
3632 LOCK_CONTEXT (context);
3633 g_main_context_wakeup_unlocked (context);
3634 UNLOCK_CONTEXT (context);
3638 * g_main_context_is_owner:
3639 * @context: a #GMainContext
3641 * Determines whether this thread holds the (recursive)
3642 * ownership of this #GMainContext. This is useful to
3643 * know before waiting on another thread that may be
3644 * blocking to get ownership of @context.
3646 * Returns: %TRUE if current thread is owner of @context.
3651 g_main_context_is_owner (GMainContext *context)
3656 context = g_main_context_default ();
3658 LOCK_CONTEXT (context);
3659 is_owner = context->owner == G_THREAD_SELF;
3660 UNLOCK_CONTEXT (context);
3668 g_timeout_set_expiration (GTimeoutSource *timeout_source,
3669 gint64 current_time)
3671 timeout_source->expiration = current_time +
3672 (guint64) timeout_source->interval * 1000;
3674 if (timeout_source->seconds)
3677 static gint timer_perturb = -1;
3679 if (timer_perturb == -1)
3682 * we want a per machine/session unique 'random' value; try the dbus
3683 * address first, that has a UUID in it. If there is no dbus, use the
3684 * hostname for hashing.
3686 const char *session_bus_address = g_getenv ("DBUS_SESSION_BUS_ADDRESS");
3687 if (!session_bus_address)
3688 session_bus_address = g_getenv ("HOSTNAME");
3689 if (session_bus_address)
3690 timer_perturb = ABS ((gint) g_str_hash (session_bus_address)) % 1000000;
3695 /* We want the microseconds part of the timeout to land on the
3696 * 'timer_perturb' mark, but we need to make sure we don't try to
3697 * set the timeout in the past. We do this by ensuring that we
3698 * always only *increase* the expiration time by adding a full
3699 * second in the case that the microsecond portion decreases.
3701 timeout_source->expiration -= timer_perturb;
3703 remainder = timeout_source->expiration % 1000000;
3704 if (remainder >= 1000000/4)
3705 timeout_source->expiration += 1000000;
3707 timeout_source->expiration -= remainder;
3708 timeout_source->expiration += timer_perturb;
3713 g_timeout_prepare (GSource *source,
3716 GTimeoutSource *timeout_source = (GTimeoutSource *) source;
3717 gint64 now = g_source_get_time (source);
3719 if (now < timeout_source->expiration)
3721 /* Round up to ensure that we don't try again too early */
3722 *timeout = (timeout_source->expiration - now + 999) / 1000;
3731 g_timeout_check (GSource *source)
3733 GTimeoutSource *timeout_source = (GTimeoutSource *) source;
3734 gint64 now = g_source_get_time (source);
3736 return timeout_source->expiration <= now;
3740 g_timeout_dispatch (GSource *source,
3741 GSourceFunc callback,
3744 GTimeoutSource *timeout_source = (GTimeoutSource *)source;
3749 g_warning ("Timeout source dispatched without callback\n"
3750 "You must call g_source_set_callback().");
3754 again = callback (user_data);
3757 g_timeout_set_expiration (timeout_source, g_source_get_time (source));
3763 * g_timeout_source_new:
3764 * @interval: the timeout interval in milliseconds.
3766 * Creates a new timeout source.
3768 * The source will not initially be associated with any #GMainContext
3769 * and must be added to one with g_source_attach() before it will be
3772 * The interval given is in terms of monotonic time, not wall clock
3773 * time. See g_get_monotonic_time().
3775 * Return value: the newly-created timeout source
3778 g_timeout_source_new (guint interval)
3780 GSource *source = g_source_new (&g_timeout_funcs, sizeof (GTimeoutSource));
3781 GTimeoutSource *timeout_source = (GTimeoutSource *)source;
3783 timeout_source->interval = interval;
3784 g_timeout_set_expiration (timeout_source, g_get_monotonic_time ());
3790 * g_timeout_source_new_seconds:
3791 * @interval: the timeout interval in seconds
3793 * Creates a new timeout source.
3795 * The source will not initially be associated with any #GMainContext
3796 * and must be added to one with g_source_attach() before it will be
3799 * The scheduling granularity/accuracy of this timeout source will be
3802 * The interval given in terms of monotonic time, not wall clock time.
3803 * See g_get_monotonic_time().
3805 * Return value: the newly-created timeout source
3810 g_timeout_source_new_seconds (guint interval)
3812 GSource *source = g_source_new (&g_timeout_funcs, sizeof (GTimeoutSource));
3813 GTimeoutSource *timeout_source = (GTimeoutSource *)source;
3815 timeout_source->interval = 1000 * interval;
3816 timeout_source->seconds = TRUE;
3818 g_timeout_set_expiration (timeout_source, g_get_monotonic_time ());
3825 * g_timeout_add_full:
3826 * @priority: the priority of the timeout source. Typically this will be in
3827 * the range between #G_PRIORITY_DEFAULT and #G_PRIORITY_HIGH.
3828 * @interval: the time between calls to the function, in milliseconds
3829 * (1/1000ths of a second)
3830 * @function: function to call
3831 * @data: data to pass to @function
3832 * @notify: function to call when the timeout is removed, or %NULL
3834 * Sets a function to be called at regular intervals, with the given
3835 * priority. The function is called repeatedly until it returns
3836 * %FALSE, at which point the timeout is automatically destroyed and
3837 * the function will not be called again. The @notify function is
3838 * called when the timeout is destroyed. The first call to the
3839 * function will be at the end of the first @interval.
3841 * Note that timeout functions may be delayed, due to the processing of other
3842 * event sources. Thus they should not be relied on for precise timing.
3843 * After each call to the timeout function, the time of the next
3844 * timeout is recalculated based on the current time and the given interval
3845 * (it does not try to 'catch up' time lost in delays).
3847 * This internally creates a main loop source using g_timeout_source_new()
3848 * and attaches it to the main loop context using g_source_attach(). You can
3849 * do these steps manually if you need greater control.
3851 * The interval given in terms of monotonic time, not wall clock time.
3852 * See g_get_monotonic_time().
3854 * Return value: the ID (greater than 0) of the event source.
3855 * Rename to: g_timeout_add
3858 g_timeout_add_full (gint priority,
3860 GSourceFunc function,
3862 GDestroyNotify notify)
3867 g_return_val_if_fail (function != NULL, 0);
3869 source = g_timeout_source_new (interval);
3871 if (priority != G_PRIORITY_DEFAULT)
3872 g_source_set_priority (source, priority);
3874 g_source_set_callback (source, function, data, notify);
3875 id = g_source_attach (source, NULL);
3876 g_source_unref (source);
3883 * @interval: the time between calls to the function, in milliseconds
3884 * (1/1000ths of a second)
3885 * @function: function to call
3886 * @data: data to pass to @function
3888 * Sets a function to be called at regular intervals, with the default
3889 * priority, #G_PRIORITY_DEFAULT. The function is called repeatedly
3890 * until it returns %FALSE, at which point the timeout is automatically
3891 * destroyed and the function will not be called again. The first call
3892 * to the function will be at the end of the first @interval.
3894 * Note that timeout functions may be delayed, due to the processing of other
3895 * event sources. Thus they should not be relied on for precise timing.
3896 * After each call to the timeout function, the time of the next
3897 * timeout is recalculated based on the current time and the given interval
3898 * (it does not try to 'catch up' time lost in delays).
3900 * If you want to have a timer in the "seconds" range and do not care
3901 * about the exact time of the first call of the timer, use the
3902 * g_timeout_add_seconds() function; this function allows for more
3903 * optimizations and more efficient system power usage.
3905 * This internally creates a main loop source using g_timeout_source_new()
3906 * and attaches it to the main loop context using g_source_attach(). You can
3907 * do these steps manually if you need greater control.
3909 * The interval given is in terms of monotonic time, not wall clock
3910 * time. See g_get_monotonic_time().
3912 * Return value: the ID (greater than 0) of the event source.
3915 g_timeout_add (guint32 interval,
3916 GSourceFunc function,
3919 return g_timeout_add_full (G_PRIORITY_DEFAULT,
3920 interval, function, data, NULL);
3924 * g_timeout_add_seconds_full:
3925 * @priority: the priority of the timeout source. Typically this will be in
3926 * the range between #G_PRIORITY_DEFAULT and #G_PRIORITY_HIGH.
3927 * @interval: the time between calls to the function, in seconds
3928 * @function: function to call
3929 * @data: data to pass to @function
3930 * @notify: function to call when the timeout is removed, or %NULL
3932 * Sets a function to be called at regular intervals, with @priority.
3933 * The function is called repeatedly until it returns %FALSE, at which
3934 * point the timeout is automatically destroyed and the function will
3935 * not be called again.
3937 * Unlike g_timeout_add(), this function operates at whole second granularity.
3938 * The initial starting point of the timer is determined by the implementation
3939 * and the implementation is expected to group multiple timers together so that
3940 * they fire all at the same time.
3941 * To allow this grouping, the @interval to the first timer is rounded
3942 * and can deviate up to one second from the specified interval.
3943 * Subsequent timer iterations will generally run at the specified interval.
3945 * Note that timeout functions may be delayed, due to the processing of other
3946 * event sources. Thus they should not be relied on for precise timing.
3947 * After each call to the timeout function, the time of the next
3948 * timeout is recalculated based on the current time and the given @interval
3950 * If you want timing more precise than whole seconds, use g_timeout_add()
3953 * The grouping of timers to fire at the same time results in a more power
3954 * and CPU efficient behavior so if your timer is in multiples of seconds
3955 * and you don't require the first timer exactly one second from now, the
3956 * use of g_timeout_add_seconds() is preferred over g_timeout_add().
3958 * This internally creates a main loop source using
3959 * g_timeout_source_new_seconds() and attaches it to the main loop context
3960 * using g_source_attach(). You can do these steps manually if you need
3963 * The interval given is in terms of monotonic time, not wall clock
3964 * time. See g_get_monotonic_time().
3966 * Return value: the ID (greater than 0) of the event source.
3968 * Rename to: g_timeout_add_seconds
3972 g_timeout_add_seconds_full (gint priority,
3974 GSourceFunc function,
3976 GDestroyNotify notify)
3981 g_return_val_if_fail (function != NULL, 0);
3983 source = g_timeout_source_new_seconds (interval);
3985 if (priority != G_PRIORITY_DEFAULT)
3986 g_source_set_priority (source, priority);
3988 g_source_set_callback (source, function, data, notify);
3989 id = g_source_attach (source, NULL);
3990 g_source_unref (source);
3996 * g_timeout_add_seconds:
3997 * @interval: the time between calls to the function, in seconds
3998 * @function: function to call
3999 * @data: data to pass to @function
4001 * Sets a function to be called at regular intervals with the default
4002 * priority, #G_PRIORITY_DEFAULT. The function is called repeatedly until
4003 * it returns %FALSE, at which point the timeout is automatically destroyed
4004 * and the function will not be called again.
4006 * This internally creates a main loop source using
4007 * g_timeout_source_new_seconds() and attaches it to the main loop context
4008 * using g_source_attach(). You can do these steps manually if you need
4009 * greater control. Also see g_timeout_add_seconds_full().
4011 * Note that the first call of the timer may not be precise for timeouts
4012 * of one second. If you need finer precision and have such a timeout,
4013 * you may want to use g_timeout_add() instead.
4015 * The interval given is in terms of monotonic time, not wall clock
4016 * time. See g_get_monotonic_time().
4018 * Return value: the ID (greater than 0) of the event source.
4023 g_timeout_add_seconds (guint interval,
4024 GSourceFunc function,
4027 g_return_val_if_fail (function != NULL, 0);
4029 return g_timeout_add_seconds_full (G_PRIORITY_DEFAULT, interval, function, data, NULL);
4032 /* Child watch functions */
4037 g_child_watch_prepare (GSource *source,
4046 g_child_watch_check (GSource *source)
4048 GChildWatchSource *child_watch_source;
4049 gboolean child_exited;
4051 child_watch_source = (GChildWatchSource *) source;
4053 child_exited = child_watch_source->poll.revents & G_IO_IN;
4060 * Note: We do _not_ check for the special value of STILL_ACTIVE
4061 * since we know that the process has exited and doing so runs into
4062 * problems if the child process "happens to return STILL_ACTIVE(259)"
4063 * as Microsoft's Platform SDK puts it.
4065 if (!GetExitCodeProcess (child_watch_source->pid, &child_status))
4067 gchar *emsg = g_win32_error_message (GetLastError ());
4068 g_warning (G_STRLOC ": GetExitCodeProcess() failed: %s", emsg);
4071 child_watch_source->child_status = -1;
4074 child_watch_source->child_status = child_status;
4077 return child_exited;
4080 #else /* G_OS_WIN32 */
4083 wake_source (GSource *source)
4085 GMainContext *context;
4087 /* This should be thread-safe:
4089 * - if the source is currently being added to a context, that
4090 * context will be woken up anyway
4092 * - if the source is currently being destroyed, we simply need not
4095 * - the memory for the source will remain valid until after the
4096 * source finalize function was called (which would remove the
4097 * source from the global list which we are currently holding the
4100 * - the GMainContext will either be NULL or point to a live
4103 * - the GMainContext will remain valid since we hold the
4104 * main_context_list lock
4106 * Since we are holding a lot of locks here, don't try to enter any
4107 * more GMainContext functions for fear of dealock -- just hit the
4108 * GWakeup and run. Even if that's safe now, it could easily become
4109 * unsafe with some very minor changes in the future, and signal
4110 * handling is not the most well-tested codepath.
4112 G_LOCK(main_context_list);
4113 context = source->context;
4115 g_wakeup_signal (context->wakeup);
4116 G_UNLOCK(main_context_list);
4120 dispatch_unix_signals (void)
4124 /* clear this first incase another one arrives while we're processing */
4125 any_unix_signal_pending = FALSE;
4127 G_LOCK(unix_signal_lock);
4129 /* handle GChildWatchSource instances */
4130 if (unix_signal_pending[SIGCHLD])
4132 unix_signal_pending[SIGCHLD] = FALSE;
4134 /* The only way we can do this is to scan all of the children.
4136 * The docs promise that we will not reap children that we are not
4137 * explicitly watching, so that ties our hands from calling
4138 * waitpid(-1). We also can't use siginfo's si_pid field since if
4139 * multiple SIGCHLD arrive at the same time, one of them can be
4140 * dropped (since a given UNIX signal can only be pending once).
4142 for (node = unix_child_watches; node; node = node->next)
4144 GChildWatchSource *source = node->data;
4146 if (!source->child_exited)
4148 if (waitpid (source->pid, &source->child_status, WNOHANG) > 0)
4150 source->child_exited = TRUE;
4152 wake_source ((GSource *) source);
4158 /* handle GUnixSignalWatchSource instances */
4159 for (node = unix_signal_watches; node; node = node->next)
4161 GUnixSignalWatchSource *source = node->data;
4163 if (!source->pending)
4165 if (unix_signal_pending[source->signum])
4167 unix_signal_pending[source->signum] = FALSE;
4168 source->pending = TRUE;
4170 wake_source ((GSource *) source);
4175 G_UNLOCK(unix_signal_lock);
4179 g_child_watch_prepare (GSource *source,
4182 GChildWatchSource *child_watch_source;
4184 child_watch_source = (GChildWatchSource *) source;
4186 return child_watch_source->child_exited;
4190 g_child_watch_check (GSource *source)
4192 GChildWatchSource *child_watch_source;
4194 child_watch_source = (GChildWatchSource *) source;
4196 return child_watch_source->child_exited;
4200 g_unix_signal_watch_prepare (GSource *source,
4203 GUnixSignalWatchSource *unix_signal_source;
4205 unix_signal_source = (GUnixSignalWatchSource *) source;
4207 return unix_signal_source->pending;
4211 g_unix_signal_watch_check (GSource *source)
4213 GUnixSignalWatchSource *unix_signal_source;
4215 unix_signal_source = (GUnixSignalWatchSource *) source;
4217 return unix_signal_source->pending;
4221 g_unix_signal_watch_dispatch (GSource *source,
4222 GSourceFunc callback,
4225 GUnixSignalWatchSource *unix_signal_source;
4227 unix_signal_source = (GUnixSignalWatchSource *) source;
4231 g_warning ("Unix signal source dispatched without callback\n"
4232 "You must call g_source_set_callback().");
4236 (callback) (user_data);
4238 unix_signal_source->pending = FALSE;
4244 ensure_unix_signal_handler_installed_unlocked (int signum)
4246 static sigset_t installed_signal_mask;
4247 static gboolean initialized;
4248 struct sigaction action;
4252 sigemptyset (&installed_signal_mask);
4253 g_get_worker_context ();
4257 if (sigismember (&installed_signal_mask, signum))
4260 sigaddset (&installed_signal_mask, signum);
4262 action.sa_handler = g_unix_signal_handler;
4263 sigemptyset (&action.sa_mask);
4264 action.sa_flags = SA_RESTART | SA_NOCLDSTOP;
4265 sigaction (signum, &action, NULL);
4269 _g_main_create_unix_signal_watch (int signum)
4272 GUnixSignalWatchSource *unix_signal_source;
4274 source = g_source_new (&g_unix_signal_funcs, sizeof (GUnixSignalWatchSource));
4275 unix_signal_source = (GUnixSignalWatchSource *) source;
4277 unix_signal_source->signum = signum;
4278 unix_signal_source->pending = FALSE;
4280 G_LOCK (unix_signal_lock);
4281 ensure_unix_signal_handler_installed_unlocked (signum);
4282 unix_signal_watches = g_slist_prepend (unix_signal_watches, unix_signal_source);
4283 if (unix_signal_pending[signum])
4284 unix_signal_source->pending = TRUE;
4285 unix_signal_pending[signum] = FALSE;
4286 G_UNLOCK (unix_signal_lock);
4292 g_unix_signal_watch_finalize (GSource *source)
4294 G_LOCK (unix_signal_lock);
4295 unix_signal_watches = g_slist_remove (unix_signal_watches, source);
4296 G_UNLOCK (unix_signal_lock);
4299 #endif /* G_OS_WIN32 */
4302 g_child_watch_finalize (GSource *source)
4304 G_LOCK (unix_signal_lock);
4305 unix_child_watches = g_slist_remove (unix_child_watches, source);
4306 G_UNLOCK (unix_signal_lock);
4310 g_child_watch_dispatch (GSource *source,
4311 GSourceFunc callback,
4314 GChildWatchSource *child_watch_source;
4315 GChildWatchFunc child_watch_callback = (GChildWatchFunc) callback;
4317 child_watch_source = (GChildWatchSource *) source;
4321 g_warning ("Child watch source dispatched without callback\n"
4322 "You must call g_source_set_callback().");
4326 (child_watch_callback) (child_watch_source->pid, child_watch_source->child_status, user_data);
4328 /* We never keep a child watch source around as the child is gone */
4335 g_unix_signal_handler (int signum)
4337 unix_signal_pending[signum] = TRUE;
4338 any_unix_signal_pending = TRUE;
4340 g_wakeup_signal (glib_worker_context->wakeup);
4343 #endif /* !G_OS_WIN32 */
4346 * g_child_watch_source_new:
4347 * @pid: process to watch. On POSIX the pid of a child process. On
4348 * Windows a handle for a process (which doesn't have to be a child).
4350 * Creates a new child_watch source.
4352 * The source will not initially be associated with any #GMainContext
4353 * and must be added to one with g_source_attach() before it will be
4356 * Note that child watch sources can only be used in conjunction with
4357 * <literal>g_spawn...</literal> when the %G_SPAWN_DO_NOT_REAP_CHILD
4360 * Note that on platforms where #GPid must be explicitly closed
4361 * (see g_spawn_close_pid()) @pid must not be closed while the
4362 * source is still active. Typically, you will want to call
4363 * g_spawn_close_pid() in the callback function for the source.
4365 * Note further that using g_child_watch_source_new() is not
4366 * compatible with calling <literal>waitpid(-1)</literal> in
4367 * the application. Calling waitpid() for individual pids will
4370 * Return value: the newly-created child watch source
4375 g_child_watch_source_new (GPid pid)
4377 GSource *source = g_source_new (&g_child_watch_funcs, sizeof (GChildWatchSource));
4378 GChildWatchSource *child_watch_source = (GChildWatchSource *)source;
4380 child_watch_source->pid = pid;
4383 child_watch_source->poll.fd = (gintptr) pid;
4384 child_watch_source->poll.events = G_IO_IN;
4386 g_source_add_poll (source, &child_watch_source->poll);
4387 #else /* G_OS_WIN32 */
4388 G_LOCK (unix_signal_lock);
4389 ensure_unix_signal_handler_installed_unlocked (SIGCHLD);
4390 unix_child_watches = g_slist_prepend (unix_child_watches, child_watch_source);
4391 if (waitpid (pid, &child_watch_source->child_status, WNOHANG) > 0)
4392 child_watch_source->child_exited = TRUE;
4393 G_UNLOCK (unix_signal_lock);
4394 #endif /* G_OS_WIN32 */
4400 * g_child_watch_add_full:
4401 * @priority: the priority of the idle source. Typically this will be in the
4402 * range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE.
4403 * @pid: process to watch. On POSIX the pid of a child process. On
4404 * Windows a handle for a process (which doesn't have to be a child).
4405 * @function: function to call
4406 * @data: data to pass to @function
4407 * @notify: function to call when the idle is removed, or %NULL
4409 * Sets a function to be called when the child indicated by @pid
4410 * exits, at the priority @priority.
4412 * If you obtain @pid from g_spawn_async() or g_spawn_async_with_pipes()
4413 * you will need to pass #G_SPAWN_DO_NOT_REAP_CHILD as flag to
4414 * the spawn function for the child watching to work.
4416 * Note that on platforms where #GPid must be explicitly closed
4417 * (see g_spawn_close_pid()) @pid must not be closed while the
4418 * source is still active. Typically, you will want to call
4419 * g_spawn_close_pid() in the callback function for the source.
4421 * GLib supports only a single callback per process id.
4423 * This internally creates a main loop source using
4424 * g_child_watch_source_new() and attaches it to the main loop context
4425 * using g_source_attach(). You can do these steps manually if you
4426 * need greater control.
4428 * Return value: the ID (greater than 0) of the event source.
4430 * Rename to: g_child_watch_add
4434 g_child_watch_add_full (gint priority,
4436 GChildWatchFunc function,
4438 GDestroyNotify notify)
4443 g_return_val_if_fail (function != NULL, 0);
4445 source = g_child_watch_source_new (pid);
4447 if (priority != G_PRIORITY_DEFAULT)
4448 g_source_set_priority (source, priority);
4450 g_source_set_callback (source, (GSourceFunc) function, data, notify);
4451 id = g_source_attach (source, NULL);
4452 g_source_unref (source);
4458 * g_child_watch_add:
4459 * @pid: process id to watch. On POSIX the pid of a child process. On
4460 * Windows a handle for a process (which doesn't have to be a child).
4461 * @function: function to call
4462 * @data: data to pass to @function
4464 * Sets a function to be called when the child indicated by @pid
4465 * exits, at a default priority, #G_PRIORITY_DEFAULT.
4467 * If you obtain @pid from g_spawn_async() or g_spawn_async_with_pipes()
4468 * you will need to pass #G_SPAWN_DO_NOT_REAP_CHILD as flag to
4469 * the spawn function for the child watching to work.
4471 * Note that on platforms where #GPid must be explicitly closed
4472 * (see g_spawn_close_pid()) @pid must not be closed while the
4473 * source is still active. Typically, you will want to call
4474 * g_spawn_close_pid() in the callback function for the source.
4476 * GLib supports only a single callback per process id.
4478 * This internally creates a main loop source using
4479 * g_child_watch_source_new() and attaches it to the main loop context
4480 * using g_source_attach(). You can do these steps manually if you
4481 * need greater control.
4483 * Return value: the ID (greater than 0) of the event source.
4488 g_child_watch_add (GPid pid,
4489 GChildWatchFunc function,
4492 return g_child_watch_add_full (G_PRIORITY_DEFAULT, pid, function, data, NULL);
4496 /* Idle functions */
4499 g_idle_prepare (GSource *source,
4508 g_idle_check (GSource *source)
4514 g_idle_dispatch (GSource *source,
4515 GSourceFunc callback,
4520 g_warning ("Idle source dispatched without callback\n"
4521 "You must call g_source_set_callback().");
4525 return callback (user_data);
4529 * g_idle_source_new:
4531 * Creates a new idle source.
4533 * The source will not initially be associated with any #GMainContext
4534 * and must be added to one with g_source_attach() before it will be
4535 * executed. Note that the default priority for idle sources is
4536 * %G_PRIORITY_DEFAULT_IDLE, as compared to other sources which
4537 * have a default priority of %G_PRIORITY_DEFAULT.
4539 * Return value: the newly-created idle source
4542 g_idle_source_new (void)
4546 source = g_source_new (&g_idle_funcs, sizeof (GSource));
4547 g_source_set_priority (source, G_PRIORITY_DEFAULT_IDLE);
4554 * @priority: the priority of the idle source. Typically this will be in the
4555 * range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE.
4556 * @function: function to call
4557 * @data: data to pass to @function
4558 * @notify: function to call when the idle is removed, or %NULL
4560 * Adds a function to be called whenever there are no higher priority
4561 * events pending. If the function returns %FALSE it is automatically
4562 * removed from the list of event sources and will not be called again.
4564 * This internally creates a main loop source using g_idle_source_new()
4565 * and attaches it to the main loop context using g_source_attach().
4566 * You can do these steps manually if you need greater control.
4568 * Return value: the ID (greater than 0) of the event source.
4569 * Rename to: g_idle_add
4572 g_idle_add_full (gint priority,
4573 GSourceFunc function,
4575 GDestroyNotify notify)
4580 g_return_val_if_fail (function != NULL, 0);
4582 source = g_idle_source_new ();
4584 if (priority != G_PRIORITY_DEFAULT_IDLE)
4585 g_source_set_priority (source, priority);
4587 g_source_set_callback (source, function, data, notify);
4588 id = g_source_attach (source, NULL);
4589 g_source_unref (source);
4596 * @function: function to call
4597 * @data: data to pass to @function.
4599 * Adds a function to be called whenever there are no higher priority
4600 * events pending to the default main loop. The function is given the
4601 * default idle priority, #G_PRIORITY_DEFAULT_IDLE. If the function
4602 * returns %FALSE it is automatically removed from the list of event
4603 * sources and will not be called again.
4605 * This internally creates a main loop source using g_idle_source_new()
4606 * and attaches it to the main loop context using g_source_attach().
4607 * You can do these steps manually if you need greater control.
4609 * Return value: the ID (greater than 0) of the event source.
4612 g_idle_add (GSourceFunc function,
4615 return g_idle_add_full (G_PRIORITY_DEFAULT_IDLE, function, data, NULL);
4619 * g_idle_remove_by_data:
4620 * @data: the data for the idle source's callback.
4622 * Removes the idle function with the given data.
4624 * Return value: %TRUE if an idle source was found and removed.
4627 g_idle_remove_by_data (gpointer data)
4629 return g_source_remove_by_funcs_user_data (&g_idle_funcs, data);
4633 * g_main_context_invoke:
4634 * @context: (allow-none): a #GMainContext, or %NULL
4635 * @function: function to call
4636 * @data: data to pass to @function
4638 * Invokes a function in such a way that @context is owned during the
4639 * invocation of @function.
4641 * If @context is %NULL then the global default main context — as
4642 * returned by g_main_context_default() — is used.
4644 * If @context is owned by the current thread, @function is called
4645 * directly. Otherwise, if @context is the thread-default main context
4646 * of the current thread and g_main_context_acquire() succeeds, then
4647 * @function is called and g_main_context_release() is called
4650 * In any other case, an idle source is created to call @function and
4651 * that source is attached to @context (presumably to be run in another
4652 * thread). The idle source is attached with #G_PRIORITY_DEFAULT
4653 * priority. If you want a different priority, use
4654 * g_main_context_invoke_full().
4656 * Note that, as with normal idle functions, @function should probably
4657 * return %FALSE. If it returns %TRUE, it will be continuously run in a
4658 * loop (and may prevent this call from returning).
4663 g_main_context_invoke (GMainContext *context,
4664 GSourceFunc function,
4667 g_main_context_invoke_full (context,
4669 function, data, NULL);
4673 * g_main_context_invoke_full:
4674 * @context: (allow-none): a #GMainContext, or %NULL
4675 * @priority: the priority at which to run @function
4676 * @function: function to call
4677 * @data: data to pass to @function
4678 * @notify: a function to call when @data is no longer in use, or %NULL.
4680 * Invokes a function in such a way that @context is owned during the
4681 * invocation of @function.
4683 * This function is the same as g_main_context_invoke() except that it
4684 * lets you specify the priority incase @function ends up being
4685 * scheduled as an idle and also lets you give a #GDestroyNotify for @data.
4687 * @notify should not assume that it is called from any particular
4688 * thread or with any particular context acquired.
4693 g_main_context_invoke_full (GMainContext *context,
4695 GSourceFunc function,
4697 GDestroyNotify notify)
4699 g_return_if_fail (function != NULL);
4702 context = g_main_context_default ();
4704 if (g_main_context_is_owner (context))
4706 while (function (data));
4713 GMainContext *thread_default;
4715 thread_default = g_main_context_get_thread_default ();
4717 if (!thread_default)
4718 thread_default = g_main_context_default ();
4720 if (thread_default == context && g_main_context_acquire (context))
4722 while (function (data));
4724 g_main_context_release (context);
4733 source = g_idle_source_new ();
4734 g_source_set_priority (source, priority);
4735 g_source_set_callback (source, function, data, notify);
4736 g_source_attach (source, context);
4737 g_source_unref (source);
4743 glib_worker_main (gpointer data)
4747 g_main_context_iteration (glib_worker_context, TRUE);
4749 if (any_unix_signal_pending)
4750 dispatch_unix_signals ();
4753 return NULL; /* worst GCC warning message ever... */
4757 g_get_worker_context (void)
4759 static gsize initialised;
4761 g_thread_init_glib ();
4763 if (g_once_init_enter (&initialised))
4765 GError *error = NULL;
4767 glib_worker_context = g_main_context_new ();
4768 if (g_thread_create (glib_worker_main, NULL, FALSE, &error) == NULL)
4769 g_error ("Creating GLib worker thread failed: %s\n", error->message);
4771 g_once_init_leave (&initialised, TRUE);
4774 return glib_worker_context;