<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><metaname="viewport"content="width=device-width, initial-scale=1.0"><metaname="generator"content="rustdoc"><metaname="description"content="API documentation for the Rust `LoopAnalysis` struct in crate `cranelift_codegen`."><metaname="keywords"content="rust, rustlang, rust-lang, LoopAnalysis"><title>cranelift_codegen::loop_analysis::LoopAnalysis - Rust</title><linkrel="stylesheet"type="text/css"href="../../normalize.css"><linkrel="stylesheet"type="text/css"href="../../rustdoc.css"id="mainThemeStyle"><linkrel="stylesheet"type="text/css"href="../../dark.css"><linkrel="stylesheet"type="text/css"href="../../light.css"id="themeStyle"><scriptsrc="../../storage.js"></script><noscript><linkrel="stylesheet"href="../../noscript.css"></noscript><linkrel="shortcut icon"href="../../favicon.ico"><styletype="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><bodyclass="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="sidebar"><divclass="sidebar-menu">☰</div><ahref='../../cranelift_codegen/index.html'><divclass='logo-container'><imgsrc='../../rust-logo.png'alt='logo'></div></a><pclass='location'>Struct LoopAnalysis</p><divclass="sidebar-elems"><divclass="block items"><aclass="sidebar-title"href="#methods">Methods</a><divclass="sidebar-links"><ahref="#method.clear">clear</a><ahref="#method.compute">compute</a><ahref="#method.is_child_loop">is_child_loop</a><ahref="#method.is_in_loop">is_in_loop</a><ahref="#method.is_valid">is_valid</a><ahref="#method.loop_header">loop_header</a><ahref="#method.loop_parent">loop_parent</a><ahref="#method.loops">loops</a><ahref="#method.new">new</a></div><aclass="sidebar-title"href="#synthetic-implementations">Auto Trait Implementations</a><divclass="sidebar-links"><ahref="#impl-RefUnwindSafe">RefUnwindSafe</a><ahref="#impl-Send">Send</a><ahref="#impl-Sync">Sync</a><ahref="#impl-Unpin">Unpin</a><ahref="#impl-UnwindSafe">UnwindSafe</a></div><aclass="sidebar-title"href="#blanket-implementations">Blanket Implementations</a><divclass="sidebar-links"><ahref="#impl-Any">Any</a><ahref="#impl-Borrow%3CT%3E">Borrow<T></a><ahref="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><ahref="#impl-From%3CT%3E">From<T></a><ahref="#impl-Into%3CU%3E">Into<U></a><ahref="#impl-TryFrom%3CU%3E">TryFrom<U></a><ahref="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><pclass='location'><ahref='../index.html'>cranelift_codegen</a>::<wbr><ahref='index.html'>loop_analysis</a></p><script>window.sidebarCurrent={name:'LoopAnalysis',ty:'struct',relpath:''};</script><scriptdefersrc="sidebar-items.js"></script></div></nav><divclass="theme-picker"><buttonid="theme-picker"aria-label="Pick another theme!"><imgsrc="../../brush.svg"width="18"alt="Pick another theme!"></button><divid="theme-choices"></div></div><scriptsrc="../../theme.js"></script><navclass="sub"><formclass="search-form js-only"><divclass="search-container"><div><selectid="crate-search"><optionvalue="All crates">All crates</option></select><inputclass="search-input"name="search"autocomplete="off"spellcheck="false"placeholder="Click or press ‘S’ to search, ‘?’ for more options…"type="search"></div><aid="settings-menu"href="../../settings.html"><imgsrc="../../wheel.svg"width="18"alt="Change settings"></a></div></form></nav><sectionid="main"class="content"><h1class='fqn'><spanclass='out-of-band'><spanid='render-detail'><aid="toggle-all-docs"href="javascript:void(0)"title="collapse all docs">[<spanclass='inner'>−</span>]</a></span><aclass='srclink'href='../../src/cranelift_codegen/loop_analysis.rs.html#23-27'title='goto source code'>[src]</a></span><spanclass='in-band'>Struct <ahref='../index.html'>cranelift_codegen</a>::<wbr><ahref='index.html'>loop_analysis</a>::<wbr><aclass="struct"href=''>LoopAnalysis</a></span></
<p>Loops are referenced by the Loop object, and for each loop you can access its header EBB,
its eventual parent in the loop tree and all the EBB belonging to the loop.</p>
</div><h2id='methods'class='small-section-header'>Methods<ahref='#methods'class='anchor'></a></h2><h3id='impl'class='impl'><codeclass='in-band'>impl <aclass="struct"href="../../cranelift_codegen/loop_analysis/struct.LoopAnalysis.html"title="struct cranelift_codegen::loop_analysis::LoopAnalysis">LoopAnalysis</a></code><ahref='#impl'class='anchor'></a><aclass='srclink'href='../../src/cranelift_codegen/loop_analysis.rs.html#45-99'title='goto source code'>[src]</a></h3><divclass='docblock'><p>Methods for querying the loop analysis.</p>
</div><divclass='impl-items'><h4id='method.new'class="method"><codeid='new.v'>pub fn <ahref='#method.new'class='fnname'>new</a>() -> Self</code><aclass='srclink'href='../../src/cranelift_codegen/loop_analysis.rs.html#48-54'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Allocate a new blank loop analysis struct. Use <code>compute</code> to compute the loop analysis for
a function.</p>
</div><h4id='method.loops'class="method"><codeid='loops.v'>pub fn <ahref='#method.loops'class='fnname'>loops</a>(&self) -><aclass="struct"href="../../cranelift_entity/keys/struct.Keys.html"title="struct cranelift_entity::keys::Keys">Keys</a><<aclass="struct"href="../../cranelift_codegen/loop_analysis/struct.Loop.html"title="struct cranelift_codegen::loop_analysis::Loop">Loop</a>></code><aclass='srclink'href='../../src/cranelift_codegen/loop_analysis.rs.html#57-59'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Returns all the loops contained in a function.</p>
</div><h4id='method.loop_header'class="method"><codeid='loop_header.v'>pub fn <ahref='#method.loop_header'class='fnname'>loop_header</a>(&self, lp: <aclass="struct"href="../../cranelift_codegen/loop_analysis/struct.Loop.html"title="struct cranelift_codegen::loop_analysis::Loop">Loop</a>) -><aclass="struct"href="../../cranelift_codegen/ir/entities/struct.Ebb.html"title="struct cranelift_codegen::ir::entities::Ebb">Ebb</a></code><aclass='srclink'href='../../src/cranelift_codegen/loop_analysis.rs.html#65-67'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Returns the header EBB of a particular loop.</p>
<p>The characteristic property of a loop header block is that it dominates some of its
predecessors.</p>
</div><h4id='method.loop_parent'class="method"><codeid='loop_parent.v'>pub fn <ahref='#method.loop_parent'class='fnname'>loop_parent</a>(&self, lp: <aclass="struct"href="../../cranelift_codegen/loop_analysis/struct.Loop.html"title="struct cranelift_codegen::loop_analysis::Loop">Loop</a>) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html"title="enum core::option::Option">Option</a><<aclass="struct"href="../../cranelift_codegen/loop_analysis/struct.Loop.html"title="struct cranelift_codegen::loop_analysis::Loop">Loop</a>></code><aclass='srclink'href='../../src/cranelift_codegen/loop_analysis.rs.html#70-72'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Return the eventual parent of a loop in the loop tree.</p>
</div><h4id='method.is_in_loop'class="method"><codeid='is_in_loop.v'>pub fn <ahref='#method.is_in_loop'class='fnname'>is_in_loop</a>(&self, ebb: <aclass="struct"href="../../cranelift_codegen/ir/entities/struct.Ebb.html"title="struct cranelift_codegen::ir::entities::Ebb">Ebb</a>, lp: <aclass="struct"href="../../cranelift_codegen/loop_analysis/struct.Loop.html"title="struct cranelift_codegen::loop_analysis::Loop">Loop</a>) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><aclass='srclink'href='../../src/cranelift_codegen/loop_analysis.rs.html#77-83'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Determine if an Ebb belongs to a loop by running a finger along the loop tree.</p>
<p>Returns <code>true</code> if <code>ebb</code> is in loop <code>lp</code>.</p>
</div><h4id='method.is_child_loop'class="method"><codeid='is_child_loop.v'>pub fn <ahref='#method.is_child_loop'class='fnname'>is_child_loop</a>(&self, child: <aclass="struct"href="../../cranelift_codegen/loop_analysis/struct.Loop.html"title="struct cranelift_codegen::loop_analysis::Loop">Loop</a>, parent: <aclass="struct"href="../../cranelift_codegen/loop_analysis/struct.Loop.html"title="struct cranelift_codegen::loop_analysis::Loop">Loop</a>) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><aclass='srclink'href='../../src/cranelift_codegen/loop_analysis.rs.html#89-98'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Determines if a loop is contained in another loop.</p>
<p><code>is_child_loop(child,parent)</code> returns <code>true</code> if and only if <code>child</code> is a child loop of
</div></div><h3id='impl-1'class='impl'><codeclass='in-band'>impl <aclass="struct"href="../../cranelift_codegen/loop_analysis/struct.LoopAnalysis.html"title="struct cranelift_codegen::loop_analysis::LoopAnalysis">LoopAnalysis</a></code><ahref='#impl-1'class='anchor'></a><aclass='srclink'href='../../src/cranelift_codegen/loop_analysis.rs.html#101-231'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='method.compute'class="method"><codeid='compute.v'>pub fn <ahref='#method.compute'class='fnname'>compute</a>(<br> &mut self, <br> func: &<aclass="struct"href="../../cranelift_codegen/ir/function/struct.Function.html"title="struct cranelift_codegen::ir::function::Function">Function</a>, <br> cfg: &<aclass="struct"href="../../cranelift_codegen/flowgraph/struct.ControlFlowGraph.html"title="struct cranelift_codegen::flowgraph::ControlFlowGraph">ControlFlowGraph</a>, <br> domtree: &<aclass="struct"href="../../cranelift_codegen/dominator_tree/struct.DominatorTree.html"title="struct cranelift_codegen::dominator_tree::DominatorTree">DominatorTree</a><br>)</code><aclass='srclink'href='../../src/cranelift_codegen/loop_analysis.rs.html#103-111'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Detects the loops in a function. Needs the control flow graph and the dominator tree.</p>
</div><h4id='method.is_valid'class="method"><codeid='is_valid.v'>pub fn <ahref='#method.is_valid'class='fnname'>is_valid</a>(&self) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><aclass='srclink'href='../../src/cranelift_codegen/loop_analysis.rs.html#118-120'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Check if the loop analysis is in a valid state.</p>
<p>Note that this doesn't perform any kind of validity checks. It simply checks if the
<code>compute()</code> method has been called since the last <code>clear()</code>. It does not check that the
loop analysis is consistent with the CFG.</p>
</div><h4id='method.clear'class="method"><codeid='clear.v'>pub fn <ahref='#method.clear'class='fnname'>clear</a>(&mut self)</code><aclass='srclink'href='../../src/cranelift_codegen/loop_analysis.rs.html#125-129'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Clear all the data structures contained in the loop analysis. This will leave the
analysis in a similar state to a context returned by <code>new()</code> except that allocated
</div></div><h3id='impl-TryFrom%3CU%3E'class='impl'><codeclass='in-band'>impl<T, U><aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U> for T <spanclass="where fmt-newline">where<br> U: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><T>, </span></code><ahref='#impl-TryFrom%3CU%3E'class='anchor'></a><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#571-577'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='associatedtype.Error'class="type"><codeid='Error.t'>type <ahref='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error'class="type">Error</a> = <aclass="enum"href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html"title="enum core::convert::Infallible">Infallible</a></code></h4><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div><h4id='method.try_from'class="method hidden"><codeid='try_from.v'>fn <ahref='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from'class='fnname'>try_from</a>(value: U) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><T, <T as <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U>>::<aclass="type"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></code><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#574-576'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3id='impl-Into%3CU%3E'class='impl'><codeclass='in-band'>impl<T, U><aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><U> for T <spanclass="where fmt-newline">where<br> U: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html"title="trait core::convert::From">From</a><T>, </span></code><ahref='#impl-Into%3CU%3E'class='anchor'></a><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#543-548'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='method.into'class="method hidden"><codeid='into.v'>fn <ahref='https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into'class='fnname'>into</a>(self) -> U</code><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#545-547'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3id='impl-TryInto%3CU%3E'class='impl'><codeclass='in-band'>impl<T, U><aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html"title="trait core::convert::TryInto">TryInto</a><U> for T <spanclass="where fmt-newline">where<br> U: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><ahref='#impl-TryInto%3CU%3E'class='anchor'></a><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#559-566'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='associatedtype.Error-1'class="type"><codeid='Error.t-1'>type <ahref='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error'class="type">Error</a> = <U as <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="type"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a></code></h4><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div><h4id='method.try_into'class="method hidden"><codeid='try_into.v'>fn <ahref='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into'class='fnname'>try_into</a>(self) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><U, <U as <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="type"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></code><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#563-565'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3id='impl-Borrow%3CT%3E'class='impl'><codeclass='in-band'>impl<T><aclass="trait"href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html"title="trait core::borrow::Borrow">Borrow</a><T> for T <spanclass="where fmt-newline">where<br> T: ?<aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html"title="trait core::marker::Sized">Sized</a>, </span></code><ahref='#impl-Borrow%3CT%3E'class='anchor'></a><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#213-215'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='method.borrow'class="method hidden"><codeid='borrow.v'>fn <ahref='https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow'class='fnname'>borrow</a>(&self) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#214'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Immutably borrows from an owned value. <ahref="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
</div></div><h3id='impl-BorrowMut%3CT%3E'class='impl'><codeclass='in-band'>impl<T><aclass="trait"href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html"title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <spanclass="where fmt-newline">where<br> T: ?<aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html"title="trait core::marker::Sized">Sized</a>, </span></code><ahref='#impl-BorrowMut%3CT%3E'class='anchor'></a><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#218-220'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='method.borrow_mut'class="method hidden"><codeid='borrow_mut.v'>fn <ahref='https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut'class='fnname'>borrow_mut</a>(&mut self) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#219'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Mutably borrows from an owned value. <ahref="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
</div></div><h3id='impl-Any'class='impl'><codeclass='in-band'>impl<T><aclass="trait"href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html"title="trait core::any::Any">Any</a> for T <spanclass="where fmt-newline">where<br> T: 'static + ?<aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html"title="trait core::marker::Sized">Sized</a>, </span></code><ahref='#impl-Any'class='anchor'></a><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#100-102'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='method.type_id'class="method hidden"><codeid='type_id.v'>fn <ahref='https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id'class='fnname'>type_id</a>(&self) -><aclass="struct"href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html"title="struct core::any::TypeId">TypeId</a></code><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#101'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <ahref="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
</div></div></div></section><sectionid="search"class="content hidden"></section><sectionclass="footer"></section><asideid="help"class="hidden"><div><h1class="hidden">Help</h1><divclass="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><divclass="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><scriptsrc="../../aliases.js"></script><scriptsrc="../../main.js"></script><scriptdefersrc="../../search-index.js"></script></body></html>
