diff options
Diffstat (limited to 'classllfio__v2__xxx_1_1section__handle.html')
| -rw-r--r-- | classllfio__v2__xxx_1_1section__handle.html | 155 |
1 files changed, 60 insertions, 95 deletions
diff --git a/classllfio__v2__xxx_1_1section__handle.html b/classllfio__v2__xxx_1_1section__handle.html index 0c96766f..8f220827 100644 --- a/classllfio__v2__xxx_1_1section__handle.html +++ b/classllfio__v2__xxx_1_1section__handle.html @@ -107,29 +107,6 @@ Inheritance diagram for llfio_v2_xxx::section_handle:</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:a5a4e0afe59d0eeb5683fb50d3d3ad549"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1section__handle.html#a5a4e0afe59d0eeb5683fb50d3d3ad549">bitfield__flag</a> : unsigned { <br /> -  <a class="el" href="classllfio__v2__xxx_1_1section__handle.html#a5a4e0afe59d0eeb5683fb50d3d3ad549aaa630970737cad05cddc88036a638d44">none</a> = 0U, -<a class="el" href="classllfio__v2__xxx_1_1section__handle.html#a5a4e0afe59d0eeb5683fb50d3d3ad549a63bd03aae67c348121ac0bf88161d90f">read</a> = 1U << 0U, -<a class="el" href="classllfio__v2__xxx_1_1section__handle.html#a5a4e0afe59d0eeb5683fb50d3d3ad549ab61620219a89d4c133c6c6f4b781a9ba">write</a> = 1U << 1U, -<a class="el" href="classllfio__v2__xxx_1_1section__handle.html#a5a4e0afe59d0eeb5683fb50d3d3ad549ac57346933aada59cff3ee2296cc70332">cow</a> = 1U << 2U, -<br /> -  <a class="el" href="classllfio__v2__xxx_1_1section__handle.html#a5a4e0afe59d0eeb5683fb50d3d3ad549a631fef30d1e40f9d7ce6fa3a0ad4fa9d">execute</a> = 1U << 3U, -<a class="el" href="classllfio__v2__xxx_1_1section__handle.html#a5a4e0afe59d0eeb5683fb50d3d3ad549a979d3bc3dccd10f67de00b228a12822f">nocommit</a> = 1U << 8U, -<a class="el" href="classllfio__v2__xxx_1_1section__handle.html#a5a4e0afe59d0eeb5683fb50d3d3ad549a1e91d093711d9d800b8ddc2f6e5d1ca2">prefault</a> = 1U << 9U, -<a class="el" href="classllfio__v2__xxx_1_1section__handle.html#a5a4e0afe59d0eeb5683fb50d3d3ad549afde37a72636d74e28ce3553154341756">executable</a> = 1U << 10U, -<br /> -  <a class="el" href="classllfio__v2__xxx_1_1section__handle.html#a5a4e0afe59d0eeb5683fb50d3d3ad549a41771be4e90788c06cc49f2d35538108">singleton</a> = 1U << 11U, -<a class="el" href="classllfio__v2__xxx_1_1section__handle.html#a5a4e0afe59d0eeb5683fb50d3d3ad549a06b41188d84f0fee5cff37c71b3d5877">barrier_on_close</a> = 1U << 16U, -<a class="el" href="classllfio__v2__xxx_1_1section__handle.html#a5a4e0afe59d0eeb5683fb50d3d3ad549a2087205d797bb4de249c85cc8b87afc5">nvram</a> = 1U << 17U, -<a class="el" href="classllfio__v2__xxx_1_1section__handle.html#a5a4e0afe59d0eeb5683fb50d3d3ad549a8d15253a30787fff812c9f254e26baf1">page_sizes_1</a> = 1U << 24U, -<br /> -  <a class="el" href="classllfio__v2__xxx_1_1section__handle.html#a5a4e0afe59d0eeb5683fb50d3d3ad549aa3a2b1b4beaa0a8f0e2658cb321f7c46">page_sizes_2</a> = 2U << 24U, -<a class="el" href="classllfio__v2__xxx_1_1section__handle.html#a5a4e0afe59d0eeb5683fb50d3d3ad549a0a225b6b1594a5540799b4c58c937522">page_sizes_3</a> = 3U << 24U, -<b>readwrite</b> = (read | write) -<br /> - }<tr class="memdesc:a5a4e0afe59d0eeb5683fb50d3d3ad549"><td class="mdescLeft"> </td><td class="mdescRight">The behaviour of the memory section. <a href="classllfio__v2__xxx_1_1section__handle.html#a5a4e0afe59d0eeb5683fb50d3d3ad549">More...</a><br /></td></tr> -</td></tr> -<tr class="separator:a5a4e0afe59d0eeb5683fb50d3d3ad549"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a91a4e4110fe6ed6358de00de3ae934d1"><td class="memItemLeft" align="right" valign="top"><a id="a91a4e4110fe6ed6358de00de3ae934d1"></a> using </td><td class="memItemRight" valign="bottom"><b>extent_type</b> = <a class="el" href="classllfio__v2__xxx_1_1handle.html#a4ee58f1b6a24af5e64d850d1e3eed07f">handle::extent_type</a></td></tr> <tr class="separator:a91a4e4110fe6ed6358de00de3ae934d1"><td class="memSeparator" colspan="2"> </td></tr> @@ -138,7 +115,7 @@ using </td><td class="memItemRight" valign="bottom"><b>size_type</b> = <a c <tr class="separator:ad623089ad47d566d5eeaefe202dbf3a0"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa3930273a2d4cabbac309e0b75701dca"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1handle.html#aa3930273a2d4cabbac309e0b75701dca">mode</a> : unsigned char { <br />   <b>unchanged</b> = 0, -<a class="el" href="classllfio__v2__xxx_1_1handle.html#a5929f46f42112bd805ab5001bfbf9d2aa334c4a4c42fdb79d7ebc3e73b517e6f8">none</a> = 2, +<a class="el" href="classllfio__v2__xxx_1_1handle.html#aa3930273a2d4cabbac309e0b75701dcaa334c4a4c42fdb79d7ebc3e73b517e6f8">mode::none</a> = 2, <a class="el" href="classllfio__v2__xxx_1_1handle.html#aa3930273a2d4cabbac309e0b75701dcaaa4daf6d1e8da35af49c33bbe9ee91d79">mode::attr_read</a> = 4, <a class="el" href="classllfio__v2__xxx_1_1handle.html#aa3930273a2d4cabbac309e0b75701dcaa9f56aff64cb748e078ab221474132d19">mode::attr_write</a> = 5, <br /> @@ -162,7 +139,7 @@ using </td><td class="memItemRight" valign="bottom"><b>size_type</b> = <a c <tr class="separator:af0b352d0f273ba6fa70c178b2c2fee42"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aecd3a7db6cee3aec07d32fe6f99e6852"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1handle.html#aecd3a7db6cee3aec07d32fe6f99e6852">caching</a> : unsigned char { <br />   <b>unchanged</b> = 0, -<a class="el" href="classllfio__v2__xxx_1_1handle.html#a5929f46f42112bd805ab5001bfbf9d2aa334c4a4c42fdb79d7ebc3e73b517e6f8">none</a> = 1, +<a class="el" href="classllfio__v2__xxx_1_1handle.html#aecd3a7db6cee3aec07d32fe6f99e6852a334c4a4c42fdb79d7ebc3e73b517e6f8">caching::none</a> = 1, <a class="el" href="classllfio__v2__xxx_1_1handle.html#aecd3a7db6cee3aec07d32fe6f99e6852ab8a61dd00ce6fc5888706bda8fab2e98">caching::only_metadata</a> = 2, <a class="el" href="classllfio__v2__xxx_1_1handle.html#aecd3a7db6cee3aec07d32fe6f99e6852a0fb9cf5f04f61bb6f1151da57ceb1ca1">caching::reads</a> = 3, <br /> @@ -181,6 +158,12 @@ using </td><td class="memItemRight" valign="bottom"><a class="el" href="cla </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:a5405985448afbfe281cbf98ab7bbb3ab"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1section__handle.html#a5405985448afbfe281cbf98ab7bbb3ab">QUICKCPPLIB_BITFIELD_BEGIN</a> (flag)</td></tr> +<tr class="memdesc:a5405985448afbfe281cbf98ab7bbb3ab"><td class="mdescLeft"> </td><td class="mdescRight">The behaviour of the memory section. <a href="#a5405985448afbfe281cbf98ab7bbb3ab">More...</a><br /></td></tr> +<tr class="separator:a5405985448afbfe281cbf98ab7bbb3ab"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad057ca569878e127389457e80e0f393d"><td class="memItemLeft" align="right" valign="top"><a id="ad057ca569878e127389457e80e0f393d"></a> + </td><td class="memItemRight" valign="bottom"><b>QUICKCPPLIB_BITFIELD_END</b> (flag)</td></tr> +<tr class="separator:ad057ca569878e127389457e80e0f393d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a967031835185e5ba872a4e584d51c40d"><td class="memItemLeft" align="right" valign="top"><a id="a967031835185e5ba872a4e584d51c40d"></a> virtual result< void > </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1section__handle.html#a967031835185e5ba872a4e584d51c40d">close</a> () noexcept override</td></tr> <tr class="memdesc:a967031835185e5ba872a4e584d51c40d"><td class="mdescLeft"> </td><td class="mdescRight">Immediately close the native handle type managed by this handle. <br /></td></tr> @@ -354,7 +337,7 @@ Protected Attributes</h2></td></tr> flag </td><td class="memItemRight" valign="bottom"><b>_flag</b> {flag::none}</td></tr> <tr class="separator:aff579de98516b809327d4443ad8eb84a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:affb091ded80ffde7c0c3854e2abc52fd"><td class="memItemLeft" align="right" valign="top"><a id="affb091ded80ffde7c0c3854e2abc52fd"></a> -<a class="el" href="classllfio__v2__xxx_1_1handle.html#aecd3a7db6cee3aec07d32fe6f99e6852">caching</a> </td><td class="memItemRight" valign="bottom"><b>_caching</b> {<a class="el" href="classllfio__v2__xxx_1_1handle.html#a5929f46f42112bd805ab5001bfbf9d2aa334c4a4c42fdb79d7ebc3e73b517e6f8">caching::none</a>}</td></tr> +<a class="el" href="classllfio__v2__xxx_1_1handle.html#aecd3a7db6cee3aec07d32fe6f99e6852">caching</a> </td><td class="memItemRight" valign="bottom"><b>_caching</b> {<a class="el" href="classllfio__v2__xxx_1_1handle.html#aecd3a7db6cee3aec07d32fe6f99e6852a334c4a4c42fdb79d7ebc3e73b517e6f8">caching::none</a>}</td></tr> <tr class="separator:affb091ded80ffde7c0c3854e2abc52fd"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad758cf1eb2e0b4c63583eab05e7f6820"><td class="memItemLeft" align="right" valign="top"><a id="ad758cf1eb2e0b4c63583eab05e7f6820"></a> flag </td><td class="memItemRight" valign="bottom"><b>_flags</b> {flag::none}</td></tr> @@ -368,66 +351,6 @@ flag </td><td class="memItemRight" valign="bottom"><b>_flags</b> {flag::non <p>There are two configurations of section handle, one where the user supplies the file backing for the section, and the other where an internal file descriptor to an unnamed inode in a tmpfs or ramfs based temporary directory is kept and managed. The latter is merely a convenience for creating an anonymous source of memory which can be resized whilst preserving contents: see <code>algorithm::trivial_vector<T></code>.</p> <p>On Windows the native handle of this handle is that of the NT kernel section object. On POSIX it is a cloned file descriptor of the backing storage if there is backing storage, else it will be the aforementioned file descriptor to an unnamed inode. </p> </div><h2 class="groupheader">Member Enumeration Documentation</h2> -<a id="a5a4e0afe59d0eeb5683fb50d3d3ad549"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a5a4e0afe59d0eeb5683fb50d3d3ad549">◆ </a></span>bitfield__flag</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">enum <a class="el" href="classllfio__v2__xxx_1_1section__handle.html#a5a4e0afe59d0eeb5683fb50d3d3ad549">llfio_v2_xxx::section_handle::bitfield__flag</a> : unsigned</td> - </tr> - </table> -</div><div class="memdoc"> - -<p>The behaviour of the memory section. </p> -<table class="fieldtable"> -<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a5a4e0afe59d0eeb5683fb50d3d3ad549aaa630970737cad05cddc88036a638d44"></a>none </td><td class="fielddoc"><p>No flags. </p> -</td></tr> -<tr><td class="fieldname"><a id="a5a4e0afe59d0eeb5683fb50d3d3ad549a63bd03aae67c348121ac0bf88161d90f"></a>read </td><td class="fielddoc"><p>Memory views can be read. </p> -</td></tr> -<tr><td class="fieldname"><a id="a5a4e0afe59d0eeb5683fb50d3d3ad549ab61620219a89d4c133c6c6f4b781a9ba"></a>write </td><td class="fielddoc"><p>Memory views can be written. </p> -</td></tr> -<tr><td class="fieldname"><a id="a5a4e0afe59d0eeb5683fb50d3d3ad549ac57346933aada59cff3ee2296cc70332"></a>cow </td><td class="fielddoc"><p>Memory views can be copy on written. </p> -</td></tr> -<tr><td class="fieldname"><a id="a5a4e0afe59d0eeb5683fb50d3d3ad549a631fef30d1e40f9d7ce6fa3a0ad4fa9d"></a>execute </td><td class="fielddoc"><p>Memory views can execute code. </p> -</td></tr> -<tr><td class="fieldname"><a id="a5a4e0afe59d0eeb5683fb50d3d3ad549a979d3bc3dccd10f67de00b228a12822f"></a>nocommit </td><td class="fielddoc"><p>Don't allocate space for this memory in the system immediately. </p> -</td></tr> -<tr><td class="fieldname"><a id="a5a4e0afe59d0eeb5683fb50d3d3ad549a1e91d093711d9d800b8ddc2f6e5d1ca2"></a>prefault </td><td class="fielddoc"><p>Prefault, as if by reading every page, any views of memory upon creation. </p> -</td></tr> -<tr><td class="fieldname"><a id="a5a4e0afe59d0eeb5683fb50d3d3ad549afde37a72636d74e28ce3553154341756"></a>executable </td><td class="fielddoc"><p>The backing storage is in fact an executable program binary. </p> -</td></tr> -<tr><td class="fieldname"><a id="a5a4e0afe59d0eeb5683fb50d3d3ad549a41771be4e90788c06cc49f2d35538108"></a>singleton </td><td class="fielddoc"><p>A single instance of this section is to be shared by all processes using the same backing file. </p> -</td></tr> -<tr><td class="fieldname"><a id="a5a4e0afe59d0eeb5683fb50d3d3ad549a06b41188d84f0fee5cff37c71b3d5877"></a>barrier_on_close </td><td class="fielddoc"><p>Maps of this section, if writable, issue a <code>barrier()</code> when destructed blocking until data (not metadata) reaches physical storage. </p> -</td></tr> -<tr><td class="fieldname"><a id="a5a4e0afe59d0eeb5683fb50d3d3ad549a2087205d797bb4de249c85cc8b87afc5"></a>nvram </td><td class="fielddoc"><p>This section is of non-volatile RAM. </p> -</td></tr> -<tr><td class="fieldname"><a id="a5a4e0afe59d0eeb5683fb50d3d3ad549a8d15253a30787fff812c9f254e26baf1"></a>page_sizes_1 </td><td class="fielddoc"><p>Use <code>utils::page_sizes()[1]</code> sized pages, or fail. </p> -</td></tr> -<tr><td class="fieldname"><a id="a5a4e0afe59d0eeb5683fb50d3d3ad549aa3a2b1b4beaa0a8f0e2658cb321f7c46"></a>page_sizes_2 </td><td class="fielddoc"><p>Use <code>utils::page_sizes()[2]</code> sized pages, or fail. </p> -</td></tr> -<tr><td class="fieldname"><a id="a5a4e0afe59d0eeb5683fb50d3d3ad549a0a225b6b1594a5540799b4c58c937522"></a>page_sizes_3 </td><td class="fielddoc"><p>Use <code>utils::page_sizes()[3]</code> sized pages, or fail. </p> -</td></tr> -</table> -<div class="fragment"><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  {<a class="code" href="classllfio__v2__xxx_1_1section__handle.html#a5a4e0afe59d0eeb5683fb50d3d3ad549aaa630970737cad05cddc88036a638d44">none</a> = 0U, <span class="comment">//!< No flags</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"></span> <a class="code" href="classllfio__v2__xxx_1_1section__handle.html#a5a4e0afe59d0eeb5683fb50d3d3ad549a63bd03aae67c348121ac0bf88161d90f">read</a> = 1U << 0U, <span class="comment">//!< Memory views can be read</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"></span> <a class="code" href="classllfio__v2__xxx_1_1section__handle.html#a5a4e0afe59d0eeb5683fb50d3d3ad549ab61620219a89d4c133c6c6f4b781a9ba">write</a> = 1U << 1U, <span class="comment">//!< Memory views can be written</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"></span> <a class="code" href="classllfio__v2__xxx_1_1section__handle.html#a5a4e0afe59d0eeb5683fb50d3d3ad549ac57346933aada59cff3ee2296cc70332">cow</a> = 1U << 2U, <span class="comment">//!< Memory views can be copy on written</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"></span> <a class="code" href="classllfio__v2__xxx_1_1section__handle.html#a5a4e0afe59d0eeb5683fb50d3d3ad549a631fef30d1e40f9d7ce6fa3a0ad4fa9d">execute</a> = 1U << 3U, <span class="comment">//!< Memory views can execute code</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"></span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <a class="code" href="classllfio__v2__xxx_1_1section__handle.html#a5a4e0afe59d0eeb5683fb50d3d3ad549a979d3bc3dccd10f67de00b228a12822f">nocommit</a> = 1U << 8U, <span class="comment">//!< Don't allocate space for this memory in the system immediately</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"></span> <a class="code" href="classllfio__v2__xxx_1_1section__handle.html#a5a4e0afe59d0eeb5683fb50d3d3ad549a1e91d093711d9d800b8ddc2f6e5d1ca2">prefault</a> = 1U << 9U, <span class="comment">//!< Prefault, as if by reading every page, any views of memory upon creation.</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"></span> <a class="code" href="classllfio__v2__xxx_1_1section__handle.html#a5a4e0afe59d0eeb5683fb50d3d3ad549afde37a72636d74e28ce3553154341756">executable</a> = 1U << 10U, <span class="comment">//!< The backing storage is in fact an executable program binary.</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"></span> <a class="code" href="classllfio__v2__xxx_1_1section__handle.html#a5a4e0afe59d0eeb5683fb50d3d3ad549a41771be4e90788c06cc49f2d35538108">singleton</a> = 1U << 11U, <span class="comment">//!< A single instance of this section is to be shared by all processes using the same backing file.</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"></span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <a class="code" href="classllfio__v2__xxx_1_1section__handle.html#a5a4e0afe59d0eeb5683fb50d3d3ad549a06b41188d84f0fee5cff37c71b3d5877">barrier_on_close</a> = 1U << 16U, <span class="comment">//!< Maps of this section, if writable, issue a `barrier()` when destructed blocking until data (not metadata) reaches physical storage.</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"></span> <a class="code" href="classllfio__v2__xxx_1_1section__handle.html#a5a4e0afe59d0eeb5683fb50d3d3ad549a2087205d797bb4de249c85cc8b87afc5">nvram</a> = 1U << 17U, <span class="comment">//!< This section is of non-volatile RAM</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"></span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <a class="code" href="classllfio__v2__xxx_1_1section__handle.html#a5a4e0afe59d0eeb5683fb50d3d3ad549a8d15253a30787fff812c9f254e26baf1">page_sizes_1</a> = 1U << 24U, <span class="comment">//!< Use `utils::page_sizes()[1]` sized pages, or fail.</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"></span> <a class="code" href="classllfio__v2__xxx_1_1section__handle.html#a5a4e0afe59d0eeb5683fb50d3d3ad549aa3a2b1b4beaa0a8f0e2658cb321f7c46">page_sizes_2</a> = 2U << 24U, <span class="comment">//!< Use `utils::page_sizes()[2]` sized pages, or fail.</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"></span> <a class="code" href="classllfio__v2__xxx_1_1section__handle.html#a5a4e0afe59d0eeb5683fb50d3d3ad549a0a225b6b1594a5540799b4c58c937522">page_sizes_3</a> = 3U << 24U, <span class="comment">//!< Use `utils::page_sizes()[3]` sized pages, or fail.</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"></span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="comment">// NOTE: IF UPDATING THIS UPDATE THE std::ostream PRINTER BELOW!!!</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  readwrite = (read | <a class="code" href="classllfio__v2__xxx_1_1section__handle.html#a5a4e0afe59d0eeb5683fb50d3d3ad549ab61620219a89d4c133c6c6f4b781a9ba">write</a>)};</div><div class="ttc" id="classllfio__v2__xxx_1_1section__handle_html_a5a4e0afe59d0eeb5683fb50d3d3ad549a979d3bc3dccd10f67de00b228a12822f"><div class="ttname"><a href="classllfio__v2__xxx_1_1section__handle.html#a5a4e0afe59d0eeb5683fb50d3d3ad549a979d3bc3dccd10f67de00b228a12822f">llfio_v2_xxx::section_handle::nocommit</a></div><div class="ttdoc">Don&#39;t allocate space for this memory in the system immediately. </div><div class="ttdef"><b>Definition:</b> map_handle.hpp:64</div></div> -<div class="ttc" id="classllfio__v2__xxx_1_1section__handle_html_a5a4e0afe59d0eeb5683fb50d3d3ad549aaa630970737cad05cddc88036a638d44"><div class="ttname"><a href="classllfio__v2__xxx_1_1section__handle.html#a5a4e0afe59d0eeb5683fb50d3d3ad549aaa630970737cad05cddc88036a638d44">llfio_v2_xxx::section_handle::none</a></div><div class="ttdoc">No flags. </div><div class="ttdef"><b>Definition:</b> map_handle.hpp:58</div></div> -<div class="ttc" id="classllfio__v2__xxx_1_1section__handle_html_a5a4e0afe59d0eeb5683fb50d3d3ad549a0a225b6b1594a5540799b4c58c937522"><div class="ttname"><a href="classllfio__v2__xxx_1_1section__handle.html#a5a4e0afe59d0eeb5683fb50d3d3ad549a0a225b6b1594a5540799b4c58c937522">llfio_v2_xxx::section_handle::page_sizes_3</a></div><div class="ttdoc">Use utils::page_sizes()[3] sized pages, or fail. </div><div class="ttdef"><b>Definition:</b> map_handle.hpp:74</div></div> -<div class="ttc" id="classllfio__v2__xxx_1_1section__handle_html_a5a4e0afe59d0eeb5683fb50d3d3ad549aa3a2b1b4beaa0a8f0e2658cb321f7c46"><div class="ttname"><a href="classllfio__v2__xxx_1_1section__handle.html#a5a4e0afe59d0eeb5683fb50d3d3ad549aa3a2b1b4beaa0a8f0e2658cb321f7c46">llfio_v2_xxx::section_handle::page_sizes_2</a></div><div class="ttdoc">Use utils::page_sizes()[2] sized pages, or fail. </div><div class="ttdef"><b>Definition:</b> map_handle.hpp:73</div></div> -<div class="ttc" id="classllfio__v2__xxx_1_1section__handle_html_a5a4e0afe59d0eeb5683fb50d3d3ad549afde37a72636d74e28ce3553154341756"><div class="ttname"><a href="classllfio__v2__xxx_1_1section__handle.html#a5a4e0afe59d0eeb5683fb50d3d3ad549afde37a72636d74e28ce3553154341756">llfio_v2_xxx::section_handle::executable</a></div><div class="ttdoc">The backing storage is in fact an executable program binary. </div><div class="ttdef"><b>Definition:</b> map_handle.hpp:66</div></div> -<div class="ttc" id="classllfio__v2__xxx_1_1section__handle_html_a5a4e0afe59d0eeb5683fb50d3d3ad549a63bd03aae67c348121ac0bf88161d90f"><div class="ttname"><a href="classllfio__v2__xxx_1_1section__handle.html#a5a4e0afe59d0eeb5683fb50d3d3ad549a63bd03aae67c348121ac0bf88161d90f">llfio_v2_xxx::section_handle::read</a></div><div class="ttdoc">Memory views can be read. </div><div class="ttdef"><b>Definition:</b> map_handle.hpp:59</div></div> -<div class="ttc" id="classllfio__v2__xxx_1_1section__handle_html_a5a4e0afe59d0eeb5683fb50d3d3ad549a2087205d797bb4de249c85cc8b87afc5"><div class="ttname"><a href="classllfio__v2__xxx_1_1section__handle.html#a5a4e0afe59d0eeb5683fb50d3d3ad549a2087205d797bb4de249c85cc8b87afc5">llfio_v2_xxx::section_handle::nvram</a></div><div class="ttdoc">This section is of non-volatile RAM. </div><div class="ttdef"><b>Definition:</b> map_handle.hpp:70</div></div> -<div class="ttc" id="classllfio__v2__xxx_1_1section__handle_html_a5a4e0afe59d0eeb5683fb50d3d3ad549a06b41188d84f0fee5cff37c71b3d5877"><div class="ttname"><a href="classllfio__v2__xxx_1_1section__handle.html#a5a4e0afe59d0eeb5683fb50d3d3ad549a06b41188d84f0fee5cff37c71b3d5877">llfio_v2_xxx::section_handle::barrier_on_close</a></div><div class="ttdoc">Maps of this section, if writable, issue a barrier() when destructed blocking until data (not metadat...</div><div class="ttdef"><b>Definition:</b> map_handle.hpp:69</div></div> -<div class="ttc" id="classllfio__v2__xxx_1_1section__handle_html_a5a4e0afe59d0eeb5683fb50d3d3ad549ac57346933aada59cff3ee2296cc70332"><div class="ttname"><a href="classllfio__v2__xxx_1_1section__handle.html#a5a4e0afe59d0eeb5683fb50d3d3ad549ac57346933aada59cff3ee2296cc70332">llfio_v2_xxx::section_handle::cow</a></div><div class="ttdoc">Memory views can be copy on written. </div><div class="ttdef"><b>Definition:</b> map_handle.hpp:61</div></div> -<div class="ttc" id="classllfio__v2__xxx_1_1section__handle_html_a5a4e0afe59d0eeb5683fb50d3d3ad549a8d15253a30787fff812c9f254e26baf1"><div class="ttname"><a href="classllfio__v2__xxx_1_1section__handle.html#a5a4e0afe59d0eeb5683fb50d3d3ad549a8d15253a30787fff812c9f254e26baf1">llfio_v2_xxx::section_handle::page_sizes_1</a></div><div class="ttdoc">Use utils::page_sizes()[1] sized pages, or fail. </div><div class="ttdef"><b>Definition:</b> map_handle.hpp:72</div></div> -<div class="ttc" id="classllfio__v2__xxx_1_1section__handle_html_a5a4e0afe59d0eeb5683fb50d3d3ad549a1e91d093711d9d800b8ddc2f6e5d1ca2"><div class="ttname"><a href="classllfio__v2__xxx_1_1section__handle.html#a5a4e0afe59d0eeb5683fb50d3d3ad549a1e91d093711d9d800b8ddc2f6e5d1ca2">llfio_v2_xxx::section_handle::prefault</a></div><div class="ttdoc">Prefault, as if by reading every page, any views of memory upon creation. </div><div class="ttdef"><b>Definition:</b> map_handle.hpp:65</div></div> -<div class="ttc" id="classllfio__v2__xxx_1_1section__handle_html_a5a4e0afe59d0eeb5683fb50d3d3ad549ab61620219a89d4c133c6c6f4b781a9ba"><div class="ttname"><a href="classllfio__v2__xxx_1_1section__handle.html#a5a4e0afe59d0eeb5683fb50d3d3ad549ab61620219a89d4c133c6c6f4b781a9ba">llfio_v2_xxx::section_handle::write</a></div><div class="ttdoc">Memory views can be written. </div><div class="ttdef"><b>Definition:</b> map_handle.hpp:60</div></div> -<div class="ttc" id="classllfio__v2__xxx_1_1section__handle_html_a5a4e0afe59d0eeb5683fb50d3d3ad549a631fef30d1e40f9d7ce6fa3a0ad4fa9d"><div class="ttname"><a href="classllfio__v2__xxx_1_1section__handle.html#a5a4e0afe59d0eeb5683fb50d3d3ad549a631fef30d1e40f9d7ce6fa3a0ad4fa9d">llfio_v2_xxx::section_handle::execute</a></div><div class="ttdoc">Memory views can execute code. </div><div class="ttdef"><b>Definition:</b> map_handle.hpp:62</div></div> -<div class="ttc" id="classllfio__v2__xxx_1_1section__handle_html_a5a4e0afe59d0eeb5683fb50d3d3ad549a41771be4e90788c06cc49f2d35538108"><div class="ttname"><a href="classllfio__v2__xxx_1_1section__handle.html#a5a4e0afe59d0eeb5683fb50d3d3ad549a41771be4e90788c06cc49f2d35538108">llfio_v2_xxx::section_handle::singleton</a></div><div class="ttdoc">A single instance of this section is to be shared by all processes using the same backing file...</div><div class="ttdef"><b>Definition:</b> map_handle.hpp:67</div></div> -</div><!-- fragment --> -</div> -</div> <a id="aecd3a7db6cee3aec07d32fe6f99e6852"></a> <h2 class="memtitle"><span class="permalink"><a href="#aecd3a7db6cee3aec07d32fe6f99e6852">◆ </a></span>caching</h2> @@ -450,7 +373,7 @@ flag </td><td class="memItemRight" valign="bottom"><b>_flags</b> {flag::non <p>What i/o on the handle may complete immediately due to kernel caching. </p> <table class="fieldtable"> -<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a5929f46f42112bd805ab5001bfbf9d2aa334c4a4c42fdb79d7ebc3e73b517e6f8"></a>none </td><td class="fielddoc"><p>No caching whatsoever, all reads and writes come from storage (i.e. <code>O_DIRECT|O_SYNC</code>). Align all i/o to 4Kb boundaries for this to work. <code>disable_safety_barriers</code> can be used here. </p> +<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="aecd3a7db6cee3aec07d32fe6f99e6852a334c4a4c42fdb79d7ebc3e73b517e6f8"></a>none </td><td class="fielddoc"><p>No caching whatsoever, all reads and writes come from storage (i.e. <code>O_DIRECT|O_SYNC</code>). Align all i/o to 4Kb boundaries for this to work. <code>disable_safety_barriers</code> can be used here. </p> </td></tr> <tr><td class="fieldname"><a id="aecd3a7db6cee3aec07d32fe6f99e6852ab8a61dd00ce6fc5888706bda8fab2e98"></a>only_metadata </td><td class="fielddoc"><p>Cache reads and writes of metadata but avoid caching data (<code>O_DIRECT</code>), thus i/o here does not affect other cached data for other handles. Align all i/o to 4Kb boundaries for this to work. </p> </td></tr> @@ -465,8 +388,7 @@ flag </td><td class="memItemRight" valign="bottom"><b>_flags</b> {flag::non <tr><td class="fieldname"><a id="aecd3a7db6cee3aec07d32fe6f99e6852ad5197d93c063a2b1e22d1630a39b7aef"></a>temporary </td><td class="fielddoc"><p>Cache reads and writes of data and metadata so they complete immediately, only sending any updates to storage on last handle close in the system or if memory becomes tight as this file is expected to be temporary (Windows and FreeBSD only). </p> </td></tr> </table> -<div class="fragment"><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  : <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> <span class="comment">// bit 0 set means safety barriers enabled</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  {</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  unchanged = 0,</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <a class="code" href="classllfio__v2__xxx_1_1handle.html#a5929f46f42112bd805ab5001bfbf9d2aae6fb35b3d125d5d76bbef95b1d804298">none</a> = 1, <span class="comment">//!< No caching whatsoever, all reads and writes come from storage (i.e. <tt>O_DIRECT|O_SYNC</tt>). Align all i/o to 4Kb boundaries for this to work. <tt>disable_safety_barriers</tt> can be used here.</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"></span> only_metadata = 2, <span class="comment">//!< Cache reads and writes of metadata but avoid caching data (<tt>O_DIRECT</tt>), thus i/o here does not affect other cached data for other handles. Align all i/o to 4Kb boundaries for this to work.</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"></span> reads = 3, <span class="comment">//!< Cache reads only. Writes of data and metadata do not complete until reaching storage (<tt>O_SYNC</tt>). <tt>disable_safety_barriers</tt> can be used here.</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"></span> reads_and_metadata = 5, <span class="comment">//!< Cache reads and writes of metadata, but writes of data do not complete until reaching storage (<tt>O_DSYNC</tt>). <tt>disable_safety_barriers</tt> can be used here.</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"></span> all = 6, <span class="comment">//!< Cache reads and writes of data and metadata so they complete immediately, sending writes to storage at some point when the kernel decides (this is the default file system caching on a system).</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"></span> safety_barriers = 7, <span class="comment">//!< Cache reads and writes of data and metadata so they complete immediately, but issue safety barriers at certain points. See documentation for <tt>disable_safety_barriers</tt>.</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"></span> temporary = 8 <span class="comment">//!< Cache reads and writes of data and metadata so they complete immediately, only sending any updates to storage on last handle close in the system or if memory becomes tight as this file is expected to be temporary (Windows and FreeBSD only).</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"></span> <span class="comment">// NOTE: IF UPDATING THIS UPDATE THE std::ostream PRINTER BELOW!!!</span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  };</div><div class="ttc" id="classllfio__v2__xxx_1_1handle_html_a5929f46f42112bd805ab5001bfbf9d2aae6fb35b3d125d5d76bbef95b1d804298"><div class="ttname"><a href="classllfio__v2__xxx_1_1handle.html#a5929f46f42112bd805ab5001bfbf9d2aae6fb35b3d125d5d76bbef95b1d804298">llfio_v2_xxx::handle::none</a></div><div class="ttdoc">No flags. </div><div class="ttdef"><b>Definition:</b> handle.hpp:99</div></div> -</div><!-- fragment --> +<div class="fragment"><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  : <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> <span class="comment">// bit 0 set means safety barriers enabled</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  {</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  unchanged = 0,</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  none = 1, <span class="comment">//!< No caching whatsoever, all reads and writes come from storage (i.e. <tt>O_DIRECT|O_SYNC</tt>). Align all i/o to 4Kb boundaries for this to work. <tt>disable_safety_barriers</tt> can be used here.</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"></span> only_metadata = 2, <span class="comment">//!< Cache reads and writes of metadata but avoid caching data (<tt>O_DIRECT</tt>), thus i/o here does not affect other cached data for other handles. Align all i/o to 4Kb boundaries for this to work.</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"></span> reads = 3, <span class="comment">//!< Cache reads only. Writes of data and metadata do not complete until reaching storage (<tt>O_SYNC</tt>). <tt>disable_safety_barriers</tt> can be used here.</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"></span> reads_and_metadata = 5, <span class="comment">//!< Cache reads and writes of metadata, but writes of data do not complete until reaching storage (<tt>O_DSYNC</tt>). <tt>disable_safety_barriers</tt> can be used here.</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"></span> all = 6, <span class="comment">//!< Cache reads and writes of data and metadata so they complete immediately, sending writes to storage at some point when the kernel decides (this is the default file system caching on a system).</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"></span> safety_barriers = 7, <span class="comment">//!< Cache reads and writes of data and metadata so they complete immediately, but issue safety barriers at certain points. See documentation for <tt>disable_safety_barriers</tt>.</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"></span> temporary = 8 <span class="comment">//!< Cache reads and writes of data and metadata so they complete immediately, only sending any updates to storage on last handle close in the system or if memory becomes tight as this file is expected to be temporary (Windows and FreeBSD only).</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"></span> <span class="comment">// NOTE: IF UPDATING THIS UPDATE THE std::ostream PRINTER BELOW!!!</span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  };</div></div><!-- fragment --> </div> </div> <a id="af0b352d0f273ba6fa70c178b2c2fee42"></a> @@ -527,7 +449,7 @@ flag </td><td class="memItemRight" valign="bottom"><b>_flags</b> {flag::non <p>The behaviour of the handle: does it read, read and write, or atomic append? </p> <table class="fieldtable"> -<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a5929f46f42112bd805ab5001bfbf9d2aa334c4a4c42fdb79d7ebc3e73b517e6f8"></a>none </td><td class="fielddoc"><p>No ability to read or write anything, but can synchronise (SYNCHRONIZE or 0) </p> +<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="aa3930273a2d4cabbac309e0b75701dcaa334c4a4c42fdb79d7ebc3e73b517e6f8"></a>none </td><td class="fielddoc"><p>No ability to read or write anything, but can synchronise (SYNCHRONIZE or 0) </p> </td></tr> <tr><td class="fieldname"><a id="aa3930273a2d4cabbac309e0b75701dcaaa4daf6d1e8da35af49c33bbe9ee91d79"></a>attr_read </td><td class="fielddoc"><p>Ability to read attributes (FILE_READ_ATTRIBUTES|SYNCHRONIZE or O_RDONLY) </p> </td></tr> @@ -540,9 +462,8 @@ flag </td><td class="memItemRight" valign="bottom"><b>_flags</b> {flag::non <tr><td class="fieldname"><a id="aa3930273a2d4cabbac309e0b75701dcaa9516dfb15f51c7ee19a4d46b8c0dbe1d"></a>append </td><td class="fielddoc"><p>All mainstream OSs and CIFS guarantee this is atomic with respect to all other appenders (FILE_APPEND_DATA|SYNCHRONISE or O_APPEND) </p> </td></tr> </table> -<div class="fragment"><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  : <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> <span class="comment">// bit 0 set means writable</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  {</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  unchanged = 0,</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <a class="code" href="classllfio__v2__xxx_1_1handle.html#a5929f46f42112bd805ab5001bfbf9d2aae6fb35b3d125d5d76bbef95b1d804298">none</a> = 2, <span class="comment">//!< No ability to read or write anything, but can synchronise (SYNCHRONIZE or 0)</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"></span> attr_read = 4, <span class="comment">//!< Ability to read attributes (FILE_READ_ATTRIBUTES|SYNCHRONIZE or O_RDONLY)</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"></span> attr_write = 5, <span class="comment">//!< Ability to read and write attributes (FILE_READ_ATTRIBUTES|FILE_WRITE_ATTRIBUTES|SYNCHRONIZE or O_RDONLY)</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"></span> <a class="code" href="namespacellfio__v2__xxx.html#af678f58d20e1f0962ff0744150342683">read</a> = 6, <span class="comment">//!< Ability to read (READ_CONTROL|FILE_READ_DATA|FILE_READ_ATTRIBUTES|FILE_READ_EA|SYNCHRONISE or O_RDONLY)</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"></span> <a class="code" href="namespacellfio__v2__xxx.html#a5a8908704c9988bbecc69c2359e6fd4a">write</a> = 7, <span class="comment">//!< Ability to read and write (READ_CONTROL|FILE_READ_DATA|FILE_READ_ATTRIBUTES|FILE_READ_EA|FILE_WRITE_DATA|FILE_WRITE_ATTRIBUTES|FILE_WRITE_EA|FILE_APPEND_DATA|SYNCHRONISE or O_RDWR)</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"></span> append = 9 <span class="comment">//!< All mainstream OSs and CIFS guarantee this is atomic with respect to all other appenders (FILE_APPEND_DATA|SYNCHRONISE or O_APPEND)</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"></span> <span class="comment">// NOTE: IF UPDATING THIS UPDATE THE std::ostream PRINTER BELOW!!!</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  };</div><div class="ttc" id="namespacellfio__v2__xxx_html_af678f58d20e1f0962ff0744150342683"><div class="ttname"><a href="namespacellfio__v2__xxx.html#af678f58d20e1f0962ff0744150342683">llfio_v2_xxx::read</a></div><div class="ttdeci">file_handle::io_result< file_handle::size_type > read(file_handle &self, file_handle::extent_type offset, std::initializer_list< file_handle::buffer_type > lst, deadline d=deadline()) noexcept</div><div class="ttdef"><b>Definition:</b> file_handle.hpp:386</div></div> -<div class="ttc" id="classllfio__v2__xxx_1_1handle_html_a5929f46f42112bd805ab5001bfbf9d2aae6fb35b3d125d5d76bbef95b1d804298"><div class="ttname"><a href="classllfio__v2__xxx_1_1handle.html#a5929f46f42112bd805ab5001bfbf9d2aae6fb35b3d125d5d76bbef95b1d804298">llfio_v2_xxx::handle::none</a></div><div class="ttdoc">No flags. </div><div class="ttdef"><b>Definition:</b> handle.hpp:99</div></div> -<div class="ttc" id="namespacellfio__v2__xxx_html_a5a8908704c9988bbecc69c2359e6fd4a"><div class="ttname"><a href="namespacellfio__v2__xxx.html#a5a8908704c9988bbecc69c2359e6fd4a">llfio_v2_xxx::write</a></div><div class="ttdeci">io_handle::io_result< io_handle::const_buffers_type > write(io_handle &self, io_handle::io_request< io_handle::const_buffers_type > reqs, deadline d=deadline()) noexcept</div><div class="ttdoc">Write data to the open handle. </div><div class="ttdef"><b>Definition:</b> io_handle.hpp:588</div></div> +<div class="fragment"><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  : <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> <span class="comment">// bit 0 set means writable</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  {</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  unchanged = 0,</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  none = 2, <span class="comment">//!< No ability to read or write anything, but can synchronise (SYNCHRONIZE or 0)</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"></span> attr_read = 4, <span class="comment">//!< Ability to read attributes (FILE_READ_ATTRIBUTES|SYNCHRONIZE or O_RDONLY)</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"></span> attr_write = 5, <span class="comment">//!< Ability to read and write attributes (FILE_READ_ATTRIBUTES|FILE_WRITE_ATTRIBUTES|SYNCHRONIZE or O_RDONLY)</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"></span> <a class="code" href="namespacellfio__v2__xxx.html#af678f58d20e1f0962ff0744150342683">read</a> = 6, <span class="comment">//!< Ability to read (READ_CONTROL|FILE_READ_DATA|FILE_READ_ATTRIBUTES|FILE_READ_EA|SYNCHRONISE or O_RDONLY)</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"></span> <a class="code" href="namespacellfio__v2__xxx.html#a5a8908704c9988bbecc69c2359e6fd4a">write</a> = 7, <span class="comment">//!< Ability to read and write (READ_CONTROL|FILE_READ_DATA|FILE_READ_ATTRIBUTES|FILE_READ_EA|FILE_WRITE_DATA|FILE_WRITE_ATTRIBUTES|FILE_WRITE_EA|FILE_APPEND_DATA|SYNCHRONISE or O_RDWR)</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"></span> append = 9 <span class="comment">//!< All mainstream OSs and CIFS guarantee this is atomic with respect to all other appenders (FILE_APPEND_DATA|SYNCHRONISE or O_APPEND)</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"></span> <span class="comment">// NOTE: IF UPDATING THIS UPDATE THE std::ostream PRINTER BELOW!!!</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  };</div><div class="ttc" id="namespacellfio__v2__xxx_html_af678f58d20e1f0962ff0744150342683"><div class="ttname"><a href="namespacellfio__v2__xxx.html#af678f58d20e1f0962ff0744150342683">llfio_v2_xxx::read</a></div><div class="ttdeci">file_handle::io_result< file_handle::size_type > read(file_handle &self, file_handle::extent_type offset, std::initializer_list< file_handle::buffer_type > lst, deadline d=deadline()) noexcept</div><div class="ttdef"><b>Definition:</b> file_handle.hpp:387</div></div> +<div class="ttc" id="namespacellfio__v2__xxx_html_a5a8908704c9988bbecc69c2359e6fd4a"><div class="ttname"><a href="namespacellfio__v2__xxx.html#a5a8908704c9988bbecc69c2359e6fd4a">llfio_v2_xxx::write</a></div><div class="ttdeci">io_handle::io_result< io_handle::const_buffers_type > write(io_handle &self, io_handle::io_request< io_handle::const_buffers_type > reqs, deadline d=deadline()) noexcept</div><div class="ttdoc">Write data to the open handle. </div><div class="ttdef"><b>Definition:</b> io_handle.hpp:623</div></div> </div><!-- fragment --> </div> </div> @@ -597,7 +518,7 @@ flag </td><td class="memItemRight" valign="bottom"><b>_flags</b> {flag::non </table> </div><div class="memdoc"> <p>Returns the current path of the open handle as said by the operating system. Note that you are NOT guaranteed that any path refreshed bears any resemblance to the original, some operating systems will return some different path which still reaches the same inode via some other route e.g. hardlinks, dereferenced symbolic links, etc. Windows and Linux correctly track changes to the specific path the handle was opened with, not getting confused by other hard links. MacOS nearly gets it right, but under some circumstances e.g. renaming may switch to a different hard link's path which is almost certainly a bug.</p> -<p>If LLFIO was not able to determine the current path for this open handle e.g. the inode has been unlinked, it returns an empty path. Be aware that FreeBSD can return an empty (deleted) path for file inodes no longer cached by the kernel path cache, LLFIO cannot detect the difference. FreeBSD will also return any path leading to the inode if it is hard linked. FreeBSD does implement path retrieval for directory inodes correctly however, and see <code>algorithm::stablized_path<T></code> for a handle adapter which makes use of that.</p> +<p>If LLFIO was not able to determine the current path for this open handle e.g. the inode has been unlinked, it returns an empty path. Be aware that FreeBSD can return an empty (deleted) path for file inodes no longer cached by the kernel path cache, LLFIO cannot detect the difference. FreeBSD will also return any path leading to the inode if it is hard linked. FreeBSD does implement path retrieval for directory inodes correctly however, and see <code>algorithm::cached_parent_handle_adapter<T></code> for a handle adapter which makes use of that.</p> <p>On Linux if <code>/proc</code> is not mounted, this call fails with an error. All APIs in LLFIO which require the use of <code>current_path()</code> can be told to not use it e.g. <code>flag::disable_safety_unlinks</code>. It is up to you to detect if <code>current_path()</code> is not working, and to change how you call LLFIO appropriately.</p> <dl class="section warning"><dt>Warning</dt><dd>This call is expensive, it always asks the kernel for the current path, and no checking is done to ensure what the kernel returns is accurate or even sensible. Be aware that despite these precautions, paths are unstable and <b>can change randomly at any moment</b>. Most code written to use absolute file systems paths is <b>racy</b>, so don't do it, use <code>path_handle</code> to fix a base location on the file system and work from that anchor instead!</dd></dl> <dl class="section user"><dt>Memory Allocations</dt><dd>At least one malloc for the <code>path_type</code>, likely several more. </dd></dl> @@ -607,6 +528,50 @@ flag </td><td class="memItemRight" valign="bottom"><b>_flags</b> {flag::non </div> </div> +<a id="a5405985448afbfe281cbf98ab7bbb3ab"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a5405985448afbfe281cbf98ab7bbb3ab">◆ </a></span>QUICKCPPLIB_BITFIELD_BEGIN()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">llfio_v2_xxx::section_handle::QUICKCPPLIB_BITFIELD_BEGIN </td> + <td>(</td> + <td class="paramtype">flag </td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>The behaviour of the memory section. </p> +<p>< No flags</p> +<p>< Memory views can be read</p> +<p>< Memory views can be written</p> +<p>< Memory views can be copy on written</p> +<p>< Memory views can execute code</p> +<p>< Don't allocate space for this memory in the system immediately</p> +<p>< Prefault, as if by reading every page, any views of memory upon creation.</p> +<p>< The backing storage is in fact an executable program binary.</p> +<p>< A single instance of this section is to be shared by all processes using the same backing file.</p> +<p>< Maps of this section, if writable, issue a <code>barrier()</code> when destructed blocking until data (not metadata) reaches physical storage.</p> +<p>< This section is of non-volatile RAM</p> +<p>< Use <code>utils::page_sizes()[1]</code> sized pages, or fail.</p> +<p>< Use <code>utils::page_sizes()[2]</code> sized pages, or fail.</p> +<p>< Use <code>utils::page_sizes()[3]</code> sized pages, or fail. </p> +<div class="fragment"><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  {none = 0U, <span class="comment">//!< No flags</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"></span> <a class="code" href="namespacellfio__v2__xxx.html#ab993693c98cdb52e2d611f8f9e24e4e2">read</a> = 1U << 0U, <span class="comment">//!< Memory views can be read</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"></span> <a class="code" href="namespacellfio__v2__xxx.html#a681ed7e98ac17e6bb336b9287365141b">write</a> = 1U << 1U, <span class="comment">//!< Memory views can be written</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"></span> cow = 1U << 2U, <span class="comment">//!< Memory views can be copy on written</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"></span> execute = 1U << 3U, <span class="comment">//!< Memory views can execute code</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"></span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  nocommit = 1U << 8U, <span class="comment">//!< Don't allocate space for this memory in the system immediately</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"></span> prefault = 1U << 9U, <span class="comment">//!< Prefault, as if by reading every page, any views of memory upon creation.</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"></span> executable = 1U << 10U, <span class="comment">//!< The backing storage is in fact an executable program binary.</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"></span> singleton = 1U << 11U, <span class="comment">//!< A single instance of this section is to be shared by all processes using the same backing file.</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"></span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  barrier_on_close = 1U << 16U, <span class="comment">//!< Maps of this section, if writable, issue a `barrier()` when destructed blocking until data (not metadata) reaches physical storage.</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"></span> nvram = 1U << 17U, <span class="comment">//!< This section is of non-volatile RAM</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"></span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  page_sizes_1 = 1U << 24U, <span class="comment">//!< Use `utils::page_sizes()[1]` sized pages, or fail.</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"></span> page_sizes_2 = 2U << 24U, <span class="comment">//!< Use `utils::page_sizes()[2]` sized pages, or fail.</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"></span> page_sizes_3 = 3U << 24U, <span class="comment">//!< Use `utils::page_sizes()[3]` sized pages, or fail.</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"></span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="comment">// NOTE: IF UPDATING THIS UPDATE THE std::ostream PRINTER BELOW!!!</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  readwrite = (read | <a class="code" href="namespacellfio__v2__xxx.html#a681ed7e98ac17e6bb336b9287365141b">write</a>)};</div><div class="ttc" id="namespacellfio__v2__xxx_html_a681ed7e98ac17e6bb336b9287365141b"><div class="ttname"><a href="namespacellfio__v2__xxx.html#a681ed7e98ac17e6bb336b9287365141b">llfio_v2_xxx::write</a></div><div class="ttdeci">map_handle::io_result< map_handle::const_buffers_type > write(map_handle &self, map_handle::io_request< map_handle::const_buffers_type > reqs, deadline d=deadline()) noexcept</div><div class="ttdoc">Write data to the mapped view. </div><div class="ttdef"><b>Definition:</b> map_handle.hpp:822</div></div> +<div class="ttc" id="namespacellfio__v2__xxx_html_ab993693c98cdb52e2d611f8f9e24e4e2"><div class="ttname"><a href="namespacellfio__v2__xxx.html#ab993693c98cdb52e2d611f8f9e24e4e2">llfio_v2_xxx::read</a></div><div class="ttdeci">map_handle::io_result< map_handle::buffers_type > read(map_handle &self, map_handle::io_request< map_handle::buffers_type > reqs, deadline d=deadline()) noexcept</div><div class="ttdoc">Read data from the mapped view. </div><div class="ttdef"><b>Definition:</b> map_handle.hpp:808</div></div> +</div><!-- fragment --> +</div> +</div> <a id="a00db3d1bbffbdb4237401568c441da21"></a> <h2 class="memtitle"><span class="permalink"><a href="#a00db3d1bbffbdb4237401568c441da21">◆ </a></span>section() <span class="overload">[1/3]</span></h2> @@ -705,7 +670,7 @@ flag </td><td class="memItemRight" valign="bottom"><b>_flags</b> {flag::non <p>This convenience overload create a writable section if the backing file is writable, otherwise a read-only section.</p> <dl class="section user"><dt>Errors returnable</dt><dd>Any of the values POSIX dup(), open() or NtCreateSection() can return. </dd></dl> <div class="fragment"><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> { <span class="keywordflow">return</span> <a class="code" href="classllfio__v2__xxx_1_1section__handle.html#a00db3d1bbffbdb4237401568c441da21">section</a>(<a class="code" href="classllfio__v2__xxx_1_1section__handle.html#a680320bd539378d99870d9b2cdedb9c8">backing</a>, bytes, <a class="code" href="classllfio__v2__xxx_1_1section__handle.html#a680320bd539378d99870d9b2cdedb9c8">backing</a>.<a class="code" href="classllfio__v2__xxx_1_1handle.html#a211fee447a47bdeb5424a2a5ae1de852">is_writable</a>() ? (flag::readwrite) : (<a class="code" href="namespacellfio__v2__xxx.html#ab993693c98cdb52e2d611f8f9e24e4e2">flag::read</a>)); }</div><div class="ttc" id="classllfio__v2__xxx_1_1section__handle_html_a680320bd539378d99870d9b2cdedb9c8"><div class="ttname"><a href="classllfio__v2__xxx_1_1section__handle.html#a680320bd539378d99870d9b2cdedb9c8">llfio_v2_xxx::section_handle::backing</a></div><div class="ttdeci">file_handle * backing() const noexcept</div><div class="ttdoc">Returns the borrowed handle backing this section, if any. </div><div class="ttdef"><b>Definition:</b> map_handle.hpp:163</div></div> -<div class="ttc" id="namespacellfio__v2__xxx_html_ab993693c98cdb52e2d611f8f9e24e4e2"><div class="ttname"><a href="namespacellfio__v2__xxx.html#ab993693c98cdb52e2d611f8f9e24e4e2">llfio_v2_xxx::read</a></div><div class="ttdeci">map_handle::io_result< map_handle::buffers_type > read(map_handle &self, map_handle::io_request< map_handle::buffers_type > reqs, deadline d=deadline()) noexcept</div><div class="ttdoc">Read data from the mapped view. </div><div class="ttdef"><b>Definition:</b> map_handle.hpp:812</div></div> +<div class="ttc" id="namespacellfio__v2__xxx_html_ab993693c98cdb52e2d611f8f9e24e4e2"><div class="ttname"><a href="namespacellfio__v2__xxx.html#ab993693c98cdb52e2d611f8f9e24e4e2">llfio_v2_xxx::read</a></div><div class="ttdeci">map_handle::io_result< map_handle::buffers_type > read(map_handle &self, map_handle::io_request< map_handle::buffers_type > reqs, deadline d=deadline()) noexcept</div><div class="ttdoc">Read data from the mapped view. </div><div class="ttdef"><b>Definition:</b> map_handle.hpp:808</div></div> <div class="ttc" id="classllfio__v2__xxx_1_1handle_html_a211fee447a47bdeb5424a2a5ae1de852"><div class="ttname"><a href="classllfio__v2__xxx_1_1handle.html#a211fee447a47bdeb5424a2a5ae1de852">llfio_v2_xxx::handle::is_writable</a></div><div class="ttdeci">bool is_writable() const noexcept</div><div class="ttdoc">True if the handle is writable. </div><div class="ttdef"><b>Definition:</b> handle.hpp:290</div></div> <div class="ttc" id="classllfio__v2__xxx_1_1section__handle_html_a00db3d1bbffbdb4237401568c441da21"><div class="ttname"><a href="classllfio__v2__xxx_1_1section__handle.html#a00db3d1bbffbdb4237401568c441da21">llfio_v2_xxx::section_handle::section</a></div><div class="ttdeci">static result< section_handle > section(file_handle &backing, extent_type maximum_size, flag _flag) noexcept</div><div class="ttdoc">Create a memory section backed by a file. </div></div> </div><!-- fragment --> |