CommMonitor.py revision 9398
18981Sandreas.hansson@arm.com# Copyright (c) 2012 ARM Limited 28981Sandreas.hansson@arm.com# All rights reserved. 38981Sandreas.hansson@arm.com# 48981Sandreas.hansson@arm.com# The license below extends only to copyright in the software and shall 58981Sandreas.hansson@arm.com# not be construed as granting a license to any other intellectual 68981Sandreas.hansson@arm.com# property including but not limited to intellectual property relating 78981Sandreas.hansson@arm.com# to a hardware implementation of the functionality of the software 88981Sandreas.hansson@arm.com# licensed hereunder. You may use the software subject to the license 98981Sandreas.hansson@arm.com# terms below provided that you ensure that this notice is replicated 108981Sandreas.hansson@arm.com# unmodified and in its entirety in all distributions of the software, 118981Sandreas.hansson@arm.com# modified or unmodified, in source code or in binary form. 128981Sandreas.hansson@arm.com# 138981Sandreas.hansson@arm.com# Redistribution and use in source and binary forms, with or without 148981Sandreas.hansson@arm.com# modification, are permitted provided that the following conditions are 158981Sandreas.hansson@arm.com# met: redistributions of source code must retain the above copyright 168981Sandreas.hansson@arm.com# notice, this list of conditions and the following disclaimer; 178981Sandreas.hansson@arm.com# redistributions in binary form must reproduce the above copyright 188981Sandreas.hansson@arm.com# notice, this list of conditions and the following disclaimer in the 198981Sandreas.hansson@arm.com# documentation and/or other materials provided with the distribution; 208981Sandreas.hansson@arm.com# neither the name of the copyright holders nor the names of its 218981Sandreas.hansson@arm.com# contributors may be used to endorse or promote products derived from 228981Sandreas.hansson@arm.com# this software without specific prior written permission. 238981Sandreas.hansson@arm.com# 248981Sandreas.hansson@arm.com# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 258981Sandreas.hansson@arm.com# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 268981Sandreas.hansson@arm.com# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 278981Sandreas.hansson@arm.com# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 288981Sandreas.hansson@arm.com# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 298981Sandreas.hansson@arm.com# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 308981Sandreas.hansson@arm.com# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 318981Sandreas.hansson@arm.com# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 328981Sandreas.hansson@arm.com# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 338981Sandreas.hansson@arm.com# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 348981Sandreas.hansson@arm.com# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 358981Sandreas.hansson@arm.com# 368981Sandreas.hansson@arm.com# Authors: Thomas Grass 378981Sandreas.hansson@arm.com# Andreas Hansson 388981Sandreas.hansson@arm.com 398981Sandreas.hansson@arm.comfrom m5.params import * 408981Sandreas.hansson@arm.comfrom MemObject import MemObject 418981Sandreas.hansson@arm.com 428981Sandreas.hansson@arm.com# The communication monitor will most typically be used in combination 438981Sandreas.hansson@arm.com# with periodic dumping and resetting of stats using schedStatEvent 448981Sandreas.hansson@arm.comclass CommMonitor(MemObject): 458981Sandreas.hansson@arm.com type = 'CommMonitor' 469338SAndreas.Sandberg@arm.com cxx_header = "mem/comm_monitor.hh" 478981Sandreas.hansson@arm.com 488981Sandreas.hansson@arm.com # one port in each direction 498981Sandreas.hansson@arm.com master = MasterPort("Master port") 508981Sandreas.hansson@arm.com slave = SlavePort("Slave port") 518981Sandreas.hansson@arm.com 529398Sandreas.hansson@arm.com # packet trace output file, disabled by default 539398Sandreas.hansson@arm.com trace_file = Param.String("", "Packet trace output file") 549398Sandreas.hansson@arm.com 558981Sandreas.hansson@arm.com # control the sample period window length of this monitor 568981Sandreas.hansson@arm.com sample_period = Param.Clock("1ms", "Sample period for histograms") 578981Sandreas.hansson@arm.com 588981Sandreas.hansson@arm.com # for each histogram, set the number of bins and enable the user 598981Sandreas.hansson@arm.com # to disable the measurement, reads and writes use the same 608981Sandreas.hansson@arm.com # parameters 618981Sandreas.hansson@arm.com 628981Sandreas.hansson@arm.com # histogram of burst length of packets (not using sample period) 638981Sandreas.hansson@arm.com burst_length_bins = Param.Unsigned('20', "# bins in burst length " \ 648981Sandreas.hansson@arm.com "histograms") 658981Sandreas.hansson@arm.com disable_burst_length_hists = Param.Bool(False, "Disable burst length " \ 668981Sandreas.hansson@arm.com "histograms") 678981Sandreas.hansson@arm.com 688981Sandreas.hansson@arm.com # bandwidth per sample period 698981Sandreas.hansson@arm.com bandwidth_bins = Param.Unsigned('20', "# bins in bandwidth histograms") 708981Sandreas.hansson@arm.com disable_bandwidth_hists = Param.Bool(False, "Disable bandwidth histograms") 718981Sandreas.hansson@arm.com 728981Sandreas.hansson@arm.com # latency from request to response (not using sample period) 738981Sandreas.hansson@arm.com latency_bins = Param.Unsigned('20', "# bins in latency histograms") 748981Sandreas.hansson@arm.com disable_latency_hists = Param.Bool(False, "Disable latency histograms") 758981Sandreas.hansson@arm.com 768981Sandreas.hansson@arm.com # inter transaction time (ITT) distributions in uniformly sized 778981Sandreas.hansson@arm.com # bins up to the maximum, independently for read-to-read, 788981Sandreas.hansson@arm.com # write-to-write and the combined request-to-request that does not 798981Sandreas.hansson@arm.com # separate read and write requests 808981Sandreas.hansson@arm.com itt_bins = Param.Unsigned('20', "# bins in ITT distributions") 818981Sandreas.hansson@arm.com itt_max_bin = Param.Latency('100ns', "Max bin of ITT distributions") 828981Sandreas.hansson@arm.com disable_itt_dists = Param.Bool(False, "Disable ITT distributions") 838981Sandreas.hansson@arm.com 848981Sandreas.hansson@arm.com # outstanding requests (that did not yet get a response) per 858981Sandreas.hansson@arm.com # sample period 868981Sandreas.hansson@arm.com outstanding_bins = Param.Unsigned('20', "# bins in outstanding " \ 878981Sandreas.hansson@arm.com "requests histograms") 888981Sandreas.hansson@arm.com disable_outstanding_hists = Param.Bool(False, "Disable outstanding " \ 898981Sandreas.hansson@arm.com "requests histograms") 908981Sandreas.hansson@arm.com 918981Sandreas.hansson@arm.com # transactions (requests) observed per sample period 928981Sandreas.hansson@arm.com transaction_bins = Param.Unsigned('20', "# bins in transaction " \ 938981Sandreas.hansson@arm.com "count histograms") 948981Sandreas.hansson@arm.com disable_transaction_hists = Param.Bool(False, "Disable transaction count " \ 958981Sandreas.hansson@arm.com "histograms") 968981Sandreas.hansson@arm.com 978981Sandreas.hansson@arm.com # address distributions (heatmaps) with associated address masks 988981Sandreas.hansson@arm.com # to selectively only look at certain bits of the address 998981Sandreas.hansson@arm.com read_addr_mask = Param.Addr(MaxAddr, "Address mask for read address") 1008981Sandreas.hansson@arm.com write_addr_mask = Param.Addr(MaxAddr, "Address mask for write address") 1018981Sandreas.hansson@arm.com disable_addr_dists = Param.Bool(True, "Disable address distributions") 102