ticked_object.cc revision 11800 
1/*
2 * Copyright (c) 2013-2014 ARM Limited
3 * All rights reserved
4 *
5 * The license below extends only to copyright in the software and shall
6 * not be construed as granting a license to any other intellectual
7 * property including but not limited to intellectual property relating
8 * to a hardware implementation of the functionality of the software
9 * licensed hereunder.  You may use the software subject to the license
10 * terms below provided that you ensure that this notice is replicated
11 * unmodified and in its entirety in all distributions of the software,
12 * modified or unmodified, in source code or in binary form.
13 *
14 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions are
16 * met: redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer;
18 * redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution;
21 * neither the name of the copyright holders nor the names of its
22 * contributors may be used to endorse or promote products derived from
23 * this software without specific prior written permission.
24 *
25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 *
37 * Authors: Andrew Bardsley
38 */
39
40#include "sim/ticked_object.hh"
41
42#include "params/TickedObject.hh"
43#include "sim/clocked_object.hh"
44
45Ticked::Ticked(ClockedObject &object_,
46    Stats::Scalar *imported_num_cycles,
47    Event::Priority priority) :
48    object(object_),
49    event(*this, priority),
50    running(false),
51    lastStopped(0),
52    /* Allocate numCycles if an external stat wasn't passed in */
53    numCyclesLocal((imported_num_cycles ? NULL : new Stats::Scalar)),
54    numCycles((imported_num_cycles ? *imported_num_cycles :
55        *numCyclesLocal))
56{ }
57
58void
59Ticked::regStats()
60{
61    if (numCyclesLocal) {
62        numCycles
63            .name(object.name() + ".tickCycles")
64            .desc("Number of cycles that the object ticked or was stopped");
65    }
66
67    tickCycles
68        .name(object.name() + ".tickCycles")
69        .desc("Number of cycles that the object actually ticked");
70
71    idleCycles
72        .name(object.name() + ".idleCycles")
73        .desc("Total number of cycles that the object has spent stopped");
74    idleCycles = numCycles - tickCycles;
75}
76
77void
78Ticked::serialize(CheckpointOut &cp) const
79{
80    uint64_t lastStoppedUint = lastStopped;
81
82    paramOut(cp, "lastStopped", lastStoppedUint);
83}
84
85void
86Ticked::unserialize(CheckpointIn &cp)
87{
88    uint64_t lastStoppedUint = 0;
89
90    /* lastStopped is optional on checkpoint restore as this object may be
91     *  being restored from one which has a common base (and so possibly
92     *  many common checkpointed values) but where Ticked is used in the
93     *  checkpointed object but not this one.
94     *  An example would be a CPU model using Ticked restores from a
95     *  simple CPU without without Ticked */
96    optParamIn(cp, "lastStopped", lastStoppedUint);
97
98    lastStopped = Cycles(lastStoppedUint);
99}
100
101TickedObject::TickedObject(TickedObjectParams *params,
102    Event::Priority priority) :
103    ClockedObject(params),
104    /* Make numCycles in Ticked */
105    Ticked(*this, NULL, priority)
106{ }
107
108void
109TickedObject::regStats()
110{
111    Ticked::regStats();
112}
113
114void
115TickedObject::serialize(CheckpointOut &cp) const
116{
117    Ticked::serialize(cp);
118    ClockedObject::serialize(cp);
119}
120void
121TickedObject::unserialize(CheckpointIn &cp)
122{
123    Ticked::unserialize(cp);
124    ClockedObject::unserialize(cp);
125}
126