1# Copyright (c) 2014-2015 ARM Limited
2# All rights reserved.
3#
4# The license below extends only to copyright in the software and shall
5# not be construed as granting a license to any other intellectual
6# property including but not limited to intellectual property relating
7# to a hardware implementation of the functionality of the software
8# licensed hereunder.  You may use the software subject to the license
9# terms below provided that you ensure that this notice is replicated
10# unmodified and in its entirety in all distributions of the software,
11# modified or unmodified, in source code or in binary form.
12#
13# Redistribution and use in source and binary forms, with or without
14# modification, are permitted provided that the following conditions are
15# met: redistributions of source code must retain the above copyright
16# notice, this list of conditions and the following disclaimer;
17# redistributions in binary form must reproduce the above copyright
18# notice, this list of conditions and the following disclaimer in the
19# documentation and/or other materials provided with the distribution;
20# neither the name of the copyright holders nor the names of its
21# contributors may be used to endorse or promote products derived from
22# this software without specific prior written permission.
23#
24# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
27# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
28# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
29# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
30# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
34# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35#
36# Authors: Andreas Hansson
37#          Andreas Sandberg
38
39from m5.params import *
40from m5.proxy import *
41from m5.objects.BaseMemProbe import BaseMemProbe
42
43class StackDistProbe(BaseMemProbe):
44    type = 'StackDistProbe'
45    cxx_header = "mem/probes/stack_dist.hh"
46
47    system = Param.System(Parent.any,
48                          "System to use when determining system cache "
49                          "line size")
50
51    line_size = Param.Unsigned(Parent.cache_line_size,
52                               "Cache line size in bytes (must be larger or "
53                               "equal to the system's line size)")
54
55    # enable verification stack
56    verify = Param.Bool(False, "Verify behaviuor with reference implementation")
57
58    # linear histogram bins and enable/disable
59    linear_hist_bins = Param.Unsigned('16', "Bins in linear histograms")
60    disable_linear_hists = Param.Bool(False, "Disable linear histograms")
61
62    # logarithmic histogram bins and enable/disable
63    log_hist_bins = Param.Unsigned('32', "Bins in logarithmic histograms")
64    disable_log_hists = Param.Bool(False, "Disable logarithmic histograms")
65