src/python/m5/event.py

   1 # Copyright (c) 2017 ARM Limited
   2 # All rights reserved.
   3 #
   4 # The license below extends only to copyright in the software and shall
   5 # not be construed as granting a license to any other intellectual
   6 # property including but not limited to intellectual property relating
   7 # to a hardware implementation of the functionality of the software
   8 # licensed hereunder.  You may use the software subject to the license
   9 # terms below provided that you ensure that this notice is replicated
  10 # unmodified and in its entirety in all distributions of the software,
  11 # modified or unmodified, in source code or in binary form.
  12 #
  13 # Copyright (c) 2006 The Regents of The University of Michigan
  14 # Copyright (c) 2013 Advanced Micro Devices, Inc.
  15 # Copyright (c) 2013 Mark D. Hill and David A. Wood
  16 # All rights reserved.
  17 #
  18 # Redistribution and use in source and binary forms, with or without
  19 # modification, are permitted provided that the following conditions are
  20 # met: redistributions of source code must retain the above copyright
  21 # notice, this list of conditions and the following disclaimer;
  22 # redistributions in binary form must reproduce the above copyright
  23 # notice, this list of conditions and the following disclaimer in the
  24 # documentation and/or other materials provided with the distribution;
  25 # neither the name of the copyright holders nor the names of its
  26 # contributors may be used to endorse or promote products derived from
  27 # this software without specific prior written permission.
  28 #
  29 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  30 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  31 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  32 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  33 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  34 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  35 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  36 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  37 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  38 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  39 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  40 #
  41 # Authors: Nathan Binkert
  42
  43 from __future__ import print_function
  44
  45 import m5
  46 import _m5.event
  47
  48 from _m5.event import GlobalSimLoopExitEvent as SimExit
  49 from _m5.event import PyEvent as Event
  50 from _m5.event import getEventQueue, setEventQueue
  51
  52 mainq = None
  53
  54 class EventWrapper(Event):
  55     """Helper class to wrap callable objects in an Event base class"""
  56
  57     def __init__(self, func, **kwargs):
  58         super(EventWrapper, self).__init__(**kwargs)
  59
  60         if not callable(func):
  61             raise RuntimeError("Can't wrap '%s', object is not callable" % \
  62                                str(func))
  63
  64         self._func = func
  65
  66     def __call__(self):
  67         self._func()
  68
  69     def __str__(self):
  70         return "EventWrapper(%s)" % (str(self._func), )
  71
  72
  73 class ProgressEvent(Event):
  74     def __init__(self, eventq, period):
  75         super(ProgressEvent, self).__init__()
  76         self.period = int(period)
  77         self.eventq = eventq
  78         self.eventq.schedule(self, m5.curTick() + self.period)
  79
  80     def __call__(self):
  81         print("Progress! Time now %fs" % (m5.curTick()/1e12))
  82         self.eventq.schedule(self, m5.curTick() + self.period)
  83
  84
  85 def create(func, priority=Event.Default_Pri):
  86     """Create an Event from a function"""
  87
  88     return EventWrapper(func, priority=priority)
  89
  90 __all__ = [ 'Event', 'EventWrapper', 'ProgressEvent', 'SimExit',
  91             'mainq', 'create' ]