summaryrefslogtreecommitdiff
path: root/kit/threads.win32.c
blob: ac185f75491905e19cf39c5e30d9f43c50d94da6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
#include "threads.h"

#ifndef KIT_DISABLE_SYSTEM_THREADS
#  include "allocator.h"

#  if defined(_WIN32) && !defined(__CYGWIN__)
#    include <assert.h>
#    include <errno.h>
#    include <limits.h>
#    include <process.h>
#    include <stdlib.h>

#    ifndef WIN32_LEAN_AND_MEAN
#      define WIN32_LEAN_AND_MEAN 1
#    endif
#    ifndef NOMINMAX
#      define NOMINMAX
#    endif
#    include <windows.h>

/*
Configuration macro:

  EMULATED_THREADS_USE_NATIVE_CALL_ONCE
    Use native WindowsAPI one-time initialization function.
    (requires WinVista or later)
    Otherwise emulate by mtx_trylock() + *busy loop* for WinXP.
*/

#    if _WIN32_WINNT >= 0x0600
/* Prefer native WindowsAPI on newer environment. */
#      if !defined(__MINGW32__)
#        define EMULATED_THREADS_USE_NATIVE_CALL_ONCE
#      endif
#    endif

/* check configuration */
#    if defined(EMULATED_THREADS_USE_NATIVE_CALL_ONCE) && \
        (_WIN32_WINNT < 0x0600)
#      error EMULATED_THREADS_USE_NATIVE_CALL_ONCE requires _WIN32_WINNT>=0x0600
#    endif

static_assert(sizeof(cnd_t) == sizeof(CONDITION_VARIABLE),
              "The size of cnd_t must equal to CONDITION_VARIABLE");
static_assert(sizeof(thrd_t) == sizeof(HANDLE),
              "The size of thrd_t must equal to HANDLE");
static_assert(sizeof(mtx_t) == sizeof(CRITICAL_SECTION),
              "The size of mtx_t must equal to CRITICAL_SECTION");
static_assert(sizeof(once_flag) == sizeof(INIT_ONCE),
              "The size of once_flag must equal to INIT_ONCE");

/*
Implementation limits:
  - Conditionally emulation for "Initialization functions"
    (see EMULATED_THREADS_USE_NATIVE_CALL_ONCE macro)
  - Emulated `mtx_timelock()' with mtx_trylock() + *busy loop*
*/

typedef struct {
  thrd_start_t func;
  void        *arg;
  thrd_t       thrd;
} impl_thrd_param_t;

struct thrd_state {
  thrd_t thrd;
  int    handle_need_close;
};

static thread_local struct thrd_state impl_current_thread = { 0 };

static unsigned __stdcall impl_thrd_routine(void *p) {
  impl_thrd_param_t *pack_p = (impl_thrd_param_t *) p;
  impl_thrd_param_t  pack;
  int                code;
  impl_current_thread.thrd              = pack_p->thrd;
  impl_current_thread.handle_need_close = 0;
  memcpy(&pack, pack_p, sizeof(impl_thrd_param_t));
  kit_alloc_dispatch(NULL, KIT_DEALLOCATE, 0, 0, p);
  code = pack.func(pack.arg);
  return (unsigned) code;
}

static time_t impl_timespec2msec(const struct timespec *ts) {
  return (ts->tv_sec * 1000U) + (ts->tv_nsec / 1000000L);
}

static DWORD impl_abs2relmsec(const struct timespec *abs_time) {
  const time_t    abs_ms = impl_timespec2msec(abs_time);
  struct timespec now;
  timespec_get(&now, TIME_UTC);
  const time_t now_ms = impl_timespec2msec(&now);
  const DWORD  rel_ms = (abs_ms > now_ms) ? (DWORD) (abs_ms - now_ms)
                                          : 0;
  return rel_ms;
}

#    ifdef EMULATED_THREADS_USE_NATIVE_CALL_ONCE
struct impl_call_once_param {
  void (*func)(void);
};

static BOOL CALLBACK impl_call_once_callback(PINIT_ONCE InitOnce,
                                             PVOID      Parameter,
                                             PVOID     *Context) {
  struct impl_call_once_param *param = (struct impl_call_once_param *)
      Parameter;
  (param->func)();
  ((void) InitOnce);
  ((void) Context); /* suppress warning */
  return TRUE;
}
#    endif /* ifdef EMULATED_THREADS_USE_NATIVE_CALL_ONCE */

void call_once(once_flag *flag, void (*func)(void)) {
  assert(flag && func);
#    ifdef EMULATED_THREADS_USE_NATIVE_CALL_ONCE
  {
    struct impl_call_once_param param;
    param.func = func;
    InitOnceExecuteOnce((PINIT_ONCE) flag, impl_call_once_callback,
                        (PVOID) &param, NULL);
  }
#    else
  if (InterlockedCompareExchangePointer(
          (PVOID volatile *) &flag->status, (PVOID) 1, (PVOID) 0) ==
      0) {
    (func)();
    InterlockedExchangePointer((PVOID volatile *) &flag->status,
                               (PVOID) 2);
  } else {
    while (flag->status == 1) {
      // busy loop!
      thrd_yield();
    }
  }
#    endif
}

int cnd_broadcast(cnd_t *cond) {
  assert(cond != NULL);
  WakeAllConditionVariable((PCONDITION_VARIABLE) cond);
  return thrd_success;
}

void cnd_destroy(cnd_t *cond) {
  assert(cond != NULL);
  /* do nothing */
  (void) cond;
}

int cnd_init(cnd_t *cond) {
  assert(cond != NULL);
  InitializeConditionVariable((PCONDITION_VARIABLE) cond);
  return thrd_success;
}

int cnd_signal(cnd_t *cond) {
  assert(cond != NULL);
  WakeConditionVariable((PCONDITION_VARIABLE) cond);
  return thrd_success;
}

int cnd_timedwait(cnd_t *cond, mtx_t *mtx,
                  const struct timespec *abs_time) {
  assert(cond != NULL);
  assert(mtx != NULL);
  assert(abs_time != NULL);
  const DWORD timeout = impl_abs2relmsec(abs_time);
  if (SleepConditionVariableCS((PCONDITION_VARIABLE) cond,
                               (PCRITICAL_SECTION) mtx, timeout))
    return thrd_success;
  return (GetLastError() == ERROR_TIMEOUT) ? thrd_timedout
                                           : thrd_error;
}

int cnd_wait(cnd_t *cond, mtx_t *mtx) {
  assert(cond != NULL);
  assert(mtx != NULL);
  SleepConditionVariableCS((PCONDITION_VARIABLE) cond,
                           (PCRITICAL_SECTION) mtx, INFINITE);
  return thrd_success;
}

void mtx_destroy(mtx_t *mtx) {
  assert(mtx);
  DeleteCriticalSection((PCRITICAL_SECTION) mtx);
}

int mtx_init(mtx_t *mtx, int type) {
  assert(mtx != NULL);
  if (type != mtx_plain && type != mtx_timed &&
      type != (mtx_plain | mtx_recursive) &&
      type != (mtx_timed | mtx_recursive))
    return thrd_error;
  InitializeCriticalSection((PCRITICAL_SECTION) mtx);
  return thrd_success;
}

int mtx_lock(mtx_t *mtx) {
  assert(mtx != NULL);
  EnterCriticalSection((PCRITICAL_SECTION) mtx);
  return thrd_success;
}

int mtx_timedlock(mtx_t *mtx, const struct timespec *ts) {
  assert(mtx != NULL);
  assert(ts != NULL);
  while (mtx_trylock(mtx) != thrd_success) {
    if (impl_abs2relmsec(ts) == 0)
      return thrd_timedout;
    /* busy loop! */
    thrd_yield();
  }
  return thrd_success;
}

int mtx_trylock(mtx_t *mtx) {
  assert(mtx != NULL);
  return TryEnterCriticalSection((PCRITICAL_SECTION) mtx)
             ? thrd_success
             : thrd_busy;
}

