32 Thread support library [thread]

32.5 Mutual exclusion [thread.mutex]

32.5.3 Mutex requirements [thread.mutex.requirements]

32.5.3.1 In general [thread.mutex.requirements.general]

1
#
A mutex object facilitates protection against data races and allows safe synchronization of data between execution agents.
An execution agent owns a mutex from the time it successfully calls one of the lock functions until it calls unlock.
Mutexes can be either recursive or non-recursive, and can grant simultaneous ownership to one or many execution agents.
Both recursive and non-recursive mutexes are supplied.

32.5.3.2 Mutex types [thread.mutex.requirements.mutex]

1
#
The mutex types are the standard library types mutex, recursive_­mutex, timed_­mutex, recursive_­timed_­mutex, shared_­mutex, and shared_­timed_­mutex.
They meet the requirements set out in this subclause.
In this description, m denotes an object of a mutex type.
2
#
The mutex types meet the Cpp17Lockable requirements ([thread.req.lockable.req]).
3
#
The mutex types meet Cpp17DefaultConstructible and Cpp17Destructible.
If initialization of an object of a mutex type fails, an exception of type system_­error is thrown.
The mutex types are neither copyable nor movable.
4
#
The error conditions for error codes, if any, reported by member functions of the mutex types are as follows:
  • (4.1)
    resource_­unavailable_­try_­again — if any native handle type manipulated is not available.
  • (4.2)
    operation_­not_­permitted — if the thread does not have the privilege to perform the operation.
  • (4.3)
    invalid_­argument — if any native handle type manipulated as part of mutex construction is incorrect.
5
#
The implementation provides lock and unlock operations, as described below.
For purposes of determining the existence of a data race, these behave as atomic operations ([intro.multithread]).
The lock and unlock operations on a single mutex appears to occur in a single total order.
[Note
:
This can be viewed as the modification order of the mutex.
— end note
]
[Note
:
Construction and destruction of an object of a mutex type need not be thread-safe; other synchronization should be used to ensure that mutex objects are initialized and visible to other threads.
— end note
]
6
#
The expression m.lock() is well-formed and has the following semantics:
7
#
Preconditions: If m is of type mutex, timed_­mutex, shared_­mutex, or shared_­timed_­mutex, the calling thread does not own the mutex.
8
#
Effects: Blocks the calling thread until ownership of the mutex can be obtained for the calling thread.
9
#
Postconditions: The calling thread owns the mutex.
10
#
Return type: void.
11
#
Synchronization: Prior unlock() operations on the same object synchronize with ([intro.multithread]) this operation.
12
#
Throws: system_­error when an exception is required ([thread.req.exception]).
13
#
Error conditions:
  • (13.1)
    operation_­not_­permitted — if the thread does not have the privilege to perform the operation.
  • (13.2)
    resource_­deadlock_­would_­occur — if the implementation detects that a deadlock would occur.
14
#
The expression m.try_­lock() is well-formed and has the following semantics:
15
#
Preconditions: If m is of type mutex, timed_­mutex, shared_­mutex, or shared_­timed_­mutex, the calling thread does not own the mutex.
16
#
Effects: Attempts to obtain ownership of the mutex for the calling thread without blocking.
If ownership is not obtained, there is no effect and try_­lock() immediately returns.
An implementation may fail to obtain the lock even if it is not held by any other thread.
[Note
:
This spurious failure is normally uncommon, but allows interesting implementations based on a simple compare and exchange ([atomics]).
— end note
]
An implementation should ensure that try_­lock() does not consistently return false in the absence of contending mutex acquisitions.
17
#
Return type: bool.
18
#
Returns: true if ownership of the mutex was obtained for the calling thread, otherwise false.
19
#
Synchronization: If try_­lock() returns true, prior unlock() operations on the same object synchronize with this operation.
[Note
:
Since lock() does not synchronize with a failed subsequent try_­lock(), the visibility rules are weak enough that little would be known about the state after a failure, even in the absence of spurious failures.
— end note
]
20
#
Throws: Nothing.
21
#
The expression m.unlock() is well-formed and has the following semantics:
22
#
Preconditions: The calling thread owns the mutex.
23
#
Effects: Releases the calling thread's ownership of the mutex.
24
#
Return type: void.
25
#
Synchronization: This operation synchronizes with subsequent lock operations that obtain ownership on the same object.
26
#
Throws: Nothing.

32.5.3.2.1 Class mutex [thread.mutex.class]

namespace std {
  class mutex {
  public:
    constexpr mutex() noexcept;
    ~mutex();

    mutex(const mutex&) = delete;
    mutex& operator=(const mutex&) = delete;

    void lock();
    bool try_lock();
    void unlock();

    using native_handle_type = implementation-defined;          // see [thread.req.native]
    native_handle_type native_handle();                         // see [thread.req.native]
  };
}
1
#
The class mutex provides a non-recursive mutex with exclusive ownership semantics.
If one thread owns a mutex object, attempts by another thread to acquire ownership of that object will fail (for try_­lock()) or block (for lock()) until the owning thread has released ownership with a call to unlock().
2
#
[Note
:
After a thread A has called unlock(), releasing a mutex, it is possible for another thread B to lock the same mutex, observe that it is no longer in use, unlock it, and destroy it, before thread A appears to have returned from its unlock call.
Implementations are required to handle such scenarios correctly, as long as thread A doesn't access the mutex after the unlock call returns.
These cases typically occur when a reference-counted object contains a mutex that is used to protect the reference count.
— end note
]
3
#
The class mutex meets all of the mutex requirements ([thread.mutex.requirements]).
It is a standard-layout class ([class.prop]).
4
#
[Note
:
A program can deadlock if the thread that owns a mutex object calls lock() on that object.
If the implementation can detect the deadlock, a resource_­deadlock_­would_­occur error condition might be observed.
— end note
]
5
#
The behavior of a program is undefined if it destroys a mutex object owned by any thread or a thread terminates while owning a mutex object.

32.5.3.2.2 Class recursive_­mutex [thread.mutex.recursive]

namespace std {
  class recursive_mutex {
  public:
    recursive_mutex();
    ~recursive_mutex();

    recursive_mutex(const recursive_mutex&) = delete;
    recursive_mutex& operator=(const recursive_mutex&) = delete;

    void lock();
    bool try_lock() noexcept;
    void unlock();

    using native_handle_type = implementation-defined;          // see [thread.req.native]
    native_handle_type native_handle();                         // see [thread.req.native]
  };
}
1
#
The class recursive_­mutex provides a recursive mutex with exclusive ownership semantics.
If one thread owns a recursive_­mutex object, attempts by another thread to acquire ownership of that object will fail (for try_­lock()) or block (for lock()) until the first thread has completely released ownership.
2
#
The class recursive_­mutex meets all of the mutex requirements ([thread.mutex.requirements]).
It is a standard-layout class ([class.prop]).
3
#
A thread that owns a recursive_­mutex object may acquire additional levels of ownership by calling lock() or try_­lock() on that object.
It is unspecified how many levels of ownership may be acquired by a single thread.
If a thread has already acquired the maximum level of ownership for a recursive_­mutex object, additional calls to try_­lock() fail, and additional calls to lock() throw an exception of type system_­error.
A thread shall call unlock() once for each level of ownership acquired by calls to lock() and try_­lock().
Only when all levels of ownership have been released may ownership be acquired by another thread.
4
#
The behavior of a program is undefined if:
  • (4.1)
    it destroys a recursive_­mutex object owned by any thread or
  • (4.2)
    a thread terminates while owning a recursive_­mutex object.

32.5.3.3 Timed mutex types [thread.timedmutex.requirements]

1
#
The timed mutex types are the standard library types timed_­mutex, recursive_­timed_­mutex, and shared_­timed_­mutex.
They meet the requirements set out below.
In this description, m denotes an object of a mutex type, rel_­time denotes an object of an instantiation of duration, and abs_­time denotes an object of an instantiation of time_­point.
2
#
The timed mutex types meet the Cpp17TimedLockable requirements ([thread.req.lockable.timed]).
3
#
The expression m.try_­lock_­for(rel_­time) is well-formed and has the following semantics:
4
#
Preconditions: If m is of type timed_­mutex or shared_­timed_­mutex, the calling thread does not own the mutex.
5
#
Effects: The function attempts to obtain ownership of the mutex within the relative timeout ([thread.req.timing]) specified by rel_­time.
If the time specified by rel_­time is less than or equal to rel_­time.zero(), the function attempts to obtain ownership without blocking (as if by calling try_­lock()).
The function returns within the timeout specified by rel_­time only if it has obtained ownership of the mutex object.
[Note
:
As with try_­lock(), there is no guarantee that ownership will be obtained if the lock is available, but implementations are expected to make a strong effort to do so.
— end note
]
6
#
Return type: bool.
7
#
Returns: true if ownership was obtained, otherwise false.
8
#
Synchronization: If try_­lock_­for() returns true, prior unlock() operations on the same object synchronize with this operation.
9
#
Throws: Timeout-related exceptions ([thread.req.timing]).
10
#
The expression m.try_­lock_­until(abs_­time) is well-formed and has the following semantics:
11
#
Preconditions: If m is of type timed_­mutex or shared_­timed_­mutex, the calling thread does not own the mutex.
12
#
Effects: The function attempts to obtain ownership of the mutex.
If abs_­time has already passed, the function attempts to obtain ownership without blocking (as if by calling try_­lock()).
The function returns before the absolute timeout ([thread.req.timing]) specified by abs_­time only if it has obtained ownership of the mutex object.
[Note
:
As with try_­lock(), there is no guarantee that ownership will be obtained if the lock is available, but implementations are expected to make a strong effort to do so.
— end note
]
13
#
Return type: bool.
14
#
Returns: true if ownership was obtained, otherwise false.
15
#
Synchronization: If try_­lock_­until() returns true, prior unlock() operations on the same object synchronize with this operation.
16
#
Throws: Timeout-related exceptions ([thread.req.timing]).

32.5.3.3.1 Class timed_­mutex [thread.timedmutex.class]

namespace std {
  class timed_mutex {
  public:
    timed_mutex();
    ~timed_mutex();

    timed_mutex(const timed_mutex&) = delete;
    timed_mutex& operator=(const timed_mutex&) = delete;

    void lock();    // blocking
    bool try_lock();
    template<class Rep, class Period>
      bool try_lock_for(const chrono::duration<Rep, Period>& rel_time);
    template<class Clock, class Duration>
      bool try_lock_until(const chrono::time_point<Clock, Duration>& abs_time);
    void unlock();

    using native_handle_type = implementation-defined;          // see [thread.req.native]
    native_handle_type native_handle();                         // see [thread.req.native]
  };
}
1
#
The class timed_­mutex provides a non-recursive mutex with exclusive ownership semantics.
If one thread owns a timed_­mutex object, attempts by another thread to acquire ownership of that object will fail (for try_­lock()) or block (for lock(), try_­lock_­for(), and try_­lock_­until()) until the owning thread has released ownership with a call to unlock() or the call to try_­lock_­for() or try_­lock_­until() times out (having failed to obtain ownership).
2
#
The class timed_­mutex meets all of the timed mutex requirements ([thread.timedmutex.requirements]).
It is a standard-layout class ([class.prop]).
3
#
The behavior of a program is undefined if:
  • (3.1)
    it destroys a timed_­mutex object owned by any thread,
  • (3.2)
    a thread that owns a timed_­mutex object calls lock(), try_­lock(), try_­lock_­for(), or try_­lock_­until() on that object, or
  • (3.3)
    a thread terminates while owning a timed_­mutex object.

32.5.3.3.2 Class recursive_­timed_­mutex [thread.timedmutex.recursive]

namespace std {
  class recursive_timed_mutex {
  public:
    recursive_timed_mutex();
    ~recursive_timed_mutex();

    recursive_timed_mutex(const recursive_timed_mutex&) = delete;
    recursive_timed_mutex& operator=(const recursive_timed_mutex&) = delete;

    void lock();    // blocking
    bool try_lock() noexcept;
    template<class Rep, class Period>
      bool try_lock_for(const chrono::duration<Rep, Period>& rel_time);
    template<class Clock, class Duration>
      bool try_lock_until(const chrono::time_point<Clock, Duration>& abs_time);
    void unlock();

    using native_handle_type = implementation-defined;          // see [thread.req.native]
    native_handle_type native_handle();                         // see [thread.req.native]
  };
}
1
#
The class recursive_­timed_­mutex provides a recursive mutex with exclusive ownership semantics.
If one thread owns a recursive_­timed_­mutex object, attempts by another thread to acquire ownership of that object will fail (for try_­lock()) or block (for lock(), try_­lock_­for(), and try_­lock_­until()) until the owning thread has completely released ownership or the call to try_­lock_­for() or try_­lock_­until() times out (having failed to obtain ownership).
2
#
The class recursive_­timed_­mutex meets all of the timed mutex requirements ([thread.timedmutex.requirements]).
It is a standard-layout class ([class.prop]).
3
#
A thread that owns a recursive_­timed_­mutex object may acquire additional levels of ownership by calling lock(), try_­lock(), try_­lock_­for(), or try_­lock_­until() on that object.
It is unspecified how many levels of ownership may be acquired by a single thread.
If a thread has already acquired the maximum level of ownership for a recursive_­timed_­mutex object, additional calls to try_­lock(), try_­lock_­for(), or try_­lock_­until() fail, and additional calls to lock() throw an exception of type system_­error.
A thread shall call unlock() once for each level of ownership acquired by calls to lock(), try_­lock(), try_­lock_­for(), and try_­lock_­until().
Only when all levels of ownership have been released may ownership of the object be acquired by another thread.
4
#
The behavior of a program is undefined if:
  • (4.1)
    it destroys a recursive_­timed_­mutex object owned by any thread, or
  • (4.2)
    a thread terminates while owning a recursive_­timed_­mutex object.

32.5.3.4 Shared mutex types [thread.sharedmutex.requirements]

1
#
The standard library types shared_­mutex and shared_­timed_­mutex are shared mutex types.
Shared mutex types meet the requirements of mutex types ([thread.mutex.requirements.mutex]) and additionally meet the requirements set out below.
In this description, m denotes an object of a shared mutex type.
2
#
In addition to the exclusive lock ownership mode specified in [thread.mutex.requirements.mutex], shared mutex types provide a shared lock ownership mode.
Multiple execution agents can simultaneously hold a shared lock ownership of a shared mutex type.
But no execution agent holds a shared lock while another execution agent holds an exclusive lock on the same shared mutex type, and vice-versa.
The maximum number of execution agents which can share a shared lock on a single shared mutex type is unspecified, but is at least 10000.
If more than the maximum number of execution agents attempt to obtain a shared lock, the excess execution agents block until the number of shared locks are reduced below the maximum amount by other execution agents releasing their shared lock.
3
#
The expression m.lock_­shared() is well-formed and has the following semantics:
4
#
Preconditions: The calling thread has no ownership of the mutex.
5
#
Effects: Blocks the calling thread until shared ownership of the mutex can be obtained for the calling thread.
If an exception is thrown then a shared lock has not been acquired for the current thread.
6
#
Postconditions: The calling thread has a shared lock on the mutex.
7
#
Return type: void.
8
#
Synchronization: Prior unlock() operations on the same object synchronize with ([intro.multithread]) this operation.
9
#
Throws: system_­error when an exception is required ([thread.req.exception]).
10
#
Error conditions:
  • (10.1)
    operation_­not_­permitted — if the thread does not have the privilege to perform the operation.
  • (10.2)
    resource_­deadlock_­would_­occur — if the implementation detects that a deadlock would occur.
11
#
The expression m.unlock_­shared() is well-formed and has the following semantics:
12
#
Preconditions: The calling thread holds a shared lock on the mutex.
13
#
Effects: Releases a shared lock on the mutex held by the calling thread.
14
#
Return type: void.
15
#
Synchronization: This operation synchronizes with subsequent lock() operations that obtain ownership on the same object.
16
#
Throws: Nothing.
17
#
The expression m.try_­lock_­shared() is well-formed and has the following semantics:
18
#
Preconditions: The calling thread has no ownership of the mutex.
19
#
Effects: Attempts to obtain shared ownership of the mutex for the calling thread without blocking.
If shared ownership is not obtained, there is no effect and try_­lock_­shared() immediately returns.
An implementation may fail to obtain the lock even if it is not held by any other thread.
20
#
Return type: bool.
21
#
Returns: true if the shared ownership lock was acquired, false otherwise.
22
#
Synchronization: If try_­lock_­shared() returns true, prior unlock() operations on the same object synchronize with this operation.
23
#
Throws: Nothing.

32.5.3.4.1 Class shared_­mutex [thread.sharedmutex.class]

namespace std {
  class shared_mutex {
  public:
    shared_mutex();
    ~shared_mutex();

    shared_mutex(const shared_mutex&) = delete;
    shared_mutex& operator=(const shared_mutex&) = delete;

    // exclusive ownership
    void lock();                // blocking
    bool try_lock();
    void unlock();

    // shared ownership
    void lock_shared();         // blocking
    bool try_lock_shared();
    void unlock_shared();

    using native_handle_type = implementation-defined;          // see [thread.req.native]
    native_handle_type native_handle();                         // see [thread.req.native]
  };
}
1
#
The class shared_­mutex provides a non-recursive mutex with shared ownership semantics.
2
#
The class shared_­mutex meets all of the shared mutex requirements ([thread.sharedmutex.requirements]).
It is a standard-layout class ([class.prop]).
3
#
The behavior of a program is undefined if:
  • (3.1)
    it destroys a shared_­mutex object owned by any thread,
  • (3.2)
    a thread attempts to recursively gain any ownership of a shared_­mutex, or
  • (3.3)
    a thread terminates while possessing any ownership of a shared_­mutex.
