← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/reconcile.py

  • Committer: Ian Clatworthy
  • Date: 2007-08-13 14:16:53 UTC
  • mto: (2733.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 2734.
  • Revision ID: ian.clatworthy@internode.on.net-20070813141653-3cbrp00xowq58zv1
Added mini tutorial

Show diffs side-by-side

added added

removed removed

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