Fix for macOS and CI improvements

grasph · grasph · commit 6c3e85cb0020 · 2026-01-11T23:49:51.000+01:00
CI:
  - add julia package cache in CI (julia-ations/cache)
  - add cache of ROOT install for test-macos
  - activate annotate option of julia-runtests: "create GitHub annotations to show test failures inlines"
  - add julia version '1' (latest release) in the matrix
  - add macos x86 in the matrix
  - cleanup: removed commented line of LFFLAGS, CPPFLAGS. etc. environment variable setttings
  - fix CI to get logs displayed during compilation of wrapper library in the macOS test.

Fix compilation of wrapper for macos:
  - set flag to disable std::ranges if used libcxxwrap_julia_stl library was built with an old c++ library missing it.
  - remove ROOT!AddClass(...) wrappers that triggers a link error on ARM64 (tested with macOS)

Wrapper compilation performance:
  - Add header precompilation.

Add the "no_auto_compile" ROOT package preference to allow disabling wrapper library build on package import (used in macos test CI).

Code generated with ROOT.jl-generator commit 8aca08bfa1abc635adf866c31d018d7d8d69f575
diff --git a/.github/workflows/test-linux.yml b/.github/workflows/test-linux.yml
@@ -7,7 +7,7 @@ on:
 
 defaults:
   run:
-    shell: bash
+    shell: bash -l {0}
  
 jobs:
   test:
@@ -18,6 +18,7 @@ jobs:
       matrix:
         version:
           - '1.10'
+          - '1'
         os:
           - ubuntu-latest
 #          - macOS-latest
@@ -31,5 +32,9 @@ jobs:
         with:
           version: ${{ matrix.version }}
           arch: ${{ matrix.arch }}
-      - uses: julia-actions/julia-buildpkg@latest
-      - uses: julia-actions/julia-runtest@latest
+      - uses: julia-actions/cache@v2
+      #- uses: julia-actions/julia-buildpkg@latest
+      - name: Run package tests
+        uses: julia-actions/julia-runtest@latest
+        with:
+          annotate: true 
diff --git a/.github/workflows/test-macos.yml b/.github/workflows/test-macos.yml
@@ -18,11 +18,13 @@ jobs:
       matrix:
         version:
           - '1.10'
+          - '1'
         os:
 #          - ubuntu-latest
           - macOS-latest
         arch:
           - aarch64
+          - x64
     steps:
       - uses: actions/checkout@v3
         with:
@@ -31,27 +33,33 @@ jobs:
         with:
           version: ${{ matrix.version }}
           arch: ${{ matrix.arch }}
+      - uses: julia-actions/cache@v2
+      - name: Cache ROOT install
+        id: cache-root-install
+        uses: actions/cache@v5
+        with:
+          path: conda_for_rootjl
+          key: ${{ runner.os }}-${{ matrix.arch }}-root-${{ hashFiles('.github/workflows/install_root_with_conda.sh')}}
       - name: Install ROOT
+        if: steps.cache-root-install.outputs.cache-hit != 'true'
         run: |
              CONDA_BINDIR="`sh .github/workflows/install_root_with_conda.sh | tail -n 1`"
              source "$CONDA_BINDIR/activate"
              cat >> "$GITHUB_ENV" <<EOF
-             #LDFLAGS="$LDFLAGS"
-             #CPPFLAGS="$CPPFLAGS"
-             #LIBTOOL="$LIBTOOL"
-             #CXXFLAGS="$CXXFLAGS"
-             #CPP="$CPP"
              PATH="$PATH"
-             #LD="$LD"
              CXX="$CXX"
-             #CFLAGS="$CFLAGS"
-             #CC="$CC"
              EOF
              echo -n "ROOT binary: " 1>&2
              which root 1>&2
       - name: Build the Julia wrapper library
         run: |
-             julia --project=@. -e 'import Pkg; Pkg.add("ROOTprefs"); using ROOTprefs; set_use_root_jll(false); set_ROOTSYS()' 1>&2
+             cd ..
+             #for some reason in auto-compile mode, the compilation logs are not displayed when run in the CI. Use explicit compile call.
+             julia --project=@. -e 'import Pkg; Pkg.add("ROOTprefs"); using ROOTprefs; ROOTprefs._set_preference("no_auto_compile", true); Pkg.add(path="./ROOT.jl"); import ROOT; ROOT.cxxcompile();' 1>&2
+             #trigger package precompilation
              julia --project=@. -e 'import ROOT' 1>&2
       #- uses: julia-actions/julia-buildpkg@latest
-      - uses: julia-actions/julia-runtest@latest
+      - name: Run package tests
+        uses: julia-actions/julia-runtest@latest
+        with:
+          annotate: true 
diff --git a/.gitignore b/.gitignore
@@ -21,3 +21,4 @@ test/test1.root
 test/test2.root
 test/test3.root
 LocalPreferences.toml
+local
diff --git a/deps/Makefile b/deps/Makefile
@@ -9,7 +9,15 @@ UNAME=$(shell uname)
 ROOT_LIBS = $(shell $(ROOT_CONFIG) --libs) -lGeom
 ROOT_INC_DIR = $(shell $(ROOT_CONFIG) --incdir)
 
+JULIA = julia
+
 CPPFLAGS = -MMD -I. -I $(CXXWRAP_PREFIX)/include
+#JCXX_HAS_RANGE must be set to 0 if libcxxwrap_julia_stl.so was compiled without std::ranges support
+#JLCXX_HAS_RANGE = isdefined(CxxWrap.StdLib, :HAS_RANGES) ? 1 : 0
+#Disable dependencies on std::ranges if libcxxwrap_julis_stl.so was compiled without it
+ifeq ($(JLCXX_HAS_RANGES), 0)
+   CPPFLAGS += -DJLCXX_FORCE_RANGES_OFF
+endif
 CXXFLAGS = $(patsubst -std=gnu%,,$(shell $(JL_SHARE)/julia-config.jl --cflags))
 CXXFLAGS += $(shell $(ROOT_CONFIG) --cflags)
 CXXFLAGS += -I$(VDT_DIR)/include
@@ -19,7 +27,6 @@ CXXFLAGS += -Wno-c++20-extensions
 #CXXFLAGS += -Wall -O0 -g     #To compile with debugger infomation
 LDFLAGS = $(shell $(JL_SHARE)/julia-config.jl --ldflags)
 LDLIBS = $(shell $(JL_SHARE)/julia-config.jl --ldlibs) -L$(CXXWRAP_PREFIX)/lib -lcxxwrap_julia -lcxxwrap_julia_stl
-JULIA = julia
 
 CXX_IS_CLANG = $(shell $(CXX) -dM -E - < /dev/null | grep -c __clang__)
 
@@ -39,8 +46,10 @@ endif
 
 ifneq ($(CXX_IS_CLANG), 0)
 	CXXFLAGS += -ferror-limit=3
+	PCH_SUFFIX=.pch
 else #assuming gcc
 	CXXFLAGS += -fmax-errors=3
+	PCH_SUFFIX=.gch
 endif
 
 
@@ -94,17 +103,30 @@ JULIA_LOAD_PATH=`pwd`/build/ROOT/src:$(JULIA_LOAD_PATH): "$(JULIA)" --project=..
 JULIA_LOAD_PATH=`pwd`/build/ROOT/src:$(JULIA_LOAD_PATH): "$(JULIA)" --project=.. TTree_examples/write_tree3.jl \
 && JULIA_LOAD_PATH=`pwd`/build/ROOT/src:$(JULIA_LOAD_PATH): "$(JULIA)" --project=.. TTree_examples/read_tree3.jl
 
-$(BUILD_DIR)/%.o: src/%.cxx
+#$(BUILD_DIR)/pch.h: 
+#	$(Q) [ -d $(BUILD_DIR)/libROOT/build ] || mkdir -p $(BUILD_DIR)/libROOT/build
+#	echo '#include "Wrapper.h"\n#include "jlROOT.h"\n#include "jlcxx/functions.hpp"\n#include "jlcxx/stl.hpp"\n' > $@
+#
+#$(BUILD_DIR)/%.h$(PCH_SUFFIX): $(BUILD_DIR)/%.h
+#	@echo "Precompile the header files."
+#	$(Q) $(COMPILE.cc) $(CPPFLAGS) -I src -x c++-header -o $@ $<
+
+$(BUILD_DIR)/pch.h$(PCH_SUFFIX):
+	@echo "Precompile the header files."
+	$(Q) [ -d $(BUILD_DIR)/include ] || mkdir -p $(BUILD_DIR)/include
+	$(Q)echo '#include "Wrapper.h"\n#include "jlROOT.h"\n#include "jlcxx/functions.hpp"\n#include "jlcxx/stl.hpp"\n' > $(BUILD_DIR)/include/pch.h
+	$(Q) $(COMPILE.cc) -Isrc -x c++-header -o $@ $(BUILD_DIR)/include/pch.h
+
+$(BUILD_DIR)/%.o: src/%.cxx $(BUILD_DIR)/pch.h$(PCH_SUFFIX)
 	@echo "Make $(notdir $@)"
