/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/repofmt/pack_repo.py

  • Committer: Martin Pool
  • Date: 2008-07-07 10:31:06 UTC
  • mfrom: (3221.11.29 reconfigure.shallow)
  • mto: This revision was merged to the branch mainline in revision 3537.
  • Revision ID: mbp@sourcefrog.net-20080707103106-jpch6tczx7x2yuq0
merge all stacking threads; some tests currently failing

Show diffs side-by-side

added added

removed removed

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