lldb/packages/Python/lldbsuite/test/lldbbench.py

   1 from __future__ import absolute_import
   2
   3 # System modules
   4 import time
   5
   6 # Third-party modules
   7
   8 # LLDB modules
   9 from .lldbtest import *
  10
  11
  12 class Stopwatch(object):
  13     """Stopwatch provides a simple utility to start/stop your stopwatch multiple
  14     times.  Each start/stop is equal to a lap, with its elapsed time accumulated
  15     while measurment is in progress.
  16
  17     When you're ready to start from scratch for another round of measurements,
  18     be sure to call the reset() method.
  19
  20     For example,
  21
  22     sw = Stopwatch()
  23     for i in range(1000):
  24         with sw:
  25             # Do some length operations...
  26             ...
  27     # Get the average time.
  28     avg_time = sw.avg()
  29
  30     # Reset the stopwatch as we are about to perform other kind of operations.
  31     sw.reset()
  32     ...
  33     """
  34
  35     #############################################################
  36     #
  37     # Context manager interfaces to support the 'with' statement.
  38     #
  39     #############################################################
  40
  41     def __enter__(self):
  42         """
  43         Context management protocol on entry to the body of the with statement.
  44         """
  45         return self.start()
  46
  47     def __exit__(self, type, value, tb):
  48         """
  49         Context management protocol on exit from the body of the with statement.
  50         """
  51         self.stop()
  52
  53     def reset(self):
  54         self.__laps__ = 0
  55         self.__total_elapsed__ = 0.0
  56         self.__start__ = None
  57         self.__stop__ = None
  58         self.__elapsed__ = 0.0
  59         self.__nums__ = []
  60
  61     def __init__(self):
  62         self.reset()
  63
  64     def start(self):
  65         if self.__start__ is None:
  66             self.__start__ = time.time()
  67         else:
  68             raise Exception(
  69                 "start() already called, did you forget to stop() first?")
  70         # Return self to facilitate the context manager __enter__ protocol.
  71         return self
  72
  73     def stop(self):
  74         if self.__start__ is not None:
  75             self.__stop__ = time.time()
  76             elapsed = self.__stop__ - self.__start__
  77             self.__total_elapsed__ += elapsed
  78             self.__laps__ += 1
  79             self.__nums__.append(elapsed)
  80             self.__start__ = None  # Reset __start__ to be None again.
  81         else:
  82             raise Exception("stop() called without first start()?")
  83
  84     def laps(self):
  85         """Gets the number of laps. One lap is equal to a start/stop action."""
  86         return self.__laps__
  87
  88     def avg(self):
  89         """Equal to total elapsed time divided by the number of laps."""
  90         return self.__total_elapsed__ / self.__laps__
  91
  92     # def sigma(self):
  93     #    """Return the standard deviation of the available samples."""
  94     #    if self.__laps__ <= 0:
  95     #        return None
  96     #    return numpy.std(self.__nums__)
  97
  98     def __str__(self):
  99         return "Avg: %f (Laps: %d, Total Elapsed Time: %f, min=%f, max=%f)" % (self.avg(
 100         ), self.__laps__, self.__total_elapsed__, min(self.__nums__), max(self.__nums__))
 101
 102
 103 class BenchBase(TestBase):
 104     """
 105     Abstract base class for benchmark tests.
 106     """
 107
 108     def setUp(self):
 109         """Fixture for unittest test case setup."""
 110         super(BenchBase, self).setUp()
 111         # TestBase.setUp(self)
 112         self.stopwatch = Stopwatch()
 113
 114     def tearDown(self):
 115         """Fixture for unittest test case teardown."""
 116         super(BenchBase, self).tearDown()
 117         # TestBase.tearDown(self)
 118         del self.stopwatch