ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-20 19:15:54 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
rippled/Vacuum_8cpp_source.html
bthomee 33451fdc96 deploy: 1d42c4f6de
2025-11-04 00:36:48 -08:00

161 lines
18 KiB
HTML
Raw Permalink Blame History

<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: Vacuum.cpp Source File</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="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>
<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 id="projectrow">
<td id="projectalign">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_a62226f9e3a6c7c5a3be455e2f87ae01.html">xrpld</a></li><li class="navelem"><a class="el" href="dir_c69db3203fa08a9ff994909ba6ee9783.html">app</a></li><li class="navelem"><a class="el" href="dir_9ce43f199f7837b2bc54444bf73b9bab.html">rdb</a></li><li class="navelem"><a class="el" href="dir_2e610841efb4e959cb432e522736434e.html">detail</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">Vacuum.cpp</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#include &lt;xrpld/app/rdb/Vacuum.h&gt;</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span> </div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#include &lt;boost/format.hpp&gt;</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span> </div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="keywordtype">bool</span></div>
<div class="foldopen" id="foldopen00008" data-start="{" data-end="}">
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"><a class="line" href="namespaceripple.html#adafdba9ca91c254868194ee5cd1f00af"> 8</a></span><a class="code hl_function" href="namespaceripple.html#adafdba9ca91c254868194ee5cd1f00af">doVacuumDB</a>(<a class="code hl_struct" href="structripple_1_1DatabaseCon_1_1Setup.html">DatabaseCon::Setup</a> <span class="keyword">const</span>&amp; setup, <a class="code hl_class" href="classbeast_1_1Journal.html">beast::Journal</a> j)</div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span>{</div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> boost::filesystem::path dbPath = setup.<a class="code hl_variable" href="structripple_1_1DatabaseCon_1_1Setup.html#a0af8b51b7fba3f82bc144cad8d83cb64">dataDir</a> / <a class="code hl_variable" href="namespaceripple.html#aaeddb4a3396c616a7ef7350e4cc327f0">TxDBName</a>;</div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> uintmax_t <span class="keyword">const</span> dbSize = file_size(dbPath);</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> XRPL_ASSERT(</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> dbSize != <span class="keyword">static_cast&lt;</span>uintmax_t<span class="keyword">&gt;</span>(-1),</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> <span class="stringliteral">&quot;ripple:doVacuumDB : file_size succeeded&quot;</span>);</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> <span class="keywordflow">if</span> (<span class="keyword">auto</span> <a class="code hl_enumvalue" href="namespaceripple.html#aaf9d6587e02c610e84a029ad5b5e17b4ae4894ca167b08880bfc35862f18575eb">available</a> = space(dbPath.parent_path()).available;</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> <a class="code hl_enumvalue" href="namespaceripple.html#aaf9d6587e02c610e84a029ad5b5e17b4ae4894ca167b08880bfc35862f18575eb">available</a> &lt; dbSize)</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> {</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/io/cerr.html">std::cerr</a> &lt;&lt; <span class="stringliteral">&quot;The database filesystem must have at least as &quot;</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> <span class="stringliteral">&quot;much free space as the size of &quot;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> &lt;&lt; dbPath.string() &lt;&lt; <span class="stringliteral">&quot;, which is &quot;</span> &lt;&lt; dbSize</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> &lt;&lt; <span class="stringliteral">&quot; bytes. Only &quot;</span> &lt;&lt; <a class="code hl_enumvalue" href="namespaceripple.html#aaf9d6587e02c610e84a029ad5b5e17b4ae4894ca167b08880bfc35862f18575eb">available</a> &lt;&lt; <span class="stringliteral">&quot; bytes are available.\n&quot;</span>;</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> }</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">auto</span> txnDB = <a class="code hl_variableRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::make_unique&lt;DatabaseCon&gt;</a>(</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> setup, <a class="code hl_variable" href="namespaceripple.html#aaeddb4a3396c616a7ef7350e4cc327f0">TxDBName</a>, setup.<a class="code hl_variable" href="structripple_1_1DatabaseCon_1_1Setup.html#ab858fce2645032c5958e3a46a4de4380">txPragma</a>, <a class="code hl_variable" href="namespaceripple.html#a02dace5f2b8af172e9d2d4ee7ea04c55">TxDBInit</a>, j);</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">auto</span>&amp; session = txnDB-&gt;getSession();</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> pageSize;</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <span class="comment">// Only the most trivial databases will fit in memory on typical</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="comment">// (recommended) hardware. Force temp files to be written to disk</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="comment">// regardless of the config settings.</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> session &lt;&lt; boost::format(<a class="code hl_variable" href="namespaceripple.html#a75396e0d47cf97ef093f6e94f0230780">CommonDBPragmaTemp</a>) % <span class="stringliteral">&quot;file&quot;</span>;</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> session &lt;&lt; <span class="stringliteral">&quot;PRAGMA page_size;&quot;</span>, soci::into(pageSize);</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/io/cout.html">std::cout</a> &lt;&lt; <span class="stringliteral">&quot;VACUUM beginning. page_size: &quot;</span> &lt;&lt; pageSize &lt;&lt; <a class="code hl_functionRef" href="http://en.cppreference.com/w/cpp/io/manip/endl.html">std::endl</a>;</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> session &lt;&lt; <span class="stringliteral">&quot;VACUUM;&quot;</span>;</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> XRPL_ASSERT(</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> setup.<a class="code hl_variable" href="structripple_1_1DatabaseCon_1_1Setup.html#a22f499c35a33d930c0f8459fe61dd9a0">globalPragma</a>, <span class="stringliteral">&quot;ripple:doVacuumDB : non-null global pragma&quot;</span>);</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <span class="keywordflow">for</span> (<span class="keyword">auto</span> <span class="keyword">const</span>&amp; p : *setup.<a class="code hl_variable" href="structripple_1_1DatabaseCon_1_1Setup.html#a22f499c35a33d930c0f8459fe61dd9a0">globalPragma</a>)</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> session &lt;&lt; p;</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> session &lt;&lt; <span class="stringliteral">&quot;PRAGMA page_size;&quot;</span>, soci::into(pageSize);</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/io/cout.html">std::cout</a> &lt;&lt; <span class="stringliteral">&quot;VACUUM finished. page_size: &quot;</span> &lt;&lt; pageSize &lt;&lt; <a class="code hl_functionRef" href="http://en.cppreference.com/w/cpp/io/manip/endl.html">std::endl</a>;</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span>}</div>
</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span>} <span class="comment">// namespace ripple</span></div>
<div class="ttc" id="acerr_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/io/cerr.html">std::cerr</a></div></div>
<div class="ttc" id="aclassbeast_1_1Journal_html"><div class="ttname"><a href="classbeast_1_1Journal.html">beast::Journal</a></div><div class="ttdoc">A generic endpoint for log messages.</div><div class="ttdef"><b>Definition</b> <a href="Journal_8h_source.html#l00040">Journal.h:41</a></div></div>
<div class="ttc" id="acout_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/io/cout.html">std::cout</a></div></div>
<div class="ttc" id="aendl_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/io/manip/endl.html">std::endl</a></div><div class="ttdeci">T endl(T... args)</div></div>
<div class="ttc" id="ainteger_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a></div></div>
<div class="ttc" id="ais_same_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/is_same.html">std::is_same_v</a></div><div class="ttdeci">T is_same_v</div></div>
<div class="ttc" id="anamespaceripple_html"><div class="ttname"><a href="namespaceripple.html">ripple</a></div><div class="ttdoc">Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.</div><div class="ttdef"><b>Definition</b> <a href="algorithm_8h_source.html#l00006">algorithm.h:6</a></div></div>
<div class="ttc" id="anamespaceripple_html_a02dace5f2b8af172e9d2d4ee7ea04c55"><div class="ttname"><a href="namespaceripple.html#a02dace5f2b8af172e9d2d4ee7ea04c55">ripple::TxDBInit</a></div><div class="ttdeci">constexpr std::array&lt; char const *, 8 &gt; TxDBInit</div><div class="ttdef"><b>Definition</b> <a href="DBInit_8h_source.html#l00053">DBInit.h:53</a></div></div>
<div class="ttc" id="anamespaceripple_html_a75396e0d47cf97ef093f6e94f0230780"><div class="ttname"><a href="namespaceripple.html#a75396e0d47cf97ef093f6e94f0230780">ripple::CommonDBPragmaTemp</a></div><div class="ttdeci">constexpr char const * CommonDBPragmaTemp</div><div class="ttdef"><b>Definition</b> <a href="DBInit_8h_source.html#l00015">DBInit.h:15</a></div></div>
<div class="ttc" id="anamespaceripple_html_aaeddb4a3396c616a7ef7350e4cc327f0"><div class="ttname"><a href="namespaceripple.html#aaeddb4a3396c616a7ef7350e4cc327f0">ripple::TxDBName</a></div><div class="ttdeci">constexpr auto TxDBName</div><div class="ttdef"><b>Definition</b> <a href="DBInit_8h_source.html#l00051">DBInit.h:51</a></div></div>
<div class="ttc" id="anamespaceripple_html_aaf9d6587e02c610e84a029ad5b5e17b4ae4894ca167b08880bfc35862f18575eb"><div class="ttname"><a href="namespaceripple.html#aaf9d6587e02c610e84a029ad5b5e17b4ae4894ca167b08880bfc35862f18575eb">ripple::PublisherStatus::available</a></div><div class="ttdeci">@ available</div></div>
<div class="ttc" id="anamespaceripple_html_adafdba9ca91c254868194ee5cd1f00af"><div class="ttname"><a href="namespaceripple.html#adafdba9ca91c254868194ee5cd1f00af">ripple::doVacuumDB</a></div><div class="ttdeci">bool doVacuumDB(DatabaseCon::Setup const &amp;setup, beast::Journal j)</div><div class="ttdoc">doVacuumDB Creates, initialises, and performs cleanup on a database.</div><div class="ttdef"><b>Definition</b> <a href="Vacuum_8cpp_source.html#l00008">Vacuum.cpp:8</a></div></div>
<div class="ttc" id="astructripple_1_1DatabaseCon_1_1Setup_html"><div class="ttname"><a href="structripple_1_1DatabaseCon_1_1Setup.html">ripple::DatabaseCon::Setup</a></div><div class="ttdef"><b>Definition</b> <a href="DatabaseCon_8h_source.html#l00069">DatabaseCon.h:70</a></div></div>
<div class="ttc" id="astructripple_1_1DatabaseCon_1_1Setup_html_a0af8b51b7fba3f82bc144cad8d83cb64"><div class="ttname"><a href="structripple_1_1DatabaseCon_1_1Setup.html#a0af8b51b7fba3f82bc144cad8d83cb64">ripple::DatabaseCon::Setup::dataDir</a></div><div class="ttdeci">boost::filesystem::path dataDir</div><div class="ttdef"><b>Definition</b> <a href="DatabaseCon_8h_source.html#l00075">DatabaseCon.h:75</a></div></div>
<div class="ttc" id="astructripple_1_1DatabaseCon_1_1Setup_html_a22f499c35a33d930c0f8459fe61dd9a0"><div class="ttname"><a href="structripple_1_1DatabaseCon_1_1Setup.html#a22f499c35a33d930c0f8459fe61dd9a0">ripple::DatabaseCon::Setup::globalPragma</a></div><div class="ttdeci">static std::unique_ptr&lt; std::vector&lt; std::string &gt; const &gt; globalPragma</div><div class="ttdef"><b>Definition</b> <a href="DatabaseCon_8h_source.html#l00091">DatabaseCon.h:91</a></div></div>
<div class="ttc" id="astructripple_1_1DatabaseCon_1_1Setup_html_ab858fce2645032c5958e3a46a4de4380"><div class="ttname"><a href="structripple_1_1DatabaseCon_1_1Setup.html#ab858fce2645032c5958e3a46a4de4380">ripple::DatabaseCon::Setup::txPragma</a></div><div class="ttdeci">std::array&lt; std::string, 4 &gt; txPragma</div><div class="ttdef"><b>Definition</b> <a href="DatabaseCon_8h_source.html#l00092">DatabaseCon.h:92</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink