summaryrefslogtreecommitdiffstats
path: root/libdimension/future.c
blob: 622d40e28af95d7d7a4eac9afafc5b9cbdead09b (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
/*************************************************************************
 * Copyright (C) 2009-2014 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
 * Future objects.
 */

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

/**
 * Since C doesn't support anything like C++'s mutable, we fake it by casting
 * away the constness.  This is okay since all valid dmnsn_futures live on the
 * heap, so cannot be const.
 */
#define MUTATE(future) ((dmnsn_future *)(future))

/* Allocate a new dmnsn_future* */
dmnsn_future *
dmnsn_new_future(void)
{
  dmnsn_future *future = dmnsn_malloc(sizeof(dmnsn_future));
  future->progress = 0;
  future->total    = 1;

  dmnsn_initialize_mutex(&future->mutex);
  dmnsn_initialize_cond(&future->cond);

  future->min_wait = 1.0;

  future->nthreads = future->nrunning = 1;
  future->npaused = 0;
  dmnsn_initialize_cond(&future->none_running_cond);
  dmnsn_initialize_cond(&future->all_running_cond);
  dmnsn_initialize_cond(&future->resume_cond);

  return future;
}

/* Join the worker thread and delete `future'. */
int
dmnsn_future_join(dmnsn_future *future)
{
  void *ptr;
  int retval = -1;

  if (future) {
    /* Get the thread's return value */
    dmnsn_join_thread(future->thread, &ptr);
    if (ptr && ptr != PTHREAD_CANCELED) {
      retval = *(int *)ptr;
      dmnsn_free(ptr);
    }

    /* Free the future object */
    dmnsn_destroy_cond(&future->resume_cond);
    dmnsn_destroy_cond(&future->all_running_cond);
    dmnsn_destroy_cond(&future->none_running_cond);
    dmnsn_destroy_cond(&future->cond);
    dmnsn_destroy_mutex(&future->mutex);
    dmnsn_free(future);
  }

  return retval;
}

/* Cancel a background thread */
void
dmnsn_future_cancel(dmnsn_future *future)
{
  pthread_cancel(future->thread);
}

/**
 * Get the current progress, without locking anything.
 *
 * future->mutex must be locked for this call to be safe.
 */
static inline double
dmnsn_future_progress_unlocked(const dmnsn_future *future)
{
  return (double)future->progress/future->total;
}

/* Get the current progress of the worker thread, in [0.0, 1.0] */
double
dmnsn_future_progress(const dmnsn_future *future)
{
  dmnsn_future *mfuture = MUTATE(future);
  double progress;

  dmnsn_lock_mutex(&mfuture->mutex);
    progress = dmnsn_future_progress_unlocked(mfuture);
  dmnsn_unlock_mutex(&mfuture->mutex);

  return progress;
}

/* Find out whether the task is complete. */
bool
dmnsn_future_is_done(const dmnsn_future *future)
{
  dmnsn_future *mfuture = MUTATE(future);
  bool result;

  dmnsn_lock_mutex(&mfuture->mutex);
    result = future->progress == future->total;
  dmnsn_unlock_mutex(&mfuture->mutex);

  return result;
}

/* Wait until dmnsn_future_progress(future) >= progress */
void
dmnsn_future_wait(const dmnsn_future *future, double progress)
{
  dmnsn_future *mfuture = MUTATE(future);

  dmnsn_lock_mutex(&mfuture->mutex);
    while (dmnsn_future_progress_unlocked(mfuture) < progress) {
      /* Set the minimum waited-on value */
      if (progress < mfuture->min_wait) {
        mfuture->min_wait = progress;
      }

      dmnsn_cond_wait_safely(&mfuture->cond, &mfuture->mutex);
    }
  dmnsn_unlock_mutex(&mfuture->mutex);
}

/* Pause all threads working on a future. */
void
dmnsn_future_pause(dmnsn_future *future)
{
  dmnsn_lock_mutex(&future->mutex);
    while (future->nrunning < future->nthreads) {
      dmnsn_cond_wait_safely(&future->all_running_cond, &future->mutex);
    }
    if (future->npaused++ == 0) {
      while (future->nrunning > 0) {
        dmnsn_cond_wait_safely(&future->none_running_cond, &future->mutex);
      }
    }
  dmnsn_unlock_mutex(&future->mutex);
}

/* Resume all threads working on a future. */
void
dmnsn_future_resume(dmnsn_future *future)
{
  dmnsn_lock_mutex(&future->mutex);
    dmnsn_assert(future->npaused > 0,
                 "dmnsn_future_resume() without matching dmnsn_future_pause()");
    if (--future->npaused == 0) {
      dmnsn_cond_broadcast(&future->resume_cond);
    }
  dmnsn_unlock_mutex(&future->mutex);
}

/* Set the total number of loop iterations */
void
dmnsn_future_set_total(dmnsn_future *future, size_t total)
{
  dmnsn_lock_mutex(&future->mutex);
    future->total = total;
  dmnsn_unlock_mutex(&future->mutex);
}

static void
dmnsn_future_increment_cleanup(void *ptr)
{
  dmnsn_future *future = ptr;
  ++future->nrunning;
  dmnsn_unlock_mutex_impl(&future->mutex);
}

/* Increment the number of completed loop iterations */
void
dmnsn_future_increment(dmnsn_future *future)
{
  /* Allow a thread to be canceled whenever it increments a future object --
     this is close to PTHREAD_CANCEL_ASYNCHRONOUS but allows consistent state
     on cancellation */
  pthread_testcancel();

  dmnsn_lock_mutex(&future->mutex);
    ++future->progress;

    if (dmnsn_future_progress_unlocked(future) >= future->min_wait) {
      future->min_wait = 1.0;
      dmnsn_cond_broadcast(&future->cond);
    }

    if (future->npaused > 0) {
      dmnsn_assert(future->nrunning > 0, "More worker threads than expected");

      if (--future->nrunning == 0) {
        dmnsn_cond_broadcast(&future->none_running_cond);
      }

      pthread_cleanup_push(dmnsn_future_increment_cleanup, future);
        do {
          dmnsn_cond_wait(&future->resume_cond, &future->mutex);
        } while (future->npaused > 0);
      pthread_cleanup_pop(false);

      if (++future->nrunning == future->nthreads) {
        dmnsn_cond_broadcast(&future->all_running_cond);
      }
    }
  dmnsn_unlock_mutex(&future->mutex);
}

/* Immediately set to 100% completion */
void
dmnsn_future_finish(dmnsn_future *future)
{
  dmnsn_lock_mutex(&future->mutex);
    future->progress = future->total;
    future->nthreads = future->nrunning = 0;
    dmnsn_cond_broadcast(&future->cond);
    dmnsn_cond_broadcast(&future->none_running_cond);
    dmnsn_cond_broadcast(&future->all_running_cond);
  dmnsn_unlock_mutex(&future->mutex);
}

/* Set the number of threads */
void
dmnsn_future_set_nthreads(dmnsn_future *future, unsigned int nthreads)
{
  dmnsn_lock_mutex(&future->mutex);
    dmnsn_assert(future->nrunning == future->nthreads,
                 "dmnsn_future_set_nthreads() called with paused threads");
    future->nthreads = future->nrunning = nthreads;
  dmnsn_unlock_mutex(&future->mutex);
}

/* Notify completion of a worker thread */
void
dmnsn_future_finish_thread(dmnsn_future *future)
{
  dmnsn_lock_mutex(&future->mutex);
    dmnsn_assert(future->nthreads > 0,
                 "dmnsn_future_finish_thread() called with no threads");
    --future->nthreads;

    dmnsn_assert(future->nrunning > 0,
                 "dmnsn_future_finish_thread() called with no running threads");
    if (--future->nrunning == 0) {
      dmnsn_cond_broadcast(&future->none_running_cond);
    }
  dmnsn_unlock_mutex(&future->mutex);
}