COMP: Linux ARM module build quality-of-life updates

Several quality-of-life fixes and updates for ARM support:
- Consolidates ARM module script with x86_64 module script for easier
  maintenance and comparison between procedures. Internal ARM script is
  preserved as a wrapper around generic internal build script.
- Splits `MANYLINUX_VERSION` variable into `MANYLINUX_VERSION` prefix
  and `TARGET_ARCH` postfix to better reflect available images.
- Uses `sudo` to avoid permissions failure when running docker or
  cleaning up files on ARM systems
- Improves cleanup step to avoid mixing x64 and ARM sources

co-authored-by: Matt McCormick <[email protected]>

Author: tbirdso

requirements-dev.txt

@@ -1 +1,2 @@
+ninja==1.11.1
 scikit-build==0.16.2

scripts/dockcross-manylinux-build-module-wheels.sh

@@ -28,32 +28,36 @@
 #   See https://github.com/dockcross/dockcross for available versions and tags.
 #   For instance, `export MANYLINUX_VERSION=2014`
 #
+# `TARGET_ARCH`: Target architecture for which wheels should be built.
+#   For instance, `export MANYLINUX_VERSION=aarch64`
+#
 # `IMAGE_TAG`: Specialized manylinux image tag to use for building.
-#   For instance, `export IMAGE_TAG=20221205-459c9f0`
+#   For instance, `export IMAGE_TAG=20221205-459c9f0`.
+#   Tagged images are available at:
+#   - https://github.com/dockcross/dockcross (x64 architecture)
+#   - https://quay.io/organization/pypa (ARM architecture)
 #
 # `ITK_MODULE_PREQ`: Prerequisite ITK modules that must be built before the requested module.
 #   See notes in `dockcross-manylinux-build-module-deps.sh`.
 #
 # `ITK_MODULE_NO_CLEANUP`: Option to skip cleanup steps.
 #
+# - `NO_SUDO`: Disable the use of superuser permissions for running docker.
+#
 ########################################################################
 
 # Handle case where the script directory is not the working directory
 script_dir=$(cd $(dirname $0) || exit 1; pwd)
 source "${script_dir}/dockcross-manylinux-set-vars.sh"
 
-echo "ITK_MODULE_PREQ ${ITK_MODULE_PREQ}"
 if [[ -n ${ITK_MODULE_PREQ} ]]; then
+  echo "Building module dependencies ${ITK_MODULE_PREQ}"
   source "${script_dir}/dockcross-manylinux-build-module-deps.sh"
 fi
 
-# Generate dockcross scripts
-docker run --rm dockcross/manylinux${MANYLINUX_VERSION}-x64:${IMAGE_TAG} > /tmp/dockcross-manylinux-x64
-chmod u+x /tmp/dockcross-manylinux-x64
-
+# Set up paths and variables for build
 mkdir -p $(pwd)/tools
 chmod 777 $(pwd)/tools
-# Build wheels
 mkdir -p dist
 DOCKER_ARGS="-v $(pwd)/dist:/work/dist/ -v ${script_dir}/..:/ITKPythonPackage -v $(pwd)/tools:/tools"
 DOCKER_ARGS+=" -e MANYLINUX_VERSION"
@@ -64,9 +68,28 @@ if [[ -n ${LD_LIBRARY_PATH} ]]; then
   done
 fi
 
-/tmp/dockcross-manylinux-x64 \
-  -a "$DOCKER_ARGS" \
-  "/ITKPythonPackage/scripts/internal/manylinux-build-module-wheels.sh" "$@"
+if [[ "${TARGET_ARCH}" = "aarch64" ]]; then
+  echo "Install aarch64 architecture emulation tools to perform build for ARM platform"
+
+  if [[ ! ${NO_SUDO} ]]; then
+    docker_prefix="sudo"
+  fi
+
+  ${docker_prefix} docker run --privileged --rm tonistiigi/binfmt --install all
+
+  # Build wheels
+  DOCKER_ARGS+=" -v $(pwd):/work/ --rm"
+  ${docker_prefix} docker run $DOCKER_ARGS ${CONTAINER_SOURCE} "/ITKPythonPackage/scripts/internal/manylinux-aarch64-build-module-wheels.sh" "$@"
+else
+  # Generate dockcross scripts
+  docker run --rm ${CONTAINER_SOURCE} > /tmp/dockcross-manylinux-x64
+  chmod u+x /tmp/dockcross-manylinux-x64
+
+  # Build wheels
+  /tmp/dockcross-manylinux-x64 \
+    -a "$DOCKER_ARGS" \
+    "/ITKPythonPackage/scripts/internal/manylinux-build-module-wheels.sh" "$@"
+fi
 
 if [[ -z ${ITK_MODULE_NO_CLEANUP} ]]; then
   source "${script_dir}/dockcross-manylinux-cleanup.sh"

scripts/dockcross-manylinux-cleanup.sh

@@ -15,15 +15,32 @@
 #   Format is `<org_name>/<module_name>@<module_tag>:<org_name>/<module_name>@<module_tag>:...`.
 #   For instance, `export ITK_MODULE_PREQ=InsightSoftwareConsortium/[email protected]`
 #
+# - `NO_SUDO`: Disable the use of superuser permissions for removing directories.
+#    `sudo` is required by default for cleanup on Github Actions runners.
+#
 ########################################################################
 
