gem5  v20.1.0.0
core.cc
Go to the documentation of this file.
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 {
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 {
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
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
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 
129 inline CallbackQueue &
131 {
132  static CallbackQueue theQueue;
133  return theQueue;
134 }
135 
139 void
140 registerExitCallback(const std::function<void()> &callback)
141 {
142  exitCallbacks().push_back(callback);
143 }
144 
149 void
151 {
153  exitCallbacks().clear();
154 
155  cout.flush();
156 }
157 
doExitCleanup
void doExitCleanup()
Do C++ simulator exit processing.
Definition: core.cc:150
SimClock::Int::ns
Tick ns
nanosecond
Definition: core.cc:65
getClockFrequency
Tick getClockFrequency()
Definition: core.cc:118
SimClock::Float::MHz
double MHz
MHz.
Definition: core.cc:57
setClockFrequency
void setClockFrequency(Tick tps)
Definition: core.cc:112
Tick
uint64_t Tick
Tick count type.
Definition: types.hh:63
SimClock::Float::kHz
double kHz
kHz
Definition: core.cc:56
SimClock::Int::us
Tick us
microsecond
Definition: core.cc:64
OutputDirectory::setDirectory
void setDirectory(const std::string &dir)
Sets name of this directory.
Definition: output.cc:163
CallbackQueue
Definition: callback.hh:35
output.hh
SimClock::Frequency
Tick Frequency
The simulated frequency of curTick(). (In ticks per second)
Definition: core.cc:46
setOutputDir
void setOutputDir(const string &dir)
Definition: core.cc:121
exitCallbacks
CallbackQueue & exitCallbacks()
Queue of C++ callbacks to invoke on simulator exit.
Definition: core.cc:130
registerExitCallback
void registerExitCallback(const std::function< void()> &callback)
Register an exit callback.
Definition: core.cc:140
SimClock::Float::Hz
double Hz
These variables the inverse of above.
Definition: core.cc:55
cprintf
void cprintf(const char *format, const Args &...args)
Definition: cprintf.hh:152
SimClock::Int::s
Tick s
second
Definition: core.cc:62
SimClock::Int::ms
Tick ms
millisecond
Definition: core.cc:63
clockFrequencyFixed
bool clockFrequencyFixed()
Definition: core.cc:109
SimClock::Int::ps
Tick ps
picosecond
Definition: core.cc:66
cprintf.hh
SimClock
These are variables that are set based on the simulator frequency.
Definition: core.cc:44
core.hh
panic_if
#define panic_if(cond,...)
Conditional panic macro that checks the supplied condition and only panics if the condition is true a...
Definition: logging.hh:197
fixClockFrequency
void fixClockFrequency()
Definition: core.cc:81
std
Overload hash function for BasicBlockRange type.
Definition: vec_reg.hh:587
CallbackQueue::process
void process()
Definition: callback.hh:46
logging.hh
simout
OutputDirectory simout
Definition: output.cc:61
callback.hh
SimClock::Float::GHz
double GHz
GHz.
Definition: core.cc:58
eventq.hh

Generated on Wed Sep 30 2020 14:02:14 for gem5 by doxygen 1.8.17