1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174
|
"""
Test defining commands using the lldb command definitions
"""
import inspect
import sys
import lldb
from lldb.plugins.parsed_cmd import ParsedCommand
class ReportingCmd(ParsedCommand):
def __init__(self, debugger, unused):
super().__init__(debugger, unused)
def __call__(self, debugger, args_array, exe_ctx, result):
opt_def = self.get_options_definition()
if len(opt_def):
result.AppendMessage("Options:\n")
for long_option, elem in opt_def.items():
dest = elem["dest"]
result.AppendMessage(f"{long_option} (set: {elem['_value_set']}): {object.__getattribute__(self.ov_parser, dest)}\n")
else:
result.AppendMessage("No options\n")
num_args = args_array.GetSize()
if num_args > 0:
result.AppendMessage(f"{num_args} arguments:")
for idx in range(0,num_args):
result.AppendMessage(f"{idx}: {args_array.GetItemAtIndex(idx).GetStringValue(10000)}\n")
class NoArgsCommand(ReportingCmd):
program = "no-args"
def __init__(self, debugger, unused):
super().__init__(debugger, unused)
@classmethod
def register_lldb_command(cls, debugger, module_name):
ParsedCommand.do_register_cmd(cls, debugger, module_name)
def setup_command_definition(self):
self.ov_parser.add_option(
"b",
"bool-arg",
"a boolean arg, defaults to True",
value_type = lldb.eArgTypeBoolean,
groups = [1,2],
dest = "bool_arg",
default = True
)
self.ov_parser.add_option(
"s",
"shlib-name",
"A shared library name.",
value_type=lldb.eArgTypeShlibName,
groups = [1, [3,4]],
dest = "shlib_name",
default = None
)
self.ov_parser.add_option(
"d",
"disk-file-name",
"An on disk filename",
value_type = lldb.eArgTypeFilename,
dest = "disk_file_name",
default = None
)
self.ov_parser.add_option(
"l",
"line-num",
"A line number",
value_type = lldb.eArgTypeLineNum,
groups = 3,
dest = "line_num",
default = 0
)
self.ov_parser.add_option(
"e",
"enum-option",
"An enum, doesn't actually do anything",
enum_values = [["foo", "does foo things"],
["bar", "does bar things"],
["baz", "does baz things"]],
groups = 4,
dest = "enum_option",
default = "foo"
)
def get_short_help(self):
return "Example command for use in debugging"
def get_long_help(self):
return self.help_string
class OneArgCommandNoOptions(ReportingCmd):
program = "one-arg-no-opt"
def __init__(self, debugger, unused):
super().__init__(debugger, unused)
@classmethod
def register_lldb_command(cls, debugger, module_name):
ParsedCommand.do_register_cmd(cls, debugger, module_name)
def setup_command_definition(self):
self.ov_parser.add_argument_set([self.ov_parser.make_argument_element(lldb.eArgTypeSourceFile, "plain")])
def get_short_help(self):
return "Example command for use in debugging"
def get_long_help(self):
return self.help_string
class TwoArgGroupsCommand(ReportingCmd):
program = "two-args"
def __init__(self, debugger, unused):
super().__init__(debugger, unused)
@classmethod
def register_lldb_command(cls, debugger, module_name):
ParsedCommand.do_register_cmd(cls, debugger, module_name)
def setup_command_definition(self):
self.ov_parser.add_option(
"l",
"language",
"language defaults to None",
value_type = lldb.eArgTypeLanguage,
groups = [1,2],
dest = "language",
default = None
)
self.ov_parser.add_option(
"c",
"log-channel",
"log channel - defaults to lldb",
value_type=lldb.eArgTypeLogChannel,
groups = [1, 3],
dest = "log_channel",
default = "lldb"
)
self.ov_parser.add_option(
"p",
"process-name",
"A process name, defaults to None",
value_type = lldb.eArgTypeProcessName,
dest = "proc_name",
default = None
)
self.ov_parser.add_argument_set([self.ov_parser.make_argument_element(lldb.eArgTypeClassName, "plain", [1,2]),
self.ov_parser.make_argument_element(lldb.eArgTypeOffset, "optional", [1,2])])
self.ov_parser.add_argument_set([self.ov_parser.make_argument_element(lldb.eArgTypePythonClass, "plain", [3,4]),
self.ov_parser.make_argument_element(lldb.eArgTypePid, "optional", [3,4])])
def get_short_help(self):
return "Example command for use in debugging"
def get_long_help(self):
return self.help_string
def __lldb_init_module(debugger, dict):
# Register all classes that have a register_lldb_command method
for _name, cls in inspect.getmembers(sys.modules[__name__]):
if inspect.isclass(cls) and callable(
getattr(cls, "register_lldb_command", None)
):
cls.register_lldb_command(debugger, __name__)
|