README.md: introduce known issue section #675
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fuweid
force-pushed
the
update-unknown-issues
branch
from
e7625aa to
73615a1
Compare
ahrtr
reviewed
Jan 12, 2024
README.md
Outdated
Comment on lines
937
to
944
| ## Known Issue | ||
|
|
||
| - Linux kernel releases [ext4: fast commits](https://lwn.net/Articles/842385/) | ||
| feature in v5.10. It's a new, lighter-weight journaling method to reduce | ||
| unrelated IO for fsync/fdatasync. However, `fast commits` is new feature and | ||
| users run into data loss issue after power failure. The data loss cat corrupt | ||
| boltdb. If you enable fast commits feature on ext4 filesystem, please ensure | ||
| that the kernel includes related fix patches to fast commit. Details in [issue 562](https://github.com/etcd-io/bbolt/issues/562). |
There was a problem hiding this comment.
- Please add an item in the content
- Please also provide a link to the fast commit issue, and also clarify which linux kernel versions contain the fix or a related link for users reference.
There was a problem hiding this comment.
Updated. Please take a look. Thanks
fuweid
force-pushed
the
update-unknown-issues
branch
from
73615a1 to
0b479c9
Compare
ahrtr
reviewed
Jan 12, 2024
README.md
Outdated
| @@ -69,6 +69,7 @@ New minor versions may add additional features to the API. | |||
| - [LMDB](#lmdb) | |||
| - [Caveats & Limitations](#caveats--limitations) | |||
| - [Reading the Source](#reading-the-source) | |||
| - [Known Issue](#known-issue) | |||
There was a problem hiding this comment.
Suggested change
| - [Known Issue](#known-issue) | |
| - [Known Issues](#known-issues) |
README.md
Outdated
Comment on lines
938
to
951
| ## Known Issue | ||
|
|
||
| - Linux kernel releases [ext4: fast commits](https://lwn.net/Articles/842385/) | ||
| feature in v5.10. It's a new, lighter-weight journaling method to reduce | ||
| unrelated IO for fsync/fdatasync. However, `fast commits` is new feature and | ||
| users run into data loss issue after power failure. The data loss cat corrupt | ||
| boltdb. There are some related patches. | ||
|
|
||
| * [ext4: fast commit may miss tracking unwritten range during ftruncate](https://lore.kernel.org/linux-ext4/[email protected]/) | ||
| * [ext4: fast commit may not fallback for ineligible commit](https://lore.kernel.org/lkml/[email protected]/T/#ma0768815e4b5f671e9e451d578256ef9a76fe30e) | ||
|
|
||
| These patches were merged into [kernel v5.17](https://lore.kernel.org/lkml/[email protected]/). | ||
| If you enable fast commits feature on ext4 filesystem, please ensure that the | ||
| kernel includes related fix patches to fast commit. Details in [issue 562](https://github.com/etcd-io/bbolt/issues/562). |
There was a problem hiding this comment.
Suggested change
| ## Known Issue | |
| - Linux kernel releases [ext4: fast commits](https://lwn.net/Articles/842385/) | |
| feature in v5.10. It's a new, lighter-weight journaling method to reduce | |
| unrelated IO for fsync/fdatasync. However, `fast commits` is new feature and | |
| users run into data loss issue after power failure. The data loss cat corrupt | |
| boltdb. There are some related patches. | |
| * [ext4: fast commit may miss tracking unwritten range during ftruncate](https://lore.kernel.org/linux-ext4/[email protected]/) | |
| * [ext4: fast commit may not fallback for ineligible commit](https://lore.kernel.org/lkml/[email protected]/T/#ma0768815e4b5f671e9e451d578256ef9a76fe30e) | |
| These patches were merged into [kernel v5.17](https://lore.kernel.org/lkml/[email protected]/). | |
| If you enable fast commits feature on ext4 filesystem, please ensure that the | |
| kernel includes related fix patches to fast commit. Details in [issue 562](https://github.com/etcd-io/bbolt/issues/562). | |
| ## Known issues | |
| - bbolt might run into data corruption issue on Linux when the feature | |
| [ext4: fast commit](https://lwn.net/Articles/842385/), which was introduced in | |
| linux kernel version v5.10, is enabled. The fixes to the issue were included in | |
| linux kernel version v5.17, please refer to links below, | |
| * [ext4: fast commit may miss tracking unwritten range during ftruncate](https://lore.kernel.org/linux-ext4/[email protected]/) | |
| * [ext4: fast commit may not fallback for ineligible commit](https://lore.kernel.org/lkml/[email protected]/T/#ma0768815e4b5f671e9e451d578256ef9a76fe30e) | |
| * [ext4 updates for 5.17](https://lore.kernel.org/lkml/[email protected]/) | |
| Please also refer to the discussion in https://github.com/etcd-io/bbolt/issues/562. |
The users might run into data corrupted issues caused by underlay filesystem. It's out of scope for bboltdb maintainers to fix filesystem issue. But the section to track known issues can help users and contributors to analyse root cause when they run into data corrupted issues. Signed-off-by: Wei Fu <[email protected]>
fuweid
force-pushed
the
update-unknown-issues
branch
from
0b479c9 to
ae4ae4a
Compare
ahrtr
approved these changes
Jan 12, 2024
|
Thanks @ahrtr |
|
Based on the Linux kernel version history, both 5.10 and 5.15 are LTS releases, but 5.17 isn't. So I think we should clearly document the exact 5.10.x and 5.15.x patches in which the fix is included. |
This was referenced Feb 21, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The users might run into data corrupted issues caused by underlay filesystem. It's out of scope for bboltdb maintainers to fix filesystem issue. But the section to track known issues can help users and contributors to analyse root cause when they run into data corrupted issues.
Closes: #562
Thanks @fyfyrchik for providing the details!