aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/juicebox_asm/insn.rs.html
blob: 029258c5f50463f0b55fdfcc684b37604929f0f9 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
<!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 `src/insn.rs`."><title>insn.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="juicebox_asm" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="../../static.files/src-script-39ed315d46fb705f.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"></nav><div class="sidebar-resizer"></div>
    <main><nav class="sub"><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><div data-nosnippet><pre class="src-line-numbers"><a href="#1" id="1">1</a>
<a href="#2" id="2">2</a>
<a href="#3" id="3">3</a>
<a href="#4" id="4">4</a>
<a href="#5" id="5">5</a>
<a href="#6" id="6">6</a>
<a href="#7" id="7">7</a>
<a href="#8" id="8">8</a>
<a href="#9" id="9">9</a>
<a href="#10" id="10">10</a>
<a href="#11" id="11">11</a>
<a href="#12" id="12">12</a>
<a href="#13" id="13">13</a>
<a href="#14" id="14">14</a>
<a href="#15" id="15">15</a>
<a href="#16" id="16">16</a>
<a href="#17" id="17">17</a>
<a href="#18" id="18">18</a>
<a href="#19" id="19">19</a>
<a href="#20" id="20">20</a>
<a href="#21" id="21">21</a>
<a href="#22" id="22">22</a>
<a href="#23" id="23">23</a>
<a href="#24" id="24">24</a>
<a href="#25" id="25">25</a>
<a href="#26" id="26">26</a>
<a href="#27" id="27">27</a>
<a href="#28" id="28">28</a>
<a href="#29" id="29">29</a>
<a href="#30" id="30">30</a>
<a href="#31" id="31">31</a>
<a href="#32" id="32">32</a>
<a href="#33" id="33">33</a>
<a href="#34" id="34">34</a>
<a href="#35" id="35">35</a>
<a href="#36" id="36">36</a>
<a href="#37" id="37">37</a>
<a href="#38" id="38">38</a>
<a href="#39" id="39">39</a>
<a href="#40" id="40">40</a>
<a href="#41" id="41">41</a>
<a href="#42" id="42">42</a>
<a href="#43" id="43">43</a>
<a href="#44" id="44">44</a>
<a href="#45" id="45">45</a>
<a href="#46" id="46">46</a>
<a href="#47" id="47">47</a>
<a href="#48" id="48">48</a>
<a href="#49" id="49">49</a>
<a href="#50" id="50">50</a>
<a href="#51" id="51">51</a>
<a href="#52" id="52">52</a>
<a href="#53" id="53">53</a>
<a href="#54" id="54">54</a>
<a href="#55" id="55">55</a>
<a href="#56" id="56">56</a>
<a href="#57" id="57">57</a>
<a href="#58" id="58">58</a>
<a href="#59" id="59">59</a>
<a href="#60" id="60">60</a>
<a href="#61" id="61">61</a>
<a href="#62" id="62">62</a>
<a href="#63" id="63">63</a>
<a href="#64" id="64">64</a>
<a href="#65" id="65">65</a>
<a href="#66" id="66">66</a>
<a href="#67" id="67">67</a>
<a href="#68" id="68">68</a>
<a href="#69" id="69">69</a>
<a href="#70" id="70">70</a>
<a href="#71" id="71">71</a>
<a href="#72" id="72">72</a>
<a href="#73" id="73">73</a>
<a href="#74" id="74">74</a>
<a href="#75" id="75">75</a>
<a href="#76" id="76">76</a>
<a href="#77" id="77">77</a>
<a href="#78" id="78">78</a>
<a href="#79" id="79">79</a>
<a href="#80" id="80">80</a>
<a href="#81" id="81">81</a>
<a href="#82" id="82">82</a>
<a href="#83" id="83">83</a>
<a href="#84" id="84">84</a>
<a href="#85" id="85">85</a>
<a href="#86" id="86">86</a>
<a href="#87" id="87">87</a>
<a href="#88" id="88">88</a>
<a href="#89" id="89">89</a>
<a href="#90" id="90">90</a>
<a href="#91" id="91">91</a>
<a href="#92" id="92">92</a>
<a href="#93" id="93">93</a>
<a href="#94" id="94">94</a>
<a href="#95" id="95">95</a>
<a href="#96" id="96">96</a>
<a href="#97" id="97">97</a>
<a href="#98" id="98">98</a>
<a href="#99" id="99">99</a>
<a href="#100" id="100">100</a>
<a href="#101" id="101">101</a>
<a href="#102" id="102">102</a>
<a href="#103" id="103">103</a>
</pre></div><pre class="rust"><code><span class="doccomment">//! Trait definitions of various instructions.

</span><span class="kw">mod </span>add;
<span class="kw">mod </span>call;
<span class="kw">mod </span>cmovnz;
<span class="kw">mod </span>cmovz;
<span class="kw">mod </span>cmp;
<span class="kw">mod </span>dec;
<span class="kw">mod </span>jmp;
<span class="kw">mod </span>jnz;
<span class="kw">mod </span>jz;
<span class="kw">mod </span>mov;
<span class="kw">mod </span>nop;
<span class="kw">mod </span>pop;
<span class="kw">mod </span>push;
<span class="kw">mod </span>ret;
<span class="kw">mod </span>test;

