src/sim/ticked_object.cc

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