/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/index.py

  • Committer: Martin
  • Date: 2009-09-20 22:12:36 UTC
  • mto: This revision was merged to the branch mainline in revision 5257.
  • Revision ID: gzlist@googlemail.com-20090920221236-84nyjpop0ttgfwzj
Ensure all files opened by bazaar proper are explicitly closed

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
382
368
    suitable for production use. :XXX
383
369
    """
384
370
 
385
 
    def __init__(self, transport, name, size, unlimited_cache=False, offset=0):
 
371
    def __init__(self, transport, name, size):
386
372
        """Open an index called name on transport.
387
373
 
388
374
        :param transport: A bzrlib.transport.Transport.
394
380
            avoided by having it supplied. If size is None, then bisection
395
381
            support will be disabled and accessing the index will just stream
396
382
            all the data.
397
 
        :param offset: Instead of starting the index data at offset 0, start it
398
 
            at an arbitrary offset.
399
383
        """
400
384
        self._transport = transport
401
385
        self._name = name
418
402
        self._size = size
419
403
        # The number of bytes we've read so far in trying to process this file
420
404
        self._bytes_read = 0
421
 
        self._base_offset = offset
422
405
 
423
406
    def __eq__(self, other):
424
407
        """Equal when self and other were created with the same parameters."""
447
430
            mutter('Reading entire index %s', self._transport.abspath(self._name))
448
431
        if stream is None:
449
432
            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
433
        self._read_prefix(stream)
455
434
        self._expected_elements = 3 + self._key_length
456
435
        line_count = 0
462
441
        trailers = 0
463
442
        pos = stream.tell()
464
443
        lines = stream.read().split('\n')
 
444
        # GZ 2009-09-20: Should really use a try/finally block to ensure close
465
445
        stream.close()
466
446
        del lines[-1]
467
447
        _, _, _, trailers = self._parse_lines(lines, pos)
475
455
                node_value = value
476
456
            self._nodes[key] = node_value
477
457
        # cache the keys for quick set intersections
 
458
        self._keys = set(self._nodes)
478
459
        if trailers != 1:
479
460
            # there must be one line - the empty trailer line.
480
461
            raise errors.BadIndexData(self)
481
462
 
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
463
    def external_references(self, ref_list_num):
491
464
        """Return references that are not present in this index.
492
465
        """
495
468
            raise ValueError('No ref list %d, index has %d ref lists'
496
469
                % (ref_list_num, self.node_ref_lists))
497
470
        refs = set()
498
 
        nodes = self._nodes
499
 
        for key, (value, ref_lists) in nodes.iteritems():
 
471
        for key, (value, ref_lists) in self._nodes.iteritems():
500
472
            ref_list = ref_lists[ref_list_num]
501
 
            refs.update([ref for ref in ref_list if ref not in nodes])
502
 
        return refs
 
473
            refs.update(ref_list)
 
474
        return refs - self._keys
503
475
 
504
476
    def _get_nodes_by_key(self):
505
477
        if self._nodes_by_key is None:
632
604
 
633
605
    def _iter_entries_from_total_buffer(self, keys):
634
606
        """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]
 
607
        keys = keys.intersection(self._keys)
639
608
        if self.node_ref_lists:
640
609
            for key in keys:
641
 
                value, node_refs = nodes[key]
 
610
                value, node_refs = self._nodes[key]
642
611
                yield self, key, value, node_refs
643
612
        else:
644
613
            for key in keys:
645
 
                yield self, key, nodes[key]
 
614
                yield self, key, self._nodes[key]
646
615
 
647
616
    def iter_entries(self, keys):
648
617
        """Iterate over keys within the index.
1185
1154
            self._parsed_key_map.insert(index + 1, new_key)
1186
1155
 
1187
1156
    def _read_and_parse(self, readv_ranges):
1188
 
        """Read the ranges and parse the resulting data.
 
1157
        """Read the the ranges and parse the resulting data.
1189
1158
 
1190
1159
        :param readv_ranges: A prepared readv range list.
1191
1160
        """
1197
1166
            self._buffer_all()
1198
1167
            return
1199
1168
 
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
1169
        readv_data = self._transport.readv(self._name, readv_ranges, True,
1206
 
            self._size + self._base_offset)
 
1170
            self._size)
1207
1171
        # parse
1208
1172
        for offset, data in readv_data:
1209
 
            offset -= base_offset
1210
1173
            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
1174
            if offset == 0 and len(data) == self._size:
1217
1175
                # We read the whole range, most likely because the
1218
1176
                # Transport upcast our readv ranges into one long request
1245
1203
    static data.
1246
1204
 
1247
1205
    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
 
1206
    and then the second and so on. The order of index's can thus influence
1249
1207
    performance significantly. For example, if one index is on local disk and a
1250
1208
    second on a remote server, the local disk index should be before the other
1251
1209
    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
1210
    """
1258
1211
 
1259
1212
    def __init__(self, indices, reload_func=None):
1266
1219
        """
1267
1220
        self._indices = indices
1268
1221
        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
1222
 
1277
1223
    def __repr__(self):
1278
1224
        return "%s(%s)" % (
1279
1225
                self.__class__.__name__,
1280
1226
                ', '.join(map(repr, self._indices)))
1281
1227
 
1282
 
    def clear_cache(self):
1283
 
        """See GraphIndex.clear_cache()"""
1284
 
        for index in self._indices:
1285
 
            index.clear_cache()
1286
 
 
1287
1228
    def get_parent_map(self, keys):
1288
1229
        """See graph.StackedParentsProvider.get_parent_map"""
1289
1230
        search_keys = set(keys)
1301
1242
 
1302
1243
    has_key = _has_key_from_parent_map
1303
1244
 
1304
 
    def insert_index(self, pos, index, name=None):
 
1245
    def insert_index(self, pos, index):
1305
1246
        """Insert a new index in the list of indices to query.
1306
1247
 
1307
1248
        :param pos: The position to insert the index.
1308
1249
        :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
1250
        """
1313
1251
        self._indices.insert(pos, index)
1314
 
        self._index_names.insert(pos, name)
1315
1252
 
1316
1253
    def iter_all_entries(self):
1317
1254
        """Iterate over all keys within the index
1342
1279
        value and are only reported once.
1343
1280
 
1344
1281
        :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
 
1282
        :return: An iterable of (index, key, reference_lists, value). There is no
 
1283
            defined order for the result iteration - it will be in the most
1347
1284
            efficient order for the index.
1348
1285
        """
1349
1286
        keys = set(keys)
1350
 
        hit_indices = []
1351
1287
        while True:
1352
1288
            try:
1353
1289
                for index in self._indices:
1354
1290
                    if not keys:
1355
 
                        break
1356
 
                    index_hit = False
 
1291
                        return
1357
1292
                    for node in index.iter_entries(keys):
1358
1293
                        keys.remove(node[1])
1359
1294
                        yield node
1360
 
                        index_hit = True
1361
 
                    if index_hit:
1362
 
                        hit_indices.append(index)
1363
 
                break
 
1295
                return
1364
1296
            except errors.NoSuchFile:
1365
1297
                self._reload_or_raise()
1366
 
        self._move_to_front(hit_indices)
1367
1298
 
1368
1299
    def iter_entries_prefix(self, keys):
1369
1300
        """Iterate over keys within the index using prefix matching.
1389
1320
        if not keys:
1390
1321
            return
1391
1322
        seen_keys = set()
1392
 
        hit_indices = []
1393
1323
        while True:
1394
1324
            try:
1395
1325
                for index in self._indices:
1396
 
                    index_hit = False
1397
1326
                    for node in index.iter_entries_prefix(keys):
1398
1327
                        if node[1] in seen_keys:
1399
1328
                            continue
1400
1329
                        seen_keys.add(node[1])
1401
1330
                        yield node
1402
 
                        index_hit = True
1403
 
                    if index_hit:
1404
 
                        hit_indices.append(index)
1405
 
                break
 
1331
                return
1406
1332
            except errors.NoSuchFile:
1407
1333
                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
1334
 
1476
1335
    def find_ancestry(self, keys, ref_list_num):
1477
1336
        """Find the complete ancestry for the given set of keys.
1484
1343
            we care about.
1485
1344
        :return: (parent_map, missing_keys)
1486
1345
        """
1487
 
        # XXX: make this call _move_to_front?
1488
1346
        missing_keys = set()
1489
1347
        parent_map = {}
1490
1348
        keys_to_lookup = set(keys)
1570
1428
                         ' Raising original exception.')
1571
1429
            raise exc_type, exc_value, exc_traceback
1572
1430
 
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
1431
    def validate(self):
1579
1432
        """Validate that everything in the index can be accessed."""
1580
1433
        while True:
1633
1486
            defined order for the result iteration - it will be in the most
1634
1487
            efficient order for the index (keys iteration order in this case).
1635
1488
        """
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]
 
1489
        keys = set(keys)
1640
1490
        if self.reference_lists:
1641
 
            for key in keys:
1642
 
                node = nodes[key]
 
1491
            for key in keys.intersection(self._keys):
 
1492
                node = self._nodes[key]
1643
1493
                if not node[0]:
1644
1494
                    yield self, key, node[2], node[1]
1645
1495
        else:
1646
 
            for key in keys:
1647
 
                node = nodes[key]
 
1496
            for key in keys.intersection(self._keys):
 
1497
                node = self._nodes[key]
1648
1498
                if not node[0]:
1649
1499
                    yield self, key, node[2]
1650
1500
 
1724
1574
 
1725
1575
        For InMemoryGraphIndex the estimate is exact.
1726
1576
        """
1727
 
        return len(self._nodes) - len(self._absent_keys)
 
1577
        return len(self._keys)
1728
1578
 
1729
1579
    def validate(self):
1730
1580
        """In memory index's have no known corruption at the moment."""