2019-09-06 15:57:44 -07:00

22 lines
8.0 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 `instructions` mod in crate `cranelift_codegen`."><meta name="keywords" content="rust, rustlang, rust-lang, instructions"><title>cranelift_codegen::ir::instructions - 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='../../../cranelift_codegen/index.html'><div class='logo-container'><img src='../../../rust-logo.png' alt='logo'></div></a><p class='location'>Module instructions</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#types">Type Definitions</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: 'instructions', 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'>&#x2212;</span>]</a></span><a class='srclink' href='../../../src/cranelift_codegen/ir/instructions.rs.html#1-702' 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=''>instructions</a></span></h1><div class='docblock'><p>Instruction formats and opcodes.</p>
<p>The <code>instructions</code> module contains definitions for instruction formats, opcodes, and the
in-memory representation of IR instructions.</p>
<p>A large part of this module is auto-generated from the instruction descriptions in the meta
directory.</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.OpcodeConstraints.html" title='cranelift_codegen::ir::instructions::OpcodeConstraints struct'>OpcodeConstraints</a></td><td class='docblock-short'><p>Value type constraints for a given opcode.</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.ValueTypeSet.html" title='cranelift_codegen::ir::instructions::ValueTypeSet struct'>ValueTypeSet</a></td><td class='docblock-short'><p>A value type set describes the permitted set of types for a type variable.</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.VariableArgs.html" title='cranelift_codegen::ir::instructions::VariableArgs struct'>VariableArgs</a></td><td class='docblock-short'><p>A variable list of <code>Value</code> operands used for function call arguments and passing arguments to
basic blocks.</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.BranchInfo.html" title='cranelift_codegen::ir::instructions::BranchInfo enum'>BranchInfo</a></td><td class='docblock-short'><p>Information about branch and jump instructions.</p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.CallInfo.html" title='cranelift_codegen::ir::instructions::CallInfo enum'>CallInfo</a></td><td class='docblock-short'><p>Information about call instructions.</p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.InstructionData.html" title='cranelift_codegen::ir::instructions::InstructionData enum'>InstructionData</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="enum" href="enum.InstructionFormat.html" title='cranelift_codegen::ir::instructions::InstructionFormat enum'>InstructionFormat</a></td><td class='docblock-short'><p>An instruction format</p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.Opcode.html" title='cranelift_codegen::ir::instructions::Opcode enum'>Opcode</a></td><td class='docblock-short'><p>An instruction opcode.</p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.ResolvedConstraint.html" title='cranelift_codegen::ir::instructions::ResolvedConstraint enum'>ResolvedConstraint</a></td><td class='docblock-short'><p>The type constraint on a value argument once the controlling type variable is known.</p>
</td></tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
<table><tr class='module-item'><td><a class="type" href="type.ValueList.html" title='cranelift_codegen::ir::instructions::ValueList type'>ValueList</a></td><td class='docblock-short'><p>Some instructions use an external list of argument values because there is not enough space in
the 16-byte <code>InstructionData</code> struct. These value lists are stored in a memory pool in
<code>dfg.value_lists</code>.</p>
</td></tr><tr class='module-item'><td><a class="type" href="type.ValueListPool.html" title='cranelift_codegen::ir::instructions::ValueListPool type'>ValueListPool</a></td><td class='docblock-short'><p>Memory pool for holding value lists. See <code>ValueList</code>.</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 = "cranelift_codegen";</script><script src="../../../aliases.js"></script><script src="../../../main.js"></script><script defer src="../../../search-index.js"></script></body></html>