~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repofmt/pack_repo.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-03-11 13:47:06 UTC
  • mfrom: (5051.3.16 use-branch-open)
  • Revision ID: pqm@pqm.ubuntu.com-20100311134706-kaerqhx3lf7xn6rh
(Jelmer) Pass colocated branch names further down the call stack.

Show diffs side-by-side

added added

removed removed

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