ticked_object.cc revision 10320:82a4fa2d19a0 
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
42Ticked::Ticked(ClockedObject &object_,
43    Stats::Scalar *imported_num_cycles,
44    Event::Priority priority) :
45    object(object_),
46    event(*this, priority),
47    running(false),
48    lastStopped(0),
49    /* Allocate numCycles if an external stat wasn't passed in */
50    numCyclesLocal((imported_num_cycles ? NULL : new Stats::Scalar)),
51    numCycles((imported_num_cycles ? *imported_num_cycles :
52        *numCyclesLocal))
53{ }
54
55void
56Ticked::regStats()
57{
58    if (numCyclesLocal) {
59        numCycles
60            .name(object.name() + ".tickCycles")
61            .desc("Number of cycles that the object ticked or was stopped");
62    }
63
64    tickCycles
65        .name(object.name() + ".tickCycles")
66        .desc("Number of cycles that the object actually ticked");
67
68    idleCycles
69        .name(object.name() + ".idleCycles")
70        .desc("Total number of cycles that the object has spent stopped");
71    idleCycles = numCycles - tickCycles;
72}
73
74void
75Ticked::serialize(std::ostream &os)
76{
77    uint64_t lastStoppedUint = lastStopped;
78
79    paramOut(os, "lastStopped", lastStoppedUint);
80}
81
82void
83Ticked::unserialize(Checkpoint *cp, const std::string &section)
84{
85    uint64_t lastStoppedUint = 0;
86
87    /* lastStopped is optional on checkpoint restore as this object may be
88     *  being restored from one which has a common base (and so possibly
89     *  many common checkpointed values) but where Ticked is used in the
90     *  checkpointed object but not this one.
91     *  An example would be a CPU model using Ticked restores from a
92     *  simple CPU without without Ticked */
93    optParamIn(cp, section, "lastStopped", lastStoppedUint);
94
95    lastStopped = Cycles(lastStoppedUint);
96}
97
98TickedObject::TickedObject(TickedObjectParams *params,
99    Event::Priority priority) :
100    ClockedObject(params),
101    /* Make numCycles in Ticked */
102    Ticked(*this, NULL, priority)
103{ }
104
105void
106TickedObject::regStats()
107{
108    Ticked::regStats();
109}
110
111void
112TickedObject::serialize(std::ostream &os)
113{
114    Ticked::serialize(os);
115    ClockedObject::serialize(os);
116}
117void
118TickedObject::unserialize(Checkpoint *cp, const std::string &section)
119{
120    Ticked::unserialize(cp, section);
121    ClockedObject::unserialize(cp, section);
122}
123