← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/index.py

  • Committer: Patch Queue Manager
  • Date: 2012-03-16 14:15:06 UTC
  • mfrom: (6503.3.1 typo-fix)
  • Revision ID: pqm@pqm.ubuntu.com-20120316141506-30gdc3wkbgmwkdus
(jelmer) Fix a typo: extention -> extension. (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/index.py
1
 
# Copyright (C) 2007-2010 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
16
16
 
17
17
"""Indexing facilities."""
18
18
 
 
19
from __future__ import absolute_import
 
20
 
19
21
__all__ = [
20
22
    'CombinedGraphIndex',
21
23
    'GraphIndex',
31
33
 
32
34
from bzrlib.lazy_import import lazy_import
33
35
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
 
36
from bzrlib import (
 
37
    bisect_multi,
 
38
    revision as _mod_revision,
 
39
    trace,
 
40
    )
38
41
""")
39
42
from bzrlib import (
40
43
    debug,
69
72
class GraphIndexBuilder(object):
70
73
    """A builder that can build a GraphIndex.
71
74
 
72
 
    The resulting graph has the structure:
 
75
    The resulting graph has the structure::
73
76
 
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
 
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
86
89
    """
87
90
 
88
91
    def __init__(self, reference_lists=0, key_elements=1):
184
187
        :param value: The value associate with this key. Must not contain
185
188
            newlines or null characters.
186
189
        :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.
 
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.
192
196
        """
193
197
        as_st = StaticTuple.from_sequence
194
198
        self._check_key(key)
219
223
        :param references: An iterable of iterables of keys. Each is a
220
224
            reference to another key.
221
225
        :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.
 
226
            bytes as long as it does not contain \\0 or \\n.
223
227
        """
224
228
        (node_refs,
225
229
         absent_references) = self._check_key_ref_value(key, references, value)
243
247
        """
244
248
        
245
249
    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
        """
246
255
        lines = [_SIGNATURE]
247
256
        lines.append(_OPTION_NODE_REFS + str(self.reference_lists) + '\n')
248
257
        lines.append(_OPTION_KEY_ELEMENTS + str(self._key_length) + '\n')
382
391
    suitable for production use. :XXX
383
392
    """
384
393
 
385
 
    def __init__(self, transport, name, size, unlimited_cache=False):
 
394
    def __init__(self, transport, name, size, unlimited_cache=False, offset=0):
386
395
        """Open an index called name on transport.
387
396
 
388
397
        :param transport: A bzrlib.transport.Transport.
394
403
            avoided by having it supplied. If size is None, then bisection
395
404
            support will be disabled and accessing the index will just stream
396
405
            all the data.
 
406
        :param offset: Instead of starting the index data at offset 0, start it
 
407
            at an arbitrary offset.
397
408
        """
398
409
        self._transport = transport
399
410
        self._name = name
416
427
        self._size = size
417
428
        # The number of bytes we've read so far in trying to process this file
418
429
        self._bytes_read = 0
 
430
        self._base_offset = offset
419
431
 
420
432
    def __eq__(self, other):
421
433
        """Equal when self and other were created with the same parameters."""
441
453
            # We already did this
442
454
            return
443
455
        if 'index' in debug.debug_flags:
444
 
            mutter('Reading entire index %s', self._transport.abspath(self._name))
 
456
            trace.mutter('Reading entire index %s',
 
457
                          self._transport.abspath(self._name))
445
458
        if stream is None:
446
459
            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:])
447
464
        self._read_prefix(stream)
448
465
        self._expected_elements = 3 + self._key_length
449
466
        line_count = 0
455
472
        trailers = 0
456
473
        pos = stream.tell()
457
474
        lines = stream.read().split('\n')
 
475
        # GZ 2009-09-20: Should really use a try/finally block to ensure close
458
476
        stream.close()
459
477
        del lines[-1]
460
478
        _, _, _, trailers = self._parse_lines(lines, pos)
663
681
        if self._nodes is not None:
664
682
            return self._iter_entries_from_total_buffer(keys)
665
683
        else:
666
 
            return (result[1] for result in bisect_multi_bytes(
 
684
            return (result[1] for result in bisect_multi.bisect_multi_bytes(
667
685
                self._lookup_keys_via_location, self._size, keys))
668
686
 
669
687
    def iter_entries_prefix(self, keys):
1190
1208
            self._buffer_all()
1191
1209
            return
1192
1210
 
 
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]
1193
1216
        readv_data = self._transport.readv(self._name, readv_ranges, True,
1194
 
            self._size)
 
1217
            self._size + self._base_offset)
1195
1218
        # parse
1196
1219
        for offset, data in readv_data:
 
1220
            offset -= base_offset
1197
1221
            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
1198
1227
            if offset == 0 and len(data) == self._size:
1199
1228
                # We read the whole range, most likely because the
1200
1229
                # Transport upcast our readv ranges into one long request
1227
1256
    static data.
1228
1257
 
1229
1258
    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
 
1259
    and then the second and so on. The order of indices can thus influence
1231
1260
    performance significantly. For example, if one index is on local disk and a
1232
1261
    second on a remote server, the local disk index should be before the other
1233
1262
    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).
1234
1268
    """
1235
1269
 
1236
1270
    def __init__(self, indices, reload_func=None):
1243
1277
        """
1244
1278
        self._indices = indices
1245
1279
        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)
1246
1287
 
1247
1288
    def __repr__(self):
1248
1289
        return "%s(%s)" % (
1257
1298
    def get_parent_map(self, keys):
1258
1299
        """See graph.StackedParentsProvider.get_parent_map"""
1259
1300
        search_keys = set(keys)
1260
 
        if NULL_REVISION in search_keys:
1261
 
            search_keys.discard(NULL_REVISION)
1262
 
            found_parents = {NULL_REVISION:[]}
 
1301
        if _mod_revision.NULL_REVISION in search_keys:
 
1302
            search_keys.discard(_mod_revision.NULL_REVISION)
 
1303
            found_parents = {_mod_revision.NULL_REVISION:[]}
1263
1304
        else:
1264
1305
            found_parents = {}
1265
1306
        for index, key, value, refs in self.iter_entries(search_keys):
1266
1307
            parents = refs[0]
1267
1308
            if not parents:
1268
 
                parents = (NULL_REVISION,)
 
1309
                parents = (_mod_revision.NULL_REVISION,)
1269
1310
            found_parents[key] = parents
1270
1311
        return found_parents
1271
1312
 
1272
1313
    has_key = _has_key_from_parent_map
1273
1314
 
1274
 
    def insert_index(self, pos, index):
 
1315
    def insert_index(self, pos, index, name=None):
1275
1316
        """Insert a new index in the list of indices to query.
1276
1317
 
1277
1318
        :param pos: The position to insert the index.
1278
1319
        :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)
1279
1323
        """
1280
1324
        self._indices.insert(pos, index)
 
1325
        self._index_names.insert(pos, name)
1281
1326
 
1282
1327
    def iter_all_entries(self):
1283
1328
        """Iterate over all keys within the index
1308
1353
        value and are only reported once.
1309
1354
 
1310
1355
        :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
 
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
1313
1358
            efficient order for the index.
1314
1359
        """
1315
1360
        keys = set(keys)
 
1361
        hit_indices = []
1316
1362
        while True:
1317
1363
            try:
1318
1364
                for index in self._indices:
1319
1365
                    if not keys:
1320
 
                        return
 
1366
                        break
 
1367
                    index_hit = False
1321
1368
                    for node in index.iter_entries(keys):
1322
1369
                        keys.remove(node[1])
1323
1370
                        yield node
1324
 
                return
 
1371
                        index_hit = True
 
1372
                    if index_hit:
 
1373
                        hit_indices.append(index)
 
1374
                break
1325
1375
            except errors.NoSuchFile:
1326
1376
                self._reload_or_raise()
 
1377
        self._move_to_front(hit_indices)
1327
1378
 
1328
1379
    def iter_entries_prefix(self, keys):
1329
1380
        """Iterate over keys within the index using prefix matching.
1349
1400
        if not keys:
1350
1401
            return
1351
1402
        seen_keys = set()
 
1403
        hit_indices = []
1352
1404
        while True:
1353
1405
            try:
1354
1406
                for index in self._indices:
 
1407
                    index_hit = False
1355
1408
                    for node in index.iter_entries_prefix(keys):
1356
1409
                        if node[1] in seen_keys:
1357
1410
                            continue
1358
1411
                        seen_keys.add(node[1])
1359
1412
                        yield node
1360
 
                return
 
1413
                        index_hit = True
 
1414
                    if index_hit:
 
1415
                        hit_indices.append(index)
 
1416
                break
1361
1417
            except errors.NoSuchFile:
1362
1418
                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)
1363
1486
 
1364
1487
    def find_ancestry(self, keys, ref_list_num):
1365
1488
        """Find the complete ancestry for the given set of keys.
1372
1495
            we care about.
1373
1496
        :return: (parent_map, missing_keys)
1374
1497
        """
 
1498
        # XXX: make this call _move_to_front?
1375
1499
        missing_keys = set()
1376
1500
        parent_map = {}
1377
1501
        keys_to_lookup = set(keys)
1457
1581
                         ' Raising original exception.')
1458
1582
            raise exc_type, exc_value, exc_traceback
1459
1583
 
 
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
 
1460
1589
    def validate(self):
1461
1590
        """Validate that everything in the index can be accessed."""
1462
1591
        while True: