mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-22 12:05:53 +00:00
162 lines
19 KiB
HTML
162 lines
19 KiB
HTML
<!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.17"/>
|
|
<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 style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">rippled
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- 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(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
<!-- 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">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_df9c78dcf3f59a33b12284f95992a64b.html">ripple</a></li><li class="navelem"><a class="el" href="dir_9f69212e4c6e2ca9ec5ab59cd7b6275c.html">app</a></li><li class="navelem"><a class="el" href="dir_6fe6f4dca26289abeb8b3619a8f9ad32.html">rdb</a></li><li class="navelem"><a class="el" href="dir_6621e5f569be728bc00b6f5c807cec29.html">impl</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 name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//------------------------------------------------------------------------------</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> This file is part of rippled: https://github.com/ripple/rippled</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> Copyright (c) 2021 Ripple Labs Inc.</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> Permission to use, copy, modify, and/or distribute this software for any</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> purpose with or without fee is hereby granted, provided that the above</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> copyright notice and this permission notice appear in all copies.</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">//==============================================================================</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include <ripple/app/rdb/Vacuum.h></span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <boost/format.hpp></span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">namespace </span><a class="code" href="namespaceripple.html">ripple</a> {</div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  </div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="keywordtype">bool</span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="namespaceripple.html#a66c57e7cfe01ff1ccccf7cad2db534db"> 26</a></span> <a class="code" href="namespaceripple.html#a66c57e7cfe01ff1ccccf7cad2db534db">doVacuumDB</a>(<a class="code" href="structripple_1_1DatabaseCon_1_1Setup.html">DatabaseCon::Setup</a> <span class="keyword">const</span>& setup)</div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> {</div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  boost::filesystem::path dbPath = setup.<a class="code" href="structripple_1_1DatabaseCon_1_1Setup.html#a0af8b51b7fba3f82bc144cad8d83cb64">dataDir</a> / <a class="code" href="namespaceripple.html#aaeddb4a3396c616a7ef7350e4cc327f0">TxDBName</a>;</div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  </div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  uintmax_t <span class="keyword">const</span> dbSize = file_size(dbPath);</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  assert(dbSize != <span class="keyword">static_cast<</span>uintmax_t<span class="keyword">></span>(-1));</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keywordflow">if</span> (<span class="keyword">auto</span> <a class="code" href="namespaceripple.html#aaf9d6587e02c610e84a029ad5b5e17b4ae4894ca167b08880bfc35862f18575eb">available</a> = space(dbPath.parent_path()).available;</div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <a class="code" href="namespaceripple.html#aaf9d6587e02c610e84a029ad5b5e17b4ae4894ca167b08880bfc35862f18575eb">available</a> < dbSize)</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  {</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/io/cerr.html">std::cerr</a> << <span class="stringliteral">"The database filesystem must have at least as "</span></div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="stringliteral">"much free space as the size of "</span></div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  << dbPath.string() << <span class="stringliteral">", which is "</span> << dbSize</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  << <span class="stringliteral">" bytes. Only "</span> << <a class="code" href="namespaceripple.html#aaf9d6587e02c610e84a029ad5b5e17b4ae4894ca167b08880bfc35862f18575eb">available</a> << <span class="stringliteral">" bytes are available.\n"</span>;</div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  }</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  </div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keyword">auto</span> txnDB =</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  std::make_unique<DatabaseCon>(setup, <a class="code" href="namespaceripple.html#aaeddb4a3396c616a7ef7350e4cc327f0">TxDBName</a>, <a class="code" href="namespaceripple.html#a10025b86c17707aa738c67c31a3aa540">TxDBPragma</a>, <a class="code" href="namespaceripple.html#a02dace5f2b8af172e9d2d4ee7ea04c55">TxDBInit</a>);</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">auto</span>& session = txnDB->getSession();</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> pageSize;</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  </div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="comment">// Only the most trivial databases will fit in memory on typical</span></div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="comment">// (recommended) hardware. Force temp files to be written to disk</span></div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="comment">// regardless of the config settings.</span></div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  session << boost::format(<a class="code" href="namespaceripple.html#a75396e0d47cf97ef093f6e94f0230780">CommonDBPragmaTemp</a>) % <span class="stringliteral">"file"</span>;</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  session << <span class="stringliteral">"PRAGMA page_size;"</span>, soci::into(pageSize);</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  </div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/io/cout.html">std::cout</a> << <span class="stringliteral">"VACUUM beginning. page_size: "</span> << pageSize << <a class="codeRef" href="http://en.cppreference.com/w/cpp/io/manip/endl.html">std::endl</a>;</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  </div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  session << <span class="stringliteral">"VACUUM;"</span>;</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  assert(setup.<a class="code" href="structripple_1_1DatabaseCon_1_1Setup.html#a22f499c35a33d930c0f8459fe61dd9a0">globalPragma</a>);</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordflow">for</span> (<span class="keyword">auto</span> <span class="keyword">const</span>& p : *setup.<a class="code" href="structripple_1_1DatabaseCon_1_1Setup.html#a22f499c35a33d930c0f8459fe61dd9a0">globalPragma</a>)</div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  session << p;</div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  session << <span class="stringliteral">"PRAGMA page_size;"</span>, soci::into(pageSize);</div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  </div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/io/cout.html">std::cout</a> << <span class="stringliteral">"VACUUM finished. page_size: "</span> << pageSize << <a class="codeRef" href="http://en.cppreference.com/w/cpp/io/manip/endl.html">std::endl</a>;</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  </div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> }</div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  </div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> } <span class="comment">// namespace ripple</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<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< std::vector< std::string > const > globalPragma</div><div class="ttdef"><b>Definition:</b> <a href="DatabaseCon_8h_source.html#l00104">DatabaseCon.h:104</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_html_a10025b86c17707aa738c67c31a3aa540"><div class="ttname"><a href="namespaceripple.html#a10025b86c17707aa738c67c31a3aa540">ripple::TxDBPragma</a></div><div class="ttdeci">constexpr std::array< char const *, 4 > TxDBPragma</div><div class="ttdef"><b>Definition:</b> <a href="DBInit_8h_source.html#l00078">DBInit.h:78</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#l00084">DatabaseCon.h:84</a></div></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="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#l00091">DatabaseCon.h:91</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="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#l00073">DBInit.h:73</a></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="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#l00034">DBInit.h:34</a></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="RCLCensorshipDetector_8h_source.html#l00029">RCLCensorshipDetector.h:29</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="anamespaceripple_html_a66c57e7cfe01ff1ccccf7cad2db534db"><div class="ttname"><a href="namespaceripple.html#a66c57e7cfe01ff1ccccf7cad2db534db">ripple::doVacuumDB</a></div><div class="ttdeci">bool doVacuumDB(DatabaseCon::Setup const &setup)</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#l00026">Vacuum.cpp:26</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< char const *, 8 > TxDBInit</div><div class="ttdef"><b>Definition:</b> <a href="DBInit_8h_source.html#l00094">DBInit.h:94</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>
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|