1 /* xbt_os_thread -- portability layer over the pthread API */
2 /* Used in RL to get win/lin portability, and in SG when CONTEXT_THREAD */
3 /* in SG, when using HAVE_UCONTEXT_CONTEXTS, xbt_os_thread_stub is used instead */
5 /* Copyright (c) 2007-2015. The SimGrid Team.
6 * All rights reserved. */
8 /* This program is free software; you can redistribute it and/or modify it
9 * under the terms of the license (GNU LGPL) which comes with this package. */
11 #include "src/internal_config.h"
12 #if HAVE_PTHREAD_SETAFFINITY
19 #if defined(__FreeBSD__)
20 #include "pthread_np.h"
21 #define cpu_set_t cpuset_t
25 #include <semaphore.h>
30 #elif defined(__MACH__) && defined(__APPLE__)
32 #include <sys/types.h>
33 #include <sys/sysctl.h>
38 #include "xbt/sysdep.h"
40 #include "src/internal_config.h"
41 #include "xbt/xbt_os_time.h" /* Portable time facilities */
42 #include "xbt/xbt_os_thread.h" /* This module */
43 #include "src/xbt_modinter.h" /* Initialization/finalization of this module */
45 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_sync_os, xbt, "Synchronization mechanism (OS-level)");
47 /* use named sempahore when sem_init() does not work */
49 static int next_sem_ID = 0;
50 static xbt_os_mutex_t next_sem_ID_lock;
53 typedef struct xbt_os_thread_ {
58 pvoid_f_pvoid_t start_routine;
61 static xbt_os_thread_t main_thread = NULL;
63 /* thread-specific data containing the xbt_os_thread_t structure */
64 static pthread_key_t xbt_self_thread_key;
65 static int thread_mod_inited = 0;
67 /* defaults attribute for pthreads */
68 //FIXME: find where to put this
69 static pthread_attr_t thread_attr;
71 /* frees the xbt_os_thread_t corresponding to the current thread */
72 static void xbt_os_thread_free_thread_data(xbt_os_thread_t thread)
74 if (thread == main_thread) /* just killed main thread */
80 /* callback: termination */
81 static void _os_thread_ex_terminate(xbt_ex_t * e)
85 /* FIXME: there should be a configuration variable to choose to kill everyone or only this one */
88 void xbt_os_thread_mod_preinit(void)
90 if (thread_mod_inited)
93 int errcode = pthread_key_create(&xbt_self_thread_key, NULL);
94 xbt_assert(errcode == 0, "pthread_key_create failed for xbt_self_thread_key");
96 main_thread = xbt_new(s_xbt_os_thread_t, 1);
97 main_thread->name = NULL;
98 main_thread->detached = 0;
99 main_thread->name = (char *) "main";
100 main_thread->param = NULL;
101 main_thread->start_routine = NULL;
102 main_thread->extra_data = NULL;
104 if ((errcode = pthread_setspecific(xbt_self_thread_key, main_thread)))
105 THROWF(system_error, errcode,
106 "Impossible to set the SimGrid identity descriptor to the main thread (pthread_setspecific failed)");
108 pthread_attr_init(&thread_attr);
110 thread_mod_inited = 1;
113 next_sem_ID_lock = xbt_os_mutex_init();
117 void xbt_os_thread_mod_postexit(void)
119 /* FIXME: don't try to free our key on shutdown.
120 Valgrind detects no leak if we don't, and whine if we try to */
123 // if ((errcode=pthread_key_delete(xbt_self_thread_key)))
124 // THROWF(system_error,errcode,"pthread_key_delete failed for xbt_self_thread_key");
127 thread_mod_inited = 0;
129 xbt_os_mutex_destroy(next_sem_ID_lock);
133 /** Calls pthread_atfork() if present, and raise an exception otherwise.
135 * The only known user of this wrapper is mmalloc_preinit(), but it is absolutely mandatory there:
136 * when used with tesh, mmalloc *must* be mutex protected and resistant to forks.
137 * This functionality is the only way to get it working (by ensuring that the mutex is consistently released on forks)
140 /* this function is critical to tesh+mmalloc, don't mess with it */
141 int xbt_os_thread_atfork(void (*prepare)(void), void (*parent)(void), void (*child)(void))
143 return pthread_atfork(prepare, parent, child);
146 static void *wrapper_start_routine(void *s)
148 xbt_os_thread_t t = s;
150 int errcode = pthread_setspecific(xbt_self_thread_key, t);
151 xbt_assert(errcode == 0, "pthread_setspecific failed for xbt_self_thread_key");
153 void *res = t->start_routine(t->param);
155 xbt_os_thread_free_thread_data(t);
159 xbt_os_thread_t xbt_os_thread_create(const char *name, pvoid_f_pvoid_t start_routine, void *param, void *extra_data)
161 xbt_os_thread_t res_thread = xbt_new(s_xbt_os_thread_t, 1);
162 res_thread->detached = 0;
163 res_thread->name = xbt_strdup(name);
164 res_thread->start_routine = start_routine;
165 res_thread->param = param;
166 res_thread->extra_data = extra_data;
168 int errcode = pthread_create(&(res_thread->t), &thread_attr, wrapper_start_routine, res_thread);
169 xbt_assert(errcode == 0, "pthread_create failed: %s", strerror(errcode));
174 /** Bind the thread to the given core, if possible.
176 * If pthread_setaffinity_np is not usable on that (non-gnu) platform, this function does nothing.
178 int xbt_os_thread_bind(xbt_os_thread_t thread, int cpu){
180 #if HAVE_PTHREAD_SETAFFINITY
181 pthread_t pthread = thread->t;
184 CPU_SET(cpu, &cpuset);
185 errcode = pthread_setaffinity_np(pthread, sizeof(cpu_set_t), &cpuset);
190 void xbt_os_thread_setstacksize(int stack_size)
192 size_t alignment[] = {
194 #ifdef PTHREAD_STACK_MIN
200 xbt_assert(stack_size >= 0, "stack size %d is negative, maybe it exceeds MAX_INT?", stack_size);
202 size_t sz = stack_size;
203 int res = pthread_attr_setstacksize(&thread_attr, sz);
205 for (int i = 0; res == EINVAL && alignment[i] > 0; i++) {
206 /* Invalid size, try again with next multiple of alignment[i]. */
207 size_t rem = sz % alignment[i];
208 if (rem != 0 || sz == 0) {
209 size_t sz2 = sz - rem + alignment[i];
210 XBT_DEBUG("pthread_attr_setstacksize failed for %zd, try again with %zd", sz, sz2);
212 res = pthread_attr_setstacksize(&thread_attr, sz);
217 XBT_WARN("invalid stack size (maybe too big): %zd", sz);
219 XBT_WARN("unknown error %d in pthread stacksize setting: %zd", res, sz);
222 void xbt_os_thread_setguardsize(int guard_size)
225 THROW_UNIMPLEMENTED; //pthread_attr_setguardsize is not implemented in pthread.h on windows
227 size_t sz = guard_size;
228 int res = pthread_attr_setguardsize(&thread_attr, sz);
230 XBT_WARN("pthread_attr_setguardsize failed (%d) for size: %zd", res, sz);
234 const char *xbt_os_thread_self_name(void)
236 xbt_os_thread_t me = xbt_os_thread_self();
237 return me ? me->name : "main";
240 void xbt_os_thread_join(xbt_os_thread_t thread, void **thread_return)
242 int errcode = pthread_join(thread->t, thread_return);
244 xbt_assert(errcode==0, "pthread_join failed: %s", strerror(errcode));
245 xbt_os_thread_free_thread_data(thread);
248 void xbt_os_thread_exit(int *retval)
250 pthread_exit(retval);
253 xbt_os_thread_t xbt_os_thread_self(void )
255 if (!thread_mod_inited)
258 return pthread_getspecific(xbt_self_thread_key);
261 void xbt_os_thread_key_create(xbt_os_thread_key_t* key)
263 int errcode = pthread_key_create(key, NULL);
264 xbt_assert(errcode==0 , "pthread_key_create failed");
267 void xbt_os_thread_set_specific(xbt_os_thread_key_t key, void* value)
269 int errcode = pthread_setspecific(key, value);
270 xbt_assert(errcode==0, "pthread_setspecific failed");
273 void* xbt_os_thread_get_specific(xbt_os_thread_key_t key)
275 return pthread_getspecific(key);
278 void xbt_os_thread_detach(xbt_os_thread_t thread)
280 thread->detached = 1;
281 pthread_detach(thread->t);
285 void xbt_os_thread_yield(void)
290 void xbt_os_thread_cancel(xbt_os_thread_t t)
292 pthread_cancel(t->t);
295 /****** mutex related functions ******/
296 typedef struct xbt_os_mutex_ {
303 xbt_os_mutex_t xbt_os_mutex_init(void)
305 pthread_mutexattr_t Attr;
306 pthread_mutexattr_init(&Attr);
307 pthread_mutexattr_settype(&Attr, PTHREAD_MUTEX_RECURSIVE);
309 xbt_os_mutex_t res = xbt_new(s_xbt_os_mutex_t, 1);
310 int errcode = pthread_mutex_init(&(res->m), &Attr);
311 xbt_assert(errcode==0, "pthread_mutex_init() failed: %s", strerror(errcode));
316 void xbt_os_mutex_acquire(xbt_os_mutex_t mutex)
318 int errcode = pthread_mutex_lock(&(mutex->m));
319 xbt_assert(errcode==0, "pthread_mutex_lock(%p) failed: %s", mutex, strerror(errcode));
322 void xbt_os_mutex_release(xbt_os_mutex_t mutex)
324 int errcode = pthread_mutex_unlock(&(mutex->m));
325 xbt_assert(errcode==0, "pthread_mutex_unlock(%p) failed: %s", mutex, strerror(errcode));
328 void xbt_os_mutex_destroy(xbt_os_mutex_t mutex)
333 int errcode = pthread_mutex_destroy(&(mutex->m));
334 xbt_assert(errcode == 0, "pthread_mutex_destroy(%p) failed: %s", mutex, strerror(errcode));
338 /***** condition related functions *****/
339 typedef struct xbt_os_cond_ {
343 xbt_os_cond_t xbt_os_cond_init(void)
345 xbt_os_cond_t res = xbt_new(s_xbt_os_cond_t, 1);
346 int errcode = pthread_cond_init(&(res->c), NULL);
347 xbt_assert(errcode==0, "pthread_cond_init() failed: %s", strerror(errcode));
351 void xbt_os_cond_wait(xbt_os_cond_t cond, xbt_os_mutex_t mutex)
353 int errcode = pthread_cond_wait(&(cond->c), &(mutex->m));
354 xbt_assert(errcode==0, "pthread_cond_wait(%p,%p) failed: %s", cond, mutex, strerror(errcode));
357 void xbt_os_cond_signal(xbt_os_cond_t cond)
359 int errcode = pthread_cond_signal(&(cond->c));
360 xbt_assert(errcode==0, "pthread_cond_signal(%p) failed: %s", cond, strerror(errcode));
363 void xbt_os_cond_broadcast(xbt_os_cond_t cond)
365 int errcode = pthread_cond_broadcast(&(cond->c));
366 xbt_assert(errcode==0, "pthread_cond_broadcast(%p) failed: %s", cond, strerror(errcode));
369 void xbt_os_cond_destroy(xbt_os_cond_t cond)
374 int errcode = pthread_cond_destroy(&(cond->c));
375 xbt_assert(errcode==0, "pthread_cond_destroy(%p) failed: %s", cond, strerror(errcode));
379 typedef struct xbt_os_sem_ {
388 #define SEM_FAILED (-1)
391 xbt_os_sem_t xbt_os_sem_init(unsigned int value)
393 xbt_os_sem_t res = xbt_new(s_xbt_os_sem_t, 1);
395 /* On some systems (MAC OS X), only the stub of sem_init is to be found.
396 * Any attempt to use it leads to ENOSYS (function not implemented).
397 * If such a prehistoric system is detected, do the job with sem_open instead
400 if (sem_init(&(res->s), 0, value) != 0)
401 THROWF(system_error, errno, "sem_init() failed: %s", strerror(errno));
404 #else /* damn, no sem_init(). Reimplement it */
406 xbt_os_mutex_acquire(next_sem_ID_lock);
407 res->name = bprintf("/%d", ++next_sem_ID);
408 xbt_os_mutex_release(next_sem_ID_lock);
410 res->ps = sem_open(res->name, O_CREAT, 0644, value);
411 if ((res->ps == (sem_t *) SEM_FAILED) && (errno == ENAMETOOLONG)) {
412 /* Old darwins only allow 13 chars. Did you create *that* amount of semaphores? */
413 res->name[13] = '\0';
414 res->ps = sem_open(res->name, O_CREAT, 0644, value);
416 if (res->ps == (sem_t *) SEM_FAILED)
417 THROWF(system_error, errno, "sem_open() failed: %s", strerror(errno));
419 /* Remove the name from the semaphore namespace: we never join on it */
420 if (sem_unlink(res->name) < 0)
421 THROWF(system_error, errno, "sem_unlink() failed: %s",
429 void xbt_os_sem_acquire(xbt_os_sem_t sem)
431 if (sem_wait(sem->ps) < 0)
432 THROWF(system_error, errno, "sem_wait() failed: %s", strerror(errno));
435 void xbt_os_sem_release(xbt_os_sem_t sem)
437 if (sem_post(sem->ps) < 0)
438 THROWF(system_error, errno, "sem_post() failed: %s", strerror(errno));
441 void xbt_os_sem_destroy(xbt_os_sem_t sem)
444 if (sem_destroy(sem->ps) < 0)
445 THROWF(system_error, errno, "sem_destroy() failed: %s", strerror(errno));
447 if (sem_close(sem->ps) < 0)
448 THROWF(system_error, errno, "sem_close() failed: %s", strerror(errno));
454 /** @brief Returns the amount of cores on the current host */
455 int xbt_os_get_numcores(void) {
458 GetSystemInfo(&sysinfo);
459 return sysinfo.dwNumberOfProcessors;
460 #elif defined(__APPLE__) && defined(__MACH__)
465 nm[0] = CTL_HW; nm[1] = HW_AVAILCPU;
466 sysctl(nm, 2, &count, &len, NULL, 0);
470 sysctl(nm, 2, &count, &len, NULL, 0);
471 if(count < 1) { count = 1; }
475 return sysconf(_SC_NPROCESSORS_ONLN);
479 void xbt_os_thread_set_extra_data(void *data)
481 xbt_os_thread_self()->extra_data = data;
484 void *xbt_os_thread_get_extra_data(void)
486 xbt_os_thread_t thread = xbt_os_thread_self();
487 return thread ? thread->extra_data : NULL;