1
# Copyright (C) 2006, 2008, 2009 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""A simple least-recently-used (LRU) cache."""
19
from __future__ import absolute_import, division
32
class _LRUNode(object):
33
"""This maintains the linked-list which is the lru internals."""
35
__slots__ = ('prev', 'next_key', 'key', 'value')
37
def __init__(self, key, value):
39
self.next_key = _null_key
47
prev_key = self.prev.key
48
return '%s(%r n:%r p:%r)' % (self.__class__.__name__, self.key,
49
self.next_key, prev_key)
52
class LRUCache(object):
53
"""A class which manages a cache of entries, removing unused ones."""
55
def __init__(self, max_cache=100, after_cleanup_count=None):
57
# The "HEAD" of the lru linked list
58
self._most_recently_used = None
59
# The "TAIL" of the lru linked list
60
self._least_recently_used = None
61
self._update_max_cache(max_cache, after_cleanup_count)
63
def __contains__(self, key):
64
return key in self._cache
66
def __getitem__(self, key):
69
# Inlined from _record_access to decrease the overhead of __getitem__
70
# We also have more knowledge about structure if __getitem__ is
71
# succeeding, then we know that self._most_recently_used must not be
73
mru = self._most_recently_used
75
# Nothing to do, this node is already at the head of the queue
77
# Remove this node from the old location
79
next_key = node.next_key
80
# benchmarking shows that the lookup of _null_key in globals is faster
81
# than the attribute lookup for (node is self._least_recently_used)
82
if next_key is _null_key:
83
# 'node' is the _least_recently_used, because it doesn't have a
84
# 'next' item. So move the current lru to the previous node.
85
self._least_recently_used = node_prev
87
node_next = cache[next_key]
88
node_next.prev = node_prev
89
node_prev.next_key = next_key
90
# Insert this node at the front of the list
91
node.next_key = mru.key
93
self._most_recently_used = node
98
return len(self._cache)
100
def __setitem__(self, key, value):
101
"""Add a new value to the cache"""
103
raise ValueError('cannot use _null_key as a key')
104
if key in self._cache:
105
node = self._cache[key]
107
self._record_access(node)
109
node = _LRUNode(key, value)
110
self._cache[key] = node
111
self._record_access(node)
113
if len(self._cache) > self._max_cache:
114
# Trigger the cleanup
117
def cache_size(self):
118
"""Get the number of entries we will cache."""
119
return self._max_cache
121
def get(self, key, default=None):
122
node = self._cache.get(key, None)
125
self._record_access(node)
129
"""Get the list of keys currently cached.
131
Note that values returned here may not be available by the time you
132
request them later. This is simply meant as a peak into the current
135
:return: An unordered list of keys that are currently cached.
137
# GZ 2016-06-04: Maybe just make this return the view?
138
return list(viewkeys(self._cache))
141
"""Get a new dict with the same key:value pairs as the cache"""
142
return dict((k, n.value) for k, n in viewitems(self._cache))
145
"""Clear the cache until it shrinks to the requested size.
147
This does not completely wipe the cache, just makes sure it is under
148
the after_cleanup_count.
150
# Make sure the cache is shrunk to the correct size
151
while len(self._cache) > self._after_cleanup_count:
154
def _record_access(self, node):
155
"""Record that key was accessed."""
156
# Move 'node' to the front of the queue
157
if self._most_recently_used is None:
158
self._most_recently_used = node
159
self._least_recently_used = node
161
elif node is self._most_recently_used:
162
# Nothing to do, this node is already at the head of the queue
164
# We've taken care of the tail pointer, remove the node, and insert it
167
if node is self._least_recently_used:
168
self._least_recently_used = node.prev
169
if node.prev is not None:
170
node.prev.next_key = node.next_key
171
if node.next_key is not _null_key:
172
node_next = self._cache[node.next_key]
173
node_next.prev = node.prev
175
node.next_key = self._most_recently_used.key
176
self._most_recently_used.prev = node
177
self._most_recently_used = node
180
def _remove_node(self, node):
181
if node is self._least_recently_used:
182
self._least_recently_used = node.prev
183
self._cache.pop(node.key)
184
# If we have removed all entries, remove the head pointer as well
185
if self._least_recently_used is None:
186
self._most_recently_used = None
187
if node.prev is not None:
188
node.prev.next_key = node.next_key
189
if node.next_key is not _null_key:
190
node_next = self._cache[node.next_key]
191
node_next.prev = node.prev
192
# And remove this node's pointers
194
node.next_key = _null_key
196
def _remove_lru(self):
197
"""Remove one entry from the lru, and handle consequences.
199
If there are no more references to the lru, then this entry should be
200
removed from the cache.
202
self._remove_node(self._least_recently_used)
205
"""Clear out all of the cache."""
206
# Clean up in LRU order
210
def resize(self, max_cache, after_cleanup_count=None):
211
"""Change the number of entries that will be cached."""
212
self._update_max_cache(max_cache,
213
after_cleanup_count=after_cleanup_count)
215
def _update_max_cache(self, max_cache, after_cleanup_count=None):
216
self._max_cache = max_cache
217
if after_cleanup_count is None:
218
self._after_cleanup_count = self._max_cache * 8 // 10
220
self._after_cleanup_count = min(after_cleanup_count,
225
class LRUSizeCache(LRUCache):
226
"""An LRUCache that removes things based on the size of the values.
228
This differs in that it doesn't care how many actual items there are,
229
it just restricts the cache to be cleaned up after so much data is stored.
231
The size of items added will be computed using compute_size(value), which
232
defaults to len() if not supplied.
235
def __init__(self, max_size=1024*1024, after_cleanup_size=None,
237
"""Create a new LRUSizeCache.
239
:param max_size: The max number of bytes to store before we start
240
clearing out entries.
241
:param after_cleanup_size: After cleaning up, shrink everything to this
243
:param compute_size: A function to compute the size of the values. We
244
use a function here, so that you can pass 'len' if you are just
245
using simple strings, or a more complex function if you are using
246
something like a list of strings, or even a custom object.
247
The function should take the form "compute_size(value) => integer".
248
If not supplied, it defaults to 'len()'
251
self._compute_size = compute_size
252
if compute_size is None:
253
self._compute_size = len
254
self._update_max_size(max_size, after_cleanup_size=after_cleanup_size)
255
LRUCache.__init__(self, max_cache=max(int(max_size // 512), 1))
257
def __setitem__(self, key, value):
258
"""Add a new value to the cache"""
260
raise ValueError('cannot use _null_key as a key')
261
node = self._cache.get(key, None)
262
value_len = self._compute_size(value)
263
if value_len >= self._after_cleanup_size:
264
# The new value is 'too big to fit', as it would fill up/overflow
265
# the cache all by itself
266
trace.mutter('Adding the key %r to an LRUSizeCache failed.'
267
' value %d is too big to fit in a the cache'
268
' with size %d %d', key, value_len,
269
self._after_cleanup_size, self._max_size)
271
# We won't be replacing the old node, so just remove it
272
self._remove_node(node)
275
node = _LRUNode(key, value)
276
self._cache[key] = node
278
self._value_size -= self._compute_size(node.value)
279
self._value_size += value_len
280
self._record_access(node)
282
if self._value_size > self._max_size:
287
"""Clear the cache until it shrinks to the requested size.
289
This does not completely wipe the cache, just makes sure it is under
290
the after_cleanup_size.
292
# Make sure the cache is shrunk to the correct size
293
while self._value_size > self._after_cleanup_size:
296
def _remove_node(self, node):
297
self._value_size -= self._compute_size(node.value)
298
LRUCache._remove_node(self, node)
300
def resize(self, max_size, after_cleanup_size=None):
301
"""Change the number of bytes that will be cached."""
302
self._update_max_size(max_size, after_cleanup_size=after_cleanup_size)
303
max_cache = max(int(max_size // 512), 1)
304
self._update_max_cache(max_cache)
306
def _update_max_size(self, max_size, after_cleanup_size=None):
307
self._max_size = max_size
308
if after_cleanup_size is None:
309
self._after_cleanup_size = self._max_size * 8 // 10
311
self._after_cleanup_size = min(after_cleanup_size, self._max_size)
added
removed
breezy/lru_cache.py
