Johnny Chen | 1605cf6 | 2010-09-08 22:54:46 +0000 | [diff] [blame] | 1 | """ |
Johnny Chen | b51d87d | 2010-10-07 21:38:28 +0000 | [diff] [blame] | 2 | This LLDB module contains miscellaneous utilities. |
Johnny Chen | 1605cf6 | 2010-09-08 22:54:46 +0000 | [diff] [blame] | 3 | """ |
| 4 | |
| 5 | import lldb |
Johnny Chen | 30425e9 | 2010-10-07 18:52:48 +0000 | [diff] [blame] | 6 | import sys |
Johnny Chen | ed5f04e | 2010-10-15 23:33:18 +0000 | [diff] [blame] | 7 | import StringIO |
Johnny Chen | 1605cf6 | 2010-09-08 22:54:46 +0000 | [diff] [blame] | 8 | |
Johnny Chen | 168a61a | 2010-10-22 21:31:03 +0000 | [diff] [blame^] | 9 | # =========================================== |
| 10 | # Iterator for lldb aggregate data structures |
| 11 | # =========================================== |
Johnny Chen | 84a6d6f | 2010-10-15 01:18:29 +0000 | [diff] [blame] | 12 | |
Johnny Chen | 4d72c74 | 2010-10-10 20:25:10 +0000 | [diff] [blame] | 13 | def lldb_iter(obj, getsize, getelem): |
Johnny Chen | 164bf88 | 2010-10-09 01:31:09 +0000 | [diff] [blame] | 14 | """ |
| 15 | A generator adaptor for lldb aggregate data structures. |
| 16 | |
Johnny Chen | 4d72c74 | 2010-10-10 20:25:10 +0000 | [diff] [blame] | 17 | API clients pass in the aggregate object, the name of the method to get the |
| 18 | size of the object, and the name of the method to get the element given an |
| 19 | index. |
Johnny Chen | 164bf88 | 2010-10-09 01:31:09 +0000 | [diff] [blame] | 20 | |
| 21 | Example usage: |
| 22 | |
| 23 | def disassemble_instructions (insts): |
Johnny Chen | 4d72c74 | 2010-10-10 20:25:10 +0000 | [diff] [blame] | 24 | from lldbutil import lldb_iter |
| 25 | for i in lldb_iter(insts, 'GetSize', 'GetInstructionAtIndex'): |
Johnny Chen | 164bf88 | 2010-10-09 01:31:09 +0000 | [diff] [blame] | 26 | print i |
| 27 | """ |
Johnny Chen | 4d72c74 | 2010-10-10 20:25:10 +0000 | [diff] [blame] | 28 | size = getattr(obj, getsize) |
| 29 | elem = getattr(obj, getelem) |
| 30 | for i in range(size()): |
| 31 | yield elem(i) |
Johnny Chen | 164bf88 | 2010-10-09 01:31:09 +0000 | [diff] [blame] | 32 | |
| 33 | |
Johnny Chen | 168a61a | 2010-10-22 21:31:03 +0000 | [diff] [blame^] | 34 | # ================================================= |
| 35 | # Convert some enum value to its string counterpart |
| 36 | # ================================================= |
Johnny Chen | be683bc | 2010-10-07 22:15:58 +0000 | [diff] [blame] | 37 | |
| 38 | def StateTypeString(enum): |
| 39 | """Returns the stateType string given an enum.""" |
| 40 | if enum == lldb.eStateInvalid: |
Johnny Chen | 59b8477 | 2010-10-18 15:46:54 +0000 | [diff] [blame] | 41 | return "invalid" |
Johnny Chen | be683bc | 2010-10-07 22:15:58 +0000 | [diff] [blame] | 42 | elif enum == lldb.eStateUnloaded: |
Johnny Chen | 59b8477 | 2010-10-18 15:46:54 +0000 | [diff] [blame] | 43 | return "unloaded" |
Johnny Chen | be683bc | 2010-10-07 22:15:58 +0000 | [diff] [blame] | 44 | elif enum == lldb.eStateAttaching: |
Johnny Chen | 59b8477 | 2010-10-18 15:46:54 +0000 | [diff] [blame] | 45 | return "attaching" |
Johnny Chen | be683bc | 2010-10-07 22:15:58 +0000 | [diff] [blame] | 46 | elif enum == lldb.eStateLaunching: |
Johnny Chen | 59b8477 | 2010-10-18 15:46:54 +0000 | [diff] [blame] | 47 | return "launching" |
Johnny Chen | be683bc | 2010-10-07 22:15:58 +0000 | [diff] [blame] | 48 | elif enum == lldb.eStateStopped: |
Johnny Chen | 59b8477 | 2010-10-18 15:46:54 +0000 | [diff] [blame] | 49 | return "stopped" |
Johnny Chen | be683bc | 2010-10-07 22:15:58 +0000 | [diff] [blame] | 50 | elif enum == lldb.eStateRunning: |
Johnny Chen | 59b8477 | 2010-10-18 15:46:54 +0000 | [diff] [blame] | 51 | return "running" |
Johnny Chen | be683bc | 2010-10-07 22:15:58 +0000 | [diff] [blame] | 52 | elif enum == lldb.eStateStepping: |
Johnny Chen | 59b8477 | 2010-10-18 15:46:54 +0000 | [diff] [blame] | 53 | return "stepping" |
Johnny Chen | be683bc | 2010-10-07 22:15:58 +0000 | [diff] [blame] | 54 | elif enum == lldb.eStateCrashed: |
Johnny Chen | 59b8477 | 2010-10-18 15:46:54 +0000 | [diff] [blame] | 55 | return "crashed" |
Johnny Chen | be683bc | 2010-10-07 22:15:58 +0000 | [diff] [blame] | 56 | elif enum == lldb.eStateDetached: |
Johnny Chen | 59b8477 | 2010-10-18 15:46:54 +0000 | [diff] [blame] | 57 | return "detached" |
Johnny Chen | be683bc | 2010-10-07 22:15:58 +0000 | [diff] [blame] | 58 | elif enum == lldb.eStateExited: |
Johnny Chen | 59b8477 | 2010-10-18 15:46:54 +0000 | [diff] [blame] | 59 | return "exited" |
Johnny Chen | be683bc | 2010-10-07 22:15:58 +0000 | [diff] [blame] | 60 | elif enum == lldb.eStateSuspended: |
Johnny Chen | 59b8477 | 2010-10-18 15:46:54 +0000 | [diff] [blame] | 61 | return "suspended" |
Johnny Chen | be683bc | 2010-10-07 22:15:58 +0000 | [diff] [blame] | 62 | else: |
| 63 | raise Exception("Unknown stopReason enum") |
| 64 | |
| 65 | def StopReasonString(enum): |
| 66 | """Returns the stopReason string given an enum.""" |
| 67 | if enum == lldb.eStopReasonInvalid: |
Johnny Chen | 59b8477 | 2010-10-18 15:46:54 +0000 | [diff] [blame] | 68 | return "invalid" |
Johnny Chen | be683bc | 2010-10-07 22:15:58 +0000 | [diff] [blame] | 69 | elif enum == lldb.eStopReasonNone: |
Johnny Chen | 59b8477 | 2010-10-18 15:46:54 +0000 | [diff] [blame] | 70 | return "none" |
Johnny Chen | be683bc | 2010-10-07 22:15:58 +0000 | [diff] [blame] | 71 | elif enum == lldb.eStopReasonTrace: |
Johnny Chen | 59b8477 | 2010-10-18 15:46:54 +0000 | [diff] [blame] | 72 | return "trace" |
Johnny Chen | be683bc | 2010-10-07 22:15:58 +0000 | [diff] [blame] | 73 | elif enum == lldb.eStopReasonBreakpoint: |
Johnny Chen | 59b8477 | 2010-10-18 15:46:54 +0000 | [diff] [blame] | 74 | return "breakpoint" |
Johnny Chen | be683bc | 2010-10-07 22:15:58 +0000 | [diff] [blame] | 75 | elif enum == lldb.eStopReasonWatchpoint: |
Johnny Chen | 59b8477 | 2010-10-18 15:46:54 +0000 | [diff] [blame] | 76 | return "watchpoint" |
Johnny Chen | be683bc | 2010-10-07 22:15:58 +0000 | [diff] [blame] | 77 | elif enum == lldb.eStopReasonSignal: |
Johnny Chen | 59b8477 | 2010-10-18 15:46:54 +0000 | [diff] [blame] | 78 | return "signal" |
Johnny Chen | be683bc | 2010-10-07 22:15:58 +0000 | [diff] [blame] | 79 | elif enum == lldb.eStopReasonException: |
Johnny Chen | 59b8477 | 2010-10-18 15:46:54 +0000 | [diff] [blame] | 80 | return "exception" |
Johnny Chen | be683bc | 2010-10-07 22:15:58 +0000 | [diff] [blame] | 81 | elif enum == lldb.eStopReasonPlanComplete: |
Johnny Chen | 59b8477 | 2010-10-18 15:46:54 +0000 | [diff] [blame] | 82 | return "plancomplete" |
Johnny Chen | be683bc | 2010-10-07 22:15:58 +0000 | [diff] [blame] | 83 | else: |
| 84 | raise Exception("Unknown stopReason enum") |
| 85 | |
| 86 | |
Johnny Chen | 168a61a | 2010-10-22 21:31:03 +0000 | [diff] [blame^] | 87 | # ================================================== |
| 88 | # Utility functions related to Threads and Processes |
| 89 | # ================================================== |
Johnny Chen | be683bc | 2010-10-07 22:15:58 +0000 | [diff] [blame] | 90 | |
Johnny Chen | 1605cf6 | 2010-09-08 22:54:46 +0000 | [diff] [blame] | 91 | def GetFunctionNames(thread): |
| 92 | """ |
| 93 | Returns a sequence of function names from the stack frames of this thread. |
| 94 | """ |
| 95 | def GetFuncName(i): |
| 96 | return thread.GetFrameAtIndex(i).GetFunction().GetName() |
| 97 | |
| 98 | return map(GetFuncName, range(thread.GetNumFrames())) |
| 99 | |
| 100 | |
Johnny Chen | b51d87d | 2010-10-07 21:38:28 +0000 | [diff] [blame] | 101 | def GetSymbolNames(thread): |
| 102 | """ |
| 103 | Returns a sequence of symbols for this thread. |
| 104 | """ |
| 105 | def GetSymbol(i): |
| 106 | return thread.GetFrameAtIndex(i).GetSymbol().GetName() |
| 107 | |
| 108 | return map(GetSymbol, range(thread.GetNumFrames())) |
| 109 | |
| 110 | |
| 111 | def GetPCAddresses(thread): |
| 112 | """ |
| 113 | Returns a sequence of pc addresses for this thread. |
| 114 | """ |
| 115 | def GetPCAddress(i): |
| 116 | return thread.GetFrameAtIndex(i).GetPCAddress() |
| 117 | |
| 118 | return map(GetPCAddress, range(thread.GetNumFrames())) |
| 119 | |
| 120 | |
Johnny Chen | 1605cf6 | 2010-09-08 22:54:46 +0000 | [diff] [blame] | 121 | def GetFilenames(thread): |
| 122 | """ |
| 123 | Returns a sequence of file names from the stack frames of this thread. |
| 124 | """ |
| 125 | def GetFilename(i): |
| 126 | return thread.GetFrameAtIndex(i).GetLineEntry().GetFileSpec().GetFilename() |
| 127 | |
| 128 | return map(GetFilename, range(thread.GetNumFrames())) |
| 129 | |
| 130 | |
| 131 | def GetLineNumbers(thread): |
| 132 | """ |
| 133 | Returns a sequence of line numbers from the stack frames of this thread. |
| 134 | """ |
| 135 | def GetLineNumber(i): |
| 136 | return thread.GetFrameAtIndex(i).GetLineEntry().GetLine() |
| 137 | |
| 138 | return map(GetLineNumber, range(thread.GetNumFrames())) |
| 139 | |
| 140 | |
| 141 | def GetModuleNames(thread): |
| 142 | """ |
| 143 | Returns a sequence of module names from the stack frames of this thread. |
| 144 | """ |
| 145 | def GetModuleName(i): |
| 146 | return thread.GetFrameAtIndex(i).GetModule().GetFileSpec().GetFilename() |
| 147 | |
| 148 | return map(GetModuleName, range(thread.GetNumFrames())) |
| 149 | |
| 150 | |
Johnny Chen | 88866ac | 2010-09-09 00:55:07 +0000 | [diff] [blame] | 151 | def GetStackFrames(thread): |
| 152 | """ |
| 153 | Returns a sequence of stack frames for this thread. |
| 154 | """ |
| 155 | def GetStackFrame(i): |
| 156 | return thread.GetFrameAtIndex(i) |
| 157 | |
| 158 | return map(GetStackFrame, range(thread.GetNumFrames())) |
| 159 | |
| 160 | |
Johnny Chen | 30425e9 | 2010-10-07 18:52:48 +0000 | [diff] [blame] | 161 | def PrintStackTrace(thread, string_buffer = False): |
Johnny Chen | 1605cf6 | 2010-09-08 22:54:46 +0000 | [diff] [blame] | 162 | """Prints a simple stack trace of this thread.""" |
Johnny Chen | 30425e9 | 2010-10-07 18:52:48 +0000 | [diff] [blame] | 163 | |
Johnny Chen | ed5f04e | 2010-10-15 23:33:18 +0000 | [diff] [blame] | 164 | output = StringIO.StringIO() if string_buffer else sys.stdout |
Johnny Chen | b51d87d | 2010-10-07 21:38:28 +0000 | [diff] [blame] | 165 | target = thread.GetProcess().GetTarget() |
| 166 | |
Johnny Chen | 1605cf6 | 2010-09-08 22:54:46 +0000 | [diff] [blame] | 167 | depth = thread.GetNumFrames() |
| 168 | |
| 169 | mods = GetModuleNames(thread) |
| 170 | funcs = GetFunctionNames(thread) |
Johnny Chen | b51d87d | 2010-10-07 21:38:28 +0000 | [diff] [blame] | 171 | symbols = GetSymbolNames(thread) |
Johnny Chen | 1605cf6 | 2010-09-08 22:54:46 +0000 | [diff] [blame] | 172 | files = GetFilenames(thread) |
| 173 | lines = GetLineNumbers(thread) |
Johnny Chen | b51d87d | 2010-10-07 21:38:28 +0000 | [diff] [blame] | 174 | addrs = GetPCAddresses(thread) |
Johnny Chen | 30425e9 | 2010-10-07 18:52:48 +0000 | [diff] [blame] | 175 | |
| 176 | print >> output, "Stack trace for thread id={0:#x} name={1} queue={2}:".format( |
Johnny Chen | 1605cf6 | 2010-09-08 22:54:46 +0000 | [diff] [blame] | 177 | thread.GetThreadID(), thread.GetName(), thread.GetQueueName()) |
| 178 | |
Johnny Chen | b51d87d | 2010-10-07 21:38:28 +0000 | [diff] [blame] | 179 | for i in range(depth): |
| 180 | frame = thread.GetFrameAtIndex(i) |
| 181 | function = frame.GetFunction() |
Johnny Chen | 1605cf6 | 2010-09-08 22:54:46 +0000 | [diff] [blame] | 182 | |
Johnny Chen | b51d87d | 2010-10-07 21:38:28 +0000 | [diff] [blame] | 183 | load_addr = addrs[i].GetLoadAddress(target) |
| 184 | if not function.IsValid(): |
| 185 | file_addr = addrs[i].GetFileAddress() |
| 186 | print >> output, " frame #{num}: {addr:#016x} {mod}`{symbol} + ????".format( |
| 187 | num=i, addr=load_addr, mod=mods[i], symbol=symbols[i]) |
| 188 | else: |
| 189 | print >> output, " frame #{num}: {addr:#016x} {mod}`{func} at {file}:{line}".format( |
| 190 | num=i, addr=load_addr, mod=mods[i], func=funcs[i], file=files[i], line=lines[i]) |
| 191 | |
| 192 | if string_buffer: |
Johnny Chen | ed5f04e | 2010-10-15 23:33:18 +0000 | [diff] [blame] | 193 | return output.getvalue() |
Johnny Chen | b51d87d | 2010-10-07 21:38:28 +0000 | [diff] [blame] | 194 | |
| 195 | |
| 196 | def PrintStackTraces(process, string_buffer = False): |
| 197 | """Prints the stack traces of all the threads.""" |
| 198 | |
Johnny Chen | ed5f04e | 2010-10-15 23:33:18 +0000 | [diff] [blame] | 199 | output = StringIO.StringIO() if string_buffer else sys.stdout |
Johnny Chen | b51d87d | 2010-10-07 21:38:28 +0000 | [diff] [blame] | 200 | |
| 201 | print >> output, "Stack traces for " + repr(process) |
| 202 | |
| 203 | for i in range(process.GetNumThreads()): |
| 204 | print >> output, PrintStackTrace(process.GetThreadAtIndex(i), string_buffer=True) |
Johnny Chen | 30425e9 | 2010-10-07 18:52:48 +0000 | [diff] [blame] | 205 | |
| 206 | if string_buffer: |
Johnny Chen | ed5f04e | 2010-10-15 23:33:18 +0000 | [diff] [blame] | 207 | return output.getvalue() |