Synchronization

Classes
class	tbb::null_mutex
	A mutex which does nothing. More...
class	tbb::null_rw_mutex
	A rw mutex which does nothing. More...
class	tbb::queuing_mutex
	Queuing mutex with local-only spinning. More...
class	tbb::queuing_rw_mutex
	Queuing reader-writer mutex with local-only spinning. More...
class	tbb::spin_mutex
	A lock that occupies a single byte. More...
class	tbb::spin_rw_mutex_v3
	Fast, unfair, spinning reader-writer lock with backoff and writer-preference. More...

Typedefs
typedef interface7::internal::padded_mutex < spin_mutex, false >	tbb::speculative_spin_mutex
	A cross-platform spin mutex with speculative lock acquisition. More...
typedef interface7::internal::padded_mutex < tbb::spin_rw_mutex, true >	tbb::interface8::speculative_spin_rw_mutex
	A cross-platform spin reader/writer mutex with speculative lock acquisition. More...

Functions
template<typename T >
struct	tbb::__TBB_DEPRECATED_IN_VERBOSE_MODE_MSG ("tbb::atomic is deprecated, use std::atomic") atomic
	Primary template for atomic. More...
class	tbb::__TBB_DEPRECATED_IN_VERBOSE_MODE_MSG ("tbb::critical_section is deprecated, use std::mutex") mutex
	Wrapper around the platform's native lock. More...
class	tbb::__TBB_DEPRECATED_IN_VERBOSE_MODE_MSG ("tbb::recursive_mutex is deprecated, use std::recursive_mutex") recursive_mutex
	Mutex that allows recursive mutex acquisition. More...

Variables
class friend class("tbb::reader_writer_lock is deprecated, use std::shared_mutex") reader_writer_lock	tbb::interface5::scoped_lock_read
	Writer-preference reader-writer lock with local-only spinning on readers. More...

Detailed Description

Typedef Documentation

typedef interface7::internal::padded_mutex<spin_mutex,false> tbb::speculative_spin_mutex

A cross-platform spin mutex with speculative lock acquisition.

On platforms with proper HW support, this lock may speculatively execute its critical sections, using HW mechanisms to detect real data races and ensure atomicity of the critical sections. In particular, it uses Intel(R) Transactional Synchronization Extensions (Intel(R) TSX). Without such HW support, it behaves like a spin_mutex. It should be used for locking short critical sections where the lock is contended but the data it protects are not. If zero-initialized, the mutex is considered unheld.

Definition at line 205 of file spin_mutex.h.

typedef interface7::internal::padded_mutex<tbb::spin_rw_mutex,true> tbb::interface8::speculative_spin_rw_mutex

A cross-platform spin reader/writer mutex with speculative lock acquisition.

On platforms with proper HW support, this lock may speculatively execute its critical sections, using HW mechanisms to detect real data races and ensure atomicity of the critical sections. In particular, it uses Intel(R) Transactional Synchronization Extensions (Intel(R) TSX). Without such HW support, it behaves like a spin_rw_mutex. It should be used for locking short critical sections where the lock is contended but the data it protects are not.

Definition at line 245 of file spin_rw_mutex.h.

Function Documentation

class tbb::__TBB_DEPRECATED_IN_VERBOSE_MODE_MSG	(	"tbb::recursive_mutex is	deprecated,
		use std::recursive_mutex"
	)

Mutex that allows recursive mutex acquisition.

Mutex that allows recursive mutex acquisition.

Definition at line 49 of file recursive_mutex.h.

References tbb::internal::handle_perror(), tbb::impl, and tbb::internal_construct().

                : internal::mutex_copy_deprecated_and_disabled {
public:
    recursive_mutex() {
#if TBB_USE_ASSERT || TBB_USE_THREADING_TOOLS
        internal_construct();
#else
  #if _WIN32||_WIN64
        InitializeCriticalSectionEx(&impl, 4000, 0);
  #else
        pthread_mutexattr_t mtx_attr;
        int error_code = pthread_mutexattr_init( &mtx_attr );
        if( error_code )
            tbb::internal::handle_perror(error_code,"recursive_mutex: pthread_mutexattr_init failed");

        pthread_mutexattr_settype( &mtx_attr, PTHREAD_MUTEX_RECURSIVE );
        error_code = pthread_mutex_init( &impl, &mtx_attr );
        if( error_code )
            tbb::internal::handle_perror(error_code,"recursive_mutex: pthread_mutex_init failed");

        pthread_mutexattr_destroy( &mtx_attr );
  #endif /* _WIN32||_WIN64*/
#endif /* TBB_USE_ASSERT */
    };

Here is the call graph for this function:

template<typename T >

struct tbb::__TBB_DEPRECATED_IN_VERBOSE_MODE_MSG	(	"tbb::atomic is	deprecated,
		use std::atomic"
	)

Primary template for atomic.

Specialization for atomic<T*> with arithmetic and operator->.

See the Reference for details.

Definition at line 417 of file atomic.h.

      : internal::atomic_impl<T> {
#if __TBB_ATOMIC_CTORS
    atomic() = default;
    constexpr atomic(T arg): internal::atomic_impl<T>(arg) {}
    constexpr atomic<T>(const atomic<T>& rhs): internal::atomic_impl<T>(rhs) {}
#endif
    T operator=( T rhs ) {
        // "this" required here in strict ISO C++ because store_with_release is a dependent name
        return this->store_with_release(rhs);
    }
    atomic<T>& operator=( const atomic<T>& rhs ) {this->store_with_release(rhs); return *this;}
};

class tbb::__TBB_DEPRECATED_IN_VERBOSE_MODE_MSG	(	"tbb::critical_section is	deprecated,
		use std::mutex"
	)

Wrapper around the platform's native lock.

Definition at line 49 of file mutex.h.

References tbb::internal::handle_perror(), tbb::impl, and tbb::internal_construct().

                                                                                                    : internal::mutex_copy_deprecated_and_disabled {
public:
    mutex() {
#if TBB_USE_ASSERT || TBB_USE_THREADING_TOOLS
    internal_construct();
#else
  #if _WIN32||_WIN64
        InitializeCriticalSectionEx(&impl, 4000, 0);
  #else
        int error_code = pthread_mutex_init(&impl,NULL);
        if( error_code )
            tbb::internal::handle_perror(error_code,"mutex: pthread_mutex_init failed");
  #endif /* _WIN32||_WIN64*/
#endif /* TBB_USE_ASSERT */
    };

Here is the call graph for this function:

Variable Documentation

class friend class ("tbb::reader_writer_lock is deprecated, use std::shared_mutex") reader_writer_lock tbb::interface5::scoped_lock_read

Writer-preference reader-writer lock with local-only spinning on readers.

Loosely adapted from Mellor-Crummey and Scott pseudocode at http://www.cs.rochester.edu/research/synchronization/pseudocode/rw.html#s_wp

Definition at line 44 of file reader_writer_lock.h.