blob: aa522c2b599f0d40f4723c3db12d9e0c2b945f98 [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/hashbrown-0.12.3/src/raw/sse2.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>sse2.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="../../../hashbrown/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="../../../hashbrown/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>
</pre><pre class="rust"><code><span class="kw">use </span><span class="kw">super</span>::bitmask::BitMask;
<span class="kw">use </span><span class="kw">super</span>::EMPTY;
<span class="kw">use </span>core::mem;
<span class="attribute">#[cfg(target_arch = <span class="string">&quot;x86&quot;</span>)]
</span><span class="kw">use </span>core::arch::x86;
<span class="attribute">#[cfg(target_arch = <span class="string">&quot;x86_64&quot;</span>)]
</span><span class="kw">use </span>core::arch::x86_64 <span class="kw">as </span>x86;
<span class="kw">pub type </span>BitMaskWord = u16;
<span class="kw">pub const </span>BITMASK_STRIDE: usize = <span class="number">1</span>;
<span class="kw">pub const </span>BITMASK_MASK: BitMaskWord = <span class="number">0xffff</span>;
<span class="doccomment">/// Abstraction over a group of control bytes which can be scanned in
/// parallel.
///
/// This implementation uses a 128-bit SSE value.
</span><span class="attribute">#[derive(Copy, Clone)]
</span><span class="kw">pub struct </span>Group(x86::__m128i);
<span class="comment">// FIXME: https://github.com/rust-lang/rust-clippy/issues/3859
</span><span class="attribute">#[allow(clippy::use_self)]
</span><span class="kw">impl </span>Group {
<span class="doccomment">/// Number of bytes in the group.
</span><span class="kw">pub const </span>WIDTH: usize = mem::size_of::&lt;<span class="self">Self</span>&gt;();
<span class="doccomment">/// Returns a full group of empty bytes, suitable for use as the initial
/// value for an empty hash table.
///
/// This is guaranteed to be aligned to the group size.
</span><span class="attribute">#[inline]
#[allow(clippy::items_after_statements)]
</span><span class="kw">pub const fn </span>static_empty() -&gt; <span class="kw-2">&amp;</span><span class="lifetime">&#39;static </span>[u8; Group::WIDTH] {
<span class="attribute">#[repr(C)]
</span><span class="kw">struct </span>AlignedBytes {
_align: [Group; <span class="number">0</span>],
bytes: [u8; Group::WIDTH],
}
<span class="kw">const </span>ALIGNED_BYTES: AlignedBytes = AlignedBytes {
_align: [],
bytes: [EMPTY; Group::WIDTH],
};
<span class="kw-2">&amp;</span>ALIGNED_BYTES.bytes
}
<span class="doccomment">/// Loads a group of bytes starting at the given address.
</span><span class="attribute">#[inline]
#[allow(clippy::cast_ptr_alignment)] </span><span class="comment">// unaligned load
</span><span class="kw">pub unsafe fn </span>load(ptr: <span class="kw-2">*const </span>u8) -&gt; <span class="self">Self </span>{
Group(x86::_mm_loadu_si128(ptr.cast()))
}
<span class="doccomment">/// Loads a group of bytes starting at the given address, which must be
/// aligned to `mem::align_of::&lt;Group&gt;()`.
</span><span class="attribute">#[inline]
#[allow(clippy::cast_ptr_alignment)]
</span><span class="kw">pub unsafe fn </span>load_aligned(ptr: <span class="kw-2">*const </span>u8) -&gt; <span class="self">Self </span>{
<span class="comment">// FIXME: use align_offset once it stabilizes
</span><span class="macro">debug_assert_eq!</span>(ptr <span class="kw">as </span>usize &amp; (mem::align_of::&lt;<span class="self">Self</span>&gt;() - <span class="number">1</span>), <span class="number">0</span>);
Group(x86::_mm_load_si128(ptr.cast()))
}
<span class="doccomment">/// Stores the group of bytes to the given address, which must be
/// aligned to `mem::align_of::&lt;Group&gt;()`.
</span><span class="attribute">#[inline]
#[allow(clippy::cast_ptr_alignment)]
</span><span class="kw">pub unsafe fn </span>store_aligned(<span class="self">self</span>, ptr: <span class="kw-2">*mut </span>u8) {
<span class="comment">// FIXME: use align_offset once it stabilizes
</span><span class="macro">debug_assert_eq!</span>(ptr <span class="kw">as </span>usize &amp; (mem::align_of::&lt;<span class="self">Self</span>&gt;() - <span class="number">1</span>), <span class="number">0</span>);
x86::_mm_store_si128(ptr.cast(), <span class="self">self</span>.<span class="number">0</span>);
}
<span class="doccomment">/// Returns a `BitMask` indicating all bytes in the group which have
/// the given value.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>match_byte(<span class="self">self</span>, byte: u8) -&gt; BitMask {
<span class="attribute">#[allow(
clippy::cast_possible_wrap, <span class="comment">// byte: u8 as i8
// byte: i32 as u16
// note: _mm_movemask_epi8 returns a 16-bit mask in a i32, the
// upper 16-bits of the i32 are zeroed:
</span>clippy::cast_sign_loss,
clippy::cast_possible_truncation
)]
</span><span class="kw">unsafe </span>{
<span class="kw">let </span>cmp = x86::_mm_cmpeq_epi8(<span class="self">self</span>.<span class="number">0</span>, x86::_mm_set1_epi8(byte <span class="kw">as </span>i8));
BitMask(x86::_mm_movemask_epi8(cmp) <span class="kw">as </span>u16)
}
}
<span class="doccomment">/// Returns a `BitMask` indicating all bytes in the group which are
/// `EMPTY`.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>match_empty(<span class="self">self</span>) -&gt; BitMask {
<span class="self">self</span>.match_byte(EMPTY)
}
<span class="doccomment">/// Returns a `BitMask` indicating all bytes in the group which are
/// `EMPTY` or `DELETED`.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>match_empty_or_deleted(<span class="self">self</span>) -&gt; BitMask {
<span class="attribute">#[allow(
<span class="comment">// byte: i32 as u16
// note: _mm_movemask_epi8 returns a 16-bit mask in a i32, the
// upper 16-bits of the i32 are zeroed:
</span>clippy::cast_sign_loss,
clippy::cast_possible_truncation
)]
</span><span class="kw">unsafe </span>{
<span class="comment">// A byte is EMPTY or DELETED iff the high bit is set
</span>BitMask(x86::_mm_movemask_epi8(<span class="self">self</span>.<span class="number">0</span>) <span class="kw">as </span>u16)
}
}
<span class="doccomment">/// Returns a `BitMask` indicating all bytes in the group which are full.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>match_full(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; BitMask {
<span class="self">self</span>.match_empty_or_deleted().invert()
}
<span class="doccomment">/// Performs the following transformation on all bytes in the group:
/// - `EMPTY =&gt; EMPTY`
/// - `DELETED =&gt; EMPTY`
/// - `FULL =&gt; DELETED`
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>convert_special_to_empty_and_full_to_deleted(<span class="self">self</span>) -&gt; <span class="self">Self </span>{
<span class="comment">// Map high_bit = 1 (EMPTY or DELETED) to 1111_1111
// and high_bit = 0 (FULL) to 1000_0000
//
// Here&#39;s this logic expanded to concrete values:
// let special = 0 &gt; byte = 1111_1111 (true) or 0000_0000 (false)
// 1111_1111 | 1000_0000 = 1111_1111
// 0000_0000 | 1000_0000 = 1000_0000
</span><span class="attribute">#[allow(
clippy::cast_possible_wrap, <span class="comment">// byte: 0x80_u8 as i8
</span>)]
</span><span class="kw">unsafe </span>{
<span class="kw">let </span>zero = x86::_mm_setzero_si128();
<span class="kw">let </span>special = x86::_mm_cmpgt_epi8(zero, <span class="self">self</span>.<span class="number">0</span>);
Group(x86::_mm_or_si128(
special,
x86::_mm_set1_epi8(<span class="number">0x80_u8 </span><span class="kw">as </span>i8),
))
}
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="hashbrown" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>