mirror of
https://github.com/trapexit/mergerfs.git
synced 2026-11-21 15:36:31 -05:00
thread_pool: document thread_count eventual consistency and -ECANCELED
Two doc-only follow-ups to the preceding cleanup series: - thread_count() is now an atomic-mirror read rather than a locked read of _threads.size(). Note on the declaration that callers wanting an exact count after a scaling operation must quiesce the pool (or use the wait_until pattern from the unit tests). - add_thread / remove_thread / set_threads now return -ECANCELED during shutdown (_stop set), where they previously silently no-oped in some code paths. Extend the class-level shutdown contract comment so callers treat the non-zero return as expected, not as a failure.
This commit is contained in:
parent
07bd0d1098
commit
0346f2557a
1 changed files with 10 additions and 0 deletions
|
|
@ -58,6 +58,10 @@ struct ThreadPoolTraits : public moodycamel::ConcurrentQueueDefaultTraits
|
|||
// An enqueue racing with the destructor is otherwise safe — the
|
||||
// BoundedQueue destructor runs only after all workers are joined, so
|
||||
// the queue is not accessed concurrently during teardown.
|
||||
//
|
||||
// add_thread(), remove_thread(), and set_threads() return
|
||||
// -ECANCELED when called while shutdown is in progress. Treat a
|
||||
// non-zero return during teardown as expected, not as a failure.
|
||||
class ThreadPool
|
||||
{
|
||||
public:
|
||||
|
|
@ -168,6 +172,12 @@ public:
|
|||
ThreadPool::PToken ptoken();
|
||||
|
||||
// Introspection
|
||||
// thread_count() reads an atomic mirror of _threads.size() and is
|
||||
// eventually consistent: at rest (no in-flight scaling operation)
|
||||
// the value equals _threads.size(). A caller that needs an exact
|
||||
// count must be sure no concurrent add/remove/set_threads is in
|
||||
// flight, or wait on the pool settling (see wait_until patterns in
|
||||
// tests/tests.cpp).
|
||||
std::size_t thread_count() const;
|
||||
std::size_t queue_depth() const;
|
||||
std::size_t queue_capacity() const;
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue