summaryrefslogtreecommitdiffstats
path: root/libdimension/progress.c
blob: 29469a6edbfe7151bc09865bcfb4e2de7f579f71 (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
/*************************************************************************
 * Copyright (C) 2008 Tavian Barnes <tavianator@gmail.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/>.                                       *
 *************************************************************************/

#include "dimension.h"
#include <pthread.h>
#include <stdlib.h> /* For malloc */

/* Allocate a new dmnsn_progress*, returning NULL on failure */
dmnsn_progress *
dmnsn_new_progress()
{
  dmnsn_progress_element element = { .progress = 0, .total = 1 };
  dmnsn_progress *progress = malloc(sizeof(dmnsn_progress));
  if (progress) {
    progress->elements = dmnsn_new_array(sizeof(dmnsn_progress_element));
    dmnsn_array_push(progress->elements, &element);

    progress->cond = malloc(sizeof(pthread_cond_t));
    if (!progress->cond) {
      dmnsn_delete_array(progress->elements);
      free(progress);
      return NULL;
    }

    progress->mutex = malloc(sizeof(pthread_mutex_t));
    if (!progress->mutex) {
      free(progress->cond);
      dmnsn_delete_array(progress->elements);
      free(progress);
      return NULL;
    }

    if (pthread_cond_init(progress->cond, NULL) != 0) {
      free(progress->mutex);
      free(progress->cond);
      dmnsn_delete_array(progress->elements);
      free(progress);
      return NULL;
    }
    if (pthread_mutex_init(progress->mutex, NULL) != 0) {
      if (pthread_cond_destroy(progress->cond) != 0) {
        dmnsn_error(DMNSN_SEVERITY_LOW,
                    "Leaking condition variable in failed allocation.");
      }
      free(progress->mutex);
      free(progress->cond);
      dmnsn_delete_array(progress->elements);
      free(progress);
      return NULL;
    }
  }
  return progress;
}

/* Delete a dmnsn_progress*, which has not yet been associated with a thread;
   mostly for failed returns from *_async() functions. */
void
dmnsn_delete_progress(dmnsn_progress *progress)
{
  if (progress) {
    if (pthread_mutex_destroy(progress->mutex) != 0) {
      dmnsn_error(DMNSN_SEVERITY_LOW, "Leaking mutex.");
    }
    if (pthread_cond_destroy(progress->cond) != 0) {
      dmnsn_error(DMNSN_SEVERITY_LOW, "Leaking condition variable.");
    }

    free(progress->mutex);
    free(progress->cond);
    dmnsn_delete_array(progress->elements);
    free(progress);
  }
}

/* Join the worker thread and delete `progress'. */
int dmnsn_finish_progress(dmnsn_progress *progress)
{
  void *ptr;
  int retval = 1;

  if (progress) {
    if (pthread_cond_broadcast(progress->cond) != 0) {
      dmnsn_error(DMNSN_SEVERITY_MEDIUM, "Couldn't signal condition variable.");
    }

    if (pthread_join(progress->thread, &ptr) != 0) {
      /* Medium severity because an unjoined thread likely means that the thread
         is incomplete or invalid */
      dmnsn_error(DMNSN_SEVERITY_MEDIUM, "Joining worker thread failed.");
    } else if (ptr) {
      retval = *(int *)ptr;
      free(ptr);
    }
    dmnsn_delete_progress(progress);
  }

  return retval;
}

/* Get the current progress of the worker thread, in [0.0, 1.0] */
double
dmnsn_get_progress(const dmnsn_progress *progress)
{
  dmnsn_progress_element *element;
  double prog = 0.0;
  unsigned int i, size;

  dmnsn_array_rdlock(progress->elements);
    size = dmnsn_array_size_unlocked(progress->elements);
    for (i = 0; i < size; ++i) {
      element = dmnsn_array_at(progress->elements, size - i - 1);
      prog += element->progress;
      prog /= element->total;
    }
  dmnsn_array_unlock(progress->elements);

  return prog;
}

/* Wait until dmnsn_get_progress(progress) >= prog */
void
dmnsn_wait_progress(const dmnsn_progress *progress, double prog)
{
  if (pthread_mutex_lock(progress->mutex) != 0) {
    dmnsn_error(DMNSN_SEVERITY_MEDIUM, "Couldn't lock condition mutex.");
  }

  while (dmnsn_get_progress(progress) < prog) {
    if (pthread_cond_wait(progress->cond, progress->mutex) != 0) {
      dmnsn_error(DMNSN_SEVERITY_MEDIUM,
                  "Couldn't wait on condition variable.");
    }
  }

  if (pthread_mutex_unlock(progress->mutex) != 0) {
    dmnsn_error(DMNSN_SEVERITY_MEDIUM, "Couldn't unlock condition mutex.");
  }
}

/* A new level of algorithmic nesting */
void
dmnsn_new_progress_element(dmnsn_progress *progress, unsigned int total)
{
  dmnsn_progress_element element = { .progress = 0, .total = total };
  dmnsn_array_push(progress->elements, &element);
}

/* Only the innermost loop needs to call this function - it handles the rest
   upon loop completion (progress == total) */
void
dmnsn_increment_progress(dmnsn_progress *progress)
{
  dmnsn_progress_element *element;
  size_t size;

  dmnsn_array_wrlock(progress->elements);
    size = dmnsn_array_size_unlocked(progress->elements);
    element = dmnsn_array_at(progress->elements, size - 1);
    ++element->progress;

    while (element->progress >= element->total && size > 1) {
      --size;
      dmnsn_array_resize_unlocked(progress->elements, size);
      element = dmnsn_array_at(progress->elements, size - 1);
      ++element->progress;
    }

    if (pthread_cond_broadcast(progress->cond) != 0) {
      dmnsn_error(DMNSN_SEVERITY_MEDIUM, "Couldn't signal condition variable.");
    }
  dmnsn_array_unlock(progress->elements);
}

/* Immediately set to 100% completion */
void
dmnsn_progress_done(dmnsn_progress *progress)
{
  dmnsn_progress_element *element;

  dmnsn_array_wrlock(progress->elements);
    dmnsn_array_resize_unlocked(progress->elements, 1);
    element = dmnsn_array_at(progress->elements, 0);
    element->progress = element->total;

    if (pthread_cond_broadcast(progress->cond) != 0) {
      dmnsn_error(DMNSN_SEVERITY_MEDIUM, "Couldn't signal condition variable.");
    }
  dmnsn_array_unlock(progress->elements);
}