Drop CA_(target)_ENABLED CMake options.

hvdijk · hvdijk · commit d74316e739f6 · 2025-07-23T19:55:33.000+01:00
The CA_(target)_ENABLED options were provided because we simultaneously
wanted to enable all available Mux targets by default, and disable the
RISC-V Mux target by default. This is confusing when CA_RISCV_ENABLED and
CA_MUX_TARGETS_TO_ENABLE are mismatched: it causes the RISC-V Mux target
to be disabled when either variable disables it, even when the other
variable suggests that it should be enabled. Drop CA_(target)_ENABLED and
rely entirely on CA_MUX_TARGETS_TO_ENABLE instead.

For consistency, make the same change to CA_MUX_COMPILERS_TO_ENABLE.

For CA_MUX_TARGETS_TO_ENABLE, change the default to "host". For
CA_MUX_COMPILERS_TO_ENABLE, change the default to match
CA_MUX_TARGETS_TO_ENABLE. Update the documentation and continuous
integration to set them where we do not want host and were not already
setting them.
diff --git a/.github/actions/do_build_ock/action.yml b/.github/actions/do_build_ock/action.yml
@@ -11,8 +11,8 @@ inputs:
     description: 'mux targets to enable e.g. riscv, host (default host)'
     default: "host"
   mux_compilers_enable:
-    description: 'mux compiler target to enable e.g. riscv, host (no default)'
-    default: ""
+    description: 'mux compiler target to enable e.g. riscv, host (default host)'
+    default: "host"
   usm:
     description: 'Enable usm (default ON)'
     default: ON
@@ -55,9 +55,6 @@ inputs:
   hal_refsi_thread_mode:
     description: 'HAL Refsi Thread Mode e.g. WI or WG, default ""'
     default: ""
-  riscv_enabled:
-    description: "Enable riscv target (default OFF)"
-    default: OFF
   build_dir:
     description: "Directory to be used for building"
     default: build
@@ -148,13 +145,12 @@ runs:
               -DOCL_EXTENSION_cl_intel_unified_shared_memory=${{ inputs.usm }}
               -DOCL_EXTENSION_cl_khr_command_buffer=${{ inputs.command_buffer }}
               -DOCL_EXTENSION_cl_khr_command_buffer_mutable_dispatch=${{ inputs.command_buffer }}
-              -DCA_MUX_COMPILERS_TO_ENABLE=${{ inputs.mux_compilers_enable}}
+              -DCA_MUX_COMPILERS_TO_ENABLE=${{ inputs.mux_compilers_enable }}
               -DCA_EXTERNAL_MUX_COMPILER_DIRS=${{ inputs.external_compiler_dirs }}
               -DCA_CL_ENABLE_ICD_LOADER=ON
               -DHAL_DESCRIPTION=${{ inputs.hal_description }}
               -DHAL_REFSI_SOC=${{ inputs.hal_refsi_soc }}
               -DHAL_REFSI_THREAD_MODE=${{ inputs.hal_refsi_thread_mode }}
-              -DCA_RISCV_ENABLED=${{ inputs.riscv_enabled }}
               -DCA_CL_ENABLE_RVV_SCALABLE_VECZ_CHECK=${{ inputs.enable_rvv_scalable_vecz_check }}
               -DCA_CL_ENABLE_RVV_SCALABLE_VP_VECZ_CHECK=${{ inputs.enable_rvv_scalable_vp_vecz_check }}
               -DCA_CL_ENABLE_UNITCL_EXPENSIVE_CHECK=${{ inputs.enable_unitcl_expensive }}
diff --git a/.github/actions/do_build_ock/do_build_m1/action.yml b/.github/actions/do_build_ock/do_build_m1/action.yml
@@ -20,7 +20,6 @@ runs:
         mux_targets_enable: riscv
         mux_compilers_enable: refsi_m1
         external_compiler_dirs: "${{ github.workspace }}/examples/refsi/refsi_m1/compiler/refsi_m1"
-        riscv_enabled: ON
         enable_rvv_scalable_vecz_check: ON
         enable_rvv_scalable_vp_vecz_check: ON
         extra_flags: ${{ inputs.extra_flags }}
