Mutex pools are designed to be used as short term leaf mutexes;
i.e., the last mutex one might acquire before calling
They operate using a shared pool of mutexes.
A mutex may be chosen from the pool based on a supplied pointer,
which may or may not point to anything valid,
or the caller may allocate an arbitrary shared mutex from the pool
and save the returned mutex pointer for later use.
The shared mutexes in the
which is created by default,
are standard, non-recursive,
blockable mutexes, and should only be used in appropriate situations.
The mutexes in the
mutex pool are similar, except that they are initialized with the MTX_NOWITNESS
flag so that they may be used to build higher-level locks.
Other mutex pools may be created that contain mutexes with different
properties, such as spin mutexes.
The caller can lock and unlock mutexes returned by the pool routines, but
since the mutexes are shared, the caller should not attempt to destroy them
or modify their characteristics.
While pool mutexes are normally leaf mutexes
(meaning that one cannot depend on any ordering guarantees
after obtaining one),
one can still obtain other mutexes under carefully controlled circumstances.
Specifically, if one has a private mutex
(one that was allocated and initialized by the caller),
one can obtain it after obtaining a pool mutex if ordering issues are
carefully accounted for.
In these cases the private mutex winds up being the true leaf mutex.
Pool mutexes have the following advantages:
- No structural overhead;
i.e., they can be associated with a structure without adding bloat to it.
- Mutexes can be obtained for invalid pointers, which is useful when one uses
mutexes to interlock destructor operations.
- No initialization or destruction overhead.
- Can be used with
And the following disadvantages:
- Should generally only be used as leaf mutexes.
- Pool/pool dependency ordering cannot be guaranteed.
- Possible L1 cache mastership contention between CPUs.
obtains a shared mutex from the specified pool.
This routine uses a simple rover to choose one of the shared mutexes managed
returns the shared mutex associated with the specified address.
This routine will create a hash out of the pointer passed into it
and will choose a shared mutex from the specified pool based on that hash.
The pointer does not need to point to anything real.
lock and unlock the shared mutex from the specified pool
associated with the specified address;
they are a combination of
Since these routines must first find the mutex to operate on,
they are not as fast as directly using the mutex pointer returned by
a previous invocation of
allocates and initializes a new mutex pool of the
The pool size must be a power of two.
argument is passed to
to set the options for each mutex in the pool.
on each mutex in the specified pool,
deallocates the memory associated with the pool,
and assigns NULL to the pool pointer.