blob: ecae9a02b62d44b9e88326b7beff82c0e07630a2 [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/aho-corasick-1.0.2/src/packed/teddy/compile.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>compile.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="../../../../aho_corasick/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="../../../../aho_corasick/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>
<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>
<span id="223">223</span>
<span id="224">224</span>
<span id="225">225</span>
<span id="226">226</span>
<span id="227">227</span>
<span id="228">228</span>
<span id="229">229</span>
<span id="230">230</span>
<span id="231">231</span>
<span id="232">232</span>
<span id="233">233</span>
<span id="234">234</span>
<span id="235">235</span>
<span id="236">236</span>
<span id="237">237</span>
<span id="238">238</span>
<span id="239">239</span>
<span id="240">240</span>
<span id="241">241</span>
<span id="242">242</span>
<span id="243">243</span>
<span id="244">244</span>
<span id="245">245</span>
<span id="246">246</span>
<span id="247">247</span>
<span id="248">248</span>
<span id="249">249</span>
<span id="250">250</span>
<span id="251">251</span>
<span id="252">252</span>
<span id="253">253</span>
<span id="254">254</span>
<span id="255">255</span>
<span id="256">256</span>
<span id="257">257</span>
<span id="258">258</span>
<span id="259">259</span>
<span id="260">260</span>
<span id="261">261</span>
<span id="262">262</span>
<span id="263">263</span>
<span id="264">264</span>
<span id="265">265</span>
<span id="266">266</span>
<span id="267">267</span>
<span id="268">268</span>
<span id="269">269</span>
<span id="270">270</span>
<span id="271">271</span>
<span id="272">272</span>
<span id="273">273</span>
<span id="274">274</span>
<span id="275">275</span>
<span id="276">276</span>
<span id="277">277</span>
<span id="278">278</span>
<span id="279">279</span>
<span id="280">280</span>
<span id="281">281</span>
<span id="282">282</span>
<span id="283">283</span>
<span id="284">284</span>
<span id="285">285</span>
<span id="286">286</span>
<span id="287">287</span>
<span id="288">288</span>
<span id="289">289</span>
<span id="290">290</span>
<span id="291">291</span>
<span id="292">292</span>
<span id="293">293</span>
<span id="294">294</span>
<span id="295">295</span>
<span id="296">296</span>
<span id="297">297</span>
<span id="298">298</span>
<span id="299">299</span>
<span id="300">300</span>
<span id="301">301</span>
<span id="302">302</span>
<span id="303">303</span>
<span id="304">304</span>
<span id="305">305</span>
<span id="306">306</span>
<span id="307">307</span>
<span id="308">308</span>
<span id="309">309</span>
<span id="310">310</span>
<span id="311">311</span>
<span id="312">312</span>
<span id="313">313</span>
<span id="314">314</span>
<span id="315">315</span>
<span id="316">316</span>
<span id="317">317</span>
<span id="318">318</span>
<span id="319">319</span>
<span id="320">320</span>
<span id="321">321</span>
<span id="322">322</span>
<span id="323">323</span>
<span id="324">324</span>
<span id="325">325</span>
<span id="326">326</span>
<span id="327">327</span>
<span id="328">328</span>
<span id="329">329</span>
<span id="330">330</span>
<span id="331">331</span>
<span id="332">332</span>
<span id="333">333</span>
<span id="334">334</span>
<span id="335">335</span>
<span id="336">336</span>
<span id="337">337</span>
<span id="338">338</span>
<span id="339">339</span>
<span id="340">340</span>
<span id="341">341</span>
<span id="342">342</span>
<span id="343">343</span>
<span id="344">344</span>
<span id="345">345</span>
<span id="346">346</span>
<span id="347">347</span>
<span id="348">348</span>
<span id="349">349</span>
<span id="350">350</span>
<span id="351">351</span>
<span id="352">352</span>
<span id="353">353</span>
<span id="354">354</span>
<span id="355">355</span>
<span id="356">356</span>
<span id="357">357</span>
<span id="358">358</span>
<span id="359">359</span>
<span id="360">360</span>
<span id="361">361</span>
<span id="362">362</span>
<span id="363">363</span>
<span id="364">364</span>
<span id="365">365</span>
<span id="366">366</span>
<span id="367">367</span>
<span id="368">368</span>
<span id="369">369</span>
<span id="370">370</span>
<span id="371">371</span>
<span id="372">372</span>
<span id="373">373</span>
<span id="374">374</span>
<span id="375">375</span>
<span id="376">376</span>
<span id="377">377</span>
<span id="378">378</span>
<span id="379">379</span>
<span id="380">380</span>
<span id="381">381</span>
<span id="382">382</span>
<span id="383">383</span>
<span id="384">384</span>
<span id="385">385</span>
<span id="386">386</span>
<span id="387">387</span>
<span id="388">388</span>
<span id="389">389</span>
<span id="390">390</span>
<span id="391">391</span>
<span id="392">392</span>
<span id="393">393</span>
<span id="394">394</span>
<span id="395">395</span>
<span id="396">396</span>
<span id="397">397</span>
<span id="398">398</span>
<span id="399">399</span>
<span id="400">400</span>
<span id="401">401</span>
<span id="402">402</span>
<span id="403">403</span>
<span id="404">404</span>
<span id="405">405</span>
<span id="406">406</span>
<span id="407">407</span>
<span id="408">408</span>
<span id="409">409</span>
<span id="410">410</span>
<span id="411">411</span>
<span id="412">412</span>
<span id="413">413</span>
<span id="414">414</span>
<span id="415">415</span>
<span id="416">416</span>
<span id="417">417</span>
<span id="418">418</span>
<span id="419">419</span>
<span id="420">420</span>
<span id="421">421</span>
<span id="422">422</span>
<span id="423">423</span>
<span id="424">424</span>
<span id="425">425</span>
<span id="426">426</span>
<span id="427">427</span>
<span id="428">428</span>
<span id="429">429</span>
<span id="430">430</span>
<span id="431">431</span>
<span id="432">432</span>
<span id="433">433</span>
<span id="434">434</span>
<span id="435">435</span>
<span id="436">436</span>
<span id="437">437</span>
<span id="438">438</span>
<span id="439">439</span>
<span id="440">440</span>
<span id="441">441</span>
<span id="442">442</span>
<span id="443">443</span>
<span id="444">444</span>
<span id="445">445</span>
<span id="446">446</span>
<span id="447">447</span>
<span id="448">448</span>
<span id="449">449</span>
<span id="450">450</span>
<span id="451">451</span>
<span id="452">452</span>
<span id="453">453</span>
<span id="454">454</span>
<span id="455">455</span>
<span id="456">456</span>
<span id="457">457</span>
<span id="458">458</span>
<span id="459">459</span>
<span id="460">460</span>
<span id="461">461</span>
<span id="462">462</span>
<span id="463">463</span>
<span id="464">464</span>
<span id="465">465</span>
<span id="466">466</span>
<span id="467">467</span>
<span id="468">468</span>
<span id="469">469</span>
<span id="470">470</span>
<span id="471">471</span>
<span id="472">472</span>
<span id="473">473</span>
<span id="474">474</span>
<span id="475">475</span>
<span id="476">476</span>
<span id="477">477</span>
<span id="478">478</span>
<span id="479">479</span>
<span id="480">480</span>
<span id="481">481</span>
<span id="482">482</span>
<span id="483">483</span>
<span id="484">484</span>
<span id="485">485</span>
<span id="486">486</span>
<span id="487">487</span>
<span id="488">488</span>
<span id="489">489</span>
<span id="490">490</span>
<span id="491">491</span>
<span id="492">492</span>
<span id="493">493</span>
<span id="494">494</span>
<span id="495">495</span>
<span id="496">496</span>
<span id="497">497</span>
<span id="498">498</span>
<span id="499">499</span>
<span id="500">500</span>
<span id="501">501</span>
<span id="502">502</span>
</pre><pre class="rust"><code><span class="comment">// See the README in this directory for an explanation of the Teddy algorithm.
</span><span class="kw">use </span>core::{cmp, fmt};
<span class="kw">use </span>alloc::{collections::BTreeMap, format, vec, vec::Vec};
<span class="kw">use </span><span class="kw">crate</span>::packed::{
pattern::{PatternID, Patterns},
teddy::Teddy,
};
<span class="doccomment">/// A builder for constructing a Teddy matcher.
///
/// The builder primarily permits fine grained configuration of the Teddy
/// matcher. Most options are made only available for testing/benchmarking
/// purposes. In reality, options are automatically determined by the nature
/// and number of patterns given to the builder.
</span><span class="attribute">#[derive(Clone, Debug)]
</span><span class="kw">pub struct </span>Builder {
<span class="doccomment">/// When none, this is automatically determined. Otherwise, `false` means
/// slim Teddy is used (8 buckets) and `true` means fat Teddy is used
/// (16 buckets). Fat Teddy requires AVX2, so if that CPU feature isn&#39;t
/// available and Fat Teddy was requested, no matcher will be built.
</span>fat: <span class="prelude-ty">Option</span>&lt;bool&gt;,
<span class="doccomment">/// When none, this is automatically determined. Otherwise, `false` means
/// that 128-bit vectors will be used (up to SSSE3 instructions) where as
/// `true` means that 256-bit vectors will be used. As with `fat`, if
/// 256-bit vectors are requested and they aren&#39;t available, then a
/// searcher will not be built.
</span>avx: <span class="prelude-ty">Option</span>&lt;bool&gt;,
}
<span class="kw">impl </span>Default <span class="kw">for </span>Builder {
<span class="kw">fn </span>default() -&gt; Builder {
Builder::new()
}
}
<span class="kw">impl </span>Builder {
<span class="doccomment">/// Create a new builder for configuring a Teddy matcher.
</span><span class="kw">pub fn </span>new() -&gt; Builder {
Builder { fat: <span class="prelude-val">None</span>, avx: <span class="prelude-val">None </span>}
}
<span class="doccomment">/// Build a matcher for the set of patterns given. If a matcher could not
/// be built, then `None` is returned.
///
/// Generally, a matcher isn&#39;t built if the necessary CPU features aren&#39;t
/// available, an unsupported target or if the searcher is believed to be
/// slower than standard techniques (i.e., if there are too many literals).
</span><span class="kw">pub fn </span>build(<span class="kw-2">&amp;</span><span class="self">self</span>, patterns: <span class="kw-2">&amp;</span>Patterns) -&gt; <span class="prelude-ty">Option</span>&lt;Teddy&gt; {
<span class="self">self</span>.build_imp(patterns)
}
<span class="doccomment">/// Require the use of Fat (true) or Slim (false) Teddy. Fat Teddy uses
/// 16 buckets where as Slim Teddy uses 8 buckets. More buckets are useful
/// for a larger set of literals.
///
/// `None` is the default, which results in an automatic selection based
/// on the number of literals and available CPU features.
</span><span class="kw">pub fn </span>fat(<span class="kw-2">&amp;mut </span><span class="self">self</span>, yes: <span class="prelude-ty">Option</span>&lt;bool&gt;) -&gt; <span class="kw-2">&amp;mut </span>Builder {
<span class="self">self</span>.fat = yes;
<span class="self">self
</span>}
<span class="doccomment">/// Request the use of 256-bit vectors (true) or 128-bit vectors (false).
/// Generally, a larger vector size is better since it either permits
/// matching more patterns or matching more bytes in the haystack at once.
///
/// `None` is the default, which results in an automatic selection based on
/// the number of literals and available CPU features.
</span><span class="kw">pub fn </span>avx(<span class="kw-2">&amp;mut </span><span class="self">self</span>, yes: <span class="prelude-ty">Option</span>&lt;bool&gt;) -&gt; <span class="kw-2">&amp;mut </span>Builder {
<span class="self">self</span>.avx = yes;
<span class="self">self
</span>}
<span class="kw">fn </span>build_imp(<span class="kw-2">&amp;</span><span class="self">self</span>, patterns: <span class="kw-2">&amp;</span>Patterns) -&gt; <span class="prelude-ty">Option</span>&lt;Teddy&gt; {
<span class="kw">use </span><span class="kw">crate</span>::packed::teddy::runtime;
<span class="comment">// Most of the logic here is just about selecting the optimal settings,
// or perhaps even rejecting construction altogether. The choices
// we have are: fat (avx only) or not, ssse3 or avx2, and how many
// patterns we allow ourselves to search. Additionally, for testing
// and benchmarking, we permit callers to try to &quot;force&quot; a setting,
// and if the setting isn&#39;t allowed (e.g., forcing AVX when AVX isn&#39;t
// available), then we bail and return nothing.
</span><span class="kw">if </span>patterns.len() &gt; <span class="number">64 </span>{
<span class="macro">debug!</span>(<span class="string">&quot;skipping Teddy because of too many patterns&quot;</span>);
<span class="kw">return </span><span class="prelude-val">None</span>;
}
<span class="kw">let </span>has_ssse3 = <span class="macro">std::is_x86_feature_detected!</span>(<span class="string">&quot;ssse3&quot;</span>);
<span class="kw">let </span>has_avx = <span class="macro">std::is_x86_feature_detected!</span>(<span class="string">&quot;avx2&quot;</span>);
<span class="kw">let </span>avx = <span class="kw">if </span><span class="self">self</span>.avx == <span class="prelude-val">Some</span>(<span class="bool-val">true</span>) {
<span class="kw">if </span>!has_avx {
<span class="macro">debug!</span>(
<span class="string">&quot;skipping Teddy because avx was demanded but unavailable&quot;
</span>);
<span class="kw">return </span><span class="prelude-val">None</span>;
}
<span class="bool-val">true
</span>} <span class="kw">else if </span><span class="self">self</span>.avx == <span class="prelude-val">Some</span>(<span class="bool-val">false</span>) {
<span class="kw">if </span>!has_ssse3 {
<span class="macro">debug!</span>(
<span class="string">&quot;skipping Teddy because ssse3 was demanded but unavailable&quot;
</span>);
<span class="kw">return </span><span class="prelude-val">None</span>;
}
<span class="bool-val">false
</span>} <span class="kw">else if </span>!has_ssse3 &amp;&amp; !has_avx {
<span class="macro">debug!</span>(<span class="string">&quot;skipping Teddy because ssse3 and avx are unavailable&quot;</span>);
<span class="kw">return </span><span class="prelude-val">None</span>;
} <span class="kw">else </span>{
has_avx
};
<span class="kw">let </span>fat = <span class="kw">match </span><span class="self">self</span>.fat {
<span class="prelude-val">None </span>=&gt; avx &amp;&amp; patterns.len() &gt; <span class="number">32</span>,
<span class="prelude-val">Some</span>(<span class="bool-val">false</span>) =&gt; <span class="bool-val">false</span>,
<span class="prelude-val">Some</span>(<span class="bool-val">true</span>) <span class="kw">if </span>!avx =&gt; {
<span class="macro">debug!</span>(
<span class="string">&quot;skipping Teddy because it needs to be fat, but fat \
Teddy requires avx which is unavailable&quot;
</span>);
<span class="kw">return </span><span class="prelude-val">None</span>;
}
<span class="prelude-val">Some</span>(<span class="bool-val">true</span>) =&gt; <span class="bool-val">true</span>,
};
<span class="kw">let </span><span class="kw-2">mut </span>compiler = Compiler::new(patterns, fat);
compiler.compile();
<span class="kw">let </span>Compiler { buckets, masks, .. } = compiler;
<span class="comment">// SAFETY: It is required that the builder only produce Teddy matchers
// that are allowed to run on the current CPU, since we later assume
// that the presence of (for example) TeddySlim1Mask256 means it is
// safe to call functions marked with the `avx2` target feature.
</span><span class="kw">match </span>(masks.len(), avx, fat) {
(<span class="number">1</span>, <span class="bool-val">false</span>, <span class="kw">_</span>) =&gt; {
<span class="macro">debug!</span>(<span class="string">&quot;Teddy choice: 128-bit slim, 1 byte&quot;</span>);
<span class="prelude-val">Some</span>(Teddy {
buckets,
max_pattern_id: patterns.max_pattern_id(),
exec: runtime::Exec::TeddySlim1Mask128(
runtime::TeddySlim1Mask128 {
mask1: runtime::Mask128::new(masks[<span class="number">0</span>]),
},
),
})
}
(<span class="number">1</span>, <span class="bool-val">true</span>, <span class="bool-val">false</span>) =&gt; {
<span class="macro">debug!</span>(<span class="string">&quot;Teddy choice: 256-bit slim, 1 byte&quot;</span>);
<span class="prelude-val">Some</span>(Teddy {
buckets,
max_pattern_id: patterns.max_pattern_id(),
exec: runtime::Exec::TeddySlim1Mask256(
runtime::TeddySlim1Mask256 {
mask1: runtime::Mask256::new(masks[<span class="number">0</span>]),
},
),
})
}
(<span class="number">1</span>, <span class="bool-val">true</span>, <span class="bool-val">true</span>) =&gt; {
<span class="macro">debug!</span>(<span class="string">&quot;Teddy choice: 256-bit fat, 1 byte&quot;</span>);
<span class="prelude-val">Some</span>(Teddy {
buckets,
max_pattern_id: patterns.max_pattern_id(),
exec: runtime::Exec::TeddyFat1Mask256(
runtime::TeddyFat1Mask256 {
mask1: runtime::Mask256::new(masks[<span class="number">0</span>]),
},
),
})
}
(<span class="number">2</span>, <span class="bool-val">false</span>, <span class="kw">_</span>) =&gt; {
<span class="macro">debug!</span>(<span class="string">&quot;Teddy choice: 128-bit slim, 2 bytes&quot;</span>);
<span class="prelude-val">Some</span>(Teddy {
buckets,
max_pattern_id: patterns.max_pattern_id(),
exec: runtime::Exec::TeddySlim2Mask128(
runtime::TeddySlim2Mask128 {
mask1: runtime::Mask128::new(masks[<span class="number">0</span>]),
mask2: runtime::Mask128::new(masks[<span class="number">1</span>]),
},
),
})
}
(<span class="number">2</span>, <span class="bool-val">true</span>, <span class="bool-val">false</span>) =&gt; {
<span class="macro">debug!</span>(<span class="string">&quot;Teddy choice: 256-bit slim, 2 bytes&quot;</span>);
<span class="prelude-val">Some</span>(Teddy {
buckets,
max_pattern_id: patterns.max_pattern_id(),
exec: runtime::Exec::TeddySlim2Mask256(
runtime::TeddySlim2Mask256 {
mask1: runtime::Mask256::new(masks[<span class="number">0</span>]),
mask2: runtime::Mask256::new(masks[<span class="number">1</span>]),
},
),
})
}
(<span class="number">2</span>, <span class="bool-val">true</span>, <span class="bool-val">true</span>) =&gt; {
<span class="macro">debug!</span>(<span class="string">&quot;Teddy choice: 256-bit fat, 2 bytes&quot;</span>);
<span class="prelude-val">Some</span>(Teddy {
buckets,
max_pattern_id: patterns.max_pattern_id(),
exec: runtime::Exec::TeddyFat2Mask256(
runtime::TeddyFat2Mask256 {
mask1: runtime::Mask256::new(masks[<span class="number">0</span>]),
mask2: runtime::Mask256::new(masks[<span class="number">1</span>]),
},
),
})
}
(<span class="number">3</span>, <span class="bool-val">false</span>, <span class="kw">_</span>) =&gt; {
<span class="macro">debug!</span>(<span class="string">&quot;Teddy choice: 128-bit slim, 3 bytes&quot;</span>);
<span class="prelude-val">Some</span>(Teddy {
buckets,
max_pattern_id: patterns.max_pattern_id(),
exec: runtime::Exec::TeddySlim3Mask128(
runtime::TeddySlim3Mask128 {
mask1: runtime::Mask128::new(masks[<span class="number">0</span>]),
mask2: runtime::Mask128::new(masks[<span class="number">1</span>]),
mask3: runtime::Mask128::new(masks[<span class="number">2</span>]),
},
),
})
}
(<span class="number">3</span>, <span class="bool-val">true</span>, <span class="bool-val">false</span>) =&gt; {
<span class="macro">debug!</span>(<span class="string">&quot;Teddy choice: 256-bit slim, 3 bytes&quot;</span>);
<span class="prelude-val">Some</span>(Teddy {
buckets,
max_pattern_id: patterns.max_pattern_id(),
exec: runtime::Exec::TeddySlim3Mask256(
runtime::TeddySlim3Mask256 {
mask1: runtime::Mask256::new(masks[<span class="number">0</span>]),
mask2: runtime::Mask256::new(masks[<span class="number">1</span>]),
mask3: runtime::Mask256::new(masks[<span class="number">2</span>]),
},
),
})
}
(<span class="number">3</span>, <span class="bool-val">true</span>, <span class="bool-val">true</span>) =&gt; {
<span class="macro">debug!</span>(<span class="string">&quot;Teddy choice: 256-bit fat, 3 bytes&quot;</span>);
<span class="prelude-val">Some</span>(Teddy {
buckets,
max_pattern_id: patterns.max_pattern_id(),
exec: runtime::Exec::TeddyFat3Mask256(
runtime::TeddyFat3Mask256 {
mask1: runtime::Mask256::new(masks[<span class="number">0</span>]),
mask2: runtime::Mask256::new(masks[<span class="number">1</span>]),
mask3: runtime::Mask256::new(masks[<span class="number">2</span>]),
},
),
})
}
(<span class="number">4</span>, <span class="bool-val">false</span>, <span class="kw">_</span>) =&gt; {
<span class="macro">debug!</span>(<span class="string">&quot;Teddy choice: 128-bit slim, 4 bytes&quot;</span>);
<span class="prelude-val">Some</span>(Teddy {
buckets,
max_pattern_id: patterns.max_pattern_id(),
exec: runtime::Exec::TeddySlim4Mask128(
runtime::TeddySlim4Mask128 {
mask1: runtime::Mask128::new(masks[<span class="number">0</span>]),
mask2: runtime::Mask128::new(masks[<span class="number">1</span>]),
mask3: runtime::Mask128::new(masks[<span class="number">2</span>]),
mask4: runtime::Mask128::new(masks[<span class="number">3</span>]),
},
),
})
}
(<span class="number">4</span>, <span class="bool-val">true</span>, <span class="bool-val">false</span>) =&gt; {
<span class="macro">debug!</span>(<span class="string">&quot;Teddy choice: 256-bit slim, 4 bytes&quot;</span>);
<span class="prelude-val">Some</span>(Teddy {
buckets,
max_pattern_id: patterns.max_pattern_id(),
exec: runtime::Exec::TeddySlim4Mask256(
runtime::TeddySlim4Mask256 {
mask1: runtime::Mask256::new(masks[<span class="number">0</span>]),
mask2: runtime::Mask256::new(masks[<span class="number">1</span>]),
mask3: runtime::Mask256::new(masks[<span class="number">2</span>]),
mask4: runtime::Mask256::new(masks[<span class="number">3</span>]),
},
),
})
}
(<span class="number">4</span>, <span class="bool-val">true</span>, <span class="bool-val">true</span>) =&gt; {
<span class="macro">debug!</span>(<span class="string">&quot;Teddy choice: 256-bit fat, 4 bytes&quot;</span>);
<span class="prelude-val">Some</span>(Teddy {
buckets,
max_pattern_id: patterns.max_pattern_id(),
exec: runtime::Exec::TeddyFat4Mask256(
runtime::TeddyFat4Mask256 {
mask1: runtime::Mask256::new(masks[<span class="number">0</span>]),
mask2: runtime::Mask256::new(masks[<span class="number">1</span>]),
mask3: runtime::Mask256::new(masks[<span class="number">2</span>]),
mask4: runtime::Mask256::new(masks[<span class="number">3</span>]),
},
),
})
}
<span class="kw">_ </span>=&gt; <span class="macro">unreachable!</span>(),
}
}
}
<span class="doccomment">/// A compiler is in charge of allocating patterns into buckets and generating
/// the masks necessary for searching.
</span><span class="attribute">#[derive(Clone)]
</span><span class="kw">struct </span>Compiler&lt;<span class="lifetime">&#39;p</span>&gt; {
patterns: <span class="kw-2">&amp;</span><span class="lifetime">&#39;p </span>Patterns,
buckets: Vec&lt;Vec&lt;PatternID&gt;&gt;,
masks: Vec&lt;Mask&gt;,
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;p</span>&gt; Compiler&lt;<span class="lifetime">&#39;p</span>&gt; {
<span class="doccomment">/// Create a new Teddy compiler for the given patterns. If `fat` is true,
/// then 16 buckets will be used instead of 8.
///
/// This panics if any of the patterns given are empty.
</span><span class="kw">fn </span>new(patterns: <span class="kw-2">&amp;</span><span class="lifetime">&#39;p </span>Patterns, fat: bool) -&gt; Compiler&lt;<span class="lifetime">&#39;p</span>&gt; {
<span class="kw">let </span>mask_len = cmp::min(<span class="number">4</span>, patterns.minimum_len());
<span class="macro">assert!</span>(<span class="number">1 </span>&lt;= mask_len &amp;&amp; mask_len &lt;= <span class="number">4</span>);
Compiler {
patterns,
buckets: <span class="macro">vec!</span>[<span class="macro">vec!</span>[]; <span class="kw">if </span>fat { <span class="number">16 </span>} <span class="kw">else </span>{ <span class="number">8 </span>}],
masks: <span class="macro">vec!</span>[Mask::default(); mask_len],
}
}
<span class="doccomment">/// Compile the patterns in this compiler into buckets and masks.
</span><span class="kw">fn </span>compile(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<span class="kw">let </span><span class="kw-2">mut </span>lonibble_to_bucket: BTreeMap&lt;Vec&lt;u8&gt;, usize&gt; = BTreeMap::new();
<span class="kw">for </span>(id, pattern) <span class="kw">in </span><span class="self">self</span>.patterns.iter() {
<span class="comment">// We try to be slightly clever in how we assign patterns into
// buckets. Generally speaking, we want patterns with the same
// prefix to be in the same bucket, since it minimizes the amount
// of time we spend churning through buckets in the verification
// step.
//
// So we could assign patterns with the same N-prefix (where N
// is the size of the mask, which is one of {1, 2, 3}) to the
// same bucket. However, case insensitive searches are fairly
// common, so we&#39;d for example, ideally want to treat `abc` and
// `ABC` as if they shared the same prefix. ASCII has the nice
// property that the lower 4 bits of A and a are the same, so we
// therefore group patterns with the same low-nybbe-N-prefix into
// the same bucket.
//
// MOREOVER, this is actually necessary for correctness! In
// particular, by grouping patterns with the same prefix into the
// same bucket, we ensure that we preserve correct leftmost-first
// and leftmost-longest match semantics. In addition to the fact
// that `patterns.iter()` iterates in the correct order, this
// guarantees that all possible ambiguous matches will occur in
// the same bucket. The verification routine could be adjusted to
// support correct leftmost match semantics regardless of bucket
// allocation, but that results in a performance hit. It&#39;s much
// nicer to be able to just stop as soon as a match is found.
</span><span class="kw">let </span>lonybs = pattern.low_nybbles(<span class="self">self</span>.masks.len());
<span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">&amp;</span>bucket) = lonibble_to_bucket.get(<span class="kw-2">&amp;</span>lonybs) {
<span class="self">self</span>.buckets[bucket].push(id);
} <span class="kw">else </span>{
<span class="comment">// N.B. We assign buckets in reverse because it shouldn&#39;t have
// any influence on performance, but it does make it harder to
// get leftmost match semantics accidentally correct.
</span><span class="kw">let </span>bucket = (<span class="self">self</span>.buckets.len() - <span class="number">1</span>)
- (id <span class="kw">as </span>usize % <span class="self">self</span>.buckets.len());
<span class="self">self</span>.buckets[bucket].push(id);
lonibble_to_bucket.insert(lonybs, bucket);
}
}
<span class="kw">for </span>(bucket_index, bucket) <span class="kw">in </span><span class="self">self</span>.buckets.iter().enumerate() {
<span class="kw">for </span><span class="kw-2">&amp;</span>pat_id <span class="kw">in </span>bucket {
<span class="kw">let </span>pat = <span class="self">self</span>.patterns.get(pat_id);
<span class="kw">for </span>(i, mask) <span class="kw">in </span><span class="self">self</span>.masks.iter_mut().enumerate() {
<span class="kw">if </span><span class="self">self</span>.buckets.len() == <span class="number">8 </span>{
mask.add_slim(bucket_index <span class="kw">as </span>u8, pat.bytes()[i]);
} <span class="kw">else </span>{
mask.add_fat(bucket_index <span class="kw">as </span>u8, pat.bytes()[i]);
}
}
}
}
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;p</span>&gt; fmt::Debug <span class="kw">for </span>Compiler&lt;<span class="lifetime">&#39;p</span>&gt; {
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; fmt::Result {
<span class="kw">let </span><span class="kw-2">mut </span>buckets = <span class="macro">vec!</span>[<span class="macro">vec!</span>[]; <span class="self">self</span>.buckets.len()];
<span class="kw">for </span>(i, bucket) <span class="kw">in </span><span class="self">self</span>.buckets.iter().enumerate() {
<span class="kw">for </span><span class="kw-2">&amp;</span>patid <span class="kw">in </span>bucket {
buckets[i].push(<span class="self">self</span>.patterns.get(patid));
}
}
f.debug_struct(<span class="string">&quot;Compiler&quot;</span>)
.field(<span class="string">&quot;buckets&quot;</span>, <span class="kw-2">&amp;</span>buckets)
.field(<span class="string">&quot;masks&quot;</span>, <span class="kw-2">&amp;</span><span class="self">self</span>.masks)
.finish()
}
}
<span class="doccomment">/// Mask represents the low and high nybble masks that will be used during
/// search. Each mask is 32 bytes wide, although only the first 16 bytes are
/// used for the SSSE3 runtime.
///
/// Each byte in the mask corresponds to a 8-bit bitset, where bit `i` is set
/// if and only if the corresponding nybble is in the ith bucket. The index of
/// the byte (0-15, inclusive) corresponds to the nybble.
///
/// Each mask is used as the target of a shuffle, where the indices for the
/// shuffle are taken from the haystack. AND&#39;ing the shuffles for both the
/// low and high masks together also results in 8-bit bitsets, but where bit
/// `i` is set if and only if the correspond *byte* is in the ith bucket.
///
/// During compilation, masks are just arrays. But during search, these masks
/// are represented as 128-bit or 256-bit vectors.
///
/// (See the README is this directory for more details.)
</span><span class="attribute">#[derive(Clone, Copy, Default)]
</span><span class="kw">pub struct </span>Mask {
lo: [u8; <span class="number">32</span>],
hi: [u8; <span class="number">32</span>],
}
<span class="kw">impl </span>Mask {
<span class="doccomment">/// Update this mask by adding the given byte to the given bucket. The
/// given bucket must be in the range 0-7.
///
/// This is for &quot;slim&quot; Teddy, where there are only 8 buckets.
</span><span class="kw">fn </span>add_slim(<span class="kw-2">&amp;mut </span><span class="self">self</span>, bucket: u8, byte: u8) {
<span class="macro">assert!</span>(bucket &lt; <span class="number">8</span>);
<span class="kw">let </span>byte_lo = (byte &amp; <span class="number">0xF</span>) <span class="kw">as </span>usize;
<span class="kw">let </span>byte_hi = ((byte &gt;&gt; <span class="number">4</span>) &amp; <span class="number">0xF</span>) <span class="kw">as </span>usize;
<span class="comment">// When using 256-bit vectors, we need to set this bucket assignment in
// the low and high 128-bit portions of the mask. This allows us to
// process 32 bytes at a time. Namely, AVX2 shuffles operate on each
// of the 128-bit lanes, rather than the full 256-bit vector at once.
</span><span class="self">self</span>.lo[byte_lo] |= <span class="number">1 </span>&lt;&lt; bucket;
<span class="self">self</span>.lo[byte_lo + <span class="number">16</span>] |= <span class="number">1 </span>&lt;&lt; bucket;
<span class="self">self</span>.hi[byte_hi] |= <span class="number">1 </span>&lt;&lt; bucket;
<span class="self">self</span>.hi[byte_hi + <span class="number">16</span>] |= <span class="number">1 </span>&lt;&lt; bucket;
}
<span class="doccomment">/// Update this mask by adding the given byte to the given bucket. The
/// given bucket must be in the range 0-15.
///
/// This is for &quot;fat&quot; Teddy, where there are 16 buckets.
</span><span class="kw">fn </span>add_fat(<span class="kw-2">&amp;mut </span><span class="self">self</span>, bucket: u8, byte: u8) {
<span class="macro">assert!</span>(bucket &lt; <span class="number">16</span>);
<span class="kw">let </span>byte_lo = (byte &amp; <span class="number">0xF</span>) <span class="kw">as </span>usize;
<span class="kw">let </span>byte_hi = ((byte &gt;&gt; <span class="number">4</span>) &amp; <span class="number">0xF</span>) <span class="kw">as </span>usize;
<span class="comment">// Unlike slim teddy, fat teddy only works with AVX2. For fat teddy,
// the high 128 bits of our mask correspond to buckets 8-15, while the
// low 128 bits correspond to buckets 0-7.
</span><span class="kw">if </span>bucket &lt; <span class="number">8 </span>{
<span class="self">self</span>.lo[byte_lo] |= <span class="number">1 </span>&lt;&lt; bucket;
<span class="self">self</span>.hi[byte_hi] |= <span class="number">1 </span>&lt;&lt; bucket;
} <span class="kw">else </span>{
<span class="self">self</span>.lo[byte_lo + <span class="number">16</span>] |= <span class="number">1 </span>&lt;&lt; (bucket % <span class="number">8</span>);
<span class="self">self</span>.hi[byte_hi + <span class="number">16</span>] |= <span class="number">1 </span>&lt;&lt; (bucket % <span class="number">8</span>);
}
}
<span class="doccomment">/// Return the low 128 bits of the low-nybble mask.
</span><span class="kw">pub fn </span>lo128(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; [u8; <span class="number">16</span>] {
<span class="kw">let </span><span class="kw-2">mut </span>tmp = [<span class="number">0</span>; <span class="number">16</span>];
tmp.copy_from_slice(<span class="kw-2">&amp;</span><span class="self">self</span>.lo[..<span class="number">16</span>]);
tmp
}
<span class="doccomment">/// Return the full low-nybble mask.
</span><span class="kw">pub fn </span>lo256(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; [u8; <span class="number">32</span>] {
<span class="self">self</span>.lo
}
<span class="doccomment">/// Return the low 128 bits of the high-nybble mask.
</span><span class="kw">pub fn </span>hi128(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; [u8; <span class="number">16</span>] {
<span class="kw">let </span><span class="kw-2">mut </span>tmp = [<span class="number">0</span>; <span class="number">16</span>];
tmp.copy_from_slice(<span class="kw-2">&amp;</span><span class="self">self</span>.hi[..<span class="number">16</span>]);
tmp
}
<span class="doccomment">/// Return the full high-nybble mask.
</span><span class="kw">pub fn </span>hi256(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; [u8; <span class="number">32</span>] {
<span class="self">self</span>.hi
}
}
<span class="kw">impl </span>fmt::Debug <span class="kw">for </span>Mask {
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; fmt::Result {
<span class="kw">let </span>(<span class="kw-2">mut </span>parts_lo, <span class="kw-2">mut </span>parts_hi) = (<span class="macro">vec!</span>[], <span class="macro">vec!</span>[]);
<span class="kw">for </span>i <span class="kw">in </span><span class="number">0</span>..<span class="number">32 </span>{
parts_lo.push(<span class="macro">format!</span>(<span class="string">&quot;{:02}: {:08b}&quot;</span>, i, <span class="self">self</span>.lo[i]));
parts_hi.push(<span class="macro">format!</span>(<span class="string">&quot;{:02}: {:08b}&quot;</span>, i, <span class="self">self</span>.hi[i]));
}
f.debug_struct(<span class="string">&quot;Mask&quot;</span>)
.field(<span class="string">&quot;lo&quot;</span>, <span class="kw-2">&amp;</span>parts_lo)
.field(<span class="string">&quot;hi&quot;</span>, <span class="kw-2">&amp;</span>parts_hi)
.finish()
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../../../" data-current-crate="aho_corasick" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>