~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repofmt/pack_repo.py

  • Committer: Vincent Ladeuil
  • Date: 2012-03-13 16:42:20 UTC
  • mto: This revision was merged to the branch mainline in revision 6512.
  • Revision ID: v.ladeuil+lp@free.fr-20120313164220-atkou2zprhlspmwg
Mention that a given config option cannot be safely handled via both APIs at the same time.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007, 2008 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
 
24
26
 
25
27
from bzrlib import (
26
28
    chk_map,
 
29
    cleanup,
 
30
    config,
27
31
    debug,
28
32
    graph,
29
33
    osutils,
30
34
    pack,
31
35
    transactions,
 
36
    tsort,
32
37
    ui,
33
 
    xml5,
34
 
    xml6,
35
 
    xml7,
36
38
    )
37
39
from bzrlib.index import (
38
40
    CombinedGraphIndex,
39
41
    GraphIndexPrefixAdapter,
40
42
    )
41
 
from bzrlib.knit import (
42
 
    KnitPlainFactory,
43
 
    KnitVersionedFiles,
44
 
    _KnitGraphIndex,
45
 
    _DirectPackAccess,
46
 
    )
47
 
from bzrlib import tsort
48
43
""")
49
44
from bzrlib import (
50
 
    bzrdir,
 
45
    btree_index,
51
46
    errors,
52
47
    lockable_files,
53
48
    lockdir,
54
 
    revision as _mod_revision,
55
49
    )
56
50
 
57
 
from bzrlib.decorators import needs_write_lock, only_raises
58
 
from bzrlib.btree_index import (
59
 
    BTreeGraphIndex,
60
 
    BTreeBuilder,
61
 
    )
62
 
from bzrlib.index import (
63
 
    GraphIndex,
64
 
    InMemoryGraphIndex,
65
 
    )
66
 
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
67
57
from bzrlib.repository import (
68
 
    CommitBuilder,
69
 
    MetaDirRepositoryFormat,
70
 
    RepositoryFormat,
71
 
    RootCommitBuilder,
72
 
    StreamSource,
 
58
    _LazyListJoin,
 
59
    MetaDirRepository,
 
60
    RepositoryFormatMetaDir,
 
61
    RepositoryWriteLockResult,
 
62
    )
 
63
from bzrlib.vf_repository import (
 
64
    MetaDirVersionedFileRepository,
 
65
    MetaDirVersionedFileRepositoryFormat,
 
66
    VersionedFileCommitBuilder,
 
67
    VersionedFileRootCommitBuilder,
73
68
    )
74
69
from bzrlib.trace import (
75
70
    mutter,
78
73
    )
79
74
 
80
75
 
81
 
class PackCommitBuilder(CommitBuilder):
82
 
    """A subclass of CommitBuilder to add texts with pack semantics.
 
76
class PackCommitBuilder(VersionedFileCommitBuilder):
 
77
    """Subclass of VersionedFileCommitBuilder to add texts with pack semantics.
83
78
 
84
79
    Specifically this uses one knit object rather than one knit object per
85
80
    added text, reducing memory and object pressure.
87
82
 
88
83
    def __init__(self, repository, parents, config, timestamp=None,
89
84
                 timezone=None, committer=None, revprops=None,
90
 
                 revision_id=None):
91
 
        CommitBuilder.__init__(self, repository, parents, config,
 
85
                 revision_id=None, lossy=False):
 
86
        VersionedFileCommitBuilder.__init__(self, repository, parents, config,
92
87
            timestamp=timestamp, timezone=timezone, committer=committer,
93
 
            revprops=revprops, revision_id=revision_id)
 
88
            revprops=revprops, revision_id=revision_id, lossy=lossy)
94
89
        self._file_graph = graph.Graph(
95
90
            repository._pack_collection.text_index.combined_index)
96
91
 
99
94
        return set([key[1] for key in self._file_graph.heads(keys)])
100
95
 
101
96
 
102
 
class PackRootCommitBuilder(RootCommitBuilder):
 
97
class PackRootCommitBuilder(VersionedFileRootCommitBuilder):
103
98
    """A subclass of RootCommitBuilder to add texts with pack semantics.
104
99
 
105
100
    Specifically this uses one knit object rather than one knit object per
108
103
 
109
104
    def __init__(self, repository, parents, config, timestamp=None,
110
105
                 timezone=None, committer=None, revprops=None,
111
 
                 revision_id=None):
112
 
        CommitBuilder.__init__(self, repository, parents, config,
113
 
            timestamp=timestamp, timezone=timezone, committer=committer,
114
 
            revprops=revprops, revision_id=revision_id)
 
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)
115
111
        self._file_graph = graph.Graph(
116
112
            repository._pack_collection.text_index.combined_index)
117
113
 
228
224
        unlimited_cache = False
229
225
        if index_type == 'chk':
230
226
            unlimited_cache = True
