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
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
|
/* SPDX-License-Identifier: GPL-2.0-or-later
* Copyright 2009 Blender Foundation. All rights reserved. */
/** \file
* \ingroup wm
*
* Threaded job manager (high level job access).
*/
#include <string.h>
#include "DNA_windowmanager_types.h"
#include "MEM_guardedalloc.h"
#include "BLI_blenlib.h"
#include "BLI_threads.h"
#include "BLI_utildefines.h"
#include "BKE_context.h"
#include "BKE_global.h"
#include "SEQ_prefetch.h"
#include "WM_api.h"
#include "WM_types.h"
#include "wm.h"
#include "wm_event_types.h"
#include "PIL_time.h"
/*
* Add new job
* - register in WM
* - configure callbacks
*
* Start or re-run job
* - if job running
* - signal job to end
* - add timer notifier to verify when it has ended, to start it
* - else
* - start job
* - add timer notifier to handle progress
*
* Stop job
* - signal job to end
* on end, job will tag itself as sleeping
*
* Remove job
* - signal job to end
* on end, job will remove itself
*
* When job is done:
* - it puts timer to sleep (or removes?)
*/
struct wmJob {
struct wmJob *next, *prev;
/** Job originating from, keep track of this when deleting windows */
wmWindow *win;
/** Should store entire own context, for start, update, free */
void *customdata;
/**
* To prevent cpu overhead, use this one which only gets called when job really starts.
* Executed in main thread.
*/
void (*initjob)(void *);
/**
* This performs the actual parallel work.
* Executed in worker thread(s).
*/
wm_jobs_start_callback startjob;
/**
* Called if thread defines so (see `do_update` flag), and max once per timer step.
* Executed in main thread.
*/
void (*update)(void *);
/**
* Free callback (typically for customdata).
* Executed in main thread.
*/
void (*free)(void *);
/**
* Called when job is stopped.
* Executed in main thread.
*/
void (*endjob)(void *);
/**
* Called when job is stopped normally, i.e. by simply completing the startjob function.
* Executed in main thread.
*/
void (*completed)(void *);
/**
* Called when job is stopped abnormally, i.e. when stop=true but ready=false.
* Executed in main thread.
*/
void (*canceled)(void *);
/** Running jobs each have own timer */
double timestep;
wmTimer *wt;
/** Only start job after specified time delay */
double start_delay_time;
/** The notifier event timers should send */
uint note, endnote;
/* internal */
const void *owner;
int flag;
short suspended, running, ready, job_type;
bool do_update, stop;
float progress;
/** For display in header, identification */
char name[128];
/** Once running, we store this separately */
void *run_customdata;
void (*run_free)(void *);
/** We use BLI_threads api, but per job only 1 thread runs */
ListBase threads;
double start_time;
/** Ticket mutex for main thread locking while some job accesses
* data that the main thread might modify at the same time */
TicketMutex *main_thread_mutex;
};
/* Main thread locking */
void WM_job_main_thread_lock_acquire(wmJob *wm_job)
{
BLI_ticket_mutex_lock(wm_job->main_thread_mutex);
}
void WM_job_main_thread_lock_release(wmJob *wm_job)
{
BLI_ticket_mutex_unlock(wm_job->main_thread_mutex);
}
static void wm_job_main_thread_yield(wmJob *wm_job)
{
/* unlock and lock the ticket mutex. because it's a fair mutex any job that
* is waiting to acquire the lock will get it first, before we can lock */
BLI_ticket_mutex_unlock(wm_job->main_thread_mutex);
BLI_ticket_mutex_lock(wm_job->main_thread_mutex);
}
/**
* Finds if type or owner, compare for it, otherwise any matching job.
*/
static wmJob *wm_job_find(const wmWindowManager *wm, const void *owner, const int job_type)
{
if (owner && job_type) {
LISTBASE_FOREACH (wmJob *, wm_job, &wm->jobs) {
if (wm_job->owner == owner && wm_job->job_type == job_type) {
return wm_job;
}
}
}
else if (owner) {
LISTBASE_FOREACH (wmJob *, wm_job, &wm->jobs) {
if (wm_job->owner == owner) {
return wm_job;
}
}
}
else if (job_type) {
LISTBASE_FOREACH (wmJob *, wm_job, &wm->jobs) {
if (wm_job->job_type == job_type) {
return wm_job;
}
}
}
return NULL;
}
/* ******************* public API ***************** */
wmJob *WM_jobs_get(wmWindowManager *wm,
wmWindow *win,
const void *owner,
const char *name,
int flag,
int job_type)
{
wmJob *wm_job = wm_job_find(wm, owner, job_type);
if (wm_job == NULL) {
wm_job = MEM_callocN(sizeof(wmJob), "new job");
BLI_addtail(&wm->jobs, wm_job);
wm_job->win = win;
wm_job->owner = owner;
wm_job->flag = flag;
wm_job->job_type = job_type;
BLI_strncpy(wm_job->name, name, sizeof(wm_job->name));
wm_job->main_thread_mutex = BLI_ticket_mutex_alloc();
WM_job_main_thread_lock_acquire(wm_job);
}
/* else: a running job, be careful */
/* prevent creating a job with an invalid type */
BLI_assert(wm_job->job_type != WM_JOB_TYPE_ANY);
return wm_job;
}
bool WM_jobs_test(const wmWindowManager *wm, const void *owner, int job_type)
{
/* job can be running or about to run (suspended) */
LISTBASE_FOREACH (wmJob *, wm_job, &wm->jobs) {
if (wm_job->owner == owner) {
if (ELEM(job_type, WM_JOB_TYPE_ANY, wm_job->job_type)) {
if ((wm_job->flag & WM_JOB_PROGRESS) && (wm_job->running || wm_job->suspended)) {
return true;
}
}
}
}
return false;
}
float WM_jobs_progress(const wmWindowManager *wm, const void *owner)
{
const wmJob *wm_job = wm_job_find(wm, owner, WM_JOB_TYPE_ANY);
if (wm_job && wm_job->flag & WM_JOB_PROGRESS) {
return wm_job->progress;
}
return 0.0;
}
static void wm_jobs_update_progress_bars(wmWindowManager *wm)
{
float total_progress = 0.0f;
float jobs_progress = 0;
LISTBASE_FOREACH (wmJob *, wm_job, &wm->jobs) {
if (wm_job->threads.first && !wm_job->ready) {
if (wm_job->flag & WM_JOB_PROGRESS) {
/* accumulate global progress for running jobs */
jobs_progress++;
total_progress += wm_job->progress;
}
}
}
/* if there are running jobs, set the global progress indicator */
if (jobs_progress > 0) {
float progress = total_progress / (float)jobs_progress;
LISTBASE_FOREACH (wmWindow *, win, &wm->windows) {
WM_progress_set(win, progress);
}
}
else {
LISTBASE_FOREACH (wmWindow *, win, &wm->windows) {
WM_progress_clear(win);
}
}
}
double WM_jobs_starttime(const wmWindowManager *wm, const void *owner)
{
const wmJob *wm_job = wm_job_find(wm, owner, WM_JOB_TYPE_ANY);
if (wm_job && wm_job->flag & WM_JOB_PROGRESS) {
return wm_job->start_time;
}
return 0;
}
const char *WM_jobs_name(const wmWindowManager *wm, const void *owner)
{
wmJob *wm_job = wm_job_find(wm, owner, WM_JOB_TYPE_ANY);
if (wm_job) {
return wm_job->name;
}
return NULL;
}
void *WM_jobs_customdata_from_type(wmWindowManager *wm, const void *owner, int job_type)
{
wmJob *wm_job = wm_job_find(wm, owner, job_type);
if (wm_job) {
return WM_jobs_customdata_get(wm_job);
}
return NULL;
}
bool WM_jobs_is_running(const wmJob *wm_job)
{
return wm_job->running;
}
bool WM_jobs_is_stopped(const wmWindowManager *wm, const void *owner)
{
wmJob *wm_job = wm_job_find(wm, owner, WM_JOB_TYPE_ANY);
return wm_job ? wm_job->stop : true; /* XXX to be redesigned properly. */
}
void *WM_jobs_customdata_get(wmJob *wm_job)
{
if (!wm_job->customdata) {
return wm_job->run_customdata;
}
return wm_job->customdata;
}
void WM_jobs_customdata_set(wmJob *wm_job, void *customdata, void (*free)(void *))
{
/* pending job? just free */
if (wm_job->customdata) {
wm_job->free(wm_job->customdata);
}
wm_job->customdata = customdata;
wm_job->free = free;
if (wm_job->running) {
/* signal job to end */
wm_job->stop = true;
}
}
void WM_jobs_timer(wmJob *wm_job, double timestep, uint note, uint endnote)
{
wm_job->timestep = timestep;
wm_job->note = note;
wm_job->endnote = endnote;
}
void WM_jobs_delay_start(wmJob *wm_job, double delay_time)
{
wm_job->start_delay_time = delay_time;
}
void WM_jobs_callbacks(wmJob *wm_job,
wm_jobs_start_callback startjob,
void (*initjob)(void *),
void (*update)(void *),
void (*endjob)(void *))
{
WM_jobs_callbacks_ex(wm_job, startjob, initjob, update, endjob, NULL, NULL);
}
void WM_jobs_callbacks_ex(wmJob *wm_job,
wm_jobs_start_callback startjob,
void (*initjob)(void *),
void (*update)(void *),
void (*endjob)(void *),
void (*completed)(void *),
void (*canceled)(void *))
{
wm_job->startjob = startjob;
wm_job->initjob = initjob;
wm_job->update = update;
wm_job->endjob = endjob;
wm_job->completed = completed;
wm_job->canceled = canceled;
}
static void *do_job_thread(void *job_v)
{
wmJob *wm_job = job_v;
wm_job->startjob(wm_job->run_customdata, &wm_job->stop, &wm_job->do_update, &wm_job->progress);
wm_job->ready = true;
return NULL;
}
/* don't allow same startjob to be executed twice */
static void wm_jobs_test_suspend_stop(wmWindowManager *wm, wmJob *test)
{
bool suspend = false;
/* job added with suspend flag, we wait 1 timer step before activating it */
if (test->start_delay_time > 0.0) {
suspend = true;
test->start_delay_time = 0.0;
}
else {
/* check other jobs */
LISTBASE_FOREACH (wmJob *, wm_job, &wm->jobs) {
/* obvious case, no test needed */
if (wm_job == test || !wm_job->running) {
continue;
}
/* if new job is not render, then check for same startjob */
if (0 == (test->flag & WM_JOB_EXCL_RENDER)) {
if (wm_job->startjob != test->startjob) {
continue;
}
}
/* if new job is render, any render job should be stopped */
if (test->flag & WM_JOB_EXCL_RENDER) {
if (0 == (wm_job->flag & WM_JOB_EXCL_RENDER)) {
continue;
}
}
suspend = true;
/* if this job has higher priority, stop others */
if (test->flag & WM_JOB_PRIORITY) {
wm_job->stop = true;
// printf("job stopped: %s\n", wm_job->name);
}
}
}
/* Possible suspend ourselves, waiting for other jobs, or de-suspend. */
test->suspended = suspend;
#if 0
if (suspend) {
printf("job suspended: %s\n", test->name);
}
#endif
}
void WM_jobs_start(wmWindowManager *wm, wmJob *wm_job)
{
if (wm_job->running) {
/* signal job to end and restart */
wm_job->stop = true;
// printf("job started a running job, ending... %s\n", wm_job->name);
}
else {
if (wm_job->customdata && wm_job->startjob) {
const double timestep = (wm_job->start_delay_time > 0.0) ? wm_job->start_delay_time :
wm_job->timestep;
wm_jobs_test_suspend_stop(wm, wm_job);
if (wm_job->suspended == false) {
/* copy to ensure proper free in end */
wm_job->run_customdata = wm_job->customdata;
wm_job->run_free = wm_job->free;
wm_job->free = NULL;
wm_job->customdata = NULL;
wm_job->running = true;
if (wm_job->initjob) {
wm_job->initjob(wm_job->run_customdata);
}
wm_job->stop = false;
wm_job->ready = false;
wm_job->progress = 0.0;
// printf("job started: %s\n", wm_job->name);
BLI_threadpool_init(&wm_job->threads, do_job_thread, 1);
BLI_threadpool_insert(&wm_job->threads, wm_job);
}
/* restarted job has timer already */
if (wm_job->wt && (wm_job->wt->timestep > timestep)) {
WM_event_remove_timer(wm, wm_job->win, wm_job->wt);
wm_job->wt = WM_event_add_timer(wm, wm_job->win, TIMERJOBS, timestep);
}
if (wm_job->wt == NULL) {
wm_job->wt = WM_event_add_timer(wm, wm_job->win, TIMERJOBS, timestep);
}
wm_job->start_time = PIL_check_seconds_timer();
}
else {
printf("job fails, not initialized\n");
}
}
}
static void wm_job_end(wmJob *wm_job)
{
BLI_assert_msg(BLI_thread_is_main(), "wm_job_end should only be called from the main thread");
if (wm_job->endjob) {
wm_job->endjob(wm_job->run_customdata);
}
/* Do the final callback based on whether the job was run to completion or not.
* Not all jobs have the same way of signaling cancellation (i.e. rendering stops when
* `G.is_break == true`, but doesn't set any wm_job properties to cancel the WM job). */
const bool was_canceled = wm_job->stop || G.is_break;
void (*final_callback)(void *) = (wm_job->ready && !was_canceled) ? wm_job->completed :
wm_job->canceled;
if (final_callback) {
final_callback(wm_job->run_customdata);
}
}
static void wm_job_free(wmWindowManager *wm, wmJob *wm_job)
{
BLI_remlink(&wm->jobs, wm_job);
WM_job_main_thread_lock_release(wm_job);
BLI_ticket_mutex_free(wm_job->main_thread_mutex);
MEM_freeN(wm_job);
}
/* stop job, end thread, free data completely */
static void wm_jobs_kill_job(wmWindowManager *wm, wmJob *wm_job)
{
bool update_progress = (wm_job->flag & WM_JOB_PROGRESS) != 0;
if (wm_job->running) {
/* signal job to end */
wm_job->stop = true;
WM_job_main_thread_lock_release(wm_job);
BLI_threadpool_end(&wm_job->threads);
WM_job_main_thread_lock_acquire(wm_job);
wm_job_end(wm_job);
}
if (wm_job->wt) {
WM_event_remove_timer(wm, wm_job->win, wm_job->wt);
}
if (wm_job->customdata) {
wm_job->free(wm_job->customdata);
}
if (wm_job->run_customdata) {
wm_job->run_free(wm_job->run_customdata);
}
/* remove wm_job */
wm_job_free(wm, wm_job);
/* Update progress bars in windows. */
if (update_progress) {
wm_jobs_update_progress_bars(wm);
}
}
void WM_jobs_kill_all(wmWindowManager *wm)
{
wmJob *wm_job;
while ((wm_job = wm->jobs.first)) {
wm_jobs_kill_job(wm, wm_job);
}
/* This job will be automatically restarted */
SEQ_prefetch_stop_all();
}
void WM_jobs_kill_all_except(wmWindowManager *wm, const void *owner)
{
LISTBASE_FOREACH_MUTABLE (wmJob *, wm_job, &wm->jobs) {
if (wm_job->owner != owner) {
wm_jobs_kill_job(wm, wm_job);
}
}
}
void WM_jobs_kill_type(struct wmWindowManager *wm, const void *owner, int job_type)
{
LISTBASE_FOREACH_MUTABLE (wmJob *, wm_job, &wm->jobs) {
if (!owner || wm_job->owner == owner) {
if (ELEM(job_type, WM_JOB_TYPE_ANY, wm_job->job_type)) {
wm_jobs_kill_job(wm, wm_job);
}
}
}
}
void WM_jobs_stop(wmWindowManager *wm, const void *owner, void *startjob)
{
LISTBASE_FOREACH (wmJob *, wm_job, &wm->jobs) {
if (wm_job->owner == owner || wm_job->startjob == startjob) {
if (wm_job->running) {
wm_job->stop = true;
}
}
}
}
void WM_jobs_kill(wmWindowManager *wm,
void *owner,
void (*startjob)(void *, bool *, bool *, float *))
{
LISTBASE_FOREACH_MUTABLE (wmJob *, wm_job, &wm->jobs) {
if (wm_job->owner == owner || wm_job->startjob == startjob) {
wm_jobs_kill_job(wm, wm_job);
}
}
}
void wm_jobs_timer_end(wmWindowManager *wm, wmTimer *wt)
{
LISTBASE_FOREACH (wmJob *, wm_job, &wm->jobs) {
if (wm_job->wt == wt) {
wm_jobs_kill_job(wm, wm_job);
return;
}
}
}
void wm_jobs_timer(wmWindowManager *wm, wmTimer *wt)
{
LISTBASE_FOREACH_MUTABLE (wmJob *, wm_job, &wm->jobs) {
if (wm_job->wt == wt) {
/* running threads */
if (wm_job->threads.first) {
/* let threads get temporary lock over main thread if needed */
wm_job_main_thread_yield(wm_job);
/* always call note and update when ready */
if (wm_job->do_update || wm_job->ready) {
if (wm_job->update) {
wm_job->update(wm_job->run_customdata);
}
if (wm_job->note) {
WM_event_add_notifier_ex(wm, wm_job->win, wm_job->note, NULL);
}
if (wm_job->flag & WM_JOB_PROGRESS) {
WM_event_add_notifier_ex(wm, wm_job->win, NC_WM | ND_JOB, NULL);
}
wm_job->do_update = false;
}
if (wm_job->ready) {
wm_job_end(wm_job);
/* free own data */
wm_job->run_free(wm_job->run_customdata);
wm_job->run_customdata = NULL;
wm_job->run_free = NULL;
#if 0
if (wm_job->stop) {
printf("job ready but stopped %s\n", wm_job->name);
}
else {
printf("job finished %s\n", wm_job->name);
}
#endif
if (G.debug & G_DEBUG_JOBS) {
printf("Job '%s' finished in %f seconds\n",
wm_job->name,
PIL_check_seconds_timer() - wm_job->start_time);
}
wm_job->running = false;
WM_job_main_thread_lock_release(wm_job);
BLI_threadpool_end(&wm_job->threads);
WM_job_main_thread_lock_acquire(wm_job);
if (wm_job->endnote) {
WM_event_add_notifier_ex(wm, wm_job->win, wm_job->endnote, NULL);
}
WM_event_add_notifier_ex(wm, wm_job->win, NC_WM | ND_JOB, NULL);
/* new job added for wm_job? */
if (wm_job->customdata) {
// printf("job restarted with new data %s\n", wm_job->name);
WM_jobs_start(wm, wm_job);
}
else {
WM_event_remove_timer(wm, wm_job->win, wm_job->wt);
wm_job->wt = NULL;
/* remove wm_job */
wm_job_free(wm, wm_job);
}
}
}
else if (wm_job->suspended) {
WM_jobs_start(wm, wm_job);
}
}
}
/* Update progress bars in windows. */
wm_jobs_update_progress_bars(wm);
}
bool WM_jobs_has_running(const wmWindowManager *wm)
{
LISTBASE_FOREACH (const wmJob *, wm_job, &wm->jobs) {
if (wm_job->running) {
return true;
}
}
return false;
}
bool WM_jobs_has_running_type(const struct wmWindowManager *wm, int job_type)
{
LISTBASE_FOREACH (wmJob *, wm_job, &wm->jobs) {
if (wm_job->running && wm_job->job_type == job_type) {
return true;
}
}
return false;
}
|