api/rmm-api/RegMutex_8h_source.html

#pragma once


#include <RMMLog.h>

#include <RMMUtils.h>


#include <cstdarg>

#include <list>

#include <memory>

#include <mutex>

#include <string>

#include <unordered_map>


using MutStrPair = std::pair<std::shared_ptr<std::recursive_mutex>, std::string>;

using MutexMap = std::unordered_map<std::string, MutStrPair>;

using RegLockGuard = std::unique_lock<std::recursive_mutex>;

using FENRegMap = std::unordered_map<std::string, uint32_t>;


class RegMutex : public RMMLog {

 public:

  bool lock(std::string reg, bool critic = true);

  bool unlock(std::string reg, bool critic = true);

  bool addReg(std::string reg, std::string tag = "NoTag", bool critic = true);

  unsigned int addRegs(std::list<std::string> regs, bool critic = true);

  unsigned int removeReg(std::string reg, bool critic = true);

  unsigned int removeRegs(std::list<std::string> regs, bool critic = true);

  RegLockGuard lockGuard(std::string reg, std::string tag = "NoTag");

  RegMutex(FENRegMap map);

  RegMutex(std::list<FENRegMap> registers);

  RegMutex(std::list<std::shared_ptr<FENRegMap>> registers);

  void printRegisters();


 private:

  std::mutex mapMut;

  void addMap(FENRegMap registers);

  MutexMap mutMap;


  friend class RMMRegisterAccess;

};


RMMLog::RMMLog
RMMLog(const char *name)
Constructs the RMMLog object with a name for the log.
Definition RMMLog.cpp:30

RegMutex::lockGuard
RegLockGuard lockGuard(std::string reg, std::string tag="NoTag")
returns a lock guard object for that register mutex.
Definition RegMutex.cpp:185

RegMutex::addRegs
unsigned int addRegs(std::list< std::string > regs, bool critic=true)
Calls addReg for each register address of a list of strings.
Definition RegMutex.cpp:82

RegMutex::addReg
bool addReg(std::string reg, std::string tag="NoTag", bool critic=true)
Adds a register to the map, initializing a mutex to it.
Definition RegMutex.cpp:62

RegMutex::removeReg
unsigned int removeReg(std::string reg, bool critic=true)
Removes a register from the map, destroying it's mutex.
Definition RegMutex.cpp:98

RegMutex::RegMutex
RegMutex(FENRegMap map)
Constructor that uses one register map. It will throw an exception if there are duplicate register ad...
Definition RegMutex.cpp:32

RegMutex::removeRegs
unsigned int removeRegs(std::list< std::string > regs, bool critic=true)
Calls removeReg for each register address of a list of strings.
Definition RegMutex.cpp:118

RegMutex::printRegisters
void printRegisters()
prints registers and addresses inside internal list. Mostly used for debugging purposes.
Definition RegMutex.cpp:130

RegMutex::unlock
bool unlock(std::string reg, bool critic=true)
Receives a string representing a register address. Unlocks the mutex associated with it....
Definition RegMutex.cpp:164

RegMutex::lock
bool lock(std::string reg, bool critic=true)
Receives a string representing a register address. Locks the mutex associated with it....
Definition RegMutex.cpp:144