1/*
2 * Copyright (c) 2012 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 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 * Ron Dreslinski
42 */
43
44/**
45 * @file
46 * Declaration of a common base class for cache tagstore objects.
47 */
48
49#ifndef __BASE_TAGS_HH__
50#define __BASE_TAGS_HH__
51
52#include <string>
53
54#include "base/callback.hh"
55#include "base/statistics.hh"
56
57class BaseCache;
58
59/**
60 * A common base class of Cache tagstore objects.
61 */
62class BaseTags
63{
64 protected:
65 /** Pointer to the parent cache. */
66 BaseCache *cache;
67
68 /** Local copy of the parent cache name. Used for DPRINTF. */
69 std::string objName;
70
71 /**
72 * The number of tags that need to be touched to meet the warmup
73 * percentage.
74 */
75 int warmupBound;
76 /** Marked true when the cache is warmed up. */
77 bool warmedUp;
78
79 /** the number of blocks in the cache */
80 unsigned numBlocks;
81
82 // Statistics
83 /**
84 * @addtogroup CacheStatistics
85 * @{
86 */
87
88 /** Number of replacements of valid blocks per thread. */
89 Stats::Vector replacements;
90 /** Per cycle average of the number of tags that hold valid data. */
91 Stats::Average tagsInUse;
92
93 /** The total number of references to a block before it is replaced. */
94 Stats::Scalar totalRefs;
95
96 /**
97 * The number of reference counts sampled. This is different from
98 * replacements because we sample all the valid blocks when the simulator
99 * exits.
100 */
101 Stats::Scalar sampledRefs;
102
103 /**
104 * Average number of references to a block before is was replaced.
105 * @todo This should change to an average stat once we have them.
106 */
107 Stats::Formula avgRefs;
108
109 /** The cycle that the warmup percentage was hit. */
110 Stats::Scalar warmupCycle;
111
112 /** Average occupancy of each requestor using the cache */
113 Stats::AverageVector occupancies;
114
115 /** Average occ % of each requestor using the cache */
116 Stats::Formula avgOccs;
117
118 /**
119 * @}
120 */
121
122 public:
123
124 /**
125 * Destructor.
126 */
127 virtual ~BaseTags() {}
128
129 /**
130 * Set the parent cache back pointer. Also copies the cache name to
131 * objName.
132 * @param _cache Pointer to parent cache.
133 */
134 void setCache(BaseCache *_cache);
135
136 /**
137 * Return the parent cache name.
138 * @return the parent cache name.
139 */
140 const std::string &name() const
141 {
142 return objName;
143 }
144
145 /**
146 * Register local statistics.
147 * @param name The name to preceed each statistic name.
148 */
149 void regStats(const std::string &name);
150
151 /**
152 * Average in the reference count for valid blocks when the simulation
153 * exits.
154 */
155 virtual void cleanupRefs() {}
156
157 /**
158 *iterated through all blocks and clear all locks
159 *Needed to clear all lock tracking at once
160 */
161 virtual void clearLocks() {}
| 1/*
2 * Copyright (c) 2012 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 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 * Ron Dreslinski
42 */
43
44/**
45 * @file
46 * Declaration of a common base class for cache tagstore objects.
47 */
48
49#ifndef __BASE_TAGS_HH__
50#define __BASE_TAGS_HH__
51
52#include <string>
53
54#include "base/callback.hh"
55#include "base/statistics.hh"
56
57class BaseCache;
58
59/**
60 * A common base class of Cache tagstore objects.
61 */
62class BaseTags
63{
64 protected:
65 /** Pointer to the parent cache. */
66 BaseCache *cache;
67
68 /** Local copy of the parent cache name. Used for DPRINTF. */
69 std::string objName;
70
71 /**
72 * The number of tags that need to be touched to meet the warmup
73 * percentage.
74 */
75 int warmupBound;
76 /** Marked true when the cache is warmed up. */
77 bool warmedUp;
78
79 /** the number of blocks in the cache */
80 unsigned numBlocks;
81
82 // Statistics
83 /**
84 * @addtogroup CacheStatistics
85 * @{
86 */
87
88 /** Number of replacements of valid blocks per thread. */
89 Stats::Vector replacements;
90 /** Per cycle average of the number of tags that hold valid data. */
91 Stats::Average tagsInUse;
92
93 /** The total number of references to a block before it is replaced. */
94 Stats::Scalar totalRefs;
95
96 /**
97 * The number of reference counts sampled. This is different from
98 * replacements because we sample all the valid blocks when the simulator
99 * exits.
100 */
101 Stats::Scalar sampledRefs;
102
103 /**
104 * Average number of references to a block before is was replaced.
105 * @todo This should change to an average stat once we have them.
106 */
107 Stats::Formula avgRefs;
108
109 /** The cycle that the warmup percentage was hit. */
110 Stats::Scalar warmupCycle;
111
112 /** Average occupancy of each requestor using the cache */
113 Stats::AverageVector occupancies;
114
115 /** Average occ % of each requestor using the cache */
116 Stats::Formula avgOccs;
117
118 /**
119 * @}
120 */
121
122 public:
123
124 /**
125 * Destructor.
126 */
127 virtual ~BaseTags() {}
128
129 /**
130 * Set the parent cache back pointer. Also copies the cache name to
131 * objName.
132 * @param _cache Pointer to parent cache.
133 */
134 void setCache(BaseCache *_cache);
135
136 /**
137 * Return the parent cache name.
138 * @return the parent cache name.
139 */
140 const std::string &name() const
141 {
142 return objName;
143 }
144
145 /**
146 * Register local statistics.
147 * @param name The name to preceed each statistic name.
148 */
149 void regStats(const std::string &name);
150
151 /**
152 * Average in the reference count for valid blocks when the simulation
153 * exits.
154 */
155 virtual void cleanupRefs() {}
156
157 /**
158 *iterated through all blocks and clear all locks
159 *Needed to clear all lock tracking at once
160 */
161 virtual void clearLocks() {}
|