doc: document the node:ffi call paths · nodejs/node@50bc27f · GitHub
Skip to content

Commit 50bc27f

Browse files
soulee-devaduh95
authored andcommitted
doc: document the node:ffi call paths
`node:ffi` dispatches native calls through one of three call paths: the V8 Fast API with a generated trampoline, a per-function shared buffer, or the generic libffi invoker. The public documentation only describes the Fast API path and a "generic" fallback, never mentions the shared buffer path, and leaves the selection order implicit. Add a "Call paths" section to doc/api/ffi.md that explains the selection order, what each path does, and when a signature qualifies for it, and point the existing per-architecture limits table at it. Add a call path overview table to the FFI Fast API internals contributor guide and cross-link the two documents. Signed-off-by: Soul Lee <alus20x@gmail.com> PR-URL: #66086 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Paolo Insogna <paolo@cowtech.it> Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
1 parent 15184e8 commit 50bc27f

2 files changed

Lines changed: 165 additions & 3 deletions

File tree

‎doc/api/ffi.md‎

Lines changed: 144 additions & 3 deletions

‎doc/contributing/ffi-fast-api-internals.md‎

Lines changed: 21 additions & 0 deletions

0 commit comments

Comments
 (0)