~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repofmt/pack_repo.py

  • Committer: Robert Collins
  • Date: 2007-11-18 19:56:39 UTC
  • mfrom: (3006 +trunk)
  • mto: This revision was merged to the branch mainline in revision 3038.
  • Revision ID: robertc@robertcollins.net-20071118195639-m6zf3d5ljjw88kkn
Merge bzr.dev.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2007-2011 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007 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
 
from __future__ import absolute_import
18
 
 
19
 
import re
20
 
import sys
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
21
16
 
22
17
from bzrlib.lazy_import import lazy_import
23
18
lazy_import(globals(), """
24
19
from itertools import izip
 
20
import math
 
21
import md5
25
22
import time
26
23
 
27
24
from bzrlib import (
28
 
    chk_map,
29
 
    cleanup,
30
 
    config,
31
 
    debug,
32
 
    graph,
33
 
    osutils,
34
 
    pack,
35
 
    transactions,
36
 
    tsort,
37
 
    ui,
38
 
    )
 
25
        debug,
 
26
        pack,
 
27
        ui,
 
28
        )
39
29
from bzrlib.index import (
 
30
    GraphIndex,
 
31
    GraphIndexBuilder,
 
32
    InMemoryGraphIndex,
40
33
    CombinedGraphIndex,
41
34
    GraphIndexPrefixAdapter,
42
35
    )
 
36
from bzrlib.knit import KnitGraphIndex, _PackAccess, _KnitData
 
37
from bzrlib.osutils import rand_chars
 
38
from bzrlib.pack import ContainerWriter
 
39
from bzrlib.store import revision
43
40
""")
44
41
from bzrlib import (
45
 
    btree_index,
 
42
    bzrdir,
 
43
    deprecated_graph,
46
44
    errors,
 
45
    knit,
47
46
    lockable_files,
48
47
    lockdir,
 
48
    osutils,
 
49
    transactions,
 
50
    xml5,
 
51
    xml7,
49
52
    )
50
53
 
51
 
from bzrlib.decorators import (
52
 
    needs_read_lock,
53
 
    needs_write_lock,
54
 
    only_raises,
55
 
    )
56
 
from bzrlib.lock import LogicalLockResult
 
54
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
55
from bzrlib.repofmt.knitrepo import KnitRepository
57
56
from bzrlib.repository import (
58
 
    _LazyListJoin,
 
57
    CommitBuilder,
59
58
    MetaDirRepository,
60
 
    RepositoryFormatMetaDir,
61
 
    RepositoryWriteLockResult,
62
 
    )
63
 
from bzrlib.vf_repository import (
64
 
    MetaDirVersionedFileRepository,
65
 
    MetaDirVersionedFileRepositoryFormat,
66
 
    VersionedFileCommitBuilder,
67
 
    VersionedFileRootCommitBuilder,
68
 
    )
69
 
from bzrlib.trace import (
70
 
    mutter,
71
 
    note,
72
 
    warning,
73
 
    )
74
 
 
75
 
 
76
 
class PackCommitBuilder(VersionedFileCommitBuilder):
77
 
    """Subclass of VersionedFileCommitBuilder to add texts with pack semantics.
78
 
 
 
59
    MetaDirRepositoryFormat,
 
60
    RootCommitBuilder,
 
61
    )
 
62
import bzrlib.revision as _mod_revision
 
63
from bzrlib.store.revision.knit import KnitRevisionStore
 
64
from bzrlib.store.versioned import VersionedFileStore
 
65
from bzrlib.trace import mutter, note, warning
 
66
 
 
67
 
 
68
class PackCommitBuilder(CommitBuilder):
 
69
    """A subclass of CommitBuilder to add texts with pack semantics.
 
70
    
79
71
    Specifically this uses one knit object rather than one knit object per
80
72
    added text, reducing memory and object pressure.
81
73
    """
82
74
 
83
 
    def __init__(self, repository, parents, config, timestamp=None,
84
 
                 timezone=None, committer=None, revprops=None,
85
 
                 revision_id=None, lossy=False):
86
 
        VersionedFileCommitBuilder.__init__(self, repository, parents, config,
87
 
            timestamp=timestamp, timezone=timezone, committer=committer,
88
 
            revprops=revprops, revision_id=revision_id, lossy=lossy)
89
 
        self._file_graph = graph.Graph(
90
 
            repository._pack_collection.text_index.combined_index)
91
 
 
92
 
    def _heads(self, file_id, revision_ids):
93
 
        keys = [(file_id, revision_id) for revision_id in revision_ids]
94
 
        return set([key[1] for key in self._file_graph.heads(keys)])
95
 
 
96
 
 
97
 
class PackRootCommitBuilder(VersionedFileRootCommitBuilder):
 
75
    def _add_text_to_weave(self, file_id, new_lines, parents, nostore_sha):
 
76
        return self.repository._pack_collection._add_text_to_weave(file_id,
 
77
            self._new_revision_id, new_lines, parents, nostore_sha,
 
78
            self.random_revid)
 
79
 
 
80
 
 
81
class PackRootCommitBuilder(RootCommitBuilder):
98
82
    """A subclass of RootCommitBuilder to add texts with pack semantics.
99
 
 
 
83
    
100
84
    Specifically this uses one knit object rather than one knit object per
101
85
    added text, reducing memory and object pressure.
102
86
    """
103
87
 
104
 
    def __init__(self, repository, parents, config, timestamp=None,
105
 
                 timezone=None, committer=None, revprops=None,
106
 
                 revision_id=None, lossy=False):
107
 
        super(PackRootCommitBuilder, self).__init__(repository, parents,
108
 
            config, timestamp=timestamp, timezone=timezone,
109
 
            committer=committer, revprops=revprops, revision_id=revision_id,
110
 
            lossy=lossy)
111
 
        self._file_graph = graph.Graph(
112
 
            repository._pack_collection.text_index.combined_index)
113
 
 
114
 
    def _heads(self, file_id, revision_ids):
115
 
        keys = [(file_id, revision_id) for revision_id in revision_ids]
116
 
        return set([key[1] for key in self._file_graph.heads(keys)])
 
88
    def _add_text_to_weave(self, file_id, new_lines, parents, nostore_sha):
 
89
        return self.repository._pack_collection._add_text_to_weave(file_id,
 
90
            self._new_revision_id, new_lines, parents, nostore_sha,
 
91
            self.random_revid)
117
92
 
118
93
 
119
94
class Pack(object):
123
98
    ExistingPack and NewPack are used.
124
99
    """
125
100
 
126
 
    # A map of index 'type' to the file extension and position in the
127
 
    # index_sizes array.
128
 
    index_definitions = {
129
 
        'chk': ('.cix', 4),
130
 
        'revision': ('.rix', 0),
131
 
        'inventory': ('.iix', 1),
132
 
        'text': ('.tix', 2),
133
 
        'signature': ('.six', 3),
134
 
        }
135
 
 
136
101
    def __init__(self, revision_index, inventory_index, text_index,
137
 
        signature_index, chk_index=None):
 
102
        signature_index):
138
103
        """Create a pack instance.
139
104
 
140
105
        :param revision_index: A GraphIndex for determining what revisions are
145
110
        :param text_index: A GraphIndex for determining what file texts
146
111
            are present in the pack and accessing the locations of their
147
112
            texts/deltas (via (fileid, revisionid) tuples).
148
 
        :param signature_index: A GraphIndex for determining what signatures are
 
113
        :param revision_index: A GraphIndex for determining what signatures are
149
114
            present in the Pack and accessing the locations of their texts.
150
 
        :param chk_index: A GraphIndex for accessing content by CHK, if the
151
 
            pack has one.
152
115
        """
153
116
        self.revision_index = revision_index
154
117
        self.inventory_index = inventory_index
155
118
        self.text_index = text_index
156
119
        self.signature_index = signature_index
157
 
        self.chk_index = chk_index
158
120
 
159
121
    def access_tuple(self):
160
122
        """Return a tuple (transport, name) for the pack content."""
161
123
        return self.pack_transport, self.file_name()
162
124
 
163
 
    def _check_references(self):
164
 
        """Make sure our external references are present.
165
 
 
166
 
        Packs are allowed to have deltas whose base is not in the pack, but it
167
 
        must be present somewhere in this collection.  It is not allowed to
168
 
        have deltas based on a fallback repository.
169
 
        (See <https://bugs.launchpad.net/bzr/+bug/288751>)
170
 
        """
171
 
        missing_items = {}
172
 
        for (index_name, external_refs, index) in [
173
 
            ('texts',
174
 
                self._get_external_refs(self.text_index),
175
 
                self._pack_collection.text_index.combined_index),
176
 
            ('inventories',
177
 
                self._get_external_refs(self.inventory_index),
178
 
                self._pack_collection.inventory_index.combined_index),
179
 
            ]:
180
 
            missing = external_refs.difference(
181
 
                k for (idx, k, v, r) in
182
 
                index.iter_entries(external_refs))
183
 
            if missing:
184
 
                missing_items[index_name] = sorted(list(missing))
185
 
        if missing_items:
186
 
            from pprint import pformat
187
 
            raise errors.BzrCheckError(
188
 
                "Newly created pack file %r has delta references to "
189
 
                "items not in its repository:\n%s"
190
 
                % (self, pformat(missing_items)))
191
 
 
192
125
    def file_name(self):
193
126
        """Get the file name for the pack on disk."""
194
127
        return self.name + '.pack'
196
129
    def get_revision_count(self):
197
130
        return self.revision_index.key_count()
198
131
 
199
 
    def index_name(self, index_type, name):
200
 
        """Get the disk name of an index type for pack name 'name'."""
201
 
        return name + Pack.index_definitions[index_type][0]
202
 
 
203
 
    def index_offset(self, index_type):
204
 
        """Get the position in a index_size array for a given index type."""
205
 
        return Pack.index_definitions[index_type][1]
206
 
 
207
132
    def inventory_index_name(self, name):
208
133
        """The inv index is the name + .iix."""
209
134
        return self.index_name('inventory', name)
220
145
        """The text index is the name + .tix."""
221
146
        return self.index_name('text', name)
222
147
 
223
 
    def _replace_index_with_readonly(self, index_type):
224
 
        unlimited_cache = False
225
 
        if index_type == 'chk':
226
 
            unlimited_cache = True
227
 
        index = self.index_class(self.index_transport,
228
 
                    self.index_name(index_type, self.name),
229
 
                    self.index_sizes[self.index_offset(index_type)],
230
 
                    unlimited_cache=unlimited_cache)
231
 
        if index_type == 'chk':
232
 
            index._leaf_factory = btree_index._gcchk_factory
233
 
        setattr(self, index_type + '_index', index)
234
 
 
235
148
 
236
149
class ExistingPack(Pack):
237
150
    """An in memory proxy for an existing .pack and its disk indices."""
238
151
 
239
152
    def __init__(self, pack_transport, name, revision_index, inventory_index,
240
 
        text_index, signature_index, chk_index=None):
 
153
        text_index, signature_index):
241
154
        """Create an ExistingPack object.
242
155
 
243
156
        :param pack_transport: The transport where the pack file resides.
244
157
        :param name: The name of the pack on disk in the pack_transport.
245
158
        """
246
159
        Pack.__init__(self, revision_index, inventory_index, text_index,
247
 
            signature_index, chk_index)
 
160
            signature_index)
248
161
        self.name = name
249
162
        self.pack_transport = pack_transport
250
 
        if None in (revision_index, inventory_index, text_index,
251
 
                signature_index, name, pack_transport):
252
 
            raise AssertionError()
 
163
        assert None not in (revision_index, inventory_index, text_index,
 
164
            signature_index, name, pack_transport)
253
165
 
254
166
    def __eq__(self, other):
255
167
        return self.__dict__ == other.__dict__
258
170
        return not self.__eq__(other)
259
171
 
260
172
    def __repr__(self):
261
 
        return "<%s.%s object at 0x%x, %s, %s" % (
262
 
            self.__class__.__module__, self.__class__.__name__, id(self),
263
 
            self.pack_transport, self.name)
264
 
 
265
 
 
266
 
class ResumedPack(ExistingPack):
267
 
 
268
 
    def __init__(self, name, revision_index, inventory_index, text_index,
269
 
        signature_index, upload_transport, pack_transport, index_transport,
270
 
        pack_collection, chk_index=None):
271
 
        """Create a ResumedPack object."""
272
 
        ExistingPack.__init__(self, pack_transport, name, revision_index,
273
 
            inventory_index, text_index, signature_index,
274
 
            chk_index=chk_index)
275
 
        self.upload_transport = upload_transport
276
 
        self.index_transport = index_transport
277
 
        self.index_sizes = [None, None, None, None]
278
 
        indices = [
279
 
            ('revision', revision_index),
280
 
            ('inventory', inventory_index),
281
 
            ('text', text_index),
282
 
            ('signature', signature_index),
283
 
            ]
284
 
        if chk_index is not None:
285
 
            indices.append(('chk', chk_index))
286
 
            self.index_sizes.append(None)
287
 
        for index_type, index in indices:
288
 
            offset = self.index_offset(index_type)
289
 
            self.index_sizes[offset] = index._size
290
 
        self.index_class = pack_collection._index_class
291
 
        self._pack_collection = pack_collection
292
 
        self._state = 'resumed'
293
 
        # XXX: perhaps check that the .pack file exists?
294
 
 
295
 
    def access_tuple(self):
296
 
        if self._state == 'finished':
297
 
            return Pack.access_tuple(self)
298
 
        elif self._state == 'resumed':
299
 
            return self.upload_transport, self.file_name()
300
 
        else:
301
 
            raise AssertionError(self._state)
302
 
 
303
 
    def abort(self):
304
 
        self.upload_transport.delete(self.file_name())
305
 
        indices = [self.revision_index, self.inventory_index, self.text_index,
306
 
            self.signature_index]
307
 
        if self.chk_index is not None:
308
 
            indices.append(self.chk_index)
309
 
        for index in indices:
310
 
            index._transport.delete(index._name)
311
 
 
312
 
    def finish(self):
313
 
        self._check_references()
314
 
        index_types = ['revision', 'inventory', 'text', 'signature']
315
 
        if self.chk_index is not None:
316
 
            index_types.append('chk')
317
 
        for index_type in index_types:
318
 
            old_name = self.index_name(index_type, self.name)
319
 
            new_name = '../indices/' + old_name
320
 
            self.upload_transport.move(old_name, new_name)
321
 
            self._replace_index_with_readonly(index_type)
322
 
        new_name = '../packs/' + self.file_name()
323
 
        self.upload_transport.move(self.file_name(), new_name)
324
 
        self._state = 'finished'
325
 
 
326
 
    def _get_external_refs(self, index):
327
 
        """Return compression parents for this index that are not present.
328
 
 
329
 
        This returns any compression parents that are referenced by this index,
330
 
        which are not contained *in* this index. They may be present elsewhere.
331
 
        """
332
 
        return index.external_references(1)
 
173
        return "<bzrlib.repofmt.pack_repo.Pack object at 0x%x, %s, %s" % (
 
174
            id(self), self.transport, self.name)
333
175
 
334
176
 
335
177
class NewPack(Pack):
336
178
    """An in memory proxy for a pack which is being created."""
337
179
 
338
 
    def __init__(self, pack_collection, upload_suffix='', file_mode=None):
 
180
    # A map of index 'type' to the file extension and position in the
 
181
    # index_sizes array.
 
182
    index_definitions = {
 
183
        'revision': ('.rix', 0),
 
184
        'inventory': ('.iix', 1),
 
185
        'text': ('.tix', 2),
 
186
        'signature': ('.six', 3),
 
187
        }
 
188
 
 
189
    def __init__(self, upload_transport, index_transport, pack_transport,
 
190
        upload_suffix=''):
339
191
        """Create a NewPack instance.
340
192
 
341
 
        :param pack_collection: A PackCollection into which this is being inserted.
 
193
        :param upload_transport: A writable transport for the pack to be
 
194
            incrementally uploaded to.
 
195
        :param index_transport: A writable transport for the pack's indices to
 
196
            be written to when the pack is finished.
 
197
        :param pack_transport: A writable transport for the pack to be renamed
 
198
            to when the upload is complete. This *must* be the same as
 
199
            upload_transport.clone('../packs').
342
200
        :param upload_suffix: An optional suffix to be given to any temporary
343
201
            files created during the pack creation. e.g '.autopack'
344
 
        :param file_mode: Unix permissions for newly created file.
345
202
        """
346
203
        # The relative locations of the packs are constrained, but all are
347
204
        # passed in because the caller has them, so as to avoid object churn.
348
 
        index_builder_class = pack_collection._index_builder_class
349
 
        if pack_collection.chk_index is not None:
350
 
            chk_index = index_builder_class(reference_lists=0)
351
 
        else:
352
 
            chk_index = None
353
205
        Pack.__init__(self,
354
206
            # Revisions: parents list, no text compression.
355
 
            index_builder_class(reference_lists=1),
 
207
            InMemoryGraphIndex(reference_lists=1),
356
208
            # Inventory: We want to map compression only, but currently the
357
209
            # knit code hasn't been updated enough to understand that, so we
358
210
            # have a regular 2-list index giving parents and compression
359
211
            # source.
360
 
            index_builder_class(reference_lists=2),
 
212
            InMemoryGraphIndex(reference_lists=2),
361
213
            # Texts: compression and per file graph, for all fileids - so two
362
214
            # reference lists and two elements in the key tuple.
363
 
            index_builder_class(reference_lists=2, key_elements=2),
 
215
            InMemoryGraphIndex(reference_lists=2, key_elements=2),
364
216
            # Signatures: Just blobs to store, no compression, no parents
365
217
            # listing.
366
 
            index_builder_class(reference_lists=0),
367
 
            # CHK based storage - just blobs, no compression or parents.
368
 
            chk_index=chk_index
 
218
            InMemoryGraphIndex(reference_lists=0),
369
219
            )
370
 
        self._pack_collection = pack_collection
371
 
        # When we make readonly indices, we need this.
372
 
        self.index_class = pack_collection._index_class
373
220
        # where should the new pack be opened
374
 
        self.upload_transport = pack_collection._upload_transport
 
221
        self.upload_transport = upload_transport
375
222
        # where are indices written out to
376
 
        self.index_transport = pack_collection._index_transport
 
223
        self.index_transport = index_transport
377
224
        # where is the pack renamed to when it is finished?
378
 
        self.pack_transport = pack_collection._pack_transport
379
 
        # What file mode to upload the pack and indices with.
380
 
        self._file_mode = file_mode
 
225
        self.pack_transport = pack_transport
381
226
        # tracks the content written to the .pack file.
382
 
        self._hash = osutils.md5()
383
 
        # a tuple with the length in bytes of the indices, once the pack
384
 
        # is finalised. (rev, inv, text, sigs, chk_if_in_use)
 
227
        self._hash = md5.new()
 
228
        # a four-tuple with the length in bytes of the indices, once the pack
 
229
        # is finalised. (rev, inv, text, sigs)
385
230
        self.index_sizes = None
386
231
        # How much data to cache when writing packs. Note that this is not
387
232
        # synchronised with reads, because it's not in the transport layer, so
389
234
        # under creation.
390
235
        self._cache_limit = 0
391
236
        # the temporary pack file name.
392
 
        self.random_name = osutils.rand_chars(20) + upload_suffix
 
237
        self.random_name = rand_chars(20) + upload_suffix
393
238
        # when was this pack started ?
394
239
        self.start_time = time.time()
395
240
        # open an output stream for the data added to the pack.
396
241
        self.write_stream = self.upload_transport.open_write_stream(
397
 
            self.random_name, mode=self._file_mode)
 
242
            self.random_name)
398
243
        if 'pack' in debug.debug_flags:
399
244
            mutter('%s: create_pack: pack stream open: %s%s t+%6.3fs',
400
245
                time.ctime(), self.upload_transport.base, self.random_name,
401
246
                time.time() - self.start_time)
402
 
        # A list of byte sequences to be written to the new pack, and the
403
 
        # aggregate size of them.  Stored as a list rather than separate
 
247
        # A list of byte sequences to be written to the new pack, and the 
 
248
        # aggregate size of them.  Stored as a list rather than separate 
404
249
        # variables so that the _write_data closure below can update them.
405
250
        self._buffer = [[], 0]
406
 
        # create a callable for adding data
 
251
        # create a callable for adding data 
407
252
        #
408
253
        # robertc says- this is a closure rather than a method on the object
409
254
        # so that the variables are locals, and faster than accessing object
425
270
        self._writer.begin()
426
271
        # what state is the pack in? (open, finished, aborted)
427
272
        self._state = 'open'
428
 
        # no name until we finish writing the content
429
 
        self.name = None
430
273
 
431
274
    def abort(self):
432
275
        """Cancel creating this pack."""
438
281
 
439
282
    def access_tuple(self):
440
283
        """Return a tuple (transport, name) for the pack content."""
 
284
        assert self._state in ('open', 'finished')
441
285
        if self._state == 'finished':
442
286
            return Pack.access_tuple(self)
443
 
        elif self._state == 'open':
 
287
        else:
444
288
            return self.upload_transport, self.random_name
445
 
        else:
446
 
            raise AssertionError(self._state)
447
289
 
448
290
    def data_inserted(self):
449
291
        """True if data has been added to this pack."""
450
292
        return bool(self.get_revision_count() or
451
293
            self.inventory_index.key_count() or
452
294
            self.text_index.key_count() or
453
 
            self.signature_index.key_count() or
454
 
            (self.chk_index is not None and self.chk_index.key_count()))
455
 
 
456
 
    def finish_content(self):
457
 
        if self.name is not None:
458
 
            return
459
 
        self._writer.end()
460
 
        if self._buffer[1]:
461
 
            self._write_data('', flush=True)
462
 
        self.name = self._hash.hexdigest()
463
 
 
464
 
    def finish(self, suspend=False):
 
295
            self.signature_index.key_count())
 
296
 
 
297
    def finish(self):
465
298
        """Finish the new pack.
466
299
 
467
300
        This:
472
305
         - stores the index size tuple for the pack in the index_sizes
473
306
           attribute.
474
307
        """
475
 
        self.finish_content()
476
 
        if not suspend:
477
 
            self._check_references()
 
308
        self._writer.end()
 
309
        if self._buffer[1]:
 
310
            self._write_data('', flush=True)
 
311
        self.name = self._hash.hexdigest()
478
312
        # write indices
479
313
        # XXX: It'd be better to write them all to temporary names, then
480
314
        # rename them all into place, so that the window when only some are
481
315
        # visible is smaller.  On the other hand none will be seen until
482
316
        # they're in the names list.
483
317
        self.index_sizes = [None, None, None, None]
484
 
        self._write_index('revision', self.revision_index, 'revision',
485
 
            suspend)
486
 
        self._write_index('inventory', self.inventory_index, 'inventory',
487
 
            suspend)
488
 
        self._write_index('text', self.text_index, 'file texts', suspend)
 
318
        self._write_index('revision', self.revision_index, 'revision')
 
319
        self._write_index('inventory', self.inventory_index, 'inventory')
 
320
        self._write_index('text', self.text_index, 'file texts')
489
321
        self._write_index('signature', self.signature_index,
490
 
            'revision signatures', suspend)
491
 
        if self.chk_index is not None:
492
 
            self.index_sizes.append(None)
493
 
            self._write_index('chk', self.chk_index,
494
 
                'content hash bytes', suspend)
495
 
        self.write_stream.close(
496
 
            want_fdatasync=self._pack_collection.config_stack.get('repository.fdatasync'))
 
322
            'revision signatures')
 
323
        self.write_stream.close()
497
324
        # Note that this will clobber an existing pack with the same name,
498
325
        # without checking for hash collisions. While this is undesirable this
499
326
        # is something that can be rectified in a subsequent release. One way
505
332
        #  - try for HASH.pack
506
333
        #  - try for temporary-name
507
334
        #  - refresh the pack-list to see if the pack is now absent
508
 
        new_name = self.name + '.pack'
509
 
        if not suspend:
510
 
            new_name = '../packs/' + new_name
511
 
        self.upload_transport.move(self.random_name, new_name)
 
335
        self.upload_transport.rename(self.random_name,
 
336
                '../packs/' + self.name + '.pack')
512
337
        self._state = 'finished'
513
338
        if 'pack' in debug.debug_flags:
514
339
            # XXX: size might be interesting?
515
 
            mutter('%s: create_pack: pack finished: %s%s->%s t+%6.3fs',
 
340
            mutter('%s: create_pack: pack renamed into place: %s%s->%s%s t+%6.3fs',
516
341
                time.ctime(), self.upload_transport.base, self.random_name,
517
 
                new_name, time.time() - self.start_time)
518
 
 
519
 
    def flush(self):
520
 
        """Flush any current data."""
521
 
        if self._buffer[1]:
522
 
            bytes = ''.join(self._buffer[0])
523
 
            self.write_stream.write(bytes)
524
 
            self._hash.update(bytes)
525
 
            self._buffer[:] = [[], 0]
526
 
 
527
 
    def _get_external_refs(self, index):
528
 
        return index._external_references()
 
342
                self.pack_transport, self.name,
 
343
                time.time() - self.start_time)
 
344
 
 
345
    def index_name(self, index_type, name):
 
346
        """Get the disk name of an index type for pack name 'name'."""
 
347
        return name + NewPack.index_definitions[index_type][0]
 
348
 
 
349
    def index_offset(self, index_type):
 
350
        """Get the position in a index_size array for a given index type."""
 
351
        return NewPack.index_definitions[index_type][1]
 
352
 
 
353
    def _replace_index_with_readonly(self, index_type):
 
354
        setattr(self, index_type + '_index',
 
355
            GraphIndex(self.index_transport,
 
356
                self.index_name(index_type, self.name),
 
357
                self.index_sizes[self.index_offset(index_type)]))
529
358
 
530
359
    def set_write_cache_size(self, size):
531
360
        self._cache_limit = size
532
361
 
533
 
    def _write_index(self, index_type, index, label, suspend=False):
 
362
    def _write_index(self, index_type, index, label):
534
363
        """Write out an index.
535
364
 
536
365
        :param index_type: The type of index to write - e.g. 'revision'.
538
367
        :param label: What label to give the index e.g. 'revision'.
539
368
        """
540
369
        index_name = self.index_name(index_type, self.name)
541
 
        if suspend:
542
 
            transport = self.upload_transport
543
 
        else:
544
 
            transport = self.index_transport
545
 
        index_tempfile = index.finish()
546
 
        index_bytes = index_tempfile.read()
547
 
        write_stream = transport.open_write_stream(index_name,
548
 
            mode=self._file_mode)
549
 
        write_stream.write(index_bytes)
550
 
        write_stream.close(
551
 
            want_fdatasync=self._pack_collection.config_stack.get('repository.fdatasync'))
552
 
        self.index_sizes[self.index_offset(index_type)] = len(index_bytes)
 
370
        self.index_sizes[self.index_offset(index_type)] = \
 
371
            self.index_transport.put_file(index_name, index.finish())
553
372
        if 'pack' in debug.debug_flags:
554
373
            # XXX: size might be interesting?
555
374
            mutter('%s: create_pack: wrote %s index: %s%s t+%6.3fs',
556
375
                time.ctime(), label, self.upload_transport.base,
557
376
                self.random_name, time.time() - self.start_time)
558
 
        # Replace the writable index on this object with a readonly,
 
377
        # Replace the writable index on this object with a readonly, 
559
378
        # presently unloaded index. We should alter
560
379
        # the index layer to make its finish() error if add_node is
561
380
        # subsequently used. RBC
570
389
    such as 'revision index'.
571
390
 
572
391
    A CombinedIndex provides an index on a single key space built up
573
 
    from several on-disk indices.  The AggregateIndex builds on this
 
392
    from several on-disk indices.  The AggregateIndex builds on this 
574
393
    to provide a knit access layer, and allows having up to one writable
575
394
    index within the collection.
576
395
    """
577
396
    # XXX: Probably 'can be written to' could/should be separated from 'acts
578
397
    # like a knit index' -- mbp 20071024
579
398
 
580
 
    def __init__(self, reload_func=None, flush_func=None):
581
 
        """Create an AggregateIndex.
582
 
 
583
 
        :param reload_func: A function to call if we find we are missing an
584
 
            index. Should have the form reload_func() => True if the list of
585
 
            active pack files has changed.
586
 
        """
587
 
        self._reload_func = reload_func
 
399
    def __init__(self):
 
400
        """Create an AggregateIndex."""
588
401
        self.index_to_pack = {}
589
 
        self.combined_index = CombinedGraphIndex([], reload_func=reload_func)
590
 
        self.data_access = _DirectPackAccess(self.index_to_pack,
591
 
                                             reload_func=reload_func,
592
 
                                             flush_func=flush_func)
 
402
        self.combined_index = CombinedGraphIndex([])
 
403
        self.knit_access = _PackAccess(self.index_to_pack)
 
404
 
 
405
    def replace_indices(self, index_to_pack, indices):
 
406
        """Replace the current mappings with fresh ones.
 
407
 
 
408
        This should probably not be used eventually, rather incremental add and
 
409
        removal of indices. It has been added during refactoring of existing
 
410
        code.
 
411
 
 
412
        :param index_to_pack: A mapping from index objects to
 
413
            (transport, name) tuples for the pack file data.
 
414
        :param indices: A list of indices.
 
415
        """
 
416
        # refresh the revision pack map dict without replacing the instance.
 
417
        self.index_to_pack.clear()
 
418
        self.index_to_pack.update(index_to_pack)
 
419
        # XXX: API break - clearly a 'replace' method would be good?
 
420
        self.combined_index._indices[:] = indices
 
421
        # the current add nodes callback for the current writable index if
 
422
        # there is one.
593
423
        self.add_callback = None
594
424
 
595
425
    def add_index(self, index, pack):
597
427
 
598
428
        Future searches on the aggregate index will seach this new index
599
429
        before all previously inserted indices.
600
 
 
 
430
        
601
431
        :param index: An Index for the pack.
602
432
        :param pack: A Pack instance.
603
433
        """
604
434
        # expose it to the index map
605
435
        self.index_to_pack[index] = pack.access_tuple()
606
436
        # put it at the front of the linear index list
607
 
        self.combined_index.insert_index(0, index, pack.name)
 
437
        self.combined_index.insert_index(0, index)
608
438
 
609
439
    def add_writable_index(self, index, pack):
610
440
        """Add an index which is able to have data added to it.
611
441
 
612
442
        There can be at most one writable index at any time.  Any
613
443
        modifications made to the knit are put into this index.
614
 
 
 
444
        
615
445
        :param index: An index from the pack parameter.
616
446
        :param pack: A Pack instance.
617
447
        """
618
 
        if self.add_callback is not None:
619
 
            raise AssertionError(
620
 
                "%s already has a writable index through %s" % \
621
 
                (self, self.add_callback))
 
448
        assert self.add_callback is None, \
 
449
            "%s already has a writable index through %s" % \
 
450
            (self, self.add_callback)
622
451
        # allow writing: queue writes to a new index
623
452
        self.add_index(index, pack)
624
453
        # Updates the index to packs mapping as a side effect,
625
 
        self.data_access.set_writer(pack._writer, index, pack.access_tuple())
 
454
        self.knit_access.set_writer(pack._writer, index, pack.access_tuple())
626
455
        self.add_callback = index.add_nodes
627
456
 
628
457
    def clear(self):
629
458
        """Reset all the aggregate data to nothing."""
630
 
        self.data_access.set_writer(None, None, (None, None))
 
459
        self.knit_access.set_writer(None, None, (None, None))
631
460
        self.index_to_pack.clear()
632
461
        del self.combined_index._indices[:]
633
 
        del self.combined_index._index_names[:]
634
462
        self.add_callback = None
635
463
 
636
 
    def remove_index(self, index):
 
464
    def remove_index(self, index, pack):
637
465
        """Remove index from the indices used to answer queries.
638
 
 
 
466
        
639
467
        :param index: An index from the pack parameter.
 
468
        :param pack: A Pack instance.
640
469
        """
641
470
        del self.index_to_pack[index]
642
 
        pos = self.combined_index._indices.index(index)
643
 
        del self.combined_index._indices[pos]
644
 
        del self.combined_index._index_names[pos]
 
471
        self.combined_index._indices.remove(index)
645
472
        if (self.add_callback is not None and
646
473
            getattr(index, 'add_nodes', None) == self.add_callback):
647
474
            self.add_callback = None
648
 
            self.data_access.set_writer(None, None, (None, None))
 
475
            self.knit_access.set_writer(None, None, (None, None))
649
476
 
650
477
 
651
478
class Packer(object):
652
479
    """Create a pack from packs."""
653
480
 
654
 
    def __init__(self, pack_collection, packs, suffix, revision_ids=None,
655
 
                 reload_func=None):
 
481
    def __init__(self, pack_collection, packs, suffix, revision_ids=None):
656
482
        """Create a Packer.
657
483
 
658
484
        :param pack_collection: A RepositoryPackCollection object where the
660
486
        :param packs: The packs to combine.
661
487
        :param suffix: The suffix to use on the temporary files for the pack.
662
488
        :param revision_ids: Revision ids to limit the pack to.
663
 
        :param reload_func: A function to call if a pack file/index goes
664
 
            missing. The side effect of calling this function should be to
665
 
            update self.packs. See also AggregateIndex
666
489
        """
667
490
        self.packs = packs
668
491
        self.suffix = suffix
669
492
        self.revision_ids = revision_ids
670
 
        # The pack object we are creating.
671
 
        self.new_pack = None
672
493
        self._pack_collection = pack_collection
673
 
        self._reload_func = reload_func
674
 
        # The index layer keys for the revisions being copied. None for 'all
675
 
        # objects'.
676
 
        self._revision_keys = None
677
 
        # What text keys to copy. None for 'all texts'. This is set by
678
 
        # _copy_inventory_texts
679
 
        self._text_filter = None
680
494
 
681
495
    def pack(self, pb=None):
682
496
        """Create a new pack by reading data from other packs.
684
498
        This does little more than a bulk copy of data. One key difference
685
499
        is that data with the same item key across multiple packs is elided
686
500
        from the output. The new pack is written into the current pack store
687
 
        along with its indices, and the name added to the pack names. The
 
501
        along with its indices, and the name added to the pack names. The 
688
502
        source packs are not altered and are not required to be in the current
689
503
        pack collection.
690
504
 
693
507
        :return: A Pack object, or None if nothing was copied.
694
508
        """
695
509
        # open a pack - using the same name as the last temporary file
696
 
        # - which has already been flushed, so it's safe.
 
510
        # - which has already been flushed, so its safe.
697
511
        # XXX: - duplicate code warning with start_write_group; fix before
698
512
        #      considering 'done'.
699
513
        if self._pack_collection._new_pack is not None:
700
 
            raise errors.BzrError('call to %s.pack() while another pack is'
701
 
                                  ' being written.'
702
 
                                  % (self.__class__.__name__,))
 
514
            raise errors.BzrError('call to create_pack_from_packs while '
 
515
                'another pack is being written.')
703
516
        if self.revision_ids is not None:
704
517
            if len(self.revision_ids) == 0:
705
518
                # silly fetch request.
706
519
                return None
707
520
            else:
708
521
                self.revision_ids = frozenset(self.revision_ids)
709
 
                self.revision_keys = frozenset((revid,) for revid in
710
 
                    self.revision_ids)
711
522
        if pb is None:
712
523
            self.pb = ui.ui_factory.nested_progress_bar()
713
524
        else:
720
531
 
721
532
    def open_pack(self):
722
533
        """Open a pack for the pack we are creating."""
723
 
        new_pack = self._pack_collection.pack_factory(self._pack_collection,
724
 
                upload_suffix=self.suffix,
725
 
                file_mode=self._pack_collection.repo.bzrdir._get_file_mode())
726
 
        # We know that we will process all nodes in order, and don't need to
727
 
        # query, so don't combine any indices spilled to disk until we are done
728
 
        new_pack.revision_index.set_optimize(combine_backing_indices=False)
729
 
        new_pack.inventory_index.set_optimize(combine_backing_indices=False)
730
 
        new_pack.text_index.set_optimize(combine_backing_indices=False)
731
 
        new_pack.signature_index.set_optimize(combine_backing_indices=False)
732
 
        return new_pack
733
 
 
734
 
    def _copy_revision_texts(self):
735
 
        """Copy revision data to the new pack."""
736
 
        raise NotImplementedError(self._copy_revision_texts)
737
 
 
738
 
    def _copy_inventory_texts(self):
739
 
        """Copy the inventory texts to the new pack.
740
 
 
741
 
        self._revision_keys is used to determine what inventories to copy.
742
 
 
743
 
        Sets self._text_filter appropriately.
744
 
        """
745
 
        raise NotImplementedError(self._copy_inventory_texts)
746
 
 
747
 
    def _copy_text_texts(self):
748
 
        raise NotImplementedError(self._copy_text_texts)
 
534
        return NewPack(self._pack_collection._upload_transport,
 
535
            self._pack_collection._index_transport,
 
536
            self._pack_collection._pack_transport, upload_suffix=self.suffix)
749
537
 
750
538
    def _create_pack_from_packs(self):
751
 
        raise NotImplementedError(self._create_pack_from_packs)
 
539
        self.pb.update("Opening pack", 0, 5)
 
540
        new_pack = self.open_pack()
 
541
        # buffer data - we won't be reading-back during the pack creation and
 
542
        # this makes a significant difference on sftp pushes.
 
543
        new_pack.set_write_cache_size(1024*1024)
 
544
        if 'pack' in debug.debug_flags:
 
545
            plain_pack_list = ['%s%s' % (a_pack.pack_transport.base, a_pack.name)
 
546
                for a_pack in self.packs]
 
547
            if self.revision_ids is not None:
 
548
                rev_count = len(self.revision_ids)
 
549
            else:
 
550
                rev_count = 'all'
 
551
            mutter('%s: create_pack: creating pack from source packs: '
 
552
                '%s%s %s revisions wanted %s t=0',
 
553
                time.ctime(), self._pack_collection._upload_transport.base, new_pack.random_name,
 
554
                plain_pack_list, rev_count)
 
555
        # select revisions
 
556
        if self.revision_ids:
 
557
            revision_keys = [(revision_id,) for revision_id in self.revision_ids]
 
558
        else:
 
559
            revision_keys = None
752
560
 
753
 
    def _log_copied_texts(self):
 
561
        # select revision keys
 
562
        revision_index_map = self._pack_collection._packs_list_to_pack_map_and_index_list(
 
563
            self.packs, 'revision_index')[0]
 
564
        revision_nodes = self._pack_collection._index_contents(revision_index_map, revision_keys)
 
565
        # copy revision keys and adjust values
 
566
        self.pb.update("Copying revision texts", 1)
 
567
        list(self._copy_nodes_graph(revision_nodes, revision_index_map,
 
568
            new_pack._writer, new_pack.revision_index))
 
569
        if 'pack' in debug.debug_flags:
 
570
            mutter('%s: create_pack: revisions copied: %s%s %d items t+%6.3fs',
 
571
                time.ctime(), self._pack_collection._upload_transport.base, new_pack.random_name,
 
572
                new_pack.revision_index.key_count(),
 
573
                time.time() - new_pack.start_time)
 
574
        # select inventory keys
 
575
        inv_keys = revision_keys # currently the same keyspace, and note that
 
576
        # querying for keys here could introduce a bug where an inventory item
 
577
        # is missed, so do not change it to query separately without cross
 
578
        # checking like the text key check below.
 
579
        inventory_index_map = self._pack_collection._packs_list_to_pack_map_and_index_list(
 
580
            self.packs, 'inventory_index')[0]
 
581
        inv_nodes = self._pack_collection._index_contents(inventory_index_map, inv_keys)
 
582
        # copy inventory keys and adjust values
 
583
        # XXX: Should be a helper function to allow different inv representation
 
584
        # at this point.
 
585
        self.pb.update("Copying inventory texts", 2)
 
586
        inv_lines = self._copy_nodes_graph(inv_nodes, inventory_index_map,
 
587
            new_pack._writer, new_pack.inventory_index, output_lines=True)
 
588
        if self.revision_ids:
 
589
            fileid_revisions = self._pack_collection.repo._find_file_ids_from_xml_inventory_lines(
 
590
                inv_lines, self.revision_ids)
 
591
            text_filter = []
 
592
            for fileid, file_revids in fileid_revisions.iteritems():
 
593
                text_filter.extend(
 
594
                    [(fileid, file_revid) for file_revid in file_revids])
 
595
        else:
 
596
            # eat the iterator to cause it to execute.
 
597
            list(inv_lines)
 
598
            text_filter = None
 
599
        if 'pack' in debug.debug_flags:
 
600
            mutter('%s: create_pack: inventories copied: %s%s %d items t+%6.3fs',
 
601
                time.ctime(), self._pack_collection._upload_transport.base, new_pack.random_name,
 
602
                new_pack.inventory_index.key_count(),
 
603
                time.time() - new_pack.start_time)
 
604
        # select text keys
 
605
        text_index_map = self._pack_collection._packs_list_to_pack_map_and_index_list(
 
606
            self.packs, 'text_index')[0]
 
607
        text_nodes = self._pack_collection._index_contents(text_index_map, text_filter)
 
608
        if text_filter is not None:
 
609
            # We could return the keys copied as part of the return value from
 
610
            # _copy_nodes_graph but this doesn't work all that well with the
 
611
            # need to get line output too, so we check separately, and as we're
 
612
            # going to buffer everything anyway, we check beforehand, which
 
613
            # saves reading knit data over the wire when we know there are
 
614
            # mising records.
 
615
            text_nodes = set(text_nodes)
 
616
            present_text_keys = set(_node[1] for _node in text_nodes)
 
617
            missing_text_keys = set(text_filter) - present_text_keys
 
618
            if missing_text_keys:
 
619
                # TODO: raise a specific error that can handle many missing
 
620
                # keys.
 
621
                a_missing_key = missing_text_keys.pop()
 
622
                raise errors.RevisionNotPresent(a_missing_key[1],
 
623
                    a_missing_key[0])
 
624
        # copy text keys and adjust values
 
625
        self.pb.update("Copying content texts", 3)
 
626
        list(self._copy_nodes_graph(text_nodes, text_index_map,
 
627
            new_pack._writer, new_pack.text_index))
754
628
        if 'pack' in debug.debug_flags:
755
629
            mutter('%s: create_pack: file texts copied: %s%s %d items t+%6.3fs',
756
 
                time.ctime(), self._pack_collection._upload_transport.base,
757
 
                self.new_pack.random_name,
758
 
                self.new_pack.text_index.key_count(),
759
 
                time.time() - self.new_pack.start_time)
760
 
 
761
 
    def _use_pack(self, new_pack):
762
 
        """Return True if new_pack should be used.
763
 
 
764
 
        :param new_pack: The pack that has just been created.
765
 
        :return: True if the pack should be used.
 
630
                time.ctime(), self._pack_collection._upload_transport.base, new_pack.random_name,
 
631
                new_pack.text_index.key_count(),
 
632
                time.time() - new_pack.start_time)
 
633
        # select signature keys
 
634
        signature_filter = revision_keys # same keyspace
 
635
        signature_index_map = self._pack_collection._packs_list_to_pack_map_and_index_list(
 
636
            self.packs, 'signature_index')[0]
 
637
        signature_nodes = self._pack_collection._index_contents(signature_index_map,
 
638
            signature_filter)
 
639
        # copy signature keys and adjust values
 
640
        self.pb.update("Copying signature texts", 4)
 
641
        self._copy_nodes(signature_nodes, signature_index_map, new_pack._writer,
 
642
            new_pack.signature_index)
 
643
        if 'pack' in debug.debug_flags:
 
644
            mutter('%s: create_pack: revision signatures copied: %s%s %d items t+%6.3fs',
 
645
                time.ctime(), self._pack_collection._upload_transport.base, new_pack.random_name,
 
646
                new_pack.signature_index.key_count(),
 
647
                time.time() - new_pack.start_time)
 
648
        if not new_pack.data_inserted():
 
649
            new_pack.abort()
 
650
            return None
 
651
        self.pb.update("Finishing pack", 5)
 
652
        new_pack.finish()
 
653
        self._pack_collection.allocate(new_pack)
 
654
        return new_pack
 
655
 
 
656
    def _copy_nodes(self, nodes, index_map, writer, write_index):
 
657
        """Copy knit nodes between packs with no graph references."""
 
658
        pb = ui.ui_factory.nested_progress_bar()
 
659
        try:
 
660
            return self._do_copy_nodes(nodes, index_map, writer,
 
661
                write_index, pb)
 
662
        finally:
 
663
            pb.finished()
 
664
 
 
665
    def _do_copy_nodes(self, nodes, index_map, writer, write_index, pb):
 
666
        # for record verification
 
667
        knit_data = _KnitData(None)
 
668
        # plan a readv on each source pack:
 
669
        # group by pack
 
670
        nodes = sorted(nodes)
 
671
        # how to map this into knit.py - or knit.py into this?
 
672
        # we don't want the typical knit logic, we want grouping by pack
 
673
        # at this point - perhaps a helper library for the following code 
 
674
        # duplication points?
 
675
        request_groups = {}
 
676
        for index, key, value in nodes:
 
677
            if index not in request_groups:
 
678
                request_groups[index] = []
 
679
            request_groups[index].append((key, value))
 
680
        record_index = 0
 
681
        pb.update("Copied record", record_index, len(nodes))
 
682
        for index, items in request_groups.iteritems():
 
683
            pack_readv_requests = []
 
684
            for key, value in items:
 
685
                # ---- KnitGraphIndex.get_position
 
686
                bits = value[1:].split(' ')
 
687
                offset, length = int(bits[0]), int(bits[1])
 
688
                pack_readv_requests.append((offset, length, (key, value[0])))
 
689
            # linear scan up the pack
 
690
            pack_readv_requests.sort()
 
691
            # copy the data
 
692
            transport, path = index_map[index]
 
693
            reader = pack.make_readv_reader(transport, path,
 
694
                [offset[0:2] for offset in pack_readv_requests])
 
695
            for (names, read_func), (_1, _2, (key, eol_flag)) in \
 
696
                izip(reader.iter_records(), pack_readv_requests):
 
697
                raw_data = read_func(None)
 
698
                # check the header only
 
699
                df, _ = knit_data._parse_record_header(key[-1], raw_data)
 
700
                df.close()
 
701
                pos, size = writer.add_bytes_record(raw_data, names)
 
702
                write_index.add_node(key, eol_flag + "%d %d" % (pos, size))
 
703
                pb.update("Copied record", record_index)
 
704
                record_index += 1
 
705
 
 
706
    def _copy_nodes_graph(self, nodes, index_map, writer, write_index,
 
707
        output_lines=False):
 
708
        """Copy knit nodes between packs.
 
709
 
 
710
        :param output_lines: Return lines present in the copied data as
 
711
            an iterator of line,version_id.
766
712
        """
767
 
        return new_pack.data_inserted()
 
713
        pb = ui.ui_factory.nested_progress_bar()
 
714
        try:
 
715
            return self._do_copy_nodes_graph(nodes, index_map, writer,
 
716
                write_index, output_lines, pb)
 
717
        finally:
 
718
            pb.finished()
 
719
 
 
720
    def _do_copy_nodes_graph(self, nodes, index_map, writer, write_index,
 
721
        output_lines, pb):
 
722
        # for record verification
 
723
        knit_data = _KnitData(None)
 
724
        # for line extraction when requested (inventories only)
 
725
        if output_lines:
 
726
            factory = knit.KnitPlainFactory()
 
727
        # plan a readv on each source pack:
 
728
        # group by pack
 
729
        nodes = sorted(nodes)
 
730
        # how to map this into knit.py - or knit.py into this?
 
731
        # we don't want the typical knit logic, we want grouping by pack
 
732
        # at this point - perhaps a helper library for the following code 
 
733
        # duplication points?
 
734
        request_groups = {}
 
735
        record_index = 0
 
736
        pb.update("Copied record", record_index, len(nodes))
 
737
        for index, key, value, references in nodes:
 
738
            if index not in request_groups:
 
739
                request_groups[index] = []
 
740
            request_groups[index].append((key, value, references))
 
741
        for index, items in request_groups.iteritems():
 
742
            pack_readv_requests = []
 
743
            for key, value, references in items:
 
744
                # ---- KnitGraphIndex.get_position
 
745
                bits = value[1:].split(' ')
 
746
                offset, length = int(bits[0]), int(bits[1])
 
747
                pack_readv_requests.append((offset, length, (key, value[0], references)))
 
748
            # linear scan up the pack
 
749
            pack_readv_requests.sort()
 
750
            # copy the data
 
751
            transport, path = index_map[index]
 
752
            reader = pack.make_readv_reader(transport, path,
 
753
                [offset[0:2] for offset in pack_readv_requests])
 
754
            for (names, read_func), (_1, _2, (key, eol_flag, references)) in \
 
755
                izip(reader.iter_records(), pack_readv_requests):
 
756
                raw_data = read_func(None)
 
757
                version_id = key[-1]
 
758
                if output_lines:
 
759
                    # read the entire thing
 
760
                    content, _ = knit_data._parse_record(version_id, raw_data)
 
761
                    if len(references[-1]) == 0:
 
762
                        line_iterator = factory.get_fulltext_content(content)
 
763
                    else:
 
764
                        line_iterator = factory.get_linedelta_content(content)
 
765
                    for line in line_iterator:
 
766
                        yield line, version_id
 
767
                else:
 
768
                    # check the header only
 
769
                    df, _ = knit_data._parse_record_header(version_id, raw_data)
 
770
                    df.close()
 
771
                pos, size = writer.add_bytes_record(raw_data, names)
 
772
                write_index.add_node(key, eol_flag + "%d %d" % (pos, size), references)
 
773
                pb.update("Copied record", record_index)
 
774
                record_index += 1
 
775
 
 
776
 
 
777
class ReconcilePacker(Packer):
 
778
    """A packer which regenerates indices etc as it copies.
 
779
    
 
780
    This is used by ``bzr reconcile`` to cause parent text pointers to be
 
781
    regenerated.
 
782
    """
768
783
 
769
784
 
770
785
class RepositoryPackCollection(object):
771
 
    """Management of packs within a repository.
772
 
 
773
 
    :ivar _names: map of {pack_name: (index_size,)}
774
 
    """
775
 
 
776
 
    pack_factory = None
777
 
    resumed_pack_factory = None
778
 
    normal_packer_class = None
779
 
    optimising_packer_class = None
 
786
    """Management of packs within a repository."""
780
787
 
781
788
    def __init__(self, repo, transport, index_transport, upload_transport,
782
 
                 pack_transport, index_builder_class, index_class,
783
 
                 use_chk_index):
 
789
                 pack_transport):
784
790
        """Create a new RepositoryPackCollection.
785
791
 
786
 
        :param transport: Addresses the repository base directory
 
792
        :param transport: Addresses the repository base directory 
787
793
            (typically .bzr/repository/).
788
794
        :param index_transport: Addresses the directory containing indices.
789
795
        :param upload_transport: Addresses the directory into which packs are written
790
796
            while they're being created.
791
797
        :param pack_transport: Addresses the directory of existing complete packs.
792
 
        :param index_builder_class: The index builder class to use.
793
 
        :param index_class: The index class to use.
794
 
        :param use_chk_index: Whether to setup and manage a CHK index.
795
798
        """
796
 
        # XXX: This should call self.reset()
797
799
        self.repo = repo
798
800
        self.transport = transport
799
801
        self._index_transport = index_transport
800
802
        self._upload_transport = upload_transport
801
803
        self._pack_transport = pack_transport
802
 
        self._index_builder_class = index_builder_class
803
 
        self._index_class = index_class
804
 
        self._suffix_offsets = {'.rix': 0, '.iix': 1, '.tix': 2, '.six': 3,
805
 
            '.cix': 4}
 
804
        self._suffix_offsets = {'.rix': 0, '.iix': 1, '.tix': 2, '.six': 3}
806
805
        self.packs = []
807
806
        # name:Pack mapping
808
 
        self._names = None
809
807
        self._packs_by_name = {}
810
808
        # the previous pack-names content
811
809
        self._packs_at_load = None
812
810
        # when a pack is being created by this object, the state of that pack.
813
811
        self._new_pack = None
814
812
        # aggregated revision index data
815
 
        flush = self._flush_new_pack
816
 
        self.revision_index = AggregateIndex(self.reload_pack_names, flush)
817
 
        self.inventory_index = AggregateIndex(self.reload_pack_names, flush)
818
 
        self.text_index = AggregateIndex(self.reload_pack_names, flush)
819
 
        self.signature_index = AggregateIndex(self.reload_pack_names, flush)
820
 
        all_indices = [self.revision_index, self.inventory_index,
821
 
                self.text_index, self.signature_index]
822
 
        if use_chk_index:
823
 
            self.chk_index = AggregateIndex(self.reload_pack_names, flush)
824
 
            all_indices.append(self.chk_index)
825
 
        else:
826
 
            # used to determine if we're using a chk_index elsewhere.
827
 
            self.chk_index = None
828
 
        # Tell all the CombinedGraphIndex objects about each other, so they can
829
 
        # share hints about which pack names to search first.
830
 
        all_combined = [agg_idx.combined_index for agg_idx in all_indices]
831
 
        for combined_idx in all_combined:
832
 
            combined_idx.set_sibling_indices(
833
 
                set(all_combined).difference([combined_idx]))
834
 
        # resumed packs
835
 
        self._resumed_packs = []
836
 
        self.config_stack = config.LocationStack(self.transport.base)
837
 
 
838
 
    def __repr__(self):
839
 
        return '%s(%r)' % (self.__class__.__name__, self.repo)
 
813
        self.revision_index = AggregateIndex()
 
814
        self.inventory_index = AggregateIndex()
 
815
        self.text_index = AggregateIndex()
 
816
        self.signature_index = AggregateIndex()
840
817
 
841
818
    def add_pack_to_memory(self, pack):
842
819
        """Make a Pack object available to the repository to satisfy queries.
843
 
 
 
820
        
844
821
        :param pack: A Pack object.
845
822
        """
846
 
        if pack.name in self._packs_by_name:
847
 
            raise AssertionError(
848
 
                'pack %s already in _packs_by_name' % (pack.name,))
 
823
        assert pack.name not in self._packs_by_name
849
824
        self.packs.append(pack)
850
825
        self._packs_by_name[pack.name] = pack
851
826
        self.revision_index.add_index(pack.revision_index, pack)
852
827
        self.inventory_index.add_index(pack.inventory_index, pack)
853
828
        self.text_index.add_index(pack.text_index, pack)
854
829
        self.signature_index.add_index(pack.signature_index, pack)
855
 
        if self.chk_index is not None:
856
 
            self.chk_index.add_index(pack.chk_index, pack)
 
830
        
 
831
    def _add_text_to_weave(self, file_id, revision_id, new_lines, parents,
 
832
        nostore_sha, random_revid):
 
833
        file_id_index = GraphIndexPrefixAdapter(
 
834
            self.text_index.combined_index,
 
835
            (file_id, ), 1,
 
836
            add_nodes_callback=self.text_index.add_callback)
 
837
        self.repo._text_knit._index._graph_index = file_id_index
 
838
        self.repo._text_knit._index._add_callback = file_id_index.add_nodes
 
839
        return self.repo._text_knit.add_lines_with_ghosts(
 
840
            revision_id, parents, new_lines, nostore_sha=nostore_sha,
 
841
            random_id=random_revid, check_content=False)[0:2]
857
842
 
858
843
    def all_packs(self):
859
844
        """Return a list of all the Pack objects this repository has.
869
854
 
870
855
    def autopack(self):
871
856
        """Pack the pack collection incrementally.
872
 
 
 
857
        
873
858
        This will not attempt global reorganisation or recompression,
874
859
        rather it will just ensure that the total number of packs does
875
860
        not grow without bound. It uses the _max_pack_count method to
881
866
        in synchronisation with certain steps. Otherwise the names collection
882
867
        is not flushed.
883
868
 
884
 
        :return: Something evaluating true if packing took place.
 
869
        :return: True if packing took place.
885
870
        """
886
 
        while True:
887
 
            try:
888
 
                return self._do_autopack()
889
 
            except errors.RetryAutopack:
890
 
                # If we get a RetryAutopack exception, we should abort the
891
 
                # current action, and retry.
892
 
                pass
893
 
 
894
 
    def _do_autopack(self):
895
871
        # XXX: Should not be needed when the management of indices is sane.
896
872
        total_revisions = self.revision_index.combined_index.key_count()
897
873
        total_packs = len(self._names)
898
874
        if self._max_pack_count(total_revisions) >= total_packs:
899
 
            return None
 
875
            return False
 
876
        # XXX: the following may want to be a class, to pack with a given
 
877
        # policy.
 
878
        mutter('Auto-packing repository %s, which has %d pack files, '
 
879
            'containing %d revisions into %d packs.', self, total_packs,
 
880
            total_revisions, self._max_pack_count(total_revisions))
900
881
        # determine which packs need changing
901
882
        pack_distribution = self.pack_distribution(total_revisions)
902
883
        existing_packs = []
910
891
                # group their data with the relevant commit, and that may
911
892
                # involve rewriting ancient history - which autopack tries to
912
893
                # avoid. Alternatively we could not group the data but treat
913
 
                # each of these as having a single revision, and thus add
 
894
                # each of these as having a single revision, and thus add 
914
895
                # one revision for each to the total revision count, to get
915
896
                # a matching distribution.
916
897
                continue
917
898
            existing_packs.append((revision_count, pack))
918
899
        pack_operations = self.plan_autopack_combinations(
919
900
            existing_packs, pack_distribution)
920
 
        num_new_packs = len(pack_operations)
921
 
        num_old_packs = sum([len(po[1]) for po in pack_operations])
922
 
        num_revs_affected = sum([po[0] for po in pack_operations])
923
 
        mutter('Auto-packing repository %s, which has %d pack files, '
924
 
            'containing %d revisions. Packing %d files into %d affecting %d'
925
 
            ' revisions', self, total_packs, total_revisions, num_old_packs,
926
 
            num_new_packs, num_revs_affected)
927
 
        result = self._execute_pack_operations(pack_operations, packer_class=self.normal_packer_class,
928
 
                                      reload_func=self._restart_autopack)
929
 
        mutter('Auto-packing repository %s completed', self)
930
 
        return result
 
901
        self._execute_pack_operations(pack_operations)
 
902
        return True
931
903
 
932
 
    def _execute_pack_operations(self, pack_operations, packer_class,
933
 
            reload_func=None):
 
904
    def _execute_pack_operations(self, pack_operations):
934
905
        """Execute a series of pack operations.
935
906
 
936
907
        :param pack_operations: A list of [revision_count, packs_to_combine].
937
 
        :param packer_class: The class of packer to use
938
 
        :return: The new pack names.
 
908
        :return: None.
939
909
        """
940
910
        for revision_count, packs in pack_operations:
941
911
            # we may have no-ops from the setup logic
942
912
            if len(packs) == 0:
943
913
                continue
944
 
            packer = packer_class(self, packs, '.autopack',
945
 
                                   reload_func=reload_func)
946
 
            try:
947
 
                result = packer.pack()
948
 
            except errors.RetryWithNewPacks:
949
 
                # An exception is propagating out of this context, make sure
950
 
                # this packer has cleaned up. Packer() doesn't set its new_pack
951
 
                # state into the RepositoryPackCollection object, so we only
952
 
                # have access to it directly here.
953
 
                if packer.new_pack is not None:
954
 
                    packer.new_pack.abort()
955
 
                raise
956
 
            if result is None:
957
 
                return
 
914
            Packer(self, packs, '.autopack').pack()
958
915
            for pack in packs:
959
916
                self._remove_pack_from_memory(pack)
960
917
        # record the newly available packs and stop advertising the old
961
918
        # packs
962
 
        to_be_obsoleted = []
963
 
        for _, packs in pack_operations:
964
 
            to_be_obsoleted.extend(packs)
965
 
        result = self._save_pack_names(clear_obsolete_packs=True,
966
 
                                       obsolete_packs=to_be_obsoleted)
967
 
        return result
968
 
 
969
 
    def _flush_new_pack(self):
970
 
        if self._new_pack is not None:
971
 
            self._new_pack.flush()
 
919
        self._save_pack_names(clear_obsolete_packs=True)
 
920
        # Move the old packs out of the way now they are no longer referenced.
 
921
        for revision_count, packs in pack_operations:
 
922
            self._obsolete_packs(packs)
972
923
 
973
924
    def lock_names(self):
974
925
        """Acquire the mutex around the pack-names index.
975
 
 
 
926
        
976
927
        This cannot be used in the middle of a read-only transaction on the
977
928
        repository.
978
929
        """
979
930
        self.repo.control_files.lock_write()
980
931
 
981
 
    def _already_packed(self):
982
 
        """Is the collection already packed?"""
983
 
        return not (self.repo._format.pack_compresses or (len(self._names) > 1))
984
 
 
985
 
    def pack(self, hint=None, clean_obsolete_packs=False):
 
932
    def pack(self):
986
933
        """Pack the pack collection totally."""
987
934
        self.ensure_loaded()
988
935
        total_packs = len(self._names)
989
 
        if self._already_packed():
 
936
        if total_packs < 2:
990
937
            return
991
938
        total_revisions = self.revision_index.combined_index.key_count()
992
939
        # XXX: the following may want to be a class, to pack with a given
993
940
        # policy.
994
941
        mutter('Packing repository %s, which has %d pack files, '
995
 
            'containing %d revisions with hint %r.', self, total_packs,
996
 
            total_revisions, hint)
997
 
        while True:
998
 
            try:
999
 
                self._try_pack_operations(hint)
1000
 
            except RetryPackOperations:
1001
 
                continue
1002
 
            break
1003
 
 
1004
 
        if clean_obsolete_packs:
1005
 
            self._clear_obsolete_packs()
1006
 
 
1007
 
    def _try_pack_operations(self, hint):
1008
 
        """Calculate the pack operations based on the hint (if any), and
1009
 
        execute them.
1010
 
        """
 
942
            'containing %d revisions into 1 packs.', self, total_packs,
 
943
            total_revisions)
1011
944
        # determine which packs need changing
 
945
        pack_distribution = [1]
1012
946
        pack_operations = [[0, []]]
1013
947
        for pack in self.all_packs():
1014
 
            if hint is None or pack.name in hint:
1015
 
                # Either no hint was provided (so we are packing everything),
1016
 
                # or this pack was included in the hint.
1017
 
                pack_operations[-1][0] += pack.get_revision_count()
1018
 
                pack_operations[-1][1].append(pack)
1019
 
        self._execute_pack_operations(pack_operations,
1020
 
            packer_class=self.optimising_packer_class,
1021
 
            reload_func=self._restart_pack_operations)
 
948
            revision_count = pack.get_revision_count()
 
949
            pack_operations[-1][0] += revision_count
 
950
            pack_operations[-1][1].append(pack)
 
951
        self._execute_pack_operations(pack_operations)
1022
952
 
1023
953
    def plan_autopack_combinations(self, existing_packs, pack_distribution):
1024
954
        """Plan a pack operation.
1034
964
        pack_operations = [[0, []]]
1035
965
        # plan out what packs to keep, and what to reorganise
1036
966
        while len(existing_packs):
1037
 
            # take the largest pack, and if it's less than the head of the
1038
 
            # distribution chart we will include its contents in the new pack
1039
 
            # for that position. If it's larger, we remove its size from the
 
967
            # take the largest pack, and if its less than the head of the
 
968
            # distribution chart we will include its contents in the new pack for
 
969
            # that position. If its larger, we remove its size from the
1040
970
            # distribution chart
1041
971
            next_pack_rev_count, next_pack = existing_packs.pop(0)
1042
972
            if next_pack_rev_count >= pack_distribution[0]:
1059
989
                    # this pack is used up, shift left.
1060
990
                    del pack_distribution[0]
1061
991
                    pack_operations.append([0, []])
1062
 
        # Now that we know which pack files we want to move, shove them all
1063
 
        # into a single pack file.
1064
 
        final_rev_count = 0
1065
 
        final_pack_list = []
1066
 
        for num_revs, pack_files in pack_operations:
1067
 
            final_rev_count += num_revs
1068
 
            final_pack_list.extend(pack_files)
1069
 
        if len(final_pack_list) == 1:
1070
 
            raise AssertionError('We somehow generated an autopack with a'
1071
 
                ' single pack file being moved.')
1072
 
            return []
1073
 
        return [[final_rev_count, final_pack_list]]
 
992
        
 
993
        return pack_operations
1074
994
 
1075
995
    def ensure_loaded(self):
1076
 
        """Ensure we have read names from disk.
1077
 
 
1078
 
        :return: True if the disk names had not been previously read.
1079
 
        """
1080
 
        # NB: if you see an assertion error here, it's probably access against
 
996
        # NB: if you see an assertion error here, its probably access against
1081
997
        # an unlocked repo. Naughty.
1082
 
        if not self.repo.is_locked():
1083
 
            raise errors.ObjectNotLocked(self.repo)
 
998
        assert self.repo.is_locked()
1084
999
        if self._names is None:
1085
1000
            self._names = {}
1086
1001
            self._packs_at_load = set()
1088
1003
                name = key[0]
1089
1004
                self._names[name] = self._parse_index_sizes(value)
1090
1005
                self._packs_at_load.add((key, value))
1091
 
            result = True
1092
 
        else:
1093
 
            result = False
1094
1006
        # populate all the metadata.
1095
1007
        self.all_packs()
1096
 
        return result
1097
1008
 
1098
1009
    def _parse_index_sizes(self, value):
1099
1010
        """Parse a string of index sizes."""
1112
1023
            inv_index = self._make_index(name, '.iix')
1113
1024
            txt_index = self._make_index(name, '.tix')
1114
1025
            sig_index = self._make_index(name, '.six')
1115
 
            if self.chk_index is not None:
1116
 
                chk_index = self._make_index(name, '.cix', is_chk=True)
1117
 
            else:
1118
 
                chk_index = None
1119
1026
            result = ExistingPack(self._pack_transport, name, rev_index,
1120
 
                inv_index, txt_index, sig_index, chk_index)
 
1027
                inv_index, txt_index, sig_index)
1121
1028
            self.add_pack_to_memory(result)
1122
1029
            return result
1123
1030
 
1124
 
    def _resume_pack(self, name):
1125
 
        """Get a suspended Pack object by name.
1126
 
 
1127
 
        :param name: The name of the pack - e.g. '123456'
1128
 
        :return: A Pack object.
1129
 
        """
1130
 
        if not re.match('[a-f0-9]{32}', name):
1131
 
            # Tokens should be md5sums of the suspended pack file, i.e. 32 hex
1132
 
            # digits.
1133
 
            raise errors.UnresumableWriteGroup(
1134
 
                self.repo, [name], 'Malformed write group token')
1135
 
        try:
1136
 
            rev_index = self._make_index(name, '.rix', resume=True)
1137
 
            inv_index = self._make_index(name, '.iix', resume=True)
1138
 
            txt_index = self._make_index(name, '.tix', resume=True)
1139
 
            sig_index = self._make_index(name, '.six', resume=True)
1140
 
            if self.chk_index is not None:
1141
 
                chk_index = self._make_index(name, '.cix', resume=True,
1142
 
                                             is_chk=True)
1143
 
            else:
1144
 
                chk_index = None
1145
 
            result = self.resumed_pack_factory(name, rev_index, inv_index,
1146
 
                txt_index, sig_index, self._upload_transport,
1147
 
                self._pack_transport, self._index_transport, self,
1148
 
                chk_index=chk_index)
1149
 
        except errors.NoSuchFile, e:
1150
 
            raise errors.UnresumableWriteGroup(self.repo, [name], str(e))
1151
 
        self.add_pack_to_memory(result)
1152
 
        self._resumed_packs.append(result)
1153
 
        return result
1154
 
 
1155
1031
    def allocate(self, a_new_pack):
1156
1032
        """Allocate name in the list of packs.
1157
1033
 
1160
1036
        """
1161
1037
        self.ensure_loaded()
1162
1038
        if a_new_pack.name in self._names:
1163
 
            raise errors.BzrError(
1164
 
                'Pack %r already exists in %s' % (a_new_pack.name, self))
 
1039
            # a collision with the packs we know about (not the only possible
 
1040
            # collision, see NewPack.finish() for some discussion). Remove our
 
1041
            # prior reference to it.
 
1042
            self._remove_pack_from_memory(a_new_pack)
1165
1043
        self._names[a_new_pack.name] = tuple(a_new_pack.index_sizes)
1166
1044
        self.add_pack_to_memory(a_new_pack)
1167
1045
 
1168
1046
    def _iter_disk_pack_index(self):
1169
1047
        """Iterate over the contents of the pack-names index.
1170
 
 
 
1048
        
1171
1049
        This is used when loading the list from disk, and before writing to
1172
1050
        detect updates from others during our write operation.
1173
1051
        :return: An iterator of the index contents.
1174
1052
        """
1175
 
        return self._index_class(self.transport, 'pack-names', None
 
1053
        return GraphIndex(self.transport, 'pack-names', None
1176
1054
                ).iter_all_entries()
1177
1055
 
1178
 
    def _make_index(self, name, suffix, resume=False, is_chk=False):
 
1056
    def _make_index(self, name, suffix):
1179
1057
        size_offset = self._suffix_offsets[suffix]
1180
1058
        index_name = name + suffix
1181
 
        if resume:
1182
 
            transport = self._upload_transport
1183
 
            index_size = transport.stat(index_name).st_size
1184
 
        else:
1185
 
            transport = self._index_transport
1186
 
            index_size = self._names[name][size_offset]
1187
 
        index = self._index_class(transport, index_name, index_size,
1188
 
                                  unlimited_cache=is_chk)
1189
 
        if is_chk and self._index_class is btree_index.BTreeGraphIndex: 
1190
 
            index._leaf_factory = btree_index._gcchk_factory
1191
 
        return index
 
1059
        index_size = self._names[name][size_offset]
 
1060
        return GraphIndex(
 
1061
            self._index_transport, index_name, index_size)
1192
1062
 
1193
1063
    def _max_pack_count(self, total_revisions):
1194
1064
        """Return the maximum number of packs to use for total revisions.
1195
 
 
 
1065
        
1196
1066
        :param total_revisions: The total number of revisions in the
1197
1067
            repository.
1198
1068
        """
1222
1092
        :param return: None.
1223
1093
        """
1224
1094
        for pack in packs:
1225
 
            try:
1226
 
                try:
1227
 
                    pack.pack_transport.move(pack.file_name(),
1228
 
                        '../obsolete_packs/' + pack.file_name())
1229
 
                except errors.NoSuchFile:
1230
 
                    # perhaps obsolete_packs was removed? Let's create it and
1231
 
                    # try again
1232
 
                    try:
1233
 
                        pack.pack_transport.mkdir('../obsolete_packs/')
1234
 
                    except errors.FileExists:
1235
 
                        pass
1236
 
                    pack.pack_transport.move(pack.file_name(),
1237
 
                        '../obsolete_packs/' + pack.file_name())
1238
 
            except (errors.PathError, errors.TransportError), e:
1239
 
                # TODO: Should these be warnings or mutters?
1240
 
                mutter("couldn't rename obsolete pack, skipping it:\n%s"
1241
 
                       % (e,))
 
1095
            pack.pack_transport.rename(pack.file_name(),
 
1096
                '../obsolete_packs/' + pack.file_name())
1242
1097
            # TODO: Probably needs to know all possible indices for this pack
1243
1098
            # - or maybe list the directory and move all indices matching this
1244
1099
            # name whether we recognize it or not?
1245
 
            suffixes = ['.iix', '.six', '.tix', '.rix']
1246
 
            if self.chk_index is not None:
1247
 
                suffixes.append('.cix')
1248
 
            for suffix in suffixes:
1249
 
                try:
1250
 
                    self._index_transport.move(pack.name + suffix,
1251
 
                        '../obsolete_packs/' + pack.name + suffix)
1252
 
                except (errors.PathError, errors.TransportError), e:
1253
 
                    mutter("couldn't rename obsolete index, skipping it:\n%s"
1254
 
                           % (e,))
 
1100
            for suffix in ('.iix', '.six', '.tix', '.rix'):
 
1101
                self._index_transport.rename(pack.name + suffix,
 
1102
                    '../obsolete_packs/' + pack.name + suffix)
1255
1103
 
1256
1104
    def pack_distribution(self, total_revisions):
1257
1105
        """Generate a list of the number of revisions to put in each pack.
1275
1123
 
1276
1124
    def _remove_pack_from_memory(self, pack):
1277
1125
        """Remove pack from the packs accessed by this repository.
1278
 
 
 
1126
        
1279
1127
        Only affects memory state, until self._save_pack_names() is invoked.
1280
1128
        """
1281
1129
        self._names.pop(pack.name)
1282
1130
        self._packs_by_name.pop(pack.name)
1283
1131
        self._remove_pack_indices(pack)
1284
 
        self.packs.remove(pack)
1285
1132
 
1286
 
    def _remove_pack_indices(self, pack, ignore_missing=False):
1287
 
        """Remove the indices for pack from the aggregated indices.
1288
 
        
1289
 
        :param ignore_missing: Suppress KeyErrors from calling remove_index.
1290
 
        """
1291
 
        for index_type in Pack.index_definitions.keys():
1292
 
            attr_name = index_type + '_index'
1293
 
            aggregate_index = getattr(self, attr_name)
1294
 
            if aggregate_index is not None:
1295
 
                pack_index = getattr(pack, attr_name)
1296
 
                try:
1297
 
                    aggregate_index.remove_index(pack_index)
1298
 
                except KeyError:
1299
 
                    if ignore_missing:
1300
 
                        continue
1301
 
                    raise
 
1133
    def _remove_pack_indices(self, pack):
 
1134
        """Remove the indices for pack from the aggregated indices."""
 
1135
        self.revision_index.remove_index(pack.revision_index, pack)
 
1136
        self.inventory_index.remove_index(pack.inventory_index, pack)
 
1137
        self.text_index.remove_index(pack.text_index, pack)
 
1138
        self.signature_index.remove_index(pack.signature_index, pack)
1302
1139
 
1303
1140
    def reset(self):
1304
1141
        """Clear all cached data."""
1305
1142
        # cached revision data
 
1143
        self.repo._revision_knit = None
1306
1144
        self.revision_index.clear()
1307
1145
        # cached signature data
 
1146
        self.repo._signature_knit = None
1308
1147
        self.signature_index.clear()
1309
1148
        # cached file text data
1310
1149
        self.text_index.clear()
 
1150
        self.repo._text_knit = None
1311
1151
        # cached inventory data
1312
1152
        self.inventory_index.clear()
1313
 
        # cached chk data
1314
 
        if self.chk_index is not None:
1315
 
            self.chk_index.clear()
1316
1153
        # remove the open pack
1317
1154
        self._new_pack = None
1318
1155
        # information about packs.
1321
1158
        self._packs_by_name = {}
1322
1159
        self._packs_at_load = None
1323
1160
 
 
1161
    def _make_index_map(self, index_suffix):
 
1162
        """Return information on existing indices.
 
1163
 
 
1164
        :param suffix: Index suffix added to pack name.
 
1165
 
 
1166
        :returns: (pack_map, indices) where indices is a list of GraphIndex 
 
1167
        objects, and pack_map is a mapping from those objects to the 
 
1168
        pack tuple they describe.
 
1169
        """
 
1170
        # TODO: stop using this; it creates new indices unnecessarily.
 
1171
        self.ensure_loaded()
 
1172
        suffix_map = {'.rix': 'revision_index',
 
1173
            '.six': 'signature_index',
 
1174
            '.iix': 'inventory_index',
 
1175
            '.tix': 'text_index',
 
1176
        }
 
1177
        return self._packs_list_to_pack_map_and_index_list(self.all_packs(),
 
1178
            suffix_map[index_suffix])
 
1179
 
 
1180
    def _packs_list_to_pack_map_and_index_list(self, packs, index_attribute):
 
1181
        """Convert a list of packs to an index pack map and index list.
 
1182
 
 
1183
        :param packs: The packs list to process.
 
1184
        :param index_attribute: The attribute that the desired index is found
 
1185
            on.
 
1186
        :return: A tuple (map, list) where map contains the dict from
 
1187
            index:pack_tuple, and lsit contains the indices in the same order
 
1188
            as the packs list.
 
1189
        """
 
1190
        indices = []
 
1191
        pack_map = {}
 
1192
        for pack in packs:
 
1193
            index = getattr(pack, index_attribute)
 
1194
            indices.append(index)
 
1195
            pack_map[index] = (pack.pack_transport, pack.file_name())
 
1196
        return pack_map, indices
 
1197
 
 
1198
    def _index_contents(self, pack_map, key_filter=None):
 
1199
        """Get an iterable of the index contents from a pack_map.
 
1200
 
 
1201
        :param pack_map: A map from indices to pack details.
 
1202
        :param key_filter: An optional filter to limit the
 
1203
            keys returned.
 
1204
        """
 
1205
        indices = [index for index in pack_map.iterkeys()]
 
1206
        all_index = CombinedGraphIndex(indices)
 
1207
        if key_filter is None:
 
1208
            return all_index.iter_all_entries()
 
1209
        else:
 
1210
            return all_index.iter_entries(key_filter)
 
1211
 
1324
1212
    def _unlock_names(self):
1325
1213
        """Release the mutex around the pack-names index."""
1326
1214
        self.repo.control_files.unlock()
1327
1215
 
1328
 
    def _diff_pack_names(self):
1329
 
        """Read the pack names from disk, and compare it to the one in memory.
1330
 
 
1331
 
        :return: (disk_nodes, deleted_nodes, new_nodes)
1332
 
            disk_nodes    The final set of nodes that should be referenced
1333
 
            deleted_nodes Nodes which have been removed from when we started
1334
 
            new_nodes     Nodes that are newly introduced
1335
 
        """
1336
 
        # load the disk nodes across
1337
 
        disk_nodes = set()
1338
 
        for index, key, value in self._iter_disk_pack_index():
1339
 
            disk_nodes.add((key, value))
1340
 
        orig_disk_nodes = set(disk_nodes)
1341
 
 
1342
 
        # do a two-way diff against our original content
1343
 
        current_nodes = set()
1344
 
        for name, sizes in self._names.iteritems():
1345
 
            current_nodes.add(
1346
 
                ((name, ), ' '.join(str(size) for size in sizes)))
1347
 
 
1348
 
        # Packs no longer present in the repository, which were present when we
1349
 
        # locked the repository
1350
 
        deleted_nodes = self._packs_at_load - current_nodes
1351
 
        # Packs which this process is adding
1352
 
        new_nodes = current_nodes - self._packs_at_load
1353
 
 
1354
 
        # Update the disk_nodes set to include the ones we are adding, and
1355
 
        # remove the ones which were removed by someone else
1356
 
        disk_nodes.difference_update(deleted_nodes)
1357
 
        disk_nodes.update(new_nodes)
1358
 
 
1359
 
        return disk_nodes, deleted_nodes, new_nodes, orig_disk_nodes
1360
 
 
1361
 
    def _syncronize_pack_names_from_disk_nodes(self, disk_nodes):
1362
 
        """Given the correct set of pack files, update our saved info.
1363
 
 
1364
 
        :return: (removed, added, modified)
1365
 
            removed     pack names removed from self._names
1366
 
            added       pack names added to self._names
1367
 
            modified    pack names that had changed value
1368
 
        """
1369
 
        removed = []
1370
 
        added = []
1371
 
        modified = []
1372
 
        ## self._packs_at_load = disk_nodes
 
1216
    def _save_pack_names(self, clear_obsolete_packs=False):
 
1217
        """Save the list of packs.
 
1218
 
 
1219
        This will take out the mutex around the pack names list for the
 
1220
        duration of the method call. If concurrent updates have been made, a
 
1221
        three-way merge between the current list and the current in memory list
 
1222
        is performed.
 
1223
 
 
1224
        :param clear_obsolete_packs: If True, clear out the contents of the
 
1225
            obsolete_packs directory.
 
1226
        """
 
1227
        self.lock_names()
 
1228
        try:
 
1229
            builder = GraphIndexBuilder()
 
1230
            # load the disk nodes across
 
1231
            disk_nodes = set()
 
1232
            for index, key, value in self._iter_disk_pack_index():
 
1233
                disk_nodes.add((key, value))
 
1234
            # do a two-way diff against our original content
 
1235
            current_nodes = set()
 
1236
            for name, sizes in self._names.iteritems():
 
1237
                current_nodes.add(
 
1238
                    ((name, ), ' '.join(str(size) for size in sizes)))
 
1239
            deleted_nodes = self._packs_at_load - current_nodes
 
1240
            new_nodes = current_nodes - self._packs_at_load
 
1241
            disk_nodes.difference_update(deleted_nodes)
 
1242
            disk_nodes.update(new_nodes)
 
1243
            # TODO: handle same-name, index-size-changes here - 
 
1244
            # e.g. use the value from disk, not ours, *unless* we're the one
 
1245
            # changing it.
 
1246
            for key, value in disk_nodes:
 
1247
                builder.add_node(key, value)
 
1248
            self.transport.put_file('pack-names', builder.finish())
 
1249
            # move the baseline forward
 
1250
            self._packs_at_load = disk_nodes
 
1251
            # now clear out the obsolete packs directory
 
1252
            if clear_obsolete_packs:
 
1253
                self.transport.clone('obsolete_packs').delete_multi(
 
1254
                    self.transport.list_dir('obsolete_packs'))
 
1255
        finally:
 
1256
            self._unlock_names()
 
1257
        # synchronise the memory packs list with what we just wrote:
1373
1258
        new_names = dict(disk_nodes)
1374
1259
        # drop no longer present nodes
1375
1260
        for pack in self.all_packs():
1376
1261
            if (pack.name,) not in new_names:
1377
 
                removed.append(pack.name)
1378
1262
                self._remove_pack_from_memory(pack)
1379
1263
        # add new nodes/refresh existing ones
1380
1264
        for key, value in disk_nodes:
1390
1274
                    # disk index because the set values are the same, unless
1391
1275
                    # the only index shows up as deleted by the set difference
1392
1276
                    # - which it may. Until there is a specific test for this,
1393
 
                    # assume it's broken. RBC 20071017.
 
1277
                    # assume its broken. RBC 20071017.
1394
1278
                    self._remove_pack_from_memory(self.get_pack_by_name(name))
1395
1279
                    self._names[name] = sizes
1396
1280
                    self.get_pack_by_name(name)
1397
 
                    modified.append(name)
1398
1281
            else:
1399
1282
                # new
1400
1283
                self._names[name] = sizes
1401
1284
                self.get_pack_by_name(name)
1402
 
                added.append(name)
1403
 
        return removed, added, modified
1404
 
 
1405
 
    def _save_pack_names(self, clear_obsolete_packs=False, obsolete_packs=None):
1406
 
        """Save the list of packs.
