##// END OF EJS Templates
delta-find: move the `gather_debug` logic in a property...
marmoute -
r51541:5d210ff4 stable
parent child Browse files
Show More
@@ -1,1530 +1,1532 b''
1 1 # revlogdeltas.py - Logic around delta computation for revlog
2 2 #
3 3 # Copyright 2005-2007 Olivia Mackall <olivia@selenic.com>
4 4 # Copyright 2018 Octobus <contact@octobus.net>
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 """Helper class to compute deltas stored inside revlogs"""
9 9
10 10
11 11 import collections
12 12 import struct
13 13
14 14 # import stuff from node for others to import from revlog
15 15 from ..node import nullrev
16 16 from ..i18n import _
17 17 from ..pycompat import getattr
18 18
19 19 from .constants import (
20 20 COMP_MODE_DEFAULT,
21 21 COMP_MODE_INLINE,
22 22 COMP_MODE_PLAIN,
23 23 DELTA_BASE_REUSE_FORCE,
24 24 DELTA_BASE_REUSE_NO,
25 25 KIND_CHANGELOG,
26 26 KIND_FILELOG,
27 27 KIND_MANIFESTLOG,
28 28 REVIDX_ISCENSORED,
29 29 REVIDX_RAWTEXT_CHANGING_FLAGS,
30 30 )
31 31
32 32 from ..thirdparty import attr
33 33
34 34 from .. import (
35 35 error,
36 36 mdiff,
37 37 util,
38 38 )
39 39
40 40 from . import flagutil
41 41
42 42 # maximum <delta-chain-data>/<revision-text-length> ratio
43 43 LIMIT_DELTA2TEXT = 2
44 44
45 45
46 46 class _testrevlog:
47 47 """minimalist fake revlog to use in doctests"""
48 48
49 49 def __init__(self, data, density=0.5, mingap=0, snapshot=()):
50 50 """data is an list of revision payload boundaries"""
51 51 self._data = data
52 52 self._srdensitythreshold = density
53 53 self._srmingapsize = mingap
54 54 self._snapshot = set(snapshot)
55 55 self.index = None
56 56
57 57 def start(self, rev):
58 58 if rev == nullrev:
59 59 return 0
60 60 if rev == 0:
61 61 return 0
62 62 return self._data[rev - 1]
63 63
64 64 def end(self, rev):
65 65 if rev == nullrev:
66 66 return 0
67 67 return self._data[rev]
68 68
69 69 def length(self, rev):
70 70 return self.end(rev) - self.start(rev)
71 71
72 72 def __len__(self):
73 73 return len(self._data)
74 74
75 75 def issnapshot(self, rev):
76 76 if rev == nullrev:
77 77 return True
78 78 return rev in self._snapshot
79 79
80 80
81 81 def slicechunk(revlog, revs, targetsize=None):
82 82 """slice revs to reduce the amount of unrelated data to be read from disk.
83 83
84 84 ``revs`` is sliced into groups that should be read in one time.
85 85 Assume that revs are sorted.
86 86
87 87 The initial chunk is sliced until the overall density (payload/chunks-span
88 88 ratio) is above `revlog._srdensitythreshold`. No gap smaller than
89 89 `revlog._srmingapsize` is skipped.
90 90
91 91 If `targetsize` is set, no chunk larger than `targetsize` will be yield.
92 92 For consistency with other slicing choice, this limit won't go lower than
93 93 `revlog._srmingapsize`.
94 94
95 95 If individual revisions chunk are larger than this limit, they will still
96 96 be raised individually.
97 97
98 98 >>> data = [
99 99 ... 5, #00 (5)
100 100 ... 10, #01 (5)
101 101 ... 12, #02 (2)
102 102 ... 12, #03 (empty)
103 103 ... 27, #04 (15)
104 104 ... 31, #05 (4)
105 105 ... 31, #06 (empty)
106 106 ... 42, #07 (11)
107 107 ... 47, #08 (5)
108 108 ... 47, #09 (empty)
109 109 ... 48, #10 (1)
110 110 ... 51, #11 (3)
111 111 ... 74, #12 (23)
112 112 ... 85, #13 (11)
113 113 ... 86, #14 (1)
114 114 ... 91, #15 (5)
115 115 ... ]
116 116 >>> revlog = _testrevlog(data, snapshot=range(16))
117 117
118 118 >>> list(slicechunk(revlog, list(range(16))))
119 119 [[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15]]
120 120 >>> list(slicechunk(revlog, [0, 15]))
121 121 [[0], [15]]
122 122 >>> list(slicechunk(revlog, [0, 11, 15]))
123 123 [[0], [11], [15]]
124 124 >>> list(slicechunk(revlog, [0, 11, 13, 15]))
125 125 [[0], [11, 13, 15]]
126 126 >>> list(slicechunk(revlog, [1, 2, 3, 5, 8, 10, 11, 14]))
127 127 [[1, 2], [5, 8, 10, 11], [14]]
128 128
129 129 Slicing with a maximum chunk size
130 130 >>> list(slicechunk(revlog, [0, 11, 13, 15], targetsize=15))
131 131 [[0], [11], [13], [15]]
132 132 >>> list(slicechunk(revlog, [0, 11, 13, 15], targetsize=20))
133 133 [[0], [11], [13, 15]]
134 134
135 135 Slicing involving nullrev
136 136 >>> list(slicechunk(revlog, [-1, 0, 11, 13, 15], targetsize=20))
137 137 [[-1, 0], [11], [13, 15]]
138 138 >>> list(slicechunk(revlog, [-1, 13, 15], targetsize=5))
139 139 [[-1], [13], [15]]
140 140 """
141 141 if targetsize is not None:
142 142 targetsize = max(targetsize, revlog._srmingapsize)
143 143 # targetsize should not be specified when evaluating delta candidates:
144 144 # * targetsize is used to ensure we stay within specification when reading,
145 145 densityslicing = getattr(revlog.index, 'slicechunktodensity', None)
146 146 if densityslicing is None:
147 147 densityslicing = lambda x, y, z: _slicechunktodensity(revlog, x, y, z)
148 148 for chunk in densityslicing(
149 149 revs, revlog._srdensitythreshold, revlog._srmingapsize
150 150 ):
151 151 for subchunk in _slicechunktosize(revlog, chunk, targetsize):
152 152 yield subchunk
153 153
154 154
155 155 def _slicechunktosize(revlog, revs, targetsize=None):
156 156 """slice revs to match the target size
157 157
158 158 This is intended to be used on chunk that density slicing selected by that
159 159 are still too large compared to the read garantee of revlog. This might
160 160 happens when "minimal gap size" interrupted the slicing or when chain are
161 161 built in a way that create large blocks next to each other.
162 162
163 163 >>> data = [
164 164 ... 3, #0 (3)
165 165 ... 5, #1 (2)
166 166 ... 6, #2 (1)
167 167 ... 8, #3 (2)
168 168 ... 8, #4 (empty)
169 169 ... 11, #5 (3)
170 170 ... 12, #6 (1)
171 171 ... 13, #7 (1)
172 172 ... 14, #8 (1)
173 173 ... ]
174 174
175 175 == All snapshots cases ==
176 176 >>> revlog = _testrevlog(data, snapshot=range(9))
177 177
178 178 Cases where chunk is already small enough
179 179 >>> list(_slicechunktosize(revlog, [0], 3))
180 180 [[0]]
181 181 >>> list(_slicechunktosize(revlog, [6, 7], 3))
182 182 [[6, 7]]
183 183 >>> list(_slicechunktosize(revlog, [0], None))
184 184 [[0]]
185 185 >>> list(_slicechunktosize(revlog, [6, 7], None))
186 186 [[6, 7]]
187 187
188 188 cases where we need actual slicing
189 189 >>> list(_slicechunktosize(revlog, [0, 1], 3))
190 190 [[0], [1]]
191 191 >>> list(_slicechunktosize(revlog, [1, 3], 3))
192 192 [[1], [3]]
193 193 >>> list(_slicechunktosize(revlog, [1, 2, 3], 3))
194 194 [[1, 2], [3]]
195 195 >>> list(_slicechunktosize(revlog, [3, 5], 3))
196 196 [[3], [5]]
197 197 >>> list(_slicechunktosize(revlog, [3, 4, 5], 3))
198 198 [[3], [5]]
199 199 >>> list(_slicechunktosize(revlog, [5, 6, 7, 8], 3))
200 200 [[5], [6, 7, 8]]
201 201 >>> list(_slicechunktosize(revlog, [0, 1, 2, 3, 4, 5, 6, 7, 8], 3))
202 202 [[0], [1, 2], [3], [5], [6, 7, 8]]
203 203
204 204 Case with too large individual chunk (must return valid chunk)
205 205 >>> list(_slicechunktosize(revlog, [0, 1], 2))
206 206 [[0], [1]]
207 207 >>> list(_slicechunktosize(revlog, [1, 3], 1))
208 208 [[1], [3]]
209 209 >>> list(_slicechunktosize(revlog, [3, 4, 5], 2))
210 210 [[3], [5]]
211 211
212 212 == No Snapshot cases ==
213 213 >>> revlog = _testrevlog(data)
214 214
215 215 Cases where chunk is already small enough
216 216 >>> list(_slicechunktosize(revlog, [0], 3))
217 217 [[0]]
218 218 >>> list(_slicechunktosize(revlog, [6, 7], 3))
219 219 [[6, 7]]
220 220 >>> list(_slicechunktosize(revlog, [0], None))
221 221 [[0]]
222 222 >>> list(_slicechunktosize(revlog, [6, 7], None))
223 223 [[6, 7]]
224 224
225 225 cases where we need actual slicing
226 226 >>> list(_slicechunktosize(revlog, [0, 1], 3))
227 227 [[0], [1]]
228 228 >>> list(_slicechunktosize(revlog, [1, 3], 3))
229 229 [[1], [3]]
230 230 >>> list(_slicechunktosize(revlog, [1, 2, 3], 3))
231 231 [[1], [2, 3]]
232 232 >>> list(_slicechunktosize(revlog, [3, 5], 3))
233 233 [[3], [5]]
234 234 >>> list(_slicechunktosize(revlog, [3, 4, 5], 3))
235 235 [[3], [4, 5]]
236 236 >>> list(_slicechunktosize(revlog, [5, 6, 7, 8], 3))
237 237 [[5], [6, 7, 8]]
238 238 >>> list(_slicechunktosize(revlog, [0, 1, 2, 3, 4, 5, 6, 7, 8], 3))
239 239 [[0], [1, 2], [3], [5], [6, 7, 8]]
240 240
241 241 Case with too large individual chunk (must return valid chunk)
242 242 >>> list(_slicechunktosize(revlog, [0, 1], 2))
243 243 [[0], [1]]
244 244 >>> list(_slicechunktosize(revlog, [1, 3], 1))
245 245 [[1], [3]]
246 246 >>> list(_slicechunktosize(revlog, [3, 4, 5], 2))
247 247 [[3], [5]]
248 248
249 249 == mixed case ==
250 250 >>> revlog = _testrevlog(data, snapshot=[0, 1, 2])
251 251 >>> list(_slicechunktosize(revlog, list(range(9)), 5))
252 252 [[0, 1], [2], [3, 4, 5], [6, 7, 8]]
253 253 """
254 254 assert targetsize is None or 0 <= targetsize
255 255 startdata = revlog.start(revs[0])
256 256 enddata = revlog.end(revs[-1])
257 257 fullspan = enddata - startdata
258 258 if targetsize is None or fullspan <= targetsize:
259 259 yield revs
260 260 return
261 261
262 262 startrevidx = 0
263 263 endrevidx = 1
264 264 iterrevs = enumerate(revs)
265 265 next(iterrevs) # skip first rev.
266 266 # first step: get snapshots out of the way
267 267 for idx, r in iterrevs:
268 268 span = revlog.end(r) - startdata
269 269 snapshot = revlog.issnapshot(r)
270 270 if span <= targetsize and snapshot:
271 271 endrevidx = idx + 1
272 272 else:
273 273 chunk = _trimchunk(revlog, revs, startrevidx, endrevidx)
274 274 if chunk:
275 275 yield chunk
276 276 startrevidx = idx
277 277 startdata = revlog.start(r)
278 278 endrevidx = idx + 1
279 279 if not snapshot:
280 280 break
281 281
282 282 # for the others, we use binary slicing to quickly converge toward valid
283 283 # chunks (otherwise, we might end up looking for start/end of many
284 284 # revisions). This logic is not looking for the perfect slicing point, it
285 285 # focuses on quickly converging toward valid chunks.
286 286 nbitem = len(revs)
287 287 while (enddata - startdata) > targetsize:
288 288 endrevidx = nbitem
289 289 if nbitem - startrevidx <= 1:
290 290 break # protect against individual chunk larger than limit
291 291 localenddata = revlog.end(revs[endrevidx - 1])
292 292 span = localenddata - startdata
293 293 while span > targetsize:
294 294 if endrevidx - startrevidx <= 1:
295 295 break # protect against individual chunk larger than limit
296 296 endrevidx -= (endrevidx - startrevidx) // 2
297 297 localenddata = revlog.end(revs[endrevidx - 1])
298 298 span = localenddata - startdata
299 299 chunk = _trimchunk(revlog, revs, startrevidx, endrevidx)
300 300 if chunk:
301 301 yield chunk
302 302 startrevidx = endrevidx
303 303 startdata = revlog.start(revs[startrevidx])
304 304
305 305 chunk = _trimchunk(revlog, revs, startrevidx)
306 306 if chunk:
307 307 yield chunk
308 308
309 309
310 310 def _slicechunktodensity(revlog, revs, targetdensity=0.5, mingapsize=0):
311 311 """slice revs to reduce the amount of unrelated data to be read from disk.
312 312
313 313 ``revs`` is sliced into groups that should be read in one time.
314 314 Assume that revs are sorted.
315 315
316 316 The initial chunk is sliced until the overall density (payload/chunks-span
317 317 ratio) is above `targetdensity`. No gap smaller than `mingapsize` is
318 318 skipped.
319 319
320 320 >>> revlog = _testrevlog([
321 321 ... 5, #00 (5)
322 322 ... 10, #01 (5)
323 323 ... 12, #02 (2)
324 324 ... 12, #03 (empty)
325 325 ... 27, #04 (15)
326 326 ... 31, #05 (4)
327 327 ... 31, #06 (empty)
328 328 ... 42, #07 (11)
329 329 ... 47, #08 (5)
330 330 ... 47, #09 (empty)
331 331 ... 48, #10 (1)
332 332 ... 51, #11 (3)
333 333 ... 74, #12 (23)
334 334 ... 85, #13 (11)
335 335 ... 86, #14 (1)
336 336 ... 91, #15 (5)
337 337 ... ])
338 338
339 339 >>> list(_slicechunktodensity(revlog, list(range(16))))
340 340 [[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15]]
341 341 >>> list(_slicechunktodensity(revlog, [0, 15]))
342 342 [[0], [15]]
343 343 >>> list(_slicechunktodensity(revlog, [0, 11, 15]))
344 344 [[0], [11], [15]]
345 345 >>> list(_slicechunktodensity(revlog, [0, 11, 13, 15]))
346 346 [[0], [11, 13, 15]]
347 347 >>> list(_slicechunktodensity(revlog, [1, 2, 3, 5, 8, 10, 11, 14]))
348 348 [[1, 2], [5, 8, 10, 11], [14]]
349 349 >>> list(_slicechunktodensity(revlog, [1, 2, 3, 5, 8, 10, 11, 14],
350 350 ... mingapsize=20))
351 351 [[1, 2, 3, 5, 8, 10, 11], [14]]
352 352 >>> list(_slicechunktodensity(revlog, [1, 2, 3, 5, 8, 10, 11, 14],
353 353 ... targetdensity=0.95))
354 354 [[1, 2], [5], [8, 10, 11], [14]]
355 355 >>> list(_slicechunktodensity(revlog, [1, 2, 3, 5, 8, 10, 11, 14],
356 356 ... targetdensity=0.95, mingapsize=12))
357 357 [[1, 2], [5, 8, 10, 11], [14]]
358 358 """
359 359 start = revlog.start
360 360 length = revlog.length
361 361
362 362 if len(revs) <= 1:
363 363 yield revs
364 364 return
365 365
366 366 deltachainspan = segmentspan(revlog, revs)
367 367
368 368 if deltachainspan < mingapsize:
369 369 yield revs
370 370 return
371 371
372 372 readdata = deltachainspan
373 373 chainpayload = sum(length(r) for r in revs)
374 374
375 375 if deltachainspan:
376 376 density = chainpayload / float(deltachainspan)
377 377 else:
378 378 density = 1.0
379 379
380 380 if density >= targetdensity:
381 381 yield revs
382 382 return
383 383
384 384 # Store the gaps in a heap to have them sorted by decreasing size
385 385 gaps = []
386 386 prevend = None
387 387 for i, rev in enumerate(revs):
388 388 revstart = start(rev)
389 389 revlen = length(rev)
390 390
391 391 # Skip empty revisions to form larger holes
392 392 if revlen == 0:
393 393 continue
394 394
395 395 if prevend is not None:
396 396 gapsize = revstart - prevend
397 397 # only consider holes that are large enough
398 398 if gapsize > mingapsize:
399 399 gaps.append((gapsize, i))
400 400
401 401 prevend = revstart + revlen
402 402 # sort the gaps to pop them from largest to small
403 403 gaps.sort()
404 404
405 405 # Collect the indices of the largest holes until the density is acceptable
406 406 selected = []
407 407 while gaps and density < targetdensity:
408 408 gapsize, gapidx = gaps.pop()
409 409
410 410 selected.append(gapidx)
411 411
412 412 # the gap sizes are stored as negatives to be sorted decreasingly
413 413 # by the heap
414 414 readdata -= gapsize
415 415 if readdata > 0:
416 416 density = chainpayload / float(readdata)
417 417 else:
418 418 density = 1.0
419 419 selected.sort()
420 420
421 421 # Cut the revs at collected indices
422 422 previdx = 0
423 423 for idx in selected:
424 424
425 425 chunk = _trimchunk(revlog, revs, previdx, idx)
426 426 if chunk:
427 427 yield chunk
428 428
429 429 previdx = idx
430 430
431 431 chunk = _trimchunk(revlog, revs, previdx)
432 432 if chunk:
433 433 yield chunk
434 434
435 435
436 436 def _trimchunk(revlog, revs, startidx, endidx=None):
437 437 """returns revs[startidx:endidx] without empty trailing revs
438 438
439 439 Doctest Setup
440 440 >>> revlog = _testrevlog([
441 441 ... 5, #0
442 442 ... 10, #1
443 443 ... 12, #2
444 444 ... 12, #3 (empty)
445 445 ... 17, #4
446 446 ... 21, #5
447 447 ... 21, #6 (empty)
448 448 ... ])
449 449
450 450 Contiguous cases:
451 451 >>> _trimchunk(revlog, [0, 1, 2, 3, 4, 5, 6], 0)
452 452 [0, 1, 2, 3, 4, 5]
453 453 >>> _trimchunk(revlog, [0, 1, 2, 3, 4, 5, 6], 0, 5)
454 454 [0, 1, 2, 3, 4]
455 455 >>> _trimchunk(revlog, [0, 1, 2, 3, 4, 5, 6], 0, 4)
456 456 [0, 1, 2]
457 457 >>> _trimchunk(revlog, [0, 1, 2, 3, 4, 5, 6], 2, 4)
458 458 [2]
459 459 >>> _trimchunk(revlog, [0, 1, 2, 3, 4, 5, 6], 3)
460 460 [3, 4, 5]
461 461 >>> _trimchunk(revlog, [0, 1, 2, 3, 4, 5, 6], 3, 5)
462 462 [3, 4]
463 463
464 464 Discontiguous cases:
465 465 >>> _trimchunk(revlog, [1, 3, 5, 6], 0)
466 466 [1, 3, 5]
467 467 >>> _trimchunk(revlog, [1, 3, 5, 6], 0, 2)
468 468 [1]
469 469 >>> _trimchunk(revlog, [1, 3, 5, 6], 1, 3)
470 470 [3, 5]
471 471 >>> _trimchunk(revlog, [1, 3, 5, 6], 1)
472 472 [3, 5]
473 473 """
474 474 length = revlog.length
475 475
476 476 if endidx is None:
477 477 endidx = len(revs)
478 478
479 479 # If we have a non-emtpy delta candidate, there are nothing to trim
480 480 if revs[endidx - 1] < len(revlog):
481 481 # Trim empty revs at the end, except the very first revision of a chain
482 482 while (
483 483 endidx > 1 and endidx > startidx and length(revs[endidx - 1]) == 0
484 484 ):
485 485 endidx -= 1
486 486
487 487 return revs[startidx:endidx]
488 488
489 489
490 490 def segmentspan(revlog, revs):
491 491 """Get the byte span of a segment of revisions
492 492
493 493 revs is a sorted array of revision numbers
494 494
495 495 >>> revlog = _testrevlog([
496 496 ... 5, #0
497 497 ... 10, #1
498 498 ... 12, #2
499 499 ... 12, #3 (empty)
500 500 ... 17, #4
501 501 ... ])
502 502
503 503 >>> segmentspan(revlog, [0, 1, 2, 3, 4])
504 504 17
505 505 >>> segmentspan(revlog, [0, 4])
506 506 17
507 507 >>> segmentspan(revlog, [3, 4])
508 508 5
509 509 >>> segmentspan(revlog, [1, 2, 3,])
510 510 7
511 511 >>> segmentspan(revlog, [1, 3])
512 512 7
513 513 """
514 514 if not revs:
515 515 return 0
516 516 end = revlog.end(revs[-1])
517 517 return end - revlog.start(revs[0])
518 518
519 519
520 520 def _textfromdelta(fh, revlog, baserev, delta, p1, p2, flags, expectednode):
521 521 """build full text from a (base, delta) pair and other metadata"""
522 522 # special case deltas which replace entire base; no need to decode
523 523 # base revision. this neatly avoids censored bases, which throw when
524 524 # they're decoded.
525 525 hlen = struct.calcsize(b">lll")
526 526 if delta[:hlen] == mdiff.replacediffheader(
527 527 revlog.rawsize(baserev), len(delta) - hlen
528 528 ):
529 529 fulltext = delta[hlen:]
530 530 else:
531 531 # deltabase is rawtext before changed by flag processors, which is
532 532 # equivalent to non-raw text
533 533 basetext = revlog.revision(baserev, _df=fh)
534 534 fulltext = mdiff.patch(basetext, delta)
535 535
536 536 try:
537 537 validatehash = flagutil.processflagsraw(revlog, fulltext, flags)
538 538 if validatehash:
539 539 revlog.checkhash(fulltext, expectednode, p1=p1, p2=p2)
540 540 if flags & REVIDX_ISCENSORED:
541 541 raise error.StorageError(
542 542 _(b'node %s is not censored') % expectednode
543 543 )
544 544 except error.CensoredNodeError:
545 545 # must pass the censored index flag to add censored revisions
546 546 if not flags & REVIDX_ISCENSORED:
547 547 raise
548 548 return fulltext
549 549
550 550
551 551 @attr.s(slots=True, frozen=True)
552 552 class _deltainfo:
553 553 distance = attr.ib()
554 554 deltalen = attr.ib()
555 555 data = attr.ib()
556 556 base = attr.ib()
557 557 chainbase = attr.ib()
558 558 chainlen = attr.ib()
559 559 compresseddeltalen = attr.ib()
560 560 snapshotdepth = attr.ib()
561 561
562 562
563 563 def drop_u_compression(delta):
564 564 """turn into a "u" (no-compression) into no-compression without header
565 565
566 566 This is useful for revlog format that has better compression method.
567 567 """
568 568 assert delta.data[0] == b'u', delta.data[0]
569 569 return _deltainfo(
570 570 delta.distance,
571 571 delta.deltalen - 1,
572 572 (b'', delta.data[1]),
573 573 delta.base,
574 574 delta.chainbase,
575 575 delta.chainlen,
576 576 delta.compresseddeltalen,
577 577 delta.snapshotdepth,
578 578 )
579 579
580 580
581 581 def is_good_delta_info(revlog, deltainfo, revinfo):
582 582 """Returns True if the given delta is good. Good means that it is within
583 583 the disk span, disk size, and chain length bounds that we know to be
584 584 performant."""
585 585 if deltainfo is None:
586 586 return False
587 587
588 588 if (
589 589 revinfo.cachedelta is not None
590 590 and deltainfo.base == revinfo.cachedelta[0]
591 591 and revinfo.cachedelta[2] == DELTA_BASE_REUSE_FORCE
592 592 ):
593 593 return True
594 594
595 595 # - 'deltainfo.distance' is the distance from the base revision --
596 596 # bounding it limits the amount of I/O we need to do.
597 597 # - 'deltainfo.compresseddeltalen' is the sum of the total size of
598 598 # deltas we need to apply -- bounding it limits the amount of CPU
599 599 # we consume.
600 600
601 601 textlen = revinfo.textlen
602 602 defaultmax = textlen * 4
603 603 maxdist = revlog._maxdeltachainspan
604 604 if not maxdist:
605 605 maxdist = deltainfo.distance # ensure the conditional pass
606 606 maxdist = max(maxdist, defaultmax)
607 607
608 608 # Bad delta from read span:
609 609 #
610 610 # If the span of data read is larger than the maximum allowed.
611 611 #
612 612 # In the sparse-revlog case, we rely on the associated "sparse reading"
613 613 # to avoid issue related to the span of data. In theory, it would be
614 614 # possible to build pathological revlog where delta pattern would lead
615 615 # to too many reads. However, they do not happen in practice at all. So
616 616 # we skip the span check entirely.
617 617 if not revlog._sparserevlog and maxdist < deltainfo.distance:
618 618 return False
619 619
620 620 # Bad delta from new delta size:
621 621 #
622 622 # If the delta size is larger than the target text, storing the
623 623 # delta will be inefficient.
624 624 if textlen < deltainfo.deltalen:
625 625 return False
626 626
627 627 # Bad delta from cumulated payload size:
628 628 #
629 629 # If the sum of delta get larger than K * target text length.
630 630 if textlen * LIMIT_DELTA2TEXT < deltainfo.compresseddeltalen:
631 631 return False
632 632
633 633 # Bad delta from chain length:
634 634 #
635 635 # If the number of delta in the chain gets too high.
636 636 if revlog._maxchainlen and revlog._maxchainlen < deltainfo.chainlen:
637 637 return False
638 638
639 639 # bad delta from intermediate snapshot size limit
640 640 #
641 641 # If an intermediate snapshot size is higher than the limit. The
642 642 # limit exist to prevent endless chain of intermediate delta to be
643 643 # created.
644 644 if (
645 645 deltainfo.snapshotdepth is not None
646 646 and (textlen >> deltainfo.snapshotdepth) < deltainfo.deltalen
647 647 ):
648 648 return False
649 649
650 650 # bad delta if new intermediate snapshot is larger than the previous
651 651 # snapshot
652 652 if (
653 653 deltainfo.snapshotdepth
654 654 and revlog.length(deltainfo.base) < deltainfo.deltalen
655 655 ):
656 656 return False
657 657
658 658 return True
659 659
660 660
661 661 # If a revision's full text is that much bigger than a base candidate full
662 662 # text's, it is very unlikely that it will produce a valid delta. We no longer
663 663 # consider these candidates.
664 664 LIMIT_BASE2TEXT = 500
665 665
666 666
667 667 def _candidategroups(
668 668 revlog,
669 669 textlen,
670 670 p1,
671 671 p2,
672 672 cachedelta,
673 673 excluded_bases=None,
674 674 target_rev=None,
675 675 snapshot_cache=None,
676 676 ):
677 677 """Provides group of revision to be tested as delta base
678 678
679 679 This top level function focus on emitting groups with unique and worthwhile
680 680 content. See _raw_candidate_groups for details about the group order.
681 681 """
682 682 # should we try to build a delta?
683 683 if not (len(revlog) and revlog._storedeltachains):
684 684 yield None
685 685 return
686 686
687 687 if target_rev is None:
688 688 target_rev = len(revlog)
689 689
690 690 if not revlog._generaldelta:
691 691 # before general delta, there is only one possible delta base
692 692 yield (target_rev - 1,)
693 693 yield None
694 694 return
695 695
696 696 if (
697 697 cachedelta is not None
698 698 and nullrev == cachedelta[0]
699 699 and cachedelta[2] == DELTA_BASE_REUSE_FORCE
700 700 ):
701 701 # instruction are to forcibly do a full snapshot
702 702 yield None
703 703 return
704 704
705 705 deltalength = revlog.length
706 706 deltaparent = revlog.deltaparent
707 707 sparse = revlog._sparserevlog
708 708 good = None
709 709
710 710 deltas_limit = textlen * LIMIT_DELTA2TEXT
711 711 group_chunk_size = revlog._candidate_group_chunk_size
712 712
713 713 tested = {nullrev}
714 714 candidates = _refinedgroups(
715 715 revlog,
716 716 p1,
717 717 p2,
718 718 cachedelta,
719 719 snapshot_cache=snapshot_cache,
720 720 )
721 721 while True:
722 722 temptative = candidates.send(good)
723 723 if temptative is None:
724 724 break
725 725 group = []
726 726 for rev in temptative:
727 727 # skip over empty delta (no need to include them in a chain)
728 728 while not (rev == nullrev or rev in tested or deltalength(rev)):
729 729 tested.add(rev)
730 730 rev = deltaparent(rev)
731 731 # no need to try a delta against nullrev, this will be done as a
732 732 # last resort.
733 733 if rev == nullrev:
734 734 continue
735 735 # filter out revision we tested already
736 736 if rev in tested:
737 737 continue
738 738
739 739 if (
740 740 cachedelta is not None
741 741 and rev == cachedelta[0]
742 742 and cachedelta[2] == DELTA_BASE_REUSE_FORCE
743 743 ):
744 744 # instructions are to forcibly consider/use this delta base
745 745 group.append(rev)
746 746 continue
747 747
748 748 # an higher authority deamed the base unworthy (e.g. censored)
749 749 if excluded_bases is not None and rev in excluded_bases:
750 750 tested.add(rev)
751 751 continue
752 752 # We are in some recomputation cases and that rev is too high in
753 753 # the revlog
754 754 if target_rev is not None and rev >= target_rev:
755 755 tested.add(rev)
756 756 continue
757 757 # filter out delta base that will never produce good delta
758 758 if deltas_limit < revlog.length(rev):
759 759 tested.add(rev)
760 760 continue
761 761 if sparse and revlog.rawsize(rev) < (textlen // LIMIT_BASE2TEXT):
762 762 tested.add(rev)
763 763 continue
764 764 # no delta for rawtext-changing revs (see "candelta" for why)
765 765 if revlog.flags(rev) & REVIDX_RAWTEXT_CHANGING_FLAGS:
766 766 tested.add(rev)
767 767 continue
768 768
769 769 # If we reach here, we are about to build and test a delta.
770 770 # The delta building process will compute the chaininfo in all
771 771 # case, since that computation is cached, it is fine to access it
772 772 # here too.
773 773 chainlen, chainsize = revlog._chaininfo(rev)
774 774 # if chain will be too long, skip base
775 775 if revlog._maxchainlen and chainlen >= revlog._maxchainlen:
776 776 tested.add(rev)
777 777 continue
778 778 # if chain already have too much data, skip base
779 779 if deltas_limit < chainsize:
780 780 tested.add(rev)
781 781 continue
782 782 if sparse and revlog.upperboundcomp is not None:
783 783 maxcomp = revlog.upperboundcomp
784 784 basenotsnap = (p1, p2, nullrev)
785 785 if rev not in basenotsnap and revlog.issnapshot(rev):
786 786 snapshotdepth = revlog.snapshotdepth(rev)
787 787 # If text is significantly larger than the base, we can
788 788 # expect the resulting delta to be proportional to the size
789 789 # difference
790 790 revsize = revlog.rawsize(rev)
791 791 rawsizedistance = max(textlen - revsize, 0)
792 792 # use an estimate of the compression upper bound.
793 793 lowestrealisticdeltalen = rawsizedistance // maxcomp
794 794
795 795 # check the absolute constraint on the delta size
796 796 snapshotlimit = textlen >> snapshotdepth
797 797 if snapshotlimit < lowestrealisticdeltalen:
798 798 # delta lower bound is larger than accepted upper bound
799 799 tested.add(rev)
800 800 continue
801 801
802 802 # check the relative constraint on the delta size
803 803 revlength = revlog.length(rev)
804 804 if revlength < lowestrealisticdeltalen:
805 805 # delta probable lower bound is larger than target base
806 806 tested.add(rev)
807 807 continue
808 808
809 809 group.append(rev)
810 810 if group:
811 811 # When the size of the candidate group is big, it can result in a
812 812 # quite significant performance impact. To reduce this, we can send
813 813 # them in smaller batches until the new batch does not provide any
814 814 # improvements.
815 815 #
816 816 # This might reduce the overall efficiency of the compression in
817 817 # some corner cases, but that should also prevent very pathological
818 818 # cases from being an issue. (eg. 20 000 candidates).
819 819 #
820 820 # XXX note that the ordering of the group becomes important as it
821 821 # now impacts the final result. The current order is unprocessed
822 822 # and can be improved.
823 823 if group_chunk_size == 0:
824 824 tested.update(group)
825 825 good = yield tuple(group)
826 826 else:
827 827 prev_good = good
828 828 for start in range(0, len(group), group_chunk_size):
829 829 sub_group = group[start : start + group_chunk_size]
830 830 tested.update(sub_group)
831 831 good = yield tuple(sub_group)
832 832 if prev_good == good:
833 833 break
834 834
835 835 yield None
836 836
837 837
838 838 def _refinedgroups(revlog, p1, p2, cachedelta, snapshot_cache=None):
839 839 good = None
840 840 # First we try to reuse a the delta contained in the bundle.
841 841 # (or from the source revlog)
842 842 #
843 843 # This logic only applies to general delta repositories and can be disabled
844 844 # through configuration. Disabling reuse source delta is useful when
845 845 # we want to make sure we recomputed "optimal" deltas.
846 846 debug_info = None
847 847 if cachedelta is not None and cachedelta[2] > DELTA_BASE_REUSE_NO:
848 848 # Assume what we received from the server is a good choice
849 849 # build delta will reuse the cache
850 850 if debug_info is not None:
851 851 debug_info['cached-delta.tested'] += 1
852 852 good = yield (cachedelta[0],)
853 853 if good is not None:
854 854 if debug_info is not None:
855 855 debug_info['cached-delta.accepted'] += 1
856 856 yield None
857 857 return
858 858 if snapshot_cache is None:
859 859 snapshot_cache = SnapshotCache()
860 860 groups = _rawgroups(
861 861 revlog,
862 862 p1,
863 863 p2,
864 864 cachedelta,
865 865 snapshot_cache,
866 866 )
867 867 for candidates in groups:
868 868 good = yield candidates
869 869 if good is not None:
870 870 break
871 871
872 872 # If sparse revlog is enabled, we can try to refine the available deltas
873 873 if not revlog._sparserevlog:
874 874 yield None
875 875 return
876 876
877 877 # if we have a refinable value, try to refine it
878 878 if good is not None and good not in (p1, p2) and revlog.issnapshot(good):
879 879 # refine snapshot down
880 880 previous = None
881 881 while previous != good:
882 882 previous = good
883 883 base = revlog.deltaparent(good)
884 884 if base == nullrev:
885 885 break
886 886 good = yield (base,)
887 887 # refine snapshot up
888 888 if not snapshot_cache.snapshots:
889 889 snapshot_cache.update(revlog, good + 1)
890 890 previous = None
891 891 while good != previous:
892 892 previous = good
893 893 children = tuple(sorted(c for c in snapshot_cache.snapshots[good]))
894 894 good = yield children
895 895
896 896 if debug_info is not None:
897 897 if good is None:
898 898 debug_info['no-solution'] += 1
899 899
900 900 yield None
901 901
902 902
903 903 def _rawgroups(revlog, p1, p2, cachedelta, snapshot_cache=None):
904 904 """Provides group of revision to be tested as delta base
905 905
906 906 This lower level function focus on emitting delta theorically interresting
907 907 without looking it any practical details.
908 908
909 909 The group order aims at providing fast or small candidates first.
910 910 """
911 911 # Why search for delta base if we cannot use a delta base ?
912 912 assert revlog._generaldelta
913 913 # also see issue6056
914 914 sparse = revlog._sparserevlog
915 915 curr = len(revlog)
916 916 prev = curr - 1
917 917 deltachain = lambda rev: revlog._deltachain(rev)[0]
918 918
919 919 # exclude already lazy tested base if any
920 920 parents = [p for p in (p1, p2) if p != nullrev]
921 921
922 922 if not revlog._deltabothparents and len(parents) == 2:
923 923 parents.sort()
924 924 # To minimize the chance of having to build a fulltext,
925 925 # pick first whichever parent is closest to us (max rev)
926 926 yield (parents[1],)
927 927 # then the other one (min rev) if the first did not fit
928 928 yield (parents[0],)
929 929 elif len(parents) > 0:
930 930 # Test all parents (1 or 2), and keep the best candidate
931 931 yield parents
932 932
933 933 if sparse and parents:
934 934 if snapshot_cache is None:
935 935 # map: base-rev: [snapshot-revs]
936 936 snapshot_cache = SnapshotCache()
937 937 # See if we can use an existing snapshot in the parent chains to use as
938 938 # a base for a new intermediate-snapshot
939 939 #
940 940 # search for snapshot in parents delta chain
941 941 # map: snapshot-level: snapshot-rev
942 942 parents_snaps = collections.defaultdict(set)
943 943 candidate_chains = [deltachain(p) for p in parents]
944 944 for chain in candidate_chains:
945 945 for idx, s in enumerate(chain):
946 946 if not revlog.issnapshot(s):
947 947 break
948 948 parents_snaps[idx].add(s)
949 949 snapfloor = min(parents_snaps[0]) + 1
950 950 snapshot_cache.update(revlog, snapfloor)
951 951 # search for the highest "unrelated" revision
952 952 #
953 953 # Adding snapshots used by "unrelated" revision increase the odd we
954 954 # reuse an independant, yet better snapshot chain.
955 955 #
956 956 # XXX instead of building a set of revisions, we could lazily enumerate
957 957 # over the chains. That would be more efficient, however we stick to
958 958 # simple code for now.
959 959 all_revs = set()
960 960 for chain in candidate_chains:
961 961 all_revs.update(chain)
962 962 other = None
963 963 for r in revlog.revs(prev, snapfloor):
964 964 if r not in all_revs:
965 965 other = r
966 966 break
967 967 if other is not None:
968 968 # To avoid unfair competition, we won't use unrelated intermediate
969 969 # snapshot that are deeper than the ones from the parent delta
970 970 # chain.
971 971 max_depth = max(parents_snaps.keys())
972 972 chain = deltachain(other)
973 973 for depth, s in enumerate(chain):
974 974 if s < snapfloor:
975 975 continue
976 976 if max_depth < depth:
977 977 break
978 978 if not revlog.issnapshot(s):
979 979 break
980 980 parents_snaps[depth].add(s)
981 981 # Test them as possible intermediate snapshot base
982 982 # We test them from highest to lowest level. High level one are more
983 983 # likely to result in small delta
984 984 floor = None
985 985 for idx, snaps in sorted(parents_snaps.items(), reverse=True):
986 986 siblings = set()
987 987 for s in snaps:
988 988 siblings.update(snapshot_cache.snapshots[s])
989 989 # Before considering making a new intermediate snapshot, we check
990 990 # if an existing snapshot, children of base we consider, would be
991 991 # suitable.
992 992 #
993 993 # It give a change to reuse a delta chain "unrelated" to the
994 994 # current revision instead of starting our own. Without such
995 995 # re-use, topological branches would keep reopening new chains.
996 996 # Creating more and more snapshot as the repository grow.
997 997
998 998 if floor is not None:
999 999 # We only do this for siblings created after the one in our
1000 1000 # parent's delta chain. Those created before has less chances
1001 1001 # to be valid base since our ancestors had to create a new
1002 1002 # snapshot.
1003 1003 siblings = [r for r in siblings if floor < r]
1004 1004 yield tuple(sorted(siblings))
1005 1005 # then test the base from our parent's delta chain.
1006 1006 yield tuple(sorted(snaps))
1007 1007 floor = min(snaps)
1008 1008 # No suitable base found in the parent chain, search if any full
1009 1009 # snapshots emitted since parent's base would be a suitable base for an
1010 1010 # intermediate snapshot.
1011 1011 #
1012 1012 # It give a chance to reuse a delta chain unrelated to the current
1013 1013 # revisions instead of starting our own. Without such re-use,
1014 1014 # topological branches would keep reopening new full chains. Creating
1015 1015 # more and more snapshot as the repository grow.
1016 1016 full = [r for r in snapshot_cache.snapshots[nullrev] if snapfloor <= r]
1017 1017 yield tuple(sorted(full))
1018 1018
1019 1019 if not sparse:
1020 1020 # other approach failed try against prev to hopefully save us a
1021 1021 # fulltext.
1022 1022 yield (prev,)
1023 1023
1024 1024
1025 1025 class SnapshotCache:
1026 1026 __slots__ = ('snapshots', '_start_rev', '_end_rev')
1027 1027
1028 1028 def __init__(self):
1029 1029 self.snapshots = collections.defaultdict(set)
1030 1030 self._start_rev = None
1031 1031 self._end_rev = None
1032 1032
1033 1033 def update(self, revlog, start_rev=0):
1034 1034 """find snapshots from start_rev to tip"""
1035 1035 nb_revs = len(revlog)
1036 1036 end_rev = nb_revs - 1
1037 1037 if start_rev > end_rev:
1038 1038 return # range is empty
1039 1039
1040 1040 if self._start_rev is None:
1041 1041 assert self._end_rev is None
1042 1042 self._update(revlog, start_rev, end_rev)
1043 1043 elif not (self._start_rev <= start_rev and end_rev <= self._end_rev):
1044 1044 if start_rev < self._start_rev:
1045 1045 self._update(revlog, start_rev, self._start_rev - 1)
1046 1046 if self._end_rev < end_rev:
1047 1047 self._update(revlog, self._end_rev + 1, end_rev)
1048 1048
1049 1049 if self._start_rev is None:
1050 1050 assert self._end_rev is None
1051 1051 self._end_rev = end_rev
1052 1052 self._start_rev = start_rev
1053 1053 else:
1054 1054 self._start_rev = min(self._start_rev, start_rev)
1055 1055 self._end_rev = max(self._end_rev, end_rev)
1056 1056 assert self._start_rev <= self._end_rev, (
1057 1057 self._start_rev,
1058 1058 self._end_rev,
1059 1059 )
1060 1060
1061 1061 def _update(self, revlog, start_rev, end_rev):
1062 1062 """internal method that actually do update content"""
1063 1063 assert self._start_rev is None or (
1064 1064 start_rev < self._start_rev or start_rev > self._end_rev
1065 1065 ), (self._start_rev, self._end_rev, start_rev, end_rev)
1066 1066 assert self._start_rev is None or (
1067 1067 end_rev < self._start_rev or end_rev > self._end_rev
1068 1068 ), (self._start_rev, self._end_rev, start_rev, end_rev)
1069 1069 cache = self.snapshots
1070 1070 if util.safehasattr(revlog.index, b'findsnapshots'):
1071 1071 revlog.index.findsnapshots(cache, start_rev, end_rev)
1072 1072 else:
1073 1073 deltaparent = revlog.deltaparent
1074 1074 issnapshot = revlog.issnapshot
1075 1075 for rev in revlog.revs(start_rev, end_rev):
1076 1076 if issnapshot(rev):
1077 1077 cache[deltaparent(rev)].add(rev)
1078 1078
1079 1079
1080 1080 class deltacomputer:
1081 1081 def __init__(
1082 1082 self,
1083 1083 revlog,
1084 1084 write_debug=None,
1085 1085 debug_search=False,
1086 1086 debug_info=None,
1087 1087 ):
1088 1088 self.revlog = revlog
1089 1089 self._write_debug = write_debug
1090 1090 self._debug_search = debug_search
1091 1091 self._debug_info = debug_info
1092 1092 self._snapshot_cache = SnapshotCache()
1093 1093
1094 @property
1095 def _gather_debug(self):
1096 return self._write_debug is not None or self._debug_info is not None
1097
1094 1098 def buildtext(self, revinfo, fh):
1095 1099 """Builds a fulltext version of a revision
1096 1100
1097 1101 revinfo: revisioninfo instance that contains all needed info
1098 1102 fh: file handle to either the .i or the .d revlog file,
1099 1103 depending on whether it is inlined or not
1100 1104 """
1101 1105 btext = revinfo.btext
1102 1106 if btext[0] is not None:
1103 1107 return btext[0]
1104 1108
1105 1109 revlog = self.revlog
1106 1110 cachedelta = revinfo.cachedelta
1107 1111 baserev = cachedelta[0]
1108 1112 delta = cachedelta[1]
1109 1113
1110 1114 fulltext = btext[0] = _textfromdelta(
1111 1115 fh,
1112 1116 revlog,
1113 1117 baserev,
1114 1118 delta,
1115 1119 revinfo.p1,
1116 1120 revinfo.p2,
1117 1121 revinfo.flags,
1118 1122 revinfo.node,
1119 1123 )
1120 1124 return fulltext
1121 1125
1122 1126 def _builddeltadiff(self, base, revinfo, fh):
1123 1127 revlog = self.revlog
1124 1128 t = self.buildtext(revinfo, fh)
1125 1129 if revlog.iscensored(base):
1126 1130 # deltas based on a censored revision must replace the
1127 1131 # full content in one patch, so delta works everywhere
1128 1132 header = mdiff.replacediffheader(revlog.rawsize(base), len(t))
1129 1133 delta = header + t
1130 1134 else:
1131 1135 ptext = revlog.rawdata(base, _df=fh)
1132 1136 delta = mdiff.textdiff(ptext, t)
1133 1137
1134 1138 return delta
1135 1139
1136 1140 def _builddeltainfo(self, revinfo, base, fh, target_rev=None):
1137 1141 # can we use the cached delta?
1138 1142 revlog = self.revlog
1139 1143 debug_search = self._write_debug is not None and self._debug_search
1140 1144 chainbase = revlog.chainbase(base)
1141 1145 if revlog._generaldelta:
1142 1146 deltabase = base
1143 1147 else:
1144 1148 if target_rev is not None and base != target_rev - 1:
1145 1149 msg = (
1146 1150 b'general delta cannot use delta for something else '
1147 1151 b'than `prev`: %d<-%d'
1148 1152 )
1149 1153 msg %= (base, target_rev)
1150 1154 raise error.ProgrammingError(msg)
1151 1155 deltabase = chainbase
1152 1156 snapshotdepth = None
1153 1157 if revlog._sparserevlog and deltabase == nullrev:
1154 1158 snapshotdepth = 0
1155 1159 elif revlog._sparserevlog and revlog.issnapshot(deltabase):
1156 1160 # A delta chain should always be one full snapshot,
1157 1161 # zero or more semi-snapshots, and zero or more deltas
1158 1162 p1, p2 = revlog.rev(revinfo.p1), revlog.rev(revinfo.p2)
1159 1163 if deltabase not in (p1, p2) and revlog.issnapshot(deltabase):
1160 1164 snapshotdepth = len(revlog._deltachain(deltabase)[0])
1161 1165 delta = None
1162 1166 if revinfo.cachedelta:
1163 1167 cachebase = revinfo.cachedelta[0]
1164 1168 # check if the diff still apply
1165 1169 currentbase = cachebase
1166 1170 while (
1167 1171 currentbase != nullrev
1168 1172 and currentbase != base
1169 1173 and self.revlog.length(currentbase) == 0
1170 1174 ):
1171 1175 currentbase = self.revlog.deltaparent(currentbase)
1172 1176 if self.revlog._lazydelta and currentbase == base:
1173 1177 delta = revinfo.cachedelta[1]
1174 1178 if delta is None:
1175 1179 delta = self._builddeltadiff(base, revinfo, fh)
1176 1180 if debug_search:
1177 1181 msg = b"DBG-DELTAS-SEARCH: uncompressed-delta-size=%d\n"
1178 1182 msg %= len(delta)
1179 1183 self._write_debug(msg)
1180 1184 # snapshotdept need to be neither None nor 0 level snapshot
1181 1185 if revlog.upperboundcomp is not None and snapshotdepth:
1182 1186 lowestrealisticdeltalen = len(delta) // revlog.upperboundcomp
1183 1187 snapshotlimit = revinfo.textlen >> snapshotdepth
1184 1188 if debug_search:
1185 1189 msg = b"DBG-DELTAS-SEARCH: projected-lower-size=%d\n"
1186 1190 msg %= lowestrealisticdeltalen
1187 1191 self._write_debug(msg)
1188 1192 if snapshotlimit < lowestrealisticdeltalen:
1189 1193 if debug_search:
1190 1194 msg = b"DBG-DELTAS-SEARCH: DISCARDED (snapshot limit)\n"
1191 1195 self._write_debug(msg)
1192 1196 return None
1193 1197 if revlog.length(base) < lowestrealisticdeltalen:
1194 1198 if debug_search:
1195 1199 msg = b"DBG-DELTAS-SEARCH: DISCARDED (prev size)\n"
1196 1200 self._write_debug(msg)
1197 1201 return None
1198 1202 header, data = revlog.compress(delta)
1199 1203 deltalen = len(header) + len(data)
1200 1204 offset = revlog.end(len(revlog) - 1)
1201 1205 dist = deltalen + offset - revlog.start(chainbase)
1202 1206 chainlen, compresseddeltalen = revlog._chaininfo(base)
1203 1207 chainlen += 1
1204 1208 compresseddeltalen += deltalen
1205 1209
1206 1210 return _deltainfo(
1207 1211 dist,
1208 1212 deltalen,
1209 1213 (header, data),
1210 1214 deltabase,
1211 1215 chainbase,
1212 1216 chainlen,
1213 1217 compresseddeltalen,
1214 1218 snapshotdepth,
1215 1219 )
1216 1220
1217 1221 def _fullsnapshotinfo(self, fh, revinfo, curr):
1218 1222 rawtext = self.buildtext(revinfo, fh)
1219 1223 data = self.revlog.compress(rawtext)
1220 1224 compresseddeltalen = deltalen = dist = len(data[1]) + len(data[0])
1221 1225 deltabase = chainbase = curr
1222 1226 snapshotdepth = 0
1223 1227 chainlen = 1
1224 1228
1225 1229 return _deltainfo(
1226 1230 dist,
1227 1231 deltalen,
1228 1232 data,
1229 1233 deltabase,
1230 1234 chainbase,
1231 1235 chainlen,
1232 1236 compresseddeltalen,
1233 1237 snapshotdepth,
1234 1238 )
1235 1239
1236 1240 def finddeltainfo(self, revinfo, fh, excluded_bases=None, target_rev=None):
1237 1241 """Find an acceptable delta against a candidate revision
1238 1242
1239 1243 revinfo: information about the revision (instance of _revisioninfo)
1240 1244 fh: file handle to either the .i or the .d revlog file,
1241 1245 depending on whether it is inlined or not
1242 1246
1243 1247 Returns the first acceptable candidate revision, as ordered by
1244 1248 _candidategroups
1245 1249
1246 1250 If no suitable deltabase is found, we return delta info for a full
1247 1251 snapshot.
1248 1252
1249 1253 `excluded_bases` is an optional set of revision that cannot be used as
1250 1254 a delta base. Use this to recompute delta suitable in censor or strip
1251 1255 context.
1252 1256 """
1253 1257 if target_rev is None:
1254 1258 target_rev = len(self.revlog)
1255 1259
1256 1260 if not revinfo.textlen:
1257 1261 return self._fullsnapshotinfo(fh, revinfo, target_rev)
1258 1262
1259 1263 if excluded_bases is None:
1260 1264 excluded_bases = set()
1261 1265
1262 1266 # no delta for flag processor revision (see "candelta" for why)
1263 1267 # not calling candelta since only one revision needs test, also to
1264 1268 # avoid overhead fetching flags again.
1265 1269 if revinfo.flags & REVIDX_RAWTEXT_CHANGING_FLAGS:
1266 1270 return self._fullsnapshotinfo(fh, revinfo, target_rev)
1267 1271
1268 gather_debug = (
1269 self._write_debug is not None or self._debug_info is not None
1270 )
1271 1272 debug_search = self._write_debug is not None and self._debug_search
1273 gather_debug = self._gather_debug
1272 1274
1273 1275 if gather_debug:
1274 1276 start = util.timer()
1275 1277
1276 1278 # count the number of different delta we tried (for debug purpose)
1277 1279 dbg_try_count = 0
1278 1280 # count the number of "search round" we did. (for debug purpose)
1279 1281 dbg_try_rounds = 0
1280 1282 dbg_type = b'unknown'
1281 1283
1282 1284 cachedelta = revinfo.cachedelta
1283 1285 p1 = revinfo.p1
1284 1286 p2 = revinfo.p2
1285 1287 revlog = self.revlog
1286 1288
1287 1289 deltainfo = None
1288 1290 p1r, p2r = revlog.rev(p1), revlog.rev(p2)
1289 1291
1290 1292 if gather_debug:
1291 1293 if p1r != nullrev:
1292 1294 p1_chain_len = revlog._chaininfo(p1r)[0]
1293 1295 else:
1294 1296 p1_chain_len = -1
1295 1297 if p2r != nullrev:
1296 1298 p2_chain_len = revlog._chaininfo(p2r)[0]
1297 1299 else:
1298 1300 p2_chain_len = -1
1299 1301 if debug_search:
1300 1302 msg = b"DBG-DELTAS-SEARCH: SEARCH rev=%d\n"
1301 1303 msg %= target_rev
1302 1304 self._write_debug(msg)
1303 1305
1304 1306 groups = _candidategroups(
1305 1307 self.revlog,
1306 1308 revinfo.textlen,
1307 1309 p1r,
1308 1310 p2r,
1309 1311 cachedelta,
1310 1312 excluded_bases,
1311 1313 target_rev,
1312 1314 snapshot_cache=self._snapshot_cache,
1313 1315 )
1314 1316 candidaterevs = next(groups)
1315 1317 while candidaterevs is not None:
1316 1318 dbg_try_rounds += 1
1317 1319 if debug_search:
1318 1320 prev = None
1319 1321 if deltainfo is not None:
1320 1322 prev = deltainfo.base
1321 1323
1322 1324 if (
1323 1325 cachedelta is not None
1324 1326 and len(candidaterevs) == 1
1325 1327 and cachedelta[0] in candidaterevs
1326 1328 ):
1327 1329 round_type = b"cached-delta"
1328 1330 elif p1 in candidaterevs or p2 in candidaterevs:
1329 1331 round_type = b"parents"
1330 1332 elif prev is not None and all(c < prev for c in candidaterevs):
1331 1333 round_type = b"refine-down"
1332 1334 elif prev is not None and all(c > prev for c in candidaterevs):
1333 1335 round_type = b"refine-up"
1334 1336 else:
1335 1337 round_type = b"search-down"
1336 1338 msg = b"DBG-DELTAS-SEARCH: ROUND #%d - %d candidates - %s\n"
1337 1339 msg %= (dbg_try_rounds, len(candidaterevs), round_type)
1338 1340 self._write_debug(msg)
1339 1341 nominateddeltas = []
1340 1342 if deltainfo is not None:
1341 1343 if debug_search:
1342 1344 msg = (
1343 1345 b"DBG-DELTAS-SEARCH: CONTENDER: rev=%d - length=%d\n"
1344 1346 )
1345 1347 msg %= (deltainfo.base, deltainfo.deltalen)
1346 1348 self._write_debug(msg)
1347 1349 # if we already found a good delta,
1348 1350 # challenge it against refined candidates
1349 1351 nominateddeltas.append(deltainfo)
1350 1352 for candidaterev in candidaterevs:
1351 1353 if debug_search:
1352 1354 msg = b"DBG-DELTAS-SEARCH: CANDIDATE: rev=%d\n"
1353 1355 msg %= candidaterev
1354 1356 self._write_debug(msg)
1355 1357 candidate_type = None
1356 1358 if candidaterev == p1:
1357 1359 candidate_type = b"p1"
1358 1360 elif candidaterev == p2:
1359 1361 candidate_type = b"p2"
1360 1362 elif self.revlog.issnapshot(candidaterev):
1361 1363 candidate_type = b"snapshot-%d"
1362 1364 candidate_type %= self.revlog.snapshotdepth(
1363 1365 candidaterev
1364 1366 )
1365 1367
1366 1368 if candidate_type is not None:
1367 1369 msg = b"DBG-DELTAS-SEARCH: type=%s\n"
1368 1370 msg %= candidate_type
1369 1371 self._write_debug(msg)
1370 1372 msg = b"DBG-DELTAS-SEARCH: size=%d\n"
1371 1373 msg %= self.revlog.length(candidaterev)
1372 1374 self._write_debug(msg)
1373 1375 msg = b"DBG-DELTAS-SEARCH: base=%d\n"
1374 1376 msg %= self.revlog.deltaparent(candidaterev)
1375 1377 self._write_debug(msg)
1376 1378
1377 1379 dbg_try_count += 1
1378 1380
1379 1381 if debug_search:
1380 1382 delta_start = util.timer()
1381 1383 candidatedelta = self._builddeltainfo(
1382 1384 revinfo,
1383 1385 candidaterev,
1384 1386 fh,
1385 1387 target_rev=target_rev,
1386 1388 )
1387 1389 if debug_search:
1388 1390 delta_end = util.timer()
1389 1391 msg = b"DBG-DELTAS-SEARCH: delta-search-time=%f\n"
1390 1392 msg %= delta_end - delta_start
1391 1393 self._write_debug(msg)
1392 1394 if candidatedelta is not None:
1393 1395 if is_good_delta_info(self.revlog, candidatedelta, revinfo):
1394 1396 if debug_search:
1395 1397 msg = b"DBG-DELTAS-SEARCH: DELTA: length=%d (GOOD)\n"
1396 1398 msg %= candidatedelta.deltalen
1397 1399 self._write_debug(msg)
1398 1400 nominateddeltas.append(candidatedelta)
1399 1401 elif debug_search:
1400 1402 msg = b"DBG-DELTAS-SEARCH: DELTA: length=%d (BAD)\n"
1401 1403 msg %= candidatedelta.deltalen
1402 1404 self._write_debug(msg)
1403 1405 elif debug_search:
1404 1406 msg = b"DBG-DELTAS-SEARCH: NO-DELTA\n"
1405 1407 self._write_debug(msg)
1406 1408 if nominateddeltas:
1407 1409 deltainfo = min(nominateddeltas, key=lambda x: x.deltalen)
1408 1410 if deltainfo is not None:
1409 1411 candidaterevs = groups.send(deltainfo.base)
1410 1412 else:
1411 1413 candidaterevs = next(groups)
1412 1414
1413 1415 if deltainfo is None:
1414 1416 dbg_type = b"full"
1415 1417 deltainfo = self._fullsnapshotinfo(fh, revinfo, target_rev)
1416 1418 elif deltainfo.snapshotdepth: # pytype: disable=attribute-error
1417 1419 dbg_type = b"snapshot"
1418 1420 else:
1419 1421 dbg_type = b"delta"
1420 1422
1421 1423 if gather_debug:
1422 1424 end = util.timer()
1423 1425 if dbg_type == b'full':
1424 1426 used_cached = (
1425 1427 cachedelta is not None
1426 1428 and dbg_try_rounds == 0
1427 1429 and dbg_try_count == 0
1428 1430 and cachedelta[0] == nullrev
1429 1431 )
1430 1432 else:
1431 1433 used_cached = (
1432 1434 cachedelta is not None
1433 1435 and dbg_try_rounds == 1
1434 1436 and dbg_try_count == 1
1435 1437 and deltainfo.base == cachedelta[0]
1436 1438 )
1437 1439 dbg = {
1438 1440 'duration': end - start,
1439 1441 'revision': target_rev,
1440 1442 'delta-base': deltainfo.base, # pytype: disable=attribute-error
1441 1443 'search_round_count': dbg_try_rounds,
1442 1444 'using-cached-base': used_cached,
1443 1445 'delta_try_count': dbg_try_count,
1444 1446 'type': dbg_type,
1445 1447 'p1-chain-len': p1_chain_len,
1446 1448 'p2-chain-len': p2_chain_len,
1447 1449 }
1448 1450 if (
1449 1451 deltainfo.snapshotdepth # pytype: disable=attribute-error
1450 1452 is not None
1451 1453 ):
1452 1454 dbg[
1453 1455 'snapshot-depth'
1454 1456 ] = deltainfo.snapshotdepth # pytype: disable=attribute-error
1455 1457 else:
1456 1458 dbg['snapshot-depth'] = 0
1457 1459 target_revlog = b"UNKNOWN"
1458 1460 target_type = self.revlog.target[0]
1459 1461 target_key = self.revlog.target[1]
1460 1462 if target_type == KIND_CHANGELOG:
1461 1463 target_revlog = b'CHANGELOG:'
1462 1464 elif target_type == KIND_MANIFESTLOG:
1463 1465 target_revlog = b'MANIFESTLOG:'
1464 1466 if target_key:
1465 1467 target_revlog += b'%s:' % target_key
1466 1468 elif target_type == KIND_FILELOG:
1467 1469 target_revlog = b'FILELOG:'
1468 1470 if target_key:
1469 1471 target_revlog += b'%s:' % target_key
1470 1472 dbg['target-revlog'] = target_revlog
1471 1473
1472 1474 if self._debug_info is not None:
1473 1475 self._debug_info.append(dbg)
1474 1476
1475 1477 if self._write_debug is not None:
1476 1478 msg = (
1477 1479 b"DBG-DELTAS:"
1478 1480 b" %-12s"
1479 1481 b" rev=%d:"
1480 1482 b" delta-base=%d"
1481 1483 b" is-cached=%d"
1482 1484 b" - search-rounds=%d"
1483 1485 b" try-count=%d"
1484 1486 b" - delta-type=%-6s"
1485 1487 b" snap-depth=%d"
1486 1488 b" - p1-chain-length=%d"
1487 1489 b" p2-chain-length=%d"
1488 1490 b" - duration=%f"
1489 1491 b"\n"
1490 1492 )
1491 1493 msg %= (
1492 1494 dbg["target-revlog"],
1493 1495 dbg["revision"],
1494 1496 dbg["delta-base"],
1495 1497 dbg["using-cached-base"],
1496 1498 dbg["search_round_count"],
1497 1499 dbg["delta_try_count"],
1498 1500 dbg["type"],
1499 1501 dbg["snapshot-depth"],
1500 1502 dbg["p1-chain-len"],
1501 1503 dbg["p2-chain-len"],
1502 1504 dbg["duration"],
1503 1505 )
1504 1506 self._write_debug(msg)
1505 1507 return deltainfo
1506 1508
1507 1509
1508 1510 def delta_compression(default_compression_header, deltainfo):
1509 1511 """return (COMPRESSION_MODE, deltainfo)
1510 1512
1511 1513 used by revlog v2+ format to dispatch between PLAIN and DEFAULT
1512 1514 compression.
1513 1515 """
1514 1516 h, d = deltainfo.data
1515 1517 compression_mode = COMP_MODE_INLINE
1516 1518 if not h and not d:
1517 1519 # not data to store at all... declare them uncompressed
1518 1520 compression_mode = COMP_MODE_PLAIN
1519 1521 elif not h:
1520 1522 t = d[0:1]
1521 1523 if t == b'\0':
1522 1524 compression_mode = COMP_MODE_PLAIN
1523 1525 elif t == default_compression_header:
1524 1526 compression_mode = COMP_MODE_DEFAULT
1525 1527 elif h == b'u':
1526 1528 # we have a more efficient way to declare uncompressed
1527 1529 h = b''
1528 1530 compression_mode = COMP_MODE_PLAIN
1529 1531 deltainfo = drop_u_compression(deltainfo)
1530 1532 return compression_mode, deltainfo
General Comments 0
You need to be logged in to leave comments. Login now