diff --git a/.github/actions/do_build_pr/run_ubuntu_gcc_x86_64_cpu/action.yml b/.github/actions/do_build_pr/run_ubuntu_gcc_x86_64_cpu/action.yml
@@ -25,6 +25,7 @@ runs:
           build_dir: $GITHUB_WORKSPACE/cpu_hal_ock/build
           install_dir: $GITHUB_WORKSPACE/cpu_hal_ock/install
           mux_targets_enable: cpu
+          mux_compilers_enable: cpu
           use_linker: gold
           debug_support: ON
           command_buffer: OFF
diff --git a/.github/actions/do_build_pr/run_ubuntu_gcc_x86_64_refsi_g1_wi_cl3_0/action.yml b/.github/actions/do_build_pr/run_ubuntu_gcc_x86_64_refsi_g1_wi_cl3_0/action.yml
@@ -20,7 +20,6 @@ runs:
           mux_targets_enable: riscv
           external_compiler_dirs: ${{ github.workspace }}/examples/refsi/refsi_g1_wi/compiler/refsi_g1_wi
           mux_compilers_enable: refsi_g1_wi
-          riscv_enabled: ON
           disable_unitcl_vecz_checks: ON
           enable_rvv_scalable_vecz_check: ON
           enable_rvv_scalable_vp_vecz_check: ON
diff --git a/.github/actions/do_build_pr/run_ubuntu_gcc_x86_64_refsi_tutorial/action.yml b/.github/actions/do_build_pr/run_ubuntu_gcc_x86_64_refsi_tutorial/action.yml
@@ -33,6 +33,7 @@ runs:
         with:
           build_targets: install
           mux_targets_enable: refsi_tutorial
+          mux_compilers_enable: refsi_tutorial
           debug_support: ON
           offline_kernel_tests: OFF
           source_dir: $GITHUB_WORKSPACE/refsi_tutorial
diff --git a/.github/actions/do_build_pr/run_ubuntu_gcc_x86_64_riscv_cl3_0/action.yml b/.github/actions/do_build_pr/run_ubuntu_gcc_x86_64_riscv_cl3_0/action.yml
@@ -26,7 +26,6 @@ runs:
           build_targets: ${{ inputs.cache_seed == 'true' && 'UnitCL clc' || inputs.build_targets }}
           mux_targets_enable: riscv
           mux_compilers_enable: refsi_m1
-          riscv_enabled: ON
           disable_unitcl_vecz_checks: ${{ inputs.disable_unitcl_vecz_checks }}
           enable_rvv_scalable_vecz_check: ON
           enable_rvv_scalable_vp_vecz_check: ON
diff --git a/.github/actions/do_build_pr/run_ubuntu_gcc_x86_64_riscv_fp16_cl3_0/action.yml b/.github/actions/do_build_pr/run_ubuntu_gcc_x86_64_riscv_fp16_cl3_0/action.yml
@@ -20,7 +20,6 @@ runs:
           build_targets: ${{ inputs.cache_seed == 'true' && 'UnitCL clc' || 'check-ock' }}
           mux_targets_enable: riscv
           mux_compilers_enable: riscv
-          riscv_enabled: ON
           disable_unitcl_vecz_checks: ON
           enable_rvv_scalable_vecz_check: ON
           enable_rvv_scalable_vp_vecz_check: ON
diff --git a/.github/actions/do_build_pr/run_ubuntu_gcc_x86_64_riscv_fp16_cl3_0_unitcl_vecz/action.yml b/.github/actions/do_build_pr/run_ubuntu_gcc_x86_64_riscv_fp16_cl3_0_unitcl_vecz/action.yml
@@ -20,7 +20,6 @@ runs:
           build_targets: ${{ inputs.cache_seed == 'true' && 'clc UnitCL' || 'check-ock-UnitCL-group-vecz' }}
           mux_targets_enable: riscv
           mux_compilers_enable: riscv
-          riscv_enabled: ON
           enable_rvv_scalable_vecz_check: ON
           enable_rvv_scalable_vp_vecz_check: ON
           hal_description: RV64GCV_Zfh
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -17,6 +17,10 @@ Upgrade guidance:
   as the API.
 * The mux spec has been bumped:
   * 0.81.0: the muxResetFence and muxResetSemaphore functions have been removed.
