Skip to content

doc: document per-architecture fast FFI argument limits - #65207

Open
leah-1ee wants to merge 1 commit into
nodejs:mainfrom
leah-1ee:doc-ffi-platform-argument-limits
Open

doc: document per-architecture fast FFI argument limits#65207
leah-1ee wants to merge 1 commit into
nodejs:mainfrom
leah-1ee:doc-ffi-platform-argument-limits

Conversation

@leah-1ee

Copy link
Copy Markdown
Contributor

The Fast FFI argument-limit paragraph only documented AArch64 and
x86-64, conflating x86-64 SysV with the stricter Win64 x64 emitter
and leaving five architectures undocumented.

Replaces it with a table covering all seven fast-call architectures,
verified against src/ffi/types.cc and the trampoline generators in
src/ffi/platforms/*.cc.

Follow-up to #63960.

Copilot AI lite review requested due to automatic review settings August 11, 2026 05:15
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/ffi

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. ffi Issues and PRs related to experimental Foreign Function Interface support. labels Aug 11, 2026

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Updates the Fast FFI documentation to clarify when optimized Fast FFI falls back to the generic path by documenting per-architecture trampoline/register constraints.

Changes:

  • Replaces the previous narrative description of Fast FFI argument limits with an architecture matrix.
  • Adds explicit notes/definitions around buffer-shaped arguments and architectures without a fast-call trampoline (e.g., PPC64BE).

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread doc/api/ffi.md Outdated
@leah-1ee
leah-1ee force-pushed the doc-ffi-platform-argument-limits branch from c337b36 to 3b33d30 Compare August 11, 2026 05:18
The prior text covered only two of the seven supported architectures
and conflated x86-64 SysV with the stricter Win64 emitter.

Signed-off-by: leah-1ee <selee3196@gmail.com>
@leah-1ee
leah-1ee force-pushed the doc-ffi-platform-argument-limits branch from 3b33d30 to bfab024 Compare August 11, 2026 05:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Issues and PRs related to the documentations. ffi Issues and PRs related to experimental Foreign Function Interface support.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants