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/km/irp.rs.html | |
| 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/km/irp.rs.html')
| -rw-r--r-- | doc/src/km/irp.rs.html | 476 |
1 files changed, 476 insertions, 0 deletions
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 |