scripts/gdb/linux/stackdepot.py

   1 # SPDX-License-Identifier: GPL-2.0
   2 #
   3 # Copyright (c) 2023 MediaTek Inc.
   4 #
   5 # Authors:
   6 #  Kuan-Ying Lee <[email protected]>
   7 #
   8
   9 import gdb
  10 from linux import utils, constants
  11
  12 if constants.LX_CONFIG_STACKDEPOT:
  13     stack_record_type = utils.CachedType('struct stack_record')
  14     DEPOT_STACK_ALIGN = 4
  15
  16 def help():
  17     t = """Usage: lx-stack_depot_lookup [Hex handle value]
  18     Example:
  19         lx-stack_depot_lookup 0x00c80300\n"""
  20     gdb.write("Unrecognized command\n")
  21     raise gdb.GdbError(t)
  22
  23 def stack_depot_fetch(handle):
  24     global DEPOT_STACK_ALIGN
  25     global stack_record_type
  26
  27     stack_depot_disabled = gdb.parse_and_eval('stack_depot_disabled')
  28
  29     if stack_depot_disabled:
  30         raise gdb.GdbError("stack_depot_disabled\n")
  31
  32     handle_parts_t = gdb.lookup_type("union handle_parts")
  33     parts = handle.cast(handle_parts_t)
  34     offset = parts['offset'] << DEPOT_STACK_ALIGN
  35     pools_num = gdb.parse_and_eval('pools_num')
  36
  37     if handle == 0:
  38         raise gdb.GdbError("handle is 0\n")
  39
  40     pool_index = parts['pool_index_plus_1'] - 1
  41     if pool_index >= pools_num:
  42         gdb.write("pool index %d out of bounds (%d) for stack id 0x%08x\n" % (parts['pool_index'], pools_num, handle))
  43         return gdb.Value(0), 0
  44
  45     stack_pools = gdb.parse_and_eval('stack_pools')
  46
  47     try:
  48         pool = stack_pools[pool_index]
  49         stack = (pool + gdb.Value(offset).cast(utils.get_size_t_type())).cast(stack_record_type.get_type().pointer())
  50         size = int(stack['size'].cast(utils.get_ulong_type()))
  51         return stack['entries'], size
  52     except Exception as e:
  53         gdb.write("%s\n" % e)
  54         return gdb.Value(0), 0
  55
  56 def stack_depot_print(handle):
  57     if not constants.LX_CONFIG_STACKDEPOT:
  58         raise gdb.GdbError("CONFIG_STACKDEPOT is not enabled")
  59
  60     entries, nr_entries = stack_depot_fetch(handle)
  61     if nr_entries > 0:
  62         for i in range(0, nr_entries):
  63             try:
  64                 gdb.execute("x /i 0x%x" % (int(entries[i])))
  65             except Exception as e:
  66                 gdb.write("%s\n" % e)
  67
  68 class StackDepotLookup(gdb.Command):
  69     """Search backtrace by handle"""
  70
  71     def __init__(self):
  72         if constants.LX_CONFIG_STACKDEPOT:
  73             super(StackDepotLookup, self).__init__("lx-stack_depot_lookup", gdb.COMMAND_SUPPORT)
  74
  75     def invoke(self, args, from_tty):
  76         if not constants.LX_CONFIG_STACKDEPOT:
  77             raise gdb.GdbError('CONFIG_STACKDEPOT is not set')
  78
  79         argv = gdb.string_to_argv(args)
  80         if len(argv) == 1:
  81             handle = int(argv[0], 16)
  82             stack_depot_print(gdb.Value(handle).cast(utils.get_uint_type()))
  83         else:
  84             help()
  85
  86 StackDepotLookup()