lock.h

Go to the documentation of this file.

/******************************************************************************
 * Copyright 2020 ETC Inc.
 *
 * 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.
 *******************************************************************************
 * This file is a part of EtcPal. For more information, go to:
 * https://github.com/ETCLabs/EtcPal
 ******************************************************************************/
 
 
#ifndef ETCPAL_CPP_LOCK_H_
#define ETCPAL_CPP_LOCK_H_
 
#include <stdexcept>
#include "etcpal/cpp/common.h"
#include "etcpal/lock.h"
 
namespace etcpal
{
 
class Mutex
{
public:
  Mutex();
  ~Mutex();
 
  Mutex(const Mutex& other) = delete;
  Mutex& operator=(const Mutex& other) = delete;
  Mutex(Mutex&& other) = delete;
  Mutex& operator=(Mutex&& other) = delete;
 
  bool Lock();
  bool TryLock(int timeout_ms = 0);
  void Unlock();
 
  etcpal_mutex_t& get();
 
private:
  etcpal_mutex_t mutex_{};
};
 
inline Mutex::Mutex()
{
  (void)etcpal_mutex_create(&mutex_);
}
 
inline Mutex::~Mutex()
{
  etcpal_mutex_destroy(&mutex_);
}
 
inline bool Mutex::Lock()
{
  return etcpal_mutex_lock(&mutex_);
}
 
inline bool Mutex::TryLock(int timeout_ms)
{
  return etcpal_mutex_timed_lock(&mutex_, timeout_ms);
}
 
inline void Mutex::Unlock()
{
  etcpal_mutex_unlock(&mutex_);
}
 
inline etcpal_mutex_t& Mutex::get()
{
  return mutex_;
}
 
class Signal
{
public:
  Signal();
  ~Signal();
 
  Signal(const Signal& other) = delete;
  Signal& operator=(const Signal& other) = delete;
  Signal(Signal&& other) = delete;
  Signal& operator=(Signal&& other) = delete;
 
  bool Wait();
  bool TryWait(int timeout_ms = 0);
  void Notify();
  void NotifyFromIsr();
 
  etcpal_signal_t& get();
 
private:
  etcpal_signal_t signal_{};
};
 
inline Signal::Signal()
{
  (void)etcpal_signal_create(&signal_);
}
 
inline Signal::~Signal()
{
  etcpal_signal_destroy(&signal_);
}
 
inline bool Signal::Wait()
{
  return etcpal_signal_wait(&signal_);
}
 
inline bool Signal::TryWait(int timeout_ms)
{
  return etcpal_signal_timed_wait(&signal_, timeout_ms);
}
 
inline void Signal::Notify()
{
  etcpal_signal_post(&signal_);
}
 
inline void Signal::NotifyFromIsr()
{
  etcpal_signal_post_from_isr(&signal_);
}
 
inline etcpal_signal_t& Signal::get()
{
  return signal_;
}
 
class RwLock
{
public:
  RwLock();
  ~RwLock();
 
  RwLock(const RwLock& other) = delete;
  RwLock& operator=(const RwLock& other) = delete;
  RwLock(RwLock&& other) = delete;
  RwLock& operator=(RwLock&& other) = delete;
 
  bool ReadLock();
  bool TryReadLock(int timeout_ms = 0);
  void ReadUnlock();
 
  bool WriteLock();
  bool TryWriteLock(int timeout_ms = 0);
  void WriteUnlock();
 
  etcpal_rwlock_t& get();
 
private:
  etcpal_rwlock_t rwlock_{};
};
 
inline RwLock::RwLock()
{
  (void)etcpal_rwlock_create(&rwlock_);
}
 
inline RwLock::~RwLock()
{
  etcpal_rwlock_destroy(&rwlock_);
}
 
inline bool RwLock::ReadLock()
{
  return etcpal_rwlock_readlock(&rwlock_);
}
 
inline bool RwLock::TryReadLock(int timeout_ms)
{
  return etcpal_rwlock_timed_readlock(&rwlock_, timeout_ms);
}
 
inline void RwLock::ReadUnlock()
{
  etcpal_rwlock_readunlock(&rwlock_);
}
 
inline bool RwLock::WriteLock()
{
  return etcpal_rwlock_writelock(&rwlock_);
}
 
inline bool RwLock::TryWriteLock(int timeout_ms)
{
  return etcpal_rwlock_timed_writelock(&rwlock_, timeout_ms);
}
 
inline void RwLock::WriteUnlock()
{
  etcpal_rwlock_writeunlock(&rwlock_);
}
 
inline etcpal_rwlock_t& RwLock::get()
{
  return rwlock_;
}
 
class Semaphore
{
public:
  static constexpr unsigned int kDefaultMaxCount = 50;
 
  Semaphore(unsigned int initial_count = 0, unsigned int max_count = kDefaultMaxCount);
  ~Semaphore();
 
  Semaphore(const Semaphore& other) = delete;
  Semaphore& operator=(const Semaphore& other) = delete;
  Semaphore(Semaphore&& other) = delete;
  Semaphore& operator=(Semaphore&& other) = delete;
 
  bool Wait();
  bool TryWait(int timeout_ms = 0);
  bool Post();
  bool PostFromIsr();
 
  etcpal_sem_t& get();
 
private:
  etcpal_sem_t sem_{};
};
 
inline Semaphore::Semaphore(unsigned int initial_count, unsigned int max_count)
{
  (void)etcpal_sem_create(&sem_, initial_count, max_count);
}
 
inline Semaphore::~Semaphore()
{
  etcpal_sem_destroy(&sem_);
}
 
inline bool Semaphore::Wait()
{
  return etcpal_sem_wait(&sem_);
}
 
inline bool Semaphore::TryWait(int timeout_ms)
{
  return etcpal_sem_timed_wait(&sem_, timeout_ms);
}
 
inline bool Semaphore::Post()
{
  return etcpal_sem_post(&sem_);
}
 
inline bool Semaphore::PostFromIsr()
{
  return etcpal_sem_post_from_isr(&sem_);
}
 
inline etcpal_sem_t& Semaphore::get()
{
  return sem_;
}
 
 
class MutexGuard
{
public:
  explicit MutexGuard(Mutex& mutex);
  explicit MutexGuard(etcpal_mutex_t& mutex);
  ~MutexGuard();
 
  MutexGuard(const MutexGuard& other) = delete;
  MutexGuard& operator=(const MutexGuard& other) = delete;
  MutexGuard(MutexGuard&& other) = delete;
  MutexGuard& operator=(MutexGuard&& other) = delete;
 
private:
  etcpal_mutex_t& mutex_;
 
  void GetLock();
};
 
inline MutexGuard::MutexGuard(Mutex& mutex) : mutex_(mutex.get())
{
  GetLock();
}
 
inline MutexGuard::MutexGuard(etcpal_mutex_t& mutex) : mutex_(mutex)
{
  GetLock();
}
 
inline MutexGuard::~MutexGuard()
{
  etcpal_mutex_unlock(&mutex_);
}
 
inline void MutexGuard::GetLock()
{
  if (!etcpal_mutex_lock(&mutex_))
    ETCPAL_THROW(std::runtime_error("etcpal_mutex_lock failed."));
}
 
class ReadGuard
{
public:
  explicit ReadGuard(RwLock& rwlock);
  explicit ReadGuard(etcpal_rwlock_t& rwlock);
  ~ReadGuard();
 
  ReadGuard(const ReadGuard& other) = delete;
  ReadGuard& operator=(const ReadGuard& other) = delete;
  ReadGuard(ReadGuard&& other) = delete;
  ReadGuard& operator=(ReadGuard&& other) = delete;
 
private:
  etcpal_rwlock_t& rwlock_;
 
  void GetReadLock();
};
 
inline ReadGuard::ReadGuard(RwLock& rwlock) : rwlock_(rwlock.get())
{
  GetReadLock();
}
 
inline ReadGuard::ReadGuard(etcpal_rwlock_t& rwlock) : rwlock_(rwlock)
{
  GetReadLock();
}
 
inline ReadGuard::~ReadGuard()
{
  etcpal_rwlock_readunlock(&rwlock_);
}
 
inline void ReadGuard::GetReadLock()
{
  if (!etcpal_rwlock_readlock(&rwlock_))
    ETCPAL_THROW(std::runtime_error("etcpal_rwlock_readlock failed."));
}
 
class WriteGuard
{
public:
  explicit WriteGuard(RwLock& rwlock);
  explicit WriteGuard(etcpal_rwlock_t& rwlock);
  ~WriteGuard();
 
  WriteGuard(const WriteGuard& other) = delete;
  WriteGuard& operator=(const WriteGuard& other) = delete;
  WriteGuard(WriteGuard&& other) = delete;
  WriteGuard& operator=(WriteGuard&& other) = delete;
 
private:
  etcpal_rwlock_t& rwlock_;
 
  void GetWriteLock();
};
 
inline WriteGuard::WriteGuard(RwLock& rwlock) : rwlock_(rwlock.get())
{
  GetWriteLock();
}
 
inline WriteGuard::WriteGuard(etcpal_rwlock_t& rwlock) : rwlock_(rwlock)
{
  GetWriteLock();
}
 
inline WriteGuard::~WriteGuard()
{
  etcpal_rwlock_writeunlock(&rwlock_);
}
 
inline void WriteGuard::GetWriteLock()
{
  if (!etcpal_rwlock_writelock(&rwlock_))
    ETCPAL_THROW(std::runtime_error("etcpal_rwlock_writelock failed."));
}
 
 
};  // namespace etcpal
 
#endif  // ETCPAL_CPP_LOCK_H_