~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/index.py

  • Committer: Matt Nordhoff
  • Date: 2009-10-22 08:28:04 UTC
  • mto: (4797.2.18 2.1)
  • mto: This revision was merged to the branch mainline in revision 5045.
  • Revision ID: mnordhoff@mattnordhoff.com-20091022082804-outyhrw2y14fxt4x
Make StaticTuple_New always raise a ValueError, and StaticTuple_new_constructor always raise a TypeError.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2007-2010 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
93
93
        :param key_elements: The number of bytestrings in each key.
94
94
        """
95
95
        self.reference_lists = reference_lists
 
96
        self._keys = set()
96
97
        # A dict of {key: (absent, ref_lists, value)}
97
98
        self._nodes = {}
98
 
        # Keys that are referenced but not actually present in this index
99
 
        self._absent_keys = set()
100
99
        self._nodes_by_key = None
101
100
        self._key_length = key_elements
102
101
        self._optimize_for_size = False
166
165
            return
167
166
        key_dict = self._nodes_by_key
168
167
        if self.reference_lists:
169
 
            key_value = StaticTuple(key, value, node_refs)
 
168
            key_value = key, value, node_refs
170
169
        else:
171
 
            key_value = StaticTuple(key, value)
 
170
            key_value = key, value
172
171
        for subkey in key[:-1]:
173
172
            key_dict = key_dict.setdefault(subkey, {})
174
173
        key_dict[key[-1]] = key_value
190
189
                                This may contain duplicates if the same key is
191
190
                                referenced in multiple lists.
192
191
        """
193
 
        as_st = StaticTuple.from_sequence
194
192
        self._check_key(key)
195
193
        if _newline_null_re.search(value) is not None:
196
194
            raise errors.BadIndexValue(value)
205
203
                if reference not in self._nodes:
206
204
                    self._check_key(reference)
207
205
                    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
 
206
            # TODO: StaticTuple
 
207
            node_refs.append(tuple(reference_list))
 
208
        # TODO: StaticTuple
 
209
        return tuple(node_refs), absent_references
212
210
 
213
211
    def add_node(self, key, value, references=()):
214
212
        """Add a node to the index.
229
227
            # There may be duplicates, but I don't think it is worth worrying
230
228
            # about
231
229
            self._nodes[reference] = ('a', (), '')
232
 
        self._absent_keys.update(absent_references)
233
 
        self._absent_keys.discard(key)
234
230
        self._nodes[key] = ('', node_refs, value)
 
231
        self._keys.add(key)
235
232
        if self._nodes_by_key is not None and self._key_length > 1:
236
233
            self._update_nodes_by_key(key, value, node_refs)
237
234
 
246
243
        lines = [_SIGNATURE]
247
244
        lines.append(_OPTION_NODE_REFS + str(self.reference_lists) + '\n')
248
245
        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')
 
246
        lines.append(_OPTION_LEN + str(len(self._keys)) + '\n')
251
247
        prefix_length = sum(len(x) for x in lines)
252
248
        # references are byte offsets. To avoid having to do nasty
253
249
        # polynomial work to resolve offsets (references to later in the
382
378
    suitable for production use. :XXX
383
379
    """
384
380
 
385
 
    def __init__(self, transport, name, size, unlimited_cache=False, offset=0):
 
381
    def __init__(self, transport, name, size, unlimited_cache=False):
386
382
        """Open an index called name on transport.
387
383
 
388
384
        :param transport: A bzrlib.transport.Transport.
394
390
            avoided by having it supplied. If size is None, then bisection
395
391
            support will be disabled and accessing the index will just stream
396
392
            all the data.
397
 
        :param offset: Instead of starting the index data at offset 0, start it
398
 
            at an arbitrary offset.
399
393
        """
400
394
        self._transport = transport
401
395
        self._name = name
418
412
        self._size = size
419
413
        # The number of bytes we've read so far in trying to process this file
420
414
        self._bytes_read = 0
421
 
        self._base_offset = offset
422
415
 
423
416
    def __eq__(self, other):
424
417
        """Equal when self and other were created with the same parameters."""
447
440
            mutter('Reading entire index %s', self._transport.abspath(self._name))
448
441
        if stream is None:
449
442
            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
443
        self._read_prefix(stream)
455
444
        self._expected_elements = 3 + self._key_length
456
445
        line_count = 0
462
451
        trailers = 0
463
452
        pos = stream.tell()
464
453
        lines = stream.read().split('\n')
465
 
        # GZ 2009-09-20: Should really use a try/finally block to ensure close
466
 
        stream.close()
467
454
        del lines[-1]
468
455
        _, _, _, trailers = self._parse_lines(lines, pos)
469
456
        for key, absent, references, value in self._keys_by_offset.itervalues():
476
463
                node_value = value
477
464
            self._nodes[key] = node_value
478
465
        # cache the keys for quick set intersections
 
466
        self._keys = set(self._nodes)
479
467
        if trailers != 1:
480
468
            # there must be one line - the empty trailer line.
481
469
            raise errors.BadIndexData(self)
496
484
            raise ValueError('No ref list %d, index has %d ref lists'
497
485
                % (ref_list_num, self.node_ref_lists))
498
486
        refs = set()
499
 
        nodes = self._nodes
500
 
        for key, (value, ref_lists) in nodes.iteritems():
 
487
        for key, (value, ref_lists) in self._nodes.iteritems():
501
488
            ref_list = ref_lists[ref_list_num]
502
 
            refs.update([ref for ref in ref_list if ref not in nodes])
503
 
        return refs
 
489
            refs.update(ref_list)
 
490
        return refs - self._keys
504
491
 
505
492
    def _get_nodes_by_key(self):
506
493
        if self._nodes_by_key is None:
633
620
 
634
621
    def _iter_entries_from_total_buffer(self, keys):
635
622
        """Iterate over keys when the entire index is parsed."""
636
 
        # Note: See the note in BTreeBuilder.iter_entries for why we don't use
637
 
        #       .intersection() here
638
 
        nodes = self._nodes
639
 
        keys = [key for key in keys if key in nodes]
 
623
        keys = keys.intersection(self._keys)
640
624
        if self.node_ref_lists:
641
625
            for key in keys:
642
 
                value, node_refs = nodes[key]
 
626
                value, node_refs = self._nodes[key]
643
627
                yield self, key, value, node_refs
644
628
        else:
645
629
            for key in keys:
646
 
                yield self, key, nodes[key]
 
630
                yield self, key, self._nodes[key]
647
631
 
648
632
    def iter_entries(self, keys):
649
633
        """Iterate over keys within the index.
1186
1170
            self._parsed_key_map.insert(index + 1, new_key)
1187
1171
 
1188
1172
    def _read_and_parse(self, readv_ranges):
1189
 
        """Read the ranges and parse the resulting data.
 
1173
        """Read the the ranges and parse the resulting data.
1190
1174
 
1191
1175
        :param readv_ranges: A prepared readv range list.
1192
1176
        """
1198
1182
            self._buffer_all()
1199
1183
            return
1200
1184
 
1201
 
        base_offset = self._base_offset
1202
 
        if base_offset != 0:
1203
 
            # Rewrite the ranges for the offset
1204
 
            readv_ranges = [(start+base_offset, size)
1205
 
                            for start, size in readv_ranges]
1206
1185
        readv_data = self._transport.readv(self._name, readv_ranges, True,
1207
 
            self._size + self._base_offset)
 
1186
            self._size)
1208
1187
        # parse
1209
1188
        for offset, data in readv_data:
1210
 
            offset -= base_offset
1211
1189
            self._bytes_read += len(data)
1212
 
            if offset < 0:
1213
 
                # transport.readv() expanded to extra data which isn't part of
1214
 
                # this index
1215
 
                data = data[-offset:]
1216
 
                offset = 0
1217
1190
            if offset == 0 and len(data) == self._size:
1218
1191
                # We read the whole range, most likely because the
1219
1192
                # Transport upcast our readv ranges into one long request
1246
1219
    static data.
1247
1220
 
1248
1221
    Queries against the combined index will be made against the first index,
1249
 
    and then the second and so on. The order of indices can thus influence
 
1222
    and then the second and so on. The order of index's can thus influence
1250
1223
    performance significantly. For example, if one index is on local disk and a
1251
1224
    second on a remote server, the local disk index should be before the other
1252
1225
    in the index list.
1253
 
    
1254
 
    Also, queries tend to need results from the same indices as previous
1255
 
    queries.  So the indices will be reordered after every query to put the
1256
 
    indices that had the result(s) of that query first (while otherwise
1257
 
    preserving the relative ordering).
1258
1226
    """
1259
1227
 
1260
1228
    def __init__(self, indices, reload_func=None):
1267
1235
        """
1268
1236
        self._indices = indices
1269
1237
        self._reload_func = reload_func
1270
 
        # Sibling indices are other CombinedGraphIndex that we should call
1271
 
        # _move_to_front_by_name on when we auto-reorder ourself.
1272
 
        self._sibling_indices = []
1273
 
        # A list of names that corresponds to the instances in self._indices,
1274
 
        # so _index_names[0] is always the name for _indices[0], etc.  Sibling
1275
 
        # indices must all use the same set of names as each other.
1276
 
        self._index_names = [None] * len(self._indices)
1277
1238
 
1278
1239
    def __repr__(self):
1279
1240
        return "%s(%s)" % (
1302
1263
 
1303
1264
    has_key = _has_key_from_parent_map
1304
1265
 
1305
 
    def insert_index(self, pos, index, name=None):
 
1266
    def insert_index(self, pos, index):
1306
1267
        """Insert a new index in the list of indices to query.
1307
1268
 
1308
1269
        :param pos: The position to insert the index.
1309
1270
        :param index: The index to insert.
1310
 
        :param name: a name for this index, e.g. a pack name.  These names can
1311
 
            be used to reflect index reorderings to related CombinedGraphIndex
1312
 
            instances that use the same names.  (see set_sibling_indices)
1313
1271
        """
1314
1272
        self._indices.insert(pos, index)
1315
 
        self._index_names.insert(pos, name)
1316
1273
 
1317
1274
    def iter_all_entries(self):
1318
1275
        """Iterate over all keys within the index
1343
1300
        value and are only reported once.
1344
1301
 
1345
1302
        :param keys: An iterable providing the keys to be retrieved.
1346
 
        :return: An iterable of (index, key, reference_lists, value). There is
1347
 
            no defined order for the result iteration - it will be in the most
 
1303
        :return: An iterable of (index, key, reference_lists, value). There is no
 
1304
            defined order for the result iteration - it will be in the most
1348
1305
            efficient order for the index.
1349
1306
        """
1350
1307
        keys = set(keys)
1351
 
        hit_indices = []
1352
1308
        while True:
1353
1309
            try:
1354
1310
                for index in self._indices:
1355
1311
                    if not keys:
1356
 
                        break
1357
 
                    index_hit = False
 
1312
                        return
1358
1313
                    for node in index.iter_entries(keys):
1359
1314
                        keys.remove(node[1])
1360
1315
                        yield node
1361
 
                        index_hit = True
1362
 
                    if index_hit:
1363
 
                        hit_indices.append(index)
1364
 
                break
 
1316
                return
1365
1317
            except errors.NoSuchFile:
1366
1318
                self._reload_or_raise()
1367
 
        self._move_to_front(hit_indices)
1368
1319
 
1369
1320
    def iter_entries_prefix(self, keys):
1370
1321
        """Iterate over keys within the index using prefix matching.
1390
1341
        if not keys:
1391
1342
            return
1392
1343
        seen_keys = set()
1393
 
        hit_indices = []
1394
1344
        while True:
1395
1345
            try:
1396
1346
                for index in self._indices:
1397
 
                    index_hit = False
1398
1347
                    for node in index.iter_entries_prefix(keys):
1399
1348
                        if node[1] in seen_keys:
1400
1349
                            continue
1401
1350
                        seen_keys.add(node[1])
1402
1351
                        yield node
1403
 
                        index_hit = True
1404
 
                    if index_hit:
1405
 
                        hit_indices.append(index)
1406
 
                break
 
1352
                return
1407
1353
            except errors.NoSuchFile:
1408
1354
                self._reload_or_raise()
1409
 
        self._move_to_front(hit_indices)
1410
 
 
1411
 
    def _move_to_front(self, hit_indices):
1412
 
        """Rearrange self._indices so that hit_indices are first.
1413
 
 
1414
 
        Order is maintained as much as possible, e.g. the first unhit index
1415
 
        will be the first index in _indices after the hit_indices, and the
1416
 
        hit_indices will be present in exactly the order they are passed to
1417
 
        _move_to_front.
1418
 
 
1419
 
        _move_to_front propagates to all objects in self._sibling_indices by
1420
 
        calling _move_to_front_by_name.
1421
 
        """
1422
 
        if self._indices[:len(hit_indices)] == hit_indices:
1423
 
            # The 'hit_indices' are already at the front (and in the same
1424
 
            # order), no need to re-order
1425
 
            return
1426
 
        hit_names = self._move_to_front_by_index(hit_indices)
1427
 
        for sibling_idx in self._sibling_indices:
1428
 
            sibling_idx._move_to_front_by_name(hit_names)
1429
 
 
1430
 
    def _move_to_front_by_index(self, hit_indices):
1431
 
        """Core logic for _move_to_front.
1432
 
        
1433
 
        Returns a list of names corresponding to the hit_indices param.
1434
 
        """
1435
 
        indices_info = zip(self._index_names, self._indices)
1436
 
        if 'index' in debug.debug_flags:
1437
 
            mutter('CombinedGraphIndex reordering: currently %r, promoting %r',
1438
 
                   indices_info, hit_indices)
1439
 
        hit_names = []
1440
 
        unhit_names = []
1441
 
        new_hit_indices = []
1442
 
        unhit_indices = []
1443
 
 
1444
 
        for offset, (name, idx) in enumerate(indices_info):
1445
 
            if idx in hit_indices:
1446
 
                hit_names.append(name)
1447
 
                new_hit_indices.append(idx)
1448
 
                if len(new_hit_indices) == len(hit_indices):
1449
 
                    # We've found all of the hit entries, everything else is
1450
 
                    # unhit
1451
 
                    unhit_names.extend(self._index_names[offset+1:])
1452
 
                    unhit_indices.extend(self._indices[offset+1:])
1453
 
                    break
1454
 
            else:
1455
 
                unhit_names.append(name)
1456
 
                unhit_indices.append(idx)
1457
 
 
1458
 
        self._indices = new_hit_indices + unhit_indices
1459
 
        self._index_names = hit_names + unhit_names
1460
 
        if 'index' in debug.debug_flags:
1461
 
            mutter('CombinedGraphIndex reordered: %r', self._indices)
1462
 
        return hit_names
1463
 
 
1464
 
    def _move_to_front_by_name(self, hit_names):
1465
 
        """Moves indices named by 'hit_names' to front of the search order, as
1466
 
        described in _move_to_front.
1467
 
        """
1468
 
        # Translate names to index instances, and then call
1469
 
        # _move_to_front_by_index.
1470
 
        indices_info = zip(self._index_names, self._indices)
1471
 
        hit_indices = []
1472
 
        for name, idx in indices_info:
1473
 
            if name in hit_names:
1474
 
                hit_indices.append(idx)
1475
 
        self._move_to_front_by_index(hit_indices)
1476
1355
 
1477
1356
    def find_ancestry(self, keys, ref_list_num):
1478
1357
        """Find the complete ancestry for the given set of keys.
1485
1364
            we care about.
1486
1365
        :return: (parent_map, missing_keys)
1487
1366
        """
1488
 
        # XXX: make this call _move_to_front?
1489
1367
        missing_keys = set()
1490
1368
        parent_map = {}
1491
1369
        keys_to_lookup = set(keys)
1571
1449
                         ' Raising original exception.')
1572
1450
            raise exc_type, exc_value, exc_traceback
1573
1451
 
1574
 
    def set_sibling_indices(self, sibling_combined_graph_indices):
1575
 
        """Set the CombinedGraphIndex objects to reorder after reordering self.
1576
 
        """
1577
 
        self._sibling_indices = sibling_combined_graph_indices
1578
 
 
1579
1452
    def validate(self):
1580
1453
        """Validate that everything in the index can be accessed."""
1581
1454
        while True:
1634
1507
            defined order for the result iteration - it will be in the most
1635
1508
            efficient order for the index (keys iteration order in this case).
1636
1509
        """
1637
 
        # Note: See BTreeBuilder.iter_entries for an explanation of why we
1638
 
        #       aren't using set().intersection() here
1639
 
        nodes = self._nodes
1640
 
        keys = [key for key in keys if key in nodes]
 
1510
        keys = set(keys)
1641
1511
        if self.reference_lists:
1642
 
            for key in keys:
1643
 
                node = nodes[key]
 
1512
            for key in keys.intersection(self._keys):
 
1513
                node = self._nodes[key]
1644
1514
                if not node[0]:
1645
1515
                    yield self, key, node[2], node[1]
1646
1516
        else:
1647
 
            for key in keys:
1648
 
                node = nodes[key]
 
1517
            for key in keys.intersection(self._keys):
 
1518
                node = self._nodes[key]
1649
1519
                if not node[0]:
1650
1520
                    yield self, key, node[2]
1651
1521
 
1725
1595
 
1726
1596
        For InMemoryGraphIndex the estimate is exact.
1727
1597
        """
1728
 
        return len(self._nodes) - len(self._absent_keys)
 
1598
        return len(self._keys)
1729
1599
 
1730
1600
    def validate(self):
1731
1601
        """In memory index's have no known corruption at the moment."""