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
|
/*
* thread-pool.c
*
* A thread pool implementation
*
* Copyright © 2012 Deutsches Elektronen-Synchrotron DESY,
* a research centre of the Helmholtz Association.
*
* Authors:
* 2010-2012 Thomas White <taw@physics.org>
*
* This file is part of CrystFEL.
*
* CrystFEL is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* CrystFEL 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with CrystFEL. If not, see <http://www.gnu.org/licenses/>.
*
*/
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include <stdarg.h>
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <unistd.h>
#include <pthread.h>
#include <assert.h>
#include "utils.h"
/**
* SECTION:thread-pool
* @short_description: The thread pool
* @title: The thread pool
* @section_id:
* @see_also:
* @include: "thread-pool.h"
* @Image:
*
* The thread pool helps when running many tasks in parallel. It takes care of
* starting and stopping threads, and presents a relatively simple interface to
* the individual programs.
*/
/* --------------------------- Status label stuff --------------------------- */
static int use_status_labels = 0;
static pthread_key_t status_label_key;
pthread_mutex_t stderr_lock = PTHREAD_MUTEX_INITIALIZER;
struct worker_args
{
struct task_queue_range *tqr;
struct task_queue *tq;
int id;
};
signed int get_status_label()
{
int *cookie;
if ( !use_status_labels ) {
return -1;
}
cookie = pthread_getspecific(status_label_key);
return *cookie;
}
struct task_queue
{
pthread_mutex_t lock;
int n_started;
int n_completed;
int max;
void *(*get_task)(void *);
void (*finalise)(void *, void *);
void *queue_args;
void (*work)(void *, int);
};
static void *task_worker(void *pargsv)
{
struct worker_args *w = pargsv;
struct task_queue *q = w->tq;
int *cookie;
cookie = malloc(sizeof(int));
*cookie = w->id;
pthread_setspecific(status_label_key, cookie);
free(w);
do {
void *task;
int cookie;
/* Get a task */
pthread_mutex_lock(&q->lock);
if ( (q->max) && (q->n_started >= q->max) ) {
pthread_mutex_unlock(&q->lock);
break;
}
task = q->get_task(q->queue_args);
/* No more tasks? */
if ( task == NULL ) {
pthread_mutex_unlock(&q->lock);
break;
}
q->n_started++;
pthread_mutex_unlock(&q->lock);
cookie = *(int *)pthread_getspecific(status_label_key);
q->work(task, cookie);
/* Update totals etc */
pthread_mutex_lock(&q->lock);
q->n_completed++;
if ( q->finalise ) {
q->finalise(q->queue_args, task);
}
pthread_mutex_unlock(&q->lock);
} while ( 1 );
free(cookie);
return NULL;
}
/**
* run_threads:
* @n_threads: The number of threads to run in parallel
* @work: The function to be called to do the work
* @get_task: The function which will determine the next unassigned task
* @final: The function which will be called to clean up after a task
* @queue_args: A pointer to any data required to determine the next task
* @max: Stop calling get_task after starting this number of jobs
* @cpu_num: Ignored
* @cpu_groupsize: Ignored
* @cpu_offset: Ignored
*
* 'get_task' will be called every time a worker is idle. It returns either
* NULL, indicating that no further work is available, or a pointer which will
* be passed to 'work'.
*
* 'final' will be called once per image, and will be given both queue_args
* and the last task pointer.
*
* 'get_task' and 'final' will be called only under lock, and so do NOT need to
* be re-entrant or otherwise thread safe. 'work', of course, needs to be
* thread safe.
*
* Work will stop after 'max' tasks have been processed whether get_task
* returned NULL or not. If "max" is zero, all tasks will be processed.
*
* Returns: The number of tasks completed.
**/
int run_threads(int n_threads, TPWorkFunc work,
TPGetTaskFunc get_task, TPFinalFunc final,
void *queue_args, int max,
int cpu_num, int cpu_groupsize, int cpu_offset)
{
pthread_t *workers;
int i;
struct task_queue q;
pthread_key_create(&status_label_key, NULL);
workers = malloc(n_threads * sizeof(pthread_t));
pthread_mutex_init(&q.lock, NULL);
q.work = work;
q.get_task = get_task;
q.finalise = final;
q.queue_args = queue_args;
q.n_started = 0;
q.n_completed = 0;
q.max = max;
/* Now it's safe to start using the status labels */
if ( n_threads > 1 ) use_status_labels = 1;
/* Start threads */
for ( i=0; i<n_threads; i++ ) {
struct worker_args *w;
w = malloc(sizeof(struct worker_args));
w->tq = &q;
w->tqr = NULL;
w->id = i;
if ( pthread_create(&workers[i], NULL, task_worker, w) ) {
/* Not ERROR() here */
fprintf(stderr, "Couldn't start thread %i\n", i);
n_threads = i;
break;
}
}
/* Join threads */
for ( i=0; i<n_threads; i++ ) {
pthread_join(workers[i], NULL);
}
use_status_labels = 0;
free(workers);
return q.n_completed;
}
|
