Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Drop xbt_os_thread_t
[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-2019. The SimGrid Team. All rights reserved.          */
6
7 /* This program is free software; you can redistribute it and/or modify it
8  * under the terms of the license (GNU LGPL) which comes with this package. */
9
10 #include "src/internal_config.h"
11 #if HAVE_PTHREAD_SETAFFINITY
12 #define _GNU_SOURCE
13 #include <sched.h>
14 #endif
15
16 #include <pthread.h>
17
18 #if defined(__FreeBSD__)
19 #include "pthread_np.h"
20 #define cpu_set_t cpuset_t
21 #endif
22
23 #include <limits.h>
24 #include <semaphore.h>
25 #include <errno.h>
26
27 #if defined(_WIN32)
28 #include <windows.h>
29 #elif defined(__MACH__) && defined(__APPLE__)
30 #include <stdint.h>
31 #include <sys/types.h>
32 #include <sys/sysctl.h>
33 #else
34 #include <unistd.h>
35 #endif
36
37 #include "xbt/sysdep.h"
38 #include "xbt/ex.h"
39 #include "src/internal_config.h"
40 #include "xbt/xbt_os_time.h"       /* Portable time facilities */
41 #include "xbt/xbt_os_thread.h"     /* This module */
42 #include "src/xbt_modinter.h"      /* Initialization/finalization of this module */
43
44 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_sync_os, xbt, "Synchronization mechanism (OS-level)");
45
46 typedef struct xbt_os_thread_ {
47   pthread_t t;
48   void *param;
49   pvoid_f_pvoid_t start_routine;
50 } s_xbt_os_thread_t;
51
52 /** Calls pthread_atfork() if present, and raise an exception otherwise.
53  *
54  * The only known user of this wrapper is mmalloc_preinit(), but it is absolutely mandatory there:
55  * when used with tesh, mmalloc *must* be mutex protected and resistant to forks.
56  * This functionality is the only way to get it working (by ensuring that the mutex is consistently released on forks)
57  */
58
59 /* this function is critical to tesh+mmalloc, don't mess with it */
60 int xbt_os_thread_atfork(void (*prepare)(void), void (*parent)(void), void (*child)(void))
61 {
62   return pthread_atfork(prepare, parent, child);
63 }
64
65 /****** mutex related functions ******/
66 typedef struct xbt_os_mutex_ {
67   pthread_mutex_t m;
68 } s_xbt_os_mutex_t;
69
70 #include <time.h>
71 #include <math.h>
72
73 xbt_os_mutex_t xbt_os_mutex_init(void)
74 {
75   pthread_mutexattr_t Attr;
76   pthread_mutexattr_init(&Attr);
77   pthread_mutexattr_settype(&Attr, PTHREAD_MUTEX_RECURSIVE);
78
79   xbt_os_mutex_t res = xbt_new(s_xbt_os_mutex_t, 1);
80   int errcode = pthread_mutex_init(&(res->m), &Attr);
81   xbt_assert(errcode==0, "pthread_mutex_init() failed: %s", strerror(errcode));
82
83   return res;
84 }
85
86 void xbt_os_mutex_acquire(xbt_os_mutex_t mutex)
87 {
88   int errcode = pthread_mutex_lock(&(mutex->m));
89   xbt_assert(errcode==0, "pthread_mutex_lock(%p) failed: %s", mutex, strerror(errcode));
90 }
91
92 void xbt_os_mutex_release(xbt_os_mutex_t mutex)
93 {
94   int errcode = pthread_mutex_unlock(&(mutex->m));
95   xbt_assert(errcode==0, "pthread_mutex_unlock(%p) failed: %s", mutex, strerror(errcode));
96 }
97
98 void xbt_os_mutex_destroy(xbt_os_mutex_t mutex)
99 {
100   if (!mutex)
101     return;
102
103   int errcode = pthread_mutex_destroy(&(mutex->m));
104   xbt_assert(errcode == 0, "pthread_mutex_destroy(%p) failed: %s", mutex, strerror(errcode));
105   free(mutex);
106 }