queuing_rw_mutex.h
Go to the documentation of this file.
/*
Copyright (c) 2005-2020 Intel Corporation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
#ifndef __TBB_queuing_rw_mutex_H
#define __TBB_queuing_rw_mutex_H
#define __TBB_queuing_rw_mutex_H_include_area
#include "internal/_warning_suppress_enable_notice.h"
#include <cstring>
#include "atomic.h"
#include "tbb_profiling.h"
namespace tbb {
class queuing_rw_mutex : internal::mutex_copy_deprecated_and_disabled {
public:
queuing_rw_mutex() {
q_tail = NULL;
#if TBB_USE_THREADING_TOOLS
internal_construct();
#endif
}
~queuing_rw_mutex() {
#if TBB_USE_ASSERT
__TBB_ASSERT( !q_tail, "destruction of an acquired mutex");
#endif
}
class scoped_lock: internal::no_copy {
void initialize() {
my_mutex = NULL;
my_internal_lock = 0;
my_going = 0;
#if TBB_USE_ASSERT
my_state = 0xFF; // Set to invalid state
internal::poison_pointer(my_next);
internal::poison_pointer(my_prev);
#endif /* TBB_USE_ASSERT */
}
public:
scoped_lock() {initialize();}
scoped_lock( queuing_rw_mutex& m, bool write=true ) {
initialize();
acquire(m,write);
}
~scoped_lock() {
if( my_mutex ) release();
}
void acquire( queuing_rw_mutex& m, bool write=true );
bool try_acquire( queuing_rw_mutex& m, bool write=true );
void release();
bool upgrade_to_writer();
bool downgrade_to_reader();
private:
queuing_rw_mutex* my_mutex;
scoped_lock *__TBB_atomic my_prev, *__TBB_atomic my_next;
typedef unsigned char state_t;
atomic<state_t> my_state;
unsigned char __TBB_atomic my_going;
unsigned char my_internal_lock;
void acquire_internal_lock();
bool try_acquire_internal_lock();
void release_internal_lock();
void wait_for_release_of_internal_lock();
void unblock_or_wait_on_internal_lock( uintptr_t );
};
void __TBB_EXPORTED_METHOD internal_construct();
// Mutex traits
static const bool is_rw_mutex = true;
static const bool is_recursive_mutex = false;
static const bool is_fair_mutex = true;
private:
atomic<scoped_lock*> q_tail;
};
__TBB_DEFINE_PROFILING_SET_NAME(queuing_rw_mutex)
} // namespace tbb
#include "internal/_warning_suppress_disable_notice.h"
#undef __TBB_queuing_rw_mutex_H_include_area
#endif /* __TBB_queuing_rw_mutex_H */
tbb::queuing_rw_mutex::scoped_lock::my_prev
scoped_lock *__TBB_atomic my_prev
The pointer to the previous and next competitors for a mutex.
Definition: queuing_rw_mutex.h:103
tbb::queuing_rw_mutex::scoped_lock::~scoped_lock
~scoped_lock()
Release lock (if lock is held).
Definition: queuing_rw_mutex.h:78
tbb::queuing_rw_mutex::is_fair_mutex
static const bool is_fair_mutex
Definition: queuing_rw_mutex.h:139
tbb::queuing_rw_mutex::scoped_lock::my_next
scoped_lock *__TBB_atomic *__TBB_atomic my_next
Definition: queuing_rw_mutex.h:103
tbb::queuing_rw_mutex::scoped_lock::acquire_internal_lock
void acquire_internal_lock()
Acquire the internal lock.
Definition: queuing_rw_mutex.cpp:55
tbb::queuing_rw_mutex::~queuing_rw_mutex
~queuing_rw_mutex()
Destructor asserts if the mutex is acquired, i.e. q_tail is non-NULL.
Definition: queuing_rw_mutex.h:44
tbb::queuing_rw_mutex::scoped_lock
The scoped locking pattern.
Definition: queuing_rw_mutex.h:53
__TBB_ASSERT
#define __TBB_ASSERT(predicate, comment)
No-op version of __TBB_ASSERT.
Definition: tbb_stddef.h:165
tbb::internal::no_copy
Base class for types that should not be copied or assigned.
Definition: tbb_stddef.h:330
tbb::queuing_rw_mutex::scoped_lock::my_going
unsigned char __TBB_atomic my_going
The local spin-wait variable.
Definition: queuing_rw_mutex.h:112
tbb::internal::poison_pointer
void poison_pointer(T *__TBB_atomic &)
Definition: tbb_stddef.h:305
tbb
The graph class.
Definition: serial/tbb/parallel_for.h:46
tbb::queuing_rw_mutex::scoped_lock::my_state
atomic< state_t > my_state
State of the request: reader, writer, active reader, other service states.
Definition: queuing_rw_mutex.h:108
tbb::queuing_rw_mutex::scoped_lock::release
void release()
Release lock.
Definition: queuing_rw_mutex.cpp:254
tbb::queuing_rw_mutex::scoped_lock::scoped_lock
scoped_lock(queuing_rw_mutex &m, bool write=true)
Acquire lock on given mutex.
Definition: queuing_rw_mutex.h:72
tbb::queuing_rw_mutex::scoped_lock::downgrade_to_reader
bool downgrade_to_reader()
Downgrade writer to become a reader.
Definition: queuing_rw_mutex.cpp:360
tbb::queuing_rw_mutex::is_rw_mutex
static const bool is_rw_mutex
Definition: queuing_rw_mutex.h:137
tbb_profiling.h
tbb::queuing_rw_mutex::scoped_lock::release_internal_lock
void release_internal_lock()
Release the internal lock.
Definition: queuing_rw_mutex.cpp:64
tbb::queuing_rw_mutex::is_recursive_mutex
static const bool is_recursive_mutex
Definition: queuing_rw_mutex.h:138
tbb::queuing_rw_mutex::queuing_rw_mutex
queuing_rw_mutex()
Construct unacquired mutex.
Definition: queuing_rw_mutex.h:36
__TBB_atomic
#define __TBB_atomic
Definition: tbb_stddef.h:237
tbb::queuing_rw_mutex::scoped_lock::my_internal_lock
unsigned char my_internal_lock
A tiny internal lock.
Definition: queuing_rw_mutex.h:115
tbb::queuing_rw_mutex::scoped_lock::scoped_lock
scoped_lock()
Construct lock that has not acquired a mutex.
Definition: queuing_rw_mutex.h:69
tbb::queuing_rw_mutex::internal_construct
void __TBB_EXPORTED_METHOD internal_construct()
Definition: queuing_rw_mutex.cpp:484
tbb::queuing_rw_mutex::scoped_lock::initialize
void initialize()
Initialize fields to mean "no lock held".
Definition: queuing_rw_mutex.h:55
tbb::queuing_rw_mutex::scoped_lock::unblock_or_wait_on_internal_lock
void unblock_or_wait_on_internal_lock(uintptr_t)
A helper function.
Definition: queuing_rw_mutex.cpp:74
tbb::queuing_rw_mutex::scoped_lock::try_acquire_internal_lock
bool try_acquire_internal_lock()
Try to acquire the internal lock.
Definition: queuing_rw_mutex.cpp:50
atomic.h
tbb::queuing_rw_mutex::scoped_lock::upgrade_to_writer
bool upgrade_to_writer()
Upgrade reader to become a writer.
Definition: queuing_rw_mutex.cpp:387
tbb::internal::mutex_copy_deprecated_and_disabled
Definition: tbb_stddef.h:365
_warning_suppress_disable_notice.h
tbb::queuing_rw_mutex::scoped_lock::wait_for_release_of_internal_lock
void wait_for_release_of_internal_lock()
Wait for internal lock to be released.
Definition: queuing_rw_mutex.cpp:69
tbb::queuing_rw_mutex
Queuing reader-writer mutex with local-only spinning.
Definition: queuing_rw_mutex.h:33
tbb::queuing_rw_mutex::scoped_lock::acquire
void acquire(queuing_rw_mutex &m, bool write=true)
Acquire lock on given mutex.
Definition: queuing_rw_mutex.cpp:140
tbb::queuing_rw_mutex::scoped_lock::my_mutex
queuing_rw_mutex * my_mutex
The pointer to the mutex owned, or NULL if not holding a mutex.
Definition: queuing_rw_mutex.h:100
tbb::queuing_rw_mutex::q_tail
atomic< scoped_lock * > q_tail
The last competitor requesting the lock.
Definition: queuing_rw_mutex.h:143
tbb::queuing_rw_mutex::scoped_lock::try_acquire
bool try_acquire(queuing_rw_mutex &m, bool write=true)
Acquire lock on given mutex if free (i.e. non-blocking)
Definition: queuing_rw_mutex.cpp:226
__TBB_DEFINE_PROFILING_SET_NAME
#define __TBB_DEFINE_PROFILING_SET_NAME(sync_object_type)
Definition: tbb_profiling.h:115
_warning_suppress_enable_notice.h
__TBB_EXPORTED_METHOD
#define __TBB_EXPORTED_METHOD
Definition: tbb_stddef.h:98
tbb::queuing_rw_mutex::scoped_lock::state_t
unsigned char state_t
Definition: queuing_rw_mutex.h:105

Copyright © 2005-2020 Intel Corporation. All Rights Reserved.

Intel, Pentium, Intel Xeon, Itanium, Intel XScale and VTune are registered trademarks or trademarks of Intel Corporation or its subsidiaries in the United States and other countries.

* Other names and brands may be claimed as the property of others.