Rec_info part 1: aliases.

Author: xclerc

.depend

@@ -189,6 +189,7 @@ MIDDLE_END_FLAMBDA_COMPILENV_DEPS=\
   middle_end/flambda/compilenv_deps/flambda_colours.cmo \
   middle_end/flambda/compilenv_deps/compilation_unit.cmo \
   middle_end/flambda/compilenv_deps/rec_info.cmo \
+  middle_end/flambda/compilenv_deps/coercion.cmo \
   middle_end/flambda/compilenv_deps/reg_width_things.cmo \
   middle_end/flambda/compilenv_deps/symbol.cmo \
   middle_end/flambda/compilenv_deps/variable.cmo \

compilerlibs/Makefile.compilerlibs

@@ -53,25 +53,25 @@ let pattern_match' t ~var ~symbol ~const =
 
 let const_from_descr descr = const (RWC.of_descr descr)
 
-let without_rec_info t = pattern_match t ~name ~const
+let without_coercion t = pattern_match t ~name ~const
 
-let merge_rec_info t ~newer_rec_info =
+let compose_coercion t ~newer_coercion =
   if is_const t then None
   else
-    match newer_rec_info with
+    match newer_coercion with
     | None -> Some t
-    | Some newer_rec_info ->
-      let rec_info =
-        match rec_info t with
-        | None -> newer_rec_info
-        | Some older_rec_info ->
-          Rec_info.merge older_rec_info ~newer:newer_rec_info
+    | Some newer_coercion ->
+      let coercion =
+        match coercion t with
+        | None -> newer_coercion
+        | Some older_coercion ->
+          Coercion.compose older_coercion ~newer:newer_coercion
       in
-      Some (with_rec_info (without_rec_info t) rec_info)
+      Some (with_coercion (without_coercion t) coercion)
 
 (* CR mshinwell: Make naming consistent with [Name] re. the option type *)
 