-echo "Cleaning up module dependencies"
+echo "Cleaning up artifacts from module build"
+
+# ARM platform observed to require sudo for removing ITKPythonPackage sources
+rm_prefix=""
+if [[ ! ${NO_SUDO} ]]; then
+  rm_prefix="sudo "
+fi
+
 unlink oneTBB-prefix
-rm -rf ITKPythonPackage/
+${rm_prefix} rm -rf ITKPythonPackage/
+${rm_prefix} rm -rf tools/
+${rm_prefix} rm -rf _skbuild/
+${rm_prefix} rm -rf ./*.egg-info/
+${rm_prefix} rm -rf ./ITK-*-manylinux${MANYLINUX_VERSION}_${TARGET_ARCH}/
+${rm_prefix} rm -rf ./ITKPythonBuilds-linux-manylinux*${MANYLINUX_VERSION}*.tar.zst
 
 if [[ -n ${ITK_MODULE_PREQ} ]]; then
   for MODULE_INFO in ${ITK_MODULE_PREQ//:/ }; do
     MODULE_NAME=`(echo ${MODULE_INFO} | cut -d'@' -f 1 | cut -d'/' -f 2)`
-    sudo rm -rf ${MODULE_NAME}/
+    ${rm_prefix} rm -rf ${MODULE_NAME}/
   done
 fi
+
+# Leave dist/ and download scripts intact

scripts/dockcross-manylinux-download-cache-and-build-module-wheels.sh

@@ -73,8 +73,4 @@ chmod u+x dockcross-manylinux-download-cache.sh
 
 echo "Building module wheels"
 set -- "${FORWARD_ARGS[@]}"; # Restore initial argument list
-if [[ "${MANYLINUX_VERSION}" = "_2_28_aarch64" ]]; then
-  ./ITKPythonPackage/scripts/manylinux_2_28_aarch64-build-module-wheels.sh "$@"
-else
-  ./ITKPythonPackage/scripts/dockcross-manylinux-build-module-wheels.sh "$@"
-fi
+./ITKPythonPackage/scripts/dockcross-manylinux-build-module-wheels.sh "$@"

scripts/dockcross-manylinux-download-cache.sh

@@ -74,7 +74,17 @@ ${unzstd_exe} --version
 # -----------------------------------------------------------------------
 # Fetch build archive
 
-TARBALL_SPECIALIZATION="-manylinux${MANYLINUX_VERSION:=_2_28}"
+MANYLINUX_VERSION=${MANYLINUX_VERSION:=_2_28}
+TARGET_ARCH=${TARGET_ARCH:=x64}
+
+case ${TARGET_ARCH} in
+    x64)
+        TARBALL_SPECIALIZATION="-manylinux${MANYLINUX_VERSION}"
+        ;;
+    *)
+        TARBALL_SPECIALIZATION="-manylinux${MANYLINUX_VERSION}_${TARGET_ARCH}"
+        ;;
+esac
 TARBALL_NAME="ITKPythonBuilds-linux${TARBALL_SPECIALIZATION}.tar"
 
 if [[ ! -f ${TARBALL_NAME}.zst ]]; then

scripts/dockcross-manylinux-set-vars.sh

@@ -34,12 +34,29 @@ ITKPYTHONPACKAGE_TAG=${ITKPYTHONPACKAGE_TAG:=master}
 #   See https://github.com/dockcross/dockcross for available versions and tags.
 MANYLINUX_VERSION=${MANYLINUX_VERSION:=_2_28}
 
+# Target platform architecture (x64, aarch64)
+TARGET_ARCH=${TARGET_ARCH:=x64}
+
 # Specialized manylinux image tag to use for building.
-if [[ ${MANYLINUX_VERSION} == _2_28 ]]; then
+if [[ ${MANYLINUX_VERSION} == _2_28 && ${TARGET_ARCH} == x64 ]]; then
   IMAGE_TAG=${IMAGE_TAG:=20221205-459c9f0}
+elif [[ ${MANYLINUX_VERSION} == _2_28 && ${TARGET_ARCH} == aarch64 ]]; then
+  IMAGE_TAG=${IMAGE_TAG:=2022-11-28-5d13db4}
 elif [[ ${MANYLINUX_VERSION} == 2014 ]]; then
   IMAGE_TAG=${IMAGE_TAG:=20221201-fd49c08}
 else
   echo "Unknown manylinux version ${MANYLINUX_VERSION}"
   exit 1;
 fi
+
+# Set container for requested version/arch/tag.
+if [[ ${TARGET_ARCH} == x64 ]]; then
+  MANYLINUX_IMAGE_NAME=${MANYLINUX_IMAGE_NAME:="manylinux${MANYLINUX_VERSION}-${TARGET_ARCH}:${IMAGE_TAG}"}
+  CONTAINER_SOURCE="dockcross/${MANYLINUX_IMAGE_NAME}"
+elif [[ ${TARGET_ARCH} == aarch64 ]]; then
+  MANYLINUX_IMAGE_NAME=${MANYLINUX_IMAGE_NAME:="manylinux${MANYLINUX_VERSION}_${TARGET_ARCH}:${IMAGE_TAG}"}
+  CONTAINER_SOURCE="quay.io/pypa/${MANYLINUX_IMAGE_NAME}"
+else
+  echo "Unknown target architecture ${TARGET_ARCH}"
+  exit 1;
+fi