1407
 
 
1408
 
        This will take out the mutex around the pack names list for the
1409
 
        duration of the method call. If concurrent updates have been made, a
1410
 
        three-way merge between the current list and the current in memory list
1411
 
        is performed.
1412
 
 
1413
 
        :param clear_obsolete_packs: If True, clear out the contents of the
1414
 
            obsolete_packs directory.
1415
 
        :param obsolete_packs: Packs that are obsolete once the new pack-names
1416
 
            file has been written.
1417
 
        :return: A list of the names saved that were not previously on disk.
1418
 
        """
1419
 
        already_obsolete = []
1420
 
        self.lock_names()
1421
 
        try:
1422
 
            builder = self._index_builder_class()
1423
 
            (disk_nodes, deleted_nodes, new_nodes,
1424
 
             orig_disk_nodes) = self._diff_pack_names()
1425
 
            # TODO: handle same-name, index-size-changes here -
1426
 
            # e.g. use the value from disk, not ours, *unless* we're the one
1427
 
            # changing it.
1428
 
            for key, value in disk_nodes:
1429
 
                builder.add_node(key, value)
1430
 
            self.transport.put_file('pack-names', builder.finish(),
1431
 
                mode=self.repo.bzrdir._get_file_mode())
1432
 
            self._packs_at_load = disk_nodes
1433
 
            if clear_obsolete_packs:
1434
 
                to_preserve = None
1435
 
                if obsolete_packs:
1436
 
                    to_preserve = set([o.name for o in obsolete_packs])
1437
 
                already_obsolete = self._clear_obsolete_packs(to_preserve)
1438
 
        finally:
1439
 
            self._unlock_names()
1440
 
        # synchronise the memory packs list with what we just wrote:
1441
 
        self._syncronize_pack_names_from_disk_nodes(disk_nodes)
1442
 
        if obsolete_packs:
1443
 
            # TODO: We could add one more condition here. "if o.name not in
1444
 
            #       orig_disk_nodes and o != the new_pack we haven't written to
1445
 
            #       disk yet. However, the new pack object is not easily
1446
 
            #       accessible here (it would have to be passed through the
1447
 
            #       autopacking code, etc.)
1448
 
            obsolete_packs = [o for o in obsolete_packs
1449
 
                              if o.name not in already_obsolete]
1450
 
            self._obsolete_packs(obsolete_packs)
1451
 
        return [new_node[0][0] for new_node in new_nodes]
1452
 
 
1453
 
    def reload_pack_names(self):
1454
 
        """Sync our pack listing with what is present in the repository.
1455
 
 
1456
 
        This should be called when we find out that something we thought was
1457
 
        present is now missing. This happens when another process re-packs the
1458
 
        repository, etc.
1459
 
 
1460
 
        :return: True if the in-memory list of packs has been altered at all.
1461
 
        """
1462
 
        # The ensure_loaded call is to handle the case where the first call
1463
 
        # made involving the collection was to reload_pack_names, where we 
1464
 
        # don't have a view of disk contents. It's a bit of a bandaid, and
1465
 
        # causes two reads of pack-names, but it's a rare corner case not
1466
 
        # struck with regular push/pull etc.
1467
 
        first_read = self.ensure_loaded()
1468
 
        if first_read:
1469
 
            return True
1470
 
        # out the new value.
1471
 
        (disk_nodes, deleted_nodes, new_nodes,
1472
 
         orig_disk_nodes) = self._diff_pack_names()
1473
 
        # _packs_at_load is meant to be the explicit list of names in
1474
 
        # 'pack-names' at then start. As such, it should not contain any
1475
 
        # pending names that haven't been written out yet.
1476
 
        self._packs_at_load = orig_disk_nodes
1477
 
        (removed, added,
1478
 
         modified) = self._syncronize_pack_names_from_disk_nodes(disk_nodes)
1479
 
        if removed or added or modified:
1480
 
            return True
1481
 
        return False
1482
 
 
1483
 
    def _restart_autopack(self):
1484
 
        """Reload the pack names list, and restart the autopack code."""
1485
 
        if not self.reload_pack_names():
1486
 
            # Re-raise the original exception, because something went missing
1487
 
            # and a restart didn't find it
1488
 
            raise
1489
 
        raise errors.RetryAutopack(self.repo, False, sys.exc_info())
1490
 
 
1491
 
    def _restart_pack_operations(self):
1492
 
        """Reload the pack names list, and restart the autopack code."""
1493
 
        if not self.reload_pack_names():
1494
 
            # Re-raise the original exception, because something went missing
1495
 
            # and a restart didn't find it
1496
 
            raise
1497
 
        raise RetryPackOperations(self.repo, False, sys.exc_info())
1498
 
 
1499
 
    def _clear_obsolete_packs(self, preserve=None):
1500
 
        """Delete everything from the obsolete-packs directory.
1501
 
 
1502
 
        :return: A list of pack identifiers (the filename without '.pack') that
1503
 
            were found in obsolete_packs.
1504
 
        """
1505
 
        found = []
1506
 
        obsolete_pack_transport = self.transport.clone('obsolete_packs')
1507
 
        if preserve is None:
1508
 
            preserve = set()
1509
 
        try:
1510
 
            obsolete_pack_files = obsolete_pack_transport.list_dir('.')
1511
 
        except errors.NoSuchFile:
1512
 
            return found
1513
 
        for filename in obsolete_pack_files:
1514
 
            name, ext = osutils.splitext(filename)
1515
 
            if ext == '.pack':
1516
 
                found.append(name)
1517
 
            if name in preserve:
1518
 
                continue
1519
 
            try:
1520
 
                obsolete_pack_transport.delete(filename)
1521
 
            except (errors.PathError, errors.TransportError), e:
1522
 
                warning("couldn't delete obsolete pack, skipping it:\n%s"
1523
 
                        % (e,))
1524
 
        return found
1525
1285
 
1526
1286
    def _start_write_group(self):
1527
1287
        # Do not permit preparation for writing if we're not in a 'write lock'.
1528
1288
        if not self.repo.is_write_locked():
1529
1289
            raise errors.NotWriteLocked(self)
1530
 
        self._new_pack = self.pack_factory(self, upload_suffix='.pack',
1531
 
            file_mode=self.repo.bzrdir._get_file_mode())
 
1290
        self._new_pack = NewPack(self._upload_transport, self._index_transport,
 
1291
            self._pack_transport, upload_suffix='.pack')
1532
1292
        # allow writing: queue writes to a new index
1533
1293
        self.revision_index.add_writable_index(self._new_pack.revision_index,
1534
1294
            self._new_pack)
1536
1296
            self._new_pack)
1537
1297
        self.text_index.add_writable_index(self._new_pack.text_index,
1538
1298
            self._new_pack)
1539
 
        self._new_pack.text_index.set_optimize(combine_backing_indices=False)
1540
1299
        self.signature_index.add_writable_index(self._new_pack.signature_index,
1541
1300
            self._new_pack)
1542
 
        if self.chk_index is not None:
1543
 
            self.chk_index.add_writable_index(self._new_pack.chk_index,
1544
 
                self._new_pack)
1545
 
            self.repo.chk_bytes._index._add_callback = self.chk_index.add_callback
1546
 
            self._new_pack.chk_index.set_optimize(combine_backing_indices=False)
1547
1301
 
1548
 
        self.repo.inventories._index._add_callback = self.inventory_index.add_callback
1549
 
        self.repo.revisions._index._add_callback = self.revision_index.add_callback
1550
 
        self.repo.signatures._index._add_callback = self.signature_index.add_callback
1551
 
        self.repo.texts._index._add_callback = self.text_index.add_callback
 
1302
        # reused revision and signature knits may need updating
 
1303
        #
 
1304
        # "Hysterical raisins. client code in bzrlib grabs those knits outside
 
1305
        # of write groups and then mutates it inside the write group."
 
1306
        if self.repo._revision_knit is not None:
 
1307
            self.repo._revision_knit._index._add_callback = \
 
1308
                self.revision_index.add_callback
 
1309
        if self.repo._signature_knit is not None:
 
1310
            self.repo._signature_knit._index._add_callback = \
 
1311
                self.signature_index.add_callback
 
1312
        # create a reused knit object for text addition in commit.
 
1313
        self.repo._text_knit = self.repo.weave_store.get_weave_or_empty(
 
1314
            'all-texts', None)
1552
1315
 
1553
1316
    def _abort_write_group(self):
1554
1317
        # FIXME: just drop the transient index.
1555
1318
        # forget what names there are
1556
 
        if self._new_pack is not None:
1557
 
            operation = cleanup.OperationWithCleanups(self._new_pack.abort)
1558
 
            operation.add_cleanup(setattr, self, '_new_pack', None)
1559
 
            # If we aborted while in the middle of finishing the write
1560
 
            # group, _remove_pack_indices could fail because the indexes are
1561
 
            # already gone.  But they're not there we shouldn't fail in this
1562
 
            # case, so we pass ignore_missing=True.
1563
 
            operation.add_cleanup(self._remove_pack_indices, self._new_pack,
1564
 
                ignore_missing=True)
1565
 
            operation.run_simple()
1566
 
        for resumed_pack in self._resumed_packs:
1567
 
            operation = cleanup.OperationWithCleanups(resumed_pack.abort)
1568
 
            # See comment in previous finally block.
1569
 
            operation.add_cleanup(self._remove_pack_indices, resumed_pack,
1570
 
                ignore_missing=True)
1571
 
            operation.run_simple()
1572
 
        del self._resumed_packs[:]
1573
 
 
1574
 
    def _remove_resumed_pack_indices(self):
1575
 
        for resumed_pack in self._resumed_packs:
1576
 
            self._remove_pack_indices(resumed_pack)
1577
 
        del self._resumed_packs[:]
1578
 
 
1579
 
    def _check_new_inventories(self):
1580
 
        """Detect missing inventories in this write group.
1581
 
 
1582
 
        :returns: list of strs, summarising any problems found.  If the list is
1583
 
            empty no problems were found.
1584
 
        """
1585
 
        # The base implementation does no checks.  GCRepositoryPackCollection
1586
 
        # overrides this.
1587
 
        return []
1588
 
        
 
1319
        self._new_pack.abort()
 
1320
        self._remove_pack_indices(self._new_pack)
 
1321
        self._new_pack = None
 
1322
        self.repo._text_knit = None
 
1323
 
1589
1324
    def _commit_write_group(self):
1590
 
        all_missing = set()
1591
 
        for prefix, versioned_file in (
1592
 
                ('revisions', self.repo.revisions),
1593
 
                ('inventories', self.repo.inventories),
1594
 
                ('texts', self.repo.texts),
1595
 
                ('signatures', self.repo.signatures),
1596
 
                ):
1597
 
            missing = versioned_file.get_missing_compression_parent_keys()
1598
 
            all_missing.update([(prefix,) + key for key in missing])
1599
 
        if all_missing:
1600
 
            raise errors.BzrCheckError(
1601
 
                "Repository %s has missing compression parent(s) %r "
1602
 
                 % (self.repo, sorted(all_missing)))
1603
 
        problems = self._check_new_inventories()
1604
 
        if problems:
1605
 
            problems_summary = '\n'.join(problems)
1606
 
            raise errors.BzrCheckError(
1607
 
                "Cannot add revision(s) to repository: " + problems_summary)
1608
1325
        self._remove_pack_indices(self._new_pack)
1609
 
        any_new_content = False
1610
1326
        if self._new_pack.data_inserted():
1611
1327
            # get all the data to disk and read to use
1612
1328
            self._new_pack.finish()
1613
1329
            self.allocate(self._new_pack)
1614
1330
            self._new_pack = None
1615
 
            any_new_content = True
1616
 
        else:
1617
 
            self._new_pack.abort()
1618
 
            self._new_pack = None
1619
 
        for resumed_pack in self._resumed_packs:
1620
 
            # XXX: this is a pretty ugly way to turn the resumed pack into a
1621
 
            # properly committed pack.
1622
 
            self._names[resumed_pack.name] = None
1623
 
            self._remove_pack_from_memory(resumed_pack)
1624
 
            resumed_pack.finish()
1625
 
            self.allocate(resumed_pack)
1626
 
            any_new_content = True
1627
 
        del self._resumed_packs[:]
1628
 
        if any_new_content:
1629
 
            result = self.autopack()
1630
 
            if not result:
 
1331
            if not self.autopack():
1631
1332
                # when autopack takes no steps, the names list is still
1632
1333
                # unsaved.
1633
 
                return self._save_pack_names()
1634
 
            return result
1635
 
        return []
1636
 
 
1637
 
    def _suspend_write_group(self):
1638
 
        tokens = [pack.name for pack in self._resumed_packs]
1639
 
        self._remove_pack_indices(self._new_pack)
1640
 
        if self._new_pack.data_inserted():
1641
 
            # get all the data to disk and read to use
1642
 
            self._new_pack.finish(suspend=True)
1643
 
            tokens.append(self._new_pack.name)
1644
 
            self._new_pack = None
 
1334
                self._save_pack_names()
1645
1335
        else:
1646
1336
            self._new_pack.abort()
1647
1337
            self._new_pack = None
1648
 
        self._remove_resumed_pack_indices()
1649
 
        return tokens
1650
 
 
1651
 
    def _resume_write_group(self, tokens):
1652
 
        for token in tokens:
1653
 
            self._resume_pack(token)
1654
 
 
1655
 
 
1656
 
class PackRepository(MetaDirVersionedFileRepository):
1657
 
    """Repository with knit objects stored inside pack containers.
1658
 
 
1659
 
    The layering for a KnitPackRepository is:
1660
 
 
1661
 
    Graph        |  HPSS    | Repository public layer |
1662
 
    ===================================================
1663
 
    Tuple based apis below, string based, and key based apis above
1664
 
    ---------------------------------------------------
1665
 
    VersionedFiles
1666
 
      Provides .texts, .revisions etc
1667
 
      This adapts the N-tuple keys to physical knit records which only have a
1668
 
      single string identifier (for historical reasons), which in older formats
1669
 
      was always the revision_id, and in the mapped code for packs is always
1670
 
      the last element of key tuples.
1671
 
    ---------------------------------------------------
1672
 
    GraphIndex
1673
 
      A separate GraphIndex is used for each of the
1674
 
      texts/inventories/revisions/signatures contained within each individual
1675
 
      pack file. The GraphIndex layer works in N-tuples and is unaware of any
1676
 
      semantic value.
1677
 
    ===================================================
1678
 
 
1679
 
    """
1680
 
 
1681
 
    # These attributes are inherited from the Repository base class. Setting
1682
 
    # them to None ensures that if the constructor is changed to not initialize
1683
 
    # them, or a subclass fails to call the constructor, that an error will
1684
 
    # occur rather than the system working but generating incorrect data.
1685
 
    _commit_builder_class = None
1686
 
    _serializer = None
1687
 
 
1688
 
    def __init__(self, _format, a_bzrdir, control_files, _commit_builder_class,
1689
 
        _serializer):
1690
 
        MetaDirRepository.__init__(self, _format, a_bzrdir, control_files)
1691
 
        self._commit_builder_class = _commit_builder_class
1692
 
        self._serializer = _serializer
1693
 
        self._reconcile_fixes_text_parents = True
1694
 
        if self._format.supports_external_lookups:
1695
 
            self._unstacked_provider = graph.CachingParentsProvider(
1696
 
                self._make_parents_provider_unstacked())
1697
 
        else:
1698
 
            self._unstacked_provider = graph.CachingParentsProvider(self)
1699
 
        self._unstacked_provider.disable_cache()
1700
 
 
1701
 
    @needs_read_lock
1702
 
    def _all_revision_ids(self):
1703
 
        """See Repository.all_revision_ids()."""
1704
 
        return [key[0] for key in self.revisions.keys()]
 
1338
        self.repo._text_knit = None
 
1339
 
 
1340
 
 
1341
class KnitPackRevisionStore(KnitRevisionStore):
 
1342
    """An object to adapt access from RevisionStore's to use KnitPacks.
 
1343
 
 
1344
    This class works by replacing the original RevisionStore.
 
1345
    We need to do this because the KnitPackRevisionStore is less
 
1346
    isolated in its layering - it uses services from the repo.
 
1347
    """
 
1348
 
 
1349
    def __init__(self, repo, transport, revisionstore):
 
1350
        """Create a KnitPackRevisionStore on repo with revisionstore.
 
1351
 
 
1352
        This will store its state in the Repository, use the
 
1353
        indices to provide a KnitGraphIndex,
 
1354
        and at the end of transactions write new indices.
 
