~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repofmt/pack_repo.py

(gz) Fix test failure on alpha by correcting format string for
 gc_chk_sha1_record (Martin [gz])

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2007-2011 Canonical Ltd
 
1
# Copyright (C) 2007-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
25
25
from bzrlib import (
26
26
    chk_map,
27
27
    cleanup,
28
 
    config,
29
28
    debug,
30
29
    graph,
31
30
    osutils,
32
31
    pack,
33
32
    transactions,
34
 
    tsort,
35
33
    ui,
 
34
    xml5,
 
35
    xml6,
 
36
    xml7,
36
37
    )
37
38
from bzrlib.index import (
38
39
    CombinedGraphIndex,
39
40
    GraphIndexPrefixAdapter,
40
41
    )
 
42
from bzrlib.knit import (
 
43
    KnitPlainFactory,
 
44
    KnitVersionedFiles,
 
45
    _KnitGraphIndex,
 
46
    _DirectPackAccess,
 
47
    )
 
48
from bzrlib import tsort
41
49
""")
42
50
from bzrlib import (
 
51
    bzrdir,
43
52
    btree_index,
44
53
    errors,
45
54
    lockable_files,
46
55
    lockdir,
 
56
    revision as _mod_revision,
47
57
    )
48
58
 
49
 
from bzrlib.decorators import (
50
 
    needs_read_lock,
51
 
    needs_write_lock,
52
 
    only_raises,
 
59
from bzrlib.decorators import needs_write_lock, only_raises
 
60
from bzrlib.index import (
 
61
    GraphIndex,
 
62
    InMemoryGraphIndex,
53
63
    )
54
64
from bzrlib.lock import LogicalLockResult
 
65
from bzrlib.repofmt.knitrepo import KnitRepository
55
66
from bzrlib.repository import (
56
 
    _LazyListJoin,
57
 
    MetaDirRepository,
 
67
    CommitBuilder,
 
68
    MetaDirRepositoryFormat,
58
69
    RepositoryFormat,
59
70
    RepositoryWriteLockResult,
60
 
    )
61
 
from bzrlib.vf_repository import (
62
 
    MetaDirVersionedFileRepository,
63
 
    MetaDirVersionedFileRepositoryFormat,
64
 
    VersionedFileCommitBuilder,
65
 
    VersionedFileRootCommitBuilder,
 
71
    RootCommitBuilder,
 
72
    StreamSource,
66
73
    )
67
74
from bzrlib.trace import (
68
75
    mutter,
71
78
    )
72
79
 
73
80
 
74
 
class PackCommitBuilder(VersionedFileCommitBuilder):
75
 
    """Subclass of VersionedFileCommitBuilder to add texts with pack semantics.
 
81
class PackCommitBuilder(CommitBuilder):
 
82
    """A subclass of CommitBuilder to add texts with pack semantics.
76
83
 
77
84
    Specifically this uses one knit object rather than one knit object per
78
85
    added text, reducing memory and object pressure.
80
87
 
81
88
    def __init__(self, repository, parents, config, timestamp=None,
82
89
                 timezone=None, committer=None, revprops=None,
83
 
                 revision_id=None, lossy=False):
84
 
        VersionedFileCommitBuilder.__init__(self, repository, parents, config,
 
90
                 revision_id=None):
 
91
        CommitBuilder.__init__(self, repository, parents, config,
85
92
            timestamp=timestamp, timezone=timezone, committer=committer,
86
 
            revprops=revprops, revision_id=revision_id, lossy=lossy)
 
93
            revprops=revprops, revision_id=revision_id)
87
94
        self._file_graph = graph.Graph(
88
95
            repository._pack_collection.text_index.combined_index)
89
96
 
92
99
        return set([key[1] for key in self._file_graph.heads(keys)])
93
100
 
94
101
 
95
 
class PackRootCommitBuilder(VersionedFileRootCommitBuilder):
 
102
class PackRootCommitBuilder(RootCommitBuilder):
96
103
    """A subclass of RootCommitBuilder to add texts with pack semantics.
97
104
 
98
105
    Specifically this uses one knit object rather than one knit object per
101
108
 
102
109
    def __init__(self, repository, parents, config, timestamp=None,
103
110
                 timezone=None, committer=None, revprops=None,
104
 
                 revision_id=None, lossy=False):
105
 
        super(PackRootCommitBuilder, self).__init__(repository, parents,
106
 
            config, timestamp=timestamp, timezone=timezone,
107
 
            committer=committer, revprops=revprops, revision_id=revision_id,
108
 
            lossy=lossy)
 
111
                 revision_id=None):
 
112
        CommitBuilder.__init__(self, repository, parents, config,
 
113
            timestamp=timestamp, timezone=timezone, committer=committer,
 
114
            revprops=revprops, revision_id=revision_id)
109
115
        self._file_graph = graph.Graph(
110
116
            repository._pack_collection.text_index.combined_index)
111
117
 
315
321
        for index_type in index_types:
316
322
            old_name = self.index_name(index_type, self.name)
317
323
            new_name = '../indices/' + old_name
318
 
            self.upload_transport.move(old_name, new_name)
 
324
            self.upload_transport.rename(old_name, new_name)
319
325
            self._replace_index_with_readonly(index_type)
320
326
        new_name = '../packs/' + self.file_name()
321
 
        self.upload_transport.move(self.file_name(), new_name)
 
327
        self.upload_transport.rename(self.file_name(), new_name)
322
328
        self._state = 'finished'
323
329
 
324
330
    def _get_external_refs(self, index):
479
485
        # visible is smaller.  On the other hand none will be seen until
480
486
        # they're in the names list.
481
487
        self.index_sizes = [None, None, None, None]
482
 
        self._write_index('revision', self.revision_index, 'revision',
483
 
            suspend)
 
488
        self._write_index('revision', self.revision_index, 'revision', suspend)
484
489
        self._write_index('inventory', self.inventory_index, 'inventory',
485
490
            suspend)
486
491
        self._write_index('text', self.text_index, 'file texts', suspend)
490
495
            self.index_sizes.append(None)
491
496
            self._write_index('chk', self.chk_index,
492
497
                'content hash bytes', suspend)
493
 
        self.write_stream.close(
494
 
            want_fdatasync=self._pack_collection.config_stack.get('repository.fdatasync'))
 
498
        self.write_stream.close()
495
499
        # Note that this will clobber an existing pack with the same name,
496
500
        # without checking for hash collisions. While this is undesirable this
497
501
        # is something that can be rectified in a subsequent release. One way
506
510
        new_name = self.name + '.pack'
507
511
        if not suspend:
508
512
            new_name = '../packs/' + new_name
509
 
        self.upload_transport.move(self.random_name, new_name)
 
513
        self.upload_transport.rename(self.random_name, new_name)
510
514
        self._state = 'finished'
511
515
        if 'pack' in debug.debug_flags:
512
516
            # XXX: size might be interesting?
540
544
            transport = self.upload_transport
541
545
        else:
542
546
            transport = self.index_transport
543
 
        index_tempfile = index.finish()
544
 
        index_bytes = index_tempfile.read()
545
 
        write_stream = transport.open_write_stream(index_name,
546
 
            mode=self._file_mode)
547
 
        write_stream.write(index_bytes)
548
 
        write_stream.close(
549
 
            want_fdatasync=self._pack_collection.config_stack.get('repository.fdatasync'))
550
 
        self.index_sizes[self.index_offset(index_type)] = len(index_bytes)
 
547
        self.index_sizes[self.index_offset(index_type)] = transport.put_file(
 
548
            index_name, index.finish(), mode=self._file_mode)
551
549
        if 'pack' in debug.debug_flags:
552
550
            # XXX: size might be interesting?
553
551
            mutter('%s: create_pack: wrote %s index: %s%s t+%6.3fs',
675
673
        # What text keys to copy. None for 'all texts'. This is set by
676
674
        # _copy_inventory_texts
677
675
        self._text_filter = None
 
676
        self._extra_init()
 
677
 
 
678
    def _extra_init(self):
 
679
        """A template hook to allow extending the constructor trivially."""
 
680
 
 
681
    def _pack_map_and_index_list(self, index_attribute):
 
682
        """Convert a list of packs to an index pack map and index list.
 
683
 
 
684
        :param index_attribute: The attribute that the desired index is found
 
685
            on.
 
686
        :return: A tuple (map, list) where map contains the dict from
 
687
            index:pack_tuple, and list contains the indices in the preferred
 
688
            access order.
 
689
        """
 
690
        indices = []
 
691
        pack_map = {}
 
692
        for pack_obj in self.packs:
 
693
            index = getattr(pack_obj, index_attribute)
 
694
            indices.append(index)
 
695
            pack_map[index] = pack_obj
 
696
        return pack_map, indices
 
697
 
 
698
    def _index_contents(self, indices, key_filter=None):
 
699
        """Get an iterable of the index contents from a pack_map.
 
700
 
 
701
        :param indices: The list of indices to query
 
702
        :param key_filter: An optional filter to limit the keys returned.
 
703
        """
 
704
        all_index = CombinedGraphIndex(indices)
 
705
        if key_filter is None:
 
706
            return all_index.iter_all_entries()
 
707
        else:
 
708
            return all_index.iter_entries(key_filter)
678
709
 
679
710
    def pack(self, pb=None):
680
711
        """Create a new pack by reading data from other packs.
729
760
        new_pack.signature_index.set_optimize(combine_backing_indices=False)
730
761
        return new_pack
731
762
 
 
763
    def _update_pack_order(self, entries, index_to_pack_map):
 
764
        """Determine how we want our packs to be ordered.
 
765
 
 
766
        This changes the sort order of the self.packs list so that packs unused
 
767
        by 'entries' will be at the end of the list, so that future requests
 
768
        can avoid probing them.  Used packs will be at the front of the
 
769
        self.packs list, in the order of their first use in 'entries'.
 
770
 
 
771
        :param entries: A list of (index, ...) tuples
 
772
        :param index_to_pack_map: A mapping from index objects to pack objects.
 
773
        """
 
774
        packs = []
 
775
        seen_indexes = set()
 
776
        for entry in entries:
 
777
            index = entry[0]
 
778
            if index not in seen_indexes:
 
779
                packs.append(index_to_pack_map[index])
 
780
                seen_indexes.add(index)
 
781
        if len(packs) == len(self.packs):
 
782
            if 'pack' in debug.debug_flags:
 
783
                mutter('Not changing pack list, all packs used.')
 
784
            return
 
785
        seen_packs = set(packs)
 
786
        for pack in self.packs:
 
787
            if pack not in seen_packs:
 
788
                packs.append(pack)
 
789
                seen_packs.add(pack)
 
790
        if 'pack' in debug.debug_flags:
 
791
            old_names = [p.access_tuple()[1] for p in self.packs]
 
792
            new_names = [p.access_tuple()[1] for p in packs]
 
793
            mutter('Reordering packs\nfrom: %s\n  to: %s',
 
794
                   old_names, new_names)
 
795
        self.packs = packs
 
796
 
732
797
    def _copy_revision_texts(self):
733
798
        """Copy revision data to the new pack."""
734
 
        raise NotImplementedError(self._copy_revision_texts)
 
799
        # select revisions
 
800
        if self.revision_ids:
 
801
            revision_keys = [(revision_id,) for revision_id in self.revision_ids]
 
802
        else:
 
803
            revision_keys = None
 
804
        # select revision keys
 
805
        revision_index_map, revision_indices = self._pack_map_and_index_list(
 
806
            'revision_index')
 
807
        revision_nodes = self._index_contents(revision_indices, revision_keys)
 
808
        revision_nodes = list(revision_nodes)
 
809
        self._update_pack_order(revision_nodes, revision_index_map)
 
810
        # copy revision keys and adjust values
 
811
        self.pb.update("Copying revision texts", 1)
 
812
        total_items, readv_group_iter = self._revision_node_readv(revision_nodes)
 
813
        list(self._copy_nodes_graph(revision_index_map, self.new_pack._writer,
 
814
            self.new_pack.revision_index, readv_group_iter, total_items))
 
815
        if 'pack' in debug.debug_flags:
 
816
            mutter('%s: create_pack: revisions copied: %s%s %d items t+%6.3fs',
 
817
                time.ctime(), self._pack_collection._upload_transport.base,
 
818
                self.new_pack.random_name,
 
819
                self.new_pack.revision_index.key_count(),
 
820
                time.time() - self.new_pack.start_time)
 
821
        self._revision_keys = revision_keys
735
822
 
736
823
    def _copy_inventory_texts(self):
737
824
        """Copy the inventory texts to the new pack.
740
827
 
741
828
        Sets self._text_filter appropriately.
742
829
        """
743
 
        raise NotImplementedError(self._copy_inventory_texts)
 
830
        # select inventory keys
 
831
        inv_keys = self._revision_keys # currently the same keyspace, and note that
 
832
        # querying for keys here could introduce a bug where an inventory item
 
833
        # is missed, so do not change it to query separately without cross
 
834
        # checking like the text key check below.
 
835
        inventory_index_map, inventory_indices = self._pack_map_and_index_list(
 
836
            'inventory_index')
 
837
        inv_nodes = self._index_contents(inventory_indices, inv_keys)
 
838
        # copy inventory keys and adjust values
 
839
        # XXX: Should be a helper function to allow different inv representation
 
840
        # at this point.
 
841
        self.pb.update("Copying inventory texts", 2)
 
842
        total_items, readv_group_iter = self._least_readv_node_readv(inv_nodes)
 
843
        # Only grab the output lines if we will be processing them
 
844
        output_lines = bool(self.revision_ids)
 
845
        inv_lines = self._copy_nodes_graph(inventory_index_map,
 
846
            self.new_pack._writer, self.new_pack.inventory_index,
 
847
            readv_group_iter, total_items, output_lines=output_lines)
 
848
        if self.revision_ids:
 
849
            self._process_inventory_lines(inv_lines)
 
850
        else:
 
851
            # eat the iterator to cause it to execute.
 
852
            list(inv_lines)
 
853
            self._text_filter = None
 
854
        if 'pack' in debug.debug_flags:
 
855
            mutter('%s: create_pack: inventories copied: %s%s %d items t+%6.3fs',
 
856
                time.ctime(), self._pack_collection._upload_transport.base,
 
857
                self.new_pack.random_name,
 
858
                self.new_pack.inventory_index.key_count(),
 
859
                time.time() - self.new_pack.start_time)
744
860
 
745
861
    def _copy_text_texts(self):
746
 
        raise NotImplementedError(self._copy_text_texts)
 
862
        # select text keys
 
863
        text_index_map, text_nodes = self._get_text_nodes()
 
864
        if self._text_filter is not None:
 
865
            # We could return the keys copied as part of the return value from
 
866
            # _copy_nodes_graph but this doesn't work all that well with the
 
867
            # need to get line output too, so we check separately, and as we're
 
868
            # going to buffer everything anyway, we check beforehand, which
 
869
            # saves reading knit data over the wire when we know there are
 
870
            # mising records.
 
871
            text_nodes = set(text_nodes)
 
872
            present_text_keys = set(_node[1] for _node in text_nodes)
 
873
            missing_text_keys = set(self._text_filter) - present_text_keys
 
874
            if missing_text_keys:
 
875
                # TODO: raise a specific error that can handle many missing
 
876
                # keys.
 
877
                mutter("missing keys during fetch: %r", missing_text_keys)
 
878
                a_missing_key = missing_text_keys.pop()
 
879
                raise errors.RevisionNotPresent(a_missing_key[1],
 
880
                    a_missing_key[0])
 
881
        # copy text keys and adjust values
 
882
        self.pb.update("Copying content texts", 3)
 
883
        total_items, readv_group_iter = self._least_readv_node_readv(text_nodes)
 
884
        list(self._copy_nodes_graph(text_index_map, self.new_pack._writer,
 
885
            self.new_pack.text_index, readv_group_iter, total_items))
 
886
        self._log_copied_texts()
747
887
 
748
888
    def _create_pack_from_packs(self):
749
 
        raise NotImplementedError(self._create_pack_from_packs)
 
889
        self.pb.update("Opening pack", 0, 5)
 
890
        self.new_pack = self.open_pack()
 
891
        new_pack = self.new_pack
 
892
        # buffer data - we won't be reading-back during the pack creation and
 
893
        # this makes a significant difference on sftp pushes.
 
894
        new_pack.set_write_cache_size(1024*1024)
 
895
        if 'pack' in debug.debug_flags:
 
896
            plain_pack_list = ['%s%s' % (a_pack.pack_transport.base, a_pack.name)
 
897
                for a_pack in self.packs]
 
898
            if self.revision_ids is not None:
 
899
                rev_count = len(self.revision_ids)
 
900
            else:
 
901
                rev_count = 'all'
 
902
            mutter('%s: create_pack: creating pack from source packs: '
 
903
                '%s%s %s revisions wanted %s t=0',
 
904
                time.ctime(), self._pack_collection._upload_transport.base, new_pack.random_name,
 
905
                plain_pack_list, rev_count)
 
906
        self._copy_revision_texts()
 
907
        self._copy_inventory_texts()
 
908
        self._copy_text_texts()
 
909
        # select signature keys
 
910
        signature_filter = self._revision_keys # same keyspace
 
911
        signature_index_map, signature_indices = self._pack_map_and_index_list(
 
912
            'signature_index')
 
913
        signature_nodes = self._index_contents(signature_indices,
 
914
            signature_filter)
 
915
        # copy signature keys and adjust values
 
916
        self.pb.update("Copying signature texts", 4)
 
917
        self._copy_nodes(signature_nodes, signature_index_map, new_pack._writer,
 
918
            new_pack.signature_index)
 
919
        if 'pack' in debug.debug_flags:
 
920
            mutter('%s: create_pack: revision signatures copied: %s%s %d items t+%6.3fs',
 
921
                time.ctime(), self._pack_collection._upload_transport.base, new_pack.random_name,
 
922
                new_pack.signature_index.key_count(),
 
923
                time.time() - new_pack.start_time)
 
924
        # copy chk contents
 
925
        # NB XXX: how to check CHK references are present? perhaps by yielding
 
926
        # the items? How should that interact with stacked repos?
 
927
        if new_pack.chk_index is not None:
 
928
            self._copy_chks()
 
929
            if 'pack' in debug.debug_flags:
 
930
                mutter('%s: create_pack: chk content copied: %s%s %d items t+%6.3fs',
 
931
                    time.ctime(), self._pack_collection._upload_transport.base,
 
932
                    new_pack.random_name,
 
933
                    new_pack.chk_index.key_count(),
 
934
                    time.time() - new_pack.start_time)
 
935
        new_pack._check_references()
 
936
        if not self._use_pack(new_pack):
 
937
            new_pack.abort()
 
938
            return None
 
939
        self.pb.update("Finishing pack", 5)
 
940
        new_pack.finish()
 
941
        self._pack_collection.allocate(new_pack)
 
942
        return new_pack
 
943
 
 
944
    def _copy_chks(self, refs=None):
 
945
        # XXX: Todo, recursive follow-pointers facility when fetching some
 
946
        # revisions only.
 
947
        chk_index_map, chk_indices = self._pack_map_and_index_list(
 
948
            'chk_index')
 
949
        chk_nodes = self._index_contents(chk_indices, refs)
 
950
        new_refs = set()
 
951
        # TODO: This isn't strictly tasteful as we are accessing some private
 
952
        #       variables (_serializer). Perhaps a better way would be to have
 
953
        #       Repository._deserialise_chk_node()
 
954
        search_key_func = chk_map.search_key_registry.get(
 
955
            self._pack_collection.repo._serializer.search_key_name)
 
956
        def accumlate_refs(lines):
 
957
            # XXX: move to a generic location
 
958
            # Yay mismatch:
 
959
            bytes = ''.join(lines)
 
960
            node = chk_map._deserialise(bytes, ("unknown",), search_key_func)
 
961
            new_refs.update(node.refs())
 
962
        self._copy_nodes(chk_nodes, chk_index_map, self.new_pack._writer,
 
963
            self.new_pack.chk_index, output_lines=accumlate_refs)
 
964
        return new_refs
 
965
 
 
966
    def _copy_nodes(self, nodes, index_map, writer, write_index,
 
967
        output_lines=None):
 
968
        """Copy knit nodes between packs with no graph references.
 
969
 
 
970
        :param output_lines: Output full texts of copied items.
 
971
        """
 
972
        pb = ui.ui_factory.nested_progress_bar()
 
973
        try:
 
974
            return self._do_copy_nodes(nodes, index_map, writer,
 
975
                write_index, pb, output_lines=output_lines)
 
976
        finally:
 
977
            pb.finished()
 
978
 
 
979
    def _do_copy_nodes(self, nodes, index_map, writer, write_index, pb,
 
980
        output_lines=None):
 
981
        # for record verification
 
982
        knit = KnitVersionedFiles(None, None)
 
983
        # plan a readv on each source pack:
 
984
        # group by pack
 
985
        nodes = sorted(nodes)
 
986
        # how to map this into knit.py - or knit.py into this?
 
987
        # we don't want the typical knit logic, we want grouping by pack
 
988
        # at this point - perhaps a helper library for the following code
 
989
        # duplication points?
 
990
        request_groups = {}
 
991
        for index, key, value in nodes:
 
992
            if index not in request_groups:
 
993
                request_groups[index] = []
 
994
            request_groups[index].append((key, value))
 
995
        record_index = 0
 
996
        pb.update("Copied record", record_index, len(nodes))
 
997
        for index, items in request_groups.iteritems():
 
998
            pack_readv_requests = []
 
999
            for key, value in items:
 
1000
                # ---- KnitGraphIndex.get_position
 
1001
                bits = value[1:].split(' ')
 
1002
                offset, length = int(bits[0]), int(bits[1])
 
1003
                pack_readv_requests.append((offset, length, (key, value[0])))
 
1004
            # linear scan up the pack
 
1005
            pack_readv_requests.sort()
 
1006
            # copy the data
 
1007
            pack_obj = index_map[index]
 
1008
            transport, path = pack_obj.access_tuple()
 
1009
            try:
 
1010
                reader = pack.make_readv_reader(transport, path,
 
1011
                    [offset[0:2] for offset in pack_readv_requests])
 
1012
            except errors.NoSuchFile:
 
1013
                if self._reload_func is not None:
 
1014
                    self._reload_func()
 
1015
                raise
 
1016
            for (names, read_func), (_1, _2, (key, eol_flag)) in \
 
1017
                izip(reader.iter_records(), pack_readv_requests):
 
1018
                raw_data = read_func(None)
 
1019
                # check the header only
 
1020
                if output_lines is not None:
 
1021
                    output_lines(knit._parse_record(key[-1], raw_data)[0])
 
1022
                else:
 
1023
                    df, _ = knit._parse_record_header(key, raw_data)
 
1024
                    df.close()
 
1025
                pos, size = writer.add_bytes_record(raw_data, names)
 
1026
                write_index.add_node(key, eol_flag + "%d %d" % (pos, size))
 
1027
                pb.update("Copied record", record_index)
 
1028
                record_index += 1
 
1029
 
 
1030
    def _copy_nodes_graph(self, index_map, writer, write_index,
 
1031
        readv_group_iter, total_items, output_lines=False):
 
1032
        """Copy knit nodes between packs.
 
1033
 
 
1034
        :param output_lines: Return lines present in the copied data as
 
1035
            an iterator of line,version_id.
 
1036
        """
 
1037
        pb = ui.ui_factory.nested_progress_bar()
 
1038
        try:
 
1039
            for result in self._do_copy_nodes_graph(index_map, writer,
 
1040
                write_index, output_lines, pb, readv_group_iter, total_items):
 
1041
                yield result
 
1042
        except Exception:
 
1043
            # Python 2.4 does not permit try:finally: in a generator.
 
1044
            pb.finished()
 
1045
            raise
 
1046
        else:
 
1047
            pb.finished()
 
1048
 
 
1049
    def _do_copy_nodes_graph(self, index_map, writer, write_index,
 
1050
        output_lines, pb, readv_group_iter, total_items):
 
1051
        # for record verification
 
1052
        knit = KnitVersionedFiles(None, None)
 
1053
        # for line extraction when requested (inventories only)
 
1054
        if output_lines:
 
1055
            factory = KnitPlainFactory()
 
1056
        record_index = 0
 
1057
        pb.update("Copied record", record_index, total_items)
 
1058
        for index, readv_vector, node_vector in readv_group_iter:
 
1059
            # copy the data
 
1060
            pack_obj = index_map[index]
 
1061
            transport, path = pack_obj.access_tuple()
 
1062
            try:
 
1063
                reader = pack.make_readv_reader(transport, path, readv_vector)
 
1064
            except errors.NoSuchFile:
 
1065
                if self._reload_func is not None:
 
1066
                    self._reload_func()
 
1067
                raise
 
1068
            for (names, read_func), (key, eol_flag, references) in \
 
1069
                izip(reader.iter_records(), node_vector):
 
1070
                raw_data = read_func(None)
 
1071
                if output_lines:
 
1072
                    # read the entire thing
 
1073
                    content, _ = knit._parse_record(key[-1], raw_data)
 
1074
                    if len(references[-1]) == 0:
 
1075
                        line_iterator = factory.get_fulltext_content(content)
 
1076
                    else:
 
1077
                        line_iterator = factory.get_linedelta_content(content)
 
1078
                    for line in line_iterator:
 
1079
                        yield line, key
 
1080
                else:
 
1081
                    # check the header only
 
1082
                    df, _ = knit._parse_record_header(key, raw_data)
 
1083
                    df.close()
 
1084
                pos, size = writer.add_bytes_record(raw_data, names)
 
1085
                write_index.add_node(key, eol_flag + "%d %d" % (pos, size), references)
 
1086
                pb.update("Copied record", record_index)
 
1087
                record_index += 1
 
1088
 
 
1089
    def _get_text_nodes(self):
 
1090
        text_index_map, text_indices = self._pack_map_and_index_list(
 
1091
            'text_index')
 
1092
        return text_index_map, self._index_contents(text_indices,
 
1093
            self._text_filter)
 
1094
 
 
1095
    def _least_readv_node_readv(self, nodes):
 
1096
        """Generate request groups for nodes using the least readv's.
 
1097
 
 
1098
        :param nodes: An iterable of graph index nodes.
 
1099
        :return: Total node count and an iterator of the data needed to perform
 
1100
            readvs to obtain the data for nodes. Each item yielded by the
 
1101
            iterator is a tuple with:
 
1102
            index, readv_vector, node_vector. readv_vector is a list ready to
 
1103
            hand to the transport readv method, and node_vector is a list of
 
1104
            (key, eol_flag, references) for the node retrieved by the
 
1105
            matching readv_vector.
 
1106
        """
 
1107
        # group by pack so we do one readv per pack
 
1108
        nodes = sorted(nodes)
 
1109
        total = len(nodes)
 
1110
        request_groups = {}
 
1111
        for index, key, value, references in nodes:
 
1112
            if index not in request_groups:
 
1113
                request_groups[index] = []
 
1114
            request_groups[index].append((key, value, references))
 
1115
        result = []
 
1116
        for index, items in request_groups.iteritems():
 
1117
            pack_readv_requests = []
 
1118
            for key, value, references in items:
 
1119
                # ---- KnitGraphIndex.get_position
 
1120
                bits = value[1:].split(' ')
 
1121
                offset, length = int(bits[0]), int(bits[1])
 
1122
                pack_readv_requests.append(
 
1123
                    ((offset, length), (key, value[0], references)))
 
1124
            # linear scan up the pack to maximum range combining.
 
1125
            pack_readv_requests.sort()
 
1126
            # split out the readv and the node data.
 
1127
            pack_readv = [readv for readv, node in pack_readv_requests]
 
1128
            node_vector = [node for readv, node in pack_readv_requests]
 
1129
            result.append((index, pack_readv, node_vector))
 
1130
        return total, result
750
1131
 
751
1132
    def _log_copied_texts(self):
752
1133
        if 'pack' in debug.debug_flags:
756
1137
                self.new_pack.text_index.key_count(),
757
1138
                time.time() - self.new_pack.start_time)
758
1139
 
 
1140
    def _process_inventory_lines(self, inv_lines):
 
1141
        """Use up the inv_lines generator and setup a text key filter."""
 
1142
        repo = self._pack_collection.repo
 
1143
        fileid_revisions = repo._find_file_ids_from_xml_inventory_lines(
 
1144
            inv_lines, self.revision_keys)
 
1145
        text_filter = []
 
1146
        for fileid, file_revids in fileid_revisions.iteritems():
 
1147
            text_filter.extend([(fileid, file_revid) for file_revid in file_revids])
 
1148
        self._text_filter = text_filter
 
1149
 
 
1150
    def _revision_node_readv(self, revision_nodes):
 
1151
        """Return the total revisions and the readv's to issue.
 
1152
 
 
1153
        :param revision_nodes: The revision index contents for the packs being
 
1154
            incorporated into the new pack.
 
1155
        :return: As per _least_readv_node_readv.
 
1156
        """
 
1157
        return self._least_readv_node_readv(revision_nodes)
 
1158
 
759
1159
    def _use_pack(self, new_pack):
760
1160
        """Return True if new_pack should be used.
761
1161
 
765
1165
        return new_pack.data_inserted()
766
1166
 
767
1167
 
 
1168
class OptimisingPacker(Packer):
 
1169
    """A packer which spends more time to create better disk layouts."""
 
1170
 
 
1171
    def _revision_node_readv(self, revision_nodes):
 
1172
        """Return the total revisions and the readv's to issue.
 
1173
 
 
1174
        This sort places revisions in topological order with the ancestors
 
1175
        after the children.
 
1176
 
 
1177
        :param revision_nodes: The revision index contents for the packs being
 
1178
            incorporated into the new pack.
 
1179
        :return: As per _least_readv_node_readv.
 
1180
        """
 
1181
        # build an ancestors dict
 
1182
        ancestors = {}
 
1183
        by_key = {}
 
1184
        for index, key, value, references in revision_nodes:
 
1185
            ancestors[key] = references[0]
 
1186
            by_key[key] = (index, value, references)
 
1187
        order = tsort.topo_sort(ancestors)
 
1188
        total = len(order)
 
1189
        # Single IO is pathological, but it will work as a starting point.
 
1190
        requests = []
 
1191
        for key in reversed(order):
 
1192
            index, value, references = by_key[key]
 
1193
            # ---- KnitGraphIndex.get_position
 
1194
            bits = value[1:].split(' ')
 
1195
            offset, length = int(bits[0]), int(bits[1])
 
1196
            requests.append(
 
1197
                (index, [(offset, length)], [(key, value[0], references)]))
 
1198
        # TODO: combine requests in the same index that are in ascending order.
 
1199
        return total, requests
 
1200
 
 
1201
    def open_pack(self):
 
1202
        """Open a pack for the pack we are creating."""
 
1203
        new_pack = super(OptimisingPacker, self).open_pack()
 
1204
        # Turn on the optimization flags for all the index builders.
 
1205
        new_pack.revision_index.set_optimize(for_size=True)
 
1206
        new_pack.inventory_index.set_optimize(for_size=True)
 
1207
        new_pack.text_index.set_optimize(for_size=True)
 
1208
        new_pack.signature_index.set_optimize(for_size=True)
 
1209
        return new_pack
 
1210
 
 
1211
 
 
1212
class ReconcilePacker(Packer):
 
1213
    """A packer which regenerates indices etc as it copies.
 
1214
 
 
1215
    This is used by ``bzr reconcile`` to cause parent text pointers to be
 
1216
    regenerated.
 
1217
    """
 
1218
 
 
1219
    def _extra_init(self):
 
1220
        self._data_changed = False
 
1221
 
 
1222
    def _process_inventory_lines(self, inv_lines):
 
1223
        """Generate a text key reference map rather for reconciling with."""
 
1224
        repo = self._pack_collection.repo
 
1225
        refs = repo._serializer._find_text_key_references(inv_lines)
 
1226
        self._text_refs = refs
 
1227
        # during reconcile we:
 
1228
        #  - convert unreferenced texts to full texts
 
1229
        #  - correct texts which reference a text not copied to be full texts
 
1230
        #  - copy all others as-is but with corrected parents.
 
1231
        #  - so at this point we don't know enough to decide what becomes a full
 
1232
        #    text.
 
1233
        self._text_filter = None
 
1234
 
 
1235
    def _copy_text_texts(self):
 
1236
        """generate what texts we should have and then copy."""
 
1237
        self.pb.update("Copying content texts", 3)
 
1238
        # we have three major tasks here:
 
1239
        # 1) generate the ideal index
 
1240
        repo = self._pack_collection.repo
 
1241
        ancestors = dict([(key[0], tuple(ref[0] for ref in refs[0])) for
 
1242
            _1, key, _2, refs in
 
1243
            self.new_pack.revision_index.iter_all_entries()])
 
1244
        ideal_index = repo._generate_text_key_index(self._text_refs, ancestors)
 
1245
        # 2) generate a text_nodes list that contains all the deltas that can
 
1246
        #    be used as-is, with corrected parents.
 
1247
        ok_nodes = []
 
1248
        bad_texts = []
 
1249
        discarded_nodes = []
 
1250
        NULL_REVISION = _mod_revision.NULL_REVISION
 
1251
        text_index_map, text_nodes = self._get_text_nodes()
 
1252
        for node in text_nodes:
 
1253
            # 0 - index
 
1254
            # 1 - key
 
1255
            # 2 - value
 
1256
            # 3 - refs
 
1257
            try:
 
1258
                ideal_parents = tuple(ideal_index[node[1]])
 
1259
            except KeyError:
 
1260
                discarded_nodes.append(node)
 
1261
                self._data_changed = True
 
1262
            else:
 
1263
                if ideal_parents == (NULL_REVISION,):
 
1264
                    ideal_parents = ()
 
1265
                if ideal_parents == node[3][0]:
 
1266
                    # no change needed.
 
1267
                    ok_nodes.append(node)
 
1268
                elif ideal_parents[0:1] == node[3][0][0:1]:
 
1269
                    # the left most parent is the same, or there are no parents
 
1270
                    # today. Either way, we can preserve the representation as
 
1271
                    # long as we change the refs to be inserted.
 
1272
                    self._data_changed = True
 
1273
                    ok_nodes.append((node[0], node[1], node[2],
 
1274
                        (ideal_parents, node[3][1])))
 
1275
                    self._data_changed = True
 
1276
                else:
 
1277
                    # Reinsert this text completely
 
1278
                    bad_texts.append((node[1], ideal_parents))
 
1279
                    self._data_changed = True
 
1280
        # we're finished with some data.
 
1281
        del ideal_index
 
1282
        del text_nodes
 
1283
        # 3) bulk copy the ok data
 
1284
        total_items, readv_group_iter = self._least_readv_node_readv(ok_nodes)
 
1285
        list(self._copy_nodes_graph(text_index_map, self.new_pack._writer,
 
1286
            self.new_pack.text_index, readv_group_iter, total_items))
 
1287
        # 4) adhoc copy all the other texts.
 
1288
        # We have to topologically insert all texts otherwise we can fail to
 
1289
        # reconcile when parts of a single delta chain are preserved intact,
 
1290
        # and other parts are not. E.g. Discarded->d1->d2->d3. d1 will be
 
1291
        # reinserted, and if d3 has incorrect parents it will also be
 
1292
        # reinserted. If we insert d3 first, d2 is present (as it was bulk
 
1293
        # copied), so we will try to delta, but d2 is not currently able to be
 
1294
        # extracted because its basis d1 is not present. Topologically sorting
 
1295
        # addresses this. The following generates a sort for all the texts that
 
1296
        # are being inserted without having to reference the entire text key
 
1297
        # space (we only topo sort the revisions, which is smaller).
 
1298
        topo_order = tsort.topo_sort(ancestors)
 
1299
        rev_order = dict(zip(topo_order, range(len(topo_order))))
 
1300
        bad_texts.sort(key=lambda key:rev_order.get(key[0][1], 0))
 
1301
        transaction = repo.get_transaction()
 
1302
        file_id_index = GraphIndexPrefixAdapter(
 
1303
            self.new_pack.text_index,
 
1304
            ('blank', ), 1,
 
1305
            add_nodes_callback=self.new_pack.text_index.add_nodes)
 
1306
        data_access = _DirectPackAccess(
 
1307
                {self.new_pack.text_index:self.new_pack.access_tuple()})
 
1308
        data_access.set_writer(self.new_pack._writer, self.new_pack.text_index,
 
1309
            self.new_pack.access_tuple())
 
1310
        output_texts = KnitVersionedFiles(
 
1311
            _KnitGraphIndex(self.new_pack.text_index,
 
1312
                add_callback=self.new_pack.text_index.add_nodes,
 
1313
                deltas=True, parents=True, is_locked=repo.is_locked),
 
1314
            data_access=data_access, max_delta_chain=200)
 
1315
        for key, parent_keys in bad_texts:
 
1316
            # We refer to the new pack to delta data being output.
 
1317
            # A possible improvement would be to catch errors on short reads
 
1318
            # and only flush then.
 
1319
            self.new_pack.flush()
 
1320
            parents = []
 
1321
            for parent_key in parent_keys:
 
1322
                if parent_key[0] != key[0]:
 
1323
                    # Graph parents must match the fileid
 
1324
                    raise errors.BzrError('Mismatched key parent %r:%r' %
 
1325
                        (key, parent_keys))
 
1326
                parents.append(parent_key[1])
 
1327
            text_lines = osutils.split_lines(repo.texts.get_record_stream(
 
1328
                [key], 'unordered', True).next().get_bytes_as('fulltext'))
 
1329
            output_texts.add_lines(key, parent_keys, text_lines,
 
1330
                random_id=True, check_content=False)
 
1331
        # 5) check that nothing inserted has a reference outside the keyspace.
 
1332
        missing_text_keys = self.new_pack.text_index._external_references()
 
1333
        if missing_text_keys:
 
1334
            raise errors.BzrCheckError('Reference to missing compression parents %r'
 
1335
                % (missing_text_keys,))
 
1336
        self._log_copied_texts()
 
1337
 
 
1338
    def _use_pack(self, new_pack):
 
1339
        """Override _use_pack to check for reconcile having changed content."""
 
1340
        # XXX: we might be better checking this at the copy time.
 
1341
        original_inventory_keys = set()
 
1342
        inv_index = self._pack_collection.inventory_index.combined_index
 
1343
        for entry in inv_index.iter_all_entries():
 
1344
            original_inventory_keys.add(entry[1])
 
1345
        new_inventory_keys = set()
 
1346
        for entry in new_pack.inventory_index.iter_all_entries():
 
1347
            new_inventory_keys.add(entry[1])
 
1348
        if new_inventory_keys != original_inventory_keys:
 
1349
            self._data_changed = True
 
1350
        return new_pack.data_inserted() and self._data_changed
 
1351
 
 
1352
 
768
1353
class RepositoryPackCollection(object):
769
1354
    """Management of packs within a repository.
770
1355
 
771
1356
    :ivar _names: map of {pack_name: (index_size,)}
772
1357
    """
773
1358
 
774
 
    pack_factory = None
775
 
    resumed_pack_factory = None
776
 
    normal_packer_class = None
777
 
    optimising_packer_class = None
 
1359
    pack_factory = NewPack
 
1360
    resumed_pack_factory = ResumedPack
778
1361
 
779
1362
    def __init__(self, repo, transport, index_transport, upload_transport,
780
1363
                 pack_transport, index_builder_class, index_class,
831
1414
                set(all_combined).difference([combined_idx]))
832
1415
        # resumed packs
833
1416
        self._resumed_packs = []
834
 
        self.config_stack = config.LocationStack(self.transport.base)
835
1417
 
836
1418
    def __repr__(self):
837
1419
        return '%s(%r)' % (self.__class__.__name__, self.repo)
922
1504
            'containing %d revisions. Packing %d files into %d affecting %d'
923
1505
            ' revisions', self, total_packs, total_revisions, num_old_packs,
924
1506
            num_new_packs, num_revs_affected)
925
 
        result = self._execute_pack_operations(pack_operations, packer_class=self.normal_packer_class,
 
1507
        result = self._execute_pack_operations(pack_operations,
926
1508
                                      reload_func=self._restart_autopack)
927
1509
        mutter('Auto-packing repository %s completed', self)
928
1510
        return result
929
1511
 
930
 
    def _execute_pack_operations(self, pack_operations, packer_class,
931
 
            reload_func=None):
 
1512
    def _execute_pack_operations(self, pack_operations, _packer_class=Packer,
 
1513
                                 reload_func=None):
932
1514
        """Execute a series of pack operations.
933
1515
 
934
1516
        :param pack_operations: A list of [revision_count, packs_to_combine].
935
 
        :param packer_class: The class of packer to use
 
1517
        :param _packer_class: The class of packer to use (default: Packer).
936
1518
        :return: The new pack names.
937
1519
        """
938
1520
        for revision_count, packs in pack_operations:
939
1521
            # we may have no-ops from the setup logic
940
1522
            if len(packs) == 0:
941
1523
                continue
942
 
            packer = packer_class(self, packs, '.autopack',
 
1524
            packer = _packer_class(self, packs, '.autopack',
943
1525
                                   reload_func=reload_func)
944
1526
            try:
945
 
                result = packer.pack()
 
1527
                packer.pack()
946
1528
            except errors.RetryWithNewPacks:
947
1529
                # An exception is propagating out of this context, make sure
948
1530
                # this packer has cleaned up. Packer() doesn't set its new_pack
951
1533
                if packer.new_pack is not None:
952
1534
                    packer.new_pack.abort()
953
1535
                raise
954
 
            if result is None:
955
 
                return
956
1536
            for pack in packs:
957
1537
                self._remove_pack_from_memory(pack)
958
1538
        # record the newly available packs and stop advertising the old
1014
1594
                # or this pack was included in the hint.
1015
1595
                pack_operations[-1][0] += pack.get_revision_count()
1016
1596
                pack_operations[-1][1].append(pack)
1017
 
        self._execute_pack_operations(pack_operations,
1018
 
            packer_class=self.optimising_packer_class,
 
1597
        self._execute_pack_operations(pack_operations, OptimisingPacker,
1019
1598
            reload_func=self._restart_pack_operations)
1020
1599
 
1021
1600
    def plan_autopack_combinations(self, existing_packs, pack_distribution):
1221
1800
        """
1222
1801
        for pack in packs:
1223
1802
            try:
1224
 
                pack.pack_transport.move(pack.file_name(),
 
1803
                pack.pack_transport.rename(pack.file_name(),
1225
1804
                    '../obsolete_packs/' + pack.file_name())
1226
1805
            except (errors.PathError, errors.TransportError), e:
1227
1806
                # TODO: Should these be warnings or mutters?
1235
1814
                suffixes.append('.cix')
1236
1815
            for suffix in suffixes:
1237
1816
                try:
1238
 
                    self._index_transport.move(pack.name + suffix,
 
1817
                    self._index_transport.rename(pack.name + suffix,
1239
1818
                        '../obsolete_packs/' + pack.name + suffix)
1240
1819
                except (errors.PathError, errors.TransportError), e:
1241
1820
                    mutter("couldn't rename obsolete index, skipping it:\n%s"
1637
2216
            self._resume_pack(token)
1638
2217
 
1639
2218
 
1640
 
class PackRepository(MetaDirVersionedFileRepository):
 
2219
class KnitPackRepository(KnitRepository):
1641
2220
    """Repository with knit objects stored inside pack containers.
1642
2221
 
1643
2222
    The layering for a KnitPackRepository is:
1646
2225
    ===================================================
1647
2226
    Tuple based apis below, string based, and key based apis above
1648
2227
    ---------------------------------------------------
1649
 
    VersionedFiles
 
2228
    KnitVersionedFiles
1650
2229
      Provides .texts, .revisions etc
1651
2230
      This adapts the N-tuple keys to physical knit records which only have a
1652
2231
      single string identifier (for historical reasons), which in older formats
1662
2241
 
1663
2242
    """
1664
2243
 
1665
 
    # These attributes are inherited from the Repository base class. Setting
1666
 
    # them to None ensures that if the constructor is changed to not initialize
1667
 
    # them, or a subclass fails to call the constructor, that an error will
1668
 
    # occur rather than the system working but generating incorrect data.
1669
 
    _commit_builder_class = None
1670
 
    _serializer = None
1671
 
 
1672
2244
    def __init__(self, _format, a_bzrdir, control_files, _commit_builder_class,
1673
2245
        _serializer):
1674
 
        MetaDirRepository.__init__(self, _format, a_bzrdir, control_files)
1675
 
        self._commit_builder_class = _commit_builder_class
1676
 
        self._serializer = _serializer
 
2246
        KnitRepository.__init__(self, _format, a_bzrdir, control_files,
 
2247
            _commit_builder_class, _serializer)
 
2248
        index_transport = self._transport.clone('indices')
 
2249
        self._pack_collection = RepositoryPackCollection(self, self._transport,
 
2250
            index_transport,
 
2251
            self._transport.clone('upload'),
 
2252
            self._transport.clone('packs'),
 
2253
            _format.index_builder_class,
 
2254
            _format.index_class,
 
2255
            use_chk_index=self._format.supports_chks,
 
2256
            )
 
2257
        self.inventories = KnitVersionedFiles(
 
2258
            _KnitGraphIndex(self._pack_collection.inventory_index.combined_index,
 
2259
                add_callback=self._pack_collection.inventory_index.add_callback,
 
2260
                deltas=True, parents=True, is_locked=self.is_locked),
 
2261
            data_access=self._pack_collection.inventory_index.data_access,
 
2262
            max_delta_chain=200)
 
2263
        self.revisions = KnitVersionedFiles(
 
2264
            _KnitGraphIndex(self._pack_collection.revision_index.combined_index,
 
2265
                add_callback=self._pack_collection.revision_index.add_callback,
 
2266
                deltas=False, parents=True, is_locked=self.is_locked,
 
2267
                track_external_parent_refs=True),
 
2268
            data_access=self._pack_collection.revision_index.data_access,
 
2269
            max_delta_chain=0)
 
2270
        self.signatures = KnitVersionedFiles(
 
2271
            _KnitGraphIndex(self._pack_collection.signature_index.combined_index,
 
2272
                add_callback=self._pack_collection.signature_index.add_callback,
 
2273
                deltas=False, parents=False, is_locked=self.is_locked),
 
2274
            data_access=self._pack_collection.signature_index.data_access,
 
2275
            max_delta_chain=0)
 
2276
        self.texts = KnitVersionedFiles(
 
2277
            _KnitGraphIndex(self._pack_collection.text_index.combined_index,
 
2278
                add_callback=self._pack_collection.text_index.add_callback,
 
2279
                deltas=True, parents=True, is_locked=self.is_locked),
 
2280
            data_access=self._pack_collection.text_index.data_access,
 
2281
            max_delta_chain=200)
 
2282
        if _format.supports_chks:
 
2283
            # No graph, no compression:- references from chks are between
 
2284
            # different objects not temporal versions of the same; and without
 
2285
            # some sort of temporal structure knit compression will just fail.
 
2286
            self.chk_bytes = KnitVersionedFiles(
 
2287
                _KnitGraphIndex(self._pack_collection.chk_index.combined_index,
 
2288
                    add_callback=self._pack_collection.chk_index.add_callback,
 
2289
                    deltas=False, parents=False, is_locked=self.is_locked),
 
2290
                data_access=self._pack_collection.chk_index.data_access,
 
2291
                max_delta_chain=0)
 
2292
        else:
 
2293
            self.chk_bytes = None
 
2294
        # True when the repository object is 'write locked' (as opposed to the
 
2295
        # physical lock only taken out around changes to the pack-names list.)
 
2296
        # Another way to represent this would be a decorator around the control
 
2297
        # files object that presents logical locks as physical ones - if this
 
2298
        # gets ugly consider that alternative design. RBC 20071011
 
2299
        self._write_lock_count = 0
 
2300
        self._transaction = None
 
2301
        # for tests
 
2302
        self._reconcile_does_inventory_gc = True
1677
2303
        self._reconcile_fixes_text_parents = True
1678
 
        if self._format.supports_external_lookups:
1679
 
            self._unstacked_provider = graph.CachingParentsProvider(
1680
 
                self._make_parents_provider_unstacked())
1681
 
        else:
1682
 
            self._unstacked_provider = graph.CachingParentsProvider(self)
1683
 
        self._unstacked_provider.disable_cache()
 
2304
        self._reconcile_backsup_inventory = False
1684
2305
 
1685
 
    @needs_read_lock
1686
 
    def _all_revision_ids(self):
1687
 
        """See Repository.all_revision_ids()."""
1688
 
        return [key[0] for key in self.revisions.keys()]
 
2306
    def _warn_if_deprecated(self, branch=None):
 
2307
        # This class isn't deprecated, but one sub-format is
 
2308
        if isinstance(self._format, RepositoryFormatKnitPack5RichRootBroken):
 
2309
            super(KnitPackRepository, self)._warn_if_deprecated(branch)
1689
2310
 
1690
2311
    def _abort_write_group(self):
1691
2312
        self.revisions._index._key_dependencies.clear()
1692
2313
        self._pack_collection._abort_write_group()
1693
2314
 
 
2315
    def _get_source(self, to_format):
 
2316
        if to_format.network_name() == self._format.network_name():
 
2317
            return KnitPackStreamSource(self, to_format)
 
2318
        return super(KnitPackRepository, self)._get_source(to_format)
 
2319
 
1694
2320
    def _make_parents_provider(self):
1695
 
        if not self._format.supports_external_lookups:
1696
 
            return self._unstacked_provider
1697
 
        return graph.StackedParentsProvider(_LazyListJoin(
1698
 
            [self._unstacked_provider], self._fallback_repositories))
 
2321
        return graph.CachingParentsProvider(self)
1699
2322
 
1700
2323
    def _refresh_data(self):
1701
2324
        if not self.is_locked():
1702
2325
            return
1703
2326
        self._pack_collection.reload_pack_names()
1704
 
        self._unstacked_provider.disable_cache()
1705
 
        self._unstacked_provider.enable_cache()
1706
2327
 
1707
2328
    def _start_write_group(self):
1708
2329
        self._pack_collection._start_write_group()
1710
2331
    def _commit_write_group(self):
1711
2332
        hint = self._pack_collection._commit_write_group()
1712
2333
        self.revisions._index._key_dependencies.clear()
1713
 
        # The commit may have added keys that were previously cached as
1714
 
        # missing, so reset the cache.
1715
 
        self._unstacked_provider.disable_cache()
1716
 
        self._unstacked_provider.enable_cache()
1717
2334
        return hint
1718
2335
 
1719
2336
    def suspend_write_group(self):
1760
2377
            if 'relock' in debug.debug_flags and self._prev_lock == 'w':
1761
2378
                note('%r was write locked again', self)
1762
2379
            self._prev_lock = 'w'
1763
 
            self._unstacked_provider.enable_cache()
1764
2380
            for repo in self._fallback_repositories:
1765
2381
                # Writes don't affect fallback repos
1766
2382
                repo.lock_read()
1781
2397
            if 'relock' in debug.debug_flags and self._prev_lock == 'r':
1782
2398
                note('%r was read locked again', self)
1783
2399
            self._prev_lock = 'r'
1784
 
            self._unstacked_provider.enable_cache()
1785
2400
            for repo in self._fallback_repositories:
1786
2401
                repo.lock_read()
1787
2402
            self._refresh_data()
1813
2428
        return reconciler
1814
2429
 
1815
2430
    def _reconcile_pack(self, collection, packs, extension, revs, pb):
1816
 
        raise NotImplementedError(self._reconcile_pack)
 
2431
        packer = ReconcilePacker(collection, packs, extension, revs)
 
2432
        return packer.pack(pb)
1817
2433
 
1818
2434
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1819
2435
    def unlock(self):
1820
2436
        if self._write_lock_count == 1 and self._write_group is not None:
1821
2437
            self.abort_write_group()
1822
 
            self._unstacked_provider.disable_cache()
1823
2438
            self._transaction = None
1824
2439
            self._write_lock_count = 0
1825
2440
            raise errors.BzrError(
1835
2450
            self.control_files.unlock()
1836
2451
 
1837
2452
        if not self.is_locked():
1838
 
            self._unstacked_provider.disable_cache()
1839
2453
            for repo in self._fallback_repositories:
1840
2454
                repo.unlock()
1841
2455
 
1842
2456
 
1843
 
class RepositoryFormatPack(MetaDirVersionedFileRepositoryFormat):
 
2457
class KnitPackStreamSource(StreamSource):
 
2458
    """A StreamSource used to transfer data between same-format KnitPack repos.
 
2459
 
 
2460
    This source assumes:
 
2461
        1) Same serialization format for all objects
 
2462
        2) Same root information
 
2463
        3) XML format inventories
 
2464
        4) Atomic inserts (so we can stream inventory texts before text
 
2465
           content)
 
2466
        5) No chk_bytes
 
2467
    """
 
2468
 
 
2469
    def __init__(self, from_repository, to_format):
 
2470
        super(KnitPackStreamSource, self).__init__(from_repository, to_format)
 
2471
        self._text_keys = None
 
2472
        self._text_fetch_order = 'unordered'
 
2473
 
 
2474
    def _get_filtered_inv_stream(self, revision_ids):
 
2475
        from_repo = self.from_repository
 
2476
        parent_ids = from_repo._find_parent_ids_of_revisions(revision_ids)
 
2477
        parent_keys = [(p,) for p in parent_ids]
 
2478
        find_text_keys = from_repo._serializer._find_text_key_references
 
2479
        parent_text_keys = set(find_text_keys(
 
2480
            from_repo._inventory_xml_lines_for_keys(parent_keys)))
 
2481
        content_text_keys = set()
 
2482
        knit = KnitVersionedFiles(None, None)
 
2483
        factory = KnitPlainFactory()
 
2484
        def find_text_keys_from_content(record):
 
2485
            if record.storage_kind not in ('knit-delta-gz', 'knit-ft-gz'):
 
2486
                raise ValueError("Unknown content storage kind for"
 
2487
                    " inventory text: %s" % (record.storage_kind,))
 
2488
            # It's a knit record, it has a _raw_record field (even if it was
 
2489
            # reconstituted from a network stream).
 
2490
            raw_data = record._raw_record
 
2491
            # read the entire thing
 
2492
            revision_id = record.key[-1]
 
2493
            content, _ = knit._parse_record(revision_id, raw_data)
 
2494
            if record.storage_kind == 'knit-delta-gz':
 
2495
                line_iterator = factory.get_linedelta_content(content)
 
2496
            elif record.storage_kind == 'knit-ft-gz':
 
2497
                line_iterator = factory.get_fulltext_content(content)
 
2498
            content_text_keys.update(find_text_keys(
 
2499
                [(line, revision_id) for line in line_iterator]))
 
2500
        revision_keys = [(r,) for r in revision_ids]
 
2501
        def _filtered_inv_stream():
 
2502
            source_vf = from_repo.inventories
 
2503
            stream = source_vf.get_record_stream(revision_keys,
 
2504
                                                 'unordered', False)
 
2505
            for record in stream:
 
2506
                if record.storage_kind == 'absent':
 
2507
                    raise errors.NoSuchRevision(from_repo, record.key)
 
2508
                find_text_keys_from_content(record)
 
2509
                yield record
 
2510
            self._text_keys = content_text_keys - parent_text_keys
 
2511
        return ('inventories', _filtered_inv_stream())
 
2512
 
 
2513
    def _get_text_stream(self):
 
2514
        # Note: We know we don't have to handle adding root keys, because both
 
2515
        # the source and target are the identical network name.
 
2516
        text_stream = self.from_repository.texts.get_record_stream(
 
2517
                        self._text_keys, self._text_fetch_order, False)
 
2518
        return ('texts', text_stream)
 
2519
 
 
2520
    def get_stream(self, search):
 
2521
        revision_ids = search.get_keys()
 
2522
        for stream_info in self._fetch_revision_texts(revision_ids):
 
2523
            yield stream_info
 
2524
        self._revision_keys = [(rev_id,) for rev_id in revision_ids]
 
2525
        yield self._get_filtered_inv_stream(revision_ids)
 
2526
        yield self._get_text_stream()
 
2527
 
 
2528
 
 
2529
 
 
2530
class RepositoryFormatPack(MetaDirRepositoryFormat):
1844
2531
    """Format logic for pack structured repositories.
