sl@0: /* GLIB - Library of useful routines for C programming
sl@0:  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
sl@0:  *
sl@0:  * gthread.c: thread related functions
sl@0:  * Copyright 1998 Sebastian Wilhelmi; University of Karlsruhe
sl@0:  * Portions copyright (c) 2006-2009 Nokia Corporation.  All rights reserved.
sl@0:  *
sl@0:  * This library is free software; you can redistribute it and/or
sl@0:  * modify it under the terms of the GNU Lesser General Public
sl@0:  * License as published by the Free Software Foundation; either
sl@0:  * version 2 of the License, or (at your option) any later version.
sl@0:  *
sl@0:  * This library is distributed in the hope that it will be useful,
sl@0:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
sl@0:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the GNU
sl@0:  * Lesser General Public License for more details.
sl@0:  *
sl@0:  * You should have received a copy of the GNU Lesser General Public
sl@0:  * License along with this library; if not, write to the
sl@0:  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
sl@0:  * Boston, MA 02111-1307, USA.
sl@0:  */
sl@0: 
sl@0: /*
sl@0:  * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
sl@0:  * file for a list of people on the GLib Team.  See the ChangeLog
sl@0:  * files for a list of changes.  These files are distributed with
sl@0:  * GLib at ftp://ftp.gtk.org/pub/gtk/.
sl@0:  */
sl@0: 
sl@0: /*
sl@0:  * MT safe
sl@0:  */
sl@0: 
sl@0: #include "config.h"
sl@0: 
sl@0: #include "glib.h"
sl@0: #include "gthreadprivate.h"
sl@0: 
sl@0: #ifdef __SYMBIAN32__
sl@0: #include <string.h>
sl@0: #endif//__SYMBIAN32__
sl@0: 
sl@0: #ifdef __SYMBIAN32__
sl@0: #include <glib_global.h>
sl@0: #include "gthread_wsd.h"
sl@0: #endif /* __SYMBIAN32__ */
sl@0: 
sl@0: #ifdef G_THREADS_ENABLED
sl@0: #if EMULATOR
sl@0: PLS(zero_thread,gthread_impl,GSystemThread)
sl@0: PLS(thread_system_already_initialized,gthread_impl,gboolean)
sl@0: PLS_ARRAY(g_thread_priority_map,gthread_impl,gint)
sl@0: 
sl@0: #define zero_thread (*FUNCTION_NAME(zero_thread,gthread_impl)())
sl@0: #define thread_system_already_initialized (*FUNCTION_NAME(thread_system_already_initialized,gthread_impl)())
sl@0: #define g_thread_priority_map (FUNCTION_NAME(g_thread_priority_map,gthread_impl)())
sl@0: #else
sl@0: static GSystemThread zero_thread; /* This is initialized to all zero */
sl@0: static gboolean thread_system_already_initialized = FALSE;
sl@0: static gint g_thread_priority_map [G_THREAD_PRIORITY_URGENT + 1];
sl@0: 
sl@0: #endif /* EMULATOR */
sl@0: 
sl@0: #include G_THREAD_SOURCE
sl@0: 
sl@0: #ifndef PRIORITY_LOW_VALUE
sl@0: # define PRIORITY_LOW_VALUE 0
sl@0: #endif
sl@0: 
sl@0: #ifndef PRIORITY_URGENT_VALUE
sl@0: # define PRIORITY_URGENT_VALUE 0
sl@0: #endif
sl@0: 
sl@0: #ifndef PRIORITY_NORMAL_VALUE
sl@0: # define PRIORITY_NORMAL_VALUE						\
sl@0:   ((PRIORITY_LOW_VALUE * 6 + PRIORITY_URGENT_VALUE * 4) / 10)
sl@0: #endif /* PRIORITY_NORMAL_VALUE */
sl@0: 
sl@0: #ifndef PRIORITY_HIGH_VALUE
sl@0: # define PRIORITY_HIGH_VALUE						\
sl@0:   ((PRIORITY_NORMAL_VALUE + PRIORITY_URGENT_VALUE * 2) / 3)
sl@0: #endif /* PRIORITY_HIGH_VALUE */
sl@0: 
sl@0: void g_mutex_init (void);
sl@0: void g_mem_init (void);
sl@0: void g_messages_init (void);
sl@0: void g_convert_init (void);
sl@0: void g_rand_init (void);
sl@0: void g_main_thread_init (void);
sl@0: 
sl@0: typedef struct _GMutexDebugInfo GMutexDebugInfo;
sl@0: struct _GMutexDebugInfo
sl@0: {
sl@0:   gchar *location;
sl@0:   GSystemThread owner;
sl@0: };
sl@0: 
sl@0: #define G_MUTEX_DEBUG_INFO(mutex) 					\
sl@0:   (((GMutexDebugInfo*)(((char*)mutex)+G_MUTEX_SIZE)))
sl@0: 
sl@0: static GMutex *
sl@0: g_mutex_new_errorcheck_impl (void)
sl@0: {
sl@0:   GMutex *retval = g_thread_functions_for_glib_use_default.mutex_new ();
sl@0:   GMutexDebugInfo *info;
sl@0:   retval = g_realloc (retval, G_MUTEX_SIZE + sizeof (GMutexDebugInfo));
sl@0: 
sl@0:   info = G_MUTEX_DEBUG_INFO (retval);
sl@0:   g_system_thread_assign (info->owner, zero_thread);
sl@0:   info->location = "invalid";
sl@0: 
sl@0:   return retval;
sl@0: }
sl@0: 
sl@0: static void
sl@0: g_mutex_lock_errorcheck_impl (GMutex *mutex,
sl@0: 			      const gulong magic,
sl@0: 			      gchar * const location)
sl@0: {
sl@0:   GMutexDebugInfo *info = G_MUTEX_DEBUG_INFO (mutex);
sl@0:   gchar *loc = (magic == G_MUTEX_DEBUG_MAGIC) ? location : "unknown";
sl@0: 
sl@0:   GSystemThread self;
sl@0:   g_thread_functions_for_glib_use.thread_self (&self);
sl@0: 
sl@0:   if (g_system_thread_equal (info->owner, self))
sl@0:     g_error ("Trying to recursivly lock a mutex at '%s', "
sl@0: 	     "previously locked at '%s'",
sl@0: 	     loc, info->location);
sl@0: 
sl@0:   g_thread_functions_for_glib_use_default.mutex_lock (mutex);
sl@0: 
sl@0:   g_system_thread_assign (info->owner, self);
sl@0:   info->location = loc;
sl@0: }
sl@0: 
sl@0: static gboolean
sl@0: g_mutex_trylock_errorcheck_impl (GMutex *mutex,
sl@0: 				 const gulong magic,
sl@0: 				 gchar * const location)
sl@0: {
sl@0:   GMutexDebugInfo *info = G_MUTEX_DEBUG_INFO (mutex);
sl@0:   gchar *loc = (magic == G_MUTEX_DEBUG_MAGIC) ? location : "unknown";
sl@0: 
sl@0:   GSystemThread self;
sl@0:   g_thread_functions_for_glib_use.thread_self (&self);
sl@0: 
sl@0:   if (g_system_thread_equal (info->owner, self))
sl@0:     g_error ("Trying to recursivly lock a mutex at '%s', "
sl@0: 	     "previously locked at '%s'",
sl@0: 	     loc, info->location);
sl@0: 
sl@0:   if (!g_thread_functions_for_glib_use_default.mutex_trylock (mutex))
sl@0:     return FALSE;
sl@0: 
sl@0:   g_system_thread_assign (info->owner, self);
sl@0:   info->location = loc;
sl@0: 
sl@0:   return TRUE;
sl@0: }
sl@0: 
sl@0: static void
sl@0: g_mutex_unlock_errorcheck_impl (GMutex *mutex,
sl@0: 				const gulong magic,
sl@0: 				gchar * const location)
sl@0: {
sl@0:   GMutexDebugInfo *info = G_MUTEX_DEBUG_INFO (mutex);
sl@0:   gchar *loc = (magic == G_MUTEX_DEBUG_MAGIC) ? location : "unknown";
sl@0: 
sl@0:   GSystemThread self;
sl@0:   g_thread_functions_for_glib_use.thread_self (&self);
sl@0: 
sl@0:   if (g_system_thread_equal (info->owner, zero_thread))
sl@0:     g_error ("Trying to unlock an unlocked mutex at '%s'", loc);
sl@0: 
sl@0:   if (!g_system_thread_equal (info->owner, self))
sl@0:     g_warning ("Trying to unlock a mutex at '%s', "
sl@0: 	       "previously locked by a different thread at '%s'",
sl@0: 	       loc, info->location);
sl@0: 
sl@0:   g_system_thread_assign (info->owner, zero_thread);
sl@0:   info->location = NULL;
sl@0: 
sl@0:   g_thread_functions_for_glib_use_default.mutex_unlock (mutex);
sl@0: }
sl@0: 
sl@0: static void
sl@0: g_mutex_free_errorcheck_impl (GMutex *mutex,
sl@0: 			      const gulong magic,
sl@0: 			      gchar * const location)
sl@0: {
sl@0:   GMutexDebugInfo *info = G_MUTEX_DEBUG_INFO (mutex);
sl@0:   gchar *loc = (magic == G_MUTEX_DEBUG_MAGIC) ? location : "unknown";
sl@0: 
sl@0:   if (info && !g_system_thread_equal (info->owner, zero_thread))
sl@0:     g_error ("Trying to free a locked mutex at '%s', "
sl@0: 	     "which was previously locked at '%s'",
sl@0: 	     loc, info->location);
sl@0: 
sl@0:   g_thread_functions_for_glib_use_default.mutex_free (mutex);
sl@0: }
sl@0: 
sl@0: static void
sl@0: g_cond_wait_errorcheck_impl (GCond *cond,
sl@0: 			     GMutex *mutex,
sl@0: 			     const gulong magic,
sl@0: 			     gchar * const location)
sl@0: {
sl@0:   GMutexDebugInfo *info = G_MUTEX_DEBUG_INFO (mutex);
sl@0:   gchar *loc = (magic == G_MUTEX_DEBUG_MAGIC) ? location : "unknown";
sl@0: 
sl@0:   GSystemThread self;
sl@0:   g_thread_functions_for_glib_use.thread_self (&self);
sl@0: 
sl@0:   if (g_system_thread_equal (info->owner, zero_thread))
sl@0:     g_error ("Trying to use an unlocked mutex in g_cond_wait() at '%s'", loc);
sl@0: 
sl@0:   if (!g_system_thread_equal (info->owner, self))
sl@0:     g_error ("Trying to use a mutex locked by another thread in "
sl@0: 	     "g_cond_wait() at '%s'", loc);
sl@0: 
sl@0:   g_system_thread_assign (info->owner, zero_thread);
sl@0:   loc = info->location;
sl@0: 
sl@0:   g_thread_functions_for_glib_use_default.cond_wait (cond, mutex);
sl@0: 
sl@0:   g_system_thread_assign (info->owner, self);
sl@0:   info->location = loc;
sl@0: }
sl@0: 
sl@0: 
sl@0: static gboolean
sl@0: g_cond_timed_wait_errorcheck_impl (GCond *cond,
sl@0:                                    GMutex *mutex,
sl@0:                                    GTimeVal *end_time,
sl@0: 				   const gulong magic,
sl@0: 				   gchar * const location)
sl@0: {
sl@0:   GMutexDebugInfo *info = G_MUTEX_DEBUG_INFO (mutex);
sl@0:   gchar *loc = (magic == G_MUTEX_DEBUG_MAGIC) ? location : "unknown";
sl@0:   gboolean retval;
sl@0: 
sl@0:   GSystemThread self;
sl@0:   g_thread_functions_for_glib_use.thread_self (&self);
sl@0: 
sl@0:   if (g_system_thread_equal (info->owner, zero_thread))
sl@0:     g_error ("Trying to use an unlocked mutex in g_cond_timed_wait() at '%s'",
sl@0: 	     loc);
sl@0: 
sl@0:   if (!g_system_thread_equal (info->owner, self))
sl@0:     g_error ("Trying to use a mutex locked by another thread in "
sl@0: 	     "g_cond_timed_wait() at '%s'", loc);
sl@0: 
sl@0:   g_system_thread_assign (info->owner, zero_thread);
sl@0:   loc = info->location;
sl@0: 
sl@0:   retval = g_thread_functions_for_glib_use_default.cond_timed_wait (cond,
sl@0: 								    mutex,
sl@0: 								    end_time);
sl@0: 
sl@0:   g_system_thread_assign (info->owner, self);
sl@0:   info->location = loc;
sl@0: 
sl@0:   return retval;
sl@0: }
sl@0: 
sl@0: 
sl@0: /* unshadow function declaration. See gthread.h */
sl@0: #undef g_thread_init
sl@0: 
sl@0: EXPORT_C
sl@0: void
sl@0: g_thread_init_with_errorcheck_mutexes (GThreadFunctions* init)
sl@0: {
sl@0:   GThreadFunctions errorcheck_functions;
sl@0:   if (init)
sl@0:     g_error ("Errorcheck mutexes can only be used for native "
sl@0: 	     "thread implementations. Sorry." );
sl@0: 
sl@0: #ifdef HAVE_G_THREAD_IMPL_INIT
sl@0:   /* This isn't called in g_thread_init, as it doesn't think to get
sl@0:    * the default implementation, so we have to call it on our own.
sl@0:    *
sl@0:    * We must call this before copying
sl@0:    * g_thread_functions_for_glib_use_default as the
sl@0:    * implementation-specific init function might modify the contents
sl@0:    * of g_thread_functions_for_glib_use_default based on operating
sl@0:    * system version, C library version, or whatever. */
sl@0:   g_thread_impl_init();
sl@0: #endif /* HAVE_G_THREAD_IMPL_INIT */
sl@0: 
sl@0:   errorcheck_functions = g_thread_functions_for_glib_use_default;
sl@0:   errorcheck_functions.mutex_new = g_mutex_new_errorcheck_impl;
sl@0:   errorcheck_functions.mutex_lock =
sl@0:     (void (*)(GMutex *)) g_mutex_lock_errorcheck_impl;
sl@0:   errorcheck_functions.mutex_trylock =
sl@0:     (gboolean (*)(GMutex *)) g_mutex_trylock_errorcheck_impl;
sl@0:   errorcheck_functions.mutex_unlock =
sl@0:     (void (*)(GMutex *)) g_mutex_unlock_errorcheck_impl;
sl@0:   errorcheck_functions.mutex_free =
sl@0:     (void (*)(GMutex *)) g_mutex_free_errorcheck_impl;
sl@0:   errorcheck_functions.cond_wait =
sl@0:     (void (*)(GCond *, GMutex *)) g_cond_wait_errorcheck_impl;
sl@0:   errorcheck_functions.cond_timed_wait =
sl@0:     (gboolean (*)(GCond *, GMutex *, GTimeVal *))
sl@0:     g_cond_timed_wait_errorcheck_impl;
sl@0: 
sl@0:   g_thread_init (&errorcheck_functions);
sl@0: }
sl@0: 
sl@0: EXPORT_C
sl@0: void
sl@0: g_thread_init (GThreadFunctions* init)
sl@0: {
sl@0:   gboolean supported;
sl@0: 
sl@0:   if (thread_system_already_initialized)
sl@0:     g_error ("GThread system may only be initialized once.");
sl@0: 
sl@0:   thread_system_already_initialized = TRUE;
sl@0: 
sl@0:   if (init == NULL)
sl@0:     {
sl@0: #ifdef HAVE_G_THREAD_IMPL_INIT
sl@0:       /* now do any initialization stuff required by the
sl@0:        * implementation, but only if called with a NULL argument, of
sl@0:        * course. Otherwise it's up to the user to do so. */
sl@0:       g_thread_impl_init();
sl@0: #endif /* HAVE_G_THREAD_IMPL_INIT */
sl@0: #ifdef __SYMBIAN32__
sl@0: 	  memcpy(&g_thread_functions_for_glib_use_default, &g_thread_functions_for_glib_use_default_temp, sizeof(GThreadFunctions));
sl@0: #endif//__SYMBIAN32__
sl@0:       init = &g_thread_functions_for_glib_use_default;
sl@0:     }
sl@0:   else
sl@0:     g_thread_use_default_impl = FALSE;
sl@0: 
sl@0:   g_thread_functions_for_glib_use = *init;
sl@0:   if (g_thread_gettime_impl)
sl@0:     g_thread_gettime = g_thread_gettime_impl;
sl@0: 
sl@0:   supported = (init->mutex_new &&
sl@0: 	       init->mutex_lock &&
sl@0: 	       init->mutex_trylock &&
sl@0: 	       init->mutex_unlock &&
sl@0: 	       init->mutex_free &&
sl@0: 	       init->cond_new &&
sl@0: 	       init->cond_signal &&
sl@0: 	       init->cond_broadcast &&
sl@0: 	       init->cond_wait &&
sl@0: 	       init->cond_timed_wait &&
sl@0: 	       init->cond_free &&
sl@0: 	       init->private_new &&
sl@0: 	       init->private_get &&
sl@0: 	       init->private_set &&
sl@0: 	       init->thread_create &&
sl@0: 	       init->thread_yield &&
sl@0: 	       init->thread_join &&
sl@0: 	       init->thread_exit &&
sl@0: 	       init->thread_set_priority &&
sl@0: 	       init->thread_self);
sl@0: 
sl@0:   /* if somebody is calling g_thread_init (), it means that he wants to
sl@0:    * have thread support, so check this
sl@0:    */
sl@0:   if (!supported)
sl@0:     {
sl@0:       if (g_thread_use_default_impl)
sl@0: 	g_error ("Threads are not supported on this platform.");
sl@0:       else
sl@0: 	g_error ("The supplied thread function vector is invalid.");
sl@0:     }
sl@0: 
sl@0:   g_thread_priority_map [G_THREAD_PRIORITY_LOW] = PRIORITY_LOW_VALUE;
sl@0:   g_thread_priority_map [G_THREAD_PRIORITY_NORMAL] = PRIORITY_NORMAL_VALUE;
sl@0:   g_thread_priority_map [G_THREAD_PRIORITY_HIGH] = PRIORITY_HIGH_VALUE;
sl@0:   g_thread_priority_map [G_THREAD_PRIORITY_URGENT] = PRIORITY_URGENT_VALUE;
sl@0: 
sl@0:   g_thread_init_glib ();
sl@0: }
sl@0: 
sl@0: #else /* !G_THREADS_ENABLED */
sl@0: 
sl@0: void
sl@0: g_thread_init (GThreadFunctions* init)
sl@0: {
sl@0:   g_error ("GLib thread support is disabled.");
sl@0: }
sl@0: 
sl@0: void
sl@0: g_thread_init_with_errorcheck_mutexes (GThreadFunctions* init)
sl@0: {
sl@0:   g_error ("GLib thread support is disabled.");
sl@0: }
sl@0: 
sl@0: #endif /* !G_THREADS_ENABLED */