From patchwork Sun Aug 6 16:43:52 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Mikko Rapeli X-Patchwork-Id: 798419 X-Patchwork-Delegate: davem@davemloft.net Return-Path: X-Original-To: patchwork-incoming@ozlabs.org Delivered-To: patchwork-incoming@ozlabs.org Authentication-Results: ozlabs.org; spf=none (mailfrom) smtp.mailfrom=vger.kernel.org (client-ip=209.132.180.67; helo=vger.kernel.org; envelope-from=netdev-owner@vger.kernel.org; receiver=) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by ozlabs.org (Postfix) with ESMTP id 3xQRxy49H3z9rxm for ; Mon, 7 Aug 2017 03:10:46 +1000 (AEST) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751748AbdHFRGi (ORCPT ); Sun, 6 Aug 2017 13:06:38 -0400 Received: from mail.kapsi.fi ([91.232.154.25]:51212 "EHLO mail.kapsi.fi" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751343AbdHFRGb (ORCPT ); Sun, 6 Aug 2017 13:06:31 -0400 Received: from p2003006ccd28d4000219d2fffe03c7a9.dip0.t-ipconnect.de ([2003:6c:cd28:d400:219:d2ff:fe03:c7a9] helo=totoro.fritz.box) by mail.kapsi.fi with esmtpsa (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.84_2) (envelope-from ) id 1deOhG-0003Hi-9G; Sun, 06 Aug 2017 19:46:34 +0300 From: Mikko Rapeli To: linux-kernel@vger.kernel.org, linux-api@vger.kernel.org Cc: Mikko Rapeli , Alexander Stein , Gabriel Laskar , "Dmitry V . Levin" , Arnd Bergmann , netdev@vger.kernel.org, Greg Kroah-Hartman , "David S. Miller" , Mauro Carvalho Chehab , Randy Dunlap Subject: [PATCH v06 01/36] Add scripts/headers_compile_test.sh: compile test for exported uapi headers Date: Sun, 6 Aug 2017 18:43:52 +0200 Message-Id: <20170806164428.2273-2-mikko.rapeli@iki.fi> X-Mailer: git-send-email 2.13.3 In-Reply-To: <20170806164428.2273-1-mikko.rapeli@iki.fi> References: <20170806164428.2273-1-mikko.rapeli@iki.fi> MIME-Version: 1.0 X-SA-Exim-Connect-IP: 2003:6c:cd28:d400:219:d2ff:fe03:c7a9 X-SA-Exim-Mail-From: mikko.rapeli@iki.fi X-SA-Exim-Scanned: No (on mail.kapsi.fi); SAEximRunCond expanded to false Sender: netdev-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: netdev@vger.kernel.org Users of kernel uapi header files would be happier if they did not contain kernel specific parts and would contain #include statements for all other header files that they depend on, and in general would compile also in user space. If Linux kernal uapi headers compile in user space, then they can also be used to do ABI and API compatibility checks against different kernel versions. ABI checks can also be used by Linux distribution build systems like yocto/bitbake to avoid recompiling dependencies if changes are ABI compatible. For each header file exported to userspace, this script tries to compile it together with minimal header files from GCC and libc, and reports results. In the test execution environment, libc and GCC header file locations are parsed from gcc compiler configuration. Some gcc and kernel headers depend on libc headers which are made available by copying from the compiler default location to a temporary location and removing possibly existing kernel headers from this directory. This is a bit of a hack but seems to work in multiple environments so test can be executed without installing headers to /usr/include and compiling a full Linux distribution on top. Tested natively on: Debian unstable, i586-linux-gnu and gcc 4.9.2 Raspbian Wheezy, arm-linux-gnueabihf and gcc 4.6.3 Ubuntu 12.04 LTS, x86_64-linux-gnu and gcc 4.6.3 Tested cross compilation using standard CROSS_COMPILE=/path/to/gcc with: arm-linux-gnueabihf-gcc (crosstool-NG linaro-1.13.1-4.9-2014.09 - Linaro GCC 4.9-2014.09) 4.9.2 20140904 (prerelease) Execute the script in the directory where kernel header files are installed. For example with kernel tree from v4.13-rc3-216-g0a23ea65ce9f on x86 i586: $ make headers_install $ cd usr/include $ ../../scripts/headers_compile_test.sh ... Kernel header compile test statistics: 42 files failed the kernel header compile test. 821 files passed the kernel header compile test. Once all these errors have been fixed, this test could be added to 'make headers_check'. In addition to plain compile test, there is also a glibc header compatibility test, which compiles all kernel uapi headers against a non-conflicting set of all GNU libc headers. The test covers variants where kernel header is included before libc header and libc header before kernel header. Tested in Debian unstable with libc6 version 2.24-14. Example execution with output: $ make headers_install $ cd usr/include $ ../../scripts/headers_compile_test.sh -lk Testing that /home/mcfrisk/src/linux-2.6/usr/headers_compile_test_include.qd5RuE/libc_headers.h compiles cc -Wall -c -nostdinc -I /usr/lib/gcc/i686-linux-gnu/6/include -I /usr/lib/gcc/i686-linux-gnu/6/include-fixed -I . -I /home/mcfrisk/src/linux-2.6/usr/headers_compile_test_include.qd5RuE -I /home/mcfrisk/src/linux-2.6/usr/headers_compile_test_include.qd5RuE/i686-linux-gnu -o /dev/null /home/mcfrisk/src/linux-2.6/usr/include/drm/i810_drm.h PASSED: drm/i810_drm.h cc -Wall -c -nostdinc -I /usr/lib/gcc/i686-linux-gnu/6/include -I /usr/lib/gcc/i686-linux-gnu/6/include-fixed -I . -I /home/mcfrisk/src/linux-2.6/usr/headers_compile_test_include.qd5RuE -I /home/mcfrisk/src/linux-2.6/usr/headers_compile_test_include.qd5RuE/i686-linux-gnu -o /dev/null /home/mcfrisk/src/linux-2.6/usr/include/drm/i810_drm.h_libc_before_kernel.h ... In file included from /home/mcfrisk/src/linux-2.6/usr/include/asm/sigcontext.h_l ibc_before_kernel.h:2:0: ./asm/sigcontext.h:291:8: error: redefinition of ‘struct sigcontext’ struct sigcontext { ^~~~~~~~~~ In file included from /home/mcfrisk/src/linux-2.6/usr/headers_compile_test_inclu de.qd5RuE/signal.h:306:0, from /home/mcfrisk/src/linux-2.6/usr/headers_compile_test_inclu de.qd5RuE/sys/param.h:28, from /home/mcfrisk/src/linux-2.6/usr/headers_compile_test_inclu de.qd5RuE/resolv.h:62, from /home/mcfrisk/src/linux-2.6/usr/headers_compile_test_inclu de.qd5RuE/libc_headers.h:103, from /home/mcfrisk/src/linux-2.6/usr/include/asm/sigcontext.h_l ibc_before_kernel.h:1: /home/mcfrisk/src/linux-2.6/usr/headers_compile_test_include.qd5RuE/bits/sigcont ext.h:93:8: note: originally defined here struct sigcontext ^~~~~~~~~~ FAILED libc before kernel test: asm/sigcontext.h ... Kernel header compile test statistics: 42 files failed the kernel header compile test. 821 files passed the kernel header compile test. libc and kernel header compatibility test statistics: 73 files failed libc before kernel include test. 790 files passed libc before kernel include test. Since I've been stubborn enough to work with this script and fixes to the test failures for a few years, I added my self to MAINTAINERS. Signed-off-by: Mikko Rapeli Cc: Alexander Stein Cc: Gabriel Laskar Cc: Dmitry V. Levin Cc: Arnd Bergmann Cc: netdev@vger.kernel.org Cc: linux-api@vger.kernel.org --- MAINTAINERS | 5 + scripts/headers_compile_test.sh | 507 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 512 insertions(+) create mode 100755 scripts/headers_compile_test.sh diff --git a/MAINTAINERS b/MAINTAINERS index 567343b8ffaa..f1d6d50932cf 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -3527,6 +3527,11 @@ S: Maintained F: mm/memcontrol.c F: mm/swap_cgroup.c +COMPILE TEST FOR HEADER FILES EXPORTED TO USERSPACE +M: Mikko Rapeli +S: Maintained +F: scripts/headers_compile_test.sh + CORETEMP HARDWARE MONITORING DRIVER M: Fenghua Yu L: linux-hwmon@vger.kernel.org diff --git a/scripts/headers_compile_test.sh b/scripts/headers_compile_test.sh new file mode 100755 index 000000000000..99de50d32b7b --- /dev/null +++ b/scripts/headers_compile_test.sh @@ -0,0 +1,507 @@ +#!/bin/bash + +help() { + cat << EOF_HELP +Userspace compile test for exported kernel headers. + + Copyright (C) 2015 Mikko Rapeli + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; version 2 + of the License. + +Execute in root directory of exported kernel headers in Linux kernel source +tree. Sets up gcc and libc headers without existing kernel headers to +a temporary environment and tries to compile all exported header files +from current directory against them. Return value is zero if all tests pass, +non-zero if something goes wrong during execution or if any file failed +the compile tests. + +Supported arguments: + + -h|--help print help + -k|--keep don't cleanup temporary header files and directories + -lk|--libc-kernel test for conflicts between kernel and libc headers + when libc headers are included before kernel headers + -kl|--kernel-libc test for conflicts between kernel and libc headers + when kernel headers are included before libc headers + -l|--libc test both -lk and -kl + -v|--verbose print more verbose output + +Example in Linux kernel source tree: + + \$ make headers_install + \$ cd usr/include + \$ $( readlink -f "$0" ) + +EOF_HELP +} + +# bash due to arithmetics and pipefail +set -euo pipefail + +KEEP=0 +HELP=0 +LIBC_TEST=0 +LIBC_KERNEL_TEST=0 +KERNEL_LIBC_TEST=0 + +# command line arguments +for p in "$@"; do + case "$p" in + -k|--keep) + KEEP=1 + ;; + -l|--libc) + LIBC_TEST=1 + LIBC_KERNEL_TEST=1 + KERNEL_LIBC_TEST=1 + ;; + -lk|--libc-kernel) + LIBC_TEST=1 + LIBC_KERNEL_TEST=1 + ;; + -kl|--kernel-libc) + LIBC_TEST=1 + KERNEL_LIBC_TEST=1 + ;; + -h|--help) + HELP=1 + ;; + -v|--verbose) + set -x + ;; + *) + help + echo "Unknown argument: $p" + exit 1 + ;; + esac +done + +if [ "$HELP" != "0" ]; then help; exit 0; fi + +# sanity test +if [ ! -d ./linux ]; then + echo Sanity check error: ./linux directory not found + echo Should be called in usr/include after \'make headers_install\'. + echo Returns number of failed files, 0 if none. + exit 1 +fi + +# Support CC variable for compiler and ccache, and cross compiling. +# CC is used without quotes to support CC="ccache gcc". +set +u +if [ "$CC"foobar == "foobar" ]; then + CC=cc +fi + +if [ "$CROSS_COMPILE"foobar != "foobar" ]; then + # Using gcc name since some cross compiler tool chains don't provide + # the cc symlink. Using eval to expand ~ to $HOME. + CC="$( eval echo "$CROSS_COMPILE"gcc )" +fi +set -u + +# Kernel headers refer to some gcc and libc headers so make them available. +set +u +if [ "$ARCH_TRIPLET"foobar == "foobar" ]; then + # Taking triplet from gcc/cpp + ARCH_TRIPLET="$( $CC -v -x c -E - < /dev/null 2>&1 | \ + grep Target | sed -e 's/Target: //' )" +fi + +if [ "$LIBC"foobar == "foobar" ]; then + # trying to grep libc includes from gcc/cpp defaults + _TEMP="$( $CC -v -x c -E - < /dev/null 2>&1 | \ + sed -n -e '/^#include <...> search starts here:$/,/^End of search list.$/{//!p}' | \ + sed -e 's/^\ \//\//g' | \ + grep '/usr/include' )" + + # sanity check and prepare LIBC dirs + for d in $_TEMP; do + if [ ! -d "$d" ]; then + echo "$d not a directory" + exit 1 + fi + LIBC="$LIBC $d" + done +fi +set -u + +# Copy libc include files to temp directory for the tests. +COMPILE_TEST_INC="$( readlink -f \ + "$( mktemp -d ../headers_compile_test_include.XXXXXX )" )" + +# cleanup if keep not set +if [ "$KEEP" = "0" ]; then + trap 'rm -rf "$COMPILE_TEST_INC"' EXIT +else + trap 'printf \ +"Temporary directory not cleaned up! Remove manually:\n${COMPILE_TEST_INC}\n"' \ + EXIT +fi + +for d in $LIBC; do + # check if last part of dir is the arch triplet, cross compile paths + # can have it also elsewhere so just the last one counts. + if ! ( echo "$d" | egrep "$ARCH_TRIPLET$" > /dev/null ); then + # hopefully just main libc dir, e.g. /usr/include, + # follow symlinks from e.g. /usr/include/bits + cp -aL "$d"/* "$COMPILE_TEST_INC"/ + elif ( echo "$d" | egrep "$ARCH_TRIPLET$" > /dev/null ); then + # hopefully the arch specific dir, e.g. /usr/include/x86_64-linux-gnu + cp -ar "$d"/* "$COMPILE_TEST_INC/" + else + echo "$d unexpected, bailing out" + exit 1 + fi +done + +# A single header with all non-conflicting libc headers to test kernel +# headers against libc headers for conflicts. +if [ "$LIBC_TEST" != 0 ]; then + # List taken from Debian unstable libc6 version 2.21-9. + # Some glibc headers conflict with each other so they + # are filtered out. Not perfect but better than nothing. + # + # $ for f in $( egrep "\.h$" /var/lib/dpkg/info/libc6-dev\:i386.list | sed -e 's|/usr/include/||'| sort | grep -v arpa | grep -v linux-gnu | grep -v rpcsvc | grep -v regexp.h | grep -v rpc | grep -v scsi | grep -v talkd ); do echo "#include <$f>"; done > libc_headers.h + + cat > "$COMPILE_TEST_INC/libc_headers.h" << EOF_LIBC_HEADERS +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include <_G_config.h> +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +EOF_LIBC_HEADERS + +fi # LIBC_TEST + +# Simulate libc headers without kernel headers by removing +# all known kernel header dirs from the copied libc ones. +# This seems to magically work. +_KERNEL_DIRS="$( find . -type d | grep -v '^\.$' )" +( cd "$COMPILE_TEST_INC" && rm -rf $_KERNEL_DIRS ) + +# GCC headers +set +u +if [ "$GCC_INC"foobar == "foobar" ]; then + # Take from $CC default system include paths, filter out + # /usr/local/include and /usr/include stuff first, then try to match + # for gcc. + _TEMP="$( $CC -v -x c -E - < /dev/null 2>&1 | \ + sed -n -e '/^#include <...> search starts here:$/,/^End of search list.$/{//!p}' | \ + sed -e 's/^\ \//\//g' | \ + egrep -v '/usr/local/include' | \ + egrep -v '/usr/include' | \ + grep gcc | \ + xargs )" + + # merge and prepare for use with $CC + for d in $_TEMP; do + # sanity test + if [ ! -d "$d" ]; then + echo "$d: is not a directory" + exit 1 + fi + GCC_INC="$GCC_INC -I $d" + done +fi +set -u + +# sanity check: test that plain libc headers compile +if [ "$LIBC_TEST" != 0 ]; then + echo "Testing that $COMPILE_TEST_INC/libc_headers.h compiles" + $CC -Wall -c -nostdinc $GCC_INC -I . \ + -I "$COMPILE_TEST_INC" \ + -I "$COMPILE_TEST_INC/$ARCH_TRIPLET" \ + -o /dev/null \ + "$COMPILE_TEST_INC/libc_headers.h" +fi + +# Summary counters: +_FAILED=0 +_PASSED=0 +_LIBC_FAILED=0 +_LIBC_PASSED=0 +_LIBC_BEFORE_KERNEL_FAILED=0 +_LIBC_BEFORE_KERNEL_PASSED=0 +_KERNEL_BEFORE_LIBC_FAILED=0 +_KERNEL_BEFORE_LIBC_PASSED=0 + +# For each header file, try to compile it using the headers we prepared. +for f in $( find . -name "*\.h" -printf "%P\n" ); do + _FAIL=0 + _FAIL_LIBC=0 + _FAIL_LIBC_BEFORE_KERNEL=0 + _FAIL_KERNEL_BEFORE_LIBC=0 + + # compile test, CC not quoted to support ccache + echo $CC -Wall -c -nostdinc $GCC_INC -I . -I "$COMPILE_TEST_INC" -I "$COMPILE_TEST_INC/$ARCH_TRIPLET" -o /dev/null "$PWD/$f" + $CC -Wall -c -nostdinc $GCC_INC -I . -I "$COMPILE_TEST_INC" -I "$COMPILE_TEST_INC/$ARCH_TRIPLET" -o /dev/null "$PWD/$f" \ + || _FAIL=1 + + # report errors + if [ "$_FAIL" -gt 0 ]; then + echo "FAILED: $f" + _FAILED="$(( _FAILED + 1 ))" + else + echo "PASSED: $f" + _PASSED="$(( _PASSED + 1))" + fi + + # libc header conflict tests + if [ "$LIBC_TEST" != 0 ]; then + _LIBC_BEFORE_KERNEL="$PWD/$f"_libc_before_kernel.h + _KERNEL_BEFORE_LIBC="$PWD/$f"_kernel_before_libc.h + + # libc header included before kernel header + if [ "$LIBC_KERNEL_TEST" != 0 ]; then + cat > "$_LIBC_BEFORE_KERNEL" << EOF_LIBC_BEFORE_KERNEL +#include +#include <$f> +EOF_LIBC_BEFORE_KERNEL + echo \ + $CC -Wall -c -nostdinc $GCC_INC \ + -I . -I "$COMPILE_TEST_INC" \ + -I "$COMPILE_TEST_INC/$ARCH_TRIPLET" \ + -o /dev/null "$_LIBC_BEFORE_KERNEL" + $CC -Wall -c -nostdinc $GCC_INC \ + -I . -I "$COMPILE_TEST_INC" \ + -I "$COMPILE_TEST_INC/$ARCH_TRIPLET" \ + -o /dev/null "$_LIBC_BEFORE_KERNEL" \ + || _FAIL_LIBC_BEFORE_KERNEL=1 + + # report errors + if [ "$_FAIL_LIBC_BEFORE_KERNEL" -gt 0 ]; then + echo "FAILED libc before kernel test: $f" + _LIBC_BEFORE_KERNEL_FAILED="$(( _LIBC_BEFORE_KERNEL_FAILED + 1 ))" + else + echo "PASSED libc before kernel test: $f" + _LIBC_BEFORE_KERNEL_PASSED="$(( _LIBC_BEFORE_KERNEL_PASSED + 1))" + fi + fi + + # kernel header included before libc + if [ "$KERNEL_LIBC_TEST" != 0 ]; then + cat > "$_KERNEL_BEFORE_LIBC" << EOF_KERNEL_BEFORE_LIBC +#include <$f> +#include +EOF_KERNEL_BEFORE_LIBC + echo \ + $CC -Wall -c -nostdinc $GCC_INC \ + -I . -I "$COMPILE_TEST_INC" \ + -I "$COMPILE_TEST_INC/$ARCH_TRIPLET" \ + -o /dev/null "$_KERNEL_BEFORE_LIBC" + $CC -Wall -c -nostdinc $GCC_INC \ + -I . -I "$COMPILE_TEST_INC" \ + -I "$COMPILE_TEST_INC/$ARCH_TRIPLET" \ + -o /dev/null "$_KERNEL_BEFORE_LIBC" \ + || _FAIL_KERNEL_BEFORE_LIBC=1 + + # report errors + if [ "$_FAIL_KERNEL_BEFORE_LIBC" -gt 0 ]; then + echo "FAILED kernel before libc test: $f" + _KERNEL_BEFORE_LIBC_FAILED="$(( _KERNEL_BEFORE_LIBC_FAILED + 1 ))" + else + echo "PASSED kernel before libc test: $f" + _KERNEL_BEFORE_LIBC_PASSED="$(( _KERNEL_BEFORE_LIBC_PASSED + 1))" + fi + fi + + # libc summary + if [ "$_FAIL_LIBC_BEFORE_KERNEL" -gt 0 -o "$_FAIL_KERNEL_BEFORE_LIBC" -gt 0 ]; then + _LIBC_FAILED="$(( _LIBC_FAILED + 1))" + else + _LIBC_PASSED="$(( _LIBC_PASSED + 1))" + fi + + if [ "$KEEP" = "0" ]; then + rm -f "$_LIBC_BEFORE_KERNEL" "$_KERNEL_BEFORE_LIBC" + fi + fi # LIBC_TEST +done + +cat << EOF_STATS + +Kernel header compile test statistics: + +$_FAILED files failed the kernel header compile test. +$_PASSED files passed the kernel header compile test. + +EOF_STATS + +if [ "$LIBC_TEST" != 0 ]; then + cat << EOF_LIBC_STATS +libc and kernel header compatibility test statistics: +EOF_LIBC_STATS + +if [ "$LIBC_KERNEL_TEST" != 0 ] && [ "$KERNEL_LIBC_TEST" != 0 ]; then + cat << EOF_LIBC_COMBINED +$_LIBC_FAILED files failed the libc compatibility test. +$_LIBC_PASSED files passed the libc compatibility test. +EOF_LIBC_COMBINED +fi + +if [ "$LIBC_KERNEL_TEST" != 0 ]; then + cat << EOF_LIBC_KERNEL +$_LIBC_BEFORE_KERNEL_FAILED files failed libc before kernel include test. +$_LIBC_BEFORE_KERNEL_PASSED files passed libc before kernel include test. +EOF_LIBC_KERNEL +fi + +if [ "$KERNEL_LIBC_TEST" != 0 ]; then + cat << EOF_KERNEL_LIBC +$_KERNEL_BEFORE_LIBC_FAILED files failed kernel before libc include test. +$_KERNEL_BEFORE_LIBC_PASSED files passed kernel before libc include test. +EOF_KERNEL_LIBC +fi + +fi # LIBC_TEST + +# return value, summary of all failures. +if [ "$(( $_FAILED + $_LIBC_BEFORE_KERNEL_FAILED + $_KERNEL_BEFORE_LIBC_FAILED ))" != 0 ]; then + exit 1 +else + exit 0 +fi