/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: Canonical.com Patch Queue Manager
  • Date: 2008-10-23 17:59:52 UTC
  • mfrom: (3788.1.5 msvc_python24)
  • Revision ID: pqm@pqm.ubuntu.com-20081023175952-0gr8np56nf6ab5yn
(jam) Allow extensions to compile for python2.4 and using msvc

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2007-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
 
 
17
 
import re
18
 
import sys
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19
16
 
20
17
from bzrlib.lazy_import import lazy_import
21
18
lazy_import(globals(), """
23
20
import time
24
21
 
25
22
from bzrlib import (
26
 
    chk_map,
27
 
    cleanup,
28
23
    debug,
29
24
    graph,
30
25
    osutils,
37
32
    )
38
33
from bzrlib.index import (
39
34
    CombinedGraphIndex,
 
35
    GraphIndex,
 
36
    GraphIndexBuilder,
40
37
    GraphIndexPrefixAdapter,
 
38
    InMemoryGraphIndex,
41
39
    )
42
40
from bzrlib.knit import (
43
41
    KnitPlainFactory,
52
50
    errors,
53
51
    lockable_files,
54
52
    lockdir,
55
 
    revision as _mod_revision,
 
53
    symbol_versioning,
56
54
    )
57
55
 
58
 
from bzrlib.decorators import needs_write_lock, only_raises
 
56
from bzrlib.decorators import needs_write_lock
59
57
from bzrlib.btree_index import (
60
58
    BTreeGraphIndex,
61
59
    BTreeBuilder,
70
68
    MetaDirRepositoryFormat,
71
69
    RepositoryFormat,
72
70
    RootCommitBuilder,
73
 
    StreamSource,
74
71
    )
 
72
import bzrlib.revision as _mod_revision
75
73
from bzrlib.trace import (
76
74
    mutter,
77
 
    note,
78
75
    warning,
79
76
    )
80
77
 
81
78
 
82
79
class PackCommitBuilder(CommitBuilder):
83
80
    """A subclass of CommitBuilder to add texts with pack semantics.
84
 
 
 
81
    
85
82
    Specifically this uses one knit object rather than one knit object per
86
83
    added text, reducing memory and object pressure.
87
84
    """
102
99
 
103
100
class PackRootCommitBuilder(RootCommitBuilder):
104
101
    """A subclass of RootCommitBuilder to add texts with pack semantics.
105
 
 
 
102
    
106
103
    Specifically this uses one knit object rather than one knit object per
107
104
    added text, reducing memory and object pressure.
108
105
    """
128
125
    ExistingPack and NewPack are used.
129
126
    """
130
127
 
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
 
 
141
128
    def __init__(self, revision_index, inventory_index, text_index,
142
 
        signature_index, chk_index=None):
 
129
        signature_index):
143
130
        """Create a pack instance.
144
131
 
145
132
        :param revision_index: A GraphIndex for determining what revisions are
152
139
            texts/deltas (via (fileid, revisionid) tuples).
153
140
        :param signature_index: A GraphIndex for determining what signatures are
154
141
            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.
157
142
        """
158
143
        self.revision_index = revision_index
159
144
        self.inventory_index = inventory_index
160
145
        self.text_index = text_index
161
146
        self.signature_index = signature_index
162
 
        self.chk_index = chk_index
163
147
 
164
148
    def access_tuple(self):
165
149
        """Return a tuple (transport, name) for the pack content."""
166
150
        return self.pack_transport, self.file_name()
167
151
 
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
 
 
197
152
    def file_name(self):
198
153
        """Get the file name for the pack on disk."""
199
154
        return self.name + '.pack'
201
156
    def get_revision_count(self):
202
157
        return self.revision_index.key_count()
203
158
 
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
 
 
212
159
    def inventory_index_name(self, name):
213
160
        """The inv index is the name + .iix."""
214
161
        return self.index_name('inventory', name)
225
172
        """The text index is the name + .tix."""
226
173
        return self.index_name('text', name)
227
174
 
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))
 
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
237
182
 
238
183
 
239
184
class ExistingPack(Pack):
240
185
    """An in memory proxy for an existing .pack and its disk indices."""
241
186
 
242
187
    def __init__(self, pack_transport, name, revision_index, inventory_index,
243
 
        text_index, signature_index, chk_index=None):
 
188
        text_index, signature_index):
244
189
        """Create an ExistingPack object.
245
190
 
246
191
        :param pack_transport: The transport where the pack file resides.
247
192
        :param name: The name of the pack on disk in the pack_transport.
248
193
        """
249
194
        Pack.__init__(self, revision_index, inventory_index, text_index,
250
 
            signature_index, chk_index)
 
195
            signature_index)
251
196
        self.name = name
252
197
        self.pack_transport = pack_transport
253
198
        if None in (revision_index, inventory_index, text_index,
261
206
        return not self.__eq__(other)
262
207
 
263
208
    def __repr__(self):
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)
 
209
        return "<bzrlib.repofmt.pack_repo.Pack object at 0x%x, %s, %s" % (
 
210
            id(self), self.pack_transport, self.name)
336
211
 
337
212
 
338
213
class NewPack(Pack):
339
214
    """An in memory proxy for a pack which is being created."""
340
215
 
341
 
    def __init__(self, pack_collection, upload_suffix='', file_mode=None):
 
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):
342
228
        """Create a NewPack instance.
343
229
 
344
 
        :param pack_collection: A PackCollection into which this is being inserted.
 
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').
345
237
        :param upload_suffix: An optional suffix to be given to any temporary
346
238
            files created during the pack creation. e.g '.autopack'
347
 
        :param file_mode: Unix permissions for newly created file.
 
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.
348
244
        """
349
245
        # The relative locations of the packs are constrained, but all are
350
246
        # 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
356
247
        Pack.__init__(self,
357
248
            # Revisions: parents list, no text compression.
358
249
            index_builder_class(reference_lists=1),
367
258
            # Signatures: Just blobs to store, no compression, no parents
368
259
            # listing.
369
260
            index_builder_class(reference_lists=0),
370
 
            # CHK based storage - just blobs, no compression or parents.
371
 
            chk_index=chk_index
372
261
            )
373
 
        self._pack_collection = pack_collection
374
262
        # When we make readonly indices, we need this.
375
 
        self.index_class = pack_collection._index_class
 
263
        self.index_class = index_class
376
264
        # where should the new pack be opened
377
 
        self.upload_transport = pack_collection._upload_transport
 
265
        self.upload_transport = upload_transport
378
266
        # where are indices written out to
379
 
        self.index_transport = pack_collection._index_transport
 
267
        self.index_transport = index_transport
380
268
        # where is the pack renamed to when it is finished?
381
 
        self.pack_transport = pack_collection._pack_transport
 
269
        self.pack_transport = pack_transport
382
270
        # What file mode to upload the pack and indices with.
383
271
        self._file_mode = file_mode
384
272
        # tracks the content written to the .pack file.
385
273
        self._hash = osutils.md5()
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)
 
274
        # a four-tuple with the length in bytes of the indices, once the pack
 
275
        # is finalised. (rev, inv, text, sigs)
388
276
        self.index_sizes = None
389
277
        # How much data to cache when writing packs. Note that this is not
390
278
        # synchronised with reads, because it's not in the transport layer, so
402
290
            mutter('%s: create_pack: pack stream open: %s%s t+%6.3fs',
403
291
                time.ctime(), self.upload_transport.base, self.random_name,
404
292
                time.time() - self.start_time)
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
 
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 
407
295
        # variables so that the _write_data closure below can update them.
408
296
        self._buffer = [[], 0]
409
 
        # create a callable for adding data
 
297
        # create a callable for adding data 
410
298
        #
411
299
        # robertc says- this is a closure rather than a method on the object
412
300
        # so that the variables are locals, and faster than accessing object
428
316
        self._writer.begin()
429
317
        # what state is the pack in? (open, finished, aborted)
430
318
        self._state = 'open'
431
 
        # no name until we finish writing the content
432
 
        self.name = None
433
319
 
434
320
    def abort(self):
435
321
        """Cancel creating this pack."""
453
339
        return bool(self.get_revision_count() or
454
340
            self.inventory_index.key_count() or
455
341
            self.text_index.key_count() or
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):
 
342
            self.signature_index.key_count())
 
343
 
 
344
    def finish(self):
468
345
        """Finish the new pack.
469
346
 
470
347
        This:
475
352
         - stores the index size tuple for the pack in the index_sizes
476
353
           attribute.
477
354
        """
478
 
        self.finish_content()
