wasmer/rustdoc/raw_cpuid/index.html
2019-09-06 15:57:44 -07:00

27 lines
14 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="API documentation for the Rust `raw_cpuid` crate."><meta name="keywords" content="rust, rustlang, rust-lang, raw_cpuid"><title>raw_cpuid - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../raw_cpuid/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Crate raw_cpuid</p><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all raw_cpuid's items</p></a><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#macros">Macros</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#constants">Constants</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'raw_cpuid', ty: 'mod', relpath: '../'};</script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"></div><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>&#x2212;</span>]</a></span><a class='srclink' href='../src/raw_cpuid/lib.rs.html#1-4260' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>raw_cpuid</a></span></h1><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
<table><tr class='module-item'><td><a class="mod" href="native_cpuid/index.html" title='raw_cpuid::native_cpuid mod'>native_cpuid</a></td><td class='docblock-short'><p>Uses Rust's <code>cpuid</code> function from the <code>arch</code> module.</p>
</td></tr></table><h2 id='macros' class='section-header'><a href="#macros">Macros</a></h2>
<table><tr class='module-item'><td><a class="macro" href="macro.cpuid.html" title='raw_cpuid::cpuid macro'>cpuid</a></td><td class='docblock-short'><p>Macro which queries cpuid directly.</p>
</td></tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table><tr class='module-item'><td><a class="struct" href="struct.CacheInfo.html" title='raw_cpuid::CacheInfo struct'>CacheInfo</a></td><td class='docblock-short'><p>Describes any kind of cache (TLB, Data and Instruction caches plus prefetchers).</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.CacheInfoIter.html" title='raw_cpuid::CacheInfoIter struct'>CacheInfoIter</a></td><td class='docblock-short'><p>Used to iterate over cache information contained in cpuid instruction.</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.CacheParameter.html" title='raw_cpuid::CacheParameter struct'>CacheParameter</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.CacheParametersIter.html" title='raw_cpuid::CacheParametersIter struct'>CacheParametersIter</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.CpuId.html" title='raw_cpuid::CpuId struct'>CpuId</a></td><td class='docblock-short'><p>Main type used to query for information about the CPU we're running on.</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.CpuIdResult.html" title='raw_cpuid::CpuIdResult struct'>CpuIdResult</a></td><td class='docblock-short'><p>Low-level data-structure to store result of cpuid instruction.</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.DatInfo.html" title='raw_cpuid::DatInfo struct'>DatInfo</a></td><td class='docblock-short'><p>Deterministic Address Translation Structure</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.DatIter.html" title='raw_cpuid::DatIter struct'>DatIter</a></td><td class='docblock-short'><p>Deterministic Address Translation Structure Iterator</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.DirectCacheAccessInfo.html" title='raw_cpuid::DirectCacheAccessInfo struct'>DirectCacheAccessInfo</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.EpcSection.html" title='raw_cpuid::EpcSection struct'>EpcSection</a></td><td class='docblock-short'><p>EBX:EAX and EDX:ECX provide information on the Enclave Page Cache (EPC) section</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.ExtendedFeatures.html" title='raw_cpuid::ExtendedFeatures struct'>ExtendedFeatures</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.ExtendedFunctionInfo.html" title='raw_cpuid::ExtendedFunctionInfo struct'>ExtendedFunctionInfo</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.ExtendedState.html" title='raw_cpuid::ExtendedState struct'>ExtendedState</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.ExtendedStateInfo.html" title='raw_cpuid::ExtendedStateInfo struct'>ExtendedStateInfo</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.ExtendedStateIter.html" title='raw_cpuid::ExtendedStateIter struct'>ExtendedStateIter</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.ExtendedTopologyIter.html" title='raw_cpuid::ExtendedTopologyIter struct'>ExtendedTopologyIter</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.ExtendedTopologyLevel.html" title='raw_cpuid::ExtendedTopologyLevel struct'>ExtendedTopologyLevel</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.FeatureInfo.html" title='raw_cpuid::FeatureInfo struct'>FeatureInfo</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.HypervisorInfo.html" title='raw_cpuid::HypervisorInfo struct'>HypervisorInfo</a></td><td class='docblock-short'><p>Information about Hypervisor (https://lwn.net/Articles/301888/)</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.L2CatInfo.html" title='raw_cpuid::L2CatInfo struct'>L2CatInfo</a></td><td class='docblock-short'><p>L2 Cache Allocation Technology Enumeration Sub-leaf (EAX = 10H, ECX = ResID = 2).</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.L3MonitoringInfo.html" title='raw_cpuid::L3MonitoringInfo struct'>L3MonitoringInfo</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.L3CatInfo.html" title='raw_cpuid::L3CatInfo struct'>L3CatInfo</a></td><td class='docblock-short'><p>L3 Cache Allocation Technology Enumeration Sub-leaf (EAX = 10H, ECX = ResID = 1).</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.MemBwAllocationInfo.html" title='raw_cpuid::MemBwAllocationInfo struct'>MemBwAllocationInfo</a></td><td class='docblock-short'><p>Memory Bandwidth Allocation Enumeration Sub-leaf (EAX = 10H, ECX = ResID = 3).</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.MonitorMwaitInfo.html" title='raw_cpuid::MonitorMwaitInfo struct'>MonitorMwaitInfo</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.PerformanceMonitoringInfo.html" title='raw_cpuid::PerformanceMonitoringInfo struct'>PerformanceMonitoringInfo</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.ProcessorFrequencyInfo.html" title='raw_cpuid::ProcessorFrequencyInfo struct'>ProcessorFrequencyInfo</a></td><td class='docblock-short'><p>Processor Frequency Information</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.ProcessorSerial.html" title='raw_cpuid::ProcessorSerial struct'>ProcessorSerial</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.ProcessorTraceInfo.html" title='raw_cpuid::ProcessorTraceInfo struct'>ProcessorTraceInfo</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.RdtAllocationInfo.html" title='raw_cpuid::RdtAllocationInfo struct'>RdtAllocationInfo</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.RdtMonitoringInfo.html" title='raw_cpuid::RdtMonitoringInfo struct'>RdtMonitoringInfo</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.SgxInfo.html" title='raw_cpuid::SgxInfo struct'>SgxInfo</a></td><td class='docblock-short'><p>Intel SGX Capability Enumeration Leaf, sub-leaf 0 (EAX = 12H, ECX = 0 and ECX = 1)</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.SgxSectionIter.html" title='raw_cpuid::SgxSectionIter struct'>SgxSectionIter</a></td><td class='docblock-short'><p>Iterator over the SGX sub-leafs (ECX &gt;= 2).</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.SoCVendorAttributesIter.html" title='raw_cpuid::SoCVendorAttributesIter struct'>SoCVendorAttributesIter</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.SoCVendorBrand.html" title='raw_cpuid::SoCVendorBrand struct'>SoCVendorBrand</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.SoCVendorInfo.html" title='raw_cpuid::SoCVendorInfo struct'>SoCVendorInfo</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.ThermalPowerInfo.html" title='raw_cpuid::ThermalPowerInfo struct'>ThermalPowerInfo</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.TscInfo.html" title='raw_cpuid::TscInfo struct'>TscInfo</a></td><td class='docblock-short'><p>Time Stamp Counter and Nominal Core Crystal Clock Information Leaf.</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.VendorInfo.html" title='raw_cpuid::VendorInfo struct'>VendorInfo</a></td><td class='docblock-short'></td></tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
<table><tr class='module-item'><td><a class="enum" href="enum.CacheInfoType.html" title='raw_cpuid::CacheInfoType enum'>CacheInfoType</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="enum" href="enum.CacheType.html" title='raw_cpuid::CacheType enum'>CacheType</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="enum" href="enum.DatType.html" title='raw_cpuid::DatType enum'>DatType</a></td><td class='docblock-short'><p>Deterministic Address Translation cache type (EDX bits 04 -- 00)</p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.Hypervisor.html" title='raw_cpuid::Hypervisor enum'>Hypervisor</a></td><td class='docblock-short'><p>Identifies the different Hypervisor products.</p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.L2Associativity.html" title='raw_cpuid::L2Associativity enum'>L2Associativity</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="enum" href="enum.SgxSectionInfo.html" title='raw_cpuid::SgxSectionInfo enum'>SgxSectionInfo</a></td><td class='docblock-short'><p>Intel SGX EPC Enumeration Leaf, sub-leaves (EAX = 12H, ECX = 2 or higher)</p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.TopologyType.html" title='raw_cpuid::TopologyType enum'>TopologyType</a></td><td class='docblock-short'></td></tr></table><h2 id='constants' class='section-header'><a href="#constants">Constants</a></h2>
<table><tr class='module-item'><td><a class="constant" href="constant.CACHE_INFO_TABLE.html" title='raw_cpuid::CACHE_INFO_TABLE constant'>CACHE_INFO_TABLE</a></td><td class='docblock-short'><p>This table is taken from Intel manual (Section CPUID instruction).</p>
</td></tr></table></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><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd></kbd></dt><dd>Move up in search results</dd><dt><kbd></kbd></dt><dd>Move down in search results</dd><dt><kbd></kbd></dt><dd>Switch tab</dd><dt><kbd>&#9166;</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</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><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "raw_cpuid";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>