Skip to content

Commit 44ac594

Browse files
ekurdybxekurdybx
committed
test: PC10 residency and resume time
Signed-off-by: Emilia Kurdybelska <emiliax.kurdybelska@intel.com>
1 parent 60f43ba commit 44ac594

File tree

4 files changed

+247
-56
lines changed

4 files changed

+247
-56
lines changed

‎test-case/check-suspend-resume.sh‎

Lines changed: 73 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -26,27 +26,33 @@ source "$TOPDIR"/case-lib/lib.sh
2626
random_min=3 # wait time should >= 3 for other device wakeup from sleep
2727
random_max=20
2828

29-
OPT_NAME['l']='loop' OPT_DESC['l']='loop count'
30-
OPT_HAS_ARG['l']=1 OPT_VAL['l']=5
29+
OPT_NAME['l']='loop' OPT_DESC['l']='loop count'
30+
OPT_HAS_ARG['l']=1 OPT_VAL['l']=5
3131

32-
OPT_NAME['T']='type' OPT_DESC['T']="suspend/resume type from /sys/power/mem_sleep"
33-
OPT_HAS_ARG['T']=1 OPT_VAL['T']=""
32+
OPT_NAME['T']='type' OPT_DESC['T']="suspend/resume type from /sys/power/mem_sleep"
33+
OPT_HAS_ARG['T']=1 OPT_VAL['T']=""
3434

35-
OPT_NAME['S']='sleep' OPT_DESC['S']='suspend/resume command:rtcwake sleep duration'
36-
OPT_HAS_ARG['S']=1 OPT_VAL['S']=5
35+
OPT_NAME['S']='sleep' OPT_DESC['S']='suspend/resume command:rtcwake sleep duration'
36+
OPT_HAS_ARG['S']=1 OPT_VAL['S']=5
3737

38-
OPT_NAME['u']='unload-audio' OPT_DESC['u']='unload audio modules for the test'
39-
OPT_HAS_ARG['u']=0 OPT_VAL['u']=0
38+
OPT_NAME['u']='unload-audio' OPT_DESC['u']='unload audio modules for the test'
39+
OPT_HAS_ARG['u']=0 OPT_VAL['u']=0
4040

41-
OPT_NAME['w']='wait' OPT_DESC['w']='idle time after suspend/resume wakeup'
42-
OPT_HAS_ARG['w']=1 OPT_VAL['w']=5
41+
OPT_NAME['w']='wait' OPT_DESC['w']='idle time after suspend/resume wakeup'
42+
OPT_HAS_ARG['w']=1 OPT_VAL['w']=5
4343

44-
OPT_NAME['r']='random' OPT_DESC['r']="Randomly setup wait/sleep time, range is [$random_min-$random_max], this option will overwrite s & w option"
45-
OPT_HAS_ARG['r']=0 OPT_VAL['r']=0
44+
OPT_NAME['r']='random' OPT_DESC['r']="Randomly setup wait/sleep time, range is [$random_min-$random_max], this option will overwrite s & w option"
45+
OPT_HAS_ARG['r']=0 OPT_VAL['r']=0
4646

4747
# processid is set by check-suspend-resume-with-audio.sh for audio test case
48-
OPT_NAME['p']='processid' OPT_DESC['p']='Fail immediately if this process dies'
49-
OPT_HAS_ARG['p']=1 OPT_VAL['p']=''
48+
OPT_NAME['p']='processid' OPT_DESC['p']='Fail immediately if this process dies'
49+
OPT_HAS_ARG['p']=1 OPT_VAL['p']=''
50+
51+
OPT_NAME['s']='run-sleepgraph' OPT_DESC['s']='run with sleepgraph'
52+
OPT_HAS_ARG['s']=0 OPT_VAL['s']=0
53+
54+
OPT_NAME['t']='times-thresholds' OPT_DESC['t']='sleepgraph thresholds'
55+
OPT_HAS_ARG['t']=1 OPT_VAL['t']=''
5056

5157
func_opt_parse_option "$@"
5258
func_lib_check_sudo
@@ -69,21 +75,29 @@ dlogi "Current suspend/resume type mode: $(cat /sys/power/mem_sleep)"
6975
loop_count=${OPT_VAL['l']}
7076
declare -a sleep_lst wait_lst
7177

