/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/repofmt/pack_repo.py

  • Committer: Martin von Gagern
  • Date: 2010-04-20 08:47:38 UTC
  • mfrom: (5167 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5195.
  • Revision ID: martin.vgagern@gmx.net-20100420084738-ygymnqmdllzrhpfn
merge trunk

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
 
 
17
import re
 
18
import sys
16
19
 
17
20
from bzrlib.lazy_import import lazy_import
18
21
lazy_import(globals(), """
20
23
import time
21
24
 
22
25
from bzrlib import (
 
26
    chk_map,
 
27
    cleanup,
23
28
    debug,
24
29
    graph,
25
30
    osutils,
26
31
    pack,
27
32
    transactions,
28
33
    ui,
 
34
    xml5,
 
35
    xml6,
 
36
    xml7,
29
37
    )
30
38
from bzrlib.index import (
31
39
    CombinedGraphIndex,
32
 
    GraphIndex,
33
 
    GraphIndexBuilder,
34
40
    GraphIndexPrefixAdapter,
35
 
    InMemoryGraphIndex,
36
41
    )
37
42
from bzrlib.knit import (
38
43
    KnitPlainFactory,
47
52
    errors,
48
53
    lockable_files,
49
54
    lockdir,
50
 
    symbol_versioning,
51
 
    xml5,
52
 
    xml6,
53
 
    xml7,
 
55
    revision as _mod_revision,
54
56
    )
55
57
 
56
 
from bzrlib.decorators import needs_write_lock
 
58
from bzrlib.decorators import needs_write_lock, only_raises
57
59
from bzrlib.btree_index import (
58
60
    BTreeGraphIndex,
59
61
    BTreeBuilder,
68
70
    MetaDirRepositoryFormat,
69
71
    RepositoryFormat,
70
72
    RootCommitBuilder,
 
73
    StreamSource,
71
74
    )
72
 
import bzrlib.revision as _mod_revision
73
75
from bzrlib.trace import (
74
76
    mutter,
 
77
    note,
75
78
    warning,
76
79
    )
77
80
 
78
81
 
79
82
class PackCommitBuilder(CommitBuilder):
80
83
    """A subclass of CommitBuilder to add texts with pack semantics.
81
 
    
 
84
 
82
85
    Specifically this uses one knit object rather than one knit object per
83
86
    added text, reducing memory and object pressure.
84
87
    """
99
102
 
100
103
class PackRootCommitBuilder(RootCommitBuilder):
101
104
    """A subclass of RootCommitBuilder to add texts with pack semantics.
102
 
    
 
105
 
103
106
    Specifically this uses one knit object rather than one knit object per
104
107
    added text, reducing memory and object pressure.
105
108
    """
125
128
    ExistingPack and NewPack are used.
126
129
    """
127
130
 
 
131
    # A map of index 'type' to the file extension and position in the
 
132
    # index_sizes array.
 
133
    index_definitions = {
 
134
        'chk': ('.cix', 4),
 
135
        'revision': ('.rix', 0),
 
136
        'inventory': ('.iix', 1),
 
137
        'text': ('.tix', 2),
 
138
        'signature': ('.six', 3),
 
139
        }
 
140
 
128
141
    def __init__(self, revision_index, inventory_index, text_index,
129
 
        signature_index):
 
142
        signature_index, chk_index=None):
130
143
        """Create a pack instance.
131
144
 
132
145
        :param revision_index: A GraphIndex for determining what revisions are
139
152
            texts/deltas (via (fileid, revisionid) tuples).
140
153
        :param signature_index: A GraphIndex for determining what signatures are
141
154
            present in the Pack and accessing the locations of their texts.
 
155
        :param chk_index: A GraphIndex for accessing content by CHK, if the
 
156
            pack has one.
142
157
        """
143
158
        self.revision_index = revision_index
144
159
        self.inventory_index = inventory_index
145
160
        self.text_index = text_index
146
161
        self.signature_index = signature_index
 
162
        self.chk_index = chk_index
147
163
 
148
164
    def access_tuple(self):
149
165
        """Return a tuple (transport, name) for the pack content."""
150
166
        return self.pack_transport, self.file_name()
151
167
 
 
168
    def _check_references(self):
 
169
        """Make sure our external references are present.
 
170
 
 
171
        Packs are allowed to have deltas whose base is not in the pack, but it
 
172
        must be present somewhere in this collection.  It is not allowed to
 
173
        have deltas based on a fallback repository.
 
174
        (See <https://bugs.launchpad.net/bzr/+bug/288751>)
 
175
        """
 
176
        missing_items = {}
 
177
        for (index_name, external_refs, index) in [
 
178
            ('texts',
 
179
                self._get_external_refs(self.text_index),
 
180
                self._pack_collection.text_index.combined_index),
 
181
            ('inventories',
 
182
                self._get_external_refs(self.inventory_index),
 
183
                self._pack_collection.inventory_index.combined_index),
 
184
            ]:
 
185
            missing = external_refs.difference(
 
186
                k for (idx, k, v, r) in
 
187
                index.iter_entries(external_refs))
 
188
            if missing:
 
189
                missing_items[index_name] = sorted(list(missing))
 
190
        if missing_items:
 
191
            from pprint import pformat
 
192
            raise errors.BzrCheckError(
 
193
                "Newly created pack file %r has delta references to "
 
194
                "items not in its repository:\n%s"
 
195
                % (self, pformat(missing_items)))
 
196
 
152
197
    def file_name(self):
153
198
        """Get the file name for the pack on disk."""
154
199
        return self.name + '.pack'
156
201
    def get_revision_count(self):
157
202
        return self.revision_index.key_count()
158
203
 
 
204
    def index_name(self, index_type, name):
 
205
        """Get the disk name of an index type for pack name 'name'."""
 
206
        return name + Pack.index_definitions[index_type][0]
 
207
 
 
208
    def index_offset(self, index_type):
 
209
        """Get the position in a index_size array for a given index type."""
 
210
        return Pack.index_definitions[index_type][1]
 
211
 
159
212
    def inventory_index_name(self, name):
160
213
        """The inv index is the name + .iix."""
161
214
        return self.index_name('inventory', name)
172
225
        """The text index is the name + .tix."""
173
226
        return self.index_name('text', name)
174
227
 
175
 
    def _external_compression_parents_of_texts(self):
176
 
        keys = set()
177
 
        refs = set()
178
 
        for node in self.text_index.iter_all_entries():
179
 
            keys.add(node[1])
180
 
            refs.update(node[3][1])
181
 
        return refs - keys
 
228
    def _replace_index_with_readonly(self, index_type):
 
229
        unlimited_cache = False
 
230
        if index_type == 'chk':
 
231
            unlimited_cache = True
 
232
        setattr(self, index_type + '_index',
 
233
            self.index_class(self.index_transport,
 
234
                self.index_name(index_type, self.name),
 
235
                self.index_sizes[self.index_offset(index_type)],
 
236
                unlimited_cache=unlimited_cache))
182
237
 
183
238
 
184
239
class ExistingPack(Pack):
185
240
    """An in memory proxy for an existing .pack and its disk indices."""
186
241
 
187
242
    def __init__(self, pack_transport, name, revision_index, inventory_index,
188
 
        text_index, signature_index):
 
243
        text_index, signature_index, chk_index=None):
189
244
        """Create an ExistingPack object.
190
245
 
191
246
        :param pack_transport: The transport where the pack file resides.
192
247
        :param name: The name of the pack on disk in the pack_transport.
193
248
        """
194
249
        Pack.__init__(self, revision_index, inventory_index, text_index,
195
 
            signature_index)
 
250
            signature_index, chk_index)
196
251
        self.name = name
197
252
        self.pack_transport = pack_transport
198
253
        if None in (revision_index, inventory_index, text_index,
206
261
        return not self.__eq__(other)
207
262
 
208
263
    def __repr__(self):
209
 
        return "<bzrlib.repofmt.pack_repo.Pack object at 0x%x, %s, %s" % (
210
 
            id(self), self.pack_transport, self.name)
 
264
        return "<%s.%s object at 0x%x, %s, %s" % (
 
265
            self.__class__.__module__, self.__class__.__name__, id(self),
 
266
            self.pack_transport, self.name)
 
267
 
 
268
 
 
269
class ResumedPack(ExistingPack):
 
270
 
 
271
    def __init__(self, name, revision_index, inventory_index, text_index,
 
272
        signature_index, upload_transport, pack_transport, index_transport,
 
273
        pack_collection, chk_index=None):
 
274
        """Create a ResumedPack object."""
 
275
        ExistingPack.__init__(self, pack_transport, name, revision_index,
 
276
            inventory_index, text_index, signature_index,
 
277
            chk_index=chk_index)
 
278
        self.upload_transport = upload_transport
 
279
        self.index_transport = index_transport
 
280
        self.index_sizes = [None, None, None, None]
 
281
        indices = [
 
282
            ('revision', revision_index),
 
283
            ('inventory', inventory_index),
 
284
            ('text', text_index),
 
285
            ('signature', signature_index),
 
286
            ]
 
287
        if chk_index is not None:
 
288
            indices.append(('chk', chk_index))
 
289
            self.index_sizes.append(None)
 
290
        for index_type, index in indices:
 
291
            offset = self.index_offset(index_type)
 
292
            self.index_sizes[offset] = index._size
 
293
        self.index_class = pack_collection._index_class
 
294
        self._pack_collection = pack_collection
 
295
        self._state = 'resumed'
 
296
        # XXX: perhaps check that the .pack file exists?
 
297
 
 
298
    def access_tuple(self):
 
299
        if self._state == 'finished':
 
300
            return Pack.access_tuple(self)
 
301
        elif self._state == 'resumed':
 
302
            return self.upload_transport, self.file_name()
 
303
        else:
 
304
            raise AssertionError(self._state)
 
305
 
 
306
    def abort(self):
 
307
        self.upload_transport.delete(self.file_name())
 
308
        indices = [self.revision_index, self.inventory_index, self.text_index,
 
309
            self.signature_index]
 
310
        if self.chk_index is not None:
 
311
            indices.append(self.chk_index)
 
312
        for index in indices:
 
313
            index._transport.delete(index._name)
 
314
 
 
315
    def finish(self):
 
316
        self._check_references()
 
317
        index_types = ['revision', 'inventory', 'text', 'signature']
 
318
        if self.chk_index is not None:
 
319
            index_types.append('chk')
 
320
        for index_type in index_types:
 
321
            old_name = self.index_name(index_type, self.name)
 
322
            new_name = '../indices/' + old_name
 
323
            self.upload_transport.rename(old_name, new_name)
 
324
            self._replace_index_with_readonly(index_type)
 
325
        new_name = '../packs/' + self.file_name()
 
326
        self.upload_transport.rename(self.file_name(), new_name)
 
327
        self._state = 'finished'
 
328
 
 
329
    def _get_external_refs(self, index):
 
330
        """Return compression parents for this index that are not present.
 
331
 
 
332
        This returns any compression parents that are referenced by this index,
 
333
        which are not contained *in* this index. They may be present elsewhere.
 
334
        """
 
335
        return index.external_references(1)
211
336
 
212
337
 
213
338
class NewPack(Pack):
214
339
    """An in memory proxy for a pack which is being created."""
215
340
 
216
 
    # A map of index 'type' to the file extension and position in the
217
 
    # index_sizes array.
218
 
    index_definitions = {
219
 
        'revision': ('.rix', 0),
220
 
        'inventory': ('.iix', 1),
221
 
        'text': ('.tix', 2),
222
 
        'signature': ('.six', 3),
223
 
        }
224
 
 
225
 
    def __init__(self, upload_transport, index_transport, pack_transport,
226
 
        upload_suffix='', file_mode=None, index_builder_class=None,
227
 
        index_class=None):
 
341
    def __init__(self, pack_collection, upload_suffix='', file_mode=None):
228
342
        """Create a NewPack instance.
229
343
 
230
 
        :param upload_transport: A writable transport for the pack to be
231
 
            incrementally uploaded to.
232
 
        :param index_transport: A writable transport for the pack's indices to
233
 
            be written to when the pack is finished.
234
 
        :param pack_transport: A writable transport for the pack to be renamed
235
 
            to when the upload is complete. This *must* be the same as
236
 
            upload_transport.clone('../packs').
 
344
        :param pack_collection: A PackCollection into which this is being inserted.
237
345
        :param upload_suffix: An optional suffix to be given to any temporary
238
346
            files created during the pack creation. e.g '.autopack'
239
 
        :param file_mode: An optional file mode to create the new files with.
240
 
        :param index_builder_class: Required keyword parameter - the class of
241
 
            index builder to use.
242
 
        :param index_class: Required keyword parameter - the class of index
243
 
            object to use.
 
347
        :param file_mode: Unix permissions for newly created file.
244
348
        """
245
349
        # The relative locations of the packs are constrained, but all are
246
350
        # passed in because the caller has them, so as to avoid object churn.
 
351
        index_builder_class = pack_collection._index_builder_class
 
352
        if pack_collection.chk_index is not None:
 
353
            chk_index = index_builder_class(reference_lists=0)
 
354
        else:
 
355
            chk_index = None
247
356
        Pack.__init__(self,
248
357
            # Revisions: parents list, no text compression.
249
358
            index_builder_class(reference_lists=1),
258
367
            # Signatures: Just blobs to store, no compression, no parents
259
368
            # listing.
260
369
            index_builder_class(reference_lists=0),
 
370
            # CHK based storage - just blobs, no compression or parents.
 
371
            chk_index=chk_index
261
372
            )
 
373
        self._pack_collection = pack_collection
262
374
        # When we make readonly indices, we need this.
263
 
        self.index_class = index_class
 
375
        self.index_class = pack_collection._index_class
264
376
        # where should the new pack be opened
265
 
        self.upload_transport = upload_transport
 
377
        self.upload_transport = pack_collection._upload_transport
266
378
        # where are indices written out to
267
 
        self.index_transport = index_transport
 
379
        self.index_transport = pack_collection._index_transport
268
380
        # where is the pack renamed to when it is finished?
269
 
        self.pack_transport = pack_transport
 
381
        self.pack_transport = pack_collection._pack_transport
270
382
        # What file mode to upload the pack and indices with.
271
383
        self._file_mode = file_mode
272
384
        # tracks the content written to the .pack file.
273
385
        self._hash = osutils.md5()
274
 
        # a four-tuple with the length in bytes of the indices, once the pack
275
 
        # is finalised. (rev, inv, text, sigs)
 
386
        # a tuple with the length in bytes of the indices, once the pack
 
387
        # is finalised. (rev, inv, text, sigs, chk_if_in_use)
276
388
        self.index_sizes = None
277
389
        # How much data to cache when writing packs. Note that this is not
278
390
        # synchronised with reads, because it's not in the transport layer, so
290
402
            mutter('%s: create_pack: pack stream open: %s%s t+%6.3fs',
291
403
                time.ctime(), self.upload_transport.base, self.random_name,
292
404
                time.time() - self.start_time)
293
 
        # A list of byte sequences to be written to the new pack, and the 
294
 
        # aggregate size of them.  Stored as a list rather than separate 
 
405
        # A list of byte sequences to be written to the new pack, and the
 
406
        # aggregate size of them.  Stored as a list rather than separate
295
407
        # variables so that the _write_data closure below can update them.
296
408
        self._buffer = [[], 0]
297
 
        # create a callable for adding data 
 
409
        # create a callable for adding data
298
410
        #
299
411
        # robertc says- this is a closure rather than a method on the object
300
412
        # so that the variables are locals, and faster than accessing object
316
428
        self._writer.begin()
317
429
        # what state is the pack in? (open, finished, aborted)
318
430
        self._state = 'open'
 
431
        # no name until we finish writing the content
 
432
        self.name = None
319
433
 
320
434
    def abort(self):
321
435
        """Cancel creating this pack."""
339
453
        return bool(self.get_revision_count() or
340
454
            self.inventory_index.key_count() or
341
455
            self.text_index.key_count() or
342
 
            self.signature_index.key_count())
343
 
 
344
 
    def finish(self):
 
456
            self.signature_index.key_count() or
 
457
            (self.chk_index is not None and self.chk_index.key_count()))
 
458
 
 
459
    def finish_content(self):
 
460
        if self.name is not None:
 
461
            return
 
462
        self._writer.end()
 
463
        if self._buffer[1]:
 
464
            self._write_data('', flush=True)
 
465
        self.name = self._hash.hexdigest()
 
466
 
 
467
    def finish(self, suspend=False):
345
468
        """Finish the new pack.
346
469
 
347
470
        This:
352
475
         - stores the index size tuple for the pack in the index_sizes
353
476
           attribute.
354
477
        """
355
 
        self._writer.end()
356
 
        if self._buffer[1]:
357
 
            self._write_data('', flush=True)
358
 
        self.name = self._hash.hexdigest()
 
478
        self.finish_content()
 
479
        if not suspend:
 
480
            self._check_references()
359
481
        # write indices
360
482
        # XXX: It'd be better to write them all to temporary names, then
361
483
        # rename them all into place, so that the window when only some are
362
484
        # visible is smaller.  On the other hand none will be seen until
363
485
        # they're in the names list.
364
486
        self.index_sizes = [None, None, None, None]
365
 
        self._write_index('revision', self.revision_index, 'revision')
366
 
        self._write_index('inventory', self.inventory_index, 'inventory')
367
 
        self._write_index('text', self.text_index, 'file texts')
 
487
        self._write_index('revision', self.revision_index, 'revision', suspend)
 
488
        self._write_index('inventory', self.inventory_index, 'inventory',
 
489
            suspend)
 
490
        self._write_index('text', self.text_index, 'file texts', suspend)
368
491
        self._write_index('signature', self.signature_index,
369
 
            'revision signatures')
 
492
            'revision signatures', suspend)
 
493
        if self.chk_index is not None:
 
494
            self.index_sizes.append(None)
 
495
            self._write_index('chk', self.chk_index,
 
496
                'content hash bytes', suspend)
370
497
        self.write_stream.close()
371
498
        # Note that this will clobber an existing pack with the same name,
372
499
        # without checking for hash collisions. While this is undesirable this
379
506
        #  - try for HASH.pack
380
507
        #  - try for temporary-name
381
508
        #  - refresh the pack-list to see if the pack is now absent
382
 
        self.upload_transport.rename(self.random_name,
383
 
                '../packs/' + self.name + '.pack')
 
509
        new_name = self.name + '.pack'
 
510
        if not suspend:
 
511
            new_name = '../packs/' + new_name
 
512
        self.upload_transport.rename(self.random_name, new_name)
384
513
        self._state = 'finished'
385
514
        if 'pack' in debug.debug_flags:
386
515
            # XXX: size might be interesting?
387
 
            mutter('%s: create_pack: pack renamed into place: %s%s->%s%s t+%6.3fs',
 
516
            mutter('%s: create_pack: pack finished: %s%s->%s t+%6.3fs',
388
517
                time.ctime(), self.upload_transport.base, self.random_name,
389
 
                self.pack_transport, self.name,
390
 
                time.time() - self.start_time)
 
518
                new_name, time.time() - self.start_time)
391
519
 
392
520
    def flush(self):
393
521
        """Flush any current data."""
397
525
            self._hash.update(bytes)
398
526
            self._buffer[:] = [[], 0]
399
527
 
400
 
    def index_name(self, index_type, name):
401
 
        """Get the disk name of an index type for pack name 'name'."""
402
 
        return name + NewPack.index_definitions[index_type][0]
403
 
 
404
 
    def index_offset(self, index_type):
405
 
        """Get the position in a index_size array for a given index type."""
406
 
        return NewPack.index_definitions[index_type][1]
407
 
 
408
 
    def _replace_index_with_readonly(self, index_type):
409
 
        setattr(self, index_type + '_index',
410
 
            self.index_class(self.index_transport,
411
 
                self.index_name(index_type, self.name),
412
 
                self.index_sizes[self.index_offset(index_type)]))
 
528
    def _get_external_refs(self, index):
 
529
        return index._external_references()
413
530
 
414
531
    def set_write_cache_size(self, size):
415
532
        self._cache_limit = size
416
533
 
417
 
    def _write_index(self, index_type, index, label):
 
534
    def _write_index(self, index_type, index, label, suspend=False):
418
535
        """Write out an index.
419
536
 
420
537
        :param index_type: The type of index to write - e.g. 'revision'.
422
539
        :param label: What label to give the index e.g. 'revision'.
423
540
        """
424
541
        index_name = self.index_name(index_type, self.name)
425
 
        self.index_sizes[self.index_offset(index_type)] = \
426
 
            self.index_transport.put_file(index_name, index.finish(),
427
 
            mode=self._file_mode)
 
542
        if suspend:
 
543
            transport = self.upload_transport
 
544
        else:
 
545
            transport = self.index_transport
 
546
        self.index_sizes[self.index_offset(index_type)] = transport.put_file(
 
547
            index_name, index.finish(), mode=self._file_mode)
428
548
        if 'pack' in debug.debug_flags:
429
549
            # XXX: size might be interesting?
430
550
            mutter('%s: create_pack: wrote %s index: %s%s t+%6.3fs',
431
551
                time.ctime(), label, self.upload_transport.base,
432
552
                self.random_name, time.time() - self.start_time)
433
 
        # Replace the writable index on this object with a readonly, 
 
553
        # Replace the writable index on this object with a readonly,
434
554
        # presently unloaded index. We should alter
435
555
        # the index layer to make its finish() error if add_node is
436
556
        # subsequently used. RBC
445
565
    such as 'revision index'.
446
566
 
447
567
    A CombinedIndex provides an index on a single key space built up
448
 
    from several on-disk indices.  The AggregateIndex builds on this 
 
568
    from several on-disk indices.  The AggregateIndex builds on this
449
569
    to provide a knit access layer, and allows having up to one writable
450
570
    index within the collection.
451
571
    """
452
572
    # XXX: Probably 'can be written to' could/should be separated from 'acts
453
573
    # like a knit index' -- mbp 20071024
454
574
 
455
 
    def __init__(self):
456
 
        """Create an AggregateIndex."""
 
575
    def __init__(self, reload_func=None, flush_func=None):
 
576
        """Create an AggregateIndex.
 
577
 
 
578
        :param reload_func: A function to call if we find we are missing an
 
579
            index. Should have the form reload_func() => True if the list of
 
580
            active pack files has changed.
 
581
        """
 
582
        self._reload_func = reload_func
457
583
        self.index_to_pack = {}
458
 
        self.combined_index = CombinedGraphIndex([])
459
 
        self.data_access = _DirectPackAccess(self.index_to_pack)
460
 
        self.add_callback = None
461
 
 
462
 
    def replace_indices(self, index_to_pack, indices):
463
 
        """Replace the current mappings with fresh ones.
464
 
 
465
 
        This should probably not be used eventually, rather incremental add and
466
 
        removal of indices. It has been added during refactoring of existing
467
 
        code.
468
 
 
469
 
        :param index_to_pack: A mapping from index objects to
470
 
            (transport, name) tuples for the pack file data.
471
 
        :param indices: A list of indices.
472
 
        """
473
 
        # refresh the revision pack map dict without replacing the instance.
474
 
        self.index_to_pack.clear()
475
 
        self.index_to_pack.update(index_to_pack)
476
 
        # XXX: API break - clearly a 'replace' method would be good?
477
 
        self.combined_index._indices[:] = indices
478
 
        # the current add nodes callback for the current writable index if
479
 
        # there is one.
 
584
        self.combined_index = CombinedGraphIndex([], reload_func=reload_func)
 
585
        self.data_access = _DirectPackAccess(self.index_to_pack,
 
586
                                             reload_func=reload_func,
 
587
                                             flush_func=flush_func)
480
588
        self.add_callback = None
481
589
 
482
590
    def add_index(self, index, pack):
484
592
 
485
593
        Future searches on the aggregate index will seach this new index
486
594
        before all previously inserted indices.
487
 
        
 
595
 
488
596
        :param index: An Index for the pack.
489
597
        :param pack: A Pack instance.
490
598
        """
491
599
        # expose it to the index map
492
600
        self.index_to_pack[index] = pack.access_tuple()
493
601
        # put it at the front of the linear index list
494
 
        self.combined_index.insert_index(0, index)
 
602
        self.combined_index.insert_index(0, index, pack.name)
495
603
 
496
604
    def add_writable_index(self, index, pack):
497
605
        """Add an index which is able to have data added to it.
498
606
 
499
607
        There can be at most one writable index at any time.  Any
500
608
        modifications made to the knit are put into this index.
501
 
        
 
609
 
502
610
        :param index: An index from the pack parameter.
503
611
        :param pack: A Pack instance.
504
612
        """
517
625
        self.data_access.set_writer(None, None, (None, None))
518
626
        self.index_to_pack.clear()
519
627
        del self.combined_index._indices[:]
 
628
        del self.combined_index._index_names[:]
520
629
        self.add_callback = None
521
630
 
522
 
    def remove_index(self, index, pack):
 
631
    def remove_index(self, index):
523
632
        """Remove index from the indices used to answer queries.
524
 
        
 
633
 
525
634
        :param index: An index from the pack parameter.
526
 
        :param pack: A Pack instance.
527
635
        """
528
636
        del self.index_to_pack[index]
529
 
        self.combined_index._indices.remove(index)
 
637
        pos = self.combined_index._indices.index(index)
 
638
        del self.combined_index._indices[pos]
 
639
        del self.combined_index._index_names[pos]
530
640
        if (self.add_callback is not None and
531
641
            getattr(index, 'add_nodes', None) == self.add_callback):
532
642
            self.add_callback = None
536
646
class Packer(object):
537
647
    """Create a pack from packs."""
538
648
 
539
 
    def __init__(self, pack_collection, packs, suffix, revision_ids=None):
 
649
    def __init__(self, pack_collection, packs, suffix, revision_ids=None,
 
650
                 reload_func=None):
540
651
        """Create a Packer.
541
652
 
542
653
        :param pack_collection: A RepositoryPackCollection object where the
544
655
        :param packs: The packs to combine.
545
656
        :param suffix: The suffix to use on the temporary files for the pack.
546
657
        :param revision_ids: Revision ids to limit the pack to.
 
658
        :param reload_func: A function to call if a pack file/index goes
 
659
            missing. The side effect of calling this function should be to
 
660
            update self.packs. See also AggregateIndex
547
661
        """
548
662
        self.packs = packs
549
663
        self.suffix = suffix
551
665
        # The pack object we are creating.
552
666
        self.new_pack = None
553
667
        self._pack_collection = pack_collection
 
668
        self._reload_func = reload_func
554
669
        # The index layer keys for the revisions being copied. None for 'all
555
670
        # objects'.
556
671
        self._revision_keys = None
562
677
    def _extra_init(self):
563
678
        """A template hook to allow extending the constructor trivially."""
564
679
 
 
680
    def _pack_map_and_index_list(self, index_attribute):
 
681
        """Convert a list of packs to an index pack map and index list.
 
682
 
 
683
        :param index_attribute: The attribute that the desired index is found
 
684
            on.
 
685
        :return: A tuple (map, list) where map contains the dict from
 
686
            index:pack_tuple, and list contains the indices in the preferred
 
687
            access order.
 
688
        """
 
689
        indices = []
 
690
        pack_map = {}
 
691
        for pack_obj in self.packs:
 
692
            index = getattr(pack_obj, index_attribute)
 
693
            indices.append(index)
 
694
            pack_map[index] = pack_obj
 
695
        return pack_map, indices
 
696
 
 
697
    def _index_contents(self, indices, key_filter=None):
 
698
        """Get an iterable of the index contents from a pack_map.
 
699
 
 
700
        :param indices: The list of indices to query
 
701
        :param key_filter: An optional filter to limit the keys returned.
 
702
        """
 
703
        all_index = CombinedGraphIndex(indices)
 
704
        if key_filter is None:
 
705
            return all_index.iter_all_entries()
 
706
        else:
 
707
            return all_index.iter_entries(key_filter)
 
708
 
565
709
    def pack(self, pb=None):
566
710
        """Create a new pack by reading data from other packs.
567
711
 
568
712
        This does little more than a bulk copy of data. One key difference
569
713
        is that data with the same item key across multiple packs is elided
570
714
        from the output. The new pack is written into the current pack store
571
 
        along with its indices, and the name added to the pack names. The 
 
715
        along with its indices, and the name added to the pack names. The
572
716
        source packs are not altered and are not required to be in the current
573
717
        pack collection.
574
718
 
581
725
        # XXX: - duplicate code warning with start_write_group; fix before
582
726
        #      considering 'done'.
583
727
        if self._pack_collection._new_pack is not None:
584
 
            raise errors.BzrError('call to create_pack_from_packs while '
585
 
                'another pack is being written.')
 
728
            raise errors.BzrError('call to %s.pack() while another pack is'
 
729
                                  ' being written.'
 
730
                                  % (self.__class__.__name__,))
586
731
        if self.revision_ids is not None:
587
732
            if len(self.revision_ids) == 0:
588
733
                # silly fetch request.
603
748
 
604
749
    def open_pack(self):
605
750
        """Open a pack for the pack we are creating."""
606
 
        return NewPack(self._pack_collection._upload_transport,
607
 
            self._pack_collection._index_transport,
608
 
            self._pack_collection._pack_transport, upload_suffix=self.suffix,
609
 
            file_mode=self._pack_collection.repo.bzrdir._get_file_mode(),
610
 
            index_builder_class=self._pack_collection._index_builder_class,
611
 
            index_class=self._pack_collection._index_class)
 
751
        new_pack = self._pack_collection.pack_factory(self._pack_collection,
 
752
                upload_suffix=self.suffix,
 
753
                file_mode=self._pack_collection.repo.bzrdir._get_file_mode())
 
754
        # We know that we will process all nodes in order, and don't need to
 
755
        # query, so don't combine any indices spilled to disk until we are done
 
756
        new_pack.revision_index.set_optimize(combine_backing_indices=False)
 
757
        new_pack.inventory_index.set_optimize(combine_backing_indices=False)
 
758
        new_pack.text_index.set_optimize(combine_backing_indices=False)
 
759
        new_pack.signature_index.set_optimize(combine_backing_indices=False)
 
760
        return new_pack
 
761
 
 
762
    def _update_pack_order(self, entries, index_to_pack_map):
 
763
        """Determine how we want our packs to be ordered.
 
