2 * Copyright (c) 2012-2013 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 "base/callback.hh"
42 #include "base/output.hh"
43 #include "base/trace.hh"
44 #include "debug/CommMonitor.hh"
45 #include "mem/comm_monitor.hh"
46 #include "proto/packet.pb.h"
47 #include "sim/stats.hh"
49 CommMonitor::CommMonitor(Params
* params
)
51 masterPort(name() + "-master", *this),
52 slavePort(name() + "-slave", *this),
53 samplePeriodicEvent(this),
54 samplePeriodTicks(params
->sample_period
),
55 readAddrMask(params
->read_addr_mask
),
56 writeAddrMask(params
->write_addr_mask
),
60 // If we are using a trace file, then open the file,
61 if (params
->trace_file
!= "") {
62 // If the trace file is not specified as an absolute path,
63 // append the current simulation output directory
64 std::string filename
= simout
.resolve(params
->trace_file
);
65 traceStream
= new ProtoOutputStream(filename
);
67 // Create a protobuf message for the header and write it to
69 Message::PacketHeader header_msg
;
70 header_msg
.set_obj_id(name());
71 header_msg
.set_tick_freq(SimClock::Frequency
);
72 traceStream
->write(header_msg
);
74 // Register a callback to compensate for the destructor not
75 // being called. The callback forces the stream to flush and
76 // closes the output file.
77 Callback
* cb
= new MakeCallback
<CommMonitor
,
78 &CommMonitor::closeStreams
>(this);
79 registerExitCallback(cb
);
82 // keep track of the sample period both in ticks and absolute time
83 samplePeriod
.setTick(params
->sample_period
);
86 "Created monitor %s with sample period %d ticks (%f ms)\n",
87 name(), samplePeriodTicks
, samplePeriod
.msec());
91 CommMonitor::closeStreams()
93 if (traceStream
!= NULL
)
98 CommMonitorParams::create()
100 return new CommMonitor(this);
106 // make sure both sides of the monitor are connected
107 if (!slavePort
.isConnected() || !masterPort
.isConnected())
108 fatal("Communication monitor is not connected on both sides.\n");
112 CommMonitor::getMasterPort(const std::string
& if_name
, PortID idx
)
114 if (if_name
== "master") {
117 return MemObject::getMasterPort(if_name
, idx
);
122 CommMonitor::getSlavePort(const std::string
& if_name
, PortID idx
)
124 if (if_name
== "slave") {
127 return MemObject::getSlavePort(if_name
, idx
);
132 CommMonitor::recvFunctional(PacketPtr pkt
)
134 masterPort
.sendFunctional(pkt
);
138 CommMonitor::recvFunctionalSnoop(PacketPtr pkt
)
140 slavePort
.sendFunctionalSnoop(pkt
);
144 CommMonitor::recvAtomic(PacketPtr pkt
)
146 return masterPort
.sendAtomic(pkt
);
150 CommMonitor::recvAtomicSnoop(PacketPtr pkt
)
152 return slavePort
.sendAtomicSnoop(pkt
);
156 CommMonitor::recvTimingReq(PacketPtr pkt
)
158 // should always see a request
159 assert(pkt
->isRequest());
161 // Store relevant fields of packet, because packet may be modified
162 // or even deleted when sendTiming() is called.
163 bool is_read
= pkt
->isRead();
164 bool is_write
= pkt
->isWrite();
165 int cmd
= pkt
->cmdToIndex();
166 Request::FlagsType req_flags
= pkt
->req
->getFlags();
167 unsigned size
= pkt
->getSize();
168 Addr addr
= pkt
->getAddr();
169 bool expects_response
= pkt
->needsResponse() && !pkt
->memInhibitAsserted();
171 // If a cache miss is served by a cache, a monitor near the memory
172 // would see a request which needs a response, but this response
173 // would be inhibited and not come back from the memory. Therefore
174 // we additionally have to check the inhibit flag.
175 if (expects_response
&& !stats
.disableLatencyHists
) {
176 pkt
->pushSenderState(new CommMonitorSenderState(curTick()));
179 // Attempt to send the packet (always succeeds for inhibited
181 bool successful
= masterPort
.sendTimingReq(pkt
);
183 // If not successful, restore the sender state
184 if (!successful
&& expects_response
&& !stats
.disableLatencyHists
) {
185 delete pkt
->popSenderState();
188 if (successful
&& traceStream
!= NULL
) {
189 // Create a protobuf message representing the
190 // packet. Currently we do not preserve the flags in the
192 Message::Packet pkt_msg
;
193 pkt_msg
.set_tick(curTick());
194 pkt_msg
.set_cmd(cmd
);
195 pkt_msg
.set_flags(req_flags
);
196 pkt_msg
.set_addr(addr
);
197 pkt_msg
.set_size(size
);
199 traceStream
->write(pkt_msg
);
202 if (successful
&& is_read
) {
203 DPRINTF(CommMonitor
, "Forwarded read request\n");
205 // Increment number of observed read transactions
206 if (!stats
.disableTransactionHists
) {
210 // Get sample of burst length
211 if (!stats
.disableBurstLengthHists
) {
212 stats
.readBurstLengthHist
.sample(size
);
215 // Sample the masked address
216 if (!stats
.disableAddrDists
) {
217 stats
.readAddrDist
.sample(addr
& readAddrMask
);
220 // If it needs a response increment number of outstanding read
222 if (!stats
.disableOutstandingHists
&& expects_response
) {
223 ++stats
.outstandingReadReqs
;
226 if (!stats
.disableITTDists
) {
227 // Sample value of read-read inter transaction time
228 if (stats
.timeOfLastRead
!= 0) {
229 stats
.ittReadRead
.sample(curTick() - stats
.timeOfLastRead
);
231 stats
.timeOfLastRead
= curTick();
233 // Sample value of req-req inter transaction time
234 if (stats
.timeOfLastReq
!= 0) {
235 stats
.ittReqReq
.sample(curTick() - stats
.timeOfLastReq
);
237 stats
.timeOfLastReq
= curTick();
239 } else if (successful
&& is_write
) {
240 DPRINTF(CommMonitor
, "Forwarded write request\n");
243 if (!stats
.disableTransactionHists
) {
247 if (!stats
.disableBurstLengthHists
) {
248 stats
.writeBurstLengthHist
.sample(size
);
251 // Update the bandwidth stats on the request
252 if (!stats
.disableBandwidthHists
) {
253 stats
.writtenBytes
+= size
;
254 stats
.totalWrittenBytes
+= size
;
257 // Sample the masked write address
258 if (!stats
.disableAddrDists
) {
259 stats
.writeAddrDist
.sample(addr
& writeAddrMask
);
262 if (!stats
.disableOutstandingHists
&& expects_response
) {
263 ++stats
.outstandingWriteReqs
;
266 if (!stats
.disableITTDists
) {
267 // Sample value of write-to-write inter transaction time
268 if (stats
.timeOfLastWrite
!= 0) {
269 stats
.ittWriteWrite
.sample(curTick() - stats
.timeOfLastWrite
);
271 stats
.timeOfLastWrite
= curTick();
273 // Sample value of req-to-req inter transaction time
274 if (stats
.timeOfLastReq
!= 0) {
275 stats
.ittReqReq
.sample(curTick() - stats
.timeOfLastReq
);
277 stats
.timeOfLastReq
= curTick();
279 } else if (successful
) {
280 DPRINTF(CommMonitor
, "Forwarded non read/write request\n");
287 CommMonitor::recvTimingResp(PacketPtr pkt
)
289 // should always see responses
290 assert(pkt
->isResponse());
292 // Store relevant fields of packet, because packet may be modified
293 // or even deleted when sendTiming() is called.
294 bool is_read
= pkt
->isRead();
295 bool is_write
= pkt
->isWrite();
296 unsigned size
= pkt
->getSize();
298 CommMonitorSenderState
* received_state
=
299 dynamic_cast<CommMonitorSenderState
*>(pkt
->senderState
);
301 if (!stats
.disableLatencyHists
) {
302 // Restore initial sender state
303 if (received_state
== NULL
)
304 panic("Monitor got a response without monitor sender state\n");
307 pkt
->senderState
= received_state
->predecessor
;
310 // Attempt to send the packet
311 bool successful
= slavePort
.sendTimingResp(pkt
);
313 if (!stats
.disableLatencyHists
) {
314 // If packet successfully send, sample value of latency,
315 // afterwards delete sender state, otherwise restore state
317 latency
= curTick() - received_state
->transmitTime
;
318 DPRINTF(CommMonitor
, "Latency: %d\n", latency
);
319 delete received_state
;
321 // Don't delete anything and let the packet look like we
323 pkt
->senderState
= received_state
;
327 if (successful
&& is_read
) {
328 // Decrement number of outstanding read requests
329 DPRINTF(CommMonitor
, "Received read response\n");
330 if (!stats
.disableOutstandingHists
) {
331 assert(stats
.outstandingReadReqs
!= 0);
332 --stats
.outstandingReadReqs
;
335 if (!stats
.disableLatencyHists
) {
336 stats
.readLatencyHist
.sample(latency
);
339 // Update the bandwidth stats based on responses for reads
340 if (!stats
.disableBandwidthHists
) {
341 stats
.readBytes
+= size
;
342 stats
.totalReadBytes
+= size
;
345 } else if (successful
&& is_write
) {
346 // Decrement number of outstanding write requests
347 DPRINTF(CommMonitor
, "Received write response\n");
348 if (!stats
.disableOutstandingHists
) {
349 assert(stats
.outstandingWriteReqs
!= 0);
350 --stats
.outstandingWriteReqs
;
353 if (!stats
.disableLatencyHists
) {
354 stats
.writeLatencyHist
.sample(latency
);
356 } else if (successful
) {
357 DPRINTF(CommMonitor
, "Received non read/write response\n");
363 CommMonitor::recvTimingSnoopReq(PacketPtr pkt
)
365 slavePort
.sendTimingSnoopReq(pkt
);
369 CommMonitor::recvTimingSnoopResp(PacketPtr pkt
)
371 return masterPort
.sendTimingSnoopResp(pkt
);
375 CommMonitor::isSnooping() const
377 // check if the connected master port is snooping
378 return slavePort
.isSnooping();
382 CommMonitor::getAddrRanges() const
384 // get the address ranges of the connected slave port
385 return masterPort
.getAddrRanges();
389 CommMonitor::recvRetryMaster()
391 slavePort
.sendRetry();
395 CommMonitor::recvRetrySlave()
397 masterPort
.sendRetry();
401 CommMonitor::recvRangeChange()
403 slavePort
.sendRangeChange();
407 CommMonitor::regStats()
409 // Initialise all the monitor stats
410 using namespace Stats
;
412 stats
.readBurstLengthHist
413 .init(params()->burst_length_bins
)
414 .name(name() + ".readBurstLengthHist")
415 .desc("Histogram of burst lengths of transmitted packets")
416 .flags(stats
.disableBurstLengthHists
? nozero
: pdf
);
418 stats
.writeBurstLengthHist
419 .init(params()->burst_length_bins
)
420 .name(name() + ".writeBurstLengthHist")
421 .desc("Histogram of burst lengths of transmitted packets")
422 .flags(stats
.disableBurstLengthHists
? nozero
: pdf
);
424 // Stats based on received responses
425 stats
.readBandwidthHist
426 .init(params()->bandwidth_bins
)
427 .name(name() + ".readBandwidthHist")
428 .desc("Histogram of read bandwidth per sample period (bytes/s)")
429 .flags(stats
.disableBandwidthHists
? nozero
: pdf
);
432 .name(name() + ".averageReadBandwidth")
433 .desc("Average read bandwidth (bytes/s)")
434 .flags(stats
.disableBandwidthHists
? nozero
: pdf
);
437 .name(name() + ".totalReadBytes")
438 .desc("Number of bytes read")
439 .flags(stats
.disableBandwidthHists
? nozero
: pdf
);
441 stats
.averageReadBW
= stats
.totalReadBytes
/ simSeconds
;
443 // Stats based on successfully sent requests
444 stats
.writeBandwidthHist
445 .init(params()->bandwidth_bins
)
446 .name(name() + ".writeBandwidthHist")
447 .desc("Histogram of write bandwidth (bytes/s)")
448 .flags(stats
.disableBandwidthHists
? (pdf
| nozero
) : pdf
);
451 .name(name() + ".averageWriteBandwidth")
452 .desc("Average write bandwidth (bytes/s)")
453 .flags(stats
.disableBandwidthHists
? nozero
: pdf
);
455 stats
.totalWrittenBytes
456 .name(name() + ".totalWrittenBytes")
457 .desc("Number of bytes written")
458 .flags(stats
.disableBandwidthHists
? nozero
: pdf
);
460 stats
.averageWriteBW
= stats
.totalWrittenBytes
/ simSeconds
;
462 stats
.readLatencyHist
463 .init(params()->latency_bins
)
464 .name(name() + ".readLatencyHist")
465 .desc("Read request-response latency")
466 .flags(stats
.disableLatencyHists
? nozero
: pdf
);
468 stats
.writeLatencyHist
469 .init(params()->latency_bins
)
470 .name(name() + ".writeLatencyHist")
471 .desc("Write request-response latency")
472 .flags(stats
.disableLatencyHists
? nozero
: pdf
);
475 .init(1, params()->itt_max_bin
, params()->itt_max_bin
/
477 .name(name() + ".ittReadRead")
478 .desc("Read-to-read inter transaction time")
479 .flags(stats
.disableITTDists
? nozero
: pdf
);
482 .init(1, params()->itt_max_bin
, params()->itt_max_bin
/
484 .name(name() + ".ittWriteWrite")
485 .desc("Write-to-write inter transaction time")
486 .flags(stats
.disableITTDists
? nozero
: pdf
);
489 .init(1, params()->itt_max_bin
, params()->itt_max_bin
/
491 .name(name() + ".ittReqReq")
492 .desc("Request-to-request inter transaction time")
493 .flags(stats
.disableITTDists
? nozero
: pdf
);
495 stats
.outstandingReadsHist
496 .init(params()->outstanding_bins
)
497 .name(name() + ".outstandingReadsHist")
498 .desc("Outstanding read transactions")
499 .flags(stats
.disableOutstandingHists
? nozero
: pdf
);
501 stats
.outstandingWritesHist
502 .init(params()->outstanding_bins
)
503 .name(name() + ".outstandingWritesHist")
504 .desc("Outstanding write transactions")
505 .flags(stats
.disableOutstandingHists
? nozero
: pdf
);
508 .init(params()->transaction_bins
)
509 .name(name() + ".readTransHist")
510 .desc("Histogram of read transactions per sample period")
511 .flags(stats
.disableTransactionHists
? nozero
: pdf
);
514 .init(params()->transaction_bins
)
515 .name(name() + ".writeTransHist")
516 .desc("Histogram of read transactions per sample period")
517 .flags(stats
.disableTransactionHists
? nozero
: pdf
);
521 .name(name() + ".readAddrDist")
522 .desc("Read address distribution")
523 .flags(stats
.disableAddrDists
? nozero
: pdf
);
527 .name(name() + ".writeAddrDist")
528 .desc("Write address distribution")
529 .flags(stats
.disableAddrDists
? nozero
: pdf
);
533 CommMonitor::samplePeriodic()
535 // the periodic stats update runs on the granularity of sample
536 // periods, but in combination with this there may also be a
537 // external resets and dumps of the stats (through schedStatEvent)
538 // causing the stats themselves to capture less than a sample
541 // only capture if we have not reset the stats during the last
543 if (simTicks
.value() >= samplePeriodTicks
) {
544 if (!stats
.disableTransactionHists
) {
545 stats
.readTransHist
.sample(stats
.readTrans
);
546 stats
.writeTransHist
.sample(stats
.writeTrans
);
549 if (!stats
.disableBandwidthHists
) {
550 stats
.readBandwidthHist
.sample(stats
.readBytes
/ samplePeriod
);
551 stats
.writeBandwidthHist
.sample(stats
.writtenBytes
/ samplePeriod
);
554 if (!stats
.disableOutstandingHists
) {
555 stats
.outstandingReadsHist
.sample(stats
.outstandingReadReqs
);
556 stats
.outstandingWritesHist
.sample(stats
.outstandingWriteReqs
);
560 // reset the sampled values
562 stats
.writeTrans
= 0;
565 stats
.writtenBytes
= 0;
567 schedule(samplePeriodicEvent
, curTick() + samplePeriodTicks
);
571 CommMonitor::startup()
573 schedule(samplePeriodicEvent
, curTick() + samplePeriodTicks
);