1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
|
# Copyright (C) 2005, 2006 Canonical Ltd
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
"""Reconcilers are able to fix some potential data errors in a branch."""
__all__ = [
'KnitReconciler',
'PackReconciler',
'reconcile',
'Reconciler',
'RepoReconciler',
]
from bzrlib import (
errors,
ui,
repository,
)
from bzrlib.trace import mutter, note
from bzrlib.tsort import TopoSorter
def reconcile(dir, other=None):
"""Reconcile the data in dir.
Currently this is limited to a inventory 'reweave'.
This is a convenience method, for using a Reconciler object.
Directly using Reconciler is recommended for library users that
desire fine grained control or analysis of the found issues.
:param other: another bzrdir to reconcile against.
"""
reconciler = Reconciler(dir, other=other)
reconciler.reconcile()
class Reconciler(object):
"""Reconcilers are used to reconcile existing data."""
def __init__(self, dir, other=None):
"""Create a Reconciler."""
self.bzrdir = dir
def reconcile(self):
"""Perform reconciliation.
After reconciliation the following attributes document found issues:
inconsistent_parents: The number of revisions in the repository whose
ancestry was being reported incorrectly.
garbage_inventories: The number of inventory objects without revisions
that were garbage collected.
"""
self.pb = ui.ui_factory.nested_progress_bar()
try:
self._reconcile()
finally:
self.pb.finished()
def _reconcile(self):
"""Helper function for performing reconciliation."""
self.repo = self.bzrdir.find_repository()
self.pb.note('Reconciling repository %s',
self.repo.bzrdir.root_transport.base)
repo_reconciler = self.repo.reconcile(thorough=True)
self.inconsistent_parents = repo_reconciler.inconsistent_parents
self.garbage_inventories = repo_reconciler.garbage_inventories
if repo_reconciler.aborted:
self.pb.note(
'Reconcile aborted: revision index has inconsistent parents.')
self.pb.note(
'Run "bzr check" for more details.')
else:
self.pb.note('Reconciliation complete.')
class RepoReconciler(object):
"""Reconciler that reconciles a repository.
The goal of repository reconciliation is to make any derived data
consistent with the core data committed by a user. This can involve
reindexing, or removing unreferenced data if that can interfere with
queries in a given repository.
Currently this consists of an inventory reweave with revision cross-checks.
"""
def __init__(self, repo, other=None, thorough=False):
"""Construct a RepoReconciler.
:param thorough: perform a thorough check which may take longer but
will correct non-data loss issues such as incorrect
cached data.
"""
self.garbage_inventories = 0
self.inconsistent_parents = 0
self.aborted = False
self.repo = repo
self.thorough = thorough
def reconcile(self):
"""Perform reconciliation.
After reconciliation the following attributes document found issues:
inconsistent_parents: The number of revisions in the repository whose
ancestry was being reported incorrectly.
garbage_inventories: The number of inventory objects without revisions
that were garbage collected.
"""
self.repo.lock_write()
try:
self.pb = ui.ui_factory.nested_progress_bar()
try:
self._reconcile_steps()
finally:
self.pb.finished()
finally:
self.repo.unlock()
def _reconcile_steps(self):
"""Perform the steps to reconcile this repository."""
self._reweave_inventory()
def _reweave_inventory(self):
"""Regenerate the inventory weave for the repository from scratch.
This is a smart function: it will only do the reweave if doing it
will correct data issues. The self.thorough flag controls whether
only data-loss causing issues (!self.thorough) or all issues
(self.thorough) are treated as requiring the reweave.
"""
# local because needing to know about WeaveFile is a wart we want to hide
from bzrlib.weave import WeaveFile, Weave
transaction = self.repo.get_transaction()
self.pb.update('Reading inventory data.')
self.inventory = self.repo.get_inventory_weave()
# the total set of revisions to process
self.pending = set([rev_id for rev_id in self.repo._revision_store.all_revision_ids(transaction)])
# mapping from revision_id to parents
self._rev_graph = {}
# errors that we detect
self.inconsistent_parents = 0
# we need the revision id of each revision and its available parents list
self._setup_steps(len(self.pending))
for rev_id in self.pending:
# put a revision into the graph.
self._graph_revision(rev_id)
self._check_garbage_inventories()
# if there are no inconsistent_parents and
# (no garbage inventories or we are not doing a thorough check)
if (not self.inconsistent_parents and
(not self.garbage_inventories or not self.thorough)):
self.pb.note('Inventory ok.')
return
self.pb.update('Backing up inventory...', 0, 0)
self.repo.control_weaves.copy(self.inventory, 'inventory.backup', self.repo.get_transaction())
self.pb.note('Backup Inventory created.')
# asking for '' should never return a non-empty weave
new_inventory_vf = self.repo.control_weaves.get_empty('inventory.new',
self.repo.get_transaction())
# we have topological order of revisions and non ghost parents ready.
self._setup_steps(len(self._rev_graph))
for rev_id in TopoSorter(self._rev_graph.items()).iter_topo_order():
parents = self._rev_graph[rev_id]
# double check this really is in topological order.
unavailable = [p for p in parents if p not in new_inventory_vf]
assert len(unavailable) == 0
# this entry has all the non ghost parents in the inventory
# file already.
self._reweave_step('adding inventories')
if isinstance(new_inventory_vf, WeaveFile):
# It's really a WeaveFile, but we call straight into the
# Weave's add method to disable the auto-write-out behaviour.
# This is done to avoid a revision_count * time-to-write additional overhead on
# reconcile.
new_inventory_vf._check_write_ok()
Weave._add_lines(new_inventory_vf, rev_id, parents,
self.inventory.get_lines(rev_id), None, None, None, False, True)
else:
new_inventory_vf.add_lines(rev_id, parents, self.inventory.get_lines(rev_id))
if isinstance(new_inventory_vf, WeaveFile):
new_inventory_vf._save()
# if this worked, the set of new_inventory_vf.names should equal
# self.pending
assert set(new_inventory_vf.versions()) == self.pending
self.pb.update('Writing weave')
self.repo.control_weaves.copy(new_inventory_vf, 'inventory', self.repo.get_transaction())
self.repo.control_weaves.delete('inventory.new', self.repo.get_transaction())
self.inventory = None
self.pb.note('Inventory regenerated.')
def _setup_steps(self, new_total):
"""Setup the markers we need to control the progress bar."""
self.total = new_total
self.count = 0
def _graph_revision(self, rev_id):
"""Load a revision into the revision graph."""
# pick a random revision
# analyse revision id rev_id and put it in the stack.
self._reweave_step('loading revisions')
rev = self.repo.get_revision_reconcile(rev_id)
assert rev.revision_id == rev_id
parents = []
for parent in rev.parent_ids:
if self._parent_is_available(parent):
parents.append(parent)
else:
mutter('found ghost %s', parent)
self._rev_graph[rev_id] = parents
if self._parents_are_inconsistent(rev_id, parents):
self.inconsistent_parents += 1
mutter('Inconsistent inventory parents: id {%s} '
'inventory claims %r, '
'available parents are %r, '
'unavailable parents are %r',
rev_id,
set(self.inventory.get_parents(rev_id)),
set(parents),
set(rev.parent_ids).difference(set(parents)))
def _parents_are_inconsistent(self, rev_id, parents):
"""Return True if the parents list of rev_id does not match the weave.
This detects inconsistencies based on the self.thorough value:
if thorough is on, the first parent value is checked as well as ghost
differences.
Otherwise only the ghost differences are evaluated.
"""
weave_parents = self.inventory.get_parents(rev_id)
weave_missing_old_ghosts = set(weave_parents) != set(parents)
first_parent_is_wrong = (
len(weave_parents) and len(parents) and
parents[0] != weave_parents[0])
if self.thorough:
return weave_missing_old_ghosts or first_parent_is_wrong
else:
return weave_missing_old_ghosts
def _check_garbage_inventories(self):
"""Check for garbage inventories which we cannot trust
We cant trust them because their pre-requisite file data may not
be present - all we know is that their revision was not installed.
"""
if not self.thorough:
return
inventories = set(self.inventory.versions())
revisions = set(self._rev_graph.keys())
garbage = inventories.difference(revisions)
self.garbage_inventories = len(garbage)
for revision_id in garbage:
mutter('Garbage inventory {%s} found.', revision_id)
def _parent_is_available(self, parent):
"""True if parent is a fully available revision
A fully available revision has a inventory and a revision object in the
repository.
"""
return (parent in self._rev_graph or
(parent in self.inventory and self.repo.has_revision(parent)))
def _reweave_step(self, message):
"""Mark a single step of regeneration complete."""
self.pb.update(message, self.count, self.total)
self.count += 1
class KnitReconciler(RepoReconciler):
"""Reconciler that reconciles a knit format repository.
This will detect garbage inventories and remove them in thorough mode.
"""
def _reconcile_steps(self):
"""Perform the steps to reconcile this repository."""
if self.thorough:
try:
self._load_indexes()
except errors.BzrCheckError:
self.aborted = True
return
# knits never suffer this
self._gc_inventory()
self._fix_text_parents()
def _load_indexes(self):
"""Load indexes for the reconciliation."""
self.transaction = self.repo.get_transaction()
self.pb.update('Reading indexes.', 0, 2)
self.inventory = self.repo.get_inventory_weave()
self.pb.update('Reading indexes.', 1, 2)
self.repo._check_for_inconsistent_revision_parents()
self.revisions = self.repo._revision_store.get_revision_file(self.transaction)
self.pb.update('Reading indexes.', 2, 2)
def _gc_inventory(self):
"""Remove inventories that are not referenced from the revision store."""
self.pb.update('Checking unused inventories.', 0, 1)
self._check_garbage_inventories()
self.pb.update('Checking unused inventories.', 1, 3)
if not self.garbage_inventories:
self.pb.note('Inventory ok.')
return
self.pb.update('Backing up inventory...', 0, 0)
self.repo.control_weaves.copy(self.inventory, 'inventory.backup', self.transaction)
self.pb.note('Backup Inventory created.')
# asking for '' should never return a non-empty weave
new_inventory_vf = self.repo.control_weaves.get_empty('inventory.new',
self.transaction)
# we have topological order of revisions and non ghost parents ready.
self._setup_steps(len(self.revisions))
for rev_id in TopoSorter(self.revisions.get_graph().items()).iter_topo_order():
parents = self.revisions.get_parents(rev_id)
# double check this really is in topological order.
unavailable = [p for p in parents if p not in new_inventory_vf]
assert len(unavailable) == 0
# this entry has all the non ghost parents in the inventory
# file already.
self._reweave_step('adding inventories')
# ugly but needed, weaves are just way tooooo slow else.
new_inventory_vf.add_lines(rev_id, parents, self.inventory.get_lines(rev_id))
# if this worked, the set of new_inventory_vf.names should equal
# self.pending
assert set(new_inventory_vf.versions()) == set(self.revisions.versions())
self.pb.update('Writing weave')
self.repo.control_weaves.copy(new_inventory_vf, 'inventory', self.transaction)
self.repo.control_weaves.delete('inventory.new', self.transaction)
self.inventory = None
self.pb.note('Inventory regenerated.')
def _check_garbage_inventories(self):
"""Check for garbage inventories which we cannot trust
We cant trust them because their pre-requisite file data may not
be present - all we know is that their revision was not installed.
"""
inventories = set(self.inventory.versions())
revisions = set(self.revisions.versions())
garbage = inventories.difference(revisions)
self.garbage_inventories = len(garbage)
for revision_id in garbage:
mutter('Garbage inventory {%s} found.', revision_id)
def _fix_text_parents(self):
"""Fix bad versionedfile parent entries.
It is possible for the parents entry in a versionedfile entry to be
inconsistent with the values in the revision and inventory.
This method finds entries with such inconsistencies, corrects their
parent lists, and replaces the versionedfile with a corrected version.
"""
transaction = self.repo.get_transaction()
revision_versions = repository._RevisionTextVersionCache(self.repo)
versions = self.revisions.versions()
mutter('Prepopulating revision text cache with %d revisions',
len(versions))
revision_versions.prepopulate_revs(versions)
used_file_versions = revision_versions.used_file_versions()
for num, file_id in enumerate(self.repo.weave_store):
self.pb.update('Fixing text parents', num,
len(self.repo.weave_store))
vf = self.repo.weave_store.get_weave(file_id, transaction)
vf_checker = self.repo.get_versioned_file_checker(
vf.versions(), revision_versions)
versions_with_bad_parents, dangling_file_versions = \
vf_checker.check_file_version_parents(vf, file_id)
if (len(versions_with_bad_parents) == 0 and
len(dangling_file_versions) == 0):
continue
full_text_versions = set()
unused_versions = set()
for dangling_version in dangling_file_versions:
version = dangling_version[1]
if dangling_version in used_file_versions:
# This version *is* used by some revision, even though it
# isn't used by its own revision! We make sure any
# revision referencing it is stored as a fulltext
# This avoids bug 155730: it means that clients looking at
# inventories to determine the versions to fetch will not
# miss a required version. (So clients can assume that if
# they have a complete revision graph, and fetch all file
# versions named by those revisions inventories, then they
# will not have any missing parents for 'delta' knit
# records.)
# XXX: A better, but more difficult and slower fix would be
# to rewrite the inventories referencing this version.
full_text_versions.add(version)
else:
# This version is totally unreferenced. It should be
# removed.
unused_versions.add(version)
self._fix_text_parent(file_id, vf, versions_with_bad_parents,
full_text_versions, unused_versions)
def _fix_text_parent(self, file_id, vf, versions_with_bad_parents,
full_text_versions, unused_versions):
"""Fix bad versionedfile entries in a single versioned file."""
mutter('fixing text parent: %r (%d versions)', file_id,
len(versions_with_bad_parents))
mutter('(%d need to be full texts, %d are unused)',
len(full_text_versions), len(unused_versions))
new_vf = self.repo.weave_store.get_empty('temp:%s' % file_id,
self.transaction)
new_parents = {}
for version in vf.versions():
if version in versions_with_bad_parents:
parents = versions_with_bad_parents[version][1]
else:
parents = vf.get_parents(version)
new_parents[version] = parents
for version in TopoSorter(new_parents.items()).iter_topo_order():
if version in unused_versions:
continue
lines = vf.get_lines(version)
parents = new_parents[version]
if parents and (parents[0] in full_text_versions):
# Force this record to be a fulltext, not a delta.
new_vf._add(version, lines, parents, False,
None, None, None, False)
else:
new_vf.add_lines(version, parents, lines)
self.repo.weave_store.copy(new_vf, file_id, self.transaction)
self.repo.weave_store.delete('temp:%s' % file_id, self.transaction)
class PackReconciler(RepoReconciler):
"""Reconciler that reconciles a pack based repository.
Garbage inventories do not affect ancestry queries, and removal is
considerably more expensive as there is no separate versioned file for
them, so they are not cleaned. In short it is currently a no-op.
In future this may be a good place to hook in annotation cache checking,
index recreation etc.
"""
# XXX: The index corruption that _fix_text_parents performs is needed for
# packs, but not yet implemented. The basic approach is to:
# - lock the names list
# - perform a customised pack() that regenerates data as needed
# - unlock the names list
# https://bugs.edge.launchpad.net/bzr/+bug/154173
def _reconcile_steps(self):
"""Perform the steps to reconcile this repository."""
|