~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repofmt/pack_repo.py

(gz) Change minimum required testtools version for selftest to 0.9.5 for
 unicode fixes (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
30
30
    osutils,
31
31
    pack,
32
32
    transactions,
33
 
    tsort,
34
33
    ui,
 
34
    xml5,
 
35
    xml6,
 
36
    xml7,
35
37
    )
36
38
from bzrlib.index import (
37
39
    CombinedGraphIndex,
38
40
    GraphIndexPrefixAdapter,
39
41
    )
 
42
from bzrlib.knit import (
 
43
    KnitPlainFactory,
 
44
    KnitVersionedFiles,
 
45
    _KnitGraphIndex,
 
46
    _DirectPackAccess,
 
47
    )
 
48
from bzrlib import tsort
40
49
""")
41
50
from bzrlib import (
 
51
    bzrdir,
42
52
    btree_index,
43
53
    errors,
44
54
    lockable_files,
45
55
    lockdir,
 
56
    revision as _mod_revision,
46
57
    )
47
58
 
48
 
from bzrlib.decorators import (
49
 
    needs_read_lock,
50
 
    needs_write_lock,
51
 
    only_raises,
 
59
from bzrlib.decorators import needs_write_lock, only_raises
 
60
from bzrlib.index import (
 
61
    GraphIndex,
 
62
    InMemoryGraphIndex,
52
63
    )
53
64
from bzrlib.lock import LogicalLockResult
 
65
from bzrlib.repofmt.knitrepo import KnitRepository
54
66
from bzrlib.repository import (
55
67
    CommitBuilder,
56
 
    MetaDirRepository,
57
68
    MetaDirRepositoryFormat,
58
69
    RepositoryFormat,
59
70
    RepositoryWriteLockResult,
60
71
    RootCommitBuilder,
 
72
    StreamSource,
61
73
    )
62
74
from bzrlib.trace import (
63
75
    mutter,
75
87
 
76
88
    def __init__(self, repository, parents, config, timestamp=None,
77
89
                 timezone=None, committer=None, revprops=None,
78
 
                 revision_id=None, lossy=False):
 
90
                 revision_id=None):
79
91
        CommitBuilder.__init__(self, repository, parents, config,
80
92
            timestamp=timestamp, timezone=timezone, committer=committer,
81
 
            revprops=revprops, revision_id=revision_id, lossy=lossy)
 
93
            revprops=revprops, revision_id=revision_id)
82
94
        self._file_graph = graph.Graph(
83
95
            repository._pack_collection.text_index.combined_index)
84
96
 
96
108
 
97
109
    def __init__(self, repository, parents, config, timestamp=None,
98
110
                 timezone=None, committer=None, revprops=None,
99
 
                 revision_id=None, lossy=False):
 
111
                 revision_id=None):
100
112
        CommitBuilder.__init__(self, repository, parents, config,
101
113
            timestamp=timestamp, timezone=timezone, committer=committer,
102
 
            revprops=revprops, revision_id=revision_id, lossy=lossy)
 
114
            revprops=revprops, revision_id=revision_id)
103
115
        self._file_graph = graph.Graph(
104
116
            repository._pack_collection.text_index.combined_index)
105
117
 
661
673
        # What text keys to copy. None for 'all texts'. This is set by
662
674
        # _copy_inventory_texts
663
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)
664
709
 
665
710
    def pack(self, pb=None):
666
711
        """Create a new pack by reading data from other packs.
715
760
        new_pack.signature_index.set_optimize(combine_backing_indices=False)
716
761
        return new_pack
717
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
 
718
797
    def _copy_revision_texts(self):
719
798
        """Copy revision data to the new pack."""
720
 
        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
721
822
 
722
823
    def _copy_inventory_texts(self):
723
824
        """Copy the inventory texts to the new pack.
726
827
 
727
828
        Sets self._text_filter appropriately.
728
829
        """
729
 
        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)
730
860
 
731
861
    def _copy_text_texts(self):
732
 
        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()
733
887
 
734
888
    def _create_pack_from_packs(self):
735
 
        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
736
1131
 
737
1132
    def _log_copied_texts(self):
738
1133
        if 'pack' in debug.debug_flags:
742
1137
                self.new_pack.text_index.key_count(),
743
1138
                time.time() - self.new_pack.start_time)
744
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
 
745
1159
    def _use_pack(self, new_pack):
746
1160
        """Return True if new_pack should be used.
747
1161
 
751
1165
        return new_pack.data_inserted()
752
1166
 
753
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._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 its 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
 
754
1354
class RepositoryPackCollection(object):
755
1355
    """Management of packs within a repository.
756
1356
 
757
1357
    :ivar _names: map of {pack_name: (index_size,)}
758
1358
    """
759
1359
 
760
 
    pack_factory = None
761
 
    resumed_pack_factory = None
762
 
    normal_packer_class = None
763
 
    optimising_packer_class = None
 
1360
    pack_factory = NewPack
 
1361
    resumed_pack_factory = ResumedPack
764
1362
 
765
1363
    def __init__(self, repo, transport, index_transport, upload_transport,
766
1364
                 pack_transport, index_builder_class, index_class,
907
1505
            'containing %d revisions. Packing %d files into %d affecting %d'
908
1506
            ' revisions', self, total_packs, total_revisions, num_old_packs,
909
1507
            num_new_packs, num_revs_affected)
910
 
        result = self._execute_pack_operations(pack_operations, packer_class=self.normal_packer_class,
 
1508
        result = self._execute_pack_operations(pack_operations,
911
1509
                                      reload_func=self._restart_autopack)
912
1510
        mutter('Auto-packing repository %s completed', self)
913
1511
        return result
914
1512
 
915
 
    def _execute_pack_operations(self, pack_operations, packer_class,
916
 
            reload_func=None):
 
1513
    def _execute_pack_operations(self, pack_operations, _packer_class=Packer,
 
1514
                                 reload_func=None):
917
1515
        """Execute a series of pack operations.
918
1516
 
919
1517
        :param pack_operations: A list of [revision_count, packs_to_combine].
920
 
        :param packer_class: The class of packer to use
 
1518
        :param _packer_class: The class of packer to use (default: Packer).
921
1519
        :return: The new pack names.
922
1520
        """
923
1521
        for revision_count, packs in pack_operations:
924
1522
            # we may have no-ops from the setup logic
925
1523
            if len(packs) == 0:
926
1524
                continue
927
 
            packer = packer_class(self, packs, '.autopack',
 
1525
            packer = _packer_class(self, packs, '.autopack',
928
1526
                                   reload_func=reload_func)
929
1527
            try:
930
 
                result = packer.pack()
 
1528
                packer.pack()
931
1529
            except errors.RetryWithNewPacks:
932
1530
                # An exception is propagating out of this context, make sure
933
1531
                # this packer has cleaned up. Packer() doesn't set its new_pack
936
1534
                if packer.new_pack is not None:
937
1535
                    packer.new_pack.abort()
938
1536
                raise
939
 
            if result is None:
940
 
                return
941
1537
            for pack in packs:
942
1538
                self._remove_pack_from_memory(pack)
943
1539
        # record the newly available packs and stop advertising the old
977
1573
        mutter('Packing repository %s, which has %d pack files, '
978
1574
            'containing %d revisions with hint %r.', self, total_packs,
979
1575
            total_revisions, hint)
980
 
        while True:
981
 
            try:
982
 
                self._try_pack_operations(hint)
983
 
            except RetryPackOperations:
984
 
                continue
985
 
            break
986
 
 
987
 
        if clean_obsolete_packs:
988
 
            self._clear_obsolete_packs()
989
 
 
990
 
    def _try_pack_operations(self, hint):
991
 
        """Calculate the pack operations based on the hint (if any), and
992
 
        execute them.
993
 
        """
994
1576
        # determine which packs need changing
995
1577
        pack_operations = [[0, []]]
996
1578
        for pack in self.all_packs():
999
1581
                # or this pack was included in the hint.
1000
1582
                pack_operations[-1][0] += pack.get_revision_count()
1001
1583
                pack_operations[-1][1].append(pack)
1002
 
        self._execute_pack_operations(pack_operations,
1003
 
            packer_class=self.optimising_packer_class,
1004
 
            reload_func=self._restart_pack_operations)
 
1584
        self._execute_pack_operations(pack_operations, OptimisingPacker)
 
1585
 
 
1586
        if clean_obsolete_packs:
 
1587
            self._clear_obsolete_packs()
1005
1588
 
1006
1589
    def plan_autopack_combinations(self, existing_packs, pack_distribution):
1007
1590
        """Plan a pack operation.
1461
2044
            raise
1462
2045
        raise errors.RetryAutopack(self.repo, False, sys.exc_info())
1463
2046
 
1464
 
    def _restart_pack_operations(self):
1465
 
        """Reload the pack names list, and restart the autopack code."""
1466
 
        if not self.reload_pack_names():
1467
 
            # Re-raise the original exception, because something went missing
1468
 
            # and a restart didn't find it
1469
 
            raise
1470
 
        raise RetryPackOperations(self.repo, False, sys.exc_info())
1471
 
 
1472
2047
    def _clear_obsolete_packs(self, preserve=None):
1473
2048
        """Delete everything from the obsolete-packs directory.
1474
2049
 
1622
2197
            self._resume_pack(token)
1623
2198
 
1624
2199
 
1625
 
class PackRepository(MetaDirRepository):
 
2200
class KnitPackRepository(KnitRepository):
1626
2201
    """Repository with knit objects stored inside pack containers.
1627
2202
 
1628
2203
    The layering for a KnitPackRepository is:
1631
2206
    ===================================================
1632
2207
    Tuple based apis below, string based, and key based apis above
1633
2208
    ---------------------------------------------------
1634
 
    VersionedFiles
 
2209
    KnitVersionedFiles
1635
2210
      Provides .texts, .revisions etc
1636
2211
      This adapts the N-tuple keys to physical knit records which only have a
1637
2212
      single string identifier (for historical reasons), which in older formats
1647
2222
 
1648
2223
    """
1649
2224
 
1650
 
    # These attributes are inherited from the Repository base class. Setting
1651
 
    # them to None ensures that if the constructor is changed to not initialize
1652
 
    # them, or a subclass fails to call the constructor, that an error will
1653
 
    # occur rather than the system working but generating incorrect data.
1654
 
    _commit_builder_class = None
1655
 
    _serializer = None
1656
 
 
1657
2225
    def __init__(self, _format, a_bzrdir, control_files, _commit_builder_class,
1658
2226
        _serializer):
1659
 
        MetaDirRepository.__init__(self, _format, a_bzrdir, control_files)
1660
 
        self._commit_builder_class = _commit_builder_class
1661
 
        self._serializer = _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
1662
2284
        self._reconcile_fixes_text_parents = True
 
2285
        self._reconcile_backsup_inventory = False
1663
2286
 
1664
 
    @needs_read_lock
1665
 
    def _all_revision_ids(self):
1666
 
        """See Repository.all_revision_ids()."""
1667
 
        return [key[0] for key in self.revisions.keys()]
 
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)
1668
2291
 
1669
2292
    def _abort_write_group(self):
1670
2293
        self.revisions._index._key_dependencies.clear()
1671
2294
        self._pack_collection._abort_write_group()
1672
2295
 
 
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
 
1673
2301
    def _make_parents_provider(self):
1674
2302
        return graph.CachingParentsProvider(self)
1675
2303
 
1781
2409
        return reconciler
1782
2410
 
1783
2411
    def _reconcile_pack(self, collection, packs, extension, revs, pb):
1784
 
        raise NotImplementedError(self._reconcile_pack)
 
2412
        packer = ReconcilePacker(collection, packs, extension, revs)
 
2413
        return packer.pack(pb)
1785
2414
 
1786
2415
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1787
2416
    def unlock(self):
1806
2435
                repo.unlock()
1807
2436
 
1808
2437
 
 
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
 
1809
2511
class RepositoryFormatPack(MetaDirRepositoryFormat):
1810
2512
    """Format logic for pack structured repositories.
1811
2513
 
1842
2544
    index_class = None
1843
2545
    _fetch_uses_deltas = True
1844
2546
    fast_deltas = False
1845
 
    supports_full_versioned_files = True
1846
 
    supports_funky_characters = True
1847
 
    revision_graph_can_have_wrong_parents = True
1848
2547
 
1849
2548
    def initialize(self, a_bzrdir, shared=False):
1850
2549
        """Create a pack based repository.
1887
2586
                              _serializer=self._serializer)
1888
2587
 
1889
2588
 
1890
 
class RetryPackOperations(errors.RetryWithNewPacks):
1891
 
    """Raised when we are packing and we find a missing file.
