← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/index.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-02-11 06:15:33 UTC
  • mfrom: (5025.1.6 331095-malloc)
  • Revision ID: pqm@pqm.ubuntu.com-20100211061533-5glf4faoutadhql9
(mbp) avoid malloc(0)

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
31
31
 
32
32
from bzrlib.lazy_import import lazy_import
33
33
lazy_import(globals(), """
34
 
from bzrlib import (
35
 
    bisect_multi,
36
 
    revision as _mod_revision,
37
 
    trace,
38
 
    )
 
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
39
38
""")
40
39
from bzrlib import (
41
40
    debug,
70
69
class GraphIndexBuilder(object):
71
70
    """A builder that can build a GraphIndex.
72
71
 
73
 
    The resulting graph has the structure::
 
72
    The resulting graph has the structure:
74
73
 
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
 
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
87
86
    """
88
87
 
89
88
    def __init__(self, reference_lists=0, key_elements=1):
185
184
        :param value: The value associate with this key. Must not contain
186
185
            newlines or null characters.
187
186
        :return: (node_refs, absent_references)
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.
 
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.
194
192
        """
195
193
        as_st = StaticTuple.from_sequence
196
194
        self._check_key(key)
221
219
        :param references: An iterable of iterables of keys. Each is a
222
220
            reference to another key.
223
221
        :param value: The value to associate with the key. It may be any
224
 
            bytes as long as it does not contain \\0 or \\n.
 
222
            bytes as long as it does not contain \0 or \n.
225
223
        """
226
224
        (node_refs,
227
225
         absent_references) = self._check_key_ref_value(key, references, value)
384
382
    suitable for production use. :XXX
385
383
    """
386
384
 
387
 
    def __init__(self, transport, name, size, unlimited_cache=False, offset=0):
 
385
    def __init__(self, transport, name, size, unlimited_cache=False):
388
386
        """Open an index called name on transport.
389
387
 
390
388
        :param transport: A bzrlib.transport.Transport.
396
394
            avoided by having it supplied. If size is None, then bisection
397
395
            support will be disabled and accessing the index will just stream
398
396
            all the data.
399
 
        :param offset: Instead of starting the index data at offset 0, start it
400
 
            at an arbitrary offset.
401
397
        """
402
398
        self._transport = transport
403
399
        self._name = name
420
416
        self._size = size
421
417
        # The number of bytes we've read so far in trying to process this file
422
418
        self._bytes_read = 0
423
 
        self._base_offset = offset
424
419
 
425
420
    def __eq__(self, other):
426
421
        """Equal when self and other were created with the same parameters."""
446
441
            # We already did this
447
442
            return
448
443
        if 'index' in debug.debug_flags:
449
 
            trace.mutter('Reading entire index %s',
450
 
                          self._transport.abspath(self._name))
 
444
            mutter('Reading entire index %s', self._transport.abspath(self._name))
451
445
        if stream is None:
452
446
            stream = self._transport.get(self._name)
453
 
            if self._base_offset != 0:
454
 
                # This is wasteful, but it is better than dealing with
455
 
                # adjusting all the offsets, etc.
456
 
                stream = StringIO(stream.read()[self._base_offset:])
457
447
        self._read_prefix(stream)
458
448
        self._expected_elements = 3 + self._key_length
459
449
        line_count = 0
465
455
        trailers = 0
466
456
        pos = stream.tell()
467
457
        lines = stream.read().split('\n')
468
 
        # GZ 2009-09-20: Should really use a try/finally block to ensure close
469
458
        stream.close()
470
459
        del lines[-1]
471
460
        _, _, _, trailers = self._parse_lines(lines, pos)
674
663
        if self._nodes is not None:
675
664
            return self._iter_entries_from_total_buffer(keys)
676
665
        else:
677
 
            return (result[1] for result in bisect_multi.bisect_multi_bytes(
 
666
            return (result[1] for result in bisect_multi_bytes(
678
667
                self._lookup_keys_via_location, self._size, keys))
679
668
 
680
669
    def iter_entries_prefix(self, keys):
1201
1190
            self._buffer_all()
1202
1191
            return
1203
1192
 
1204
 
        base_offset = self._base_offset
1205
 
        if base_offset != 0:
1206
 
            # Rewrite the ranges for the offset
1207
 
            readv_ranges = [(start+base_offset, size)
1208
 
                            for start, size in readv_ranges]
1209
1193
        readv_data = self._transport.readv(self._name, readv_ranges, True,
1210
 
            self._size + self._base_offset)
 
1194
            self._size)
1211
1195
        # parse
1212
1196
        for offset, data in readv_data:
1213
 
            offset -= base_offset
1214
1197
            self._bytes_read += len(data)
1215
 
            if offset < 0:
1216
 
                # transport.readv() expanded to extra data which isn't part of
1217
 
                # this index
1218
 
                data = data[-offset:]
1219
 
                offset = 0
1220
1198
            if offset == 0 and len(data) == self._size:
1221
1199
                # We read the whole range, most likely because the
1222
1200
                # Transport upcast our readv ranges into one long request
1249
1227
    static data.
1250
1228
 
1251
1229
    Queries against the combined index will be made against the first index,
1252
 
    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
1253
1231
    performance significantly. For example, if one index is on local disk and a
1254
1232
    second on a remote server, the local disk index should be before the other
1255
1233
    in the index list.
1256
 
    
1257
 
    Also, queries tend to need results from the same indices as previous
1258
 
    queries.  So the indices will be reordered after every query to put the
1259
 
    indices that had the result(s) of that query first (while otherwise
1260
 
    preserving the relative ordering).
1261
1234
    """
1262
1235
 
1263
1236
    def __init__(self, indices, reload_func=None):
1270
1243
        """
1271
1244
        self._indices = indices
1272
1245
        self._reload_func = reload_func
1273
 
        # Sibling indices are other CombinedGraphIndex that we should call
1274
 
        # _move_to_front_by_name on when we auto-reorder ourself.
1275
 
        self._sibling_indices = []
1276
 
        # A list of names that corresponds to the instances in self._indices,
1277
 
        # so _index_names[0] is always the name for _indices[0], etc.  Sibling
1278
 
        # indices must all use the same set of names as each other.
1279
 
        self._index_names = [None] * len(self._indices)
1280
1246
 
1281
1247
    def __repr__(self):
1282
1248
        return "%s(%s)" % (
1291
1257
    def get_parent_map(self, keys):
1292
1258
        """See graph.StackedParentsProvider.get_parent_map"""
1293
1259
        search_keys = set(keys)
1294
 
        if _mod_revision.NULL_REVISION in search_keys:
1295
 
            search_keys.discard(_mod_revision.NULL_REVISION)
1296
 
            found_parents = {_mod_revision.NULL_REVISION:[]}
 
1260
        if NULL_REVISION in search_keys:
 
1261
            search_keys.discard(NULL_REVISION)
 
1262
            found_parents = {NULL_REVISION:[]}
1297
1263
        else:
1298
1264
            found_parents = {}
1299
1265
        for index, key, value, refs in self.iter_entries(search_keys):
1300
1266
            parents = refs[0]
1301
1267
            if not parents:
1302
 
                parents = (_mod_revision.NULL_REVISION,)
 
1268
                parents = (NULL_REVISION,)
1303
1269
            found_parents[key] = parents
1304
1270
        return found_parents
1305
1271
 
1306
1272
    has_key = _has_key_from_parent_map
1307
1273
 
1308
 
    def insert_index(self, pos, index, name=None):
 
1274
    def insert_index(self, pos, index):
1309
1275
        """Insert a new index in the list of indices to query.
1310
1276
 
1311
1277
        :param pos: The position to insert the index.
1312
1278
        :param index: The index to insert.
1313
 
        :param name: a name for this index, e.g. a pack name.  These names can
1314
 
            be used to reflect index reorderings to related CombinedGraphIndex
1315
 
            instances that use the same names.  (see set_sibling_indices)
1316
1279
        """
1317
1280
        self._indices.insert(pos, index)
1318
 
        self._index_names.insert(pos, name)
1319
1281
 
1320
1282
    def iter_all_entries(self):
1321
1283
        """Iterate over all keys within the index
1346
1308
        value and are only reported once.
1347
1309
 
1348
1310
        :param keys: An iterable providing the keys to be retrieved.
1349
 
        :return: An iterable of (index, key, reference_lists, value). There is
1350
 
            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
1351
1313
            efficient order for the index.
1352
1314
        """
1353
1315
        keys = set(keys)
1354
 
        hit_indices = []
1355
1316
        while True:
1356
1317
            try:
1357
1318
                for index in self._indices:
1358
1319
                    if not keys:
1359
 
                        break
1360
 
                    index_hit = False
 
1320
                        return
1361
1321
                    for node in index.iter_entries(keys):
1362
1322
                        keys.remove(node[1])
1363
1323
                        yield node
1364
 
                        index_hit = True
1365
 
                    if index_hit:
1366
 
                        hit_indices.append(index)
1367
 
                break
 
1324
                return
1368
1325
            except errors.NoSuchFile:
1369
1326
                self._reload_or_raise()
1370
 
        self._move_to_front(hit_indices)
1371
1327
 
1372
1328
    def iter_entries_prefix(self, keys):
1373
1329
        """Iterate over keys within the index using prefix matching.
1393
1349
        if not keys:
1394
1350
            return
1395
1351
        seen_keys = set()
1396
 
        hit_indices = []
1397
1352
        while True:
1398
1353
            try:
1399
1354
                for index in self._indices:
1400
 
                    index_hit = False
1401
1355
                    for node in index.iter_entries_prefix(keys):
1402
1356
                        if node[1] in seen_keys:
1403
1357
                            continue
1404
1358
                        seen_keys.add(node[1])
1405
1359
                        yield node
1406
 
                        index_hit = True
1407
 
                    if index_hit:
1408
 
                        hit_indices.append(index)
1409
 
                break
 
1360
                return
1410
1361
            except errors.NoSuchFile:
1411
1362
                self._reload_or_raise()
1412
 
        self._move_to_front(hit_indices)
1413
 
 
1414
 
    def _move_to_front(self, hit_indices):
1415
 
        """Rearrange self._indices so that hit_indices are first.
1416
 
 
1417
 
        Order is maintained as much as possible, e.g. the first unhit index
1418
 
        will be the first index in _indices after the hit_indices, and the
1419
 
        hit_indices will be present in exactly the order they are passed to
1420
 
        _move_to_front.
1421
 
 
1422
 
        _move_to_front propagates to all objects in self._sibling_indices by
1423
 
        calling _move_to_front_by_name.
1424
 
        """
1425
 
        if self._indices[:len(hit_indices)] == hit_indices:
1426
 
            # The 'hit_indices' are already at the front (and in the same
1427
 
            # order), no need to re-order
1428
 
            return
1429
 
        hit_names = self._move_to_front_by_index(hit_indices)
1430
 
        for sibling_idx in self._sibling_indices:
1431
 
            sibling_idx._move_to_front_by_name(hit_names)
1432
 
 
1433
 
    def _move_to_front_by_index(self, hit_indices):
1434
 
        """Core logic for _move_to_front.
1435
 
        
1436
 
        Returns a list of names corresponding to the hit_indices param.
1437
 
        """
1438
 
        indices_info = zip(self._index_names, self._indices)
1439
 
        if 'index' in debug.debug_flags:
1440
 
            trace.mutter('CombinedGraphIndex reordering: currently %r, '
1441
 
                         'promoting %r', indices_info, hit_indices)
1442
 
        hit_names = []
1443
 
        unhit_names = []
1444
 
        new_hit_indices = []
1445
 
        unhit_indices = []
1446
 
 
1447
 
        for offset, (name, idx) in enumerate(indices_info):
1448
 
            if idx in hit_indices:
1449
 
                hit_names.append(name)
1450
 
                new_hit_indices.append(idx)
1451
 
                if len(new_hit_indices) == len(hit_indices):
1452
 
                    # We've found all of the hit entries, everything else is
1453
 
                    # unhit
1454
 
                    unhit_names.extend(self._index_names[offset+1:])
1455
 
                    unhit_indices.extend(self._indices[offset+1:])
1456
 
                    break
1457
 
            else:
1458
 
                unhit_names.append(name)
1459
 
                unhit_indices.append(idx)
1460
 
 
1461
 
        self._indices = new_hit_indices + unhit_indices
1462
 
        self._index_names = hit_names + unhit_names
1463
 
        if 'index' in debug.debug_flags:
1464
 
            trace.mutter('CombinedGraphIndex reordered: %r', self._indices)
1465
 
        return hit_names
1466
 
 
1467
 
    def _move_to_front_by_name(self, hit_names):
1468
 
        """Moves indices named by 'hit_names' to front of the search order, as
1469
 
        described in _move_to_front.
1470
 
        """
1471
 
        # Translate names to index instances, and then call
1472
 
        # _move_to_front_by_index.
1473
 
        indices_info = zip(self._index_names, self._indices)
1474
 
        hit_indices = []
1475
 
        for name, idx in indices_info:
1476
 
            if name in hit_names:
1477
 
                hit_indices.append(idx)
1478
 
        self._move_to_front_by_index(hit_indices)
1479
1363
 
1480
1364
    def find_ancestry(self, keys, ref_list_num):
1481
1365
        """Find the complete ancestry for the given set of keys.
1488
1372
            we care about.
1489
1373
        :return: (parent_map, missing_keys)
1490
1374
        """
1491
 
        # XXX: make this call _move_to_front?
1492
1375
        missing_keys = set()
1493
1376
        parent_map = {}
1494
1377
        keys_to_lookup = set(keys)
1574
1457
                         ' Raising original exception.')
1575
1458
            raise exc_type, exc_value, exc_traceback
1576
1459
 
1577
 
    def set_sibling_indices(self, sibling_combined_graph_indices):
1578
 
        """Set the CombinedGraphIndex objects to reorder after reordering self.
1579
 
        """
1580
 
        self._sibling_indices = sibling_combined_graph_indices
1581
 
 
1582
1460
    def validate(self):
1583
1461
        """Validate that everything in the index can be accessed."""
1584
1462
        while True: