~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repofmt/pack_repo.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2006-05-19 06:14:38 UTC
  • mfrom: (1704.2.23 bzr.mbp.integration)
  • Revision ID: pqm@pqm.ubuntu.com-20060519061438-6300caf3926c3cff
(mbp) small fixes

Show diffs side-by-side

added added

removed removed

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