← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/index.py

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-2010 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
382
382
    suitable for production use. :XXX
383
383
    """
384
384
 
385
 
    def __init__(self, transport, name, size, unlimited_cache=False):
 
385
    def __init__(self, transport, name, size, unlimited_cache=False, offset=0):
386
386
        """Open an index called name on transport.
387
387
 
388
388
        :param transport: A bzrlib.transport.Transport.
394
394
            avoided by having it supplied. If size is None, then bisection
395
395
            support will be disabled and accessing the index will just stream
396
396
            all the data.
 
397
        :param offset: Instead of starting the index data at offset 0, start it
 
398
            at an arbitrary offset.
397
399
        """
398
400
        self._transport = transport
399
401
        self._name = name
416
418
        self._size = size
417
419
        # The number of bytes we've read so far in trying to process this file
418
420
        self._bytes_read = 0
 
421
        self._base_offset = offset
419
422
 
420
423
    def __eq__(self, other):
421
424
        """Equal when self and other were created with the same parameters."""
444
447
            mutter('Reading entire index %s', self._transport.abspath(self._name))
445
448
        if stream is None:
446
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:])
447
454
        self._read_prefix(stream)
448
455
        self._expected_elements = 3 + self._key_length
449
456
        line_count = 0
1190
1197
            self._buffer_all()
1191
1198
            return
1192
1199
 
 
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]
1193
1205
        readv_data = self._transport.readv(self._name, readv_ranges, True,
1194
 
            self._size)
 
1206
            self._size + self._base_offset)
1195
1207
        # parse
1196
1208
        for offset, data in readv_data:
 
1209
            offset -= base_offset
1197
1210
            self._bytes_read += len(data)
 
1211
            if offset < 0:
 
1212
                # transport.readv() expanded to extra data which isn't part of
 
1213
                # this index
 
1214
                data = data[-offset:]
 
1215
                offset = 0
1198
1216
            if offset == 0 and len(data) == self._size:
1199
1217
                # We read the whole range, most likely because the
1200
1218
                # Transport upcast our readv ranges into one long request
1227
1245
    static data.
1228
1246
 
1229
1247
    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
 
1248
    and then the second and so on. The order of indices can thus influence
1231
1249
    performance significantly. For example, if one index is on local disk and a
1232
1250
    second on a remote server, the local disk index should be before the other
1233
1251
    in the index list.
 
1252
    
 
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).
1234
1257
    """
1235
1258
 
1236
1259
    def __init__(self, indices, reload_func=None):
1243
1266
        """
1244
1267
        self._indices = indices
1245
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)
1246
1276
 
1247
1277
    def __repr__(self):
1248
1278
        return "%s(%s)" % (
1271
1301
 
1272
1302
    has_key = _has_key_from_parent_map
1273
1303
 
1274
 
    def insert_index(self, pos, index):
 
1304
    def insert_index(self, pos, index, name=None):
1275
1305
        """Insert a new index in the list of indices to query.
1276
1306
 
1277
1307
        :param pos: The position to insert the index.
1278
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)
1279
1312
        """
1280
1313
        self._indices.insert(pos, index)
 
1314
        self._index_names.insert(pos, name)
1281
1315
 
1282
1316
    def iter_all_entries(self):
1283
1317
        """Iterate over all keys within the index
1308
1342
        value and are only reported once.
1309
1343
 
1310
1344
        :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
 
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
1313
1347
            efficient order for the index.
1314
1348
        """
1315
1349
        keys = set(keys)
 
1350
        hit_indices = []
1316
1351
        while True:
1317
1352
            try:
1318
1353
                for index in self._indices:
1319
1354
                    if not keys:
1320
 
                        return
 
1355
                        break
 
1356
                    index_hit = False
1321
1357
                    for node in index.iter_entries(keys):
1322
1358
                        keys.remove(node[1])
1323
1359
                        yield node
1324
 
                return
 
1360
                        index_hit = True
 
1361
                    if index_hit:
 
1362
                        hit_indices.append(index)
 
1363
                break
1325
1364
            except errors.NoSuchFile:
1326
1365
                self._reload_or_raise()
 
1366
        self._move_to_front(hit_indices)
1327
1367
 
1328
1368
    def iter_entries_prefix(self, keys):
1329
1369
        """Iterate over keys within the index using prefix matching.