231
 
        setattr(self, index_type + '_index',
232
 
            self.index_class(self.index_transport,
233
 
                self.index_name(index_type, self.name),
234
 
                self.index_sizes[self.index_offset(index_type)],
235
 
                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)
236
234
 
237
235
 
238
236
class ExistingPack(Pack):
319
317
        for index_type in index_types:
320
318
            old_name = self.index_name(index_type, self.name)
321
319
            new_name = '../indices/' + old_name
322
 
            self.upload_transport.rename(old_name, new_name)
 
320
            self.upload_transport.move(old_name, new_name)
323
321
            self._replace_index_with_readonly(index_type)
324
322
        new_name = '../packs/' + self.file_name()
325
 
        self.upload_transport.rename(self.file_name(), new_name)
 
323
        self.upload_transport.move(self.file_name(), new_name)
326
324
        self._state = 'finished'
327
325
 
328
326
    def _get_external_refs(self, index):
483
481
        # visible is smaller.  On the other hand none will be seen until
484
482
        # they're in the names list.
485
483
        self.index_sizes = [None, None, None, None]
486
 
        self._write_index('revision', self.revision_index, 'revision', suspend)
 
484
        self._write_index('revision', self.revision_index, 'revision',
 
485
            suspend)
487
486
        self._write_index('inventory', self.inventory_index, 'inventory',
488
487
            suspend)
489
488
        self._write_index('text', self.text_index, 'file texts', suspend)
493
492
            self.index_sizes.append(None)
494
493
            self._write_index('chk', self.chk_index,
495
494
                'content hash bytes', suspend)
496
 
        self.write_stream.close()
 
495
        self.write_stream.close(
 
496
            want_fdatasync=self._pack_collection.config_stack.get('repository.fdatasync'))
497
497
        # Note that this will clobber an existing pack with the same name,
498
498
        # without checking for hash collisions. While this is undesirable this
499
499
        # is something that can be rectified in a subsequent release. One way
508
508
        new_name = self.name + '.pack'
509
509
        if not suspend:
510
510
            new_name = '../packs/' + new_name
511
 
        self.upload_transport.rename(self.random_name, new_name)
 
511
        self.upload_transport.move(self.random_name, new_name)
512
512
        self._state = 'finished'
513
513
        if 'pack' in debug.debug_flags:
514
514
            # XXX: size might be interesting?
542
542
            transport = self.upload_transport
543
543
        else:
544
544
            transport = self.index_transport
545
 
        self.index_sizes[self.index_offset(index_type)] = transport.put_file(
546
 
            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)
547
553
        if 'pack' in debug.debug_flags:
548
554
            # XXX: size might be interesting?
549
555
            mutter('%s: create_pack: wrote %s index: %s%s t+%6.3fs',
586
592
                                             flush_func=flush_func)
587
593
        self.add_callback = None
588
594
 
589
 
    def replace_indices(self, index_to_pack, indices):
590
 
        """Replace the current mappings with fresh ones.
591
 
 
592
 
        This should probably not be used eventually, rather incremental add and
593
 
        removal of indices. It has been added during refactoring of existing
594
 
        code.
595
 
 
596
 
        :param index_to_pack: A mapping from index objects to
597
 
            (transport, name) tuples for the pack file data.
598
 
        :param indices: A list of indices.
599
 
        """
600
 
        # refresh the revision pack map dict without replacing the instance.
601
 
        self.index_to_pack.clear()
602
 
        self.index_to_pack.update(index_to_pack)
603
 
        # XXX: API break - clearly a 'replace' method would be good?
604
 
        self.combined_index._indices[:] = indices
605
 
        # the current add nodes callback for the current writable index if
606
 
        # there is one.
607
 
        self.add_callback = None
608
 
 
609
595
    def add_index(self, index, pack):
610
596
        """Add index to the aggregate, which is an index for Pack pack.
611
597
 
618
604
        # expose it to the index map
619
605
        self.index_to_pack[index] = pack.access_tuple()
620
606
        # put it at the front of the linear index list
621
 
        self.combined_index.insert_index(0, index)
 
607
        self.combined_index.insert_index(0, index, pack.name)
622
608
 
623
609
    def add_writable_index(self, index, pack):
624
610
        """Add an index which is able to have data added to it.
644
630
        self.data_access.set_writer(None, None, (None, None))
645
631
        self.index_to_pack.clear()
646
632
        del self.combined_index._indices[:]
 
633
        del self.combined_index._index_names[:]
647
634
        self.add_callback = None
648
635
 
649
 
    def remove_index(self, index, pack):
 
636
    def remove_index(self, index):
650
637
        """Remove index from the indices used to answer queries.
651
638
 
652
639
        :param index: An index from the pack parameter.
653
 
        :param pack: A Pack instance.
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
1547
961
        # packs
1548
 
        result = self._save_pack_names(clear_obsolete_packs=True)
1549
 
        # Move the old packs out of the way now they are no longer referenced.
1550
 
        for revision_count, packs in pack_operations:
1551
 
            self._obsolete_packs(packs)
 
962
        to_be_obsoleted = []
 
963
        for _, packs in pack_operations:
 
964
            to_be_obsoleted.extend(packs)
 
965
        result = self._save_pack_names(clear_obsolete_packs=True,
 
966
                                       obsolete_packs=to_be_obsoleted)
1552
967
        return result
1553
968
 
1554
969
    def _flush_new_pack(self):
1567
982
        """Is the collection already packed?"""
1568
983
        return not (self.repo._format.pack_compresses or (len(self._names) > 1))
1569
984
 
1570
 
    def pack(self, hint=None):
 
985
    def pack(self, hint=None, clean_obsolete_packs=False):
1571
986
        """Pack the pack collection totally."""
1572
987
        self.ensure_loaded()
1573
988
        total_packs = len(self._names)
1579
994
        mutter('Packing repository %s, which has %d pack files, '
1580
995
            'containing %d revisions with hint %r.', self, total_packs,
1581
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
        """
1582
1011
        # determine which packs need changing
1583
1012
        pack_operations = [[0, []]]
1584
1013
        for pack in self.all_packs():
1587
1016
                # or this pack was included in the hint.
1588
1017
                pack_operations[-1][0] += pack.get_revision_count()
1589
1018
                pack_operations[-1][1].append(pack)
1590
 
        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)
1591
1022
 
1592
1023
    def plan_autopack_combinations(self, existing_packs, pack_distribution):
1593
1024
        """Plan a pack operation.
1603
1034
        pack_operations = [[0, []]]
1604
1035
        # plan out what packs to keep, and what to reorganise
1605
1036
        while len(existing_packs):
1606
 
            # 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
1607
1038
            # distribution chart we will include its contents in the new pack
1608
 
            # 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
1609
1040
            # distribution chart
1610
1041
            next_pack_rev_count, next_pack = existing_packs.pop(0)
1611
1042
            if next_pack_rev_count >= pack_distribution[0]:
1646
1077
 
1647
1078
        :return: True if the disk names had not been previously read.
1648
1079
        """
1649
 
        # 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
1650
1081
        # an unlocked repo. Naughty.
1651
1082
        if not self.repo.is_locked():
1652
1083
            raise errors.ObjectNotLocked(self.repo)
1682
1113
            txt_index = self._make_index(name, '.tix')
1683
1114
            sig_index = self._make_index(name, '.six')
1684
1115
            if self.chk_index is not None:
1685
 
                chk_index = self._make_index(name, '.cix', unlimited_cache=True)
 
1116
                chk_index = self._make_index(name, '.cix', is_chk=True)
1686
1117
            else:
1687
1118
                chk_index = None
1688
1119
            result = ExistingPack(self._pack_transport, name, rev_index,
1708
1139
            sig_index = self._make_index(name, '.six', resume=True)
1709
1140
            if self.chk_index is not None:
1710
1141
                chk_index = self._make_index(name, '.cix', resume=True,
1711
 
                                             unlimited_cache=True)
 
1142
                                             is_chk=True)
1712
1143
            else:
1713
1144
                chk_index = None
1714
1145
            result = self.resumed_pack_factory(name, rev_index, inv_index,
1744
1175
        return self._index_class(self.transport, 'pack-names', None
1745
1176
                ).iter_all_entries()
1746
1177
 
1747
 
    def _make_index(self, name, suffix, resume=False, unlimited_cache=False):
 
1178
    def _make_index(self, name, suffix, resume=False, is_chk=False):
1748
1179
        size_offset = self._suffix_offsets[suffix]
1749
1180
        index_name = name + suffix
1750
1181
        if resume:
1753
1184
        else:
1754
1185
            transport = self._index_transport
1755
1186
            index_size = self._names[name][size_offset]
1756
 
        return self._index_class(transport, index_name, index_size,
1757
 
                                 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
1758
1192
 
1759
1193
    def _max_pack_count(self, total_revisions):
1760
1194
        """Return the maximum number of packs to use for total revisions.
1788
1222
        :param return: None.
1789
1223
        """
1790
1224
        for pack in packs:
1791
 
            pack.pack_transport.rename(pack.file_name(),
1792
 
                '../obsolete_packs/' + pack.file_name())
 
1225
            try:
 
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())
 
1238
            except (errors.PathError, errors.TransportError), e:
 
1239
                # TODO: Should these be warnings or mutters?
 
1240
                mutter("couldn't rename obsolete pack, skipping it:\n%s"
 
1241
                       % (e,))
1793
1242
            # TODO: Probably needs to know all possible indices for this pack
1794
1243
            # - or maybe list the directory and move all indices matching this
1795
1244
            # name whether we recognize it or not?
1797
1246
            if self.chk_index is not None:
1798
1247
                suffixes.append('.cix')
1799
1248
            for suffix in suffixes:
1800
 
                self._index_transport.rename(pack.name + suffix,
1801
 
                    '../obsolete_packs/' + pack.name + suffix)
 
1249
                try:
 
1250
                    self._index_transport.move(pack.name + suffix,
 
1251
                        '../obsolete_packs/' + pack.name + suffix)
 
1252
                except (errors.PathError, errors.TransportError), e:
 
1253
                    mutter("couldn't rename obsolete index, skipping it:\n%s"
 
1254
                           % (e,))
1802
1255
 
1803
1256
    def pack_distribution(self, total_revisions):
1804
1257
        """Generate a list of the number of revisions to put in each pack.
1830
1283
        self._remove_pack_indices(pack)
1831
1284
        self.packs.remove(pack)
1832
1285
 
1833
 
    def _remove_pack_indices(self, pack):
1834
 
        """Remove the indices for pack from the aggregated indices."""
1835
 
        self.revision_index.remove_index(pack.revision_index, pack)
1836
 
        self.inventory_index.remove_index(pack.inventory_index, pack)
1837
 
        self.text_index.remove_index(pack.text_index, pack)
1838
 
        self.signature_index.remove_index(pack.signature_index, pack)
1839
 
        if self.chk_index is not None:
1840
 
            self.chk_index.remove_index(pack.chk_index, pack)
 
1286
    def _remove_pack_indices(self, pack, ignore_missing=False):
 
1287
        """Remove the indices for pack from the aggregated indices.
 
1288
        
 
1289
        :param ignore_missing: Suppress KeyErrors from calling remove_index.
 
1290
        """
 
1291
        for index_type in Pack.index_definitions.keys():
 
1292
            attr_name = index_type + '_index'
 
1293
            aggregate_index = getattr(self, attr_name)
 
1294
            if aggregate_index is not None:
 
1295
                pack_index = getattr(pack, attr_name)
 
1296
                try:
 
1297
                    aggregate_index.remove_index(pack_index)
 
1298
                except KeyError:
 
1299
                    if ignore_missing:
 
1300
                        continue
 
1301
                    raise
1841
1302
 
1842
1303
    def reset(self):
1843
1304
        """Clear all cached data."""
1876
1337
        disk_nodes = set()
1877
1338
        for index, key, value in self._iter_disk_pack_index():
1878
1339
            disk_nodes.add((key, value))
 
1340
        orig_disk_nodes = set(disk_nodes)
1879
1341
 
1880
1342
        # do a two-way diff against our original content
1881
1343
        current_nodes = set()
1894
1356
        disk_nodes.difference_update(deleted_nodes)
1895
1357
        disk_nodes.update(new_nodes)
1896
1358
 
1897
 
        return disk_nodes, deleted_nodes, new_nodes
 
1359
        return disk_nodes, deleted_nodes, new_nodes, orig_disk_nodes
1898
1360
 
1899
1361
    def _syncronize_pack_names_from_disk_nodes(self, disk_nodes):
1900
1362
        """Given the correct set of pack files, update our saved info.
1928
1390
                    # disk index because the set values are the same, unless
1929
1391
                    # the only index shows up as deleted by the set difference
1930
1392
                    # - which it may. Until there is a specific test for this,
1931
 
                    # assume its broken. RBC 20071017.
 
1393
                    # assume it's broken. RBC 20071017.
1932
1394
                    self._remove_pack_from_memory(self.get_pack_by_name(name))
1933
1395
                    self._names[name] = sizes
1934
1396
                    self.get_pack_by_name(name)
1940
1402
                added.append(name)
1941
1403
        return removed, added, modified
1942
1404
 
1943
 
    def _save_pack_names(self, clear_obsolete_packs=False):
 
1405
    def _save_pack_names(self, clear_obsolete_packs=False, obsolete_packs=None):
1944
1406
        """Save the list of packs.
1945
1407
 
1946
1408
        This will take out the mutex around the pack names list for the
1950
1412
 
1951
1413
        :param clear_obsolete_packs: If True, clear out the contents of the
1952
1414
            obsolete_packs directory.
 
1415
        :param obsolete_packs: Packs that are obsolete once the new pack-names
 
1416
            file has been written.
1953
1417
        :return: A list of the names saved that were not previously on disk.
1954
1418
        """
 
1419
        already_obsolete = []
1955
1420
        self.lock_names()
1956
1421
        try:
1957
1422
            builder = self._index_builder_class()
1958
 
            disk_nodes, deleted_nodes, new_nodes = self._diff_pack_names()
 
1423
            (disk_nodes, deleted_nodes, new_nodes,
 
1424
             orig_disk_nodes) = self._diff_pack_names()
1959
1425
            # TODO: handle same-name, index-size-changes here -
1960
1426
            # e.g. use the value from disk, not ours, *unless* we're the one
1961
1427
            # changing it.
1963
1429
                builder.add_node(key, value)
1964
1430
            self.transport.put_file('pack-names', builder.finish(),
1965
1431
                mode=self.repo.bzrdir._get_file_mode())
1966
 
            # move the baseline forward
1967
1432
            self._packs_at_load = disk_nodes
1968
1433
            if clear_obsolete_packs:
1969
 
                self._clear_obsolete_packs()
 
1434
                to_preserve = None
 
1435
                if obsolete_packs:
 
1436
                    to_preserve = set([o.name for o in obsolete_packs])
 
1437
                already_obsolete = self._clear_obsolete_packs(to_preserve)
1970
1438
        finally:
1971
1439
            self._unlock_names()
1972
1440
        # synchronise the memory packs list with what we just wrote:
1973
1441
        self._syncronize_pack_names_from_disk_nodes(disk_nodes)
 
1442
        if obsolete_packs:
 
1443
            # TODO: We could add one more condition here. "if o.name not in
 
1444
            #       orig_disk_nodes and o != the new_pack we haven't written to
 
1445
            #       disk yet. However, the new pack object is not easily
 
1446
            #       accessible here (it would have to be passed through the
 
1447
            #       autopacking code, etc.)
 
1448
            obsolete_packs = [o for o in obsolete_packs
 
1449
                              if o.name not in already_obsolete]
 
1450
            self._obsolete_packs(obsolete_packs)
1974
1451
        return [new_node[0][0] for new_node in new_nodes]
1975
1452
 
1976
1453
    def reload_pack_names(self):
1984
1461
        """
1985
1462
        # The ensure_loaded call is to handle the case where the first call
1986
1463
        # made involving the collection was to reload_pack_names, where we 
1987
 
        # don't have a view of disk contents. Its a bit of a bandaid, and
1988
 
        # causes two reads of pack-names, but its a rare corner case not struck
1989
 
        # 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.
1990
1467
        first_read = self.ensure_loaded()
1991
1468
        if first_read:
1992
1469
            return True
1993
1470
        # out the new value.
1994
 
        disk_nodes, _, _ = self._diff_pack_names()
1995
 
        self._packs_at_load = disk_nodes
 
1471
        (disk_nodes, deleted_nodes, new_nodes,
 
1472
         orig_disk_nodes) = self._diff_pack_names()
 
1473
        # _packs_at_load is meant to be the explicit list of names in
 
1474
        # 'pack-names' at then start. As such, it should not contain any
 
1475
        # pending names that haven't been written out yet.
 
1476
        self._packs_at_load = orig_disk_nodes
1996
1477
        (removed, added,
1997
1478
         modified) = self._syncronize_pack_names_from_disk_nodes(disk_nodes)
1998
1479
        if removed or added or modified:
2007
1488
            raise
2008
1489
        raise errors.RetryAutopack(self.repo, False, sys.exc_info())
2009
1490
 
2010
 
    def _clear_obsolete_packs(self):
 
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
 
 
1499
    def _clear_obsolete_packs(self, preserve=None):
2011
1500
        """Delete everything from the obsolete-packs directory.
 
1501
 
 
1502
        :return: A list of pack identifiers (the filename without '.pack') that
 
1503
            were found in obsolete_packs.
2012
1504
        """
 
1505
        found = []
2013
1506
        obsolete_pack_transport = self.transport.clone('obsolete_packs')
2014
 
        for filename in obsolete_pack_transport.list_dir('.'):
 
1507
        if preserve is None:
 
1508
            preserve = set()
 
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:
 
1514
            name, ext = osutils.splitext(filename)
 
1515
            if ext == '.pack':
 
1516
                found.append(name)
 
1517
            if name in preserve:
 
1518
                continue
2015
1519
            try:
2016
1520
                obsolete_pack_transport.delete(filename)
2017
1521
            except (errors.PathError, errors.TransportError), e:
2018
 
                warning("couldn't delete obsolete pack, skipping it:\n%s" % (e,))
 
1522
                warning("couldn't delete obsolete pack, skipping it:\n%s"
 
1523
                        % (e,))
 
1524
        return found
2019
1525
 
2020
1526
    def _start_write_group(self):
2021
1527
        # Do not permit preparation for writing if we're not in a 'write lock'.
2048
1554
        # FIXME: just drop the transient index.
2049
1555
        # forget what names there are
2050
1556
        if self._new_pack is not None:
2051
 
            try:
2052
 
                self._new_pack.abort()
2053
 
            finally:
2054
 
                # XXX: If we aborted while in the middle of finishing the write
2055
 
                # group, _remove_pack_indices can fail because the indexes are
2056
 
                # already gone.  If they're not there we shouldn't fail in this
2057
 
                # case.  -- mbp 20081113
2058
 
                self._remove_pack_indices(self._new_pack)
2059
 
                self._new_pack = None
 
1557
            operation = cleanup.OperationWithCleanups(self._new_pack.abort)
 
1558
            operation.add_cleanup(setattr, self, '_new_pack', None)
 
1559
            # If we aborted while in the middle of finishing the write
 
1560
            # group, _remove_pack_indices could fail because the indexes are
 
1561
            # already gone.  But they're not there we shouldn't fail in this
 
1562
            # case, so we pass ignore_missing=True.
 
1563
            operation.add_cleanup(self._remove_pack_indices, self._new_pack,
 
1564
                ignore_missing=True)
 
1565
            operation.run_simple()
2060
1566
        for resumed_pack in self._resumed_packs:
2061
 
            try:
2062
 
                resumed_pack.abort()
2063
 
            finally:
2064
 
                # See comment in previous finally block.
2065
 
                try:
2066
 
                    self._remove_pack_indices(resumed_pack)
2067
 
                except KeyError:
2068
 
                    pass
 
1567
            operation = cleanup.OperationWithCleanups(resumed_pack.abort)
 
1568
            # See comment in previous finally block.
 
1569
            operation.add_cleanup(self._remove_pack_indices, resumed_pack,
 
1570
                ignore_missing=True)
 
1571
            operation.run_simple()
2069
1572
        del self._resumed_packs[:]
2070
1573
 
2071
1574
    def _remove_resumed_pack_indices(self):
2150
1653
            self._resume_pack(token)
2151
1654
 
2152
1655
 
2153
 
class KnitPackRepository(KnitRepository):
 
1656
class PackRepository(MetaDirVersionedFileRepository):
2154
1657
    """Repository with knit objects stored inside pack containers.
2155
1658
 
2156
1659
    The layering for a KnitPackRepository is:
2159
1662
    ===================================================
2160
1663
    Tuple based apis below, string based, and key based apis above
2161
1664
    ---------------------------------------------------
2162
 
    KnitVersionedFiles
 
1665
    VersionedFiles
2163
1666
      Provides .texts, .revisions etc
2164
1667
      This adapts the N-tuple keys to physical knit records which only have a
2165
1668
      single string identifier (for historical reasons), which in older formats
2175
1678
 
2176
1679
    """
2177
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
 
2178
1688
    def __init__(self, _format, a_bzrdir, control_files, _commit_builder_class,
2179
1689
        _serializer):
2180
 
        KnitRepository.__init__(self, _format, a_bzrdir, control_files,
2181
 
            _commit_builder_class, _serializer)
2182
 
        index_transport = self._transport.clone('indices')
2183
 
        self._pack_collection = RepositoryPackCollection(self, self._transport,
2184
 
            index_transport,
2185
 
            self._transport.clone('upload'),
2186
 
            self._transport.clone('packs'),
2187
 
            _format.index_builder_class,
2188
 
            _format.index_class,
2189
 
            use_chk_index=self._format.supports_chks,
2190
 
            )
2191
 
        self.inventories = KnitVersionedFiles(
2192
 
            _KnitGraphIndex(self._pack_collection.inventory_index.combined_index,
2193
 
                add_callback=self._pack_collection.inventory_index.add_callback,
2194
 
                deltas=True, parents=True, is_locked=self.is_locked),
2195
 
            data_access=self._pack_collection.inventory_index.data_access,
2196
 
            max_delta_chain=200)
2197
 
        self.revisions = KnitVersionedFiles(
2198
 
            _KnitGraphIndex(self._pack_collection.revision_index.combined_index,
2199
 
                add_callback=self._pack_collection.revision_index.add_callback,
2200
 
                deltas=False, parents=True, is_locked=self.is_locked,
2201
 
                track_external_parent_refs=True),
2202
 
            data_access=self._pack_collection.revision_index.data_access,
2203
 
            max_delta_chain=0)
2204
 
        self.signatures = KnitVersionedFiles(
2205
 
            _KnitGraphIndex(self._pack_collection.signature_index.combined_index,
2206
 
                add_callback=self._pack_collection.signature_index.add_callback,
2207
 
                deltas=False, parents=False, is_locked=self.is_locked),
2208
 
            data_access=self._pack_collection.signature_index.data_access,
2209
 
            max_delta_chain=0)
2210
 
        self.texts = KnitVersionedFiles(
2211
 
            _KnitGraphIndex(self._pack_collection.text_index.combined_index,
2212
 
                add_callback=self._pack_collection.text_index.add_callback,
2213
 
                deltas=True, parents=True, is_locked=self.is_locked),
2214
 
            data_access=self._pack_collection.text_index.data_access,
2215
 
            max_delta_chain=200)
2216
 
        if _format.supports_chks:
2217
 
            # No graph, no compression:- references from chks are between
2218
 
            # different objects not temporal versions of the same; and without
2219
 
            # some sort of temporal structure knit compression will just fail.
2220
 
            self.chk_bytes = KnitVersionedFiles(
2221
 
                _KnitGraphIndex(self._pack_collection.chk_index.combined_index,
2222
 
                    add_callback=self._pack_collection.chk_index.add_callback,
2223
 
                    deltas=False, parents=False, is_locked=self.is_locked),
2224
 
                data_access=self._pack_collection.chk_index.data_access,
2225
 
                max_delta_chain=0)
2226
 
        else:
2227
 
            self.chk_bytes = None
2228
 
        # True when the repository object is 'write locked' (as opposed to the
2229
 
        # physical lock only taken out around changes to the pack-names list.)
2230
 
        # Another way to represent this would be a decorator around the control
2231
 
        # files object that presents logical locks as physical ones - if this
2232
 
        # gets ugly consider that alternative design. RBC 20071011
2233
 
        self._write_lock_count = 0
2234
 
        self._transaction = None
2235
 
        # for tests
2236
 
        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
2237
1693
        self._reconcile_fixes_text_parents = True
2238
 
        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()
2239
1700
 
2240
 
    def _warn_if_deprecated(self, branch=None):
2241
 
        # This class isn't deprecated, but one sub-format is
2242
 
        if isinstance(self._format, RepositoryFormatKnitPack5RichRootBroken):
2243
 
            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()]
2244
1705
 
2245
1706
    def _abort_write_group(self):
2246
1707
        self.revisions._index._key_dependencies.clear()
2247
1708
        self._pack_collection._abort_write_group()
2248
1709
 
2249
 
    def _get_source(self, to_format):
2250
 
        if to_format.network_name() == self._format.network_name():
2251
 
            return KnitPackStreamSource(self, to_format)
2252
 
        return super(KnitPackRepository, self)._get_source(to_format)
2253
 
 
2254
1710
    def _make_parents_provider(self):
2255
 
        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))
2256
1715
 
2257
1716
    def _refresh_data(self):
2258
1717
        if not self.is_locked():
2259
1718
            return
2260
1719
        self._pack_collection.reload_pack_names()
 
1720
        self._unstacked_provider.disable_cache()
 
1721
        self._unstacked_provider.enable_cache()
2261
1722
 
2262
1723
    def _start_write_group(self):
2263
1724
        self._pack_collection._start_write_group()
2265
1726
    def _commit_write_group(self):
2266
1727
        hint = self._pack_collection._commit_write_group()
2267
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()
2268
1733
        return hint
2269
1734
 
2270
1735
    def suspend_write_group(self):
2297
1762
        return self._write_lock_count
2298
1763
 
2299
1764
    def lock_write(self, token=None):
 
1765
        """Lock the repository for writes.
 
1766
 
 
1767
        :return: A bzrlib.repository.RepositoryWriteLockResult.
 
1768
        """
2300
1769
        locked = self.is_locked()
2301
1770
        if not self._write_lock_count and locked:
2302
1771
            raise errors.ReadOnlyError(self)
2307
1776
            if 'relock' in debug.debug_flags and self._prev_lock == 'w':
2308
1777
                note('%r was write locked again', self)
2309
1778
            self._prev_lock = 'w'
 
1779
            self._unstacked_provider.enable_cache()
2310
1780
            for repo in self._fallback_repositories:
2311
1781
                # Writes don't affect fallback repos
2312
1782
                repo.lock_read()
2313
1783
            self._refresh_data()
 
1784
        return RepositoryWriteLockResult(self.unlock, None)
2314
1785
 
2315
1786
    def lock_read(self):
 
1787
        """Lock the repository for reads.
 
1788
 
 
1789
        :return: A bzrlib.lock.LogicalLockResult.
 
1790
        """
2316
1791
        locked = self.is_locked()
2317
1792
        if self._write_lock_count:
2318
1793
            self._write_lock_count += 1
2322
1797
            if 'relock' in debug.debug_flags and self._prev_lock == 'r':
2323
1798
                note('%r was read locked again', self)
2324
1799
            self._prev_lock = 'r'
 
1800
            self._unstacked_provider.enable_cache()
2325
1801
            for repo in self._fallback_repositories:
2326
1802
                repo.lock_read()
2327
1803
            self._refresh_data()
 
1804
        return LogicalLockResult(self.unlock)
2328
1805
 
2329
1806
    def leave_lock_in_place(self):
2330
1807
        # not supported - raise an error
2335
1812
        raise NotImplementedError(self.dont_leave_lock_in_place)
2336
1813
 
2337
1814
    @needs_write_lock
2338
 
    def pack(self, hint=None):
 
1815
    def pack(self, hint=None, clean_obsolete_packs=False):
2339
1816
        """Compress the data within the repository.
2340
1817
 
2341
1818
        This will pack all the data to a single pack. In future it may
2342
1819
        recompress deltas or do other such expensive operations.
2343
1820
        """
2344
 
        self._pack_collection.pack(hint=hint)
 
1821
        self._pack_collection.pack(hint=hint, clean_obsolete_packs=clean_obsolete_packs)
2345
1822
 
2346
1823
    @needs_write_lock
2347
1824
    def reconcile(self, other=None, thorough=False):
2352
1829
        return reconciler
2353
1830
 
2354
1831
    def _reconcile_pack(self, collection, packs, extension, revs, pb):
2355
 
        packer = ReconcilePacker(collection, packs, extension, revs)
2356
 
        return packer.pack(pb)
 
1832
        raise NotImplementedError(self._reconcile_pack)
2357
1833
 
2358
1834
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2359
1835
    def unlock(self):
2360
1836
        if self._write_lock_count == 1 and self._write_group is not None:
2361
1837
            self.abort_write_group()
 
1838
            self._unstacked_provider.disable_cache()
2362
1839
            self._transaction = None
2363
1840
            self._write_lock_count = 0
2364
1841
            raise errors.BzrError(
2374
1851
            self.control_files.unlock()
2375
1852
 
2376
1853
        if not self.is_locked():
 
1854
            self._unstacked_provider.disable_cache()
2377
1855
            for repo in self._fallback_repositories:
2378
1856
                repo.unlock()
2379
1857
 
2380
1858
 
2381
 
class KnitPackStreamSource(StreamSource):
2382
 
    """A StreamSource used to transfer data between same-format KnitPack repos.
2383
 
 
2384
 
    This source assumes:
2385
 
        1) Same serialization format for all objects
