* are also thread-safe.
*/
-/**
- * G_THREADS_IMPL_POSIX:
- *
- * This macro is defined if POSIX style threads are used.
- */
-
-/**
- * G_THREADS_IMPL_WIN32:
- *
- * This macro is defined if Windows style threads are used.
- */
-
/* G_LOCK Documentation {{{1 ---------------------------------------------- */
/**
*
* It is easy to see that this won't work in a multi-threaded
* application. There current_number must be protected against shared
- * access. A first naive implementation would be:
- *
- * <example>
- * <title>The wrong way to write a thread-safe function</title>
- * <programlisting>
- * int
- * give_me_next_number (void)
- * {
- * static int current_number = 0;
- * int ret_val;
- * static GMutex * mutex = NULL;
- *
- * if (!mutex) mutex = g_mutex_new (<!-- -->);
- *
- * g_mutex_lock (mutex);
- * ret_val = current_number = calc_next_number (current_number);
- * g_mutex_unlock (mutex);
- *
- * return ret_val;
- * }
- * </programlisting>
- * </example>
- *
- * This looks like it would work, but there is a race condition while
- * constructing the mutex and this code cannot work reliable. Please do
- * not use such constructs in your own programs! One working solution
- * is:
+ * access. A #GMutex can be used as a solution to this problem:
*
* <example>
- * <title>A correct thread-safe function</title>
- * <programlisting>
- * static GMutex *give_me_next_number_mutex = NULL;
- *
- * /<!-- -->* this function must be called before any call to
- * * give_me_next_number(<!-- -->)
- * *
- * * it must be called exactly once.
- * *<!-- -->/
- * void
- * init_give_me_next_number (void)
- * {
- * g_assert (give_me_next_number_mutex == NULL);
- * give_me_next_number_mutex = g_mutex_new (<!-- -->);
- * }
- *
- * int
- * give_me_next_number (void)
- * {
- * static int current_number = 0;
- * int ret_val;
- *
- * g_mutex_lock (give_me_next_number_mutex);
- * ret_val = current_number = calc_next_number (current_number);
- * g_mutex_unlock (give_me_next_number_mutex);
- *
- * return ret_val;
- * }
- * </programlisting>
- * </example>
- *
- * If a #GMutex is allocated in static storage then it can be used
- * without initialisation. Otherwise, you should call g_mutex_init() on
- * it and g_mutex_clear() when done.
- *
- * A statically initialized #GMutex provides an even simpler and safer
- * way of doing this:
- *
- * <example>
- * <title>Using a statically allocated mutex</title>
+ * <title>Using GMutex to protected a shared variable</title>
* <programlisting>
* int
* give_me_next_number (void)
* </programlisting>
* </example>
*
+ * Notice that the #GMutex is not initialised to any particular value.
+ * Its placement in static storage ensures that it will be initialised
+ * to all-zeros, which is appropriate.
+ *
+ * If a #GMutex is placed in other contexts (eg: embedded in a struct)
+ * then it must be explicitly initialised using g_mutex_init().
+ *
* A #GMutex should only be accessed via <function>g_mutex_</function>
* functions.
*/
* condition they signal the #GCond, and that causes the waiting
* threads to be woken up.
*
+ * Consider the following example of a shared variable. One or more
+ * threads can wait for data to be published to the variable and when
+ * another thread publishes the data, it can signal one of the waiting
+ * threads to wake up to collect the data.
+ *
* <example>
* <title>
* Using GCond to block a thread until a condition is satisfied
* </title>
* <programlisting>
- * GCond* data_cond = NULL; /<!-- -->* Must be initialized somewhere *<!-- -->/
- * GMutex* data_mutex = NULL; /<!-- -->* Must be initialized somewhere *<!-- -->/
* gpointer current_data = NULL;
+ * GMutex data_mutex;
+ * GCond data_cond;
*
* void
* push_data (gpointer data)
* {
- * g_mutex_lock (data_mutex);
+ * g_mutex_lock (&data_mutex);
* current_data = data;
- * g_cond_signal (data_cond);
- * g_mutex_unlock (data_mutex);
+ * g_cond_signal (&data_cond);
+ * g_mutex_unlock (&data_mutex);
* }
*
* gpointer
* {
* gpointer data;
*
- * g_mutex_lock (data_mutex);
+ * g_mutex_lock (&data_mutex);
* while (!current_data)
- * g_cond_wait (data_cond, data_mutex);
+ * g_cond_wait (&data_cond, &data_mutex);
* data = current_data;
* current_data = NULL;
- * g_mutex_unlock (data_mutex);
+ * g_mutex_unlock (&data_mutex);
*
* return data;
* }
* current_data is non-%NULL, i.e. until some other thread
* has called push_data().
*
- * <note><para>It is important to use the g_cond_wait() and
- * g_cond_timed_wait() functions only inside a loop which checks for the
- * condition to be true. It is not guaranteed that the waiting thread
- * will find the condition fulfilled after it wakes up, even if the
- * signaling thread left the condition in that state: another thread may
- * have altered the condition before the waiting thread got the chance
- * to be woken up, even if the condition itself is protected by a
- * #GMutex, like above.</para></note>
+ * The example shows that use of a condition variable must always be
+ * paired with a mutex. Without the use of a mutex, there would be a
+ * race between the check of <varname>current_data</varname> by the
+ * while loop in <function>pop_data</function> and waiting.
+ * Specifically, another thread could set <varname>pop_data</varname>
+ * after the check, and signal the cond (with nobody waiting on it)
+ * before the first thread goes to sleep. #GCond is specifically useful
+ * for its ability to release the mutex and go to sleep atomically.
+ *
+ * It is also important to use the g_cond_wait() and g_cond_wait_until()
+ * functions only inside a loop which checks for the condition to be
+ * true. See g_cond_wait() for an explanation of why the condition may
+ * not be true even after it returns.
*
* If a #GCond is allocated in static storage then it can be used
* without initialisation. Otherwise, you should call g_cond_init() on
* GThread:
*
* The #GThread struct represents a running thread. This struct
- * is returned by g_thread_new() or g_thread_new_full(). You can
- * obtain the #GThread struct representing the current thead by
- * calling g_thread_self().
+ * is returned by g_thread_new() or g_thread_try_new(). You can obtain
+ * the #GThread struct representing the current thead by calling
+ * g_thread_self().
+ *
+ * The structure is opaque -- none of its fields may be directly
+ * accessed.
*/
/**
* GThreadFunc:
* @data: data passed to the thread
*
- * Specifies the type of the @func functions passed to
- * g_thread_new() or g_thread_new_full().
- *
- * If the thread is joinable, the return value of this function
- * is returned by a g_thread_join() call waiting for the thread.
- * If the thread is not joinable, the return value is ignored.
+ * Specifies the type of the @func functions passed to g_thread_new() or
+ * g_thread_try_new().
*
* Returns: the return value of the thread
*/
/* Local Data {{{1 -------------------------------------------------------- */
-GMutex g_once_mutex;
+static GMutex g_once_mutex;
static GCond g_once_cond;
static GSList *g_once_init_list = NULL;
/* GThread {{{1 -------------------------------------------------------- */
-static void
-g_thread_cleanup (gpointer data)
+GThread *
+g_thread_ref (GThread *thread)
{
- if (data)
- {
- GRealThread* thread = data;
+ GRealThread *real = (GRealThread *) thread;
- g_static_private_cleanup (thread);
+ g_atomic_int_inc (&real->ref_count);
- /* We only free the thread structure if it isn't joinable.
- * If it is, the structure is freed in g_thread_join()
- */
- if (!thread->thread.joinable)
- {
- if (thread->enumerable)
- g_enumerable_thread_remove (thread);
+ return thread;
+}
- /* Just to make sure, this isn't used any more */
- g_system_thread_assign (thread->system_thread, zero_thread);
- g_free (thread);
- }
+void
+g_thread_unref (GThread *thread)
+{
+ GRealThread *real = (GRealThread *) thread;
+
+ if (g_atomic_int_dec_and_test (&real->ref_count))
+ {
+ if (real->ours)
+ g_system_thread_free (real);
+ else
+ g_slice_free (GRealThread, real);
}
}
-static gpointer
-g_thread_create_proxy (gpointer data)
+static void
+g_thread_cleanup (gpointer data)
+{
+ g_thread_unref (data);
+}
+
+gpointer
+g_thread_proxy (gpointer data)
{
GRealThread* thread = data;
/* This has to happen before G_LOCK, as that might call g_thread_self */
g_private_set (&g_thread_specific_private, data);
- /* The lock makes sure that thread->system_thread is written,
- * before thread->thread.func is called. See g_thread_new_internal().
+ /* The lock makes sure that g_thread_new_internal() has a chance to
+ * setup 'func' and 'data' before we make the call.
*/
G_LOCK (g_thread_new);
G_UNLOCK (g_thread_new);
* @name: a name for the new thread
* @func: a function to execute in the new thread
* @data: an argument to supply to the new thread
- * @joinable: should this thread be joinable?
* @error: return location for error
*
- * This function creates a new thread. The new thread starts by
- * invoking @func with the argument data. The thread will run
- * until @func returns or until g_thread_exit() is called.
+ * This function creates a new thread. The new thread starts by invoking
+ * @func with the argument data. The thread will run until @func returns
+ * or until g_thread_exit() is called from the new thread.
*
* The @name can be useful for discriminating threads in
* a debugger. Some systems restrict the length of @name to
* 16 bytes.
*
- * If @joinable is %TRUE, you can wait for this threads termination
- * calling g_thread_join(). Resources for a joinable thread are not
- * fully released until g_thread_join() is called for that thread.
- * Otherwise the thread will just disappear when it terminates.
+ * If the thread can not be created the program aborts. See
+ * g_thread_try_new() if you want to attempt to deal with failures.
*
- * @error can be %NULL to ignore errors, or non-%NULL to report errors.
- * The error is set, if and only if the function returns %NULL.
- *
- * Returns: the new #GThread, or %NULL if an error occurred
+ * Returns: the new #GThread
*
* Since: 2.32
*/
GThread *
-g_thread_new (const gchar *name,
- GThreadFunc func,
- gpointer data,
- gboolean joinable,
- GError **error)
+g_thread_new (const gchar *name,
+ GThreadFunc func,
+ gpointer data)
{
- return g_thread_new_internal (name, func, data, joinable, 0, FALSE, error);
+ GError *error = NULL;
+ GThread *thread;
+
+ thread = g_thread_new_internal (name, g_thread_proxy, func, data, 0, &error);
+
+ if G_UNLIKELY (thread == NULL)
+ g_error ("creating thread '%s': %s", name ? name : "", error->message);
+
+ return thread;
}
/**
- * g_thread_new_full:
+ * g_thread_try_new:
* @name: a name for the new thread
* @func: a function to execute in the new thread
* @data: an argument to supply to the new thread
- * @joinable: should this thread be joinable?
- * @stack_size: a stack size for the new thread
- * @error: return location for error
- *
- * This function creates a new thread. The new thread starts by
- * invoking @func with the argument data. The thread will run
- * until @func returns or until g_thread_exit() is called.
- *
- * The @name can be useful for discriminating threads in
- * a debugger. Some systems restrict the length of @name to
- * 16 bytes.
+ * @error: return location for error, or %NULL
*
- * If the underlying thread implementation supports it, the thread
- * gets a stack size of @stack_size or the default value for the
- * current platform, if @stack_size is 0. Note that you should only
- * use a non-zero @stack_size if you really can't use the default.
- * In most cases, using g_thread_new() (which doesn't take a
- * @stack_size) is better.
+ * This function is the same as g_thread_new() except that
+ * it allows for the possibility of failure.
*
- * If @joinable is %TRUE, you can wait for this threads termination
- * calling g_thread_join(). Resources for a joinable thread are not
- * fully released until g_thread_join() is called for that thread.
- * Otherwise the thread will just disappear when it terminates.
- *
- * @error can be %NULL to ignore errors, or non-%NULL to report errors.
- * The error is set, if and only if the function returns %NULL.
+ * If a thread can not be created (due to resource limits),
+ * @error is set and %NULL is returned.
*
* Returns: the new #GThread, or %NULL if an error occurred
*
* Since: 2.32
*/
GThread *
-g_thread_new_full (const gchar *name,
- GThreadFunc func,
- gpointer data,
- gboolean joinable,
- gsize stack_size,
- GError **error)
+g_thread_try_new (const gchar *name,
+ GThreadFunc func,
+ gpointer data,
+ GError **error)
{
- return g_thread_new_internal (name, func, data, joinable, stack_size, FALSE, error);
+ return g_thread_new_internal (name, g_thread_proxy, func, data, 0, error);
}
GThread *
-g_thread_new_internal (const gchar *name,
- GThreadFunc func,
- gpointer data,
- gboolean joinable,
- gsize stack_size,
- gboolean enumerable,
- GError **error)
+g_thread_new_internal (const gchar *name,
+ GThreadFunc proxy,
+ GThreadFunc func,
+ gpointer data,
+ gsize stack_size,
+ GError **error)
{
- GRealThread *result;
- GError *local_error = NULL;
+ GRealThread *thread;
g_return_val_if_fail (func != NULL, NULL);
- result = g_new0 (GRealThread, 1);
-
- result->thread.joinable = joinable;
- result->thread.func = func;
- result->thread.data = data;
- result->private_data = NULL;
- result->enumerable = enumerable;
- result->name = name;
G_LOCK (g_thread_new);
- g_system_thread_create (g_thread_create_proxy, result,
- stack_size, joinable,
- &result->system_thread, &local_error);
- if (enumerable && !local_error)
- g_enumerable_thread_add (result);
- G_UNLOCK (g_thread_new);
-
- if (local_error)
+ thread = g_system_thread_new (proxy, stack_size, error);
+ if (thread)
{
- g_propagate_error (error, local_error);
- g_free (result);
- return NULL;
+ thread->ref_count = 2;
+ thread->ours = TRUE;
+ thread->thread.joinable = TRUE;
+ thread->thread.func = func;
+ thread->thread.data = data;
+ thread->name = name;
}
+ G_UNLOCK (g_thread_new);
- return (GThread*) result;
+ return (GThread*) thread;
}
/**
*
* Terminates the current thread.
*
- * If another thread is waiting for that thread using g_thread_join()
- * and the current thread is joinable, the waiting thread will be woken
- * up and get @retval as the return value of g_thread_join(). If the
- * current thread is not joinable, @retval is ignored.
+ * If another thread is waiting for us using g_thread_join() then the
+ * waiting thread will be woken up and get @retval as the return value
+ * of g_thread_join().
*
* Calling <literal>g_thread_exit (retval)</literal> is equivalent to
* returning @retval from the function @func, as given to g_thread_new().
/**
* g_thread_join:
- * @thread: a joinable #GThread
+ * @thread: a #GThread
*
* Waits until @thread finishes, i.e. the function @func, as
* given to g_thread_new(), returns or g_thread_exit() is called.
* If @thread has already terminated, then g_thread_join()
- * returns immediately. @thread must be joinable.
+ * returns immediately.
*
- * Any thread can wait for any other (joinable) thread by calling
- * g_thread_join(), not just its 'creator'. Calling g_thread_join()
- * from multiple threads for the same @thread leads to undefined
- * behaviour.
+ * Any thread can wait for any other thread by calling g_thread_join(),
+ * not just its 'creator'. Calling g_thread_join() from multiple threads
+ * for the same @thread leads to undefined behaviour.
*
* The value returned by @func or given to g_thread_exit() is
* returned by this function.
gpointer retval;
g_return_val_if_fail (thread, NULL);
- g_return_val_if_fail (thread->joinable, NULL);
- g_return_val_if_fail (!g_system_thread_equal (&real->system_thread, &zero_thread), NULL);
- g_system_thread_join (&real->system_thread);
+ g_system_thread_wait (real);
retval = real->retval;
- if (real->enumerable)
- g_enumerable_thread_remove (real);
-
/* Just to make sure, this isn't used any more */
thread->joinable = 0;
- g_system_thread_assign (real->system_thread, zero_thread);
- /* the thread structure for non-joinable threads is freed upon
- * thread end. We free the memory here. This will leave a loose end,
- * if a joinable thread is not joined.
- */
- g_free (thread);
+ g_thread_unref (thread);
return retval;
}
* g_thread_self:
*
* This functions returns the #GThread corresponding to the
- * current thread.
+ * current thread. Note that this function does not increase
+ * the reference count of the returned object.
*
* Returns: the #GThread representing the current thread
*/
* This can happen for the main thread and for threads
* that are not created by GLib.
*/
- thread = g_new0 (GRealThread, 1);
- thread->thread.joinable = FALSE; /* This is a safe guess */
- thread->thread.func = NULL;
- thread->thread.data = NULL;
- thread->private_data = NULL;
- thread->enumerable = FALSE;
-
- g_system_thread_self (&thread->system_thread);
+ thread = g_slice_new0 (GRealThread);
+ thread->ref_count = 1;
g_private_set (&g_thread_specific_private, thread);
}
- return (GThread*)thread;
+ return (GThread*) thread;
}
/* Epilogue {{{1 */
projects / platform / upstream / glib.git / blobdiff