mirror of
https://github.com/fluencelabs/wasmer
synced 2025-04-30 12:52:14 +00:00
30 lines
8.4 KiB
HTML
30 lines
8.4 KiB
HTML
<!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 `entities` mod in crate `cranelift_codegen`."><meta name="keywords" content="rust, rustlang, rust-lang, entities"><title>cranelift_codegen::ir::entities - 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">☰</div><a href='../../../cranelift_codegen/index.html'><div class='logo-container'><img src='../../../rust-logo.png' alt='logo'></div></a><p class='location'>Module entities</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></div><p class='location'><a href='../../index.html'>cranelift_codegen</a>::<wbr><a href='../index.html'>ir</a></p><script>window.sidebarCurrent = {name: 'entities', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></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'>−</span>]</a></span><a class='srclink' href='../../../src/cranelift_codegen/ir/entities.rs.html#1-330' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../../index.html'>cranelift_codegen</a>::<wbr><a href='../index.html'>ir</a>::<wbr><a class="mod" href=''>entities</a></span></h1><div class='docblock'><p>Cranelift IR entity references.</p>
|
||
<p>Instructions in Cranelift IR need to reference other entities in the function. This can be other
|
||
parts of the function like extended basic blocks or stack slots, or it can be external entities
|
||
that are declared in the function preamble in the text format.</p>
|
||
<p>These entity references in instruction operands are not implemented as Rust references both
|
||
because Rust's ownership and mutability rules make it difficult, and because 64-bit pointers
|
||
take up a lot of space, and we want a compact in-memory representation. Instead, entity
|
||
references are structs wrapping a <code>u32</code> index into a table in the <code>Function</code> main data
|
||
structure. There is a separate index type for each entity type, so we don't lose type safety.</p>
|
||
<p>The <code>entities</code> module defines public types for the entity references along with constants
|
||
representing an invalid reference. We prefer to use <code>Option<EntityRef></code> whenever possible, but
|
||
unfortunately that type is twice as large as the 32-bit index type on its own. Thus, compact
|
||
data structures use the <code>PackedOption<EntityRef></code> representation, while function arguments and
|
||
return values prefer the more Rust-like <code>Option<EntityRef></code> variant.</p>
|
||
<p>The entity references all implement the <code>Display</code> trait in a way that matches the textual IR
|
||
format.</p>
|
||
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
||
<table><tr class='module-item'><td><a class="struct" href="struct.Ebb.html" title='cranelift_codegen::ir::entities::Ebb struct'>Ebb</a></td><td class='docblock-short'><p>An opaque reference to an extended basic block in a function.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.FuncRef.html" title='cranelift_codegen::ir::entities::FuncRef struct'>FuncRef</a></td><td class='docblock-short'><p>A reference to an external function.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.GlobalValue.html" title='cranelift_codegen::ir::entities::GlobalValue struct'>GlobalValue</a></td><td class='docblock-short'><p>An opaque reference to a global value.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Heap.html" title='cranelift_codegen::ir::entities::Heap struct'>Heap</a></td><td class='docblock-short'><p>A reference to a heap.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Inst.html" title='cranelift_codegen::ir::entities::Inst struct'>Inst</a></td><td class='docblock-short'><p>An opaque reference to an instruction in a function.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.JumpTable.html" title='cranelift_codegen::ir::entities::JumpTable struct'>JumpTable</a></td><td class='docblock-short'><p>An opaque reference to a jump table.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.SigRef.html" title='cranelift_codegen::ir::entities::SigRef struct'>SigRef</a></td><td class='docblock-short'><p>A reference to a function signature.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.StackSlot.html" title='cranelift_codegen::ir::entities::StackSlot struct'>StackSlot</a></td><td class='docblock-short'><p>An opaque reference to a stack slot.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Table.html" title='cranelift_codegen::ir::entities::Table struct'>Table</a></td><td class='docblock-short'><p>A reference to a table.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Value.html" title='cranelift_codegen::ir::entities::Value struct'>Value</a></td><td class='docblock-short'><p>An opaque reference to an SSA value.</p>
|
||
</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.AnyEntity.html" title='cranelift_codegen::ir::entities::AnyEntity enum'>AnyEntity</a></td><td class='docblock-short'><p>A reference to any of the entities defined in this module.</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>⏎</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 = "cranelift_codegen";</script><script src="../../../aliases.js"></script><script src="../../../main.js"></script><script defer src="../../../search-index.js"></script></body></html> |