diff options
Diffstat (limited to 'utils_8hpp.html')
| -rw-r--r-- | utils_8hpp.html | 51 |
1 files changed, 24 insertions, 27 deletions
diff --git a/utils_8hpp.html b/utils_8hpp.html index 22491a15..31a5017e 100644 --- a/utils_8hpp.html +++ b/utils_8hpp.html @@ -1,9 +1,9 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.13"/> +<meta name="generator" content="Doxygen 1.8.17"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>LLFIO: include/llfio/v2.0/utils.hpp File Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> @@ -13,9 +13,6 @@ <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtreedata.js"></script> <script type="text/javascript" src="navtree.js"></script> -<script type="text/javascript"> - $(document).ready(initResizable); -</script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/searchdata.js"></script> <script type="text/javascript" src="search/search.js"></script> @@ -29,7 +26,7 @@ <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">LLFIO -  <span id="projectnumber">v2.00 late alpha</span> +  <span id="projectnumber">v2.00 late beta</span> </div> </td> </tr> @@ -37,18 +34,21 @@ </table> </div> <!-- end header part --> -<!-- Generated by Doxygen 1.8.13 --> +<!-- Generated by Doxygen 1.8.17 --> <script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ var searchBox = new SearchBox("searchBox", "search",false,'Search'); +/* @license-end */ </script> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(function() { initMenu('',true,false,'search.php','Search'); $(document).ready(function() { init_search(); }); }); -</script> +/* @license-end */</script> <div id="main-nav"></div> </div><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> @@ -62,7 +62,9 @@ $(function() { </div> </div> <script type="text/javascript"> -$(document).ready(function(){initNavTree('utils_8hpp.html','');}); +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(document).ready(function(){initNavTree('utils_8hpp.html',''); initResizable(); }); +/* @license-end */ </script> <div id="doc-content"> <!-- window showing the filter options --> @@ -88,22 +90,22 @@ $(document).ready(function(){initNavTree('utils_8hpp.html','');}); <div class="title">utils.hpp File Reference</div> </div> </div><!--header--> <div class="contents"> - -<p>Provides namespace utils. -<a href="#details">More...</a></p> <div class="textblock"><code>#include "<a class="el" href="config_8hpp.html">config.hpp</a>"</code><br /> <code>#include "quickcpplib/algorithm/string.hpp"</code><br /> </div><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> Classes</h2></td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structllfio__v2__xxx_1_1utils_1_1process__memory__usage.html">llfio_v2_xxx::utils::process_memory_usage</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Memory usage statistics for a process. <a href="structllfio__v2__xxx_1_1utils_1_1process__memory__usage.html#details">More...</a><br /></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1utils_1_1page__allocator.html">llfio_v2_xxx::utils::page_allocator< T ></a></td></tr> -<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">An STL allocator which allocates large TLB page memory.If the operating system is configured to allow it, this type of memory is particularly efficient for doing large scale file i/o. This is because the kernel must normally convert the scatter gather buffers you pass into extended scatter gather buffers as the memory you see as contiguous may not, and probably isn't, actually be contiguous in physical memory. Regions returned by this allocator <em>may</em> be allocated contiguously in physical memory and therefore the kernel can pass through your scatter gather buffers unmodified. <a href="classllfio__v2__xxx_1_1utils_1_1page__allocator.html#details">More...</a><br /></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">An STL allocator which allocates large TLB page memory. <a href="classllfio__v2__xxx_1_1utils_1_1page__allocator.html#details">More...</a><br /></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structllfio__v2__xxx_1_1utils_1_1page__allocator_1_1rebind.html">llfio_v2_xxx::utils::page_allocator< T >::rebind< U ></a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1utils_1_1page__allocator_3_01void_01_4.html">llfio_v2_xxx::utils::page_allocator< void ></a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structllfio__v2__xxx_1_1utils_1_1page__allocator_3_01void_01_4_1_1rebind.html">llfio_v2_xxx::utils::page_allocator< void >::rebind< U ></a></td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structllfio__v2__xxx_1_1utils_1_1page__allocator_3_01void_01_4_1_1rebind.html">llfio_v2_xxx::utils::page_allocator< void >::rebind</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a> @@ -130,17 +132,9 @@ template<class T > </td></tr> <tr class="memitem:a67f8f31f6b93293a22a4b30d686eb3af"><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacellfio__v2__xxx_1_1utils.html#a67f8f31f6b93293a22a4b30d686eb3af">llfio_v2_xxx::utils::round_up_to_page_size</a> (T i, size_t pagesize) noexcept</td></tr> <tr class="memdesc:a67f8f31f6b93293a22a4b30d686eb3af"><td class="mdescLeft"> </td><td class="mdescRight">Round a value to its next highest page size multiple. <br /></td></tr> <tr class="separator:a67f8f31f6b93293a22a4b30d686eb3af"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:afa36e8bc2a1f004696c09d104e23d685"><td class="memTemplParams" colspan="2"><a id="afa36e8bc2a1f004696c09d104e23d685"></a> -template<class T > </td></tr> -<tr class="memitem:afa36e8bc2a1f004696c09d104e23d685"><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacellfio__v2__xxx_1_1utils.html#afa36e8bc2a1f004696c09d104e23d685">llfio_v2_xxx::utils::round_to_page_size</a> (T i, size_t pagesize) noexcept</td></tr> -<tr class="memdesc:afa36e8bc2a1f004696c09d104e23d685"><td class="mdescLeft"> </td><td class="mdescRight">Round a pair of a pointer and a size_t to their nearest page size multiples. The pointer will be rounded down, the size_t upwards. <br /></td></tr> -<tr class="separator:afa36e8bc2a1f004696c09d104e23d685"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a6c41e314d4d4b8362b96a3b4c1c363f5"><td class="memItemLeft" align="right" valign="top">const std::vector< size_t > & </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacellfio__v2__xxx_1_1utils.html#a6c41e314d4d4b8362b96a3b4c1c363f5">llfio_v2_xxx::utils::page_sizes</a> (bool only_actually_available=true)</td></tr> -<tr class="memdesc:a6c41e314d4d4b8362b96a3b4c1c363f5"><td class="mdescLeft"> </td><td class="mdescRight">Returns the page sizes of this architecture which is useful for calculating direct i/o multiples. <a href="namespacellfio__v2__xxx_1_1utils.html#a6c41e314d4d4b8362b96a3b4c1c363f5">More...</a><br /></td></tr> -<tr class="separator:a6c41e314d4d4b8362b96a3b4c1c363f5"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a90d8f94ddb6e026f931e86d0dc904778"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacellfio__v2__xxx_1_1utils.html#a90d8f94ddb6e026f931e86d0dc904778">llfio_v2_xxx::utils::file_buffer_default_size</a> ()</td></tr> -<tr class="memdesc:a90d8f94ddb6e026f931e86d0dc904778"><td class="mdescLeft"> </td><td class="mdescRight">Returns a reasonable default size for page_allocator, typically the closest page size from page_sizes() to 1Mb. <a href="namespacellfio__v2__xxx_1_1utils.html#a90d8f94ddb6e026f931e86d0dc904778">More...</a><br /></td></tr> -<tr class="separator:a90d8f94ddb6e026f931e86d0dc904778"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a83420c7c9af03ca93d5ed029c34d5dd6"><td class="memItemLeft" align="right" valign="top">LLFIO_TEMPLATE(class T) LLFIO_TREQUIRES(LLFIO_TEXPR(std size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacellfio__v2__xxx_1_1utils.html#a83420c7c9af03ca93d5ed029c34d5dd6">llfio_v2_xxx::utils::file_buffer_default_size</a> ()</td></tr> +<tr class="memdesc:a83420c7c9af03ca93d5ed029c34d5dd6"><td class="mdescLeft"> </td><td class="mdescRight">Round a pair of a pointer and a size_t to their nearest page size multiples. The pointer will be rounded down, the size_t upwards. <a href="namespacellfio__v2__xxx_1_1utils.html#a83420c7c9af03ca93d5ed029c34d5dd6">More...</a><br /></td></tr> +<tr class="separator:a83420c7c9af03ca93d5ed029c34d5dd6"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae61e2de30b06776a1c24643a1d1dc64e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacellfio__v2__xxx_1_1utils.html#ae61e2de30b06776a1c24643a1d1dc64e">llfio_v2_xxx::utils::random_fill</a> (char *buffer, size_t bytes) noexcept</td></tr> <tr class="memdesc:ae61e2de30b06776a1c24643a1d1dc64e"><td class="mdescLeft"> </td><td class="mdescRight">Fills the buffer supplied with cryptographically strong randomness. Uses the OS kernel API. <a href="namespacellfio__v2__xxx_1_1utils.html#ae61e2de30b06776a1c24643a1d1dc64e">More...</a><br /></td></tr> <tr class="separator:ae61e2de30b06776a1c24643a1d1dc64e"><td class="memSeparator" colspan="2"> </td></tr> @@ -158,6 +152,9 @@ result< void > </td><td class="memItemRight" valign="bottom"><a class bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacellfio__v2__xxx_1_1utils.html#a7aae80908cc5521ef67234152c5c5044">llfio_v2_xxx::utils::running_under_wsl</a> () noexcept</td></tr> <tr class="memdesc:a7aae80908cc5521ef67234152c5c5044"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if this POSIX is running under Microsoft's Subsystem for Linux. <br /></td></tr> <tr class="separator:a7aae80908cc5521ef67234152c5c5044"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a5a2d8f932686b4c35a67a6aa972b4e92"><td class="memItemLeft" align="right" valign="top">result< process_memory_usage > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacellfio__v2__xxx_1_1utils.html#a5a2d8f932686b4c35a67a6aa972b4e92">llfio_v2_xxx::utils::current_process_memory_usage</a> () noexcept</td></tr> +<tr class="memdesc:a5a2d8f932686b4c35a67a6aa972b4e92"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the current memory usage statistics for this process. <a href="namespacellfio__v2__xxx_1_1utils.html#a5a2d8f932686b4c35a67a6aa972b4e92">More...</a><br /></td></tr> +<tr class="separator:a5a2d8f932686b4c35a67a6aa972b4e92"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:acf1b1646f257d85f7f2655df1042483f"><td class="memItemLeft" align="right" valign="top"><a id="acf1b1646f257d85f7f2655df1042483f"></a> large_page_allocation </td><td class="memItemRight" valign="bottom"><b>llfio_v2_xxx::utils::detail::calculate_large_page_allocation</b> (size_t bytes)</td></tr> <tr class="separator:acf1b1646f257d85f7f2655df1042483f"><td class="memSeparator" colspan="2"> </td></tr> @@ -173,7 +170,7 @@ template<class T , class U > </td></tr> <tr class="separator:ae880ebd5681dcf6b700d67fb10b4547e"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> -<div class="textblock"><p>Provides namespace utils. </p> +<div class="textblock"><p>Provides namespace utils </p> </div></div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> @@ -182,7 +179,7 @@ template<class T , class U > </td></tr> <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_9ffbcff25eb6a2bb8ed044f6c5d983c9.html">llfio</a></li><li class="navelem"><a class="el" href="dir_ff8d8ad368a820031e12dd9b12d79036.html">v2.0</a></li><li class="navelem"><a class="el" href="utils_8hpp.html">utils.hpp</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.13 </li> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li> </ul> </div> </body> |