Skip to contentSkip to conversation

perf tests task-analyzer: Write all test files to tmpdir

PATCH Superseded Ian Rogers 2 participants 5 messages Mar 21 – Apr 1 perf events

lore
Share & tools
lore

Ian Rogers

author reviewer
#0 lore raw

PATCH 1/1 perf tests task-analyzer: Write all test files to tmpdir

Writing to the test output files in the current working directory can fail in various contexts such as continual test. Other tests write to a mktemp-ed file, make the "perf script task-analyszer tests" follow this convention too. Currently this isn't possible for the perf.data file due to a lack of perf script support.

---
 tools/perf/tests/shell/test_task_analyzer.sh | 37 +++++++++++---------
 1 file changed, 20 insertions(+), 17 deletions(-)
tools/perf/tests/shell/test_task_analyzer.sh +20 -17
index e194fcf61df3..cc74b03477fe 100755
@@ -3,6 +3,10 @@
 # SPDX-License-Identifier: GPL-2.0
 
 tmpdir=$(mktemp -d /tmp/perf-script-task-analyzer-XXXXX)
+# perf script report only supports input from the perf.data file.
+perfdata="perf.data"
+csv="$tmpdir/csv"
+csvsummary="$tmpdir/csvsummary"
 err=0
 
 # set PERF_EXEC_PATH to find scripts in the source directory
@@ -15,11 +19,10 @@ fi
 export ASAN_OPTIONS=detect_leaks=0
 
 cleanup() {
-  rm -f perf.data
-  rm -f perf.data.old
-  rm -f csv
-  rm -f csvsummary
+  rm -f "${perfdata}"
+  rm -f "${perfdata}".old
   rm -rf "$tmpdir"
+
   trap - exit term int
 }
 
