← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/fetch.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-02-26 03:15:58 UTC
  • mfrom: (4050.1.3 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20090226031558-1ubr618vdn4r5f07
(robertc) Fix race condition with branch hooks during cloning when
        the new branch is stacked. (Robert Collins)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/fetch.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2008 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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
 
18
18
"""Copying of history from one branch to another.
21
21
that has merged into it.  As the first step of a merge, pull, or
22
22
branch operation we copy history from the source into the destination
23
23
branch.
 
24
 
 
25
The copying is done in a slightly complicated order.  We don't want to
 
26
add a revision to the store until everything it refers to is also
 
27
stored, so that if a revision is present we can totally recreate it.
 
28
However, we can't know what files are included in a revision until we
 
29
read its inventory.  So we query the inventory store of the source for
 
30
the ids we need, and then pull those ids and then return to the inventories.
24
31
"""
25
32
 
26
33
import operator
27
34
 
28
 
from bzrlib.lazy_import import lazy_import
29
 
lazy_import(globals(), """
30
 
from bzrlib import (
31
 
    tsort,
32
 
    versionedfile,
33
 
    )
34
 
""")
35
35
import bzrlib
36
 
from bzrlib import (
37
 
    errors,
38
 
    ui,
39
 
    )
 
36
import bzrlib.errors as errors
 
37
from bzrlib.errors import InstallFailed
 
38
from bzrlib.progress import ProgressPhase
40
39
from bzrlib.revision import NULL_REVISION
 
40
from bzrlib.tsort import topo_sort
41
41
from bzrlib.trace import mutter
 
42
import bzrlib.ui
 
43
from bzrlib.versionedfile import filter_absent, FulltextContentFactory
 
44
 
 
45
# TODO: Avoid repeatedly opening weaves so many times.
 
46
 
 
47
# XXX: This doesn't handle ghost (not present in branch) revisions at
 
48
# all yet.  I'm not sure they really should be supported.
 
49
 
 
50
# NOTE: This doesn't copy revisions which may be present but not
 
51
# merged into the last revision.  I'm not sure we want to do that.
 
52
 
 
53
# - get a list of revisions that need to be pulled in
 
54
# - for each one, pull in that revision file
 
55
#   and get the inventory, and store the inventory with right
 
56
#   parents.
 
57
# - and get the ancestry, and store that with right parents too
 
58
# - and keep a note of all file ids and version seen
 
59
# - then go through all files; for each one get the weave,
 
60
#   and add in all file versions
42
61
 
43
62
 
44
63
class RepoFetcher(object):
45
64
    """Pull revisions and texts from one repository to another.
46
65
 
 
66
    last_revision
 
67
        if set, try to limit to the data this revision references.
 
68
 
 
69
    after running:
 
70
    count_copied -- number of revisions copied
 
71
 
47
72
    This should not be used directly, it's essential a object to encapsulate
48
73
    the logic in InterRepository.fetch().
49
74
    """
50
75
 
51
 
    def __init__(self, to_repository, from_repository, last_revision=None,
52
 
        find_ghosts=True, fetch_spec=None):
 
76
    def __init__(self, to_repository, from_repository, last_revision=None, pb=None,
 
77
        find_ghosts=True):
53
78
        """Create a repo fetcher.
54
79
 
55
 
        :param last_revision: If set, try to limit to the data this revision
56
 
            references.
57
80
        :param find_ghosts: If True search the entire history for ghosts.
 
81
        :param _write_group_acquired_callable: Don't use; this parameter only
 
82
            exists to facilitate a hack done in InterPackRepo.fetch.  We would
 
83
            like to remove this parameter.
58
84
        """
59
 
        # repository.fetch has the responsibility for short-circuiting
60
 
        # attempts to copy between a repository and itself.
 
85
        # result variables.
 
86
        self.failed_revisions = []
 
87
        self.count_copied = 0
 
88
        if to_repository.has_same_location(from_repository):
 
89
            # repository.fetch should be taking care of this case.
 
90
            raise errors.BzrError('RepoFetcher run '
 
91
                    'between two objects at the same location: '
 
92
                    '%r and %r' % (to_repository, from_repository))
61
93
        self.to_repository = to_repository
62
94
        self.from_repository = from_repository
63
95
        self.sink = to_repository._get_sink()
64
96
        # must not mutate self._last_revision as its potentially a shared instance
65
97
        self._last_revision = last_revision
66
 
        self._fetch_spec = fetch_spec
67
98
        self.find_ghosts = find_ghosts
 
99
        if pb is None:
 
100
            self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
101
            self.nested_pb = self.pb
 
102
        else:
 
103
            self.pb = pb
 
104
            self.nested_pb = None
68
105
        self.from_repository.lock_read()
69
 
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
70
 
               self.from_repository, self.from_repository._format,
71
 
               self.to_repository, self.to_repository._format)
