GDesktopAppInfo: rewrite content type code
[glib.git] / glib / gmain.c
blob45ed40250b7a2565b04edde9ff62e757e24d9a76
1 /* GLIB - Library of useful routines for C programming
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * gmain.c: Main loop abstraction, timeouts, and idle functions
5 * Copyright 1998 Owen Taylor
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
22 * Modified by the GLib Team and others 1997-2000. See the AUTHORS
23 * file for a list of people on the GLib Team. See the ChangeLog
24 * files for a list of changes. These files are distributed with
25 * GLib at ftp://ftp.gtk.org/pub/gtk/.
29 * MT safe
32 #include "config.h"
33 #include "glibconfig.h"
35 /* Uncomment the next line (and the corresponding line in gpoll.c) to
36 * enable debugging printouts if the environment variable
37 * G_MAIN_POLL_DEBUG is set to some value.
39 /* #define G_MAIN_POLL_DEBUG */
41 #ifdef _WIN32
42 /* Always enable debugging printout on Windows, as it is more often
43 * needed there...
45 #define G_MAIN_POLL_DEBUG
46 #endif
48 #ifdef G_OS_UNIX
49 #include "glib-unix.h"
50 #include <pthread.h>
51 #ifdef HAVE_EVENTFD
52 #include <sys/eventfd.h>
53 #endif
54 #endif
56 #include <signal.h>
57 #include <sys/types.h>
58 #include <time.h>
59 #include <stdlib.h>
60 #ifdef HAVE_SYS_TIME_H
61 #include <sys/time.h>
62 #endif /* HAVE_SYS_TIME_H */
63 #ifdef G_OS_UNIX
64 #include <unistd.h>
65 #endif /* G_OS_UNIX */
66 #include <errno.h>
67 #include <string.h>
69 #ifdef G_OS_WIN32
70 #define STRICT
71 #include <windows.h>
72 #endif /* G_OS_WIN32 */
74 #ifdef HAVE_MACH_MACH_TIME_H
75 #include <mach/mach_time.h>
76 #endif
78 #include "glib_trace.h"
80 #include "gmain.h"
82 #include "garray.h"
83 #include "giochannel.h"
84 #include "ghash.h"
85 #include "ghook.h"
86 #include "gqueue.h"
87 #include "gstrfuncs.h"
88 #include "gtestutils.h"
90 #ifdef G_OS_WIN32
91 #include "gwin32.h"
92 #endif
94 #ifdef G_MAIN_POLL_DEBUG
95 #include "gtimer.h"
96 #endif
98 #include "gwakeup.h"
99 #include "gmain-internal.h"
100 #include "glib-init.h"
101 #include "glib-private.h"
104 * SECTION:main
105 * @title: The Main Event Loop
106 * @short_description: manages all available sources of events
108 * The main event loop manages all the available sources of events for
109 * GLib and GTK+ applications. These events can come from any number of
110 * different types of sources such as file descriptors (plain files,
111 * pipes or sockets) and timeouts. New types of event sources can also
112 * be added using g_source_attach().
114 * To allow multiple independent sets of sources to be handled in
115 * different threads, each source is associated with a #GMainContext.
116 * A GMainContext can only be running in a single thread, but
117 * sources can be added to it and removed from it from other threads.
119 * Each event source is assigned a priority. The default priority,
120 * #G_PRIORITY_DEFAULT, is 0. Values less than 0 denote higher priorities.
121 * Values greater than 0 denote lower priorities. Events from high priority
122 * sources are always processed before events from lower priority sources.
124 * Idle functions can also be added, and assigned a priority. These will
125 * be run whenever no events with a higher priority are ready to be processed.
127 * The #GMainLoop data type represents a main event loop. A GMainLoop is
128 * created with g_main_loop_new(). After adding the initial event sources,
129 * g_main_loop_run() is called. This continuously checks for new events from
130 * each of the event sources and dispatches them. Finally, the processing of
131 * an event from one of the sources leads to a call to g_main_loop_quit() to
132 * exit the main loop, and g_main_loop_run() returns.
134 * It is possible to create new instances of #GMainLoop recursively.
135 * This is often used in GTK+ applications when showing modal dialog
136 * boxes. Note that event sources are associated with a particular
137 * #GMainContext, and will be checked and dispatched for all main
138 * loops associated with that GMainContext.
140 * GTK+ contains wrappers of some of these functions, e.g. gtk_main(),
141 * gtk_main_quit() and gtk_events_pending().
143 * ## Creating new source types
145 * One of the unusual features of the #GMainLoop functionality
146 * is that new types of event source can be created and used in
147 * addition to the builtin type of event source. A new event source
148 * type is used for handling GDK events. A new source type is created
149 * by "deriving" from the #GSource structure. The derived type of
150 * source is represented by a structure that has the #GSource structure
151 * as a first element, and other elements specific to the new source
152 * type. To create an instance of the new source type, call
153 * g_source_new() passing in the size of the derived structure and
154 * a table of functions. These #GSourceFuncs determine the behavior of
155 * the new source type.
157 * New source types basically interact with the main context
158 * in two ways. Their prepare function in #GSourceFuncs can set a timeout
159 * to determine the maximum amount of time that the main loop will sleep
160 * before checking the source again. In addition, or as well, the source
161 * can add file descriptors to the set that the main context checks using
162 * g_source_add_poll().
164 * ## Customizing the main loop iteration
166 * Single iterations of a #GMainContext can be run with
167 * g_main_context_iteration(). In some cases, more detailed control
168 * of exactly how the details of the main loop work is desired, for
169 * instance, when integrating the #GMainLoop with an external main loop.
170 * In such cases, you can call the component functions of
171 * g_main_context_iteration() directly. These functions are
172 * g_main_context_prepare(), g_main_context_query(),
173 * g_main_context_check() and g_main_context_dispatch().
175 * ## State of a Main Context # {#mainloop-states}
177 * The operation of these functions can best be seen in terms
178 * of a state diagram, as shown in this image.
180 * ![](mainloop-states.gif)
182 * On UNIX, the GLib mainloop is incompatible with fork(). Any program
183 * using the mainloop must either exec() or exit() from the child
184 * without returning to the mainloop.
187 /* Types */
189 typedef struct _GTimeoutSource GTimeoutSource;
190 typedef struct _GChildWatchSource GChildWatchSource;
191 typedef struct _GUnixSignalWatchSource GUnixSignalWatchSource;
192 typedef struct _GPollRec GPollRec;
193 typedef struct _GSourceCallback GSourceCallback;
195 typedef enum
197 G_SOURCE_READY = 1 << G_HOOK_FLAG_USER_SHIFT,
198 G_SOURCE_CAN_RECURSE = 1 << (G_HOOK_FLAG_USER_SHIFT + 1),
199 G_SOURCE_BLOCKED = 1 << (G_HOOK_FLAG_USER_SHIFT + 2)
200 } GSourceFlags;
202 typedef struct _GSourceList GSourceList;
204 struct _GSourceList
206 GSource *head, *tail;
207 gint priority;
210 typedef struct _GMainWaiter GMainWaiter;
212 struct _GMainWaiter
214 GCond *cond;
215 GMutex *mutex;
218 typedef struct _GMainDispatch GMainDispatch;
220 struct _GMainDispatch
222 gint depth;
223 GSource *source;
226 #ifdef G_MAIN_POLL_DEBUG
227 gboolean _g_main_poll_debug = FALSE;
228 #endif
230 struct _GMainContext
232 /* The following lock is used for both the list of sources
233 * and the list of poll records
235 GMutex mutex;
236 GCond cond;
237 GThread *owner;
238 guint owner_count;
239 GSList *waiters;
241 gint ref_count;
243 GHashTable *sources; /* guint -> GSource */
245 GPtrArray *pending_dispatches;
246 gint timeout; /* Timeout for current iteration */
248 guint next_id;
249 GList *source_lists;
250 gint in_check_or_prepare;
252 GPollRec *poll_records, *poll_records_tail;
253 guint n_poll_records;
254 GPollFD *cached_poll_array;
255 guint cached_poll_array_size;
257 GWakeup *wakeup;
259 GPollFD wake_up_rec;
261 /* Flag indicating whether the set of fd's changed during a poll */
262 gboolean poll_changed;
264 GPollFunc poll_func;
266 gint64 time;
267 gboolean time_is_fresh;
270 struct _GSourceCallback
272 guint ref_count;
273 GSourceFunc func;
274 gpointer data;
275 GDestroyNotify notify;
278 struct _GMainLoop
280 GMainContext *context;
281 gboolean is_running;
282 gint ref_count;
285 struct _GTimeoutSource
287 GSource source;
288 guint interval;
289 gboolean seconds;
292 struct _GChildWatchSource
294 GSource source;
295 GPid pid;
296 gint child_status;
297 #ifdef G_OS_WIN32
298 GPollFD poll;
299 #else /* G_OS_WIN32 */
300 gboolean child_exited;
301 #endif /* G_OS_WIN32 */
304 struct _GUnixSignalWatchSource
306 GSource source;
307 int signum;
308 gboolean pending;
311 struct _GPollRec
313 GPollFD *fd;
314 GPollRec *prev;
315 GPollRec *next;
316 gint priority;
319 struct _GSourcePrivate
321 GSList *child_sources;
322 GSource *parent_source;
324 gint64 ready_time;
326 /* This is currently only used on UNIX, but we always declare it (and
327 * let it remain empty on Windows) to avoid #ifdef all over the place.
329 GSList *fds;
332 typedef struct _GSourceIter
334 GMainContext *context;
335 gboolean may_modify;
336 GList *current_list;
337 GSource *source;
338 } GSourceIter;
340 #define LOCK_CONTEXT(context) g_mutex_lock (&context->mutex)
341 #define UNLOCK_CONTEXT(context) g_mutex_unlock (&context->mutex)
342 #define G_THREAD_SELF g_thread_self ()
344 #define SOURCE_DESTROYED(source) (((source)->flags & G_HOOK_FLAG_ACTIVE) == 0)
345 #define SOURCE_BLOCKED(source) (((source)->flags & G_SOURCE_BLOCKED) != 0)
347 #define SOURCE_UNREF(source, context) \
348 G_STMT_START { \
349 if ((source)->ref_count > 1) \
350 (source)->ref_count--; \
351 else \
352 g_source_unref_internal ((source), (context), TRUE); \
353 } G_STMT_END
356 /* Forward declarations */
358 static void g_source_unref_internal (GSource *source,
359 GMainContext *context,
360 gboolean have_lock);
361 static void g_source_destroy_internal (GSource *source,
362 GMainContext *context,
363 gboolean have_lock);
364 static void g_source_set_priority_unlocked (GSource *source,
365 GMainContext *context,
366 gint priority);
367 static void g_child_source_remove_internal (GSource *child_source,
368 GMainContext *context);
370 static void g_main_context_poll (GMainContext *context,
371 gint timeout,
372 gint priority,
373 GPollFD *fds,
374 gint n_fds);
375 static void g_main_context_add_poll_unlocked (GMainContext *context,
376 gint priority,
377 GPollFD *fd);
378 static void g_main_context_remove_poll_unlocked (GMainContext *context,
379 GPollFD *fd);
381 static void g_source_iter_init (GSourceIter *iter,
382 GMainContext *context,
383 gboolean may_modify);
384 static gboolean g_source_iter_next (GSourceIter *iter,
385 GSource **source);
386 static void g_source_iter_clear (GSourceIter *iter);
388 static gboolean g_timeout_dispatch (GSource *source,
389 GSourceFunc callback,
390 gpointer user_data);
391 static gboolean g_child_watch_prepare (GSource *source,
392 gint *timeout);
393 static gboolean g_child_watch_check (GSource *source);
394 static gboolean g_child_watch_dispatch (GSource *source,
395 GSourceFunc callback,
396 gpointer user_data);
397 static void g_child_watch_finalize (GSource *source);
398 #ifdef G_OS_UNIX
399 static void g_unix_signal_handler (int signum);
400 static gboolean g_unix_signal_watch_prepare (GSource *source,
401 gint *timeout);
402 static gboolean g_unix_signal_watch_check (GSource *source);
403 static gboolean g_unix_signal_watch_dispatch (GSource *source,
404 GSourceFunc callback,
405 gpointer user_data);
406 static void g_unix_signal_watch_finalize (GSource *source);
407 #endif
408 static gboolean g_idle_prepare (GSource *source,
409 gint *timeout);
410 static gboolean g_idle_check (GSource *source);
411 static gboolean g_idle_dispatch (GSource *source,
412 GSourceFunc callback,
413 gpointer user_data);
415 static void block_source (GSource *source);
417 static GMainContext *glib_worker_context;
419 G_LOCK_DEFINE_STATIC (main_loop);
420 static GMainContext *default_main_context;
422 #ifndef G_OS_WIN32
425 /* UNIX signals work by marking one of these variables then waking the
426 * worker context to check on them and dispatch accordingly.
428 #ifdef HAVE_SIG_ATOMIC_T
429 static volatile sig_atomic_t unix_signal_pending[NSIG];
430 static volatile sig_atomic_t any_unix_signal_pending;
431 #else
432 static volatile int unix_signal_pending[NSIG];
433 static volatile int any_unix_signal_pending;
434 #endif
435 static volatile guint unix_signal_refcount[NSIG];
437 /* Guards all the data below */
438 G_LOCK_DEFINE_STATIC (unix_signal_lock);
439 static GSList *unix_signal_watches;
440 static GSList *unix_child_watches;
442 GSourceFuncs g_unix_signal_funcs =
444 g_unix_signal_watch_prepare,
445 g_unix_signal_watch_check,
446 g_unix_signal_watch_dispatch,
447 g_unix_signal_watch_finalize
449 #endif /* !G_OS_WIN32 */
450 G_LOCK_DEFINE_STATIC (main_context_list);
451 static GSList *main_context_list = NULL;
453 GSourceFuncs g_timeout_funcs =
455 NULL, /* prepare */
456 NULL, /* check */
457 g_timeout_dispatch,
458 NULL
461 GSourceFuncs g_child_watch_funcs =
463 g_child_watch_prepare,
464 g_child_watch_check,
465 g_child_watch_dispatch,
466 g_child_watch_finalize
469 GSourceFuncs g_idle_funcs =
471 g_idle_prepare,
472 g_idle_check,
473 g_idle_dispatch,
474 NULL
478 * g_main_context_ref:
479 * @context: a #GMainContext
481 * Increases the reference count on a #GMainContext object by one.
483 * Returns: the @context that was passed in (since 2.6)
485 GMainContext *
486 g_main_context_ref (GMainContext *context)
488 g_return_val_if_fail (context != NULL, NULL);
489 g_return_val_if_fail (g_atomic_int_get (&context->ref_count) > 0, NULL);
491 g_atomic_int_inc (&context->ref_count);
493 return context;
496 static inline void
497 poll_rec_list_free (GMainContext *context,
498 GPollRec *list)
500 g_slice_free_chain (GPollRec, list, next);
504 * g_main_context_unref:
505 * @context: a #GMainContext
507 * Decreases the reference count on a #GMainContext object by one. If
508 * the result is zero, free the context and free all associated memory.
510 void
511 g_main_context_unref (GMainContext *context)
513 GSourceIter iter;
514 GSource *source;
515 GList *sl_iter;
516 GSourceList *list;
517 gint i;
519 g_return_if_fail (context != NULL);
520 g_return_if_fail (g_atomic_int_get (&context->ref_count) > 0);
522 if (!g_atomic_int_dec_and_test (&context->ref_count))
523 return;
525 G_LOCK (main_context_list);
526 main_context_list = g_slist_remove (main_context_list, context);
527 G_UNLOCK (main_context_list);
529 /* Free pending dispatches */
530 for (i = 0; i < context->pending_dispatches->len; i++)
531 g_source_unref_internal (context->pending_dispatches->pdata[i], context, FALSE);
533 /* g_source_iter_next() assumes the context is locked. */
534 LOCK_CONTEXT (context);
535 g_source_iter_init (&iter, context, TRUE);
536 while (g_source_iter_next (&iter, &source))
538 source->context = NULL;
539 g_source_destroy_internal (source, context, TRUE);
541 UNLOCK_CONTEXT (context);
543 for (sl_iter = context->source_lists; sl_iter; sl_iter = sl_iter->next)
545 list = sl_iter->data;
546 g_slice_free (GSourceList, list);
548 g_list_free (context->source_lists);
550 g_hash_table_destroy (context->sources);
552 g_mutex_clear (&context->mutex);
554 g_ptr_array_free (context->pending_dispatches, TRUE);
555 g_free (context->cached_poll_array);
557 poll_rec_list_free (context, context->poll_records);
559 g_wakeup_free (context->wakeup);
560 g_cond_clear (&context->cond);
562 g_free (context);
565 /* Helper function used by mainloop/overflow test.
567 GMainContext *
568 g_main_context_new_with_next_id (guint next_id)
570 GMainContext *ret = g_main_context_new ();
572 ret->next_id = next_id;
574 return ret;
578 * g_main_context_new:
580 * Creates a new #GMainContext structure.
582 * Returns: the new #GMainContext
584 GMainContext *
585 g_main_context_new (void)
587 static gsize initialised;
588 GMainContext *context;
590 if (g_once_init_enter (&initialised))
592 #ifdef G_MAIN_POLL_DEBUG
593 if (getenv ("G_MAIN_POLL_DEBUG") != NULL)
594 _g_main_poll_debug = TRUE;
595 #endif
597 g_once_init_leave (&initialised, TRUE);
600 context = g_new0 (GMainContext, 1);
602 g_mutex_init (&context->mutex);
603 g_cond_init (&context->cond);
605 context->sources = g_hash_table_new (NULL, NULL);
606 context->owner = NULL;
607 context->waiters = NULL;
609 context->ref_count = 1;
611 context->next_id = 1;
613 context->source_lists = NULL;
615 context->poll_func = g_poll;
617 context->cached_poll_array = NULL;
618 context->cached_poll_array_size = 0;
620 context->pending_dispatches = g_ptr_array_new ();
622 context->time_is_fresh = FALSE;
624 context->wakeup = g_wakeup_new ();
625 g_wakeup_get_pollfd (context->wakeup, &context->wake_up_rec);
626 g_main_context_add_poll_unlocked (context, 0, &context->wake_up_rec);
628 G_LOCK (main_context_list);
629 main_context_list = g_slist_append (main_context_list, context);
631 #ifdef G_MAIN_POLL_DEBUG
632 if (_g_main_poll_debug)
633 g_print ("created context=%p\n", context);
634 #endif
636 G_UNLOCK (main_context_list);
638 return context;
642 * g_main_context_default:
644 * Returns the global default main context. This is the main context
645 * used for main loop functions when a main loop is not explicitly
646 * specified, and corresponds to the "main" main loop. See also
647 * g_main_context_get_thread_default().
649 * Returns: (transfer none): the global default main context.
651 GMainContext *
652 g_main_context_default (void)
654 /* Slow, but safe */
656 G_LOCK (main_loop);
658 if (!default_main_context)
660 default_main_context = g_main_context_new ();
661 #ifdef G_MAIN_POLL_DEBUG
662 if (_g_main_poll_debug)
663 g_print ("default context=%p\n", default_main_context);
664 #endif
667 G_UNLOCK (main_loop);
669 return default_main_context;
672 static void
673 free_context (gpointer data)
675 GMainContext *context = data;
677 g_main_context_release (context);
678 if (context)
679 g_main_context_unref (context);
682 static void
683 free_context_stack (gpointer data)
685 g_queue_free_full((GQueue *) data, (GDestroyNotify) free_context);
688 static GPrivate thread_context_stack = G_PRIVATE_INIT (free_context_stack);
691 * g_main_context_push_thread_default:
692 * @context: (allow-none): a #GMainContext, or %NULL for the global default context
694 * Acquires @context and sets it as the thread-default context for the
695 * current thread. This will cause certain asynchronous operations
696 * (such as most [gio][gio]-based I/O) which are
697 * started in this thread to run under @context and deliver their
698 * results to its main loop, rather than running under the global
699 * default context in the main thread. Note that calling this function
700 * changes the context returned by g_main_context_get_thread_default(),
701 * not the one returned by g_main_context_default(), so it does not affect
702 * the context used by functions like g_idle_add().
704 * Normally you would call this function shortly after creating a new
705 * thread, passing it a #GMainContext which will be run by a
706 * #GMainLoop in that thread, to set a new default context for all
707 * async operations in that thread. (In this case, you don't need to
708 * ever call g_main_context_pop_thread_default().) In some cases
709 * however, you may want to schedule a single operation in a
710 * non-default context, or temporarily use a non-default context in
711 * the main thread. In that case, you can wrap the call to the
712 * asynchronous operation inside a
713 * g_main_context_push_thread_default() /
714 * g_main_context_pop_thread_default() pair, but it is up to you to
715 * ensure that no other asynchronous operations accidentally get
716 * started while the non-default context is active.
718 * Beware that libraries that predate this function may not correctly
719 * handle being used from a thread with a thread-default context. Eg,
720 * see g_file_supports_thread_contexts().
722 * Since: 2.22
724 void
725 g_main_context_push_thread_default (GMainContext *context)
727 GQueue *stack;
728 gboolean acquired_context;
730 acquired_context = g_main_context_acquire (context);
731 g_return_if_fail (acquired_context);
733 if (context == g_main_context_default ())
734 context = NULL;
735 else if (context)
736 g_main_context_ref (context);
738 stack = g_private_get (&thread_context_stack);
739 if (!stack)
741 stack = g_queue_new ();
742 g_private_set (&thread_context_stack, stack);
745 g_queue_push_head (stack, context);
749 * g_main_context_pop_thread_default:
750 * @context: (allow-none): a #GMainContext object, or %NULL
752 * Pops @context off the thread-default context stack (verifying that
753 * it was on the top of the stack).
755 * Since: 2.22
757 void
758 g_main_context_pop_thread_default (GMainContext *context)
760 GQueue *stack;
762 if (context == g_main_context_default ())
763 context = NULL;
765 stack = g_private_get (&thread_context_stack);
767 g_return_if_fail (stack != NULL);
768 g_return_if_fail (g_queue_peek_head (stack) == context);
770 g_queue_pop_head (stack);
772 g_main_context_release (context);
773 if (context)
774 g_main_context_unref (context);
778 * g_main_context_get_thread_default:
780 * Gets the thread-default #GMainContext for this thread. Asynchronous
781 * operations that want to be able to be run in contexts other than
782 * the default one should call this method or
783 * g_main_context_ref_thread_default() to get a #GMainContext to add
784 * their #GSources to. (Note that even in single-threaded
785 * programs applications may sometimes want to temporarily push a
786 * non-default context, so it is not safe to assume that this will
787 * always return %NULL if you are running in the default thread.)
789 * If you need to hold a reference on the context, use
790 * g_main_context_ref_thread_default() instead.
792 * Returns: (transfer none): the thread-default #GMainContext, or
793 * %NULL if the thread-default context is the global default context.
795 * Since: 2.22
797 GMainContext *
798 g_main_context_get_thread_default (void)
800 GQueue *stack;
802 stack = g_private_get (&thread_context_stack);
803 if (stack)
804 return g_queue_peek_head (stack);
805 else
806 return NULL;
810 * g_main_context_ref_thread_default:
812 * Gets the thread-default #GMainContext for this thread, as with
813 * g_main_context_get_thread_default(), but also adds a reference to
814 * it with g_main_context_ref(). In addition, unlike
815 * g_main_context_get_thread_default(), if the thread-default context
816 * is the global default context, this will return that #GMainContext
817 * (with a ref added to it) rather than returning %NULL.
819 * Returns: (transfer full): the thread-default #GMainContext. Unref
820 * with g_main_context_unref() when you are done with it.
822 * Since: 2.32
824 GMainContext *
825 g_main_context_ref_thread_default (void)
827 GMainContext *context;
829 context = g_main_context_get_thread_default ();
830 if (!context)
831 context = g_main_context_default ();
832 return g_main_context_ref (context);
835 /* Hooks for adding to the main loop */
838 * g_source_new:
839 * @source_funcs: structure containing functions that implement
840 * the sources behavior.
841 * @struct_size: size of the #GSource structure to create.
843 * Creates a new #GSource structure. The size is specified to
844 * allow creating structures derived from #GSource that contain
845 * additional data. The size passed in must be at least
846 * `sizeof (GSource)`.
848 * The source will not initially be associated with any #GMainContext
849 * and must be added to one with g_source_attach() before it will be
850 * executed.
852 * Returns: the newly-created #GSource.
854 GSource *
855 g_source_new (GSourceFuncs *source_funcs,
856 guint struct_size)
858 GSource *source;
860 g_return_val_if_fail (source_funcs != NULL, NULL);
861 g_return_val_if_fail (struct_size >= sizeof (GSource), NULL);
863 source = (GSource*) g_malloc0 (struct_size);
864 source->priv = g_slice_new0 (GSourcePrivate);
865 source->source_funcs = source_funcs;
866 source->ref_count = 1;
868 source->priority = G_PRIORITY_DEFAULT;
870 source->flags = G_HOOK_FLAG_ACTIVE;
872 source->priv->ready_time = -1;
874 /* NULL/0 initialization for all other fields */
876 return source;
879 /* Holds context's lock */
880 static void
881 g_source_iter_init (GSourceIter *iter,
882 GMainContext *context,
883 gboolean may_modify)
885 iter->context = context;
886 iter->current_list = NULL;
887 iter->source = NULL;
888 iter->may_modify = may_modify;
891 /* Holds context's lock */
892 static gboolean
893 g_source_iter_next (GSourceIter *iter, GSource **source)
895 GSource *next_source;
897 if (iter->source)
898 next_source = iter->source->next;
899 else
900 next_source = NULL;
902 if (!next_source)
904 if (iter->current_list)
905 iter->current_list = iter->current_list->next;
906 else
907 iter->current_list = iter->context->source_lists;
909 if (iter->current_list)
911 GSourceList *source_list = iter->current_list->data;
913 next_source = source_list->head;
917 /* Note: unreffing iter->source could potentially cause its
918 * GSourceList to be removed from source_lists (if iter->source is
919 * the only source in its list, and it is destroyed), so we have to
920 * keep it reffed until after we advance iter->current_list, above.
923 if (iter->source && iter->may_modify)
924 SOURCE_UNREF (iter->source, iter->context);
925 iter->source = next_source;
926 if (iter->source && iter->may_modify)
927 iter->source->ref_count++;
929 *source = iter->source;
930 return *source != NULL;
933 /* Holds context's lock. Only necessary to call if you broke out of
934 * the g_source_iter_next() loop early.
936 static void
937 g_source_iter_clear (GSourceIter *iter)
939 if (iter->source && iter->may_modify)
941 SOURCE_UNREF (iter->source, iter->context);
942 iter->source = NULL;
946 /* Holds context's lock
948 static GSourceList *
949 find_source_list_for_priority (GMainContext *context,
950 gint priority,
951 gboolean create)
953 GList *iter, *last;
954 GSourceList *source_list;
956 last = NULL;
957 for (iter = context->source_lists; iter != NULL; last = iter, iter = iter->next)
959 source_list = iter->data;
961 if (source_list->priority == priority)
962 return source_list;
964 if (source_list->priority > priority)
966 if (!create)
967 return NULL;
969 source_list = g_slice_new0 (GSourceList);
970 source_list->priority = priority;
971 context->source_lists = g_list_insert_before (context->source_lists,
972 iter,
973 source_list);
974 return source_list;
978 if (!create)
979 return NULL;
981 source_list = g_slice_new0 (GSourceList);
982 source_list->priority = priority;
984 if (!last)
985 context->source_lists = g_list_append (NULL, source_list);
986 else
988 /* This just appends source_list to the end of
989 * context->source_lists without having to walk the list again.
991 last = g_list_append (last, source_list);
993 return source_list;
996 /* Holds context's lock
998 static void
999 source_add_to_context (GSource *source,
1000 GMainContext *context)
1002 GSourceList *source_list;
1003 GSource *prev, *next;
1005 source_list = find_source_list_for_priority (context, source->priority, TRUE);
1007 if (source->priv->parent_source)
1009 g_assert (source_list->head != NULL);
1011 /* Put the source immediately before its parent */
1012 prev = source->priv->parent_source->prev;
1013 next = source->priv->parent_source;
1015 else
1017 prev = source_list->tail;
1018 next = NULL;
1021 source->next = next;
1022 if (next)
1023 next->prev = source;
1024 else
1025 source_list->tail = source;
1027 source->prev = prev;
1028 if (prev)
1029 prev->next = source;
1030 else
1031 source_list->head = source;
1034 /* Holds context's lock
1036 static void
1037 source_remove_from_context (GSource *source,
1038 GMainContext *context)
1040 GSourceList *source_list;
1042 source_list = find_source_list_for_priority (context, source->priority, FALSE);
1043 g_return_if_fail (source_list != NULL);
1045 if (source->prev)
1046 source->prev->next = source->next;
1047 else
1048 source_list->head = source->next;
1050 if (source->next)
1051 source->next->prev = source->prev;
1052 else
1053 source_list->tail = source->prev;
1055 source->prev = NULL;
1056 source->next = NULL;
1058 if (source_list->head == NULL)
1060 context->source_lists = g_list_remove (context->source_lists, source_list);
1061 g_slice_free (GSourceList, source_list);
1065 static guint
1066 g_source_attach_unlocked (GSource *source,
1067 GMainContext *context,
1068 gboolean do_wakeup)
1070 GSList *tmp_list;
1071 guint id;
1073 /* The counter may have wrapped, so we must ensure that we do not
1074 * reuse the source id of an existing source.
1077 id = context->next_id++;
1078 while (id == 0 || g_hash_table_contains (context->sources, GUINT_TO_POINTER (id)));
1080 source->context = context;
1081 source->source_id = id;
1082 source->ref_count++;
1084 g_hash_table_insert (context->sources, GUINT_TO_POINTER (id), source);
1086 source_add_to_context (source, context);
1088 if (!SOURCE_BLOCKED (source))
1090 tmp_list = source->poll_fds;
1091 while (tmp_list)
1093 g_main_context_add_poll_unlocked (context, source->priority, tmp_list->data);
1094 tmp_list = tmp_list->next;
1097 for (tmp_list = source->priv->fds; tmp_list; tmp_list = tmp_list->next)
1098 g_main_context_add_poll_unlocked (context, source->priority, tmp_list->data);
1101 tmp_list = source->priv->child_sources;
1102 while (tmp_list)
1104 g_source_attach_unlocked (tmp_list->data, context, FALSE);
1105 tmp_list = tmp_list->next;
1108 /* If another thread has acquired the context, wake it up since it
1109 * might be in poll() right now.
1111 if (do_wakeup && context->owner && context->owner != G_THREAD_SELF)
1112 g_wakeup_signal (context->wakeup);
1114 return source->source_id;
1118 * g_source_attach:
1119 * @source: a #GSource
1120 * @context: (allow-none): a #GMainContext (if %NULL, the default context will be used)
1122 * Adds a #GSource to a @context so that it will be executed within
1123 * that context. Remove it by calling g_source_destroy().
1125 * Returns: the ID (greater than 0) for the source within the
1126 * #GMainContext.
1128 guint
1129 g_source_attach (GSource *source,
1130 GMainContext *context)
1132 guint result = 0;
1134 g_return_val_if_fail (source->context == NULL, 0);
1135 g_return_val_if_fail (!SOURCE_DESTROYED (source), 0);
1137 TRACE (GLIB_MAIN_SOURCE_ATTACH (g_source_get_name (source)));
1139 if (!context)
1140 context = g_main_context_default ();
1142 LOCK_CONTEXT (context);
1144 result = g_source_attach_unlocked (source, context, TRUE);
1146 UNLOCK_CONTEXT (context);
1148 return result;
1151 static void
1152 g_source_destroy_internal (GSource *source,
1153 GMainContext *context,
1154 gboolean have_lock)
1156 TRACE (GLIB_MAIN_SOURCE_DESTROY (g_source_get_name (source)));
1158 if (!have_lock)
1159 LOCK_CONTEXT (context);
1161 if (!SOURCE_DESTROYED (source))
1163 GSList *tmp_list;
1164 gpointer old_cb_data;
1165 GSourceCallbackFuncs *old_cb_funcs;
1167 source->flags &= ~G_HOOK_FLAG_ACTIVE;
1169 old_cb_data = source->callback_data;
1170 old_cb_funcs = source->callback_funcs;
1172 source->callback_data = NULL;
1173 source->callback_funcs = NULL;
1175 if (old_cb_funcs)
1177 UNLOCK_CONTEXT (context);
1178 old_cb_funcs->unref (old_cb_data);
1179 LOCK_CONTEXT (context);
1182 if (!SOURCE_BLOCKED (source))
1184 tmp_list = source->poll_fds;
1185 while (tmp_list)
1187 g_main_context_remove_poll_unlocked (context, tmp_list->data);
1188 tmp_list = tmp_list->next;
1191 for (tmp_list = source->priv->fds; tmp_list; tmp_list = tmp_list->next)
1192 g_main_context_remove_poll_unlocked (context, tmp_list->data);
1195 while (source->priv->child_sources)
1196 g_child_source_remove_internal (source->priv->child_sources->data, context);
1198 if (source->priv->parent_source)
1199 g_child_source_remove_internal (source, context);
1201 g_source_unref_internal (source, context, TRUE);
1204 if (!have_lock)
1205 UNLOCK_CONTEXT (context);
1209 * g_source_destroy:
1210 * @source: a #GSource
1212 * Removes a source from its #GMainContext, if any, and mark it as
1213 * destroyed. The source cannot be subsequently added to another
1214 * context. It is safe to call this on sources which have already been
1215 * removed from their context.
1217 void
1218 g_source_destroy (GSource *source)
1220 GMainContext *context;
1222 g_return_if_fail (source != NULL);
1224 context = source->context;
1226 if (context)
1227 g_source_destroy_internal (source, context, FALSE);
1228 else
1229 source->flags &= ~G_HOOK_FLAG_ACTIVE;
1233 * g_source_get_id:
1234 * @source: a #GSource
1236 * Returns the numeric ID for a particular source. The ID of a source
1237 * is a positive integer which is unique within a particular main loop
1238 * context. The reverse
1239 * mapping from ID to source is done by g_main_context_find_source_by_id().
1241 * Returns: the ID (greater than 0) for the source
1243 guint
1244 g_source_get_id (GSource *source)
1246 guint result;
1248 g_return_val_if_fail (source != NULL, 0);
1249 g_return_val_if_fail (source->context != NULL, 0);
1251 LOCK_CONTEXT (source->context);
1252 result = source->source_id;
1253 UNLOCK_CONTEXT (source->context);
1255 return result;
1259 * g_source_get_context:
1260 * @source: a #GSource
1262 * Gets the #GMainContext with which the source is associated.
1264 * You can call this on a source that has been destroyed, provided
1265 * that the #GMainContext it was attached to still exists (in which
1266 * case it will return that #GMainContext). In particular, you can
1267 * always call this function on the source returned from
1268 * g_main_current_source(). But calling this function on a source
1269 * whose #GMainContext has been destroyed is an error.
1271 * Returns: (transfer none) (allow-none): the #GMainContext with which the
1272 * source is associated, or %NULL if the context has not
1273 * yet been added to a source.
1275 GMainContext *
1276 g_source_get_context (GSource *source)
1278 g_return_val_if_fail (source->context != NULL || !SOURCE_DESTROYED (source), NULL);
1280 return source->context;
1284 * g_source_add_poll:
1285 * @source:a #GSource
1286 * @fd: a #GPollFD structure holding information about a file
1287 * descriptor to watch.
1289 * Adds a file descriptor to the set of file descriptors polled for
1290 * this source. This is usually combined with g_source_new() to add an
1291 * event source. The event source's check function will typically test
1292 * the @revents field in the #GPollFD struct and return %TRUE if events need
1293 * to be processed.
1295 * This API is only intended to be used by implementations of #GSource.
1296 * Do not call this API on a #GSource that you did not create.
1298 * Using this API forces the linear scanning of event sources on each
1299 * main loop iteration. Newly-written event sources should try to use
1300 * g_source_add_unix_fd() instead of this API.
1302 void
1303 g_source_add_poll (GSource *source,
1304 GPollFD *fd)
1306 GMainContext *context;
1308 g_return_if_fail (source != NULL);
1309 g_return_if_fail (fd != NULL);
1310 g_return_if_fail (!SOURCE_DESTROYED (source));
1312 context = source->context;
1314 if (context)
1315 LOCK_CONTEXT (context);
1317 source->poll_fds = g_slist_prepend (source->poll_fds, fd);
1319 if (context)
1321 if (!SOURCE_BLOCKED (source))
1322 g_main_context_add_poll_unlocked (context, source->priority, fd);
1323 UNLOCK_CONTEXT (context);
1328 * g_source_remove_poll:
1329 * @source:a #GSource
1330 * @fd: a #GPollFD structure previously passed to g_source_add_poll().
1332 * Removes a file descriptor from the set of file descriptors polled for
1333 * this source.
1335 * This API is only intended to be used by implementations of #GSource.
1336 * Do not call this API on a #GSource that you did not create.
1338 void
1339 g_source_remove_poll (GSource *source,
1340 GPollFD *fd)
1342 GMainContext *context;
1344 g_return_if_fail (source != NULL);
1345 g_return_if_fail (fd != NULL);
1346 g_return_if_fail (!SOURCE_DESTROYED (source));
1348 context = source->context;
1350 if (context)
1351 LOCK_CONTEXT (context);
1353 source->poll_fds = g_slist_remove (source->poll_fds, fd);
1355 if (context)
1357 if (!SOURCE_BLOCKED (source))
1358 g_main_context_remove_poll_unlocked (context, fd);
1359 UNLOCK_CONTEXT (context);
1364 * g_source_add_child_source:
1365 * @source:a #GSource
1366 * @child_source: a second #GSource that @source should "poll"
1368 * Adds @child_source to @source as a "polled" source; when @source is
1369 * added to a #GMainContext, @child_source will be automatically added
1370 * with the same priority, when @child_source is triggered, it will
1371 * cause @source to dispatch (in addition to calling its own
1372 * callback), and when @source is destroyed, it will destroy
1373 * @child_source as well. (@source will also still be dispatched if
1374 * its own prepare/check functions indicate that it is ready.)
1376 * If you don't need @child_source to do anything on its own when it
1377 * triggers, you can call g_source_set_dummy_callback() on it to set a
1378 * callback that does nothing (except return %TRUE if appropriate).
1380 * @source will hold a reference on @child_source while @child_source
1381 * is attached to it.
1383 * This API is only intended to be used by implementations of #GSource.
1384 * Do not call this API on a #GSource that you did not create.
1386 * Since: 2.28
1388 void
1389 g_source_add_child_source (GSource *source,
1390 GSource *child_source)
1392 GMainContext *context;
1394 g_return_if_fail (source != NULL);
1395 g_return_if_fail (child_source != NULL);
1396 g_return_if_fail (!SOURCE_DESTROYED (source));
1397 g_return_if_fail (!SOURCE_DESTROYED (child_source));
1398 g_return_if_fail (child_source->context == NULL);
1399 g_return_if_fail (child_source->priv->parent_source == NULL);
1401 context = source->context;
1403 if (context)
1404 LOCK_CONTEXT (context);
1406 source->priv->child_sources = g_slist_prepend (source->priv->child_sources,
1407 g_source_ref (child_source));
1408 child_source->priv->parent_source = source;
1409 g_source_set_priority_unlocked (child_source, NULL, source->priority);
1410 if (SOURCE_BLOCKED (source))
1411 block_source (child_source);
1413 if (context)
1415 g_source_attach_unlocked (child_source, context, TRUE);
1416 UNLOCK_CONTEXT (context);
1420 static void
1421 g_child_source_remove_internal (GSource *child_source,
1422 GMainContext *context)
1424 GSource *parent_source = child_source->priv->parent_source;
1426 parent_source->priv->child_sources =
1427 g_slist_remove (parent_source->priv->child_sources, child_source);
1428 child_source->priv->parent_source = NULL;
1430 g_source_destroy_internal (child_source, context, TRUE);
1431 g_source_unref_internal (child_source, context, TRUE);
1435 * g_source_remove_child_source:
1436 * @source:a #GSource
1437 * @child_source: a #GSource previously passed to
1438 * g_source_add_child_source().
1440 * Detaches @child_source from @source and destroys it.
1442 * This API is only intended to be used by implementations of #GSource.
1443 * Do not call this API on a #GSource that you did not create.
1445 * Since: 2.28
1447 void
1448 g_source_remove_child_source (GSource *source,
1449 GSource *child_source)
1451 GMainContext *context;
1453 g_return_if_fail (source != NULL);
1454 g_return_if_fail (child_source != NULL);
1455 g_return_if_fail (child_source->priv->parent_source == source);
1456 g_return_if_fail (!SOURCE_DESTROYED (source));
1457 g_return_if_fail (!SOURCE_DESTROYED (child_source));
1459 context = source->context;
1461 if (context)
1462 LOCK_CONTEXT (context);
1464 g_child_source_remove_internal (child_source, context);
1466 if (context)
1467 UNLOCK_CONTEXT (context);
1471 * g_source_set_callback_indirect:
1472 * @source: the source
1473 * @callback_data: pointer to callback data "object"
1474 * @callback_funcs: functions for reference counting @callback_data
1475 * and getting the callback and data
1477 * Sets the callback function storing the data as a refcounted callback
1478 * "object". This is used internally. Note that calling
1479 * g_source_set_callback_indirect() assumes
1480 * an initial reference count on @callback_data, and thus
1481 * @callback_funcs->unref will eventually be called once more
1482 * than @callback_funcs->ref.
1484 void
1485 g_source_set_callback_indirect (GSource *source,
1486 gpointer callback_data,
1487 GSourceCallbackFuncs *callback_funcs)
1489 GMainContext *context;
1490 gpointer old_cb_data;
1491 GSourceCallbackFuncs *old_cb_funcs;
1493 g_return_if_fail (source != NULL);
1494 g_return_if_fail (callback_funcs != NULL || callback_data == NULL);
1496 context = source->context;
1498 if (context)
1499 LOCK_CONTEXT (context);
1501 old_cb_data = source->callback_data;
1502 old_cb_funcs = source->callback_funcs;
1504 source->callback_data = callback_data;
1505 source->callback_funcs = callback_funcs;
1507 if (context)
1508 UNLOCK_CONTEXT (context);
1510 if (old_cb_funcs)
1511 old_cb_funcs->unref (old_cb_data);
1514 static void
1515 g_source_callback_ref (gpointer cb_data)
1517 GSourceCallback *callback = cb_data;
1519 callback->ref_count++;
1523 static void
1524 g_source_callback_unref (gpointer cb_data)
1526 GSourceCallback *callback = cb_data;
1528 callback->ref_count--;
1529 if (callback->ref_count == 0)
1531 if (callback->notify)
1532 callback->notify (callback->data);
1533 g_free (callback);
1537 static void
1538 g_source_callback_get (gpointer cb_data,
1539 GSource *source,
1540 GSourceFunc *func,
1541 gpointer *data)
1543 GSourceCallback *callback = cb_data;
1545 *func = callback->func;
1546 *data = callback->data;
1549 static GSourceCallbackFuncs g_source_callback_funcs = {
1550 g_source_callback_ref,
1551 g_source_callback_unref,
1552 g_source_callback_get,
1556 * g_source_set_callback:
1557 * @source: the source
1558 * @func: a callback function
1559 * @data: the data to pass to callback function
1560 * @notify: (allow-none): a function to call when @data is no longer in use, or %NULL.
1562 * Sets the callback function for a source. The callback for a source is
1563 * called from the source's dispatch function.
1565 * The exact type of @func depends on the type of source; ie. you
1566 * should not count on @func being called with @data as its first
1567 * parameter.
1569 * Typically, you won't use this function. Instead use functions specific
1570 * to the type of source you are using.
1572 void
1573 g_source_set_callback (GSource *source,
1574 GSourceFunc func,
1575 gpointer data,
1576 GDestroyNotify notify)
1578 GSourceCallback *new_callback;
1580 g_return_if_fail (source != NULL);
1582 new_callback = g_new (GSourceCallback, 1);
1584 new_callback->ref_count = 1;
1585 new_callback->func = func;
1586 new_callback->data = data;
1587 new_callback->notify = notify;
1589 g_source_set_callback_indirect (source, new_callback, &g_source_callback_funcs);
1594 * g_source_set_funcs:
1595 * @source: a #GSource
1596 * @funcs: the new #GSourceFuncs
1598 * Sets the source functions (can be used to override
1599 * default implementations) of an unattached source.
1601 * Since: 2.12
1603 void
1604 g_source_set_funcs (GSource *source,
1605 GSourceFuncs *funcs)
1607 g_return_if_fail (source != NULL);
1608 g_return_if_fail (source->context == NULL);
1609 g_return_if_fail (source->ref_count > 0);
1610 g_return_if_fail (funcs != NULL);
1612 source->source_funcs = funcs;
1615 static void
1616 g_source_set_priority_unlocked (GSource *source,
1617 GMainContext *context,
1618 gint priority)
1620 GSList *tmp_list;
1622 g_return_if_fail (source->priv->parent_source == NULL ||
1623 source->priv->parent_source->priority == priority);
1625 if (context)
1627 /* Remove the source from the context's source and then
1628 * add it back after so it is sorted in the correct place
1630 source_remove_from_context (source, source->context);
1633 source->priority = priority;
1635 if (context)
1637 source_add_to_context (source, source->context);
1639 if (!SOURCE_BLOCKED (source))
1641 tmp_list = source->poll_fds;
1642 while (tmp_list)
1644 g_main_context_remove_poll_unlocked (context, tmp_list->data);
1645 g_main_context_add_poll_unlocked (context, priority, tmp_list->data);
1647 tmp_list = tmp_list->next;
1650 for (tmp_list = source->priv->fds; tmp_list; tmp_list = tmp_list->next)
1652 g_main_context_remove_poll_unlocked (context, tmp_list->data);
1653 g_main_context_add_poll_unlocked (context, priority, tmp_list->data);
1658 if (source->priv->child_sources)
1660 tmp_list = source->priv->child_sources;
1661 while (tmp_list)
1663 g_source_set_priority_unlocked (tmp_list->data, context, priority);
1664 tmp_list = tmp_list->next;
1670 * g_source_set_priority:
1671 * @source: a #GSource
1672 * @priority: the new priority.
1674 * Sets the priority of a source. While the main loop is being run, a
1675 * source will be dispatched if it is ready to be dispatched and no
1676 * sources at a higher (numerically smaller) priority are ready to be
1677 * dispatched.
1679 * A child source always has the same priority as its parent. It is not
1680 * permitted to change the priority of a source once it has been added
1681 * as a child of another source.
1683 void
1684 g_source_set_priority (GSource *source,
1685 gint priority)
1687 GMainContext *context;
1689 g_return_if_fail (source != NULL);
1690 g_return_if_fail (source->priv->parent_source == NULL);
1692 context = source->context;
1694 if (context)
1695 LOCK_CONTEXT (context);
1696 g_source_set_priority_unlocked (source, context, priority);
1697 if (context)
1698 UNLOCK_CONTEXT (source->context);
1702 * g_source_get_priority:
1703 * @source: a #GSource
1705 * Gets the priority of a source.
1707 * Returns: the priority of the source
1709 gint
1710 g_source_get_priority (GSource *source)
1712 g_return_val_if_fail (source != NULL, 0);
1714 return source->priority;
1718 * g_source_set_ready_time:
1719 * @source: a #GSource
1720 * @ready_time: the monotonic time at which the source will be ready,
1721 * 0 for "immediately", -1 for "never"
1723 * Sets a #GSource to be dispatched when the given monotonic time is
1724 * reached (or passed). If the monotonic time is in the past (as it
1725 * always will be if @ready_time is 0) then the source will be
1726 * dispatched immediately.
1728 * If @ready_time is -1 then the source is never woken up on the basis
1729 * of the passage of time.
1731 * Dispatching the source does not reset the ready time. You should do
1732 * so yourself, from the source dispatch function.
1734 * Note that if you have a pair of sources where the ready time of one
1735 * suggests that it will be delivered first but the priority for the
1736 * other suggests that it would be delivered first, and the ready time
1737 * for both sources is reached during the same main context iteration
1738 * then the order of dispatch is undefined.
1740 * This API is only intended to be used by implementations of #GSource.
1741 * Do not call this API on a #GSource that you did not create.
1743 * Since: 2.36
1745 void
1746 g_source_set_ready_time (GSource *source,
1747 gint64 ready_time)
1749 GMainContext *context;
1751 g_return_if_fail (source != NULL);
1752 g_return_if_fail (source->ref_count > 0);
1754 if (source->priv->ready_time == ready_time)
1755 return;
1757 context = source->context;
1759 if (context)
1760 LOCK_CONTEXT (context);
1762 source->priv->ready_time = ready_time;
1764 if (context)
1766 /* Quite likely that we need to change the timeout on the poll */
1767 if (!SOURCE_BLOCKED (source))
1768 g_wakeup_signal (context->wakeup);
1769 UNLOCK_CONTEXT (context);
1774 * g_source_get_ready_time:
1775 * @source: a #GSource
1777 * Gets the "ready time" of @source, as set by
1778 * g_source_set_ready_time().
1780 * Any time before the current monotonic time (including 0) is an
1781 * indication that the source will fire immediately.
1783 * Returns: the monotonic ready time, -1 for "never"
1785 gint64
1786 g_source_get_ready_time (GSource *source)
1788 g_return_val_if_fail (source != NULL, -1);
1790 return source->priv->ready_time;
1794 * g_source_set_can_recurse:
1795 * @source: a #GSource
1796 * @can_recurse: whether recursion is allowed for this source
1798 * Sets whether a source can be called recursively. If @can_recurse is
1799 * %TRUE, then while the source is being dispatched then this source
1800 * will be processed normally. Otherwise, all processing of this
1801 * source is blocked until the dispatch function returns.
1803 void
1804 g_source_set_can_recurse (GSource *source,
1805 gboolean can_recurse)
1807 GMainContext *context;
1809 g_return_if_fail (source != NULL);
1811 context = source->context;
1813 if (context)
1814 LOCK_CONTEXT (context);
1816 if (can_recurse)
1817 source->flags |= G_SOURCE_CAN_RECURSE;
1818 else
1819 source->flags &= ~G_SOURCE_CAN_RECURSE;
1821 if (context)
1822 UNLOCK_CONTEXT (context);
1826 * g_source_get_can_recurse:
1827 * @source: a #GSource
1829 * Checks whether a source is allowed to be called recursively.
1830 * see g_source_set_can_recurse().
1832 * Returns: whether recursion is allowed.
1834 gboolean
1835 g_source_get_can_recurse (GSource *source)
1837 g_return_val_if_fail (source != NULL, FALSE);
1839 return (source->flags & G_SOURCE_CAN_RECURSE) != 0;
1844 * g_source_set_name:
1845 * @source: a #GSource
1846 * @name: debug name for the source
1848 * Sets a name for the source, used in debugging and profiling.
1849 * The name defaults to #NULL.
1851 * The source name should describe in a human-readable way
1852 * what the source does. For example, "X11 event queue"
1853 * or "GTK+ repaint idle handler" or whatever it is.
1855 * It is permitted to call this function multiple times, but is not
1856 * recommended due to the potential performance impact. For example,
1857 * one could change the name in the "check" function of a #GSourceFuncs
1858 * to include details like the event type in the source name.
1860 * Since: 2.26
1862 void
1863 g_source_set_name (GSource *source,
1864 const char *name)
1866 g_return_if_fail (source != NULL);
1868 /* setting back to NULL is allowed, just because it's
1869 * weird if get_name can return NULL but you can't
1870 * set that.
1873 g_free (source->name);
1874 source->name = g_strdup (name);
1878 * g_source_get_name:
1879 * @source: a #GSource
1881 * Gets a name for the source, used in debugging and profiling.
1882 * The name may be #NULL if it has never been set with
1883 * g_source_set_name().
1885 * Returns: the name of the source
1886 * Since: 2.26
1888 const char *
1889 g_source_get_name (GSource *source)
1891 g_return_val_if_fail (source != NULL, NULL);
1893 return source->name;
1897 * g_source_set_name_by_id:
1898 * @tag: a #GSource ID
1899 * @name: debug name for the source
1901 * Sets the name of a source using its ID.
1903 * This is a convenience utility to set source names from the return
1904 * value of g_idle_add(), g_timeout_add(), etc.
1906 * Since: 2.26
1908 void
1909 g_source_set_name_by_id (guint tag,
1910 const char *name)
1912 GSource *source;
1914 g_return_if_fail (tag > 0);
1916 source = g_main_context_find_source_by_id (NULL, tag);
1917 if (source == NULL)
1918 return;
1920 g_source_set_name (source, name);
1925 * g_source_ref:
1926 * @source: a #GSource
1928 * Increases the reference count on a source by one.
1930 * Returns: @source
1932 GSource *
1933 g_source_ref (GSource *source)
1935 GMainContext *context;
1937 g_return_val_if_fail (source != NULL, NULL);
1939 context = source->context;
1941 if (context)
1942 LOCK_CONTEXT (context);
1944 source->ref_count++;
1946 if (context)
1947 UNLOCK_CONTEXT (context);
1949 return source;
1952 /* g_source_unref() but possible to call within context lock
1954 static void
1955 g_source_unref_internal (GSource *source,
1956 GMainContext *context,
1957 gboolean have_lock)
1959 gpointer old_cb_data = NULL;
1960 GSourceCallbackFuncs *old_cb_funcs = NULL;
1962 g_return_if_fail (source != NULL);
1964 if (!have_lock && context)
1965 LOCK_CONTEXT (context);
1967 source->ref_count--;
1968 if (source->ref_count == 0)
1970 old_cb_data = source->callback_data;
1971 old_cb_funcs = source->callback_funcs;
1973 source->callback_data = NULL;
1974 source->callback_funcs = NULL;
1976 if (context)
1978 if (!SOURCE_DESTROYED (source))
1979 g_warning (G_STRLOC ": ref_count == 0, but source was still attached to a context!");
1980 source_remove_from_context (source, context);
1982 g_hash_table_remove (context->sources, GUINT_TO_POINTER (source->source_id));
1985 if (source->source_funcs->finalize)
1987 if (context)
1988 UNLOCK_CONTEXT (context);
1989 source->source_funcs->finalize (source);
1990 if (context)
1991 LOCK_CONTEXT (context);
1994 g_free (source->name);
1995 source->name = NULL;
1997 g_slist_free (source->poll_fds);
1998 source->poll_fds = NULL;
2000 g_slist_free_full (source->priv->fds, g_free);
2002 g_slice_free (GSourcePrivate, source->priv);
2003 source->priv = NULL;
2005 g_free (source);
2008 if (!have_lock && context)
2009 UNLOCK_CONTEXT (context);
2011 if (old_cb_funcs)
2013 if (have_lock)
2014 UNLOCK_CONTEXT (context);
2016 old_cb_funcs->unref (old_cb_data);
2018 if (have_lock)
2019 LOCK_CONTEXT (context);
2024 * g_source_unref:
2025 * @source: a #GSource
2027 * Decreases the reference count of a source by one. If the
2028 * resulting reference count is zero the source and associated
2029 * memory will be destroyed.
2031 void
2032 g_source_unref (GSource *source)
2034 g_return_if_fail (source != NULL);
2036 g_source_unref_internal (source, source->context, FALSE);
2040 * g_main_context_find_source_by_id:
2041 * @context: (allow-none): a #GMainContext (if %NULL, the default context will be used)
2042 * @source_id: the source ID, as returned by g_source_get_id().
2044 * Finds a #GSource given a pair of context and ID.
2046 * Returns: (transfer none): the #GSource if found, otherwise, %NULL
2048 GSource *
2049 g_main_context_find_source_by_id (GMainContext *context,
2050 guint source_id)
2052 GSource *source;
2054 g_return_val_if_fail (source_id > 0, NULL);
2056 if (context == NULL)
2057 context = g_main_context_default ();
2059 LOCK_CONTEXT (context);
2060 source = g_hash_table_lookup (context->sources, GUINT_TO_POINTER (source_id));
2061 UNLOCK_CONTEXT (context);
2063 if (source && SOURCE_DESTROYED (source))
2064 source = NULL;
2066 return source;
2070 * g_main_context_find_source_by_funcs_user_data:
2071 * @context: (allow-none): a #GMainContext (if %NULL, the default context will be used).
2072 * @funcs: the @source_funcs passed to g_source_new().
2073 * @user_data: the user data from the callback.
2075 * Finds a source with the given source functions and user data. If
2076 * multiple sources exist with the same source function and user data,
2077 * the first one found will be returned.
2079 * Returns: (transfer none): the source, if one was found, otherwise %NULL
2081 GSource *
2082 g_main_context_find_source_by_funcs_user_data (GMainContext *context,
2083 GSourceFuncs *funcs,
2084 gpointer user_data)
2086 GSourceIter iter;
2087 GSource *source;
2089 g_return_val_if_fail (funcs != NULL, NULL);
2091 if (context == NULL)
2092 context = g_main_context_default ();
2094 LOCK_CONTEXT (context);
2096 g_source_iter_init (&iter, context, FALSE);
2097 while (g_source_iter_next (&iter, &source))
2099 if (!SOURCE_DESTROYED (source) &&
2100 source->source_funcs == funcs &&
2101 source->callback_funcs)
2103 GSourceFunc callback;
2104 gpointer callback_data;
2106 source->callback_funcs->get (source->callback_data, source, &callback, &callback_data);
2108 if (callback_data == user_data)
2109 break;
2112 g_source_iter_clear (&iter);
2114 UNLOCK_CONTEXT (context);
2116 return source;
2120 * g_main_context_find_source_by_user_data:
2121 * @context: a #GMainContext
2122 * @user_data: the user_data for the callback.
2124 * Finds a source with the given user data for the callback. If
2125 * multiple sources exist with the same user data, the first
2126 * one found will be returned.
2128 * Returns: (transfer none): the source, if one was found, otherwise %NULL
2130 GSource *
2131 g_main_context_find_source_by_user_data (GMainContext *context,
2132 gpointer user_data)
2134 GSourceIter iter;
2135 GSource *source;
2137 if (context == NULL)
2138 context = g_main_context_default ();
2140 LOCK_CONTEXT (context);
2142 g_source_iter_init (&iter, context, FALSE);
2143 while (g_source_iter_next (&iter, &source))
2145 if (!SOURCE_DESTROYED (source) &&
2146 source->callback_funcs)
2148 GSourceFunc callback;
2149 gpointer callback_data = NULL;
2151 source->callback_funcs->get (source->callback_data, source, &callback, &callback_data);
2153 if (callback_data == user_data)
2154 break;
2157 g_source_iter_clear (&iter);
2159 UNLOCK_CONTEXT (context);
2161 return source;
2165 * g_source_remove:
2166 * @tag: the ID of the source to remove.
2168 * Removes the source with the given id from the default main context.
2170 * The id of a #GSource is given by g_source_get_id(), or will be
2171 * returned by the functions g_source_attach(), g_idle_add(),
2172 * g_idle_add_full(), g_timeout_add(), g_timeout_add_full(),
2173 * g_child_watch_add(), g_child_watch_add_full(), g_io_add_watch(), and
2174 * g_io_add_watch_full().
2176 * See also g_source_destroy(). You must use g_source_destroy() for sources
2177 * added to a non-default main context.
2179 * It is a programmer error to attempt to remove a non-existent source.
2181 * Returns: For historical reasons, this function always returns %TRUE
2183 gboolean
2184 g_source_remove (guint tag)
2186 GSource *source;
2188 g_return_val_if_fail (tag > 0, FALSE);
2190 source = g_main_context_find_source_by_id (NULL, tag);
2191 if (source)
2192 g_source_destroy (source);
2193 else
2194 g_critical ("Source ID %u was not found when attempting to remove it", tag);
2196 return source != NULL;
2200 * g_source_remove_by_user_data:
2201 * @user_data: the user_data for the callback.
2203 * Removes a source from the default main loop context given the user
2204 * data for the callback. If multiple sources exist with the same user
2205 * data, only one will be destroyed.
2207 * Returns: %TRUE if a source was found and removed.
2209 gboolean
2210 g_source_remove_by_user_data (gpointer user_data)
2212 GSource *source;
2214 source = g_main_context_find_source_by_user_data (NULL, user_data);
2215 if (source)
2217 g_source_destroy (source);
2218 return TRUE;
2220 else
2221 return FALSE;
2225 * g_source_remove_by_funcs_user_data:
2226 * @funcs: The @source_funcs passed to g_source_new()
2227 * @user_data: the user data for the callback
2229 * Removes a source from the default main loop context given the
2230 * source functions and user data. If multiple sources exist with the
2231 * same source functions and user data, only one will be destroyed.
2233 * Returns: %TRUE if a source was found and removed.
2235 gboolean
2236 g_source_remove_by_funcs_user_data (GSourceFuncs *funcs,
2237 gpointer user_data)
2239 GSource *source;
2241 g_return_val_if_fail (funcs != NULL, FALSE);
2243 source = g_main_context_find_source_by_funcs_user_data (NULL, funcs, user_data);
2244 if (source)
2246 g_source_destroy (source);
2247 return TRUE;
2249 else
2250 return FALSE;
2253 #ifdef G_OS_UNIX
2255 * g_source_add_unix_fd:
2256 * @source: a #GSource
2257 * @fd: the fd to monitor
2258 * @events: an event mask
2260 * Monitors @fd for the IO events in @events.
2262 * The tag returned by this function can be used to remove or modify the
2263 * monitoring of the fd using g_source_remove_unix_fd() or
2264 * g_source_modify_unix_fd().
2266 * It is not necessary to remove the fd before destroying the source; it
2267 * will be cleaned up automatically.
2269 * This API is only intended to be used by implementations of #GSource.
2270 * Do not call this API on a #GSource that you did not create.
2272 * As the name suggests, this function is not available on Windows.
2274 * Returns: an opaque tag
2276 * Since: 2.36
2278 gpointer
2279 g_source_add_unix_fd (GSource *source,
2280 gint fd,
2281 GIOCondition events)
2283 GMainContext *context;
2284 GPollFD *poll_fd;
2286 g_return_val_if_fail (source != NULL, NULL);
2287 g_return_val_if_fail (!SOURCE_DESTROYED (source), NULL);
2289 poll_fd = g_new (GPollFD, 1);
2290 poll_fd->fd = fd;
2291 poll_fd->events = events;
2292 poll_fd->revents = 0;
2294 context = source->context;
2296 if (context)
2297 LOCK_CONTEXT (context);
2299 source->priv->fds = g_slist_prepend (source->priv->fds, poll_fd);
2301 if (context)
2303 if (!SOURCE_BLOCKED (source))
2304 g_main_context_add_poll_unlocked (context, source->priority, poll_fd);
2305 UNLOCK_CONTEXT (context);
2308 return poll_fd;
2312 * g_source_modify_unix_fd:
2313 * @source: a #GSource
2314 * @tag: the tag from g_source_add_unix_fd()
2315 * @new_events: the new event mask to watch
2317 * Updates the event mask to watch for the fd identified by @tag.
2319 * @tag is the tag returned from g_source_add_unix_fd().
2321 * If you want to remove a fd, don't set its event mask to zero.
2322 * Instead, call g_source_remove_unix_fd().
2324 * This API is only intended to be used by implementations of #GSource.
2325 * Do not call this API on a #GSource that you did not create.
2327 * As the name suggests, this function is not available on Windows.
2329 * Since: 2.36
2331 void
2332 g_source_modify_unix_fd (GSource *source,
2333 gpointer tag,
2334 GIOCondition new_events)
2336 GMainContext *context;
2337 GPollFD *poll_fd;
2339 g_return_if_fail (source != NULL);
2340 g_return_if_fail (g_slist_find (source->priv->fds, tag));
2342 context = source->context;
2343 poll_fd = tag;
2345 poll_fd->events = new_events;
2347 if (context)
2348 g_main_context_wakeup (context);
2352 * g_source_remove_unix_fd:
2353 * @source: a #GSource
2354 * @tag: the tag from g_source_add_unix_fd()
2356 * Reverses the effect of a previous call to g_source_add_unix_fd().
2358 * You only need to call this if you want to remove an fd from being
2359 * watched while keeping the same source around. In the normal case you
2360 * will just want to destroy the source.
2362 * This API is only intended to be used by implementations of #GSource.
2363 * Do not call this API on a #GSource that you did not create.
2365 * As the name suggests, this function is not available on Windows.
2367 * Since: 2.36
2369 void
2370 g_source_remove_unix_fd (GSource *source,
2371 gpointer tag)
2373 GMainContext *context;
2374 GPollFD *poll_fd;
2376 g_return_if_fail (source != NULL);
2377 g_return_if_fail (g_slist_find (source->priv->fds, tag));
2379 context = source->context;
2380 poll_fd = tag;
2382 if (context)
2383 LOCK_CONTEXT (context);
2385 source->priv->fds = g_slist_remove (source->priv->fds, poll_fd);
2387 if (context)
2389 if (!SOURCE_BLOCKED (source))
2390 g_main_context_remove_poll_unlocked (context, poll_fd);
2392 UNLOCK_CONTEXT (context);
2395 g_free (poll_fd);
2399 * g_source_query_unix_fd:
2400 * @source: a #GSource
2401 * @tag: the tag from g_source_add_unix_fd()
2403 * Queries the events reported for the fd corresponding to @tag on
2404 * @source during the last poll.
2406 * The return value of this function is only defined when the function
2407 * is called from the check or dispatch functions for @source.
2409 * This API is only intended to be used by implementations of #GSource.
2410 * Do not call this API on a #GSource that you did not create.
2412 * As the name suggests, this function is not available on Windows.
2414 * Returns: the conditions reported on the fd
2416 * Since: 2.36
2418 GIOCondition
2419 g_source_query_unix_fd (GSource *source,
2420 gpointer tag)
2422 GPollFD *poll_fd;
2424 g_return_val_if_fail (source != NULL, 0);
2425 g_return_val_if_fail (g_slist_find (source->priv->fds, tag), 0);
2427 poll_fd = tag;
2429 return poll_fd->revents;
2431 #endif /* G_OS_UNIX */
2434 * g_get_current_time:
2435 * @result: #GTimeVal structure in which to store current time.
2437 * Equivalent to the UNIX gettimeofday() function, but portable.
2439 * You may find g_get_real_time() to be more convenient.
2441 void
2442 g_get_current_time (GTimeVal *result)
2444 #ifndef G_OS_WIN32
2445 struct timeval r;
2447 g_return_if_fail (result != NULL);
2449 /*this is required on alpha, there the timeval structs are int's
2450 not longs and a cast only would fail horribly*/
2451 gettimeofday (&r, NULL);
2452 result->tv_sec = r.tv_sec;
2453 result->tv_usec = r.tv_usec;
2454 #else
2455 FILETIME ft;
2456 guint64 time64;
2458 g_return_if_fail (result != NULL);
2460 GetSystemTimeAsFileTime (&ft);
2461 memmove (&time64, &ft, sizeof (FILETIME));
2463 /* Convert from 100s of nanoseconds since 1601-01-01
2464 * to Unix epoch. Yes, this is Y2038 unsafe.
2466 time64 -= G_GINT64_CONSTANT (116444736000000000);
2467 time64 /= 10;
2469 result->tv_sec = time64 / 1000000;
2470 result->tv_usec = time64 % 1000000;
2471 #endif
2475 * g_get_real_time:
2477 * Queries the system wall-clock time.
2479 * This call is functionally equivalent to g_get_current_time() except
2480 * that the return value is often more convenient than dealing with a
2481 * #GTimeVal.
2483 * You should only use this call if you are actually interested in the real
2484 * wall-clock time. g_get_monotonic_time() is probably more useful for
2485 * measuring intervals.
2487 * Returns: the number of microseconds since January 1, 1970 UTC.
2489 * Since: 2.28
2491 gint64
2492 g_get_real_time (void)
2494 GTimeVal tv;
2496 g_get_current_time (&tv);
2498 return (((gint64) tv.tv_sec) * 1000000) + tv.tv_usec;
2502 * g_get_monotonic_time:
2504 * Queries the system monotonic time.
2506 * The monotonic clock will always increase and doesn't suffer
2507 * discontinuities when the user (or NTP) changes the system time. It
2508 * may or may not continue to tick during times where the machine is
2509 * suspended.
2511 * We try to use the clock that corresponds as closely as possible to
2512 * the passage of time as measured by system calls such as poll() but it
2513 * may not always be possible to do this.
2515 * Returns: the monotonic time, in microseconds
2517 * Since: 2.28
2519 #if defined (G_OS_WIN32)
2520 static ULONGLONG (*g_GetTickCount64) (void) = NULL;
2521 static guint32 g_win32_tick_epoch = 0;
2523 void
2524 g_clock_win32_init (void)
2526 HMODULE kernel32;
2528 g_GetTickCount64 = NULL;
2529 kernel32 = GetModuleHandle ("KERNEL32.DLL");
2530 if (kernel32 != NULL)
2531 g_GetTickCount64 = (void *) GetProcAddress (kernel32, "GetTickCount64");
2532 g_win32_tick_epoch = ((guint32)GetTickCount()) >> 31;
2535 gint64
2536 g_get_monotonic_time (void)
2538 guint64 ticks;
2539 guint32 ticks32;
2541 /* There are four sources for the monotonic time on Windows:
2543 * Three are based on a (1 msec accuracy, but only read periodically) clock chip:
2544 * - GetTickCount (GTC)
2545 * 32bit msec counter, updated each ~15msec, wraps in ~50 days
2546 * - GetTickCount64 (GTC64)
2547 * Same as GetTickCount, but extended to 64bit, so no wrap
2548 * Only available in Vista or later
2549 * - timeGetTime (TGT)
2550 * similar to GetTickCount by default: 15msec, 50 day wrap.
2551 * available in winmm.dll (thus known as the multimedia timers)
2552 * However apps can raise the system timer clock frequency using timeBeginPeriod()
2553 * increasing the accuracy up to 1 msec, at a cost in general system performance
2554 * and battery use.
2556 * One is based on high precision clocks:
2557 * - QueryPrecisionCounter (QPC)
2558 * This has much higher accuracy, but is not guaranteed monotonic, and
2559 * has lots of complications like clock jumps and different times on different
2560 * CPUs. It also has lower long term accuracy (i.e. it will drift compared to
2561 * the low precision clocks.
2563 * Additionally, the precision available in the timer-based wakeup such as
2564 * MsgWaitForMultipleObjectsEx (which is what the mainloop is based on) is based
2565 * on the TGT resolution, so by default it is ~15msec, but can be increased by apps.
2567 * The QPC timer has too many issues to be used as is. The only way it could be used
2568 * is to use it to interpolate the lower precision clocks. Firefox does something like
2569 * this:
2570 * https://bugzilla.mozilla.org/show_bug.cgi?id=363258
2572 * However this seems quite complicated, so we're not doing this right now.
2574 * The approach we take instead is to use the TGT timer, extending it to 64bit
2575 * either by using the GTC64 value, or if that is not available, a process local
2576 * time epoch that we increment when we detect a timer wrap (assumes that we read
2577 * the time at least once every 50 days).
2579 * This means that:
2580 * - We have a globally consistent monotonic clock on Vista and later
2581 * - We have a locally monotonic clock on XP
2582 * - Apps that need higher precision in timeouts and clock reads can call
2583 * timeBeginPeriod() to increase it as much as they want
2586 if (g_GetTickCount64 != NULL)
2588 guint32 ticks_as_32bit;
2590 ticks = g_GetTickCount64 ();
2591 ticks32 = timeGetTime();
2593 /* GTC64 and TGT are sampled at different times, however they
2594 * have the same base and source (msecs since system boot).
2595 * They can differ by as much as -16 to +16 msecs.
2596 * We can't just inject the low bits into the 64bit counter
2597 * as one of the counters can have wrapped in 32bit space and
2598 * the other not. Instead we calculate the signed difference
2599 * in 32bit space and apply that difference to the 64bit counter.
2601 ticks_as_32bit = (guint32)ticks;
2603 /* We could do some 2's complement hack, but we play it safe */
2604 if (ticks32 - ticks_as_32bit <= G_MAXINT32)
2605 ticks += ticks32 - ticks_as_32bit;
2606 else
2607 ticks -= ticks_as_32bit - ticks32;
2609 else
2611 guint32 epoch;
2613 epoch = g_atomic_int_get (&g_win32_tick_epoch);
2615 /* Must read ticks after the epoch. Then we're guaranteed
2616 * that the ticks value we read is higher or equal to any
2617 * previous ones that lead to the writing of the epoch.
2619 ticks32 = timeGetTime();
2621 /* We store the MSB of the current time as the LSB
2622 * of the epoch. Comparing these bits lets us detect when
2623 * the 32bit counter has wrapped so we can increase the
2624 * epoch.
2626 * This will work as long as this function is called at
2627 * least once every ~24 days, which is half the wrap time
2628 * of a 32bit msec counter. I think this is pretty likely.
2630 * Note that g_win32_tick_epoch is a process local state,
2631 * so the monotonic clock will not be the same between
2632 * processes.
2634 if ((ticks32 >> 31) != (epoch & 1))
2636 epoch++;
2637 g_atomic_int_set (&g_win32_tick_epoch, epoch);
2641 ticks = (guint64)ticks32 | ((guint64)epoch) << 31;
2644 return ticks * 1000;
2646 #elif defined(HAVE_MACH_MACH_TIME_H) /* Mac OS */
2647 gint64
2648 g_get_monotonic_time (void)
2650 static mach_timebase_info_data_t timebase_info;
2652 if (timebase_info.denom == 0)
2654 /* This is a fraction that we must use to scale
2655 * mach_absolute_time() by in order to reach nanoseconds.
2657 * We've only ever observed this to be 1/1, but maybe it could be
2658 * 1000/1 if mach time is microseconds already, or 1/1000 if
2659 * picoseconds. Try to deal nicely with that.
2661 mach_timebase_info (&timebase_info);
2663 /* We actually want microseconds... */
2664 if (timebase_info.numer % 1000 == 0)
2665 timebase_info.numer /= 1000;
2666 else
2667 timebase_info.denom *= 1000;
2669 /* We want to make the numer 1 to avoid having to multiply... */
2670 if (timebase_info.denom % timebase_info.numer == 0)
2672 timebase_info.denom /= timebase_info.numer;
2673 timebase_info.numer = 1;
2675 else
2677 /* We could just multiply by timebase_info.numer below, but why
2678 * bother for a case that may never actually exist...
2680 * Plus -- performing the multiplication would risk integer
2681 * overflow. If we ever actually end up in this situation, we
2682 * should more carefully evaluate the correct course of action.
2684 mach_timebase_info (&timebase_info); /* Get a fresh copy for a better message */
2685 g_error ("Got weird mach timebase info of %d/%d. Please file a bug against GLib.",
2686 timebase_info.numer, timebase_info.denom);
2690 return mach_absolute_time () / timebase_info.denom;
2692 #else
2693 gint64
2694 g_get_monotonic_time (void)
2696 struct timespec ts;
2697 gint result;
2699 result = clock_gettime (CLOCK_MONOTONIC, &ts);
2701 if G_UNLIKELY (result != 0)
2702 g_error ("GLib requires working CLOCK_MONOTONIC");
2704 return (((gint64) ts.tv_sec) * 1000000) + (ts.tv_nsec / 1000);
2706 #endif
2708 static void
2709 g_main_dispatch_free (gpointer dispatch)
2711 g_slice_free (GMainDispatch, dispatch);
2714 /* Running the main loop */
2716 static GMainDispatch *
2717 get_dispatch (void)
2719 static GPrivate depth_private = G_PRIVATE_INIT (g_main_dispatch_free);
2720 GMainDispatch *dispatch;
2722 dispatch = g_private_get (&depth_private);
2724 if (!dispatch)
2726 dispatch = g_slice_new0 (GMainDispatch);
2727 g_private_set (&depth_private, dispatch);
2730 return dispatch;
2734 * g_main_depth:
2736 * Returns the depth of the stack of calls to
2737 * g_main_context_dispatch() on any #GMainContext in the current thread.
2738 * That is, when called from the toplevel, it gives 0. When
2739 * called from within a callback from g_main_context_iteration()
2740 * (or g_main_loop_run(), etc.) it returns 1. When called from within
2741 * a callback to a recursive call to g_main_context_iteration(),
2742 * it returns 2. And so forth.
2744 * This function is useful in a situation like the following:
2745 * Imagine an extremely simple "garbage collected" system.
2747 * |[<!-- language="C" -->
2748 * static GList *free_list;
2750 * gpointer
2751 * allocate_memory (gsize size)
2752 * {
2753 * gpointer result = g_malloc (size);
2754 * free_list = g_list_prepend (free_list, result);
2755 * return result;
2758 * void
2759 * free_allocated_memory (void)
2761 * GList *l;
2762 * for (l = free_list; l; l = l->next);
2763 * g_free (l->data);
2764 * g_list_free (free_list);
2765 * free_list = NULL;
2768 * [...]
2770 * while (TRUE);
2772 * g_main_context_iteration (NULL, TRUE);
2773 * free_allocated_memory();
2775 * ]|
2777 * This works from an application, however, if you want to do the same
2778 * thing from a library, it gets more difficult, since you no longer
2779 * control the main loop. You might think you can simply use an idle
2780 * function to make the call to free_allocated_memory(), but that
2781 * doesn't work, since the idle function could be called from a
2782 * recursive callback. This can be fixed by using g_main_depth()
2784 * |[<!-- language="C" -->
2785 * gpointer
2786 * allocate_memory (gsize size)
2787 * {
2788 * FreeListBlock *block = g_new (FreeListBlock, 1);
2789 * block->mem = g_malloc (size);
2790 * block->depth = g_main_depth ();
2791 * free_list = g_list_prepend (free_list, block);
2792 * return block->mem;
2795 * void
2796 * free_allocated_memory (void)
2798 * GList *l;
2800 * int depth = g_main_depth ();
2801 * for (l = free_list; l; );
2803 * GList *next = l->next;
2804 * FreeListBlock *block = l->data;
2805 * if (block->depth > depth)
2807 * g_free (block->mem);
2808 * g_free (block);
2809 * free_list = g_list_delete_link (free_list, l);
2812 * l = next;
2815 * ]|
2817 * There is a temptation to use g_main_depth() to solve
2818 * problems with reentrancy. For instance, while waiting for data
2819 * to be received from the network in response to a menu item,
2820 * the menu item might be selected again. It might seem that
2821 * one could make the menu item's callback return immediately
2822 * and do nothing if g_main_depth() returns a value greater than 1.
2823 * However, this should be avoided since the user then sees selecting
2824 * the menu item do nothing. Furthermore, you'll find yourself adding
2825 * these checks all over your code, since there are doubtless many,
2826 * many things that the user could do. Instead, you can use the
2827 * following techniques:
2829 * 1. Use gtk_widget_set_sensitive() or modal dialogs to prevent
2830 * the user from interacting with elements while the main
2831 * loop is recursing.
2833 * 2. Avoid main loop recursion in situations where you can't handle
2834 * arbitrary callbacks. Instead, structure your code so that you
2835 * simply return to the main loop and then get called again when
2836 * there is more work to do.
2838 * Returns: The main loop recursion level in the current thread
2841 g_main_depth (void)
2843 GMainDispatch *dispatch = get_dispatch ();
2844 return dispatch->depth;
2848 * g_main_current_source:
2850 * Returns the currently firing source for this thread.
2852 * Returns: (transfer none): The currently firing source or %NULL.
2854 * Since: 2.12
2856 GSource *
2857 g_main_current_source (void)
2859 GMainDispatch *dispatch = get_dispatch ();
2860 return dispatch->source;
2864 * g_source_is_destroyed:
2865 * @source: a #GSource
2867 * Returns whether @source has been destroyed.
2869 * This is important when you operate upon your objects
2870 * from within idle handlers, but may have freed the object
2871 * before the dispatch of your idle handler.
2873 * |[<!-- language="C" -->
2874 * static gboolean
2875 * idle_callback (gpointer data)
2877 * SomeWidget *self = data;
2879 * GDK_THREADS_ENTER ();
2880 * // do stuff with self
2881 * self->idle_id = 0;
2882 * GDK_THREADS_LEAVE ();
2884 * return G_SOURCE_REMOVE;
2887 * static void
2888 * some_widget_do_stuff_later (SomeWidget *self)
2890 * self->idle_id = g_idle_add (idle_callback, self);
2893 * static void
2894 * some_widget_finalize (GObject *object)
2896 * SomeWidget *self = SOME_WIDGET (object);
2898 * if (self->idle_id)
2899 * g_source_remove (self->idle_id);
2901 * G_OBJECT_CLASS (parent_class)->finalize (object);
2903 * ]|
2905 * This will fail in a multi-threaded application if the
2906 * widget is destroyed before the idle handler fires due
2907 * to the use after free in the callback. A solution, to
2908 * this particular problem, is to check to if the source
2909 * has already been destroy within the callback.
2911 * |[<!-- language="C" -->
2912 * static gboolean
2913 * idle_callback (gpointer data)
2915 * SomeWidget *self = data;
2917 * GDK_THREADS_ENTER ();
2918 * if (!g_source_is_destroyed (g_main_current_source ()))
2920 * // do stuff with self
2922 * GDK_THREADS_LEAVE ();
2924 * return FALSE;
2926 * ]|
2928 * Returns: %TRUE if the source has been destroyed
2930 * Since: 2.12
2932 gboolean
2933 g_source_is_destroyed (GSource *source)
2935 return SOURCE_DESTROYED (source);
2938 /* Temporarily remove all this source's file descriptors from the
2939 * poll(), so that if data comes available for one of the file descriptors
2940 * we don't continually spin in the poll()
2942 /* HOLDS: source->context's lock */
2943 static void
2944 block_source (GSource *source)
2946 GSList *tmp_list;
2948 g_return_if_fail (!SOURCE_BLOCKED (source));
2950 source->flags |= G_SOURCE_BLOCKED;
2952 if (source->context)
2954 tmp_list = source->poll_fds;
2955 while (tmp_list)
2957 g_main_context_remove_poll_unlocked (source->context, tmp_list->data);
2958 tmp_list = tmp_list->next;
2961 for (tmp_list = source->priv->fds; tmp_list; tmp_list = tmp_list->next)
2962 g_main_context_remove_poll_unlocked (source->context, tmp_list->data);
2965 if (source->priv && source->priv->child_sources)
2967 tmp_list = source->priv->child_sources;
2968 while (tmp_list)
2970 block_source (tmp_list->data);
2971 tmp_list = tmp_list->next;
2976 /* HOLDS: source->context's lock */
2977 static void
2978 unblock_source (GSource *source)
2980 GSList *tmp_list;
2982 g_return_if_fail (SOURCE_BLOCKED (source)); /* Source already unblocked */
2983 g_return_if_fail (!SOURCE_DESTROYED (source));
2985 source->flags &= ~G_SOURCE_BLOCKED;
2987 tmp_list = source->poll_fds;
2988 while (tmp_list)
2990 g_main_context_add_poll_unlocked (source->context, source->priority, tmp_list->data);
2991 tmp_list = tmp_list->next;
2994 for (tmp_list = source->priv->fds; tmp_list; tmp_list = tmp_list->next)
2995 g_main_context_add_poll_unlocked (source->context, source->priority, tmp_list->data);
2997 if (source->priv && source->priv->child_sources)
2999 tmp_list = source->priv->child_sources;
3000 while (tmp_list)
3002 unblock_source (tmp_list->data);
3003 tmp_list = tmp_list->next;
3008 /* HOLDS: context's lock */
3009 static void
3010 g_main_dispatch (GMainContext *context)
3012 GMainDispatch *current = get_dispatch ();
3013 guint i;
3015 for (i = 0; i < context->pending_dispatches->len; i++)
3017 GSource *source = context->pending_dispatches->pdata[i];
3019 context->pending_dispatches->pdata[i] = NULL;
3020 g_assert (source);
3022 source->flags &= ~G_SOURCE_READY;
3024 if (!SOURCE_DESTROYED (source))
3026 gboolean was_in_call;
3027 gpointer user_data = NULL;
3028 GSourceFunc callback = NULL;
3029 GSourceCallbackFuncs *cb_funcs;
3030 gpointer cb_data;
3031 gboolean need_destroy;
3033 gboolean (*dispatch) (GSource *,
3034 GSourceFunc,
3035 gpointer);
3036 GSource *prev_source;
3038 dispatch = source->source_funcs->dispatch;
3039 cb_funcs = source->callback_funcs;
3040 cb_data = source->callback_data;
3042 if (cb_funcs)
3043 cb_funcs->ref (cb_data);
3045 if ((source->flags & G_SOURCE_CAN_RECURSE) == 0)
3046 block_source (source);
3048 was_in_call = source->flags & G_HOOK_FLAG_IN_CALL;
3049 source->flags |= G_HOOK_FLAG_IN_CALL;
3051 if (cb_funcs)
3052 cb_funcs->get (cb_data, source, &callback, &user_data);
3054 UNLOCK_CONTEXT (context);
3056 /* These operations are safe because 'current' is thread-local
3057 * and not modified from anywhere but this function.
3059 prev_source = current->source;
3060 current->source = source;
3061 current->depth++;
3063 TRACE( GLIB_MAIN_BEFORE_DISPATCH (g_source_get_name (source)));
3064 need_destroy = !(* dispatch) (source, callback, user_data);
3065 TRACE( GLIB_MAIN_AFTER_DISPATCH (g_source_get_name (source)));
3067 current->source = prev_source;
3068 current->depth--;
3070 if (cb_funcs)
3071 cb_funcs->unref (cb_data);
3073 LOCK_CONTEXT (context);
3075 if (!was_in_call)
3076 source->flags &= ~G_HOOK_FLAG_IN_CALL;
3078 if (SOURCE_BLOCKED (source) && !SOURCE_DESTROYED (source))
3079 unblock_source (source);
3081 /* Note: this depends on the fact that we can't switch
3082 * sources from one main context to another
3084 if (need_destroy && !SOURCE_DESTROYED (source))
3086 g_assert (source->context == context);
3087 g_source_destroy_internal (source, context, TRUE);
3091 SOURCE_UNREF (source, context);
3094 g_ptr_array_set_size (context->pending_dispatches, 0);
3098 * g_main_context_acquire:
3099 * @context: a #GMainContext
3101 * Tries to become the owner of the specified context.
3102 * If some other thread is the owner of the context,
3103 * returns %FALSE immediately. Ownership is properly
3104 * recursive: the owner can require ownership again
3105 * and will release ownership when g_main_context_release()
3106 * is called as many times as g_main_context_acquire().
3108 * You must be the owner of a context before you
3109 * can call g_main_context_prepare(), g_main_context_query(),
3110 * g_main_context_check(), g_main_context_dispatch().
3112 * Returns: %TRUE if the operation succeeded, and
3113 * this thread is now the owner of @context.
3115 gboolean
3116 g_main_context_acquire (GMainContext *context)
3118 gboolean result = FALSE;
3119 GThread *self = G_THREAD_SELF;
3121 if (context == NULL)
3122 context = g_main_context_default ();
3124 LOCK_CONTEXT (context);
3126 if (!context->owner)
3128 context->owner = self;
3129 g_assert (context->owner_count == 0);
3132 if (context->owner == self)
3134 context->owner_count++;
3135 result = TRUE;
3138 UNLOCK_CONTEXT (context);
3140 return result;
3144 * g_main_context_release:
3145 * @context: a #GMainContext
3147 * Releases ownership of a context previously acquired by this thread
3148 * with g_main_context_acquire(). If the context was acquired multiple
3149 * times, the ownership will be released only when g_main_context_release()
3150 * is called as many times as it was acquired.
3152 void
3153 g_main_context_release (GMainContext *context)
3155 if (context == NULL)
3156 context = g_main_context_default ();
3158 LOCK_CONTEXT (context);
3160 context->owner_count--;
3161 if (context->owner_count == 0)
3163 context->owner = NULL;
3165 if (context->waiters)
3167 GMainWaiter *waiter = context->waiters->data;
3168 gboolean loop_internal_waiter = (waiter->mutex == &context->mutex);
3169 context->waiters = g_slist_delete_link (context->waiters,
3170 context->waiters);
3171 if (!loop_internal_waiter)
3172 g_mutex_lock (waiter->mutex);
3174 g_cond_signal (waiter->cond);
3176 if (!loop_internal_waiter)
3177 g_mutex_unlock (waiter->mutex);
3181 UNLOCK_CONTEXT (context);
3185 * g_main_context_wait:
3186 * @context: a #GMainContext
3187 * @cond: a condition variable
3188 * @mutex: a mutex, currently held
3190 * Tries to become the owner of the specified context,
3191 * as with g_main_context_acquire(). But if another thread
3192 * is the owner, atomically drop @mutex and wait on @cond until
3193 * that owner releases ownership or until @cond is signaled, then
3194 * try again (once) to become the owner.
3196 * Returns: %TRUE if the operation succeeded, and
3197 * this thread is now the owner of @context.
3199 gboolean
3200 g_main_context_wait (GMainContext *context,
3201 GCond *cond,
3202 GMutex *mutex)
3204 gboolean result = FALSE;
3205 GThread *self = G_THREAD_SELF;
3206 gboolean loop_internal_waiter;
3208 if (context == NULL)
3209 context = g_main_context_default ();
3211 if G_UNLIKELY (cond != &context->cond || mutex != &context->mutex)
3213 static gboolean warned;
3215 if (!warned)
3217 g_critical ("WARNING!! g_main_context_wait() will be removed in a future release. "
3218 "If you see this message, please file a bug immediately.");
3219 warned = TRUE;
3223 loop_internal_waiter = (mutex == &context->mutex);
3225 if (!loop_internal_waiter)
3226 LOCK_CONTEXT (context);
3228 if (context->owner && context->owner != self)
3230 GMainWaiter waiter;
3232 waiter.cond = cond;
3233 waiter.mutex = mutex;
3235 context->waiters = g_slist_append (context->waiters, &waiter);
3237 if (!loop_internal_waiter)
3238 UNLOCK_CONTEXT (context);
3239 g_cond_wait (cond, mutex);
3240 if (!loop_internal_waiter)
3241 LOCK_CONTEXT (context);
3243 context->waiters = g_slist_remove (context->waiters, &waiter);
3246 if (!context->owner)
3248 context->owner = self;
3249 g_assert (context->owner_count == 0);
3252 if (context->owner == self)
3254 context->owner_count++;
3255 result = TRUE;
3258 if (!loop_internal_waiter)
3259 UNLOCK_CONTEXT (context);
3261 return result;
3265 * g_main_context_prepare:
3266 * @context: a #GMainContext
3267 * @priority: location to store priority of highest priority
3268 * source already ready.
3270 * Prepares to poll sources within a main loop. The resulting information
3271 * for polling is determined by calling g_main_context_query ().
3273 * You must have successfully acquired the context with
3274 * g_main_context_acquire() before you may call this function.
3276 * Returns: %TRUE if some source is ready to be dispatched
3277 * prior to polling.
3279 gboolean
3280 g_main_context_prepare (GMainContext *context,
3281 gint *priority)
3283 gint i;
3284 gint n_ready = 0;
3285 gint current_priority = G_MAXINT;
3286 GSource *source;
3287 GSourceIter iter;
3289 if (context == NULL)
3290 context = g_main_context_default ();
3292 LOCK_CONTEXT (context);
3294 context->time_is_fresh = FALSE;
3296 if (context->in_check_or_prepare)
3298 g_warning ("g_main_context_prepare() called recursively from within a source's check() or "
3299 "prepare() member.");
3300 UNLOCK_CONTEXT (context);
3301 return FALSE;
3304 #if 0
3305 /* If recursing, finish up current dispatch, before starting over */
3306 if (context->pending_dispatches)
3308 if (dispatch)
3309 g_main_dispatch (context, &current_time);
3311 UNLOCK_CONTEXT (context);
3312 return TRUE;
3314 #endif
3316 /* If recursing, clear list of pending dispatches */
3318 for (i = 0; i < context->pending_dispatches->len; i++)
3320 if (context->pending_dispatches->pdata[i])
3321 SOURCE_UNREF ((GSource *)context->pending_dispatches->pdata[i], context);
3323 g_ptr_array_set_size (context->pending_dispatches, 0);
3325 /* Prepare all sources */
3327 context->timeout = -1;
3329 g_source_iter_init (&iter, context, TRUE);
3330 while (g_source_iter_next (&iter, &source))
3332 gint source_timeout = -1;
3334 if (SOURCE_DESTROYED (source) || SOURCE_BLOCKED (source))
3335 continue;
3336 if ((n_ready > 0) && (source->priority > current_priority))
3337 break;
3339 if (!(source->flags & G_SOURCE_READY))
3341 gboolean result;
3342 gboolean (* prepare) (GSource *source,
3343 gint *timeout);
3345 prepare = source->source_funcs->prepare;
3347 if (prepare)
3349 context->in_check_or_prepare++;
3350 UNLOCK_CONTEXT (context);
3352 result = (* prepare) (source, &source_timeout);
3354 LOCK_CONTEXT (context);
3355 context->in_check_or_prepare--;
3357 else
3359 source_timeout = -1;
3360 result = FALSE;
3363 if (result == FALSE && source->priv->ready_time != -1)
3365 if (!context->time_is_fresh)
3367 context->time = g_get_monotonic_time ();
3368 context->time_is_fresh = TRUE;
3371 if (source->priv->ready_time <= context->time)
3373 source_timeout = 0;
3374 result = TRUE;
3376 else
3378 gint timeout;
3380 /* rounding down will lead to spinning, so always round up */
3381 timeout = (source->priv->ready_time - context->time + 999) / 1000;
3383 if (source_timeout < 0 || timeout < source_timeout)
3384 source_timeout = timeout;
3388 if (result)
3390 GSource *ready_source = source;
3392 while (ready_source)
3394 ready_source->flags |= G_SOURCE_READY;
3395 ready_source = ready_source->priv->parent_source;
3400 if (source->flags & G_SOURCE_READY)
3402 n_ready++;
3403 current_priority = source->priority;
3404 context->timeout = 0;
3407 if (source_timeout >= 0)
3409 if (context->timeout < 0)
3410 context->timeout = source_timeout;
3411 else
3412 context->timeout = MIN (context->timeout, source_timeout);
3415 g_source_iter_clear (&iter);
3417 UNLOCK_CONTEXT (context);
3419 if (priority)
3420 *priority = current_priority;
3422 return (n_ready > 0);
3426 * g_main_context_query:
3427 * @context: a #GMainContext
3428 * @max_priority: maximum priority source to check
3429 * @timeout_: (out): location to store timeout to be used in polling
3430 * @fds: (out caller-allocates) (array length=n_fds): location to
3431 * store #GPollFD records that need to be polled.
3432 * @n_fds: length of @fds.
3434 * Determines information necessary to poll this main loop.
3436 * You must have successfully acquired the context with
3437 * g_main_context_acquire() before you may call this function.
3439 * Returns: the number of records actually stored in @fds,
3440 * or, if more than @n_fds records need to be stored, the number
3441 * of records that need to be stored.
3443 gint
3444 g_main_context_query (GMainContext *context,
3445 gint max_priority,
3446 gint *timeout,
3447 GPollFD *fds,
3448 gint n_fds)
3450 gint n_poll;
3451 GPollRec *pollrec;
3453 LOCK_CONTEXT (context);
3455 pollrec = context->poll_records;
3456 n_poll = 0;
3457 while (pollrec && max_priority >= pollrec->priority)
3459 /* We need to include entries with fd->events == 0 in the array because
3460 * otherwise if the application changes fd->events behind our back and
3461 * makes it non-zero, we'll be out of sync when we check the fds[] array.
3462 * (Changing fd->events after adding an FD wasn't an anticipated use of
3463 * this API, but it occurs in practice.) */
3464 if (n_poll < n_fds)
3466 fds[n_poll].fd = pollrec->fd->fd;
3467 /* In direct contradiction to the Unix98 spec, IRIX runs into
3468 * difficulty if you pass in POLLERR, POLLHUP or POLLNVAL
3469 * flags in the events field of the pollfd while it should
3470 * just ignoring them. So we mask them out here.
3472 fds[n_poll].events = pollrec->fd->events & ~(G_IO_ERR|G_IO_HUP|G_IO_NVAL);
3473 fds[n_poll].revents = 0;
3476 pollrec = pollrec->next;
3477 n_poll++;
3480 context->poll_changed = FALSE;
3482 if (timeout)
3484 *timeout = context->timeout;
3485 if (*timeout != 0)
3486 context->time_is_fresh = FALSE;
3489 UNLOCK_CONTEXT (context);
3491 return n_poll;
3495 * g_main_context_check:
3496 * @context: a #GMainContext
3497 * @max_priority: the maximum numerical priority of sources to check
3498 * @fds: (array length=n_fds): array of #GPollFD's that was passed to
3499 * the last call to g_main_context_query()
3500 * @n_fds: return value of g_main_context_query()
3502 * Passes the results of polling back to the main loop.
3504 * You must have successfully acquired the context with
3505 * g_main_context_acquire() before you may call this function.
3507 * Returns: %TRUE if some sources are ready to be dispatched.
3509 gboolean
3510 g_main_context_check (GMainContext *context,
3511 gint max_priority,
3512 GPollFD *fds,
3513 gint n_fds)
3515 GSource *source;
3516 GSourceIter iter;
3517 GPollRec *pollrec;
3518 gint n_ready = 0;
3519 gint i;
3521 LOCK_CONTEXT (context);
3523 if (context->in_check_or_prepare)
3525 g_warning ("g_main_context_check() called recursively from within a source's check() or "
3526 "prepare() member.");
3527 UNLOCK_CONTEXT (context);
3528 return FALSE;
3531 if (context->wake_up_rec.revents)
3532 g_wakeup_acknowledge (context->wakeup);
3534 /* If the set of poll file descriptors changed, bail out
3535 * and let the main loop rerun
3537 if (context->poll_changed)
3539 UNLOCK_CONTEXT (context);
3540 return FALSE;
3543 pollrec = context->poll_records;
3544 i = 0;
3545 while (i < n_fds)
3547 if (pollrec->fd->events)
3548 pollrec->fd->revents = fds[i].revents;
3550 pollrec = pollrec->next;
3551 i++;
3554 g_source_iter_init (&iter, context, TRUE);
3555 while (g_source_iter_next (&iter, &source))
3557 if (SOURCE_DESTROYED (source) || SOURCE_BLOCKED (source))
3558 continue;
3559 if ((n_ready > 0) && (source->priority > max_priority))
3560 break;
3562 if (!(source->flags & G_SOURCE_READY))
3564 gboolean result;
3565 gboolean (* check) (GSource *source);
3567 check = source->source_funcs->check;
3569 if (check)
3571 /* If the check function is set, call it. */
3572 context->in_check_or_prepare++;
3573 UNLOCK_CONTEXT (context);
3575 result = (* check) (source);
3577 LOCK_CONTEXT (context);
3578 context->in_check_or_prepare--;
3580 else
3581 result = FALSE;
3583 if (result == FALSE)
3585 GSList *tmp_list;
3587 /* If not already explicitly flagged ready by ->check()
3588 * (or if we have no check) then we can still be ready if
3589 * any of our fds poll as ready.
3591 for (tmp_list = source->priv->fds; tmp_list; tmp_list = tmp_list->next)
3593 GPollFD *pollfd = tmp_list->data;
3595 if (pollfd->revents)
3597 result = TRUE;
3598 break;
3603 if (result == FALSE && source->priv->ready_time != -1)
3605 if (!context->time_is_fresh)
3607 context->time = g_get_monotonic_time ();
3608 context->time_is_fresh = TRUE;
3611 if (source->priv->ready_time <= context->time)
3612 result = TRUE;
3615 if (result)
3617 GSource *ready_source = source;
3619 while (ready_source)
3621 ready_source->flags |= G_SOURCE_READY;
3622 ready_source = ready_source->priv->parent_source;
3627 if (source->flags & G_SOURCE_READY)
3629 source->ref_count++;
3630 g_ptr_array_add (context->pending_dispatches, source);
3632 n_ready++;
3634 /* never dispatch sources with less priority than the first
3635 * one we choose to dispatch
3637 max_priority = source->priority;
3640 g_source_iter_clear (&iter);
3642 UNLOCK_CONTEXT (context);
3644 return n_ready > 0;
3648 * g_main_context_dispatch:
3649 * @context: a #GMainContext
3651 * Dispatches all pending sources.
3653 * You must have successfully acquired the context with
3654 * g_main_context_acquire() before you may call this function.
3656 void
3657 g_main_context_dispatch (GMainContext *context)
3659 LOCK_CONTEXT (context);
3661 if (context->pending_dispatches->len > 0)
3663 g_main_dispatch (context);
3666 UNLOCK_CONTEXT (context);
3669 /* HOLDS context lock */
3670 static gboolean
3671 g_main_context_iterate (GMainContext *context,
3672 gboolean block,
3673 gboolean dispatch,
3674 GThread *self)
3676 gint max_priority;
3677 gint timeout;
3678 gboolean some_ready;
3679 gint nfds, allocated_nfds;
3680 GPollFD *fds = NULL;
3682 UNLOCK_CONTEXT (context);
3684 if (!g_main_context_acquire (context))
3686 gboolean got_ownership;
3688 LOCK_CONTEXT (context);
3690 if (!block)
3691 return FALSE;
3693 got_ownership = g_main_context_wait (context,
3694 &context->cond,
3695 &context->mutex);
3697 if (!got_ownership)
3698 return FALSE;
3700 else
3701 LOCK_CONTEXT (context);
3703 if (!context->cached_poll_array)
3705 context->cached_poll_array_size = context->n_poll_records;
3706 context->cached_poll_array = g_new (GPollFD, context->n_poll_records);
3709 allocated_nfds = context->cached_poll_array_size;
3710 fds = context->cached_poll_array;
3712 UNLOCK_CONTEXT (context);
3714 g_main_context_prepare (context, &max_priority);
3716 while ((nfds = g_main_context_query (context, max_priority, &timeout, fds,
3717 allocated_nfds)) > allocated_nfds)
3719 LOCK_CONTEXT (context);
3720 g_free (fds);
3721 context->cached_poll_array_size = allocated_nfds = nfds;
3722 context->cached_poll_array = fds = g_new (GPollFD, nfds);
3723 UNLOCK_CONTEXT (context);
3726 if (!block)
3727 timeout = 0;
3729 g_main_context_poll (context, timeout, max_priority, fds, nfds);
3731 some_ready = g_main_context_check (context, max_priority, fds, nfds);
3733 if (dispatch)
3734 g_main_context_dispatch (context);
3736 g_main_context_release (context);
3738 LOCK_CONTEXT (context);
3740 return some_ready;
3744 * g_main_context_pending:
3745 * @context: (allow-none): a #GMainContext (if %NULL, the default context will be used)
3747 * Checks if any sources have pending events for the given context.
3749 * Returns: %TRUE if events are pending.
3751 gboolean
3752 g_main_context_pending (GMainContext *context)
3754 gboolean retval;
3756 if (!context)
3757 context = g_main_context_default();
3759 LOCK_CONTEXT (context);
3760 retval = g_main_context_iterate (context, FALSE, FALSE, G_THREAD_SELF);
3761 UNLOCK_CONTEXT (context);
3763 return retval;
3767 * g_main_context_iteration:
3768 * @context: (allow-none): a #GMainContext (if %NULL, the default context will be used)
3769 * @may_block: whether the call may block.
3771 * Runs a single iteration for the given main loop. This involves
3772 * checking to see if any event sources are ready to be processed,
3773 * then if no events sources are ready and @may_block is %TRUE, waiting
3774 * for a source to become ready, then dispatching the highest priority
3775 * events sources that are ready. Otherwise, if @may_block is %FALSE
3776 * sources are not waited to become ready, only those highest priority
3777 * events sources will be dispatched (if any), that are ready at this
3778 * given moment without further waiting.
3780 * Note that even when @may_block is %TRUE, it is still possible for
3781 * g_main_context_iteration() to return %FALSE, since the wait may
3782 * be interrupted for other reasons than an event source becoming ready.
3784 * Returns: %TRUE if events were dispatched.
3786 gboolean
3787 g_main_context_iteration (GMainContext *context, gboolean may_block)
3789 gboolean retval;
3791 if (!context)
3792 context = g_main_context_default();
3794 LOCK_CONTEXT (context);
3795 retval = g_main_context_iterate (context, may_block, TRUE, G_THREAD_SELF);
3796 UNLOCK_CONTEXT (context);
3798 return retval;
3802 * g_main_loop_new:
3803 * @context: (allow-none): a #GMainContext (if %NULL, the default context will be used).
3804 * @is_running: set to %TRUE to indicate that the loop is running. This
3805 * is not very important since calling g_main_loop_run() will set this to
3806 * %TRUE anyway.
3808 * Creates a new #GMainLoop structure.
3810 * Returns: a new #GMainLoop.
3812 GMainLoop *
3813 g_main_loop_new (GMainContext *context,
3814 gboolean is_running)
3816 GMainLoop *loop;
3818 if (!context)
3819 context = g_main_context_default();
3821 g_main_context_ref (context);
3823 loop = g_new0 (GMainLoop, 1);
3824 loop->context = context;
3825 loop->is_running = is_running != FALSE;
3826 loop->ref_count = 1;
3828 return loop;
3832 * g_main_loop_ref:
3833 * @loop: a #GMainLoop
3835 * Increases the reference count on a #GMainLoop object by one.
3837 * Returns: @loop
3839 GMainLoop *
3840 g_main_loop_ref (GMainLoop *loop)
3842 g_return_val_if_fail (loop != NULL, NULL);
3843 g_return_val_if_fail (g_atomic_int_get (&loop->ref_count) > 0, NULL);
3845 g_atomic_int_inc (&loop->ref_count);
3847 return loop;
3851 * g_main_loop_unref:
3852 * @loop: a #GMainLoop
3854 * Decreases the reference count on a #GMainLoop object by one. If
3855 * the result is zero, free the loop and free all associated memory.
3857 void
3858 g_main_loop_unref (GMainLoop *loop)
3860 g_return_if_fail (loop != NULL);
3861 g_return_if_fail (g_atomic_int_get (&loop->ref_count) > 0);
3863 if (!g_atomic_int_dec_and_test (&loop->ref_count))
3864 return;
3866 g_main_context_unref (loop->context);
3867 g_free (loop);
3871 * g_main_loop_run:
3872 * @loop: a #GMainLoop
3874 * Runs a main loop until g_main_loop_quit() is called on the loop.
3875 * If this is called for the thread of the loop's #GMainContext,
3876 * it will process events from the loop, otherwise it will
3877 * simply wait.
3879 void
3880 g_main_loop_run (GMainLoop *loop)
3882 GThread *self = G_THREAD_SELF;
3884 g_return_if_fail (loop != NULL);
3885 g_return_if_fail (g_atomic_int_get (&loop->ref_count) > 0);
3887 if (!g_main_context_acquire (loop->context))
3889 gboolean got_ownership = FALSE;
3891 /* Another thread owns this context */
3892 LOCK_CONTEXT (loop->context);
3894 g_atomic_int_inc (&loop->ref_count);
3896 if (!loop->is_running)
3897 loop->is_running = TRUE;
3899 while (loop->is_running && !got_ownership)
3900 got_ownership = g_main_context_wait (loop->context,
3901 &loop->context->cond,
3902 &loop->context->mutex);
3904 if (!loop->is_running)
3906 UNLOCK_CONTEXT (loop->context);
3907 if (got_ownership)
3908 g_main_context_release (loop->context);
3909 g_main_loop_unref (loop);
3910 return;
3913 g_assert (got_ownership);
3915 else
3916 LOCK_CONTEXT (loop->context);
3918 if (loop->context->in_check_or_prepare)
3920 g_warning ("g_main_loop_run(): called recursively from within a source's "
3921 "check() or prepare() member, iteration not possible.");
3922 return;
3925 g_atomic_int_inc (&loop->ref_count);
3926 loop->is_running = TRUE;
3927 while (loop->is_running)
3928 g_main_context_iterate (loop->context, TRUE, TRUE, self);
3930 UNLOCK_CONTEXT (loop->context);
3932 g_main_context_release (loop->context);
3934 g_main_loop_unref (loop);
3938 * g_main_loop_quit:
3939 * @loop: a #GMainLoop
3941 * Stops a #GMainLoop from running. Any calls to g_main_loop_run()
3942 * for the loop will return.
3944 * Note that sources that have already been dispatched when
3945 * g_main_loop_quit() is called will still be executed.
3947 void
3948 g_main_loop_quit (GMainLoop *loop)
3950 g_return_if_fail (loop != NULL);
3951 g_return_if_fail (g_atomic_int_get (&loop->ref_count) > 0);
3953 LOCK_CONTEXT (loop->context);
3954 loop->is_running = FALSE;
3955 g_wakeup_signal (loop->context->wakeup);
3957 g_cond_broadcast (&loop->context->cond);
3959 UNLOCK_CONTEXT (loop->context);
3963 * g_main_loop_is_running:
3964 * @loop: a #GMainLoop.
3966 * Checks to see if the main loop is currently being run via g_main_loop_run().
3968 * Returns: %TRUE if the mainloop is currently being run.
3970 gboolean
3971 g_main_loop_is_running (GMainLoop *loop)
3973 g_return_val_if_fail (loop != NULL, FALSE);
3974 g_return_val_if_fail (g_atomic_int_get (&loop->ref_count) > 0, FALSE);
3976 return loop->is_running;
3980 * g_main_loop_get_context:
3981 * @loop: a #GMainLoop.
3983 * Returns the #GMainContext of @loop.
3985 * Returns: (transfer none): the #GMainContext of @loop
3987 GMainContext *
3988 g_main_loop_get_context (GMainLoop *loop)
3990 g_return_val_if_fail (loop != NULL, NULL);
3991 g_return_val_if_fail (g_atomic_int_get (&loop->ref_count) > 0, NULL);
3993 return loop->context;
3996 /* HOLDS: context's lock */
3997 static void
3998 g_main_context_poll (GMainContext *context,
3999 gint timeout,
4000 gint priority,
4001 GPollFD *fds,
4002 gint n_fds)
4004 #ifdef G_MAIN_POLL_DEBUG
4005 GTimer *poll_timer;
4006 GPollRec *pollrec;
4007 gint i;
4008 #endif
4010 GPollFunc poll_func;
4012 if (n_fds || timeout != 0)
4014 #ifdef G_MAIN_POLL_DEBUG
4015 if (_g_main_poll_debug)
4017 g_print ("polling context=%p n=%d timeout=%d\n",
4018 context, n_fds, timeout);
4019 poll_timer = g_timer_new ();
4021 #endif
4023 LOCK_CONTEXT (context);
4025 poll_func = context->poll_func;
4027 UNLOCK_CONTEXT (context);
4028 if ((*poll_func) (fds, n_fds, timeout) < 0 && errno != EINTR)
4030 #ifndef G_OS_WIN32
4031 g_warning ("poll(2) failed due to: %s.",
4032 g_strerror (errno));
4033 #else
4034 /* If g_poll () returns -1, it has already called g_warning() */
4035 #endif
4038 #ifdef G_MAIN_POLL_DEBUG
4039 if (_g_main_poll_debug)
4041 LOCK_CONTEXT (context);
4043 g_print ("g_main_poll(%d) timeout: %d - elapsed %12.10f seconds",
4044 n_fds,
4045 timeout,
4046 g_timer_elapsed (poll_timer, NULL));
4047 g_timer_destroy (poll_timer);
4048 pollrec = context->poll_records;
4050 while (pollrec != NULL)
4052 i = 0;
4053 while (i < n_fds)
4055 if (fds[i].fd == pollrec->fd->fd &&
4056 pollrec->fd->events &&
4057 fds[i].revents)
4059 g_print (" [" G_POLLFD_FORMAT " :", fds[i].fd);
4060 if (fds[i].revents & G_IO_IN)
4061 g_print ("i");
4062 if (fds[i].revents & G_IO_OUT)
4063 g_print ("o");
4064 if (fds[i].revents & G_IO_PRI)
4065 g_print ("p");
4066 if (fds[i].revents & G_IO_ERR)
4067 g_print ("e");
4068 if (fds[i].revents & G_IO_HUP)
4069 g_print ("h");
4070 if (fds[i].revents & G_IO_NVAL)
4071 g_print ("n");
4072 g_print ("]");
4074 i++;
4076 pollrec = pollrec->next;
4078 g_print ("\n");
4080 UNLOCK_CONTEXT (context);
4082 #endif
4083 } /* if (n_fds || timeout != 0) */
4087 * g_main_context_add_poll:
4088 * @context: (allow-none): a #GMainContext (or %NULL for the default context)
4089 * @fd: a #GPollFD structure holding information about a file
4090 * descriptor to watch.
4091 * @priority: the priority for this file descriptor which should be
4092 * the same as the priority used for g_source_attach() to ensure that the
4093 * file descriptor is polled whenever the results may be needed.
4095 * Adds a file descriptor to the set of file descriptors polled for
4096 * this context. This will very seldom be used directly. Instead
4097 * a typical event source will use g_source_add_unix_fd() instead.
4099 void
4100 g_main_context_add_poll (GMainContext *context,
4101 GPollFD *fd,
4102 gint priority)
4104 if (!context)
4105 context = g_main_context_default ();
4107 g_return_if_fail (g_atomic_int_get (&context->ref_count) > 0);
4108 g_return_if_fail (fd);
4110 LOCK_CONTEXT (context);
4111 g_main_context_add_poll_unlocked (context, priority, fd);
4112 UNLOCK_CONTEXT (context);
4115 /* HOLDS: main_loop_lock */
4116 static void
4117 g_main_context_add_poll_unlocked (GMainContext *context,
4118 gint priority,
4119 GPollFD *fd)
4121 GPollRec *prevrec, *nextrec;
4122 GPollRec *newrec = g_slice_new (GPollRec);
4124 /* This file descriptor may be checked before we ever poll */
4125 fd->revents = 0;
4126 newrec->fd = fd;
4127 newrec->priority = priority;
4129 prevrec = context->poll_records_tail;
4130 nextrec = NULL;
4131 while (prevrec && priority < prevrec->priority)
4133 nextrec = prevrec;
4134 prevrec = prevrec->prev;
4137 if (prevrec)
4138 prevrec->next = newrec;
4139 else
4140 context->poll_records = newrec;
4142 newrec->prev = prevrec;
4143 newrec->next = nextrec;
4145 if (nextrec)
4146 nextrec->prev = newrec;
4147 else
4148 context->poll_records_tail = newrec;
4150 context->n_poll_records++;
4152 context->poll_changed = TRUE;
4154 /* Now wake up the main loop if it is waiting in the poll() */
4155 g_wakeup_signal (context->wakeup);
4159 * g_main_context_remove_poll:
4160 * @context:a #GMainContext
4161 * @fd: a #GPollFD descriptor previously added with g_main_context_add_poll()
4163 * Removes file descriptor from the set of file descriptors to be
4164 * polled for a particular context.
4166 void
4167 g_main_context_remove_poll (GMainContext *context,
4168 GPollFD *fd)
4170 if (!context)
4171 context = g_main_context_default ();
4173 g_return_if_fail (g_atomic_int_get (&context->ref_count) > 0);
4174 g_return_if_fail (fd);
4176 LOCK_CONTEXT (context);
4177 g_main_context_remove_poll_unlocked (context, fd);
4178 UNLOCK_CONTEXT (context);
4181 static void
4182 g_main_context_remove_poll_unlocked (GMainContext *context,
4183 GPollFD *fd)
4185 GPollRec *pollrec, *prevrec, *nextrec;
4187 prevrec = NULL;
4188 pollrec = context->poll_records;
4190 while (pollrec)
4192 nextrec = pollrec->next;
4193 if (pollrec->fd == fd)
4195 if (prevrec != NULL)
4196 prevrec->next = nextrec;
4197 else
4198 context->poll_records = nextrec;
4200 if (nextrec != NULL)
4201 nextrec->prev = prevrec;
4202 else
4203 context->poll_records_tail = prevrec;
4205 g_slice_free (GPollRec, pollrec);
4207 context->n_poll_records--;
4208 break;
4210 prevrec = pollrec;
4211 pollrec = nextrec;
4214 context->poll_changed = TRUE;
4216 /* Now wake up the main loop if it is waiting in the poll() */
4217 g_wakeup_signal (context->wakeup);
4221 * g_source_get_current_time:
4222 * @source: a #GSource
4223 * @timeval: #GTimeVal structure in which to store current time.
4225 * This function ignores @source and is otherwise the same as
4226 * g_get_current_time().
4228 * Deprecated: 2.28: use g_source_get_time() instead
4230 void
4231 g_source_get_current_time (GSource *source,
4232 GTimeVal *timeval)
4234 g_get_current_time (timeval);
4238 * g_source_get_time:
4239 * @source: a #GSource
4241 * Gets the time to be used when checking this source. The advantage of
4242 * calling this function over calling g_get_monotonic_time() directly is
4243 * that when checking multiple sources, GLib can cache a single value
4244 * instead of having to repeatedly get the system monotonic time.
4246 * The time here is the system monotonic time, if available, or some
4247 * other reasonable alternative otherwise. See g_get_monotonic_time().
4249 * Returns: the monotonic time in microseconds
4251 * Since: 2.28
4253 gint64
4254 g_source_get_time (GSource *source)
4256 GMainContext *context;
4257 gint64 result;
4259 g_return_val_if_fail (source->context != NULL, 0);
4261 context = source->context;
4263 LOCK_CONTEXT (context);
4265 if (!context->time_is_fresh)
4267 context->time = g_get_monotonic_time ();
4268 context->time_is_fresh = TRUE;
4271 result = context->time;
4273 UNLOCK_CONTEXT (context);
4275 return result;
4279 * g_main_context_set_poll_func:
4280 * @context: a #GMainContext
4281 * @func: the function to call to poll all file descriptors
4283 * Sets the function to use to handle polling of file descriptors. It
4284 * will be used instead of the poll() system call
4285 * (or GLib's replacement function, which is used where
4286 * poll() isn't available).
4288 * This function could possibly be used to integrate the GLib event
4289 * loop with an external event loop.
4291 void
4292 g_main_context_set_poll_func (GMainContext *context,
4293 GPollFunc func)
4295 if (!context)
4296 context = g_main_context_default ();
4298 g_return_if_fail (g_atomic_int_get (&context->ref_count) > 0);
4300 LOCK_CONTEXT (context);
4302 if (func)
4303 context->poll_func = func;
4304 else
4305 context->poll_func = g_poll;
4307 UNLOCK_CONTEXT (context);
4311 * g_main_context_get_poll_func:
4312 * @context: a #GMainContext
4314 * Gets the poll function set by g_main_context_set_poll_func().
4316 * Returns: the poll function
4318 GPollFunc
4319 g_main_context_get_poll_func (GMainContext *context)
4321 GPollFunc result;
4323 if (!context)
4324 context = g_main_context_default ();
4326 g_return_val_if_fail (g_atomic_int_get (&context->ref_count) > 0, NULL);
4328 LOCK_CONTEXT (context);
4329 result = context->poll_func;
4330 UNLOCK_CONTEXT (context);
4332 return result;
4336 * g_main_context_wakeup:
4337 * @context: a #GMainContext
4339 * If @context is currently blocking in g_main_context_iteration()
4340 * waiting for a source to become ready, cause it to stop blocking
4341 * and return. Otherwise, cause the next invocation of
4342 * g_main_context_iteration() to return without blocking.
4344 * This API is useful for low-level control over #GMainContext; for
4345 * example, integrating it with main loop implementations such as
4346 * #GMainLoop.
4348 * Another related use for this function is when implementing a main
4349 * loop with a termination condition, computed from multiple threads:
4351 * |[<!-- language="C" -->
4352 * #define NUM_TASKS 10
4353 * static volatile gint tasks_remaining = NUM_TASKS;
4354 * ...
4356 * while (g_atomic_int_get (&tasks_remaining) != 0)
4357 * g_main_context_iteration (NULL, TRUE);
4358 * ]|
4360 * Then in a thread:
4361 * |[<!-- language="C" -->
4362 * perform_work();
4364 * if (g_atomic_int_dec_and_test (&tasks_remaining))
4365 * g_main_context_wakeup (NULL);
4366 * ]|
4368 void
4369 g_main_context_wakeup (GMainContext *context)
4371 if (!context)
4372 context = g_main_context_default ();
4374 g_return_if_fail (g_atomic_int_get (&context->ref_count) > 0);
4376 g_wakeup_signal (context->wakeup);
4380 * g_main_context_is_owner:
4381 * @context: a #GMainContext
4383 * Determines whether this thread holds the (recursive)
4384 * ownership of this #GMainContext. This is useful to
4385 * know before waiting on another thread that may be
4386 * blocking to get ownership of @context.
4388 * Returns: %TRUE if current thread is owner of @context.
4390 * Since: 2.10
4392 gboolean
4393 g_main_context_is_owner (GMainContext *context)
4395 gboolean is_owner;
4397 if (!context)
4398 context = g_main_context_default ();
4400 LOCK_CONTEXT (context);
4401 is_owner = context->owner == G_THREAD_SELF;
4402 UNLOCK_CONTEXT (context);
4404 return is_owner;
4407 /* Timeouts */
4409 static void
4410 g_timeout_set_expiration (GTimeoutSource *timeout_source,
4411 gint64 current_time)
4413 gint64 expiration;
4415 expiration = current_time + (guint64) timeout_source->interval * 1000;
4417 if (timeout_source->seconds)
4419 gint64 remainder;
4420 static gint timer_perturb = -1;
4422 if (timer_perturb == -1)
4425 * we want a per machine/session unique 'random' value; try the dbus
4426 * address first, that has a UUID in it. If there is no dbus, use the
4427 * hostname for hashing.
4429 const char *session_bus_address = g_getenv ("DBUS_SESSION_BUS_ADDRESS");
4430 if (!session_bus_address)
4431 session_bus_address = g_getenv ("HOSTNAME");
4432 if (session_bus_address)
4433 timer_perturb = ABS ((gint) g_str_hash (session_bus_address)) % 1000000;
4434 else
4435 timer_perturb = 0;
4438 /* We want the microseconds part of the timeout to land on the
4439 * 'timer_perturb' mark, but we need to make sure we don't try to
4440 * set the timeout in the past. We do this by ensuring that we
4441 * always only *increase* the expiration time by adding a full
4442 * second in the case that the microsecond portion decreases.
4444 expiration -= timer_perturb;
4446 remainder = expiration % 1000000;
4447 if (remainder >= 1000000/4)
4448 expiration += 1000000;
4450 expiration -= remainder;
4451 expiration += timer_perturb;
4454 g_source_set_ready_time ((GSource *) timeout_source, expiration);
4457 static gboolean
4458 g_timeout_dispatch (GSource *source,
4459 GSourceFunc callback,
4460 gpointer user_data)
4462 GTimeoutSource *timeout_source = (GTimeoutSource *)source;
4463 gboolean again;
4465 if (!callback)
4467 g_warning ("Timeout source dispatched without callback\n"
4468 "You must call g_source_set_callback().");
4469 return FALSE;
4472 again = callback (user_data);
4474 if (again)
4475 g_timeout_set_expiration (timeout_source, g_source_get_time (source));
4477 return again;
4481 * g_timeout_source_new:
4482 * @interval: the timeout interval in milliseconds.
4484 * Creates a new timeout source.
4486 * The source will not initially be associated with any #GMainContext
4487 * and must be added to one with g_source_attach() before it will be
4488 * executed.
4490 * The interval given is in terms of monotonic time, not wall clock
4491 * time. See g_get_monotonic_time().
4493 * Returns: the newly-created timeout source
4495 GSource *
4496 g_timeout_source_new (guint interval)
4498 GSource *source = g_source_new (&g_timeout_funcs, sizeof (GTimeoutSource));
4499 GTimeoutSource *timeout_source = (GTimeoutSource *)source;
4501 timeout_source->interval = interval;
4502 g_timeout_set_expiration (timeout_source, g_get_monotonic_time ());
4504 return source;
4508 * g_timeout_source_new_seconds:
4509 * @interval: the timeout interval in seconds
4511 * Creates a new timeout source.
4513 * The source will not initially be associated with any #GMainContext
4514 * and must be added to one with g_source_attach() before it will be
4515 * executed.
4517 * The scheduling granularity/accuracy of this timeout source will be
4518 * in seconds.
4520 * The interval given in terms of monotonic time, not wall clock time.
4521 * See g_get_monotonic_time().
4523 * Returns: the newly-created timeout source
4525 * Since: 2.14
4527 GSource *
4528 g_timeout_source_new_seconds (guint interval)
4530 GSource *source = g_source_new (&g_timeout_funcs, sizeof (GTimeoutSource));
4531 GTimeoutSource *timeout_source = (GTimeoutSource *)source;
4533 timeout_source->interval = 1000 * interval;
4534 timeout_source->seconds = TRUE;
4536 g_timeout_set_expiration (timeout_source, g_get_monotonic_time ());
4538 return source;
4543 * g_timeout_add_full:
4544 * @priority: the priority of the timeout source. Typically this will be in
4545 * the range between #G_PRIORITY_DEFAULT and #G_PRIORITY_HIGH.
4546 * @interval: the time between calls to the function, in milliseconds
4547 * (1/1000ths of a second)
4548 * @function: function to call
4549 * @data: data to pass to @function
4550 * @notify: (allow-none): function to call when the timeout is removed, or %NULL
4552 * Sets a function to be called at regular intervals, with the given
4553 * priority. The function is called repeatedly until it returns
4554 * %FALSE, at which point the timeout is automatically destroyed and
4555 * the function will not be called again. The @notify function is
4556 * called when the timeout is destroyed. The first call to the
4557 * function will be at the end of the first @interval.
4559 * Note that timeout functions may be delayed, due to the processing of other
4560 * event sources. Thus they should not be relied on for precise timing.
4561 * After each call to the timeout function, the time of the next
4562 * timeout is recalculated based on the current time and the given interval
4563 * (it does not try to 'catch up' time lost in delays).
4565 * This internally creates a main loop source using g_timeout_source_new()
4566 * and attaches it to the main loop context using g_source_attach(). You can
4567 * do these steps manually if you need greater control.
4569 * The interval given in terms of monotonic time, not wall clock time.
4570 * See g_get_monotonic_time().
4572 * Returns: the ID (greater than 0) of the event source.
4573 * Rename to: g_timeout_add
4575 guint
4576 g_timeout_add_full (gint priority,
4577 guint interval,
4578 GSourceFunc function,
4579 gpointer data,
4580 GDestroyNotify notify)
4582 GSource *source;
4583 guint id;
4585 g_return_val_if_fail (function != NULL, 0);
4587 source = g_timeout_source_new (interval);
4589 if (priority != G_PRIORITY_DEFAULT)
4590 g_source_set_priority (source, priority);
4592 g_source_set_callback (source, function, data, notify);
4593 id = g_source_attach (source, NULL);
4594 g_source_unref (source);
4596 return id;
4600 * g_timeout_add:
4601 * @interval: the time between calls to the function, in milliseconds
4602 * (1/1000ths of a second)
4603 * @function: function to call
4604 * @data: data to pass to @function
4606 * Sets a function to be called at regular intervals, with the default
4607 * priority, #G_PRIORITY_DEFAULT. The function is called repeatedly
4608 * until it returns %FALSE, at which point the timeout is automatically
4609 * destroyed and the function will not be called again. The first call
4610 * to the function will be at the end of the first @interval.
4612 * Note that timeout functions may be delayed, due to the processing of other
4613 * event sources. Thus they should not be relied on for precise timing.
4614 * After each call to the timeout function, the time of the next
4615 * timeout is recalculated based on the current time and the given interval
4616 * (it does not try to 'catch up' time lost in delays).
4618 * If you want to have a timer in the "seconds" range and do not care
4619 * about the exact time of the first call of the timer, use the
4620 * g_timeout_add_seconds() function; this function allows for more
4621 * optimizations and more efficient system power usage.
4623 * This internally creates a main loop source using g_timeout_source_new()
4624 * and attaches it to the main loop context using g_source_attach(). You can
4625 * do these steps manually if you need greater control.
4627 * The interval given is in terms of monotonic time, not wall clock
4628 * time. See g_get_monotonic_time().
4630 * Returns: the ID (greater than 0) of the event source.
4632 guint
4633 g_timeout_add (guint32 interval,
4634 GSourceFunc function,
4635 gpointer data)
4637 return g_timeout_add_full (G_PRIORITY_DEFAULT,
4638 interval, function, data, NULL);
4642 * g_timeout_add_seconds_full:
4643 * @priority: the priority of the timeout source. Typically this will be in
4644 * the range between #G_PRIORITY_DEFAULT and #G_PRIORITY_HIGH.
4645 * @interval: the time between calls to the function, in seconds
4646 * @function: function to call
4647 * @data: data to pass to @function
4648 * @notify: (allow-none): function to call when the timeout is removed, or %NULL
4650 * Sets a function to be called at regular intervals, with @priority.
4651 * The function is called repeatedly until it returns %FALSE, at which
4652 * point the timeout is automatically destroyed and the function will
4653 * not be called again.
4655 * Unlike g_timeout_add(), this function operates at whole second granularity.
4656 * The initial starting point of the timer is determined by the implementation
4657 * and the implementation is expected to group multiple timers together so that
4658 * they fire all at the same time.
4659 * To allow this grouping, the @interval to the first timer is rounded
4660 * and can deviate up to one second from the specified interval.
4661 * Subsequent timer iterations will generally run at the specified interval.
4663 * Note that timeout functions may be delayed, due to the processing of other
4664 * event sources. Thus they should not be relied on for precise timing.
4665 * After each call to the timeout function, the time of the next
4666 * timeout is recalculated based on the current time and the given @interval
4668 * If you want timing more precise than whole seconds, use g_timeout_add()
4669 * instead.
4671 * The grouping of timers to fire at the same time results in a more power
4672 * and CPU efficient behavior so if your timer is in multiples of seconds
4673 * and you don't require the first timer exactly one second from now, the
4674 * use of g_timeout_add_seconds() is preferred over g_timeout_add().
4676 * This internally creates a main loop source using
4677 * g_timeout_source_new_seconds() and attaches it to the main loop context
4678 * using g_source_attach(). You can do these steps manually if you need
4679 * greater control.
4681 * The interval given is in terms of monotonic time, not wall clock
4682 * time. See g_get_monotonic_time().
4684 * Returns: the ID (greater than 0) of the event source.
4686 * Rename to: g_timeout_add_seconds
4687 * Since: 2.14
4689 guint
4690 g_timeout_add_seconds_full (gint priority,
4691 guint32 interval,
4692 GSourceFunc function,
4693 gpointer data,
4694 GDestroyNotify notify)
4696 GSource *source;
4697 guint id;
4699 g_return_val_if_fail (function != NULL, 0);
4701 source = g_timeout_source_new_seconds (interval);
4703 if (priority != G_PRIORITY_DEFAULT)
4704 g_source_set_priority (source, priority);
4706 g_source_set_callback (source, function, data, notify);
4707 id = g_source_attach (source, NULL);
4708 g_source_unref (source);
4710 return id;
4714 * g_timeout_add_seconds:
4715 * @interval: the time between calls to the function, in seconds
4716 * @function: function to call
4717 * @data: data to pass to @function
4719 * Sets a function to be called at regular intervals with the default
4720 * priority, #G_PRIORITY_DEFAULT. The function is called repeatedly until
4721 * it returns %FALSE, at which point the timeout is automatically destroyed
4722 * and the function will not be called again.
4724 * This internally creates a main loop source using
4725 * g_timeout_source_new_seconds() and attaches it to the main loop context
4726 * using g_source_attach(). You can do these steps manually if you need
4727 * greater control. Also see g_timeout_add_seconds_full().
4729 * Note that the first call of the timer may not be precise for timeouts
4730 * of one second. If you need finer precision and have such a timeout,
4731 * you may want to use g_timeout_add() instead.
4733 * The interval given is in terms of monotonic time, not wall clock
4734 * time. See g_get_monotonic_time().
4736 * Returns: the ID (greater than 0) of the event source.
4738 * Since: 2.14
4740 guint
4741 g_timeout_add_seconds (guint interval,
4742 GSourceFunc function,
4743 gpointer data)
4745 g_return_val_if_fail (function != NULL, 0);
4747 return g_timeout_add_seconds_full (G_PRIORITY_DEFAULT, interval, function, data, NULL);
4750 /* Child watch functions */
4752 #ifdef G_OS_WIN32
4754 static gboolean
4755 g_child_watch_prepare (GSource *source,
4756 gint *timeout)
4758 *timeout = -1;
4759 return FALSE;
4762 static gboolean
4763 g_child_watch_check (GSource *source)
4765 GChildWatchSource *child_watch_source;
4766 gboolean child_exited;
4768 child_watch_source = (GChildWatchSource *) source;
4770 child_exited = child_watch_source->poll.revents & G_IO_IN;
4772 if (child_exited)
4774 DWORD child_status;
4777 * Note: We do _not_ check for the special value of STILL_ACTIVE
4778 * since we know that the process has exited and doing so runs into
4779 * problems if the child process "happens to return STILL_ACTIVE(259)"
4780 * as Microsoft's Platform SDK puts it.
4782 if (!GetExitCodeProcess (child_watch_source->pid, &child_status))
4784 gchar *emsg = g_win32_error_message (GetLastError ());
4785 g_warning (G_STRLOC ": GetExitCodeProcess() failed: %s", emsg);
4786 g_free (emsg);
4788 child_watch_source->child_status = -1;
4790 else
4791 child_watch_source->child_status = child_status;
4794 return child_exited;
4797 static void
4798 g_child_watch_finalize (GSource *source)
4802 #else /* G_OS_WIN32 */
4804 static void
4805 wake_source (GSource *source)
4807 GMainContext *context;
4809 /* This should be thread-safe:
4811 * - if the source is currently being added to a context, that
4812 * context will be woken up anyway
4814 * - if the source is currently being destroyed, we simply need not
4815 * to crash:
4817 * - the memory for the source will remain valid until after the
4818 * source finalize function was called (which would remove the
4819 * source from the global list which we are currently holding the
4820 * lock for)
4822 * - the GMainContext will either be NULL or point to a live
4823 * GMainContext
4825 * - the GMainContext will remain valid since we hold the
4826 * main_context_list lock
4828 * Since we are holding a lot of locks here, don't try to enter any
4829 * more GMainContext functions for fear of dealock -- just hit the
4830 * GWakeup and run. Even if that's safe now, it could easily become
4831 * unsafe with some very minor changes in the future, and signal
4832 * handling is not the most well-tested codepath.
4834 G_LOCK(main_context_list);
4835 context = source->context;
4836 if (context)
4837 g_wakeup_signal (context->wakeup);
4838 G_UNLOCK(main_context_list);
4841 static void
4842 dispatch_unix_signals_unlocked (void)
4844 gboolean pending[NSIG];
4845 GSList *node;
4846 gint i;
4848 /* clear this first incase another one arrives while we're processing */
4849 any_unix_signal_pending = FALSE;
4851 /* We atomically test/clear the bit from the global array in case
4852 * other signals arrive while we are dispatching.
4854 * We then can safely use our own array below without worrying about
4855 * races.
4857 for (i = 0; i < NSIG; i++)
4859 /* Be very careful with (the volatile) unix_signal_pending.
4861 * We must ensure that it's not possible that we clear it without
4862 * handling the signal. We therefore must ensure that our pending
4863 * array has a field set (ie: we will do something about the
4864 * signal) before we clear the item in unix_signal_pending.
4866 * Note specifically: we must check _our_ array.
4868 pending[i] = unix_signal_pending[i];
4869 if (pending[i])
4870 unix_signal_pending[i] = FALSE;
4873 /* handle GChildWatchSource instances */
4874 if (pending[SIGCHLD])
4876 /* The only way we can do this is to scan all of the children.
4878 * The docs promise that we will not reap children that we are not
4879 * explicitly watching, so that ties our hands from calling
4880 * waitpid(-1). We also can't use siginfo's si_pid field since if
4881 * multiple SIGCHLD arrive at the same time, one of them can be
4882 * dropped (since a given UNIX signal can only be pending once).
4884 for (node = unix_child_watches; node; node = node->next)
4886 GChildWatchSource *source = node->data;
4888 if (!source->child_exited)
4890 pid_t pid;
4893 g_assert (source->pid > 0);
4895 pid = waitpid (source->pid, &source->child_status, WNOHANG);
4896 if (pid > 0)
4898 source->child_exited = TRUE;
4899 wake_source ((GSource *) source);
4901 else if (pid == -1 && errno == ECHILD)
4903 g_warning ("GChildWatchSource: Exit status of a child process was requested but ECHILD was received by waitpid(). Most likely the process is ignoring SIGCHLD, or some other thread is invoking waitpid() with a nonpositive first argument; either behavior can break applications that use g_child_watch_add()/g_spawn_sync() either directly or indirectly.");
4904 source->child_exited = TRUE;
4905 source->child_status = 0;
4906 wake_source ((GSource *) source);
4909 while (pid == -1 && errno == EINTR);
4914 /* handle GUnixSignalWatchSource instances */
4915 for (node = unix_signal_watches; node; node = node->next)
4917 GUnixSignalWatchSource *source = node->data;
4919 if (!source->pending)
4921 if (pending[source->signum])
4923 source->pending = TRUE;
4925 wake_source ((GSource *) source);
4932 static void
4933 dispatch_unix_signals (void)
4935 G_LOCK(unix_signal_lock);
4936 dispatch_unix_signals_unlocked ();
4937 G_UNLOCK(unix_signal_lock);
4940 static gboolean
4941 g_child_watch_prepare (GSource *source,
4942 gint *timeout)
4944 GChildWatchSource *child_watch_source;
4946 child_watch_source = (GChildWatchSource *) source;
4948 return child_watch_source->child_exited;
4951 static gboolean
4952 g_child_watch_check (GSource *source)
4954 GChildWatchSource *child_watch_source;
4956 child_watch_source = (GChildWatchSource *) source;
4958 return child_watch_source->child_exited;
4961 static gboolean
4962 g_unix_signal_watch_prepare (GSource *source,
4963 gint *timeout)
4965 GUnixSignalWatchSource *unix_signal_source;
4967 unix_signal_source = (GUnixSignalWatchSource *) source;
4969 return unix_signal_source->pending;
4972 static gboolean
4973 g_unix_signal_watch_check (GSource *source)
4975 GUnixSignalWatchSource *unix_signal_source;
4977 unix_signal_source = (GUnixSignalWatchSource *) source;
4979 return unix_signal_source->pending;
4982 static gboolean
4983 g_unix_signal_watch_dispatch (GSource *source,
4984 GSourceFunc callback,
4985 gpointer user_data)
4987 GUnixSignalWatchSource *unix_signal_source;
4988 gboolean again;
4990 unix_signal_source = (GUnixSignalWatchSource *) source;
4992 if (!callback)
4994 g_warning ("Unix signal source dispatched without callback\n"
4995 "You must call g_source_set_callback().");
4996 return FALSE;
4999 again = (callback) (user_data);
5001 unix_signal_source->pending = FALSE;
5003 return again;
5006 static void
5007 ref_unix_signal_handler_unlocked (int signum)
5009 /* Ensure we have the worker context */
5010 g_get_worker_context ();
5011 unix_signal_refcount[signum]++;
5012 if (unix_signal_refcount[signum] == 1)
5014 struct sigaction action;
5015 action.sa_handler = g_unix_signal_handler;
5016 sigemptyset (&action.sa_mask);
5017 #ifdef SA_RESTART
5018 action.sa_flags = SA_RESTART | SA_NOCLDSTOP;
5019 #else
5020 action.sa_flags = SA_NOCLDSTOP;
5021 #endif
5022 sigaction (signum, &action, NULL);
5026 static void
5027 unref_unix_signal_handler_unlocked (int signum)
5029 unix_signal_refcount[signum]--;
5030 if (unix_signal_refcount[signum] == 0)
5032 struct sigaction action;
5033 memset (&action, 0, sizeof (action));
5034 action.sa_handler = SIG_DFL;
5035 sigemptyset (&action.sa_mask);
5036 sigaction (signum, &action, NULL);
5040 GSource *
5041 _g_main_create_unix_signal_watch (int signum)
5043 GSource *source;
5044 GUnixSignalWatchSource *unix_signal_source;
5046 source = g_source_new (&g_unix_signal_funcs, sizeof (GUnixSignalWatchSource));
5047 unix_signal_source = (GUnixSignalWatchSource *) source;
5049 unix_signal_source->signum = signum;
5050 unix_signal_source->pending = FALSE;
5052 G_LOCK (unix_signal_lock);
5053 ref_unix_signal_handler_unlocked (signum);
5054 unix_signal_watches = g_slist_prepend (unix_signal_watches, unix_signal_source);
5055 dispatch_unix_signals_unlocked ();
5056 G_UNLOCK (unix_signal_lock);
5058 return source;
5061 static void
5062 g_unix_signal_watch_finalize (GSource *source)
5064 GUnixSignalWatchSource *unix_signal_source;
5066 unix_signal_source = (GUnixSignalWatchSource *) source;
5068 G_LOCK (unix_signal_lock);
5069 unref_unix_signal_handler_unlocked (unix_signal_source->signum);
5070 unix_signal_watches = g_slist_remove (unix_signal_watches, source);
5071 G_UNLOCK (unix_signal_lock);
5074 static void
5075 g_child_watch_finalize (GSource *source)
5077 G_LOCK (unix_signal_lock);
5078 unix_child_watches = g_slist_remove (unix_child_watches, source);
5079 unref_unix_signal_handler_unlocked (SIGCHLD);
5080 G_UNLOCK (unix_signal_lock);
5083 #endif /* G_OS_WIN32 */
5085 static gboolean
5086 g_child_watch_dispatch (GSource *source,
5087 GSourceFunc callback,
5088 gpointer user_data)
5090 GChildWatchSource *child_watch_source;
5091 GChildWatchFunc child_watch_callback = (GChildWatchFunc) callback;
5093 child_watch_source = (GChildWatchSource *) source;
5095 if (!callback)
5097 g_warning ("Child watch source dispatched without callback\n"
5098 "You must call g_source_set_callback().");
5099 return FALSE;
5102 (child_watch_callback) (child_watch_source->pid, child_watch_source->child_status, user_data);
5104 /* We never keep a child watch source around as the child is gone */
5105 return FALSE;
5108 #ifndef G_OS_WIN32
5110 static void
5111 g_unix_signal_handler (int signum)
5113 unix_signal_pending[signum] = TRUE;
5114 any_unix_signal_pending = TRUE;
5116 g_wakeup_signal (glib_worker_context->wakeup);
5119 #endif /* !G_OS_WIN32 */
5122 * g_child_watch_source_new:
5123 * @pid: process to watch. On POSIX the positive pid of a child process. On
5124 * Windows a handle for a process (which doesn't have to be a child).
5126 * Creates a new child_watch source.
5128 * The source will not initially be associated with any #GMainContext
5129 * and must be added to one with g_source_attach() before it will be
5130 * executed.
5132 * Note that child watch sources can only be used in conjunction with
5133 * `g_spawn...` when the %G_SPAWN_DO_NOT_REAP_CHILD flag is used.
5135 * Note that on platforms where #GPid must be explicitly closed
5136 * (see g_spawn_close_pid()) @pid must not be closed while the
5137 * source is still active. Typically, you will want to call
5138 * g_spawn_close_pid() in the callback function for the source.
5140 * Note further that using g_child_watch_source_new() is not
5141 * compatible with calling `waitpid` with a nonpositive first
5142 * argument in the application. Calling waitpid() for individual
5143 * pids will still work fine.
5145 * Similarly, on POSIX platforms, the @pid passed to this function must
5146 * be greater than 0 (i.e. this function must wait for a specific child,
5147 * and cannot wait for one of many children by using a nonpositive argument).
5149 * Returns: the newly-created child watch source
5151 * Since: 2.4
5153 GSource *
5154 g_child_watch_source_new (GPid pid)
5156 GSource *source;
5157 GChildWatchSource *child_watch_source;
5159 #ifndef G_OS_WIN32
5160 g_return_val_if_fail (pid > 0, NULL);
5161 #endif
5163 source = g_source_new (&g_child_watch_funcs, sizeof (GChildWatchSource));
5164 child_watch_source = (GChildWatchSource *)source;
5166 child_watch_source->pid = pid;
5168 #ifdef G_OS_WIN32
5169 child_watch_source->poll.fd = (gintptr) pid;
5170 child_watch_source->poll.events = G_IO_IN;
5172 g_source_add_poll (source, &child_watch_source->poll);
5173 #else /* G_OS_WIN32 */
5174 G_LOCK (unix_signal_lock);
5175 ref_unix_signal_handler_unlocked (SIGCHLD);
5176 unix_child_watches = g_slist_prepend (unix_child_watches, child_watch_source);
5177 if (waitpid (pid, &child_watch_source->child_status, WNOHANG) > 0)
5178 child_watch_source->child_exited = TRUE;
5179 G_UNLOCK (unix_signal_lock);
5180 #endif /* G_OS_WIN32 */
5182 return source;
5186 * g_child_watch_add_full:
5187 * @priority: the priority of the idle source. Typically this will be in the
5188 * range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE.
5189 * @pid: process to watch. On POSIX the positive pid of a child process. On
5190 * Windows a handle for a process (which doesn't have to be a child).
5191 * @function: function to call
5192 * @data: data to pass to @function
5193 * @notify: (allow-none): function to call when the idle is removed, or %NULL
5195 * Sets a function to be called when the child indicated by @pid
5196 * exits, at the priority @priority.
5198 * If you obtain @pid from g_spawn_async() or g_spawn_async_with_pipes()
5199 * you will need to pass #G_SPAWN_DO_NOT_REAP_CHILD as flag to
5200 * the spawn function for the child watching to work.
5202 * In many programs, you will want to call g_spawn_check_exit_status()
5203 * in the callback to determine whether or not the child exited
5204 * successfully.
5206 * Also, note that on platforms where #GPid must be explicitly closed
5207 * (see g_spawn_close_pid()) @pid must not be closed while the source
5208 * is still active. Typically, you should invoke g_spawn_close_pid()
5209 * in the callback function for the source.
5211 * GLib supports only a single callback per process id.
5213 * This internally creates a main loop source using
5214 * g_child_watch_source_new() and attaches it to the main loop context
5215 * using g_source_attach(). You can do these steps manually if you
5216 * need greater control.
5218 * Returns: the ID (greater than 0) of the event source.
5220 * Rename to: g_child_watch_add
5221 * Since: 2.4
5223 guint
5224 g_child_watch_add_full (gint priority,
5225 GPid pid,
5226 GChildWatchFunc function,
5227 gpointer data,
5228 GDestroyNotify notify)
5230 GSource *source;
5231 guint id;
5233 g_return_val_if_fail (function != NULL, 0);
5234 #ifndef G_OS_WIN32
5235 g_return_val_if_fail (pid > 0, 0);
5236 #endif
5238 source = g_child_watch_source_new (pid);
5240 if (priority != G_PRIORITY_DEFAULT)
5241 g_source_set_priority (source, priority);
5243 g_source_set_callback (source, (GSourceFunc) function, data, notify);
5244 id = g_source_attach (source, NULL);
5245 g_source_unref (source);
5247 return id;
5251 * g_child_watch_add:
5252 * @pid: process id to watch. On POSIX the positive pid of a child
5253 * process. On Windows a handle for a process (which doesn't have to be
5254 * a child).
5255 * @function: function to call
5256 * @data: data to pass to @function
5258 * Sets a function to be called when the child indicated by @pid
5259 * exits, at a default priority, #G_PRIORITY_DEFAULT.
5261 * If you obtain @pid from g_spawn_async() or g_spawn_async_with_pipes()
5262 * you will need to pass #G_SPAWN_DO_NOT_REAP_CHILD as flag to
5263 * the spawn function for the child watching to work.
5265 * Note that on platforms where #GPid must be explicitly closed
5266 * (see g_spawn_close_pid()) @pid must not be closed while the
5267 * source is still active. Typically, you will want to call
5268 * g_spawn_close_pid() in the callback function for the source.
5270 * GLib supports only a single callback per process id.
5272 * This internally creates a main loop source using
5273 * g_child_watch_source_new() and attaches it to the main loop context
5274 * using g_source_attach(). You can do these steps manually if you
5275 * need greater control.
5277 * Returns: the ID (greater than 0) of the event source.
5279 * Since: 2.4
5281 guint
5282 g_child_watch_add (GPid pid,
5283 GChildWatchFunc function,
5284 gpointer data)
5286 return g_child_watch_add_full (G_PRIORITY_DEFAULT, pid, function, data, NULL);
5290 /* Idle functions */
5292 static gboolean
5293 g_idle_prepare (GSource *source,
5294 gint *timeout)
5296 *timeout = 0;
5298 return TRUE;
5301 static gboolean
5302 g_idle_check (GSource *source)
5304 return TRUE;
5307 static gboolean
5308 g_idle_dispatch (GSource *source,
5309 GSourceFunc callback,
5310 gpointer user_data)
5312 if (!callback)
5314 g_warning ("Idle source dispatched without callback\n"
5315 "You must call g_source_set_callback().");
5316 return FALSE;
5319 return callback (user_data);
5323 * g_idle_source_new:
5325 * Creates a new idle source.
5327 * The source will not initially be associated with any #GMainContext
5328 * and must be added to one with g_source_attach() before it will be
5329 * executed. Note that the default priority for idle sources is
5330 * %G_PRIORITY_DEFAULT_IDLE, as compared to other sources which
5331 * have a default priority of %G_PRIORITY_DEFAULT.
5333 * Returns: the newly-created idle source
5335 GSource *
5336 g_idle_source_new (void)
5338 GSource *source;
5340 source = g_source_new (&g_idle_funcs, sizeof (GSource));
5341 g_source_set_priority (source, G_PRIORITY_DEFAULT_IDLE);
5343 return source;
5347 * g_idle_add_full:
5348 * @priority: the priority of the idle source. Typically this will be in the
5349 * range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE.
5350 * @function: function to call
5351 * @data: data to pass to @function
5352 * @notify: (allow-none): function to call when the idle is removed, or %NULL
5354 * Adds a function to be called whenever there are no higher priority
5355 * events pending. If the function returns %FALSE it is automatically
5356 * removed from the list of event sources and will not be called again.
5358 * This internally creates a main loop source using g_idle_source_new()
5359 * and attaches it to the main loop context using g_source_attach().
5360 * You can do these steps manually if you need greater control.
5362 * Returns: the ID (greater than 0) of the event source.
5363 * Rename to: g_idle_add
5365 guint
5366 g_idle_add_full (gint priority,
5367 GSourceFunc function,
5368 gpointer data,
5369 GDestroyNotify notify)
5371 GSource *source;
5372 guint id;
5374 g_return_val_if_fail (function != NULL, 0);
5376 source = g_idle_source_new ();
5378 if (priority != G_PRIORITY_DEFAULT_IDLE)
5379 g_source_set_priority (source, priority);
5381 g_source_set_callback (source, function, data, notify);
5382 id = g_source_attach (source, NULL);
5383 g_source_unref (source);
5385 return id;
5389 * g_idle_add:
5390 * @function: function to call
5391 * @data: data to pass to @function.
5393 * Adds a function to be called whenever there are no higher priority
5394 * events pending to the default main loop. The function is given the
5395 * default idle priority, #G_PRIORITY_DEFAULT_IDLE. If the function
5396 * returns %FALSE it is automatically removed from the list of event
5397 * sources and will not be called again.
5399 * This internally creates a main loop source using g_idle_source_new()
5400 * and attaches it to the main loop context using g_source_attach().
5401 * You can do these steps manually if you need greater control.
5403 * Returns: the ID (greater than 0) of the event source.
5405 guint
5406 g_idle_add (GSourceFunc function,
5407 gpointer data)
5409 return g_idle_add_full (G_PRIORITY_DEFAULT_IDLE, function, data, NULL);
5413 * g_idle_remove_by_data:
5414 * @data: the data for the idle source's callback.
5416 * Removes the idle function with the given data.
5418 * Returns: %TRUE if an idle source was found and removed.
5420 gboolean
5421 g_idle_remove_by_data (gpointer data)
5423 return g_source_remove_by_funcs_user_data (&g_idle_funcs, data);
5427 * g_main_context_invoke:
5428 * @context: (allow-none): a #GMainContext, or %NULL
5429 * @function: function to call
5430 * @data: data to pass to @function
5432 * Invokes a function in such a way that @context is owned during the
5433 * invocation of @function.
5435 * If @context is %NULL then the global default main context — as
5436 * returned by g_main_context_default() — is used.
5438 * If @context is owned by the current thread, @function is called
5439 * directly. Otherwise, if @context is the thread-default main context
5440 * of the current thread and g_main_context_acquire() succeeds, then
5441 * @function is called and g_main_context_release() is called
5442 * afterwards.
5444 * In any other case, an idle source is created to call @function and
5445 * that source is attached to @context (presumably to be run in another
5446 * thread). The idle source is attached with #G_PRIORITY_DEFAULT
5447 * priority. If you want a different priority, use
5448 * g_main_context_invoke_full().
5450 * Note that, as with normal idle functions, @function should probably
5451 * return %FALSE. If it returns %TRUE, it will be continuously run in a
5452 * loop (and may prevent this call from returning).
5454 * Since: 2.28
5456 void
5457 g_main_context_invoke (GMainContext *context,
5458 GSourceFunc function,
5459 gpointer data)
5461 g_main_context_invoke_full (context,
5462 G_PRIORITY_DEFAULT,
5463 function, data, NULL);
5467 * g_main_context_invoke_full:
5468 * @context: (allow-none): a #GMainContext, or %NULL
5469 * @priority: the priority at which to run @function
5470 * @function: function to call
5471 * @data: data to pass to @function
5472 * @notify: (allow-none): a function to call when @data is no longer in use, or %NULL.
5474 * Invokes a function in such a way that @context is owned during the
5475 * invocation of @function.
5477 * This function is the same as g_main_context_invoke() except that it
5478 * lets you specify the priority incase @function ends up being
5479 * scheduled as an idle and also lets you give a #GDestroyNotify for @data.
5481 * @notify should not assume that it is called from any particular
5482 * thread or with any particular context acquired.
5484 * Since: 2.28
5486 void
5487 g_main_context_invoke_full (GMainContext *context,
5488 gint priority,
5489 GSourceFunc function,
5490 gpointer data,
5491 GDestroyNotify notify)
5493 g_return_if_fail (function != NULL);
5495 if (!context)
5496 context = g_main_context_default ();
5498 if (g_main_context_is_owner (context))
5500 while (function (data));
5501 if (notify != NULL)
5502 notify (data);
5505 else
5507 GMainContext *thread_default;
5509 thread_default = g_main_context_get_thread_default ();
5511 if (!thread_default)
5512 thread_default = g_main_context_default ();
5514 if (thread_default == context && g_main_context_acquire (context))
5516 while (function (data));
5518 g_main_context_release (context);
5520 if (notify != NULL)
5521 notify (data);
5523 else
5525 GSource *source;
5527 source = g_idle_source_new ();
5528 g_source_set_priority (source, priority);
5529 g_source_set_callback (source, function, data, notify);
5530 g_source_attach (source, context);
5531 g_source_unref (source);
5536 static gpointer
5537 glib_worker_main (gpointer data)
5539 while (TRUE)
5541 g_main_context_iteration (glib_worker_context, TRUE);
5543 #ifdef G_OS_UNIX
5544 if (any_unix_signal_pending)
5545 dispatch_unix_signals ();
5546 #endif
5549 return NULL; /* worst GCC warning message ever... */
5552 GMainContext *
5553 g_get_worker_context (void)
5555 static gsize initialised;
5557 if (g_once_init_enter (&initialised))
5559 /* mask all signals in the worker thread */
5560 #ifdef G_OS_UNIX
5561 sigset_t prev_mask;
5562 sigset_t all;
5564 sigfillset (&all);
5565 pthread_sigmask (SIG_SETMASK, &all, &prev_mask);
5566 #endif
5567 glib_worker_context = g_main_context_new ();
5568 g_thread_new ("gmain", glib_worker_main, NULL);
5569 #ifdef G_OS_UNIX
5570 pthread_sigmask (SIG_SETMASK, &prev_mask, NULL);
5571 #endif
5572 g_once_init_leave (&initialised, TRUE);
5575 return glib_worker_context;