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/startup.hh"
  39 #include "sim/stats.hh"
  40
  41 using namespace std;
  42
  43 SimLoopExitEvent::SimLoopExitEvent(const std::string &_cause, int c, Tick r)
  44     : Event(Sim_Exit_Pri), cause(_cause), code(c), repeat(r)
  45 {
  46     setFlags(IsExitEvent);
  47 }
  48
  49
  50 //
  51 // handle termination event
  52 //
  53 void
  54 SimLoopExitEvent::process()
  55 {
  56     // if this got scheduled on a different queue (e.g. the committed
  57     // instruction queue) then make a corresponding event on the main
  58     // queue.
  59     if (!getFlags(IsMainQueue)) {
  60         exitSimLoop(cause, code);
  61         delete this;
  62     }
  63
  64     // otherwise do nothing... the IsExitEvent flag takes care of
  65     // exiting the simulation loop and returning this object to Python
  66
  67     // but if you are doing this on intervals, don't forget to make another
  68     if (repeat) {
  69         assert(getFlags(IsMainQueue));
  70         mainEventQueue.schedule(this, curTick + repeat);
  71     }
  72 }
  73
  74
  75 const char *
  76 SimLoopExitEvent::description() const
  77 {
  78     return "simulation loop exit";
  79 }
  80
  81 void
  82 exitSimLoop(const std::string &message, int exit_code)
  83 {
  84     Event *event = new SimLoopExitEvent(message, exit_code);
  85     mainEventQueue.schedule(event, curTick);
  86 }
  87
  88 CountedDrainEvent::CountedDrainEvent()
  89     : SimLoopExitEvent("Finished drain", 0), count(0)
  90 { }
  91
  92 void
  93 CountedDrainEvent::process()
  94 {
  95     if (--count == 0)
  96         exitSimLoop(cause, code);
  97 }
  98
  99 //
 100 // constructor: automatically schedules at specified time
 101 //
 102 CountedExitEvent::CountedExitEvent(const std::string &_cause, int &counter)
 103     : Event(Sim_Exit_Pri), cause(_cause), downCounter(counter)
 104 {
 105     // catch stupid mistakes
 106     assert(downCounter > 0);
 107 }
 108
 109
 110 //
 111 // handle termination event
 112 //
 113 void
 114 CountedExitEvent::process()
 115 {
 116     if (--downCounter == 0) {
 117         exitSimLoop(cause, 0);
 118     }
 119 }
 120
 121
 122 const char *
 123 CountedExitEvent::description() const
 124 {
 125     return "counted exit";
 126 }
 127
 128 CheckSwapEvent::CheckSwapEvent(int ival)
 129     : interval(ival)
 130 {
 131     mainEventQueue.schedule(this, curTick + interval);
 132 }
 133
 134 void
 135 CheckSwapEvent::process()
 136 {
 137     /*  Check the amount of free swap space  */
 138     long swap;
 139
 140     /*  returns free swap in KBytes  */
 141     swap = procInfo("/proc/meminfo", "SwapFree:");
 142
 143     if (swap < 1000)
 144         ccprintf(cerr, "\a\a\aWarning! Swap space is low (%d)\n", swap);
 145
 146     if (swap < 100) {
 147         cerr << "\a\aAborting Simulation! Inadequate swap space!\n\n";
 148         exitSimLoop("Lack of swap space");
 149     }
 150
 151     assert(getFlags(IsMainQueue));
 152     mainEventQueue.schedule(this, curTick + interval);
 153 }
 154
 155 const char *
 156 CheckSwapEvent::description() const
 157 {
 158     return "check swap";
 159 }