hack this so it compiles, needs fixing for real.
[platform/upstream/glib.git] / gthread / gthread-impl.c
1 /* GLIB - Library of useful routines for C programming
2  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
3  *
4  * gthread.c: thread related functions
5  * Copyright 1998 Sebastian Wilhelmi; University of Karlsruhe
6  *
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.
11  *
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.
16  *
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.
21  */
22
23 /*
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/. 
28  */
29
30 /* 
31  * MT safe
32  */
33
34 #ifdef HAVE_CONFIG_H
35 #include <config.h>
36 #endif
37
38 #include <glib.h>
39
40 static gboolean thread_system_already_initialized = FALSE;
41 static gint g_thread_priority_map [G_THREAD_PRIORITY_URGENT];
42
43 #include G_THREAD_SOURCE
44
45 #ifndef PRIORITY_LOW_VALUE
46 # define PRIORITY_LOW_VALUE 0
47 #endif
48
49 #ifndef PRIORITY_URGENT_VALUE
50 # define PRIORITY_URGENT_VALUE 0
51 #endif
52
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 */
57
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 */
62
63 void g_mutex_init (void);
64 void g_mem_init (void);
65 void g_messages_init (void);
66
67 #define G_MUTEX_DEBUG_INFO(mutex) (*((gpointer*)(((char*)mutex)+G_MUTEX_SIZE)))
68
69 typedef struct _ErrorCheckInfo ErrorCheckInfo;
70 struct _ErrorCheckInfo
71 {
72   gchar *location;
73   GThread *owner;
74 };
75
76 static GMutex *
77 g_mutex_new_errorcheck_impl (void)
78 {
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;
82   return retval;
83 }
84
85 static void
86 g_mutex_lock_errorcheck_impl (GMutex *mutex, 
87                               gulong magic,
88                               gchar *location)
89 {
90   ErrorCheckInfo *info;
91   GThread *self = g_thread_self ();
92
93   if (magic != G_MUTEX_DEBUG_MAGIC)
94     location = "unknown";
95
96   if (G_MUTEX_DEBUG_INFO (mutex) == NULL)
97     {
98       /* if the debug info is NULL, we have not yet locked that mutex,
99        * so we do it now */
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)
106         {
107           info = G_MUTEX_DEBUG_INFO (mutex) = g_new0 (ErrorCheckInfo, 1);
108         }
109       g_thread_functions_for_glib_use_default.mutex_unlock (mutex);
110     }
111   
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);
117
118   g_thread_functions_for_glib_use_default.mutex_lock (mutex);
119
120   info->owner = self;
121   info->location = location;
122 }
123
124 static gboolean
125 g_mutex_trylock_errorcheck_impl (GMutex *mutex, 
126                                  gulong magic, 
127                                  gchar *location)
128 {
129   ErrorCheckInfo *info = G_MUTEX_DEBUG_INFO (mutex);
130   GThread *self = g_thread_self ();
131
132   if (magic != G_MUTEX_DEBUG_MAGIC)
133     location = "unknown";
134
135   if (!info)
136     {
137       /* This mutex has not yet been used, so simply lock and return TRUE */
138       g_mutex_lock_errorcheck_impl (mutex, magic, location);
139       return TRUE;
140     }
141
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);
146   
147   if (!g_thread_functions_for_glib_use_default.mutex_trylock (mutex))
148     return FALSE;
149
150   info->owner = self;
151   info->location = location;
152
153   return TRUE;
154 }
155
156 static void
157 g_mutex_unlock_errorcheck_impl (GMutex *mutex, 
158                                 gulong magic, 
159                                 gchar *location)
160 {
161   ErrorCheckInfo *info = G_MUTEX_DEBUG_INFO (mutex);
162   GThread *self = g_thread_self ();
163
164   if (magic != G_MUTEX_DEBUG_MAGIC)
165     location = "unknown";
166
167   if (!info || info->owner == NULL)
168     g_error ("Trying to unlock an unlocked mutex at '%s'", location);
169
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);
174
175   info->owner = NULL;
176   info->location = NULL;
177
178   g_thread_functions_for_glib_use_default.mutex_unlock (mutex);
179 }
180
181 static void
182 g_mutex_free_errorcheck_impl (GMutex *mutex)
183 {
184   ErrorCheckInfo *info = G_MUTEX_DEBUG_INFO (mutex);
185   
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);
190
191   g_free (G_MUTEX_DEBUG_INFO (mutex));
192   g_thread_functions_for_glib_use_default.mutex_free (mutex);  
193 }
194
195 static void     
196 g_cond_wait_errorcheck_impl (GCond *cond,
197                              GMutex *mutex, 
198                              gulong magic, 
199                              gchar *location)
200 {
201   
202   ErrorCheckInfo *info = G_MUTEX_DEBUG_INFO (mutex);
203   GThread *self = g_thread_self ();
204
205   if (magic != G_MUTEX_DEBUG_MAGIC)
206     location = "unknown";
207
208   if (!info || info->owner == NULL)
209     g_error ("Trying to use an unlocked mutex in g_cond_wait() at '%s'",
210              location);
211
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);
215
216   info->owner = NULL;
217   location = info->location;
218
219   g_thread_functions_for_glib_use_default.cond_wait (cond, mutex);
220
221   info->owner = self;
222   info->location = location;
223 }
224     
225
226 static gboolean 
227 g_cond_timed_wait_errorcheck_impl (GCond *cond,
228                                    GMutex *mutex,
229                                    GTimeVal *end_time, 
230                                    gulong magic, 
231                                    gchar *location)
232 {
233   ErrorCheckInfo *info = G_MUTEX_DEBUG_INFO (mutex);
234   GThread *self = g_thread_self ();
235   gboolean retval;
236
237   if (magic != G_MUTEX_DEBUG_MAGIC)
238     location = "unknown";
239
240   if (!info || info->owner == NULL)
241     g_error ("Trying to use an unlocked mutex in g_cond_timed_wait() at '%s'",
242              location);
243
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);
247
248   info->owner = NULL;
249   location = info->location;
250   
251   retval = g_thread_functions_for_glib_use_default.cond_timed_wait (cond, 
252                                                                     mutex, 
253                                                                     end_time);
254
255   info->owner = self;
256   info->location = location;
257
258   return retval;
259 }
260
261
262 /* unshadow function declaration. See glib.h */
263 #undef g_thread_init
264
265 void 
266 g_thread_init_with_errorcheck_mutexes (GThreadFunctions* init)
267 {
268   GThreadFunctions errorcheck_functions;
269   if (init)
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;
283     
284   g_thread_init (&errorcheck_functions);
285 }
286
287 void
288 g_thread_init (GThreadFunctions* init)
289 {
290   gboolean supported;
291
292 #ifndef G_THREADS_ENABLED
293   g_error ("GLib thread support is disabled.");
294 #endif  /* !G_THREADS_ENABLED */
295
296   if (thread_system_already_initialized)
297     g_error ("GThread system may only be initialized once.");
298     
299   thread_system_already_initialized = TRUE;
300
301   if (init == NULL)
302     init = &g_thread_functions_for_glib_use_default;
303   else
304     g_thread_use_default_impl = FALSE;
305
306 #if defined (G_OS_WIN32) && defined (__GNUC__)
307   memcpy(&g_thread_functions_for_glib_use, init, sizeof (*init));
308 #else
309   g_thread_functions_for_glib_use = *init;
310 #endif
311   /* It is important, that g_threads_got_initialized is not set before the
312    * thread initialization functions of the different modules are called
313    */
314
315   supported = (init->mutex_new &&  
316                init->mutex_lock && 
317                init->mutex_trylock && 
318                init->mutex_unlock && 
319                init->mutex_free && 
320                init->cond_new && 
321                init->cond_signal && 
322                init->cond_broadcast && 
323                init->cond_wait && 
324                init->cond_timed_wait &&
325                init->cond_free &&
326                init->private_new &&
327                init->private_get &&
328                init->private_get);
329
330   /* if somebody is calling g_thread_init (), it means that he wants to
331    * have thread support, so check this
332    */
333   if (!supported)
334     {
335       if (g_thread_use_default_impl)
336         g_error ("Threads are not supported on this platform.");
337       else
338         g_error ("The supplied thread function vector is invalid.");
339     }
340
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. */
344
345 #ifdef HAVE_G_THREAD_IMPL_INIT
346   if (g_thread_use_default_impl)
347     g_thread_impl_init();
348 #endif
349
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;
354
355   /* now call the thread initialization functions of the different
356    * glib modules. order does matter, g_mutex_init MUST come first.
357    */
358   g_mutex_init ();
359   g_mem_init ();
360   g_messages_init ();
361
362   /* now we can set g_threads_got_initialized and thus enable
363    * all the thread functions
364    */
365   g_threads_got_initialized = TRUE;
366
367   /* we want the main thread to run with normal priority */
368   g_thread_set_priority (g_thread_self(), G_THREAD_PRIORITY_NORMAL);
369 }