1/*
2 * Copyright (c) 2012-2014 ARM Limited
3 * All rights reserved.
4 *
5 * The license below extends only to copyright in the software and shall
6 * not be construed as granting a license to any other intellectual
7 * property including but not limited to intellectual property relating
8 * to a hardware implementation of the functionality of the software
9 * licensed hereunder.  You may use the software subject to the license
10 * terms below provided that you ensure that this notice is replicated
11 * unmodified and in its entirety in all distributions of the software,
12 * modified or unmodified, in source code or in binary form.
13 *
14 * Copyright (c) 2003-2005,2014 The Regents of The University of Michigan
15 * All rights reserved.
16 *
17 * Redistribution and use in source and binary forms, with or without
18 * modification, are permitted provided that the following conditions are
19 * met: redistributions of source code must retain the above copyright
20 * notice, this list of conditions and the following disclaimer;
21 * redistributions in binary form must reproduce the above copyright
22 * notice, this list of conditions and the following disclaimer in the
23 * documentation and/or other materials provided with the distribution;
24 * neither the name of the copyright holders nor the names of its
25 * contributors may be used to endorse or promote products derived from
26 * this software without specific prior written permission.
27 *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 *
40 * Authors: Erik Hallnor
41 */
42
43/**
44 * @file
45 * Definitions of a conventional tag store.
46 */
47
48#include "mem/cache/tags/base_set_assoc.hh"
49
50#include <string>
51
52#include "base/intmath.hh"
53
54BaseSetAssoc::BaseSetAssoc(const Params *p)
55    :BaseTags(p), allocAssoc(p->assoc), blks(p->size / p->block_size),
56     sequentialAccess(p->sequential_access),
57     replacementPolicy(p->replacement_policy)
58{
59    // Check parameters
60    if (blkSize < 4 || !isPowerOf2(blkSize)) {
61        fatal("Block size must be at least 4 and a power of 2");
62    }
63}
64
65void
66BaseSetAssoc::tagsInit()
67{
68    // Initialize all blocks
69    for (unsigned blk_index = 0; blk_index < numBlocks; blk_index++) {
70        // Locate next cache block
71        CacheBlk* blk = &blks[blk_index];
72
73        // Link block to indexing policy
74        indexingPolicy->setEntry(blk, blk_index);
75
76        // Associate a data chunk to the block
77        blk->data = &dataBlks[blkSize*blk_index];
78
79        // Associate a replacement data entry to the block
80        blk->replacementData = replacementPolicy->instantiateEntry();
81    }
82}
83
84void
85BaseSetAssoc::invalidate(CacheBlk *blk)
86{
87    BaseTags::invalidate(blk);
88
89    // Decrease the number of tags in use
90    tagsInUse--;
91
92    // Invalidate replacement data
93    replacementPolicy->invalidate(blk->replacementData);
94}
95
96BaseSetAssoc *
97BaseSetAssocParams::create()
98{
99    // There must be a indexing policy
100    fatal_if(!indexing_policy, "An indexing policy is required");
101
102    return new BaseSetAssoc(this);
103}
104