summaryrefslogtreecommitdiffstats
path: root/libdimension/threads.c
blob: 2200671cf6f601ffdb660ea3dae07f0fc6754765 (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
/*************************************************************************
 * Copyright (C) 2010-2011 Tavian Barnes <tavianator@tavianator.com>     *
 *                                                                       *
 * This file is part of The Dimension Library.                           *
 *                                                                       *
 * The Dimension Library is free software; you can redistribute it and/  *
 * or modify it under the terms of the GNU Lesser General Public License *
 * as published by the Free Software Foundation; either version 3 of the *
 * License, or (at your option) any later version.                       *
 *                                                                       *
 * The Dimension Library is distributed in the hope that it will be      *
 * useful, but WITHOUT ANY WARRANTY; without even the implied warranty   *
 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU  *
 * Lesser General Public License for more details.                       *
 *                                                                       *
 * You should have received a copy of the GNU Lesser General Public      *
 * License along with this program.  If not, see                         *
 * <http://www.gnu.org/licenses/>.                                       *
 *************************************************************************/

/**
 * @file
 * Background threading.
 */

#include "dimension-internal.h"
#include <pthread.h>

/** The payload to pass to the pthread callback. */
typedef struct dmnsn_thread_payload {
  dmnsn_thread_fn *thread_fn;
  void *arg;
  dmnsn_progress *progress;
} dmnsn_thread_payload;

/** Clean up after a thread. */
static void
dmnsn_thread_cleanup(void *arg)
{
  dmnsn_thread_payload *payload = arg;
  dmnsn_progress *progress = payload->progress;
  dmnsn_free(payload);

  dmnsn_done_progress(progress);
}

/** pthread callback -- call the real thread callback. */
static void *
dmnsn_thread(void *arg)
{
  dmnsn_thread_payload *payload = arg;
  int *ret;

  pthread_cleanup_push(dmnsn_thread_cleanup, payload);
    ret  = dmnsn_malloc(sizeof(int));
    *ret = payload->thread_fn(payload->arg);
  pthread_cleanup_pop(true);
  return ret;
}

void
dmnsn_new_thread(dmnsn_progress *progress, dmnsn_thread_fn *thread_fn,
                 void *arg)
{
  dmnsn_thread_payload *payload = dmnsn_malloc(sizeof(dmnsn_thread_payload));
  payload->thread_fn = thread_fn;
  payload->arg       = arg;
  payload->progress  = progress;

  if (pthread_create(&progress->thread, NULL, dmnsn_thread, payload) != 0) {
    dmnsn_error("Couldn't start thread.");
  }
}

/** Payload for threads executed by dmnsn_execute_concurrently(). */
typedef struct dmnsn_ccthread_payload {
  dmnsn_ccthread_fn *ccthread_fn;
  void *arg;
  unsigned int thread, nthreads;
  int ret;
  bool started;
} dmnsn_ccthread_payload;

static void *
dmnsn_concurrent_thread(void *ptr)
{
  dmnsn_ccthread_payload *payload = ptr;
  payload->ret = payload->ccthread_fn(payload->arg, payload->thread,
                                      payload->nthreads);
  return NULL;
}

typedef struct dmnsn_ccthread_cleanup_payload {
  pthread_t *threads;
  dmnsn_ccthread_payload *payloads;
  unsigned int nthreads;
} dmnsn_ccthread_cleanup_payload;

static void
dmnsn_ccthread_cleanup(void *ptr)
{
  dmnsn_ccthread_cleanup_payload *payload = ptr;

  for (unsigned int i = 0; i < payload->nthreads; ++i) {
    if (payload->payloads[i].started) {
      pthread_cancel(payload->threads[i]);
    }
  }

  for (unsigned int i = 0; i < payload->nthreads; ++i) {
    if (payload->payloads[i].started) {
      dmnsn_join_thread(payload->threads[i], NULL);
    }
  }
}

int
dmnsn_execute_concurrently(dmnsn_ccthread_fn *ccthread_fn,
                           void *arg, unsigned int nthreads)
{
  dmnsn_assert(nthreads > 0, "Attempt to execute using 0 concurrent threads.");

  pthread_t threads[nthreads];
  dmnsn_ccthread_payload payloads[nthreads];
  for (unsigned int i = 0; i < nthreads; ++i) {
    payloads[i].started = false;
  }

  int ret = 0;
  dmnsn_ccthread_cleanup_payload cleanup_payload = {
    .threads = threads,
    .payloads = payloads,
    .nthreads = nthreads,
  };
  pthread_cleanup_push(dmnsn_ccthread_cleanup, &cleanup_payload);
    for (unsigned int i = 0; i < nthreads; ++i) {
      payloads[i].ccthread_fn = ccthread_fn;
      payloads[i].arg         = arg;
      payloads[i].thread      = i;
      payloads[i].nthreads    = nthreads;
      payloads[i].ret         = -1;
      if (pthread_create(&threads[i], NULL, dmnsn_concurrent_thread,
                         &payloads[i]) != 0)
      {
        dmnsn_error("Couldn't start worker thread.");
      }
      payloads[i].started = true;
    }

    for (unsigned int i = 0; i < nthreads; ++i) {
      dmnsn_join_thread(threads[i], NULL);
      payloads[i].started = false;
      if (payloads[i].ret != 0) {
        ret = payloads[i].ret;
      }
    }
  pthread_cleanup_pop(false);

  return ret;
}

/* pthread wrappers */

void
dmnsn_initialize_mutex(pthread_mutex_t *mutex)
{
  if (pthread_mutex_init(mutex, NULL) != 0) {
    dmnsn_error("Couldn't initialize mutex.");
  }
}

void
dmnsn_lock_mutex_impl(pthread_mutex_t *mutex)
{
  if (pthread_mutex_lock(mutex) != 0) {
    dmnsn_error("Couldn't lock mutex.");
  }
}

void
dmnsn_unlock_mutex_impl(pthread_mutex_t *mutex)
{
  if (pthread_mutex_unlock(mutex) != 0) {
    dmnsn_error("Couldn't unlock mutex.");
  }
}

void
dmnsn_destroy_mutex(pthread_mutex_t *mutex)
{
  if (pthread_mutex_destroy(mutex) != 0) {
    dmnsn_warning("Couldn't destroy mutex.");
  }
}

void
dmnsn_initialize_rwlock(pthread_rwlock_t *rwlock)
{
  if (pthread_rwlock_init(rwlock, NULL) != 0) {
    dmnsn_error("Couldn't initialize read-write lock.");
  }
}

void
dmnsn_read_lock_impl(pthread_rwlock_t *rwlock)
{
  if (pthread_rwlock_rdlock(rwlock) != 0) {
    dmnsn_error("Couldn't acquire read lock.");
  }
}

void
dmnsn_write_lock_impl(pthread_rwlock_t *rwlock)
{
  if (pthread_rwlock_wrlock(rwlock) != 0) {
    dmnsn_error("Couldn't acquire write lock.");
  }
}

void
dmnsn_unlock_rwlock_impl(pthread_rwlock_t *rwlock)
{
  if (pthread_rwlock_unlock(rwlock) != 0) {
    dmnsn_error("Couldn't unlock read-write lock.");
  }
}

void
dmnsn_destroy_rwlock(pthread_rwlock_t *rwlock)
{
  if (pthread_rwlock_destroy(rwlock) != 0) {
    dmnsn_warning("Couldn't destroy read-write lock.");
  }
}

void
dmnsn_initialize_cond(pthread_cond_t *cond)
{
  if (pthread_cond_init(cond, NULL) != 0) {
    dmnsn_error("Couldn't initialize condition variable.");
  }
}

void
dmnsn_cond_wait(pthread_cond_t *cond, pthread_mutex_t *mutex)
{
  if (pthread_cond_wait(cond, mutex) != 0) {
    dmnsn_error("Couldn't wait on condition variable.");
  }
}

void
dmnsn_cond_broadcast(pthread_cond_t *cond)
{
  if (pthread_cond_broadcast(cond) != 0) {
    dmnsn_error("Couldn't signal condition variable.");
  }
}

void
dmnsn_destroy_cond(pthread_cond_t *cond)
{
  if (pthread_cond_destroy(cond) != 0) {
    dmnsn_warning("Couldn't destroy condition variable.");
  }
}

void
dmnsn_once(pthread_once_t *once, dmnsn_once_fn *once_fn)
{
  if (pthread_once(once, once_fn) != 0) {
    dmnsn_error("Couldn't call one-shot function.");
  }
}

void
dmnsn_key_create(pthread_key_t *key, dmnsn_callback_fn *destructor)
{
  if (pthread_key_create(key, destructor) != 0) {
    dmnsn_error("Couldn't initialize thread-specific pointer.");
  }
}

void
dmnsn_setspecific(pthread_key_t key, const void *value)
{
  if (pthread_setspecific(key, value) != 0) {
    dmnsn_error("Couldn't set thread-specific pointer.");
  }
}

void
dmnsn_key_delete(pthread_key_t key)
{
  if (pthread_key_delete(key) != 0) {
    dmnsn_warning("Couldn't destroy thread-specific pointer.");
  }
}

void
dmnsn_join_thread(pthread_t thread, void **retval)
{
  if (pthread_join(thread, retval) != 0) {
    dmnsn_error("Couldn't join thread.");
  }
}