1355
        """
 
1356
        KnitRevisionStore.__init__(self, revisionstore.versioned_file_store)
 
1357
        self.repo = repo
 
1358
        self._serializer = revisionstore._serializer
 
1359
        self.transport = transport
 
1360
 
 
1361
    def get_revision_file(self, transaction):
 
1362
        """Get the revision versioned file object."""
 
1363
        if getattr(self.repo, '_revision_knit', None) is not None:
 
1364
            return self.repo._revision_knit
 
1365
        self.repo._pack_collection.ensure_loaded()
 
1366
        add_callback = self.repo._pack_collection.revision_index.add_callback
 
1367
        # setup knit specific objects
 
1368
        knit_index = KnitGraphIndex(
 
1369
            self.repo._pack_collection.revision_index.combined_index,
 
1370
            add_callback=add_callback)
 
1371
        self.repo._revision_knit = knit.KnitVersionedFile(
 
1372
            'revisions', self.transport.clone('..'),
 
1373
            self.repo.control_files._file_mode,
 
1374
            create=False, access_mode=self.repo._access_mode(),
 
1375
            index=knit_index, delta=False, factory=knit.KnitPlainFactory(),
 
1376
            access_method=self.repo._pack_collection.revision_index.knit_access)
 
1377
        return self.repo._revision_knit
 
1378
 
 
1379
    def get_signature_file(self, transaction):
 
1380
        """Get the signature versioned file object."""
 
1381
        if getattr(self.repo, '_signature_knit', None) is not None:
 
1382
            return self.repo._signature_knit
 
1383
        self.repo._pack_collection.ensure_loaded()
 
1384
        add_callback = self.repo._pack_collection.signature_index.add_callback
 
1385
        # setup knit specific objects
 
1386
        knit_index = KnitGraphIndex(
 
1387
            self.repo._pack_collection.signature_index.combined_index,
 
1388
            add_callback=add_callback, parents=False)
 
1389
        self.repo._signature_knit = knit.KnitVersionedFile(
 
1390
            'signatures', self.transport.clone('..'),
 
1391
            self.repo.control_files._file_mode,
 
1392
            create=False, access_mode=self.repo._access_mode(),
 
1393
            index=knit_index, delta=False, factory=knit.KnitPlainFactory(),
 
1394
            access_method=self.repo._pack_collection.signature_index.knit_access)
 
1395
        return self.repo._signature_knit
 
1396
 
 
1397
 
 
1398
class KnitPackTextStore(VersionedFileStore):
 
1399
    """Presents a TextStore abstraction on top of packs.
 
1400
 
 
1401
    This class works by replacing the original VersionedFileStore.
 
1402
    We need to do this because the KnitPackRevisionStore is less
 
1403
    isolated in its layering - it uses services from the repo and shares them
 
1404
    with all the data written in a single write group.
 
1405
    """
 
1406
 
 
1407
    def __init__(self, repo, transport, weavestore):
 
1408
        """Create a KnitPackTextStore on repo with weavestore.
 
1409
 
 
1410
        This will store its state in the Repository, use the
 
1411
        indices FileNames to provide a KnitGraphIndex,
 
1412
        and at the end of transactions write new indices.
 
1413
        """
 
1414
        # don't call base class constructor - it's not suitable.
 
1415
        # no transient data stored in the transaction
 
1416
        # cache.
 
1417
        self._precious = False
 
1418
        self.repo = repo
 
1419
        self.transport = transport
 
1420
        self.weavestore = weavestore
 
1421
        # XXX for check() which isn't updated yet
 
1422
        self._transport = weavestore._transport
 
1423
 
 
1424
    def get_weave_or_empty(self, file_id, transaction):
 
1425
        """Get a 'Knit' backed by the .tix indices.
 
1426
 
 
1427
        The transaction parameter is ignored.
 
1428
        """
 
1429
        self.repo._pack_collection.ensure_loaded()
 
1430
        add_callback = self.repo._pack_collection.text_index.add_callback
 
1431
        # setup knit specific objects
 
1432
        file_id_index = GraphIndexPrefixAdapter(
 
1433
            self.repo._pack_collection.text_index.combined_index,
 
1434
            (file_id, ), 1, add_nodes_callback=add_callback)
 
1435
        knit_index = KnitGraphIndex(file_id_index,
 
1436
            add_callback=file_id_index.add_nodes,
 
1437
            deltas=True, parents=True)
 
1438
        return knit.KnitVersionedFile('text:' + file_id,
 
1439
            self.transport.clone('..'),
 
1440
            None,
 
1441
            index=knit_index,
 
1442
            access_method=self.repo._pack_collection.text_index.knit_access,
 
1443
            factory=knit.KnitPlainFactory())
 
1444
 
 
1445
    get_weave = get_weave_or_empty
 
1446
 
 
1447
    def __iter__(self):
 
1448
        """Generate a list of the fileids inserted, for use by check."""
 
1449
        self.repo._pack_collection.ensure_loaded()
 
1450
        ids = set()
 
1451
        for index, key, value, refs in \
 
1452
            self.repo._pack_collection.text_index.combined_index.iter_all_entries():
 
1453
            ids.add(key[0])
 
1454
        return iter(ids)
 
1455
 
 
1456
 
 
1457
class InventoryKnitThunk(object):
 
1458
    """An object to manage thunking get_inventory_weave to pack based knits."""
 
1459
 
 
1460
    def __init__(self, repo, transport):
 
1461
        """Create an InventoryKnitThunk for repo at transport.
 
1462
 
 
1463
        This will store its state in the Repository, use the
 
1464
        indices FileNames to provide a KnitGraphIndex,
 
1465
        and at the end of transactions write a new index..
 
1466
        """
 
1467
        self.repo = repo
 
1468
        self.transport = transport
 
1469
 
 
1470
    def get_weave(self):
 
1471
        """Get a 'Knit' that contains inventory data."""
 
1472
        self.repo._pack_collection.ensure_loaded()
 
1473
        add_callback = self.repo._pack_collection.inventory_index.add_callback
 
1474
        # setup knit specific objects
 
1475
        knit_index = KnitGraphIndex(
 
1476
            self.repo._pack_collection.inventory_index.combined_index,
 
1477
            add_callback=add_callback, deltas=True, parents=True)
 
1478
        return knit.KnitVersionedFile(
 
1479
            'inventory', self.transport.clone('..'),
 
1480
            self.repo.control_files._file_mode,
 
1481
            create=False, access_mode=self.repo._access_mode(),
 
1482
            index=knit_index, delta=True, factory=knit.KnitPlainFactory(),
 
1483
            access_method=self.repo._pack_collection.inventory_index.knit_access)
 
1484
 
 
1485
 
 
1486
class KnitPackRepository(KnitRepository):
 
1487
    """Experimental graph-knit using repository."""
 
1488
 
 
1489
    def __init__(self, _format, a_bzrdir, control_files, _revision_store,
 
1490
        control_store, text_store, _commit_builder_class, _serializer):
 
1491
        KnitRepository.__init__(self, _format, a_bzrdir, control_files,
 
1492
            _revision_store, control_store, text_store, _commit_builder_class,
 
1493
            _serializer)
 
1494
        index_transport = control_files._transport.clone('indices')
 
1495
        self._pack_collection = RepositoryPackCollection(self, control_files._transport,
 
1496
            index_transport,
 
1497
            control_files._transport.clone('upload'),
 
1498
            control_files._transport.clone('packs'))
 
1499
        self._revision_store = KnitPackRevisionStore(self, index_transport, self._revision_store)
 
1500
        self.weave_store = KnitPackTextStore(self, index_transport, self.weave_store)
 
1501
        self._inv_thunk = InventoryKnitThunk(self, index_transport)
 
1502
        # True when the repository object is 'write locked' (as opposed to the
 
1503
        # physical lock only taken out around changes to the pack-names list.) 
 
1504
        # Another way to represent this would be a decorator around the control
 
1505
        # files object that presents logical locks as physical ones - if this
 
1506
        # gets ugly consider that alternative design. RBC 20071011
 
1507
        self._write_lock_count = 0
 
1508
        self._transaction = None
 
1509
        # for tests
 
1510
        self._reconcile_does_inventory_gc = True
 
1511
        self._reconcile_fixes_text_parents = False
 
1512
        self._reconcile_backsup_inventory = False
1705
1513
 
1706
1514
    def _abort_write_group(self):
1707
 
        self.revisions._index._key_dependencies.clear()
1708
1515
        self._pack_collection._abort_write_group()
1709
1516
 
 
1517
    def _access_mode(self):
 
1518
        """Return 'w' or 'r' for depending on whether a write lock is active.
 
1519
        
 
1520
        This method is a helper for the Knit-thunking support objects.
 
1521
        """
 
1522
        if self.is_write_locked():
 
1523
            return 'w'
 
1524
        return 'r'
 
1525
 
 
1526
    def _find_inconsistent_revision_parents(self):
 
1527
        """Find revisions with incorrectly cached parents.
 
1528
 
 
1529
        :returns: an iterator yielding tuples of (revison-id, parents-in-index,
 
1530
            parents-in-revision).
 
1531
        """
 
1532
        assert self.is_locked()
 
1533
        pb = ui.ui_factory.nested_progress_bar()
 
1534
        result = []
 
1535
        try:
 
1536
            revision_nodes = self._pack_collection.revision_index \
 
1537
                .combined_index.iter_all_entries()
 
1538
            index_positions = []
 
1539
            # Get the cached index values for all revisions, and also the location
 
1540
            # in each index of the revision text so we can perform linear IO.
 
1541
            for index, key, value, refs in revision_nodes:
 
1542
                pos, length = value[1:].split(' ')
 
1543
                index_positions.append((index, int(pos), key[0],
 
1544
                    tuple(parent[0] for parent in refs[0])))
 
1545
                pb.update("Reading revision index.", 0, 0)
 
1546
            index_positions.sort()
 
1547
            batch_count = len(index_positions) / 1000 + 1
 
1548
            pb.update("Checking cached revision graph.", 0, batch_count)
 
1549
            for offset in xrange(batch_count):
 
1550
                pb.update("Checking cached revision graph.", offset)
 
1551
                to_query = index_positions[offset * 1000:(offset + 1) * 1000]
 
1552
                if not to_query:
 
1553
                    break
 
1554
                rev_ids = [item[2] for item in to_query]
 
1555
                revs = self.get_revisions(rev_ids)
 
1556
                for revision, item in zip(revs, to_query):
 
1557
                    index_parents = item[3]
 
1558
                    rev_parents = tuple(revision.parent_ids)
 
1559
                    if index_parents != rev_parents:
 
1560
                        result.append((revision.revision_id, index_parents, rev_parents))
 
1561
        finally:
 
1562
            pb.finished()
 
1563
        return result
 
1564
 
 
1565
    def get_parents(self, revision_ids):
 
1566
        """See StackedParentsProvider.get_parents.
 
1567
        
 
1568
        This implementation accesses the combined revision index to provide
 
1569
        answers.
 
1570
        """
 
1571
        self._pack_collection.ensure_loaded()
 
1572
        index = self._pack_collection.revision_index.combined_index
 
1573
        search_keys = set()
 
1574
        for revision_id in revision_ids:
 
1575
            if revision_id != _mod_revision.NULL_REVISION:
 
1576
                search_keys.add((revision_id,))
 
1577
        found_parents = {_mod_revision.NULL_REVISION:[]}
 
1578
        for index, key, value, refs in index.iter_entries(search_keys):
 
1579
            parents = refs[0]
 
1580
            if not parents:
 
1581
                parents = (_mod_revision.NULL_REVISION,)
 
1582
            else:
 
1583
                parents = tuple(parent[0] for parent in parents)
 
1584
            found_parents[key[0]] = parents
 
1585
        result = []
 
1586
        for revision_id in revision_ids:
 
1587
            try:
 
1588
                result.append(found_parents[revision_id])
 
1589
            except KeyError:
 
1590
                result.append(None)
 
1591
        return result
 
1592
 
1710
1593
    def _make_parents_provider(self):
1711
 
        if not self._format.supports_external_lookups:
1712
 
            return self._unstacked_provider
1713
 
        return graph.StackedParentsProvider(_LazyListJoin(
1714
 
            [self._unstacked_provider], self._fallback_repositories))
 
1594
        return self
1715
1595
 
1716
1596
    def _refresh_data(self):
1717
 
        if not self.is_locked():
1718
 
            return
1719
 
        self._pack_collection.reload_pack_names()
1720
 
        self._unstacked_provider.disable_cache()
1721
 
        self._unstacked_provider.enable_cache()
 
1597
        if self._write_lock_count == 1 or (
 
1598
            self.control_files._lock_count == 1 and
 
1599
            self.control_files._lock_mode == 'r'):
 
1600
            # forget what names there are
 
1601
            self._pack_collection.reset()
 
1602
            # XXX: Better to do an in-memory merge when acquiring a new lock -
 
1603
            # factor out code from _save_pack_names.
 
1604
            self._pack_collection.ensure_loaded()
1722
1605
 
1723
1606
    def _start_write_group(self):
1724
1607
        self._pack_collection._start_write_group()
1725
1608
 
1726
1609
    def _commit_write_group(self):
1727
 
        hint = self._pack_collection._commit_write_group()
1728
 
        self.revisions._index._key_dependencies.clear()
1729
 
        # The commit may have added keys that were previously cached as
1730
 
        # missing, so reset the cache.
1731
 
        self._unstacked_provider.disable_cache()
1732
 
        self._unstacked_provider.enable_cache()
1733
 
        return hint
1734
 
 
1735
 
    def suspend_write_group(self):
1736
 
        # XXX check self._write_group is self.get_transaction()?
1737
 
        tokens = self._pack_collection._suspend_write_group()
1738
 
        self.revisions._index._key_dependencies.clear()
1739
 
        self._write_group = None
1740
 
        return tokens
1741
 
 
1742
 
    def _resume_write_group(self, tokens):
1743
 
        self._start_write_group()
1744
 
        try:
1745
 
            self._pack_collection._resume_write_group(tokens)
1746
 
        except errors.UnresumableWriteGroup:
1747
 
            self._abort_write_group()
1748
 
            raise
1749
 
        for pack in self._pack_collection._resumed_packs:
1750
 
            self.revisions._index.scan_unvalidated_index(pack.revision_index)
 
1610
        return self._pack_collection._commit_write_group()
 
1611
 
 
1612
    def get_inventory_weave(self):
 
1613
        return self._inv_thunk.get_weave()
1751
1614
 
1752
1615
    def get_transaction(self):
1753
1616
        if self._write_lock_count:
1762
1625
        return self._write_lock_count
1763
1626
 
1764
1627
    def lock_write(self, token=None):
1765
 
        """Lock the repository for writes.
1766
 
 
1767
 
        :return: A bzrlib.repository.RepositoryWriteLockResult.
1768
 
        """
1769
 
        locked = self.is_locked()
1770
 
        if not self._write_lock_count and locked:
 
1628
        if not self._write_lock_count and self.is_locked():
1771
1629
            raise errors.ReadOnlyError(self)
1772
1630
        self._write_lock_count += 1
1773
1631
        if self._write_lock_count == 1:
 
1632
            from bzrlib import transactions
1774
1633
            self._transaction = transactions.WriteTransaction()
1775
 
        if not locked:
1776
 
            if 'relock' in debug.debug_flags and self._prev_lock == 'w':
1777
 
                note('%r was write locked again', self)
1778
 
            self._prev_lock = 'w'
1779
 
            self._unstacked_provider.enable_cache()
1780
 
            for repo in self._fallback_repositories:
1781
 
                # Writes don't affect fallback repos
1782
 
                repo.lock_read()
1783
 
            self._refresh_data()
1784
 
        return RepositoryWriteLockResult(self.unlock, None)
 
1634
        self._refresh_data()
1785
1635
 
1786
1636
    def lock_read(self):
1787
 
        """Lock the repository for reads.
1788
 
 
1789
 
        :return: A bzrlib.lock.LogicalLockResult.
1790
 
        """
1791
 
        locked = self.is_locked()
1792
1637
        if self._write_lock_count:
1793
1638
            self._write_lock_count += 1
1794
1639
        else:
1795
1640
            self.control_files.lock_read()
1796
 
        if not locked:
1797
 
            if 'relock' in debug.debug_flags and self._prev_lock == 'r':
1798
 
                note('%r was read locked again', self)
1799
 
            self._prev_lock = 'r'
1800
 
            self._unstacked_provider.enable_cache()
1801
 
            for repo in self._fallback_repositories:
1802
 
                repo.lock_read()
1803
 
            self._refresh_data()
1804
 
        return LogicalLockResult(self.unlock)
 
1641
        self._refresh_data()
1805
1642
 
1806
1643
    def leave_lock_in_place(self):
1807
1644
        # not supported - raise an error
1812
1649
        raise NotImplementedError(self.dont_leave_lock_in_place)
1813
1650
 
1814
1651
    @needs_write_lock
1815
 
    def pack(self, hint=None, clean_obsolete_packs=False):
 
1652
    def pack(self):
1816
1653
        """Compress the data within the repository.
