<reponame>delorean-sim/gem5
# Copyright (c) 2012-2019 <NAME>
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met: redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer;
# redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution;
# neither the name of the copyright holders nor the names of its
# contributors may be used to endorse or promote products derived from
# this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
# Authors: <NAME>

from m5.params import *
from m5.proxy import Parent
from m5.SimObject import SimObject
from m5.util.pybind import *

class MemSampler(SimObject):
    """Probe for collecting memory reuse distances and strides."""

    type = 'MemSampler'
    cxx_header = "model/mem_sampler.hh"

    blockSize = Param.Unsigned(Parent.cache_line_size, "Sampling block size")
    windowSize = Param.Unsigned(10000, "Sampling window size")
    excludeKernel = Param.Bool(True, "Ignore memory accesses from kernelspace")
    system = Param.System(Parent.any, "system")

    cxx_exports = [
        PyBindMethod("loadAccesses"),
        PyBindMethod("save"),
        PyBindMethod("setSamplingPeriod"),
        PyBindMethod("stage"),
    ]
