93
93
:param key_elements: The number of bytestrings in each key.
95
95
self.reference_lists = reference_lists
97
96
# A dict of {key: (absent, ref_lists, value)}
98
# Keys that are referenced but not actually present in this index
99
self._absent_keys = set()
99
100
self._nodes_by_key = None
100
101
self._key_length = key_elements
101
102
self._optimize_for_size = False
166
167
key_dict = self._nodes_by_key
167
168
if self.reference_lists:
168
key_value = key, value, node_refs
169
key_value = StaticTuple(key, value, node_refs)
170
key_value = key, value
171
key_value = StaticTuple(key, value)
171
172
for subkey in key[:-1]:
172
173
key_dict = key_dict.setdefault(subkey, {})
173
174
key_dict[key[-1]] = key_value
203
205
if reference not in self._nodes:
204
206
self._check_key(reference)
205
207
absent_references.append(reference)
207
node_refs.append(tuple(reference_list))
209
return tuple(node_refs), absent_references
208
reference_list = as_st([as_st(ref).intern()
209
for ref in reference_list])
210
node_refs.append(reference_list)
211
return as_st(node_refs), absent_references
211
213
def add_node(self, key, value, references=()):
212
214
"""Add a node to the index.
227
229
# There may be duplicates, but I don't think it is worth worrying
229
231
self._nodes[reference] = ('a', (), '')
232
self._absent_keys.update(absent_references)
233
self._absent_keys.discard(key)
230
234
self._nodes[key] = ('', node_refs, value)
232
235
if self._nodes_by_key is not None and self._key_length > 1:
233
236
self._update_nodes_by_key(key, value, node_refs)
243
246
lines = [_SIGNATURE]
244
247
lines.append(_OPTION_NODE_REFS + str(self.reference_lists) + '\n')
245
248
lines.append(_OPTION_KEY_ELEMENTS + str(self._key_length) + '\n')
246
lines.append(_OPTION_LEN + str(len(self._keys)) + '\n')
249
key_count = len(self._nodes) - len(self._absent_keys)
250
lines.append(_OPTION_LEN + str(key_count) + '\n')
247
251
prefix_length = sum(len(x) for x in lines)
248
252
# references are byte offsets. To avoid having to do nasty
249
253
# polynomial work to resolve offsets (references to later in the
378
382
suitable for production use. :XXX
381
def __init__(self, transport, name, size, unlimited_cache=False):
385
def __init__(self, transport, name, size, unlimited_cache=False, offset=0):
382
386
"""Open an index called name on transport.
384
388
:param transport: A bzrlib.transport.Transport.
440
447
mutter('Reading entire index %s', self._transport.abspath(self._name))
441
448
if stream is None:
442
449
stream = self._transport.get(self._name)
450
if self._base_offset != 0:
451
# This is wasteful, but it is better than dealing with
452
# adjusting all the offsets, etc.
453
stream = StringIO(stream.read()[self._base_offset:])
443
454
self._read_prefix(stream)
444
455
self._expected_elements = 3 + self._key_length
484
495
raise ValueError('No ref list %d, index has %d ref lists'
485
496
% (ref_list_num, self.node_ref_lists))
487
for key, (value, ref_lists) in self._nodes.iteritems():
499
for key, (value, ref_lists) in nodes.iteritems():
488
500
ref_list = ref_lists[ref_list_num]
489
refs.update(ref_list)
490
return refs - self._keys
501
refs.update([ref for ref in ref_list if ref not in nodes])
492
504
def _get_nodes_by_key(self):
493
505
if self._nodes_by_key is None:
621
633
def _iter_entries_from_total_buffer(self, keys):
622
634
"""Iterate over keys when the entire index is parsed."""
623
keys = keys.intersection(self._keys)
635
# Note: See the note in BTreeBuilder.iter_entries for why we don't use
636
# .intersection() here
638
keys = [key for key in keys if key in nodes]
624
639
if self.node_ref_lists:
626
value, node_refs = self._nodes[key]
641
value, node_refs = nodes[key]
627
642
yield self, key, value, node_refs
630
yield self, key, self._nodes[key]
645
yield self, key, nodes[key]
632
647
def iter_entries(self, keys):
633
648
"""Iterate over keys within the index.
1182
1197
self._buffer_all()
1200
base_offset = self._base_offset
1201
if base_offset != 0:
1202
# Rewrite the ranges for the offset
1203
readv_ranges = [(start+base_offset, size)
1204
for start, size in readv_ranges]
1185
1205
readv_data = self._transport.readv(self._name, readv_ranges, True,
1206
self._size + self._base_offset)
1188
1208
for offset, data in readv_data:
1209
offset -= base_offset
1189
1210
self._bytes_read += len(data)
1212
# transport.readv() expanded to extra data which isn't part of
1214
data = data[-offset:]
1190
1216
if offset == 0 and len(data) == self._size:
1191
1217
# We read the whole range, most likely because the
1192
1218
# Transport upcast our readv ranges into one long request
1221
1247
Queries against the combined index will be made against the first index,
1222
and then the second and so on. The order of index's can thus influence
1248
and then the second and so on. The order of indices can thus influence
1223
1249
performance significantly. For example, if one index is on local disk and a
1224
1250
second on a remote server, the local disk index should be before the other
1225
1251
in the index list.
1253
Also, queries tend to need results from the same indices as previous
1254
queries. So the indices will be reordered after every query to put the
1255
indices that had the result(s) of that query first (while otherwise
1256
preserving the relative ordering).
1228
1259
def __init__(self, indices, reload_func=None):
1236
1267
self._indices = indices
1237
1268
self._reload_func = reload_func
1269
# Sibling indices are other CombinedGraphIndex that we should call
1270
# _move_to_front_by_name on when we auto-reorder ourself.
1271
self._sibling_indices = []
1272
# A list of names that corresponds to the instances in self._indices,
1273
# so _index_names[0] is always the name for _indices[0], etc. Sibling
1274
# indices must all use the same set of names as each other.
1275
self._index_names = [None] * len(self._indices)
1239
1277
def __repr__(self):
1240
1278
return "%s(%s)" % (
1264
1302
has_key = _has_key_from_parent_map
1266
def insert_index(self, pos, index):
1304
def insert_index(self, pos, index, name=None):
1267
1305
"""Insert a new index in the list of indices to query.
1269
1307
:param pos: The position to insert the index.
1270
1308
:param index: The index to insert.
1309
:param name: a name for this index, e.g. a pack name. These names can
1310
be used to reflect index reorderings to related CombinedGraphIndex
1311
instances that use the same names. (see set_sibling_indices)
1272
1313
self._indices.insert(pos, index)
1314
self._index_names.insert(pos, name)
1274
1316
def iter_all_entries(self):
1275
1317
"""Iterate over all keys within the index
1300
1342
value and are only reported once.
1302
1344
:param keys: An iterable providing the keys to be retrieved.
1303
:return: An iterable of (index, key, reference_lists, value). There is no
1304
defined order for the result iteration - it will be in the most
1345
:return: An iterable of (index, key, reference_lists, value). There is
1346
no defined order for the result iteration - it will be in the most
1305
1347
efficient order for the index.
1307
1349
keys = set(keys)
1310
1353
for index in self._indices:
1313
1357
for node in index.iter_entries(keys):
1314
1358
keys.remove(node[1])
1362
hit_indices.append(index)
1317
1364
except errors.NoSuchFile:
1318
1365
self._reload_or_raise()
1366
self._move_to_front(hit_indices)
1320
1368
def iter_entries_prefix(self, keys):
1321
1369
"""Iterate over keys within the index using prefix matching.
1343
1391
seen_keys = set()
1346
1395
for index in self._indices:
1347
1397
for node in index.iter_entries_prefix(keys):
1348
1398
if node[1] in seen_keys:
1350
1400
seen_keys.add(node[1])
1404
hit_indices.append(index)
1353
1406
except errors.NoSuchFile:
1354
1407
self._reload_or_raise()
1408
self._move_to_front(hit_indices)
1410
def _move_to_front(self, hit_indices):
1411
"""Rearrange self._indices so that hit_indices are first.
1413
Order is maintained as much as possible, e.g. the first unhit index
1414
will be the first index in _indices after the hit_indices, and the
1415
hit_indices will be present in exactly the order they are passed to
1418
_move_to_front propagates to all objects in self._sibling_indices by
1419
calling _move_to_front_by_name.
1421
if self._indices[:len(hit_indices)] == hit_indices:
1422
# The 'hit_indices' are already at the front (and in the same
1423
# order), no need to re-order
1425
hit_names = self._move_to_front_by_index(hit_indices)
1426
for sibling_idx in self._sibling_indices:
1427
sibling_idx._move_to_front_by_name(hit_names)
1429
def _move_to_front_by_index(self, hit_indices):
1430
"""Core logic for _move_to_front.
1432
Returns a list of names corresponding to the hit_indices param.
1434
indices_info = zip(self._index_names, self._indices)
1435
if 'index' in debug.debug_flags:
1436
mutter('CombinedGraphIndex reordering: currently %r, promoting %r',
1437
indices_info, hit_indices)
1440
new_hit_indices = []
1443
for offset, (name, idx) in enumerate(indices_info):
1444
if idx in hit_indices:
1445
hit_names.append(name)
1446
new_hit_indices.append(idx)
1447
if len(new_hit_indices) == len(hit_indices):
1448
# We've found all of the hit entries, everything else is
1450
unhit_names.extend(self._index_names[offset+1:])
1451
unhit_indices.extend(self._indices[offset+1:])
1454
unhit_names.append(name)
1455
unhit_indices.append(idx)
1457
self._indices = new_hit_indices + unhit_indices
1458
self._index_names = hit_names + unhit_names
1459
if 'index' in debug.debug_flags:
1460
mutter('CombinedGraphIndex reordered: %r', self._indices)
1463
def _move_to_front_by_name(self, hit_names):
1464
"""Moves indices named by 'hit_names' to front of the search order, as
1465
described in _move_to_front.
1467
# Translate names to index instances, and then call
1468
# _move_to_front_by_index.
1469
indices_info = zip(self._index_names, self._indices)
1471
for name, idx in indices_info:
1472
if name in hit_names:
1473
hit_indices.append(idx)
1474
self._move_to_front_by_index(hit_indices)
1356
1476
def find_ancestry(self, keys, ref_list_num):
1357
1477
"""Find the complete ancestry for the given set of keys.
1507
1633
defined order for the result iteration - it will be in the most
1508
1634
efficient order for the index (keys iteration order in this case).
1636
# Note: See BTreeBuilder.iter_entries for an explanation of why we
1637
# aren't using set().intersection() here
1639
keys = [key for key in keys if key in nodes]
1511
1640
if self.reference_lists:
1512
for key in keys.intersection(self._keys):
1513
node = self._nodes[key]
1514
1643
if not node[0]:
1515
1644
yield self, key, node[2], node[1]
1517
for key in keys.intersection(self._keys):
1518
node = self._nodes[key]
1519
1648
if not node[0]:
1520
1649
yield self, key, node[2]
added
removed
bzrlib/index.py