1349
1389
        if not keys:
1350
1390
            return
1351
1391
        seen_keys = set()
 
1392
        hit_indices = []
1352
1393
        while True:
1353
1394
            try:
1354
1395
                for index in self._indices:
 
1396
                    index_hit = False
1355
1397
                    for node in index.iter_entries_prefix(keys):
1356
1398
                        if node[1] in seen_keys:
1357
1399
                            continue
1358
1400
                        seen_keys.add(node[1])
1359
1401
                        yield node
1360
 
                return
 
1402
                        index_hit = True
 
1403
                    if index_hit:
 
1404
                        hit_indices.append(index)
 
1405
                break
1361
1406
            except errors.NoSuchFile:
1362
1407
                self._reload_or_raise()
 
1408
        self._move_to_front(hit_indices)
 
1409
 
 
1410
    def _move_to_front(self, hit_indices):
 
1411
        """Rearrange self._indices so that hit_indices are first.
 
1412
 
 
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
 
1416
        _move_to_front.
 
1417
 
 
1418
        _move_to_front propagates to all objects in self._sibling_indices by
 
1419
        calling _move_to_front_by_name.
 
1420
        """
 
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
 
1424
            return
 
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)
 
1428
 
 
1429
    def _move_to_front_by_index(self, hit_indices):
 
1430
        """Core logic for _move_to_front.
 
1431
        
 
1432
        Returns a list of names corresponding to the hit_indices param.
 
1433
        """
 
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)
 
1438
        hit_indices_info = []
 
1439
        hit_names = []
 
1440
        unhit_indices_info = []
 
1441
        for name, idx in indices_info:
 
1442
            if idx in hit_indices:
 
1443
                info = hit_indices_info
 
1444
                hit_names.append(name)
 
1445
            else:
 
1446
                info = unhit_indices_info
 
1447
            info.append((name, idx))
 
1448
        final_info = hit_indices_info + unhit_indices_info
 
1449
        self._indices = [idx for (name, idx) in final_info]
 
1450
        self._index_names = [name for (name, idx) in final_info]
 
1451
        if 'index' in debug.debug_flags:
 
1452
            mutter('CombinedGraphIndex reordered: %r', self._indices)
 
1453
        return hit_names
 
1454
 
 
1455
    def _move_to_front_by_name(self, hit_names):
 
1456
        """Moves indices named by 'hit_names' to front of the search order, as
 
1457
        described in _move_to_front.
 
1458
        """
 
1459
        # Translate names to index instances, and then call
 
1460
        # _move_to_front_by_index.
 
1461
        indices_info = zip(self._index_names, self._indices)
 
1462
        hit_indices = []
 
1463
        for name, idx in indices_info:
 
1464
            if name in hit_names:
 
1465
                hit_indices.append(idx)
 
1466
        self._move_to_front_by_index(hit_indices)
1363
1467
 
1364
1468
    def find_ancestry(self, keys, ref_list_num):
1365
1469
        """Find the complete ancestry for the given set of keys.
1372
1476
            we care about.
1373
1477
        :return: (parent_map, missing_keys)
1374
1478
        """
 
1479
        # XXX: make this call _move_to_front?
1375
1480
        missing_keys = set()
1376
1481
        parent_map = {}
1377
1482
        keys_to_lookup = set(keys)
1457
1562
                         ' Raising original exception.')
1458
1563
            raise exc_type, exc_value, exc_traceback
1459
1564
 
 
1565
    def set_sibling_indices(self, sibling_combined_graph_indices):
 
1566
        """Set the CombinedGraphIndex objects to reorder after reordering self.
 
1567
        """
 
1568
        self._sibling_indices = sibling_combined_graph_indices
 
1569
 
1460
1570
    def validate(self):
1461
1571
        """Validate that everything in the index can be accessed."""
1462
1572
        while True: