2 * Copyright (c) 2012-2013, 2015 ARM Limited
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.
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.
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.
37 * Authors: Thomas Grass
41 #include "mem/comm_monitor.hh"
43 #include "base/trace.hh"
44 #include "debug/CommMonitor.hh"
45 #include "sim/stats.hh"
47 CommMonitor::CommMonitor(Params
* params
)
49 masterPort(name() + "-master", *this),
50 slavePort(name() + "-slave", *this),
51 samplePeriodicEvent(this),
52 samplePeriodTicks(params
->sample_period
),
53 samplePeriod(params
->sample_period
/ SimClock::Float::s
),
54 readAddrMask(params
->read_addr_mask
),
55 writeAddrMask(params
->write_addr_mask
),
59 "Created monitor %s with sample period %d ticks (%f ms)\n",
60 name(), samplePeriodTicks
, samplePeriod
* 1E3
);
64 CommMonitorParams::create()
66 return new CommMonitor(this);
72 // make sure both sides of the monitor are connected
73 if (!slavePort
.isConnected() || !masterPort
.isConnected())
74 fatal("Communication monitor is not connected on both sides.\n");
78 CommMonitor::regProbePoints()
80 ppPktReq
.reset(new ProbePoints::Packet(getProbeManager(), "PktRequest"));
81 ppPktResp
.reset(new ProbePoints::Packet(getProbeManager(), "PktResponse"));
85 CommMonitor::getMasterPort(const std::string
& if_name
, PortID idx
)
87 if (if_name
== "master") {
90 return MemObject::getMasterPort(if_name
, idx
);
95 CommMonitor::getSlavePort(const std::string
& if_name
, PortID idx
)
97 if (if_name
== "slave") {
100 return MemObject::getSlavePort(if_name
, idx
);
105 CommMonitor::recvFunctional(PacketPtr pkt
)
107 masterPort
.sendFunctional(pkt
);
111 CommMonitor::recvFunctionalSnoop(PacketPtr pkt
)
113 slavePort
.sendFunctionalSnoop(pkt
);
117 CommMonitor::recvAtomic(PacketPtr pkt
)
119 ProbePoints::PacketInfo
req_pkt_info(pkt
);
120 ppPktReq
->notify(req_pkt_info
);
122 const Tick
delay(masterPort
.sendAtomic(pkt
));
123 assert(pkt
->isResponse());
124 ProbePoints::PacketInfo
resp_pkt_info(pkt
);
125 ppPktResp
->notify(resp_pkt_info
);
130 CommMonitor::recvAtomicSnoop(PacketPtr pkt
)
132 return slavePort
.sendAtomicSnoop(pkt
);
136 CommMonitor::recvTimingReq(PacketPtr pkt
)
138 // should always see a request
139 assert(pkt
->isRequest());
141 // Store relevant fields of packet, because packet may be modified
142 // or even deleted when sendTiming() is called.
143 const ProbePoints::PacketInfo
pkt_info(pkt
);
145 const bool is_read
= pkt
->isRead();
146 const bool is_write
= pkt
->isWrite();
147 const bool expects_response(
148 pkt
->needsResponse() && !pkt
->cacheResponding());
150 // If a cache miss is served by a cache, a monitor near the memory
151 // would see a request which needs a response, but this response
152 // would not come back from the memory. Therefore we additionally
153 // have to check the cacheResponding flag
154 if (expects_response
&& !stats
.disableLatencyHists
) {
155 pkt
->pushSenderState(new CommMonitorSenderState(curTick()));
158 // Attempt to send the packet
159 bool successful
= masterPort
.sendTimingReq(pkt
);
161 // If not successful, restore the sender state
162 if (!successful
&& expects_response
&& !stats
.disableLatencyHists
) {
163 delete pkt
->popSenderState();
167 ppPktReq
->notify(pkt_info
);
170 if (successful
&& is_read
) {
171 DPRINTF(CommMonitor
, "Forwarded read request\n");
173 // Increment number of observed read transactions
174 if (!stats
.disableTransactionHists
) {
178 // Get sample of burst length
179 if (!stats
.disableBurstLengthHists
) {
180 stats
.readBurstLengthHist
.sample(pkt_info
.size
);
183 // Sample the masked address
184 if (!stats
.disableAddrDists
) {
185 stats
.readAddrDist
.sample(pkt_info
.addr
& readAddrMask
);
188 // If it needs a response increment number of outstanding read
190 if (!stats
.disableOutstandingHists
&& expects_response
) {
191 ++stats
.outstandingReadReqs
;
194 if (!stats
.disableITTDists
) {
195 // Sample value of read-read inter transaction time
196 if (stats
.timeOfLastRead
!= 0) {
197 stats
.ittReadRead
.sample(curTick() - stats
.timeOfLastRead
);
199 stats
.timeOfLastRead
= curTick();
201 // Sample value of req-req inter transaction time
202 if (stats
.timeOfLastReq
!= 0) {
203 stats
.ittReqReq
.sample(curTick() - stats
.timeOfLastReq
);
205 stats
.timeOfLastReq
= curTick();
207 } else if (successful
&& is_write
) {
208 DPRINTF(CommMonitor
, "Forwarded write request\n");
211 if (!stats
.disableTransactionHists
) {
215 if (!stats
.disableBurstLengthHists
) {
216 stats
.writeBurstLengthHist
.sample(pkt_info
.size
);
219 // Update the bandwidth stats on the request
220 if (!stats
.disableBandwidthHists
) {
221 stats
.writtenBytes
+= pkt_info
.size
;
222 stats
.totalWrittenBytes
+= pkt_info
.size
;
225 // Sample the masked write address
226 if (!stats
.disableAddrDists
) {
227 stats
.writeAddrDist
.sample(pkt_info
.addr
& writeAddrMask
);
230 if (!stats
.disableOutstandingHists
&& expects_response
) {
231 ++stats
.outstandingWriteReqs
;
234 if (!stats
.disableITTDists
) {
235 // Sample value of write-to-write inter transaction time
236 if (stats
.timeOfLastWrite
!= 0) {
237 stats
.ittWriteWrite
.sample(curTick() - stats
.timeOfLastWrite
);
239 stats
.timeOfLastWrite
= curTick();
241 // Sample value of req-to-req inter transaction time
242 if (stats
.timeOfLastReq
!= 0) {
243 stats
.ittReqReq
.sample(curTick() - stats
.timeOfLastReq
);
245 stats
.timeOfLastReq
= curTick();
247 } else if (successful
) {
248 DPRINTF(CommMonitor
, "Forwarded non read/write request\n");
255 CommMonitor::recvTimingResp(PacketPtr pkt
)
257 // should always see responses
258 assert(pkt
->isResponse());
260 // Store relevant fields of packet, because packet may be modified
261 // or even deleted when sendTiming() is called.
262 const ProbePoints::PacketInfo
pkt_info(pkt
);
264 bool is_read
= pkt
->isRead();
265 bool is_write
= pkt
->isWrite();
267 CommMonitorSenderState
* received_state
=
268 dynamic_cast<CommMonitorSenderState
*>(pkt
->senderState
);
270 if (!stats
.disableLatencyHists
) {
271 // Restore initial sender state
272 if (received_state
== NULL
)
273 panic("Monitor got a response without monitor sender state\n");
276 pkt
->senderState
= received_state
->predecessor
;
279 // Attempt to send the packet
280 bool successful
= slavePort
.sendTimingResp(pkt
);
282 if (!stats
.disableLatencyHists
) {
283 // If packet successfully send, sample value of latency,
284 // afterwards delete sender state, otherwise restore state
286 latency
= curTick() - received_state
->transmitTime
;
287 DPRINTF(CommMonitor
, "Latency: %d\n", latency
);
288 delete received_state
;
290 // Don't delete anything and let the packet look like we
292 pkt
->senderState
= received_state
;
297 ppPktResp
->notify(pkt_info
);
300 if (successful
&& is_read
) {
301 // Decrement number of outstanding read requests
302 DPRINTF(CommMonitor
, "Received read response\n");
303 if (!stats
.disableOutstandingHists
) {
304 assert(stats
.outstandingReadReqs
!= 0);
305 --stats
.outstandingReadReqs
;
308 if (!stats
.disableLatencyHists
) {
309 stats
.readLatencyHist
.sample(latency
);
312 // Update the bandwidth stats based on responses for reads
313 if (!stats
.disableBandwidthHists
) {
314 stats
.readBytes
+= pkt_info
.size
;
315 stats
.totalReadBytes
+= pkt_info
.size
;
318 } else if (successful
&& is_write
) {
319 // Decrement number of outstanding write requests
320 DPRINTF(CommMonitor
, "Received write response\n");
321 if (!stats
.disableOutstandingHists
) {
322 assert(stats
.outstandingWriteReqs
!= 0);
323 --stats
.outstandingWriteReqs
;
326 if (!stats
.disableLatencyHists
) {
327 stats
.writeLatencyHist
.sample(latency
);
329 } else if (successful
) {
330 DPRINTF(CommMonitor
, "Received non read/write response\n");
336 CommMonitor::recvTimingSnoopReq(PacketPtr pkt
)
338 slavePort
.sendTimingSnoopReq(pkt
);
342 CommMonitor::recvTimingSnoopResp(PacketPtr pkt
)
344 return masterPort
.sendTimingSnoopResp(pkt
);
348 CommMonitor::recvRetrySnoopResp()
350 slavePort
.sendRetrySnoopResp();
354 CommMonitor::isSnooping() const
356 // check if the connected master port is snooping
357 return slavePort
.isSnooping();
361 CommMonitor::getAddrRanges() const
363 // get the address ranges of the connected slave port
364 return masterPort
.getAddrRanges();
368 CommMonitor::recvReqRetry()
370 slavePort
.sendRetryReq();
374 CommMonitor::recvRespRetry()
376 masterPort
.sendRetryResp();
380 CommMonitor::recvRangeChange()
382 slavePort
.sendRangeChange();
386 CommMonitor::regStats()
388 MemObject::regStats();
390 // Initialise all the monitor stats
391 using namespace Stats
;
393 stats
.readBurstLengthHist
394 .init(params()->burst_length_bins
)
395 .name(name() + ".readBurstLengthHist")
396 .desc("Histogram of burst lengths of transmitted packets")
397 .flags(stats
.disableBurstLengthHists
? nozero
: pdf
);
399 stats
.writeBurstLengthHist
400 .init(params()->burst_length_bins
)
401 .name(name() + ".writeBurstLengthHist")
402 .desc("Histogram of burst lengths of transmitted packets")
403 .flags(stats
.disableBurstLengthHists
? nozero
: pdf
);
405 // Stats based on received responses
406 stats
.readBandwidthHist
407 .init(params()->bandwidth_bins
)
408 .name(name() + ".readBandwidthHist")
409 .desc("Histogram of read bandwidth per sample period (bytes/s)")
410 .flags(stats
.disableBandwidthHists
? nozero
: pdf
);
413 .name(name() + ".averageReadBandwidth")
414 .desc("Average read bandwidth (bytes/s)")
415 .flags(stats
.disableBandwidthHists
? nozero
: pdf
);
418 .name(name() + ".totalReadBytes")
419 .desc("Number of bytes read")
420 .flags(stats
.disableBandwidthHists
? nozero
: pdf
);
422 stats
.averageReadBW
= stats
.totalReadBytes
/ simSeconds
;
424 // Stats based on successfully sent requests
425 stats
.writeBandwidthHist
426 .init(params()->bandwidth_bins
)
427 .name(name() + ".writeBandwidthHist")
428 .desc("Histogram of write bandwidth (bytes/s)")
429 .flags(stats
.disableBandwidthHists
? (pdf
| nozero
) : pdf
);
432 .name(name() + ".averageWriteBandwidth")
433 .desc("Average write bandwidth (bytes/s)")
434 .flags(stats
.disableBandwidthHists
? nozero
: pdf
);
436 stats
.totalWrittenBytes
437 .name(name() + ".totalWrittenBytes")
438 .desc("Number of bytes written")
439 .flags(stats
.disableBandwidthHists
? nozero
: pdf
);
441 stats
.averageWriteBW
= stats
.totalWrittenBytes
/ simSeconds
;
443 stats
.readLatencyHist
444 .init(params()->latency_bins
)
445 .name(name() + ".readLatencyHist")
446 .desc("Read request-response latency")
447 .flags(stats
.disableLatencyHists
? nozero
: pdf
);
449 stats
.writeLatencyHist
450 .init(params()->latency_bins
)
451 .name(name() + ".writeLatencyHist")
452 .desc("Write request-response latency")
453 .flags(stats
.disableLatencyHists
? nozero
: pdf
);
456 .init(1, params()->itt_max_bin
, params()->itt_max_bin
/
458 .name(name() + ".ittReadRead")
459 .desc("Read-to-read inter transaction time")
460 .flags(stats
.disableITTDists
? nozero
: pdf
);
463 .init(1, params()->itt_max_bin
, params()->itt_max_bin
/
465 .name(name() + ".ittWriteWrite")
466 .desc("Write-to-write inter transaction time")
467 .flags(stats
.disableITTDists
? nozero
: pdf
);
470 .init(1, params()->itt_max_bin
, params()->itt_max_bin
/
472 .name(name() + ".ittReqReq")
473 .desc("Request-to-request inter transaction time")
474 .flags(stats
.disableITTDists
? nozero
: pdf
);
476 stats
.outstandingReadsHist
477 .init(params()->outstanding_bins
)
478 .name(name() + ".outstandingReadsHist")
479 .desc("Outstanding read transactions")
480 .flags(stats
.disableOutstandingHists
? nozero
: pdf
);
482 stats
.outstandingWritesHist
483 .init(params()->outstanding_bins
)
484 .name(name() + ".outstandingWritesHist")
485 .desc("Outstanding write transactions")
486 .flags(stats
.disableOutstandingHists
? nozero
: pdf
);
489 .init(params()->transaction_bins
)
490 .name(name() + ".readTransHist")
491 .desc("Histogram of read transactions per sample period")
492 .flags(stats
.disableTransactionHists
? nozero
: pdf
);
495 .init(params()->transaction_bins
)
496 .name(name() + ".writeTransHist")
497 .desc("Histogram of read transactions per sample period")
498 .flags(stats
.disableTransactionHists
? nozero
: pdf
);
502 .name(name() + ".readAddrDist")
503 .desc("Read address distribution")
504 .flags(stats
.disableAddrDists
? nozero
: pdf
);
508 .name(name() + ".writeAddrDist")
509 .desc("Write address distribution")
510 .flags(stats
.disableAddrDists
? nozero
: pdf
);
514 CommMonitor::samplePeriodic()
516 // the periodic stats update runs on the granularity of sample
517 // periods, but in combination with this there may also be a
518 // external resets and dumps of the stats (through schedStatEvent)
519 // causing the stats themselves to capture less than a sample
522 // only capture if we have not reset the stats during the last
524 if (simTicks
.value() >= samplePeriodTicks
) {
525 if (!stats
.disableTransactionHists
) {
526 stats
.readTransHist
.sample(stats
.readTrans
);
527 stats
.writeTransHist
.sample(stats
.writeTrans
);
530 if (!stats
.disableBandwidthHists
) {
531 stats
.readBandwidthHist
.sample(stats
.readBytes
/ samplePeriod
);
532 stats
.writeBandwidthHist
.sample(stats
.writtenBytes
/ samplePeriod
);
535 if (!stats
.disableOutstandingHists
) {
536 stats
.outstandingReadsHist
.sample(stats
.outstandingReadReqs
);
537 stats
.outstandingWritesHist
.sample(stats
.outstandingWriteReqs
);
541 // reset the sampled values
543 stats
.writeTrans
= 0;
546 stats
.writtenBytes
= 0;
548 schedule(samplePeriodicEvent
, curTick() + samplePeriodTicks
);
552 CommMonitor::startup()
554 schedule(samplePeriodicEvent
, curTick() + samplePeriodTicks
);