~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repofmt/pack_repo.py

  • Committer: John Arbash Meinel
  • Date: 2011-05-11 11:35:28 UTC
  • mto: This revision was merged to the branch mainline in revision 5851.
  • Revision ID: john@arbash-meinel.com-20110511113528-qepibuwxicjrbb2h
Break compatibility with python <2.6.

This includes auditing the code for places where we were doing
explicit 'sys.version' checks and removing them as appropriate.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2007-2010 Canonical Ltd
 
1
# Copyright (C) 2007-2011 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
30
30
    osutils,
31
31
    pack,
32
32
    transactions,
 
33
    tsort,
33
34
    ui,
34
 
    xml5,
35
 
    xml6,
36
 
    xml7,
37
35
    )
38
36
from bzrlib.index import (
39
37
    CombinedGraphIndex,
40
38
    GraphIndexPrefixAdapter,
41
39
    )
42
 
from bzrlib.knit import (
43
 
    KnitPlainFactory,
44
 
    KnitVersionedFiles,
45
 
    _KnitGraphIndex,
46
 
    _DirectPackAccess,
47
 
    )
48
 
from bzrlib import tsort
49
40
""")
50
41
from bzrlib import (
51
 
    bzrdir,
52
42
    btree_index,
53
43
    errors,
54
44
    lockable_files,
55
45
    lockdir,
56
 
    revision as _mod_revision,
57
46
    )
58
47
 
59
 
from bzrlib.decorators import needs_write_lock, only_raises
60
 
from bzrlib.index import (
61
 
    GraphIndex,
62
 
    InMemoryGraphIndex,
 
48
from bzrlib.decorators import (
 
49
    needs_read_lock,
 
50
    needs_write_lock,
 
51
    only_raises,
63
52
    )
64
53
from bzrlib.lock import LogicalLockResult
65
 
from bzrlib.repofmt.knitrepo import KnitRepository
66
54
from bzrlib.repository import (
67
 
    CommitBuilder,
68
 
    MetaDirRepositoryFormat,
 
55
    _LazyListJoin,
 
56
    MetaDirRepository,
69
57
    RepositoryFormat,
70
58
    RepositoryWriteLockResult,
71
 
    RootCommitBuilder,
72
 
    StreamSource,
 
59
    )
 
60
from bzrlib.vf_repository import (
 
61
    MetaDirVersionedFileRepository,
 
62
    MetaDirVersionedFileRepositoryFormat,
 
63
    VersionedFileCommitBuilder,
 
64
    VersionedFileRootCommitBuilder,
73
65
    )
74
66
from bzrlib.trace import (
75
67
    mutter,
78
70
    )
79
71
 
80
72
 
81
 
class PackCommitBuilder(CommitBuilder):
82
 
    """A subclass of CommitBuilder to add texts with pack semantics.
 
73
class PackCommitBuilder(VersionedFileCommitBuilder):
 
74
    """Subclass of VersionedFileCommitBuilder to add texts with pack semantics.
83
75
 
84
76
    Specifically this uses one knit object rather than one knit object per
85
77
    added text, reducing memory and object pressure.
87
79
 
88
80
    def __init__(self, repository, parents, config, timestamp=None,
89
81
                 timezone=None, committer=None, revprops=None,
90
 
                 revision_id=None):
91
 
        CommitBuilder.__init__(self, repository, parents, config,
 
82
                 revision_id=None, lossy=False):
 
83
        VersionedFileCommitBuilder.__init__(self, repository, parents, config,
92
84
            timestamp=timestamp, timezone=timezone, committer=committer,
93
 
            revprops=revprops, revision_id=revision_id)
 
85
            revprops=revprops, revision_id=revision_id, lossy=lossy)
94
86
        self._file_graph = graph.Graph(
95
87
            repository._pack_collection.text_index.combined_index)
96
88
 
99
91
        return set([key[1] for key in self._file_graph.heads(keys)])
100
92
 
101
93
 
102
 
class PackRootCommitBuilder(RootCommitBuilder):
 
94
class PackRootCommitBuilder(VersionedFileRootCommitBuilder):
103
95
    """A subclass of RootCommitBuilder to add texts with pack semantics.
104
96
 
105
97
    Specifically this uses one knit object rather than one knit object per
108
100
 
109
101
    def __init__(self, repository, parents, config, timestamp=None,
110
102
                 timezone=None, committer=None, revprops=None,
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)
 
103
                 revision_id=None, lossy=False):
 
104
        super(PackRootCommitBuilder, self).__init__(repository, parents,
 
105
            config, timestamp=timestamp, timezone=timezone,
 
106
            committer=committer, revprops=revprops, revision_id=revision_id,
 
107
            lossy=lossy)
115
108
        self._file_graph = graph.Graph(
116
109
            repository._pack_collection.text_index.combined_index)
117
110
 
673
666
        # What text keys to copy. None for 'all texts'. This is set by
674
667
        # _copy_inventory_texts
675
668
        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)
709
669
 
710
670
    def pack(self, pb=None):
711
671
        """Create a new pack by reading data from other packs.
722
682
        :return: A Pack object, or None if nothing was copied.
723
683
        """
724
684
        # open a pack - using the same name as the last temporary file
725
 
        # - which has already been flushed, so its safe.
 
685
        # - which has already been flushed, so it's safe.
726
686
        # XXX: - duplicate code warning with start_write_group; fix before
727
687
        #      considering 'done'.
728
688
        if self._pack_collection._new_pack is not None:
760
720
        new_pack.signature_index.set_optimize(combine_backing_indices=False)
761
721
        return new_pack
762
722
 
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
 
 
797
723
    def _copy_revision_texts(self):
798
724
        """Copy revision data to the new pack."""
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
 
725
        raise NotImplementedError(self._copy_revision_texts)
822
726
 
823
727
    def _copy_inventory_texts(self):
824
728
        """Copy the inventory texts to the new pack.
827
731
 
828
732
        Sets self._text_filter appropriately.
829
733
        """
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)
 
734
        raise NotImplementedError(self._copy_inventory_texts)
860
735
 
861
736
    def _copy_text_texts(self):
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()
 
737
        raise NotImplementedError(self._copy_text_texts)
887
738
 
888
739
    def _create_pack_from_packs(self):
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
 
740
        raise NotImplementedError(self._create_pack_from_packs)
1131
741
 
1132
742
    def _log_copied_texts(self):
1133
743
        if 'pack' in debug.debug_flags:
1137
747
                self.new_pack.text_index.key_count(),
1138
748
                time.time() - self.new_pack.start_time)
1139
749
 
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
 
 
1159
750
    def _use_pack(self, new_pack):
1160
751
        """Return True if new_pack should be used.
1161
752
 
1165
756
        return new_pack.data_inserted()
1166
757
 
1167
758
 
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._find_text_key_references_from_xml_inventory_lines(
1226
 
            inv_lines)
1227
 
        self._text_refs = refs
1228
 
        # during reconcile we:
1229
 
        #  - convert unreferenced texts to full texts
1230
 
        #  - correct texts which reference a text not copied to be full texts
1231
 
        #  - copy all others as-is but with corrected parents.
1232
 
        #  - so at this point we don't know enough to decide what becomes a full
1233
 
        #    text.
1234
 
        self._text_filter = None
1235
 
 
1236
 
    def _copy_text_texts(self):
1237
 
        """generate what texts we should have and then copy."""
1238
 
        self.pb.update("Copying content texts", 3)
1239
 
        # we have three major tasks here:
1240
 
        # 1) generate the ideal index
1241
 
        repo = self._pack_collection.repo
1242
 
        ancestors = dict([(key[0], tuple(ref[0] for ref in refs[0])) for
1243
 
            _1, key, _2, refs in
1244
 
            self.new_pack.revision_index.iter_all_entries()])
1245
 
        ideal_index = repo._generate_text_key_index(self._text_refs, ancestors)
1246
 
        # 2) generate a text_nodes list that contains all the deltas that can
1247
 
        #    be used as-is, with corrected parents.
1248
 
        ok_nodes = []
1249
 
        bad_texts = []
1250
 
        discarded_nodes = []
1251
 
        NULL_REVISION = _mod_revision.NULL_REVISION
1252
 
        text_index_map, text_nodes = self._get_text_nodes()
1253
 
        for node in text_nodes:
1254
 
            # 0 - index
1255
 
            # 1 - key
1256
 
            # 2 - value
1257
 
            # 3 - refs
1258
 
            try:
1259
 
                ideal_parents = tuple(ideal_index[node[1]])
1260
 
            except KeyError:
1261
 
                discarded_nodes.append(node)
1262
 
                self._data_changed = True
1263
 
            else:
1264
 
                if ideal_parents == (NULL_REVISION,):
1265
 
                    ideal_parents = ()
1266
 
                if ideal_parents == node[3][0]:
1267
 
                    # no change needed.
1268
 
                    ok_nodes.append(node)
1269
 
                elif ideal_parents[0:1] == node[3][0][0:1]:
1270
 
                    # the left most parent is the same, or there are no parents
1271
 
                    # today. Either way, we can preserve the representation as
1272
 
                    # long as we change the refs to be inserted.
1273
 
                    self._data_changed = True
1274
 
                    ok_nodes.append((node[0], node[1], node[2],
1275
 
                        (ideal_parents, node[3][1])))
1276
 
                    self._data_changed = True
1277
 
                else:
1278
 
                    # Reinsert this text completely
1279
 
                    bad_texts.append((node[1], ideal_parents))
1280
 
                    self._data_changed = True
1281
 
        # we're finished with some data.
1282
 
        del ideal_index
1283
 
        del text_nodes
1284
 
        # 3) bulk copy the ok data
1285
 
        total_items, readv_group_iter = self._least_readv_node_readv(ok_nodes)
1286
 
        list(self._copy_nodes_graph(text_index_map, self.new_pack._writer,
1287
 
            self.new_pack.text_index, readv_group_iter, total_items))
1288
 
        # 4) adhoc copy all the other texts.
1289
 
        # We have to topologically insert all texts otherwise we can fail to
1290
 
        # reconcile when parts of a single delta chain are preserved intact,
1291
 
        # and other parts are not. E.g. Discarded->d1->d2->d3. d1 will be
1292
 
        # reinserted, and if d3 has incorrect parents it will also be
1293
 
        # reinserted. If we insert d3 first, d2 is present (as it was bulk
1294
 
        # copied), so we will try to delta, but d2 is not currently able to be
1295
 
        # extracted because it's basis d1 is not present. Topologically sorting
1296
 
        # addresses this. The following generates a sort for all the texts that
1297
 
        # are being inserted without having to reference the entire text key
1298
 
        # space (we only topo sort the revisions, which is smaller).
1299
 
        topo_order = tsort.topo_sort(ancestors)
1300
 
        rev_order = dict(zip(topo_order, range(len(topo_order))))
1301
 
        bad_texts.sort(key=lambda key:rev_order.get(key[0][1], 0))
1302
 
        transaction = repo.get_transaction()
1303
 
        file_id_index = GraphIndexPrefixAdapter(
1304
 
            self.new_pack.text_index,
1305
 
            ('blank', ), 1,
1306
 
            add_nodes_callback=self.new_pack.text_index.add_nodes)
1307
 
        data_access = _DirectPackAccess(
1308
 
                {self.new_pack.text_index:self.new_pack.access_tuple()})
1309
 
        data_access.set_writer(self.new_pack._writer, self.new_pack.text_index,
1310
 
            self.new_pack.access_tuple())
1311
 
        output_texts = KnitVersionedFiles(
1312
 
            _KnitGraphIndex(self.new_pack.text_index,
1313
 
                add_callback=self.new_pack.text_index.add_nodes,
1314
 
                deltas=True, parents=True, is_locked=repo.is_locked),
1315
 
            data_access=data_access, max_delta_chain=200)
1316
 
        for key, parent_keys in bad_texts:
1317
 
            # We refer to the new pack to delta data being output.
1318
 
            # A possible improvement would be to catch errors on short reads
1319
 
            # and only flush then.
1320
 
            self.new_pack.flush()
1321
 
            parents = []
1322
 
            for parent_key in parent_keys:
1323
 
                if parent_key[0] != key[0]:
1324
 
                    # Graph parents must match the fileid
1325
 
                    raise errors.BzrError('Mismatched key parent %r:%r' %
1326
 
                        (key, parent_keys))
1327
 
                parents.append(parent_key[1])
1328
 
            text_lines = osutils.split_lines(repo.texts.get_record_stream(
1329
 
                [key], 'unordered', True).next().get_bytes_as('fulltext'))
1330
 
            output_texts.add_lines(key, parent_keys, text_lines,
1331
 
                random_id=True, check_content=False)
1332
 
        # 5) check that nothing inserted has a reference outside the keyspace.
1333
 
        missing_text_keys = self.new_pack.text_index._external_references()
1334
 
        if missing_text_keys:
1335
 
            raise errors.BzrCheckError('Reference to missing compression parents %r'
1336
 
                % (missing_text_keys,))
1337
 
        self._log_copied_texts()
1338
 
 
1339
 
    def _use_pack(self, new_pack):
1340
 
        """Override _use_pack to check for reconcile having changed content."""
1341
 
        # XXX: we might be better checking this at the copy time.
1342
 
        original_inventory_keys = set()
1343
 
        inv_index = self._pack_collection.inventory_index.combined_index
1344
 
        for entry in inv_index.iter_all_entries():
1345
 
            original_inventory_keys.add(entry[1])
1346
 
        new_inventory_keys = set()
1347
 
        for entry in new_pack.inventory_index.iter_all_entries():
1348
 
            new_inventory_keys.add(entry[1])
1349
 
        if new_inventory_keys != original_inventory_keys:
1350
 
            self._data_changed = True
1351
 
        return new_pack.data_inserted() and self._data_changed
1352
 
 
1353
 
 
1354
759
class RepositoryPackCollection(object):
1355
760
    """Management of packs within a repository.
1356
761
 
1357
762
    :ivar _names: map of {pack_name: (index_size,)}
1358
763
    """
1359
764
 
1360
 
    pack_factory = NewPack
1361
 
    resumed_pack_factory = ResumedPack
 
765
    pack_factory = None
 
766
    resumed_pack_factory = None
 
767
    normal_packer_class = None
 
768
    optimising_packer_class = None
1362
769
 
1363
770
    def __init__(self, repo, transport, index_transport, upload_transport,
1364
771
                 pack_transport, index_builder_class, index_class,
1505
912
            'containing %d revisions. Packing %d files into %d affecting %d'
1506
913
            ' revisions', self, total_packs, total_revisions, num_old_packs,
1507
914
            num_new_packs, num_revs_affected)
1508
 
        result = self._execute_pack_operations(pack_operations,
 
915
        result = self._execute_pack_operations(pack_operations, packer_class=self.normal_packer_class,
1509
916
                                      reload_func=self._restart_autopack)
1510
917
        mutter('Auto-packing repository %s completed', self)
1511
918
        return result
1512
919
 
1513
 
    def _execute_pack_operations(self, pack_operations, _packer_class=Packer,
1514
 
                                 reload_func=None):
 
920
    def _execute_pack_operations(self, pack_operations, packer_class,
 
921
            reload_func=None):
1515
922
        """Execute a series of pack operations.
1516
923
 
1517
924
        :param pack_operations: A list of [revision_count, packs_to_combine].
1518
 
        :param _packer_class: The class of packer to use (default: Packer).
 
925
        :param packer_class: The class of packer to use
1519
926
        :return: The new pack names.
1520
927
        """
1521
928
        for revision_count, packs in pack_operations:
1522
929
            # we may have no-ops from the setup logic
1523
930
            if len(packs) == 0:
1524
931
                continue
1525
 
            packer = _packer_class(self, packs, '.autopack',
 
932
            packer = packer_class(self, packs, '.autopack',
1526
933
                                   reload_func=reload_func)
1527
934
            try:
1528
 
                packer.pack()
 
935
                result = packer.pack()
1529
936
            except errors.RetryWithNewPacks:
1530
937
                # An exception is propagating out of this context, make sure
1531
938
                # this packer has cleaned up. Packer() doesn't set its new_pack
1534
941
                if packer.new_pack is not None:
1535
942
                    packer.new_pack.abort()
1536
943
                raise
 
944
            if result is None:
 
945
                return
1537
946
            for pack in packs:
1538
947
                self._remove_pack_from_memory(pack)
1539
948
        # record the newly available packs and stop advertising the old
1573
982
        mutter('Packing repository %s, which has %d pack files, '
1574
983
            'containing %d revisions with hint %r.', self, total_packs,
1575
984
            total_revisions, hint)
 
985
        while True:
 
986
            try:
 
987
                self._try_pack_operations(hint)
 
988
            except RetryPackOperations:
 
989
                continue
 
990
            break
 
991
 
 
992
        if clean_obsolete_packs:
 
993
            self._clear_obsolete_packs()
 
994
 
 
995
    def _try_pack_operations(self, hint):
 
996
        """Calculate the pack operations based on the hint (if any), and
 
997
        execute them.
 
998
        """
1576
999
        # determine which packs need changing
1577
1000
        pack_operations = [[0, []]]
1578
1001
        for pack in self.all_packs():
1581
1004
                # or this pack was included in the hint.
1582
1005
                pack_operations[-1][0] += pack.get_revision_count()
1583
1006
                pack_operations[-1][1].append(pack)
1584
 
        self._execute_pack_operations(pack_operations, OptimisingPacker)
1585
 
 
1586
 
        if clean_obsolete_packs:
1587
 
            self._clear_obsolete_packs()
 
1007
        self._execute_pack_operations(pack_operations,
 
1008
            packer_class=self.optimising_packer_class,
 
1009
            reload_func=self._restart_pack_operations)
1588
1010
 
1589
1011
    def plan_autopack_combinations(self, existing_packs, pack_distribution):
1590
1012
        """Plan a pack operation.
1600
1022
        pack_operations = [[0, []]]
1601
1023
        # plan out what packs to keep, and what to reorganise
1602
1024
        while len(existing_packs):
1603
 
            # take the largest pack, and if its less than the head of the
 
1025
            # take the largest pack, and if it's less than the head of the
1604
1026
            # distribution chart we will include its contents in the new pack
1605
 
            # for that position. If its larger, we remove its size from the
 
1027
            # for that position. If it's larger, we remove its size from the
1606
1028
            # distribution chart
1607
1029
            next_pack_rev_count, next_pack = existing_packs.pop(0)
1608
1030
            if next_pack_rev_count >= pack_distribution[0]:
1643
1065
 
1644
1066
        :return: True if the disk names had not been previously read.
1645
1067
        """
1646
 
        # NB: if you see an assertion error here, its probably access against
 
1068
        # NB: if you see an assertion error here, it's probably access against
1647
1069
        # an unlocked repo. Naughty.
1648
1070
        if not self.repo.is_locked():
1649
1071
            raise errors.ObjectNotLocked(self.repo)
1946
1368
                    # disk index because the set values are the same, unless
1947
1369
                    # the only index shows up as deleted by the set difference
1948
1370
                    # - which it may. Until there is a specific test for this,
1949
 
                    # assume its broken. RBC 20071017.
 
1371
                    # assume it's broken. RBC 20071017.
1950
1372
                    self._remove_pack_from_memory(self.get_pack_by_name(name))
1951
1373
                    self._names[name] = sizes
1952
1374
                    self.get_pack_by_name(name)
2017
1439
        """
2018
1440
        # The ensure_loaded call is to handle the case where the first call
2019
1441
        # made involving the collection was to reload_pack_names, where we 
2020
 
        # don't have a view of disk contents. Its a bit of a bandaid, and
2021
 
        # causes two reads of pack-names, but its a rare corner case not struck
2022
 
        # with regular push/pull etc.
 
1442
        # don't have a view of disk contents. It's a bit of a bandaid, and
 
1443
        # causes two reads of pack-names, but it's a rare corner case not
 
1444
        # struck with regular push/pull etc.
2023
1445
        first_read = self.ensure_loaded()
2024
1446
        if first_read:
2025
1447
            return True
2044
1466
            raise
2045
1467
        raise errors.RetryAutopack(self.repo, False, sys.exc_info())
2046
1468
 
 
1469
    def _restart_pack_operations(self):
 
1470
        """Reload the pack names list, and restart the autopack code."""
 
1471
        if not self.reload_pack_names():
 
1472
            # Re-raise the original exception, because something went missing
 
1473
            # and a restart didn't find it
 
1474
            raise
 
1475
        raise RetryPackOperations(self.repo, False, sys.exc_info())
 
1476
 
2047
1477
    def _clear_obsolete_packs(self, preserve=None):
2048
1478
        """Delete everything from the obsolete-packs directory.
2049
1479
 
2197
1627
            self._resume_pack(token)
2198
1628
 
2199
1629
 
2200
 
class KnitPackRepository(KnitRepository):
 
1630
class PackRepository(MetaDirVersionedFileRepository):
2201
1631
    """Repository with knit objects stored inside pack containers.
2202
1632
 
2203
1633
    The layering for a KnitPackRepository is:
2206
1636
    ===================================================
2207
1637
    Tuple based apis below, string based, and key based apis above
2208
1638
    ---------------------------------------------------
2209
 
    KnitVersionedFiles
 
1639
    VersionedFiles
2210
1640
      Provides .texts, .revisions etc
2211
1641
      This adapts the N-tuple keys to physical knit records which only have a
2212
1642
      single string identifier (for historical reasons), which in older formats
2222
1652
 
2223
1653
    """
2224
1654
 
 
1655
    # These attributes are inherited from the Repository base class. Setting
 
1656
    # them to None ensures that if the constructor is changed to not initialize
 
1657
    # them, or a subclass fails to call the constructor, that an error will
 
1658
    # occur rather than the system working but generating incorrect data.
 
1659
    _commit_builder_class = None
 
1660
    _serializer = None
 
1661
 
2225
1662
    def __init__(self, _format, a_bzrdir, control_files, _commit_builder_class,
2226
1663
        _serializer):
2227
 
        KnitRepository.__init__(self, _format, a_bzrdir, control_files,
2228
 
            _commit_builder_class, _serializer)
2229
 
        index_transport = self._transport.clone('indices')
2230
 
        self._pack_collection = RepositoryPackCollection(self, self._transport,
2231
 
            index_transport,
2232
 
            self._transport.clone('upload'),
2233
 
            self._transport.clone('packs'),
2234
 
            _format.index_builder_class,
2235
 
            _format.index_class,
2236
 
            use_chk_index=self._format.supports_chks,
2237
 
            )
2238
 
        self.inventories = KnitVersionedFiles(
2239
 
            _KnitGraphIndex(self._pack_collection.inventory_index.combined_index,
2240
 
                add_callback=self._pack_collection.inventory_index.add_callback,
2241
 
                deltas=True, parents=True, is_locked=self.is_locked),
2242
 
            data_access=self._pack_collection.inventory_index.data_access,
2243
 
            max_delta_chain=200)
2244
 
        self.revisions = KnitVersionedFiles(
2245
 
            _KnitGraphIndex(self._pack_collection.revision_index.combined_index,
2246
 
                add_callback=self._pack_collection.revision_index.add_callback,
2247
 
                deltas=False, parents=True, is_locked=self.is_locked,
2248
 
                track_external_parent_refs=True),
2249
 
            data_access=self._pack_collection.revision_index.data_access,
2250
 
            max_delta_chain=0)
2251
 
        self.signatures = KnitVersionedFiles(
2252
 
            _KnitGraphIndex(self._pack_collection.signature_index.combined_index,
2253
 
                add_callback=self._pack_collection.signature_index.add_callback,
2254
 
                deltas=False, parents=False, is_locked=self.is_locked),
2255
 
            data_access=self._pack_collection.signature_index.data_access,
2256
 
            max_delta_chain=0)
2257
 
        self.texts = KnitVersionedFiles(
2258
 
            _KnitGraphIndex(self._pack_collection.text_index.combined_index,
2259
 
                add_callback=self._pack_collection.text_index.add_callback,
2260
 
                deltas=True, parents=True, is_locked=self.is_locked),
2261
 
            data_access=self._pack_collection.text_index.data_access,
2262
 
            max_delta_chain=200)
2263
 
        if _format.supports_chks:
2264
 
            # No graph, no compression:- references from chks are between
2265
 
            # different objects not temporal versions of the same; and without
2266
 
            # some sort of temporal structure knit compression will just fail.
2267
 
            self.chk_bytes = KnitVersionedFiles(
2268
 
                _KnitGraphIndex(self._pack_collection.chk_index.combined_index,
2269
 
                    add_callback=self._pack_collection.chk_index.add_callback,
2270
 
                    deltas=False, parents=False, is_locked=self.is_locked),
2271
 
                data_access=self._pack_collection.chk_index.data_access,
2272
 
                max_delta_chain=0)
2273
 
        else:
2274
 
            self.chk_bytes = None
2275
 
        # True when the repository object is 'write locked' (as opposed to the
2276
 
        # physical lock only taken out around changes to the pack-names list.)
2277
 
        # Another way to represent this would be a decorator around the control
2278
 
        # files object that presents logical locks as physical ones - if this
2279
 
        # gets ugly consider that alternative design. RBC 20071011
2280
 
        self._write_lock_count = 0
2281
 
        self._transaction = None
2282
 
        # for tests
2283
 
        self._reconcile_does_inventory_gc = True
 
1664
        MetaDirRepository.__init__(self, _format, a_bzrdir, control_files)
 
1665
        self._commit_builder_class = _commit_builder_class
 
1666
        self._serializer = _serializer
2284
1667
        self._reconcile_fixes_text_parents = True
2285
 
        self._reconcile_backsup_inventory = False
 
1668
        if self._format.supports_external_lookups:
 
1669
            self._unstacked_provider = graph.CachingParentsProvider(
 
1670
                self._make_parents_provider_unstacked())
 
1671
        else:
 
1672
            self._unstacked_provider = graph.CachingParentsProvider(self)
 
1673
        self._unstacked_provider.disable_cache()
2286
1674
 
2287
 
    def _warn_if_deprecated(self, branch=None):
2288
 
        # This class isn't deprecated, but one sub-format is
2289
 
        if isinstance(self._format, RepositoryFormatKnitPack5RichRootBroken):
2290
 
            super(KnitPackRepository, self)._warn_if_deprecated(branch)
 
1675
    @needs_read_lock
 
1676
    def _all_revision_ids(self):
 
1677
        """See Repository.all_revision_ids()."""
 
1678
        return [key[0] for key in self.revisions.keys()]
2291
1679
 
2292
1680
    def _abort_write_group(self):
2293
1681
        self.revisions._index._key_dependencies.clear()
2294
1682
        self._pack_collection._abort_write_group()
2295
1683
 
2296
 
    def _get_source(self, to_format):
2297
 
        if to_format.network_name() == self._format.network_name():
2298
 
            return KnitPackStreamSource(self, to_format)
2299
 
        return super(KnitPackRepository, self)._get_source(to_format)
2300
 
 
2301
1684
    def _make_parents_provider(self):
2302
 
        return graph.CachingParentsProvider(self)
 
1685
        if not self._format.supports_external_lookups:
 
1686
            return self._unstacked_provider
 
1687
        return graph.StackedParentsProvider(_LazyListJoin(
 
1688
            [self._unstacked_provider], self._fallback_repositories))
2303
1689
 
2304
1690
    def _refresh_data(self):
2305
1691
        if not self.is_locked():
2306
1692
            return
2307
1693
        self._pack_collection.reload_pack_names()
 
1694
        self._unstacked_provider.disable_cache()
 
1695
        self._unstacked_provider.enable_cache()
2308
1696
 
2309
1697
    def _start_write_group(self):
2310
1698
        self._pack_collection._start_write_group()
2312
1700
    def _commit_write_group(self):
2313
1701
        hint = self._pack_collection._commit_write_group()
2314
1702
        self.revisions._index._key_dependencies.clear()
 
1703
        # The commit may have added keys that were previously cached as
 
1704
        # missing, so reset the cache.
 
1705
        self._unstacked_provider.disable_cache()
 
1706
        self._unstacked_provider.enable_cache()
2315
1707
        return hint
2316
1708
 
2317
1709
    def suspend_write_group(self):
2358
1750
            if 'relock' in debug.debug_flags and self._prev_lock == 'w':
2359
1751
                note('%r was write locked again', self)
2360
1752
            self._prev_lock = 'w'
 
1753
            self._unstacked_provider.enable_cache()
2361
1754
            for repo in self._fallback_repositories:
2362
1755
                # Writes don't affect fallback repos
2363
1756
                repo.lock_read()
2378
1771
            if 'relock' in debug.debug_flags and self._prev_lock == 'r':
2379
1772
                note('%r was read locked again', self)
2380
1773
            self._prev_lock = 'r'
 
1774
            self._unstacked_provider.enable_cache()
2381
1775
            for repo in self._fallback_repositories:
2382
1776
                repo.lock_read()
2383
1777
            self._refresh_data()
2409
1803
        return reconciler
2410
1804
 
2411
1805
    def _reconcile_pack(self, collection, packs, extension, revs, pb):
2412
 
        packer = ReconcilePacker(collection, packs, extension, revs)
2413
 
        return packer.pack(pb)
 
1806
        raise NotImplementedError(self._reconcile_pack)
2414
1807
 
2415
1808
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2416
1809
    def unlock(self):
2417
1810
        if self._write_lock_count == 1 and self._write_group is not None:
2418
1811
            self.abort_write_group()
 
1812
            self._unstacked_provider.disable_cache()
2419
1813
            self._transaction = None
2420
1814
            self._write_lock_count = 0
2421
1815
            raise errors.BzrError(
2431
1825
            self.control_files.unlock()
2432
1826
 
2433
1827
        if not self.is_locked():
 
1828
            self._unstacked_provider.disable_cache()
2434
1829
            for repo in self._fallback_repositories:
2435
1830
                repo.unlock()
2436
1831
 
2437
1832
 
2438
 
class KnitPackStreamSource(StreamSource):
2439
 
    """A StreamSource used to transfer data between same-format KnitPack repos.
2440
 
 
2441
 
    This source assumes:
2442
 
        1) Same serialization format for all objects
2443
 
        2) Same root information
2444
 
        3) XML format inventories
2445
 
        4) Atomic inserts (so we can stream inventory texts before text
2446
 
           content)
2447
 
        5) No chk_bytes
2448
 
    """
2449
 
 
2450
 
    def __init__(self, from_repository, to_format):
2451
 
        super(KnitPackStreamSource, self).__init__(from_repository, to_format)
2452
 
        self._text_keys = None
2453
 
        self._text_fetch_order = 'unordered'
2454
 
 
2455
 
    def _get_filtered_inv_stream(self, revision_ids):
2456
 
        from_repo = self.from_repository
2457
 
        parent_ids = from_repo._find_parent_ids_of_revisions(revision_ids)
2458
 
        parent_keys = [(p,) for p in parent_ids]
2459
 
        find_text_keys = from_repo._find_text_key_references_from_xml_inventory_lines
2460
 
        parent_text_keys = set(find_text_keys(
2461
 
            from_repo._inventory_xml_lines_for_keys(parent_keys)))
2462
 
        content_text_keys = set()
2463
 
        knit = KnitVersionedFiles(None, None)
2464
 
        factory = KnitPlainFactory()
2465
 
        def find_text_keys_from_content(record):
2466
 
            if record.storage_kind not in ('knit-delta-gz', 'knit-ft-gz'):
2467
 
                raise ValueError("Unknown content storage kind for"
2468
 
                    " inventory text: %s" % (record.storage_kind,))
2469
 
            # It's a knit record, it has a _raw_record field (even if it was
2470
 
            # reconstituted from a network stream).
2471
 
            raw_data = record._raw_record
2472
 
            # read the entire thing
2473
 
            revision_id = record.key[-1]
2474
 
            content, _ = knit._parse_record(revision_id, raw_data)
2475
 
            if record.storage_kind == 'knit-delta-gz':
2476
 
                line_iterator = factory.get_linedelta_content(content)
2477
 
            elif record.storage_kind == 'knit-ft-gz':
2478
 
                line_iterator = factory.get_fulltext_content(content)
2479
 
            content_text_keys.update(find_text_keys(
2480
 
                [(line, revision_id) for line in line_iterator]))
2481
 
        revision_keys = [(r,) for r in revision_ids]
2482
 
        def _filtered_inv_stream():
2483
 
            source_vf = from_repo.inventories
2484
 
            stream = source_vf.get_record_stream(revision_keys,
2485
 
                                                 'unordered', False)
2486
 
            for record in stream:
2487
 
                if record.storage_kind == 'absent':
2488
 
                    raise errors.NoSuchRevision(from_repo, record.key)
2489
 
                find_text_keys_from_content(record)
2490
 
                yield record
2491
 
            self._text_keys = content_text_keys - parent_text_keys
2492
 
        return ('inventories', _filtered_inv_stream())
2493
 
 
2494
 
    def _get_text_stream(self):
2495
 
        # Note: We know we don't have to handle adding root keys, because both
2496
 
        # the source and target are the identical network name.
2497
 
        text_stream = self.from_repository.texts.get_record_stream(
2498
 
                        self._text_keys, self._text_fetch_order, False)
2499
 
        return ('texts', text_stream)
2500
 
 
2501
 
    def get_stream(self, search):
2502
 
        revision_ids = search.get_keys()
2503
 
        for stream_info in self._fetch_revision_texts(revision_ids):
2504
 
            yield stream_info
2505
 
        self._revision_keys = [(rev_id,) for rev_id in revision_ids]
2506
 
        yield self._get_filtered_inv_stream(revision_ids)
2507
 
        yield self._get_text_stream()
2508
 
 
2509
 
 
2510
 
 
2511
 
class RepositoryFormatPack(MetaDirRepositoryFormat):
 
1833
class RepositoryFormatPack(MetaDirVersionedFileRepositoryFormat):
2512
1834
    """Format logic for pack structured repositories.
2513
1835
 
2514
1836
    This repository format has:
2544
1866
    index_class = None
2545
1867
    _fetch_uses_deltas = True
2546
1868
    fast_deltas = False
 
1869
    supports_funky_characters = True
 
1870
    revision_graph_can_have_wrong_parents = True
2547
1871
 
2548
1872
    def initialize(self, a_bzrdir, shared=False):
2549
1873
        """Create a pack based repository.
2586
1910
                              _serializer=self._serializer)
2587
1911
 
2588
1912
 
2589
 
class RepositoryFormatKnitPack1(RepositoryFormatPack):
2590
 
    """A no-subtrees parameterized Pack repository.
2591
 
 
2592
 
    This format was introduced in 0.92.
2593
 
    """
2594
 
 
2595
 
    repository_class = KnitPackRepository
2596
 
    _commit_builder_class = PackCommitBuilder
2597
 
    @property
2598
 
    def _serializer(self):
2599
 
        return xml5.serializer_v5
2600
 
    # What index classes to use
2601
 
    index_builder_class = InMemoryGraphIndex
2602
 
    index_class = GraphIndex
2603
 
 
2604
 
    def _get_matching_bzrdir(self):
2605
 
        return bzrdir.format_registry.make_bzrdir('pack-0.92')
2606
 
 
2607
 
    def _ignore_setting_bzrdir(self, format):
2608
 
        pass
2609
 
 
2610
 
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2611
 
 
2612
 
    def get_format_string(self):
2613
 
        """See RepositoryFormat.get_format_string()."""
2614
 
        return "Bazaar pack repository format 1 (needs bzr 0.92)\n"
2615
 
 
2616
 
    def get_format_description(self):
2617
 
        """See RepositoryFormat.get_format_description()."""
2618
 
        return "Packs containing knits without subtree support"
2619
 
 
2620
 
 
2621
 
class RepositoryFormatKnitPack3(RepositoryFormatPack):
2622
 
    """A subtrees parameterized Pack repository.
2623
 
 
2624
 
    This repository format uses the xml7 serializer to get:
2625
 
     - support for recording full info about the tree root
2626
 
     - support for recording tree-references
2627
 
 
2628
 
    This format was introduced in 0.92.
2629
 
    """
2630
 
 
2631
 
    repository_class = KnitPackRepository
2632
 
    _commit_builder_class = PackRootCommitBuilder
2633
 
    rich_root_data = True
2634
 
    experimental = True
2635
 
    supports_tree_reference = True
2636
 
    @property
2637
 
    def _serializer(self):
2638
 
        return xml7.serializer_v7
2639
 
    # What index classes to use
2640
 
    index_builder_class = InMemoryGraphIndex
2641
 
    index_class = GraphIndex
2642
 
 
2643
 
    def _get_matching_bzrdir(self):
2644
 
        return bzrdir.format_registry.make_bzrdir(
2645
 
            'pack-0.92-subtree')
2646
 
 
2647
 
    def _ignore_setting_bzrdir(self, format):
2648
 
        pass
2649
 
 
2650
 
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2651
 
 
2652
 
    def get_format_string(self):
2653
 
        """See RepositoryFormat.get_format_string()."""
2654
 
        return "Bazaar pack repository format 1 with subtree support (needs bzr 0.92)\n"
2655
 
 
2656
 
    def get_format_description(self):
2657
 
        """See RepositoryFormat.get_format_description()."""
2658
 
        return "Packs containing knits with subtree support\n"
2659
 
 
2660
 
 
2661
 
class RepositoryFormatKnitPack4(RepositoryFormatPack):
2662
 
    """A rich-root, no subtrees parameterized Pack repository.
2663
 
 
2664
 
    This repository format uses the xml6 serializer to get:
2665
 
     - support for recording full info about the tree root
2666
 
 
2667
 
    This format was introduced in 1.0.
2668
 
    """
2669
 
 
2670
 
    repository_class = KnitPackRepository
2671
 
    _commit_builder_class = PackRootCommitBuilder
2672
 
    rich_root_data = True
2673
 
    supports_tree_reference = False
2674
 
    @property
2675
 
    def _serializer(self):
2676
 
        return xml6.serializer_v6
2677
 
    # What index classes to use
2678
 
    index_builder_class = InMemoryGraphIndex
2679
 
    index_class = GraphIndex
2680
 
 
2681
 
    def _get_matching_bzrdir(self):
2682
 
        return bzrdir.format_registry.make_bzrdir(
2683
 
            'rich-root-pack')
2684
 
 
2685
 
    def _ignore_setting_bzrdir(self, format):
2686
 
        pass
2687
 
 
2688
 
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2689
 
 
2690
 
    def get_format_string(self):
2691
 
        """See RepositoryFormat.get_format_string()."""
2692
 
        return ("Bazaar pack repository format 1 with rich root"
2693
 
                " (needs bzr 1.0)\n")
2694
 
 
2695
 
    def get_format_description(self):
2696
 
        """See RepositoryFormat.get_format_description()."""
2697
 
        return "Packs containing knits with rich root support\n"
2698
 
 
2699
 
 
2700
 
class RepositoryFormatKnitPack5(RepositoryFormatPack):
2701
 
    """Repository that supports external references to allow stacking.
2702
 
 
2703
 
    New in release 1.6.
2704
 
 
2705
 
    Supports external lookups, which results in non-truncated ghosts after
2706
 
    reconcile compared to pack-0.92 formats.
2707
 
    """
2708
 
 
2709
 
    repository_class = KnitPackRepository
2710
 
    _commit_builder_class = PackCommitBuilder
2711
 
    supports_external_lookups = True
2712
 
    # What index classes to use
2713
 
    index_builder_class = InMemoryGraphIndex
2714
 
    index_class = GraphIndex
2715
 
 
2716
 
    @property
2717
 
    def _serializer(self):
2718
 
        return xml5.serializer_v5
2719
 
 
2720
 
    def _get_matching_bzrdir(self):
2721
 
        return bzrdir.format_registry.make_bzrdir('1.6')
2722
 
 
2723
 
    def _ignore_setting_bzrdir(self, format):
2724
 
        pass
2725
 
 
2726
 
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2727
 
 
2728
 
    def get_format_string(self):
2729
 
        """See RepositoryFormat.get_format_string()."""
2730
 
        return "Bazaar RepositoryFormatKnitPack5 (bzr 1.6)\n"
2731
 
 
2732
 
    def get_format_description(self):
2733
 
        """See RepositoryFormat.get_format_description()."""
2734
 
        return "Packs 5 (adds stacking support, requires bzr 1.6)"
2735
 
 
2736
 
 
2737
 
class RepositoryFormatKnitPack5RichRoot(RepositoryFormatPack):
2738
 
    """A repository with rich roots and stacking.
2739
 
 
2740
 
    New in release 1.6.1.
2741
 
 
2742
 
    Supports stacking on other repositories, allowing data to be accessed
2743
 
    without being stored locally.
2744
 
    """
2745
 
 
2746
 
    repository_class = KnitPackRepository
2747
 
    _commit_builder_class = PackRootCommitBuilder
2748
 
    rich_root_data = True
2749
 
    supports_tree_reference = False # no subtrees
2750
 
    supports_external_lookups = True
2751
 
    # What index classes to use
2752
 
    index_builder_class = InMemoryGraphIndex
2753
 
    index_class = GraphIndex
2754
 
 
2755
 
    @property
2756
 
    def _serializer(self):
2757
 
        return xml6.serializer_v6
2758
 
 
2759
 
    def _get_matching_bzrdir(self):
2760
 
        return bzrdir.format_registry.make_bzrdir(
2761
 
            '1.6.1-rich-root')
2762
 
 
2763
 
    def _ignore_setting_bzrdir(self, format):
2764
 
        pass
2765
 
 
2766
 
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2767
 
 
2768
 
    def get_format_string(self):
2769
 
        """See RepositoryFormat.get_format_string()."""
2770
 
        return "Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6.1)\n"
2771
 
 
2772
 
    def get_format_description(self):
2773
 
        return "Packs 5 rich-root (adds stacking support, requires bzr 1.6.1)"
2774
 
 
2775
 
 
2776
 
class RepositoryFormatKnitPack5RichRootBroken(RepositoryFormatPack):
2777
 
    """A repository with rich roots and external references.
2778
 
 
2779
 
    New in release 1.6.
2780
 
 
2781
 
    Supports external lookups, which results in non-truncated ghosts after
2782
 
    reconcile compared to pack-0.92 formats.
2783
 
 
2784
 
    This format was deprecated because the serializer it uses accidentally
2785
 
    supported subtrees, when the format was not intended to. This meant that
2786
 
    someone could accidentally fetch from an incorrect repository.
2787
 
    """
2788
 
 
2789
 
    repository_class = KnitPackRepository
2790
 
    _commit_builder_class = PackRootCommitBuilder
2791
 
    rich_root_data = True
2792
 
    supports_tree_reference = False # no subtrees
2793
 
 
2794
 
    supports_external_lookups = True
2795
 
    # What index classes to use
2796
 
    index_builder_class = InMemoryGraphIndex
2797
 
    index_class = GraphIndex
2798
 
 
2799
 
    @property
2800
 
    def _serializer(self):
2801
 
        return xml7.serializer_v7
2802
 
 
2803
 
    def _get_matching_bzrdir(self):
2804
 
        matching = bzrdir.format_registry.make_bzrdir(
2805
 
            '1.6.1-rich-root')
2806
 
        matching.repository_format = self
2807
 
        return matching
2808
 
 
2809
 
    def _ignore_setting_bzrdir(self, format):
2810
 
        pass
2811
 
 
2812
 
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2813
 
 
2814
 
    def get_format_string(self):
2815
 
        """See RepositoryFormat.get_format_string()."""
2816
 
        return "Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6)\n"
2817
 
 
2818
 
    def get_format_description(self):
2819
 
        return ("Packs 5 rich-root (adds stacking support, requires bzr 1.6)"
2820
 
                " (deprecated)")
2821
 
 
2822
 
 
2823
 
class RepositoryFormatKnitPack6(RepositoryFormatPack):
2824
 
    """A repository with stacking and btree indexes,
2825
 
    without rich roots or subtrees.
2826
 
 
2827
 
    This is equivalent to pack-1.6 with B+Tree indices.
2828
 
    """
2829
 
 
2830
 
    repository_class = KnitPackRepository
2831
 
    _commit_builder_class = PackCommitBuilder
2832
 
    supports_external_lookups = True
2833
 
    # What index classes to use
2834
 
    index_builder_class = btree_index.BTreeBuilder
2835
 
    index_class = btree_index.BTreeGraphIndex
2836
 
 
2837
 
    @property
2838
 
    def _serializer(self):
2839
 
        return xml5.serializer_v5
2840
 
 
2841
 
    def _get_matching_bzrdir(self):
2842
 
        return bzrdir.format_registry.make_bzrdir('1.9')
2843
 
 
2844
 
    def _ignore_setting_bzrdir(self, format):
2845
 
        pass
2846
 
 
2847
 
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2848
 
 
2849
 
    def get_format_string(self):
2850
 
        """See RepositoryFormat.get_format_string()."""
2851
 
        return "Bazaar RepositoryFormatKnitPack6 (bzr 1.9)\n"
2852
 
 
2853
 
    def get_format_description(self):
2854
 
        """See RepositoryFormat.get_format_description()."""
2855
 
        return "Packs 6 (uses btree indexes, requires bzr 1.9)"
2856
 
 
2857
 
 
2858
 
class RepositoryFormatKnitPack6RichRoot(RepositoryFormatPack):
2859
 
    """A repository with rich roots, no subtrees, stacking and btree indexes.
2860
 
 
2861
 
    1.6-rich-root with B+Tree indices.
2862
 
    """
2863
 
 
2864
 
    repository_class = KnitPackRepository
2865
 
    _commit_builder_class = PackRootCommitBuilder
2866
 
    rich_root_data = True
2867
 
    supports_tree_reference = False # no subtrees
2868
 
    supports_external_lookups = True
2869
 
    # What index classes to use
2870
 
    index_builder_class = btree_index.BTreeBuilder
2871
 
    index_class = btree_index.BTreeGraphIndex
2872
 
 
2873
 
    @property
2874
 
    def _serializer(self):
2875
 
        return xml6.serializer_v6
2876
 
 
2877
 
    def _get_matching_bzrdir(self):
2878
 
        return bzrdir.format_registry.make_bzrdir(
2879
 
            '1.9-rich-root')
2880
 
 
2881
 
    def _ignore_setting_bzrdir(self, format):
2882
 
        pass
2883
 
 
2884
 
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2885
 
 
2886
 
    def get_format_string(self):
2887
 
        """See RepositoryFormat.get_format_string()."""
2888
 
        return "Bazaar RepositoryFormatKnitPack6RichRoot (bzr 1.9)\n"
2889
 
 
2890
 
    def get_format_description(self):
2891
 
        return "Packs 6 rich-root (uses btree indexes, requires bzr 1.9)"
2892
 
 
2893
 
 
2894
 
class RepositoryFormatPackDevelopment2Subtree(RepositoryFormatPack):
2895
 
    """A subtrees development repository.
2896
 
 
2897
 
    This format should be retained until the second release after bzr 1.7.
2898
 
 
2899
 
    1.6.1-subtree[as it might have been] with B+Tree indices.
2900
 
 
2901
 
    This is [now] retained until we have a CHK based subtree format in
2902
 
    development.
2903
 
    """
2904
 
 
2905
 
    repository_class = KnitPackRepository
2906
 
    _commit_builder_class = PackRootCommitBuilder
2907
 
    rich_root_data = True
2908
 
    experimental = True
2909
 
    supports_tree_reference = True
2910
 
    supports_external_lookups = True
2911
 
    # What index classes to use
2912
 
    index_builder_class = btree_index.BTreeBuilder
2913
 
    index_class = btree_index.BTreeGraphIndex
2914
 
 
2915
 
    @property
2916
 
    def _serializer(self):
2917
 
        return xml7.serializer_v7
2918
 
 
2919
 
    def _get_matching_bzrdir(self):
2920
 
        return bzrdir.format_registry.make_bzrdir(
2921
 
            'development-subtree')
2922
 
 
2923
 
    def _ignore_setting_bzrdir(self, format):
2924
 
        pass
2925
 
 
2926
 
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2927
 
 
2928
 
    def get_format_string(self):
2929
 
        """See RepositoryFormat.get_format_string()."""
2930
 
        return ("Bazaar development format 2 with subtree support "
2931
 
            "(needs bzr.dev from before 1.8)\n")
2932
 
 
2933
 
    def get_format_description(self):
2934
 
        """See RepositoryFormat.get_format_description()."""
2935
 
        return ("Development repository format, currently the same as "
2936
 
            "1.6.1-subtree with B+Tree indices.\n")
 
1913
class RetryPackOperations(errors.RetryWithNewPacks):
 
1914
    """Raised when we are packing and we find a missing file.
 
1915
 
 
1916
    Meant as a signaling exception, to tell the RepositoryPackCollection.pack
 
1917
    code it should try again.
 
1918
    """
 
1919
 
 
1920
    internal_error = True
 
1921
 
 
1922
    _fmt = ("Pack files have changed, reload and try pack again."
 
1923
            " context: %(context)s %(orig_error)s")
 
1924
 
 
1925
 
 
1926
class _DirectPackAccess(object):
 
1927
    """Access to data in one or more packs with less translation."""
 
1928
 
 
1929
    def __init__(self, index_to_packs, reload_func=None, flush_func=None):
 
1930
        """Create a _DirectPackAccess object.
 
1931
 
 
1932
        :param index_to_packs: A dict mapping index objects to the transport
 
1933
            and file names for obtaining data.
 
1934
        :param reload_func: A function to call if we determine that the pack
 
1935
            files have moved and we need to reload our caches. See
 
1936
            bzrlib.repo_fmt.pack_repo.AggregateIndex for more details.
 
1937
        """
 
1938
        self._container_writer = None
 
1939
        self._write_index = None
 
1940
        self._indices = index_to_packs
 
1941
        self._reload_func = reload_func
 
1942
        self._flush_func = flush_func
 
1943
 
 
1944
    def add_raw_records(self, key_sizes, raw_data):
 
1945
        """Add raw knit bytes to a storage area.
 
1946
 
 
1947
        The data is spooled to the container writer in one bytes-record per
 
1948
        raw data item.
 
1949
 
 
1950
        :param sizes: An iterable of tuples containing the key and size of each
 
1951
            raw data segment.
 
1952
        :param raw_data: A bytestring containing the data.
 
1953
        :return: A list of memos to retrieve the record later. Each memo is an
 
1954
            opaque index memo. For _DirectPackAccess the memo is (index, pos,
 
1955
            length), where the index field is the write_index object supplied
 
1956
            to the PackAccess object.
 
1957
        """
 
1958
        if type(raw_data) is not str:
 
1959
            raise AssertionError(
 
1960
                'data must be plain bytes was %s' % type(raw_data))
 
1961
        result = []
 
1962
        offset = 0
 
1963
        for key, size in key_sizes:
 
1964
            p_offset, p_length = self._container_writer.add_bytes_record(
 
1965
                raw_data[offset:offset+size], [])
 
1966
            offset += size
 
1967
            result.append((self._write_index, p_offset, p_length))
 
1968
        return result
 
1969
 
 
1970
    def flush(self):
 
1971
        """Flush pending writes on this access object.
 
1972
 
 
1973
        This will flush any buffered writes to a NewPack.
 
1974
        """
 
1975
        if self._flush_func is not None:
 
1976
            self._flush_func()
 
1977
 
 
1978
    def get_raw_records(self, memos_for_retrieval):
 
1979
        """Get the raw bytes for a records.
 
1980
 
 
1981
        :param memos_for_retrieval: An iterable containing the (index, pos,
 
1982
            length) memo for retrieving the bytes. The Pack access method
 
1983
            looks up the pack to use for a given record in its index_to_pack
 
1984
            map.
 
1985
        :return: An iterator over the bytes of the records.
 
1986
        """
 
1987
        # first pass, group into same-index requests
 
1988
        request_lists = []
 
1989
        current_index = None
 
1990
        for (index, offset, length) in memos_for_retrieval:
 
1991
            if current_index == index:
 
1992
                current_list.append((offset, length))
 
1993
            else:
 
1994
                if current_index is not None:
 
1995
                    request_lists.append((current_index, current_list))
 
1996
                current_index = index
 
1997
                current_list = [(offset, length)]
 
1998
        # handle the last entry
 
1999
        if current_index is not None:
 
2000
            request_lists.append((current_index, current_list))
 
2001
        for index, offsets in request_lists:
 
2002
            try:
 
2003
                transport, path = self._indices[index]
 
2004
            except KeyError:
 
2005
                # A KeyError here indicates that someone has triggered an index
 
2006
                # reload, and this index has gone missing, we need to start
 
2007
                # over.
 
2008
                if self._reload_func is None:
 
2009
                    # If we don't have a _reload_func there is nothing that can
 
2010
                    # be done
 
2011
                    raise
 
2012
                raise errors.RetryWithNewPacks(index,
 
2013
                                               reload_occurred=True,
 
2014
                                               exc_info=sys.exc_info())
 
2015
            try:
 
2016
                reader = pack.make_readv_reader(transport, path, offsets)
 
2017
                for names, read_func in reader.iter_records():
 
2018
                    yield read_func(None)
 
2019
            except errors.NoSuchFile:
 
2020
                # A NoSuchFile error indicates that a pack file has gone
 
2021
                # missing on disk, we need to trigger a reload, and start over.
 
2022
                if self._reload_func is None:
 
2023
                    raise
 
2024
                raise errors.RetryWithNewPacks(transport.abspath(path),
 
2025
                                               reload_occurred=False,
 
2026
                                               exc_info=sys.exc_info())
 
2027
 
 
2028
    def set_writer(self, writer, index, transport_packname):
 
2029
        """Set a writer to use for adding data."""
 
2030
        if index is not None:
 
2031
            self._indices[index] = transport_packname
 
2032
        self._container_writer = writer
 
2033
        self._write_index = index
 
2034
 
 
2035
    def reload_or_raise(self, retry_exc):
 
2036
        """Try calling the reload function, or re-raise the original exception.
 
2037
 
 
2038
        This should be called after _DirectPackAccess raises a
 
2039
        RetryWithNewPacks exception. This function will handle the common logic
 
2040
        of determining when the error is fatal versus being temporary.
 
2041
        It will also make sure that the original exception is raised, rather
 
2042
        than the RetryWithNewPacks exception.
 
2043
 
 
2044
        If this function returns, then the calling function should retry
 
2045
        whatever operation was being performed. Otherwise an exception will
 
2046
        be raised.
 
2047
 
 
2048
        :param retry_exc: A RetryWithNewPacks exception.
 
2049
        """
 
2050
        is_error = False
 
2051
        if self._reload_func is None:
 
2052
            is_error = True
 
2053
        elif not self._reload_func():
 
2054
            # The reload claimed that nothing changed
 
2055
            if not retry_exc.reload_occurred:
 
2056
                # If there wasn't an earlier reload, then we really were
 
2057
                # expecting to find changes. We didn't find them, so this is a
 
2058
                # hard error
 
2059
                is_error = True
 
2060
        if is_error:
 
2061
            exc_class, exc_value, exc_traceback = retry_exc.exc_info
 
2062
            raise exc_class, exc_value, exc_traceback
 
2063
 
 
2064
 
2937
2065