~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repofmt/pack_repo.py

  • Committer: Martin Pool
  • Date: 2010-02-25 06:17:27 UTC
  • mfrom: (5055 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5057.
  • Revision ID: mbp@sourcefrog.net-20100225061727-4sd9lt0qmdc6087t
merge news

Show diffs side-by-side

added added

removed removed

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