openvmm: virtiofs: inode lookup count wraps to zero at u64::MAX

Open
#1,633 1 comment 0 reactions 0 assignees View on GitHub

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

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

area: openvmm

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

  1. Create a temporary directory containing a file "f", instantiate VirtioFs::new(dir.path(), None), and look up "f" once to obtain node_id.
  2. Set that inode's lookup_count to u64::MAX (simulating a restored SavedInode with lookup_count: u64::MAX or cumulative lookups).
  3. Look up "f" a second time (or call inode.inc_lookup()). lookup_count wraps from u64::MAX to 0.
  4. Call fs.forget(node_id, 1) and then fs.get_attr on node_id. forget evicts node_id from InodeMap, and get_attr fails with lx::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

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from microsoft/nvx

All issues in microsoft/nvx

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.