| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/root/.cargo/git/checkouts/tantivy-65d0bbbddbbd5d02/433372d/src/directory/managed_directory.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>managed_directory.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../../normalize.css"><link rel="stylesheet" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../../ayu.css" disabled><link rel="stylesheet" href="../../../dark.css" disabled><link rel="stylesheet" href="../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../storage.js"></script><script defer src="../../../source-script.js"></script><script defer src="../../../source-files.js"></script><script defer src="../../../main.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../../tantivy/index.html"><div class="logo-container"> |
| <img src="http://fulmicoton.com/tantivy-logo/tantivy-logo.png" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../tantivy/index.html"> |
| <img src="http://fulmicoton.com/tantivy-logo/tantivy-logo.png" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> |
| <span id="2">2</span> |
| <span id="3">3</span> |
| <span id="4">4</span> |
| <span id="5">5</span> |
| <span id="6">6</span> |
| <span id="7">7</span> |
| <span id="8">8</span> |
| <span id="9">9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <span id="35">35</span> |
| <span id="36">36</span> |
| <span id="37">37</span> |
| <span id="38">38</span> |
| <span id="39">39</span> |
| <span id="40">40</span> |
| <span id="41">41</span> |
| <span id="42">42</span> |
| <span id="43">43</span> |
| <span id="44">44</span> |
| <span id="45">45</span> |
| <span id="46">46</span> |
| <span id="47">47</span> |
| <span id="48">48</span> |
| <span id="49">49</span> |
| <span id="50">50</span> |
| <span id="51">51</span> |
| <span id="52">52</span> |
| <span id="53">53</span> |
| <span id="54">54</span> |
| <span id="55">55</span> |
| <span id="56">56</span> |
| <span id="57">57</span> |
| <span id="58">58</span> |
| <span id="59">59</span> |
| <span id="60">60</span> |
| <span id="61">61</span> |
| <span id="62">62</span> |
| <span id="63">63</span> |
| <span id="64">64</span> |
| <span id="65">65</span> |
| <span id="66">66</span> |
| <span id="67">67</span> |
| <span id="68">68</span> |
| <span id="69">69</span> |
| <span id="70">70</span> |
| <span id="71">71</span> |
| <span id="72">72</span> |
| <span id="73">73</span> |
| <span id="74">74</span> |
| <span id="75">75</span> |
| <span id="76">76</span> |
| <span id="77">77</span> |
| <span id="78">78</span> |
| <span id="79">79</span> |
| <span id="80">80</span> |
| <span id="81">81</span> |
| <span id="82">82</span> |
| <span id="83">83</span> |
| <span id="84">84</span> |
| <span id="85">85</span> |
| <span id="86">86</span> |
| <span id="87">87</span> |
| <span id="88">88</span> |
| <span id="89">89</span> |
| <span id="90">90</span> |
| <span id="91">91</span> |
| <span id="92">92</span> |
| <span id="93">93</span> |
| <span id="94">94</span> |
| <span id="95">95</span> |
| <span id="96">96</span> |
| <span id="97">97</span> |
| <span id="98">98</span> |
| <span id="99">99</span> |
| <span id="100">100</span> |
| <span id="101">101</span> |
| <span id="102">102</span> |
| <span id="103">103</span> |
| <span id="104">104</span> |
| <span id="105">105</span> |
| <span id="106">106</span> |
| <span id="107">107</span> |
| <span id="108">108</span> |
| <span id="109">109</span> |
| <span id="110">110</span> |
| <span id="111">111</span> |
| <span id="112">112</span> |
| <span id="113">113</span> |
| <span id="114">114</span> |
| <span id="115">115</span> |
| <span id="116">116</span> |
| <span id="117">117</span> |
| <span id="118">118</span> |
| <span id="119">119</span> |
| <span id="120">120</span> |
| <span id="121">121</span> |
| <span id="122">122</span> |
| <span id="123">123</span> |
| <span id="124">124</span> |
| <span id="125">125</span> |
| <span id="126">126</span> |
| <span id="127">127</span> |
| <span id="128">128</span> |
| <span id="129">129</span> |
| <span id="130">130</span> |
| <span id="131">131</span> |
| <span id="132">132</span> |
| <span id="133">133</span> |
| <span id="134">134</span> |
| <span id="135">135</span> |
| <span id="136">136</span> |
| <span id="137">137</span> |
| <span id="138">138</span> |
| <span id="139">139</span> |
| <span id="140">140</span> |
| <span id="141">141</span> |
| <span id="142">142</span> |
| <span id="143">143</span> |
| <span id="144">144</span> |
| <span id="145">145</span> |
| <span id="146">146</span> |
| <span id="147">147</span> |
| <span id="148">148</span> |
| <span id="149">149</span> |
| <span id="150">150</span> |
| <span id="151">151</span> |
| <span id="152">152</span> |
| <span id="153">153</span> |
| <span id="154">154</span> |
| <span id="155">155</span> |
| <span id="156">156</span> |
| <span id="157">157</span> |
| <span id="158">158</span> |
| <span id="159">159</span> |
| <span id="160">160</span> |
| <span id="161">161</span> |
| <span id="162">162</span> |
| <span id="163">163</span> |
| <span id="164">164</span> |
| <span id="165">165</span> |
| <span id="166">166</span> |
| <span id="167">167</span> |
| <span id="168">168</span> |
| <span id="169">169</span> |
| <span id="170">170</span> |
| <span id="171">171</span> |
| <span id="172">172</span> |
| <span id="173">173</span> |
| <span id="174">174</span> |
| <span id="175">175</span> |
| <span id="176">176</span> |
| <span id="177">177</span> |
| <span id="178">178</span> |
| <span id="179">179</span> |
| <span id="180">180</span> |
| <span id="181">181</span> |
| <span id="182">182</span> |
| <span id="183">183</span> |
| <span id="184">184</span> |
| <span id="185">185</span> |
| <span id="186">186</span> |
| <span id="187">187</span> |
| <span id="188">188</span> |
| <span id="189">189</span> |
| <span id="190">190</span> |
| <span id="191">191</span> |
| <span id="192">192</span> |
| <span id="193">193</span> |
| <span id="194">194</span> |
| <span id="195">195</span> |
| <span id="196">196</span> |
| <span id="197">197</span> |
| <span id="198">198</span> |
| <span id="199">199</span> |
| <span id="200">200</span> |
| <span id="201">201</span> |
| <span id="202">202</span> |
| <span id="203">203</span> |
| <span id="204">204</span> |
| <span id="205">205</span> |
| <span id="206">206</span> |
| <span id="207">207</span> |
| <span id="208">208</span> |
| <span id="209">209</span> |
| <span id="210">210</span> |
| <span id="211">211</span> |
| <span id="212">212</span> |
| <span id="213">213</span> |
| <span id="214">214</span> |
| <span id="215">215</span> |
| <span id="216">216</span> |
| <span id="217">217</span> |
| <span id="218">218</span> |
| <span id="219">219</span> |
| <span id="220">220</span> |
| <span id="221">221</span> |
| <span id="222">222</span> |
| <span id="223">223</span> |
| <span id="224">224</span> |
| <span id="225">225</span> |
| <span id="226">226</span> |
| <span id="227">227</span> |
| <span id="228">228</span> |
| <span id="229">229</span> |
| <span id="230">230</span> |
| <span id="231">231</span> |
| <span id="232">232</span> |
| <span id="233">233</span> |
| <span id="234">234</span> |
| <span id="235">235</span> |
| <span id="236">236</span> |
| <span id="237">237</span> |
| <span id="238">238</span> |
| <span id="239">239</span> |
| <span id="240">240</span> |
| <span id="241">241</span> |
| <span id="242">242</span> |
| <span id="243">243</span> |
| <span id="244">244</span> |
| <span id="245">245</span> |
| <span id="246">246</span> |
| <span id="247">247</span> |
| <span id="248">248</span> |
| <span id="249">249</span> |
| <span id="250">250</span> |
| <span id="251">251</span> |
| <span id="252">252</span> |
| <span id="253">253</span> |
| <span id="254">254</span> |
| <span id="255">255</span> |
| <span id="256">256</span> |
| <span id="257">257</span> |
| <span id="258">258</span> |
| <span id="259">259</span> |
| <span id="260">260</span> |
| <span id="261">261</span> |
| <span id="262">262</span> |
| <span id="263">263</span> |
| <span id="264">264</span> |
| <span id="265">265</span> |
| <span id="266">266</span> |
| <span id="267">267</span> |
| <span id="268">268</span> |
| <span id="269">269</span> |
| <span id="270">270</span> |
| <span id="271">271</span> |
| <span id="272">272</span> |
| <span id="273">273</span> |
| <span id="274">274</span> |
| <span id="275">275</span> |
| <span id="276">276</span> |
| <span id="277">277</span> |
| <span id="278">278</span> |
| <span id="279">279</span> |
| <span id="280">280</span> |
| <span id="281">281</span> |
| <span id="282">282</span> |
| <span id="283">283</span> |
| <span id="284">284</span> |
| <span id="285">285</span> |
| <span id="286">286</span> |
| <span id="287">287</span> |
| <span id="288">288</span> |
| <span id="289">289</span> |
| <span id="290">290</span> |
| <span id="291">291</span> |
| <span id="292">292</span> |
| <span id="293">293</span> |
| <span id="294">294</span> |
| <span id="295">295</span> |
| <span id="296">296</span> |
| <span id="297">297</span> |
| <span id="298">298</span> |
| <span id="299">299</span> |
| <span id="300">300</span> |
| <span id="301">301</span> |
| <span id="302">302</span> |
| <span id="303">303</span> |
| <span id="304">304</span> |
| <span id="305">305</span> |
| <span id="306">306</span> |
| <span id="307">307</span> |
| <span id="308">308</span> |
| <span id="309">309</span> |
| <span id="310">310</span> |
| <span id="311">311</span> |
| <span id="312">312</span> |
| <span id="313">313</span> |
| <span id="314">314</span> |
| <span id="315">315</span> |
| <span id="316">316</span> |
| <span id="317">317</span> |
| <span id="318">318</span> |
| <span id="319">319</span> |
| <span id="320">320</span> |
| <span id="321">321</span> |
| <span id="322">322</span> |
| <span id="323">323</span> |
| <span id="324">324</span> |
| <span id="325">325</span> |
| <span id="326">326</span> |
| <span id="327">327</span> |
| <span id="328">328</span> |
| <span id="329">329</span> |
| <span id="330">330</span> |
| <span id="331">331</span> |
| <span id="332">332</span> |
| <span id="333">333</span> |
| <span id="334">334</span> |
| <span id="335">335</span> |
| <span id="336">336</span> |
| <span id="337">337</span> |
| <span id="338">338</span> |
| <span id="339">339</span> |
| <span id="340">340</span> |
| <span id="341">341</span> |
| <span id="342">342</span> |
| <span id="343">343</span> |
| <span id="344">344</span> |
| <span id="345">345</span> |
| <span id="346">346</span> |
| <span id="347">347</span> |
| <span id="348">348</span> |
| <span id="349">349</span> |
| <span id="350">350</span> |
| <span id="351">351</span> |
| <span id="352">352</span> |
| <span id="353">353</span> |
| <span id="354">354</span> |
| <span id="355">355</span> |
| <span id="356">356</span> |
| <span id="357">357</span> |
| <span id="358">358</span> |
| <span id="359">359</span> |
| <span id="360">360</span> |
| <span id="361">361</span> |
| <span id="362">362</span> |
| <span id="363">363</span> |
| <span id="364">364</span> |
| <span id="365">365</span> |
| <span id="366">366</span> |
| <span id="367">367</span> |
| <span id="368">368</span> |
| <span id="369">369</span> |
| <span id="370">370</span> |
| <span id="371">371</span> |
| <span id="372">372</span> |
| <span id="373">373</span> |
| <span id="374">374</span> |
| <span id="375">375</span> |
| <span id="376">376</span> |
| <span id="377">377</span> |
| <span id="378">378</span> |
| <span id="379">379</span> |
| <span id="380">380</span> |
| <span id="381">381</span> |
| <span id="382">382</span> |
| <span id="383">383</span> |
| <span id="384">384</span> |
| <span id="385">385</span> |
| <span id="386">386</span> |
| <span id="387">387</span> |
| <span id="388">388</span> |
| <span id="389">389</span> |
| <span id="390">390</span> |
| <span id="391">391</span> |
| <span id="392">392</span> |
| <span id="393">393</span> |
| <span id="394">394</span> |
| <span id="395">395</span> |
| <span id="396">396</span> |
| <span id="397">397</span> |
| <span id="398">398</span> |
| <span id="399">399</span> |
| <span id="400">400</span> |
| <span id="401">401</span> |
| <span id="402">402</span> |
| <span id="403">403</span> |
| <span id="404">404</span> |
| <span id="405">405</span> |
| <span id="406">406</span> |
| <span id="407">407</span> |
| <span id="408">408</span> |
| <span id="409">409</span> |
| <span id="410">410</span> |
| <span id="411">411</span> |
| <span id="412">412</span> |
| <span id="413">413</span> |
| </pre><pre class="rust"><code><span class="kw">use </span>std::collections::HashSet; |
| <span class="kw">use </span>std::io::Write; |
| <span class="kw">use </span>std::path::{Path, PathBuf}; |
| <span class="kw">use </span>std::sync::{Arc, RwLock, RwLockWriteGuard}; |
| <span class="kw">use </span>std::{io, result}; |
| |
| <span class="kw">use </span>crc32fast::Hasher; |
| |
| <span class="kw">use </span><span class="kw">crate</span>::core::MANAGED_FILEPATH; |
| <span class="kw">use </span><span class="kw">crate</span>::directory::error::{DeleteError, LockError, OpenReadError, OpenWriteError}; |
| <span class="kw">use </span><span class="kw">crate</span>::directory::footer::{Footer, FooterProxy}; |
| <span class="kw">use </span><span class="kw">crate</span>::directory::{ |
| DirectoryLock, FileHandle, FileSlice, GarbageCollectionResult, Lock, WatchCallback, |
| WatchHandle, WritePtr, META_LOCK, |
| }; |
| <span class="kw">use </span><span class="kw">crate</span>::error::DataCorruption; |
| <span class="kw">use </span><span class="kw">crate</span>::Directory; |
| |
| <span class="doccomment">/// Returns true if the file is "managed". |
| /// Non-managed file are not subject to garbage collection. |
| /// |
| /// Filenames that starts by a "." -typically locks- |
| /// are not managed. |
| </span><span class="kw">fn </span>is_managed(path: <span class="kw-2">&</span>Path) -> bool { |
| path.to_str() |
| .map(|p_str| !p_str.starts_with(<span class="string">'.'</span>)) |
| .unwrap_or(<span class="bool-val">true</span>) |
| } |
| |
| <span class="doccomment">/// Wrapper of directories that keeps track of files created by Tantivy. |
| /// |
| /// A managed directory is just a wrapper of a directory |
| /// that keeps a (persisted) list of the files that |
| /// have been created (and not deleted) by tantivy so far. |
| /// |
| /// Thanks to this list, it implements a `garbage_collect` method |
| /// that removes the files that were created by tantivy and are not |
| /// useful anymore. |
| </span><span class="attribute">#[derive(Debug)] |
| </span><span class="kw">pub struct </span>ManagedDirectory { |
| directory: Box<<span class="kw">dyn </span>Directory>, |
| meta_informations: Arc<RwLock<MetaInformation>>, |
| } |
| |
| <span class="attribute">#[derive(Debug, Default)] |
| </span><span class="kw">struct </span>MetaInformation { |
| managed_paths: HashSet<PathBuf>, |
| } |
| |
| <span class="doccomment">/// Saves the file containing the list of existing files |
| /// that were created by tantivy. |
| </span><span class="kw">fn </span>save_managed_paths( |
| directory: <span class="kw-2">&</span><span class="kw">dyn </span>Directory, |
| wlock: <span class="kw-2">&</span>RwLockWriteGuard<<span class="lifetime">'_</span>, MetaInformation>, |
| ) -> io::Result<()> { |
| <span class="kw">let </span><span class="kw-2">mut </span>w = serde_json::to_vec(<span class="kw-2">&</span>wlock.managed_paths)<span class="question-mark">?</span>; |
| <span class="macro">writeln!</span>(<span class="kw-2">&mut </span>w)<span class="question-mark">?</span>; |
| directory.atomic_write(<span class="kw-2">&</span>MANAGED_FILEPATH, <span class="kw-2">&</span>w[..])<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(()) |
| } |
| |
| <span class="kw">impl </span>ManagedDirectory { |
| <span class="doccomment">/// Wraps a directory as managed directory. |
| </span><span class="kw">pub fn </span>wrap(directory: Box<<span class="kw">dyn </span>Directory>) -> <span class="kw">crate</span>::Result<ManagedDirectory> { |
| <span class="kw">match </span>directory.atomic_read(<span class="kw-2">&</span>MANAGED_FILEPATH) { |
| <span class="prelude-val">Ok</span>(data) => { |
| <span class="kw">let </span>managed_files_json = String::from_utf8_lossy(<span class="kw-2">&</span>data); |
| <span class="kw">let </span>managed_files: HashSet<PathBuf> = serde_json::from_str(<span class="kw-2">&</span>managed_files_json) |
| .map_err(|e| { |
| DataCorruption::new( |
| MANAGED_FILEPATH.to_path_buf(), |
| <span class="macro">format!</span>(<span class="string">"Managed file cannot be deserialized: {:?}. "</span>, e), |
| ) |
| })<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(ManagedDirectory { |
| directory, |
| meta_informations: Arc::new(RwLock::new(MetaInformation { |
| managed_paths: managed_files, |
| })), |
| }) |
| } |
| <span class="prelude-val">Err</span>(OpenReadError::FileDoesNotExist(<span class="kw">_</span>)) => <span class="prelude-val">Ok</span>(ManagedDirectory { |
| directory, |
| meta_informations: Arc::default(), |
| }), |
| io_err @ <span class="prelude-val">Err</span>(OpenReadError::IoError { .. }) => <span class="prelude-val">Err</span>(io_err.err().unwrap().into()), |
| <span class="prelude-val">Err</span>(OpenReadError::IncompatibleIndex(incompatibility)) => { |
| <span class="comment">// For the moment, this should never happen `meta.json` |
| // do not have any footer and cannot detect incompatibility. |
| </span><span class="prelude-val">Err</span>(<span class="kw">crate</span>::TantivyError::IncompatibleIndex(incompatibility)) |
| } |
| } |
| } |
| |
| <span class="doccomment">/// Garbage collect unused files. |
| /// |
| /// Removes the files that were created by `tantivy` and are not |
| /// used by any segment anymore. |
| /// |
| /// * `living_files` - List of files that are still used by the index. |
| /// |
| /// The use a callback ensures that the list of living_files is computed |
| /// while we hold the lock on meta. |
| /// |
| /// This method does not panick nor returns errors. |
| /// If a file cannot be deleted (for permission reasons for instance) |
| /// an error is simply logged, and the file remains in the list of managed |
| /// files. |
| </span><span class="kw">pub fn </span>garbage_collect<L: FnOnce() -> HashSet<PathBuf>>( |
| <span class="kw-2">&mut </span><span class="self">self</span>, |
| get_living_files: L, |
| ) -> <span class="kw">crate</span>::Result<GarbageCollectionResult> { |
| <span class="macro">info!</span>(<span class="string">"Garbage collect"</span>); |
| <span class="kw">let </span><span class="kw-2">mut </span>files_to_delete = <span class="macro">vec!</span>[]; |
| |
| <span class="comment">// It is crucial to get the living files after acquiring the |
| // read lock of meta information. That way, we |
| // avoid the following scenario. |
| // |
| // 1) we get the list of living files. |
| // 2) someone creates a new file. |
| // 3) we start garbage collection and remove this file |
| // even though it is a living file. |
| // |
| // releasing the lock as .delete() will use it too. |
| </span>{ |
| <span class="kw">let </span>meta_informations_rlock = <span class="self">self |
| </span>.meta_informations |
| .read() |
| .expect(<span class="string">"Managed directory rlock poisoned in garbage collect."</span>); |
| |
| <span class="comment">// The point of this second "file" lock is to enforce the following scenario |
| // 1) process B tries to load a new set of searcher. |
| // The list of segments is loaded |
| // 2) writer change meta.json (for instance after a merge or a commit) |
| // 3) gc kicks in. |
| // 4) gc removes a file that was useful for process B, before process B opened it. |
| </span><span class="kw">match </span><span class="self">self</span>.acquire_lock(<span class="kw-2">&</span>META_LOCK) { |
| <span class="prelude-val">Ok</span>(_meta_lock) => { |
| <span class="kw">let </span>living_files = get_living_files(); |
| <span class="kw">for </span>managed_path <span class="kw">in </span><span class="kw-2">&</span>meta_informations_rlock.managed_paths { |
| <span class="kw">if </span>!living_files.contains(managed_path) { |
| files_to_delete.push(managed_path.clone()); |
| } |
| } |
| } |
| <span class="prelude-val">Err</span>(err) => { |
| <span class="macro">error!</span>(<span class="string">"Failed to acquire lock for GC"</span>); |
| <span class="kw">return </span><span class="prelude-val">Err</span>(<span class="kw">crate</span>::TantivyError::from(err)); |
| } |
| } |
| } |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>failed_to_delete_files = <span class="macro">vec!</span>[]; |
| <span class="kw">let </span><span class="kw-2">mut </span>deleted_files = <span class="macro">vec!</span>[]; |
| |
| <span class="kw">for </span>file_to_delete <span class="kw">in </span>files_to_delete { |
| <span class="kw">match </span><span class="self">self</span>.delete(<span class="kw-2">&</span>file_to_delete) { |
| <span class="prelude-val">Ok</span>(<span class="kw">_</span>) => { |
| <span class="macro">info!</span>(<span class="string">"Deleted {:?}"</span>, file_to_delete); |
| deleted_files.push(file_to_delete); |
| } |
| <span class="prelude-val">Err</span>(file_error) => { |
| <span class="kw">match </span>file_error { |
| DeleteError::FileDoesNotExist(<span class="kw">_</span>) => { |
| deleted_files.push(file_to_delete.clone()); |
| } |
| DeleteError::IoError { .. } => { |
| failed_to_delete_files.push(file_to_delete.clone()); |
| <span class="kw">if </span>!<span class="macro">cfg!</span>(target_os = <span class="string">"windows"</span>) { |
| <span class="comment">// On windows, delete is expected to fail if the file |
| // is mmapped. |
| </span><span class="macro">error!</span>(<span class="string">"Failed to delete {:?}"</span>, file_to_delete); |
| } |
| } |
| } |
| } |
| } |
| } |
| |
| <span class="kw">if </span>!deleted_files.is_empty() { |
| <span class="comment">// update the list of managed files by removing |
| // the file that were removed. |
| </span><span class="kw">let </span><span class="kw-2">mut </span>meta_informations_wlock = <span class="self">self |
| </span>.meta_informations |
| .write() |
| .expect(<span class="string">"Managed directory wlock poisoned (2)."</span>); |
| <span class="kw">let </span>managed_paths_write = <span class="kw-2">&mut </span>meta_informations_wlock.managed_paths; |
| <span class="kw">for </span>delete_file <span class="kw">in </span><span class="kw-2">&</span>deleted_files { |
| managed_paths_write.remove(delete_file); |
| } |
| <span class="self">self</span>.directory.sync_directory()<span class="question-mark">?</span>; |
| save_managed_paths(<span class="self">self</span>.directory.as_mut(), <span class="kw-2">&</span>meta_informations_wlock)<span class="question-mark">?</span>; |
| } |
| |
| <span class="prelude-val">Ok</span>(GarbageCollectionResult { |
| deleted_files, |
| failed_to_delete_files, |
| }) |
| } |
| |
| <span class="doccomment">/// Registers a file as managed |
| /// |
| /// This method must be called before the file is |
| /// actually created to ensure that a failure between |
| /// registering the filepath and creating the file |
| /// will not lead to garbage files that will |
| /// never get removed. |
| /// |
| /// File starting by "." are reserved to locks. |
| /// They are not managed and cannot be subjected |
| /// to garbage collection. |
| </span><span class="kw">fn </span>register_file_as_managed(<span class="kw-2">&</span><span class="self">self</span>, filepath: <span class="kw-2">&</span>Path) -> io::Result<()> { |
| <span class="comment">// Files starting by "." (e.g. lock files) are not managed. |
| </span><span class="kw">if </span>!is_managed(filepath) { |
| <span class="kw">return </span><span class="prelude-val">Ok</span>(()); |
| } |
| <span class="kw">let </span><span class="kw-2">mut </span>meta_wlock = <span class="self">self |
| </span>.meta_informations |
| .write() |
| .expect(<span class="string">"Managed file lock poisoned"</span>); |
| <span class="kw">let </span>has_changed = meta_wlock.managed_paths.insert(filepath.to_owned()); |
| <span class="kw">if </span>!has_changed { |
| <span class="kw">return </span><span class="prelude-val">Ok</span>(()); |
| } |
| save_managed_paths(<span class="self">self</span>.directory.as_ref(), <span class="kw-2">&</span>meta_wlock)<span class="question-mark">?</span>; |
| <span class="comment">// This is not the first file we add. |
| // Therefore, we are sure that `.managed.json` has been already |
| // properly created and we do not need to sync its parent directory. |
| // |
| // (It might seem like a nicer solution to create the managed_json on the |
| // creation of the ManagedDirectory instance but it would actually |
| // prevent the use of read-only directories..) |
| </span><span class="kw">let </span>managed_file_definitely_already_exists = meta_wlock.managed_paths.len() > <span class="number">1</span>; |
| <span class="kw">if </span>managed_file_definitely_already_exists { |
| <span class="kw">return </span><span class="prelude-val">Ok</span>(()); |
| } |
| <span class="self">self</span>.directory.sync_directory()<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(()) |
| } |
| |
| <span class="doccomment">/// Verify checksum of a managed file |
| </span><span class="kw">pub fn </span>validate_checksum(<span class="kw-2">&</span><span class="self">self</span>, path: <span class="kw-2">&</span>Path) -> result::Result<bool, OpenReadError> { |
| <span class="kw">let </span>reader = <span class="self">self</span>.directory.open_read(path)<span class="question-mark">?</span>; |
| <span class="kw">let </span>(footer, data) = Footer::extract_footer(reader) |
| .map_err(|io_error| OpenReadError::wrap_io_error(io_error, path.to_path_buf()))<span class="question-mark">?</span>; |
| <span class="kw">let </span>bytes = data |
| .read_bytes() |
| .map_err(|io_error| OpenReadError::IoError { |
| io_error: Arc::new(io_error), |
| filepath: path.to_path_buf(), |
| })<span class="question-mark">?</span>; |
| <span class="kw">let </span><span class="kw-2">mut </span>hasher = Hasher::new(); |
| hasher.update(bytes.as_slice()); |
| <span class="kw">let </span>crc = hasher.finalize(); |
| <span class="prelude-val">Ok</span>(footer.crc() == crc) |
| } |
| |
| <span class="doccomment">/// List all managed files |
| </span><span class="kw">pub fn </span>list_managed_files(<span class="kw-2">&</span><span class="self">self</span>) -> HashSet<PathBuf> { |
| <span class="kw">let </span>managed_paths = <span class="self">self |
| </span>.meta_informations |
| .read() |
| .expect(<span class="string">"Managed directory rlock poisoned in list damaged."</span>) |
| .managed_paths |
| .clone(); |
| managed_paths |
| } |
| } |
| |
| <span class="kw">impl </span>Directory <span class="kw">for </span>ManagedDirectory { |
| <span class="kw">fn </span>get_file_handle(<span class="kw-2">&</span><span class="self">self</span>, path: <span class="kw-2">&</span>Path) -> <span class="prelude-ty">Result</span><Arc<<span class="kw">dyn </span>FileHandle>, OpenReadError> { |
| <span class="kw">let </span>file_slice = <span class="self">self</span>.open_read(path)<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(Arc::new(file_slice)) |
| } |
| |
| <span class="kw">fn </span>open_read(<span class="kw-2">&</span><span class="self">self</span>, path: <span class="kw-2">&</span>Path) -> result::Result<FileSlice, OpenReadError> { |
| <span class="kw">let </span>file_slice = <span class="self">self</span>.directory.open_read(path)<span class="question-mark">?</span>; |
| <span class="kw">let </span>(footer, reader) = Footer::extract_footer(file_slice) |
| .map_err(|io_error| OpenReadError::wrap_io_error(io_error, path.to_path_buf()))<span class="question-mark">?</span>; |
| footer.is_compatible()<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(reader) |
| } |
| |
| <span class="kw">fn </span>open_write(<span class="kw-2">&</span><span class="self">self</span>, path: <span class="kw-2">&</span>Path) -> result::Result<WritePtr, OpenWriteError> { |
| <span class="self">self</span>.register_file_as_managed(path) |
| .map_err(|io_error| OpenWriteError::wrap_io_error(io_error, path.to_path_buf()))<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(io::BufWriter::new(Box::new(FooterProxy::new( |
| <span class="self">self</span>.directory |
| .open_write(path)<span class="question-mark">? |
| </span>.into_inner() |
| .map_err(|<span class="kw">_</span>| ()) |
| .expect(<span class="string">"buffer should be empty"</span>), |
| )))) |
| } |
| |
| <span class="kw">fn </span>atomic_write(<span class="kw-2">&</span><span class="self">self</span>, path: <span class="kw-2">&</span>Path, data: <span class="kw-2">&</span>[u8]) -> io::Result<()> { |
| <span class="self">self</span>.register_file_as_managed(path)<span class="question-mark">?</span>; |
| <span class="self">self</span>.directory.atomic_write(path, data) |
| } |
| |
| <span class="kw">fn </span>atomic_read(<span class="kw-2">&</span><span class="self">self</span>, path: <span class="kw-2">&</span>Path) -> result::Result<Vec<u8>, OpenReadError> { |
| <span class="self">self</span>.directory.atomic_read(path) |
| } |
| |
| <span class="kw">fn </span>delete(<span class="kw-2">&</span><span class="self">self</span>, path: <span class="kw-2">&</span>Path) -> result::Result<(), DeleteError> { |
| <span class="self">self</span>.directory.delete(path) |
| } |
| |
| <span class="kw">fn </span>exists(<span class="kw-2">&</span><span class="self">self</span>, path: <span class="kw-2">&</span>Path) -> <span class="prelude-ty">Result</span><bool, OpenReadError> { |
| <span class="self">self</span>.directory.exists(path) |
| } |
| |
| <span class="kw">fn </span>acquire_lock(<span class="kw-2">&</span><span class="self">self</span>, lock: <span class="kw-2">&</span>Lock) -> result::Result<DirectoryLock, LockError> { |
| <span class="self">self</span>.directory.acquire_lock(lock) |
| } |
| |
| <span class="kw">fn </span>watch(<span class="kw-2">&</span><span class="self">self</span>, watch_callback: WatchCallback) -> <span class="kw">crate</span>::Result<WatchHandle> { |
| <span class="self">self</span>.directory.watch(watch_callback) |
| } |
| |
| <span class="kw">fn </span>sync_directory(<span class="kw-2">&</span><span class="self">self</span>) -> io::Result<()> { |
| <span class="self">self</span>.directory.sync_directory()<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(()) |
| } |
| } |
| |
| <span class="kw">impl </span>Clone <span class="kw">for </span>ManagedDirectory { |
| <span class="kw">fn </span>clone(<span class="kw-2">&</span><span class="self">self</span>) -> ManagedDirectory { |
| ManagedDirectory { |
| directory: <span class="self">self</span>.directory.box_clone(), |
| meta_informations: Arc::clone(<span class="kw-2">&</span><span class="self">self</span>.meta_informations), |
| } |
| } |
| } |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"mmap"</span>)] |
| #[cfg(test)] |
| </span><span class="kw">mod </span>tests_mmap_specific { |
| |
| <span class="kw">use </span>std::collections::HashSet; |
| <span class="kw">use </span>std::io::Write; |
| <span class="kw">use </span>std::path::{Path, PathBuf}; |
| |
| <span class="kw">use </span>tempfile::TempDir; |
| |
| <span class="kw">use </span><span class="kw">crate</span>::directory::{Directory, ManagedDirectory, MmapDirectory, TerminatingWrite}; |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>test_managed_directory() { |
| <span class="kw">let </span>tempdir = TempDir::new().unwrap(); |
| <span class="kw">let </span>tempdir_path = PathBuf::from(tempdir.path()); |
| |
| <span class="kw">let </span>test_path1: <span class="kw-2">&</span><span class="lifetime">'static </span>Path = Path::new(<span class="string">"some_path_for_test"</span>); |
| <span class="kw">let </span>test_path2: <span class="kw-2">&</span><span class="lifetime">'static </span>Path = Path::new(<span class="string">"some_path_for_test_2"</span>); |
| { |
| <span class="kw">let </span>mmap_directory = MmapDirectory::open(<span class="kw-2">&</span>tempdir_path).unwrap(); |
| <span class="kw">let </span><span class="kw-2">mut </span>managed_directory = ManagedDirectory::wrap(Box::new(mmap_directory)).unwrap(); |
| <span class="kw">let </span>write_file = managed_directory.open_write(test_path1).unwrap(); |
| write_file.terminate().unwrap(); |
| managed_directory |
| .atomic_write(test_path2, <span class="kw-2">&</span>[<span class="number">0u8</span>, <span class="number">1u8</span>]) |
| .unwrap(); |
| <span class="macro">assert!</span>(managed_directory.exists(test_path1).unwrap()); |
| <span class="macro">assert!</span>(managed_directory.exists(test_path2).unwrap()); |
| <span class="kw">let </span>living_files: HashSet<PathBuf> = [test_path1.to_owned()].iter().cloned().collect(); |
| <span class="macro">assert!</span>(managed_directory.garbage_collect(|| living_files).is_ok()); |
| <span class="macro">assert!</span>(managed_directory.exists(test_path1).unwrap()); |
| <span class="macro">assert!</span>(!managed_directory.exists(test_path2).unwrap()); |
| } |
| { |
| <span class="kw">let </span>mmap_directory = MmapDirectory::open(<span class="kw-2">&</span>tempdir_path).unwrap(); |
| <span class="kw">let </span><span class="kw-2">mut </span>managed_directory = ManagedDirectory::wrap(Box::new(mmap_directory)).unwrap(); |
| <span class="macro">assert!</span>(managed_directory.exists(test_path1).unwrap()); |
| <span class="macro">assert!</span>(!managed_directory.exists(test_path2).unwrap()); |
| <span class="kw">let </span>living_files: HashSet<PathBuf> = HashSet::new(); |
| <span class="macro">assert!</span>(managed_directory.garbage_collect(|| living_files).is_ok()); |
| <span class="macro">assert!</span>(!managed_directory.exists(test_path1).unwrap()); |
| <span class="macro">assert!</span>(!managed_directory.exists(test_path2).unwrap()); |
| } |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>test_managed_directory_gc_while_mmapped() { |
| <span class="kw">let </span>test_path1: <span class="kw-2">&</span><span class="lifetime">'static </span>Path = Path::new(<span class="string">"some_path_for_test"</span>); |
| |
| <span class="kw">let </span>tempdir = TempDir::new().unwrap(); |
| <span class="kw">let </span>tempdir_path = PathBuf::from(tempdir.path()); |
| <span class="kw">let </span>living_files = HashSet::new(); |
| |
| <span class="kw">let </span>mmap_directory = MmapDirectory::open(<span class="kw-2">&</span>tempdir_path).unwrap(); |
| <span class="kw">let </span><span class="kw-2">mut </span>managed_directory = ManagedDirectory::wrap(Box::new(mmap_directory)).unwrap(); |
| <span class="kw">let </span><span class="kw-2">mut </span>write = managed_directory.open_write(test_path1).unwrap(); |
| write.write_all(<span class="kw-2">&</span>[<span class="number">0u8</span>, <span class="number">1u8</span>]).unwrap(); |
| write.terminate().unwrap(); |
| <span class="macro">assert!</span>(managed_directory.exists(test_path1).unwrap()); |
| |
| <span class="kw">let </span>_mmap_read = managed_directory.open_read(test_path1).unwrap(); |
| <span class="macro">assert!</span>(managed_directory |
| .garbage_collect(|| living_files.clone()) |
| .is_ok()); |
| <span class="kw">if </span><span class="macro">cfg!</span>(target_os = <span class="string">"windows"</span>) { |
| <span class="comment">// On Windows, gc should try and fail the file as it is mmapped. |
| </span><span class="macro">assert!</span>(managed_directory.exists(test_path1).unwrap()); |
| <span class="comment">// unmap should happen here. |
| </span>drop(_mmap_read); |
| <span class="comment">// The file should still be in the list of managed file and |
| // eventually be deleted once mmap is released. |
| </span><span class="macro">assert!</span>(managed_directory.garbage_collect(|| living_files).is_ok()); |
| } |
| <span class="macro">assert!</span>(!managed_directory.exists(test_path1).unwrap()); |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="tantivy" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
