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
40
from bzrlib.decorators import needs_read_lock, needs_write_lock
39
41
from bzrlib.repository import (
43
44
MetaDirRepositoryFormat,
48
import bzrlib.revision as _mod_revision
49
from bzrlib.store.versioned import VersionedFileStore
50
from bzrlib.trace import mutter, mutter_callsite
51
from bzrlib.util import bencode
49
54
class _KnitParentsProvider(object):
54
59
def __repr__(self):
55
60
return 'KnitParentsProvider(%r)' % self._knit
62
@symbol_versioning.deprecated_method(symbol_versioning.one_one)
63
def get_parents(self, revision_ids):
64
"""See graph._StackedParentsProvider.get_parents"""
65
parent_map = self.get_parent_map(revision_ids)
66
return [parent_map.get(r, None) for r in revision_ids]
57
68
def get_parent_map(self, keys):
58
"""See graph.StackedParentsProvider.get_parent_map"""
69
"""See graph._StackedParentsProvider.get_parent_map"""
60
71
for revision_id in keys:
61
if revision_id is None:
62
raise ValueError('get_parent_map(None) is not valid')
63
72
if revision_id == _mod_revision.NULL_REVISION:
64
parent_map[revision_id] = ()
73
parent_map[revision_id] = []
68
self._knit.get_parents_with_ghosts(revision_id))
76
parents = self._knit.get_parents_with_ghosts(revision_id)
69
77
except errors.RevisionNotPresent:
72
80
if len(parents) == 0:
73
parents = (_mod_revision.NULL_REVISION,)
81
parents = [_mod_revision.NULL_REVISION]
74
82
parent_map[revision_id] = parents
78
class _KnitsParentsProvider(object):
80
def __init__(self, knit, prefix=()):
81
"""Create a parent provider for string keys mapped to tuple keys."""
86
return 'KnitsParentsProvider(%r)' % self._knit
88
def get_parent_map(self, keys):
89
"""See graph.StackedParentsProvider.get_parent_map"""
90
parent_map = self._knit.get_parent_map(
91
[self._prefix + (key,) for key in keys])
93
for key, parents in parent_map.items():
96
parents = (_mod_revision.NULL_REVISION,)
98
parents = tuple(parent[-1] for parent in parents)
99
result[revid] = parents
100
for revision_id in keys:
101
if revision_id == _mod_revision.NULL_REVISION:
102
result[revision_id] = ()
106
86
class KnitRepository(MetaDirRepository):
107
87
"""Knit format repository."""
113
93
_commit_builder_class = None
114
94
_serializer = None
116
def __init__(self, _format, a_bzrdir, control_files, _commit_builder_class,
118
MetaDirRepository.__init__(self, _format, a_bzrdir, control_files)
96
def __init__(self, _format, a_bzrdir, control_files, _revision_store,
97
control_store, text_store, _commit_builder_class, _serializer):
98
MetaDirRepository.__init__(self, _format, a_bzrdir, control_files,
99
_revision_store, control_store, text_store)
119
100
self._commit_builder_class = _commit_builder_class
120
101
self._serializer = _serializer
121
102
self._reconcile_fixes_text_parents = True
104
def _warn_if_deprecated(self):
105
# This class isn't deprecated
108
def _inventory_add_lines(self, inv_vf, revid, parents, lines, check_content):
109
return inv_vf.add_lines_with_ghosts(revid, parents, lines,
110
check_content=check_content)[0]
124
113
def _all_revision_ids(self):
125
114
"""See Repository.all_revision_ids()."""
126
return [key[0] for key in self.revisions.keys()]
128
def _activate_new_inventory(self):
129
"""Put a replacement inventory.new into use as inventories."""
130
# Copy the content across
132
t.copy('inventory.new.kndx', 'inventory.kndx')
134
t.copy('inventory.new.knit', 'inventory.knit')
135
except errors.NoSuchFile:
136
# empty inventories knit
137
t.delete('inventory.knit')
138
# delete the temp inventory
139
t.delete('inventory.new.kndx')
141
t.delete('inventory.new.knit')
142
except errors.NoSuchFile:
143
# empty inventories knit
145
# Force index reload (sanity check)
146
self.inventories._index._reset_cache()
147
self.inventories.keys()
149
def _backup_inventory(self):
151
t.copy('inventory.kndx', 'inventory.backup.kndx')
152
t.copy('inventory.knit', 'inventory.backup.knit')
154
def _move_file_id(self, from_id, to_id):
155
t = self._transport.clone('knits')
156
from_rel_url = self.texts._index._mapper.map((from_id, None))
157
to_rel_url = self.texts._index._mapper.map((to_id, None))
158
# We expect both files to always exist in this case.
159
for suffix in ('.knit', '.kndx'):
160
t.rename(from_rel_url + suffix, to_rel_url + suffix)
162
def _remove_file_id(self, file_id):
163
t = self._transport.clone('knits')
164
rel_url = self.texts._index._mapper.map((file_id, None))
165
for suffix in ('.kndx', '.knit'):
167
t.delete(rel_url + suffix)
168
except errors.NoSuchFile:
171
def _temp_inventories(self):
172
result = self._format._get_inventories(self._transport, self,
174
# Reconciling when the output has no revisions would result in no
175
# writes - but we want to ensure there is an inventory for
176
# compatibility with older clients that don't lazy-load.
177
result.get_parent_map([('A',)])
115
# Knits get the revision graph from the index of the revision knit, so
116
# it's always possible even if they're on an unlistable transport.
117
return self._revision_store.all_revision_ids(self.get_transaction())
180
119
def fileid_involved_between_revs(self, from_revid, to_revid):
181
120
"""Find file_id(s) which are involved in the changes between revisions.
203
142
return self._fileid_involved_by_set(changed)
145
def get_ancestry(self, revision_id, topo_sorted=True):
146
"""Return a list of revision-ids integrated by a revision.
148
This is topologically sorted, unless 'topo_sorted' is specified as
151
if _mod_revision.is_null(revision_id):
153
vf = self._get_revision_vf()
155
return [None] + vf.get_ancestry(revision_id, topo_sorted)
156
except errors.RevisionNotPresent:
157
raise errors.NoSuchRevision(self, revision_id)
160
def get_data_stream(self, revision_ids):
161
"""See Repository.get_data_stream."""
162
item_keys = self.item_keys_introduced_by(revision_ids)
163
for knit_kind, file_id, versions in item_keys:
165
if knit_kind == 'file':
166
name = ('file', file_id)
167
knit = self.weave_store.get_weave_or_empty(
168
file_id, self.get_transaction())
169
elif knit_kind == 'inventory':
170
knit = self.get_inventory_weave()
171
elif knit_kind == 'revisions':
172
knit = self._revision_store.get_revision_file(
173
self.get_transaction())
174
elif knit_kind == 'signatures':
175
knit = self._revision_store.get_signature_file(
176
self.get_transaction())
178
raise AssertionError('Unknown knit kind %r' % (knit_kind,))
179
yield name, _get_stream_as_bytes(knit, versions)
206
182
def get_revision(self, revision_id):
207
183
"""Return the Revision object for a named revision"""
208
184
revision_id = osutils.safe_revision_id(revision_id)
209
185
return self.get_revision_reconcile(revision_id)
211
def _refresh_data(self):
212
if not self.is_locked():
214
if self.is_in_write_group():
215
raise IsInWriteGroupError(self)
216
# Create a new transaction to force all knits to see the scope change.
217
# This is safe because we're outside a write group.
218
self.control_files._finish_transaction()
219
if self.is_write_locked():
220
self.control_files._set_write_transaction()
222
self.control_files._set_read_transaction()
188
def get_revision_graph(self, revision_id=None):
189
"""Return a dictionary containing the revision graph.
191
:param revision_id: The revision_id to get a graph from. If None, then
192
the entire revision graph is returned. This is a deprecated mode of
193
operation and will be removed in the future.
194
:return: a dictionary of revision_id->revision_parents_list.
196
if 'evil' in debug.debug_flags:
198
"get_revision_graph scales with size of history.")
199
# special case NULL_REVISION
200
if revision_id == _mod_revision.NULL_REVISION:
202
a_weave = self._get_revision_vf()
203
if revision_id is None:
204
return a_weave.get_graph()
205
if revision_id not in a_weave:
206
raise errors.NoSuchRevision(self, revision_id)
208
# add what can be reached from revision_id
209
return a_weave.get_graph([revision_id])
212
def get_revision_graph_with_ghosts(self, revision_ids=None):
213
"""Return a graph of the revisions with ghosts marked as applicable.
215
:param revision_ids: an iterable of revisions to graph or None for all.
216
:return: a Graph object with the graph reachable from revision_ids.
218
if 'evil' in debug.debug_flags:
220
"get_revision_graph_with_ghosts scales with size of history.")
221
result = deprecated_graph.Graph()
222
vf = self._get_revision_vf()
223
versions = set(vf.versions())
225
pending = set(self.all_revision_ids())
228
pending = set(revision_ids)
229
# special case NULL_REVISION
230
if _mod_revision.NULL_REVISION in pending:
231
pending.remove(_mod_revision.NULL_REVISION)
232
required = set(pending)
235
revision_id = pending.pop()
236
if not revision_id in versions:
237
if revision_id in required:
238
raise errors.NoSuchRevision(self, revision_id)
240
result.add_ghost(revision_id)
241
# mark it as done so we don't try for it again.
242
done.add(revision_id)
244
parent_ids = vf.get_parents_with_ghosts(revision_id)
245
for parent_id in parent_ids:
246
# is this queued or done ?
247
if (parent_id not in pending and
248
parent_id not in done):
250
pending.add(parent_id)
251
result.add_node(revision_id, parent_ids)
252
done.add(revision_id)
255
def _get_revision_vf(self):
256
""":return: a versioned file containing the revisions."""
257
vf = self._revision_store.get_revision_file(self.get_transaction())
260
def _get_history_vf(self):
261
"""Get a versionedfile whose history graph reflects all revisions.
263
For knit repositories, this is the revision knit.
265
return self._get_revision_vf()
224
267
@needs_write_lock
225
268
def reconcile(self, other=None, thorough=False):
228
271
reconciler = KnitReconciler(self, thorough=thorough)
229
272
reconciler.reconcile()
230
273
return reconciler
275
def revision_parents(self, revision_id):
276
return self._get_revision_vf().get_parents(revision_id)
232
278
def _make_parents_provider(self):
233
return _KnitsParentsProvider(self.revisions)
279
return _KnitParentsProvider(self._get_revision_vf())
235
def _find_inconsistent_revision_parents(self, revisions_iterator=None):
281
def _find_inconsistent_revision_parents(self):
236
282
"""Find revisions with different parent lists in the revision object
237
283
and in the index graph.
239
:param revisions_iterator: None, or an iterator of (revid,
240
Revision-or-None). This iterator controls the revisions checked.
241
285
:returns: an iterator yielding tuples of (revison-id, parents-in-index,
242
286
parents-in-revision).
244
if not self.is_locked():
245
raise AssertionError()
247
if revisions_iterator is None:
248
revisions_iterator = self._iter_revisions(None)
249
for revid, revision in revisions_iterator:
252
parent_map = vf.get_parent_map([(revid,)])
253
parents_according_to_index = tuple(parent[-1] for parent in
254
parent_map[(revid,)])
288
assert self.is_locked()
289
vf = self._get_revision_vf()
290
for index_version in vf.versions():
291
parents_according_to_index = tuple(vf.get_parents_with_ghosts(
293
revision = self.get_revision(index_version)
255
294
parents_according_to_revision = tuple(revision.parent_ids)
256
295
if parents_according_to_index != parents_according_to_revision:
257
yield (revid, parents_according_to_index,
296
yield (index_version, parents_according_to_index,
258
297
parents_according_to_revision)
260
299
def _check_for_inconsistent_revision_parents(self):
292
331
_commit_builder_class = None
293
332
# Set this attribute in derived clases to control the _serializer that the
294
333
# repository objects will have passed to their constructor.
296
def _serializer(self):
297
return xml5.serializer_v5
334
_serializer = xml5.serializer_v5
298
335
# Knit based repositories handle ghosts reasonably well.
299
336
supports_ghosts = True
300
# External lookups are not supported in this format.
301
supports_external_lookups = False
303
supports_chks = False
304
_fetch_order = 'topological'
305
_fetch_uses_deltas = True
308
def _get_inventories(self, repo_transport, repo, name='inventory'):
309
mapper = versionedfile.ConstantMapper(name)
310
index = _mod_knit._KndxIndex(repo_transport, mapper,
311
repo.get_transaction, repo.is_write_locked, repo.is_locked)
312
access = _mod_knit._KnitKeyAccess(repo_transport, mapper)
313
return _mod_knit.KnitVersionedFiles(index, access, annotated=False)
315
def _get_revisions(self, repo_transport, repo):
316
mapper = versionedfile.ConstantMapper('revisions')
317
index = _mod_knit._KndxIndex(repo_transport, mapper,
318
repo.get_transaction, repo.is_write_locked, repo.is_locked)
319
access = _mod_knit._KnitKeyAccess(repo_transport, mapper)
320
return _mod_knit.KnitVersionedFiles(index, access, max_delta_chain=0,
323
def _get_signatures(self, repo_transport, repo):
324
mapper = versionedfile.ConstantMapper('signatures')
325
index = _mod_knit._KndxIndex(repo_transport, mapper,
326
repo.get_transaction, repo.is_write_locked, repo.is_locked)
327
access = _mod_knit._KnitKeyAccess(repo_transport, mapper)
328
return _mod_knit.KnitVersionedFiles(index, access, max_delta_chain=0,
331
def _get_texts(self, repo_transport, repo):
332
mapper = versionedfile.HashEscapedPrefixMapper()
333
base_transport = repo_transport.clone('knits')
334
index = _mod_knit._KndxIndex(base_transport, mapper,
335
repo.get_transaction, repo.is_write_locked, repo.is_locked)
336
access = _mod_knit._KnitKeyAccess(base_transport, mapper)
337
return _mod_knit.KnitVersionedFiles(index, access, max_delta_chain=200,
338
def _get_control_store(self, repo_transport, control_files):
339
"""Return the control store for this repository."""
340
return VersionedFileStore(
343
file_mode=control_files._file_mode,
344
versionedfile_class=knit.KnitVersionedFile,
345
versionedfile_kwargs={'factory':knit.KnitPlainFactory()},
348
def _get_revision_store(self, repo_transport, control_files):
349
"""See RepositoryFormat._get_revision_store()."""
350
versioned_file_store = VersionedFileStore(
352
file_mode=control_files._file_mode,
355
versionedfile_class=knit.KnitVersionedFile,
356
versionedfile_kwargs={'delta':False,
357
'factory':knit.KnitPlainFactory(),
361
return KnitRevisionStore(versioned_file_store)
363
def _get_text_store(self, transport, control_files):
364
"""See RepositoryFormat._get_text_store()."""
365
return self._get_versioned_file_store('knits',
368
versionedfile_class=knit.KnitVersionedFile,
369
versionedfile_kwargs={
370
'create_parent_dir':True,
372
'dir_mode':control_files._dir_mode,
340
376
def initialize(self, a_bzrdir, shared=False):
341
377
"""Create a knit format 1 repository.
345
381
:param shared: If true the repository will be initialized as a shared
348
trace.mutter('creating repository in %s.', a_bzrdir.transport.base)
384
mutter('creating repository in %s.', a_bzrdir.transport.base)
351
387
utf8_files = [('format', self.get_format_string())]
353
389
self._upload_blank_content(a_bzrdir, dirs, files, utf8_files, shared)
354
390
repo_transport = a_bzrdir.get_repository_transport(None)
355
391
control_files = lockable_files.LockableFiles(repo_transport,
356
392
'lock', lockdir.LockDir)
393
control_store = self._get_control_store(repo_transport, control_files)
357
394
transaction = transactions.WriteTransaction()
358
result = self.open(a_bzrdir=a_bzrdir, _found=True)
395
# trigger a write of the inventory store.
396
control_store.get_weave_or_empty('inventory', transaction)
397
_revision_store = self._get_revision_store(repo_transport, control_files)
360
398
# the revision id here is irrelevant: it will not be stored, and cannot
361
# already exist, we do this to create files on disk for older clients.
362
result.inventories.get_parent_map([('A',)])
363
result.revisions.get_parent_map([('A',)])
364
result.signatures.get_parent_map([('A',)])
366
self._run_post_repo_init_hooks(result, a_bzrdir, shared)
400
_revision_store.has_revision_id('A', transaction)
401
_revision_store.get_signature_file(transaction)
402
return self.open(a_bzrdir=a_bzrdir, _found=True)
369
404
def open(self, a_bzrdir, _found=False, _override_transport=None):
370
405
"""See RepositoryFormat.open().
372
407
:param _override_transport: INTERNAL USE ONLY. Allows opening the
373
408
repository at a slightly different url
374
409
than normal. I.e. during 'upgrade'.
377
412
format = RepositoryFormat.find_format(a_bzrdir)
413
assert format.__class__ == self.__class__
378
414
if _override_transport is not None:
379
415
repo_transport = _override_transport
381
417
repo_transport = a_bzrdir.get_repository_transport(None)
382
418
control_files = lockable_files.LockableFiles(repo_transport,
383
419
'lock', lockdir.LockDir)
384
repo = self.repository_class(_format=self,
420
text_store = self._get_text_store(repo_transport, control_files)
421
control_store = self._get_control_store(repo_transport, control_files)
422
_revision_store = self._get_revision_store(repo_transport, control_files)
423
return self.repository_class(_format=self,
385
424
a_bzrdir=a_bzrdir,
386
425
control_files=control_files,
426
_revision_store=_revision_store,
427
control_store=control_store,
428
text_store=text_store,
387
429
_commit_builder_class=self._commit_builder_class,
388
430
_serializer=self._serializer)
389
repo.revisions = self._get_revisions(repo_transport, repo)
390
repo.signatures = self._get_signatures(repo_transport, repo)
391
repo.inventories = self._get_inventories(repo_transport, repo)
392
repo.texts = self._get_texts(repo_transport, repo)
393
repo.chk_bytes = None
394
repo._transport = repo_transport
398
433
class RepositoryFormatKnit1(RepositoryFormatKnit):
510
554
def get_format_description(self):
511
555
"""See RepositoryFormat.get_format_description()."""
512
556
return "Knit repository format 4"
559
def _get_stream_as_bytes(knit, required_versions):
560
"""Generate a serialised data stream.
562
The format is a bencoding of a list. The first element of the list is a
563
string of the format signature, then each subsequent element is a list
564
corresponding to a record. Those lists contain:
571
:returns: a bencoded list.
573
knit_stream = knit.get_data_stream(required_versions)
574
format_signature, data_list, callable = knit_stream
576
data.append(format_signature)
577
for version, options, length, parents in data_list:
578
data.append([version, options, parents, callable(length)])
579
return bencode.bencode(data)
added
removed
bzrlib/repofmt/knitrepo.py
