~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/reconcile.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-04-09 20:23:07 UTC
  • mfrom: (4265.1.4 bbc-merge)
  • Revision ID: pqm@pqm.ubuntu.com-20090409202307-n0depb16qepoe21o
(jam) Change _fetch_uses_deltas = False for CHK repos until we can
        write a better fix.

Show diffs side-by-side

added added

removed removed

Lines of Context:
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
"""Reconcilers are able to fix some potential data errors in a branch."""
18
18
 
19
19
 
20
 
__all__ = ['reconcile', 'Reconciler', 'RepoReconciler', 'KnitReconciler']
21
 
 
22
 
 
23
 
from bzrlib import ui
24
 
from bzrlib.trace import mutter
 
20
__all__ = [
 
21
    'KnitReconciler',
 
22
    'PackReconciler',
 
23
    'reconcile',
 
24
    'Reconciler',
 
25
    'RepoReconciler',
 
26
    ]
 
27
 
 
28
 
 
29
from bzrlib import (
 
30
    errors,
 
31
    ui,
 
32
    repository,
 
33
    repofmt,
 
34
    )
 
35
from bzrlib.trace import mutter, note
25
36
from bzrlib.tsort import TopoSorter
 
37
from bzrlib.versionedfile import AdapterFactory, FulltextContentFactory
26
38
 
27
39
 
28
40
def reconcile(dir, other=None):
50
62
 
51
63
    def reconcile(self):
52
64
        """Perform reconciliation.
53
 
        
 
65
 
54
66
        After reconciliation the following attributes document found issues:
55
67
        inconsistent_parents: The number of revisions in the repository whose
56
68
                              ancestry was being reported incorrectly.
57
69
        garbage_inventories: The number of inventory objects without revisions
58
70
                             that were garbage collected.
 
71
        fixed_branch_history: None if there was no branch, False if the branch
 
72
                              history was correct, True if the branch history
 
73
                              needed to be re-normalized.
59
74
        """
60
75
        self.pb = ui.ui_factory.nested_progress_bar()
61
76
        try:
65
80
 
66
81
    def _reconcile(self):
67
82
        """Helper function for performing reconciliation."""
 
83
        self._reconcile_branch()
 
84
        self._reconcile_repository()
 
85
 
 
86
    def _reconcile_branch(self):
 
87
        try:
 
88
            self.branch = self.bzrdir.open_branch()
 
89
        except errors.NotBranchError:
 
90
            # Nothing to check here
 
91
            self.fixed_branch_history = None
 
92
            return
 
93
        self.pb.note('Reconciling branch %s',
 
94
                     self.branch.base)
 
95
        branch_reconciler = self.branch.reconcile(thorough=True)
 
96
        self.fixed_branch_history = branch_reconciler.fixed_history
 
97
 
 
98
    def _reconcile_repository(self):
68
99
        self.repo = self.bzrdir.find_repository()
69
100
        self.pb.note('Reconciling repository %s',
70
101
                     self.repo.bzrdir.root_transport.base)
 
102
        self.pb.update("Reconciling repository", 0, 1)
71
103
        repo_reconciler = self.repo.reconcile(thorough=True)
72
104
        self.inconsistent_parents = repo_reconciler.inconsistent_parents
73
105
        self.garbage_inventories = repo_reconciler.garbage_inventories
74
 
        self.pb.note('Reconciliation complete.')
 
106
        if repo_reconciler.aborted:
 
107
            self.pb.note(
 
108
                'Reconcile aborted: revision index has inconsistent parents.')
 
109
            self.pb.note(
 
110
                'Run "bzr check" for more details.')
 
111
        else:
 
112
            self.pb.note('Reconciliation complete.')
 
113
 
 
114
 
 
115
class BranchReconciler(object):
 
116
    """Reconciler that works on a branch."""
 
117
 
 
118
    def __init__(self, a_branch, thorough=False):
 
119
        self.fixed_history = None
 
120
        self.thorough = thorough
 
121
        self.branch = a_branch
 
122
 
 
123
    def reconcile(self):
 
124
        self.branch.lock_write()
 
125
        try:
 