2386
 
        2) Same root information
2387
 
        3) XML format inventories
2388
 
        4) Atomic inserts (so we can stream inventory texts before text
2389
 
           content)
2390
 
        5) No chk_bytes
2391
 
    """
2392
 
 
2393
 
    def __init__(self, from_repository, to_format):
2394
 
        super(KnitPackStreamSource, self).__init__(from_repository, to_format)
2395
 
        self._text_keys = None
2396
 
        self._text_fetch_order = 'unordered'
2397
 
 
2398
 
    def _get_filtered_inv_stream(self, revision_ids):
2399
 
        from_repo = self.from_repository
2400
 
        parent_ids = from_repo._find_parent_ids_of_revisions(revision_ids)
2401
 
        parent_keys = [(p,) for p in parent_ids]
2402
 
        find_text_keys = from_repo._find_text_key_references_from_xml_inventory_lines
2403
 
        parent_text_keys = set(find_text_keys(
2404
 
            from_repo._inventory_xml_lines_for_keys(parent_keys)))
2405
 
        content_text_keys = set()
2406
 
        knit = KnitVersionedFiles(None, None)
2407
 
        factory = KnitPlainFactory()
2408
 
        def find_text_keys_from_content(record):
2409
 
            if record.storage_kind not in ('knit-delta-gz', 'knit-ft-gz'):
2410
 
                raise ValueError("Unknown content storage kind for"
2411
 
                    " inventory text: %s" % (record.storage_kind,))
2412
 
            # It's a knit record, it has a _raw_record field (even if it was
2413
 
            # reconstituted from a network stream).
2414
 
            raw_data = record._raw_record
2415
 
            # read the entire thing
2416
 
            revision_id = record.key[-1]
2417
 
            content, _ = knit._parse_record(revision_id, raw_data)
2418
 
            if record.storage_kind == 'knit-delta-gz':
2419
 
                line_iterator = factory.get_linedelta_content(content)
2420
 
            elif record.storage_kind == 'knit-ft-gz':
2421
 
                line_iterator = factory.get_fulltext_content(content)
2422
 
            content_text_keys.update(find_text_keys(
2423
 
                [(line, revision_id) for line in line_iterator]))
2424
 
        revision_keys = [(r,) for r in revision_ids]
2425
 
        def _filtered_inv_stream():
2426
 
            source_vf = from_repo.inventories
2427
 
            stream = source_vf.get_record_stream(revision_keys,
2428
 
                                                 'unordered', False)
2429
 
            for record in stream:
2430
 
                if record.storage_kind == 'absent':
2431
 
                    raise errors.NoSuchRevision(from_repo, record.key)
2432
 
                find_text_keys_from_content(record)
2433
 
                yield record
2434
 
            self._text_keys = content_text_keys - parent_text_keys
2435
 
        return ('inventories', _filtered_inv_stream())
2436
 
 
2437
 
    def _get_text_stream(self):
2438
 
        # Note: We know we don't have to handle adding root keys, because both
2439
 
        # the source and target are the identical network name.
2440
 
        text_stream = self.from_repository.texts.get_record_stream(
2441
 
                        self._text_keys, self._text_fetch_order, False)
2442
 
        return ('texts', text_stream)
2443
 
 
2444
 
    def get_stream(self, search):
2445
 
        revision_ids = search.get_keys()
2446
 
        for stream_info in self._fetch_revision_texts(revision_ids):
2447
 
            yield stream_info
2448
 
        self._revision_keys = [(rev_id,) for rev_id in revision_ids]
2449
 
        yield self._get_filtered_inv_stream(revision_ids)
2450
 
        yield self._get_text_stream()
2451
 
 
2452
 
 
2453
 
 
2454
 
class RepositoryFormatPack(MetaDirRepositoryFormat):
 
1859
class RepositoryFormatPack(MetaDirVersionedFileRepositoryFormat):
2455
1860
    """Format logic for pack structured repositories.
2456
1861
 
2457
1862
    This repository format has:
2487
1892
    index_class = None
2488
1893
    _fetch_uses_deltas = True
2489
1894
    fast_deltas = False
 
1895
    supports_funky_characters = True
 
1896
    revision_graph_can_have_wrong_parents = True
2490
1897
 
2491
1898
    def initialize(self, a_bzrdir, shared=False):
2492
1899
        """Create a pack based repository.
2503
1910
        utf8_files = [('format', self.get_format_string())]
2504
1911
 
2505
1912
        self._upload_blank_content(a_bzrdir, dirs, files, utf8_files, shared)
2506
 
        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
2507
1916
 
2508
1917
    def open(self, a_bzrdir, _found=False, _override_transport=None):
2509
1918
        """See RepositoryFormat.open().
2513
1922
                                    than normal. I.e. during 'upgrade'.
2514
1923
        """
2515
1924
        if not _found:
2516
 
            format = RepositoryFormat.find_format(a_bzrdir)
 
1925
            format = RepositoryFormatMetaDir.find_format(a_bzrdir)
2517
1926
        if _override_transport is not None:
2518
1927
            repo_transport = _override_transport
2519
1928
        else:
2527
1936
                              _serializer=self._serializer)
2528
1937
 
2529
1938
 
2530
 
class RepositoryFormatKnitPack1(RepositoryFormatPack):
2531
 
    """A no-subtrees parameterized Pack repository.
