gem5  v21.0.1.0
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
mem_footprint.cc
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016 Google Inc.
3  * All rights reserved.
4  *
5  * The license below extends only to copyright in the software and
6  * shall not be construed as granting a license to any other
7  * intellectual property including but not limited to intellectual
8  * property relating to a hardware implementation of the
9  * functionality of the software licensed hereunder. You may use the
10  * software subject to the license terms below provided that you
11  * ensure that this notice is replicated unmodified and in its
12  * entirety in all distributions of the software, modified or
13  * 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 
40 
41 #include "base/intmath.hh"
42 #include "params/MemFootprintProbe.hh"
43 
44 MemFootprintProbe::MemFootprintProbe(const MemFootprintProbeParams &p)
45  : BaseMemProbe(p),
46  cacheLineSizeLg2(floorLog2(p.system->cacheLineSize())),
47  pageSizeLg2(floorLog2(p.page_size)),
48  totalCacheLinesInMem(p.system->memSize() / p.system->cacheLineSize()),
49  totalPagesInMem(p.system->memSize() / p.page_size),
50  cacheLines(),
51  cacheLinesAll(),
52  pages(),
53  pagesAll(),
54  system(p.system),
55  stats(this)
56 {
58  "MemFootprintProbe expects cache line size is power of 2.");
59  fatal_if(!isPowerOf2(p.page_size),
60  "MemFootprintProbe expects page size parameter is power of 2");
61 }
62 
65  : Stats::Group(parent),
66  ADD_STAT(cacheLine, UNIT_COUNT,
67  "Memory footprint at cache line granularity"),
68  ADD_STAT(cacheLineTotal, UNIT_COUNT,
69  "Total memory footprint at cache line granularity since "
70  "simulation begin"),
71  ADD_STAT(page, UNIT_COUNT, "Memory footprint at page granularity"),
72  ADD_STAT(pageTotal, UNIT_COUNT,
73  "Total memory footprint at page granularity since simulation "
74  "begin")
75 {
76  using namespace Stats;
77  // clang-format off
82  // clang-format on
83  registerResetCallback([parent]() { parent->statReset(); });
84 }
85 
86 void
88 {
89  set->insert(addr);
90  assert(set->size() <= limit);
91 }
92 
93 void
95 {
96  if (!pi.cmd.isRequest() || !system->isMemAddr(pi.addr))
97  return;
98 
99  const Addr cl_addr = (pi.addr >> cacheLineSizeLg2) << cacheLineSizeLg2;
100  const Addr page_addr = (pi.addr >> pageSizeLg2) << pageSizeLg2;
103  insertAddr(page_addr, &pages, totalPagesInMem);
104  insertAddr(page_addr, &pagesAll, totalPagesInMem);
105 
106  assert(cacheLines.size() <= cacheLinesAll.size());
107  assert(pages.size() <= pagesAll.size());
108 
109  stats.cacheLine = cacheLines.size() << cacheLineSizeLg2;
110  stats.cacheLineTotal = cacheLinesAll.size() << cacheLineSizeLg2;
111  stats.page = pages.size() << pageSizeLg2;
112  stats.pageTotal = pagesAll.size() << pageSizeLg2;
113 }
114 
115 void
117 {
118  cacheLines.clear();
119  pages.clear();
120 }
MemFootprintProbe::cacheLineSizeLg2
const uint8_t cacheLineSizeLg2
Cache Line size for footprint measurement (log2)
Definition: mem_footprint.hh:65
MemFootprintProbe::pagesAll
AddrSet pagesAll
Definition: mem_footprint.hh:95
MemFootprintProbe::system
System * system
Definition: mem_footprint.hh:96
MemFootprintProbe
Probe to track footprint of accessed memory Two granularity of footprint measurement i....
Definition: mem_footprint.hh:54
ProbePoints::PacketInfo::addr
Addr addr
Definition: mem.hh:55
MemFootprintProbe::MemFootprintProbeStats::page
Stats::Scalar page
Footprint at page granularity.
Definition: mem_footprint.hh:83
MemFootprintProbe::pageSizeLg2
const uint8_t pageSizeLg2
Page size for footprint measurement (log2)
Definition: mem_footprint.hh:67
MemFootprintProbe::handleRequest
void handleRequest(const ProbePoints::PacketInfo &pkt_info) override
Callback to analyse intercepted Packets.
Definition: mem_footprint.cc:94
MemFootprintProbe::MemFootprintProbe
MemFootprintProbe(const MemFootprintProbeParams &p)
Definition: mem_footprint.cc:44
MemFootprintProbe::cacheLinesAll
AddrSet cacheLinesAll
Definition: mem_footprint.hh:91
MemFootprintProbe::insertAddr
void insertAddr(Addr addr, AddrSet *set, uint64_t limit)
Definition: mem_footprint.cc:87
Stats::DataWrap::flags
Derived & flags(Flags _flags)
Set the flags and marks this stat to print at the end of simulation.
Definition: statistics.hh:339
X86ISA::system
Bitfield< 15 > system
Definition: misc.hh:997
MemFootprintProbe::AddrSet
std::unordered_set< Addr > AddrSet
Definition: mem_footprint.hh:57
ADD_STAT
#define ADD_STAT(n,...)
Convenience macro to add a stat to a statistics group.
Definition: group.hh:71
Stats::registerResetCallback
void registerResetCallback(const std::function< void()> &callback)
Register a callback that should be called whenever statistics are reset.
Definition: statistics.cc:267
Stats::Group::stats
std::vector< Info * > stats
Definition: group.hh:215
MemCmd::isRequest
bool isRequest() const
Definition: packet.hh:203
UNIT_COUNT
#define UNIT_COUNT
Definition: units.hh:49
Addr
uint64_t Addr
Address type This will probably be moved somewhere else in the near future.
Definition: types.hh:148
mem_footprint.hh
Stats::nozero
const FlagsType nozero
Don't print if this is zero.
Definition: info.hh:58
MemFootprintProbe::pages
AddrSet pages
Definition: mem_footprint.hh:93
MemFootprintProbe::MemFootprintProbeStats::cacheLineTotal
Stats::Scalar cacheLineTotal
Footprint at cache line size granularity, since simulation begin.
Definition: mem_footprint.hh:81
MemFootprintProbe::cacheLines
AddrSet cacheLines
Definition: mem_footprint.hh:89
X86ISA::addr
Bitfield< 3 > addr
Definition: types.hh:80
MemFootprintProbe::totalCacheLinesInMem
const uint64_t totalCacheLinesInMem
Definition: mem_footprint.hh:68
floorLog2
std::enable_if_t< std::is_integral< T >::value, int > floorLog2(T x)
Definition: intmath.hh:63
ProbePoints::PacketInfo::cmd
MemCmd cmd
Definition: mem.hh:54
MemFootprintProbe::statReset
void statReset()
Definition: mem_footprint.cc:116
X86ISA::limit
BitfieldType< SegDescriptorLimit > limit
Definition: misc.hh:924
MemFootprintProbe::MemFootprintProbeStats::MemFootprintProbeStats
MemFootprintProbeStats(MemFootprintProbe *parent)
Definition: mem_footprint.cc:64
Stats
Definition: statistics.cc:53
MemFootprintProbe::MemFootprintProbeStats::cacheLine
Stats::Scalar cacheLine
Footprint at cache line size granularity.
Definition: mem_footprint.hh:79
MemFootprintProbe::MemFootprintProbeStats::pageTotal
Stats::Scalar pageTotal
Footprint at page granularity, since simulation begin.
Definition: mem_footprint.hh:85
MipsISA::p
Bitfield< 0 > p
Definition: pra_constants.hh:323
intmath.hh
System::cacheLineSize
unsigned int cacheLineSize() const
Get the cache line size of the system.
Definition: system.hh:302
fatal_if
#define fatal_if(cond,...)
Conditional fatal macro that checks the supplied condition and only causes a fatal error if the condi...
Definition: logging.hh:219
isPowerOf2
bool isPowerOf2(const T &n)
Definition: intmath.hh:102
ProbePoints::PacketInfo
A struct to hold on to the essential fields from a packet, so that the packet and underlying request ...
Definition: mem.hh:53
System::isMemAddr
bool isMemAddr(Addr addr) const
Check if a physical address is within a range of a memory that is part of the global address map.
Definition: system.cc:407
MemFootprintProbe::totalPagesInMem
const uint64_t totalPagesInMem
Definition: mem_footprint.hh:69
Stats::nonan
const FlagsType nonan
Don't print if this is NAN.
Definition: info.hh:60
BaseMemProbe
Base class for memory system probes accepting Packet instances.
Definition: base.hh:61

Generated on Tue Jun 22 2021 15:28:29 for gem5 by doxygen 1.8.17