2 * Copyright (c) 2012-2013, 2015, 2018 ARM Limited
3 * Copyright (c) 2016 Google Inc.
4 * Copyright (c) 2017, Centre National de la Recherche Scientifique
7 * The license below extends only to copyright in the software and shall
8 * not be construed as granting a license to any other intellectual
9 * property including but not limited to intellectual property relating
10 * to a hardware implementation of the functionality of the software
11 * licensed hereunder. You may use the software subject to the license
12 * terms below provided that you ensure that this notice is replicated
13 * unmodified and in its entirety in all distributions of the software,
14 * modified or unmodified, in source code or in binary form.
16 * Redistribution and use in source and binary forms, with or without
17 * modification, are permitted provided that the following conditions are
18 * met: redistributions of source code must retain the above copyright
19 * notice, this list of conditions and the following disclaimer;
20 * redistributions in binary form must reproduce the above copyright
21 * notice, this list of conditions and the following disclaimer in the
22 * documentation and/or other materials provided with the distribution;
23 * neither the name of the copyright holders nor the names of its
24 * contributors may be used to endorse or promote products derived from
25 * this software without specific prior written permission.
27 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
28 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
29 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
30 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
31 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
32 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
33 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
34 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
35 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
36 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
37 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 * Authors: Thomas Grass
45 #include "mem/comm_monitor.hh"
47 #include "base/trace.hh"
48 #include "debug/CommMonitor.hh"
49 #include "sim/stats.hh"
51 CommMonitor::CommMonitor(Params
* params
)
53 masterPort(name() + "-master", *this),
54 slavePort(name() + "-slave", *this),
55 samplePeriodicEvent([this]{ samplePeriodic(); }, name()),
56 samplePeriodTicks(params
->sample_period
),
57 samplePeriod(params
->sample_period
/ SimClock::Float::s
),
61 "Created monitor %s with sample period %d ticks (%f ms)\n",
62 name(), samplePeriodTicks
, samplePeriod
* 1E3
);
66 CommMonitorParams::create()
68 return new CommMonitor(this);
74 // make sure both sides of the monitor are connected
75 if (!slavePort
.isConnected() || !masterPort
.isConnected())
76 fatal("Communication monitor is not connected on both sides.\n");
80 CommMonitor::regProbePoints()
82 ppPktReq
.reset(new ProbePoints::Packet(getProbeManager(), "PktRequest"));
83 ppPktResp
.reset(new ProbePoints::Packet(getProbeManager(), "PktResponse"));
87 CommMonitor::getPort(const std::string
&if_name
, PortID idx
)
89 if (if_name
== "master") {
91 } else if (if_name
== "slave") {
94 return SimObject::getPort(if_name
, idx
);
99 CommMonitor::recvFunctional(PacketPtr pkt
)
101 masterPort
.sendFunctional(pkt
);
105 CommMonitor::recvFunctionalSnoop(PacketPtr pkt
)
107 slavePort
.sendFunctionalSnoop(pkt
);
111 CommMonitor::MonitorStats::updateReqStats(
112 const ProbePoints::PacketInfo
& pkt_info
, bool is_atomic
,
113 bool expects_response
)
115 if (pkt_info
.cmd
.isRead()) {
116 // Increment number of observed read transactions
117 if (!disableTransactionHists
)
120 // Get sample of burst length
121 if (!disableBurstLengthHists
)
122 readBurstLengthHist
.sample(pkt_info
.size
);
124 // Sample the masked address
125 if (!disableAddrDists
)
126 readAddrDist
.sample(pkt_info
.addr
& readAddrMask
);
128 if (!disableITTDists
) {
129 // Sample value of read-read inter transaction time
130 if (timeOfLastRead
!= 0)
131 ittReadRead
.sample(curTick() - timeOfLastRead
);
132 timeOfLastRead
= curTick();
134 // Sample value of req-req inter transaction time
135 if (timeOfLastReq
!= 0)
136 ittReqReq
.sample(curTick() - timeOfLastReq
);
137 timeOfLastReq
= curTick();
139 if (!is_atomic
&& !disableOutstandingHists
&& expects_response
)
140 ++outstandingReadReqs
;
142 } else if (pkt_info
.cmd
.isWrite()) {
144 if (!disableTransactionHists
)
147 if (!disableBurstLengthHists
)
148 writeBurstLengthHist
.sample(pkt_info
.size
);
150 // Update the bandwidth stats on the request
151 if (!disableBandwidthHists
) {
152 writtenBytes
+= pkt_info
.size
;
153 totalWrittenBytes
+= pkt_info
.size
;
156 // Sample the masked write address
157 if (!disableAddrDists
)
158 writeAddrDist
.sample(pkt_info
.addr
& writeAddrMask
);
160 if (!disableITTDists
) {
161 // Sample value of write-to-write inter transaction time
162 if (timeOfLastWrite
!= 0)
163 ittWriteWrite
.sample(curTick() - timeOfLastWrite
);
164 timeOfLastWrite
= curTick();
166 // Sample value of req-to-req inter transaction time
167 if (timeOfLastReq
!= 0)
168 ittReqReq
.sample(curTick() - timeOfLastReq
);
169 timeOfLastReq
= curTick();
172 if (!is_atomic
&& !disableOutstandingHists
&& expects_response
)
173 ++outstandingWriteReqs
;
178 CommMonitor::MonitorStats::updateRespStats(
179 const ProbePoints::PacketInfo
& pkt_info
, Tick latency
, bool is_atomic
)
181 if (pkt_info
.cmd
.isRead()) {
182 // Decrement number of outstanding read requests
183 if (!is_atomic
&& !disableOutstandingHists
) {
184 assert(outstandingReadReqs
!= 0);
185 --outstandingReadReqs
;
188 if (!disableLatencyHists
)
189 readLatencyHist
.sample(latency
);
191 // Update the bandwidth stats based on responses for reads
192 if (!disableBandwidthHists
) {
193 readBytes
+= pkt_info
.size
;
194 totalReadBytes
+= pkt_info
.size
;
197 } else if (pkt_info
.cmd
.isWrite()) {
198 // Decrement number of outstanding write requests
199 if (!is_atomic
&& !disableOutstandingHists
) {
200 assert(outstandingWriteReqs
!= 0);
201 --outstandingWriteReqs
;
204 if (!disableLatencyHists
)
205 writeLatencyHist
.sample(latency
);
210 CommMonitor::recvAtomic(PacketPtr pkt
)
212 const bool expects_response(pkt
->needsResponse() &&
213 !pkt
->cacheResponding());
214 ProbePoints::PacketInfo
req_pkt_info(pkt
);
215 ppPktReq
->notify(req_pkt_info
);
217 const Tick
delay(masterPort
.sendAtomic(pkt
));
219 stats
.updateReqStats(req_pkt_info
, true, expects_response
);
220 if (expects_response
)
221 stats
.updateRespStats(req_pkt_info
, delay
, true);
223 assert(pkt
->isResponse());
224 ProbePoints::PacketInfo
resp_pkt_info(pkt
);
225 ppPktResp
->notify(resp_pkt_info
);
230 CommMonitor::recvAtomicSnoop(PacketPtr pkt
)
232 return slavePort
.sendAtomicSnoop(pkt
);
236 CommMonitor::recvTimingReq(PacketPtr pkt
)
238 // should always see a request
239 assert(pkt
->isRequest());
241 // Store relevant fields of packet, because packet may be modified
242 // or even deleted when sendTiming() is called.
243 const ProbePoints::PacketInfo
pkt_info(pkt
);
245 const bool expects_response(pkt
->needsResponse() &&
246 !pkt
->cacheResponding());
248 // If a cache miss is served by a cache, a monitor near the memory
249 // would see a request which needs a response, but this response
250 // would not come back from the memory. Therefore we additionally
251 // have to check the cacheResponding flag
252 if (expects_response
&& !stats
.disableLatencyHists
) {
253 pkt
->pushSenderState(new CommMonitorSenderState(curTick()));
256 // Attempt to send the packet
257 bool successful
= masterPort
.sendTimingReq(pkt
);
259 // If not successful, restore the sender state
260 if (!successful
&& expects_response
&& !stats
.disableLatencyHists
) {
261 delete pkt
->popSenderState();
265 ppPktReq
->notify(pkt_info
);
269 DPRINTF(CommMonitor
, "Forwarded %s request\n", pkt
->isRead() ? "read" :
270 pkt
->isWrite() ? "write" : "non read/write");
271 stats
.updateReqStats(pkt_info
, false, expects_response
);
277 CommMonitor::recvTimingResp(PacketPtr pkt
)
279 // should always see responses
280 assert(pkt
->isResponse());
282 // Store relevant fields of packet, because packet may be modified
283 // or even deleted when sendTiming() is called.
284 const ProbePoints::PacketInfo
pkt_info(pkt
);
287 CommMonitorSenderState
* received_state
=
288 dynamic_cast<CommMonitorSenderState
*>(pkt
->senderState
);
290 if (!stats
.disableLatencyHists
) {
291 // Restore initial sender state
292 if (received_state
== NULL
)
293 panic("Monitor got a response without monitor sender state\n");
296 pkt
->senderState
= received_state
->predecessor
;
299 // Attempt to send the packet
300 bool successful
= slavePort
.sendTimingResp(pkt
);
302 if (!stats
.disableLatencyHists
) {
303 // If packet successfully send, sample value of latency,
304 // afterwards delete sender state, otherwise restore state
306 latency
= curTick() - received_state
->transmitTime
;
307 DPRINTF(CommMonitor
, "Latency: %d\n", latency
);
308 delete received_state
;
310 // Don't delete anything and let the packet look like we
312 pkt
->senderState
= received_state
;
317 ppPktResp
->notify(pkt_info
);
318 DPRINTF(CommMonitor
, "Received %s response\n", pkt
->isRead() ? "read" :
319 pkt
->isWrite() ? "write" : "non read/write");
320 stats
.updateRespStats(pkt_info
, latency
, false);
326 CommMonitor::recvTimingSnoopReq(PacketPtr pkt
)
328 slavePort
.sendTimingSnoopReq(pkt
);
332 CommMonitor::recvTimingSnoopResp(PacketPtr pkt
)
334 return masterPort
.sendTimingSnoopResp(pkt
);
338 CommMonitor::recvRetrySnoopResp()
340 slavePort
.sendRetrySnoopResp();
344 CommMonitor::isSnooping() const
346 // check if the connected master port is snooping
347 return slavePort
.isSnooping();
351 CommMonitor::getAddrRanges() const
353 // get the address ranges of the connected slave port
354 return masterPort
.getAddrRanges();
358 CommMonitor::recvReqRetry()
360 slavePort
.sendRetryReq();
364 CommMonitor::recvRespRetry()
366 masterPort
.sendRetryResp();
370 CommMonitor::tryTiming(PacketPtr pkt
)
372 return masterPort
.tryTiming(pkt
);
376 CommMonitor::recvRangeChange()
378 slavePort
.sendRangeChange();
382 CommMonitor::regStats()
384 SimObject::regStats();
386 // Initialise all the monitor stats
387 using namespace Stats
;
389 stats
.readBurstLengthHist
390 .init(params()->burst_length_bins
)
391 .name(name() + ".readBurstLengthHist")
392 .desc("Histogram of burst lengths of transmitted packets")
393 .flags(stats
.disableBurstLengthHists
? nozero
: pdf
);
395 stats
.writeBurstLengthHist
396 .init(params()->burst_length_bins
)
397 .name(name() + ".writeBurstLengthHist")
398 .desc("Histogram of burst lengths of transmitted packets")
399 .flags(stats
.disableBurstLengthHists
? nozero
: pdf
);
401 // Stats based on received responses
402 stats
.readBandwidthHist
403 .init(params()->bandwidth_bins
)
404 .name(name() + ".readBandwidthHist")
405 .desc("Histogram of read bandwidth per sample period (bytes/s)")
406 .flags(stats
.disableBandwidthHists
? nozero
: pdf
);
409 .name(name() + ".averageReadBandwidth")
410 .desc("Average read bandwidth (bytes/s)")
411 .flags(stats
.disableBandwidthHists
? nozero
: pdf
);
414 .name(name() + ".totalReadBytes")
415 .desc("Number of bytes read")
416 .flags(stats
.disableBandwidthHists
? nozero
: pdf
);
418 stats
.averageReadBW
= stats
.totalReadBytes
/ simSeconds
;
420 // Stats based on successfully sent requests
421 stats
.writeBandwidthHist
422 .init(params()->bandwidth_bins
)
423 .name(name() + ".writeBandwidthHist")
424 .desc("Histogram of write bandwidth (bytes/s)")
425 .flags(stats
.disableBandwidthHists
? (pdf
| nozero
) : pdf
);
428 .name(name() + ".averageWriteBandwidth")
429 .desc("Average write bandwidth (bytes/s)")
430 .flags(stats
.disableBandwidthHists
? nozero
: pdf
);
432 stats
.totalWrittenBytes
433 .name(name() + ".totalWrittenBytes")
434 .desc("Number of bytes written")
435 .flags(stats
.disableBandwidthHists
? nozero
: pdf
);
437 stats
.averageWriteBW
= stats
.totalWrittenBytes
/ simSeconds
;
439 stats
.readLatencyHist
440 .init(params()->latency_bins
)
441 .name(name() + ".readLatencyHist")
442 .desc("Read request-response latency")
443 .flags(stats
.disableLatencyHists
? nozero
: pdf
);
445 stats
.writeLatencyHist
446 .init(params()->latency_bins
)
447 .name(name() + ".writeLatencyHist")
448 .desc("Write request-response latency")
449 .flags(stats
.disableLatencyHists
? nozero
: pdf
);
452 .init(1, params()->itt_max_bin
, params()->itt_max_bin
/
454 .name(name() + ".ittReadRead")
455 .desc("Read-to-read inter transaction time")
456 .flags(stats
.disableITTDists
? nozero
: pdf
);
459 .init(1, params()->itt_max_bin
, params()->itt_max_bin
/
461 .name(name() + ".ittWriteWrite")
462 .desc("Write-to-write inter transaction time")
463 .flags(stats
.disableITTDists
? nozero
: pdf
);
466 .init(1, params()->itt_max_bin
, params()->itt_max_bin
/
468 .name(name() + ".ittReqReq")
469 .desc("Request-to-request inter transaction time")
470 .flags(stats
.disableITTDists
? nozero
: pdf
);
472 stats
.outstandingReadsHist
473 .init(params()->outstanding_bins
)
474 .name(name() + ".outstandingReadsHist")
475 .desc("Outstanding read transactions")
476 .flags(stats
.disableOutstandingHists
? nozero
: pdf
);
478 stats
.outstandingWritesHist
479 .init(params()->outstanding_bins
)
480 .name(name() + ".outstandingWritesHist")
481 .desc("Outstanding write transactions")
482 .flags(stats
.disableOutstandingHists
? nozero
: pdf
);
485 .init(params()->transaction_bins
)
486 .name(name() + ".readTransHist")
487 .desc("Histogram of read transactions per sample period")
488 .flags(stats
.disableTransactionHists
? nozero
: pdf
);
491 .init(params()->transaction_bins
)
492 .name(name() + ".writeTransHist")
493 .desc("Histogram of write transactions per sample period")
494 .flags(stats
.disableTransactionHists
? nozero
: pdf
);
498 .name(name() + ".readAddrDist")
499 .desc("Read address distribution")
500 .flags(stats
.disableAddrDists
? nozero
: pdf
);
504 .name(name() + ".writeAddrDist")
505 .desc("Write address distribution")
506 .flags(stats
.disableAddrDists
? nozero
: pdf
);
510 CommMonitor::samplePeriodic()
512 // the periodic stats update runs on the granularity of sample
513 // periods, but in combination with this there may also be a
514 // external resets and dumps of the stats (through schedStatEvent)
515 // causing the stats themselves to capture less than a sample
518 // only capture if we have not reset the stats during the last
520 if (simTicks
.value() >= samplePeriodTicks
) {
521 if (!stats
.disableTransactionHists
) {
522 stats
.readTransHist
.sample(stats
.readTrans
);
523 stats
.writeTransHist
.sample(stats
.writeTrans
);
526 if (!stats
.disableBandwidthHists
) {
527 stats
.readBandwidthHist
.sample(stats
.readBytes
/ samplePeriod
);
528 stats
.writeBandwidthHist
.sample(stats
.writtenBytes
/ samplePeriod
);
531 if (!stats
.disableOutstandingHists
) {
532 stats
.outstandingReadsHist
.sample(stats
.outstandingReadReqs
);
533 stats
.outstandingWritesHist
.sample(stats
.outstandingWriteReqs
);
537 // reset the sampled values
539 stats
.writeTrans
= 0;
542 stats
.writtenBytes
= 0;
544 schedule(samplePeriodicEvent
, curTick() + samplePeriodTicks
);
548 CommMonitor::startup()
550 schedule(samplePeriodicEvent
, curTick() + samplePeriodTicks
);