flambda-backend: Reclassify 'CR ocaml 5 runtime' comments (#2094)

Author: mshinwell

otherlibs/str/str.ml

@@ -610,7 +610,7 @@ external re_search_backward: regexp -> string -> int -> int array
 module Domain = struct
   module DLS = struct
 
-    (* CR ocaml 5 runtime: Remove this proxy and use the real Domain.DLS *)
+    (* CR ocaml 5 domains: Remove this proxy and use the real Domain.DLS *)
     let[@inline always] new_key f = ref (f ())
     let[@inline always] set k s = k := s
     let[@inline always] get k = !k

otherlibs/systhreads4/st_stubs.c

@@ -13,10 +13,6 @@
 /*                                                                        */
 /**************************************************************************/
 
-// CR ocaml 5 runtime: We will need to pull in changes from the same file in
-// [tip-5] tag in ocaml-jst. We're considering this file to be part of the
-// runtime.
-
 #define CAML_INTERNALS
 
 #define CAML_NAME_SPACE

otherlibs/unix/signals.c

@@ -13,9 +13,10 @@
 /*                                                                        */
 /**************************************************************************/
 
-/* CR ocaml 5 runtime: This file is the 4.x version together with
+/* CR ocaml 5 domains: This file is the 4.x version together with
    adjustments to the names of exported functions ("unix_" -> "caml_unix").
-   (mshinwell/xclerc)
+   (mshinwell/xclerc).
+   For multi-domain support we'll need to revisit this.
 */
 
 #define CAML_INTERNALS

runtime/caml/stack.h

@@ -59,7 +59,7 @@
 #ifdef TARGET_arm64
 /* Size of the gc_regs structure, in words.
    See arm64.S and arm64/proc.ml for the indices */
-/* CR ocaml 5 runtime (mshinwell): this has not been updated for SIMD */
+/* CR-someday mshinwell: update for SIMD */
 #define Wosize_gc_regs (2 + 24 /* int regs */ + 24 /* float regs */)
 #define Saved_return_address(sp) *((intnat *)((sp) - 8))
 #define Pop_frame_pointer(sp) sp += sizeof(value)

runtime/dynlink.c

@@ -236,7 +236,7 @@ void caml_free_shared_libs(void)
 #define Handle_val(v) (*((void **) (v)))
 
 /* The mode argument is here for compatibility with runtime4. */
-/* CR ocaml 5 runtime: Remove [mode] when all-runtime5. */
+/* CR ocaml 5 all-runtime5: Remove [mode] when all-runtime5. */
 CAMLprim value caml_dynlink_open_lib(value mode, value filename)
 {
   void * handle;

runtime/extern.c

@@ -1380,7 +1380,7 @@ enum reachable_words_node_state {
    * root that we reached it from */
 };
 
-/* CR ocaml 5 runtime (mshinwell): think about what to do here */
+/* CR ocaml 5 domains (mshinwell): think about what to do here */
 /* Not multicore-safe (the [volatile] just lets us use this with the [Field] macro) */
 static void add_to_long_value(volatile value *v, intnat x) {
   *v = Val_long(Long_val(*v) + x);

runtime4/caml/camlatomic.h

@@ -43,7 +43,7 @@ using std::memory_order_seq_cst;
 #include <stdatomic.h>
 #define ATOMIC_UINTNAT_INIT(x) (x)
 
-// CR ocaml 5 runtime: provide these typedefs (requires C11)
+// CR ocaml 5 domains: provide these typedefs (requires C11)
 // typedef _Atomic uintnat atomic_uintnat;
 // typedef _Atomic intnat atomic_intnat;
 

stdlib/domain.ml

@@ -21,8 +21,10 @@ open! Stdlib
 
 [@@@ocaml.flambda_o3]
 
-(* CR ocaml 5 runtime: domain-local-storage assumes single-domain,
-   i.e. calling split will never be necessary. *)
+(* CR ocaml 5 domains: domain-local-storage assumes single-domain,
+   i.e. calling split will never be necessary.
+   For multi-domain support we'll need the upstream 5.x implementation.
+*)
 
 module DLS = struct
 
@@ -107,7 +109,7 @@ let do_at_exit () =
 
 let _ = Stdlib.do_domain_local_at_exit := do_at_exit
 
-(* CR ocaml 5 runtime: domains not supported on 4.x
+(* CR ocaml 5 domains: use this code
 
 module Raw = struct
   (* Low-level primitives provided by the runtime *)

stdlib/domain.mli

@@ -17,7 +17,7 @@
 (*                                                                        *)
 (**************************************************************************)
 
-(* CR ocaml 5 runtime: domains not supported on 4.x
+(* CR ocaml 5 domains: domains not supported on 4.x
 
 [@@@alert unstable
     "The Domain interface may change in incompatible ways in the future."

stdlib/gc.ml

@@ -67,9 +67,9 @@ external full_major : unit -> unit = "caml_gc_full_major"
 external compact : unit -> unit = "caml_gc_compaction"
 external get_minor_free : unit -> int = "caml_get_minor_free"
 
-(* CR ocaml 5 runtime: These functions are no-ops upstream. We should make them
-   no-ops internally when we delete the corresponding C functions from the
-   runtime -- they're already marked as deprecated in the mli.
+(* CR ocaml 5 all-runtime5: These functions are no-ops upstream. We should
+   make them no-ops internally when we delete the corresponding C functions
+   from the runtime -- they're already marked as deprecated in the mli.
 *)
 
 external eventlog_pause : unit -> unit = "caml_eventlog_pause"

stdlib/gc.mli

@@ -100,7 +100,7 @@ type stat =
         value will always be [0].
 
         @since 3.12 *)
-    (* CR ocaml 5 runtime: Update the above comment to what it is upstream:
+    (* CR ocaml 5 all-runtime5: Update the above comment to what it is upstream:
 
        This metrics is currently not available in OCaml 5: the field value is
        always [0].

stdlib/mutex.mli

@@ -70,4 +70,5 @@ val protect : t -> (unit -> 'a) -> 'a
 
     @since 5.1 *)
 (* CR ocaml 5 runtime (mshinwell): looks like [protect] needs to use
-   Sys.with_async_exns? *)
+   Sys.with_async_exns?
+   (PR2007 fixes this) *)

stdlib/stdlib.ml

@@ -608,7 +608,7 @@ module Complex        = Complex
 module Condition      = Condition
 module Digest         = Digest
 module Domain         = Domain
-(* CR ocaml 5 runtime:
+(* CR ocaml 5 effects:
    BACKPORT
 module Effect         = Effect
 *)

stdlib/stdlib.mli

@@ -1410,7 +1410,7 @@ module Domain         = Domain
 [@@alert unstable
     "The Domain interface may change in incompatible ways in the future."
 ]
-(* CR ocaml 5 runtime:
+(* CR ocaml 5 effects:
 BACKPORT
 module Effect         = Effect
 [@@alert "-unstable"]

testsuite/tests/misc/pr7168.ml

@@ -76,7 +76,7 @@ let _ =
    * to simplify this test along the same
    * lines as upstream, as stack overflow
    * detection is always supported in
-* ocaml 5. *)
+  * ocaml 5. *)
   if (Gc.get ()).Gc.stack_limit = 0 then begin
     (* We are in native code. Skip the test because some platforms cannot
        reliably detect stack overflow. *)

testsuite/tests/statmemprof/thread_exit_in_callback.ml

@@ -6,7 +6,7 @@ include systhreads
 *** native
 *)
 
-(* CR ocaml 5 runtime: Once statmemprof is ported, remove "runtime4" stanzas
+(* CR ocaml 5 statmemprof: Once statmemprof is ported, remove "runtime4" stanzas
    for the tests/statmemprof/ tests. *)
 
 let _ =

utils/symbol.ml

@@ -47,7 +47,7 @@ end)
 
 let caml_symbol_prefix = "caml"
 
-(* CR ocaml 5 runtime: Remove this_is_ocamlc and force_runtime4_symbols once
+(* CR ocaml 5 all-runtime5: Remove this_is_ocamlc and force_runtime4_symbols once
    fully on runtime5 *)
 let this_is_ocamlc = ref false
 let force_runtime4_symbols = ref false