Makefile: add check of binaries architecture

As shown recently by the firejail example, it is easy to miss that a
package builds and installs binaries without actually cross-compiling
them: they are built for the host architecture instead of the target
architecture.

This commit adds a small helper script, check-bin-arch, called as a
GLOBAL_INSTRUMENTATION_HOOKS at the end of the target installation of
each package, to verify that the files installed by this package have
been built for the correct architecture.

Being called as a GLOBAL_INSTRUMENTATION_HOOKS allows the build to error
out right after the installation of the faulty package, and therefore
get autobuilder error detection properly assigned to this specific
package.

Example output with the firejail package enabled, when building for an
ARM target:

ERROR: architecture for ./usr/lib/firejail/libconnect.so is Advanced Micro Devices X86-64, should be ARM
ERROR: architecture for ./usr/bin/firejail is Advanced Micro Devices X86-64, should be ARM
ERROR: architecture for ./usr/lib/firejail/libtrace.so is Advanced Micro Devices X86-64, should be ARM
ERROR: architecture for ./usr/lib/firejail/libtracelog.so is Advanced Micro Devices X86-64, should be ARM
ERROR: architecture for ./usr/lib/firejail/ftee is Advanced Micro Devices X86-64, should be ARM
ERROR: architecture for ./usr/lib/firejail/faudit is Advanced Micro Devices X86-64, should be ARM
ERROR: architecture for ./usr/bin/firemon is Advanced Micro Devices X86-64, should be ARM
ERROR: architecture for ./usr/bin/firecfg is Advanced Micro Devices X86-64, should be ARM

Many thanks to Yann E. Morin and Arnout Vandecappelle for their reviews
and suggestions.

Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>

diff --git a/package/pkg-generic.mk b/package/pkg-generic.mk
index e8a8021e3c37b23ebce36add5aa12b85604b1faf..dd8a1e2ece4ce0672057ca0d6437a293ec03ad44 100644 (file)
--- a/package/pkg-generic.mk
+++ b/package/pkg-generic.mk
@@ -87,6 +87,17 @@ define step_pkg_size
 endef
 GLOBAL_INSTRUMENTATION_HOOKS += step_pkg_size
 
+# Relies on step_pkg_size, so must be after
+define check_bin_arch
+       $(if $(filter end-install-target,$(1)-$(2)),\
+               support/scripts/check-bin-arch -p $(3) \
+                       -l $(BUILD_DIR)/packages-file-list.txt \
+                       -r $(TARGET_READELF) \
+                       -a $(BR2_READELF_ARCH_NAME))
+endef
+
+GLOBAL_INSTRUMENTATION_HOOKS += check_bin_arch
+
 # This hook checks that host packages that need libraries that we build
 # have a proper DT_RPATH or DT_RUNPATH tag
 define check_host_rpath

diff --git a/support/scripts/check-bin-arch b/support/scripts/check-bin-arch
new file mode 100755 (executable)
index 0000000..2c619ad
--- /dev/null
+++ b/support/scripts/check-bin-arch
@@ -0,0 +1,52 @@
+#!/bin/bash
+
+while getopts p:l:r:a: OPT ; do
+       case "${OPT}" in
+       p) package="${OPTARG}";;
+       l) pkg_list="${OPTARG}";;
+       r) readelf="${OPTARG}";;
+       a) arch_name="${OPTARG}";;
+       :) error "option '%s' expects a mandatory argument\n" "${OPTARG}";;
+       \?) error "unknown option '%s'\n" "${OPTARG}";;
+       esac
+done
+
+if test -z "${package}" -o -z "${pkg_list}" -o -z "${readelf}" -o -z "${arch_name}" ; then
+       echo "Usage: $0 -p <pkg> -l <pkg-file-list> -r <readelf> -a <arch name>"
+       exit 1
+fi
+
+exitcode=0
+
+pkg_files=$(sed -r -e "/^${package},(.+)$/!d; s//\1/;" ${pkg_list})
+
+for f in ${pkg_files} ; do
+       # Skip firmware files, they could be ELF files for other
+       # architectures
+       if [[ "${f}" =~ ^\./(usr/)?lib/firmware/.* ]]; then
+               continue
+       fi
+
+       # Get architecture using readelf. We pipe through 'head -1' so
+       # that when the file is a static library (.a), we only take
+       # into account the architecture of the first object file.
+       arch=$(LC_ALL=C ${readelf} -h "${TARGET_DIR}/${f}" 2>&1 | \
+                      sed -r -e '/^  Machine: +(.+)/!d; s//\1/;' | head -1)
+
+       # If no architecture found, assume it was not an ELF file
+       if test "${arch}" = "" ; then
+               continue
+       fi
+
+       # Architecture is correct
+       if test "${arch}" = "${arch_name}" ; then
+               continue
+       fi
+
+       printf 'ERROR: architecture for %s is %s, should be %s\n' \
+              "${f}" "${arch}" "${arch_name}"
+
+       exitcode=1
+done
+
+exit ${exitcode}