<span class="doccomment">/// Trait for [`add`](https://www.felixcloutier.com/x86/add) instruction kinds.
</span><span class="kw">pub trait </span>Add&lt;T, U&gt; {
    <span class="doccomment">/// Emit an add instruction.
    </span><span class="kw">fn </span>add(<span class="kw-2">&amp;mut </span><span class="self">self</span>, op1: T, op2: U);
}

<span class="doccomment">/// Trait for [`call`](https://www.felixcloutier.com/x86/call) instruction kinds.
</span><span class="kw">pub trait </span>Call&lt;T&gt; {
    <span class="doccomment">/// Emit a call instruction.
    </span><span class="kw">fn </span>call(<span class="kw-2">&amp;mut </span><span class="self">self</span>, op1: T);
}

<span class="kw">pub trait </span>Cmovnz&lt;T, U&gt; {
    <span class="doccomment">/// Emit a (conditional) move if not zero instruction.
    ///
    /// Move is only commited if (ZF=0).
    </span><span class="kw">fn </span>cmovnz(<span class="kw-2">&amp;mut </span><span class="self">self</span>, op1: T, op2: U);
}

<span class="kw">pub trait </span>Cmovz&lt;T, U&gt; {
    <span class="doccomment">/// Emit a (conditional) move if zero instruction.
    ///
    /// Move is only commited if (ZF=1).
    </span><span class="kw">fn </span>cmovz(<span class="kw-2">&amp;mut </span><span class="self">self</span>, op1: T, op2: U);
}

<span class="doccomment">/// Trait for [`cmp`](https://www.felixcloutier.com/x86/cmp) instruction kinds.
</span><span class="kw">pub trait </span>Cmp&lt;T, U&gt; {
    <span class="doccomment">/// Emit a compare instruction.
    ///
    /// Computes `op2 - op1` and sets the status flags in the same way as the `sub` instruction,
    /// the result is discarded.
    </span><span class="kw">fn </span>cmp(<span class="kw-2">&amp;mut </span><span class="self">self</span>, op1: T, op2: U);
}

<span class="doccomment">/// Trait for [`dec`](https://www.felixcloutier.com/x86/dec) instruction kinds.
</span><span class="kw">pub trait </span>Dec&lt;T&gt; {
    <span class="doccomment">/// Emit a decrement instruction.
    </span><span class="kw">fn </span>dec(<span class="kw-2">&amp;mut </span><span class="self">self</span>, op1: T);
}

<span class="doccomment">/// Trait for [`jmp`](https://www.felixcloutier.com/x86/jmp) instruction kinds.
</span><span class="kw">pub trait </span>Jmp&lt;T&gt; {
    <span class="doccomment">/// Emit an unconditional jump instruction.
    </span><span class="kw">fn </span>jmp(<span class="kw-2">&amp;mut </span><span class="self">self</span>, op1: T);
}

<span class="doccomment">/// Trait for [`jnz`](https://www.felixcloutier.com/x86/jcc) instruction kinds.
</span><span class="kw">pub trait </span>Jnz&lt;T&gt; {
    <span class="doccomment">/// Emit a conditional jump if not zero instruction (`ZF = 0`).
    </span><span class="kw">fn </span>jnz(<span class="kw-2">&amp;mut </span><span class="self">self</span>, op1: T);
}

<span class="doccomment">/// Trait for [`jz`](https://www.felixcloutier.com/x86/jcc) instruction kinds.
</span><span class="kw">pub trait </span>Jz&lt;T&gt; {
    <span class="doccomment">/// Emit a conditional jump if zero instruction (`ZF = 1`).
    </span><span class="kw">fn </span>jz(<span class="kw-2">&amp;mut </span><span class="self">self</span>, op1: T);
}

<span class="doccomment">/// Trait for [`mov`](https://www.felixcloutier.com/x86/mov) instruction kinds.
</span><span class="kw">pub trait </span>Mov&lt;T, U&gt; {
    <span class="doccomment">/// Emit an move instruction.
    </span><span class="kw">fn </span>mov(<span class="kw-2">&amp;mut </span><span class="self">self</span>, op1: T, op2: U);
}

<span class="doccomment">/// Trait for [`push`](https://www.felixcloutier.com/x86/push) instruction kinds.
</span><span class="kw">pub trait </span>Push&lt;T&gt; {
    <span class="doccomment">/// Emit a push instruction.
    </span><span class="kw">fn </span>push(<span class="kw-2">&amp;mut </span><span class="self">self</span>, op1: T);
}

<span class="doccomment">/// Trait for [`pop`](https://www.felixcloutier.com/x86/pop) instruction kinds.
</span><span class="kw">pub trait </span>Pop&lt;T&gt; {
    <span class="doccomment">/// Emit a pop instruction.
    </span><span class="kw">fn </span>pop(<span class="kw-2">&amp;mut </span><span class="self">self</span>, op1: T);
}

<span class="doccomment">/// Trait for [`test`](https://www.felixcloutier.com/x86/test) instruction kinds.
</span><span class="kw">pub trait </span>Test&lt;T, U&gt; {
    <span class="doccomment">/// Emit a logical compare instruction.
    ///
    /// Computes the bit-wise logical AND of first operand and the second operand and sets the
    /// `SF`, `ZF`, and `PF` status flags, the result is discarded.
    </span><span class="kw">fn </span>test(<span class="kw-2">&amp;mut </span><span class="self">self</span>, op1: T, op2: U);
}
</code></pre></div></section></main></body></html>