1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
|
/* Copyright (c) 2015, 2025, Oracle and/or its affiliates.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License, version 2.0,
as published by the Free Software Foundation.
This program is designed to work with certain software (including
but not limited to OpenSSL) that is licensed under separate terms,
as designated in a particular file or component or in included license
documentation. The authors of MySQL hereby grant you an additional
permission to link the program and your derivative works with the
separately licensed software that they have either included with
the program or referenced in the documentation.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License, version 2.0, for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */
#ifndef DD_CACHE__FREE_LIST_INCLUDED
#define DD_CACHE__FREE_LIST_INCLUDED
#include <assert.h>
#include <vector> // vector
#include "sql/malloc_allocator.h" // Malloc_allocator.
#include "sql/psi_memory_key.h" // key_memory_DD_cache_infrastructure
namespace dd {
namespace cache {
/**
Template for management of a free list based on a std::vector.
The free list template defines functions mostly wrapping the std::vector
functions, but additionally doing some asserts to ensure correct usage.
The first element in the free list is the least recently used element.
When a new element becomes unused, it is added to the end of the free list.
An element may also be removed from within the middle of the free list
when the element is being acquired. This use case means iterating through
the vector to find the correct element.
@tparam E Element type (a Cache_element wrapping some dictionary
object type).
*/
template <typename E>
class Free_list {
private:
typedef std::vector<E *, Malloc_allocator<E *>> List_type;
List_type m_list; // The actual list.
public:
Free_list()
: m_list(Malloc_allocator<E *>(key_memory_DD_cache_infrastructure)) {}
// Return the actual free list length.
size_t length() const { return m_list.size(); }
/**
Add an element to the end of the free list.
@param element Element to add to the end of the list.
*/
void add_last(E *element) {
assert(element != nullptr && element->usage() == 0);
m_list.push_back(element);
}
/**
Remove an element from the free list.
@param element Element to be removed from the list.
*/
void remove(E *element) {
assert(element != nullptr && element->usage() == 0);
assert(!m_list.empty());
for (typename List_type::iterator it = m_list.begin(); it != m_list.end();
++it)
if (*it == element) {
m_list.erase(it);
return;
}
assert(false); /* purecov: deadcode */
}
/**
Get the least recently used element in the list, i.e., the first element.
@return The least recently used element in the list.
*/
E *get_lru() const {
assert(!m_list.empty());
if (!m_list.empty()) return m_list.front();
return nullptr;
}
/**
Debug dump of the free list to stderr.
*/
/* purecov: begin inspected */
void dump() const {
#ifndef NDEBUG
if (m_list.empty()) {
fprintf(stderr, " lru-> NULL\n");
return;
}
fprintf(stderr, " lru-> ");
for (typename List_type::const_iterator it = m_list.begin();
it != m_list.end(); ++it)
fprintf(stderr, "%llu ", (*it)->object()->id());
fprintf(stderr, "\n");
#endif
}
/* purecov: end */
};
} // namespace cache
} // namespace dd
#endif // DD_CACHE__FREE_LIST_INCLUDED
|
