~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/index.py

  • Committer: Martin Pool
  • Date: 2009-07-27 06:28:35 UTC
  • mto: This revision was merged to the branch mainline in revision 4587.
  • Revision ID: mbp@sourcefrog.net-20090727062835-o66p8it658tq1sma
Add CountedLock.get_physical_lock_status

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2007-2010 Canonical Ltd
 
1
# Copyright (C) 2007, 2008 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
40
40
    debug,
41
41
    errors,
42
42
    )
43
 
from bzrlib.static_tuple import StaticTuple
44
43
 
45
44
_HEADER_READV = (0, 200)
46
45
_OPTION_KEY_ELEMENTS = "key_elements="
93
92
        :param key_elements: The number of bytestrings in each key.
94
93
        """
95
94
        self.reference_lists = reference_lists
 
95
        self._keys = set()
96
96
        # A dict of {key: (absent, ref_lists, value)}
97
97
        self._nodes = {}
98
 
        # Keys that are referenced but not actually present in this index
99
 
        self._absent_keys = set()
100
98
        self._nodes_by_key = None
101
99
        self._key_length = key_elements
102
100
        self._optimize_for_size = False
104
102
 
105
103
    def _check_key(self, key):
106
104
        """Raise BadIndexKey if key is not a valid key for this index."""
107
 
        if type(key) not in (tuple, StaticTuple):
 
105
        if type(key) != tuple:
108
106
            raise errors.BadIndexKey(key)
109
107
        if self._key_length != len(key):
110
108
            raise errors.BadIndexKey(key)
166
164
            return
167
165
        key_dict = self._nodes_by_key
168
166
        if self.reference_lists:
169
 
            key_value = StaticTuple(key, value, node_refs)
 
167
            key_value = key, value, node_refs
170
168
        else:
171
 
            key_value = StaticTuple(key, value)
 
169
            key_value = key, value
172
170
        for subkey in key[:-1]:
173
171
            key_dict = key_dict.setdefault(subkey, {})
174
172
        key_dict[key[-1]] = key_value
190
188
                                This may contain duplicates if the same key is
191
189
                                referenced in multiple lists.
192
190
        """
193
 
        as_st = StaticTuple.from_sequence
194
191
        self._check_key(key)
195
192
        if _newline_null_re.search(value) is not None:
196
193
            raise errors.BadIndexValue(value)
205
202
                if reference not in self._nodes:
206
203
                    self._check_key(reference)
207
204
                    absent_references.append(reference)
208
 
            reference_list = as_st([as_st(ref).intern()
209
 
                                    for ref in reference_list])
210
 
            node_refs.append(reference_list)
211
 
        return as_st(node_refs), absent_references
 
205
            node_refs.append(tuple(reference_list))
 
206
        return tuple(node_refs), absent_references
212
207
 
213
208
    def add_node(self, key, value, references=()):
214
209
        """Add a node to the index.
229
224
            # There may be duplicates, but I don't think it is worth worrying
230
225
            # about
231
226
            self._nodes[reference] = ('a', (), '')
232
 
        self._absent_keys.update(absent_references)
233
 
        self._absent_keys.discard(key)
234
227
        self._nodes[key] = ('', node_refs, value)
 
228
        self._keys.add(key)
235
229
        if self._nodes_by_key is not None and self._key_length > 1:
236
230
            self._update_nodes_by_key(key, value, node_refs)
237
231
 
238
 
    def clear_cache(self):
239
 
        """See GraphIndex.clear_cache()
240
 
 
241
 
        This is a no-op, but we need the api to conform to a generic 'Index'
242
 
        abstraction.
243
 
        """
244
 
        
245
232
    def finish(self):
246
233
        lines = [_SIGNATURE]
247
234
        lines.append(_OPTION_NODE_REFS + str(self.reference_lists) + '\n')
248
235
        lines.append(_OPTION_KEY_ELEMENTS + str(self._key_length) + '\n')
249
 
        key_count = len(self._nodes) - len(self._absent_keys)
250
 
        lines.append(_OPTION_LEN + str(key_count) + '\n')
 
236
        lines.append(_OPTION_LEN + str(len(self._keys)) + '\n')
251
237
        prefix_length = sum(len(x) for x in lines)
252
238
        # references are byte offsets. To avoid having to do nasty
253
239
        # polynomial work to resolve offsets (references to later in the
347
333
        if combine_backing_indices is not None:
348
334
            self._combine_backing_indices = combine_backing_indices
349
335
 
350
 
    def find_ancestry(self, keys, ref_list_num):
351
 
        """See CombinedGraphIndex.find_ancestry()"""
352
 
        pending = set(keys)
353
 
        parent_map = {}
354
 
        missing_keys = set()
355
 
        while pending:
356
 
            next_pending = set()
357
 
            for _, key, value, ref_lists in self.iter_entries(pending):
358
 
                parent_keys = ref_lists[ref_list_num]
359
 
                parent_map[key] = parent_keys
360
 
                next_pending.update([p for p in parent_keys if p not in
361
 
                                     parent_map])
362
 
                missing_keys.update(pending.difference(parent_map))
363
 
            pending = next_pending
364
 
        return parent_map, missing_keys
365
 
 
366
336
 
367
337
class GraphIndex(object):
368
338
    """An index for data with embedded graphs.
382
352
    suitable for production use. :XXX
383
353
    """
384
354
 
385
 
    def __init__(self, transport, name, size, unlimited_cache=False, offset=0):
 
355
    def __init__(self, transport, name, size):
386
356
        """Open an index called name on transport.
387
357
 
388
358
        :param transport: A bzrlib.transport.Transport.
394
364
            avoided by having it supplied. If size is None, then bisection
395
365
            support will be disabled and accessing the index will just stream
396
366
            all the data.
397
 
        :param offset: Instead of starting the index data at offset 0, start it
398
 
            at an arbitrary offset.
399
367
        """
400
368
        self._transport = transport
401
369
        self._name = name
418
386
        self._size = size
419
387
        # The number of bytes we've read so far in trying to process this file
420
388
        self._bytes_read = 0
421
 
        self._base_offset = offset
422
389
 
423
390
    def __eq__(self, other):
424
391
        """Equal when self and other were created with the same parameters."""
447
414
            mutter('Reading entire index %s', self._transport.abspath(self._name))
448
415
        if stream is None:
449
416
            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:])
454
417
        self._read_prefix(stream)
455
418
        self._expected_elements = 3 + self._key_length
456
419
        line_count = 0
462
425
        trailers = 0
463
426
        pos = stream.tell()
464
427
        lines = stream.read().split('\n')
465
 
        stream.close()
466
428
        del lines[-1]
467
429
        _, _, _, trailers = self._parse_lines(lines, pos)
468
430
        for key, absent, references, value in self._keys_by_offset.itervalues():
475
437
                node_value = value
476
438
            self._nodes[key] = node_value
477
439
        # cache the keys for quick set intersections
 
440
        self._keys = set(self._nodes)
478
441
        if trailers != 1:
479
442
            # there must be one line - the empty trailer line.
480
443
            raise errors.BadIndexData(self)
481
444
 
482
 
    def clear_cache(self):
483
 
        """Clear out any cached/memoized values.
484
 
 
485
 
        This can be called at any time, but generally it is used when we have
486
 
        extracted some information, but don't expect to be requesting any more
487
 
        from this index.
488
 
        """
489
 
 
490
445
    def external_references(self, ref_list_num):
491
446
        """Return references that are not present in this index.
492
447
        """
495
450
            raise ValueError('No ref list %d, index has %d ref lists'
496
451
                % (ref_list_num, self.node_ref_lists))
497
452
        refs = set()
498
 
        nodes = self._nodes
499
 
        for key, (value, ref_lists) in nodes.iteritems():
 
453
        for key, (value, ref_lists) in self._nodes.iteritems():
500
454
            ref_list = ref_lists[ref_list_num]
501
 
            refs.update([ref for ref in ref_list if ref not in nodes])
502
 
        return refs
 
455
            refs.update(ref_list)
 
456
        return refs - self._keys
503
457
 
504
458
    def _get_nodes_by_key(self):
505
459
        if self._nodes_by_key is None:
632
586
 
633
587
    def _iter_entries_from_total_buffer(self, keys):
634
588
        """Iterate over keys when the entire index is parsed."""
635
 
        # Note: See the note in BTreeBuilder.iter_entries for why we don't use
636
 
        #       .intersection() here
637
 
        nodes = self._nodes
638
 
        keys = [key for key in keys if key in nodes]
 
589
        keys = keys.intersection(self._keys)
639
590
        if self.node_ref_lists:
640
591
            for key in keys:
641
 
                value, node_refs = nodes[key]
 
592
                value, node_refs = self._nodes[key]
642
593
                yield self, key, value, node_refs
643
594
        else:
644
595
            for key in keys:
645
 
                yield self, key, nodes[key]
 
596
                yield self, key, self._nodes[key]
646
597
 
647
598
    def iter_entries(self, keys):
648
599
        """Iterate over keys within the index.
751
702
                # the last thing looked up was a terminal element
752
703
                yield (self, ) + key_dict
753
704
 
754
 
    def _find_ancestors(self, keys, ref_list_num, parent_map, missing_keys):
755
 
        """See BTreeIndex._find_ancestors."""
756
 
        # The api can be implemented as a trivial overlay on top of
757
 
        # iter_entries, it is not an efficient implementation, but it at least
758
 
        # gets the job done.
759
 
        found_keys = set()
760
 
        search_keys = set()
761
 
        for index, key, value, refs in self.iter_entries(keys):
762
 
            parent_keys = refs[ref_list_num]
763
 
            found_keys.add(key)
764
 
            parent_map[key] = parent_keys
765
 
            search_keys.update(parent_keys)
766
 
        # Figure out what, if anything, was missing
767
 
        missing_keys.update(set(keys).difference(found_keys))
768
 
        search_keys = search_keys.difference(parent_map)
769
 
        return search_keys
770
 
 
771
705
    def key_count(self):
772
706
        """Return an estimate of the number of keys in this index.
773
707
 
1185
1119
            self._parsed_key_map.insert(index + 1, new_key)
1186
1120
 
1187
1121
    def _read_and_parse(self, readv_ranges):
1188
 
        """Read the ranges and parse the resulting data.
 
1122
        """Read the the ranges and parse the resulting data.
1189
1123
 
1190
1124
        :param readv_ranges: A prepared readv range list.
1191
1125
        """
1197
1131
            self._buffer_all()
1198
1132
            return
1199
1133
 
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]
1205
1134
        readv_data = self._transport.readv(self._name, readv_ranges, True,
1206
 
            self._size + self._base_offset)
 
1135
            self._size)
1207
1136
        # parse
1208
1137
        for offset, data in readv_data:
1209
 
            offset -= base_offset
1210
1138
            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
1216
1139
            if offset == 0 and len(data) == self._size:
1217
1140
                # We read the whole range, most likely because the
1218
1141
                # Transport upcast our readv ranges into one long request
1245
1168
    static data.
1246
1169
 
1247
1170
    Queries against the combined index will be made against the first index,
1248
 
    and then the second and so on. The order of indices can thus influence
 
1171
    and then the second and so on. The order of index's can thus influence
1249
1172
    performance significantly. For example, if one index is on local disk and a
1250
1173
    second on a remote server, the local disk index should be before the other
1251
1174
    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).
1257
1175
    """
1258
1176
 
1259
1177
    def __init__(self, indices, reload_func=None):
1266
1184
        """
1267
1185
        self._indices = indices
1268
1186
        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)
1276
1187
 
1277
1188
    def __repr__(self):
1278
1189
        return "%s(%s)" % (
1279
1190
                self.__class__.__name__,
1280
1191
                ', '.join(map(repr, self._indices)))
1281
1192
 
1282
 
    def clear_cache(self):
1283
 
        """See GraphIndex.clear_cache()"""
1284
 
        for index in self._indices:
1285
 
            index.clear_cache()
1286
 
 
1287
1193
    def get_parent_map(self, keys):
1288
1194
        """See graph.StackedParentsProvider.get_parent_map"""
1289
1195
        search_keys = set(keys)
1301
1207
 
1302
1208
    has_key = _has_key_from_parent_map
1303
1209
 
1304
 
    def insert_index(self, pos, index, name=None):
 
1210
    def insert_index(self, pos, index):
1305
1211
        """Insert a new index in the list of indices to query.
1306
1212
 
1307
1213
        :param pos: The position to insert the index.
1308
1214
        :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)
1312
1215
        """
1313
1216
        self._indices.insert(pos, index)
1314
 
        self._index_names.insert(pos, name)
1315
1217
 
1316
1218
    def iter_all_entries(self):
1317
1219
        """Iterate over all keys within the index
1342
1244
        value and are only reported once.
1343
1245
 
1344
1246
        :param keys: An iterable providing the keys to be retrieved.
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
 
1247
        :return: An iterable of (index, key, reference_lists, value). There is no
 
1248
            defined order for the result iteration - it will be in the most
1347
1249
            efficient order for the index.
1348
1250
        """
1349
1251
        keys = set(keys)
1350
 
        hit_indices = []
1351
1252
        while True:
1352
1253
            try:
1353
1254
                for index in self._indices:
1354
1255
                    if not keys:
1355
 
                        break
1356
 
                    index_hit = False
 
1256
                        return
1357
1257
                    for node in index.iter_entries(keys):
1358
1258
                        keys.remove(node[1])
1359
1259
                        yield node
1360
 
                        index_hit = True
1361
 
                    if index_hit:
1362
 
                        hit_indices.append(index)
1363
 
                break
 
1260
                return
1364
1261
            except errors.NoSuchFile:
1365
1262
                self._reload_or_raise()
1366
 
        self._move_to_front(hit_indices)
1367
1263
 
1368
1264
    def iter_entries_prefix(self, keys):
1369
1265
        """Iterate over keys within the index using prefix matching.
1389
1285
        if not keys:
1390
1286
            return
1391
1287
        seen_keys = set()
1392
 
        hit_indices = []
1393
1288
        while True:
1394
1289
            try:
1395
1290
                for index in self._indices:
1396
 
                    index_hit = False
1397
1291
                    for node in index.iter_entries_prefix(keys):
1398
1292
                        if node[1] in seen_keys:
1399
1293
                            continue
1400
1294
                        seen_keys.add(node[1])
1401
1295
                        yield node
1402
 
                        index_hit = True
1403
 
                    if index_hit:
1404
 
                        hit_indices.append(index)
1405
 
                break
 
1296
                return
1406
1297
            except errors.NoSuchFile:
1407
1298
                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_names = []
1439
 
        unhit_names = []
1440
 
        new_hit_indices = []
1441
 
        unhit_indices = []
1442
 
 
1443
 
        for offset, (name, idx) in enumerate(indices_info):
1444
 
            if idx in hit_indices:
1445
 
                hit_names.append(name)
1446
 
                new_hit_indices.append(idx)
1447
 
                if len(new_hit_indices) == len(hit_indices):
1448
 
                    # We've found all of the hit entries, everything else is
1449
 
                    # unhit
1450
 
                    unhit_names.extend(self._index_names[offset+1:])
1451
 
                    unhit_indices.extend(self._indices[offset+1:])
1452
 
                    break
1453
 
            else:
1454
 
                unhit_names.append(name)
1455
 
                unhit_indices.append(idx)
1456
 
 
1457
 
        self._indices = new_hit_indices + unhit_indices
1458
 
        self._index_names = hit_names + unhit_names
1459
 
        if 'index' in debug.debug_flags:
1460
 
            mutter('CombinedGraphIndex reordered: %r', self._indices)
1461
 
        return hit_names
1462
 
 
1463
 
    def _move_to_front_by_name(self, hit_names):
1464
 
        """Moves indices named by 'hit_names' to front of the search order, as
1465
 
        described in _move_to_front.
1466
 
        """
1467
 
        # Translate names to index instances, and then call
1468
 
        # _move_to_front_by_index.
1469
 
        indices_info = zip(self._index_names, self._indices)
1470
 
        hit_indices = []
1471
 
        for name, idx in indices_info:
1472
 
            if name in hit_names:
1473
 
                hit_indices.append(idx)
1474
 
        self._move_to_front_by_index(hit_indices)
1475
 
 
1476
 
    def find_ancestry(self, keys, ref_list_num):
1477
 
        """Find the complete ancestry for the given set of keys.
1478
 
 
1479
 
        Note that this is a whole-ancestry request, so it should be used
1480
 
        sparingly.
1481
 
 
1482
 
        :param keys: An iterable of keys to look for
1483
 
        :param ref_list_num: The reference list which references the parents
1484
 
            we care about.
1485
 
        :return: (parent_map, missing_keys)
1486
 
        """
1487
 
        # XXX: make this call _move_to_front?
1488
 
        missing_keys = set()
1489
 
        parent_map = {}
1490
 
        keys_to_lookup = set(keys)
1491
 
        generation = 0
1492
 
        while keys_to_lookup:
1493
 
            # keys that *all* indexes claim are missing, stop searching them
1494
 
            generation += 1
1495
 
            all_index_missing = None
1496
 
            # print 'gen\tidx\tsub\tn_keys\tn_pmap\tn_miss'
1497
 
            # print '%4d\t\t\t%4d\t%5d\t%5d' % (generation, len(keys_to_lookup),
1498
 
            #                                   len(parent_map),
1499
 
            #                                   len(missing_keys))
1500
 
            for index_idx, index in enumerate(self._indices):
1501
 
                # TODO: we should probably be doing something with
1502
 
                #       'missing_keys' since we've already determined that
1503
 
                #       those revisions have not been found anywhere
1504
 
                index_missing_keys = set()
1505
 
                # Find all of the ancestry we can from this index
1506
 
                # keep looking until the search_keys set is empty, which means
1507
 
                # things we didn't find should be in index_missing_keys
1508
 
                search_keys = keys_to_lookup
1509
 
                sub_generation = 0
1510
 
                # print '    \t%2d\t\t%4d\t%5d\t%5d' % (
1511
 
                #     index_idx, len(search_keys),
1512
 
                #     len(parent_map), len(index_missing_keys))
1513
 
                while search_keys:
1514
 
                    sub_generation += 1
1515
 
                    # TODO: ref_list_num should really be a parameter, since
1516
 
                    #       CombinedGraphIndex does not know what the ref lists
1517
 
                    #       mean.
1518
 
                    search_keys = index._find_ancestors(search_keys,
1519
 
                        ref_list_num, parent_map, index_missing_keys)
1520
 
                    # print '    \t  \t%2d\t%4d\t%5d\t%5d' % (
1521
 
                    #     sub_generation, len(search_keys),
1522
 
                    #     len(parent_map), len(index_missing_keys))
1523
 
                # Now set whatever was missing to be searched in the next index
1524
 
                keys_to_lookup = index_missing_keys
1525
 
                if all_index_missing is None:
1526
 
                    all_index_missing = set(index_missing_keys)
1527
 
                else:
1528
 
                    all_index_missing.intersection_update(index_missing_keys)
1529
 
                if not keys_to_lookup:
1530
 
                    break
1531
 
            if all_index_missing is None:
1532
 
                # There were no indexes, so all search keys are 'missing'
1533
 
                missing_keys.update(keys_to_lookup)
1534
 
                keys_to_lookup = None
1535
 
            else:
1536
 
                missing_keys.update(all_index_missing)
1537
 
                keys_to_lookup.difference_update(all_index_missing)
1538
 
        return parent_map, missing_keys
1539
1299
 
1540
1300
    def key_count(self):
1541
1301
        """Return an estimate of the number of keys in this index.
1570
1330
                         ' Raising original exception.')
1571
1331
            raise exc_type, exc_value, exc_traceback
1572
1332
 
1573
 
    def set_sibling_indices(self, sibling_combined_graph_indices):
1574
 
        """Set the CombinedGraphIndex objects to reorder after reordering self.
1575
 
        """
1576
 
        self._sibling_indices = sibling_combined_graph_indices
1577
 
 
1578
1333
    def validate(self):
1579
1334
        """Validate that everything in the index can be accessed."""
1580
1335
        while True:
1633
1388
            defined order for the result iteration - it will be in the most
1634
1389
            efficient order for the index (keys iteration order in this case).
1635
1390
        """
1636
 
        # Note: See BTreeBuilder.iter_entries for an explanation of why we
1637
 
        #       aren't using set().intersection() here
1638
 
        nodes = self._nodes
1639
 
        keys = [key for key in keys if key in nodes]
 
1391
        keys = set(keys)
1640
1392
        if self.reference_lists:
1641
 
            for key in keys:
1642
 
                node = nodes[key]
 
1393
            for key in keys.intersection(self._keys):
 
1394
                node = self._nodes[key]
1643
1395
                if not node[0]:
1644
1396
                    yield self, key, node[2], node[1]
1645
1397
        else:
1646
 
            for key in keys:
1647
 
                node = nodes[key]
 
1398
            for key in keys.intersection(self._keys):
 
1399
                node = self._nodes[key]
1648
1400
                if not node[0]:
1649
1401
                    yield self, key, node[2]
1650
1402
 
1724
1476
 
1725
1477
        For InMemoryGraphIndex the estimate is exact.
1726
1478
        """
1727
 
        return len(self._nodes) - len(self._absent_keys)
 
1479
        return len(self._keys)
1728
1480
 
1729
1481
    def validate(self):
1730
1482
        """In memory index's have no known corruption at the moment."""