williamr@2: /* GLIB - Library of useful routines for C programming williamr@2: * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald williamr@2: * Portions copyright (c) 2006 Nokia Corporation. All rights reserved. williamr@2: * williamr@2: * This library is free software; you can redistribute it and/or williamr@2: * modify it under the terms of the GNU Lesser General Public williamr@2: * License as published by the Free Software Foundation; either williamr@2: * version 2 of the License, or (at your option) any later version. williamr@2: * williamr@2: * This library is distributed in the hope that it will be useful, williamr@2: * but WITHOUT ANY WARRANTY; without even the implied warranty of williamr@2: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU williamr@2: * Lesser General Public License for more details. williamr@2: * williamr@2: * You should have received a copy of the GNU Lesser General Public williamr@2: * License along with this library; if not, write to the williamr@2: * Free Software Foundation, Inc., 59 Temple Place - Suite 330, williamr@2: * Boston, MA 02111-1307, USA. williamr@2: */ williamr@2: williamr@2: /* williamr@2: * Modified by the GLib Team and others 1997-2000. See the AUTHORS williamr@2: * file for a list of people on the GLib Team. See the ChangeLog williamr@2: * files for a list of changes. These files are distributed with williamr@2: * GLib at ftp://ftp.gtk.org/pub/gtk/. williamr@2: */ williamr@2: williamr@2: #ifndef __G_THREAD_H__ williamr@2: #define __G_THREAD_H__ williamr@2: williamr@2: #include <_ansi.h> williamr@2: #include williamr@2: #include williamr@2: #include /* for g_atomic_pointer_get */ williamr@2: williamr@2: G_BEGIN_DECLS williamr@2: williamr@2: /* GLib Thread support williamr@2: */ williamr@2: #ifdef __SYMBIAN32__ williamr@2: IMPORT_C GQuark g_thread_error_quark (void); williamr@2: #else williamr@2: extern GQuark g_thread_error_quark (void); williamr@2: #endif /* __SYMBIAN32__ */ williamr@2: #define G_THREAD_ERROR g_thread_error_quark () williamr@2: williamr@2: typedef enum williamr@2: { williamr@2: G_THREAD_ERROR_AGAIN /* Resource temporarily unavailable */ williamr@2: } GThreadError; williamr@2: williamr@2: typedef gpointer (*GThreadFunc) (gpointer data); williamr@2: williamr@2: typedef enum williamr@2: { williamr@2: G_THREAD_PRIORITY_LOW, williamr@2: G_THREAD_PRIORITY_NORMAL, williamr@2: G_THREAD_PRIORITY_HIGH, williamr@2: G_THREAD_PRIORITY_URGENT williamr@2: } GThreadPriority; williamr@2: williamr@2: typedef struct _GThread GThread; williamr@2: struct _GThread williamr@2: { williamr@2: /*< private >*/ williamr@2: GThreadFunc func; williamr@2: gpointer data; williamr@2: gboolean joinable; williamr@2: GThreadPriority priority; williamr@2: }; williamr@2: williamr@2: typedef struct _GMutex GMutex; williamr@2: typedef struct _GCond GCond; williamr@2: typedef struct _GPrivate GPrivate; williamr@2: typedef struct _GStaticPrivate GStaticPrivate; williamr@2: williamr@2: typedef struct _GThreadFunctions GThreadFunctions; williamr@2: struct _GThreadFunctions williamr@2: { williamr@2: GMutex* (*mutex_new) (void); williamr@2: void (*mutex_lock) (GMutex *mutex); williamr@2: gboolean (*mutex_trylock) (GMutex *mutex); williamr@2: void (*mutex_unlock) (GMutex *mutex); williamr@2: void (*mutex_free) (GMutex *mutex); williamr@2: GCond* (*cond_new) (void); williamr@2: void (*cond_signal) (GCond *cond); williamr@2: void (*cond_broadcast) (GCond *cond); williamr@2: void (*cond_wait) (GCond *cond, williamr@2: GMutex *mutex); williamr@2: gboolean (*cond_timed_wait) (GCond *cond, williamr@2: GMutex *mutex, williamr@2: GTimeVal *end_time); williamr@2: void (*cond_free) (GCond *cond); williamr@2: GPrivate* (*private_new) (GDestroyNotify destructor); williamr@2: gpointer (*private_get) (GPrivate *private_key); williamr@2: void (*private_set) (GPrivate *private_key, williamr@2: gpointer data); williamr@2: void (*thread_create) (GThreadFunc func, williamr@2: gpointer data, williamr@2: gulong stack_size, williamr@2: gboolean joinable, williamr@2: gboolean bound, williamr@2: GThreadPriority priority, williamr@2: gpointer thread, williamr@2: GError **error); williamr@2: void (*thread_yield) (void); williamr@2: void (*thread_join) (gpointer thread); williamr@2: void (*thread_exit) (void); williamr@2: void (*thread_set_priority)(gpointer thread, williamr@2: GThreadPriority priority); williamr@2: void (*thread_self) (gpointer thread); williamr@2: gboolean (*thread_equal) (gpointer thread1, williamr@2: gpointer thread2); williamr@2: }; williamr@2: williamr@2: #ifdef __SYMBIAN32__ williamr@2: IMPORT_C GThreadFunctions *_g_thread_functions_for_glib_use(); williamr@2: #endif /* __SYMBIAN32__ */ williamr@2: GLIB_VAR GThreadFunctions g_thread_functions_for_glib_use; williamr@2: williamr@2: #ifdef __SYMBIAN32__ williamr@2: IMPORT_C gboolean *_g_thread_use_default_impl(); williamr@2: #endif /* __SYMBIAN32__ */ williamr@2: GLIB_VAR gboolean g_thread_use_default_impl; williamr@2: williamr@2: #ifdef __SYMBIAN32__ williamr@2: IMPORT_C gboolean *_g_threads_got_initialized(); williamr@2: #endif /* __SYMBIAN32__ */ williamr@2: GLIB_VAR gboolean g_threads_got_initialized; williamr@2: williamr@2: /* initializes the mutex/cond/private implementation for glib, might williamr@2: * only be called once, and must not be called directly or indirectly williamr@2: * from another glib-function, e.g. as a callback. williamr@2: */ williamr@2: IMPORT_C void g_thread_init (GThreadFunctions *vtable); williamr@2: williamr@2: #ifdef __SYMBIAN32__ williamr@2: IMPORT_C gboolean g_thread_supported(); williamr@2: #else williamr@2: #define g_thread_supported() (g_threads_got_initialized) williamr@2: #endif williamr@2: williamr@2: /* Errorcheck mutexes. If you define G_ERRORCHECK_MUTEXES, then all williamr@2: * mutexes will check for re-locking and re-unlocking */ williamr@2: williamr@2: /* Initialize thread system with errorcheck mutexes. vtable must be williamr@2: * NULL. Do not call directly. Use #define G_ERRORCHECK_MUTEXES williamr@2: * instead. williamr@2: */ williamr@2: IMPORT_C void g_thread_init_with_errorcheck_mutexes (GThreadFunctions* vtable); williamr@2: williamr@2: /* A random number to recognize debug calls to g_mutex_... */ williamr@2: #define G_MUTEX_DEBUG_MAGIC 0xf8e18ad7 williamr@2: williamr@2: #ifdef G_ERRORCHECK_MUTEXES williamr@2: #define g_thread_init(vtable) g_thread_init_with_errorcheck_mutexes (vtable) williamr@2: #endif williamr@2: williamr@2: /* internal function for fallback static mutex implementation */ williamr@2: IMPORT_C GMutex* g_static_mutex_get_mutex_impl (GMutex **mutex); williamr@2: williamr@2: #define g_static_mutex_get_mutex_impl_shortcut(mutex) \ williamr@2: (g_atomic_pointer_get ((gpointer*)(void*)mutex) ? *(mutex) : \ williamr@2: g_static_mutex_get_mutex_impl (mutex)) williamr@2: williamr@2: /* shorthands for conditional and unconditional function calls */ williamr@2: williamr@2: #define G_THREAD_UF(op, arglist) \ williamr@2: (*g_thread_functions_for_glib_use . op) arglist williamr@2: #define G_THREAD_CF(op, fail, arg) \ williamr@2: (g_thread_supported () ? G_THREAD_UF (op, arg) : (fail)) williamr@2: #define G_THREAD_ECF(op, fail, mutex, type) \ williamr@2: (g_thread_supported () ? ((type(*)(GMutex*, gulong, gchar*)) \ williamr@2: (*g_thread_functions_for_glib_use . op)) \ williamr@2: (mutex, G_MUTEX_DEBUG_MAGIC, G_STRLOC) : (fail)) williamr@2: williamr@2: #ifndef G_ERRORCHECK_MUTEXES williamr@2: # define g_mutex_lock(mutex) \ williamr@2: G_THREAD_CF (mutex_lock, (void)0, (mutex)) williamr@2: # define g_mutex_trylock(mutex) \ williamr@2: G_THREAD_CF (mutex_trylock, TRUE, (mutex)) williamr@2: # define g_mutex_unlock(mutex) \ williamr@2: G_THREAD_CF (mutex_unlock, (void)0, (mutex)) williamr@2: # define g_mutex_free(mutex) \ williamr@2: G_THREAD_CF (mutex_free, (void)0, (mutex)) williamr@2: # define g_cond_wait(cond, mutex) \ williamr@2: G_THREAD_CF (cond_wait, (void)0, (cond, mutex)) williamr@2: # define g_cond_timed_wait(cond, mutex, abs_time) \ williamr@2: G_THREAD_CF (cond_timed_wait, TRUE, (cond, mutex, abs_time)) williamr@2: #else /* G_ERRORCHECK_MUTEXES */ williamr@2: # define g_mutex_lock(mutex) \ williamr@2: G_THREAD_ECF (mutex_lock, (void)0, (mutex), void) williamr@2: # define g_mutex_trylock(mutex) \ williamr@2: G_THREAD_ECF (mutex_trylock, TRUE, (mutex), gboolean) williamr@2: # define g_mutex_unlock(mutex) \ williamr@2: G_THREAD_ECF (mutex_unlock, (void)0, (mutex), void) williamr@2: # define g_mutex_free(mutex) \ williamr@2: G_THREAD_ECF (mutex_free, (void)0, (mutex), void) williamr@2: # define g_cond_wait(cond, mutex) \ williamr@2: (g_thread_supported () ? ((void(*)(GCond*, GMutex*, gulong, gchar*))\ williamr@2: g_thread_functions_for_glib_use.cond_wait) \ williamr@2: (cond, mutex, G_MUTEX_DEBUG_MAGIC, G_STRLOC) : (void) 0) williamr@2: # define g_cond_timed_wait(cond, mutex, abs_time) \ williamr@2: (g_thread_supported () ? \ williamr@2: ((gboolean(*)(GCond*, GMutex*, GTimeVal*, gulong, gchar*)) \ williamr@2: g_thread_functions_for_glib_use.cond_timed_wait) \ williamr@2: (cond, mutex, abs_time, G_MUTEX_DEBUG_MAGIC, G_STRLOC) : TRUE) williamr@2: #endif /* G_ERRORCHECK_MUTEXES */ williamr@2: williamr@2: #define g_mutex_new() G_THREAD_UF (mutex_new, ()) williamr@2: #define g_cond_new() G_THREAD_UF (cond_new, ()) williamr@2: #define g_cond_signal(cond) G_THREAD_CF (cond_signal, (void)0, (cond)) williamr@2: #define g_cond_broadcast(cond) G_THREAD_CF (cond_broadcast, (void)0, (cond)) williamr@2: #define g_cond_free(cond) G_THREAD_CF (cond_free, (void)0, (cond)) williamr@2: #define g_private_new(destructor) G_THREAD_UF (private_new, (destructor)) williamr@2: #define g_private_get(private_key) G_THREAD_CF (private_get, \ williamr@2: ((gpointer)private_key), \ williamr@2: (private_key)) williamr@2: #define g_private_set(private_key, value) G_THREAD_CF (private_set, \ williamr@2: (void) (private_key = \ williamr@2: (GPrivate*) (value)), \ williamr@2: (private_key, value)) williamr@2: #define g_thread_yield() G_THREAD_CF (thread_yield, (void)0, ()) williamr@2: williamr@2: #define g_thread_create(func, data, joinable, error) \ williamr@2: (g_thread_create_full (func, data, 0, joinable, FALSE, \ williamr@2: G_THREAD_PRIORITY_NORMAL, error)) williamr@2: williamr@2: IMPORT_C GThread* g_thread_create_full (GThreadFunc func, williamr@2: gpointer data, williamr@2: gulong stack_size, williamr@2: gboolean joinable, williamr@2: gboolean bound, williamr@2: GThreadPriority priority, williamr@2: GError **error); williamr@2: IMPORT_C GThread* g_thread_self (void); williamr@2: IMPORT_C void g_thread_exit (gpointer retval); williamr@2: IMPORT_C gpointer g_thread_join (GThread *thread); williamr@2: williamr@2: IMPORT_C void g_thread_set_priority (GThread *thread, williamr@2: GThreadPriority priority); williamr@2: williamr@2: /* GStaticMutexes can be statically initialized with the value williamr@2: * G_STATIC_MUTEX_INIT, and then they can directly be used, that is williamr@2: * much easier, than having to explicitly allocate the mutex before williamr@2: * use williamr@2: */ williamr@2: #define g_static_mutex_lock(mutex) \ williamr@2: g_mutex_lock (g_static_mutex_get_mutex (mutex)) williamr@2: #define g_static_mutex_trylock(mutex) \ williamr@2: g_mutex_trylock (g_static_mutex_get_mutex (mutex)) williamr@2: #define g_static_mutex_unlock(mutex) \ williamr@2: g_mutex_unlock (g_static_mutex_get_mutex (mutex)) williamr@2: IMPORT_C void g_static_mutex_init (GStaticMutex *mutex); williamr@2: IMPORT_C void g_static_mutex_free (GStaticMutex *mutex); williamr@2: williamr@2: struct _GStaticPrivate williamr@2: { williamr@2: /*< private >*/ williamr@2: guint index; williamr@2: }; williamr@2: #define G_STATIC_PRIVATE_INIT { 0 } williamr@2: IMPORT_C void g_static_private_init (GStaticPrivate *private_key); williamr@2: IMPORT_C gpointer g_static_private_get (GStaticPrivate *private_key); williamr@2: IMPORT_C void g_static_private_set (GStaticPrivate *private_key, williamr@2: gpointer data, williamr@2: GDestroyNotify notify); williamr@2: IMPORT_C void g_static_private_free (GStaticPrivate *private_key); williamr@2: williamr@2: typedef struct _GStaticRecMutex GStaticRecMutex; williamr@2: struct _GStaticRecMutex williamr@2: { williamr@2: /*< private >*/ williamr@2: GStaticMutex mutex; williamr@2: guint depth; williamr@2: GSystemThread owner; williamr@2: }; williamr@2: williamr@2: #define G_STATIC_REC_MUTEX_INIT { G_STATIC_MUTEX_INIT } williamr@2: IMPORT_C void g_static_rec_mutex_init (GStaticRecMutex *mutex); williamr@2: IMPORT_C void g_static_rec_mutex_lock (GStaticRecMutex *mutex); williamr@2: IMPORT_C gboolean g_static_rec_mutex_trylock (GStaticRecMutex *mutex); williamr@2: IMPORT_C void g_static_rec_mutex_unlock (GStaticRecMutex *mutex); williamr@2: IMPORT_C void g_static_rec_mutex_lock_full (GStaticRecMutex *mutex, williamr@2: guint depth); williamr@2: IMPORT_C guint g_static_rec_mutex_unlock_full (GStaticRecMutex *mutex); williamr@2: IMPORT_C void g_static_rec_mutex_free (GStaticRecMutex *mutex); williamr@2: williamr@2: typedef struct _GStaticRWLock GStaticRWLock; williamr@2: struct _GStaticRWLock williamr@2: { williamr@2: /*< private >*/ williamr@2: GStaticMutex mutex; williamr@2: GCond *read_cond; williamr@2: GCond *write_cond; williamr@2: guint read_counter; williamr@2: gboolean have_writer; williamr@2: guint want_to_read; williamr@2: guint want_to_write; williamr@2: }; williamr@2: williamr@2: #define G_STATIC_RW_LOCK_INIT { G_STATIC_MUTEX_INIT, NULL, NULL, 0, FALSE, 0, 0 } williamr@2: williamr@2: IMPORT_C void g_static_rw_lock_init (GStaticRWLock* lock); williamr@2: IMPORT_C void g_static_rw_lock_reader_lock (GStaticRWLock* lock); williamr@2: IMPORT_C gboolean g_static_rw_lock_reader_trylock (GStaticRWLock* lock); williamr@2: IMPORT_C void g_static_rw_lock_reader_unlock (GStaticRWLock* lock); williamr@2: IMPORT_C void g_static_rw_lock_writer_lock (GStaticRWLock* lock); williamr@2: IMPORT_C gboolean g_static_rw_lock_writer_trylock (GStaticRWLock* lock); williamr@2: IMPORT_C void g_static_rw_lock_writer_unlock (GStaticRWLock* lock); williamr@2: IMPORT_C void g_static_rw_lock_free (GStaticRWLock* lock); williamr@2: williamr@2: IMPORT_C void g_thread_foreach (GFunc thread_func, williamr@2: gpointer user_data); williamr@2: williamr@2: typedef enum williamr@2: { williamr@2: G_ONCE_STATUS_NOTCALLED, williamr@2: G_ONCE_STATUS_PROGRESS, williamr@2: G_ONCE_STATUS_READY williamr@2: } GOnceStatus; williamr@2: williamr@2: typedef struct _GOnce GOnce; williamr@2: struct _GOnce williamr@2: { williamr@2: volatile GOnceStatus status; williamr@2: volatile gpointer retval; williamr@2: }; williamr@2: williamr@2: #define G_ONCE_INIT { G_ONCE_STATUS_NOTCALLED, NULL } williamr@2: williamr@2: IMPORT_C gpointer g_once_impl (GOnce *once, GThreadFunc func, gpointer arg); williamr@2: williamr@2: #ifdef G_ATOMIC_OP_MEMORY_BARRIER_NEEDED williamr@2: # define g_once(once, func, arg) g_once_impl ((once), (func), (arg)) williamr@2: #else /* !G_ATOMIC_OP_MEMORY_BARRIER_NEEDED*/ williamr@2: # define g_once(once, func, arg) \ williamr@2: (((once)->status == G_ONCE_STATUS_READY) ? \ williamr@2: (once)->retval : \ williamr@2: g_once_impl ((once), (func), (arg))) williamr@2: #endif /* G_ATOMIC_OP_MEMORY_BARRIER_NEEDED */ williamr@2: williamr@2: /* these are some convenience macros that expand to nothing if GLib williamr@2: * was configured with --disable-threads. for using StaticMutexes, williamr@2: * you define them with G_LOCK_DEFINE_STATIC (name) or G_LOCK_DEFINE (name) williamr@2: * if you need to export the mutex. With G_LOCK_EXTERN (name) you can williamr@2: * declare such an globally defined lock. name is a unique identifier williamr@2: * for the protected varibale or code portion. locking, testing and williamr@2: * unlocking of such mutexes can be done with G_LOCK(), G_UNLOCK() and williamr@2: * G_TRYLOCK() respectively. williamr@2: */ williamr@2: #ifdef __SYMBIAN32__ williamr@2: #ifdef G_DEBUG_LOCKS williamr@2: #undef G_DEBUG_LOCKS williamr@2: #endif //G_DEBUG_LOCKS williamr@2: #endif //__SYMBIAN32__ williamr@2: williamr@2: extern void glib_dummy_decl (void); williamr@2: #define G_LOCK_NAME(name) g__ ## name ## _lock williamr@2: #ifdef G_THREADS_ENABLED williamr@2: # define G_LOCK_DEFINE_STATIC(name) static G_LOCK_DEFINE (name) williamr@2: # define G_LOCK_DEFINE(name) \ williamr@2: GStaticMutex G_LOCK_NAME (name) = G_STATIC_MUTEX_INIT williamr@2: # define G_LOCK_EXTERN(name) extern GStaticMutex G_LOCK_NAME (name) williamr@2: williamr@2: # ifdef G_DEBUG_LOCKS williamr@2: # define G_LOCK(name) G_STMT_START{ \ williamr@2: g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG, \ williamr@2: "file %s: line %d (%s): locking: %s ", \ williamr@2: __FILE__, __LINE__, G_GNUC_PRETTY_FUNCTION, \ williamr@2: #name); \ williamr@2: g_static_mutex_lock (&G_LOCK_NAME (name)); \ williamr@2: }G_STMT_END williamr@2: # define G_UNLOCK(name) G_STMT_START{ \ williamr@2: g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG, \ williamr@2: "file %s: line %d (%s): unlocking: %s ", \ williamr@2: __FILE__, __LINE__, G_GNUC_PRETTY_FUNCTION, \ williamr@2: #name); \ williamr@2: g_static_mutex_unlock (&G_LOCK_NAME (name)); \ williamr@2: }G_STMT_END williamr@2: # define G_TRYLOCK(name) \ williamr@2: (g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG, \ williamr@2: "file %s: line %d (%s): try locking: %s ", \ williamr@2: __FILE__, __LINE__, G_GNUC_PRETTY_FUNCTION, \ williamr@2: #name), g_static_mutex_trylock (&G_LOCK_NAME (name))) williamr@2: # else /* !G_DEBUG_LOCKS */ williamr@2: # define G_LOCK(name) g_static_mutex_lock (&G_LOCK_NAME (name)) williamr@2: # define G_UNLOCK(name) g_static_mutex_unlock (&G_LOCK_NAME (name)) williamr@2: # define G_TRYLOCK(name) g_static_mutex_trylock (&G_LOCK_NAME (name)) williamr@2: # endif /* !G_DEBUG_LOCKS */ williamr@2: #else /* !G_THREADS_ENABLED */ williamr@2: # define G_LOCK_DEFINE_STATIC(name) extern void glib_dummy_decl (void) williamr@2: # define G_LOCK_DEFINE(name) extern void glib_dummy_decl (void) williamr@2: # define G_LOCK_EXTERN(name) extern void glib_dummy_decl (void) williamr@2: # define G_LOCK(name) williamr@2: # define G_UNLOCK(name) williamr@2: # define G_TRYLOCK(name) (TRUE) williamr@2: #endif /* !G_THREADS_ENABLED */ williamr@2: williamr@2: williamr@2: G_END_DECLS williamr@2: williamr@2: #endif /* __G_THREAD_H__ */ williamr@2: