Skip to contentSkip to conversation

perf scripts: Add configurable sorting option to powerpc-hcalls

PATCH Superseded Shivani Nittor 2 participants 2 messages Jun 17 perf events

v2 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 perf scripts: Add configurable sorting option to powerpc-hcalls

The powerpc-hcalls.py script currently prints hypercall statistics in a fixed sort order based on the number of hcall occurrences, making it difficult to analyze hcalls from different execution characteristics.

Add support for runtime-configurable sorting so users can order hypercall statistics by count, minimum latency, maximum latency, or average latency using a --sort option.

Parse arguments through sys.argv to support perf script argument passing semantics.

Example:

perf record -a -e powerpc* sleep 10

perf script -s ./powerpc-hcalls.py -i ./perf.data -- --sort=max

SORT KEY = max
hcall count min(ns) max(ns) avg(ns)

H_SEND_LOGICAL_LAN                  47      7380     40148      8739
H_VIO_SIGNAL                       706       880     17454      1911
H_RANDOM                             1     15176     15176     15176
H_PUT_TCE_INDIRECT                   4      3032     10444      4956
H_ADD_LOGICAL_LAN_BUFFER           363      1250      8716      1534
H_SEND_CRQ                           8      2086      6846      3044
H_PUT_TCE                            9      1284      4932      2646
H_STUFF_TCE                         13      1620      3962      2358

This makes it easier to identify frequently occurring or high-latency hypercalls depending on the analysis being performed.

---
Changelog:
v1 -> v2
- Add bounds check for --sort argument handling
- Prevent IndexError when sort key is omitted

---
tools/perf/scripts/python/powerpc-hcalls.py | 38 ++++++++++++++++++++-

1 file changed, 37 insertions(+), 1 deletion(-)
tools/perf/scripts/python/powerpc-hcalls.py +37 -1
index 8b78dc790adb..e5b0c1bee65f 100644
@@ -25,6 +25,7 @@ from Util import *
 #	} ...
 # }
 output = {}
+sort_key = 'count'
 
 # d_enter: {
 #	cpu: {
@@ -158,10 +159,45 @@ def hcall_table_lookup(opcode):
 
 print_ptrn = '%-28s%10s%10s%10s%10s'
 
+def sort_output(opcode):
+	stats = output[opcode]
+
+	if sort_key == 'min':
+		return stats['min']
+	if sort_key == 'max':
+		return stats['max']
+	if sort_key == 'avg':
+		return stats['time'] // stats['cnt']
+
+	return stats['cnt']
+
+def trace_begin():
+    global sort_key
+
+    i = 1
+    while i < len(sys.argv):
+        arg = sys.argv[i]
+
+        if arg == '-s' or arg == '--sort':
+            if i + 1 >= len(sys.argv):
+                print("Error: -s/--sort requires a sort key argument")
+                sys.exit(1)
+            sort_key = sys.argv[i + 1]
+            i += 2
+            continue
+
+        if arg.startswith('--sort='):
+            sort_key = arg.split('=', 1)[1]
+
+        i += 1
+
+    print("SORT KEY =", sort_key)
+
 def trace_end():
 	print(print_ptrn % ('hcall', 'count', 'min(ns)', 'max(ns)', 'avg(ns)'))
 	print('-' * 68)
-	for opcode in output:
+	for opcode in sorted(output, key = sort_output,
+                            reverse=True):
 		h_name = hcall_table_lookup(opcode)
 		time = output[opcode]['time']
 		cnt = output[opcode]['cnt']
Signature · 1 line
2.54.0
#1 lore raw
Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider: - [Medium] The `--sort` argument value is not validated, leading to silently ignored user intent and…

Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
- [Medium] The --sort argument value is not validated, leading to silently ignored user intent and misleading output for invalid keys. --

commit 1aa1f92efbcdcc2ec41737225787d40ac02abf40
Author: Shivani Nittor <[email protected]>

perf scripts: Add configurable sorting option to powerpc-hcalls

The powerpc-hcalls.py script currently prints hypercall statistics in a fixed sort order based on the number of hcall occurrences. This patch adds a --sort option to runtime-configure the sort order (count, min, max, avg).

Quoted 4 lines
tools/perf/scripts/python/powerpc-hcalls.py +0 -0
index 8b78dc790adb1..e5b0c1bee65fb 100644

[ ... ]

Quoted 27 lines
tools/perf/scripts/python/powerpc-hcalls.py +23 -0
@@ -158,10 +159,45 @@ def hcall_table_lookup(opcode):
 
 print_ptrn = '%-28s%10s%10s%10s%10s'
 
+def sort_output(opcode):
+	stats = output[opcode]
+
+	if sort_key == 'min':
+		return stats['min']
+	if sort_key == 'max':
+		return stats['max']
+	if sort_key == 'avg':
+		return stats['time'] // stats['cnt']
+
+	return stats['cnt']
+
+def trace_begin():
+    global sort_key
+
+    i = 1
+    while i < len(sys.argv):
+        arg = sys.argv[i]
+
+        if arg == '-s' or arg == '--sort':
+            if i + 1 >= len(sys.argv):
+                print("Error: -s/--sort requires a sort key argument")
+                sys.exit(1)

tools/perf/scripts/python/powerpc-hcalls.py def hcall_table_lookup(opcode): · line 194

Quoted 10 lines
tools/perf/scripts/python/powerpc-hcalls.py +10 -0
+            sort_key = sys.argv[i + 1]
+            i += 2
+            continue
+
+        if arg.startswith('--sort='):
+            sort_key = arg.split('=', 1)[1]
+
+        i += 1
+
+    print("SORT KEY =", sort_key)

[Severity: Medium]
Will this result in silently falling back to sorting by count if an invalid sort key is provided?

If a user runs the script with an invalid sort option like --sort=latency, trace_begin() will assign it to sort_key and print "SORT KEY = latency".

Then in sort_output(), it will fall through the conditionals and return stats['cnt'], leaving the user with output sorted by count despite the printed sort key.

Could we add validation for the sort_key argument to error out if it isn't one of the expected values (count, min, max, avg)?

Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=1