Zcheri risc-v integration. Temporary branch for CI

combine-files.py

@@ -151,6 +151,7 @@ def check_all_files_used(directory: Path):
 add_filtered_file(script_dir / "projects/cross/crosscompileproject.py")
 add_filtered_file(script_dir / "projects/cross/benchmark_mixin.py")
 add_filtered_file(script_dir / "projects/cross/llvm_test_suite.py")
+add_filtered_file(script_dir / "projects/cross/opensbi.py")
 # disk-image, sdk and run_qemu must come after cheribsd as they use CheriBSD.rootfs_dir
 add_filtered_file(script_dir / "projects/disk_image.py")
 add_filtered_file(script_dir / "projects/run_qemu.py")

pycheribuild/boot_cheribsd/__init__.py

@@ -53,6 +53,7 @@
 from typing import Callable, Optional, Union
 
 from ..colour import AnsiColour, coloured
+from ..config.chericonfig import RiscvCheriISA
 from ..config.compilation_targets import CompilationTargets, CrossCompileTarget
 from ..processutils import commandline_to_str, keep_terminal_sane, run_and_kill_children_on_exit
 from ..qemu_utils import QemuOptions, riscv_bios_arguments
@@ -916,7 +917,7 @@ def boot_cheribsd(
     if bios_path is not None:
         bios_args = ["-bios", str(bios_path)]
     elif qemu_options.xtarget.is_riscv(include_purecap=True):
-        bios_args = riscv_bios_arguments(qemu_options.xtarget, None)
+        bios_args = riscv_bios_arguments(qemu_options.xtarget, qemu_options.riscv_cheri_isa)
     else:
         bios_args = []
     qemu_args = qemu_options.get_commandline(
@@ -1516,7 +1517,12 @@ def _main(
     if argparse_adjust_args_callback:
         argparse_adjust_args_callback(args)
 
-    qemu_options = QemuOptions(xtarget)
+    riscv_cheri_isa = None
+    # Slightly ugly hack to avoid having to pass yet another argument for something
+    # that is a temporary workaround until ISAv9 is gone.
+    if args.qemu_cmd is not None and str(args.qemu_cmd).endswith("cheristd"):
+        riscv_cheri_isa = RiscvCheriISA.STD
+    qemu_options = QemuOptions(xtarget, riscv_cheri_isa=riscv_cheri_isa)
     if args.qemu_cmd is not None:
         if not Path(args.qemu_cmd).exists():
             failure("ERROR: Cannot find QEMU binary ", args.qemu_cmd, " doesn't exist", exit=True)

pycheribuild/config/chericonfig.py

@@ -123,6 +123,11 @@ def clang_march_flag(self) -> str:
         return self.value[1]
 
 
+class RiscvCheriISA(Enum):
+    V9 = "v9"
+    STD = "std"
+
+
 class RiscvFloatAbi(Enum):
     SOFT = "soft"
     HARD = "hard"
@@ -319,6 +324,13 @@ def __init__(self, loader, action_class: "type[CheribuildActionEnum]") -> None:
         self.skip_configure: "Optional[bool] " = None
         self.force_configure: "Optional[bool] " = None
         self.force_update: "Optional[bool] " = None
+        self.riscv_cheri_isa = loader.add_option(
+            "riscv-cheri-isa",
+            default=RiscvCheriISA.V9,
+            type=RiscvCheriISA,
+            group=loader.cross_compile_options_group,
+            help="The CHERI ISA to target for RISC-V code",
+        )
         self.mips_float_abi = loader.add_option(
             "mips-float-abi",
             default=MipsFloatAbi.SOFT,
@@ -455,6 +467,7 @@ def __init__(self, loader, action_class: "type[CheribuildActionEnum]") -> None:
         self.cheribsd_image_root: Optional[Path] = None
         self.cheri_sdk_dir: Optional[Path] = None
         self.morello_sdk_dir: Optional[Path] = None
+        self.cheri_alliance_sdk_dir: Optional[Path] = None
         self.other_tools_dir: Optional[Path] = None
         self.sysroot_output_root: Optional[Path] = None
         self.docker = loader.add_bool_option(
@@ -737,6 +750,10 @@ def default_cheri_sdk_directory_name(self) -> str:
     def default_morello_sdk_directory_name(self) -> str:
         return "morello-sdk"
 
+    @property
+    def default_cheri_alliance_sdk_directory_name(self) -> str:
+        return "cheri-alliance-sdk"
+
     @property
     def cheri_sdk_bindir(self):
         return self.cheri_sdk_dir / "bin"
@@ -745,6 +762,14 @@ def cheri_sdk_bindir(self):
     def morello_sdk_bindir(self):
         return self.morello_sdk_dir / "bin"
 
+    @property
+    def cheri_alliance_sdk_bindir(self):
+        return self.cheri_alliance_sdk_dir / "bin"
+
+    @property
+    def cheri_alliance_qemu_bindir(self):
+        return self.cheri_alliance_sdk_bindir
+
     @property
     def qemu_bindir(self):
         return self.cheri_sdk_bindir

pycheribuild/config/compilation_targets.py

@@ -40,7 +40,7 @@
 from pathlib import Path
 from typing import Optional
 
-from .chericonfig import CheriConfig
+from .chericonfig import CheriConfig, RiscvCheriISA
 from .config_loader_base import ConfigLoaderBase, ConfigOptionHandle
 from .target_info import (
     AArch64FloatSimdOptions,
@@ -84,8 +84,12 @@ def get_qemu_mfs_root_kernel(self, use_benchmark_kernel: bool) -> Path:
 
 @functools.lru_cache(maxsize=20)
 def _linker_supports_riscv_relaxations(linker: Path, config: CheriConfig, xtarget: "CrossCompileTarget") -> bool:
-    if xtarget.is_hybrid_or_purecap_cheri():
+    # XXX-AM: Hack: codasip lld does not seem to play nice with -mrelax and cheri
+    if config.riscv_cheri_isa == RiscvCheriISA.STD:
         return False
+    elif xtarget.is_hybrid_or_purecap_cheri():
+        return False
+
     try:
         linker_version = get_version_output(linker, config=config)
     except subprocess.CalledProcessError as e:
@@ -118,15 +122,17 @@ def sdk_root_dir(self) -> Path:
         return self._sdk_root_dir
 
     @classmethod
-    def _get_compiler_project(cls) -> "type[BuildLLVMInterface]":
+    def _get_compiler_project(cls, config: CheriConfig) -> "type[BuildLLVMInterface]":
         raise NotImplementedError()
 
     def _get_sdk_root_dir_lazy(self) -> Path:
-        return self._get_compiler_project().get_native_install_path(self.config)
+        return self._get_compiler_project(self.config).get_native_install_path(self.config)
 
     @classmethod
     def toolchain_targets(cls, target: "CrossCompileTarget", config: "CheriConfig") -> "list[str]":
-        return [cls._get_compiler_project().get_class_for_target(BasicCompilationTargets.NATIVE_NON_PURECAP).target]
+        return [
+            cls._get_compiler_project(config).get_class_for_target(BasicCompilationTargets.NATIVE_NON_PURECAP).target
+        ]
 
     def _rootfs_path(self) -> Path:
         xtarget = self.target.get_rootfs_target()
@@ -277,7 +283,7 @@ def essential_compiler_and_linker_flags_impl(
                     result.append("-mcpu=beri")
         elif xtarget.is_riscv(include_purecap=True):
             # Use the insane RISC-V arch string to enable CHERI
-            result.append("-march=" + cls.get_riscv_arch_string(xtarget, softfloat=softfloat))
+            result.append("-march=" + cls.get_riscv_arch_string(xtarget, config, softfloat=softfloat))
             result.append("-mabi=" + cls.get_riscv_abi(xtarget, softfloat=softfloat))
             result.append(
                 "-mrelax" if _linker_supports_riscv_relaxations(instance.linker, config, xtarget) else "-mno-relax"
@@ -313,15 +319,19 @@ def essential_compiler_and_linker_flags_impl(
         return result
 
     @classmethod
-    def get_riscv_arch_string(cls, xtarget: CrossCompileTarget, softfloat: bool) -> str:
+    def get_riscv_arch_string(cls, xtarget: CrossCompileTarget, config: CheriConfig, softfloat: bool) -> str:
         assert xtarget.is_riscv(include_purecap=True)
         # Use the insane RISC-V arch string to enable CHERI
         arch_string = "rv" + str(xtarget.cpu_architecture.word_bits()) + "ima"
         if not softfloat:
             arch_string += "fd"
         arch_string += "c"
         if xtarget.is_hybrid_or_purecap_cheri():
-            arch_string += "xcheri"
+            if config.riscv_cheri_isa == RiscvCheriISA.V9:
+                arch_string += "xcheri"
+            else:
+                assert config.riscv_cheri_isa == RiscvCheriISA.STD
+                arch_string += "zcherihybrid"
         return arch_string
 
     @classmethod
@@ -366,7 +376,7 @@ def _get_sdk_root_dir_lazy(self) -> Path:
             # If we couldn't find a working system compiler, default to cheribuild-compiled upstream LLVM.
             assert fbsd.build_toolchain == CompilerType.DEFAULT_COMPILER
             # noinspection PyUnresolvedReferences
-            return self._get_compiler_project().get_native_install_path(self.config)
+            return self._get_compiler_project(self.config).get_native_install_path(self.config)
         return configured_path
 
     @property
@@ -464,7 +474,7 @@ def localbase(self) -> Path:
         return Path("usr/local")
 
     @classmethod
-    def _get_compiler_project(cls) -> "type[BuildLLVMInterface]":
+    def _get_compiler_project(cls, config: CheriConfig) -> "type[BuildLLVMInterface]":
         return typing.cast("type[BuildLLVMInterface]", SimpleProject.get_class_for_target_name("upstream-llvm", None))
 
     def _get_rootfs_class(self, xtarget: "CrossCompileTarget") -> "type[SimpleProject]":
@@ -502,7 +512,7 @@ def has_test_extra_arg_override(arg: str):
         rootfs_xtarget = xtarget.get_rootfs_target()
         from ..qemu_utils import QemuOptions
 
-        qemu_options = QemuOptions(rootfs_xtarget)
+        qemu_options = QemuOptions(rootfs_xtarget, riscv_cheri_isa=self.config.riscv_cheri_isa)
         run_instance: LaunchFreeBSDInterface = self._get_run_project(rootfs_xtarget, self.project)
         if rootfs_xtarget.cpu_architecture not in (
             CPUArchitecture.MIPS64,
@@ -635,8 +645,12 @@ class CheriBSDTargetInfo(FreeBSDTargetInfo):
     FREEBSD_VERSION: int = 13
 
     @classmethod
-    def _get_compiler_project(cls) -> "type[BuildLLVMInterface]":
-        return typing.cast("type[BuildLLVMInterface]", SimpleProject.get_class_for_target_name("llvm", None))
+    def _get_compiler_project(cls, config: CheriConfig) -> "type[BuildLLVMInterface]":
+        if config.riscv_cheri_isa == RiscvCheriISA.STD:
+            llvm_target = SimpleProject.get_class_for_target_name("cheri-alliance-llvm", None)
+        else:
+            llvm_target = SimpleProject.get_class_for_target_name("llvm", None)
+        return typing.cast("type[BuildLLVMInterface]", llvm_target)
 
     def _get_run_project(self, xtarget: "CrossCompileTarget", caller: SimpleProject) -> LaunchFreeBSDInterface:
         result = SimpleProject.get_instance_for_target_name("run", xtarget, caller.config, caller)
@@ -703,7 +717,7 @@ class CheriBSDMorelloTargetInfo(CheriBSDTargetInfo):
     uses_morello_llvm: bool = True
 
     @classmethod
-    def _get_compiler_project(cls) -> "type[BuildLLVMInterface]":
+    def _get_compiler_project(cls, config: CheriConfig) -> "type[BuildLLVMInterface]":
         return typing.cast("type[BuildLLVMInterface]", SimpleProject.get_class_for_target_name("morello-llvm", None))
 
     @classmethod
@@ -739,10 +753,10 @@ def _get_rootfs_class(self, xtarget: "CrossCompileTarget") -> "type[SimpleProjec
         raise LookupError("Should not be called")
 
     def _get_sdk_root_dir_lazy(self) -> Path:
-        return self._get_compiler_project().get_native_install_path(self.config)
+        return self._get_compiler_project(self.config).get_native_install_path(self.config)
 
     @classmethod
-    def _get_compiler_project(cls) -> "type[BuildLLVMInterface]":
+    def _get_compiler_project(cls, config: CheriConfig) -> "type[BuildLLVMInterface]":
         return typing.cast("type[BuildLLVMInterface]", SimpleProject.get_class_for_target_name("cherios-llvm", None))
 
     @property
@@ -809,7 +823,7 @@ def sysroot_install_prefix_relative(self) -> Path:
         return Path(self.target_triple)
 
     @classmethod
-    def _get_compiler_project(cls) -> "type[BuildLLVMInterface]":
+    def _get_compiler_project(cls, config: CheriConfig) -> "type[BuildLLVMInterface]":
         return typing.cast("type[BuildLLVMInterface]", SimpleProject.get_class_for_target_name("llvm", None))
 
     @property
@@ -861,7 +875,7 @@ def sysroot_dir(self) -> Path:
         return sysroot_dir / "baremetal" / suffix
 
     @classmethod
-    def _get_compiler_project(cls) -> "type[BuildLLVMInterface]":
+    def _get_compiler_project(cls, config: CheriConfig) -> "type[BuildLLVMInterface]":
         return typing.cast("type[BuildLLVMInterface]", SimpleProject.get_class_for_target_name("llvm", None))
 
     @classmethod
@@ -947,7 +961,7 @@ def sysroot_dir(self) -> Path:
         return result
 
     @classmethod
-    def _get_compiler_project(cls) -> "type[BuildLLVMInterface]":
+    def _get_compiler_project(cls, config: CheriConfig) -> "type[BuildLLVMInterface]":
         return typing.cast("type[BuildLLVMInterface]", SimpleProject.get_class_for_target_name("llvm", None))
 
     @property
@@ -1021,8 +1035,12 @@ class BaremetalFreestandingTargetInfo(BaremetalClangTargetInfo):
     os_prefix: str = "baremetal-"
 
     @classmethod
-    def _get_compiler_project(cls) -> "type[BuildLLVMInterface]":
-        return typing.cast("type[BuildLLVMInterface]", SimpleProject.get_class_for_target_name("llvm", None))
+    def _get_compiler_project(cls, config: CheriConfig) -> "type[BuildLLVMInterface]":
+        if config.riscv_cheri_isa == RiscvCheriISA.STD:
+            llvm_target = SimpleProject.get_class_for_target_name("cheri-alliance-llvm", None)
+        else:
+            llvm_target = SimpleProject.get_class_for_target_name("llvm", None)
+        return typing.cast("type[BuildLLVMInterface]", llvm_target)
 
     @classmethod
     def base_sysroot_targets(cls, target: "CrossCompileTarget", config: "CheriConfig") -> "list[str]":
@@ -1036,7 +1054,10 @@ def triple_for_target(cls, target: "CrossCompileTarget", config: "CheriConfig",
 
     @property
     def sysroot_dir(self) -> Path:
-        sysroot_dir = self.config.sysroot_output_root / self.config.default_cheri_sdk_directory_name
+        if self.config.riscv_cheri_isa == RiscvCheriISA.STD:
+            sysroot_dir = self.config.sysroot_output_root / self.config.default_cheri_alliance_sdk_directory_name
+        else:
+            sysroot_dir = self.config.sysroot_output_root / self.config.default_cheri_sdk_directory_name
         return sysroot_dir / "baremetal" / self.target.get_rootfs_target().generic_arch_suffix
 
 
@@ -1046,7 +1067,7 @@ class MorelloBaremetalTargetInfo(BaremetalFreestandingTargetInfo):
     uses_morello_llvm: bool = True
 
     @classmethod
-    def _get_compiler_project(cls) -> "type[BuildLLVMInterface]":
+    def _get_compiler_project(cls, config: CheriConfig) -> "type[BuildLLVMInterface]":
         return typing.cast("type[BuildLLVMInterface]", SimpleProject.get_class_for_target_name("morello-llvm", None))
 
     @property

pycheribuild/config/defaultconfig.py

@@ -234,6 +234,16 @@ def __init__(self, loader: ConfigLoaderBase, available_targets: "list[str]") ->
             group=loader.path_group,
             help="The directory to find/install the Morello SDK",
         )
+        default_cheri_alliance_sdk = ComputedDefaultValue(
+            function=lambda p, cls: (p.tools_root / p.default_cheri_alliance_sdk_directory_name),
+            as_string="'<TOOLS_ROOT>/cheri-alliance-sdk'",
+        )
+        self.cheri_alliance_sdk_dir = loader.add_path_option(
+            "cheri-alliance-sdk-root",
+            default=default_cheri_alliance_sdk,
+            group=loader.path_group,
+            help="The directory to find/install the CHERI Alliance SDK",
+        )
         self.sysroot_output_root = loader.add_path_option(
             "sysroot-install-root",
             shortname="-sysroot-install-dir",

pycheribuild/config/jenkinsconfig.py

@@ -179,6 +179,12 @@ def __init__(self, loader: ConfigLoaderBase, available_targets: "list[str]") ->
             type=Path,
             help="Override the path to the CHERI SDK (default is $WORKSPACE/cherisdk)",
         )
+        self._cheri_alliance_sdk_dir_override = loader.add_commandline_only_option(
+            "cheri-alliance-sdk-path",
+            default=None,
+            type=Path,
+            help="Override the path to the CHERI Alliance SDK (default is $WORKSPACE/cheri-alliance-sdk)",
+        )
         self._morello_sdk_dir_override = loader.add_commandline_only_option(
             "morello-sdk-path",
             default=None,
@@ -293,6 +299,13 @@ def load(self) -> None:
         else:
             self.cheri_sdk_dir = self.workspace / self.default_cheri_sdk_directory_name
 
+        if self._cheri_alliance_sdk_dir_override is not None:
+            self.cheri_alliance_sdk_dir = self._cheri_alliance_sdk_dir_override
+        elif Path("/cheri-alliance-sdk/bin/clang").exists():  # check for docker image
+            self.cheri_alliance_sdk_dir = Path("/cheri-alliance-sdk")
+        else:
+            self.cheri_alliance_sdk_dir = self.workspace / self.default_cheri_alliance_sdk_directory_name
+
         if self._morello_sdk_dir_override is not None:
             self.morello_sdk_dir = self._morello_sdk_dir_override
         elif Path("/morello-sdk/bin/clang").exists():  # check for docker image

pycheribuild/config/target_info.py

@@ -110,6 +110,7 @@ class CompilerType(Enum):
     DEFAULT_COMPILER = "default-compiler"  # Default system compiler (i.e. the argument passed to cheribuild)
     CHERI_LLVM = "cheri-llvm"  # Compile with CHERI LLVM built by cheribuild
     MORELLO_LLVM = "morello-llvm"  # Compile with Morello LLVM built by cheribuild
+    CHERI_ALLIANCE_LLVM = "cheri-alliance-llvm"  # Compile with CHERI Alliance LLVM built by cheribuild
     UPSTREAM_LLVM = "upstream-llvm"  # Compile with upstream LLVM built by cheribuild
     SYSTEM_LLVM = "system-llvm"  # Compile with system installation of LLVM/Clang
     BOOTSTRAPPED = "bootstrap"  # Compiler is included with the project
@@ -149,6 +150,7 @@ class DefaultInstallDir(Enum):
     KDE_PREFIX = "The sysroot for this target (<rootfs>/opt/<arch>/kde by default)"
     CHERI_SDK = "The CHERI SDK directory"
     MORELLO_SDK = "The Morello SDK directory"
+    CHERI_ALLIANCE_SDK = "The CHERI Alliance SDK directory"
     BOOTSTRAP_TOOLS = "The bootstap tools directory"
     CUSTOM_INSTALL_DIR = "Custom install directory"
     SYSROOT_FOR_BAREMETAL_ROOTFS_OTHERWISE = "Sysroot for baremetal projects, rootfs otherwise"
@@ -599,6 +601,8 @@ def default_install_dir(self, install_dir: DefaultInstallDir) -> Path:
             return config.cheri_sdk_dir
         elif install_dir == DefaultInstallDir.MORELLO_SDK:
             return config.morello_sdk_dir
+        elif install_dir == DefaultInstallDir.CHERI_ALLIANCE_SDK:
+            return config.cheri_alliance_sdk_dir
         elif install_dir == DefaultInstallDir.BOOTSTRAP_TOOLS:
             return config.other_tools_dir
         return super().default_install_dir(install_dir)