2532
 
 
2533
 
    This format was introduced in 0.92.
2534
 
    """
2535
 
 
2536
 
    repository_class = KnitPackRepository
2537
 
    _commit_builder_class = PackCommitBuilder
2538
 
    @property
2539
 
    def _serializer(self):
2540
 
        return xml5.serializer_v5
2541
 
    # What index classes to use
2542
 
    index_builder_class = InMemoryGraphIndex
2543
 
    index_class = GraphIndex
2544
 
 
2545
 
    def _get_matching_bzrdir(self):
2546
 
        return bzrdir.format_registry.make_bzrdir('pack-0.92')
2547
 
 
2548
 
    def _ignore_setting_bzrdir(self, format):
2549
 
        pass
2550
 
 
2551
 
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2552
 
 
2553
 
    def get_format_string(self):
2554
 
        """See RepositoryFormat.get_format_string()."""
2555
 
        return "Bazaar pack repository format 1 (needs bzr 0.92)\n"
2556
 
 
2557
 
    def get_format_description(self):
2558
 
        """See RepositoryFormat.get_format_description()."""
2559
 
        return "Packs containing knits without subtree support"
2560
 
 
2561
 
 
2562
 
class RepositoryFormatKnitPack3(RepositoryFormatPack):
2563
 
    """A subtrees parameterized Pack repository.
