CommMonitor.py revision 9398:6a348f61220c
19241Sandreas.hansson@arm.com# Copyright (c) 2012 ARM Limited 29241Sandreas.hansson@arm.com# All rights reserved. 39241Sandreas.hansson@arm.com# 49241Sandreas.hansson@arm.com# The license below extends only to copyright in the software and shall 59241Sandreas.hansson@arm.com# not be construed as granting a license to any other intellectual 69241Sandreas.hansson@arm.com# property including but not limited to intellectual property relating 79241Sandreas.hansson@arm.com# to a hardware implementation of the functionality of the software 89241Sandreas.hansson@arm.com# licensed hereunder. You may use the software subject to the license 99241Sandreas.hansson@arm.com# terms below provided that you ensure that this notice is replicated 109241Sandreas.hansson@arm.com# unmodified and in its entirety in all distributions of the software, 119241Sandreas.hansson@arm.com# modified or unmodified, in source code or in binary form. 129241Sandreas.hansson@arm.com# 139241Sandreas.hansson@arm.com# Redistribution and use in source and binary forms, with or without 149241Sandreas.hansson@arm.com# modification, are permitted provided that the following conditions are 159241Sandreas.hansson@arm.com# met: redistributions of source code must retain the above copyright 169241Sandreas.hansson@arm.com# notice, this list of conditions and the following disclaimer; 179241Sandreas.hansson@arm.com# redistributions in binary form must reproduce the above copyright 189241Sandreas.hansson@arm.com# notice, this list of conditions and the following disclaimer in the 199241Sandreas.hansson@arm.com# documentation and/or other materials provided with the distribution; 209241Sandreas.hansson@arm.com# neither the name of the copyright holders nor the names of its 219241Sandreas.hansson@arm.com# contributors may be used to endorse or promote products derived from 229241Sandreas.hansson@arm.com# this software without specific prior written permission. 239241Sandreas.hansson@arm.com# 249241Sandreas.hansson@arm.com# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 259241Sandreas.hansson@arm.com# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 269241Sandreas.hansson@arm.com# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 279241Sandreas.hansson@arm.com# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 289241Sandreas.hansson@arm.com# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 299241Sandreas.hansson@arm.com# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 309241Sandreas.hansson@arm.com# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 319241Sandreas.hansson@arm.com# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 329241Sandreas.hansson@arm.com# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 339241Sandreas.hansson@arm.com# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 349241Sandreas.hansson@arm.com# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 359241Sandreas.hansson@arm.com# 369241Sandreas.hansson@arm.com# Authors: Thomas Grass 379241Sandreas.hansson@arm.com# Andreas Hansson 389241Sandreas.hansson@arm.com 399241Sandreas.hansson@arm.comfrom m5.params import * 409241Sandreas.hansson@arm.comfrom MemObject import MemObject 419241Sandreas.hansson@arm.com 429241Sandreas.hansson@arm.com# The communication monitor will most typically be used in combination 439241Sandreas.hansson@arm.com# with periodic dumping and resetting of stats using schedStatEvent 449241Sandreas.hansson@arm.comclass CommMonitor(MemObject): 459241Sandreas.hansson@arm.com type = 'CommMonitor' 469241Sandreas.hansson@arm.com cxx_header = "mem/comm_monitor.hh" 479241Sandreas.hansson@arm.com 489241Sandreas.hansson@arm.com # one port in each direction 499241Sandreas.hansson@arm.com master = MasterPort("Master port") 509241Sandreas.hansson@arm.com slave = SlavePort("Slave port") 519241Sandreas.hansson@arm.com 529241Sandreas.hansson@arm.com # packet trace output file, disabled by default 539241Sandreas.hansson@arm.com trace_file = Param.String("", "Packet trace output file") 549241Sandreas.hansson@arm.com 559241Sandreas.hansson@arm.com # control the sample period window length of this monitor 569241Sandreas.hansson@arm.com sample_period = Param.Clock("1ms", "Sample period for histograms") 579241Sandreas.hansson@arm.com 589241Sandreas.hansson@arm.com # for each histogram, set the number of bins and enable the user 599241Sandreas.hansson@arm.com # to disable the measurement, reads and writes use the same 609241Sandreas.hansson@arm.com # parameters 619241Sandreas.hansson@arm.com 629241Sandreas.hansson@arm.com # histogram of burst length of packets (not using sample period) 639241Sandreas.hansson@arm.com burst_length_bins = Param.Unsigned('20', "# bins in burst length " \ 649241Sandreas.hansson@arm.com "histograms") 659241Sandreas.hansson@arm.com disable_burst_length_hists = Param.Bool(False, "Disable burst length " \ 669241Sandreas.hansson@arm.com "histograms") 679241Sandreas.hansson@arm.com 689241Sandreas.hansson@arm.com # bandwidth per sample period 699241Sandreas.hansson@arm.com bandwidth_bins = Param.Unsigned('20', "# bins in bandwidth histograms") 709241Sandreas.hansson@arm.com disable_bandwidth_hists = Param.Bool(False, "Disable bandwidth histograms") 719241Sandreas.hansson@arm.com 729241Sandreas.hansson@arm.com # latency from request to response (not using sample period) 739241Sandreas.hansson@arm.com latency_bins = Param.Unsigned('20', "# bins in latency histograms") 749241Sandreas.hansson@arm.com disable_latency_hists = Param.Bool(False, "Disable latency histograms") 759241Sandreas.hansson@arm.com 769241Sandreas.hansson@arm.com # inter transaction time (ITT) distributions in uniformly sized 779241Sandreas.hansson@arm.com # bins up to the maximum, independently for read-to-read, 789241Sandreas.hansson@arm.com # write-to-write and the combined request-to-request that does not 799241Sandreas.hansson@arm.com # separate read and write requests 809241Sandreas.hansson@arm.com itt_bins = Param.Unsigned('20', "# bins in ITT distributions") 819241Sandreas.hansson@arm.com itt_max_bin = Param.Latency('100ns', "Max bin of ITT distributions") 829241Sandreas.hansson@arm.com disable_itt_dists = Param.Bool(False, "Disable ITT distributions") 839241Sandreas.hansson@arm.com 849241Sandreas.hansson@arm.com # outstanding requests (that did not yet get a response) per 859241Sandreas.hansson@arm.com # sample period 869241Sandreas.hansson@arm.com outstanding_bins = Param.Unsigned('20', "# bins in outstanding " \ 879241Sandreas.hansson@arm.com "requests histograms") 889241Sandreas.hansson@arm.com disable_outstanding_hists = Param.Bool(False, "Disable outstanding " \ 899241Sandreas.hansson@arm.com "requests histograms") 909241Sandreas.hansson@arm.com 919241Sandreas.hansson@arm.com # transactions (requests) observed per sample period 929241Sandreas.hansson@arm.com transaction_bins = Param.Unsigned('20', "# bins in transaction " \ 939241Sandreas.hansson@arm.com "count histograms") 949241Sandreas.hansson@arm.com disable_transaction_hists = Param.Bool(False, "Disable transaction count " \ 959241Sandreas.hansson@arm.com "histograms") 969241Sandreas.hansson@arm.com 979241Sandreas.hansson@arm.com # address distributions (heatmaps) with associated address masks 989241Sandreas.hansson@arm.com # to selectively only look at certain bits of the address 999241Sandreas.hansson@arm.com read_addr_mask = Param.Addr(MaxAddr, "Address mask for read address") 1009241Sandreas.hansson@arm.com write_addr_mask = Param.Addr(MaxAddr, "Address mask for write address") 1019241Sandreas.hansson@arm.com disable_addr_dists = Param.Bool(True, "Disable address distributions") 1029241Sandreas.hansson@arm.com