1892
 
 
1893
 
    Meant as a signaling exception, to tell the RepositoryPackCollection.pack
1894
 
    code it should try again.
1895
 
    """
1896
 
 
1897
 
    internal_error = True
1898
 
 
1899
 
    _fmt = ("Pack files have changed, reload and try pack again."
1900
 
            " context: %(context)s %(orig_error)s")
1901
 
 
1902
 
 
1903
 
class _DirectPackAccess(object):
1904
 
    """Access to data in one or more packs with less translation."""
1905
 
 
1906
 
    def __init__(self, index_to_packs, reload_func=None, flush_func=None):
1907
 
        """Create a _DirectPackAccess object.
1908
 
 
1909
 
        :param index_to_packs: A dict mapping index objects to the transport
1910
 
            and file names for obtaining data.
1911
 
        :param reload_func: A function to call if we determine that the pack
1912
 
            files have moved and we need to reload our caches. See
1913
 
            bzrlib.repo_fmt.pack_repo.AggregateIndex for more details.
1914
 
        """
1915
 
        self._container_writer = None
1916
 
        self._write_index = None
1917
 
        self._indices = index_to_packs
1918
 
        self._reload_func = reload_func
1919
 
        self._flush_func = flush_func
1920
 
 
1921
 
    def add_raw_records(self, key_sizes, raw_data):
1922
 
        """Add raw knit bytes to a storage area.
1923
 
 
1924
 
        The data is spooled to the container writer in one bytes-record per
1925
 
        raw data item.
1926
 
 
1927
 
        :param sizes: An iterable of tuples containing the key and size of each
1928
 
            raw data segment.
1929
 
        :param raw_data: A bytestring containing the data.
1930
 
        :return: A list of memos to retrieve the record later. Each memo is an
1931
 
            opaque index memo. For _DirectPackAccess the memo is (index, pos,
1932
 
            length), where the index field is the write_index object supplied
1933
 
            to the PackAccess object.
1934
 
        """
1935
 
        if type(raw_data) is not str:
1936
 
            raise AssertionError(
1937
 
                'data must be plain bytes was %s' % type(raw_data))
1938
 
        result = []
1939
 
        offset = 0
1940
 
        for key, size in key_sizes:
1941
 
            p_offset, p_length = self._container_writer.add_bytes_record(
1942
 
                raw_data[offset:offset+size], [])
1943
 
            offset += size
1944
 
            result.append((self._write_index, p_offset, p_length))
1945
 
        return result
1946
 
 
1947
 
    def flush(self):
1948
 
        """Flush pending writes on this access object.
1949
 
 
1950
 
        This will flush any buffered writes to a NewPack.
1951
 
        """
1952
 
        if self._flush_func is not None:
1953
 
            self._flush_func()
1954
 
 
1955
 
    def get_raw_records(self, memos_for_retrieval):
1956
 
        """Get the raw bytes for a records.
1957
 
 
1958
 
        :param memos_for_retrieval: An iterable containing the (index, pos,
1959
 
            length) memo for retrieving the bytes. The Pack access method
1960
 
            looks up the pack to use for a given record in its index_to_pack
1961
 
            map.
1962
 
        :return: An iterator over the bytes of the records.
