← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/reconcile.py

  • Committer: John Arbash Meinel
  • Date: 2006-09-20 14:51:03 UTC
  • mfrom: (0.8.23 version_info)
  • mto: This revision was merged to the branch mainline in revision 2028.
  • Revision ID: john@arbash-meinel.com-20060920145103-02725c6d6c886040
[merge] version-info plugin, and cleanup for layout in bzr

Show diffs side-by-side

added added

removed removed

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