fix(vaultfs): Fix 32-bit panic

[hairyhenderson]

Fixes #719

The struct wasn't on a 64-bit offset, which is why it was panicking. However, we can use atomic.Uint64 now, which totally avoids this problem, so I've switched to that instead.

Summary by CodeRabbit

• Bug Fixes
  • Improved thread safety in client operations by updating reference count handling to use atomic operations.

[coderabbitai]

Walkthrough

The vaultfs/client.go file has been modified to replace the uint64 type of the refs field in the refCountedClient struct with atomic.Uint64, ensuring thread-safe operations. The AddRef() and RemoveRef() methods have been updated to utilize atomic operations, addressing 32-bit architecture issues causing unaligned 64-bit atomic operation panics.

Changes

File	Change Summary
vaultfs/client.go	Changed refs field in refCountedClient struct from uint64 to atomic.Uint64. Updated AddRef() and RemoveRef() methods.

Assessment against linked issues

Objective	Addressed	Explanation
Fix unaligned 64-bit atomic operations issue (#719)	✅

Poem

Amid the vaults, a change so slight,
Atomic counts to set things right.
No panic now in lines of code,
A smoother path, a lighter load.
For threads in sync, they dance anew,
In 32-bit realms, they made it through.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[hairyhenderson]

#718 isn't merged yet, so I can't test this in CI, but I've tested it in a VM:

$ make test GOARCH=386
CGO_ENABLED=0 go test -coverprofile=c.out ./...
ok      github.com/hairyhenderson/go-fsimpl     0.042s  coverage: 81.8% of statements
?       github.com/hairyhenderson/go-fsimpl/examples    [no test files]
        github.com/hairyhenderson/go-fsimpl/internal/tests              coverage: 0.0% of statements
ok      github.com/hairyhenderson/go-fsimpl/autofs      0.312s  coverage: 86.7% of statements
ok      github.com/hairyhenderson/go-fsimpl/awsimdsfs   1.514s  coverage: 76.0% of statements
ok      github.com/hairyhenderson/go-fsimpl/awssmfs     0.270s  coverage: 79.8% of statements
ok      github.com/hairyhenderson/go-fsimpl/awssmpfs    0.295s  coverage: 77.5% of statements
ok      github.com/hairyhenderson/go-fsimpl/blobfs      1.013s  coverage: 78.3% of statements
ok      github.com/hairyhenderson/go-fsimpl/consulfs    0.350s  coverage: 84.2% of statements
ok      github.com/hairyhenderson/go-fsimpl/examples/fscli      0.329s  coverage: 23.3% of statements
ok      github.com/hairyhenderson/go-fsimpl/filefs      0.325s  coverage: 95.5% of statements
ok      github.com/hairyhenderson/go-fsimpl/gitfs       1.112s  coverage: 86.9% of statements
ok      github.com/hairyhenderson/go-fsimpl/httpfs      0.309s  coverage: 65.8% of statements
ok      github.com/hairyhenderson/go-fsimpl/internal    0.145s  coverage: 37.1% of statements
ok      github.com/hairyhenderson/go-fsimpl/internal/billyadapter       0.261s  coverage: 88.1% of statements
ok      github.com/hairyhenderson/go-fsimpl/internal/env        0.243s  coverage: 100.0% of statements
ok      github.com/hairyhenderson/go-fsimpl/internal/tests/integration  8.982s  coverage: 75.0% of statements
ok      github.com/hairyhenderson/go-fsimpl/tracefs     0.269s  coverage: 75.0% of statements
ok      github.com/hairyhenderson/go-fsimpl/vaultfs     0.127s  coverage: 79.1% of statements
ok      github.com/hairyhenderson/go-fsimpl/vaultfs/vaultauth   0.059s  coverage: 49.2% of statements

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9740435 and 0c81c0c.

Files selected for processing (1)

• vaultfs/client.go (2 hunks)

Additional comments not posted (4)

vaultfs/client.go (4)

21-21: Approved modification of refs field type.

Changing from uint64 to atomic.Uint64 addresses alignment issues on 32-bit systems and ensures thread-safe operations.

---

27-27: Approved update to AddRef method.

Using atomic.Uint64's Add method for incrementing is appropriate and thread-safe.

---

39-39: Approved update to RemoveRef method.

Using atomic.Uint64's Add method with ^uint64(0) to decrement is correct and ensures atomicity.

---

43-43: Approved addition of Refs method.

The method correctly uses atomic.Uint64's Load to safely retrieve the current reference count.