1
# Copyright (C) 2008, 2009 Canonical Ltd
1
# Copyright (C) 2008, 2009, 2010 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
57
from bzrlib.static_tuple import StaticTuple
57
60
# If each line is 50 bytes, and you have 255 internal pages, with 255-way fan
58
61
# out, it takes 3.1MB to cache the layer.
59
62
_PAGE_CACHE_SIZE = 4*1024*1024
60
# We are caching bytes so len(value) is perfectly accurate
61
_page_cache = lru_cache.LRUSizeCache(_PAGE_CACHE_SIZE)
63
# Per thread caches for 2 reasons:
64
# - in the server we may be serving very different content, so we get less
66
# - we avoid locking on every cache lookup.
67
_thread_caches = threading.local()
69
_thread_caches.page_cache = None
72
"""Get the per-thread page cache.
74
We need a function to do this because in a new thread the _thread_caches
75
threading.local object does not have the cache initialized yet.
77
page_cache = getattr(_thread_caches, 'page_cache', None)
78
if page_cache is None:
79
# We are caching bytes so len(value) is perfectly accurate
80
page_cache = lru_cache.LRUSizeCache(_PAGE_CACHE_SIZE)
81
_thread_caches.page_cache = page_cache
66
89
# If a ChildNode falls below this many bytes, we check for a remap
67
90
_INTERESTING_NEW_SIZE = 50
83
106
class CHKMap(object):
84
107
"""A persistent map from string to string backed by a CHK store."""
109
__slots__ = ('_store', '_root_node', '_search_key_func')
86
111
def __init__(self, store, root_key, search_key_func=None):
87
112
"""Create a CHKMap object.
114
139
# Check preconditions first.
115
new_items = set([key for (old, key, value) in delta if key is not None
140
as_st = StaticTuple.from_sequence
141
new_items = set([as_st(key) for (old, key, value) in delta
142
if key is not None and old is None])
117
143
existing_new = list(self.iteritems(key_filter=new_items))
119
145
raise errors.InconsistentDeltaDelta(delta,
147
173
:param node: A tuple key or node object.
148
174
:return: A node object.
150
if type(node) is tuple:
176
if type(node) is StaticTuple:
151
177
bytes = self._read_bytes(node)
152
178
return _deserialise(bytes, node,
153
179
search_key_func=self._search_key_func)
157
183
def _read_bytes(self, key):
159
return _page_cache[key]
185
return _get_cache()[key]
161
187
stream = self._store.get_record_stream([key], 'unordered', True)
162
188
bytes = stream.next().get_bytes_as('fulltext')
163
_page_cache[key] = bytes
189
_get_cache()[key] = bytes
166
192
def _dump_tree(self, include_keys=False):
194
220
for key, value in sorted(node._items.iteritems()):
195
221
# Don't use prefix nor indent here to line up when used in
196
222
# tests in conjunction with assertEqualDiff
197
result.append(' %r %r' % (key, value))
223
result.append(' %r %r' % (tuple(key), value))
218
244
root_key = klass._create_directly(store, initial_value,
219
245
maximum_size=maximum_size, key_width=key_width,
220
246
search_key_func=search_key_func)
247
if type(root_key) is not StaticTuple:
248
raise AssertionError('we got a %s instead of a StaticTuple'
238
267
node = LeafNode(search_key_func=search_key_func)
239
268
node.set_maximum_size(maximum_size)
240
269
node._key_width = key_width
241
node._items = dict(initial_value)
270
as_st = StaticTuple.from_sequence
271
node._items = dict([(as_st(key), val) for key, val
272
in initial_value.iteritems()])
242
273
node._raw_size = sum([node._key_value_len(key, value)
243
for key,value in initial_value.iteritems()])
274
for key,value in node._items.iteritems()])
244
275
node._len = len(node._items)
245
276
node._compute_search_prefix()
246
277
node._compute_serialised_prefix()
482
513
def iteritems(self, key_filter=None):
483
514
"""Iterate over the entire CHKMap's contents."""
484
515
self._ensure_root()
516
if key_filter is not None:
517
as_st = StaticTuple.from_sequence
518
key_filter = [as_st(key) for key in key_filter]
485
519
return self._root_node.iteritems(self._store, key_filter=key_filter)
488
522
"""Return the key for this map."""
489
if type(self._root_node) is tuple:
523
if type(self._root_node) is StaticTuple:
490
524
return self._root_node
492
526
return self._root_node._key
501
535
:param key: A key to map.
502
536
:param value: The value to assign to key.
538
key = StaticTuple.from_sequence(key)
504
539
# Need a root object.
505
540
self._ensure_root()
506
541
prefix, node_details = self._root_node.map(self._store, key, value)
517
552
def _node_key(self, node):
518
553
"""Get the key for a node whether it's a tuple or node."""
519
554
if type(node) is tuple:
555
node = StaticTuple.from_sequence(node)
556
if type(node) is StaticTuple:
524
561
def unmap(self, key, check_remap=True):
525
562
"""remove key from the map."""
563
key = StaticTuple.from_sequence(key)
526
564
self._ensure_root()
527
565
if type(self._root_node) is InternalNode:
528
566
unmapped = self._root_node.unmap(self._store, key,
556
594
adding the header bytes, and without prefix compression.
597
__slots__ = ('_key', '_len', '_maximum_size', '_key_width',
598
'_raw_size', '_items', '_search_prefix', '_search_key_func'
559
601
def __init__(self, key_width=1):
560
602
"""Create a node.
650
692
the key/value pairs.
695
__slots__ = ('_common_serialised_prefix',)
653
697
def __init__(self, search_key_func=None):
654
698
Node.__init__(self)
655
699
# All of the keys in this leaf node share this common prefix
656
700
self._common_serialised_prefix = None
657
self._serialise_key = '\x00'.join
658
701
if search_key_func is None:
659
702
self._search_key_func = _search_key_plain
698
741
:param bytes: The bytes of the node.
699
742
:param key: The key that the serialised node has.
744
key = static_tuple.expect_static_tuple(key)
701
745
return _deserialise_leaf_node(bytes, key,
702
746
search_key_func=search_key_func)
843
887
raise AssertionError('%r must be known' % self._search_prefix)
844
888
return self._search_prefix, [("", self)]
890
_serialise_key = '\x00'.join
846
892
def serialise(self, store):
847
893
"""Serialise the LeafNode to store.
873
919
lines.append(serialized[prefix_len:])
874
920
lines.extend(value_lines)
875
921
sha1, _, _ = store.add_lines((None,), (), lines)
876
self._key = ("sha1:" + sha1,)
922
self._key = StaticTuple("sha1:" + sha1,).intern()
877
923
bytes = ''.join(lines)
878
924
if len(bytes) != self._current_size():
879
925
raise AssertionError('Invalid _current_size')
880
_page_cache.add(self._key, bytes)
926
_get_cache().add(self._key, bytes)
881
927
return [self._key]
947
993
LeafNode or InternalNode.
996
__slots__ = ('_node_width',)
950
998
def __init__(self, prefix='', search_key_func=None):
951
999
Node.__init__(self)
952
1000
# The size of an internalnode with default values and no children.
994
1042
:param key: The key that the serialised node has.
995
1043
:return: An InternalNode instance.
1045
key = static_tuple.expect_static_tuple(key)
997
1046
return _deserialise_internal_node(bytes, key,
998
1047
search_key_func=search_key_func)
1024
1073
# for whatever we are missing
1025
1074
shortcut = True
1026
1075
for prefix, node in self._items.iteritems():
1027
if node.__class__ is tuple:
1076
if node.__class__ is StaticTuple:
1028
1077
keys[node] = (prefix, None)
1030
1079
yield node, None
1059
1108
# A given key can only match 1 child node, if it isn't
1060
1109
# there, then we can just return nothing
1062
if node.__class__ is tuple:
1111
if node.__class__ is StaticTuple:
1063
1112
keys[node] = (search_prefix, [key])
1065
1114
# This is loaded, and the only thing that can match,
1092
1141
# We can ignore this one
1094
1143
node_key_filter = prefix_to_keys[search_prefix]
1095
if node.__class__ is tuple:
1144
if node.__class__ is StaticTuple:
1096
1145
keys[node] = (search_prefix, node_key_filter)
1098
1147
yield node, node_key_filter
1107
1156
if sub_prefix in length_filter:
1108
1157
node_key_filter.extend(prefix_to_keys[sub_prefix])
1109
1158
if node_key_filter: # this key matched something, yield it
1110
if node.__class__ is tuple:
1159
if node.__class__ is StaticTuple:
1111
1160
keys[node] = (prefix, node_key_filter)
1113
1162
yield node, node_key_filter
1147
1196
prefix, node_key_filter = keys[record.key]
1148
1197
node_and_filters.append((node, node_key_filter))
1149
1198
self._items[prefix] = node
1150
_page_cache.add(record.key, bytes)
1199
_get_cache().add(record.key, bytes)
1151
1200
for info in node_and_filters:
1262
1311
lines.append('%s\n' % (self._search_prefix,))
1263
1312
prefix_len = len(self._search_prefix)
1264
1313
for prefix, node in sorted(self._items.items()):
1265
if type(node) is tuple:
1314
if type(node) is StaticTuple:
1268
1317
key = node._key[0]
1272
1321
% (serialised, self._search_prefix))
1273
1322
lines.append(serialised[prefix_len:])
1274
1323
sha1, _, _ = store.add_lines((None,), (), lines)
1275
self._key = ("sha1:" + sha1,)
1276
_page_cache.add(self._key, ''.join(lines))
1324
self._key = StaticTuple("sha1:" + sha1,).intern()
1325
_get_cache().add(self._key, ''.join(lines))
1277
1326
yield self._key
1279
1328
def _search_key(self, key):
1428
1477
def __init__(self, store, new_root_keys, old_root_keys,
1429
1478
search_key_func, pb=None):
1479
# TODO: Should we add a StaticTuple barrier here? It would be nice to
1480
# force callers to use StaticTuple, because there will often be
1481
# lots of keys passed in here. And even if we cast it locally,
1482
# that just meanst that we will have *both* a StaticTuple and a
1483
# tuple() in memory, referring to the same object. (so a net
1484
# increase in memory, not a decrease.)
1430
1485
self._store = store
1431
1486
self._new_root_keys = new_root_keys
1432
1487
self._old_root_keys = old_root_keys
1434
1489
# All uninteresting chks that we have seen. By the time they are added
1435
1490
# here, they should be either fully ignored, or queued up for
1492
# TODO: This might grow to a large size if there are lots of merge
1493
# parents, etc. However, it probably doesn't scale to O(history)
1494
# like _processed_new_refs does.
1437
1495
self._all_old_chks = set(self._old_root_keys)
1438
1496
# All items that we have seen from the old_root_keys
1439
1497
self._all_old_items = set()
1440
1498
# These are interesting items which were either read, or already in the
1441
1499
# interesting queue (so we don't need to walk them again)
1500
# TODO: processed_new_refs becomes O(all_chks), consider switching to
1442
1502
self._processed_new_refs = set()
1443
1503
self._search_key_func = search_key_func
1451
1511
self._state = None
1453
1513
def _read_nodes_from_store(self, keys):
1454
# We chose not to use _page_cache, because we think in terms of records
1455
# to be yielded. Also, we expect to touch each page only 1 time during
1456
# this code. (We may want to evaluate saving the raw bytes into the
1457
# page cache, which would allow a working tree update after the fetch
1458
# to not have to read the bytes again.)
1514
# We chose not to use _get_cache(), because we think in
1515
# terms of records to be yielded. Also, we expect to touch each page
1516
# only 1 time during this code. (We may want to evaluate saving the
1517
# raw bytes into the page cache, which would allow a working tree
1518
# update after the fetch to not have to read the bytes again.)
1519
as_st = StaticTuple.from_sequence
1459
1520
stream = self._store.get_record_stream(keys, 'unordered', True)
1460
1521
for record in stream:
1461
1522
if self._pb is not None:
1468
1529
if type(node) is InternalNode:
1469
1530
# Note we don't have to do node.refs() because we know that
1470
1531
# there are no children that have been pushed into this node
1532
# Note: Using as_st() here seemed to save 1.2MB, which would
1533
# indicate that we keep 100k prefix_refs around while
1534
# processing. They *should* be shorter lived than that...
1535
# It does cost us ~10s of processing time
1536
#prefix_refs = [as_st(item) for item in node._items.iteritems()]
1471
1537
prefix_refs = node._items.items()
1474
1540
prefix_refs = []
1541
# Note: We don't use a StaticTuple here. Profiling showed a
1542
# minor memory improvement (0.8MB out of 335MB peak 0.2%)
1543
# But a significant slowdown (15s / 145s, or 10%)
1475
1544
items = node._items.items()
1476
1545
yield record, node, prefix_refs, items
1485
1554
if p_r[1] not in all_old_chks]
1486
1555
new_refs = [p_r[1] for p_r in prefix_refs]
1487
1556
all_old_chks.update(new_refs)
1557
# TODO: This might be a good time to turn items into StaticTuple
1558
# instances and possibly intern them. However, this does not
1559
# impact 'initial branch' performance, so I'm not worrying
1488
1561
self._all_old_items.update(items)
1489
1562
# Queue up the uninteresting references
1490
1563
# Don't actually put them in the 'to-read' queue until we have
1543
1616
# current design allows for this, as callers will do the work
1544
1617
# to make the results unique. We might profile whether we
1545
1618
# gain anything by ensuring unique return values for items
1619
# TODO: This might be a good time to cast to StaticTuple, as
1620
# self._new_item_queue will hold the contents of multiple
1621
# records for an extended lifetime
1546
1622
new_items = [item for item in items
1547
1623
if item not in self._all_old_items]
1548
1624
self._new_item_queue.extend(new_items)
1574
1650
yield None, new_items
1575
1651
refs = refs.difference(all_old_chks)
1652
processed_new_refs.update(refs)
1654
# TODO: Using a SimpleSet for self._processed_new_refs and
1655
# saved as much as 10MB of peak memory. However, it requires
1656
# implementing a non-pyrex version.
1577
1657
next_refs = set()
1578
1658
next_refs_update = next_refs.update
1579
1659
# Inlining _read_nodes_from_store improves 'bzr branch bzr.dev'
1580
1660
# from 1m54s to 1m51s. Consider it.
1581
1661
for record, _, p_refs, items in self._read_nodes_from_store(refs):
1582
items = [item for item in items
1583
if item not in all_old_items]
1663
# using the 'if' check saves about 145s => 141s, when
1664
# streaming initial branch of Launchpad data.
1665
items = [item for item in items
1666
if item not in all_old_items]
1584
1667
yield record, items
1585
1668
next_refs_update([p_r[1] for p_r in p_refs])
1670
# set1.difference(set/dict) walks all of set1, and checks if it
1671
# exists in 'other'.
1672
# set1.difference(iterable) walks all of iterable, and does a
1673
# 'difference_update' on a clone of set1. Pick wisely based on the
1674
# expected sizes of objects.
1675
# in our case it is expected that 'new_refs' will always be quite
1586
1677
next_refs = next_refs.difference(all_old_chks)
1587
1678
next_refs = next_refs.difference(processed_new_refs)
1588
1679
processed_new_refs.update(next_refs)
1595
1686
self._old_queue = []
1596
1687
all_old_chks = self._all_old_chks
1597
1688
for record, _, prefix_refs, items in self._read_nodes_from_store(refs):
1689
# TODO: Use StaticTuple here?
1598
1690
self._all_old_items.update(items)
1599
1691
refs = [r for _,r in prefix_refs if r not in all_old_chks]
1600
1692
self._old_queue.extend(refs)
1651
1745
search_key_registry.register('hash-16-way', _search_key_16)
1652
1746
search_key_registry.register('hash-255-way', _search_key_255)
1749
def _check_key(key):
1750
"""Helper function to assert that a key is properly formatted.
1752
This generally shouldn't be used in production code, but it can be helpful
1755
if type(key) is not StaticTuple:
1756
raise TypeError('key %r is not StaticTuple but %s' % (key, type(key)))
1758
raise ValueError('key %r should have length 1, not %d' % (key, len(key),))
1759
if type(key[0]) is not str:
1760
raise TypeError('key %r should hold a str, not %r'
1761
% (key, type(key[0])))
1762
if not key[0].startswith('sha1:'):
1763
raise ValueError('key %r should point to a sha1:' % (key,))
added
removed
bzrlib/chk_map.py
