src/mem/ruby/structures/RubyPrefetcher.py

   1 # Copyright (c) 2020 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 # Copyright (c) 2012 Mark D. Hill and David A. Wood
  14 # All rights reserved.
  15 #
  16 # Redistribution and use in source and binary forms, with or without
  17 # modification, are permitted provided that the following conditions are
  18 # met: redistributions of source code must retain the above copyright
  19 # notice, this list of conditions and the following disclaimer;
  20 # redistributions in binary form must reproduce the above copyright
  21 # notice, this list of conditions and the following disclaimer in the
  22 # documentation and/or other materials provided with the distribution;
  23 # neither the name of the copyright holders nor the names of its
  24 # contributors may be used to endorse or promote products derived from
  25 # this software without specific prior written permission.
  26 #
  27 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  28 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  29 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  30 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  31 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  32 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  33 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  34 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  35 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  36 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  37 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  38
  39 from m5.SimObject import SimObject
  40 from m5.params import *
  41 from m5.proxy import *
  42
  43 from m5.objects.System import System
  44
  45 class RubyPrefetcher(SimObject):
  46     type = 'RubyPrefetcher'
  47     cxx_class = 'RubyPrefetcher'
  48     cxx_header = "mem/ruby/structures/RubyPrefetcher.hh"
  49
  50     num_streams = Param.UInt32(4,
  51         "Number of prefetch streams to be allocated")
  52     unit_filter  = Param.UInt32(8,
  53         "Number of entries in the unit filter array")
  54     nonunit_filter = Param.UInt32(8,
  55         "Number of entries in the non-unit filter array")
  56     train_misses = Param.UInt32(4, "")
  57     num_startup_pfs = Param.UInt32(1, "")
  58     cross_page = Param.Bool(False, """True if prefetched address can be on a
  59             page different from the observed address""")
  60     sys = Param.System(Parent.any, "System this prefetcher belongs to")
  61
  62 class Prefetcher(RubyPrefetcher):
  63     """DEPRECATED"""
  64     pass