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