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 #ifdef HAVE_PTHREAD_SETAFFINITY
19 #if defined(__FreeBSD__)
20 #include "pthread_np.h"
21 #define cpu_set_t cpuset_t
25 #include <semaphore.h>
29 #elif defined(__MACH__) && defined(__APPLE__)
31 #include <sys/types.h>
32 #include <sys/sysctl.h>
37 #include "xbt/sysdep.h"
39 #include "src/xbt/ex_interface.h" /* We play crude games with exceptions */
40 #include "src/portable.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)");
48 /* use named sempahore when sem_init() does not work */
50 static int next_sem_ID = 0;
51 static xbt_os_mutex_t next_sem_ID_lock;
54 typedef struct xbt_os_thread_ {
59 pvoid_f_pvoid_t start_routine;
60 xbt_running_ctx_t *running_ctx;
63 static xbt_os_thread_t main_thread = NULL;
65 /* thread-specific data containing the xbt_os_thread_t structure */
66 static pthread_key_t xbt_self_thread_key;
67 static int thread_mod_inited = 0;
69 /* defaults attribute for pthreads */
70 //FIXME: find where to put this
71 static pthread_attr_t thread_attr;
73 /* frees the xbt_os_thread_t corresponding to the current thread */
74 static void xbt_os_thread_free_thread_data(xbt_os_thread_t thread)
76 if (thread == main_thread) /* just killed main thread */
79 free(thread->running_ctx);
84 /* callback: context fetching */
85 static xbt_running_ctx_t *_os_thread_get_running_ctx(void)
87 return xbt_os_thread_self()->running_ctx;
90 /* callback: termination */
91 static void _os_thread_ex_terminate(xbt_ex_t * e)
95 /* FIXME: there should be a configuration variable to choose to kill everyone or only this one */
98 void xbt_os_thread_mod_preinit(void)
100 if (thread_mod_inited)
103 int errcode = pthread_key_create(&xbt_self_thread_key, NULL);
104 xbt_assert(errcode == 0, "pthread_key_create failed for xbt_self_thread_key");
106 main_thread = xbt_new(s_xbt_os_thread_t, 1);
107 main_thread->name = NULL;
108 main_thread->detached = 0;
109 main_thread->name = (char *) "main";
110 main_thread->param = NULL;
111 main_thread->start_routine = NULL;
112 main_thread->running_ctx = xbt_new(xbt_running_ctx_t, 1);
113 main_thread->extra_data = NULL;
114 XBT_RUNNING_CTX_INITIALIZE(main_thread->running_ctx);
116 if ((errcode = pthread_setspecific(xbt_self_thread_key, main_thread)))
117 THROWF(system_error, errcode,
118 "Impossible to set the SimGrid identity descriptor to the main thread (pthread_setspecific failed)");
120 __xbt_running_ctx_fetch = _os_thread_get_running_ctx;
121 __xbt_ex_terminate = _os_thread_ex_terminate;
123 pthread_attr_init(&thread_attr);
125 thread_mod_inited = 1;
127 #ifndef HAVE_SEM_INIT
128 next_sem_ID_lock = xbt_os_mutex_init();
132 void xbt_os_thread_mod_postexit(void)
134 /* FIXME: don't try to free our key on shutdown.
135 Valgrind detects no leak if we don't, and whine if we try to */
138 // if ((errcode=pthread_key_delete(xbt_self_thread_key)))
139 // THROWF(system_error,errcode,"pthread_key_delete failed for xbt_self_thread_key");
140 free(main_thread->running_ctx);
143 thread_mod_inited = 0;
144 #ifndef HAVE_SEM_INIT
145 xbt_os_mutex_destroy(next_sem_ID_lock);
148 /* Restore the default exception setup */
149 __xbt_running_ctx_fetch = &__xbt_ex_ctx_default;
150 __xbt_ex_terminate = &__xbt_ex_terminate_default;
153 /** Calls pthread_atfork() if present, and raise an exception otherwise.
155 * The only known user of this wrapper is mmalloc_preinit(), but it is absolutely mandatory there:
156 * when used with tesh, mmalloc *must* be mutex protected and resistant to forks.
157 * This functionality is the only way to get it working (by ensuring that the mutex is consistently released on forks)
160 /* this function is critical to tesh+mmalloc, don't mess with it */
161 int xbt_os_thread_atfork(void (*prepare)(void), void (*parent)(void), void (*child)(void))
163 return pthread_atfork(prepare, parent, child);
166 static void *wrapper_start_routine(void *s)
168 xbt_os_thread_t t = s;
170 int errcode = pthread_setspecific(xbt_self_thread_key, t);
171 xbt_assert(errcode == 0, "pthread_setspecific failed for xbt_self_thread_key");
173 void *res = t->start_routine(t->param);
175 xbt_os_thread_free_thread_data(t);
180 xbt_os_thread_t xbt_os_thread_create(const char *name, pvoid_f_pvoid_t start_routine, void *param, void *extra_data)
182 xbt_os_thread_t res_thread = xbt_new(s_xbt_os_thread_t, 1);
183 res_thread->detached = 0;
184 res_thread->name = xbt_strdup(name);
185 res_thread->start_routine = start_routine;
186 res_thread->param = param;
187 res_thread->running_ctx = xbt_new(xbt_running_ctx_t, 1);
188 XBT_RUNNING_CTX_INITIALIZE(res_thread->running_ctx);
189 res_thread->extra_data = extra_data;
191 int errcode = pthread_create(&(res_thread->t), &thread_attr, wrapper_start_routine, res_thread);
192 xbt_assert(errcode == 0, "pthread_create failed: %s", strerror(errcode));
197 /** Bind the thread to the given core, if possible.
199 * If pthread_setaffinity_np is not usable on that (non-gnu) platform, this function does nothing.
201 int xbt_os_thread_bind(xbt_os_thread_t thread, int cpu){
203 #ifdef HAVE_PTHREAD_SETAFFINITY
204 pthread_t pthread = thread->t;
207 CPU_SET(cpu, &cpuset);
208 errcode = pthread_setaffinity_np(pthread, sizeof(cpu_set_t), &cpuset);
213 void xbt_os_thread_setstacksize(int stack_size)
215 size_t alignment[] = {
217 #ifdef PTHREAD_STACK_MIN
223 xbt_assert(stack_size >= 0, "stack size %d is negative, maybe it exceeds MAX_INT?", stack_size);
225 size_t sz = stack_size;
226 int res = pthread_attr_setstacksize(&thread_attr, sz);
228 for (int i = 0; res == EINVAL && alignment[i] > 0; i++) {
229 /* Invalid size, try again with next multiple of alignment[i]. */
230 size_t rem = sz % alignment[i];
231 if (rem != 0 || sz == 0) {
232 size_t sz2 = sz - rem + alignment[i];
233 XBT_DEBUG("pthread_attr_setstacksize failed for %zd, try again with %zd", sz, sz2);
235 res = pthread_attr_setstacksize(&thread_attr, sz);
240 XBT_WARN("invalid stack size (maybe too big): %zd", sz);
242 XBT_WARN("unknown error %d in pthread stacksize setting: %zd", res, sz);
245 void xbt_os_thread_setguardsize(int guard_size)
248 THROW_UNIMPLEMENTED; //pthread_attr_setguardsize is not implemented in pthread.h on windows
250 size_t sz = guard_size;
251 int res = pthread_attr_setguardsize(&thread_attr, sz);
253 XBT_WARN("pthread_attr_setguardsize failed (%d) for size: %zd", res, sz);
257 const char *xbt_os_thread_self_name(void)
259 xbt_os_thread_t me = xbt_os_thread_self();
260 return me ? me->name : "main";
263 void xbt_os_thread_join(xbt_os_thread_t thread, void **thread_return)
265 int errcode = pthread_join(thread->t, thread_return);
267 xbt_assert(errcode==0, "pthread_join failed: %s", strerror(errcode));
268 xbt_os_thread_free_thread_data(thread);
271 void xbt_os_thread_exit(int *retval)
273 pthread_exit(retval);
276 xbt_os_thread_t xbt_os_thread_self(void)
278 if (!thread_mod_inited)
281 return pthread_getspecific(xbt_self_thread_key);
284 void xbt_os_thread_key_create(xbt_os_thread_key_t* key)
286 int errcode = pthread_key_create(key, NULL);
287 xbt_assert(errcode==0 , "pthread_key_create failed");
290 void xbt_os_thread_set_specific(xbt_os_thread_key_t key, void* value) {
292 int errcode = pthread_setspecific(key, value);
293 xbt_assert(errcode==0, "pthread_setspecific failed");
296 void* xbt_os_thread_get_specific(xbt_os_thread_key_t key) {
297 return pthread_getspecific(key);
300 void xbt_os_thread_detach(xbt_os_thread_t thread)
302 thread->detached = 1;
303 pthread_detach(thread->t);
307 void xbt_os_thread_yield(void)
312 void xbt_os_thread_cancel(xbt_os_thread_t t)
314 pthread_cancel(t->t);
317 /****** mutex related functions ******/
318 typedef struct xbt_os_mutex_ {
325 xbt_os_mutex_t xbt_os_mutex_init(void)
327 pthread_mutexattr_t Attr;
328 pthread_mutexattr_init(&Attr);
329 pthread_mutexattr_settype(&Attr, PTHREAD_MUTEX_RECURSIVE);
331 xbt_os_mutex_t res = xbt_new(s_xbt_os_mutex_t, 1);
332 int errcode = pthread_mutex_init(&(res->m), &Attr);
333 xbt_assert(errcode==0, "pthread_mutex_init() failed: %s", strerror(errcode));
338 void xbt_os_mutex_acquire(xbt_os_mutex_t mutex)
340 int errcode = pthread_mutex_lock(&(mutex->m));
341 xbt_assert(errcode==0, "pthread_mutex_lock(%p) failed: %s", mutex, strerror(errcode));
344 void xbt_os_mutex_release(xbt_os_mutex_t mutex)
346 int errcode = pthread_mutex_unlock(&(mutex->m));
347 xbt_assert(errcode==0, "pthread_mutex_unlock(%p) failed: %s", mutex, strerror(errcode));
350 void xbt_os_mutex_destroy(xbt_os_mutex_t mutex)
355 int errcode = pthread_mutex_destroy(&(mutex->m));
356 xbt_assert(errcode == 0, "pthread_mutex_destroy(%p) failed: %s", mutex, strerror(errcode));
360 /***** condition related functions *****/
361 typedef struct xbt_os_cond_ {
365 xbt_os_cond_t xbt_os_cond_init(void)
367 xbt_os_cond_t res = xbt_new(s_xbt_os_cond_t, 1);
368 int errcode = pthread_cond_init(&(res->c), NULL);
369 xbt_assert(errcode==0, "pthread_cond_init() failed: %s", strerror(errcode));
373 void xbt_os_cond_wait(xbt_os_cond_t cond, xbt_os_mutex_t mutex)
375 int errcode = pthread_cond_wait(&(cond->c), &(mutex->m));
376 xbt_assert(errcode==0, "pthread_cond_wait(%p,%p) failed: %s", cond, mutex, strerror(errcode));
379 void xbt_os_cond_signal(xbt_os_cond_t cond)
381 int errcode = pthread_cond_signal(&(cond->c));
382 xbt_assert(errcode==0, "pthread_cond_signal(%p) failed: %s", cond, strerror(errcode));
385 void xbt_os_cond_broadcast(xbt_os_cond_t cond)
387 int errcode = pthread_cond_broadcast(&(cond->c));
388 xbt_assert(errcode==0, "pthread_cond_broadcast(%p) failed: %s", cond, strerror(errcode));
391 void xbt_os_cond_destroy(xbt_os_cond_t cond)
396 int errcode = pthread_cond_destroy(&(cond->c));
397 xbt_assert(errcode==0, "pthread_cond_destroy(%p) failed: %s", cond, strerror(errcode));
401 typedef struct xbt_os_sem_ {
402 #ifndef HAVE_SEM_INIT
410 #define SEM_FAILED (-1)
413 xbt_os_sem_t xbt_os_sem_init(unsigned int value)
415 xbt_os_sem_t res = xbt_new(s_xbt_os_sem_t, 1);
417 /* On some systems (MAC OS X), only the stub of sem_init is to be found.
418 * Any attempt to use it leads to ENOSYS (function not implemented).
419 * If such a prehistoric system is detected, do the job with sem_open instead
422 if (sem_init(&(res->s), 0, value) != 0)
423 THROWF(system_error, errno, "sem_init() failed: %s", strerror(errno));
426 #else /* damn, no sem_init(). Reimplement it */
428 xbt_os_mutex_acquire(next_sem_ID_lock);
429 res->name = bprintf("/%d", ++next_sem_ID);
430 xbt_os_mutex_release(next_sem_ID_lock);
432 res->ps = sem_open(res->name, O_CREAT, 0644, value);
433 if ((res->ps == (sem_t *) SEM_FAILED) && (errno == ENAMETOOLONG)) {
434 /* Old darwins only allow 13 chars. Did you create *that* amount of semaphores? */
435 res->name[13] = '\0';
436 res->ps = sem_open(res->name, O_CREAT, 0644, value);
438 if (res->ps == (sem_t *) SEM_FAILED)
439 THROWF(system_error, errno, "sem_open() failed: %s", strerror(errno));
441 /* Remove the name from the semaphore namespace: we never join on it */
442 if (sem_unlink(res->name) < 0)
443 THROWF(system_error, errno, "sem_unlink() failed: %s",
451 void xbt_os_sem_acquire(xbt_os_sem_t sem)
453 if (sem_wait(sem->ps) < 0)
454 THROWF(system_error, errno, "sem_wait() failed: %s", strerror(errno));
457 void xbt_os_sem_release(xbt_os_sem_t sem)
459 if (sem_post(sem->ps) < 0)
460 THROWF(system_error, errno, "sem_post() failed: %s", strerror(errno));
463 void xbt_os_sem_destroy(xbt_os_sem_t sem)
466 if (sem_destroy(sem->ps) < 0)
467 THROWF(system_error, errno, "sem_destroy() failed: %s",
470 if (sem_close(sem->ps) < 0)
471 THROWF(system_error, errno, "sem_close() failed: %s", strerror(errno));
478 void xbt_os_sem_get_value(xbt_os_sem_t sem, int *svalue)
480 if (sem_getvalue(&(sem->s), svalue) < 0)
481 THROWF(system_error, errno, "sem_getvalue() failed: %s",
486 /** @brief Returns the amount of cores on the current host */
487 int xbt_os_get_numcores(void) {
490 GetSystemInfo(&sysinfo);
491 return sysinfo.dwNumberOfProcessors;
492 #elif defined(__APPLE__) && defined(__MACH__)
497 nm[0] = CTL_HW; nm[1] = HW_AVAILCPU;
498 sysctl(nm, 2, &count, &len, NULL, 0);
502 sysctl(nm, 2, &count, &len, NULL, 0);
503 if(count < 1) { count = 1; }
507 return sysconf(_SC_NPROCESSORS_ONLN);
511 void xbt_os_thread_set_extra_data(void *data)
513 xbt_os_thread_self()->extra_data = data;
516 void *xbt_os_thread_get_extra_data(void)
518 xbt_os_thread_t thread = xbt_os_thread_self();
519 return thread ? thread->extra_data : NULL;