Module Flambda2_to_cmm.To_cmm_effects
type effects_and_coeffects_classification = | Pure(*Pure expressions can be commuted with *everything*, including effectful expressions such as function calls.
*)| Effect(*Effectful expressions only commute with pure expressions.
For the purpose of To_cmm, generative effects, i.e. allocations, are considered to have effects. This is because the mutable state of the GC that allocations affect can be observed by coeffects performed by function calls (in particular those coming from the Gc module).
*)| Coeffect_only(*Coeffects without any effect. These expression can commute with other coeffectful expressions (and pure expressions), but cannot commute with an effectful expression.
*)| Generative_immutable(*Only immutable generative effects. These are technically effects (since functions in the `Gc` module can read counters related to allocations), but we are interested in moving allocation (e.g. for unboxing of numbers in classic mode).
*)
Classification of expressions based on their effects and coeffects.
val classify_by_effects_and_coeffects :
Flambda2_terms.Effects_and_coeffects.t ->
Flambda2_to_cmm.To_cmm_effects.effects_and_coeffects_classificationReturn the classification of an expression with the given effects and coeffects.
type let_binding_classification = private | Drop_defining_expr(*The defining expression may be deleted.
*)| Regular(*Proceed as normal, do not inline the defining expression.
*)| May_inline_once(*The defining expression is guaranteed to be used once, and may be inlined at the use site.
*)| Must_inline_once(*The defining expression is guaranteed to be used once, and must inlined at the use site.
*)| Must_inline_and_duplicate(*The defining expression must be inlined at all use sites, and it is used multiple times (or inside a loop).
*)
Classification of Let-expressions, identifying what may be done with the defining expression.
val classify_let_binding :
Flambda2_identifiers.Variable.t ->
effects_and_coeffects_of_defining_expr:Flambda2_terms.Effects_and_coeffects.t ->
num_normal_occurrences_of_bound_vars:
Flambda2_nominal.Num_occurrences.t Flambda2_identifiers.Variable.Map.t ->
Flambda2_to_cmm.To_cmm_effects.let_binding_classificationClassification of continuations, indicating what may be done with the handler expression.
val classify_continuation_handler :
Flambda2_identifiers.Continuation.t ->
Flambda2_terms.Flambda.Import.Continuation_handler.t ->
num_free_occurrences:
Flambda2_nominal.Num_occurrences.t Flambda2_lattices.Or_unknown.t ->
is_applied_with_traps:bool ->
Flambda2_to_cmm.To_cmm_effects.continuation_handler_classificationEffects and coeffects of C calls
val transl_c_call_effects : Flambda2_terms.Effects.t -> Cmm.effectsval transl_c_call_coeffects : Flambda2_terms.Coeffects.t -> Cmm.coeffects