blob: a255d805a6d2b2cd1b7d2eaa6a7d1f0682dddd8e [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/memchr-2.5.0/src/memmem/x86/sse.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>sse.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="../../../../memchr/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="../../../../memchr/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>
</pre><pre class="rust"><code><span class="kw">use </span>core::arch::x86_64::__m128i;
<span class="kw">use </span><span class="kw">crate</span>::memmem::{genericsimd, NeedleInfo};
<span class="doccomment">/// An SSE accelerated vectorized substring search routine that only works on
/// small needles.
</span><span class="attribute">#[derive(Clone, Copy, Debug)]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>Forward(genericsimd::Forward);
<span class="kw">impl </span>Forward {
<span class="doccomment">/// Create a new &quot;generic simd&quot; forward searcher. If one could not be
/// created from the given inputs, then None is returned.
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>new(ninfo: <span class="kw-2">&amp;</span>NeedleInfo, needle: <span class="kw-2">&amp;</span>[u8]) -&gt; <span class="prelude-ty">Option</span>&lt;Forward&gt; {
<span class="kw">if </span>!<span class="macro">cfg!</span>(memchr_runtime_sse2) {
<span class="kw">return </span><span class="prelude-val">None</span>;
}
genericsimd::Forward::new(ninfo, needle).map(Forward)
}
<span class="doccomment">/// Returns the minimum length of haystack that is needed for this searcher
/// to work. Passing a haystack with a length smaller than this will cause
/// `find` to panic.
</span><span class="attribute">#[inline(always)]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>min_haystack_len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<span class="self">self</span>.<span class="number">0</span>.min_haystack_len::&lt;__m128i&gt;()
}
<span class="attribute">#[inline(always)]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>find(
<span class="kw-2">&amp;</span><span class="self">self</span>,
haystack: <span class="kw-2">&amp;</span>[u8],
needle: <span class="kw-2">&amp;</span>[u8],
) -&gt; <span class="prelude-ty">Option</span>&lt;usize&gt; {
<span class="comment">// SAFETY: sse2 is enabled on all x86_64 targets, so this is always
// safe to call.
</span><span class="kw">unsafe </span>{ <span class="self">self</span>.find_impl(haystack, needle) }
}
<span class="doccomment">/// The implementation of find marked with the appropriate target feature.
///
/// # Safety
///
/// This is safe to call in all cases since sse2 is guaranteed to be part
/// of x86_64. It is marked as unsafe because of the target feature
/// attribute.
</span><span class="attribute">#[target_feature(enable = <span class="string">&quot;sse2&quot;</span>)]
</span><span class="kw">unsafe fn </span>find_impl(
<span class="kw-2">&amp;</span><span class="self">self</span>,
haystack: <span class="kw-2">&amp;</span>[u8],
needle: <span class="kw-2">&amp;</span>[u8],
) -&gt; <span class="prelude-ty">Option</span>&lt;usize&gt; {
genericsimd::fwd_find::&lt;__m128i&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>.<span class="number">0</span>, haystack, needle)
}
}
<span class="attribute">#[cfg(all(test, feature = <span class="string">&quot;std&quot;</span>, not(miri)))]
</span><span class="kw">mod </span>tests {
<span class="kw">use </span><span class="kw">crate</span>::memmem::{prefilter::PrefilterState, NeedleInfo};
<span class="kw">fn </span>find(
<span class="kw">_</span>: <span class="kw-2">&amp;mut </span>PrefilterState,
ninfo: <span class="kw-2">&amp;</span>NeedleInfo,
haystack: <span class="kw-2">&amp;</span>[u8],
needle: <span class="kw-2">&amp;</span>[u8],
) -&gt; <span class="prelude-ty">Option</span>&lt;usize&gt; {
<span class="kw">super</span>::Forward::new(ninfo, needle).unwrap().find(haystack, needle)
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>prefilter_permutations() {
<span class="kw">use </span><span class="kw">crate</span>::memmem::prefilter::tests::PrefilterTest;
<span class="comment">// SAFETY: sse2 is enabled on all x86_64 targets, so this is always
// safe to call.
</span><span class="kw">unsafe </span>{
PrefilterTest::run_all_tests_filter(find, |t| {
<span class="comment">// This substring searcher only works on certain configs, so
// filter our tests such that Forward::new will be guaranteed
// to succeed. (And also remove tests with a haystack that is
// too small.)
</span><span class="kw">let </span>fwd = <span class="kw">match </span><span class="kw">super</span>::Forward::new(<span class="kw-2">&amp;</span>t.ninfo, <span class="kw-2">&amp;</span>t.needle) {
<span class="prelude-val">None </span>=&gt; <span class="kw">return </span><span class="bool-val">false</span>,
<span class="prelude-val">Some</span>(fwd) =&gt; fwd,
};
t.haystack.len() &gt;= fwd.min_haystack_len()
})
}
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../../../" data-current-crate="memchr" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>