src/python/m5/event.py

   1 # Copyright (c) 2006 The Regents of The University of Michigan
   2 # Copyright (c) 2013 Advanced Micro Devices, Inc.
   3 # Copyright (c) 2013 Mark D. Hill and David A. Wood
   4 # All rights reserved.
   5 #
   6 # Redistribution and use in source and binary forms, with or without
   7 # modification, are permitted provided that the following conditions are
   8 # met: redistributions of source code must retain the above copyright
   9 # notice, this list of conditions and the following disclaimer;
  10 # redistributions in binary form must reproduce the above copyright
  11 # notice, this list of conditions and the following disclaimer in the
  12 # documentation and/or other materials provided with the distribution;
  13 # neither the name of the copyright holders nor the names of its
  14 # contributors may be used to endorse or promote products derived from
  15 # this software without specific prior written permission.
  16 #
  17 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  18 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  19 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  20 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  21 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  22 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  23 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  27 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28 #
  29 # Authors: Nathan Binkert
  30
  31 import m5
  32 import _m5.event
  33
  34 from _m5.event import PythonEvent, GlobalSimLoopExitEvent as SimExit
  35
  36 mainq = None
  37
  38 def create(obj, priority=None):
  39     if priority is None:
  40         priority = Event.Default_Pri
  41     return PythonEvent(obj, priority)
  42
  43
  44 # As a reminder, priorities found in sim/eventq.hh are stuck into the
  45 # Event class by swig
  46 class Event(PythonEvent):
  47     def __init__(self, priority=None):
  48         if priority is None:
  49             priority = Event.Default_Pri
  50         super(Event, self).__init__(self, priority)
  51
  52 class ProgressEvent(Event):
  53     def __init__(self, eventq, period):
  54         super(ProgressEvent, self).__init__()
  55         self.period = int(period)
  56         self.eventq = eventq
  57         self.eventq.schedule(self, m5.curTick() + self.period)
  58
  59     def __call__(self):
  60         print "Progress! Time now %fs" % (m5.curTick()/1e12)
  61         self.eventq.schedule(self, m5.curTick() + self.period)
  62
  63 def getEventQueue(index):
  64     return _m5.event.getEventQueue(index)
  65
  66 def setEventQueue(eventq):
  67     _m5.event.curEventQueue(eventq)
  68
  69 __all__ = [ 'create', 'Event', 'ProgressEvent', 'SimExit', 'mainq' ]