Improve the generated meson cross files

luismarques · luismarques · commit b196cc6308a8 · 2022-02-10T10:36:38.000Z
The main benefits of the new cross files are:

- The toolchain path is isolated into a constant, so when the path needs to
  be updated only one line needs to change.
- It is easier to override certain configuration options.
diff --git a/azure-pipelines.yml b/azure-pipelines.yml
@@ -34,7 +34,7 @@ jobs:
         "lowrisc-toolchain-gcc-rv32imc" \
         "riscv32-unknown-elf" \
         "/tools/riscv" \
-        "-march=rv32imc" "-mabi=ilp32" "-mcmodel=medany"
+        "rv32imc" "ilp32" "medany"
     displayName: 'Build GCC toolchain'
     env:
       ARTIFACT_STAGING_DIR: $(Build.ArtifactStagingDirectory)
@@ -45,7 +45,7 @@ jobs:
         "lowrisc-toolchain-rv32imc" \
         "riscv32-unknown-elf" \
         "/tools/riscv" \
-        "-march=rv32imc" "-mabi=ilp32" "-mcmodel=medany"
+        "rv32imc" "ilp32" "medany"
     displayName: "Build Clang toolchain"
     env:
       ARTIFACT_STAGING_DIR: $(Build.ArtifactStagingDirectory)
@@ -77,8 +77,8 @@ jobs:
         "lowrisc-toolchain-gcc-rv32imcb" \
         "riscv32-unknown-elf" \
         "/tools/riscv" \
-        "-march=rv32imc_zba_zbb_zbc_zbs" \
-        "-mabi=ilp32" "-mcmodel=medany"
+        "rv32imc_zba_zbb_zbc_zbs" \
+        "ilp32" "medany"
     displayName: 'Build GCC toolchain'
     env:
       ARTIFACT_STAGING_DIR: $(Build.ArtifactStagingDirectory)
@@ -89,8 +89,8 @@ jobs:
         "lowrisc-toolchain-rv32imcb" \
         "riscv32-unknown-elf" \
         "/tools/riscv" \
-        "-march=rv32imc_zba0p93_zbb0p93_zbc0p93_zbs0p93" \
-        "-mabi=ilp32" "-mcmodel=medany" "-menable-experimental-extensions"
+        "rv32imc_zba0p93_zbb0p93_zbc0p93_zbs0p93" \
+        "ilp32" "medany" "-menable-experimental-extensions"
     displayName: "Build Clang toolchain"
     env:
       ARTIFACT_STAGING_DIR: $(Build.ArtifactStagingDirectory)
@@ -119,7 +119,7 @@ jobs:
         "lowrisc-toolchain-gcc-rv64imac" \
         "riscv64-unknown-elf" \
         "/tools/riscv" \
-        "-march=rv64imac" "-mabi=lp64" "-mcmodel=medany"
+        "rv64imac" "lp64" "medany"
     displayName: 'Build GCC toolchain'
     env:
       ARTIFACT_STAGING_DIR: $(Build.ArtifactStagingDirectory)
@@ -130,7 +130,7 @@ jobs:
         "lowrisc-toolchain-rv64imac" \
         "riscv64-unknown-elf" \
         "/tools/riscv" \
-        "-march=rv64imac" "-mabi=lp64" "-mcmodel=medany"
+        "rv64imac" "lp64" "medany"
     displayName: "Build Clang toolchain"
     env:
       ARTIFACT_STAGING_DIR: $(Build.ArtifactStagingDirectory)
diff --git a/build-clang-with-args.sh b/build-clang-with-args.sh
@@ -20,7 +20,7 @@ set -x
 set -o pipefail
 
 if ! [ "$#" -ge 3 ]; then
-  echo "Usage: $0 <config_name> <target> <dest_dir> <cflags...>"
+  echo "Usage: $0 <config_name> <target> <dest_dir> <march> <mabi> <mcmodel> <cflags...>"
   exit 2
 fi;
 
@@ -33,8 +33,14 @@ toolchain_name="${1}"
 toolchain_target="${2}"
 # This is the directory where we want the toolchain to added to
 toolchain_dest="${3}"
+# -march option default value
+march="${4}"
+# -mabi option default value
+mabi="${5}"
+# -mcmodel option default value
+mcmodel="${6}"
 # Remaining cflags for build configurations
-toolchain_cflags=("${@:4}")
+toolchain_cflags=("${@:7}")
 
 build_top_dir="${PWD}"
 