479
 
        if not suspend:
480
 
            self._check_references()
 
355
        self._writer.end()
 
356
        if self._buffer[1]:
 
357
            self._write_data('', flush=True)
 
358
        self.name = self._hash.hexdigest()
481
359
        # write indices
482
360
        # XXX: It'd be better to write them all to temporary names, then
483
361
        # rename them all into place, so that the window when only some are
484
362
        # visible is smaller.  On the other hand none will be seen until
485
363
        # they're in the names list.
486
364
        self.index_sizes = [None, None, None, None]
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)
 
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')
491
368
        self._write_index('signature', self.signature_index,
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)
 
369
            'revision signatures')
497
370
        self.write_stream.close()
498
371
        # Note that this will clobber an existing pack with the same name,
499
372
        # without checking for hash collisions. While this is undesirable this
506
379
        #  - try for HASH.pack
507
380
        #  - try for temporary-name
508
381
        #  - refresh the pack-list to see if the pack is now absent
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)
 
382
        self.upload_transport.rename(self.random_name,
 
383
                '../packs/' + self.name + '.pack')
513
384
        self._state = 'finished'
514
385
        if 'pack' in debug.debug_flags:
515
386
            # XXX: size might be interesting?
516
 
            mutter('%s: create_pack: pack finished: %s%s->%s t+%6.3fs',
 
387
            mutter('%s: create_pack: pack renamed into place: %s%s->%s%s t+%6.3fs',
517
388
                time.ctime(), self.upload_transport.base, self.random_name,
518
 
                new_name, time.time() - self.start_time)
 
389
                self.pack_transport, self.name,
 
390
                time.time() - self.start_time)
519
391
 
520
392
    def flush(self):
521
393
        """Flush any current data."""
525
397
            self._hash.update(bytes)
526
398
            self._buffer[:] = [[], 0]
527
399
 
528
 
    def _get_external_refs(self, index):
529
 
        return index._external_references()
 
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)]))
530
413
 
531
414
    def set_write_cache_size(self, size):
532
415
        self._cache_limit = size
533
416
 
534
 
    def _write_index(self, index_type, index, label, suspend=False):
 
417
    def _write_index(self, index_type, index, label):
535
418
        """Write out an index.
536
419
 
537
420
        :param index_type: The type of index to write - e.g. 'revision'.
539
422
        :param label: What label to give the index e.g. 'revision'.
540
423
        """
541
424
        index_name = self.index_name(index_type, self.name)
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)
 
425
        self.index_sizes[self.index_offset(index_type)] = \
 
426
            self.index_transport.put_file(index_name, index.finish(),
 
427
            mode=self._file_mode)
548
428
        if 'pack' in debug.debug_flags:
549
429
            # XXX: size might be interesting?
550
430
            mutter('%s: create_pack: wrote %s index: %s%s t+%6.3fs',
551
431
                time.ctime(), label, self.upload_transport.base,
552
432
                self.random_name, time.time() - self.start_time)
553
 
        # Replace the writable index on this object with a readonly,
 
433
        # Replace the writable index on this object with a readonly, 
554
434
        # presently unloaded index. We should alter
555
435
        # the index layer to make its finish() error if add_node is
556
436
        # subsequently used. RBC
565
445
    such as 'revision index'.
566
446
 
567
447
    A CombinedIndex provides an index on a single key space built up
568
 
    from several on-disk indices.  The AggregateIndex builds on this
 
448
    from several on-disk indices.  The AggregateIndex builds on this 
569
449
    to provide a knit access layer, and allows having up to one writable
570
450
    index within the collection.
571
451
    """
572
452
    # XXX: Probably 'can be written to' could/should be separated from 'acts
573
453
    # like a knit index' -- mbp 20071024
574
454
 
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
 
455
    def __init__(self):
 
456
        """Create an AggregateIndex."""
583
457
        self.index_to_pack = {}
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)
 
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.
588
480
        self.add_callback = None
589
481
 
590
482
    def add_index(self, index, pack):
592
484
 
593
485
        Future searches on the aggregate index will seach this new index
594
486
        before all previously inserted indices.
595
 
 
 
487
        
596
488
        :param index: An Index for the pack.
597
489
        :param pack: A Pack instance.
598
490
        """
599
491
        # expose it to the index map
600
492
        self.index_to_pack[index] = pack.access_tuple()
601
493
        # put it at the front of the linear index list
602
 
        self.combined_index.insert_index(0, index, pack.name)
 
494
        self.combined_index.insert_index(0, index)
603
495
 
604
496
    def add_writable_index(self, index, pack):
605
497
        """Add an index which is able to have data added to it.
606
498
 
607
499
        There can be at most one writable index at any time.  Any
608
500
        modifications made to the knit are put into this index.
609
 
 
 
501
        
610
502
        :param index: An index from the pack parameter.
611
503
        :param pack: A Pack instance.
612
504
        """
625
517
        self.data_access.set_writer(None, None, (None, None))
626
518
        self.index_to_pack.clear()
627
519
        del self.combined_index._indices[:]
628
 
        del self.combined_index._index_names[:]
629
520
        self.add_callback = None
630
521
 
631
 
    def remove_index(self, index):
 
522
    def remove_index(self, index, pack):
632
523
        """Remove index from the indices used to answer queries.
633
 
 
 
524
        
634
525
        :param index: An index from the pack parameter.
 
526
        :param pack: A Pack instance.
635
527
        """
636
528
        del self.index_to_pack[index]
637
 
        pos = self.combined_index._indices.index(index)
638
 
        del self.combined_index._indices[pos]
639
 
        del self.combined_index._index_names[pos]
 
529
        self.combined_index._indices.remove(index)
640
530
        if (self.add_callback is not None and
641
531
            getattr(index, 'add_nodes', None) == self.add_callback):
642
532
            self.add_callback = None
646
536
class Packer(object):
647
537
    """Create a pack from packs."""
648
538
 
649
 
    def __init__(self, pack_collection, packs, suffix, revision_ids=None,
650
 
                 reload_func=None):
 
539
    def __init__(self, pack_collection, packs, suffix, revision_ids=None):
651
540
        """Create a Packer.
652
541
 
653
542
        :param pack_collection: A RepositoryPackCollection object where the
655
544
        :param packs: The packs to combine.
656
545
        :param suffix: The suffix to use on the temporary files for the pack.
657
546
        :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
661
547
        """
662
548
        self.packs = packs
663
549
        self.suffix = suffix
665
551
        # The pack object we are creating.
666
552
        self.new_pack = None
667
553
        self._pack_collection = pack_collection
668
 
        self._reload_func = reload_func
669
554
        # The index layer keys for the revisions being copied. None for 'all
670
555
        # objects'.
671
556
        self._revision_keys = None
677
562
    def _extra_init(self):
678
563
        """A template hook to allow extending the constructor trivially."""
679
564
 
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
 
 
709
565
    def pack(self, pb=None):
710
566
        """Create a new pack by reading data from other packs.
711
567
 
712
568
        This does little more than a bulk copy of data. One key difference
713
569
        is that data with the same item key across multiple packs is elided
714
570
        from the output. The new pack is written into the current pack store
715
 
        along with its indices, and the name added to the pack names. The
 
571
        along with its indices, and the name added to the pack names. The 
716
572
        source packs are not altered and are not required to be in the current
717
573
        pack collection.
718
574
 
725
581
        # XXX: - duplicate code warning with start_write_group; fix before
726
582
        #      considering 'done'.
727
583
        if self._pack_collection._new_pack is not None:
728
 
            raise errors.BzrError('call to %s.pack() while another pack is'
729
 
                                  ' being written.'
730
 
                                  % (self.__class__.__name__,))
 
584
            raise errors.BzrError('call to create_pack_from_packs while '
 
585
                'another pack is being written.')
731
586
        if self.revision_ids is not None:
732
587
            if len(self.revision_ids) == 0:
733
588
                # silly fetch request.
748
603
 
749
604
    def open_pack(self):
750
605
        """Open a pack for the pack we are creating."""
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
 
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)
795
612
 
796
613
    def _copy_revision_texts(self):
797
614
        """Copy revision data to the new pack."""
801
618
        else:
802
619
            revision_keys = None
803
620
        # select 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)
 
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)
809
624
        # copy revision keys and adjust values
810
625
        self.pb.update("Copying revision texts", 1)
811
626
        total_items, readv_group_iter = self._revision_node_readv(revision_nodes)
831
646
        # querying for keys here could introduce a bug where an inventory item
832
647
        # is missed, so do not change it to query separately without cross
833
648
        # checking like the text key check below.
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)
 
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)
837
652
        # copy inventory keys and adjust values
838
653
        # XXX: Should be a helper function to allow different inv representation
839
654
        # at this point.
873
688
            if missing_text_keys:
874
689
                # TODO: raise a specific error that can handle many missing
875
690
                # keys.
876
 
                mutter("missing keys during fetch: %r", missing_text_keys)
877
691
                a_missing_key = missing_text_keys.pop()
878
692
                raise errors.RevisionNotPresent(a_missing_key[1],
879
693
                    a_missing_key[0])
884
698
            self.new_pack.text_index, readv_group_iter, total_items))
885
699
        self._log_copied_texts()
886
700
 
 
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
 
887
714
    def _create_pack_from_packs(self):
888
715
        self.pb.update("Opening pack", 0, 5)
889
716
        self.new_pack = self.open_pack()
907
734
        self._copy_text_texts()
908
735
        # select signature keys
909
736
        signature_filter = self._revision_keys # same keyspace
910
 
        signature_index_map, signature_indices = self._pack_map_and_index_list(
911
 
            'signature_index')
912
 
        signature_nodes = self._index_contents(signature_indices,
 
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,
913
740
            signature_filter)
914
741
        # copy signature keys and adjust values
915
742
        self.pb.update("Copying signature texts", 4)
920
747
                time.ctime(), self._pack_collection._upload_transport.base, new_pack.random_name,
921
748
                new_pack.signature_index.key_count(),
922
749
                time.time() - new_pack.start_time)
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()
 
750
        self._check_references()
935
751
        if not self._use_pack(new_pack):
936
752
            new_pack.abort()
937
753
            return None
940
756
        self._pack_collection.allocate(new_pack)
941
757
        return new_pack
942
758
 
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
 
        """
 
759
    def _copy_nodes(self, nodes, index_map, writer, write_index):
 
760
        """Copy knit nodes between packs with no graph references."""
971
761
        pb = ui.ui_factory.nested_progress_bar()
972
762
        try:
973
763
            return self._do_copy_nodes(nodes, index_map, writer,
974
 
                write_index, pb, output_lines=output_lines)
 
764
                write_index, pb)
975
765
        finally:
976
766
            pb.finished()
977
767
 
978
 
    def _do_copy_nodes(self, nodes, index_map, writer, write_index, pb,
979
 
        output_lines=None):
 
768
    def _do_copy_nodes(self, nodes, index_map, writer, write_index, pb):
980
769
        # for record verification
981
770
        knit = KnitVersionedFiles(None, None)
982
771
        # plan a readv on each source pack:
984
773
        nodes = sorted(nodes)
985
774
        # how to map this into knit.py - or knit.py into this?
986
775
        # we don't want the typical knit logic, we want grouping by pack
987
 
        # at this point - perhaps a helper library for the following code
 
776
        # at this point - perhaps a helper library for the following code 
988
777
        # duplication points?
989
778
        request_groups = {}
990
779
        for index, key, value in nodes:
1003
792
            # linear scan up the pack
1004
793
            pack_readv_requests.sort()
1005
794
            # copy the data
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
 
795
            transport, path = index_map[index]
 
796
            reader = pack.make_readv_reader(transport, path,
 
797
                [offset[0:2] for offset in pack_readv_requests])
1015
798
            for (names, read_func), (_1, _2, (key, eol_flag)) in \
1016
799
                izip(reader.iter_records(), pack_readv_requests):
1017
800
                raw_data = read_func(None)
1018
801
                # check the header only
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()
 
802
                df, _ = knit._parse_record_header(key, raw_data)
 
803
                df.close()
1024
804
                pos, size = writer.add_bytes_record(raw_data, names)
1025
805
                write_index.add_node(key, eol_flag + "%d %d" % (pos, size))
1026
806
                pb.update("Copied record", record_index)
1056
836
        pb.update("Copied record", record_index, total_items)
1057
837
        for index, readv_vector, node_vector in readv_group_iter:
1058
838
            # copy the data
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
 
839
            transport, path = index_map[index]
 
840
            reader = pack.make_readv_reader(transport, path, readv_vector)
1067
841
            for (names, read_func), (key, eol_flag, references) in \
1068
842
                izip(reader.iter_records(), node_vector):
1069
843
                raw_data = read_func(None)
1086
860
                record_index += 1
1087
861
 
1088
862
    def _get_text_nodes(self):
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,
 
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,
1092
866
            self._text_filter)
1093
867
 
1094
868
    def _least_readv_node_readv(self, nodes):
1095
869
        """Generate request groups for nodes using the least readv's.
1096
 
 
 
870
        
1097
871
        :param nodes: An iterable of graph index nodes.
1098
872
        :return: Total node count and an iterator of the data needed to perform
1099
873
            readvs to obtain the data for nodes. Each item yielded by the
1100
874
            iterator is a tuple with:
1101
875
            index, readv_vector, node_vector. readv_vector is a list ready to
1102
876
            hand to the transport readv method, and node_vector is a list of
1103
 
            (key, eol_flag, references) for the node retrieved by the
 
877
            (key, eol_flag, references) for the the node retrieved by the
1104
878
            matching readv_vector.
1105
879
        """
1106
880
        # group by pack so we do one readv per pack
1210
984
 
1211
985
class ReconcilePacker(Packer):
1212
986
    """A packer which regenerates indices etc as it copies.
1213
 
 
 
987
    
1214
988
    This is used by ``bzr reconcile`` to cause parent text pointers to be
1215
989
    regenerated.
1216
990
    """
1239
1013
        # 1) generate the ideal index
1240
1014
        repo = self._pack_collection.repo
1241
1015
        ancestors = dict([(key[0], tuple(ref[0] for ref in refs[0])) for
1242
 
            _1, key, _2, refs in
 
1016
            _1, key, _2, refs in 
1243
1017
            self.new_pack.revision_index.iter_all_entries()])
1244
1018
        ideal_index = repo._generate_text_key_index(self._text_refs, ancestors)
1245
1019
        # 2) generate a text_nodes list that contains all the deltas that can
1251
1025
        text_index_map, text_nodes = self._get_text_nodes()
1252
1026
        for node in text_nodes:
1253
1027
            # 0 - index
1254
 
            # 1 - key
 
1028
            # 1 - key 
1255
1029
            # 2 - value
1256
1030
            # 3 - refs
1257
1031
            try:
1297
1071
        # space (we only topo sort the revisions, which is smaller).
1298
1072
        topo_order = tsort.topo_sort(ancestors)
1299
1073
        rev_order = dict(zip(topo_order, range(len(topo_order))))
1300
 
        bad_texts.sort(key=lambda key:rev_order.get(key[0][1], 0))
 
1074
        bad_texts.sort(key=lambda key:rev_order[key[0][1]])
1301
1075
        transaction = repo.get_transaction()
1302
1076
        file_id_index = GraphIndexPrefixAdapter(
1303
1077
            self.new_pack.text_index,
1329
1103
            output_texts.add_lines(key, parent_keys, text_lines,
1330
1104
                random_id=True, check_content=False)
1331
1105
        # 5) check that nothing inserted has a reference outside the keyspace.
1332
 
        missing_text_keys = self.new_pack.text_index._external_references()
 
1106
        missing_text_keys = self.new_pack._external_compression_parents_of_texts()
1333
1107
        if missing_text_keys:
1334
 
            raise errors.BzrCheckError('Reference to missing compression parents %r'
 
1108
            raise errors.BzrError('Reference to missing compression parents %r'
1335
1109
                % (missing_text_keys,))
1336
1110
        self._log_copied_texts()
1337
1111
 
1352
1126
 
1353
1127
class RepositoryPackCollection(object):
1354
1128
    """Management of packs within a repository.
1355
 
 
 
1129
    
1356
1130
    :ivar _names: map of {pack_name: (index_size,)}
1357
1131
    """
1358
1132
 
1359
 
    pack_factory = NewPack
1360
 
    resumed_pack_factory = ResumedPack
1361
 
 
1362
1133
    def __init__(self, repo, transport, index_transport, upload_transport,
1363
 
                 pack_transport, index_builder_class, index_class,
1364
 
                 use_chk_index):
 
1134
                 pack_transport, index_builder_class, index_class):
1365
1135
        """Create a new RepositoryPackCollection.
1366
1136
 
1367
 
        :param transport: Addresses the repository base directory
 
1137
        :param transport: Addresses the repository base directory 
1368
1138
            (typically .bzr/repository/).
1369
1139
        :param index_transport: Addresses the directory containing indices.
1370
1140
        :param upload_transport: Addresses the directory into which packs are written
1372
1142
        :param pack_transport: Addresses the directory of existing complete packs.
1373
1143
        :param index_builder_class: The index builder class to use.
1374
1144
        :param index_class: The index class to use.
1375
 
        :param use_chk_index: Whether to setup and manage a CHK index.
1376
1145
        """
1377
 
        # XXX: This should call self.reset()
1378
1146
        self.repo = repo
1379
1147
        self.transport = transport
1380
1148
        self._index_transport = index_transport
1382
1150
        self._pack_transport = pack_transport
1383
1151
        self._index_builder_class = index_builder_class
1384
1152
        self._index_class = index_class
1385
 
        self._suffix_offsets = {'.rix': 0, '.iix': 1, '.tix': 2, '.six': 3,
1386
 
            '.cix': 4}
 
1153
        self._suffix_offsets = {'.rix': 0, '.iix': 1, '.tix': 2, '.six': 3}
1387
1154
        self.packs = []
1388
1155
        # name:Pack mapping
1389
 
        self._names = None
1390
1156
        self._packs_by_name = {}
1391
1157
        # the previous pack-names content
1392
1158
        self._packs_at_load = None
1393
1159
        # when a pack is being created by this object, the state of that pack.
1394
1160
        self._new_pack = None
1395
1161
        # aggregated revision index data
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)
 
1162
        self.revision_index = AggregateIndex()
 
1163
        self.inventory_index = AggregateIndex()
 
1164
        self.text_index = AggregateIndex()
 
1165
        self.signature_index = AggregateIndex()
1420
1166
 
1421
1167
    def add_pack_to_memory(self, pack):
1422
1168
        """Make a Pack object available to the repository to satisfy queries.
1423
 
 
 
1169
        
1424
1170
        :param pack: A Pack object.
1425
1171
        """
1426
1172
        if pack.name in self._packs_by_name:
1427
 
            raise AssertionError(
1428
 
                'pack %s already in _packs_by_name' % (pack.name,))
 
1173
            raise AssertionError()
1429
1174
        self.packs.append(pack)
1430
1175
        self._packs_by_name[pack.name] = pack
1431
1176
        self.revision_index.add_index(pack.revision_index, pack)
1432
1177
        self.inventory_index.add_index(pack.inventory_index, pack)
1433
1178
        self.text_index.add_index(pack.text_index, pack)
1434
1179
        self.signature_index.add_index(pack.signature_index, pack)
1435
 
        if self.chk_index is not None:
1436
 
            self.chk_index.add_index(pack.chk_index, pack)
1437
 
 
 
1180
        
1438
1181
    def all_packs(self):
1439
1182
        """Return a list of all the Pack objects this repository has.
1440
1183
 
1449
1192
 
1450
1193
    def autopack(self):
1451
1194
        """Pack the pack collection incrementally.
1452
 
 
 
1195
        
1453
1196
        This will not attempt global reorganisation or recompression,
1454
1197
        rather it will just ensure that the total number of packs does
1455
1198
        not grow without bound. It uses the _max_pack_count method to
1461
1204
        in synchronisation with certain steps. Otherwise the names collection
1462
1205
        is not flushed.
1463
1206
 
1464
 
        :return: Something evaluating true if packing took place.
 
1207
        :return: True if packing took place.
1465
1208
        """
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):
1475
1209
        # XXX: Should not be needed when the management of indices is sane.
1476
1210
        total_revisions = self.revision_index.combined_index.key_count()
1477
1211
        total_packs = len(self._names)
1478
1212
        if self._max_pack_count(total_revisions) >= total_packs:
1479
 
            return None
 
1213
            return False
 
1214
        # XXX: the following may want to be a class, to pack with a given
 
1215
        # policy.
 
1216
        mutter('Auto-packing repository %s, which has %d pack files, '
 
1217
            'containing %d revisions into %d packs.', self, total_packs,
 
1218
            total_revisions, self._max_pack_count(total_revisions))
1480
1219
        # determine which packs need changing
1481
1220
        pack_distribution = self.pack_distribution(total_revisions)
1482
1221
        existing_packs = []
1490
1229
                # group their data with the relevant commit, and that may
1491
1230
                # involve rewriting ancient history - which autopack tries to
1492
1231
                # avoid. Alternatively we could not group the data but treat
1493
 
                # each of these as having a single revision, and thus add
 
1232
                # each of these as having a single revision, and thus add 
1494
1233
                # one revision for each to the total revision count, to get
1495
1234
                # a matching distribution.
1496
1235
                continue
1497
1236
            existing_packs.append((revision_count, pack))
1498
1237
        pack_operations = self.plan_autopack_combinations(
1499
1238
            existing_packs, pack_distribution)
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
 
1239
        self._execute_pack_operations(pack_operations)
 
1240
        return True
1511
1241
 
1512
 
    def _execute_pack_operations(self, pack_operations, _packer_class=Packer,
1513
 
                                 reload_func=None):
 
1242
    def _execute_pack_operations(self, pack_operations, _packer_class=Packer):
1514
1243
        """Execute a series of pack operations.
1515
1244
 
1516
1245
        :param pack_operations: A list of [revision_count, packs_to_combine].
1517
1246
        :param _packer_class: The class of packer to use (default: Packer).
1518
 
        :return: The new pack names.
 
1247
        :return: None.
1519
1248
        """
1520
1249
        for revision_count, packs in pack_operations:
1521
1250
            # we may have no-ops from the setup logic
1522
1251
            if len(packs) == 0:
1523
1252
                continue
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
 
1253
            _packer_class(self, packs, '.autopack').pack()
1536
1254
            for pack in packs:
1537
1255
                self._remove_pack_from_memory(pack)
1538
1256
        # record the newly available packs and stop advertising the old
1539
1257
        # 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()
 
1258
        self._save_pack_names(clear_obsolete_packs=True)
 
1259
        # Move the old packs out of the way now they are no longer referenced.
 
1260
        for revision_count, packs in pack_operations:
 
1261
            self._obsolete_packs(packs)
1550
1262
 
1551
1263
    def lock_names(self):
1552
1264
        """Acquire the mutex around the pack-names index.
1553
 
 
 
1265
        
1554
1266
        This cannot be used in the middle of a read-only transaction on the
1555
1267
        repository.
1556
1268
        """
1557
1269
        self.repo.control_files.lock_write()
1558
1270
 
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):
 
1271
    def pack(self):
1564
1272
        """Pack the pack collection totally."""
1565
1273
        self.ensure_loaded()
1566
1274
        total_packs = len(self._names)
1567
 
        if self._already_packed():
 
1275
        if total_packs < 2:
 
1276
            # This is arguably wrong because we might not be optimal, but for
 
1277
            # now lets leave it in. (e.g. reconcile -> one pack. But not
 
1278
            # optimal.
1568
1279
            return
1569
1280
        total_revisions = self.revision_index.combined_index.key_count()
1570
1281
        # XXX: the following may want to be a class, to pack with a given
1571
1282
        # policy.
1572
1283
        mutter('Packing repository %s, which has %d pack files, '
1573
 
            'containing %d revisions with hint %r.', self, total_packs,
1574
 
            total_revisions, hint)
 
1284
            'containing %d revisions into 1 packs.', self, total_packs,
 
1285
            total_revisions)
1575
1286
        # determine which packs need changing
 
1287
        pack_distribution = [1]
1576
1288
        pack_operations = [[0, []]]
1577
1289
        for pack in self.all_packs():
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)
 
1290
            pack_operations[-1][0] += pack.get_revision_count()
 
1291
            pack_operations[-1][1].append(pack)
1583
1292
        self._execute_pack_operations(pack_operations, OptimisingPacker)
1584
1293
 
1585
 
        if clean_obsolete_packs:
1586
 
            self._clear_obsolete_packs()
1587
 
 
1588
1294
    def plan_autopack_combinations(self, existing_packs, pack_distribution):
1589
1295
        """Plan a pack operation.
1590
1296
 
1638
1344
        return [[final_rev_count, final_pack_list]]
1639
1345
 
1640
1346
    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
 
        """
1645
1347
        # NB: if you see an assertion error here, its probably access against
1646
1348
        # an unlocked repo. Naughty.
1647
1349
        if not self.repo.is_locked():
1653
1355
                name = key[0]
1654
1356
                self._names[name] = self._parse_index_sizes(value)
1655
1357
                self._packs_at_load.add((key, value))
1656
 
            result = True
1657
 
        else:
1658
 
            result = False
1659
1358
        # populate all the metadata.
1660
1359
        self.all_packs()
1661
 
        return result
1662
1360
 
1663
1361
    def _parse_index_sizes(self, value):
1664
1362
        """Parse a string of index sizes."""
1677
1375
            inv_index = self._make_index(name, '.iix')
1678
1376
            txt_index = self._make_index(name, '.tix')
1679
1377
            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
1684
1378
            result = ExistingPack(self._pack_transport, name, rev_index,
1685
 
                inv_index, txt_index, sig_index, chk_index)
 
1379
                inv_index, txt_index, sig_index)
1686
1380
            self.add_pack_to_memory(result)
1687
1381
            return result
1688
1382
 
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
 
 
1720
1383
    def allocate(self, a_new_pack):
1721
1384
        """Allocate name in the list of packs.
1722
1385
 
1732
1395
 
1733
1396
    def _iter_disk_pack_index(self):
1734
1397
        """Iterate over the contents of the pack-names index.
1735
 
 
 
1398
        
1736
1399
        This is used when loading the list from disk, and before writing to
1737
1400
        detect updates from others during our write operation.
1738
1401
        :return: An iterator of the index contents.
1740
1403
        return self._index_class(self.transport, 'pack-names', None
1741
1404
                ).iter_all_entries()
1742
1405
 
1743
 
    def _make_index(self, name, suffix, resume=False, unlimited_cache=False):
 
1406
    def _make_index(self, name, suffix):
1744
1407
        size_offset = self._suffix_offsets[suffix]
1745
1408
        index_name = name + suffix
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)
 
1409
        index_size = self._names[name][size_offset]
 
1410
        return self._index_class(
 
1411
            self._index_transport, index_name, index_size)
1754
1412
 
1755
1413
    def _max_pack_count(self, total_revisions):
1756
1414
        """Return the maximum number of packs to use for total revisions.
1757
 
 
 
1415
        
1758
1416
        :param total_revisions: The total number of revisions in the
1759
1417
            repository.
1760
1418
        """
1784
1442
        :param return: None.
1785
1443
        """
1786
1444
        for pack in packs:
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,))
 
1445
            pack.pack_transport.rename(pack.file_name(),
 
1446
                '../obsolete_packs/' + pack.file_name())
1794
1447
            # TODO: Probably needs to know all possible indices for this pack
1795
1448
            # - or maybe list the directory and move all indices matching this
1796
1449
            # name whether we recognize it or not?
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,))
 
1450
            for suffix in ('.iix', '.six', '.tix', '.rix'):
 
1451
                self._index_transport.rename(pack.name + suffix,
 
1452
                    '../obsolete_packs/' + pack.name + suffix)
1807
1453
 
1808
1454
    def pack_distribution(self, total_revisions):
1809
1455
        """Generate a list of the number of revisions to put in each pack.
1827
1473
 
1828
1474
    def _remove_pack_from_memory(self, pack):
1829
1475
        """Remove pack from the packs accessed by this repository.
1830
 
 
 
1476
        
1831
1477
        Only affects memory state, until self._save_pack_names() is invoked.
1832
1478
        """
1833
1479
        self._names.pop(pack.name)
1834
1480
        self._packs_by_name.pop(pack.name)
1835
1481
        self._remove_pack_indices(pack)
1836
 
        self.packs.remove(pack)
1837
1482
 
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
 
1483
    def _remove_pack_indices(self, pack):
 
1484
        """Remove the indices for pack from the aggregated indices."""
 
1485
        self.revision_index.remove_index(pack.revision_index, pack)
 
1486
        self.inventory_index.remove_index(pack.inventory_index, pack)
 
1487
        self.text_index.remove_index(pack.text_index, pack)
 
1488
        self.signature_index.remove_index(pack.signature_index, pack)
1854
1489
 
1855
1490
    def reset(self):
1856
1491
        """Clear all cached data."""
1857
1492
        # cached revision data
 
1493
        self.repo._revision_knit = None
1858
1494
        self.revision_index.clear()
1859
1495
        # cached signature data
 
1496
        self.repo._signature_knit = None
1860
1497
        self.signature_index.clear()
1861
1498
        # cached file text data
1862
1499
        self.text_index.clear()
 
1500
        self.repo._text_knit = None
1863
1501
        # cached inventory data
1864
1502
        self.inventory_index.clear()
1865
 
        # cached chk data
1866
 
        if self.chk_index is not None:
1867
 
            self.chk_index.clear()
1868
1503
        # remove the open pack
1869
1504
        self._new_pack = None
1870
1505
        # information about packs.
1873
1508
        self._packs_by_name = {}
1874
1509
        self._packs_at_load = None
1875
1510
 
 
1511
    def _make_index_map(self, index_suffix):
 
1512
        """Return information on existing indices.
 
1513
 
 
1514
        :param suffix: Index suffix added to pack name.
 
1515
 
 
1516
        :returns: (pack_map, indices) where indices is a list of GraphIndex 
 
1517
        objects, and pack_map is a mapping from those objects to the 
 
1518
        pack tuple they describe.
 
1519
        """
 
1520
        # TODO: stop using this; it creates new indices unnecessarily.
 
1521
        self.ensure_loaded()
 
1522
        suffix_map = {'.rix': 'revision_index',
 
1523
            '.six': 'signature_index',
 
1524
            '.iix': 'inventory_index',
 
1525
            '.tix': 'text_index',
 
1526
        }
 
1527
        return self._packs_list_to_pack_map_and_index_list(self.all_packs(),
 
1528
            suffix_map[index_suffix])
 
1529
 
 
1530
    def _packs_list_to_pack_map_and_index_list(self, packs, index_attribute):
 
1531
        """Convert a list of packs to an index pack map and index list.
 
1532
 
 
1533
        :param packs: The packs list to process.
 
1534
        :param index_attribute: The attribute that the desired index is found
 
1535
            on.
 
1536
        :return: A tuple (map, list) where map contains the dict from
 
1537
            index:pack_tuple, and lsit contains the indices in the same order
 
1538
            as the packs list.
 
1539
        """
 
1540
        indices = []
 
1541
        pack_map = {}
 
1542
        for pack in packs:
 
1543
            index = getattr(pack, index_attribute)
 
1544
            indices.append(index)
 
1545
            pack_map[index] = (pack.pack_transport, pack.file_name())
 
1546
        return pack_map, indices
 
1547
 
 
1548
    def _index_contents(self, pack_map, key_filter=None):
 
1549
        """Get an iterable of the index contents from a pack_map.
 
1550
 
 
1551
        :param pack_map: A map from indices to pack details.
 
1552
        :param key_filter: An optional filter to limit the
 
1553
            keys returned.
 
1554
        """
 
1555
        indices = [index for index in pack_map.iterkeys()]
 
1556
        all_index = CombinedGraphIndex(indices)
 
1557
        if key_filter is None:
 
1558
            return all_index.iter_all_entries()
 
1559
        else:
 
1560
            return all_index.iter_entries(key_filter)
 
1561
 
1876
1562
    def _unlock_names(self):
1877
1563
        """Release the mutex around the pack-names index."""
1878
1564
        self.repo.control_files.unlock()
1879
1565
 
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
 
1566
    def _save_pack_names(self, clear_obsolete_packs=False):
 
1567
        """Save the list of packs.
 
1568
 
 
1569
        This will take out the mutex around the pack names list for the
 
1570
        duration of the method call. If concurrent updates have been made, a
 
1571
        three-way merge between the current list and the current in memory list
 
1572
        is performed.
 
1573
 
 
1574
        :param clear_obsolete_packs: If True, clear out the contents of the
 
1575
            obsolete_packs directory.
 
1576
        """
 
1577
        self.lock_names()
 
1578
        try:
 
1579
            builder = self._index_builder_class()
 
1580
            # load the disk nodes across
 
1581
            disk_nodes = set()
 
1582
            for index, key, value in self._iter_disk_pack_index():
 
1583
                disk_nodes.add((key, value))
 
1584
            # do a two-way diff against our original content
 
1585
            current_nodes = set()
 
1586
            for name, sizes in self._names.iteritems():
 
1587
                current_nodes.add(
 
1588
                    ((name, ), ' '.join(str(size) for size in sizes)))
 
1589
            deleted_nodes = self._packs_at_load - current_nodes
 
1590
            new_nodes = current_nodes - self._packs_at_load
 
1591
            disk_nodes.difference_update(deleted_nodes)
 
1592
            disk_nodes.update(new_nodes)
 
1593
            # TODO: handle same-name, index-size-changes here - 
 
1594
            # e.g. use the value from disk, not ours, *unless* we're the one
 
1595
            # changing it.
 
1596
            for key, value in disk_nodes:
 
1597
                builder.add_node(key, value)
 
1598
            self.transport.put_file('pack-names', builder.finish(),
 
1599
                mode=self.repo.bzrdir._get_file_mode())
 
1600
            # move the baseline forward
 
1601
            self._packs_at_load = disk_nodes
 
1602
            if clear_obsolete_packs:
 
1603
                self._clear_obsolete_packs()
 
1604
        finally:
 
1605
            self._unlock_names()
 
1606
        # synchronise the memory packs list with what we just wrote:
1925
1607
        new_names = dict(disk_nodes)
1926
1608
        # drop no longer present nodes
1927
1609
        for pack in self.all_packs():
1928
1610
            if (pack.name,) not in new_names:
1929
 
                removed.append(pack.name)
1930
1611
                self._remove_pack_from_memory(pack)
1931
1612
        # add new nodes/refresh existing ones
1932
1613
        for key, value in disk_nodes:
1946
1627
                    self._remove_pack_from_memory(self.get_pack_by_name(name))
1947
1628
                    self._names[name] = sizes
1948
1629
                    self.get_pack_by_name(name)
1949
 
                    modified.append(name)
1950
1630
            else:
1951
1631
                # new
1952
1632
                self._names[name] = sizes
1953
1633
                self.get_pack_by_name(name)
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):
 
1634
 
 
1635
    def _clear_obsolete_packs(self):
2044
1636
        """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.
2048
1637
        """
2049
 
        found = []
2050
1638
        obsolete_pack_transport = self.transport.clone('obsolete_packs')
2051
 
        if preserve is None:
2052
 
            preserve = set()
2053
1639
        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
2059
1640
            try:
2060
1641
                obsolete_pack_transport.delete(filename)
2061
1642
            except (errors.PathError, errors.TransportError), e:
2062
 
                warning("couldn't delete obsolete pack, skipping it:\n%s"
2063
 
                        % (e,))
2064
 
        return found
 
1643
                warning("couldn't delete obsolete pack, skipping it:\n%s" % (e,))
2065
1644
 
2066
1645
    def _start_write_group(self):
2067
1646
        # Do not permit preparation for writing if we're not in a 'write lock'.
2068
1647
        if not self.repo.is_write_locked():
2069
1648
            raise errors.NotWriteLocked(self)
2070
 
        self._new_pack = self.pack_factory(self, upload_suffix='.pack',
2071
 
            file_mode=self.repo.bzrdir._get_file_mode())
 
1649
        self._new_pack = NewPack(self._upload_transport, self._index_transport,
 
1650
            self._pack_transport, upload_suffix='.pack',
 
1651
            file_mode=self.repo.bzrdir._get_file_mode(),
 
1652
            index_builder_class=self._index_builder_class,
 
1653
            index_class=self._index_class)
2072
1654
        # allow writing: queue writes to a new index
2073
1655
        self.revision_index.add_writable_index(self._new_pack.revision_index,
2074
1656
            self._new_pack)
2076
1658
            self._new_pack)
2077
1659
        self.text_index.add_writable_index(self._new_pack.text_index,
2078
1660
            self._new_pack)
2079
 
        self._new_pack.text_index.set_optimize(combine_backing_indices=False)
2080
1661
        self.signature_index.add_writable_index(self._new_pack.signature_index,
2081
1662
            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)
2087
1663
 
2088
1664
        self.repo.inventories._index._add_callback = self.inventory_index.add_callback
2089
1665
        self.repo.revisions._index._add_callback = self.revision_index.add_callback
2094
1670
        # FIXME: just drop the transient index.
2095
1671
        # forget what names there are
2096
1672
        if self._new_pack is not None:
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
 
        
 
1673
            self._new_pack.abort()
 
1674
            self._remove_pack_indices(self._new_pack)
 
1675
            self._new_pack = None
 
1676
        self.repo._text_knit = None
 
1677
 
2129
1678
    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)
2148
1679
        self._remove_pack_indices(self._new_pack)
2149
 
        any_new_content = False
2150
1680
        if self._new_pack.data_inserted():
2151
1681
            # get all the data to disk and read to use
2152
1682
            self._new_pack.finish()
2153
1683
            self.allocate(self._new_pack)
2154
1684
            self._new_pack = None
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:
 
1685
            if not self.autopack():
2171
1686
                # when autopack takes no steps, the names list is still
2172
1687
                # unsaved.
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
 
1688
                self._save_pack_names()
2185
1689
        else:
2186
1690
            self._new_pack.abort()
2187
1691
            self._new_pack = 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)
 
1692
        self.repo._text_knit = None
2194
1693
 
2195
1694
 
2196
1695
class KnitPackRepository(KnitRepository):
2197
1696
    """Repository with knit objects stored inside pack containers.
2198
 
 
 
1697
    
2199
1698
    The layering for a KnitPackRepository is:
2200
1699
 
2201
1700
    Graph        |  HPSS    | Repository public layer |
2215
1714
      pack file. The GraphIndex layer works in N-tuples and is unaware of any
2216
1715
      semantic value.
2217
1716
    ===================================================
2218
 
 
 
1717
    
2219
1718
    """
2220
1719
 
2221
1720
    def __init__(self, _format, a_bzrdir, control_files, _commit_builder_class,
2228
1727
            self._transport.clone('upload'),
2229
1728
            self._transport.clone('packs'),
2230
1729
            _format.index_builder_class,
2231
 
            _format.index_class,
2232
 
            use_chk_index=self._format.supports_chks,
2233
 
            )
 
1730
            _format.index_class)
2234
1731
        self.inventories = KnitVersionedFiles(
2235
1732
            _KnitGraphIndex(self._pack_collection.inventory_index.combined_index,
2236
1733
                add_callback=self._pack_collection.inventory_index.add_callback,
2240
1737
        self.revisions = KnitVersionedFiles(
2241
1738
            _KnitGraphIndex(self._pack_collection.revision_index.combined_index,
2242
1739
                add_callback=self._pack_collection.revision_index.add_callback,
2243
 
                deltas=False, parents=True, is_locked=self.is_locked,
2244
 
                track_external_parent_refs=True),
 
1740
                deltas=False, parents=True, is_locked=self.is_locked),
2245
1741
            data_access=self._pack_collection.revision_index.data_access,
2246
1742
            max_delta_chain=0)
2247
1743
        self.signatures = KnitVersionedFiles(
2256
1752
                deltas=True, parents=True, is_locked=self.is_locked),
2257
1753
            data_access=self._pack_collection.text_index.data_access,
2258
1754
            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
2271
1755
        # True when the repository object is 'write locked' (as opposed to the
2272
 
        # physical lock only taken out around changes to the pack-names list.)
 
1756
        # physical lock only taken out around changes to the pack-names list.) 
2273
1757
        # Another way to represent this would be a decorator around the control
2274
1758
        # files object that presents logical locks as physical ones - if this
2275
1759
        # gets ugly consider that alternative design. RBC 20071011
2279
1763
        self._reconcile_does_inventory_gc = True
2280
1764
        self._reconcile_fixes_text_parents = True
2281
1765
        self._reconcile_backsup_inventory = False
 
1766
        self._fetch_order = 'unordered'
2282
1767
 
2283
 
    def _warn_if_deprecated(self, branch=None):
 
1768
    def _warn_if_deprecated(self):
2284
1769
        # This class isn't deprecated, but one sub-format is
2285
1770
        if isinstance(self._format, RepositoryFormatKnitPack5RichRootBroken):
2286
 
            super(KnitPackRepository, self)._warn_if_deprecated(branch)
 
1771
            from bzrlib import repository
 
1772
            if repository._deprecation_warning_done:
 
1773
                return
 
1774
            repository._deprecation_warning_done = True
 
1775
            warning("Format %s for %s is deprecated - please use"
 
1776
                    " 'bzr upgrade --1.6.1-rich-root'"
 
1777
                    % (self._format, self.bzrdir.transport.base))
2287
1778
 
2288
1779
    def _abort_write_group(self):
2289
 
        self.revisions._index._key_dependencies.clear()
2290
1780
        self._pack_collection._abort_write_group()
2291
1781
 
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)
 
1782
    def _find_inconsistent_revision_parents(self):
 
1783
        """Find revisions with incorrectly cached parents.
 
