1# Copyright (c) 2013 - 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: Radhika Jagtap
37#          Andreas Hansson
38#          Thomas Grass
39
40from m5.objects.Probe import *
41
42class ElasticTrace(ProbeListenerObject):
43    type = 'ElasticTrace'
44    cxx_header = 'cpu/o3/probe/elastic_trace.hh'
45
46    # Trace files for the following params are created in the output directory.
47    # User is forced to provide these when an instance of this class is created.
48    instFetchTraceFile = Param.String(desc="Protobuf trace file name for " \
49                                        "instruction fetch tracing")
50    dataDepTraceFile = Param.String(desc="Protobuf trace file name for " \
51                                    "data dependency tracing")
52    # The dependency window size param must be equal to or greater than the
53    # number of entries in the O3CPU ROB, a typical value is 3 times ROB size
54    depWindowSize = Param.Unsigned(desc="Instruction window size used for " \
55                                    "recording and processing data " \
56                                    "dependencies")
57    # The committed instruction count from which to start tracing
58    startTraceInst = Param.UInt64(0, "The number of committed instructions " \
59                                    "after which to start tracing. Default " \
60                                    "zero means start tracing from first " \
61                                    "committed instruction.")
62    # Whether to trace virtual addresses for memory accesses
63    traceVirtAddr = Param.Bool(False, "Set to true if virtual addresses are " \
64                                "to be traced.")
65