Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Use lock guards suitable for configurable mutex implementations #179

Merged
merged 3 commits into from
Jun 21, 2024
Merged

Use lock guards suitable for configurable mutex implementations #179

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b77e796
Fix incorrect mutex implementation selector when futexes are desired
mattrm456 Jun 21, 2024
23ad442
Rename futex implementation from ntccfg::Mutex to Futex and typedef t…
mattrm456 Jun 21, 2024
96982ba
Use lock guards suitable for configurable mutex implementations
mattrm456 Jun 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions groups/ntc/ntccfg/ntccfg_mutex.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ namespace ntccfg {
#if NTCCFG_FUTEX_ENABLED

// Some versions of GCC issue a spurious warning that the 'current' paramter
// is set but not used when 'Mutex::compareAndSwap' is called.
// is set but not used when 'Futex::compareAndSwap' is called.
#if defined(BSLS_PLATFORM_CMP_GNU)
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wunused-but-set-parameter"
Expand All @@ -51,7 +51,7 @@ __attribute__((noinline)) void Futex::wake()
syscall(SYS_futex, (int*)(&d_value), FUTEX_WAKE, 1, 0, 0, 0);
}

__attribute__((noinline)) void Mutex::lockContention(int c)
__attribute__((noinline)) void Futex::lockContention(int c)
{
do {
if (c == 2 || compareAndSwap(&d_value, 1, 2) != 0) {
Expand Down
14 changes: 7 additions & 7 deletions groups/ntc/ntccfg/ntccfg_mutex.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ namespace ntccfg {
#if NTCCFG_FUTEX_ENABLED

// Some versions of GCC issue a spurious warning that the 'current' paramter
// is set but not used when 'Mutex::compareAndSwap' is called.
// is set but not used when 'Futex::compareAndSwap' is called.
#if defined(BSLS_PLATFORM_CMP_GNU)
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wunused-but-set-parameter"
Expand Down Expand Up @@ -99,7 +99,7 @@ class __attribute__((__aligned__(sizeof(int)))) Futex
};

NTCCFG_INLINE
int Mutex::compareAndSwap(int* current, int expected, int desired)
int Futex::compareAndSwap(int* current, int expected, int desired)
{
int* ep = &expected;
int* dp = &desired;
Expand All @@ -115,18 +115,18 @@ int Mutex::compareAndSwap(int* current, int expected, int desired)
}

NTCCFG_INLINE
Mutex::Mutex()
Futex::Futex()
{
__atomic_store_n(&d_value, 0, __ATOMIC_RELAXED);
}

NTCCFG_INLINE
Mutex::~Mutex()
Futex::~Futex()
{
}

NTCCFG_INLINE
void Mutex::lock()
void Futex::lock()
{
int previous = compareAndSwap(&d_value, 0, 1);
if (previous != 0) {
Expand All @@ -135,7 +135,7 @@ void Mutex::lock()
}

NTCCFG_INLINE
void Mutex::unlock()
void Futex::unlock()
{
int previous = __atomic_fetch_sub(&d_value, 1, __ATOMIC_SEQ_CST);
if (previous != 1) {
Expand Down Expand Up @@ -345,7 +345,7 @@ typedef bslmt::LockGuard<ntccfg::SpinLock> LockGuard;
/// @ingroup module_ntccfg
typedef bslmt::UnLockGuard<ntccfg::SpinLock> UnLockGuard;

#elif NTCCFG_MUTEX_IMPL == NTCCFG_MUTEX_IMPL_BSLMT_FUTEX
#elif NTCCFG_MUTEX_IMPL == NTCCFG_MUTEX_IMPL_FUTEX

/// @internal @brief
/// Provide a synchronization primitive for mutually-exclusive access.
Expand Down
26 changes: 13 additions & 13 deletions groups/ntc/ntcp/ntcp_interface.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -335,7 +335,7 @@ ntsa::Error Interface::addThread()
bsl::shared_ptr<ntci::Proactor> Interface::acquireProactorUsedByThreadHandle(
const ntca::LoadBalancingOptions& options)
{
bslmt::LockGuard<bslmt::Mutex> lock(&d_mutex);
LockGuard lock(&d_mutex);

bsl::shared_ptr<ntci::Proactor> result;

Expand Down Expand Up @@ -366,7 +366,7 @@ bsl::shared_ptr<ntci::Proactor> Interface::acquireProactorUsedByThreadHandle(
bsl::shared_ptr<ntci::Proactor> Interface::acquireProactorUsedByThreadIndex(
const ntca::LoadBalancingOptions& options)
{
bslmt::LockGuard<bslmt::Mutex> lock(&d_mutex);
LockGuard lock(&d_mutex);

bsl::shared_ptr<ntci::Proactor> result;

Expand Down Expand Up @@ -401,7 +401,7 @@ bsl::shared_ptr<ntci::Proactor> Interface::acquireProactorUsedByThreadIndex(
bsl::shared_ptr<ntci::Proactor> Interface::acquireProactorWithLeastLoad(
const ntca::LoadBalancingOptions& options)
{
bslmt::LockGuard<bslmt::Mutex> lock(&d_mutex);
LockGuard lock(&d_mutex);

NTCI_LOG_CONTEXT();

Expand Down Expand Up @@ -563,7 +563,7 @@ ntsa::Error Interface::start()
bsl::shared_ptr<ntci::Resolver> resolver;

{
bslmt::LockGuard<bslmt::Mutex> lock(&d_mutex);
LockGuard lock(&d_mutex);

if (!d_resolver_sp) {
BSLS_ASSERT_OPT(!d_config.resolverEnabled().isNull());
Expand Down Expand Up @@ -618,7 +618,7 @@ void Interface::shutdown()
bsl::shared_ptr<ntci::Resolver> resolver;
ProactorVector proactorVector(d_allocator_p);
{
bslmt::LockGuard<bslmt::Mutex> lock(&d_mutex);
LockGuard lock(&d_mutex);

resolver = d_resolver_sp;
proactorVector = d_proactorVector;
Expand All @@ -645,7 +645,7 @@ void Interface::linger()
ThreadVector threadVector(d_allocator_p);
ProactorVector proactorVector(d_allocator_p);
{
bslmt::LockGuard<bslmt::Mutex> lock(&d_mutex);
LockGuard lock(&d_mutex);

resolver = d_resolver_sp;
threadVector = d_threadVector;
Expand Down Expand Up @@ -681,7 +681,7 @@ void Interface::linger()
proactorVector.clear();

{
bslmt::LockGuard<bslmt::Mutex> lock(&d_mutex);
LockGuard lock(&d_mutex);

d_threadVector.clear();
d_threadMap.clear();
Expand All @@ -698,7 +698,7 @@ ntsa::Error Interface::closeAll()

ProactorVector proactorVector(d_allocator_p);
{
bslmt::LockGuard<bslmt::Mutex> lock(&d_mutex);
LockGuard lock(&d_mutex);
proactorVector = d_proactorVector;
}

Expand Down Expand Up @@ -1489,7 +1489,7 @@ void Interface::releaseHandleReservation()

bool Interface::expand()
{
bslmt::LockGuard<bslmt::Mutex> lock(&d_mutex);
LockGuard lock(&d_mutex);

NTCI_LOG_CONTEXT();

Expand All @@ -1510,13 +1510,13 @@ bool Interface::expand()

bsl::size_t Interface::numProactors() const
{
bslmt::LockGuard<bslmt::Mutex> lock(&d_mutex);
LockGuard lock(&d_mutex);
return d_proactorVector.size();
}

bsl::size_t Interface::numThreads() const
{
bslmt::LockGuard<bslmt::Mutex> lock(&d_mutex);
LockGuard lock(&d_mutex);
return d_threadVector.size();
}

Expand Down Expand Up @@ -1544,7 +1544,7 @@ bool Interface::lookupByThreadHandle(
bsl::shared_ptr<ntci::Executor>* result,
bslmt::ThreadUtil::Handle threadHandle) const
{
bslmt::LockGuard<bslmt::Mutex> lock(&d_mutex);
LockGuard lock(&d_mutex);

result->reset();

Expand Down Expand Up @@ -1575,7 +1575,7 @@ bool Interface::lookupByThreadHandle(
bool Interface::lookupByThreadIndex(bsl::shared_ptr<ntci::Executor>* result,
bsl::size_t threadIndex) const
{
bslmt::LockGuard<bslmt::Mutex> lock(&d_mutex);
LockGuard lock(&d_mutex);

result->reset();

Expand Down
38 changes: 19 additions & 19 deletions groups/ntc/ntcp/ntcp_interface.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,28 +76,28 @@ class Interface : public ntci::Interface,
/// Define a type alias for a vector of proactors.
typedef bsl::vector<bsl::shared_ptr<ntci::Proactor> > ProactorVector;

ntccfg::Object d_object;

mutable ntccfg::Mutex d_mutex;

bsl::shared_ptr<ntcs::User> d_user_sp;
bsl::shared_ptr<ntci::DataPool> d_dataPool_sp;
bsl::shared_ptr<ntci::Resolver> d_resolver_sp;

bsl::shared_ptr<ntci::Reservation> d_connectionLimiter_sp;
bsl::shared_ptr<ntcs::Metrics> d_socketMetrics_sp;

// Define a type alias for a mutex.
typedef ntccfg::Mutex Mutex;

/// Define a type alias for a mutex lock guard.
typedef ntccfg::LockGuard LockGuard;

ntccfg::Object d_object;
mutable Mutex d_mutex;
bsl::shared_ptr<ntcs::User> d_user_sp;
bsl::shared_ptr<ntci::DataPool> d_dataPool_sp;
bsl::shared_ptr<ntci::Resolver> d_resolver_sp;
bsl::shared_ptr<ntci::Reservation> d_connectionLimiter_sp;
bsl::shared_ptr<ntcs::Metrics> d_socketMetrics_sp;
bsl::shared_ptr<ntci::ProactorFactory> d_proactorFactory_sp;
bsl::shared_ptr<ntci::ProactorMetrics> d_proactorMetrics_sp;
ProactorVector d_proactorVector;

ThreadVector d_threadVector;
ThreadMap d_threadMap;
bslmt::Semaphore d_threadSemaphore;
bsl::size_t d_threadWatermark;

ntca::InterfaceConfig d_config;
bslma::Allocator* d_allocator_p;
ThreadVector d_threadVector;
ThreadMap d_threadMap;
bslmt::Semaphore d_threadSemaphore;
bsl::size_t d_threadWatermark;
ntca::InterfaceConfig d_config;
bslma::Allocator* d_allocator_p;

private:
Interface(const Interface&) BSLS_KEYWORD_DELETED;
Expand Down
26 changes: 13 additions & 13 deletions groups/ntc/ntcr/ntcr_interface.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -344,7 +344,7 @@ ntsa::Error Interface::addThread()
bsl::shared_ptr<ntci::Reactor> Interface::acquireReactorUsedByThreadHandle(
const ntca::LoadBalancingOptions& options)
{
bslmt::LockGuard<bslmt::Mutex> lock(&d_mutex);
LockGuard lock(&d_mutex);

bsl::shared_ptr<ntci::Reactor> result;

Expand Down Expand Up @@ -375,7 +375,7 @@ bsl::shared_ptr<ntci::Reactor> Interface::acquireReactorUsedByThreadHandle(
bsl::shared_ptr<ntci::Reactor> Interface::acquireReactorUsedByThreadIndex(
const ntca::LoadBalancingOptions& options)
{
bslmt::LockGuard<bslmt::Mutex> lock(&d_mutex);
LockGuard lock(&d_mutex);

bsl::shared_ptr<ntci::Reactor> result;

Expand Down Expand Up @@ -410,7 +410,7 @@ bsl::shared_ptr<ntci::Reactor> Interface::acquireReactorUsedByThreadIndex(
bsl::shared_ptr<ntci::Reactor> Interface::acquireReactorWithLeastLoad(
const ntca::LoadBalancingOptions& options)
{
bslmt::LockGuard<bslmt::Mutex> lock(&d_mutex);
LockGuard lock(&d_mutex);

NTCI_LOG_CONTEXT();

Expand Down Expand Up @@ -572,7 +572,7 @@ ntsa::Error Interface::start()
bsl::shared_ptr<ntci::Resolver> resolver;

{
bslmt::LockGuard<bslmt::Mutex> lock(&d_mutex);
LockGuard lock(&d_mutex);

if (!d_resolver_sp) {
BSLS_ASSERT_OPT(!d_config.resolverEnabled().isNull());
Expand Down Expand Up @@ -627,7 +627,7 @@ void Interface::shutdown()
bsl::shared_ptr<ntci::Resolver> resolver;
ReactorVector reactorVector(d_allocator_p);
{
bslmt::LockGuard<bslmt::Mutex> lock(&d_mutex);
LockGuard lock(&d_mutex);

resolver = d_resolver_sp;
reactorVector = d_reactorVector;
Expand All @@ -654,7 +654,7 @@ void Interface::linger()
ThreadVector threadVector(d_allocator_p);
ReactorVector reactorVector(d_allocator_p);
{
bslmt::LockGuard<bslmt::Mutex> lock(&d_mutex);
LockGuard lock(&d_mutex);

resolver = d_resolver_sp;
threadVector = d_threadVector;
Expand Down Expand Up @@ -690,7 +690,7 @@ void Interface::linger()
reactorVector.clear();

{
bslmt::LockGuard<bslmt::Mutex> lock(&d_mutex);
LockGuard lock(&d_mutex);

d_threadVector.clear();
d_threadMap.clear();
Expand All @@ -707,7 +707,7 @@ ntsa::Error Interface::closeAll()

ReactorVector reactorVector(d_allocator_p);
{
bslmt::LockGuard<bslmt::Mutex> lock(&d_mutex);
LockGuard lock(&d_mutex);
reactorVector = d_reactorVector;
}

Expand Down Expand Up @@ -1499,7 +1499,7 @@ void Interface::releaseHandleReservation()

bool Interface::expand()
{
bslmt::LockGuard<bslmt::Mutex> lock(&d_mutex);
LockGuard lock(&d_mutex);

NTCI_LOG_CONTEXT();

Expand All @@ -1520,13 +1520,13 @@ bool Interface::expand()

bsl::size_t Interface::numReactors() const
{
bslmt::LockGuard<bslmt::Mutex> lock(&d_mutex);
LockGuard lock(&d_mutex);
return d_reactorVector.size();
}

bsl::size_t Interface::numThreads() const
{
bslmt::LockGuard<bslmt::Mutex> lock(&d_mutex);
LockGuard lock(&d_mutex);
return d_threadVector.size();
}

Expand Down Expand Up @@ -1554,7 +1554,7 @@ bool Interface::lookupByThreadHandle(
bsl::shared_ptr<ntci::Executor>* result,
bslmt::ThreadUtil::Handle threadHandle) const
{
bslmt::LockGuard<bslmt::Mutex> lock(&d_mutex);
LockGuard lock(&d_mutex);

result->reset();

Expand Down Expand Up @@ -1585,7 +1585,7 @@ bool Interface::lookupByThreadHandle(
bool Interface::lookupByThreadIndex(bsl::shared_ptr<ntci::Executor>* result,
bsl::size_t threadIndex) const
{
bslmt::LockGuard<bslmt::Mutex> lock(&d_mutex);
LockGuard lock(&d_mutex);

result->reset();

Expand Down
Loading
Loading