Use GTestDBus in all GDBus unit tests
[glib.git] / glib / gmain.c
blob760f1792b32317dce0b40d28349af1e0554d3e5b
1 /* GLIB - Library of useful routines for C programming
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * gmain.c: Main loop abstraction, timeouts, and idle functions
5 * Copyright 1998 Owen Taylor
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, USA.
24 * Modified by the GLib Team and others 1997-2000. See the AUTHORS
25 * file for a list of people on the GLib Team. See the ChangeLog
26 * files for a list of changes. These files are distributed with
27 * GLib at ftp://ftp.gtk.org/pub/gtk/.
31 * MT safe
34 #include "config.h"
35 #include "glibconfig.h"
37 /* Uncomment the next line (and the corresponding line in gpoll.c) to
38 * enable debugging printouts if the environment variable
39 * G_MAIN_POLL_DEBUG is set to some value.
41 /* #define G_MAIN_POLL_DEBUG */
43 #ifdef _WIN32
44 /* Always enable debugging printout on Windows, as it is more often
45 * needed there...
47 #define G_MAIN_POLL_DEBUG
48 #endif
50 #ifdef G_OS_UNIX
51 #include "glib-unix.h"
52 #include <pthread.h>
53 #ifdef HAVE_EVENTFD
54 #include <sys/eventfd.h>
55 #endif
56 #endif
58 #include <signal.h>
59 #include <sys/types.h>
60 #include <time.h>
61 #include <stdlib.h>
62 #ifdef HAVE_SYS_TIME_H
63 #include <sys/time.h>
64 #endif /* HAVE_SYS_TIME_H */
65 #ifdef HAVE_UNISTD_H
66 #include <unistd.h>
67 #endif /* HAVE_UNISTD_H */
68 #include <errno.h>
69 #include <string.h>
71 #ifdef G_OS_WIN32
72 #define STRICT
73 #include <windows.h>
74 #endif /* G_OS_WIN32 */
76 #ifdef G_OS_BEOS
77 #include <sys/socket.h>
78 #include <sys/wait.h>
79 #endif /* G_OS_BEOS */
81 #include "gmain.h"
83 #include "garray.h"
84 #include "giochannel.h"
85 #include "ghash.h"
86 #include "ghook.h"
87 #include "gqueue.h"
88 #include "gstrfuncs.h"
89 #include "gtestutils.h"
91 #ifdef G_OS_WIN32
92 #include "gwin32.h"
93 #endif
95 #ifdef G_MAIN_POLL_DEBUG
96 #include "gtimer.h"
97 #endif
99 #include "gwakeup.h"
100 #include "gmain-internal.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 * <refsect2><title>Creating new source types</title>
144 * <para>One of the unusual features of the #GMainLoop functionality
145 * is that new types of event source can be created and used in
146 * addition to the builtin type of event source. A new event source
147 * type is used for handling GDK events. A new source type is created
148 * by <firstterm>deriving</firstterm> from the #GSource structure.
149 * The derived type of source is represented by a structure that has
150 * the #GSource structure as a first element, and other elements specific
151 * to the new source type. To create an instance of the new source type,
152 * call g_source_new() passing in the size of the derived structure and
153 * a table of functions. These #GSourceFuncs determine the behavior of
154 * the new source type.</para>
155 * <para>New source types basically interact with the main context
156 * in two ways. Their prepare function in #GSourceFuncs can set a timeout
157 * to determine the maximum amount of time that the main loop will sleep
158 * before checking the source again. In addition, or as well, the source
159 * can add file descriptors to the set that the main context checks using
160 * g_source_add_poll().</para>
161 * </refsect2>
162 * <refsect2><title>Customizing the main loop iteration</title>
163 * <para>Single iterations of a #GMainContext can be run with
164 * g_main_context_iteration(). In some cases, more detailed control
165 * of exactly how the details of the main loop work is desired, for
166 * instance, when integrating the #GMainLoop with an external main loop.
167 * In such cases, you can call the component functions of
168 * g_main_context_iteration() directly. These functions are
169 * g_main_context_prepare(), g_main_context_query(),
170 * g_main_context_check() and g_main_context_dispatch().</para>
171 * <para>The operation of these functions can best be seen in terms
172 * of a state diagram, as shown in <xref linkend="mainloop-states"/>.</para>
173 * <figure id="mainloop-states"><title>States of a Main Context</title>
174 * <graphic fileref="mainloop-states.gif" format="GIF"></graphic>
175 * </figure>
176 * </refsect2>
178 * On Unix, the GLib mainloop is incompatible with fork(). Any program
179 * using the mainloop must either exec() or exit() from the child
180 * without returning to the mainloop.
183 /* Types */
185 typedef struct _GTimeoutSource GTimeoutSource;
186 typedef struct _GChildWatchSource GChildWatchSource;
187 typedef struct _GUnixSignalWatchSource GUnixSignalWatchSource;
188 typedef struct _GPollRec GPollRec;
189 typedef struct _GSourceCallback GSourceCallback;
191 typedef enum
193 G_SOURCE_READY = 1 << G_HOOK_FLAG_USER_SHIFT,
194 G_SOURCE_CAN_RECURSE = 1 << (G_HOOK_FLAG_USER_SHIFT + 1),
195 G_SOURCE_BLOCKED = 1 << (G_HOOK_FLAG_USER_SHIFT + 2)
196 } GSourceFlags;
198 typedef struct _GMainWaiter GMainWaiter;
200 struct _GMainWaiter
202 GCond *cond;
203 GMutex *mutex;
206 typedef struct _GMainDispatch GMainDispatch;
208 struct _GMainDispatch
210 gint depth;
211 GSList *dispatching_sources; /* stack of current sources */
214 #ifdef G_MAIN_POLL_DEBUG
215 gboolean _g_main_poll_debug = FALSE;
216 #endif
218 struct _GMainContext
220 /* The following lock is used for both the list of sources
221 * and the list of poll records
223 GMutex mutex;
224 GCond cond;
225 GThread *owner;
226 guint owner_count;
227 GSList *waiters;
229 gint ref_count;
231 GPtrArray *pending_dispatches;
232 gint timeout; /* Timeout for current iteration */
234 guint next_id;
235 GSource *source_list;
236 gint in_check_or_prepare;
238 GPollRec *poll_records, *poll_records_tail;
239 guint n_poll_records;
240 GPollFD *cached_poll_array;
241 guint cached_poll_array_size;
243 GWakeup *wakeup;
245 GPollFD wake_up_rec;
247 /* Flag indicating whether the set of fd's changed during a poll */
248 gboolean poll_changed;
250 GPollFunc poll_func;
252 gint64 time;
253 gboolean time_is_fresh;
256 struct _GSourceCallback
258 guint ref_count;
259 GSourceFunc func;
260 gpointer data;
261 GDestroyNotify notify;
264 struct _GMainLoop
266 GMainContext *context;
267 gboolean is_running;
268 gint ref_count;
271 struct _GTimeoutSource
273 GSource source;
274 gint64 expiration;
275 guint interval;
276 gboolean seconds;
279 struct _GChildWatchSource
281 GSource source;
282 GPid pid;
283 gint child_status;
284 #ifdef G_OS_WIN32
285 GPollFD poll;
286 #else /* G_OS_WIN32 */
287 gboolean child_exited;
288 #endif /* G_OS_WIN32 */
291 struct _GUnixSignalWatchSource
293 GSource source;
294 int signum;
295 gboolean pending;
298 struct _GPollRec
300 GPollFD *fd;
301 GPollRec *prev;
302 GPollRec *next;
303 gint priority;
306 struct _GSourcePrivate
308 GSList *child_sources;
309 GSource *parent_source;
312 #define LOCK_CONTEXT(context) g_mutex_lock (&context->mutex)
313 #define UNLOCK_CONTEXT(context) g_mutex_unlock (&context->mutex)
314 #define G_THREAD_SELF g_thread_self ()
316 #define SOURCE_DESTROYED(source) (((source)->flags & G_HOOK_FLAG_ACTIVE) == 0)
317 #define SOURCE_BLOCKED(source) (((source)->flags & G_SOURCE_BLOCKED) != 0)
319 #define SOURCE_UNREF(source, context) \
320 G_STMT_START { \
321 if ((source)->ref_count > 1) \
322 (source)->ref_count--; \
323 else \
324 g_source_unref_internal ((source), (context), TRUE); \
325 } G_STMT_END
328 /* Forward declarations */
330 static void g_source_unref_internal (GSource *source,
331 GMainContext *context,
332 gboolean have_lock);
333 static void g_source_destroy_internal (GSource *source,
334 GMainContext *context,
335 gboolean have_lock);
336 static void g_source_set_priority_unlocked (GSource *source,
337 GMainContext *context,
338 gint priority);
339 static void g_main_context_poll (GMainContext *context,
340 gint timeout,
341 gint priority,
342 GPollFD *fds,
343 gint n_fds);
344 static void g_main_context_add_poll_unlocked (GMainContext *context,
345 gint priority,
346 GPollFD *fd);
347 static void g_main_context_remove_poll_unlocked (GMainContext *context,
348 GPollFD *fd);
350 static gboolean g_timeout_prepare (GSource *source,
351 gint *timeout);
352 static gboolean g_timeout_check (GSource *source);
353 static gboolean g_timeout_dispatch (GSource *source,
354 GSourceFunc callback,
355 gpointer user_data);
356 static gboolean g_child_watch_prepare (GSource *source,
357 gint *timeout);
358 static gboolean g_child_watch_check (GSource *source);
359 static gboolean g_child_watch_dispatch (GSource *source,
360 GSourceFunc callback,
361 gpointer user_data);
362 static void g_child_watch_finalize (GSource *source);
363 #ifdef G_OS_UNIX
364 static void g_unix_signal_handler (int signum);
365 static gboolean g_unix_signal_watch_prepare (GSource *source,
366 gint *timeout);
367 static gboolean g_unix_signal_watch_check (GSource *source);
368 static gboolean g_unix_signal_watch_dispatch (GSource *source,
369 GSourceFunc callback,
370 gpointer user_data);
371 static void g_unix_signal_watch_finalize (GSource *source);
372 #endif
373 static gboolean g_idle_prepare (GSource *source,
374 gint *timeout);
375 static gboolean g_idle_check (GSource *source);
376 static gboolean g_idle_dispatch (GSource *source,
377 GSourceFunc callback,
378 gpointer user_data);
380 static GMainContext *glib_worker_context;
382 G_LOCK_DEFINE_STATIC (main_loop);
383 static GMainContext *default_main_context;
385 #ifndef G_OS_WIN32
388 /* UNIX signals work by marking one of these variables then waking the
389 * worker context to check on them and dispatch accordingly.
391 #ifdef HAVE_SIG_ATOMIC_T
392 static volatile sig_atomic_t unix_signal_pending[NSIG];
393 static volatile sig_atomic_t any_unix_signal_pending;
394 #else
395 static volatile int unix_signal_pending[NSIG];
396 static volatile int any_unix_signal_pending;
397 #endif
399 /* Guards all the data below */
400 G_LOCK_DEFINE_STATIC (unix_signal_lock);
401 static GSList *unix_signal_watches;
402 static GSList *unix_child_watches;
404 static GSourceFuncs g_unix_signal_funcs =
406 g_unix_signal_watch_prepare,
407 g_unix_signal_watch_check,
408 g_unix_signal_watch_dispatch,
409 g_unix_signal_watch_finalize
411 #endif /* !G_OS_WIN32 */
412 G_LOCK_DEFINE_STATIC (main_context_list);
413 static GSList *main_context_list = NULL;
415 GSourceFuncs g_timeout_funcs =
417 g_timeout_prepare,
418 g_timeout_check,
419 g_timeout_dispatch,
420 NULL
423 GSourceFuncs g_child_watch_funcs =
425 g_child_watch_prepare,
426 g_child_watch_check,
427 g_child_watch_dispatch,
428 g_child_watch_finalize
431 GSourceFuncs g_idle_funcs =
433 g_idle_prepare,
434 g_idle_check,
435 g_idle_dispatch,
436 NULL
440 * g_main_context_ref:
441 * @context: a #GMainContext
443 * Increases the reference count on a #GMainContext object by one.
445 * Returns: the @context that was passed in (since 2.6)
447 GMainContext *
448 g_main_context_ref (GMainContext *context)
450 g_return_val_if_fail (context != NULL, NULL);
451 g_return_val_if_fail (g_atomic_int_get (&context->ref_count) > 0, NULL);
453 g_atomic_int_inc (&context->ref_count);
455 return context;
458 static inline void
459 poll_rec_list_free (GMainContext *context,
460 GPollRec *list)
462 g_slice_free_chain (GPollRec, list, next);
466 * g_main_context_unref:
467 * @context: a #GMainContext
469 * Decreases the reference count on a #GMainContext object by one. If
470 * the result is zero, free the context and free all associated memory.
472 void
473 g_main_context_unref (GMainContext *context)
475 GSource *source;
476 g_return_if_fail (context != NULL);
477 g_return_if_fail (g_atomic_int_get (&context->ref_count) > 0);
479 if (!g_atomic_int_dec_and_test (&context->ref_count))
480 return;
482 G_LOCK (main_context_list);
483 main_context_list = g_slist_remove (main_context_list, context);
484 G_UNLOCK (main_context_list);
486 source = context->source_list;
487 while (source)
489 GSource *next = source->next;
490 g_source_destroy_internal (source, context, FALSE);
491 source = next;
494 g_mutex_clear (&context->mutex);
496 g_ptr_array_free (context->pending_dispatches, TRUE);
497 g_free (context->cached_poll_array);
499 poll_rec_list_free (context, context->poll_records);
501 g_wakeup_free (context->wakeup);
502 g_cond_clear (&context->cond);
504 g_free (context);
508 * g_main_context_new:
510 * Creates a new #GMainContext structure.
512 * Return value: the new #GMainContext
514 GMainContext *
515 g_main_context_new (void)
517 static gsize initialised;
518 GMainContext *context;
520 if (g_once_init_enter (&initialised))
522 #ifdef G_MAIN_POLL_DEBUG
523 if (getenv ("G_MAIN_POLL_DEBUG") != NULL)
524 _g_main_poll_debug = TRUE;
525 #endif
527 g_once_init_leave (&initialised, TRUE);
530 context = g_new0 (GMainContext, 1);
532 g_mutex_init (&context->mutex);
533 g_cond_init (&context->cond);
535 context->owner = NULL;
536 context->waiters = NULL;
538 context->ref_count = 1;
540 context->next_id = 1;
542 context->source_list = NULL;
544 context->poll_func = g_poll;
546 context->cached_poll_array = NULL;
547 context->cached_poll_array_size = 0;
549 context->pending_dispatches = g_ptr_array_new ();
551 context->time_is_fresh = FALSE;
553 context->wakeup = g_wakeup_new ();
554 g_wakeup_get_pollfd (context->wakeup, &context->wake_up_rec);
555 g_main_context_add_poll_unlocked (context, 0, &context->wake_up_rec);
557 G_LOCK (main_context_list);
558 main_context_list = g_slist_append (main_context_list, context);
560 #ifdef G_MAIN_POLL_DEBUG
561 if (_g_main_poll_debug)
562 g_print ("created context=%p\n", context);
563 #endif
565 G_UNLOCK (main_context_list);
567 return context;
571 * g_main_context_default:
573 * Returns the global default main context. This is the main context
574 * used for main loop functions when a main loop is not explicitly
575 * specified, and corresponds to the "main" main loop. See also
576 * g_main_context_get_thread_default().
578 * Return value: (transfer none): the global default main context.
580 GMainContext *
581 g_main_context_default (void)
583 /* Slow, but safe */
585 G_LOCK (main_loop);
587 if (!default_main_context)
589 default_main_context = g_main_context_new ();
590 #ifdef G_MAIN_POLL_DEBUG
591 if (_g_main_poll_debug)
592 g_print ("default context=%p\n", default_main_context);
593 #endif
596 G_UNLOCK (main_loop);
598 return default_main_context;
601 static void
602 free_context (gpointer data)
604 GMainContext *context = data;
606 g_main_context_release (context);
607 if (context)
608 g_main_context_unref (context);
611 static void
612 free_context_stack (gpointer data)
614 g_queue_free_full((GQueue *) data, (GDestroyNotify) free_context);
617 static GPrivate thread_context_stack = G_PRIVATE_INIT (free_context_stack);
620 * g_main_context_push_thread_default:
621 * @context: (allow-none): a #GMainContext, or %NULL for the global default context
623 * Acquires @context and sets it as the thread-default context for the
624 * current thread. This will cause certain asynchronous operations
625 * (such as most <link linkend="gio">gio</link>-based I/O) which are
626 * started in this thread to run under @context and deliver their
627 * results to its main loop, rather than running under the global
628 * default context in the main thread. Note that calling this function
629 * changes the context returned by
630 * g_main_context_get_thread_default(), <emphasis>not</emphasis> the
631 * one returned by g_main_context_default(), so it does not affect the
632 * context used by functions like g_idle_add().
634 * Normally you would call this function shortly after creating a new
635 * thread, passing it a #GMainContext which will be run by a
636 * #GMainLoop in that thread, to set a new default context for all
637 * async operations in that thread. (In this case, you don't need to
638 * ever call g_main_context_pop_thread_default().) In some cases
639 * however, you may want to schedule a single operation in a
640 * non-default context, or temporarily use a non-default context in
641 * the main thread. In that case, you can wrap the call to the
642 * asynchronous operation inside a
643 * g_main_context_push_thread_default() /
644 * g_main_context_pop_thread_default() pair, but it is up to you to
645 * ensure that no other asynchronous operations accidentally get
646 * started while the non-default context is active.
648 * Beware that libraries that predate this function may not correctly
649 * handle being used from a thread with a thread-default context. Eg,
650 * see g_file_supports_thread_contexts().
652 * Since: 2.22
654 void
655 g_main_context_push_thread_default (GMainContext *context)
657 GQueue *stack;
658 gboolean acquired_context;
660 acquired_context = g_main_context_acquire (context);
661 g_return_if_fail (acquired_context);
663 if (context == g_main_context_default ())
664 context = NULL;
665 else if (context)
666 g_main_context_ref (context);
668 stack = g_private_get (&thread_context_stack);
669 if (!stack)
671 stack = g_queue_new ();
672 g_private_set (&thread_context_stack, stack);
675 g_queue_push_head (stack, context);
679 * g_main_context_pop_thread_default:
680 * @context: (allow-none): a #GMainContext object, or %NULL
682 * Pops @context off the thread-default context stack (verifying that
683 * it was on the top of the stack).
685 * Since: 2.22
687 void
688 g_main_context_pop_thread_default (GMainContext *context)
690 GQueue *stack;
692 if (context == g_main_context_default ())
693 context = NULL;
695 stack = g_private_get (&thread_context_stack);
697 g_return_if_fail (stack != NULL);
698 g_return_if_fail (g_queue_peek_head (stack) == context);
700 g_queue_pop_head (stack);
702 g_main_context_release (context);
703 if (context)
704 g_main_context_unref (context);
708 * g_main_context_get_thread_default:
710 * Gets the thread-default #GMainContext for this thread. Asynchronous
711 * operations that want to be able to be run in contexts other than
712 * the default one should call this method or
713 * g_main_context_ref_thread_default() to get a #GMainContext to add
714 * their #GSource<!-- -->s to. (Note that even in single-threaded
715 * programs applications may sometimes want to temporarily push a
716 * non-default context, so it is not safe to assume that this will
717 * always return %NULL if you are running in the default thread.)
719 * If you need to hold a reference on the context, use
720 * g_main_context_ref_thread_default() instead.
722 * Returns: (transfer none): the thread-default #GMainContext, or
723 * %NULL if the thread-default context is the global default context.
725 * Since: 2.22
727 GMainContext *
728 g_main_context_get_thread_default (void)
730 GQueue *stack;
732 stack = g_private_get (&thread_context_stack);
733 if (stack)
734 return g_queue_peek_head (stack);
735 else
736 return NULL;
740 * g_main_context_ref_thread_default:
742 * Gets the thread-default #GMainContext for this thread, as with
743 * g_main_context_get_thread_default(), but also adds a reference to
744 * it with g_main_context_ref(). In addition, unlike
745 * g_main_context_get_thread_default(), if the thread-default context
746 * is the global default context, this will return that #GMainContext
747 * (with a ref added to it) rather than returning %NULL.
749 * Returns: (transfer full): the thread-default #GMainContext. Unref
750 * with g_main_context_unref() when you are done with it.
752 * Since: 2.32
754 GMainContext *
755 g_main_context_ref_thread_default (void)
757 GMainContext *context;
759 context = g_main_context_get_thread_default ();
760 if (!context)
761 context = g_main_context_default ();
762 return g_main_context_ref (context);
765 /* Hooks for adding to the main loop */
768 * g_source_new:
769 * @source_funcs: structure containing functions that implement
770 * the sources behavior.
771 * @struct_size: size of the #GSource structure to create.
773 * Creates a new #GSource structure. The size is specified to
774 * allow creating structures derived from #GSource that contain
775 * additional data. The size passed in must be at least
776 * <literal>sizeof (GSource)</literal>.
778 * The source will not initially be associated with any #GMainContext
779 * and must be added to one with g_source_attach() before it will be
780 * executed.
782 * Return value: the newly-created #GSource.
784 GSource *
785 g_source_new (GSourceFuncs *source_funcs,
786 guint struct_size)
788 GSource *source;
790 g_return_val_if_fail (source_funcs != NULL, NULL);
791 g_return_val_if_fail (struct_size >= sizeof (GSource), NULL);
793 source = (GSource*) g_malloc0 (struct_size);
795 source->source_funcs = source_funcs;
796 source->ref_count = 1;
798 source->priority = G_PRIORITY_DEFAULT;
800 source->flags = G_HOOK_FLAG_ACTIVE;
802 /* NULL/0 initialization for all other fields */
804 return source;
807 /* Holds context's lock
809 static void
810 g_source_list_add (GSource *source,
811 GMainContext *context)
813 GSource *tmp_source, *last_source;
815 if (source->priv && source->priv->parent_source)
817 /* Put the source immediately before its parent */
818 tmp_source = source->priv->parent_source;
819 last_source = source->priv->parent_source->prev;
821 else
823 last_source = NULL;
824 tmp_source = context->source_list;
825 while (tmp_source && tmp_source->priority <= source->priority)
827 last_source = tmp_source;
828 tmp_source = tmp_source->next;
832 source->next = tmp_source;
833 if (tmp_source)
834 tmp_source->prev = source;
836 source->prev = last_source;
837 if (last_source)
838 last_source->next = source;
839 else
840 context->source_list = source;
843 /* Holds context's lock
845 static void
846 g_source_list_remove (GSource *source,
847 GMainContext *context)
849 if (source->prev)
850 source->prev->next = source->next;
851 else
852 context->source_list = source->next;
854 if (source->next)
855 source->next->prev = source->prev;
857 source->prev = NULL;
858 source->next = NULL;
861 static guint
862 g_source_attach_unlocked (GSource *source,
863 GMainContext *context)
865 guint result = 0;
866 GSList *tmp_list;
868 source->context = context;
869 result = source->source_id = context->next_id++;
871 source->ref_count++;
872 g_source_list_add (source, context);
874 tmp_list = source->poll_fds;
875 while (tmp_list)
877 g_main_context_add_poll_unlocked (context, source->priority, tmp_list->data);
878 tmp_list = tmp_list->next;
881 if (source->priv)
883 tmp_list = source->priv->child_sources;
884 while (tmp_list)
886 g_source_attach_unlocked (tmp_list->data, context);
887 tmp_list = tmp_list->next;
891 return result;
895 * g_source_attach:
896 * @source: a #GSource
897 * @context: (allow-none): a #GMainContext (if %NULL, the default context will be used)
899 * Adds a #GSource to a @context so that it will be executed within
900 * that context. Remove it by calling g_source_destroy().
902 * Return value: the ID (greater than 0) for the source within the
903 * #GMainContext.
905 guint
906 g_source_attach (GSource *source,
907 GMainContext *context)
909 guint result = 0;
911 g_return_val_if_fail (source->context == NULL, 0);
912 g_return_val_if_fail (!SOURCE_DESTROYED (source), 0);
914 if (!context)
915 context = g_main_context_default ();
917 LOCK_CONTEXT (context);
919 result = g_source_attach_unlocked (source, context);
921 /* If another thread has acquired the context, wake it up since it
922 * might be in poll() right now.
924 if (context->owner && context->owner != G_THREAD_SELF)
925 g_wakeup_signal (context->wakeup);
927 UNLOCK_CONTEXT (context);
929 return result;
932 static void
933 g_source_destroy_internal (GSource *source,
934 GMainContext *context,
935 gboolean have_lock)
937 if (!have_lock)
938 LOCK_CONTEXT (context);
940 if (!SOURCE_DESTROYED (source))
942 GSList *tmp_list;
943 gpointer old_cb_data;
944 GSourceCallbackFuncs *old_cb_funcs;
946 source->flags &= ~G_HOOK_FLAG_ACTIVE;
948 old_cb_data = source->callback_data;
949 old_cb_funcs = source->callback_funcs;
951 source->callback_data = NULL;
952 source->callback_funcs = NULL;
954 if (old_cb_funcs)
956 UNLOCK_CONTEXT (context);
957 old_cb_funcs->unref (old_cb_data);
958 LOCK_CONTEXT (context);
961 if (!SOURCE_BLOCKED (source))
963 tmp_list = source->poll_fds;
964 while (tmp_list)
966 g_main_context_remove_poll_unlocked (context, tmp_list->data);
967 tmp_list = tmp_list->next;
971 if (source->priv && source->priv->child_sources)
973 /* This is safe because even if a child_source finalizer or
974 * closure notify tried to modify source->priv->child_sources
975 * from outside the lock, it would fail since
976 * SOURCE_DESTROYED(source) is now TRUE.
978 tmp_list = source->priv->child_sources;
979 while (tmp_list)
981 g_source_destroy_internal (tmp_list->data, context, TRUE);
982 g_source_unref_internal (tmp_list->data, context, TRUE);
983 tmp_list = tmp_list->next;
985 g_slist_free (source->priv->child_sources);
986 source->priv->child_sources = NULL;
989 g_source_unref_internal (source, context, TRUE);
992 if (!have_lock)
993 UNLOCK_CONTEXT (context);
997 * g_source_destroy:
998 * @source: a #GSource
1000 * Removes a source from its #GMainContext, if any, and mark it as
1001 * destroyed. The source cannot be subsequently added to another
1002 * context.
1004 void
1005 g_source_destroy (GSource *source)
1007 GMainContext *context;
1009 g_return_if_fail (source != NULL);
1011 context = source->context;
1013 if (context)
1014 g_source_destroy_internal (source, context, FALSE);
1015 else
1016 source->flags &= ~G_HOOK_FLAG_ACTIVE;
1020 * g_source_get_id:
1021 * @source: a #GSource
1023 * Returns the numeric ID for a particular source. The ID of a source
1024 * is a positive integer which is unique within a particular main loop
1025 * context. The reverse
1026 * mapping from ID to source is done by g_main_context_find_source_by_id().
1028 * Return value: the ID (greater than 0) for the source
1030 guint
1031 g_source_get_id (GSource *source)
1033 guint result;
1035 g_return_val_if_fail (source != NULL, 0);
1036 g_return_val_if_fail (source->context != NULL, 0);
1038 LOCK_CONTEXT (source->context);
1039 result = source->source_id;
1040 UNLOCK_CONTEXT (source->context);
1042 return result;
1046 * g_source_get_context:
1047 * @source: a #GSource
1049 * Gets the #GMainContext with which the source is associated.
1050 * Calling this function on a destroyed source is an error.
1052 * Return value: (transfer none) (allow-none): the #GMainContext with which the
1053 * source is associated, or %NULL if the context has not
1054 * yet been added to a source.
1056 GMainContext *
1057 g_source_get_context (GSource *source)
1059 g_return_val_if_fail (!SOURCE_DESTROYED (source), NULL);
1061 return source->context;
1065 * g_source_add_poll:
1066 * @source:a #GSource
1067 * @fd: a #GPollFD structure holding information about a file
1068 * descriptor to watch.
1070 * Adds a file descriptor to the set of file descriptors polled for
1071 * this source. This is usually combined with g_source_new() to add an
1072 * event source. The event source's check function will typically test
1073 * the @revents field in the #GPollFD struct and return %TRUE if events need
1074 * to be processed.
1076 void
1077 g_source_add_poll (GSource *source,
1078 GPollFD *fd)
1080 GMainContext *context;
1082 g_return_if_fail (source != NULL);
1083 g_return_if_fail (fd != NULL);
1084 g_return_if_fail (!SOURCE_DESTROYED (source));
1086 context = source->context;
1088 if (context)
1089 LOCK_CONTEXT (context);
1091 source->poll_fds = g_slist_prepend (source->poll_fds, fd);
1093 if (context)
1095 if (!SOURCE_BLOCKED (source))
1096 g_main_context_add_poll_unlocked (context, source->priority, fd);
1097 UNLOCK_CONTEXT (context);
1102 * g_source_remove_poll:
1103 * @source:a #GSource
1104 * @fd: a #GPollFD structure previously passed to g_source_add_poll().
1106 * Removes a file descriptor from the set of file descriptors polled for
1107 * this source.
1109 void
1110 g_source_remove_poll (GSource *source,
1111 GPollFD *fd)
1113 GMainContext *context;
1115 g_return_if_fail (source != NULL);
1116 g_return_if_fail (fd != NULL);
1117 g_return_if_fail (!SOURCE_DESTROYED (source));
1119 context = source->context;
1121 if (context)
1122 LOCK_CONTEXT (context);
1124 source->poll_fds = g_slist_remove (source->poll_fds, fd);
1126 if (context)
1128 if (!SOURCE_BLOCKED (source))
1129 g_main_context_remove_poll_unlocked (context, fd);
1130 UNLOCK_CONTEXT (context);
1135 * g_source_add_child_source:
1136 * @source:a #GSource
1137 * @child_source: a second #GSource that @source should "poll"
1139 * Adds @child_source to @source as a "polled" source; when @source is
1140 * added to a #GMainContext, @child_source will be automatically added
1141 * with the same priority, when @child_source is triggered, it will
1142 * cause @source to dispatch (in addition to calling its own
1143 * callback), and when @source is destroyed, it will destroy
1144 * @child_source as well. (@source will also still be dispatched if
1145 * its own prepare/check functions indicate that it is ready.)
1147 * If you don't need @child_source to do anything on its own when it
1148 * triggers, you can call g_source_set_dummy_callback() on it to set a
1149 * callback that does nothing (except return %TRUE if appropriate).
1151 * @source will hold a reference on @child_source while @child_source
1152 * is attached to it.
1154 * Since: 2.28
1156 void
1157 g_source_add_child_source (GSource *source,
1158 GSource *child_source)
1160 GMainContext *context;
1162 g_return_if_fail (source != NULL);
1163 g_return_if_fail (child_source != NULL);
1164 g_return_if_fail (!SOURCE_DESTROYED (source));
1165 g_return_if_fail (!SOURCE_DESTROYED (child_source));
1166 g_return_if_fail (child_source->context == NULL);
1167 g_return_if_fail (child_source->priv == NULL || child_source->priv->parent_source == NULL);
1169 context = source->context;
1171 if (context)
1172 LOCK_CONTEXT (context);
1174 if (!source->priv)
1175 source->priv = g_slice_new0 (GSourcePrivate);
1176 if (!child_source->priv)
1177 child_source->priv = g_slice_new0 (GSourcePrivate);
1179 source->priv->child_sources = g_slist_prepend (source->priv->child_sources,
1180 g_source_ref (child_source));
1181 child_source->priv->parent_source = source;
1182 g_source_set_priority_unlocked (child_source, NULL, source->priority);
1184 if (context)
1186 UNLOCK_CONTEXT (context);
1187 g_source_attach (child_source, context);
1192 * g_source_remove_child_source:
1193 * @source:a #GSource
1194 * @child_source: a #GSource previously passed to
1195 * g_source_add_child_source().
1197 * Detaches @child_source from @source and destroys it.
1199 * Since: 2.28
1201 void
1202 g_source_remove_child_source (GSource *source,
1203 GSource *child_source)
1205 GMainContext *context;
1207 g_return_if_fail (source != NULL);
1208 g_return_if_fail (child_source != NULL);
1209 g_return_if_fail (child_source->priv != NULL && child_source->priv->parent_source == source);
1210 g_return_if_fail (!SOURCE_DESTROYED (source));
1211 g_return_if_fail (!SOURCE_DESTROYED (child_source));
1213 context = source->context;
1215 if (context)
1216 LOCK_CONTEXT (context);
1218 source->priv->child_sources = g_slist_remove (source->priv->child_sources, child_source);
1219 g_source_destroy_internal (child_source, context, TRUE);
1220 g_source_unref_internal (child_source, context, TRUE);
1222 if (context)
1223 UNLOCK_CONTEXT (context);
1227 * g_source_set_callback_indirect:
1228 * @source: the source
1229 * @callback_data: pointer to callback data "object"
1230 * @callback_funcs: functions for reference counting @callback_data
1231 * and getting the callback and data
1233 * Sets the callback function storing the data as a refcounted callback
1234 * "object". This is used internally. Note that calling
1235 * g_source_set_callback_indirect() assumes
1236 * an initial reference count on @callback_data, and thus
1237 * @callback_funcs->unref will eventually be called once more
1238 * than @callback_funcs->ref.
1240 void
1241 g_source_set_callback_indirect (GSource *source,
1242 gpointer callback_data,
1243 GSourceCallbackFuncs *callback_funcs)
1245 GMainContext *context;
1246 gpointer old_cb_data;
1247 GSourceCallbackFuncs *old_cb_funcs;
1249 g_return_if_fail (source != NULL);
1250 g_return_if_fail (callback_funcs != NULL || callback_data == NULL);
1252 context = source->context;
1254 if (context)
1255 LOCK_CONTEXT (context);
1257 old_cb_data = source->callback_data;
1258 old_cb_funcs = source->callback_funcs;
1260 source->callback_data = callback_data;
1261 source->callback_funcs = callback_funcs;
1263 if (context)
1264 UNLOCK_CONTEXT (context);
1266 if (old_cb_funcs)
1267 old_cb_funcs->unref (old_cb_data);
1270 static void
1271 g_source_callback_ref (gpointer cb_data)
1273 GSourceCallback *callback = cb_data;
1275 callback->ref_count++;
1279 static void
1280 g_source_callback_unref (gpointer cb_data)
1282 GSourceCallback *callback = cb_data;
1284 callback->ref_count--;
1285 if (callback->ref_count == 0)
1287 if (callback->notify)
1288 callback->notify (callback->data);
1289 g_free (callback);
1293 static void
1294 g_source_callback_get (gpointer cb_data,
1295 GSource *source,
1296 GSourceFunc *func,
1297 gpointer *data)
1299 GSourceCallback *callback = cb_data;
1301 *func = callback->func;
1302 *data = callback->data;
1305 static GSourceCallbackFuncs g_source_callback_funcs = {
1306 g_source_callback_ref,
1307 g_source_callback_unref,
1308 g_source_callback_get,
1312 * g_source_set_callback:
1313 * @source: the source
1314 * @func: a callback function
1315 * @data: the data to pass to callback function
1316 * @notify: (allow-none): a function to call when @data is no longer in use, or %NULL.
1318 * Sets the callback function for a source. The callback for a source is
1319 * called from the source's dispatch function.
1321 * The exact type of @func depends on the type of source; ie. you
1322 * should not count on @func being called with @data as its first
1323 * parameter.
1325 * Typically, you won't use this function. Instead use functions specific
1326 * to the type of source you are using.
1328 void
1329 g_source_set_callback (GSource *source,
1330 GSourceFunc func,
1331 gpointer data,
1332 GDestroyNotify notify)
1334 GSourceCallback *new_callback;
1336 g_return_if_fail (source != NULL);
1338 new_callback = g_new (GSourceCallback, 1);
1340 new_callback->ref_count = 1;
1341 new_callback->func = func;
1342 new_callback->data = data;
1343 new_callback->notify = notify;
1345 g_source_set_callback_indirect (source, new_callback, &g_source_callback_funcs);
1350 * g_source_set_funcs:
1351 * @source: a #GSource
1352 * @funcs: the new #GSourceFuncs
1354 * Sets the source functions (can be used to override
1355 * default implementations) of an unattached source.
1357 * Since: 2.12
1359 void
1360 g_source_set_funcs (GSource *source,
1361 GSourceFuncs *funcs)
1363 g_return_if_fail (source != NULL);
1364 g_return_if_fail (source->context == NULL);
1365 g_return_if_fail (source->ref_count > 0);
1366 g_return_if_fail (funcs != NULL);
1368 source->source_funcs = funcs;
1371 static void
1372 g_source_set_priority_unlocked (GSource *source,
1373 GMainContext *context,
1374 gint priority)
1376 GSList *tmp_list;
1378 source->priority = priority;
1380 if (context)
1382 /* Remove the source from the context's source and then
1383 * add it back so it is sorted in the correct place
1385 g_source_list_remove (source, source->context);
1386 g_source_list_add (source, source->context);
1388 if (!SOURCE_BLOCKED (source))
1390 tmp_list = source->poll_fds;
1391 while (tmp_list)
1393 g_main_context_remove_poll_unlocked (context, tmp_list->data);
1394 g_main_context_add_poll_unlocked (context, priority, tmp_list->data);
1396 tmp_list = tmp_list->next;
1401 if (source->priv && source->priv->child_sources)
1403 tmp_list = source->priv->child_sources;
1404 while (tmp_list)
1406 g_source_set_priority_unlocked (tmp_list->data, context, priority);
1407 tmp_list = tmp_list->next;
1413 * g_source_set_priority:
1414 * @source: a #GSource
1415 * @priority: the new priority.
1417 * Sets the priority of a source. While the main loop is being run, a
1418 * source will be dispatched if it is ready to be dispatched and no
1419 * sources at a higher (numerically smaller) priority are ready to be
1420 * dispatched.
1422 void
1423 g_source_set_priority (GSource *source,
1424 gint priority)
1426 GMainContext *context;
1428 g_return_if_fail (source != NULL);
1430 context = source->context;
1432 if (context)
1433 LOCK_CONTEXT (context);
1434 g_source_set_priority_unlocked (source, context, priority);
1435 if (context)
1436 UNLOCK_CONTEXT (source->context);
1440 * g_source_get_priority:
1441 * @source: a #GSource
1443 * Gets the priority of a source.
1445 * Return value: the priority of the source
1447 gint
1448 g_source_get_priority (GSource *source)
1450 g_return_val_if_fail (source != NULL, 0);
1452 return source->priority;
1456 * g_source_set_can_recurse:
1457 * @source: a #GSource
1458 * @can_recurse: whether recursion is allowed for this source
1460 * Sets whether a source can be called recursively. If @can_recurse is
1461 * %TRUE, then while the source is being dispatched then this source
1462 * will be processed normally. Otherwise, all processing of this
1463 * source is blocked until the dispatch function returns.
1465 void
1466 g_source_set_can_recurse (GSource *source,
1467 gboolean can_recurse)
1469 GMainContext *context;
1471 g_return_if_fail (source != NULL);
1473 context = source->context;
1475 if (context)
1476 LOCK_CONTEXT (context);
1478 if (can_recurse)
1479 source->flags |= G_SOURCE_CAN_RECURSE;
1480 else
1481 source->flags &= ~G_SOURCE_CAN_RECURSE;
1483 if (context)
1484 UNLOCK_CONTEXT (context);
1488 * g_source_get_can_recurse:
1489 * @source: a #GSource
1491 * Checks whether a source is allowed to be called recursively.
1492 * see g_source_set_can_recurse().
1494 * Return value: whether recursion is allowed.
1496 gboolean
1497 g_source_get_can_recurse (GSource *source)
1499 g_return_val_if_fail (source != NULL, FALSE);
1501 return (source->flags & G_SOURCE_CAN_RECURSE) != 0;
1506 * g_source_set_name:
1507 * @source: a #GSource
1508 * @name: debug name for the source
1510 * Sets a name for the source, used in debugging and profiling.
1511 * The name defaults to #NULL.
1513 * The source name should describe in a human-readable way
1514 * what the source does. For example, "X11 event queue"
1515 * or "GTK+ repaint idle handler" or whatever it is.
1517 * It is permitted to call this function multiple times, but is not
1518 * recommended due to the potential performance impact. For example,
1519 * one could change the name in the "check" function of a #GSourceFuncs
1520 * to include details like the event type in the source name.
1522 * Since: 2.26
1524 void
1525 g_source_set_name (GSource *source,
1526 const char *name)
1528 g_return_if_fail (source != NULL);
1530 /* setting back to NULL is allowed, just because it's
1531 * weird if get_name can return NULL but you can't
1532 * set that.
1535 g_free (source->name);
1536 source->name = g_strdup (name);
1540 * g_source_get_name:
1541 * @source: a #GSource
1543 * Gets a name for the source, used in debugging and profiling.
1544 * The name may be #NULL if it has never been set with
1545 * g_source_set_name().
1547 * Return value: the name of the source
1548 * Since: 2.26
1550 const char *
1551 g_source_get_name (GSource *source)
1553 g_return_val_if_fail (source != NULL, NULL);
1555 return source->name;
1559 * g_source_set_name_by_id:
1560 * @tag: a #GSource ID
1561 * @name: debug name for the source
1563 * Sets the name of a source using its ID.
1565 * This is a convenience utility to set source names from the return
1566 * value of g_idle_add(), g_timeout_add(), etc.
1568 * Since: 2.26
1570 void
1571 g_source_set_name_by_id (guint tag,
1572 const char *name)
1574 GSource *source;
1576 g_return_if_fail (tag > 0);
1578 source = g_main_context_find_source_by_id (NULL, tag);
1579 if (source == NULL)
1580 return;
1582 g_source_set_name (source, name);
1587 * g_source_ref:
1588 * @source: a #GSource
1590 * Increases the reference count on a source by one.
1592 * Return value: @source
1594 GSource *
1595 g_source_ref (GSource *source)
1597 GMainContext *context;
1599 g_return_val_if_fail (source != NULL, NULL);
1601 context = source->context;
1603 if (context)
1604 LOCK_CONTEXT (context);
1606 source->ref_count++;
1608 if (context)
1609 UNLOCK_CONTEXT (context);
1611 return source;
1614 /* g_source_unref() but possible to call within context lock
1616 static void
1617 g_source_unref_internal (GSource *source,
1618 GMainContext *context,
1619 gboolean have_lock)
1621 gpointer old_cb_data = NULL;
1622 GSourceCallbackFuncs *old_cb_funcs = NULL;
1624 g_return_if_fail (source != NULL);
1626 if (!have_lock && context)
1627 LOCK_CONTEXT (context);
1629 source->ref_count--;
1630 if (source->ref_count == 0)
1632 old_cb_data = source->callback_data;
1633 old_cb_funcs = source->callback_funcs;
1635 source->callback_data = NULL;
1636 source->callback_funcs = NULL;
1638 if (context)
1640 if (!SOURCE_DESTROYED (source))
1641 g_warning (G_STRLOC ": ref_count == 0, but source was still attached to a context!");
1642 g_source_list_remove (source, context);
1645 if (source->source_funcs->finalize)
1647 if (context)
1648 UNLOCK_CONTEXT (context);
1649 source->source_funcs->finalize (source);
1650 if (context)
1651 LOCK_CONTEXT (context);
1654 g_free (source->name);
1655 source->name = NULL;
1657 g_slist_free (source->poll_fds);
1658 source->poll_fds = NULL;
1660 if (source->priv)
1662 g_slice_free (GSourcePrivate, source->priv);
1663 source->priv = NULL;
1666 g_free (source);
1669 if (!have_lock && context)
1670 UNLOCK_CONTEXT (context);
1672 if (old_cb_funcs)
1674 if (have_lock)
1675 UNLOCK_CONTEXT (context);
1677 old_cb_funcs->unref (old_cb_data);
1679 if (have_lock)
1680 LOCK_CONTEXT (context);
1685 * g_source_unref:
1686 * @source: a #GSource
1688 * Decreases the reference count of a source by one. If the
1689 * resulting reference count is zero the source and associated
1690 * memory will be destroyed.
1692 void
1693 g_source_unref (GSource *source)
1695 g_return_if_fail (source != NULL);
1697 g_source_unref_internal (source, source->context, FALSE);
1701 * g_main_context_find_source_by_id:
1702 * @context: (allow-none): a #GMainContext (if %NULL, the default context will be used)
1703 * @source_id: the source ID, as returned by g_source_get_id().
1705 * Finds a #GSource given a pair of context and ID.
1707 * Return value: (transfer none): the #GSource if found, otherwise, %NULL
1709 GSource *
1710 g_main_context_find_source_by_id (GMainContext *context,
1711 guint source_id)
1713 GSource *source;
1715 g_return_val_if_fail (source_id > 0, NULL);
1717 if (context == NULL)
1718 context = g_main_context_default ();
1720 LOCK_CONTEXT (context);
1722 source = context->source_list;
1723 while (source)
1725 if (!SOURCE_DESTROYED (source) &&
1726 source->source_id == source_id)
1727 break;
1728 source = source->next;
1731 UNLOCK_CONTEXT (context);
1733 return source;
1737 * g_main_context_find_source_by_funcs_user_data:
1738 * @context: (allow-none): a #GMainContext (if %NULL, the default context will be used).
1739 * @funcs: the @source_funcs passed to g_source_new().
1740 * @user_data: the user data from the callback.
1742 * Finds a source with the given source functions and user data. If
1743 * multiple sources exist with the same source function and user data,
1744 * the first one found will be returned.
1746 * Return value: (transfer none): the source, if one was found, otherwise %NULL
1748 GSource *
1749 g_main_context_find_source_by_funcs_user_data (GMainContext *context,
1750 GSourceFuncs *funcs,
1751 gpointer user_data)
1753 GSource *source;
1755 g_return_val_if_fail (funcs != NULL, NULL);
1757 if (context == NULL)
1758 context = g_main_context_default ();
1760 LOCK_CONTEXT (context);
1762 source = context->source_list;
1763 while (source)
1765 if (!SOURCE_DESTROYED (source) &&
1766 source->source_funcs == funcs &&
1767 source->callback_funcs)
1769 GSourceFunc callback;
1770 gpointer callback_data;
1772 source->callback_funcs->get (source->callback_data, source, &callback, &callback_data);
1774 if (callback_data == user_data)
1775 break;
1777 source = source->next;
1780 UNLOCK_CONTEXT (context);
1782 return source;
1786 * g_main_context_find_source_by_user_data:
1787 * @context: a #GMainContext
1788 * @user_data: the user_data for the callback.
1790 * Finds a source with the given user data for the callback. If
1791 * multiple sources exist with the same user data, the first
1792 * one found will be returned.
1794 * Return value: (transfer none): the source, if one was found, otherwise %NULL
1796 GSource *
1797 g_main_context_find_source_by_user_data (GMainContext *context,
1798 gpointer user_data)
1800 GSource *source;
1802 if (context == NULL)
1803 context = g_main_context_default ();
1805 LOCK_CONTEXT (context);
1807 source = context->source_list;
1808 while (source)
1810 if (!SOURCE_DESTROYED (source) &&
1811 source->callback_funcs)
1813 GSourceFunc callback;
1814 gpointer callback_data = NULL;
1816 source->callback_funcs->get (source->callback_data, source, &callback, &callback_data);
1818 if (callback_data == user_data)
1819 break;
1821 source = source->next;
1824 UNLOCK_CONTEXT (context);
1826 return source;
1830 * g_source_remove:
1831 * @tag: the ID of the source to remove.
1833 * Removes the source with the given id from the default main context.
1834 * The id of
1835 * a #GSource is given by g_source_get_id(), or will be returned by the
1836 * functions g_source_attach(), g_idle_add(), g_idle_add_full(),
1837 * g_timeout_add(), g_timeout_add_full(), g_child_watch_add(),
1838 * g_child_watch_add_full(), g_io_add_watch(), and g_io_add_watch_full().
1840 * See also g_source_destroy(). You must use g_source_destroy() for sources
1841 * added to a non-default main context.
1843 * Return value: %TRUE if the source was found and removed.
1845 gboolean
1846 g_source_remove (guint tag)
1848 GSource *source;
1850 g_return_val_if_fail (tag > 0, FALSE);
1852 source = g_main_context_find_source_by_id (NULL, tag);
1853 if (source)
1854 g_source_destroy (source);
1856 return source != NULL;
1860 * g_source_remove_by_user_data:
1861 * @user_data: the user_data for the callback.
1863 * Removes a source from the default main loop context given the user
1864 * data for the callback. If multiple sources exist with the same user
1865 * data, only one will be destroyed.
1867 * Return value: %TRUE if a source was found and removed.
1869 gboolean
1870 g_source_remove_by_user_data (gpointer user_data)
1872 GSource *source;
1874 source = g_main_context_find_source_by_user_data (NULL, user_data);
1875 if (source)
1877 g_source_destroy (source);
1878 return TRUE;
1880 else
1881 return FALSE;
1885 * g_source_remove_by_funcs_user_data:
1886 * @funcs: The @source_funcs passed to g_source_new()
1887 * @user_data: the user data for the callback
1889 * Removes a source from the default main loop context given the
1890 * source functions and user data. If multiple sources exist with the
1891 * same source functions and user data, only one will be destroyed.
1893 * Return value: %TRUE if a source was found and removed.
1895 gboolean
1896 g_source_remove_by_funcs_user_data (GSourceFuncs *funcs,
1897 gpointer user_data)
1899 GSource *source;
1901 g_return_val_if_fail (funcs != NULL, FALSE);
1903 source = g_main_context_find_source_by_funcs_user_data (NULL, funcs, user_data);
1904 if (source)
1906 g_source_destroy (source);
1907 return TRUE;
1909 else
1910 return FALSE;
1914 * g_get_current_time:
1915 * @result: #GTimeVal structure in which to store current time.
1917 * Equivalent to the UNIX gettimeofday() function, but portable.
1919 * You may find g_get_real_time() to be more convenient.
1921 void
1922 g_get_current_time (GTimeVal *result)
1924 #ifndef G_OS_WIN32
1925 struct timeval r;
1927 g_return_if_fail (result != NULL);
1929 /*this is required on alpha, there the timeval structs are int's
1930 not longs and a cast only would fail horribly*/
1931 gettimeofday (&r, NULL);
1932 result->tv_sec = r.tv_sec;
1933 result->tv_usec = r.tv_usec;
1934 #else
1935 FILETIME ft;
1936 guint64 time64;
1938 g_return_if_fail (result != NULL);
1940 GetSystemTimeAsFileTime (&ft);
1941 memmove (&time64, &ft, sizeof (FILETIME));
1943 /* Convert from 100s of nanoseconds since 1601-01-01
1944 * to Unix epoch. Yes, this is Y2038 unsafe.
1946 time64 -= G_GINT64_CONSTANT (116444736000000000);
1947 time64 /= 10;
1949 result->tv_sec = time64 / 1000000;
1950 result->tv_usec = time64 % 1000000;
1951 #endif
1955 * g_get_real_time:
1957 * Queries the system wall-clock time.
1959 * This call is functionally equivalent to g_get_current_time() except
1960 * that the return value is often more convenient than dealing with a
1961 * #GTimeVal.
1963 * You should only use this call if you are actually interested in the real
1964 * wall-clock time. g_get_monotonic_time() is probably more useful for
1965 * measuring intervals.
1967 * Returns: the number of microseconds since January 1, 1970 UTC.
1969 * Since: 2.28
1971 gint64
1972 g_get_real_time (void)
1974 GTimeVal tv;
1976 g_get_current_time (&tv);
1978 return (((gint64) tv.tv_sec) * 1000000) + tv.tv_usec;
1981 #ifdef G_OS_WIN32
1982 static ULONGLONG (*g_GetTickCount64) (void) = NULL;
1983 static guint32 g_win32_tick_epoch = 0;
1985 G_GNUC_INTERNAL void
1986 g_clock_win32_init (void)
1988 HMODULE kernel32;
1990 g_GetTickCount64 = NULL;
1991 kernel32 = GetModuleHandle ("KERNEL32.DLL");
1992 if (kernel32 != NULL)
1993 g_GetTickCount64 = (void *) GetProcAddress (kernel32, "GetTickCount64");
1994 g_win32_tick_epoch = ((guint32)GetTickCount()) >> 31;
1996 #endif
1999 * g_get_monotonic_time:
2001 * Queries the system monotonic time, if available.
2003 * On POSIX systems with clock_gettime() and <literal>CLOCK_MONOTONIC</literal> this call
2004 * is a very shallow wrapper for that. Otherwise, we make a best effort
2005 * that probably involves returning the wall clock time (with at least
2006 * microsecond accuracy, subject to the limitations of the OS kernel).
2008 * It's important to note that POSIX <literal>CLOCK_MONOTONIC</literal> does
2009 * not count time spent while the machine is suspended.
2011 * On Windows, "limitations of the OS kernel" is a rather substantial
2012 * statement. Depending on the configuration of the system, the wall
2013 * clock time is updated as infrequently as 64 times a second (which
2014 * is approximately every 16ms). Also, on XP (but not on Vista or later)
2015 * the monotonic clock is locally monotonic, but may differ in exact
2016 * value between processes due to timer wrap handling.
2018 * Returns: the monotonic time, in microseconds
2020 * Since: 2.28
2022 gint64
2023 g_get_monotonic_time (void)
2025 #ifdef HAVE_CLOCK_GETTIME
2026 /* librt clock_gettime() is our first choice */
2027 struct timespec ts;
2029 #ifdef CLOCK_MONOTONIC
2030 clock_gettime (CLOCK_MONOTONIC, &ts);
2031 #else
2032 clock_gettime (CLOCK_REALTIME, &ts);
2033 #endif
2035 /* In theory monotonic time can have any epoch.
2037 * glib presently assumes the following:
2039 * 1) The epoch comes some time after the birth of Jesus of Nazareth, but
2040 * not more than 10000 years later.
2042 * 2) The current time also falls sometime within this range.
2044 * These two reasonable assumptions leave us with a maximum deviation from
2045 * the epoch of 10000 years, or 315569520000000000 seconds.
2047 * If we restrict ourselves to this range then the number of microseconds
2048 * will always fit well inside the constraints of a int64 (by a factor of
2049 * about 29).
2051 * If you actually hit the following assertion, probably you should file a
2052 * bug against your operating system for being excessively silly.
2054 g_assert (G_GINT64_CONSTANT (-315569520000000000) < ts.tv_sec &&
2055 ts.tv_sec < G_GINT64_CONSTANT (315569520000000000));
2057 return (((gint64) ts.tv_sec) * 1000000) + (ts.tv_nsec / 1000);
2059 #elif defined (G_OS_WIN32)
2060 guint64 ticks;
2061 guint32 ticks32;
2063 /* There are four sources for the monotonic time on Windows:
2065 * Three are based on a (1 msec accuracy, but only read periodically) clock chip:
2066 * - GetTickCount (GTC)
2067 * 32bit msec counter, updated each ~15msec, wraps in ~50 days
2068 * - GetTickCount64 (GTC64)
2069 * Same as GetTickCount, but extended to 64bit, so no wrap
2070 * Only available in Vista or later
2071 * - timeGetTime (TGT)
2072 * similar to GetTickCount by default: 15msec, 50 day wrap.
2073 * available in winmm.dll (thus known as the multimedia timers)
2074 * However apps can raise the system timer clock frequency using timeBeginPeriod()
2075 * increasing the accuracy up to 1 msec, at a cost in general system performance
2076 * and battery use.
2078 * One is based on high precision clocks:
2079 * - QueryPrecisionCounter (QPC)
2080 * This has much higher accuracy, but is not guaranteed monotonic, and
2081 * has lots of complications like clock jumps and different times on different
2082 * CPUs. It also has lower long term accuracy (i.e. it will drift compared to
2083 * the low precision clocks.
2085 * Additionally, the precision available in the timer-based wakeup such as
2086 * MsgWaitForMultipleObjectsEx (which is what the mainloop is based on) is based
2087 * on the TGT resolution, so by default it is ~15msec, but can be increased by apps.
2089 * The QPC timer has too many issues to be used as is. The only way it could be used
2090 * is to use it to interpolate the lower precision clocks. Firefox does something like
2091 * this:
2092 * https://bugzilla.mozilla.org/show_bug.cgi?id=363258
2094 * However this seems quite complicated, so we're not doing this right now.
2096 * The approach we take instead is to use the TGT timer, extending it to 64bit
2097 * either by using the GTC64 value, or if that is not available, a process local
2098 * time epoch that we increment when we detect a timer wrap (assumes that we read
2099 * the time at least once every 50 days).
2101 * This means that:
2102 * - We have a globally consistent monotonic clock on Vista and later
2103 * - We have a locally monotonic clock on XP
2104 * - Apps that need higher precision in timeouts and clock reads can call
2105 * timeBeginPeriod() to increase it as much as they want
2108 if (g_GetTickCount64 != NULL)
2110 guint32 ticks_as_32bit;
2112 ticks = g_GetTickCount64 ();
2113 ticks32 = timeGetTime();
2115 /* GTC64 and TGT are sampled at different times, however they
2116 * have the same base and source (msecs since system boot).
2117 * They can differ by as much as -16 to +16 msecs.
2118 * We can't just inject the low bits into the 64bit counter
2119 * as one of the counters can have wrapped in 32bit space and
2120 * the other not. Instead we calculate the signed difference
2121 * in 32bit space and apply that difference to the 64bit counter.
2123 ticks_as_32bit = (guint32)ticks;
2125 /* We could do some 2's complement hack, but we play it safe */
2126 if (ticks32 - ticks_as_32bit <= G_MAXINT32)
2127 ticks += ticks32 - ticks_as_32bit;
2128 else
2129 ticks -= ticks_as_32bit - ticks32;
2131 else
2133 guint32 epoch;
2135 epoch = g_atomic_int_get (&g_win32_tick_epoch);
2137 /* Must read ticks after the epoch. Then we're guaranteed
2138 * that the ticks value we read is higher or equal to any
2139 * previous ones that lead to the writing of the epoch.
2141 ticks32 = timeGetTime();
2143 /* We store the MSB of the current time as the LSB
2144 * of the epoch. Comparing these bits lets us detect when
2145 * the 32bit counter has wrapped so we can increase the
2146 * epoch.
2148 * This will work as long as this function is called at
2149 * least once every ~24 days, which is half the wrap time
2150 * of a 32bit msec counter. I think this is pretty likely.
2152 * Note that g_win32_tick_epoch is a process local state,
2153 * so the monotonic clock will not be the same between
2154 * processes.
2156 if ((ticks32 >> 31) != (epoch & 1))
2158 epoch++;
2159 g_atomic_int_set (&g_win32_tick_epoch, epoch);
2163 ticks = (guint64)ticks32 | ((guint64)epoch) << 31;
2166 return ticks * 1000;
2168 #else /* !HAVE_CLOCK_GETTIME && ! G_OS_WIN32*/
2170 GTimeVal tv;
2172 g_get_current_time (&tv);
2174 return (((gint64) tv.tv_sec) * 1000000) + tv.tv_usec;
2175 #endif
2178 static void
2179 g_main_dispatch_free (gpointer dispatch)
2181 g_slice_free (GMainDispatch, dispatch);
2184 /* Running the main loop */
2186 static GMainDispatch *
2187 get_dispatch (void)
2189 static GPrivate depth_private = G_PRIVATE_INIT (g_main_dispatch_free);
2190 GMainDispatch *dispatch;
2192 dispatch = g_private_get (&depth_private);
2194 if (!dispatch)
2196 dispatch = g_slice_new0 (GMainDispatch);
2197 g_private_set (&depth_private, dispatch);
2200 return dispatch;
2204 * g_main_depth:
2206 * Returns the depth of the stack of calls to
2207 * g_main_context_dispatch() on any #GMainContext in the current thread.
2208 * That is, when called from the toplevel, it gives 0. When
2209 * called from within a callback from g_main_context_iteration()
2210 * (or g_main_loop_run(), etc.) it returns 1. When called from within
2211 * a callback to a recursive call to g_main_context_iteration(),
2212 * it returns 2. And so forth.
2214 * This function is useful in a situation like the following:
2215 * Imagine an extremely simple "garbage collected" system.
2217 * |[
2218 * static GList *free_list;
2220 * gpointer
2221 * allocate_memory (gsize size)
2222 * {
2223 * gpointer result = g_malloc (size);
2224 * free_list = g_list_prepend (free_list, result);
2225 * return result;
2228 * void
2229 * free_allocated_memory (void)
2231 * GList *l;
2232 * for (l = free_list; l; l = l->next);
2233 * g_free (l->data);
2234 * g_list_free (free_list);
2235 * free_list = NULL;
2238 * [...]
2240 * while (TRUE);
2242 * g_main_context_iteration (NULL, TRUE);
2243 * free_allocated_memory();
2245 * ]|
2247 * This works from an application, however, if you want to do the same
2248 * thing from a library, it gets more difficult, since you no longer
2249 * control the main loop. You might think you can simply use an idle
2250 * function to make the call to free_allocated_memory(), but that
2251 * doesn't work, since the idle function could be called from a
2252 * recursive callback. This can be fixed by using g_main_depth()
2254 * |[
2255 * gpointer
2256 * allocate_memory (gsize size)
2257 * {
2258 * FreeListBlock *block = g_new (FreeListBlock, 1);
2259 * block->mem = g_malloc (size);
2260 * block->depth = g_main_depth ();
2261 * free_list = g_list_prepend (free_list, block);
2262 * return block->mem;
2265 * void
2266 * free_allocated_memory (void)
2268 * GList *l;
2270 * int depth = g_main_depth ();
2271 * for (l = free_list; l; );
2273 * GList *next = l->next;
2274 * FreeListBlock *block = l->data;
2275 * if (block->depth > depth)
2277 * g_free (block->mem);
2278 * g_free (block);
2279 * free_list = g_list_delete_link (free_list, l);
2282 * l = next;
2285 * ]|
2287 * There is a temptation to use g_main_depth() to solve
2288 * problems with reentrancy. For instance, while waiting for data
2289 * to be received from the network in response to a menu item,
2290 * the menu item might be selected again. It might seem that
2291 * one could make the menu item's callback return immediately
2292 * and do nothing if g_main_depth() returns a value greater than 1.
2293 * However, this should be avoided since the user then sees selecting
2294 * the menu item do nothing. Furthermore, you'll find yourself adding
2295 * these checks all over your code, since there are doubtless many,
2296 * many things that the user could do. Instead, you can use the
2297 * following techniques:
2299 * <orderedlist>
2300 * <listitem>
2301 * <para>
2302 * Use gtk_widget_set_sensitive() or modal dialogs to prevent
2303 * the user from interacting with elements while the main
2304 * loop is recursing.
2305 * </para>
2306 * </listitem>
2307 * <listitem>
2308 * <para>
2309 * Avoid main loop recursion in situations where you can't handle
2310 * arbitrary callbacks. Instead, structure your code so that you
2311 * simply return to the main loop and then get called again when
2312 * there is more work to do.
2313 * </para>
2314 * </listitem>
2315 * </orderedlist>
2317 * Return value: The main loop recursion level in the current thread
2320 g_main_depth (void)
2322 GMainDispatch *dispatch = get_dispatch ();
2323 return dispatch->depth;
2327 * g_main_current_source:
2329 * Returns the currently firing source for this thread.
2331 * Return value: (transfer none): The currently firing source or %NULL.
2333 * Since: 2.12
2335 GSource *
2336 g_main_current_source (void)
2338 GMainDispatch *dispatch = get_dispatch ();
2339 return dispatch->dispatching_sources ? dispatch->dispatching_sources->data : NULL;
2343 * g_source_is_destroyed:
2344 * @source: a #GSource
2346 * Returns whether @source has been destroyed.
2348 * This is important when you operate upon your objects
2349 * from within idle handlers, but may have freed the object
2350 * before the dispatch of your idle handler.
2352 * |[
2353 * static gboolean
2354 * idle_callback (gpointer data)
2356 * SomeWidget *self = data;
2358 * GDK_THREADS_ENTER (<!-- -->);
2359 * /<!-- -->* do stuff with self *<!-- -->/
2360 * self->idle_id = 0;
2361 * GDK_THREADS_LEAVE (<!-- -->);
2363 * return G_SOURCE_REMOVE;
2366 * static void
2367 * some_widget_do_stuff_later (SomeWidget *self)
2369 * self->idle_id = g_idle_add (idle_callback, self);
2372 * static void
2373 * some_widget_finalize (GObject *object)
2375 * SomeWidget *self = SOME_WIDGET (object);
2377 * if (self->idle_id)
2378 * g_source_remove (self->idle_id);
2380 * G_OBJECT_CLASS (parent_class)->finalize (object);
2382 * ]|
2384 * This will fail in a multi-threaded application if the
2385 * widget is destroyed before the idle handler fires due
2386 * to the use after free in the callback. A solution, to
2387 * this particular problem, is to check to if the source
2388 * has already been destroy within the callback.
2390 * |[
2391 * static gboolean
2392 * idle_callback (gpointer data)
2394 * SomeWidget *self = data;
2396 * GDK_THREADS_ENTER ();
2397 * if (!g_source_is_destroyed (g_main_current_source ()))
2399 * /<!-- -->* do stuff with self *<!-- -->/
2401 * GDK_THREADS_LEAVE ();
2403 * return FALSE;
2405 * ]|
2407 * Return value: %TRUE if the source has been destroyed
2409 * Since: 2.12
2411 gboolean
2412 g_source_is_destroyed (GSource *source)
2414 return SOURCE_DESTROYED (source);
2417 /* Temporarily remove all this source's file descriptors from the
2418 * poll(), so that if data comes available for one of the file descriptors
2419 * we don't continually spin in the poll()
2421 /* HOLDS: source->context's lock */
2422 static void
2423 block_source (GSource *source)
2425 GSList *tmp_list;
2427 g_return_if_fail (!SOURCE_BLOCKED (source));
2429 source->flags |= G_SOURCE_BLOCKED;
2431 tmp_list = source->poll_fds;
2432 while (tmp_list)
2434 g_main_context_remove_poll_unlocked (source->context, tmp_list->data);
2435 tmp_list = tmp_list->next;
2438 if (source->priv && source->priv->child_sources)
2440 tmp_list = source->priv->child_sources;
2441 while (tmp_list)
2443 block_source (tmp_list->data);
2444 tmp_list = tmp_list->next;
2449 /* HOLDS: source->context's lock */
2450 static void
2451 unblock_source (GSource *source)
2453 GSList *tmp_list;
2455 g_return_if_fail (SOURCE_BLOCKED (source)); /* Source already unblocked */
2456 g_return_if_fail (!SOURCE_DESTROYED (source));
2458 source->flags &= ~G_SOURCE_BLOCKED;
2460 tmp_list = source->poll_fds;
2461 while (tmp_list)
2463 g_main_context_add_poll_unlocked (source->context, source->priority, tmp_list->data);
2464 tmp_list = tmp_list->next;
2467 if (source->priv && source->priv->child_sources)
2469 tmp_list = source->priv->child_sources;
2470 while (tmp_list)
2472 unblock_source (tmp_list->data);
2473 tmp_list = tmp_list->next;
2478 /* HOLDS: context's lock */
2479 static void
2480 g_main_dispatch (GMainContext *context)
2482 GMainDispatch *current = get_dispatch ();
2483 guint i;
2485 for (i = 0; i < context->pending_dispatches->len; i++)
2487 GSource *source = context->pending_dispatches->pdata[i];
2489 context->pending_dispatches->pdata[i] = NULL;
2490 g_assert (source);
2492 source->flags &= ~G_SOURCE_READY;
2494 if (!SOURCE_DESTROYED (source))
2496 gboolean was_in_call;
2497 gpointer user_data = NULL;
2498 GSourceFunc callback = NULL;
2499 GSourceCallbackFuncs *cb_funcs;
2500 gpointer cb_data;
2501 gboolean need_destroy;
2503 gboolean (*dispatch) (GSource *,
2504 GSourceFunc,
2505 gpointer);
2506 GSList current_source_link;
2508 dispatch = source->source_funcs->dispatch;
2509 cb_funcs = source->callback_funcs;
2510 cb_data = source->callback_data;
2512 if (cb_funcs)
2513 cb_funcs->ref (cb_data);
2515 if ((source->flags & G_SOURCE_CAN_RECURSE) == 0)
2516 block_source (source);
2518 was_in_call = source->flags & G_HOOK_FLAG_IN_CALL;
2519 source->flags |= G_HOOK_FLAG_IN_CALL;
2521 if (cb_funcs)
2522 cb_funcs->get (cb_data, source, &callback, &user_data);
2524 UNLOCK_CONTEXT (context);
2526 current->depth++;
2527 /* The on-stack allocation of the GSList is unconventional, but
2528 * we know that the lifetime of the link is bounded to this
2529 * function as the link is kept in a thread specific list and
2530 * not manipulated outside of this function and its descendants.
2531 * Avoiding the overhead of a g_slist_alloc() is useful as many
2532 * applications do little more than dispatch events.
2534 * This is a performance hack - do not revert to g_slist_prepend()!
2536 current_source_link.data = source;
2537 current_source_link.next = current->dispatching_sources;
2538 current->dispatching_sources = &current_source_link;
2539 need_destroy = ! dispatch (source,
2540 callback,
2541 user_data);
2542 g_assert (current->dispatching_sources == &current_source_link);
2543 current->dispatching_sources = current_source_link.next;
2544 current->depth--;
2546 if (cb_funcs)
2547 cb_funcs->unref (cb_data);
2549 LOCK_CONTEXT (context);
2551 if (!was_in_call)
2552 source->flags &= ~G_HOOK_FLAG_IN_CALL;
2554 if (SOURCE_BLOCKED (source) && !SOURCE_DESTROYED (source))
2555 unblock_source (source);
2557 /* Note: this depends on the fact that we can't switch
2558 * sources from one main context to another
2560 if (need_destroy && !SOURCE_DESTROYED (source))
2562 g_assert (source->context == context);
2563 g_source_destroy_internal (source, context, TRUE);
2567 SOURCE_UNREF (source, context);
2570 g_ptr_array_set_size (context->pending_dispatches, 0);
2573 /* Holds context's lock */
2574 static inline GSource *
2575 next_valid_source (GMainContext *context,
2576 GSource *source)
2578 GSource *new_source = source ? source->next : context->source_list;
2580 while (new_source)
2582 if (!SOURCE_DESTROYED (new_source))
2584 new_source->ref_count++;
2585 break;
2588 new_source = new_source->next;
2591 if (source)
2592 SOURCE_UNREF (source, context);
2594 return new_source;
2598 * g_main_context_acquire:
2599 * @context: a #GMainContext
2601 * Tries to become the owner of the specified context.
2602 * If some other thread is the owner of the context,
2603 * returns %FALSE immediately. Ownership is properly
2604 * recursive: the owner can require ownership again
2605 * and will release ownership when g_main_context_release()
2606 * is called as many times as g_main_context_acquire().
2608 * You must be the owner of a context before you
2609 * can call g_main_context_prepare(), g_main_context_query(),
2610 * g_main_context_check(), g_main_context_dispatch().
2612 * Return value: %TRUE if the operation succeeded, and
2613 * this thread is now the owner of @context.
2615 gboolean
2616 g_main_context_acquire (GMainContext *context)
2618 gboolean result = FALSE;
2619 GThread *self = G_THREAD_SELF;
2621 if (context == NULL)
2622 context = g_main_context_default ();
2624 LOCK_CONTEXT (context);
2626 if (!context->owner)
2628 context->owner = self;
2629 g_assert (context->owner_count == 0);
2632 if (context->owner == self)
2634 context->owner_count++;
2635 result = TRUE;
2638 UNLOCK_CONTEXT (context);
2640 return result;
2644 * g_main_context_release:
2645 * @context: a #GMainContext
2647 * Releases ownership of a context previously acquired by this thread
2648 * with g_main_context_acquire(). If the context was acquired multiple
2649 * times, the ownership will be released only when g_main_context_release()
2650 * is called as many times as it was acquired.
2652 void
2653 g_main_context_release (GMainContext *context)
2655 if (context == NULL)
2656 context = g_main_context_default ();
2658 LOCK_CONTEXT (context);
2660 context->owner_count--;
2661 if (context->owner_count == 0)
2663 context->owner = NULL;
2665 if (context->waiters)
2667 GMainWaiter *waiter = context->waiters->data;
2668 gboolean loop_internal_waiter = (waiter->mutex == &context->mutex);
2669 context->waiters = g_slist_delete_link (context->waiters,
2670 context->waiters);
2671 if (!loop_internal_waiter)
2672 g_mutex_lock (waiter->mutex);
2674 g_cond_signal (waiter->cond);
2676 if (!loop_internal_waiter)
2677 g_mutex_unlock (waiter->mutex);
2681 UNLOCK_CONTEXT (context);
2685 * g_main_context_wait:
2686 * @context: a #GMainContext
2687 * @cond: a condition variable
2688 * @mutex: a mutex, currently held
2690 * Tries to become the owner of the specified context,
2691 * as with g_main_context_acquire(). But if another thread
2692 * is the owner, atomically drop @mutex and wait on @cond until
2693 * that owner releases ownership or until @cond is signaled, then
2694 * try again (once) to become the owner.
2696 * Return value: %TRUE if the operation succeeded, and
2697 * this thread is now the owner of @context.
2699 gboolean
2700 g_main_context_wait (GMainContext *context,
2701 GCond *cond,
2702 GMutex *mutex)
2704 gboolean result = FALSE;
2705 GThread *self = G_THREAD_SELF;
2706 gboolean loop_internal_waiter;
2708 if (context == NULL)
2709 context = g_main_context_default ();
2711 loop_internal_waiter = (mutex == &context->mutex);
2713 if (!loop_internal_waiter)
2714 LOCK_CONTEXT (context);
2716 if (context->owner && context->owner != self)
2718 GMainWaiter waiter;
2720 waiter.cond = cond;
2721 waiter.mutex = mutex;
2723 context->waiters = g_slist_append (context->waiters, &waiter);
2725 if (!loop_internal_waiter)
2726 UNLOCK_CONTEXT (context);
2727 g_cond_wait (cond, mutex);
2728 if (!loop_internal_waiter)
2729 LOCK_CONTEXT (context);
2731 context->waiters = g_slist_remove (context->waiters, &waiter);
2734 if (!context->owner)
2736 context->owner = self;
2737 g_assert (context->owner_count == 0);
2740 if (context->owner == self)
2742 context->owner_count++;
2743 result = TRUE;
2746 if (!loop_internal_waiter)
2747 UNLOCK_CONTEXT (context);
2749 return result;
2753 * g_main_context_prepare:
2754 * @context: a #GMainContext
2755 * @priority: location to store priority of highest priority
2756 * source already ready.
2758 * Prepares to poll sources within a main loop. The resulting information
2759 * for polling is determined by calling g_main_context_query ().
2761 * Return value: %TRUE if some source is ready to be dispatched
2762 * prior to polling.
2764 gboolean
2765 g_main_context_prepare (GMainContext *context,
2766 gint *priority)
2768 gint i;
2769 gint n_ready = 0;
2770 gint current_priority = G_MAXINT;
2771 GSource *source;
2773 if (context == NULL)
2774 context = g_main_context_default ();
2776 LOCK_CONTEXT (context);
2778 context->time_is_fresh = FALSE;
2780 if (context->in_check_or_prepare)
2782 g_warning ("g_main_context_prepare() called recursively from within a source's check() or "
2783 "prepare() member.");
2784 UNLOCK_CONTEXT (context);
2785 return FALSE;
2788 #if 0
2789 /* If recursing, finish up current dispatch, before starting over */
2790 if (context->pending_dispatches)
2792 if (dispatch)
2793 g_main_dispatch (context, &current_time);
2795 UNLOCK_CONTEXT (context);
2796 return TRUE;
2798 #endif
2800 /* If recursing, clear list of pending dispatches */
2802 for (i = 0; i < context->pending_dispatches->len; i++)
2804 if (context->pending_dispatches->pdata[i])
2805 SOURCE_UNREF ((GSource *)context->pending_dispatches->pdata[i], context);
2807 g_ptr_array_set_size (context->pending_dispatches, 0);
2809 /* Prepare all sources */
2811 context->timeout = -1;
2813 source = next_valid_source (context, NULL);
2814 while (source)
2816 gint source_timeout = -1;
2818 if ((n_ready > 0) && (source->priority > current_priority))
2820 SOURCE_UNREF (source, context);
2821 break;
2823 if (SOURCE_BLOCKED (source))
2824 goto next;
2826 if (!(source->flags & G_SOURCE_READY))
2828 gboolean result;
2829 gboolean (*prepare) (GSource *source,
2830 gint *timeout);
2832 prepare = source->source_funcs->prepare;
2833 context->in_check_or_prepare++;
2834 UNLOCK_CONTEXT (context);
2836 result = (*prepare) (source, &source_timeout);
2838 LOCK_CONTEXT (context);
2839 context->in_check_or_prepare--;
2841 if (result)
2843 GSource *ready_source = source;
2845 while (ready_source)
2847 ready_source->flags |= G_SOURCE_READY;
2848 ready_source = ready_source->priv ? ready_source->priv->parent_source : NULL;
2853 if (source->flags & G_SOURCE_READY)
2855 n_ready++;
2856 current_priority = source->priority;
2857 context->timeout = 0;
2860 if (source_timeout >= 0)
2862 if (context->timeout < 0)
2863 context->timeout = source_timeout;
2864 else
2865 context->timeout = MIN (context->timeout, source_timeout);
2868 next:
2869 source = next_valid_source (context, source);
2872 UNLOCK_CONTEXT (context);
2874 if (priority)
2875 *priority = current_priority;
2877 return (n_ready > 0);
2881 * g_main_context_query:
2882 * @context: a #GMainContext
2883 * @max_priority: maximum priority source to check
2884 * @timeout_: (out): location to store timeout to be used in polling
2885 * @fds: (out caller-allocates) (array length=n_fds): location to
2886 * store #GPollFD records that need to be polled.
2887 * @n_fds: length of @fds.
2889 * Determines information necessary to poll this main loop.
2891 * Return value: the number of records actually stored in @fds,
2892 * or, if more than @n_fds records need to be stored, the number
2893 * of records that need to be stored.
2895 gint
2896 g_main_context_query (GMainContext *context,
2897 gint max_priority,
2898 gint *timeout,
2899 GPollFD *fds,
2900 gint n_fds)
2902 gint n_poll;
2903 GPollRec *pollrec;
2905 LOCK_CONTEXT (context);
2907 pollrec = context->poll_records;
2908 n_poll = 0;
2909 while (pollrec && max_priority >= pollrec->priority)
2911 /* We need to include entries with fd->events == 0 in the array because
2912 * otherwise if the application changes fd->events behind our back and
2913 * makes it non-zero, we'll be out of sync when we check the fds[] array.
2914 * (Changing fd->events after adding an FD wasn't an anticipated use of
2915 * this API, but it occurs in practice.) */
2916 if (n_poll < n_fds)
2918 fds[n_poll].fd = pollrec->fd->fd;
2919 /* In direct contradiction to the Unix98 spec, IRIX runs into
2920 * difficulty if you pass in POLLERR, POLLHUP or POLLNVAL
2921 * flags in the events field of the pollfd while it should
2922 * just ignoring them. So we mask them out here.
2924 fds[n_poll].events = pollrec->fd->events & ~(G_IO_ERR|G_IO_HUP|G_IO_NVAL);
2925 fds[n_poll].revents = 0;
2928 pollrec = pollrec->next;
2929 n_poll++;
2932 context->poll_changed = FALSE;
2934 if (timeout)
2936 *timeout = context->timeout;
2937 if (*timeout != 0)
2938 context->time_is_fresh = FALSE;
2941 UNLOCK_CONTEXT (context);
2943 return n_poll;
2947 * g_main_context_check:
2948 * @context: a #GMainContext
2949 * @max_priority: the maximum numerical priority of sources to check
2950 * @fds: (array length=n_fds): array of #GPollFD's that was passed to
2951 * the last call to g_main_context_query()
2952 * @n_fds: return value of g_main_context_query()
2954 * Passes the results of polling back to the main loop.
2956 * Return value: %TRUE if some sources are ready to be dispatched.
2958 gboolean
2959 g_main_context_check (GMainContext *context,
2960 gint max_priority,
2961 GPollFD *fds,
2962 gint n_fds)
2964 GSource *source;
2965 GPollRec *pollrec;
2966 gint n_ready = 0;
2967 gint i;
2969 LOCK_CONTEXT (context);
2971 if (context->in_check_or_prepare)
2973 g_warning ("g_main_context_check() called recursively from within a source's check() or "
2974 "prepare() member.");
2975 UNLOCK_CONTEXT (context);
2976 return FALSE;
2979 if (context->wake_up_rec.events)
2980 g_wakeup_acknowledge (context->wakeup);
2982 /* If the set of poll file descriptors changed, bail out
2983 * and let the main loop rerun
2985 if (context->poll_changed)
2987 UNLOCK_CONTEXT (context);
2988 return FALSE;
2991 pollrec = context->poll_records;
2992 i = 0;
2993 while (i < n_fds)
2995 if (pollrec->fd->events)
2996 pollrec->fd->revents = fds[i].revents;
2998 pollrec = pollrec->next;
2999 i++;
3002 source = next_valid_source (context, NULL);
3003 while (source)
3005 if ((n_ready > 0) && (source->priority > max_priority))
3007 SOURCE_UNREF (source, context);
3008 break;
3010 if (SOURCE_BLOCKED (source))
3011 goto next;
3013 if (!(source->flags & G_SOURCE_READY))
3015 gboolean result;
3016 gboolean (*check) (GSource *source);
3018 check = source->source_funcs->check;
3020 context->in_check_or_prepare++;
3021 UNLOCK_CONTEXT (context);
3023 result = (*check) (source);
3025 LOCK_CONTEXT (context);
3026 context->in_check_or_prepare--;
3028 if (result)
3030 GSource *ready_source = source;
3032 while (ready_source)
3034 ready_source->flags |= G_SOURCE_READY;
3035 ready_source = ready_source->priv ? ready_source->priv->parent_source : NULL;
3040 if (source->flags & G_SOURCE_READY)
3042 source->ref_count++;
3043 g_ptr_array_add (context->pending_dispatches, source);
3045 n_ready++;
3047 /* never dispatch sources with less priority than the first
3048 * one we choose to dispatch
3050 max_priority = source->priority;
3053 next:
3054 source = next_valid_source (context, source);
3057 UNLOCK_CONTEXT (context);
3059 return n_ready > 0;
3063 * g_main_context_dispatch:
3064 * @context: a #GMainContext
3066 * Dispatches all pending sources.
3068 void
3069 g_main_context_dispatch (GMainContext *context)
3071 LOCK_CONTEXT (context);
3073 if (context->pending_dispatches->len > 0)
3075 g_main_dispatch (context);
3078 UNLOCK_CONTEXT (context);
3081 /* HOLDS context lock */
3082 static gboolean
3083 g_main_context_iterate (GMainContext *context,
3084 gboolean block,
3085 gboolean dispatch,
3086 GThread *self)
3088 gint max_priority;
3089 gint timeout;
3090 gboolean some_ready;
3091 gint nfds, allocated_nfds;
3092 GPollFD *fds = NULL;
3094 UNLOCK_CONTEXT (context);
3096 if (!g_main_context_acquire (context))
3098 gboolean got_ownership;
3100 LOCK_CONTEXT (context);
3102 if (!block)
3103 return FALSE;
3105 got_ownership = g_main_context_wait (context,
3106 &context->cond,
3107 &context->mutex);
3109 if (!got_ownership)
3110 return FALSE;
3112 else
3113 LOCK_CONTEXT (context);
3115 if (!context->cached_poll_array)
3117 context->cached_poll_array_size = context->n_poll_records;
3118 context->cached_poll_array = g_new (GPollFD, context->n_poll_records);
3121 allocated_nfds = context->cached_poll_array_size;
3122 fds = context->cached_poll_array;
3124 UNLOCK_CONTEXT (context);
3126 g_main_context_prepare (context, &max_priority);
3128 while ((nfds = g_main_context_query (context, max_priority, &timeout, fds,
3129 allocated_nfds)) > allocated_nfds)
3131 LOCK_CONTEXT (context);
3132 g_free (fds);
3133 context->cached_poll_array_size = allocated_nfds = nfds;
3134 context->cached_poll_array = fds = g_new (GPollFD, nfds);
3135 UNLOCK_CONTEXT (context);
3138 if (!block)
3139 timeout = 0;
3141 g_main_context_poll (context, timeout, max_priority, fds, nfds);
3143 some_ready = g_main_context_check (context, max_priority, fds, nfds);
3145 if (dispatch)
3146 g_main_context_dispatch (context);
3148 g_main_context_release (context);
3150 LOCK_CONTEXT (context);
3152 return some_ready;
3156 * g_main_context_pending:
3157 * @context: (allow-none): a #GMainContext (if %NULL, the default context will be used)
3159 * Checks if any sources have pending events for the given context.
3161 * Return value: %TRUE if events are pending.
3163 gboolean
3164 g_main_context_pending (GMainContext *context)
3166 gboolean retval;
3168 if (!context)
3169 context = g_main_context_default();
3171 LOCK_CONTEXT (context);
3172 retval = g_main_context_iterate (context, FALSE, FALSE, G_THREAD_SELF);
3173 UNLOCK_CONTEXT (context);
3175 return retval;
3179 * g_main_context_iteration:
3180 * @context: (allow-none): a #GMainContext (if %NULL, the default context will be used)
3181 * @may_block: whether the call may block.
3183 * Runs a single iteration for the given main loop. This involves
3184 * checking to see if any event sources are ready to be processed,
3185 * then if no events sources are ready and @may_block is %TRUE, waiting
3186 * for a source to become ready, then dispatching the highest priority
3187 * events sources that are ready. Otherwise, if @may_block is %FALSE
3188 * sources are not waited to become ready, only those highest priority
3189 * events sources will be dispatched (if any), that are ready at this
3190 * given moment without further waiting.
3192 * Note that even when @may_block is %TRUE, it is still possible for
3193 * g_main_context_iteration() to return %FALSE, since the the wait may
3194 * be interrupted for other reasons than an event source becoming ready.
3196 * Return value: %TRUE if events were dispatched.
3198 gboolean
3199 g_main_context_iteration (GMainContext *context, gboolean may_block)
3201 gboolean retval;
3203 if (!context)
3204 context = g_main_context_default();
3206 LOCK_CONTEXT (context);
3207 retval = g_main_context_iterate (context, may_block, TRUE, G_THREAD_SELF);
3208 UNLOCK_CONTEXT (context);
3210 return retval;
3214 * g_main_loop_new:
3215 * @context: (allow-none): a #GMainContext (if %NULL, the default context will be used).
3216 * @is_running: set to %TRUE to indicate that the loop is running. This
3217 * is not very important since calling g_main_loop_run() will set this to
3218 * %TRUE anyway.
3220 * Creates a new #GMainLoop structure.
3222 * Return value: a new #GMainLoop.
3224 GMainLoop *
3225 g_main_loop_new (GMainContext *context,
3226 gboolean is_running)
3228 GMainLoop *loop;
3230 if (!context)
3231 context = g_main_context_default();
3233 g_main_context_ref (context);
3235 loop = g_new0 (GMainLoop, 1);
3236 loop->context = context;
3237 loop->is_running = is_running != FALSE;
3238 loop->ref_count = 1;
3240 return loop;
3244 * g_main_loop_ref:
3245 * @loop: a #GMainLoop
3247 * Increases the reference count on a #GMainLoop object by one.
3249 * Return value: @loop
3251 GMainLoop *
3252 g_main_loop_ref (GMainLoop *loop)
3254 g_return_val_if_fail (loop != NULL, NULL);
3255 g_return_val_if_fail (g_atomic_int_get (&loop->ref_count) > 0, NULL);
3257 g_atomic_int_inc (&loop->ref_count);
3259 return loop;
3263 * g_main_loop_unref:
3264 * @loop: a #GMainLoop
3266 * Decreases the reference count on a #GMainLoop object by one. If
3267 * the result is zero, free the loop and free all associated memory.
3269 void
3270 g_main_loop_unref (GMainLoop *loop)
3272 g_return_if_fail (loop != NULL);
3273 g_return_if_fail (g_atomic_int_get (&loop->ref_count) > 0);
3275 if (!g_atomic_int_dec_and_test (&loop->ref_count))
3276 return;
3278 g_main_context_unref (loop->context);
3279 g_free (loop);
3283 * g_main_loop_run:
3284 * @loop: a #GMainLoop
3286 * Runs a main loop until g_main_loop_quit() is called on the loop.
3287 * If this is called for the thread of the loop's #GMainContext,
3288 * it will process events from the loop, otherwise it will
3289 * simply wait.
3291 void
3292 g_main_loop_run (GMainLoop *loop)
3294 GThread *self = G_THREAD_SELF;
3296 g_return_if_fail (loop != NULL);
3297 g_return_if_fail (g_atomic_int_get (&loop->ref_count) > 0);
3299 if (!g_main_context_acquire (loop->context))
3301 gboolean got_ownership = FALSE;
3303 /* Another thread owns this context */
3304 LOCK_CONTEXT (loop->context);
3306 g_atomic_int_inc (&loop->ref_count);
3308 if (!loop->is_running)
3309 loop->is_running = TRUE;
3311 while (loop->is_running && !got_ownership)
3312 got_ownership = g_main_context_wait (loop->context,
3313 &loop->context->cond,
3314 &loop->context->mutex);
3316 if (!loop->is_running)
3318 UNLOCK_CONTEXT (loop->context);
3319 if (got_ownership)
3320 g_main_context_release (loop->context);
3321 g_main_loop_unref (loop);
3322 return;
3325 g_assert (got_ownership);
3327 else
3328 LOCK_CONTEXT (loop->context);
3330 if (loop->context->in_check_or_prepare)
3332 g_warning ("g_main_loop_run(): called recursively from within a source's "
3333 "check() or prepare() member, iteration not possible.");
3334 return;
3337 g_atomic_int_inc (&loop->ref_count);
3338 loop->is_running = TRUE;
3339 while (loop->is_running)
3340 g_main_context_iterate (loop->context, TRUE, TRUE, self);
3342 UNLOCK_CONTEXT (loop->context);
3344 g_main_context_release (loop->context);
3346 g_main_loop_unref (loop);
3350 * g_main_loop_quit:
3351 * @loop: a #GMainLoop
3353 * Stops a #GMainLoop from running. Any calls to g_main_loop_run()
3354 * for the loop will return.
3356 * Note that sources that have already been dispatched when
3357 * g_main_loop_quit() is called will still be executed.
3359 void
3360 g_main_loop_quit (GMainLoop *loop)
3362 g_return_if_fail (loop != NULL);
3363 g_return_if_fail (g_atomic_int_get (&loop->ref_count) > 0);
3365 LOCK_CONTEXT (loop->context);
3366 loop->is_running = FALSE;
3367 g_wakeup_signal (loop->context->wakeup);
3369 g_cond_broadcast (&loop->context->cond);
3371 UNLOCK_CONTEXT (loop->context);
3375 * g_main_loop_is_running:
3376 * @loop: a #GMainLoop.
3378 * Checks to see if the main loop is currently being run via g_main_loop_run().
3380 * Return value: %TRUE if the mainloop is currently being run.
3382 gboolean
3383 g_main_loop_is_running (GMainLoop *loop)
3385 g_return_val_if_fail (loop != NULL, FALSE);
3386 g_return_val_if_fail (g_atomic_int_get (&loop->ref_count) > 0, FALSE);
3388 return loop->is_running;
3392 * g_main_loop_get_context:
3393 * @loop: a #GMainLoop.
3395 * Returns the #GMainContext of @loop.
3397 * Return value: (transfer none): the #GMainContext of @loop
3399 GMainContext *
3400 g_main_loop_get_context (GMainLoop *loop)
3402 g_return_val_if_fail (loop != NULL, NULL);
3403 g_return_val_if_fail (g_atomic_int_get (&loop->ref_count) > 0, NULL);
3405 return loop->context;
3408 /* HOLDS: context's lock */
3409 static void
3410 g_main_context_poll (GMainContext *context,
3411 gint timeout,
3412 gint priority,
3413 GPollFD *fds,
3414 gint n_fds)
3416 #ifdef G_MAIN_POLL_DEBUG
3417 GTimer *poll_timer;
3418 GPollRec *pollrec;
3419 gint i;
3420 #endif
3422 GPollFunc poll_func;
3424 if (n_fds || timeout != 0)
3426 #ifdef G_MAIN_POLL_DEBUG
3427 if (_g_main_poll_debug)
3429 g_print ("polling context=%p n=%d timeout=%d\n",
3430 context, n_fds, timeout);
3431 poll_timer = g_timer_new ();
3433 #endif
3435 LOCK_CONTEXT (context);
3437 poll_func = context->poll_func;
3439 UNLOCK_CONTEXT (context);
3440 if ((*poll_func) (fds, n_fds, timeout) < 0 && errno != EINTR)
3442 #ifndef G_OS_WIN32
3443 g_warning ("poll(2) failed due to: %s.",
3444 g_strerror (errno));
3445 #else
3446 /* If g_poll () returns -1, it has already called g_warning() */
3447 #endif
3450 #ifdef G_MAIN_POLL_DEBUG
3451 if (_g_main_poll_debug)
3453 LOCK_CONTEXT (context);
3455 g_print ("g_main_poll(%d) timeout: %d - elapsed %12.10f seconds",
3456 n_fds,
3457 timeout,
3458 g_timer_elapsed (poll_timer, NULL));
3459 g_timer_destroy (poll_timer);
3460 pollrec = context->poll_records;
3462 while (pollrec != NULL)
3464 i = 0;
3465 while (i < n_fds)
3467 if (fds[i].fd == pollrec->fd->fd &&
3468 pollrec->fd->events &&
3469 fds[i].revents)
3471 g_print (" [" G_POLLFD_FORMAT " :", fds[i].fd);
3472 if (fds[i].revents & G_IO_IN)
3473 g_print ("i");
3474 if (fds[i].revents & G_IO_OUT)
3475 g_print ("o");
3476 if (fds[i].revents & G_IO_PRI)
3477 g_print ("p");
3478 if (fds[i].revents & G_IO_ERR)
3479 g_print ("e");
3480 if (fds[i].revents & G_IO_HUP)
3481 g_print ("h");
3482 if (fds[i].revents & G_IO_NVAL)
3483 g_print ("n");
3484 g_print ("]");
3486 i++;
3488 pollrec = pollrec->next;
3490 g_print ("\n");
3492 UNLOCK_CONTEXT (context);
3494 #endif
3495 } /* if (n_fds || timeout != 0) */
3499 * g_main_context_add_poll:
3500 * @context: (allow-none): a #GMainContext (or %NULL for the default context)
3501 * @fd: a #GPollFD structure holding information about a file
3502 * descriptor to watch.
3503 * @priority: the priority for this file descriptor which should be
3504 * the same as the priority used for g_source_attach() to ensure that the
3505 * file descriptor is polled whenever the results may be needed.
3507 * Adds a file descriptor to the set of file descriptors polled for
3508 * this context. This will very seldom be used directly. Instead
3509 * a typical event source will use g_source_add_poll() instead.
3511 void
3512 g_main_context_add_poll (GMainContext *context,
3513 GPollFD *fd,
3514 gint priority)
3516 if (!context)
3517 context = g_main_context_default ();
3519 g_return_if_fail (g_atomic_int_get (&context->ref_count) > 0);
3520 g_return_if_fail (fd);
3522 LOCK_CONTEXT (context);
3523 g_main_context_add_poll_unlocked (context, priority, fd);
3524 UNLOCK_CONTEXT (context);
3527 /* HOLDS: main_loop_lock */
3528 static void
3529 g_main_context_add_poll_unlocked (GMainContext *context,
3530 gint priority,
3531 GPollFD *fd)
3533 GPollRec *prevrec, *nextrec;
3534 GPollRec *newrec = g_slice_new (GPollRec);
3536 /* This file descriptor may be checked before we ever poll */
3537 fd->revents = 0;
3538 newrec->fd = fd;
3539 newrec->priority = priority;
3541 prevrec = context->poll_records_tail;
3542 nextrec = NULL;
3543 while (prevrec && priority < prevrec->priority)
3545 nextrec = prevrec;
3546 prevrec = prevrec->prev;
3549 if (prevrec)
3550 prevrec->next = newrec;
3551 else
3552 context->poll_records = newrec;
3554 newrec->prev = prevrec;
3555 newrec->next = nextrec;
3557 if (nextrec)
3558 nextrec->prev = newrec;
3559 else
3560 context->poll_records_tail = newrec;
3562 context->n_poll_records++;
3564 context->poll_changed = TRUE;
3566 /* Now wake up the main loop if it is waiting in the poll() */
3567 g_wakeup_signal (context->wakeup);
3571 * g_main_context_remove_poll:
3572 * @context:a #GMainContext
3573 * @fd: a #GPollFD descriptor previously added with g_main_context_add_poll()
3575 * Removes file descriptor from the set of file descriptors to be
3576 * polled for a particular context.
3578 void
3579 g_main_context_remove_poll (GMainContext *context,
3580 GPollFD *fd)
3582 if (!context)
3583 context = g_main_context_default ();
3585 g_return_if_fail (g_atomic_int_get (&context->ref_count) > 0);
3586 g_return_if_fail (fd);
3588 LOCK_CONTEXT (context);
3589 g_main_context_remove_poll_unlocked (context, fd);
3590 UNLOCK_CONTEXT (context);
3593 static void
3594 g_main_context_remove_poll_unlocked (GMainContext *context,
3595 GPollFD *fd)
3597 GPollRec *pollrec, *prevrec, *nextrec;
3599 prevrec = NULL;
3600 pollrec = context->poll_records;
3602 while (pollrec)
3604 nextrec = pollrec->next;
3605 if (pollrec->fd == fd)
3607 if (prevrec != NULL)
3608 prevrec->next = nextrec;
3609 else
3610 context->poll_records = nextrec;
3612 if (nextrec != NULL)
3613 nextrec->prev = prevrec;
3614 else
3615 context->poll_records_tail = prevrec;
3617 g_slice_free (GPollRec, pollrec);
3619 context->n_poll_records--;
3620 break;
3622 prevrec = pollrec;
3623 pollrec = nextrec;
3626 context->poll_changed = TRUE;
3628 /* Now wake up the main loop if it is waiting in the poll() */
3629 g_wakeup_signal (context->wakeup);
3633 * g_source_get_current_time:
3634 * @source: a #GSource
3635 * @timeval: #GTimeVal structure in which to store current time.
3637 * This function ignores @source and is otherwise the same as
3638 * g_get_current_time().
3640 * Deprecated: 2.28: use g_source_get_time() instead
3642 void
3643 g_source_get_current_time (GSource *source,
3644 GTimeVal *timeval)
3646 g_get_current_time (timeval);
3650 * g_source_get_time:
3651 * @source: a #GSource
3653 * Gets the time to be used when checking this source. The advantage of
3654 * calling this function over calling g_get_monotonic_time() directly is
3655 * that when checking multiple sources, GLib can cache a single value
3656 * instead of having to repeatedly get the system monotonic time.
3658 * The time here is the system monotonic time, if available, or some
3659 * other reasonable alternative otherwise. See g_get_monotonic_time().
3661 * Returns: the monotonic time in microseconds
3663 * Since: 2.28
3665 gint64
3666 g_source_get_time (GSource *source)
3668 GMainContext *context;
3669 gint64 result;
3671 g_return_val_if_fail (source->context != NULL, 0);
3673 context = source->context;
3675 LOCK_CONTEXT (context);
3677 if (!context->time_is_fresh)
3679 context->time = g_get_monotonic_time ();
3680 context->time_is_fresh = TRUE;
3683 result = context->time;
3685 UNLOCK_CONTEXT (context);
3687 return result;
3691 * g_main_context_set_poll_func:
3692 * @context: a #GMainContext
3693 * @func: the function to call to poll all file descriptors
3695 * Sets the function to use to handle polling of file descriptors. It
3696 * will be used instead of the poll() system call
3697 * (or GLib's replacement function, which is used where
3698 * poll() isn't available).
3700 * This function could possibly be used to integrate the GLib event
3701 * loop with an external event loop.
3703 void
3704 g_main_context_set_poll_func (GMainContext *context,
3705 GPollFunc func)
3707 if (!context)
3708 context = g_main_context_default ();
3710 g_return_if_fail (g_atomic_int_get (&context->ref_count) > 0);
3712 LOCK_CONTEXT (context);
3714 if (func)
3715 context->poll_func = func;
3716 else
3717 context->poll_func = g_poll;
3719 UNLOCK_CONTEXT (context);
3723 * g_main_context_get_poll_func:
3724 * @context: a #GMainContext
3726 * Gets the poll function set by g_main_context_set_poll_func().
3728 * Return value: the poll function
3730 GPollFunc
3731 g_main_context_get_poll_func (GMainContext *context)
3733 GPollFunc result;
3735 if (!context)
3736 context = g_main_context_default ();
3738 g_return_val_if_fail (g_atomic_int_get (&context->ref_count) > 0, NULL);
3740 LOCK_CONTEXT (context);
3741 result = context->poll_func;
3742 UNLOCK_CONTEXT (context);
3744 return result;
3748 * g_main_context_wakeup:
3749 * @context: a #GMainContext
3751 * If @context is currently waiting in a poll(), interrupt
3752 * the poll(), and continue the iteration process.
3754 void
3755 g_main_context_wakeup (GMainContext *context)
3757 if (!context)
3758 context = g_main_context_default ();
3760 g_return_if_fail (g_atomic_int_get (&context->ref_count) > 0);
3762 g_wakeup_signal (context->wakeup);
3766 * g_main_context_is_owner:
3767 * @context: a #GMainContext
3769 * Determines whether this thread holds the (recursive)
3770 * ownership of this #GMainContext. This is useful to
3771 * know before waiting on another thread that may be
3772 * blocking to get ownership of @context.
3774 * Returns: %TRUE if current thread is owner of @context.
3776 * Since: 2.10
3778 gboolean
3779 g_main_context_is_owner (GMainContext *context)
3781 gboolean is_owner;
3783 if (!context)
3784 context = g_main_context_default ();
3786 LOCK_CONTEXT (context);
3787 is_owner = context->owner == G_THREAD_SELF;
3788 UNLOCK_CONTEXT (context);
3790 return is_owner;
3793 /* Timeouts */
3795 static void
3796 g_timeout_set_expiration (GTimeoutSource *timeout_source,
3797 gint64 current_time)
3799 timeout_source->expiration = current_time +
3800 (guint64) timeout_source->interval * 1000;
3802 if (timeout_source->seconds)
3804 gint64 remainder;
3805 static gint timer_perturb = -1;
3807 if (timer_perturb == -1)
3810 * we want a per machine/session unique 'random' value; try the dbus
3811 * address first, that has a UUID in it. If there is no dbus, use the
3812 * hostname for hashing.
3814 const char *session_bus_address = g_getenv ("DBUS_SESSION_BUS_ADDRESS");
3815 if (!session_bus_address)
3816 session_bus_address = g_getenv ("HOSTNAME");
3817 if (session_bus_address)
3818 timer_perturb = ABS ((gint) g_str_hash (session_bus_address)) % 1000000;
3819 else
3820 timer_perturb = 0;
3823 /* We want the microseconds part of the timeout to land on the
3824 * 'timer_perturb' mark, but we need to make sure we don't try to
3825 * set the timeout in the past. We do this by ensuring that we
3826 * always only *increase* the expiration time by adding a full
3827 * second in the case that the microsecond portion decreases.
3829 timeout_source->expiration -= timer_perturb;
3831 remainder = timeout_source->expiration % 1000000;
3832 if (remainder >= 1000000/4)
3833 timeout_source->expiration += 1000000;
3835 timeout_source->expiration -= remainder;
3836 timeout_source->expiration += timer_perturb;
3840 static gboolean
3841 g_timeout_prepare (GSource *source,
3842 gint *timeout)
3844 GTimeoutSource *timeout_source = (GTimeoutSource *) source;
3845 gint64 now = g_source_get_time (source);
3847 if (now < timeout_source->expiration)
3849 /* Round up to ensure that we don't try again too early */
3850 *timeout = (timeout_source->expiration - now + 999) / 1000;
3851 return FALSE;
3854 *timeout = 0;
3855 return TRUE;
3858 static gboolean
3859 g_timeout_check (GSource *source)
3861 GTimeoutSource *timeout_source = (GTimeoutSource *) source;
3862 gint64 now = g_source_get_time (source);
3864 return timeout_source->expiration <= now;
3867 static gboolean
3868 g_timeout_dispatch (GSource *source,
3869 GSourceFunc callback,
3870 gpointer user_data)
3872 GTimeoutSource *timeout_source = (GTimeoutSource *)source;
3873 gboolean again;
3875 if (!callback)
3877 g_warning ("Timeout source dispatched without callback\n"
3878 "You must call g_source_set_callback().");
3879 return FALSE;
3882 again = callback (user_data);
3884 if (again)
3885 g_timeout_set_expiration (timeout_source, g_source_get_time (source));
3887 return again;
3891 * g_timeout_source_new:
3892 * @interval: the timeout interval in milliseconds.
3894 * Creates a new timeout source.
3896 * The source will not initially be associated with any #GMainContext
3897 * and must be added to one with g_source_attach() before it will be
3898 * executed.
3900 * The interval given is in terms of monotonic time, not wall clock
3901 * time. See g_get_monotonic_time().
3903 * Return value: the newly-created timeout source
3905 GSource *
3906 g_timeout_source_new (guint interval)
3908 GSource *source = g_source_new (&g_timeout_funcs, sizeof (GTimeoutSource));
3909 GTimeoutSource *timeout_source = (GTimeoutSource *)source;
3911 timeout_source->interval = interval;
3912 g_timeout_set_expiration (timeout_source, g_get_monotonic_time ());
3914 return source;
3918 * g_timeout_source_new_seconds:
3919 * @interval: the timeout interval in seconds
3921 * Creates a new timeout source.
3923 * The source will not initially be associated with any #GMainContext
3924 * and must be added to one with g_source_attach() before it will be
3925 * executed.
3927 * The scheduling granularity/accuracy of this timeout source will be
3928 * in seconds.
3930 * The interval given in terms of monotonic time, not wall clock time.
3931 * See g_get_monotonic_time().
3933 * Return value: the newly-created timeout source
3935 * Since: 2.14
3937 GSource *
3938 g_timeout_source_new_seconds (guint interval)
3940 GSource *source = g_source_new (&g_timeout_funcs, sizeof (GTimeoutSource));
3941 GTimeoutSource *timeout_source = (GTimeoutSource *)source;
3943 timeout_source->interval = 1000 * interval;
3944 timeout_source->seconds = TRUE;
3946 g_timeout_set_expiration (timeout_source, g_get_monotonic_time ());
3948 return source;
3953 * g_timeout_add_full:
3954 * @priority: the priority of the timeout source. Typically this will be in
3955 * the range between #G_PRIORITY_DEFAULT and #G_PRIORITY_HIGH.
3956 * @interval: the time between calls to the function, in milliseconds
3957 * (1/1000ths of a second)
3958 * @function: function to call
3959 * @data: data to pass to @function
3960 * @notify: (allow-none): function to call when the timeout is removed, or %NULL
3962 * Sets a function to be called at regular intervals, with the given
3963 * priority. The function is called repeatedly until it returns
3964 * %FALSE, at which point the timeout is automatically destroyed and
3965 * the function will not be called again. The @notify function is
3966 * called when the timeout is destroyed. The first call to the
3967 * function will be at the end of the first @interval.
3969 * Note that timeout functions may be delayed, due to the processing of other
3970 * event sources. Thus they should not be relied on for precise timing.
3971 * After each call to the timeout function, the time of the next
3972 * timeout is recalculated based on the current time and the given interval
3973 * (it does not try to 'catch up' time lost in delays).
3975 * This internally creates a main loop source using g_timeout_source_new()
3976 * and attaches it to the main loop context using g_source_attach(). You can
3977 * do these steps manually if you need greater control.
3979 * The interval given in terms of monotonic time, not wall clock time.
3980 * See g_get_monotonic_time().
3982 * Return value: the ID (greater than 0) of the event source.
3983 * Rename to: g_timeout_add
3985 guint
3986 g_timeout_add_full (gint priority,
3987 guint interval,
3988 GSourceFunc function,
3989 gpointer data,
3990 GDestroyNotify notify)
3992 GSource *source;
3993 guint id;
3995 g_return_val_if_fail (function != NULL, 0);
3997 source = g_timeout_source_new (interval);
3999 if (priority != G_PRIORITY_DEFAULT)
4000 g_source_set_priority (source, priority);
4002 g_source_set_callback (source, function, data, notify);
4003 id = g_source_attach (source, NULL);
4004 g_source_unref (source);
4006 return id;
4010 * g_timeout_add:
4011 * @interval: the time between calls to the function, in milliseconds
4012 * (1/1000ths of a second)
4013 * @function: function to call
4014 * @data: data to pass to @function
4016 * Sets a function to be called at regular intervals, with the default
4017 * priority, #G_PRIORITY_DEFAULT. The function is called repeatedly
4018 * until it returns %FALSE, at which point the timeout is automatically
4019 * destroyed and the function will not be called again. The first call
4020 * to the function will be at the end of the first @interval.
4022 * Note that timeout functions may be delayed, due to the processing of other
4023 * event sources. Thus they should not be relied on for precise timing.
4024 * After each call to the timeout function, the time of the next
4025 * timeout is recalculated based on the current time and the given interval
4026 * (it does not try to 'catch up' time lost in delays).
4028 * If you want to have a timer in the "seconds" range and do not care
4029 * about the exact time of the first call of the timer, use the
4030 * g_timeout_add_seconds() function; this function allows for more
4031 * optimizations and more efficient system power usage.
4033 * This internally creates a main loop source using g_timeout_source_new()
4034 * and attaches it to the main loop context using g_source_attach(). You can
4035 * do these steps manually if you need greater control.
4037 * The interval given is in terms of monotonic time, not wall clock
4038 * time. See g_get_monotonic_time().
4040 * Return value: the ID (greater than 0) of the event source.
4042 guint
4043 g_timeout_add (guint32 interval,
4044 GSourceFunc function,
4045 gpointer data)
4047 return g_timeout_add_full (G_PRIORITY_DEFAULT,
4048 interval, function, data, NULL);
4052 * g_timeout_add_seconds_full:
4053 * @priority: the priority of the timeout source. Typically this will be in
4054 * the range between #G_PRIORITY_DEFAULT and #G_PRIORITY_HIGH.
4055 * @interval: the time between calls to the function, in seconds
4056 * @function: function to call
4057 * @data: data to pass to @function
4058 * @notify: (allow-none): function to call when the timeout is removed, or %NULL
4060 * Sets a function to be called at regular intervals, with @priority.
4061 * The function is called repeatedly until it returns %FALSE, at which
4062 * point the timeout is automatically destroyed and the function will
4063 * not be called again.
4065 * Unlike g_timeout_add(), this function operates at whole second granularity.
4066 * The initial starting point of the timer is determined by the implementation
4067 * and the implementation is expected to group multiple timers together so that
4068 * they fire all at the same time.
4069 * To allow this grouping, the @interval to the first timer is rounded
4070 * and can deviate up to one second from the specified interval.
4071 * Subsequent timer iterations will generally run at the specified interval.
4073 * Note that timeout functions may be delayed, due to the processing of other
4074 * event sources. Thus they should not be relied on for precise timing.
4075 * After each call to the timeout function, the time of the next
4076 * timeout is recalculated based on the current time and the given @interval
4078 * If you want timing more precise than whole seconds, use g_timeout_add()
4079 * instead.
4081 * The grouping of timers to fire at the same time results in a more power
4082 * and CPU efficient behavior so if your timer is in multiples of seconds
4083 * and you don't require the first timer exactly one second from now, the
4084 * use of g_timeout_add_seconds() is preferred over g_timeout_add().
4086 * This internally creates a main loop source using
4087 * g_timeout_source_new_seconds() and attaches it to the main loop context
4088 * using g_source_attach(). You can do these steps manually if you need
4089 * greater control.
4091 * The interval given is in terms of monotonic time, not wall clock
4092 * time. See g_get_monotonic_time().
4094 * Return value: the ID (greater than 0) of the event source.
4096 * Rename to: g_timeout_add_seconds
4097 * Since: 2.14
4099 guint
4100 g_timeout_add_seconds_full (gint priority,
4101 guint32 interval,
4102 GSourceFunc function,
4103 gpointer data,
4104 GDestroyNotify notify)
4106 GSource *source;
4107 guint id;
4109 g_return_val_if_fail (function != NULL, 0);
4111 source = g_timeout_source_new_seconds (interval);
4113 if (priority != G_PRIORITY_DEFAULT)
4114 g_source_set_priority (source, priority);
4116 g_source_set_callback (source, function, data, notify);
4117 id = g_source_attach (source, NULL);
4118 g_source_unref (source);
4120 return id;
4124 * g_timeout_add_seconds:
4125 * @interval: the time between calls to the function, in seconds
4126 * @function: function to call
4127 * @data: data to pass to @function
4129 * Sets a function to be called at regular intervals with the default
4130 * priority, #G_PRIORITY_DEFAULT. The function is called repeatedly until
4131 * it returns %FALSE, at which point the timeout is automatically destroyed
4132 * and the function will not be called again.
4134 * This internally creates a main loop source using
4135 * g_timeout_source_new_seconds() and attaches it to the main loop context
4136 * using g_source_attach(). You can do these steps manually if you need
4137 * greater control. Also see g_timeout_add_seconds_full().
4139 * Note that the first call of the timer may not be precise for timeouts
4140 * of one second. If you need finer precision and have such a timeout,
4141 * you may want to use g_timeout_add() instead.
4143 * The interval given is in terms of monotonic time, not wall clock
4144 * time. See g_get_monotonic_time().
4146 * Return value: the ID (greater than 0) of the event source.
4148 * Since: 2.14
4150 guint
4151 g_timeout_add_seconds (guint interval,
4152 GSourceFunc function,
4153 gpointer data)
4155 g_return_val_if_fail (function != NULL, 0);
4157 return g_timeout_add_seconds_full (G_PRIORITY_DEFAULT, interval, function, data, NULL);
4160 /* Child watch functions */
4162 #ifdef G_OS_WIN32
4164 static gboolean
4165 g_child_watch_prepare (GSource *source,
4166 gint *timeout)
4168 *timeout = -1;
4169 return FALSE;
4172 static gboolean
4173 g_child_watch_check (GSource *source)
4175 GChildWatchSource *child_watch_source;
4176 gboolean child_exited;
4178 child_watch_source = (GChildWatchSource *) source;
4180 child_exited = child_watch_source->poll.revents & G_IO_IN;
4182 if (child_exited)
4184 DWORD child_status;
4187 * Note: We do _not_ check for the special value of STILL_ACTIVE
4188 * since we know that the process has exited and doing so runs into
4189 * problems if the child process "happens to return STILL_ACTIVE(259)"
4190 * as Microsoft's Platform SDK puts it.
4192 if (!GetExitCodeProcess (child_watch_source->pid, &child_status))
4194 gchar *emsg = g_win32_error_message (GetLastError ());
4195 g_warning (G_STRLOC ": GetExitCodeProcess() failed: %s", emsg);
4196 g_free (emsg);
4198 child_watch_source->child_status = -1;
4200 else
4201 child_watch_source->child_status = child_status;
4204 return child_exited;
4207 static void
4208 g_child_watch_finalize (GSource *source)
4212 #else /* G_OS_WIN32 */
4214 static void
4215 wake_source (GSource *source)
4217 GMainContext *context;
4219 /* This should be thread-safe:
4221 * - if the source is currently being added to a context, that
4222 * context will be woken up anyway
4224 * - if the source is currently being destroyed, we simply need not
4225 * to crash:
4227 * - the memory for the source will remain valid until after the
4228 * source finalize function was called (which would remove the
4229 * source from the global list which we are currently holding the
4230 * lock for)
4232 * - the GMainContext will either be NULL or point to a live
4233 * GMainContext
4235 * - the GMainContext will remain valid since we hold the
4236 * main_context_list lock
4238 * Since we are holding a lot of locks here, don't try to enter any
4239 * more GMainContext functions for fear of dealock -- just hit the
4240 * GWakeup and run. Even if that's safe now, it could easily become
4241 * unsafe with some very minor changes in the future, and signal
4242 * handling is not the most well-tested codepath.
4244 G_LOCK(main_context_list);
4245 context = source->context;
4246 if (context)
4247 g_wakeup_signal (context->wakeup);
4248 G_UNLOCK(main_context_list);
4251 static void
4252 dispatch_unix_signals (void)
4254 GSList *node;
4256 /* clear this first incase another one arrives while we're processing */
4257 any_unix_signal_pending = FALSE;
4259 G_LOCK(unix_signal_lock);
4261 /* handle GChildWatchSource instances */
4262 if (unix_signal_pending[SIGCHLD])
4264 unix_signal_pending[SIGCHLD] = FALSE;
4266 /* The only way we can do this is to scan all of the children.
4268 * The docs promise that we will not reap children that we are not
4269 * explicitly watching, so that ties our hands from calling
4270 * waitpid(-1). We also can't use siginfo's si_pid field since if
4271 * multiple SIGCHLD arrive at the same time, one of them can be
4272 * dropped (since a given UNIX signal can only be pending once).
4274 for (node = unix_child_watches; node; node = node->next)
4276 GChildWatchSource *source = node->data;
4278 if (!source->child_exited)
4280 if (waitpid (source->pid, &source->child_status, WNOHANG) > 0)
4282 source->child_exited = TRUE;
4284 wake_source ((GSource *) source);
4290 /* handle GUnixSignalWatchSource instances */
4291 for (node = unix_signal_watches; node; node = node->next)
4293 GUnixSignalWatchSource *source = node->data;
4295 if (!source->pending)
4297 if (unix_signal_pending[source->signum])
4299 unix_signal_pending[source->signum] = FALSE;
4300 source->pending = TRUE;
4302 wake_source ((GSource *) source);
4307 G_UNLOCK(unix_signal_lock);
4310 static gboolean
4311 g_child_watch_prepare (GSource *source,
4312 gint *timeout)
4314 GChildWatchSource *child_watch_source;
4316 child_watch_source = (GChildWatchSource *) source;
4318 return child_watch_source->child_exited;
4321 static gboolean
4322 g_child_watch_check (GSource *source)
4324 GChildWatchSource *child_watch_source;
4326 child_watch_source = (GChildWatchSource *) source;
4328 return child_watch_source->child_exited;
4331 static gboolean
4332 g_unix_signal_watch_prepare (GSource *source,
4333 gint *timeout)
4335 GUnixSignalWatchSource *unix_signal_source;
4337 unix_signal_source = (GUnixSignalWatchSource *) source;
4339 return unix_signal_source->pending;
4342 static gboolean
4343 g_unix_signal_watch_check (GSource *source)
4345 GUnixSignalWatchSource *unix_signal_source;
4347 unix_signal_source = (GUnixSignalWatchSource *) source;
4349 return unix_signal_source->pending;
4352 static gboolean
4353 g_unix_signal_watch_dispatch (GSource *source,
4354 GSourceFunc callback,
4355 gpointer user_data)
4357 GUnixSignalWatchSource *unix_signal_source;
4359 unix_signal_source = (GUnixSignalWatchSource *) source;
4361 if (!callback)
4363 g_warning ("Unix signal source dispatched without callback\n"
4364 "You must call g_source_set_callback().");
4365 return FALSE;
4368 (callback) (user_data);
4370 unix_signal_source->pending = FALSE;
4372 return TRUE;
4375 static void
4376 ensure_unix_signal_handler_installed_unlocked (int signum)
4378 static sigset_t installed_signal_mask;
4379 static gboolean initialized;
4380 struct sigaction action;
4382 if (!initialized)
4384 sigemptyset (&installed_signal_mask);
4385 g_get_worker_context ();
4386 initialized = TRUE;
4389 if (sigismember (&installed_signal_mask, signum))
4390 return;
4392 sigaddset (&installed_signal_mask, signum);
4394 action.sa_handler = g_unix_signal_handler;
4395 sigemptyset (&action.sa_mask);
4396 action.sa_flags = SA_RESTART | SA_NOCLDSTOP;
4397 sigaction (signum, &action, NULL);
4400 GSource *
4401 _g_main_create_unix_signal_watch (int signum)
4403 GSource *source;
4404 GUnixSignalWatchSource *unix_signal_source;
4406 source = g_source_new (&g_unix_signal_funcs, sizeof (GUnixSignalWatchSource));
4407 unix_signal_source = (GUnixSignalWatchSource *) source;
4409 unix_signal_source->signum = signum;
4410 unix_signal_source->pending = FALSE;
4412 G_LOCK (unix_signal_lock);
4413 ensure_unix_signal_handler_installed_unlocked (signum);
4414 unix_signal_watches = g_slist_prepend (unix_signal_watches, unix_signal_source);
4415 if (unix_signal_pending[signum])
4416 unix_signal_source->pending = TRUE;
4417 unix_signal_pending[signum] = FALSE;
4418 G_UNLOCK (unix_signal_lock);
4420 return source;
4423 static void
4424 g_unix_signal_watch_finalize (GSource *source)
4426 G_LOCK (unix_signal_lock);
4427 unix_signal_watches = g_slist_remove (unix_signal_watches, source);
4428 G_UNLOCK (unix_signal_lock);
4431 static void
4432 g_child_watch_finalize (GSource *source)
4434 G_LOCK (unix_signal_lock);
4435 unix_child_watches = g_slist_remove (unix_child_watches, source);
4436 G_UNLOCK (unix_signal_lock);
4439 #endif /* G_OS_WIN32 */
4441 static gboolean
4442 g_child_watch_dispatch (GSource *source,
4443 GSourceFunc callback,
4444 gpointer user_data)
4446 GChildWatchSource *child_watch_source;
4447 GChildWatchFunc child_watch_callback = (GChildWatchFunc) callback;
4449 child_watch_source = (GChildWatchSource *) source;
4451 if (!callback)
4453 g_warning ("Child watch source dispatched without callback\n"
4454 "You must call g_source_set_callback().");
4455 return FALSE;
4458 (child_watch_callback) (child_watch_source->pid, child_watch_source->child_status, user_data);
4460 /* We never keep a child watch source around as the child is gone */
4461 return FALSE;
4464 #ifndef G_OS_WIN32
4466 static void
4467 g_unix_signal_handler (int signum)
4469 unix_signal_pending[signum] = TRUE;
4470 any_unix_signal_pending = TRUE;
4472 g_wakeup_signal (glib_worker_context->wakeup);
4475 #endif /* !G_OS_WIN32 */
4478 * g_child_watch_source_new:
4479 * @pid: process to watch. On POSIX the pid of a child process. On
4480 * Windows a handle for a process (which doesn't have to be a child).
4482 * Creates a new child_watch source.
4484 * The source will not initially be associated with any #GMainContext
4485 * and must be added to one with g_source_attach() before it will be
4486 * executed.
4488 * Note that child watch sources can only be used in conjunction with
4489 * <literal>g_spawn...</literal> when the %G_SPAWN_DO_NOT_REAP_CHILD
4490 * flag is used.
4492 * Note that on platforms where #GPid must be explicitly closed
4493 * (see g_spawn_close_pid()) @pid must not be closed while the
4494 * source is still active. Typically, you will want to call
4495 * g_spawn_close_pid() in the callback function for the source.
4497 * Note further that using g_child_watch_source_new() is not
4498 * compatible with calling <literal>waitpid(-1)</literal> in
4499 * the application. Calling waitpid() for individual pids will
4500 * still work fine.
4502 * Return value: the newly-created child watch source
4504 * Since: 2.4
4506 GSource *
4507 g_child_watch_source_new (GPid pid)
4509 GSource *source = g_source_new (&g_child_watch_funcs, sizeof (GChildWatchSource));
4510 GChildWatchSource *child_watch_source = (GChildWatchSource *)source;
4512 child_watch_source->pid = pid;
4514 #ifdef G_OS_WIN32
4515 child_watch_source->poll.fd = (gintptr) pid;
4516 child_watch_source->poll.events = G_IO_IN;
4518 g_source_add_poll (source, &child_watch_source->poll);
4519 #else /* G_OS_WIN32 */
4520 G_LOCK (unix_signal_lock);
4521 ensure_unix_signal_handler_installed_unlocked (SIGCHLD);
4522 unix_child_watches = g_slist_prepend (unix_child_watches, child_watch_source);
4523 if (waitpid (pid, &child_watch_source->child_status, WNOHANG) > 0)
4524 child_watch_source->child_exited = TRUE;
4525 G_UNLOCK (unix_signal_lock);
4526 #endif /* G_OS_WIN32 */
4528 return source;
4532 * g_child_watch_add_full:
4533 * @priority: the priority of the idle source. Typically this will be in the
4534 * range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE.
4535 * @pid: process to watch. On POSIX the pid of a child process. On
4536 * Windows a handle for a process (which doesn't have to be a child).
4537 * @function: function to call
4538 * @data: data to pass to @function
4539 * @notify: (allow-none): function to call when the idle is removed, or %NULL
4541 * Sets a function to be called when the child indicated by @pid
4542 * exits, at the priority @priority.
4544 * If you obtain @pid from g_spawn_async() or g_spawn_async_with_pipes()
4545 * you will need to pass #G_SPAWN_DO_NOT_REAP_CHILD as flag to
4546 * the spawn function for the child watching to work.
4548 * Note that on platforms where #GPid must be explicitly closed
4549 * (see g_spawn_close_pid()) @pid must not be closed while the
4550 * source is still active. Typically, you will want to call
4551 * g_spawn_close_pid() in the callback function for the source.
4553 * GLib supports only a single callback per process id.
4555 * This internally creates a main loop source using
4556 * g_child_watch_source_new() and attaches it to the main loop context
4557 * using g_source_attach(). You can do these steps manually if you
4558 * need greater control.
4560 * Return value: the ID (greater than 0) of the event source.
4562 * Rename to: g_child_watch_add
4563 * Since: 2.4
4565 guint
4566 g_child_watch_add_full (gint priority,
4567 GPid pid,
4568 GChildWatchFunc function,
4569 gpointer data,
4570 GDestroyNotify notify)
4572 GSource *source;
4573 guint id;
4575 g_return_val_if_fail (function != NULL, 0);
4577 source = g_child_watch_source_new (pid);
4579 if (priority != G_PRIORITY_DEFAULT)
4580 g_source_set_priority (source, priority);
4582 g_source_set_callback (source, (GSourceFunc) function, data, notify);
4583 id = g_source_attach (source, NULL);
4584 g_source_unref (source);
4586 return id;
4590 * g_child_watch_add:
4591 * @pid: process id to watch. On POSIX the pid of a child process. On
4592 * Windows a handle for a process (which doesn't have to be a child).
4593 * @function: function to call
4594 * @data: data to pass to @function
4596 * Sets a function to be called when the child indicated by @pid
4597 * exits, at a default priority, #G_PRIORITY_DEFAULT.
4599 * If you obtain @pid from g_spawn_async() or g_spawn_async_with_pipes()
4600 * you will need to pass #G_SPAWN_DO_NOT_REAP_CHILD as flag to
4601 * the spawn function for the child watching to work.
4603 * Note that on platforms where #GPid must be explicitly closed
4604 * (see g_spawn_close_pid()) @pid must not be closed while the
4605 * source is still active. Typically, you will want to call
4606 * g_spawn_close_pid() in the callback function for the source.
4608 * GLib supports only a single callback per process id.
4610 * This internally creates a main loop source using
4611 * g_child_watch_source_new() and attaches it to the main loop context
4612 * using g_source_attach(). You can do these steps manually if you
4613 * need greater control.
4615 * Return value: the ID (greater than 0) of the event source.
4617 * Since: 2.4
4619 guint
4620 g_child_watch_add (GPid pid,
4621 GChildWatchFunc function,
4622 gpointer data)
4624 return g_child_watch_add_full (G_PRIORITY_DEFAULT, pid, function, data, NULL);
4628 /* Idle functions */
4630 static gboolean
4631 g_idle_prepare (GSource *source,
4632 gint *timeout)
4634 *timeout = 0;
4636 return TRUE;
4639 static gboolean
4640 g_idle_check (GSource *source)
4642 return TRUE;
4645 static gboolean
4646 g_idle_dispatch (GSource *source,
4647 GSourceFunc callback,
4648 gpointer user_data)
4650 if (!callback)
4652 g_warning ("Idle source dispatched without callback\n"
4653 "You must call g_source_set_callback().");
4654 return FALSE;
4657 return callback (user_data);
4661 * g_idle_source_new:
4663 * Creates a new idle source.
4665 * The source will not initially be associated with any #GMainContext
4666 * and must be added to one with g_source_attach() before it will be
4667 * executed. Note that the default priority for idle sources is
4668 * %G_PRIORITY_DEFAULT_IDLE, as compared to other sources which
4669 * have a default priority of %G_PRIORITY_DEFAULT.
4671 * Return value: the newly-created idle source
4673 GSource *
4674 g_idle_source_new (void)
4676 GSource *source;
4678 source = g_source_new (&g_idle_funcs, sizeof (GSource));
4679 g_source_set_priority (source, G_PRIORITY_DEFAULT_IDLE);
4681 return source;
4685 * g_idle_add_full:
4686 * @priority: the priority of the idle source. Typically this will be in the
4687 * range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE.
4688 * @function: function to call
4689 * @data: data to pass to @function
4690 * @notify: (allow-none): function to call when the idle is removed, or %NULL
4692 * Adds a function to be called whenever there are no higher priority
4693 * events pending. If the function returns %FALSE it is automatically
4694 * removed from the list of event sources and will not be called again.
4696 * This internally creates a main loop source using g_idle_source_new()
4697 * and attaches it to the main loop context using g_source_attach().
4698 * You can do these steps manually if you need greater control.
4700 * Return value: the ID (greater than 0) of the event source.
4701 * Rename to: g_idle_add
4703 guint
4704 g_idle_add_full (gint priority,
4705 GSourceFunc function,
4706 gpointer data,
4707 GDestroyNotify notify)
4709 GSource *source;
4710 guint id;
4712 g_return_val_if_fail (function != NULL, 0);
4714 source = g_idle_source_new ();
4716 if (priority != G_PRIORITY_DEFAULT_IDLE)
4717 g_source_set_priority (source, priority);
4719 g_source_set_callback (source, function, data, notify);
4720 id = g_source_attach (source, NULL);
4721 g_source_unref (source);
4723 return id;
4727 * g_idle_add:
4728 * @function: function to call
4729 * @data: data to pass to @function.
4731 * Adds a function to be called whenever there are no higher priority
4732 * events pending to the default main loop. The function is given the
4733 * default idle priority, #G_PRIORITY_DEFAULT_IDLE. If the function
4734 * returns %FALSE it is automatically removed from the list of event
4735 * sources and will not be called again.
4737 * This internally creates a main loop source using g_idle_source_new()
4738 * and attaches it to the main loop context using g_source_attach().
4739 * You can do these steps manually if you need greater control.
4741 * Return value: the ID (greater than 0) of the event source.
4743 guint
4744 g_idle_add (GSourceFunc function,
4745 gpointer data)
4747 return g_idle_add_full (G_PRIORITY_DEFAULT_IDLE, function, data, NULL);
4751 * g_idle_remove_by_data:
4752 * @data: the data for the idle source's callback.
4754 * Removes the idle function with the given data.
4756 * Return value: %TRUE if an idle source was found and removed.
4758 gboolean
4759 g_idle_remove_by_data (gpointer data)
4761 return g_source_remove_by_funcs_user_data (&g_idle_funcs, data);
4765 * g_main_context_invoke:
4766 * @context: (allow-none): a #GMainContext, or %NULL
4767 * @function: function to call
4768 * @data: data to pass to @function
4770 * Invokes a function in such a way that @context is owned during the
4771 * invocation of @function.
4773 * If @context is %NULL then the global default main context — as
4774 * returned by g_main_context_default() — is used.
4776 * If @context is owned by the current thread, @function is called
4777 * directly. Otherwise, if @context is the thread-default main context
4778 * of the current thread and g_main_context_acquire() succeeds, then
4779 * @function is called and g_main_context_release() is called
4780 * afterwards.
4782 * In any other case, an idle source is created to call @function and
4783 * that source is attached to @context (presumably to be run in another
4784 * thread). The idle source is attached with #G_PRIORITY_DEFAULT
4785 * priority. If you want a different priority, use
4786 * g_main_context_invoke_full().
4788 * Note that, as with normal idle functions, @function should probably
4789 * return %FALSE. If it returns %TRUE, it will be continuously run in a
4790 * loop (and may prevent this call from returning).
4792 * Since: 2.28
4794 void
4795 g_main_context_invoke (GMainContext *context,
4796 GSourceFunc function,
4797 gpointer data)
4799 g_main_context_invoke_full (context,
4800 G_PRIORITY_DEFAULT,
4801 function, data, NULL);
4805 * g_main_context_invoke_full:
4806 * @context: (allow-none): a #GMainContext, or %NULL
4807 * @priority: the priority at which to run @function
4808 * @function: function to call
4809 * @data: data to pass to @function
4810 * @notify: (allow-none): a function to call when @data is no longer in use, or %NULL.
4812 * Invokes a function in such a way that @context is owned during the
4813 * invocation of @function.
4815 * This function is the same as g_main_context_invoke() except that it
4816 * lets you specify the priority incase @function ends up being
4817 * scheduled as an idle and also lets you give a #GDestroyNotify for @data.
4819 * @notify should not assume that it is called from any particular
4820 * thread or with any particular context acquired.
4822 * Since: 2.28
4824 void
4825 g_main_context_invoke_full (GMainContext *context,
4826 gint priority,
4827 GSourceFunc function,
4828 gpointer data,
4829 GDestroyNotify notify)
4831 g_return_if_fail (function != NULL);
4833 if (!context)
4834 context = g_main_context_default ();
4836 if (g_main_context_is_owner (context))
4838 while (function (data));
4839 if (notify != NULL)
4840 notify (data);
4843 else
4845 GMainContext *thread_default;
4847 thread_default = g_main_context_get_thread_default ();
4849 if (!thread_default)
4850 thread_default = g_main_context_default ();
4852 if (thread_default == context && g_main_context_acquire (context))
4854 while (function (data));
4856 g_main_context_release (context);
4858 if (notify != NULL)
4859 notify (data);
4861 else
4863 GSource *source;
4865 source = g_idle_source_new ();
4866 g_source_set_priority (source, priority);
4867 g_source_set_callback (source, function, data, notify);
4868 g_source_attach (source, context);
4869 g_source_unref (source);
4874 static gpointer
4875 glib_worker_main (gpointer data)
4877 while (TRUE)
4879 g_main_context_iteration (glib_worker_context, TRUE);
4881 #ifdef G_OS_UNIX
4882 if (any_unix_signal_pending)
4883 dispatch_unix_signals ();
4884 #endif
4887 return NULL; /* worst GCC warning message ever... */
4890 GMainContext *
4891 g_get_worker_context (void)
4893 static gsize initialised;
4895 if (g_once_init_enter (&initialised))
4897 /* mask all signals in the worker thread */
4898 #ifdef G_OS_UNIX
4899 sigset_t prev_mask;
4900 sigset_t all;
4902 sigfillset (&all);
4903 pthread_sigmask (SIG_SETMASK, &all, &prev_mask);
4904 #endif
4905 glib_worker_context = g_main_context_new ();
4906 g_thread_new ("gmain", glib_worker_main, NULL);
4907 #ifdef G_OS_UNIX
4908 pthread_sigmask (SIG_SETMASK, &prev_mask, NULL);
4909 #endif
4910 g_once_init_leave (&initialised, TRUE);
4913 return glib_worker_context;