clocked_object.hh revision 14162 
1/*
2 * Copyright (c) 2012-2013, 2015-2016 ARM Limited
3 * Copyright (c) 2013 Cornell University
4 * All rights reserved
5 *
6 * The license below extends only to copyright in the software and shall
7 * not be construed as granting a license to any other intellectual
8 * property including but not limited to intellectual property relating
9 * to a hardware implementation of the functionality of the software
10 * licensed hereunder.  You may use the software subject to the license
11 * terms below provided that you ensure that this notice is replicated
12 * unmodified and in its entirety in all distributions of the software,
13 * modified or unmodified, in source code or in binary form.
14 *
15 * Redistribution and use in source and binary forms, with or without
16 * modification, are permitted provided that the following conditions are
17 * met: redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer;
19 * redistributions in binary form must reproduce the above copyright
20 * notice, this list of conditions and the following disclaimer in the
21 * documentation and/or other materials provided with the distribution;
22 * neither the name of the copyright holders nor the names of its
23 * contributors may be used to endorse or promote products derived from
24 * this software without specific prior written permission.
25 *
26 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
27 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
28 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
29 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
30 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
31 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
32 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
33 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
34 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
35 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
36 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 *
38 * Authors: Andreas Hansson
39 *          Christopher Torng
40 *          Akash Bagdia
41 *          David Guillen Fandos
42 */
43
44/**
45 * @file
46 * ClockedObject declaration and implementation.
47 */
48
49#ifndef __SIM_CLOCKED_OBJECT_HH__
50#define __SIM_CLOCKED_OBJECT_HH__
51
52#include "base/callback.hh"
53#include "base/intmath.hh"
54#include "enums/PwrState.hh"
55#include "params/ClockedObject.hh"
56#include "sim/core.hh"
57#include "sim/clock_domain.hh"
58#include "sim/sim_object.hh"
59
60/**
61 * Helper class for objects that need to be clocked. Clocked objects
62 * typically inherit from this class. Objects that need SimObject
63 * functionality as well should inherit from ClockedObject.
64 */
65class Clocked
66{
67
68  private:
69    // the tick value of the next clock edge (>= curTick()) at the
70    // time of the last call to update()
71    mutable Tick tick;
72
73    // The cycle counter value corresponding to the current value of
74    // 'tick'
75    mutable Cycles cycle;
76
77    /**
78     *  Align cycle and tick to the next clock edge if not already done. When
79     *  complete, tick must be at least curTick().
80     */
81    void
82    update() const
83    {
84        // both tick and cycle are up-to-date and we are done, note
85        // that the >= is important as it captures cases where tick
86        // has already passed curTick()
87        if (tick >= curTick())
88            return;
89
90        // optimise for the common case and see if the tick should be
91        // advanced by a single clock period
92        tick += clockPeriod();
93        ++cycle;
94
95        // see if we are done at this point
96        if (tick >= curTick())
97            return;
98
99        // if not, we have to recalculate the cycle and tick, we
100        // perform the calculations in terms of relative cycles to
101        // allow changes to the clock period in the future
102        Cycles elapsedCycles(divCeil(curTick() - tick, clockPeriod()));
103        cycle += elapsedCycles;
104        tick += elapsedCycles * clockPeriod();
105    }
106
107    /**
108     * The clock domain this clocked object belongs to
109     */
110    ClockDomain &clockDomain;
111
112  protected:
113
114    /**
115     * Create a clocked object and set the clock domain based on the
116     * parameters.
117     */
118    Clocked(ClockDomain &clk_domain)
119        : tick(0), cycle(0), clockDomain(clk_domain)
120    {
121        // Register with the clock domain, so that if the clock domain
122        // frequency changes, we can update this object's tick.
123        clockDomain.registerWithClockDomain(this);
124    }
125
126    Clocked(Clocked &) = delete;
127    Clocked &operator=(Clocked &) = delete;
128
129    /**
130     * Virtual destructor due to inheritance.
131     */
132    virtual ~Clocked() { }
133
134    /**
135     * Reset the object's clock using the current global tick value. Likely
136     * to be used only when the global clock is reset. Currently, this done
137     * only when Ruby is done warming up the memory system.
138     */
139    void
140    resetClock() const
141    {
142        Cycles elapsedCycles(divCeil(curTick(), clockPeriod()));
143        cycle = elapsedCycles;
144        tick = elapsedCycles * clockPeriod();
145    }
146
147  public:
148
149    /**
150     * Update the tick to the current tick.
151     */
152    void updateClockPeriod() const { update(); }
153
154    /**
155     * Determine the tick when a cycle begins, by default the current one, but
156     * the argument also enables the caller to determine a future cycle. When
157     * curTick() is on a clock edge, the number of cycles in the parameter is
158     * added to curTick() to be returned. When curTick() is not aligned to a
159     * clock edge, the number of cycles in the parameter is added to the next
160     * clock edge.
161     *
162     * @param cycles The number of cycles into the future
163     *
164     * @return The start tick when the requested clock edge occurs. Precisely,
165     * this tick can be
166     *     curTick() + [0, clockPeriod()) + clockPeriod() * cycles
167     */
168    Tick
169    clockEdge(Cycles cycles=Cycles(0)) const
170    {
171        // align tick to the next clock edge
172        update();
173
174        // figure out when this future cycle is
175        return tick + clockPeriod() * cycles;
176    }
177
178    /**
179     * Determine the current cycle, corresponding to a tick aligned to
180     * a clock edge.
181     *
182     * @return When curTick() is on a clock edge, return the Cycle corresponding
183     * to that clock edge. When curTick() is not on a clock edge, return the
184     * Cycle corresponding to the next clock edge.
185     */
186    Cycles
187    curCycle() const
188    {
189        // align cycle to the next clock edge.
190        update();
191
192        return cycle;
193    }
194
195    /**
196     * Based on the clock of the object, determine the start tick of the first
197     * cycle that is at least one cycle in the future. When curTick() is at the
198     * current cycle edge, this returns the next clock edge. When calling this
199     * during the middle of a cycle, this returns 2 clock edges in the future.
200     *
201     * @return The start tick of the first cycle that is at least one cycle in
202     * the future. Precisely, the returned tick can be in the range
203     *     curTick() + [clockPeriod(), 2 * clockPeriod())
204     */
205    Tick nextCycle() const { return clockEdge(Cycles(1)); }
206
207    uint64_t frequency() const { return SimClock::Frequency / clockPeriod(); }
208
209    Tick clockPeriod() const { return clockDomain.clockPeriod(); }
210
211    double voltage() const { return clockDomain.voltage(); }
212
213    Cycles
214    ticksToCycles(Tick t) const
215    {
216        return Cycles(divCeil(t, clockPeriod()));
217    }
218
219    Tick cyclesToTicks(Cycles c) const { return clockPeriod() * c; }
220};
221
222/**
223 * The ClockedObject class extends the SimObject with a clock and
224 * accessor functions to relate ticks to the cycles of the object.
225 */
226class ClockedObject : public SimObject, public Clocked
227{
228  public:
229    ClockedObject(const ClockedObjectParams *p);
230
231    /** Parameters of ClockedObject */
232    typedef ClockedObjectParams Params;
233    const Params *
234    params() const
235    {
236        return reinterpret_cast<const Params*>(_params);
237    }
238
239    void serialize(CheckpointOut &cp) const override;
240    void unserialize(CheckpointIn &cp) override;
241
242    Enums::PwrState pwrState() const { return _currPwrState; }
243
244    std::string
245    pwrStateName() const
246    {
247        return Enums::PwrStateStrings[_currPwrState];
248    }
249
250    /** Returns the percentage residency for each power state */
251    std::vector<double> pwrStateWeights() const;
252
253    /**
254     * Record stats values like state residency by computing the time
255     * difference from previous update. Also, updates the previous evaluation
256     * tick once all stats are recorded.
257     * Usually called on power state change and stats dump callback.
258     */
259    void computeStats();
260
261    void pwrState(Enums::PwrState);
262    void regStats() override;
263
264  protected:
265
266    /** To keep track of the current power state */
267    Enums::PwrState _currPwrState;
268
269    Tick prvEvalTick;
270
271    Stats::Scalar numPwrStateTransitions;
272    Stats::Distribution pwrStateClkGateDist;
273    Stats::Vector pwrStateResidencyTicks;
274
275};
276
277class ClockedObjectDumpCallback : public Callback
278{
279    ClockedObject *co;
280  public:
281    ClockedObjectDumpCallback(ClockedObject *co_t) : co(co_t) {}
282    virtual void process() { co->computeStats(); };
283};
284
285#endif //__SIM_CLOCKED_OBJECT_HH__
286