1784
 
 
1785
        :returns: an iterator yielding tuples of (revison-id, parents-in-index,
 
1786
            parents-in-revision).
 
1787
        """
 
1788
        if not self.is_locked():
 
1789
            raise errors.ObjectNotLocked(self)
 
1790
        pb = ui.ui_factory.nested_progress_bar()
 
1791
        result = []
 
1792
        try:
 
1793
            revision_nodes = self._pack_collection.revision_index \
 
1794
                .combined_index.iter_all_entries()
 
1795
            index_positions = []
 
1796
            # Get the cached index values for all revisions, and also the location
 
1797
            # in each index of the revision text so we can perform linear IO.
 
1798
            for index, key, value, refs in revision_nodes:
 
1799
                pos, length = value[1:].split(' ')
 
1800
                index_positions.append((index, int(pos), key[0],
 
1801
                    tuple(parent[0] for parent in refs[0])))
 
1802
                pb.update("Reading revision index.", 0, 0)
 
1803
            index_positions.sort()
 
1804
            batch_count = len(index_positions) / 1000 + 1
 
1805
            pb.update("Checking cached revision graph.", 0, batch_count)
 
1806
            for offset in xrange(batch_count):
 
1807
                pb.update("Checking cached revision graph.", offset)
 
1808
                to_query = index_positions[offset * 1000:(offset + 1) * 1000]
 
1809
                if not to_query:
 
1810
                    break
 
1811
                rev_ids = [item[2] for item in to_query]
 
1812
                revs = self.get_revisions(rev_ids)
 
1813
                for revision, item in zip(revs, to_query):
 
1814
                    index_parents = item[3]
 
1815
                    rev_parents = tuple(revision.parent_ids)
 
1816
                    if index_parents != rev_parents:
 
1817
                        result.append((revision.revision_id, index_parents, rev_parents))
 
1818
        finally:
 
1819
            pb.finished()
 
1820
        return result
 
1821
 
 
1822
    @symbol_versioning.deprecated_method(symbol_versioning.one_one)
 
1823
    def get_parents(self, revision_ids):
 
1824
        """See graph._StackedParentsProvider.get_parents."""
 
1825
        parent_map = self.get_parent_map(revision_ids)
 
1826
        return [parent_map.get(r, None) for r in revision_ids]
2296
1827
 
2297
1828
    def _make_parents_provider(self):
2298
1829
        return graph.CachingParentsProvider(self)
2299
1830
 
2300
1831
    def _refresh_data(self):
2301
 
        if not self.is_locked():
2302
 
            return
2303
 
        self._pack_collection.reload_pack_names()
 
1832
        if self._write_lock_count == 1 or (
 
1833
            self.control_files._lock_count == 1 and
 
1834
            self.control_files._lock_mode == 'r'):
 
1835
            # forget what names there are
 
1836
            self._pack_collection.reset()
 
1837
            # XXX: Better to do an in-memory merge when acquiring a new lock -
 
1838
            # factor out code from _save_pack_names.
 
1839
            self._pack_collection.ensure_loaded()
2304
1840
 
2305
1841
    def _start_write_group(self):
2306
1842
        self._pack_collection._start_write_group()
2307
1843
 
2308
1844
    def _commit_write_group(self):
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)
 
1845
        return self._pack_collection._commit_write_group()
2329
1846
 
2330
1847
    def get_transaction(self):
2331
1848
        if self._write_lock_count:
2340
1857
        return self._write_lock_count
2341
1858
 
2342
1859
    def lock_write(self, token=None):
2343
 
        locked = self.is_locked()
2344
 
        if not self._write_lock_count and locked:
 
1860
        if not self._write_lock_count and self.is_locked():
2345
1861
            raise errors.ReadOnlyError(self)
2346
1862
        self._write_lock_count += 1
2347
1863
        if self._write_lock_count == 1:
2348
1864
            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'
2353
1865
            for repo in self._fallback_repositories:
2354
1866
                # Writes don't affect fallback repos
2355
1867
                repo.lock_read()
2356
 
            self._refresh_data()
 
1868
        self._refresh_data()
2357
1869
 
2358
1870
    def lock_read(self):
2359
 
        locked = self.is_locked()
2360
1871
        if self._write_lock_count:
2361
1872
            self._write_lock_count += 1
2362
1873
        else:
2363
1874
            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'
2368
1875
            for repo in self._fallback_repositories:
 
1876
                # Writes don't affect fallback repos
2369
1877
                repo.lock_read()
2370
 
            self._refresh_data()
 
1878
        self._refresh_data()
2371
1879
 
2372
1880
    def leave_lock_in_place(self):
2373
1881
        # not supported - raise an error
2378
1886
        raise NotImplementedError(self.dont_leave_lock_in_place)
2379
1887
 
2380
1888
    @needs_write_lock
2381
 
    def pack(self, hint=None, clean_obsolete_packs=False):
 
1889
    def pack(self):
2382
1890
        """Compress the data within the repository.
2383
1891
 
2384
1892
        This will pack all the data to a single pack. In future it may
2385
1893
        recompress deltas or do other such expensive operations.
2386
1894
        """
2387
 
        self._pack_collection.pack(hint=hint, clean_obsolete_packs=clean_obsolete_packs)
 
1895
        self._pack_collection.pack()
2388
1896
 
2389
1897
    @needs_write_lock
2390
1898
    def reconcile(self, other=None, thorough=False):
2394
1902
        reconciler.reconcile()
2395
1903
        return reconciler
2396
1904
 
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)
2402
1905
    def unlock(self):
2403
1906
        if self._write_lock_count == 1 and self._write_group is not None:
2404
1907
            self.abort_write_group()
2413
1916
                transaction = self._transaction
2414
1917
                self._transaction = None
2415
1918
                transaction.finish()
 
1919
                for repo in self._fallback_repositories:
 
1920
                    repo.unlock()
2416
1921
        else:
2417
1922
            self.control_files.unlock()
2418
 
 
2419
 
        if not self.is_locked():
2420
1923
            for repo in self._fallback_repositories:
2421
1924
                repo.unlock()
2422
1925
 
2423
1926
 
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
 
 
2497
1927
class RepositoryFormatPack(MetaDirRepositoryFormat):
2498
1928
    """Format logic for pack structured repositories.
2499
1929
 
2519
1949
    # Set this attribute in derived clases to control the _serializer that the
2520
1950
    # repository objects will have passed to their constructor.
2521
1951
    _serializer = None
2522
 
    # Packs are not confused by ghosts.
2523
 
    supports_ghosts = True
2524
1952
    # External references are not supported in pack repositories yet.
2525
1953
    supports_external_lookups = False
2526
 
    # Most pack formats do not use chk lookups.
2527
 
    supports_chks = False
2528
1954
    # What index classes to use
2529
1955
    index_builder_class = None
2530
1956
    index_class = None
2531
 
    _fetch_uses_deltas = True
2532
 
    fast_deltas = False
2533
1957
 
2534
1958
    def initialize(self, a_bzrdir, shared=False):
2535
1959
        """Create a pack based repository.
2544
1968
        builder = self.index_builder_class()
2545
1969
        files = [('pack-names', builder.finish())]
2546
1970
        utf8_files = [('format', self.get_format_string())]
2547
 
 
 
1971
        
2548
1972
        self._upload_blank_content(a_bzrdir, dirs, files, utf8_files, shared)
2549
 
        repository = self.open(a_bzrdir=a_bzrdir, _found=True)
2550
 
        self._run_post_repo_init_hooks(repository, a_bzrdir, shared)
2551
 
        return repository
 
1973
        return self.open(a_bzrdir=a_bzrdir, _found=True)
2552
1974
 
2553
1975
    def open(self, a_bzrdir, _found=False, _override_transport=None):
2554
1976
        """See RepositoryFormat.open().
2555
 
 
 
1977
        
2556
1978
        :param _override_transport: INTERNAL USE ONLY. Allows opening the
2557
1979
                                    repository at a slightly different url
2558
1980
                                    than normal. I.e. during 'upgrade'.
2603
2025
        """See RepositoryFormat.get_format_description()."""
2604
2026
        return "Packs containing knits without subtree support"
2605
2027
 
 
2028
    def check_conversion_target(self, target_format):
 
2029
        pass
 
2030
 
2606
2031
 
