(patrick  03-Aug-20) 

1

: #!/usr/bin/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

: from __future__ import print_function

 (patrick  03-Aug-20) 

13

: 

 (patrick  03-Aug-20) 

14

: import inspect

 (patrick  03-Aug-20) 

15

: import lldb

 (patrick  03-Aug-20) 

16

: import optparse

 (patrick  03-Aug-20) 

17

: import shlex

 (patrick  03-Aug-20) 

18

: import sys

 (patrick  03-Aug-20) 

19

: 

 (patrick  03-Aug-20) 

20

: 

 (patrick  03-Aug-20) 

21

: class FrameStatCommand:

 (patrick  03-Aug-20) 

22

:     program = 'framestats'

 (patrick  03-Aug-20) 

23

: 

 (patrick  03-Aug-20) 

24

:     @classmethod

 (patrick  03-Aug-20) 

25

:     def register_lldb_command(cls, debugger, module_name):

 (patrick  03-Aug-20) 

26

:         parser = cls.create_options()

 (patrick  03-Aug-20) 

27

:         cls.__doc__ = parser.format_help()

 (patrick  03-Aug-20) 

28

:         # Add any commands contained in this module to LLDB

 (patrick  03-Aug-20) 

29

:         command = 'command script add -c %s.%s %s' % (module_name,

 (patrick  03-Aug-20) 

30

:                                                       cls.__name__,

 (patrick  03-Aug-20) 

31

:                                                       cls.program)

 (patrick  03-Aug-20) 

32

:         debugger.HandleCommand(command)

 (patrick  03-Aug-20) 

33

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

 (patrick  03-Aug-20) 

34

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

 (patrick  03-Aug-20) 

35

: 

 (patrick  03-Aug-20) 

36

:     @classmethod

 (patrick  03-Aug-20) 

37

:     def create_options(cls):

 (patrick  03-Aug-20) 

38

: 

 (patrick  03-Aug-20) 

39

:         usage = "usage: %prog [options]"

 (patrick  03-Aug-20) 

40

