/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/repofmt/pack_repo.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-09-03 08:32:49 UTC
  • mfrom: (1739.2.13 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20080903083249-e76ygekseh1peidm
Fix typo in ReadDirFeature.

Show diffs side-by-side

added added

removed removed

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