1845
2532
 
1846
2533
    This repository format has:
1876
2563
    index_class = None
1877
2564
    _fetch_uses_deltas = True
1878
2565
    fast_deltas = False
1879
 
    supports_funky_characters = True
1880
 
    revision_graph_can_have_wrong_parents = True
1881
2566
 
1882
2567
    def initialize(self, a_bzrdir, shared=False):
1883
2568
        """Create a pack based repository.
1920
2605
                              _serializer=self._serializer)
1921
2606
 
1922
2607
 
 
2608
class RepositoryFormatKnitPack1(RepositoryFormatPack):
 
2609
    """A no-subtrees parameterized Pack repository.
 
2610
 
 
2611
    This format was introduced in 0.92.
 
2612
    """
 
2613
 
 
2614
    repository_class = KnitPackRepository
 
2615
    _commit_builder_class = PackCommitBuilder
 
2616
    @property
 
2617
    def _serializer(self):
 
2618
        return xml5.serializer_v5
 
2619
    # What index classes to use
 
2620
    index_builder_class = InMemoryGraphIndex
 
2621
    index_class = GraphIndex
 
2622
 
 
2623
    def _get_matching_bzrdir(self):
 
2624
        return bzrdir.format_registry.make_bzrdir('pack-0.92')
 
2625
 
 
2626
    def _ignore_setting_bzrdir(self, format):
 
2627
        pass
 
2628
 
 
2629
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
 
2630
 
 
2631
    def get_format_string(self):
 
2632
        """See RepositoryFormat.get_format_string()."""
 
2633
        return "Bazaar pack repository format 1 (needs bzr 0.92)\n"
 
2634
 
 
2635
    def get_format_description(self):
 
2636
        """See RepositoryFormat.get_format_description()."""
 
2637
        return "Packs containing knits without subtree support"
 
2638
 
 
2639
 
 
2640
class RepositoryFormatKnitPack3(RepositoryFormatPack):
 
2641
    """A subtrees parameterized Pack repository.
 
2642
 
 
2643
    This repository format uses the xml7 serializer to get:
 
2644
     - support for recording full info about the tree root
 
2645
     - support for recording tree-references
 
2646
 
 
2647
    This format was introduced in 0.92.
 
2648
    """
 
2649
 
 
2650
    repository_class = KnitPackRepository
 
2651
    _commit_builder_class = PackRootCommitBuilder
 
2652
    rich_root_data = True
 
2653
    experimental = True
 
2654
    supports_tree_reference = True
 
2655
    @property
 
2656
    def _serializer(self):
 
2657
        return xml7.serializer_v7
 
2658
    # What index classes to use
 
2659
    index_builder_class = InMemoryGraphIndex
 
2660
    index_class = GraphIndex
 
2661
 
 
2662
    def _get_matching_bzrdir(self):
 
2663
        return bzrdir.format_registry.make_bzrdir(
 
2664
            'pack-0.92-subtree')
 
2665
 
 
2666
    def _ignore_setting_bzrdir(self, format):
 
2667
        pass
 
2668
 
 
2669
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
 
2670
 
 
2671
    def get_format_string(self):
 
2672
        """See RepositoryFormat.get_format_string()."""
 
2673
        return "Bazaar pack repository format 1 with subtree support (needs bzr 0.92)\n"
 
2674
 
 
2675
    def get_format_description(self):
 
2676
        """See RepositoryFormat.get_format_description()."""
 
2677
        return "Packs containing knits with subtree support\n"
 
2678
 
 
2679
 
 
2680
class RepositoryFormatKnitPack4(RepositoryFormatPack):
 
2681
    """A rich-root, no subtrees parameterized Pack repository.
 
2682
 
 
2683
    This repository format uses the xml6 serializer to get:
 
2684
     - support for recording full info about the tree root
 
2685
 
 
2686
    This format was introduced in 1.0.
 
2687
    """
 
2688
 
 
2689
    repository_class = KnitPackRepository
 
2690
    _commit_builder_class = PackRootCommitBuilder
 
2691
    rich_root_data = True
 
2692
    supports_tree_reference = False
 
2693
    @property
 
2694
    def _serializer(self):
 
2695
        return xml6.serializer_v6
 
2696
    # What index classes to use
 
2697
    index_builder_class = InMemoryGraphIndex
 
2698
    index_class = GraphIndex
 
2699
 
 
2700
    def _get_matching_bzrdir(self):
 
2701
        return bzrdir.format_registry.make_bzrdir(
 
2702
            'rich-root-pack')
 
2703
 
 
2704
    def _ignore_setting_bzrdir(self, format):
 
2705
        pass
 
2706
 
 
2707
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
 
2708
 
 
2709
    def get_format_string(self):
 
2710
        """See RepositoryFormat.get_format_string()."""
 
2711
        return ("Bazaar pack repository format 1 with rich root"
 
2712
                " (needs bzr 1.0)\n")
 
2713
 
 
2714
    def get_format_description(self):
 
2715
        """See RepositoryFormat.get_format_description()."""
 
2716
        return "Packs containing knits with rich root support\n"
 
2717
 
 
2718
 
 
2719
class RepositoryFormatKnitPack5(RepositoryFormatPack):
 
2720
    """Repository that supports external references to allow stacking.
 
2721
 
 
2722
    New in release 1.6.
 
2723
 
 
2724
    Supports external lookups, which results in non-truncated ghosts after
 
2725
    reconcile compared to pack-0.92 formats.
 
2726
    """
 
2727
 
 
2728
    repository_class = KnitPackRepository
 
2729
    _commit_builder_class = PackCommitBuilder
 
2730
    supports_external_lookups = True
 
2731
    # What index classes to use
 
2732
    index_builder_class = InMemoryGraphIndex
 
2733
    index_class = GraphIndex
 
2734
 
 
2735
    @property
 
2736
    def _serializer(self):
 
2737
        return xml5.serializer_v5
 
2738
 
 
2739
    def _get_matching_bzrdir(self):
 
2740
        return bzrdir.format_registry.make_bzrdir('1.6')
 
2741
 
 
2742
    def _ignore_setting_bzrdir(self, format):
 
2743
        pass
 
2744
 
 
2745
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
 
2746
 
 
2747
    def get_format_string(self):
 
2748
        """See RepositoryFormat.get_format_string()."""
 
2749
        return "Bazaar RepositoryFormatKnitPack5 (bzr 1.6)\n"
 
2750
 
 
2751
    def get_format_description(self):
 
2752
        """See RepositoryFormat.get_format_description()."""
 
2753
        return "Packs 5 (adds stacking support, requires bzr 1.6)"
 
2754
 
 
2755
 
 
2756
class RepositoryFormatKnitPack5RichRoot(RepositoryFormatPack):
 
2757
    """A repository with rich roots and stacking.
 
2758
 
 
2759
    New in release 1.6.1.
 
2760
 
 
2761
    Supports stacking on other repositories, allowing data to be accessed
 
2762
    without being stored locally.
 
2763
    """
 
2764
 
 
2765
    repository_class = KnitPackRepository
 
2766
    _commit_builder_class = PackRootCommitBuilder
 
2767
    rich_root_data = True
 
2768
    supports_tree_reference = False # no subtrees
 
2769
    supports_external_lookups = True
 
2770
    # What index classes to use
 
2771
    index_builder_class = InMemoryGraphIndex
 
2772
    index_class = GraphIndex
 
2773
 
 
2774
    @property
 
2775
    def _serializer(self):
 
2776
        return xml6.serializer_v6
 
2777
 
 
2778
    def _get_matching_bzrdir(self):
 
2779
        return bzrdir.format_registry.make_bzrdir(
 
2780
            '1.6.1-rich-root')
 
2781
 
 
2782
    def _ignore_setting_bzrdir(self, format):
 
2783
        pass
 
2784
 
 
2785
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
 
2786
 
 
2787
    def get_format_string(self):
 
2788
        """See RepositoryFormat.get_format_string()."""
 
2789
        return "Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6.1)\n"
 
2790
 
 
2791
    def get_format_description(self):
 
2792
        return "Packs 5 rich-root (adds stacking support, requires bzr 1.6.1)"
 
2793
 
 
2794
 
 
2795
class RepositoryFormatKnitPack5RichRootBroken(RepositoryFormatPack):
 
2796
    """A repository with rich roots and external references.
 
2797
 
 
2798
    New in release 1.6.
 
2799
 
 
2800
    Supports external lookups, which results in non-truncated ghosts after
 
2801
    reconcile compared to pack-0.92 formats.
 
2802
 
 
2803
    This format was deprecated because the serializer it uses accidentally
 
2804
    supported subtrees, when the format was not intended to. This meant that
 
2805
    someone could accidentally fetch from an incorrect repository.
 
2806
    """
 
2807
 
 
2808
    repository_class = KnitPackRepository
 
2809
    _commit_builder_class = PackRootCommitBuilder
 
2810
    rich_root_data = True
 
2811
    supports_tree_reference = False # no subtrees
 
2812
 
 
2813
    supports_external_lookups = True
 
2814
    # What index classes to use
 
2815
    index_builder_class = InMemoryGraphIndex
 
2816
    index_class = GraphIndex
 
2817
 
 
2818
    @property
 
2819
    def _serializer(self):
 
2820
        return xml7.serializer_v7
 
2821
 
 
2822
    def _get_matching_bzrdir(self):
 
2823
        matching = bzrdir.format_registry.make_bzrdir(
 
2824
            '1.6.1-rich-root')
 
2825
        matching.repository_format = self
 
2826
        return matching
 
2827
 
 
2828
    def _ignore_setting_bzrdir(self, format):
 
2829
        pass
 
2830
 
 
2831
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
 
2832
 
 
2833
    def get_format_string(self):
 
2834
        """See RepositoryFormat.get_format_string()."""
 
2835
        return "Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6)\n"
 
2836
 
 
2837
    def get_format_description(self):
 
2838
        return ("Packs 5 rich-root (adds stacking support, requires bzr 1.6)"
 
2839
                " (deprecated)")
 
2840
 
 
2841
 
 
2842
class RepositoryFormatKnitPack6(RepositoryFormatPack):
 
2843
    """A repository with stacking and btree indexes,
 
2844
    without rich roots or subtrees.
 
2845
 
 
2846
    This is equivalent to pack-1.6 with B+Tree indices.
 
2847
    """
 
2848
 
 
2849
    repository_class = KnitPackRepository
 
2850
    _commit_builder_class = PackCommitBuilder
 
2851
    supports_external_lookups = True
 
2852
    # What index classes to use
 
2853
    index_builder_class = btree_index.BTreeBuilder
 
2854
    index_class = btree_index.BTreeGraphIndex
 
2855
 
 
2856
    @property
 
2857
    def _serializer(self):
 
2858
        return xml5.serializer_v5
 
2859
 
 
2860
    def _get_matching_bzrdir(self):
 
2861
        return bzrdir.format_registry.make_bzrdir('1.9')
 
2862
 
 
2863
    def _ignore_setting_bzrdir(self, format):
 
2864
        pass
 
2865
 
 
2866
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
 
2867
 
 
2868
    def get_format_string(self):
 
2869
        """See RepositoryFormat.get_format_string()."""
 
2870
        return "Bazaar RepositoryFormatKnitPack6 (bzr 1.9)\n"
 
2871
 
 
2872
    def get_format_description(self):
 
2873
        """See RepositoryFormat.get_format_description()."""
 
2874
        return "Packs 6 (uses btree indexes, requires bzr 1.9)"
 
2875
 
 
2876
 
 
2877
class RepositoryFormatKnitPack6RichRoot(RepositoryFormatPack):
 
2878
    """A repository with rich roots, no subtrees, stacking and btree indexes.
 
