Home | History | Annotate | Download | only in python
      1 #!/usr/bin/python
      2 
      3 #----------------------------------------------------------------------
      4 # Be sure to add the python path that points to the LLDB shared library.
      5 # On MacOSX csh, tcsh:
      6 #   setenv PYTHONPATH /Applications/Xcode.app/Contents/SharedFrameworks/LLDB.framework/Resources/Python
      7 # On MacOSX sh, bash:
      8 #   export PYTHONPATH=/Applications/Xcode.app/Contents/SharedFrameworks/LLDB.framework/Resources/Python
      9 #----------------------------------------------------------------------
     10 
     11 import commands
     12 import optparse
     13 import os
     14 import platform
     15 import re
     16 import resource
     17 import sys
     18 import time
     19 import types
     20 
     21 #----------------------------------------------------------------------
     22 # Code that auto imports LLDB
     23 #----------------------------------------------------------------------
     24 try: 
     25     # Just try for LLDB in case PYTHONPATH is already correctly setup
     26     import lldb
     27 except ImportError:
     28     lldb_python_dirs = list()
     29     # lldb is not in the PYTHONPATH, try some defaults for the current platform
     30     platform_system = platform.system()
     31     if platform_system == 'Darwin':
     32         # On Darwin, try the currently selected Xcode directory
     33         xcode_dir = commands.getoutput("xcode-select --print-path")
     34         if xcode_dir:
     35             lldb_python_dirs.append(os.path.realpath(xcode_dir + '/../SharedFrameworks/LLDB.framework/Resources/Python'))
     36             lldb_python_dirs.append(xcode_dir + '/Library/PrivateFrameworks/LLDB.framework/Resources/Python')
     37         lldb_python_dirs.append('/System/Library/PrivateFrameworks/LLDB.framework/Resources/Python')
     38     success = False
     39     for lldb_python_dir in lldb_python_dirs:
     40         if os.path.exists(lldb_python_dir):
     41             if not (sys.path.__contains__(lldb_python_dir)):
     42                 sys.path.append(lldb_python_dir)
     43                 try: 
     44                     import lldb
     45                 except ImportError:
     46                     pass
     47                 else:
     48                     print 'imported lldb from: "%s"' % (lldb_python_dir)
     49                     success = True
     50                     break
     51     if not success:
     52         print "error: couldn't locate the 'lldb' module, please set PYTHONPATH correctly"
     53         sys.exit(1)
     54 
     55 
     56 class Timer:    
     57     def __enter__(self):
     58         self.start = time.clock()
     59         return self
     60 
     61     def __exit__(self, *args):
     62         self.end = time.clock()
     63         self.interval = self.end - self.start
     64 
     65 class Action(object):
     66     """Class that encapsulates actions to take when a thread stops for a reason."""
     67     def __init__(self, callback = None, callback_owner = None):
     68         self.callback = callback
     69         self.callback_owner = callback_owner
     70     def ThreadStopped (self, thread):
     71         assert False, "performance.Action.ThreadStopped(self, thread) must be overridden in a subclass"
     72 
     73 class PlanCompleteAction (Action):
     74     def __init__(self, callback = None, callback_owner = None):
     75         Action.__init__(self, callback, callback_owner)
     76     def ThreadStopped (self, thread):
     77         if thread.GetStopReason() == lldb.eStopReasonPlanComplete:
     78             if self.callback:
     79                 if self.callback_owner:
     80                     self.callback (self.callback_owner, thread)
     81                 else:
     82                     self.callback (thread)
     83             return True
     84         return False
     85 
     86 
     87 class BreakpointAction (Action):
     88     def __init__(self, callback = None, callback_owner = None, name = None, module = None, file = None, line = None, breakpoint = None):
     89         Action.__init__(self, callback, callback_owner)
     90         self.modules = lldb.SBFileSpecList()
     91         self.files = lldb.SBFileSpecList()
     92         self.breakpoints = list()
     93         # "module" can be a list or a string
     94         if breakpoint:
     95             self.breakpoints.append(breakpoint)
     96         else:
     97             if module:
     98                 if isinstance(module, types.ListType):
     99                     for module_path in module:
    100                         self.modules.Append(lldb.SBFileSpec(module_path, False))
    101                 elif isinstance(module, types.StringTypes):
    102                     self.modules.Append(lldb.SBFileSpec(module, False))
    103             if name:
    104                 # "file" can be a list or a string
    105                 if file:
    106                     if isinstance(file, types.ListType):
    107                         self.files = lldb.SBFileSpecList()
    108                         for f in file:
    109                             self.files.Append(lldb.SBFileSpec(f, False))
    110                     elif isinstance(file, types.StringTypes):
    111                         self.files.Append(lldb.SBFileSpec(file, False))
    112                 self.breakpoints.append (self.target.BreakpointCreateByName(name, self.modules, self.files))
    113             elif file and line:
    114                 self.breakpoints.append (self.target.BreakpointCreateByLocation(file, line))
    115     def ThreadStopped (self, thread):
    116         if thread.GetStopReason() == lldb.eStopReasonBreakpoint:
    117             for bp in self.breakpoints:
    118                 if bp.GetID() == thread.GetStopReasonDataAtIndex(0):
    119                     if self.callback:
    120                         if self.callback_owner:
    121                             self.callback (self.callback_owner, thread)
    122                         else:
    123                             self.callback (thread)
    124                     return True
    125         return False
    126 class TestCase:
    127     """Class that aids in running performance tests."""
    128     def __init__(self):
    129         self.verbose = False
    130         self.debugger = lldb.SBDebugger.Create()
    131         self.target = None
    132         self.process = None
    133         self.thread = None
    134         self.launch_info = None
    135         self.done = False
    136         self.listener = self.debugger.GetListener()
    137         self.user_actions = list()
    138         self.builtin_actions = list()
    139         self.bp_id_to_dict = dict()
    140         
    141     def Setup(self, args):
    142         self.launch_info = lldb.SBLaunchInfo(args)
    143         
    144     def Run (self, args):
    145         assert False, "performance.TestCase.Run(self, args) must be subclassed"
    146     
    147     def Launch(self):
    148         if self.target:
    149             error = lldb.SBError()
    150             self.process = self.target.Launch (self.launch_info, error)
    151             if not error.Success():
    152                 print "error: %s" % error.GetCString()
    153             if self.process:
    154                 self.process.GetBroadcaster().AddListener(self.listener, lldb.SBProcess.eBroadcastBitStateChanged | lldb.SBProcess.eBroadcastBitInterrupt)
    155                 return True
    156         return False
    157         
    158     def WaitForNextProcessEvent (self):
    159         event = None
    160         if self.process:
    161             while event is None:
    162                 process_event = lldb.SBEvent()
    163                 if self.listener.WaitForEvent (lldb.UINT32_MAX, process_event):
    164                     state = lldb.SBProcess.GetStateFromEvent (process_event)
    165                     if self.verbose:
    166                         print "event = %s" % (lldb.SBDebugger.StateAsCString(state))
    167                     if lldb.SBProcess.GetRestartedFromEvent(process_event):
    168                         continue
    169                     if state == lldb.eStateInvalid or state == lldb.eStateDetached or state == lldb.eStateCrashed or  state == lldb.eStateUnloaded or state == lldb.eStateExited:
    170                         event = process_event
    171                         self.done = True
    172                     elif state == lldb.eStateConnected or state == lldb.eStateAttaching or state == lldb.eStateLaunching or state == lldb.eStateRunning or state == lldb.eStateStepping or state == lldb.eStateSuspended:
    173                         continue
    174                     elif state == lldb.eStateStopped:
    175                         event = process_event
    176                         call_test_step = True
    177                         fatal = False
    178                         selected_thread = False
    179                         for thread in self.process:
    180                             frame = thread.GetFrameAtIndex(0)
    181                             select_thread = False
    182                             
    183                             stop_reason = thread.GetStopReason()
    184                             if self.verbose:
    185                                 print "tid = %#x pc = %#x " % (thread.GetThreadID(),frame.GetPC()),
    186                             if stop_reason == lldb.eStopReasonNone:
    187                                 if self.verbose:
    188                                     print "none"
    189                             elif stop_reason == lldb.eStopReasonTrace:
    190                                 select_thread = True
    191                                 if self.verbose:
    192                                     print "trace"
    193                             elif stop_reason == lldb.eStopReasonPlanComplete:
    194                                 select_thread = True
    195                                 if self.verbose:
    196                                     print "plan complete"
    197                             elif stop_reason == lldb.eStopReasonThreadExiting:
    198                                 if self.verbose:
    199                                     print "thread exiting"
    200                             elif stop_reason == lldb.eStopReasonExec:
    201                                 if self.verbose:
    202                                     print "exec"
    203                             elif stop_reason == lldb.eStopReasonInvalid:
    204                                 if self.verbose:
    205                                     print "invalid"
    206                             elif stop_reason == lldb.eStopReasonException:
    207                                 select_thread = True
    208                                 if self.verbose:
    209                                     print "exception"
    210                                 fatal = True
    211                             elif stop_reason == lldb.eStopReasonBreakpoint:
    212                                 select_thread = True
    213                                 bp_id = thread.GetStopReasonDataAtIndex(0)
    214                                 bp_loc_id = thread.GetStopReasonDataAtIndex(1)
    215                                 if self.verbose:
    216                                     print "breakpoint id = %d.%d" % (bp_id, bp_loc_id)
    217                             elif stop_reason == lldb.eStopReasonWatchpoint:
    218                                 select_thread = True
    219                                 if self.verbose:
    220                                     print "watchpoint id = %d" % (thread.GetStopReasonDataAtIndex(0))
    221                             elif stop_reason == lldb.eStopReasonSignal:
    222                                 select_thread = True
    223                                 if self.verbose:
    224                                     print "signal %d" % (thread.GetStopReasonDataAtIndex(0))
    225                             
    226                             if select_thread and not selected_thread:
    227                                 self.thread = thread
    228                                 selected_thread = self.process.SetSelectedThread(thread)
    229                             
    230                             for action in self.user_actions:
    231                                 action.ThreadStopped (thread)
    232                                     
    233 
    234                         if fatal:
    235                             # if self.verbose: 
    236                             #     Xcode.RunCommand(self.debugger,"bt all",true)
    237                             sys.exit(1)
    238         return event
    239     
    240 class Measurement:
    241     '''A class that encapsulates a measurement'''
    242     def __init__(self):
    243         object.__init__(self)
    244     def Measure(self):
    245         assert False, "performance.Measurement.Measure() must be subclassed"
    246         
    247 class MemoryMeasurement(Measurement):
    248     '''A class that can measure memory statistics for a process.'''
    249     def __init__(self, pid):
    250         Measurement.__init__(self)
    251         self.pid = pid
    252         self.stats = ["rprvt","rshrd","rsize","vsize","vprvt","kprvt","kshrd","faults","cow","pageins"]
    253         self.command = "top -l 1 -pid %u -stats %s" % (self.pid, ",".join(self.stats))
    254         self.value = dict()
    255     
    256     def Measure(self):
    257         output = commands.getoutput(self.command).split("\n")[-1]
    258         values = re.split('[-+\s]+', output)
    259         for (idx, stat) in enumerate(values):
    260             multiplier = 1
    261             if stat:
    262                 if stat[-1] == 'K':
    263                     multiplier = 1024
    264                     stat = stat[:-1]
    265                 elif stat[-1] == 'M':
    266                     multiplier = 1024*1024
    267                     stat = stat[:-1]
    268                 elif stat[-1] == 'G':
    269                     multiplier = 1024*1024*1024
    270                 elif stat[-1] == 'T':
    271                     multiplier = 1024*1024*1024*1024
    272                     stat = stat[:-1]
    273                 self.value[self.stats[idx]] = int (stat) * multiplier
    274 
    275     def __str__(self):
    276         '''Dump the MemoryMeasurement current value'''
    277         s = ''
    278         for key in self.value.keys():
    279             if s:
    280                 s += "\n"
    281             s += "%8s = %s" % (key, self.value[key])
    282         return s
    283 
    284 
    285 class TesterTestCase(TestCase):    
    286     def __init__(self):
    287         TestCase.__init__(self)
    288         self.verbose = True
    289         self.num_steps = 5
    290     
    291     def BreakpointHit (self, thread):
    292         bp_id = thread.GetStopReasonDataAtIndex(0)
    293         loc_id = thread.GetStopReasonDataAtIndex(1)
    294         print "Breakpoint %i.%i hit: %s" % (bp_id, loc_id, thread.process.target.FindBreakpointByID(bp_id))
    295         thread.StepOver()
    296     
    297     def PlanComplete (self, thread):
    298         if self.num_steps > 0:
    299             thread.StepOver()
    300             self.num_steps = self.num_steps - 1
    301         else:
    302             thread.process.Kill()
    303 
    304     def Run (self, args):
    305         self.Setup(args)
    306         with Timer() as total_time:
    307             self.target = self.debugger.CreateTarget(args[0])
    308             if self.target:
    309                 with Timer() as breakpoint_timer:
    310                     bp = self.target.BreakpointCreateByName("main")
    311                 print('Breakpoint time = %.03f sec.' % breakpoint_timer.interval)
    312                 
    313                 self.user_actions.append (BreakpointAction(breakpoint=bp, callback=TesterTestCase.BreakpointHit, callback_owner=self))
    314                 self.user_actions.append (PlanCompleteAction(callback=TesterTestCase.PlanComplete, callback_owner=self))
    315                 
    316                 if self.Launch():
    317                     while not self.done:
    318                         self.WaitForNextProcessEvent()
    319                 else:
    320                     print "error: failed to launch process"
    321             else:
    322                 print "error: failed to create target with '%s'" % (args[0])
    323         print('Total time = %.03f sec.' % total_time.interval)
    324         
    325 
    326 if __name__ == '__main__':
    327     lldb.SBDebugger.Initialize()
    328     test = TesterTestCase()
    329     test.Run (sys.argv[1:])
    330     mem = MemoryMeasurement(os.getpid())
    331     mem.Measure()
    332     print str(mem)
    333     lldb.SBDebugger.Terminate()
    334     # print "sleeeping for 100 seconds"
    335     # time.sleep(100)
    336