/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/repofmt/pack_repo.py

  • Committer: Robert Collins
  • Date: 2010-05-06 23:41:35 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506234135-yivbzczw1sejxnxc
Lock methods on ``Tree``, ``Branch`` and ``Repository`` are now
expected to return an object which can be used to unlock them. This reduces
duplicate code when using cleanups. The previous 'tokens's returned by
``Branch.lock_write`` and ``Repository.lock_write`` are now attributes
on the result of the lock_write. ``repository.RepositoryWriteLockResult``
and ``branch.BranchWriteLockResult`` document this. (Robert Collins)

``log._get_info_for_log_files`` now takes an add_cleanup callable.
(Robert Collins)

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