sim_events.cc revision 7823:dac01f14f20f 
1/*
2 * Copyright (c) 2002-2005 The Regents of The University of Michigan
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met: redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer;
9 * redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution;
12 * neither the name of the copyright holders nor the names of its
13 * contributors may be used to endorse or promote products derived from
14 * this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 *
28 * Authors: Nathan Binkert
29 */
30
31#include <string>
32
33#include "base/callback.hh"
34#include "base/hostinfo.hh"
35#include "sim/eventq.hh"
36#include "sim/sim_events.hh"
37#include "sim/sim_exit.hh"
38#include "sim/stats.hh"
39
40using namespace std;
41
42SimLoopExitEvent::SimLoopExitEvent(const std::string &_cause, int c, Tick r)
43    : Event(Sim_Exit_Pri), cause(_cause), code(c), repeat(r)
44{
45    setFlags(IsExitEvent);
46}
47
48
49//
50// handle termination event
51//
52void
53SimLoopExitEvent::process()
54{
55    // if this got scheduled on a different queue (e.g. the committed
56    // instruction queue) then make a corresponding event on the main
57    // queue.
58    if (!getFlags(IsMainQueue)) {
59        exitSimLoop(cause, code);
60        delete this;
61    }
62
63    // otherwise do nothing... the IsExitEvent flag takes care of
64    // exiting the simulation loop and returning this object to Python
65
66    // but if you are doing this on intervals, don't forget to make another
67    if (repeat) {
68        assert(getFlags(IsMainQueue));
69        mainEventQueue.schedule(this, curTick() + repeat);
70    }
71}
72
73
74const char *
75SimLoopExitEvent::description() const
76{
77    return "simulation loop exit";
78}
79
80void
81exitSimLoop(const std::string &message, int exit_code, Tick when, Tick repeat)
82{
83    Event *event = new SimLoopExitEvent(message, exit_code, repeat);
84    mainEventQueue.schedule(event, when);
85}
86
87CountedDrainEvent::CountedDrainEvent()
88    : count(0)
89{ }
90
91void
92CountedDrainEvent::process()
93{
94    if (--count == 0)
95        exitSimLoop("Finished drain", 0);
96}
97
98//
99// constructor: automatically schedules at specified time
100//
101CountedExitEvent::CountedExitEvent(const std::string &_cause, int &counter)
102    : Event(Sim_Exit_Pri), cause(_cause), downCounter(counter)
103{
104    // catch stupid mistakes
105    assert(downCounter > 0);
106}
107
108
109//
110// handle termination event
111//
112void
113CountedExitEvent::process()
114{
115    if (--downCounter == 0) {
116        exitSimLoop(cause, 0);
117    }
118}
119
120
121const char *
122CountedExitEvent::description() const
123{
124    return "counted exit";
125}
126