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"
54 #include <sys/eventfd.h>
59 #include <sys/types.h>
62 #ifdef HAVE_SYS_TIME_H
64 #endif /* HAVE_SYS_TIME_H */
67 #endif /* HAVE_UNISTD_H */
74 #endif /* G_OS_WIN32 */
77 #include <sys/socket.h>
79 #endif /* G_OS_BEOS */
84 #include "giochannel.h"
88 #include "gstrfuncs.h"
89 #include "gtestutils.h"
95 #ifdef G_MAIN_POLL_DEBUG
100 #include "gmain-internal.h"
101 #include "glib-private.h"
105 * @title: The Main Event Loop
106 * @short_description: manages all available sources of events
108 * The main event loop manages all the available sources of events for
109 * GLib and GTK+ applications. These events can come from any number of
110 * different types of sources such as file descriptors (plain files,
111 * pipes or sockets) and timeouts. New types of event sources can also
112 * be added using g_source_attach().
114 * To allow multiple independent sets of sources to be handled in
115 * different threads, each source is associated with a #GMainContext.
116 * A GMainContext can only be running in a single thread, but
117 * sources can be added to it and removed from it from other threads.
119 * Each event source is assigned a priority. The default priority,
120 * #G_PRIORITY_DEFAULT, is 0. Values less than 0 denote higher priorities.
121 * Values greater than 0 denote lower priorities. Events from high priority
122 * sources are always processed before events from lower priority sources.
124 * Idle functions can also be added, and assigned a priority. These will
125 * be run whenever no events with a higher priority are ready to be processed.
127 * The #GMainLoop data type represents a main event loop. A GMainLoop is
128 * created with g_main_loop_new(). After adding the initial event sources,
129 * g_main_loop_run() is called. This continuously checks for new events from
130 * each of the event sources and dispatches them. Finally, the processing of
131 * an event from one of the sources leads to a call to g_main_loop_quit() to
132 * exit the main loop, and g_main_loop_run() returns.
134 * It is possible to create new instances of #GMainLoop recursively.
135 * This is often used in GTK+ applications when showing modal dialog
136 * boxes. Note that event sources are associated with a particular
137 * #GMainContext, and will be checked and dispatched for all main
138 * loops associated with that GMainContext.
140 * GTK+ contains wrappers of some of these functions, e.g. gtk_main(),
141 * gtk_main_quit() and gtk_events_pending().
143 * <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>
178 * On Unix, the GLib mainloop is incompatible with fork(). Any program
179 * using the mainloop must either exec() or exit() from the child
180 * without returning to the mainloop.
185 typedef struct _GTimeoutSource GTimeoutSource;
186 typedef struct _GChildWatchSource GChildWatchSource;
187 typedef struct _GUnixSignalWatchSource GUnixSignalWatchSource;
188 typedef struct _GPollRec GPollRec;
189 typedef struct _GSourceCallback GSourceCallback;
193 G_SOURCE_READY = 1 << G_HOOK_FLAG_USER_SHIFT,
194 G_SOURCE_CAN_RECURSE = 1 << (G_HOOK_FLAG_USER_SHIFT + 1)
197 typedef struct _GMainWaiter GMainWaiter;
205 typedef struct _GMainDispatch GMainDispatch;
207 struct _GMainDispatch
210 GSList *dispatching_sources; /* stack of current sources */
213 #ifdef G_MAIN_POLL_DEBUG
214 gboolean _g_main_poll_debug = FALSE;
219 /* The following lock is used for both the list of sources
220 * and the list of poll records
230 GPtrArray *pending_dispatches;
231 gint timeout; /* Timeout for current iteration */
234 GSource *source_list;
235 gint in_check_or_prepare;
237 GPollRec *poll_records, *poll_records_tail;
238 guint n_poll_records;
239 GPollFD *cached_poll_array;
240 guint cached_poll_array_size;
246 /* Flag indicating whether the set of fd's changed during a poll */
247 gboolean poll_changed;
252 gboolean time_is_fresh;
255 struct _GSourceCallback
260 GDestroyNotify notify;
265 GMainContext *context;
270 struct _GTimeoutSource
278 struct _GChildWatchSource
285 #else /* G_OS_WIN32 */
286 gboolean child_exited;
287 #endif /* G_OS_WIN32 */
290 struct _GUnixSignalWatchSource
305 struct _GSourcePrivate
307 GSList *child_sources;
308 GSource *parent_source;
311 #define LOCK_CONTEXT(context) g_mutex_lock (&context->mutex)
312 #define UNLOCK_CONTEXT(context) g_mutex_unlock (&context->mutex)
313 #define G_THREAD_SELF g_thread_self ()
315 #define SOURCE_DESTROYED(source) (((source)->flags & G_HOOK_FLAG_ACTIVE) == 0)
316 #define SOURCE_BLOCKED(source) (((source)->flags & G_HOOK_FLAG_IN_CALL) != 0 && \
317 ((source)->flags & G_SOURCE_CAN_RECURSE) == 0)
319 #define SOURCE_UNREF(source, context) \
321 if ((source)->ref_count > 1) \
322 (source)->ref_count--; \
324 g_source_unref_internal ((source), (context), TRUE); \
328 /* Forward declarations */
330 static void g_source_unref_internal (GSource *source,
331 GMainContext *context,
333 static void g_source_destroy_internal (GSource *source,
334 GMainContext *context,
336 static void g_source_set_priority_unlocked (GSource *source,
337 GMainContext *context,
339 static void g_main_context_poll (GMainContext *context,
344 static void g_main_context_add_poll_unlocked (GMainContext *context,
347 static void g_main_context_remove_poll_unlocked (GMainContext *context,
350 static gboolean g_timeout_prepare (GSource *source,
352 static gboolean g_timeout_check (GSource *source);
353 static gboolean g_timeout_dispatch (GSource *source,
354 GSourceFunc callback,
356 static gboolean g_child_watch_prepare (GSource *source,
358 static gboolean g_child_watch_check (GSource *source);
359 static gboolean g_child_watch_dispatch (GSource *source,
360 GSourceFunc callback,
362 static void g_child_watch_finalize (GSource *source);
364 static void g_unix_signal_handler (int signum);
365 static gboolean g_unix_signal_watch_prepare (GSource *source,
367 static gboolean g_unix_signal_watch_check (GSource *source);
368 static gboolean g_unix_signal_watch_dispatch (GSource *source,
369 GSourceFunc callback,
371 static void g_unix_signal_watch_finalize (GSource *source);
373 static gboolean g_idle_prepare (GSource *source,
375 static gboolean g_idle_check (GSource *source);
376 static gboolean g_idle_dispatch (GSource *source,
377 GSourceFunc callback,
380 static GMainContext *glib_worker_context;
382 G_LOCK_DEFINE_STATIC (main_loop);
383 static GMainContext *default_main_context;
388 /* UNIX signals work by marking one of these variables then waking the
389 * worker context to check on them and dispatch accordingly.
391 static volatile gchar unix_signal_pending[NSIG];
392 static volatile gboolean any_unix_signal_pending;
394 /* Guards all the data below */
395 G_LOCK_DEFINE_STATIC (unix_signal_lock);
396 static GSList *unix_signal_watches;
397 static GSList *unix_child_watches;
399 static GSourceFuncs g_unix_signal_funcs =
401 g_unix_signal_watch_prepare,
402 g_unix_signal_watch_check,
403 g_unix_signal_watch_dispatch,
404 g_unix_signal_watch_finalize
406 #endif /* !G_OS_WIN32 */
407 G_LOCK_DEFINE_STATIC (main_context_list);
408 static GSList *main_context_list = NULL;
410 GSourceFuncs g_timeout_funcs =
418 GSourceFuncs g_child_watch_funcs =
420 g_child_watch_prepare,
422 g_child_watch_dispatch,
423 g_child_watch_finalize
426 GSourceFuncs g_idle_funcs =
435 * g_main_context_ref:
436 * @context: a #GMainContext
438 * Increases the reference count on a #GMainContext object by one.
440 * Returns: the @context that was passed in (since 2.6)
443 g_main_context_ref (GMainContext *context)
445 g_return_val_if_fail (context != NULL, NULL);
446 g_return_val_if_fail (g_atomic_int_get (&context->ref_count) > 0, NULL);
448 g_atomic_int_inc (&context->ref_count);
454 poll_rec_list_free (GMainContext *context,
457 g_slice_free_chain (GPollRec, list, next);
461 * g_main_context_unref:
462 * @context: a #GMainContext
464 * Decreases the reference count on a #GMainContext object by one. If
465 * the result is zero, free the context and free all associated memory.
468 g_main_context_unref (GMainContext *context)
471 g_return_if_fail (context != NULL);
472 g_return_if_fail (g_atomic_int_get (&context->ref_count) > 0);
474 if (!g_atomic_int_dec_and_test (&context->ref_count))
477 G_LOCK (main_context_list);
478 main_context_list = g_slist_remove (main_context_list, context);
479 G_UNLOCK (main_context_list);
481 source = context->source_list;
484 GSource *next = source->next;
485 g_source_destroy_internal (source, context, FALSE);
489 g_mutex_clear (&context->mutex);
491 g_ptr_array_free (context->pending_dispatches, TRUE);
492 g_free (context->cached_poll_array);
494 poll_rec_list_free (context, context->poll_records);
496 g_wakeup_free (context->wakeup);
497 g_cond_clear (&context->cond);
503 * g_main_context_new:
505 * Creates a new #GMainContext structure.
507 * Return value: the new #GMainContext
510 g_main_context_new (void)
512 static gsize initialised;
513 GMainContext *context;
515 if (g_once_init_enter (&initialised))
517 #ifdef G_MAIN_POLL_DEBUG
518 if (getenv ("G_MAIN_POLL_DEBUG") != NULL)
519 _g_main_poll_debug = TRUE;
522 g_once_init_leave (&initialised, TRUE);
525 context = g_new0 (GMainContext, 1);
527 g_mutex_init (&context->mutex);
528 g_cond_init (&context->cond);
530 context->owner = NULL;
531 context->waiters = NULL;
533 context->ref_count = 1;
535 context->next_id = 1;
537 context->source_list = NULL;
539 context->poll_func = g_poll;
541 context->cached_poll_array = NULL;
542 context->cached_poll_array_size = 0;
544 context->pending_dispatches = g_ptr_array_new ();
546 context->time_is_fresh = FALSE;
548 context->wakeup = g_wakeup_new ();
549 g_wakeup_get_pollfd (context->wakeup, &context->wake_up_rec);
550 g_main_context_add_poll_unlocked (context, 0, &context->wake_up_rec);
552 G_LOCK (main_context_list);
553 main_context_list = g_slist_append (main_context_list, context);
555 #ifdef G_MAIN_POLL_DEBUG
556 if (_g_main_poll_debug)
557 g_print ("created context=%p\n", context);
560 G_UNLOCK (main_context_list);
566 * g_main_context_default:
568 * Returns the global default main context. This is the main context
569 * used for main loop functions when a main loop is not explicitly
570 * specified, and corresponds to the "main" main loop. See also
571 * g_main_context_get_thread_default().
573 * Return value: (transfer none): the global default main context.
576 g_main_context_default (void)
582 if (!default_main_context)
584 default_main_context = g_main_context_new ();
585 #ifdef G_MAIN_POLL_DEBUG
586 if (_g_main_poll_debug)
587 g_print ("default context=%p\n", default_main_context);
591 G_UNLOCK (main_loop);
593 return default_main_context;
597 free_context_stack (gpointer data)
599 GQueue *stack = data;
600 GMainContext *context;
602 while (!g_queue_is_empty (stack))
604 context = g_queue_pop_head (stack);
605 g_main_context_release (context);
607 g_main_context_unref (context);
609 g_queue_free (stack);
612 static GPrivate thread_context_stack = G_PRIVATE_INIT (free_context_stack);
615 * g_main_context_push_thread_default:
616 * @context: a #GMainContext, or %NULL for the global default context
618 * Acquires @context and sets it as the thread-default context for the
619 * current thread. This will cause certain asynchronous operations
620 * (such as most <link linkend="gio">gio</link>-based I/O) which are
621 * started in this thread to run under @context and deliver their
622 * results to its main loop, rather than running under the global
623 * default context in the main thread. Note that calling this function
624 * changes the context returned by
625 * g_main_context_get_thread_default(), <emphasis>not</emphasis> the
626 * one returned by g_main_context_default(), so it does not affect the
627 * context used by functions like g_idle_add().
629 * Normally you would call this function shortly after creating a new
630 * thread, passing it a #GMainContext which will be run by a
631 * #GMainLoop in that thread, to set a new default context for all
632 * async operations in that thread. (In this case, you don't need to
633 * ever call g_main_context_pop_thread_default().) In some cases
634 * however, you may want to schedule a single operation in a
635 * non-default context, or temporarily use a non-default context in
636 * the main thread. In that case, you can wrap the call to the
637 * asynchronous operation inside a
638 * g_main_context_push_thread_default() /
639 * g_main_context_pop_thread_default() pair, but it is up to you to
640 * ensure that no other asynchronous operations accidentally get
641 * started while the non-default context is active.
643 * Beware that libraries that predate this function may not correctly
644 * handle being used from a thread with a thread-default context. Eg,
645 * see g_file_supports_thread_contexts().
650 g_main_context_push_thread_default (GMainContext *context)
653 gboolean acquired_context;
655 acquired_context = g_main_context_acquire (context);
656 g_return_if_fail (acquired_context);
658 if (context == g_main_context_default ())
661 g_main_context_ref (context);
663 stack = g_private_get (&thread_context_stack);
666 stack = g_queue_new ();
667 g_private_set (&thread_context_stack, stack);
670 g_queue_push_head (stack, context);
674 * g_main_context_pop_thread_default:
675 * @context: a #GMainContext object, or %NULL
677 * Pops @context off the thread-default context stack (verifying that
678 * it was on the top of the stack).
683 g_main_context_pop_thread_default (GMainContext *context)
687 if (context == g_main_context_default ())
690 stack = g_private_get (&thread_context_stack);
692 g_return_if_fail (stack != NULL);
693 g_return_if_fail (g_queue_peek_head (stack) == context);
695 g_queue_pop_head (stack);
697 g_main_context_release (context);
699 g_main_context_unref (context);
703 * g_main_context_get_thread_default:
705 * Gets the thread-default #GMainContext for this thread. Asynchronous
706 * operations that want to be able to be run in contexts other than
707 * the default one should call this method or
708 * g_main_context_ref_thread_default() to get a #GMainContext to add
709 * their #GSource<!-- -->s to. (Note that even in single-threaded
710 * programs applications may sometimes want to temporarily push a
711 * non-default context, so it is not safe to assume that this will
712 * always return %NULL if you are running in the default thread.)
714 * If you need to hold a reference on the context, use
715 * g_main_context_ref_thread_default() instead.
717 * Returns: (transfer none): the thread-default #GMainContext, or
718 * %NULL if the thread-default context is the global default context.
723 g_main_context_get_thread_default (void)
727 stack = g_private_get (&thread_context_stack);
729 return g_queue_peek_head (stack);
735 * g_main_context_ref_thread_default:
737 * Gets the thread-default #GMainContext for this thread, as with
738 * g_main_context_get_thread_default(), but also adds a reference to
739 * it with g_main_context_ref(). In addition, unlike
740 * g_main_context_get_thread_default(), if the thread-default context
741 * is the global default context, this will return that #GMainContext
742 * (with a ref added to it) rather than returning %NULL.
744 * Returns: (transfer full): the thread-default #GMainContext. Unref
745 * with g_main_context_unref() when you are done with it.
750 g_main_context_ref_thread_default (void)
752 GMainContext *context;
754 context = g_main_context_get_thread_default ();
756 context = g_main_context_default ();
757 return g_main_context_ref (context);
760 /* Hooks for adding to the main loop */
764 * @source_funcs: structure containing functions that implement
765 * the sources behavior.
766 * @struct_size: size of the #GSource structure to create.
768 * Creates a new #GSource structure. The size is specified to
769 * allow creating structures derived from #GSource that contain
770 * additional data. The size passed in must be at least
771 * <literal>sizeof (GSource)</literal>.
773 * The source will not initially be associated with any #GMainContext
774 * and must be added to one with g_source_attach() before it will be
777 * Return value: the newly-created #GSource.
780 g_source_new (GSourceFuncs *source_funcs,
785 g_return_val_if_fail (source_funcs != NULL, NULL);
786 g_return_val_if_fail (struct_size >= sizeof (GSource), NULL);
788 source = (GSource*) g_malloc0 (struct_size);
790 source->source_funcs = source_funcs;
791 source->ref_count = 1;
793 source->priority = G_PRIORITY_DEFAULT;
795 source->flags = G_HOOK_FLAG_ACTIVE;
797 /* NULL/0 initialization for all other fields */
802 /* Holds context's lock
805 g_source_list_add (GSource *source,
806 GMainContext *context)
808 GSource *tmp_source, *last_source;
810 if (source->priv && source->priv->parent_source)
812 /* Put the source immediately before its parent */
813 tmp_source = source->priv->parent_source;
814 last_source = source->priv->parent_source->prev;
819 tmp_source = context->source_list;
820 while (tmp_source && tmp_source->priority <= source->priority)
822 last_source = tmp_source;
823 tmp_source = tmp_source->next;
827 source->next = tmp_source;
829 tmp_source->prev = source;
831 source->prev = last_source;
833 last_source->next = source;
835 context->source_list = source;
838 /* Holds context's lock
841 g_source_list_remove (GSource *source,
842 GMainContext *context)
845 source->prev->next = source->next;
847 context->source_list = source->next;
850 source->next->prev = source->prev;
857 g_source_attach_unlocked (GSource *source,
858 GMainContext *context)
863 source->context = context;
864 result = source->source_id = context->next_id++;
867 g_source_list_add (source, context);
869 tmp_list = source->poll_fds;
872 g_main_context_add_poll_unlocked (context, source->priority, tmp_list->data);
873 tmp_list = tmp_list->next;
878 tmp_list = source->priv->child_sources;
881 g_source_attach_unlocked (tmp_list->data, context);
882 tmp_list = tmp_list->next;
891 * @source: a #GSource
892 * @context: a #GMainContext (if %NULL, the default context will be used)
894 * Adds a #GSource to a @context so that it will be executed within
895 * that context. Remove it by calling g_source_destroy().
897 * Return value: the ID (greater than 0) for the source within the
901 g_source_attach (GSource *source,
902 GMainContext *context)
906 g_return_val_if_fail (source->context == NULL, 0);
907 g_return_val_if_fail (!SOURCE_DESTROYED (source), 0);
910 context = g_main_context_default ();
912 LOCK_CONTEXT (context);
914 result = g_source_attach_unlocked (source, context);
916 /* If another thread has acquired the context, wake it up since it
917 * might be in poll() right now.
919 if (context->owner && context->owner != G_THREAD_SELF)
920 g_wakeup_signal (context->wakeup);
922 UNLOCK_CONTEXT (context);
928 g_source_destroy_internal (GSource *source,
929 GMainContext *context,
933 LOCK_CONTEXT (context);
935 if (!SOURCE_DESTROYED (source))
938 gpointer old_cb_data;
939 GSourceCallbackFuncs *old_cb_funcs;
941 source->flags &= ~G_HOOK_FLAG_ACTIVE;
943 old_cb_data = source->callback_data;
944 old_cb_funcs = source->callback_funcs;
946 source->callback_data = NULL;
947 source->callback_funcs = NULL;
951 UNLOCK_CONTEXT (context);
952 old_cb_funcs->unref (old_cb_data);
953 LOCK_CONTEXT (context);
956 if (!SOURCE_BLOCKED (source))
958 tmp_list = source->poll_fds;
961 g_main_context_remove_poll_unlocked (context, tmp_list->data);
962 tmp_list = tmp_list->next;
966 if (source->priv && source->priv->child_sources)
968 /* This is safe because even if a child_source finalizer or
969 * closure notify tried to modify source->priv->child_sources
970 * from outside the lock, it would fail since
971 * SOURCE_DESTROYED(source) is now TRUE.
973 tmp_list = source->priv->child_sources;
976 g_source_destroy_internal (tmp_list->data, context, TRUE);
977 g_source_unref_internal (tmp_list->data, context, TRUE);
978 tmp_list = tmp_list->next;
980 g_slist_free (source->priv->child_sources);
981 source->priv->child_sources = NULL;
984 g_source_unref_internal (source, context, TRUE);
988 UNLOCK_CONTEXT (context);
993 * @source: a #GSource
995 * Removes a source from its #GMainContext, if any, and mark it as
996 * destroyed. The source cannot be subsequently added to another
1000 g_source_destroy (GSource *source)
1002 GMainContext *context;
1004 g_return_if_fail (source != NULL);
1006 context = source->context;
1009 g_source_destroy_internal (source, context, FALSE);
1011 source->flags &= ~G_HOOK_FLAG_ACTIVE;
1016 * @source: a #GSource
1018 * Returns the numeric ID for a particular source. The ID of a source
1019 * is a positive integer which is unique within a particular main loop
1020 * context. The reverse
1021 * mapping from ID to source is done by g_main_context_find_source_by_id().
1023 * Return value: the ID (greater than 0) for the source
1026 g_source_get_id (GSource *source)
1030 g_return_val_if_fail (source != NULL, 0);
1031 g_return_val_if_fail (source->context != NULL, 0);
1033 LOCK_CONTEXT (source->context);
1034 result = source->source_id;
1035 UNLOCK_CONTEXT (source->context);
1041 * g_source_get_context:
1042 * @source: a #GSource
1044 * Gets the #GMainContext with which the source is associated.
1045 * Calling this function on a destroyed source is an error.
1047 * Return value: (transfer none): the #GMainContext with which the
1048 * source is associated, or %NULL if the context has not
1049 * yet been added to a source.
1052 g_source_get_context (GSource *source)
1054 g_return_val_if_fail (!SOURCE_DESTROYED (source), NULL);
1056 return source->context;
1060 * g_source_add_poll:
1061 * @source:a #GSource
1062 * @fd: a #GPollFD structure holding information about a file
1063 * descriptor to watch.
1065 * Adds a file descriptor to the set of file descriptors polled for
1066 * this source. This is usually combined with g_source_new() to add an
1067 * event source. The event source's check function will typically test
1068 * the @revents field in the #GPollFD struct and return %TRUE if events need
1072 g_source_add_poll (GSource *source,
1075 GMainContext *context;
1077 g_return_if_fail (source != NULL);
1078 g_return_if_fail (fd != NULL);
1079 g_return_if_fail (!SOURCE_DESTROYED (source));
1081 context = source->context;
1084 LOCK_CONTEXT (context);
1086 source->poll_fds = g_slist_prepend (source->poll_fds, fd);
1090 if (!SOURCE_BLOCKED (source))
1091 g_main_context_add_poll_unlocked (context, source->priority, fd);
1092 UNLOCK_CONTEXT (context);
1097 * g_source_remove_poll:
1098 * @source:a #GSource
1099 * @fd: a #GPollFD structure previously passed to g_source_add_poll().
1101 * Removes a file descriptor from the set of file descriptors polled for
1105 g_source_remove_poll (GSource *source,
1108 GMainContext *context;
1110 g_return_if_fail (source != NULL);
1111 g_return_if_fail (fd != NULL);
1112 g_return_if_fail (!SOURCE_DESTROYED (source));
1114 context = source->context;
1117 LOCK_CONTEXT (context);
1119 source->poll_fds = g_slist_remove (source->poll_fds, fd);
1123 if (!SOURCE_BLOCKED (source))
1124 g_main_context_remove_poll_unlocked (context, fd);
1125 UNLOCK_CONTEXT (context);
1130 * g_source_add_child_source:
1131 * @source:a #GSource
1132 * @child_source: a second #GSource that @source should "poll"
1134 * Adds @child_source to @source as a "polled" source; when @source is
1135 * added to a #GMainContext, @child_source will be automatically added
1136 * with the same priority, when @child_source is triggered, it will
1137 * cause @source to dispatch (in addition to calling its own
1138 * callback), and when @source is destroyed, it will destroy
1139 * @child_source as well. (@source will also still be dispatched if
1140 * its own prepare/check functions indicate that it is ready.)
1142 * If you don't need @child_source to do anything on its own when it
1143 * triggers, you can call g_source_set_dummy_callback() on it to set a
1144 * callback that does nothing (except return %TRUE if appropriate).
1146 * @source will hold a reference on @child_source while @child_source
1147 * is attached to it.
1152 g_source_add_child_source (GSource *source,
1153 GSource *child_source)
1155 GMainContext *context;
1157 g_return_if_fail (source != NULL);
1158 g_return_if_fail (child_source != NULL);
1159 g_return_if_fail (!SOURCE_DESTROYED (source));
1160 g_return_if_fail (!SOURCE_DESTROYED (child_source));
1161 g_return_if_fail (child_source->context == NULL);
1162 g_return_if_fail (child_source->priv == NULL || child_source->priv->parent_source == NULL);
1164 context = source->context;
1167 LOCK_CONTEXT (context);
1170 source->priv = g_slice_new0 (GSourcePrivate);
1171 if (!child_source->priv)
1172 child_source->priv = g_slice_new0 (GSourcePrivate);
1174 source->priv->child_sources = g_slist_prepend (source->priv->child_sources,
1175 g_source_ref (child_source));
1176 child_source->priv->parent_source = source;
1177 g_source_set_priority_unlocked (child_source, context, source->priority);
1181 UNLOCK_CONTEXT (context);
1182 g_source_attach (child_source, context);
1187 * g_source_remove_child_source:
1188 * @source:a #GSource
1189 * @child_source: a #GSource previously passed to
1190 * g_source_add_child_source().
1192 * Detaches @child_source from @source and destroys it.
1197 g_source_remove_child_source (GSource *source,
1198 GSource *child_source)
1200 GMainContext *context;
1202 g_return_if_fail (source != NULL);
1203 g_return_if_fail (child_source != NULL);
1204 g_return_if_fail (child_source->priv != NULL && child_source->priv->parent_source == source);
1205 g_return_if_fail (!SOURCE_DESTROYED (source));
1206 g_return_if_fail (!SOURCE_DESTROYED (child_source));
1208 context = source->context;
1211 LOCK_CONTEXT (context);
1213 source->priv->child_sources = g_slist_remove (source->priv->child_sources, child_source);
1214 g_source_destroy_internal (child_source, context, TRUE);
1215 g_source_unref_internal (child_source, context, TRUE);
1218 UNLOCK_CONTEXT (context);
1222 * g_source_set_callback_indirect:
1223 * @source: the source
1224 * @callback_data: pointer to callback data "object"
1225 * @callback_funcs: functions for reference counting @callback_data
1226 * and getting the callback and data
1228 * Sets the callback function storing the data as a refcounted callback
1229 * "object". This is used internally. Note that calling
1230 * g_source_set_callback_indirect() assumes
1231 * an initial reference count on @callback_data, and thus
1232 * @callback_funcs->unref will eventually be called once more
1233 * than @callback_funcs->ref.
1236 g_source_set_callback_indirect (GSource *source,
1237 gpointer callback_data,
1238 GSourceCallbackFuncs *callback_funcs)
1240 GMainContext *context;
1241 gpointer old_cb_data;
1242 GSourceCallbackFuncs *old_cb_funcs;
1244 g_return_if_fail (source != NULL);
1245 g_return_if_fail (callback_funcs != NULL || callback_data == NULL);
1247 context = source->context;
1250 LOCK_CONTEXT (context);
1252 old_cb_data = source->callback_data;
1253 old_cb_funcs = source->callback_funcs;
1255 source->callback_data = callback_data;
1256 source->callback_funcs = callback_funcs;
1259 UNLOCK_CONTEXT (context);
1262 old_cb_funcs->unref (old_cb_data);
1266 g_source_callback_ref (gpointer cb_data)
1268 GSourceCallback *callback = cb_data;
1270 callback->ref_count++;
1275 g_source_callback_unref (gpointer cb_data)
1277 GSourceCallback *callback = cb_data;
1279 callback->ref_count--;
1280 if (callback->ref_count == 0)
1282 if (callback->notify)
1283 callback->notify (callback->data);
1289 g_source_callback_get (gpointer cb_data,
1294 GSourceCallback *callback = cb_data;
1296 *func = callback->func;
1297 *data = callback->data;
1300 static GSourceCallbackFuncs g_source_callback_funcs = {
1301 g_source_callback_ref,
1302 g_source_callback_unref,
1303 g_source_callback_get,
1307 * g_source_set_callback:
1308 * @source: the source
1309 * @func: a callback function
1310 * @data: the data to pass to callback function
1311 * @notify: a function to call when @data is no longer in use, or %NULL.
1313 * Sets the callback function for a source. The callback for a source is
1314 * called from the source's dispatch function.
1316 * The exact type of @func depends on the type of source; ie. you
1317 * should not count on @func being called with @data as its first
1320 * Typically, you won't use this function. Instead use functions specific
1321 * to the type of source you are using.
1324 g_source_set_callback (GSource *source,
1327 GDestroyNotify notify)
1329 GSourceCallback *new_callback;
1331 g_return_if_fail (source != NULL);
1333 new_callback = g_new (GSourceCallback, 1);
1335 new_callback->ref_count = 1;
1336 new_callback->func = func;
1337 new_callback->data = data;
1338 new_callback->notify = notify;
1340 g_source_set_callback_indirect (source, new_callback, &g_source_callback_funcs);
1345 * g_source_set_funcs:
1346 * @source: a #GSource
1347 * @funcs: the new #GSourceFuncs
1349 * Sets the source functions (can be used to override
1350 * default implementations) of an unattached source.
1355 g_source_set_funcs (GSource *source,
1356 GSourceFuncs *funcs)
1358 g_return_if_fail (source != NULL);
1359 g_return_if_fail (source->context == NULL);
1360 g_return_if_fail (source->ref_count > 0);
1361 g_return_if_fail (funcs != NULL);
1363 source->source_funcs = funcs;
1367 g_source_set_priority_unlocked (GSource *source,
1368 GMainContext *context,
1373 source->priority = priority;
1377 /* Remove the source from the context's source and then
1378 * add it back so it is sorted in the correct place
1380 g_source_list_remove (source, source->context);
1381 g_source_list_add (source, source->context);
1383 if (!SOURCE_BLOCKED (source))
1385 tmp_list = source->poll_fds;
1388 g_main_context_remove_poll_unlocked (context, tmp_list->data);
1389 g_main_context_add_poll_unlocked (context, priority, tmp_list->data);
1391 tmp_list = tmp_list->next;
1396 if (source->priv && source->priv->child_sources)
1398 tmp_list = source->priv->child_sources;
1401 g_source_set_priority_unlocked (tmp_list->data, context, priority);
1402 tmp_list = tmp_list->next;
1408 * g_source_set_priority:
1409 * @source: a #GSource
1410 * @priority: the new priority.
1412 * Sets the priority of a source. While the main loop is being run, a
1413 * source will be dispatched if it is ready to be dispatched and no
1414 * sources at a higher (numerically smaller) priority are ready to be
1418 g_source_set_priority (GSource *source,
1421 GMainContext *context;
1423 g_return_if_fail (source != NULL);
1425 context = source->context;
1428 LOCK_CONTEXT (context);
1429 g_source_set_priority_unlocked (source, context, priority);
1431 UNLOCK_CONTEXT (source->context);
1435 * g_source_get_priority:
1436 * @source: a #GSource
1438 * Gets the priority of a source.
1440 * Return value: the priority of the source
1443 g_source_get_priority (GSource *source)
1445 g_return_val_if_fail (source != NULL, 0);
1447 return source->priority;
1451 * g_source_set_can_recurse:
1452 * @source: a #GSource
1453 * @can_recurse: whether recursion is allowed for this source
1455 * Sets whether a source can be called recursively. If @can_recurse is
1456 * %TRUE, then while the source is being dispatched then this source
1457 * will be processed normally. Otherwise, all processing of this
1458 * source is blocked until the dispatch function returns.
1461 g_source_set_can_recurse (GSource *source,
1462 gboolean can_recurse)
1464 GMainContext *context;
1466 g_return_if_fail (source != NULL);
1468 context = source->context;
1471 LOCK_CONTEXT (context);
1474 source->flags |= G_SOURCE_CAN_RECURSE;
1476 source->flags &= ~G_SOURCE_CAN_RECURSE;
1479 UNLOCK_CONTEXT (context);
1483 * g_source_get_can_recurse:
1484 * @source: a #GSource
1486 * Checks whether a source is allowed to be called recursively.
1487 * see g_source_set_can_recurse().
1489 * Return value: whether recursion is allowed.
1492 g_source_get_can_recurse (GSource *source)
1494 g_return_val_if_fail (source != NULL, FALSE);
1496 return (source->flags & G_SOURCE_CAN_RECURSE) != 0;
1501 * g_source_set_name:
1502 * @source: a #GSource
1503 * @name: debug name for the source
1505 * Sets a name for the source, used in debugging and profiling.
1506 * The name defaults to #NULL.
1508 * The source name should describe in a human-readable way
1509 * what the source does. For example, "X11 event queue"
1510 * or "GTK+ repaint idle handler" or whatever it is.
1512 * It is permitted to call this function multiple times, but is not
1513 * recommended due to the potential performance impact. For example,
1514 * one could change the name in the "check" function of a #GSourceFuncs
1515 * to include details like the event type in the source name.
1520 g_source_set_name (GSource *source,
1523 g_return_if_fail (source != NULL);
1525 /* setting back to NULL is allowed, just because it's
1526 * weird if get_name can return NULL but you can't
1530 g_free (source->name);
1531 source->name = g_strdup (name);
1535 * g_source_get_name:
1536 * @source: a #GSource
1538 * Gets a name for the source, used in debugging and profiling.
1539 * The name may be #NULL if it has never been set with
1540 * g_source_set_name().
1542 * Return value: the name of the source
1546 g_source_get_name (GSource *source)
1548 g_return_val_if_fail (source != NULL, NULL);
1550 return source->name;
1554 * g_source_set_name_by_id:
1555 * @tag: a #GSource ID
1556 * @name: debug name for the source
1558 * Sets the name of a source using its ID.
1560 * This is a convenience utility to set source names from the return
1561 * value of g_idle_add(), g_timeout_add(), etc.
1566 g_source_set_name_by_id (guint tag,
1571 g_return_if_fail (tag > 0);
1573 source = g_main_context_find_source_by_id (NULL, tag);
1577 g_source_set_name (source, name);
1583 * @source: a #GSource
1585 * Increases the reference count on a source by one.
1587 * Return value: @source
1590 g_source_ref (GSource *source)
1592 GMainContext *context;
1594 g_return_val_if_fail (source != NULL, NULL);
1596 context = source->context;
1599 LOCK_CONTEXT (context);
1601 source->ref_count++;
1604 UNLOCK_CONTEXT (context);
1609 /* g_source_unref() but possible to call within context lock
1612 g_source_unref_internal (GSource *source,
1613 GMainContext *context,
1616 gpointer old_cb_data = NULL;
1617 GSourceCallbackFuncs *old_cb_funcs = NULL;
1619 g_return_if_fail (source != NULL);
1621 if (!have_lock && context)
1622 LOCK_CONTEXT (context);
1624 source->ref_count--;
1625 if (source->ref_count == 0)
1627 old_cb_data = source->callback_data;
1628 old_cb_funcs = source->callback_funcs;
1630 source->callback_data = NULL;
1631 source->callback_funcs = NULL;
1635 if (!SOURCE_DESTROYED (source))
1636 g_warning (G_STRLOC ": ref_count == 0, but source was still attached to a context!");
1637 g_source_list_remove (source, context);
1640 if (source->source_funcs->finalize)
1643 UNLOCK_CONTEXT (context);
1644 source->source_funcs->finalize (source);
1646 LOCK_CONTEXT (context);
1649 g_free (source->name);
1650 source->name = NULL;
1652 g_slist_free (source->poll_fds);
1653 source->poll_fds = NULL;
1657 g_slice_free (GSourcePrivate, source->priv);
1658 source->priv = NULL;
1664 if (!have_lock && context)
1665 UNLOCK_CONTEXT (context);
1670 UNLOCK_CONTEXT (context);
1672 old_cb_funcs->unref (old_cb_data);
1675 LOCK_CONTEXT (context);
1681 * @source: a #GSource
1683 * Decreases the reference count of a source by one. If the
1684 * resulting reference count is zero the source and associated
1685 * memory will be destroyed.
1688 g_source_unref (GSource *source)
1690 g_return_if_fail (source != NULL);
1692 g_source_unref_internal (source, source->context, FALSE);
1696 * g_main_context_find_source_by_id:
1697 * @context: a #GMainContext (if %NULL, the default context will be used)
1698 * @source_id: the source ID, as returned by g_source_get_id().
1700 * Finds a #GSource given a pair of context and ID.
1702 * Return value: (transfer none): the #GSource if found, otherwise, %NULL
1705 g_main_context_find_source_by_id (GMainContext *context,
1710 g_return_val_if_fail (source_id > 0, NULL);
1712 if (context == NULL)
1713 context = g_main_context_default ();
1715 LOCK_CONTEXT (context);
1717 source = context->source_list;
1720 if (!SOURCE_DESTROYED (source) &&
1721 source->source_id == source_id)
1723 source = source->next;
1726 UNLOCK_CONTEXT (context);
1732 * g_main_context_find_source_by_funcs_user_data:
1733 * @context: a #GMainContext (if %NULL, the default context will be used).
1734 * @funcs: the @source_funcs passed to g_source_new().
1735 * @user_data: the user data from the callback.
1737 * Finds a source with the given source functions and user data. If
1738 * multiple sources exist with the same source function and user data,
1739 * the first one found will be returned.
1741 * Return value: (transfer none): the source, if one was found, otherwise %NULL
1744 g_main_context_find_source_by_funcs_user_data (GMainContext *context,
1745 GSourceFuncs *funcs,
1750 g_return_val_if_fail (funcs != NULL, NULL);
1752 if (context == NULL)
1753 context = g_main_context_default ();
1755 LOCK_CONTEXT (context);
1757 source = context->source_list;
1760 if (!SOURCE_DESTROYED (source) &&
1761 source->source_funcs == funcs &&
1762 source->callback_funcs)
1764 GSourceFunc callback;
1765 gpointer callback_data;
1767 source->callback_funcs->get (source->callback_data, source, &callback, &callback_data);
1769 if (callback_data == user_data)
1772 source = source->next;
1775 UNLOCK_CONTEXT (context);
1781 * g_main_context_find_source_by_user_data:
1782 * @context: a #GMainContext
1783 * @user_data: the user_data for the callback.
1785 * Finds a source with the given user data for the callback. If
1786 * multiple sources exist with the same user data, the first
1787 * one found will be returned.
1789 * Return value: (transfer none): the source, if one was found, otherwise %NULL
1792 g_main_context_find_source_by_user_data (GMainContext *context,
1797 if (context == NULL)
1798 context = g_main_context_default ();
1800 LOCK_CONTEXT (context);
1802 source = context->source_list;
1805 if (!SOURCE_DESTROYED (source) &&
1806 source->callback_funcs)
1808 GSourceFunc callback;
1809 gpointer callback_data = NULL;
1811 source->callback_funcs->get (source->callback_data, source, &callback, &callback_data);
1813 if (callback_data == user_data)
1816 source = source->next;
1819 UNLOCK_CONTEXT (context);
1826 * @tag: the ID of the source to remove.
1828 * Removes the source with the given id from the default main context.
1830 * a #GSource is given by g_source_get_id(), or will be returned by the
1831 * functions g_source_attach(), g_idle_add(), g_idle_add_full(),
1832 * g_timeout_add(), g_timeout_add_full(), g_child_watch_add(),
1833 * g_child_watch_add_full(), g_io_add_watch(), and g_io_add_watch_full().
1835 * See also g_source_destroy(). You must use g_source_destroy() for sources
1836 * added to a non-default main context.
1838 * Return value: %TRUE if the source was found and removed.
1841 g_source_remove (guint tag)
1845 g_return_val_if_fail (tag > 0, FALSE);
1847 source = g_main_context_find_source_by_id (NULL, tag);
1849 g_source_destroy (source);
1851 return source != NULL;
1855 * g_source_remove_by_user_data:
1856 * @user_data: the user_data for the callback.
1858 * Removes a source from the default main loop context given the user
1859 * data for the callback. If multiple sources exist with the same user
1860 * data, only one will be destroyed.
1862 * Return value: %TRUE if a source was found and removed.
1865 g_source_remove_by_user_data (gpointer user_data)
1869 source = g_main_context_find_source_by_user_data (NULL, user_data);
1872 g_source_destroy (source);
1880 * g_source_remove_by_funcs_user_data:
1881 * @funcs: The @source_funcs passed to g_source_new()
1882 * @user_data: the user data for the callback
1884 * Removes a source from the default main loop context given the
1885 * source functions and user data. If multiple sources exist with the
1886 * same source functions and user data, only one will be destroyed.
1888 * Return value: %TRUE if a source was found and removed.
1891 g_source_remove_by_funcs_user_data (GSourceFuncs *funcs,
1896 g_return_val_if_fail (funcs != NULL, FALSE);
1898 source = g_main_context_find_source_by_funcs_user_data (NULL, funcs, user_data);
1901 g_source_destroy (source);
1909 * g_get_current_time:
1910 * @result: #GTimeVal structure in which to store current time.
1912 * Equivalent to the UNIX gettimeofday() function, but portable.
1914 * You may find g_get_real_time() to be more convenient.
1917 g_get_current_time (GTimeVal *result)
1922 g_return_if_fail (result != NULL);
1924 /*this is required on alpha, there the timeval structs are int's
1925 not longs and a cast only would fail horribly*/
1926 gettimeofday (&r, NULL);
1927 result->tv_sec = r.tv_sec;
1928 result->tv_usec = r.tv_usec;
1933 g_return_if_fail (result != NULL);
1935 GetSystemTimeAsFileTime (&ft);
1936 memmove (&time64, &ft, sizeof (FILETIME));
1938 /* Convert from 100s of nanoseconds since 1601-01-01
1939 * to Unix epoch. Yes, this is Y2038 unsafe.
1941 time64 -= G_GINT64_CONSTANT (116444736000000000);
1944 result->tv_sec = time64 / 1000000;
1945 result->tv_usec = time64 % 1000000;
1952 * Queries the system wall-clock time.
1954 * This call is functionally equivalent to g_get_current_time() except
1955 * that the return value is often more convenient than dealing with a
1958 * You should only use this call if you are actually interested in the real
1959 * wall-clock time. g_get_monotonic_time() is probably more useful for
1960 * measuring intervals.
1962 * Returns: the number of microseconds since January 1, 1970 UTC.
1967 g_get_real_time (void)
1971 g_get_current_time (&tv);
1973 return (((gint64) tv.tv_sec) * 1000000) + tv.tv_usec;
1977 G_LOCK_DEFINE_STATIC (g_win32_clock);
1978 static ULONGLONG (*g_GetTickCount64) (void) = NULL;
1979 static guint32 g_win32_last_ticks32 = 0;
1980 static guint32 g_win32_tick_epoch = 0;
1981 G_GNUC_INTERNAL void
1982 g_clock_win32_init (void)
1986 g_GetTickCount64 = NULL;
1987 kernel32 = GetModuleHandle ("KERNEL32.DLL");
1988 if (kernel32 != NULL)
1989 g_GetTickCount64 = (void *) GetProcAddress (kernel32, "GetTickCount64");
1990 g_win32_last_ticks32 = GetTickCount();
1995 * g_get_monotonic_time:
1997 * Queries the system monotonic time, if available.
1999 * On POSIX systems with clock_gettime() and %CLOCK_MONOTONIC this call
2000 * is a very shallow wrapper for that. Otherwise, we make a best effort
2001 * that probably involves returning the wall clock time (with at least
2002 * microsecond accuracy, subject to the limitations of the OS kernel).
2004 * It's important to note that POSIX %CLOCK_MONOTONIC does not count
2005 * time spent while the machine is suspended.
2007 * On Windows, "limitations of the OS kernel" is a rather substantial
2008 * statement. Depending on the configuration of the system, the wall
2009 * clock time is updated as infrequently as 64 times a second (which
2010 * is approximately every 16ms). Also, the on XP (not on Vista or later)
2011 * the monitonic clock is locally monotonic, but may differ in exact
2012 * value between processes due to timer wrap handling.
2014 * Returns: the monotonic time, in microseconds
2019 g_get_monotonic_time (void)
2021 #ifdef HAVE_CLOCK_GETTIME
2022 /* librt clock_gettime() is our first choice */
2025 #ifdef CLOCK_MONOTONIC
2026 clock_gettime (CLOCK_MONOTONIC, &ts);
2028 clock_gettime (CLOCK_REALTIME, &ts);
2031 /* In theory monotonic time can have any epoch.
2033 * glib presently assumes the following:
2035 * 1) The epoch comes some time after the birth of Jesus of Nazareth, but
2036 * not more than 10000 years later.
2038 * 2) The current time also falls sometime within this range.
2040 * These two reasonable assumptions leave us with a maximum deviation from
2041 * the epoch of 10000 years, or 315569520000000000 seconds.
2043 * If we restrict ourselves to this range then the number of microseconds
2044 * will always fit well inside the constraints of a int64 (by a factor of
2047 * If you actually hit the following assertion, probably you should file a
2048 * bug against your operating system for being excessively silly.
2050 g_assert (G_GINT64_CONSTANT (-315569520000000000) < ts.tv_sec &&
2051 ts.tv_sec < G_GINT64_CONSTANT (315569520000000000));
2053 return (((gint64) ts.tv_sec) * 1000000) + (ts.tv_nsec / 1000);
2055 #elif defined (G_OS_WIN32)
2058 if (g_GetTickCount64 != NULL)
2060 ticks = g_GetTickCount64 ();
2066 G_LOCK (g_win32_clock);
2068 ticks32 = GetTickCount();
2070 /* We have wrapped the 32bit counter, increase the epoch.
2071 * This will work as long as this function is called at
2072 * least once every ~50 days, which is the wrap time of
2073 * a 32bit msec counter. I think this is pretty likely.
2075 * Note that g_win32_tick_epoch is a process local state,
2076 * so the monotonic clock will not be the same between
2079 if (ticks32 < g_win32_last_ticks32)
2080 g_win32_tick_epoch++;
2082 ticks = (guint64)ticks32 | ((guint64)g_win32_tick_epoch) << 32;
2083 g_win32_last_ticks32 = ticks32;
2085 G_UNLOCK (g_win32_clock);
2088 return ticks * 1000;
2090 #else /* !HAVE_CLOCK_GETTIME && ! G_OS_WIN32*/
2092 /* It may look like we are discarding accuracy on Windows (since its
2093 * current time is expressed in 100s of nanoseconds) but according to
2094 * many sources, the time is only updated 64 times per second, so
2095 * microsecond accuracy is more than enough.
2099 g_get_current_time (&tv);
2101 return (((gint64) tv.tv_sec) * 1000000) + tv.tv_usec;
2106 g_main_dispatch_free (gpointer dispatch)
2108 g_slice_free (GMainDispatch, dispatch);
2111 /* Running the main loop */
2113 static GMainDispatch *
2116 static GPrivate depth_private = G_PRIVATE_INIT (g_main_dispatch_free);
2117 GMainDispatch *dispatch;
2119 dispatch = g_private_get (&depth_private);
2123 dispatch = g_slice_new0 (GMainDispatch);
2124 g_private_set (&depth_private, dispatch);
2133 * Returns the depth of the stack of calls to
2134 * g_main_context_dispatch() on any #GMainContext in the current thread.
2135 * That is, when called from the toplevel, it gives 0. When
2136 * called from within a callback from g_main_context_iteration()
2137 * (or g_main_loop_run(), etc.) it returns 1. When called from within
2138 * a callback to a recursive call to g_main_context_iteration(),
2139 * it returns 2. And so forth.
2141 * This function is useful in a situation like the following:
2142 * Imagine an extremely simple "garbage collected" system.
2145 * static GList *free_list;
2148 * allocate_memory (gsize size)
2150 * gpointer result = g_malloc (size);
2151 * free_list = g_list_prepend (free_list, result);
2156 * free_allocated_memory (void)
2159 * for (l = free_list; l; l = l->next);
2161 * g_list_free (free_list);
2169 * g_main_context_iteration (NULL, TRUE);
2170 * free_allocated_memory();
2174 * This works from an application, however, if you want to do the same
2175 * thing from a library, it gets more difficult, since you no longer
2176 * control the main loop. You might think you can simply use an idle
2177 * function to make the call to free_allocated_memory(), but that
2178 * doesn't work, since the idle function could be called from a
2179 * recursive callback. This can be fixed by using g_main_depth()
2183 * allocate_memory (gsize size)
2185 * FreeListBlock *block = g_new (FreeListBlock, 1);
2186 * block->mem = g_malloc (size);
2187 * block->depth = g_main_depth ();
2188 * free_list = g_list_prepend (free_list, block);
2189 * return block->mem;
2193 * free_allocated_memory (void)
2197 * int depth = g_main_depth ();
2198 * for (l = free_list; l; );
2200 * GList *next = l->next;
2201 * FreeListBlock *block = l->data;
2202 * if (block->depth > depth)
2204 * g_free (block->mem);
2206 * free_list = g_list_delete_link (free_list, l);
2214 * There is a temptation to use g_main_depth() to solve
2215 * problems with reentrancy. For instance, while waiting for data
2216 * to be received from the network in response to a menu item,
2217 * the menu item might be selected again. It might seem that
2218 * one could make the menu item's callback return immediately
2219 * and do nothing if g_main_depth() returns a value greater than 1.
2220 * However, this should be avoided since the user then sees selecting
2221 * the menu item do nothing. Furthermore, you'll find yourself adding
2222 * these checks all over your code, since there are doubtless many,
2223 * many things that the user could do. Instead, you can use the
2224 * following techniques:
2229 * Use gtk_widget_set_sensitive() or modal dialogs to prevent
2230 * the user from interacting with elements while the main
2231 * loop is recursing.
2236 * Avoid main loop recursion in situations where you can't handle
2237 * arbitrary callbacks. Instead, structure your code so that you
2238 * simply return to the main loop and then get called again when
2239 * there is more work to do.
2244 * Return value: The main loop recursion level in the current thread
2249 GMainDispatch *dispatch = get_dispatch ();
2250 return dispatch->depth;
2254 * g_main_current_source:
2256 * Returns the currently firing source for this thread.
2258 * Return value: (transfer none): The currently firing source or %NULL.
2263 g_main_current_source (void)
2265 GMainDispatch *dispatch = get_dispatch ();
2266 return dispatch->dispatching_sources ? dispatch->dispatching_sources->data : NULL;
2270 * g_source_is_destroyed:
2271 * @source: a #GSource
2273 * Returns whether @source has been destroyed.
2275 * This is important when you operate upon your objects
2276 * from within idle handlers, but may have freed the object
2277 * before the dispatch of your idle handler.
2281 * idle_callback (gpointer data)
2283 * SomeWidget *self = data;
2285 * GDK_THREADS_ENTER (<!-- -->);
2286 * /<!-- -->* do stuff with self *<!-- -->/
2287 * self->idle_id = 0;
2288 * GDK_THREADS_LEAVE (<!-- -->);
2294 * some_widget_do_stuff_later (SomeWidget *self)
2296 * self->idle_id = g_idle_add (idle_callback, self);
2300 * some_widget_finalize (GObject *object)
2302 * SomeWidget *self = SOME_WIDGET (object);
2304 * if (self->idle_id)
2305 * g_source_remove (self->idle_id);
2307 * G_OBJECT_CLASS (parent_class)->finalize (object);
2311 * This will fail in a multi-threaded application if the
2312 * widget is destroyed before the idle handler fires due
2313 * to the use after free in the callback. A solution, to
2314 * this particular problem, is to check to if the source
2315 * has already been destroy within the callback.
2319 * idle_callback (gpointer data)
2321 * SomeWidget *self = data;
2323 * GDK_THREADS_ENTER ();
2324 * if (!g_source_is_destroyed (g_main_current_source ()))
2326 * /<!-- -->* do stuff with self *<!-- -->/
2328 * GDK_THREADS_LEAVE ();
2334 * Return value: %TRUE if the source has been destroyed
2339 g_source_is_destroyed (GSource *source)
2341 return SOURCE_DESTROYED (source);
2344 /* Temporarily remove all this source's file descriptors from the
2345 * poll(), so that if data comes available for one of the file descriptors
2346 * we don't continually spin in the poll()
2348 /* HOLDS: source->context's lock */
2350 block_source (GSource *source)
2354 g_return_if_fail (!SOURCE_BLOCKED (source));
2356 tmp_list = source->poll_fds;
2359 g_main_context_remove_poll_unlocked (source->context, tmp_list->data);
2360 tmp_list = tmp_list->next;
2364 /* HOLDS: source->context's lock */
2366 unblock_source (GSource *source)
2370 g_return_if_fail (!SOURCE_BLOCKED (source)); /* Source already unblocked */
2371 g_return_if_fail (!SOURCE_DESTROYED (source));
2373 tmp_list = source->poll_fds;
2376 g_main_context_add_poll_unlocked (source->context, source->priority, tmp_list->data);
2377 tmp_list = tmp_list->next;
2381 /* HOLDS: context's lock */
2383 g_main_dispatch (GMainContext *context)
2385 GMainDispatch *current = get_dispatch ();
2388 for (i = 0; i < context->pending_dispatches->len; i++)
2390 GSource *source = context->pending_dispatches->pdata[i];
2392 context->pending_dispatches->pdata[i] = NULL;
2395 source->flags &= ~G_SOURCE_READY;
2397 if (!SOURCE_DESTROYED (source))
2399 gboolean was_in_call;
2400 gpointer user_data = NULL;
2401 GSourceFunc callback = NULL;
2402 GSourceCallbackFuncs *cb_funcs;
2404 gboolean need_destroy;
2406 gboolean (*dispatch) (GSource *,
2409 GSList current_source_link;
2411 dispatch = source->source_funcs->dispatch;
2412 cb_funcs = source->callback_funcs;
2413 cb_data = source->callback_data;
2416 cb_funcs->ref (cb_data);
2418 if ((source->flags & G_SOURCE_CAN_RECURSE) == 0)
2419 block_source (source);
2421 was_in_call = source->flags & G_HOOK_FLAG_IN_CALL;
2422 source->flags |= G_HOOK_FLAG_IN_CALL;
2425 cb_funcs->get (cb_data, source, &callback, &user_data);
2427 UNLOCK_CONTEXT (context);
2430 /* The on-stack allocation of the GSList is unconventional, but
2431 * we know that the lifetime of the link is bounded to this
2432 * function as the link is kept in a thread specific list and
2433 * not manipulated outside of this function and its descendants.
2434 * Avoiding the overhead of a g_slist_alloc() is useful as many
2435 * applications do little more than dispatch events.
2437 * This is a performance hack - do not revert to g_slist_prepend()!
2439 current_source_link.data = source;
2440 current_source_link.next = current->dispatching_sources;
2441 current->dispatching_sources = ¤t_source_link;
2442 need_destroy = ! dispatch (source,
2445 g_assert (current->dispatching_sources == ¤t_source_link);
2446 current->dispatching_sources = current_source_link.next;
2450 cb_funcs->unref (cb_data);
2452 LOCK_CONTEXT (context);
2455 source->flags &= ~G_HOOK_FLAG_IN_CALL;
2457 if ((source->flags & G_SOURCE_CAN_RECURSE) == 0 &&
2458 !SOURCE_DESTROYED (source))
2459 unblock_source (source);
2461 /* Note: this depends on the fact that we can't switch
2462 * sources from one main context to another
2464 if (need_destroy && !SOURCE_DESTROYED (source))
2466 g_assert (source->context == context);
2467 g_source_destroy_internal (source, context, TRUE);
2471 SOURCE_UNREF (source, context);
2474 g_ptr_array_set_size (context->pending_dispatches, 0);
2477 /* Holds context's lock */
2478 static inline GSource *
2479 next_valid_source (GMainContext *context,
2482 GSource *new_source = source ? source->next : context->source_list;
2486 if (!SOURCE_DESTROYED (new_source))
2488 new_source->ref_count++;
2492 new_source = new_source->next;
2496 SOURCE_UNREF (source, context);
2502 * g_main_context_acquire:
2503 * @context: a #GMainContext
2505 * Tries to become the owner of the specified context.
2506 * If some other thread is the owner of the context,
2507 * returns %FALSE immediately. Ownership is properly
2508 * recursive: the owner can require ownership again
2509 * and will release ownership when g_main_context_release()
2510 * is called as many times as g_main_context_acquire().
2512 * You must be the owner of a context before you
2513 * can call g_main_context_prepare(), g_main_context_query(),
2514 * g_main_context_check(), g_main_context_dispatch().
2516 * Return value: %TRUE if the operation succeeded, and
2517 * this thread is now the owner of @context.
2520 g_main_context_acquire (GMainContext *context)
2522 gboolean result = FALSE;
2523 GThread *self = G_THREAD_SELF;
2525 if (context == NULL)
2526 context = g_main_context_default ();
2528 LOCK_CONTEXT (context);
2530 if (!context->owner)
2532 context->owner = self;
2533 g_assert (context->owner_count == 0);
2536 if (context->owner == self)
2538 context->owner_count++;
2542 UNLOCK_CONTEXT (context);
2548 * g_main_context_release:
2549 * @context: a #GMainContext
2551 * Releases ownership of a context previously acquired by this thread
2552 * with g_main_context_acquire(). If the context was acquired multiple
2553 * times, the ownership will be released only when g_main_context_release()
2554 * is called as many times as it was acquired.
2557 g_main_context_release (GMainContext *context)
2559 if (context == NULL)
2560 context = g_main_context_default ();
2562 LOCK_CONTEXT (context);
2564 context->owner_count--;
2565 if (context->owner_count == 0)
2567 context->owner = NULL;
2569 if (context->waiters)
2571 GMainWaiter *waiter = context->waiters->data;
2572 gboolean loop_internal_waiter = (waiter->mutex == &context->mutex);
2573 context->waiters = g_slist_delete_link (context->waiters,
2575 if (!loop_internal_waiter)
2576 g_mutex_lock (waiter->mutex);
2578 g_cond_signal (waiter->cond);
2580 if (!loop_internal_waiter)
2581 g_mutex_unlock (waiter->mutex);
2585 UNLOCK_CONTEXT (context);
2589 * g_main_context_wait:
2590 * @context: a #GMainContext
2591 * @cond: a condition variable
2592 * @mutex: a mutex, currently held
2594 * Tries to become the owner of the specified context,
2595 * as with g_main_context_acquire(). But if another thread
2596 * is the owner, atomically drop @mutex and wait on @cond until
2597 * that owner releases ownership or until @cond is signaled, then
2598 * try again (once) to become the owner.
2600 * Return value: %TRUE if the operation succeeded, and
2601 * this thread is now the owner of @context.
2604 g_main_context_wait (GMainContext *context,
2608 gboolean result = FALSE;
2609 GThread *self = G_THREAD_SELF;
2610 gboolean loop_internal_waiter;
2612 if (context == NULL)
2613 context = g_main_context_default ();
2615 loop_internal_waiter = (mutex == &context->mutex);
2617 if (!loop_internal_waiter)
2618 LOCK_CONTEXT (context);
2620 if (context->owner && context->owner != self)
2625 waiter.mutex = mutex;
2627 context->waiters = g_slist_append (context->waiters, &waiter);
2629 if (!loop_internal_waiter)
2630 UNLOCK_CONTEXT (context);
2631 g_cond_wait (cond, mutex);
2632 if (!loop_internal_waiter)
2633 LOCK_CONTEXT (context);
2635 context->waiters = g_slist_remove (context->waiters, &waiter);
2638 if (!context->owner)
2640 context->owner = self;
2641 g_assert (context->owner_count == 0);
2644 if (context->owner == self)
2646 context->owner_count++;
2650 if (!loop_internal_waiter)
2651 UNLOCK_CONTEXT (context);
2657 * g_main_context_prepare:
2658 * @context: a #GMainContext
2659 * @priority: location to store priority of highest priority
2660 * source already ready.
2662 * Prepares to poll sources within a main loop. The resulting information
2663 * for polling is determined by calling g_main_context_query ().
2665 * Return value: %TRUE if some source is ready to be dispatched
2669 g_main_context_prepare (GMainContext *context,
2674 gint current_priority = G_MAXINT;
2677 if (context == NULL)
2678 context = g_main_context_default ();
2680 LOCK_CONTEXT (context);
2682 context->time_is_fresh = FALSE;
2684 if (context->in_check_or_prepare)
2686 g_warning ("g_main_context_prepare() called recursively from within a source's check() or "
2687 "prepare() member.");
2688 UNLOCK_CONTEXT (context);
2693 /* If recursing, finish up current dispatch, before starting over */
2694 if (context->pending_dispatches)
2697 g_main_dispatch (context, ¤t_time);
2699 UNLOCK_CONTEXT (context);
2704 /* If recursing, clear list of pending dispatches */
2706 for (i = 0; i < context->pending_dispatches->len; i++)
2708 if (context->pending_dispatches->pdata[i])
2709 SOURCE_UNREF ((GSource *)context->pending_dispatches->pdata[i], context);
2711 g_ptr_array_set_size (context->pending_dispatches, 0);
2713 /* Prepare all sources */
2715 context->timeout = -1;
2717 source = next_valid_source (context, NULL);
2720 gint source_timeout = -1;
2722 if ((n_ready > 0) && (source->priority > current_priority))
2724 SOURCE_UNREF (source, context);
2727 if (SOURCE_BLOCKED (source))
2730 if (!(source->flags & G_SOURCE_READY))
2733 gboolean (*prepare) (GSource *source,
2736 prepare = source->source_funcs->prepare;
2737 context->in_check_or_prepare++;
2738 UNLOCK_CONTEXT (context);
2740 result = (*prepare) (source, &source_timeout);
2742 LOCK_CONTEXT (context);
2743 context->in_check_or_prepare--;
2747 GSource *ready_source = source;
2749 while (ready_source)
2751 ready_source->flags |= G_SOURCE_READY;
2752 ready_source = ready_source->priv ? ready_source->priv->parent_source : NULL;
2757 if (source->flags & G_SOURCE_READY)
2760 current_priority = source->priority;
2761 context->timeout = 0;
2764 if (source_timeout >= 0)
2766 if (context->timeout < 0)
2767 context->timeout = source_timeout;
2769 context->timeout = MIN (context->timeout, source_timeout);
2773 source = next_valid_source (context, source);
2776 UNLOCK_CONTEXT (context);
2779 *priority = current_priority;
2781 return (n_ready > 0);
2785 * g_main_context_query:
2786 * @context: a #GMainContext
2787 * @max_priority: maximum priority source to check
2788 * @timeout_: (out): location to store timeout to be used in polling
2789 * @fds: (out caller-allocates) (array length=n_fds): location to
2790 * store #GPollFD records that need to be polled.
2791 * @n_fds: length of @fds.
2793 * Determines information necessary to poll this main loop.
2795 * Return value: the number of records actually stored in @fds,
2796 * or, if more than @n_fds records need to be stored, the number
2797 * of records that need to be stored.
2800 g_main_context_query (GMainContext *context,
2809 LOCK_CONTEXT (context);
2811 pollrec = context->poll_records;
2813 while (pollrec && max_priority >= pollrec->priority)
2815 /* We need to include entries with fd->events == 0 in the array because
2816 * otherwise if the application changes fd->events behind our back and
2817 * makes it non-zero, we'll be out of sync when we check the fds[] array.
2818 * (Changing fd->events after adding an FD wasn't an anticipated use of
2819 * this API, but it occurs in practice.) */
2822 fds[n_poll].fd = pollrec->fd->fd;
2823 /* In direct contradiction to the Unix98 spec, IRIX runs into
2824 * difficulty if you pass in POLLERR, POLLHUP or POLLNVAL
2825 * flags in the events field of the pollfd while it should
2826 * just ignoring them. So we mask them out here.
2828 fds[n_poll].events = pollrec->fd->events & ~(G_IO_ERR|G_IO_HUP|G_IO_NVAL);
2829 fds[n_poll].revents = 0;
2832 pollrec = pollrec->next;
2836 context->poll_changed = FALSE;
2840 *timeout = context->timeout;
2842 context->time_is_fresh = FALSE;
2845 UNLOCK_CONTEXT (context);
2851 * g_main_context_check:
2852 * @context: a #GMainContext
2853 * @max_priority: the maximum numerical priority of sources to check
2854 * @fds: (array length=n_fds): array of #GPollFD's that was passed to
2855 * the last call to g_main_context_query()
2856 * @n_fds: return value of g_main_context_query()
2858 * Passes the results of polling back to the main loop.
2860 * Return value: %TRUE if some sources are ready to be dispatched.
2863 g_main_context_check (GMainContext *context,
2873 LOCK_CONTEXT (context);
2875 if (context->in_check_or_prepare)
2877 g_warning ("g_main_context_check() called recursively from within a source's check() or "
2878 "prepare() member.");
2879 UNLOCK_CONTEXT (context);
2883 if (context->wake_up_rec.events)
2884 g_wakeup_acknowledge (context->wakeup);
2886 /* If the set of poll file descriptors changed, bail out
2887 * and let the main loop rerun
2889 if (context->poll_changed)
2891 UNLOCK_CONTEXT (context);
2895 pollrec = context->poll_records;
2899 if (pollrec->fd->events)
2900 pollrec->fd->revents = fds[i].revents;
2902 pollrec = pollrec->next;
2906 source = next_valid_source (context, NULL);
2909 if ((n_ready > 0) && (source->priority > max_priority))
2911 SOURCE_UNREF (source, context);
2914 if (SOURCE_BLOCKED (source))
2917 if (!(source->flags & G_SOURCE_READY))
2920 gboolean (*check) (GSource *source);
2922 check = source->source_funcs->check;
2924 context->in_check_or_prepare++;
2925 UNLOCK_CONTEXT (context);
2927 result = (*check) (source);
2929 LOCK_CONTEXT (context);
2930 context->in_check_or_prepare--;
2934 GSource *ready_source = source;
2936 while (ready_source)
2938 ready_source->flags |= G_SOURCE_READY;
2939 ready_source = ready_source->priv ? ready_source->priv->parent_source : NULL;
2944 if (source->flags & G_SOURCE_READY)
2946 source->ref_count++;
2947 g_ptr_array_add (context->pending_dispatches, source);
2951 /* never dispatch sources with less priority than the first
2952 * one we choose to dispatch
2954 max_priority = source->priority;
2958 source = next_valid_source (context, source);
2961 UNLOCK_CONTEXT (context);
2967 * g_main_context_dispatch:
2968 * @context: a #GMainContext
2970 * Dispatches all pending sources.
2973 g_main_context_dispatch (GMainContext *context)
2975 LOCK_CONTEXT (context);
2977 if (context->pending_dispatches->len > 0)
2979 g_main_dispatch (context);
2982 UNLOCK_CONTEXT (context);
2985 /* HOLDS context lock */
2987 g_main_context_iterate (GMainContext *context,
2994 gboolean some_ready;
2995 gint nfds, allocated_nfds;
2996 GPollFD *fds = NULL;
2998 UNLOCK_CONTEXT (context);
3000 if (!g_main_context_acquire (context))
3002 gboolean got_ownership;
3004 LOCK_CONTEXT (context);
3009 got_ownership = g_main_context_wait (context,
3017 LOCK_CONTEXT (context);
3019 if (!context->cached_poll_array)
3021 context->cached_poll_array_size = context->n_poll_records;
3022 context->cached_poll_array = g_new (GPollFD, context->n_poll_records);
3025 allocated_nfds = context->cached_poll_array_size;
3026 fds = context->cached_poll_array;
3028 UNLOCK_CONTEXT (context);
3030 g_main_context_prepare (context, &max_priority);
3032 while ((nfds = g_main_context_query (context, max_priority, &timeout, fds,
3033 allocated_nfds)) > allocated_nfds)
3035 LOCK_CONTEXT (context);
3037 context->cached_poll_array_size = allocated_nfds = nfds;
3038 context->cached_poll_array = fds = g_new (GPollFD, nfds);
3039 UNLOCK_CONTEXT (context);
3045 g_main_context_poll (context, timeout, max_priority, fds, nfds);
3047 some_ready = g_main_context_check (context, max_priority, fds, nfds);
3050 g_main_context_dispatch (context);
3052 g_main_context_release (context);
3054 LOCK_CONTEXT (context);
3060 * g_main_context_pending:
3061 * @context: a #GMainContext (if %NULL, the default context will be used)
3063 * Checks if any sources have pending events for the given context.
3065 * Return value: %TRUE if events are pending.
3068 g_main_context_pending (GMainContext *context)
3073 context = g_main_context_default();
3075 LOCK_CONTEXT (context);
3076 retval = g_main_context_iterate (context, FALSE, FALSE, G_THREAD_SELF);
3077 UNLOCK_CONTEXT (context);
3083 * g_main_context_iteration:
3084 * @context: a #GMainContext (if %NULL, the default context will be used)
3085 * @may_block: whether the call may block.
3087 * Runs a single iteration for the given main loop. This involves
3088 * checking to see if any event sources are ready to be processed,
3089 * then if no events sources are ready and @may_block is %TRUE, waiting
3090 * for a source to become ready, then dispatching the highest priority
3091 * events sources that are ready. Otherwise, if @may_block is %FALSE
3092 * sources are not waited to become ready, only those highest priority
3093 * events sources will be dispatched (if any), that are ready at this
3094 * given moment without further waiting.
3096 * Note that even when @may_block is %TRUE, it is still possible for
3097 * g_main_context_iteration() to return %FALSE, since the the wait may
3098 * be interrupted for other reasons than an event source becoming ready.
3100 * Return value: %TRUE if events were dispatched.
3103 g_main_context_iteration (GMainContext *context, gboolean may_block)
3108 context = g_main_context_default();
3110 LOCK_CONTEXT (context);
3111 retval = g_main_context_iterate (context, may_block, TRUE, G_THREAD_SELF);
3112 UNLOCK_CONTEXT (context);
3119 * @context: (allow-none): a #GMainContext (if %NULL, the default context will be used).
3120 * @is_running: set to %TRUE to indicate that the loop is running. This
3121 * is not very important since calling g_main_loop_run() will set this to
3124 * Creates a new #GMainLoop structure.
3126 * Return value: a new #GMainLoop.
3129 g_main_loop_new (GMainContext *context,
3130 gboolean is_running)
3135 context = g_main_context_default();
3137 g_main_context_ref (context);
3139 loop = g_new0 (GMainLoop, 1);
3140 loop->context = context;
3141 loop->is_running = is_running != FALSE;
3142 loop->ref_count = 1;
3149 * @loop: a #GMainLoop
3151 * Increases the reference count on a #GMainLoop object by one.
3153 * Return value: @loop
3156 g_main_loop_ref (GMainLoop *loop)
3158 g_return_val_if_fail (loop != NULL, NULL);
3159 g_return_val_if_fail (g_atomic_int_get (&loop->ref_count) > 0, NULL);
3161 g_atomic_int_inc (&loop->ref_count);
3167 * g_main_loop_unref:
3168 * @loop: a #GMainLoop
3170 * Decreases the reference count on a #GMainLoop object by one. If
3171 * the result is zero, free the loop and free all associated memory.
3174 g_main_loop_unref (GMainLoop *loop)
3176 g_return_if_fail (loop != NULL);
3177 g_return_if_fail (g_atomic_int_get (&loop->ref_count) > 0);
3179 if (!g_atomic_int_dec_and_test (&loop->ref_count))
3182 g_main_context_unref (loop->context);
3188 * @loop: a #GMainLoop
3190 * Runs a main loop until g_main_loop_quit() is called on the loop.
3191 * If this is called for the thread of the loop's #GMainContext,
3192 * it will process events from the loop, otherwise it will
3196 g_main_loop_run (GMainLoop *loop)
3198 GThread *self = G_THREAD_SELF;
3200 g_return_if_fail (loop != NULL);
3201 g_return_if_fail (g_atomic_int_get (&loop->ref_count) > 0);
3203 if (!g_main_context_acquire (loop->context))
3205 gboolean got_ownership = FALSE;
3207 /* Another thread owns this context */
3208 LOCK_CONTEXT (loop->context);
3210 g_atomic_int_inc (&loop->ref_count);
3212 if (!loop->is_running)
3213 loop->is_running = TRUE;
3215 while (loop->is_running && !got_ownership)
3216 got_ownership = g_main_context_wait (loop->context,
3217 &loop->context->cond,
3218 &loop->context->mutex);
3220 if (!loop->is_running)
3222 UNLOCK_CONTEXT (loop->context);
3224 g_main_context_release (loop->context);
3225 g_main_loop_unref (loop);
3229 g_assert (got_ownership);
3232 LOCK_CONTEXT (loop->context);
3234 if (loop->context->in_check_or_prepare)
3236 g_warning ("g_main_loop_run(): called recursively from within a source's "
3237 "check() or prepare() member, iteration not possible.");
3241 g_atomic_int_inc (&loop->ref_count);
3242 loop->is_running = TRUE;
3243 while (loop->is_running)
3244 g_main_context_iterate (loop->context, TRUE, TRUE, self);
3246 UNLOCK_CONTEXT (loop->context);
3248 g_main_context_release (loop->context);
3250 g_main_loop_unref (loop);
3255 * @loop: a #GMainLoop
3257 * Stops a #GMainLoop from running. Any calls to g_main_loop_run()
3258 * for the loop will return.
3260 * Note that sources that have already been dispatched when
3261 * g_main_loop_quit() is called will still be executed.
3264 g_main_loop_quit (GMainLoop *loop)
3266 g_return_if_fail (loop != NULL);
3267 g_return_if_fail (g_atomic_int_get (&loop->ref_count) > 0);
3269 LOCK_CONTEXT (loop->context);
3270 loop->is_running = FALSE;
3271 g_wakeup_signal (loop->context->wakeup);
3273 g_cond_broadcast (&loop->context->cond);
3275 UNLOCK_CONTEXT (loop->context);
3279 * g_main_loop_is_running:
3280 * @loop: a #GMainLoop.
3282 * Checks to see if the main loop is currently being run via g_main_loop_run().
3284 * Return value: %TRUE if the mainloop is currently being run.
3287 g_main_loop_is_running (GMainLoop *loop)
3289 g_return_val_if_fail (loop != NULL, FALSE);
3290 g_return_val_if_fail (g_atomic_int_get (&loop->ref_count) > 0, FALSE);
3292 return loop->is_running;
3296 * g_main_loop_get_context:
3297 * @loop: a #GMainLoop.
3299 * Returns the #GMainContext of @loop.
3301 * Return value: (transfer none): the #GMainContext of @loop
3304 g_main_loop_get_context (GMainLoop *loop)
3306 g_return_val_if_fail (loop != NULL, NULL);
3307 g_return_val_if_fail (g_atomic_int_get (&loop->ref_count) > 0, NULL);
3309 return loop->context;
3312 /* HOLDS: context's lock */
3314 g_main_context_poll (GMainContext *context,
3320 #ifdef G_MAIN_POLL_DEBUG
3326 GPollFunc poll_func;
3328 if (n_fds || timeout != 0)
3330 #ifdef G_MAIN_POLL_DEBUG
3331 if (_g_main_poll_debug)
3333 g_print ("polling context=%p n=%d timeout=%d\n",
3334 context, n_fds, timeout);
3335 poll_timer = g_timer_new ();
3339 LOCK_CONTEXT (context);
3341 poll_func = context->poll_func;
3343 UNLOCK_CONTEXT (context);
3344 if ((*poll_func) (fds, n_fds, timeout) < 0 && errno != EINTR)
3347 g_warning ("poll(2) failed due to: %s.",
3348 g_strerror (errno));
3350 /* If g_poll () returns -1, it has already called g_warning() */
3354 #ifdef G_MAIN_POLL_DEBUG
3355 if (_g_main_poll_debug)
3357 LOCK_CONTEXT (context);
3359 g_print ("g_main_poll(%d) timeout: %d - elapsed %12.10f seconds",
3362 g_timer_elapsed (poll_timer, NULL));
3363 g_timer_destroy (poll_timer);
3364 pollrec = context->poll_records;
3366 while (pollrec != NULL)
3371 if (fds[i].fd == pollrec->fd->fd &&
3372 pollrec->fd->events &&
3375 g_print (" [" G_POLLFD_FORMAT " :", fds[i].fd);
3376 if (fds[i].revents & G_IO_IN)
3378 if (fds[i].revents & G_IO_OUT)
3380 if (fds[i].revents & G_IO_PRI)
3382 if (fds[i].revents & G_IO_ERR)
3384 if (fds[i].revents & G_IO_HUP)
3386 if (fds[i].revents & G_IO_NVAL)
3392 pollrec = pollrec->next;
3396 UNLOCK_CONTEXT (context);
3399 } /* if (n_fds || timeout != 0) */
3403 * g_main_context_add_poll:
3404 * @context: a #GMainContext (or %NULL for the default context)
3405 * @fd: a #GPollFD structure holding information about a file
3406 * descriptor to watch.
3407 * @priority: the priority for this file descriptor which should be
3408 * the same as the priority used for g_source_attach() to ensure that the
3409 * file descriptor is polled whenever the results may be needed.
3411 * Adds a file descriptor to the set of file descriptors polled for
3412 * this context. This will very seldom be used directly. Instead
3413 * a typical event source will use g_source_add_poll() instead.
3416 g_main_context_add_poll (GMainContext *context,
3421 context = g_main_context_default ();
3423 g_return_if_fail (g_atomic_int_get (&context->ref_count) > 0);
3424 g_return_if_fail (fd);
3426 LOCK_CONTEXT (context);
3427 g_main_context_add_poll_unlocked (context, priority, fd);
3428 UNLOCK_CONTEXT (context);
3431 /* HOLDS: main_loop_lock */
3433 g_main_context_add_poll_unlocked (GMainContext *context,
3437 GPollRec *prevrec, *nextrec;
3438 GPollRec *newrec = g_slice_new (GPollRec);
3440 /* This file descriptor may be checked before we ever poll */
3443 newrec->priority = priority;
3445 prevrec = context->poll_records_tail;
3447 while (prevrec && priority < prevrec->priority)
3450 prevrec = prevrec->prev;
3454 prevrec->next = newrec;
3456 context->poll_records = newrec;
3458 newrec->prev = prevrec;
3459 newrec->next = nextrec;
3462 nextrec->prev = newrec;
3464 context->poll_records_tail = newrec;
3466 context->n_poll_records++;
3468 context->poll_changed = TRUE;
3470 /* Now wake up the main loop if it is waiting in the poll() */
3471 g_wakeup_signal (context->wakeup);
3475 * g_main_context_remove_poll:
3476 * @context:a #GMainContext
3477 * @fd: a #GPollFD descriptor previously added with g_main_context_add_poll()
3479 * Removes file descriptor from the set of file descriptors to be
3480 * polled for a particular context.
3483 g_main_context_remove_poll (GMainContext *context,
3487 context = g_main_context_default ();
3489 g_return_if_fail (g_atomic_int_get (&context->ref_count) > 0);
3490 g_return_if_fail (fd);
3492 LOCK_CONTEXT (context);
3493 g_main_context_remove_poll_unlocked (context, fd);
3494 UNLOCK_CONTEXT (context);
3498 g_main_context_remove_poll_unlocked (GMainContext *context,
3501 GPollRec *pollrec, *prevrec, *nextrec;
3504 pollrec = context->poll_records;
3508 nextrec = pollrec->next;
3509 if (pollrec->fd == fd)
3511 if (prevrec != NULL)
3512 prevrec->next = nextrec;
3514 context->poll_records = nextrec;
3516 if (nextrec != NULL)
3517 nextrec->prev = prevrec;
3519 context->poll_records_tail = prevrec;
3521 g_slice_free (GPollRec, pollrec);
3523 context->n_poll_records--;
3530 context->poll_changed = TRUE;
3532 /* Now wake up the main loop if it is waiting in the poll() */
3533 g_wakeup_signal (context->wakeup);
3537 * g_source_get_current_time:
3538 * @source: a #GSource
3539 * @timeval: #GTimeVal structure in which to store current time.
3541 * This function ignores @source and is otherwise the same as
3542 * g_get_current_time().
3544 * Deprecated: 2.28: use g_source_get_time() instead
3547 g_source_get_current_time (GSource *source,
3550 g_get_current_time (timeval);
3554 * g_source_get_time:
3555 * @source: a #GSource
3557 * Gets the time to be used when checking this source. The advantage of
3558 * calling this function over calling g_get_monotonic_time() directly is
3559 * that when checking multiple sources, GLib can cache a single value
3560 * instead of having to repeatedly get the system monotonic time.
3562 * The time here is the system monotonic time, if available, or some
3563 * other reasonable alternative otherwise. See g_get_monotonic_time().
3565 * Returns: the monotonic time in microseconds
3570 g_source_get_time (GSource *source)
3572 GMainContext *context;
3575 g_return_val_if_fail (source->context != NULL, 0);
3577 context = source->context;
3579 LOCK_CONTEXT (context);
3581 if (!context->time_is_fresh)
3583 context->time = g_get_monotonic_time ();
3584 context->time_is_fresh = TRUE;
3587 result = context->time;
3589 UNLOCK_CONTEXT (context);
3595 * g_main_context_set_poll_func:
3596 * @context: a #GMainContext
3597 * @func: the function to call to poll all file descriptors
3599 * Sets the function to use to handle polling of file descriptors. It
3600 * will be used instead of the poll() system call
3601 * (or GLib's replacement function, which is used where
3602 * poll() isn't available).
3604 * This function could possibly be used to integrate the GLib event
3605 * loop with an external event loop.
3608 g_main_context_set_poll_func (GMainContext *context,
3612 context = g_main_context_default ();
3614 g_return_if_fail (g_atomic_int_get (&context->ref_count) > 0);
3616 LOCK_CONTEXT (context);
3619 context->poll_func = func;
3621 context->poll_func = g_poll;
3623 UNLOCK_CONTEXT (context);
3627 * g_main_context_get_poll_func:
3628 * @context: a #GMainContext
3630 * Gets the poll function set by g_main_context_set_poll_func().
3632 * Return value: the poll function
3635 g_main_context_get_poll_func (GMainContext *context)
3640 context = g_main_context_default ();
3642 g_return_val_if_fail (g_atomic_int_get (&context->ref_count) > 0, NULL);
3644 LOCK_CONTEXT (context);
3645 result = context->poll_func;
3646 UNLOCK_CONTEXT (context);
3652 * g_main_context_wakeup:
3653 * @context: a #GMainContext
3655 * If @context is currently waiting in a poll(), interrupt
3656 * the poll(), and continue the iteration process.
3659 g_main_context_wakeup (GMainContext *context)
3662 context = g_main_context_default ();
3664 g_return_if_fail (g_atomic_int_get (&context->ref_count) > 0);
3666 g_wakeup_signal (context->wakeup);
3670 * g_main_context_is_owner:
3671 * @context: a #GMainContext
3673 * Determines whether this thread holds the (recursive)
3674 * ownership of this #GMainContext. This is useful to
3675 * know before waiting on another thread that may be
3676 * blocking to get ownership of @context.
3678 * Returns: %TRUE if current thread is owner of @context.
3683 g_main_context_is_owner (GMainContext *context)
3688 context = g_main_context_default ();
3690 LOCK_CONTEXT (context);
3691 is_owner = context->owner == G_THREAD_SELF;
3692 UNLOCK_CONTEXT (context);
3700 g_timeout_set_expiration (GTimeoutSource *timeout_source,
3701 gint64 current_time)
3703 timeout_source->expiration = current_time +
3704 (guint64) timeout_source->interval * 1000;
3706 if (timeout_source->seconds)
3709 static gint timer_perturb = -1;
3711 if (timer_perturb == -1)
3714 * we want a per machine/session unique 'random' value; try the dbus
3715 * address first, that has a UUID in it. If there is no dbus, use the
3716 * hostname for hashing.
3718 const char *session_bus_address = g_getenv ("DBUS_SESSION_BUS_ADDRESS");
3719 if (!session_bus_address)
3720 session_bus_address = g_getenv ("HOSTNAME");
3721 if (session_bus_address)
3722 timer_perturb = ABS ((gint) g_str_hash (session_bus_address)) % 1000000;
3727 /* We want the microseconds part of the timeout to land on the
3728 * 'timer_perturb' mark, but we need to make sure we don't try to
3729 * set the timeout in the past. We do this by ensuring that we
3730 * always only *increase* the expiration time by adding a full
3731 * second in the case that the microsecond portion decreases.
3733 timeout_source->expiration -= timer_perturb;
3735 remainder = timeout_source->expiration % 1000000;
3736 if (remainder >= 1000000/4)
3737 timeout_source->expiration += 1000000;
3739 timeout_source->expiration -= remainder;
3740 timeout_source->expiration += timer_perturb;
3745 g_timeout_prepare (GSource *source,
3748 GTimeoutSource *timeout_source = (GTimeoutSource *) source;
3749 gint64 now = g_source_get_time (source);
3751 if (now < timeout_source->expiration)
3753 /* Round up to ensure that we don't try again too early */
3754 *timeout = (timeout_source->expiration - now + 999) / 1000;
3763 g_timeout_check (GSource *source)
3765 GTimeoutSource *timeout_source = (GTimeoutSource *) source;
3766 gint64 now = g_source_get_time (source);
3768 return timeout_source->expiration <= now;
3772 g_timeout_dispatch (GSource *source,
3773 GSourceFunc callback,
3776 GTimeoutSource *timeout_source = (GTimeoutSource *)source;
3781 g_warning ("Timeout source dispatched without callback\n"
3782 "You must call g_source_set_callback().");
3786 again = callback (user_data);
3789 g_timeout_set_expiration (timeout_source, g_source_get_time (source));
3795 * g_timeout_source_new:
3796 * @interval: the timeout interval in milliseconds.
3798 * Creates a new timeout source.
3800 * The source will not initially be associated with any #GMainContext
3801 * and must be added to one with g_source_attach() before it will be
3804 * The interval given is in terms of monotonic time, not wall clock
3805 * time. See g_get_monotonic_time().
3807 * Return value: the newly-created timeout source
3810 g_timeout_source_new (guint interval)
3812 GSource *source = g_source_new (&g_timeout_funcs, sizeof (GTimeoutSource));
3813 GTimeoutSource *timeout_source = (GTimeoutSource *)source;
3815 timeout_source->interval = interval;
3816 g_timeout_set_expiration (timeout_source, g_get_monotonic_time ());
3822 * g_timeout_source_new_seconds:
3823 * @interval: the timeout interval in seconds
3825 * Creates a new timeout source.
3827 * The source will not initially be associated with any #GMainContext
3828 * and must be added to one with g_source_attach() before it will be
3831 * The scheduling granularity/accuracy of this timeout source will be
3834 * The interval given in terms of monotonic time, not wall clock time.
3835 * See g_get_monotonic_time().
3837 * Return value: the newly-created timeout source
3842 g_timeout_source_new_seconds (guint interval)
3844 GSource *source = g_source_new (&g_timeout_funcs, sizeof (GTimeoutSource));
3845 GTimeoutSource *timeout_source = (GTimeoutSource *)source;
3847 timeout_source->interval = 1000 * interval;
3848 timeout_source->seconds = TRUE;
3850 g_timeout_set_expiration (timeout_source, g_get_monotonic_time ());
3857 * g_timeout_add_full:
3858 * @priority: the priority of the timeout source. Typically this will be in
3859 * the range between #G_PRIORITY_DEFAULT and #G_PRIORITY_HIGH.
3860 * @interval: the time between calls to the function, in milliseconds
3861 * (1/1000ths of a second)
3862 * @function: function to call
3863 * @data: data to pass to @function
3864 * @notify: function to call when the timeout is removed, or %NULL
3866 * Sets a function to be called at regular intervals, with the given
3867 * priority. The function is called repeatedly until it returns
3868 * %FALSE, at which point the timeout is automatically destroyed and
3869 * the function will not be called again. The @notify function is
3870 * called when the timeout is destroyed. The first call to the
3871 * function will be at the end of the first @interval.
3873 * Note that timeout functions may be delayed, due to the processing of other
3874 * event sources. Thus they should not be relied on for precise timing.
3875 * After each call to the timeout function, the time of the next
3876 * timeout is recalculated based on the current time and the given interval
3877 * (it does not try to 'catch up' time lost in delays).
3879 * This internally creates a main loop source using g_timeout_source_new()
3880 * and attaches it to the main loop context using g_source_attach(). You can
3881 * do these steps manually if you need greater control.
3883 * The interval given in terms of monotonic time, not wall clock time.
3884 * See g_get_monotonic_time().
3886 * Return value: the ID (greater than 0) of the event source.
3887 * Rename to: g_timeout_add
3890 g_timeout_add_full (gint priority,
3892 GSourceFunc function,
3894 GDestroyNotify notify)
3899 g_return_val_if_fail (function != NULL, 0);
3901 source = g_timeout_source_new (interval);
3903 if (priority != G_PRIORITY_DEFAULT)
3904 g_source_set_priority (source, priority);
3906 g_source_set_callback (source, function, data, notify);
3907 id = g_source_attach (source, NULL);
3908 g_source_unref (source);
3915 * @interval: the time between calls to the function, in milliseconds
3916 * (1/1000ths of a second)
3917 * @function: function to call
3918 * @data: data to pass to @function
3920 * Sets a function to be called at regular intervals, with the default
3921 * priority, #G_PRIORITY_DEFAULT. The function is called repeatedly
3922 * until it returns %FALSE, at which point the timeout is automatically
3923 * destroyed and the function will not be called again. The first call
3924 * to the function will be at the end of the first @interval.
3926 * Note that timeout functions may be delayed, due to the processing of other
3927 * event sources. Thus they should not be relied on for precise timing.
3928 * After each call to the timeout function, the time of the next
3929 * timeout is recalculated based on the current time and the given interval
3930 * (it does not try to 'catch up' time lost in delays).
3932 * If you want to have a timer in the "seconds" range and do not care
3933 * about the exact time of the first call of the timer, use the
3934 * g_timeout_add_seconds() function; this function allows for more
3935 * optimizations and more efficient system power usage.
3937 * This internally creates a main loop source using g_timeout_source_new()
3938 * and attaches it to the main loop context using g_source_attach(). You can
3939 * do these steps manually if you need greater control.
3941 * The interval given is in terms of monotonic time, not wall clock
3942 * time. See g_get_monotonic_time().
3944 * Return value: the ID (greater than 0) of the event source.
3947 g_timeout_add (guint32 interval,
3948 GSourceFunc function,
3951 return g_timeout_add_full (G_PRIORITY_DEFAULT,
3952 interval, function, data, NULL);
3956 * g_timeout_add_seconds_full:
3957 * @priority: the priority of the timeout source. Typically this will be in
3958 * the range between #G_PRIORITY_DEFAULT and #G_PRIORITY_HIGH.
3959 * @interval: the time between calls to the function, in seconds
3960 * @function: function to call
3961 * @data: data to pass to @function
3962 * @notify: function to call when the timeout is removed, or %NULL
3964 * Sets a function to be called at regular intervals, with @priority.
3965 * The function is called repeatedly until it returns %FALSE, at which
3966 * point the timeout is automatically destroyed and the function will
3967 * not be called again.
3969 * Unlike g_timeout_add(), this function operates at whole second granularity.
3970 * The initial starting point of the timer is determined by the implementation
3971 * and the implementation is expected to group multiple timers together so that
3972 * they fire all at the same time.
3973 * To allow this grouping, the @interval to the first timer is rounded
3974 * and can deviate up to one second from the specified interval.
3975 * Subsequent timer iterations will generally run at the specified interval.
3977 * Note that timeout functions may be delayed, due to the processing of other
3978 * event sources. Thus they should not be relied on for precise timing.
3979 * After each call to the timeout function, the time of the next
3980 * timeout is recalculated based on the current time and the given @interval
3982 * If you want timing more precise than whole seconds, use g_timeout_add()
3985 * The grouping of timers to fire at the same time results in a more power
3986 * and CPU efficient behavior so if your timer is in multiples of seconds
3987 * and you don't require the first timer exactly one second from now, the
3988 * use of g_timeout_add_seconds() is preferred over g_timeout_add().
3990 * This internally creates a main loop source using
3991 * g_timeout_source_new_seconds() and attaches it to the main loop context
3992 * using g_source_attach(). You can do these steps manually if you need
3995 * The interval given is in terms of monotonic time, not wall clock
3996 * time. See g_get_monotonic_time().
3998 * Return value: the ID (greater than 0) of the event source.
4000 * Rename to: g_timeout_add_seconds
4004 g_timeout_add_seconds_full (gint priority,
4006 GSourceFunc function,
4008 GDestroyNotify notify)
4013 g_return_val_if_fail (function != NULL, 0);
4015 source = g_timeout_source_new_seconds (interval);
4017 if (priority != G_PRIORITY_DEFAULT)
4018 g_source_set_priority (source, priority);
4020 g_source_set_callback (source, function, data, notify);
4021 id = g_source_attach (source, NULL);
4022 g_source_unref (source);
4028 * g_timeout_add_seconds:
4029 * @interval: the time between calls to the function, in seconds
4030 * @function: function to call
4031 * @data: data to pass to @function
4033 * Sets a function to be called at regular intervals with the default
4034 * priority, #G_PRIORITY_DEFAULT. The function is called repeatedly until
4035 * it returns %FALSE, at which point the timeout is automatically destroyed
4036 * and the function will not be called again.
4038 * This internally creates a main loop source using
4039 * g_timeout_source_new_seconds() and attaches it to the main loop context
4040 * using g_source_attach(). You can do these steps manually if you need
4041 * greater control. Also see g_timeout_add_seconds_full().
4043 * Note that the first call of the timer may not be precise for timeouts
4044 * of one second. If you need finer precision and have such a timeout,
4045 * you may want to use g_timeout_add() instead.
4047 * The interval given is in terms of monotonic time, not wall clock
4048 * time. See g_get_monotonic_time().
4050 * Return value: the ID (greater than 0) of the event source.
4055 g_timeout_add_seconds (guint interval,
4056 GSourceFunc function,
4059 g_return_val_if_fail (function != NULL, 0);
4061 return g_timeout_add_seconds_full (G_PRIORITY_DEFAULT, interval, function, data, NULL);
4064 /* Child watch functions */
4069 g_child_watch_prepare (GSource *source,
4077 g_child_watch_check (GSource *source)
4079 GChildWatchSource *child_watch_source;
4080 gboolean child_exited;
4082 child_watch_source = (GChildWatchSource *) source;
4084 child_exited = child_watch_source->poll.revents & G_IO_IN;
4091 * Note: We do _not_ check for the special value of STILL_ACTIVE
4092 * since we know that the process has exited and doing so runs into
4093 * problems if the child process "happens to return STILL_ACTIVE(259)"
4094 * as Microsoft's Platform SDK puts it.
4096 if (!GetExitCodeProcess (child_watch_source->pid, &child_status))
4098 gchar *emsg = g_win32_error_message (GetLastError ());
4099 g_warning (G_STRLOC ": GetExitCodeProcess() failed: %s", emsg);
4102 child_watch_source->child_status = -1;
4105 child_watch_source->child_status = child_status;
4108 return child_exited;
4112 g_child_watch_finalize (GSource *source)
4116 #else /* G_OS_WIN32 */
4119 wake_source (GSource *source)
4121 GMainContext *context;
4123 /* This should be thread-safe:
4125 * - if the source is currently being added to a context, that
4126 * context will be woken up anyway
4128 * - if the source is currently being destroyed, we simply need not
4131 * - the memory for the source will remain valid until after the
4132 * source finalize function was called (which would remove the
4133 * source from the global list which we are currently holding the
4136 * - the GMainContext will either be NULL or point to a live
4139 * - the GMainContext will remain valid since we hold the
4140 * main_context_list lock
4142 * Since we are holding a lot of locks here, don't try to enter any
4143 * more GMainContext functions for fear of dealock -- just hit the
4144 * GWakeup and run. Even if that's safe now, it could easily become
4145 * unsafe with some very minor changes in the future, and signal
4146 * handling is not the most well-tested codepath.
4148 G_LOCK(main_context_list);
4149 context = source->context;
4151 g_wakeup_signal (context->wakeup);
4152 G_UNLOCK(main_context_list);
4156 dispatch_unix_signals (void)
4160 /* clear this first incase another one arrives while we're processing */
4161 any_unix_signal_pending = FALSE;
4163 G_LOCK(unix_signal_lock);
4165 /* handle GChildWatchSource instances */
4166 if (unix_signal_pending[SIGCHLD])
4168 unix_signal_pending[SIGCHLD] = FALSE;
4170 /* The only way we can do this is to scan all of the children.
4172 * The docs promise that we will not reap children that we are not
4173 * explicitly watching, so that ties our hands from calling
4174 * waitpid(-1). We also can't use siginfo's si_pid field since if
4175 * multiple SIGCHLD arrive at the same time, one of them can be
4176 * dropped (since a given UNIX signal can only be pending once).
4178 for (node = unix_child_watches; node; node = node->next)
4180 GChildWatchSource *source = node->data;
4182 if (!source->child_exited)
4184 if (waitpid (source->pid, &source->child_status, WNOHANG) > 0)
4186 source->child_exited = TRUE;
4188 wake_source ((GSource *) source);
4194 /* handle GUnixSignalWatchSource instances */
4195 for (node = unix_signal_watches; node; node = node->next)
4197 GUnixSignalWatchSource *source = node->data;
4199 if (!source->pending)
4201 if (unix_signal_pending[source->signum])
4203 unix_signal_pending[source->signum] = FALSE;
4204 source->pending = TRUE;
4206 wake_source ((GSource *) source);
4211 G_UNLOCK(unix_signal_lock);
4215 g_child_watch_prepare (GSource *source,
4218 GChildWatchSource *child_watch_source;
4220 child_watch_source = (GChildWatchSource *) source;
4222 return child_watch_source->child_exited;
4226 g_child_watch_check (GSource *source)
4228 GChildWatchSource *child_watch_source;
4230 child_watch_source = (GChildWatchSource *) source;
4232 return child_watch_source->child_exited;
4236 g_unix_signal_watch_prepare (GSource *source,
4239 GUnixSignalWatchSource *unix_signal_source;
4241 unix_signal_source = (GUnixSignalWatchSource *) source;
4243 return unix_signal_source->pending;
4247 g_unix_signal_watch_check (GSource *source)
4249 GUnixSignalWatchSource *unix_signal_source;
4251 unix_signal_source = (GUnixSignalWatchSource *) source;
4253 return unix_signal_source->pending;
4257 g_unix_signal_watch_dispatch (GSource *source,
4258 GSourceFunc callback,
4261 GUnixSignalWatchSource *unix_signal_source;
4263 unix_signal_source = (GUnixSignalWatchSource *) source;
4267 g_warning ("Unix signal source dispatched without callback\n"
4268 "You must call g_source_set_callback().");
4272 (callback) (user_data);
4274 unix_signal_source->pending = FALSE;
4280 ensure_unix_signal_handler_installed_unlocked (int signum)
4282 static sigset_t installed_signal_mask;
4283 static gboolean initialized;
4284 struct sigaction action;
4288 sigemptyset (&installed_signal_mask);
4289 g_get_worker_context ();
4293 if (sigismember (&installed_signal_mask, signum))
4296 sigaddset (&installed_signal_mask, signum);
4298 action.sa_handler = g_unix_signal_handler;
4299 sigemptyset (&action.sa_mask);
4300 action.sa_flags = SA_RESTART | SA_NOCLDSTOP;
4301 sigaction (signum, &action, NULL);
4305 _g_main_create_unix_signal_watch (int signum)
4308 GUnixSignalWatchSource *unix_signal_source;
4310 source = g_source_new (&g_unix_signal_funcs, sizeof (GUnixSignalWatchSource));
4311 unix_signal_source = (GUnixSignalWatchSource *) source;
4313 unix_signal_source->signum = signum;
4314 unix_signal_source->pending = FALSE;
4316 G_LOCK (unix_signal_lock);
4317 ensure_unix_signal_handler_installed_unlocked (signum);
4318 unix_signal_watches = g_slist_prepend (unix_signal_watches, unix_signal_source);
4319 if (unix_signal_pending[signum])
4320 unix_signal_source->pending = TRUE;
4321 unix_signal_pending[signum] = FALSE;
4322 G_UNLOCK (unix_signal_lock);
4328 g_unix_signal_watch_finalize (GSource *source)
4330 G_LOCK (unix_signal_lock);
4331 unix_signal_watches = g_slist_remove (unix_signal_watches, source);
4332 G_UNLOCK (unix_signal_lock);
4336 g_child_watch_finalize (GSource *source)
4338 G_LOCK (unix_signal_lock);
4339 unix_child_watches = g_slist_remove (unix_child_watches, source);
4340 G_UNLOCK (unix_signal_lock);
4343 #endif /* G_OS_WIN32 */
4346 g_child_watch_dispatch (GSource *source,
4347 GSourceFunc callback,
4350 GChildWatchSource *child_watch_source;
4351 GChildWatchFunc child_watch_callback = (GChildWatchFunc) callback;
4353 child_watch_source = (GChildWatchSource *) source;
4357 g_warning ("Child watch source dispatched without callback\n"
4358 "You must call g_source_set_callback().");
4362 (child_watch_callback) (child_watch_source->pid, child_watch_source->child_status, user_data);
4364 /* We never keep a child watch source around as the child is gone */
4371 g_unix_signal_handler (int signum)
4373 unix_signal_pending[signum] = TRUE;
4374 any_unix_signal_pending = TRUE;
4376 g_wakeup_signal (glib_worker_context->wakeup);
4379 #endif /* !G_OS_WIN32 */
4382 * g_child_watch_source_new:
4383 * @pid: process to watch. On POSIX the pid of a child process. On
4384 * Windows a handle for a process (which doesn't have to be a child).
4386 * Creates a new child_watch source.
4388 * The source will not initially be associated with any #GMainContext
4389 * and must be added to one with g_source_attach() before it will be
4392 * Note that child watch sources can only be used in conjunction with
4393 * <literal>g_spawn...</literal> when the %G_SPAWN_DO_NOT_REAP_CHILD
4396 * Note that on platforms where #GPid must be explicitly closed
4397 * (see g_spawn_close_pid()) @pid must not be closed while the
4398 * source is still active. Typically, you will want to call
4399 * g_spawn_close_pid() in the callback function for the source.
4401 * Note further that using g_child_watch_source_new() is not
4402 * compatible with calling <literal>waitpid(-1)</literal> in
4403 * the application. Calling waitpid() for individual pids will
4406 * Return value: the newly-created child watch source
4411 g_child_watch_source_new (GPid pid)
4413 GSource *source = g_source_new (&g_child_watch_funcs, sizeof (GChildWatchSource));
4414 GChildWatchSource *child_watch_source = (GChildWatchSource *)source;
4416 child_watch_source->pid = pid;
4419 child_watch_source->poll.fd = (gintptr) pid;
4420 child_watch_source->poll.events = G_IO_IN;
4422 g_source_add_poll (source, &child_watch_source->poll);
4423 #else /* G_OS_WIN32 */
4424 G_LOCK (unix_signal_lock);
4425 ensure_unix_signal_handler_installed_unlocked (SIGCHLD);
4426 unix_child_watches = g_slist_prepend (unix_child_watches, child_watch_source);
4427 if (waitpid (pid, &child_watch_source->child_status, WNOHANG) > 0)
4428 child_watch_source->child_exited = TRUE;
4429 G_UNLOCK (unix_signal_lock);
4430 #endif /* G_OS_WIN32 */
4436 * g_child_watch_add_full:
4437 * @priority: the priority of the idle source. Typically this will be in the
4438 * range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE.
4439 * @pid: process to watch. On POSIX the pid of a child process. On
4440 * Windows a handle for a process (which doesn't have to be a child).
4441 * @function: function to call
4442 * @data: data to pass to @function
4443 * @notify: function to call when the idle is removed, or %NULL
4445 * Sets a function to be called when the child indicated by @pid
4446 * exits, at the priority @priority.
4448 * If you obtain @pid from g_spawn_async() or g_spawn_async_with_pipes()
4449 * you will need to pass #G_SPAWN_DO_NOT_REAP_CHILD as flag to
4450 * the spawn function for the child watching to work.
4452 * Note that on platforms where #GPid must be explicitly closed
4453 * (see g_spawn_close_pid()) @pid must not be closed while the
4454 * source is still active. Typically, you will want to call
4455 * g_spawn_close_pid() in the callback function for the source.
4457 * GLib supports only a single callback per process id.
4459 * This internally creates a main loop source using
4460 * g_child_watch_source_new() and attaches it to the main loop context
4461 * using g_source_attach(). You can do these steps manually if you
4462 * need greater control.
4464 * Return value: the ID (greater than 0) of the event source.
4466 * Rename to: g_child_watch_add
4470 g_child_watch_add_full (gint priority,
4472 GChildWatchFunc function,
4474 GDestroyNotify notify)
4479 g_return_val_if_fail (function != NULL, 0);
4481 source = g_child_watch_source_new (pid);
4483 if (priority != G_PRIORITY_DEFAULT)
4484 g_source_set_priority (source, priority);
4486 g_source_set_callback (source, (GSourceFunc) function, data, notify);
4487 id = g_source_attach (source, NULL);
4488 g_source_unref (source);
4494 * g_child_watch_add:
4495 * @pid: process id to watch. On POSIX the pid of a child process. On
4496 * Windows a handle for a process (which doesn't have to be a child).
4497 * @function: function to call
4498 * @data: data to pass to @function
4500 * Sets a function to be called when the child indicated by @pid
4501 * exits, at a default priority, #G_PRIORITY_DEFAULT.
4503 * If you obtain @pid from g_spawn_async() or g_spawn_async_with_pipes()
4504 * you will need to pass #G_SPAWN_DO_NOT_REAP_CHILD as flag to
4505 * the spawn function for the child watching to work.
4507 * Note that on platforms where #GPid must be explicitly closed
4508 * (see g_spawn_close_pid()) @pid must not be closed while the
4509 * source is still active. Typically, you will want to call
4510 * g_spawn_close_pid() in the callback function for the source.
4512 * GLib supports only a single callback per process id.
4514 * This internally creates a main loop source using
4515 * g_child_watch_source_new() and attaches it to the main loop context
4516 * using g_source_attach(). You can do these steps manually if you
4517 * need greater control.
4519 * Return value: the ID (greater than 0) of the event source.
4524 g_child_watch_add (GPid pid,
4525 GChildWatchFunc function,
4528 return g_child_watch_add_full (G_PRIORITY_DEFAULT, pid, function, data, NULL);
4532 /* Idle functions */
4535 g_idle_prepare (GSource *source,
4544 g_idle_check (GSource *source)
4550 g_idle_dispatch (GSource *source,
4551 GSourceFunc callback,
4556 g_warning ("Idle source dispatched without callback\n"
4557 "You must call g_source_set_callback().");
4561 return callback (user_data);
4565 * g_idle_source_new:
4567 * Creates a new idle source.
4569 * The source will not initially be associated with any #GMainContext
4570 * and must be added to one with g_source_attach() before it will be
4571 * executed. Note that the default priority for idle sources is
4572 * %G_PRIORITY_DEFAULT_IDLE, as compared to other sources which
4573 * have a default priority of %G_PRIORITY_DEFAULT.
4575 * Return value: the newly-created idle source
4578 g_idle_source_new (void)
4582 source = g_source_new (&g_idle_funcs, sizeof (GSource));
4583 g_source_set_priority (source, G_PRIORITY_DEFAULT_IDLE);
4590 * @priority: the priority of the idle source. Typically this will be in the
4591 * range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE.
4592 * @function: function to call
4593 * @data: data to pass to @function
4594 * @notify: function to call when the idle is removed, or %NULL
4596 * Adds a function to be called whenever there are no higher priority
4597 * events pending. If the function returns %FALSE it is automatically
4598 * removed from the list of event sources and will not be called again.
4600 * This internally creates a main loop source using g_idle_source_new()
4601 * and attaches it to the main loop context using g_source_attach().
4602 * You can do these steps manually if you need greater control.
4604 * Return value: the ID (greater than 0) of the event source.
4605 * Rename to: g_idle_add
4608 g_idle_add_full (gint priority,
4609 GSourceFunc function,
4611 GDestroyNotify notify)
4616 g_return_val_if_fail (function != NULL, 0);
4618 source = g_idle_source_new ();
4620 if (priority != G_PRIORITY_DEFAULT_IDLE)
4621 g_source_set_priority (source, priority);
4623 g_source_set_callback (source, function, data, notify);
4624 id = g_source_attach (source, NULL);
4625 g_source_unref (source);
4632 * @function: function to call
4633 * @data: data to pass to @function.
4635 * Adds a function to be called whenever there are no higher priority
4636 * events pending to the default main loop. The function is given the
4637 * default idle priority, #G_PRIORITY_DEFAULT_IDLE. If the function
4638 * returns %FALSE it is automatically removed from the list of event
4639 * sources and will not be called again.
4641 * This internally creates a main loop source using g_idle_source_new()
4642 * and attaches it to the main loop context using g_source_attach().
4643 * You can do these steps manually if you need greater control.
4645 * Return value: the ID (greater than 0) of the event source.
4648 g_idle_add (GSourceFunc function,
4651 return g_idle_add_full (G_PRIORITY_DEFAULT_IDLE, function, data, NULL);
4655 * g_idle_remove_by_data:
4656 * @data: the data for the idle source's callback.
4658 * Removes the idle function with the given data.
4660 * Return value: %TRUE if an idle source was found and removed.
4663 g_idle_remove_by_data (gpointer data)
4665 return g_source_remove_by_funcs_user_data (&g_idle_funcs, data);
4669 * g_main_context_invoke:
4670 * @context: (allow-none): a #GMainContext, or %NULL
4671 * @function: function to call
4672 * @data: data to pass to @function
4674 * Invokes a function in such a way that @context is owned during the
4675 * invocation of @function.
4677 * If @context is %NULL then the global default main context — as
4678 * returned by g_main_context_default() — is used.
4680 * If @context is owned by the current thread, @function is called
4681 * directly. Otherwise, if @context is the thread-default main context
4682 * of the current thread and g_main_context_acquire() succeeds, then
4683 * @function is called and g_main_context_release() is called
4686 * In any other case, an idle source is created to call @function and
4687 * that source is attached to @context (presumably to be run in another
4688 * thread). The idle source is attached with #G_PRIORITY_DEFAULT
4689 * priority. If you want a different priority, use
4690 * g_main_context_invoke_full().
4692 * Note that, as with normal idle functions, @function should probably
4693 * return %FALSE. If it returns %TRUE, it will be continuously run in a
4694 * loop (and may prevent this call from returning).
4699 g_main_context_invoke (GMainContext *context,
4700 GSourceFunc function,
4703 g_main_context_invoke_full (context,
4705 function, data, NULL);
4709 * g_main_context_invoke_full:
4710 * @context: (allow-none): a #GMainContext, or %NULL
4711 * @priority: the priority at which to run @function
4712 * @function: function to call
4713 * @data: data to pass to @function
4714 * @notify: a function to call when @data is no longer in use, or %NULL.
4716 * Invokes a function in such a way that @context is owned during the
4717 * invocation of @function.
4719 * This function is the same as g_main_context_invoke() except that it
4720 * lets you specify the priority incase @function ends up being
4721 * scheduled as an idle and also lets you give a #GDestroyNotify for @data.
4723 * @notify should not assume that it is called from any particular
4724 * thread or with any particular context acquired.
4729 g_main_context_invoke_full (GMainContext *context,
4731 GSourceFunc function,
4733 GDestroyNotify notify)
4735 g_return_if_fail (function != NULL);
4738 context = g_main_context_default ();
4740 if (g_main_context_is_owner (context))
4742 while (function (data));
4749 GMainContext *thread_default;
4751 thread_default = g_main_context_get_thread_default ();
4753 if (!thread_default)
4754 thread_default = g_main_context_default ();
4756 if (thread_default == context && g_main_context_acquire (context))
4758 while (function (data));
4760 g_main_context_release (context);
4769 source = g_idle_source_new ();
4770 g_source_set_priority (source, priority);
4771 g_source_set_callback (source, function, data, notify);
4772 g_source_attach (source, context);
4773 g_source_unref (source);
4779 glib_worker_main (gpointer data)
4783 g_main_context_iteration (glib_worker_context, TRUE);
4786 if (any_unix_signal_pending)
4787 dispatch_unix_signals ();
4791 return NULL; /* worst GCC warning message ever... */
4795 g_get_worker_context (void)
4797 static gsize initialised;
4799 if (g_once_init_enter (&initialised))
4801 /* mask all signals in the worker thread */
4807 pthread_sigmask (SIG_SETMASK, &all, &prev_mask);
4809 glib_worker_context = g_main_context_new ();
4810 g_thread_new ("gmain", glib_worker_main, NULL);
4812 pthread_sigmask (SIG_SETMASK, &prev_mask, NULL);
4814 g_once_init_leave (&initialised, TRUE);
4817 return glib_worker_context;