src/python/m5/event.py

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