Commit | Line | Data |
---|---|---|
4513c2e9 MD |
1 | /* |
2 | * workqueue.c | |
3 | * | |
4 | * Userspace RCU library - Userspace workqeues | |
5 | * | |
6 | * Copyright (c) 2010 Paul E. McKenney <paulmck@linux.vnet.ibm.com> | |
7 | * Copyright (c) 2017 Mathieu Desnoyers <mathieu.desnoyers@efficios.com> | |
8 | * | |
9 | * This library is free software; you can redistribute it and/or | |
10 | * modify it under the terms of the GNU Lesser General Public | |
11 | * License as published by the Free Software Foundation; either | |
12 | * version 2.1 of the License, or (at your option) any later version. | |
13 | * | |
14 | * This library is distributed in the hope that it will be useful, | |
15 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
16 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
17 | * Lesser General Public License for more details. | |
18 | * | |
19 | * You should have received a copy of the GNU Lesser General Public | |
20 | * License along with this library; if not, write to the Free Software | |
21 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA | |
22 | */ | |
23 | ||
24 | #define _LGPL_SOURCE | |
25 | #define _GNU_SOURCE | |
26 | #include <stdio.h> | |
27 | #include <pthread.h> | |
28 | #include <signal.h> | |
29 | #include <assert.h> | |
30 | #include <stdlib.h> | |
31 | #include <stdint.h> | |
32 | #include <string.h> | |
33 | #include <errno.h> | |
34 | #include <poll.h> | |
35 | #include <sys/time.h> | |
36 | #include <unistd.h> | |
37 | #include <sched.h> | |
38 | ||
39 | #include "compat-getcpu.h" | |
40 | #include "urcu/wfcqueue.h" | |
4513c2e9 MD |
41 | #include "urcu-pointer.h" |
42 | #include "urcu/list.h" | |
43 | #include "urcu/futex.h" | |
44 | #include "urcu/tls-compat.h" | |
45 | #include "urcu/ref.h" | |
46 | #include "urcu-die.h" | |
47 | ||
48 | #include "workqueue.h" | |
49 | ||
50 | #define SET_AFFINITY_CHECK_PERIOD (1U << 8) /* 256 */ | |
51 | #define SET_AFFINITY_CHECK_PERIOD_MASK (SET_AFFINITY_CHECK_PERIOD - 1) | |
52 | ||
53 | /* Data structure that identifies a workqueue. */ | |
54 | ||
55 | struct urcu_workqueue { | |
56 | /* | |
57 | * We do not align head on a different cache-line than tail | |
24db930f MD |
58 | * mainly because workqueue threads use batching ("splice") to |
59 | * get an entire list of callbacks, which effectively empties | |
60 | * the queue, and requires to touch the tail anyway. | |
4513c2e9 MD |
61 | */ |
62 | struct cds_wfcq_tail cbs_tail; | |
63 | struct cds_wfcq_head cbs_head; | |
64 | unsigned long flags; | |
65 | int32_t futex; | |
66 | unsigned long qlen; /* maintained for debugging. */ | |
67 | pthread_t tid; | |
68 | int cpu_affinity; | |
69 | unsigned long loop_count; | |
70 | void *priv; | |
71 | void (*grace_period_fct)(struct urcu_workqueue *workqueue, void *priv); | |
72 | void (*initialize_worker_fct)(struct urcu_workqueue *workqueue, void *priv); | |
73 | void (*finalize_worker_fct)(struct urcu_workqueue *workqueue, void *priv); | |
74 | void (*worker_before_pause_fct)(struct urcu_workqueue *workqueue, void *priv); | |
75 | void (*worker_after_resume_fct)(struct urcu_workqueue *workqueue, void *priv); | |
76 | void (*worker_before_wait_fct)(struct urcu_workqueue *workqueue, void *priv); | |
77 | void (*worker_after_wake_up_fct)(struct urcu_workqueue *workqueue, void *priv); | |
78 | } __attribute__((aligned(CAA_CACHE_LINE_SIZE))); | |
79 | ||
80 | struct urcu_workqueue_completion { | |
81 | int barrier_count; | |
82 | int32_t futex; | |
83 | struct urcu_ref ref; | |
84 | }; | |
85 | ||
86 | struct urcu_workqueue_completion_work { | |
87 | struct urcu_work work; | |
88 | struct urcu_workqueue_completion *completion; | |
89 | }; | |
90 | ||
91 | /* | |
92 | * Periodically retry setting CPU affinity if we migrate. | |
93 | * Losing affinity can be caused by CPU hotunplug/hotplug, or by | |
94 | * cpuset(7). | |
95 | */ | |
96 | #if HAVE_SCHED_SETAFFINITY | |
97 | static int set_thread_cpu_affinity(struct urcu_workqueue *workqueue) | |
98 | { | |
99 | cpu_set_t mask; | |
100 | int ret; | |
101 | ||
102 | if (workqueue->cpu_affinity < 0) | |
103 | return 0; | |
104 | if (++workqueue->loop_count & SET_AFFINITY_CHECK_PERIOD_MASK) | |
105 | return 0; | |
106 | if (urcu_sched_getcpu() == workqueue->cpu_affinity) | |
107 | return 0; | |
108 | ||
109 | CPU_ZERO(&mask); | |
110 | CPU_SET(workqueue->cpu_affinity, &mask); | |
111 | #if SCHED_SETAFFINITY_ARGS == 2 | |
112 | ret = sched_setaffinity(0, &mask); | |
113 | #else | |
114 | ret = sched_setaffinity(0, sizeof(mask), &mask); | |
115 | #endif | |
116 | /* | |
117 | * EINVAL is fine: can be caused by hotunplugged CPUs, or by | |
118 | * cpuset(7). This is why we should always retry if we detect | |
119 | * migration. | |
120 | */ | |
121 | if (ret && errno == EINVAL) { | |
122 | ret = 0; | |
123 | errno = 0; | |
124 | } | |
125 | return ret; | |
126 | } | |
127 | #else | |
128 | static int set_thread_cpu_affinity(struct urcu_workqueue *workqueue) | |
129 | { | |
130 | return 0; | |
131 | } | |
132 | #endif | |
133 | ||
134 | static void futex_wait(int32_t *futex) | |
135 | { | |
136 | /* Read condition before read futex */ | |
137 | cmm_smp_mb(); | |
138 | if (uatomic_read(futex) != -1) | |
139 | return; | |
140 | while (futex_async(futex, FUTEX_WAIT, -1, NULL, NULL, 0)) { | |
141 | switch (errno) { | |
142 | case EWOULDBLOCK: | |
143 | /* Value already changed. */ | |
144 | return; | |
145 | case EINTR: | |
146 | /* Retry if interrupted by signal. */ | |
147 | break; /* Get out of switch. */ | |
148 | default: | |
149 | /* Unexpected error. */ | |
150 | urcu_die(errno); | |
151 | } | |
152 | } | |
153 | } | |
154 | ||
155 | static void futex_wake_up(int32_t *futex) | |
156 | { | |
157 | /* Write to condition before reading/writing futex */ | |
158 | cmm_smp_mb(); | |
159 | if (caa_unlikely(uatomic_read(futex) == -1)) { | |
160 | uatomic_set(futex, 0); | |
161 | if (futex_async(futex, FUTEX_WAKE, 1, | |
162 | NULL, NULL, 0) < 0) | |
163 | urcu_die(errno); | |
164 | } | |
165 | } | |
166 | ||
167 | /* This is the code run by each worker thread. */ | |
168 | ||
169 | static void *workqueue_thread(void *arg) | |
170 | { | |
171 | unsigned long cbcount; | |
172 | struct urcu_workqueue *workqueue = (struct urcu_workqueue *) arg; | |
173 | int rt = !!(uatomic_read(&workqueue->flags) & URCU_WORKQUEUE_RT); | |
174 | ||
175 | if (set_thread_cpu_affinity(workqueue)) | |
176 | urcu_die(errno); | |
177 | ||
178 | if (workqueue->initialize_worker_fct) | |
179 | workqueue->initialize_worker_fct(workqueue, workqueue->priv); | |
180 | ||
181 | if (!rt) { | |
182 | uatomic_dec(&workqueue->futex); | |
183 | /* Decrement futex before reading workqueue */ | |
184 | cmm_smp_mb(); | |
185 | } | |
186 | for (;;) { | |
187 | struct cds_wfcq_head cbs_tmp_head; | |
188 | struct cds_wfcq_tail cbs_tmp_tail; | |
189 | struct cds_wfcq_node *cbs, *cbs_tmp_n; | |
190 | enum cds_wfcq_ret splice_ret; | |
191 | ||
192 | if (set_thread_cpu_affinity(workqueue)) | |
193 | urcu_die(errno); | |
194 | ||
195 | if (uatomic_read(&workqueue->flags) & URCU_WORKQUEUE_PAUSE) { | |
196 | /* | |
197 | * Pause requested. Become quiescent: remove | |
198 | * ourself from all global lists, and don't | |
199 | * process any callback. The callback lists may | |
200 | * still be non-empty though. | |
201 | */ | |
202 | if (workqueue->worker_before_pause_fct) | |
203 | workqueue->worker_before_pause_fct(workqueue, workqueue->priv); | |
204 | cmm_smp_mb__before_uatomic_or(); | |
205 | uatomic_or(&workqueue->flags, URCU_WORKQUEUE_PAUSED); | |
206 | while ((uatomic_read(&workqueue->flags) & URCU_WORKQUEUE_PAUSE) != 0) | |
207 | (void) poll(NULL, 0, 1); | |
208 | uatomic_and(&workqueue->flags, ~URCU_WORKQUEUE_PAUSED); | |
209 | cmm_smp_mb__after_uatomic_and(); | |
210 | if (workqueue->worker_after_resume_fct) | |
211 | workqueue->worker_after_resume_fct(workqueue, workqueue->priv); | |
212 | } | |
213 | ||
214 | cds_wfcq_init(&cbs_tmp_head, &cbs_tmp_tail); | |
215 | splice_ret = __cds_wfcq_splice_blocking(&cbs_tmp_head, | |
216 | &cbs_tmp_tail, &workqueue->cbs_head, &workqueue->cbs_tail); | |
217 | assert(splice_ret != CDS_WFCQ_RET_WOULDBLOCK); | |
218 | assert(splice_ret != CDS_WFCQ_RET_DEST_NON_EMPTY); | |
219 | if (splice_ret != CDS_WFCQ_RET_SRC_EMPTY) { | |
220 | if (workqueue->grace_period_fct) | |
221 | workqueue->grace_period_fct(workqueue, workqueue->priv); | |
222 | cbcount = 0; | |
223 | __cds_wfcq_for_each_blocking_safe(&cbs_tmp_head, | |
224 | &cbs_tmp_tail, cbs, cbs_tmp_n) { | |
a74e6661 | 225 | struct urcu_work *uwp; |
4513c2e9 | 226 | |
a74e6661 MD |
227 | uwp = caa_container_of(cbs, |
228 | struct urcu_work, next); | |
229 | uwp->func(uwp); | |
4513c2e9 MD |
230 | cbcount++; |
231 | } | |
232 | uatomic_sub(&workqueue->qlen, cbcount); | |
233 | } | |
234 | if (uatomic_read(&workqueue->flags) & URCU_WORKQUEUE_STOP) | |
235 | break; | |
236 | if (workqueue->worker_before_wait_fct) | |
237 | workqueue->worker_before_wait_fct(workqueue, workqueue->priv); | |
238 | if (!rt) { | |
239 | if (cds_wfcq_empty(&workqueue->cbs_head, | |
240 | &workqueue->cbs_tail)) { | |
241 | futex_wait(&workqueue->futex); | |
4513c2e9 MD |
242 | uatomic_dec(&workqueue->futex); |
243 | /* | |
244 | * Decrement futex before reading | |
24db930f | 245 | * urcu_work list. |
4513c2e9 MD |
246 | */ |
247 | cmm_smp_mb(); | |
4513c2e9 MD |
248 | } |
249 | } else { | |
42d396ba JG |
250 | if (cds_wfcq_empty(&workqueue->cbs_head, |
251 | &workqueue->cbs_tail)) { | |
252 | (void) poll(NULL, 0, 10); | |
253 | } | |
4513c2e9 MD |
254 | } |
255 | if (workqueue->worker_after_wake_up_fct) | |
256 | workqueue->worker_after_wake_up_fct(workqueue, workqueue->priv); | |
257 | } | |
258 | if (!rt) { | |
259 | /* | |
24db930f | 260 | * Read urcu_work list before write futex. |
4513c2e9 MD |
261 | */ |
262 | cmm_smp_mb(); | |
263 | uatomic_set(&workqueue->futex, 0); | |
264 | } | |
265 | if (workqueue->finalize_worker_fct) | |
266 | workqueue->finalize_worker_fct(workqueue, workqueue->priv); | |
267 | return NULL; | |
268 | } | |
269 | ||
270 | struct urcu_workqueue *urcu_workqueue_create(unsigned long flags, | |
271 | int cpu_affinity, void *priv, | |
272 | void (*grace_period_fct)(struct urcu_workqueue *workqueue, void *priv), | |
273 | void (*initialize_worker_fct)(struct urcu_workqueue *workqueue, void *priv), | |
274 | void (*finalize_worker_fct)(struct urcu_workqueue *workqueue, void *priv), | |
275 | void (*worker_before_wait_fct)(struct urcu_workqueue *workqueue, void *priv), | |
276 | void (*worker_after_wake_up_fct)(struct urcu_workqueue *workqueue, void *priv), | |
277 | void (*worker_before_pause_fct)(struct urcu_workqueue *workqueue, void *priv), | |
278 | void (*worker_after_resume_fct)(struct urcu_workqueue *workqueue, void *priv)) | |
279 | { | |
280 | struct urcu_workqueue *workqueue; | |
281 | int ret; | |
282 | ||
283 | workqueue = malloc(sizeof(*workqueue)); | |
284 | if (workqueue == NULL) | |
285 | urcu_die(errno); | |
286 | memset(workqueue, '\0', sizeof(*workqueue)); | |
287 | cds_wfcq_init(&workqueue->cbs_head, &workqueue->cbs_tail); | |
288 | workqueue->qlen = 0; | |
289 | workqueue->futex = 0; | |
290 | workqueue->flags = flags; | |
291 | workqueue->priv = priv; | |
292 | workqueue->grace_period_fct = grace_period_fct; | |
293 | workqueue->initialize_worker_fct = initialize_worker_fct; | |
294 | workqueue->finalize_worker_fct = finalize_worker_fct; | |
295 | workqueue->worker_before_wait_fct = worker_before_wait_fct; | |
296 | workqueue->worker_after_wake_up_fct = worker_after_wake_up_fct; | |
297 | workqueue->worker_before_pause_fct = worker_before_pause_fct; | |
298 | workqueue->worker_after_resume_fct = worker_after_resume_fct; | |
299 | workqueue->cpu_affinity = cpu_affinity; | |
300 | workqueue->loop_count = 0; | |
301 | cmm_smp_mb(); /* Structure initialized before pointer is planted. */ | |
302 | ret = pthread_create(&workqueue->tid, NULL, workqueue_thread, workqueue); | |
303 | if (ret) { | |
304 | urcu_die(ret); | |
305 | } | |
306 | return workqueue; | |
307 | } | |
308 | ||
309 | static void wake_worker_thread(struct urcu_workqueue *workqueue) | |
310 | { | |
c289a62b | 311 | if (!(_CMM_LOAD_SHARED(workqueue->flags) & URCU_WORKQUEUE_RT)) |
4513c2e9 MD |
312 | futex_wake_up(&workqueue->futex); |
313 | } | |
314 | ||
315 | static int urcu_workqueue_destroy_worker(struct urcu_workqueue *workqueue) | |
316 | { | |
317 | int ret; | |
318 | void *retval; | |
319 | ||
320 | uatomic_or(&workqueue->flags, URCU_WORKQUEUE_STOP); | |
321 | wake_worker_thread(workqueue); | |
322 | ||
323 | ret = pthread_join(workqueue->tid, &retval); | |
324 | if (ret) { | |
325 | urcu_die(ret); | |
326 | } | |
327 | if (retval != NULL) { | |
328 | urcu_die(EINVAL); | |
329 | } | |
330 | workqueue->flags &= ~URCU_WORKQUEUE_STOP; | |
331 | workqueue->tid = 0; | |
332 | return 0; | |
333 | } | |
334 | ||
335 | void urcu_workqueue_destroy(struct urcu_workqueue *workqueue) | |
336 | { | |
337 | if (workqueue == NULL) { | |
338 | return; | |
339 | } | |
340 | if (urcu_workqueue_destroy_worker(workqueue)) { | |
341 | urcu_die(errno); | |
342 | } | |
343 | assert(cds_wfcq_empty(&workqueue->cbs_head, &workqueue->cbs_tail)); | |
344 | free(workqueue); | |
345 | } | |
346 | ||
347 | void urcu_workqueue_queue_work(struct urcu_workqueue *workqueue, | |
348 | struct urcu_work *work, | |
349 | void (*func)(struct urcu_work *work)) | |
350 | { | |
351 | cds_wfcq_node_init(&work->next); | |
352 | work->func = func; | |
353 | cds_wfcq_enqueue(&workqueue->cbs_head, &workqueue->cbs_tail, &work->next); | |
354 | uatomic_inc(&workqueue->qlen); | |
355 | wake_worker_thread(workqueue); | |
356 | } | |
357 | ||
358 | static | |
359 | void free_completion(struct urcu_ref *ref) | |
360 | { | |
361 | struct urcu_workqueue_completion *completion; | |
362 | ||
363 | completion = caa_container_of(ref, struct urcu_workqueue_completion, ref); | |
364 | free(completion); | |
365 | } | |
366 | ||
367 | static | |
368 | void _urcu_workqueue_wait_complete(struct urcu_work *work) | |
369 | { | |
370 | struct urcu_workqueue_completion_work *completion_work; | |
371 | struct urcu_workqueue_completion *completion; | |
372 | ||
373 | completion_work = caa_container_of(work, struct urcu_workqueue_completion_work, work); | |
374 | completion = completion_work->completion; | |
375 | if (!uatomic_sub_return(&completion->barrier_count, 1)) | |
376 | futex_wake_up(&completion->futex); | |
377 | urcu_ref_put(&completion->ref, free_completion); | |
378 | free(completion_work); | |
379 | } | |
380 | ||
381 | struct urcu_workqueue_completion *urcu_workqueue_create_completion(void) | |
382 | { | |
383 | struct urcu_workqueue_completion *completion; | |
384 | ||
385 | completion = calloc(sizeof(*completion), 1); | |
386 | if (!completion) | |
387 | urcu_die(errno); | |
388 | urcu_ref_set(&completion->ref, 1); | |
389 | completion->barrier_count = 0; | |
390 | return completion; | |
391 | } | |
392 | ||
393 | void urcu_workqueue_destroy_completion(struct urcu_workqueue_completion *completion) | |
394 | { | |
395 | urcu_ref_put(&completion->ref, free_completion); | |
396 | } | |
397 | ||
398 | void urcu_workqueue_wait_completion(struct urcu_workqueue_completion *completion) | |
399 | { | |
400 | /* Wait for them */ | |
401 | for (;;) { | |
402 | uatomic_dec(&completion->futex); | |
403 | /* Decrement futex before reading barrier_count */ | |
404 | cmm_smp_mb(); | |
405 | if (!uatomic_read(&completion->barrier_count)) | |
406 | break; | |
407 | futex_wait(&completion->futex); | |
408 | } | |
409 | } | |
410 | ||
411 | void urcu_workqueue_queue_completion(struct urcu_workqueue *workqueue, | |
412 | struct urcu_workqueue_completion *completion) | |
413 | { | |
414 | struct urcu_workqueue_completion_work *work; | |
415 | ||
416 | work = calloc(sizeof(*work), 1); | |
417 | if (!work) | |
418 | urcu_die(errno); | |
419 | work->completion = completion; | |
420 | urcu_ref_get(&completion->ref); | |
421 | uatomic_inc(&completion->barrier_count); | |
422 | urcu_workqueue_queue_work(workqueue, &work->work, _urcu_workqueue_wait_complete); | |
423 | } | |
424 | ||
425 | /* | |
426 | * Wait for all in-flight work to complete execution. | |
427 | */ | |
428 | void urcu_workqueue_flush_queued_work(struct urcu_workqueue *workqueue) | |
429 | { | |
430 | struct urcu_workqueue_completion *completion; | |
431 | ||
432 | completion = urcu_workqueue_create_completion(); | |
433 | if (!completion) | |
434 | urcu_die(ENOMEM); | |
435 | urcu_workqueue_queue_completion(workqueue, completion); | |
436 | urcu_workqueue_wait_completion(completion); | |
437 | urcu_workqueue_destroy_completion(completion); | |
438 | } | |
439 | ||
440 | /* To be used in before fork handler. */ | |
441 | void urcu_workqueue_pause_worker(struct urcu_workqueue *workqueue) | |
442 | { | |
443 | uatomic_or(&workqueue->flags, URCU_WORKQUEUE_PAUSE); | |
444 | cmm_smp_mb__after_uatomic_or(); | |
445 | wake_worker_thread(workqueue); | |
446 | ||
447 | while ((uatomic_read(&workqueue->flags) & URCU_WORKQUEUE_PAUSED) == 0) | |
448 | (void) poll(NULL, 0, 1); | |
449 | } | |
450 | ||
451 | /* To be used in after fork parent handler. */ | |
452 | void urcu_workqueue_resume_worker(struct urcu_workqueue *workqueue) | |
453 | { | |
454 | uatomic_and(&workqueue->flags, ~URCU_WORKQUEUE_PAUSE); | |
455 | while ((uatomic_read(&workqueue->flags) & URCU_WORKQUEUE_PAUSED) != 0) | |
456 | (void) poll(NULL, 0, 1); | |
457 | } | |
458 | ||
459 | void urcu_workqueue_create_worker(struct urcu_workqueue *workqueue) | |
460 | { | |
461 | int ret; | |
462 | ||
463 | /* Clear workqueue state from parent. */ | |
464 | workqueue->flags &= ~URCU_WORKQUEUE_PAUSED; | |
465 | workqueue->flags &= ~URCU_WORKQUEUE_PAUSE; | |
466 | workqueue->tid = 0; | |
467 | ret = pthread_create(&workqueue->tid, NULL, workqueue_thread, workqueue); | |
468 | if (ret) { | |
469 | urcu_die(ret); | |
470 | } | |
471 | } |