2564
 
 
2565
 
    This repository format uses the xml7 serializer to get:
2566
 
     - support for recording full info about the tree root
2567
 
     - support for recording tree-references
2568
 
 
2569
 
    This format was introduced in 0.92.
2570
 
    """
2571
 
 
2572
 
    repository_class = KnitPackRepository
2573
 
    _commit_builder_class = PackRootCommitBuilder
2574
 
    rich_root_data = True
2575
 
    supports_tree_reference = True
2576
 
    @property
2577
 
    def _serializer(self):
2578
 
        return xml7.serializer_v7
2579
 
    # What index classes to use
2580
 
    index_builder_class = InMemoryGraphIndex
2581
 
    index_class = GraphIndex
2582
 
 
2583
 
    def _get_matching_bzrdir(self):
2584
 
        return bzrdir.format_registry.make_bzrdir(
2585
 
            'pack-0.92-subtree')
2586
 
 
2587
 
    def _ignore_setting_bzrdir(self, format):
2588
 
        pass
2589
 
 
2590
 
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2591
 
 
2592
 
    def get_format_string(self):
2593
 
        """See RepositoryFormat.get_format_string()."""
2594
 
        return "Bazaar pack repository format 1 with subtree support (needs bzr 0.92)\n"
2595
 
 
2596
 
    def get_format_description(self):
2597
 
        """See RepositoryFormat.get_format_description()."""
2598
 
        return "Packs containing knits with subtree support\n"
2599
 
 
2600
 
 
2601
 
class RepositoryFormatKnitPack4(RepositoryFormatPack):
2602
 
    """A rich-root, no subtrees parameterized Pack repository.
2603
 
 
2604
 
    This repository format uses the xml6 serializer to get:
2605
 
     - support for recording full info about the tree root
2606
 
 
2607
 
    This format was introduced in 1.0.
2608
 
    """
2609
 
 
2610
 
    repository_class = KnitPackRepository
2611
 
    _commit_builder_class = PackRootCommitBuilder
2612
 
    rich_root_data = True
2613
 
    supports_tree_reference = False
2614
 
    @property
2615
 
    def _serializer(self):
2616
 
        return xml6.serializer_v6
2617
 
    # What index classes to use
2618
 
    index_builder_class = InMemoryGraphIndex
2619
 
    index_class = GraphIndex
2620
 
 
2621
 
    def _get_matching_bzrdir(self):
2622
 
        return bzrdir.format_registry.make_bzrdir(
2623
 
            'rich-root-pack')
2624
 
 
2625
 
    def _ignore_setting_bzrdir(self, format):
2626
 
        pass
2627
 
 
2628
 
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2629
 
 
2630
 
    def get_format_string(self):
2631
 
        """See RepositoryFormat.get_format_string()."""
2632
 
        return ("Bazaar pack repository format 1 with rich root"
2633
 
                " (needs bzr 1.0)\n")
2634
 
 
2635
 
    def get_format_description(self):
2636
 
        """See RepositoryFormat.get_format_description()."""
2637
 
        return "Packs containing knits with rich root support\n"
2638
 
 
2639
 
 
2640
 
class RepositoryFormatKnitPack5(RepositoryFormatPack):
2641
 
    """Repository that supports external references to allow stacking.
2642
 
 
2643
 
    New in release 1.6.
2644
 
 
2645
 
    Supports external lookups, which results in non-truncated ghosts after
2646
 
    reconcile compared to pack-0.92 formats.
2647
 
    """
2648
 
 
2649
 
    repository_class = KnitPackRepository
2650
 
    _commit_builder_class = PackCommitBuilder
2651
 
    supports_external_lookups = True
2652
 
    # What index classes to use
2653
 
    index_builder_class = InMemoryGraphIndex
2654
 
    index_class = GraphIndex
2655
 
 
2656
 
    @property
2657
 
    def _serializer(self):
2658
 
        return xml5.serializer_v5
2659
 
 
2660
 
    def _get_matching_bzrdir(self):
2661
 
        return bzrdir.format_registry.make_bzrdir('1.6')
2662
 
 
2663
 
    def _ignore_setting_bzrdir(self, format):
2664
 
        pass
2665
 
 
2666
 
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2667
 
 
2668
 
    def get_format_string(self):
2669
 
        """See RepositoryFormat.get_format_string()."""
2670
 
        return "Bazaar RepositoryFormatKnitPack5 (bzr 1.6)\n"
2671
 
 
2672
 
    def get_format_description(self):
2673
 
        """See RepositoryFormat.get_format_description()."""
2674
 
        return "Packs 5 (adds stacking support, requires bzr 1.6)"
2675
 
 
2676
 
 
2677
 
class RepositoryFormatKnitPack5RichRoot(RepositoryFormatPack):
2678
 
    """A repository with rich roots and stacking.
2679
 
 
2680
 
    New in release 1.6.1.
2681
 
 
2682
 
    Supports stacking on other repositories, allowing data to be accessed
2683
 
    without being stored locally.
2684
 
    """
2685
 
 
2686
 
    repository_class = KnitPackRepository
2687
 
    _commit_builder_class = PackRootCommitBuilder
2688
 
    rich_root_data = True
2689
 
    supports_tree_reference = False # no subtrees
2690
 
    supports_external_lookups = True
2691
 
    # What index classes to use
2692
 
    index_builder_class = InMemoryGraphIndex
2693
 
    index_class = GraphIndex
2694
 
 
2695
 
    @property
2696
 
    def _serializer(self):
2697
 
        return xml6.serializer_v6
2698
 
 
2699
 
    def _get_matching_bzrdir(self):
2700
 
        return bzrdir.format_registry.make_bzrdir(
2701
 
            '1.6.1-rich-root')
2702
 
 
2703
 
    def _ignore_setting_bzrdir(self, format):
2704
 
        pass
2705
 
 
2706
 
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2707
 
 
2708
 
    def get_format_string(self):
2709
 
        """See RepositoryFormat.get_format_string()."""
2710
 
        return "Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6.1)\n"
2711
 
 
2712
 
    def get_format_description(self):
2713
 
        return "Packs 5 rich-root (adds stacking support, requires bzr 1.6.1)"
2714
 
 
2715
 
 
2716
 
class RepositoryFormatKnitPack5RichRootBroken(RepositoryFormatPack):
2717
 
    """A repository with rich roots and external references.
2718
 
 
2719
 
    New in release 1.6.
2720
 
 
2721
 
    Supports external lookups, which results in non-truncated ghosts after
2722
 
    reconcile compared to pack-0.92 formats.
2723
 
 
2724
 
    This format was deprecated because the serializer it uses accidentally
2725
 
    supported subtrees, when the format was not intended to. This meant that
2726
 
    someone could accidentally fetch from an incorrect repository.
2727
 
    """
2728
 
 
2729
 
    repository_class = KnitPackRepository
2730
 
    _commit_builder_class = PackRootCommitBuilder
2731
 
    rich_root_data = True
2732
 
    supports_tree_reference = False # no subtrees
2733
 
 
2734
 
    supports_external_lookups = True
2735
 
    # What index classes to use
2736
 
    index_builder_class = InMemoryGraphIndex
2737
 
    index_class = GraphIndex
2738
 
 
2739
 
    @property
2740
 
    def _serializer(self):
2741
 
        return xml7.serializer_v7
2742
 
 
2743
 
    def _get_matching_bzrdir(self):
2744
 
        matching = bzrdir.format_registry.make_bzrdir(
2745
 
            '1.6.1-rich-root')
2746
 
        matching.repository_format = self
2747
 
        return matching
2748
 
 
2749
 
    def _ignore_setting_bzrdir(self, format):
2750
 
        pass
2751
 
 
2752
 
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2753
 
 
2754
 
    def get_format_string(self):
2755
 
        """See RepositoryFormat.get_format_string()."""
2756
 
        return "Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6)\n"
2757
 
 
2758
 
    def get_format_description(self):
2759
 
        return ("Packs 5 rich-root (adds stacking support, requires bzr 1.6)"
2760
 
                " (deprecated)")
2761
 
 
2762
 
 
2763
 
class RepositoryFormatKnitPack6(RepositoryFormatPack):
2764
 
    """A repository with stacking and btree indexes,
2765
 
    without rich roots or subtrees.
2766
 
 
2767
 
    This is equivalent to pack-1.6 with B+Tree indices.
2768
 
    """
2769
 
 
2770
 
    repository_class = KnitPackRepository
2771
 
    _commit_builder_class = PackCommitBuilder
2772
 
    supports_external_lookups = True
2773
 
    # What index classes to use
2774
 
    index_builder_class = BTreeBuilder
2775
 
    index_class = BTreeGraphIndex
2776
 
 
2777
 
    @property
2778
 
    def _serializer(self):
2779
 
        return xml5.serializer_v5
2780
 
 
2781
 
    def _get_matching_bzrdir(self):
2782
 
        return bzrdir.format_registry.make_bzrdir('1.9')
2783
 
 
2784
 
    def _ignore_setting_bzrdir(self, format):
2785
 
        pass
2786
 
 
2787
 
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2788
 
 
2789
 
    def get_format_string(self):
2790
 
        """See RepositoryFormat.get_format_string()."""
2791
 
        return "Bazaar RepositoryFormatKnitPack6 (bzr 1.9)\n"
2792
 
 
2793
 
    def get_format_description(self):
2794
 
        """See RepositoryFormat.get_format_description()."""
2795
 
        return "Packs 6 (uses btree indexes, requires bzr 1.9)"
2796
 
 
2797
 
 
2798
 
class RepositoryFormatKnitPack6RichRoot(RepositoryFormatPack):
2799
 
    """A repository with rich roots, no subtrees, stacking and btree indexes.
2800
 
 
2801
 
    1.6-rich-root with B+Tree indices.
2802
 
    """
2803
 
 
2804
 
    repository_class = KnitPackRepository
2805
 
    _commit_builder_class = PackRootCommitBuilder
2806
 
    rich_root_data = True
2807
 
    supports_tree_reference = False # no subtrees
2808
 
    supports_external_lookups = True
2809
 
    # What index classes to use
2810
 
    index_builder_class = BTreeBuilder
2811
 
    index_class = BTreeGraphIndex
2812
 
 
2813
 
    @property
2814
 
    def _serializer(self):
2815
 
        return xml6.serializer_v6
2816
 
 
2817
 
    def _get_matching_bzrdir(self):
2818
 
        return bzrdir.format_registry.make_bzrdir(
2819
 
            '1.9-rich-root')
2820
 
 
2821
 
    def _ignore_setting_bzrdir(self, format):
2822
 
        pass
2823
 
 
2824
 
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2825
 
 
2826
 
    def get_format_string(self):
2827
 
        """See RepositoryFormat.get_format_string()."""
2828
 
        return "Bazaar RepositoryFormatKnitPack6RichRoot (bzr 1.9)\n"
2829
 
 
2830
 
    def get_format_description(self):
2831
 
        return "Packs 6 rich-root (uses btree indexes, requires bzr 1.9)"
2832
 
 
2833
 
 
2834
 
class RepositoryFormatPackDevelopment2Subtree(RepositoryFormatPack):
2835
 
    """A subtrees development repository.
2836
 
 
2837
 
    This format should be retained until the second release after bzr 1.7.
2838
 
 
2839
 
    1.6.1-subtree[as it might have been] with B+Tree indices.
2840
 
 
2841
 
    This is [now] retained until we have a CHK based subtree format in
2842
 
    development.
2843
 
    """
2844
 
 
2845
 
    repository_class = KnitPackRepository
2846
 
    _commit_builder_class = PackRootCommitBuilder
2847
 
    rich_root_data = True
2848
 
    supports_tree_reference = True
2849
 
    supports_external_lookups = True
2850
 
    # What index classes to use
2851
 
    index_builder_class = BTreeBuilder
2852
 
    index_class = BTreeGraphIndex
2853
 
 
2854
 
    @property
2855
 
    def _serializer(self):
2856
 
        return xml7.serializer_v7
2857
 
 
2858
 
    def _get_matching_bzrdir(self):
2859
 
        return bzrdir.format_registry.make_bzrdir(
2860
 
            'development-subtree')
2861
 
 
2862
 
    def _ignore_setting_bzrdir(self, format):
2863
 
        pass
2864
 
 
2865
 
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
2866
 
 
2867
 
    def get_format_string(self):
2868
 
        """See RepositoryFormat.get_format_string()."""
2869
 
        return ("Bazaar development format 2 with subtree support "
2870
 
            "(needs bzr.dev from before 1.8)\n")
2871
 
 
2872
 
    def get_format_description(self):
2873
 
        """See RepositoryFormat.get_format_description()."""
2874
 
        return ("Development repository format, currently the same as "
2875
 
            "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
 
2876
2091