src/sim/sim_events.cc

   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
  40 using namespace std;
  41
  42 SimLoopExitEvent::SimLoopExitEvent(const std::string &_cause, int c, Tick r)
  43     : Event(Sim_Exit_Pri, IsExitEvent), cause(_cause), code(c), repeat(r)
  44 {
  45 }
  46
  47
  48 //
  49 // handle termination event
  50 //
  51 void
  52 SimLoopExitEvent::process()
  53 {
  54     // if this got scheduled on a different queue (e.g. the committed
  55     // instruction queue) then make a corresponding event on the main
  56     // queue.
  57     if (!isFlagSet(IsMainQueue)) {
  58         exitSimLoop(cause, code);
  59         delete this;
  60     }
  61
  62     // otherwise do nothing... the IsExitEvent flag takes care of
  63     // exiting the simulation loop and returning this object to Python
  64
  65     // but if you are doing this on intervals, don't forget to make another
  66     if (repeat) {
  67         assert(isFlagSet(IsMainQueue));
  68         mainEventQueue.schedule(this, curTick() + repeat);
  69     }
  70 }
  71
  72
  73 const char *
  74 SimLoopExitEvent::description() const
  75 {
  76     return "simulation loop exit";
  77 }
  78
  79 void
  80 exitSimLoop(const std::string &message, int exit_code, Tick when, Tick repeat)
  81 {
  82     Event *event = new SimLoopExitEvent(message, exit_code, repeat);
  83     mainEventQueue.schedule(event, when);
  84 }
  85
  86 CountedDrainEvent::CountedDrainEvent()
  87     : count(0)
  88 { }
  89
  90 void
  91 CountedDrainEvent::process()
  92 {
  93     if (--count == 0)
  94         exitSimLoop("Finished drain", 0);
  95 }
  96
  97 //
  98 // constructor: automatically schedules at specified time
  99 //
 100 CountedExitEvent::CountedExitEvent(const std::string &_cause, int &counter)
 101     : Event(Sim_Exit_Pri), cause(_cause), downCounter(counter)
 102 {
 103     // catch stupid mistakes
 104     assert(downCounter > 0);
 105 }
 106
 107
 108 //
 109 // handle termination event
 110 //
 111 void
 112 CountedExitEvent::process()
 113 {
 114     if (--downCounter == 0) {
 115         exitSimLoop(cause, 0);
 116     }
 117 }
 118
 119
 120 const char *
 121 CountedExitEvent::description() const
 122 {
 123     return "counted exit";
 124 }