int mtx_unlock(mtx_t *mtx) {
  assert(mtx != NULL);
  LeaveCriticalSection((PCRITICAL_SECTION) mtx);
  return thrd_success;
}

int thrd_create_with_stack(thrd_t *thr, thrd_start_t func, void *arg,
                           ptrdiff_t const stack_size) {
  impl_thrd_param_t *pack;
  uintptr_t          handle;
  assert(thr != NULL);
  assert(stack_size >= 0 && stack_size < 0x100000000);

  pack = (impl_thrd_param_t *) kit_alloc_dispatch(
      NULL, KIT_ALLOCATE, (sizeof(impl_thrd_param_t)), 0, NULL);
  if (!pack)
    return thrd_nomem;
  pack->func = func;
  pack->arg  = arg;
  handle     = _beginthreadex(NULL, (unsigned) stack_size,
                              impl_thrd_routine, pack, CREATE_SUSPENDED,
                              NULL);
  if (handle == 0) {
    kit_alloc_dispatch(NULL, KIT_DEALLOCATE, 0, 0, pack);
    if (errno == EAGAIN || errno == EACCES)
      return thrd_nomem;
    return thrd_error;
  }
  thr->handle = (void *) handle;
  pack->thrd  = *thr;
  ResumeThread((HANDLE) handle);
  return thrd_success;
}

int thrd_create(thrd_t *thr, thrd_start_t func, void *arg) {
  return thrd_create_with_stack(thr, func, arg, 0);
}

thrd_t thrd_current(void) {
  /* GetCurrentThread() returns a pseudo-handle, which we need
   * to pass to DuplicateHandle(). Only the resulting handle can be
   * used from other threads.
   *
   * Note that neither handle can be compared to the one by
   * thread_create. Only the thread IDs - as returned by GetThreadId()
   * and GetCurrentThreadId() can be compared directly.
   *
   * Other potential solutions would be:
   * - define thrd_t as a thread Ids, but this would mean we'd need to
   * OpenThread for many operations
   * - use malloc'ed memory for thrd_t. This would imply using TLS for
   * current thread.
   *
   * Neither is particularly nice.
   *
   * Life would be much easier if C11 threads had different
   * abstractions for threads and thread IDs, just like C++11 threads
   * does...
   */
  struct thrd_state *state = &impl_current_thread;
  if (state->thrd.handle == NULL) {
    if (!DuplicateHandle(GetCurrentProcess(), GetCurrentThread(),
                         GetCurrentProcess(), &(state->thrd.handle),
                         0, FALSE, DUPLICATE_SAME_ACCESS)) {
      abort();
    }
    state->handle_need_close = 1;
  }
  return state->thrd;
}

int thrd_detach(thrd_t thr) {
  CloseHandle(thr.handle);
  return thrd_success;
}

int thrd_equal(thrd_t thr0, thrd_t thr1) {
  return GetThreadId(thr0.handle) == GetThreadId(thr1.handle);
}

_Noreturn void thrd_exit(int res) {
  _endthreadex((unsigned) res);
}

int thrd_join(thrd_t thr, int *res) {
  DWORD w, code;
  if (thr.handle == NULL) {
    return thrd_error;
  }
  w = WaitForSingleObject(thr.handle, INFINITE);
  if (w != WAIT_OBJECT_0)
    return thrd_error;
  if (res) {
    if (!GetExitCodeThread(thr.handle, &code)) {
      CloseHandle(thr.handle);
      return thrd_error;
    }
    *res = (int) code;
  }
  CloseHandle(thr.handle);
  return thrd_success;
}

int thrd_sleep(const struct timespec *time_point,
               struct timespec       *remaining) {
  (void) remaining;
  assert(time_point);
  assert(!remaining); /* not implemented */
  Sleep((DWORD) impl_timespec2msec(time_point));
  return 0;
}

void thrd_yield(void) {
  SwitchToThread();
}

#  endif
#endif