[linux.git] / scripts / test_fortify.sh

#!/bin/sh
# SPDX-License-Identifier: GPL-2.0-only
set -e

# Argument 1: Source file to build.
IN="$1"
shift
# Extract just the filename for error messages below.
FILE="${IN##*/}"
# Extract the function name for error messages below.
FUNC="${FILE#*-}"
FUNC="${FUNC%%-*}"
FUNC="${FUNC%%.*}"
# Extract the symbol to test for in build/symbol test below.
WANT="__${FILE%%-*}"

# Argument 2: Where to write the build log.
OUT="$1"
shift
TMP="${OUT}.tmp"

# Argument 3: Path to "nm" tool.
NM="$1"
shift

# Remaining arguments are: $(CC) $(c_flags)

# Clean up temporary file at exit.
__cleanup() {
	rm -f "$TMP"
}
trap __cleanup EXIT

# Function names in warnings are wrapped in backticks under UTF-8 locales.
# Run the commands with LANG=C so that grep output will not change.
export LANG=C

status=
# Attempt to build a source that is expected to fail with a specific warning.
if "$@" -Werror -c "$IN" -o "$OUT".o 2> "$TMP" ; then
	# If the build succeeds, either the test has failed or the
	# warning may only happen at link time (Clang). In that case,
	# make sure the expected symbol is unresolved in the symbol list.
	# If so, FORTIFY is working for this case.
	if ! $NM -A "$OUT".o | grep -m1 "\bU ${WANT}$" >>"$TMP" ; then
		status="warning: unsafe ${FUNC}() usage lacked '$WANT' symbol in $IN"
	fi
else
	# If the build failed, check for the warning in the stderr.
	# GCC:
	# ./include/linux/fortify-string.h:316:25: error: call to '__write_overflow_field' declared with attribute warning: detected write beyond size of field (1st parameter); maybe use struct_group()? [-Werror=attribute-warning]
	# Clang 14:
	# ./include/linux/fortify-string.h:316:4: error: call to __write_overflow_field declared with 'warning' attribute: detected write beyond size of field (1st parameter); maybe use struct_group()? [-Werror,-Wattribute-warning]
	if ! grep -Eq -m1 "error: call to .?\b${WANT}\b.?" "$TMP" ; then
		status="warning: unsafe ${FUNC}() usage lacked '$WANT' warning in $IN"
	fi
fi

if [ -n "$status" ]; then
	# Report on failure results, including compilation warnings.
	echo "$status" | tee "$OUT" >&2
else
	# Report on good results, and save any compilation output to log.
	echo "ok: unsafe ${FUNC}() usage correctly detected with '$WANT' in $IN" >"$OUT"
fi
cat "$TMP" >>"$OUT"
Commit	Line	Data
be58f710 KC	1	#!/bin/sh
	2	# SPDX-License-Identifier: GPL-2.0-only
	3	set -e
	4
	5	# Argument 1: Source file to build.
	6	IN="$1"
	7	shift
	8	# Extract just the filename for error messages below.
	9	FILE="${IN##*/}"
	10	# Extract the function name for error messages below.
	11	FUNC="${FILE#*-}"
	12	FUNC="${FUNC%%-*}"
	13	FUNC="${FUNC%%.*}"
	14	# Extract the symbol to test for in build/symbol test below.
	15	WANT="__${FILE%%-*}"
	16
	17	# Argument 2: Where to write the build log.
	18	OUT="$1"
	19	shift
	20	TMP="${OUT}.tmp"
	21
	22	# Argument 3: Path to "nm" tool.
	23	NM="$1"
	24	shift
	25
	26	# Remaining arguments are: $(CC) $(c_flags)
	27
	28	# Clean up temporary file at exit.
	29	__cleanup() {
	30	rm -f "$TMP"
	31	}
	32	trap __cleanup EXIT
	33
	34	# Function names in warnings are wrapped in backticks under UTF-8 locales.
	35	# Run the commands with LANG=C so that grep output will not change.
	36	export LANG=C
	37
	38	status=
	39	# Attempt to build a source that is expected to fail with a specific warning.
	40	if "$@" -Werror -c "$IN" -o "$OUT".o 2> "$TMP" ; then
	41	# If the build succeeds, either the test has failed or the
	42	# warning may only happen at link time (Clang). In that case,
	43	# make sure the expected symbol is unresolved in the symbol list.
	44	# If so, FORTIFY is working for this case.
	45	if ! $NM -A "$OUT".o \| grep -m1 "\bU ${WANT}$" >>"$TMP" ; then
	46	status="warning: unsafe ${FUNC}() usage lacked '$WANT' symbol in $IN"
	47	fi
	48	else
818ab43f KC	49	# If the build failed, check for the warning in the stderr.
	50	# GCC:
	51	# ./include/linux/fortify-string.h:316:25: error: call to '__write_overflow_field' declared with attribute warning: detected write beyond size of field (1st parameter); maybe use struct_group()? [-Werror=attribute-warning]
	52	# Clang 14:
	53	# ./include/linux/fortify-string.h:316:4: error: call to __write_overflow_field declared with 'warning' attribute: detected write beyond size of field (1st parameter); maybe use struct_group()? [-Werror,-Wattribute-warning]
	54	if ! grep -Eq -m1 "error: call to .?\b${WANT}\b.?" "$TMP" ; then
be58f710 KC	55	status="warning: unsafe ${FUNC}() usage lacked '$WANT' warning in $IN"
	56	fi
	57	fi
	58
	59	if [ -n "$status" ]; then
	60	# Report on failure results, including compilation warnings.
	61	echo "$status" \| tee "$OUT" >&2
	62	else
	63	# Report on good results, and save any compilation output to log.
	64	echo "ok: unsafe ${FUNC}() usage correctly detected with '$WANT' in $IN" >"$OUT"
	65	fi
	66	cat "$TMP" >>"$OUT"