process_events.py revision 565add09831504997f8e4297ec44a479e321fcec
19aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton#!/usr/bin/python 29aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton 39aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton#---------------------------------------------------------------------- 49aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton# Be sure to add the python path that points to the LLDB shared library. 59aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton# On MacOSX csh, tcsh: 69aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton# setenv PYTHONPATH /Applications/Xcode.app/Contents/SharedFrameworks/LLDB.framework/Resources/Python 79aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton# On MacOSX sh, bash: 89aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton# export PYTHONPATH=/Applications/Xcode.app/Contents/SharedFrameworks/LLDB.framework/Resources/Python 99aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton#---------------------------------------------------------------------- 109aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton 11565add09831504997f8e4297ec44a479e321fcecGreg Claytonimport commands 129aec43d66eedd94a2cb5513743f48bfaf3626684Greg Claytonimport optparse 139aec43d66eedd94a2cb5513743f48bfaf3626684Greg Claytonimport os 14565add09831504997f8e4297ec44a479e321fcecGreg Claytonimport platform 159aec43d66eedd94a2cb5513743f48bfaf3626684Greg Claytonimport sys 169aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton 17565add09831504997f8e4297ec44a479e321fcecGreg Clayton#---------------------------------------------------------------------- 18565add09831504997f8e4297ec44a479e321fcecGreg Clayton# Code that auto imports LLDB 19565add09831504997f8e4297ec44a479e321fcecGreg Clayton#---------------------------------------------------------------------- 20565add09831504997f8e4297ec44a479e321fcecGreg Claytontry: 21565add09831504997f8e4297ec44a479e321fcecGreg Clayton # Just try for LLDB in case PYTHONPATH is already correctly setup 22565add09831504997f8e4297ec44a479e321fcecGreg Clayton import lldb 23565add09831504997f8e4297ec44a479e321fcecGreg Claytonexcept ImportError: 24565add09831504997f8e4297ec44a479e321fcecGreg Clayton lldb_python_dirs = list() 25565add09831504997f8e4297ec44a479e321fcecGreg Clayton # lldb is not in the PYTHONPATH, try some defaults for the current platform 26565add09831504997f8e4297ec44a479e321fcecGreg Clayton platform_system = platform.system() 27565add09831504997f8e4297ec44a479e321fcecGreg Clayton if platform_system == 'Darwin': 28565add09831504997f8e4297ec44a479e321fcecGreg Clayton # On Darwin, try the currently selected Xcode directory 29565add09831504997f8e4297ec44a479e321fcecGreg Clayton xcode_dir = commands.getoutput("xcode-select --print-path") 30565add09831504997f8e4297ec44a479e321fcecGreg Clayton if xcode_dir: 31565add09831504997f8e4297ec44a479e321fcecGreg Clayton lldb_python_dirs.append(os.path.realpath(xcode_dir + '/../SharedFrameworks/LLDB.framework/Resources/Python')) 32565add09831504997f8e4297ec44a479e321fcecGreg Clayton lldb_python_dirs.append(xcode_dir + '/Library/PrivateFrameworks/LLDB.framework/Resources/Python') 33565add09831504997f8e4297ec44a479e321fcecGreg Clayton lldb_python_dirs.append('/System/Library/PrivateFrameworks/LLDB.framework/Resources/Python') 34565add09831504997f8e4297ec44a479e321fcecGreg Clayton success = False 35565add09831504997f8e4297ec44a479e321fcecGreg Clayton for lldb_python_dir in lldb_python_dirs: 36565add09831504997f8e4297ec44a479e321fcecGreg Clayton if os.path.exists(lldb_python_dir): 37565add09831504997f8e4297ec44a479e321fcecGreg Clayton if not (sys.path.__contains__(lldb_python_dir)): 38565add09831504997f8e4297ec44a479e321fcecGreg Clayton sys.path.append(lldb_python_dir) 39565add09831504997f8e4297ec44a479e321fcecGreg Clayton try: 40565add09831504997f8e4297ec44a479e321fcecGreg Clayton import lldb 41565add09831504997f8e4297ec44a479e321fcecGreg Clayton except ImportError: 42565add09831504997f8e4297ec44a479e321fcecGreg Clayton pass 43565add09831504997f8e4297ec44a479e321fcecGreg Clayton else: 44565add09831504997f8e4297ec44a479e321fcecGreg Clayton print 'imported lldb from: "%s"' % (lldb_python_dir) 45565add09831504997f8e4297ec44a479e321fcecGreg Clayton success = True 46565add09831504997f8e4297ec44a479e321fcecGreg Clayton break 47565add09831504997f8e4297ec44a479e321fcecGreg Clayton if not success: 48565add09831504997f8e4297ec44a479e321fcecGreg Clayton print "error: couldn't locate the 'lldb' module, please set PYTHONPATH correctly" 49565add09831504997f8e4297ec44a479e321fcecGreg Clayton sys.exit(1) 50565add09831504997f8e4297ec44a479e321fcecGreg Clayton 51565add09831504997f8e4297ec44a479e321fcecGreg Clayton 52565add09831504997f8e4297ec44a479e321fcecGreg Clayton 53565add09831504997f8e4297ec44a479e321fcecGreg Clayton 54565add09831504997f8e4297ec44a479e321fcecGreg Clayton 55565add09831504997f8e4297ec44a479e321fcecGreg Clayton 56565add09831504997f8e4297ec44a479e321fcecGreg Clayton 57565add09831504997f8e4297ec44a479e321fcecGreg Clayton 589aec43d66eedd94a2cb5513743f48bfaf3626684Greg Claytondef print_threads(process, options): 599aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton if options.show_threads: 609aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton for thread in process: 619aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton print '%s %s' % (thread, thread.GetFrameAtIndex(0)) 629aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton 639aec43d66eedd94a2cb5513743f48bfaf3626684Greg Claytondef run_commands(command_interpreter, commands): 649aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton return_obj = lldb.SBCommandReturnObject() 659aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton for command in commands: 669aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton command_interpreter.HandleCommand( command, return_obj ) 679aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton if return_obj.Succeeded(): 689aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton print return_obj.GetOutput() 699aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton else: 709aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton print return_obj 719aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton if options.stop_on_error: 729aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton break 739aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton 749aec43d66eedd94a2cb5513743f48bfaf3626684Greg Claytondef main(argv): 759aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton description='''Debugs a program using the LLDB python API and uses asynchronous broadcast events to watch for process state changes.''' 76565add09831504997f8e4297ec44a479e321fcecGreg Clayton epilog='''Examples: 77565add09831504997f8e4297ec44a479e321fcecGreg Clayton 78565add09831504997f8e4297ec44a479e321fcecGreg Clayton#---------------------------------------------------------------------- 79565add09831504997f8e4297ec44a479e321fcecGreg Clayton# Run "/bin/ls" with the arguments "-lAF /tmp/", and set a breakpoint 80565add09831504997f8e4297ec44a479e321fcecGreg Clayton# at "malloc" and backtrace and read all registers each time we stop 81565add09831504997f8e4297ec44a479e321fcecGreg Clayton#---------------------------------------------------------------------- 82565add09831504997f8e4297ec44a479e321fcecGreg Clayton% ./process_events.py --breakpoint malloc --stop-command bt --stop-command 'register read' -- /bin/ls -lAF /tmp/ 83565add09831504997f8e4297ec44a479e321fcecGreg Clayton 84565add09831504997f8e4297ec44a479e321fcecGreg Clayton''' 85565add09831504997f8e4297ec44a479e321fcecGreg Clayton optparse.OptionParser.format_epilog = lambda self, formatter: self.epilog 86565add09831504997f8e4297ec44a479e321fcecGreg Clayton parser = optparse.OptionParser(description=description, prog='process_events',usage='usage: process_events [options] program [arg1 arg2]', epilog=epilog) 879aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton parser.add_option('-v', '--verbose', action='store_true', dest='verbose', help="Enable verbose logging.", default=False) 88565add09831504997f8e4297ec44a479e321fcecGreg Clayton parser.add_option('-b', '--breakpoint', action='append', type='string', metavar='BPEXPR', dest='breakpoints', help='Breakpoint commands to create after the target has been created, the values will be sent to the "_regexp-break" command which supports breakpoints by name, file:line, and address.') 89565add09831504997f8e4297ec44a479e321fcecGreg Clayton parser.add_option('-a', '--arch', type='string', dest='arch', help='The architecture to use when creating the debug target.', default=None) 90565add09831504997f8e4297ec44a479e321fcecGreg Clayton parser.add_option('-l', '--launch-command', action='append', type='string', metavar='CMD', dest='launch_commands', help='LLDB command interpreter commands to run once after the process has launched. This option can be specified more than once.', default=[]) 91565add09831504997f8e4297ec44a479e321fcecGreg Clayton parser.add_option('-s', '--stop-command', action='append', type='string', metavar='CMD', dest='stop_commands', help='LLDB command interpreter commands to run each time the process stops. This option can be specified more than once.', default=[]) 92565add09831504997f8e4297ec44a479e321fcecGreg Clayton parser.add_option('-c', '--crash-command', action='append', type='string', metavar='CMD', dest='crash_commands', help='LLDB command interpreter commands to run in case the process crashes. This option can be specified more than once.', default=[]) 93565add09831504997f8e4297ec44a479e321fcecGreg Clayton parser.add_option('-x', '--exit-command', action='append', type='string', metavar='CMD', dest='exit_commands', help='LLDB command interpreter commands to run once after the process has exited. This option can be specified more than once.', default=[]) 949aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton parser.add_option('-T', '--no-threads', action='store_false', dest='show_threads', help="Don't show threads when process stops.", default=True) 95565add09831504997f8e4297ec44a479e321fcecGreg Clayton parser.add_option('-e', '--ignore-errors', action='store_false', dest='stop_on_error', help="Don't stop executing LLDB commands if the command returns an error. This applies to all of the LLDB command interpreter commands that get run for launch, stop, crash and exit.", default=True) 96565add09831504997f8e4297ec44a479e321fcecGreg Clayton parser.add_option('-n', '--run-count', type='int', dest='run_count', metavar='N', help='How many times to run the process in case the process exits.', default=1) 97565add09831504997f8e4297ec44a479e321fcecGreg Clayton parser.add_option('-t', '--event-timeout', type='int', dest='event_timeout', metavar='SEC', help='Specify the timeout in seconds to wait for process state change events.', default=5) 989aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton try: 999aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton (options, args) = parser.parse_args(argv) 1009aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton except: 1019aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton return 1029aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton if not args: 1039aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton print 'error: a program path for a program to debug and its arguments are required' 1049aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton sys.exit(1) 1059aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton 1069aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton exe = args.pop(0) 107565add09831504997f8e4297ec44a479e321fcecGreg Clayton 1089aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton # Create a new debugger instance 1099aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton debugger = lldb.SBDebugger.Create() 1109aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton command_interpreter = debugger.GetCommandInterpreter() 1119aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton # Create a target from a file and arch 1129aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton print "Creating a target for '%s'" % exe 1139aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton 1149aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton target = debugger.CreateTargetWithFileAndArch (exe, options.arch) 1159aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton 1169aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton if target: 1179aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton 1189aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton # Set any breakpoints that were specified in the args 119565add09831504997f8e4297ec44a479e321fcecGreg Clayton if options.breakpoints: 120565add09831504997f8e4297ec44a479e321fcecGreg Clayton for bp in options.breakpoints: 121565add09831504997f8e4297ec44a479e321fcecGreg Clayton debugger.HandleCommand( "_regexp-break %s" % (bp)) 122565add09831504997f8e4297ec44a479e321fcecGreg Clayton run_commands(command_interpreter, ['breakpoint list']) 1239aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton 1249aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton for run_idx in range(options.run_count): 1259aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton # Launch the process. Since we specified synchronous mode, we won't return 1269aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton # from this function until we hit the breakpoint at main 1279aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton if options.run_count == 1: 1289aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton print 'Launching "%s"...' % (exe) 1299aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton else: 1309aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton print 'Launching "%s"... (launch %u of %u)' % (exe, run_idx + 1, options.run_count) 1319aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton 1329aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton process = target.LaunchSimple (args, None, os.getcwd()) 1339aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton 1349aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton # Make sure the launch went ok 1359aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton if process: 1369aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton pid = process.GetProcessID() 1379aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton listener = lldb.SBListener("event_listener") 1389aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton # sign up for process state change events 1399aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton process.GetBroadcaster().AddListener(listener, lldb.SBProcess.eBroadcastBitStateChanged) 1409aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton stop_idx = 0 1419aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton done = False 1429aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton while not done: 1439aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton event = lldb.SBEvent() 1449aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton if listener.WaitForEvent (options.event_timeout, event): 1459aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton state = lldb.SBProcess.GetStateFromEvent (event) 1469aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton if state == lldb.eStateStopped: 1479aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton if stop_idx == 0: 1489aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton print "process %u launched" % (pid) 149565add09831504997f8e4297ec44a479e321fcecGreg Clayton run_commands (command_interpreter, options.launch_commands) 1509aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton else: 1519aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton if options.verbose: 1529aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton print "process %u stopped" % (pid) 153565add09831504997f8e4297ec44a479e321fcecGreg Clayton run_commands (command_interpreter, options.stop_commands) 1549aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton stop_idx += 1 1559aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton print_threads (process, options) 1569aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton process.Continue() 1579aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton elif state == lldb.eStateExited: 1589aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton exit_desc = process.GetExitDescription() 1599aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton if exit_desc: 1609aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton print "process %u exited with status %u: %s" % (pid, process.GetExitStatus (), exit_desc) 1619aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton else: 1629aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton print "process %u exited with status %u" % (pid, process.GetExitStatus ()) 163565add09831504997f8e4297ec44a479e321fcecGreg Clayton run_commands (command_interpreter, options.exit_commands) 1649aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton done = True 1659aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton elif state == lldb.eStateCrashed: 1669aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton print "process %u crashed" % (pid) 1679aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton print_threads (process, options) 1689aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton run_commands (command_interpreter, options.crash_commands) 1699aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton done = True 1709aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton elif state == lldb.eStateDetached: 1719aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton print "process %u detached" % (pid) 1729aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton done = True 1739aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton elif state == lldb.eStateRunning: 1749aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton # process is running, don't say anything, we will always get one of these after resuming 1759aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton if options.verbose: 1769aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton print "process %u resumed" % (pid) 1779aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton elif state == lldb.eStateUnloaded: 1789aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton print "process %u unloaded, this shouldn't happen" % (pid) 1799aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton done = True 1809aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton elif state == lldb.eStateConnected: 1819aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton print "process connected" 1829aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton elif state == lldb.eStateAttaching: 1839aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton print "process attaching" 1849aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton elif state == lldb.eStateLaunching: 1859aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton print "process launching" 1869aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton else: 1879aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton # timeout waiting for an event 1889aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton print "no process event for %u seconds, killing the process..." % (options.event_timeout) 1899aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton done = True 1909aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton process.Kill() # kill the process 1919aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton 1929aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton lldb.SBDebugger.Terminate() 1939aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton 1949aec43d66eedd94a2cb5513743f48bfaf3626684Greg Claytonif __name__ == '__main__': 1959aec43d66eedd94a2cb5513743f48bfaf3626684Greg Clayton main(sys.argv[1:])