126
            self.pb = ui.ui_factory.nested_progress_bar()
 
127
            try:
 
128
                self._reconcile_steps()
 
129
            finally:
 
130
                self.pb.finished()
 
131
        finally:
 
132
            self.branch.unlock()
 
133
 
 
134
    def _reconcile_steps(self):
 
135
        self._reconcile_revision_history()
 
136
 
 
137
    def _reconcile_revision_history(self):
 
138
        repo = self.branch.repository
 
139
        last_revno, last_revision_id = self.branch.last_revision_info()
 
140
        real_history = list(repo.iter_reverse_revision_history(
 
141
                                last_revision_id))
 
142
        real_history.reverse()
 
143
        if last_revno != len(real_history):
 
144
            self.fixed_history = True
 
145
            # Technically for Branch5 formats, it is more efficient to use
 
146
            # set_revision_history, as this will regenerate it again.
 
147
            # Not really worth a whole BranchReconciler class just for this,
 
148
            # though.
 
149
            self.pb.note('Fixing last revision info %s => %s',
 
150
                         last_revno, len(real_history))
 
151
            self.branch.set_last_revision_info(len(real_history),
 
152
                                               last_revision_id)
 
153
        else:
 
154
            self.fixed_history = False
 
155
            self.pb.note('revision_history ok.')
75
156
 
76
157
 
77
158
class RepoReconciler(object):
78
159
    """Reconciler that reconciles a repository.
79
160
 
 
161
    The goal of repository reconciliation is to make any derived data
 
162
    consistent with the core data committed by a user. This can involve
 
163
    reindexing, or removing unreferenced data if that can interfere with
 
164
    queries in a given repository.
 
165
 
80
166
    Currently this consists of an inventory reweave with revision cross-checks.
81
167
    """
82
168
 
89
175
        """
90
176
        self.garbage_inventories = 0
91
177
        self.inconsistent_parents = 0
 
178
        self.aborted = False
92
179
        self.repo = repo
93
180
        self.thorough = thorough
94
181
 
95
182
    def reconcile(self):
96
183
        """Perform reconciliation.
97
 
        
 
184
 
98
185
        After reconciliation the following attributes document found issues:
99
186
        inconsistent_parents: The number of revisions in the repository whose
100
187
                              ancestry was being reported incorrectly.
117
204
 
118
205
    def _reweave_inventory(self):
119
206
        """Regenerate the inventory weave for the repository from scratch.
120
 
        
121
 
        This is a smart function: it will only do the reweave if doing it 
 
207
 
 
208
        This is a smart function: it will only do the reweave if doing it
122
209
        will correct data issues. The self.thorough flag controls whether
123
210
        only data-loss causing issues (!self.thorough) or all issues
124
211
        (self.thorough) are treated as requiring the reweave.
126
213
        # local because needing to know about WeaveFile is a wart we want to hide
127
214
        from bzrlib.weave import WeaveFile, Weave
128
215
        transaction = self.repo.get_transaction()
129
 
        self.pb.update('Reading inventory data.')
130
 
        self.inventory = self.repo.get_inventory_weave()
 
216
        self.pb.update('Reading inventory data')
 
217
        self.inventory = self.repo.inventories
 
218
        self.revisions = self.repo.revisions
131
219
        # the total set of revisions to process
132
 
        self.pending = set([rev_id for rev_id in self.repo._revision_store.all_revision_ids(transaction)])
 
220
        self.pending = set([key[-1] for key in self.revisions.keys()])
133
221
 
134
222
        # mapping from revision_id to parents
135
223
        self._rev_graph = {}
141
229
            # put a revision into the graph.
142
230
            self._graph_revision(rev_id)
143
231
        self._check_garbage_inventories()
144
 
        # if there are no inconsistent_parents and 
 
232
        # if there are no inconsistent_parents and
145
233
        # (no garbage inventories or we are not doing a thorough check)
146
 
        if (not self.inconsistent_parents and 
 
234
        if (not self.inconsistent_parents and
147
235
            (not self.garbage_inventories or not self.thorough)):
148
236
            self.pb.note('Inventory ok.')
149
237
            return
150
 
        self.pb.update('Backing up inventory...', 0, 0)
151
 
        self.repo.control_weaves.copy(self.inventory, 'inventory.backup', self.repo.get_transaction())
152
 
        self.pb.note('Backup Inventory created.')
153
 
        # asking for '' should never return a non-empty weave
154
 
        new_inventory_vf = self.repo.control_weaves.get_empty('inventory.new',
155
 
            self.repo.get_transaction())
 
238
        self.pb.update('Backing up inventory', 0, 0)
 
239
        self.repo._backup_inventory()
 
240
        self.pb.note('Backup inventory created.')
 
241
        new_inventories = self.repo._temp_inventories()
156
242
 
157
243
        # we have topological order of revisions and non ghost parents ready.
158
244
        self._setup_steps(len(self._rev_graph))
159
 
        for rev_id in TopoSorter(self._rev_graph.items()).iter_topo_order():
160
 
            parents = self._rev_graph[rev_id]
161
 
            # double check this really is in topological order.
162
 
            unavailable = [p for p in parents if p not in new_inventory_vf]
163
 
            assert len(unavailable) == 0
164
 
            # this entry has all the non ghost parents in the inventory
165
 
            # file already.
166
 
            self._reweave_step('adding inventories')
167
 
            if isinstance(new_inventory_vf, WeaveFile):
168
 
                # It's really a WeaveFile, but we call straight into the
169
 
                # Weave's add method to disable the auto-write-out behaviour.
170
 
                # This is done to avoid a revision_count * time-to-write additional overhead on 
171
 
                # reconcile.
172
 
                new_inventory_vf._check_write_ok()
173
 
                Weave._add_lines(new_inventory_vf, rev_id, parents, self.inventory.get_lines(rev_id),
174
 
                                 None)
175
 
            else:
176
 
                new_inventory_vf.add_lines(rev_id, parents, self.inventory.get_lines(rev_id))
177
 
 
178
 
        if isinstance(new_inventory_vf, WeaveFile):
179
 
            new_inventory_vf._save()
180
 
        # if this worked, the set of new_inventory_vf.names should equal
 
245
        revision_keys = [(rev_id,) for rev_id in
 
246
            TopoSorter(self._rev_graph.items()).iter_topo_order()]
 
247
        stream = self._change_inv_parents(
 
248
            self.inventory.get_record_stream(revision_keys, 'unordered', True),
 
249
            self._new_inv_parents,
 
250
            set(revision_keys))
 
251
        new_inventories.insert_record_stream(stream)
 
252
        # if this worked, the set of new_inventories.keys should equal
181
253
        # self.pending
182
 
        assert set(new_inventory_vf.versions()) == self.pending
 
254
        if not (set(new_inventories.keys()) ==
 
255
            set([(revid,) for revid in self.pending])):
 
256
            raise AssertionError()
183
257
        self.pb.update('Writing weave')
184
 
        self.repo.control_weaves.copy(new_inventory_vf, 'inventory', self.repo.get_transaction())
185
 
        self.repo.control_weaves.delete('inventory.new', self.repo.get_transaction())
 
258
        self.repo._activate_new_inventory()
186
259
        self.inventory = None
187
260
        self.pb.note('Inventory regenerated.')
188
261
 
 
262
    def _new_inv_parents(self, revision_key):
 
263
        """Lookup ghost-filtered parents for revision_key."""
 
264
        # Use the filtered ghostless parents list:
 
265
        return tuple([(revid,) for revid in self._rev_graph[revision_key[-1]]])
 
266
 
 
267
    def _change_inv_parents(self, stream, get_parents, all_revision_keys):
 
268
        """Adapt a record stream to reconcile the parents."""
 
269
        for record in stream:
 
270
            wanted_parents = get_parents(record.key)
 
271
            if wanted_parents and wanted_parents[0] not in all_revision_keys:
 
272
                # The check for the left most parent only handles knit
 
273
                # compressors, but this code only applies to knit and weave
 
274
                # repositories anyway.
 
275
                bytes = record.get_bytes_as('fulltext')
 
276
                yield FulltextContentFactory(record.key, wanted_parents, record.sha1, bytes)
 
277
            else:
 
278
                adapted_record = AdapterFactory(record.key, wanted_parents, record)
 
279
                yield adapted_record
 
280
            self._reweave_step('adding inventories')
 
281
 
189
282
    def _setup_steps(self, new_total):
190
283
        """Setup the markers we need to control the progress bar."""
191
284
        self.total = new_total
197
290
        # analyse revision id rev_id and put it in the stack.
198
291
        self._reweave_step('loading revisions')
199
292
        rev = self.repo.get_revision_reconcile(rev_id)
200
 
        assert rev.revision_id == rev_id
201
293
        parents = []
202
294
        for parent in rev.parent_ids:
203
295
            if self._parent_is_available(parent):
204
296
                parents.append(parent)
205
297
            else:
206
298
                mutter('found ghost %s', parent)
207
 
        self._rev_graph[rev_id] = parents   
208
 
        if self._parents_are_inconsistent(rev_id, parents):
209
 
            self.inconsistent_parents += 1
210
 
            mutter('Inconsistent inventory parents: id {%s} '
211
 
                   'inventory claims %r, '
212
 
                   'available parents are %r, '
213
 
                   'unavailable parents are %r',
214
 
                   rev_id, 
215
 
                   set(self.inventory.get_parents(rev_id)),
216
 
                   set(parents),
217
 
                   set(rev.parent_ids).difference(set(parents)))
218
 
 
219
 
    def _parents_are_inconsistent(self, rev_id, parents):
220
 
        """Return True if the parents list of rev_id does not match the weave.
