diff options
| author | Jenkins nedprod CI <foo@nowhere> | 2017-07-29 21:54:44 +0300 |
|---|---|---|
| committer | Jenkins nedprod CI <foo@nowhere> | 2017-07-29 21:54:44 +0300 |
| commit | 1b5510dbce9d9211480cf9545654d4b5e3f8e65e (patch) | |
| tree | caf77728ee2562ba0b76b41482d688984badf4e8 /classafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1atomic__append.html | |
| parent | a839136f4b800c0508f010b496899c1d4197f4ef (diff) | |
Travis CI updates documentation
Diffstat (limited to 'classafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1atomic__append.html')
| -rw-r--r-- | classafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1atomic__append.html | 572 |
1 files changed, 572 insertions, 0 deletions
diff --git a/classafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1atomic__append.html b/classafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1atomic__append.html new file mode 100644 index 00000000..cefde813 --- /dev/null +++ b/classafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1atomic__append.html @@ -0,0 +1,572 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.6"/> +<title>AFIO: afio_v2_xxx::algorithm::shared_fs_mutex::atomic_append Class Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); + $(window).load(resizeHeight); +</script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td style="padding-left: 0.5em;"> + <div id="projectname">AFIO +  <span id="projectnumber">v2.00 late alpha</span> + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.6 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="pages.html"><span>Related Pages</span></a></li> + <li><a href="modules.html"><span>Modules</span></a></li> + <li><a href="namespaces.html"><span>Namespaces</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </span> + </div> + </li> + </ul> + </div> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="classes.html"><span>Class Index</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +$(document).ready(function(){initNavTree('classafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1atomic__append.html','');}); +</script> +<div id="doc-content"> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Pages</a></div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div class="header"> + <div class="summary"> +<a href="#pub-types">Public Types</a> | +<a href="#pub-methods">Public Member Functions</a> | +<a href="#pub-static-methods">Static Public Member Functions</a> | +<a href="#pro-methods">Protected Member Functions</a> | +<a href="classafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1atomic__append-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">afio_v2_xxx::algorithm::shared_fs_mutex::atomic_append Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>Scalable many entity shared/exclusive file system based lock. + <a href="classafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1atomic__append.html#details">More...</a></p> + +<p><code>#include "atomic_append.hpp"</code></p> +<div class="dynheader"> +Inheritance diagram for afio_v2_xxx::algorithm::shared_fs_mutex::atomic_append:</div> +<div class="dyncontent"> + <div class="center"> + <img src="classafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1atomic__append.png" usemap="#afio_v2_xxx::algorithm::shared_fs_mutex::atomic_append_map" alt=""/> + <map id="afio_v2_xxx::algorithm::shared_fs_mutex::atomic_append_map" name="afio_v2_xxx::algorithm::shared_fs_mutex::atomic_append_map"> +<area href="classafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1shared__fs__mutex.html" title="Abstract base class for an object which protects shared filing system resources. " alt="afio_v2_xxx::algorithm::shared_fs_mutex::shared_fs_mutex" shape="rect" coords="0,0,338,24"/> +</map> + </div></div> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a> +Public Types</h2></td></tr> +<tr class="memitem:a0b8ee014f4d70b6e972eef6eed3a9cc5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0b8ee014f4d70b6e972eef6eed3a9cc5"></a> +using </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1atomic__append.html#a0b8ee014f4d70b6e972eef6eed3a9cc5">entity_type</a> = <a class="el" href="structafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1shared__fs__mutex_1_1entity__type.html">shared_fs_mutex::entity_type</a></td></tr> +<tr class="memdesc:a0b8ee014f4d70b6e972eef6eed3a9cc5"><td class="mdescLeft"> </td><td class="mdescRight">The type of an entity id. <br/></td></tr> +<tr class="separator:a0b8ee014f4d70b6e972eef6eed3a9cc5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a8122298dacfb0e372d9a7e2ce0f6d463"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8122298dacfb0e372d9a7e2ce0f6d463"></a> +using </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1atomic__append.html#a8122298dacfb0e372d9a7e2ce0f6d463">entities_type</a> = <a class="el" href="classafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1shared__fs__mutex.html#ab9b3f3598d373786919eafc643d78633">shared_fs_mutex::entities_type</a></td></tr> +<tr class="memdesc:a8122298dacfb0e372d9a7e2ce0f6d463"><td class="mdescLeft"> </td><td class="mdescRight">The type of a sequence of entities. <br/></td></tr> +<tr class="separator:a8122298dacfb0e372d9a7e2ce0f6d463"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> +Public Member Functions</h2></td></tr> +<tr class="memitem:a8f5b9600df711a61c49d50988b83ea51"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8f5b9600df711a61c49d50988b83ea51"></a> + </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1atomic__append.html#a8f5b9600df711a61c49d50988b83ea51">atomic_append</a> (<a class="el" href="classafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1atomic__append.html">atomic_append</a> &&o) noexcept</td></tr> +<tr class="memdesc:a8f5b9600df711a61c49d50988b83ea51"><td class="mdescLeft"> </td><td class="mdescRight">Move constructor. <br/></td></tr> +<tr class="separator:a8f5b9600df711a61c49d50988b83ea51"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa370b82fbcb8d78418f1258f759e00d9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa370b82fbcb8d78418f1258f759e00d9"></a> +<a class="el" href="classafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1atomic__append.html">atomic_append</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1atomic__append.html#aa370b82fbcb8d78418f1258f759e00d9">operator=</a> (<a class="el" href="classafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1atomic__append.html">atomic_append</a> &&o) noexcept</td></tr> +<tr class="memdesc:aa370b82fbcb8d78418f1258f759e00d9"><td class="mdescLeft"> </td><td class="mdescRight">Move assign. <br/></td></tr> +<tr class="separator:aa370b82fbcb8d78418f1258f759e00d9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a80c98bea41ad1695ee255bddab5609b1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a80c98bea41ad1695ee255bddab5609b1"></a> +const <a class="el" href="classafio__v2__xxx_1_1file__handle.html">file_handle</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1atomic__append.html#a80c98bea41ad1695ee255bddab5609b1">handle</a> () const noexcept</td></tr> +<tr class="memdesc:a80c98bea41ad1695ee255bddab5609b1"><td class="mdescLeft"> </td><td class="mdescRight">Return the handle to file being used for this lock. <br/></td></tr> +<tr class="separator:a80c98bea41ad1695ee255bddab5609b1"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad66b0f2de1fc1853c9b2f9893145bf41"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad66b0f2de1fc1853c9b2f9893145bf41"></a> +virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1atomic__append.html#ad66b0f2de1fc1853c9b2f9893145bf41">unlock</a> (<a class="el" href="classafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1atomic__append.html#a8122298dacfb0e372d9a7e2ce0f6d463">entities_type</a> entities, unsigned long long hint) noexceptoverridefinal</td></tr> +<tr class="memdesc:ad66b0f2de1fc1853c9b2f9893145bf41"><td class="mdescLeft"> </td><td class="mdescRight">Unlock a previously locked sequence of entities. <br/></td></tr> +<tr class="separator:ad66b0f2de1fc1853c9b2f9893145bf41"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a96b28acf46a3d4ebe93b6031d90f79ac"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a96b28acf46a3d4ebe93b6031d90f79ac"></a> +<a class="el" href="classafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1atomic__append.html#a0b8ee014f4d70b6e972eef6eed3a9cc5">entity_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1shared__fs__mutex.html#a96b28acf46a3d4ebe93b6031d90f79ac">entity_from_buffer</a> (const char *buffer, size_t bytes, bool exclusive=true) noexcept</td></tr> +<tr class="memdesc:a96b28acf46a3d4ebe93b6031d90f79ac"><td class="mdescLeft"> </td><td class="mdescRight">Generates an entity id from a sequence of bytes. <br/></td></tr> +<tr class="separator:a96b28acf46a3d4ebe93b6031d90f79ac"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a3cd51b21b55c1ed21fcea0edaefdae85"><td class="memTemplParams" colspan="2"><a class="anchor" id="a3cd51b21b55c1ed21fcea0edaefdae85"></a> +template<typename T > </td></tr> +<tr class="memitem:a3cd51b21b55c1ed21fcea0edaefdae85"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1atomic__append.html#a0b8ee014f4d70b6e972eef6eed3a9cc5">entity_type</a> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1shared__fs__mutex.html#a3cd51b21b55c1ed21fcea0edaefdae85">entity_from_string</a> (const std::basic_string< T > &str, bool exclusive=true) noexcept</td></tr> +<tr class="memdesc:a3cd51b21b55c1ed21fcea0edaefdae85"><td class="mdescLeft"> </td><td class="mdescRight">Generates an entity id from a string. <br/></td></tr> +<tr class="separator:a3cd51b21b55c1ed21fcea0edaefdae85"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a17f374fc7863784f478498eac95dcc70"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a17f374fc7863784f478498eac95dcc70"></a> +<a class="el" href="classafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1atomic__append.html#a0b8ee014f4d70b6e972eef6eed3a9cc5">entity_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1shared__fs__mutex.html#a17f374fc7863784f478498eac95dcc70">random_entity</a> (bool exclusive=true) noexcept</td></tr> +<tr class="memdesc:a17f374fc7863784f478498eac95dcc70"><td class="mdescLeft"> </td><td class="mdescRight">Generates a cryptographically random entity id. <br/></td></tr> +<tr class="separator:a17f374fc7863784f478498eac95dcc70"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a1d2d3fb211c48b0322333c55e1d019a5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1d2d3fb211c48b0322333c55e1d019a5"></a> +void </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1shared__fs__mutex.html#a1d2d3fb211c48b0322333c55e1d019a5">fill_random_entities</a> (span< <a class="el" href="classafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1atomic__append.html#a0b8ee014f4d70b6e972eef6eed3a9cc5">entity_type</a> > seq, bool exclusive=true) noexcept</td></tr> +<tr class="memdesc:a1d2d3fb211c48b0322333c55e1d019a5"><td class="mdescLeft"> </td><td class="mdescRight">Fills a sequence of entity ids with cryptographic randomness. Much faster than calling random_entity() individually. <br/></td></tr> +<tr class="separator:a1d2d3fb211c48b0322333c55e1d019a5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2e82ae0ca11932f5287b0ca2f4834da6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2e82ae0ca11932f5287b0ca2f4834da6"></a> +result< <a class="el" href="classafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1shared__fs__mutex_1_1entities__guard.html">entities_guard</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1shared__fs__mutex.html#a2e82ae0ca11932f5287b0ca2f4834da6">lock</a> (<a class="el" href="classafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1atomic__append.html#a8122298dacfb0e372d9a7e2ce0f6d463">entities_type</a> entities, <a class="el" href="structdeadline.html">deadline</a> d=<a class="el" href="structdeadline.html">deadline</a>(), bool spin_not_sleep=false) noexcept</td></tr> +<tr class="memdesc:a2e82ae0ca11932f5287b0ca2f4834da6"><td class="mdescLeft"> </td><td class="mdescRight">Lock all of a sequence of entities for exclusive or shared access. <br/></td></tr> +<tr class="separator:a2e82ae0ca11932f5287b0ca2f4834da6"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac1dbb5f7b7887690b47b1d24940a054d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac1dbb5f7b7887690b47b1d24940a054d"></a> +result< <a class="el" href="classafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1shared__fs__mutex_1_1entities__guard.html">entities_guard</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1shared__fs__mutex.html#ac1dbb5f7b7887690b47b1d24940a054d">lock</a> (<a class="el" href="classafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1atomic__append.html#a0b8ee014f4d70b6e972eef6eed3a9cc5">entity_type</a> entity, <a class="el" href="structdeadline.html">deadline</a> d=<a class="el" href="structdeadline.html">deadline</a>(), bool spin_not_sleep=false) noexcept</td></tr> +<tr class="memdesc:ac1dbb5f7b7887690b47b1d24940a054d"><td class="mdescLeft"> </td><td class="mdescRight">Lock a single entity for exclusive or shared access. <br/></td></tr> +<tr class="separator:ac1dbb5f7b7887690b47b1d24940a054d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0987b9c6c93a65acb2715e589d45c273"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0987b9c6c93a65acb2715e589d45c273"></a> +result< <a class="el" href="classafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1shared__fs__mutex_1_1entities__guard.html">entities_guard</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1shared__fs__mutex.html#a0987b9c6c93a65acb2715e589d45c273">try_lock</a> (<a class="el" href="classafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1atomic__append.html#a8122298dacfb0e372d9a7e2ce0f6d463">entities_type</a> entities) noexcept</td></tr> +<tr class="memdesc:a0987b9c6c93a65acb2715e589d45c273"><td class="mdescLeft"> </td><td class="mdescRight">Try to lock all of a sequence of entities for exclusive or shared access. <br/></td></tr> +<tr class="separator:a0987b9c6c93a65acb2715e589d45c273"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aebdc3d01ccb30b297950130c7ebac57b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aebdc3d01ccb30b297950130c7ebac57b"></a> +result< <a class="el" href="classafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1shared__fs__mutex_1_1entities__guard.html">entities_guard</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1shared__fs__mutex.html#aebdc3d01ccb30b297950130c7ebac57b">try_lock</a> (<a class="el" href="classafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1atomic__append.html#a0b8ee014f4d70b6e972eef6eed3a9cc5">entity_type</a> entity) noexcept</td></tr> +<tr class="memdesc:aebdc3d01ccb30b297950130c7ebac57b"><td class="mdescLeft"> </td><td class="mdescRight">Try to lock a single entity for exclusive or shared access. <br/></td></tr> +<tr class="separator:aebdc3d01ccb30b297950130c7ebac57b"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> +Static Public Member Functions</h2></td></tr> +<tr class="memitem:a37d6135d8677c0da876a432a7ac05b53"><td class="memItemLeft" align="right" valign="top">static result< <a class="el" href="classafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1atomic__append.html">atomic_append</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1atomic__append.html#a37d6135d8677c0da876a432a7ac05b53">fs_mutex_append</a> (const <a class="el" href="classafio__v2__xxx_1_1path__handle.html">path_handle</a> &base, <a class="el" href="classafio__v2__xxx_1_1path__view.html">path_view</a> lockfile, bool nfs_compatibility=false, bool skip_hashing=false) noexcept</td></tr> +<tr class="separator:a37d6135d8677c0da876a432a7ac05b53"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a> +Protected Member Functions</h2></td></tr> +<tr class="memitem:a314b006449b2516b1dbe3c4ac07067dc"><td class="memItemLeft" align="right" valign="top">virtual result< void > </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1atomic__append.html#a314b006449b2516b1dbe3c4ac07067dc">_lock</a> (<a class="el" href="classafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1shared__fs__mutex_1_1entities__guard.html">entities_guard</a> &out, <a class="el" href="structdeadline.html">deadline</a> d, bool spin_not_sleep) noexceptoverridefinal</td></tr> +<tr class="separator:a314b006449b2516b1dbe3c4ac07067dc"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>Scalable many entity shared/exclusive file system based lock. </p> +<p>Lock files and byte ranges scale poorly to the number of items being concurrently locked with typically an exponential drop off in performance as the number of items being concurrently locked rises. This file system algorithm solves this problem using IPC via a shared append-only lock file.</p> +<ul> +<li>Compatible with networked file systems (NFS too if the special nfs_compatibility flag is true. Note turning this on is not free of cost if you don't need NFS compatibility).</li> +<li>Nearly constant time to number of entities being locked.</li> +<li>Nearly constant time to number of processes concurrently using the lock (i.e. number of waiters).</li> +<li>Can sleep until a lock becomes free in a power-efficient manner.</li> +<li>Sudden power loss during use is recovered from.</li> +</ul> +<p>Caveats:</p> +<ul> +<li>Much slower than byte_ranges for few waiters or small number of entities.</li> +<li>Sudden process exit with locks held will deadlock all other users.</li> +<li>Maximum of twelve entities may be locked concurrently.</li> +<li>Wasteful of disk space if used on a non-extents based filing system (e.g. FAT32, ext3). It is best used in <code>/tmp</code> if possible (<code>file_handle::temp_file()</code>). If you really must use a non-extents based filing system, destroy and recreate the object instance periodically to force resetting the lock file's length to zero.</li> +<li>Similarly older operating systems (e.g. Linux < 3.0) do not implement extent hole punching and therefore will also see excessive disk space consumption. Note at the time of writing OS X doesn't implement hole punching at all.</li> +<li>If your OS doesn't have sane byte range locks (OS X, BSD, older Linuxes) and multiple objects in your process use the same lock file, misoperation will occur. Use lock_files instead.</li> +</ul> +<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000005">Todo:</a></b></dt><dd><p class="startdd">Implement hole punching once I port that code from AFIO v1. </p> +<p>Decide on some resolution mechanism for sudden process exit. </p> +<p class="enddd">There is a 1 out of 2^64-2 chance of unique id collision. It would be nice if we actually formally checked that our chosen unique id is actually unique. </p> +</dd></dl> +</div><h2 class="groupheader">Member Function Documentation</h2> +<a class="anchor" id="a314b006449b2516b1dbe3c4ac07067dc"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual result<void> afio_v2_xxx::algorithm::shared_fs_mutex::atomic_append::_lock </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1shared__fs__mutex_1_1entities__guard.html">entities_guard</a> & </td> + <td class="paramname"><em>out</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="structdeadline.html">deadline</a> </td> + <td class="paramname"><em>d</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"><em>spin_not_sleep</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">final</span><span class="mlabel">override</span><span class="mlabel">protected</span><span class="mlabel">virtual</span><span class="mlabel">noexcept</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000007">Todo:</a></b></dt><dd>Read from header.last_known_good immediately if possible in order to avoid a duplicate read later </dd></dl> + +<p>Implements <a class="el" href="classafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1shared__fs__mutex.html">afio_v2_xxx::algorithm::shared_fs_mutex::shared_fs_mutex</a>.</p> +<div class="fragment"><div class="line"><a name="l00215"></a><span class="lineno"> 215</span>  {</div> +<div class="line"><a name="l00216"></a><span class="lineno"> 216</span>  AFIO_LOG_FUNCTION_CALL(<span class="keyword">this</span>);</div> +<div class="line"><a name="l00217"></a><span class="lineno"> 217</span>  atomic_append_detail::lock_request lock_request;</div> +<div class="line"><a name="l00218"></a><span class="lineno"> 218</span>  <span class="keywordflow">if</span>(out.entities.size() > <span class="keyword">sizeof</span>(lock_request.entities) / <span class="keyword">sizeof</span>(lock_request.entities[0]))</div> +<div class="line"><a name="l00219"></a><span class="lineno"> 219</span>  <span class="keywordflow">return</span> std::errc::argument_list_too_long;</div> +<div class="line"><a name="l00220"></a><span class="lineno"> 220</span> </div> +<div class="line"><a name="l00221"></a><span class="lineno"> 221</span>  std::chrono::steady_clock::time_point began_steady;</div> +<div class="line"><a name="l00222"></a><span class="lineno"> 222</span>  std::chrono::system_clock::time_point end_utc;</div> +<div class="line"><a name="l00223"></a><span class="lineno"> 223</span>  <span class="keywordflow">if</span>(d)</div> +<div class="line"><a name="l00224"></a><span class="lineno"> 224</span>  {</div> +<div class="line"><a name="l00225"></a><span class="lineno"> 225</span>  <span class="keywordflow">if</span>((d).steady)</div> +<div class="line"><a name="l00226"></a><span class="lineno"> 226</span>  began_steady = std::chrono::steady_clock::now();</div> +<div class="line"><a name="l00227"></a><span class="lineno"> 227</span>  <span class="keywordflow">else</span></div> +<div class="line"><a name="l00228"></a><span class="lineno"> 228</span>  end_utc = (d).to_time_point();</div> +<div class="line"><a name="l00229"></a><span class="lineno"> 229</span>  }</div> +<div class="line"><a name="l00230"></a><span class="lineno"> 230</span>  <span class="comment">// Fire this if an error occurs</span></div> +<div class="line"><a name="l00231"></a><span class="lineno"> 231</span>  <span class="keyword">auto</span> disableunlock = undoer([&] { out.release(); });</div> +<div class="line"><a name="l00232"></a><span class="lineno"> 232</span> </div> +<div class="line"><a name="l00233"></a><span class="lineno"> 233</span>  <span class="comment">// Write my lock request immediately</span></div> +<div class="line"><a name="l00234"></a><span class="lineno"> 234</span>  memset(&lock_request, 0, <span class="keyword">sizeof</span>(lock_request));</div> +<div class="line"><a name="l00235"></a><span class="lineno"> 235</span>  lock_request.unique_id = _unique_id;</div> +<div class="line"><a name="l00236"></a><span class="lineno"> 236</span>  <span class="keyword">auto</span> count = std::chrono::system_clock::now() - std::chrono::system_clock::from_time_t(_header.time_offset);</div> +<div class="line"><a name="l00237"></a><span class="lineno"> 237</span>  lock_request.us_count = std::chrono::duration_cast<std::chrono::microseconds>(count).count();</div> +<div class="line"><a name="l00238"></a><span class="lineno"> 238</span>  lock_request.items = out.entities.size();</div> +<div class="line"><a name="l00239"></a><span class="lineno"> 239</span>  memcpy(lock_request.entities, out.entities.data(), <span class="keyword">sizeof</span>(lock_request.entities[0]) * out.entities.size());</div> +<div class="line"><a name="l00240"></a><span class="lineno"> 240</span>  <span class="keywordflow">if</span>(!_skip_hashing)</div> +<div class="line"><a name="l00241"></a><span class="lineno"> 241</span>  lock_request.hash = QUICKCPPLIB_NAMESPACE::algorithm::hash::fast_hash::hash(((<span class="keywordtype">char</span> *) &lock_request) + 16, <span class="keyword">sizeof</span>(lock_request) - 16);</div> +<div class="line"><a name="l00242"></a><span class="lineno"> 242</span>  <span class="comment">// My lock request will be the file's current length or higher</span></div> +<div class="line"><a name="l00243"></a><span class="lineno"> 243</span>  OUTCOME_TRY(my_lock_request_offset, _h.<a class="code" href="classafio__v2__xxx_1_1file__handle.html#a2083c37ffc746ec28f9e4d6b094d3ba5">length</a>());</div> +<div class="line"><a name="l00244"></a><span class="lineno"> 244</span>  {</div> +<div class="line"><a name="l00245"></a><span class="lineno"> 245</span>  OUTCOME_TRYV(_h.<a class="code" href="classafio__v2__xxx_1_1handle.html#af1610ec7fb0a41f039e3e17e0dc467ab">set_append_only</a>(<span class="keyword">true</span>));</div> +<div class="line"><a name="l00246"></a><span class="lineno"> 246</span>  <span class="keyword">auto</span> undo = undoer([<span class="keyword">this</span>] { (void) _h.<a class="code" href="classafio__v2__xxx_1_1handle.html#af1610ec7fb0a41f039e3e17e0dc467ab">set_append_only</a>(<span class="keyword">false</span>); });</div> +<div class="line"><a name="l00247"></a><span class="lineno"> 247</span>  file_handle::extent_guard append_guard;</div> +<div class="line"><a name="l00248"></a><span class="lineno"> 248</span>  <span class="keywordflow">if</span>(_nfs_compatibility)</div> +<div class="line"><a name="l00249"></a><span class="lineno"> 249</span>  {</div> +<div class="line"><a name="l00250"></a><span class="lineno"> 250</span>  file_handle::extent_type lastbyte = (file_handle::extent_type) -1;</div> +<div class="line"><a name="l00251"></a><span class="lineno"> 251</span>  <span class="comment">// Lock up to the beginning of the shadow lock space</span></div> +<div class="line"><a name="l00252"></a><span class="lineno"> 252</span>  lastbyte &= ~(1ULL << 63);</div> +<div class="line"><a name="l00253"></a><span class="lineno"> 253</span>  OUTCOME_TRY(append_guard_, _h.<a class="code" href="classafio__v2__xxx_1_1io__handle.html#a88689b15e6e8b6ce1f945737dee4369e">lock</a>(my_lock_request_offset, lastbyte, <span class="keyword">true</span>));</div> +<div class="line"><a name="l00254"></a><span class="lineno"> 254</span>  append_guard = std::move(append_guard_);</div> +<div class="line"><a name="l00255"></a><span class="lineno"> 255</span>  }</div> +<div class="line"><a name="l00256"></a><span class="lineno"> 256</span>  OUTCOME_TRYV(_h.<a class="code" href="classafio__v2__xxx_1_1io__handle.html#aefac4710e5617264347f437b04732c01">write</a>(0, (<span class="keywordtype">char</span> *) &lock_request, <span class="keyword">sizeof</span>(lock_request)));</div> +<div class="line"><a name="l00257"></a><span class="lineno"> 257</span>  }</div> +<div class="line"><a name="l00258"></a><span class="lineno"> 258</span> </div> +<div class="line"><a name="l00259"></a><span class="lineno"> 259</span>  <span class="comment">// Find the record I just wrote</span></div> +<div class="line"><a name="l00260"></a><span class="lineno"> 260</span>  <span class="keyword">alignas</span>(64) <span class="keywordtype">char</span> _buffer[4096 + 2048]; <span class="comment">// 6Kb cache line aligned buffer</span></div> +<div class="line"><a name="l00261"></a><span class="lineno"> 261</span>  <span class="comment">// Read onwards from length as reported before I wrote my lock request</span></div> +<div class="line"><a name="l00262"></a><span class="lineno"> 262</span>  <span class="comment">// until I find my lock request. This loop should never actually iterate</span></div> +<div class="line"><a name="l00263"></a><span class="lineno"> 263</span>  <span class="comment">// except under extreme load conditions.</span><span class="comment"></span></div> +<div class="line"><a name="l00264"></a><span class="lineno"> 264</span> <span class="comment"> //! \todo Read from header.last_known_good immediately if possible in order</span></div> +<div class="line"><a name="l00265"></a><span class="lineno"> 265</span> <span class="comment"> //! to avoid a duplicate read later</span></div> +<div class="line"><a name="l00266"></a><span class="lineno"> 266</span> <span class="comment"></span> <span class="keywordflow">for</span>(;;)</div> +<div class="line"><a name="l00267"></a><span class="lineno"> 267</span>  {</div> +<div class="line"><a name="l00268"></a><span class="lineno"> 268</span>  file_handle::io_result<file_handle::buffer_type> readoutcome = _h.<a class="code" href="classafio__v2__xxx_1_1io__handle.html#a71d7636f40607829cacc2c974c4a2a28">read</a>(my_lock_request_offset, _buffer, <span class="keyword">sizeof</span>(_buffer));</div> +<div class="line"><a name="l00269"></a><span class="lineno"> 269</span>  <span class="comment">// Should never happen :)</span></div> +<div class="line"><a name="l00270"></a><span class="lineno"> 270</span>  <span class="keywordflow">if</span>(readoutcome.has_error())</div> +<div class="line"><a name="l00271"></a><span class="lineno"> 271</span>  {</div> +<div class="line"><a name="l00272"></a><span class="lineno"> 272</span>  AFIO_LOG_FATAL(<span class="keyword">this</span>, <span class="stringliteral">"atomic_append::lock() saw an error when searching for just written data"</span>);</div> +<div class="line"><a name="l00273"></a><span class="lineno"> 273</span>  std::terminate();</div> +<div class="line"><a name="l00274"></a><span class="lineno"> 274</span>  }</div> +<div class="line"><a name="l00275"></a><span class="lineno"> 275</span>  <span class="keyword">const</span> atomic_append_detail::lock_request *record, *lastrecord;</div> +<div class="line"><a name="l00276"></a><span class="lineno"> 276</span>  <span class="keywordflow">for</span>(record = (<span class="keyword">const</span> atomic_append_detail::lock_request *) readoutcome.value().data, lastrecord = (<span class="keyword">const</span> atomic_append_detail::lock_request *) (readoutcome.value().data + readoutcome.value().len); record < lastrecord && record->hash != lock_request.hash; ++record)</div> +<div class="line"><a name="l00277"></a><span class="lineno"> 277</span>  my_lock_request_offset += <span class="keyword">sizeof</span>(atomic_append_detail::lock_request);</div> +<div class="line"><a name="l00278"></a><span class="lineno"> 278</span>  <span class="keywordflow">if</span>(record->hash == lock_request.hash)</div> +<div class="line"><a name="l00279"></a><span class="lineno"> 279</span>  <span class="keywordflow">break</span>;</div> +<div class="line"><a name="l00280"></a><span class="lineno"> 280</span>  }</div> +<div class="line"><a name="l00281"></a><span class="lineno"> 281</span> </div> +<div class="line"><a name="l00282"></a><span class="lineno"> 282</span>  <span class="comment">// extent_guard is now valid and will be unlocked on error</span></div> +<div class="line"><a name="l00283"></a><span class="lineno"> 283</span>  out.hint = my_lock_request_offset;</div> +<div class="line"><a name="l00284"></a><span class="lineno"> 284</span>  disableunlock.dismiss();</div> +<div class="line"><a name="l00285"></a><span class="lineno"> 285</span> </div> +<div class="line"><a name="l00286"></a><span class="lineno"> 286</span>  <span class="comment">// Lock my request for writing so others can sleep on me</span></div> +<div class="line"><a name="l00287"></a><span class="lineno"> 287</span>  file_handle::extent_guard my_request_guard;</div> +<div class="line"><a name="l00288"></a><span class="lineno"> 288</span>  <span class="keywordflow">if</span>(!spin_not_sleep)</div> +<div class="line"><a name="l00289"></a><span class="lineno"> 289</span>  {</div> +<div class="line"><a name="l00290"></a><span class="lineno"> 290</span>  <span class="keyword">auto</span> lock_offset = my_lock_request_offset;</div> +<div class="line"><a name="l00291"></a><span class="lineno"> 291</span>  <span class="comment">// Set the top bit to use the shadow lock space on Windows</span></div> +<div class="line"><a name="l00292"></a><span class="lineno"> 292</span>  lock_offset |= (1ULL << 63);</div> +<div class="line"><a name="l00293"></a><span class="lineno"> 293</span>  OUTCOME_TRY(my_request_guard_, _h.<a class="code" href="classafio__v2__xxx_1_1io__handle.html#a88689b15e6e8b6ce1f945737dee4369e">lock</a>(lock_offset, <span class="keyword">sizeof</span>(lock_request), <span class="keyword">true</span>));</div> +<div class="line"><a name="l00294"></a><span class="lineno"> 294</span>  my_request_guard = std::move(my_request_guard_);</div> +<div class="line"><a name="l00295"></a><span class="lineno"> 295</span>  }</div> +<div class="line"><a name="l00296"></a><span class="lineno"> 296</span> </div> +<div class="line"><a name="l00297"></a><span class="lineno"> 297</span>  <span class="comment">// Read every record preceding mine until header.first_known_good inclusive</span></div> +<div class="line"><a name="l00298"></a><span class="lineno"> 298</span>  <span class="keyword">auto</span> record_offset = my_lock_request_offset - <span class="keyword">sizeof</span>(atomic_append_detail::lock_request);</div> +<div class="line"><a name="l00299"></a><span class="lineno"> 299</span>  <span class="keywordflow">do</span></div> +<div class="line"><a name="l00300"></a><span class="lineno"> 300</span>  {</div> +<div class="line"><a name="l00301"></a><span class="lineno"> 301</span>  reload:</div> +<div class="line"><a name="l00302"></a><span class="lineno"> 302</span>  <span class="comment">// Refresh the header and load a snapshot of everything between record_offset</span></div> +<div class="line"><a name="l00303"></a><span class="lineno"> 303</span>  <span class="comment">// and first_known_good or -6Kb, whichever the sooner</span></div> +<div class="line"><a name="l00304"></a><span class="lineno"> 304</span>  OUTCOME_TRYV(_read_header());</div> +<div class="line"><a name="l00305"></a><span class="lineno"> 305</span>  <span class="comment">// If there are no preceding records, we're done</span></div> +<div class="line"><a name="l00306"></a><span class="lineno"> 306</span>  <span class="keywordflow">if</span>(record_offset < _header.first_known_good)</div> +<div class="line"><a name="l00307"></a><span class="lineno"> 307</span>  <span class="keywordflow">break</span>;</div> +<div class="line"><a name="l00308"></a><span class="lineno"> 308</span>  <span class="keyword">auto</span> start_offset = record_offset;</div> +<div class="line"><a name="l00309"></a><span class="lineno"> 309</span>  <span class="keywordflow">if</span>(start_offset > <span class="keyword">sizeof</span>(_buffer) - <span class="keyword">sizeof</span>(atomic_append_detail::lock_request))</div> +<div class="line"><a name="l00310"></a><span class="lineno"> 310</span>  start_offset -= <span class="keyword">sizeof</span>(_buffer) - <span class="keyword">sizeof</span>(atomic_append_detail::lock_request);</div> +<div class="line"><a name="l00311"></a><span class="lineno"> 311</span>  <span class="keywordflow">else</span></div> +<div class="line"><a name="l00312"></a><span class="lineno"> 312</span>  start_offset = <span class="keyword">sizeof</span>(atomic_append_detail::lock_request);</div> +<div class="line"><a name="l00313"></a><span class="lineno"> 313</span>  <span class="keywordflow">if</span>(start_offset < _header.first_known_good)</div> +<div class="line"><a name="l00314"></a><span class="lineno"> 314</span>  start_offset = _header.first_known_good;</div> +<div class="line"><a name="l00315"></a><span class="lineno"> 315</span>  assert(record_offset >= start_offset);</div> +<div class="line"><a name="l00316"></a><span class="lineno"> 316</span>  assert(record_offset - start_offset <= <span class="keyword">sizeof</span>(_buffer));</div> +<div class="line"><a name="l00317"></a><span class="lineno"> 317</span>  OUTCOME_TRY(batchread, _h.<a class="code" href="classafio__v2__xxx_1_1io__handle.html#a71d7636f40607829cacc2c974c4a2a28">read</a>(start_offset, _buffer, (<span class="keywordtype">size_t</span>)(record_offset - start_offset) + <span class="keyword">sizeof</span>(atomic_append_detail::lock_request)));</div> +<div class="line"><a name="l00318"></a><span class="lineno"> 318</span>  assert(batchread.len == record_offset - start_offset + <span class="keyword">sizeof</span>(atomic_append_detail::lock_request));</div> +<div class="line"><a name="l00319"></a><span class="lineno"> 319</span>  <span class="keyword">const</span> atomic_append_detail::lock_request *record = (atomic_append_detail::lock_request *) (batchread.data + batchread.len - <span class="keyword">sizeof</span>(atomic_append_detail::lock_request));</div> +<div class="line"><a name="l00320"></a><span class="lineno"> 320</span>  <span class="keyword">const</span> atomic_append_detail::lock_request *firstrecord = (atomic_append_detail::lock_request *) batchread.data;</div> +<div class="line"><a name="l00321"></a><span class="lineno"> 321</span> </div> +<div class="line"><a name="l00322"></a><span class="lineno"> 322</span>  <span class="comment">// Skip all completed lock requests or not mentioning any of my entities</span></div> +<div class="line"><a name="l00323"></a><span class="lineno"> 323</span>  <span class="keywordflow">for</span>(; record >= firstrecord; record_offset -= <span class="keyword">sizeof</span>(atomic_append_detail::lock_request), --record)</div> +<div class="line"><a name="l00324"></a><span class="lineno"> 324</span>  {</div> +<div class="line"><a name="l00325"></a><span class="lineno"> 325</span>  <span class="comment">// If a completed lock request, skip</span></div> +<div class="line"><a name="l00326"></a><span class="lineno"> 326</span>  <span class="keywordflow">if</span>(!record->hash && !record->unique_id)</div> +<div class="line"><a name="l00327"></a><span class="lineno"> 327</span>  <span class="keywordflow">continue</span>;</div> +<div class="line"><a name="l00328"></a><span class="lineno"> 328</span>  <span class="comment">// If record hash doesn't match contents it's a torn read, reload</span></div> +<div class="line"><a name="l00329"></a><span class="lineno"> 329</span>  <span class="keywordflow">if</span>(!_skip_hashing)</div> +<div class="line"><a name="l00330"></a><span class="lineno"> 330</span>  {</div> +<div class="line"><a name="l00331"></a><span class="lineno"> 331</span>  <span class="keywordflow">if</span>(record->hash != QUICKCPPLIB_NAMESPACE::algorithm::hash::fast_hash::hash(((<span class="keywordtype">char</span> *) record) + 16, <span class="keyword">sizeof</span>(atomic_append_detail::lock_request) - 16))</div> +<div class="line"><a name="l00332"></a><span class="lineno"> 332</span>  <span class="keywordflow">goto</span> reload;</div> +<div class="line"><a name="l00333"></a><span class="lineno"> 333</span>  }</div> +<div class="line"><a name="l00334"></a><span class="lineno"> 334</span> </div> +<div class="line"><a name="l00335"></a><span class="lineno"> 335</span>  <span class="comment">// Does this record lock anything I am locking?</span></div> +<div class="line"><a name="l00336"></a><span class="lineno"> 336</span>  <span class="keywordflow">for</span>(<span class="keyword">const</span> <span class="keyword">auto</span> &entity : out.entities)</div> +<div class="line"><a name="l00337"></a><span class="lineno"> 337</span>  {</div> +<div class="line"><a name="l00338"></a><span class="lineno"> 338</span>  <span class="keywordflow">for</span>(<span class="keywordtype">size_t</span> n = 0; n < record->items; n++)</div> +<div class="line"><a name="l00339"></a><span class="lineno"> 339</span>  {</div> +<div class="line"><a name="l00340"></a><span class="lineno"> 340</span>  <span class="keywordflow">if</span>(record->entities[n].value == entity.value)</div> +<div class="line"><a name="l00341"></a><span class="lineno"> 341</span>  {</div> +<div class="line"><a name="l00342"></a><span class="lineno"> 342</span>  <span class="comment">// Is the lock I want exclusive or the lock he wants exclusive?</span></div> +<div class="line"><a name="l00343"></a><span class="lineno"> 343</span>  <span class="comment">// If so, need to block</span></div> +<div class="line"><a name="l00344"></a><span class="lineno"> 344</span>  <span class="keywordflow">if</span>(record->entities[n].exclusive || entity.exclusive)</div> +<div class="line"><a name="l00345"></a><span class="lineno"> 345</span>  <span class="keywordflow">goto</span> beginwait;</div> +<div class="line"><a name="l00346"></a><span class="lineno"> 346</span>  }</div> +<div class="line"><a name="l00347"></a><span class="lineno"> 347</span>  }</div> +<div class="line"><a name="l00348"></a><span class="lineno"> 348</span>  }</div> +<div class="line"><a name="l00349"></a><span class="lineno"> 349</span>  }</div> +<div class="line"><a name="l00350"></a><span class="lineno"> 350</span>  <span class="comment">// None of this batch of records has anything to do with my request, so keep going</span></div> +<div class="line"><a name="l00351"></a><span class="lineno"> 351</span>  <span class="keywordflow">continue</span>;</div> +<div class="line"><a name="l00352"></a><span class="lineno"> 352</span> </div> +<div class="line"><a name="l00353"></a><span class="lineno"> 353</span>  beginwait:</div> +<div class="line"><a name="l00354"></a><span class="lineno"> 354</span>  <span class="comment">// Sleep until this record is freed using a shared lock</span></div> +<div class="line"><a name="l00355"></a><span class="lineno"> 355</span>  <span class="comment">// on the record in our way. Note there is a race here</span></div> +<div class="line"><a name="l00356"></a><span class="lineno"> 356</span>  <span class="comment">// between when the lock requester writes the lock</span></div> +<div class="line"><a name="l00357"></a><span class="lineno"> 357</span>  <span class="comment">// request and when he takes an exclusive lock on it,</span></div> +<div class="line"><a name="l00358"></a><span class="lineno"> 358</span>  <span class="comment">// so if our shared lock succeeds we need to immediately</span></div> +<div class="line"><a name="l00359"></a><span class="lineno"> 359</span>  <span class="comment">// unlock and retry based on the data.</span></div> +<div class="line"><a name="l00360"></a><span class="lineno"> 360</span>  std::this_thread::yield();</div> +<div class="line"><a name="l00361"></a><span class="lineno"> 361</span>  <span class="keywordflow">if</span>(!spin_not_sleep)</div> +<div class="line"><a name="l00362"></a><span class="lineno"> 362</span>  {</div> +<div class="line"><a name="l00363"></a><span class="lineno"> 363</span>  <a class="code" href="structdeadline.html">deadline</a> nd;</div> +<div class="line"><a name="l00364"></a><span class="lineno"> 364</span>  <span class="keywordflow">if</span>(d)</div> +<div class="line"><a name="l00365"></a><span class="lineno"> 365</span>  {</div> +<div class="line"><a name="l00366"></a><span class="lineno"> 366</span>  <span class="keywordflow">if</span>((d).steady)</div> +<div class="line"><a name="l00367"></a><span class="lineno"> 367</span>  {</div> +<div class="line"><a name="l00368"></a><span class="lineno"> 368</span>  std::chrono::nanoseconds ns = std::chrono::duration_cast<std::chrono::nanoseconds>((began_steady + std::chrono::nanoseconds((d).nsecs)) - std::chrono::steady_clock::now());</div> +<div class="line"><a name="l00369"></a><span class="lineno"> 369</span>  <span class="keywordflow">if</span>(ns.count() < 0)</div> +<div class="line"><a name="l00370"></a><span class="lineno"> 370</span>  (nd).nsecs = 0;</div> +<div class="line"><a name="l00371"></a><span class="lineno"> 371</span>  <span class="keywordflow">else</span></div> +<div class="line"><a name="l00372"></a><span class="lineno"> 372</span>  (nd).nsecs = ns.count();</div> +<div class="line"><a name="l00373"></a><span class="lineno"> 373</span>  }</div> +<div class="line"><a name="l00374"></a><span class="lineno"> 374</span>  <span class="keywordflow">else</span></div> +<div class="line"><a name="l00375"></a><span class="lineno"> 375</span>  (nd) = (d);</div> +<div class="line"><a name="l00376"></a><span class="lineno"> 376</span>  }</div> +<div class="line"><a name="l00377"></a><span class="lineno"> 377</span>  <span class="keyword">auto</span> lock_offset = record_offset;</div> +<div class="line"><a name="l00378"></a><span class="lineno"> 378</span>  <span class="comment">// Set the top bit to use the shadow lock space on Windows</span></div> +<div class="line"><a name="l00379"></a><span class="lineno"> 379</span>  lock_offset |= (1ULL << 63);</div> +<div class="line"><a name="l00380"></a><span class="lineno"> 380</span>  OUTCOME_TRYV(_h.<a class="code" href="classafio__v2__xxx_1_1io__handle.html#a88689b15e6e8b6ce1f945737dee4369e">lock</a>(lock_offset, <span class="keyword">sizeof</span>(record), <span class="keyword">false</span>, nd));</div> +<div class="line"><a name="l00381"></a><span class="lineno"> 381</span>  }</div> +<div class="line"><a name="l00382"></a><span class="lineno"> 382</span>  <span class="comment">// Make sure we haven't timed out during this wait</span></div> +<div class="line"><a name="l00383"></a><span class="lineno"> 383</span>  <span class="keywordflow">if</span>(d)</div> +<div class="line"><a name="l00384"></a><span class="lineno"> 384</span>  {</div> +<div class="line"><a name="l00385"></a><span class="lineno"> 385</span>  <span class="keywordflow">if</span>((d).steady)</div> +<div class="line"><a name="l00386"></a><span class="lineno"> 386</span>  {</div> +<div class="line"><a name="l00387"></a><span class="lineno"> 387</span>  <span class="keywordflow">if</span>(std::chrono::steady_clock::now() >= (began_steady + std::chrono::nanoseconds((d).nsecs)))</div> +<div class="line"><a name="l00388"></a><span class="lineno"> 388</span>  <span class="keywordflow">return</span> std::errc::timed_out;</div> +<div class="line"><a name="l00389"></a><span class="lineno"> 389</span>  }</div> +<div class="line"><a name="l00390"></a><span class="lineno"> 390</span>  <span class="keywordflow">else</span></div> +<div class="line"><a name="l00391"></a><span class="lineno"> 391</span>  {</div> +<div class="line"><a name="l00392"></a><span class="lineno"> 392</span>  <span class="keywordflow">if</span>(std::chrono::system_clock::now() >= end_utc)</div> +<div class="line"><a name="l00393"></a><span class="lineno"> 393</span>  <span class="keywordflow">return</span> std::errc::timed_out;</div> +<div class="line"><a name="l00394"></a><span class="lineno"> 394</span>  }</div> +<div class="line"><a name="l00395"></a><span class="lineno"> 395</span>  }</div> +<div class="line"><a name="l00396"></a><span class="lineno"> 396</span>  } <span class="keywordflow">while</span>(record_offset >= _header.first_known_good);</div> +<div class="line"><a name="l00397"></a><span class="lineno"> 397</span>  <span class="keywordflow">return</span> success();</div> +<div class="line"><a name="l00398"></a><span class="lineno"> 398</span>  }</div> +<div class="ttc" id="classafio__v2__xxx_1_1io__handle_html_aefac4710e5617264347f437b04732c01"><div class="ttname"><a href="classafio__v2__xxx_1_1io__handle.html#aefac4710e5617264347f437b04732c01">afio_v2_xxx::io_handle::write</a></div><div class="ttdeci">virtual io_result< const_buffers_type > write(io_request< const_buffers_type > reqs, deadline d=deadline()) noexcept</div><div class="ttdoc">Write data to the open handle. </div></div> +<div class="ttc" id="structdeadline_html"><div class="ttname"><a href="structdeadline.html">deadline</a></div><div class="ttdoc">A time deadline in either relative-to-now or absolute (system clock) terms. </div></div> +<div class="ttc" id="classafio__v2__xxx_1_1handle_html_af1610ec7fb0a41f039e3e17e0dc467ab"><div class="ttname"><a href="classafio__v2__xxx_1_1handle.html#af1610ec7fb0a41f039e3e17e0dc467ab">afio_v2_xxx::handle::set_append_only</a></div><div class="ttdeci">virtual result< void > set_append_only(bool enable) noexcept</div></div> +<div class="ttc" id="classafio__v2__xxx_1_1file__handle_html_a2083c37ffc746ec28f9e4d6b094d3ba5"><div class="ttname"><a href="classafio__v2__xxx_1_1file__handle.html#a2083c37ffc746ec28f9e4d6b094d3ba5">afio_v2_xxx::file_handle::length</a></div><div class="ttdeci">virtual result< extent_type > length() const noexcept</div></div> +<div class="ttc" id="classafio__v2__xxx_1_1io__handle_html_a71d7636f40607829cacc2c974c4a2a28"><div class="ttname"><a href="classafio__v2__xxx_1_1io__handle.html#a71d7636f40607829cacc2c974c4a2a28">afio_v2_xxx::io_handle::read</a></div><div class="ttdeci">virtual io_result< buffers_type > read(io_request< buffers_type > reqs, deadline d=deadline()) noexcept</div><div class="ttdoc">Read data from the open handle. </div></div> +<div class="ttc" id="classafio__v2__xxx_1_1io__handle_html_a88689b15e6e8b6ce1f945737dee4369e"><div class="ttname"><a href="classafio__v2__xxx_1_1io__handle.html#a88689b15e6e8b6ce1f945737dee4369e">afio_v2_xxx::io_handle::lock</a></div><div class="ttdeci">virtual result< extent_guard > lock(extent_type offset, extent_type bytes, bool exclusive=true, deadline d=deadline()) noexcept</div><div class="ttdoc">Tries to lock the range of bytes specified for shared or exclusive access. Be aware this passes throu...</div></div> +</div><!-- fragment --> +</div> +</div> +<a class="anchor" id="a37d6135d8677c0da876a432a7ac05b53"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static result<<a class="el" href="classafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1atomic__append.html">atomic_append</a>> afio_v2_xxx::algorithm::shared_fs_mutex::atomic_append::fs_mutex_append </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classafio__v2__xxx_1_1path__handle.html">path_handle</a> & </td> + <td class="paramname"><em>base</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classafio__v2__xxx_1_1path__view.html">path_view</a> </td> + <td class="paramname"><em>lockfile</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"><em>nfs_compatibility</em> = <code>false</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"><em>skip_hashing</em> = <code>false</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">noexcept</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>Initialises a shared filing system mutex using the file at <em>lockfile</em> </p> +<dl class="section return"><dt>Returns</dt><dd>An implementation of shared_fs_mutex using the atomic_append algorithm. </dd></dl> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">lockfile</td><td>The path to the file to use for IPC. </td></tr> + <tr><td class="paramname">nfs_compatibility</td><td>Make this true if the lockfile could be accessed by NFS. </td></tr> + <tr><td class="paramname">skip_hashing</td><td>Some filing systems (typically the copy on write ones e.g. ZFS, btrfs) guarantee atomicity of updates and therefore torn writes are never observed by readers. For these, hashing can be safely disabled. </td></tr> + </table> + </dd> +</dl> +<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000006">Todo:</a></b></dt><dd>fs_mutex_append needs to check if file still exists after lock is granted, awaiting path fetching. </dd></dl> +<div class="fragment"><div class="line"><a name="l00176"></a><span class="lineno"> 176</span>  {</div> +<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>  AFIO_LOG_FUNCTION_CALL(0);</div> +<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>  OUTCOME_TRY(ret, <a class="code" href="classafio__v2__xxx_1_1file__handle.html#a6f4e7c6e9768c0e853105b1d63bd9dfb">file_handle::file</a>(base, lockfile, <a class="code" href="classafio__v2__xxx_1_1handle.html#a0489b6c1e25cd2bad2ba1ec86e1aaf18aefb2a684e4afb7d55e6147fbe5a332ee">file_handle::mode::write</a>, file_handle::creation::if_needed, <a class="code" href="classafio__v2__xxx_1_1handle.html#a6f7e37c73271968271c2342023f58c9ead5197d93c063a2b1e22d1630a39b7aef">file_handle::caching::temporary</a>));</div> +<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  atomic_append_detail::header header;</div> +<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  <span class="comment">// Lock the entire header for exclusive access</span></div> +<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>  <span class="keyword">auto</span> lockresult = ret.try_lock(0, <span class="keyword">sizeof</span>(header), <span class="keyword">true</span>);<span class="comment"></span></div> +<div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="comment"> //! \todo fs_mutex_append needs to check if file still exists after lock is granted, awaiting path fetching.</span></div> +<div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="comment"></span> <span class="keywordflow">if</span>(lockresult.has_error())</div> +<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  {</div> +<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>  <span class="keywordflow">if</span>(lockresult.error().value() != ETIMEDOUT)</div> +<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  <span class="keywordflow">return</span> lockresult.error();</div> +<div class="line"><a name="l00187"></a><span class="lineno"> 187</span>  <span class="comment">// Somebody else is also using this file</span></div> +<div class="line"><a name="l00188"></a><span class="lineno"> 188</span>  }</div> +<div class="line"><a name="l00189"></a><span class="lineno"> 189</span>  <span class="keywordflow">else</span></div> +<div class="line"><a name="l00190"></a><span class="lineno"> 190</span>  {</div> +<div class="line"><a name="l00191"></a><span class="lineno"> 191</span>  <span class="comment">// I am the first person to be using this (stale?) file, so write a new header and truncate</span></div> +<div class="line"><a name="l00192"></a><span class="lineno"> 192</span>  OUTCOME_TRYV(ret.truncate(<span class="keyword">sizeof</span>(header)));</div> +<div class="line"><a name="l00193"></a><span class="lineno"> 193</span>  memset(&header, 0, <span class="keyword">sizeof</span>(header));</div> +<div class="line"><a name="l00194"></a><span class="lineno"> 194</span>  header.time_offset = std::chrono::system_clock::to_time_t(std::chrono::system_clock::now());</div> +<div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  header.first_known_good = <span class="keyword">sizeof</span>(header);</div> +<div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  header.first_after_hole_punch = <span class="keyword">sizeof</span>(header);</div> +<div class="line"><a name="l00197"></a><span class="lineno"> 197</span>  <span class="keywordflow">if</span>(!skip_hashing)</div> +<div class="line"><a name="l00198"></a><span class="lineno"> 198</span>  header.hash = QUICKCPPLIB_NAMESPACE::algorithm::hash::fast_hash::hash(((<span class="keywordtype">char</span> *) &header) + 16, <span class="keyword">sizeof</span>(header) - 16);</div> +<div class="line"><a name="l00199"></a><span class="lineno"> 199</span>  OUTCOME_TRYV(ret.write(0, (<span class="keywordtype">char</span> *) &header, <span class="keyword">sizeof</span>(header)));</div> +<div class="line"><a name="l00200"></a><span class="lineno"> 200</span>  }</div> +<div class="line"><a name="l00201"></a><span class="lineno"> 201</span>  <span class="comment">// Open a shared lock on last byte in header to prevent other users zomping the file</span></div> +<div class="line"><a name="l00202"></a><span class="lineno"> 202</span>  OUTCOME_TRY(guard, ret.lock(<span class="keyword">sizeof</span>(header) - 1, 1, <span class="keyword">false</span>));</div> +<div class="line"><a name="l00203"></a><span class="lineno"> 203</span>  <span class="comment">// Unlock any exclusive lock I gained earlier now</span></div> +<div class="line"><a name="l00204"></a><span class="lineno"> 204</span>  <span class="keywordflow">if</span>(lockresult)</div> +<div class="line"><a name="l00205"></a><span class="lineno"> 205</span>  lockresult.value().unlock();</div> +<div class="line"><a name="l00206"></a><span class="lineno"> 206</span>  <span class="comment">// The constructor will read and cache the header</span></div> +<div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  <span class="keywordflow">return</span> atomic_append(std::move(ret), std::move(guard), nfs_compatibility, skip_hashing);</div> +<div class="line"><a name="l00208"></a><span class="lineno"> 208</span>  }</div> +<div class="ttc" id="classafio__v2__xxx_1_1handle_html_a0489b6c1e25cd2bad2ba1ec86e1aaf18aefb2a684e4afb7d55e6147fbe5a332ee"><div class="ttname"><a href="classafio__v2__xxx_1_1handle.html#a0489b6c1e25cd2bad2ba1ec86e1aaf18aefb2a684e4afb7d55e6147fbe5a332ee">afio_v2_xxx::handle::mode::write</a></div><div class="ttdoc">Ability to read and write (READ_CONTROL|FILE_READ_DATA|FILE_READ_ATTRIBUTES|FILE_READ_EA|FILE_WRITE_D...</div></div> +<div class="ttc" id="classafio__v2__xxx_1_1file__handle_html_a6f4e7c6e9768c0e853105b1d63bd9dfb"><div class="ttname"><a href="classafio__v2__xxx_1_1file__handle.html#a6f4e7c6e9768c0e853105b1d63bd9dfb">afio_v2_xxx::file_handle::file</a></div><div class="ttdeci">static result< file_handle > file(const path_handle &base, path_view_type _path, mode _mode=mode::read, creation _creation=creation::open_existing, caching _caching=caching::all, flag flags=flag::none) noexcept</div></div> +<div class="ttc" id="classafio__v2__xxx_1_1handle_html_a6f7e37c73271968271c2342023f58c9ead5197d93c063a2b1e22d1630a39b7aef"><div class="ttname"><a href="classafio__v2__xxx_1_1handle.html#a6f7e37c73271968271c2342023f58c9ead5197d93c063a2b1e22d1630a39b7aef">afio_v2_xxx::handle::caching::temporary</a></div><div class="ttdoc">Cache reads and writes of data and metadata so they complete immediately, only sending any updates to...</div></div> +</div><!-- fragment --> +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>include/afio/v2.0/algorithm/shared_fs_mutex/<a class="el" href="atomic__append_8hpp.html">atomic_append.hpp</a></li> +</ul> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="navelem"><a class="el" href="namespaceafio__v2__xxx.html">afio_v2_xxx</a></li><li class="navelem"><a class="el" href="namespaceafio__v2__xxx_1_1algorithm.html">algorithm</a></li><li class="navelem"><a class="el" href="namespaceafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex.html">shared_fs_mutex</a></li><li class="navelem"><a class="el" href="classafio__v2__xxx_1_1algorithm_1_1shared__fs__mutex_1_1atomic__append.html">atomic_append</a></li> + <li class="footer">Generated by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li> + </ul> +</div> +</body> +</html> |