xref: /aosp_15_r20/external/OpenCSD/decoder/tests/run_pkt_decode_tests.bash (revision 02ca8ccacfba7e0df68f3332a95f3180334d6649)
1#!/bin/bash
2#################################################################################
3# Copyright 2018 ARM. All rights reserved.
4#
5# Redistribution and use in source and binary forms, with or without modification,
6# are permitted provided that the following conditions are met:
7#
8# 1. Redistributions of source code must retain the above copyright notice,
9# this list of conditions and the following disclaimer.
10#
11# 2. Redistributions in binary form must reproduce the above copyright notice,
12# this list of conditions and the following disclaimer in the documentation
13# and/or other materials provided with the distribution.
14#
15# 3. Neither the name of the copyright holder nor the names of its contributors
16# may be used to endorse or promote products derived from this software without
17# specific prior written permission.
18#
19# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' AND
20# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
23# INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
26# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
28# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29#
30#################################################################################
31# OpenCSD library: Test script.
32#
33# Test script to run packet lister on each of the snapshots retained with the repository.
34# No attempt is made to compare output results to previous versions,  (output formatting
35# may change due to bugfix / enhancements) or assess the validity  of the trace output.
36#
37#################################################################################
38# Usage options:-
39# * default: run tests on binary + libs in ./bin/linux64/rel
40# run_pkt_decode_tests.bash
41#
42# * use installed opencsd libraries & program
43# run_pkt_decode_tests.bash use-installed <options>
44#
45# * use supplied path for binary + libs (must have trailing /)
46# run_pkt_decode_tests.bash -bindir <custom>/<path>/ <options>
47#
48
49OUT_DIR=./results
50SNAPSHOT_DIR=./snapshots
51BIN_DIR=./bin/linux64/rel/
52
53# directories for tests using full decode
54declare -a test_dirs_decode=( "juno-ret-stck"
55                              "a57_single_step"
56                              "bugfix-exact-match"
57                              "juno-uname-001"
58                              "juno-uname-002"
59                              "juno_r1_1"
60                              "tc2-ptm-rstk-t32"
61                              "trace_cov_a15"
62                              "stm_only"
63                              "stm_only-2"
64                              "stm_only-juno"
65                              "stm-issue-27"
66                              "TC2"
67                              "Snowball"
68                              "test-file-mem-offsets"
69                            )
70
71
72echo "Running trc_pkt_lister on snapshot directories."
73
74mkdir -p ${OUT_DIR}
75
76if [ "$1" == "use-installed" ]; then
77    BIN_DIR=""
78    shift
79elif [ "$1" == "-bindir" ]; then
80    BIN_DIR=$2
81    shift
82    shift
83fi
84
85echo "Tests using BIN_DIR = ${BIN_DIR}"
86
87if [ "${BIN_DIR}" != "" ]; then
88    export LD_LIBRARY_PATH=${BIN_DIR}.
89    echo "LD_LIBRARY_PATH set to ${BIN_DIR}"
90fi
91
92# === test the decode set ===
93for test_dir in "${test_dirs_decode[@]}"
94do
95    echo "Testing $test_dir..."
96    ${BIN_DIR}trc_pkt_lister -ss_dir "${SNAPSHOT_DIR}/$test_dir" $@ -decode -logfilename "${OUT_DIR}/$test_dir.ppl"
97    echo "Done : Return $?"
98done
99
100# === test for debugging issues ===
101# juno_r1_1 has fake data that triggers range limit and bad opcode if operating
102echo "Test with run limit on..."
103export OPENCSD_INSTR_RANGE_LIMIT=100
104env | grep OPENCSD
105${BIN_DIR}trc_pkt_lister -ss_dir "${SNAPSHOT_DIR}/juno_r1_1" $@ -decode -logfilename "${OUT_DIR}/juno_r1_1_rangelimit.ppl"
106unset OPENCSD_INSTR_RANGE_LIMIT
107echo "Done : Return $?"
108env | grep OPENCSD
109
110echo "Test with bad opcode detect on using env var..."
111export OPENCSD_ERR_ON_AA64_BAD_OPCODE=1
112env | grep OPENCSD
113${BIN_DIR}trc_pkt_lister -ss_dir "${SNAPSHOT_DIR}/juno_r1_1" $@ -decode -logfilename "${OUT_DIR}/juno_r1_1_badopcode.ppl"
114unset OPENCSD_ERR_ON_AA64_BAD_OPCODE
115echo "Done : Return $?"
116env | grep OPENCSD
117
118echo "Test with bad opcode detect on using flag..."
119${BIN_DIR}trc_pkt_lister -ss_dir "${SNAPSHOT_DIR}/juno_r1_1" $@ -decode -aa64_opcode_chk -logfilename "${OUT_DIR}/juno_r1_1_badopcode_flag.ppl"
120echo "Done : Return $?"
121
122# === test a packet only example ===
123echo "Testing init-short-addr..."
124${BIN_DIR}trc_pkt_lister -ss_dir "${SNAPSHOT_DIR}/init-short-addr" $@ -pkt_mon -logfilename "${OUT_DIR}/init-short-addr.ppl"
125echo "Done : Return $?"
126
127# === test the TPIU deformatter ===
128echo "Testing a55-test-tpiu..."
129${BIN_DIR}trc_pkt_lister -ss_dir "${SNAPSHOT_DIR}/a55-test-tpiu" $@ -dstream_format -o_raw_packed -o_raw_unpacked -logfilename "${OUT_DIR}/a55-test-tpiu.ppl"
130echo "Done : Return $?"
131
132# === test the C-API lib - this test prog is not installed ===
133if [ "$1" != "use-installed" ]; then
134    echo "Testing C-API library"
135    ${BIN_DIR}c_api_pkt_print_test -ss_path ${SNAPSHOT_DIR} -decode > /dev/null
136    echo "Done : Return $?"
137    echo "moving result file."
138    mv ./c_api_test.log ./${OUT_DIR}/c_api_test.ppl
139fi
140
141# === run the Frame decoder test - program not installed ===
142if [ "$1" != "use-installed" ]; then
143    echo "Running Frame demux test"
144    ${BIN_DIR}frame-demux-test > /dev/null
145    echo "Done : Return $?"
146    echo "moving result file."
147    mv ./frame_demux_test.ppl ./${OUT_DIR}/.
148fi
149