← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/index.py

  • Committer: Vincent Ladeuil
  • Date: 2010-02-05 10:27:33 UTC
  • mto: (5008.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 5009.
  • Revision ID: v.ladeuil+lp@free.fr-20100205102733-8wpjnqz6g4nvrbfu
All Conflict action method names start with 'action_' to avoid potential namespace collisions

Show diffs side-by-side

added added

removed removed

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