/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/repofmt/pack_repo.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-02-05 05:42:28 UTC
  • mfrom: (3959.1.5 debug-sftp)
  • Revision ID: pqm@pqm.ubuntu.com-20090205054228-3qyiv92vtgs94e0c
(mbp) better and less redundant debug flag docs

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
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
 
import re
18
17
import sys
19
18
 
20
19
from bzrlib.lazy_import import lazy_import
23
22
import time
24
23
 
25
24
from bzrlib import (
26
 
    chk_map,
27
 
    cleanup,
28
25
    debug,
29
26
    graph,
30
27
    osutils,
37
34
    )
38
35
from bzrlib.index import (
39
36
    CombinedGraphIndex,
 
37
    GraphIndex,
 
38
    GraphIndexBuilder,
40
39
    GraphIndexPrefixAdapter,
 
40
    InMemoryGraphIndex,
41
41
    )
42
42
from bzrlib.knit import (
43
43
    KnitPlainFactory,
52
52
    errors,
53
53
    lockable_files,
54
54
    lockdir,
55
 
    revision as _mod_revision,
 
55
    symbol_versioning,
56
56
    )
57
57
 
58
 
from bzrlib.decorators import needs_write_lock, only_raises
 
58
from bzrlib.decorators import needs_write_lock
59
59
from bzrlib.btree_index import (
60
60
    BTreeGraphIndex,
61
61
    BTreeBuilder,
70
70
    MetaDirRepositoryFormat,
71
71
    RepositoryFormat,
72
72
    RootCommitBuilder,
73
 
    StreamSource,
74
73
    )
 
74
import bzrlib.revision as _mod_revision
75
75
from bzrlib.trace import (
76
76
    mutter,
77
 
    note,
78
77
    warning,
79
78
    )
80
79
 
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
152
141
            texts/deltas (via (fileid, revisionid) tuples).
153
142
        :param signature_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))
237
 
 
238
177
 
239
178
class ExistingPack(Pack):
240
179
    """An in memory proxy for an existing .pack and its disk indices."""
241
180
 
242
181
    def __init__(self, pack_transport, name, revision_index, inventory_index,
243
 
        text_index, signature_index, chk_index=None):
 
182
        text_index, signature_index):
244
183
        """Create an ExistingPack object.
245
184
 
246
185
        :param pack_transport: The transport where the pack file resides.
247
186
        :param name: The name of the pack on disk in the pack_transport.
248
187
        """
249
188
        Pack.__init__(self, revision_index, inventory_index, text_index,
250
 
            signature_index, chk_index)
 
189
            signature_index)
251
190
        self.name = name
252
191
        self.pack_transport = pack_transport
253
192
        if None in (revision_index, inventory_index, text_index,
261
200
        return not self.__eq__(other)
262
201
 
263
202
    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)
 
203
        return "<bzrlib.repofmt.pack_repo.Pack object at 0x%x, %s, %s" % (
 
204
            id(self), self.pack_transport, self.name)
336
205
 
337
206
 
338
207
class NewPack(Pack):
339
208
    """An in memory proxy for a pack which is being created."""
340
209
 
 
210
    # A map of index 'type' to the file extension and position in the
 
211
    # index_sizes array.
 
212
    index_definitions = {
 
213
        'revision': ('.rix', 0),
 
214
        'inventory': ('.iix', 1),
 
215
        'text': ('.tix', 2),
 
216
        'signature': ('.six', 3),
 
217
        }
 
218
 
341
219
    def __init__(self, pack_collection, upload_suffix='', file_mode=None):
342
220
        """Create a NewPack instance.
343
221
 
349
227
        # The relative locations of the packs are constrained, but all are
350
228
        # passed in because the caller has them, so as to avoid object churn.
351
229
        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
230
        Pack.__init__(self,
357
231
            # Revisions: parents list, no text compression.
358
232
            index_builder_class(reference_lists=1),
367
241
            # Signatures: Just blobs to store, no compression, no parents
368
242
            # listing.
369
243
            index_builder_class(reference_lists=0),
370
 
            # CHK based storage - just blobs, no compression or parents.
371
 
            chk_index=chk_index
372
244
            )
373
245
        self._pack_collection = pack_collection
374
246
        # When we make readonly indices, we need this.
383
255
        self._file_mode = file_mode
384
256
        # tracks the content written to the .pack file.
385
257
        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)
 
258
        # a four-tuple with the length in bytes of the indices, once the pack
 
259
        # is finalised. (rev, inv, text, sigs)
388
260
        self.index_sizes = None
389
261
        # How much data to cache when writing packs. Note that this is not
390
262
        # synchronised with reads, because it's not in the transport layer, so
402
274
            mutter('%s: create_pack: pack stream open: %s%s t+%6.3fs',
403
275
                time.ctime(), self.upload_transport.base, self.random_name,
404
276
                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
 
277
        # A list of byte sequences to be written to the new pack, and the 
 
278
        # aggregate size of them.  Stored as a list rather than separate 
407
279
        # variables so that the _write_data closure below can update them.
408
280
        self._buffer = [[], 0]
409
 
        # create a callable for adding data
 
281
        # create a callable for adding data 
410
282
        #
411
283
        # robertc says- this is a closure rather than a method on the object
412
284
        # so that the variables are locals, and faster than accessing object
428
300
        self._writer.begin()
429
301
        # what state is the pack in? (open, finished, aborted)
430
302
        self._state = 'open'
431
 
        # no name until we finish writing the content
432
 
        self.name = None
433
303
 
434
304
    def abort(self):
435
305
        """Cancel creating this pack."""
448
318
        else:
449
319
            raise AssertionError(self._state)
450
320
 
 
321
    def _check_references(self):
 
322
        """Make sure our external references are present.
 
323
        
 
324
        Packs are allowed to have deltas whose base is not in the pack, but it
 
325
        must be present somewhere in this collection.  It is not allowed to
 
326
        have deltas based on a fallback repository. 
 
327
        (See <https://bugs.launchpad.net/bzr/+bug/288751>)
 
328
        """
 
329
        missing_items = {}
 
330
        for (index_name, external_refs, index) in [
 
331
            ('texts',
 
332
                self.text_index._external_references(),
 
333
                self._pack_collection.text_index.combined_index),
 
334
            ('inventories',
 
335
                self.inventory_index._external_references(),
 
336
                self._pack_collection.inventory_index.combined_index),
 
337
            ]:
 
338
            missing = external_refs.difference(
 
339
                k for (idx, k, v, r) in 
 
340
                index.iter_entries(external_refs))
 
341
            if missing:
 
342
                missing_items[index_name] = sorted(list(missing))
 
343
        if missing_items:
 
344
            from pprint import pformat
 
345
            raise errors.BzrCheckError(
 
346
                "Newly created pack file %r has delta references to "
 
347
                "items not in its repository:\n%s"
 
348
                % (self, pformat(missing_items)))
 
349
 
451
350
    def data_inserted(self):
452
351
        """True if data has been added to this pack."""
453
352
        return bool(self.get_revision_count() or
454
353
            self.inventory_index.key_count() or
455
354
            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):
 
355
            self.signature_index.key_count())
 
356
 
 
357
    def finish(self):
468
358
        """Finish the new pack.
469
359
 
470
360
        This:
475
365
         - stores the index size tuple for the pack in the index_sizes
476
366
           attribute.
477
367
        """
478
 
        self.finish_content()
479
 
        if not suspend:
480
 
            self._check_references()
 
368
        self._writer.end()
 
369
        if self._buffer[1]:
 
370
            self._write_data('', flush=True)
 
371
        self.name = self._hash.hexdigest()
 
372
        self._check_references()
481
373
        # write indices
482
374
        # XXX: It'd be better to write them all to temporary names, then
483
375
        # rename them all into place, so that the window when only some are
484
376
        # visible is smaller.  On the other hand none will be seen until
485
377
        # they're in the names list.
486
378
        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)
 
379
        self._write_index('revision', self.revision_index, 'revision')
 
380
        self._write_index('inventory', self.inventory_index, 'inventory')
 
381
        self._write_index('text', self.text_index, 'file texts')
491
382
        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)
 
383
            'revision signatures')
497
384
        self.write_stream.close()
498
385
        # Note that this will clobber an existing pack with the same name,
499
386
        # without checking for hash collisions. While this is undesirable this
506
393
        #  - try for HASH.pack
507
394
        #  - try for temporary-name
508
395
        #  - 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)
 
396
        self.upload_transport.rename(self.random_name,
 
397
                '../packs/' + self.name + '.pack')
513
398
        self._state = 'finished'
514
399
        if 'pack' in debug.debug_flags:
515
400
            # XXX: size might be interesting?
516
 
            mutter('%s: create_pack: pack finished: %s%s->%s t+%6.3fs',
 
401
            mutter('%s: create_pack: pack renamed into place: %s%s->%s%s t+%6.3fs',
517
402
                time.ctime(), self.upload_transport.base, self.random_name,
518
 
                new_name, time.time() - self.start_time)
 
403
                self.pack_transport, self.name,
 
404
                time.time() - self.start_time)
519
405
 
520
406
    def flush(self):
521
407
        """Flush any current data."""
525
411
            self._hash.update(bytes)
526
412
            self._buffer[:] = [[], 0]
527
413
 
528
 
    def _get_external_refs(self, index):
529
 
        return index._external_references()
 
414
    def index_name(self, index_type, name):
 
415
        """Get the disk name of an index type for pack name 'name'."""
 
416
        return name + NewPack.index_definitions[index_type][0]
 
417
 
 
418
    def index_offset(self, index_type):
 
419
        """Get the position in a index_size array for a given index type."""
 
420
        return NewPack.index_definitions[index_type][1]
 
421
 
 
422
    def _replace_index_with_readonly(self, index_type):
 
423
        setattr(self, index_type + '_index',
 
424
            self.index_class(self.index_transport,
 
425
                self.index_name(index_type, self.name),
 
426
                self.index_sizes[self.index_offset(index_type)]))
530
427
 
531
428
    def set_write_cache_size(self, size):
532
429
        self._cache_limit = size
533
430
 
534
 
    def _write_index(self, index_type, index, label, suspend=False):
 
431
    def _write_index(self, index_type, index, label):
535
432
        """Write out an index.
536
433
 
537
434
        :param index_type: The type of index to write - e.g. 'revision'.
539
436
        :param label: What label to give the index e.g. 'revision'.
540
437
        """
541
438
        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)
 
439
        self.index_sizes[self.index_offset(index_type)] = \
 
440
            self.index_transport.put_file(index_name, index.finish(),
 
441
            mode=self._file_mode)
548
442
        if 'pack' in debug.debug_flags:
549
443
            # XXX: size might be interesting?
550
444
            mutter('%s: create_pack: wrote %s index: %s%s t+%6.3fs',
551
445
                time.ctime(), label, self.upload_transport.base,
552
446
                self.random_name, time.time() - self.start_time)
553
 
        # Replace the writable index on this object with a readonly,
 
447
        # Replace the writable index on this object with a readonly, 
554
448
        # presently unloaded index. We should alter
555
449
        # the index layer to make its finish() error if add_node is
556
450
        # subsequently used. RBC
565
459
    such as 'revision index'.
566
460
 
567
461
    A CombinedIndex provides an index on a single key space built up
568
 
    from several on-disk indices.  The AggregateIndex builds on this
 
462
    from several on-disk indices.  The AggregateIndex builds on this 
569
463
    to provide a knit access layer, and allows having up to one writable
570
464
    index within the collection.
571
465
    """
572
466
    # XXX: Probably 'can be written to' could/should be separated from 'acts
573
467
    # like a knit index' -- mbp 20071024
574
468
 
575
 
    def __init__(self, reload_func=None, flush_func=None):
 
469
    def __init__(self, reload_func=None):
576
470
        """Create an AggregateIndex.
577
471
 
578
472
        :param reload_func: A function to call if we find we are missing an
583
477
        self.index_to_pack = {}
584
478
        self.combined_index = CombinedGraphIndex([], reload_func=reload_func)
585
479
        self.data_access = _DirectPackAccess(self.index_to_pack,
586
 
                                             reload_func=reload_func,
587
 
                                             flush_func=flush_func)
 
480
                                             reload_func=reload_func)
 
481
        self.add_callback = None
 
482
 
 
483
    def replace_indices(self, index_to_pack, indices):
 
484
        """Replace the current mappings with fresh ones.
 
485
 
 
486
        This should probably not be used eventually, rather incremental add and
 
487
        removal of indices. It has been added during refactoring of existing
 
488
        code.
 
489
 
 
490
        :param index_to_pack: A mapping from index objects to
 
491
            (transport, name) tuples for the pack file data.
 
492
        :param indices: A list of indices.
 
493
        """
 
494
        # refresh the revision pack map dict without replacing the instance.
 
495
        self.index_to_pack.clear()
 
496
        self.index_to_pack.update(index_to_pack)
 
497
        # XXX: API break - clearly a 'replace' method would be good?
 
498
        self.combined_index._indices[:] = indices
 
499
        # the current add nodes callback for the current writable index if
 
500
        # there is one.
588
501
        self.add_callback = None
589
502
 
590
503
    def add_index(self, index, pack):
592
505
 
593
506
        Future searches on the aggregate index will seach this new index
594
507
        before all previously inserted indices.
595
 
 
 
508
        
596
509
        :param index: An Index for the pack.
597
510
        :param pack: A Pack instance.
598
511
        """
599
512
        # expose it to the index map
600
513
        self.index_to_pack[index] = pack.access_tuple()
601
514
        # put it at the front of the linear index list
602
 
        self.combined_index.insert_index(0, index, pack.name)
 
515
        self.combined_index.insert_index(0, index)
603
516
 
604
517
    def add_writable_index(self, index, pack):
605
518
        """Add an index which is able to have data added to it.
606
519
 
607
520
        There can be at most one writable index at any time.  Any
608
521
        modifications made to the knit are put into this index.
609
 
 
 
522
        
610
523
        :param index: An index from the pack parameter.
611
524
        :param pack: A Pack instance.
612
525
        """
625
538
        self.data_access.set_writer(None, None, (None, None))
626
539
        self.index_to_pack.clear()
627
540
        del self.combined_index._indices[:]
628
 
        del self.combined_index._index_names[:]
629
541
        self.add_callback = None
630
542
 
631
 
    def remove_index(self, index):
 
543
    def remove_index(self, index, pack):
632
544
        """Remove index from the indices used to answer queries.
633
 
 
 
545
        
634
546
        :param index: An index from the pack parameter.
 
547
        :param pack: A Pack instance.
635
548
        """
636
549
        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]
 
550
        self.combined_index._indices.remove(index)
640
551
        if (self.add_callback is not None and
641
552
            getattr(index, 'add_nodes', None) == self.add_callback):
642
553
            self.add_callback = None
712
623
        This does little more than a bulk copy of data. One key difference
713
624
        is that data with the same item key across multiple packs is elided
714
625
        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
 
626
        along with its indices, and the name added to the pack names. The 
716
627
        source packs are not altered and are not required to be in the current
717
628
        pack collection.
718
629
 
748
659
 
749
660
    def open_pack(self):
750
661
        """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,
 
662
        return NewPack(self._pack_collection, upload_suffix=self.suffix,
753
663
                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
664
 
762
665
    def _update_pack_order(self, entries, index_to_pack_map):
763
666
        """Determine how we want our packs to be ordered.
873
776
            if missing_text_keys:
874
777
                # TODO: raise a specific error that can handle many missing
875
778
                # keys.
876
 
                mutter("missing keys during fetch: %r", missing_text_keys)
877
779
                a_missing_key = missing_text_keys.pop()
878
780
                raise errors.RevisionNotPresent(a_missing_key[1],
879
781
                    a_missing_key[0])
920
822
                time.ctime(), self._pack_collection._upload_transport.base, new_pack.random_name,
921
823
                new_pack.signature_index.key_count(),
922
824
                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
825
        new_pack._check_references()
935
826
        if not self._use_pack(new_pack):
936
827
            new_pack.abort()
940
831
        self._pack_collection.allocate(new_pack)
941
832
        return new_pack
942
833
 
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
 
        """
 
834
    def _copy_nodes(self, nodes, index_map, writer, write_index):
 
835
        """Copy knit nodes between packs with no graph references."""
971
836
        pb = ui.ui_factory.nested_progress_bar()
972
837
        try:
973
838
            return self._do_copy_nodes(nodes, index_map, writer,
974
 
                write_index, pb, output_lines=output_lines)
 
839
                write_index, pb)
975
840
        finally:
976
841
            pb.finished()
977
842
 
978
 
    def _do_copy_nodes(self, nodes, index_map, writer, write_index, pb,
979
 
        output_lines=None):
 
843
    def _do_copy_nodes(self, nodes, index_map, writer, write_index, pb):
980
844
        # for record verification
981
845
        knit = KnitVersionedFiles(None, None)
982
846
        # plan a readv on each source pack:
984
848
        nodes = sorted(nodes)
985
849
        # how to map this into knit.py - or knit.py into this?
986
850
        # 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
 
851
        # at this point - perhaps a helper library for the following code 
988
852
        # duplication points?
989
853
        request_groups = {}
990
854
        for index, key, value in nodes:
1016
880
                izip(reader.iter_records(), pack_readv_requests):
1017
881
                raw_data = read_func(None)
1018
882
                # 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()
 
883
                df, _ = knit._parse_record_header(key, raw_data)
 
884
                df.close()
1024
885
                pos, size = writer.add_bytes_record(raw_data, names)
1025
886
                write_index.add_node(key, eol_flag + "%d %d" % (pos, size))
1026
887
                pb.update("Copied record", record_index)
1093
954
 
1094
955
    def _least_readv_node_readv(self, nodes):
1095
956
        """Generate request groups for nodes using the least readv's.
1096
 
 
 
957
        
1097
958
        :param nodes: An iterable of graph index nodes.
1098
959
        :return: Total node count and an iterator of the data needed to perform
1099
960
            readvs to obtain the data for nodes. Each item yielded by the
1100
961
            iterator is a tuple with:
1101
962
            index, readv_vector, node_vector. readv_vector is a list ready to
1102
963
            hand to the transport readv method, and node_vector is a list of
1103
 
            (key, eol_flag, references) for the node retrieved by the
 
964
            (key, eol_flag, references) for the the node retrieved by the
1104
965
            matching readv_vector.
1105
966
        """
1106
967
        # group by pack so we do one readv per pack
1210
1071
 
1211
1072
class ReconcilePacker(Packer):
1212
1073
    """A packer which regenerates indices etc as it copies.
1213
 
 
 
1074
    
1214
1075
    This is used by ``bzr reconcile`` to cause parent text pointers to be
1215
1076
    regenerated.
1216
1077
    """
1239
1100
        # 1) generate the ideal index
1240
1101
        repo = self._pack_collection.repo
1241
1102
        ancestors = dict([(key[0], tuple(ref[0] for ref in refs[0])) for
1242
 
            _1, key, _2, refs in
 
1103
            _1, key, _2, refs in 
1243
1104
            self.new_pack.revision_index.iter_all_entries()])
1244
1105
        ideal_index = repo._generate_text_key_index(self._text_refs, ancestors)
1245
1106
        # 2) generate a text_nodes list that contains all the deltas that can
1251
1112
        text_index_map, text_nodes = self._get_text_nodes()
1252
1113
        for node in text_nodes:
1253
1114
            # 0 - index
1254
 
            # 1 - key
 
1115
            # 1 - key 
1255
1116
            # 2 - value
1256
1117
            # 3 - refs
1257
1118
            try:
1297
1158
        # space (we only topo sort the revisions, which is smaller).
1298
1159
        topo_order = tsort.topo_sort(ancestors)
1299
1160
        rev_order = dict(zip(topo_order, range(len(topo_order))))
1300
 
        bad_texts.sort(key=lambda key:rev_order.get(key[0][1], 0))
 
1161
        bad_texts.sort(key=lambda key:rev_order[key[0][1]])
1301
1162
        transaction = repo.get_transaction()
1302
1163
        file_id_index = GraphIndexPrefixAdapter(
1303
1164
            self.new_pack.text_index,
1352
1213
 
1353
1214
class RepositoryPackCollection(object):
1354
1215
    """Management of packs within a repository.
1355
 
 
 
1216
    
1356
1217
    :ivar _names: map of {pack_name: (index_size,)}
1357
1218
    """
1358
1219
 
1359
 
    pack_factory = NewPack
1360
 
    resumed_pack_factory = ResumedPack
1361
 
 
1362
1220
    def __init__(self, repo, transport, index_transport, upload_transport,
1363
 
                 pack_transport, index_builder_class, index_class,
1364
 
                 use_chk_index):
 
1221
                 pack_transport, index_builder_class, index_class):
1365
1222
        """Create a new RepositoryPackCollection.
1366
1223
 
1367
 
        :param transport: Addresses the repository base directory
 
1224
        :param transport: Addresses the repository base directory 
1368
1225
            (typically .bzr/repository/).
1369
1226
        :param index_transport: Addresses the directory containing indices.
1370
1227
        :param upload_transport: Addresses the directory into which packs are written
1372
1229
        :param pack_transport: Addresses the directory of existing complete packs.
1373
1230
        :param index_builder_class: The index builder class to use.
1374
1231
        :param index_class: The index class to use.
1375
 
        :param use_chk_index: Whether to setup and manage a CHK index.
1376
1232
        """
1377
 
        # XXX: This should call self.reset()
1378
1233
        self.repo = repo
1379
1234
        self.transport = transport
1380
1235
        self._index_transport = index_transport
1382
1237
        self._pack_transport = pack_transport
1383
1238
        self._index_builder_class = index_builder_class
1384
1239
        self._index_class = index_class
1385
 
        self._suffix_offsets = {'.rix': 0, '.iix': 1, '.tix': 2, '.six': 3,
1386
 
            '.cix': 4}
 
1240
        self._suffix_offsets = {'.rix': 0, '.iix': 1, '.tix': 2, '.six': 3}
1387
1241
        self.packs = []
1388
1242
        # name:Pack mapping
1389
 
        self._names = None
1390
1243
        self._packs_by_name = {}
1391
1244
        # the previous pack-names content
1392
1245
        self._packs_at_load = None
1393
1246
        # when a pack is being created by this object, the state of that pack.
1394
1247
        self._new_pack = None
1395
1248
        # 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)
 
1249
        self.revision_index = AggregateIndex(self.reload_pack_names)
 
1250
        self.inventory_index = AggregateIndex(self.reload_pack_names)
 
1251
        self.text_index = AggregateIndex(self.reload_pack_names)
 
1252
        self.signature_index = AggregateIndex(self.reload_pack_names)
1420
1253
 
1421
1254
    def add_pack_to_memory(self, pack):
1422
1255
        """Make a Pack object available to the repository to satisfy queries.
1423
 
 
 
1256
        
1424
1257
        :param pack: A Pack object.
1425
1258
        """
1426
1259
        if pack.name in self._packs_by_name:
1427
 
            raise AssertionError(
1428
 
                'pack %s already in _packs_by_name' % (pack.name,))
 
1260
            raise AssertionError()
1429
1261
        self.packs.append(pack)
1430
1262
        self._packs_by_name[pack.name] = pack
1431
1263
        self.revision_index.add_index(pack.revision_index, pack)
1432
1264
        self.inventory_index.add_index(pack.inventory_index, pack)
1433
1265
        self.text_index.add_index(pack.text_index, pack)
1434
1266
        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
 
 
 
1267
        
1438
1268
    def all_packs(self):
1439
1269
        """Return a list of all the Pack objects this repository has.
1440
1270
 
1449
1279
 
1450
1280
    def autopack(self):
1451
1281
        """Pack the pack collection incrementally.
1452
 
 
 
1282
        
1453
1283
        This will not attempt global reorganisation or recompression,
1454
1284
        rather it will just ensure that the total number of packs does
1455
1285
        not grow without bound. It uses the _max_pack_count method to
1461
1291
        in synchronisation with certain steps. Otherwise the names collection
1462
1292
        is not flushed.
1463
1293
 
1464
 
        :return: Something evaluating true if packing took place.
 
1294
        :return: True if packing took place.
1465
1295
        """
1466
1296
        while True:
1467
1297
            try:
1468
1298
                return self._do_autopack()
1469
 
            except errors.RetryAutopack:
 
1299
            except errors.RetryAutopack, e:
1470
1300
                # If we get a RetryAutopack exception, we should abort the
1471
1301
                # current action, and retry.
1472
1302
                pass
1476
1306
        total_revisions = self.revision_index.combined_index.key_count()
1477
1307
        total_packs = len(self._names)
1478
1308
        if self._max_pack_count(total_revisions) >= total_packs:
1479
 
            return None
 
1309
            return False
 
1310
        # XXX: the following may want to be a class, to pack with a given
 
1311
        # policy.
1480
1312
        # determine which packs need changing
1481
1313
        pack_distribution = self.pack_distribution(total_revisions)
1482
1314
        existing_packs = []
1490
1322
                # group their data with the relevant commit, and that may
1491
1323
                # involve rewriting ancient history - which autopack tries to
1492
1324
                # avoid. Alternatively we could not group the data but treat
1493
 
                # each of these as having a single revision, and thus add
 
1325
                # each of these as having a single revision, and thus add 
1494
1326
                # one revision for each to the total revision count, to get
1495
1327
                # a matching distribution.
1496
1328
                continue
1504
1336
            'containing %d revisions. Packing %d files into %d affecting %d'
1505
1337
            ' revisions', self, total_packs, total_revisions, num_old_packs,
1506
1338
            num_new_packs, num_revs_affected)
1507
 
        result = self._execute_pack_operations(pack_operations,
 
1339
        self._execute_pack_operations(pack_operations,
1508
1340
                                      reload_func=self._restart_autopack)
1509
 
        mutter('Auto-packing repository %s completed', self)
1510
 
        return result
 
1341
        return True
1511
1342
 
1512
1343
    def _execute_pack_operations(self, pack_operations, _packer_class=Packer,
1513
1344
                                 reload_func=None):
1515
1346
 
1516
1347
        :param pack_operations: A list of [revision_count, packs_to_combine].
1517
1348
        :param _packer_class: The class of packer to use (default: Packer).
1518
 
        :return: The new pack names.
 
1349
        :return: None.
1519
1350
        """
1520
1351
        for revision_count, packs in pack_operations:
1521
1352
            # we may have no-ops from the setup logic
1537
1368
                self._remove_pack_from_memory(pack)
1538
1369
        # record the newly available packs and stop advertising the old
1539
1370
        # 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()
 
1371
        self._save_pack_names(clear_obsolete_packs=True)
 
1372
        # Move the old packs out of the way now they are no longer referenced.
 
1373
        for revision_count, packs in pack_operations:
 
1374
            self._obsolete_packs(packs)
1550
1375
 
1551
1376
    def lock_names(self):
1552
1377
        """Acquire the mutex around the pack-names index.
1553
 
 
 
1378
        
1554
1379
        This cannot be used in the middle of a read-only transaction on the
1555
1380
        repository.
1556
1381
        """
1557
1382
        self.repo.control_files.lock_write()
1558
1383
 
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):
 
1384
    def pack(self):
1564
1385
        """Pack the pack collection totally."""
1565
1386
        self.ensure_loaded()
1566
1387
        total_packs = len(self._names)
1567
 
        if self._already_packed():
 
1388
        if total_packs < 2:
 
1389
            # This is arguably wrong because we might not be optimal, but for
 
1390
            # now lets leave it in. (e.g. reconcile -> one pack. But not
 
1391
            # optimal.
1568
1392
            return
1569
1393
        total_revisions = self.revision_index.combined_index.key_count()
1570
1394
        # XXX: the following may want to be a class, to pack with a given
1571
1395
        # policy.
1572
1396
        mutter('Packing repository %s, which has %d pack files, '
1573
 
            'containing %d revisions with hint %r.', self, total_packs,
1574
 
            total_revisions, hint)
 
1397
            'containing %d revisions into 1 packs.', self, total_packs,
 
1398
            total_revisions)
1575
1399
        # determine which packs need changing
 
1400
        pack_distribution = [1]
1576
1401
        pack_operations = [[0, []]]
1577
1402
        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)
 
1403
            pack_operations[-1][0] += pack.get_revision_count()
 
1404
            pack_operations[-1][1].append(pack)
1583
1405
        self._execute_pack_operations(pack_operations, OptimisingPacker)
1584
1406
 
1585
 
        if clean_obsolete_packs:
1586
 
            self._clear_obsolete_packs()
1587
 
 
1588
1407
    def plan_autopack_combinations(self, existing_packs, pack_distribution):
1589
1408
        """Plan a pack operation.
1590
1409
 
1638
1457
        return [[final_rev_count, final_pack_list]]
1639
1458
 
1640
1459
    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
1460
        # NB: if you see an assertion error here, its probably access against
1646
1461
        # an unlocked repo. Naughty.
1647
1462
        if not self.repo.is_locked():
1653
1468
                name = key[0]
1654
1469
                self._names[name] = self._parse_index_sizes(value)
1655
1470
                self._packs_at_load.add((key, value))
1656
 
            result = True
1657
 
        else:
1658
 
            result = False
1659
1471
        # populate all the metadata.
1660
1472
        self.all_packs()
1661
 
        return result
1662
1473
 
1663
1474
    def _parse_index_sizes(self, value):
1664
1475
        """Parse a string of index sizes."""
1677
1488
            inv_index = self._make_index(name, '.iix')
1678
1489
            txt_index = self._make_index(name, '.tix')
1679
1490
            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
1491
            result = ExistingPack(self._pack_transport, name, rev_index,
1685
 
                inv_index, txt_index, sig_index, chk_index)
 
1492
                inv_index, txt_index, sig_index)
1686
1493
            self.add_pack_to_memory(result)
1687
1494
            return result
1688
1495
 
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
1496
    def allocate(self, a_new_pack):
1721
1497
        """Allocate name in the list of packs.
1722
1498
 
1732
1508
 
1733
1509
    def _iter_disk_pack_index(self):
1734
1510
        """Iterate over the contents of the pack-names index.
1735
 
 
 
1511
        
1736
1512
        This is used when loading the list from disk, and before writing to
1737
1513
        detect updates from others during our write operation.
1738
1514
        :return: An iterator of the index contents.
1740
1516
        return self._index_class(self.transport, 'pack-names', None
1741
1517
                ).iter_all_entries()
1742
1518
 
1743
 
    def _make_index(self, name, suffix, resume=False, unlimited_cache=False):
 
1519
    def _make_index(self, name, suffix):
1744
1520
        size_offset = self._suffix_offsets[suffix]
1745
1521
        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)
 
1522
        index_size = self._names[name][size_offset]
 
1523
        return self._index_class(
 
1524
            self._index_transport, index_name, index_size)
1754
1525
 
1755
1526
    def _max_pack_count(self, total_revisions):
1756
1527
        """Return the maximum number of packs to use for total revisions.
1757
 
 
 
1528
        
1758
1529
        :param total_revisions: The total number of revisions in the
1759
1530
            repository.
1760
1531
        """
1784
1555
        :param return: None.
1785
1556
        """
1786
1557
        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,))
 
1558
            pack.pack_transport.rename(pack.file_name(),
 
1559
                '../obsolete_packs/' + pack.file_name())
1794
1560
            # TODO: Probably needs to know all possible indices for this pack
1795
1561
            # - or maybe list the directory and move all indices matching this
1796
1562
            # 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,))
 
1563
            for suffix in ('.iix', '.six', '.tix', '.rix'):
 
1564
                self._index_transport.rename(pack.name + suffix,
 
1565
                    '../obsolete_packs/' + pack.name + suffix)
1807
1566
 
1808
1567
    def pack_distribution(self, total_revisions):
1809
1568
        """Generate a list of the number of revisions to put in each pack.
1827
1586
 
1828
1587
    def _remove_pack_from_memory(self, pack):
1829
1588
        """Remove pack from the packs accessed by this repository.
1830
 
 
 
1589
        
1831
1590
        Only affects memory state, until self._save_pack_names() is invoked.
1832
1591
        """
1833
1592
        self._names.pop(pack.name)
1835
1594
        self._remove_pack_indices(pack)
1836
1595
        self.packs.remove(pack)
1837
1596
 
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
 
1597
    def _remove_pack_indices(self, pack):
 
1598
        """Remove the indices for pack from the aggregated indices."""
 
1599
        self.revision_index.remove_index(pack.revision_index, pack)
 
1600
        self.inventory_index.remove_index(pack.inventory_index, pack)
 
1601
        self.text_index.remove_index(pack.text_index, pack)
 
1602
        self.signature_index.remove_index(pack.signature_index, pack)
1854
1603
 
1855
1604
    def reset(self):
1856
1605
        """Clear all cached data."""
1857
1606
        # cached revision data
 
1607
        self.repo._revision_knit = None
1858
1608
        self.revision_index.clear()
1859
1609
        # cached signature data
 
1610
        self.repo._signature_knit = None
1860
1611
        self.signature_index.clear()
1861
1612
        # cached file text data
1862
1613
        self.text_index.clear()
 
1614
        self.repo._text_knit = None
1863
1615
        # cached inventory data
1864
1616
        self.inventory_index.clear()
1865
 
        # cached chk data
1866
 
        if self.chk_index is not None:
1867
 
            self.chk_index.clear()
1868
1617
        # remove the open pack
1869
1618
        self._new_pack = None
1870
1619
        # information about packs.
1889
1638
        disk_nodes = set()
1890
1639
        for index, key, value in self._iter_disk_pack_index():
1891
1640
            disk_nodes.add((key, value))
1892
 
        orig_disk_nodes = set(disk_nodes)
1893
1641
 
1894
1642
        # do a two-way diff against our original content
1895
1643
        current_nodes = set()
1908
1656
        disk_nodes.difference_update(deleted_nodes)
1909
1657
        disk_nodes.update(new_nodes)
1910
1658
 
1911
 
        return disk_nodes, deleted_nodes, new_nodes, orig_disk_nodes
 
1659
        return disk_nodes, deleted_nodes, new_nodes
1912
1660
 
1913
1661
    def _syncronize_pack_names_from_disk_nodes(self, disk_nodes):
1914
1662
        """Given the correct set of pack files, update our saved info.
1954
1702
                added.append(name)
1955
1703
        return removed, added, modified
1956
1704
 
1957
 
    def _save_pack_names(self, clear_obsolete_packs=False, obsolete_packs=None):
 
1705
    def _save_pack_names(self, clear_obsolete_packs=False):
1958
1706
        """Save the list of packs.
1959
1707
 
1960
1708
        This will take out the mutex around the pack names list for the
1964
1712
 
1965
1713
        :param clear_obsolete_packs: If True, clear out the contents of the
1966
1714
            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
1715
        """
1971
 
        already_obsolete = []
1972
1716
        self.lock_names()
1973
1717
        try:
1974
1718
            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 -
 
1719
            disk_nodes, deleted_nodes, new_nodes = self._diff_pack_names()
 
1720
            # TODO: handle same-name, index-size-changes here - 
1978
1721
            # e.g. use the value from disk, not ours, *unless* we're the one
1979
1722
            # changing it.
1980
1723
            for key, value in disk_nodes:
1981
1724
                builder.add_node(key, value)
1982
1725
            self.transport.put_file('pack-names', builder.finish(),
1983
1726
                mode=self.repo.bzrdir._get_file_mode())
 
1727
            # move the baseline forward
1984
1728
            self._packs_at_load = disk_nodes
1985
1729
            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)
 
1730
                self._clear_obsolete_packs()
1990
1731
        finally:
1991
1732
            self._unlock_names()
1992
1733
        # synchronise the memory packs list with what we just wrote:
1993
1734
        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
1735
 
2005
1736
    def reload_pack_names(self):
2006
1737
        """Sync our pack listing with what is present in the repository.
2008
1739
        This should be called when we find out that something we thought was
2009
1740
        present is now missing. This happens when another process re-packs the
2010
1741
        repository, etc.
2011
 
 
2012
 
        :return: True if the in-memory list of packs has been altered at all.
2013
1742
        """
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
 
1743
        # This is functionally similar to _save_pack_names, but we don't write
2022
1744
        # 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
 
1745
        disk_nodes, _, _ = self._diff_pack_names()
 
1746
        self._packs_at_load = disk_nodes
2029
1747
        (removed, added,
2030
1748
         modified) = self._syncronize_pack_names_from_disk_nodes(disk_nodes)
2031
1749
        if removed or added or modified:
2040
1758
            raise
2041
1759
        raise errors.RetryAutopack(self.repo, False, sys.exc_info())
2042
1760
 
2043
 
    def _clear_obsolete_packs(self, preserve=None):
 
1761
    def _clear_obsolete_packs(self):
2044
1762
        """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
1763
        """
2049
 
        found = []
2050
1764
        obsolete_pack_transport = self.transport.clone('obsolete_packs')
2051
 
        if preserve is None:
2052
 
            preserve = set()
2053
1765
        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
1766
            try:
2060
1767
                obsolete_pack_transport.delete(filename)
2061
1768
            except (errors.PathError, errors.TransportError), e:
2062
 
                warning("couldn't delete obsolete pack, skipping it:\n%s"
2063
 
                        % (e,))
2064
 
        return found
 
1769
                warning("couldn't delete obsolete pack, skipping it:\n%s" % (e,))
2065
1770
 
2066
1771
    def _start_write_group(self):
2067
1772
        # Do not permit preparation for writing if we're not in a 'write lock'.
2068
1773
        if not self.repo.is_write_locked():
2069
1774
            raise errors.NotWriteLocked(self)
2070
 
        self._new_pack = self.pack_factory(self, upload_suffix='.pack',
 
1775
        self._new_pack = NewPack(self, upload_suffix='.pack',
2071
1776
            file_mode=self.repo.bzrdir._get_file_mode())
2072
1777
        # allow writing: queue writes to a new index
2073
1778
        self.revision_index.add_writable_index(self._new_pack.revision_index,
2076
1781
            self._new_pack)
2077
1782
        self.text_index.add_writable_index(self._new_pack.text_index,
2078
1783
            self._new_pack)
2079
 
        self._new_pack.text_index.set_optimize(combine_backing_indices=False)
2080
1784
        self.signature_index.add_writable_index(self._new_pack.signature_index,
2081
1785
            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
1786
 
2088
1787
        self.repo.inventories._index._add_callback = self.inventory_index.add_callback
2089
1788
        self.repo.revisions._index._add_callback = self.revision_index.add_callback
2094
1793
        # FIXME: just drop the transient index.
2095
1794
        # forget what names there are
2096
1795
        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
 
        
 
1796
            try:
 
1797
                self._new_pack.abort()
 
1798
            finally:
 
1799
                # XXX: If we aborted while in the middle of finishing the write
 
1800
                # group, _remove_pack_indices can fail because the indexes are
 
1801
                # already gone.  If they're not there we shouldn't fail in this
 
1802
                # case.  -- mbp 20081113
 
1803
                self._remove_pack_indices(self._new_pack)
 
1804
                self._new_pack = None
 
1805
        self.repo._text_knit = None
 
1806
 
2129
1807
    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
1808
        self._remove_pack_indices(self._new_pack)
2149
 
        any_new_content = False
2150
1809
        if self._new_pack.data_inserted():
2151
1810
            # get all the data to disk and read to use
2152
1811
            self._new_pack.finish()
2153
1812
            self.allocate(self._new_pack)
2154
1813
            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:
 
1814
            if not self.autopack():
2171
1815
                # when autopack takes no steps, the names list is still
2172
1816
                # 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
 
1817
                self._save_pack_names()
2185
1818
        else:
2186
1819
            self._new_pack.abort()
2187
1820
            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)
 
1821
        self.repo._text_knit = None
2194
1822
 
2195
1823
 
2196
1824
class KnitPackRepository(KnitRepository):
2197
1825
    """Repository with knit objects stored inside pack containers.
2198
 
 
 
1826
    
2199
1827
    The layering for a KnitPackRepository is:
2200
1828
 
2201
1829
    Graph        |  HPSS    | Repository public layer |
2215
1843
      pack file. The GraphIndex layer works in N-tuples and is unaware of any
2216
1844
      semantic value.
2217
1845
    ===================================================
2218
 
 
 
1846
    
2219
1847
    """
2220
1848
 
2221
1849
    def __init__(self, _format, a_bzrdir, control_files, _commit_builder_class,
2228
1856
            self._transport.clone('upload'),
2229
1857
            self._transport.clone('packs'),
2230
1858
            _format.index_builder_class,
2231
 
            _format.index_class,
2232
 
            use_chk_index=self._format.supports_chks,
2233
 
            )
 
1859
            _format.index_class)
2234
1860
        self.inventories = KnitVersionedFiles(
2235
1861
            _KnitGraphIndex(self._pack_collection.inventory_index.combined_index,
2236
1862
                add_callback=self._pack_collection.inventory_index.add_callback,
2240
1866
        self.revisions = KnitVersionedFiles(
2241
1867
            _KnitGraphIndex(self._pack_collection.revision_index.combined_index,
2242
1868
                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),
 
1869
                deltas=False, parents=True, is_locked=self.is_locked),
2245
1870
            data_access=self._pack_collection.revision_index.data_access,
2246
1871
            max_delta_chain=0)
2247
1872
        self.signatures = KnitVersionedFiles(
2256
1881
                deltas=True, parents=True, is_locked=self.is_locked),
2257
1882
            data_access=self._pack_collection.text_index.data_access,
2258
1883
            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
1884
        # 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.)
 
1885
        # physical lock only taken out around changes to the pack-names list.) 
2273
1886
        # Another way to represent this would be a decorator around the control
2274
1887
        # files object that presents logical locks as physical ones - if this
2275
1888
        # gets ugly consider that alternative design. RBC 20071011
2279
1892
        self._reconcile_does_inventory_gc = True
2280
1893
        self._reconcile_fixes_text_parents = True
2281
1894
        self._reconcile_backsup_inventory = False
 
1895
        self._fetch_order = 'unordered'
2282
1896
 
2283
 
    def _warn_if_deprecated(self, branch=None):
 
1897
    def _warn_if_deprecated(self):
2284
1898
        # This class isn't deprecated, but one sub-format is
2285
1899
        if isinstance(self._format, RepositoryFormatKnitPack5RichRootBroken):
2286
 
            super(KnitPackRepository, self)._warn_if_deprecated(branch)
 
1900
            from bzrlib import repository
 
1901
            if repository._deprecation_warning_done:
 
1902
                return
 
1903
            repository._deprecation_warning_done = True
 
1904
            warning("Format %s for %s is deprecated - please use"
 
1905
                    " 'bzr upgrade --1.6.1-rich-root'"
 
1906
                    % (self._format, self.bzrdir.transport.base))
2287
1907
 
2288
1908
    def _abort_write_group(self):
2289
 
        self.revisions._index._key_dependencies.clear()
2290
1909
        self._pack_collection._abort_write_group()
2291
1910
 
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)
 
1911
    def _find_inconsistent_revision_parents(self):
 
1912
        """Find revisions with incorrectly cached parents.
 
1913
 
 
1914
        :returns: an iterator yielding tuples of (revison-id, parents-in-index,
 
1915
            parents-in-revision).
 
1916
        """
 
1917
        if not self.is_locked():
 
1918
            raise errors.ObjectNotLocked(self)
 
1919
        pb = ui.ui_factory.nested_progress_bar()
 
1920
        result = []
 
1921
        try:
 
1922
            revision_nodes = self._pack_collection.revision_index \
 
1923
                .combined_index.iter_all_entries()
 
1924
            index_positions = []
 
1925
            # Get the cached index values for all revisions, and also the location
 
1926
            # in each index of the revision text so we can perform linear IO.
 
1927
            for index, key, value, refs in revision_nodes:
 
1928
                pos, length = value[1:].split(' ')
 
1929
                index_positions.append((index, int(pos), key[0],
 
1930
                    tuple(parent[0] for parent in refs[0])))
 
1931
                pb.update("Reading revision index.", 0, 0)
 
1932
            index_positions.sort()
 
1933
            batch_count = len(index_positions) / 1000 + 1
 
1934
            pb.update("Checking cached revision graph.", 0, batch_count)
 
1935
            for offset in xrange(batch_count):
 
1936
                pb.update("Checking cached revision graph.", offset)
 
1937
                to_query = index_positions[offset * 1000:(offset + 1) * 1000]
 
1938
                if not to_query:
 
1939
                    break
 
1940
                rev_ids = [item[2] for item in to_query]
 
1941
                revs = self.get_revisions(rev_ids)
 
1942
                for revision, item in zip(revs, to_query):
 
1943
                    index_parents = item[3]
 
1944
                    rev_parents = tuple(revision.parent_ids)
 
1945
                    if index_parents != rev_parents:
 
1946
                        result.append((revision.revision_id, index_parents, rev_parents))
 
1947
        finally:
 
1948
            pb.finished()
 
1949
        return result
 
1950
 
 
1951
    @symbol_versioning.deprecated_method(symbol_versioning.one_one)
 
1952
    def get_parents(self, revision_ids):
 
1953
        """See graph._StackedParentsProvider.get_parents."""
 
1954
        parent_map = self.get_parent_map(revision_ids)
 
1955
        return [parent_map.get(r, None) for r in revision_ids]
2296
1956
 
2297
1957
    def _make_parents_provider(self):
2298
1958
        return graph.CachingParentsProvider(self)
2299
1959
 
2300
1960
    def _refresh_data(self):
2301
 
        if not self.is_locked():
2302
 
            return
2303
 
        self._pack_collection.reload_pack_names()
 
1961
        if self._write_lock_count == 1 or (
 
1962
            self.control_files._lock_count == 1 and
 
1963
            self.control_files._lock_mode == 'r'):
 
1964
            # forget what names there are
 
1965
            self._pack_collection.reset()
 
1966
            # XXX: Better to do an in-memory merge when acquiring a new lock -
 
1967
            # factor out code from _save_pack_names.
 
1968
            self._pack_collection.ensure_loaded()
2304
1969
 
2305
1970
    def _start_write_group(self):
2306
1971
        self._pack_collection._start_write_group()
2307
1972
 
2308
1973
    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)
 
1974
        return self._pack_collection._commit_write_group()
2329
1975
 
2330
1976
    def get_transaction(self):
2331
1977
        if self._write_lock_count:
2340
1986
        return self._write_lock_count
2341
1987
 
2342
1988
    def lock_write(self, token=None):
2343
 
        locked = self.is_locked()
2344
 
        if not self._write_lock_count and locked:
 
1989
        if not self._write_lock_count and self.is_locked():
2345
1990
            raise errors.ReadOnlyError(self)
2346
1991
        self._write_lock_count += 1
2347
1992
        if self._write_lock_count == 1:
2348
1993
            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
1994
            for repo in self._fallback_repositories:
2354
1995
                # Writes don't affect fallback repos
2355
1996
                repo.lock_read()
2356
 
            self._refresh_data()
 
1997
        self._refresh_data()
2357
1998
 
2358
1999
    def lock_read(self):
2359
 
        locked = self.is_locked()
2360
2000
        if self._write_lock_count:
2361
2001
            self._write_lock_count += 1
2362
2002
        else:
2363
2003
            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
2004
            for repo in self._fallback_repositories:
 
2005
                # Writes don't affect fallback repos
2369
2006
                repo.lock_read()
2370
 
            self._refresh_data()
 
2007
        self._refresh_data()
2371
2008
 
2372
2009
    def leave_lock_in_place(self):
2373
2010
        # not supported - raise an error
2378
2015
        raise NotImplementedError(self.dont_leave_lock_in_place)
2379
2016
 
2380
2017
    @needs_write_lock
2381
 
    def pack(self, hint=None, clean_obsolete_packs=False):
 
2018
    def pack(self):
2382
2019
        """Compress the data within the repository.
2383
2020
 
2384
2021
        This will pack all the data to a single pack. In future it may
2385
2022
        recompress deltas or do other such expensive operations.
2386
2023
        """
2387
 
        self._pack_collection.pack(hint=hint, clean_obsolete_packs=clean_obsolete_packs)
 
2024
        self._pack_collection.pack()
2388
2025
 
2389
2026
    @needs_write_lock
2390
2027
    def reconcile(self, other=None, thorough=False):
2394
2031
        reconciler.reconcile()
2395
2032
        return reconciler
2396
2033
 
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
2034
    def unlock(self):
2403
2035
        if self._write_lock_count == 1 and self._write_group is not None:
2404
2036
            self.abort_write_group()
2413
2045
                transaction = self._transaction
2414
2046
                self._transaction = None
2415
2047
                transaction.finish()
 
2048
                for repo in self._fallback_repositories:
 
2049
                    repo.unlock()
2416
2050
        else:
2417
2051
            self.control_files.unlock()
2418
 
 
2419
 
        if not self.is_locked():
2420
2052
            for repo in self._fallback_repositories:
2421
2053
                repo.unlock()
2422
2054
 
2423
2055
 
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
2056
class RepositoryFormatPack(MetaDirRepositoryFormat):
2498
2057
    """Format logic for pack structured repositories.
2499
2058
 
2519
2078
    # Set this attribute in derived clases to control the _serializer that the
2520
2079
    # repository objects will have passed to their constructor.
2521
2080
    _serializer = None
2522
 
    # Packs are not confused by ghosts.
2523
 
    supports_ghosts = True
2524
2081
    # External references are not supported in pack repositories yet.
2525
2082
    supports_external_lookups = False
2526
 
    # Most pack formats do not use chk lookups.
2527
 
    supports_chks = False
2528
2083
    # What index classes to use
2529
2084
    index_builder_class = None
2530
2085
    index_class = None
2531
 
    _fetch_uses_deltas = True
2532
 
    fast_deltas = False
2533
2086
 
2534
2087
    def initialize(self, a_bzrdir, shared=False):
2535
2088
        """Create a pack based repository.
2544
2097
        builder = self.index_builder_class()
2545
2098
        files = [('pack-names', builder.finish())]
2546
2099
        utf8_files = [('format', self.get_format_string())]
2547
 
 
 
2100
        
2548
2101
        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
 
2102
        return self.open(a_bzrdir=a_bzrdir, _found=True)
2552
2103
 
2553
2104
    def open(self, a_bzrdir, _found=False, _override_transport=None):
2554
2105
        """See RepositoryFormat.open().
2555
 
 
 
2106
        
2556
2107
        :param _override_transport: INTERNAL USE ONLY. Allows opening the
2557
2108
                                    repository at a slightly different url
2558
2109
                                    than normal. I.e. during 'upgrade'.
2603
2154
        """See RepositoryFormat.get_format_description()."""
2604
2155
        return "Packs containing knits without subtree support"
2605
2156
 
 
2157
    def check_conversion_target(self, target_format):
 
2158
        pass
 
2159
 
2606
2160
 
2607
2161
class RepositoryFormatKnitPack3(RepositoryFormatPack):
2608
2162
    """A subtrees parameterized Pack repository.
2617
2171
    repository_class = KnitPackRepository
2618
2172
    _commit_builder_class = PackRootCommitBuilder
2619
2173
    rich_root_data = True
2620
 
    experimental = True
2621
2174
    supports_tree_reference = True
2622
2175
    @property
2623
2176
    def _serializer(self):
2635
2188
 
2636
2189
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2637
2190
 
 
2191
    def check_conversion_target(self, target_format):
 
2192
        if not target_format.rich_root_data:
 
2193
            raise errors.BadConversionTarget(
 
2194
                'Does not support rich root data.', target_format)
 
2195
        if not getattr(target_format, 'supports_tree_reference', False):
 
2196
            raise errors.BadConversionTarget(
 
2197
                'Does not support nested trees', target_format)
 
2198
            
2638
2199
    def get_format_string(self):
2639
2200
        """See RepositoryFormat.get_format_string()."""
2640
2201
        return "Bazaar pack repository format 1 with subtree support (needs bzr 0.92)\n"
2673
2234
 
2674
2235
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2675
2236
 
 
2237
    def check_conversion_target(self, target_format):
 
2238
        if not target_format.rich_root_data:
 
2239
            raise errors.BadConversionTarget(
 
2240
                'Does not support rich root data.', target_format)
 
2241
 
2676
2242
    def get_format_string(self):
2677
2243
        """See RepositoryFormat.get_format_string()."""
2678
2244
        return ("Bazaar pack repository format 1 with rich root"
2719
2285
        """See RepositoryFormat.get_format_description()."""
2720
2286
        return "Packs 5 (adds stacking support, requires bzr 1.6)"
2721
2287
 
 
2288
    def check_conversion_target(self, target_format):
 
2289
        pass
 
2290
 
2722
2291
 
2723
2292
class RepositoryFormatKnitPack5RichRoot(RepositoryFormatPack):
2724
2293
    """A repository with rich roots and stacking.
2751
2320
 
2752
2321
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2753
2322
 
 
2323
    def check_conversion_target(self, target_format):
 
2324
        if not target_format.rich_root_data:
 
2325
            raise errors.BadConversionTarget(
 
2326
                'Does not support rich root data.', target_format)
 
2327
 
2754
2328
    def get_format_string(self):
2755
2329
        """See RepositoryFormat.get_format_string()."""
2756
2330
        return "Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6.1)\n"
2797
2371
 
2798
2372
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2799
2373
 
 
2374
    def check_conversion_target(self, target_format):
 
2375
        if not target_format.rich_root_data:
 
2376
            raise errors.BadConversionTarget(
 
2377
                'Does not support rich root data.', target_format)
 
2378
 
2800
2379
    def get_format_string(self):
2801
2380
        """See RepositoryFormat.get_format_string()."""
2802
2381
        return "Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6)\n"
2840
2419
        """See RepositoryFormat.get_format_description()."""
2841
2420
        return "Packs 6 (uses btree indexes, requires bzr 1.9)"
2842
2421
 
 
2422
    def check_conversion_target(self, target_format):
 
2423
        pass
 
2424
 
2843
2425
 
2844
2426
class RepositoryFormatKnitPack6RichRoot(RepositoryFormatPack):
2845
2427
    """A repository with rich roots, no subtrees, stacking and btree indexes.
2869
2451
 
2870
2452
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2871
2453
 
 
2454
    def check_conversion_target(self, target_format):
 
2455
        if not target_format.rich_root_data:
 
2456
            raise errors.BadConversionTarget(
 
2457
                'Does not support rich root data.', target_format)
 
2458
 
2872
2459
    def get_format_string(self):
2873
2460
        """See RepositoryFormat.get_format_string()."""
2874
2461
        return "Bazaar RepositoryFormatKnitPack6RichRoot (bzr 1.9)\n"
2877
2464
        return "Packs 6 rich-root (uses btree indexes, requires bzr 1.9)"
2878
2465
 
2879
2466
 
 
2467
class RepositoryFormatPackDevelopment2(RepositoryFormatPack):
 
2468
    """A no-subtrees development repository.
 
2469
 
 
2470
    This format should be retained until the second release after bzr 1.7.
 
2471
 
 
2472
    This is pack-1.6.1 with B+Tree indices.
 
2473
    """
 
2474
 
 
2475
    repository_class = KnitPackRepository
 
2476
    _commit_builder_class = PackCommitBuilder
 
2477
    supports_external_lookups = True
 
2478
    # What index classes to use
 
2479
    index_builder_class = BTreeBuilder
 
2480
    index_class = BTreeGraphIndex
 
2481
 
 
2482
    @property
 
2483
    def _serializer(self):
 
2484
        return xml5.serializer_v5
 
2485
 
 
2486
    def _get_matching_bzrdir(self):
 
2487
        return bzrdir.format_registry.make_bzrdir('development2')
 
2488
 
 
2489
    def _ignore_setting_bzrdir(self, format):
 
2490
        pass
 
2491
 
 
2492
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
 
2493
 
 
2494
    def get_format_string(self):
 
2495
        """See RepositoryFormat.get_format_string()."""
 
2496
        return "Bazaar development format 2 (needs bzr.dev from before 1.8)\n"
 
2497
 
 
2498
    def get_format_description(self):
 
2499
        """See RepositoryFormat.get_format_description()."""
 
2500
        return ("Development repository format, currently the same as "
 
2501
            "1.6.1 with B+Trees.\n")
 
2502
 
 
2503
    def check_conversion_target(self, target_format):
 
2504
        pass
 
2505
 
 
2506
 
2880
2507
class RepositoryFormatPackDevelopment2Subtree(RepositoryFormatPack):
2881
2508
    """A subtrees development repository.
2882
2509
 
2883
2510
    This format should be retained until the second release after bzr 1.7.
2884
2511
 
2885
2512
    1.6.1-subtree[as it might have been] with B+Tree indices.
2886
 
 
2887
 
    This is [now] retained until we have a CHK based subtree format in
2888
 
    development.
2889
2513
    """
2890
2514
 
2891
2515
    repository_class = KnitPackRepository
2892
2516
    _commit_builder_class = PackRootCommitBuilder
2893
2517
    rich_root_data = True
2894
 
    experimental = True
2895
2518
    supports_tree_reference = True
2896
2519
    supports_external_lookups = True
2897
2520
    # What index classes to use
2904
2527
 
2905
2528
    def _get_matching_bzrdir(self):
2906
2529
        return bzrdir.format_registry.make_bzrdir(
2907
 
            'development-subtree')
 
2530
            'development2-subtree')
2908
2531
 
2909
2532
    def _ignore_setting_bzrdir(self, format):
2910
2533
        pass
2911
2534
 
2912
2535
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2913
2536
 
 
2537
    def check_conversion_target(self, target_format):
 
2538
        if not target_format.rich_root_data:
 
2539
            raise errors.BadConversionTarget(
 
2540
                'Does not support rich root data.', target_format)
 
2541
        if not getattr(target_format, 'supports_tree_reference', False):
 
2542
            raise errors.BadConversionTarget(
 
2543
                'Does not support nested trees', target_format)
 
2544
            
2914
2545
    def get_format_string(self):
2915
2546
        """See RepositoryFormat.get_format_string()."""
2916
2547
        return ("Bazaar development format 2 with subtree support "
2920
2551
        """See RepositoryFormat.get_format_description()."""
2921
2552
        return ("Development repository format, currently the same as "
2922
2553
            "1.6.1-subtree with B+Tree indices.\n")
2923