add README, and CLI options

This commit is contained in:
Brendan Gregg committed 2018-01-10 16:05:31 -08:00
1 parent b8bdb2d6cb
commit f09ed5dbee
3 files changed
+178 -6

No files matched your search

+50 -4
View File
@@ -5,7 +5,7 @@
# TLB: Translation Lookaside Buffer (the MMU page translation cache)
# PMC: Performance Monitoring Counters
#
# USAGE: tlbstat [interval [duration]]
# USAGE: tlbstat {-C CPU | -p PID | -c CMD} [interval [duration]]
#
# REQUIREMENTS: perf command, TLB PMCs (counters listed below)
#
@@ -26,12 +26,58 @@
#
# 08-Jan-2018 Brendan Gregg Created this.
function usage {
cat <<-END >&2
USAGE: tlbstat {-C CPU | -p PID | -c CMD} [interval [duration]]
-C CPU # measure this CPU only
-p PID # measure this PID only
-c 'CMD' # measure this command only (quote it)
interval # output interval in secs (default 1)
duration # total seconds (default infinityish)
eg,
tlbstat # show stats across all CPUs
tlbstat 5 # show stats every 5 seconds
tlbstat -C 0 # measure CPU 0 only
tlbstat -p 181 # measure PID 181 only
tlbstat -c 'cksum /boot/*' # measure run and measure this cmd
END
exit
}
opt_cpu=0; opt_pid=0; opt_cmd=0; cpu=""; pid=""; cmd=""
while getopts C:p:c:h opt
do
case $opt in
C) opt_cpu=1; cpu=$OPTARG ;;
p) opt_pid=1; pid=$OPTARG ;;
c) opt_cmd=1; cmd=$OPTARG ;;
h|?) usage ;;
esac
done
shift $(( $OPTIND - 1 ))
if (( opt_cpu + opt_pid + opt_cmd > 1 )); then
echo >&2 "ERROR: pick one of -C, -p, -c"
usage
fi
secs=${1-1} # default 1 second
duration=${2-999999999} # default semi-infinite seconds
hlines=25 # lines to repeat header
target=-a
(( opt_cpu )) && target="-C $cpu sleep $duration"
(( opt_pid )) && target="-p $pid sleep $duration"
(( opt_cmd )) && target="$cmd"
if (( opt_pid )); then
if [ ! -d /proc/$pid ]; then
echo >&2 "ERROR: Can't find PID $pid. Exiting."
exit
fi
fi
# note that instructions is last on purpose, it triggers output
perf stat -e cycles \
perf stat -e cycles -e cycles \
-e dtlb_load_misses.miss_causes_a_walk \
-e dtlb_store_misses.miss_causes_a_walk \
-e itlb_misses.miss_causes_a_walk \
@@ -39,7 +85,7 @@ perf stat -e cycles \
-e dtlb_store_misses.walk_active \
-e itlb_misses.walk_active \
-e instructions \
-a -I $(( secs * 1000 )) sleep $duration 2>&1 | awk -v hlines=$hlines '
-I $(( secs * 1000 )) $target 2>&1 | awk -v hlines=$hlines '
BEGIN {
htxt = sprintf("%-10s %-10s %5s %-10s %-10s %-10s %-10s %5s %5s",
"K_CYCLES", "K_INSTR", "IPC", "DTLB_WALKS", "ITLB_WALKS",
@@ -63,7 +109,7 @@ perf stat -e cycles \
header = hlines
}
ins = $2
if (cycles == 0) { cycles = 1 } # and PMCs are broken
if (cycles == 0) { cycles = 1 } # PMCs are broken, or no events
printf("%-10d %-10d %5.2f %-10d %-10d %-10d %-10d %5.2f %5.2f\n",
cycles / 1000, ins / 1000, ins / cycles,