sim/sim_events.cc

   1 /*
   2  * Copyright (c) 2002-2004 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
  29 #include <string>
  30
  31 #include "base/callback.hh"
  32 #include "base/hostinfo.hh"
  33 #include "sim/eventq.hh"
  34 #include "sim/param.hh"
  35 #include "sim/sim_events.hh"
  36 #include "sim/sim_exit.hh"
  37 #include "sim/startup.hh"
  38 #include "sim/stats.hh"
  39
  40 using namespace std;
  41
  42 //
  43 // handle termination event
  44 //
  45 void
  46 SimExitEvent::process()
  47 {
  48     // This event does not autodelete because exitNow may be called,
  49     // and the function will never be allowed to finish.
  50     if (theQueue() == &mainEventQueue) {
  51         string _cause = cause;
  52         int _code = code;
  53         delete this;
  54         exitNow(_cause, _code);
  55     } else {
  56         new SimExitEvent(cause, code);
  57         delete this;
  58     }
  59 }
  60
  61
  62 const char *
  63 SimExitEvent::description()
  64 {
  65     return "simulation termination";
  66 }
  67
  68 //
  69 // constructor: automatically schedules at specified time
  70 //
  71 CountedExitEvent::CountedExitEvent(EventQueue *q, const std::string &_cause,
  72                                    Tick _when, int &_downCounter)
  73     : Event(q, Sim_Exit_Pri),
  74       cause(_cause),
  75       downCounter(_downCounter)
  76 {
  77     // catch stupid mistakes
  78     assert(downCounter > 0);
  79
  80     schedule(_when);
  81 }
  82
  83
  84 //
  85 // handle termination event
  86 //
  87 void
  88 CountedExitEvent::process()
  89 {
  90     if (--downCounter == 0) {
  91         new SimExitEvent(cause, 0);
  92     }
  93 }
  94
  95
  96 const char *
  97 CountedExitEvent::description()
  98 {
  99     return "counted exit";
 100 }
 101
 102 #ifdef CHECK_SWAP_CYCLES
 103 new CheckSwapEvent(&mainEventQueue, CHECK_SWAP_CYCLES);
 104 #endif
 105
 106 void
 107 CheckSwapEvent::process()
 108 {
 109     /*  Check the amount of free swap space  */
 110     long swap;
 111
 112     /*  returns free swap in KBytes  */
 113     swap = procInfo("/proc/meminfo", "SwapFree:");
 114
 115     if (swap < 1000)
 116         ccprintf(cerr, "\a\a\aWarning! Swap space is low (%d)\n", swap);
 117
 118     if (swap < 100) {
 119         cerr << "\a\aAborting Simulation! Inadequate swap space!\n\n";
 120         new SimExitEvent("Lack of swap space");
 121     }
 122
 123     schedule(curTick + interval);
 124 }
 125
 126 const char *
 127 CheckSwapEvent::description()
 128 {
 129     return "check swap";
 130 }
 131
 132
 133 ///////////////////////////////////////////////////
 134 //
 135 // Simulation termination parameters
 136 //
 137 ///////////////////////////////////////////////////
 138
 139 class TermParamContext : public ParamContext
 140 {
 141   public:
 142     TermParamContext(const string &_iniSection)
 143         : ParamContext(_iniSection) {}
 144     void checkParams();
 145 };
 146
 147 TermParamContext simTerminationParams("max");
 148
 149 Param<Tick> max_cycle(&simTerminationParams, "cycle",
 150                         "maximum number of cycles to execute");
 151
 152 void
 153 TermParamContext::checkParams()
 154 {
 155     // if a max cycle count was specified, put a termination event on
 156     // the event queue at that point
 157     if (max_cycle.isValid())
 158         new SimExitEvent(max_cycle, "reached maximum cycle count");
 159 }
 160
 161 //
 162 // Progress event: print out cycle every so often so we know we're
 163 // making forward progress.
 164 //
 165 class ProgressEvent : public Event
 166 {
 167   protected:
 168     Tick interval;
 169
 170   public:
 171     ProgressEvent(EventQueue *q, Tick interval);
 172
 173     void process();     // process event
 174     virtual const char *description();
 175 };
 176
 177 //
 178 // constructor: schedule at specified time
 179 //
 180 ProgressEvent::ProgressEvent(EventQueue *q, Tick _interval)
 181     : Event(q), interval(_interval)
 182 {
 183     schedule(curTick + interval);
 184 }
 185
 186 //
 187 // handle progress event: print message and reschedule
 188 //
 189 void
 190 ProgressEvent::process()
 191 {
 192     DPRINTFN("ProgressEvent\n");
 193     // reschedule for next interval
 194     schedule(curTick + interval);
 195 }
 196
 197
 198 const char *
 199 ProgressEvent::description()
 200 {
 201     return "progress message";
 202 }
 203
 204 /////////
 205 //
 206 // Periodic progress message support: print out a message every n
 207 // cycles so we know we're making forward progress.
 208 //
 209 /////////
 210
 211 // Parameter space for execution address tracing options.  Derive
 212 // from ParamContext so we can override checkParams() function.
 213 struct ProgressParamContext : public ParamContext
 214 {
 215     ProgressParamContext(const string &_iniSection)
 216         : ParamContext(_iniSection) {}
 217     void startup();
 218 };
 219
 220 ProgressParamContext progessMessageParams("progress");
 221
 222 Param<Tick> progress_interval(&progessMessageParams, "cycle",
 223                                 "cycle interval for progress messages");
 224
 225 void
 226 ProgressParamContext::startup()
 227 {
 228     if (progress_interval.isValid())
 229         new ProgressEvent(&mainEventQueue, progress_interval);
 230 }