← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/index.py

  • Committer: Jelmer Vernooij
  • Date: 2011-12-05 14:12:23 UTC
  • mto: This revision was merged to the branch mainline in revision 6348.
  • Revision ID: jelmer@samba.org-20111205141223-8qxae4h37satlzgq
Move more functionality to vf_search.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/index.py
1
 
# Copyright (C) 2007, 2008, 2009 Canonical Ltd
 
1
# Copyright (C) 2007-2011 Canonical Ltd
2
2
#
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
31
31
 
32
32
from bzrlib.lazy_import import lazy_import
33
33
lazy_import(globals(), """
34
 
from bzrlib import trace
35
 
from bzrlib.bisect_multi import bisect_multi_bytes
36
 
from bzrlib.revision import NULL_REVISION
37
 
from bzrlib.trace import mutter
 
34
from bzrlib import (
 
35
    bisect_multi,
 
36
    revision as _mod_revision,
 
37
    trace,
 
38
    )
38
39
""")
39
40
from bzrlib import (
40
41
    debug,
69
70
class GraphIndexBuilder(object):
70
71
    """A builder that can build a GraphIndex.
71
72
 
72
 
    The resulting graph has the structure:
 
73
    The resulting graph has the structure::
73
74
 
74
 
    _SIGNATURE OPTIONS NODES NEWLINE
75
 
    _SIGNATURE     := 'Bazaar Graph Index 1' NEWLINE
76
 
    OPTIONS        := 'node_ref_lists=' DIGITS NEWLINE
77
 
    NODES          := NODE*
78
 
    NODE           := KEY NULL ABSENT? NULL REFERENCES NULL VALUE NEWLINE
79
 
    KEY            := Not-whitespace-utf8
80
 
    ABSENT         := 'a'
81
 
    REFERENCES     := REFERENCE_LIST (TAB REFERENCE_LIST){node_ref_lists - 1}
82
 
    REFERENCE_LIST := (REFERENCE (CR REFERENCE)*)?
83
 
    REFERENCE      := DIGITS  ; digits is the byte offset in the index of the
84
 
                              ; referenced key.
85
 
    VALUE          := no-newline-no-null-bytes
 
75
      _SIGNATURE OPTIONS NODES NEWLINE
 
76
      _SIGNATURE     := 'Bazaar Graph Index 1' NEWLINE
 
77
      OPTIONS        := 'node_ref_lists=' DIGITS NEWLINE
 
78
      NODES          := NODE*
 
79
      NODE           := KEY NULL ABSENT? NULL REFERENCES NULL VALUE NEWLINE
 
80
      KEY            := Not-whitespace-utf8
 
81
      ABSENT         := 'a'
 
82
      REFERENCES     := REFERENCE_LIST (TAB REFERENCE_LIST){node_ref_lists - 1}
 
83
      REFERENCE_LIST := (REFERENCE (CR REFERENCE)*)?
 
84
      REFERENCE      := DIGITS  ; digits is the byte offset in the index of the
 
85
                                ; referenced key.
 
86
      VALUE          := no-newline-no-null-bytes
86
87
    """
87
88
 
88
89
    def __init__(self, reference_lists=0, key_elements=1):
184
185
        :param value: The value associate with this key. Must not contain
185
186
            newlines or null characters.
186
187
        :return: (node_refs, absent_references)
187
 
            node_refs   basically a packed form of 'references' where all
188
 
                        iterables are tuples
189
 
            absent_references   reference keys that are not in self._nodes.
190
 
                                This may contain duplicates if the same key is
191
 
                                referenced in multiple lists.
 
188
        
 
189
            * node_refs: basically a packed form of 'references' where all
 
190
              iterables are tuples
 
191
            * absent_references: reference keys that are not in self._nodes.
 
192
              This may contain duplicates if the same key is referenced in
 
193
              multiple lists.
192
194
        """
193
195
        as_st = StaticTuple.from_sequence
194
196
        self._check_key(key)
219
221
        :param references: An iterable of iterables of keys. Each is a
220
222
            reference to another key.
221
223
        :param value: The value to associate with the key. It may be any
222
 
            bytes as long as it does not contain \0 or \n.
 
224
            bytes as long as it does not contain \\0 or \\n.
223
225
        """
224
226
        (node_refs,
225
227
         absent_references) = self._check_key_ref_value(key, references, value)
243
245
        """
244
246
        
245
247
    def finish(self):
 
248
        """Finish the index.
 
249
 
 
250
        :returns: cStringIO holding the full context of the index as it 
 
251
        should be written to disk.
 
252
        """
246
253
        lines = [_SIGNATURE]
247
254
        lines.append(_OPTION_NODE_REFS + str(self.reference_lists) + '\n')
248
255
        lines.append(_OPTION_KEY_ELEMENTS + str(self._key_length) + '\n')
382
389
    suitable for production use. :XXX
383
390
    """
384
391
 
385
 
    def __init__(self, transport, name, size, unlimited_cache=False):
 
392
    def __init__(self, transport, name, size, unlimited_cache=False, offset=0):
386
393
        """Open an index called name on transport.
387
394
 
388
395
        :param transport: A bzrlib.transport.Transport.
394
401
            avoided by having it supplied. If size is None, then bisection
395
402
            support will be disabled and accessing the index will just stream
396
403
            all the data.
 
404
        :param offset: Instead of starting the index data at offset 0, start it
 
405
            at an arbitrary offset.
397
406
        """
398
407
        self._transport = transport
399
408
        self._name = name
416
425
        self._size = size
417
426
        # The number of bytes we've read so far in trying to process this file
418
427
        self._bytes_read = 0
 
428
        self._base_offset = offset
419
429
 
420
430
    def __eq__(self, other):
421
431
        """Equal when self and other were created with the same parameters."""
441
451
            # We already did this
442
452
            return
443
453
        if 'index' in debug.debug_flags:
444
 
            mutter('Reading entire index %s', self._transport.abspath(self._name))
 
454
            trace.mutter('Reading entire index %s',
 
455
                          self._transport.abspath(self._name))
445
456
        if stream is None:
446
457
            stream = self._transport.get(self._name)
 
458
            if self._base_offset != 0:
 
459
                # This is wasteful, but it is better than dealing with
 
460
                # adjusting all the offsets, etc.
 
461
                stream = StringIO(stream.read()[self._base_offset:])
447
462
        self._read_prefix(stream)
448
463
        self._expected_elements = 3 + self._key_length
449
464
        line_count = 0
455
470
        trailers = 0
456
471
        pos = stream.tell()
457
472
        lines = stream.read().split('\n')
 
473
        # GZ 2009-09-20: Should really use a try/finally block to ensure close
458
474
        stream.close()
459
475
        del lines[-1]
460
476
        _, _, _, trailers = self._parse_lines(lines, pos)
663
679
        if self._nodes is not None:
664
680
            return self._iter_entries_from_total_buffer(keys)
665
681
        else:
666
 
            return (result[1] for result in bisect_multi_bytes(
 
682
            return (result[1] for result in bisect_multi.bisect_multi_bytes(
667
683
                self._lookup_keys_via_location, self._size, keys))
668
684
 
669
685
    def iter_entries_prefix(self, keys):
1190
1206
            self._buffer_all()
1191
1207
            return
1192
1208
 
 
1209
        base_offset = self._base_offset
 
1210
        if base_offset != 0:
 
1211
            # Rewrite the ranges for the offset
 
1212
            readv_ranges = [(start+base_offset, size)
 
1213
                            for start, size in readv_ranges]
1193
1214
        readv_data = self._transport.readv(self._name, readv_ranges, True,
1194
 
            self._size)
 
1215
            self._size + self._base_offset)
1195
1216
        # parse
1196
1217
        for offset, data in readv_data:
 
1218
            offset -= base_offset
1197
1219
            self._bytes_read += len(data)
 
1220
            if offset < 0:
 
1221
                # transport.readv() expanded to extra data which isn't part of
 
1222
                # this index
 
1223
                data = data[-offset:]
 
1224
                offset = 0
1198
1225
            if offset == 0 and len(data) == self._size:
1199
1226
                # We read the whole range, most likely because the
1200
1227
                # Transport upcast our readv ranges into one long request
1227
1254
    static data.
1228
1255
 
1229
1256
    Queries against the combined index will be made against the first index,
1230
 
    and then the second and so on. The order of index's can thus influence
 
1257
    and then the second and so on. The order of indices can thus influence
1231
1258
    performance significantly. For example, if one index is on local disk and a
1232
1259
    second on a remote server, the local disk index should be before the other
1233
1260
    in the index list.
 
1261
    
 
1262
    Also, queries tend to need results from the same indices as previous
 
1263
    queries.  So the indices will be reordered after every query to put the
 
1264
    indices that had the result(s) of that query first (while otherwise
 
1265
    preserving the relative ordering).
1234
1266
    """
1235
1267
 
1236
1268
    def __init__(self, indices, reload_func=None):
1243
1275
        """
1244
1276
        self._indices = indices
1245
1277
        self._reload_func = reload_func
 
1278
        # Sibling indices are other CombinedGraphIndex that we should call
 
1279
        # _move_to_front_by_name on when we auto-reorder ourself.
 
1280
        self._sibling_indices = []
 
1281
        # A list of names that corresponds to the instances in self._indices,
 
1282
        # so _index_names[0] is always the name for _indices[0], etc.  Sibling
 
1283
        # indices must all use the same set of names as each other.
 
1284
        self._index_names = [None] * len(self._indices)
1246
1285
 
1247
1286
    def __repr__(self):
1248
1287
        return "%s(%s)" % (
1257
1296
    def get_parent_map(self, keys):
1258
1297
        """See graph.StackedParentsProvider.get_parent_map"""
1259
1298
        search_keys = set(keys)
1260
 
        if NULL_REVISION in search_keys:
1261
 
            search_keys.discard(NULL_REVISION)
1262
 
            found_parents = {NULL_REVISION:[]}
 
1299
        if _mod_revision.NULL_REVISION in search_keys:
 
1300
            search_keys.discard(_mod_revision.NULL_REVISION)
 
1301
            found_parents = {_mod_revision.NULL_REVISION:[]}
1263
1302
        else:
1264
1303
            found_parents = {}
1265
1304
        for index, key, value, refs in self.iter_entries(search_keys):
1266
1305
            parents = refs[0]
1267
1306
            if not parents:
1268
 
                parents = (NULL_REVISION,)
 
1307
                parents = (_mod_revision.NULL_REVISION,)
1269
1308
            found_parents[key] = parents
1270
1309
        return found_parents
1271
1310
 
1272
1311
    has_key = _has_key_from_parent_map
1273
1312
 
1274
 
    def insert_index(self, pos, index):
 
1313
    def insert_index(self, pos, index, name=None):
1275
1314
        """Insert a new index in the list of indices to query.
1276
1315
 
1277
1316
        :param pos: The position to insert the index.
1278
1317
        :param index: The index to insert.
 
1318
        :param name: a name for this index, e.g. a pack name.  These names can
 
1319
            be used to reflect index reorderings to related CombinedGraphIndex
 
1320
            instances that use the same names.  (see set_sibling_indices)
1279
1321
        """
1280
1322
        self._indices.insert(pos, index)
 
1323
        self._index_names.insert(pos, name)
1281
1324
 
1282
1325
    def iter_all_entries(self):
1283
1326
        """Iterate over all keys within the index
1308
1351
        value and are only reported once.
1309
1352
 
1310
1353
        :param keys: An iterable providing the keys to be retrieved.
1311
 
        :return: An iterable of (index, key, reference_lists, value). There is no
1312
 
            defined order for the result iteration - it will be in the most
 
1354
        :return: An iterable of (index, key, reference_lists, value). There is
 
1355
            no defined order for the result iteration - it will be in the most
1313
1356
            efficient order for the index.
1314
1357
        """
1315
1358
        keys = set(keys)
 
1359
        hit_indices = []
1316
1360
        while True:
1317
1361
            try:
1318
1362
                for index in self._indices:
1319
1363
                    if not keys:
1320
 
                        return
 
1364
                        break
 
1365
                    index_hit = False
1321
1366
                    for node in index.iter_entries(keys):
1322
1367
                        keys.remove(node[1])
1323
1368
                        yield node
1324
 
                return
 
1369
                        index_hit = True
 
1370
                    if index_hit:
 
1371
                        hit_indices.append(index)
 
1372
                break
1325
1373
            except errors.NoSuchFile:
1326
1374
                self._reload_or_raise()
 
1375
        self._move_to_front(hit_indices)
1327
1376
 
1328
1377
    def iter_entries_prefix(self, keys):
1329
1378
        """Iterate over keys within the index using prefix matching.
1349
1398
        if not keys:
1350
1399
            return
1351
1400
        seen_keys = set()
 
1401
        hit_indices = []
1352
1402
        while True:
1353
1403
            try:
1354
1404
                for index in self._indices:
 
1405
                    index_hit = False
1355
1406
                    for node in index.iter_entries_prefix(keys):
1356
1407
                        if node[1] in seen_keys:
1357
1408
                            continue
1358
1409
                        seen_keys.add(node[1])
1359
1410
                        yield node
1360
 
                return
 
1411
                        index_hit = True
 
1412
                    if index_hit:
 
1413
                        hit_indices.append(index)
 
1414
                break
1361
1415
            except errors.NoSuchFile:
1362
1416
                self._reload_or_raise()
 
1417
        self._move_to_front(hit_indices)
 
1418
 
 
1419
    def _move_to_front(self, hit_indices):
 
1420
        """Rearrange self._indices so that hit_indices are first.
 
1421
 
 
1422
        Order is maintained as much as possible, e.g. the first unhit index
 
1423
        will be the first index in _indices after the hit_indices, and the
 
1424
        hit_indices will be present in exactly the order they are passed to
 
1425
        _move_to_front.
 
1426
 
 
1427
        _move_to_front propagates to all objects in self._sibling_indices by
 
1428
        calling _move_to_front_by_name.
 
1429
        """
 
1430
        if self._indices[:len(hit_indices)] == hit_indices:
 
1431
            # The 'hit_indices' are already at the front (and in the same
 
1432
            # order), no need to re-order
 
1433
            return
 
1434
        hit_names = self._move_to_front_by_index(hit_indices)
 
1435
        for sibling_idx in self._sibling_indices:
 
1436
            sibling_idx._move_to_front_by_name(hit_names)
 
1437
 
 
1438
    def _move_to_front_by_index(self, hit_indices):
 
1439
        """Core logic for _move_to_front.
 
1440
        
 
1441
        Returns a list of names corresponding to the hit_indices param.
 
1442
        """
 
1443
        indices_info = zip(self._index_names, self._indices)
 
1444
        if 'index' in debug.debug_flags:
 
1445
            trace.mutter('CombinedGraphIndex reordering: currently %r, '
 
1446
                         'promoting %r', indices_info, hit_indices)
 
1447
        hit_names = []
 
1448
        unhit_names = []
 
1449
        new_hit_indices = []
 
1450
        unhit_indices = []
 
1451
 
 
1452
        for offset, (name, idx) in enumerate(indices_info):
 
1453
            if idx in hit_indices:
 
1454
                hit_names.append(name)
 
1455
                new_hit_indices.append(idx)
 
1456
                if len(new_hit_indices) == len(hit_indices):
 
1457
                    # We've found all of the hit entries, everything else is
 
1458
                    # unhit
 
1459
                    unhit_names.extend(self._index_names[offset+1:])
 
1460
                    unhit_indices.extend(self._indices[offset+1:])
 
1461
                    break
 
1462
            else:
 
1463
                unhit_names.append(name)
 
1464
                unhit_indices.append(idx)
 
1465
 
 
1466
        self._indices = new_hit_indices + unhit_indices
 
1467
        self._index_names = hit_names + unhit_names
 
1468
        if 'index' in debug.debug_flags:
 
1469
            trace.mutter('CombinedGraphIndex reordered: %r', self._indices)
 
1470
        return hit_names
 
1471
 
 
1472
    def _move_to_front_by_name(self, hit_names):
 
1473
        """Moves indices named by 'hit_names' to front of the search order, as
 
1474
        described in _move_to_front.
 
1475
        """
 
1476
        # Translate names to index instances, and then call
 
1477
        # _move_to_front_by_index.
 
1478
        indices_info = zip(self._index_names, self._indices)
 
1479
        hit_indices = []
 
1480
        for name, idx in indices_info:
 
1481
            if name in hit_names:
 
1482
                hit_indices.append(idx)
 
1483
        self._move_to_front_by_index(hit_indices)
1363
1484
 
1364
1485
    def find_ancestry(self, keys, ref_list_num):
1365
1486
        """Find the complete ancestry for the given set of keys.
1372
1493
            we care about.
1373
1494
        :return: (parent_map, missing_keys)
1374
1495
        """
 
1496
        # XXX: make this call _move_to_front?
1375
1497
        missing_keys = set()
1376
1498
        parent_map = {}
1377
1499
        keys_to_lookup = set(keys)
1457
1579
                         ' Raising original exception.')
1458
1580
            raise exc_type, exc_value, exc_traceback
1459
1581
 
 
1582
    def set_sibling_indices(self, sibling_combined_graph_indices):
 
1583
        """Set the CombinedGraphIndex objects to reorder after reordering self.
 
1584
        """
 
1585
        self._sibling_indices = sibling_combined_graph_indices
 
1586
 
1460
1587
    def validate(self):
1461
1588
        """Validate that everything in the index can be accessed."""
1462
1589
        while True: