~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repofmt/pack_repo.py

  • Committer: Launchpad Translations on behalf of bzr-core
  • Date: 2012-02-22 06:50:36 UTC
  • mto: (6437.35.1 2.5.0-dev)
  • mto: This revision was merged to the branch mainline in revision 6475.
  • Revision ID: launchpad_translations_on_behalf_of_bzr-core-20120222065036-ssi1nphovuqv8ou2
Launchpad automatic translations update.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2007-2010 Canonical Ltd
 
1
# Copyright (C) 2007-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
 
17
from __future__ import absolute_import
 
18
 
17
19
import re
18
20
import sys
19
21
 
25
27
from bzrlib import (
26
28
    chk_map,
27
29
    cleanup,
 
30
    config,
28
31
    debug,
29
32
    graph,
30
33
    osutils,
31
34
    pack,
32
35
    transactions,
 
36
    tsort,
33
37
    ui,
34
 
    xml5,
35
 
    xml6,
36
 
    xml7,
37
38
    )
38
39
from bzrlib.index import (
39
40
    CombinedGraphIndex,
40
41
    GraphIndexPrefixAdapter,
41
42
    )
42
 
from bzrlib.knit import (
43
 
    KnitPlainFactory,
44
 
    KnitVersionedFiles,
45
 
    _KnitGraphIndex,
46
 
    _DirectPackAccess,
47
 
    )
48
 
from bzrlib import tsort
49
43
""")
50
44
from bzrlib import (
51
 
    bzrdir,
 
45
    btree_index,
52
46
    errors,
53
47
    lockable_files,
54
48
    lockdir,
55
 
    revision as _mod_revision,
56
49
    )
57
50
 
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
 
51
from bzrlib.decorators import (
 
52
    needs_read_lock,
 
53
    needs_write_lock,
 
54
    only_raises,
 
55
    )
 
56
from bzrlib.lock import LogicalLockResult
68
57
from bzrlib.repository import (
69
 
    CommitBuilder,
70
 
    MetaDirRepositoryFormat,
71
 
    RepositoryFormat,
72
 
    RootCommitBuilder,
73
 
    StreamSource,
 
58
    _LazyListJoin,
 
59
    MetaDirRepository,
 
60
    RepositoryFormatMetaDir,
 
61
    RepositoryWriteLockResult,
 
62
    )
 
63
from bzrlib.vf_repository import (
 
64
    MetaDirVersionedFileRepository,
 
65
    MetaDirVersionedFileRepositoryFormat,
 
66
    VersionedFileCommitBuilder,
 
67
    VersionedFileRootCommitBuilder,
74
68
    )
75
69
from bzrlib.trace import (
76
70
    mutter,
79
73
    )
80
74
 
81
75
 
82
 
class PackCommitBuilder(CommitBuilder):
83
 
    """A subclass of CommitBuilder to add texts with pack semantics.
 
76
class PackCommitBuilder(VersionedFileCommitBuilder):
 
77
    """Subclass of VersionedFileCommitBuilder to add texts with pack semantics.
84
78
 
85
79
    Specifically this uses one knit object rather than one knit object per
86
80
    added text, reducing memory and object pressure.
88
82
 
89
83
    def __init__(self, repository, parents, config, timestamp=None,
90
84
                 timezone=None, committer=None, revprops=None,
91
 
                 revision_id=None):
92
 
        CommitBuilder.__init__(self, repository, parents, config,
 
85
                 revision_id=None, lossy=False):
 
86
        VersionedFileCommitBuilder.__init__(self, repository, parents, config,
93
87
            timestamp=timestamp, timezone=timezone, committer=committer,
94
 
            revprops=revprops, revision_id=revision_id)
 
88
            revprops=revprops, revision_id=revision_id, lossy=lossy)
95
89
        self._file_graph = graph.Graph(
96
90
            repository._pack_collection.text_index.combined_index)
97
91
 
100
94
        return set([key[1] for key in self._file_graph.heads(keys)])
101
95
 
102
96
 
103
 
class PackRootCommitBuilder(RootCommitBuilder):
 
97
class PackRootCommitBuilder(VersionedFileRootCommitBuilder):
104
98
    """A subclass of RootCommitBuilder to add texts with pack semantics.
105
99
 
106
100
    Specifically this uses one knit object rather than one knit object per
109
103
 
110
104
    def __init__(self, repository, parents, config, timestamp=None,
111
105
                 timezone=None, committer=None, revprops=None,
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)
 
106
                 revision_id=None, lossy=False):
 
107
        super(PackRootCommitBuilder, self).__init__(repository, parents,
 
108
            config, timestamp=timestamp, timezone=timezone,
 
109
            committer=committer, revprops=revprops, revision_id=revision_id,
 
110
            lossy=lossy)
116
111
        self._file_graph = graph.Graph(
117
112
            repository._pack_collection.text_index.combined_index)
118
113
 
229
224
        unlimited_cache = False
230
225
        if index_type == 'chk':
231
226
            unlimited_cache = True
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))
 
227
        index = self.index_class(self.index_transport,
 
228
                    self.index_name(index_type, self.name),
 
229
                    self.index_sizes[self.index_offset(index_type)],
 
230
                    unlimited_cache=unlimited_cache)
 
231
        if index_type == 'chk':
 
232
            index._leaf_factory = btree_index._gcchk_factory
 
233
        setattr(self, index_type + '_index', index)
237
234
 
238
235
 
239
236
class ExistingPack(Pack):
320
317
        for index_type in index_types:
321
318
            old_name = self.index_name(index_type, self.name)
322
319
            new_name = '../indices/' + old_name
323
 
            self.upload_transport.rename(old_name, new_name)
 
320
            self.upload_transport.move(old_name, new_name)
324
321
            self._replace_index_with_readonly(index_type)
325
322
        new_name = '../packs/' + self.file_name()
326
 
        self.upload_transport.rename(self.file_name(), new_name)
 
323
        self.upload_transport.move(self.file_name(), new_name)
327
324
        self._state = 'finished'
328
325
 
329
326
    def _get_external_refs(self, index):
484
481
        # visible is smaller.  On the other hand none will be seen until
485
482
        # they're in the names list.
486
483
        self.index_sizes = [None, None, None, None]
487
 
        self._write_index('revision', self.revision_index, 'revision', suspend)
 
484
        self._write_index('revision', self.revision_index, 'revision',
 
485
            suspend)
488
486
        self._write_index('inventory', self.inventory_index, 'inventory',
489
487
            suspend)
490
488
        self._write_index('text', self.text_index, 'file texts', suspend)
494
492
            self.index_sizes.append(None)
495
493
            self._write_index('chk', self.chk_index,
496
494
                'content hash bytes', suspend)
497
 
        self.write_stream.close()
 
495
        self.write_stream.close(
 
496
            want_fdatasync=self._pack_collection.config_stack.get('repository.fdatasync'))
498
497
        # Note that this will clobber an existing pack with the same name,
499
498
        # without checking for hash collisions. While this is undesirable this
500
499
        # is something that can be rectified in a subsequent release. One way
509
508
        new_name = self.name + '.pack'
510
509
        if not suspend:
511
510
            new_name = '../packs/' + new_name
512
 
        self.upload_transport.rename(self.random_name, new_name)
 
511
        self.upload_transport.move(self.random_name, new_name)
513
512
        self._state = 'finished'
514
513
        if 'pack' in debug.debug_flags:
515
514
            # XXX: size might be interesting?
543
542
            transport = self.upload_transport
544
543
        else:
545
544
            transport = self.index_transport
546
 
        self.index_sizes[self.index_offset(index_type)] = transport.put_file(
547
 
            index_name, index.finish(), mode=self._file_mode)
 
545
        index_tempfile = index.finish()
 
546
        index_bytes = index_tempfile.read()
 
547
        write_stream = transport.open_write_stream(index_name,
 
548
            mode=self._file_mode)
 
549
        write_stream.write(index_bytes)
 
550
        write_stream.close(
 
551
            want_fdatasync=self._pack_collection.config_stack.get('repository.fdatasync'))
 
552
        self.index_sizes[self.index_offset(index_type)] = len(index_bytes)
548
553
        if 'pack' in debug.debug_flags:
549
554
            # XXX: size might be interesting?
550
555
            mutter('%s: create_pack: wrote %s index: %s%s t+%6.3fs',
587
592
                                             flush_func=flush_func)
588
593
        self.add_callback = None
589
594
 
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
 
 
610
595
    def add_index(self, index, pack):
611
596
        """Add index to the aggregate, which is an index for Pack pack.
612
597
 
619
604
        # expose it to the index map
620
605
        self.index_to_pack[index] = pack.access_tuple()
621
606
        # put it at the front of the linear index list
622
 
        self.combined_index.insert_index(0, index)
 
607
        self.combined_index.insert_index(0, index, pack.name)
623
608
 
624
609
    def add_writable_index(self, index, pack):
625
610
        """Add an index which is able to have data added to it.
645
630
        self.data_access.set_writer(None, None, (None, None))
646
631
        self.index_to_pack.clear()
647
632
        del self.combined_index._indices[:]
 
633
        del self.combined_index._index_names[:]
648
634
        self.add_callback = None
649
635
 
650
636
    def remove_index(self, index):
653
639
        :param index: An index from the pack parameter.
654
640
        """
655
641
        del self.index_to_pack[index]
656
 
        self.combined_index._indices.remove(index)
 
642
        pos = self.combined_index._indices.index(index)
 
643
        del self.combined_index._indices[pos]
 
644
        del self.combined_index._index_names[pos]
657
645
        if (self.add_callback is not None and
658
646
            getattr(index, 'add_nodes', None) == self.add_callback):
659
647
            self.add_callback = None
689
677
        # What text keys to copy. None for 'all texts'. This is set by
690
678
        # _copy_inventory_texts
691
679
        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)
725
680
 
726
681
    def pack(self, pb=None):
727
682
        """Create a new pack by reading data from other packs.
738
693
        :return: A Pack object, or None if nothing was copied.
739
694
        """
740
695
        # open a pack - using the same name as the last temporary file
741
 
        # - which has already been flushed, so its safe.
 
696
        # - which has already been flushed, so it's safe.
742
697
        # XXX: - duplicate code warning with start_write_group; fix before
743
698
        #      considering 'done'.
744
699
        if self._pack_collection._new_pack is not None:
776
731
        new_pack.signature_index.set_optimize(combine_backing_indices=False)
777
732
        return new_pack
778
733
 
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
 
 
813
734
    def _copy_revision_texts(self):
814
735
        """Copy revision data to the new pack."""
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
 
736
        raise NotImplementedError(self._copy_revision_texts)
838
737
 
839
738
    def _copy_inventory_texts(self):
840
739
        """Copy the inventory texts to the new pack.
843
742
 
844
743
        Sets self._text_filter appropriately.
845
744
        """
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)
 
745
        raise NotImplementedError(self._copy_inventory_texts)
876
746
 
877
747
    def _copy_text_texts(self):
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()
 
748
        raise NotImplementedError(self._copy_text_texts)
903
749
 
904
750
    def _create_pack_from_packs(self):
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
 
751
        raise NotImplementedError(self._create_pack_from_packs)
1147
752
 
1148
753
    def _log_copied_texts(self):
1149
754
        if 'pack' in debug.debug_flags:
1153
758
                self.new_pack.text_index.key_count(),
1154
759
                time.time() - self.new_pack.start_time)
1155
760
 
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
 
 
1175
761
    def _use_pack(self, new_pack):
1176
762
        """Return True if new_pack should be used.
1177
763
 
1181
767
        return new_pack.data_inserted()
1182
768
 
1183
769
 
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
 
 
1370
770
class RepositoryPackCollection(object):
1371
771
    """Management of packs within a repository.
1372
772
 
1373
773
    :ivar _names: map of {pack_name: (index_size,)}
1374
774
    """
1375
775
 
1376
 
    pack_factory = NewPack
1377
 
    resumed_pack_factory = ResumedPack
 
776
    pack_factory = None
 
777
    resumed_pack_factory = None
 
778
    normal_packer_class = None
 
779
    optimising_packer_class = None
1378
780
 
1379
781
    def __init__(self, repo, transport, index_transport, upload_transport,
1380
782
                 pack_transport, index_builder_class, index_class,
1415
817
        self.inventory_index = AggregateIndex(self.reload_pack_names, flush)
1416
818
        self.text_index = AggregateIndex(self.reload_pack_names, flush)
1417
819
        self.signature_index = AggregateIndex(self.reload_pack_names, flush)
 
820
        all_indices = [self.revision_index, self.inventory_index,
 
821
                self.text_index, self.signature_index]
1418
822
        if use_chk_index:
1419
823
            self.chk_index = AggregateIndex(self.reload_pack_names, flush)
 
824
            all_indices.append(self.chk_index)
1420
825
        else:
1421
826
            # used to determine if we're using a chk_index elsewhere.
1422
827
            self.chk_index = None
 
828
        # Tell all the CombinedGraphIndex objects about each other, so they can
 
829
        # share hints about which pack names to search first.
 
830
        all_combined = [agg_idx.combined_index for agg_idx in all_indices]
 
831
        for combined_idx in all_combined:
 
832
            combined_idx.set_sibling_indices(
 
833
                set(all_combined).difference([combined_idx]))
1423
834
        # resumed packs
1424
835
        self._resumed_packs = []
 
836
        self.config_stack = config.LocationStack(self.transport.base)
1425
837
 
1426
838
    def __repr__(self):
1427
839
        return '%s(%r)' % (self.__class__.__name__, self.repo)
1512
924
            'containing %d revisions. Packing %d files into %d affecting %d'
1513
925
            ' revisions', self, total_packs, total_revisions, num_old_packs,
1514
926
            num_new_packs, num_revs_affected)
1515
 
        result = self._execute_pack_operations(pack_operations,
 
927
        result = self._execute_pack_operations(pack_operations, packer_class=self.normal_packer_class,
1516
928
                                      reload_func=self._restart_autopack)
1517
929
        mutter('Auto-packing repository %s completed', self)
1518
930
        return result
1519
931
 
1520
 
    def _execute_pack_operations(self, pack_operations, _packer_class=Packer,
1521
 
                                 reload_func=None):
 
932
    def _execute_pack_operations(self, pack_operations, packer_class,
 
933
            reload_func=None):
1522
934
        """Execute a series of pack operations.
1523
935
 
1524
936
        :param pack_operations: A list of [revision_count, packs_to_combine].
1525
 
        :param _packer_class: The class of packer to use (default: Packer).
 
937
        :param packer_class: The class of packer to use
1526
938
        :return: The new pack names.
1527
939
        """
1528
940
        for revision_count, packs in pack_operations:
1529
941
            # we may have no-ops from the setup logic
1530
942
            if len(packs) == 0:
1531
943
                continue
1532
 
            packer = _packer_class(self, packs, '.autopack',
 
944
            packer = packer_class(self, packs, '.autopack',
1533
945
                                   reload_func=reload_func)
1534
946
            try:
1535
 
                packer.pack()
 
947
                result = packer.pack()
1536
948
            except errors.RetryWithNewPacks:
1537
949
                # An exception is propagating out of this context, make sure
1538
950
                # this packer has cleaned up. Packer() doesn't set its new_pack
1541
953
                if packer.new_pack is not None:
1542
954
                    packer.new_pack.abort()
1543
955
                raise
 
956
            if result is None:
 
957
                return
1544
958
            for pack in packs:
1545
959
                self._remove_pack_from_memory(pack)
1546
960
        # record the newly available packs and stop advertising the old
1568
982
        """Is the collection already packed?"""
1569
983
        return not (self.repo._format.pack_compresses or (len(self._names) > 1))
1570
984
 
1571
 
    def pack(self, hint=None):
 
985
    def pack(self, hint=None, clean_obsolete_packs=False):
1572
986
        """Pack the pack collection totally."""
1573
987
        self.ensure_loaded()
1574
988
        total_packs = len(self._names)
1580
994
        mutter('Packing repository %s, which has %d pack files, '
1581
995
            'containing %d revisions with hint %r.', self, total_packs,
1582
996
            total_revisions, hint)
 
997
        while True:
 
998
            try:
 
999
                self._try_pack_operations(hint)
 
1000
            except RetryPackOperations:
 
1001
                continue
 
1002
            break
 
1003
 
 
1004
        if clean_obsolete_packs:
 
1005
            self._clear_obsolete_packs()
 
1006
 
 
1007
    def _try_pack_operations(self, hint):
 
1008
        """Calculate the pack operations based on the hint (if any), and
 
1009
        execute them.
 
1010
        """
1583
1011
        # determine which packs need changing
1584
1012
        pack_operations = [[0, []]]
1585
1013
        for pack in self.all_packs():
1588
1016
                # or this pack was included in the hint.
1589
1017
                pack_operations[-1][0] += pack.get_revision_count()
1590
1018
                pack_operations[-1][1].append(pack)
1591
 
        self._execute_pack_operations(pack_operations, OptimisingPacker)
 
1019
        self._execute_pack_operations(pack_operations,
 
1020
            packer_class=self.optimising_packer_class,
 
1021
            reload_func=self._restart_pack_operations)
1592
1022
 
1593
1023
    def plan_autopack_combinations(self, existing_packs, pack_distribution):
1594
1024
        """Plan a pack operation.
1604
1034
        pack_operations = [[0, []]]
1605
1035
        # plan out what packs to keep, and what to reorganise
1606
1036
        while len(existing_packs):
1607
 
            # take the largest pack, and if its less than the head of the
 
1037
            # take the largest pack, and if it's less than the head of the
1608
1038
            # distribution chart we will include its contents in the new pack
1609
 
            # for that position. If its larger, we remove its size from the
 
1039
            # for that position. If it's larger, we remove its size from the
1610
1040
            # distribution chart
1611
1041
            next_pack_rev_count, next_pack = existing_packs.pop(0)
1612
1042
            if next_pack_rev_count >= pack_distribution[0]:
1647
1077
 
1648
1078
        :return: True if the disk names had not been previously read.
1649
1079
        """
1650
 
        # NB: if you see an assertion error here, its probably access against
 
1080
        # NB: if you see an assertion error here, it's probably access against
1651
1081
        # an unlocked repo. Naughty.
1652
1082
        if not self.repo.is_locked():
1653
1083
            raise errors.ObjectNotLocked(self.repo)
1683
1113
            txt_index = self._make_index(name, '.tix')
1684
1114
            sig_index = self._make_index(name, '.six')
1685
1115
            if self.chk_index is not None:
1686
 
                chk_index = self._make_index(name, '.cix', unlimited_cache=True)
 
1116
                chk_index = self._make_index(name, '.cix', is_chk=True)
1687
1117
            else:
1688
1118
                chk_index = None
1689
1119
            result = ExistingPack(self._pack_transport, name, rev_index,
1709
1139
            sig_index = self._make_index(name, '.six', resume=True)
1710
1140
            if self.chk_index is not None:
1711
1141
                chk_index = self._make_index(name, '.cix', resume=True,
1712
 
                                             unlimited_cache=True)
 
1142
                                             is_chk=True)
1713
1143
            else:
1714
1144
                chk_index = None
1715
1145
            result = self.resumed_pack_factory(name, rev_index, inv_index,
1745
1175
        return self._index_class(self.transport, 'pack-names', None
1746
1176
                ).iter_all_entries()
1747
1177
 
1748
 
    def _make_index(self, name, suffix, resume=False, unlimited_cache=False):
 
1178
    def _make_index(self, name, suffix, resume=False, is_chk=False):
1749
1179
        size_offset = self._suffix_offsets[suffix]
1750
1180
        index_name = name + suffix
1751
1181
        if resume:
1754
1184
        else:
1755
1185
            transport = self._index_transport
1756
1186
            index_size = self._names[name][size_offset]
1757
 
        return self._index_class(transport, index_name, index_size,
1758
 
                                 unlimited_cache=unlimited_cache)
 
1187
        index = self._index_class(transport, index_name, index_size,
 
1188
                                  unlimited_cache=is_chk)
 
1189
        if is_chk and self._index_class is btree_index.BTreeGraphIndex: 
 
1190
            index._leaf_factory = btree_index._gcchk_factory
 
1191
        return index
1759
1192
 
1760
1193
    def _max_pack_count(self, total_revisions):
1761
1194
        """Return the maximum number of packs to use for total revisions.
1790
1223
        """
1791
1224
        for pack in packs:
1792
1225
            try:
1793
 
                pack.pack_transport.rename(pack.file_name(),
1794
 
                    '../obsolete_packs/' + pack.file_name())
 
1226
                try:
 
1227
                    pack.pack_transport.move(pack.file_name(),
 
1228
                        '../obsolete_packs/' + pack.file_name())
 
1229
                except errors.NoSuchFile:
 
1230
                    # perhaps obsolete_packs was removed? Let's create it and
 
1231
                    # try again
 
1232
                    try:
 
1233
                        pack.pack_transport.mkdir('../obsolete_packs/')
 
1234
                    except errors.FileExists:
 
1235
                        pass
 
1236
                    pack.pack_transport.move(pack.file_name(),
 
1237
                        '../obsolete_packs/' + pack.file_name())
1795
1238
            except (errors.PathError, errors.TransportError), e:
1796
1239
                # TODO: Should these be warnings or mutters?
1797
1240
                mutter("couldn't rename obsolete pack, skipping it:\n%s"
1804
1247
                suffixes.append('.cix')
1805
1248
            for suffix in suffixes:
1806
1249
                try:
1807
 
                    self._index_transport.rename(pack.name + suffix,
 
1250
                    self._index_transport.move(pack.name + suffix,
1808
1251
                        '../obsolete_packs/' + pack.name + suffix)
1809
1252
                except (errors.PathError, errors.TransportError), e:
1810
1253
                    mutter("couldn't rename obsolete index, skipping it:\n%s"
1947
1390
                    # disk index because the set values are the same, unless
1948
1391
                    # the only index shows up as deleted by the set difference
1949
1392
                    # - which it may. Until there is a specific test for this,
1950
 
                    # assume its broken. RBC 20071017.
 
1393
                    # assume it's broken. RBC 20071017.
1951
1394
                    self._remove_pack_from_memory(self.get_pack_by_name(name))
1952
1395
                    self._names[name] = sizes
1953
1396
                    self.get_pack_by_name(name)
2018
1461
        """
2019
1462
        # The ensure_loaded call is to handle the case where the first call
2020
1463
        # made involving the collection was to reload_pack_names, where we 
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.
 
1464
        # don't have a view of disk contents. It's a bit of a bandaid, and
 
1465
        # causes two reads of pack-names, but it's a rare corner case not
 
1466
        # struck with regular push/pull etc.
2024
1467
        first_read = self.ensure_loaded()
2025
1468
        if first_read:
2026
1469
            return True
2045
1488
            raise
2046
1489
        raise errors.RetryAutopack(self.repo, False, sys.exc_info())
2047
1490
 
 
1491
    def _restart_pack_operations(self):
 
1492
        """Reload the pack names list, and restart the autopack code."""
 
1493
        if not self.reload_pack_names():
 
1494
            # Re-raise the original exception, because something went missing
 
1495
            # and a restart didn't find it
 
1496
            raise
 
1497
        raise RetryPackOperations(self.repo, False, sys.exc_info())
 
1498
 
2048
1499
    def _clear_obsolete_packs(self, preserve=None):
2049
1500
        """Delete everything from the obsolete-packs directory.
2050
1501
 
2055
1506
        obsolete_pack_transport = self.transport.clone('obsolete_packs')
2056
1507
        if preserve is None:
2057
1508
            preserve = set()
2058
 
        for filename in obsolete_pack_transport.list_dir('.'):
 
1509
        try:
 
1510
            obsolete_pack_files = obsolete_pack_transport.list_dir('.')
 
1511
        except errors.NoSuchFile:
 
1512
            return found
 
1513
        for filename in obsolete_pack_files:
2059
1514
            name, ext = osutils.splitext(filename)
2060
1515
            if ext == '.pack':
2061
1516
                found.append(name)
2198
1653
            self._resume_pack(token)
2199
1654
 
2200
1655
 
2201
 
class KnitPackRepository(KnitRepository):
 
1656
class PackRepository(MetaDirVersionedFileRepository):
2202
1657
    """Repository with knit objects stored inside pack containers.
2203
1658
 
2204
1659
    The layering for a KnitPackRepository is:
2207
1662
    ===================================================
2208
1663
    Tuple based apis below, string based, and key based apis above
2209
1664
    ---------------------------------------------------
2210
 
    KnitVersionedFiles
 
1665
    VersionedFiles
2211
1666
      Provides .texts, .revisions etc
2212
1667
      This adapts the N-tuple keys to physical knit records which only have a
2213
1668
      single string identifier (for historical reasons), which in older formats
2223
1678
 
2224
1679
    """
2225
1680
 
 
1681
    # These attributes are inherited from the Repository base class. Setting
 
1682
    # them to None ensures that if the constructor is changed to not initialize
 
1683
    # them, or a subclass fails to call the constructor, that an error will
 
1684
    # occur rather than the system working but generating incorrect data.
 
1685
    _commit_builder_class = None
 
1686
    _serializer = None
 
1687
 
2226
1688
    def __init__(self, _format, a_bzrdir, control_files, _commit_builder_class,
2227
1689
        _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
 
1690
        MetaDirRepository.__init__(self, _format, a_bzrdir, control_files)
 
1691
        self._commit_builder_class = _commit_builder_class
 
1692
        self._serializer = _serializer
2285
1693
        self._reconcile_fixes_text_parents = True
2286
 
        self._reconcile_backsup_inventory = False
 
1694
        if self._format.supports_external_lookups:
 
1695
            self._unstacked_provider = graph.CachingParentsProvider(
 
1696
                self._make_parents_provider_unstacked())
 
1697
        else:
 
1698
            self._unstacked_provider = graph.CachingParentsProvider(self)
 
1699
        self._unstacked_provider.disable_cache()
2287
1700
 
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)
 
1701
    @needs_read_lock
 
1702
    def _all_revision_ids(self):
 
1703
        """See Repository.all_revision_ids()."""
 
1704
        return [key[0] for key in self.revisions.keys()]
2292
1705
 
2293
1706
    def _abort_write_group(self):
2294
1707
        self.revisions._index._key_dependencies.clear()
2295
1708
        self._pack_collection._abort_write_group()
2296
1709
 
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
 
 
2302
1710
    def _make_parents_provider(self):
2303
 
        return graph.CachingParentsProvider(self)
 
1711
        if not self._format.supports_external_lookups:
 
1712
            return self._unstacked_provider
 
1713
        return graph.StackedParentsProvider(_LazyListJoin(
 
1714
            [self._unstacked_provider], self._fallback_repositories))
2304
1715
 
2305
1716
    def _refresh_data(self):
2306
1717
        if not self.is_locked():
2307
1718
            return
2308
1719
        self._pack_collection.reload_pack_names()
 
1720
        self._unstacked_provider.disable_cache()
 
1721
        self._unstacked_provider.enable_cache()
2309
1722
 
2310
1723
    def _start_write_group(self):
2311
1724
        self._pack_collection._start_write_group()
2313
1726
    def _commit_write_group(self):
2314
1727
        hint = self._pack_collection._commit_write_group()
2315
1728
        self.revisions._index._key_dependencies.clear()
 
1729
        # The commit may have added keys that were previously cached as
 
1730
        # missing, so reset the cache.
 
1731
        self._unstacked_provider.disable_cache()
 
1732
        self._unstacked_provider.enable_cache()
2316
1733
        return hint
2317
1734
 
2318
1735
    def suspend_write_group(self):
2345
1762
        return self._write_lock_count
2346
1763
 
2347
1764
    def lock_write(self, token=None):
 
1765
        """Lock the repository for writes.
 
1766
 
 
1767
        :return: A bzrlib.repository.RepositoryWriteLockResult.
 
1768
        """
2348
1769
        locked = self.is_locked()
2349
1770
        if not self._write_lock_count and locked:
2350
1771
            raise errors.ReadOnlyError(self)
2355
1776
            if 'relock' in debug.debug_flags and self._prev_lock == 'w':
2356
1777
                note('%r was write locked again', self)
2357
1778
            self._prev_lock = 'w'
 
1779
            self._unstacked_provider.enable_cache()
2358
1780
            for repo in self._fallback_repositories:
2359
1781
                # Writes don't affect fallback repos
2360
1782
                repo.lock_read()
2361
1783
            self._refresh_data()
 
1784
        return RepositoryWriteLockResult(self.unlock, None)
2362
1785
 
2363
1786
    def lock_read(self):
 
1787
        """Lock the repository for reads.
 
1788
 
 
1789
        :return: A bzrlib.lock.LogicalLockResult.
 
1790
        """
2364
1791
        locked = self.is_locked()
2365
1792
        if self._write_lock_count:
2366
1793
            self._write_lock_count += 1
2370
1797
            if 'relock' in debug.debug_flags and self._prev_lock == 'r':
2371
1798
                note('%r was read locked again', self)
2372
1799
            self._prev_lock = 'r'
 
1800
            self._unstacked_provider.enable_cache()
2373
1801
            for repo in self._fallback_repositories:
2374
1802
                repo.lock_read()
2375
1803
            self._refresh_data()
 
1804
        return LogicalLockResult(self.unlock)
2376
1805
 
2377
1806
    def leave_lock_in_place(self):
2378
1807
        # not supported - raise an error
2383
1812
        raise NotImplementedError(self.dont_leave_lock_in_place)
2384
1813
 
2385
1814
    @needs_write_lock
2386
 
    def pack(self, hint=None):
 
1815
    def pack(self, hint=None, clean_obsolete_packs=False):
2387
1816
        """Compress the data within the repository.
2388
1817
 
2389
1818
        This will pack all the data to a single pack. In future it may
2390
1819
        recompress deltas or do other such expensive operations.
2391
1820
        """
2392
 
        self._pack_collection.pack(hint=hint)
 
1821
        self._pack_collection.pack(hint=hint, clean_obsolete_packs=clean_obsolete_packs)
2393
1822
 
2394
1823
    @needs_write_lock
2395
1824
    def reconcile(self, other=None, thorough=False):
2400
1829
        return reconciler
2401
1830
 
2402
1831
    def _reconcile_pack(self, collection, packs, extension, revs, pb):
2403
 
        packer = ReconcilePacker(collection, packs, extension, revs)
2404
 
        return packer.pack(pb)
 
1832
        raise NotImplementedError(self._reconcile_pack)
2405
1833
 
2406
1834
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2407
1835
    def unlock(self):
2408
1836
        if self._write_lock_count == 1 and self._write_group is not None:
2409
1837
            self.abort_write_group()
 
1838
            self._unstacked_provider.disable_cache()
2410
1839
            self._transaction = None
2411
1840
            self._write_lock_count = 0
2412
1841
            raise errors.BzrError(
2422
1851
            self.control_files.unlock()
2423
1852
 
2424
1853
        if not self.is_locked():
 
1854
            self._unstacked_provider.disable_cache()
2425
1855
            for repo in self._fallback_repositories:
2426
1856
                repo.unlock()
2427
1857
 
2428
1858
 
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):
 
1859
class RepositoryFormatPack(MetaDirVersionedFileRepositoryFormat):
2503
1860
    """Format logic for pack structured repositories.
2504
1861
 
2505
1862
    This repository format has:
2535
1892
    index_class = None
2536
1893
    _fetch_uses_deltas = True
2537
1894
    fast_deltas = False
 
1895
    supports_funky_characters = True
 
1896
    revision_graph_can_have_wrong_parents = True
2538
1897
 
2539
1898
    def initialize(self, a_bzrdir, shared=False):
2540
1899
        """Create a pack based repository.
2551
1910
        utf8_files = [('format', self.get_format_string())]
2552
1911
 
2553
1912
        self._upload_blank_content(a_bzrdir, dirs, files, utf8_files, shared)
2554
 
        return self.open(a_bzrdir=a_bzrdir, _found=True)
 
1913
        repository = self.open(a_bzrdir=a_bzrdir, _found=True)
 
1914
        self._run_post_repo_init_hooks(repository, a_bzrdir, shared)
 
1915
        return repository
2555
1916
 
2556
1917
    def open(self, a_bzrdir, _found=False, _override_transport=None):
2557
1918
        """See RepositoryFormat.open().
2561
1922
                                    than normal. I.e. during 'upgrade'.
2562
1923
        """
2563
1924
        if not _found:
2564
 
            format = RepositoryFormat.find_format(a_bzrdir)
 
1925
            format = RepositoryFormatMetaDir.find_format(a_bzrdir)
2565
1926
        if _override_transport is not None:
2566
1927
            repo_transport = _override_transport
2567
1928
        else:
2575
1936
                              _serializer=self._serializer)
2576
1937
 
2577
1938
 
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")
 
1939
class RetryPackOperations(errors.RetryWithNewPacks):
 
1940
    """Raised when we are packing and we find a missing file.
 
1941
 
 
1942
    Meant as a signaling exception, to tell the RepositoryPackCollection.pack
 
1943
    code it should try again.
 
1944
    """
 
1945
 
 
1946
    internal_error = True
 
1947
 
 
1948
    _fmt = ("Pack files have changed, reload and try pack again."
 
1949
            " context: %(context)s %(orig_error)s")
 
1950
 
 
1951
 
 
1952
class _DirectPackAccess(object):
 
1953
    """Access to data in one or more packs with less translation."""
 
1954
 
 
1955
    def __init__(self, index_to_packs, reload_func=None, flush_func=None):
 
1956
        """Create a _DirectPackAccess object.
 
1957
 
 
1958
        :param index_to_packs: A dict mapping index objects to the transport
 
1959
            and file names for obtaining data.
 
1960
        :param reload_func: A function to call if we determine that the pack
 
1961
            files have moved and we need to reload our caches. See
 
1962
            bzrlib.repo_fmt.pack_repo.AggregateIndex for more details.
 
1963
        """
 
1964
        self._container_writer = None
 
1965
        self._write_index = None
 
1966
        self._indices = index_to_packs
 
1967
        self._reload_func = reload_func
 
1968
        self._flush_func = flush_func
 
1969
 
 
1970
    def add_raw_records(self, key_sizes, raw_data):
 
1971
        """Add raw knit bytes to a storage area.
 
1972
 
 
1973
        The data is spooled to the container writer in one bytes-record per
 
1974
        raw data item.
 
1975
 
 
1976
        :param sizes: An iterable of tuples containing the key and size of each
 
1977
            raw data segment.
 
1978
        :param raw_data: A bytestring containing the data.
 
1979
        :return: A list of memos to retrieve the record later. Each memo is an
 
1980
            opaque index memo. For _DirectPackAccess the memo is (index, pos,
 
1981
            length), where the index field is the write_index object supplied
 
1982
            to the PackAccess object.
 
1983
        """
 
1984
        if type(raw_data) is not str:
 
1985
            raise AssertionError(
 
1986
                'data must be plain bytes was %s' % type(raw_data))
 
1987
        result = []
 
1988
        offset = 0
 
1989
        for key, size in key_sizes:
 
1990
            p_offset, p_length = self._container_writer.add_bytes_record(
 
1991
                raw_data[offset:offset+size], [])
 
1992
            offset += size
 
1993
            result.append((self._write_index, p_offset, p_length))
 
1994
        return result
 
1995
 
 
1996
    def flush(self):
 
1997
        """Flush pending writes on this access object.
 
1998
 
 
1999
        This will flush any buffered writes to a NewPack.
 
2000
        """
 
2001
        if self._flush_func is not None:
 
2002
            self._flush_func()
 
2003
 
 
2004
    def get_raw_records(self, memos_for_retrieval):
 
2005
        """Get the raw bytes for a records.
 
2006
 
 
2007
        :param memos_for_retrieval: An iterable containing the (index, pos,
 
2008
            length) memo for retrieving the bytes. The Pack access method
 
2009
            looks up the pack to use for a given record in its index_to_pack
 
2010
            map.
 
2011
        :return: An iterator over the bytes of the records.
 
2012
        """
 
2013
        # first pass, group into same-index requests
 
2014
        request_lists = []
 
2015
        current_index = None
 
2016
        for (index, offset, length) in memos_for_retrieval:
 
2017
            if current_index == index:
 
2018
                current_list.append((offset, length))
 
2019
            else:
 
2020
                if current_index is not None:
 
2021
                    request_lists.append((current_index, current_list))
 
2022
                current_index = index
 
2023
                current_list = [(offset, length)]
 
2024
        # handle the last entry
 
2025
        if current_index is not None:
 
2026
            request_lists.append((current_index, current_list))
 
2027
        for index, offsets in request_lists:
 
2028
            try:
 
2029
                transport, path = self._indices[index]
 
2030
            except KeyError:
 
2031
                # A KeyError here indicates that someone has triggered an index
 
2032
                # reload, and this index has gone missing, we need to start
 
2033
                # over.
 
2034
                if self._reload_func is None:
 
2035
                    # If we don't have a _reload_func there is nothing that can
 
2036
                    # be done
 
2037
                    raise
 
2038
                raise errors.RetryWithNewPacks(index,
 
2039
                                               reload_occurred=True,
 
2040
                                               exc_info=sys.exc_info())
 
2041
            try:
 
2042
                reader = pack.make_readv_reader(transport, path, offsets)
 
2043
                for names, read_func in reader.iter_records():
 
2044
                    yield read_func(None)
 
2045
            except errors.NoSuchFile:
 
2046
                # A NoSuchFile error indicates that a pack file has gone
 
2047
                # missing on disk, we need to trigger a reload, and start over.
 
2048
                if self._reload_func is None:
 
2049
                    raise
 
2050
                raise errors.RetryWithNewPacks(transport.abspath(path),
 
2051
                                               reload_occurred=False,
 
2052
                                               exc_info=sys.exc_info())
 
2053
 
 
2054
    def set_writer(self, writer, index, transport_packname):
 
2055
        """Set a writer to use for adding data."""
 
2056
        if index is not None:
 
2057
            self._indices[index] = transport_packname
 
2058
        self._container_writer = writer
 
2059
        self._write_index = index
 
2060
 
 
2061
    def reload_or_raise(self, retry_exc):
 
2062
        """Try calling the reload function, or re-raise the original exception.
 
2063
 
 
2064
        This should be called after _DirectPackAccess raises a
 
2065
        RetryWithNewPacks exception. This function will handle the common logic
 
2066
        of determining when the error is fatal versus being temporary.
 
2067
        It will also make sure that the original exception is raised, rather
 
2068
        than the RetryWithNewPacks exception.
 
2069
 
 
2070
        If this function returns, then the calling function should retry
 
2071
        whatever operation was being performed. Otherwise an exception will
 
2072
        be raised.
 
2073
 
 
2074
        :param retry_exc: A RetryWithNewPacks exception.
 
2075
        """
 
2076
        is_error = False
 
2077
        if self._reload_func is None:
 
2078
            is_error = True
 
2079
        elif not self._reload_func():
 
2080
            # The reload claimed that nothing changed
 
2081
            if not retry_exc.reload_occurred:
 
2082
                # If there wasn't an earlier reload, then we really were
 
2083
                # expecting to find changes. We didn't find them, so this is a
 
2084
                # hard error
 
2085
                is_error = True
 
2086
        if is_error:
 
2087
            exc_class, exc_value, exc_traceback = retry_exc.exc_info
 
2088
            raise exc_class, exc_value, exc_traceback
 
2089
 
 
2090
 
2926
2091