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
),
59 system(params
->system
)
61 // If we are using a trace file, then open the file,
62 if (params
->trace_file
!= "") {
63 // If the trace file is not specified as an absolute path,
64 // append the current simulation output directory
65 std::string filename
= simout
.resolve(params
->trace_file
);
66 traceStream
= new ProtoOutputStream(filename
);
68 // Create a protobuf message for the header and write it to
70 Message::PacketHeader header_msg
;
71 header_msg
.set_obj_id(name());
72 header_msg
.set_tick_freq(SimClock::Frequency
);
73 traceStream
->write(header_msg
);
75 // Register a callback to compensate for the destructor not
76 // being called. The callback forces the stream to flush and
77 // closes the output file.
78 Callback
* cb
= new MakeCallback
<CommMonitor
,
79 &CommMonitor::closeStreams
>(this);
80 registerExitCallback(cb
);
83 // keep track of the sample period both in ticks and absolute time
84 samplePeriod
.setTick(params
->sample_period
);
87 "Created monitor %s with sample period %d ticks (%f ms)\n",
88 name(), samplePeriodTicks
, samplePeriod
.msec());
92 CommMonitor::closeStreams()
94 if (traceStream
!= NULL
)
99 CommMonitorParams::create()
101 return new CommMonitor(this);
107 // make sure both sides of the monitor are connected
108 if (!slavePort
.isConnected() || !masterPort
.isConnected())
109 fatal("Communication monitor is not connected on both sides.\n");
111 if (traceStream
!= NULL
) {
112 // Check the memory mode. We only record something when in
113 // timing mode. Warn accordingly.
114 if (!system
->isTimingMode())
115 warn("%s: Not in timing mode. No trace will be recorded.", name());
120 CommMonitor::getMasterPort(const std::string
& if_name
, PortID idx
)
122 if (if_name
== "master") {
125 return MemObject::getMasterPort(if_name
, idx
);
130 CommMonitor::getSlavePort(const std::string
& if_name
, PortID idx
)
132 if (if_name
== "slave") {
135 return MemObject::getSlavePort(if_name
, idx
);
140 CommMonitor::recvFunctional(PacketPtr pkt
)
142 masterPort
.sendFunctional(pkt
);
146 CommMonitor::recvFunctionalSnoop(PacketPtr pkt
)
148 slavePort
.sendFunctionalSnoop(pkt
);
152 CommMonitor::recvAtomic(PacketPtr pkt
)
154 return masterPort
.sendAtomic(pkt
);
158 CommMonitor::recvAtomicSnoop(PacketPtr pkt
)
160 return slavePort
.sendAtomicSnoop(pkt
);
164 CommMonitor::recvTimingReq(PacketPtr pkt
)
166 // should always see a request
167 assert(pkt
->isRequest());
169 // Store relevant fields of packet, because packet may be modified
170 // or even deleted when sendTiming() is called.
171 bool is_read
= pkt
->isRead();
172 bool is_write
= pkt
->isWrite();
173 int cmd
= pkt
->cmdToIndex();
174 Request::FlagsType req_flags
= pkt
->req
->getFlags();
175 unsigned size
= pkt
->getSize();
176 Addr addr
= pkt
->getAddr();
177 bool expects_response
= pkt
->needsResponse() && !pkt
->memInhibitAsserted();
179 // If a cache miss is served by a cache, a monitor near the memory
180 // would see a request which needs a response, but this response
181 // would be inhibited and not come back from the memory. Therefore
182 // we additionally have to check the inhibit flag.
183 if (expects_response
&& !stats
.disableLatencyHists
) {
184 pkt
->pushSenderState(new CommMonitorSenderState(curTick()));
187 // Attempt to send the packet (always succeeds for inhibited
189 bool successful
= masterPort
.sendTimingReq(pkt
);
191 // If not successful, restore the sender state
192 if (!successful
&& expects_response
&& !stats
.disableLatencyHists
) {
193 delete pkt
->popSenderState();
196 if (successful
&& traceStream
!= NULL
) {
197 // Create a protobuf message representing the
198 // packet. Currently we do not preserve the flags in the
200 Message::Packet pkt_msg
;
201 pkt_msg
.set_tick(curTick());
202 pkt_msg
.set_cmd(cmd
);
203 pkt_msg
.set_flags(req_flags
);
204 pkt_msg
.set_addr(addr
);
205 pkt_msg
.set_size(size
);
207 traceStream
->write(pkt_msg
);
210 if (successful
&& is_read
) {
211 DPRINTF(CommMonitor
, "Forwarded read request\n");
213 // Increment number of observed read transactions
214 if (!stats
.disableTransactionHists
) {
218 // Get sample of burst length
219 if (!stats
.disableBurstLengthHists
) {
220 stats
.readBurstLengthHist
.sample(size
);
223 // Sample the masked address
224 if (!stats
.disableAddrDists
) {
225 stats
.readAddrDist
.sample(addr
& readAddrMask
);
228 // If it needs a response increment number of outstanding read
230 if (!stats
.disableOutstandingHists
&& expects_response
) {
231 ++stats
.outstandingReadReqs
;
234 if (!stats
.disableITTDists
) {
235 // Sample value of read-read inter transaction time
236 if (stats
.timeOfLastRead
!= 0) {
237 stats
.ittReadRead
.sample(curTick() - stats
.timeOfLastRead
);
239 stats
.timeOfLastRead
= curTick();
241 // Sample value of req-req inter transaction time
242 if (stats
.timeOfLastReq
!= 0) {
243 stats
.ittReqReq
.sample(curTick() - stats
.timeOfLastReq
);
245 stats
.timeOfLastReq
= curTick();
247 } else if (successful
&& is_write
) {
248 DPRINTF(CommMonitor
, "Forwarded write request\n");
251 if (!stats
.disableTransactionHists
) {
255 if (!stats
.disableBurstLengthHists
) {
256 stats
.writeBurstLengthHist
.sample(size
);
259 // Update the bandwidth stats on the request
260 if (!stats
.disableBandwidthHists
) {
261 stats
.writtenBytes
+= size
;
262 stats
.totalWrittenBytes
+= size
;
265 // Sample the masked write address
266 if (!stats
.disableAddrDists
) {
267 stats
.writeAddrDist
.sample(addr
& writeAddrMask
);
270 if (!stats
.disableOutstandingHists
&& expects_response
) {
271 ++stats
.outstandingWriteReqs
;
274 if (!stats
.disableITTDists
) {
275 // Sample value of write-to-write inter transaction time
276 if (stats
.timeOfLastWrite
!= 0) {
277 stats
.ittWriteWrite
.sample(curTick() - stats
.timeOfLastWrite
);
279 stats
.timeOfLastWrite
= curTick();
281 // Sample value of req-to-req inter transaction time
282 if (stats
.timeOfLastReq
!= 0) {
283 stats
.ittReqReq
.sample(curTick() - stats
.timeOfLastReq
);
285 stats
.timeOfLastReq
= curTick();
287 } else if (successful
) {
288 DPRINTF(CommMonitor
, "Forwarded non read/write request\n");
295 CommMonitor::recvTimingResp(PacketPtr pkt
)
297 // should always see responses
298 assert(pkt
->isResponse());
300 // Store relevant fields of packet, because packet may be modified
301 // or even deleted when sendTiming() is called.
302 bool is_read
= pkt
->isRead();
303 bool is_write
= pkt
->isWrite();
304 unsigned size
= pkt
->getSize();
306 CommMonitorSenderState
* received_state
=
307 dynamic_cast<CommMonitorSenderState
*>(pkt
->senderState
);
309 if (!stats
.disableLatencyHists
) {
310 // Restore initial sender state
311 if (received_state
== NULL
)
312 panic("Monitor got a response without monitor sender state\n");
315 pkt
->senderState
= received_state
->predecessor
;
318 // Attempt to send the packet
319 bool successful
= slavePort
.sendTimingResp(pkt
);
321 if (!stats
.disableLatencyHists
) {
322 // If packet successfully send, sample value of latency,
323 // afterwards delete sender state, otherwise restore state
325 latency
= curTick() - received_state
->transmitTime
;
326 DPRINTF(CommMonitor
, "Latency: %d\n", latency
);
327 delete received_state
;
329 // Don't delete anything and let the packet look like we
331 pkt
->senderState
= received_state
;
335 if (successful
&& is_read
) {
336 // Decrement number of outstanding read requests
337 DPRINTF(CommMonitor
, "Received read response\n");
338 if (!stats
.disableOutstandingHists
) {
339 assert(stats
.outstandingReadReqs
!= 0);
340 --stats
.outstandingReadReqs
;
343 if (!stats
.disableLatencyHists
) {
344 stats
.readLatencyHist
.sample(latency
);
347 // Update the bandwidth stats based on responses for reads
348 if (!stats
.disableBandwidthHists
) {
349 stats
.readBytes
+= size
;
350 stats
.totalReadBytes
+= size
;
353 } else if (successful
&& is_write
) {
354 // Decrement number of outstanding write requests
355 DPRINTF(CommMonitor
, "Received write response\n");
356 if (!stats
.disableOutstandingHists
) {
357 assert(stats
.outstandingWriteReqs
!= 0);
358 --stats
.outstandingWriteReqs
;
361 if (!stats
.disableLatencyHists
) {
362 stats
.writeLatencyHist
.sample(latency
);
364 } else if (successful
) {
365 DPRINTF(CommMonitor
, "Received non read/write response\n");
371 CommMonitor::recvTimingSnoopReq(PacketPtr pkt
)
373 slavePort
.sendTimingSnoopReq(pkt
);
377 CommMonitor::recvTimingSnoopResp(PacketPtr pkt
)
379 return masterPort
.sendTimingSnoopResp(pkt
);
383 CommMonitor::isSnooping() const
385 // check if the connected master port is snooping
386 return slavePort
.isSnooping();
390 CommMonitor::getAddrRanges() const
392 // get the address ranges of the connected slave port
393 return masterPort
.getAddrRanges();
397 CommMonitor::recvRetryMaster()
399 slavePort
.sendRetry();
403 CommMonitor::recvRetrySlave()
405 masterPort
.sendRetry();
409 CommMonitor::recvRangeChange()
411 slavePort
.sendRangeChange();
415 CommMonitor::regStats()
417 // Initialise all the monitor stats
418 using namespace Stats
;
420 stats
.readBurstLengthHist
421 .init(params()->burst_length_bins
)
422 .name(name() + ".readBurstLengthHist")
423 .desc("Histogram of burst lengths of transmitted packets")
424 .flags(stats
.disableBurstLengthHists
? nozero
: pdf
);
426 stats
.writeBurstLengthHist
427 .init(params()->burst_length_bins
)
428 .name(name() + ".writeBurstLengthHist")
429 .desc("Histogram of burst lengths of transmitted packets")
430 .flags(stats
.disableBurstLengthHists
? nozero
: pdf
);
432 // Stats based on received responses
433 stats
.readBandwidthHist
434 .init(params()->bandwidth_bins
)
435 .name(name() + ".readBandwidthHist")
436 .desc("Histogram of read bandwidth per sample period (bytes/s)")
437 .flags(stats
.disableBandwidthHists
? nozero
: pdf
);
440 .name(name() + ".averageReadBandwidth")
441 .desc("Average read bandwidth (bytes/s)")
442 .flags(stats
.disableBandwidthHists
? nozero
: pdf
);
445 .name(name() + ".totalReadBytes")
446 .desc("Number of bytes read")
447 .flags(stats
.disableBandwidthHists
? nozero
: pdf
);
449 stats
.averageReadBW
= stats
.totalReadBytes
/ simSeconds
;
451 // Stats based on successfully sent requests
452 stats
.writeBandwidthHist
453 .init(params()->bandwidth_bins
)
454 .name(name() + ".writeBandwidthHist")
455 .desc("Histogram of write bandwidth (bytes/s)")
456 .flags(stats
.disableBandwidthHists
? (pdf
| nozero
) : pdf
);
459 .name(name() + ".averageWriteBandwidth")
460 .desc("Average write bandwidth (bytes/s)")
461 .flags(stats
.disableBandwidthHists
? nozero
: pdf
);
463 stats
.totalWrittenBytes
464 .name(name() + ".totalWrittenBytes")
465 .desc("Number of bytes written")
466 .flags(stats
.disableBandwidthHists
? nozero
: pdf
);
468 stats
.averageWriteBW
= stats
.totalWrittenBytes
/ simSeconds
;
470 stats
.readLatencyHist
471 .init(params()->latency_bins
)
472 .name(name() + ".readLatencyHist")
473 .desc("Read request-response latency")
474 .flags(stats
.disableLatencyHists
? nozero
: pdf
);
476 stats
.writeLatencyHist
477 .init(params()->latency_bins
)
478 .name(name() + ".writeLatencyHist")
479 .desc("Write request-response latency")
480 .flags(stats
.disableLatencyHists
? nozero
: pdf
);
483 .init(1, params()->itt_max_bin
, params()->itt_max_bin
/
485 .name(name() + ".ittReadRead")
486 .desc("Read-to-read inter transaction time")
487 .flags(stats
.disableITTDists
? nozero
: pdf
);
490 .init(1, params()->itt_max_bin
, params()->itt_max_bin
/
492 .name(name() + ".ittWriteWrite")
493 .desc("Write-to-write inter transaction time")
494 .flags(stats
.disableITTDists
? nozero
: pdf
);
497 .init(1, params()->itt_max_bin
, params()->itt_max_bin
/
499 .name(name() + ".ittReqReq")
500 .desc("Request-to-request inter transaction time")
501 .flags(stats
.disableITTDists
? nozero
: pdf
);
503 stats
.outstandingReadsHist
504 .init(params()->outstanding_bins
)
505 .name(name() + ".outstandingReadsHist")
506 .desc("Outstanding read transactions")
507 .flags(stats
.disableOutstandingHists
? nozero
: pdf
);
509 stats
.outstandingWritesHist
510 .init(params()->outstanding_bins
)
511 .name(name() + ".outstandingWritesHist")
512 .desc("Outstanding write transactions")
513 .flags(stats
.disableOutstandingHists
? nozero
: pdf
);
516 .init(params()->transaction_bins
)
517 .name(name() + ".readTransHist")
518 .desc("Histogram of read transactions per sample period")
519 .flags(stats
.disableTransactionHists
? nozero
: pdf
);
522 .init(params()->transaction_bins
)
523 .name(name() + ".writeTransHist")
524 .desc("Histogram of read transactions per sample period")
525 .flags(stats
.disableTransactionHists
? nozero
: pdf
);
529 .name(name() + ".readAddrDist")
530 .desc("Read address distribution")
531 .flags(stats
.disableAddrDists
? nozero
: pdf
);
535 .name(name() + ".writeAddrDist")
536 .desc("Write address distribution")
537 .flags(stats
.disableAddrDists
? nozero
: pdf
);
541 CommMonitor::samplePeriodic()
543 // the periodic stats update runs on the granularity of sample
544 // periods, but in combination with this there may also be a
545 // external resets and dumps of the stats (through schedStatEvent)
546 // causing the stats themselves to capture less than a sample
549 // only capture if we have not reset the stats during the last
551 if (simTicks
.value() >= samplePeriodTicks
) {
552 if (!stats
.disableTransactionHists
) {
553 stats
.readTransHist
.sample(stats
.readTrans
);
554 stats
.writeTransHist
.sample(stats
.writeTrans
);
557 if (!stats
.disableBandwidthHists
) {
558 stats
.readBandwidthHist
.sample(stats
.readBytes
/ samplePeriod
);
559 stats
.writeBandwidthHist
.sample(stats
.writtenBytes
/ samplePeriod
);
562 if (!stats
.disableOutstandingHists
) {
563 stats
.outstandingReadsHist
.sample(stats
.outstandingReadReqs
);
564 stats
.outstandingWritesHist
.sample(stats
.outstandingWriteReqs
);
568 // reset the sampled values
570 stats
.writeTrans
= 0;
573 stats
.writtenBytes
= 0;
575 schedule(samplePeriodicEvent
, curTick() + samplePeriodTicks
);
579 CommMonitor::startup()
581 schedule(samplePeriodicEvent
, curTick() + samplePeriodTicks
);