@@ -137,7 +143,8 @@ cd "${build_top_dir}"
 "${build_top_dir}/generate-clang-cmake-toolchain.sh" \
   "${toolchain_target}" "${toolchain_dest}" "${toolchain_cflags[@]}"
 "${build_top_dir}/generate-clang-meson-cross-file.sh" \
-  "${toolchain_target}" "${toolchain_dest}" "${toolchain_cflags[@]}"
+  "${toolchain_target}" "${toolchain_dest}" ${march} ${mabi} ${mcmodel} \
+  "${toolchain_cflags[@]}"
 
 # Copy LLVM licenses into toolchain
 mkdir -p "${toolchain_dest}/share/licenses/llvm"
@@ -171,7 +178,7 @@ Crosstool-ng version:
   (git: ${CROSSTOOL_NG_URL} ${CROSSTOOL_NG_VERSION})
 
 C Flags:
-  ${toolchain_cflags[@]}
+  -march=${march} -mabi=${mabi} -mcmodel=${mcmodel} ${toolchain_cflags[@]}
 
 Built at ${build_date} on $(hostname)
 BUILDINFO
diff --git a/build-gcc-with-args.sh b/build-gcc-with-args.sh
@@ -29,8 +29,14 @@ toolchain_name="${1}"
 toolchain_target="${2}"
 # This is the directory where we want the toolchain to be installed.
 toolchain_dest="${3}"
+# -march option default value
+march="${4}"
+# -mabi option default value
+mabi="${5}"
+# -mcmodel option default value
+mcmodel="${6}"
 # Remaining cflags for build configurations
-toolchain_cflags=("${@:4}")
+toolchain_cflags=("${@:7}")
 
 build_top_dir="${PWD}"
 
@@ -91,7 +97,8 @@ cd "${build_top_dir}"
 "${build_top_dir}/generate-gcc-cmake-toolchain.sh" \
   "${toolchain_target}" "${toolchain_dest}" "${toolchain_cflags[@]}"
 "${build_top_dir}/generate-gcc-meson-cross-file.sh" \
-  "${toolchain_target}" "${toolchain_dest}" "${toolchain_cflags[@]}"
+  "${toolchain_target}" "${toolchain_dest}" ${march} ${mabi} ${mcmodel} \
+  "${toolchain_cflags[@]}"
 
 ls -l "${toolchain_dest}"
 
@@ -116,7 +123,7 @@ Crosstool-ng version:
   (git: ${CROSSTOOL_NG_URL} ${CROSSTOOL_NG_VERSION})
 
 C Flags:
-  ${toolchain_cflags[@]}
+  -march=${march} -mabi=${mabi} -mcmodel=${mcmodel} ${toolchain_cflags[@]}
 
 Built at ${build_date} on $(hostname)
 BUILDINFO
diff --git a/generate-clang-meson-cross-file.sh b/generate-clang-meson-cross-file.sh
@@ -5,16 +5,18 @@
 
 ## generate-gcc-meson-cross-file.sh
 #
-# This generates a cross file to configure meson for cross-compiling with clang.
+# This generates a cross file to configure meson for cross-compiling with Clang.
 #
-# Docs: https://mesonbuild.com/Cross-compilation.html
+# Docs:
+# - https://mesonbuild.com/Cross-compilation.html
+# - https://mesonbuild.com/Machine-files.html
 
 set -e
 set -x
 set -o pipefail
 
 if ! [ "$#" -ge 2 ]; then
-  echo "Usage: $0 <target> <prefix_dir> <cflags...>"
+  echo "Usage: $0 <target> <prefix_dir> <march> <mabi> <mcmodel> <cflags...>"
   exit 2
 fi;
 
@@ -23,16 +25,23 @@ fi;
 toolchain_target="${1}"
 # This is the directory where the toolchain has been installed.
 toolchain_dest="${2}"
+# -march option default value
+march="${3}"
+# -mabi option default value
+mabi="${4}"
+# -mcmodel option default value
+mcmodel="${5}"
 # Remaining cflags for build configurations
-toolchain_cflags=("${@:3}")
+toolchain_cflags=("${@:6}")
 
 # Meson uses the driver when both compiling and linking, which may need flags to
 # identify exactly how to set up paths and defaults for both.
 #
