Tags.py revision 13418:08101e89101e 
1# Copyright (c) 2012-2013 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: Prakash Ramrakhyani
37
38from m5.params import *
39from m5.proxy import *
40from ClockedObject import ClockedObject
41from IndexingPolicies import *
42
43class BaseTags(ClockedObject):
44    type = 'BaseTags'
45    abstract = True
46    cxx_header = "mem/cache/tags/base.hh"
47    # Get the size from the parent (cache)
48    size = Param.MemorySize(Parent.size, "capacity in bytes")
49
50    # Get the block size from the parent (system)
51    block_size = Param.Int(Parent.cache_line_size, "block size in bytes")
52
53    # Get the tag lookup latency from the parent (cache)
54    tag_latency = Param.Cycles(Parent.tag_latency,
55                               "The tag lookup latency for this cache")
56
57    # Get the warmup percentage from the parent (cache)
58    warmup_percentage = Param.Percent(Parent.warmup_percentage,
59        "Percentage of tags to be touched to warm up the cache")
60
61    sequential_access = Param.Bool(Parent.sequential_access,
62        "Whether to access tags and data sequentially")
63
64    # Get indexing policy
65    indexing_policy = Param.BaseIndexingPolicy(SetAssociative(),
66        "Indexing policy")
67
68    # Set the indexing entry size as the block size
69    entry_size = Param.Int(Parent.cache_line_size,
70                           "Indexing entry size in bytes")
71
72class BaseSetAssoc(BaseTags):
73    type = 'BaseSetAssoc'
74    cxx_header = "mem/cache/tags/base_set_assoc.hh"
75
76    # Get the cache associativity
77    assoc = Param.Int(Parent.assoc, "associativity")
78
79    # Get replacement policy from the parent (cache)
80    replacement_policy = Param.BaseReplacementPolicy(
81        Parent.replacement_policy, "Replacement policy")
82
83class SectorTags(BaseTags):
84    type = 'SectorTags'
85    cxx_header = "mem/cache/tags/sector_tags.hh"
86
87    # Get the cache associativity
88    assoc = Param.Int(Parent.assoc, "associativity")
89
90    # Number of sub-sectors (data blocks) per sector
91    num_blocks_per_sector = Param.Int(1, "Number of sub-sectors per sector");
92
93    # The indexing entry now is a sector block
94    entry_size = Parent.cache_line_size * Self.num_blocks_per_sector
95
96    # Get replacement policy from the parent (cache)
97    replacement_policy = Param.BaseReplacementPolicy(
98        Parent.replacement_policy, "Replacement policy")
99
100class FALRU(BaseTags):
101    type = 'FALRU'
102    cxx_class = 'FALRU'
103    cxx_header = "mem/cache/tags/fa_lru.hh"
104
105    min_tracked_cache_size = Param.MemorySize("128kB", "Minimum cache size for"
106                                              " which we track statistics")
107
108    # This tag uses its own embedded indexing
109    indexing_policy = NULL
110