Back to home page

OSCL-LXR

 
 

    


0001 # SPDX-License-Identifier: GPL-2.0
0002 #
0003 # Copyright (c) NXP 2019
0004 
0005 import gdb
0006 
0007 from linux.utils import CachedType
0008 from linux.utils import container_of
0009 from linux.lists import list_for_each_entry
0010 
0011 
0012 device_private_type = CachedType('struct device_private')
0013 device_type = CachedType('struct device')
0014 
0015 subsys_private_type = CachedType('struct subsys_private')
0016 kobject_type = CachedType('struct kobject')
0017 kset_type = CachedType('struct kset')
0018 
0019 bus_type = CachedType('struct bus_type')
0020 class_type = CachedType('struct class')
0021 
0022 
0023 def dev_name(dev):
0024     dev_init_name = dev['init_name']
0025     if dev_init_name:
0026         return dev_init_name.string()
0027     return dev['kobj']['name'].string()
0028 
0029 
0030 def kset_for_each_object(kset):
0031     return list_for_each_entry(kset['list'],
0032             kobject_type.get_type().pointer(), "entry")
0033 
0034 
0035 def for_each_bus():
0036     for kobj in kset_for_each_object(gdb.parse_and_eval('bus_kset')):
0037         subsys = container_of(kobj, kset_type.get_type().pointer(), 'kobj')
0038         subsys_priv = container_of(subsys, subsys_private_type.get_type().pointer(), 'subsys')
0039         yield subsys_priv['bus']
0040 
0041 
0042 def for_each_class():
0043     for kobj in kset_for_each_object(gdb.parse_and_eval('class_kset')):
0044         subsys = container_of(kobj, kset_type.get_type().pointer(), 'kobj')
0045         subsys_priv = container_of(subsys, subsys_private_type.get_type().pointer(), 'subsys')
0046         yield subsys_priv['class']
0047 
0048 
0049 def get_bus_by_name(name):
0050     for item in for_each_bus():
0051         if item['name'].string() == name:
0052             return item
0053     raise gdb.GdbError("Can't find bus type {!r}".format(name))
0054 
0055 
0056 def get_class_by_name(name):
0057     for item in for_each_class():
0058         if item['name'].string() == name:
0059             return item
0060     raise gdb.GdbError("Can't find device class {!r}".format(name))
0061 
0062 
0063 klist_type = CachedType('struct klist')
0064 klist_node_type = CachedType('struct klist_node')
0065 
0066 
0067 def klist_for_each(klist):
0068     return list_for_each_entry(klist['k_list'],
0069                 klist_node_type.get_type().pointer(), 'n_node')
0070 
0071 
0072 def bus_for_each_device(bus):
0073     for kn in klist_for_each(bus['p']['klist_devices']):
0074         dp = container_of(kn, device_private_type.get_type().pointer(), 'knode_bus')
0075         yield dp['device']
0076 
0077 
0078 def class_for_each_device(cls):
0079     for kn in klist_for_each(cls['p']['klist_devices']):
0080         dp = container_of(kn, device_private_type.get_type().pointer(), 'knode_class')
0081         yield dp['device']
0082 
0083 
0084 def device_for_each_child(dev):
0085     for kn in klist_for_each(dev['p']['klist_children']):
0086         dp = container_of(kn, device_private_type.get_type().pointer(), 'knode_parent')
0087         yield dp['device']
0088 
0089 
0090 def _show_device(dev, level=0, recursive=False):
0091     gdb.write('{}dev {}:\t{}\n'.format('\t' * level, dev_name(dev), dev))
0092     if recursive:
0093         for child in device_for_each_child(dev):
0094             _show_device(child, level + 1, recursive)
0095 
0096 
0097 class LxDeviceListBus(gdb.Command):
0098     '''Print devices on a bus (or all buses if not specified)'''
0099 
0100     def __init__(self):
0101         super(LxDeviceListBus, self).__init__('lx-device-list-bus', gdb.COMMAND_DATA)
0102 
0103     def invoke(self, arg, from_tty):
0104         if not arg:
0105             for bus in for_each_bus():
0106                 gdb.write('bus {}:\t{}\n'.format(bus['name'].string(), bus))
0107                 for dev in bus_for_each_device(bus):
0108                     _show_device(dev, level=1)
0109         else:
0110             bus = get_bus_by_name(arg)
0111             if not bus:
0112                 raise gdb.GdbError("Can't find bus {!r}".format(arg))
0113             for dev in bus_for_each_device(bus):
0114                 _show_device(dev)
0115 
0116 
0117 class LxDeviceListClass(gdb.Command):
0118     '''Print devices in a class (or all classes if not specified)'''
0119 
0120     def __init__(self):
0121         super(LxDeviceListClass, self).__init__('lx-device-list-class', gdb.COMMAND_DATA)
0122 
0123     def invoke(self, arg, from_tty):
0124         if not arg:
0125             for cls in for_each_class():
0126                 gdb.write("class {}:\t{}\n".format(cls['name'].string(), cls))
0127                 for dev in class_for_each_device(cls):
0128                     _show_device(dev, level=1)
0129         else:
0130             cls = get_class_by_name(arg)
0131             for dev in class_for_each_device(cls):
0132                 _show_device(dev)
0133 
0134 
0135 class LxDeviceListTree(gdb.Command):
0136     '''Print a device and its children recursively'''
0137 
0138     def __init__(self):
0139         super(LxDeviceListTree, self).__init__('lx-device-list-tree', gdb.COMMAND_DATA)
0140 
0141     def invoke(self, arg, from_tty):
0142         if not arg:
0143             raise gdb.GdbError('Please provide pointer to struct device')
0144         dev = gdb.parse_and_eval(arg)
0145         if dev.type != device_type.get_type().pointer():
0146             raise gdb.GdbError('Please provide pointer to struct device')
0147         _show_device(dev, level=0, recursive=True)
0148 
0149 
0150 class LxDeviceFindByBusName(gdb.Function):
0151     '''Find struct device by bus and name (both strings)'''
0152 
0153     def __init__(self):
0154         super(LxDeviceFindByBusName, self).__init__('lx_device_find_by_bus_name')
0155 
0156     def invoke(self, bus, name):
0157         name = name.string()
0158         bus = get_bus_by_name(bus.string())
0159         for dev in bus_for_each_device(bus):
0160             if dev_name(dev) == name:
0161                 return dev
0162 
0163 
0164 class LxDeviceFindByClassName(gdb.Function):
0165     '''Find struct device by class and name (both strings)'''
0166 
0167     def __init__(self):
0168         super(LxDeviceFindByClassName, self).__init__('lx_device_find_by_class_name')
0169 
0170     def invoke(self, cls, name):
0171         name = name.string()
0172         cls = get_class_by_name(cls.string())
0173         for dev in class_for_each_device(cls):
0174             if dev_name(dev) == name:
0175                 return dev
0176 
0177 
0178 LxDeviceListBus()
0179 LxDeviceListClass()
0180 LxDeviceListTree()
0181 LxDeviceFindByBusName()
0182 LxDeviceFindByClassName()