-	$(Q) [ -d $(BUILD_DIR)/libROOT/build ] || mkdir -p $(BUILD_DIR)/libROOT/build
-	$(Q) $(COMPILE.cc) $(CPPFLAGS) -o $@ $<
+	$(Q) [ -d $(BUILD_DIR) ] || mkdir -p $(BUILD_DIR)
+	$(Q) $(COMPILE.cc) -include $(BUILD_DIR)/pch.h -o $@ $<
 
 $(BUILD_DIR)/libroot_julia$(SO_SUFFIX): $(OBJS)
 	@echo "Make $(notdir $@)"
 	$(Q) $(MAKE) check_root
 	$(Q) $(LINK.o) -o $@ --shared -fPIC $(OBJS) $(ROOT_LIBS) $(LDLIBS)
 
-
 echo_%:
 	@echo "$* = $(subst ",\",$($*))"
 
diff --git a/deps/pch.h b/deps/pch.h
@@ -0,0 +1 @@
+#error "Failed to use precompile headers."
diff --git a/deps/src/JlGlobals.cxx b/deps/src/JlGlobals.cxx
@@ -20,10 +20,12 @@ struct JlGlobal: public Wrapper {
     // defined in /home/pgras/.julia/artifacts/541477a5cefd778e4ecbd314cfbc99eed20f2c4c/include/Rtypes.h:120:19
     t.method("ROOT!CreateClass", [](const char * arg0, int16_t arg1, const std::type_info & arg2, TVirtualIsAProxy * arg3, const char * arg4, const char * arg5, int32_t arg6, int32_t arg7)->TClass * { return ROOT::CreateClass(arg0, (Version_t)arg1, arg2, arg3, arg4, arg5, (Int_t)arg6, (Int_t)arg7); }, jlcxx::arg("this"), jlcxx::arg("cname"), jlcxx::arg("id"), jlcxx::arg("info"), jlcxx::arg("isa"), jlcxx::arg("dfil"), jlcxx::arg("ifil"), jlcxx::arg("dl"), jlcxx::arg("il"));
 
+    /* Link fails on ARM64
     DEBUG_MSG("Adding wrapper for void ::ROOT::AddClass(const char *, Version_t, const std::type_info &, DictFuncPtr_t, Int_t) (" __HERE__ ")");
     // signature to use in the veto list: void ::ROOT::AddClass(const char *, Version_t, const std::type_info &, DictFuncPtr_t, Int_t)
     // defined in /home/pgras/.julia/artifacts/541477a5cefd778e4ecbd314cfbc99eed20f2c4c/include/Rtypes.h:124:16
     t.method("ROOT!AddClass", [](const char * arg0, int16_t arg1, const std::type_info & arg2, DictFuncPtr_t arg3, int32_t arg4)->void { ROOT::AddClass(arg0, (Version_t)arg1, arg2, arg3, (Int_t)arg4); }, jlcxx::arg("this"), jlcxx::arg("cname"), jlcxx::arg("id"), jlcxx::arg("info"), jlcxx::arg("dict"), jlcxx::arg("pragmabits"));
+    */
 
     DEBUG_MSG("Adding wrapper for void ::ROOT::RemoveClass(const char *, TClass *) (" __HERE__ ")");
     // signature to use in the veto list: void ::ROOT::RemoveClass(const char *, TClass *)
@@ -1060,10 +1062,13 @@ struct JlGlobal: public Wrapper {
 
     module_.unset_override_module();
 
+    /*Link fails on ARM64
     DEBUG_MSG("Adding wrapper for void ::ROOT::AddClass(const char *, Version_t, DictFuncPtr_t, Int_t) (" __HERE__ ")");
     // signature to use in the veto list: void ::ROOT::AddClass(const char *, Version_t, DictFuncPtr_t, Int_t)
     // defined in /home/pgras/.julia/artifacts/541477a5cefd778e4ecbd314cfbc99eed20f2c4c/include/TClassTable.h:100:16
     t.method("ROOT!AddClass", [](const char * arg0, int16_t arg1, DictFuncPtr_t arg2, int32_t arg3)->void { ROOT::AddClass(arg0, (Version_t)arg1, arg2, (Int_t)arg3); }, jlcxx::arg("this"), jlcxx::arg("cname"), jlcxx::arg("id"), jlcxx::arg("dict"), jlcxx::arg("pragmabits"));
+    */
+    
     module_.set_override_module(jl_base_module);
 
     DEBUG_MSG("Adding wrapper for TBuffer & ::operator>>(TBuffer &, TArrayL *&) (" __HERE__ ")");
diff --git a/deps/src/Wrapper.h b/deps/src/Wrapper.h
@@ -1,3 +1,5 @@
+#ifndef WRAPPER_H
+#define WRAPPER_H
 #include "jlcxx/jlcxx.hpp"
 
 struct Wrapper{
@@ -8,3 +10,4 @@ struct Wrapper{
 protected:
   jlcxx::Module& module_;
 };
+#endif //WRAPPER_H not defined
diff --git a/deps/src/jlROOT.h b/deps/src/jlROOT.h
@@ -1,3 +1,5 @@
+#ifndef JLROOT_H
+#define JLROOT_H
 #include "TVectorT.h"
 #include "cstdint"
 #include "Buttons.h"
@@ -301,3 +303,4 @@
 #include "TVirtualGeoPainter.h"
 #include "TVirtualGeoTrack.h"
 #include "TVirtualMagField.h"
+#endif //JLROOT_H not defined
diff --git a/deps/src/pch.h b/deps/src/pch.h
@@ -0,0 +1 @@
+#error "Failed to use precompile headers."
diff --git a/src/CxxBuild.jl b/src/CxxBuild.jl
@@ -35,7 +35,7 @@ end
 # Build the libroot_julia library for the ROOT libraries installed under rootsys directory.
 # Return the full path to libroot_julia or an empty string in case of failure.
 #
-function build_root_wrapper(rootsys = ROOTprefs.get_ROOTSYS())
+function build_root_wrapper(rootsys=ROOTprefs.get_ROOTSYS(); nobuild=false)
 
     rootconfig = joinpath(rootsys, "bin", "root-config")
     used_root_version = readchomp(`$rootconfig --version`)
@@ -51,9 +51,10 @@ function build_root_wrapper(rootsys = ROOTprefs.get_ROOTSYS())
     CXXWRAP_PREFIX = CxxWrap.prefix_path()
     JL_SHARE = joinpath(Sys.BINDIR, Base.DATAROOTDIR, "julia")
     JULIA = joinpath(Sys.BINDIR, "julia")
+    JLCXX_HAS_RANGES = isdefined(CxxWrap.StdLib, :HAS_RANGES) ? 1 : 0
     depsdir = joinpath(dirname(@__DIR__), "deps")
     srcdir = joinpath(depsdir, "src")
-    cmd=`make -C "$depsdir" BUILD_DIR="$buildpath" CXXWRAP_PREFIX="$CXXWRAP_PREFIX" JL_SHARE="$JL_SHARE" JULIA="$JULIA" ROOT_CONFIG="$rootconfig" -j $(Sys.CPU_THREADS) VDT_DIR="$(VDT_jll.artifact_dir)"`
+    cmd=`make -C "$depsdir" BUILD_DIR="$buildpath" CXXWRAP_PREFIX="$CXXWRAP_PREFIX" JL_SHARE="$JL_SHARE" JULIA="$JULIA" ROOT_CONFIG="$rootconfig" -j $(Sys.CPU_THREADS) VDT_DIR="$(VDT_jll.artifact_dir)" JLCXX_HAS_RANGES=$(JLCXX_HAS_RANGES)`
     extra_make_options = ROOTprefs._load_preference("extra_make_options", "")
     if !isempty(extra_make_options)
         cmd = Cmd([collect(cmd)..., extra_make_options])
@@ -80,7 +81,7 @@ function build_root_wrapper(rootsys = ROOTprefs.get_ROOTSYS())
         end
     end
 
-    build = true
+    libready = false
     
     #Check if library is already built and up-to-date. Returns if it's the case.
     sigfile = joinpath(scratch, "sig")
@@ -90,12 +91,22 @@ function build_root_wrapper(rootsys = ROOTprefs.get_ROOTSYS())
         oldsig = readline(sigfile)
         if newsig == oldsig
             @info "Library $libpath is already up-to-date."
-            build = false
+            libready = true
         end
         t1 = time()
         @info "Time spent to check for modifications in the ROOT-julia library source code that would require a compilation: $(round(t1-t0, digits=2)) s"
     end
 
+    build = if libready
+        false
+    elseif nobuild
+        libpath = ""
+        @info "Build skipped as required by the no_auto_compile preference setting."
+        false
+    else
+        true
+    end
+
     if build
         @info "Build command: " * string(cmd)[2:end-1] * " executed in " * pwd() * " directory."
     
@@ -248,7 +259,7 @@ function check_rootsys()
 end
 
 
-function get_or_build_libroot_julia()
+function get_or_build_libroot_julia(;nobuild=false)
 
     if get_use_root_jll() && is_jll_supported()
         #prebuilt wrapper used, no build to perform
@@ -285,7 +296,7 @@ function get_or_build_libroot_julia()
         end
     end
 
-    libpath =  build_root_wrapper(rootsys)
+    libpath =  build_root_wrapper(rootsys, nobuild=nobuild)
    
     if !isempty(libpath) && rootsys != pref_rootsys
       #If build succeeded and ROOTSYS was modified, update LocalPreference.toml
diff --git a/src/ROOT.jl b/src/ROOT.jl
@@ -34,12 +34,19 @@ Value of ROOTSYS preference when this module was precompiled.
 """
 const rootsys = ROOTprefs.get_ROOTSYS()
 
+"""
+  `libroot_julia_from_jll`
+
+Flag telling if the package was precompiled with the C++ wrapper library from the jll package (true) or built for an external C++ ROOT installation (false).
+"""
+const libroot_julia_from_jll = root_jll_preferred && Internals.CxxBuild.is_jll_supported()
+
 """
   `libroot_julia_path`
 
 Path of the shared library containing the C++ code interfacing the Julia ROOT package with the C++ ROOT libraries. This library is provided by the package ROOT_julia_jll included in the dependency, when the C++ ROOT libraries are installed by the Julia package manager from the ROOT_jll package, or built on the fly (at first ROOT module import), if they are installed by another mean. 
 """
-const libroot_julia_path =  Internals.CxxBuild.get_or_build_libroot_julia() 
+const libroot_julia_path =  Internals.CxxBuild.get_or_build_libroot_julia(nobuild=Preferences.load_preference("ROOT", "no_auto_compile", false))
 
 const _libroot_compilation_failed = if isempty(libroot_julia_path) #precompilation failed
    # trick to invalidate the precompilation cache
@@ -48,14 +55,6 @@ const _libroot_compilation_failed = if isempty(libroot_julia_path) #precompilati
    ROOTprefs._load_preference("internal_compilation_failed", true)
 end
 
-
-"""
-  `libroot_julia_from_jll`
-
-Flag telling if the package was precompiled with the C++ wrapper library from the jll package (true) or built for an external C++ ROOT installation (false).
-"""
-const libroot_julia_from_jll = root_jll_preferred && Internals.CxxBuild.is_jll_supported()
-
 # Display libroot_julia_path value on precompilation
 isempty(libroot_julia_path) || (@info "ROOT wrapper library: $libroot_julia_path")
 
@@ -105,7 +104,7 @@ end
 function __init__()
     if !ok()
         ROOTprefs._set_preference("internal_compilation_failed", nothing)
-        @warn "The imported ROOT module is empty because of the error mentioned above. To import the module again after resolving the issue, a restart of Julia is required."
+        @warn "The imported ROOT module is empty because its c++ part is not compiled. Use ROOT.cxxcompile() to compile it. After compilation, restart of Julia is required after the compilation."
     else
         libroot_julia_from_jll && Internals.loadlibdeps()
         @initcxx

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+#error "Failed to use precompile headers."`