Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Use standard C/C++ attributes when available.
[simgrid.git] / src / xbt / xbt_os_thread.c
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   */
4
5 /* Copyright (c) 2007-2017. The SimGrid Team.
6  * All rights reserved.                                                     */
7
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. */
10
11 #include "src/internal_config.h"
12 #if HAVE_PTHREAD_SETAFFINITY
13 #define _GNU_SOURCE
14 #include <sched.h>
15 #endif
16
17 #include <pthread.h>
18
19 #if defined(__FreeBSD__)
20 #include "pthread_np.h"
21 #define cpu_set_t cpuset_t
22 #endif
23
24 #include <limits.h>
25 #include <semaphore.h>
26 #include <errno.h>
27
28 #if defined(_WIN32)
29 #include <windows.h>
30 #elif defined(__MACH__) && defined(__APPLE__)
31 #include <stdint.h>
32 #include <sys/types.h>
33 #include <sys/sysctl.h>
34 #else
35 #include <unistd.h>
36 #endif
37
38 #include "xbt/sysdep.h"
39 #include "xbt/ex.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 */
44
45 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_sync_os, xbt, "Synchronization mechanism (OS-level)");
46
47 /* use named semaphore when sem_init() does not work */
48 #if !HAVE_SEM_INIT
49 static int next_sem_ID = 0;
50 static xbt_os_mutex_t next_sem_ID_lock;
51 #endif
52
53 typedef struct xbt_os_thread_ {
54   pthread_t t;
55   char *name;
56   void *param;
57   pvoid_f_pvoid_t start_routine;
58   void *extra_data;
59 } s_xbt_os_thread_t;
60 static xbt_os_thread_t main_thread = NULL;
61
62 /* thread-specific data containing the xbt_os_thread_t structure */
63 static pthread_key_t xbt_self_thread_key;
64 static int thread_mod_inited = 0;
65
66 /* defaults attribute for pthreads */
67 //FIXME: find where to put this
68 static pthread_attr_t thread_attr;
69
70 /* frees the xbt_os_thread_t corresponding to the current thread */
71 static void xbt_os_thread_free_thread_data(xbt_os_thread_t thread)
72 {
73   if (thread == main_thread)    /* just killed main thread */
74     main_thread = NULL;
75   free(thread->name);
76   free(thread);
77 }
78
79 void xbt_os_thread_mod_preinit(void)
80 {
81   if (thread_mod_inited)
82     return;
83
84   int errcode = pthread_key_create(&xbt_self_thread_key, NULL);
85   xbt_assert(errcode == 0, "pthread_key_create failed for xbt_self_thread_key");
86
87   main_thread = xbt_new(s_xbt_os_thread_t, 1);
88   main_thread->name = NULL;
89   main_thread->name = xbt_strdup("main");
90   main_thread->param = NULL;
91   main_thread->start_routine = NULL;
92   main_thread->extra_data = NULL;
93
94   if ((errcode = pthread_setspecific(xbt_self_thread_key, main_thread)))
95     THROWF(system_error, errcode,
96            "Impossible to set the SimGrid identity descriptor to the main thread (pthread_setspecific failed)");
97
98   pthread_attr_init(&thread_attr);
99
100   thread_mod_inited = 1;
101
102 #if !HAVE_SEM_INIT
103   next_sem_ID_lock = xbt_os_mutex_init();
104 #endif
105 }
106
107 void xbt_os_thread_mod_postexit(void)
108 {
109   /* FIXME: don't try to free our key on shutdown.
110      Valgrind detects no leak if we don't, and whine if we try to */
111   //   int errcode;
112
113   //   if ((errcode=pthread_key_delete(xbt_self_thread_key)))
114   //     THROWF(system_error,errcode,"pthread_key_delete failed for xbt_self_thread_key");
115   free(main_thread->name);
116   free(main_thread);
117   main_thread = NULL;
118   thread_mod_inited = 0;
119 #if !HAVE_SEM_INIT
120   xbt_os_mutex_destroy(next_sem_ID_lock);
121 #endif
122 }
123
124 /** Calls pthread_atfork() if present, and raise an exception otherwise.
125  *
126  * The only known user of this wrapper is mmalloc_preinit(), but it is absolutely mandatory there:
127  * when used with tesh, mmalloc *must* be mutex protected and resistant to forks.
128  * This functionality is the only way to get it working (by ensuring that the mutex is consistently released on forks)
129  */
130
131 /* this function is critical to tesh+mmalloc, don't mess with it */
132 int xbt_os_thread_atfork(void (*prepare)(void), void (*parent)(void), void (*child)(void))
133 {
134   return pthread_atfork(prepare, parent, child);
135 }
136
137 static void *wrapper_start_routine(void *s)
138 {
139   xbt_os_thread_t t = s;
140
141   int errcode = pthread_setspecific(xbt_self_thread_key, t);
142   xbt_assert(errcode == 0, "pthread_setspecific failed for xbt_self_thread_key");
143
144   return t->start_routine(t->param);
145 }
146
147 xbt_os_thread_t xbt_os_thread_create(const char *name,  pvoid_f_pvoid_t start_routine, void *param, void *extra_data)
148 {
149   xbt_os_thread_t res_thread = xbt_new(s_xbt_os_thread_t, 1);
150   res_thread->name = xbt_strdup(name);
151   res_thread->start_routine = start_routine;
152   res_thread->param = param;
153   res_thread->extra_data = extra_data;
154
155   int errcode = pthread_create(&(res_thread->t), &thread_attr, wrapper_start_routine, res_thread);
156   xbt_assert(errcode == 0, "pthread_create failed: %s", strerror(errcode));
157
158   return res_thread;
159 }
160
161 /** Bind the thread to the given core, if possible.
162  *
163  * If pthread_setaffinity_np is not usable on that (non-gnu) platform, this function does nothing.
164  */
165 int xbt_os_thread_bind(XBT_ATTRIB_UNUSED xbt_os_thread_t thread, XBT_ATTRIB_UNUSED int cpu)
166 {
167   int errcode = 0;
168 #if HAVE_PTHREAD_SETAFFINITY
169   pthread_t pthread = thread->t;
170   cpu_set_t cpuset;
171   CPU_ZERO(&cpuset);
172   CPU_SET(cpu, &cpuset);
173   errcode = pthread_setaffinity_np(pthread, sizeof(cpu_set_t), &cpuset);
174 #endif
175   return errcode;
176 }
177
178 void xbt_os_thread_setstacksize(int stack_size)
179 {
180   size_t alignment[] = {
181     xbt_pagesize,
182 #ifdef PTHREAD_STACK_MIN
183     PTHREAD_STACK_MIN,
184 #endif
185     0
186   };
187
188   xbt_assert(stack_size >= 0, "stack size %d is negative, maybe it exceeds MAX_INT?", stack_size);
189
190   size_t sz = stack_size;
191   int res = pthread_attr_setstacksize(&thread_attr, sz);
192
193   for (int i = 0; res == EINVAL && alignment[i] > 0; i++) {
194     /* Invalid size, try again with next multiple of alignment[i]. */
195     size_t rem = sz % alignment[i];
196     if (rem != 0 || sz == 0) {
197       size_t sz2 = sz - rem + alignment[i];
198       XBT_DEBUG("pthread_attr_setstacksize failed for %zu, try again with %zu", sz, sz2);
199       sz = sz2;
200       res = pthread_attr_setstacksize(&thread_attr, sz);
201     }
202   }
203
204   if (res == EINVAL)
205     XBT_WARN("invalid stack size (maybe too big): %zu", sz);
206   else if (res != 0)
207     XBT_WARN("unknown error %d in pthread stacksize setting: %zu", res, sz);
208 }
209
210 void xbt_os_thread_setguardsize(int guard_size)
211 {
212 #ifdef WIN32
213   THROW_UNIMPLEMENTED; //pthread_attr_setguardsize is not implemented in pthread.h on windows
214 #else
215   size_t sz = guard_size;
216   int res = pthread_attr_setguardsize(&thread_attr, sz);
217   if (res)
218     XBT_WARN("pthread_attr_setguardsize failed (%d) for size: %zu", res, sz);
219 #endif
220 }
221
222 const char *xbt_os_thread_self_name(void)
223 {
224   xbt_os_thread_t me = xbt_os_thread_self();
225   return me ? (const char *)me->name : "main";
226 }
227
228 void xbt_os_thread_join(xbt_os_thread_t thread, void **thread_return)
229 {
230   int errcode = pthread_join(thread->t, thread_return);
231
232   xbt_assert(errcode==0, "pthread_join failed: %s", strerror(errcode));
233   xbt_os_thread_free_thread_data(thread);
234 }
235
236 void xbt_os_thread_exit(int *retval)
237 {
238   pthread_exit(retval);
239 }
240
241 xbt_os_thread_t xbt_os_thread_self(void )
242 {
243   if (!thread_mod_inited)
244     return NULL;
245
246   return pthread_getspecific(xbt_self_thread_key);
247 }
248
249 void xbt_os_thread_key_create(xbt_os_thread_key_t* key)
250 {
251   int errcode = pthread_key_create(key, NULL);
252   xbt_assert(errcode==0 , "pthread_key_create failed");
253 }
254
255 void xbt_os_thread_set_specific(xbt_os_thread_key_t key, void* value)
256 {
257   int errcode = pthread_setspecific(key, value);
258   xbt_assert(errcode==0, "pthread_setspecific failed");
259 }
260
261 void* xbt_os_thread_get_specific(xbt_os_thread_key_t key)
262 {
263   return pthread_getspecific(key);
264 }
265
266 #include <sched.h>
267 void xbt_os_thread_yield(void)
268 {
269   sched_yield();
270 }
271
272 /****** mutex related functions ******/
273 typedef struct xbt_os_mutex_ {
274   pthread_mutex_t m;
275 } s_xbt_os_mutex_t;
276
277 #include <time.h>
278 #include <math.h>
279
280 xbt_os_mutex_t xbt_os_mutex_init(void)
281 {
282   pthread_mutexattr_t Attr;
283   pthread_mutexattr_init(&Attr);
284   pthread_mutexattr_settype(&Attr, PTHREAD_MUTEX_RECURSIVE);
285
286   xbt_os_mutex_t res = xbt_new(s_xbt_os_mutex_t, 1);
287   int errcode = pthread_mutex_init(&(res->m), &Attr);
288   xbt_assert(errcode==0, "pthread_mutex_init() failed: %s", strerror(errcode));
289
290   return res;
291 }
292
293 void xbt_os_mutex_acquire(xbt_os_mutex_t mutex)
294 {
295   int errcode = pthread_mutex_lock(&(mutex->m));
296   xbt_assert(errcode==0, "pthread_mutex_lock(%p) failed: %s", mutex, strerror(errcode));
297 }
298
299 void xbt_os_mutex_release(xbt_os_mutex_t mutex)
300 {
301   int errcode = pthread_mutex_unlock(&(mutex->m));
302   xbt_assert(errcode==0, "pthread_mutex_unlock(%p) failed: %s", mutex, strerror(errcode));
303 }
304
305 void xbt_os_mutex_destroy(xbt_os_mutex_t mutex)
306 {
307   if (!mutex)
308     return;
309
310   int errcode = pthread_mutex_destroy(&(mutex->m));
311   xbt_assert(errcode == 0, "pthread_mutex_destroy(%p) failed: %s", mutex, strerror(errcode));
312   free(mutex);
313 }
314
315 /***** condition related functions *****/
316 typedef struct xbt_os_cond_ {
317   pthread_cond_t c;
318 } s_xbt_os_cond_t;
319
320 xbt_os_cond_t xbt_os_cond_init(void)
321 {
322   xbt_os_cond_t res = xbt_new(s_xbt_os_cond_t, 1);
323   int errcode = pthread_cond_init(&(res->c), NULL);
324   xbt_assert(errcode==0, "pthread_cond_init() failed: %s", strerror(errcode));
325   return res;
326 }
327
328 void xbt_os_cond_wait(xbt_os_cond_t cond, xbt_os_mutex_t mutex)
329 {
330   int errcode = pthread_cond_wait(&(cond->c), &(mutex->m));
331   xbt_assert(errcode==0, "pthread_cond_wait(%p,%p) failed: %s", cond, mutex, strerror(errcode));
332 }
333
334 void xbt_os_cond_signal(xbt_os_cond_t cond)
335 {
336   int errcode = pthread_cond_signal(&(cond->c));
337   xbt_assert(errcode==0, "pthread_cond_signal(%p) failed: %s", cond, strerror(errcode));
338 }
339
340 void xbt_os_cond_broadcast(xbt_os_cond_t cond)
341 {
342   int errcode = pthread_cond_broadcast(&(cond->c));
343   xbt_assert(errcode==0, "pthread_cond_broadcast(%p) failed: %s", cond, strerror(errcode));
344 }
345
346 void xbt_os_cond_destroy(xbt_os_cond_t cond)
347 {
348   if (!cond)
349     return;
350
351   int errcode = pthread_cond_destroy(&(cond->c));
352   xbt_assert(errcode==0, "pthread_cond_destroy(%p) failed: %s", cond, strerror(errcode));
353   free(cond);
354 }
355
356 typedef struct xbt_os_sem_ {
357 #if !HAVE_SEM_INIT
358   char *name;
359 #endif
360   sem_t s;
361   sem_t *ps;
362 } s_xbt_os_sem_t;
363
364 #ifndef SEM_FAILED
365 #define SEM_FAILED (-1)
366 #endif
367
368 xbt_os_sem_t xbt_os_sem_init(unsigned int value)
369 {
370   xbt_os_sem_t res = xbt_new(s_xbt_os_sem_t, 1);
371
372   /* On some systems (MAC OS X), only the stub of sem_init is to be found.
373    * Any attempt to use it leads to ENOSYS (function not implemented).
374    * If such a prehistoric system is detected, do the job with sem_open instead
375    */
376 #if HAVE_SEM_INIT
377   if (sem_init(&(res->s), 0, value) != 0)
378     THROWF(system_error, errno, "sem_init() failed: %s", strerror(errno));
379   res->ps = &(res->s);
380
381 #else                           /* damn, no sem_init(). Reimplement it */
382
383   xbt_os_mutex_acquire(next_sem_ID_lock);
384   res->name = bprintf("/sg-%d", ++next_sem_ID);
385   xbt_os_mutex_release(next_sem_ID_lock);
386
387   sem_unlink(res->name);
388   res->ps = sem_open(res->name, O_CREAT, 0644, value);
389   if ((res->ps == (sem_t *) SEM_FAILED) && (errno == ENAMETOOLONG)) {
390     /* Old darwins only allow 13 chars. Did you create *that* amount of semaphores? */
391     res->name[13] = '\0';
392     sem_unlink(res->name);
393     res->ps = sem_open(res->name, O_CREAT, 0644, value);
394   }
395   if (res->ps == (sem_t *) SEM_FAILED)
396     THROWF(system_error, errno, "sem_open() failed: %s", strerror(errno));
397
398   /* Remove the name from the semaphore namespace: we never join on it */
399   if (sem_unlink(res->name) < 0)
400     THROWF(system_error, errno, "sem_unlink() failed: %s",
401            strerror(errno));
402
403 #endif
404
405   return res;
406 }
407
408 void xbt_os_sem_acquire(xbt_os_sem_t sem)
409 {
410   if (sem_wait(sem->ps) < 0)
411     THROWF(system_error, errno, "sem_wait() failed: %s", strerror(errno));
412 }
413
414 void xbt_os_sem_release(xbt_os_sem_t sem)
415 {
416   if (sem_post(sem->ps) < 0)
417     THROWF(system_error, errno, "sem_post() failed: %s", strerror(errno));
418 }
419
420 void xbt_os_sem_destroy(xbt_os_sem_t sem)
421 {
422 #if HAVE_SEM_INIT
423   if (sem_destroy(sem->ps) < 0)
424     THROWF(system_error, errno, "sem_destroy() failed: %s", strerror(errno));
425 #else
426   if (sem_close(sem->ps) < 0)
427     THROWF(system_error, errno, "sem_close() failed: %s", strerror(errno));
428   xbt_free(sem->name);
429 #endif
430   xbt_free(sem);
431 }
432
433 /** @brief Returns the amount of cores on the current host */
434 int xbt_os_get_numcores(void) {
435 #ifdef WIN32
436     SYSTEM_INFO sysinfo;
437     GetSystemInfo(&sysinfo);
438     return sysinfo.dwNumberOfProcessors;
439 #elif defined(__APPLE__) && defined(__MACH__)
440     int nm[2];
441     size_t len = 4;
442     uint32_t count;
443
444     nm[0] = CTL_HW; nm[1] = HW_AVAILCPU;
445     sysctl(nm, 2, &count, &len, NULL, 0);
446
447     if(count < 1) {
448         nm[1] = HW_NCPU;
449         sysctl(nm, 2, &count, &len, NULL, 0);
450         if(count < 1) { count = 1; }
451     }
452     return count;
453 #else
454     return sysconf(_SC_NPROCESSORS_ONLN);
455 #endif
456 }
457
458 void xbt_os_thread_set_extra_data(void *data)
459 {
460   xbt_os_thread_self()->extra_data = data;
461 }
462
463 void *xbt_os_thread_get_extra_data(void)
464 {
465   xbt_os_thread_t thread = xbt_os_thread_self();
466   return thread ? thread->extra_data : NULL;
467 }