xref: /third_party/mesa3d/src/gallium/auxiliary/util/u_tracepoints.py

#
# Copyright (C) 2020 Google, Inc.
#
# Permission is hereby granted, free of charge, to any person obtaining a
# copy of this software and associated documentation files (the "Software"),
# to deal in the Software without restriction, including without limitation
# the rights to use, copy, modify, merge, publish, distribute, sublicense,
# and/or sell copies of the Software, and to permit persons to whom the
# Software is furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice (including the next
# paragraph) shall be included in all copies or substantial portions of the
# Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE.
#

import argparse
import sys

#
# TODO can we do this with less boilerplate?
#
parser = argparse.ArgumentParser()
parser.add_argument('-p', '--import-path', required=True)
parser.add_argument('-C', '--src')
parser.add_argument('-H', '--hdr')
args = parser.parse_args()
sys.path.insert(0, args.import_path)


from u_trace import Header
from u_trace import Tracepoint
from u_trace import TracepointArg as Arg
from u_trace import TracepointArgStruct as ArgStruct
from u_trace import utrace_generate

#
# Tracepoint definitions:
#

Header('pipe/p_state.h')
Header('util/format/u_format.h')

Tracepoint('surface',
    args=[ArgStruct(type='const struct pipe_surface *', var='psurf')],
    tp_struct=[Arg(type='uint16_t',     name='width',      var='psurf->width',                          c_format='%u'),
               Arg(type='uint16_t',     name='height',     var='psurf->height',                         c_format='%u'),
               Arg(type='uint8_t',      name='nr_samples', var='psurf->nr_samples',                     c_format='%u'),
               Arg(type='const char *', name='format',     var='util_format_short_name(psurf->format)', c_format='%s')],
    tp_print=['%ux%u@%u, fmt=%s',
        '__entry->width',
        '__entry->height',
        '__entry->nr_samples',
        '__entry->format'],
)

# Note: called internally from trace_framebuffer_state()
Tracepoint('framebuffer',
    args=[ArgStruct(type='const struct pipe_framebuffer_state *', var='pfb')],
    tp_struct=[Arg(type='uint16_t', name='width',    var='pfb->width',    c_format='%u'),
               Arg(type='uint16_t', name='height',   var='pfb->height',   c_format='%u'),
               Arg(type='uint8_t',  name='layers',   var='pfb->layers',   c_format='%u'),
               Arg(type='uint8_t',  name='samples',  var='pfb->samples',  c_format='%u'),
               Arg(type='uint8_t',  name='nr_cbufs', var='pfb->nr_cbufs', c_format='%u')],
    tp_print=['%ux%ux%u@%u, nr_cbufs: %u',
        '__entry->width',
        '__entry->height',
        '__entry->layers',
        '__entry->samples',
        '__entry->nr_cbufs'],
)

Tracepoint('grid_info',
    args=[ArgStruct(type='const struct pipe_grid_info *', var='pgrid')],
    tp_struct=[Arg(type='uint8_t',  name='work_dim', var='pgrid->work_dim', c_format='%u'),
               Arg(type='uint16_t', name='block_x',  var='pgrid->block[0]', c_format='%u'),
               Arg(type='uint16_t', name='block_y',  var='pgrid->block[1]', c_format='%u'),
               Arg(type='uint16_t', name='block_z',  var='pgrid->block[2]', c_format='%u'),
               Arg(type='uint16_t', name='grid_x',   var='pgrid->grid[0]',  c_format='%u'),
               Arg(type='uint16_t', name='grid_y',   var='pgrid->grid[1]',  c_format='%u'),
               Arg(type='uint16_t', name='grid_z',   var='pgrid->grid[2]',  c_format='%u')],
    tp_print=['work_dim=%u, block=%ux%ux%u, grid=%ux%ux%u', '__entry->work_dim',
        '__entry->block_x', '__entry->block_y', '__entry->block_z',
        '__entry->grid_x', '__entry->grid_y', '__entry->grid_z'],
)

utrace_generate(cpath=args.src, hpath=args.hdr, ctx_param='struct pipe_context *pctx')