src/sim/stat_control.cc

   1 /*
   2  * Copyright (c) 2004-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 // This file will contain default statistics for the simulator that
  32 // don't really belong to a specific simulator object
  33
  34 #include <fstream>
  35 #include <iostream>
  36 #include <list>
  37
  38 #include "base/callback.hh"
  39 #include "base/hostinfo.hh"
  40 #include "base/statistics.hh"
  41 #include "base/str.hh"
  42 #include "base/time.hh"
  43 #include "base/stats/output.hh"
  44 #include "cpu/base.hh"
  45 #include "sim/eventq.hh"
  46 #include "sim/sim_object.hh"
  47 #include "sim/stat_control.hh"
  48 #include "sim/root.hh"
  49
  50 using namespace std;
  51
  52 Stats::Formula hostInstRate;
  53 Stats::Formula hostTickRate;
  54 Stats::Value hostMemory;
  55 Stats::Value hostSeconds;
  56
  57 Stats::Value simTicks;
  58 Stats::Value simInsts;
  59 Stats::Value simFreq;
  60 Stats::Formula simSeconds;
  61
  62 namespace Stats {
  63
  64 Time statTime(true);
  65 Tick startTick;
  66 Tick lastDump(0);
  67
  68 class SimTicksReset : public Callback
  69 {
  70   public:
  71     void process()
  72     {
  73         statTime.set();
  74         startTick = curTick;
  75     }
  76 };
  77
  78 double
  79 statElapsedTime()
  80 {
  81     Time now(true);
  82     Time elapsed = now - statTime;
  83     return elapsed();
  84 }
  85
  86 Tick
  87 statElapsedTicks()
  88 {
  89     return curTick - startTick;
  90 }
  91
  92 SimTicksReset simTicksReset;
  93
  94 void
  95 InitSimStats()
  96 {
  97     simInsts
  98         .functor(BaseCPU::numSimulatedInstructions)
  99         .name("sim_insts")
 100         .desc("Number of instructions simulated")
 101         .precision(0)
 102         .prereq(simInsts)
 103         ;
 104
 105     simSeconds
 106         .name("sim_seconds")
 107         .desc("Number of seconds simulated")
 108         ;
 109
 110     simFreq
 111         .scalar(Clock::Frequency)
 112         .name("sim_freq")
 113         .desc("Frequency of simulated ticks")
 114         ;
 115
 116     simTicks
 117         .functor(statElapsedTicks)
 118         .name("sim_ticks")
 119         .desc("Number of ticks simulated")
 120         ;
 121
 122     hostInstRate
 123         .name("host_inst_rate")
 124         .desc("Simulator instruction rate (inst/s)")
 125         .precision(0)
 126         .prereq(simInsts)
 127         ;
 128
 129     hostMemory
 130         .functor(memUsage)
 131         .name("host_mem_usage")
 132         .desc("Number of bytes of host memory used")
 133         .prereq(hostMemory)
 134         ;
 135
 136     hostSeconds
 137         .functor(statElapsedTime)
 138         .name("host_seconds")
 139         .desc("Real time elapsed on the host")
 140         .precision(2)
 141         ;
 142
 143     hostTickRate
 144         .name("host_tick_rate")
 145         .desc("Simulator tick rate (ticks/s)")
 146         .precision(0)
 147         ;
 148
 149     simSeconds = simTicks / simFreq;
 150     hostInstRate = simInsts / hostSeconds;
 151     hostTickRate = simTicks / hostSeconds;
 152
 153     registerResetCallback(&simTicksReset);
 154 }
 155
 156 class StatEvent : public Event
 157 {
 158   protected:
 159     int flags;
 160     Tick repeat;
 161
 162   public:
 163     StatEvent(EventQueue *queue, int _flags, Tick _when, Tick _repeat);
 164     virtual void process();
 165     virtual const char *description();
 166 };
 167
 168 StatEvent::StatEvent(EventQueue *queue, int _flags, Tick _when, Tick _repeat)
 169     : Event(queue, Stat_Event_Pri),
 170       flags(_flags), repeat(_repeat)
 171 {
 172     setFlags(AutoDelete);
 173     schedule(_when);
 174 }
 175
 176 const char *
 177 StatEvent::description()
 178 {
 179     return "Statistics dump and/or reset";
 180 }
 181
 182 void
 183 StatEvent::process()
 184 {
 185     if (flags & Stats::Dump)
 186         DumpNow();
 187
 188     if (flags & Stats::Reset) {
 189         cprintf("Resetting stats!\n");
 190         reset();
 191     }
 192
 193     if (repeat)
 194         schedule(curTick + repeat);
 195 }
 196
 197 list<Output *> OutputList;
 198
 199 void
 200 DumpNow()
 201 {
 202     assert(lastDump <= curTick);
 203     if (lastDump == curTick)
 204         return;
 205     lastDump = curTick;
 206
 207     list<Output *>::iterator i = OutputList.begin();
 208     list<Output *>::iterator end = OutputList.end();
 209     for (; i != end; ++i) {
 210         Output *output = *i;
 211         if (!output->valid())
 212             continue;
 213
 214         output->output();
 215     }
 216 }
 217
 218 void
 219 SetupEvent(int flags, Tick when, Tick repeat, EventQueue *queue)
 220 {
 221     if (queue == NULL)
 222         queue = &mainEventQueue;
 223
 224     new StatEvent(queue, flags, when, repeat);
 225 }
 226
 227 /* namespace Stats */ }
 228
 229 void debugDumpStats()
 230 {
 231     Stats::DumpNow();
 232 }
 233