-(* CR mshinwell: Careful that Rec_info doesn't get dropped using the
+(* CR mshinwell: Careful that Coercion doesn't get dropped using the
    following *)
 
 let [@inline always] must_be_var t =
@@ -86,7 +86,7 @@ let [@inline always] must_be_name t =
 let to_name t =
   match must_be_name t with
   | None -> None
-  | Some name -> Some (rec_info t, name)
+  | Some name -> Some (coercion t, name)
 
 let map_name t ~f =
   match must_be_name t with
@@ -118,9 +118,9 @@ let apply_name_permutation t perm =
     let new_name = Name_permutation.apply_name perm old_name in
     if old_name == new_name then t
     else
-      match rec_info t with
+      match coercion t with
       | None -> name new_name
-      | Some rec_info -> with_rec_info (name new_name) rec_info
+      | Some coercion -> with_coercion (name new_name) coercion
   in
   pattern_match t ~const:(fun _ -> t) ~name
 

middle_end/flambda/basic/simple.ml

@@ -23,9 +23,9 @@ include module type of struct include Reg_width_things.Simple end
 
 include Contains_names.S with type t := t
 
-val merge_rec_info : t -> newer_rec_info:Rec_info.t option -> t option
+val compose_coercion : t -> newer_coercion:Coercion.t option -> t option
 
-val without_rec_info : t -> t
+val without_coercion : t -> t
 
 val must_be_var : t -> Variable.t option
 
@@ -64,7 +64,7 @@ val const_from_descr : Reg_width_const.Descr.t -> t
 
 val map_name : t -> f:(Name.t -> Name.t) -> t
 
-val to_name : t -> (Rec_info.t option * Name.t) option
+val to_name : t -> (Coercion.t option * Name.t) option
 
 (* CR mshinwell: remove these next two? *)
 val map_var : t -> f:(Variable.t -> Variable.t) -> t

middle_end/flambda/basic/simple.mli

@@ -74,7 +74,7 @@ let add_name t name =
 
 let add_simple t simple =
   let simples =
-    match Simple.rec_info simple with
+    match Simple.coercion simple with
     | None -> t.simples
     | Some _ -> Simple.Set.add simple t.simples
   in
@@ -91,7 +91,7 @@ let add_continuation t continuation =
 
 let from_simple simple =
   let simples =
-    match Simple.rec_info simple with
+    match Simple.coercion simple with
     | None ->
       (* This simple will not be in the grand_table_of_simples *)
       Simple.Set.empty
@@ -199,12 +199,12 @@ module Import_map = struct
     match Simple.Map.find simple t.simples with
     | simple -> simple
     | exception Not_found ->
-      begin match Simple.rec_info simple with
+      begin match Simple.coercion simple with
       | None ->
         Simple.pattern_match simple
           ~name:(fun n -> Simple.name (name t n))
           ~const:(fun c -> Simple.const (const t c))
-      | Some _rec_info -> simple
+      | Some _coercion -> simple
       end
 
   let closure_var_is_used t var =

middle_end/flambda/cmx/ids_for_export.ml

@@ -0,0 +1,26 @@
+(**************************************************************************)
+(*                                                                        *)
+(*                                 OCaml                                  *)
+(*                                                                        *)
+(*                   Mark Shinwell, Jane Street Europe                    *)
+(*                                                                        *)
+(*   Copyright 2019 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.          *)
+(*                                                                        *)
+(**************************************************************************)
+
+type t = unit
+
+let id = ()
+let is_id () = true
+let inverse () = ()
+let compose () ~newer:() = ()
+let print ppf () = Format.fprintf ppf "id"
+let equal () () = true
+let hash () = 0
+
+let unroll_to () = None
+let depth () = 1

middle_end/flambda/compilenv_deps/coercion.ml

@@ -0,0 +1,28 @@
+(**************************************************************************)
+(*                                                                        *)
+(*                                 OCaml                                  *)
+(*                                                                        *)
+(*                   Mark Shinwell, Jane Street Europe                    *)
+(*                                                                        *)
+(*   Copyright 2019 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-30-40-41-42"]
+
+type t
+
+val id : t
+val is_id : t -> bool
+val inverse : t -> t
+val compose : t -> newer:t -> t
+val print : Format.formatter -> t -> unit
+val equal : t -> t -> bool
+val hash : t -> int
+
+val unroll_to : t -> int option
+val depth : t -> int

middle_end/flambda/compilenv_deps/coercion.mli

@@ -55,7 +55,7 @@ let continuation_annotation () = (C.fg_256 202) ^ (C.bg_256 237)
 
 let name_abstraction () = C.fg_256 172
 
-let rec_info () = C.fg_256 243
+let coercion () = C.fg_256 243
 
 let error () = C.fg_256 160
 

middle_end/flambda/compilenv_deps/flambda_colours.ml

@@ -53,7 +53,7 @@ val continuation_annotation : unit -> string
 
 val name_abstraction : unit -> string
 
-val rec_info : unit -> string
+val coercion : unit -> string
 
 val elide : unit -> string
 

middle_end/flambda/compilenv_deps/flambda_colours.mli

@@ -13,7 +13,7 @@
 (**************************************************************************)
 
 [@@@ocaml.warning "+a-4-30-40-41-42"]
-
+(*
 type t = {
   depth : int;
   unroll_to : int option;
@@ -64,3 +64,4 @@ let merge { depth = depth1; unroll_to = older_unroll_to; } ~newer =
 let initial = create ~depth:0 ~unroll_to:None
 
 let is_initial t = equal t initial
+*)

middle_end/flambda/compilenv_deps/rec_info.ml

@@ -13,7 +13,7 @@
 (**************************************************************************)
 
 [@@@ocaml.warning "+a-4-30-40-41-42"]
-
+(*
 type t
 
 include Identifiable.S with type t := t
@@ -29,3 +29,4 @@ val merge : t -> newer:t -> t
 val initial : t
 
 val is_initial : t -> bool
+*)

middle_end/flambda/compilenv_deps/rec_info.mli

@@ -221,28 +221,28 @@ end
 
 module Simple_data = struct
   type t = {
-    simple : Id.t;  (* always without [Rec_info] *)
-    rec_info : Rec_info.t;
+    simple : Id.t;  (* always without [Coercion] *)
+    coercion : Coercion.t;
   }
 
   let flags = simple_flags
 
-  let print ppf { simple = _; rec_info; } =
+  let print ppf { simple = _; coercion; } =
     Format.fprintf ppf "@[<hov 1>\
-        @[<hov 1>(rec_info@ %a)@]\
+        @[<hov 1>(coercion@ %a)@]\
         @]"
-      Rec_info.print rec_info
+      Coercion.print coercion
 
-  let hash { simple; rec_info; } =
-    Hashtbl.hash (Id.hash simple, Rec_info.hash rec_info)
+  let hash { simple; coercion; } =
+    Hashtbl.hash (Id.hash simple, Coercion.hash coercion)
 
   let equal t1 t2 =
     if t1 == t2 then true
     else
-      let { simple = simple1; rec_info = rec_info1; } = t1 in
-      let { simple = simple2; rec_info = rec_info2; } = t2 in
+      let { simple = simple1; coercion = coercion1; } = t1 in
+      let { simple = simple2; coercion = coercion2; } = t2 in
       Id.equal simple1 simple2
-        && Rec_info.equal rec_info1 rec_info2
+        && Coercion.equal coercion1 coercion2
 end
 
 module Const = struct
@@ -547,9 +547,9 @@ module Simple = struct
     in
     pattern_match t1 ~name ~const
 
-  let [@inline always] rec_info t =
+  let [@inline always] coercion t =
     let flags = Id.flags t in
-    if flags = simple_flags then Some ((find_data t).rec_info)
+    if flags = simple_flags then Some ((find_data t).coercion)
     else None
 
   module T0 = struct
@@ -563,15 +563,15 @@ module Simple = struct
           ~name:(fun name -> Name.print ppf name)
           ~const:(fun cst -> Const.print ppf cst)
       in
-      match rec_info t with
+      match coercion t with
       | None -> print ppf t
-      | Some rec_info ->
+      | Some coercion ->
        Format.fprintf ppf "@[<hov 1>\
             @[<hov 1>(simple@ %a)@] \
-            @[<hov 1>(rec_info@ %a)@]\
+            @[<hov 1>(coercion@ %a)@]\
             @]"
           print t
-          Rec_info.print rec_info
+          Coercion.print coercion
 
     let output chan t =
       print (Format.formatter_of_out_channel chan) t
@@ -583,16 +583,16 @@ module Simple = struct
     include T0
   end
 
-  let with_rec_info t new_rec_info =
-    if Rec_info.is_initial new_rec_info then t
+  let with_coercion t new_coercion =
+    if Coercion.is_id new_coercion then t
     else
-      match rec_info t with
+      match coercion t with
       | None ->
-        let data : Simple_data.t = { simple = t; rec_info = new_rec_info; } in
+        let data : Simple_data.t = { simple = t; coercion = new_coercion; } in
         Table.add !grand_table_of_simples data
       | Some _ ->
-        Misc.fatal_errorf "Cannot add [Rec_info] to [Simple] %a that already \
-            has [Rec_info]"
+        Misc.fatal_errorf "Cannot add [Coercion] to [Simple] %a that already \
+            has [Coercion]"
           print t
 
   module Set = Patricia_tree.Make_set (struct let print = print end)
@@ -604,7 +604,7 @@ module Simple = struct
   let import map (data : exported) =
     let simple = map data.simple in
     let data : Simple_data.t =
-      { simple; rec_info = data.rec_info; }
+      { simple; coercion = data.coercion; }
     in
     Table.add !grand_table_of_simples data
 

middle_end/flambda/compilenv_deps/reg_width_things.ml

@@ -154,9 +154,9 @@ module Simple : sig
 
   val const : Const.t -> t
 
-  val rec_info : t -> Rec_info.t option
+  val coercion : t -> Coercion.t option
 
-  val with_rec_info : t -> Rec_info.t -> t
+  val with_coercion : t -> Coercion.t -> t
 
   val pattern_match
      : t
@@ -165,7 +165,7 @@ module Simple : sig
     -> 'a
 
   (* [same s1 s2] returns true iff they represent the same name or const
-     i.e. [same s (with_rec_info s rec_info)] returns true *)
+     i.e. [same s (with_coercion s coercion)] returns true *)
   val same : t -> t -> bool
 
   val export : t -> exported

middle_end/flambda/compilenv_deps/reg_width_things.mli

@@ -218,7 +218,7 @@ end
 (* CR mshinwell: This parameter needs to be configurable *)
 let max_rec_depth = 1
 
-let make_decision_for_call_site denv ~function_decl_rec_info
+let make_decision_for_call_site denv ~function_decl_coercion
       ~apply_inlining_state (inline : Inline_attribute.t)
       : Call_site_decision.t =
   if (not (DE.can_inline denv)) then
@@ -227,9 +227,9 @@ let make_decision_for_call_site denv ~function_decl_rec_info
     match inline with
     | Never_inline -> Never_inline_attribute
     | Default_inline | Unroll _ | Always_inline | Hint_inline ->
-      match Rec_info.unroll_to function_decl_rec_info with
+      match Coercion.unroll_to function_decl_coercion with
       | Some unroll_to ->
-        if Rec_info.depth function_decl_rec_info >= unroll_to then
+        if Coercion.depth function_decl_coercion >= unroll_to then
           Unrolling_depth_exceeded
         else
           Inline { attribute = None; unroll_to = None; }
@@ -241,13 +241,13 @@ let make_decision_for_call_site denv ~function_decl_rec_info
           match inline with
           | Never_inline -> assert false
           | Default_inline ->
-            if Rec_info.depth function_decl_rec_info >= max_rec_depth then
+            if Coercion.depth function_decl_coercion >= max_rec_depth then
               Recursion_depth_exceeded
             else
               Inline { attribute = None; unroll_to = None; }
           | Unroll unroll_to ->
             let unroll_to =
-              Rec_info.depth function_decl_rec_info + unroll_to
+              Coercion.depth function_decl_coercion + unroll_to
             in
             Inline { attribute = Some Unroll; unroll_to = Some unroll_to; }
           | Always_inline | Hint_inline ->

middle_end/flambda/inlining/inlining_decision.ml

@@ -67,7 +67,7 @@ end
 
 val make_decision_for_call_site
    : Downwards_env.t
-  -> function_decl_rec_info:Rec_info.t
+  -> function_decl_coercion:Coercion.t
   -> apply_inlining_state:Inlining_state.t
   -> Inline_attribute.t
   -> Call_site_decision.t