| #!/bin/bash | |
| # perf_report :: Basic perf report options (exclusive) | |
| # SPDX-License-Identifier: GPL-2.0 | |
| # | |
| # test_basic of perf_report test | |
| # Author: Michael Petlan <mpetlan@redhat.com> | |
| # | |
| # Description: | |
| # | |
| # This test tests basic functionality of perf report command. | |
| # | |
| # | |
| DIR_PATH="$(dirname $0)" | |
| TEST_RESULT=0 | |
| # include working environment | |
| . "$DIR_PATH/../common/init.sh" | |
| ### help message | |
| if [ "$PARAM_GENERAL_HELP_TEXT_CHECK" = "y" ]; then | |
| # test that a help message is shown and looks reasonable | |
| $CMD_PERF report --help > $LOGS_DIR/basic_helpmsg.log 2> $LOGS_DIR/basic_helpmsg.err | |
| PERF_EXIT_CODE=$? | |
| "$DIR_PATH/../common/check_all_patterns_found.pl" \ | |
| "PERF-REPORT" "NAME" "SYNOPSIS" "DESCRIPTION" "OPTIONS" \ | |
| "OVERHEAD\s+CALCULATION" "SEE ALSO" < $LOGS_DIR/basic_helpmsg.log | |
| CHECK_EXIT_CODE=$? | |
| "$DIR_PATH/../common/check_all_patterns_found.pl" \ | |
| "input" "verbose" "show-nr-samples" "show-cpu-utilization" \ | |
| "threads" "comms" "pid" "tid" "dsos" "symbols" "symbol-filter" \ | |
| < $LOGS_DIR/basic_helpmsg.log | |
| (( CHECK_EXIT_CODE += $? )) | |
| "$DIR_PATH/../common/check_all_patterns_found.pl" \ | |
| "hide-unresolved" "sort" "fields" "parent" "exclude-other" \ | |
| "column-widths" "field-separator" "dump-raw-trace" "children" \ | |
| < $LOGS_DIR/basic_helpmsg.log | |
| (( CHECK_EXIT_CODE += $? )) | |
| "$DIR_PATH/../common/check_all_patterns_found.pl" \ | |
| "call-graph" "max-stack" "inverted" "ignore-callees" "pretty" \ | |
| "stdio" "tui" "gtk" "vmlinux" "kallsyms" "modules" \ | |
| < $LOGS_DIR/basic_helpmsg.log | |
| (( CHECK_EXIT_CODE += $? )) | |
| "$DIR_PATH/../common/check_all_patterns_found.pl" \ | |
| "force" "symfs" "cpu" "disassembler-style" "source" "asm-raw" \ | |
| "show-total-period" "show-info" "branch-stack" "group" \ | |
| < $LOGS_DIR/basic_helpmsg.log | |
| (( CHECK_EXIT_CODE += $? )) | |
| "$DIR_PATH/../common/check_all_patterns_found.pl" \ | |
| "branch-history" "objdump" "demangle" "percent-limit" "percentage" \ | |
| "header" "itrace" "full-source-path" "show-ref-call-graph" \ | |
| < $LOGS_DIR/basic_helpmsg.log | |
| (( CHECK_EXIT_CODE += $? )) | |
| "$DIR_PATH/../common/check_no_patterns_found.pl" \ | |
| "No manual entry for" < $LOGS_DIR/basic_helpmsg.err | |
| (( CHECK_EXIT_CODE += $? )) | |
| print_results $PERF_EXIT_CODE $CHECK_EXIT_CODE "help message" | |
| (( TEST_RESULT += $? )) | |
| else | |
| print_testcase_skipped "help message" | |
| fi | |
| ### basic execution | |
| # test that perf report is even working | |
| $CMD_PERF report -i $CURRENT_TEST_DIR/perf.data --stdio > $LOGS_DIR/basic_basic.log 2> $LOGS_DIR/basic_basic.err | |
| PERF_EXIT_CODE=$? | |
| REGEX_LOST_SAMPLES_INFO="#\s*Total Lost Samples:\s+$RE_NUMBER" | |
| REGEX_SAMPLES_INFO="#\s*Samples:\s+(?:$RE_NUMBER)\w?\s+of\s+event\s+'$RE_EVENT_ANY'" | |
| REGEX_LINES_HEADER="#\s*Children\s+Self\s+Command\s+Shared Object\s+Symbol" | |
| REGEX_LINES="\s*$RE_NUMBER%\s+$RE_NUMBER%\s+\S+\s+\[kernel\.(?:vmlinux)|(?:kallsyms)\]\s+\[[k\.]\]\s+\w+" | |
| "$DIR_PATH/../common/check_all_patterns_found.pl" \ | |
| "$REGEX_LOST_SAMPLES_INFO" "$REGEX_SAMPLES_INFO" \ | |
| "$REGEX_LINES_HEADER" "$REGEX_LINES" < $LOGS_DIR/basic_basic.log | |
| CHECK_EXIT_CODE=$? | |
| "$DIR_PATH/../common/check_errors_whitelisted.pl" \ | |
| "$DIR_PATH/stderr-whitelist.txt" < $LOGS_DIR/basic_basic.err | |
| (( CHECK_EXIT_CODE += $? )) | |
| print_results $PERF_EXIT_CODE $CHECK_EXIT_CODE "basic execution" | |
| (( TEST_RESULT += $? )) | |
| ### number of samples | |
| # '--show-nr-samples' should show number of samples for each symbol | |
| $CMD_PERF report --stdio -i $CURRENT_TEST_DIR/perf.data --show-nr-samples > $LOGS_DIR/basic_nrsamples.log 2> $LOGS_DIR/basic_nrsamples.err | |
| PERF_EXIT_CODE=$? | |
| REGEX_LINES_HEADER="#\s*Children\s+Self\s+Samples\s+Command\s+Shared Object\s+Symbol" | |
| REGEX_LINES="\s*$RE_NUMBER%\s+$RE_NUMBER%\s+$RE_NUMBER\s+\S+\s+\[kernel\.(?:vmlinux)|(?:kallsyms)\]\s+\[[k\.]\]\s+\w+" | |
| "$DIR_PATH/../common/check_all_patterns_found.pl" \ | |
| "$REGEX_LINES_HEADER" "$REGEX_LINES" < $LOGS_DIR/basic_nrsamples.log | |
| CHECK_EXIT_CODE=$? | |
| "$DIR_PATH/../common/check_errors_whitelisted.pl" \ | |
| "$DIR_PATH/stderr-whitelist.txt" < $LOGS_DIR/basic_nrsamples.err | |
| (( CHECK_EXIT_CODE += $? )) | |
| print_results $PERF_EXIT_CODE $CHECK_EXIT_CODE "number of samples" | |
| (( TEST_RESULT += $? )) | |
| ### header | |
| # '--header' and '--header-only' should show perf report header | |
| $CMD_PERF report -i $CURRENT_TEST_DIR/perf.data --stdio --header-only > $LOGS_DIR/basic_header.log | |
| PERF_EXIT_CODE=$? | |
| REGEX_LINE_TIMESTAMP="#\s+captured on\s*:\s*$RE_DATE_TIME" | |
| REGEX_LINE_HOSTNAME="#\s+hostname\s*:\s*$MY_HOSTNAME" | |
| REGEX_LINE_KERNEL="#\s+os release\s*:\s*${MY_KERNEL_VERSION//+/\\+}" | |
| REGEX_LINE_PERF="#\s+perf version\s*:\s*" | |
| REGEX_LINE_ARCH="#\s+arch\s*:\s*$MY_ARCH" | |
| REGEX_LINE_CPUS_ONLINE="#\s+nrcpus online\s*:\s*$MY_CPUS_ONLINE" | |
| REGEX_LINE_CPUS_AVAIL="#\s+nrcpus avail\s*:\s*$MY_CPUS_AVAILABLE" | |
| # disable precise check for "nrcpus avail" in BASIC runmode | |
| test $PERFTOOL_TESTSUITE_RUNMODE -lt $RUNMODE_STANDARD && REGEX_LINE_CPUS_AVAIL="#\s+nrcpus avail\s*:\s*$RE_NUMBER" | |
| "$DIR_PATH/../common/check_all_patterns_found.pl" \ | |
| "$REGEX_LINE_TIMESTAMP" "$REGEX_LINE_HOSTNAME" "$REGEX_LINE_KERNEL" \ | |
| "$REGEX_LINE_PERF" "$REGEX_LINE_ARCH" "$REGEX_LINE_CPUS_ONLINE" \ | |
| "$REGEX_LINE_CPUS_AVAIL" < $LOGS_DIR/basic_header.log | |
| CHECK_EXIT_CODE=$? | |
| print_results $PERF_EXIT_CODE $CHECK_EXIT_CODE "header" | |
| (( TEST_RESULT += $? )) | |
| # '--header' and '--header-only' should use creation time | |
| OLD_TIMESTAMP=`$CMD_PERF report --stdio --header-only -i $CURRENT_TEST_DIR/perf.data | grep "captured on"` | |
| PERF_EXIT_CODE=$? | |
| ( tar -C $CURRENT_TEST_DIR -c perf.data | xz > $CURRENT_TEST_DIR/perf.data.tar.xz ; xzcat $CURRENT_TEST_DIR/perf.data.tar.xz | tar x -C $HEADER_TAR_DIR ) | |
| (( PERF_EXIT_CODE += $? )) | |
| NEW_TIMESTAMP=`$CMD_PERF report --stdio --header-only -i $HEADER_TAR_DIR/perf.data | grep "captured on"` | |
| (( PERF_EXIT_CODE += $? )) | |
| test "$OLD_TIMESTAMP" = "$NEW_TIMESTAMP" | |
| CHECK_EXIT_CODE=$? | |
| print_results $PERF_EXIT_CODE $CHECK_EXIT_CODE "header timestamp" | |
| (( TEST_RESULT += $? )) | |
| ### show CPU utilization | |
| # '--showcpuutilization' should show percentage for both system and userspace mode | |
| $CMD_PERF report -i $CURRENT_TEST_DIR/perf.data --stdio --showcpuutilization > $LOGS_DIR/basic_cpuut.log 2> $LOGS_DIR/basic_cpuut.err | |
| PERF_EXIT_CODE=$? | |
| REGEX_LINES_HEADER="#\s*Children\s+Self\s+sys\s+usr\s+Command\s+Shared Object\s+Symbol" | |
| REGEX_LINES="\s*$RE_NUMBER%\s+$RE_NUMBER%\s+$RE_NUMBER%\s+$RE_NUMBER%\s+\S+\s+\[kernel\.(?:vmlinux)|(?:kallsyms)\]\s+\[[k\.]\]\s+\w+" | |
| "$DIR_PATH/../common/check_all_patterns_found.pl" \ | |
| "$REGEX_LINES_HEADER" "$REGEX_LINES" < $LOGS_DIR/basic_cpuut.log | |
| CHECK_EXIT_CODE=$? | |
| "$DIR_PATH/../common/check_errors_whitelisted.pl" \ | |
| "$DIR_PATH/stderr-whitelist.txt" < $LOGS_DIR/basic_cpuut.err | |
| (( CHECK_EXIT_CODE += $? )) | |
| print_results $PERF_EXIT_CODE $CHECK_EXIT_CODE "show CPU utilization" | |
| (( TEST_RESULT += $? )) | |
| ### pid | |
| # '--pid=' should limit the output for a process with the given pid only | |
| $CMD_PERF report --stdio -i $CURRENT_TEST_DIR/perf.data --pid=1 > $LOGS_DIR/basic_pid.log 2> $LOGS_DIR/basic_pid.err | |
| PERF_EXIT_CODE=$? | |
| grep -P -v '^#' $LOGS_DIR/basic_pid.log | grep -P '\s+[\d\.]+%' | \ | |
| "$DIR_PATH/../common/check_all_lines_matched.pl" "systemd|init" | |
| CHECK_EXIT_CODE=$? | |
| "$DIR_PATH/../common/check_errors_whitelisted.pl" \ | |
| "$DIR_PATH/stderr-whitelist.txt" < $LOGS_DIR/basic_pid.err | |
| (( CHECK_EXIT_CODE += $? )) | |
| print_results $PERF_EXIT_CODE $CHECK_EXIT_CODE "pid" | |
| (( TEST_RESULT += $? )) | |
| ### non-existing symbol | |
| # '--symbols' should show only the given symbols | |
| $CMD_PERF report --stdio -i $CURRENT_TEST_DIR/perf.data --symbols=dummynonexistingsymbol > $LOGS_DIR/basic_symbols.log 2> $LOGS_DIR/basic_symbols.err | |
| PERF_EXIT_CODE=$? | |
| "$DIR_PATH/../common/check_all_lines_matched.pl" \ | |
| "$RE_LINE_EMPTY" "$RE_LINE_COMMENT" < $LOGS_DIR/basic_symbols.log | |
| CHECK_EXIT_CODE=$? | |
| "$DIR_PATH/../common/check_errors_whitelisted.pl" \ | |
| "$DIR_PATH/stderr-whitelist.txt" < $LOGS_DIR/basic_symbols.err | |
| (( CHECK_EXIT_CODE += $? )) | |
| print_results $PERF_EXIT_CODE $CHECK_EXIT_CODE "non-existing symbol" | |
| (( TEST_RESULT += $? )) | |
| ### symbol filter | |
| # '--symbol-filter' should filter symbols based on substrings | |
| $CMD_PERF report --stdio -i $CURRENT_TEST_DIR/perf.data --symbol-filter=map > $LOGS_DIR/basic_symbolfilter.log 2> $LOGS_DIR/basic_symbolfilter.err | |
| PERF_EXIT_CODE=$? | |
| grep -P -v '^#' $LOGS_DIR/basic_symbolfilter.log | grep -P '\s+[\d\.]+%' | \ | |
| "$DIR_PATH/../common/check_all_lines_matched.pl" "\[[k\.]\]\s+.*map" | |
| CHECK_EXIT_CODE=$? | |
| "$DIR_PATH/../common/check_errors_whitelisted.pl" \ | |
| "$DIR_PATH/stderr-whitelist.txt" < $LOGS_DIR/basic_symbolfilter.err | |
| (( CHECK_EXIT_CODE += $? )) | |
| print_results $PERF_EXIT_CODE $CHECK_EXIT_CODE "symbol filter" | |
| (( TEST_RESULT += $? )) | |
| ### latency and parallelism | |
| # Record with --latency should record with context switches. | |
| $CMD_PERF report -i $CURRENT_TEST_DIR/perf.data.1 --stdio --header-only > $LOGS_DIR/latency_header.log | |
| PERF_EXIT_CODE=$? | |
| "$DIR_PATH/../common/check_all_patterns_found.pl" \ | |
| ", context_switch = 1, " < $LOGS_DIR/latency_header.log | |
| CHECK_EXIT_CODE=$? | |
| print_results $PERF_EXIT_CODE $CHECK_EXIT_CODE "latency header" | |
| (( TEST_RESULT += $? )) | |
| # The default report for latency profile should show Overhead and Latency fields (in that order). | |
| $CMD_PERF report --stdio -i $CURRENT_TEST_DIR/perf.data.1 > $LOGS_DIR/latency_default.log 2> $LOGS_DIR/latency_default.err | |
| PERF_EXIT_CODE=$? | |
| "$DIR_PATH/../common/check_all_patterns_found.pl" \ | |
| "# Overhead Latency Command" < $LOGS_DIR/latency_default.log | |
| CHECK_EXIT_CODE=$? | |
| "$DIR_PATH/../common/check_errors_whitelisted.pl" \ | |
| "stderr-whitelist.txt" < $LOGS_DIR/latency_default.err | |
| (( CHECK_EXIT_CODE += $? )) | |
| print_results $PERF_EXIT_CODE $CHECK_EXIT_CODE "default report for latency profile" | |
| (( TEST_RESULT += $? )) | |
| # The latency report for latency profile should show Latency and Overhead fields (in that order). | |
| $CMD_PERF report --latency --stdio -i $CURRENT_TEST_DIR/perf.data.1 > $LOGS_DIR/latency_latency.log 2> $LOGS_DIR/latency_latency.err | |
| PERF_EXIT_CODE=$? | |
| "$DIR_PATH/../common/check_all_patterns_found.pl" \ | |
| "# Latency Overhead Command" < $LOGS_DIR/latency_latency.log | |
| CHECK_EXIT_CODE=$? | |
| "$DIR_PATH/../common/check_errors_whitelisted.pl" \ | |
| "stderr-whitelist.txt" < $LOGS_DIR/latency_latency.err | |
| (( CHECK_EXIT_CODE += $? )) | |
| print_results $PERF_EXIT_CODE $CHECK_EXIT_CODE "latency report for latency profile" | |
| (( TEST_RESULT += $? )) | |
| # Ensure parallelism histogram with parallelism filter does not fail/crash. | |
| $CMD_PERF report --hierarchy --sort latency,parallelism,comm,symbol --parallelism=1,2 --stdio -i $CURRENT_TEST_DIR/perf.data.1 > $LOGS_DIR/parallelism_hierarchy.log 2> $LOGS_DIR/parallelism_hierarchy.err | |
| PERF_EXIT_CODE=$? | |
| "$DIR_PATH/../common/check_all_patterns_found.pl" \ | |
| "# Latency Parallelism / Command / Symbol" \ | |
| < $LOGS_DIR/parallelism_hierarchy.log | |
| CHECK_EXIT_CODE=$? | |
| "$DIR_PATH/../common/check_errors_whitelisted.pl" \ | |
| "stderr-whitelist.txt" < $LOGS_DIR/parallelism_hierarchy.err | |
| (( CHECK_EXIT_CODE += $? )) | |
| print_results $PERF_EXIT_CODE $CHECK_EXIT_CODE "parallelism histogram" | |
| (( TEST_RESULT += $? )) | |
| # TODO: $CMD_PERF report -n --showcpuutilization -TUxDg 2> 01.log | |
| # print overall results | |
| print_overall_results "$TEST_RESULT" | |
| exit $? |