72-
if [ ${OPT_VAL['r']} -eq 1 ]; then
78+
if [ "${OPT_VAL['r']}" -eq 1 ]; then
7379
# create random number list
74-
for i in $(seq 1 $loop_count)
80+
for i in $(seq 1 "$loop_count")
7581
do
76-
sleep_lst[$i]=$(func_lib_get_random $random_max $random_min)
77-
wait_lst[$i]=$(func_lib_get_random $random_max $random_min)
82+
sleep_lst[i]=$(func_lib_get_random $random_max $random_min)
83+
wait_lst[i]=$(func_lib_get_random $random_max $random_min)
7884
done
7985
else
80-
for i in $(seq 1 $loop_count)
86+
for i in $(seq 1 "$loop_count")
8187
do
82-
sleep_lst[$i]=${OPT_VAL['S']}
83-
wait_lst[$i]=${OPT_VAL['w']}
88+
sleep_lst[i]=${OPT_VAL['S']}
89+
wait_lst[i]=${OPT_VAL['w']}
8490
done
8591
fi
8692

93+
if [ "${OPT_VAL['s']}" -eq 1 ]; then
94+
SLEEPGRAPH_PATH="$HOME/pm-graph/sleepgraph.py"
95+
if [ ! -f "$SLEEPGRAPH_PATH" ]; then
96+
echo "Sleepgraph is not installed! Exiting..."
97+
exit 1
98+
fi
99+
fi
100+
87101
save_initial_stats()
88102
{
89103
printf '\n\n'
@@ -143,7 +157,7 @@ main()
143157

144158
local keep_modules=true already_unloaded=false
145159

146-
if [ ${OPT_VAL['u']} = 1 ]; then
160+
if [ "${OPT_VAL['u']}" = 1 ]; then
147161
keep_modules=false
148162
fi
149163

@@ -159,7 +173,7 @@ main()
159173
expected_wakeup_count=$(cat /sys/power/wakeup_count)
160174
expected_stats_success=$(cat /sys/power/suspend_stats/success)
161175
save_initial_stats
162-
for i in $(seq 1 $loop_count)
176+
for i in $(seq 1 "$loop_count")
163177
do
164178
sleep_once "$i"
165179
done
@@ -170,6 +184,40 @@ main()
170184
die "Found kernel error after reloading audio drivers"
171185
}
172186

187+
analyze_sleepgraph_results()
188+
{
189+
dlogi "Analyzing sleepgraph results"
190+
results_file=$(find suspend-*/*.html)
191+
cp "$results_file" "$LOG_ROOT/"
192+
thresholds="${OPT_VAL['t']}"
193+
194+
dlogi "Analyzing $results_file file..."
195+
if python3 "$SCRIPT_HOME"/tools/analyze-sleepgraph-results.py "$results_file" "$thresholds"; then
196+
dlogi "All times measurements within the thresholds"
197+
return 0
198+
else
199+
dlogw "Time measurements not within the thresholds!"
200+
return 1
201+
fi
202+
}
203+
204+
run_rtcwake()
205+
{
206+
if [ "${OPT_VAL['s']}" -eq 1 ]; then
207+
# remove any files from previous sleepgraph runs
208+
rm -rf suspend-*
209+
210+
dlogc "Run the command: $SLEEPGRAPH_PATH -rtcwake ${sleep_lst[$i]} -m freeze"
211+
sudo "$SLEEPGRAPH_PATH" -rtcwake "${sleep_lst[$i]}" -m freeze ||
212+
dump_and_die "rtcwake returned $?"
213+
analyze_sleepgraph_results
214+
else
215+
dlogc "Run the command: rtcwake -m mem -s ${sleep_lst[$i]}"
216+
sudo rtcwake -m mem -s "${sleep_lst[$i]}" ||
217+
dump_and_die "rtcwake returned $?"
218+
fi
219+
}
220+
173221
sleep_once()
174222
{
175223
local i="$1"
@@ -179,11 +227,9 @@ sleep_once()
179227
setup_kernel_check_point
180228
expected_wakeup_count=$((expected_wakeup_count+1))
181229
expected_stats_success=$((expected_stats_success+1))
182-
dlogc "Run the command: rtcwake -m mem -s ${sleep_lst[$i]}"
183-
sudo rtcwake -m mem -s "${sleep_lst[$i]}" ||
184-
dump_and_die "rtcwake returned $?"
230+
run_rtcwake
185231
dlogc "sleep for ${wait_lst[$i]}"
186-
sleep ${wait_lst[$i]}
232+
sleep "${wait_lst[$i]}"
187233
dlogi "Check for the kernel log status"
188234
# check kernel log for each iteration to catch issues
189235
sof-kernel-log-check.sh "$KERNEL_CHECKPOINT" || dump_and_die "Caught error in kernel log"

‎test-case/sleepgraph-wrapper.sh‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
#!/bin/bash
2+
3+
##
4+
## Case Name: Wrapper to run a given test case with sleepgraph.py in setup that cannot set the environment variable.
5+
## Keep this script as simple as possible and avoid additional layers of indirections when possible.
6+
## Preconditions:
7+
## Sleepgraph.py script is available.
8+
## Description:
9+
## This script serves as a wrapper to execute a test case script with additionally running sleepgraph.py.
10+
## It expects the test case script file name (without path) as the first parameter,
11+
## followed by other parameters required for that test case.
12+
##
13+
14+
set -e
15+
16+
# Ensure the test case script file name is provided
17+
if [ -z "$1" ]; then
18+
echo "Error: No test case script file name provided. Exiting..."
19+
exit 1
20+
fi
21+
22+
# Check if sleepgraph is installed
23+
export SLEEPGRAPH_PATH="$HOME/pm-graph/sleepgraph.py"
24+
if [ ! -f "$SLEEPGRAPH_PATH" ]; then
25+
echo "Sleepgraph is not installed! Exiting..."
26+
exit 1
27+
fi
28+
29+
export RUN_SLEEPGRAPH=true
30+
31+
TESTDIR=$(realpath -e "$(dirname "${BASH_SOURCE[0]}")/..")
32+
33+
# shellcheck disable=SC2145
34+
[ -x "$TESTDIR/test-case/$(basename "$1")" ] && exec "$TESTDIR"/test-case/"$@"

‎test-case/test-socwatch.sh‎

Lines changed: 65 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,7 @@ OPT_NAME['u']='unload-audio' OPT_DESC['u']='unload audio modules for the test'
3838
OPT_HAS_ARG['u']=0 OPT_VAL['u']=0
3939

4040
: "${SOCWATCH_PATH:=$HOME/socwatch}"
41-
SOCWATCH_VERSION=$("$SOCWATCH_PATH"/socwatch --version |grep Version)
42-
43-
# reference cmd: sudo ./socwatch -t 20 -s 5 -f cpu-cstate -f pkg-pwr -o fredtest5
44-
#SOCWATCH_CMD="./socwatch"
45-
SOCWATCH_FEATURE_PARAMS=( -f cpu-cstate -f pkg-pwr )
41+
SOCWATCH_VERSION=$(sudo "$SOCWATCH_PATH"/socwatch --version |grep Version)
4642

4743
func_opt_parse_option "$@"
4844
func_lib_check_sudo
@@ -57,41 +53,57 @@ check_socwatch_module_loaded()
5753
lsmod | grep -q socwatch || dlogi "socwatch is not loaded"
5854
}
5955

56+
check_for_PC10_state()
57+
{
58+
pc10_count=$(awk '/Package C-State Summary: Entry Counts/{f=1; next} f && /PC10/{print $3; exit}' "$socwatch_output".csv)
59+
if [ -z "$pc10_count" ]; then
60+
die "PC10 State not achieved"
61+
fi
62+
dlogi "Entered into PC10 State $pc10_count times"
63+
64+
pc10_per=$(awk '/Package C-State Summary: Residency/{f=1; next} f && /PC10/{print $3; exit}' "$socwatch_output".csv)
65+
pc10_time=$(awk '/Package C-State Summary: Residency/{f=1; next} f && /PC10/{print $5; exit}' "$socwatch_output".csv)
66+
dlogi "Spent $pc10_time ms ($pc10_per %) in PC10 State"
67+
68+
json_str=$( jq -n \
69+
--arg id "$i" \
70+
--arg cnt "$pc10_count" \
71+
--arg time "$pc10_time" \
72+
--arg per "$pc10_per" \
73+
'{$id: {pc10_entires_count: $cnt, time_ms: $time, time_percentage: $per}}' )
74+
75+
results=$(jq --slurp 'add' <(echo "$results") <(echo "$json_str"))
76+
}
77+
6078
socwatch_test_once()
6179
{
6280
local i="$1"
6381
dlogi "===== Loop($i/$loop_count) ====="
6482
dlogi "SoCWatch version: ${SOCWATCH_VERSION}"
6583

84+
socwatch_output="$LOG_ROOT/socwatch-results/socwatch_output_$i"
85+
6686
# set up checkpoint for each iteration
6787
setup_kernel_check_point
6888

69-
# load socwatch module, if the module is loaded, go ahead with the testing (-q)
70-
sudo "$SOCWATCH_PATH"/drivers/insmod-socwatch -q || true
71-
check_socwatch_module_loaded || die "socwatch module not loaded"
72-
7389
( set -x
74-
sudo "$SOCWATCH_PATH"/socwatch -t "$duration" -s "$wait_time" "${SOCWATCH_FEATURE_PARAMS[@]}" -o "$SOCWATCH_PATH/sofsocwatch-$i" ) ||
90+
sudo "$SOCWATCH_PATH"/socwatch -m -f sys -f cpu -f cpu-hw -f pcie -f hw-cpu-cstate \
91+
-f pcd-slps0 -f tcss-state -f tcss -f pcie-lpm -n 200 -t "$duration" -s "$wait_time" \
92+
-r json -o "$socwatch_output" ) ||
7593
die "socwatch returned $?"
7694

77-
# filter output and copy to log directory
78-
grep "Package C-State Summary: Residency" -B 8 -A 11 "$SOCWATCH_PATH/sofsocwatch-$i.csv" | tee "$SOCWATCH_PATH/socwatch-$i.txt"
79-
grep "Package Power Summary: Average Rate" -B 6 -A 4 "$SOCWATCH_PATH/sofsocwatch-$i.csv" | tee -a "$SOCWATCH_PATH/socwatch-$i.txt"
80-
# zip original csv report
81-
gzip "$SOCWATCH_PATH/sofsocwatch-$i.csv"
82-
mv "$SOCWATCH_PATH/socwatch-$i.txt" "$SOCWATCH_PATH/sofsocwatch-$i.csv.gz" "$LOG_ROOT"/
95+
# analyze SoCWatch results
96+
check_for_PC10_state
8397

84-
dlogi "Check for the kernel log status"
8598
# check kernel log for each iteration to catch issues
99+
dlogi "Check for the kernel log status"
86100
sof-kernel-log-check.sh "$KERNEL_CHECKPOINT" || die "Caught error in kernel log"
87-
88-
# unload socwatch module
89-
sudo "$SOCWATCH_PATH"/drivers/rmmod-socwatch || true
90101
}
91102

92-
main()
103+
unload_modules()
93104
{
94-
local keep_modules=true already_unloaded=false
105+
keep_modules=true
106+
already_unloaded=false
95107

96108
[ -d "$SOCWATCH_PATH" ] ||
97109
die "SOCWATCH not found in SOCWATCH_PATH=$SOCWATCH_PATH"
@@ -108,20 +120,44 @@ main()
108120

109121
$already_unloaded || $keep_modules || "$TOPDIR"/tools/kmod/sof_remove.sh ||
110122
die "Failed to unload audio drivers"
123+
}
124+
125+
load_modules()
126+
{
127+
$already_unloaded || $keep_modules || "$TOPDIR"/tools/kmod/sof_insert.sh ||
128+
die "Failed to reload audio drivers"
129+
sof-kernel-log-check.sh "$KERNEL_CHECKPOINT" ||
130+
die "Found kernel error after reloading audio drivers"
131+
}
132+
133+
run_socwatch_tests()
134+
{
135+
# load socwatch module, if the module is loaded, go ahead with the testing
136+
sudo "$SOCWATCH_PATH"/drivers/insmod-socwatch || true
137+
check_socwatch_module_loaded || die "socwatch module not loaded"
138+
139+
mkdir "$LOG_ROOT/socwatch-results"
140+
pc10_results_file="$LOG_ROOT/socwatch-results/pc10_results.json"
141+
touch "$pc10_results_file"
111142

112-
# socwatch test from here
113143
for i in $(seq 1 "$loop_count")
114144
do
115145
socwatch_test_once "$i"
116146
done
147+
echo "$results" > "$pc10_results_file"
117148

118-
$already_unloaded || $keep_modules || "$TOPDIR"/tools/kmod/sof_insert.sh ||
119-
die "Failed to reload audio drivers"
120-
sof-kernel-log-check.sh "$KERNEL_CHECKPOINT" ||
121-
die "Found kernel error after reloading audio drivers"
149+
# zip all SoCWatch reports
150+
tar -zcvf "$LOG_ROOT/socwatch-results.tar.gz" "$LOG_ROOT/socwatch-results/"
122151

123-
# DON"T delete socwatch directory after test, delete before new test
124-
# rm -rf $SOCWATCH_PATH
152+
# unload socwatch module
153+
sudo "$SOCWATCH_PATH"/drivers/rmmod-socwatch
154+
}
155+
156+
main()
157+
{
158+
unload_modules
159+
run_socwatch_tests
160+
load_modules
125161
}
126162

127163
main "$@"

0 commit comments

Comments
 (0)