blob: 24c9696e94befbc705a21020f1d5c91e479620ef [file] [log] [blame]
<!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 `common/rusty_leveldb_sgx/src/table_block.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>table_block.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="../../rusty_leveldb/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../rusty_leveldb/index.html"><img class="rust-logo" src="../../rust-logo.svg" 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>
</pre><pre class="rust"><code><span class="kw">use </span><span class="kw">crate</span>::block::Block;
<span class="kw">use </span><span class="kw">crate</span>::blockhandle::BlockHandle;
<span class="kw">use </span><span class="kw">crate</span>::env::RandomAccess;
<span class="kw">use </span><span class="kw">crate</span>::error::{err, <span class="prelude-ty">Result</span>, StatusCode};
<span class="kw">use </span><span class="kw">crate</span>::filter;
<span class="kw">use </span><span class="kw">crate</span>::filter_block::FilterBlockReader;
<span class="kw">use </span><span class="kw">crate</span>::log::unmask_crc;
<span class="kw">use </span><span class="kw">crate</span>::options::{<span class="self">self</span>, CompressionType, Options};
<span class="kw">use </span><span class="kw">crate</span>::table_builder;
<span class="kw">use </span>crc::crc32::{<span class="self">self</span>, Hasher32};
<span class="kw">use </span>integer_encoding::FixedInt;
<span class="kw">use </span>snap::Decoder;
<span class="doccomment">/// Reads the data for the specified block handle from a file.
</span><span class="kw">fn </span>read_bytes(f: <span class="kw-2">&amp;</span><span class="kw">dyn </span>RandomAccess, location: <span class="kw-2">&amp;</span>BlockHandle) -&gt; <span class="prelude-ty">Result</span>&lt;Vec&lt;u8&gt;&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>buf = <span class="macro">vec!</span>[<span class="number">0</span>; location.size()];
f.read_at(location.offset(), <span class="kw-2">&amp;mut </span>buf).map(|<span class="kw">_</span>| buf)
}
<span class="doccomment">/// Reads a serialized filter block from a file and returns a FilterBlockReader.
</span><span class="kw">pub fn </span>read_filter_block(
src: <span class="kw-2">&amp;</span><span class="kw">dyn </span>RandomAccess,
location: <span class="kw-2">&amp;</span>BlockHandle,
policy: filter::BoxedFilterPolicy,
) -&gt; <span class="prelude-ty">Result</span>&lt;FilterBlockReader&gt; {
<span class="kw">if </span>location.size() == <span class="number">0 </span>{
<span class="kw">return </span>err(
StatusCode::InvalidArgument,
<span class="string">&quot;no filter block in empty location&quot;</span>,
);
}
<span class="kw">let </span>buf = read_bytes(src, location)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(FilterBlockReader::new_owned(policy, buf))
}
<span class="doccomment">/// Reads a table block from a random-access source.
/// A table block consists of [bytes..., compress (1B), checksum (4B)]; the handle only refers to
/// the location and length of [bytes...].
</span><span class="kw">pub fn </span>read_table_block(
opt: Options,
f: <span class="kw-2">&amp;</span><span class="kw">dyn </span>RandomAccess,
location: <span class="kw-2">&amp;</span>BlockHandle,
) -&gt; <span class="prelude-ty">Result</span>&lt;Block&gt; {
<span class="comment">// The block is denoted by offset and length in BlockHandle. A block in an encoded
// table is followed by 1B compression type and 4B checksum.
// The checksum refers to the compressed contents.
</span><span class="kw">let </span>buf = read_bytes(f, location)<span class="question-mark">?</span>;
<span class="kw">let </span>compress = read_bytes(
f,
<span class="kw-2">&amp;</span>BlockHandle::new(
location.offset() + location.size(),
table_builder::TABLE_BLOCK_COMPRESS_LEN,
),
)<span class="question-mark">?</span>;
<span class="kw">let </span>cksum = read_bytes(
f,
<span class="kw-2">&amp;</span>BlockHandle::new(
location.offset() + location.size() + table_builder::TABLE_BLOCK_COMPRESS_LEN,
table_builder::TABLE_BLOCK_CKSUM_LEN,
),
)<span class="question-mark">?</span>;
<span class="kw">if </span>!verify_table_block(<span class="kw-2">&amp;</span>buf, compress[<span class="number">0</span>], unmask_crc(u32::decode_fixed(<span class="kw-2">&amp;</span>cksum))) {
<span class="kw">return </span>err(
StatusCode::Corruption,
<span class="kw-2">&amp;</span><span class="macro">format!</span>(
<span class="string">&quot;checksum verification failed for block at {}&quot;</span>,
location.offset()
),
);
}
<span class="kw">if let </span><span class="prelude-val">Some</span>(ctype) = options::int_to_compressiontype(compress[<span class="number">0</span>] <span class="kw">as </span>u32) {
<span class="kw">match </span>ctype {
CompressionType::CompressionNone =&gt; <span class="prelude-val">Ok</span>(Block::new(opt, buf)),
CompressionType::CompressionSnappy =&gt; {
<span class="kw">let </span>decoded = Decoder::new().decompress_vec(<span class="kw-2">&amp;</span>buf)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(Block::new(opt, decoded))
}
}
} <span class="kw">else </span>{
err(StatusCode::InvalidData, <span class="string">&quot;invalid compression type&quot;</span>)
}
}
<span class="doccomment">/// Verify checksum of block
</span><span class="kw">fn </span>verify_table_block(data: <span class="kw-2">&amp;</span>[u8], compression: u8, want: u32) -&gt; bool {
<span class="kw">let </span><span class="kw-2">mut </span>digest = crc32::Digest::new(crc32::CASTAGNOLI);
digest.write(data);
digest.write(<span class="kw-2">&amp;</span>[compression; <span class="number">1</span>]);
digest.sum32() == want
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rusty_leveldb" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>