72
106
        try:
73
 
            self.__fetch()
 
107
            try:
 
108
                self.__fetch()
 
109
            finally:
 
110
                if self.nested_pb is not None:
 
111
                    self.nested_pb.finished()
74
112
        finally:
75
113
            self.from_repository.unlock()
76
114
 
88
126
        # assert not missing
89
127
        self.count_total = 0
90
128
        self.file_ids_names = {}
91
 
        pb = ui.ui_factory.nested_progress_bar()
92
 
        pb.show_pct = pb.show_count = False
 
129
        pp = ProgressPhase('Transferring', 4, self.pb)
93
130
        try:
94
 
            pb.update("Finding revisions", 0, 2)
 
131
            pp.next_phase()
95
132
            search = self._revids_to_fetch()
96
133
            if search is None:
97
134
                return
98
 
            pb.update("Fetching revisions", 1, 2)
99
 
            self._fetch_everything_for_search(search)
 
135
            self._fetch_everything_for_search(search, pp)
100
136
        finally:
101
 
            pb.finished()
 
137
            self.pb.clear()
102
138
 
103
 
    def _fetch_everything_for_search(self, search):
 
139
    def _fetch_everything_for_search(self, search, pp):
104
140
        """Fetch all data for the given set of revisions."""
105
141
        # The first phase is "file".  We pass the progress bar for it directly
106
142
        # into item_keys_introduced_by, which has more information about how
110
146
        # item_keys_introduced_by should have a richer API than it does at the
111
147
        # moment, so that it can feed the progress information back to this
112
148
        # function?
113
 
        if (self.from_repository._format.rich_root_data and
114
 
            not self.to_repository._format.rich_root_data):
115
 
            raise errors.IncompatibleRepositories(
116
 
                self.from_repository, self.to_repository,
117
 
                "different rich-root support")
118
 
        pb = ui.ui_factory.nested_progress_bar()
 
149
        self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
119
150
        try:
120
 
            pb.update("Get stream source")
121
 
            source = self.from_repository._get_source(
122
 
                self.to_repository._format)
123
 
            stream = source.get_stream(search)
124
151
            from_format = self.from_repository._format
125
 
            pb.update("Inserting stream")
 
152
            stream = self.get_stream(search, pp)
126
153
            resume_tokens, missing_keys = self.sink.insert_stream(
127
154
                stream, from_format, [])
128
 
            if self.to_repository._fallback_repositories:
129
 
                missing_keys.update(
130
 
                    self._parent_inventories(search.get_keys()))
131
155
            if missing_keys:
132
 
                pb.update("Missing keys")
133
 
                stream = source.get_stream_for_missing_keys(missing_keys)
134
 
                pb.update("Inserting missing keys")
 
156
                stream = self.get_stream_for_missing_keys(missing_keys)
135
157
                resume_tokens, missing_keys = self.sink.insert_stream(
136
158
                    stream, from_format, resume_tokens)
137
159
            if missing_keys:
142
164
                raise AssertionError(
143
165
                    "second push failed to commit the fetch %r." % (
144
166
                        resume_tokens,))
