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
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.
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.
31 #ifndef __SIM_CORE_HH__
32 #define __SIM_CORE_HH__
34 /** @file This header provides some core simulator functionality such as time
35 * information, output directory and exit events
41 #include "base/types.hh"
42 // @todo The next include is not needed in this file, but must be kept
43 // until the transitive includes are fixed
44 #include "sim/cur_tick.hh"
46 /// These are variables that are set based on the simulator frequency
49 extern Tick Frequency; ///< The number of ticks that equal one second
53 /** These variables equal the number of ticks in the unit of time they're
54 * named after in a double.
57 extern double s; ///< second
58 extern double ms; ///< millisecond
59 extern double us; ///< microsecond
60 extern double ns; ///< nanosecond
61 extern double ps; ///< picosecond
64 /** These variables the inverse of above. They're all < 1.
67 extern double Hz; ///< Hz
68 extern double kHz; ///< kHz
69 extern double MHz; ///< MHz
70 extern double GHz; ///< GHz
74 /** These variables equal the number of ticks in the unit of time they're
75 * named after in a 64 bit integer.
80 extern Tick s; ///< second
81 extern Tick ms; ///< millisecond
82 extern Tick us; ///< microsecond
83 extern Tick ns; ///< nanosecond
84 extern Tick ps; ///< picosecond
87 } // namespace SimClock
90 void fixClockFrequency();
91 bool clockFrequencyFixed();
93 void setClockFrequency(Tick ticksPerSecond);
94 Tick getClockFrequency(); // Ticks per second.
96 void setOutputDir(const std::string &dir);
98 void registerExitCallback(const std::function<void()> &callback);
101 #endif /* __SIM_CORE_HH__ */