openvmm: virtiofs: inode lookup count wraps to zero at u64::MAX
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- Half a day
- Newbie friendliness
- 68/100
- Issue type
- Bug
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- rust
- Domain
- operating-systems
Research direction
Start in vm/devices/virtio/virtiofs/src/inode.rs around lines 236-262: compare lookup/inc_lookup (which use fetch_add) with the neighbouring forget, which already uses AtomicU64::update with saturating_sub. Decide whether the restore path in vm/devices/virtio/virtiofs/src/microvm/state.rs (validate_microvm_state) should also reject an implausible lookup_count, then add a unit test that replays the reproduction steps and asserts the inode survives fs.forget(node_id, 1) followed by get_attr. Done means a lookup at u64::MAX keeps the count saturated and the node stays in InodeMap; run the virtiofs crate tests with cargo test -p virtiofs.
Written by the indexing model from the issue text.
Description
Summary
VirtioFsInode::lookup and VirtioFsInode::inc_lookup increment lookup_count with AtomicU64::fetch_add(1, Ordering::AcqRel), which uses wrapping arithmetic at u64::MAX. When an inode's lookup_count is u64::MAX — reachable directly via microVM saved-state restore without 2^64 live requests — one additional FUSE_LOOKUP, FUSE_READDIRPLUS, or FUSE_LINK wraps lookup_count to 0, allowing the next FUSE_FORGET to evict the still-referenced inode from InodeMap. Found by formal verification.
Root Cause
In vm/devices/virtio/virtiofs/src/inode.rs, both VirtioFsInode::lookup and VirtioFsInode::inc_lookup use fetch_add(1, Ordering::AcqRel) rather than saturating addition, even though VirtioFsInode::forget immediately below already uses AtomicU64::update with saturating_sub:
/// Increments the lookup count.
pub fn lookup(&self, new_path: PathBuf) {
self.lookup_count.fetch_add(1, Ordering::AcqRel);
self.aliases.write().insert(new_path.clone());
let mut path = self.path.write();
*path = new_path;
}
/// Increments the lookup count without updating the path.
///
/// This is used when returning an existing inode in a FUSE reply (e.g., for hard links)
/// where the kernel will track the reference and later send a forget.
pub fn inc_lookup(&self) {
self.lookup_count.fetch_add(1, Ordering::AcqRel);
}
In microVM mode, validate_microvm_state accepts any SavedInode with inode.lookup_count != 0, including u64::MAX, and restores it verbatim into VirtioFsInode::lookup_count.
Consequence
Once lookup_count wraps from u64::MAX to 0, the inode remains in InodeMap with a zero reference count until any FUSE_FORGET(node_id, n) arrives. At that point, Fuse::forget computes 0u64.saturating_sub(n) == 0 and removes the node from InodeMap while the guest still holds active FUSE references to node_id. Subsequent guest operations on node_id fail with EINVAL (request for unknown inode), and in microVM mode save_microvm_state also fails if an open handle still points to the evicted inode (open handle refers to an untracked inode).
Reproduction
- Create a temporary directory containing a file
"f", instantiateVirtioFs::new(dir.path(), None), and look up"f"once to obtainnode_id. - Set that inode's
lookup_counttou64::MAX(simulating a restoredSavedInodewithlookup_count: u64::MAXor cumulative lookups). - Look up
"f"a second time (or callinode.inc_lookup()).lookup_countwraps fromu64::MAXto0. - Call
fs.forget(node_id, 1)and thenfs.get_attronnode_id.forgetevictsnode_idfromInodeMap, andget_attrfails withlx::Error::EINVAL.
Related: #1627.
- Dominant language
- Rust
- Stars
- 831
- Forks
- 56
- Avg merge
- 13h 37m
- Merged PRs (30d)
- 571
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- No contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from microsoft/nvx
-
area: ci
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
area: ci
Difficulty 1/5 Under an hour Newbie friendliness 90/100
Maintainers usually reply within 1 day
-
openvmm: virtiofs: aggregate synthetic root st_nlink counts single-file shares as subdirectoriesOpenarea: openvmm
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
microsoft/nvx#1632 · 1 comment ·
Maintainers usually reply within 1 day
-
area: openvmm
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
microsoft/nvx#1628 · 1 comment ·
Maintainers usually reply within 1 day
-
area: openvmm
Difficulty 2/5 1-3 hours Newbie friendliness 80/100
microsoft/nvx#1629 · 1 comment ·
Maintainers usually reply within 1 day
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
oxc-project/tsrs#1010 ·
Maintainers usually reply within 1 day
-
Link is deadOpen
Difficulty 1/5 Under an hour Newbie friendliness 63/100
nicholas-ochoa/OpenSC2K#104 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
libracoder/kiri#445 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
DioxusLabs/blitz#1614 ·
Maintainers usually reply within 1 day