core.hh revision 8737
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 43/// The universal simulation clock. 44extern Tick _curTick; 45 46inline Tick curTick() { return _curTick; } 47inline void curTick(Tick newVal) { _curTick = newVal; } 48 49const Tick retryTime = 1000; 50 51/// These are variables that are set based on the simulator frequency 52///@{ 53namespace SimClock { 54extern Tick Frequency; ///< The number of ticks that equal one second 55 56namespace Float { 57 58/** These variables equal the number of ticks in the unit of time they're 59 * named after in a double. 60 * @{ 61 */ 62extern double s; ///< second 63extern double ms; ///< millisecond 64extern double us; ///< microsecond 65extern double ns; ///< nanosecond 66extern double ps; ///< picosecond 67/** @} */ 68 69/** These variables the inverse of above. They're all < 1. 70 * @{ 71 */ 72extern double Hz; ///< Hz 73extern double kHz; ///< kHz 74extern double MHz; ///< MHz 75extern double GHZ; ///< GHz 76/** @}*/ 77} // namespace Float 78 79/** These variables equal the number of ticks in the unit of time they're 80 * named after in a 64 bit integer. 81 * 82 * @{ 83 */ 84namespace Int { 85extern Tick s; ///< second 86extern Tick ms; ///< millisecond 87extern Tick us; ///< microsecond 88extern Tick ns; ///< nanosecond 89extern Tick ps; ///< picosecond 90/** @} */ 91} // namespace Int 92} // namespace SimClock 93/** @} */ 94void setClockFrequency(Tick ticksPerSecond); 95 96void setOutputDir(const std::string &dir); 97 98class Callback; 99void registerExitCallback(Callback *callback); 100void doExitCleanup(); 101 102#endif /* __SIM_CORE_HH__ */ 103