sim_events.cc revision 9952
1/* 2 * Copyright (c) 2013 ARM Limited 3 * All rights reserved 4 * 5 * The license below extends only to copyright in the software and shall 6 * not be construed as granting a license to any other intellectual 7 * property including but not limited to intellectual property relating 8 * to a hardware implementation of the functionality of the software 9 * licensed hereunder. You may use the software subject to the license 10 * terms below provided that you ensure that this notice is replicated 11 * unmodified and in its entirety in all distributions of the software, 12 * modified or unmodified, in source code or in binary form. 13 * 14 * Copyright (c) 2002-2005 The Regents of The University of Michigan 15 * All rights reserved. 16 * 17 * Redistribution and use in source and binary forms, with or without 18 * modification, are permitted provided that the following conditions are 19 * met: redistributions of source code must retain the above copyright 20 * notice, this list of conditions and the following disclaimer; 21 * redistributions in binary form must reproduce the above copyright 22 * notice, this list of conditions and the following disclaimer in the 23 * documentation and/or other materials provided with the distribution; 24 * neither the name of the copyright holders nor the names of its 25 * contributors may be used to endorse or promote products derived from 26 * this software without specific prior written permission. 27 * 28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 30 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 31 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 32 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 33 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 34 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 35 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 36 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 38 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 39 * 40 * Authors: Nathan Binkert 41 */ 42 43#include <string> 44 45#include "base/callback.hh" 46#include "base/hostinfo.hh" 47#include "sim/eventq_impl.hh" 48#include "sim/sim_events.hh" 49#include "sim/sim_exit.hh" 50#include "sim/stats.hh" 51 52using namespace std; 53 54SimLoopExitEvent::SimLoopExitEvent() 55 : Event(Sim_Exit_Pri, IsExitEvent | AutoSerialize), 56 cause(""), code(0), repeat(0) 57{ 58} 59 60SimLoopExitEvent::SimLoopExitEvent(const std::string &_cause, int c, Tick r, 61 bool serialize) 62 : Event(Sim_Exit_Pri, IsExitEvent | (serialize ? AutoSerialize : 0)), 63 cause(_cause), code(c), repeat(r) 64{ 65} 66 67 68// 69// handle termination event 70// 71void 72SimLoopExitEvent::process() 73{ 74 // if this got scheduled on a different queue (e.g. the committed 75 // instruction queue) then make a corresponding event on the main 76 // queue. 77 if (!isFlagSet(IsMainQueue)) { 78 exitSimLoop(cause, code); 79 setFlags(AutoDelete); 80 } 81 82 // otherwise do nothing... the IsExitEvent flag takes care of 83 // exiting the simulation loop and returning this object to Python 84 85 // but if you are doing this on intervals, don't forget to make another 86 if (repeat) { 87 assert(isFlagSet(IsMainQueue)); 88 mainEventQueue.schedule(this, curTick() + repeat); 89 } 90} 91 92 93const char * 94SimLoopExitEvent::description() const 95{ 96 return "simulation loop exit"; 97} 98 99void 100SimLoopExitEvent::serialize(ostream &os) 101{ 102 paramOut(os, "type", string("SimLoopExitEvent")); 103 Event::serialize(os); 104 105 SERIALIZE_SCALAR(cause); 106 SERIALIZE_SCALAR(code); 107 SERIALIZE_SCALAR(repeat); 108} 109 110void 111SimLoopExitEvent::unserialize(Checkpoint *cp, const string §ion) 112{ 113 Event::unserialize(cp, section); 114 115 UNSERIALIZE_SCALAR(cause); 116 UNSERIALIZE_SCALAR(code); 117 UNSERIALIZE_SCALAR(repeat); 118} 119 120Serializable * 121SimLoopExitEvent::createForUnserialize(Checkpoint *cp, const string §ion) 122{ 123 return new SimLoopExitEvent(); 124} 125 126REGISTER_SERIALIZEABLE("SimLoopExitEvent", SimLoopExitEvent) 127 128void 129exitSimLoop(const std::string &message, int exit_code, Tick when, Tick repeat, 130 bool serialize) 131{ 132 Event *event = new SimLoopExitEvent(message, exit_code, repeat, serialize); 133 mainEventQueue.schedule(event, when); 134} 135 136// 137// constructor: automatically schedules at specified time 138// 139CountedExitEvent::CountedExitEvent(const std::string &_cause, int &counter) 140 : Event(Sim_Exit_Pri), cause(_cause), downCounter(counter) 141{ 142 // catch stupid mistakes 143 assert(downCounter > 0); 144} 145 146 147// 148// handle termination event 149// 150void 151CountedExitEvent::process() 152{ 153 if (--downCounter == 0) { 154 exitSimLoop(cause, 0); 155 } 156} 157 158 159const char * 160CountedExitEvent::description() const 161{ 162 return "counted exit"; 163} 164