2879
 
 
2880
    1.6-rich-root with B+Tree indices.
 
2881
    """
 
2882
 
 
2883
    repository_class = KnitPackRepository
 
2884
    _commit_builder_class = PackRootCommitBuilder
 
2885
    rich_root_data = True
 
2886
    supports_tree_reference = False # no subtrees
 
2887
    supports_external_lookups = True
 
2888
    # What index classes to use
 
2889
    index_builder_class = btree_index.BTreeBuilder
 
2890
    index_class = btree_index.BTreeGraphIndex
 
2891
 
 
2892
    @property
 
2893
    def _serializer(self):
 
2894
        return xml6.serializer_v6
 
2895
 
 
2896
    def _get_matching_bzrdir(self):
 
2897
        return bzrdir.format_registry.make_bzrdir(
 
2898
            '1.9-rich-root')
 
2899
 
 
2900
    def _ignore_setting_bzrdir(self, format):
 
2901
        pass
 
2902
 
 
2903
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
 
2904
 
 
2905
    def get_format_string(self):
 
2906
        """See RepositoryFormat.get_format_string()."""
 
2907
        return "Bazaar RepositoryFormatKnitPack6RichRoot (bzr 1.9)\n"
 
2908
 
 
2909
    def get_format_description(self):
 
2910
        return "Packs 6 rich-root (uses btree indexes, requires bzr 1.9)"
 
2911
 
 
2912
 
 
2913
class RepositoryFormatPackDevelopment2Subtree(RepositoryFormatPack):
 
2914
    """A subtrees development repository.
 
2915
 
 
2916
    This format should be retained in 2.3, to provide an upgrade path from this
 
2917
    to RepositoryFormat2aSubtree.  It can be removed in later releases.
 
2918
 
 
2919
    1.6.1-subtree[as it might have been] with B+Tree indices.
 
2920
    """
 
2921
 
 
2922
    repository_class = KnitPackRepository
 
2923
    _commit_builder_class = PackRootCommitBuilder
 
2924
    rich_root_data = True
 
2925
    experimental = True
 
2926
    supports_tree_reference = True
 
2927
    supports_external_lookups = True
 
2928
    # What index classes to use
 
2929
    index_builder_class = btree_index.BTreeBuilder
 
2930
    index_class = btree_index.BTreeGraphIndex
 
2931
 
 
2932
    @property
 
2933
    def _serializer(self):
 
2934
        return xml7.serializer_v7
 
2935
 
 
2936
    def _get_matching_bzrdir(self):
 
2937
        return bzrdir.format_registry.make_bzrdir(
 
2938
            'development5-subtree')
 
2939
 
 
2940
    def _ignore_setting_bzrdir(self, format):
 
2941
        pass
 
2942
 
 
2943
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
 
2944
 
 
2945
    def get_format_string(self):
 
2946
        """See RepositoryFormat.get_format_string()."""
 
2947
        return ("Bazaar development format 2 with subtree support "
 
2948
            "(needs bzr.dev from before 1.8)\n")
 
2949
 
 
2950
    def get_format_description(self):
 
2951
        """See RepositoryFormat.get_format_description()."""
 
2952
        return ("Development repository format, currently the same as "
 
2953
            "1.6.1-subtree with B+Tree indices.\n")
 
2954
 
 
2955
 
1923
2956
class RetryPackOperations(errors.RetryWithNewPacks):
1924
2957
    """Raised when we are packing and we find a missing file.
1925
2958
 
1933
2966
            " context: %(context)s %(orig_error)s")
1934
2967
 
1935
2968
 
1936
 
class _DirectPackAccess(object):
1937
 
    """Access to data in one or more packs with less translation."""
1938
 
 
1939
 
    def __init__(self, index_to_packs, reload_func=None, flush_func=None):
1940
 
        """Create a _DirectPackAccess object.
1941
 
 
1942
 
        :param index_to_packs: A dict mapping index objects to the transport
1943
 
            and file names for obtaining data.
1944
 
        :param reload_func: A function to call if we determine that the pack
1945
 
            files have moved and we need to reload our caches. See
1946
 
            bzrlib.repo_fmt.pack_repo.AggregateIndex for more details.
1947
 
        """
1948
 
        self._container_writer = None
1949
 
        self._write_index = None
1950
 
        self._indices = index_to_packs
1951
 
        self._reload_func = reload_func
1952
 
        self._flush_func = flush_func
1953
 
 
1954
 
    def add_raw_records(self, key_sizes, raw_data):
1955
 
        """Add raw knit bytes to a storage area.
1956
 
 
1957
 
        The data is spooled to the container writer in one bytes-record per
1958
 
        raw data item.
1959
 
 
1960
 
        :param sizes: An iterable of tuples containing the key and size of each
1961
 
            raw data segment.
1962
 
        :param raw_data: A bytestring containing the data.
1963
 
        :return: A list of memos to retrieve the record later. Each memo is an
1964
 
            opaque index memo. For _DirectPackAccess the memo is (index, pos,
1965
 
            length), where the index field is the write_index object supplied
1966
 
            to the PackAccess object.
1967
 
        """
1968
 
        if type(raw_data) is not str:
1969
 
            raise AssertionError(
1970
 
                'data must be plain bytes was %s' % type(raw_data))
1971
 
        result = []
1972
 
        offset = 0
1973
 
        for key, size in key_sizes:
1974
 
            p_offset, p_length = self._container_writer.add_bytes_record(
1975
 
                raw_data[offset:offset+size], [])
1976
 
            offset += size
1977
 
            result.append((self._write_index, p_offset, p_length))
1978
 
        return result
1979
 
 
1980
 
    def flush(self):
1981
 
        """Flush pending writes on this access object.
1982
 
 
1983
 
        This will flush any buffered writes to a NewPack.
1984
 
        """
1985
 
        if self._flush_func is not None:
1986
 
            self._flush_func()
1987
 
 
1988
 
    def get_raw_records(self, memos_for_retrieval):
1989
 
        """Get the raw bytes for a records.
1990
 
 
1991
 
        :param memos_for_retrieval: An iterable containing the (index, pos,
1992
 
            length) memo for retrieving the bytes. The Pack access method
1993
 
            looks up the pack to use for a given record in its index_to_pack
1994
 
            map.
1995
 
        :return: An iterator over the bytes of the records.
1996
 
        """
1997
 
        # first pass, group into same-index requests
1998
 
        request_lists = []
1999
 
        current_index = None
2000
 
        for (index, offset, length) in memos_for_retrieval:
2001
 
            if current_index == index:
2002
 
                current_list.append((offset, length))
2003
 
            else:
2004
 
                if current_index is not None:
2005
 
                    request_lists.append((current_index, current_list))
2006
 
                current_index = index
2007
 
                current_list = [(offset, length)]
2008
 
        # handle the last entry
2009
 
        if current_index is not None:
2010
 
            request_lists.append((current_index, current_list))
2011
 
        for index, offsets in request_lists:
2012
 
            try:
2013
 
                transport, path = self._indices[index]
2014
 
            except KeyError:
2015
 
                # A KeyError here indicates that someone has triggered an index
2016
 
                # reload, and this index has gone missing, we need to start
2017
 
                # over.
2018
 
                if self._reload_func is None:
2019
 
                    # If we don't have a _reload_func there is nothing that can
2020
 
                    # be done
2021
 
                    raise
2022
 
                raise errors.RetryWithNewPacks(index,
2023
 
                                               reload_occurred=True,
2024
 
                                               exc_info=sys.exc_info())
2025
 
            try:
2026
 
                reader = pack.make_readv_reader(transport, path, offsets)
2027
 
                for names, read_func in reader.iter_records():
2028
 
                    yield read_func(None)
2029
 
            except errors.NoSuchFile:
2030
 
                # A NoSuchFile error indicates that a pack file has gone
2031
 
                # missing on disk, we need to trigger a reload, and start over.
2032
 
                if self._reload_func is None:
2033
 
                    raise
2034
 
                raise errors.RetryWithNewPacks(transport.abspath(path),
2035
 
                                               reload_occurred=False,
2036
 
                                               exc_info=sys.exc_info())
2037
 
 
2038
 
    def set_writer(self, writer, index, transport_packname):
2039
 
        """Set a writer to use for adding data."""
2040
 
        if index is not None:
2041
 
            self._indices[index] = transport_packname
2042
 
        self._container_writer = writer
2043
 
        self._write_index = index
2044
 
 
2045
 
    def reload_or_raise(self, retry_exc):
2046
 
        """Try calling the reload function, or re-raise the original exception.
2047
 
 
2048
 
        This should be called after _DirectPackAccess raises a
2049
 
        RetryWithNewPacks exception. This function will handle the common logic
2050
 
        of determining when the error is fatal versus being temporary.
2051
 
        It will also make sure that the original exception is raised, rather
2052
 
        than the RetryWithNewPacks exception.
2053
 
 
2054
 
        If this function returns, then the calling function should retry
2055
 
        whatever operation was being performed. Otherwise an exception will
2056
 
        be raised.
2057
 
 
2058
 
        :param retry_exc: A RetryWithNewPacks exception.
2059
 
        """
2060
 
        is_error = False
2061
 
        if self._reload_func is None:
2062
 
            is_error = True
2063
 
        elif not self._reload_func():
2064
 
            # The reload claimed that nothing changed
2065
 
            if not retry_exc.reload_occurred:
2066
 
                # If there wasn't an earlier reload, then we really were
2067
 
                # expecting to find changes. We didn't find them, so this is a
2068
 
                # hard error
2069
 
                is_error = True
2070
 
        if is_error:
2071
 
            exc_class, exc_value, exc_traceback = retry_exc.exc_info
2072
 
            raise exc_class, exc_value, exc_traceback
2073
 
 
2074
 
 
2075