/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/lru_cache.py

  • Committer: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/lru_cache.py
16
16
 
17
17
"""A simple least-recently-used (LRU) cache."""
18
18
 
19
 
from __future__ import absolute_import, division
20
 
 
21
 
from . import (
 
19
from bzrlib import (
 
20
    symbol_versioning,
22
21
    trace,
23
22
    )
24
 
from .sixish import (
25
 
    viewitems,
26
 
    viewkeys,
27
 
    )
28
 
 
29
23
 
30
24
_null_key = object()
31
25
 
32
26
class _LRUNode(object):
33
27
    """This maintains the linked-list which is the lru internals."""
34
28
 
35
 
    __slots__ = ('prev', 'next_key', 'key', 'value')
 
29
    __slots__ = ('prev', 'next_key', 'key', 'value', 'cleanup', 'size')
36
30
 
37
 
    def __init__(self, key, value):
 
31
    def __init__(self, key, value, cleanup=None):
38
32
        self.prev = None
39
33
        self.next_key = _null_key
40
34
        self.key = key
41
35
        self.value = value
 
36
        self.cleanup = cleanup
 
37
        # TODO: We could compute this 'on-the-fly' like we used to, and remove
 
38
        #       one pointer from this object, we just need to decide if it
 
39
        #       actually costs us much of anything in normal usage
 
40
        self.size = None
42
41
 
43
42
    def __repr__(self):
44
43
        if self.prev is None:
48
47
        return '%s(%r n:%r p:%r)' % (self.__class__.__name__, self.key,
49
48
                                     self.next_key, prev_key)
50
49
 
 
50
    def run_cleanup(self):
 
51
        try:
 
52
            if self.cleanup is not None:
 
53
                self.cleanup(self.key, self.value)
 
54
        finally:
 
55
            # cleanup might raise an exception, but we want to make sure
 
56
            # to break refcycles, etc
 
57
            self.cleanup = None
 
58
            self.value = None
 
59
 
51
60
 
52
61
class LRUCache(object):
53
62
    """A class which manages a cache of entries, removing unused ones."""
54
63
 
55
 
    def __init__(self, max_cache=100, after_cleanup_count=None):
 
64
    def __init__(self, max_cache=100, after_cleanup_count=None,
 
65
                 after_cleanup_size=symbol_versioning.DEPRECATED_PARAMETER):
 
66
        if symbol_versioning.deprecated_passed(after_cleanup_size):
 
67
            symbol_versioning.warn('LRUCache.__init__(after_cleanup_size) was'
 
68
                                   ' deprecated in 1.11. Use'
 
69
                                   ' after_cleanup_count instead.',
 
70
                                   DeprecationWarning)
 
71
            after_cleanup_count = after_cleanup_size
56
72
        self._cache = {}
57
73
        # The "HEAD" of the lru linked list
58
74
        self._most_recently_used = None
97
113
    def __len__(self):
98
114
        return len(self._cache)
99
115
 
100
 
    def __setitem__(self, key, value):
101
 
        """Add a new value to the cache"""
 
116
    def _walk_lru(self):
 
117
        """Walk the LRU list, only meant to be used in tests."""
 
118
        node = self._most_recently_used
 
119
        if node is not None:
 
120
            if node.prev is not None:
 
121
                raise AssertionError('the _most_recently_used entry is not'
 
122
                                     ' supposed to have a previous entry'
 
123
                                     ' %s' % (node,))
 
124
        while node is not None:
 
125
            if node.next_key is _null_key:
 
126
                if node is not self._least_recently_used:
 
127
                    raise AssertionError('only the last node should have'
 
128
                                         ' no next value: %s' % (node,))
 
129
                node_next = None
 
130
            else:
 
131
                node_next = self._cache[node.next_key]
 
132
                if node_next.prev is not node:
 
133
                    raise AssertionError('inconsistency found, node.next.prev'
 
134
                                         ' != node: %s' % (node,))
 
135
            if node.prev is None:
 
136
                if node is not self._most_recently_used:
 
137
                    raise AssertionError('only the _most_recently_used should'
 
138
                                         ' not have a previous node: %s'
 
139
                                         % (node,))
 
140
            else:
 
141
                if node.prev.next_key != node.key:
 
142
                    raise AssertionError('inconsistency found, node.prev.next'
 
143
                                         ' != node: %s' % (node,))
 
144
            yield node
 
145
            node = node_next
 
146
 
 
147
    def add(self, key, value, cleanup=None):
 
148
        """Add a new value to the cache.
 
149
 
 
150
        Also, if the entry is ever removed from the cache, call
 
151
        cleanup(key, value).
 
152
 
 
153
        :param key: The key to store it under
 
154
        :param value: The object to store
 
155
        :param cleanup: None or a function taking (key, value) to indicate
 
156
                        'value' should be cleaned up.
 
157
        """
102
158
        if key is _null_key:
103
159
            raise ValueError('cannot use _null_key as a key')
104
160
        if key in self._cache:
105
161
            node = self._cache[key]
106
 
            node.value = value
107
 
            self._record_access(node)
 
162
            try:
 
163
                node.run_cleanup()
 
164
            finally:
 
165
                # Maintain the LRU properties, even if cleanup raises an
 
166
                # exception
 
167
                node.value = value
 
168
                node.cleanup = cleanup
 
169
                self._record_access(node)
108
170
        else:
109
 
            node = _LRUNode(key, value)
 
171
            node = _LRUNode(key, value, cleanup=cleanup)
110
172
            self._cache[key] = node
111
173
            self._record_access(node)
112
174
 
134
196
 
135
197
        :return: An unordered list of keys that are currently cached.
136
198
        """
137
 
        # GZ 2016-06-04: Maybe just make this return the view?
138
 
        return list(viewkeys(self._cache))
 
199
        return self._cache.keys()
139
200
 
140
 
    def as_dict(self):
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))
 
201
    def items(self):
 
202
        """Get the key:value pairs as a dict."""
 
203
        return dict((k, n.value) for k, n in self._cache.iteritems())
143
204
 
144
205
    def cleanup(self):
145
206
        """Clear the cache until it shrinks to the requested size.
151
212
        while len(self._cache) > self._after_cleanup_count:
152
213
            self._remove_lru()
153
214
 
 
215
    def __setitem__(self, key, value):
 
216
        """Add a value to the cache, there will be no cleanup function."""
 
217
        self.add(key, value, cleanup=None)
 
218
 
154
219
    def _record_access(self, node):
155
220
        """Record that key was accessed."""
156
221
        # Move 'node' to the front of the queue
184
249
        # If we have removed all entries, remove the head pointer as well
185
250
        if self._least_recently_used is None:
186
251
            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
193
 
        node.prev = None
194
 
        node.next_key = _null_key
 
252
        try:
 
253
            node.run_cleanup()
 
254
        finally:
 
255
            # cleanup might raise an exception, but we want to make sure to
 
256
            # maintain the linked list
 
257
            if node.prev is not None:
 
258
                node.prev.next_key = node.next_key
 
259
            if node.next_key is not _null_key:
 
260
                node_next = self._cache[node.next_key]
 
261
                node_next.prev = node.prev
 
262
            # And remove this node's pointers
 
263
            node.prev = None
 
264
            node.next_key = _null_key
195
265
 
196
266
    def _remove_lru(self):
197
267
        """Remove one entry from the lru, and handle consequences.
215
285
    def _update_max_cache(self, max_cache, after_cleanup_count=None):
216
286
        self._max_cache = max_cache
217
287
        if after_cleanup_count is None:
218
 
            self._after_cleanup_count = self._max_cache * 8 // 10
 
288
            self._after_cleanup_count = self._max_cache * 8 / 10
219
289
        else:
220
290
            self._after_cleanup_count = min(after_cleanup_count,
221
291
                                            self._max_cache)
252
322
        if compute_size is None:
253
323
            self._compute_size = len
254
324
        self._update_max_size(max_size, after_cleanup_size=after_cleanup_size)
255
 
        LRUCache.__init__(self, max_cache=max(int(max_size // 512), 1))
256
 
 
257
 
    def __setitem__(self, key, value):
258
 
        """Add a new value to the cache"""
 
325
        LRUCache.__init__(self, max_cache=max(int(max_size/512), 1))
 
326
 
 
327
    def add(self, key, value, cleanup=None):
 
328
        """Add a new value to the cache.
 
329
 
 
330
        Also, if the entry is ever removed from the cache, call
 
331
        cleanup(key, value).
 
332
 
 
333
        :param key: The key to store it under
 
334
        :param value: The object to store
 
335
        :param cleanup: None or a function taking (key, value) to indicate
 
336
                        'value' should be cleaned up.
 
337
        """
259
338
        if key is _null_key:
260
339
            raise ValueError('cannot use _null_key as a key')
261
340
        node = self._cache.get(key, None)
270
349
            if node is not None:
271
350
                # We won't be replacing the old node, so just remove it
272
351
                self._remove_node(node)
 
352
            if cleanup is not None:
 
353
                cleanup(key, value)
273
354
            return
274
355
        if node is None:
275
 
            node = _LRUNode(key, value)
 
356
            node = _LRUNode(key, value, cleanup=cleanup)
276
357
            self._cache[key] = node
277
358
        else:
278
 
            self._value_size -= self._compute_size(node.value)
 
359
            self._value_size -= node.size
 
360
        node.size = value_len
279
361
        self._value_size += value_len
280
362
        self._record_access(node)
281
363
 
294
376
            self._remove_lru()
295
377
 
296
378
    def _remove_node(self, node):
297
 
        self._value_size -= self._compute_size(node.value)
 
379
        self._value_size -= node.size
298
380
        LRUCache._remove_node(self, node)
299
381
 
300
382
    def resize(self, max_size, after_cleanup_size=None):
301
383
        """Change the number of bytes that will be cached."""
302
384
        self._update_max_size(max_size, after_cleanup_size=after_cleanup_size)
303
 
        max_cache = max(int(max_size // 512), 1)
 
385
        max_cache = max(int(max_size/512), 1)
304
386
        self._update_max_cache(max_cache)
305
387
 
306
388
    def _update_max_size(self, max_size, after_cleanup_size=None):
307
389
        self._max_size = max_size
308
390
        if after_cleanup_size is None:
309
 
            self._after_cleanup_size = self._max_size * 8 // 10
 
391
            self._after_cleanup_size = self._max_size * 8 / 10
310
392
        else:
311
393
            self._after_cleanup_size = min(after_cleanup_size, self._max_size)