Various WorkQueueThread improvements #11539

phire · 2023-02-04T01:48:02Z

Various improvements to WorkQueueThread

Pulled out of #11473 and #11417, a combination of work by both me and @K0bin

Changes:

Added WaitForCompletion (needed by both PRs)
The threads now have proper names
Changed cancel semantics to meet requirements of the present wait PR
Rewrote the whole thing directly with condition vars instead of using Common::Event.

and rename the existing Flush to FlushOne.

Otherwise we will end up with a dozen threads named "WorkQueueThread"

- Cancel doesn't shut down anymore. Allowing it to be used multiple times thoughout the life of the WorkQueue - Remove Clear, so we only have Cancel semantics - Add IsCancelling so work items can abort early if cancelling - Replace m_cancelled and m_thread.joinable() guars with m_shutdown. - Rename Flush to WaitForCompletion (As it's ambiguous if a function called flush should be blocking or not) - Add documentation

Source/Core/Common/WorkQueueThread.h

Adjust shutdown order to prevent potential deadlocks when one thread calls Shutdown, and another calls WaitForCompletion.

m_items.empty() is by far the most likely reason for a notification.

phire and others added 6 commits February 4, 2023 14:31

WorkQueueThread: Add flush capability

512273a

WorkQueueThread: Add Push

9badcc6

WorkQueueThread: Implement proper Flush

9affbfe

and rename the existing Flush to FlushOne.

WorkQueueThread: Rework without Flags/Events

94a0c50

WorkQueueThread: Implement thread name

acdb0c5

Otherwise we will end up with a dozen threads named "WorkQueueThread"

phire force-pushed the improve_workqueuethread branch from 11b1a40 to 6594532 Compare February 4, 2023 01:58

WorkQueueThread: provide name and function at same time

7c4fcc3