~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repofmt/pack_repo.py

Initial commit for russian version of documents.

Show diffs side-by-side

added added

removed removed

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