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