applied patch from Andreas Persenius <ndap@swipnet.se> that updates the
[platform/upstream/glib.git] / gthread / gthread-posix.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: posix thread system implementation
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 #include <pthread.h>
35 #include <errno.h>
36 #include <stdlib.h>
37 #ifdef HAVE_SYS_TIME_H
38 #include <sys/time.h>
39 #endif
40 #ifdef HAVE_UNISTD_H
41 #include <unistd.h>
42 #endif
43
44 #define posix_print_error( name, num )                                  \
45   g_error( "file %s: line %d (%s): error %s during %s",                 \
46            __FILE__, __LINE__, G_GNUC_PRETTY_FUNCTION,                  \
47            g_strerror((num)), #name )
48
49 #if defined(G_THREADS_IMPL_POSIX)
50 # define posix_check_for_error( what ) G_STMT_START{                    \
51     int error = (what);                                                 \
52     if( error ) { posix_print_error( what, error ); }                   \
53     }G_STMT_END
54 # define mutexattr_default NULL
55 # define condattr_default NULL
56 #elif defined(G_THREADS_IMPL_DCE)
57 # define posix_check_for_error( what ) G_STMT_START{                    \
58     if( (what) == -1 ) { posix_print_error( what, errno ); }            \
59     }G_STMT_END
60 # define pthread_key_create(a, b) pthread_keycreate (a, b)
61 # define pthread_attr_init(a) pthread_attr_create (a)
62 # define pthread_attr_destroy(a) pthread_attr_delete (a)
63 # define pthread_create(a, b, c, d) pthread_create(a, *b, c, d) 
64 # define mutexattr_default (pthread_mutexattr_default)
65 # define condattr_default (pthread_condattr_default)
66 #else /* neither G_THREADS_IMPL_POSIX nor G_THREADS_IMPL_DCE are defined */
67 # error This should not happen. Contact the GLib team.
68 #endif
69
70 #if defined(POSIX_MIN_PRIORITY) && defined(POSIX_MAX_PRIORITY)
71 #  define HAVE_PRIORITIES 1
72 #endif
73
74 gulong g_thread_min_stack_size = 0;
75
76 #define HAVE_G_THREAD_IMPL_INIT
77 static void 
78 g_thread_impl_init()
79 {
80 #ifdef HAVE_PRIORITIES
81   g_thread_min_priority = POSIX_MIN_PRIORITY;
82   g_thread_max_priority = POSIX_MAX_PRIORITY;
83 #endif /* HAVE_PRIORITIES */
84 #ifdef _SC_THREAD_STACK_MIN
85   g_thread_min_stack_size = MAX (sysconf (_SC_THREAD_STACK_MIN), 0);
86 #endif /* _SC_THREAD_STACK_MIN */
87 }
88
89 static GMutex *
90 g_mutex_new_posix_impl (void)
91 {
92   GMutex *result = (GMutex *) g_new (pthread_mutex_t, 1);
93   posix_check_for_error (pthread_mutex_init ((pthread_mutex_t *) result, 
94                                              mutexattr_default));
95   return result;
96 }
97
98 static void
99 g_mutex_free_posix_impl (GMutex * mutex)
100 {
101   posix_check_for_error (pthread_mutex_destroy ((pthread_mutex_t *) mutex));
102   g_free (mutex);
103 }
104
105 /* NOTE: the functions g_mutex_lock and g_mutex_unlock may not use
106    functions from gmem.c and gmessages.c; */
107
108 /* pthread_mutex_lock, pthread_mutex_unlock can be taken directly, as
109    signature and semantic are right, but without error check then!!!!,
110    we might want to change this therefore. */
111
112 static gboolean
113 g_mutex_trylock_posix_impl (GMutex * mutex)
114 {
115   int result;
116
117   result = pthread_mutex_trylock ((pthread_mutex_t *) mutex);
118
119 #ifdef G_THREADS_IMPL_POSIX
120   if (result == EBUSY)
121     return FALSE;
122 #else /* G_THREADS_IMPL_DCE */
123   if (result == 0)
124     return FALSE;
125 #endif
126
127   posix_check_for_error (result);
128   return TRUE;
129 }
130
131 static GCond *
132 g_cond_new_posix_impl (void)
133 {
134   GCond *result = (GCond *) g_new (pthread_cond_t, 1);
135   posix_check_for_error (pthread_cond_init ((pthread_cond_t *) result, 
136                                             condattr_default));
137   return result;
138 }
139
140 /* pthread_cond_signal, pthread_cond_broadcast and pthread_cond_wait
141    can be taken directly, as signature and semantic are right, but
142    without error check then!!!!, we might want to change this
143    therfore. */
144
145 #define G_MICROSEC 1000000
146 #define G_NANOSEC 1000000000
147
148 static gboolean
149 g_cond_timed_wait_posix_impl (GCond * cond,
150                               GMutex * entered_mutex,
151                               GTimeVal * abs_time)
152 {
153   int result;
154   struct timespec end_time;
155   gboolean timed_out;
156
157   g_return_val_if_fail (cond != NULL, FALSE);
158   g_return_val_if_fail (entered_mutex != NULL, FALSE);
159
160   if (!abs_time)
161     {
162       g_cond_wait (cond, entered_mutex);
163       return TRUE;
164     }
165
166   end_time.tv_sec = abs_time->tv_sec;
167   end_time.tv_nsec = abs_time->tv_usec * (G_NANOSEC / G_MICROSEC);
168   g_assert (end_time.tv_nsec < G_NANOSEC);
169   result = pthread_cond_timedwait ((pthread_cond_t *) cond,
170                                    (pthread_mutex_t *) entered_mutex,
171                                    &end_time);
172
173 #ifdef G_THREADS_IMPL_POSIX
174   timed_out = (result == ETIMEDOUT);
175 #else /* G_THREADS_IMPL_DCE */
176   timed_out = (result == -1) && (errno = EAGAIN);
177 #endif
178
179   if (!timed_out)
180     posix_check_for_error (result);
181   return !timed_out;
182 }
183
184 static void
185 g_cond_free_posix_impl (GCond * cond)
186 {
187   posix_check_for_error (pthread_cond_destroy ((pthread_cond_t *) cond));
188   g_free (cond);
189 }
190
191 static GPrivate *
192 g_private_new_posix_impl (GDestroyNotify destructor)
193 {
194   GPrivate *result = (GPrivate *) g_new (pthread_key_t, 1);
195   posix_check_for_error (pthread_key_create ((pthread_key_t *) result,
196                                              destructor));
197   return result;
198 }
199
200 /* NOTE: the functions g_private_get and g_private_set may not use
201    functions from gmem.c and gmessages.c */
202
203 static void
204 g_private_set_posix_impl (GPrivate * private_key, gpointer value)
205 {
206   if (!private_key)
207     return;
208   pthread_setspecific (*(pthread_key_t *) private_key, value);
209 }
210
211 static gpointer
212 g_private_get_posix_impl (GPrivate * private_key)
213 {
214   if (!private_key)
215     return NULL;
216 #ifdef G_THREADS_IMPL_POSIX
217   return pthread_getspecific (*(pthread_key_t *) private_key);
218 #else /* G_THREADS_IMPL_DCE */
219   {
220     void* data;
221     posix_check_for_error (pthread_getspecific (*(pthread_key_t *) 
222                                                 private_key, &data));
223     return data;
224   }
225 #endif
226 }
227
228 static void
229 g_thread_create_posix_impl (GThreadFunc thread_func, 
230                             gpointer arg, 
231                             gulong stack_size,
232                             gboolean joinable,
233                             gboolean bound,
234                             GThreadPriority priority,
235                             gpointer thread)
236 {
237   pthread_attr_t attr;
238
239   g_return_if_fail (thread_func);
240
241   posix_check_for_error (pthread_attr_init (&attr));
242   
243 #ifdef HAVE_PTHREAD_ATTR_SETSTACKSIZE
244   if (stack_size)
245     {
246       stack_size = MAX (g_thread_min_stack_size, stack_size);
247       posix_check_for_error (pthread_attr_setstacksize (&attr, stack_size));
248     }
249 #endif /* HAVE_PTHREAD_ATTR_SETSTACKSIZE */
250
251 #ifdef PTHREAD_SCOPE_SYSTEM
252   if (bound)
253     /* No error check here, because some systems can't do it and we
254      * simply don't want threads to fail because of that. */
255     pthread_attr_setscope (&attr, PTHREAD_SCOPE_SYSTEM);
256 #endif /* PTHREAD_SCOPE_SYSTEM */
257
258 #ifdef G_THREADS_IMPL_POSIX
259   posix_check_for_error (pthread_attr_setdetachstate (&attr,
260           joinable ? PTHREAD_CREATE_JOINABLE : PTHREAD_CREATE_DETACHED));
261 #endif /* G_THREADS_IMPL_POSIX */
262   
263 #ifdef HAVE_PRIORITIES
264 # ifdef G_THREADS_IMPL_POSIX
265   {
266     struct sched_param sched;
267     posix_check_for_error (pthread_attr_getschedparam (&attr, &sched));
268     sched.sched_priority = g_thread_map_priority (priority);
269     posix_check_for_error (pthread_attr_setschedparam (&attr, &sched));
270   }
271 # else /* G_THREADS_IMPL_DCE */
272   posix_check_for_error 
273     (pthread_attr_setprio (&attr, g_thread_map_priority (priority)));
274 # endif /* G_THREADS_IMPL_DCE */
275 #endif /* HAVE_PRIORITIES */
276
277   posix_check_for_error (pthread_create (thread, &attr, 
278                                          (void* (*)(void*))thread_func,
279                                          arg));
280   
281   posix_check_for_error (pthread_attr_destroy (&attr));
282
283 #ifdef G_THREADS_IMPL_DCE
284   if (!joinable)
285     posix_check_for_error (pthread_detach (thread));
286 #endif /* G_THREADS_IMPL_DCE */
287 }
288
289 static void 
290 g_thread_yield_posix_impl (void)
291 {
292   POSIX_YIELD_FUNC;
293 }
294
295 static void
296 g_thread_join_posix_impl (gpointer thread)
297 {     
298   gpointer ignore;
299   posix_check_for_error (pthread_join (*(pthread_t*)thread, 
300                                        &ignore));
301 }
302
303 static void 
304 g_thread_exit_posix_impl (void) 
305 {
306   pthread_exit (NULL);
307 }
308
309 static void
310 g_thread_set_priority_posix_impl (gpointer thread, GThreadPriority priority)
311 {
312 #ifdef HAVE_PRIORITIES
313 # ifdef G_THREADS_IMPL_POSIX
314   struct sched_param sched;
315   int policy;
316   posix_check_for_error (pthread_getschedparam (*(pthread_t*)thread, 
317                                                 &policy, &sched));
318   sched.sched_priority = g_thread_map_priority (priority);
319   posix_check_for_error (pthread_setschedparam (*(pthread_t*)thread, 
320                                                 policy, &sched));
321 # else /* G_THREADS_IMPL_DCE */
322   posix_check_for_error (pthread_setprio (*(pthread_t*)thread, 
323                                           g_thread_map_priority (priority)));
324 # endif
325 #endif /* HAVE_PRIORITIES */
326 }
327
328 static void
329 g_thread_self_posix_impl (gpointer thread)
330 {
331   *(pthread_t*)thread = pthread_self();
332 }
333
334 static GThreadFunctions g_thread_functions_for_glib_use_default =
335 {
336   g_mutex_new_posix_impl,
337   (void (*)(GMutex *)) pthread_mutex_lock,
338   g_mutex_trylock_posix_impl,
339   (void (*)(GMutex *)) pthread_mutex_unlock,
340   g_mutex_free_posix_impl,
341   g_cond_new_posix_impl,
342   (void (*)(GCond *)) pthread_cond_signal,
343   (void (*)(GCond *)) pthread_cond_broadcast,
344   (void (*)(GCond *, GMutex *)) pthread_cond_wait,
345   g_cond_timed_wait_posix_impl,
346   g_cond_free_posix_impl,
347   g_private_new_posix_impl,
348   g_private_get_posix_impl,
349   g_private_set_posix_impl,
350   g_thread_create_posix_impl,
351   g_thread_yield_posix_impl,
352   g_thread_join_posix_impl,
353   g_thread_exit_posix_impl,
354   g_thread_set_priority_posix_impl,
355   g_thread_self_posix_impl
356 };