/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar
5557.1.7 by John Arbash Meinel
Merge in the bzr.dev 5582
1
# Copyright (C) 2007-2011 Canonical Ltd
2490.2.5 by Aaron Bentley
Use GraphWalker.unique_ancestor to determine merge base
2
#
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
7
#
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
# GNU General Public License for more details.
12
#
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
4183.7.1 by Sabin Iacob
update FSF mailing address
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
2490.2.5 by Aaron Bentley
Use GraphWalker.unique_ancestor to determine merge base
16
6379.6.3 by Jelmer Vernooij
Use absolute_import.
17
from __future__ import absolute_import
18
3377.4.5 by John Arbash Meinel
Several updates. A bit more debug logging, only step the all_unique searcher 1/10th of the time.
19
import time
20
6624 by Jelmer Vernooij
Merge Python3 porting work ('py3 pokes')
21
from . import (
3377.3.33 by John Arbash Meinel
Add some logging with -Dgraph
22
    debug,
2490.2.30 by Aaron Bentley
Add functionality for tsorting graphs
23
    errors,
4574.3.6 by Martin Pool
More warnings when failing to load extensions
24
    osutils,
3052.1.3 by John Arbash Meinel
deprecate revision.is_ancestor, update the callers and the tests.
25
    revision,
3377.3.10 by John Arbash Meinel
Tweak _BreadthFirstSearcher.find_seen_ancestors()
26
    trace,
2490.2.30 by Aaron Bentley
Add functionality for tsorting graphs
27
    )
6656.1.1 by Martin
Apply 2to3 dict fixer and clean up resulting mess using view helpers
28
from .sixish import (
29
    viewitems,
30
    viewvalues,
31
    )
2490.2.1 by Aaron Bentley
Start work on GraphWalker
32
3377.4.9 by John Arbash Meinel
STEP every 5
33
STEP_UNIQUE_SEARCHER_EVERY = 5
3377.4.5 by John Arbash Meinel
Several updates. A bit more debug logging, only step the all_unique searcher 1/10th of the time.
34
2490.2.25 by Aaron Bentley
Update from review
35
# DIAGRAM of terminology
36
#       A
37
#       /\
38
#      B  C
39
#      |  |\
40
#      D  E F
41
#      |\/| |
42
#      |/\|/
43
#      G  H
44
#
45
# In this diagram, relative to G and H:
46
# A, B, C, D, E are common ancestors.
47
# C, D and E are border ancestors, because each has a non-common descendant.
48
# D and E are least common ancestors because none of their descendants are
49
# common ancestors.
50
# C is not a least common ancestor because its descendant, E, is a common
51
# ancestor.
52
#
53
# The find_unique_lca algorithm will pick A in two steps:
54
# 1. find_lca('G', 'H') => ['D', 'E']
55
# 2. Since len(['D', 'E']) > 1, find_lca('D', 'E') => ['A']
56
57
2988.1.3 by Robert Collins
Add a new repositoy method _generate_text_key_index for use by reconcile/check.
58
class DictParentsProvider(object):
3172.1.2 by Robert Collins
Parent Providers should now implement ``get_parent_map`` returning a
59
    """A parents provider for Graph objects."""
2988.1.3 by Robert Collins
Add a new repositoy method _generate_text_key_index for use by reconcile/check.
60
61
    def __init__(self, ancestry):
62
        self.ancestry = ancestry
63
64
    def __repr__(self):
65
        return 'DictParentsProvider(%r)' % self.ancestry
66
6015.24.8 by John Arbash Meinel
Some cleanups suggested by Vincent.
67
    # Note: DictParentsProvider does not implement get_cached_parent_map
68
    #       Arguably, the data is clearly cached in memory. However, this class
69
    #       is mostly used for testing, and it keeps the tests clean to not
70
    #       change it.
71
3099.3.1 by John Arbash Meinel
Implement get_parent_map for ParentProviders
72
    def get_parent_map(self, keys):
4379.3.3 by Gary van der Merwe
Rename and add doc string for StackedParentsProvider.
73
        """See StackedParentsProvider.get_parent_map"""
3099.3.1 by John Arbash Meinel
Implement get_parent_map for ParentProviders
74
        ancestry = self.ancestry
6015.23.10 by John Arbash Meinel
Small tweaks to search performance, though still at depth=100 the primary time
75
        return dict([(k, ancestry[k]) for k in keys if k in ancestry])
3099.3.1 by John Arbash Meinel
Implement get_parent_map for ParentProviders
76
2490.2.5 by Aaron Bentley
Use GraphWalker.unique_ancestor to determine merge base
77
4379.3.3 by Gary van der Merwe
Rename and add doc string for StackedParentsProvider.
78
class StackedParentsProvider(object):
79
    """A parents provider which stacks (or unions) multiple providers.
6015.24.3 by John Arbash Meinel
Implement get_cached_parent_map
80
4379.3.3 by Gary van der Merwe
Rename and add doc string for StackedParentsProvider.
81
    The providers are queries in the order of the provided parent_providers.
82
    """
6015.24.3 by John Arbash Meinel
Implement get_cached_parent_map
83
2490.2.13 by Aaron Bentley
Update distinct -> lowest, refactor, add ParentsProvider concept
84
    def __init__(self, parent_providers):
85
        self._parent_providers = parent_providers
86
2490.2.28 by Aaron Bentley
Fix handling of null revision
87
    def __repr__(self):
4379.3.4 by Gary van der Merwe
Make StackedParentsProvider.__repr__ more dynamic.
88
        return "%s(%r)" % (self.__class__.__name__, self._parent_providers)
2490.2.28 by Aaron Bentley
Fix handling of null revision
89
3099.3.1 by John Arbash Meinel
Implement get_parent_map for ParentProviders
90
    def get_parent_map(self, keys):
91
        """Get a mapping of keys => parents
92
93
        A dictionary is returned with an entry for each key present in this
94
        source. If this source doesn't have information about a key, it should
95
        not include an entry.
96
97
        [NULL_REVISION] is used as the parent of the first user-committed
98
        revision.  Its parent list is empty.
99
100
        :param keys: An iterable returning keys to check (eg revision_ids)
101
        :return: A dictionary mapping each key to its parents
102
        """
2490.2.13 by Aaron Bentley
Update distinct -> lowest, refactor, add ParentsProvider concept
103
        found = {}
3099.3.1 by John Arbash Meinel
Implement get_parent_map for ParentProviders
104
        remaining = set(keys)
6015.24.9 by John Arbash Meinel
Discuss why the extra getattr() calls should be fine.
105
        # This adds getattr() overhead to each get_parent_map call. However,
106
        # this is StackedParentsProvider, which means we're dealing with I/O
107
        # (either local indexes, or remote RPCs), so CPU overhead should be
108
        # minimal.
6015.24.3 by John Arbash Meinel
Implement get_cached_parent_map
109
        for parents_provider in self._parent_providers:
110
            get_cached = getattr(parents_provider, 'get_cached_parent_map',
111
                                 None)
112
            if get_cached is None:
113
                continue
114
            new_found = get_cached(remaining)
115
            found.update(new_found)
116
            remaining.difference_update(new_found)
117
            if not remaining:
118
                break
119
        if not remaining:
120
            return found
2490.2.13 by Aaron Bentley
Update distinct -> lowest, refactor, add ParentsProvider concept
121
        for parents_provider in self._parent_providers:
3099.3.1 by John Arbash Meinel
Implement get_parent_map for ParentProviders
122
            new_found = parents_provider.get_parent_map(remaining)
2490.2.13 by Aaron Bentley
Update distinct -> lowest, refactor, add ParentsProvider concept
123
            found.update(new_found)
3099.3.1 by John Arbash Meinel
Implement get_parent_map for ParentProviders
124
            remaining.difference_update(new_found)
125
            if not remaining:
2490.2.13 by Aaron Bentley
Update distinct -> lowest, refactor, add ParentsProvider concept
126
                break
3099.3.1 by John Arbash Meinel
Implement get_parent_map for ParentProviders
127
        return found
128
129
130
class CachingParentsProvider(object):
3835.1.13 by Aaron Bentley
Update documentation
131
    """A parents provider which will cache the revision => parents as a dict.
132
133
    This is useful for providers which have an expensive look up.
134
135
    Either a ParentsProvider or a get_parent_map-like callback may be
136
    supplied.  If it provides extra un-asked-for parents, they will be cached,
137
    but filtered out of get_parent_map.
3835.1.16 by Aaron Bentley
Updates from review
138
139
    The cache is enabled by default, but may be disabled and re-enabled.
3835.1.10 by Aaron Bentley
Move CachingExtraParentsProvider to Graph
140
    """
3896.1.1 by Andrew Bennetts
Remove broken debugging cruft, and some unused imports.
141
    def __init__(self, parent_provider=None, get_parent_map=None):
3835.1.13 by Aaron Bentley
Update documentation
142
        """Constructor.
143
144
        :param parent_provider: The ParentProvider to use.  It or
145
            get_parent_map must be supplied.
146
        :param get_parent_map: The get_parent_map callback to use.  It or
147
            parent_provider must be supplied.
148
        """
3835.1.12 by Aaron Bentley
Unify CachingExtraParentsProvider and CachingParentsProvider.
149
        self._real_provider = parent_provider
150
        if get_parent_map is None:
151
            self._get_parent_map = self._real_provider.get_parent_map
152
        else:
153
            self._get_parent_map = get_parent_map
4190.1.1 by Robert Collins
Negatively cache misses during read-locks in RemoteRepository.
154
        self._cache = None
155
        self.enable_cache(True)
3835.1.10 by Aaron Bentley
Move CachingExtraParentsProvider to Graph
156
3835.1.12 by Aaron Bentley
Unify CachingExtraParentsProvider and CachingParentsProvider.
157
    def __repr__(self):
158
        return "%s(%r)" % (self.__class__.__name__, self._real_provider)
159
3835.1.15 by Aaron Bentley
Allow miss caching to be disabled.
160
    def enable_cache(self, cache_misses=True):
3835.1.10 by Aaron Bentley
Move CachingExtraParentsProvider to Graph
161
        """Enable cache."""
3835.1.19 by Aaron Bentley
Raise exception when caching is enabled twice.
162
        if self._cache is not None:
3835.1.20 by Aaron Bentley
Change custom error to an AssertionError.
163
            raise AssertionError('Cache enabled when already enabled.')
3835.1.16 by Aaron Bentley
Updates from review
164
        self._cache = {}
3835.1.15 by Aaron Bentley
Allow miss caching to be disabled.
165
        self._cache_misses = cache_misses
4190.1.4 by Robert Collins
Cache ghosts when we can get them from a RemoteRepository in get_parent_map.
166
        self.missing_keys = set()
3835.1.10 by Aaron Bentley
Move CachingExtraParentsProvider to Graph
167
168
    def disable_cache(self):
3835.1.16 by Aaron Bentley
Updates from review
169
        """Disable and clear the cache."""
170
        self._cache = None
4190.1.1 by Robert Collins
Negatively cache misses during read-locks in RemoteRepository.
171
        self._cache_misses = None
4190.1.4 by Robert Collins
Cache ghosts when we can get them from a RemoteRepository in get_parent_map.
172
        self.missing_keys = set()
3835.1.10 by Aaron Bentley
Move CachingExtraParentsProvider to Graph
173
174
    def get_cached_map(self):
175
        """Return any cached get_parent_map values."""
3835.1.16 by Aaron Bentley
Updates from review
176
        if self._cache is None:
3835.1.12 by Aaron Bentley
Unify CachingExtraParentsProvider and CachingParentsProvider.
177
            return None
4190.1.1 by Robert Collins
Negatively cache misses during read-locks in RemoteRepository.
178
        return dict(self._cache)
3835.1.10 by Aaron Bentley
Move CachingExtraParentsProvider to Graph
179
6015.24.3 by John Arbash Meinel
Implement get_cached_parent_map
180
    def get_cached_parent_map(self, keys):
6015.24.7 by John Arbash Meinel
Update some comments and docstrings.
181
        """Return items from the cache.
182
183
        This returns the same info as get_parent_map, but explicitly does not
184
        invoke the supplied ParentsProvider to search for uncached values.
185
        """
6015.24.3 by John Arbash Meinel
Implement get_cached_parent_map
186
        cache = self._cache
187
        if cache is None:
188
            return {}
189
        return dict([(key, cache[key]) for key in keys if key in cache])
190
3835.1.10 by Aaron Bentley
Move CachingExtraParentsProvider to Graph
191
    def get_parent_map(self, keys):
4379.3.3 by Gary van der Merwe
Rename and add doc string for StackedParentsProvider.
192
        """See StackedParentsProvider.get_parent_map."""
4190.1.1 by Robert Collins
Negatively cache misses during read-locks in RemoteRepository.
193
        cache = self._cache
194
        if cache is None:
195
            cache = self._get_parent_map(keys)
3835.1.10 by Aaron Bentley
Move CachingExtraParentsProvider to Graph
196
        else:
4190.1.1 by Robert Collins
Negatively cache misses during read-locks in RemoteRepository.
197
            needed_revisions = set(key for key in keys if key not in cache)
198
            # Do not ask for negatively cached keys
4190.1.4 by Robert Collins
Cache ghosts when we can get them from a RemoteRepository in get_parent_map.
199
            needed_revisions.difference_update(self.missing_keys)
4190.1.1 by Robert Collins
Negatively cache misses during read-locks in RemoteRepository.
200
            if needed_revisions:
201
                parent_map = self._get_parent_map(needed_revisions)
202
                cache.update(parent_map)
203
                if self._cache_misses:
204
                    for key in needed_revisions:
205
                        if key not in parent_map:
4190.1.4 by Robert Collins
Cache ghosts when we can get them from a RemoteRepository in get_parent_map.
206
                            self.note_missing_key(key)
4190.1.1 by Robert Collins
Negatively cache misses during read-locks in RemoteRepository.
207
        result = {}
208
        for key in keys:
209
            value = cache.get(key)
210
            if value is not None:
211
                result[key] = value
212
        return result
3835.1.10 by Aaron Bentley
Move CachingExtraParentsProvider to Graph
213
4190.1.4 by Robert Collins
Cache ghosts when we can get them from a RemoteRepository in get_parent_map.
214
    def note_missing_key(self, key):
215
        """Note that key is a missing key."""
216
        if self._cache_misses:
217
            self.missing_keys.add(key)
218
3835.1.10 by Aaron Bentley
Move CachingExtraParentsProvider to Graph
219
5816.8.1 by Andrew Bennetts
Be a little more clever about constructing a parents provider for stacked repositories, so that get_parent_map with local-stacked-on-remote doesn't use HPSS VFS calls.
220
class CallableToParentsProviderAdapter(object):
221
    """A parents provider that adapts any callable to the parents provider API.
222
223
    i.e. it accepts calls to self.get_parent_map and relays them to the
224
    callable it was constructed with.
225
    """
226
227
    def __init__(self, a_callable):
228
        self.callable = a_callable
229
230
    def __repr__(self):
231
        return "%s(%r)" % (self.__class__.__name__, self.callable)
232
233
    def get_parent_map(self, keys):
234
        return self.callable(keys)
235
236
2490.2.22 by Aaron Bentley
Rename GraphWalker -> Graph, _AncestryWalker -> _BreadthFirstSearcher
237
class Graph(object):
2490.2.10 by Aaron Bentley
Clarify text, remove unused _get_ancestry method
238
    """Provide incremental access to revision graphs.
239
240
    This is the generic implementation; it is intended to be subclassed to
241
    specialize it for other repository types.
242
    """
2490.2.1 by Aaron Bentley
Start work on GraphWalker
243
2490.2.13 by Aaron Bentley
Update distinct -> lowest, refactor, add ParentsProvider concept
244
    def __init__(self, parents_provider):
2490.2.22 by Aaron Bentley
Rename GraphWalker -> Graph, _AncestryWalker -> _BreadthFirstSearcher
245
        """Construct a Graph that uses several graphs as its input
2490.2.10 by Aaron Bentley
Clarify text, remove unused _get_ancestry method
246
247
        This should not normally be invoked directly, because there may be
248
        specialized implementations for particular repository types.  See
3172.1.2 by Robert Collins
Parent Providers should now implement ``get_parent_map`` returning a
249
        Repository.get_graph().
2490.2.10 by Aaron Bentley
Clarify text, remove unused _get_ancestry method
250
3172.1.2 by Robert Collins
Parent Providers should now implement ``get_parent_map`` returning a
251
        :param parents_provider: An object providing a get_parent_map call
252
            conforming to the behavior of
253
            StackedParentsProvider.get_parent_map.
2490.2.13 by Aaron Bentley
Update distinct -> lowest, refactor, add ParentsProvider concept
254
        """
3172.1.2 by Robert Collins
Parent Providers should now implement ``get_parent_map`` returning a
255
        if getattr(parents_provider, 'get_parents', None) is not None:
256
            self.get_parents = parents_provider.get_parents
257
        if getattr(parents_provider, 'get_parent_map', None) is not None:
258
            self.get_parent_map = parents_provider.get_parent_map
2490.2.29 by Aaron Bentley
Make parents provider private
259
        self._parents_provider = parents_provider
2490.2.28 by Aaron Bentley
Fix handling of null revision
260
261
    def __repr__(self):
2490.2.29 by Aaron Bentley
Make parents provider private
262
        return 'Graph(%r)' % self._parents_provider
2490.2.13 by Aaron Bentley
Update distinct -> lowest, refactor, add ParentsProvider concept
263
264
    def find_lca(self, *revisions):
265
        """Determine the lowest common ancestors of the provided revisions
266
267
        A lowest common ancestor is a common ancestor none of whose
268
        descendants are common ancestors.  In graphs, unlike trees, there may
269
        be multiple lowest common ancestors.
2490.2.12 by Aaron Bentley
Improve documentation
270
271
        This algorithm has two phases.  Phase 1 identifies border ancestors,
2490.2.13 by Aaron Bentley
Update distinct -> lowest, refactor, add ParentsProvider concept
272
        and phase 2 filters border ancestors to determine lowest common
273
        ancestors.
2490.2.12 by Aaron Bentley
Improve documentation
274
275
        In phase 1, border ancestors are identified, using a breadth-first
276
        search starting at the bottom of the graph.  Searches are stopped
277
        whenever a node or one of its descendants is determined to be common
278
2490.2.13 by Aaron Bentley
Update distinct -> lowest, refactor, add ParentsProvider concept
279
        In phase 2, the border ancestors are filtered to find the least
2490.2.12 by Aaron Bentley
Improve documentation
280
        common ancestors.  This is done by searching the ancestries of each
281
        border ancestor.
282
2490.2.13 by Aaron Bentley
Update distinct -> lowest, refactor, add ParentsProvider concept
283
        Phase 2 is perfomed on the principle that a border ancestor that is
284
        not an ancestor of any other border ancestor is a least common
285
        ancestor.
2490.2.12 by Aaron Bentley
Improve documentation
286
287
        Searches are stopped when they find a node that is determined to be a
288
        common ancestor of all border ancestors, because this shows that it
289
        cannot be a descendant of any border ancestor.
290
5891.1.2 by Andrew Bennetts
Fix a bunch of docstring formatting nits, making pydoctor a bit happier.
291
        The scaling of this operation should be proportional to:
292
2490.2.12 by Aaron Bentley
Improve documentation
293
        1. The number of uncommon ancestors
294
        2. The number of border ancestors
295
        3. The length of the shortest path between a border ancestor and an
296
           ancestor of all border ancestors.
2490.2.3 by Aaron Bentley
Implement new merge base picker
297
        """
2490.2.23 by Aaron Bentley
Adapt find_borders to produce a graph difference
298
        border_common, common, sides = self._find_border_ancestors(revisions)
2776.3.1 by Robert Collins
* Deprecated method ``find_previous_heads`` on
299
        # We may have common ancestors that can be reached from each other.
300
        # - ask for the heads of them to filter it down to only ones that
301
        # cannot be reached from each other - phase 2.
302
        return self.heads(border_common)
2490.2.9 by Aaron Bentley
Fix minimal common ancestor algorithm for non-minimal perhipheral ancestors
303
2490.2.23 by Aaron Bentley
Adapt find_borders to produce a graph difference
304
    def find_difference(self, left_revision, right_revision):
2490.2.25 by Aaron Bentley
Update from review
305
        """Determine the graph difference between two revisions"""
3377.3.1 by John Arbash Meinel
Bring in some of the changes from graph_update and graph_optimization
306
        border, common, searchers = self._find_border_ancestors(
2490.2.23 by Aaron Bentley
Adapt find_borders to produce a graph difference
307
            [left_revision, right_revision])
3377.3.1 by John Arbash Meinel
Bring in some of the changes from graph_update and graph_optimization
308
        self._search_for_extra_common(common, searchers)
309
        left = searchers[0].seen
310
        right = searchers[1].seen
311
        return (left.difference(right), right.difference(left))
2490.2.23 by Aaron Bentley
Adapt find_borders to produce a graph difference
312
5365.6.1 by Aaron Bentley
Implement find_descendants.
313
    def find_descendants(self, old_key, new_key):
314
        """Find descendants of old_key that are ancestors of new_key."""
315
        child_map = self.get_child_map(self._find_descendant_ancestors(
316
            old_key, new_key))
317
        graph = Graph(DictParentsProvider(child_map))
318
        searcher = graph._make_breadth_first_searcher([old_key])
319
        list(searcher)
320
        return searcher.seen
321
322
    def _find_descendant_ancestors(self, old_key, new_key):
323
        """Find ancestors of new_key that may be descendants of old_key."""
324
        stop = self._make_breadth_first_searcher([old_key])
325
        descendants = self._make_breadth_first_searcher([new_key])
326
        for revisions in descendants:
327
            old_stop = stop.seen.intersection(revisions)
328
            descendants.stop_searching_any(old_stop)
329
            seen_stop = descendants.find_seen_ancestors(stop.step())
330
            descendants.stop_searching_any(seen_stop)
331
        return descendants.seen.difference(stop.seen)
332
333
    def get_child_map(self, keys):
334
        """Get a mapping from parents to children of the specified keys.
335
336
        This is simply the inversion of get_parent_map.  Only supplied keys
337
        will be discovered as children.
338
        :return: a dict of key:child_list for keys.
339
        """
340
        parent_map = self._parents_provider.get_parent_map(keys)
341
        parent_child = {}
6656.1.1 by Martin
Apply 2to3 dict fixer and clean up resulting mess using view helpers
342
        for child, parents in sorted(viewitems(parent_map)):
5365.6.1 by Aaron Bentley
Implement find_descendants.
343
            for parent in parents:
344
                parent_child.setdefault(parent, []).append(child)
345
        return parent_child
346
3445.1.4 by John Arbash Meinel
Change the function to be called 'find_distance_to_null'
347
    def find_distance_to_null(self, target_revision_id, known_revision_ids):
348
        """Find the left-hand distance to the NULL_REVISION.
349
350
        (This can also be considered the revno of a branch at
351
        target_revision_id.)
3445.1.1 by John Arbash Meinel
Start working on a new Graph api to make finding revision numbers faster.
352
353
        :param target_revision_id: A revision_id which we would like to know
354
            the revno for.
355
        :param known_revision_ids: [(revision_id, revno)] A list of known
356
            revno, revision_id tuples. We'll use this to seed the search.
357
        """
358
        # Map from revision_ids to a known value for their revno
359
        known_revnos = dict(known_revision_ids)
360
        cur_tip = target_revision_id
361
        num_steps = 0
362
        NULL_REVISION = revision.NULL_REVISION
3445.1.2 by John Arbash Meinel
Handle when a known revision is an ancestor.
363
        known_revnos[NULL_REVISION] = 0
3445.1.1 by John Arbash Meinel
Start working on a new Graph api to make finding revision numbers faster.
364
6656.1.1 by Martin
Apply 2to3 dict fixer and clean up resulting mess using view helpers
365
        searching_known_tips = list(known_revnos)
3445.1.3 by John Arbash Meinel
Search from all of the known revisions.
366
367
        unknown_searched = {}
368
3445.1.2 by John Arbash Meinel
Handle when a known revision is an ancestor.
369
        while cur_tip not in known_revnos:
3445.1.3 by John Arbash Meinel
Search from all of the known revisions.
370
            unknown_searched[cur_tip] = num_steps
371
            num_steps += 1
6619.3.12 by Jelmer Vernooij
Use 2to3 set_literal fixer.
372
            to_search = {cur_tip}
3445.1.3 by John Arbash Meinel
Search from all of the known revisions.
373
            to_search.update(searching_known_tips)
3445.1.2 by John Arbash Meinel
Handle when a known revision is an ancestor.
374
            parent_map = self.get_parent_map(to_search)
3445.1.1 by John Arbash Meinel
Start working on a new Graph api to make finding revision numbers faster.
375
            parents = parent_map.get(cur_tip, None)
3445.1.8 by John Arbash Meinel
Clarity tweaks recommended by Ian
376
            if not parents: # An empty list or None is a ghost
3445.1.1 by John Arbash Meinel
Start working on a new Graph api to make finding revision numbers faster.
377
                raise errors.GhostRevisionsHaveNoRevno(target_revision_id,
378
                                                       cur_tip)
379
            cur_tip = parents[0]
3445.1.3 by John Arbash Meinel
Search from all of the known revisions.
380
            next_known_tips = []
381
            for revision_id in searching_known_tips:
382
                parents = parent_map.get(revision_id, None)
383
                if not parents:
384
                    continue
385
                next = parents[0]
386
                next_revno = known_revnos[revision_id] - 1
387
                if next in unknown_searched:
388
                    # We have enough information to return a value right now
389
                    return next_revno + unknown_searched[next]
390
                if next in known_revnos:
391
                    continue
392
                known_revnos[next] = next_revno
393
                next_known_tips.append(next)
394
            searching_known_tips = next_known_tips
3445.1.1 by John Arbash Meinel
Start working on a new Graph api to make finding revision numbers faster.
395
3445.1.2 by John Arbash Meinel
Handle when a known revision is an ancestor.
396
        # We reached a known revision, so just add in how many steps it took to
397
        # get there.
398
        return known_revnos[cur_tip] + num_steps
3445.1.1 by John Arbash Meinel
Start working on a new Graph api to make finding revision numbers faster.
399
4332.3.4 by Robert Collins
Add a graph API for getting multiple distances to NULL at once.
400
    def find_lefthand_distances(self, keys):
401
        """Find the distance to null for all the keys in keys.
402
403
        :param keys: keys to lookup.
404
        :return: A dict key->distance for all of keys.
405
        """
406
        # Optimisable by concurrent searching, but a random spread should get
407
        # some sort of hit rate.
408
        result = {}
409
        known_revnos = []
4332.3.6 by Robert Collins
Teach graph.find_lefthand_distances about ghosts.
410
        ghosts = []
4332.3.4 by Robert Collins
Add a graph API for getting multiple distances to NULL at once.
411
        for key in keys:
4332.3.6 by Robert Collins
Teach graph.find_lefthand_distances about ghosts.
412
            try:
413
                known_revnos.append(
414
                    (key, self.find_distance_to_null(key, known_revnos)))
415
            except errors.GhostRevisionsHaveNoRevno:
416
                ghosts.append(key)
417
        for key in ghosts:
418
            known_revnos.append((key, -1))
4332.3.4 by Robert Collins
Add a graph API for getting multiple distances to NULL at once.
419
        return dict(known_revnos)
420
3377.3.21 by John Arbash Meinel
Simple brute-force implementation of find_unique_ancestors
421
    def find_unique_ancestors(self, unique_revision, common_revisions):
422
        """Find the unique ancestors for a revision versus others.
423
424
        This returns the ancestry of unique_revision, excluding all revisions
425
        in the ancestry of common_revisions. If unique_revision is in the
426
        ancestry, then the empty set will be returned.
427
428
        :param unique_revision: The revision_id whose ancestry we are
429
            interested in.
5891.1.2 by Andrew Bennetts
Fix a bunch of docstring formatting nits, making pydoctor a bit happier.
430
            (XXX: Would this API be better if we allowed multiple revisions on
431
            to be searched here?)
3377.3.21 by John Arbash Meinel
Simple brute-force implementation of find_unique_ancestors
432
        :param common_revisions: Revision_ids of ancestries to exclude.
433
        :return: A set of revisions in the ancestry of unique_revision
434
        """
435
        if unique_revision in common_revisions:
436
            return set()
3377.3.23 by John Arbash Meinel
Implement find_unique_ancestors using more explicit graph searching.
437
438
        # Algorithm description
439
        # 1) Walk backwards from the unique node and all common nodes.
440
        # 2) When a node is seen by both sides, stop searching it in the unique
441
        #    walker, include it in the common walker.
442
        # 3) Stop searching when there are no nodes left for the unique walker.
443
        #    At this point, you have a maximal set of unique nodes. Some of
444
        #    them may actually be common, and you haven't reached them yet.
445
        # 4) Start new searchers for the unique nodes, seeded with the
446
        #    information you have so far.
