1 /**
2  * Copyright (c) 2016 Tino Reichardt
3  * All rights reserved.
4  *
5  * This source code is licensed under both the BSD-style license (found in the
6  * LICENSE file in the root directory of this source tree) and the GPLv2 (found
7  * in the COPYING file in the root directory of this source tree).
8  *
9  * You can contact the author at:
10  * - zstdmt source repository: https://github.com/mcmilk/zstdmt
11  */
12 
13 #ifndef THREADING_H_938743
14 #define THREADING_H_938743
15 
16 #include "debug.h"
17 
18 #if defined (__cplusplus)
19 extern "C" {
20 #endif
21 
22 #if defined(ZSTD_MULTITHREAD) && defined(_WIN32)
23 
24 /**
25  * Windows minimalist Pthread Wrapper, based on :
26  * http://www.cse.wustl.edu/~schmidt/win32-cv-1.html
27  */
28 #ifdef WINVER
29 #  undef WINVER
30 #endif
31 #define WINVER       0x0600
32 
33 #ifdef _WIN32_WINNT
34 #  undef _WIN32_WINNT
35 #endif
36 #define _WIN32_WINNT 0x0600
37 
38 #ifndef WIN32_LEAN_AND_MEAN
39 #  define WIN32_LEAN_AND_MEAN
40 #endif
41 
42 #undef ERROR   /* reported already defined on VS 2015 (Rich Geldreich) */
43 #include <windows.h>
44 #undef ERROR
45 #define ERROR(name) ZSTD_ERROR(name)
46 
47 
48 /* mutex */
49 #define ZSTD_pthread_mutex_t           CRITICAL_SECTION
50 #define ZSTD_pthread_mutex_init(a, b)  ((void)(b), InitializeCriticalSection((a)), 0)
51 #define ZSTD_pthread_mutex_destroy(a)  DeleteCriticalSection((a))
52 #define ZSTD_pthread_mutex_lock(a)     EnterCriticalSection((a))
53 #define ZSTD_pthread_mutex_unlock(a)   LeaveCriticalSection((a))
54 
55 /* condition variable */
56 #define ZSTD_pthread_cond_t             CONDITION_VARIABLE
57 #define ZSTD_pthread_cond_init(a, b)    ((void)(b), InitializeConditionVariable((a)), 0)
58 #define ZSTD_pthread_cond_destroy(a)    ((void)(a))
59 #define ZSTD_pthread_cond_wait(a, b)    SleepConditionVariableCS((a), (b), INFINITE)
60 #define ZSTD_pthread_cond_signal(a)     WakeConditionVariable((a))
61 #define ZSTD_pthread_cond_broadcast(a)  WakeAllConditionVariable((a))
62 
63 /* ZSTD_pthread_create() and ZSTD_pthread_join() */
64 typedef struct {
65     HANDLE handle;
66     void* (*start_routine)(void*);
67     void* arg;
68 } ZSTD_pthread_t;
69 
70 int ZSTD_pthread_create(ZSTD_pthread_t* thread, const void* unused,
71                    void* (*start_routine) (void*), void* arg);
72 
73 int ZSTD_pthread_join(ZSTD_pthread_t thread, void** value_ptr);
74 
75 /**
76  * add here more wrappers as required
77  */
78 
79 
80 #elif defined(ZSTD_MULTITHREAD)    /* posix assumed ; need a better detection method */
81 /* ===   POSIX Systems   === */
82 #  include <pthread.h>
83 
84 #if DEBUGLEVEL < 1
85 
86 #define ZSTD_pthread_mutex_t            pthread_mutex_t
87 #define ZSTD_pthread_mutex_init(a, b)   pthread_mutex_init((a), (b))
88 #define ZSTD_pthread_mutex_destroy(a)   pthread_mutex_destroy((a))
89 #define ZSTD_pthread_mutex_lock(a)      pthread_mutex_lock((a))
90 #define ZSTD_pthread_mutex_unlock(a)    pthread_mutex_unlock((a))
91 
92 #define ZSTD_pthread_cond_t             pthread_cond_t
93 #define ZSTD_pthread_cond_init(a, b)    pthread_cond_init((a), (b))
94 #define ZSTD_pthread_cond_destroy(a)    pthread_cond_destroy((a))
95 #define ZSTD_pthread_cond_wait(a, b)    pthread_cond_wait((a), (b))
96 #define ZSTD_pthread_cond_signal(a)     pthread_cond_signal((a))
97 #define ZSTD_pthread_cond_broadcast(a)  pthread_cond_broadcast((a))
98 
99 #define ZSTD_pthread_t                  pthread_t
100 #define ZSTD_pthread_create(a, b, c, d) pthread_create((a), (b), (c), (d))
101 #define ZSTD_pthread_join(a, b)         pthread_join((a),(b))
102 
103 #else /* DEBUGLEVEL >= 1 */
104 
105 /* Debug implementation of threading.
106  * In this implementation we use pointers for mutexes and condition variables.
107  * This way, if we forget to init/destroy them the program will crash or ASAN
108  * will report leaks.
109  */
110 
111 #define ZSTD_pthread_mutex_t            pthread_mutex_t*
112 int ZSTD_pthread_mutex_init(ZSTD_pthread_mutex_t* mutex, pthread_mutexattr_t const* attr);
113 int ZSTD_pthread_mutex_destroy(ZSTD_pthread_mutex_t* mutex);
114 #define ZSTD_pthread_mutex_lock(a)      pthread_mutex_lock(*(a))
115 #define ZSTD_pthread_mutex_unlock(a)    pthread_mutex_unlock(*(a))
116 
117 #define ZSTD_pthread_cond_t             pthread_cond_t*
118 int ZSTD_pthread_cond_init(ZSTD_pthread_cond_t* cond, pthread_condattr_t const* attr);
119 int ZSTD_pthread_cond_destroy(ZSTD_pthread_cond_t* cond);
120 #define ZSTD_pthread_cond_wait(a, b)    pthread_cond_wait(*(a), *(b))
121 #define ZSTD_pthread_cond_signal(a)     pthread_cond_signal(*(a))
122 #define ZSTD_pthread_cond_broadcast(a)  pthread_cond_broadcast(*(a))
123 
124 #define ZSTD_pthread_t                  pthread_t
125 #define ZSTD_pthread_create(a, b, c, d) pthread_create((a), (b), (c), (d))
126 #define ZSTD_pthread_join(a, b)         pthread_join((a),(b))
127 
128 #endif
129 
130 #else  /* ZSTD_MULTITHREAD not defined */
131 /* No multithreading support */
132 
133 typedef int ZSTD_pthread_mutex_t;
134 #define ZSTD_pthread_mutex_init(a, b)   ((void)(a), (void)(b), 0)
135 #define ZSTD_pthread_mutex_destroy(a)   ((void)(a))
136 #define ZSTD_pthread_mutex_lock(a)      ((void)(a))
137 #define ZSTD_pthread_mutex_unlock(a)    ((void)(a))
138 
139 typedef int ZSTD_pthread_cond_t;
140 #define ZSTD_pthread_cond_init(a, b)    ((void)(a), (void)(b), 0)
141 #define ZSTD_pthread_cond_destroy(a)    ((void)(a))
142 #define ZSTD_pthread_cond_wait(a, b)    ((void)(a), (void)(b))
143 #define ZSTD_pthread_cond_signal(a)     ((void)(a))
144 #define ZSTD_pthread_cond_broadcast(a)  ((void)(a))
145 
146 /* do not use ZSTD_pthread_t */
147 
148 #endif /* ZSTD_MULTITHREAD */
149 
150 #if defined (__cplusplus)
151 }
152 #endif
153 
154 #endif /* THREADING_H_938743 */
155