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