blob: c6465613d5bc27fca5cbc4ecd34c41f57a51901a [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 `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/snap-0.2.5/src/crc32.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>crc32.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="../../snap/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="../../snap/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>
<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>
</pre><pre class="rust"><code><span class="comment">// Sadly, all of the crc crates in Rust appear to be insufficient for high
// performance algorithms. In fact, the implementation here is insufficient!
// The best implementation uses the CRC32 instruction from SSE 4.2, but using
// specialty instructions on stable Rust is an absolute nightmare at the
// moment. The only way I can think to do it is to write some Assembly in a
// separate source file and run an Assembler from build.rs. But we&#39;d need to be
// careful to only do this on platforms that support the CRC32 instruction,
// which means we&#39;d need to query CPUID. There are a couple Rust crates for
// that, but of course, they only work on unstable Rust so we&#39;d need to hand
// roll that too.
//
// As a stopgap, we implement the fastest (slicing-by-16) algorithm described
// here: http://create.stephan-brumme.com/crc32/
// (Actually, slicing-by-16 doesn&#39;t seem to be measurably faster than
// slicing-by-8 on my i7-6900K, so use slicing-by-8.)
//
// For Snappy, we only care about CRC32C (32 bit, Castagnoli).
//
// ---AG
// We have a bunch of different implementations of crc32 below that seem
// somewhat useful to leave around for easy benchmarking.
</span><span class="attribute">#![allow(dead_code)]
</span><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian <span class="kw">as </span>LE};
<span class="kw">const </span>CASTAGNOLI_POLY: u32 = <span class="number">0x82f63b78</span>;
<span class="macro">lazy_static! </span>{
<span class="kw">static </span><span class="kw-2">ref </span>TABLE: [u32; <span class="number">256</span>] = make_table(CASTAGNOLI_POLY);
<span class="kw">static </span><span class="kw-2">ref </span>TABLE16: [[u32; <span class="number">256</span>]; <span class="number">16</span>] = {
<span class="kw">let </span><span class="kw-2">mut </span>tab = [[<span class="number">0</span>; <span class="number">256</span>]; <span class="number">16</span>];
tab[<span class="number">0</span>] = make_table(CASTAGNOLI_POLY);
<span class="kw">for </span>i <span class="kw">in </span><span class="number">0</span>..<span class="number">256 </span>{
<span class="kw">let </span><span class="kw-2">mut </span>crc = tab[<span class="number">0</span>][i];
<span class="kw">for </span>j <span class="kw">in </span><span class="number">1</span>..<span class="number">16 </span>{
crc = (crc &gt;&gt; <span class="number">8</span>) ^ tab[<span class="number">0</span>][crc <span class="kw">as </span>u8 <span class="kw">as </span>usize];
tab[j][i] = crc;
}
}
tab
};
}
<span class="doccomment">/// Returns the CRC32 checksum of `buf` using the Castagnoli polynomial.
</span><span class="kw">pub fn </span>crc32c(buf: <span class="kw-2">&amp;</span>[u8]) -&gt; u32 {
<span class="comment">// I can&#39;t measure any difference between slice8 and slice16.
</span>crc32c_slice8(buf)
}
<span class="doccomment">/// Returns the CRC32 checksum of `buf` using the Castagnoli polynomial.
</span><span class="kw">fn </span>crc32c_slice16(<span class="kw-2">mut </span>buf: <span class="kw-2">&amp;</span>[u8]) -&gt; u32 {
<span class="kw">let </span>tab = <span class="kw-2">&amp;*</span>TABLE;
<span class="kw">let </span>tab16 = <span class="kw-2">&amp;*</span>TABLE16;
<span class="kw">let </span><span class="kw-2">mut </span>crc: u32 = !<span class="number">0</span>;
<span class="kw">while </span>buf.len() &gt;= <span class="number">16 </span>{
crc ^= LE::read_u32(<span class="kw-2">&amp;</span>buf[<span class="number">0</span>..<span class="number">4</span>]);
crc = tab16[<span class="number">0</span>][buf[<span class="number">15</span>] <span class="kw">as </span>usize]
^ tab16[<span class="number">1</span>][buf[<span class="number">14</span>] <span class="kw">as </span>usize]
^ tab16[<span class="number">2</span>][buf[<span class="number">13</span>] <span class="kw">as </span>usize]
^ tab16[<span class="number">3</span>][buf[<span class="number">12</span>] <span class="kw">as </span>usize]
^ tab16[<span class="number">4</span>][buf[<span class="number">11</span>] <span class="kw">as </span>usize]
^ tab16[<span class="number">5</span>][buf[<span class="number">10</span>] <span class="kw">as </span>usize]
^ tab16[<span class="number">6</span>][buf[<span class="number">9</span>] <span class="kw">as </span>usize]
^ tab16[<span class="number">7</span>][buf[<span class="number">8</span>] <span class="kw">as </span>usize]
^ tab16[<span class="number">8</span>][buf[<span class="number">7</span>] <span class="kw">as </span>usize]
^ tab16[<span class="number">9</span>][buf[<span class="number">6</span>] <span class="kw">as </span>usize]
^ tab16[<span class="number">10</span>][buf[<span class="number">5</span>] <span class="kw">as </span>usize]
^ tab16[<span class="number">11</span>][buf[<span class="number">4</span>] <span class="kw">as </span>usize]
^ tab16[<span class="number">12</span>][(crc &gt;&gt; <span class="number">24</span>) <span class="kw">as </span>u8 <span class="kw">as </span>usize]
^ tab16[<span class="number">13</span>][(crc &gt;&gt; <span class="number">16</span>) <span class="kw">as </span>u8 <span class="kw">as </span>usize]
^ tab16[<span class="number">14</span>][(crc &gt;&gt; <span class="number">8 </span>) <span class="kw">as </span>u8 <span class="kw">as </span>usize]
^ tab16[<span class="number">15</span>][(crc ) <span class="kw">as </span>u8 <span class="kw">as </span>usize];
buf = <span class="kw-2">&amp;</span>buf[<span class="number">16</span>..];
}
<span class="kw">for </span><span class="kw-2">&amp;</span>b <span class="kw">in </span>buf {
crc = tab[((crc <span class="kw">as </span>u8) ^ b) <span class="kw">as </span>usize] ^ (crc &gt;&gt; <span class="number">8</span>);
}
!crc
}
<span class="doccomment">/// Returns the CRC32 checksum of `buf` using the Castagnoli polynomial.
</span><span class="kw">fn </span>crc32c_slice8(<span class="kw-2">mut </span>buf: <span class="kw-2">&amp;</span>[u8]) -&gt; u32 {
<span class="kw">let </span>tab = <span class="kw-2">&amp;*</span>TABLE;
<span class="kw">let </span>tab8 = <span class="kw-2">&amp;*</span>TABLE16;
<span class="kw">let </span><span class="kw-2">mut </span>crc: u32 = !<span class="number">0</span>;
<span class="kw">while </span>buf.len() &gt;= <span class="number">8 </span>{
crc ^= LE::read_u32(<span class="kw-2">&amp;</span>buf[<span class="number">0</span>..<span class="number">4</span>]);
crc = tab8[<span class="number">0</span>][buf[<span class="number">7</span>] <span class="kw">as </span>usize]
^ tab8[<span class="number">1</span>][buf[<span class="number">6</span>] <span class="kw">as </span>usize]
^ tab8[<span class="number">2</span>][buf[<span class="number">5</span>] <span class="kw">as </span>usize]
^ tab8[<span class="number">3</span>][buf[<span class="number">4</span>] <span class="kw">as </span>usize]
^ tab8[<span class="number">4</span>][(crc &gt;&gt; <span class="number">24</span>) <span class="kw">as </span>u8 <span class="kw">as </span>usize]
^ tab8[<span class="number">5</span>][(crc &gt;&gt; <span class="number">16</span>) <span class="kw">as </span>u8 <span class="kw">as </span>usize]
^ tab8[<span class="number">6</span>][(crc &gt;&gt; <span class="number">8 </span>) <span class="kw">as </span>u8 <span class="kw">as </span>usize]
^ tab8[<span class="number">7</span>][(crc ) <span class="kw">as </span>u8 <span class="kw">as </span>usize];
buf = <span class="kw-2">&amp;</span>buf[<span class="number">8</span>..];
}
<span class="kw">for </span><span class="kw-2">&amp;</span>b <span class="kw">in </span>buf {
crc = tab[((crc <span class="kw">as </span>u8) ^ b) <span class="kw">as </span>usize] ^ (crc &gt;&gt; <span class="number">8</span>);
}
!crc
}
<span class="doccomment">/// Returns the CRC32 checksum of `buf` using the Castagnoli polynomial.
</span><span class="kw">fn </span>crc32c_slice4(<span class="kw-2">mut </span>buf: <span class="kw-2">&amp;</span>[u8]) -&gt; u32 {
<span class="kw">let </span>tab = <span class="kw-2">&amp;*</span>TABLE;
<span class="kw">let </span>tab4 = <span class="kw-2">&amp;*</span>TABLE16;
<span class="kw">let </span><span class="kw-2">mut </span>crc: u32 = !<span class="number">0</span>;
<span class="kw">while </span>buf.len() &gt;= <span class="number">4 </span>{
crc ^= LE::read_u32(<span class="kw-2">&amp;</span>buf[<span class="number">0</span>..<span class="number">4</span>]);
crc = tab4[<span class="number">0</span>][(crc &gt;&gt; <span class="number">24</span>) <span class="kw">as </span>u8 <span class="kw">as </span>usize]
^ tab4[<span class="number">1</span>][(crc &gt;&gt; <span class="number">16</span>) <span class="kw">as </span>u8 <span class="kw">as </span>usize]
^ tab4[<span class="number">2</span>][(crc &gt;&gt; <span class="number">8 </span>) <span class="kw">as </span>u8 <span class="kw">as </span>usize]
^ tab4[<span class="number">3</span>][(crc ) <span class="kw">as </span>u8 <span class="kw">as </span>usize];
buf = <span class="kw-2">&amp;</span>buf[<span class="number">4</span>..];
}
<span class="kw">for </span><span class="kw-2">&amp;</span>b <span class="kw">in </span>buf {
crc = tab[((crc <span class="kw">as </span>u8) ^ b) <span class="kw">as </span>usize] ^ (crc &gt;&gt; <span class="number">8</span>);
}
!crc
}
<span class="doccomment">/// Returns the CRC32 checksum of `buf` using the Castagnoli polynomial.
</span><span class="kw">fn </span>crc32c_multiple(buf: <span class="kw-2">&amp;</span>[u8]) -&gt; u32 {
<span class="kw">let </span>tab = <span class="kw-2">&amp;*</span>TABLE;
<span class="kw">let </span><span class="kw-2">mut </span>crc: u32 = !<span class="number">0</span>;
<span class="kw">for </span><span class="kw-2">&amp;</span>b <span class="kw">in </span>buf {
crc = tab[((crc <span class="kw">as </span>u8) ^ b) <span class="kw">as </span>usize] ^ (crc &gt;&gt; <span class="number">8</span>);
}
!crc
}
<span class="doccomment">/// Returns the CRC32 checksum of `buf` using the Castagnoli polynomial.
</span><span class="kw">fn </span>crc32c_bitwise(buf: <span class="kw-2">&amp;</span>[u8]) -&gt; u32 {
<span class="kw">let </span><span class="kw-2">mut </span>crc: u32 = !<span class="number">0</span>;
<span class="kw">for </span><span class="kw-2">&amp;</span>b <span class="kw">in </span>buf {
crc ^= b <span class="kw">as </span>u32;
<span class="kw">for _ in </span><span class="number">0</span>..<span class="number">8 </span>{
crc = (crc &gt;&gt; <span class="number">1</span>) ^ ((crc &amp; <span class="number">1</span>) * CASTAGNOLI_POLY);
}
}
!crc
}
<span class="kw">fn </span>make_table(poly: u32) -&gt; [u32; <span class="number">256</span>] {
<span class="kw">let </span><span class="kw-2">mut </span>tab = [<span class="number">0</span>; <span class="number">256</span>];
<span class="kw">for </span>i <span class="kw">in </span><span class="number">0u32</span>..<span class="number">256u32 </span>{
<span class="kw">let </span><span class="kw-2">mut </span>crc = i;
<span class="kw">for _ in </span><span class="number">0</span>..<span class="number">8 </span>{
<span class="kw">if </span>crc &amp; <span class="number">1 </span>== <span class="number">1 </span>{
crc = (crc &gt;&gt; <span class="number">1</span>) ^ poly;
} <span class="kw">else </span>{
crc &gt;&gt;= <span class="number">1</span>;
}
}
tab[i <span class="kw">as </span>usize] = crc;
}
tab
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="snap" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>