[herd-www] Support every Arm ARM release for all catalogues

TiberiuBucur · TiberiuBucur · commit bce9aa651431 · 2026-01-29T18:21:16.000Z
diff --git a/herd-www/Makefile b/herd-www/Makefile
@@ -1,13 +1,16 @@
 CAT2HTML7=$(if $(shell which cat2html7), cat2html7, ../_build/default/tools/cat2html.exe)
-BOOKS=aarch64  aarch64-ifetch aarch64-mixed aarch64-MTE aarch64-MTE-mixed aarch64-VMSA  aarch64-ETS2 aarch64-faults bpf x86 linux
+AARCH64_BOOKS= aarch64  aarch64-ifetch aarch64-mixed aarch64-MTE aarch64-MTE-mixed aarch64-VMSA  aarch64-ETS2 aarch64-faults
+BOOKS= $(AARCH64_BOOKS) bpf x86 linux
 WWW_CATALOGUE=www/catalogue
 HERD_CATALOGUE=../catalogue
 PROG=jerd.js
 WWW_PROG=www/$(PROG)
 WWW_LIB=www/weblib
 JSON_SHELVES=$(foreach book,$(BOOKS),$(WWW_CATALOGUE)/$(book)/shelf.json)
+ARM_ARM_RELEASES=$(wildcard ../herd/libdir/aarch64/*)
+ENV_PAIRS := $(foreach d,$(ARM_ARM_RELEASES),$(notdir $(d)) $(d))
 CATINCLUDES=../herd/libdir linux $(foreach b,$(BOOKS),$(HERD_CATALOGUE)/$(b)/cats)
-CATINCLUDESDEP=$(foreach d,$(CATINCLUDES),$(wildcard $(d)/*.*))
+CATINCLUDESDEP=$(foreach d,$(CATINCLUDES) $(ARM_ARM_RELEASES),$(wildcard $(d)/*.*))
 DUNETGT=../_build/default/herd-www
 all: web
 
@@ -22,6 +25,12 @@ define make-book
 $(WWW_CATALOGUE)/$1/:
 	mkdir -p $(WWW_CATALOGUE)
 	rsync -a --copy-unsafe-links --delete $(HERD_CATALOGUE)/$1/ $(WWW_CATALOGUE)/$1/
+	$(if $(filter $1,$(AARCH64_BOOKS)), \
+		$(foreach d,$(ARM_ARM_RELEASES), \
+			mkdir -p $(WWW_CATALOGUE)/$1/cats/$(notdir $(d)) && \
+			cp $(d)/aarch64.cat $(WWW_CATALOGUE)/$1/cats/$(notdir $(d))/aarch64.cat; \
+		) \
+	,)
 
 .PHONY:: $(WWW_CATALOGUE)/$1/
 endef
@@ -40,7 +49,7 @@ $(PROG): catIncludes.ml force
 	cp $(DUNETGT)/jerd.bc.js $(PROG) && chmod u+w $(PROG)
 
 catIncludes.ml: generate_includes.ml $(CATINCLUDESDEP)
-	ocaml ./generate_includes.ml -norec $(CATINCLUDES) > $@
+	ocaml ./generate_includes.ml -norec -envs $(ENV_PAIRS) -- $(CATINCLUDES) > $@
 
 $(foreach book,$(BOOKS),$(eval $(call make-json-shelf,$(book))))
 $(foreach book,$(BOOKS),$(eval $(call make-book,$(book))))
diff --git a/herd-www/catalogue_to_json.py b/herd-www/catalogue_to_json.py
@@ -2,14 +2,31 @@
 
 import importlib
 import json
-import re
+import os
 import sys
+from glob import glob
+
+def discover_release_cats():
+    """
+    Discover extra aarch64.cat files under:
+        cats/*/aarch64.cat
+
+    Returns paths relative to the book directory, e.g.:
+        cats/ArmARM-L.b/aarch64.cat
+    """
+    matches = glob(os.path.join('cats', '*', 'aarch64.cat'))
+    # Normalize to forward slashes for JSON / browser use
+    return sorted(m.replace(os.sep, '/') for m in matches)
 
 def jsonify(fname):
     m = importlib.import_module(fname)
+
+    base_cats = list(m.cats)
+    extra_cats = discover_release_cats()
+
     j = json.dumps({
         'record' : m.record,
-        'cats' : m.cats,
+        'cats' : base_cats + extra_cats,
         'illustrative_tests' : m.illustrative_tests,
         'cfgs' : m.cfgs,
         'bells' : m.bells if 'bells' in dir(m) else None,
diff --git a/herd-www/generate_includes.ml b/herd-www/generate_includes.ml
@@ -22,7 +22,9 @@ let output_header () =
   Printf.printf
     "(* Warning: file generated by ./generate_includes.ml DO NOT EDIT *)\n\n"
 
-let output_env fs =
+let output_env env_names fs =
+  let formatted_names = List.map (Printf.sprintf "%S") env_names in
+  Printf.printf "let envs = [%s]\n" (String.concat "; " formatted_names);
   Printf.printf "let map_env = StringMap.empty\n" ;
   List.iter
     (fun (k,cts) ->
@@ -35,8 +37,12 @@ let output_env fs =
 let output_postlude () =
   let pp s = Printf.printf "%s\n" s in
   pp "let autoloader ~prefix ~path =" ;
+  pp "  let dir = Filename.basename prefix in" ;
+  pp "  let fname = if List.exists (String.equal dir) envs then" ;
+  pp "    Filename.concat dir path" ;
+  pp "  else path in" ;
   pp "  try" ;
-  pp "    ignore (prefix) ; Some (StringMap.find path map_env)" ;
+  pp "    Some (StringMap.find fname map_env)" ;
   pp "  with Not_found -> None" ;
   ()
 
@@ -84,30 +90,73 @@ let rec all_files do_rec m path d =
   done ;
   !mr
 
+let do_rec = ref false
+let envs = ref []
+
 let bind d f =
   let g = Filename.concat d (Filename.basename f) in
   f,read_file g
 
 let _ =
   let mr = ref StringMap.empty in
-  let k0,do_rec =
-    if Array.length Sys.argv < 2 then 1,false
-    else
-      match Sys.argv.(1) with
-      | "-rec" -> 2,true
-      | "-norec" -> 2,false
-      | _ -> 1,true in
-  for k = k0 to Array.length Sys.argv-1 do
-    mr := all_files do_rec !mr "" Sys.argv.(k)
-  done ;
+  let i = ref 1 in
+  let argc = Array.length Sys.argv in
+  let dirs = ref [] in
+
+  let rec parse () =
+    if !i >= argc then ()
+    else match Sys.argv.(!i) with
+    | "-rec" ->
+        do_rec := true ;
+        incr i ;
+        parse ()
+    | "-norec" ->
+        do_rec := false ;
+        incr i ;
+        parse ()
+    | "-envs" -> (* Self-contained cat environments, to set as libdirs.
+        They are passed as pairs of (name, path). The name will be used
+        as a path distinguisher inside the map_env for files under path *)
+        incr i ;
+        (* collect (name, dir) pairs until -- *)
+        while !i < argc && Sys.argv.(!i) <> "--" do
+          if !i + 1 >= argc then begin
+            Printf.eprintf "Error: -envs expects (name dir) pairs, got dangling name.\n" ;
+            exit 2
+          end ;
+          let name = Sys.argv.(!i) in
+          let dir  = Sys.argv.(!i + 1) in
+          envs := (name, dir) :: !envs ;
+          i := !i + 2
+        done ;
+        if !i < argc && Sys.argv.(!i) = "--" then incr i ;
+        parse ()
+    | s ->
+        dirs := s :: !dirs ;
+        incr i ;
+        parse ()
+  in
+  parse () ;
+
+  let dirs = List.rev !dirs in
+  let envs = List.rev !envs in
+  let env_names = List.map fst envs in
+
+  List.iter
+    (fun d -> mr := all_files !do_rec !mr "" d)
+    dirs ;
+  List.iter
+    (fun (name, d) -> mr := all_files !do_rec !mr name d)
+    envs ;
+
   begin match Filename.basename prog with
   | "generate_includes.ml" ->
       let files =
         StringMap.fold
           (fun f d k -> bind d f::k)
           !mr [] in
       output_header () ;
-      output_env files ;
+      output_env env_names files ;
       output_postlude ()
   | "generate_names.ml" ->
       let files =
diff --git a/herd-www/jerd.ml b/herd-www/jerd.ml
@@ -64,18 +64,30 @@ let set_defaults ()  =
   show := default.show
 
 (* Configure parser/models/etc. *)
-let run_herd bell cat litmus cfg =
+let run_herd bell cat litmus cfg cat_label =
 
   let bell = Js.to_string bell
   and cat = Js.to_string cat
   and litmus = Js.to_string litmus
-  and cfg = Js.to_string cfg in
+  and cfg = Js.to_string cfg
+  and cat_label = Js.to_string cat_label in
+
+  let cat_env_opt = match String.split_on_char '/' cat_label with
+  | [env; _] -> Some env
+  | _ -> None in
 
   if dbg then begin
-    eprintf "** bell **\n%s" bell ;
-    eprintf "** cat  **\n%s" cat ;
-    eprintf "** cfg  **\n%s" cfg ;
-    eprintf "** lit  **\n%s" litmus ;
+    eprintf "** bell      **\n%s\n" bell ;
+    eprintf "** cat       **\n%s\n" cat ;
+    eprintf "** cfg       **\n%s\n" cfg ;
+    eprintf "** lit       **\n%s\n" litmus ;
+    eprintf "** cat_label **\n%s\n" cat_label ;
+    begin match cat_env_opt with
+    | Some env ->
+      eprintf "** cat_env   **\n%s\n" env
+    | None ->
+      eprintf "** cat_env   **\n<none>\n"
+    end;
     ()
   end ;
 
@@ -111,11 +123,15 @@ let run_herd bell cat litmus cfg =
   end ;
   let args = ref [Filename.concat WebInput.webpath litmus_fname] in
 
+  let includes = Option.fold ~some:(fun env ->
+    WebInput.get_env_webpath env :: !includes
+  ) ~none:!includes cat_env_opt in
+
   (* Read generic model, if any *)
  let module ML =
     MyLib.Make
       (struct
-        let includes = !includes
+        let includes = includes
         let env = None
         let libdir = Version.libdir
         let debug = false
diff --git a/herd-www/webInput.ml b/herd-www/webInput.ml
@@ -75,6 +75,12 @@ let autoloader ~prefix ~path =
     try pp path (CatIncludes.autoloader ~prefix:prefix ~path:path)
     with Not_found ->  None
 
+let get_env_webpath path =
+  Filename.concat webpath path
+
 let register_autoloader () =
-  Js_of_ocaml.Sys_js.unmount ~path:webpath ;
-  Js_of_ocaml.Sys_js.mount ~path:webpath autoloader
+  let paths = webpath :: List.map get_env_webpath CatIncludes.envs in
+  List.iter (fun webpath ->
+    Js_of_ocaml.Sys_js.unmount ~path:webpath ;
+    Js_of_ocaml.Sys_js.mount ~path:webpath autoloader
+  ) paths
diff --git a/herd-www/webInput.mli b/herd-www/webInput.mli
@@ -23,5 +23,8 @@ val set_cat_str : string -> string
 val set_cfg_str : string -> string
 val set_litmus_str : string -> string
 
+(* Get the full pseudo file-system path for a cat environment *)
+val get_env_webpath : string -> string
+
 (* Initialise pseudo file-system *)
 val register_autoloader : unit -> unit
diff --git a/herd-www/www/jerd_driver.js b/herd-www/www/jerd_driver.js
@@ -21,6 +21,7 @@ function initCurrentState() {
         'shelf' : null,
         'compatNum' : null,
         'campaignCode' : [],
+        'catLabelPrefix' : '',
         'bell' : { 'origText' : null, 'origUrl' : null, 'pos' : null },
         'cat' : { 'origText' : null, 'origUrl' : null, 'pos' : null },
         'cfg' : { 'origText' : null, 'origUrl' : null, 'pos' : null },
@@ -42,6 +43,37 @@ function basename(path) {
     return path.split('/').pop()
 }
 
+// Longest common directory prefix among a list of URLs/paths.
+// Example:
+//   ["catalogue/aarch64/cats/aarch64.cat",
+//    "catalogue/aarch64/cats/ArmARM-L.b/aarch64.cat"]
+// -> "catalogue/aarch64/cats/"
+function commonDirPrefix(urls) {
+    if (!urls || urls.length === 0) return '';
+    var prefix = urls[0];
+    for (var i = 1; i < urls.length; i++) {
+        var u = urls[i];
+        var j = 0;
+        while (j < prefix.length && j < u.length && prefix[j] === u[j]) j++;
+        prefix = prefix.substring(0, j);
+        if (prefix === '') break;
+    }
+    // Only keep whole-directory prefix
+    var slash = prefix.lastIndexOf('/');
+    return slash >= 0 ? prefix.substring(0, slash + 1) : '';
+}
+
+// Label cats by stripping the common prefix (computed per-record).
+// Falls back to basename if the prefix isn't known or doesn't match.
+function catLabel(url) {
+    var prefix = currentState['catLabelPrefix'] || '';
+    if (url === null) return '';
+    if (prefix && url.indexOf(prefix) === 0) {
+        return url.substring(prefix.length);
+    }
+    return basename(url);
+}
+
 function shortname(path) {
     if (path === null) {
         return null
@@ -258,8 +290,9 @@ function populateEditorPanelHeader(id, elems) {
 }
 
 function prepareEditorFile(editorName, key, val, callback) {
-    var baseVal = basename(val);
-    var itemId = 'file-' + baseVal.replace(/\+/g, '.');
+    var baseVal = (editorName === 'cat') ? catLabel(val) : basename(val);
+    // baseVal may contain '/', so sanitize for HTML id usage.
+    var itemId = 'file-' + baseVal.replace(/\+/g, '.').replace(/\//g, '__');
 
     return $('<li/>')
         .append($('<a/>', {
@@ -333,7 +366,11 @@ function doDownloadAndSetEditorValue(url, name, pos) {
                 currentState[name]['pos'] = pos;
                 updateLinkToExample();
 
-                $(selectMenuIdOfEditorName(name)).html(basename(url));
+                if (name === 'cat') {
+                    $(selectMenuIdOfEditorName(name)).html(catLabel(url));
+                } else {
+                    $(selectMenuIdOfEditorName(name)).html(basename(url));
+                }
 
                 editors[name].setValue(data, -1);
                 if (name === 'litmus') {
@@ -815,6 +852,10 @@ function readRecord(record, displayName, compatNum, bellKey, catKey, cfgKey, lit
                 currentState['displayName'] = displayName;
                 currentState['shelf'] = resolveUrlsInShelf(result, record);
 
+                // Precompute the common prefix used to label cats uniquely.
+                // resolveUrlsInShelf has expanded entries to full URLs like "catalogue/<record>/<...>".
+                currentState['catLabelPrefix'] = commonDirPrefix(currentState['shelf']['cats'] || []);
+
                 updateAllEditors(compatNum, bellKey, catKey, cfgKey, litmusKey, false);
 
                 if (currentState['shelf']['compatibilities'] === null) {
@@ -960,11 +1001,16 @@ function jerdIt() {
     var catStr = editors['cat'].getValue();
     var cfgStr = editors['cfg'].getValue();
     var litmusStr = editors['litmus'].getValue();
+    var catSelectedLabel = '';
+    if (currentState['cat'] && currentState['cat']['origUrl'] !== null) {
+        catSelectedLabel = catLabel(currentState['cat']['origUrl']);
+    }
     runHerd(
         bellStr,
         catStr,
         litmusStr,
         cfgStr,
+        catSelectedLabel,
     );
     displayDotOutputs();
 }
@@ -980,12 +1026,17 @@ function jerdAll() {
                 var cfgStr = editors['cfg'].getValue();
                 var catStr = editors['cat'].getValue();
                 var litmusStr = data;
+                var catSelectedLabel = '';
+                if (currentState['cat'] && currentState['cat']['origUrl'] !== null) {
+                    catSelectedLabel = catLabel(currentState['cat']['origUrl']);
+                }
 
                 runHerd(
                     bellStr,
                     catStr,
                     litmusStr,
                     cfgStr,
+                    catSelectedLabel,
                 );
 
                 var herdOutput = editors['herdoutput'].getValue();
