#!/usr/bin/ksh
#
#
# This file and its contents are supplied under the terms of the
# Common Development and Distribution License ("CDDL"), version 1.0.
# You may only use this file in accordance with the terms of version
# 1.0 of the CDDL.
#
# A full copy of the text of the CDDL should have accompanied this
# source.  A copy of the CDDL is also available via the Internet at
# http://www.illumos.org/license/CDDL.
#

#
# Copyright 2021 Oxide Computer Company
#

unalias -a
set -o pipefail

pcidb_arg0="$(basename $0)"
pcidb_prog="/usr/lib/pci/pcidb"
pcidb_exit=0

warn()
{
	typeset msg="$*"
	[[ -z "$msg" ]] && msg="failed"
	echo "TEST FAILED: $pcidb_arg0: $msg" >&2
}

#
# The following is intended to catch bad filters.
#
pcidb_bad_filter()
{
	typeset filt="$1"

	if $pcidb_prog $filt 2>/dev/null; then
		warn "invalid filter $filt erroneously worked"
		pcidb_exit=1
		return
	fi

	printf "TEST PASSED: invalid filter %s\n" "$filt"

}

pcidb_bad_args()
{
	if $pcidb_prog $@ 2>/dev/null 1>/dev/null; then
		warn "should have failed with args "$@", but passed"
		pcidb_exit=1
		return
	fi

	printf "TEST PASSED: invalid arguments %s\n" "$*"
}

pcidb_match()
{
	typeset output
	typeset match="$1"
	shift

	output=$($pcidb_prog $@)
	if (( $? != 0)); then
		warn "failed to run pcidb with args: $@"
		pcidb_exit=1
		return
	fi

	if [[ "$output" != "$match" ]]; then
		warn "output mismatch with args: $@\n found:    $output\n" \
		    "expected: $match"
		pcidb_exit=1
		return
	fi

	printf "TEST PASSED: successfully matched against %s\n" "$*"
}

if [[ -n $PCIDB ]]; then
	pcidb_prog=$PCIDB
fi

#
# Before we begin execution, set up the environment such that we have a
# standard locale and that umem will help us catch mistakes.
#
export LC_ALL=C.UTF-8
export LD_PRELOAD=libumem.so
export UMEM_DEBUG=default

#
# Validate that filters match either exactly one or at least one line of
# output using parsable mode. When we match more than one entry, we
# don't try to assert the count because we expect that it will actually
# change over time.
#
exp="1de
8086"
pcidb_match "$exp" -v -p -o vid pci8086 pci1de
pcidb_match "Advanced Micro Devices, Inc. [AMD]" -v -p -o vendor pci1022
pcidb_match "1af4:1044:Virtio RNG" -p -o vid,did,device pci1af4,1044
pcidb_match "Dell:HBA330 Adapter" -s -p -o subvendor,subsystem \
	pci1000,97.1028,1f45
pcidb_match "c:3:30:XHCI" -i -p -o bcc,scc,pi,interface pciclass,0c0330
pcidb_match "I2O" -S -p -o subclass pciexclass,0e
pcidb_match "Ethernet 1Gb 2-port 368i Adapter" -s -p -o subsystem pci1590,216,s

#
# We should get no output when we specify a class or device filter and
# use a different table or we have an over specified filter.
#
pcidb_match "" -d pciclass,03
pcidb_match "" -S pci1000
pcidb_match "" -v pci8086,1234
pcidb_match "" -c pciclass,010802

#
# Run through filter parsing
#
pcidb_bad_filter "foo"
pcidb_bad_filter ";ffvi"
pcidb_bad_filter "12345"
pcidb_bad_filter "pc8086"
pcidb_bad_filter "pciqwer"
pcidb_bad_filter "pci12345"
pcidb_bad_filter "pci8086,"
pcidb_bad_filter "pci8086,locke"
pcidb_bad_filter "pci8086sigh"
pcidb_bad_filter "pci8086,p"
pcidb_bad_filter "pci8086,12345"
pcidb_bad_filter "pci8086,1234zz"
pcidb_bad_filter "pci8086,1234."
pcidb_bad_filter "pci8086,1234,"
pcidb_bad_filter "pci8086,1234,b"
pcidb_bad_filter "pci8086,1234,8"
pcidb_bad_filter "pci8086,1234,wat"
pcidb_bad_filter "pci8086,1234.terra"
pcidb_bad_filter "pci8086,1234.terra,celes"
pcidb_bad_filter "pci8086,1234.fffff"
pcidb_bad_filter "pci8086,1234.abcd,"
pcidb_bad_filter "pci8086,1234.abcd."
pcidb_bad_filter "pci8086,1234.abcdqr"
pcidb_bad_filter "pci8086,1234.abcd,2,p"
pcidb_bad_filter "pci8086,1234.abcd,2000000000"
pcidb_bad_filter "pci8086,1234.abcd,kefka"
pcidb_bad_filter "pci8086,1234.abcd,34ultros"
pcidb_bad_filter "pciexqwer"
pcidb_bad_filter "pciex12345"
pcidb_bad_filter "pciex8086,"
pcidb_bad_filter "pciex8086,locke"
pcidb_bad_filter "pciex8086sigh"
pcidb_bad_filter "pciex8086,p"
pcidb_bad_filter "pciex8086,12345"
pcidb_bad_filter "pciex8086,1234zz"
pcidb_bad_filter "pciex8086,1234."
pcidb_bad_filter "pciex8086,1234,"
pcidb_bad_filter "pciex8086,1234,b"
pcidb_bad_filter "pciex8086,1234,8"
pcidb_bad_filter "pciex8086,1234,wat"
pcidb_bad_filter "pciex8086,1234.terra"
pcidb_bad_filter "pciex8086,1234.terra,celes"
pcidb_bad_filter "pciex8086,1234.fffff"
pcidb_bad_filter "pciex8086,1234.abcd,"
pcidb_bad_filter "pciex8086,1234.abcd."
pcidb_bad_filter "pciex8086,1234.abcdqr"
pcidb_bad_filter "pciex8086,1234.abcd,2,p"
pcidb_bad_filter "pciex8086,1234.abcd,2000000000"
pcidb_bad_filter "pciex8086,1234.abcd,kefka"
pcidb_bad_filter "pciex8086,1234.abcd,34ultros"
pcidb_bad_filter "pciclas"
pcidb_bad_filter "pciclassedgar"
pcidb_bad_filter "pciclass,sabin"
pcidb_bad_filter "pciclass,0"
pcidb_bad_filter "pciclass,013"
pcidb_bad_filter "pciclass,01345"
pcidb_bad_filter "pciclass,0134567"
pcidb_bad_filter "pciclass,01,"
pcidb_bad_filter "pciclass,010,"
pcidb_bad_filter "pciclass,010aa,"
pcidb_bad_filter "pciclass,0102as"
pcidb_bad_filter "pciclass,0102.as"
pcidb_bad_filter "pciclass,0102@as"
pcidb_bad_filter "pciclass,010298aa"
pcidb_bad_filter "pciclass,010298,"
pcidb_bad_filter "pciclass,010298!"
pcidb_bad_filter "pciclass,010298!shadow"
pcidb_bad_filter "pciexclas"
pcidb_bad_filter "pciexclassedgar"
pcidb_bad_filter "pciexclass,sabin"
pcidb_bad_filter "pciexclass,0"
pcidb_bad_filter "pciexclass,013"
pcidb_bad_filter "pciexclass,01345"
pcidb_bad_filter "pciexclass,0134567"
pcidb_bad_filter "pciexclass,01,"
pcidb_bad_filter "pciexclass,010,"
pcidb_bad_filter "pciexclass,010aa,"
pcidb_bad_filter "pciexclass,0102as"
pcidb_bad_filter "pciexclass,0102.as"
pcidb_bad_filter "pciexclass,0102@as"
pcidb_bad_filter "pciexclass,010298aa"
pcidb_bad_filter "pciexclass,010298,"
pcidb_bad_filter "pciexclass,010298!"
pcidb_bad_filter "pciexclass,010298!shadow"

#
# Verify that if we ask for bad columns we error
#
pcidb_bad_args -p
pcidb_bad_args -o
pcidb_bad_args -o -p
pcidb_bad_args -p -o terra
pcidb_bad_args -p -o subclass -v
pcidb_bad_args -v -d -c

if (( pcidb_exit == 0 )); then
	printf "All tests passed successfully!\n"
fi

exit $pcidb_exit