(patrick  17-Dec-21) 

1

: #!/usr/bin/env python

 (patrick  03-Aug-20) 

2

: 

 (patrick  03-Aug-20) 

3

: # ---------------------------------------------------------------------

 (patrick  03-Aug-20) 

4

: # Be sure to add the python path that points to the LLDB shared library.

 (patrick  03-Aug-20) 

5

: #

 (patrick  03-Aug-20) 

6

: # # To use this in the embedded python interpreter using "lldb" just

 (patrick  03-Aug-20) 

7

: # import it with the full path using the "command script import"

 (patrick  03-Aug-20) 

8

: # command

 (patrick  03-Aug-20) 

9

: #   (lldb) command script import /path/to/cmdtemplate.py

 (patrick  03-Aug-20) 

10

: # ---------------------------------------------------------------------

 (patrick  03-Aug-20) 

11

: 

 (patrick  03-Aug-20) 

12

: import inspect

 (patrick  03-Aug-20) 

13

: import lldb

 (patrick  03-Aug-20) 

14

: import sys

 (robert   11-Jun-25) 

15

: from lldb.plugins.parsed_cmd import ParsedCommand

 (patrick  03-Aug-20) 

16

: 

 (robert   11-Jun-25) 

17

: class FrameStatCommand(ParsedCommand):

 (robert   11-Jun-25) 

18

:     program = "framestats"

 (patrick  03-Aug-20) 

19

: 

 (patrick  03-Aug-20) 

20

:     @classmethod

 (patrick  03-Aug-20) 

21

:     def register_lldb_command(cls, debugger, module_name):

 (robert   11-Jun-25) 

22

:         ParsedCommand.do_register_cmd(cls, debugger, module_name)

 (robert   11-Jun-25) 

23

:         print(

 (robert   11-Jun-25) 

24

:             'The "{0}" command has been installed, type "help {0}" or "{0} '

 (robert   11-Jun-25) 

25

:             '--help" for detailed help.'.format(cls.program)

 (robert   11-Jun-25) 

26

:         )

 (robert   11-Jun-25) 

27

: 

 (robert   29-May-26) 

28

:     def get_flags(self):

 (robert   29-May-26) 

29

:         return lldb.eCommandRequiresFrame | lldb.eCommandProcessMustBePaused

 (robert   11-Jun-25) 

30

: 

 (robert   29-May-26) 

31

:     def setup_command_definition(self):

 (robert   29-May-26) 

32

:         ov_parser = self.get_parser()

 (robert   29-May-26) 

33

:         ov_parser.add_option(

 (robert   11-Jun-25) 

34

:             "i",

 (robert   11-Jun-25) 

35

:             "in-scope",

 (robert   11-Jun-25) 

36

:             help = "in_scope_only = True",

 (robert   11-Jun-25) 

37

:             value_type = lldb.eArgTypeBoolean,

 (robert   11-Jun-25) 

38

:             dest = "bool_arg",

 (robert   11-Jun-25) 

39

:             default = True,

 (robert   11-Jun-25) 

40

:         )

 (robert   11-Jun-25) 

41

: 

 (robert   29-May-26) 

42

:         ov_parser.add_option(

 (robert   11-Jun-25) 

43

:             "i",

 (robert   11-Jun-25) 

44

:             "in-scope",

 (robert   11-Jun-25) 

45

:             help = "in_scope_only = True",

 (robert   11-Jun-25) 

46

:             value_type = lldb.eArgTypeBoolean,

 (robert   11-Jun-25) 

47

:             dest = "inscope",

 (robert   11-Jun-25) 

48

:             default=True,

 (robert   11-Jun-25) 

49

:         )

 (robert   11-Jun-25) 

50

:         

 (robert   29-May-26) 

51

:         ov_parser.add_option(

 (robert   11-Jun-25) 

52

:             "a",

 (robert   11-Jun-25) 

53

:             "arguments",

 (robert   11-Jun-25) 

54

:             help = "arguments = True",

 (robert   11-Jun-25) 

55

:             value_type = lldb.eArgTypeBoolean,

 (robert   11-Jun-25) 

56

:             dest = "arguments",

 (robert   11-Jun-25) 

57

:             default = True,

 (robert   11-Jun-25) 

58

:         )

 (robert   11-Jun-25) 

59

: 

 (robert   29-May-26) 

60

:         ov_parser.add_option(

 (robert   11-Jun-25) 

61

:             "l",

 (robert   11-Jun-25) 

62

:             "locals",

 (robert   11-Jun-25) 

63

:             help = "locals = True",

 (robert   11-Jun-25) 

64

:             value_type = lldb.eArgTypeBoolean,

 (robert   11-Jun-25) 

65

:             dest = "locals",

 (robert   11-Jun-25) 

66

:             default = True,

 (robert   11-Jun-25) 

67

:         )

 (robert   11-Jun-25) 

68

: 

 (robert   29-May-26) 

69

:         ov_parser.add_option(

 (robert   11-Jun-25) 

70

:             "s",

 (robert   11-Jun-25) 

71

:             "statics",

 (robert   11-Jun-25) 

72

:             help = "statics = True",

 (robert   11-Jun-25) 

73

:             value_type = lldb.eArgTypeBoolean,

 (robert   11-Jun-25) 

74

:             dest = "statics",

 (robert   11-Jun-25) 

75

:             default = True,

 (robert   11-Jun-25) 

76

:         )

 (robert   29-May-26) 

77

:         ov_parser.add_option(

 (robert   29-May-26) 

78

:             "t",

 (robert   29-May-26) 

79

:             "test-flag",

 (robert   29-May-26) 

80

:             help="test a flag value.",

 (robert   29-May-26) 

81

:         )

 (robert   11-Jun-25) 

82

: 

 (robert   11-Jun-25) 

83

:     def get_repeat_command(self, args):

 (robert   11-Jun-25) 

84

:         """As an example, make the command not auto-repeat:"""

 (robert   11-Jun-25) 

85

:         return ""

 (patrick  03-Aug-20) 

86

: 

 (patrick  03-Aug-20) 

87

:     def get_short_help(self):

 (patrick  03-Aug-20) 

88

:         return "Example command for use in debugging"

 (patrick  03-Aug-20) 

89

: 

 (patrick  03-Aug-20) 

90

:     def get_long_help(self):

 (robert   11-Jun-25) 

91

:         return ("This command is meant to be an example of how to make "

 (robert   11-Jun-25) 

92

:             "an LLDB command that does something useful, follows "

 (robert   11-Jun-25) 

93

:             "best practices, and exploits the SB API. "

 (robert   11-Jun-25) 

94

:             "Specifically, this command computes the aggregate "

 (robert   11-Jun-25) 

95

:             "and average size of the variables in the current "

 (robert   11-Jun-25) 

96

:             "frame and allows you to tweak exactly which variables "

 (robert   11-Jun-25) 

97

:             "are to be accounted in the computation.")

 (robert   11-Jun-25) 

98

: 

 (patrick  03-Aug-20) 

99

: 

 (patrick  03-Aug-20) 

100

:     def __init__(self, debugger, unused):

 (robert   11-Jun-25) 

101

:         super().__init__(debugger, unused)

 (patrick  03-Aug-20) 

102

: 

 (patrick  03-Aug-20) 

103

:     def __call__(self, debugger, command, exe_ctx, result):

 (patrick  03-Aug-20) 

104

:         # Always get program state from the lldb.SBExecutionContext passed

 (patrick  03-Aug-20) 

105

:         # in as exe_ctx

 (patrick  03-Aug-20) 

106

:         frame = exe_ctx.GetFrame()

 (patrick  03-Aug-20) 

107

:         if not frame.IsValid():

 (patrick  03-Aug-20) 

108

:             result.SetError("invalid frame")

 (patrick  03-Aug-20) 

109

:             return

 (patrick  03-Aug-20) 

110

: 

 (robert   29-May-26) 

111

:         ov_parser = self.get_parser()

 (patrick  03-Aug-20) 

112

:         variables_list = frame.GetVariables(

 (robert   29-May-26) 

113

:             ov_parser.arguments, ov_parser.locals, ov_parser.statics, ov_parser.inscope

 (robert   11-Jun-25) 

114

:         )

 (patrick  03-Aug-20) 

115

:         variables_count = variables_list.GetSize()

 (patrick  03-Aug-20) 

116

:         if variables_count == 0:

 (patrick  03-Aug-20) 

117

:             print("no variables here", file=result)

 (patrick  03-Aug-20) 

118

:             return

 (patrick  03-Aug-20) 

119

:         total_size = 0

 (patrick  03-Aug-20) 

120

:         for i in range(0, variables_count):

 (patrick  03-Aug-20) 

121

:             variable = variables_list.GetValueAtIndex(i)

 (patrick  03-Aug-20) 

122

:             variable_type = variable.GetType()

 (patrick  03-Aug-20) 

123

:             total_size = total_size + variable_type.GetByteSize()

 (patrick  03-Aug-20) 

124

:             average_size = float(total_size) / variables_count

 (robert   11-Jun-25) 

125

:             print(

 (robert   11-Jun-25) 

126

:                 "Your frame has %d variables. Their total size "

 (robert   11-Jun-25) 

127

:                 "is %d bytes. The average size is %f bytes"

 (robert   11-Jun-25) 

128

:                 % (variables_count, total_size, average_size),

 (robert   11-Jun-25) 

129

:                 file=result,

 (robert   11-Jun-25) 

130

:             )

 (robert   29-May-26) 

131

:         if ov_parser.was_set("test-flag"):

 (robert   29-May-26) 

132

:             print("Got the test flag")

 (robert   29-May-26) 

133

:         else:

 (robert   29-May-26) 

134

:             print("Got no test flag")

 (robert   29-May-26) 

135

: 

 (patrick  03-Aug-20) 

136

:         # not returning anything is akin to returning success

 (patrick  03-Aug-20) 

137

: 

 (patrick  03-Aug-20) 

138

: 

 (patrick  03-Aug-20) 

139

: def __lldb_init_module(debugger, dict):

 (patrick  03-Aug-20) 

140

:     # Register all classes that have a register_lldb_command method

 (patrick  03-Aug-20) 

141

:     for _name, cls in inspect.getmembers(sys.modules[__name__]):

 (robert   11-Jun-25) 

142

:         if inspect.isclass(cls) and callable(

 (robert   11-Jun-25) 

143

:             getattr(cls, "register_lldb_command", None)

 (robert   11-Jun-25) 

144

:         ):

 (patrick  03-Aug-20) 

145

:             cls.register_lldb_command(debugger, __name__)