Mercurial > public > mercurial-scm > hg-stable
comparison mercurial/revlog.py @ 46646:e9901d01d135
revlog: add a mechanism to verify expected file position before appending
If someone uses `hg debuglocks`, or some non-hg process writes to the .hg
directory without respecting the locks, or if the repo's on a networked
filesystem, it's possible for the revlog code to write out corrupted data.
The form of this corruption can vary depending on what data was written and how
that happened. We are in the "networked filesystem" case (though I've had users
also do this to themselves with the "`hg debuglocks`" scenario), and most often
see this with the changelog. What ends up happening is we produce two items
(let's call them rev1 and rev2) in the .i file that have the same linkrev,
baserev, and offset into the .d file, while the data in the .d file is appended
properly. rev2's compressed_size is accurate for rev2, but when we go to
decompress the data in the .d file, we use the offset that's recorded in the
index file, which is the same as rev1, and attempt to decompress
rev2.compressed_size bytes of rev1's data. This usually does not succeed. :)
When using inline data, this also fails, though I haven't investigated why too
closely. This shows up as a "patch decode" error. I believe what's happening
there is that we're basically ignoring the offset field, getting the data
properly, but since baserev != rev, it thinks this is a delta based on rev
(instead of a full text) and can't actually apply it as such.
For now, I'm going to make this an optional component and default it to entirely
off. I may increase the default severity of this in the future, once I've
enabled it for my users and we gain more experience with it. Luckily, most of my
users have a versioned filesystem and can roll back to before the corruption has
been written, it's just a hassle to do so and not everyone knows how (so it's a
support burden). Users on other filesystems will not have that luxury, and this
can cause them to have a corrupted repository that they are unlikely to know how
to resolve, and they'll see this as a data-loss event. Refusing to create the
corruption is a much better user experience.
This mechanism is not perfect. There may be false-negatives (racy writes that
are not detected). There should not be any false-positives (non-racy writes that
are detected as such). This is not a mechanism that makes putting a repo on a
networked filesystem "safe" or "supported", just *less* likely to cause
corruption.
Differential Revision: https://phab.mercurial-scm.org/D9952
author | Kyle Lippincott <spectral@google.com> |
---|---|
date | Wed, 03 Feb 2021 16:33:10 -0800 |
parents | 7a93b7b3dc2d |
children | 913485776542 |
comparison
equal
deleted
inserted
replaced
46645:ced66295ea90 | 46646:e9901d01d135 |
---|---|
419 | 419 |
420 If censorable is True, the revlog can have censored revisions. | 420 If censorable is True, the revlog can have censored revisions. |
421 | 421 |
422 If `upperboundcomp` is not None, this is the expected maximal gain from | 422 If `upperboundcomp` is not None, this is the expected maximal gain from |
423 compression for the data content. | 423 compression for the data content. |
424 | |
425 `concurrencychecker` is an optional function that receives 3 arguments: a | |
426 file handle, a filename, and an expected position. It should check whether | |
427 the current position in the file handle is valid, and log/warn/fail (by | |
428 raising). | |
424 """ | 429 """ |
425 | 430 |
426 _flagserrorclass = error.RevlogError | 431 _flagserrorclass = error.RevlogError |
427 | 432 |
428 def __init__( | 433 def __init__( |
433 checkambig=False, | 438 checkambig=False, |
434 mmaplargeindex=False, | 439 mmaplargeindex=False, |
435 censorable=False, | 440 censorable=False, |
436 upperboundcomp=None, | 441 upperboundcomp=None, |
437 persistentnodemap=False, | 442 persistentnodemap=False, |
443 concurrencychecker=None, | |
438 ): | 444 ): |
439 """ | 445 """ |
440 create a revlog object | 446 create a revlog object |
441 | 447 |
442 opener is a function that abstracts the file opening operation | 448 opener is a function that abstracts the file opening operation |
487 | 493 |
488 # 2-tuple of file handles being used for active writing. | 494 # 2-tuple of file handles being used for active writing. |
489 self._writinghandles = None | 495 self._writinghandles = None |
490 | 496 |
491 self._loadindex() | 497 self._loadindex() |
498 | |
499 self._concurrencychecker = concurrencychecker | |
492 | 500 |
493 def _loadindex(self): | 501 def _loadindex(self): |
494 mmapindexthreshold = None | 502 mmapindexthreshold = None |
495 opts = self.opener.options | 503 opts = self.opener.options |
496 | 504 |
2282 btext = [rawtext] | 2290 btext = [rawtext] |
2283 | 2291 |
2284 curr = len(self) | 2292 curr = len(self) |
2285 prev = curr - 1 | 2293 prev = curr - 1 |
2286 offset = self.end(prev) | 2294 offset = self.end(prev) |
2295 | |
2296 if self._concurrencychecker: | |
2297 if self._inline: | |
2298 # offset is "as if" it were in the .d file, so we need to add on | |
2299 # the size of the entry metadata. | |
2300 self._concurrencychecker( | |
2301 ifh, self.indexfile, offset + curr * self._io.size | |
2302 ) | |
2303 else: | |
2304 # Entries in the .i are a consistent size. | |
2305 self._concurrencychecker( | |
2306 ifh, self.indexfile, curr * self._io.size | |
2307 ) | |
2308 self._concurrencychecker(dfh, self.datafile, offset) | |
2309 | |
2287 p1r, p2r = self.rev(p1), self.rev(p2) | 2310 p1r, p2r = self.rev(p1), self.rev(p2) |
2288 | 2311 |
2289 # full versions are inserted when the needed deltas | 2312 # full versions are inserted when the needed deltas |
2290 # become comparable to the uncompressed text | 2313 # become comparable to the uncompressed text |
2291 if rawtext is None: | 2314 if rawtext is None: |