447
        # 5) Continue searching, stopping the common searches when the search
448
        #    tip is an ancestor of all unique nodes.
3377.4.6 by John Arbash Meinel
Lots of refactoring for find_unique_ancestors.
449
        # 6) Aggregate together unique searchers when they are searching the
450
        #    same tips. When all unique searchers are searching the same node,
451
        #    stop move it to a single 'all_unique_searcher'.
452
        # 7) The 'all_unique_searcher' represents the very 'tip' of searching.
453
        #    Most of the time this produces very little important information.
454
        #    So don't step it as quickly as the other searchers.
455
        # 8) Search is done when all common searchers have completed.
456
457
        unique_searcher, common_searcher = self._find_initial_unique_nodes(
458
            [unique_revision], common_revisions)
459
460
        unique_nodes = unique_searcher.seen.difference(common_searcher.seen)
461
        if not unique_nodes:
462
            return unique_nodes
463
464
        (all_unique_searcher,
465
         unique_tip_searchers) = self._make_unique_searchers(unique_nodes,
466
                                    unique_searcher, common_searcher)
467
468
        self._refine_unique_nodes(unique_searcher, all_unique_searcher,
469
                                  unique_tip_searchers, common_searcher)
470
        true_unique_nodes = unique_nodes.difference(common_searcher.seen)
3377.3.33 by John Arbash Meinel
Add some logging with -Dgraph
471
        if 'graph' in debug.debug_flags:
3377.4.8 by John Arbash Meinel
Final tweaks from Ian
472
            trace.mutter('Found %d truly unique nodes out of %d',
3377.4.6 by John Arbash Meinel
Lots of refactoring for find_unique_ancestors.
473
                         len(true_unique_nodes), len(unique_nodes))
474
        return true_unique_nodes
475
476
    def _find_initial_unique_nodes(self, unique_revisions, common_revisions):
477
        """Steps 1-3 of find_unique_ancestors.
478
479
        Find the maximal set of unique nodes. Some of these might actually
480
        still be common, but we are sure that there are no other unique nodes.
481
482
        :return: (unique_searcher, common_searcher)
483
        """
484
485
        unique_searcher = self._make_breadth_first_searcher(unique_revisions)
486
        # we know that unique_revisions aren't in common_revisions, so skip
487
        # past them.
6634.2.1 by Martin
Apply 2to3 next fixer and make compatible
488
        next(unique_searcher)
3377.3.23 by John Arbash Meinel
Implement find_unique_ancestors using more explicit graph searching.
489
        common_searcher = self._make_breadth_first_searcher(common_revisions)
490
3377.4.6 by John Arbash Meinel
Lots of refactoring for find_unique_ancestors.
491
        # As long as we are still finding unique nodes, keep searching
3377.3.27 by John Arbash Meinel
some simple updates
492
        while unique_searcher._next_query:
3377.3.23 by John Arbash Meinel
Implement find_unique_ancestors using more explicit graph searching.
493
            next_unique_nodes = set(unique_searcher.step())
494
            next_common_nodes = set(common_searcher.step())
495
496
            # Check if either searcher encounters new nodes seen by the other
497
            # side.
498
            unique_are_common_nodes = next_unique_nodes.intersection(
499
                common_searcher.seen)
500
            unique_are_common_nodes.update(
501
                next_common_nodes.intersection(unique_searcher.seen))
502
            if unique_are_common_nodes:
3377.4.6 by John Arbash Meinel
Lots of refactoring for find_unique_ancestors.
503
                ancestors = unique_searcher.find_seen_ancestors(
504
                                unique_are_common_nodes)
3377.4.5 by John Arbash Meinel
Several updates. A bit more debug logging, only step the all_unique searcher 1/10th of the time.
505
                # TODO: This is a bit overboard, we only really care about
506
                #       the ancestors of the tips because the rest we
507
                #       already know. This is *correct* but causes us to
3377.4.6 by John Arbash Meinel
Lots of refactoring for find_unique_ancestors.
508
                #       search too much ancestry.
3377.3.29 by John Arbash Meinel
Revert the _find_any_seen change.
509
                ancestors.update(common_searcher.find_seen_ancestors(ancestors))
3377.3.23 by John Arbash Meinel
Implement find_unique_ancestors using more explicit graph searching.
510
                unique_searcher.stop_searching_any(ancestors)
511
                common_searcher.start_searching(ancestors)
512
3377.4.6 by John Arbash Meinel
Lots of refactoring for find_unique_ancestors.
513
        return unique_searcher, common_searcher
514
515
    def _make_unique_searchers(self, unique_nodes, unique_searcher,
516
                               common_searcher):
517
        """Create a searcher for all the unique search tips (step 4).
518
519
        As a side effect, the common_searcher will stop searching any nodes
520
        that are ancestors of the unique searcher tips.
521
522
        :return: (all_unique_searcher, unique_tip_searchers)
523
        """
3377.3.23 by John Arbash Meinel
Implement find_unique_ancestors using more explicit graph searching.
524
        unique_tips = self._remove_simple_descendants(unique_nodes,
525
                        self.get_parent_map(unique_nodes))
526
3377.4.4 by John Arbash Meinel
Restore the previous code, but bring in a couple changes. Including an update to have lsprof show where the time is spent.
527
        if len(unique_tips) == 1:
3377.4.6 by John Arbash Meinel
Lots of refactoring for find_unique_ancestors.
528
            unique_tip_searchers = []
3377.4.4 by John Arbash Meinel
Restore the previous code, but bring in a couple changes. Including an update to have lsprof show where the time is spent.
529
            ancestor_all_unique = unique_searcher.find_seen_ancestors(unique_tips)
530
        else:
3377.4.6 by John Arbash Meinel
Lots of refactoring for find_unique_ancestors.
531
            unique_tip_searchers = []
3377.4.4 by John Arbash Meinel
Restore the previous code, but bring in a couple changes. Including an update to have lsprof show where the time is spent.
532
            for tip in unique_tips:
533
                revs_to_search = unique_searcher.find_seen_ancestors([tip])
534
                revs_to_search.update(
535
                    common_searcher.find_seen_ancestors(revs_to_search))
536
                searcher = self._make_breadth_first_searcher(revs_to_search)
537
                # We don't care about the starting nodes.
538
                searcher._label = tip
539
                searcher.step()
3377.4.6 by John Arbash Meinel
Lots of refactoring for find_unique_ancestors.
540
                unique_tip_searchers.append(searcher)
3377.3.23 by John Arbash Meinel
Implement find_unique_ancestors using more explicit graph searching.
541
3377.4.4 by John Arbash Meinel
Restore the previous code, but bring in a couple changes. Including an update to have lsprof show where the time is spent.
542
            ancestor_all_unique = None
3377.4.6 by John Arbash Meinel
Lots of refactoring for find_unique_ancestors.
543
            for searcher in unique_tip_searchers:
3377.4.4 by John Arbash Meinel
Restore the previous code, but bring in a couple changes. Including an update to have lsprof show where the time is spent.
544
                if ancestor_all_unique is None:
545
                    ancestor_all_unique = set(searcher.seen)
546
                else:
547
                    ancestor_all_unique = ancestor_all_unique.intersection(
548
                                                searcher.seen)
3377.3.33 by John Arbash Meinel
Add some logging with -Dgraph
549
        # Collapse all the common nodes into a single searcher
3377.4.6 by John Arbash Meinel
Lots of refactoring for find_unique_ancestors.
550
        all_unique_searcher = self._make_breadth_first_searcher(
551
                                ancestor_all_unique)
3377.4.4 by John Arbash Meinel
Restore the previous code, but bring in a couple changes. Including an update to have lsprof show where the time is spent.
552
        if ancestor_all_unique:
3377.4.6 by John Arbash Meinel
Lots of refactoring for find_unique_ancestors.
553
            # We've seen these nodes in all the searchers, so we'll just go to
554
            # the next
3377.4.4 by John Arbash Meinel
Restore the previous code, but bring in a couple changes. Including an update to have lsprof show where the time is spent.
555
            all_unique_searcher.step()
556
557
            # Stop any search tips that are already known as ancestors of the
558
            # unique nodes
559
            stopped_common = common_searcher.stop_searching_any(
560
                common_searcher.find_seen_ancestors(ancestor_all_unique))
561
562
            total_stopped = 0
3377.4.6 by John Arbash Meinel
Lots of refactoring for find_unique_ancestors.
563
            for searcher in unique_tip_searchers:
3377.4.4 by John Arbash Meinel
Restore the previous code, but bring in a couple changes. Including an update to have lsprof show where the time is spent.
564
                total_stopped += len(searcher.stop_searching_any(
565
                    searcher.find_seen_ancestors(ancestor_all_unique)))
3377.4.6 by John Arbash Meinel
Lots of refactoring for find_unique_ancestors.
566
        if 'graph' in debug.debug_flags:
3377.4.8 by John Arbash Meinel
Final tweaks from Ian
567
            trace.mutter('For %d unique nodes, created %d + 1 unique searchers'
568
                         ' (%d stopped search tips, %d common ancestors'
569
                         ' (%d stopped common)',
3377.4.6 by John Arbash Meinel
Lots of refactoring for find_unique_ancestors.
570
                         len(unique_nodes), len(unique_tip_searchers),
571
                         total_stopped, len(ancestor_all_unique),
572
                         len(stopped_common))
573
        return all_unique_searcher, unique_tip_searchers
574
575
    def _step_unique_and_common_searchers(self, common_searcher,
576
                                          unique_tip_searchers,
577
                                          unique_searcher):
3377.4.7 by John Arbash Meinel
Small documentation and code wrapping cleanup
578
        """Step all the searchers"""
3377.4.6 by John Arbash Meinel
Lots of refactoring for find_unique_ancestors.
579
        newly_seen_common = set(common_searcher.step())
580
        newly_seen_unique = set()
581
        for searcher in unique_tip_searchers:
582
            next = set(searcher.step())
583
            next.update(unique_searcher.find_seen_ancestors(next))
584
            next.update(common_searcher.find_seen_ancestors(next))
585
            for alt_searcher in unique_tip_searchers:
586
                if alt_searcher is searcher:
587
                    continue
588
                next.update(alt_searcher.find_seen_ancestors(next))
589
            searcher.start_searching(next)
590
            newly_seen_unique.update(next)
3377.4.8 by John Arbash Meinel
Final tweaks from Ian
591
        return newly_seen_common, newly_seen_unique
3377.4.6 by John Arbash Meinel
Lots of refactoring for find_unique_ancestors.
592
593
    def _find_nodes_common_to_all_unique(self, unique_tip_searchers,
594
                                         all_unique_searcher,
595
                                         newly_seen_unique, step_all_unique):
596
        """Find nodes that are common to all unique_tip_searchers.
597
598
        If it is time, step the all_unique_searcher, and add its nodes to the
599
        result.
600
        """
3377.4.8 by John Arbash Meinel
Final tweaks from Ian
601
        common_to_all_unique_nodes = newly_seen_unique.copy()
3377.4.6 by John Arbash Meinel
Lots of refactoring for find_unique_ancestors.
602
        for searcher in unique_tip_searchers:
3377.4.8 by John Arbash Meinel
Final tweaks from Ian
603
            common_to_all_unique_nodes.intersection_update(searcher.seen)
604
        common_to_all_unique_nodes.intersection_update(
3377.4.6 by John Arbash Meinel
Lots of refactoring for find_unique_ancestors.
605
                                    all_unique_searcher.seen)
606
        # Step all-unique less frequently than the other searchers.
607
        # In the common case, we don't need to spider out far here, so
608
        # avoid doing extra work.
3377.4.8 by John Arbash Meinel
Final tweaks from Ian
609
        if step_all_unique:
3377.4.6 by John Arbash Meinel
Lots of refactoring for find_unique_ancestors.
610
            tstart = time.clock()
611
            nodes = all_unique_searcher.step()
3377.4.8 by John Arbash Meinel
Final tweaks from Ian
612
            common_to_all_unique_nodes.update(nodes)
3377.4.6 by John Arbash Meinel
Lots of refactoring for find_unique_ancestors.
613
            if 'graph' in debug.debug_flags:
3377.4.8 by John Arbash Meinel
Final tweaks from Ian
614
                tdelta = time.clock() - tstart
3377.4.6 by John Arbash Meinel
Lots of refactoring for find_unique_ancestors.
615
                trace.mutter('all_unique_searcher step() took %.3fs'
616
                             'for %d nodes (%d total), iteration: %s',
617
                             tdelta, len(nodes), len(all_unique_searcher.seen),
618
                             all_unique_searcher._iterations)
3377.4.8 by John Arbash Meinel
Final tweaks from Ian
619
        return common_to_all_unique_nodes
3377.4.6 by John Arbash Meinel
Lots of refactoring for find_unique_ancestors.
620
621
    def _collapse_unique_searchers(self, unique_tip_searchers,
3377.4.8 by John Arbash Meinel
Final tweaks from Ian
622
                                   common_to_all_unique_nodes):
3377.4.6 by John Arbash Meinel
Lots of refactoring for find_unique_ancestors.
623
        """Combine searchers that are searching the same tips.
624
625
        When two searchers are searching the same tips, we can stop one of the
626
        searchers. We also know that the maximal set of common ancestors is the
627
        intersection of the two original searchers.
628
629
        :return: A list of searchers that are searching unique nodes.
630
        """
631
        # Filter out searchers that don't actually search different
632
        # nodes. We already have the ancestry intersection for them
633
        unique_search_tips = {}
634
        for searcher in unique_tip_searchers:
3377.4.8 by John Arbash Meinel
Final tweaks from Ian
635
            stopped = searcher.stop_searching_any(common_to_all_unique_nodes)
3377.4.6 by John Arbash Meinel
Lots of refactoring for find_unique_ancestors.
636
            will_search_set = frozenset(searcher._next_query)
637
            if not will_search_set:
638
                if 'graph' in debug.debug_flags:
639
                    trace.mutter('Unique searcher %s was stopped.'
640
                                 ' (%s iterations) %d nodes stopped',
641
                                 searcher._label,
642
                                 searcher._iterations,
643
                                 len(stopped))
644
            elif will_search_set not in unique_search_tips:
645
                # This searcher is searching a unique set of nodes, let it
646
                unique_search_tips[will_search_set] = [searcher]
647
            else:
648
                unique_search_tips[will_search_set].append(searcher)
649
        # TODO: it might be possible to collapse searchers faster when they
650
        #       only have *some* search tips in common.
651
        next_unique_searchers = []
6656.1.1 by Martin
Apply 2to3 dict fixer and clean up resulting mess using view helpers
652
        for searchers in viewvalues(unique_search_tips):
3377.4.6 by John Arbash Meinel
Lots of refactoring for find_unique_ancestors.
653
            if len(searchers) == 1:
654
                # Searching unique tips, go for it
655
                next_unique_searchers.append(searchers[0])
656
            else:
657
                # These searchers have started searching the same tips, we
658
                # don't need them to cover the same ground. The
659
                # intersection of their ancestry won't change, so create a
660
                # new searcher, combining their histories.
661
                next_searcher = searchers[0]
662
                for searcher in searchers[1:]:
663
                    next_searcher.seen.intersection_update(searcher.seen)
664
                if 'graph' in debug.debug_flags:
3377.4.8 by John Arbash Meinel
Final tweaks from Ian
665
                    trace.mutter('Combining %d searchers into a single'
666
                                 ' searcher searching %d nodes with'
667
                                 ' %d ancestry',
3377.4.6 by John Arbash Meinel
Lots of refactoring for find_unique_ancestors.
668
                                 len(searchers),
669
                                 len(next_searcher._next_query),
670
                                 len(next_searcher.seen))
671
                next_unique_searchers.append(next_searcher)
672
        return next_unique_searchers
673
674
    def _refine_unique_nodes(self, unique_searcher, all_unique_searcher,
675
                             unique_tip_searchers, common_searcher):
676
        """Steps 5-8 of find_unique_ancestors.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
677
3377.4.6 by John Arbash Meinel
Lots of refactoring for find_unique_ancestors.
678
        This function returns when common_searcher has stopped searching for
679
        more nodes.
680
        """
681
        # We step the ancestor_all_unique searcher only every
682
        # STEP_UNIQUE_SEARCHER_EVERY steps.
683
        step_all_unique_counter = 0
3377.3.23 by John Arbash Meinel
Implement find_unique_ancestors using more explicit graph searching.
684
        # While we still have common nodes to search
685
        while common_searcher._next_query:
3377.4.6 by John Arbash Meinel
Lots of refactoring for find_unique_ancestors.
686
            (newly_seen_common,
687
             newly_seen_unique) = self._step_unique_and_common_searchers(
688
                common_searcher, unique_tip_searchers, unique_searcher)
3377.3.23 by John Arbash Meinel
Implement find_unique_ancestors using more explicit graph searching.
689
            # These nodes are common ancestors of all unique nodes
3377.4.8 by John Arbash Meinel
Final tweaks from Ian
690
            common_to_all_unique_nodes = self._find_nodes_common_to_all_unique(
3377.4.6 by John Arbash Meinel
Lots of refactoring for find_unique_ancestors.
691
                unique_tip_searchers, all_unique_searcher, newly_seen_unique,
692
                step_all_unique_counter==0)
693
            step_all_unique_counter = ((step_all_unique_counter + 1)
694
                                       % STEP_UNIQUE_SEARCHER_EVERY)
3377.4.4 by John Arbash Meinel
Restore the previous code, but bring in a couple changes. Including an update to have lsprof show where the time is spent.
695
696
            if newly_seen_common:
697
                # If a 'common' node is an ancestor of all unique searchers, we
698
                # can stop searching it.
699
                common_searcher.stop_searching_any(
700
                    all_unique_searcher.seen.intersection(newly_seen_common))
3377.4.8 by John Arbash Meinel
Final tweaks from Ian
701
            if common_to_all_unique_nodes:
702
                common_to_all_unique_nodes.update(
3377.4.7 by John Arbash Meinel
Small documentation and code wrapping cleanup
703
                    common_searcher.find_seen_ancestors(
3377.4.8 by John Arbash Meinel
Final tweaks from Ian
704
                        common_to_all_unique_nodes))
3377.4.4 by John Arbash Meinel
Restore the previous code, but bring in a couple changes. Including an update to have lsprof show where the time is spent.
705
                # The all_unique searcher can start searching the common nodes
706
                # but everyone else can stop.
3377.4.7 by John Arbash Meinel
Small documentation and code wrapping cleanup
707
                # This is the sort of thing where we would like to not have it
708
                # start_searching all of the nodes, but only mark all of them
709
                # as seen, and have it search only the actual tips. Otherwise
710
                # it is another get_parent_map() traversal for it to figure out
711
                # what we already should know.
3377.4.8 by John Arbash Meinel
Final tweaks from Ian
712
                all_unique_searcher.start_searching(common_to_all_unique_nodes)
713
                common_searcher.stop_searching_any(common_to_all_unique_nodes)
3377.4.4 by John Arbash Meinel
Restore the previous code, but bring in a couple changes. Including an update to have lsprof show where the time is spent.
714
3377.4.6 by John Arbash Meinel
Lots of refactoring for find_unique_ancestors.
715
            next_unique_searchers = self._collapse_unique_searchers(
3377.4.8 by John Arbash Meinel
Final tweaks from Ian
716
                unique_tip_searchers, common_to_all_unique_nodes)
3377.4.6 by John Arbash Meinel
Lots of refactoring for find_unique_ancestors.
717
            if len(unique_tip_searchers) != len(next_unique_searchers):
718
                if 'graph' in debug.debug_flags:
3377.4.8 by John Arbash Meinel
Final tweaks from Ian
719
                    trace.mutter('Collapsed %d unique searchers => %d'
3377.4.6 by John Arbash Meinel
Lots of refactoring for find_unique_ancestors.
720
                                 ' at %s iterations',
721
                                 len(unique_tip_searchers),
722
                                 len(next_unique_searchers),
723
                                 all_unique_searcher._iterations)
724
            unique_tip_searchers = next_unique_searchers
3377.3.21 by John Arbash Meinel
Simple brute-force implementation of find_unique_ancestors
725
3172.1.2 by Robert Collins
Parent Providers should now implement ``get_parent_map`` returning a
726
    def get_parent_map(self, revisions):
727
        """Get a map of key:parent_list for revisions.
728
729
        This implementation delegates to get_parents, for old parent_providers
730
        that do not supply get_parent_map.
731
        """
732
        result = {}
733
        for rev, parents in self.get_parents(revisions):
734
            if parents is not None:
735
                result[rev] = parents
736
        return result
737
2490.2.22 by Aaron Bentley
Rename GraphWalker -> Graph, _AncestryWalker -> _BreadthFirstSearcher
738
    def _make_breadth_first_searcher(self, revisions):
739
        return _BreadthFirstSearcher(revisions, self)
740
2490.2.10 by Aaron Bentley
Clarify text, remove unused _get_ancestry method
741
    def _find_border_ancestors(self, revisions):
2490.2.12 by Aaron Bentley
Improve documentation
742
        """Find common ancestors with at least one uncommon descendant.
743
744
        Border ancestors are identified using a breadth-first
745
        search starting at the bottom of the graph.  Searches are stopped
746
        whenever a node or one of its descendants is determined to be common.
747
748
        This will scale with the number of uncommon ancestors.
2490.2.25 by Aaron Bentley
Update from review
749
750
        As well as the border ancestors, a set of seen common ancestors and a
751
        list of sets of seen ancestors for each input revision is returned.
752
        This allows calculation of graph difference from the results of this
753
        operation.
2490.2.12 by Aaron Bentley
Improve documentation
754
        """
2490.2.28 by Aaron Bentley
Fix handling of null revision
755
        if None in revisions:
756
            raise errors.InvalidRevisionId(None, self)
2490.2.19 by Aaron Bentley
Implement common-ancestor-based culling
757
        common_ancestors = set()
2490.2.22 by Aaron Bentley
Rename GraphWalker -> Graph, _AncestryWalker -> _BreadthFirstSearcher
758
        searchers = [self._make_breadth_first_searcher([r])
759
                     for r in revisions]
760
        active_searchers = searchers[:]
2490.2.13 by Aaron Bentley
Update distinct -> lowest, refactor, add ParentsProvider concept
761
        border_ancestors = set()
2490.2.19 by Aaron Bentley
Implement common-ancestor-based culling
762
2490.2.7 by Aaron Bentley
Start implementing mca that scales with number of uncommon ancestors
763
        while True:
764
            newly_seen = set()
3377.3.2 by John Arbash Meinel
find_difference is fixed by updating _find_border_ancestors.... is that reasonable?
765
            for searcher in searchers:
766
                new_ancestors = searcher.step()
767
                if new_ancestors:
768
                    newly_seen.update(new_ancestors)
769
            new_common = set()
2490.2.7 by Aaron Bentley
Start implementing mca that scales with number of uncommon ancestors
770
            for revision in newly_seen:
2490.2.19 by Aaron Bentley
Implement common-ancestor-based culling
771
                if revision in common_ancestors:
3377.3.2 by John Arbash Meinel
find_difference is fixed by updating _find_border_ancestors.... is that reasonable?
772
                    # Not a border ancestor because it was seen as common
773
                    # already
774
                    new_common.add(revision)
2490.2.19 by Aaron Bentley
Implement common-ancestor-based culling
775
                    continue
2490.2.22 by Aaron Bentley
Rename GraphWalker -> Graph, _AncestryWalker -> _BreadthFirstSearcher
776
                for searcher in searchers:
777
                    if revision not in searcher.seen:
2490.2.7 by Aaron Bentley
Start implementing mca that scales with number of uncommon ancestors
778
                        break
779
                else:
3377.3.2 by John Arbash Meinel
find_difference is fixed by updating _find_border_ancestors.... is that reasonable?
780
                    # This is a border because it is a first common that we see
781
                    # after walking for a while.
2490.2.13 by Aaron Bentley
Update distinct -> lowest, refactor, add ParentsProvider concept
782
                    border_ancestors.add(revision)
3377.3.2 by John Arbash Meinel
find_difference is fixed by updating _find_border_ancestors.... is that reasonable?
783
                    new_common.add(revision)
784
            if new_common:
785
                for searcher in searchers:
786
                    new_common.update(searcher.find_seen_ancestors(new_common))
787
                for searcher in searchers:
788
                    searcher.start_searching(new_common)
789
                common_ancestors.update(new_common)
790
791
            # Figure out what the searchers will be searching next, and if
792
            # there is only 1 set being searched, then we are done searching,
793
            # since all searchers would have to be searching the same data,
794
            # thus it *must* be in common.
795
            unique_search_sets = set()
796
            for searcher in searchers:
797
                will_search_set = frozenset(searcher._next_query)
798
                if will_search_set not in unique_search_sets:
799
                    # This searcher is searching a unique set of nodes, let it
800
                    unique_search_sets.add(will_search_set)
801
802
            if len(unique_search_sets) == 1:
803
                nodes = unique_search_sets.pop()
804
                uncommon_nodes = nodes.difference(common_ancestors)
3376.2.14 by Martin Pool
Remove recently-introduced assert statements
805
                if uncommon_nodes:
806
                    raise AssertionError("Somehow we ended up converging"
807
                                         " without actually marking them as"
808
                                         " in common."
809
                                         "\nStart_nodes: %s"
810
                                         "\nuncommon_nodes: %s"
811
                                         % (revisions, uncommon_nodes))
3377.3.2 by John Arbash Meinel
find_difference is fixed by updating _find_border_ancestors.... is that reasonable?
812
                break
813
        return border_ancestors, common_ancestors, searchers
2490.2.9 by Aaron Bentley
Fix minimal common ancestor algorithm for non-minimal perhipheral ancestors
814
2776.3.1 by Robert Collins
* Deprecated method ``find_previous_heads`` on
815
    def heads(self, keys):
816
        """Return the heads from amongst keys.
817
818
        This is done by searching the ancestries of each key.  Any key that is
819
        reachable from another key is not returned; all the others are.
820
821
        This operation scales with the relative depth between any two keys. If
822
        any two keys are completely disconnected all ancestry of both sides
823
        will be retrieved.
824
825
        :param keys: An iterable of keys.
2776.1.4 by Robert Collins
Trivial review feedback changes.
826
        :return: A set of the heads. Note that as a set there is no ordering
827
            information. Callers will need to filter their input to create
828
            order if they need it.
2490.2.12 by Aaron Bentley
Improve documentation
829
        """
2776.1.4 by Robert Collins
Trivial review feedback changes.
830
        candidate_heads = set(keys)
3052.5.5 by John Arbash Meinel
Special case Graph.heads() for NULL_REVISION rather than is_ancestor.
831
        if revision.NULL_REVISION in candidate_heads:
832
            # NULL_REVISION is only a head if it is the only entry
833
            candidate_heads.remove(revision.NULL_REVISION)
834
            if not candidate_heads:
6619.3.12 by Jelmer Vernooij
Use 2to3 set_literal fixer.
835
                return {revision.NULL_REVISION}
2850.2.1 by Robert Collins
(robertc) Special case the zero-or-no-heads case for Graph.heads(). (Robert Collins)
836
        if len(candidate_heads) < 2:
837
            return candidate_heads
2490.2.22 by Aaron Bentley
Rename GraphWalker -> Graph, _AncestryWalker -> _BreadthFirstSearcher
838
        searchers = dict((c, self._make_breadth_first_searcher([c]))
2776.1.4 by Robert Collins
Trivial review feedback changes.
839
                          for c in candidate_heads)
2490.2.22 by Aaron Bentley
Rename GraphWalker -> Graph, _AncestryWalker -> _BreadthFirstSearcher
840
        active_searchers = dict(searchers)
841
        # skip over the actual candidate for each searcher
6656.1.1 by Martin
Apply 2to3 dict fixer and clean up resulting mess using view helpers
842
        for searcher in viewvalues(active_searchers):
6634.2.1 by Martin
Apply 2to3 next fixer and make compatible
843
            next(searcher)
2921.3.1 by Robert Collins
* Graph ``heads()`` queries have been bugfixed to no longer access all
844
        # The common walker finds nodes that are common to two or more of the
845
        # input keys, so that we don't access all history when a currently
846
        # uncommon search point actually meets up with something behind a
847
        # common search point. Common search points do not keep searches
848
        # active; they just allow us to make searches inactive without
849
        # accessing all history.
850
        common_walker = self._make_breadth_first_searcher([])
2490.2.22 by Aaron Bentley
Rename GraphWalker -> Graph, _AncestryWalker -> _BreadthFirstSearcher
851
        while len(active_searchers) > 0:
2921.3.1 by Robert Collins
* Graph ``heads()`` queries have been bugfixed to no longer access all
852
            ancestors = set()
853
            # advance searches
854
            try:
6634.2.1 by Martin
Apply 2to3 next fixer and make compatible
855
                next(common_walker)
2921.3.1 by Robert Collins
* Graph ``heads()`` queries have been bugfixed to no longer access all
856
            except StopIteration:
2921.3.4 by Robert Collins
Review feedback.
857
                # No common points being searched at this time.
2921.3.1 by Robert Collins
* Graph ``heads()`` queries have been bugfixed to no longer access all
858
                pass
6656.1.1 by Martin
Apply 2to3 dict fixer and clean up resulting mess using view helpers
859
            for candidate in list(active_searchers):
1551.15.78 by Aaron Bentley
Fix KeyError in filter_candidate_lca
860
                try:
861
                    searcher = active_searchers[candidate]
862
                except KeyError:
863
                    # rare case: we deleted candidate in a previous iteration
864
                    # through this for loop, because it was determined to be
865
                    # a descendant of another candidate.
866
                    continue
2490.2.9 by Aaron Bentley
Fix minimal common ancestor algorithm for non-minimal perhipheral ancestors
867
                try:
6634.2.1 by Martin
Apply 2to3 next fixer and make compatible
868
                    ancestors.update(next(searcher))
2490.2.9 by Aaron Bentley
Fix minimal common ancestor algorithm for non-minimal perhipheral ancestors
869
                except StopIteration:
2490.2.22 by Aaron Bentley
Rename GraphWalker -> Graph, _AncestryWalker -> _BreadthFirstSearcher
870
                    del active_searchers[candidate]
2490.2.9 by Aaron Bentley
Fix minimal common ancestor algorithm for non-minimal perhipheral ancestors
871
                    continue
2921.3.1 by Robert Collins
* Graph ``heads()`` queries have been bugfixed to no longer access all
872
            # process found nodes
873
            new_common = set()
874
            for ancestor in ancestors:
875
                if ancestor in candidate_heads:
876
                    candidate_heads.remove(ancestor)
877
                    del searchers[ancestor]
878
                    if ancestor in active_searchers:
879
                        del active_searchers[ancestor]
880
                # it may meet up with a known common node
2921.3.4 by Robert Collins
Review feedback.
881
                if ancestor in common_walker.seen:
882
                    # some searcher has encountered our known common nodes:
883
                    # just stop it
6619.3.12 by Jelmer Vernooij
Use 2to3 set_literal fixer.
884
                    ancestor_set = {ancestor}
6656.1.1 by Martin
Apply 2to3 dict fixer and clean up resulting mess using view helpers
885
                    for searcher in viewvalues(searchers):
2921.3.4 by Robert Collins
Review feedback.
886
                        searcher.stop_searching_any(ancestor_set)
887
                else:
2921.3.1 by Robert Collins
* Graph ``heads()`` queries have been bugfixed to no longer access all
888
                    # or it may have been just reached by all the searchers:
6656.1.1 by Martin
Apply 2to3 dict fixer and clean up resulting mess using view helpers
889
                    for searcher in viewvalues(searchers):
2490.2.22 by Aaron Bentley
Rename GraphWalker -> Graph, _AncestryWalker -> _BreadthFirstSearcher
890
                        if ancestor not in searcher.seen:
2490.2.9 by Aaron Bentley
Fix minimal common ancestor algorithm for non-minimal perhipheral ancestors
891
                            break
892
                    else:
2921.3.4 by Robert Collins
Review feedback.
893
                        # The final active searcher has just reached this node,
894
                        # making it be known as a descendant of all candidates,
895
                        # so we can stop searching it, and any seen ancestors
896
                        new_common.add(ancestor)
6656.1.1 by Martin
Apply 2to3 dict fixer and clean up resulting mess using view helpers
897
                        for searcher in viewvalues(searchers):
2921.3.4 by Robert Collins
Review feedback.
898
                            seen_ancestors =\
3377.3.1 by John Arbash Meinel
Bring in some of the changes from graph_update and graph_optimization
899
                                searcher.find_seen_ancestors([ancestor])
2921.3.4 by Robert Collins
Review feedback.
900
                            searcher.stop_searching_any(seen_ancestors)
2921.3.1 by Robert Collins
* Graph ``heads()`` queries have been bugfixed to no longer access all
901
            common_walker.start_searching(new_common)
2776.1.4 by Robert Collins
Trivial review feedback changes.
902
        return candidate_heads
2490.2.13 by Aaron Bentley
Update distinct -> lowest, refactor, add ParentsProvider concept
903
3514.2.8 by John Arbash Meinel
The insertion ordering into the weave has an impact on conflicts.
904
    def find_merge_order(self, tip_revision_id, lca_revision_ids):
905
        """Find the order that each revision was merged into tip.
906
907
        This basically just walks backwards with a stack, and walks left-first
908
        until it finds a node to stop.
909
        """
910
        if len(lca_revision_ids) == 1:
911
            return list(lca_revision_ids)
912
        looking_for = set(lca_revision_ids)
913
        # TODO: Is there a way we could do this "faster" by batching up the
914
        # get_parent_map requests?
915
        # TODO: Should we also be culling the ancestry search right away? We
916
        # could add looking_for to the "stop" list, and walk their
917
        # ancestry in batched mode. The flip side is it might mean we walk a
918
        # lot of "stop" nodes, rather than only the minimum.
919
        # Then again, without it we may trace back into ancestry we could have
920
        # stopped early.
921
        stack = [tip_revision_id]
922
        found = []
923
        stop = set()
924
        while stack and looking_for:
925
            next = stack.pop()
926
            stop.add(next)
927
            if next in looking_for:
928
                found.append(next)
929
                looking_for.remove(next)
930
                if len(looking_for) == 1:
931
                    found.append(looking_for.pop())
932
                    break
933
                continue
934
            parent_ids = self.get_parent_map([next]).get(next, None)
935
            if not parent_ids: # Ghost, nothing to search here
936
                continue
937
            for parent_id in reversed(parent_ids):
938
                # TODO: (performance) We see the parent at this point, but we
939
                #       wait to mark it until later to make sure we get left
940
                #       parents before right parents. However, instead of
941
                #       waiting until we have traversed enough parents, we
942
                #       could instead note that we've found it, and once all
943
                #       parents are in the stack, just reverse iterate the
944
                #       stack for them.
945
                if parent_id not in stop:
946
                    # this will need to be searched
947
                    stack.append(parent_id)
948
                stop.add(parent_id)
949
        return found
950
5365.6.3 by Aaron Bentley
Implement find_lefthand_merger.
951
    def find_lefthand_merger(self, merged_key, tip_key):
952
        """Find the first lefthand ancestor of tip_key that merged merged_key.
953
954
        We do this by first finding the descendants of merged_key, then
955
        walking through the lefthand ancestry of tip_key until we find a key
956
        that doesn't descend from merged_key.  Its child is the key that
957
        merged merged_key.
958
959
        :return: The first lefthand ancestor of tip_key to merge merged_key.
960
            merged_key if it is a lefthand ancestor of tip_key.
961
            None if no ancestor of tip_key merged merged_key.
962
        """
963
        descendants = self.find_descendants(merged_key, tip_key)
964
        candidate_iterator = self.iter_lefthand_ancestry(tip_key)
965
        last_candidate = None
966
        for candidate in candidate_iterator:
967
            if candidate not in descendants:
968
                return last_candidate
969
            last_candidate = candidate
970
1551.19.10 by Aaron Bentley
Merge now warns when it encounters a criss-cross
971
    def find_unique_lca(self, left_revision, right_revision,
972
                        count_steps=False):
2490.2.13 by Aaron Bentley
Update distinct -> lowest, refactor, add ParentsProvider concept
973
        """Find a unique LCA.
974
975
        Find lowest common ancestors.  If there is no unique  common
976
        ancestor, find the lowest common ancestors of those ancestors.
977
978
        Iteration stops when a unique lowest common ancestor is found.
979
        The graph origin is necessarily a unique lowest common ancestor.
2490.2.5 by Aaron Bentley
Use GraphWalker.unique_ancestor to determine merge base
980
981
        Note that None is not an acceptable substitute for NULL_REVISION.
2490.2.13 by Aaron Bentley
Update distinct -> lowest, refactor, add ParentsProvider concept
982
        in the input for this method.
1551.19.12 by Aaron Bentley
Add documentation for the count_steps parameter of Graph.find_unique_lca
983
984
        :param count_steps: If True, the return value will be a tuple of
985
            (unique_lca, steps) where steps is the number of times that
986
            find_lca was run.  If False, only unique_lca is returned.
2490.2.3 by Aaron Bentley
Implement new merge base picker
987
        """
988
        revisions = [left_revision, right_revision]
1551.19.10 by Aaron Bentley
Merge now warns when it encounters a criss-cross
989
        steps = 0
2490.2.3 by Aaron Bentley
Implement new merge base picker
990
        while True:
1551.19.10 by Aaron Bentley
Merge now warns when it encounters a criss-cross
991
            steps += 1
2490.2.13 by Aaron Bentley
Update distinct -> lowest, refactor, add ParentsProvider concept
992
            lca = self.find_lca(*revisions)
993
            if len(lca) == 1:
1551.19.10 by Aaron Bentley
Merge now warns when it encounters a criss-cross
994
                result = lca.pop()
995
                if count_steps:
996
                    return result, steps
997
                else:
998
                    return result
2520.4.104 by Aaron Bentley
Avoid infinite loop when there is no unique lca
999
            if len(lca) == 0:
1000
                raise errors.NoCommonAncestor(left_revision, right_revision)
2490.2.13 by Aaron Bentley
Update distinct -> lowest, refactor, add ParentsProvider concept
1001
            revisions = lca
2490.2.7 by Aaron Bentley
Start implementing mca that scales with number of uncommon ancestors
1002
3228.4.4 by John Arbash Meinel
Change iter_ancestry to take a group instead of a single node,
1003
    def iter_ancestry(self, revision_ids):
3228.4.2 by John Arbash Meinel
Add a Graph.iter_ancestry()
1004
        """Iterate the ancestry of this revision.
1005
3228.4.4 by John Arbash Meinel
Change iter_ancestry to take a group instead of a single node,
1006
        :param revision_ids: Nodes to start the search
3228.4.2 by John Arbash Meinel
Add a Graph.iter_ancestry()
1007
        :return: Yield tuples mapping a revision_id to its parents for the
1008
            ancestry of revision_id.
3228.4.10 by John Arbash Meinel
Respond to abentley's review comments.
1009
            Ghosts will be returned with None as their parents, and nodes
3228.4.4 by John Arbash Meinel
Change iter_ancestry to take a group instead of a single node,
1010
            with no parents will have NULL_REVISION as their only parent. (As
1011
            defined by get_parent_map.)
3228.4.10 by John Arbash Meinel
Respond to abentley's review comments.
1012
            There will also be a node for (NULL_REVISION, ())
3228.4.2 by John Arbash Meinel
Add a Graph.iter_ancestry()
1013
        """
3228.4.4 by John Arbash Meinel
Change iter_ancestry to take a group instead of a single node,
1014
        pending = set(revision_ids)
3228.4.2 by John Arbash Meinel
Add a Graph.iter_ancestry()
1015
        processed = set()
1016
        while pending:
1017
            processed.update(pending)
1018
            next_map = self.get_parent_map(pending)
1019
            next_pending = set()
6656.1.1 by Martin
Apply 2to3 dict fixer and clean up resulting mess using view helpers
1020
            for item in viewitems(next_map):
3228.4.2 by John Arbash Meinel
Add a Graph.iter_ancestry()
1021
                yield item
1022
                next_pending.update(p for p in item[1] if p not in processed)
1023
            ghosts = pending.difference(next_map)
1024
            for ghost in ghosts:
3228.4.10 by John Arbash Meinel
Respond to abentley's review comments.
1025
                yield (ghost, None)
3228.4.2 by John Arbash Meinel
Add a Graph.iter_ancestry()
1026
            pending = next_pending
1027
5365.6.2 by Aaron Bentley
Extract iter_lefthand_ancestry from Repository.iter_ancestry.
1028
    def iter_lefthand_ancestry(self, start_key, stop_keys=None):
1029
        if stop_keys is None:
1030
            stop_keys = ()
1031
        next_key = start_key
1032
        def get_parents(key):
1033
            try:
1034
                return self._parents_provider.get_parent_map([key])[key]
1035
            except KeyError:
1036
                raise errors.RevisionNotPresent(next_key, self)
1037
        while True:
1038
            if next_key in stop_keys:
1039
                return
1040
            parents = get_parents(next_key)
1041
            yield next_key
1042
            if len(parents) == 0:
1043
                return
1044
            else:
1045
                next_key = parents[0]
1046
2490.2.31 by Aaron Bentley
Fix iter_topo_order to permit un-included parents
1047
    def iter_topo_order(self, revisions):
2490.2.30 by Aaron Bentley
Add functionality for tsorting graphs
1048
        """Iterate through the input revisions in topological order.
1049
1050
        This sorting only ensures that parents come before their children.
1051
        An ancestor may sort after a descendant if the relationship is not
1052
        visible in the supplied list of revisions.
1053
        """
6622.1.34 by Jelmer Vernooij
Rename brzlib => breezy.
1054
        from breezy import tsort
3099.3.3 by John Arbash Meinel
Deprecate get_parents() in favor of get_parent_map()
1055
        sorter = tsort.TopoSorter(self.get_parent_map(revisions))
2490.2.34 by Aaron Bentley
Update NEWS and change implementation to return an iterator
1056
        return sorter.iter_topo_order()
2490.2.30 by Aaron Bentley
Add functionality for tsorting graphs
1057
2653.2.1 by Aaron Bentley
Implement Graph.is_ancestor
1058
    def is_ancestor(self, candidate_ancestor, candidate_descendant):
2653.2.5 by Aaron Bentley
Update to clarify algorithm
1059
        """Determine whether a revision is an ancestor of another.
1060
2921.3.1 by Robert Collins
* Graph ``heads()`` queries have been bugfixed to no longer access all
1061
        We answer this using heads() as heads() has the logic to perform the
3078.2.6 by Ian Clatworthy
fix efficiency of local commit detection as recommended by jameinel's review
1062
        smallest number of parent lookups to determine the ancestral
2921.3.1 by Robert Collins
* Graph ``heads()`` queries have been bugfixed to no longer access all
1063
        relationship between N revisions.
2653.2.5 by Aaron Bentley
Update to clarify algorithm
1064
        """
6619.3.12 by Jelmer Vernooij
Use 2to3 set_literal fixer.
1065
        return {candidate_descendant} == self.heads(
2921.3.1 by Robert Collins
* Graph ``heads()`` queries have been bugfixed to no longer access all
1066
            [candidate_ancestor, candidate_descendant])
2653.2.1 by Aaron Bentley
Implement Graph.is_ancestor
1067
3921.3.5 by Marius Kruger
extract graph.is_between from builtins.cmd_tags.run, and test it
1068
    def is_between(self, revid, lower_bound_revid, upper_bound_revid):