+* Mux now enables only the "host" compiler and target by default. Non-host
+  builds will need to specify the compiler and target explicitly. The
+  `CA_(target)_ENABLED` variables which served as extra gates for various
+  targets no longer have any effect.
 
 ## Version 4.0.0
 
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -110,11 +110,11 @@ endif()
 ca_option(CA_ENABLE_DOCUMENTATION BOOL
   "Enable documentation generation" ON)
 ca_option(CA_MUX_TARGETS_TO_ENABLE STRING
-  "Semi-colon separated list of ComputeMux targets to enable, empty enables all" "")
+  "Semi-colon separated list of ComputeMux targets to enable, empty enables all" "host")
 ca_option(CA_EXTERNAL_MUX_TARGET_DIRS STRING
   "Semi-colon separated list of external ComputeMux target source directories" "")
 ca_option(CA_MUX_COMPILERS_TO_ENABLE STRING
-  "Semi-colon separated list of ComputeMux compilers to enable, empty enables all" "")
+  "Semi-colon separated list of ComputeMux compilers to enable, empty enables all" "${CA_MUX_TARGETS_TO_ENABLE}")
 ca_option(CA_EXTERNAL_MUX_COMPILER_DIRS STRING
   "Semi-colon separated list of external ComputeMux compiler source directories" "")
 ca_immutable_option(CA_RUNTIME_COMPILER_ENABLED BOOL
diff --git a/README.md b/README.md
@@ -76,7 +76,6 @@ The available targets in the current implementation are based on Codeplay's refe
 ```sh
 cmake -GNinja \
    -Bbuild-riscv \
-   -DCA_RISCV_ENABLED=ON \
    -DCA_MUX_TARGETS_TO_ENABLE="riscv" \
    -DCA_LLVM_INSTALL_DIR=$LLVMInstall \
    -DCA_ENABLE_HOST_IMAGE_SUPPORT=OFF \
diff --git a/doc/modules/mux/bumping-the-spec.rst b/doc/modules/mux/bumping-the-spec.rst
@@ -11,8 +11,7 @@ Bumping the ComputeMux Specification Version
    a. Note that as long as the version number is in the 0.X.Y stage it is very
       unlikely that you will be updating the major number.
 3. Configure CMake, making sure that all ComputeMux targets are enabled. This
-   includes ``host`` which is enabled by default, and the RISC-V target which
-   is enabled with the ``CA_RISCV_ENABLED`` cmake option.
+   includes ``host`` which is enabled by default, and the ``riscv`` target.
 4. Build the ``mux-api-generate`` target e.g., ``ninja mux-api-generate``.
 5. Update ``doc/modules/mux/changes.rst``. The previous step will have
    generated an empty entry for the latest version.
diff --git a/doc/modules/riscv.rst b/doc/modules/riscv.rst
@@ -125,7 +125,6 @@ Currently recommended build options include:
 .. code-block:: console
 
  $ cmake -GNinja \
-   -DCA_RISCV_ENABLED=ON \
    -DCA_MUX_TARGETS_TO_ENABLE="riscv" \
    -DCA_LLVM_INSTALL_DIR=<llvm_install_dir>/llvm_install \
    -DCA_ENABLE_HOST_IMAGE_SUPPORT=OFF \
@@ -138,7 +137,6 @@ target has additional features. This is done by adding to the build options:
 .. code-block:: console
 
  $ cmake -GNinja \
-   -DCA_RISCV_ENABLED=ON \
    -DCA_MUX_TARGETS_TO_ENABLE="riscv" \
    -DCA_LLVM_INSTALL_DIR=<llvm_install_dir>/llvm_install \
    -DCA_ENABLE_HOST_IMAGE_SUPPORT=OFF \
diff --git a/doc/overview/tutorials/creating-a-new-mux-target/building-and-running-tests.rst b/doc/overview/tutorials/creating-a-new-mux-target/building-and-running-tests.rst
@@ -29,7 +29,6 @@ Firstly we set up the `CMake` directive.
     $ export LLVM_INSTALL_DIR=<your_llvm_install_dir>
     $ export ONEAPI_CON_KIT_PATH=<your_oneapi_construction_kit_dir>    
     $ cmake -GNinja -DCA_MUX_TARGETS_TO_ENABLE="refsi_tutorial" \
-        -DCA_REFSI_TUTORIAL_ENABLED=ON \
         -DCMAKE_BUILD_TYPE=Debug \
         -DCA_LLVM_INSTALL_DIR=$LLVM_INSTALL_DIR \
         -DCA_ENABLE_DEBUG_SUPPORT=ON \
diff --git a/examples/hal_cpu_remote_server/README.md b/examples/hal_cpu_remote_server/README.md
@@ -51,7 +51,6 @@ The client can built in-tree (for risc-v) as follows:
 ```
   cmake -Bbuild_client -GNinja \
     -DCA_MUX_TARGETS_TO_ENABLE="riscv" \
-    -DCA_RISCV_ENABLED=ON \
     -DCA_LLVM_INSTALL_DIR=<path_to_llvm_install> \
     -DCA_CL_ENABLE_ICD_LOADER=ON  \
     -DCA_HAL_NAME=cpu_client
@@ -71,7 +70,6 @@ for different architectures. For example:
 
   cmake -Bbuild_client -GNinja \
     -DCA_MUX_TARGETS_TO_ENABLE="cpu_client" \
-    -DCA_CPU_CLIENT_ENABLED=ON \
     -DCA_LLVM_INSTALL_DIR=<path_to_llvm_install> \
     -DCA_CL_ENABLE_ICD_LOADER=ON  \
     -DCA_EXTERNAL_ONEAPI_CON_KIT_DIR=<path_to_ock> 
diff --git a/examples/technical_blogs/refsi_simple_blog1/run_tech_blog_1.sh b/examples/technical_blogs/refsi_simple_blog1/run_tech_blog_1.sh
@@ -68,7 +68,6 @@ cmake -Bbuild \
       -DCA_EXTERNAL_ONEAPI_CON_KIT_DIR=$ONEAPI_CON_KIT_DIR \
       -DCA_EXTERNAL_REFSI_G1_HAL_DIR=$ONEAPI_CON_KIT_DIR/examples/refsi/hal_refsi \
       -DCA_MUX_TARGETS_TO_ENABLE="refsi_g1" \
-      -DCA_REFSI_G1_ENABLED=ON \
       -DCA_CL_ENABLE_OFFLINE_KERNEL_TESTS=OFF \
       -DCA_LLVM_INSTALL_DIR=$LLVM_INSTALL_DIR -GNinja .
 
diff --git a/modules/mux/cookie/{{cookiecutter.target_name}}/CMakeLists.txt b/modules/mux/cookie/{{cookiecutter.target_name}}/CMakeLists.txt
@@ -18,11 +18,6 @@
 # Reserved.
 {% endif -%}
 
-ca_option(CA_{{cookiecutter.target_name_capitals}}_ENABLED BOOL "Enable {{cookiecutter.target_name}} mux target" OFF)
-if(NOT ${CA_{{cookiecutter.target_name_capitals}}_ENABLED})
-  return()
-endif()
-
 if (DEFINED CA_EXTERNAL_{{cookiecutter.target_name_capitals}}_HAL_DIR)
   # Get the name of only the final part of the directory
   get_filename_component(EXTERNAL_HAL_NAME ${CA_EXTERNAL_{{cookiecutter.target_name_capitals}}_HAL_DIR} NAME)
diff --git a/modules/mux/targets/host/CMakeLists.txt b/modules/mux/targets/host/CMakeLists.txt
@@ -14,16 +14,6 @@
 #
 # SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 
-#[=======================================================================[.rst:
-.. cmake:variable:: CA_HOST_ENABLED
-
-  Option for enabling host Mux target, defaults to on.
-#]=======================================================================]
-ca_option(CA_HOST_ENABLED BOOL "Enable host mux target" ON)
-if(NOT CA_HOST_ENABLED)
-  return()
-endif()
-
 #[=======================================================================[.rst:
 .. cmake:variable:: CA_HOST_ENABLE_BUILTIN_KERNEL
 
diff --git a/modules/mux/targets/riscv/CMakeLists.txt b/modules/mux/targets/riscv/CMakeLists.txt
@@ -14,11 +14,6 @@
 #
 # SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 
-ca_option(CA_RISCV_ENABLED BOOL "Enable RISC-V mux target" OFF)
-if(NOT ${CA_RISCV_ENABLED})
-  return()
-endif()
-
 ca_option(CA_HAL_NAME STRING "Name of the HAL library to link with" refsi)
 
 # Ensure that HAL targets are processed before the riscv target.