@@ -61,7 +64,7 @@ skip_no_probe_record_support() {
 
 prepare_perf_data() {
 	# 1s should be sufficient to catch at least some switches
-	perf record -e sched:sched_switch -a -- sleep 1 > /dev/null 2>&1
+	perf record -e sched:sched_switch -a -o "${perfdata}" -- sleep 1 > /dev/null 2>&1
 	# check if perf data file got created in above step.
 	if [ ! -e "perf.data" ]; then
 		printf "FAIL: perf record failed to create \"perf.data\" \n"
@@ -130,28 +133,28 @@ test_extended_times_summary_ns() {
 }
 
 test_csv() {
-	perf script report task-analyzer --csv csv > /dev/null
-	check_exec_0 "perf script report task-analyzer --csv csv"
-	find_str_or_fail "Comm;" csv "${FUNCNAME[0]}"
+	perf script report task-analyzer --csv "${csv}" > /dev/null
+	check_exec_0 "perf script report task-analyzer --csv ${csv}"
+	find_str_or_fail "Comm;" "${csv}" "${FUNCNAME[0]}"
 }
 
 test_csv_extended_times() {
-	perf script report task-analyzer --csv csv --extended-times > /dev/null
-	check_exec_0 "perf script report task-analyzer --csv csv --extended-times"
-	find_str_or_fail "Out-Out;" csv "${FUNCNAME[0]}"
+	perf script report task-analyzer --csv "${csv}" --extended-times > /dev/null
+	check_exec_0 "perf script report task-analyzer --csv ${csv} --extended-times"
+	find_str_or_fail "Out-Out;" "${csv}" "${FUNCNAME[0]}"
 }
 
 test_csvsummary() {
-	perf script report task-analyzer --csv-summary csvsummary > /dev/null
-	check_exec_0 "perf script report task-analyzer --csv-summary csvsummary"
-	find_str_or_fail "Comm;" csvsummary "${FUNCNAME[0]}"
+	perf script report task-analyzer --csv-summary "${csvsummary}" > /dev/null
+	check_exec_0 "perf script report task-analyzer --csv-summary ${csvsummary}"
+	find_str_or_fail "Comm;" "${csvsummary}" "${FUNCNAME[0]}"
 }
 
 test_csvsummary_extended() {
-	perf script report task-analyzer --csv-summary csvsummary --summary-extended \
+	perf script report task-analyzer --csv-summary "${csvsummary}" --summary-extended \
 	>/dev/null
-	check_exec_0 "perf script report task-analyzer --csv-summary csvsummary --summary-extended"
-	find_str_or_fail "Out-Out;" csvsummary "${FUNCNAME[0]}"
+	check_exec_0 "perf script report task-analyzer --csv-summary ${csvsummary} --summary-extended"
+	find_str_or_fail "Out-Out;" "${csvsummary}" "${FUNCNAME[0]}"
 }
 
 skip_no_probe_record_support
Signature · 1 line
2.53.0.959.g497ff81fa9-goog
maintainer
#1 lore raw
Quoted 5 lines · Ian Rogers

Writing to the test output files in the current working directory can fail in various contexts such as continual test. Other tests write to a mktemp-ed file, make the "perf script task-analyszer tests" follow this convention too. Currently this isn't possible for the perf.data file due to a lack of perf script support.

I don't know what you mean by the last sentence.

Quoted 11 lines
---
 tools/perf/tests/shell/test_task_analyzer.sh | 37 +++++++++++---------
 1 file changed, 20 insertions(+), 17 deletions(-)
tools/perf/tests/shell/test_task_analyzer.sh +0 -0
index e194fcf61df3..cc74b03477fe 100755

tools/perf/tests/shell/test_task_analyzer.sh line 7

Quoted 5 lines
tools/perf/tests/shell/test_task_analyzer.sh +2 -0
@@ -3,6 +3,10 @@
 # SPDX-License-Identifier: GPL-2.0
 
 tmpdir=$(mktemp -d /tmp/perf-script-task-analyzer-XXXXX)
+# perf script report only supports input from the perf.data file.
+perfdata="perf.data"

I thought you want to use a different file name. What's the point of adding a variable here?

Quoted 21 lines
tools/perf/tests/shell/test_task_analyzer.sh +5 -4
+csv="$tmpdir/csv"
+csvsummary="$tmpdir/csvsummary"
 err=0
 
 # set PERF_EXEC_PATH to find scripts in the source directory
@@ -15,11 +19,10 @@ fi
 export ASAN_OPTIONS=detect_leaks=0
 
 cleanup() {
-  rm -f perf.data
-  rm -f perf.data.old
-  rm -f csv
-  rm -f csvsummary
+  rm -f "${perfdata}"
+  rm -f "${perfdata}".old
   rm -rf "$tmpdir"
+
   trap - exit term int
 }
 

tools/perf/tests/shell/test_task_analyzer.sh skip_no_probe_record_support() { · line 67

Quoted 5 lines
tools/perf/tests/shell/test_task_analyzer.sh +1 -1
@@ -61,7 +64,7 @@ skip_no_probe_record_support() {
 
 prepare_perf_data() {
 	# 1s should be sufficient to catch at least some switches
-	perf record -e sched:sched_switch -a -- sleep 1 > /dev/null 2>&1
+	perf record -e sched:sched_switch -a -o "${perfdata}" -- sleep 1 > /dev/null 2>&1

I'm not sure why it's needed.

Thanks,
Namhyung

Quoted 47 lines
tools/perf/tests/shell/test_task_analyzer.sh +12 -12
 	# check if perf data file got created in above step.
 	if [ ! -e "perf.data" ]; then
 		printf "FAIL: perf record failed to create \"perf.data\" \n"
@@ -130,28 +133,28 @@ test_extended_times_summary_ns() {
 }
 
 test_csv() {
-	perf script report task-analyzer --csv csv > /dev/null
-	check_exec_0 "perf script report task-analyzer --csv csv"
-	find_str_or_fail "Comm;" csv "${FUNCNAME[0]}"
+	perf script report task-analyzer --csv "${csv}" > /dev/null
+	check_exec_0 "perf script report task-analyzer --csv ${csv}"
+	find_str_or_fail "Comm;" "${csv}" "${FUNCNAME[0]}"
 }
 
 test_csv_extended_times() {
-	perf script report task-analyzer --csv csv --extended-times > /dev/null
-	check_exec_0 "perf script report task-analyzer --csv csv --extended-times"
-	find_str_or_fail "Out-Out;" csv "${FUNCNAME[0]}"
+	perf script report task-analyzer --csv "${csv}" --extended-times > /dev/null
+	check_exec_0 "perf script report task-analyzer --csv ${csv} --extended-times"
+	find_str_or_fail "Out-Out;" "${csv}" "${FUNCNAME[0]}"
 }
 
 test_csvsummary() {
-	perf script report task-analyzer --csv-summary csvsummary > /dev/null
-	check_exec_0 "perf script report task-analyzer --csv-summary csvsummary"
-	find_str_or_fail "Comm;" csvsummary "${FUNCNAME[0]}"
+	perf script report task-analyzer --csv-summary "${csvsummary}" > /dev/null
+	check_exec_0 "perf script report task-analyzer --csv-summary ${csvsummary}"
+	find_str_or_fail "Comm;" "${csvsummary}" "${FUNCNAME[0]}"
 }
 
 test_csvsummary_extended() {
-	perf script report task-analyzer --csv-summary csvsummary --summary-extended \
+	perf script report task-analyzer --csv-summary "${csvsummary}" --summary-extended \
 	>/dev/null
-	check_exec_0 "perf script report task-analyzer --csv-summary csvsummary --summary-extended"
-	find_str_or_fail "Out-Out;" csvsummary "${FUNCNAME[0]}"
+	check_exec_0 "perf script report task-analyzer --csv-summary ${csvsummary} --summary-extended"
+	find_str_or_fail "Out-Out;" "${csvsummary}" "${FUNCNAME[0]}"
 }
 
 skip_no_probe_record_support
Signature · 1 line
2.53.0.959.g497ff81fa9-goog
author reviewer
#2 lore raw
Quoted 23 lines · Namhyung Kim
Quoted 5 lines · Ian Rogers

Writing to the test output files in the current working directory can fail in various contexts such as continual test. Other tests write to a mktemp-ed file, make the "perf script task-analyszer tests" follow this convention too. Currently this isn't possible for the perf.data file due to a lack of perf script support.

I don't know what you mean by the last sentence.

Quoted 13 lines
---
 tools/perf/tests/shell/test_task_analyzer.sh | 37 +++++++++++---------
 1 file changed, 20 insertions(+), 17 deletions(-)
tools/perf/tests/shell/test_task_analyzer.sh +0 -0
index e194fcf61df3..cc74b03477fe 100755
@@ -3,6 +3,10 @@
 # SPDX-License-Identifier: GPL-2.0
 
Quoted 6 lines

tools/perf/tests/shell/test_task_analyzer.sh line 7

Quoted 3 lines
tools/perf/tests/shell/test_task_analyzer.sh +2 -0
 tmpdir=$(mktemp -d /tmp/perf-script-task-analyzer-XXXXX)
+# perf script report only supports input from the perf.data file.
+perfdata="perf.data"

I thought you want to use a different file name. What's the point of adding a variable here?

Let me cleanup the commit message in v2. The variable's purpose is to allow us to update it when perf script supports the -i flag with script files.

Thanks,
Ian

Quoted 81 lines
Quoted 22 lines
tools/perf/tests/shell/test_task_analyzer.sh +5 -4
+csv="$tmpdir/csv"
+csvsummary="$tmpdir/csvsummary"
 err=0
 
 # set PERF_EXEC_PATH to find scripts in the source directory
@@ -15,11 +19,10 @@ fi
 export ASAN_OPTIONS=detect_leaks=0
 
 cleanup() {
-  rm -f perf.data
-  rm -f perf.data.old
-  rm -f csv
-  rm -f csvsummary
+  rm -f "${perfdata}"
+  rm -f "${perfdata}".old
   rm -rf "$tmpdir"
+
   trap - exit term int
 }
 

tools/perf/tests/shell/test_task_analyzer.sh skip_no_probe_record_support() { · line 67

Quoted 5 lines
tools/perf/tests/shell/test_task_analyzer.sh +1 -1
@@ -61,7 +64,7 @@ skip_no_probe_record_support() {
 
 prepare_perf_data() {
      # 1s should be sufficient to catch at least some switches
-     perf record -e sched:sched_switch -a -- sleep 1 > /dev/null 2>&1
+     perf record -e sched:sched_switch -a -o "${perfdata}" -- sleep 1 > /dev/null 2>&1

I'm not sure why it's needed.

Thanks,
Namhyung

Quoted 47 lines
tools/perf/tests/shell/test_task_analyzer.sh +12 -13
      # check if perf data file got created in above step.
      if [ ! -e "perf.data" ]; then
              printf "FAIL: perf record failed to create \"perf.data\" \n"
@@ -130,28 +133,28 @@ test_extended_times_summary_ns() {
 }
 
 test_csv() {
-     perf script report task-analyzer --csv csv > /dev/null
-     check_exec_0 "perf script report task-analyzer --csv csv"
-     find_str_or_fail "Comm;" csv "${FUNCNAME[0]}"
+     perf script report task-analyzer --csv "${csv}" > /dev/null
+     check_exec_0 "perf script report task-analyzer --csv ${csv}"
+     find_str_or_fail "Comm;" "${csv}" "${FUNCNAME[0]}"
 }
 
 test_csv_extended_times() {
-     perf script report task-analyzer --csv csv --extended-times > /dev/null
-     check_exec_0 "perf script report task-analyzer --csv csv --extended-times"
-     find_str_or_fail "Out-Out;" csv "${FUNCNAME[0]}"
+     perf script report task-analyzer --csv "${csv}" --extended-times > /dev/null
+     check_exec_0 "perf script report task-analyzer --csv ${csv} --extended-times"
+     find_str_or_fail "Out-Out;" "${csv}" "${FUNCNAME[0]}"
 }
 
 test_csvsummary() {
-     perf script report task-analyzer --csv-summary csvsummary > /dev/null
-     check_exec_0 "perf script report task-analyzer --csv-summary csvsummary"
-     find_str_or_fail "Comm;" csvsummary "${FUNCNAME[0]}"
+     perf script report task-analyzer --csv-summary "${csvsummary}" > /dev/null
+     check_exec_0 "perf script report task-analyzer --csv-summary ${csvsummary}"
+     find_str_or_fail "Comm;" "${csvsummary}" "${FUNCNAME[0]}"
 }
 
 test_csvsummary_extended() {
-     perf script report task-analyzer --csv-summary csvsummary --summary-extended \
+     perf script report task-analyzer --csv-summary "${csvsummary}" --summary-extended \
      >/dev/null
-     check_exec_0 "perf script report task-analyzer --csv-summary csvsummary --summary-extended"
-     find_str_or_fail "Out-Out;" csvsummary "${FUNCNAME[0]}"
+     check_exec_0 "perf script report task-analyzer --csv-summary ${csvsummary} --summary-extended"
+     find_str_or_fail "Out-Out;" "${csvsummary}" "${FUNCNAME[0]}"
 }
 
 skip_no_probe_record_support
--

2.53.0.959.g497ff81fa9-goog

author reviewer
#3 lore raw

PATCH v3 1/1 perf tests task-analyzer: Write test files to tmpdir

Writing to the test output files in the current working directory can fail in various contexts such as continual test. Other tests write to a mktemp-ed file, make the "perf script task-analyszer tests" follow this convention too. Currently this isn't possible for the perf.data file due to a lack of perf script support, add a variable for when this support is available.

---
v3: Address missed rename feedback from Namhyung.
v2: Improvements to commit message:

    https://lore.kernel.org/lkml/[email protected]/
v1: https://lore.kernel.org/lkml/[email protected]/
---
 tools/perf/tests/shell/test_task_analyzer.sh | 42 +++++++++++---------
 1 file changed, 23 insertions(+), 19 deletions(-)
tools/perf/tests/shell/test_task_analyzer.sh +23 -19
index e194fcf61df3..0314412e63b4 100755
@@ -3,6 +3,11 @@
 # SPDX-License-Identifier: GPL-2.0
 
 tmpdir=$(mktemp -d /tmp/perf-script-task-analyzer-XXXXX)
+# TODO: perf script report only supports input from the CWD perf.data file, make
+# it support input from any file.
+perfdata="perf.data"
+csv="$tmpdir/csv"
+csvsummary="$tmpdir/csvsummary"
 err=0
 
 # set PERF_EXEC_PATH to find scripts in the source directory
@@ -15,11 +20,10 @@ fi
 export ASAN_OPTIONS=detect_leaks=0
 
 cleanup() {
-  rm -f perf.data
-  rm -f perf.data.old
-  rm -f csv
-  rm -f csvsummary
+  rm -f "${perfdata}"
+  rm -f "${perfdata}".old
   rm -rf "$tmpdir"
+
   trap - exit term int
 }
 
@@ -61,10 +65,10 @@ skip_no_probe_record_support() {
 
 prepare_perf_data() {
 	# 1s should be sufficient to catch at least some switches
-	perf record -e sched:sched_switch -a -- sleep 1 > /dev/null 2>&1
+	perf record -e sched:sched_switch -a -o "${perfdata}" -- sleep 1 > /dev/null 2>&1
 	# check if perf data file got created in above step.
-	if [ ! -e "perf.data" ]; then
-		printf "FAIL: perf record failed to create \"perf.data\" \n"
+	if [ ! -e "${perfdata}" ]; then
+		printf "FAIL: perf record failed to create \"${perfdata}\" \n"
 		return 1
 	fi
 }
@@ -130,28 +134,28 @@ test_extended_times_summary_ns() {
 }
 
 test_csv() {
-	perf script report task-analyzer --csv csv > /dev/null
-	check_exec_0 "perf script report task-analyzer --csv csv"
-	find_str_or_fail "Comm;" csv "${FUNCNAME[0]}"
+	perf script report task-analyzer --csv "${csv}" > /dev/null
+	check_exec_0 "perf script report task-analyzer --csv ${csv}"
+	find_str_or_fail "Comm;" "${csv}" "${FUNCNAME[0]}"
 }
 
 test_csv_extended_times() {
-	perf script report task-analyzer --csv csv --extended-times > /dev/null
-	check_exec_0 "perf script report task-analyzer --csv csv --extended-times"
-	find_str_or_fail "Out-Out;" csv "${FUNCNAME[0]}"
+	perf script report task-analyzer --csv "${csv}" --extended-times > /dev/null
+	check_exec_0 "perf script report task-analyzer --csv ${csv} --extended-times"
+	find_str_or_fail "Out-Out;" "${csv}" "${FUNCNAME[0]}"
 }
 
 test_csvsummary() {
-	perf script report task-analyzer --csv-summary csvsummary > /dev/null
-	check_exec_0 "perf script report task-analyzer --csv-summary csvsummary"
-	find_str_or_fail "Comm;" csvsummary "${FUNCNAME[0]}"
+	perf script report task-analyzer --csv-summary "${csvsummary}" > /dev/null
+	check_exec_0 "perf script report task-analyzer --csv-summary ${csvsummary}"
+	find_str_or_fail "Comm;" "${csvsummary}" "${FUNCNAME[0]}"
 }
 
 test_csvsummary_extended() {
-	perf script report task-analyzer --csv-summary csvsummary --summary-extended \
+	perf script report task-analyzer --csv-summary "${csvsummary}" --summary-extended \
 	>/dev/null
-	check_exec_0 "perf script report task-analyzer --csv-summary csvsummary --summary-extended"
-	find_str_or_fail "Out-Out;" csvsummary "${FUNCNAME[0]}"
+	check_exec_0 "perf script report task-analyzer --csv-summary ${csvsummary} --summary-extended"
+	find_str_or_fail "Out-Out;" "${csvsummary}" "${FUNCNAME[0]}"
 }
 
 skip_no_probe_record_support
Signature · 1 line
2.53.0.1118.gaef5881109-goog
maintainer Applied
#4 lore raw

Re: [PATCH v3] perf tests task-analyzer: Write test files to tmpdir

Quoted 8 lines · Ian Rogers

Writing to the test output files in the current working directory can fail in various contexts such as continual test. Other tests write to a mktemp-ed file, make the "perf script task-analyszer tests" follow this convention too. Currently this isn't possible for the perf.data file due to a lack of perf script support, add a variable for when this support is available.

[...]

Applied to perf-tools-next, thanks!

Best regards,
Namhyung