# $NetBSD: asan_common.subr,v 1.3 2022/06/12 08:55:36 skrll Exp $

# $NetBSD: asan_common.subr,v 1.3 2022/06/12 08:55:36 skrll Exp $
#
# Copyright (c) 2018, 2019 The NetBSD Foundation, Inc.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
# 1. Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
# ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
# TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
# BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
#

SUPPORT='n'
test_target() {
if uname -p | grep -q "aarch64"; then
SUPPORT='y'
fi

if uname -m | grep -q "amd64"; then
SUPPORT='y'
fi

if uname -m | grep -q "i386"; then
SUPPORT='y'
fi
}

atf_test_case target_not_supported
target_not_supported_head()
{
atf_set "descr" "Test forced skip"
}

target_not_supported_body()
{
atf_skip "Target is not supported"
}

# Add a new test case, with head & body.
# asan_test_case <test-name> <description> <check-output>
asan_test_case() {
atf_test_case "$1"
eval "$1_head() {
atf_set 'descr' 'compile and run \"$2\"'
atf_set 'require.progs' 'cc paxctl'
}"

atf_test_case "$1_profile"
eval "$1_head() {
atf_set 'descr' 'compile and run \"$2\" with profiling option'
atf_set 'require.progs' 'cc paxctl'
}"

atf_test_case "$1_pic"
eval "$1_head() {
atf_set 'descr' 'compile and run PIC \"$2\"'
atf_set 'require.progs' 'cc paxctl'
}"

atf_test_case "$1_pie"
eval "$1_head() {
atf_set 'descr' 'compile and run position independent (PIE) \"$2\"'
atf_set 'require.progs' 'cc paxctl'
}"

atf_test_case "${1}32"
eval "$1_head() {
atf_set 'descr' 'compile and run \"$2\" for/in netbsd32 emulation'
atf_set 'require.progs' 'cc paxctl file diff cat'
}"

eval "$1_body() {
echo \"\$ASAN_CODE\" > test.c
cc -fsanitize=address -o test test.c
paxctl +a test
atf_check -s not-exit:0 -o not-match:'CHECK\n' -e match:'$3' ./test
}

$1_profile_body() {
echo \"\$ASAN_CODE\" > test.c
cc -fsanitize=address -static -o test -pg test.c
paxctl +a test
atf_check -s not-exit:0 -o not-match:'CHECK\n' -e match:'$3' ./test
}

$1_pic_body() {
echo \"\$ASAN_CODE\" > test.c
cc -DPIC_FOO -fsanitize=address -fPIC -shared -o libtest.so test.c
cc -DPIC_MAIN -o test test.c -fsanitize=address -L. -ltest
paxctl +a test

export LD_LIBRARY_PATH=.
atf_check -s not-exit:0 -o not-match:'CHECK\n' -e match:'$3' ./test
}

$1_pie_body() {
# check whether this arch supports -pice
if ! cc -pie -dM -E - < /dev/null 2>/dev/null >/dev/null; then
atf_set_skip 'cc -pie not supported on this architecture'
fi
echo \"\$ASAN_CODE\" > test.c
cc -fsanitize=address -o test -fpie -pie test.c
paxctl +a test
atf_check -s not-exit:0 -o not-match:'CHECK\n' -e match:'$3' ./test
}

${1}32_body() {
# check whether this arch is 64bit
if ! cc -dM -E - < /dev/null | fgrep -q _LP64; then
atf_skip 'this is not a 64 bit architecture'
fi
if ! cc -m32 -dM -E - < /dev/null 2>/dev/null > ./def32; then
atf_skip 'cc -m32 not supported on this architecture'
else
if fgrep -q _LP64 ./def32; then
atf_fail 'cc -m32 does not generate netbsd32 binaries'
fi
fi

echo \"\$ASAN_CODE\" > test.c
cc -fsanitize=address -o df32 -m32 test.c
cc -fsanitize=address -o df64 test.c
file -b ./df32 > ./ftype32
file -b ./df64 > ./ftype64
if diff ./ftype32 ./ftype64 >/dev/null; then
atf_fail 'generated binaries do not differ'
fi
echo '32bit binaries on this platform are:'
cat ./ftype32
echo 'While native (64bit) binaries are:'
cat ./ftype64
paxctl +a df32
atf_check -s not-exit:0 -o not-match:'CHECK\n' -e match:'$3' ./df32

# and another test with profile 32bit binaries
cc -fsanitize=address -static -o test -pg -m32 test.c
paxctl +a test
atf_check -s not-exit:0 -o not-match:'CHECK\n' -e match:'$3' ./test
}"
}

asan_add_test_cases() {
test_target
test $SUPPORT = 'n' && {
atf_add_test_case target_not_supported
return 0
}

atf_add_test_case "$1"
# atf_add_test_case "$1_profile"
atf_add_test_case "$1_pic"
atf_add_test_case "$1_pie"
# atf_add_test_case "${1}32"
# static option not supported
# -static and -fsanitize=address can't be used together for compilation
# (gcc version 5.4.0 and clang 7.1) tested on April 2nd 2018.
}