~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repofmt/pack_repo.py

Replace remaining to unittest.TestResult methods with super

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007, 2008 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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
 
17
import re
17
18
import sys
18
19
 
19
20
from bzrlib.lazy_import import lazy_import
22
23
import time
23
24
 
24
25
from bzrlib import (
 
26
    chk_map,
 
27
    cleanup,
25
28
    debug,
26
29
    graph,
27
30
    osutils,
34
37
    )
35
38
from bzrlib.index import (
36
39
    CombinedGraphIndex,
37
 
    GraphIndex,
38
 
    GraphIndexBuilder,
39
40
    GraphIndexPrefixAdapter,
40
 
    InMemoryGraphIndex,
41
41
    )
42
42
from bzrlib.knit import (
43
43
    KnitPlainFactory,
52
52
    errors,
53
53
    lockable_files,
54
54
    lockdir,
55
 
    symbol_versioning,
 
55
    revision as _mod_revision,
56
56
    )
57
57
 
58
 
from bzrlib.decorators import needs_write_lock
 
58
from bzrlib.decorators import needs_write_lock, only_raises
59
59
from bzrlib.btree_index import (
60
60
    BTreeGraphIndex,
61
61
    BTreeBuilder,
64
64
    GraphIndex,
65
65
    InMemoryGraphIndex,
66
66
    )
 
67
from bzrlib.lock import LogicalLockResult
67
68
from bzrlib.repofmt.knitrepo import KnitRepository
68
69
from bzrlib.repository import (
69
70
    CommitBuilder,
70
71
    MetaDirRepositoryFormat,
71
72
    RepositoryFormat,
 
73
    RepositoryWriteLockResult,
72
74
    RootCommitBuilder,
 
75
    StreamSource,
73
76
    )
74
 
import bzrlib.revision as _mod_revision
75
77
from bzrlib.trace import (
76
78
    mutter,
 
79
    note,
77
80
    warning,
78
81
    )
79
82
 
80
83
 
81
84
class PackCommitBuilder(CommitBuilder):
82
85
    """A subclass of CommitBuilder to add texts with pack semantics.
83
 
    
 
86
 
84
87
    Specifically this uses one knit object rather than one knit object per
85
88
    added text, reducing memory and object pressure.
86
89
    """
101
104
 
102
105
class PackRootCommitBuilder(RootCommitBuilder):
103
106
    """A subclass of RootCommitBuilder to add texts with pack semantics.
104
 
    
 
107
 
105
108
    Specifically this uses one knit object rather than one knit object per
106
109
    added text, reducing memory and object pressure.
107
110
    """
127
130
    ExistingPack and NewPack are used.
128
131
    """
129
132
 
 
133
    # A map of index 'type' to the file extension and position in the
 
134
    # index_sizes array.
 
135
    index_definitions = {
 
136
        'chk': ('.cix', 4),
 
137
        'revision': ('.rix', 0),
 
138
        'inventory': ('.iix', 1),
 
139
        'text': ('.tix', 2),
 
140
        'signature': ('.six', 3),
 
141
        }
 
142
 
130
143
    def __init__(self, revision_index, inventory_index, text_index,
131
 
        signature_index):
 
144
        signature_index, chk_index=None):
132
145
        """Create a pack instance.
133
146
 
134
147
        :param revision_index: A GraphIndex for determining what revisions are
141
154
            texts/deltas (via (fileid, revisionid) tuples).
142
155
        :param signature_index: A GraphIndex for determining what signatures are
143
156
            present in the Pack and accessing the locations of their texts.
 
157
        :param chk_index: A GraphIndex for accessing content by CHK, if the
 
158
            pack has one.
144
159
        """
145
160
        self.revision_index = revision_index
146
161
        self.inventory_index = inventory_index
147
162
        self.text_index = text_index
148
163
        self.signature_index = signature_index
 
164
        self.chk_index = chk_index
149
165
 
150
166
    def access_tuple(self):
151
167
        """Return a tuple (transport, name) for the pack content."""
152
168
        return self.pack_transport, self.file_name()
153
169
 
 
170
    def _check_references(self):
 
171
        """Make sure our external references are present.
 
172
 
 
173
        Packs are allowed to have deltas whose base is not in the pack, but it
 
174
        must be present somewhere in this collection.  It is not allowed to
 
175
        have deltas based on a fallback repository.
 
176
        (See <https://bugs.launchpad.net/bzr/+bug/288751>)
 
177
        """
 
178
        missing_items = {}
 
179
        for (index_name, external_refs, index) in [
 
180
            ('texts',
 
181
                self._get_external_refs(self.text_index),
 
182
                self._pack_collection.text_index.combined_index),
 
183
            ('inventories',
 
184
                self._get_external_refs(self.inventory_index),
 
185
                self._pack_collection.inventory_index.combined_index),
 
186
            ]:
 
187
            missing = external_refs.difference(
 
188
                k for (idx, k, v, r) in
 
189
                index.iter_entries(external_refs))
 
190
            if missing:
 
191
                missing_items[index_name] = sorted(list(missing))
 
192
        if missing_items:
 
193
            from pprint import pformat
 
194
            raise errors.BzrCheckError(
 
195
                "Newly created pack file %r has delta references to "
 
196
                "items not in its repository:\n%s"
 
197
                % (self, pformat(missing_items)))
 
198
 
154
199
    def file_name(self):
155
200
        """Get the file name for the pack on disk."""
156
201
        return self.name + '.pack'
158
203
    def get_revision_count(self):
159
204
        return self.revision_index.key_count()
160
205
 
 
206
    def index_name(self, index_type, name):
 
207
        """Get the disk name of an index type for pack name 'name'."""
 
208
        return name + Pack.index_definitions[index_type][0]
 
209
 
 
210
    def index_offset(self, index_type):
 
211
        """Get the position in a index_size array for a given index type."""
 
212
        return Pack.index_definitions[index_type][1]
 
213
 
161
214
    def inventory_index_name(self, name):
162
215
        """The inv index is the name + .iix."""
163
216
        return self.index_name('inventory', name)
174
227
        """The text index is the name + .tix."""
175
228
        return self.index_name('text', name)
176
229
 
 
230
    def _replace_index_with_readonly(self, index_type):
 
231
        unlimited_cache = False
 
232
        if index_type == 'chk':
 
233
            unlimited_cache = True
 
234
        setattr(self, index_type + '_index',
 
235
            self.index_class(self.index_transport,
 
236
                self.index_name(index_type, self.name),
 
237
                self.index_sizes[self.index_offset(index_type)],
 
238
                unlimited_cache=unlimited_cache))
 
239
 
177
240
 
178
241
class ExistingPack(Pack):
179
242
    """An in memory proxy for an existing .pack and its disk indices."""
180
243
 
181
244
    def __init__(self, pack_transport, name, revision_index, inventory_index,
182
 
        text_index, signature_index):
 
245
        text_index, signature_index, chk_index=None):
183
246
        """Create an ExistingPack object.
184
247
 
185
248
        :param pack_transport: The transport where the pack file resides.
186
249
        :param name: The name of the pack on disk in the pack_transport.
187
250
        """
188
251
        Pack.__init__(self, revision_index, inventory_index, text_index,
189
 
            signature_index)
 
252
            signature_index, chk_index)
190
253
        self.name = name
191
254
        self.pack_transport = pack_transport
192
255
        if None in (revision_index, inventory_index, text_index,
200
263
        return not self.__eq__(other)
201
264
 
202
265
    def __repr__(self):
203
 
        return "<bzrlib.repofmt.pack_repo.Pack object at 0x%x, %s, %s" % (
204
 
            id(self), self.pack_transport, self.name)
 
266
        return "<%s.%s object at 0x%x, %s, %s" % (
 
267
            self.__class__.__module__, self.__class__.__name__, id(self),
 
268
            self.pack_transport, self.name)
 
269
 
 
270
 
 
271
class ResumedPack(ExistingPack):
 
272
 
 
273
    def __init__(self, name, revision_index, inventory_index, text_index,
 
274
        signature_index, upload_transport, pack_transport, index_transport,
 
275
        pack_collection, chk_index=None):
 
276
        """Create a ResumedPack object."""
 
277
        ExistingPack.__init__(self, pack_transport, name, revision_index,
 
278
            inventory_index, text_index, signature_index,
 
279
            chk_index=chk_index)
 
280
        self.upload_transport = upload_transport
 
281
        self.index_transport = index_transport
 
282
        self.index_sizes = [None, None, None, None]
 
283
        indices = [
 
284
            ('revision', revision_index),
 
285
            ('inventory', inventory_index),
 
286
            ('text', text_index),
 
287
            ('signature', signature_index),
 
288
            ]
 
289
        if chk_index is not None:
 
290
            indices.append(('chk', chk_index))
 
291
            self.index_sizes.append(None)
 
292
        for index_type, index in indices:
 
293
            offset = self.index_offset(index_type)
 
294
            self.index_sizes[offset] = index._size
 
295
        self.index_class = pack_collection._index_class
 
296
        self._pack_collection = pack_collection
 
297
        self._state = 'resumed'
 
298
        # XXX: perhaps check that the .pack file exists?
 
299
 
 
300
    def access_tuple(self):
 
301
        if self._state == 'finished':
 
302
            return Pack.access_tuple(self)
 
303
        elif self._state == 'resumed':
 
304
            return self.upload_transport, self.file_name()
 
305
        else:
 
306
            raise AssertionError(self._state)
 
307
 
 
308
    def abort(self):
 
309
        self.upload_transport.delete(self.file_name())
 
310
        indices = [self.revision_index, self.inventory_index, self.text_index,
 
311
            self.signature_index]
 
312
        if self.chk_index is not None:
 
313
            indices.append(self.chk_index)
 
314
        for index in indices:
 
315
            index._transport.delete(index._name)
 
316
 
 
317
    def finish(self):
 
318
        self._check_references()
 
319
        index_types = ['revision', 'inventory', 'text', 'signature']
 
320
        if self.chk_index is not None:
 
321
            index_types.append('chk')
 
322
        for index_type in index_types:
 
323
            old_name = self.index_name(index_type, self.name)
 
324
            new_name = '../indices/' + old_name
 
325
            self.upload_transport.rename(old_name, new_name)
 
326
            self._replace_index_with_readonly(index_type)
 
327
        new_name = '../packs/' + self.file_name()
 
328
        self.upload_transport.rename(self.file_name(), new_name)
 
329
        self._state = 'finished'
 
330
 
 
331
    def _get_external_refs(self, index):
 
332
        """Return compression parents for this index that are not present.
 
333
 
 
334
        This returns any compression parents that are referenced by this index,
 
335
        which are not contained *in* this index. They may be present elsewhere.
 
336
        """
 
337
        return index.external_references(1)
205
338
 
206
339
 
207
340
class NewPack(Pack):
208
341
    """An in memory proxy for a pack which is being created."""
209
342
 
210
 
    # A map of index 'type' to the file extension and position in the
211
 
    # index_sizes array.
212
 
    index_definitions = {
213
 
        'revision': ('.rix', 0),
214
 
        'inventory': ('.iix', 1),
215
 
        'text': ('.tix', 2),
216
 
        'signature': ('.six', 3),
217
 
        }
218
 
 
219
343
    def __init__(self, pack_collection, upload_suffix='', file_mode=None):
220
344
        """Create a NewPack instance.
221
345
 
227
351
        # The relative locations of the packs are constrained, but all are
228
352
        # passed in because the caller has them, so as to avoid object churn.
229
353
        index_builder_class = pack_collection._index_builder_class
 
354
        if pack_collection.chk_index is not None:
 
355
            chk_index = index_builder_class(reference_lists=0)
 
356
        else:
 
357
            chk_index = None
230
358
        Pack.__init__(self,
231
359
            # Revisions: parents list, no text compression.
232
360
            index_builder_class(reference_lists=1),
241
369
            # Signatures: Just blobs to store, no compression, no parents
242
370
            # listing.
243
371
            index_builder_class(reference_lists=0),
 
372
            # CHK based storage - just blobs, no compression or parents.
 
373
            chk_index=chk_index
244
374
            )
245
375
        self._pack_collection = pack_collection
246
376
        # When we make readonly indices, we need this.
255
385
        self._file_mode = file_mode
256
386
        # tracks the content written to the .pack file.
257
387
        self._hash = osutils.md5()
258
 
        # a four-tuple with the length in bytes of the indices, once the pack
259
 
        # is finalised. (rev, inv, text, sigs)
 
388
        # a tuple with the length in bytes of the indices, once the pack
 
389
        # is finalised. (rev, inv, text, sigs, chk_if_in_use)
260
390
        self.index_sizes = None
261
391
        # How much data to cache when writing packs. Note that this is not
262
392
        # synchronised with reads, because it's not in the transport layer, so
274
404
            mutter('%s: create_pack: pack stream open: %s%s t+%6.3fs',
275
405
                time.ctime(), self.upload_transport.base, self.random_name,
276
406
                time.time() - self.start_time)
277
 
        # A list of byte sequences to be written to the new pack, and the 
278
 
        # aggregate size of them.  Stored as a list rather than separate 
 
407
        # A list of byte sequences to be written to the new pack, and the
 
408
        # aggregate size of them.  Stored as a list rather than separate
279
409
        # variables so that the _write_data closure below can update them.
280
410
        self._buffer = [[], 0]
281
 
        # create a callable for adding data 
 
411
        # create a callable for adding data
282
412
        #
283
413
        # robertc says- this is a closure rather than a method on the object
284
414
        # so that the variables are locals, and faster than accessing object
300
430
        self._writer.begin()
301
431
        # what state is the pack in? (open, finished, aborted)
302
432
        self._state = 'open'
 
433
        # no name until we finish writing the content
 
434
        self.name = None
303
435
 
304
436
    def abort(self):
305
437
        """Cancel creating this pack."""
318
450
        else:
319
451
            raise AssertionError(self._state)
320
452
 
321
 
    def _check_references(self):
322
 
        """Make sure our external references are present.
323
 
        
324
 
        Packs are allowed to have deltas whose base is not in the pack, but it
325
 
        must be present somewhere in this collection.  It is not allowed to
326
 
        have deltas based on a fallback repository. 
327
 
        (See <https://bugs.launchpad.net/bzr/+bug/288751>)
328
 
        """
329
 
        missing_items = {}
330
 
        for (index_name, external_refs, index) in [
331
 
            ('texts',
332
 
                self.text_index._external_references(),
333
 
                self._pack_collection.text_index.combined_index),
334
 
            ('inventories',
335
 
                self.inventory_index._external_references(),
336
 
                self._pack_collection.inventory_index.combined_index),
337
 
            ]:
338
 
            missing = external_refs.difference(
339
 
                k for (idx, k, v, r) in 
340
 
                index.iter_entries(external_refs))
341
 
            if missing:
342
 
                missing_items[index_name] = sorted(list(missing))
343
 
        if missing_items:
344
 
            from pprint import pformat
345
 
            raise errors.BzrCheckError(
346
 
                "Newly created pack file %r has delta references to "
347
 
                "items not in its repository:\n%s"
348
 
                % (self, pformat(missing_items)))
349
 
 
350
453
    def data_inserted(self):
351
454
        """True if data has been added to this pack."""
352
455
        return bool(self.get_revision_count() or
353
456
            self.inventory_index.key_count() or
354
457
            self.text_index.key_count() or
355
 
            self.signature_index.key_count())
356
 
 
357
 
    def finish(self):
 
458
            self.signature_index.key_count() or
 
459
            (self.chk_index is not None and self.chk_index.key_count()))
 
460
 
 
461
    def finish_content(self):
 
462
        if self.name is not None:
 
463
            return
 
464
        self._writer.end()
 
465
        if self._buffer[1]:
 
466
            self._write_data('', flush=True)
 
467
        self.name = self._hash.hexdigest()
 
468
 
 
469
    def finish(self, suspend=False):
358
470
        """Finish the new pack.
359
471
 
360
472
        This:
365
477
         - stores the index size tuple for the pack in the index_sizes
366
478
           attribute.
367
479
        """
368
 
        self._writer.end()
369
 
        if self._buffer[1]:
370
 
            self._write_data('', flush=True)
371
 
        self.name = self._hash.hexdigest()
372
 
        self._check_references()
 
480
        self.finish_content()
 
481
        if not suspend:
 
482
            self._check_references()
373
483
        # write indices
374
484
        # XXX: It'd be better to write them all to temporary names, then
375
485
        # rename them all into place, so that the window when only some are
376
486
        # visible is smaller.  On the other hand none will be seen until
377
487
        # they're in the names list.
378
488
        self.index_sizes = [None, None, None, None]
379
 
        self._write_index('revision', self.revision_index, 'revision')
380
 
        self._write_index('inventory', self.inventory_index, 'inventory')
381
 
        self._write_index('text', self.text_index, 'file texts')
 
489
        self._write_index('revision', self.revision_index, 'revision', suspend)
 
490
        self._write_index('inventory', self.inventory_index, 'inventory',
 
491
            suspend)
 
492
        self._write_index('text', self.text_index, 'file texts', suspend)
382
493
        self._write_index('signature', self.signature_index,
383
 
            'revision signatures')
 
494
            'revision signatures', suspend)
 
495
        if self.chk_index is not None:
 
496
            self.index_sizes.append(None)
 
497
            self._write_index('chk', self.chk_index,
 
498
                'content hash bytes', suspend)
384
499
        self.write_stream.close()
385
500
        # Note that this will clobber an existing pack with the same name,
386
501
        # without checking for hash collisions. While this is undesirable this
393
508
        #  - try for HASH.pack
394
509
        #  - try for temporary-name
395
510
        #  - refresh the pack-list to see if the pack is now absent
396
 
        self.upload_transport.rename(self.random_name,
397
 
                '../packs/' + self.name + '.pack')
 
511
        new_name = self.name + '.pack'
 
512
        if not suspend:
 
513
            new_name = '../packs/' + new_name
 
514
        self.upload_transport.rename(self.random_name, new_name)
398
515
        self._state = 'finished'
399
516
        if 'pack' in debug.debug_flags:
400
517
            # XXX: size might be interesting?
401
 
            mutter('%s: create_pack: pack renamed into place: %s%s->%s%s t+%6.3fs',
 
518
            mutter('%s: create_pack: pack finished: %s%s->%s t+%6.3fs',
402
519
                time.ctime(), self.upload_transport.base, self.random_name,
403
 
                self.pack_transport, self.name,
404
 
                time.time() - self.start_time)
 
520
                new_name, time.time() - self.start_time)
405
521
 
406
522
    def flush(self):
407
523
        """Flush any current data."""
411
527
            self._hash.update(bytes)
412
528
            self._buffer[:] = [[], 0]
413
529
 
414
 
    def index_name(self, index_type, name):
415
 
        """Get the disk name of an index type for pack name 'name'."""
416
 
        return name + NewPack.index_definitions[index_type][0]
417
 
 
418
 
    def index_offset(self, index_type):
419
 
        """Get the position in a index_size array for a given index type."""
420
 
        return NewPack.index_definitions[index_type][1]
421
 
 
422
 
    def _replace_index_with_readonly(self, index_type):
423
 
        setattr(self, index_type + '_index',
424
 
            self.index_class(self.index_transport,
425
 
                self.index_name(index_type, self.name),
426
 
                self.index_sizes[self.index_offset(index_type)]))
 
530
    def _get_external_refs(self, index):
 
531
        return index._external_references()
427
532
 
428
533
    def set_write_cache_size(self, size):
429
534
        self._cache_limit = size
430
535
 
431
 
    def _write_index(self, index_type, index, label):
 
536
    def _write_index(self, index_type, index, label, suspend=False):
432
537
        """Write out an index.
433
538
 
434
539
        :param index_type: The type of index to write - e.g. 'revision'.
436
541
        :param label: What label to give the index e.g. 'revision'.
437
542
        """
438
543
        index_name = self.index_name(index_type, self.name)
439
 
        self.index_sizes[self.index_offset(index_type)] = \
440
 
            self.index_transport.put_file(index_name, index.finish(),
441
 
            mode=self._file_mode)
 
544
        if suspend:
 
545
            transport = self.upload_transport
 
546
        else:
 
547
            transport = self.index_transport
 
548
        self.index_sizes[self.index_offset(index_type)] = transport.put_file(
 
549
            index_name, index.finish(), mode=self._file_mode)
442
550
        if 'pack' in debug.debug_flags:
443
551
            # XXX: size might be interesting?
444
552
            mutter('%s: create_pack: wrote %s index: %s%s t+%6.3fs',
445
553
                time.ctime(), label, self.upload_transport.base,
446
554
                self.random_name, time.time() - self.start_time)
447
 
        # Replace the writable index on this object with a readonly, 
 
555
        # Replace the writable index on this object with a readonly,
448
556
        # presently unloaded index. We should alter
449
557
        # the index layer to make its finish() error if add_node is
450
558
        # subsequently used. RBC
459
567
    such as 'revision index'.
460
568
 
461
569
    A CombinedIndex provides an index on a single key space built up
462
 
    from several on-disk indices.  The AggregateIndex builds on this 
 
570
    from several on-disk indices.  The AggregateIndex builds on this
463
571
    to provide a knit access layer, and allows having up to one writable
464
572
    index within the collection.
465
573
    """
466
574
    # XXX: Probably 'can be written to' could/should be separated from 'acts
467
575
    # like a knit index' -- mbp 20071024
468
576
 
469
 
    def __init__(self, reload_func=None):
 
577
    def __init__(self, reload_func=None, flush_func=None):
470
578
        """Create an AggregateIndex.
471
579
 
472
580
        :param reload_func: A function to call if we find we are missing an
477
585
        self.index_to_pack = {}
478
586
        self.combined_index = CombinedGraphIndex([], reload_func=reload_func)
479
587
        self.data_access = _DirectPackAccess(self.index_to_pack,
480
 
                                             reload_func=reload_func)
481
 
        self.add_callback = None
482
 
 
483
 
    def replace_indices(self, index_to_pack, indices):
484
 
        """Replace the current mappings with fresh ones.
485
 
 
486
 
        This should probably not be used eventually, rather incremental add and
487
 
        removal of indices. It has been added during refactoring of existing
488
 
        code.
489
 
 
490
 
        :param index_to_pack: A mapping from index objects to
491
 
            (transport, name) tuples for the pack file data.
492
 
        :param indices: A list of indices.
493
 
        """
494
 
        # refresh the revision pack map dict without replacing the instance.
495
 
        self.index_to_pack.clear()
496
 
        self.index_to_pack.update(index_to_pack)
497
 
        # XXX: API break - clearly a 'replace' method would be good?
498
 
        self.combined_index._indices[:] = indices
499
 
        # the current add nodes callback for the current writable index if
500
 
        # there is one.
 
588
                                             reload_func=reload_func,
 
589
                                             flush_func=flush_func)
501
590
        self.add_callback = None
502
591
 
503
592
    def add_index(self, index, pack):
505
594
 
506
595
        Future searches on the aggregate index will seach this new index
507
596
        before all previously inserted indices.
508
 
        
 
597
 
509
598
        :param index: An Index for the pack.
510
599
        :param pack: A Pack instance.
511
600
        """
512
601
        # expose it to the index map
513
602
        self.index_to_pack[index] = pack.access_tuple()
514
603
        # put it at the front of the linear index list
515
 
        self.combined_index.insert_index(0, index)
 
604
        self.combined_index.insert_index(0, index, pack.name)
516
605
 
517
606
    def add_writable_index(self, index, pack):
518
607
        """Add an index which is able to have data added to it.
519
608
 
520
609
        There can be at most one writable index at any time.  Any
521
610
        modifications made to the knit are put into this index.
522
 
        
 
611
 
523
612
        :param index: An index from the pack parameter.
524
613
        :param pack: A Pack instance.
525
614
        """
538
627
        self.data_access.set_writer(None, None, (None, None))
539
628
        self.index_to_pack.clear()
540
629
        del self.combined_index._indices[:]
 
630
        del self.combined_index._index_names[:]
541
631
        self.add_callback = None
542
632
 
543
 
    def remove_index(self, index, pack):
 
633
    def remove_index(self, index):
544
634
        """Remove index from the indices used to answer queries.
545
 
        
 
635
 
546
636
        :param index: An index from the pack parameter.
547
 
        :param pack: A Pack instance.
548
637
        """
549
638
        del self.index_to_pack[index]
550
 
        self.combined_index._indices.remove(index)
 
639
        pos = self.combined_index._indices.index(index)
 
640
        del self.combined_index._indices[pos]
 
641
        del self.combined_index._index_names[pos]
551
642
        if (self.add_callback is not None and
552
643
            getattr(index, 'add_nodes', None) == self.add_callback):
553
644
            self.add_callback = None
623
714
        This does little more than a bulk copy of data. One key difference
624
715
        is that data with the same item key across multiple packs is elided
625
716
        from the output. The new pack is written into the current pack store
626
 
        along with its indices, and the name added to the pack names. The 
 
717
        along with its indices, and the name added to the pack names. The
627
718
        source packs are not altered and are not required to be in the current
628
719
        pack collection.
629
720
 
659
750
 
660
751
    def open_pack(self):
661
752
        """Open a pack for the pack we are creating."""
662
 
        return NewPack(self._pack_collection, upload_suffix=self.suffix,
 
753
        new_pack = self._pack_collection.pack_factory(self._pack_collection,
 
754
                upload_suffix=self.suffix,
663
755
                file_mode=self._pack_collection.repo.bzrdir._get_file_mode())
 
756
        # We know that we will process all nodes in order, and don't need to
 
757
        # query, so don't combine any indices spilled to disk until we are done
 
758
        new_pack.revision_index.set_optimize(combine_backing_indices=False)
 
759
        new_pack.inventory_index.set_optimize(combine_backing_indices=False)
 
760
        new_pack.text_index.set_optimize(combine_backing_indices=False)
 
761
        new_pack.signature_index.set_optimize(combine_backing_indices=False)
 
762
        return new_pack
664
763
 
665
764
    def _update_pack_order(self, entries, index_to_pack_map):
666
765
        """Determine how we want our packs to be ordered.
776
875
            if missing_text_keys:
777
876
                # TODO: raise a specific error that can handle many missing
778
877
                # keys.
 
878
                mutter("missing keys during fetch: %r", missing_text_keys)
779
879
                a_missing_key = missing_text_keys.pop()
780
880
                raise errors.RevisionNotPresent(a_missing_key[1],
781
881
                    a_missing_key[0])
822
922
                time.ctime(), self._pack_collection._upload_transport.base, new_pack.random_name,
823
923
                new_pack.signature_index.key_count(),
824
924
                time.time() - new_pack.start_time)
 
925
        # copy chk contents
 
926
        # NB XXX: how to check CHK references are present? perhaps by yielding
 
927
        # the items? How should that interact with stacked repos?
 
928
        if new_pack.chk_index is not None:
 
929
            self._copy_chks()
 
930
            if 'pack' in debug.debug_flags:
 
931
                mutter('%s: create_pack: chk content copied: %s%s %d items t+%6.3fs',
 
932
                    time.ctime(), self._pack_collection._upload_transport.base,
 
933
                    new_pack.random_name,
 
934
                    new_pack.chk_index.key_count(),
 
935
                    time.time() - new_pack.start_time)
825
936
        new_pack._check_references()
826
937
        if not self._use_pack(new_pack):
827
938
            new_pack.abort()
831
942
        self._pack_collection.allocate(new_pack)
832
943
        return new_pack
833
944
 
834
 
    def _copy_nodes(self, nodes, index_map, writer, write_index):
835
 
        """Copy knit nodes between packs with no graph references."""
 
945
    def _copy_chks(self, refs=None):
 
946
        # XXX: Todo, recursive follow-pointers facility when fetching some
 
947
        # revisions only.
 
948
        chk_index_map, chk_indices = self._pack_map_and_index_list(
 
949
            'chk_index')
 
950
        chk_nodes = self._index_contents(chk_indices, refs)
 
951
        new_refs = set()
 
952
        # TODO: This isn't strictly tasteful as we are accessing some private
 
953
        #       variables (_serializer). Perhaps a better way would be to have
 
954
        #       Repository._deserialise_chk_node()
 
955
        search_key_func = chk_map.search_key_registry.get(
 
956
            self._pack_collection.repo._serializer.search_key_name)
 
957
        def accumlate_refs(lines):
 
958
            # XXX: move to a generic location
 
959
            # Yay mismatch:
 
960
            bytes = ''.join(lines)
 
961
            node = chk_map._deserialise(bytes, ("unknown",), search_key_func)
 
962
            new_refs.update(node.refs())
 
963
        self._copy_nodes(chk_nodes, chk_index_map, self.new_pack._writer,
 
964
            self.new_pack.chk_index, output_lines=accumlate_refs)
 
965
        return new_refs
 
966
 
 
967
    def _copy_nodes(self, nodes, index_map, writer, write_index,
 
968
        output_lines=None):
 
969
        """Copy knit nodes between packs with no graph references.
 
970
 
 
971
        :param output_lines: Output full texts of copied items.
 
972
        """
836
973
        pb = ui.ui_factory.nested_progress_bar()
837
974
        try:
838
975
            return self._do_copy_nodes(nodes, index_map, writer,
839
 
                write_index, pb)
 
976
                write_index, pb, output_lines=output_lines)
840
977
        finally:
841
978
            pb.finished()
842
979
 
843
 
    def _do_copy_nodes(self, nodes, index_map, writer, write_index, pb):
 
980
    def _do_copy_nodes(self, nodes, index_map, writer, write_index, pb,
 
981
        output_lines=None):
844
982
        # for record verification
845
983
        knit = KnitVersionedFiles(None, None)
846
984
        # plan a readv on each source pack:
848
986
        nodes = sorted(nodes)
849
987
        # how to map this into knit.py - or knit.py into this?
850
988
        # we don't want the typical knit logic, we want grouping by pack
851
 
        # at this point - perhaps a helper library for the following code 
 
989
        # at this point - perhaps a helper library for the following code
852
990
        # duplication points?
853
991
        request_groups = {}
854
992
        for index, key, value in nodes:
880
1018
                izip(reader.iter_records(), pack_readv_requests):
881
1019
                raw_data = read_func(None)
882
1020
                # check the header only
883
 
                df, _ = knit._parse_record_header(key, raw_data)
884
 
                df.close()
 
1021
                if output_lines is not None:
 
1022
                    output_lines(knit._parse_record(key[-1], raw_data)[0])
 
1023
                else:
 
1024
                    df, _ = knit._parse_record_header(key, raw_data)
 
1025
                    df.close()
885
1026
                pos, size = writer.add_bytes_record(raw_data, names)
886
1027
                write_index.add_node(key, eol_flag + "%d %d" % (pos, size))
887
1028
                pb.update("Copied record", record_index)
954
1095
 
955
1096
    def _least_readv_node_readv(self, nodes):
956
1097
        """Generate request groups for nodes using the least readv's.
957
 
        
 
1098
 
958
1099
        :param nodes: An iterable of graph index nodes.
959
1100
        :return: Total node count and an iterator of the data needed to perform
960
1101
            readvs to obtain the data for nodes. Each item yielded by the
961
1102
            iterator is a tuple with:
962
1103
            index, readv_vector, node_vector. readv_vector is a list ready to
963
1104
            hand to the transport readv method, and node_vector is a list of
964
 
            (key, eol_flag, references) for the the node retrieved by the
 
1105
            (key, eol_flag, references) for the node retrieved by the
965
1106
            matching readv_vector.
966
1107
        """
967
1108
        # group by pack so we do one readv per pack
1071
1212
 
1072
1213
class ReconcilePacker(Packer):
1073
1214
    """A packer which regenerates indices etc as it copies.
1074
 
    
 
1215
 
1075
1216
    This is used by ``bzr reconcile`` to cause parent text pointers to be
1076
1217
    regenerated.
1077
1218
    """
1100
1241
        # 1) generate the ideal index
1101
1242
        repo = self._pack_collection.repo
1102
1243
        ancestors = dict([(key[0], tuple(ref[0] for ref in refs[0])) for
1103
 
            _1, key, _2, refs in 
 
1244
            _1, key, _2, refs in
1104
1245
            self.new_pack.revision_index.iter_all_entries()])
1105
1246
        ideal_index = repo._generate_text_key_index(self._text_refs, ancestors)
1106
1247
        # 2) generate a text_nodes list that contains all the deltas that can
1112
1253
        text_index_map, text_nodes = self._get_text_nodes()
1113
1254
        for node in text_nodes:
1114
1255
            # 0 - index
1115
 
            # 1 - key 
 
1256
            # 1 - key
1116
1257
            # 2 - value
1117
1258
            # 3 - refs
1118
1259
            try:
1158
1299
        # space (we only topo sort the revisions, which is smaller).
1159
1300
        topo_order = tsort.topo_sort(ancestors)
1160
1301
        rev_order = dict(zip(topo_order, range(len(topo_order))))
1161
 
        bad_texts.sort(key=lambda key:rev_order[key[0][1]])
 
1302
        bad_texts.sort(key=lambda key:rev_order.get(key[0][1], 0))
1162
1303
        transaction = repo.get_transaction()
1163
1304
        file_id_index = GraphIndexPrefixAdapter(
1164
1305
            self.new_pack.text_index,
1213
1354
 
1214
1355
class RepositoryPackCollection(object):
1215
1356
    """Management of packs within a repository.
1216
 
    
 
1357
 
1217
1358
    :ivar _names: map of {pack_name: (index_size,)}
1218
1359
    """
1219
1360
 
 
1361
    pack_factory = NewPack
 
1362
    resumed_pack_factory = ResumedPack
 
1363
 
1220
1364
    def __init__(self, repo, transport, index_transport, upload_transport,
1221
 
                 pack_transport, index_builder_class, index_class):
 
1365
                 pack_transport, index_builder_class, index_class,
 
1366
                 use_chk_index):
1222
1367
        """Create a new RepositoryPackCollection.
1223
1368
 
1224
 
        :param transport: Addresses the repository base directory 
 
1369
        :param transport: Addresses the repository base directory
1225
1370
            (typically .bzr/repository/).
1226
1371
        :param index_transport: Addresses the directory containing indices.
1227
1372
        :param upload_transport: Addresses the directory into which packs are written
1229
1374
        :param pack_transport: Addresses the directory of existing complete packs.
1230
1375
        :param index_builder_class: The index builder class to use.
1231
1376
        :param index_class: The index class to use.
 
1377
        :param use_chk_index: Whether to setup and manage a CHK index.
1232
1378
        """
 
1379
        # XXX: This should call self.reset()
1233
1380
        self.repo = repo
1234
1381
        self.transport = transport
1235
1382
        self._index_transport = index_transport
1237
1384
        self._pack_transport = pack_transport
1238
1385
        self._index_builder_class = index_builder_class
1239
1386
        self._index_class = index_class
1240
 
        self._suffix_offsets = {'.rix': 0, '.iix': 1, '.tix': 2, '.six': 3}
 
1387
        self._suffix_offsets = {'.rix': 0, '.iix': 1, '.tix': 2, '.six': 3,
 
1388
            '.cix': 4}
1241
1389
        self.packs = []
1242
1390
        # name:Pack mapping
 
1391
        self._names = None
1243
1392
        self._packs_by_name = {}
1244
1393
        # the previous pack-names content
1245
1394
        self._packs_at_load = None
1246
1395
        # when a pack is being created by this object, the state of that pack.
1247
1396
        self._new_pack = None
1248
1397
        # aggregated revision index data
1249
 
        self.revision_index = AggregateIndex(self.reload_pack_names)
1250
 
        self.inventory_index = AggregateIndex(self.reload_pack_names)
1251
 
        self.text_index = AggregateIndex(self.reload_pack_names)
1252
 
        self.signature_index = AggregateIndex(self.reload_pack_names)
 
1398
        flush = self._flush_new_pack
 
1399
        self.revision_index = AggregateIndex(self.reload_pack_names, flush)
 
1400
        self.inventory_index = AggregateIndex(self.reload_pack_names, flush)
 
1401
        self.text_index = AggregateIndex(self.reload_pack_names, flush)
 
1402
        self.signature_index = AggregateIndex(self.reload_pack_names, flush)
 
1403
        all_indices = [self.revision_index, self.inventory_index,
 
1404
                self.text_index, self.signature_index]
 
1405
        if use_chk_index:
 
1406
            self.chk_index = AggregateIndex(self.reload_pack_names, flush)
 
1407
            all_indices.append(self.chk_index)
 
1408
        else:
 
1409
            # used to determine if we're using a chk_index elsewhere.
 
1410
            self.chk_index = None
 
1411
        # Tell all the CombinedGraphIndex objects about each other, so they can
 
1412
        # share hints about which pack names to search first.
 
1413
        all_combined = [agg_idx.combined_index for agg_idx in all_indices]
 
1414
        for combined_idx in all_combined:
 
1415
            combined_idx.set_sibling_indices(
 
1416
                set(all_combined).difference([combined_idx]))
 
1417
        # resumed packs
 
1418
        self._resumed_packs = []
 
1419
 
 
1420
    def __repr__(self):
 
1421
        return '%s(%r)' % (self.__class__.__name__, self.repo)
1253
1422
 
1254
1423
    def add_pack_to_memory(self, pack):
1255
1424
        """Make a Pack object available to the repository to satisfy queries.
1256
 
        
 
1425
 
1257
1426
        :param pack: A Pack object.
1258
1427
        """
1259
1428
        if pack.name in self._packs_by_name:
1260
 
            raise AssertionError()
 
1429
            raise AssertionError(
 
1430
                'pack %s already in _packs_by_name' % (pack.name,))
1261
1431
        self.packs.append(pack)
1262
1432
        self._packs_by_name[pack.name] = pack
1263
1433
        self.revision_index.add_index(pack.revision_index, pack)
1264
1434
        self.inventory_index.add_index(pack.inventory_index, pack)
1265
1435
        self.text_index.add_index(pack.text_index, pack)
1266
1436
        self.signature_index.add_index(pack.signature_index, pack)
1267
 
        
 
1437
        if self.chk_index is not None:
 
1438
            self.chk_index.add_index(pack.chk_index, pack)
 
1439
 
1268
1440
    def all_packs(self):
1269
1441
        """Return a list of all the Pack objects this repository has.
1270
1442
 
1279
1451
 
1280
1452
    def autopack(self):
1281
1453
        """Pack the pack collection incrementally.
1282
 
        
 
1454
 
1283
1455
        This will not attempt global reorganisation or recompression,
1284
1456
        rather it will just ensure that the total number of packs does
1285
1457
        not grow without bound. It uses the _max_pack_count method to
1291
1463
        in synchronisation with certain steps. Otherwise the names collection
1292
1464
        is not flushed.
1293
1465
 
1294
 
        :return: True if packing took place.
 
1466
        :return: Something evaluating true if packing took place.
1295
1467
        """
1296
1468
        while True:
1297
1469
            try:
1298
1470
                return self._do_autopack()
1299
 
            except errors.RetryAutopack, e:
 
1471
            except errors.RetryAutopack:
1300
1472
                # If we get a RetryAutopack exception, we should abort the
1301
1473
                # current action, and retry.
1302
1474
                pass
1306
1478
        total_revisions = self.revision_index.combined_index.key_count()
1307
1479
        total_packs = len(self._names)
1308
1480
        if self._max_pack_count(total_revisions) >= total_packs:
1309
 
            return False
1310
 
        # XXX: the following may want to be a class, to pack with a given
1311
 
        # policy.
 
1481
            return None
1312
1482
        # determine which packs need changing
1313
1483
        pack_distribution = self.pack_distribution(total_revisions)
1314
1484
        existing_packs = []
1322
1492
                # group their data with the relevant commit, and that may
1323
1493
                # involve rewriting ancient history - which autopack tries to
1324
1494
                # avoid. Alternatively we could not group the data but treat
1325
 
                # each of these as having a single revision, and thus add 
 
1495
                # each of these as having a single revision, and thus add
1326
1496
                # one revision for each to the total revision count, to get
1327
1497
                # a matching distribution.
1328
1498
                continue
1336
1506
            'containing %d revisions. Packing %d files into %d affecting %d'
1337
1507
            ' revisions', self, total_packs, total_revisions, num_old_packs,
1338
1508
            num_new_packs, num_revs_affected)
1339
 
        self._execute_pack_operations(pack_operations,
 
1509
        result = self._execute_pack_operations(pack_operations,
1340
1510
                                      reload_func=self._restart_autopack)
1341
 
        return True
 
1511
        mutter('Auto-packing repository %s completed', self)
 
1512
        return result
1342
1513
 
1343
1514
    def _execute_pack_operations(self, pack_operations, _packer_class=Packer,
1344
1515
                                 reload_func=None):
1346
1517
 
1347
1518
        :param pack_operations: A list of [revision_count, packs_to_combine].
1348
1519
        :param _packer_class: The class of packer to use (default: Packer).
1349
 
        :return: None.
 
1520
        :return: The new pack names.
1350
1521
        """
1351
1522
        for revision_count, packs in pack_operations:
1352
1523
            # we may have no-ops from the setup logic
1368
1539
                self._remove_pack_from_memory(pack)
1369
1540
        # record the newly available packs and stop advertising the old
1370
1541
        # packs
1371
 
        self._save_pack_names(clear_obsolete_packs=True)
1372
 
        # Move the old packs out of the way now they are no longer referenced.
1373
 
        for revision_count, packs in pack_operations:
1374
 
            self._obsolete_packs(packs)
 
1542
        to_be_obsoleted = []
 
1543
        for _, packs in pack_operations:
 
1544
            to_be_obsoleted.extend(packs)
 
1545
        result = self._save_pack_names(clear_obsolete_packs=True,
 
1546
                                       obsolete_packs=to_be_obsoleted)
 
1547
        return result
 
1548
 
 
1549
    def _flush_new_pack(self):
 
1550
        if self._new_pack is not None:
 
1551
            self._new_pack.flush()
1375
1552
 
1376
1553
    def lock_names(self):
1377
1554
        """Acquire the mutex around the pack-names index.
1378
 
        
 
1555
 
1379
1556
        This cannot be used in the middle of a read-only transaction on the
1380
1557
        repository.
1381
1558
        """
1382
1559
        self.repo.control_files.lock_write()
1383
1560
 
1384
 
    def pack(self):
 
1561
    def _already_packed(self):
 
1562
        """Is the collection already packed?"""
 
1563
        return not (self.repo._format.pack_compresses or (len(self._names) > 1))
 
1564
 
 
1565
    def pack(self, hint=None, clean_obsolete_packs=False):
1385
1566
        """Pack the pack collection totally."""
1386
1567
        self.ensure_loaded()
1387
1568
        total_packs = len(self._names)
1388
 
        if total_packs < 2:
1389
 
            # This is arguably wrong because we might not be optimal, but for
1390
 
            # now lets leave it in. (e.g. reconcile -> one pack. But not
1391
 
            # optimal.
 
1569
        if self._already_packed():
1392
1570
            return
1393
1571
        total_revisions = self.revision_index.combined_index.key_count()
1394
1572
        # XXX: the following may want to be a class, to pack with a given
1395
1573
        # policy.
1396
1574
        mutter('Packing repository %s, which has %d pack files, '
1397
 
            'containing %d revisions into 1 packs.', self, total_packs,
1398
 
            total_revisions)
 
1575
            'containing %d revisions with hint %r.', self, total_packs,
 
1576
            total_revisions, hint)
1399
1577
        # determine which packs need changing
1400
 
        pack_distribution = [1]
1401
1578
        pack_operations = [[0, []]]
1402
1579
        for pack in self.all_packs():
1403
 
            pack_operations[-1][0] += pack.get_revision_count()
1404
 
            pack_operations[-1][1].append(pack)
 
1580
            if hint is None or pack.name in hint:
 
1581
                # Either no hint was provided (so we are packing everything),
 
1582
                # or this pack was included in the hint.
 
1583
                pack_operations[-1][0] += pack.get_revision_count()
 
1584
                pack_operations[-1][1].append(pack)
1405
1585
        self._execute_pack_operations(pack_operations, OptimisingPacker)
1406
1586
 
 
1587
        if clean_obsolete_packs:
 
1588
            self._clear_obsolete_packs()
 
1589
 
1407
1590
    def plan_autopack_combinations(self, existing_packs, pack_distribution):
1408
1591
        """Plan a pack operation.
1409
1592
 
1457
1640
        return [[final_rev_count, final_pack_list]]
1458
1641
 
1459
1642
    def ensure_loaded(self):
 
1643
        """Ensure we have read names from disk.
 
1644
 
 
1645
        :return: True if the disk names had not been previously read.
 
1646
        """
1460
1647
        # NB: if you see an assertion error here, its probably access against
1461
1648
        # an unlocked repo. Naughty.
1462
1649
        if not self.repo.is_locked():
1468
1655
                name = key[0]
1469
1656
                self._names[name] = self._parse_index_sizes(value)
1470
1657
                self._packs_at_load.add((key, value))
 
1658
            result = True
 
1659
        else:
 
1660
            result = False
1471
1661
        # populate all the metadata.
1472
1662
        self.all_packs()
 
1663
        return result
1473
1664
 
1474
1665
    def _parse_index_sizes(self, value):
1475
1666
        """Parse a string of index sizes."""
1488
1679
            inv_index = self._make_index(name, '.iix')
1489
1680
            txt_index = self._make_index(name, '.tix')
1490
1681
            sig_index = self._make_index(name, '.six')
 
1682
            if self.chk_index is not None:
 
1683
                chk_index = self._make_index(name, '.cix', unlimited_cache=True)
 
1684
            else:
 
1685
                chk_index = None
1491
1686
            result = ExistingPack(self._pack_transport, name, rev_index,
1492
 
                inv_index, txt_index, sig_index)
 
1687
                inv_index, txt_index, sig_index, chk_index)
1493
1688
            self.add_pack_to_memory(result)
1494
1689
            return result
1495
1690
 
 
1691
    def _resume_pack(self, name):
 
1692
        """Get a suspended Pack object by name.
 
1693
 
 
1694
        :param name: The name of the pack - e.g. '123456'
 
1695
        :return: A Pack object.
 
1696
        """
 
1697
        if not re.match('[a-f0-9]{32}', name):
 
1698
            # Tokens should be md5sums of the suspended pack file, i.e. 32 hex
 
1699
            # digits.
 
1700
            raise errors.UnresumableWriteGroup(
 
1701
                self.repo, [name], 'Malformed write group token')
 
1702
        try:
 
1703
            rev_index = self._make_index(name, '.rix', resume=True)
 
1704
            inv_index = self._make_index(name, '.iix', resume=True)
 
1705
            txt_index = self._make_index(name, '.tix', resume=True)
 
1706
            sig_index = self._make_index(name, '.six', resume=True)
 
1707
            if self.chk_index is not None:
 
1708
                chk_index = self._make_index(name, '.cix', resume=True,
 
1709
                                             unlimited_cache=True)
 
1710
            else:
 
1711
                chk_index = None
 
1712
            result = self.resumed_pack_factory(name, rev_index, inv_index,
 
1713
                txt_index, sig_index, self._upload_transport,
 
1714
                self._pack_transport, self._index_transport, self,
 
1715
                chk_index=chk_index)
 
1716
        except errors.NoSuchFile, e:
 
1717
            raise errors.UnresumableWriteGroup(self.repo, [name], str(e))
 
1718
        self.add_pack_to_memory(result)
 
1719
        self._resumed_packs.append(result)
 
1720
        return result
 
1721
 
1496
1722
    def allocate(self, a_new_pack):
1497
1723
        """Allocate name in the list of packs.
1498
1724
 
1508
1734
 
1509
1735
    def _iter_disk_pack_index(self):
1510
1736
        """Iterate over the contents of the pack-names index.
1511
 
        
 
1737
 
1512
1738
        This is used when loading the list from disk, and before writing to
1513
1739
        detect updates from others during our write operation.
1514
1740
        :return: An iterator of the index contents.
1516
1742
        return self._index_class(self.transport, 'pack-names', None
1517
1743
                ).iter_all_entries()
1518
1744
 
1519
 
    def _make_index(self, name, suffix):
 
1745
    def _make_index(self, name, suffix, resume=False, unlimited_cache=False):
1520
1746
        size_offset = self._suffix_offsets[suffix]
1521
1747
        index_name = name + suffix
1522
 
        index_size = self._names[name][size_offset]
1523
 
        return self._index_class(
1524
 
            self._index_transport, index_name, index_size)
 
1748
        if resume:
 
1749
            transport = self._upload_transport
 
1750
            index_size = transport.stat(index_name).st_size
 
1751
        else:
 
1752
            transport = self._index_transport
 
1753
            index_size = self._names[name][size_offset]
 
1754
        return self._index_class(transport, index_name, index_size,
 
1755
                                 unlimited_cache=unlimited_cache)
1525
1756
 
1526
1757
    def _max_pack_count(self, total_revisions):
1527
1758
        """Return the maximum number of packs to use for total revisions.
1528
 
        
 
1759
 
1529
1760
        :param total_revisions: The total number of revisions in the
1530
1761
            repository.
1531
1762
        """
1555
1786
        :param return: None.
1556
1787
        """
1557
1788
        for pack in packs:
1558
 
            pack.pack_transport.rename(pack.file_name(),
1559
 
                '../obsolete_packs/' + pack.file_name())
 
1789
            try:
 
1790
                pack.pack_transport.rename(pack.file_name(),
 
1791
                    '../obsolete_packs/' + pack.file_name())
 
1792
            except (errors.PathError, errors.TransportError), e:
 
1793
                # TODO: Should these be warnings or mutters?
 
1794
                mutter("couldn't rename obsolete pack, skipping it:\n%s"
 
1795
                       % (e,))
1560
1796
            # TODO: Probably needs to know all possible indices for this pack
1561
1797
            # - or maybe list the directory and move all indices matching this
1562
1798
            # name whether we recognize it or not?
1563
 
            for suffix in ('.iix', '.six', '.tix', '.rix'):
1564
 
                self._index_transport.rename(pack.name + suffix,
1565
 
                    '../obsolete_packs/' + pack.name + suffix)
 
1799
            suffixes = ['.iix', '.six', '.tix', '.rix']
 
1800
            if self.chk_index is not None:
 
1801
                suffixes.append('.cix')
 
1802
            for suffix in suffixes:
 
1803
                try:
 
1804
                    self._index_transport.rename(pack.name + suffix,
 
1805
                        '../obsolete_packs/' + pack.name + suffix)
 
1806
                except (errors.PathError, errors.TransportError), e:
 
1807
                    mutter("couldn't rename obsolete index, skipping it:\n%s"
 
1808
                           % (e,))
1566
1809
 
1567
1810
    def pack_distribution(self, total_revisions):
1568
1811
        """Generate a list of the number of revisions to put in each pack.
1586
1829
 
1587
1830
    def _remove_pack_from_memory(self, pack):
1588
1831
        """Remove pack from the packs accessed by this repository.
1589
 
        
 
1832
 
1590
1833
        Only affects memory state, until self._save_pack_names() is invoked.
1591
1834
        """
1592
1835
        self._names.pop(pack.name)
1594
1837
        self._remove_pack_indices(pack)
1595
1838
        self.packs.remove(pack)
1596
1839
 
1597
 
    def _remove_pack_indices(self, pack):
1598
 
        """Remove the indices for pack from the aggregated indices."""
1599
 
        self.revision_index.remove_index(pack.revision_index, pack)
1600
 
        self.inventory_index.remove_index(pack.inventory_index, pack)
1601
 
        self.text_index.remove_index(pack.text_index, pack)
1602
 
        self.signature_index.remove_index(pack.signature_index, pack)
 
1840
    def _remove_pack_indices(self, pack, ignore_missing=False):
 
1841
        """Remove the indices for pack from the aggregated indices.
 
1842
        
 
1843
        :param ignore_missing: Suppress KeyErrors from calling remove_index.
 
1844
        """
 
1845
        for index_type in Pack.index_definitions.keys():
 
1846
            attr_name = index_type + '_index'
 
1847
            aggregate_index = getattr(self, attr_name)
 
1848
            if aggregate_index is not None:
 
1849
                pack_index = getattr(pack, attr_name)
 
1850
                try:
 
1851
                    aggregate_index.remove_index(pack_index)
 
1852
                except KeyError:
 
1853
                    if ignore_missing:
 
1854
                        continue
 
1855
                    raise
1603
1856
 
1604
1857
    def reset(self):
1605
1858
        """Clear all cached data."""
1606
1859
        # cached revision data
1607
 
        self.repo._revision_knit = None
1608
1860
        self.revision_index.clear()
1609
1861
        # cached signature data
1610
 
        self.repo._signature_knit = None
1611
1862
        self.signature_index.clear()
1612
1863
        # cached file text data
1613
1864
        self.text_index.clear()
1614
 
        self.repo._text_knit = None
1615
1865
        # cached inventory data
1616
1866
        self.inventory_index.clear()
 
1867
        # cached chk data
 
1868
        if self.chk_index is not None:
 
1869
            self.chk_index.clear()
1617
1870
        # remove the open pack
1618
1871
        self._new_pack = None
1619
1872
        # information about packs.
1638
1891
        disk_nodes = set()
1639
1892
        for index, key, value in self._iter_disk_pack_index():
1640
1893
            disk_nodes.add((key, value))
 
1894
        orig_disk_nodes = set(disk_nodes)
1641
1895
 
1642
1896
        # do a two-way diff against our original content
1643
1897
        current_nodes = set()
1656
1910
        disk_nodes.difference_update(deleted_nodes)
1657
1911
        disk_nodes.update(new_nodes)
1658
1912
 
1659
 
        return disk_nodes, deleted_nodes, new_nodes
 
1913
        return disk_nodes, deleted_nodes, new_nodes, orig_disk_nodes
1660
1914
 
1661
1915
    def _syncronize_pack_names_from_disk_nodes(self, disk_nodes):
1662
1916
        """Given the correct set of pack files, update our saved info.
1702
1956
                added.append(name)
1703
1957
        return removed, added, modified
1704
1958
 
1705
 
    def _save_pack_names(self, clear_obsolete_packs=False):
 
1959
    def _save_pack_names(self, clear_obsolete_packs=False, obsolete_packs=None):
1706
1960
        """Save the list of packs.
1707
1961
 
1708
1962
        This will take out the mutex around the pack names list for the
1712
1966
 
1713
1967
        :param clear_obsolete_packs: If True, clear out the contents of the
1714
1968
            obsolete_packs directory.
 
1969
        :param obsolete_packs: Packs that are obsolete once the new pack-names
 
1970
            file has been written.
 
1971
        :return: A list of the names saved that were not previously on disk.
1715
1972
        """
 
1973
        already_obsolete = []
1716
1974
        self.lock_names()
1717
1975
        try:
1718
1976
            builder = self._index_builder_class()
1719
 
            disk_nodes, deleted_nodes, new_nodes = self._diff_pack_names()
1720
 
            # TODO: handle same-name, index-size-changes here - 
 
1977
            (disk_nodes, deleted_nodes, new_nodes,
 
1978
             orig_disk_nodes) = self._diff_pack_names()
 
1979
            # TODO: handle same-name, index-size-changes here -
1721
1980
            # e.g. use the value from disk, not ours, *unless* we're the one
1722
1981
            # changing it.
1723
1982
            for key, value in disk_nodes:
1724
1983
                builder.add_node(key, value)
1725
1984
            self.transport.put_file('pack-names', builder.finish(),
1726
1985
                mode=self.repo.bzrdir._get_file_mode())
1727
 
            # move the baseline forward
1728
1986
            self._packs_at_load = disk_nodes
1729
1987
            if clear_obsolete_packs:
1730
 
                self._clear_obsolete_packs()
 
1988
                to_preserve = None
 
1989
                if obsolete_packs:
 
1990
                    to_preserve = set([o.name for o in obsolete_packs])
 
1991
                already_obsolete = self._clear_obsolete_packs(to_preserve)
1731
1992
        finally:
1732
1993
            self._unlock_names()
1733
1994
        # synchronise the memory packs list with what we just wrote:
1734
1995
        self._syncronize_pack_names_from_disk_nodes(disk_nodes)
 
1996
        if obsolete_packs:
 
1997
            # TODO: We could add one more condition here. "if o.name not in
 
1998
            #       orig_disk_nodes and o != the new_pack we haven't written to
 
1999
            #       disk yet. However, the new pack object is not easily
 
2000
            #       accessible here (it would have to be passed through the
 
2001
            #       autopacking code, etc.)
 
2002
            obsolete_packs = [o for o in obsolete_packs
 
2003
                              if o.name not in already_obsolete]
 
2004
            self._obsolete_packs(obsolete_packs)
 
2005
        return [new_node[0][0] for new_node in new_nodes]
1735
2006
 
1736
2007
    def reload_pack_names(self):
1737
2008
        """Sync our pack listing with what is present in the repository.
1739
2010
        This should be called when we find out that something we thought was
1740
2011
        present is now missing. This happens when another process re-packs the
1741
2012
        repository, etc.
 
2013
 
 
2014
        :return: True if the in-memory list of packs has been altered at all.
1742
2015
        """
1743
 
        # This is functionally similar to _save_pack_names, but we don't write
 
2016
        # The ensure_loaded call is to handle the case where the first call
 
2017
        # made involving the collection was to reload_pack_names, where we 
 
2018
        # don't have a view of disk contents. Its a bit of a bandaid, and
 
2019
        # causes two reads of pack-names, but its a rare corner case not struck
 
2020
        # with regular push/pull etc.
 
2021
        first_read = self.ensure_loaded()
 
2022
        if first_read:
 
2023
            return True
1744
2024
        # out the new value.
1745
 
        disk_nodes, _, _ = self._diff_pack_names()
1746
 
        self._packs_at_load = disk_nodes
 
2025
        (disk_nodes, deleted_nodes, new_nodes,
 
2026
         orig_disk_nodes) = self._diff_pack_names()
 
2027
        # _packs_at_load is meant to be the explicit list of names in
 
2028
        # 'pack-names' at then start. As such, it should not contain any
 
2029
        # pending names that haven't been written out yet.
 
2030
        self._packs_at_load = orig_disk_nodes
1747
2031
        (removed, added,
1748
2032
         modified) = self._syncronize_pack_names_from_disk_nodes(disk_nodes)
1749
2033
        if removed or added or modified:
1758
2042
            raise
1759
2043
        raise errors.RetryAutopack(self.repo, False, sys.exc_info())
1760
2044
 
1761
 
    def _clear_obsolete_packs(self):
 
2045
    def _clear_obsolete_packs(self, preserve=None):
1762
2046
        """Delete everything from the obsolete-packs directory.
 
2047
 
 
2048
        :return: A list of pack identifiers (the filename without '.pack') that
 
2049
            were found in obsolete_packs.
1763
2050
        """
 
2051
        found = []
1764
2052
        obsolete_pack_transport = self.transport.clone('obsolete_packs')
 
2053
        if preserve is None:
 
2054
            preserve = set()
1765
2055
        for filename in obsolete_pack_transport.list_dir('.'):
 
2056
            name, ext = osutils.splitext(filename)
 
2057
            if ext == '.pack':
 
2058
                found.append(name)
 
2059
            if name in preserve:
 
2060
                continue
1766
2061
            try:
1767
2062
                obsolete_pack_transport.delete(filename)
1768
2063
            except (errors.PathError, errors.TransportError), e:
1769
 
                warning("couldn't delete obsolete pack, skipping it:\n%s" % (e,))
 
2064
                warning("couldn't delete obsolete pack, skipping it:\n%s"
 
2065
                        % (e,))
 
2066
        return found
1770
2067
 
1771
2068
    def _start_write_group(self):
1772
2069
        # Do not permit preparation for writing if we're not in a 'write lock'.
1773
2070
        if not self.repo.is_write_locked():
1774
2071
            raise errors.NotWriteLocked(self)
1775
 
        self._new_pack = NewPack(self, upload_suffix='.pack',
 
2072
        self._new_pack = self.pack_factory(self, upload_suffix='.pack',
1776
2073
            file_mode=self.repo.bzrdir._get_file_mode())
1777
2074
        # allow writing: queue writes to a new index
1778
2075
        self.revision_index.add_writable_index(self._new_pack.revision_index,
1781
2078
            self._new_pack)
1782
2079
        self.text_index.add_writable_index(self._new_pack.text_index,
1783
2080
            self._new_pack)
 
2081
        self._new_pack.text_index.set_optimize(combine_backing_indices=False)
1784
2082
        self.signature_index.add_writable_index(self._new_pack.signature_index,
1785
2083
            self._new_pack)
 
2084
        if self.chk_index is not None:
 
2085
            self.chk_index.add_writable_index(self._new_pack.chk_index,
 
2086
                self._new_pack)
 
2087
            self.repo.chk_bytes._index._add_callback = self.chk_index.add_callback
 
2088
            self._new_pack.chk_index.set_optimize(combine_backing_indices=False)
1786
2089
 
1787
2090
        self.repo.inventories._index._add_callback = self.inventory_index.add_callback
1788
2091
        self.repo.revisions._index._add_callback = self.revision_index.add_callback
1793
2096
        # FIXME: just drop the transient index.
1794
2097
        # forget what names there are
1795
2098
        if self._new_pack is not None:
1796
 
            try:
1797
 
                self._new_pack.abort()
1798
 
            finally:
1799
 
                # XXX: If we aborted while in the middle of finishing the write
1800
 
                # group, _remove_pack_indices can fail because the indexes are
1801
 
                # already gone.  If they're not there we shouldn't fail in this
1802
 
                # case.  -- mbp 20081113
1803
 
                self._remove_pack_indices(self._new_pack)
1804
 
                self._new_pack = None
1805
 
        self.repo._text_knit = None
1806
 
 
 
2099
            operation = cleanup.OperationWithCleanups(self._new_pack.abort)
 
2100
            operation.add_cleanup(setattr, self, '_new_pack', None)
 
2101
            # If we aborted while in the middle of finishing the write
 
2102
            # group, _remove_pack_indices could fail because the indexes are
 
2103
            # already gone.  But they're not there we shouldn't fail in this
 
2104
            # case, so we pass ignore_missing=True.
 
2105
            operation.add_cleanup(self._remove_pack_indices, self._new_pack,
 
2106
                ignore_missing=True)
 
2107
            operation.run_simple()
 
2108
        for resumed_pack in self._resumed_packs:
 
2109
            operation = cleanup.OperationWithCleanups(resumed_pack.abort)
 
2110
            # See comment in previous finally block.
 
2111
            operation.add_cleanup(self._remove_pack_indices, resumed_pack,
 
2112
                ignore_missing=True)
 
2113
            operation.run_simple()
 
2114
        del self._resumed_packs[:]
 
2115
 
 
2116
    def _remove_resumed_pack_indices(self):
 
2117
        for resumed_pack in self._resumed_packs:
 
2118
            self._remove_pack_indices(resumed_pack)
 
2119
        del self._resumed_packs[:]
 
2120
 
 
2121
    def _check_new_inventories(self):
 
2122
        """Detect missing inventories in this write group.
 
2123
 
 
2124
        :returns: list of strs, summarising any problems found.  If the list is
 
2125
            empty no problems were found.
 
2126
        """
 
2127
        # The base implementation does no checks.  GCRepositoryPackCollection
 
2128
        # overrides this.
 
2129
        return []
 
2130
        
1807
2131
    def _commit_write_group(self):
 
2132
        all_missing = set()
 
2133
        for prefix, versioned_file in (
 
2134
                ('revisions', self.repo.revisions),
 
2135
                ('inventories', self.repo.inventories),
 
2136
                ('texts', self.repo.texts),
 
2137
                ('signatures', self.repo.signatures),
 
2138
                ):
 
2139
            missing = versioned_file.get_missing_compression_parent_keys()
 
2140
            all_missing.update([(prefix,) + key for key in missing])
 
2141
        if all_missing:
 
2142
            raise errors.BzrCheckError(
 
2143
                "Repository %s has missing compression parent(s) %r "
 
2144
                 % (self.repo, sorted(all_missing)))
 
2145
        problems = self._check_new_inventories()
 
2146
        if problems:
 
2147
            problems_summary = '\n'.join(problems)
 
2148
            raise errors.BzrCheckError(
 
2149
                "Cannot add revision(s) to repository: " + problems_summary)
1808
2150
        self._remove_pack_indices(self._new_pack)
 
2151
        any_new_content = False
1809
2152
        if self._new_pack.data_inserted():
1810
2153
            # get all the data to disk and read to use
1811
2154
            self._new_pack.finish()
1812
2155
            self.allocate(self._new_pack)
1813
2156
            self._new_pack = None
1814
 
            if not self.autopack():
 
2157
            any_new_content = True
 
2158
        else:
 
2159
            self._new_pack.abort()
 
2160
            self._new_pack = None
 
2161
        for resumed_pack in self._resumed_packs:
 
2162
            # XXX: this is a pretty ugly way to turn the resumed pack into a
 
2163
            # properly committed pack.
 
2164
            self._names[resumed_pack.name] = None
 
2165
            self._remove_pack_from_memory(resumed_pack)
 
2166
            resumed_pack.finish()
 
2167
            self.allocate(resumed_pack)
 
2168
            any_new_content = True
 
2169
        del self._resumed_packs[:]
 
2170
        if any_new_content:
 
2171
            result = self.autopack()
 
2172
            if not result:
1815
2173
                # when autopack takes no steps, the names list is still
1816
2174
                # unsaved.
1817
 
                self._save_pack_names()
 
2175
                return self._save_pack_names()
 
2176
            return result
 
2177
        return []
 
2178
 
 
2179
    def _suspend_write_group(self):
 
2180
        tokens = [pack.name for pack in self._resumed_packs]
 
2181
        self._remove_pack_indices(self._new_pack)
 
2182
        if self._new_pack.data_inserted():
 
2183
            # get all the data to disk and read to use
 
2184
            self._new_pack.finish(suspend=True)
 
2185
            tokens.append(self._new_pack.name)
 
2186
            self._new_pack = None
1818
2187
        else:
1819
2188
            self._new_pack.abort()
1820
2189
            self._new_pack = None
1821
 
        self.repo._text_knit = None
 
2190
        self._remove_resumed_pack_indices()
 
2191
        return tokens
 
2192
 
 
2193
    def _resume_write_group(self, tokens):
 
2194
        for token in tokens:
 
2195
            self._resume_pack(token)
1822
2196
 
1823
2197
 
1824
2198
class KnitPackRepository(KnitRepository):
1825
2199
    """Repository with knit objects stored inside pack containers.
1826
 
    
 
2200
 
1827
2201
    The layering for a KnitPackRepository is:
1828
2202
 
1829
2203
    Graph        |  HPSS    | Repository public layer |
1843
2217
      pack file. The GraphIndex layer works in N-tuples and is unaware of any
1844
2218
      semantic value.
1845
2219
    ===================================================
1846
 
    
 
2220
 
1847
2221
    """
1848
2222
 
1849
2223
    def __init__(self, _format, a_bzrdir, control_files, _commit_builder_class,
1856
2230
            self._transport.clone('upload'),
1857
2231
            self._transport.clone('packs'),
1858
2232
            _format.index_builder_class,
1859
 
            _format.index_class)
 
2233
            _format.index_class,
 
2234
            use_chk_index=self._format.supports_chks,
 
2235
            )
1860
2236
        self.inventories = KnitVersionedFiles(
1861
2237
            _KnitGraphIndex(self._pack_collection.inventory_index.combined_index,
1862
2238
                add_callback=self._pack_collection.inventory_index.add_callback,
1866
2242
        self.revisions = KnitVersionedFiles(
1867
2243
            _KnitGraphIndex(self._pack_collection.revision_index.combined_index,
1868
2244
                add_callback=self._pack_collection.revision_index.add_callback,
1869
 
                deltas=False, parents=True, is_locked=self.is_locked),
 
2245
                deltas=False, parents=True, is_locked=self.is_locked,
 
2246
                track_external_parent_refs=True),
1870
2247
            data_access=self._pack_collection.revision_index.data_access,
1871
2248
            max_delta_chain=0)
1872
2249
        self.signatures = KnitVersionedFiles(
1881
2258
                deltas=True, parents=True, is_locked=self.is_locked),
1882
2259
            data_access=self._pack_collection.text_index.data_access,
1883
2260
            max_delta_chain=200)
 
2261
        if _format.supports_chks:
 
2262
            # No graph, no compression:- references from chks are between
 
2263
            # different objects not temporal versions of the same; and without
 
2264
            # some sort of temporal structure knit compression will just fail.
 
2265
            self.chk_bytes = KnitVersionedFiles(
 
2266
                _KnitGraphIndex(self._pack_collection.chk_index.combined_index,
 
2267
                    add_callback=self._pack_collection.chk_index.add_callback,
 
2268
                    deltas=False, parents=False, is_locked=self.is_locked),
 
2269
                data_access=self._pack_collection.chk_index.data_access,
 
2270
                max_delta_chain=0)
 
2271
        else:
 
2272
            self.chk_bytes = None
1884
2273
        # True when the repository object is 'write locked' (as opposed to the
1885
 
        # physical lock only taken out around changes to the pack-names list.) 
 
2274
        # physical lock only taken out around changes to the pack-names list.)
1886
2275
        # Another way to represent this would be a decorator around the control
1887
2276
        # files object that presents logical locks as physical ones - if this
1888
2277
        # gets ugly consider that alternative design. RBC 20071011
1892
2281
        self._reconcile_does_inventory_gc = True
1893
2282
        self._reconcile_fixes_text_parents = True
1894
2283
        self._reconcile_backsup_inventory = False
1895
 
        self._fetch_order = 'unordered'
1896
2284
 
1897
 
    def _warn_if_deprecated(self):
 
2285
    def _warn_if_deprecated(self, branch=None):
1898
2286
        # This class isn't deprecated, but one sub-format is
1899
2287
        if isinstance(self._format, RepositoryFormatKnitPack5RichRootBroken):
1900
 
            from bzrlib import repository
1901
 
            if repository._deprecation_warning_done:
1902
 
                return
1903
 
            repository._deprecation_warning_done = True
1904
 
            warning("Format %s for %s is deprecated - please use"
1905
 
                    " 'bzr upgrade --1.6.1-rich-root'"
1906
 
                    % (self._format, self.bzrdir.transport.base))
 
2288
            super(KnitPackRepository, self)._warn_if_deprecated(branch)
1907
2289
 
1908
2290
    def _abort_write_group(self):
 
2291
        self.revisions._index._key_dependencies.clear()
1909
2292
        self._pack_collection._abort_write_group()
1910
2293
 
1911
 
    def _find_inconsistent_revision_parents(self):
1912
 
        """Find revisions with incorrectly cached parents.
1913
 
 
1914
 
        :returns: an iterator yielding tuples of (revison-id, parents-in-index,
1915
 
            parents-in-revision).
1916
 
        """
1917
 
        if not self.is_locked():
1918
 
            raise errors.ObjectNotLocked(self)
1919
 
        pb = ui.ui_factory.nested_progress_bar()
1920
 
        result = []
1921
 
        try:
1922
 
            revision_nodes = self._pack_collection.revision_index \
1923
 
                .combined_index.iter_all_entries()
1924
 
            index_positions = []
1925
 
            # Get the cached index values for all revisions, and also the location
1926
 
            # in each index of the revision text so we can perform linear IO.
1927
 
            for index, key, value, refs in revision_nodes:
1928
 
                pos, length = value[1:].split(' ')
1929
 
                index_positions.append((index, int(pos), key[0],
1930
 
                    tuple(parent[0] for parent in refs[0])))
1931
 
                pb.update("Reading revision index.", 0, 0)
1932
 
            index_positions.sort()
1933
 
            batch_count = len(index_positions) / 1000 + 1
1934
 
            pb.update("Checking cached revision graph.", 0, batch_count)
1935
 
            for offset in xrange(batch_count):
1936
 
                pb.update("Checking cached revision graph.", offset)
1937
 
                to_query = index_positions[offset * 1000:(offset + 1) * 1000]
1938
 
                if not to_query:
1939
 
                    break
1940
 
                rev_ids = [item[2] for item in to_query]
1941
 
                revs = self.get_revisions(rev_ids)
1942
 
                for revision, item in zip(revs, to_query):
1943
 
                    index_parents = item[3]
1944
 
                    rev_parents = tuple(revision.parent_ids)
1945
 
                    if index_parents != rev_parents:
1946
 
                        result.append((revision.revision_id, index_parents, rev_parents))
1947
 
        finally:
1948
 
            pb.finished()
1949
 
        return result
1950
 
 
1951
 
    @symbol_versioning.deprecated_method(symbol_versioning.one_one)
1952
 
    def get_parents(self, revision_ids):
1953
 
        """See graph._StackedParentsProvider.get_parents."""
1954
 
        parent_map = self.get_parent_map(revision_ids)
1955
 
        return [parent_map.get(r, None) for r in revision_ids]
 
2294
    def _get_source(self, to_format):
 
2295
        if to_format.network_name() == self._format.network_name():
 
2296
            return KnitPackStreamSource(self, to_format)
 
2297
        return super(KnitPackRepository, self)._get_source(to_format)
1956
2298
 
1957
2299
    def _make_parents_provider(self):
1958
2300
        return graph.CachingParentsProvider(self)
1959
2301
 
1960
2302
    def _refresh_data(self):
1961
 
        if self._write_lock_count == 1 or (
1962
 
            self.control_files._lock_count == 1 and
1963
 
            self.control_files._lock_mode == 'r'):
1964
 
            # forget what names there are
1965
 
            self._pack_collection.reset()
1966
 
            # XXX: Better to do an in-memory merge when acquiring a new lock -
1967
 
            # factor out code from _save_pack_names.
1968
 
            self._pack_collection.ensure_loaded()
 
2303
        if not self.is_locked():
 
2304
            return
 
2305
        self._pack_collection.reload_pack_names()
1969
2306
 
1970
2307
    def _start_write_group(self):
1971
2308
        self._pack_collection._start_write_group()
1972
2309
 
1973
2310
    def _commit_write_group(self):
1974
 
        return self._pack_collection._commit_write_group()
 
2311
        hint = self._pack_collection._commit_write_group()
 
2312
        self.revisions._index._key_dependencies.clear()
 
2313
        return hint
 
2314
 
 
2315
    def suspend_write_group(self):
 
2316
        # XXX check self._write_group is self.get_transaction()?
 
2317
        tokens = self._pack_collection._suspend_write_group()
 
2318
        self.revisions._index._key_dependencies.clear()
 
2319
        self._write_group = None
 
2320
        return tokens
 
2321
 
 
2322
    def _resume_write_group(self, tokens):
 
2323
        self._start_write_group()
 
2324
        try:
 
2325
            self._pack_collection._resume_write_group(tokens)
 
2326
        except errors.UnresumableWriteGroup:
 
2327
            self._abort_write_group()
 
2328
            raise
 
2329
        for pack in self._pack_collection._resumed_packs:
 
2330
            self.revisions._index.scan_unvalidated_index(pack.revision_index)
1975
2331
 
1976
2332
    def get_transaction(self):
1977
2333
        if self._write_lock_count:
1986
2342
        return self._write_lock_count
1987
2343
 
1988
2344
    def lock_write(self, token=None):
1989
 
        if not self._write_lock_count and self.is_locked():
 
2345
        """Lock the repository for writes.
 
2346
 
 
2347
        :return: A bzrlib.repository.RepositoryWriteLockResult.
 
2348
        """
 
2349
        locked = self.is_locked()
 
2350
        if not self._write_lock_count and locked:
1990
2351
            raise errors.ReadOnlyError(self)
1991
2352
        self._write_lock_count += 1
1992
2353
        if self._write_lock_count == 1:
1993
2354
            self._transaction = transactions.WriteTransaction()
 
2355
        if not locked:
 
2356
            if 'relock' in debug.debug_flags and self._prev_lock == 'w':
 
2357
                note('%r was write locked again', self)
 
2358
            self._prev_lock = 'w'
1994
2359
            for repo in self._fallback_repositories:
1995
2360
                # Writes don't affect fallback repos
1996
2361
                repo.lock_read()
1997
 
        self._refresh_data()
 
2362
            self._refresh_data()
 
2363
        return RepositoryWriteLockResult(self.unlock, None)
1998
2364
 
1999
2365
    def lock_read(self):
 
2366
        """Lock the repository for reads.
 
2367
 
 
2368
        :return: A bzrlib.lock.LogicalLockResult.
 
2369
        """
 
2370
        locked = self.is_locked()
2000
2371
        if self._write_lock_count:
2001
2372
            self._write_lock_count += 1
2002
2373
        else:
2003
2374
            self.control_files.lock_read()
 
2375
        if not locked:
 
2376
            if 'relock' in debug.debug_flags and self._prev_lock == 'r':
 
2377
                note('%r was read locked again', self)
 
2378
            self._prev_lock = 'r'
2004
2379
            for repo in self._fallback_repositories:
2005
 
                # Writes don't affect fallback repos
2006
2380
                repo.lock_read()
2007
 
        self._refresh_data()
 
2381
            self._refresh_data()
 
2382
        return LogicalLockResult(self.unlock)
2008
2383
 
2009
2384
    def leave_lock_in_place(self):
2010
2385
        # not supported - raise an error
2015
2390
        raise NotImplementedError(self.dont_leave_lock_in_place)
2016
2391
 
2017
2392
    @needs_write_lock
2018
 
    def pack(self):
 
2393
    def pack(self, hint=None, clean_obsolete_packs=False):
2019
2394
        """Compress the data within the repository.
2020
2395
 
2021
2396
        This will pack all the data to a single pack. In future it may
2022
2397
        recompress deltas or do other such expensive operations.
2023
2398
        """
2024
 
        self._pack_collection.pack()
 
2399
        self._pack_collection.pack(hint=hint, clean_obsolete_packs=clean_obsolete_packs)
2025
2400
 
2026
2401
    @needs_write_lock
2027
2402
    def reconcile(self, other=None, thorough=False):
2031
2406
        reconciler.reconcile()
2032
2407
        return reconciler
2033
2408
 
 
2409
    def _reconcile_pack(self, collection, packs, extension, revs, pb):
 
2410
        packer = ReconcilePacker(collection, packs, extension, revs)
 
2411
        return packer.pack(pb)
 
2412
 
 
2413
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2034
2414
    def unlock(self):
2035
2415
        if self._write_lock_count == 1 and self._write_group is not None:
2036
2416
            self.abort_write_group()
2045
2425
                transaction = self._transaction
2046
2426
                self._transaction = None
2047
2427
                transaction.finish()
2048
 
                for repo in self._fallback_repositories:
2049
 
                    repo.unlock()
2050
2428
        else:
2051
2429
            self.control_files.unlock()
 
2430
 
 
2431
        if not self.is_locked():
2052
2432
            for repo in self._fallback_repositories:
2053
2433
                repo.unlock()
2054
2434
 
2055
2435
 
 
2436
class KnitPackStreamSource(StreamSource):
 
2437
    """A StreamSource used to transfer data between same-format KnitPack repos.
 
2438
 
 
2439
    This source assumes:
 
2440
        1) Same serialization format for all objects
 
2441
        2) Same root information
 
2442
        3) XML format inventories
 
2443
        4) Atomic inserts (so we can stream inventory texts before text
 
2444
           content)
 
2445
        5) No chk_bytes
 
2446
    """
 
2447
 
 
2448
    def __init__(self, from_repository, to_format):
 
2449
        super(KnitPackStreamSource, self).__init__(from_repository, to_format)
 
2450
        self._text_keys = None
 
2451
        self._text_fetch_order = 'unordered'
 
2452
 
 
2453
    def _get_filtered_inv_stream(self, revision_ids):
 
2454
        from_repo = self.from_repository
 
2455
        parent_ids = from_repo._find_parent_ids_of_revisions(revision_ids)
 
2456
        parent_keys = [(p,) for p in parent_ids]
 
2457
        find_text_keys = from_repo._find_text_key_references_from_xml_inventory_lines
 
2458
        parent_text_keys = set(find_text_keys(
 
2459
            from_repo._inventory_xml_lines_for_keys(parent_keys)))
 
2460
        content_text_keys = set()
 
2461
        knit = KnitVersionedFiles(None, None)
 
2462
        factory = KnitPlainFactory()
 
2463
        def find_text_keys_from_content(record):
 
2464
            if record.storage_kind not in ('knit-delta-gz', 'knit-ft-gz'):
 
2465
                raise ValueError("Unknown content storage kind for"
 
2466
                    " inventory text: %s" % (record.storage_kind,))
 
2467
            # It's a knit record, it has a _raw_record field (even if it was
 
2468
            # reconstituted from a network stream).
 
2469
            raw_data = record._raw_record
 
2470
            # read the entire thing
 
2471
            revision_id = record.key[-1]
 
2472
            content, _ = knit._parse_record(revision_id, raw_data)
 
2473
            if record.storage_kind == 'knit-delta-gz':
 
2474
                line_iterator = factory.get_linedelta_content(content)
 
2475
            elif record.storage_kind == 'knit-ft-gz':
 
2476
                line_iterator = factory.get_fulltext_content(content)
 
2477
            content_text_keys.update(find_text_keys(
 
2478
                [(line, revision_id) for line in line_iterator]))
 
2479
        revision_keys = [(r,) for r in revision_ids]
 
2480
        def _filtered_inv_stream():
 
2481
            source_vf = from_repo.inventories
 
2482
            stream = source_vf.get_record_stream(revision_keys,
 
2483
                                                 'unordered', False)
 
2484
            for record in stream:
 
2485
                if record.storage_kind == 'absent':
 
2486
                    raise errors.NoSuchRevision(from_repo, record.key)
 
2487
                find_text_keys_from_content(record)
 
2488
                yield record
 
2489
            self._text_keys = content_text_keys - parent_text_keys
 
2490
        return ('inventories', _filtered_inv_stream())
 
2491
 
 
2492
    def _get_text_stream(self):
 
2493
        # Note: We know we don't have to handle adding root keys, because both
 
2494
        # the source and target are the identical network name.
 
2495
        text_stream = self.from_repository.texts.get_record_stream(
 
2496
                        self._text_keys, self._text_fetch_order, False)
 
2497
        return ('texts', text_stream)
 
2498
 
 
2499
    def get_stream(self, search):
 
2500
        revision_ids = search.get_keys()
 
2501
        for stream_info in self._fetch_revision_texts(revision_ids):
 
2502
            yield stream_info
 
2503
        self._revision_keys = [(rev_id,) for rev_id in revision_ids]
 
2504
        yield self._get_filtered_inv_stream(revision_ids)
 
2505
        yield self._get_text_stream()
 
2506
 
 
2507
 
 
2508
 
2056
2509
class RepositoryFormatPack(MetaDirRepositoryFormat):
2057
2510
    """Format logic for pack structured repositories.
2058
2511
 
2078
2531
    # Set this attribute in derived clases to control the _serializer that the
2079
2532
    # repository objects will have passed to their constructor.
2080
2533
    _serializer = None
 
2534
    # Packs are not confused by ghosts.
 
2535
    supports_ghosts = True
2081
2536
    # External references are not supported in pack repositories yet.
2082
2537
    supports_external_lookups = False
 
2538
    # Most pack formats do not use chk lookups.
 
2539
    supports_chks = False
2083
2540
    # What index classes to use
2084
2541
    index_builder_class = None
2085
2542
    index_class = None
 
2543
    _fetch_uses_deltas = True
 
2544
    fast_deltas = False
2086
2545
 
2087
2546
    def initialize(self, a_bzrdir, shared=False):
2088
2547
        """Create a pack based repository.
2097
2556
        builder = self.index_builder_class()
2098
2557
        files = [('pack-names', builder.finish())]
2099
2558
        utf8_files = [('format', self.get_format_string())]
2100
 
        
 
2559
 
2101
2560
        self._upload_blank_content(a_bzrdir, dirs, files, utf8_files, shared)
2102
 
        return self.open(a_bzrdir=a_bzrdir, _found=True)
 
2561
        repository = self.open(a_bzrdir=a_bzrdir, _found=True)
 
2562
        self._run_post_repo_init_hooks(repository, a_bzrdir, shared)
 
2563
        return repository
2103
2564
 
2104
2565
    def open(self, a_bzrdir, _found=False, _override_transport=None):
2105
2566
        """See RepositoryFormat.open().
2106
 
        
 
2567
 
2107
2568
        :param _override_transport: INTERNAL USE ONLY. Allows opening the
2108
2569
                                    repository at a slightly different url
2109
2570
                                    than normal. I.e. during 'upgrade'.
2154
2615
        """See RepositoryFormat.get_format_description()."""
2155
2616
        return "Packs containing knits without subtree support"
2156
2617
 
2157
 
    def check_conversion_target(self, target_format):
2158
 
        pass
2159
 
 
2160
2618
 
2161
2619
class RepositoryFormatKnitPack3(RepositoryFormatPack):
2162
2620
    """A subtrees parameterized Pack repository.
2171
2629
    repository_class = KnitPackRepository
2172
2630
    _commit_builder_class = PackRootCommitBuilder
2173
2631
    rich_root_data = True
 
2632
    experimental = True
2174
2633
    supports_tree_reference = True
2175
2634
    @property
2176
2635
    def _serializer(self):
2188
2647
 
2189
2648
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2190
2649
 
2191
 
    def check_conversion_target(self, target_format):
2192
 
        if not target_format.rich_root_data:
2193
 
            raise errors.BadConversionTarget(
2194
 
                'Does not support rich root data.', target_format)
2195
 
        if not getattr(target_format, 'supports_tree_reference', False):
2196
 
            raise errors.BadConversionTarget(
2197
 
                'Does not support nested trees', target_format)
2198
 
            
2199
2650
    def get_format_string(self):
2200
2651
        """See RepositoryFormat.get_format_string()."""
2201
2652
        return "Bazaar pack repository format 1 with subtree support (needs bzr 0.92)\n"
2234
2685
 
2235
2686
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2236
2687
 
2237
 
    def check_conversion_target(self, target_format):
2238
 
        if not target_format.rich_root_data:
2239
 
            raise errors.BadConversionTarget(
2240
 
                'Does not support rich root data.', target_format)
2241
 
 
2242
2688
    def get_format_string(self):
2243
2689
        """See RepositoryFormat.get_format_string()."""
2244
2690
        return ("Bazaar pack repository format 1 with rich root"
2285
2731
        """See RepositoryFormat.get_format_description()."""
2286
2732
        return "Packs 5 (adds stacking support, requires bzr 1.6)"
2287
2733
 
2288
 
    def check_conversion_target(self, target_format):
2289
 
        pass
2290
 
 
2291
2734
 
2292
2735
class RepositoryFormatKnitPack5RichRoot(RepositoryFormatPack):
2293
2736
    """A repository with rich roots and stacking.
2320
2763
 
2321
2764
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2322
2765
 
2323
 
    def check_conversion_target(self, target_format):
2324
 
        if not target_format.rich_root_data:
2325
 
            raise errors.BadConversionTarget(
2326
 
                'Does not support rich root data.', target_format)
2327
 
 
2328
2766
    def get_format_string(self):
2329
2767
        """See RepositoryFormat.get_format_string()."""
2330
2768
        return "Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6.1)\n"
2371
2809
 
2372
2810
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2373
2811
 
2374
 
    def check_conversion_target(self, target_format):
2375
 
        if not target_format.rich_root_data:
2376
 
            raise errors.BadConversionTarget(
2377
 
                'Does not support rich root data.', target_format)
2378
 
 
2379
2812
    def get_format_string(self):
2380
2813
        """See RepositoryFormat.get_format_string()."""
2381
2814
        return "Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6)\n"
2419
2852
        """See RepositoryFormat.get_format_description()."""
2420
2853
        return "Packs 6 (uses btree indexes, requires bzr 1.9)"
2421
2854
 
2422
 
    def check_conversion_target(self, target_format):
2423
 
        pass
2424
 
 
2425
2855
 
2426
2856
class RepositoryFormatKnitPack6RichRoot(RepositoryFormatPack):
2427
2857
    """A repository with rich roots, no subtrees, stacking and btree indexes.
2451
2881
 
2452
2882
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2453
2883
 
2454
 
    def check_conversion_target(self, target_format):
2455
 
        if not target_format.rich_root_data:
2456
 
            raise errors.BadConversionTarget(
2457
 
                'Does not support rich root data.', target_format)
2458
 
 
2459
2884
    def get_format_string(self):
2460
2885
        """See RepositoryFormat.get_format_string()."""
2461
2886
        return "Bazaar RepositoryFormatKnitPack6RichRoot (bzr 1.9)\n"
2464
2889
        return "Packs 6 rich-root (uses btree indexes, requires bzr 1.9)"
2465
2890
 
2466
2891
 
2467
 
class RepositoryFormatPackDevelopment2(RepositoryFormatPack):
2468
 
    """A no-subtrees development repository.
2469
 
 
2470
 
    This format should be retained until the second release after bzr 1.7.
2471
 
 
2472
 
    This is pack-1.6.1 with B+Tree indices.
2473
 
    """
2474
 
 
2475
 
    repository_class = KnitPackRepository
2476
 
    _commit_builder_class = PackCommitBuilder
2477
 
    supports_external_lookups = True
2478
 
    # What index classes to use
2479
 
    index_builder_class = BTreeBuilder
2480
 
    index_class = BTreeGraphIndex
2481
 
 
2482
 
    @property
2483
 
    def _serializer(self):
2484
 
        return xml5.serializer_v5
2485
 
 
2486
 
    def _get_matching_bzrdir(self):
2487
 
        return bzrdir.format_registry.make_bzrdir('development2')
2488
 
 
2489
 
    def _ignore_setting_bzrdir(self, format):
2490
 
        pass
2491
 
 
2492
 
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2493
 
 
2494
 
    def get_format_string(self):
2495
 
        """See RepositoryFormat.get_format_string()."""
2496
 
        return "Bazaar development format 2 (needs bzr.dev from before 1.8)\n"
2497
 
 
2498
 
    def get_format_description(self):
2499
 
        """See RepositoryFormat.get_format_description()."""
2500
 
        return ("Development repository format, currently the same as "
2501
 
            "1.6.1 with B+Trees.\n")
2502
 
 
2503
 
    def check_conversion_target(self, target_format):
2504
 
        pass
2505
 
 
2506
 
 
2507
2892
class RepositoryFormatPackDevelopment2Subtree(RepositoryFormatPack):
2508
2893
    """A subtrees development repository.
2509
2894
 
2510
2895
    This format should be retained until the second release after bzr 1.7.
2511
2896
 
2512
2897
    1.6.1-subtree[as it might have been] with B+Tree indices.
 
2898
 
 
2899
    This is [now] retained until we have a CHK based subtree format in
 
2900
    development.
2513
2901
    """
2514
2902
 
2515
2903
    repository_class = KnitPackRepository
2516
2904
    _commit_builder_class = PackRootCommitBuilder
2517
2905
    rich_root_data = True
 
2906
    experimental = True
2518
2907
    supports_tree_reference = True
2519
2908
    supports_external_lookups = True
2520
2909
    # What index classes to use
2527
2916
 
2528
2917
    def _get_matching_bzrdir(self):
2529
2918
        return bzrdir.format_registry.make_bzrdir(
2530
 
            'development2-subtree')
 
2919
            'development-subtree')
2531
2920
 
2532
2921
    def _ignore_setting_bzrdir(self, format):
2533
2922
        pass
2534
2923
 
2535
2924
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2536
2925
 
2537
 
    def check_conversion_target(self, target_format):
2538
 
        if not target_format.rich_root_data:
2539
 
            raise errors.BadConversionTarget(
2540
 
                'Does not support rich root data.', target_format)
2541
 
        if not getattr(target_format, 'supports_tree_reference', False):
2542
 
            raise errors.BadConversionTarget(
2543
 
                'Does not support nested trees', target_format)
2544
 
            
2545
2926
    def get_format_string(self):
2546
2927
        """See RepositoryFormat.get_format_string()."""
2547
2928
        return ("Bazaar development format 2 with subtree support "
2551
2932
        """See RepositoryFormat.get_format_description()."""
2552
2933
        return ("Development repository format, currently the same as "
2553
2934
            "1.6.1-subtree with B+Tree indices.\n")
 
2935