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

29 lines
6.4 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 `flowgraph` mod in crate `cranelift_codegen`."><meta name="keywords" content="rust, rustlang, rust-lang, flowgraph"><title>cranelift_codegen::flowgraph - 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 flowgraph</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</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: 'flowgraph', 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/flowgraph.rs.html#1-350' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../index.html'>cranelift_codegen</a>::<wbr><a class="mod" href=''>flowgraph</a></span></h1><div class='docblock'><p>A control flow graph represented as mappings of extended basic blocks to their predecessors
and successors.</p>
<p>Successors are represented as extended basic blocks while predecessors are represented by basic
blocks. Basic blocks are denoted by tuples of EBB and branch/jump instructions. Each
predecessor tuple corresponds to the end of a basic block.</p>
<pre><code class="language-c"> Ebb0:
... ; beginning of basic block
...
brz vx, Ebb1 ; end of basic block
... ; beginning of basic block
...
jmp Ebb2 ; end of basic block
</code></pre>
<p>Here <code>Ebb1</code> and <code>Ebb2</code> would each have a single predecessor denoted as <code>(Ebb0, brz)</code>
and <code>(Ebb0, jmp Ebb2)</code> respectively.</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.BasicBlock.html" title='cranelift_codegen::flowgraph::BasicBlock struct'>BasicBlock</a></td><td class='docblock-short'><p>A basic block denoted by its enclosing Ebb and last instruction.</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.ControlFlowGraph.html" title='cranelift_codegen::flowgraph::ControlFlowGraph struct'>ControlFlowGraph</a></td><td class='docblock-short'><p>The Control Flow Graph maintains a mapping of ebbs to their predecessors
and successors where predecessors are basic blocks and successors are
extended basic blocks.</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.PredIter.html" title='cranelift_codegen::flowgraph::PredIter struct'>PredIter</a></td><td class='docblock-short'><p>An iterator over EBB predecessors. The iterator type is <code>BasicBlock</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.SuccIter.html" title='cranelift_codegen::flowgraph::SuccIter type'>SuccIter</a></td><td class='docblock-short'><p>An iterator over EBB successors. The iterator type is <code>Ebb</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>