Skip to content

Commit

Permalink
Added code.
Browse files Browse the repository at this point in the history
  • Loading branch information
Helios-vmg committed Aug 2, 2021
1 parent 3cd8efb commit fd0c573
Show file tree
Hide file tree
Showing 9 changed files with 691 additions and 0 deletions.
12 changes: 12 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
/msvc/.vs/
*.exe
*.pdb
*.recipe
*.ilk
*.log
*.tlog
*.o
*.lastbuildstate
*.obj
*.idb
*.user
42 changes: 42 additions & 0 deletions README.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
This is a simple multiple-reader, single-writer mutex class for C++14. Reader
locks can be upgraded and then downgraded without being released. It uses a
queue (allocated on the stack) to prevent writer starvation and to resolve lock
acquisition conflicts. Writer lock acquisition requests are always fulfilled in
FIFO order.


Usage examples:

helios::rwmutex m;

void reader(){
helios::rwlock l(m);
//reader code
}

void conditional_writer(){
helios::rwlock l(m);
//reader code
if (/*condition*/)
return;
l.upgrade();
//note: calling l.upgrade() again would throw an exception
//writer code
}

void nested_writer(){
helios::rwlock l(m);
//reader code
if (/*condition*/)
return;
{
helios::rwlock_writer_region r(l);
//writer code
}
//some more reader code
}

void unconditional_writer(){
helios::wlock l(m);
//writer code
}
2 changes: 2 additions & 0 deletions build_test.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
#!/bin/sh
c++ src/rwmutex.cpp test/test_concurrency.cpp -o test_concurrency
31 changes: 31 additions & 0 deletions msvc/rwmutex_test.sln
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@

Microsoft Visual Studio Solution File, Format Version 12.00
# Visual Studio Version 16
VisualStudioVersion = 16.0.31424.327
MinimumVisualStudioVersion = 10.0.40219.1
Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "rwmutex_test", "rwmutex_test\rwmutex_test.vcxproj", "{FEE9AC51-BB7E-4164-8581-5A4A9EBD007C}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|x64 = Debug|x64
Debug|x86 = Debug|x86
Release|x64 = Release|x64
Release|x86 = Release|x86
EndGlobalSection
GlobalSection(ProjectConfigurationPlatforms) = postSolution
{FEE9AC51-BB7E-4164-8581-5A4A9EBD007C}.Debug|x64.ActiveCfg = Debug|x64
{FEE9AC51-BB7E-4164-8581-5A4A9EBD007C}.Debug|x64.Build.0 = Debug|x64
{FEE9AC51-BB7E-4164-8581-5A4A9EBD007C}.Debug|x86.ActiveCfg = Debug|Win32
{FEE9AC51-BB7E-4164-8581-5A4A9EBD007C}.Debug|x86.Build.0 = Debug|Win32
{FEE9AC51-BB7E-4164-8581-5A4A9EBD007C}.Release|x64.ActiveCfg = Release|x64
{FEE9AC51-BB7E-4164-8581-5A4A9EBD007C}.Release|x64.Build.0 = Release|x64
{FEE9AC51-BB7E-4164-8581-5A4A9EBD007C}.Release|x86.ActiveCfg = Release|Win32
{FEE9AC51-BB7E-4164-8581-5A4A9EBD007C}.Release|x86.Build.0 = Release|Win32
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
EndGlobalSection
GlobalSection(ExtensibilityGlobals) = postSolution
SolutionGuid = {7BED76C7-7591-4569-AF6A-52168DA71F59}
EndGlobalSection
EndGlobal
151 changes: 151 additions & 0 deletions msvc/rwmutex_test/rwmutex_test.vcxproj
Original file line number Diff line number Diff line change
@@ -0,0 +1,151 @@
<?xml version="1.0" encoding="utf-8"?>
<Project DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
<ItemGroup Label="ProjectConfigurations">
<ProjectConfiguration Include="Debug|Win32">
<Configuration>Debug</Configuration>
<Platform>Win32</Platform>
</ProjectConfiguration>
<ProjectConfiguration Include="Release|Win32">
<Configuration>Release</Configuration>
<Platform>Win32</Platform>
</ProjectConfiguration>
<ProjectConfiguration Include="Debug|x64">
<Configuration>Debug</Configuration>
<Platform>x64</Platform>
</ProjectConfiguration>
<ProjectConfiguration Include="Release|x64">
<Configuration>Release</Configuration>
<Platform>x64</Platform>
</ProjectConfiguration>
</ItemGroup>
<ItemGroup>
<ClCompile Include="..\..\src\rwmutex.cpp" />
<ClCompile Include="..\..\test\test_concurrency.cpp" />
</ItemGroup>
<ItemGroup>
<ClInclude Include="..\..\src\rwmutex.hpp" />
</ItemGroup>
<PropertyGroup Label="Globals">
<VCProjectVersion>16.0</VCProjectVersion>
<Keyword>Win32Proj</Keyword>
<ProjectGuid>{fee9ac51-bb7e-4164-8581-5a4a9ebd007c}</ProjectGuid>
<RootNamespace>rwmutextest</RootNamespace>
<WindowsTargetPlatformVersion>10.0</WindowsTargetPlatformVersion>
</PropertyGroup>
<Import Project="$(VCTargetsPath)\Microsoft.Cpp.Default.props" />
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'" Label="Configuration">
<ConfigurationType>Application</ConfigurationType>
<UseDebugLibraries>true</UseDebugLibraries>
<PlatformToolset>v142</PlatformToolset>
<CharacterSet>Unicode</CharacterSet>
</PropertyGroup>
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|Win32'" Label="Configuration">
<ConfigurationType>Application</ConfigurationType>
<UseDebugLibraries>false</UseDebugLibraries>
<PlatformToolset>v142</PlatformToolset>
<WholeProgramOptimization>true</WholeProgramOptimization>
<CharacterSet>Unicode</CharacterSet>
</PropertyGroup>
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'" Label="Configuration">
<ConfigurationType>Application</ConfigurationType>
<UseDebugLibraries>true</UseDebugLibraries>
<PlatformToolset>v142</PlatformToolset>
<CharacterSet>Unicode</CharacterSet>
</PropertyGroup>
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'" Label="Configuration">
<ConfigurationType>Application</ConfigurationType>
<UseDebugLibraries>false</UseDebugLibraries>
<PlatformToolset>v142</PlatformToolset>
<WholeProgramOptimization>true</WholeProgramOptimization>
<CharacterSet>Unicode</CharacterSet>
</PropertyGroup>
<Import Project="$(VCTargetsPath)\Microsoft.Cpp.props" />
<ImportGroup Label="ExtensionSettings">
</ImportGroup>
<ImportGroup Label="Shared">
</ImportGroup>
<ImportGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">
<Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" />
</ImportGroup>
<ImportGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Release|Win32'">
<Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" />
</ImportGroup>
<ImportGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">
<Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" />
</ImportGroup>
<ImportGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Release|x64'">
<Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" />
</ImportGroup>
<PropertyGroup Label="UserMacros" />
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">
<LinkIncremental>true</LinkIncremental>
</PropertyGroup>
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|Win32'">
<LinkIncremental>false</LinkIncremental>
</PropertyGroup>
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">
<LinkIncremental>true</LinkIncremental>
</PropertyGroup>
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'">
<LinkIncremental>false</LinkIncremental>
</PropertyGroup>
<ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">
<ClCompile>
<WarningLevel>Level3</WarningLevel>
<SDLCheck>true</SDLCheck>
<PreprocessorDefinitions>WIN32;_DEBUG;_CONSOLE;%(PreprocessorDefinitions)</PreprocessorDefinitions>
<ConformanceMode>true</ConformanceMode>
</ClCompile>
<Link>
<SubSystem>Console</SubSystem>
<GenerateDebugInformation>true</GenerateDebugInformation>
</Link>
</ItemDefinitionGroup>
<ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Release|Win32'">
<ClCompile>
<WarningLevel>Level3</WarningLevel>
<FunctionLevelLinking>true</FunctionLevelLinking>
<IntrinsicFunctions>true</IntrinsicFunctions>
<SDLCheck>true</SDLCheck>
<PreprocessorDefinitions>WIN32;NDEBUG;_CONSOLE;%(PreprocessorDefinitions)</PreprocessorDefinitions>
<ConformanceMode>true</ConformanceMode>
</ClCompile>
<Link>
<SubSystem>Console</SubSystem>
<EnableCOMDATFolding>true</EnableCOMDATFolding>
<OptimizeReferences>true</OptimizeReferences>
<GenerateDebugInformation>true</GenerateDebugInformation>
</Link>
</ItemDefinitionGroup>
<ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">
<ClCompile>
<WarningLevel>Level3</WarningLevel>
<SDLCheck>true</SDLCheck>
<PreprocessorDefinitions>_DEBUG;_CONSOLE;%(PreprocessorDefinitions)</PreprocessorDefinitions>
<ConformanceMode>true</ConformanceMode>
</ClCompile>
<Link>
<SubSystem>Console</SubSystem>
<GenerateDebugInformation>true</GenerateDebugInformation>
</Link>
</ItemDefinitionGroup>
<ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'">
<ClCompile>
<WarningLevel>Level3</WarningLevel>
<FunctionLevelLinking>true</FunctionLevelLinking>
<IntrinsicFunctions>true</IntrinsicFunctions>
<SDLCheck>true</SDLCheck>
<PreprocessorDefinitions>NDEBUG;_CONSOLE;%(PreprocessorDefinitions)</PreprocessorDefinitions>
<ConformanceMode>true</ConformanceMode>
</ClCompile>
<Link>
<SubSystem>Console</SubSystem>
<EnableCOMDATFolding>true</EnableCOMDATFolding>
<OptimizeReferences>true</OptimizeReferences>
<GenerateDebugInformation>true</GenerateDebugInformation>
</Link>
</ItemDefinitionGroup>
<Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
<ImportGroup Label="ExtensionTargets">
</ImportGroup>
</Project>
30 changes: 30 additions & 0 deletions msvc/rwmutex_test/rwmutex_test.vcxproj.filters
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
<?xml version="1.0" encoding="utf-8"?>
<Project ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
<ItemGroup>
<Filter Include="Source Files">
<UniqueIdentifier>{4FC737F1-C7A5-4376-A066-2A32D752A2FF}</UniqueIdentifier>
<Extensions>cpp;c;cc;cxx;c++;cppm;ixx;def;odl;idl;hpj;bat;asm;asmx</Extensions>
</Filter>
<Filter Include="Header Files">
<UniqueIdentifier>{93995380-89BD-4b04-88EB-625FBE52EBFB}</UniqueIdentifier>
<Extensions>h;hh;hpp;hxx;h++;hm;inl;inc;ipp;xsd</Extensions>
</Filter>
<Filter Include="Resource Files">
<UniqueIdentifier>{67DA6AB6-F800-4c08-8B7A-83BB121AAD01}</UniqueIdentifier>
<Extensions>rc;ico;cur;bmp;dlg;rc2;rct;bin;rgs;gif;jpg;jpeg;jpe;resx;tiff;tif;png;wav;mfcribbon-ms</Extensions>
</Filter>
</ItemGroup>
<ItemGroup>
<ClCompile Include="..\..\test\test_concurrency.cpp">
<Filter>Source Files</Filter>
</ClCompile>
<ClCompile Include="..\..\src\rwmutex.cpp">
<Filter>Source Files</Filter>
</ClCompile>
</ItemGroup>
<ItemGroup>
<ClInclude Include="..\..\src\rwmutex.hpp">
<Filter>Header Files</Filter>
</ClInclude>
</ItemGroup>
</Project>
115 changes: 115 additions & 0 deletions src/rwmutex.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
#include "rwmutex.hpp"
#include <stdexcept>

namespace helios{

rwlock::rwlock(rwmutex &m): m(m){
node.id = std::this_thread::get_id();
m.lock_reader(node);
state = 1;
}

rwlock::~rwlock(){
if (state == 1)
m.unlock_reader(node);
else
m.unlock_writer(node);
}

void rwlock::upgrade(){
if (state != 1)
throw std::runtime_error("incorrect use");
m.upgrade();
state = 2;
}

void rwlock::downgrade(){
if (state != 2)
throw std::runtime_error("incorrect use");
m.upgrade();
state = 1;
}

void rwmutex::lock_reader(rwlock_node &node){
UL lg(m);
push(node);
while (state == 2)
cv.wait(lg);
state = 1;
}

void rwmutex::unlock_reader(rwlock_node &node){
UL lg(m);
remove(node);
if (!queue_size)
state = 0;
cv.notify_all();
}

void rwmutex::upgrade(){
auto id = std::this_thread::get_id();
UL lg(m);
writers_waiting++;
cv.notify_all();
while (queue_head->id != id)
cv.wait(lg);
while (queue_size > writers_waiting && state != 0)
cv.wait(lg);
writers_waiting--;
state = 2;
}

void rwmutex::downgrade(){
UL lg(m);
state = 1;
cv.notify_all();
}

void rwmutex::lock_writer(rwlock_node &node){
auto id = std::this_thread::get_id();
UL lg(m);
push(node);
writers_waiting++;
cv.notify_all();
while (queue_head->id != id)
cv.wait(lg);
while (queue_size > writers_waiting && state != 0)
cv.wait(lg);
writers_waiting--;
state = 2;
}

void rwmutex::unlock_writer(rwlock_node &node){
UL lg(m);
remove(node);
state = !!queue_size;
cv.notify_all();
}

void rwmutex::push(rwlock_node &node){
queue_size++;
node.next = nullptr;
if (queue_size == 1){
queue_head = &node;
queue_tail = &node;
node.previous = nullptr;
return;
}
queue_tail->next = &node;
node.previous = queue_tail;
queue_tail = &node;
}

void rwmutex::remove(rwlock_node &node){
queue_size--;
if (node.previous)
node.previous->next = node.next;
else
queue_head = node.next;
if (node.next)
node.next->previous = node.previous;
else
queue_tail = node.previous;
}

}
Loading

0 comments on commit fd0c573

Please sign in to comment.