221
 
 
222
 
        This detects inconsistencies based on the self.thorough value:
223
 
        if thorough is on, the first parent value is checked as well as ghost
224
 
        differences.
225
 
        Otherwise only the ghost differences are evaluated.
226
 
        """
227
 
        weave_parents = self.inventory.get_parents(rev_id)
228
 
        weave_missing_old_ghosts = set(weave_parents) != set(parents)
229
 
        first_parent_is_wrong = (
230
 
            len(weave_parents) and len(parents) and
231
 
            parents[0] != weave_parents[0])
232
 
        if self.thorough:
233
 
            return weave_missing_old_ghosts or first_parent_is_wrong
234
 
        else:
235
 
            return weave_missing_old_ghosts
 
299
        self._rev_graph[rev_id] = parents
236
300
 
237
301
    def _check_garbage_inventories(self):
238
302
        """Check for garbage inventories which we cannot trust
242
306
        """
243
307
        if not self.thorough:
244
308
            return
245
 
        inventories = set(self.inventory.versions())
246
 
        revisions = set(self._rev_graph.keys())
 
309
        inventories = set(self.inventory.keys())
 
310
        revisions = set(self.revisions.keys())
247
311
        garbage = inventories.difference(revisions)
248
312
        self.garbage_inventories = len(garbage)
249
 
        for revision_id in garbage:
250
 
            mutter('Garbage inventory {%s} found.', revision_id)
 
313
        for revision_key in garbage:
 
314
            mutter('Garbage inventory {%s} found.', revision_key[-1])
251
315
 
252
316
    def _parent_is_available(self, parent):
253
317
        """True if parent is a fully available revision
255
319
        A fully available revision has a inventory and a revision object in the
256
320
        repository.
257
321
        """
258
 
        return (parent in self._rev_graph or 
259
 
                (parent in self.inventory and self.repo.has_revision(parent)))
 
322
        if parent in self._rev_graph:
 
323
            return True
 
324
        inv_present = (1 == len(self.inventory.get_parent_map([(parent,)])))
 
325
        return (inv_present and self.repo.has_revision(parent))
260
326
 
261
327
    def _reweave_step(self, message):
262
328
        """Mark a single step of regeneration complete."""
267
333
class KnitReconciler(RepoReconciler):
268
334
    """Reconciler that reconciles a knit format repository.
269
335
 
270
 
    This will detect garbage inventories and remove them.
271
 
 
272
 
    Inconsistent parentage is checked for in the revision weave.
 
336
    This will detect garbage inventories and remove them in thorough mode.
