event.py revision 12041:52b3b120dbc0 
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
43import m5
44import _m5.event
45
46from _m5.event import GlobalSimLoopExitEvent as SimExit
47from _m5.event import PyEvent as Event
48from _m5.event import getEventQueue, setEventQueue
49
50mainq = None
51
52class EventWrapper(Event):
53    """Helper class to wrap callable objects in an Event base class"""
54
55    def __init__(self, func, **kwargs):
56        super(EventWrapper, self).__init__(**kwargs)
57
58        if not callable(func):
59            raise RuntimeError("Can't wrap '%s', object is not callable" % \
60                               str(func))
61
62        self._func = func
63
64    def __call__(self):
65        self._func()
66
67    def __str__(self):
68        return "EventWrapper(%s)" % (str(self._func), )
69
70
71class ProgressEvent(Event):
72    def __init__(self, eventq, period):
73        super(ProgressEvent, self).__init__()
74        self.period = int(period)
75        self.eventq = eventq
76        self.eventq.schedule(self, m5.curTick() + self.period)
77
78    def __call__(self):
79        print "Progress! Time now %fs" % (m5.curTick()/1e12)
80        self.eventq.schedule(self, m5.curTick() + self.period)
81
82
83def create(func, priority=Event.Default_Pri):
84    """Create an Event from a function"""
85
86    return EventWrapper(func, priority=priority)
87
88__all__ = [ 'Event', 'EventWrapper', 'ProgressEvent', 'SimExit',
89            'mainq', 'create' ]
90