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

24 lines
8.5 KiB
HTML
Raw 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 `binemit` mod in crate `cranelift_codegen`."><meta name="keywords" content="rust, rustlang, rust-lang, binemit"><title>cranelift_codegen::binemit - 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 binemit</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="#traits">Traits</a></li><li><a href="#functions">Functions</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'><a href='../index.html'>cranelift_codegen</a></p><script>window.sidebarCurrent = {name: 'binemit', 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/binemit/mod.rs.html#1-186' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../index.html'>cranelift_codegen</a>::<wbr><a class="mod" href=''>binemit</a></span></h1><div class='docblock'><p>Binary machine code emission.</p>
<p>The <code>binemit</code> module contains code for translating Cranelift's intermediate representation into
binary machine code.</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.CodeInfo.html" title='cranelift_codegen::binemit::CodeInfo struct'>CodeInfo</a></td><td class='docblock-short'><p>Container for information about a vector of compiled code and its supporting read-only data.</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.MemoryCodeSink.html" title='cranelift_codegen::binemit::MemoryCodeSink struct'>MemoryCodeSink</a></td><td class='docblock-short'><p>A <code>CodeSink</code> that writes binary machine code directly into memory.</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.NullTrapSink.html" title='cranelift_codegen::binemit::NullTrapSink struct'>NullTrapSink</a></td><td class='docblock-short'><p>A <code>TrapSink</code> implementation that does nothing, which is convenient when
compiling code that does not rely on trapping semantics.</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.RegDiversions.html" title='cranelift_codegen::binemit::RegDiversions struct'>RegDiversions</a></td><td class='docblock-short'><p>Keep track of diversions in an EBB.</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.Reloc.html" title='cranelift_codegen::binemit::Reloc enum'>Reloc</a></td><td class='docblock-short'><p>Relocation kinds for every ISA</p>
</td></tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
<table><tr class='module-item'><td><a class="trait" href="trait.CodeSink.html" title='cranelift_codegen::binemit::CodeSink trait'>CodeSink</a></td><td class='docblock-short'><p>Abstract interface for adding bytes to the code segment.</p>
</td></tr><tr class='module-item'><td><a class="trait" href="trait.RelocSink.html" title='cranelift_codegen::binemit::RelocSink trait'>RelocSink</a></td><td class='docblock-short'><p>A trait for receiving relocations for code that is emitted directly into memory.</p>
</td></tr><tr class='module-item'><td><a class="trait" href="trait.TrapSink.html" title='cranelift_codegen::binemit::TrapSink trait'>TrapSink</a></td><td class='docblock-short'><p>A trait for receiving trap codes and offsets.</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.bad_encoding.html" title='cranelift_codegen::binemit::bad_encoding fn'>bad_encoding</a></td><td class='docblock-short'><p>Report a bad encoding error.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.emit_function.html" title='cranelift_codegen::binemit::emit_function fn'>emit_function</a></td><td class='docblock-short'><p>Emit a function to <code>sink</code>, given an instruction emitter function.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.relax_branches.html" title='cranelift_codegen::binemit::relax_branches fn'>relax_branches</a></td><td class='docblock-short'><p>Relax branches and compute the final layout of EBB headers in <code>func</code>.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.shrink_instructions.html" title='cranelift_codegen::binemit::shrink_instructions fn'>shrink_instructions</a></td><td class='docblock-short'><p>Pick the smallest valid encodings for instructions.</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.Addend.html" title='cranelift_codegen::binemit::Addend type'>Addend</a></td><td class='docblock-short'><p>Addend to add to the symbol value.</p>
</td></tr><tr class='module-item'><td><a class="type" href="type.CodeOffset.html" title='cranelift_codegen::binemit::CodeOffset type'>CodeOffset</a></td><td class='docblock-short'><p>Offset in bytes from the beginning of the function.</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>