WM Jobs: Refactor all worker status variables into a single shared struct. #113343

Bastien Montagne · 2023-10-06T13:12:15+02:00

Bastien Montagne commented

2023-10-06 13:12:15 +02:00

Move the three current 'status variables' (stop, update and progress)
into a single 'WorkerStatus' struct. This is cleaner and will allow for
future workin this area without having to edit tens of 'startjob'
callbacks signatures all the time.

No functional change expected here.

Note: jobs' specific internal code has been modified as little as
possible, in many cases the job's own data still just store pointers to
these three values. Ideally in the future more refactor will be using a
single pointer to the shared wmJobWorkerStatus data instead.

NOTE: This is a first cleanup step before addressing #112537.

Move the three current 'status variables' (stop, update and progress) into a single 'WorkerStatus' struct. This is cleaner and will allow for future workin this area without having to edit tens of 'startjob' callbacks signatures all the time. No functional change expected here. Note: jobs' specific internal code has been modified as little as possible, in many cases the job's own data still just store pointers to these three values. Ideally in the future more refactor will be using a single pointer to the shared `wmJobWorkerStatus` data instead. -------------------- NOTE: This is a first cleanup step before addressing #112537.

👍 1

Bastien Montagne requested review from Brecht Van Lommel 2023-10-06 13:12:52 +02:00

Bastien Montagne requested review from Campbell Barton 2023-10-06 13:12:52 +02:00

Bastien Montagne requested review from Sergey Sharybin 2023-10-06 13:12:52 +02:00

Brecht Van Lommel approved these changes 2023-10-06 19:49:00 +02:00

Brecht Van Lommel left a comment

It would be nice to add some comments are better names to clarify that do_update and progress are status reported by the worker, and stop is a signal to the worker that it should stop.

It would be nice to add some comments are better names to clarify that `do_update` and `progress` are status reported by the worker, and `stop` is a signal to the worker that it should stop.

👍 1

Bastien Montagne force-pushed tmp-wmjobs from 1d387bc669 to 3ff85dbb7b

2023-10-07 16:14:18 +02:00

Compare

Bastien Montagne commented

2023-10-07 16:16:32 +02:00

Thanks, added comments for each member, but would rather not rename them for the time being (since the exact same names are also used in many jobs's own data).

Also added some comment regarding thread safety (since this is essentially data shared between threads, without any protection or synchronization to its access).

Thanks, added comments for each member, but would rather not rename them for the time being (since the exact same names are also used in many jobs's own data). Also added some comment regarding thread safety (since this is essentially data shared between threads, without any protection or synchronization to its access).

Sergey Sharybin approved these changes 2023-10-09 09:57:46 +02:00

Bastien Montagne merged commit df0d7c9c3d into main

2023-10-09 12:12:30 +02:00

Bastien Montagne referenced this issue from a commit

2023-10-09 12:12:32 +02:00

WM Jobs: Refactor all worker status variables into a single shared struct.

Bastien Montagne deleted branch tmp-wmjobs

2023-10-09 12:12:32 +02:00

Sign in to join this conversation.

No reviewers

No Label

Download

What's New

Blender Studio

Manual

Developers Blog

Documentation

Benchmark

Blender Conference

Development Fund

One-time Donations

WM Jobs: Refactor all worker status variables into a single shared struct. #113343