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
17
17
from bzrlib.lazy_import import lazy_import
18
18
lazy_import(globals(), """
19
19
from bzrlib import (
22
from bzrlib.store import revision
23
from bzrlib.store.revision.knit import KnitRevisionStore
26
revision as _mod_revision,
38
38
from bzrlib.decorators import needs_read_lock, needs_write_lock
39
39
from bzrlib.repository import (
42
41
MetaDirRepositoryFormat,
45
import bzrlib.revision as _mod_revision
46
from bzrlib.store.versioned import VersionedFileStore
47
from bzrlib.trace import mutter, mutter_callsite
48
from bzrlib.util import bencode
48
51
class _KnitParentsProvider(object):
53
56
def __repr__(self):
54
57
return 'KnitParentsProvider(%r)' % self._knit
56
def get_parent_map(self, keys):
57
"""See graph.StackedParentsProvider.get_parent_map"""
59
for revision_id in keys:
60
if revision_id is None:
61
raise ValueError('get_parent_map(None) is not valid')
59
def get_parents(self, revision_ids):
61
for revision_id in revision_ids:
62
62
if revision_id == _mod_revision.NULL_REVISION:
63
parent_map[revision_id] = ()
67
self._knit.get_parents_with_ghosts(revision_id))
66
parents = self._knit.get_parents_with_ghosts(revision_id)
68
67
except errors.RevisionNotPresent:
71
70
if len(parents) == 0:
72
parents = (_mod_revision.NULL_REVISION,)
73
parent_map[revision_id] = parents
77
class _KnitsParentsProvider(object):
79
def __init__(self, knit, prefix=()):
80
"""Create a parent provider for string keys mapped to tuple keys."""
85
return 'KnitsParentsProvider(%r)' % self._knit
87
def get_parent_map(self, keys):
88
"""See graph.StackedParentsProvider.get_parent_map"""
89
parent_map = self._knit.get_parent_map(
90
[self._prefix + (key,) for key in keys])
92
for key, parents in parent_map.items():
95
parents = (_mod_revision.NULL_REVISION,)
97
parents = tuple(parent[-1] for parent in parents)
98
result[revid] = parents
99
for revision_id in keys:
100
if revision_id == _mod_revision.NULL_REVISION:
101
result[revision_id] = ()
71
parents = [_mod_revision.NULL_REVISION]
72
parents_list.append(parents)
105
76
class KnitRepository(MetaDirRepository):
106
77
"""Knit format repository."""
108
# These attributes are inherited from the Repository base class. Setting
109
# them to None ensures that if the constructor is changed to not initialize
110
# them, or a subclass fails to call the constructor, that an error will
111
# occur rather than the system working but generating incorrect data.
112
_commit_builder_class = None
115
def __init__(self, _format, a_bzrdir, control_files, _commit_builder_class,
117
MetaDirRepository.__init__(self, _format, a_bzrdir, control_files)
118
self._commit_builder_class = _commit_builder_class
119
self._serializer = _serializer
120
self._reconcile_fixes_text_parents = True
79
_serializer = xml5.serializer_v5
81
def _warn_if_deprecated(self):
82
# This class isn't deprecated
85
def _inventory_add_lines(self, inv_vf, revid, parents, lines, check_content):
86
return inv_vf.add_lines_with_ghosts(revid, parents, lines,
87
check_content=check_content)[0]
123
90
def _all_revision_ids(self):
124
91
"""See Repository.all_revision_ids()."""
125
return [key[0] for key in self.revisions.keys()]
127
def _activate_new_inventory(self):
128
"""Put a replacement inventory.new into use as inventories."""
129
# Copy the content across
131
t.copy('inventory.new.kndx', 'inventory.kndx')
133
t.copy('inventory.new.knit', 'inventory.knit')
134
except errors.NoSuchFile:
135
# empty inventories knit
136
t.delete('inventory.knit')
137
# delete the temp inventory
138
t.delete('inventory.new.kndx')
140
t.delete('inventory.new.knit')
141
except errors.NoSuchFile:
142
# empty inventories knit
144
# Force index reload (sanity check)
145
self.inventories._index._reset_cache()
146
self.inventories.keys()
148
def _backup_inventory(self):
150
t.copy('inventory.kndx', 'inventory.backup.kndx')
151
t.copy('inventory.knit', 'inventory.backup.knit')
153
def _move_file_id(self, from_id, to_id):
154
t = self._transport.clone('knits')
155
from_rel_url = self.texts._index._mapper.map((from_id, None))
156
to_rel_url = self.texts._index._mapper.map((to_id, None))
157
# We expect both files to always exist in this case.
158
for suffix in ('.knit', '.kndx'):
159
t.rename(from_rel_url + suffix, to_rel_url + suffix)
161
def _remove_file_id(self, file_id):
162
t = self._transport.clone('knits')
163
rel_url = self.texts._index._mapper.map((file_id, None))
164
for suffix in ('.kndx', '.knit'):
166
t.delete(rel_url + suffix)
167
except errors.NoSuchFile:
170
def _temp_inventories(self):
171
result = self._format._get_inventories(self._transport, self,
173
# Reconciling when the output has no revisions would result in no
174
# writes - but we want to ensure there is an inventory for
175
# compatibility with older clients that don't lazy-load.
176
result.get_parent_map([('A',)])
92
# Knits get the revision graph from the index of the revision knit, so
93
# it's always possible even if they're on an unlistable transport.
94
return self._revision_store.all_revision_ids(self.get_transaction())
179
96
def fileid_involved_between_revs(self, from_revid, to_revid):
180
97
"""Find file_id(s) which are involved in the changes between revisions.
202
121
return self._fileid_involved_by_set(changed)
124
def get_ancestry(self, revision_id, topo_sorted=True):
125
"""Return a list of revision-ids integrated by a revision.
127
This is topologically sorted, unless 'topo_sorted' is specified as
130
if _mod_revision.is_null(revision_id):
132
revision_id = osutils.safe_revision_id(revision_id)
133
vf = self._get_revision_vf()
135
return [None] + vf.get_ancestry(revision_id, topo_sorted)
136
except errors.RevisionNotPresent:
137
raise errors.NoSuchRevision(self, revision_id)
140
def get_data_stream(self, revision_ids):
141
"""See Repository.get_data_stream."""
142
item_keys = self.item_keys_introduced_by(revision_ids)
143
for knit_kind, file_id, versions in item_keys:
145
if knit_kind == 'file':
146
name = ('file', file_id)
147
knit = self.weave_store.get_weave_or_empty(
148
file_id, self.get_transaction())
149
elif knit_kind == 'inventory':
150
knit = self.get_inventory_weave()
151
elif knit_kind == 'revisions':
152
knit = self._revision_store.get_revision_file(
153
self.get_transaction())
154
elif knit_kind == 'signatures':
155
knit = self._revision_store.get_signature_file(
156
self.get_transaction())
158
raise AssertionError('Unknown knit kind %r' % (knit_kind,))
159
yield name, _get_stream_as_bytes(knit, versions)
205
162
def get_revision(self, revision_id):
206
163
"""Return the Revision object for a named revision"""
207
164
revision_id = osutils.safe_revision_id(revision_id)
208
165
return self.get_revision_reconcile(revision_id)
210
def _refresh_data(self):
211
if not self.is_locked():
213
# Create a new transaction to force all knits to see the scope change.
214
# This is safe because we're outside a write group.
215
self.control_files._finish_transaction()
216
if self.is_write_locked():
217
self.control_files._set_write_transaction()
219
self.control_files._set_read_transaction()
168
def get_revision_graph(self, revision_id=None):
169
"""Return a dictionary containing the revision graph.
171
:param revision_id: The revision_id to get a graph from. If None, then
172
the entire revision graph is returned. This is a deprecated mode of
173
operation and will be removed in the future.
174
:return: a dictionary of revision_id->revision_parents_list.
176
if 'evil' in debug.debug_flags:
178
"get_revision_graph scales with size of history.")
179
# special case NULL_REVISION
180
if revision_id == _mod_revision.NULL_REVISION:
182
revision_id = osutils.safe_revision_id(revision_id)
183
a_weave = self._get_revision_vf()
184
if revision_id is None:
185
return a_weave.get_graph()
186
if revision_id not in a_weave:
187
raise errors.NoSuchRevision(self, revision_id)
189
# add what can be reached from revision_id
190
return a_weave.get_graph([revision_id])
193
def get_revision_graph_with_ghosts(self, revision_ids=None):
194
"""Return a graph of the revisions with ghosts marked as applicable.
196
:param revision_ids: an iterable of revisions to graph or None for all.
197
:return: a Graph object with the graph reachable from revision_ids.
199
if 'evil' in debug.debug_flags:
201
"get_revision_graph_with_ghosts scales with size of history.")
202
result = deprecated_graph.Graph()
203
vf = self._get_revision_vf()
204
versions = set(vf.versions())
206
pending = set(self.all_revision_ids())
209
pending = set(osutils.safe_revision_id(r) for r in revision_ids)
210
# special case NULL_REVISION
211
if _mod_revision.NULL_REVISION in pending:
212
pending.remove(_mod_revision.NULL_REVISION)
213
required = set(pending)
216
revision_id = pending.pop()
217
if not revision_id in versions:
218
if revision_id in required:
219
raise errors.NoSuchRevision(self, revision_id)
221
result.add_ghost(revision_id)
222
# mark it as done so we don't try for it again.
223
done.add(revision_id)
225
parent_ids = vf.get_parents_with_ghosts(revision_id)
226
for parent_id in parent_ids:
227
# is this queued or done ?
228
if (parent_id not in pending and
229
parent_id not in done):
231
pending.add(parent_id)
232
result.add_node(revision_id, parent_ids)
233
done.add(revision_id)
236
def _get_revision_vf(self):
237
""":return: a versioned file containing the revisions."""
238
vf = self._revision_store.get_revision_file(self.get_transaction())
241
def _get_history_vf(self):
242
"""Get a versionedfile whose history graph reflects all revisions.
244
For knit repositories, this is the revision knit.
246
return self._get_revision_vf()
221
248
@needs_write_lock
222
249
def reconcile(self, other=None, thorough=False):
225
252
reconciler = KnitReconciler(self, thorough=thorough)
226
253
reconciler.reconcile()
227
254
return reconciler
256
def revision_parents(self, revision_id):
257
revision_id = osutils.safe_revision_id(revision_id)
258
return self._get_revision_vf().get_parents(revision_id)
229
260
def _make_parents_provider(self):
230
return _KnitsParentsProvider(self.revisions)
232
def _find_inconsistent_revision_parents(self, revisions_iterator=None):
233
"""Find revisions with different parent lists in the revision object
234
and in the index graph.
236
:param revisions_iterator: None, or an iterator of (revid,
237
Revision-or-None). This iterator controls the revisions checked.
238
:returns: an iterator yielding tuples of (revison-id, parents-in-index,
239
parents-in-revision).
241
if not self.is_locked():
242
raise AssertionError()
244
if revisions_iterator is None:
245
revisions_iterator = self._iter_revisions(None)
246
for revid, revision in revisions_iterator:
249
parent_map = vf.get_parent_map([(revid,)])
250
parents_according_to_index = tuple(parent[-1] for parent in
251
parent_map[(revid,)])
252
parents_according_to_revision = tuple(revision.parent_ids)
253
if parents_according_to_index != parents_according_to_revision:
254
yield (revid, parents_according_to_index,
255
parents_according_to_revision)
257
def _check_for_inconsistent_revision_parents(self):
258
inconsistencies = list(self._find_inconsistent_revision_parents())
260
raise errors.BzrCheckError(
261
"Revision knit has inconsistent parents.")
263
def revision_graph_can_have_wrong_parents(self):
264
# The revision.kndx could potentially claim a revision has a different
265
# parent to the revision text.
261
return _KnitParentsProvider(self._get_revision_vf())
264
class KnitRepository3(KnitRepository):
266
# knit3 repositories need a RootCommitBuilder
267
_commit_builder_class = RootCommitBuilder
269
def __init__(self, _format, a_bzrdir, control_files, _revision_store,
270
control_store, text_store):
271
KnitRepository.__init__(self, _format, a_bzrdir, control_files,
272
_revision_store, control_store, text_store)
273
self._serializer = xml7.serializer_v7
275
def deserialise_inventory(self, revision_id, xml):
276
"""Transform the xml into an inventory object.
278
:param revision_id: The expected revision id of the inventory.
279
:param xml: A serialised inventory.
281
result = self._serializer.read_inventory_from_string(xml)
282
assert result.root.revision is not None
285
def serialise_inventory(self, inv):
286
"""Transform the inventory object into XML text.
288
:param revision_id: The expected revision id of the inventory.
289
:param xml: A serialised inventory.
291
assert inv.revision_id is not None
292
assert inv.root.revision is not None
293
return KnitRepository.serialise_inventory(self, inv)
269
296
class RepositoryFormatKnit(MetaDirRepositoryFormat):
270
"""Bzr repository knit format (generalized).
297
"""Bzr repository knit format (generalized).
272
299
This repository format has:
273
300
- knits for file texts and inventory
283
310
# Set this attribute in derived classes to control the repository class
284
311
# created by open and initialize.
285
312
repository_class = None
286
# Set this attribute in derived classes to control the
287
# _commit_builder_class that the repository objects will have passed to
289
_commit_builder_class = None
290
# Set this attribute in derived clases to control the _serializer that the
291
# repository objects will have passed to their constructor.
293
def _serializer(self):
294
return xml5.serializer_v5
295
# Knit based repositories handle ghosts reasonably well.
296
supports_ghosts = True
297
# External lookups are not supported in this format.
298
supports_external_lookups = False
300
supports_chks = False
301
_fetch_order = 'topological'
302
_fetch_uses_deltas = True
305
def _get_inventories(self, repo_transport, repo, name='inventory'):
306
mapper = versionedfile.ConstantMapper(name)
307
index = _mod_knit._KndxIndex(repo_transport, mapper,
308
repo.get_transaction, repo.is_write_locked, repo.is_locked)
309
access = _mod_knit._KnitKeyAccess(repo_transport, mapper)
310
return _mod_knit.KnitVersionedFiles(index, access, annotated=False)
312
def _get_revisions(self, repo_transport, repo):
313
mapper = versionedfile.ConstantMapper('revisions')
314
index = _mod_knit._KndxIndex(repo_transport, mapper,
315
repo.get_transaction, repo.is_write_locked, repo.is_locked)
316
access = _mod_knit._KnitKeyAccess(repo_transport, mapper)
317
return _mod_knit.KnitVersionedFiles(index, access, max_delta_chain=0,
320
def _get_signatures(self, repo_transport, repo):
321
mapper = versionedfile.ConstantMapper('signatures')
322
index = _mod_knit._KndxIndex(repo_transport, mapper,
323
repo.get_transaction, repo.is_write_locked, repo.is_locked)
324
access = _mod_knit._KnitKeyAccess(repo_transport, mapper)
325
return _mod_knit.KnitVersionedFiles(index, access, max_delta_chain=0,
328
def _get_texts(self, repo_transport, repo):
329
mapper = versionedfile.HashEscapedPrefixMapper()
330
base_transport = repo_transport.clone('knits')
331
index = _mod_knit._KndxIndex(base_transport, mapper,
332
repo.get_transaction, repo.is_write_locked, repo.is_locked)
333
access = _mod_knit._KnitKeyAccess(base_transport, mapper)
334
return _mod_knit.KnitVersionedFiles(index, access, max_delta_chain=200,
314
def _get_control_store(self, repo_transport, control_files):
315
"""Return the control store for this repository."""
316
return VersionedFileStore(
319
file_mode=control_files._file_mode,
320
versionedfile_class=knit.KnitVersionedFile,
321
versionedfile_kwargs={'factory':knit.KnitPlainFactory()},
324
def _get_revision_store(self, repo_transport, control_files):
325
"""See RepositoryFormat._get_revision_store()."""
326
versioned_file_store = VersionedFileStore(
328
file_mode=control_files._file_mode,
331
versionedfile_class=knit.KnitVersionedFile,
332
versionedfile_kwargs={'delta':False,
333
'factory':knit.KnitPlainFactory(),
337
return KnitRevisionStore(versioned_file_store)
339
def _get_text_store(self, transport, control_files):
340
"""See RepositoryFormat._get_text_store()."""
341
return self._get_versioned_file_store('knits',
344
versionedfile_class=knit.KnitVersionedFile,
345
versionedfile_kwargs={
346
'create_parent_dir':True,
348
'dir_mode':control_files._dir_mode,
337
352
def initialize(self, a_bzrdir, shared=False):
338
353
"""Create a knit format 1 repository.
342
357
:param shared: If true the repository will be initialized as a shared
345
trace.mutter('creating repository in %s.', a_bzrdir.transport.base)
360
mutter('creating repository in %s.', a_bzrdir.transport.base)
348
363
utf8_files = [('format', self.get_format_string())]
350
365
self._upload_blank_content(a_bzrdir, dirs, files, utf8_files, shared)
351
366
repo_transport = a_bzrdir.get_repository_transport(None)
352
367
control_files = lockable_files.LockableFiles(repo_transport,
353
368
'lock', lockdir.LockDir)
369
control_store = self._get_control_store(repo_transport, control_files)
354
370
transaction = transactions.WriteTransaction()
355
result = self.open(a_bzrdir=a_bzrdir, _found=True)
371
# trigger a write of the inventory store.
372
control_store.get_weave_or_empty('inventory', transaction)
373
_revision_store = self._get_revision_store(repo_transport, control_files)
357
374
# the revision id here is irrelevant: it will not be stored, and cannot
358
# already exist, we do this to create files on disk for older clients.
359
result.inventories.get_parent_map([('A',)])
360
result.revisions.get_parent_map([('A',)])
361
result.signatures.get_parent_map([('A',)])
363
self._run_post_repo_init_hooks(result, a_bzrdir, shared)
376
_revision_store.has_revision_id('A', transaction)
377
_revision_store.get_signature_file(transaction)
378
return self.open(a_bzrdir=a_bzrdir, _found=True)
366
380
def open(self, a_bzrdir, _found=False, _override_transport=None):
367
381
"""See RepositoryFormat.open().
369
383
:param _override_transport: INTERNAL USE ONLY. Allows opening the
370
384
repository at a slightly different url
371
385
than normal. I.e. during 'upgrade'.
374
388
format = RepositoryFormat.find_format(a_bzrdir)
389
assert format.__class__ == self.__class__
375
390
if _override_transport is not None:
376
391
repo_transport = _override_transport
378
393
repo_transport = a_bzrdir.get_repository_transport(None)
379
394
control_files = lockable_files.LockableFiles(repo_transport,
380
395
'lock', lockdir.LockDir)
381
repo = self.repository_class(_format=self,
396
text_store = self._get_text_store(repo_transport, control_files)
397
control_store = self._get_control_store(repo_transport, control_files)
398
_revision_store = self._get_revision_store(repo_transport, control_files)
399
return self.repository_class(_format=self,
382
400
a_bzrdir=a_bzrdir,
383
401
control_files=control_files,
384
_commit_builder_class=self._commit_builder_class,
385
_serializer=self._serializer)
386
repo.revisions = self._get_revisions(repo_transport, repo)
387
repo.signatures = self._get_signatures(repo_transport, repo)
388
repo.inventories = self._get_inventories(repo_transport, repo)
389
repo.texts = self._get_texts(repo_transport, repo)
390
repo.chk_bytes = None
391
repo._transport = repo_transport
402
_revision_store=_revision_store,
403
control_store=control_store,
404
text_store=text_store)
395
407
class RepositoryFormatKnit1(RepositoryFormatKnit):
468
482
return "Knit repository format 3"
471
class RepositoryFormatKnit4(RepositoryFormatKnit):
472
"""Bzr repository knit format 4.
474
This repository format has everything in format 3, except for
476
- knits for file texts and inventory
477
- hash subdirectory based stores.
478
- knits for revisions and signatures
479
- TextStores for revisions and signatures.
480
- a format marker of its own
481
- an optional 'shared-storage' flag
482
- an optional 'no-working-trees' flag
484
- support for recording full info about the tree root
485
def _get_stream_as_bytes(knit, required_versions):
486
"""Generate a serialised data stream.
488
The format is a bencoding of a list. The first element of the list is a
489
string of the format signature, then each subsequent element is a list
490
corresponding to a record. Those lists contain:
497
:returns: a bencoded list.
487
repository_class = KnitRepository
488
_commit_builder_class = RootCommitBuilder
489
rich_root_data = True
490
supports_tree_reference = False
492
def _serializer(self):
493
return xml6.serializer_v6
495
def _get_matching_bzrdir(self):
496
return bzrdir.format_registry.make_bzrdir('rich-root')
498
def _ignore_setting_bzrdir(self, format):
501
_matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
503
def get_format_string(self):
504
"""See RepositoryFormat.get_format_string()."""
505
return 'Bazaar Knit Repository Format 4 (bzr 1.0)\n'
507
def get_format_description(self):
508
"""See RepositoryFormat.get_format_description()."""
509
return "Knit repository format 4"
499
knit_stream = knit.get_data_stream(required_versions)
500
format_signature, data_list, callable = knit_stream
502
data.append(format_signature)
503
for version, options, length, parents in data_list:
504
data.append([version, options, parents, callable(length)])
505
return bencode.bencode(data)
added
removed
bzrlib/repofmt/knitrepo.py