273
337
    """
274
338
 
275
339
    def _reconcile_steps(self):
276
340
        """Perform the steps to reconcile this repository."""
277
341
        if self.thorough:
278
 
            self._load_indexes()
 
342
            try:
 
343
                self._load_indexes()
 
344
            except errors.BzrCheckError:
 
345
                self.aborted = True
 
346
                return
279
347
            # knits never suffer this
280
348
            self._gc_inventory()
 
349
            self._fix_text_parents()
281
350
 
282
351
    def _load_indexes(self):
283
352
        """Load indexes for the reconciliation."""
284
353
        self.transaction = self.repo.get_transaction()
285
 
        self.pb.update('Reading indexes.', 0, 2)
286
 
        self.inventory = self.repo.get_inventory_weave()
287
 
        self.pb.update('Reading indexes.', 1, 2)
288
 
        self.revisions = self.repo._revision_store.get_revision_file(self.transaction)
289
 
        self.pb.update('Reading indexes.', 2, 2)
 
354
        self.pb.update('Reading indexes', 0, 2)
 
355
        self.inventory = self.repo.inventories
 
356
        self.pb.update('Reading indexes', 1, 2)
 
357
        self.repo._check_for_inconsistent_revision_parents()
 
358
        self.revisions = self.repo.revisions
 
359
        self.pb.update('Reading indexes', 2, 2)
290
360
 
291
361
    def _gc_inventory(self):
292
362
        """Remove inventories that are not referenced from the revision store."""
293
 
        self.pb.update('Checking unused inventories.', 0, 1)
 
363
        self.pb.update('Checking unused inventories', 0, 1)
294
364
        self._check_garbage_inventories()
295
 
        self.pb.update('Checking unused inventories.', 1, 3)
 
365
        self.pb.update('Checking unused inventories', 1, 3)
296
366
        if not self.garbage_inventories:
297
367
            self.pb.note('Inventory ok.')
298
368
            return
299
 
        self.pb.update('Backing up inventory...', 0, 0)
300
 
        self.repo.control_weaves.copy(self.inventory, 'inventory.backup', self.transaction)
301
 
        self.pb.note('Backup Inventory created.')
 
369
        self.pb.update('Backing up inventory', 0, 0)
 
370
        self.repo._backup_inventory()
 
371
        self.pb.note('Backup Inventory created')
302
372
        # asking for '' should never return a non-empty weave
303
 
        new_inventory_vf = self.repo.control_weaves.get_empty('inventory.new',
304
 
            self.transaction)
305
 
 
 
373
        new_inventories = self.repo._temp_inventories()
306
374
        # we have topological order of revisions and non ghost parents ready.
307
 
        self._setup_steps(len(self.revisions))
308
 
        for rev_id in TopoSorter(self.revisions.get_graph().items()).iter_topo_order():
309
 
            parents = self.revisions.get_parents(rev_id)
310
 
            # double check this really is in topological order.
311
 
            unavailable = [p for p in parents if p not in new_inventory_vf]
312
 
            assert len(unavailable) == 0
313
 
            # this entry has all the non ghost parents in the inventory
314
 
            # file already.
315
 
            self._reweave_step('adding inventories')
316
 
            # ugly but needed, weaves are just way tooooo slow else.
317
 
            new_inventory_vf.add_lines(rev_id, parents, self.inventory.get_lines(rev_id))
318
 
 
 
375
        graph = self.revisions.get_parent_map(self.revisions.keys())
 
376
        revision_keys = list(TopoSorter(graph).iter_topo_order())
 
377
        revision_ids = [key[-1] for key in revision_keys]
 
378
        self._setup_steps(len(revision_keys))
 
379
        stream = self._change_inv_parents(
 
380
            self.inventory.get_record_stream(revision_keys, 'unordered', True),
 
381
            graph.__getitem__,
 
382
            set(revision_keys))
 
383
        new_inventories.insert_record_stream(stream)
319
384
        # if this worked, the set of new_inventory_vf.names should equal
320
 
        # self.pending
321
 
        assert set(new_inventory_vf.versions()) == set(self.revisions.versions())
 
385
        # the revisionds list
 
386
        if not(set(new_inventories.keys()) == set(revision_keys)):
 
387
            raise AssertionError()
322
388
        self.pb.update('Writing weave')
323
 
        self.repo.control_weaves.copy(new_inventory_vf, 'inventory', self.transaction)
324
 
        self.repo.control_weaves.delete('inventory.new', self.transaction)
 
389
        self.repo._activate_new_inventory()
325
390
        self.inventory = None
326
391
        self.pb.note('Inventory regenerated.')
327
392
 
328
 
    def _check_garbage_inventories(self):
329
 
        """Check for garbage inventories which we cannot trust
330
 
 
331
 
        We cant trust them because their pre-requisite file data may not
332
 
        be present - all we know is that their revision was not installed.
333
 
        """
334
 
        inventories = set(self.inventory.versions())
335
 
        revisions = set(self.revisions.versions())
336
 
        garbage = inventories.difference(revisions)
337
 
        self.garbage_inventories = len(garbage)
338
 
        for revision_id in garbage:
339
 
            mutter('Garbage inventory {%s} found.', revision_id)
 
393
    def _fix_text_parents(self):
 
394
        """Fix bad versionedfile parent entries.
 
395
 
 
396
        It is possible for the parents entry in a versionedfile entry to be
 
397
        inconsistent with the values in the revision and inventory.
 
398
 
 
399
        This method finds entries with such inconsistencies, corrects their
 
400
        parent lists, and replaces the versionedfile with a corrected version.
 
401
        """
 
402
        transaction = self.repo.get_transaction()
 
403
        versions = [key[-1] for key in self.revisions.keys()]
 
404
        mutter('Prepopulating revision text cache with %d revisions',
 
405
                len(versions))
 
406
        vf_checker = self.repo._get_versioned_file_checker()
 
407
        bad_parents, unused_versions = vf_checker.check_file_version_parents(
 
408
            self.repo.texts, self.pb)
 
409
        text_index = vf_checker.text_index
 
410
        per_id_bad_parents = {}
 
411
        for key in unused_versions:
 
412
            # Ensure that every file with unused versions gets rewritten.
 
413
            # NB: This is really not needed, reconcile != pack.
 
414
            per_id_bad_parents[key[0]] = {}
 
415
        # Generate per-knit/weave data.
 
416
        for key, details in bad_parents.iteritems():
 
417
            file_id = key[0]
 
418
            rev_id = key[1]
 
419
            knit_parents = tuple([parent[-1] for parent in details[0]])
 
420
            correct_parents = tuple([parent[-1] for parent in details[1]])
 
421
            file_details = per_id_bad_parents.setdefault(file_id, {})
 
422
            file_details[rev_id] = (knit_parents, correct_parents)
 
423
        file_id_versions = {}
 
424
        for text_key in text_index:
 
425
            versions_list = file_id_versions.setdefault(text_key[0], [])
 
426
            versions_list.append(text_key[1])
 
427
        # Do the reconcile of individual weaves.
 
428
        for num, file_id in enumerate(per_id_bad_parents):
 
429
            self.pb.update('Fixing text parents', num,
 
430
                           len(per_id_bad_parents))
 
431
            versions_with_bad_parents = per_id_bad_parents[file_id]
 
432
            id_unused_versions = set(key[-1] for key in unused_versions
 
433
                if key[0] == file_id)
 
434
            if file_id in file_id_versions:
 
435
                file_versions = file_id_versions[file_id]
 
436
            else:
 
437
                # This id was present in the disk store but is not referenced
 
438
                # by any revision at all.
 
439
                file_versions = []
 
440
            self._fix_text_parent(file_id, versions_with_bad_parents,
 
441
                 id_unused_versions, file_versions)
 
442
 
 
443
    def _fix_text_parent(self, file_id, versions_with_bad_parents,
 
444
            unused_versions, all_versions):
 
445
        """Fix bad versionedfile entries in a single versioned file."""
 
446
        mutter('fixing text parent: %r (%d versions)', file_id,
 
447
                len(versions_with_bad_parents))
 
448
        mutter('(%d are unused)', len(unused_versions))
 
449
        new_file_id = 'temp:%s' % file_id
 
450
        new_parents = {}
 
451
        needed_keys = set()
 
452
        for version in all_versions:
 
453
            if version in unused_versions:
 
454
                continue
 
455
            elif version in versions_with_bad_parents:
 
456
                parents = versions_with_bad_parents[version][1]
 
457
            else:
 
458
                pmap = self.repo.texts.get_parent_map([(file_id, version)])
 
459
                parents = [key[-1] for key in pmap[(file_id, version)]]
 
460
            new_parents[(new_file_id, version)] = [
 
461
                (new_file_id, parent) for parent in parents]
 
462
            needed_keys.add((file_id, version))
 
463
        def fix_parents(stream):
 
464
            for record in stream:
 
465
                bytes = record.get_bytes_as('fulltext')
 
466
                new_key = (new_file_id, record.key[-1])
 
467
                parents = new_parents[new_key]
 
468
                yield FulltextContentFactory(new_key, parents, record.sha1, bytes)
 
469
        stream = self.repo.texts.get_record_stream(needed_keys, 'topological', True)
 
470
        self.repo._remove_file_id(new_file_id)
 
471
        self.repo.texts.insert_record_stream(fix_parents(stream))
 
472
        self.repo._remove_file_id(file_id)
 
473
        if len(new_parents):
 
474
            self.repo._move_file_id(new_file_id, file_id)
 
475
 
 
476
 
 
477
class PackReconciler(RepoReconciler):
 
478
    """Reconciler that reconciles a pack based repository.
 
