1 /* Threads compatibility routines for libgcc2 and libobjc. */
2 /* Compile this one with gcc. */
3 /* Copyright (C) 1997, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007
4 Free Software Foundation, Inc.
6 This file is part of GCC.
8 GCC is free software; you can redistribute it and/or modify it under
9 the terms of the GNU General Public License as published by the Free
10 Software Foundation; either version 2, or (at your option) any later
13 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
14 WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
18 You should have received a copy of the GNU General Public License
19 along with GCC; see the file COPYING. If not, write to the Free
20 Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA
23 /* As a special exception, if you link this library with other files,
24 some of which are compiled with GCC, to produce an executable,
25 this library does not by itself cause the resulting executable
26 to be covered by the GNU General Public License.
27 This exception does not however invalidate any other reasons why
28 the executable file might be covered by the GNU General Public License. */
30 #ifndef GCC_GTHR_POSIX_H
31 #define GCC_GTHR_POSIX_H
33 /* POSIX threads specific definitions.
34 Easy, since the interface is just one-to-one mapping. */
38 /* Some implementations of <pthread.h> require this to be defined. */
39 #if !defined(_REENTRANT) && defined(__osf__)
46 typedef pthread_key_t __gthread_key_t
;
47 typedef pthread_once_t __gthread_once_t
;
48 typedef pthread_mutex_t __gthread_mutex_t
;
49 typedef pthread_mutex_t __gthread_recursive_mutex_t
;
50 typedef pthread_cond_t __gthread_cond_t
;
52 /* POSIX like conditional variables are supported. Please look at comments
53 in gthr.h for details. */
54 #define __GTHREAD_HAS_COND 1
56 #define __GTHREAD_MUTEX_INIT PTHREAD_MUTEX_INITIALIZER
57 #define __GTHREAD_ONCE_INIT PTHREAD_ONCE_INIT
58 #if defined(PTHREAD_RECURSIVE_MUTEX_INITIALIZER)
59 #define __GTHREAD_RECURSIVE_MUTEX_INIT PTHREAD_RECURSIVE_MUTEX_INITIALIZER
60 #elif defined(PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP)
61 #define __GTHREAD_RECURSIVE_MUTEX_INIT PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP
63 #define __GTHREAD_RECURSIVE_MUTEX_INIT_FUNCTION __gthread_recursive_mutex_init_function
65 #define __GTHREAD_COND_INIT PTHREAD_COND_INITIALIZER
67 #if SUPPORTS_WEAK && GTHREAD_USE_WEAK
68 # ifndef __gthrw_pragma
69 # define __gthrw_pragma(pragma)
71 # define __gthrw2(name,name2,type) \
72 static __typeof(type) name __attribute__ ((__weakref__(#name2))); \
73 __gthrw_pragma(weak type)
74 # define __gthrw_(name) __gthrw_ ## name
76 # define __gthrw2(name,name2,type)
77 # define __gthrw_(name) name
80 /* Typically, __gthrw_foo is a weak reference to symbol foo. */
81 #define __gthrw(name) __gthrw2(__gthrw_ ## name,name,name)
83 /* On Tru64, /usr/include/pthread.h uses #pragma extern_prefix "__" to
84 map a subset of the POSIX pthread API to mangled versions of their
86 #if defined(__osf__) && defined(_PTHREAD_USE_MANGLED_NAMES_)
87 #define __gthrw3(name) __gthrw2(__gthrw_ ## name, __ ## name, name)
88 __gthrw3(pthread_once
)
89 __gthrw3(pthread_getspecific
)
90 __gthrw3(pthread_setspecific
)
91 __gthrw3(pthread_create
)
92 __gthrw3(pthread_cancel
)
93 __gthrw3(pthread_mutex_lock
)
94 __gthrw3(pthread_mutex_trylock
)
95 __gthrw3(pthread_mutex_unlock
)
96 __gthrw3(pthread_mutex_init
)
97 __gthrw3(pthread_cond_broadcast
)
98 __gthrw3(pthread_cond_wait
)
100 __gthrw(pthread_once
)
101 __gthrw(pthread_getspecific
)
102 __gthrw(pthread_setspecific
)
103 __gthrw(pthread_create
)
104 __gthrw(pthread_cancel
)
105 __gthrw(pthread_mutex_lock
)
106 __gthrw(pthread_mutex_trylock
)
107 __gthrw(pthread_mutex_unlock
)
108 __gthrw(pthread_mutex_init
)
109 __gthrw(pthread_cond_broadcast
)
110 __gthrw(pthread_cond_wait
)
113 __gthrw(pthread_key_create
)
114 __gthrw(pthread_key_delete
)
115 __gthrw(pthread_mutexattr_init
)
116 __gthrw(pthread_mutexattr_settype
)
117 __gthrw(pthread_mutexattr_destroy
)
120 #if defined(_LIBOBJC) || defined(_LIBOBJC_WEAK)
122 #if defined(__osf__) && defined(_PTHREAD_USE_MANGLED_NAMES_)
123 __gthrw3(pthread_cond_destroy
)
124 __gthrw3(pthread_cond_init
)
125 __gthrw3(pthread_cond_signal
)
126 __gthrw3(pthread_exit
)
127 __gthrw3(pthread_mutex_destroy
)
128 __gthrw3(pthread_self
)
130 __gthrw(pthread_cond_destroy
)
131 __gthrw(pthread_cond_init
)
132 __gthrw(pthread_cond_signal
)
133 __gthrw(pthread_exit
)
134 __gthrw(pthread_mutex_destroy
)
135 __gthrw(pthread_self
)
136 #endif /* __osf__ && _PTHREAD_USE_MANGLED_NAMES_ */
137 #ifdef _POSIX_PRIORITY_SCHEDULING
138 #ifdef _POSIX_THREAD_PRIORITY_SCHEDULING
139 __gthrw(sched_get_priority_max
)
140 __gthrw(sched_get_priority_min
)
141 #endif /* _POSIX_THREAD_PRIORITY_SCHEDULING */
142 #endif /* _POSIX_PRIORITY_SCHEDULING */
144 __gthrw(pthread_attr_destroy
)
145 __gthrw(pthread_attr_init
)
146 __gthrw(pthread_attr_setdetachstate
)
147 #ifdef _POSIX_THREAD_PRIORITY_SCHEDULING
148 __gthrw(pthread_getschedparam
)
149 __gthrw(pthread_setschedparam
)
150 #endif /* _POSIX_THREAD_PRIORITY_SCHEDULING */
151 #endif /* _LIBOBJC || _LIBOBJC_WEAK */
153 #if SUPPORTS_WEAK && GTHREAD_USE_WEAK
155 /* On Solaris 2.6 up to 9, the libc exposes a POSIX threads interface even if
156 -pthreads is not specified. The functions are dummies and most return an
157 error value. However pthread_once returns 0 without invoking the routine
158 it is passed so we cannot pretend that the interface is active if -pthreads
159 is not specified. On Solaris 2.5.1, the interface is not exposed at all so
160 we need to play the usual game with weak symbols. On Solaris 10 and up, a
161 working interface is always exposed. On FreeBSD 6 and later, libc also
162 exposes a dummy POSIX threads interface, similar to what Solaris 2.6 up
163 to 9 does. FreeBSD >= 700014 even provides a pthread_cancel stub in libc,
164 which means the alternate __gthread_active_p below cannot be used there. */
166 #if defined(__FreeBSD__) || (defined(__sun) && defined(__svr4__))
168 static volatile int __gthread_active
= -1;
171 __gthread_trigger (void)
173 __gthread_active
= 1;
177 __gthread_active_p (void)
179 static pthread_mutex_t __gthread_active_mutex
= PTHREAD_MUTEX_INITIALIZER
;
180 static pthread_once_t __gthread_active_once
= PTHREAD_ONCE_INIT
;
182 /* Avoid reading __gthread_active twice on the main code path. */
183 int __gthread_active_latest_value
= __gthread_active
;
185 /* This test is not protected to avoid taking a lock on the main code
186 path so every update of __gthread_active in a threaded program must
187 be atomic with regard to the result of the test. */
188 if (__builtin_expect (__gthread_active_latest_value
< 0, 0))
190 if (__gthrw_(pthread_once
))
192 /* If this really is a threaded program, then we must ensure that
193 __gthread_active has been set to 1 before exiting this block. */
194 __gthrw_(pthread_mutex_lock
) (&__gthread_active_mutex
);
195 __gthrw_(pthread_once
) (&__gthread_active_once
, __gthread_trigger
);
196 __gthrw_(pthread_mutex_unlock
) (&__gthread_active_mutex
);
199 /* Make sure we'll never enter this block again. */
200 if (__gthread_active
< 0)
201 __gthread_active
= 0;
203 __gthread_active_latest_value
= __gthread_active
;
206 return __gthread_active_latest_value
!= 0;
209 #else /* neither FreeBSD nor Solaris */
212 __gthread_active_p (void)
214 static void *const __gthread_active_ptr
215 = __extension__ (void *) &__gthrw_(pthread_cancel
);
216 return __gthread_active_ptr
!= 0;
219 #endif /* FreeBSD or Solaris */
221 #else /* not SUPPORTS_WEAK */
223 /* Similar to Solaris, HP-UX 11 for PA-RISC provides stubs for pthread
224 calls in shared flavors of the HP-UX C library. Most of the stubs
225 have no functionality. The details are described in the "libc cumulative
226 patch" for each subversion of HP-UX 11. There are two special interfaces
227 provided for checking whether an application is linked to a pthread
228 library or not. However, these interfaces aren't available in early
229 libc versions. We also can't use pthread_once as some libc versions
230 call the init function. So, we use pthread_create to check whether it
231 is possible to create a thread or not. The stub implementation returns
232 the error number ENOSYS. */
234 #if defined(__hppa__) && defined(__hpux__)
238 static volatile int __gthread_active
= -1;
241 __gthread_start (void *arg
__attribute__((unused
)))
246 static void __gthread_active_init (void) __attribute__((noinline
));
248 __gthread_active_init (void)
250 static pthread_mutex_t __gthread_active_mutex
= PTHREAD_MUTEX_INITIALIZER
;
255 __gthrw_(pthread_mutex_lock
) (&__gthread_active_mutex
);
256 if (__gthread_active
< 0)
258 __gthrw_(pthread_attr_init
) (&a
);
259 __gthrw_(pthread_attr_setdetachstate
) (&a
, PTHREAD_CREATE_DETACHED
);
260 result
= __gthrw_(pthread_create
) (&t
, &a
, __gthread_start
, NULL
);
261 if (result
!= ENOSYS
)
262 __gthread_active
= 1;
264 __gthread_active
= 0;
265 __gthrw_(pthread_attr_destroy
) (&a
);
267 __gthrw_(pthread_mutex_unlock
) (&__gthread_active_mutex
);
271 __gthread_active_p (void)
273 /* Avoid reading __gthread_active twice on the main code path. */
274 int __gthread_active_latest_value
= __gthread_active
;
276 /* This test is not protected to avoid taking a lock on the main code
277 path so every update of __gthread_active in a threaded program must
278 be atomic with regard to the result of the test. */
279 if (__builtin_expect (__gthread_active_latest_value
< 0, 0))
281 __gthread_active_init ();
282 __gthread_active_latest_value
= __gthread_active
;
285 return __gthread_active_latest_value
!= 0;
288 #else /* not hppa-hpux */
291 __gthread_active_p (void)
296 #endif /* hppa-hpux */
298 #endif /* SUPPORTS_WEAK */
302 /* This is the config.h file in libobjc/ */
309 /* Key structure for maintaining thread specific storage */
310 static pthread_key_t _objc_thread_storage
;
311 static pthread_attr_t _objc_thread_attribs
;
313 /* Thread local storage for a single thread */
314 static void *thread_local_storage
= NULL
;
316 /* Backend initialization functions */
318 /* Initialize the threads subsystem. */
320 __gthread_objc_init_thread_system (void)
322 if (__gthread_active_p ())
324 /* Initialize the thread storage key. */
325 if (__gthrw_(pthread_key_create
) (&_objc_thread_storage
, NULL
) == 0)
327 /* The normal default detach state for threads is
328 * PTHREAD_CREATE_JOINABLE which causes threads to not die
329 * when you think they should. */
330 if (__gthrw_(pthread_attr_init
) (&_objc_thread_attribs
) == 0
331 && __gthrw_(pthread_attr_setdetachstate
) (&_objc_thread_attribs
,
332 PTHREAD_CREATE_DETACHED
) == 0)
340 /* Close the threads subsystem. */
342 __gthread_objc_close_thread_system (void)
344 if (__gthread_active_p ()
345 && __gthrw_(pthread_key_delete
) (_objc_thread_storage
) == 0
346 && __gthrw_(pthread_attr_destroy
) (&_objc_thread_attribs
) == 0)
352 /* Backend thread functions */
354 /* Create a new thread of execution. */
355 static inline objc_thread_t
356 __gthread_objc_thread_detach (void (*func
)(void *), void *arg
)
358 objc_thread_t thread_id
;
359 pthread_t new_thread_handle
;
361 if (!__gthread_active_p ())
364 if (!(__gthrw_(pthread_create
) (&new_thread_handle
, NULL
, (void *) func
, arg
)))
365 thread_id
= (objc_thread_t
) new_thread_handle
;
372 /* Set the current thread's priority. */
374 __gthread_objc_thread_set_priority (int priority
)
376 if (!__gthread_active_p ())
380 #ifdef _POSIX_PRIORITY_SCHEDULING
381 #ifdef _POSIX_THREAD_PRIORITY_SCHEDULING
382 pthread_t thread_id
= __gthrw_(pthread_self
) ();
384 struct sched_param params
;
385 int priority_min
, priority_max
;
387 if (__gthrw_(pthread_getschedparam
) (thread_id
, &policy
, ¶ms
) == 0)
389 if ((priority_max
= __gthrw_(sched_get_priority_max
) (policy
)) == -1)
392 if ((priority_min
= __gthrw_(sched_get_priority_min
) (policy
)) == -1)
395 if (priority
> priority_max
)
396 priority
= priority_max
;
397 else if (priority
< priority_min
)
398 priority
= priority_min
;
399 params
.sched_priority
= priority
;
402 * The solaris 7 and several other man pages incorrectly state that
403 * this should be a pointer to policy but pthread.h is universally
406 if (__gthrw_(pthread_setschedparam
) (thread_id
, policy
, ¶ms
) == 0)
409 #endif /* _POSIX_THREAD_PRIORITY_SCHEDULING */
410 #endif /* _POSIX_PRIORITY_SCHEDULING */
415 /* Return the current thread's priority. */
417 __gthread_objc_thread_get_priority (void)
419 #ifdef _POSIX_PRIORITY_SCHEDULING
420 #ifdef _POSIX_THREAD_PRIORITY_SCHEDULING
421 if (__gthread_active_p ())
424 struct sched_param params
;
426 if (__gthrw_(pthread_getschedparam
) (__gthrw_(pthread_self
) (), &policy
, ¶ms
) == 0)
427 return params
.sched_priority
;
432 #endif /* _POSIX_THREAD_PRIORITY_SCHEDULING */
433 #endif /* _POSIX_PRIORITY_SCHEDULING */
434 return OBJC_THREAD_INTERACTIVE_PRIORITY
;
437 /* Yield our process time to another thread. */
439 __gthread_objc_thread_yield (void)
441 if (__gthread_active_p ())
442 __gthrw_(sched_yield
) ();
445 /* Terminate the current thread. */
447 __gthread_objc_thread_exit (void)
449 if (__gthread_active_p ())
450 /* exit the thread */
451 __gthrw_(pthread_exit
) (&__objc_thread_exit_status
);
453 /* Failed if we reached here */
457 /* Returns an integer value which uniquely describes a thread. */
458 static inline objc_thread_t
459 __gthread_objc_thread_id (void)
461 if (__gthread_active_p ())
462 return (objc_thread_t
) __gthrw_(pthread_self
) ();
464 return (objc_thread_t
) 1;
467 /* Sets the thread's local storage pointer. */
469 __gthread_objc_thread_set_data (void *value
)
471 if (__gthread_active_p ())
472 return __gthrw_(pthread_setspecific
) (_objc_thread_storage
, value
);
475 thread_local_storage
= value
;
480 /* Returns the thread's local storage pointer. */
482 __gthread_objc_thread_get_data (void)
484 if (__gthread_active_p ())
485 return __gthrw_(pthread_getspecific
) (_objc_thread_storage
);
487 return thread_local_storage
;
490 /* Backend mutex functions */
492 /* Allocate a mutex. */
494 __gthread_objc_mutex_allocate (objc_mutex_t mutex
)
496 if (__gthread_active_p ())
498 mutex
->backend
= objc_malloc (sizeof (pthread_mutex_t
));
500 if (__gthrw_(pthread_mutex_init
) ((pthread_mutex_t
*) mutex
->backend
, NULL
))
502 objc_free (mutex
->backend
);
503 mutex
->backend
= NULL
;
511 /* Deallocate a mutex. */
513 __gthread_objc_mutex_deallocate (objc_mutex_t mutex
)
515 if (__gthread_active_p ())
520 * Posix Threads specifically require that the thread be unlocked
521 * for __gthrw_(pthread_mutex_destroy) to work.
526 count
= __gthrw_(pthread_mutex_unlock
) ((pthread_mutex_t
*) mutex
->backend
);
532 if (__gthrw_(pthread_mutex_destroy
) ((pthread_mutex_t
*) mutex
->backend
))
535 objc_free (mutex
->backend
);
536 mutex
->backend
= NULL
;
541 /* Grab a lock on a mutex. */
543 __gthread_objc_mutex_lock (objc_mutex_t mutex
)
545 if (__gthread_active_p ()
546 && __gthrw_(pthread_mutex_lock
) ((pthread_mutex_t
*) mutex
->backend
) != 0)
554 /* Try to grab a lock on a mutex. */
556 __gthread_objc_mutex_trylock (objc_mutex_t mutex
)
558 if (__gthread_active_p ()
559 && __gthrw_(pthread_mutex_trylock
) ((pthread_mutex_t
*) mutex
->backend
) != 0)
567 /* Unlock the mutex */
569 __gthread_objc_mutex_unlock (objc_mutex_t mutex
)
571 if (__gthread_active_p ()
572 && __gthrw_(pthread_mutex_unlock
) ((pthread_mutex_t
*) mutex
->backend
) != 0)
580 /* Backend condition mutex functions */
582 /* Allocate a condition. */
584 __gthread_objc_condition_allocate (objc_condition_t condition
)
586 if (__gthread_active_p ())
588 condition
->backend
= objc_malloc (sizeof (pthread_cond_t
));
590 if (__gthrw_(pthread_cond_init
) ((pthread_cond_t
*) condition
->backend
, NULL
))
592 objc_free (condition
->backend
);
593 condition
->backend
= NULL
;
601 /* Deallocate a condition. */
603 __gthread_objc_condition_deallocate (objc_condition_t condition
)
605 if (__gthread_active_p ())
607 if (__gthrw_(pthread_cond_destroy
) ((pthread_cond_t
*) condition
->backend
))
610 objc_free (condition
->backend
);
611 condition
->backend
= NULL
;
616 /* Wait on the condition */
618 __gthread_objc_condition_wait (objc_condition_t condition
, objc_mutex_t mutex
)
620 if (__gthread_active_p ())
621 return __gthrw_(pthread_cond_wait
) ((pthread_cond_t
*) condition
->backend
,
622 (pthread_mutex_t
*) mutex
->backend
);
627 /* Wake up all threads waiting on this condition. */
629 __gthread_objc_condition_broadcast (objc_condition_t condition
)
631 if (__gthread_active_p ())
632 return __gthrw_(pthread_cond_broadcast
) ((pthread_cond_t
*) condition
->backend
);
637 /* Wake up one thread waiting on this condition. */
639 __gthread_objc_condition_signal (objc_condition_t condition
)
641 if (__gthread_active_p ())
642 return __gthrw_(pthread_cond_signal
) ((pthread_cond_t
*) condition
->backend
);
650 __gthread_once (__gthread_once_t
*once
, void (*func
) (void))
652 if (__gthread_active_p ())
653 return __gthrw_(pthread_once
) (once
, func
);
659 __gthread_key_create (__gthread_key_t
*key
, void (*dtor
) (void *))
661 return __gthrw_(pthread_key_create
) (key
, dtor
);
665 __gthread_key_delete (__gthread_key_t key
)
667 return __gthrw_(pthread_key_delete
) (key
);
671 __gthread_getspecific (__gthread_key_t key
)
673 return __gthrw_(pthread_getspecific
) (key
);
677 __gthread_setspecific (__gthread_key_t key
, const void *ptr
)
679 return __gthrw_(pthread_setspecific
) (key
, ptr
);
683 __gthread_mutex_lock (__gthread_mutex_t
*mutex
)
685 if (__gthread_active_p ())
686 return __gthrw_(pthread_mutex_lock
) (mutex
);
692 __gthread_mutex_trylock (__gthread_mutex_t
*mutex
)
694 if (__gthread_active_p ())
695 return __gthrw_(pthread_mutex_trylock
) (mutex
);
701 __gthread_mutex_unlock (__gthread_mutex_t
*mutex
)
703 if (__gthread_active_p ())
704 return __gthrw_(pthread_mutex_unlock
) (mutex
);
709 #ifndef PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP
711 __gthread_recursive_mutex_init_function (__gthread_recursive_mutex_t
*mutex
)
713 if (__gthread_active_p ())
715 pthread_mutexattr_t attr
;
718 r
= __gthrw_(pthread_mutexattr_init
) (&attr
);
720 r
= __gthrw_(pthread_mutexattr_settype
) (&attr
, PTHREAD_MUTEX_RECURSIVE
);
722 r
= __gthrw_(pthread_mutex_init
) (mutex
, &attr
);
724 r
= __gthrw_(pthread_mutexattr_destroy
) (&attr
);
732 __gthread_recursive_mutex_lock (__gthread_recursive_mutex_t
*mutex
)
734 return __gthread_mutex_lock (mutex
);
738 __gthread_recursive_mutex_trylock (__gthread_recursive_mutex_t
*mutex
)
740 return __gthread_mutex_trylock (mutex
);
744 __gthread_recursive_mutex_unlock (__gthread_recursive_mutex_t
*mutex
)
746 return __gthread_mutex_unlock (mutex
);
750 __gthread_cond_broadcast (__gthread_cond_t
*cond
)
752 return __gthrw_(pthread_cond_broadcast
) (cond
);
756 __gthread_cond_wait (__gthread_cond_t
*cond
, __gthread_mutex_t
*mutex
)
758 return __gthrw_(pthread_cond_wait
) (cond
, mutex
);
762 __gthread_cond_wait_recursive (__gthread_cond_t
*cond
,
763 __gthread_recursive_mutex_t
*mutex
)
765 return __gthread_cond_wait (cond
, mutex
);
768 #endif /* _LIBOBJC */
770 #endif /* ! GCC_GTHR_POSIX_H */