blob: 2ecd2bea9520174bbfe2978dfc8d0bbde113bf1f [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 to the Rust file `crates/std_detect/src/detect/arch/aarch64.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>aarch64.rs.html -- source</title><link rel="stylesheet" type="text/css" href="../../../../normalize.css"><link rel="stylesheet" type="text/css" href="../../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../../../dark.css"><link rel="stylesheet" type="text/css" href="../../../../light.css" id="themeStyle"><script src="../../../../storage.js"></script><noscript><link rel="stylesheet" href="../../../../noscript.css"></noscript><link rel="shortcut icon" href="../../../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../../../down-arrow.svg");}</style></head><body class="rustdoc source"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../../../../std_detect/index.html'><div class='logo-container'><img src='../../../../rust-logo.png' alt='logo'></div></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../../../../settings.html"><img src="../../../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><pre class="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>
</pre><div class="example-wrap"><pre class="rust ">
<span class="doccomment">//! Aarch64 run-time features.</span>
<span class="doccomment">/// Checks if `aarch64` feature is enabled.</span>
<span class="attribute">#[<span class="ident">macro_export</span>]</span>
<span class="attribute">#[<span class="ident">unstable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;stdsimd&quot;</span>, <span class="ident">issue</span> <span class="op">=</span> <span class="string">&quot;27731&quot;</span>)]</span>
<span class="attribute">#[<span class="ident">allow_internal_unstable</span>(<span class="ident">stdsimd_internal</span>,<span class="ident">stdsimd</span>)]</span>
<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">is_aarch64_feature_detected</span> {
(<span class="string">&quot;neon&quot;</span>) <span class="op">=&gt;</span> {
<span class="comment">// FIXME: this should be removed once we rename Aarch64 neon to asimd</span>
<span class="macro">cfg</span><span class="macro">!</span>(<span class="ident">target_feature</span> <span class="op">=</span> <span class="string">&quot;neon&quot;</span>) <span class="op">||</span>
<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">detect</span>::<span class="ident">check_for</span>(<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">detect</span>::<span class="ident">Feature</span>::<span class="ident">asimd</span>)
};
(<span class="string">&quot;asimd&quot;</span>) <span class="op">=&gt;</span> {
<span class="macro">cfg</span><span class="macro">!</span>(<span class="ident">target_feature</span> <span class="op">=</span> <span class="string">&quot;neon&quot;</span>) <span class="op">||</span>
<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">detect</span>::<span class="ident">check_for</span>(<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">detect</span>::<span class="ident">Feature</span>::<span class="ident">asimd</span>)
};
(<span class="string">&quot;pmull&quot;</span>) <span class="op">=&gt;</span> {
<span class="macro">cfg</span><span class="macro">!</span>(<span class="ident">target_feature</span> <span class="op">=</span> <span class="string">&quot;pmull&quot;</span>) <span class="op">||</span>
<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">detect</span>::<span class="ident">check_for</span>(<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">detect</span>::<span class="ident">Feature</span>::<span class="ident">pmull</span>)
};
(<span class="string">&quot;fp&quot;</span>) <span class="op">=&gt;</span> {
<span class="macro">cfg</span><span class="macro">!</span>(<span class="ident">target_feature</span> <span class="op">=</span> <span class="string">&quot;fp&quot;</span>) <span class="op">||</span>
<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">detect</span>::<span class="ident">check_for</span>(<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">detect</span>::<span class="ident">Feature</span>::<span class="ident">fp</span>)
};
(<span class="string">&quot;fp16&quot;</span>) <span class="op">=&gt;</span> {
<span class="macro">cfg</span><span class="macro">!</span>(<span class="ident">target_feature</span> <span class="op">=</span> <span class="string">&quot;fp16&quot;</span>) <span class="op">||</span>
<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">detect</span>::<span class="ident">check_for</span>(<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">detect</span>::<span class="ident">Feature</span>::<span class="ident">fp16</span>)
};
(<span class="string">&quot;sve&quot;</span>) <span class="op">=&gt;</span> {
<span class="macro">cfg</span><span class="macro">!</span>(<span class="ident">target_feature</span> <span class="op">=</span> <span class="string">&quot;sve&quot;</span>) <span class="op">||</span>
<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">detect</span>::<span class="ident">check_for</span>(<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">detect</span>::<span class="ident">Feature</span>::<span class="ident">sve</span>)
};
(<span class="string">&quot;crc&quot;</span>) <span class="op">=&gt;</span> {
<span class="macro">cfg</span><span class="macro">!</span>(<span class="ident">target_feature</span> <span class="op">=</span> <span class="string">&quot;crc&quot;</span>) <span class="op">||</span>
<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">detect</span>::<span class="ident">check_for</span>(<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">detect</span>::<span class="ident">Feature</span>::<span class="ident">crc</span>)
};
(<span class="string">&quot;crypto&quot;</span>) <span class="op">=&gt;</span> {
<span class="macro">cfg</span><span class="macro">!</span>(<span class="ident">target_feature</span> <span class="op">=</span> <span class="string">&quot;crypto&quot;</span>) <span class="op">||</span>
<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">detect</span>::<span class="ident">check_for</span>(<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">detect</span>::<span class="ident">Feature</span>::<span class="ident">crypto</span>)
};
(<span class="string">&quot;lse&quot;</span>) <span class="op">=&gt;</span> {
<span class="macro">cfg</span><span class="macro">!</span>(<span class="ident">target_feature</span> <span class="op">=</span> <span class="string">&quot;lse&quot;</span>) <span class="op">||</span>
<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">detect</span>::<span class="ident">check_for</span>(<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">detect</span>::<span class="ident">Feature</span>::<span class="ident">lse</span>)
};
(<span class="string">&quot;rdm&quot;</span>) <span class="op">=&gt;</span> {
<span class="macro">cfg</span><span class="macro">!</span>(<span class="ident">target_feature</span> <span class="op">=</span> <span class="string">&quot;rdm&quot;</span>) <span class="op">||</span>
<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">detect</span>::<span class="ident">check_for</span>(<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">detect</span>::<span class="ident">Feature</span>::<span class="ident">rdm</span>)
};
(<span class="string">&quot;rcpc&quot;</span>) <span class="op">=&gt;</span> {
<span class="macro">cfg</span><span class="macro">!</span>(<span class="ident">target_feature</span> <span class="op">=</span> <span class="string">&quot;rcpc&quot;</span>) <span class="op">||</span>
<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">detect</span>::<span class="ident">check_for</span>(<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">detect</span>::<span class="ident">Feature</span>::<span class="ident">rcpc</span>)
};
(<span class="string">&quot;dotprod&quot;</span>) <span class="op">=&gt;</span> {
<span class="macro">cfg</span><span class="macro">!</span>(<span class="ident">target_feature</span> <span class="op">=</span> <span class="string">&quot;dotprod&quot;</span>) <span class="op">||</span>
<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">detect</span>::<span class="ident">check_for</span>(<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">detect</span>::<span class="ident">Feature</span>::<span class="ident">dotprod</span>)
};
(<span class="string">&quot;ras&quot;</span>) <span class="op">=&gt;</span> {
<span class="macro">compile_error</span><span class="macro">!</span>(<span class="string">&quot;\&quot;ras\&quot; feature cannot be detected at run-time&quot;</span>)
};
(<span class="string">&quot;v8.1a&quot;</span>) <span class="op">=&gt;</span> {
<span class="macro">compile_error</span><span class="macro">!</span>(<span class="string">&quot;\&quot;v8.1a\&quot; feature cannot be detected at run-time&quot;</span>)
};
(<span class="string">&quot;v8.2a&quot;</span>) <span class="op">=&gt;</span> {
<span class="macro">compile_error</span><span class="macro">!</span>(<span class="string">&quot;\&quot;v8.2a\&quot; feature cannot be detected at run-time&quot;</span>)
};
(<span class="string">&quot;v8.3a&quot;</span>) <span class="op">=&gt;</span> {
<span class="macro">compile_error</span><span class="macro">!</span>(<span class="string">&quot;\&quot;v8.3a\&quot; feature cannot be detected at run-time&quot;</span>)
};
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">t</span>:<span class="ident">tt</span>,) <span class="op">=&gt;</span> {
<span class="macro">is_aarch64_feature_detected</span><span class="macro">!</span>(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">t</span>);
};
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">t</span>:<span class="ident">tt</span>) <span class="op">=&gt;</span> { <span class="macro">compile_error</span><span class="macro">!</span>(<span class="macro">concat</span><span class="macro">!</span>(<span class="string">&quot;unknown aarch64 target feature: &quot;</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">t</span>)) };
}
<span class="doccomment">/// ARM Aarch64 CPU Feature enum. Each variant denotes a position in a bitset</span>
<span class="doccomment">/// for a particular feature.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// PLEASE: do not use this, it is an implementation detail subject to change.</span>
<span class="attribute">#[<span class="ident">doc</span>(<span class="ident">hidden</span>)]</span>
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">non_camel_case_types</span>)]</span>
<span class="attribute">#[<span class="ident">repr</span>(<span class="ident">u8</span>)]</span>
<span class="attribute">#[<span class="ident">unstable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;stdsimd_internal&quot;</span>, <span class="ident">issue</span> <span class="op">=</span> <span class="string">&quot;0&quot;</span>)]</span>
<span class="kw">pub</span> <span class="kw">enum</span> <span class="ident">Feature</span> {
<span class="doccomment">/// ARM Advanced SIMD (ASIMD)</span>
<span class="ident">asimd</span>,
<span class="doccomment">/// Polynomial Multiply</span>
<span class="ident">pmull</span>,
<span class="doccomment">/// Floating point support</span>
<span class="ident">fp</span>,
<span class="doccomment">/// Half-float support.</span>
<span class="ident">fp16</span>,
<span class="doccomment">/// Scalable Vector Extension (SVE)</span>
<span class="ident">sve</span>,
<span class="doccomment">/// CRC32 (Cyclic Redundancy Check)</span>
<span class="ident">crc</span>,
<span class="doccomment">/// Crypto: AES + PMULL + SHA1 + SHA2</span>
<span class="ident">crypto</span>,
<span class="doccomment">/// Atomics (Large System Extension)</span>
<span class="ident">lse</span>,
<span class="doccomment">/// Rounding Double Multiply (ASIMDRDM)</span>
<span class="ident">rdm</span>,
<span class="doccomment">/// Release consistent Processor consistent (RcPc)</span>
<span class="ident">rcpc</span>,
<span class="doccomment">/// Vector Dot-Product (ASIMDDP)</span>
<span class="ident">dotprod</span>,
}
</pre></div>
</section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd></kbd></dt><dd>Move up in search results</dd><dt><kbd></kbd></dt><dd>Move down in search results</dd><dt><kbd></kbd></dt><dd>Switch tab</dd><dt><kbd>&#9166;</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../../../";window.currentCrate = "std_detect";</script><script src="../../../../aliases.js"></script><script src="../../../../main.js"></script><script src="../../../../source-script.js"></script><script src="../../../../source-files.js"></script><script defer src="../../../../search-index.js"></script></body></html>