1 /* ---------------------------------------------------------------------------
3 * (c) The GHC Team, 2001-2005
5 * Accessing OS threads functionality in a (mostly) OS-independent
8 * --------------------------------------------------------------------------*/
10 #if defined(__linux__)
11 /* We want GNU extensions in DEBUG mode for mutex error checking */
12 /* We also want the affinity API, which requires _GNU_SOURCE */
16 #include "PosixSource.h"
18 #if defined(freebsd_HOST_OS)
19 /* Inclusion of system headers usually requires __BSD_VISIBLE on FreeBSD,
20 * because of some specific types, like u_char, u_int, etc. */
21 #define __BSD_VISIBLE 1
26 #if defined(THREADED_RTS)
34 #if defined(darwin_HOST_OS) || defined(freebsd_HOST_OS)
35 #include <sys/types.h>
36 #include <sys/sysctl.h>
39 #if !defined(HAVE_PTHREAD_H)
40 #error pthreads.h is required for the threaded RTS on Posix platforms
43 #if defined(HAVE_SCHED_H)
47 #if defined(HAVE_SYS_CPUSET_H)
48 #include <sys/param.h>
49 #include <sys/cpuset.h>
56 #if defined(darwin_HOST_OS)
57 #include <mach/mach.h>
61 * This (allegedly) OS threads independent layer was initially
62 * abstracted away from code that used Pthreads, so the functions
63 * provided here are mostly just wrappers to the Pthreads API.
68 initCondition( Condition* pCond )
70 pthread_cond_init(pCond, NULL);
75 closeCondition( Condition* pCond )
77 pthread_cond_destroy(pCond);
82 broadcastCondition ( Condition* pCond )
84 return (pthread_cond_broadcast(pCond) == 0);
88 signalCondition ( Condition* pCond )
90 return (pthread_cond_signal(pCond) == 0);
94 waitCondition ( Condition* pCond, Mutex* pMut )
96 return (pthread_cond_wait(pCond,pMut) == 0);
113 createOSThread (OSThreadId* pId, OSThreadProc *startProc, void *param)
115 int result = pthread_create(pId, NULL, (void *(*)(void *))startProc, param);
117 pthread_detach(*pId);
124 return pthread_self();
128 osThreadIsAlive(OSThreadId id STG_UNUSED)
130 // no good way to implement this on POSIX, AFAICT. Returning true
136 initMutex(Mutex* pMut)
139 pthread_mutexattr_t attr;
140 pthread_mutexattr_init(&attr);
141 pthread_mutexattr_settype(&attr,PTHREAD_MUTEX_ERRORCHECK);
142 pthread_mutex_init(pMut,&attr);
144 pthread_mutex_init(pMut,NULL);
149 closeMutex(Mutex* pMut)
151 pthread_mutex_destroy(pMut);
155 newThreadLocalKey (ThreadLocalKey *key)
158 if ((r = pthread_key_create(key, NULL)) != 0) {
159 barf("newThreadLocalKey: %s", strerror(r));
164 getThreadLocalVar (ThreadLocalKey *key)
166 return pthread_getspecific(*key);
167 // Note: a return value of NULL can indicate that either the key
168 // is not valid, or the key is valid and the data value has not
169 // yet been set. We need to use the latter case, so we cannot
170 // detect errors here.
174 setThreadLocalVar (ThreadLocalKey *key, void *value)
177 if ((r = pthread_setspecific(*key,value)) != 0) {
178 barf("setThreadLocalVar: %s", strerror(r));
183 freeThreadLocalKey (ThreadLocalKey *key)
186 if ((r = pthread_key_delete(*key)) != 0) {
187 barf("freeThreadLocalKey: %s", strerror(r));
192 forkOS_createThreadWrapper ( void * entry )
196 cap = rts_evalStableIO(cap, (HsStablePtr) entry, NULL);
197 taskTimeStamp(myTask());
203 forkOS_createThread ( HsStablePtr entry )
206 int result = pthread_create(&tid, NULL,
207 forkOS_createThreadWrapper, (void*)entry);
214 getNumberOfProcessors (void)
216 static nat nproc = 0;
219 #if defined(HAVE_SYSCONF) && defined(_SC_NPROCESSORS_ONLN)
220 nproc = sysconf(_SC_NPROCESSORS_ONLN);
221 #elif defined(HAVE_SYSCONF) && defined(_SC_NPROCESSORS_CONF)
222 nproc = sysconf(_SC_NPROCESSORS_CONF);
223 #elif defined(darwin_HOST_OS) || defined(freebsd_HOST_OS)
224 size_t size = sizeof(nat);
225 if(0 != sysctlbyname("hw.ncpu",&nproc,&size,NULL,0))
235 #if defined(HAVE_SCHED_H) && defined(HAVE_SCHED_SETAFFINITY)
236 // Schedules the thread to run on CPU n of m. m may be less than the
237 // number of physical CPUs, in which case, the thread will be allowed
238 // to run on CPU n, n+m, n+2m etc.
240 setThreadAffinity (nat n, nat m)
246 nproc = getNumberOfProcessors();
248 for (i = n; i < nproc; i+=m) {
251 sched_setaffinity(0, sizeof(cpu_set_t), &cs);
254 #elif defined(darwin_HOST_OS) && defined(THREAD_AFFINITY_POLICY)
255 // Schedules the current thread in the affinity set identified by tag n.
257 setThreadAffinity (nat n, nat m GNUC3_ATTRIBUTE(__unused__))
259 thread_affinity_policy_data_t policy;
261 policy.affinity_tag = n;
262 thread_policy_set(mach_thread_self(),
263 THREAD_AFFINITY_POLICY,
264 (thread_policy_t) &policy,
265 THREAD_AFFINITY_POLICY_COUNT);
268 #elif defined(HAVE_SYS_CPUSET_H) /* FreeBSD 7.1+ */
270 setThreadAffinity(nat n, nat m)
276 nproc = getNumberOfProcessors();
279 for (i = n; i < nproc; i += m)
282 cpuset_setaffinity(CPU_LEVEL_WHICH, CPU_WHICH_TID, -1, sizeof(cpuset_t), &cs);
287 setThreadAffinity (nat n GNUC3_ATTRIBUTE(__unused__),
288 nat m GNUC3_ATTRIBUTE(__unused__))
293 #else /* !defined(THREADED_RTS) */
296 forkOS_createThread ( HsStablePtr entry STG_UNUSED )
301 #endif /* !defined(THREADED_RTS) */