2 * Copyright (c) 2011 Advanced Micro Devices, Inc.
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.
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.
32 * @file This file defines the Root simobject and the methods used to control
33 * the time syncing mechanism provided through it.
35 * Time syncing prevents simulated time from passing faster than real time. It
36 * works by scheduling a periodic event that checks to see if its simulated
37 * period is shorter than its real period. If it is, it stalls the simulation
38 * until they're equal.
41 #ifndef __SIM_ROOT_HH__
42 #define __SIM_ROOT_HH__
44 #include "base/time.hh"
45 #include "params/Root.hh"
46 #include "sim/eventq.hh"
47 #include "sim/sim_object.hh"
49 class Root : public SimObject
63 EventWrapper<Root, &Root::timeSync> syncEvent;
64 friend class EventWrapper<Root, &Root::timeSync>;
68 * Use this function to get a pointer to the single Root object in the
69 * simulation. This function asserts that such an object has actual been
70 * constructed to avoid having to perform that check everywhere the root
71 * is used. This is to allow calling the functions below.
73 * @return Pointer to the single root object.
84 /// Check whether time syncing is enabled.
85 bool timeSyncEnabled() const { return _enabled; }
86 /// Retrieve the period for the sync event.
87 const Time timeSyncPeriod() const { return _period; }
88 /// Retrieve the threshold for time remaining to spin wait.
89 const Time timeSyncSpinThreshold() const { return _spinThreshold; }
91 /// Enable or disable time syncing.
92 void timeSyncEnable(bool en);
93 /// Configure the period for time sync events.
94 void timeSyncPeriod(Time newPeriod);
95 /// Set the threshold for time remaining to spin wait.
96 void timeSyncSpinThreshold(Time newThreshold);
98 typedef RootParams Params;
102 return dynamic_cast<const Params *>(_params);
107 /** Schedule the timesync event at loadState() so that curTick is correct
109 void loadState(Checkpoint *cp);
111 /** Schedule the timesync event at initState() when not unserializing
116 #endif // __SIM_ROOT_HH__