81
66
def _reconcile(self):
82
67
"""Helper function for performing reconciliation."""
83
self._reconcile_branch()
84
self._reconcile_repository()
86
def _reconcile_branch(self):
88
self.branch = self.bzrdir.open_branch()
89
except errors.NotBranchError:
90
# Nothing to check here
91
self.fixed_branch_history = None
93
self.pb.note('Reconciling branch %s',
95
branch_reconciler = self.branch.reconcile(thorough=True)
96
self.fixed_branch_history = branch_reconciler.fixed_history
98
def _reconcile_repository(self):
99
68
self.repo = self.bzrdir.find_repository()
100
69
self.pb.note('Reconciling repository %s',
101
70
self.repo.bzrdir.root_transport.base)
102
self.pb.update("Reconciling repository", 0, 1)
103
71
repo_reconciler = self.repo.reconcile(thorough=True)
104
72
self.inconsistent_parents = repo_reconciler.inconsistent_parents
105
73
self.garbage_inventories = repo_reconciler.garbage_inventories
106
if repo_reconciler.aborted:
108
'Reconcile aborted: revision index has inconsistent parents.')
110
'Run "bzr check" for more details.')
112
self.pb.note('Reconciliation complete.')
115
class BranchReconciler(object):
116
"""Reconciler that works on a branch."""
118
def __init__(self, a_branch, thorough=False):
119
self.fixed_history = None
120
self.thorough = thorough
121
self.branch = a_branch
124
self.branch.lock_write()
126
self.pb = ui.ui_factory.nested_progress_bar()
128
self._reconcile_steps()
134
def _reconcile_steps(self):
135
self._reconcile_revision_history()
137
def _reconcile_revision_history(self):
138
repo = self.branch.repository
139
last_revno, last_revision_id = self.branch.last_revision_info()
142
for revid in repo.iter_reverse_revision_history(
144
real_history.append(revid)
145
except errors.RevisionNotPresent:
146
pass # Hit a ghost left hand parent
147
real_history.reverse()
148
if last_revno != len(real_history):
149
self.fixed_history = True
150
# Technically for Branch5 formats, it is more efficient to use
151
# set_revision_history, as this will regenerate it again.
152
# Not really worth a whole BranchReconciler class just for this,
154
self.pb.note('Fixing last revision info %s => %s',
155
last_revno, len(real_history))
156
self.branch.set_last_revision_info(len(real_history),
159
self.fixed_history = False
160
self.pb.note('revision_history ok.')
74
self.pb.note('Reconciliation complete.')
163
77
class RepoReconciler(object):
164
78
"""Reconciler that reconciles a repository.
166
The goal of repository reconciliation is to make any derived data
167
consistent with the core data committed by a user. This can involve
168
reindexing, or removing unreferenced data if that can interfere with
169
queries in a given repository.
171
80
Currently this consists of an inventory reweave with revision cross-checks.
234
141
# put a revision into the graph.
235
142
self._graph_revision(rev_id)
236
143
self._check_garbage_inventories()
237
# if there are no inconsistent_parents and
144
# if there are no inconsistent_parents and
238
145
# (no garbage inventories or we are not doing a thorough check)
239
if (not self.inconsistent_parents and
146
if (not self.inconsistent_parents and
240
147
(not self.garbage_inventories or not self.thorough)):
241
148
self.pb.note('Inventory ok.')
243
self.pb.update('Backing up inventory', 0, 0)
244
self.repo._backup_inventory()
245
self.pb.note('Backup inventory created.')
246
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())
248
157
# we have topological order of revisions and non ghost parents ready.
249
158
self._setup_steps(len(self._rev_graph))
250
revision_keys = [(rev_id,) for rev_id in topo_sort(self._rev_graph)]
251
stream = self._change_inv_parents(
252
self.inventory.get_record_stream(revision_keys, 'unordered', True),
253
self._new_inv_parents,
255
new_inventories.insert_record_stream(stream)
256
# 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
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
172
new_inventory_vf._check_write_ok()
173
Weave._add_lines(new_inventory_vf, rev_id, parents, self.inventory.get_lines(rev_id),
176
new_inventory_vf.add_lines(rev_id, parents, self.inventory.get_lines(rev_id))
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
258
if not (set(new_inventories.keys()) ==
259
set([(revid,) for revid in self.pending])):
260
raise AssertionError()
182
assert set(new_inventory_vf.versions()) == self.pending
261
183
self.pb.update('Writing weave')
262
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())
263
186
self.inventory = None
264
187
self.pb.note('Inventory regenerated.')
266
def _new_inv_parents(self, revision_key):
267
"""Lookup ghost-filtered parents for revision_key."""
268
# Use the filtered ghostless parents list:
269
return tuple([(revid,) for revid in self._rev_graph[revision_key[-1]]])
271
def _change_inv_parents(self, stream, get_parents, all_revision_keys):
272
"""Adapt a record stream to reconcile the parents."""
273
for record in stream:
274
wanted_parents = get_parents(record.key)
275
if wanted_parents and wanted_parents[0] not in all_revision_keys:
276
# The check for the left most parent only handles knit
277
# compressors, but this code only applies to knit and weave
278
# repositories anyway.
279
bytes = record.get_bytes_as('fulltext')
280
yield FulltextContentFactory(record.key, wanted_parents, record.sha1, bytes)
282
adapted_record = AdapterFactory(record.key, wanted_parents, record)
284
self._reweave_step('adding inventories')
286
189
def _setup_steps(self, new_total):
287
190
"""Setup the markers we need to control the progress bar."""
288
191
self.total = new_total
337
267
class KnitReconciler(RepoReconciler):
338
268
"""Reconciler that reconciles a knit format repository.
340
This will detect garbage inventories and remove them in thorough mode.
270
This will detect garbage inventories and remove them.
272
Inconsistent parentage is checked for in the revision weave.
343
275
def _reconcile_steps(self):
344
276
"""Perform the steps to reconcile this repository."""
345
277
if self.thorough:
348
except errors.BzrCheckError:
351
279
# knits never suffer this
352
280
self._gc_inventory()
353
self._fix_text_parents()
355
282
def _load_indexes(self):
356
283
"""Load indexes for the reconciliation."""
357
284
self.transaction = self.repo.get_transaction()
358
self.pb.update('Reading indexes', 0, 2)
359
self.inventory = self.repo.inventories
360
self.pb.update('Reading indexes', 1, 2)
361
self.repo._check_for_inconsistent_revision_parents()
362
self.revisions = self.repo.revisions
363
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)
365
291
def _gc_inventory(self):
366
292
"""Remove inventories that are not referenced from the revision store."""
367
self.pb.update('Checking unused inventories', 0, 1)
293
self.pb.update('Checking unused inventories.', 0, 1)
368
294
self._check_garbage_inventories()
369
self.pb.update('Checking unused inventories', 1, 3)
295
self.pb.update('Checking unused inventories.', 1, 3)
370
296
if not self.garbage_inventories:
371
297
self.pb.note('Inventory ok.')
373
self.pb.update('Backing up inventory', 0, 0)
374
self.repo._backup_inventory()
375
self.pb.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.')
376
302
# asking for '' should never return a non-empty weave
377
new_inventories = self.repo._temp_inventories()
303
new_inventory_vf = self.repo.control_weaves.get_empty('inventory.new',
378
306
# we have topological order of revisions and non ghost parents ready.
379
graph = self.revisions.get_parent_map(self.revisions.keys())
380
revision_keys = topo_sort(graph)
381
revision_ids = [key[-1] for key in revision_keys]
382
self._setup_steps(len(revision_keys))
383
stream = self._change_inv_parents(
384
self.inventory.get_record_stream(revision_keys, 'unordered', True),
387
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
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))
388
319
# if this worked, the set of new_inventory_vf.names should equal
389
# the revisionds list
390
if not(set(new_inventories.keys()) == set(revision_keys)):
391
raise AssertionError()
321
assert set(new_inventory_vf.versions()) == set(self.revisions.versions())
392
322
self.pb.update('Writing weave')
393
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)
394
325
self.inventory = None
395
326
self.pb.note('Inventory regenerated.')
397
def _fix_text_parents(self):
398
"""Fix bad versionedfile parent entries.
400
It is possible for the parents entry in a versionedfile entry to be
401
inconsistent with the values in the revision and inventory.
403
This method finds entries with such inconsistencies, corrects their
404
parent lists, and replaces the versionedfile with a corrected version.
406
transaction = self.repo.get_transaction()
407
versions = [key[-1] for key in self.revisions.keys()]
408
mutter('Prepopulating revision text cache with %d revisions',
410
vf_checker = self.repo._get_versioned_file_checker()
411
bad_parents, unused_versions = vf_checker.check_file_version_parents(
412
self.repo.texts, self.pb)
413
text_index = vf_checker.text_index
414
per_id_bad_parents = {}
415
for key in unused_versions:
416
# Ensure that every file with unused versions gets rewritten.
417
# NB: This is really not needed, reconcile != pack.
418
per_id_bad_parents[key[0]] = {}
419
# Generate per-knit/weave data.
420
for key, details in bad_parents.iteritems():
423
knit_parents = tuple([parent[-1] for parent in details[0]])
424
correct_parents = tuple([parent[-1] for parent in details[1]])
425
file_details = per_id_bad_parents.setdefault(file_id, {})
426
file_details[rev_id] = (knit_parents, correct_parents)
427
file_id_versions = {}
428
for text_key in text_index:
429
versions_list = file_id_versions.setdefault(text_key[0], [])
430
versions_list.append(text_key[1])
431
# Do the reconcile of individual weaves.
432
for num, file_id in enumerate(per_id_bad_parents):
433
self.pb.update('Fixing text parents', num,
434
len(per_id_bad_parents))
435
versions_with_bad_parents = per_id_bad_parents[file_id]
436
id_unused_versions = set(key[-1] for key in unused_versions
437
if key[0] == file_id)
438
if file_id in file_id_versions:
439
file_versions = file_id_versions[file_id]
441
# This id was present in the disk store but is not referenced
442
# by any revision at all.
444
self._fix_text_parent(file_id, versions_with_bad_parents,
445
id_unused_versions, file_versions)
447
def _fix_text_parent(self, file_id, versions_with_bad_parents,
448
unused_versions, all_versions):
449
"""Fix bad versionedfile entries in a single versioned file."""
450
mutter('fixing text parent: %r (%d versions)', file_id,
451
len(versions_with_bad_parents))
452
mutter('(%d are unused)', len(unused_versions))
453
new_file_id = 'temp:%s' % file_id
456
for version in all_versions:
457
if version in unused_versions:
459
elif version in versions_with_bad_parents:
460
parents = versions_with_bad_parents[version][1]
462
pmap = self.repo.texts.get_parent_map([(file_id, version)])
463
parents = [key[-1] for key in pmap[(file_id, version)]]
464
new_parents[(new_file_id, version)] = [
465
(new_file_id, parent) for parent in parents]
466
needed_keys.add((file_id, version))
467
def fix_parents(stream):
468
for record in stream:
469
bytes = record.get_bytes_as('fulltext')
470
new_key = (new_file_id, record.key[-1])
471
parents = new_parents[new_key]
472
yield FulltextContentFactory(new_key, parents, record.sha1, bytes)
473
stream = self.repo.texts.get_record_stream(needed_keys, 'topological', True)
474
self.repo._remove_file_id(new_file_id)
475
self.repo.texts.insert_record_stream(fix_parents(stream))
476
self.repo._remove_file_id(file_id)
478
self.repo._move_file_id(new_file_id, file_id)
481
class PackReconciler(RepoReconciler):
482
"""Reconciler that reconciles a pack based repository.
484
Garbage inventories do not affect ancestry queries, and removal is
485
considerably more expensive as there is no separate versioned file for
486
them, so they are not cleaned. In short it is currently a no-op.
488
In future this may be a good place to hook in annotation cache checking,
489
index recreation etc.
492
# XXX: The index corruption that _fix_text_parents performs is needed for
493
# packs, but not yet implemented. The basic approach is to:
494
# - lock the names list
495
# - perform a customised pack() that regenerates data as needed
496
# - unlock the names list
497
# https://bugs.edge.launchpad.net/bzr/+bug/154173
499
def _reconcile_steps(self):
500
"""Perform the steps to reconcile this repository."""
501
if not self.thorough:
503
collection = self.repo._pack_collection
504
collection.ensure_loaded()
505
collection.lock_names()
507
packs = collection.all_packs()
508
all_revisions = self.repo.all_revision_ids()
509
total_inventories = len(list(
510
collection.inventory_index.combined_index.iter_all_entries()))
511
if len(all_revisions):
512
new_pack = self.repo._reconcile_pack(collection, packs,
513
".reconcile", all_revisions, self.pb)
514
if new_pack is not None:
515
self._discard_and_save(packs)
517
# only make a new pack when there is data to copy.
518
self._discard_and_save(packs)
519
self.garbage_inventories = total_inventories - len(list(
520
collection.inventory_index.combined_index.iter_all_entries()))
522
collection._unlock_names()
524
def _discard_and_save(self, packs):
525
"""Discard some packs from the repository.
527
This removes them from the memory index, saves the in-memory index
528
which makes the newly reconciled pack visible and hides the packs to be
529
discarded, and finally renames the packs being discarded into the
530
obsolete packs directory.
532
:param packs: The packs to discard.
535
self.repo._pack_collection._remove_pack_from_memory(pack)
536
self.repo._pack_collection._save_pack_names()
537
self.repo._pack_collection._obsolete_packs(packs)
328
def _check_garbage_inventories(self):
329
"""Check for garbage inventories which we cannot trust
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.
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)