145
 
            pb.update("Finishing stream")
146
167
            self.sink.finished()
147
168
        finally:
148
 
            pb.finished()
 
169
            if self.pb is not None:
 
170
                self.pb.finished()
 
171
 
 
172
    def get_stream(self, search, pp):
 
173
        phase = 'file'
 
174
        revs = search.get_keys()
 
175
        graph = self.from_repository.get_graph()
 
176
        revs = list(graph.iter_topo_order(revs))
 
177
        data_to_fetch = self.from_repository.item_keys_introduced_by(
 
178
            revs, self.pb)
 
179
        text_keys = []
 
180
        for knit_kind, file_id, revisions in data_to_fetch:
 
181
            if knit_kind != phase:
 
182
                phase = knit_kind
 
183
                # Make a new progress bar for this phase
 
184
                self.pb.finished()
 
185
                pp.next_phase()
 
186
                self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
187
            if knit_kind == "file":
 
188
                # Accumulate file texts
 
189
                text_keys.extend([(file_id, revision) for revision in
 
190
                    revisions])
 
191
            elif knit_kind == "inventory":
 
192
                # Now copy the file texts.
 
193
                from_texts = self.from_repository.texts
 
194
                yield ('texts', from_texts.get_record_stream(
 
195
                    text_keys, self.to_repository._fetch_order,
 
196
                    not self.to_repository._fetch_uses_deltas))
 
197
                # Cause an error if a text occurs after we have done the
 
198
                # copy.
 
199
                text_keys = None
 
200
                # Before we process the inventory we generate the root
 
201
                # texts (if necessary) so that the inventories references
 
202
                # will be valid.
 
203
                for _ in self._generate_root_texts(revs):
 
204
                    yield _
 
205
                # NB: This currently reopens the inventory weave in source;
 
206
                # using a single stream interface instead would avoid this.
 
207
                self.pb.update("fetch inventory", 0, 1)
 
208
                from_weave = self.from_repository.inventories
 
209
                # we fetch only the referenced inventories because we do not
 
210
                # know for unselected inventories whether all their required
 
211
                # texts are present in the other repository - it could be
 
212
                # corrupt.
 
213
                yield ('inventories', from_weave.get_record_stream(
 
214
                    [(rev_id,) for rev_id in revs],
 
215
                    self.inventory_fetch_order(),
 
216
                    not self.delta_on_metadata()))
 
217
            elif knit_kind == "signatures":
 
218
                # Nothing to do here; this will be taken care of when
 
219
                # _fetch_revision_texts happens.
 
220
                pass
 
221
            elif knit_kind == "revisions":
 
222
                for _ in self._fetch_revision_texts(revs, self.pb):
 
223
                    yield _
 
224
            else:
 
225
                raise AssertionError("Unknown knit kind %r" % knit_kind)
 
226
        self.count_copied += len(revs)
 
227
 
 
228
    def get_stream_for_missing_keys(self, missing_keys):
 
229
        # missing keys can only occur when we are byte copying and not
 
230
        # translating (because translation means we don't send
 
231
        # unreconstructable deltas ever).
 
232
        keys = {}
 
233
        keys['texts'] = set()
 
234
        keys['revisions'] = set()
 
235
        keys['inventories'] = set()
 
236
        keys['signatures'] = set()
 
237
        for key in missing_keys:
 
238
            keys[key[0]].add(key[1:])
 
239
        if len(keys['revisions']):
 
240
            # If we allowed copying revisions at this point, we could end up
 
241
            # copying a revision without copying its required texts: a
 
242
            # violation of the requirements for repository integrity.
 
243
            raise AssertionError(
 
244
                'cannot copy revisions to fill in missing deltas %s' % (
 
245
                    keys['revisions'],))
 
246
        for substream_kind, keys in keys.iteritems():
 
247
            vf = getattr(self.from_repository, substream_kind)
 
248
            # Ask for full texts always so that we don't need more round trips
 
