1#
2# Copyright (C) 2020 Google, Inc.
3#
4# Permission is hereby granted, free of charge, to any person obtaining a
5# copy of this software and associated documentation files (the "Software"),
6# to deal in the Software without restriction, including without limitation
7# the rights to use, copy, modify, merge, publish, distribute, sublicense,
8# and/or sell copies of the Software, and to permit persons to whom the
9# Software is furnished to do so, subject to the following conditions:
10#
11# The above copyright notice and this permission notice (including the next
12# paragraph) shall be included in all copies or substantial portions of the
13# Software.
14#
15# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
18# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21# IN THE SOFTWARE.
22#
23
24import argparse
25import sys
26
27#
28# TODO can we do this with less boilerplate?
29#
30parser = argparse.ArgumentParser()
31parser.add_argument('-p', '--import-path', required=True)
32parser.add_argument('-C', '--src', required=True)
33parser.add_argument('-H', '--hdr', required=True)
34args = parser.parse_args()
35sys.path.insert(0, args.import_path)
36
37
38from u_trace import Header
39from u_trace import Tracepoint
40from u_trace import TracepointArg
41from u_trace import utrace_generate
42
43# List of the default tracepoints enabled. By default tracepoints are enabled,
44# set tp_default_enabled=False to disable them by default.
45fd_default_tps = []
46
47#
48# Tracepoint definitions:
49#
50
51Header('util/u_dump.h')
52Header('freedreno_batch.h')
53
54
55def begin_end_tp(name, args=[], tp_struct=None, tp_print=None,
56                 tp_default_enabled=True):
57    global fd_default_tps
58    if tp_default_enabled:
59        fd_default_tps.append(name)
60    Tracepoint('start_{0}'.format(name),
61               toggle_name=name,
62               args=args,
63               tp_struct=tp_struct,
64               tp_perfetto='fd_start_{0}'.format(name),
65               tp_print=tp_print)
66    Tracepoint('end_{0}'.format(name),
67               toggle_name=name,
68               tp_perfetto='fd_end_{0}'.format(name))
69
70
71def singular_tp(name, args=[], tp_struct=None, tp_print=None,
72                tp_default_enabled=True):
73    global fd_default_tps
74    if tp_default_enabled:
75        fd_default_tps.append(name)
76    Tracepoint(name,
77               toggle_name=name,
78               args=args,
79               tp_struct=tp_struct,
80               tp_print=tp_print)
81
82begin_end_tp('state_restore')
83
84singular_tp('flush_batch',
85    args=[TracepointArg(type='struct fd_batch *', var='batch',       c_format='%x'),
86          TracepointArg(type='uint16_t',          var='cleared',     c_format='%x'),
87          TracepointArg(type='uint16_t',          var='gmem_reason', c_format='%x'),
88          TracepointArg(type='uint16_t',          var='num_draws',   c_format='%u')],
89    tp_print=['%p: cleared=%x, gmem_reason=%x, num_draws=%u', '__entry->batch',
90        '__entry->cleared', '__entry->gmem_reason', '__entry->num_draws'],
91)
92
93singular_tp('render_gmem',
94    args=[TracepointArg(type='uint16_t', var='nbins_x', c_format='%u'),
95          TracepointArg(type='uint16_t', var='nbins_y', c_format='%u'),
96          TracepointArg(type='uint16_t', var='bin_w',   c_format='%u'),
97          TracepointArg(type='uint16_t', var='bin_h',   c_format='%u')],
98    tp_print=['%ux%u bins of %ux%u',
99        '__entry->nbins_x', '__entry->nbins_y', '__entry->bin_w', '__entry->bin_h'],
100)
101
102singular_tp('render_sysmem')
103
104# Note that this doesn't include full information about all of the MRTs
105# but seems to roughly match what I see with a blob trace
106begin_end_tp('render_pass',
107    args=[TracepointArg(type='uint32_t',         var='submit_id',     c_format='%u'),
108          TracepointArg(type='enum pipe_format', var='cbuf0_format',  c_format='%s', to_prim_type='util_format_description({})->short_name'),
109          TracepointArg(type='enum pipe_format', var='zs_format',     c_format='%s', to_prim_type='util_format_description({})->short_name'),
110          TracepointArg(type='uint16_t',         var='width',         c_format='%u'),
111          TracepointArg(type='uint16_t',         var='height',        c_format='%u'),
112          TracepointArg(type='uint8_t',          var='mrts',          c_format='%u'),
113          TracepointArg(type='uint8_t',          var='samples',       c_format='%u'),
114          TracepointArg(type='uint16_t',         var='nbins',         c_format='%u'),
115          TracepointArg(type='uint16_t',         var='binw',          c_format='%u'),
116          TracepointArg(type='uint16_t',         var='binh',          c_format='%u')],
117)
118
119begin_end_tp('binning_ib')
120begin_end_tp('vsc_overflow_test')
121begin_end_tp('prologue')
122
123# For GMEM pass, where this could either be a clear or resolve
124begin_end_tp('clear_restore',
125    args=[TracepointArg(type='uint16_t', var='fast_cleared', c_format='0x%x')],
126    tp_print=['fast_cleared: 0x%x', '__entry->fast_cleared'],
127)
128
129begin_end_tp('resolve')
130
131singular_tp('start_tile',
132    args=[TracepointArg(type='uint16_t', var='bin_h', c_format='%u'),
133          TracepointArg(type='uint16_t', var='yoff',  c_format='%u'),
134          TracepointArg(type='uint16_t', var='bin_w', c_format='%u'),
135          TracepointArg(type='uint16_t', var='xoff',  c_format='%u')],
136    tp_print=['bin_h=%d, yoff=%d, bin_w=%d, xoff=%d',
137        '__entry->bin_h', '__entry->yoff', '__entry->bin_w', '__entry->xoff'],
138)
139
140begin_end_tp('draw_ib')
141
142begin_end_tp('blit',
143    args=[TracepointArg(type='enum pipe_texture_target', var='src_target', c_format='%s', to_prim_type="util_str_tex_target({}, true)"),
144          TracepointArg(type='enum pipe_texture_target', var='dst_target', c_format='%s', to_prim_type="util_str_tex_target({}, true)")],
145    tp_print=['%s -> %s', 'util_str_tex_target(__entry->src_target, true)',
146        'util_str_tex_target(__entry->dst_target, true)'],
147)
148
149begin_end_tp('compute')
150
151utrace_generate(cpath=args.src,
152                hpath=args.hdr,
153                ctx_param='struct pipe_context *pctx',
154                trace_toggle_name='fd_gpu_tracepoint',
155                trace_toggle_defaults=fd_default_tps)
156