sim/root.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
  29 #include <cstring>
  30 #include <fstream>
  31 #include <list>
  32 #include <string>
  33 #include <vector>
  34
  35 #include "base/misc.hh"
  36 #include "base/output.hh"
  37 #include "sim/builder.hh"
  38 #include "sim/host.hh"
  39 #include "sim/sim_events.hh"
  40 #include "sim/sim_object.hh"
  41 #include "sim/root.hh"
  42
  43 using namespace std;
  44
  45 Tick curTick = 0;
  46 ostream *outputStream;
  47 ostream *configStream;
  48
  49 /// The simulated frequency of curTick. (This is only here for a short time)
  50 Tick ticksPerSecond;
  51
  52 namespace Clock {
  53 /// The simulated frequency of curTick. (In ticks per second)
  54 Tick Frequency;
  55
  56 namespace Float {
  57 double s;
  58 double ms;
  59 double us;
  60 double ns;
  61 double ps;
  62
  63 double Hz;
  64 double kHz;
  65 double MHz;
  66 double GHZ;
  67 /* namespace Float */ }
  68
  69 namespace Int {
  70 Tick s;
  71 Tick ms;
  72 Tick us;
  73 Tick ns;
  74 Tick ps;
  75 /* namespace Float */ }
  76
  77 /* namespace Clock */ }
  78
  79
  80 // Dummy Object
  81 class Root : public SimObject
  82 {
  83   private:
  84     Tick max_tick;
  85     Tick progress_interval;
  86
  87   public:
  88     Root(const std::string &name, Tick maxtick, Tick pi)
  89         : SimObject(name), max_tick(maxtick), progress_interval(pi)
  90     {}
  91
  92     virtual void startup();
  93 };
  94
  95 void
  96 Root::startup()
  97 {
  98     if (max_tick != 0)
  99         new SimExitEvent(curTick + max_tick, "reached maximum cycle count");
 100
 101     if (progress_interval != 0)
 102         new ProgressEvent(&mainEventQueue, progress_interval);
 103 }
 104
 105 BEGIN_DECLARE_SIM_OBJECT_PARAMS(Root)
 106
 107     Param<Tick> clock;
 108     Param<Tick> max_tick;
 109     Param<Tick> progress_interval;
 110     Param<string> output_file;
 111
 112 END_DECLARE_SIM_OBJECT_PARAMS(Root)
 113
 114 BEGIN_INIT_SIM_OBJECT_PARAMS(Root)
 115
 116     INIT_PARAM(clock, "tick frequency"),
 117     INIT_PARAM(max_tick, "maximum simulation time"),
 118     INIT_PARAM(progress_interval, "print a progress message"),
 119     INIT_PARAM(output_file, "file to dump simulator output to")
 120
 121 END_INIT_SIM_OBJECT_PARAMS(Root)
 122
 123 CREATE_SIM_OBJECT(Root)
 124 {
 125     static bool created = false;
 126     if (created)
 127         panic("only one root object allowed!");
 128
 129     created = true;
 130
 131     outputStream = simout.find(output_file);
 132     Root *root = new Root(getInstanceName(), max_tick, progress_interval);
 133
 134     using namespace Clock;
 135     Frequency = clock;
 136     Float::s = static_cast<double>(Frequency);
 137     Float::ms = Float::s / 1.0e3;
 138     Float::us = Float::s / 1.0e6;
 139     Float::ns = Float::s / 1.0e9;
 140     Float::ps = Float::s / 1.0e12;
 141
 142     Float::Hz  = 1.0 / Float::s;
 143     Float::kHz = 1.0 / Float::ms;
 144     Float::MHz = 1.0 / Float::us;
 145     Float::GHZ = 1.0 / Float::ns;
 146
 147     Int::s  = Frequency;
 148     Int::ms = Int::s / 1000;
 149     Int::us = Int::ms / 1000;
 150     Int::ns = Int::us / 1000;
 151     Int::ps = Int::ns / 1000;
 152
 153     return root;
 154 }
 155
 156 REGISTER_SIM_OBJECT("Root", Root)