249
            # after this stream.
 
250
            stream = vf.get_record_stream(keys,
 
251
                self.to_repository._fetch_order, True)
 
252
            yield substream_kind, stream
149
253
 
150
254
    def _revids_to_fetch(self):
151
255
        """Determines the exact revisions needed from self.from_repository to
153
257
 
154
258
        If no revisions need to be fetched, then this just returns None.
155
259
        """
156
 
        if self._fetch_spec is not None:
157
 
            return self._fetch_spec
158
260
        mutter('fetch up to rev {%s}', self._last_revision)
159
261
        if self._last_revision is NULL_REVISION:
160
262
            # explicit limit of no revisions needed
161
263
            return None
162
 
        return self.to_repository.search_missing_revision_ids(
163
 
            self.from_repository, self._last_revision,
164
 
            find_ghosts=self.find_ghosts)
165
 
 
166
 
    def _parent_inventories(self, revision_ids):
167
 
        # Find all the parent revisions referenced by the stream, but
168
 
        # not present in the stream, and make sure we send their
169
 
        # inventories.
170
 
        parent_maps = self.to_repository.get_parent_map(revision_ids)
171
 
        parents = set()
172
 
        map(parents.update, parent_maps.itervalues())
173
 
        parents.discard(NULL_REVISION)
174
 
        parents.difference_update(revision_ids)
175
 
        missing_keys = set(('inventories', rev_id) for rev_id in parents)
176
 
        return missing_keys
 
264
        if (self._last_revision is not None and
 
265
            self.to_repository.has_revision(self._last_revision)):
 
266
            return None
 
267
        try:
 
268
            return self.to_repository.search_missing_revision_ids(
 
269
                self.from_repository, self._last_revision,
 
270
                find_ghosts=self.find_ghosts)
 
271
        except errors.NoSuchRevision, e:
 
272
            raise InstallFailed([self._last_revision])
 
273
 
 
274
    def _fetch_revision_texts(self, revs, pb):
 
275
        # fetch signatures first and then the revision texts
 
276
        # may need to be a InterRevisionStore call here.
 
277
        from_sf = self.from_repository.signatures
 
278
        # A missing signature is just skipped.
 
279
        keys = [(rev_id,) for rev_id in revs]
 
280
        signatures = filter_absent(from_sf.get_record_stream(
 
281
            keys,
 
282
            self.to_repository._fetch_order,
 
283
            not self.to_repository._fetch_uses_deltas))
 
284
        # If a revision has a delta, this is actually expanded inside the
 
285
        # insert_record_stream code now, which is an alternate fix for
 
286
        # bug #261339
 
287
        from_rf = self.from_repository.revisions
 
288
        revisions = from_rf.get_record_stream(
 
289
            keys,
 
290
            self.to_repository._fetch_order,
 
291
            not self.delta_on_metadata())
 
292
        return [('signatures', signatures), ('revisions', revisions)]
 
293
 
 
294
    def _generate_root_texts(self, revs):
 
295
        """This will be called by __fetch between fetching weave texts and
 
296
        fetching the inventory weave.
 
297
 
 
298
        Subclasses should override this if they need to generate root texts
 
299
        after fetching weave texts.
 
300
        """
 
301
        return []
 
302
 
 
303
    def inventory_fetch_order(self):
 
304
        return self.to_repository._fetch_order
 
305
 
 
306
    def delta_on_metadata(self):
 
307
        src_serializer = self.from_repository._format._serializer
 
308
        target_serializer = self.to_repository._format._serializer
 
309
        return (self.to_repository._fetch_uses_deltas and
 
310
            src_serializer == target_serializer)
177
311
 
178
312
 
179
313
class Inter1and2Helper(object):
210
344
 
211
345
    def _find_root_ids(self, revs, parent_map, graph):
212
346
        revision_root = {}
 
347
        planned_versions = {}
213
348
        for tree in self.iter_rev_trees(revs):