1069
        """Determine whether a revision is between two others.
1070
1071
        returns true if and only if:
1072
        lower_bound_revid <= revid <= upper_bound_revid
1073
        """
1074
        return ((upper_bound_revid is None or
1075
                    self.is_ancestor(revid, upper_bound_revid)) and
1076
               (lower_bound_revid is None or
1077
                    self.is_ancestor(lower_bound_revid, revid)))
1078
3377.3.1 by John Arbash Meinel
Bring in some of the changes from graph_update and graph_optimization
1079
    def _search_for_extra_common(self, common, searchers):
1080
        """Make sure that unique nodes are genuinely unique.
1081
3377.3.10 by John Arbash Meinel
Tweak _BreadthFirstSearcher.find_seen_ancestors()
1082
        After _find_border_ancestors, all nodes marked "common" are indeed
1083
        common. Some of the nodes considered unique are not, due to history
1084
        shortcuts stopping the searches early.
3377.3.1 by John Arbash Meinel
Bring in some of the changes from graph_update and graph_optimization
1085
1086
        We know that we have searched enough when all common search tips are
1087
        descended from all unique (uncommon) nodes because we know that a node
1088
        cannot be an ancestor of its own ancestor.
1089
1090
        :param common: A set of common nodes
1091
        :param searchers: The searchers returned from _find_border_ancestors
1092
        :return: None
1093
        """
1094
        # Basic algorithm...
1095
        #   A) The passed in searchers should all be on the same tips, thus
1096
        #      they should be considered the "common" searchers.
1097
        #   B) We find the difference between the searchers, these are the
1098
        #      "unique" nodes for each side.
1099
        #   C) We do a quick culling so that we only start searching from the
1100
        #      more interesting unique nodes. (A unique ancestor is more
3377.3.10 by John Arbash Meinel
Tweak _BreadthFirstSearcher.find_seen_ancestors()
1101
        #      interesting than any of its children.)
3377.3.1 by John Arbash Meinel
Bring in some of the changes from graph_update and graph_optimization
1102
        #   D) We start searching for ancestors common to all unique nodes.
1103
        #   E) We have the common searchers stop searching any ancestors of
1104
        #      nodes found by (D)
1105
        #   F) When there are no more common search tips, we stop
3377.3.10 by John Arbash Meinel
Tweak _BreadthFirstSearcher.find_seen_ancestors()
1106
1107
        # TODO: We need a way to remove unique_searchers when they overlap with
1108
        #       other unique searchers.
3376.2.14 by Martin Pool
Remove recently-introduced assert statements
1109
        if len(searchers) != 2:
1110
            raise NotImplementedError(
1111
                "Algorithm not yet implemented for > 2 searchers")
3377.3.1 by John Arbash Meinel
Bring in some of the changes from graph_update and graph_optimization
1112
        common_searchers = searchers
1113
        left_searcher = searchers[0]
1114
        right_searcher = searchers[1]
3377.3.15 by John Arbash Meinel
minor update
1115
        unique = left_searcher.seen.symmetric_difference(right_searcher.seen)
3377.3.17 by John Arbash Meinel
Keep track of the intersection of unique ancestry,
1116
        if not unique: # No unique nodes, nothing to do
1117
            return
3377.3.10 by John Arbash Meinel
Tweak _BreadthFirstSearcher.find_seen_ancestors()
1118
        total_unique = len(unique)
3377.3.1 by John Arbash Meinel
Bring in some of the changes from graph_update and graph_optimization
1119
        unique = self._remove_simple_descendants(unique,
1120
                    self.get_parent_map(unique))
3377.3.10 by John Arbash Meinel
Tweak _BreadthFirstSearcher.find_seen_ancestors()
1121
        simple_unique = len(unique)
3377.3.14 by John Arbash Meinel
Take another tack on _search_for_extra
1122
1123
        unique_searchers = []
1124
        for revision_id in unique:
3377.3.15 by John Arbash Meinel
minor update
1125
            if revision_id in left_searcher.seen:
3377.3.14 by John Arbash Meinel
Take another tack on _search_for_extra
1126
                parent_searcher = left_searcher
1127
            else:
1128
                parent_searcher = right_searcher
1129
            revs_to_search = parent_searcher.find_seen_ancestors([revision_id])
1130
            if not revs_to_search: # XXX: This shouldn't be possible
1131
                revs_to_search = [revision_id]
3377.3.15 by John Arbash Meinel
minor update
1132
            searcher = self._make_breadth_first_searcher(revs_to_search)
1133
            # We don't care about the starting nodes.
1134
            searcher.step()
1135
            unique_searchers.append(searcher)
3377.3.14 by John Arbash Meinel
Take another tack on _search_for_extra
1136
3377.3.16 by John Arbash Meinel
small cleanups
1137
        # possible todo: aggregate the common searchers into a single common
1138
        #   searcher, just make sure that we include the nodes into the .seen
1139
        #   properties of the original searchers
3377.3.1 by John Arbash Meinel
Bring in some of the changes from graph_update and graph_optimization
1140
3377.3.17 by John Arbash Meinel
Keep track of the intersection of unique ancestry,
1141
        ancestor_all_unique = None
1142
        for searcher in unique_searchers:
1143
            if ancestor_all_unique is None:
1144
                ancestor_all_unique = set(searcher.seen)
1145
            else:
1146
                ancestor_all_unique = ancestor_all_unique.intersection(
1147
                                            searcher.seen)
1148
3377.3.23 by John Arbash Meinel
Implement find_unique_ancestors using more explicit graph searching.
1149
        trace.mutter('Started %s unique searchers for %s unique revisions',
1150
                     simple_unique, total_unique)
3377.3.19 by John Arbash Meinel
Start culling unique searchers once they converge.
1151
3377.3.1 by John Arbash Meinel
Bring in some of the changes from graph_update and graph_optimization
1152
        while True: # If we have no more nodes we have nothing to do
1153
            newly_seen_common = set()
1154
            for searcher in common_searchers:
1155
                newly_seen_common.update(searcher.step())
1156
            newly_seen_unique = set()
1157
            for searcher in unique_searchers:
1158
                newly_seen_unique.update(searcher.step())
1159
            new_common_unique = set()
1160
            for revision in newly_seen_unique:
1161
                for searcher in unique_searchers:
1162
                    if revision not in searcher.seen:
1163
                        break
1164
                else:
1165
                    # This is a border because it is a first common that we see
1166
                    # after walking for a while.
1167
                    new_common_unique.add(revision)
1168
            if newly_seen_common:
1169
                # These are nodes descended from one of the 'common' searchers.
1170
                # Make sure all searchers are on the same page
1171
                for searcher in common_searchers:
3377.3.16 by John Arbash Meinel
small cleanups
1172
                    newly_seen_common.update(
1173
                        searcher.find_seen_ancestors(newly_seen_common))
3377.3.14 by John Arbash Meinel
Take another tack on _search_for_extra
1174
                # We start searching the whole ancestry. It is a bit wasteful,
1175
                # though. We really just want to mark all of these nodes as
1176
                # 'seen' and then start just the tips. However, it requires a
1177
                # get_parent_map() call to figure out the tips anyway, and all
1178
                # redundant requests should be fairly fast.
3377.3.1 by John Arbash Meinel
Bring in some of the changes from graph_update and graph_optimization
1179
                for searcher in common_searchers:
1180
                    searcher.start_searching(newly_seen_common)
3377.3.13 by John Arbash Meinel
Change _search_for_extra_common slightly.
1181
3377.3.17 by John Arbash Meinel
Keep track of the intersection of unique ancestry,
1182
                # If a 'common' node is an ancestor of all unique searchers, we
3377.3.13 by John Arbash Meinel
Change _search_for_extra_common slightly.
1183
                # can stop searching it.
3377.3.17 by John Arbash Meinel
Keep track of the intersection of unique ancestry,
1184
                stop_searching_common = ancestor_all_unique.intersection(
1185
                                            newly_seen_common)
3377.3.13 by John Arbash Meinel
Change _search_for_extra_common slightly.
1186
                if stop_searching_common:
1187
                    for searcher in common_searchers:
1188
                        searcher.stop_searching_any(stop_searching_common)
3377.3.1 by John Arbash Meinel
Bring in some of the changes from graph_update and graph_optimization
1189
            if new_common_unique:
3377.3.20 by John Arbash Meinel
comment cleanups.
1190
                # We found some ancestors that are common
3377.3.10 by John Arbash Meinel
Tweak _BreadthFirstSearcher.find_seen_ancestors()
1191
                for searcher in unique_searchers:
3377.3.16 by John Arbash Meinel
small cleanups
1192
                    new_common_unique.update(
1193
                        searcher.find_seen_ancestors(new_common_unique))
3377.3.1 by John Arbash Meinel
Bring in some of the changes from graph_update and graph_optimization
1194
                # Since these are common, we can grab another set of ancestors
1195
                # that we have seen
1196
                for searcher in common_searchers:
3377.3.16 by John Arbash Meinel
small cleanups
1197
                    new_common_unique.update(
1198
                        searcher.find_seen_ancestors(new_common_unique))
3377.3.1 by John Arbash Meinel
Bring in some of the changes from graph_update and graph_optimization
1199
1200
                # We can tell all of the unique searchers to start at these
1201
                # nodes, and tell all of the common searchers to *stop*
1202
                # searching these nodes
1203
                for searcher in unique_searchers:
1204
                    searcher.start_searching(new_common_unique)
1205
                for searcher in common_searchers:
1206
                    searcher.stop_searching_any(new_common_unique)
3377.3.17 by John Arbash Meinel
Keep track of the intersection of unique ancestry,
1207
                ancestor_all_unique.update(new_common_unique)
3377.3.19 by John Arbash Meinel
Start culling unique searchers once they converge.
1208
3377.3.20 by John Arbash Meinel
comment cleanups.
1209
                # Filter out searchers that don't actually search different
1210
                # nodes. We already have the ancestry intersection for them
3377.3.19 by John Arbash Meinel
Start culling unique searchers once they converge.
1211
                next_unique_searchers = []
1212
                unique_search_sets = set()
1213
                for searcher in unique_searchers:
1214
                    will_search_set = frozenset(searcher._next_query)
1215
                    if will_search_set not in unique_search_sets:
1216
                        # This searcher is searching a unique set of nodes, let it
1217
                        unique_search_sets.add(will_search_set)
1218
                        next_unique_searchers.append(searcher)
1219
                unique_searchers = next_unique_searchers
3377.3.2 by John Arbash Meinel
find_difference is fixed by updating _find_border_ancestors.... is that reasonable?
1220
            for searcher in common_searchers:
1221
                if searcher._next_query:
1222
                    break
1223
            else:
1224
                # All common searcher have stopped searching
3377.3.16 by John Arbash Meinel
small cleanups
1225
                return
3377.3.1 by John Arbash Meinel
Bring in some of the changes from graph_update and graph_optimization
1226
1227
    def _remove_simple_descendants(self, revisions, parent_map):
1228
        """remove revisions which are children of other ones in the set
1229
1230
        This doesn't do any graph searching, it just checks the immediate
1231
        parent_map to find if there are any children which can be removed.
1232
1233
        :param revisions: A set of revision_ids
1234
        :return: A set of revision_ids with the children removed
1235
        """
1236
        simple_ancestors = revisions.copy()
1237
        # TODO: jam 20071214 we *could* restrict it to searching only the
1238
        #       parent_map of revisions already present in 'revisions', but
1239
        #       considering the general use case, I think this is actually
1240
        #       better.
1241
1242
        # This is the same as the following loop. I don't know that it is any
1243
        # faster.
1244
        ## simple_ancestors.difference_update(r for r, p_ids in parent_map.iteritems()
1245
        ##     if p_ids is not None and revisions.intersection(p_ids))
1246
        ## return simple_ancestors
1247
1248
        # Yet Another Way, invert the parent map (which can be cached)
1249
        ## descendants = {}
1250
        ## for revision_id, parent_ids in parent_map.iteritems():
1251
        ##   for p_id in parent_ids:
1252
        ##       descendants.setdefault(p_id, []).append(revision_id)
1253
        ## for revision in revisions.intersection(descendants):
1254
        ##   simple_ancestors.difference_update(descendants[revision])
1255
        ## return simple_ancestors
6656.1.1 by Martin
Apply 2to3 dict fixer and clean up resulting mess using view helpers
1256
        for revision, parent_ids in viewitems(parent_map):
3377.3.1 by John Arbash Meinel
Bring in some of the changes from graph_update and graph_optimization
1257
            if parent_ids is None:
1258
                continue
1259
            for parent_id in parent_ids:
1260
                if parent_id in revisions:
1261
                    # This node has a parent present in the set, so we can
1262
                    # remove it
1263
                    simple_ancestors.discard(revision)
1264
                    break
1265
        return simple_ancestors
1266
2490.2.7 by Aaron Bentley
Start implementing mca that scales with number of uncommon ancestors
1267
2911.4.1 by Robert Collins
Factor out the Graph.heads() cache from _RevisionTextVersionCache for reuse, and use it in commit.
1268
class HeadsCache(object):
1269
    """A cache of results for graph heads calls."""
1270
1271
    def __init__(self, graph):
1272
        self.graph = graph
1273
        self._heads = {}
1274
1275
    def heads(self, keys):
1276
        """Return the heads of keys.
1277
2911.4.3 by Robert Collins
Make the contract of HeadsCache.heads() more clear.
1278
        This matches the API of Graph.heads(), specifically the return value is
1279
        a set which can be mutated, and ordering of the input is not preserved
1280
        in the output.
1281
2911.4.1 by Robert Collins
Factor out the Graph.heads() cache from _RevisionTextVersionCache for reuse, and use it in commit.
1282
        :see also: Graph.heads.
1283
        :param keys: The keys to calculate heads for.
1284
        :return: A set containing the heads, which may be mutated without
1285
            affecting future lookups.
1286
        """
2911.4.2 by Robert Collins
Make HeadsCache actually work.
1287
        keys = frozenset(keys)
2911.4.1 by Robert Collins
Factor out the Graph.heads() cache from _RevisionTextVersionCache for reuse, and use it in commit.
1288
        try:
1289
            return set(self._heads[keys])
1290
        except KeyError:
1291
            heads = self.graph.heads(keys)
1292
            self._heads[keys] = heads
1293
            return set(heads)
1294
1295
3224.1.20 by John Arbash Meinel
Reduce the number of cache misses by caching known heads answers
1296
class FrozenHeadsCache(object):
1297
    """Cache heads() calls, assuming the caller won't modify them."""
