fix some issues

ocaml-flambda · Aug 14, 2023 · 2b8c975 · 2b8c975
1 parent d94c4c4
commit 2b8c975
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/middle_end/flambda2/terms/flambda_primitive.mli b/middle_end/flambda2/terms/flambda_primitive.mli
@@ -324,7 +324,9 @@ type unary_primitive =
       (** Ending delimiter of local allocation region, accepting a region name. *)
   | Obj_dup  (** Corresponds to [Obj.dup]; see the documentation in obj.mli. *)
   | Get_header
-      (** get the header of a block; undefined behaviour if it's int *)
+      (** Get the header of a block. This primitive is invalid if provided with
+          an immediate value.
+          Note: The GC color bits in the header is not reliable. *)
 
 (** Whether a comparison is to yield a boolean result, as given by a particular
     comparison operator, or whether it is to behave in the manner of "compare"

diff --git a/ocaml/lambda/lambda.mli b/ocaml/lambda/lambda.mli
@@ -199,8 +199,9 @@ type primitive =
                         one; O(1) *)
   | Parray_of_iarray (* Unsafely reinterpret an immutable array as a mutable
                         one; O(1) *)
-  | Pget_header of alloc_mode (* returns the header of a block; undefined
-     behavior if it is int*)
+  | Pget_header of alloc_mode
+  (* Get the header of a block. This primitive is invalid if provided with an
+    immediate value. Note: The GC color bits in the header is not reliable. *)
 
 and integer_comparison =
     Ceq | Cne | Clt | Cgt | Cle | Cge