214
349
            revision_id = tree.inventory.root.revision
215
350
            root_id = tree.get_root_id()
 
351
            planned_versions.setdefault(root_id, []).append(revision_id)
216
352
            revision_root[revision_id] = root_id
217
353
        # Find out which parents we don't already know root ids for
218
354
        parents = set()
224
360
        for tree in self.iter_rev_trees(parents):
225
361
            root_id = tree.get_root_id()
226
362
            revision_root[tree.get_revision_id()] = root_id
227
 
        return revision_root
 
363
        return revision_root, planned_versions
228
364
 
229
365
    def generate_root_texts(self, revs):
230
366
        """Generate VersionedFiles for all root ids.
233
369
        """
234
370
        graph = self.source.get_graph()
235
371
        parent_map = graph.get_parent_map(revs)
236
 
        rev_order = tsort.topo_sort(parent_map)
237
 
        rev_id_to_root_id = self._find_root_ids(revs, parent_map, graph)
 
372
        rev_order = topo_sort(parent_map)
 
373
        rev_id_to_root_id, root_id_to_rev_ids = self._find_root_ids(
 
374
            revs, parent_map, graph)
238
375
        root_id_order = [(rev_id_to_root_id[rev_id], rev_id) for rev_id in
239
376
            rev_order]
240
377
        # Guaranteed stable, this groups all the file id operations together
243
380
        # yet, and are unlikely to in non-rich-root environments anyway.
244
381
        root_id_order.sort(key=operator.itemgetter(0))
245
382
        # Create a record stream containing the roots to create.
246
 
        if len(revs) > 100:
247
 
            # XXX: not covered by tests, should have a flag to always run
248
 
            # this. -- mbp 20100129
249
 
            graph = self.source_repo.get_known_graph_ancestry(revs)
250
 
        new_roots_stream = _new_root_data_stream(
251
 
            root_id_order, rev_id_to_root_id, parent_map, self.source, graph)
252
 
        return [('texts', new_roots_stream)]
253
 
 
254
 
 
255
 
def _get_rich_root_heads_graph(source_repo, revision_ids):
256
 
    """Get a Graph object suitable for asking heads() for new rich roots."""
257
 
    return 
258
 
 
259
 
 
260
 
def _new_root_data_stream(
261
 
    root_keys_to_create, rev_id_to_root_id_map, parent_map, repo, graph=None):
262
 
    """Generate a texts substream of synthesised root entries.
263
 
 
264
 
    Used in fetches that do rich-root upgrades.
265
 
    
266
 
    :param root_keys_to_create: iterable of (root_id, rev_id) pairs describing
267
 
        the root entries to create.
268
 
    :param rev_id_to_root_id_map: dict of known rev_id -> root_id mappings for
269
 
        calculating the parents.  If a parent rev_id is not found here then it
270
 
        will be recalculated.
271
 
    :param parent_map: a parent map for all the revisions in
272
 
        root_keys_to_create.
273
 
    :param graph: a graph to use instead of repo.get_graph().
274
 
    """
275
 
    for root_key in root_keys_to_create:
276
 
        root_id, rev_id = root_key
277
 
        parent_keys = _parent_keys_for_root_version(
278
 
            root_id, rev_id, rev_id_to_root_id_map, parent_map, repo, graph)
279
 
        yield versionedfile.FulltextContentFactory(
280
 
            root_key, parent_keys, None, '')
281
 
 
282
 
 
283
 
def _parent_keys_for_root_version(
284
 
    root_id, rev_id, rev_id_to_root_id_map, parent_map, repo, graph=None):
285
 
    """Get the parent keys for a given root id.
286
 
    
287
 
    A helper function for _new_root_data_stream.
288
 
    """
289
 
    # Include direct parents of the revision, but only if they used the same
290
 
    # root_id and are heads.
291
 
    rev_parents = parent_map[rev_id]
292
 
    parent_ids = []
293
 
    for parent_id in rev_parents:
294
 
        if parent_id == NULL_REVISION:
295
 
            continue
296
 
        if parent_id not in rev_id_to_root_id_map:
297
 
            # We probably didn't read this revision, go spend the extra effort
298
 
            # to actually check
299
 
            try:
300
 
                tree = repo.revision_tree(parent_id)
301
 
            except errors.NoSuchRevision:
302
 
                # Ghost, fill out rev_id_to_root_id in case we encounter this
303
 
                # again.
304
 
                # But set parent_root_id to None since we don't really know
305
 
                parent_root_id = None
306
 
            else:
307
 
                parent_root_id = tree.get_root_id()
308
 
            rev_id_to_root_id_map[parent_id] = None
309
 
            # XXX: why not:
310
 
            #   rev_id_to_root_id_map[parent_id] = parent_root_id
311
 
            # memory consumption maybe?
312
 
        else:
313
 
            parent_root_id = rev_id_to_root_id_map[parent_id]
314
 
        if root_id == parent_root_id:
315
 
            # With stacking we _might_ want to refer to a non-local revision,
316
 
            # but this code path only applies when we have the full content
317
 
            # available, so ghosts really are ghosts, not just the edge of
318
 
            # local data.
319
 
            parent_ids.append(parent_id)
320
 
        else:
321
 
            # root_id may be in the parent anyway.
322
 
            try:
323
 
                tree = repo.revision_tree(parent_id)
324
 
            except errors.NoSuchRevision:
325
 
                # ghost, can't refer to it.
326
 
                pass
327
 
            else:
328
 
                try:
329
 
                    parent_ids.append(tree.inventory[root_id].revision)
330
 
                except errors.NoSuchId:
331
 
                    # not in the tree
332
 
                    pass
333
 
    # Drop non-head parents
334
 
    if graph is None:
335
 
        graph = repo.get_graph()
336
 
    heads = graph.heads(parent_ids)
337
 
    selected_ids = []
338
 
    for parent_id in parent_ids:
339
 
        if parent_id in heads and parent_id not in selected_ids:
340
 
            selected_ids.append(parent_id)
341
 
    parent_keys = [(root_id, parent_id) for parent_id in selected_ids]
342
 
    return parent_keys
 
383
        def yield_roots():
 
384
            for key in root_id_order:
 
385
                root_id, rev_id = key
 
386
                rev_parents = parent_map[rev_id]
 
387
                # We drop revision parents with different file-ids, because
 
388
                # that represents a rename of the root to a different location
 
389
                # - its not actually a parent for us. (We could look for that
 
390
                # file id in the revision tree at considerably more expense,
 
391
                # but for now this is sufficient (and reconcile will catch and
 
392
                # correct this anyway).
 
393
                # When a parent revision is a ghost, we guess that its root id
 
394
                # was unchanged (rather than trimming it from the parent list).
 
395
                parent_keys = tuple((root_id, parent) for parent in rev_parents
 
396
                    if parent != NULL_REVISION and
 
397
                        rev_id_to_root_id.get(parent, root_id) == root_id)
 
398
                yield FulltextContentFactory(key, parent_keys, None, '')
 
399
        return [('texts', yield_roots())]
 
400
 
 
401
 
 
402
class Model1toKnit2Fetcher(RepoFetcher):
 
403
    """Fetch from a Model1 repository into a Knit2 repository
 
404
    """
 
405
    def __init__(self, to_repository, from_repository, last_revision=None,
 
406
                 pb=None, find_ghosts=True):
 
407
        self.helper = Inter1and2Helper(from_repository)
 
408
        RepoFetcher.__init__(self, to_repository, from_repository,
 
409
            last_revision, pb, find_ghosts)
 
410
 
 
411
    def _generate_root_texts(self, revs):
 
412
        return self.helper.generate_root_texts(revs)
 
413
 
 
414
    def inventory_fetch_order(self):
 
415
        return 'topological'
 
416
 
 
417
Knit1to2Fetcher = Model1toKnit2Fetcher