src/sim/core.cc

   1 /*
   2  * Copyright (c) 2006 The Regents of The University of Michigan
   3  * Copyright (c) 2013 Advanced Micro Devices, Inc.
   4  * Copyright (c) 2013 Mark D. Hill and David A. Wood
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions are
   9  * met: redistributions of source code must retain the above copyright
  10  * notice, this list of conditions and the following disclaimer;
  11  * redistributions in binary form must reproduce the above copyright
  12  * notice, this list of conditions and the following disclaimer in the
  13  * documentation and/or other materials provided with the distribution;
  14  * neither the name of the copyright holders nor the names of its
  15  * contributors may be used to endorse or promote products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #include "sim/core.hh"
  32
  33 #include <iostream>
  34 #include <string>
  35
  36 #include "base/callback.hh"
  37 #include "base/cprintf.hh"
  38 #include "base/logging.hh"
  39 #include "base/output.hh"
  40 #include "sim/eventq.hh"
  41
  42 using namespace std;
  43
  44 namespace SimClock {
  45 /// The simulated frequency of curTick(). (In ticks per second)
  46 Tick Frequency;
  47
  48 namespace Float {
  49 double s;
  50 double ms;
  51 double us;
  52 double ns;
  53 double ps;
  54
  55 double Hz;
  56 double kHz;
  57 double MHz;
  58 double GHz;
  59 } // namespace Float
  60
  61 namespace Int {
  62 Tick s;
  63 Tick ms;
  64 Tick us;
  65 Tick ns;
  66 Tick ps;
  67 } // namespace Float
  68
  69 } // namespace SimClock
  70
  71 namespace {
  72
  73 bool _clockFrequencyFixed = false;
  74
  75 // Default to 1 THz (1 Tick == 1 ps)
  76 Tick _ticksPerSecond = 1e12;
  77
  78 } // anonymous namespace
  79
  80 void
  81 fixClockFrequency()
  82 {
  83     if (_clockFrequencyFixed)
  84         return;
  85
  86     using namespace SimClock;
  87     Frequency = _ticksPerSecond;
  88     Float::s = static_cast<double>(Frequency);
  89     Float::ms = Float::s / 1.0e3;
  90     Float::us = Float::s / 1.0e6;
  91     Float::ns = Float::s / 1.0e9;
  92     Float::ps = Float::s / 1.0e12;
  93
  94     Float::Hz  = 1.0 / Float::s;
  95     Float::kHz = 1.0 / Float::ms;
  96     Float::MHz = 1.0 / Float::us;
  97     Float::GHz = 1.0 / Float::ns;
  98
  99     Int::s  = Frequency;
 100     Int::ms = Int::s / 1000;
 101     Int::us = Int::ms / 1000;
 102     Int::ns = Int::us / 1000;
 103     Int::ps = Int::ns / 1000;
 104
 105     cprintf("Global frequency set at %d ticks per second\n", _ticksPerSecond);
 106
 107     _clockFrequencyFixed = true;
 108 }
 109 bool clockFrequencyFixed() { return _clockFrequencyFixed; }
 110
 111 void
 112 setClockFrequency(Tick tps)
 113 {
 114     panic_if(_clockFrequencyFixed,
 115             "Global frequency already fixed at %f ticks/s.", _ticksPerSecond);
 116     _ticksPerSecond = tps;
 117 }
 118 Tick getClockFrequency() { return _ticksPerSecond; }
 119
 120 void
 121 setOutputDir(const string &dir)
 122 {
 123     simout.setDirectory(dir);
 124 }
 125
 126 /**
 127  * Queue of C++ callbacks to invoke on simulator exit.
 128  */
 129 inline CallbackQueue &
 130 exitCallbacks()
 131 {
 132     static CallbackQueue theQueue;
 133     return theQueue;
 134 }
 135
 136 /**
 137  * Register an exit callback.
 138  */
 139 void
 140 registerExitCallback(Callback *callback)
 141 {
 142     exitCallbacks().add(callback);
 143 }
 144
 145 /**
 146  * Do C++ simulator exit processing.  Exported to Python to be invoked
 147  * when simulator terminates via Python's atexit mechanism.
 148  */
 149 void
 150 doExitCleanup()
 151 {
 152     exitCallbacks().process();
 153     exitCallbacks().clear();
 154
 155     cout.flush();
 156 }
 157