2607
2032
class RepositoryFormatKnitPack3(RepositoryFormatPack):
2608
2033
    """A subtrees parameterized Pack repository.
2617
2042
    repository_class = KnitPackRepository
2618
2043
    _commit_builder_class = PackRootCommitBuilder
2619
2044
    rich_root_data = True
2620
 
    experimental = True
2621
2045
    supports_tree_reference = True
2622
2046
    @property
2623
2047
    def _serializer(self):
2635
2059
 
2636
2060
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2637
2061
 
 
2062
    def check_conversion_target(self, target_format):
 
2063
        if not target_format.rich_root_data:
 
2064
            raise errors.BadConversionTarget(
 
2065
                'Does not support rich root data.', target_format)
 
2066
        if not getattr(target_format, 'supports_tree_reference', False):
 
2067
            raise errors.BadConversionTarget(
 
2068
                'Does not support nested trees', target_format)
 
2069
            
2638
2070
    def get_format_string(self):
2639
2071
        """See RepositoryFormat.get_format_string()."""
2640
2072
        return "Bazaar pack repository format 1 with subtree support (needs bzr 0.92)\n"
2673
2105
 
2674
2106
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2675
2107
 
 
2108
    def check_conversion_target(self, target_format):
 
2109
        if not target_format.rich_root_data:
 
2110
            raise errors.BadConversionTarget(
 
2111
                'Does not support rich root data.', target_format)
 
2112
 
2676
2113
    def get_format_string(self):
2677
2114
        """See RepositoryFormat.get_format_string()."""
2678
2115
        return ("Bazaar pack repository format 1 with rich root"
2719
2156
        """See RepositoryFormat.get_format_description()."""
2720
2157
        return "Packs 5 (adds stacking support, requires bzr 1.6)"
2721
2158
 
 
2159
    def check_conversion_target(self, target_format):
 
2160
        pass
 
2161
 
2722
2162
 
2723
2163
class RepositoryFormatKnitPack5RichRoot(RepositoryFormatPack):
2724
2164
    """A repository with rich roots and stacking.
2751
2191
 
2752
2192
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2753
2193
 
 
2194
    def check_conversion_target(self, target_format):
 
2195
        if not target_format.rich_root_data:
 
2196
            raise errors.BadConversionTarget(
 
2197
                'Does not support rich root data.', target_format)
 
2198
 
2754
2199
    def get_format_string(self):
2755
2200
        """See RepositoryFormat.get_format_string()."""
2756
2201
        return "Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6.1)\n"
2787
2232
        return xml7.serializer_v7
2788
2233
 
2789
2234
    def _get_matching_bzrdir(self):
2790
 
        matching = bzrdir.format_registry.make_bzrdir(
 
2235
        return bzrdir.format_registry.make_bzrdir(
2791
2236
            '1.6.1-rich-root')
2792
 
        matching.repository_format = self
2793
 
        return matching
2794
2237
 
2795
2238
    def _ignore_setting_bzrdir(self, format):
2796
2239
        pass
2797
2240
 
2798
2241
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2799
2242
 
 
2243
    def check_conversion_target(self, target_format):
 
2244
        if not target_format.rich_root_data:
 
2245
            raise errors.BadConversionTarget(
 
2246
                'Does not support rich root data.', target_format)
 
2247
 
2800
2248
    def get_format_string(self):
2801
2249
        """See RepositoryFormat.get_format_string()."""
2802
2250
        return "Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6)\n"
2806
2254
                " (deprecated)")
2807
2255
 
2808
2256
 
2809
 
class RepositoryFormatKnitPack6(RepositoryFormatPack):
2810
 
    """A repository with stacking and btree indexes,
2811
 
    without rich roots or subtrees.
2812
 
 
2813
 
    This is equivalent to pack-1.6 with B+Tree indices.
 
2257
class RepositoryFormatPackDevelopment2(RepositoryFormatPack):
 
2258
    """A no-subtrees development repository.
 
2259
 
 
2260
    This format should be retained until the second release after bzr 1.7.
 
2261
 
 
2262
    This is pack-1.6.1 with B+Tree indices.
2814
2263
    """
2815
2264
 
2816
2265
    repository_class = KnitPackRepository
2825
2274
        return xml5.serializer_v5
2826
2275
 
2827
2276
    def _get_matching_bzrdir(self):
2828
 
        return bzrdir.format_registry.make_bzrdir('1.9')
 
2277
        return bzrdir.format_registry.make_bzrdir('development2')
2829
2278
 
2830
2279
    def _ignore_setting_bzrdir(self, format):
2831
2280
        pass
2834
2283
 
2835
2284
    def get_format_string(self):
2836
2285
        """See RepositoryFormat.get_format_string()."""
2837
 
        return "Bazaar RepositoryFormatKnitPack6 (bzr 1.9)\n"
 
2286
        return "Bazaar development format 2 (needs bzr.dev from before 1.8)\n"
2838
2287
 
2839
2288
    def get_format_description(self):
2840
2289
        """See RepositoryFormat.get_format_description()."""
2841
 
        return "Packs 6 (uses btree indexes, requires bzr 1.9)"
2842
 
 
2843
 
 
2844
 
class RepositoryFormatKnitPack6RichRoot(RepositoryFormatPack):
2845
 
    """A repository with rich roots, no subtrees, stacking and btree indexes.
2846
 
 
2847
 
    1.6-rich-root with B+Tree indices.
2848
 
    """
2849
 
 
2850
 
    repository_class = KnitPackRepository
2851
 
    _commit_builder_class = PackRootCommitBuilder
2852
 
    rich_root_data = True
2853
 
    supports_tree_reference = False # no subtrees
2854
 
    supports_external_lookups = True
2855
 
    # What index classes to use
2856
 
    index_builder_class = BTreeBuilder
2857
 
    index_class = BTreeGraphIndex
2858
 
 
2859
 
    @property
2860
 
    def _serializer(self):
2861
 
        return xml6.serializer_v6
2862
 
 
2863
 
    def _get_matching_bzrdir(self):
2864
 
        return bzrdir.format_registry.make_bzrdir(
2865
 
            '1.9-rich-root')
2866
 
 
2867
 
    def _ignore_setting_bzrdir(self, format):
 
2290
        return ("Development repository format, currently the same as "
 
2291
            "1.6.1 with B+Trees.\n")
 
2292
 
 
2293
    def check_conversion_target(self, target_format):
2868
2294
        pass
2869
2295
 
2870
 
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2871
 
 
2872
 
    def get_format_string(self):
2873
 
        """See RepositoryFormat.get_format_string()."""
2874
 
        return "Bazaar RepositoryFormatKnitPack6RichRoot (bzr 1.9)\n"
2875
 
 
2876
 
    def get_format_description(self):
2877
 
        return "Packs 6 rich-root (uses btree indexes, requires bzr 1.9)"
2878
 
 
2879
2296
 
2880
2297
class RepositoryFormatPackDevelopment2Subtree(RepositoryFormatPack):
2881
2298
    """A subtrees development repository.
2883
2300
    This format should be retained until the second release after bzr 1.7.
2884
2301
 
2885
2302
    1.6.1-subtree[as it might have been] with B+Tree indices.
2886
 
 
2887
 
    This is [now] retained until we have a CHK based subtree format in
2888
 
    development.
2889
2303
    """
2890
2304
 
2891
2305
    repository_class = KnitPackRepository
2892
2306
    _commit_builder_class = PackRootCommitBuilder
2893
2307
    rich_root_data = True
2894
 
    experimental = True
2895
2308
    supports_tree_reference = True
2896
2309
    supports_external_lookups = True
2897
2310
    # What index classes to use
2904
2317
 
2905
2318
    def _get_matching_bzrdir(self):
2906
2319
        return bzrdir.format_registry.make_bzrdir(
2907
 
            'development-subtree')
 
2320
            'development2-subtree')
2908
2321
 
2909
2322
    def _ignore_setting_bzrdir(self, format):
2910
2323
        pass
2911
2324
 
2912
2325
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2913
2326
 
 
2327
    def check_conversion_target(self, target_format):
 
2328
        if not target_format.rich_root_data:
 
2329
            raise errors.BadConversionTarget(
 
2330
                'Does not support rich root data.', target_format)
 
2331
        if not getattr(target_format, 'supports_tree_reference', False):
 
2332
            raise errors.BadConversionTarget(
 
2333
                'Does not support nested trees', target_format)
 
2334
            
2914
2335
    def get_format_string(self):
2915
2336
        """See RepositoryFormat.get_format_string()."""
2916
2337
        return ("Bazaar development format 2 with subtree support "
2920
2341
        """See RepositoryFormat.get_format_description()."""
2921
2342
        return ("Development repository format, currently the same as "
2922
2343
            "1.6.1-subtree with B+Tree indices.\n")
2923