Skip to content

vfs: load each memfd image under a path of its own - #67068

Open
pipobscure wants to merge 2 commits into
nodejs:mainfrom
pipobscure:vfs-addon-memfd
Open

pipobscure wants to merge 2 commits into
nodejs:mainfrom
pipobscure:vfs-addon-memfd

Conversation

@pipobscure

@pipobscure pipobscure commented Oct 27, 2026 •

Copy link
Copy Markdown
Contributor

On Linux an addon or FFI library inside a VFS is loaded from an anonymous memfd through /proc/self/fd/N, and the memfd is closed right after the load. The next image then got the same fd number, hence the same path, and the dynamic loader, which knows a loaded object by the path it was opened with, returned the object already loaded under that path instead of loading the new file. So the second of any two addons or libraries loaded from a VFS resolved to the first: an addon after an FFI library failed with "Module did not self-register", an FFI library after an addon had none of its own symbols, and two addons silently became the same one.

Move each image's fd to a number no earlier image has had, using F_DUPFD_CLOEXEC with a process-wide counter that only goes up, and still close it right after the load. The fd is only needed until dlopen() returns, because the load's mapping keeps the memory alive from then on, so no file descriptor outlives a load. That covers ffi's close(), worker exit, and loads that fail, whether in dlopen() or at registration.

The first commit kept each loaded memfd open until exit instead, which leaked one fd per load. The second commit replaces that. Closing after dlclose() was not enough, because dlclose() can leave an object loaded (for example one with an STB_GNU_UNIQUE symbol or a thread_local destructor), and addons on the main thread are never unloaded.

Each load uses up an fd number for the life of the process. If the numbers run out, the image goes through the existing temp-file fallback. Windows is unchanged: it keeps its images until exit.

On Linux an addon or FFI library inside a VFS is loaded from an
anonymous memfd through /proc/self/fd/N, and the memfd was closed
right after a successful load. The next image then got the same fd
number, hence the same path, and the dynamic loader, which knows a
loaded object by the path it was opened with, returned the object
already loaded under that path instead of loading the new file. So
the second of any two addons or libraries loaded from a VFS resolved
to the first: an addon after an FFI library failed with "Module did
not self-register", an FFI library after an addon had none of its
own symbols, and two addons silently became the same one.

Keep a memfd open for the life of the process once it has been
loaded, so no two images ever share a path; MFD_CLOEXEC keeps it out
of child processes. A failed load still closes its memfd. The
temp-file fallback is unaffected: each image there gets a fresh
mkdtemp() directory, and Windows already keeps its images until exit.

Signed-off-by: Philipp Dunkel <pip@pipobscure.com>
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/ffi

@nodejs-github-bot nodejs-github-bot added c++ Issues and PRs that require attention from people who are familiar with C++. needs-ci PRs that need a full CI run. labels Oct 27, 2026
@codecov

codecov Bot commented Oct 27, 2026 •

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 77.77778% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 90.68%. Comparing base (98dbf60) to head (ea97424).
⚠️ Report is 57 commits behind head on main.

Files with missing lines Patch % Lines
src/node_binding.cc 77.77% 0 Missing and 2 partials ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #67068      +/-   ##
==========================================
+ Coverage   90.65%   90.68%   +0.03%     
==========================================
  Files         797      797              
  Lines      278268   278786     +518     
  Branches    53517    53626     +109     
==========================================
+ Hits       252261   252816     +555     
+ Misses      16386    16328      -58     
- Partials     9621     9642      +21     
Files with missing lines Coverage Δ
src/node_binding.h 80.00% <ø> (ø)
src/node_binding.cc 76.34% <77.77%> (+5.54%) ⬆️

... and 51 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@pipobscure

Copy link
Copy Markdown
Contributor Author

@mcollina @jasnell @trivikr can one of you give this a request-ci and a review please

@addaleax addaleax left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we have to leak here? Can we just close after uv_dlclose()?

There is an expectation that Node.js instances clean up file descriptors opened by them unless explicitly told otherwise.

@pipobscure

Copy link
Copy Markdown
Contributor Author

Do we have to leak here

You might have a point. I'm reworking it with a slightly better idea that makes sure we don't leak. uv_dlclode() doesn't solve the problem, since that would just lead to reused /proc/self/fs/<x> numbers and therefore fail on loading later libraries.

Hold for changes comint

Keeping a loaded memfd open until exit gave each image a path of its
own, but held one file descriptor per load for the life of the process:
ffi's close() did not release it, nor did a worker's exit, nor a load
that failed after dlopen(), so a process opening libraries in a loop
would grow without bound.

The fd is only needed until dlopen() returns, as the load's mapping
keeps the memory alive from then on. What has to last is the path, and
that depends only on the number. So move each image's fd to a number no
earlier image has had, using F_DUPFD_CLOEXEC with a process-wide counter
that only goes up, and close it right after the load again. Unlike
closing it after dlclose(), this also holds for an object that dlclose()
leaves loaded, and for addons on the main thread, which are never
unloaded. Should the numbers run out, the image goes to a temp file.

Signed-off-by: Philipp Dunkel <pip@pipobscure.com>
@pipobscure pipobscure changed the title vfs: keep each loaded memfd image open until exit vfs: load each memfd image under a path of its own Oct 30, 2026
@pipobscure

Copy link
Copy Markdown
Contributor Author

You're right, we didn't have to leak, and I've pushed a fix. The memfd now closes right after dlopen(), so no fd outlives a load, whether it's ffi.close(), worker exit or a failed load.
I didn't close after uv_dlclose() because dlclose() can leave an object loaded, so the next image would reuse the fd number and get the stale object. Main-thread addons are also never unloaded, so their fds would have no point at which to close. Instead, each image takes an fd number no earlier image has had, which keeps its /proc/self/fd/N path unique. If the numbers run out, it falls back to the temp-file path.
Windows still keeps its image files until process exit, since it can't delete them while they're mapped.

@pipobscure
pipobscure requested a review from addaleax October 30, 2026 20:30

@addaleax addaleax left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this is a good permanent solution tbh, but I don't think it hurts either right now

Comment thread src/node_binding.cc
static Mutex mutex;
static int next_number = 0;
Mutex::ScopedLock lock(mutex);
const int moved = fcntl(fd, F_DUPFD_CLOEXEC, next_number);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will reliably start to break once the fd number reaches the EMFILE limit (ulimit -n) – it doesn't matter how many file descriptors are actually open, the resource limit limits the maximum fd value.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

True. Do you have any idea how to solve that though? I'd actually like to solve this in a solid permanent way, so if you have any ideas I'd very much appreciate it!

@addaleax addaleax added the request-ci Add this label to start a Jenkins CI on a PR. Only starts once the PR has an approving review. label Oct 31, 2026
@github-actions github-actions Bot removed the request-ci Add this label to start a Jenkins CI on a PR. Only starts once the PR has an approving review. label Oct 31, 2026
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@pipobscure

Copy link
Copy Markdown
Contributor Author

Given the valid criticisms that @addaleax raised, and the fact that she has more than a point I'd like to solve this in a cleaner way. If anyone has any ideas I'd appreciate hearing them.

I'm also thinking that maybe simpler is better. So what if we didn't do any of the platform dependent divergence and instead just did what we do on Windows:

  • create a file and write the content
  • dlopen the temp file
  • unload and delete on atexit

Thoughts very much appreciated!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

c++ Issues and PRs that require attention from people who are familiar with C++. needs-ci PRs that need a full CI run.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants