rtla/tests: Test all tracer options in runtime tests

Currently, runtime tests only test the osnoise period option
(-p/--period of rtla-osnoise tools, backed by
/sys/kernel/tracing/osnoise/period_us), using the
check_with_osnoise_options function together with a hack relying on long
period (pre-set) timing out if RTLA fails to reset it to the default
value.

Extend tracer option testing to all options used by RTLA; test both RTLA
setting the default option by pre-setting the tracer to a different
value and user-requested value.

The tests are done using a script that reads the tracer values inside an
--on-threshold action, like existing tests for runtime behavior already
do. check_with_osnoise_option is modified to support grep filters, so
that it can be used together with the script pattern.

Assisted-by: Claude:claude-opus-4-6
Link: https://lore.kernel.org/r/20260709091755.58265-1-tglozar@redhat.com
Signed-off-by: Tomas Glozar <tglozar@redhat.com>
This commit is contained in:
Tomas Glozar
2026-07-09 11:17:55 +02:00
parent c1bb78002a
commit ab43bd72f9
6 changed files with 124 additions and 20 deletions

View File

@@ -98,30 +98,37 @@ check() {
}
check_with_osnoise_options() {
# Do the same as "check", but with pre-set osnoise options.
# Note: rtla should reset the osnoise options, this is used to test
# if it indeed does so.
# Save original arguments
arg1=$1
arg2=$2
arg3=$3
# Do the same as "check", but with pre-set tracefs options.
# Resets osnoise first, then writes the given tracefs option=value
# pairs before running the check with NO_RESET_OSNOISE=1.
# Arguments: test_name command exit_code expected_output [path=value ...]
# Each path is relative to /sys/kernel/tracing/
local arg1=$1
local arg2=$2
local arg3=$3
local arg4=$4
local opt option value
# Apply osnoise options (if not dry run)
# Apply tracefs options (if not dry run)
if [ -n "$TEST_COUNT" ]
then
[ "$NO_RESET_OSNOISE" == 1 ] || reset_osnoise
shift
shift
while shift
shift 4
for opt in "$@"
do
[ "$1" == "" ] && continue
option=$(echo $1 | cut -d '=' -f 1)
value=$(echo $1 | cut -d '=' -f 2)
echo "$value" > "/sys/kernel/tracing/osnoise/$option" || return 1
[ -z "$opt" ] && continue
option="${opt%%=*}"
value="${opt#*=}"
# Try to apply the option, ignore errors: when pre-setting fails
# (e.g. kernel does not know the option), the test itself will likely
# also fail.
# Throwing an error here would cause the test to be incorrectly
# skipped.
echo "$value" > "/sys/kernel/tracing/$option"
done
fi
NO_RESET_OSNOISE=1 check "$arg1" "$arg2" "$arg3"
NO_RESET_OSNOISE=1 check "$arg1" "$arg2" "$arg3" "$arg4"
}
check_top_hist() {

View File

@@ -18,5 +18,8 @@ check "stop the trace if a single sample is higher than 1 us" \
check "enable a trace event trigger" \
"hwnoise -t -e osnoise:irq_noise --trigger=\"hist:key=desc,duration:sort=desc,duration:vals=hitcount\" -d 10s" \
0 "Saving event osnoise:irq_noise hist to osnoise_irq_noise_hist.txt"
check "verify OSNOISE_IRQ_DISABLE" \
"hwnoise -S 1 --on-threshold shell,command=\"$testdir/scripts/check-osnoise-option.sh OSNOISE_IRQ_DISABLE\"" \
2 "^OSNOISE_IRQ_DISABLE=enabled$"
test_end

View File

@@ -42,11 +42,40 @@ check "hist with --no-index" \
check "hist with --no-summary" \
"osnoise hist --no-summary -d 1s" 0 "" "^count:"
# Test setting default period by putting an absurdly high period
# and stopping on threshold.
# If default period is not set, this will time out.
# Tracer option tests - verify that rtla correctly sets tracefs options
# Default tests: poison tracefs with wrong values, verify rtla resets to defaults
check_with_osnoise_options "apply default period" \
"osnoise hist -s 1" 2 period_us=600000000
"osnoise top -q -S 1 --on-threshold shell,command=\"$testdir/scripts/check-tracefs-value.sh osnoise/period_us\"" \
2 "^osnoise/period_us=1000000$" osnoise/period_us=600000000
check_with_osnoise_options "apply default runtime" \
"osnoise top -q -S 1 --on-threshold shell,command=\"$testdir/scripts/check-tracefs-value.sh osnoise/runtime_us\"" \
2 "^osnoise/runtime_us=1000000$" osnoise/runtime_us=100
check_with_osnoise_options "apply default tracing_thresh" \
"osnoise top -q -S 1 --on-threshold shell,command=\"$testdir/scripts/check-tracefs-value.sh tracing_thresh\"" \
2 "^tracing_thresh=0$" tracing_thresh=999999
check_with_osnoise_options "apply default stop_tracing_us" \
"osnoise top -q -S 1 --on-threshold shell,command=\"$testdir/scripts/check-tracefs-value.sh osnoise/stop_tracing_us\"" \
2 "^osnoise/stop_tracing_us=0$" osnoise/stop_tracing_us=999999
check_with_osnoise_options "apply default stop_tracing_total_us" \
"osnoise top -q -s 1 --on-threshold shell,command=\"$testdir/scripts/check-tracefs-value.sh osnoise/stop_tracing_total_us\"" \
2 "^osnoise/stop_tracing_total_us=0$" osnoise/stop_tracing_total_us=999999
# Non-default tracer option tests: verify CLI options correctly set tracefs values
check_top_q_hist "verify -p sets period_us" \
"osnoise TOOL -p 2000000 -S 1 --on-threshold shell,command=\"$testdir/scripts/check-tracefs-value.sh osnoise/period_us\"" \
2 "^osnoise/period_us=2000000$"
check_top_q_hist "verify -r sets runtime_us" \
"osnoise TOOL -r 500000 -S 1 --on-threshold shell,command=\"$testdir/scripts/check-tracefs-value.sh osnoise/runtime_us\"" \
2 "^osnoise/runtime_us=500000$"
check_top_q_hist "verify -T sets tracing_thresh" \
"osnoise TOOL -T 5 -S 1 --on-threshold shell,command=\"$testdir/scripts/check-tracefs-value.sh tracing_thresh\"" \
2 "^tracing_thresh=5$"
check_top_q_hist "verify -s sets stop_tracing_us" \
"osnoise TOOL -s 30 -S 1 --on-threshold shell,command=\"$testdir/scripts/check-tracefs-value.sh osnoise/stop_tracing_us\"" \
2 "^osnoise/stop_tracing_us=30$"
check_top_q_hist "verify -S sets stop_tracing_total_us" \
"osnoise TOOL -S 100 --on-threshold shell,command=\"$testdir/scripts/check-tracefs-value.sh osnoise/stop_tracing_total_us\"" \
2 "^osnoise/stop_tracing_total_us=100$"
# Actions tests
check_top_q_hist "trace output through -t with custom filename" \

View File

@@ -0,0 +1,16 @@
#!/bin/bash
# SPDX-License-Identifier: GPL-2.0
# Check if osnoise options are enabled or disabled.
# Usage: check-osnoise-option.sh <OPTION1> [<OPTION2> ...]
# Output: one line per option in the format "OPTION=enabled" or "OPTION=disabled"
options=$(tr ' ' '\n' < /sys/kernel/tracing/osnoise/options)
for name in "$@"; do
if echo "$options" | grep -q "^NO_${name}$"; then
echo "$name=disabled"
elif echo "$options" | grep -q "^${name}$"; then
echo "$name=enabled"
else
echo "$name=unsupported"
fi
done

View File

@@ -0,0 +1,11 @@
#!/bin/bash
# SPDX-License-Identifier: GPL-2.0
# Read tracefs values and print them.
# Usage: check-tracefs-value.sh <relative_path1> [<relative_path2> ...]
# Each path is relative to /sys/kernel/tracing/
# Output: one line per file in the format "path=value"
for file in "$@"; do
read value < "/sys/kernel/tracing/$file"
echo "$file=$value"
done

View File

@@ -55,6 +55,44 @@ check_top_q_hist "verify -k/--kernel-threads" \
check_top_q_hist "verify -u/--user-threads" \
"timerlat TOOL -u -c 0 -d 10s -T 1 --on-threshold shell,command=$testdir/scripts/check-user-kernel-threads.sh" 2 "0 kernel threads, 1 user threads"
# Tracer option tests - verify that rtla correctly sets tracefs options
# Default tests: poison tracefs with wrong values, verify rtla resets to defaults
check_with_osnoise_options "apply default timerlat_period_us" \
"timerlat top -q -T 1 --on-threshold shell,command=\"$testdir/scripts/check-tracefs-value.sh osnoise/timerlat_period_us\"" \
2 "^osnoise/timerlat_period_us=1000$" osnoise/timerlat_period_us=999999
check_with_osnoise_options "apply default print_stack" \
"timerlat top -q -T 1 --on-threshold shell,command=\"$testdir/scripts/check-tracefs-value.sh osnoise/print_stack\"" \
2 "^osnoise/print_stack=0$" osnoise/print_stack=999999
check_with_osnoise_options "apply default stop_tracing_us" \
"timerlat top -q -T 1 --on-threshold shell,command=\"$testdir/scripts/check-tracefs-value.sh osnoise/stop_tracing_us\"" \
2 "^osnoise/stop_tracing_us=0$" osnoise/stop_tracing_us=999999
check_with_osnoise_options "apply default stop_tracing_total_us" \
"timerlat top -q -i 1 --on-threshold shell,command=\"$testdir/scripts/check-tracefs-value.sh osnoise/stop_tracing_total_us\"" \
2 "^osnoise/stop_tracing_total_us=0$" osnoise/stop_tracing_total_us=999999
# Non-default tracer option tests: verify CLI options correctly set tracefs values
check_top_q_hist "verify -p sets timerlat_period_us" \
"timerlat TOOL -p 2000 -T 1 --on-threshold shell,command=\"$testdir/scripts/check-tracefs-value.sh osnoise/timerlat_period_us\"" \
2 "^osnoise/timerlat_period_us=2000$"
check_top_q_hist "verify -s sets print_stack" \
"timerlat TOOL -s 5 -T 1 --on-threshold shell,command=\"$testdir/scripts/check-tracefs-value.sh osnoise/print_stack\"" \
2 "^osnoise/print_stack=5$"
check_top_q_hist "verify -i sets stop_tracing_us" \
"timerlat TOOL -i 2 --on-threshold shell,command=\"$testdir/scripts/check-tracefs-value.sh osnoise/stop_tracing_us\"" \
2 "^osnoise/stop_tracing_us=2$"
check_top_q_hist "verify -T sets stop_tracing_total_us" \
"timerlat TOOL -T 2 --on-threshold shell,command=\"$testdir/scripts/check-tracefs-value.sh osnoise/stop_tracing_total_us\"" \
2 "^osnoise/stop_tracing_total_us=2$"
check_with_osnoise_options "apply default TIMERLAT_ALIGN" \
"timerlat top -q -T 1 --on-threshold shell,command=\"$testdir/scripts/check-osnoise-option.sh TIMERLAT_ALIGN\"" \
2 "^TIMERLAT_ALIGN=disabled$" osnoise/options=TIMERLAT_ALIGN
check_top_q_hist "verify -A sets TIMERLAT_ALIGN" \
"timerlat TOOL -A 100 -T 1 --on-threshold shell,command=\"$testdir/scripts/check-osnoise-option.sh TIMERLAT_ALIGN\"" \
2 "^TIMERLAT_ALIGN=enabled$"
check_top_q_hist "verify -A sets timerlat_align_us" \
"timerlat TOOL -A 100 -T 1 --on-threshold shell,command=\"$testdir/scripts/check-tracefs-value.sh osnoise/timerlat_align_us\"" \
2 "^osnoise/timerlat_align_us=100$"
# Histogram tests
check "hist with -b/--bucket-size" \
"timerlat hist -b 1 -d 1s"