Added an example that show correct usage of the async process event API.

llvm-svn: 162967

1 files changed, 139 insertions, 0 deletions

diff --git a/lldb/examples/python/process_events.py b/lldb/examples/python/process_events.py
new file mode 100755
index 00000000000..b869c071a99
--- /dev/null
+++ b/lldb/examples/python/process_events.py
@@ -0,0 +1,139 @@
+#!/usr/bin/python
+
+#----------------------------------------------------------------------
+# Be sure to add the python path that points to the LLDB shared library.
+# On MacOSX csh, tcsh:
+#   setenv PYTHONPATH /Applications/Xcode.app/Contents/SharedFrameworks/LLDB.framework/Resources/Python
+# On MacOSX sh, bash:
+#   export PYTHONPATH=/Applications/Xcode.app/Contents/SharedFrameworks/LLDB.framework/Resources/Python
+#----------------------------------------------------------------------
+
+import lldb
+import optparse
+import os
+import sys
+
+def print_threads(process, options):
+    if options.show_threads:
+        for thread in process:
+            print '%s %s' % (thread, thread.GetFrameAtIndex(0))
+
+def run_commands(command_interpreter, commands):
+    return_obj = lldb.SBCommandReturnObject()
+    for command in commands:
+        command_interpreter.HandleCommand( command, return_obj )
+        if return_obj.Succeeded():
+            print return_obj.GetOutput()
+        else:
+            print return_obj
+            if options.stop_on_error:
+                break
+    
+def main(argv):
+    description='''Debugs a program using the LLDB python API and uses asynchronous broadcast events to watch for process state changes.'''
+    parser = optparse.OptionParser(description=description, prog='process_events',usage='usage: process_events [options] program [arg1 arg2]')
+    parser.add_option('-v', '--verbose', action='store_true', dest='verbose', help="Enable verbose logging.", default=False)
+    parser.add_option('-b', '--breakpoint', action='append', type='string', dest='breakpoints', help='Breakpoint commands to create after the target has been created, the values will be sent to the "_regexp-break" command.')
+    parser.add_option('-a', '--arch', type='string', dest='arch', help='The architecture to use when creating the debug target.', default=lldb.LLDB_ARCH_DEFAULT)
+    parser.add_option('-s', '--stop-command', action='append', type='string', dest='stop_commands', help='Commands to run each time the process stops.', default=[])
+    parser.add_option('-S', '--crash-command', action='append', type='string', dest='crash_commands', help='Commands to run in case the process crashes.', default=[])
+    parser.add_option('-T', '--no-threads', action='store_false', dest='show_threads', help="Don't show threads when process stops.", default=True)
+    parser.add_option('-e', '--no_stop-on-error', action='store_false', dest='stop_on_error', help="Stop executing stop or crash commands if the command returns an error.", default=True)
+    parser.add_option('-c', '--run-count', type='int', dest='run_count', help='How many times to run the process in case the process exits.', default=1)
+    parser.add_option('-t', '--event-timeout', type='int', dest='event_timeout', help='Specify the timeout in seconds to wait for process state change events.', default=5)
+    try:
+        (options, args) = parser.parse_args(argv)
+    except:
+        return
+    if not args:
+        print 'error: a program path for a program to debug and its arguments are required'
+        sys.exit(1)
+    
+    exe = args.pop(0)
+    
+    # Create a new debugger instance
+    debugger = lldb.SBDebugger.Create()
+    command_interpreter = debugger.GetCommandInterpreter()
+    return_obj = lldb.SBCommandReturnObject()
+    # Create a target from a file and arch
+    print "Creating a target for '%s'" % exe
+    
+    target = debugger.CreateTargetWithFileAndArch (exe, options.arch)
+    
+    if target:
+        
+        # Set any breakpoints that were specified in the args
+        for bp in options.breakpoints:
+            command_interpreter.HandleCommand( "_regexp-break %s" % (bp), return_obj )
+            print return_obj            
+        
+        for run_idx in range(options.run_count):
+            # Launch the process. Since we specified synchronous mode, we won't return
+            # from this function until we hit the breakpoint at main
+            if options.run_count == 1:
+                print 'Launching "%s"...' % (exe)
+            else:
+                print 'Launching "%s"... (launch %u of %u)' % (exe, run_idx + 1, options.run_count)
+            
+            process = target.LaunchSimple (args, None, os.getcwd())
+            
+            # Make sure the launch went ok
+            if process:
+                pid = process.GetProcessID()
+                listener = lldb.SBListener("event_listener")
+                # sign up for process state change events
+                process.GetBroadcaster().AddListener(listener, lldb.SBProcess.eBroadcastBitStateChanged)
+                stop_idx = 0
+                done = False
+                while not done:
+                    event = lldb.SBEvent()
+                    if listener.WaitForEvent (options.event_timeout, event):
+                        state = lldb.SBProcess.GetStateFromEvent (event)
+                        if state == lldb.eStateStopped:
+                            if stop_idx == 0:
+                                print "process %u launched" % (pid)
+                            else:
+                                if options.verbose:
+                                    print "process %u stopped" % (pid)
+                            stop_idx += 1
+                            print_threads (process, options)
+                            run_commands (command_interpreter, options.stop_commands)
+                            process.Continue()
+                        elif state == lldb.eStateExited:
+                            exit_desc = process.GetExitDescription()
+                            if exit_desc:
+                                print "process %u exited with status %u: %s" % (pid, process.GetExitStatus (), exit_desc)
+                            else:
+                                print "process %u exited with status %u" % (pid, process.GetExitStatus ())
+                            done = True
+                        elif state == lldb.eStateCrashed:
+                            print "process %u crashed" % (pid)
+                            print_threads (process, options)
+                            run_commands (command_interpreter, options.crash_commands)
+                            done = True
+                        elif state == lldb.eStateDetached:
+                            print "process %u detached" % (pid)
+                            done = True
+                        elif state == lldb.eStateRunning:
+                            # process is running, don't say anything, we will always get one of these after resuming
+                            if options.verbose:
+                                print "process %u resumed" % (pid)
+                        elif state == lldb.eStateUnloaded:
+                            print "process %u unloaded, this shouldn't happen" % (pid)
+                            done = True
+                        elif state == lldb.eStateConnected:
+                            print "process connected"
+                        elif state == lldb.eStateAttaching:
+                            print "process attaching"
+                        elif state == lldb.eStateLaunching:
+                            print "process launching"
+                    else:
+                        # timeout waiting for an event
+                        print "no process event for %u seconds, killing the process..." % (options.event_timeout)
+                        done = True
+                process.Kill() # kill the process
+    
+    lldb.SBDebugger.Terminate()
+
+if __name__ == '__main__':
+    main(sys.argv[1:])
\ No newline at end of file