diff options
| author | pravic <[email protected]> | 2016-04-12 18:12:52 +0300 |
|---|---|---|
| committer | pravic <[email protected]> | 2016-04-12 18:12:52 +0300 |
| commit | 24af17846d14b290aa1d90e37e98c4cbe9e173e1 (patch) | |
| tree | d68362060a430c72f19a46ec382f070cf0cbefe5 /doc/src | |
| parent | add index (diff) | |
| download | winapi-kmd-rs-24af17846d14b290aa1d90e37e98c4cbe9e173e1.tar.xz winapi-kmd-rs-24af17846d14b290aa1d90e37e98c4cbe9e173e1.zip | |
add winapi-km-rs docs
Diffstat (limited to 'doc/src')
| -rw-r--r-- | doc/src/km/basedef.rs.html | 290 | ||||
| -rw-r--r-- | doc/src/km/crt.rs.html | 280 | ||||
| -rw-r--r-- | doc/src/km/debug.rs.html | 200 | ||||
| -rw-r--r-- | doc/src/km/device_object.rs.html | 306 | ||||
| -rw-r--r-- | doc/src/km/dpc.rs.html | 190 | ||||
| -rw-r--r-- | doc/src/km/driver_object.rs.html | 176 | ||||
| -rw-r--r-- | doc/src/km/event.rs.html | 170 | ||||
| -rw-r--r-- | doc/src/km/file_object.rs.html | 138 | ||||
| -rw-r--r-- | doc/src/km/irp.rs.html | 476 | ||||
| -rw-r--r-- | doc/src/km/irql.rs.html | 230 | ||||
| -rw-r--r-- | doc/src/km/lang.rs.html | 122 | ||||
| -rw-r--r-- | doc/src/km/lib.rs.html | 218 | ||||
| -rw-r--r-- | doc/src/km/macros.rs.html | 176 | ||||
| -rw-r--r-- | doc/src/km/object.rs.html | 196 | ||||
| -rw-r--r-- | doc/src/km/pool.rs.html | 192 | ||||
| -rw-r--r-- | doc/src/km/rtl.rs.html | 130 | ||||
| -rw-r--r-- | doc/src/km/status.rs.html | 226 | ||||
| -rw-r--r-- | doc/src/km/string.rs.html | 298 | ||||
| -rw-r--r-- | doc/src/km/time.rs.html | 160 |
19 files changed, 4174 insertions, 0 deletions
diff --git a/doc/src/km/basedef.rs.html b/doc/src/km/basedef.rs.html new file mode 100644 index 0000000..4f2a670 --- /dev/null +++ b/doc/src/km/basedef.rs.html @@ -0,0 +1,290 @@ +<!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 `basedef.rs`."> + <meta name="keywords" content="rust, rustlang, rust-lang"> + + <title>basedef.rs.html -- source</title> + + <link rel="stylesheet" type="text/css" href="../../rustdoc.css"> + <link rel="stylesheet" type="text/css" href="../../main.css"> + + + + +</head> +<body class="rustdoc"> + <!--[if lte IE 8]> + <div class="warning"> + This old browser is unsupported and will most likely display funky + things. + </div> + <![endif]--> + + + + <nav class="sidebar"> + + + </nav> + + <nav class="sub"> + <form class="search-form js-only"> + <div class="search-container"> + <input class="search-input" name="search" + autocomplete="off" + placeholder="Click or press ‘S’ to search, ‘?’ for more options…" + type="search"> + </div> + </form> + </nav> + + <section id='main' class="content source"><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> +</pre><pre class='rust '> +<span class='doccomment'>//! Kernel-Mode Types.</span> + +<span class='kw'>use</span> ::<span class='ident'>KIRQL</span>; + + +<span class='comment'>// Use repr(u8) as LLVM expects `void*` to be the same as `i8*` to help enable</span> +<span class='comment'>// more optimization opportunities around it recognizing things like</span> +<span class='comment'>// malloc/free.</span> +<span class='attribute'>#[<span class='ident'>repr</span>(<span class='ident'>u8</span>)]</span> +<span class='attribute'>#[<span class='ident'>doc</span>(<span class='ident'>hidden</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>enum</span> <span class='ident'>km_void</span> { + <span class='comment'>// Two dummy variants so the #[repr] attribute can be used.</span> + <span class='attribute'>#[<span class='ident'>doc</span>(<span class='ident'>hidden</span>)]</span> + <span class='ident'>__variant1</span>, + <span class='attribute'>#[<span class='ident'>doc</span>(<span class='ident'>hidden</span>)]</span> + <span class='ident'>__variant2</span>, +} + +<span class='kw'>pub</span> <span class='kw'>type</span> <span class='ident'>VOID</span> <span class='op'>=</span> <span class='ident'>km_void</span>; +<span class='kw'>pub</span> <span class='kw'>type</span> <span class='ident'>PVOID</span> <span class='op'>=</span> <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>VOID</span>; +<span class='kw'>pub</span> <span class='kw'>type</span> <span class='ident'>PCVOID</span> <span class='op'>=</span> <span class='op'>*</span><span class='kw'>const</span> <span class='ident'>VOID</span>; + + +<span class='kw'>pub</span> <span class='kw'>type</span> <span class='ident'>PETHREAD</span> <span class='op'>=</span> <span class='ident'>PVOID</span>; +<span class='kw'>pub</span> <span class='kw'>type</span> <span class='ident'>PIO_APC_ROUTINE</span> <span class='op'>=</span> <span class='prelude-ty'>Option</span><span class='op'><</span><span class='kw'>extern</span> <span class='string'>"system"</span> <span class='kw'>fn</span> (<span class='ident'>ApcContext</span>: <span class='ident'>PCVOID</span>, <span class='ident'>IoStatusBlock</span>: <span class='op'>*</span><span class='kw'>const</span> <span class='ident'>IO_STATUS_BLOCK</span>, <span class='ident'>Reserved</span>: <span class='ident'>u32</span>)<span class='op'>></span>; + + +<span class='kw'>extern</span> <span class='string'>"system"</span> +{ + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>KeGetCurrentIrql</span>() <span class='op'>-></span> <span class='ident'>KIRQL</span>; + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>KeRaiseIrqlToDpcLevel</span>() <span class='op'>-></span> <span class='ident'>KIRQL</span>; + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>KfLowerIrql</span>(<span class='ident'>NewIrql</span>: <span class='ident'>KIRQL</span>) <span class='op'>-></span> <span class='ident'>KIRQL</span>; + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>KfRaiseIrql</span>(<span class='ident'>NewIrql</span>: <span class='ident'>KIRQL</span>) <span class='op'>-></span> <span class='ident'>KIRQL</span>; +} + + +<span class='doccomment'>/// Doubly linked list structure.</span> +<span class='attribute'>#[<span class='ident'>repr</span>(<span class='ident'>C</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>struct</span> <span class='ident'>LIST_ENTRY</span> +{ + <span class='kw'>pub</span> <span class='ident'>next</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>LIST_ENTRY</span>, + <span class='kw'>pub</span> <span class='ident'>prev</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>LIST_ENTRY</span>, +} + +<span class='doccomment'>/// Spin Lock.</span> +<span class='attribute'>#[<span class='ident'>repr</span>(<span class='ident'>C</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>struct</span> <span class='ident'>KSPIN_LOCK</span> +{ + <span class='kw'>pub</span> <span class='ident'>lock</span>: <span class='ident'>usize</span>, +} + +<span class='doccomment'>/// Common dispatcher object header.</span> +<span class='attribute'>#[<span class='ident'>repr</span>(<span class='ident'>C</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>struct</span> <span class='ident'>DISPATCHER_HEADER</span> +{ + <span class='kw'>pub</span> <span class='ident'>Type</span>: <span class='ident'>u8</span>, + <span class='kw'>pub</span> <span class='ident'>Absolute</span>: <span class='ident'>u8</span>, + <span class='kw'>pub</span> <span class='ident'>Size</span>: <span class='ident'>u8</span>, + <span class='kw'>pub</span> <span class='ident'>Inserted</span>: <span class='ident'>u8</span>, + <span class='kw'>pub</span> <span class='ident'>SignalState</span>: <span class='ident'>i32</span>, + <span class='kw'>pub</span> <span class='ident'>WaitListHead</span>: <span class='ident'>LIST_ENTRY</span>, +} + +<span class='doccomment'>/// An I/O status block.</span> +<span class='attribute'>#[<span class='ident'>repr</span>(<span class='ident'>C</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>struct</span> <span class='ident'>IO_STATUS_BLOCK</span> +{ + <span class='kw'>pub</span> <span class='ident'>Status</span>: ::<span class='ident'>NTSTATUS</span>, + <span class='kw'>pub</span> <span class='ident'>Information</span>: <span class='ident'>usize</span>, +} + +<span class='kw'>pub</span> <span class='kw'>type</span> <span class='ident'>PIO_STATUS_BLOCK</span> <span class='op'>=</span> <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>IO_STATUS_BLOCK</span>; + + +<span class='doccomment'>/// Processor modes.</span> +<span class='attribute'>#[<span class='ident'>repr</span>(<span class='ident'>C</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>enum</span> <span class='ident'>KPROCESSOR_MODE</span> +{ + <span class='ident'>KernelMode</span>, + <span class='ident'>UserMode</span>, +} + +<span class='doccomment'>/// I/O Request priority.</span> +<span class='kw'>pub</span> <span class='kw'>mod</span> <span class='ident'>IO_PRIORITY</span> { + <span class='doccomment'>/// I/O Request priority type.</span> + <span class='kw'>pub</span> <span class='kw'>type</span> <span class='ident'>KPRIORITY_BOOST</span> <span class='op'>=</span> <span class='ident'>u8</span>; + + <span class='kw'>pub</span> <span class='kw'>const</span> <span class='ident'>IO_NO_INCREMENT</span>: <span class='ident'>KPRIORITY_BOOST</span> <span class='op'>=</span> <span class='number'>0</span>; + <span class='kw'>pub</span> <span class='kw'>const</span> <span class='ident'>IO_DISK_INCREMENT</span>: <span class='ident'>KPRIORITY_BOOST</span> <span class='op'>=</span> <span class='number'>1</span>; + <span class='kw'>pub</span> <span class='kw'>const</span> <span class='ident'>EVENT_INCREMENT</span>: <span class='ident'>KPRIORITY_BOOST</span> <span class='op'>=</span> <span class='number'>1</span>; +} +</pre> +</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>?</dt> + <dd>Show this help dialog</dd> + <dt>S</dt> + <dd>Focus the search field</dd> + <dt>⇤</dt> + <dd>Move up in search results</dd> + <dt>⇥</dt> + <dd>Move down in search results</dd> + <dt>⏎</dt> + <dd>Go to active search result</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> + </div> + </div> + </aside> + + + + <script> + window.rootPath = "../../"; + window.currentCrate = "km"; + window.playgroundUrl = ""; + </script> + <script src="../../jquery.js"></script> + <script src="../../main.js"></script> + + <script defer src="../../search-index.js"></script> +</body> +</html>
\ No newline at end of file diff --git a/doc/src/km/crt.rs.html b/doc/src/km/crt.rs.html new file mode 100644 index 0000000..c86885e --- /dev/null +++ b/doc/src/km/crt.rs.html @@ -0,0 +1,280 @@ +<!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 `crt.rs`."> + <meta name="keywords" content="rust, rustlang, rust-lang"> + + <title>crt.rs.html -- source</title> + + <link rel="stylesheet" type="text/css" href="../../rustdoc.css"> + <link rel="stylesheet" type="text/css" href="../../main.css"> + + + + +</head> +<body class="rustdoc"> + <!--[if lte IE 8]> + <div class="warning"> + This old browser is unsupported and will most likely display funky + things. + </div> + <![endif]--> + + + + <nav class="sidebar"> + + + </nav> + + <nav class="sub"> + <form class="search-form js-only"> + <div class="search-container"> + <input class="search-input" name="search" + autocomplete="off" + placeholder="Click or press ‘S’ to search, ‘?’ for more options…" + type="search"> + </div> + </form> + </nav> + + <section id='main' class="content source"><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> +</pre><pre class='rust '> +<span class='doccomment'>//! C runtime library.</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! Functions imported from `ntoskrnl.exe`.</span> + +<span class='kw'>extern</span> <span class='string'>"C"</span> +{ + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>memcmp</span>(<span class='ident'>s1</span>: <span class='op'>*</span><span class='kw'>const</span> <span class='ident'>u8</span>, <span class='ident'>s2</span>: <span class='op'>*</span><span class='kw'>const</span> <span class='ident'>u8</span>, <span class='ident'>n</span>: <span class='ident'>usize</span>) <span class='op'>-></span> <span class='ident'>i32</span>; + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>memcpy</span>(<span class='ident'>dest</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>u8</span>, <span class='ident'>src</span>: <span class='op'>*</span><span class='kw'>const</span> <span class='ident'>u8</span>, <span class='ident'>n</span>: <span class='ident'>usize</span>) <span class='op'>-></span> <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>u8</span>; + + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>strlen</span>(<span class='ident'>s</span>: <span class='op'>*</span><span class='kw'>const</span> <span class='ident'>u8</span>) <span class='op'>-></span> <span class='ident'>usize</span>; + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>strcmp</span>(<span class='ident'>s1</span>: <span class='op'>*</span><span class='kw'>const</span> <span class='ident'>u8</span>, <span class='ident'>s2</span>: <span class='op'>*</span><span class='kw'>const</span> <span class='ident'>u8</span>) <span class='op'>-></span> <span class='ident'>i32</span>; + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>strcpy</span>(<span class='ident'>dest</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>u8</span>, <span class='ident'>src</span>: <span class='op'>*</span><span class='kw'>const</span> <span class='ident'>u8</span>) <span class='op'>-></span> <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>u8</span>; + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>strcat</span>(<span class='ident'>dest</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>u8</span>, <span class='ident'>src</span>: <span class='op'>*</span><span class='kw'>const</span> <span class='ident'>u8</span>) <span class='op'>-></span> <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>u8</span>; + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>strncpy</span>(<span class='ident'>dest</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>u8</span>, <span class='ident'>src</span>: <span class='op'>*</span><span class='kw'>const</span> <span class='ident'>u8</span>, <span class='ident'>n</span>: <span class='ident'>usize</span>) <span class='op'>-></span> <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>u8</span>; + + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>wcslen</span>(<span class='ident'>s</span>: <span class='op'>*</span><span class='kw'>const</span> <span class='ident'>u16</span>) <span class='op'>-></span> <span class='ident'>usize</span>; + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>wcscpy</span>(<span class='ident'>dest</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>u16</span>, <span class='ident'>src</span>: <span class='op'>*</span><span class='kw'>const</span> <span class='ident'>u16</span>) <span class='op'>-></span> <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>u16</span>; + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>wcsncpy</span>(<span class='ident'>dest</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>u16</span>, <span class='ident'>src</span>: <span class='op'>*</span><span class='kw'>const</span> <span class='ident'>u16</span>, <span class='ident'>n</span>: <span class='ident'>usize</span>) <span class='op'>-></span> <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>u16</span>; +} + + +<span class='attribute'>#[<span class='ident'>no_mangle</span>]</span> +<span class='attribute'>#[<span class='ident'>allow</span>(<span class='ident'>non_upper_case_globals</span>)]</span> +<span class='attribute'>#[<span class='ident'>cfg</span>(<span class='ident'>target_arch</span><span class='op'>=</span><span class='string'>"x86"</span>)]</span> +<span class='attribute'>#[<span class='ident'>doc</span>(<span class='ident'>hidden</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>static</span> <span class='ident'>__security_cookie</span>: <span class='ident'>usize</span> <span class='op'>=</span> <span class='number'>0xBB40E64E</span>; + +<span class='attribute'>#[<span class='ident'>no_mangle</span>]</span> +<span class='attribute'>#[<span class='ident'>allow</span>(<span class='ident'>non_upper_case_globals</span>)]</span> +<span class='attribute'>#[<span class='ident'>cfg</span>(<span class='ident'>target_arch</span><span class='op'>=</span><span class='string'>"x86_64"</span>)]</span> +<span class='attribute'>#[<span class='ident'>doc</span>(<span class='ident'>hidden</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>static</span> <span class='ident'>__security_cookie</span>: <span class='ident'>usize</span> <span class='op'>=</span> <span class='number'>0x00002B992DDFA232</span>; + + +<span class='attribute'>#[<span class='ident'>doc</span>(<span class='ident'>hidden</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>mod</span> <span class='ident'>rust_intrinsics</span> +{ + <span class='comment'>// Idk why, but linker cannot find `_memcmp` for llvm intrinsics. So lets make forward one.</span> + <span class='attribute'>#[<span class='ident'>no_mangle</span>]</span> + <span class='kw'>pub</span> <span class='kw'>unsafe</span> <span class='kw'>extern</span> <span class='kw'>fn</span> <span class='ident'>memcmp</span>(<span class='ident'>s1</span>: <span class='op'>*</span><span class='kw'>const</span> <span class='ident'>u8</span>, <span class='ident'>s2</span>: <span class='op'>*</span><span class='kw'>const</span> <span class='ident'>u8</span>, <span class='ident'>n</span>: <span class='ident'>usize</span>) <span class='op'>-></span> <span class='ident'>i32</span> { + <span class='kw'>return</span> ::<span class='ident'>crt</span>::<span class='ident'>memcmp</span>(<span class='ident'>s1</span>, <span class='ident'>s2</span>, <span class='ident'>n</span>); + } + + <span class='comment'>// ported from compiler-rt</span> + <span class='attribute'>#[<span class='ident'>no_mangle</span>]</span> + <span class='kw'>pub</span> <span class='kw'>unsafe</span> <span class='kw'>extern</span> <span class='kw'>fn</span> <span class='ident'>__mulodi4</span>(<span class='ident'>a</span>: <span class='ident'>i64</span>, <span class='ident'>b</span>: <span class='ident'>i64</span>, <span class='ident'>overflow</span>: <span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>i32</span>) <span class='op'>-></span> <span class='ident'>i64</span> { + <span class='kw'>const</span> <span class='ident'>N</span>: <span class='ident'>i32</span> <span class='op'>=</span> <span class='number'>64</span>; + <span class='kw'>const</span> <span class='ident'>MIN</span>: <span class='ident'>i64</span> <span class='op'>=</span> <span class='number'>1</span> <span class='op'><<</span> (<span class='ident'>N</span><span class='op'>-</span><span class='number'>1</span>); + <span class='kw'>const</span> <span class='ident'>MAX</span>: <span class='ident'>i64</span> <span class='op'>=</span> <span class='op'>!</span><span class='ident'>MIN</span>; + <span class='op'>*</span><span class='ident'>overflow</span> <span class='op'>=</span> <span class='number'>0</span>; + + <span class='kw'>let</span> <span class='ident'>result</span> <span class='op'>=</span> <span class='ident'>a</span> <span class='op'>*</span> <span class='ident'>b</span>; + <span class='kw'>if</span> <span class='ident'>a</span> <span class='op'>==</span> <span class='ident'>MIN</span> { + <span class='kw'>if</span> <span class='ident'>b</span> <span class='op'>!=</span> <span class='number'>0</span> <span class='op'>&&</span> <span class='ident'>b</span> <span class='op'>!=</span> <span class='number'>1</span> { + <span class='op'>*</span><span class='ident'>overflow</span> <span class='op'>=</span> <span class='number'>1</span>; + } + <span class='kw'>return</span> <span class='ident'>result</span>; + } + + <span class='kw'>if</span> <span class='ident'>b</span> <span class='op'>==</span> <span class='ident'>MIN</span> { + <span class='kw'>if</span> <span class='ident'>a</span> <span class='op'>!=</span> <span class='number'>0</span> <span class='op'>&&</span> <span class='ident'>a</span> <span class='op'>!=</span> <span class='number'>1</span> { + <span class='op'>*</span><span class='ident'>overflow</span> <span class='op'>=</span> <span class='number'>1</span>; + } + <span class='kw'>return</span> <span class='ident'>result</span>; + } + + <span class='kw'>let</span> <span class='ident'>sa</span> <span class='op'>=</span> <span class='ident'>a</span> <span class='op'>>></span> (<span class='ident'>N</span><span class='op'>-</span><span class='number'>1</span>); + <span class='kw'>let</span> <span class='ident'>sb</span> <span class='op'>=</span> <span class='ident'>b</span> <span class='op'>>></span> (<span class='ident'>N</span><span class='op'>-</span><span class='number'>1</span>); + <span class='kw'>let</span> <span class='ident'>abs_a</span> <span class='op'>=</span> (<span class='ident'>a</span> <span class='op'>^</span> <span class='ident'>sa</span>) <span class='op'>-</span> <span class='ident'>sa</span>; + <span class='kw'>let</span> <span class='ident'>abs_b</span> <span class='op'>=</span> (<span class='ident'>b</span> <span class='op'>^</span> <span class='ident'>sb</span>) <span class='op'>-</span> <span class='ident'>sb</span>; + + <span class='kw'>if</span> <span class='ident'>abs_a</span> <span class='op'><</span> <span class='number'>2</span> <span class='op'>||</span> <span class='ident'>abs_b</span> <span class='op'><</span> <span class='number'>2</span> { + <span class='kw'>return</span> <span class='ident'>result</span>; + } + <span class='kw'>if</span> <span class='ident'>sa</span> <span class='op'>==</span> <span class='ident'>sb</span> { + <span class='kw'>if</span> <span class='ident'>abs_a</span> <span class='op'>></span> <span class='ident'>MAX</span> <span class='op'>/</span> <span class='ident'>abs_b</span> { + <span class='op'>*</span><span class='ident'>overflow</span> <span class='op'>=</span> <span class='number'>1</span>; + } + } <span class='kw'>else</span> { + <span class='kw'>if</span> <span class='ident'>abs_a</span> <span class='op'>></span> <span class='ident'>MIN</span> <span class='op'>/</span> <span class='op'>-</span><span class='ident'>abs_b</span> { + <span class='op'>*</span><span class='ident'>overflow</span> <span class='op'>=</span> <span class='number'>1</span>; + } + } + <span class='kw'>return</span> <span class='ident'>result</span>; + } +} +</pre> +</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>?</dt> + <dd>Show this help dialog</dd> + <dt>S</dt> + <dd>Focus the search field</dd> + <dt>⇤</dt> + <dd>Move up in search results</dd> + <dt>⇥</dt> + <dd>Move down in search results</dd> + <dt>⏎</dt> + <dd>Go to active search result</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> + </div> + </div> + </aside> + + + + <script> + window.rootPath = "../../"; + window.currentCrate = "km"; + window.playgroundUrl = ""; + </script> + <script src="../../jquery.js"></script> + <script src="../../main.js"></script> + + <script defer src="../../search-index.js"></script> +</body> +</html>
\ No newline at end of file diff --git a/doc/src/km/debug.rs.html b/doc/src/km/debug.rs.html new file mode 100644 index 0000000..48cfa5b --- /dev/null +++ b/doc/src/km/debug.rs.html @@ -0,0 +1,200 @@ +<!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 `debug.rs`."> + <meta name="keywords" content="rust, rustlang, rust-lang"> + + <title>debug.rs.html -- source</title> + + <link rel="stylesheet" type="text/css" href="../../rustdoc.css"> + <link rel="stylesheet" type="text/css" href="../../main.css"> + + + + +</head> +<body class="rustdoc"> + <!--[if lte IE 8]> + <div class="warning"> + This old browser is unsupported and will most likely display funky + things. + </div> + <![endif]--> + + + + <nav class="sidebar"> + + + </nav> + + <nav class="sub"> + <form class="search-form js-only"> + <div class="search-container"> + <input class="search-input" name="search" + autocomplete="off" + placeholder="Click or press ‘S’ to search, ‘?’ for more options…" + type="search"> + </div> + </form> + </nav> + + <section id='main' class="content source"><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> +</pre><pre class='rust '> +<span class='doccomment'>//! Debugger support.</span> + +<span class='kw'>use</span> ::<span class='ident'>status</span>::<span class='ident'>NTSTATUS</span>; + +<span class='kw'>extern</span> <span class='string'>"C"</span> +{ + <span class='doccomment'>/// `DbgPrint` routine sends a message to the kernel debugger.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>DbgPrint</span>(<span class='ident'>Format</span>: <span class='op'>*</span><span class='kw'>const</span> <span class='ident'>u8</span>, ...) <span class='op'>-></span> <span class='ident'>NTSTATUS</span>; + <span class='doccomment'>/// The `DbgPrintEx` routine sends a string to the kernel debugger if certain conditions are met.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>DbgPrintEx</span>(<span class='ident'>ComponentId</span>: <span class='ident'>u32</span>, <span class='ident'>Level</span>: <span class='ident'>u32</span>, <span class='ident'>Format</span>: <span class='op'>*</span><span class='kw'>const</span> <span class='ident'>u8</span>, ...) <span class='op'>-></span> <span class='ident'>NTSTATUS</span>; +} + +<span class='kw'>extern</span> <span class='string'>"system"</span> +{ + <span class='doccomment'>/// Breaks into the kernel debugger.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>DbgBreakPoint</span>(); + <span class='doccomment'>/// Breaks into the kernel debugger and sends the value of `Status` to the debugger.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>DbgBreakPointWithStatus</span>(<span class='ident'>Status</span>: <span class='ident'>NTSTATUS</span>); +} + +<span class='doccomment'>/// `DbgPrintEx` Message severity.</span> +<span class='attribute'>#[<span class='ident'>repr</span>(<span class='ident'>C</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>enum</span> <span class='ident'>DPFLTR_LEVEL</span> { + <span class='ident'>ERROR</span> <span class='op'>=</span> <span class='number'>0</span>, + <span class='ident'>WARNING</span>, + <span class='ident'>TRACE</span>, + <span class='ident'>INFO</span>, +} + +<span class='doccomment'>/// `DbgPrintEx` Component name.</span> +<span class='attribute'>#[<span class='ident'>repr</span>(<span class='ident'>C</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>enum</span> <span class='ident'>DPFLTR_ID</span> { + <span class='ident'>SYSTEM</span> <span class='op'>=</span> <span class='number'>0</span>, + <span class='ident'>SMSS</span>, + <span class='ident'>SETUP</span>, + <span class='ident'>NTFS</span>, + <span class='comment'>// ...</span> + <span class='ident'>IHVDRIVER</span> <span class='op'>=</span> <span class='number'>77</span>, + <span class='ident'>IHVVIDEO</span>, + <span class='ident'>IHVAUDIO</span>, + <span class='ident'>IHVNETWORK</span>, + <span class='ident'>IHVSTREAMING</span>, + <span class='ident'>IHVBUS</span>, + + <span class='ident'>DEFAULT</span> <span class='op'>=</span> <span class='number'>99</span>, +} +</pre> +</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>?</dt> + <dd>Show this help dialog</dd> + <dt>S</dt> + <dd>Focus the search field</dd> + <dt>⇤</dt> + <dd>Move up in search results</dd> + <dt>⇥</dt> + <dd>Move down in search results</dd> + <dt>⏎</dt> + <dd>Go to active search result</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> + </div> + </div> + </aside> + + + + <script> + window.rootPath = "../../"; + window.currentCrate = "km"; + window.playgroundUrl = ""; + </script> + <script src="../../jquery.js"></script> + <script src="../../main.js"></script> + + <script defer src="../../search-index.js"></script> +</body> +</html>
\ No newline at end of file diff --git a/doc/src/km/device_object.rs.html b/doc/src/km/device_object.rs.html new file mode 100644 index 0000000..4d46be6 --- /dev/null +++ b/doc/src/km/device_object.rs.html @@ -0,0 +1,306 @@ +<!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 `device_object.rs`."> + <meta name="keywords" content="rust, rustlang, rust-lang"> + + <title>device_object.rs.html -- source</title> + + <link rel="stylesheet" type="text/css" href="../../rustdoc.css"> + <link rel="stylesheet" type="text/css" href="../../main.css"> + + + + +</head> +<body class="rustdoc"> + <!--[if lte IE 8]> + <div class="warning"> + This old browser is unsupported and will most likely display funky + things. + </div> + <![endif]--> + + + + <nav class="sidebar"> + + + </nav> + + <nav class="sub"> + <form class="search-form js-only"> + <div class="search-container"> + <input class="search-input" name="search" + autocomplete="off" + placeholder="Click or press ‘S’ to search, ‘?’ for more options…" + type="search"> + </div> + </form> + </nav> + + <section id='main' class="content source"><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> +</pre><pre class='rust '> +<span class='doccomment'>//! Device Object.</span> + +<span class='kw'>use</span> ::{<span class='ident'>NTSTATUS</span>, <span class='ident'>UNICODE_STRING</span>}; +<span class='kw'>use</span> ::<span class='ident'>driver_object</span>::<span class='ident'>DRIVER_OBJECT</span>; +<span class='kw'>use</span> ::<span class='ident'>irp</span>::{<span class='ident'>IRP</span>, <span class='ident'>PIRP</span>}; +<span class='kw'>use</span> ::<span class='ident'>dpc</span>::<span class='ident'>KDPC</span>; +<span class='kw'>use</span> ::<span class='ident'>event</span>::<span class='ident'>KEVENT</span>; +<span class='kw'>use</span> ::<span class='ident'>object</span>::<span class='op'>*</span>; +<span class='kw'>use</span> ::<span class='ident'>PVOID</span>; + +<span class='kw'>extern</span> <span class='string'>"system"</span> +{ + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>IoCreateDevice</span>(<span class='ident'>DriverObject</span>: <span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>DRIVER_OBJECT</span>, <span class='ident'>DeviceExtensionSize</span>: <span class='ident'>u32</span>, <span class='ident'>DeviceName</span>: <span class='op'>*</span><span class='kw'>const</span> <span class='ident'>UNICODE_STRING</span>, + <span class='ident'>DeviceType</span>: <span class='ident'>u32</span>, <span class='ident'>DeviceCharacteristics</span>: <span class='ident'>u32</span>, <span class='ident'>Exclusive</span>: <span class='ident'>bool</span>, <span class='ident'>DeviceObject</span>: <span class='op'>*</span><span class='kw-2'>mut</span><span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>DEVICE_OBJECT</span>) <span class='op'>-></span> <span class='ident'>NTSTATUS</span>; + + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>IoDeleteDevice</span>(<span class='ident'>DeviceObject</span>: <span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>DEVICE_OBJECT</span>) <span class='op'>-></span> <span class='ident'>NTSTATUS</span>; + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>IoCreateSymbolicLink</span>(<span class='ident'>SymbolicLinkName</span>: <span class='kw-2'>&</span><span class='ident'>UNICODE_STRING</span>, <span class='ident'>DeviceName</span>: <span class='kw-2'>&</span><span class='ident'>UNICODE_STRING</span>) <span class='op'>-></span> <span class='ident'>NTSTATUS</span>; + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>IoDeleteSymbolicLink</span>(<span class='ident'>SymbolicLinkName</span>: <span class='kw-2'>&</span><span class='ident'>UNICODE_STRING</span>) <span class='op'>-></span> <span class='ident'>NTSTATUS</span>; +} + +<span class='doccomment'>/// Device object flags.</span> +<span class='attribute'>#[<span class='ident'>repr</span>(<span class='ident'>C</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>enum</span> <span class='ident'>DEVICE_FLAGS</span> { + <span class='ident'>NONE</span> <span class='op'>=</span> <span class='number'>0</span>, + <span class='ident'>DO_VERIFY_VOLUME</span> <span class='op'>=</span> <span class='number'>0x00000002</span>, + <span class='ident'>DO_BUFFERED_IO</span> <span class='op'>=</span> <span class='number'>0x00000004</span>, + <span class='ident'>DO_EXCLUSIVE</span> <span class='op'>=</span> <span class='number'>0x00000008</span>, + <span class='ident'>DO_DIRECT_IO</span> <span class='op'>=</span> <span class='number'>0x00000010</span>, + <span class='ident'>DO_MAP_IO_BUFFER</span> <span class='op'>=</span> <span class='number'>0x00000020</span>, + <span class='ident'>DO_DEVICE_HAS_NAME</span> <span class='op'>=</span> <span class='number'>0x00000040</span>, + <span class='ident'>DO_DEVICE_INITIALIZING</span> <span class='op'>=</span> <span class='number'>0x00000080</span>, + <span class='ident'>DO_SYSTEM_BOOT_PARTITION</span> <span class='op'>=</span> <span class='number'>0x00000100</span>, + <span class='ident'>DO_LONG_TERM_REQUESTS</span> <span class='op'>=</span> <span class='number'>0x00000200</span>, + <span class='ident'>DO_NEVER_LAST_DEVICE</span> <span class='op'>=</span> <span class='number'>0x00000400</span>, + <span class='ident'>DO_SHUTDOWN_REGISTERED</span> <span class='op'>=</span> <span class='number'>0x00000800</span>, + <span class='ident'>DO_BUS_ENUMERATED_DEVICE</span> <span class='op'>=</span> <span class='number'>0x00001000</span>, + <span class='ident'>DO_POWER_PAGABLE</span> <span class='op'>=</span> <span class='number'>0x00002000</span>, + <span class='ident'>DO_POWER_INRUSH</span> <span class='op'>=</span> <span class='number'>0x00004000</span>, + <span class='ident'>DO_POWER_NOOP</span> <span class='op'>=</span> <span class='number'>0x00008000</span>, + <span class='ident'>DO_LOW_PRIORITY_FILESYSTEM</span> <span class='op'>=</span> <span class='number'>0x00010000</span>, + <span class='ident'>DO_XIP</span> <span class='op'>=</span> <span class='number'>0x00020000</span> +} + +<span class='doccomment'>/// The `DEVICE_OBJECT` structure is used by the operating system to represent a device object.</span> +<span class='attribute'>#[<span class='ident'>repr</span>(<span class='ident'>C</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>struct</span> <span class='ident'>DEVICE_OBJECT</span> +{ + <span class='kw'>pub</span> <span class='ident'>Type</span>: <span class='ident'>u16</span>, + <span class='kw'>pub</span> <span class='ident'>Size</span>: <span class='ident'>u16</span>, + <span class='kw'>pub</span> <span class='ident'>ReferenceCount</span>: <span class='ident'>i32</span>, + <span class='kw'>pub</span> <span class='ident'>DriverObject</span>: <span class='op'>*</span><span class='kw'>const</span> <span class='ident'>DRIVER_OBJECT</span>, + <span class='kw'>pub</span> <span class='ident'>NextDevice</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>DEVICE_OBJECT</span>, + <span class='kw'>pub</span> <span class='ident'>AttachedDevice</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>DEVICE_OBJECT</span>, + <span class='kw'>pub</span> <span class='ident'>CurrentIrp</span>: <span class='op'>*</span><span class='kw'>const</span> <span class='ident'>IRP</span>, + <span class='kw'>pub</span> <span class='ident'>Timer</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>u8</span>, + <span class='kw'>pub</span> <span class='ident'>Flags</span>: <span class='ident'>u32</span>, + <span class='kw'>pub</span> <span class='ident'>Characteristics</span>: <span class='ident'>u32</span>, + <span class='kw'>pub</span> <span class='ident'>Vpb</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>u8</span>, + <span class='kw'>pub</span> <span class='ident'>DeviceExtension</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>u8</span>, + <span class='kw'>pub</span> <span class='ident'>DeviceType</span>: <span class='ident'>u32</span>, + <span class='kw'>pub</span> <span class='ident'>StackSize</span>: <span class='ident'>u8</span>, + <span class='kw'>pub</span> <span class='ident'>Queue</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>WAIT_CONTEXT_BLOCK</span>, + <span class='kw'>pub</span> <span class='ident'>AlignmentRequirement</span>: <span class='ident'>u32</span>, + <span class='kw'>pub</span> <span class='ident'>DeviceQueue</span>: <span class='ident'>KDEVICE_QUEUE</span>, + <span class='kw'>pub</span> <span class='ident'>Dpc</span>: <span class='ident'>KDPC</span>, + <span class='kw'>pub</span> <span class='ident'>ActiveThreadCount</span>: <span class='ident'>u32</span>, + <span class='kw'>pub</span> <span class='ident'>SecurityDescriptor</span>: <span class='op'>*</span><span class='kw'>const</span> <span class='ident'>u8</span>, + <span class='kw'>pub</span> <span class='ident'>DeviceLock</span>: <span class='ident'>KEVENT</span>, + <span class='kw'>pub</span> <span class='ident'>SectorSize</span>: <span class='ident'>u16</span>, + <span class='kw'>pub</span> <span class='ident'>Spare1</span>: <span class='ident'>u16</span>, + <span class='kw'>pub</span> <span class='ident'>DeviceObjectExtension</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>DEVOBJ_EXTENSION</span>, + <span class='kw'>pub</span> <span class='ident'>Reserved</span>: <span class='op'>*</span><span class='kw'>const</span> <span class='ident'>u8</span>, +} + +<span class='doccomment'>/// Device object extension structure.</span> +<span class='attribute'>#[<span class='ident'>repr</span>(<span class='ident'>C</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>struct</span> <span class='ident'>DEVOBJ_EXTENSION</span> +{ + <span class='ident'>Type</span>: <span class='ident'>u16</span>, + <span class='ident'>Size</span>: <span class='ident'>u16</span>, + <span class='ident'>DeviceObject</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>DEVICE_OBJECT</span>, + <span class='ident'>PowerFlags</span>: <span class='ident'>u32</span>, + <span class='ident'>Dope</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>u8</span>, + <span class='ident'>ExtensionFlags</span>: <span class='ident'>u32</span>, + <span class='ident'>DeviceNode</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>u8</span>, + <span class='ident'>AttachedTo</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>DEVICE_OBJECT</span>, + <span class='ident'>StartIoCount</span>: <span class='ident'>i32</span>, + <span class='ident'>StartIoKey</span>: <span class='ident'>i32</span>, + <span class='ident'>StartIoFlags</span>: <span class='ident'>u32</span>, + <span class='ident'>Vpb</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>u8</span>, +} + +<span class='kw'>pub</span> <span class='kw'>type</span> <span class='ident'>PDEVICE_OBJECT</span> <span class='op'>=</span> <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>DEVICE_OBJECT</span>; + +<span class='kw'>pub</span> <span class='kw'>type</span> <span class='ident'>PDRIVER_CANCEL</span> <span class='op'>=</span> <span class='prelude-ty'>Option</span><span class='op'><</span><span class='kw'>extern</span> <span class='string'>"system"</span> <span class='kw'>fn</span> (<span class='ident'>DeviceObject</span>: <span class='ident'>PDEVICE_OBJECT</span>, <span class='ident'>Irp</span>: <span class='ident'>PIRP</span>)<span class='op'>></span>; + +<span class='kw'>pub</span> <span class='kw'>type</span> <span class='ident'>PDRIVER_DISPATCH</span> <span class='op'>=</span> <span class='prelude-ty'>Option</span><span class='op'><</span><span class='kw'>extern</span> <span class='string'>"system"</span> <span class='kw'>fn</span> (<span class='ident'>DeviceObject</span>: <span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>DEVICE_OBJECT</span>, <span class='ident'>Irp</span>: <span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>IRP</span>) <span class='op'>-></span> <span class='ident'>NTSTATUS</span><span class='op'>></span>; + +<span class='kw'>pub</span> <span class='kw'>type</span> <span class='ident'>PIO_COMPLETION_ROUTINE</span> <span class='op'>=</span> <span class='prelude-ty'>Option</span><span class='op'><</span><span class='kw'>extern</span> <span class='string'>"system"</span> <span class='kw'>fn</span> (<span class='ident'>DeviceObject</span>: <span class='ident'>PDEVICE_OBJECT</span>, <span class='ident'>Irp</span>: <span class='ident'>PIRP</span>, <span class='ident'>Context</span>: <span class='ident'>PVOID</span>) <span class='op'>-></span> <span class='ident'>NTSTATUS</span><span class='op'>></span>; +</pre> +</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>?</dt> + <dd>Show this help dialog</dd> + <dt>S</dt> + <dd>Focus the search field</dd> + <dt>⇤</dt> + <dd>Move up in search results</dd> + <dt>⇥</dt> + <dd>Move down in search results</dd> + <dt>⏎</dt> + <dd>Go to active search result</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> + </div> + </div> + </aside> + + + + <script> + window.rootPath = "../../"; + window.currentCrate = "km"; + window.playgroundUrl = ""; + </script> + <script src="../../jquery.js"></script> + <script src="../../main.js"></script> + + <script defer src="../../search-index.js"></script> +</body> +</html>
\ No newline at end of file diff --git a/doc/src/km/dpc.rs.html b/doc/src/km/dpc.rs.html new file mode 100644 index 0000000..0b59d75 --- /dev/null +++ b/doc/src/km/dpc.rs.html @@ -0,0 +1,190 @@ +<!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 `dpc.rs`."> + <meta name="keywords" content="rust, rustlang, rust-lang"> + + <title>dpc.rs.html -- source</title> + + <link rel="stylesheet" type="text/css" href="../../rustdoc.css"> + <link rel="stylesheet" type="text/css" href="../../main.css"> + + + + +</head> +<body class="rustdoc"> + <!--[if lte IE 8]> + <div class="warning"> + This old browser is unsupported and will most likely display funky + things. + </div> + <![endif]--> + + + + <nav class="sidebar"> + + + </nav> + + <nav class="sub"> + <form class="search-form js-only"> + <div class="search-container"> + <input class="search-input" name="search" + autocomplete="off" + placeholder="Click or press ‘S’ to search, ‘?’ for more options…" + type="search"> + </div> + </form> + </nav> + + <section id='main' class="content source"><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> +</pre><pre class='rust '> +<span class='doccomment'>//! Deferred Procedure Calls (DPC).</span> + +<span class='kw'>use</span> ::<span class='ident'>basedef</span>::<span class='op'>*</span>; + +<span class='kw'>extern</span> <span class='string'>"system"</span> +{ + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>KeInitializeDpc</span>(<span class='ident'>Dpc</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>KDPC</span>, <span class='ident'>DeferredRoutine</span>: <span class='ident'>PDEFERRED_ROUTINE</span>, <span class='ident'>DeferredContext</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>u8</span>); + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>KeInsertQueueDpc</span>(<span class='ident'>Dpc</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>KDPC</span>, <span class='ident'>SystemArgument1</span>: <span class='op'>*</span><span class='kw'>const</span> <span class='ident'>u8</span>, <span class='ident'>SystemArgument2</span>: <span class='op'>*</span><span class='kw'>const</span> <span class='ident'>u8</span>) <span class='op'>-></span> <span class='ident'>bool</span>; + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>KeRemoveQueueDpc</span>(<span class='ident'>Dpc</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>KDPC</span>) <span class='op'>-></span> <span class='ident'>bool</span>; + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>KeFlushQueuedDpcs</span>(); + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>KeGenericCallDpc</span>(<span class='ident'>DeferredRoutine</span>: <span class='ident'>PDEFERRED_ROUTINE</span>, <span class='ident'>DeferredContext</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>u8</span>); +} + +<span class='kw'>pub</span> <span class='kw'>type</span> <span class='ident'>PDEFERRED_ROUTINE</span> <span class='op'>=</span> <span class='kw'>extern</span> <span class='string'>"system"</span> <span class='kw'>fn</span> (<span class='ident'>Dpc</span>: <span class='op'>*</span><span class='kw'>const</span> <span class='ident'>KDPC</span>, <span class='ident'>DeferredContext</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>u8</span>, <span class='ident'>SystemArgument1</span>: <span class='op'>*</span><span class='kw'>const</span> <span class='ident'>u8</span>, <span class='ident'>SystemArgument2</span>: <span class='op'>*</span><span class='kw'>const</span> <span class='ident'>u8</span>); + +<span class='doccomment'>/// Deferred Procedure Call object.</span> +<span class='attribute'>#[<span class='ident'>repr</span>(<span class='ident'>C</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>struct</span> <span class='ident'>KDPC</span> +{ + <span class='ident'>Type</span>: <span class='ident'>u8</span>, + <span class='ident'>Number</span>: <span class='ident'>u8</span>, + <span class='ident'>Importance</span>: <span class='ident'>u8</span>, + + <span class='ident'>DpcListEntry</span>: <span class='ident'>LIST_ENTRY</span>, + <span class='ident'>DeferredRoutine</span>: <span class='ident'>PDEFERRED_ROUTINE</span>, + <span class='ident'>DeferredContext</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>u8</span>, + <span class='ident'>SystemArgument1</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>u8</span>, + <span class='ident'>SystemArgument2</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>u8</span>, + + <span class='ident'>DpcData</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>KDPC_DATA</span>, +} + +<span class='doccomment'>/// DPC data structure definition.</span> +<span class='attribute'>#[<span class='ident'>repr</span>(<span class='ident'>C</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>struct</span> <span class='ident'>KDPC_DATA</span> +{ + <span class='ident'>DpcListHead</span>: <span class='ident'>LIST_ENTRY</span>, + <span class='ident'>DpcLock</span>: <span class='ident'>KSPIN_LOCK</span>, + <span class='ident'>DpcQueueDepth</span>: <span class='ident'>i32</span>, + <span class='ident'>DpcCount</span>: <span class='ident'>u32</span>, +} +</pre> +</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>?</dt> + <dd>Show this help dialog</dd> + <dt>S</dt> + <dd>Focus the search field</dd> + <dt>⇤</dt> + <dd>Move up in search results</dd> + <dt>⇥</dt> + <dd>Move down in search results</dd> + <dt>⏎</dt> + <dd>Go to active search result</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> + </div> + </div> + </aside> + + + + <script> + window.rootPath = "../../"; + window.currentCrate = "km"; + window.playgroundUrl = ""; + </script> + <script src="../../jquery.js"></script> + <script src="../../main.js"></script> + + <script defer src="../../search-index.js"></script> +</body> +</html>
\ No newline at end of file diff --git a/doc/src/km/driver_object.rs.html b/doc/src/km/driver_object.rs.html new file mode 100644 index 0000000..0b44205 --- /dev/null +++ b/doc/src/km/driver_object.rs.html @@ -0,0 +1,176 @@ +<!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 `driver_object.rs`."> + <meta name="keywords" content="rust, rustlang, rust-lang"> + + <title>driver_object.rs.html -- source</title> + + <link rel="stylesheet" type="text/css" href="../../rustdoc.css"> + <link rel="stylesheet" type="text/css" href="../../main.css"> + + + + +</head> +<body class="rustdoc"> + <!--[if lte IE 8]> + <div class="warning"> + This old browser is unsupported and will most likely display funky + things. + </div> + <![endif]--> + + + + <nav class="sidebar"> + + + </nav> + + <nav class="sub"> + <form class="search-form js-only"> + <div class="search-container"> + <input class="search-input" name="search" + autocomplete="off" + placeholder="Click or press ‘S’ to search, ‘?’ for more options…" + type="search"> + </div> + </form> + </nav> + + <section id='main' class="content source"><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> +</pre><pre class='rust '> +<span class='doccomment'>//! Driver Object.</span> + +<span class='kw'>use</span> ::{<span class='ident'>NTSTATUS</span>, <span class='ident'>UNICODE_STRING</span>}; +<span class='kw'>use</span> ::<span class='ident'>device_object</span>::<span class='op'>*</span>; +<span class='kw'>use</span> ::<span class='ident'>irp</span>::<span class='ident'>IRP</span>; + + +<span class='kw'>pub</span> <span class='kw'>type</span> <span class='ident'>PDRIVER_INITIALIZE</span> <span class='op'>=</span> <span class='prelude-ty'>Option</span><span class='op'><</span><span class='kw'>extern</span> <span class='string'>"system"</span> <span class='kw'>fn</span> (<span class='ident'>_self</span>: <span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>DRIVER_OBJECT</span>, <span class='kw-2'>&</span><span class='ident'>UNICODE_STRING</span>) <span class='op'>-></span> <span class='ident'>NTSTATUS</span><span class='op'>></span>; +<span class='kw'>pub</span> <span class='kw'>type</span> <span class='ident'>PDRIVER_STARTIO</span> <span class='op'>=</span> <span class='prelude-ty'>Option</span><span class='op'><</span><span class='kw'>extern</span> <span class='string'>"system"</span> <span class='kw'>fn</span> (<span class='ident'>_self</span>: <span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>DRIVER_OBJECT</span>, <span class='kw-2'>&</span><span class='ident'>IRP</span>)<span class='op'>></span>; +<span class='kw'>pub</span> <span class='kw'>type</span> <span class='ident'>PDRIVER_UNLOAD</span> <span class='op'>=</span> <span class='prelude-ty'>Option</span><span class='op'><</span><span class='kw'>extern</span> <span class='string'>"system"</span> <span class='kw'>fn</span> (<span class='ident'>_self</span>: <span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>DRIVER_OBJECT</span>)<span class='op'>></span>; + + +<span class='doccomment'>/// Represents the image of a loaded kernel-mode driver.</span> +<span class='attribute'>#[<span class='ident'>repr</span>(<span class='ident'>C</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>struct</span> <span class='ident'>DRIVER_OBJECT</span> +{ + <span class='kw'>pub</span> <span class='ident'>Type</span>: <span class='ident'>u16</span>, + <span class='kw'>pub</span> <span class='ident'>Size</span>: <span class='ident'>u16</span>, + <span class='kw'>pub</span> <span class='ident'>DeviceObject</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>DEVICE_OBJECT</span>, + <span class='kw'>pub</span> <span class='ident'>Flags</span>: <span class='ident'>u32</span>, + <span class='kw'>pub</span> <span class='ident'>DriverStart</span>: <span class='op'>*</span><span class='kw'>const</span> <span class='ident'>u8</span>, + <span class='kw'>pub</span> <span class='ident'>DriverSize</span>: <span class='ident'>u32</span>, + <span class='kw'>pub</span> <span class='ident'>DriverSection</span>: <span class='op'>*</span><span class='kw'>const</span> <span class='ident'>u8</span>, + <span class='kw'>pub</span> <span class='ident'>DriverExtension</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>u8</span>, + <span class='kw'>pub</span> <span class='ident'>DriverName</span>: <span class='ident'>UNICODE_STRING</span>, + <span class='kw'>pub</span> <span class='ident'>HardwareDatabase</span>: <span class='op'>*</span><span class='kw'>const</span> <span class='ident'>UNICODE_STRING</span>, + <span class='kw'>pub</span> <span class='ident'>FastIoDispatch</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>u8</span>, + <span class='kw'>pub</span> <span class='ident'>DriverInit</span>: <span class='ident'>PDRIVER_INITIALIZE</span>, + <span class='kw'>pub</span> <span class='ident'>DriverStartIo</span>: <span class='ident'>PDRIVER_STARTIO</span>, + <span class='doccomment'>/// The entry point for the driver's Unload routine, if any.</span> + <span class='kw'>pub</span> <span class='ident'>DriverUnload</span>: <span class='ident'>PDRIVER_UNLOAD</span>, + <span class='doccomment'>/// A dispatch table consisting of an array of entry points for the driver's `DispatchXxx` routines.</span> + <span class='kw'>pub</span> <span class='ident'>MajorFunction</span>: [<span class='ident'>PDRIVER_DISPATCH</span>; <span class='number'>28</span>], +} +</pre> +</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>?</dt> + <dd>Show this help dialog</dd> + <dt>S</dt> + <dd>Focus the search field</dd> + <dt>⇤</dt> + <dd>Move up in search results</dd> + <dt>⇥</dt> + <dd>Move down in search results</dd> + <dt>⏎</dt> + <dd>Go to active search result</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> + </div> + </div> + </aside> + + + + <script> + window.rootPath = "../../"; + window.currentCrate = "km"; + window.playgroundUrl = ""; + </script> + <script src="../../jquery.js"></script> + <script src="../../main.js"></script> + + <script defer src="../../search-index.js"></script> +</body> +</html>
\ No newline at end of file diff --git a/doc/src/km/event.rs.html b/doc/src/km/event.rs.html new file mode 100644 index 0000000..99cfe3e --- /dev/null +++ b/doc/src/km/event.rs.html @@ -0,0 +1,170 @@ +<!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 `event.rs`."> + <meta name="keywords" content="rust, rustlang, rust-lang"> + + <title>event.rs.html -- source</title> + + <link rel="stylesheet" type="text/css" href="../../rustdoc.css"> + <link rel="stylesheet" type="text/css" href="../../main.css"> + + + + +</head> +<body class="rustdoc"> + <!--[if lte IE 8]> + <div class="warning"> + This old browser is unsupported and will most likely display funky + things. + </div> + <![endif]--> + + + + <nav class="sidebar"> + + + </nav> + + <nav class="sub"> + <form class="search-form js-only"> + <div class="search-container"> + <input class="search-input" name="search" + autocomplete="off" + placeholder="Click or press ‘S’ to search, ‘?’ for more options…" + type="search"> + </div> + </form> + </nav> + + <section id='main' class="content source"><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> +</pre><pre class='rust '> +<span class='doccomment'>//! Event Objects.</span> + +<span class='kw'>use</span> ::<span class='ident'>basedef</span>::<span class='ident'>DISPATCHER_HEADER</span>; + +<span class='kw'>extern</span> <span class='string'>"system"</span> +{ + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>KeInitializeEvent</span>(<span class='ident'>Event</span>: <span class='ident'>PKEVENT</span>, <span class='ident'>Type</span>: <span class='ident'>EVENT_TYPE</span>, <span class='ident'>State</span>: <span class='ident'>bool</span>); + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>KeSetEvent</span>(<span class='ident'>Event</span>: <span class='ident'>PKEVENT</span>, <span class='ident'>Increment</span>: <span class='ident'>i32</span>, <span class='ident'>Wait</span>: <span class='ident'>bool</span>) <span class='op'>-></span> <span class='ident'>i32</span>; + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>KeReadStateEvent</span>(<span class='ident'>Event</span>: <span class='ident'>PKEVENT</span>) <span class='op'>-></span> <span class='ident'>i32</span>; + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>KeResetEvent</span>(<span class='ident'>Event</span>: <span class='ident'>PKEVENT</span>) <span class='op'>-></span> <span class='ident'>i32</span>; + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>KeClearEvent</span>(<span class='ident'>Event</span>: <span class='ident'>PKEVENT</span>); +} + +<span class='kw'>pub</span> <span class='kw'>type</span> <span class='ident'>PKEVENT</span> <span class='op'>=</span> <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>KEVENT</span>; + +<span class='doccomment'>/// Specifies the event type.</span> +<span class='attribute'>#[<span class='ident'>repr</span>(<span class='ident'>C</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>enum</span> <span class='ident'>EVENT_TYPE</span> +{ + <span class='doccomment'>/// Manual-reset event.</span> + <span class='ident'>NotificationEvent</span> <span class='op'>=</span> <span class='number'>0</span>, + <span class='doccomment'>/// Auto-clearing event.</span> + <span class='ident'>SynchronizationEvent</span>, +} + +<span class='doccomment'>/// Event object.</span> +<span class='attribute'>#[<span class='ident'>repr</span>(<span class='ident'>C</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>struct</span> <span class='ident'>KEVENT</span> +{ + <span class='ident'>Header</span>: <span class='ident'>DISPATCHER_HEADER</span>, +} +</pre> +</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>?</dt> + <dd>Show this help dialog</dd> + <dt>S</dt> + <dd>Focus the search field</dd> + <dt>⇤</dt> + <dd>Move up in search results</dd> + <dt>⇥</dt> + <dd>Move down in search results</dd> + <dt>⏎</dt> + <dd>Go to active search result</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> + </div> + </div> + </aside> + + + + <script> + window.rootPath = "../../"; + window.currentCrate = "km"; + window.playgroundUrl = ""; + </script> + <script src="../../jquery.js"></script> + <script src="../../main.js"></script> + + <script defer src="../../search-index.js"></script> +</body> +</html>
\ No newline at end of file diff --git a/doc/src/km/file_object.rs.html b/doc/src/km/file_object.rs.html new file mode 100644 index 0000000..846fb26 --- /dev/null +++ b/doc/src/km/file_object.rs.html @@ -0,0 +1,138 @@ +<!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 `file_object.rs`."> + <meta name="keywords" content="rust, rustlang, rust-lang"> + + <title>file_object.rs.html -- source</title> + + <link rel="stylesheet" type="text/css" href="../../rustdoc.css"> + <link rel="stylesheet" type="text/css" href="../../main.css"> + + + + +</head> +<body class="rustdoc"> + <!--[if lte IE 8]> + <div class="warning"> + This old browser is unsupported and will most likely display funky + things. + </div> + <![endif]--> + + + + <nav class="sidebar"> + + + </nav> + + <nav class="sub"> + <form class="search-form js-only"> + <div class="search-container"> + <input class="search-input" name="search" + autocomplete="off" + placeholder="Click or press ‘S’ to search, ‘?’ for more options…" + type="search"> + </div> + </form> + </nav> + + <section id='main' class="content source"><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> +</pre><pre class='rust '> +<span class='doccomment'>//! File Object.</span> + +<span class='kw'>use</span> ::<span class='ident'>device_object</span>::<span class='ident'>PDEVICE_OBJECT</span>; + +<span class='kw'>pub</span> <span class='kw'>type</span> <span class='ident'>PFILE_OBJECT</span> <span class='op'>=</span> <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>FILE_OBJECT</span>; + +<span class='doccomment'>/// The `FILE_OBJECT` structure is used by the system to represent a file object.</span> +<span class='attribute'>#[<span class='ident'>repr</span>(<span class='ident'>C</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>struct</span> <span class='ident'>FILE_OBJECT</span> +{ + <span class='ident'>Type</span>: <span class='ident'>u16</span>, + <span class='ident'>Size</span>: <span class='ident'>u16</span>, + <span class='ident'>DeviceObject</span>: <span class='ident'>PDEVICE_OBJECT</span>, + <span class='comment'>// ...</span> +} +</pre> +</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>?</dt> + <dd>Show this help dialog</dd> + <dt>S</dt> + <dd>Focus the search field</dd> + <dt>⇤</dt> + <dd>Move up in search results</dd> + <dt>⇥</dt> + <dd>Move down in search results</dd> + <dt>⏎</dt> + <dd>Go to active search result</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> + </div> + </div> + </aside> + + + + <script> + window.rootPath = "../../"; + window.currentCrate = "km"; + window.playgroundUrl = ""; + </script> + <script src="../../jquery.js"></script> + <script src="../../main.js"></script> + + <script defer src="../../search-index.js"></script> +</body> +</html>
\ No newline at end of file diff --git a/doc/src/km/irp.rs.html b/doc/src/km/irp.rs.html new file mode 100644 index 0000000..fb902dc --- /dev/null +++ b/doc/src/km/irp.rs.html @@ -0,0 +1,476 @@ +<!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 `irp.rs`."> + <meta name="keywords" content="rust, rustlang, rust-lang"> + + <title>irp.rs.html -- source</title> + + <link rel="stylesheet" type="text/css" href="../../rustdoc.css"> + <link rel="stylesheet" type="text/css" href="../../main.css"> + + + + +</head> +<body class="rustdoc"> + <!--[if lte IE 8]> + <div class="warning"> + This old browser is unsupported and will most likely display funky + things. + </div> + <![endif]--> + + + + <nav class="sidebar"> + + + </nav> + + <nav class="sub"> + <form class="search-form js-only"> + <div class="search-container"> + <input class="search-input" name="search" + autocomplete="off" + placeholder="Click or press ‘S’ to search, ‘?’ for more options…" + type="search"> + </div> + </form> + </nav> + + <section id='main' class="content source"><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> +<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> +</pre><pre class='rust '> +<span class='doccomment'>//! I/O request packets (IRP).</span> + +<span class='kw'>use</span> ::<span class='ident'>NTSTATUS</span>; +<span class='kw'>use</span> ::<span class='ident'>basedef</span>::<span class='op'>*</span>; +<span class='kw'>use</span> ::<span class='ident'>event</span>::<span class='ident'>PKEVENT</span>; +<span class='kw'>use</span> ::<span class='ident'>device_object</span>::<span class='op'>*</span>; +<span class='kw'>use</span> ::<span class='ident'>file_object</span>::<span class='op'>*</span>; +<span class='kw'>use</span> ::<span class='ident'>basedef</span>::<span class='ident'>IO_PRIORITY</span>::<span class='op'>*</span>; +<span class='kw'>use</span> ::<span class='ident'>KIRQL</span>; + + +<span class='kw'>pub</span> <span class='kw'>type</span> <span class='ident'>PIRP</span> <span class='op'>=</span> <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>IRP</span>; +<span class='kw'>pub</span> <span class='kw'>type</span> <span class='ident'>PIO_STACK_LOCATION</span> <span class='op'>=</span> <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>IO_STACK_LOCATION</span>; + +<span class='comment'>// NOTE: fastcall is broken: https://github.com/rust-lang/rust/issues/18086</span> +<span class='comment'>//extern "fastcall" { fn IofCompleteRequest(Irp: PIRP, PriorityBoost: KPRIORITY_BOOST); }</span> +<span class='kw'>extern</span> <span class='string'>"system"</span> +{ + <span class='kw'>fn</span> <span class='ident'>IoCompleteRequest</span>(<span class='ident'>Irp</span>: <span class='ident'>PIRP</span>, <span class='ident'>PriorityBoost</span>: <span class='ident'>KPRIORITY_BOOST</span>); + + <span class='comment'>// unfortunately following are macro</span> + <span class='comment'>// fn IoGetCurrentIrpStackLocation(Irp: PIRP) -> PIO_STACK_LOCATION;</span> + <span class='comment'>// fn IoGetNextIrpStackLocation(Irp: PIRP) -> PIO_STACK_LOCATION;</span> + <span class='comment'>// fn IoSetNextIrpStackLocation(Irp: PIRP);</span> + <span class='comment'>// fn IoSkipCurrentIrpStackLocation(Irp: PIRP);</span> +} + +<span class='doccomment'>/// `IRP` Major Function Codes.</span> +<span class='attribute'>#[<span class='ident'>repr</span>(<span class='ident'>u8</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>enum</span> <span class='ident'>IRP_MJ</span> +{ + <span class='ident'>CREATE</span>, + <span class='ident'>CREATE_NAMED_PIPE</span>, + <span class='ident'>CLOSE</span>, + <span class='ident'>READ</span>, + <span class='ident'>WRITE</span>, + <span class='ident'>QUERY_INFORMATION</span>, + <span class='ident'>SET_INFORMATION</span>, + <span class='ident'>QUERY_EA</span>, + <span class='ident'>SET_EA</span>, + <span class='ident'>FLUSH_BUFFERS</span>, + <span class='ident'>QUERY_VOLUME_INFORMATION</span>, + <span class='ident'>SET_VOLUME_INFORMATION</span>, + <span class='ident'>DIRECTORY_CONTROL</span>, + <span class='ident'>FILE_SYSTEM_CONTROL</span>, + <span class='ident'>DEVICE_CONTROL</span>, + <span class='ident'>INTERNAL_DEVICE_CONTROL</span>, + <span class='ident'>SHUTDOWN</span>, + <span class='ident'>LOCK_CONTROL</span>, + <span class='ident'>CLEANUP</span>, + <span class='ident'>CREATE_MAILSLOT</span>, + <span class='ident'>QUERY_SECURITY</span>, + <span class='ident'>SET_SECURITY</span>, + <span class='ident'>POWER</span>, + <span class='ident'>SYSTEM_CONTROL</span>, + <span class='ident'>DEVICE_CHANGE</span>, + <span class='ident'>QUERY_QUOTA</span>, + <span class='ident'>SET_QUOTA</span>, + <span class='ident'>PNP</span>, + <span class='ident'>MAXIMUM_FUNCTION</span>, +} + +<span class='doccomment'>/// The `IRP` structure is a partial opaque structure that represents an I/O request packet.</span> +<span class='attribute'>#[<span class='ident'>repr</span>(<span class='ident'>C</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>struct</span> <span class='ident'>IRP</span> +{ + <span class='kw'>pub</span> <span class='ident'>Type</span>: <span class='ident'>u16</span>, + <span class='kw'>pub</span> <span class='ident'>Size</span>: <span class='ident'>u16</span>, + <span class='doccomment'>/// Pointer to an `MDL` describing a user buffer, if the driver is using direct I/O.</span> + <span class='kw'>pub</span> <span class='ident'>MdlAddress</span>: <span class='ident'>PVOID</span>, + <span class='doccomment'>/// Flags word - used to remember various flags.</span> + <span class='kw'>pub</span> <span class='ident'>Flags</span>: <span class='ident'>u32</span>, + <span class='doccomment'>/// Pointer to a system-space buffer if the driver is using buffered I/O.</span> + <span class='kw'>pub</span> <span class='ident'>SystemBuffer</span>: <span class='ident'>PVOID</span>, + <span class='kw'>pub</span> <span class='ident'>ThreadListEntry</span>: <span class='ident'>LIST_ENTRY</span>, + <span class='doccomment'>/// I/O status - final status of operation.</span> + <span class='kw'>pub</span> <span class='ident'>IoStatus</span>: <span class='ident'>IO_STATUS_BLOCK</span>, + <span class='doccomment'>/// Indicates the execution mode of the original requester of the operation.</span> + <span class='kw'>pub</span> <span class='ident'>RequestorMode</span>: <span class='ident'>KPROCESSOR_MODE</span>, + <span class='doccomment'>/// If set to `TRUE`, a driver has marked the IRP pending.</span> + <span class='kw'>pub</span> <span class='ident'>PendingReturned</span>: <span class='ident'>bool</span>, + <span class='doccomment'>/// Stack state information.</span> + <span class='kw'>pub</span> <span class='ident'>StackCount</span>: <span class='ident'>i8</span>, + <span class='doccomment'>/// Stack state information.</span> + <span class='kw'>pub</span> <span class='ident'>CurrentLocation</span>: <span class='ident'>i8</span>, + <span class='doccomment'>/// If set to `TRUE`, the IRP either is or should be canceled.</span> + <span class='kw'>pub</span> <span class='ident'>Cancel</span>: <span class='ident'>bool</span>, + <span class='doccomment'>/// Irql at which the cancel spinlock was acquired.</span> + <span class='kw'>pub</span> <span class='ident'>CancelIrql</span>: <span class='ident'>KIRQL</span>, + <span class='kw'>pub</span> <span class='ident'>ApcEnvironment</span>: <span class='ident'>u8</span>, + <span class='doccomment'>/// Allocation control flags.</span> + <span class='kw'>pub</span> <span class='ident'>AllocationFlags</span>: <span class='ident'>u8</span>, + <span class='doccomment'>/// User parameters.</span> + <span class='kw'>pub</span> <span class='ident'>UserIosb</span>: <span class='ident'>PIO_STATUS_BLOCK</span>, + <span class='kw'>pub</span> <span class='ident'>UserEvent</span>: <span class='ident'>PKEVENT</span>, + + <span class='comment'>// union {</span> + <span class='kw'>pub</span> <span class='ident'>UserApcRoutine</span>: <span class='ident'>PIO_APC_ROUTINE</span>, + <span class='kw'>pub</span> <span class='ident'>UserApcContext</span>: <span class='ident'>PVOID</span>, + <span class='comment'>// } Overlay</span> + + <span class='doccomment'>/// Contains the entry point for a driver-supplied `Cancel` routine to be called if the IRP is canceled.</span> + <span class='kw'>pub</span> <span class='ident'>CancelRoutine</span>: <span class='ident'>PDRIVER_CANCEL</span>, + <span class='doccomment'>/// Contains the address of an output buffer for `IRP_MJ_DEVICE_CONTROL`.</span> + <span class='kw'>pub</span> <span class='ident'>UserBuffer</span>: <span class='ident'>PVOID</span>, + + <span class='doccomment'>/// Kernel structures.</span> + <span class='comment'>// union {</span> + <span class='kw'>pub</span> <span class='ident'>Overlay</span>: <span class='ident'>_IRP_OVERLAY</span>, + <span class='comment'>// } Tail</span> +} + +<span class='doccomment'>/// Kernel structures for IRP.</span> +<span class='attribute'>#[<span class='ident'>repr</span>(<span class='ident'>C</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>struct</span> <span class='ident'>_IRP_OVERLAY</span> +{ + <span class='kw'>pub</span> <span class='ident'>DriverContext</span>: [<span class='ident'>PVOID</span>; <span class='number'>4</span>], + <span class='kw'>pub</span> <span class='ident'>Thread</span>: <span class='ident'>PETHREAD</span>, + <span class='kw'>pub</span> <span class='ident'>AuxiliaryBuffer</span>: <span class='ident'>PVOID</span>, + <span class='kw'>pub</span> <span class='ident'>ListEntry</span>: <span class='ident'>LIST_ENTRY</span>, + <span class='doccomment'>/// Current stack location.</span> + <span class='kw'>pub</span> <span class='ident'>CurrentStackLocation</span>: <span class='ident'>PIO_STACK_LOCATION</span>, + <span class='kw'>pub</span> <span class='ident'>OriginalFileObject</span>: <span class='ident'>PFILE_OBJECT</span>, +} + +<span class='doccomment'>/// I/O Stack Locations.</span> +<span class='attribute'>#[<span class='ident'>repr</span>(<span class='ident'>C</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>struct</span> <span class='ident'>IO_STACK_LOCATION</span> +{ + <span class='doccomment'>/// The IRP major function code indicating the type of I/O operation to be performed.</span> + <span class='kw'>pub</span> <span class='ident'>MajorFunction</span>: <span class='ident'>u8</span>, + <span class='doccomment'>/// A subfunction code for `MajorFunction`.</span> + <span class='kw'>pub</span> <span class='ident'>MinorFunction</span>: <span class='ident'>u8</span>, + <span class='doccomment'>/// Request-type-specific values (see [DEVICE_FLAGS](../device_object/enum.DEVICE_FLAGS.html)).</span> + <span class='kw'>pub</span> <span class='ident'>Flags</span>: <span class='ident'>u8</span>, + <span class='kw'>pub</span> <span class='ident'>Control</span>: <span class='ident'>u8</span>, + + <span class='doccomment'>/// A union that depends on the major and minor IRP function code values</span> + <span class='doccomment'>/// contained in `MajorFunction` and `MinorFunction`.</span> + <span class='comment'>// union Parameters</span> + <span class='kw'>pub</span> <span class='ident'>Parameters</span>: [<span class='ident'>PVOID</span>; <span class='number'>4</span>], + + <span class='doccomment'>/// A pointer to the driver-created `DEVICE_OBJECT` structure</span> + <span class='doccomment'>/// representing the target physical, logical, or virtual device for which this driver is to handle the IRP.</span> + <span class='kw'>pub</span> <span class='ident'>DeviceObject</span>: <span class='ident'>PDEVICE_OBJECT</span>, + <span class='doccomment'>/// A pointer to a `FILE_OBJECT` structure that represents the file object, if any, that is associated with `DeviceObject` pointer.</span> + <span class='kw'>pub</span> <span class='ident'>FileObject</span>: <span class='ident'>PFILE_OBJECT</span>, + <span class='doccomment'>/// The following routine is invoked depending on the flags in the above `Flags` field.</span> + <span class='kw'>pub</span> <span class='ident'>CompletionRoutine</span>: <span class='ident'>PIO_COMPLETION_ROUTINE</span>, + <span class='doccomment'>/// The following is used to store the address of the context parameter that should be passed to the `CompletionRoutine`.</span> + <span class='kw'>pub</span> <span class='ident'>Context</span>: <span class='ident'>PVOID</span>, +} + +<span class='doccomment'>/// Parameters for `IRP_MJ_READ`.</span> +<span class='attribute'>#[<span class='ident'>repr</span>(<span class='ident'>C</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>struct</span> <span class='ident'>_IO_STACK_LOCATION_READ</span> +{ + <span class='kw'>pub</span> <span class='ident'>Length</span>: <span class='ident'>u32</span>, + <span class='kw'>pub</span> <span class='ident'>Key</span>: <span class='ident'>u32</span>, + <span class='kw'>pub</span> <span class='ident'>ByteOffset</span>: <span class='ident'>i64</span>, +} + + +<span class='kw'>impl</span> <span class='ident'>IRP</span> { + <span class='doccomment'>/// Returns a pointer to the caller's stack location in the given `IRP`.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>get_current_stack_location</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='self'>self</span>) <span class='op'>-></span> <span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>IO_STACK_LOCATION</span> { + <span class='kw'>unsafe</span> { <span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='op'>*</span><span class='self'>self</span>.<span class='ident'>Overlay</span>.<span class='ident'>CurrentStackLocation</span> } + } + + <span class='doccomment'>/// Indicates that the caller has completed all processing for a given I/O request</span> + <span class='doccomment'>/// and is returning the given IRP to the I/O manager.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>complete_request</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='self'>self</span>, <span class='ident'>Status</span>: <span class='ident'>NTSTATUS</span>) <span class='op'>-></span> <span class='ident'>NTSTATUS</span> { + <span class='self'>self</span>.<span class='ident'>IoStatus</span>.<span class='ident'>Status</span> <span class='op'>=</span> <span class='ident'>Status</span>; + <span class='kw'>unsafe</span> { <span class='ident'>IoCompleteRequest</span>(<span class='self'>self</span>, <span class='ident'>IO_NO_INCREMENT</span>) }; + <span class='kw'>return</span> <span class='ident'>Status</span>; + } +} + +<span class='kw'>impl</span> <span class='ident'>IO_STACK_LOCATION</span> { + <span class='doccomment'>/// Access parameters for `IRP_MJ_READ`.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>ParametersRead</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='self'>self</span>) <span class='op'>-></span> <span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>_IO_STACK_LOCATION_READ</span> { + <span class='kw'>unsafe</span> { ::<span class='ident'>core</span>::<span class='ident'>mem</span>::<span class='ident'>transmute</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='self'>self</span>.<span class='ident'>Parameters</span>) } + } +} +</pre> +</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>?</dt> + <dd>Show this help dialog</dd> + <dt>S</dt> + <dd>Focus the search field</dd> + <dt>⇤</dt> + <dd>Move up in search results</dd> + <dt>⇥</dt> + <dd>Move down in search results</dd> + <dt>⏎</dt> + <dd>Go to active search result</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> + </div> + </div> + </aside> + + + + <script> + window.rootPath = "../../"; + window.currentCrate = "km"; + window.playgroundUrl = ""; + </script> + <script src="../../jquery.js"></script> + <script src="../../main.js"></script> + + <script defer src="../../search-index.js"></script> +</body> +</html>
\ No newline at end of file diff --git a/doc/src/km/irql.rs.html b/doc/src/km/irql.rs.html new file mode 100644 index 0000000..03964c4 --- /dev/null +++ b/doc/src/km/irql.rs.html @@ -0,0 +1,230 @@ +<!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 `irql.rs`."> + <meta name="keywords" content="rust, rustlang, rust-lang"> + + <title>irql.rs.html -- source</title> + + <link rel="stylesheet" type="text/css" href="../../rustdoc.css"> + <link rel="stylesheet" type="text/css" href="../../main.css"> + + + + +</head> +<body class="rustdoc"> + <!--[if lte IE 8]> + <div class="warning"> + This old browser is unsupported and will most likely display funky + things. + </div> + <![endif]--> + + + + <nav class="sidebar"> + + + </nav> + + <nav class="sub"> + <form class="search-form js-only"> + <div class="search-container"> + <input class="search-input" name="search" + autocomplete="off" + placeholder="Click or press ‘S’ to search, ‘?’ for more options…" + type="search"> + </div> + </form> + </nav> + + <section id='main' class="content source"><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> +</pre><pre class='rust '> +<span class='doccomment'>//! Interrupt Request Level (IRQL).</span> + +<span class='doccomment'>/// IRQL type.</span> +<span class='kw'>pub</span> <span class='kw'>type</span> <span class='ident'>KIRQL</span> <span class='op'>=</span> <span class='ident'>u8</span>; + +<span class='doccomment'>/// Passive release level, no interrupt vectors are masked.</span> +<span class='kw'>pub</span> <span class='kw'>const</span> <span class='ident'>PASSIVE_LEVEL</span>: <span class='ident'>KIRQL</span> <span class='op'>=</span> <span class='number'>0</span>; +<span class='doccomment'>/// The lowest IRQL level, no interrupt vectors are masked.</span> +<span class='kw'>pub</span> <span class='kw'>const</span> <span class='ident'>LOW_LEVEL</span>: <span class='ident'>KIRQL</span> <span class='op'>=</span> <span class='number'>0</span>; +<span class='doccomment'>/// APC interrupt level.</span> +<span class='kw'>pub</span> <span class='kw'>const</span> <span class='ident'>APC_LEVEL</span>: <span class='ident'>KIRQL</span> <span class='op'>=</span> <span class='number'>1</span>; +<span class='doccomment'>/// Dispatcher level</span> +<span class='kw'>pub</span> <span class='kw'>const</span> <span class='ident'>DISPATCH_LEVEL</span>: <span class='ident'>KIRQL</span> <span class='op'>=</span> <span class='number'>2</span>; + +<span class='doccomment'>/// Timer used for profiling.</span> +<span class='attribute'>#[<span class='ident'>cfg</span>(<span class='ident'>target_arch</span> <span class='op'>=</span> <span class='string'>"x86"</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>const</span> <span class='ident'>PROFILE_LEVEL</span>: <span class='ident'>KIRQL</span> <span class='op'>=</span> <span class='number'>27</span>; + +<span class='doccomment'>/// Interval clock level.</span> +<span class='attribute'>#[<span class='ident'>cfg</span>(<span class='ident'>target_arch</span> <span class='op'>=</span> <span class='string'>"x86"</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>const</span> <span class='ident'>CLOCK_LEVEL</span>: <span class='ident'>KIRQL</span> <span class='op'>=</span> <span class='number'>28</span>; + +<span class='doccomment'>/// Interprocessor interrupt level.</span> +<span class='attribute'>#[<span class='ident'>cfg</span>(<span class='ident'>target_arch</span> <span class='op'>=</span> <span class='string'>"x86"</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>const</span> <span class='ident'>IPI_LEVEL</span>: <span class='ident'>KIRQL</span> <span class='op'>=</span> <span class='number'>29</span>; + +<span class='doccomment'>/// Power failure level.</span> +<span class='attribute'>#[<span class='ident'>cfg</span>(<span class='ident'>target_arch</span> <span class='op'>=</span> <span class='string'>"x86"</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>const</span> <span class='ident'>POWER_LEVEL</span>: <span class='ident'>KIRQL</span> <span class='op'>=</span> <span class='number'>30</span>; + +<span class='doccomment'>/// Highest interrupt level.</span> +<span class='attribute'>#[<span class='ident'>cfg</span>(<span class='ident'>target_arch</span> <span class='op'>=</span> <span class='string'>"x86"</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>const</span> <span class='ident'>HIGH_LEVEL</span>: <span class='ident'>KIRQL</span> <span class='op'>=</span> <span class='number'>31</span>; + +<span class='doccomment'>/// Synchronization level.</span> +<span class='attribute'>#[<span class='ident'>cfg</span>(<span class='ident'>target_arch</span> <span class='op'>=</span> <span class='string'>"x86"</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>const</span> <span class='ident'>SYNCH_LEVEL</span>: <span class='ident'>KIRQL</span> <span class='op'>=</span> <span class='number'>29</span> <span class='op'>-</span> <span class='number'>2</span>; + +<span class='doccomment'>/// Interval clock level.</span> +<span class='attribute'>#[<span class='ident'>cfg</span>(<span class='ident'>target_arch</span> <span class='op'>=</span> <span class='string'>"x86_64"</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>const</span> <span class='ident'>CLOCK_LEVEL</span>: <span class='ident'>KIRQL</span> <span class='op'>=</span> <span class='number'>13</span>; + +<span class='doccomment'>/// Interprocessor interrupt level.</span> +<span class='attribute'>#[<span class='ident'>cfg</span>(<span class='ident'>target_arch</span> <span class='op'>=</span> <span class='string'>"x86_64"</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>const</span> <span class='ident'>IPI_LEVEL</span>: <span class='ident'>KIRQL</span> <span class='op'>=</span> <span class='number'>14</span>; + +<span class='doccomment'>/// Power failure level.</span> +<span class='attribute'>#[<span class='ident'>cfg</span>(<span class='ident'>target_arch</span> <span class='op'>=</span> <span class='string'>"x86_64"</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>const</span> <span class='ident'>POWER_LEVEL</span>: <span class='ident'>KIRQL</span> <span class='op'>=</span> <span class='number'>15</span>; + +<span class='doccomment'>/// Timer used for profiling.</span> +<span class='attribute'>#[<span class='ident'>cfg</span>(<span class='ident'>target_arch</span> <span class='op'>=</span> <span class='string'>"x86_64"</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>const</span> <span class='ident'>PROFILE_LEVEL</span>: <span class='ident'>KIRQL</span> <span class='op'>=</span> <span class='number'>16</span>; + +<span class='doccomment'>/// Highest interrupt level.</span> +<span class='attribute'>#[<span class='ident'>cfg</span>(<span class='ident'>target_arch</span> <span class='op'>=</span> <span class='string'>"x86_64"</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>const</span> <span class='ident'>HIGH_LEVEL</span>: <span class='ident'>KIRQL</span> <span class='op'>=</span> <span class='number'>17</span>; + +<span class='doccomment'>/// Synchronization level.</span> +<span class='attribute'>#[<span class='ident'>cfg</span>(<span class='ident'>target_arch</span> <span class='op'>=</span> <span class='string'>"x86_64"</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>const</span> <span class='ident'>SYNCH_LEVEL</span>: <span class='ident'>KIRQL</span> <span class='op'>=</span> <span class='number'>14</span><span class='op'>-</span> <span class='number'>2</span>; +</pre> +</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>?</dt> + <dd>Show this help dialog</dd> + <dt>S</dt> + <dd>Focus the search field</dd> + <dt>⇤</dt> + <dd>Move up in search results</dd> + <dt>⇥</dt> + <dd>Move down in search results</dd> + <dt>⏎</dt> + <dd>Go to active search result</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> + </div> + </div> + </aside> + + + + <script> + window.rootPath = "../../"; + window.currentCrate = "km"; + window.playgroundUrl = ""; + </script> + <script src="../../jquery.js"></script> + <script src="../../main.js"></script> + + <script defer src="../../search-index.js"></script> +</body> +</html>
\ No newline at end of file diff --git a/doc/src/km/lang.rs.html b/doc/src/km/lang.rs.html new file mode 100644 index 0000000..0467c87 --- /dev/null +++ b/doc/src/km/lang.rs.html @@ -0,0 +1,122 @@ +<!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 `lang.rs`."> + <meta name="keywords" content="rust, rustlang, rust-lang"> + + <title>lang.rs.html -- source</title> + + <link rel="stylesheet" type="text/css" href="../../rustdoc.css"> + <link rel="stylesheet" type="text/css" href="../../main.css"> + + + + +</head> +<body class="rustdoc"> + <!--[if lte IE 8]> + <div class="warning"> + This old browser is unsupported and will most likely display funky + things. + </div> + <![endif]--> + + + + <nav class="sidebar"> + + + </nav> + + <nav class="sub"> + <form class="search-form js-only"> + <div class="search-container"> + <input class="search-input" name="search" + autocomplete="off" + placeholder="Click or press ‘S’ to search, ‘?’ for more options…" + type="search"> + </div> + </form> + </nav> + + <section id='main' class="content source"><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> +</pre><pre class='rust '> +<span class='attribute'>#[<span class='ident'>lang</span> <span class='op'>=</span> <span class='string'>"eh_personality"</span>]</span> <span class='kw'>extern</span> <span class='kw'>fn</span> <span class='ident'>eh_personality</span>() {} +<span class='attribute'>#[<span class='ident'>lang</span> <span class='op'>=</span> <span class='string'>"eh_unwind_resume"</span>]</span> <span class='kw'>extern</span> <span class='kw'>fn</span> <span class='ident'>rust_eh_unwind_resume</span>() {} + +<span class='attribute'>#[<span class='ident'>lang</span> <span class='op'>=</span> <span class='string'>"panic_fmt"</span>]</span> <span class='kw'>extern</span> <span class='kw'>fn</span> <span class='ident'>panic_fmt</span>() <span class='op'>-></span> <span class='op'>!</span> { + <span class='macro'>KdPrint</span><span class='macro'>!</span>(<span class='string'>"panic_fmt() -> !"</span>); + <span class='kw'>loop</span>{} +} +</pre> +</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>?</dt> + <dd>Show this help dialog</dd> + <dt>S</dt> + <dd>Focus the search field</dd> + <dt>⇤</dt> + <dd>Move up in search results</dd> + <dt>⇥</dt> + <dd>Move down in search results</dd> + <dt>⏎</dt> + <dd>Go to active search result</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> + </div> + </div> + </aside> + + + + <script> + window.rootPath = "../../"; + window.currentCrate = "km"; + window.playgroundUrl = ""; + </script> + <script src="../../jquery.js"></script> + <script src="../../main.js"></script> + + <script defer src="../../search-index.js"></script> +</body> +</html>
\ No newline at end of file diff --git a/doc/src/km/lib.rs.html b/doc/src/km/lib.rs.html new file mode 100644 index 0000000..12c52e0 --- /dev/null +++ b/doc/src/km/lib.rs.html @@ -0,0 +1,218 @@ +<!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 `lib.rs`."> + <meta name="keywords" content="rust, rustlang, rust-lang"> + + <title>lib.rs.html -- source</title> + + <link rel="stylesheet" type="text/css" href="../../rustdoc.css"> + <link rel="stylesheet" type="text/css" href="../../main.css"> + + + + +</head> +<body class="rustdoc"> + <!--[if lte IE 8]> + <div class="warning"> + This old browser is unsupported and will most likely display funky + things. + </div> + <![endif]--> + + + + <nav class="sidebar"> + + + </nav> + + <nav class="sub"> + <form class="search-form js-only"> + <div class="search-container"> + <input class="search-input" name="search" + autocomplete="off" + placeholder="Click or press ‘S’ to search, ‘?’ for more options…" + type="search"> + </div> + </form> + </nav> + + <section id='main' class="content source"><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> +</pre><pre class='rust '> +<span class='doccomment'>//! Windows Kernel Mode library.</span> + +<span class='attribute'>#<span class='op'>!</span>[<span class='ident'>feature</span>(<span class='ident'>lang_items</span>)]</span> +<span class='attribute'>#<span class='op'>!</span>[<span class='ident'>feature</span>(<span class='ident'>on_unimplemented</span>, <span class='ident'>fundamental</span>)]</span> +<span class='attribute'>#<span class='op'>!</span>[<span class='ident'>feature</span>(<span class='ident'>no_core</span>)]</span> + +<span class='attribute'>#<span class='op'>!</span>[<span class='ident'>no_std</span>]</span> +<span class='attribute'>#<span class='op'>!</span>[<span class='ident'>allow</span>(<span class='ident'>bad_style</span>)]</span> + + +<span class='attribute'>#[<span class='ident'>macro_use</span>]</span> <span class='kw'>pub</span> <span class='kw'>mod</span> <span class='ident'>macros</span>; + +<span class='kw'>mod</span> <span class='ident'>lang</span>; + +<span class='kw'>pub</span> <span class='kw'>mod</span> <span class='ident'>status</span>; + +<span class='kw'>pub</span> <span class='kw'>mod</span> <span class='ident'>basedef</span>; +<span class='kw'>pub</span> <span class='kw'>mod</span> <span class='ident'>crt</span>; +<span class='kw'>pub</span> <span class='kw'>mod</span> <span class='ident'>debug</span>; +<span class='kw'>pub</span> <span class='kw'>mod</span> <span class='ident'>device_object</span>; +<span class='kw'>pub</span> <span class='kw'>mod</span> <span class='ident'>dpc</span>; +<span class='kw'>pub</span> <span class='kw'>mod</span> <span class='ident'>driver_object</span>; +<span class='kw'>pub</span> <span class='kw'>mod</span> <span class='ident'>event</span>; +<span class='kw'>pub</span> <span class='kw'>mod</span> <span class='ident'>file_object</span>; +<span class='kw'>pub</span> <span class='kw'>mod</span> <span class='ident'>irp</span>; +<span class='kw'>pub</span> <span class='kw'>mod</span> <span class='ident'>irql</span>; +<span class='kw'>pub</span> <span class='kw'>mod</span> <span class='ident'>object</span>; +<span class='kw'>pub</span> <span class='kw'>mod</span> <span class='ident'>pool</span>; +<span class='kw'>pub</span> <span class='kw'>mod</span> <span class='ident'>rtl</span>; +<span class='kw'>pub</span> <span class='kw'>mod</span> <span class='ident'>string</span>; +<span class='kw'>pub</span> <span class='kw'>mod</span> <span class='ident'>time</span>; + +<span class='attribute'>#[<span class='ident'>doc</span>(<span class='ident'>hidden</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>use</span> <span class='ident'>irql</span>::<span class='ident'>KIRQL</span>; + +<span class='attribute'>#[<span class='ident'>doc</span>(<span class='ident'>hidden</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>use</span> <span class='ident'>status</span>::<span class='op'>*</span>; + +<span class='attribute'>#[<span class='ident'>doc</span>(<span class='ident'>hidden</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>use</span> <span class='ident'>debug</span>::<span class='ident'>DbgPrint</span>; + +<span class='attribute'>#[<span class='ident'>doc</span>(<span class='ident'>hidden</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>use</span> <span class='ident'>string</span>::<span class='op'>*</span>; + +<span class='attribute'>#[<span class='ident'>doc</span>(<span class='ident'>hidden</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>use</span> <span class='ident'>driver_object</span>::<span class='op'>*</span>; + +<span class='attribute'>#[<span class='ident'>doc</span>(<span class='ident'>hidden</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>use</span> <span class='ident'>device_object</span>::<span class='op'>*</span>; + +<span class='attribute'>#[<span class='ident'>doc</span>(<span class='ident'>hidden</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>use</span> <span class='ident'>irp</span>::<span class='ident'>IRP</span>; + +<span class='attribute'>#[<span class='ident'>doc</span>(<span class='ident'>hidden</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>use</span> <span class='ident'>basedef</span>::{<span class='ident'>PVOID</span>}; +</pre> +</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>?</dt> + <dd>Show this help dialog</dd> + <dt>S</dt> + <dd>Focus the search field</dd> + <dt>⇤</dt> + <dd>Move up in search results</dd> + <dt>⇥</dt> + <dd>Move down in search results</dd> + <dt>⏎</dt> + <dd>Go to active search result</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> + </div> + </div> + </aside> + + + + <script> + window.rootPath = "../../"; + window.currentCrate = "km"; + window.playgroundUrl = ""; + </script> + <script src="../../jquery.js"></script> + <script src="../../main.js"></script> + + <script defer src="../../search-index.js"></script> +</body> +</html>
\ No newline at end of file diff --git a/doc/src/km/macros.rs.html b/doc/src/km/macros.rs.html new file mode 100644 index 0000000..229c030 --- /dev/null +++ b/doc/src/km/macros.rs.html @@ -0,0 +1,176 @@ +<!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 `macros.rs`."> + <meta name="keywords" content="rust, rustlang, rust-lang"> + + <title>macros.rs.html -- source</title> + + <link rel="stylesheet" type="text/css" href="../../rustdoc.css"> + <link rel="stylesheet" type="text/css" href="../../main.css"> + + + + +</head> +<body class="rustdoc"> + <!--[if lte IE 8]> + <div class="warning"> + This old browser is unsupported and will most likely display funky + things. + </div> + <![endif]--> + + + + <nav class="sidebar"> + + + </nav> + + <nav class="sub"> + <form class="search-form js-only"> + <div class="search-container"> + <input class="search-input" name="search" + autocomplete="off" + placeholder="Click or press ‘S’ to search, ‘?’ for more options…" + type="search"> + </div> + </form> + </nav> + + <section id='main' class="content source"><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> +</pre><pre class='rust '> +<span class='doccomment'>//! Macros for Kernel-Mode drivers.</span> + +<span class='doccomment'>/// Macro to send a message to the kernel debugger.</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// # Example</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// ```no_run</span> +<span class='doccomment'>/// KdPrint!("NTSTATUS is 0x%X\n", status);</span> +<span class='doccomment'>/// ```</span> +<span class='attribute'>#[<span class='ident'>macro_export</span>]</span> +<span class='macro'>macro_rules</span><span class='macro'>!</span> <span class='ident'>KdPrint</span> { + (<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>msg</span>:<span class='ident'>expr</span> $(, <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>arg</span>:<span class='ident'>expr</span>)<span class='op'>*</span>) <span class='op'>=></span> { <span class='kw'>unsafe</span> { <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>crate</span>::<span class='ident'>debug</span>::<span class='ident'>DbgPrint</span>( <span class='macro'>concat</span><span class='macro'>!</span>(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>msg</span>, <span class='string'>"\0"</span>).<span class='ident'>as_ptr</span>() $(, <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>arg</span> )<span class='op'>*</span> )} }; +} + +<span class='doccomment'>/// Macro to send a message to the kernel debugger for unsafe blocks.</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// Used in `unsafe {}` blocks.</span> +<span class='attribute'>#[<span class='ident'>macro_export</span>]</span> +<span class='macro'>macro_rules</span><span class='macro'>!</span> <span class='ident'>KdPrint_u</span> { + (<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>msg</span>:<span class='ident'>expr</span> $(, <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>arg</span>:<span class='ident'>expr</span>)<span class='op'>*</span>) <span class='op'>=></span> { <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>crate</span>::<span class='ident'>debug</span>::<span class='ident'>DbgPrint</span>( <span class='macro'>concat</span><span class='macro'>!</span>(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>msg</span>, <span class='string'>"\0"</span>).<span class='ident'>as_ptr</span>() $(, <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>arg</span> )<span class='op'>*</span> ) }; +} + +<span class='attribute'>#[<span class='ident'>macro_export</span>]</span> +<span class='macro'>macro_rules</span><span class='macro'>!</span> <span class='ident'>check_unsafe</span> { + (<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>expr</span>:<span class='ident'>expr</span>) <span class='op'>=></span> {{ + <span class='kw'>let</span> <span class='ident'>st</span>: <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>crate</span>::<span class='ident'>status</span>::<span class='ident'>Status</span> <span class='op'>=</span> <span class='kw'>unsafe</span> { <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>expr</span> }; + <span class='kw'>if</span> <span class='ident'>st</span>.<span class='ident'>is_err</span>() { + <span class='macro'>KdPrint</span><span class='macro'>!</span>(<span class='string'>"[km] error: status 0x%X\n"</span>, <span class='ident'>st</span>); + <span class='kw'>return</span> <span class='ident'>st</span>; + } <span class='kw'>else</span> { + <span class='ident'>st</span> + } + }} +} +</pre> +</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>?</dt> + <dd>Show this help dialog</dd> + <dt>S</dt> + <dd>Focus the search field</dd> + <dt>⇤</dt> + <dd>Move up in search results</dd> + <dt>⇥</dt> + <dd>Move down in search results</dd> + <dt>⏎</dt> + <dd>Go to active search result</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> + </div> + </div> + </aside> + + + + <script> + window.rootPath = "../../"; + window.currentCrate = "km"; + window.playgroundUrl = ""; + </script> + <script src="../../jquery.js"></script> + <script src="../../main.js"></script> + + <script defer src="../../search-index.js"></script> +</body> +</html>
\ No newline at end of file diff --git a/doc/src/km/object.rs.html b/doc/src/km/object.rs.html new file mode 100644 index 0000000..39f127f --- /dev/null +++ b/doc/src/km/object.rs.html @@ -0,0 +1,196 @@ +<!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 `object.rs`."> + <meta name="keywords" content="rust, rustlang, rust-lang"> + + <title>object.rs.html -- source</title> + + <link rel="stylesheet" type="text/css" href="../../rustdoc.css"> + <link rel="stylesheet" type="text/css" href="../../main.css"> + + + + +</head> +<body class="rustdoc"> + <!--[if lte IE 8]> + <div class="warning"> + This old browser is unsupported and will most likely display funky + things. + </div> + <![endif]--> + + + + <nav class="sidebar"> + + + </nav> + + <nav class="sub"> + <form class="search-form js-only"> + <div class="search-container"> + <input class="search-input" name="search" + autocomplete="off" + placeholder="Click or press ‘S’ to search, ‘?’ for more options…" + type="search"> + </div> + </form> + </nav> + + <section id='main' class="content source"><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> +</pre><pre class='rust '> +<span class='doccomment'>//! Kernel Objects.</span> + +<span class='kw'>use</span> ::<span class='ident'>basedef</span>::<span class='op'>*</span>; +<span class='kw'>use</span> ::<span class='ident'>device_object</span>::<span class='ident'>PDEVICE_OBJECT</span>; +<span class='kw'>use</span> ::<span class='ident'>irp</span>::<span class='ident'>IRP</span>; + + +<span class='attribute'>#[<span class='ident'>repr</span>(<span class='ident'>C</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>struct</span> <span class='ident'>WAIT_CONTEXT_BLOCK</span> +{ + <span class='ident'>WaitQueueEntry</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>KDEVICE_QUEUE_ENTRY</span>, + <span class='ident'>DeviceRoutine</span>: <span class='kw'>extern</span> <span class='string'>"system"</span> <span class='kw'>fn</span> (<span class='ident'>_obj</span>: <span class='ident'>PDEVICE_OBJECT</span>, <span class='ident'>_irp</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>IRP</span>, <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>u8</span>, <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>u8</span>) <span class='op'>-></span> <span class='ident'>IO_ALLOCATION_ACTION</span>, + <span class='ident'>DeviceContext</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>u8</span>, + <span class='ident'>NumberOfMapRegisters</span>: <span class='ident'>u32</span>, + <span class='ident'>DeviceObject</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>u8</span>, + <span class='ident'>CurrentIrp</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>u8</span>, + <span class='ident'>BufferChainingDpc</span>: <span class='op'>*</span> <span class='kw-2'>mut</span> <span class='ident'>u8</span>, +} + +<span class='attribute'>#[<span class='ident'>repr</span>(<span class='ident'>C</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>enum</span> <span class='ident'>IO_ALLOCATION_ACTION</span> +{ + <span class='ident'>KeepObject</span> <span class='op'>=</span> <span class='number'>0x01</span>, + <span class='ident'>DeallocateObject</span> <span class='op'>=</span> <span class='number'>0x02</span>, + <span class='ident'>DeallocateObjectKeepRegisters</span> <span class='op'>=</span> <span class='number'>0x03</span>, +} + +<span class='attribute'>#[<span class='ident'>repr</span>(<span class='ident'>C</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>struct</span> <span class='ident'>KDEVICE_QUEUE_ENTRY</span> +{ + <span class='ident'>DeviceListEntry</span>: <span class='ident'>LIST_ENTRY</span>, + <span class='ident'>SortKey</span>: <span class='ident'>u32</span>, + <span class='ident'>Inserted</span>: <span class='ident'>bool</span>, +} + +<span class='attribute'>#[<span class='ident'>repr</span>(<span class='ident'>C</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>struct</span> <span class='ident'>KDEVICE_QUEUE</span> +{ + <span class='ident'>Type</span>: <span class='ident'>u16</span>, + <span class='ident'>Size</span>: <span class='ident'>u16</span>, + <span class='ident'>DeviceListHead</span>: <span class='ident'>LIST_ENTRY</span>, + <span class='ident'>Lock</span>: <span class='ident'>KSPIN_LOCK</span>, + <span class='ident'>Busy</span>: <span class='ident'>bool</span>, +} +</pre> +</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>?</dt> + <dd>Show this help dialog</dd> + <dt>S</dt> + <dd>Focus the search field</dd> + <dt>⇤</dt> + <dd>Move up in search results</dd> + <dt>⇥</dt> + <dd>Move down in search results</dd> + <dt>⏎</dt> + <dd>Go to active search result</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> + </div> + </div> + </aside> + + + + <script> + window.rootPath = "../../"; + window.currentCrate = "km"; + window.playgroundUrl = ""; + </script> + <script src="../../jquery.js"></script> + <script src="../../main.js"></script> + + <script defer src="../../search-index.js"></script> +</body> +</html>
\ No newline at end of file diff --git a/doc/src/km/pool.rs.html b/doc/src/km/pool.rs.html new file mode 100644 index 0000000..95e3e0d --- /dev/null +++ b/doc/src/km/pool.rs.html @@ -0,0 +1,192 @@ +<!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 `pool.rs`."> + <meta name="keywords" content="rust, rustlang, rust-lang"> + + <title>pool.rs.html -- source</title> + + <link rel="stylesheet" type="text/css" href="../../rustdoc.css"> + <link rel="stylesheet" type="text/css" href="../../main.css"> + + + + +</head> +<body class="rustdoc"> + <!--[if lte IE 8]> + <div class="warning"> + This old browser is unsupported and will most likely display funky + things. + </div> + <![endif]--> + + + + <nav class="sidebar"> + + + </nav> + + <nav class="sub"> + <form class="search-form js-only"> + <div class="search-container"> + <input class="search-input" name="search" + autocomplete="off" + placeholder="Click or press ‘S’ to search, ‘?’ for more options…" + type="search"> + </div> + </form> + </nav> + + <section id='main' class="content source"><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> +</pre><pre class='rust '> +<span class='doccomment'>//! Kernel Mode pools.</span> + +<span class='kw'>use</span> ::<span class='ident'>PVOID</span>; + +<span class='kw'>extern</span> <span class='string'>"system"</span> +{ + <span class='doccomment'>/// Allocates pool memory of the specified type and tag.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>ExAllocatePoolWithTag</span>(<span class='ident'>PoolType</span>: <span class='ident'>POOL_TYPE</span>, <span class='ident'>NumberOfBytes</span>: <span class='ident'>usize</span>, <span class='ident'>Tag</span>: <span class='ident'>u32</span>) <span class='op'>-></span> <span class='ident'>PVOID</span>; + <span class='doccomment'>/// Deallocates a block of pool memory allocated with the specified tag.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>ExFreePoolWithTag</span>(<span class='ident'>P</span>: <span class='ident'>PVOID</span>, <span class='ident'>Tag</span>: <span class='ident'>u32</span>); + + <span class='doccomment'>/// Allocates pool memory of the specified type.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>ExAllocatePool</span>(<span class='ident'>PoolType</span>: <span class='ident'>POOL_TYPE</span>, <span class='ident'>NumberOfBytes</span>: <span class='ident'>usize</span>) <span class='op'>-></span> <span class='ident'>PVOID</span>; + <span class='doccomment'>/// Deallocates a block of pool memory.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>ExFreePool</span>(<span class='ident'>P</span>: <span class='ident'>PVOID</span>); +} + + +<span class='doccomment'>/// Specifies the type of system memory to allocate.</span> +<span class='attribute'>#[<span class='ident'>repr</span>(<span class='ident'>C</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>enum</span> <span class='ident'>POOL_TYPE</span> +{ + <span class='doccomment'>/// Nonpageable system memory, can be accessed from any IRQL.</span> + <span class='ident'>NonPagedPool</span> <span class='op'>=</span> <span class='number'>0</span>, + <span class='doccomment'>/// Pageable system memory, can only be allocated and accessed at IRQL < DISPATCH_LEVEL.</span> + <span class='ident'>PagedPool</span>, + <span class='ident'>NonPagedPoolMustSucceed</span>, + <span class='ident'>DontUseThisType</span>, + <span class='doccomment'>/// Nonpaged pool, aligned on processor cache boundaries.</span> + <span class='ident'>NonPagedPoolCacheAligned</span>, + <span class='doccomment'>/// Paged pool, aligned on processor cache boundaries.</span> + <span class='ident'>PagedPoolCacheAligned</span>, + <span class='ident'>NonPagedPoolCacheAlignedMustS</span>, + <span class='ident'>MaxPoolType</span>, + <span class='ident'>NonPagedPoolSession</span> <span class='op'>=</span> <span class='number'>32</span>, + <span class='ident'>PagedPoolSession</span>, + <span class='ident'>NonPagedPoolMustSucceedSession</span>, + <span class='ident'>DontUseThisTypeSession</span>, + <span class='ident'>NonPagedPoolCacheAlignedSession</span>, + <span class='ident'>PagedPoolCacheAlignedSession</span>, + <span class='ident'>NonPagedPoolCacheAlignedMustSSession</span>, +} +</pre> +</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>?</dt> + <dd>Show this help dialog</dd> + <dt>S</dt> + <dd>Focus the search field</dd> + <dt>⇤</dt> + <dd>Move up in search results</dd> + <dt>⇥</dt> + <dd>Move down in search results</dd> + <dt>⏎</dt> + <dd>Go to active search result</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> + </div> + </div> + </aside> + + + + <script> + window.rootPath = "../../"; + window.currentCrate = "km"; + window.playgroundUrl = ""; + </script> + <script src="../../jquery.js"></script> + <script src="../../main.js"></script> + + <script defer src="../../search-index.js"></script> +</body> +</html>
\ No newline at end of file diff --git a/doc/src/km/rtl.rs.html b/doc/src/km/rtl.rs.html new file mode 100644 index 0000000..3fafddb --- /dev/null +++ b/doc/src/km/rtl.rs.html @@ -0,0 +1,130 @@ +<!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 `rtl.rs`."> + <meta name="keywords" content="rust, rustlang, rust-lang"> + + <title>rtl.rs.html -- source</title> + + <link rel="stylesheet" type="text/css" href="../../rustdoc.css"> + <link rel="stylesheet" type="text/css" href="../../main.css"> + + + + +</head> +<body class="rustdoc"> + <!--[if lte IE 8]> + <div class="warning"> + This old browser is unsupported and will most likely display funky + things. + </div> + <![endif]--> + + + + <nav class="sidebar"> + + + </nav> + + <nav class="sub"> + <form class="search-form js-only"> + <div class="search-container"> + <input class="search-input" name="search" + autocomplete="off" + placeholder="Click or press ‘S’ to search, ‘?’ for more options…" + type="search"> + </div> + </form> + </nav> + + <section id='main' class="content source"><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> +</pre><pre class='rust '> +<span class='doccomment'>//! NT runtime routines.</span> + +<span class='kw'>extern</span> <span class='string'>"system"</span> +{ + <span class='doccomment'>/// Returns a random number that was generated from a given `seed` value in the range `[0..MAXLONG-1]`.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>RtlRandom</span>(<span class='ident'>Seed</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>u32</span>) <span class='op'>-></span> <span class='ident'>u32</span>; + <span class='doccomment'>/// Returns a random number that was generated from a given `seed` value in the range `[0..MAXLONG-1]`.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>RtlRandomEx</span>(<span class='ident'>Seed</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>u32</span>) <span class='op'>-></span> <span class='ident'>u32</span>; + <span class='doccomment'>/// A simple uniform random number generator, based on D.H. Lehmer's 1948 alrogithm.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>RtlUniform</span>(<span class='ident'>Seed</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>u32</span>) <span class='op'>-></span> <span class='ident'>u32</span>; +} +</pre> +</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>?</dt> + <dd>Show this help dialog</dd> + <dt>S</dt> + <dd>Focus the search field</dd> + <dt>⇤</dt> + <dd>Move up in search results</dd> + <dt>⇥</dt> + <dd>Move down in search results</dd> + <dt>⏎</dt> + <dd>Go to active search result</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> + </div> + </div> + </aside> + + + + <script> + window.rootPath = "../../"; + window.currentCrate = "km"; + window.playgroundUrl = ""; + </script> + <script src="../../jquery.js"></script> + <script src="../../main.js"></script> + + <script defer src="../../search-index.js"></script> +</body> +</html>
\ No newline at end of file diff --git a/doc/src/km/status.rs.html b/doc/src/km/status.rs.html new file mode 100644 index 0000000..c2fc788 --- /dev/null +++ b/doc/src/km/status.rs.html @@ -0,0 +1,226 @@ +<!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 `status.rs`."> + <meta name="keywords" content="rust, rustlang, rust-lang"> + + <title>status.rs.html -- source</title> + + <link rel="stylesheet" type="text/css" href="../../rustdoc.css"> + <link rel="stylesheet" type="text/css" href="../../main.css"> + + + + +</head> +<body class="rustdoc"> + <!--[if lte IE 8]> + <div class="warning"> + This old browser is unsupported and will most likely display funky + things. + </div> + <![endif]--> + + + + <nav class="sidebar"> + + + </nav> + + <nav class="sub"> + <form class="search-form js-only"> + <div class="search-container"> + <input class="search-input" name="search" + autocomplete="off" + placeholder="Click or press ‘S’ to search, ‘?’ for more options…" + type="search"> + </div> + </form> + </nav> + + <section id='main' class="content source"><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> +</pre><pre class='rust '> +<span class='doccomment'>//! NT Status codes.</span> +<span class='attribute'>#<span class='op'>!</span>[<span class='ident'>allow</span>(<span class='ident'>non_camel_case_types</span>)]</span> +<span class='attribute'>#<span class='op'>!</span>[<span class='ident'>allow</span>(<span class='ident'>overflowing_literals</span>)]</span> + +<span class='doccomment'>/// NT Status type.</span> +<span class='kw'>pub</span> <span class='kw'>type</span> <span class='ident'>NTSTATUS</span> <span class='op'>=</span> <span class='ident'>Status</span>; + +<span class='doccomment'>/// A specialized `Result` type for NT operations.</span> +<span class='kw'>pub</span> <span class='kw'>type</span> <span class='prelude-ty'>Result</span><span class='op'><</span><span class='ident'>T</span><span class='op'>></span> <span class='op'>=</span> ::<span class='ident'>core</span>::<span class='ident'>result</span>::<span class='prelude-ty'>Result</span><span class='op'><</span><span class='ident'>T</span>, <span class='ident'>Status</span><span class='op'>></span>; + + +<span class='doccomment'>/// NT Status code.</span> +<span class='attribute'>#[<span class='ident'>repr</span>(<span class='ident'>C</span>)]</span> +<span class='attribute'>#[<span class='ident'>derive</span>(<span class='ident'>Clone</span>, <span class='ident'>Copy</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>enum</span> <span class='ident'>Status</span> { + <span class='ident'>success</span> <span class='op'>=</span> <span class='number'>0</span>, + <span class='ident'>unsuccessful</span> <span class='op'>=</span> <span class='number'>0xC0000001</span>, +} + +<span class='kw'>impl</span> <span class='ident'>Status</span> { + <span class='doccomment'>/// Evaluates to `true` if the `Status` is a success type (`0..0x3FFFFFFF`)</span> + <span class='doccomment'>/// or an informational type (`0x40000000..0x7FFFFFFF`).</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>is_ok</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>bool</span> { + (<span class='op'>*</span><span class='self'>self</span> <span class='kw'>as</span> <span class='ident'>i32</span>) <span class='op'>>=</span> <span class='number'>0</span> + } + <span class='doccomment'>/// Status is a warning or error type.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>is_err</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>bool</span> { + (<span class='op'>*</span><span class='self'>self</span> <span class='kw'>as</span> <span class='ident'>i32</span>) <span class='op'><</span> <span class='number'>0</span> + } + <span class='doccomment'>/// Status is a success type.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>is_success</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>bool</span> { + <span class='kw'>let</span> <span class='ident'>c</span> <span class='op'>=</span> <span class='op'>*</span><span class='self'>self</span> <span class='kw'>as</span> <span class='ident'>u32</span>; + <span class='ident'>c</span> <span class='op'>></span> <span class='number'>0</span> <span class='op'>&&</span> <span class='ident'>c</span> <span class='op'><</span> <span class='number'>0x3FFF_FFFF</span> + } + <span class='doccomment'>/// Status is a information type.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>is_information</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>bool</span> { + <span class='kw'>let</span> <span class='ident'>c</span> <span class='op'>=</span> <span class='op'>*</span><span class='self'>self</span> <span class='kw'>as</span> <span class='ident'>u32</span>; + <span class='ident'>c</span> <span class='op'>></span> <span class='number'>0x4000_0000</span> <span class='op'>&&</span> <span class='ident'>c</span> <span class='op'><</span> <span class='number'>0x7FFF_FFFF</span> + } + <span class='doccomment'>/// Status is a warning type.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>is_warning</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>bool</span> { + <span class='kw'>let</span> <span class='ident'>c</span> <span class='op'>=</span> <span class='op'>*</span><span class='self'>self</span> <span class='kw'>as</span> <span class='ident'>u32</span>; + <span class='ident'>c</span> <span class='op'>></span> <span class='number'>0x8000_0000</span> <span class='op'>&&</span> <span class='ident'>c</span> <span class='op'><</span> <span class='number'>0xBFFF_FFFF</span> + } + <span class='doccomment'>/// Status is a error type.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>is_error</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>bool</span> { + <span class='kw'>let</span> <span class='ident'>c</span> <span class='op'>=</span> <span class='op'>*</span><span class='self'>self</span> <span class='kw'>as</span> <span class='ident'>u32</span>; + <span class='ident'>c</span> <span class='op'>></span> <span class='number'>0xC000_0000</span> <span class='op'>&&</span> <span class='ident'>c</span> <span class='op'><</span> <span class='number'>0xFFFF_FFFF</span> + } +} + +<span class='doccomment'>/// Convert `Status` to `Result<()>`.</span> +<span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>check</span>(<span class='ident'>st</span>: <span class='ident'>Status</span>) <span class='op'>-></span> <span class='prelude-ty'>Result</span><span class='op'><</span>()<span class='op'>></span> { + <span class='kw'>if</span> <span class='ident'>st</span>.<span class='ident'>is_err</span>() { + <span class='prelude-val'>Err</span>(<span class='ident'>st</span>) + } <span class='kw'>else</span> { + <span class='prelude-val'>Ok</span>(()) + } +} +</pre> +</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>?</dt> + <dd>Show this help dialog</dd> + <dt>S</dt> + <dd>Focus the search field</dd> + <dt>⇤</dt> + <dd>Move up in search results</dd> + <dt>⇥</dt> + <dd>Move down in search results</dd> + <dt>⏎</dt> + <dd>Go to active search result</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> + </div> + </div> + </aside> + + + + <script> + window.rootPath = "../../"; + window.currentCrate = "km"; + window.playgroundUrl = ""; + </script> + <script src="../../jquery.js"></script> + <script src="../../main.js"></script> + + <script defer src="../../search-index.js"></script> +</body> +</html>
\ No newline at end of file diff --git a/doc/src/km/string.rs.html b/doc/src/km/string.rs.html new file mode 100644 index 0000000..df79ed1 --- /dev/null +++ b/doc/src/km/string.rs.html @@ -0,0 +1,298 @@ +<!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 `string.rs`."> + <meta name="keywords" content="rust, rustlang, rust-lang"> + + <title>string.rs.html -- source</title> + + <link rel="stylesheet" type="text/css" href="../../rustdoc.css"> + <link rel="stylesheet" type="text/css" href="../../main.css"> + + + + +</head> +<body class="rustdoc"> + <!--[if lte IE 8]> + <div class="warning"> + This old browser is unsupported and will most likely display funky + things. + </div> + <![endif]--> + + + + <nav class="sidebar"> + + + </nav> + + <nav class="sub"> + <form class="search-form js-only"> + <div class="search-container"> + <input class="search-input" name="search" + autocomplete="off" + placeholder="Click or press ‘S’ to search, ‘?’ for more options…" + type="search"> + </div> + </form> + </nav> + + <section id='main' class="content source"><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> +</pre><pre class='rust '> +<span class='doccomment'>//! Kernel mode string types.</span> + +<span class='kw'>use</span> ::<span class='ident'>NTSTATUS</span>; + +<span class='doccomment'>/// NT native string types.</span> +<span class='kw'>pub</span> <span class='kw'>trait</span> <span class='ident'>NativeString</span> { + <span class='doccomment'>/// Size of string in bytes.</span> + <span class='kw'>fn</span> <span class='ident'>size</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>u16</span>; + <span class='doccomment'>/// Size of buffer in bytes.</span> + <span class='kw'>fn</span> <span class='ident'>max_size</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>u16</span>; + + <span class='doccomment'>/// Check is the string is empty.</span> + <span class='kw'>fn</span> <span class='ident'>is_empty</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>bool</span> { + <span class='self'>self</span>.<span class='ident'>size</span>() <span class='op'>==</span> <span class='number'>0u16</span> + } +} + +<span class='doccomment'>/// A counted Unicode string.</span> +<span class='attribute'>#[<span class='ident'>repr</span>(<span class='ident'>C</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>struct</span> <span class='ident'>UNICODE_STRING</span> +{ + <span class='doccomment'>/// The length in **bytes** of the string stored in `Buffer`.</span> + <span class='kw'>pub</span> <span class='ident'>Length</span>: <span class='ident'>u16</span>, + <span class='doccomment'>/// The length in **bytes** of `Buffer`.</span> + <span class='kw'>pub</span> <span class='ident'>MaximumLength</span>: <span class='ident'>u16</span>, + <span class='doccomment'>/// Pointer to a buffer used to contain a string of wide characters.</span> + <span class='kw'>pub</span> <span class='ident'>Buffer</span>: <span class='op'>*</span><span class='kw'>const</span> <span class='ident'>u16</span>, +} + +<span class='doccomment'>/// A counted string used for ANSI strings.</span> +<span class='attribute'>#[<span class='ident'>repr</span>(<span class='ident'>C</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>struct</span> <span class='ident'>ANSI_STRING</span> +{ + <span class='doccomment'>/// The length in *bytes* of the string stored in `Buffer`.</span> + <span class='kw'>pub</span> <span class='ident'>Length</span>: <span class='ident'>u16</span>, + <span class='doccomment'>/// The length in bytes of `Buffer`.</span> + <span class='kw'>pub</span> <span class='ident'>MaximumLength</span>: <span class='ident'>u16</span>, + <span class='doccomment'>/// Pointer to a buffer used to contain a string of characters.</span> + <span class='kw'>pub</span> <span class='ident'>Buffer</span>: <span class='op'>*</span><span class='kw'>const</span> <span class='ident'>u8</span>, +} + +<span class='kw'>impl</span> <span class='ident'>NativeString</span> <span class='kw'>for</span> <span class='ident'>UNICODE_STRING</span> +{ + <span class='kw'>fn</span> <span class='ident'>size</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>u16</span> { <span class='self'>self</span>.<span class='ident'>Length</span> } + <span class='kw'>fn</span> <span class='ident'>max_size</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>u16</span> { <span class='self'>self</span>.<span class='ident'>MaximumLength</span> } +} + +<span class='kw'>impl</span> <span class='ident'>UNICODE_STRING</span> +{ +} + +<span class='doccomment'>/// Initializes a counted Unicode string.</span> +<span class='kw'>impl</span> <span class='ident'>Default</span> <span class='kw'>for</span> <span class='ident'>UNICODE_STRING</span> { + <span class='kw'>fn</span> <span class='ident'>default</span>() <span class='op'>-></span> <span class='kw'>Self</span> { + <span class='ident'>UNICODE_STRING</span> { <span class='ident'>Length</span>: <span class='number'>0</span>, <span class='ident'>MaximumLength</span>: <span class='number'>0</span>, <span class='ident'>Buffer</span>: ::<span class='ident'>core</span>::<span class='ident'>ptr</span>::<span class='ident'>null</span>() } + } +} + +<span class='kw'>impl</span><span class='op'><</span><span class='lifetime'>'a</span><span class='op'>></span> <span class='ident'>From</span><span class='op'><</span><span class='kw-2'>&</span><span class='lifetime'>'a</span> [<span class='ident'>u8</span>]<span class='op'>></span> <span class='kw'>for</span> <span class='ident'>ANSI_STRING</span> { + <span class='kw'>fn</span> <span class='ident'>from</span>(<span class='ident'>s</span>: <span class='kw-2'>&</span><span class='lifetime'>'a</span> [<span class='ident'>u8</span>]) <span class='op'>-></span> <span class='kw'>Self</span> { + <span class='kw'>let</span> <span class='ident'>len</span> <span class='op'>=</span> <span class='ident'>s</span>.<span class='ident'>len</span>(); + <span class='kw'>let</span> <span class='ident'>n</span> <span class='op'>=</span> <span class='kw'>if</span> <span class='ident'>len</span> <span class='op'>></span> <span class='number'>0</span> <span class='op'>&&</span> <span class='ident'>s</span>[<span class='ident'>len</span><span class='op'>-</span><span class='number'>1</span>] <span class='op'>==</span> <span class='number'>0</span> { <span class='ident'>len</span> <span class='op'>-</span> <span class='number'>1</span> } <span class='kw'>else</span> { <span class='ident'>len</span> }; + <span class='ident'>ANSI_STRING</span> { <span class='ident'>Length</span>: <span class='ident'>n</span> <span class='kw'>as</span> <span class='ident'>u16</span>, <span class='ident'>MaximumLength</span>: <span class='ident'>len</span> <span class='kw'>as</span> <span class='ident'>u16</span>, <span class='ident'>Buffer</span>: <span class='ident'>s</span>.<span class='ident'>as_ptr</span>() } + } +} + + +<span class='kw'>pub</span> <span class='kw'>type</span> <span class='ident'>AnsiString</span> <span class='op'>=</span> <span class='ident'>ANSI_STRING</span>; +<span class='kw'>pub</span> <span class='kw'>type</span> <span class='ident'>UnicodeString</span> <span class='op'>=</span> <span class='ident'>UNICODE_STRING</span>; +<span class='kw'>pub</span> <span class='kw'>type</span> <span class='ident'>CONST_UNICODE_STRING</span> <span class='op'>=</span> <span class='ident'>UNICODE_STRING</span>; +<span class='kw'>pub</span> <span class='kw'>type</span> <span class='ident'>CONST_ANSI_STRING</span> <span class='op'>=</span> <span class='ident'>ANSI_STRING</span>; + + + +<span class='kw'>extern</span> <span class='string'>"system"</span> +{ + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>RtlIntegerToUnicodeString</span>(<span class='ident'>Value</span>: <span class='ident'>u32</span>, <span class='ident'>Base</span>: <span class='ident'>u32</span>, <span class='ident'>String</span>: <span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>UNICODE_STRING</span>) <span class='op'>-></span> <span class='ident'>NTSTATUS</span>; + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>RtlInt64ToUnicodeString</span>(<span class='ident'>Value</span>: <span class='ident'>u64</span>, <span class='ident'>Base</span>: <span class='ident'>u32</span>, <span class='ident'>String</span>: <span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>UNICODE_STRING</span>) <span class='op'>-></span> <span class='ident'>NTSTATUS</span>; + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>RtlUnicodeStringToInteger</span>(<span class='ident'>String</span>: <span class='kw-2'>&</span><span class='ident'>CONST_UNICODE_STRING</span>, <span class='ident'>Base</span>: <span class='ident'>u32</span>, <span class='ident'>Value</span>: <span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>u32</span>) <span class='op'>-></span> <span class='ident'>NTSTATUS</span>; + + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>RtlUnicodeStringToAnsiString</span>(<span class='ident'>DestinationString</span>: <span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>ANSI_STRING</span>, <span class='ident'>SourceString</span>: <span class='kw-2'>&</span><span class='ident'>CONST_UNICODE_STRING</span>, <span class='ident'>AllocateDestination</span>: <span class='ident'>bool</span>) <span class='op'>-></span> <span class='ident'>NTSTATUS</span>; + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>RtlUnicodeStringToAnsiSize</span>(<span class='ident'>SourceString</span>: <span class='kw-2'>&</span><span class='ident'>CONST_UNICODE_STRING</span>) <span class='op'>-></span> <span class='ident'>u32</span>; + + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>RtlAnsiStringToUnicodeString</span>(<span class='ident'>DestinationString</span>: <span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>UNICODE_STRING</span>, <span class='ident'>SourceString</span>: <span class='kw-2'>&</span><span class='ident'>CONST_ANSI_STRING</span>, <span class='ident'>AllocateDestination</span>: <span class='ident'>bool</span>) <span class='op'>-></span> <span class='ident'>NTSTATUS</span>; + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>RtlAnsiStringToUnicodeSize</span>(<span class='ident'>SourceString</span>: <span class='kw-2'>&</span><span class='ident'>CONST_ANSI_STRING</span>) <span class='op'>-></span> <span class='ident'>u32</span>; + + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>RtlCompareUnicodeString</span> (<span class='ident'>String1</span>: <span class='kw-2'>&</span><span class='ident'>CONST_UNICODE_STRING</span>, <span class='ident'>String2</span>: <span class='kw-2'>&</span><span class='ident'>CONST_UNICODE_STRING</span>, <span class='ident'>CaseInSensitive</span>: <span class='ident'>bool</span>) <span class='op'>-></span> <span class='ident'>i32</span>; + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>RtlCompareString</span> (<span class='ident'>String1</span>: <span class='kw-2'>&</span><span class='ident'>CONST_ANSI_STRING</span>, <span class='ident'>String2</span>: <span class='kw-2'>&</span><span class='ident'>CONST_ANSI_STRING</span>, <span class='ident'>CaseInSensitive</span>: <span class='ident'>bool</span>) <span class='op'>-></span> <span class='ident'>i32</span>; + + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>RtlEqualUnicodeString</span>(<span class='ident'>String1</span>: <span class='kw-2'>&</span><span class='ident'>CONST_UNICODE_STRING</span>, <span class='ident'>String2</span>: <span class='kw-2'>&</span><span class='ident'>CONST_UNICODE_STRING</span>) <span class='op'>-></span> <span class='ident'>bool</span>; + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>RtlEqualString</span>(<span class='ident'>String1</span>: <span class='kw-2'>&</span><span class='ident'>CONST_ANSI_STRING</span>, <span class='ident'>String2</span>: <span class='kw-2'>&</span><span class='ident'>CONST_ANSI_STRING</span>) <span class='op'>-></span> <span class='ident'>bool</span>; + + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>RtlFreeAnsiString</span>(<span class='ident'>UnicodeString</span>: <span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>ANSI_STRING</span>); + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>RtlFreeUnicodeString</span>(<span class='ident'>UnicodeString</span>: <span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>UNICODE_STRING</span>); +} +</pre> +</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>?</dt> + <dd>Show this help dialog</dd> + <dt>S</dt> + <dd>Focus the search field</dd> + <dt>⇤</dt> + <dd>Move up in search results</dd> + <dt>⇥</dt> + <dd>Move down in search results</dd> + <dt>⏎</dt> + <dd>Go to active search result</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> + </div> + </div> + </aside> + + + + <script> + window.rootPath = "../../"; + window.currentCrate = "km"; + window.playgroundUrl = ""; + </script> + <script src="../../jquery.js"></script> + <script src="../../main.js"></script> + + <script defer src="../../search-index.js"></script> +</body> +</html>
\ No newline at end of file diff --git a/doc/src/km/time.rs.html b/doc/src/km/time.rs.html new file mode 100644 index 0000000..2476c7d --- /dev/null +++ b/doc/src/km/time.rs.html @@ -0,0 +1,160 @@ +<!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 `time.rs`."> + <meta name="keywords" content="rust, rustlang, rust-lang"> + + <title>time.rs.html -- source</title> + + <link rel="stylesheet" type="text/css" href="../../rustdoc.css"> + <link rel="stylesheet" type="text/css" href="../../main.css"> + + + + +</head> +<body class="rustdoc"> + <!--[if lte IE 8]> + <div class="warning"> + This old browser is unsupported and will most likely display funky + things. + </div> + <![endif]--> + + + + <nav class="sidebar"> + + + </nav> + + <nav class="sub"> + <form class="search-form js-only"> + <div class="search-container"> + <input class="search-input" name="search" + autocomplete="off" + placeholder="Click or press ‘S’ to search, ‘?’ for more options…" + type="search"> + </div> + </form> + </nav> + + <section id='main' class="content source"><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> +</pre><pre class='rust '> +<span class='doccomment'>//! NT Time routines.</span> + +<span class='doccomment'>/// System time is a count of 100-nanosecond intervals since January 1, 1601.</span> +<span class='kw'>pub</span> <span class='kw'>type</span> <span class='ident'>SYSTEMTIME</span> <span class='op'>=</span> <span class='ident'>i64</span>; + +<span class='kw'>extern</span> <span class='string'>"system"</span> +{ + <span class='kw'>fn</span> <span class='ident'>KeQuerySystemTime</span>(<span class='ident'>CurrentTime</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>SYSTEMTIME</span>); + <span class='kw'>fn</span> <span class='ident'>KeQueryTickCount</span>(<span class='ident'>TickCount</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>i64</span>); + <span class='doccomment'>/// Converts a GMT system time value to the local system time for the current time zone.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>ExSystemTimeToLocalTime</span>(<span class='ident'>SystemTime</span>: <span class='op'>*</span><span class='kw'>const</span> <span class='ident'>SYSTEMTIME</span>, <span class='ident'>LocalTime</span>: <span class='op'>*</span><span class='kw-2'>mut</span> <span class='ident'>SYSTEMTIME</span>); +} + +<span class='doccomment'>/// Obtains the current system time.</span> +<span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>QuerySystemTime</span>() <span class='op'>-></span> <span class='ident'>SYSTEMTIME</span> { + <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>t</span> <span class='op'>=</span> <span class='number'>0i64</span>; + <span class='kw'>unsafe</span> { <span class='ident'>KeQuerySystemTime</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>t</span>) }; + <span class='kw'>return</span> <span class='ident'>t</span>; +} + +<span class='doccomment'>/// A count of the interval timer interrupts that have occurred since the system was booted.</span> +<span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>QueryTickCount</span>() <span class='op'>-></span> <span class='ident'>i64</span> { + <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>t</span> <span class='op'>=</span> <span class='number'>0i64</span>; + <span class='kw'>unsafe</span> { <span class='ident'>KeQueryTickCount</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>t</span>) }; + <span class='kw'>return</span> <span class='ident'>t</span>; +} +</pre> +</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>?</dt> + <dd>Show this help dialog</dd> + <dt>S</dt> + <dd>Focus the search field</dd> + <dt>⇤</dt> + <dd>Move up in search results</dd> + <dt>⇥</dt> + <dd>Move down in search results</dd> + <dt>⏎</dt> + <dd>Go to active search result</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> + </div> + </div> + </aside> + + + + <script> + window.rootPath = "../../"; + window.currentCrate = "km"; + window.playgroundUrl = ""; + </script> + <script src="../../jquery.js"></script> + <script src="../../main.js"></script> + + <script defer src="../../search-index.js"></script> +</body> +</html>
\ No newline at end of file |