1298
1299
    def __init__(self, graph):
1300
        self.graph = graph
1301
        self._heads = {}
1302
1303
    def heads(self, keys):
1304
        """Return the heads of keys.
1305
3224.1.24 by John Arbash Meinel
Fix up docstring since FrozenHeadsCache doesn't let you mutate the result.
1306
        Similar to Graph.heads(). The main difference is that the return value
1307
        is a frozen set which cannot be mutated.
3224.1.20 by John Arbash Meinel
Reduce the number of cache misses by caching known heads answers
1308
1309
        :see also: Graph.heads.
1310
        :param keys: The keys to calculate heads for.
3224.1.24 by John Arbash Meinel
Fix up docstring since FrozenHeadsCache doesn't let you mutate the result.
1311
        :return: A frozenset containing the heads.
3224.1.20 by John Arbash Meinel
Reduce the number of cache misses by caching known heads answers
1312
        """
1313
        keys = frozenset(keys)
1314
        try:
1315
            return self._heads[keys]
1316
        except KeyError:
1317
            heads = frozenset(self.graph.heads(keys))
1318
            self._heads[keys] = heads
1319
            return heads
1320
1321
    def cache(self, keys, heads):
1322
        """Store a known value."""
1323
        self._heads[frozenset(keys)] = frozenset(heads)
1324
1325
2490.2.22 by Aaron Bentley
Rename GraphWalker -> Graph, _AncestryWalker -> _BreadthFirstSearcher
1326
class _BreadthFirstSearcher(object):
2921.3.4 by Robert Collins
Review feedback.
1327
    """Parallel search breadth-first the ancestry of revisions.
2490.2.10 by Aaron Bentley
Clarify text, remove unused _get_ancestry method
1328
1329
    This class implements the iterator protocol, but additionally
1330
    1. provides a set of seen ancestors, and
1331
    2. allows some ancestries to be unsearched, via stop_searching_any
1332
    """
2490.2.7 by Aaron Bentley
Start implementing mca that scales with number of uncommon ancestors
1333
2490.2.22 by Aaron Bentley
Rename GraphWalker -> Graph, _AncestryWalker -> _BreadthFirstSearcher
1334
    def __init__(self, revisions, parents_provider):
3177.3.1 by Robert Collins
* New method ``next_with_ghosts`` on the Graph breadth-first-search objects
1335
        self._iterations = 0
1336
        self._next_query = set(revisions)
1337
        self.seen = set()
3184.1.1 by Robert Collins
Add basic get_recipe to the graph breadth first searcher.
1338
        self._started_keys = set(self._next_query)
1339
        self._stopped_keys = set()
3099.3.1 by John Arbash Meinel
Implement get_parent_map for ParentProviders
1340
        self._parents_provider = parents_provider
3177.3.3 by Robert Collins
Review feedback.
1341
        self._returning = 'next_with_ghosts'
3184.1.2 by Robert Collins
Add tests for starting and stopping searches in combination with get_recipe.
1342
        self._current_present = set()
1343
        self._current_ghosts = set()
1344
        self._current_parents = {}
2490.2.7 by Aaron Bentley
Start implementing mca that scales with number of uncommon ancestors
1345
1346
    def __repr__(self):
3177.3.1 by Robert Collins
* New method ``next_with_ghosts`` on the Graph breadth-first-search objects
1347
        if self._iterations:
1348
            prefix = "searching"
3099.3.1 by John Arbash Meinel
Implement get_parent_map for ParentProviders
1349
        else:
3177.3.1 by Robert Collins
* New method ``next_with_ghosts`` on the Graph breadth-first-search objects
1350
            prefix = "starting"
1351
        search = '%s=%r' % (prefix, list(self._next_query))
1352
        return ('_BreadthFirstSearcher(iterations=%d, %s,'
1353
                ' seen=%r)' % (self._iterations, search, list(self.seen)))
2490.2.7 by Aaron Bentley
Start implementing mca that scales with number of uncommon ancestors
1354
6341.1.5 by Jelmer Vernooij
Fix get_state().
1355
    def get_state(self):
1356
        """Get the current state of this searcher.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1357
6341.1.5 by Jelmer Vernooij
Fix get_state().
1358
        :return: Tuple with started keys, excludes and included keys
3184.1.1 by Robert Collins
Add basic get_recipe to the graph breadth first searcher.
1359
        """
1360
        if self._returning == 'next':
1361
            # We have to know the current nodes children to be able to list the
1362
            # exclude keys for them. However, while we could have a second
1363
            # look-ahead result buffer and shuffle things around, this method
1364
            # is typically only called once per search - when memoising the
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1365
            # results of the search.
3184.1.1 by Robert Collins
Add basic get_recipe to the graph breadth first searcher.
1366
            found, ghosts, next, parents = self._do_query(self._next_query)
1367
            # pretend we didn't query: perhaps we should tweak _do_query to be
1368
            # entirely stateless?
1369
            self.seen.difference_update(next)
3184.1.3 by Robert Collins
Automatically exclude ghosts.
1370
            next_query = next.union(ghosts)
3184.1.1 by Robert Collins
Add basic get_recipe to the graph breadth first searcher.
1371
        else:
1372
            next_query = self._next_query
3184.1.5 by Robert Collins
Record the number of found revisions for cross checking.
1373
        excludes = self._stopped_keys.union(next_query)
3184.1.6 by Robert Collins
Create a SearchResult object which can be used as a replacement for sets.
1374
        included_keys = self.seen.difference(excludes)
6341.1.5 by Jelmer Vernooij
Fix get_state().
1375
        return self._started_keys, excludes, included_keys
1376
1377
    def _get_result(self):
1378
        """Get a SearchResult for the current state of this searcher.
1379
1380
        :return: A SearchResult for this search so far. The SearchResult is
1381
            static - the search can be advanced and the search result will not
1382
            be invalidated or altered.
1383
        """
6622.1.34 by Jelmer Vernooij
Rename brzlib => breezy.
1384
        from breezy.vf_search import SearchResult
6341.1.5 by Jelmer Vernooij
Fix get_state().
1385
        (started_keys, excludes, included_keys) = self.get_state()
1386
        return SearchResult(started_keys, excludes, len(included_keys),
3184.1.6 by Robert Collins
Create a SearchResult object which can be used as a replacement for sets.
1387
            included_keys)
3184.1.1 by Robert Collins
Add basic get_recipe to the graph breadth first searcher.
1388
3377.3.1 by John Arbash Meinel
Bring in some of the changes from graph_update and graph_optimization
1389
    def step(self):
1390
        try:
6634.2.1 by Martin
Apply 2to3 next fixer and make compatible
1391
            return next(self)
3377.3.1 by John Arbash Meinel
Bring in some of the changes from graph_update and graph_optimization
1392
        except StopIteration:
1393
            return ()
1394
6634.2.1 by Martin
Apply 2to3 next fixer and make compatible
1395
    def __next__(self):
2490.2.10 by Aaron Bentley
Clarify text, remove unused _get_ancestry method
1396
        """Return the next ancestors of this revision.
1397
2490.2.12 by Aaron Bentley
Improve documentation
1398
        Ancestors are returned in the order they are seen in a breadth-first
3177.3.1 by Robert Collins
* New method ``next_with_ghosts`` on the Graph breadth-first-search objects
1399
        traversal.  No ancestor will be returned more than once. Ancestors are
1400
        returned before their parentage is queried, so ghosts and missing
1401
        revisions (including the start revisions) are included in the result.
1402
        This can save a round trip in LCA style calculation by allowing
1403
        convergence to be detected without reading the data for the revision
1404
        the convergence occurs on.
1405
1406
        :return: A set of revision_ids.
2490.2.10 by Aaron Bentley
Clarify text, remove unused _get_ancestry method
1407
        """
3177.3.3 by Robert Collins
Review feedback.
1408
        if self._returning != 'next':
3177.3.1 by Robert Collins
* New method ``next_with_ghosts`` on the Graph breadth-first-search objects
1409
            # switch to returning the query, not the results.
3177.3.3 by Robert Collins
Review feedback.
1410
            self._returning = 'next'
3177.3.1 by Robert Collins
* New method ``next_with_ghosts`` on the Graph breadth-first-search objects
1411
            self._iterations += 1
2490.2.7 by Aaron Bentley
Start implementing mca that scales with number of uncommon ancestors
1412
        else:
3177.3.1 by Robert Collins
* New method ``next_with_ghosts`` on the Graph breadth-first-search objects
1413
            self._advance()
1414
        if len(self._next_query) == 0:
1415
            raise StopIteration()
3184.1.1 by Robert Collins
Add basic get_recipe to the graph breadth first searcher.
1416
        # We have seen what we're querying at this point as we are returning
1417
        # the query, not the results.
1418
        self.seen.update(self._next_query)
3177.3.1 by Robert Collins
* New method ``next_with_ghosts`` on the Graph breadth-first-search objects
1419
        return self._next_query
1420
6634.2.1 by Martin
Apply 2to3 next fixer and make compatible
1421
    next = __next__
1422
3177.3.1 by Robert Collins
* New method ``next_with_ghosts`` on the Graph breadth-first-search objects
1423
    def next_with_ghosts(self):
1424
        """Return the next found ancestors, with ghosts split out.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1425
3177.3.1 by Robert Collins
* New method ``next_with_ghosts`` on the Graph breadth-first-search objects
1426
        Ancestors are returned in the order they are seen in a breadth-first
1427
        traversal.  No ancestor will be returned more than once. Ancestors are
3177.3.3 by Robert Collins
Review feedback.
1428
        returned only after asking for their parents, which allows us to detect
1429
        which revisions are ghosts and which are not.
3177.3.1 by Robert Collins
* New method ``next_with_ghosts`` on the Graph breadth-first-search objects
1430
1431
        :return: A tuple with (present ancestors, ghost ancestors) sets.
1432
        """
3177.3.3 by Robert Collins
Review feedback.
1433
        if self._returning != 'next_with_ghosts':
3177.3.1 by Robert Collins
* New method ``next_with_ghosts`` on the Graph breadth-first-search objects
1434
            # switch to returning the results, not the current query.
3177.3.3 by Robert Collins
Review feedback.
1435
            self._returning = 'next_with_ghosts'
3177.3.1 by Robert Collins
* New method ``next_with_ghosts`` on the Graph breadth-first-search objects
1436
            self._advance()
1437
        if len(self._next_query) == 0:
1438
            raise StopIteration()
1439
        self._advance()
1440
        return self._current_present, self._current_ghosts
1441
1442
    def _advance(self):
1443
        """Advance the search.
1444
1445
        Updates self.seen, self._next_query, self._current_present,
3177.3.3 by Robert Collins
Review feedback.
1446
        self._current_ghosts, self._current_parents and self._iterations.
3177.3.1 by Robert Collins
* New method ``next_with_ghosts`` on the Graph breadth-first-search objects
1447
        """
1448
        self._iterations += 1
3177.3.2 by Robert Collins
Update graph searchers stop_searching_any and start_searching for next_with_ghosts.
1449
        found, ghosts, next, parents = self._do_query(self._next_query)
1450
        self._current_present = found
1451
        self._current_ghosts = ghosts
1452
        self._next_query = next
1453
        self._current_parents = parents
3184.1.3 by Robert Collins
Automatically exclude ghosts.
1454
        # ghosts are implicit stop points, otherwise the search cannot be
1455
        # repeated when ghosts are filled.
1456
        self._stopped_keys.update(ghosts)
3177.3.2 by Robert Collins
Update graph searchers stop_searching_any and start_searching for next_with_ghosts.
1457
1458
    def _do_query(self, revisions):
1459
        """Query for revisions.
1460
3184.1.4 by Robert Collins
Correctly exclude ghosts when ghosts are started on an existing search.
1461
        Adds revisions to the seen set.
1462
3177.3.2 by Robert Collins
Update graph searchers stop_searching_any and start_searching for next_with_ghosts.
1463
        :param revisions: Revisions to query.
1464
        :return: A tuple: (set(found_revisions), set(ghost_revisions),
1465
           set(parents_of_found_revisions), dict(found_revisions:parents)).
1466
        """
3377.3.9 by John Arbash Meinel
Small tweaks to _do_query
1467
        found_revisions = set()
3177.3.2 by Robert Collins
Update graph searchers stop_searching_any and start_searching for next_with_ghosts.
1468
        parents_of_found = set()
3184.1.1 by Robert Collins
Add basic get_recipe to the graph breadth first searcher.
1469
        # revisions may contain nodes that point to other nodes in revisions:
1470
        # we want to filter them out.
6015.23.7 by John Arbash Meinel
Run the search a 3rd time if we encounter heads.
1471
        seen = self.seen
1472
        seen.update(revisions)
3177.3.2 by Robert Collins
Update graph searchers stop_searching_any and start_searching for next_with_ghosts.
1473
        parent_map = self._parents_provider.get_parent_map(revisions)
3377.3.9 by John Arbash Meinel
Small tweaks to _do_query
1474
        found_revisions.update(parent_map)
6656.1.1 by Martin
Apply 2to3 dict fixer and clean up resulting mess using view helpers
1475
        for rev_id, parents in viewitems(parent_map):
3517.4.2 by Martin Pool
Make simple-annotation and graph code more tolerant of knits with no graph
1476
            if parents is None:
1477
                continue
6015.23.7 by John Arbash Meinel
Run the search a 3rd time if we encounter heads.
1478
            new_found_parents = [p for p in parents if p not in seen]
3377.3.9 by John Arbash Meinel
Small tweaks to _do_query
1479
            if new_found_parents:
1480
                # Calling set.update() with an empty generator is actually
1481
                # rather expensive.
1482
                parents_of_found.update(new_found_parents)
1483
        ghost_revisions = revisions - found_revisions
1484
        return found_revisions, ghost_revisions, parents_of_found, parent_map
2490.2.7 by Aaron Bentley
Start implementing mca that scales with number of uncommon ancestors
1485
2490.2.8 by Aaron Bentley
fix iteration stuff
1486
    def __iter__(self):
1487
        return self
2490.2.7 by Aaron Bentley
Start implementing mca that scales with number of uncommon ancestors
1488
3377.3.1 by John Arbash Meinel
Bring in some of the changes from graph_update and graph_optimization
1489
    def find_seen_ancestors(self, revisions):
3377.4.6 by John Arbash Meinel
Lots of refactoring for find_unique_ancestors.
1490
        """Find ancestors of these revisions that have already been seen.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1491
3377.4.6 by John Arbash Meinel
Lots of refactoring for find_unique_ancestors.
1492
        This function generally makes the assumption that querying for the
1493
        parents of a node that has already been queried is reasonably cheap.
1494
        (eg, not a round trip to a remote host).
1495
        """
