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

34 lines
11 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 `cranelift_codegen` crate."><meta name="keywords" content="rust, rustlang, rust-lang, cranelift_codegen"><title>cranelift_codegen - 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'>Crate cranelift_codegen</p><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all cranelift_codegen's items</p></a><div class="block items"><ul><li><a href="#reexports">Re-exports</a></li><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#constants">Constants</a></li><li><a href="#functions">Functions</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'cranelift_codegen', 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/cranelift_codegen/lib.rs.html#1-112' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>cranelift_codegen</a></span></h1><div class='docblock'><p>Cranelift code generation library.</p>
</div><h2 id='reexports' class='section-header'><a href="#reexports">Re-exports</a></h2>
<table><tr><td><code>pub use crate::verifier::<a class="fn" href="../cranelift_codegen/verifier/fn.verify_function.html" title="fn cranelift_codegen::verifier::verify_function">verify_function</a>;</code></td></tr><tr><td><code>pub use crate::write::<a class="fn" href="../cranelift_codegen/write/fn.write_function.html" title="fn cranelift_codegen::write::write_function">write_function</a>;</code></td></tr><tr><td><code>pub use <a class="mod" href="../cranelift_bforest/index.html" title="mod cranelift_bforest">cranelift_bforest</a> as bforest;</code></td></tr><tr><td><code>pub use <a class="mod" href="../cranelift_entity/index.html" title="mod cranelift_entity">cranelift_entity</a> as entity;</code></td></tr></table><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
<table><tr class='module-item'><td><a class="mod" href="binemit/index.html" title='cranelift_codegen::binemit mod'>binemit</a></td><td class='docblock-short'><p>Binary machine code emission.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="cfg_printer/index.html" title='cranelift_codegen::cfg_printer mod'>cfg_printer</a></td><td class='docblock-short'><p>The <code>CFGPrinter</code> utility.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="cursor/index.html" title='cranelift_codegen::cursor mod'>cursor</a></td><td class='docblock-short'><p>Cursor library.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="dbg/index.html" title='cranelift_codegen::dbg mod'>dbg</a></td><td class='docblock-short'><p>Debug tracing helpers.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="dominator_tree/index.html" title='cranelift_codegen::dominator_tree mod'>dominator_tree</a></td><td class='docblock-short'><p>A Dominator Tree represented as mappings of Ebbs to their immediate dominator.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="flowgraph/index.html" title='cranelift_codegen::flowgraph mod'>flowgraph</a></td><td class='docblock-short'><p>A control flow graph represented as mappings of extended basic blocks to their predecessors
and successors.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="ir/index.html" title='cranelift_codegen::ir mod'>ir</a></td><td class='docblock-short'><p>Representation of Cranelift IR functions.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="isa/index.html" title='cranelift_codegen::isa mod'>isa</a></td><td class='docblock-short'><p>Instruction Set Architectures.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="loop_analysis/index.html" title='cranelift_codegen::loop_analysis mod'>loop_analysis</a></td><td class='docblock-short'><p>A loop analysis represented as mappings of loops to their header Ebb
and parent in the loop tree.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="packed_option/index.html" title='cranelift_codegen::packed_option mod'>packed_option</a></td><td class='docblock-short'><p>Compact representation of <code>Option&lt;T&gt;</code> for types with a reserved value.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="print_errors/index.html" title='cranelift_codegen::print_errors mod'>print_errors</a></td><td class='docblock-short'><p>Utility routines for pretty-printing error messages.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="settings/index.html" title='cranelift_codegen::settings mod'>settings</a></td><td class='docblock-short'><p>Shared settings module.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="timing/index.html" title='cranelift_codegen::timing mod'>timing</a></td><td class='docblock-short'><p>Pass timing.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="verifier/index.html" title='cranelift_codegen::verifier mod'>verifier</a></td><td class='docblock-short'><p>A verifier for ensuring that functions are well formed.
It verifies:</p>
</td></tr><tr class='module-item'><td><a class="mod" href="write/index.html" title='cranelift_codegen::write mod'>write</a></td><td class='docblock-short'><p>Converting Cranelift IR to text.</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.Context.html" title='cranelift_codegen::Context struct'>Context</a></td><td class='docblock-short'><p>Persistent data structures and compilation pipeline.</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.ValueLocRange.html" title='cranelift_codegen::ValueLocRange struct'>ValueLocRange</a></td><td class='docblock-short'><p>Value location range.</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.CodegenError.html" title='cranelift_codegen::CodegenError enum'>CodegenError</a></td><td class='docblock-short'><p>A compilation error.</p>
</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.VERSION.html" title='cranelift_codegen::VERSION constant'>VERSION</a></td><td class='docblock-short'><p>Version number of this crate.</p>
</td></tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
<table><tr class='module-item'><td><a class="fn" href="fn.legalize_function.html" title='cranelift_codegen::legalize_function fn'>legalize_function</a></td><td class='docblock-short'><p>Legalize <code>func</code> for <code>isa</code>.</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.CodegenResult.html" title='cranelift_codegen::CodegenResult type'>CodegenResult</a></td><td class='docblock-short'><p>A convenient alias for a <code>Result</code> that uses <code>CodegenError</code> as the error type.</p>
</td></tr><tr class='module-item'><td><a class="type" href="type.ValueLabelsRanges.html" title='cranelift_codegen::ValueLabelsRanges type'>ValueLabelsRanges</a></td><td class='docblock-short'><p>Resulting map of Value labels and their ranges/locations.</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>