479
 
 
480
    Garbage inventories do not affect ancestry queries, and removal is
 
481
    considerably more expensive as there is no separate versioned file for
 
482
    them, so they are not cleaned. In short it is currently a no-op.
 
483
 
 
484
    In future this may be a good place to hook in annotation cache checking,
 
485
    index recreation etc.
 
486
    """
 
487
 
 
488
    # XXX: The index corruption that _fix_text_parents performs is needed for
 
489
    # packs, but not yet implemented. The basic approach is to:
 
490
    #  - lock the names list
 
491
    #  - perform a customised pack() that regenerates data as needed
 
492
    #  - unlock the names list
 
493
    # https://bugs.edge.launchpad.net/bzr/+bug/154173
 
494
 
 
495
    def _reconcile_steps(self):
 
496
        """Perform the steps to reconcile this repository."""
 
497
        if not self.thorough:
 
498
            return
 
499
        collection = self.repo._pack_collection
 
500
        collection.ensure_loaded()
 
501
        collection.lock_names()
 
502
        try:
 
503
            packs = collection.all_packs()
 
504
            all_revisions = self.repo.all_revision_ids()
 
505
            total_inventories = len(list(
 
506
                collection.inventory_index.combined_index.iter_all_entries()))
 
507
            if len(all_revisions):
 
508
                new_pack =  self.repo._reconcile_pack(collection, packs,
 
509
                    ".reconcile", all_revisions, self.pb)
 
510
                if new_pack is not None:
 
511
                    self._discard_and_save(packs)
 
512
            else:
 
513
                # only make a new pack when there is data to copy.
 
514
                self._discard_and_save(packs)
 
515
            self.garbage_inventories = total_inventories - len(list(
 
516
                collection.inventory_index.combined_index.iter_all_entries()))
 
517
        finally:
 
518
            collection._unlock_names()
 
519
 
 
520
    def _discard_and_save(self, packs):
 
521
        """Discard some packs from the repository.
 
522
 
 
523
        This removes them from the memory index, saves the in-memory index
 
524
        which makes the newly reconciled pack visible and hides the packs to be
 
525
        discarded, and finally renames the packs being discarded into the
 
526
        obsolete packs directory.
 
527
 
 
528
        :param packs: The packs to discard.
 
529
        """
 
530
        for pack in packs:
 
531
            self.repo._pack_collection._remove_pack_from_memory(pack)
 
532
        self.repo._pack_collection._save_pack_names()
 
533
        self.repo._pack_collection._obsolete_packs(packs)