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