1963
 
        """
1964
 
        # first pass, group into same-index requests
1965
 
        request_lists = []
1966
 
        current_index = None
1967
 
        for (index, offset, length) in memos_for_retrieval:
1968
 
            if current_index == index:
1969
 
                current_list.append((offset, length))
1970
 
            else:
1971
 
                if current_index is not None:
1972
 
                    request_lists.append((current_index, current_list))
1973
 
                current_index = index
1974
 
                current_list = [(offset, length)]
1975
 
        # handle the last entry
1976
 
        if current_index is not None:
1977
 
            request_lists.append((current_index, current_list))
1978
 
        for index, offsets in request_lists:
1979
 
            try:
1980
 
                transport, path = self._indices[index]
1981
 
            except KeyError:
1982
 
                # A KeyError here indicates that someone has triggered an index
1983
 
                # reload, and this index has gone missing, we need to start
1984
 
                # over.
1985
 
                if self._reload_func is None:
1986
 
                    # If we don't have a _reload_func there is nothing that can
1987
 
                    # be done
1988
 
                    raise
1989
 
                raise errors.RetryWithNewPacks(index,
1990
 
                                               reload_occurred=True,
1991
 
                                               exc_info=sys.exc_info())
1992
 
            try:
1993
 
                reader = pack.make_readv_reader(transport, path, offsets)
1994
 
                for names, read_func in reader.iter_records():
1995
 
                    yield read_func(None)
1996
 
            except errors.NoSuchFile:
1997
 
                # A NoSuchFile error indicates that a pack file has gone
1998
 
                # missing on disk, we need to trigger a reload, and start over.
1999
 
                if self._reload_func is None:
2000
 
                    raise
2001
 
                raise errors.RetryWithNewPacks(transport.abspath(path),
2002
 
                                               reload_occurred=False,
2003
 
                                               exc_info=sys.exc_info())
2004
 
 
2005
 
    def set_writer(self, writer, index, transport_packname):
2006
 
        """Set a writer to use for adding data."""
2007
 
        if index is not None:
2008
 
            self._indices[index] = transport_packname
2009
 
        self._container_writer = writer
2010
 
        self._write_index = index
2011
 
 
2012
 
    def reload_or_raise(self, retry_exc):
2013
 
        """Try calling the reload function, or re-raise the original exception.
2014
 
 
2015
 
        This should be called after _DirectPackAccess raises a
2016
 
        RetryWithNewPacks exception. This function will handle the common logic
2017
 
        of determining when the error is fatal versus being temporary.
2018
 
        It will also make sure that the original exception is raised, rather
2019
 
        than the RetryWithNewPacks exception.
2020
 
 
2021
 
        If this function returns, then the calling function should retry
2022
 
        whatever operation was being performed. Otherwise an exception will
2023
 
        be raised.
2024
 
 
2025
 
        :param retry_exc: A RetryWithNewPacks exception.
2026
 
        """
2027
 
        is_error = False
2028
 
        if self._reload_func is None:
2029
 
            is_error = True
2030
 
        elif not self._reload_func():
2031
 
            # The reload claimed that nothing changed
2032
 
            if not retry_exc.reload_occurred:
2033
 
                # If there wasn't an earlier reload, then we really were
2034
 
                # expecting to find changes. We didn't find them, so this is a
2035
 
                # hard error
2036
 
                is_error = True
2037
 
        if is_error:
2038
 
            exc_class, exc_value, exc_traceback = retry_exc.exc_info
2039
 
            raise exc_class, exc_value, exc_traceback
2040
 
 
2041
 
 
 
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 in 2.3, to provide an upgrade path from this
 
2898
    to RepositoryFormat2aSubtree.  It can be removed in later releases.
 
2899
 
 
2900
    1.6.1-subtree[as it might have been] with B+Tree indices.
 
2901
    """
 
2902
 
 
2903
    repository_class = KnitPackRepository
 
2904
    _commit_builder_class = PackRootCommitBuilder
 
2905
    rich_root_data = True
 
2906
    experimental = True
 
2907
    supports_tree_reference = True
 
2908
    supports_external_lookups = True
 
2909
    # What index classes to use
 
2910
    index_builder_class = btree_index.BTreeBuilder
 
2911
    index_class = btree_index.BTreeGraphIndex
 
2912
 
 
2913
    @property
 
2914
    def _serializer(self):
 
2915
        return xml7.serializer_v7
 
2916
 
 
2917
    def _get_matching_bzrdir(self):
 
2918
        return bzrdir.format_registry.make_bzrdir(
 
2919
            'development5-subtree')
 
2920
 
 
2921
    def _ignore_setting_bzrdir(self, format):
 
2922
        pass
 
2923
 
 
2924
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
 
2925
 
 
2926
    def get_format_string(self):
 
2927
        """See RepositoryFormat.get_format_string()."""
 
2928
        return ("Bazaar development format 2 with subtree support "
 
2929
            "(needs bzr.dev from before 1.8)\n")
 
2930
 
 
2931
    def get_format_description(self):
 
2932
        """See RepositoryFormat.get_format_description()."""
 
2933
        return ("Development repository format, currently the same as "
 
2934
            "1.6.1-subtree with B+Tree indices.\n")
2042
2935