1817
1654
 
1818
1655
        This will pack all the data to a single pack. In future it may
1819
1656
        recompress deltas or do other such expensive operations.
1820
1657
        """
1821
 
        self._pack_collection.pack(hint=hint, clean_obsolete_packs=clean_obsolete_packs)
 
1658
        self._pack_collection.pack()
1822
1659
 
1823
1660
    @needs_write_lock
1824
1661
    def reconcile(self, other=None, thorough=False):
1828
1665
        reconciler.reconcile()
1829
1666
        return reconciler
1830
1667
 
1831
 
    def _reconcile_pack(self, collection, packs, extension, revs, pb):
1832
 
        raise NotImplementedError(self._reconcile_pack)
1833
 
 
1834
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1835
1668
    def unlock(self):
1836
1669
        if self._write_lock_count == 1 and self._write_group is not None:
1837
1670
            self.abort_write_group()
1838
 
            self._unstacked_provider.disable_cache()
1839
1671
            self._transaction = None
1840
1672
            self._write_lock_count = 0
1841
1673
            raise errors.BzrError(
1850
1682
        else:
1851
1683
            self.control_files.unlock()
1852
1684
 
1853
 
        if not self.is_locked():
1854
 
            self._unstacked_provider.disable_cache()
1855
 
            for repo in self._fallback_repositories:
1856
 
                repo.unlock()
1857
 
 
1858
 
 
1859
 
class RepositoryFormatPack(MetaDirVersionedFileRepositoryFormat):
 
1685
 
 
1686
class RepositoryFormatPack(MetaDirRepositoryFormat):
1860
1687
    """Format logic for pack structured repositories.
1861
1688
 
1862
1689
    This repository format has:
1881
1708
    # Set this attribute in derived clases to control the _serializer that the
1882
1709
    # repository objects will have passed to their constructor.
1883
1710
    _serializer = None
1884
 
    # Packs are not confused by ghosts.
1885
 
    supports_ghosts = True
1886
 
    # External references are not supported in pack repositories yet.
1887
 
    supports_external_lookups = False
1888
 
    # Most pack formats do not use chk lookups.
1889
 
    supports_chks = False
1890
 
    # What index classes to use
1891
 
    index_builder_class = None
1892
 
    index_class = None
1893
 
    _fetch_uses_deltas = True
1894
 
    fast_deltas = False
1895
 
    supports_funky_characters = True
1896
 
    revision_graph_can_have_wrong_parents = True
 
1711
 
 
1712
    def _get_control_store(self, repo_transport, control_files):
 
1713
        """Return the control store for this repository."""
 
1714
        return VersionedFileStore(
 
1715
            repo_transport,
 
1716
            prefixed=False,
 
1717
            file_mode=control_files._file_mode,
 
1718
            versionedfile_class=knit.KnitVersionedFile,
 
1719
            versionedfile_kwargs={'factory': knit.KnitPlainFactory()},
 
1720
            )
 
1721
 
 
1722
    def _get_revision_store(self, repo_transport, control_files):
 
1723
        """See RepositoryFormat._get_revision_store()."""
 
1724
        versioned_file_store = VersionedFileStore(
 
1725
            repo_transport,
 
1726
            file_mode=control_files._file_mode,
 
1727
            prefixed=False,
 
1728
            precious=True,
 
1729
            versionedfile_class=knit.KnitVersionedFile,
 
1730
            versionedfile_kwargs={'delta': False,
 
1731
                                  'factory': knit.KnitPlainFactory(),
 
1732
                                 },
 
1733
            escaped=True,
 
1734
            )
 
1735
        return KnitRevisionStore(versioned_file_store)
 
1736
 
 
1737
    def _get_text_store(self, transport, control_files):
 
1738
        """See RepositoryFormat._get_text_store()."""
 
1739
        return self._get_versioned_file_store('knits',
 
1740
                                  transport,
 
1741
                                  control_files,
 
1742
                                  versionedfile_class=knit.KnitVersionedFile,
 
1743
                                  versionedfile_kwargs={
 
1744
                                      'create_parent_dir': True,
 
1745
                                      'delay_create': True,
 
1746
                                      'dir_mode': control_files._dir_mode,
 
1747
                                  },
 
1748
                                  escaped=True)
1897
1749
 
1898
1750
    def initialize(self, a_bzrdir, shared=False):
1899
1751
        """Create a pack based repository.
1905
1757
        """
1906
1758
        mutter('creating repository in %s.', a_bzrdir.transport.base)
1907
1759
        dirs = ['indices', 'obsolete_packs', 'packs', 'upload']
1908
 
        builder = self.index_builder_class()
 
1760
        builder = GraphIndexBuilder()
1909
1761
        files = [('pack-names', builder.finish())]
1910
1762
        utf8_files = [('format', self.get_format_string())]
1911
 
 
 
1763
        
1912
1764
        self._upload_blank_content(a_bzrdir, dirs, files, utf8_files, shared)
1913
 
        repository = self.open(a_bzrdir=a_bzrdir, _found=True)
1914
 
        self._run_post_repo_init_hooks(repository, a_bzrdir, shared)
1915
 
        return repository
 
1765
        return self.open(a_bzrdir=a_bzrdir, _found=True)
1916
1766
 
1917
1767
    def open(self, a_bzrdir, _found=False, _override_transport=None):
1918
1768
        """See RepositoryFormat.open().
1919
 
 
 
1769
        
1920
1770
        :param _override_transport: INTERNAL USE ONLY. Allows opening the
1921
1771
                                    repository at a slightly different url
1922
1772
                                    than normal. I.e. during 'upgrade'.
1923
1773
        """
1924
1774
        if not _found:
1925
 
            format = RepositoryFormatMetaDir.find_format(a_bzrdir)
 
1775
            format = RepositoryFormat.find_format(a_bzrdir)
 
1776
            assert format.__class__ ==  self.__class__
1926
1777
        if _override_transport is not None:
1927
1778
            repo_transport = _override_transport
1928
1779
        else:
1929
1780
            repo_transport = a_bzrdir.get_repository_transport(None)
1930
1781
        control_files = lockable_files.LockableFiles(repo_transport,
1931
1782
                                'lock', lockdir.LockDir)
 
1783
        text_store = self._get_text_store(repo_transport, control_files)
 
1784
        control_store = self._get_control_store(repo_transport, control_files)
 
1785
        _revision_store = self._get_revision_store(repo_transport, control_files)
1932
1786
        return self.repository_class(_format=self,
1933
1787
                              a_bzrdir=a_bzrdir,
1934
1788
                              control_files=control_files,
 
1789
                              _revision_store=_revision_store,
 
1790
                              control_store=control_store,
 
1791
                              text_store=text_store,
1935
1792
                              _commit_builder_class=self._commit_builder_class,
1936
1793
                              _serializer=self._serializer)
1937
1794
 
1938
1795
 
1939
 
class RetryPackOperations(errors.RetryWithNewPacks):
1940
 
    """Raised when we are packing and we find a missing file.
1941
 
 
1942
 
    Meant as a signaling exception, to tell the RepositoryPackCollection.pack
1943
 
    code it should try again.
1944
 
    """
1945
 
 
1946
 
    internal_error = True
1947
 
 
1948
 
    _fmt = ("Pack files have changed, reload and try pack again."
1949
 
            " context: %(context)s %(orig_error)s")
1950
 
 
1951
 
 
1952
 
class _DirectPackAccess(object):
1953
 
    """Access to data in one or more packs with less translation."""
1954
 
 
1955
 
    def __init__(self, index_to_packs, reload_func=None, flush_func=None):
1956
 
        """Create a _DirectPackAccess object.
1957
 
 
1958
 
        :param index_to_packs: A dict mapping index objects to the transport
1959
 
            and file names for obtaining data.
1960
 
        :param reload_func: A function to call if we determine that the pack
1961
 
            files have moved and we need to reload our caches. See
1962
 
            bzrlib.repo_fmt.pack_repo.AggregateIndex for more details.
1963
 
        """
1964
 
        self._container_writer = None
1965
 
        self._write_index = None
1966
 
        self._indices = index_to_packs
1967
 
        self._reload_func = reload_func
1968
 
        self._flush_func = flush_func
1969
 
 
1970
 
    def add_raw_records(self, key_sizes, raw_data):
1971
 
        """Add raw knit bytes to a storage area.
1972
 
 
1973
 
        The data is spooled to the container writer in one bytes-record per
1974
 
        raw data item.
1975
 
 
1976
 
        :param sizes: An iterable of tuples containing the key and size of each
1977
 
            raw data segment.
1978
 
        :param raw_data: A bytestring containing the data.
1979
 
        :return: A list of memos to retrieve the record later. Each memo is an
1980
 
            opaque index memo. For _DirectPackAccess the memo is (index, pos,
1981
 
            length), where the index field is the write_index object supplied
1982
 
            to the PackAccess object.
1983
 
        """
1984
 
        if type(raw_data) is not str:
1985
 
            raise AssertionError(
1986
 
                'data must be plain bytes was %s' % type(raw_data))
1987
 
        result = []
1988
 
        offset = 0
1989
 
        for key, size in key_sizes:
1990
 
            p_offset, p_length = self._container_writer.add_bytes_record(
1991
 
                raw_data[offset:offset+size], [])
1992
 
            offset += size
1993
 
            result.append((self._write_index, p_offset, p_length))
1994
 
        return result
1995
 
 
1996
 
    def flush(self):
1997
 
        """Flush pending writes on this access object.
1998
 
 
1999
 
        This will flush any buffered writes to a NewPack.
2000
 
        """
2001
 
        if self._flush_func is not None:
2002
 
            self._flush_func()
2003
 
 
2004
 
    def get_raw_records(self, memos_for_retrieval):
2005
 
        """Get the raw bytes for a records.
2006
 
 
2007
 
        :param memos_for_retrieval: An iterable containing the (index, pos,
2008
 
            length) memo for retrieving the bytes. The Pack access method
2009
 
            looks up the pack to use for a given record in its index_to_pack
2010
 
            map.
2011
 
        :return: An iterator over the bytes of the records.
2012
 
        """
2013
 
        # first pass, group into same-index requests
2014
 
        request_lists = []
2015
 
        current_index = None
2016
 
        for (index, offset, length) in memos_for_retrieval:
2017
 
            if current_index == index:
2018
 
                current_list.append((offset, length))
2019
 
            else:
2020
 
                if current_index is not None:
2021
 
                    request_lists.append((current_index, current_list))
2022
 
                current_index = index
2023
 
                current_list = [(offset, length)]
2024
 
        # handle the last entry
2025
 
        if current_index is not None:
2026
 
            request_lists.append((current_index, current_list))
2027
 
        for index, offsets in request_lists:
2028
 
            try:
2029
 
                transport, path = self._indices[index]
2030
 
            except KeyError:
2031
 
                # A KeyError here indicates that someone has triggered an index
2032
 
                # reload, and this index has gone missing, we need to start
2033
 
                # over.
2034
 
                if self._reload_func is None:
2035
 
                    # If we don't have a _reload_func there is nothing that can
2036
 
                    # be done
2037
 
                    raise
2038
 
                raise errors.RetryWithNewPacks(index,
2039
 
                                               reload_occurred=True,
2040
 
                                               exc_info=sys.exc_info())
2041
 
            try:
2042
 
                reader = pack.make_readv_reader(transport, path, offsets)
2043
 
                for names, read_func in reader.iter_records():
2044
 
                    yield read_func(None)
2045
 
            except errors.NoSuchFile:
2046
 
                # A NoSuchFile error indicates that a pack file has gone
2047
 
                # missing on disk, we need to trigger a reload, and start over.
2048
 
                if self._reload_func is None:
2049
 
                    raise
2050
 
                raise errors.RetryWithNewPacks(transport.abspath(path),
2051
 
                                               reload_occurred=False,
2052
 
                                               exc_info=sys.exc_info())
2053
 
 
2054
 
    def set_writer(self, writer, index, transport_packname):
2055
 
        """Set a writer to use for adding data."""
2056
 
        if index is not None:
2057
 
            self._indices[index] = transport_packname
2058
 
        self._container_writer = writer
2059
 
        self._write_index = index
2060
 
 
2061
 
    def reload_or_raise(self, retry_exc):
2062
 
        """Try calling the reload function, or re-raise the original exception.
2063
 
 
2064
 
        This should be called after _DirectPackAccess raises a
2065
 
        RetryWithNewPacks exception. This function will handle the common logic
2066
 
        of determining when the error is fatal versus being temporary.
2067
 
        It will also make sure that the original exception is raised, rather
2068
 
        than the RetryWithNewPacks exception.
2069
 
 
2070
 
        If this function returns, then the calling function should retry
2071
 
        whatever operation was being performed. Otherwise an exception will
2072
 
        be raised.
2073
 
 
2074
 
        :param retry_exc: A RetryWithNewPacks exception.
2075
 
        """
2076
 
        is_error = False
2077
 
        if self._reload_func is None:
2078
 
            is_error = True
2079
 
        elif not self._reload_func():
2080
 
            # The reload claimed that nothing changed
2081
 
            if not retry_exc.reload_occurred:
2082
 
                # If there wasn't an earlier reload, then we really were
2083
 
                # expecting to find changes. We didn't find them, so this is a
2084
 
                # hard error
2085
 
                is_error = True
2086
 
        if is_error:
2087
 
            exc_class, exc_value, exc_traceback = retry_exc.exc_info
2088
 
            raise exc_class, exc_value, exc_traceback
2089
 
 
2090
 
 
2091
 
 
 
1796
class RepositoryFormatKnitPack1(RepositoryFormatPack):
 
1797
    """A no-subtrees parameterised Pack repository.
 
1798
 
 
1799
    This format was introduced in 0.92.
 
1800
    """
 
1801
 
 
1802
    repository_class = KnitPackRepository
 
1803
    _commit_builder_class = PackCommitBuilder
 
1804
    _serializer = xml5.serializer_v5
 
1805
 
 
1806
    def _get_matching_bzrdir(self):
 
1807
        return bzrdir.format_registry.make_bzrdir('knitpack-experimental')
 
1808
 
 
1809
    def _ignore_setting_bzrdir(self, format):
 
1810
        pass
 
1811
 
 
1812
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
 
1813
 
 
1814
    def get_format_string(self):
 
1815
        """See RepositoryFormat.get_format_string()."""
 
1816
        return "Bazaar pack repository format 1 (needs bzr 0.92)\n"
 
1817
 
 
1818
    def get_format_description(self):
 
1819
        """See RepositoryFormat.get_format_description()."""
 
1820
        return "Packs containing knits without subtree support"
 
1821
 
 
1822
    def check_conversion_target(self, target_format):
 
1823
        pass
 
1824
 
 
1825
 
 
1826
class RepositoryFormatKnitPack3(RepositoryFormatPack):
 
1827
    """A subtrees parameterised Pack repository.
 
1828
 
 
1829
    This repository format uses the xml7 serializer to get:
 
1830
     - support for recording full info about the tree root
 
1831
     - support for recording tree-references
 
1832
 
 
1833
    This format was introduced in 0.92.
 
1834
    """
 
1835
 
 
1836
    repository_class = KnitPackRepository
 
1837
    _commit_builder_class = PackRootCommitBuilder
 
1838
    rich_root_data = True
 
1839
    supports_tree_reference = True
 
1840
    _serializer = xml7.serializer_v7
 
1841
 
 
1842
    def _get_matching_bzrdir(self):
 
1843
        return bzrdir.format_registry.make_bzrdir(
 
1844
            'knitpack-subtree-experimental')
 
1845
 
 
1846
    def _ignore_setting_bzrdir(self, format):
 
1847
        pass
 
1848
 
 
1849
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
 
1850
 
 
1851
    def check_conversion_target(self, target_format):
 
1852
        if not target_format.rich_root_data:
 
1853
            raise errors.BadConversionTarget(
 
1854
                'Does not support rich root data.', target_format)
 
1855
        if not getattr(target_format, 'supports_tree_reference', False):
 
1856
            raise errors.BadConversionTarget(
 
1857
                'Does not support nested trees', target_format)
 
1858
            
 
1859
    def get_format_string(self):
 
1860
        """See RepositoryFormat.get_format_string()."""
 
1861
        return "Bazaar pack repository format 1 with subtree support (needs bzr 0.92)\n"
 
1862
 
 
1863
    def get_format_description(self):
 
1864
        """See RepositoryFormat.get_format_description()."""
 
1865
        return "Packs containing knits with subtree support\n"