1# stackcollapse.py - format perf samples with one line per distinct call stack
2# SPDX-License-Identifier: GPL-2.0
3#
4# This script's output has two space-separated fields.  The first is a semicolon
5# separated stack including the program name (from the "comm" field) and the
6# function names from the call stack.  The second is a count:
7#
8#  swapper;start_kernel;rest_init;cpu_idle;default_idle;native_safe_halt 2
9#
10# The file is sorted according to the first field.
11#
12# Input may be created and processed using:
13#
14#  perf record -a -g -F 99 sleep 60
15#  perf script report stackcollapse > out.stacks-folded
16#
17# (perf script record stackcollapse works too).
18#
19# Written by Paolo Bonzini <pbonzini@redhat.com>
20# Based on Brendan Gregg's stackcollapse-perf.pl script.
21
22import os
23import sys
24from collections import defaultdict
25from optparse import OptionParser, make_option
26
27sys.path.append(os.environ['PERF_EXEC_PATH'] + \
28                '/scripts/python/Perf-Trace-Util/lib/Perf/Trace')
29
30from perf_trace_context import *
31from Core import *
32from EventClass import *
33
34# command line parsing
35
36option_list = [
37    # formatting options for the bottom entry of the stack
38    make_option("--include-tid", dest="include_tid",
39                 action="store_true", default=False,
40                 help="include thread id in stack"),
41    make_option("--include-pid", dest="include_pid",
42                 action="store_true", default=False,
43                 help="include process id in stack"),
44    make_option("--no-comm", dest="include_comm",
45                 action="store_false", default=True,
46                 help="do not separate stacks according to comm"),
47    make_option("--tidy-java", dest="tidy_java",
48                 action="store_true", default=False,
49                 help="beautify Java signatures"),
50    make_option("--kernel", dest="annotate_kernel",
51                 action="store_true", default=False,
52                 help="annotate kernel functions with _[k]")
53]
54
55parser = OptionParser(option_list=option_list)
56(opts, args) = parser.parse_args()
57
58if len(args) != 0:
59    parser.error("unexpected command line argument")
60if opts.include_tid and not opts.include_comm:
61    parser.error("requesting tid but not comm is invalid")
62if opts.include_pid and not opts.include_comm:
63    parser.error("requesting pid but not comm is invalid")
64
65# event handlers
66
67lines = defaultdict(lambda: 0)
68
69def process_event(param_dict):
70    def tidy_function_name(sym, dso):
71        if sym is None:
72            sym = '[unknown]'
73
74        sym = sym.replace(';', ':')
75        if opts.tidy_java:
76            # the original stackcollapse-perf.pl script gives the
77            # example of converting this:
78            #    Lorg/mozilla/javascript/MemberBox;.<init>(Ljava/lang/reflect/Method;)V
79            # to this:
80            #    org/mozilla/javascript/MemberBox:.init
81            sym = sym.replace('<', '')
82            sym = sym.replace('>', '')
83            if sym[0] == 'L' and sym.find('/'):
84                sym = sym[1:]
85            try:
86                sym = sym[:sym.index('(')]
87            except ValueError:
88                pass
89
90        if opts.annotate_kernel and dso == '[kernel.kallsyms]':
91            return sym + '_[k]'
92        else:
93            return sym
94
95    stack = list()
96    if 'callchain' in param_dict:
97        for entry in param_dict['callchain']:
98            entry.setdefault('sym', dict())
99            entry['sym'].setdefault('name', None)
100            entry.setdefault('dso', None)
101            stack.append(tidy_function_name(entry['sym']['name'],
102                                            entry['dso']))
103    else:
104        param_dict.setdefault('symbol', None)
105        param_dict.setdefault('dso', None)
106        stack.append(tidy_function_name(param_dict['symbol'],
107                                        param_dict['dso']))
108
109    if opts.include_comm:
110        comm = param_dict["comm"].replace(' ', '_')
111        sep = "-"
112        if opts.include_pid:
113            comm = comm + sep + str(param_dict['sample']['pid'])
114            sep = "/"
115        if opts.include_tid:
116            comm = comm + sep + str(param_dict['sample']['tid'])
117        stack.append(comm)
118
119    stack_string = ';'.join(reversed(stack))
120    lines[stack_string] = lines[stack_string] + 1
121
122def trace_end():
123    list = lines.keys()
124    list.sort()
125    for stack in list:
126        print "%s %d" % (stack, lines[stack])
127