-# In particular, the clang driver requires a `--gcc-toolchain=<path>` argument
-# to find the right libraries if there are system versions of the risc-v
-# toolchains installed.
-meson_driver_flags="'--gcc-toolchain=${toolchain_dest}'"
+# The clang driver requires a `--gcc-toolchain=<path>` argument to find the
+# right libraries if there are system versions of the risc-v toolchains
+# installed. That is added automatically to the meson cross file constant
+# `default_args`, so it doesn't need to be manually specified here.
+meson_driver_flags=""
 for flag in "${toolchain_cflags[@]}"; do
   if [ -z "${meson_driver_flags}" ]; then
     meson_driver_flags+="'${flag}'";
@@ -47,7 +56,7 @@ system_name=""
 
 case "${toolchain_target}" in
   riscv*-*-linux-gnu)
-    sysroot_config="sys_root = '${toolchain_dest}/${toolchain_target}/sysroot'";
+    sysroot_config="sys_root = toolchain_path / '${toolchain_target}/sysroot'";
     system_name="linux";
   ;;
   riscv*-*-elf)
@@ -57,32 +66,46 @@ esac;
 
 tee "${config_dest}" <<CONFIG
 # Autogenerated by ${0} on $(date -u)
-# Problems? Bug reporting instructions in ${toolchain_dest}/buildinfo
+# Problems? See the bug reporting instructions in the file buildinfo.
 #
-# If you have relocated this toolchain, change all occurences of '${toolchain_dest}'
-# to point to the new location of the toolchain.
+# If you have relocated this toolchain, update "toolchain_path" accordingly.
+
+[constants]
+toolchain_path = '${toolchain_dest}'
+toolchain_opt = '--gcc-toolchain=' + toolchain_path
+march = '${march}'
+mabi = '${mabi}'
+mcmodel = '${mcmodel}'
+default_extra_args = [${meson_driver_flags}]
+default_args = [toolchain_opt, '-march=' + march, '-mabi=' + mabi, '-mcmodel=' + mcmodel] + default_extra_args
+default_c_args = default_args
+default_c_link_args = default_args
+default_cpp_args = default_args
+default_cpp_link_args = default_args
 
 [binaries]
-c = '${toolchain_dest}/bin/${toolchain_target}-clang'
-cpp = '${toolchain_dest}/bin/${toolchain_target}-clang++'
-ar = '${toolchain_dest}/bin/${toolchain_target}-ar'
-ld = '${toolchain_dest}/bin/${toolchain_target}-ld'
-c_ld = '${toolchain_dest}/bin/${toolchain_target}-ld'
-cpp_ld = '${toolchain_dest}/bin/${toolchain_target}-ld'
-objdump = '${toolchain_dest}/bin/${toolchain_target}-objdump'
-objcopy = '${toolchain_dest}/bin/${toolchain_target}-objcopy'
-strip = '${toolchain_dest}/bin/${toolchain_target}-strip'
-as = '${toolchain_dest}/bin/${toolchain_target}-as'
+c = toolchain_path / 'bin/riscv32-unknown-elf-clang'
+cpp = toolchain_path / 'bin/riscv32-unknown-elf-clang++'
+ar = toolchain_path / 'bin/riscv32-unknown-elf-ar'
+ld = toolchain_path / 'bin/riscv32-unknown-elf-ld'
+c_ld = toolchain_path / 'bin/riscv32-unknown-elf-ld'
+cpp_ld = toolchain_path / 'bin/riscv32-unknown-elf-ld'
+objdump = toolchain_path / 'bin/riscv32-unknown-elf-objdump'
+objcopy = toolchain_path / 'bin/riscv32-unknown-elf-objcopy'
+strip = toolchain_path / 'bin/riscv32-unknown-elf-strip'
+as = toolchain_path / 'bin/riscv32-unknown-elf-as'
 
 [properties]
 needs_exe_wrapper = true
 has_function_printf = false
-c_args = [${meson_driver_flags}]
-c_link_args = [${meson_driver_flags}]
-cpp_args = [${meson_driver_flags}]
-cpp_link_args = [${meson_driver_flags}]
 ${sysroot_config}
 
+[built-in options]
+c_args = default_c_args
+c_link_args = default_c_link_args
+cpp_args = default_cpp_args
+cpp_link_args = default_cpp_link_args
+
 [host_machine]
 system = '${system_name}'
 cpu_family = '${toolchain_target%%-*}'
diff --git a/generate-gcc-meson-cross-file.sh b/generate-gcc-meson-cross-file.sh
@@ -7,14 +7,16 @@
 #
 # This generates a cross file to configure meson for cross-compiling with GCC.
 #
