ocaml/middle_end/inlining_decision.mli

43 lines
2.2 KiB
OCaml

(**************************************************************************)
(* *)
(* OCaml *)
(* *)
(* Pierre Chambart, OCamlPro *)
(* Mark Shinwell and Leo White, Jane Street Europe *)
(* *)
(* Copyright 2013--2016 OCamlPro SAS *)
(* Copyright 2014--2016 Jane Street Group LLC *)
(* *)
(* All rights reserved. This file is distributed under the terms of *)
(* the GNU Lesser General Public License version 2.1, with the *)
(* special exception on linking described in the file ../LICENSE. *)
(* *)
(**************************************************************************)
[@@@ocaml.warning "+a-4-9-30-40-41-42"]
(* CR mshinwell: Add the new inlining heuristic documentation here. *)
(** Try to inline a full application of a known function, guided by various
heuristics. *)
val for_call_site
: env:Inline_and_simplify_aux.Env.t
-> r:Inline_and_simplify_aux.Result.t
-> function_decls:Flambda.function_declarations
-> lhs_of_application:Variable.t
-> closure_id_being_applied:Closure_id.t
-> function_decl:Flambda.function_declaration
-> value_set_of_closures:Simple_value_approx.value_set_of_closures
-> args:Variable.t list
-> args_approxs:Simple_value_approx.t list
-> dbg:Debuginfo.t
-> simplify:Inlining_decision_intf.simplify
-> inline_requested:Lambda.inline_attribute
-> specialise_requested:Lambda.specialise_attribute
-> Flambda.t * Inline_and_simplify_aux.Result.t
(** When a function declaration is encountered by [for_call_site], the body
may be subject to inlining immediately, thus changing the declaration.
This function must return [true] for that to be able to happen. *)
val should_inline_inside_declaration : Flambda.function_declaration -> bool