| <!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/indexer/segment_manager.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>segment_manager.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> |
| </pre><pre class="rust"><code><span class="kw">use </span>std::collections::hash_set::HashSet; |
| <span class="kw">use </span>std::fmt::{<span class="self">self</span>, Debug, Formatter}; |
| <span class="kw">use </span>std::sync::{RwLock, RwLockReadGuard, RwLockWriteGuard}; |
| |
| <span class="kw">use </span><span class="kw">super</span>::segment_register::SegmentRegister; |
| <span class="kw">use </span><span class="kw">crate</span>::core::{SegmentId, SegmentMeta}; |
| <span class="kw">use </span><span class="kw">crate</span>::error::TantivyError; |
| <span class="kw">use </span><span class="kw">crate</span>::indexer::delete_queue::DeleteCursor; |
| <span class="kw">use </span><span class="kw">crate</span>::indexer::SegmentEntry; |
| |
| <span class="attribute">#[derive(Default)] |
| </span><span class="kw">struct </span>SegmentRegisters { |
| uncommitted: SegmentRegister, |
| committed: SegmentRegister, |
| } |
| |
| <span class="attribute">#[derive(PartialEq, Eq)] |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">enum </span>SegmentsStatus { |
| Committed, |
| Uncommitted, |
| } |
| |
| <span class="kw">impl </span>SegmentRegisters { |
| <span class="doccomment">/// Check if all the segments are committed or uncommitted. |
| /// |
| /// If some segment is missing or segments are in a different state (this should not happen |
| /// if tantivy is used correctly), returns `None`. |
| </span><span class="kw">fn </span>segments_status(<span class="kw-2">&</span><span class="self">self</span>, segment_ids: <span class="kw-2">&</span>[SegmentId]) -> <span class="prelude-ty">Option</span><SegmentsStatus> { |
| <span class="kw">if </span><span class="self">self</span>.uncommitted.contains_all(segment_ids) { |
| <span class="prelude-val">Some</span>(SegmentsStatus::Uncommitted) |
| } <span class="kw">else if </span><span class="self">self</span>.committed.contains_all(segment_ids) { |
| <span class="prelude-val">Some</span>(SegmentsStatus::Committed) |
| } <span class="kw">else </span>{ |
| <span class="macro">warn!</span>( |
| <span class="string">"segment_ids: {:?}, committed_ids: {:?}, uncommitted_ids {:?}"</span>, |
| segment_ids, |
| <span class="self">self</span>.committed.segment_ids(), |
| <span class="self">self</span>.uncommitted.segment_ids() |
| ); |
| <span class="prelude-val">None |
| </span>} |
| } |
| } |
| |
| <span class="doccomment">/// The segment manager stores the list of segments |
| /// as well as their state. |
| /// |
| /// It guarantees the atomicity of the |
| /// changes (merges especially) |
| </span><span class="attribute">#[derive(Default)] |
| </span><span class="kw">pub struct </span>SegmentManager { |
| registers: RwLock<SegmentRegisters>, |
| } |
| |
| <span class="kw">impl </span>Debug <span class="kw">for </span>SegmentManager { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>Formatter<<span class="lifetime">'_</span>>) -> fmt::Result { |
| <span class="kw">let </span>lock = <span class="self">self</span>.read(); |
| <span class="macro">write!</span>( |
| f, |
| <span class="string">"{{ uncommitted: {:?}, committed: {:?} }}"</span>, |
| lock.uncommitted, lock.committed |
| ) |
| } |
| } |
| |
| <span class="kw">impl </span>SegmentManager { |
| <span class="kw">pub fn </span>from_segments( |
| segment_metas: Vec<SegmentMeta>, |
| delete_cursor: <span class="kw-2">&</span>DeleteCursor, |
| ) -> SegmentManager { |
| SegmentManager { |
| registers: RwLock::new(SegmentRegisters { |
| uncommitted: SegmentRegister::default(), |
| committed: SegmentRegister::new(segment_metas, delete_cursor), |
| }), |
| } |
| } |
| |
| <span class="kw">pub fn </span>get_mergeable_segments( |
| <span class="kw-2">&</span><span class="self">self</span>, |
| in_merge_segment_ids: <span class="kw-2">&</span>HashSet<SegmentId>, |
| ) -> (Vec<SegmentMeta>, Vec<SegmentMeta>) { |
| <span class="kw">let </span>registers_lock = <span class="self">self</span>.read(); |
| ( |
| registers_lock |
| .committed |
| .get_mergeable_segments(in_merge_segment_ids), |
| registers_lock |
| .uncommitted |
| .get_mergeable_segments(in_merge_segment_ids), |
| ) |
| } |
| <span class="doccomment">/// Returns all of the segment entries (committed or uncommitted) |
| </span><span class="kw">pub fn </span>segment_entries(<span class="kw-2">&</span><span class="self">self</span>) -> Vec<SegmentEntry> { |
| <span class="kw">let </span>registers_lock = <span class="self">self</span>.read(); |
| <span class="kw">let </span><span class="kw-2">mut </span>segment_entries = registers_lock.uncommitted.segment_entries(); |
| segment_entries.extend(registers_lock.committed.segment_entries()); |
| segment_entries |
| } |
| |
| <span class="comment">// Lock poisoning should never happen : |
| // The lock is acquired and released within this class, |
| // and the operations cannot panic. |
| </span><span class="kw">fn </span>read(<span class="kw-2">&</span><span class="self">self</span>) -> RwLockReadGuard<<span class="lifetime">'_</span>, SegmentRegisters> { |
| <span class="self">self</span>.registers |
| .read() |
| .expect(<span class="string">"Failed to acquire read lock on SegmentManager."</span>) |
| } |
| |
| <span class="kw">fn </span>write(<span class="kw-2">&</span><span class="self">self</span>) -> RwLockWriteGuard<<span class="lifetime">'_</span>, SegmentRegisters> { |
| <span class="self">self</span>.registers |
| .write() |
| .expect(<span class="string">"Failed to acquire write lock on SegmentManager."</span>) |
| } |
| |
| <span class="doccomment">/// Deletes all empty segments |
| </span><span class="kw">fn </span>remove_empty_segments(<span class="kw-2">&</span><span class="self">self</span>) { |
| <span class="kw">let </span><span class="kw-2">mut </span>registers_lock = <span class="self">self</span>.write(); |
| registers_lock |
| .committed |
| .segment_entries() |
| .iter() |
| .filter(|segment| segment.meta().num_docs() == <span class="number">0</span>) |
| .for_each(|segment| { |
| registers_lock |
| .committed |
| .remove_segment(<span class="kw-2">&</span>segment.segment_id()) |
| }); |
| } |
| |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>remove_all_segments(<span class="kw-2">&</span><span class="self">self</span>) { |
| <span class="kw">let </span><span class="kw-2">mut </span>registers_lock = <span class="self">self</span>.write(); |
| registers_lock.committed.clear(); |
| registers_lock.uncommitted.clear(); |
| } |
| |
| <span class="kw">pub fn </span>commit(<span class="kw-2">&</span><span class="self">self</span>, segment_entries: Vec<SegmentEntry>) { |
| <span class="kw">let </span><span class="kw-2">mut </span>registers_lock = <span class="self">self</span>.write(); |
| registers_lock.committed.clear(); |
| registers_lock.uncommitted.clear(); |
| <span class="kw">for </span>segment_entry <span class="kw">in </span>segment_entries { |
| registers_lock.committed.add_segment_entry(segment_entry); |
| } |
| } |
| |
| <span class="doccomment">/// Marks a list of segments as in merge. |
| /// |
| /// Returns an error if some segments are missing, or if |
| /// the `segment_ids` are not either all committed or all |
| /// uncommitted. |
| </span><span class="kw">pub fn </span>start_merge(<span class="kw-2">&</span><span class="self">self</span>, segment_ids: <span class="kw-2">&</span>[SegmentId]) -> <span class="kw">crate</span>::Result<Vec<SegmentEntry>> { |
| <span class="kw">let </span>registers_lock = <span class="self">self</span>.read(); |
| <span class="kw">let </span><span class="kw-2">mut </span>segment_entries = <span class="macro">vec!</span>[]; |
| <span class="kw">if </span>registers_lock.uncommitted.contains_all(segment_ids) { |
| <span class="kw">for </span>segment_id <span class="kw">in </span>segment_ids { |
| <span class="kw">let </span>segment_entry = registers_lock.uncommitted.get(segment_id).expect( |
| <span class="string">"Segment id not found {}. Should never happen because of the contains all \ |
| if-block."</span>, |
| ); |
| segment_entries.push(segment_entry); |
| } |
| } <span class="kw">else if </span>registers_lock.committed.contains_all(segment_ids) { |
| <span class="kw">for </span>segment_id <span class="kw">in </span>segment_ids { |
| <span class="kw">let </span>segment_entry = registers_lock.committed.get(segment_id).expect( |
| <span class="string">"Segment id not found {}. Should never happen because of the contains all \ |
| if-block."</span>, |
| ); |
| segment_entries.push(segment_entry); |
| } |
| } <span class="kw">else </span>{ |
| <span class="kw">let </span>error_msg = <span class="string">"Merge operation sent for segments that are not all uncommitted or \ |
| committed." |
| </span>.to_string(); |
| <span class="kw">return </span><span class="prelude-val">Err</span>(TantivyError::InvalidArgument(error_msg)); |
| } |
| |
| <span class="prelude-val">Ok</span>(segment_entries) |
| } |
| |
| <span class="kw">pub fn </span>add_segment(<span class="kw-2">&</span><span class="self">self</span>, segment_entry: SegmentEntry) { |
| <span class="kw">let </span><span class="kw-2">mut </span>registers_lock = <span class="self">self</span>.write(); |
| registers_lock.uncommitted.add_segment_entry(segment_entry); |
| } |
| <span class="comment">// Replace a list of segments for their equivalent merged segment. |
| // |
| // Returns true if these segments are committed, false if the merge segments are uncommitted. |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>end_merge( |
| <span class="kw-2">&</span><span class="self">self</span>, |
| before_merge_segment_ids: <span class="kw-2">&</span>[SegmentId], |
| after_merge_segment_entry: <span class="prelude-ty">Option</span><SegmentEntry>, |
| ) -> <span class="kw">crate</span>::Result<SegmentsStatus> { |
| <span class="kw">let </span><span class="kw-2">mut </span>registers_lock = <span class="self">self</span>.write(); |
| <span class="kw">let </span>segments_status = registers_lock |
| .segments_status(before_merge_segment_ids) |
| .ok_or_else(|| { |
| <span class="macro">warn!</span>(<span class="string">"couldn't find segment in SegmentManager"</span>); |
| <span class="kw">crate</span>::TantivyError::InvalidArgument( |
| <span class="string">"The segments that were merged could not be found in the SegmentManager. This \ |
| is not necessarily a bug, and can happen after a rollback for instance." |
| </span>.to_string(), |
| ) |
| })<span class="question-mark">?</span>; |
| |
| <span class="kw">let </span>target_register: <span class="kw-2">&mut </span>SegmentRegister = <span class="kw">match </span>segments_status { |
| SegmentsStatus::Uncommitted => <span class="kw-2">&mut </span>registers_lock.uncommitted, |
| SegmentsStatus::Committed => <span class="kw-2">&mut </span>registers_lock.committed, |
| }; |
| <span class="kw">for </span>segment_id <span class="kw">in </span>before_merge_segment_ids { |
| target_register.remove_segment(segment_id); |
| } |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(entry) = after_merge_segment_entry { |
| target_register.add_segment_entry(entry); |
| } |
| <span class="prelude-val">Ok</span>(segments_status) |
| } |
| |
| <span class="kw">pub fn </span>committed_segment_metas(<span class="kw-2">&</span><span class="self">self</span>) -> Vec<SegmentMeta> { |
| <span class="self">self</span>.remove_empty_segments(); |
| <span class="kw">let </span>registers_lock = <span class="self">self</span>.read(); |
| registers_lock.committed.segment_metas() |
| } |
| } |
| </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> |
