core.hh revision 9356 
1/*
2 * Copyright (c) 2006 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 *          Steve Reinhardt
30 */
31
32#ifndef __SIM_CORE_HH__
33#define __SIM_CORE_HH__
34
35/** @file This header provides some core simulator functionality such as time
36 * information, output directory and exit events
37 */
38
39#include <string>
40
41#include "base/types.hh"
42#include "sim/eventq.hh"
43
44/// The universal simulation clock.
45inline Tick curTick() { return mainEventQueue.getCurTick(); }
46
47const Tick retryTime = 1000;
48
49/// These are variables that are set based on the simulator frequency
50///@{
51namespace SimClock {
52extern Tick Frequency; ///< The number of ticks that equal one second
53
54namespace Float {
55
56/** These variables equal the number of ticks in the unit of time they're
57 * named after in a double.
58 * @{
59 */
60extern double s;  ///< second
61extern double ms; ///< millisecond
62extern double us; ///< microsecond
63extern double ns; ///< nanosecond
64extern double ps; ///< picosecond
65/** @} */
66
67/** These variables the inverse of above. They're all < 1.
68 * @{
69 */
70extern double Hz;  ///< Hz
71extern double kHz; ///< kHz
72extern double MHz; ///< MHz
73extern double GHZ; ///< GHz
74/** @}*/
75} // namespace Float
76
77/** These variables equal the number of ticks in the unit of time they're
78 *  named after in a 64 bit integer.
79 *
80 * @{
81 */
82namespace Int {
83extern Tick s;  ///< second
84extern Tick ms; ///< millisecond
85extern Tick us; ///< microsecond
86extern Tick ns; ///< nanosecond
87extern Tick ps; ///< picosecond
88/** @} */
89} // namespace Int
90} // namespace SimClock
91/** @} */
92void setClockFrequency(Tick ticksPerSecond);
93
94void setOutputDir(const std::string &dir);
95
96class Callback;
97void registerExitCallback(Callback *callback);
98void doExitCleanup();
99
100#endif /* __SIM_CORE_HH__ */
101