1496
        # TODO: Often we might ask one searcher for its seen ancestors, and
1497
        #       then ask another searcher the same question. This can result in
1498
        #       searching the same revisions repeatedly if the two searchers
1499
        #       have a lot of overlap.
3377.3.10 by John Arbash Meinel
Tweak _BreadthFirstSearcher.find_seen_ancestors()
1500
        all_seen = self.seen
1501
        pending = set(revisions).intersection(all_seen)
1502
        seen_ancestors = set(pending)
1503
1504
        if self._returning == 'next':
1505
            # self.seen contains what nodes have been returned, not what nodes
1506
            # have been queried. We don't want to probe for nodes that haven't
1507
            # been searched yet.
1508
            not_searched_yet = self._next_query
1509
        else:
1510
            not_searched_yet = ()
3377.3.11 by John Arbash Meinel
Committing a debug thunk that was very helpful
1511
        pending.difference_update(not_searched_yet)
3377.3.10 by John Arbash Meinel
Tweak _BreadthFirstSearcher.find_seen_ancestors()
1512
        get_parent_map = self._parents_provider.get_parent_map
3377.3.12 by John Arbash Meinel
Remove the helpful but ugly thunk
1513
        while pending:
1514
            parent_map = get_parent_map(pending)
1515
            all_parents = []
1516
            # We don't care if it is a ghost, since it can't be seen if it is
1517
            # a ghost
6656.1.1 by Martin
Apply 2to3 dict fixer and clean up resulting mess using view helpers
1518
            for parent_ids in viewvalues(parent_map):
3377.3.12 by John Arbash Meinel
Remove the helpful but ugly thunk
1519
                all_parents.extend(parent_ids)
1520
            next_pending = all_seen.intersection(all_parents).difference(seen_ancestors)
1521
            seen_ancestors.update(next_pending)
1522
            next_pending.difference_update(not_searched_yet)
1523
            pending = next_pending
3377.3.10 by John Arbash Meinel
Tweak _BreadthFirstSearcher.find_seen_ancestors()
1524
2490.2.7 by Aaron Bentley
Start implementing mca that scales with number of uncommon ancestors
1525
        return seen_ancestors
1526
2490.2.10 by Aaron Bentley
Clarify text, remove unused _get_ancestry method
1527
    def stop_searching_any(self, revisions):
1528
        """
1529
        Remove any of the specified revisions from the search list.
1530
1531
        None of the specified revisions are required to be present in the
3808.1.4 by John Arbash Meinel
make _walk_to_common responsible for stopping ancestors
1532
        search list.
3808.1.1 by Andrew Bennetts
Possible fix for bug in new _walk_to_common_revisions.
1533
3808.1.4 by John Arbash Meinel
make _walk_to_common responsible for stopping ancestors
1534
        It is okay to call stop_searching_any() for revisions which were seen
1535
        in previous iterations. It is the callers responsibility to call
1536
        find_seen_ancestors() to make sure that current search tips that are
1537
        ancestors of those revisions are also stopped.  All explicitly stopped
1538
        revisions will be excluded from the search result's get_keys(), though.
2490.2.10 by Aaron Bentley
Clarify text, remove unused _get_ancestry method
1539
        """
3377.4.6 by John Arbash Meinel
Lots of refactoring for find_unique_ancestors.
1540
        # TODO: does this help performance?
1541
        # if not revisions:
1542
        #     return set()
3177.3.2 by Robert Collins
Update graph searchers stop_searching_any and start_searching for next_with_ghosts.
1543
        revisions = frozenset(revisions)
3177.3.3 by Robert Collins
Review feedback.
1544
        if self._returning == 'next':
3177.3.2 by Robert Collins
Update graph searchers stop_searching_any and start_searching for next_with_ghosts.
1545
            stopped = self._next_query.intersection(revisions)
1546
            self._next_query = self._next_query.difference(revisions)
1547
        else:
3184.2.1 by Robert Collins
Handle stopping ghosts in searches properly.
1548
            stopped_present = self._current_present.intersection(revisions)
1549
            stopped = stopped_present.union(
1550
                self._current_ghosts.intersection(revisions))
3177.3.2 by Robert Collins
Update graph searchers stop_searching_any and start_searching for next_with_ghosts.
1551
            self._current_present.difference_update(stopped)
1552
            self._current_ghosts.difference_update(stopped)
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1553
            # stopping 'x' should stop returning parents of 'x', but
3177.3.2 by Robert Collins
Update graph searchers stop_searching_any and start_searching for next_with_ghosts.
1554
            # not if 'y' always references those same parents
1555
            stop_rev_references = {}
3184.2.1 by Robert Collins
Handle stopping ghosts in searches properly.
1556
            for rev in stopped_present:
3177.3.2 by Robert Collins
Update graph searchers stop_searching_any and start_searching for next_with_ghosts.
1557
                for parent_id in self._current_parents[rev]:
1558
                    if parent_id not in stop_rev_references:
1559
                        stop_rev_references[parent_id] = 0
1560
                    stop_rev_references[parent_id] += 1
1561
            # if only the stopped revisions reference it, the ref count will be
1562
            # 0 after this loop
6656.1.1 by Martin
Apply 2to3 dict fixer and clean up resulting mess using view helpers
1563
            for parents in viewvalues(self._current_parents):
3177.3.2 by Robert Collins
Update graph searchers stop_searching_any and start_searching for next_with_ghosts.
1564
                for parent_id in parents:
1565
                    try:
1566
                        stop_rev_references[parent_id] -= 1
1567
                    except KeyError:
1568
                        pass
1569
            stop_parents = set()
6656.1.1 by Martin
Apply 2to3 dict fixer and clean up resulting mess using view helpers
1570
            for rev_id, refs in viewitems(stop_rev_references):
3177.3.2 by Robert Collins
Update graph searchers stop_searching_any and start_searching for next_with_ghosts.
1571
                if refs == 0:
1572
                    stop_parents.add(rev_id)
1573
            self._next_query.difference_update(stop_parents)
3184.1.2 by Robert Collins
Add tests for starting and stopping searches in combination with get_recipe.
1574
        self._stopped_keys.update(stopped)
4053.2.2 by Andrew Bennetts
Better fix, with test.
1575
        self._stopped_keys.update(revisions)
2490.2.25 by Aaron Bentley
Update from review
1576
        return stopped
2490.2.17 by Aaron Bentley
Add start_searching, tweak stop_searching_any
1577
1578
    def start_searching(self, revisions):
3177.3.2 by Robert Collins
Update graph searchers stop_searching_any and start_searching for next_with_ghosts.
1579
        """Add revisions to the search.
1580
1581
        The parents of revisions will be returned from the next call to next()
1582
        or next_with_ghosts(). If next_with_ghosts was the most recently used
1583
        next* call then the return value is the result of looking up the
1584
        ghost/not ghost status of revisions. (A tuple (present, ghosted)).
1585
        """
1586
        revisions = frozenset(revisions)
3184.1.2 by Robert Collins
Add tests for starting and stopping searches in combination with get_recipe.
1587
        self._started_keys.update(revisions)
3184.1.4 by Robert Collins
Correctly exclude ghosts when ghosts are started on an existing search.
1588
        new_revisions = revisions.difference(self.seen)
3177.3.3 by Robert Collins
Review feedback.
1589
        if self._returning == 'next':
3184.1.4 by Robert Collins
Correctly exclude ghosts when ghosts are started on an existing search.
1590
            self._next_query.update(new_revisions)
3377.3.30 by John Arbash Meinel
Can we avoid the extra _do_query in start_searching?
1591
            self.seen.update(new_revisions)
3177.3.2 by Robert Collins
Update graph searchers stop_searching_any and start_searching for next_with_ghosts.
1592
        else:
1593
            # perform a query on revisions
3377.3.30 by John Arbash Meinel
Can we avoid the extra _do_query in start_searching?
1594
            revs, ghosts, query, parents = self._do_query(revisions)
1595
            self._stopped_keys.update(ghosts)
3177.3.2 by Robert Collins
Update graph searchers stop_searching_any and start_searching for next_with_ghosts.
1596
            self._current_present.update(revs)
1597
            self._current_ghosts.update(ghosts)
1598
            self._next_query.update(query)
1599
            self._current_parents.update(parents)
1600
            return revs, ghosts
3184.1.6 by Robert Collins
Create a SearchResult object which can be used as a replacement for sets.
1601
1602
6015.23.4 by John Arbash Meinel
Prototype the walk-backwards-and-then-forwards code.
1603
def invert_parent_map(parent_map):
1604
    """Given a map from child => parents, create a map of parent=>children"""
1605
    child_map = {}
6656.1.1 by Martin
Apply 2to3 dict fixer and clean up resulting mess using view helpers
1606
    for child, parents in viewitems(parent_map):
6015.23.4 by John Arbash Meinel
Prototype the walk-backwards-and-then-forwards code.
1607
        for p in parents:
1608
            # Any given parent is likely to have only a small handful
1609
            # of children, many will have only one. So we avoid mem overhead of
1610
            # a list, in exchange for extra copying of tuples
1611
            if p not in child_map:
1612
                child_map[p] = (child,)
1613
            else:
1614
                child_map[p] = child_map[p] + (child,)
1615
    return child_map
1616
1617
3514.2.14 by John Arbash Meinel
Bring in the code to collapse linear portions of the graph.
1618
def collapse_linear_regions(parent_map):
1619
    """Collapse regions of the graph that are 'linear'.
1620
1621
    For example::
1622
1623
      A:[B], B:[C]
1624
1625
    can be collapsed by removing B and getting::
1626
1627
      A:[C]
1628
1629
    :param parent_map: A dictionary mapping children to their parents
1630
    :return: Another dictionary with 'linear' chains collapsed
1631
    """
1632
    # Note: this isn't a strictly minimal collapse. For example:
1633
    #   A
1634
    #  / \
1635
    # B   C
1636
    #  \ /
1637
    #   D
1638
    #   |
1639
    #   E
1640
    # Will not have 'D' removed, even though 'E' could fit. Also:
1641
    #   A
1642
    #   |    A
1643
    #   B => |
1644
    #   |    C
1645
    #   C
1646
    # A and C are both kept because they are edges of the graph. We *could* get
1647
    # rid of A if we wanted.
1648
    #   A
1649
    #  / \
1650
    # B   C
1651
    # |   |
1652
    # D   E
1653
    #  \ /
1654
    #   F
1655
    # Will not have any nodes removed, even though you do have an
1656
    # 'uninteresting' linear D->B and E->C
1657
    children = {}
6656.1.1 by Martin
Apply 2to3 dict fixer and clean up resulting mess using view helpers
1658
    for child, parents in viewitems(parent_map):
3514.2.14 by John Arbash Meinel
Bring in the code to collapse linear portions of the graph.
1659
        children.setdefault(child, [])
1660
        for p in parents:
1661
            children.setdefault(p, []).append(child)
1662
1663
    orig_children = dict(children)
1664
    removed = set()
1665
    result = dict(parent_map)
1666
    for node in parent_map:
1667
        parents = result[node]
1668
        if len(parents) == 1:
1669
            parent_children = children[parents[0]]
1670
            if len(parent_children) != 1:
1671
                # This is not the only child
1672
                continue
1673
            node_children = children[node]
1674
            if len(node_children) != 1:
1675
                continue
1676
            child_parents = result.get(node_children[0], None)
1677
            if len(child_parents) != 1:
1678
                # This is not its only parent
1679
                continue
1680
            # The child of this node only points at it, and the parent only has
1681
            # this as a child. remove this node, and join the others together
1682
            result[node_children[0]] = parents
1683
            children[parents[0]] = node_children
1684
            del result[node]
1685
            del children[node]
1686
            removed.add(node)
1687
1688
    return result
4371.3.18 by John Arbash Meinel
Change VF.annotate to use the new KnownGraph code.
1689
1690
4819.2.3 by John Arbash Meinel
Add a GraphThunkIdsToKeys as a tested class.
1691
class GraphThunkIdsToKeys(object):
1692
    """Forwards calls about 'ids' to be about keys internally."""
1693
1694
    def __init__(self, graph):
1695
        self._graph = graph
1696
4913.4.4 by Jelmer Vernooij
Add test for Repository.get_known_graph_ancestry().
1697
    def topo_sort(self):
1698
        return [r for (r,) in self._graph.topo_sort()]
1699
4819.2.3 by John Arbash Meinel
Add a GraphThunkIdsToKeys as a tested class.
1700
    def heads(self, ids):
1701
        """See Graph.heads()"""
1702
        as_keys = [(i,) for i in ids]
1703
        head_keys = self._graph.heads(as_keys)
6619.3.12 by Jelmer Vernooij
Use 2to3 set_literal fixer.
1704
        return {h[0] for h in head_keys}
4819.2.3 by John Arbash Meinel
Add a GraphThunkIdsToKeys as a tested class.
1705
4913.4.2 by Jelmer Vernooij
Add Repository.get_known_graph_ancestry.
1706
    def merge_sort(self, tip_revision):
5988.1.1 by Jelmer Vernooij
Fix GraphThunkIdsToKeys.merge_sort
1707
        nodes = self._graph.merge_sort((tip_revision,))
1708
        for node in nodes:
1709
            node.key = node.key[0]
1710
        return nodes
4913.4.2 by Jelmer Vernooij
Add Repository.get_known_graph_ancestry.
1711
5559.3.1 by Jelmer Vernooij
Add GraphThunkIdsToKeys.add_node.
1712
    def add_node(self, revision, parents):
1713
        self._graph.add_node((revision,), [(p,) for p in parents])
1714
4819.2.3 by John Arbash Meinel
Add a GraphThunkIdsToKeys as a tested class.
1715
4371.3.38 by John Arbash Meinel
Add a failing test for handling nodes that are in the same linear chain.
1716
_counters = [0,0,0,0,0,0,0]
4371.3.18 by John Arbash Meinel
Change VF.annotate to use the new KnownGraph code.
1717
try:
6624 by Jelmer Vernooij
Merge Python3 porting work ('py3 pokes')
1718
    from ._known_graph_pyx import KnownGraph
6619.3.2 by Jelmer Vernooij
Apply 2to3 except fix.
1719
except ImportError as e:
4574.3.8 by Martin Pool
Only mutter extension load errors when they occur, and record for later
1720
    osutils.failed_to_load_extension(e)
6624 by Jelmer Vernooij
Merge Python3 porting work ('py3 pokes')
1721
    from ._known_graph_py import KnownGraph