10c343af2SClaire Jensen#!/bin/bash 20c343af2SClaire Jensen# perf stat JSON output linter 30c343af2SClaire Jensen# SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause) 40c343af2SClaire Jensen# Checks various perf stat JSON output commands for the 50c343af2SClaire Jensen# correct number of fields. 60c343af2SClaire Jensen 70c343af2SClaire Jensenset -e 80c343af2SClaire Jensen 958d4802aSAthira Rajeevskip_test=0 1058d4802aSAthira Rajeev 110c343af2SClaire Jensenpythonchecker=$(dirname $0)/lib/perf_json_output_lint.py 120c343af2SClaire Jensenif [ "x$PYTHON" == "x" ] 130c343af2SClaire Jensenthen 140c343af2SClaire Jensen if which python3 > /dev/null 150c343af2SClaire Jensen then 160c343af2SClaire Jensen PYTHON=python3 170c343af2SClaire Jensen elif which python > /dev/null 180c343af2SClaire Jensen then 190c343af2SClaire Jensen PYTHON=python 200c343af2SClaire Jensen else 210c343af2SClaire Jensen echo Skipping test, python not detected please set environment variable PYTHON. 220c343af2SClaire Jensen exit 2 230c343af2SClaire Jensen fi 240c343af2SClaire Jensenfi 250c343af2SClaire Jensen 26760eafb2SIan Rogersstat_output=$(mktemp /tmp/__perf_test.stat_output.json.XXXXX) 27760eafb2SIan Rogers 28760eafb2SIan Rogerscleanup() { 29760eafb2SIan Rogers rm -f "${stat_output}" 30760eafb2SIan Rogers 31760eafb2SIan Rogers trap - EXIT TERM INT 32760eafb2SIan Rogers} 33760eafb2SIan Rogers 34760eafb2SIan Rogerstrap_cleanup() { 35760eafb2SIan Rogers cleanup 36760eafb2SIan Rogers exit 1 37760eafb2SIan Rogers} 38760eafb2SIan Rogerstrap trap_cleanup EXIT TERM INT 39760eafb2SIan Rogers 400c343af2SClaire Jensen# Return true if perf_event_paranoid is > $1 and not running as root. 410c343af2SClaire Jensenfunction ParanoidAndNotRoot() 420c343af2SClaire Jensen{ 43*b3839ff1SDisha Goel [ "$(id -u)" != 0 ] && [ "$(cat /proc/sys/kernel/perf_event_paranoid)" -gt $1 ] 440c343af2SClaire Jensen} 450c343af2SClaire Jensen 460c343af2SClaire Jensencheck_no_args() 470c343af2SClaire Jensen{ 480c343af2SClaire Jensen echo -n "Checking json output: no args " 49760eafb2SIan Rogers perf stat -j -o "${stat_output}" true 50760eafb2SIan Rogers $PYTHON $pythonchecker --no-args --file "${stat_output}" 510c343af2SClaire Jensen echo "[Success]" 520c343af2SClaire Jensen} 530c343af2SClaire Jensen 540c343af2SClaire Jensencheck_system_wide() 550c343af2SClaire Jensen{ 560c343af2SClaire Jensen echo -n "Checking json output: system wide " 570c343af2SClaire Jensen if ParanoidAndNotRoot 0 580c343af2SClaire Jensen then 590c343af2SClaire Jensen echo "[Skip] paranoia and not root" 600c343af2SClaire Jensen return 610c343af2SClaire Jensen fi 62760eafb2SIan Rogers perf stat -j -a -o "${stat_output}" true 63760eafb2SIan Rogers $PYTHON $pythonchecker --system-wide --file "${stat_output}" 640c343af2SClaire Jensen echo "[Success]" 650c343af2SClaire Jensen} 660c343af2SClaire Jensen 670c343af2SClaire Jensencheck_system_wide_no_aggr() 680c343af2SClaire Jensen{ 69760eafb2SIan Rogers echo -n "Checking json output: system wide no aggregation " 700c343af2SClaire Jensen if ParanoidAndNotRoot 0 710c343af2SClaire Jensen then 720c343af2SClaire Jensen echo "[Skip] paranoia and not root" 730c343af2SClaire Jensen return 740c343af2SClaire Jensen fi 75760eafb2SIan Rogers perf stat -j -A -a --no-merge -o "${stat_output}" true 76760eafb2SIan Rogers $PYTHON $pythonchecker --system-wide-no-aggr --file "${stat_output}" 770c343af2SClaire Jensen echo "[Success]" 780c343af2SClaire Jensen} 790c343af2SClaire Jensen 800c343af2SClaire Jensencheck_interval() 810c343af2SClaire Jensen{ 820c343af2SClaire Jensen echo -n "Checking json output: interval " 83760eafb2SIan Rogers perf stat -j -I 1000 -o "${stat_output}" true 84760eafb2SIan Rogers $PYTHON $pythonchecker --interval --file "${stat_output}" 850c343af2SClaire Jensen echo "[Success]" 860c343af2SClaire Jensen} 870c343af2SClaire Jensen 880c343af2SClaire Jensen 890c343af2SClaire Jensencheck_event() 900c343af2SClaire Jensen{ 910c343af2SClaire Jensen echo -n "Checking json output: event " 92760eafb2SIan Rogers perf stat -j -e cpu-clock -o "${stat_output}" true 93760eafb2SIan Rogers $PYTHON $pythonchecker --event --file "${stat_output}" 940c343af2SClaire Jensen echo "[Success]" 950c343af2SClaire Jensen} 960c343af2SClaire Jensen 970c343af2SClaire Jensencheck_per_core() 980c343af2SClaire Jensen{ 990c343af2SClaire Jensen echo -n "Checking json output: per core " 1000c343af2SClaire Jensen if ParanoidAndNotRoot 0 1010c343af2SClaire Jensen then 1020c343af2SClaire Jensen echo "[Skip] paranoia and not root" 1030c343af2SClaire Jensen return 1040c343af2SClaire Jensen fi 105760eafb2SIan Rogers perf stat -j --per-core -a -o "${stat_output}" true 106760eafb2SIan Rogers $PYTHON $pythonchecker --per-core --file "${stat_output}" 1070c343af2SClaire Jensen echo "[Success]" 1080c343af2SClaire Jensen} 1090c343af2SClaire Jensen 1100c343af2SClaire Jensencheck_per_thread() 1110c343af2SClaire Jensen{ 1120c343af2SClaire Jensen echo -n "Checking json output: per thread " 1130c343af2SClaire Jensen if ParanoidAndNotRoot 0 1140c343af2SClaire Jensen then 1150c343af2SClaire Jensen echo "[Skip] paranoia and not root" 1160c343af2SClaire Jensen return 1170c343af2SClaire Jensen fi 118760eafb2SIan Rogers perf stat -j --per-thread -a -o "${stat_output}" true 119760eafb2SIan Rogers $PYTHON $pythonchecker --per-thread --file "${stat_output}" 1200c343af2SClaire Jensen echo "[Success]" 1210c343af2SClaire Jensen} 1220c343af2SClaire Jensen 123bfce728dSK Prateek Nayakcheck_per_cache_instance() 124bfce728dSK Prateek Nayak{ 125bfce728dSK Prateek Nayak echo -n "Checking json output: per cache_instance " 126bfce728dSK Prateek Nayak if ParanoidAndNotRoot 0 127bfce728dSK Prateek Nayak then 128bfce728dSK Prateek Nayak echo "[Skip] paranoia and not root" 129bfce728dSK Prateek Nayak return 130bfce728dSK Prateek Nayak fi 131bfce728dSK Prateek Nayak perf stat -j --per-cache -a true 2>&1 | $PYTHON $pythonchecker --per-cache 132bfce728dSK Prateek Nayak echo "[Success]" 133bfce728dSK Prateek Nayak} 134bfce728dSK Prateek Nayak 1350c343af2SClaire Jensencheck_per_die() 1360c343af2SClaire Jensen{ 1370c343af2SClaire Jensen echo -n "Checking json output: per die " 1380c343af2SClaire Jensen if ParanoidAndNotRoot 0 1390c343af2SClaire Jensen then 1400c343af2SClaire Jensen echo "[Skip] paranoia and not root" 1410c343af2SClaire Jensen return 1420c343af2SClaire Jensen fi 143760eafb2SIan Rogers perf stat -j --per-die -a -o "${stat_output}" true 144760eafb2SIan Rogers $PYTHON $pythonchecker --per-die --file "${stat_output}" 1450c343af2SClaire Jensen echo "[Success]" 1460c343af2SClaire Jensen} 1470c343af2SClaire Jensen 1480c343af2SClaire Jensencheck_per_node() 1490c343af2SClaire Jensen{ 1500c343af2SClaire Jensen echo -n "Checking json output: per node " 1510c343af2SClaire Jensen if ParanoidAndNotRoot 0 1520c343af2SClaire Jensen then 1530c343af2SClaire Jensen echo "[Skip] paranoia and not root" 1540c343af2SClaire Jensen return 1550c343af2SClaire Jensen fi 156760eafb2SIan Rogers perf stat -j --per-node -a -o "${stat_output}" true 157760eafb2SIan Rogers $PYTHON $pythonchecker --per-node --file "${stat_output}" 1580c343af2SClaire Jensen echo "[Success]" 1590c343af2SClaire Jensen} 1600c343af2SClaire Jensen 1610c343af2SClaire Jensencheck_per_socket() 1620c343af2SClaire Jensen{ 1630c343af2SClaire Jensen echo -n "Checking json output: per socket " 1640c343af2SClaire Jensen if ParanoidAndNotRoot 0 1650c343af2SClaire Jensen then 1660c343af2SClaire Jensen echo "[Skip] paranoia and not root" 1670c343af2SClaire Jensen return 1680c343af2SClaire Jensen fi 169760eafb2SIan Rogers perf stat -j --per-socket -a -o "${stat_output}" true 170760eafb2SIan Rogers $PYTHON $pythonchecker --per-socket --file "${stat_output}" 1710c343af2SClaire Jensen echo "[Success]" 1720c343af2SClaire Jensen} 1730c343af2SClaire Jensen 17458d4802aSAthira Rajeev# The perf stat options for per-socket, per-core, per-die 17558d4802aSAthira Rajeev# and -A ( no_aggr mode ) uses the info fetched from this 17658d4802aSAthira Rajeev# directory: "/sys/devices/system/cpu/cpu*/topology". For 17758d4802aSAthira Rajeev# example, socket value is fetched from "physical_package_id" 17858d4802aSAthira Rajeev# file in topology directory. 17958d4802aSAthira Rajeev# Reference: cpu__get_topology_int in util/cpumap.c 18058d4802aSAthira Rajeev# If the platform doesn't expose topology information, values 18158d4802aSAthira Rajeev# will be set to -1. For example, incase of pSeries platform 18258d4802aSAthira Rajeev# of powerpc, value for "physical_package_id" is restricted 18358d4802aSAthira Rajeev# and set to -1. Check here validates the socket-id read from 18458d4802aSAthira Rajeev# topology file before proceeding further 18558d4802aSAthira Rajeev 18658d4802aSAthira RajeevFILE_LOC="/sys/devices/system/cpu/cpu*/topology/" 18758d4802aSAthira RajeevFILE_NAME="physical_package_id" 18858d4802aSAthira Rajeev 18958d4802aSAthira Rajeevcheck_for_topology() 19058d4802aSAthira Rajeev{ 19158d4802aSAthira Rajeev if ! ParanoidAndNotRoot 0 19258d4802aSAthira Rajeev then 19358d4802aSAthira Rajeev socket_file=`ls $FILE_LOC/$FILE_NAME | head -n 1` 19458d4802aSAthira Rajeev [ -z $socket_file ] && return 0 19558d4802aSAthira Rajeev socket_id=`cat $socket_file` 19658d4802aSAthira Rajeev [ $socket_id == -1 ] && skip_test=1 19758d4802aSAthira Rajeev return 0 19858d4802aSAthira Rajeev fi 19958d4802aSAthira Rajeev} 20058d4802aSAthira Rajeev 20158d4802aSAthira Rajeevcheck_for_topology 2020c343af2SClaire Jensencheck_no_args 2030c343af2SClaire Jensencheck_system_wide 2040c343af2SClaire Jensencheck_interval 2050c343af2SClaire Jensencheck_event 2060c343af2SClaire Jensencheck_per_thread 2070c343af2SClaire Jensencheck_per_node 20858d4802aSAthira Rajeevif [ $skip_test -ne 1 ] 20958d4802aSAthira Rajeevthen 21058d4802aSAthira Rajeev check_system_wide_no_aggr 21158d4802aSAthira Rajeev check_per_core 212bfce728dSK Prateek Nayak check_per_cache_instance 21358d4802aSAthira Rajeev check_per_die 2140c343af2SClaire Jensen check_per_socket 21558d4802aSAthira Rajeevelse 21658d4802aSAthira Rajeev echo "[Skip] Skipping tests for system_wide_no_aggr, per_core, per_die and per_socket since socket id exposed via topology is invalid" 21758d4802aSAthira Rajeevfi 218760eafb2SIan Rogerscleanup 2190c343af2SClaire Jensenexit 0 220