4
#
shared_­mutex may be a synonym for shared_­timed_­mutex.

32.5.3.5 Shared timed mutex types [thread.sharedtimedmutex.requirements]

1
#
The standard library type shared_­timed_­mutex is a shared timed mutex type.
Shared timed mutex types meet the requirements of timed mutex types ([thread.timedmutex.requirements]), shared mutex types ([thread.sharedmutex.requirements]), and additionally meet the requirements set out below.
In this description, m denotes an object of a shared timed mutex type, rel_­type denotes an object of an instantiation of duration, and abs_­time denotes an object of an instantiation of time_­point.
2
#
The expression m.try_­lock_­shared_­for(rel_­time) is well-formed and has the following semantics:
3
#
Preconditions: The calling thread has no ownership of the mutex.
4
#
Effects: Attempts to obtain shared lock ownership for the calling thread within the relative timeout ([thread.req.timing]) specified by rel_­time.
If the time specified by rel_­time is less than or equal to rel_­time.zero(), the function attempts to obtain ownership without blocking (as if by calling try_­lock_­shared()).
The function returns within the timeout specified by rel_­time only if it has obtained shared ownership of the mutex object.
[Note
:
As with try_­lock(), there is no guarantee that ownership will be obtained if the lock is available, but implementations are expected to make a strong effort to do so.
— end note
]
If an exception is thrown then a shared lock has not been acquired for the current thread.
5
#
Return type: bool.
6
#
Returns: true if the shared lock was acquired, false otherwise.
7
#
Synchronization: If try_­lock_­shared_­for() returns true, prior unlock() operations on the same object synchronize with ([intro.multithread]) this operation.
8
#
Throws: Timeout-related exceptions ([thread.req.timing]).
9
#
The expression m.try_­lock_­shared_­until(abs_­time) is well-formed and has the following semantics:
10
#
Preconditions: The calling thread has no ownership of the mutex.
11
#
Effects: The function attempts to obtain shared ownership of the mutex.
If abs_­time has already passed, the function attempts to obtain shared ownership without blocking (as if by calling try_­lock_­shared()).
The function returns before the absolute timeout ([thread.req.timing]) specified by abs_­time only if it has obtained shared ownership of the mutex object.
[Note
:
As with try_­lock(), there is no guarantee that ownership will be obtained if the lock is available, but implementations are expected to make a strong effort to do so.
— end note
]
If an exception is thrown then a shared lock has not been acquired for the current thread.
12
#
Return type: bool.
13
#
Returns: true if the shared lock was acquired, false otherwise.
14
#
Synchronization: If try_­lock_­shared_­until() returns true, prior unlock() operations on the same object synchronize with ([intro.multithread]) this operation.
15
#
Throws: Timeout-related exceptions ([thread.req.timing]).

32.5.3.5.1 Class shared_­timed_­mutex [thread.sharedtimedmutex.class]

namespace std {
  class shared_timed_mutex {
  public:
    shared_timed_mutex();
    ~shared_timed_mutex();

    shared_timed_mutex(const shared_timed_mutex&) = delete;
    shared_timed_mutex& operator=(const shared_timed_mutex&) = delete;

    // exclusive ownership
    void lock();                // blocking
    bool try_lock();
    template<class Rep, class Period>
      bool try_lock_for(const chrono::duration<Rep, Period>& rel_time);
    template<class Clock, class Duration>
      bool try_lock_until(const chrono::time_point<Clock, Duration>& abs_time);
    void unlock();

    // shared ownership
    void lock_shared();         // blocking
    bool try_lock_shared();
    template<class Rep, class Period>
      bool try_lock_shared_for(const chrono::duration<Rep, Period>& rel_time);
    template<class Clock, class Duration>
      bool try_lock_shared_until(const chrono::time_point<Clock, Duration>& abs_time);
    void unlock_shared();
  };
}
1
#
The class shared_­timed_­mutex provides a non-recursive mutex with shared ownership semantics.
2
#
The class shared_­timed_­mutex meets all of the shared timed mutex requirements ([thread.sharedtimedmutex.requirements]).
It is a standard-layout class ([class.prop]).
3
#
The behavior of a program is undefined if:
  • (3.1)
    it destroys a shared_­timed_­mutex object owned by any thread,
  • (3.2)
    a thread attempts to recursively gain any ownership of a shared_­timed_­mutex, or
  • (3.3)
    a thread terminates while possessing any ownership of a shared_­timed_­mutex.