1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
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
17
"""Knit versionedfile implementation.
19
A knit is a versioned file implementation that supports efficient append only
23
lifeless: the data file is made up of "delta records". each delta record has a delta header
24
that contains; (1) a version id, (2) the size of the delta (in lines), and (3) the digest of
25
the -expanded data- (ie, the delta applied to the parent). the delta also ends with a
26
end-marker; simply "end VERSION"
28
delta can be line or full contents.a
29
... the 8's there are the index number of the annotation.
30
version robertc@robertcollins.net-20051003014215-ee2990904cc4c7ad 7 c7d23b2a5bd6ca00e8e266cec0ec228158ee9f9e
34
8 e.set('executable', 'yes')
36
8 if elt.get('executable') == 'yes':
37
8 ie.executable = True
38
end robertc@robertcollins.net-20051003014215-ee2990904cc4c7ad
42
09:33 < jrydberg> lifeless: each index is made up of a tuple of; version id, options, position, size, parents
43
09:33 < jrydberg> lifeless: the parents are currently dictionary compressed
44
09:33 < jrydberg> lifeless: (meaning it currently does not support ghosts)
45
09:33 < lifeless> right
46
09:33 < jrydberg> lifeless: the position and size is the range in the data file
49
so the index sequence is the dictionary compressed sequence number used
50
in the deltas to provide line annotation
55
from cStringIO import StringIO
56
from itertools import izip
61
from bzrlib.lazy_import import lazy_import
62
lazy_import(globals(), """
82
from bzrlib.errors import (
90
RevisionAlreadyPresent,
93
from bzrlib.osutils import (
100
from bzrlib.versionedfile import (
101
AbsentContentFactory,
105
ChunkedContentFactory,
112
# TODO: Split out code specific to this format into an associated object.
114
# TODO: Can we put in some kind of value to check that the index and data
115
# files belong together?
117
# TODO: accommodate binaries, perhaps by storing a byte count
119
# TODO: function to check whole file
121
# TODO: atomically append data, then measure backwards from the cursor
122
# position after writing to work out where it was located. we may need to
123
# bypass python file buffering.
125
DATA_SUFFIX = '.knit'
126
INDEX_SUFFIX = '.kndx'
127
_STREAM_MIN_BUFFER_SIZE = 5*1024*1024
130
class KnitAdapter(object):
131
"""Base class for knit record adaption."""
133
def __init__(self, basis_vf):
134
"""Create an adapter which accesses full texts from basis_vf.
136
:param basis_vf: A versioned file to access basis texts of deltas from.
137
May be None for adapters that do not need to access basis texts.
139
self._data = KnitVersionedFiles(None, None)
140
self._annotate_factory = KnitAnnotateFactory()
141
self._plain_factory = KnitPlainFactory()
142
self._basis_vf = basis_vf
145
class FTAnnotatedToUnannotated(KnitAdapter):
146
"""An adapter from FT annotated knits to unannotated ones."""
148
def get_bytes(self, factory):
149
annotated_compressed_bytes = factory._raw_record
151
self._data._parse_record_unchecked(annotated_compressed_bytes)
152
content = self._annotate_factory.parse_fulltext(contents, rec[1])
153
size, bytes = self._data._record_to_data((rec[1],), rec[3], content.text())
157
class DeltaAnnotatedToUnannotated(KnitAdapter):
158
"""An adapter for deltas from annotated to unannotated."""
160
def get_bytes(self, factory):
161
annotated_compressed_bytes = factory._raw_record
163
self._data._parse_record_unchecked(annotated_compressed_bytes)
164
delta = self._annotate_factory.parse_line_delta(contents, rec[1],
166
contents = self._plain_factory.lower_line_delta(delta)
167
size, bytes = self._data._record_to_data((rec[1],), rec[3], contents)
171
class FTAnnotatedToFullText(KnitAdapter):
172
"""An adapter from FT annotated knits to unannotated ones."""
174
def get_bytes(self, factory):
175
annotated_compressed_bytes = factory._raw_record
177
self._data._parse_record_unchecked(annotated_compressed_bytes)
178
content, delta = self._annotate_factory.parse_record(factory.key[-1],
179
contents, factory._build_details, None)
180
return ''.join(content.text())
183
class DeltaAnnotatedToFullText(KnitAdapter):
184
"""An adapter for deltas from annotated to unannotated."""
186
def get_bytes(self, factory):
187
annotated_compressed_bytes = factory._raw_record
189
self._data._parse_record_unchecked(annotated_compressed_bytes)
190
delta = self._annotate_factory.parse_line_delta(contents, rec[1],
192
compression_parent = factory.parents[0]
193
basis_entry = self._basis_vf.get_record_stream(
194
[compression_parent], 'unordered', True).next()
195
if basis_entry.storage_kind == 'absent':
196
raise errors.RevisionNotPresent(compression_parent, self._basis_vf)
197
basis_chunks = basis_entry.get_bytes_as('chunked')
198
basis_lines = osutils.chunks_to_lines(basis_chunks)
199
# Manually apply the delta because we have one annotated content and
201
basis_content = PlainKnitContent(basis_lines, compression_parent)
202
basis_content.apply_delta(delta, rec[1])
203
basis_content._should_strip_eol = factory._build_details[1]
204
return ''.join(basis_content.text())
207
class FTPlainToFullText(KnitAdapter):
208
"""An adapter from FT plain knits to unannotated ones."""
210
def get_bytes(self, factory):
211
compressed_bytes = factory._raw_record
213
self._data._parse_record_unchecked(compressed_bytes)
214
content, delta = self._plain_factory.parse_record(factory.key[-1],
215
contents, factory._build_details, None)
216
return ''.join(content.text())
219
class DeltaPlainToFullText(KnitAdapter):
220
"""An adapter for deltas from annotated to unannotated."""
222
def get_bytes(self, factory):
223
compressed_bytes = factory._raw_record
225
self._data._parse_record_unchecked(compressed_bytes)
226
delta = self._plain_factory.parse_line_delta(contents, rec[1])
227
compression_parent = factory.parents[0]
228
# XXX: string splitting overhead.
229
basis_entry = self._basis_vf.get_record_stream(
230
[compression_parent], 'unordered', True).next()
231
if basis_entry.storage_kind == 'absent':
232
raise errors.RevisionNotPresent(compression_parent, self._basis_vf)
233
basis_chunks = basis_entry.get_bytes_as('chunked')
234
basis_lines = osutils.chunks_to_lines(basis_chunks)
235
basis_content = PlainKnitContent(basis_lines, compression_parent)
236
# Manually apply the delta because we have one annotated content and
238
content, _ = self._plain_factory.parse_record(rec[1], contents,
239
factory._build_details, basis_content)
240
return ''.join(content.text())
243
class KnitContentFactory(ContentFactory):
244
"""Content factory for streaming from knits.
246
:seealso ContentFactory:
249
def __init__(self, key, parents, build_details, sha1, raw_record,
250
annotated, knit=None, network_bytes=None):
251
"""Create a KnitContentFactory for key.
254
:param parents: The parents.
255
:param build_details: The build details as returned from
257
:param sha1: The sha1 expected from the full text of this object.
258
:param raw_record: The bytes of the knit data from disk.
259
:param annotated: True if the raw data is annotated.
260
:param network_bytes: None to calculate the network bytes on demand,
261
not-none if they are already known.
263
ContentFactory.__init__(self)
266
self.parents = parents
267
if build_details[0] == 'line-delta':
272
annotated_kind = 'annotated-'
275
self.storage_kind = 'knit-%s%s-gz' % (annotated_kind, kind)
276
self._raw_record = raw_record
277
self._network_bytes = network_bytes
278
self._build_details = build_details
281
def _create_network_bytes(self):
282
"""Create a fully serialised network version for transmission."""
283
# storage_kind, key, parents, Noeol, raw_record
284
key_bytes = '\x00'.join(self.key)
285
if self.parents is None:
286
parent_bytes = 'None:'
288
parent_bytes = '\t'.join('\x00'.join(key) for key in self.parents)
289
if self._build_details[1]:
293
network_bytes = "%s\n%s\n%s\n%s%s" % (self.storage_kind, key_bytes,
294
parent_bytes, noeol, self._raw_record)
295
self._network_bytes = network_bytes
297
def get_bytes_as(self, storage_kind):
298
if storage_kind == self.storage_kind:
299
if self._network_bytes is None:
300
self._create_network_bytes()
301
return self._network_bytes
302
if ('-ft-' in self.storage_kind and
303
storage_kind in ('chunked', 'fulltext')):
304
adapter_key = (self.storage_kind, 'fulltext')
305
adapter_factory = adapter_registry.get(adapter_key)
306
adapter = adapter_factory(None)
307
bytes = adapter.get_bytes(self)
308
if storage_kind == 'chunked':
312
if self._knit is not None:
313
# Not redundant with direct conversion above - that only handles
315
if storage_kind == 'chunked':
316
return self._knit.get_lines(self.key[0])
317
elif storage_kind == 'fulltext':
318
return self._knit.get_text(self.key[0])
319
raise errors.UnavailableRepresentation(self.key, storage_kind,
323
class LazyKnitContentFactory(ContentFactory):
324
"""A ContentFactory which can either generate full text or a wire form.
326
:seealso ContentFactory:
329
def __init__(self, key, parents, generator, first):
330
"""Create a LazyKnitContentFactory.
332
:param key: The key of the record.
333
:param parents: The parents of the record.
334
:param generator: A _ContentMapGenerator containing the record for this
336
:param first: Is this the first content object returned from generator?
337
if it is, its storage kind is knit-delta-closure, otherwise it is
338
knit-delta-closure-ref
341
self.parents = parents
343
self._generator = generator
344
self.storage_kind = "knit-delta-closure"
346
self.storage_kind = self.storage_kind + "-ref"
349
def get_bytes_as(self, storage_kind):
350
if storage_kind == self.storage_kind:
352
return self._generator._wire_bytes()
354
# all the keys etc are contained in the bytes returned in the
357
if storage_kind in ('chunked', 'fulltext'):
358
chunks = self._generator._get_one_work(self.key).text()
359
if storage_kind == 'chunked':
362
return ''.join(chunks)
363
raise errors.UnavailableRepresentation(self.key, storage_kind,
367
def knit_delta_closure_to_records(storage_kind, bytes, line_end):
368
"""Convert a network record to a iterator over stream records.
370
:param storage_kind: The storage kind of the record.
371
Must be 'knit-delta-closure'.
372
:param bytes: The bytes of the record on the network.
374
generator = _NetworkContentMapGenerator(bytes, line_end)
375
return generator.get_record_stream()
378
def knit_network_to_record(storage_kind, bytes, line_end):
379
"""Convert a network record to a record object.
381
:param storage_kind: The storage kind of the record.
382
:param bytes: The bytes of the record on the network.
385
line_end = bytes.find('\n', start)
386
key = tuple(bytes[start:line_end].split('\x00'))
388
line_end = bytes.find('\n', start)
389
parent_line = bytes[start:line_end]
390
if parent_line == 'None:':
394
[tuple(segment.split('\x00')) for segment in parent_line.split('\t')
397
noeol = bytes[start] == 'N'
398
if 'ft' in storage_kind:
401
method = 'line-delta'
402
build_details = (method, noeol)
404
raw_record = bytes[start:]
405
annotated = 'annotated' in storage_kind
406
return [KnitContentFactory(key, parents, build_details, None, raw_record,
407
annotated, network_bytes=bytes)]
410
class KnitContent(object):
411
"""Content of a knit version to which deltas can be applied.
413
This is always stored in memory as a list of lines with \n at the end,
414
plus a flag saying if the final ending is really there or not, because that
415
corresponds to the on-disk knit representation.
419
self._should_strip_eol = False
421
def apply_delta(self, delta, new_version_id):
422
"""Apply delta to this object to become new_version_id."""
423
raise NotImplementedError(self.apply_delta)
425
def line_delta_iter(self, new_lines):
426
"""Generate line-based delta from this content to new_lines."""
427
new_texts = new_lines.text()
428
old_texts = self.text()
429
s = patiencediff.PatienceSequenceMatcher(None, old_texts, new_texts)
430
for tag, i1, i2, j1, j2 in s.get_opcodes():
433
# ofrom, oto, length, data
434
yield i1, i2, j2 - j1, new_lines._lines[j1:j2]
436
def line_delta(self, new_lines):
437
return list(self.line_delta_iter(new_lines))
440
def get_line_delta_blocks(knit_delta, source, target):
441
"""Extract SequenceMatcher.get_matching_blocks() from a knit delta"""
442
target_len = len(target)
445
for s_begin, s_end, t_len, new_text in knit_delta:
446
true_n = s_begin - s_pos
449
# knit deltas do not provide reliable info about whether the
450
# last line of a file matches, due to eol handling.
451
if source[s_pos + n -1] != target[t_pos + n -1]:
454
yield s_pos, t_pos, n
455
t_pos += t_len + true_n
457
n = target_len - t_pos
459
if source[s_pos + n -1] != target[t_pos + n -1]:
462
yield s_pos, t_pos, n
463
yield s_pos + (target_len - t_pos), target_len, 0
466
class AnnotatedKnitContent(KnitContent):
467
"""Annotated content."""
469
def __init__(self, lines):
470
KnitContent.__init__(self)
474
"""Return a list of (origin, text) for each content line."""
475
lines = self._lines[:]
476
if self._should_strip_eol:
477
origin, last_line = lines[-1]
478
lines[-1] = (origin, last_line.rstrip('\n'))
481
def apply_delta(self, delta, new_version_id):
482
"""Apply delta to this object to become new_version_id."""
485
for start, end, count, delta_lines in delta:
486
lines[offset+start:offset+end] = delta_lines
487
offset = offset + (start - end) + count
491
lines = [text for origin, text in self._lines]
492
except ValueError, e:
493
# most commonly (only?) caused by the internal form of the knit
494
# missing annotation information because of a bug - see thread
496
raise KnitCorrupt(self,
497
"line in annotated knit missing annotation information: %s"
499
if self._should_strip_eol:
500
lines[-1] = lines[-1].rstrip('\n')
504
return AnnotatedKnitContent(self._lines[:])
507
class PlainKnitContent(KnitContent):
508
"""Unannotated content.
510
When annotate[_iter] is called on this content, the same version is reported
511
for all lines. Generally, annotate[_iter] is not useful on PlainKnitContent
515
def __init__(self, lines, version_id):
516
KnitContent.__init__(self)
518
self._version_id = version_id
521
"""Return a list of (origin, text) for each content line."""
522
return [(self._version_id, line) for line in self._lines]
524
def apply_delta(self, delta, new_version_id):
525
"""Apply delta to this object to become new_version_id."""
528
for start, end, count, delta_lines in delta:
529
lines[offset+start:offset+end] = delta_lines
530
offset = offset + (start - end) + count
531
self._version_id = new_version_id
534
return PlainKnitContent(self._lines[:], self._version_id)
538
if self._should_strip_eol:
540
lines[-1] = lines[-1].rstrip('\n')
544
class _KnitFactory(object):
545
"""Base class for common Factory functions."""
547
def parse_record(self, version_id, record, record_details,
548
base_content, copy_base_content=True):
549
"""Parse a record into a full content object.
551
:param version_id: The official version id for this content
552
:param record: The data returned by read_records_iter()
553
:param record_details: Details about the record returned by
555
:param base_content: If get_build_details returns a compression_parent,
556
you must return a base_content here, else use None
557
:param copy_base_content: When building from the base_content, decide
558
you can either copy it and return a new object, or modify it in
560
:return: (content, delta) A Content object and possibly a line-delta,
563
method, noeol = record_details
564
if method == 'line-delta':
565
if copy_base_content:
566
content = base_content.copy()
568
content = base_content
569
delta = self.parse_line_delta(record, version_id)
570
content.apply_delta(delta, version_id)
572
content = self.parse_fulltext(record, version_id)
574
content._should_strip_eol = noeol
575
return (content, delta)
578
class KnitAnnotateFactory(_KnitFactory):
579
"""Factory for creating annotated Content objects."""
583
def make(self, lines, version_id):
584
num_lines = len(lines)
585
return AnnotatedKnitContent(zip([version_id] * num_lines, lines))
587
def parse_fulltext(self, content, version_id):
588
"""Convert fulltext to internal representation
590
fulltext content is of the format
591
revid(utf8) plaintext\n
592
internal representation is of the format:
595
# TODO: jam 20070209 The tests expect this to be returned as tuples,
596
# but the code itself doesn't really depend on that.
597
# Figure out a way to not require the overhead of turning the
598
# list back into tuples.
599
lines = [tuple(line.split(' ', 1)) for line in content]
600
return AnnotatedKnitContent(lines)
602
def parse_line_delta_iter(self, lines):
603
return iter(self.parse_line_delta(lines))
605
def parse_line_delta(self, lines, version_id, plain=False):
606
"""Convert a line based delta into internal representation.
608
line delta is in the form of:
609
intstart intend intcount
611
revid(utf8) newline\n
612
internal representation is
613
(start, end, count, [1..count tuples (revid, newline)])
615
:param plain: If True, the lines are returned as a plain
616
list without annotations, not as a list of (origin, content) tuples, i.e.
617
(start, end, count, [1..count newline])
624
def cache_and_return(line):
625
origin, text = line.split(' ', 1)
626
return cache.setdefault(origin, origin), text
628
# walk through the lines parsing.
629
# Note that the plain test is explicitly pulled out of the
630
# loop to minimise any performance impact
633
start, end, count = [int(n) for n in header.split(',')]
634
contents = [next().split(' ', 1)[1] for i in xrange(count)]
635
result.append((start, end, count, contents))
638
start, end, count = [int(n) for n in header.split(',')]
639
contents = [tuple(next().split(' ', 1)) for i in xrange(count)]
640
result.append((start, end, count, contents))
643
def get_fulltext_content(self, lines):
644
"""Extract just the content lines from a fulltext."""
645
return (line.split(' ', 1)[1] for line in lines)
647
def get_linedelta_content(self, lines):
648
"""Extract just the content from a line delta.
650
This doesn't return all of the extra information stored in a delta.
651
Only the actual content lines.
656
header = header.split(',')
657
count = int(header[2])
658
for i in xrange(count):
659
origin, text = next().split(' ', 1)
662
def lower_fulltext(self, content):
663
"""convert a fulltext content record into a serializable form.
665
see parse_fulltext which this inverts.
667
return ['%s %s' % (o, t) for o, t in content._lines]
669
def lower_line_delta(self, delta):
670
"""convert a delta into a serializable form.
672
See parse_line_delta which this inverts.
674
# TODO: jam 20070209 We only do the caching thing to make sure that
675
# the origin is a valid utf-8 line, eventually we could remove it
677
for start, end, c, lines in delta:
678
out.append('%d,%d,%d\n' % (start, end, c))
679
out.extend(origin + ' ' + text
680
for origin, text in lines)
683
def annotate(self, knit, key):
684
content = knit._get_content(key)
685
# adjust for the fact that serialised annotations are only key suffixes
687
if type(key) is tuple:
689
origins = content.annotate()
691
for origin, line in origins:
692
result.append((prefix + (origin,), line))
695
# XXX: This smells a bit. Why would key ever be a non-tuple here?
696
# Aren't keys defined to be tuples? -- spiv 20080618
697
return content.annotate()
700
class KnitPlainFactory(_KnitFactory):
701
"""Factory for creating plain Content objects."""
705
def make(self, lines, version_id):
706
return PlainKnitContent(lines, version_id)
708
def parse_fulltext(self, content, version_id):
709
"""This parses an unannotated fulltext.
711
Note that this is not a noop - the internal representation
712
has (versionid, line) - its just a constant versionid.
714
return self.make(content, version_id)
716
def parse_line_delta_iter(self, lines, version_id):
718
num_lines = len(lines)
719
while cur < num_lines:
722
start, end, c = [int(n) for n in header.split(',')]
723
yield start, end, c, lines[cur:cur+c]
726
def parse_line_delta(self, lines, version_id):
727
return list(self.parse_line_delta_iter(lines, version_id))
729
def get_fulltext_content(self, lines):
730
"""Extract just the content lines from a fulltext."""
733
def get_linedelta_content(self, lines):
734
"""Extract just the content from a line delta.
736
This doesn't return all of the extra information stored in a delta.
737
Only the actual content lines.
742
header = header.split(',')
743
count = int(header[2])
744
for i in xrange(count):
747
def lower_fulltext(self, content):
748
return content.text()
750
def lower_line_delta(self, delta):
752
for start, end, c, lines in delta:
753
out.append('%d,%d,%d\n' % (start, end, c))
757
def annotate(self, knit, key):
758
annotator = _KnitAnnotator(knit)
759
return annotator.annotate_flat(key)
763
def make_file_factory(annotated, mapper):
764
"""Create a factory for creating a file based KnitVersionedFiles.
766
This is only functional enough to run interface tests, it doesn't try to
767
provide a full pack environment.
769
:param annotated: knit annotations are wanted.
770
:param mapper: The mapper from keys to paths.
772
def factory(transport):
773
index = _KndxIndex(transport, mapper, lambda:None, lambda:True, lambda:True)
774
access = _KnitKeyAccess(transport, mapper)
775
return KnitVersionedFiles(index, access, annotated=annotated)
779
def make_pack_factory(graph, delta, keylength):
780
"""Create a factory for creating a pack based VersionedFiles.
782
This is only functional enough to run interface tests, it doesn't try to
783
provide a full pack environment.
785
:param graph: Store a graph.
786
:param delta: Delta compress contents.
787
:param keylength: How long should keys be.
789
def factory(transport):
790
parents = graph or delta
796
max_delta_chain = 200
799
graph_index = _mod_index.InMemoryGraphIndex(reference_lists=ref_length,
800
key_elements=keylength)
801
stream = transport.open_write_stream('newpack')
802
writer = pack.ContainerWriter(stream.write)
804
index = _KnitGraphIndex(graph_index, lambda:True, parents=parents,
805
deltas=delta, add_callback=graph_index.add_nodes)
806
access = _DirectPackAccess({})
807
access.set_writer(writer, graph_index, (transport, 'newpack'))
808
result = KnitVersionedFiles(index, access,
809
max_delta_chain=max_delta_chain)
810
result.stream = stream
811
result.writer = writer
816
def cleanup_pack_knit(versioned_files):
817
versioned_files.stream.close()
818
versioned_files.writer.end()
821
def _get_total_build_size(self, keys, positions):
822
"""Determine the total bytes to build these keys.
824
(helper function because _KnitGraphIndex and _KndxIndex work the same, but
825
don't inherit from a common base.)
827
:param keys: Keys that we want to build
828
:param positions: dict of {key, (info, index_memo, comp_parent)} (such
829
as returned by _get_components_positions)
830
:return: Number of bytes to build those keys
832
all_build_index_memos = {}
836
for key in build_keys:
837
# This is mostly for the 'stacked' case
838
# Where we will be getting the data from a fallback
839
if key not in positions:
841
_, index_memo, compression_parent = positions[key]
842
all_build_index_memos[key] = index_memo
843
if compression_parent not in all_build_index_memos:
844
next_keys.add(compression_parent)
845
build_keys = next_keys
846
return sum([index_memo[2] for index_memo
847
in all_build_index_memos.itervalues()])
850
class KnitVersionedFiles(VersionedFiles):
851
"""Storage for many versioned files using knit compression.
853
Backend storage is managed by indices and data objects.
855
:ivar _index: A _KnitGraphIndex or similar that can describe the
856
parents, graph, compression and data location of entries in this
857
KnitVersionedFiles. Note that this is only the index for
858
*this* vfs; if there are fallbacks they must be queried separately.
861
def __init__(self, index, data_access, max_delta_chain=200,
862
annotated=False, reload_func=None):
863
"""Create a KnitVersionedFiles with index and data_access.
865
:param index: The index for the knit data.
866
:param data_access: The access object to store and retrieve knit
868
:param max_delta_chain: The maximum number of deltas to permit during
869
insertion. Set to 0 to prohibit the use of deltas.
870
:param annotated: Set to True to cause annotations to be calculated and
871
stored during insertion.
872
:param reload_func: An function that can be called if we think we need
873
to reload the pack listing and try again. See
874
'bzrlib.repofmt.pack_repo.AggregateIndex' for the signature.
877
self._access = data_access
878
self._max_delta_chain = max_delta_chain
880
self._factory = KnitAnnotateFactory()
882
self._factory = KnitPlainFactory()
883
self._fallback_vfs = []
884
self._reload_func = reload_func
887
return "%s(%r, %r)" % (
888
self.__class__.__name__,
892
def add_fallback_versioned_files(self, a_versioned_files):
893
"""Add a source of texts for texts not present in this knit.
895
:param a_versioned_files: A VersionedFiles object.
897
self._fallback_vfs.append(a_versioned_files)
899
def add_lines(self, key, parents, lines, parent_texts=None,
900
left_matching_blocks=None, nostore_sha=None, random_id=False,
902
"""See VersionedFiles.add_lines()."""
903
self._index._check_write_ok()
904
self._check_add(key, lines, random_id, check_content)
906
# The caller might pass None if there is no graph data, but kndx
907
# indexes can't directly store that, so we give them
908
# an empty tuple instead.
910
line_bytes = ''.join(lines)
911
return self._add(key, lines, parents,
912
parent_texts, left_matching_blocks, nostore_sha, random_id,
913
line_bytes=line_bytes)
915
def _add_text(self, key, parents, text, nostore_sha=None, random_id=False):
916
"""See VersionedFiles._add_text()."""
917
self._index._check_write_ok()
918
self._check_add(key, None, random_id, check_content=False)
919
if text.__class__ is not str:
920
raise errors.BzrBadParameterUnicode("text")
922
# The caller might pass None if there is no graph data, but kndx
923
# indexes can't directly store that, so we give them
924
# an empty tuple instead.
926
return self._add(key, None, parents,
927
None, None, nostore_sha, random_id,
930
def _add(self, key, lines, parents, parent_texts,
931
left_matching_blocks, nostore_sha, random_id,
933
"""Add a set of lines on top of version specified by parents.
935
Any versions not present will be converted into ghosts.
937
:param lines: A list of strings where each one is a single line (has a
938
single newline at the end of the string) This is now optional
939
(callers can pass None). It is left in its location for backwards
940
compatibility. It should ''.join(lines) must == line_bytes
941
:param line_bytes: A single string containing the content
943
We pass both lines and line_bytes because different routes bring the
944
values to this function. And for memory efficiency, we don't want to
945
have to split/join on-demand.
947
# first thing, if the content is something we don't need to store, find
949
digest = sha_string(line_bytes)
950
if nostore_sha == digest:
951
raise errors.ExistingContent
954
if parent_texts is None:
956
# Do a single query to ascertain parent presence; we only compress
957
# against parents in the same kvf.
958
present_parent_map = self._index.get_parent_map(parents)
959
for parent in parents:
960
if parent in present_parent_map:
961
present_parents.append(parent)
963
# Currently we can only compress against the left most present parent.
964
if (len(present_parents) == 0 or
965
present_parents[0] != parents[0]):
968
# To speed the extract of texts the delta chain is limited
969
# to a fixed number of deltas. This should minimize both
970
# I/O and the time spend applying deltas.
971
delta = self._check_should_delta(present_parents[0])
973
text_length = len(line_bytes)
976
# Note: line_bytes is not modified to add a newline, that is tracked
977
# via the no_eol flag. 'lines' *is* modified, because that is the
978
# general values needed by the Content code.
979
if line_bytes and line_bytes[-1] != '\n':
980
options.append('no-eol')
982
# Copy the existing list, or create a new one
984
lines = osutils.split_lines(line_bytes)
987
# Replace the last line with one that ends in a final newline
988
lines[-1] = lines[-1] + '\n'
990
lines = osutils.split_lines(line_bytes)
992
for element in key[:-1]:
993
if type(element) is not str:
994
raise TypeError("key contains non-strings: %r" % (key,))
996
key = key[:-1] + ('sha1:' + digest,)
997
elif type(key[-1]) is not str:
998
raise TypeError("key contains non-strings: %r" % (key,))
999
# Knit hunks are still last-element only
1000
version_id = key[-1]
1001
content = self._factory.make(lines, version_id)
1003
# Hint to the content object that its text() call should strip the
1005
content._should_strip_eol = True
1006
if delta or (self._factory.annotated and len(present_parents) > 0):
1007
# Merge annotations from parent texts if needed.
1008
delta_hunks = self._merge_annotations(content, present_parents,
1009
parent_texts, delta, self._factory.annotated,
1010
left_matching_blocks)
1013
options.append('line-delta')
1014
store_lines = self._factory.lower_line_delta(delta_hunks)
1015
size, bytes = self._record_to_data(key, digest,
1018
options.append('fulltext')
1019
# isinstance is slower and we have no hierarchy.
1020
if self._factory.__class__ is KnitPlainFactory:
1021
# Use the already joined bytes saving iteration time in
1023
dense_lines = [line_bytes]
1025
dense_lines.append('\n')
1026
size, bytes = self._record_to_data(key, digest,
1029
# get mixed annotation + content and feed it into the
1031
store_lines = self._factory.lower_fulltext(content)
1032
size, bytes = self._record_to_data(key, digest,
1035
access_memo = self._access.add_raw_records([(key, size)], bytes)[0]
1036
self._index.add_records(
1037
((key, options, access_memo, parents),),
1038
random_id=random_id)
1039
return digest, text_length, content
1041
def annotate(self, key):
1042
"""See VersionedFiles.annotate."""
1043
return self._factory.annotate(self, key)
1045
def get_annotator(self):
1046
return _KnitAnnotator(self)
1048
def check(self, progress_bar=None):
1049
"""See VersionedFiles.check()."""
1050
# This doesn't actually test extraction of everything, but that will
1051
# impact 'bzr check' substantially, and needs to be integrated with
1052
# care. However, it does check for the obvious problem of a delta with
1054
keys = self._index.keys()
1055
parent_map = self.get_parent_map(keys)
1057
if self._index.get_method(key) != 'fulltext':
1058
compression_parent = parent_map[key][0]
1059
if compression_parent not in parent_map:
1060
raise errors.KnitCorrupt(self,
1061
"Missing basis parent %s for %s" % (
1062
compression_parent, key))
1063
for fallback_vfs in self._fallback_vfs:
1064
fallback_vfs.check()
1066
def _check_add(self, key, lines, random_id, check_content):
1067
"""check that version_id and lines are safe to add."""
1068
version_id = key[-1]
1069
if version_id is not None:
1070
if contains_whitespace(version_id):
1071
raise InvalidRevisionId(version_id, self)
1072
self.check_not_reserved_id(version_id)
1073
# TODO: If random_id==False and the key is already present, we should
1074
# probably check that the existing content is identical to what is
1075
# being inserted, and otherwise raise an exception. This would make
1076
# the bundle code simpler.
1078
self._check_lines_not_unicode(lines)
1079
self._check_lines_are_lines(lines)
1081
def _check_header(self, key, line):
1082
rec = self._split_header(line)
1083
self._check_header_version(rec, key[-1])
1086
def _check_header_version(self, rec, version_id):
1087
"""Checks the header version on original format knit records.
1089
These have the last component of the key embedded in the record.
1091
if rec[1] != version_id:
1092
raise KnitCorrupt(self,
1093
'unexpected version, wanted %r, got %r' % (version_id, rec[1]))
1095
def _check_should_delta(self, parent):
1096
"""Iterate back through the parent listing, looking for a fulltext.
1098
This is used when we want to decide whether to add a delta or a new
1099
fulltext. It searches for _max_delta_chain parents. When it finds a
1100
fulltext parent, it sees if the total size of the deltas leading up to
1101
it is large enough to indicate that we want a new full text anyway.
1103
Return True if we should create a new delta, False if we should use a
1107
fulltext_size = None
1108
for count in xrange(self._max_delta_chain):
1110
# Note that this only looks in the index of this particular
1111
# KnitVersionedFiles, not in the fallbacks. This ensures that
1112
# we won't store a delta spanning physical repository
1114
build_details = self._index.get_build_details([parent])
1115
parent_details = build_details[parent]
1116
except (RevisionNotPresent, KeyError), e:
1117
# Some basis is not locally present: always fulltext
1119
index_memo, compression_parent, _, _ = parent_details
1120
_, _, size = index_memo
1121
if compression_parent is None:
1122
fulltext_size = size
1125
# We don't explicitly check for presence because this is in an
1126
# inner loop, and if it's missing it'll fail anyhow.
1127
parent = compression_parent
1129
# We couldn't find a fulltext, so we must create a new one
1131
# Simple heuristic - if the total I/O wold be greater as a delta than
1132
# the originally installed fulltext, we create a new fulltext.
1133
return fulltext_size > delta_size
1135
def _build_details_to_components(self, build_details):
1136
"""Convert a build_details tuple to a position tuple."""
1137
# record_details, access_memo, compression_parent
1138
return build_details[3], build_details[0], build_details[1]
1140
def _get_components_positions(self, keys, allow_missing=False):
1141
"""Produce a map of position data for the components of keys.
1143
This data is intended to be used for retrieving the knit records.
1145
A dict of key to (record_details, index_memo, next, parents) is
1147
method is the way referenced data should be applied.
1148
index_memo is the handle to pass to the data access to actually get the
1150
next is the build-parent of the version, or None for fulltexts.
1151
parents is the version_ids of the parents of this version
1153
:param allow_missing: If True do not raise an error on a missing component,
1157
pending_components = keys
1158
while pending_components:
1159
build_details = self._index.get_build_details(pending_components)
1160
current_components = set(pending_components)
1161
pending_components = set()
1162
for key, details in build_details.iteritems():
1163
(index_memo, compression_parent, parents,
1164
record_details) = details
1165
method = record_details[0]
1166
if compression_parent is not None:
1167
pending_components.add(compression_parent)
1168
component_data[key] = self._build_details_to_components(details)
1169
missing = current_components.difference(build_details)
1170
if missing and not allow_missing:
1171
raise errors.RevisionNotPresent(missing.pop(), self)
1172
return component_data
1174
def _get_content(self, key, parent_texts={}):
1175
"""Returns a content object that makes up the specified
1177
cached_version = parent_texts.get(key, None)
1178
if cached_version is not None:
1179
# Ensure the cache dict is valid.
1180
if not self.get_parent_map([key]):
1181
raise RevisionNotPresent(key, self)
1182
return cached_version
1183
generator = _VFContentMapGenerator(self, [key])
1184
return generator._get_content(key)
1186
def get_parent_map(self, keys):
1187
"""Get a map of the graph parents of keys.
1189
:param keys: The keys to look up parents for.
1190
:return: A mapping from keys to parents. Absent keys are absent from
1193
return self._get_parent_map_with_sources(keys)[0]
1195
def _get_parent_map_with_sources(self, keys):
1196
"""Get a map of the parents of keys.
1198
:param keys: The keys to look up parents for.
1199
:return: A tuple. The first element is a mapping from keys to parents.
1200
Absent keys are absent from the mapping. The second element is a
1201
list with the locations each key was found in. The first element
1202
is the in-this-knit parents, the second the first fallback source,
1206
sources = [self._index] + self._fallback_vfs
1209
for source in sources:
1212
new_result = source.get_parent_map(missing)
1213
source_results.append(new_result)
1214
result.update(new_result)
1215
missing.difference_update(set(new_result))
1216
return result, source_results
1218
def _get_record_map(self, keys, allow_missing=False):
1219
"""Produce a dictionary of knit records.
1221
:return: {key:(record, record_details, digest, next)}
1223
data returned from read_records (a KnitContentobject)
1225
opaque information to pass to parse_record
1227
SHA1 digest of the full text after all steps are done
1229
build-parent of the version, i.e. the leftmost ancestor.
1230
Will be None if the record is not a delta.
1231
:param keys: The keys to build a map for
1232
:param allow_missing: If some records are missing, rather than
1233
error, just return the data that could be generated.
1235
raw_map = self._get_record_map_unparsed(keys,
1236
allow_missing=allow_missing)
1237
return self._raw_map_to_record_map(raw_map)
1239
def _raw_map_to_record_map(self, raw_map):
1240
"""Parse the contents of _get_record_map_unparsed.
1242
:return: see _get_record_map.
1246
data, record_details, next = raw_map[key]
1247
content, digest = self._parse_record(key[-1], data)
1248
result[key] = content, record_details, digest, next
1251
def _get_record_map_unparsed(self, keys, allow_missing=False):
1252
"""Get the raw data for reconstructing keys without parsing it.
1254
:return: A dict suitable for parsing via _raw_map_to_record_map.
1255
key-> raw_bytes, (method, noeol), compression_parent
1257
# This retries the whole request if anything fails. Potentially we
1258
# could be a bit more selective. We could track the keys whose records
1259
# we have successfully found, and then only request the new records
1260
# from there. However, _get_components_positions grabs the whole build
1261
# chain, which means we'll likely try to grab the same records again
1262
# anyway. Also, can the build chains change as part of a pack
1263
# operation? We wouldn't want to end up with a broken chain.
1266
position_map = self._get_components_positions(keys,
1267
allow_missing=allow_missing)
1268
# key = component_id, r = record_details, i_m = index_memo,
1270
records = [(key, i_m) for key, (r, i_m, n)
1271
in position_map.iteritems()]
1272
# Sort by the index memo, so that we request records from the
1273
# same pack file together, and in forward-sorted order
1274
records.sort(key=operator.itemgetter(1))
1276
for key, data in self._read_records_iter_unchecked(records):
1277
(record_details, index_memo, next) = position_map[key]
1278
raw_record_map[key] = data, record_details, next
1279
return raw_record_map
1280
except errors.RetryWithNewPacks, e:
1281
self._access.reload_or_raise(e)
1284
def _split_by_prefix(cls, keys):
1285
"""For the given keys, split them up based on their prefix.
1287
To keep memory pressure somewhat under control, split the
1288
requests back into per-file-id requests, otherwise "bzr co"
1289
extracts the full tree into memory before writing it to disk.
1290
This should be revisited if _get_content_maps() can ever cross
1293
The keys for a given file_id are kept in the same relative order.
1294
Ordering between file_ids is not, though prefix_order will return the
1295
order that the key was first seen.
1297
:param keys: An iterable of key tuples
1298
:return: (split_map, prefix_order)
1299
split_map A dictionary mapping prefix => keys
1300
prefix_order The order that we saw the various prefixes
1302
split_by_prefix = {}
1310
if prefix in split_by_prefix:
1311
split_by_prefix[prefix].append(key)
1313
split_by_prefix[prefix] = [key]
1314
prefix_order.append(prefix)
1315
return split_by_prefix, prefix_order
1317
def _group_keys_for_io(self, keys, non_local_keys, positions,
1318
_min_buffer_size=_STREAM_MIN_BUFFER_SIZE):
1319
"""For the given keys, group them into 'best-sized' requests.
1321
The idea is to avoid making 1 request per file, but to never try to
1322
unpack an entire 1.5GB source tree in a single pass. Also when
1323
possible, we should try to group requests to the same pack file
1326
:return: list of (keys, non_local) tuples that indicate what keys
1327
should be fetched next.
1329
# TODO: Ideally we would group on 2 factors. We want to extract texts
1330
# from the same pack file together, and we want to extract all
1331
# the texts for a given build-chain together. Ultimately it
1332
# probably needs a better global view.
1333
total_keys = len(keys)
1334
prefix_split_keys, prefix_order = self._split_by_prefix(keys)
1335
prefix_split_non_local_keys, _ = self._split_by_prefix(non_local_keys)
1337
cur_non_local = set()
1341
for prefix in prefix_order:
1342
keys = prefix_split_keys[prefix]
1343
non_local = prefix_split_non_local_keys.get(prefix, [])
1345
this_size = self._index._get_total_build_size(keys, positions)
1346
cur_size += this_size
1347
cur_keys.extend(keys)
1348
cur_non_local.update(non_local)
1349
if cur_size > _min_buffer_size:
1350
result.append((cur_keys, cur_non_local))
1351
sizes.append(cur_size)
1353
cur_non_local = set()
1356
result.append((cur_keys, cur_non_local))
1357
sizes.append(cur_size)
1360
def get_record_stream(self, keys, ordering, include_delta_closure):
1361
"""Get a stream of records for keys.
1363
:param keys: The keys to include.
1364
:param ordering: Either 'unordered' or 'topological'. A topologically
1365
sorted stream has compression parents strictly before their
1367
:param include_delta_closure: If True then the closure across any
1368
compression parents will be included (in the opaque data).
1369
:return: An iterator of ContentFactory objects, each of which is only
1370
valid until the iterator is advanced.
1372
# keys might be a generator
1376
if not self._index.has_graph:
1377
# Cannot sort when no graph has been stored.
1378
ordering = 'unordered'
1380
remaining_keys = keys
1383
keys = set(remaining_keys)
1384
for content_factory in self._get_remaining_record_stream(keys,
1385
ordering, include_delta_closure):
1386
remaining_keys.discard(content_factory.key)
1387
yield content_factory
1389
except errors.RetryWithNewPacks, e:
1390
self._access.reload_or_raise(e)
1392
def _get_remaining_record_stream(self, keys, ordering,
1393
include_delta_closure):
1394
"""This function is the 'retry' portion for get_record_stream."""
1395
if include_delta_closure:
1396
positions = self._get_components_positions(keys, allow_missing=True)
1398
build_details = self._index.get_build_details(keys)
1400
# (record_details, access_memo, compression_parent_key)
1401
positions = dict((key, self._build_details_to_components(details))
1402
for key, details in build_details.iteritems())
1403
absent_keys = keys.difference(set(positions))
1404
# There may be more absent keys : if we're missing the basis component
1405
# and are trying to include the delta closure.
1406
# XXX: We should not ever need to examine remote sources because we do
1407
# not permit deltas across versioned files boundaries.
1408
if include_delta_closure:
1409
needed_from_fallback = set()
1410
# Build up reconstructable_keys dict. key:True in this dict means
1411
# the key can be reconstructed.
1412
reconstructable_keys = {}
1416
chain = [key, positions[key][2]]
1418
needed_from_fallback.add(key)
1421
while chain[-1] is not None:
1422
if chain[-1] in reconstructable_keys:
1423
result = reconstructable_keys[chain[-1]]
1427
chain.append(positions[chain[-1]][2])
1429
# missing basis component
1430
needed_from_fallback.add(chain[-1])
1433
for chain_key in chain[:-1]:
1434
reconstructable_keys[chain_key] = result
1436
needed_from_fallback.add(key)
1437
# Double index lookups here : need a unified api ?
1438
global_map, parent_maps = self._get_parent_map_with_sources(keys)
1439
if ordering in ('topological', 'groupcompress'):
1440
if ordering == 'topological':
1441
# Global topological sort
1442
present_keys = tsort.topo_sort(global_map)
1444
present_keys = sort_groupcompress(global_map)
1445
# Now group by source:
1447
current_source = None
1448
for key in present_keys:
1449
for parent_map in parent_maps:
1450
if key in parent_map:
1451
key_source = parent_map
1453
if current_source is not key_source:
1454
source_keys.append((key_source, []))
1455
current_source = key_source
1456
source_keys[-1][1].append(key)
1458
if ordering != 'unordered':
1459
raise AssertionError('valid values for ordering are:'
1460
' "unordered", "groupcompress" or "topological" not: %r'
1462
# Just group by source; remote sources first.
1465
for parent_map in reversed(parent_maps):
1466
source_keys.append((parent_map, []))
1467
for key in parent_map:
1468
present_keys.append(key)
1469
source_keys[-1][1].append(key)
1470
# We have been requested to return these records in an order that
1471
# suits us. So we ask the index to give us an optimally sorted
1473
for source, sub_keys in source_keys:
1474
if source is parent_maps[0]:
1475
# Only sort the keys for this VF
1476
self._index._sort_keys_by_io(sub_keys, positions)
1477
absent_keys = keys - set(global_map)
1478
for key in absent_keys:
1479
yield AbsentContentFactory(key)
1480
# restrict our view to the keys we can answer.
1481
# XXX: Memory: TODO: batch data here to cap buffered data at (say) 1MB.
1482
# XXX: At that point we need to consider the impact of double reads by
1483
# utilising components multiple times.
1484
if include_delta_closure:
1485
# XXX: get_content_maps performs its own index queries; allow state
1487
non_local_keys = needed_from_fallback - absent_keys
1488
for keys, non_local_keys in self._group_keys_for_io(present_keys,
1491
generator = _VFContentMapGenerator(self, keys, non_local_keys,
1493
for record in generator.get_record_stream():
1496
for source, keys in source_keys:
1497
if source is parent_maps[0]:
1498
# this KnitVersionedFiles
1499
records = [(key, positions[key][1]) for key in keys]
1500
for key, raw_data, sha1 in self._read_records_iter_raw(records):
1501
(record_details, index_memo, _) = positions[key]
1502
yield KnitContentFactory(key, global_map[key],
1503
record_details, sha1, raw_data, self._factory.annotated, None)
1505
vf = self._fallback_vfs[parent_maps.index(source) - 1]
1506
for record in vf.get_record_stream(keys, ordering,
1507
include_delta_closure):
1510
def get_sha1s(self, keys):
1511
"""See VersionedFiles.get_sha1s()."""
1513
record_map = self._get_record_map(missing, allow_missing=True)
1515
for key, details in record_map.iteritems():
1516
if key not in missing:
1518
# record entry 2 is the 'digest'.
1519
result[key] = details[2]
1520
missing.difference_update(set(result))
1521
for source in self._fallback_vfs:
1524
new_result = source.get_sha1s(missing)
1525
result.update(new_result)
1526
missing.difference_update(set(new_result))
1529
def insert_record_stream(self, stream):
1530
"""Insert a record stream into this container.
1532
:param stream: A stream of records to insert.
1534
:seealso VersionedFiles.get_record_stream:
1536
def get_adapter(adapter_key):
1538
return adapters[adapter_key]
1540
adapter_factory = adapter_registry.get(adapter_key)
1541
adapter = adapter_factory(self)
1542
adapters[adapter_key] = adapter
1545
if self._factory.annotated:
1546
# self is annotated, we need annotated knits to use directly.
1547
annotated = "annotated-"
1550
# self is not annotated, but we can strip annotations cheaply.
1552
convertibles = set(["knit-annotated-ft-gz"])
1553
if self._max_delta_chain:
1554
delta_types.add("knit-annotated-delta-gz")
1555
convertibles.add("knit-annotated-delta-gz")
1556
# The set of types we can cheaply adapt without needing basis texts.
1557
native_types = set()
1558
if self._max_delta_chain:
1559
native_types.add("knit-%sdelta-gz" % annotated)
1560
delta_types.add("knit-%sdelta-gz" % annotated)
1561
native_types.add("knit-%sft-gz" % annotated)
1562
knit_types = native_types.union(convertibles)
1564
# Buffer all index entries that we can't add immediately because their
1565
# basis parent is missing. We don't buffer all because generating
1566
# annotations may require access to some of the new records. However we
1567
# can't generate annotations from new deltas until their basis parent
1568
# is present anyway, so we get away with not needing an index that
1569
# includes the new keys.
1571
# See <http://launchpad.net/bugs/300177> about ordering of compression
1572
# parents in the records - to be conservative, we insist that all
1573
# parents must be present to avoid expanding to a fulltext.
1575
# key = basis_parent, value = index entry to add
1576
buffered_index_entries = {}
1577
for record in stream:
1579
parents = record.parents
1580
if record.storage_kind in delta_types:
1581
# TODO: eventually the record itself should track
1582
# compression_parent
1583
compression_parent = parents[0]
1585
compression_parent = None
1586
# Raise an error when a record is missing.
1587
if record.storage_kind == 'absent':
1588
raise RevisionNotPresent([record.key], self)
1589
elif ((record.storage_kind in knit_types)
1590
and (compression_parent is None
1591
or not self._fallback_vfs
1592
or self._index.has_key(compression_parent)
1593
or not self.has_key(compression_parent))):
1594
# we can insert the knit record literally if either it has no
1595
# compression parent OR we already have its basis in this kvf
1596
# OR the basis is not present even in the fallbacks. In the
1597
# last case it will either turn up later in the stream and all
1598
# will be well, or it won't turn up at all and we'll raise an
1601
# TODO: self.has_key is somewhat redundant with
1602
# self._index.has_key; we really want something that directly
1603
# asks if it's only present in the fallbacks. -- mbp 20081119
1604
if record.storage_kind not in native_types:
1606
adapter_key = (record.storage_kind, "knit-delta-gz")
1607
adapter = get_adapter(adapter_key)
1609
adapter_key = (record.storage_kind, "knit-ft-gz")
1610
adapter = get_adapter(adapter_key)
1611
bytes = adapter.get_bytes(record)
1613
# It's a knit record, it has a _raw_record field (even if
1614
# it was reconstituted from a network stream).
1615
bytes = record._raw_record
1616
options = [record._build_details[0]]
1617
if record._build_details[1]:
1618
options.append('no-eol')
1619
# Just blat it across.
1620
# Note: This does end up adding data on duplicate keys. As
1621
# modern repositories use atomic insertions this should not
1622
# lead to excessive growth in the event of interrupted fetches.
1623
# 'knit' repositories may suffer excessive growth, but as a
1624
# deprecated format this is tolerable. It can be fixed if
1625
# needed by in the kndx index support raising on a duplicate
1626
# add with identical parents and options.
1627
access_memo = self._access.add_raw_records(
1628
[(record.key, len(bytes))], bytes)[0]
1629
index_entry = (record.key, options, access_memo, parents)
1630
if 'fulltext' not in options:
1631
# Not a fulltext, so we need to make sure the compression
1632
# parent will also be present.
1633
# Note that pack backed knits don't need to buffer here
1634
# because they buffer all writes to the transaction level,
1635
# but we don't expose that difference at the index level. If
1636
# the query here has sufficient cost to show up in
1637
# profiling we should do that.
1639
# They're required to be physically in this
1640
# KnitVersionedFiles, not in a fallback.
1641
if not self._index.has_key(compression_parent):
1642
pending = buffered_index_entries.setdefault(
1643
compression_parent, [])
1644
pending.append(index_entry)
1647
self._index.add_records([index_entry])
1648
elif record.storage_kind == 'chunked':
1649
self.add_lines(record.key, parents,
1650
osutils.chunks_to_lines(record.get_bytes_as('chunked')))
1652
# Not suitable for direct insertion as a
1653
# delta, either because it's not the right format, or this
1654
# KnitVersionedFiles doesn't permit deltas (_max_delta_chain ==
1655
# 0) or because it depends on a base only present in the
1657
self._access.flush()
1659
# Try getting a fulltext directly from the record.
1660
bytes = record.get_bytes_as('fulltext')
1661
except errors.UnavailableRepresentation:
1662
adapter_key = record.storage_kind, 'fulltext'
1663
adapter = get_adapter(adapter_key)
1664
bytes = adapter.get_bytes(record)
1665
lines = split_lines(bytes)
1667
self.add_lines(record.key, parents, lines)
1668
except errors.RevisionAlreadyPresent:
1670
# Add any records whose basis parent is now available.
1672
added_keys = [record.key]
1674
key = added_keys.pop(0)
1675
if key in buffered_index_entries:
1676
index_entries = buffered_index_entries[key]
1677
self._index.add_records(index_entries)
1679
[index_entry[0] for index_entry in index_entries])
1680
del buffered_index_entries[key]
1681
if buffered_index_entries:
1682
# There were index entries buffered at the end of the stream,
1683
# So these need to be added (if the index supports holding such
1684
# entries for later insertion)
1685
for key in buffered_index_entries:
1686
index_entries = buffered_index_entries[key]
1687
self._index.add_records(index_entries,
1688
missing_compression_parents=True)
1690
def get_missing_compression_parent_keys(self):
1691
"""Return an iterable of keys of missing compression parents.
1693
Check this after calling insert_record_stream to find out if there are
1694
any missing compression parents. If there are, the records that
1695
depend on them are not able to be inserted safely. For atomic
1696
KnitVersionedFiles built on packs, the transaction should be aborted or
1697
suspended - commit will fail at this point. Nonatomic knits will error
1698
earlier because they have no staging area to put pending entries into.
1700
return self._index.get_missing_compression_parents()
1702
def iter_lines_added_or_present_in_keys(self, keys, pb=None):
1703
"""Iterate over the lines in the versioned files from keys.
1705
This may return lines from other keys. Each item the returned
1706
iterator yields is a tuple of a line and a text version that that line
1707
is present in (not introduced in).
1709
Ordering of results is in whatever order is most suitable for the
1710
underlying storage format.
1712
If a progress bar is supplied, it may be used to indicate progress.
1713
The caller is responsible for cleaning up progress bars (because this
1717
* Lines are normalised by the underlying store: they will all have \\n
1719
* Lines are returned in arbitrary order.
1720
* If a requested key did not change any lines (or didn't have any
1721
lines), it may not be mentioned at all in the result.
1723
:param pb: Progress bar supplied by caller.
1724
:return: An iterator over (line, key).
1727
pb = progress.DummyProgress()
1733
# we don't care about inclusions, the caller cares.
1734
# but we need to setup a list of records to visit.
1735
# we need key, position, length
1737
build_details = self._index.get_build_details(keys)
1738
for key, details in build_details.iteritems():
1740
key_records.append((key, details[0]))
1741
records_iter = enumerate(self._read_records_iter(key_records))
1742
for (key_idx, (key, data, sha_value)) in records_iter:
1743
pb.update('Walking content', key_idx, total)
1744
compression_parent = build_details[key][1]
1745
if compression_parent is None:
1747
line_iterator = self._factory.get_fulltext_content(data)
1750
line_iterator = self._factory.get_linedelta_content(data)
1751
# Now that we are yielding the data for this key, remove it
1754
# XXX: It might be more efficient to yield (key,
1755
# line_iterator) in the future. However for now, this is a
1756
# simpler change to integrate into the rest of the
1757
# codebase. RBC 20071110
1758
for line in line_iterator:
1761
except errors.RetryWithNewPacks, e:
1762
self._access.reload_or_raise(e)
1763
# If there are still keys we've not yet found, we look in the fallback
1764
# vfs, and hope to find them there. Note that if the keys are found
1765
# but had no changes or no content, the fallback may not return
1767
if keys and not self._fallback_vfs:
1768
# XXX: strictly the second parameter is meant to be the file id
1769
# but it's not easily accessible here.
1770
raise RevisionNotPresent(keys, repr(self))
1771
for source in self._fallback_vfs:
1775
for line, key in source.iter_lines_added_or_present_in_keys(keys):
1776
source_keys.add(key)
1778
keys.difference_update(source_keys)
1779
pb.update('Walking content', total, total)
1781
def _make_line_delta(self, delta_seq, new_content):
1782
"""Generate a line delta from delta_seq and new_content."""
1784
for op in delta_seq.get_opcodes():
1785
if op[0] == 'equal':
1787
diff_hunks.append((op[1], op[2], op[4]-op[3], new_content._lines[op[3]:op[4]]))
1790
def _merge_annotations(self, content, parents, parent_texts={},
1791
delta=None, annotated=None,
1792
left_matching_blocks=None):
1793
"""Merge annotations for content and generate deltas.
1795
This is done by comparing the annotations based on changes to the text
1796
and generating a delta on the resulting full texts. If annotations are
1797
not being created then a simple delta is created.
1799
if left_matching_blocks is not None:
1800
delta_seq = diff._PrematchedMatcher(left_matching_blocks)
1804
for parent_key in parents:
1805
merge_content = self._get_content(parent_key, parent_texts)
1806
if (parent_key == parents[0] and delta_seq is not None):
1809
seq = patiencediff.PatienceSequenceMatcher(
1810
None, merge_content.text(), content.text())
1811
for i, j, n in seq.get_matching_blocks():
1814
# this copies (origin, text) pairs across to the new
1815
# content for any line that matches the last-checked
1817
content._lines[j:j+n] = merge_content._lines[i:i+n]
1818
# XXX: Robert says the following block is a workaround for a
1819
# now-fixed bug and it can probably be deleted. -- mbp 20080618
1820
if content._lines and content._lines[-1][1][-1] != '\n':
1821
# The copied annotation was from a line without a trailing EOL,
1822
# reinstate one for the content object, to ensure correct
1824
line = content._lines[-1][1] + '\n'
1825
content._lines[-1] = (content._lines[-1][0], line)
1827
if delta_seq is None:
1828
reference_content = self._get_content(parents[0], parent_texts)
1829
new_texts = content.text()
1830
old_texts = reference_content.text()
1831
delta_seq = patiencediff.PatienceSequenceMatcher(
1832
None, old_texts, new_texts)
1833
return self._make_line_delta(delta_seq, content)
1835
def _parse_record(self, version_id, data):
1836
"""Parse an original format knit record.
1838
These have the last element of the key only present in the stored data.
1840
rec, record_contents = self._parse_record_unchecked(data)
1841
self._check_header_version(rec, version_id)
1842
return record_contents, rec[3]
1844
def _parse_record_header(self, key, raw_data):
1845
"""Parse a record header for consistency.
1847
:return: the header and the decompressor stream.
1848
as (stream, header_record)
1850
df = tuned_gzip.GzipFile(mode='rb', fileobj=StringIO(raw_data))
1853
rec = self._check_header(key, df.readline())
1854
except Exception, e:
1855
raise KnitCorrupt(self,
1856
"While reading {%s} got %s(%s)"
1857
% (key, e.__class__.__name__, str(e)))
1860
def _parse_record_unchecked(self, data):
1862
# 4168 calls in 2880 217 internal
1863
# 4168 calls to _parse_record_header in 2121
1864
# 4168 calls to readlines in 330
1865
df = tuned_gzip.GzipFile(mode='rb', fileobj=StringIO(data))
1867
record_contents = df.readlines()
1868
except Exception, e:
1869
raise KnitCorrupt(self, "Corrupt compressed record %r, got %s(%s)" %
1870
(data, e.__class__.__name__, str(e)))
1871
header = record_contents.pop(0)
1872
rec = self._split_header(header)
1873
last_line = record_contents.pop()
1874
if len(record_contents) != int(rec[2]):
1875
raise KnitCorrupt(self,
1876
'incorrect number of lines %s != %s'
1877
' for version {%s} %s'
1878
% (len(record_contents), int(rec[2]),
1879
rec[1], record_contents))
1880
if last_line != 'end %s\n' % rec[1]:
1881
raise KnitCorrupt(self,
1882
'unexpected version end line %r, wanted %r'
1883
% (last_line, rec[1]))
1885
return rec, record_contents
1887
def _read_records_iter(self, records):
1888
"""Read text records from data file and yield result.
1890
The result will be returned in whatever is the fastest to read.
1891
Not by the order requested. Also, multiple requests for the same
1892
record will only yield 1 response.
1893
:param records: A list of (key, access_memo) entries
1894
:return: Yields (key, contents, digest) in the order
1895
read, not the order requested
1900
# XXX: This smells wrong, IO may not be getting ordered right.
1901
needed_records = sorted(set(records), key=operator.itemgetter(1))
1902
if not needed_records:
1905
# The transport optimizes the fetching as well
1906
# (ie, reads continuous ranges.)
1907
raw_data = self._access.get_raw_records(
1908
[index_memo for key, index_memo in needed_records])
1910
for (key, index_memo), data in \
1911
izip(iter(needed_records), raw_data):
1912
content, digest = self._parse_record(key[-1], data)
1913
yield key, content, digest
1915
def _read_records_iter_raw(self, records):
1916
"""Read text records from data file and yield raw data.
1918
This unpacks enough of the text record to validate the id is
1919
as expected but thats all.
1921
Each item the iterator yields is (key, bytes,
1922
expected_sha1_of_full_text).
1924
for key, data in self._read_records_iter_unchecked(records):
1925
# validate the header (note that we can only use the suffix in
1926
# current knit records).
1927
df, rec = self._parse_record_header(key, data)
1929
yield key, data, rec[3]
1931
def _read_records_iter_unchecked(self, records):
1932
"""Read text records from data file and yield raw data.
1934
No validation is done.
1936
Yields tuples of (key, data).
1938
# setup an iterator of the external records:
1939
# uses readv so nice and fast we hope.
1941
# grab the disk data needed.
1942
needed_offsets = [index_memo for key, index_memo
1944
raw_records = self._access.get_raw_records(needed_offsets)
1946
for key, index_memo in records:
1947
data = raw_records.next()
1950
def _record_to_data(self, key, digest, lines, dense_lines=None):
1951
"""Convert key, digest, lines into a raw data block.
1953
:param key: The key of the record. Currently keys are always serialised
1954
using just the trailing component.
1955
:param dense_lines: The bytes of lines but in a denser form. For
1956
instance, if lines is a list of 1000 bytestrings each ending in \n,
1957
dense_lines may be a list with one line in it, containing all the
1958
1000's lines and their \n's. Using dense_lines if it is already
1959
known is a win because the string join to create bytes in this
1960
function spends less time resizing the final string.
1961
:return: (len, a StringIO instance with the raw data ready to read.)
1963
chunks = ["version %s %d %s\n" % (key[-1], len(lines), digest)]
1964
chunks.extend(dense_lines or lines)
1965
chunks.append("end %s\n" % key[-1])
1966
for chunk in chunks:
1967
if type(chunk) is not str:
1968
raise AssertionError(
1969
'data must be plain bytes was %s' % type(chunk))
1970
if lines and lines[-1][-1] != '\n':
1971
raise ValueError('corrupt lines value %r' % lines)
1972
compressed_bytes = tuned_gzip.chunks_to_gzip(chunks)
1973
return len(compressed_bytes), compressed_bytes
1975
def _split_header(self, line):
1978
raise KnitCorrupt(self,
1979
'unexpected number of elements in record header')
1983
"""See VersionedFiles.keys."""
1984
if 'evil' in debug.debug_flags:
1985
trace.mutter_callsite(2, "keys scales with size of history")
1986
sources = [self._index] + self._fallback_vfs
1988
for source in sources:
1989
result.update(source.keys())
1993
class _ContentMapGenerator(object):
1994
"""Generate texts or expose raw deltas for a set of texts."""
1996
def _get_content(self, key):
1997
"""Get the content object for key."""
1998
# Note that _get_content is only called when the _ContentMapGenerator
1999
# has been constructed with just one key requested for reconstruction.
2000
if key in self.nonlocal_keys:
2001
record = self.get_record_stream().next()
2002
# Create a content object on the fly
2003
lines = osutils.chunks_to_lines(record.get_bytes_as('chunked'))
2004
return PlainKnitContent(lines, record.key)
2006
# local keys we can ask for directly
2007
return self._get_one_work(key)
2009
def get_record_stream(self):
2010
"""Get a record stream for the keys requested during __init__."""
2011
for record in self._work():
2015
"""Produce maps of text and KnitContents as dicts.
2017
:return: (text_map, content_map) where text_map contains the texts for
2018
the requested versions and content_map contains the KnitContents.
2020
# NB: By definition we never need to read remote sources unless texts
2021
# are requested from them: we don't delta across stores - and we
2022
# explicitly do not want to to prevent data loss situations.
2023
if self.global_map is None:
2024
self.global_map = self.vf.get_parent_map(self.keys)
2025
nonlocal_keys = self.nonlocal_keys
2027
missing_keys = set(nonlocal_keys)
2028
# Read from remote versioned file instances and provide to our caller.
2029
for source in self.vf._fallback_vfs:
2030
if not missing_keys:
2032
# Loop over fallback repositories asking them for texts - ignore
2033
# any missing from a particular fallback.
2034
for record in source.get_record_stream(missing_keys,
2036
if record.storage_kind == 'absent':
2037
# Not in thie particular stream, may be in one of the
2038
# other fallback vfs objects.
2040
missing_keys.remove(record.key)
2043
if self._raw_record_map is None:
2044
raise AssertionError('_raw_record_map should have been filled')
2046
for key in self.keys:
2047
if key in self.nonlocal_keys:
2049
yield LazyKnitContentFactory(key, self.global_map[key], self, first)
2052
def _get_one_work(self, requested_key):
2053
# Now, if we have calculated everything already, just return the
2055
if requested_key in self._contents_map:
2056
return self._contents_map[requested_key]
2057
# To simplify things, parse everything at once - code that wants one text
2058
# probably wants them all.
2059
# FUTURE: This function could be improved for the 'extract many' case
2060
# by tracking each component and only doing the copy when the number of
2061
# children than need to apply delta's to it is > 1 or it is part of the
2063
multiple_versions = len(self.keys) != 1
2064
if self._record_map is None:
2065
self._record_map = self.vf._raw_map_to_record_map(
2066
self._raw_record_map)
2067
record_map = self._record_map
2068
# raw_record_map is key:
2069
# Have read and parsed records at this point.
2070
for key in self.keys:
2071
if key in self.nonlocal_keys:
2076
while cursor is not None:
2078
record, record_details, digest, next = record_map[cursor]
2080
raise RevisionNotPresent(cursor, self)
2081
components.append((cursor, record, record_details, digest))
2083
if cursor in self._contents_map:
2084
# no need to plan further back
2085
components.append((cursor, None, None, None))
2089
for (component_id, record, record_details,
2090
digest) in reversed(components):
2091
if component_id in self._contents_map:
2092
content = self._contents_map[component_id]
2094
content, delta = self._factory.parse_record(key[-1],
2095
record, record_details, content,
2096
copy_base_content=multiple_versions)
2097
if multiple_versions:
2098
self._contents_map[component_id] = content
2100
# digest here is the digest from the last applied component.
2101
text = content.text()
2102
actual_sha = sha_strings(text)
2103
if actual_sha != digest:
2104
raise SHA1KnitCorrupt(self, actual_sha, digest, key, text)
2105
if multiple_versions:
2106
return self._contents_map[requested_key]
2110
def _wire_bytes(self):
2111
"""Get the bytes to put on the wire for 'key'.
2113
The first collection of bytes asked for returns the serialised
2114
raw_record_map and the additional details (key, parent) for key.
2115
Subsequent calls return just the additional details (key, parent).
2116
The wire storage_kind given for the first key is 'knit-delta-closure',
2117
For subsequent keys it is 'knit-delta-closure-ref'.
2119
:param key: A key from the content generator.
2120
:return: Bytes to put on the wire.
2123
# kind marker for dispatch on the far side,
2124
lines.append('knit-delta-closure')
2126
if self.vf._factory.annotated:
2127
lines.append('annotated')
2130
# then the list of keys
2131
lines.append('\t'.join(['\x00'.join(key) for key in self.keys
2132
if key not in self.nonlocal_keys]))
2133
# then the _raw_record_map in serialised form:
2135
# for each item in the map:
2137
# 1 line with parents if the key is to be yielded (None: for None, '' for ())
2138
# one line with method
2139
# one line with noeol
2140
# one line with next ('' for None)
2141
# one line with byte count of the record bytes
2143
for key, (record_bytes, (method, noeol), next) in \
2144
self._raw_record_map.iteritems():
2145
key_bytes = '\x00'.join(key)
2146
parents = self.global_map.get(key, None)
2148
parent_bytes = 'None:'
2150
parent_bytes = '\t'.join('\x00'.join(key) for key in parents)
2151
method_bytes = method
2157
next_bytes = '\x00'.join(next)
2160
map_byte_list.append('%s\n%s\n%s\n%s\n%s\n%d\n%s' % (
2161
key_bytes, parent_bytes, method_bytes, noeol_bytes, next_bytes,
2162
len(record_bytes), record_bytes))
2163
map_bytes = ''.join(map_byte_list)
2164
lines.append(map_bytes)
2165
bytes = '\n'.join(lines)
2169
class _VFContentMapGenerator(_ContentMapGenerator):
2170
"""Content map generator reading from a VersionedFiles object."""
2172
def __init__(self, versioned_files, keys, nonlocal_keys=None,
2173
global_map=None, raw_record_map=None):
2174
"""Create a _ContentMapGenerator.
2176
:param versioned_files: The versioned files that the texts are being
2178
:param keys: The keys to produce content maps for.
2179
:param nonlocal_keys: An iterable of keys(possibly intersecting keys)
2180
which are known to not be in this knit, but rather in one of the
2182
:param global_map: The result of get_parent_map(keys) (or a supermap).
2183
This is required if get_record_stream() is to be used.
2184
:param raw_record_map: A unparsed raw record map to use for answering
2187
# The vf to source data from
2188
self.vf = versioned_files
2190
self.keys = list(keys)
2191
# Keys known to be in fallback vfs objects
2192
if nonlocal_keys is None:
2193
self.nonlocal_keys = set()
2195
self.nonlocal_keys = frozenset(nonlocal_keys)
2196
# Parents data for keys to be returned in get_record_stream
2197
self.global_map = global_map
2198
# The chunked lists for self.keys in text form
2200
# A cache of KnitContent objects used in extracting texts.
2201
self._contents_map = {}
2202
# All the knit records needed to assemble the requested keys as full
2204
self._record_map = None
2205
if raw_record_map is None:
2206
self._raw_record_map = self.vf._get_record_map_unparsed(keys,
2209
self._raw_record_map = raw_record_map
2210
# the factory for parsing records
2211
self._factory = self.vf._factory
2214
class _NetworkContentMapGenerator(_ContentMapGenerator):
2215
"""Content map generator sourced from a network stream."""
2217
def __init__(self, bytes, line_end):
2218
"""Construct a _NetworkContentMapGenerator from a bytes block."""
2220
self.global_map = {}
2221
self._raw_record_map = {}
2222
self._contents_map = {}
2223
self._record_map = None
2224
self.nonlocal_keys = []
2225
# Get access to record parsing facilities
2226
self.vf = KnitVersionedFiles(None, None)
2229
line_end = bytes.find('\n', start)
2230
line = bytes[start:line_end]
2231
start = line_end + 1
2232
if line == 'annotated':
2233
self._factory = KnitAnnotateFactory()
2235
self._factory = KnitPlainFactory()
2236
# list of keys to emit in get_record_stream
2237
line_end = bytes.find('\n', start)
2238
line = bytes[start:line_end]
2239
start = line_end + 1
2241
tuple(segment.split('\x00')) for segment in line.split('\t')
2243
# now a loop until the end. XXX: It would be nice if this was just a
2244
# bunch of the same records as get_record_stream(..., False) gives, but
2245
# there is a decent sized gap stopping that at the moment.
2249
line_end = bytes.find('\n', start)
2250
key = tuple(bytes[start:line_end].split('\x00'))
2251
start = line_end + 1
2252
# 1 line with parents (None: for None, '' for ())
2253
line_end = bytes.find('\n', start)
2254
line = bytes[start:line_end]
2259
[tuple(segment.split('\x00')) for segment in line.split('\t')
2261
self.global_map[key] = parents
2262
start = line_end + 1
2263
# one line with method
2264
line_end = bytes.find('\n', start)
2265
line = bytes[start:line_end]
2267
start = line_end + 1
2268
# one line with noeol
2269
line_end = bytes.find('\n', start)
2270
line = bytes[start:line_end]
2272
start = line_end + 1
2273
# one line with next ('' for None)
2274
line_end = bytes.find('\n', start)
2275
line = bytes[start:line_end]
2279
next = tuple(bytes[start:line_end].split('\x00'))
2280
start = line_end + 1
2281
# one line with byte count of the record bytes
2282
line_end = bytes.find('\n', start)
2283
line = bytes[start:line_end]
2285
start = line_end + 1
2287
record_bytes = bytes[start:start+count]
2288
start = start + count
2290
self._raw_record_map[key] = (record_bytes, (method, noeol), next)
2292
def get_record_stream(self):
2293
"""Get a record stream for for keys requested by the bytestream."""
2295
for key in self.keys:
2296
yield LazyKnitContentFactory(key, self.global_map[key], self, first)
2299
def _wire_bytes(self):
2303
class _KndxIndex(object):
2304
"""Manages knit index files
2306
The index is kept in memory and read on startup, to enable
2307
fast lookups of revision information. The cursor of the index
2308
file is always pointing to the end, making it easy to append
2311
_cache is a cache for fast mapping from version id to a Index
2314
_history is a cache for fast mapping from indexes to version ids.
2316
The index data format is dictionary compressed when it comes to
2317
parent references; a index entry may only have parents that with a
2318
lover index number. As a result, the index is topological sorted.
2320
Duplicate entries may be written to the index for a single version id
2321
if this is done then the latter one completely replaces the former:
2322
this allows updates to correct version and parent information.
2323
Note that the two entries may share the delta, and that successive
2324
annotations and references MUST point to the first entry.
2326
The index file on disc contains a header, followed by one line per knit
2327
record. The same revision can be present in an index file more than once.
2328
The first occurrence gets assigned a sequence number starting from 0.
2330
The format of a single line is
2331
REVISION_ID FLAGS BYTE_OFFSET LENGTH( PARENT_ID|PARENT_SEQUENCE_ID)* :\n
2332
REVISION_ID is a utf8-encoded revision id
2333
FLAGS is a comma separated list of flags about the record. Values include
2334
no-eol, line-delta, fulltext.
2335
BYTE_OFFSET is the ascii representation of the byte offset in the data file
2336
that the the compressed data starts at.
2337
LENGTH is the ascii representation of the length of the data file.
2338
PARENT_ID a utf-8 revision id prefixed by a '.' that is a parent of
2340
PARENT_SEQUENCE_ID the ascii representation of the sequence number of a
2341
revision id already in the knit that is a parent of REVISION_ID.
2342
The ' :' marker is the end of record marker.
2345
when a write is interrupted to the index file, it will result in a line
2346
that does not end in ' :'. If the ' :' is not present at the end of a line,
2347
or at the end of the file, then the record that is missing it will be
2348
ignored by the parser.
2350
When writing new records to the index file, the data is preceded by '\n'
2351
to ensure that records always start on new lines even if the last write was
2352
interrupted. As a result its normal for the last line in the index to be
2353
missing a trailing newline. One can be added with no harmful effects.
2355
:ivar _kndx_cache: dict from prefix to the old state of KnitIndex objects,
2356
where prefix is e.g. the (fileid,) for .texts instances or () for
2357
constant-mapped things like .revisions, and the old state is
2358
tuple(history_vector, cache_dict). This is used to prevent having an
2359
ABI change with the C extension that reads .kndx files.
2362
HEADER = "# bzr knit index 8\n"
2364
def __init__(self, transport, mapper, get_scope, allow_writes, is_locked):
2365
"""Create a _KndxIndex on transport using mapper."""
2366
self._transport = transport
2367
self._mapper = mapper
2368
self._get_scope = get_scope
2369
self._allow_writes = allow_writes
2370
self._is_locked = is_locked
2372
self.has_graph = True
2374
def add_records(self, records, random_id=False, missing_compression_parents=False):
2375
"""Add multiple records to the index.
2377
:param records: a list of tuples:
2378
(key, options, access_memo, parents).
2379
:param random_id: If True the ids being added were randomly generated
2380
and no check for existence will be performed.
2381
:param missing_compression_parents: If True the records being added are
2382
only compressed against texts already in the index (or inside
2383
records). If False the records all refer to unavailable texts (or
2384
texts inside records) as compression parents.
2386
if missing_compression_parents:
2387
# It might be nice to get the edge of the records. But keys isn't
2389
keys = sorted(record[0] for record in records)
2390
raise errors.RevisionNotPresent(keys, self)
2392
for record in records:
2395
path = self._mapper.map(key) + '.kndx'
2396
path_keys = paths.setdefault(path, (prefix, []))
2397
path_keys[1].append(record)
2398
for path in sorted(paths):
2399
prefix, path_keys = paths[path]
2400
self._load_prefixes([prefix])
2402
orig_history = self._kndx_cache[prefix][1][:]
2403
orig_cache = self._kndx_cache[prefix][0].copy()
2406
for key, options, (_, pos, size), parents in path_keys:
2408
# kndx indices cannot be parentless.
2410
line = "\n%s %s %s %s %s :" % (
2411
key[-1], ','.join(options), pos, size,
2412
self._dictionary_compress(parents))
2413
if type(line) is not str:
2414
raise AssertionError(
2415
'data must be utf8 was %s' % type(line))
2417
self._cache_key(key, options, pos, size, parents)
2418
if len(orig_history):
2419
self._transport.append_bytes(path, ''.join(lines))
2421
self._init_index(path, lines)
2423
# If any problems happen, restore the original values and re-raise
2424
self._kndx_cache[prefix] = (orig_cache, orig_history)
2427
def scan_unvalidated_index(self, graph_index):
2428
"""See _KnitGraphIndex.scan_unvalidated_index."""
2429
# Because kndx files do not support atomic insertion via separate index
2430
# files, they do not support this method.
2431
raise NotImplementedError(self.scan_unvalidated_index)
2433
def get_missing_compression_parents(self):
2434
"""See _KnitGraphIndex.get_missing_compression_parents."""
2435
# Because kndx files do not support atomic insertion via separate index
2436
# files, they do not support this method.
2437
raise NotImplementedError(self.get_missing_compression_parents)
2439
def _cache_key(self, key, options, pos, size, parent_keys):
2440
"""Cache a version record in the history array and index cache.
2442
This is inlined into _load_data for performance. KEEP IN SYNC.
2443
(It saves 60ms, 25% of the __init__ overhead on local 4000 record
2447
version_id = key[-1]
2448
# last-element only for compatibilty with the C load_data.
2449
parents = tuple(parent[-1] for parent in parent_keys)
2450
for parent in parent_keys:
2451
if parent[:-1] != prefix:
2452
raise ValueError("mismatched prefixes for %r, %r" % (
2454
cache, history = self._kndx_cache[prefix]
2455
# only want the _history index to reference the 1st index entry
2457
if version_id not in cache:
2458
index = len(history)
2459
history.append(version_id)
2461
index = cache[version_id][5]
2462
cache[version_id] = (version_id,
2469
def check_header(self, fp):
2470
line = fp.readline()
2472
# An empty file can actually be treated as though the file doesn't
2474
raise errors.NoSuchFile(self)
2475
if line != self.HEADER:
2476
raise KnitHeaderError(badline=line, filename=self)
2478
def _check_read(self):
2479
if not self._is_locked():
2480
raise errors.ObjectNotLocked(self)
2481
if self._get_scope() != self._scope:
2484
def _check_write_ok(self):
2485
"""Assert if not writes are permitted."""
2486
if not self._is_locked():
2487
raise errors.ObjectNotLocked(self)
2488
if self._get_scope() != self._scope:
2490
if self._mode != 'w':
2491
raise errors.ReadOnlyObjectDirtiedError(self)
2493
def get_build_details(self, keys):
2494
"""Get the method, index_memo and compression parent for keys.
2496
Ghosts are omitted from the result.
2498
:param keys: An iterable of keys.
2499
:return: A dict of key:(index_memo, compression_parent, parents,
2502
opaque structure to pass to read_records to extract the raw
2505
Content that this record is built upon, may be None
2507
Logical parents of this node
2509
extra information about the content which needs to be passed to
2510
Factory.parse_record
2512
parent_map = self.get_parent_map(keys)
2515
if key not in parent_map:
2517
method = self.get_method(key)
2518
parents = parent_map[key]
2519
if method == 'fulltext':
2520
compression_parent = None
2522
compression_parent = parents[0]
2523
noeol = 'no-eol' in self.get_options(key)
2524
index_memo = self.get_position(key)
2525
result[key] = (index_memo, compression_parent,
2526
parents, (method, noeol))
2529
def get_method(self, key):
2530
"""Return compression method of specified key."""
2531
options = self.get_options(key)
2532
if 'fulltext' in options:
2534
elif 'line-delta' in options:
2537
raise errors.KnitIndexUnknownMethod(self, options)
2539
def get_options(self, key):
2540
"""Return a list representing options.
2544
prefix, suffix = self._split_key(key)
2545
self._load_prefixes([prefix])
2547
return self._kndx_cache[prefix][0][suffix][1]
2549
raise RevisionNotPresent(key, self)
2551
def get_parent_map(self, keys):
2552
"""Get a map of the parents of keys.
2554
:param keys: The keys to look up parents for.
2555
:return: A mapping from keys to parents. Absent keys are absent from
2558
# Parse what we need to up front, this potentially trades off I/O
2559
# locality (.kndx and .knit in the same block group for the same file
2560
# id) for less checking in inner loops.
2561
prefixes = set(key[:-1] for key in keys)
2562
self._load_prefixes(prefixes)
2567
suffix_parents = self._kndx_cache[prefix][0][key[-1]][4]
2571
result[key] = tuple(prefix + (suffix,) for
2572
suffix in suffix_parents)
2575
def get_position(self, key):
2576
"""Return details needed to access the version.
2578
:return: a tuple (key, data position, size) to hand to the access
2579
logic to get the record.
2581
prefix, suffix = self._split_key(key)
2582
self._load_prefixes([prefix])
2583
entry = self._kndx_cache[prefix][0][suffix]
2584
return key, entry[2], entry[3]
2586
has_key = _mod_index._has_key_from_parent_map
2588
def _init_index(self, path, extra_lines=[]):
2589
"""Initialize an index."""
2591
sio.write(self.HEADER)
2592
sio.writelines(extra_lines)
2594
self._transport.put_file_non_atomic(path, sio,
2595
create_parent_dir=True)
2596
# self._create_parent_dir)
2597
# mode=self._file_mode,
2598
# dir_mode=self._dir_mode)
2601
"""Get all the keys in the collection.
2603
The keys are not ordered.
2606
# Identify all key prefixes.
2607
# XXX: A bit hacky, needs polish.
2608
if type(self._mapper) is ConstantMapper:
2612
for quoted_relpath in self._transport.iter_files_recursive():
2613
path, ext = os.path.splitext(quoted_relpath)
2615
prefixes = [self._mapper.unmap(path) for path in relpaths]
2616
self._load_prefixes(prefixes)
2617
for prefix in prefixes:
2618
for suffix in self._kndx_cache[prefix][1]:
2619
result.add(prefix + (suffix,))
2622
def _load_prefixes(self, prefixes):
2623
"""Load the indices for prefixes."""
2625
for prefix in prefixes:
2626
if prefix not in self._kndx_cache:
2627
# the load_data interface writes to these variables.
2630
self._filename = prefix
2632
path = self._mapper.map(prefix) + '.kndx'
2633
fp = self._transport.get(path)
2635
# _load_data may raise NoSuchFile if the target knit is
2637
_load_data(self, fp)
2640
self._kndx_cache[prefix] = (self._cache, self._history)
2645
self._kndx_cache[prefix] = ({}, [])
2646
if type(self._mapper) is ConstantMapper:
2647
# preserve behaviour for revisions.kndx etc.
2648
self._init_index(path)
2653
missing_keys = _mod_index._missing_keys_from_parent_map
2655
def _partition_keys(self, keys):
2656
"""Turn keys into a dict of prefix:suffix_list."""
2659
prefix_keys = result.setdefault(key[:-1], [])
2660
prefix_keys.append(key[-1])
2663
def _dictionary_compress(self, keys):
2664
"""Dictionary compress keys.
2666
:param keys: The keys to generate references to.
2667
:return: A string representation of keys. keys which are present are
2668
dictionary compressed, and others are emitted as fulltext with a
2674
prefix = keys[0][:-1]
2675
cache = self._kndx_cache[prefix][0]
2677
if key[:-1] != prefix:
2678
# kndx indices cannot refer across partitioned storage.
2679
raise ValueError("mismatched prefixes for %r" % keys)
2680
if key[-1] in cache:
2681
# -- inlined lookup() --
2682
result_list.append(str(cache[key[-1]][5]))
2683
# -- end lookup () --
2685
result_list.append('.' + key[-1])
2686
return ' '.join(result_list)
2688
def _reset_cache(self):
2689
# Possibly this should be a LRU cache. A dictionary from key_prefix to
2690
# (cache_dict, history_vector) for parsed kndx files.
2691
self._kndx_cache = {}
2692
self._scope = self._get_scope()
2693
allow_writes = self._allow_writes()
2699
def _sort_keys_by_io(self, keys, positions):
2700
"""Figure out an optimal order to read the records for the given keys.
2702
Sort keys, grouped by index and sorted by position.
2704
:param keys: A list of keys whose records we want to read. This will be
2706
:param positions: A dict, such as the one returned by
2707
_get_components_positions()
2710
def get_sort_key(key):
2711
index_memo = positions[key][1]
2712
# Group by prefix and position. index_memo[0] is the key, so it is
2713
# (file_id, revision_id) and we don't want to sort on revision_id,
2714
# index_memo[1] is the position, and index_memo[2] is the size,
2715
# which doesn't matter for the sort
2716
return index_memo[0][:-1], index_memo[1]
2717
return keys.sort(key=get_sort_key)
2719
_get_total_build_size = _get_total_build_size
2721
def _split_key(self, key):
2722
"""Split key into a prefix and suffix."""
2723
return key[:-1], key[-1]
2726
class _KeyRefs(object):
2729
# dict mapping 'key' to 'set of keys referring to that key'
2732
def add_references(self, key, refs):
2733
# Record the new references
2734
for referenced in refs:
2736
needed_by = self.refs[referenced]
2738
needed_by = self.refs[referenced] = set()
2740
# Discard references satisfied by the new key
2743
def get_unsatisfied_refs(self):
2744
return self.refs.iterkeys()
2746
def add_key(self, key):
2750
# No keys depended on this key. That's ok.
2753
def add_keys(self, keys):
2757
def get_referrers(self):
2759
for referrers in self.refs.itervalues():
2760
result.update(referrers)
2764
class _KnitGraphIndex(object):
2765
"""A KnitVersionedFiles index layered on GraphIndex."""
2767
def __init__(self, graph_index, is_locked, deltas=False, parents=True,
2768
add_callback=None, track_external_parent_refs=False):
2769
"""Construct a KnitGraphIndex on a graph_index.
2771
:param graph_index: An implementation of bzrlib.index.GraphIndex.
2772
:param is_locked: A callback to check whether the object should answer
2774
:param deltas: Allow delta-compressed records.
2775
:param parents: If True, record knits parents, if not do not record
2777
:param add_callback: If not None, allow additions to the index and call
2778
this callback with a list of added GraphIndex nodes:
2779
[(node, value, node_refs), ...]
2780
:param is_locked: A callback, returns True if the index is locked and
2782
:param track_external_parent_refs: If True, record all external parent
2783
references parents from added records. These can be retrieved
2784
later by calling get_missing_parents().
2786
self._add_callback = add_callback
2787
self._graph_index = graph_index
2788
self._deltas = deltas
2789
self._parents = parents
2790
if deltas and not parents:
2791
# XXX: TODO: Delta tree and parent graph should be conceptually
2793
raise KnitCorrupt(self, "Cannot do delta compression without "
2795
self.has_graph = parents
2796
self._is_locked = is_locked
2797
self._missing_compression_parents = set()
2798
if track_external_parent_refs:
2799
self._key_dependencies = _KeyRefs()
2801
self._key_dependencies = None
2804
return "%s(%r)" % (self.__class__.__name__, self._graph_index)
2806
def add_records(self, records, random_id=False,
2807
missing_compression_parents=False):
2808
"""Add multiple records to the index.
2810
This function does not insert data into the Immutable GraphIndex
2811
backing the KnitGraphIndex, instead it prepares data for insertion by
2812
the caller and checks that it is safe to insert then calls
2813
self._add_callback with the prepared GraphIndex nodes.
2815
:param records: a list of tuples:
2816
(key, options, access_memo, parents).
2817
:param random_id: If True the ids being added were randomly generated
2818
and no check for existence will be performed.
2819
:param missing_compression_parents: If True the records being added are
2820
only compressed against texts already in the index (or inside
2821
records). If False the records all refer to unavailable texts (or
2822
texts inside records) as compression parents.
2824
if not self._add_callback:
2825
raise errors.ReadOnlyError(self)
2826
# we hope there are no repositories with inconsistent parentage
2830
compression_parents = set()
2831
key_dependencies = self._key_dependencies
2832
for (key, options, access_memo, parents) in records:
2834
parents = tuple(parents)
2835
if key_dependencies is not None:
2836
key_dependencies.add_references(key, parents)
2837
index, pos, size = access_memo
2838
if 'no-eol' in options:
2842
value += "%d %d" % (pos, size)
2843
if not self._deltas:
2844
if 'line-delta' in options:
2845
raise KnitCorrupt(self, "attempt to add line-delta in non-delta knit")
2848
if 'line-delta' in options:
2849
node_refs = (parents, (parents[0],))
2850
if missing_compression_parents:
2851
compression_parents.add(parents[0])
2853
node_refs = (parents, ())
2855
node_refs = (parents, )
2858
raise KnitCorrupt(self, "attempt to add node with parents "
2859
"in parentless index.")
2861
keys[key] = (value, node_refs)
2864
present_nodes = self._get_entries(keys)
2865
for (index, key, value, node_refs) in present_nodes:
2866
if (value[0] != keys[key][0][0] or
2867
node_refs[:1] != keys[key][1][:1]):
2868
raise KnitCorrupt(self, "inconsistent details in add_records"
2869
": %s %s" % ((value, node_refs), keys[key]))
2873
for key, (value, node_refs) in keys.iteritems():
2874
result.append((key, value, node_refs))
2876
for key, (value, node_refs) in keys.iteritems():
2877
result.append((key, value))
2878
self._add_callback(result)
2879
if missing_compression_parents:
2880
# This may appear to be incorrect (it does not check for
2881
# compression parents that are in the existing graph index),
2882
# but such records won't have been buffered, so this is
2883
# actually correct: every entry when
2884
# missing_compression_parents==True either has a missing parent, or
2885
# a parent that is one of the keys in records.
2886
compression_parents.difference_update(keys)
2887
self._missing_compression_parents.update(compression_parents)
2888
# Adding records may have satisfied missing compression parents.
2889
self._missing_compression_parents.difference_update(keys)
2891
def scan_unvalidated_index(self, graph_index):
2892
"""Inform this _KnitGraphIndex that there is an unvalidated index.
2894
This allows this _KnitGraphIndex to keep track of any missing
2895
compression parents we may want to have filled in to make those
2898
:param graph_index: A GraphIndex
2901
new_missing = graph_index.external_references(ref_list_num=1)
2902
new_missing.difference_update(self.get_parent_map(new_missing))
2903
self._missing_compression_parents.update(new_missing)
2904
if self._key_dependencies is not None:
2905
# Add parent refs from graph_index (and discard parent refs that
2906
# the graph_index has).
2907
for node in graph_index.iter_all_entries():
2908
self._key_dependencies.add_references(node[1], node[3][0])
2910
def get_missing_compression_parents(self):
2911
"""Return the keys of missing compression parents.
2913
Missing compression parents occur when a record stream was missing
2914
basis texts, or a index was scanned that had missing basis texts.
2916
return frozenset(self._missing_compression_parents)
2918
def get_missing_parents(self):
2919
"""Return the keys of missing parents."""
2920
# If updating this, you should also update
2921
# groupcompress._GCGraphIndex.get_missing_parents
2922
# We may have false positives, so filter those out.
2923
self._key_dependencies.add_keys(
2924
self.get_parent_map(self._key_dependencies.get_unsatisfied_refs()))
2925
return frozenset(self._key_dependencies.get_unsatisfied_refs())
2927
def _check_read(self):
2928
"""raise if reads are not permitted."""
2929
if not self._is_locked():
2930
raise errors.ObjectNotLocked(self)
2932
def _check_write_ok(self):
2933
"""Assert if writes are not permitted."""
2934
if not self._is_locked():
2935
raise errors.ObjectNotLocked(self)
2937
def _compression_parent(self, an_entry):
2938
# return the key that an_entry is compressed against, or None
2939
# Grab the second parent list (as deltas implies parents currently)
2940
compression_parents = an_entry[3][1]
2941
if not compression_parents:
2943
if len(compression_parents) != 1:
2944
raise AssertionError(
2945
"Too many compression parents: %r" % compression_parents)
2946
return compression_parents[0]
2948
def get_build_details(self, keys):
2949
"""Get the method, index_memo and compression parent for version_ids.
2951
Ghosts are omitted from the result.
2953
:param keys: An iterable of keys.
2954
:return: A dict of key:
2955
(index_memo, compression_parent, parents, record_details).
2957
opaque structure to pass to read_records to extract the raw
2960
Content that this record is built upon, may be None
2962
Logical parents of this node
2964
extra information about the content which needs to be passed to
2965
Factory.parse_record
2969
entries = self._get_entries(keys, False)
2970
for entry in entries:
2972
if not self._parents:
2975
parents = entry[3][0]
2976
if not self._deltas:
2977
compression_parent_key = None
2979
compression_parent_key = self._compression_parent(entry)
2980
noeol = (entry[2][0] == 'N')
2981
if compression_parent_key:
2982
method = 'line-delta'
2985
result[key] = (self._node_to_position(entry),
2986
compression_parent_key, parents,
2990
def _get_entries(self, keys, check_present=False):
2991
"""Get the entries for keys.
2993
:param keys: An iterable of index key tuples.
2998
for node in self._graph_index.iter_entries(keys):
3000
found_keys.add(node[1])
3002
# adapt parentless index to the rest of the code.
3003
for node in self._graph_index.iter_entries(keys):
3004
yield node[0], node[1], node[2], ()
3005
found_keys.add(node[1])
3007
missing_keys = keys.difference(found_keys)
3009
raise RevisionNotPresent(missing_keys.pop(), self)
3011
def get_method(self, key):
3012
"""Return compression method of specified key."""
3013
return self._get_method(self._get_node(key))
3015
def _get_method(self, node):
3016
if not self._deltas:
3018
if self._compression_parent(node):
3023
def _get_node(self, key):
3025
return list(self._get_entries([key]))[0]
3027
raise RevisionNotPresent(key, self)
3029
def get_options(self, key):
3030
"""Return a list representing options.
3034
node = self._get_node(key)
3035
options = [self._get_method(node)]
3036
if node[2][0] == 'N':
3037
options.append('no-eol')
3040
def get_parent_map(self, keys):
3041
"""Get a map of the parents of keys.
3043
:param keys: The keys to look up parents for.
3044
:return: A mapping from keys to parents. Absent keys are absent from
3048
nodes = self._get_entries(keys)
3052
result[node[1]] = node[3][0]
3055
result[node[1]] = None
3058
def get_position(self, key):
3059
"""Return details needed to access the version.
3061
:return: a tuple (index, data position, size) to hand to the access
3062
logic to get the record.
3064
node = self._get_node(key)
3065
return self._node_to_position(node)
3067
has_key = _mod_index._has_key_from_parent_map
3070
"""Get all the keys in the collection.
3072
The keys are not ordered.
3075
return [node[1] for node in self._graph_index.iter_all_entries()]
3077
missing_keys = _mod_index._missing_keys_from_parent_map
3079
def _node_to_position(self, node):
3080
"""Convert an index value to position details."""
3081
bits = node[2][1:].split(' ')
3082
return node[0], int(bits[0]), int(bits[1])
3084
def _sort_keys_by_io(self, keys, positions):
3085
"""Figure out an optimal order to read the records for the given keys.
3087
Sort keys, grouped by index and sorted by position.
3089
:param keys: A list of keys whose records we want to read. This will be
3091
:param positions: A dict, such as the one returned by
3092
_get_components_positions()
3095
def get_index_memo(key):
3096
# index_memo is at offset [1]. It is made up of (GraphIndex,
3097
# position, size). GI is an object, which will be unique for each
3098
# pack file. This causes us to group by pack file, then sort by
3099
# position. Size doesn't matter, but it isn't worth breaking up the
3101
return positions[key][1]
3102
return keys.sort(key=get_index_memo)
3104
_get_total_build_size = _get_total_build_size
3107
class _KnitKeyAccess(object):
3108
"""Access to records in .knit files."""
3110
def __init__(self, transport, mapper):
3111
"""Create a _KnitKeyAccess with transport and mapper.
3113
:param transport: The transport the access object is rooted at.
3114
:param mapper: The mapper used to map keys to .knit files.
3116
self._transport = transport
3117
self._mapper = mapper
3119
def add_raw_records(self, key_sizes, raw_data):
3120
"""Add raw knit bytes to a storage area.
3122
The data is spooled to the container writer in one bytes-record per
3125
:param sizes: An iterable of tuples containing the key and size of each
3127
:param raw_data: A bytestring containing the data.
3128
:return: A list of memos to retrieve the record later. Each memo is an
3129
opaque index memo. For _KnitKeyAccess the memo is (key, pos,
3130
length), where the key is the record key.
3132
if type(raw_data) is not str:
3133
raise AssertionError(
3134
'data must be plain bytes was %s' % type(raw_data))
3137
# TODO: This can be tuned for writing to sftp and other servers where
3138
# append() is relatively expensive by grouping the writes to each key
3140
for key, size in key_sizes:
3141
path = self._mapper.map(key)
3143
base = self._transport.append_bytes(path + '.knit',
3144
raw_data[offset:offset+size])
3145
except errors.NoSuchFile:
3146
self._transport.mkdir(osutils.dirname(path))
3147
base = self._transport.append_bytes(path + '.knit',
3148
raw_data[offset:offset+size])
3152
result.append((key, base, size))
3156
"""Flush pending writes on this access object.
3158
For .knit files this is a no-op.
3162
def get_raw_records(self, memos_for_retrieval):
3163
"""Get the raw bytes for a records.
3165
:param memos_for_retrieval: An iterable containing the access memo for
3166
retrieving the bytes.
3167
:return: An iterator over the bytes of the records.
3169
# first pass, group into same-index request to minimise readv's issued.
3171
current_prefix = None
3172
for (key, offset, length) in memos_for_retrieval:
3173
if current_prefix == key[:-1]:
3174
current_list.append((offset, length))
3176
if current_prefix is not None:
3177
request_lists.append((current_prefix, current_list))
3178
current_prefix = key[:-1]
3179
current_list = [(offset, length)]
3180
# handle the last entry
3181
if current_prefix is not None:
3182
request_lists.append((current_prefix, current_list))
3183
for prefix, read_vector in request_lists:
3184
path = self._mapper.map(prefix) + '.knit'
3185
for pos, data in self._transport.readv(path, read_vector):
3189
class _DirectPackAccess(object):
3190
"""Access to data in one or more packs with less translation."""
3192
def __init__(self, index_to_packs, reload_func=None, flush_func=None):
3193
"""Create a _DirectPackAccess object.
3195
:param index_to_packs: A dict mapping index objects to the transport
3196
and file names for obtaining data.
3197
:param reload_func: A function to call if we determine that the pack
3198
files have moved and we need to reload our caches. See
3199
bzrlib.repo_fmt.pack_repo.AggregateIndex for more details.
3201
self._container_writer = None
3202
self._write_index = None
3203
self._indices = index_to_packs
3204
self._reload_func = reload_func
3205
self._flush_func = flush_func
3207
def add_raw_records(self, key_sizes, raw_data):
3208
"""Add raw knit bytes to a storage area.
3210
The data is spooled to the container writer in one bytes-record per
3213
:param sizes: An iterable of tuples containing the key and size of each
3215
:param raw_data: A bytestring containing the data.
3216
:return: A list of memos to retrieve the record later. Each memo is an
3217
opaque index memo. For _DirectPackAccess the memo is (index, pos,
3218
length), where the index field is the write_index object supplied
3219
to the PackAccess object.
3221
if type(raw_data) is not str:
3222
raise AssertionError(
3223
'data must be plain bytes was %s' % type(raw_data))
3226
for key, size in key_sizes:
3227
p_offset, p_length = self._container_writer.add_bytes_record(
3228
raw_data[offset:offset+size], [])
3230
result.append((self._write_index, p_offset, p_length))
3234
"""Flush pending writes on this access object.
3236
This will flush any buffered writes to a NewPack.
3238
if self._flush_func is not None:
3241
def get_raw_records(self, memos_for_retrieval):
3242
"""Get the raw bytes for a records.
3244
:param memos_for_retrieval: An iterable containing the (index, pos,
3245
length) memo for retrieving the bytes. The Pack access method
3246
looks up the pack to use for a given record in its index_to_pack
3248
:return: An iterator over the bytes of the records.
3250
# first pass, group into same-index requests
3252
current_index = None
3253
for (index, offset, length) in memos_for_retrieval:
3254
if current_index == index:
3255
current_list.append((offset, length))
3257
if current_index is not None:
3258
request_lists.append((current_index, current_list))
3259
current_index = index
3260
current_list = [(offset, length)]
3261
# handle the last entry
3262
if current_index is not None:
3263
request_lists.append((current_index, current_list))
3264
for index, offsets in request_lists:
3266
transport, path = self._indices[index]
3268
# A KeyError here indicates that someone has triggered an index
3269
# reload, and this index has gone missing, we need to start
3271
if self._reload_func is None:
3272
# If we don't have a _reload_func there is nothing that can
3275
raise errors.RetryWithNewPacks(index,
3276
reload_occurred=True,
3277
exc_info=sys.exc_info())
3279
reader = pack.make_readv_reader(transport, path, offsets)
3280
for names, read_func in reader.iter_records():
3281
yield read_func(None)
3282
except errors.NoSuchFile:
3283
# A NoSuchFile error indicates that a pack file has gone
3284
# missing on disk, we need to trigger a reload, and start over.
3285
if self._reload_func is None:
3287
raise errors.RetryWithNewPacks(transport.abspath(path),
3288
reload_occurred=False,
3289
exc_info=sys.exc_info())
3291
def set_writer(self, writer, index, transport_packname):
3292
"""Set a writer to use for adding data."""
3293
if index is not None:
3294
self._indices[index] = transport_packname
3295
self._container_writer = writer
3296
self._write_index = index
3298
def reload_or_raise(self, retry_exc):
3299
"""Try calling the reload function, or re-raise the original exception.
3301
This should be called after _DirectPackAccess raises a
3302
RetryWithNewPacks exception. This function will handle the common logic
3303
of determining when the error is fatal versus being temporary.
3304
It will also make sure that the original exception is raised, rather
3305
than the RetryWithNewPacks exception.
3307
If this function returns, then the calling function should retry
3308
whatever operation was being performed. Otherwise an exception will
3311
:param retry_exc: A RetryWithNewPacks exception.
3314
if self._reload_func is None:
3316
elif not self._reload_func():
3317
# The reload claimed that nothing changed
3318
if not retry_exc.reload_occurred:
3319
# If there wasn't an earlier reload, then we really were
3320
# expecting to find changes. We didn't find them, so this is a
3324
exc_class, exc_value, exc_traceback = retry_exc.exc_info
3325
raise exc_class, exc_value, exc_traceback
3328
# Deprecated, use PatienceSequenceMatcher instead
3329
KnitSequenceMatcher = patiencediff.PatienceSequenceMatcher
3332
def annotate_knit(knit, revision_id):
3333
"""Annotate a knit with no cached annotations.
3335
This implementation is for knits with no cached annotations.
3336
It will work for knits with cached annotations, but this is not
3339
annotator = _KnitAnnotator(knit)
3340
return iter(annotator.annotate_flat(revision_id))
3343
class _KnitAnnotator(annotate.Annotator):
3344
"""Build up the annotations for a text."""
3346
def __init__(self, vf):
3347
annotate.Annotator.__init__(self, vf)
3349
# TODO: handle Nodes which cannot be extracted
3350
# self._ghosts = set()
3352
# Map from (key, parent_key) => matching_blocks, should be 'use once'
3353
self._matching_blocks = {}
3355
# KnitContent objects
3356
self._content_objects = {}
3357
# The number of children that depend on this fulltext content object
3358
self._num_compression_children = {}
3359
# Delta records that need their compression parent before they can be
3361
self._pending_deltas = {}
3362
# Fulltext records that are waiting for their parents fulltexts before
3363
# they can be yielded for annotation
3364
self._pending_annotation = {}
3366
self._all_build_details = {}
3368
def _get_build_graph(self, key):
3369
"""Get the graphs for building texts and annotations.
3371
The data you need for creating a full text may be different than the
3372
data you need to annotate that text. (At a minimum, you need both
3373
parents to create an annotation, but only need 1 parent to generate the
3376
:return: A list of (key, index_memo) records, suitable for
3377
passing to read_records_iter to start reading in the raw data from
3380
pending = set([key])
3383
self._num_needed_children[key] = 1
3385
# get all pending nodes
3386
this_iteration = pending
3387
build_details = self._vf._index.get_build_details(this_iteration)
3388
self._all_build_details.update(build_details)
3389
# new_nodes = self._vf._index._get_entries(this_iteration)
3391
for key, details in build_details.iteritems():
3392
(index_memo, compression_parent, parent_keys,
3393
record_details) = details
3394
self._parent_map[key] = parent_keys
3395
self._heads_provider = None
3396
records.append((key, index_memo))
3397
# Do we actually need to check _annotated_lines?
3398
pending.update([p for p in parent_keys
3399
if p not in self._all_build_details])
3401
for parent_key in parent_keys:
3402
if parent_key in self._num_needed_children:
3403
self._num_needed_children[parent_key] += 1
3405
self._num_needed_children[parent_key] = 1
3406
if compression_parent:
3407
if compression_parent in self._num_compression_children:
3408
self._num_compression_children[compression_parent] += 1
3410
self._num_compression_children[compression_parent] = 1
3412
missing_versions = this_iteration.difference(build_details.keys())
3413
if missing_versions:
3414
for key in missing_versions:
3415
if key in self._parent_map and key in self._text_cache:
3416
# We already have this text ready, we just need to
3417
# yield it later so we get it annotated
3419
parent_keys = self._parent_map[key]
3420
for parent_key in parent_keys:
3421
if parent_key in self._num_needed_children:
3422
self._num_needed_children[parent_key] += 1
3424
self._num_needed_children[parent_key] = 1
3425
pending.update([p for p in parent_keys
3426
if p not in self._all_build_details])
3428
raise errors.RevisionNotPresent(key, self._vf)
3429
# Generally we will want to read the records in reverse order, because
3430
# we find the parent nodes after the children
3432
return records, ann_keys
3434
def _get_needed_texts(self, key, pb=None):
3435
# if True or len(self._vf._fallback_vfs) > 0:
3436
if len(self._vf._fallback_vfs) > 0:
3437
# If we have fallbacks, go to the generic path
3438
for v in annotate.Annotator._get_needed_texts(self, key, pb=pb):
3443
records, ann_keys = self._get_build_graph(key)
3444
for idx, (sub_key, text, num_lines) in enumerate(
3445
self._extract_texts(records)):
3447
pb.update('annotating', idx, len(records))
3448
yield sub_key, text, num_lines
3449
for sub_key in ann_keys:
3450
text = self._text_cache[sub_key]
3451
num_lines = len(text) # bad assumption
3452
yield sub_key, text, num_lines
3454
except errors.RetryWithNewPacks, e:
3455
self._vf._access.reload_or_raise(e)
3456
# The cached build_details are no longer valid
3457
self._all_build_details.clear()
3459
def _cache_delta_blocks(self, key, compression_parent, delta, lines):
3460
parent_lines = self._text_cache[compression_parent]
3461
blocks = list(KnitContent.get_line_delta_blocks(delta, parent_lines, lines))
3462
self._matching_blocks[(key, compression_parent)] = blocks
3464
def _expand_record(self, key, parent_keys, compression_parent, record,
3467
if compression_parent:
3468
if compression_parent not in self._content_objects:
3469
# Waiting for the parent
3470
self._pending_deltas.setdefault(compression_parent, []).append(
3471
(key, parent_keys, record, record_details))
3473
# We have the basis parent, so expand the delta
3474
num = self._num_compression_children[compression_parent]
3477
base_content = self._content_objects.pop(compression_parent)
3478
self._num_compression_children.pop(compression_parent)
3480
self._num_compression_children[compression_parent] = num
3481
base_content = self._content_objects[compression_parent]
3482
# It is tempting to want to copy_base_content=False for the last
3483
# child object. However, whenever noeol=False,
3484
# self._text_cache[parent_key] is content._lines. So mutating it
3485
# gives very bad results.
3486
# The alternative is to copy the lines into text cache, but then we
3487
# are copying anyway, so just do it here.
3488
content, delta = self._vf._factory.parse_record(
3489
key, record, record_details, base_content,
3490
copy_base_content=True)
3493
content, _ = self._vf._factory.parse_record(
3494
key, record, record_details, None)
3495
if self._num_compression_children.get(key, 0) > 0:
3496
self._content_objects[key] = content
3497
lines = content.text()
3498
self._text_cache[key] = lines
3499
if delta is not None:
3500
self._cache_delta_blocks(key, compression_parent, delta, lines)
3503
def _get_parent_annotations_and_matches(self, key, text, parent_key):
3504
"""Get the list of annotations for the parent, and the matching lines.
3506
:param text: The opaque value given by _get_needed_texts
3507
:param parent_key: The key for the parent text
3508
:return: (parent_annotations, matching_blocks)
3509
parent_annotations is a list as long as the number of lines in
3511
matching_blocks is a list of (parent_idx, text_idx, len) tuples
3512
indicating which lines match between the two texts
3514
block_key = (key, parent_key)
3515
if block_key in self._matching_blocks:
3516
blocks = self._matching_blocks.pop(block_key)
3517
parent_annotations = self._annotations_cache[parent_key]
3518
return parent_annotations, blocks
3519
return annotate.Annotator._get_parent_annotations_and_matches(self,
3520
key, text, parent_key)
3522
def _process_pending(self, key):
3523
"""The content for 'key' was just processed.
3525
Determine if there is any more pending work to be processed.
3528
if key in self._pending_deltas:
3529
compression_parent = key
3530
children = self._pending_deltas.pop(key)
3531
for child_key, parent_keys, record, record_details in children:
3532
lines = self._expand_record(child_key, parent_keys,
3534
record, record_details)
3535
if self._check_ready_for_annotations(child_key, parent_keys):
3536
to_return.append(child_key)
3537
# Also check any children that are waiting for this parent to be
3539
if key in self._pending_annotation:
3540
children = self._pending_annotation.pop(key)
3541
to_return.extend([c for c, p_keys in children
3542
if self._check_ready_for_annotations(c, p_keys)])
3545
def _check_ready_for_annotations(self, key, parent_keys):
3546
"""return true if this text is ready to be yielded.
3548
Otherwise, this will return False, and queue the text into
3549
self._pending_annotation
3551
for parent_key in parent_keys:
3552
if parent_key not in self._annotations_cache:
3553
# still waiting on at least one parent text, so queue it up
3554
# Note that if there are multiple parents, we need to wait
3556
self._pending_annotation.setdefault(parent_key,
3557
[]).append((key, parent_keys))
3561
def _extract_texts(self, records):
3562
"""Extract the various texts needed based on records"""
3563
# We iterate in the order read, rather than a strict order requested
3564
# However, process what we can, and put off to the side things that
3565
# still need parents, cleaning them up when those parents are
3568
# 1) As 'records' are read, see if we can expand these records into
3569
# Content objects (and thus lines)
3570
# 2) If a given line-delta is waiting on its compression parent, it
3571
# gets queued up into self._pending_deltas, otherwise we expand
3572
# it, and put it into self._text_cache and self._content_objects
3573
# 3) If we expanded the text, we will then check to see if all
3574
# parents have also been processed. If so, this text gets yielded,
3575
# else this record gets set aside into pending_annotation
3576
# 4) Further, if we expanded the text in (2), we will then check to
3577
# see if there are any children in self._pending_deltas waiting to
3578
# also be processed. If so, we go back to (2) for those
3579
# 5) Further again, if we yielded the text, we can then check if that
3580
# 'unlocks' any of the texts in pending_annotations, which should
3581
# then get yielded as well
3582
# Note that both steps 4 and 5 are 'recursive' in that unlocking one
3583
# compression child could unlock yet another, and yielding a fulltext
3584
# will also 'unlock' the children that are waiting on that annotation.
3585
# (Though also, unlocking 1 parent's fulltext, does not unlock a child
3586
# if other parents are also waiting.)
3587
# We want to yield content before expanding child content objects, so
3588
# that we know when we can re-use the content lines, and the annotation
3589
# code can know when it can stop caching fulltexts, as well.
3591
# Children that are missing their compression parent
3593
for (key, record, digest) in self._vf._read_records_iter(records):
3595
details = self._all_build_details[key]
3596
(_, compression_parent, parent_keys, record_details) = details
3597
lines = self._expand_record(key, parent_keys, compression_parent,
3598
record, record_details)
3600
# Pending delta should be queued up
3602
# At this point, we may be able to yield this content, if all
3603
# parents are also finished
3604
yield_this_text = self._check_ready_for_annotations(key,
3607
# All parents present
3608
yield key, lines, len(lines)
3609
to_process = self._process_pending(key)
3611
this_process = to_process
3613
for key in this_process:
3614
lines = self._text_cache[key]
3615
yield key, lines, len(lines)
3616
to_process.extend(self._process_pending(key))
3619
from bzrlib._knit_load_data_c import _load_data_c as _load_data
3621
from bzrlib._knit_load_data_py import _load_data_py as _load_data
added
removed
bzrlib/knit.py