:         description = ('This command is meant to be an example of how to make '

 (patrick  03-Aug-20) 

41

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

 (patrick  03-Aug-20) 

42

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

 (patrick  03-Aug-20) 

43

:                        'Specifically, this command computes the aggregate '

 (patrick  03-Aug-20) 

44

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

 (patrick  03-Aug-20) 

45

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

 (patrick  03-Aug-20) 

46

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

 (patrick  03-Aug-20) 

47

: 

 (patrick  03-Aug-20) 

48

:         # Pass add_help_option = False, since this keeps the command in line

 (patrick  03-Aug-20) 

49

:         #  with lldb commands, and we wire up "help command" to work by

 (patrick  03-Aug-20) 

50

:         # providing the long & short help methods below.

 (patrick  03-Aug-20) 

51

:         parser = optparse.OptionParser(

 (patrick  03-Aug-20) 

52

:             description=description,

 (patrick  03-Aug-20) 

53

:             prog=cls.program,

 (patrick  03-Aug-20) 

54

:             usage=usage,

 (patrick  03-Aug-20) 

55

:             add_help_option=False)

 (patrick  03-Aug-20) 

56

: 

 (patrick  03-Aug-20) 

57

:         parser.add_option(

 (patrick  03-Aug-20) 

58

:             '-i',

 (patrick  03-Aug-20) 

59

:             '--in-scope',

 (patrick  03-Aug-20) 

60

:             action='store_true',

 (patrick  03-Aug-20) 

61

:             dest='inscope',

 (patrick  03-Aug-20) 

62

:             help='in_scope_only = True',

 (patrick  03-Aug-20) 

63

:             default=True)

 (patrick  03-Aug-20) 

64

: 

 (patrick  03-Aug-20) 

65

:         parser.add_option(

 (patrick  03-Aug-20) 

66

:             '-a',

 (patrick  03-Aug-20) 

67

:             '--arguments',

 (patrick  03-Aug-20) 

68

:             action='store_true',

 (patrick  03-Aug-20) 

69

:             dest='arguments',

 (patrick  03-Aug-20) 

70

:             help='arguments = True',

 (patrick  03-Aug-20) 

71

:             default=True)

 (patrick  03-Aug-20) 

72

: 

 (patrick  03-Aug-20) 

73

:         parser.add_option(

 (patrick  03-Aug-20) 

74

:             '-l',

 (patrick  03-Aug-20) 

75

:             '--locals',

 (patrick  03-Aug-20) 

76

:             action='store_true',

 (patrick  03-Aug-20) 

77

:             dest='locals',

 (patrick  03-Aug-20) 

78

:             help='locals = True',

 (patrick  03-Aug-20) 

79

:             default=True)

 (patrick  03-Aug-20) 

80

: 

 (patrick  03-Aug-20) 

81

:         parser.add_option(

 (patrick  03-Aug-20) 

82

:             '-s',

 (patrick  03-Aug-20) 

83

:             '--statics',

 (patrick  03-Aug-20) 

84

:             action='store_true',

 (patrick  03-Aug-20) 

85

:             dest='statics',

 (patrick  03-Aug-20) 

86

:             help='statics = True',

 (patrick  03-Aug-20) 

87

:             default=True)

 (patrick  03-Aug-20) 

88

: 

 (patrick  03-Aug-20) 

89

:         return parser

 (patrick  03-Aug-20) 

90

: 

 (patrick  03-Aug-20) 

91

:     def get_short_help(self):

 (patrick  03-Aug-20) 

92

:         return "Example command for use in debugging"

 (patrick  03-Aug-20) 

93

: 

 (patrick  03-Aug-20) 

94

:     def get_long_help(self):

 (patrick  03-Aug-20) 

95

:         return self.help_string

 (patrick  03-Aug-20) 

96

: 

 (patrick  03-Aug-20) 

97

:     def __init__(self, debugger, unused):

 (patrick  03-Aug-20) 

98

:         self.parser = self.create_options()

 (patrick  03-Aug-20) 

99

:         self.help_string = self.parser.format_help()

 (patrick  03-Aug-20) 

100

: 

 (patrick  03-Aug-20) 

101

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

 (patrick  03-Aug-20) 

102

:         # Use the Shell Lexer to properly parse up command options just like a

 (patrick  03-Aug-20) 

103

:         # shell would

 (patrick  03-Aug-20) 

104

:         command_args = shlex.split(command)

 (patrick  03-Aug-20) 

105

: 

 (patrick  03-Aug-20) 

106

:         try:

 (patrick  03-Aug-20) 

107

:             (options, args) = self.parser.parse_args(command_args)

 (patrick  03-Aug-20) 

108

:         except:

 (patrick  03-Aug-20) 

109

:             # if you don't handle exceptions, passing an incorrect argument to

 (patrick  03-Aug-20) 

110

:             # the OptionParser will cause LLDB to exit (courtesy of OptParse

 (patrick  03-Aug-20) 

111

:             # dealing with argument errors by throwing SystemExit)

 (patrick  03-Aug-20) 

112

:             result.SetError("option parsing failed")

 (patrick  03-Aug-20) 

113

:             return

 (patrick  03-Aug-20) 

114

: 

 (patrick  03-Aug-20) 

115

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

 (patrick  03-Aug-20) 

116

:         # in as exe_ctx

 (patrick  03-Aug-20) 

117

:         frame = exe_ctx.GetFrame()

 (patrick  03-Aug-20) 

118

:         if not frame.IsValid():

 (patrick  03-Aug-20) 

119

:             result.SetError("invalid frame")

 (patrick  03-Aug-20) 

120

:             return

 (patrick  03-Aug-20) 

121

: 

 (patrick  03-Aug-20) 

122

:         variables_list = frame.GetVariables(

 (patrick  03-Aug-20) 

123

:             options.arguments,

 (patrick  03-Aug-20) 

124

:             options.locals,

 (patrick  03-Aug-20) 

125

:             options.statics,

 (patrick  03-Aug-20) 

126

:             options.inscope)

 (patrick  03-Aug-20) 

127

:         variables_count = variables_list.GetSize()

 (patrick  03-Aug-20) 

128

:         if variables_count == 0:

 (patrick  03-Aug-20) 

129

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

 (patrick  03-Aug-20) 

130

:             return

 (patrick  03-Aug-20) 

131

:         total_size = 0

 (patrick  03-Aug-20) 

132

:         for i in range(0, variables_count):

 (patrick  03-Aug-20) 

133

:             variable = variables_list.GetValueAtIndex(i)

 (patrick  03-Aug-20) 

134

:             variable_type = variable.GetType()

 (patrick  03-Aug-20) 

135

:             total_size = total_size + variable_type.GetByteSize()

 (patrick  03-Aug-20) 

136

:             average_size = float(total_size) / variables_count

 (patrick  03-Aug-20) 

137

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

 (patrick  03-Aug-20) 

138

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

 (patrick  03-Aug-20) 

139

:                                     variables_count, total_size, average_size), file=result)

 (patrick  03-Aug-20) 

140

:         # not returning anything is akin to returning success

 (patrick  03-Aug-20) 

141

: 

 (patrick  03-Aug-20) 

142

: 

 (patrick  03-Aug-20) 

143

: def __lldb_init_module(debugger, dict):

 (patrick  03-Aug-20) 

144

:     # Register all classes that have a register_lldb_command method

 (patrick  03-Aug-20) 

145

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

 (patrick  03-Aug-20) 

146

:         if inspect.isclass(cls) and callable(getattr(cls,

 (patrick  03-Aug-20) 

147

:                                                      "register_lldb_command",

 (patrick  03-Aug-20) 

148

:                                                      None)):

 (patrick  03-Aug-20) 

149

:             cls.register_lldb_command(debugger, __name__)