##// END OF EJS Templates
discovery: simplify the building of the children mapping...
marmoute -
r42049:1f069f37 default
parent child Browse files
Show More
@@ -1,363 +1,363 b''
1 1 # setdiscovery.py - improved discovery of common nodeset for mercurial
2 2 #
3 3 # Copyright 2010 Benoit Boissinot <bboissin@gmail.com>
4 4 # and Peter Arrenbrecht <peter@arrenbrecht.ch>
5 5 #
6 6 # This software may be used and distributed according to the terms of the
7 7 # GNU General Public License version 2 or any later version.
8 8 """
9 9 Algorithm works in the following way. You have two repository: local and
10 10 remote. They both contains a DAG of changelists.
11 11
12 12 The goal of the discovery protocol is to find one set of node *common*,
13 13 the set of nodes shared by local and remote.
14 14
15 15 One of the issue with the original protocol was latency, it could
16 16 potentially require lots of roundtrips to discover that the local repo was a
17 17 subset of remote (which is a very common case, you usually have few changes
18 18 compared to upstream, while upstream probably had lots of development).
19 19
20 20 The new protocol only requires one interface for the remote repo: `known()`,
21 21 which given a set of changelists tells you if they are present in the DAG.
22 22
23 23 The algorithm then works as follow:
24 24
25 25 - We will be using three sets, `common`, `missing`, `unknown`. Originally
26 26 all nodes are in `unknown`.
27 27 - Take a sample from `unknown`, call `remote.known(sample)`
28 28 - For each node that remote knows, move it and all its ancestors to `common`
29 29 - For each node that remote doesn't know, move it and all its descendants
30 30 to `missing`
31 31 - Iterate until `unknown` is empty
32 32
33 33 There are a couple optimizations, first is instead of starting with a random
34 34 sample of missing, start by sending all heads, in the case where the local
35 35 repo is a subset, you computed the answer in one round trip.
36 36
37 37 Then you can do something similar to the bisecting strategy used when
38 38 finding faulty changesets. Instead of random samples, you can try picking
39 39 nodes that will maximize the number of nodes that will be
40 40 classified with it (since all ancestors or descendants will be marked as well).
41 41 """
42 42
43 43 from __future__ import absolute_import
44 44
45 45 import collections
46 46 import random
47 47
48 48 from .i18n import _
49 49 from .node import (
50 50 nullid,
51 51 nullrev,
52 52 )
53 53 from . import (
54 54 error,
55 55 util,
56 56 )
57 57
58 58 def _updatesample(revs, heads, sample, parentfn, quicksamplesize=0):
59 59 """update an existing sample to match the expected size
60 60
61 61 The sample is updated with revs exponentially distant from each head of the
62 62 <revs> set. (H~1, H~2, H~4, H~8, etc).
63 63
64 64 If a target size is specified, the sampling will stop once this size is
65 65 reached. Otherwise sampling will happen until roots of the <revs> set are
66 66 reached.
67 67
68 68 :revs: set of revs we want to discover (if None, assume the whole dag)
69 69 :heads: set of DAG head revs
70 70 :sample: a sample to update
71 71 :parentfn: a callable to resolve parents for a revision
72 72 :quicksamplesize: optional target size of the sample"""
73 73 dist = {}
74 74 visit = collections.deque(heads)
75 75 seen = set()
76 76 factor = 1
77 77 while visit:
78 78 curr = visit.popleft()
79 79 if curr in seen:
80 80 continue
81 81 d = dist.setdefault(curr, 1)
82 82 if d > factor:
83 83 factor *= 2
84 84 if d == factor:
85 85 sample.add(curr)
86 86 if quicksamplesize and (len(sample) >= quicksamplesize):
87 87 return
88 88 seen.add(curr)
89 89
90 90 for p in parentfn(curr):
91 91 if p != nullrev and (not revs or p in revs):
92 92 dist.setdefault(p, d + 1)
93 93 visit.append(p)
94 94
95 95 def _limitsample(sample, desiredlen):
96 96 """return a random subset of sample of at most desiredlen item"""
97 97 if len(sample) > desiredlen:
98 98 sample = set(random.sample(sample, desiredlen))
99 99 return sample
100 100
101 101 class partialdiscovery(object):
102 102 """an object representing ongoing discovery
103 103
104 104 Feed with data from the remote repository, this object keep track of the
105 105 current set of changeset in various states:
106 106
107 107 - common: revs also known remotely
108 108 - undecided: revs we don't have information on yet
109 109 - missing: revs missing remotely
110 110 (all tracked revisions are known locally)
111 111 """
112 112
113 113 def __init__(self, repo, targetheads):
114 114 self._repo = repo
115 115 self._targetheads = targetheads
116 116 self._common = repo.changelog.incrementalmissingrevs()
117 117 self._undecided = None
118 118 self.missing = set()
119 119
120 120 def addcommons(self, commons):
121 121 """registrer nodes known as common"""
122 122 self._common.addbases(commons)
123 123 if self._undecided is not None:
124 124 self._common.removeancestorsfrom(self._undecided)
125 125
126 126 def addmissings(self, missings):
127 127 """registrer some nodes as missing"""
128 128 newmissing = self._repo.revs('%ld::%ld', missings, self.undecided)
129 129 if newmissing:
130 130 self.missing.update(newmissing)
131 131 self.undecided.difference_update(newmissing)
132 132
133 133 def addinfo(self, sample):
134 134 """consume an iterable of (rev, known) tuples"""
135 135 common = set()
136 136 missing = set()
137 137 for rev, known in sample:
138 138 if known:
139 139 common.add(rev)
140 140 else:
141 141 missing.add(rev)
142 142 if common:
143 143 self.addcommons(common)
144 144 if missing:
145 145 self.addmissings(missing)
146 146
147 147 def hasinfo(self):
148 148 """return True is we have any clue about the remote state"""
149 149 return self._common.hasbases()
150 150
151 151 def iscomplete(self):
152 152 """True if all the necessary data have been gathered"""
153 153 return self._undecided is not None and not self._undecided
154 154
155 155 @property
156 156 def undecided(self):
157 157 if self._undecided is not None:
158 158 return self._undecided
159 159 self._undecided = set(self._common.missingancestors(self._targetheads))
160 160 return self._undecided
161 161
162 162 def commonheads(self):
163 163 """the heads of the known common set"""
164 164 # heads(common) == heads(common.bases) since common represents
165 165 # common.bases and all its ancestors
166 166 return self._common.basesheads()
167 167
168 168 def _parentsgetter(self):
169 169 getrev = self._repo.changelog.index.__getitem__
170 170 def getparents(r):
171 171 return getrev(r)[5:6]
172 172 return getparents
173 173
174 174 def takequicksample(self, headrevs, size):
175 175 """takes a quick sample of size <size>
176 176
177 177 It is meant for initial sampling and focuses on querying heads and close
178 178 ancestors of heads.
179 179
180 180 :headrevs: set of head revisions in local DAG to consider
181 181 :size: the maximum size of the sample"""
182 182 revs = self.undecided
183 183 if len(revs) <= size:
184 184 return list(revs)
185 185 sample = set(self._repo.revs('heads(%ld)', revs))
186 186
187 187 if len(sample) >= size:
188 188 return _limitsample(sample, size)
189 189
190 190 _updatesample(None, headrevs, sample, self._parentsgetter(),
191 191 quicksamplesize=size)
192 192 return sample
193 193
194 194 def takefullsample(self, headrevs, size):
195 195 revs = self.undecided
196 196 if len(revs) <= size:
197 197 return list(revs)
198 198 repo = self._repo
199 199 sample = set(repo.revs('heads(%ld)', revs))
200 200 parentrevs = self._parentsgetter()
201 201
202 202 # update from heads
203 203 revsheads = sample.copy()
204 204 _updatesample(revs, revsheads, sample, parentrevs)
205 205
206 206 # update from roots
207 207 revsroots = set(repo.revs('roots(%ld)', revs))
208 208
209 209 # _updatesample() essentially does interaction over revisions to look
210 210 # up their children. This lookup is expensive and doing it in a loop is
211 211 # quadratic. We precompute the children for all relevant revisions and
212 212 # make the lookup in _updatesample() a simple dict lookup.
213 213 #
214 214 # Because this function can be called multiple times during discovery,
215 215 # we may still perform redundant work and there is room to optimize
216 216 # this by keeping a persistent cache of children across invocations.
217 217 children = {}
218 218
219 219 for rev in sorted(revs):
220 220 # Always ensure revision has an entry so we don't need to worry
221 221 # about missing keys.
222 children.setdefault(rev, [])
223
222 children[rev] = []
224 223 for prev in parentrevs(rev):
225 224 if prev == nullrev:
226 225 continue
227
228 children.setdefault(prev, []).append(rev)
226 c = children.get(prev)
227 if c is not None:
228 c.append(rev)
229 229
230 230 _updatesample(revs, revsroots, sample, children.__getitem__)
231 231 assert sample
232 232 sample = _limitsample(sample, size)
233 233 if len(sample) < size:
234 234 more = size - len(sample)
235 235 sample.update(random.sample(list(revs - sample), more))
236 236 return sample
237 237
238 238 def findcommonheads(ui, local, remote,
239 239 initialsamplesize=100,
240 240 fullsamplesize=200,
241 241 abortwhenunrelated=True,
242 242 ancestorsof=None):
243 243 '''Return a tuple (common, anyincoming, remoteheads) used to identify
244 244 missing nodes from or in remote.
245 245 '''
246 246 start = util.timer()
247 247
248 248 roundtrips = 0
249 249 cl = local.changelog
250 250 clnode = cl.node
251 251 clrev = cl.rev
252 252
253 253 if ancestorsof is not None:
254 254 ownheads = [clrev(n) for n in ancestorsof]
255 255 else:
256 256 ownheads = [rev for rev in cl.headrevs() if rev != nullrev]
257 257
258 258 # early exit if we know all the specified remote heads already
259 259 ui.debug("query 1; heads\n")
260 260 roundtrips += 1
261 261 sample = _limitsample(ownheads, initialsamplesize)
262 262 # indices between sample and externalized version must match
263 263 sample = list(sample)
264 264
265 265 with remote.commandexecutor() as e:
266 266 fheads = e.callcommand('heads', {})
267 267 fknown = e.callcommand('known', {
268 268 'nodes': [clnode(r) for r in sample],
269 269 })
270 270
271 271 srvheadhashes, yesno = fheads.result(), fknown.result()
272 272
273 273 if cl.tip() == nullid:
274 274 if srvheadhashes != [nullid]:
275 275 return [nullid], True, srvheadhashes
276 276 return [nullid], False, []
277 277
278 278 # start actual discovery (we note this before the next "if" for
279 279 # compatibility reasons)
280 280 ui.status(_("searching for changes\n"))
281 281
282 282 knownsrvheads = [] # revnos of remote heads that are known locally
283 283 for node in srvheadhashes:
284 284 if node == nullid:
285 285 continue
286 286
287 287 try:
288 288 knownsrvheads.append(clrev(node))
289 289 # Catches unknown and filtered nodes.
290 290 except error.LookupError:
291 291 continue
292 292
293 293 if len(knownsrvheads) == len(srvheadhashes):
294 294 ui.debug("all remote heads known locally\n")
295 295 return srvheadhashes, False, srvheadhashes
296 296
297 297 if len(sample) == len(ownheads) and all(yesno):
298 298 ui.note(_("all local heads known remotely\n"))
299 299 ownheadhashes = [clnode(r) for r in ownheads]
300 300 return ownheadhashes, True, srvheadhashes
301 301
302 302 # full blown discovery
303 303
304 304 disco = partialdiscovery(local, ownheads)
305 305 # treat remote heads (and maybe own heads) as a first implicit sample
306 306 # response
307 307 disco.addcommons(knownsrvheads)
308 308 disco.addinfo(zip(sample, yesno))
309 309
310 310 full = False
311 311 progress = ui.makeprogress(_('searching'), unit=_('queries'))
312 312 while not disco.iscomplete():
313 313
314 314 if full or disco.hasinfo():
315 315 if full:
316 316 ui.note(_("sampling from both directions\n"))
317 317 else:
318 318 ui.debug("taking initial sample\n")
319 319 samplefunc = disco.takefullsample
320 320 targetsize = fullsamplesize
321 321 else:
322 322 # use even cheaper initial sample
323 323 ui.debug("taking quick initial sample\n")
324 324 samplefunc = disco.takequicksample
325 325 targetsize = initialsamplesize
326 326 sample = samplefunc(ownheads, targetsize)
327 327
328 328 roundtrips += 1
329 329 progress.update(roundtrips)
330 330 ui.debug("query %i; still undecided: %i, sample size is: %i\n"
331 331 % (roundtrips, len(disco.undecided), len(sample)))
332 332 # indices between sample and externalized version must match
333 333 sample = list(sample)
334 334
335 335 with remote.commandexecutor() as e:
336 336 yesno = e.callcommand('known', {
337 337 'nodes': [clnode(r) for r in sample],
338 338 }).result()
339 339
340 340 full = True
341 341
342 342 disco.addinfo(zip(sample, yesno))
343 343
344 344 result = disco.commonheads()
345 345 elapsed = util.timer() - start
346 346 progress.complete()
347 347 ui.debug("%d total queries in %.4fs\n" % (roundtrips, elapsed))
348 348 msg = ('found %d common and %d unknown server heads,'
349 349 ' %d roundtrips in %.4fs\n')
350 350 missing = set(result) - set(knownsrvheads)
351 351 ui.log('discovery', msg, len(result), len(missing), roundtrips,
352 352 elapsed)
353 353
354 354 if not result and srvheadhashes != [nullid]:
355 355 if abortwhenunrelated:
356 356 raise error.Abort(_("repository is unrelated"))
357 357 else:
358 358 ui.warn(_("warning: repository is unrelated\n"))
359 359 return ({nullid}, True, srvheadhashes,)
360 360
361 361 anyincoming = (srvheadhashes != [nullid])
362 362 result = {clnode(r) for r in result}
363 363 return result, anyincoming, srvheadhashes
General Comments 0
You need to be logged in to leave comments. Login now