flambda-backend: Rename Float to Float_boxed in flat suffix variant (#2590)

* Rename identifiers

* make fmt

Author: ncik-roberts

lambda/lambda.ml

@@ -343,10 +343,17 @@ and block_shape =
   value_kind list option
 
 and flat_element = Types.flat_element =
-    Imm | Float | Float64 | Float32 | Bits32 | Bits64 | Word
+  | Imm
+  | Float_boxed
+  | Float64
+  | Float32
+  | Bits32
+  | Bits64
+  | Word
+
 and flat_element_read =
   | Flat_read of flat_element (* invariant: not [Float] *)
-  | Flat_read_float of alloc_mode
+  | Flat_read_float_boxed of alloc_mode
 and mixed_block_read =
   | Mread_value_prefix of immediate_or_pointer
   | Mread_flat_suffix of flat_element_read
@@ -1264,11 +1271,11 @@ let get_mixed_block_element = Types.get_mixed_product_element
 
 let flat_read_non_float flat_element =
   match flat_element with
-  | Float -> Misc.fatal_error "flat_element_read_non_float Float"
+  | Float_boxed -> Misc.fatal_error "flat_element_read_non_float Float_boxed"
   | Imm | Float64 | Float32 | Bits32 | Bits64 | Word as flat_element ->
       Flat_read flat_element
 
-let flat_read_float alloc_mode = Flat_read_float alloc_mode
+let flat_read_float_boxed alloc_mode = Flat_read_float_boxed alloc_mode
 
 (* Compile a sequence of expressions *)
 
@@ -1674,7 +1681,7 @@ let primitive_may_allocate : primitive -> alloc_mode option = function
   | Pmixedfield (_, read, _) -> begin
       match read with
       | Mread_value_prefix _ -> None
-      | Mread_flat_suffix (Flat_read_float m) -> Some m
+      | Mread_flat_suffix (Flat_read_float_boxed m) -> Some m
       | Mread_flat_suffix (Flat_read _) -> None
     end
   | Psetfloatfield _ -> None
@@ -1824,7 +1831,7 @@ let array_ref_kind_result_layout = function
 let layout_of_mixed_field (kind : mixed_block_read) =
   match kind with
   | Mread_value_prefix _ -> layout_value_field
-  | Mread_flat_suffix (Flat_read_float (_ : alloc_mode)) ->
+  | Mread_flat_suffix (Flat_read_float_boxed (_ : alloc_mode)) ->
       layout_boxed_float Pfloat64
   | Mread_flat_suffix (Flat_read proj) ->
       match proj with
@@ -1834,7 +1841,7 @@ let layout_of_mixed_field (kind : mixed_block_read) =
       | Bits32 -> layout_unboxed_int32
       | Bits64 -> layout_unboxed_int64
       | Word -> layout_unboxed_nativeint
-      | Float -> layout_boxed_float Pfloat64
+      | Float_boxed -> layout_boxed_float Pfloat64
 
 let primitive_result_layout (p : primitive) =
   assert !Clflags.native_code;

lambda/lambda.mli

@@ -351,10 +351,17 @@ and block_shape =
   value_kind list option
 
 and flat_element = Types.flat_element =
-    Imm | Float | Float64 | Float32 | Bits32 | Bits64 | Word
+  | Imm
+  | Float_boxed
+  | Float64
+  | Float32
+  | Bits32
+  | Bits64
+  | Word
+
 and flat_element_read = private
   | Flat_read of flat_element (* invariant: not [Float] *)
-  | Flat_read_float of alloc_mode
+  | Flat_read_float_boxed of alloc_mode
 and mixed_block_read =
   | Mread_value_prefix of immediate_or_pointer
   | Mread_flat_suffix of flat_element_read
@@ -606,7 +613,7 @@ type lambda =
      a subset of those open at the point of the [Lstaticraise] that jumps to it,
      as we can't reopen closed regions. All regions that were open at the point of
      the [Lstaticraise] but not in the handler will be closed just before the [Lstaticraise].
-   
+
      However, to be able to express the fact
      that the [Lstaticraise] might be under a [Lexclave], the [pop_region] flag
      is used to specify what regions are considered open in the handler. If it
@@ -838,9 +845,9 @@ type mixed_block_element =
 (** Raises if the int is out of bounds. *)
 val get_mixed_block_element : mixed_block_shape -> int -> mixed_block_element
 
-(** Raises if [flat_element] is float. *)
+(** Raises if [flat_element] is [Float_boxed]. *)
 val flat_read_non_float : flat_element -> flat_element_read
-val flat_read_float : alloc_mode -> flat_element_read
+val flat_read_float_boxed : alloc_mode -> flat_element_read
 
 val make_sequence: ('a -> lambda) -> 'a list -> lambda
 

lambda/matching.ml

@@ -1811,7 +1811,7 @@ let get_expr_args_constr ~scopes head (arg, _mut, sort, layout) rem =
             | Flat_suffix flat ->
                 let flat_read =
                   match flat with
-                  | Float ->
+                  | Float_boxed ->
                       Misc.fatal_error
                         "unexpected flat float of layout value in \
                          constructor field"
@@ -2185,9 +2185,9 @@ let get_expr_args_record ~scopes head (arg, _mut, sort, layout) rem =
                   match flat_suffix.(pos - value_prefix_len) with
                   | Imm | Float64 | Float32 | Bits32 | Bits64 | Word as non_float ->
                       flat_read_non_float non_float
-                  | Float ->
+                  | Float_boxed ->
                       (* TODO: could optimise to Alloc_local sometimes *)
-                      flat_read_float alloc_heap
+                      flat_read_float_boxed alloc_heap
                 in
                 Mread_flat_suffix read
             in

lambda/printlambda.ml

@@ -324,7 +324,7 @@ let flat_element ppf : flat_element -> unit = fun x ->
 let flat_element_read ppf : flat_element_read -> unit = function
   | Flat_read flat ->
       pp_print_string ppf (Types.flat_element_to_lowercase_string flat)
-  | Flat_read_float m -> fprintf ppf "float[%a]" alloc_mode m
+  | Flat_read_float_boxed m -> fprintf ppf "float[%a]" alloc_mode m
 
 let mixed_block_read ppf : mixed_block_read -> unit = function
   | Mread_value_prefix Immediate -> pp_print_string ppf "value_int"

lambda/translcore.ml

@@ -611,10 +611,10 @@ and transl_exp0 ~in_new_scope ~scopes sort e =
             else
               let flat_read =
                 match flat_suffix.(lbl.lbl_num - value_prefix_len) with
-                | Float ->
+                | Float_boxed ->
                   (match float with
                     | Boxing (mode, _) ->
-                        flat_read_float (transl_alloc_mode_r mode)
+                        flat_read_float_boxed (transl_alloc_mode_r mode)
                     | Non_boxing _ ->
                         Misc.fatal_error
                           "expected typechecking to make [float] boxing mode\
@@ -1734,11 +1734,11 @@ and transl_record ~scopes loc env mode fields repres opt_init_expr =
                     else
                       let read =
                         match flat_suffix.(lbl.lbl_num - value_prefix_len) with
-                        | Float ->
+                        | Float_boxed ->
                             (* See the handling of [Record_float] above for
                                 why we choose Alloc_heap.
                             *)
-                            flat_read_float alloc_heap
+                            flat_read_float_boxed alloc_heap
                         | non_float -> flat_read_non_float non_float
                       in
                       Mread_flat_suffix read

toplevel/genprintval.ml

@@ -580,7 +580,7 @@ module Make(O : OBJ)(EVP : EVALPATH with type valu = O.t) = struct
                         match Types.get_mixed_product_element shape pos with
                         | Value_prefix -> `Continue (O.field obj pos)
                         | Flat_suffix Imm -> `Continue (O.field obj pos)
-                        | Flat_suffix (Float | Float64) ->
+                        | Flat_suffix (Float_boxed | Float64) ->
                             `Continue (O.repr (O.double_field obj pos))
                         | Flat_suffix (Float32 | Bits32 | Bits64 | Word) ->
                             `Stop (Oval_stuff "<abstr>")

typing/typecore.ml

@@ -5738,7 +5738,7 @@ and type_expect_
           | Record_float -> true
           | Record_mixed mixed -> begin
               match Types.get_mixed_product_element mixed label.lbl_num with
-              | Flat_suffix Float -> true
+              | Flat_suffix Float_boxed -> true
               | Flat_suffix (Float64 | Float32 | Imm | Bits32 | Bits64 | Word) -> false
               | Value_prefix -> false
             end

typing/typedecl.ml

@@ -1423,7 +1423,7 @@ let update_decl_jkind env dpath decl =
               List.map
                 (fun ((repr : Element_repr.t), _lbl) ->
                   match repr with
-                  | Float_element -> Float
+                  | Float_element -> Float_boxed
                   | Unboxed_element Float64 -> Float64
                   | Element_without_runtime_component { ty; loc } ->
                       raise (Error (loc,

typing/types.ml

@@ -283,7 +283,15 @@ and abstract_reason =
     Abstract_def
   | Abstract_rec_check_regularity
 
-and flat_element = Imm | Float | Float64 | Float32 | Bits32 | Bits64 | Word
+and flat_element =
+  | Imm
+  | Float_boxed
+  | Float64
+  | Float32
+  | Bits32
+  | Bits64
+  | Word
+
 and mixed_product_shape =
   { value_prefix_len : int;
     flat_suffix : flat_element array;
@@ -579,20 +587,20 @@ let equal_tag t1 t2 =
 
 let equal_flat_element e1 e2 =
   match e1, e2 with
-  | Imm, Imm | Float64, Float64 | Float32, Float32 | Float, Float
+  | Imm, Imm | Float64, Float64 | Float32, Float32 | Float_boxed, Float_boxed
   | Word, Word | Bits32, Bits32 | Bits64, Bits64
     -> true
-  | (Imm | Float64 | Float32 | Float | Word | Bits32 | Bits64), _ -> false
+  | (Imm | Float64 | Float32 | Float_boxed | Word | Bits32 | Bits64), _ -> false
 
 let compare_flat_element e1 e2 =
   match e1, e2 with
-  | Imm, Imm | Float, Float | Float64, Float64 | Float32, Float32
+  | Imm, Imm | Float_boxed, Float_boxed | Float64, Float64 | Float32, Float32
   | Word, Word | Bits32, Bits32 | Bits64, Bits64
     -> 0
   | Imm, _ -> -1
   | _, Imm -> 1
-  | Float, _ -> -1
-  | _, Float -> 1
+  | Float_boxed, _ -> -1
+  | _, Float_boxed -> 1
   | Float64, _ -> -1
   | _, Float64 -> 1
   | Float32, _ -> -1
@@ -729,7 +737,7 @@ let get_mixed_product_element { value_prefix_len; flat_suffix } i =
 
 let flat_element_to_string = function
   | Imm -> "Imm"
-  | Float -> "Float"
+  | Float_boxed -> "Float_boxed"
   | Float32 -> "Float32"
   | Float64 -> "Float64"
   | Bits32 -> "Bits32"
@@ -738,7 +746,7 @@ let flat_element_to_string = function
 
 let flat_element_to_lowercase_string = function
   | Imm -> "imm"
-  | Float -> "float"
+  | Float_boxed -> "float"
   | Float32 -> "float32"
   | Float64 -> "float64"
   | Bits32 -> "bits32"

typing/types.mli

@@ -565,7 +565,16 @@ and abstract_reason =
    non-empty suffix of "flat" elements. Intuitively, a flat element is one that
    need not be scanned by the garbage collector.
 *)
-and flat_element = Imm | Float | Float64 | Float32 | Bits32 | Bits64 | Word
+and flat_element =
+  | Imm
+  | Float_boxed
+  (* A [Float_boxed] is a float that's stored flat but boxed upon projection. *)
+  | Float64
+  | Float32
+  | Bits32
+  | Bits64
+  | Word
+
 and mixed_product_shape =
   { value_prefix_len : int;
     (* We use an array just so we can index into the middle. *)