764
 
 
765
        This changes the sort order of the self.packs list so that packs unused
 
766
        by 'entries' will be at the end of the list, so that future requests
 
767
        can avoid probing them.  Used packs will be at the front of the
 
768
        self.packs list, in the order of their first use in 'entries'.
 
769
 
 
770
        :param entries: A list of (index, ...) tuples
 
771
        :param index_to_pack_map: A mapping from index objects to pack objects.
 
772
        """
 
773
        packs = []
 
774
        seen_indexes = set()
 
775
        for entry in entries:
 
776
            index = entry[0]
 
777
            if index not in seen_indexes:
 
778
                packs.append(index_to_pack_map[index])
 
779
                seen_indexes.add(index)
 
780
        if len(packs) == len(self.packs):
 
781
            if 'pack' in debug.debug_flags:
 
782
                mutter('Not changing pack list, all packs used.')
 
783
            return
 
784
        seen_packs = set(packs)
 
785
        for pack in self.packs:
 
786
            if pack not in seen_packs:
 
787
                packs.append(pack)
 
788
                seen_packs.add(pack)
 
789
        if 'pack' in debug.debug_flags:
 
790
            old_names = [p.access_tuple()[1] for p in self.packs]
 
791
            new_names = [p.access_tuple()[1] for p in packs]
 
792
            mutter('Reordering packs\nfrom: %s\n  to: %s',
 
793
                   old_names, new_names)
 
794
        self.packs = packs
612
795
 
613
796
    def _copy_revision_texts(self):
614
797
        """Copy revision data to the new pack."""
618
801
        else:
619
802
            revision_keys = None
620
803
        # select revision keys
621
 
        revision_index_map = self._pack_collection._packs_list_to_pack_map_and_index_list(
622
 
            self.packs, 'revision_index')[0]
623
 
        revision_nodes = self._pack_collection._index_contents(revision_index_map, revision_keys)
 
804
        revision_index_map, revision_indices = self._pack_map_and_index_list(
 
805
            'revision_index')
 
806
        revision_nodes = self._index_contents(revision_indices, revision_keys)
 
807
        revision_nodes = list(revision_nodes)
 
808
        self._update_pack_order(revision_nodes, revision_index_map)
624
809
        # copy revision keys and adjust values
625
810
        self.pb.update("Copying revision texts", 1)
626
811
        total_items, readv_group_iter = self._revision_node_readv(revision_nodes)
646
831
        # querying for keys here could introduce a bug where an inventory item
647
832
        # is missed, so do not change it to query separately without cross
648
833
        # checking like the text key check below.
649
 
        inventory_index_map = self._pack_collection._packs_list_to_pack_map_and_index_list(
650
 
            self.packs, 'inventory_index')[0]
651
 
        inv_nodes = self._pack_collection._index_contents(inventory_index_map, inv_keys)
 
834
        inventory_index_map, inventory_indices = self._pack_map_and_index_list(
 
835
            'inventory_index')
 
836
        inv_nodes = self._index_contents(inventory_indices, inv_keys)
652
837
        # copy inventory keys and adjust values
653
838
        # XXX: Should be a helper function to allow different inv representation
654
839
        # at this point.
688
873
            if missing_text_keys:
689
874
                # TODO: raise a specific error that can handle many missing
690
875
                # keys.
 
876
                mutter("missing keys during fetch: %r", missing_text_keys)
691
877
                a_missing_key = missing_text_keys.pop()
692
878
                raise errors.RevisionNotPresent(a_missing_key[1],
693
879
                    a_missing_key[0])
698
884
            self.new_pack.text_index, readv_group_iter, total_items))
699
885
        self._log_copied_texts()
700
886
 
701
 
    def _check_references(self):
702
 
        """Make sure our external refereneces are present."""
703
 
        external_refs = self.new_pack._external_compression_parents_of_texts()
704
 
        if external_refs:
705
 
            index = self._pack_collection.text_index.combined_index
706
 
            found_items = list(index.iter_entries(external_refs))
707
 
            if len(found_items) != len(external_refs):
708
 
                found_keys = set(k for idx, k, refs, value in found_items)
709
 
                missing_items = external_refs - found_keys
710
 
                missing_file_id, missing_revision_id = missing_items.pop()
711
 
                raise errors.RevisionNotPresent(missing_revision_id,
712
 
                                                missing_file_id)
713
 
 
714
887
    def _create_pack_from_packs(self):
715
888
        self.pb.update("Opening pack", 0, 5)
716
889
        self.new_pack = self.open_pack()
734
907
        self._copy_text_texts()
735
908
        # select signature keys
736
909
        signature_filter = self._revision_keys # same keyspace
737
 
        signature_index_map = self._pack_collection._packs_list_to_pack_map_and_index_list(
738
 
            self.packs, 'signature_index')[0]
739
 
        signature_nodes = self._pack_collection._index_contents(signature_index_map,
 
910
        signature_index_map, signature_indices = self._pack_map_and_index_list(
 
911
            'signature_index')
 
912
        signature_nodes = self._index_contents(signature_indices,
740
913
            signature_filter)
741
914
        # copy signature keys and adjust values
742
915
        self.pb.update("Copying signature texts", 4)
747
920
                time.ctime(), self._pack_collection._upload_transport.base, new_pack.random_name,
748
921
                new_pack.signature_index.key_count(),
749
922
                time.time() - new_pack.start_time)
750
 
        self._check_references()
 
923
        # copy chk contents
 
924
        # NB XXX: how to check CHK references are present? perhaps by yielding
 
925
        # the items? How should that interact with stacked repos?
 
926
        if new_pack.chk_index is not None:
 
927
            self._copy_chks()
 
928
            if 'pack' in debug.debug_flags:
 
929
                mutter('%s: create_pack: chk content copied: %s%s %d items t+%6.3fs',
 
930
                    time.ctime(), self._pack_collection._upload_transport.base,
 
931
                    new_pack.random_name,
 
932
                    new_pack.chk_index.key_count(),
 
933
                    time.time() - new_pack.start_time)
 
934
        new_pack._check_references()
751
935
        if not self._use_pack(new_pack):
752
936
            new_pack.abort()
753
937
            return None
756
940
        self._pack_collection.allocate(new_pack)
757
941
        return new_pack
758
942
 
759
 
    def _copy_nodes(self, nodes, index_map, writer, write_index):
760
 
        """Copy knit nodes between packs with no graph references."""
 
943
    def _copy_chks(self, refs=None):
 
944
        # XXX: Todo, recursive follow-pointers facility when fetching some
 
945
        # revisions only.
 
946
        chk_index_map, chk_indices = self._pack_map_and_index_list(
 
947
            'chk_index')
 
948
        chk_nodes = self._index_contents(chk_indices, refs)
 
949
        new_refs = set()
 
950
        # TODO: This isn't strictly tasteful as we are accessing some private
 
951
        #       variables (_serializer). Perhaps a better way would be to have
 
952
        #       Repository._deserialise_chk_node()
 
953
        search_key_func = chk_map.search_key_registry.get(
 
954
            self._pack_collection.repo._serializer.search_key_name)
 
955
        def accumlate_refs(lines):
 
956
            # XXX: move to a generic location
 
957
            # Yay mismatch:
 
958
            bytes = ''.join(lines)
 
959
            node = chk_map._deserialise(bytes, ("unknown",), search_key_func)
 
960
            new_refs.update(node.refs())
 
961
        self._copy_nodes(chk_nodes, chk_index_map, self.new_pack._writer,
 
962
            self.new_pack.chk_index, output_lines=accumlate_refs)
 
963
        return new_refs
 
964
 
 
965
    def _copy_nodes(self, nodes, index_map, writer, write_index,
 
966
        output_lines=None):
 
967
        """Copy knit nodes between packs with no graph references.
 
968
 
 
969
        :param output_lines: Output full texts of copied items.
 
970
        """
761
971
        pb = ui.ui_factory.nested_progress_bar()
762
972
        try:
763
973
            return self._do_copy_nodes(nodes, index_map, writer,
764
 
                write_index, pb)
 
974
                write_index, pb, output_lines=output_lines)
765
975
        finally:
766
976
            pb.finished()
767
977
 
768
 
    def _do_copy_nodes(self, nodes, index_map, writer, write_index, pb):
 
978
    def _do_copy_nodes(self, nodes, index_map, writer, write_index, pb,
 
979
        output_lines=None):
769
980
        # for record verification
770
981
        knit = KnitVersionedFiles(None, None)
771
982
        # plan a readv on each source pack:
773
984
        nodes = sorted(nodes)
774
985
        # how to map this into knit.py - or knit.py into this?
775
986
        # we don't want the typical knit logic, we want grouping by pack
776
 
        # at this point - perhaps a helper library for the following code 
 
987
        # at this point - perhaps a helper library for the following code
777
988
        # duplication points?
778
989
        request_groups = {}
779
990
        for index, key, value in nodes:
792
1003
            # linear scan up the pack
793
1004
            pack_readv_requests.sort()
794
1005
            # copy the data
795
 
            transport, path = index_map[index]
796
 
            reader = pack.make_readv_reader(transport, path,
797
 
                [offset[0:2] for offset in pack_readv_requests])
 
1006
            pack_obj = index_map[index]
 
1007
            transport, path = pack_obj.access_tuple()
 
1008
            try:
 
1009
                reader = pack.make_readv_reader(transport, path,
 
1010
                    [offset[0:2] for offset in pack_readv_requests])
 
1011
            except errors.NoSuchFile:
 
1012
                if self._reload_func is not None:
 
1013
                    self._reload_func()
 
1014
                raise
798
1015
            for (names, read_func), (_1, _2, (key, eol_flag)) in \
799
1016
                izip(reader.iter_records(), pack_readv_requests):
800
1017
                raw_data = read_func(None)
801
1018
                # check the header only
802
 
                df, _ = knit._parse_record_header(key, raw_data)
803
 
                df.close()
 
1019
                if output_lines is not None:
 
1020
                    output_lines(knit._parse_record(key[-1], raw_data)[0])
 
1021
                else:
 
1022
                    df, _ = knit._parse_record_header(key, raw_data)
 
1023
                    df.close()
804
1024
                pos, size = writer.add_bytes_record(raw_data, names)
805
1025
                write_index.add_node(key, eol_flag + "%d %d" % (pos, size))
806
1026
                pb.update("Copied record", record_index)
836
1056
        pb.update("Copied record", record_index, total_items)
837
1057
        for index, readv_vector, node_vector in readv_group_iter:
838
1058
            # copy the data
839
 
            transport, path = index_map[index]
840
 
            reader = pack.make_readv_reader(transport, path, readv_vector)
 
1059
            pack_obj = index_map[index]
 
1060
            transport, path = pack_obj.access_tuple()
 
1061
            try:
 
1062
                reader = pack.make_readv_reader(transport, path, readv_vector)
 
1063
            except errors.NoSuchFile:
 
1064
                if self._reload_func is not None:
 
1065
                    self._reload_func()
 
1066
                raise
841
1067
            for (names, read_func), (key, eol_flag, references) in \
842
1068
                izip(reader.iter_records(), node_vector):
843
1069
                raw_data = read_func(None)
860
1086
                record_index += 1
861
1087
 
862
1088
    def _get_text_nodes(self):
863
 
        text_index_map = self._pack_collection._packs_list_to_pack_map_and_index_list(
864
 
            self.packs, 'text_index')[0]
865
 
        return text_index_map, self._pack_collection._index_contents(text_index_map,
 
1089
        text_index_map, text_indices = self._pack_map_and_index_list(
 
1090
            'text_index')
 
1091
        return text_index_map, self._index_contents(text_indices,
866
1092
            self._text_filter)
867
1093
 
868
1094
    def _least_readv_node_readv(self, nodes):
869
1095
        """Generate request groups for nodes using the least readv's.
870
 
        
 
1096
 
871
1097
        :param nodes: An iterable of graph index nodes.
872
1098
        :return: Total node count and an iterator of the data needed to perform
873
1099
            readvs to obtain the data for nodes. Each item yielded by the
874
1100
            iterator is a tuple with:
875
1101
            index, readv_vector, node_vector. readv_vector is a list ready to
876
1102
            hand to the transport readv method, and node_vector is a list of
877
 
            (key, eol_flag, references) for the the node retrieved by the
 
1103
            (key, eol_flag, references) for the node retrieved by the
878
1104
            matching readv_vector.
879
1105
        """
880
1106
        # group by pack so we do one readv per pack
971
1197
        # TODO: combine requests in the same index that are in ascending order.
972
1198
        return total, requests
973
1199
 
 
1200
    def open_pack(self):
 
1201
        """Open a pack for the pack we are creating."""
 
1202
        new_pack = super(OptimisingPacker, self).open_pack()
 
1203
        # Turn on the optimization flags for all the index builders.
 
1204
        new_pack.revision_index.set_optimize(for_size=True)
 
1205
        new_pack.inventory_index.set_optimize(for_size=True)
 
1206
        new_pack.text_index.set_optimize(for_size=True)
 
1207
        new_pack.signature_index.set_optimize(for_size=True)
 
1208
        return new_pack
 
1209
 
974
1210
 
975
1211
class ReconcilePacker(Packer):
976
1212
    """A packer which regenerates indices etc as it copies.
977
 
    
 
1213
 
978
1214
    This is used by ``bzr reconcile`` to cause parent text pointers to be
979
1215
    regenerated.
980
1216
    """
1003
1239
        # 1) generate the ideal index
1004
1240
        repo = self._pack_collection.repo
1005
1241
        ancestors = dict([(key[0], tuple(ref[0] for ref in refs[0])) for
1006
 
            _1, key, _2, refs in 
 
1242
            _1, key, _2, refs in
1007
1243
            self.new_pack.revision_index.iter_all_entries()])
1008
1244
        ideal_index = repo._generate_text_key_index(self._text_refs, ancestors)
1009
1245
        # 2) generate a text_nodes list that contains all the deltas that can
1015
1251
        text_index_map, text_nodes = self._get_text_nodes()
1016
1252
        for node in text_nodes:
1017
1253
            # 0 - index
1018
 
            # 1 - key 
 
1254
            # 1 - key
1019
1255
            # 2 - value
1020
1256
            # 3 - refs
1021
1257
            try:
1061
1297
        # space (we only topo sort the revisions, which is smaller).
1062
1298
        topo_order = tsort.topo_sort(ancestors)
1063
1299
        rev_order = dict(zip(topo_order, range(len(topo_order))))
1064
 
        bad_texts.sort(key=lambda key:rev_order[key[0][1]])
 
1300
        bad_texts.sort(key=lambda key:rev_order.get(key[0][1], 0))
1065
1301
        transaction = repo.get_transaction()
1066
1302
        file_id_index = GraphIndexPrefixAdapter(
1067
1303
            self.new_pack.text_index,
1093
1329
            output_texts.add_lines(key, parent_keys, text_lines,
1094
1330
                random_id=True, check_content=False)
1095
1331
        # 5) check that nothing inserted has a reference outside the keyspace.
1096
 
        missing_text_keys = self.new_pack._external_compression_parents_of_texts()
 
1332
        missing_text_keys = self.new_pack.text_index._external_references()
1097
1333
        if missing_text_keys:
1098
 
            raise errors.BzrError('Reference to missing compression parents %r'
 
1334
            raise errors.BzrCheckError('Reference to missing compression parents %r'
1099
1335
                % (missing_text_keys,))
1100
1336
        self._log_copied_texts()
1101
1337
 
1116
1352
 
1117
1353
class RepositoryPackCollection(object):
1118
1354
    """Management of packs within a repository.
1119
 
    
 
1355
 
1120
1356
    :ivar _names: map of {pack_name: (index_size,)}
1121
1357
    """
1122
1358
 
 
1359
    pack_factory = NewPack
 
1360
    resumed_pack_factory = ResumedPack
 
1361
 
1123
1362
    def __init__(self, repo, transport, index_transport, upload_transport,
1124
 
                 pack_transport, index_builder_class, index_class):
 
1363
                 pack_transport, index_builder_class, index_class,
 
1364
                 use_chk_index):
1125
1365
        """Create a new RepositoryPackCollection.
1126
1366
 
1127
 
        :param transport: Addresses the repository base directory 
 
1367
        :param transport: Addresses the repository base directory
1128
1368
            (typically .bzr/repository/).
1129
1369
        :param index_transport: Addresses the directory containing indices.
1130
1370
        :param upload_transport: Addresses the directory into which packs are written
1132
1372
        :param pack_transport: Addresses the directory of existing complete packs.
1133
1373
        :param index_builder_class: The index builder class to use.
1134
1374
        :param index_class: The index class to use.
 
1375
        :param use_chk_index: Whether to setup and manage a CHK index.
1135
1376
        """
 
1377
        # XXX: This should call self.reset()
1136
1378
        self.repo = repo
1137
1379
        self.transport = transport
1138
1380
        self._index_transport = index_transport
1140
1382
        self._pack_transport = pack_transport
1141
1383
        self._index_builder_class = index_builder_class
1142
1384
        self._index_class = index_class
1143
 
        self._suffix_offsets = {'.rix': 0, '.iix': 1, '.tix': 2, '.six': 3}
 
1385
        self._suffix_offsets = {'.rix': 0, '.iix': 1, '.tix': 2, '.six': 3,
 
1386
            '.cix': 4}
1144
1387
        self.packs = []
1145
1388
        # name:Pack mapping
 
1389
        self._names = None
1146
1390
        self._packs_by_name = {}
1147
1391
        # the previous pack-names content
1148
1392
        self._packs_at_load = None
1149
1393
        # when a pack is being created by this object, the state of that pack.
1150
1394
        self._new_pack = None
1151
1395
        # aggregated revision index data
1152
 
        self.revision_index = AggregateIndex()
1153
 
        self.inventory_index = AggregateIndex()
1154
 
        self.text_index = AggregateIndex()
1155
 
        self.signature_index = AggregateIndex()
 
1396
        flush = self._flush_new_pack
 
1397
        self.revision_index = AggregateIndex(self.reload_pack_names, flush)
 
1398
        self.inventory_index = AggregateIndex(self.reload_pack_names, flush)
 
1399
        self.text_index = AggregateIndex(self.reload_pack_names, flush)
 
1400
        self.signature_index = AggregateIndex(self.reload_pack_names, flush)
 
1401
        all_indices = [self.revision_index, self.inventory_index,
 
1402
                self.text_index, self.signature_index]
 
1403
        if use_chk_index:
 
1404
            self.chk_index = AggregateIndex(self.reload_pack_names, flush)
 
1405
            all_indices.append(self.chk_index)
 
1406
        else:
 
1407
            # used to determine if we're using a chk_index elsewhere.
 
1408
            self.chk_index = None
 
1409
        # Tell all the CombinedGraphIndex objects about each other, so they can
 
1410
        # share hints about which pack names to search first.
 
1411
        all_combined = [agg_idx.combined_index for agg_idx in all_indices]
 
1412
        for combined_idx in all_combined:
 
1413
            combined_idx.set_sibling_indices(
 
1414
                set(all_combined).difference([combined_idx]))
 
1415
        # resumed packs
 
1416
        self._resumed_packs = []
 
1417
 
 
1418
    def __repr__(self):
 
1419
        return '%s(%r)' % (self.__class__.__name__, self.repo)
1156
1420
 
1157
1421
    def add_pack_to_memory(self, pack):
1158
1422
        """Make a Pack object available to the repository to satisfy queries.
1159
 
        
 
1423
 
1160
1424
        :param pack: A Pack object.
1161
1425
        """
1162
1426
        if pack.name in self._packs_by_name:
1163
 
            raise AssertionError()
 
1427
            raise AssertionError(
 
1428
                'pack %s already in _packs_by_name' % (pack.name,))
1164
1429
        self.packs.append(pack)
1165
1430
        self._packs_by_name[pack.name] = pack
1166
1431
        self.revision_index.add_index(pack.revision_index, pack)
1167
1432
        self.inventory_index.add_index(pack.inventory_index, pack)
1168
1433
        self.text_index.add_index(pack.text_index, pack)
1169
1434
        self.signature_index.add_index(pack.signature_index, pack)
1170
 
        
 
1435
        if self.chk_index is not None:
 
1436
            self.chk_index.add_index(pack.chk_index, pack)
 
1437
 
1171
1438
    def all_packs(self):
1172
1439
        """Return a list of all the Pack objects this repository has.
1173
1440
 
1182
1449
 
1183
1450
    def autopack(self):
1184
1451
        """Pack the pack collection incrementally.
1185
 
        
 
1452
 
1186
1453
        This will not attempt global reorganisation or recompression,
1187
1454
        rather it will just ensure that the total number of packs does
1188
1455
        not grow without bound. It uses the _max_pack_count method to
1194
1461
        in synchronisation with certain steps. Otherwise the names collection
1195
1462
        is not flushed.
1196
1463
 
1197
 
        :return: True if packing took place.
 
1464
        :return: Something evaluating true if packing took place.
1198
1465
        """
 
1466
        while True:
 
1467
            try:
 
1468
                return self._do_autopack()
 
1469
            except errors.RetryAutopack:
 
1470
                # If we get a RetryAutopack exception, we should abort the
 
1471
                # current action, and retry.
 
1472
                pass
 
1473
 
 
1474
    def _do_autopack(self):
1199
1475
        # XXX: Should not be needed when the management of indices is sane.
1200
1476
        total_revisions = self.revision_index.combined_index.key_count()
1201
1477
        total_packs = len(self._names)
1202
1478
        if self._max_pack_count(total_revisions) >= total_packs:
1203
 
            return False
1204
 
        # XXX: the following may want to be a class, to pack with a given
1205
 
        # policy.
1206
 
        mutter('Auto-packing repository %s, which has %d pack files, '
1207
 
            'containing %d revisions into %d packs.', self, total_packs,
1208
 
            total_revisions, self._max_pack_count(total_revisions))
 
1479
            return None
1209
1480
        # determine which packs need changing
1210
1481
        pack_distribution = self.pack_distribution(total_revisions)
1211
1482
        existing_packs = []
1219
1490
                # group their data with the relevant commit, and that may
1220
1491
                # involve rewriting ancient history - which autopack tries to
1221
1492
                # avoid. Alternatively we could not group the data but treat
1222
 
                # each of these as having a single revision, and thus add 
 
1493
                # each of these as having a single revision, and thus add
1223
1494
                # one revision for each to the total revision count, to get
1224
1495
                # a matching distribution.
1225
1496
                continue
1226
1497
            existing_packs.append((revision_count, pack))
1227
1498
        pack_operations = self.plan_autopack_combinations(
1228
1499
            existing_packs, pack_distribution)
1229
 
        self._execute_pack_operations(pack_operations)
1230
 
        return True
 
1500
        num_new_packs = len(pack_operations)
 
1501
        num_old_packs = sum([len(po[1]) for po in pack_operations])
 
1502
        num_revs_affected = sum([po[0] for po in pack_operations])
 
1503
        mutter('Auto-packing repository %s, which has %d pack files, '
 
1504
            'containing %d revisions. Packing %d files into %d affecting %d'
 
1505
            ' revisions', self, total_packs, total_revisions, num_old_packs,
 
1506
            num_new_packs, num_revs_affected)
 
1507
        result = self._execute_pack_operations(pack_operations,
 
1508
                                      reload_func=self._restart_autopack)
 
1509
        mutter('Auto-packing repository %s completed', self)
 
1510
        return result
1231
1511
 
1232
 
    def _execute_pack_operations(self, pack_operations, _packer_class=Packer):
 
1512
    def _execute_pack_operations(self, pack_operations, _packer_class=Packer,
 
1513
                                 reload_func=None):
1233
1514
        """Execute a series of pack operations.
1234
1515
 
1235
1516
        :param pack_operations: A list of [revision_count, packs_to_combine].
1236
1517
        :param _packer_class: The class of packer to use (default: Packer).
1237
 
        :return: None.
 
1518
        :return: The new pack names.
1238
1519
        """
1239
1520
        for revision_count, packs in pack_operations:
1240
1521
            # we may have no-ops from the setup logic
1241
1522
            if len(packs) == 0:
1242
1523
                continue
1243
 
            _packer_class(self, packs, '.autopack').pack()
 
1524
            packer = _packer_class(self, packs, '.autopack',
 
1525
                                   reload_func=reload_func)
 
1526
            try:
 
1527
                packer.pack()
 
1528
            except errors.RetryWithNewPacks:
 
1529
                # An exception is propagating out of this context, make sure
 
1530
                # this packer has cleaned up. Packer() doesn't set its new_pack
 
1531
                # state into the RepositoryPackCollection object, so we only
 
1532
                # have access to it directly here.
 
1533
                if packer.new_pack is not None:
 
1534
                    packer.new_pack.abort()
 
1535
                raise
1244
1536
            for pack in packs:
1245
1537
                self._remove_pack_from_memory(pack)
1246
1538
        # record the newly available packs and stop advertising the old
1247
1539
        # packs
1248
 
        self._save_pack_names(clear_obsolete_packs=True)
1249
 
        # Move the old packs out of the way now they are no longer referenced.
1250
 
        for revision_count, packs in pack_operations:
1251
 
            self._obsolete_packs(packs)
 
1540
        to_be_obsoleted = []
 
1541
        for _, packs in pack_operations:
 
1542
            to_be_obsoleted.extend(packs)
 
1543
        result = self._save_pack_names(clear_obsolete_packs=True,
 
1544
                                       obsolete_packs=to_be_obsoleted)
 
1545
        return result
 
1546
 
 
1547
    def _flush_new_pack(self):
 
1548
        if self._new_pack is not None:
 
1549
            self._new_pack.flush()
1252
1550
 
1253
1551
    def lock_names(self):
1254
1552
        """Acquire the mutex around the pack-names index.
1255
 
        
 
1553
 
1256
1554
        This cannot be used in the middle of a read-only transaction on the
1257
1555
        repository.
1258
1556
        """
1259
1557
        self.repo.control_files.lock_write()
1260
1558
 
1261
 
    def pack(self):
 
1559
    def _already_packed(self):
 
1560
        """Is the collection already packed?"""
 
1561
        return not (self.repo._format.pack_compresses or (len(self._names) > 1))
 
1562
 
 
1563
    def pack(self, hint=None, clean_obsolete_packs=False):
1262
1564
        """Pack the pack collection totally."""
1263
1565
        self.ensure_loaded()
1264
1566
        total_packs = len(self._names)
1265
 
        if total_packs < 2:
1266
 
            # This is arguably wrong because we might not be optimal, but for
1267
 
            # now lets leave it in. (e.g. reconcile -> one pack. But not
1268
 
            # optimal.
 
1567
        if self._already_packed():
1269
1568
            return
1270
1569
        total_revisions = self.revision_index.combined_index.key_count()
1271
1570
        # XXX: the following may want to be a class, to pack with a given
1272
1571
        # policy.
1273
1572
        mutter('Packing repository %s, which has %d pack files, '
1274
 
            'containing %d revisions into 1 packs.', self, total_packs,
1275
 
            total_revisions)
 
1573
            'containing %d revisions with hint %r.', self, total_packs,
 
1574
            total_revisions, hint)
1276
1575
        # determine which packs need changing
1277
 
        pack_distribution = [1]
1278
1576
        pack_operations = [[0, []]]
1279
1577
        for pack in self.all_packs():
1280
 
            pack_operations[-1][0] += pack.get_revision_count()
1281
 
            pack_operations[-1][1].append(pack)
 
1578
            if hint is None or pack.name in hint:
 
1579
                # Either no hint was provided (so we are packing everything),
 
1580
                # or this pack was included in the hint.
 
1581
                pack_operations[-1][0] += pack.get_revision_count()
 
1582
                pack_operations[-1][1].append(pack)
1282
1583
        self._execute_pack_operations(pack_operations, OptimisingPacker)
1283
1584
 
 
1585
        if clean_obsolete_packs:
 
1586
            self._clear_obsolete_packs()
 
1587
 
1284
1588
    def plan_autopack_combinations(self, existing_packs, pack_distribution):
1285
1589
        """Plan a pack operation.
1286
1590
 
1334
1638
        return [[final_rev_count, final_pack_list]]
1335
1639
 
1336
1640
    def ensure_loaded(self):
 
1641
        """Ensure we have read names from disk.
 
1642
 
 
1643
        :return: True if the disk names had not been previously read.
 
1644
        """
1337
1645
        # NB: if you see an assertion error here, its probably access against
1338
1646
        # an unlocked repo. Naughty.
1339
1647
        if not self.repo.is_locked():
1345
1653
                name = key[0]
1346
1654
                self._names[name] = self._parse_index_sizes(value)
1347
1655
                self._packs_at_load.add((key, value))
 
1656
            result = True
 
1657
        else:
 
1658
            result = False
1348
1659
        # populate all the metadata.
1349
1660
        self.all_packs()
 
1661
        return result
1350
1662
 
1351
1663
    def _parse_index_sizes(self, value):
1352
1664
        """Parse a string of index sizes."""
1365
1677
            inv_index = self._make_index(name, '.iix')
1366
1678
            txt_index = self._make_index(name, '.tix')
1367
1679
            sig_index = self._make_index(name, '.six')
 
1680
            if self.chk_index is not None:
 
1681
                chk_index = self._make_index(name, '.cix', unlimited_cache=True)
 
1682
            else:
 
1683
                chk_index = None
1368
1684
            result = ExistingPack(self._pack_transport, name, rev_index,
1369
 
                inv_index, txt_index, sig_index)
 
1685
                inv_index, txt_index, sig_index, chk_index)
1370
1686
            self.add_pack_to_memory(result)
1371
1687
            return result
1372
1688
 
 
1689
    def _resume_pack(self, name):
 
1690
        """Get a suspended Pack object by name.
 
1691
 
 
1692
        :param name: The name of the pack - e.g. '123456'
 
1693
        :return: A Pack object.
 
1694
        """
 
1695
        if not re.match('[a-f0-9]{32}', name):
 
1696
            # Tokens should be md5sums of the suspended pack file, i.e. 32 hex
 
1697
            # digits.
 
1698
            raise errors.UnresumableWriteGroup(
 
1699
                self.repo, [name], 'Malformed write group token')
 
1700
        try:
 
1701
            rev_index = self._make_index(name, '.rix', resume=True)
 
1702
            inv_index = self._make_index(name, '.iix', resume=True)
 
1703
            txt_index = self._make_index(name, '.tix', resume=True)
 
1704
            sig_index = self._make_index(name, '.six', resume=True)
 
1705
            if self.chk_index is not None:
 
1706
                chk_index = self._make_index(name, '.cix', resume=True,
 
1707
                                             unlimited_cache=True)
 
1708
            else:
 
1709
                chk_index = None
 
1710
            result = self.resumed_pack_factory(name, rev_index, inv_index,
 
1711
                txt_index, sig_index, self._upload_transport,
 
1712
                self._pack_transport, self._index_transport, self,
 
1713
                chk_index=chk_index)
 
1714
        except errors.NoSuchFile, e:
 
1715
            raise errors.UnresumableWriteGroup(self.repo, [name], str(e))
 
1716
        self.add_pack_to_memory(result)
 
1717
        self._resumed_packs.append(result)
 
1718
        return result
 
1719
 
1373
1720
    def allocate(self, a_new_pack):
1374
1721
        """Allocate name in the list of packs.
1375
1722
 
1385
1732
 
1386
1733
    def _iter_disk_pack_index(self):
1387
1734
        """Iterate over the contents of the pack-names index.
1388
 
        
 
1735
 
1389
1736
        This is used when loading the list from disk, and before writing to
1390
1737
        detect updates from others during our write operation.
1391
1738
        :return: An iterator of the index contents.
1393
1740
        return self._index_class(self.transport, 'pack-names', None
1394
1741
                ).iter_all_entries()
1395
1742
 
1396
 
    def _make_index(self, name, suffix):
 
1743
    def _make_index(self, name, suffix, resume=False, unlimited_cache=False):
1397
1744
        size_offset = self._suffix_offsets[suffix]
1398
1745
        index_name = name + suffix
1399
 
        index_size = self._names[name][size_offset]
1400
 
        return self._index_class(
1401
 
            self._index_transport, index_name, index_size)
 
1746
        if resume:
 
1747
            transport = self._upload_transport
 
1748
            index_size = transport.stat(index_name).st_size
 
1749
        else:
 
1750
            transport = self._index_transport
 
1751
            index_size = self._names[name][size_offset]
 
1752
        return self._index_class(transport, index_name, index_size,
 
1753
                                 unlimited_cache=unlimited_cache)
1402
1754
 
1403
1755
    def _max_pack_count(self, total_revisions):
1404
1756
        """Return the maximum number of packs to use for total revisions.
1405
 
        
 
1757
 
1406
1758
        :param total_revisions: The total number of revisions in the
1407
1759
            repository.
1408
1760
        """
1432
1784
        :param return: None.
1433
1785
        """
1434
1786
        for pack in packs:
1435
 
            pack.pack_transport.rename(pack.file_name(),
1436
 
                '../obsolete_packs/' + pack.file_name())
 
1787
            try:
 
1788
                pack.pack_transport.rename(pack.file_name(),
 
1789
                    '../obsolete_packs/' + pack.file_name())
 
1790
            except (errors.PathError, errors.TransportError), e:
 
1791
                # TODO: Should these be warnings or mutters?
 
1792
                mutter("couldn't rename obsolete pack, skipping it:\n%s"
 
1793
                       % (e,))
1437
1794
            # TODO: Probably needs to know all possible indices for this pack
1438
1795
            # - or maybe list the directory and move all indices matching this
1439
1796
            # name whether we recognize it or not?
1440
 
            for suffix in ('.iix', '.six', '.tix', '.rix'):
1441
 
                self._index_transport.rename(pack.name + suffix,
1442
 
                    '../obsolete_packs/' + pack.name + suffix)
 
1797
            suffixes = ['.iix', '.six', '.tix', '.rix']
 
1798
            if self.chk_index is not None:
 
1799
                suffixes.append('.cix')
 
1800
            for suffix in suffixes:
 
1801
                try:
 
1802
                    self._index_transport.rename(pack.name + suffix,
 
1803
                        '../obsolete_packs/' + pack.name + suffix)
 
1804
                except (errors.PathError, errors.TransportError), e:
 
1805
                    mutter("couldn't rename obsolete index, skipping it:\n%s"
 
1806
                           % (e,))
1443
1807
 
1444
1808
    def pack_distribution(self, total_revisions):
1445
1809
        """Generate a list of the number of revisions to put in each pack.
1463
1827
 
1464
1828
    def _remove_pack_from_memory(self, pack):
1465
1829
        """Remove pack from the packs accessed by this repository.
1466
 
        
 
1830
 
1467
1831
        Only affects memory state, until self._save_pack_names() is invoked.
1468
1832
        """
1469
1833
        self._names.pop(pack.name)
1470
1834
        self._packs_by_name.pop(pack.name)
1471
1835
        self._remove_pack_indices(pack)
 
1836
        self.packs.remove(pack)
1472
1837
 
1473
 
    def _remove_pack_indices(self, pack):
1474
 
        """Remove the indices for pack from the aggregated indices."""
1475
 
        self.revision_index.remove_index(pack.revision_index, pack)
1476
 
        self.inventory_index.remove_index(pack.inventory_index, pack)
1477
 
        self.text_index.remove_index(pack.text_index, pack)
1478
 
        self.signature_index.remove_index(pack.signature_index, pack)
 
1838
    def _remove_pack_indices(self, pack, ignore_missing=False):
 
1839
        """Remove the indices for pack from the aggregated indices.
 
1840
        
 
1841
        :param ignore_missing: Suppress KeyErrors from calling remove_index.
 
1842
        """
 
1843
        for index_type in Pack.index_definitions.keys():
 
1844
            attr_name = index_type + '_index'
 
1845
            aggregate_index = getattr(self, attr_name)
 
1846
            if aggregate_index is not None:
 
1847
                pack_index = getattr(pack, attr_name)
 
1848
                try:
 
1849
                    aggregate_index.remove_index(pack_index)
 
1850
                except KeyError:
 
1851
                    if ignore_missing:
 
1852
                        continue
 
1853
                    raise
1479
1854
 
1480
1855
    def reset(self):
1481
1856
        """Clear all cached data."""
1482
1857
        # cached revision data
1483
 
        self.repo._revision_knit = None
1484
1858
        self.revision_index.clear()
1485
1859
        # cached signature data
1486
 
        self.repo._signature_knit = None
1487
1860
        self.signature_index.clear()
1488
1861
        # cached file text data
1489
1862
        self.text_index.clear()
1490
 
        self.repo._text_knit = None
1491
1863
        # cached inventory data
1492
1864
        self.inventory_index.clear()
 
1865
        # cached chk data
 
1866
        if self.chk_index is not None:
 
1867
            self.chk_index.clear()
1493
1868
        # remove the open pack
1494
1869
        self._new_pack = None
1495
1870
        # information about packs.
1498
1873
        self._packs_by_name = {}
1499
1874
        self._packs_at_load = None
1500
1875
 
1501
 
    def _make_index_map(self, index_suffix):
1502
 
        """Return information on existing indices.
1503
 
 
1504
 
        :param suffix: Index suffix added to pack name.
1505
 
 
1506
 
        :returns: (pack_map, indices) where indices is a list of GraphIndex 
1507
 
        objects, and pack_map is a mapping from those objects to the 
1508
 
        pack tuple they describe.
1509
 
        """
1510
 
        # TODO: stop using this; it creates new indices unnecessarily.
1511
 
        self.ensure_loaded()
1512
 
        suffix_map = {'.rix': 'revision_index',
1513
 
            '.six': 'signature_index',
1514
 
            '.iix': 'inventory_index',
1515
 
            '.tix': 'text_index',
1516
 
        }
1517
 
        return self._packs_list_to_pack_map_and_index_list(self.all_packs(),
1518
 
            suffix_map[index_suffix])
1519
 
 
1520
 
    def _packs_list_to_pack_map_and_index_list(self, packs, index_attribute):
1521
 
        """Convert a list of packs to an index pack map and index list.
1522
 
 
1523
 
        :param packs: The packs list to process.
1524
 
        :param index_attribute: The attribute that the desired index is found
1525
 
            on.
1526
 
        :return: A tuple (map, list) where map contains the dict from
1527
 
            index:pack_tuple, and lsit contains the indices in the same order
1528
 
            as the packs list.
1529
 
        """
1530
 
        indices = []
1531
 
        pack_map = {}
1532
 
        for pack in packs:
1533
 
            index = getattr(pack, index_attribute)
1534
 
            indices.append(index)
1535
 
            pack_map[index] = (pack.pack_transport, pack.file_name())
1536
 
        return pack_map, indices
1537
 
 
1538
 
    def _index_contents(self, pack_map, key_filter=None):
1539
 
        """Get an iterable of the index contents from a pack_map.
1540
 
 
1541
 
        :param pack_map: A map from indices to pack details.
1542
 
        :param key_filter: An optional filter to limit the
1543
 
            keys returned.
1544
 
        """
1545
 
        indices = [index for index in pack_map.iterkeys()]
1546
 
        all_index = CombinedGraphIndex(indices)
1547
 
        if key_filter is None:
1548
 
            return all_index.iter_all_entries()
1549
 
        else:
1550
 
            return all_index.iter_entries(key_filter)
1551
 
 
1552
1876
    def _unlock_names(self):
1553
1877
        """Release the mutex around the pack-names index."""
1554
1878
        self.repo.control_files.unlock()
1555
1879
 
1556
 
    def _save_pack_names(self, clear_obsolete_packs=False):
1557
 
        """Save the list of packs.
1558
 
 
1559
 
        This will take out the mutex around the pack names list for the
1560
 
        duration of the method call. If concurrent updates have been made, a
1561
 
        three-way merge between the current list and the current in memory list
1562
 
        is performed.
1563
 
 
1564
 
        :param clear_obsolete_packs: If True, clear out the contents of the
1565
 
            obsolete_packs directory.
1566
 
        """
1567
 
        self.lock_names()
1568
 
        try:
1569
 
            builder = self._index_builder_class()
1570
 
            # load the disk nodes across
1571
 
            disk_nodes = set()
1572
 
            for index, key, value in self._iter_disk_pack_index():
1573
 
                disk_nodes.add((key, value))
1574
 
            # do a two-way diff against our original content
1575
 
            current_nodes = set()
1576
 
            for name, sizes in self._names.iteritems():
1577
 
                current_nodes.add(
1578
 
                    ((name, ), ' '.join(str(size) for size in sizes)))
1579
 
            deleted_nodes = self._packs_at_load - current_nodes
1580
 
            new_nodes = current_nodes - self._packs_at_load
1581
 
            disk_nodes.difference_update(deleted_nodes)
1582
 
            disk_nodes.update(new_nodes)
1583
 
            # TODO: handle same-name, index-size-changes here - 
1584
 
            # e.g. use the value from disk, not ours, *unless* we're the one
1585
 
            # changing it.
1586
 
            for key, value in disk_nodes:
1587
 
                builder.add_node(key, value)
1588
 
            self.transport.put_file('pack-names', builder.finish(),
1589
 
                mode=self.repo.bzrdir._get_file_mode())
1590
 
            # move the baseline forward
1591
 
            self._packs_at_load = disk_nodes
1592
 
            if clear_obsolete_packs:
1593
 
                self._clear_obsolete_packs()
1594
 
        finally:
1595
 
            self._unlock_names()
1596
 
        # synchronise the memory packs list with what we just wrote:
 
1880
    def _diff_pack_names(self):
 
1881
        """Read the pack names from disk, and compare it to the one in memory.
 
1882
 
 
1883
        :return: (disk_nodes, deleted_nodes, new_nodes)
 
1884
            disk_nodes    The final set of nodes that should be referenced
 
1885
            deleted_nodes Nodes which have been removed from when we started
 
1886
            new_nodes     Nodes that are newly introduced
 
1887
        """
 
1888
        # load the disk nodes across
 
1889
        disk_nodes = set()
 
1890
        for index, key, value in self._iter_disk_pack_index():
 
1891
            disk_nodes.add((key, value))
 
1892
        orig_disk_nodes = set(disk_nodes)
 
1893
 
 
1894
        # do a two-way diff against our original content
 
1895
        current_nodes = set()
 
1896
        for name, sizes in self._names.iteritems():
 
1897
            current_nodes.add(
 
1898
                ((name, ), ' '.join(str(size) for size in sizes)))
 
1899
 
 
1900
        # Packs no longer present in the repository, which were present when we
 
1901
        # locked the repository
 
1902
        deleted_nodes = self._packs_at_load - current_nodes
 
1903
        # Packs which this process is adding
 
1904
        new_nodes = current_nodes - self._packs_at_load
 
1905
 
 
1906
        # Update the disk_nodes set to include the ones we are adding, and
 
1907
        # remove the ones which were removed by someone else
 
1908
        disk_nodes.difference_update(deleted_nodes)
 
1909
        disk_nodes.update(new_nodes)
 
1910
 
 
1911
        return disk_nodes, deleted_nodes, new_nodes, orig_disk_nodes
 
1912
 
 
1913
    def _syncronize_pack_names_from_disk_nodes(self, disk_nodes):
 
1914
        """Given the correct set of pack files, update our saved info.
 
1915
 
 
1916
        :return: (removed, added, modified)
 
1917
            removed     pack names removed from self._names
 
1918
            added       pack names added to self._names
 
1919
            modified    pack names that had changed value
 
1920
        """
 
1921
        removed = []
 
1922
        added = []
 
1923
        modified = []
 
1924
        ## self._packs_at_load = disk_nodes
1597
1925
        new_names = dict(disk_nodes)
1598
1926
        # drop no longer present nodes
1599
1927
        for pack in self.all_packs():
1600
1928
            if (pack.name,) not in new_names:
 
1929
                removed.append(pack.name)
1601
1930
                self._remove_pack_from_memory(pack)
1602
1931
        # add new nodes/refresh existing ones
1603
1932
        for key, value in disk_nodes:
1617
1946
                    self._remove_pack_from_memory(self.get_pack_by_name(name))
1618
1947
                    self._names[name] = sizes
1619
1948
                    self.get_pack_by_name(name)
 
1949
                    modified.append(name)
1620
1950
            else:
1621
1951
                # new
1622
1952
                self._names[name] = sizes
1623
1953
                self.get_pack_by_name(name)
1624
 
 
1625
 
    def _clear_obsolete_packs(self):
 
1954
                added.append(name)
 
1955
        return removed, added, modified
 
1956
 
 
1957
    def _save_pack_names(self, clear_obsolete_packs=False, obsolete_packs=None):
 
1958
        """Save the list of packs.
 
1959
 
 
1960
        This will take out the mutex around the pack names list for the
 
1961
        duration of the method call. If concurrent updates have been made, a
 
1962
        three-way merge between the current list and the current in memory list
 
1963
        is performed.
 
1964
 
 
1965
        :param clear_obsolete_packs: If True, clear out the contents of the
 
1966
            obsolete_packs directory.
 
1967
        :param obsolete_packs: Packs that are obsolete once the new pack-names
 
1968
            file has been written.
 
1969
        :return: A list of the names saved that were not previously on disk.
 
1970
        """
 
1971
        already_obsolete = []
 
1972
        self.lock_names()
 
1973
        try:
 
1974
            builder = self._index_builder_class()
 
1975
            (disk_nodes, deleted_nodes, new_nodes,
 
1976
             orig_disk_nodes) = self._diff_pack_names()
 
1977
            # TODO: handle same-name, index-size-changes here -
 
1978
            # e.g. use the value from disk, not ours, *unless* we're the one
 
1979
            # changing it.
 
1980
            for key, value in disk_nodes:
 
1981
                builder.add_node(key, value)
 
1982
            self.transport.put_file('pack-names', builder.finish(),
 
1983
                mode=self.repo.bzrdir._get_file_mode())
 
1984
            self._packs_at_load = disk_nodes
 
1985
            if clear_obsolete_packs:
 
1986
                to_preserve = None
 
1987
                if obsolete_packs:
 
1988
                    to_preserve = set([o.name for o in obsolete_packs])
 
1989
                already_obsolete = self._clear_obsolete_packs(to_preserve)
 
1990
        finally:
 
1991
            self._unlock_names()
 
1992
        # synchronise the memory packs list with what we just wrote:
 
1993
        self._syncronize_pack_names_from_disk_nodes(disk_nodes)
 
1994
        if obsolete_packs:
 
1995
            # TODO: We could add one more condition here. "if o.name not in
 
1996
            #       orig_disk_nodes and o != the new_pack we haven't written to
 
1997
            #       disk yet. However, the new pack object is not easily
 
1998
            #       accessible here (it would have to be passed through the
 
1999
            #       autopacking code, etc.)
 
2000
            obsolete_packs = [o for o in obsolete_packs
 
2001
                              if o.name not in already_obsolete]
 
2002
            self._obsolete_packs(obsolete_packs)
 
2003
        return [new_node[0][0] for new_node in new_nodes]
 
2004
 
 
2005
    def reload_pack_names(self):
 
2006
        """Sync our pack listing with what is present in the repository.
 
2007
 
 
2008
        This should be called when we find out that something we thought was
 
2009
        present is now missing. This happens when another process re-packs the
 
2010
        repository, etc.
 
2011
 
 
2012
        :return: True if the in-memory list of packs has been altered at all.
 
2013
        """
 
2014
        # The ensure_loaded call is to handle the case where the first call
 
2015
        # made involving the collection was to reload_pack_names, where we 
 
2016
        # don't have a view of disk contents. Its a bit of a bandaid, and
 
2017
        # causes two reads of pack-names, but its a rare corner case not struck
 
2018
        # with regular push/pull etc.
 
2019
        first_read = self.ensure_loaded()
 
2020
        if first_read:
 
2021
            return True
 
2022
        # out the new value.
 
2023
        (disk_nodes, deleted_nodes, new_nodes,
 
2024
         orig_disk_nodes) = self._diff_pack_names()
 
2025
        # _packs_at_load is meant to be the explicit list of names in
 
2026
        # 'pack-names' at then start. As such, it should not contain any
 
2027
        # pending names that haven't been written out yet.
 
2028
        self._packs_at_load = orig_disk_nodes
 
2029
        (removed, added,
 
2030
         modified) = self._syncronize_pack_names_from_disk_nodes(disk_nodes)
 
2031
        if removed or added or modified:
 
2032
            return True
 
2033
        return False
 
2034
 
 
2035
    def _restart_autopack(self):
 
2036
        """Reload the pack names list, and restart the autopack code."""
 
2037
        if not self.reload_pack_names():
 
2038
            # Re-raise the original exception, because something went missing
 
2039
            # and a restart didn't find it
 
2040
            raise
 
2041
        raise errors.RetryAutopack(self.repo, False, sys.exc_info())
 
2042
 
 
2043
    def _clear_obsolete_packs(self, preserve=None):
1626
2044
        """Delete everything from the obsolete-packs directory.
 
2045
 
 
2046
        :return: A list of pack identifiers (the filename without '.pack') that
 
2047
            were found in obsolete_packs.
1627
2048
        """
 
2049
        found = []
1628
2050
        obsolete_pack_transport = self.transport.clone('obsolete_packs')
 
2051
        if preserve is None:
 
2052
            preserve = set()
1629
2053
        for filename in obsolete_pack_transport.list_dir('.'):
 
2054
            name, ext = osutils.splitext(filename)
 
2055
            if ext == '.pack':
 
2056
                found.append(name)
 
2057
            if name in preserve:
 
2058
                continue
1630
2059
            try:
1631
2060
                obsolete_pack_transport.delete(filename)
1632
2061
            except (errors.PathError, errors.TransportError), e:
1633
 
                warning("couldn't delete obsolete pack, skipping it:\n%s" % (e,))
 
2062
                warning("couldn't delete obsolete pack, skipping it:\n%s"
 
2063
                        % (e,))
 
2064
        return found
1634
2065
 
1635
2066
    def _start_write_group(self):
1636
2067
        # Do not permit preparation for writing if we're not in a 'write lock'.
1637
2068
        if not self.repo.is_write_locked():
1638
2069
            raise errors.NotWriteLocked(self)
1639
 
        self._new_pack = NewPack(self._upload_transport, self._index_transport,
1640
 
            self._pack_transport, upload_suffix='.pack',
1641
 
            file_mode=self.repo.bzrdir._get_file_mode(),
1642
 
            index_builder_class=self._index_builder_class,
1643
 
            index_class=self._index_class)
 
2070
        self._new_pack = self.pack_factory(self, upload_suffix='.pack',
 
2071
            file_mode=self.repo.bzrdir._get_file_mode())
1644
2072
        # allow writing: queue writes to a new index
1645
2073
        self.revision_index.add_writable_index(self._new_pack.revision_index,
1646
2074
            self._new_pack)
1648
2076
            self._new_pack)
1649
2077
        self.text_index.add_writable_index(self._new_pack.text_index,
1650
2078
            self._new_pack)
 
2079
        self._new_pack.text_index.set_optimize(combine_backing_indices=False)
1651
2080
        self.signature_index.add_writable_index(self._new_pack.signature_index,
1652
2081
            self._new_pack)
 
2082
        if self.chk_index is not None:
 
2083
            self.chk_index.add_writable_index(self._new_pack.chk_index,
 
2084
                self._new_pack)
 
2085
            self.repo.chk_bytes._index._add_callback = self.chk_index.add_callback
 
2086
            self._new_pack.chk_index.set_optimize(combine_backing_indices=False)
1653
2087
 
1654
2088
        self.repo.inventories._index._add_callback = self.inventory_index.add_callback
1655
2089
        self.repo.revisions._index._add_callback = self.revision_index.add_callback
1660
2094
        # FIXME: just drop the transient index.
1661
2095
        # forget what names there are
1662
2096
        if self._new_pack is not None:
1663
 
            self._new_pack.abort()
1664
 
            self._remove_pack_indices(self._new_pack)
1665
 
            self._new_pack = None
1666
 
        self.repo._text_knit = None
1667
 
 
 
2097
            operation = cleanup.OperationWithCleanups(self._new_pack.abort)
 
2098
            operation.add_cleanup(setattr, self, '_new_pack', None)
 
2099
            # If we aborted while in the middle of finishing the write
 
2100
            # group, _remove_pack_indices could fail because the indexes are
 
2101
            # already gone.  But they're not there we shouldn't fail in this
 
2102
            # case, so we pass ignore_missing=True.
 
2103
            operation.add_cleanup(self._remove_pack_indices, self._new_pack,
 
2104
                ignore_missing=True)
 
2105
            operation.run_simple()
 
2106
        for resumed_pack in self._resumed_packs:
 
2107
            operation = cleanup.OperationWithCleanups(resumed_pack.abort)
 
2108
            # See comment in previous finally block.
 
2109
            operation.add_cleanup(self._remove_pack_indices, resumed_pack,
 
2110
                ignore_missing=True)
 
2111
            operation.run_simple()
 
2112
        del self._resumed_packs[:]
 
2113
 
 
2114
    def _remove_resumed_pack_indices(self):
 
2115
        for resumed_pack in self._resumed_packs:
 
2116
            self._remove_pack_indices(resumed_pack)
 
2117
        del self._resumed_packs[:]
 
2118
 
 
2119
    def _check_new_inventories(self):
 
2120
        """Detect missing inventories in this write group.
 
2121
 
 
2122
        :returns: list of strs, summarising any problems found.  If the list is
 
2123
            empty no problems were found.
 
2124
        """
 
2125
        # The base implementation does no checks.  GCRepositoryPackCollection
 
2126
        # overrides this.
 
2127
        return []
 
2128
        
1668
2129
    def _commit_write_group(self):
 
2130
        all_missing = set()
 
2131
        for prefix, versioned_file in (
 
2132
                ('revisions', self.repo.revisions),
 
2133
                ('inventories', self.repo.inventories),
 
2134
                ('texts', self.repo.texts),
 
2135
                ('signatures', self.repo.signatures),
 
2136
                ):
 
2137
            missing = versioned_file.get_missing_compression_parent_keys()
 
2138
            all_missing.update([(prefix,) + key for key in missing])
 
2139
        if all_missing:
 
2140
            raise errors.BzrCheckError(
 
2141
                "Repository %s has missing compression parent(s) %r "
 
2142
                 % (self.repo, sorted(all_missing)))
 
2143
        problems = self._check_new_inventories()
 
2144
        if problems:
 
2145
            problems_summary = '\n'.join(problems)
 
2146
            raise errors.BzrCheckError(
 
2147
                "Cannot add revision(s) to repository: " + problems_summary)
1669
2148
        self._remove_pack_indices(self._new_pack)
 
2149
        any_new_content = False
1670
2150
        if self._new_pack.data_inserted():
1671
2151
            # get all the data to disk and read to use
1672
2152
            self._new_pack.finish()
1673
2153
            self.allocate(self._new_pack)
1674
2154
            self._new_pack = None
1675
 
            if not self.autopack():
 
2155
            any_new_content = True
 
2156
        else:
 
2157
            self._new_pack.abort()
 
2158
            self._new_pack = None
 
2159
        for resumed_pack in self._resumed_packs:
 
2160
            # XXX: this is a pretty ugly way to turn the resumed pack into a
 
2161
            # properly committed pack.
 
2162
            self._names[resumed_pack.name] = None
 
2163
            self._remove_pack_from_memory(resumed_pack)
 
2164
            resumed_pack.finish()
 
2165
            self.allocate(resumed_pack)
 
2166
            any_new_content = True
 
2167
        del self._resumed_packs[:]
 
2168
        if any_new_content:
 
2169
            result = self.autopack()
 
2170
            if not result:
1676
2171
                # when autopack takes no steps, the names list is still
1677
2172
                # unsaved.
1678
 
                self._save_pack_names()
 
2173
                return self._save_pack_names()
 
2174
            return result
 
2175
        return []
 
2176
 
 
2177
    def _suspend_write_group(self):
 
2178
        tokens = [pack.name for pack in self._resumed_packs]
 
2179
        self._remove_pack_indices(self._new_pack)
 
2180
        if self._new_pack.data_inserted():
 
2181
            # get all the data to disk and read to use
 
2182
            self._new_pack.finish(suspend=True)
 
2183
            tokens.append(self._new_pack.name)
 
2184
            self._new_pack = None
1679
2185
        else:
1680
2186
            self._new_pack.abort()
1681
2187
            self._new_pack = None
1682
 
        self.repo._text_knit = None
 
2188
        self._remove_resumed_pack_indices()
 
2189
        return tokens
 
2190
 
 
2191
    def _resume_write_group(self, tokens):
 
2192
        for token in tokens:
 
2193
            self._resume_pack(token)
1683
2194
 
1684
2195
 
1685
2196
class KnitPackRepository(KnitRepository):
1686
2197
    """Repository with knit objects stored inside pack containers.
1687
 
    
 
2198
 
1688
2199
    The layering for a KnitPackRepository is:
1689
2200
 
1690
2201
    Graph        |  HPSS    | Repository public layer |
1704
2215
      pack file. The GraphIndex layer works in N-tuples and is unaware of any
1705
2216
      semantic value.
1706
2217
    ===================================================
1707
 
    
 
2218
 
1708
2219
    """
1709
2220
 
1710
2221
    def __init__(self, _format, a_bzrdir, control_files, _commit_builder_class,
1717
2228
            self._transport.clone('upload'),
1718
2229
            self._transport.clone('packs'),
1719
2230
            _format.index_builder_class,
1720
 
            _format.index_class)
 
2231
            _format.index_class,
 
2232
            use_chk_index=self._format.supports_chks,
 
2233
            )
1721
2234
        self.inventories = KnitVersionedFiles(
1722
2235
            _KnitGraphIndex(self._pack_collection.inventory_index.combined_index,
1723
2236
                add_callback=self._pack_collection.inventory_index.add_callback,
1727
2240
        self.revisions = KnitVersionedFiles(
1728
2241
            _KnitGraphIndex(self._pack_collection.revision_index.combined_index,
1729
2242
                add_callback=self._pack_collection.revision_index.add_callback,
1730
 
                deltas=False, parents=True, is_locked=self.is_locked),
 
2243
                deltas=False, parents=True, is_locked=self.is_locked,
 
2244
                track_external_parent_refs=True),
1731
2245
            data_access=self._pack_collection.revision_index.data_access,
1732
2246
            max_delta_chain=0)
1733
2247
        self.signatures = KnitVersionedFiles(
1742
2256
                deltas=True, parents=True, is_locked=self.is_locked),
1743
2257
            data_access=self._pack_collection.text_index.data_access,
1744
2258
            max_delta_chain=200)
 
2259
        if _format.supports_chks:
 
2260
            # No graph, no compression:- references from chks are between
 
2261
            # different objects not temporal versions of the same; and without
 
2262
            # some sort of temporal structure knit compression will just fail.
 
2263
            self.chk_bytes = KnitVersionedFiles(
 
2264
                _KnitGraphIndex(self._pack_collection.chk_index.combined_index,
 
2265
                    add_callback=self._pack_collection.chk_index.add_callback,
 
2266
                    deltas=False, parents=False, is_locked=self.is_locked),
 
2267
                data_access=self._pack_collection.chk_index.data_access,
 
2268
                max_delta_chain=0)
 
2269
        else:
 
2270
            self.chk_bytes = None
1745
2271
        # True when the repository object is 'write locked' (as opposed to the
1746
 
        # physical lock only taken out around changes to the pack-names list.) 
 
2272
        # physical lock only taken out around changes to the pack-names list.)
1747
2273
        # Another way to represent this would be a decorator around the control
1748
2274
        # files object that presents logical locks as physical ones - if this
1749
2275
        # gets ugly consider that alternative design. RBC 20071011
1753
2279
        self._reconcile_does_inventory_gc = True
1754
2280
        self._reconcile_fixes_text_parents = True
1755
2281
        self._reconcile_backsup_inventory = False
1756
 
        self._fetch_order = 'unordered'
1757
2282
 
1758
 
    def _warn_if_deprecated(self):
 
2283
    def _warn_if_deprecated(self, branch=None):
1759
2284
        # This class isn't deprecated, but one sub-format is
1760
2285
        if isinstance(self._format, RepositoryFormatKnitPack5RichRootBroken):
1761
 
            from bzrlib import repository
1762
 
            if repository._deprecation_warning_done:
1763
 
                return
1764
 
            repository._deprecation_warning_done = True
1765
 
            warning("Format %s for %s is deprecated - please use"
1766
 
                    " 'bzr upgrade --1.6.1-rich-root'"
1767
 
                    % (self._format, self.bzrdir.transport.base))
 
2286
            super(KnitPackRepository, self)._warn_if_deprecated(branch)
1768
2287
 
1769
2288
    def _abort_write_group(self):
 
2289
        self.revisions._index._key_dependencies.clear()
1770
2290
        self._pack_collection._abort_write_group()
1771
2291
 
1772
 
    def _find_inconsistent_revision_parents(self):
1773
 
        """Find revisions with incorrectly cached parents.
1774
 
 
1775
 
        :returns: an iterator yielding tuples of (revison-id, parents-in-index,
1776
 
            parents-in-revision).
1777
 
        """
1778
 
        if not self.is_locked():
1779
 
            raise errors.ObjectNotLocked(self)
1780
 
        pb = ui.ui_factory.nested_progress_bar()
1781
 
        result = []
1782
 
        try:
1783
 
            revision_nodes = self._pack_collection.revision_index \
1784
 
                .combined_index.iter_all_entries()
1785
 
            index_positions = []
1786
 
            # Get the cached index values for all revisions, and also the location
1787
 
            # in each index of the revision text so we can perform linear IO.
1788
 
            for index, key, value, refs in revision_nodes:
1789
 
                pos, length = value[1:].split(' ')
1790
 
                index_positions.append((index, int(pos), key[0],
1791
 
                    tuple(parent[0] for parent in refs[0])))
1792
 
                pb.update("Reading revision index.", 0, 0)
1793
 
            index_positions.sort()
1794
 
            batch_count = len(index_positions) / 1000 + 1
1795
 
            pb.update("Checking cached revision graph.", 0, batch_count)
1796
 
            for offset in xrange(batch_count):
1797
 
                pb.update("Checking cached revision graph.", offset)
1798
 
                to_query = index_positions[offset * 1000:(offset + 1) * 1000]
1799
 
                if not to_query:
1800
 
                    break
1801
 
                rev_ids = [item[2] for item in to_query]
1802
 
                revs = self.get_revisions(rev_ids)
1803
 
                for revision, item in zip(revs, to_query):
1804
 
                    index_parents = item[3]
1805
 
                    rev_parents = tuple(revision.parent_ids)
1806
 
                    if index_parents != rev_parents:
1807
 
                        result.append((revision.revision_id, index_parents, rev_parents))
1808
 
        finally:
1809
 
            pb.finished()
1810
 
        return result
1811
 
 
1812
 
    @symbol_versioning.deprecated_method(symbol_versioning.one_one)
1813
 
    def get_parents(self, revision_ids):
1814
 
        """See graph._StackedParentsProvider.get_parents."""
1815
 
        parent_map = self.get_parent_map(revision_ids)
1816
 
        return [parent_map.get(r, None) for r in revision_ids]
 
2292
    def _get_source(self, to_format):
 
2293
        if to_format.network_name() == self._format.network_name():
 
2294
            return KnitPackStreamSource(self, to_format)
 
2295
        return super(KnitPackRepository, self)._get_source(to_format)
1817
2296
 
1818
2297
    def _make_parents_provider(self):
1819
2298
        return graph.CachingParentsProvider(self)
1820
2299
 
1821
2300
    def _refresh_data(self):
1822
 
        if self._write_lock_count == 1 or (
1823
 
            self.control_files._lock_count == 1 and
1824
 
            self.control_files._lock_mode == 'r'):
1825
 
            # forget what names there are
1826
 
            self._pack_collection.reset()
1827
 
            # XXX: Better to do an in-memory merge when acquiring a new lock -
1828
 
            # factor out code from _save_pack_names.
1829
 
            self._pack_collection.ensure_loaded()
 
2301
        if not self.is_locked():
 
2302
            return
 
2303
        self._pack_collection.reload_pack_names()
1830
2304
 
1831
2305
    def _start_write_group(self):
1832
2306
        self._pack_collection._start_write_group()
1833
2307
 
1834
2308
    def _commit_write_group(self):
1835
 
        return self._pack_collection._commit_write_group()
 
2309
        hint = self._pack_collection._commit_write_group()
 
2310
        self.revisions._index._key_dependencies.clear()
 
2311
        return hint
 
2312
 
 
2313
    def suspend_write_group(self):
 
2314
        # XXX check self._write_group is self.get_transaction()?
 
2315
        tokens = self._pack_collection._suspend_write_group()
 
2316
        self.revisions._index._key_dependencies.clear()
 
2317
        self._write_group = None
 
2318
        return tokens
 
2319
 
 
2320
    def _resume_write_group(self, tokens):
 
2321
        self._start_write_group()
 
2322
        try:
 
2323
            self._pack_collection._resume_write_group(tokens)
 
2324
        except errors.UnresumableWriteGroup:
 
2325
            self._abort_write_group()
 
2326
            raise
 
2327
        for pack in self._pack_collection._resumed_packs:
 
2328
            self.revisions._index.scan_unvalidated_index(pack.revision_index)
1836
2329
 
1837
2330
    def get_transaction(self):
1838
2331
        if self._write_lock_count:
1847
2340
        return self._write_lock_count
1848
2341
 
1849
2342
    def lock_write(self, token=None):
1850
 
        if not self._write_lock_count and self.is_locked():
 
2343
        locked = self.is_locked()
 
2344
        if not self._write_lock_count and locked:
1851
2345
            raise errors.ReadOnlyError(self)
1852
2346
        self._write_lock_count += 1
1853
2347
        if self._write_lock_count == 1:
1854
2348
            self._transaction = transactions.WriteTransaction()
 
2349
        if not locked:
 
2350
            if 'relock' in debug.debug_flags and self._prev_lock == 'w':
 
2351
                note('%r was write locked again', self)
 
2352
            self._prev_lock = 'w'
1855
2353
            for repo in self._fallback_repositories:
1856
2354
                # Writes don't affect fallback repos
1857
2355
                repo.lock_read()
1858
 
        self._refresh_data()
 
2356
            self._refresh_data()
1859
2357
 
1860
2358
    def lock_read(self):
 
2359
        locked = self.is_locked()
1861
2360
        if self._write_lock_count:
1862
2361
            self._write_lock_count += 1
1863
2362
        else:
1864
2363
            self.control_files.lock_read()
 
2364
        if not locked:
 
2365
            if 'relock' in debug.debug_flags and self._prev_lock == 'r':
 
2366
                note('%r was read locked again', self)
 
2367
            self._prev_lock = 'r'
1865
2368
            for repo in self._fallback_repositories:
1866
 
                # Writes don't affect fallback repos
1867
2369
                repo.lock_read()
1868
 
        self._refresh_data()
 
2370
            self._refresh_data()
1869
2371
 
1870
2372
    def leave_lock_in_place(self):
1871
2373
        # not supported - raise an error
1876
2378
        raise NotImplementedError(self.dont_leave_lock_in_place)
1877
2379
 
1878
2380
    @needs_write_lock
1879
 
    def pack(self):
 
2381
    def pack(self, hint=None, clean_obsolete_packs=False):
1880
2382
        """Compress the data within the repository.
1881
2383
 
1882
2384
        This will pack all the data to a single pack. In future it may
1883
2385
        recompress deltas or do other such expensive operations.
1884
2386
        """
1885
 
        self._pack_collection.pack()
 
2387
        self._pack_collection.pack(hint=hint, clean_obsolete_packs=clean_obsolete_packs)
1886
2388
 
1887
2389
    @needs_write_lock
1888
2390
    def reconcile(self, other=None, thorough=False):
1892
2394
        reconciler.reconcile()
1893
2395
        return reconciler
1894
2396
 
 
2397
    def _reconcile_pack(self, collection, packs, extension, revs, pb):
 
2398
        packer = ReconcilePacker(collection, packs, extension, revs)
 
2399
        return packer.pack(pb)
 
2400
 
 
2401
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1895
2402
    def unlock(self):
1896
2403
        if self._write_lock_count == 1 and self._write_group is not None:
1897
2404
            self.abort_write_group()
1906
2413
                transaction = self._transaction
1907
2414
                self._transaction = None
1908
2415
                transaction.finish()
1909
 
                for repo in self._fallback_repositories:
1910
 
                    repo.unlock()
1911
2416
        else:
1912
2417
            self.control_files.unlock()
 
2418
 
 
2419
        if not self.is_locked():
1913
2420
            for repo in self._fallback_repositories:
1914
2421
                repo.unlock()
1915
2422
 
1916
2423
 
 
2424
class KnitPackStreamSource(StreamSource):
 
2425
    """A StreamSource used to transfer data between same-format KnitPack repos.
 
2426
 
 
2427
    This source assumes:
 
2428
        1) Same serialization format for all objects
 
2429
        2) Same root information
 
2430
        3) XML format inventories
 
2431
        4) Atomic inserts (so we can stream inventory texts before text
 
2432
           content)
 
2433
        5) No chk_bytes
 
2434
    """
 
2435
 
 
2436
    def __init__(self, from_repository, to_format):
 
2437
        super(KnitPackStreamSource, self).__init__(from_repository, to_format)
 
2438
        self._text_keys = None
 
2439
        self._text_fetch_order = 'unordered'
 
2440
 
 
2441
    def _get_filtered_inv_stream(self, revision_ids):
 
2442
        from_repo = self.from_repository
 
2443
        parent_ids = from_repo._find_parent_ids_of_revisions(revision_ids)
 
2444
        parent_keys = [(p,) for p in parent_ids]
 
2445
        find_text_keys = from_repo._find_text_key_references_from_xml_inventory_lines
 
2446
        parent_text_keys = set(find_text_keys(
 
2447
            from_repo._inventory_xml_lines_for_keys(parent_keys)))
 
2448
        content_text_keys = set()
 
2449
        knit = KnitVersionedFiles(None, None)
 
2450
        factory = KnitPlainFactory()
 
2451
        def find_text_keys_from_content(record):
 
2452
            if record.storage_kind not in ('knit-delta-gz', 'knit-ft-gz'):
 
2453
                raise ValueError("Unknown content storage kind for"
 
2454
                    " inventory text: %s" % (record.storage_kind,))
 
2455
            # It's a knit record, it has a _raw_record field (even if it was
 
2456
            # reconstituted from a network stream).
 
2457
            raw_data = record._raw_record
 
2458
            # read the entire thing
 
2459
            revision_id = record.key[-1]
 
2460
            content, _ = knit._parse_record(revision_id, raw_data)
 
2461
            if record.storage_kind == 'knit-delta-gz':
 
2462
                line_iterator = factory.get_linedelta_content(content)
 
2463
            elif record.storage_kind == 'knit-ft-gz':
 
2464
                line_iterator = factory.get_fulltext_content(content)
 
2465
            content_text_keys.update(find_text_keys(
 
2466
                [(line, revision_id) for line in line_iterator]))
 
2467
        revision_keys = [(r,) for r in revision_ids]
 
2468
        def _filtered_inv_stream():
 
2469
            source_vf = from_repo.inventories
 
2470
            stream = source_vf.get_record_stream(revision_keys,
 
2471
                                                 'unordered', False)
 
2472
            for record in stream:
 
2473
                if record.storage_kind == 'absent':
 
2474
                    raise errors.NoSuchRevision(from_repo, record.key)
 
2475
                find_text_keys_from_content(record)
 
2476
                yield record
 
2477
            self._text_keys = content_text_keys - parent_text_keys
 
2478
        return ('inventories', _filtered_inv_stream())
 
2479
 
 
2480
    def _get_text_stream(self):
 
2481
        # Note: We know we don't have to handle adding root keys, because both
 
2482
        # the source and target are the identical network name.
 
2483
        text_stream = self.from_repository.texts.get_record_stream(
 
2484
                        self._text_keys, self._text_fetch_order, False)
 
2485
        return ('texts', text_stream)
 
2486
 
 
2487
    def get_stream(self, search):
 
2488
        revision_ids = search.get_keys()
 
2489
        for stream_info in self._fetch_revision_texts(revision_ids):
 
2490
            yield stream_info
 
2491
        self._revision_keys = [(rev_id,) for rev_id in revision_ids]
 
2492
        yield self._get_filtered_inv_stream(revision_ids)
 
2493
        yield self._get_text_stream()
 
2494
 
 
2495
 
 
2496
 
1917
2497
class RepositoryFormatPack(MetaDirRepositoryFormat):
1918
2498
    """Format logic for pack structured repositories.
1919
2499
 
1939
2519
    # Set this attribute in derived clases to control the _serializer that the
1940
2520
    # repository objects will have passed to their constructor.
1941
2521
    _serializer = None
 
2522
    # Packs are not confused by ghosts.
 
2523
    supports_ghosts = True
1942
2524
    # External references are not supported in pack repositories yet.
1943
2525
    supports_external_lookups = False
 
2526
    # Most pack formats do not use chk lookups.
 
2527
    supports_chks = False
1944
2528
    # What index classes to use
1945
2529
    index_builder_class = None
1946
2530
    index_class = None
 
2531
    _fetch_uses_deltas = True
 
2532
    fast_deltas = False
1947
2533
 
1948
2534
    def initialize(self, a_bzrdir, shared=False):
1949
2535
        """Create a pack based repository.
1958
2544
        builder = self.index_builder_class()
1959
2545
        files = [('pack-names', builder.finish())]
1960
2546
        utf8_files = [('format', self.get_format_string())]
1961
 
        
 
2547
 
1962
2548
        self._upload_blank_content(a_bzrdir, dirs, files, utf8_files, shared)
1963
2549
        return self.open(a_bzrdir=a_bzrdir, _found=True)
1964
2550
 
1965
2551
    def open(self, a_bzrdir, _found=False, _override_transport=None):
1966
2552
        """See RepositoryFormat.open().
1967
 
        
 
2553
 
1968
2554
        :param _override_transport: INTERNAL USE ONLY. Allows opening the
1969
2555
                                    repository at a slightly different url
1970
2556
                                    than normal. I.e. during 'upgrade'.
1992
2578
 
1993
2579
    repository_class = KnitPackRepository
1994
2580
    _commit_builder_class = PackCommitBuilder
1995
 
    _serializer = xml5.serializer_v5
 
2581
    @property
 
2582
    def _serializer(self):
 
2583
        return xml5.serializer_v5
1996
2584
    # What index classes to use
1997
2585
    index_builder_class = InMemoryGraphIndex
1998
2586
    index_class = GraphIndex
2013
2601
        """See RepositoryFormat.get_format_description()."""
2014
2602
        return "Packs containing knits without subtree support"
2015
2603
 
2016
 
    def check_conversion_target(self, target_format):
2017
 
        pass
2018
 
 
2019
2604
 
2020
2605
class RepositoryFormatKnitPack3(RepositoryFormatPack):
2021
2606
    """A subtrees parameterized Pack repository.
2030
2615
    repository_class = KnitPackRepository
2031
2616
    _commit_builder_class = PackRootCommitBuilder
2032
2617
    rich_root_data = True
 
2618
    experimental = True
2033
2619
    supports_tree_reference = True
2034
 
    _serializer = xml7.serializer_v7
 
2620
    @property
 
2621
    def _serializer(self):
 
2622
        return xml7.serializer_v7
2035
2623
    # What index classes to use
2036
2624
    index_builder_class = InMemoryGraphIndex
2037
2625
    index_class = GraphIndex
2045
2633
 
2046
2634
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2047
2635
 
2048
 
    def check_conversion_target(self, target_format):
2049
 
        if not target_format.rich_root_data:
2050
 
            raise errors.BadConversionTarget(
2051
 
                'Does not support rich root data.', target_format)
2052
 
        if not getattr(target_format, 'supports_tree_reference', False):
2053
 
            raise errors.BadConversionTarget(
2054
 
                'Does not support nested trees', target_format)
2055
 
            
2056
2636
    def get_format_string(self):
2057
2637
        """See RepositoryFormat.get_format_string()."""
2058
2638
        return "Bazaar pack repository format 1 with subtree support (needs bzr 0.92)\n"
2075
2655
    _commit_builder_class = PackRootCommitBuilder
2076
2656
    rich_root_data = True
2077
2657
    supports_tree_reference = False
2078
 
    _serializer = xml6.serializer_v6
 
2658
    @property
 
2659
    def _serializer(self):
 
2660
        return xml6.serializer_v6
2079
2661
    # What index classes to use
2080
2662
    index_builder_class = InMemoryGraphIndex
2081
2663
    index_class = GraphIndex
2089
2671
 
2090
2672
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2091
2673
 
2092
 
    def check_conversion_target(self, target_format):
2093
 
        if not target_format.rich_root_data:
2094
 
            raise errors.BadConversionTarget(
2095
 
                'Does not support rich root data.', target_format)
2096
 
 
2097
2674
    def get_format_string(self):
2098
2675
        """See RepositoryFormat.get_format_string()."""
2099
2676
        return ("Bazaar pack repository format 1 with rich root"
2115
2692
 
2116
2693
    repository_class = KnitPackRepository
2117
2694
    _commit_builder_class = PackCommitBuilder
2118
 
    _serializer = xml5.serializer_v5
2119
2695
    supports_external_lookups = True
2120
2696
    # What index classes to use
2121
2697
    index_builder_class = InMemoryGraphIndex
2122
2698
    index_class = GraphIndex
2123
2699
 
 
2700
    @property
 
2701
    def _serializer(self):
 
2702
        return xml5.serializer_v5
 
2703
 
2124
2704
    def _get_matching_bzrdir(self):
2125
2705
        return bzrdir.format_registry.make_bzrdir('1.6')
2126
2706
 
2137
2717
        """See RepositoryFormat.get_format_description()."""
2138
2718
        return "Packs 5 (adds stacking support, requires bzr 1.6)"
2139
2719
 
2140
 
    def check_conversion_target(self, target_format):
2141
 
        pass
2142
 
 
2143
2720
 
2144
2721
class RepositoryFormatKnitPack5RichRoot(RepositoryFormatPack):
2145
2722
    """A repository with rich roots and stacking.
2154
2731
    _commit_builder_class = PackRootCommitBuilder
2155
2732
    rich_root_data = True
2156
2733
    supports_tree_reference = False # no subtrees
2157
 
    _serializer = xml6.serializer_v6
2158
2734
    supports_external_lookups = True
2159
2735
    # What index classes to use
2160
2736
    index_builder_class = InMemoryGraphIndex
2161
2737
    index_class = GraphIndex
2162
2738
 
 
2739
    @property
 
2740
    def _serializer(self):
 
2741
        return xml6.serializer_v6
 
2742
 
2163
2743
    def _get_matching_bzrdir(self):
2164
2744
        return bzrdir.format_registry.make_bzrdir(
2165
2745
            '1.6.1-rich-root')
2169
2749
 
2170
2750
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2171
2751
 
2172
 
    def check_conversion_target(self, target_format):
2173
 
        if not target_format.rich_root_data:
2174
 
            raise errors.BadConversionTarget(
2175
 
                'Does not support rich root data.', target_format)
2176
 
 
2177
2752
    def get_format_string(self):
2178
2753
        """See RepositoryFormat.get_format_string()."""
2179
2754
        return "Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6.1)\n"
2199
2774
    _commit_builder_class = PackRootCommitBuilder
2200
2775
    rich_root_data = True
2201
2776
    supports_tree_reference = False # no subtrees
2202
 
    _serializer = xml7.serializer_v7
2203
2777
 
2204
2778
    supports_external_lookups = True
2205
2779
    # What index classes to use
2206
2780
    index_builder_class = InMemoryGraphIndex
2207
2781
    index_class = GraphIndex
2208
2782
 
 
2783
    @property
 
2784
    def _serializer(self):
 
2785
        return xml7.serializer_v7
 
2786
 
2209
2787
    def _get_matching_bzrdir(self):
2210
 
        return bzrdir.format_registry.make_bzrdir(
 
2788
        matching = bzrdir.format_registry.make_bzrdir(
2211
2789
            '1.6.1-rich-root')
 
2790
        matching.repository_format = self
 
2791
        return matching
2212
2792
 
2213
2793
    def _ignore_setting_bzrdir(self, format):
2214
2794
        pass
2215
2795
 
2216
2796
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2217
2797
 
2218
 
    def check_conversion_target(self, target_format):
2219
 
        if not target_format.rich_root_data:
2220
 
            raise errors.BadConversionTarget(
2221
 
                'Does not support rich root data.', target_format)
2222
 
 
2223
2798
    def get_format_string(self):
2224
2799
        """See RepositoryFormat.get_format_string()."""
2225
2800
        return "Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6)\n"
2229
2804
                " (deprecated)")
2230
2805
 
2231
2806
 
2232
 
class RepositoryFormatPackDevelopment2(RepositoryFormatPack):
2233
 
    """A no-subtrees development repository.
2234
 
 
2235
 
    This format should be retained until the second release after bzr 1.7.
2236
 
 
2237
 
    This is pack-1.6.1 with B+Tree indices.
 
2807
class RepositoryFormatKnitPack6(RepositoryFormatPack):
 
2808
    """A repository with stacking and btree indexes,
 
2809
    without rich roots or subtrees.
 
2810
 
 
2811
    This is equivalent to pack-1.6 with B+Tree indices.
2238
2812
    """
2239
2813
 
2240
2814
    repository_class = KnitPackRepository
2241
2815
    _commit_builder_class = PackCommitBuilder
2242
 
    _serializer = xml5.serializer_v5
2243
2816
    supports_external_lookups = True
2244
2817
    # What index classes to use
2245
2818
    index_builder_class = BTreeBuilder
2246
2819
    index_class = BTreeGraphIndex
2247
2820
 
 
2821
    @property
 
2822
    def _serializer(self):
 
2823
        return xml5.serializer_v5
 
2824
 
2248
2825
    def _get_matching_bzrdir(self):
2249
 
        return bzrdir.format_registry.make_bzrdir('development2')
 
2826
        return bzrdir.format_registry.make_bzrdir('1.9')
2250
2827
 
2251
2828
    def _ignore_setting_bzrdir(self, format):
2252
2829
        pass
2255
2832
 
2256
2833
    def get_format_string(self):
2257
2834
        """See RepositoryFormat.get_format_string()."""
2258
 
        return "Bazaar development format 2 (needs bzr.dev from before 1.8)\n"
 
2835
        return "Bazaar RepositoryFormatKnitPack6 (bzr 1.9)\n"
2259
2836
 
2260
2837
    def get_format_description(self):
2261
2838
        """See RepositoryFormat.get_format_description()."""
2262
 
        return ("Development repository format, currently the same as "
2263
 
            "1.6.1 with B+Trees.\n")
2264
 
 
2265
 
    def check_conversion_target(self, target_format):
 
2839
        return "Packs 6 (uses btree indexes, requires bzr 1.9)"
 
2840
 
 
2841
 
 
2842
class RepositoryFormatKnitPack6RichRoot(RepositoryFormatPack):
 
2843
    """A repository with rich roots, no subtrees, stacking and btree indexes.
 
2844
 
 
2845
    1.6-rich-root with B+Tree indices.
 
2846
    """
 
2847
 
 
2848
    repository_class = KnitPackRepository
 
2849
    _commit_builder_class = PackRootCommitBuilder
 
2850
    rich_root_data = True
 
2851
    supports_tree_reference = False # no subtrees
 
2852
    supports_external_lookups = True
 
2853
    # What index classes to use
 
2854
    index_builder_class = BTreeBuilder
 
2855
    index_class = BTreeGraphIndex
 
2856
 
 
2857
    @property
 
2858
    def _serializer(self):
 
2859
        return xml6.serializer_v6
 
2860
 
 
2861
    def _get_matching_bzrdir(self):
 
2862
        return bzrdir.format_registry.make_bzrdir(
 
2863
            '1.9-rich-root')
 
2864
 
 
2865
    def _ignore_setting_bzrdir(self, format):
2266
2866
        pass
2267
2867
 
 
2868
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
 
2869
 
 
2870
    def get_format_string(self):
 
2871
        """See RepositoryFormat.get_format_string()."""
 
2872
        return "Bazaar RepositoryFormatKnitPack6RichRoot (bzr 1.9)\n"
 
2873
 
 
2874
    def get_format_description(self):
 
2875
        return "Packs 6 rich-root (uses btree indexes, requires bzr 1.9)"
 
2876
 
2268
2877
 
2269
2878
class RepositoryFormatPackDevelopment2Subtree(RepositoryFormatPack):
2270
2879
    """A subtrees development repository.
2272
2881
    This format should be retained until the second release after bzr 1.7.
2273
2882
 
2274
2883
    1.6.1-subtree[as it might have been] with B+Tree indices.
 
2884
 
 
2885
    This is [now] retained until we have a CHK based subtree format in
 
2886
    development.
2275
2887
    """
2276
2888
 
2277
2889
    repository_class = KnitPackRepository
2278
2890
    _commit_builder_class = PackRootCommitBuilder
2279
2891
    rich_root_data = True
 
2892
    experimental = True
2280
2893
    supports_tree_reference = True
2281
 
    _serializer = xml7.serializer_v7
2282
2894
    supports_external_lookups = True
2283
2895
    # What index classes to use
2284
2896
    index_builder_class = BTreeBuilder
2285
2897
    index_class = BTreeGraphIndex
2286
2898
 
 
2899
    @property
 
2900
    def _serializer(self):
 
2901
        return xml7.serializer_v7
 
2902
 
2287
2903
    def _get_matching_bzrdir(self):
2288
2904
        return bzrdir.format_registry.make_bzrdir(
2289
 
            'development2-subtree')
 
2905
            'development-subtree')
2290
2906
 
2291
2907
    def _ignore_setting_bzrdir(self, format):
2292
2908
        pass
2293
2909
 
2294
2910
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2295
2911
 
2296
 
    def check_conversion_target(self, target_format):
2297
 
        if not target_format.rich_root_data:
2298
 
            raise errors.BadConversionTarget(
2299
 
                'Does not support rich root data.', target_format)
2300
 
        if not getattr(target_format, 'supports_tree_reference', False):
2301
 
            raise errors.BadConversionTarget(
2302
 
                'Does not support nested trees', target_format)
2303
 
            
2304
2912
    def get_format_string(self):
2305
2913
        """See RepositoryFormat.get_format_string()."""
2306
2914
        return ("Bazaar development format 2 with subtree support "
2310
2918
        """See RepositoryFormat.get_format_description()."""
2311
2919
        return ("Development repository format, currently the same as "
2312
2920
            "1.6.1-subtree with B+Tree indices.\n")
 
2921