blob: fc55e0580a4ae1eaba21281ae6428b3e7ca8a5ce (
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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
|
<!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/x86_64.rs`."><title>x86_64.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/SourceSerif4-Bold-a2c9cd1067f8b328.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-cb6f1f67f1bcd037.css" id="mainThemeStyle"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="kvm_rs" data-themes="" data-resource-suffix="" data-rustdoc-version="1.73.0 (cc66ad468 2023-10-03)" data-channel="1.73.0" data-search-js="search-6dfdfced5eff6596.js" data-settings-js="settings-de11bff964e9d4e5.js" data-settings-css="settings-8c76f75bfb6bd192.css" data-theme-light-css="light-1596385f77d47ef2.css" data-theme-dark-css="dark-0a43001d3fc2282c.css" data-theme-ayu-css="ayu-fd19013d6ce078bf.css" ><script src="../../static.files/storage-db41da1a38ea3cb8.js"></script><script defer src="../../static.files/src-script-3280b574d94e47b4.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-0795b7d26be81095.js"></script><noscript><link rel="stylesheet" media="(prefers-color-scheme:light)" href="../../static.files/light-1596385f77d47ef2.css"><link rel="stylesheet" media="(prefers-color-scheme:dark)" href="../../static.files/dark-0a43001d3fc2282c.css"><link rel="stylesheet" href="../../static.files/noscript-cffde32267a19fd6.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><main><nav class="sub"><a class="sub-logo-container" href="../../kvm_rs/index.html"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><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" 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="../../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>
<a href="#104" id="104">104</a>
<a href="#105" id="105">105</a>
<a href="#106" id="106">106</a>
<a href="#107" id="107">107</a>
<a href="#108" id="108">108</a>
<a href="#109" id="109">109</a>
<a href="#110" id="110">110</a>
<a href="#111" id="111">111</a>
<a href="#112" id="112">112</a>
<a href="#113" id="113">113</a>
<a href="#114" id="114">114</a>
<a href="#115" id="115">115</a>
<a href="#116" id="116">116</a>
<a href="#117" id="117">117</a>
<a href="#118" id="118">118</a>
<a href="#119" id="119">119</a>
<a href="#120" id="120">120</a>
<a href="#121" id="121">121</a>
<a href="#122" id="122">122</a>
<a href="#123" id="123">123</a>
<a href="#124" id="124">124</a>
<a href="#125" id="125">125</a>
<a href="#126" id="126">126</a>
<a href="#127" id="127">127</a>
<a href="#128" id="128">128</a>
<a href="#129" id="129">129</a>
<a href="#130" id="130">130</a>
<a href="#131" id="131">131</a>
<a href="#132" id="132">132</a>
<a href="#133" id="133">133</a>
<a href="#134" id="134">134</a>
<a href="#135" id="135">135</a>
<a href="#136" id="136">136</a>
<a href="#137" id="137">137</a>
<a href="#138" id="138">138</a>
<a href="#139" id="139">139</a>
<a href="#140" id="140">140</a>
<a href="#141" id="141">141</a>
<a href="#142" id="142">142</a>
<a href="#143" id="143">143</a>
<a href="#144" id="144">144</a>
<a href="#145" id="145">145</a>
<a href="#146" id="146">146</a>
<a href="#147" id="147">147</a>
<a href="#148" id="148">148</a>
<a href="#149" id="149">149</a>
<a href="#150" id="150">150</a>
<a href="#151" id="151">151</a>
<a href="#152" id="152">152</a>
<a href="#153" id="153">153</a>
<a href="#154" id="154">154</a>
<a href="#155" id="155">155</a>
<a href="#156" id="156">156</a>
<a href="#157" id="157">157</a>
<a href="#158" id="158">158</a>
<a href="#159" id="159">159</a>
<a href="#160" id="160">160</a>
<a href="#161" id="161">161</a>
<a href="#162" id="162">162</a>
</pre></div><pre class="rust"><code><span class="doccomment">//! `x86_64` flags and bitfields.
</span><span class="kw">pub use </span>x86_64::<span class="kw-2">*</span>;
<span class="attr">#[rustfmt::skip]
</span><span class="kw">mod </span>x86_64 {
<span class="comment">/* Rflags Register */
</span><span class="doccomment">/// Carry flag.
</span><span class="kw">pub const </span>RFLAGS_CF: u64 = <span class="number">1 </span><< <span class="number">0</span>;
<span class="doccomment">/// Parity flag.
</span><span class="kw">pub const </span>RFLAGS_PF: u64 = <span class="number">1 </span><< <span class="number">2</span>;
<span class="doccomment">/// Adjust flag.
</span><span class="kw">pub const </span>RFLAGS_AF: u64 = <span class="number">1 </span><< <span class="number">4</span>;
<span class="doccomment">/// Zero flag.
</span><span class="kw">pub const </span>RFLAGS_ZF: u64 = <span class="number">1 </span><< <span class="number">6</span>;
<span class="doccomment">/// Sign flag.
</span><span class="kw">pub const </span>RFLAGS_SF: u64 = <span class="number">1 </span><< <span class="number">7</span>;
<span class="doccomment">/// Trap flag.
</span><span class="kw">pub const </span>RFLAGS_TF: u64 = <span class="number">1 </span><< <span class="number">8</span>;
<span class="doccomment">/// Sign flag.
</span><span class="kw">pub const </span>RFLAGS_IF: u64 = <span class="number">1 </span><< <span class="number">9</span>;
<span class="doccomment">/// Direction flag.
</span><span class="kw">pub const </span>RFLAGS_DF: u64 = <span class="number">1 </span><< <span class="number">10</span>;
<span class="doccomment">/// Overflow flag.
</span><span class="kw">pub const </span>RFLAGS_OF: u64 = <span class="number">1 </span><< <span class="number">11</span>;
<span class="doccomment">/// I/O privilege level.
</span><span class="kw">pub const </span>RFLAGS_IOPL: u64 = <span class="number">0b11 </span><< <span class="number">12</span>;
<span class="doccomment">/// Alignment check.
</span><span class="kw">pub const </span>RFLAGS_AC: u64 = <span class="number">1 </span><< <span class="number">18</span>;
<span class="kw">pub const fn </span>rflags_cf(r: u64) -> u64 { (r & RFLAGS_CF) >> <span class="number">0 </span>}
<span class="kw">pub const fn </span>rflags_pf(r: u64) -> u64 { (r & RFLAGS_PF) >> <span class="number">2 </span>}
<span class="kw">pub const fn </span>rflags_af(r: u64) -> u64 { (r & RFLAGS_AF) >> <span class="number">4 </span>}
<span class="kw">pub const fn </span>rflags_zf(r: u64) -> u64 { (r & RFLAGS_ZF) >> <span class="number">6 </span>}
<span class="kw">pub const fn </span>rflags_sf(r: u64) -> u64 { (r & RFLAGS_SF) >> <span class="number">7 </span>}
<span class="kw">pub const fn </span>rflags_tf(r: u64) -> u64 { (r & RFLAGS_TF) >> <span class="number">8 </span>}
<span class="kw">pub const fn </span>rflags_if(r: u64) -> u64 { (r & RFLAGS_IF) >> <span class="number">9 </span>}
<span class="kw">pub const fn </span>rflags_df(r: u64) -> u64 { (r & RFLAGS_DF) >> <span class="number">10 </span>}
<span class="kw">pub const fn </span>rflags_of(r: u64) -> u64 { (r & RFLAGS_OF) >> <span class="number">11 </span>}
<span class="kw">pub const fn </span>rflags_iopl(r: u64) -> u64 { (r & RFLAGS_IOPL) >> <span class="number">12 </span>}
<span class="kw">pub const fn </span>rflags_ac(r: u64) -> u64 { (r & RFLAGS_AC) >> <span class="number">18 </span>}
<span class="comment">/* Segment Selector */
</span><span class="doccomment">/// Requested privilege level.
///
/// Privilege level of the segment selector, where `0` is the most privileged mode and `3` the
/// least.
</span><span class="kw">pub const </span>SEG_SELECTOR_RPL: u16 = <span class="number">0b11 </span><< <span class="number">0</span>;
<span class="doccomment">/// Table indicator.
///
/// | TI | Table |
/// |----|-------|
/// | 0 | GDT |
/// | 1 | LDT |
</span><span class="kw">pub const </span>SEG_SELECTOR_TI: u16 = <span class="number">1 </span><< <span class="number">2</span>;
<span class="doccomment">/// Table index.
///
/// Index into the `GDT` or `LDT` table to select the segment descriptor. `GDT.base + 8 * index`
/// gives the address of the segment descriptor (times `8` because every segment descriptor is `8
/// byte`).
</span><span class="kw">pub const </span>SEG_SELECTOR_INDEX: u16 = <span class="number">0x1fff </span><< <span class="number">3</span>;
<span class="kw">pub const fn </span>seg_selector_rpl(s: u16) -> u16 { (s & SEG_SELECTOR_RPL) >> <span class="number">0 </span>}
<span class="kw">pub const fn </span>seg_selector_ti(s: u16) -> u16 { (s & SEG_SELECTOR_TI) >> <span class="number">2 </span>}
<span class="kw">pub const fn </span>seg_selector_index(s: u16) -> u16 { (s & SEG_SELECTOR_INDEX) >> <span class="number">3 </span>}
<span class="comment">/* Control Register CR0 (operation mode & state of the processor) */
</span><span class="doccomment">/// Protection Enable.
///
/// Enables `protected mode` when set and `real-address mode` when cleared. This enables
/// `segment-level protection` not paging.
</span><span class="kw">pub const </span>CR0_PE: u64 = <span class="number">1 </span><< <span class="number">0</span>;
<span class="doccomment">/// Monitor Coprocessor.
</span><span class="kw">pub const </span>CR0_MP: u64 = <span class="number">1 </span><< <span class="number">1</span>;
<span class="doccomment">/// Emulation.
///
/// When set indicates the process does not have a FPU. FPU instructions will generate an exception
/// that software can emulate the instruction.
</span><span class="kw">pub const </span>CR0_EM: u64 = <span class="number">1 </span><< <span class="number">2</span>;
<span class="doccomment">/// Task Switched.
</span><span class="kw">pub const </span>CR0_TS: u64 = <span class="number">1 </span><< <span class="number">3</span>;
<span class="doccomment">/// Extension Type.
</span><span class="kw">pub const </span>CR0_ET: u64 = <span class="number">1 </span><< <span class="number">4</span>;
<span class="doccomment">/// Numeric Error.
</span><span class="kw">pub const </span>CR0_NE: u64 = <span class="number">1 </span><< <span class="number">5</span>;
<span class="doccomment">/// Write Protect.
///
/// When set supervisor-level procedures can't write to read-only pages.
</span><span class="kw">pub const </span>CR0_WP: u64 = <span class="number">1 </span><< <span class="number">16</span>;
<span class="doccomment">/// Alignment Mask.
///
/// Enables alignment check for `CPL=3`, check is only done if the [AC
/// bit](crate::x86_64::RFLAGS_AC) of the `rflags` register ist set.
</span><span class="kw">pub const </span>CR0_AM: u64 = <span class="number">1 </span><< <span class="number">18</span>;
<span class="doccomment">/// Not Write-Torugh.
</span><span class="kw">pub const </span>CR0_NW: u64 = <span class="number">1 </span><< <span class="number">29</span>;
<span class="doccomment">/// Cachine disable.
</span><span class="kw">pub const </span>CR0_CD: u64 = <span class="number">1 </span><< <span class="number">30</span>;
<span class="doccomment">/// Paging.
///
/// Enables paging when set, requires [CR0_PE](crate::x86_64::CR0_PE) to be set as well.
</span><span class="kw">pub const </span>CR0_PG: u64 = <span class="number">1 </span><< <span class="number">31</span>;
<span class="comment">/* Control Register CR3 (paging information)
*
* Holds the physical base address of the first paging structure. The 12 lower bytes of the base
* address are assumed to be 0 and hence the first paging structure must be aligned to a 4K
* boundary.
*/
</span><span class="doccomment">/// Mask for physical base address of paging structure.
</span><span class="kw">pub const </span>CR3_PAGE_BASE_MASK: u64 = <span class="number">0xffff_ffff_ffff_0000</span>;
<span class="doccomment">/// Page-level Write-Through.
</span><span class="kw">pub const </span>CR3_PWT: u64 = <span class="number">1 </span><< <span class="number">3</span>;
<span class="doccomment">/// Page-level Cache Disable.
</span><span class="kw">pub const </span>CR3_PCD: u64 = <span class="number">1 </span><< <span class="number">4</span>;
<span class="comment">/* Control Register CR4 (flags for arch extenstions processor capabilities) */
</span><span class="doccomment">/// Physical Address Extenstion.
///
/// When set enables paging to produce physicall addresses with more than 32 bits. Required before
/// entering `long mode`.
</span><span class="kw">pub const </span>CR4_PAE: u64 = <span class="number">1 </span><< <span class="number">5</span>;
<span class="doccomment">/// 57-bit Linear Addresses.
///
/// When set in `long mode` enables `5-level` paging to translate `57-bit` linear addresses. When
/// cleared use `4-level` paging to translate `48-bit` linear addresses.
</span><span class="kw">pub const </span>CR4_LA57: u64 = <span class="number">1 </span><< <span class="number">5</span>;
<span class="comment">/* Extended Feature Enable Register (EFER) */
</span><span class="doccomment">/// Extended Feature Enable Register MSR number.
///
/// MSR number used with the [`rdmsr`][msr] and [`wrmsr`][msr] instructions to read/write the
/// `EFER` model specific register.
///
/// [msr]: https://johannst.github.io/notes/arch/x86_64.html#model-specific-register-msr
</span><span class="kw">pub const </span>MSR_EFER: u64 = <span class="number">0xc000_0080</span>;
<span class="doccomment">/// Long Mode Enable.
///
/// When set enables long mode operations.
</span><span class="kw">pub const </span>EFER_LME: u64 = <span class="number">1 </span><< <span class="number">8</span>;
<span class="doccomment">/// Long Mode Active (readonly).
///
/// When set indicates long mode is active.
</span><span class="kw">pub const </span>EFER_LMA: u64 = <span class="number">1 </span><< <span class="number">10</span>;
<span class="comment">/* Paging */
</span><span class="doccomment">/// Page entry present.
</span><span class="kw">pub const </span>PAGE_ENTRY_PRESENT: u64 = <span class="number">1 </span><< <span class="number">0</span>;
<span class="doccomment">/// Page region read/write.
///
/// If set, region reference by paging entry is writeable.
</span><span class="kw">pub const </span>PAGE_ENTRY_RW: u64 = <span class="number">1 </span><< <span class="number">1</span>;
}
</code></pre></div></section></main></body></html>
|
