1 /* GLIB - Library of useful routines for C programming
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * gthread.c: thread related functions
5 * Copyright 1998 Sebastian Wilhelmi; University of Karlsruhe
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/.
40 static gboolean thread_system_already_initialized = FALSE;
41 static gint g_thread_priority_map [G_THREAD_PRIORITY_URGENT];
43 #include G_THREAD_SOURCE
45 #ifndef PRIORITY_LOW_VALUE
46 # define PRIORITY_LOW_VALUE 0
49 #ifndef PRIORITY_URGENT_VALUE
50 # define PRIORITY_URGENT_VALUE 0
53 #ifndef PRIORITY_NORMAL_VALUE
54 # define PRIORITY_NORMAL_VALUE \
55 PRIORITY_LOW_VALUE + (PRIORITY_URGENT_VALUE - PRIORITY_LOW_VALUE) * 40 / 100
56 #endif /* PRIORITY_NORMAL_VALUE */
58 #ifndef PRIORITY_HIGH_VALUE
59 # define PRIORITY_HIGH_VALUE \
60 PRIORITY_LOW_VALUE + (PRIORITY_URGENT_VALUE - PRIORITY_LOW_VALUE) * 80 / 100
61 #endif /* PRIORITY_HIGH_VALUE */
63 void g_mutex_init (void);
64 void g_mem_init (void);
65 void g_messages_init (void);
67 #define G_MUTEX_DEBUG_INFO(mutex) (*((gpointer*)(((char*)mutex)+G_MUTEX_SIZE)))
69 typedef struct _ErrorCheckInfo ErrorCheckInfo;
70 struct _ErrorCheckInfo
77 g_mutex_new_errorcheck_impl (void)
79 GMutex *retval = g_thread_functions_for_glib_use_default.mutex_new ();
80 retval = g_realloc (retval, G_MUTEX_SIZE + sizeof (gpointer));
81 G_MUTEX_DEBUG_INFO (retval) = NULL;
86 g_mutex_lock_errorcheck_impl (GMutex *mutex,
91 GThread *self = g_thread_self ();
93 if (magic != G_MUTEX_DEBUG_MAGIC)
96 if (G_MUTEX_DEBUG_INFO (mutex) == NULL)
98 /* if the debug info is NULL, we have not yet locked that mutex,
100 g_thread_functions_for_glib_use_default.mutex_lock (mutex);
101 /* Now we have to check again, because another thread might have
102 * tried to lock the mutex at the same time we did. This
103 * technique is not 100% save on systems without decent cache
104 * coherence, but we have no choice */
105 if (G_MUTEX_DEBUG_INFO (mutex) == NULL)
107 info = G_MUTEX_DEBUG_INFO (mutex) = g_new0 (ErrorCheckInfo, 1);
109 g_thread_functions_for_glib_use_default.mutex_unlock (mutex);
112 info = G_MUTEX_DEBUG_INFO (mutex);
113 if (info->owner == self)
114 g_error ("Trying to recursivly lock a mutex at '%s', "
115 "previously locked at '%s'",
116 location, info->location);
118 g_thread_functions_for_glib_use_default.mutex_lock (mutex);
121 info->location = location;
125 g_mutex_trylock_errorcheck_impl (GMutex *mutex,
129 ErrorCheckInfo *info = G_MUTEX_DEBUG_INFO (mutex);
130 GThread *self = g_thread_self ();
132 if (magic != G_MUTEX_DEBUG_MAGIC)
133 location = "unknown";
137 /* This mutex has not yet been used, so simply lock and return TRUE */
138 g_mutex_lock_errorcheck_impl (mutex, magic, location);
142 if (info->owner == self)
143 g_error ("Trying to recursivly lock a mutex at '%s', "
144 "previously locked at '%s'",
145 location, info->location);
147 if (!g_thread_functions_for_glib_use_default.mutex_trylock (mutex))
151 info->location = location;
157 g_mutex_unlock_errorcheck_impl (GMutex *mutex,
161 ErrorCheckInfo *info = G_MUTEX_DEBUG_INFO (mutex);
162 GThread *self = g_thread_self ();
164 if (magic != G_MUTEX_DEBUG_MAGIC)
165 location = "unknown";
167 if (!info || info->owner == NULL)
168 g_error ("Trying to unlock an unlocked mutex at '%s'", location);
170 if (info->owner != self)
171 g_warning ("Trying to unlock a mutex at '%s', "
172 "previously locked by a different thread at '%s'",
173 location, info->location);
176 info->location = NULL;
178 g_thread_functions_for_glib_use_default.mutex_unlock (mutex);
182 g_mutex_free_errorcheck_impl (GMutex *mutex)
184 ErrorCheckInfo *info = G_MUTEX_DEBUG_INFO (mutex);
186 if (info && info->owner != NULL)
187 g_error ("Trying to free a locked mutex at '%s', "
188 "which was previously locked at '%s'",
189 "FIXME", info->location);
191 g_free (G_MUTEX_DEBUG_INFO (mutex));
192 g_thread_functions_for_glib_use_default.mutex_free (mutex);
196 g_cond_wait_errorcheck_impl (GCond *cond,
202 ErrorCheckInfo *info = G_MUTEX_DEBUG_INFO (mutex);
203 GThread *self = g_thread_self ();
205 if (magic != G_MUTEX_DEBUG_MAGIC)
206 location = "unknown";
208 if (!info || info->owner == NULL)
209 g_error ("Trying to use an unlocked mutex in g_cond_wait() at '%s'",
212 if (info->owner != self)
213 g_error ("Trying to use a mutex locked by another thread in "
214 "g_cond_wait() at '%s'", location);
217 location = info->location;
219 g_thread_functions_for_glib_use_default.cond_wait (cond, mutex);
222 info->location = location;
227 g_cond_timed_wait_errorcheck_impl (GCond *cond,
233 ErrorCheckInfo *info = G_MUTEX_DEBUG_INFO (mutex);
234 GThread *self = g_thread_self ();
237 if (magic != G_MUTEX_DEBUG_MAGIC)
238 location = "unknown";
240 if (!info || info->owner == NULL)
241 g_error ("Trying to use an unlocked mutex in g_cond_timed_wait() at '%s'",
244 if (info->owner != self)
245 g_error ("Trying to use a mutex locked by another thread in "
246 "g_cond_timed_wait() at '%s'", location);
249 location = info->location;
251 retval = g_thread_functions_for_glib_use_default.cond_timed_wait (cond,
256 info->location = location;
262 /* unshadow function declaration. See glib.h */
266 g_thread_init_with_errorcheck_mutexes (GThreadFunctions* init)
268 GThreadFunctions errorcheck_functions;
270 g_error ("Errorcheck mutexes can only be used for native "
271 "thread implementations. Sorry." );
272 errorcheck_functions = g_thread_functions_for_glib_use_default;
273 errorcheck_functions.mutex_new = g_mutex_new_errorcheck_impl;
274 errorcheck_functions.mutex_lock =
275 (void (*)(GMutex *)) g_mutex_lock_errorcheck_impl;
276 errorcheck_functions.mutex_trylock =
277 (gboolean (*)(GMutex *)) g_mutex_trylock_errorcheck_impl;
278 errorcheck_functions.mutex_unlock =
279 (void (*)(GMutex *)) g_mutex_unlock_errorcheck_impl;
280 errorcheck_functions.mutex_free = g_mutex_free_errorcheck_impl;
281 errorcheck_functions.cond_wait = g_cond_wait_errorcheck_impl;
282 errorcheck_functions.cond_timed_wait = g_cond_timed_wait_errorcheck_impl;
284 g_thread_init (&errorcheck_functions);
288 g_thread_init (GThreadFunctions* init)
292 #ifndef G_THREADS_ENABLED
293 g_error ("GLib thread support is disabled.");
294 #endif /* !G_THREADS_ENABLED */
296 if (thread_system_already_initialized)
297 g_error ("GThread system may only be initialized once.");
299 thread_system_already_initialized = TRUE;
302 init = &g_thread_functions_for_glib_use_default;
304 g_thread_use_default_impl = FALSE;
306 #if defined (G_OS_WIN32) && defined (__GNUC__)
307 memcpy(&g_thread_functions_for_glib_use, init, sizeof (*init));
309 g_thread_functions_for_glib_use = *init;
311 /* It is important, that g_threads_got_initialized is not set before the
312 * thread initialization functions of the different modules are called
315 supported = (init->mutex_new &&
317 init->mutex_trylock &&
318 init->mutex_unlock &&
322 init->cond_broadcast &&
324 init->cond_timed_wait &&
330 /* if somebody is calling g_thread_init (), it means that he wants to
331 * have thread support, so check this
335 if (g_thread_use_default_impl)
336 g_error ("Threads are not supported on this platform.");
338 g_error ("The supplied thread function vector is invalid.");
341 /* now do any initialization stuff required by the implementation,
342 * but only if called with a NULL argument, of course. Otherwise
343 * it's up to the user to do so. */
345 #ifdef HAVE_G_THREAD_IMPL_INIT
346 if (g_thread_use_default_impl)
347 g_thread_impl_init();
350 g_thread_priority_map [G_THREAD_PRIORITY_LOW] = PRIORITY_LOW_VALUE;
351 g_thread_priority_map [G_THREAD_PRIORITY_NORMAL] = PRIORITY_NORMAL_VALUE;
352 g_thread_priority_map [G_THREAD_PRIORITY_HIGH] = PRIORITY_HIGH_VALUE;
353 g_thread_priority_map [G_THREAD_PRIORITY_URGENT] = PRIORITY_URGENT_VALUE;
355 /* now call the thread initialization functions of the different
356 * glib modules. order does matter, g_mutex_init MUST come first.
362 /* now we can set g_threads_got_initialized and thus enable
363 * all the thread functions
365 g_threads_got_initialized = TRUE;
367 /* we want the main thread to run with normal priority */
368 g_thread_set_priority (g_thread_self(), G_THREAD_PRIORITY_NORMAL);