moonpool/dev/ocaml/Inlining_decision/index.html
2023-08-28 17:11:38 +00:00

16 lines
No EOL
3.9 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 xmlns="http://www.w3.org/1999/xhtml"><head><title>Inlining_decision (ocaml.Inlining_decision)</title><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../index.html">ocaml</a> &#x00BB; Inlining_decision</nav><header class="odoc-preamble"><h1>Module <code><span>Inlining_decision</span></code></h1><p>See the Flambda manual chapter for an explanation in prose of the inlining decision procedure.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-for_call_site"><a href="#val-for_call_site" class="anchor"></a><code><span><span class="keyword">val</span> for_call_site :
<span>env:<a href="../Inline_and_simplify_aux/Env/index.html#type-t">Inline_and_simplify_aux.Env.t</a> <span class="arrow">&#45;&gt;</span></span>
<span>r:<a href="../Inline_and_simplify_aux/Result/index.html#type-t">Inline_and_simplify_aux.Result.t</a> <span class="arrow">&#45;&gt;</span></span>
<span>function_decls:<a href="../Simple_value_approx/index.html#type-function_declarations">Simple_value_approx.function_declarations</a> <span class="arrow">&#45;&gt;</span></span>
<span>lhs_of_application:<a href="../Variable/index.html#type-t">Variable.t</a> <span class="arrow">&#45;&gt;</span></span>
<span>closure_id_being_applied:<a href="../Closure_id/index.html#type-t">Closure_id.t</a> <span class="arrow">&#45;&gt;</span></span>
<span>function_decl:<a href="../Simple_value_approx/index.html#type-function_declaration">Simple_value_approx.function_declaration</a> <span class="arrow">&#45;&gt;</span></span>
<span>value_set_of_closures:<a href="../Simple_value_approx/index.html#type-value_set_of_closures">Simple_value_approx.value_set_of_closures</a> <span class="arrow">&#45;&gt;</span></span>
<span>args:<span><a href="../Variable/index.html#type-t">Variable.t</a> list</span> <span class="arrow">&#45;&gt;</span></span>
<span>args_approxs:<span><a href="../Simple_value_approx/index.html#type-t">Simple_value_approx.t</a> list</span> <span class="arrow">&#45;&gt;</span></span>
<span>dbg:<a href="../Debuginfo/index.html#type-t">Debuginfo.t</a> <span class="arrow">&#45;&gt;</span></span>
<span>simplify:<a href="../Inlining_decision_intf/index.html#type-simplify">Inlining_decision_intf.simplify</a> <span class="arrow">&#45;&gt;</span></span>
<span>inline_requested:<a href="../Lambda/index.html#type-inline_attribute">Lambda.inline_attribute</a> <span class="arrow">&#45;&gt;</span></span>
<span>specialise_requested:<a href="../Lambda/index.html#type-specialise_attribute">Lambda.specialise_attribute</a> <span class="arrow">&#45;&gt;</span></span>
<a href="../Flambda/index.html#type-t">Flambda.t</a> * <a href="../Inline_and_simplify_aux/Result/index.html#type-t">Inline_and_simplify_aux.Result.t</a></span></code></div><div class="spec-doc"><p>Try to inline a full application of a known function, guided by various heuristics.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-should_inline_inside_declaration"><a href="#val-should_inline_inside_declaration" class="anchor"></a><code><span><span class="keyword">val</span> should_inline_inside_declaration : <span><a href="../Flambda/index.html#type-function_declaration">Flambda.function_declaration</a> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div><div class="spec-doc"><p>When a function declaration is encountered by <code>for_call_site</code>, the body may be subject to inlining immediately, thus changing the declaration. This function must return <code>true</code> for that to be able to happen.</p></div></div></div></body></html>