-# Docs: https://mesonbuild.com/Cross-compilation.html
+# Docs:
+# - https://mesonbuild.com/Cross-compilation.html
+# - https://mesonbuild.com/Machine-files.html
 
 set -e
 set -x
 set -o pipefail
 
 if ! [ "$#" -ge 2 ]; then
-  echo "Usage: $0 <target> <prefix_dir> <cflags...>"
+  echo "Usage: $0 <target> <prefix_dir> <march> <mabi> <mcmodel> <cflags...>"
   exit 2
 fi;
 
@@ -23,8 +25,14 @@ fi;
 toolchain_target="${1}"
 # This is the directory where the toolchain has been installed.
 toolchain_dest="${2}"
+# -march option default value
+march="${3}"
+# -mabi option default value
+mabi="${4}"
+# -mcmodel option default value
+mcmodel="${5}"
 # Remaining cflags for build configurations
-toolchain_cflags=("${@:3}")
+toolchain_cflags=("${@:6}")
 
 # Meson uses the driver when both compiling and linking, which may need flags to
 # identify exactly how to set up paths and defaults for both.
@@ -43,7 +51,7 @@ system_name=""
 
 case "${toolchain_target}" in
   riscv*-*-linux-gnu)
-    sysroot_config="sys_root = '${toolchain_dest}/${toolchain_target}/sysroot'";
+    sysroot_config="sys_root = toolchain_path / '${toolchain_target}/sysroot'";
     system_name="linux";
   ;;
   riscv*-*-elf)
@@ -53,30 +61,43 @@ esac;
 
 tee "${config_dest}" <<CONFIG
 # Autogenerated by ${0} on $(date -u)
-# Problems? Bug reporting instructions in ${toolchain_dest}/buildinfo
+# Problems? See the bug reporting instructions in the file buildinfo.
 #
-# If you have relocated this toolchain, change all occurences of '${toolchain_dest}'
-# to point to the new location of the toolchain.
+# If you have relocated this toolchain, update "toolchain_path" accordingly.
+
+[constants]
+toolchain_path = '${toolchain_dest}'
+march = '${march}'
+mabi = '${mabi}'
+mcmodel = '${mcmodel}'
+default_extra_args = [${meson_driver_flags}]
+default_args = ['-march=' + march, '-mabi=' + mabi, '-mcmodel=' + mcmodel] + default_extra_args
+default_c_args = default_args
+default_c_link_args = default_args
+default_cpp_args = default_args
+default_cpp_link_args = default_args
 
 [binaries]
-c = '${toolchain_dest}/bin/${toolchain_target}-gcc'
-cpp = '${toolchain_dest}/bin/${toolchain_target}-g++'
-ar = '${toolchain_dest}/bin/${toolchain_target}-ar'
-ld = '${toolchain_dest}/bin/${toolchain_target}-ld'
-objdump = '${toolchain_dest}/bin/${toolchain_target}-objdump'
-objcopy = '${toolchain_dest}/bin/${toolchain_target}-objcopy'
-strip = '${toolchain_dest}/bin/${toolchain_target}-strip'
-as = '${toolchain_dest}/bin/${toolchain_target}-as'
+c = toolchain_path / 'bin/riscv32-unknown-elf-gcc'
+cpp = toolchain_path / 'bin/riscv32-unknown-elf-g++'
+ar = toolchain_path / 'bin/riscv32-unknown-elf-ar'
+ld = toolchain_path / 'bin/riscv32-unknown-elf-ld'
+objdump = toolchain_path / 'bin/riscv32-unknown-elf-objdump'
+objcopy = toolchain_path / 'bin/riscv32-unknown-elf-objcopy'
+strip = toolchain_path / 'bin/riscv32-unknown-elf-strip'
+as = toolchain_path / 'bin/riscv32-unknown-elf-as'
 
 [properties]
 needs_exe_wrapper = true
 has_function_printf = false
-c_args = [${meson_driver_flags}]
-c_link_args = [${meson_driver_flags}]
-cpp_args = [${meson_driver_flags}]
-cpp_link_args = [${meson_driver_flags}]
 ${sysroot_config}
 
+[built-in options]
+c_args = default_c_args
+c_link_args = default_c_link_args
+cpp_args = default_cpp_args
+cpp_link_args = default_cpp_link_args
+
 [host_machine]
 system = '${system_name}'
 cpu_family = '${toolchain_target%%-*}'
