Commit 5cac7c2

Browse files
umuoy1aduh95
authored andcommitted
ffi: reuse libffi call plans
Precompute a libffi call plan for each fixed signature on x86-64 System V and reuse it from the generic and SharedBuffer invokers. This avoids repeating argument-placement work for every call. Continue to use ffi_call() with libffi older than 3.7, on other ABIs, and when plan allocation fails. Signed-off-by: umuoy1 <burningdian@gmail.com> PR-URL: #64958Fixes: #64562 Refs: libffi/libffi@3cc6beb Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Gürgün Dayıoğlu <hey@gurgun.day> Reviewed-By: Paolo Insogna <paolo@cowtech.it> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
1 parent 044402c commit 5cac7c2

4 files changed

Lines changed: 152 additions & 17 deletions

File tree

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
'use strict';
2+
3+
constassert=require('node:assert');
4+
constcommon=require('../common.js');
5+
const{ libraryPath, ensureFixtureLibrary }=require('./common.js');
6+
7+
// Measure the invocation (call) path for signatures that bypass V8 Fast API
8+
// and use libffi through FFIFunction::Invoke(). On x86-64 System V with
9+
// libffi >= 3.7, Invoke() reuses a precomputed call plan that avoids repeating
10+
// argument-placement work on every call. This benchmark quantifies the
11+
// per-call benefit.
12+
//
13+
// Signatures chosen to bypass both V8 Fast API and keep native work minimal:
14+
// - call_int_callback (null): 'function' type forces the generic path; null
15+
// pointer triggers the early return in C so native computation is negligible.
16+
// From libffi's perspective this is a register-only plan (2 pointer-sized
17+
// args both fit in GP registers on x86-64 System V).
18+
// - sum_8_i32: 8 GP args exceed the x86-64 Fast API register cap (6), forcing
19+
// the generic path. From libffi's perspective 6 args go in registers and 2
20+
// spill to the stack, exercising a stack-spilled plan.
21+
22+
constbench=common.createBenchmark(main,{
23+
n: [1e7],
24+
symbol: ['call_int_callback','sum_8_i32'],
25+
},{
26+
flags: ['--experimental-ffi','--no-warnings'],
27+
});
28+
29+
ensureFixtureLibrary();
30+
31+
functionmain({ n, symbol }){
32+
constffi=require('node:ffi');
33+
34+
if(symbol==='call_int_callback'){
35+
// 'function' type bypasses Fast API (IsFastCallEligible rejects it).
36+
// Pass 0n (null function pointer) so the native function returns -1
37+
// immediately without invoking any callback, keeping per-call overhead
38+
// dominated by the FFI call machinery itself.
39+
const{ lib, functions }=ffi.dlopen(libraryPath,{
40+
call_int_callback: {return: 'i32',arguments: ['function','i32']},
41+
});
42+
43+
try{
44+
// Verify the null-pointer early return.
45+
assert.strictEqual(functions.call_int_callback(0n,7),-1);
46+
47+
bench.start();
48+
for(leti=0;i<n;++i)
49+
functions.call_int_callback(0n,21);
50+
bench.end(n);
51+
}finally{
52+
lib.close();
53+
}
54+
}else{
55+
// 8 integer args exceed the x86-64 SysV GP register cap (6), which makes
56+
// CreateFastFFIMetadata reject the signature. Calls go through the
57+
// SharedBuffer or generic invoker into FFIFunction::Invoke().
58+
const{ lib, functions }=ffi.dlopen(libraryPath,{
59+
sum_8_i32: {
60+
return: 'i32',
61+
arguments: [
62+
'i32','i32','i32','i32',
63+
'i32','i32','i32','i32',
64+
],
65+
},
66+
});
67+
68+
constfn=functions.sum_8_i32;
69+
70+
assert.strictEqual(fn(1,2,3,4,5,6,7,8),36);
71+
72+
bench.start();
73+
for(leti=0;i<n;++i)
74+
fn(1,2,3,4,5,6,7,14);
75+
bench.end(n);
76+
77+
lib.close();
78+
}
79+
}

β€Žsrc/ffi/fast.ccβ€Ž

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -192,13 +192,31 @@ bool SignatureNeedsFastBufferInvoke(const FFIFunction& fn) {
192192
IsBufferTypeName(fn.arg_type_names[0]));
193193
}
194194

195+
namespace {
196+
197+
std::shared_ptr<FFIFunction> CloneForFastMetadata(
198+
const std::shared_ptr<FFIFunction>& fn) {
199+
// Fast metadata only needs the native target and signature. In particular,
200+
// its temporary clone must not borrow the original function's cif or plan.
201+
auto clone = std::make_shared<FFIFunction>();
202+
clone->closed = fn->closed;
203+
clone->ptr = fn->ptr;
204+
clone->args = fn->args;
205+
clone->return_type = fn->return_type;
206+
clone->arg_type_names = fn->arg_type_names;
207+
clone->return_type_name = fn->return_type_name;
208+
return clone;
209+
}
210+
211+
} // namespace
212+
195213
std::shared_ptr<FFIFunction> CloneWithRawPointerArgNames(
196214
const std::shared_ptr<FFIFunction>& fn) {
197215
// The primary Fast API entrypoint receives pointer-compatible values as
198216
// BigInts after the JS wrapper has converted strings, nullish values, and
199217
// memory-backed objects. A secondary entrypoint handles the monomorphic
200218
// memory-backed case without extracting the pointer in JS.
201-
auto clone = std::make_shared<FFIFunction>(*fn);
219+
auto clone = CloneForFastMetadata(fn);
202220
for (std::string& name : clone->arg_type_names) {
203221
if (IsBufferTypeName(name)) {
204222
name = "pointer";
@@ -209,10 +227,10 @@ std::shared_ptr<FFIFunction> CloneWithRawPointerArgNames(
209227

210228
std::shared_ptr<FFIFunction> CloneWithFastBufferArgNames(
211229
const std::shared_ptr<FFIFunction>& fn) {
212-
// Reuse the same native target and libffi metadata, but describe the JS
230+
// Reuse the same native target and signature metadata, but describe the JS
213231
// argument as `buffer` so CreateFastFFIMetadata() emits a trampoline that
214232
// receives a V8 value and calls node_ffi_fast_buffer_data().
215-
auto clone = std::make_shared<FFIFunction>(*fn);
233+
auto clone = CloneForFastMetadata(fn);
216234
for (std::string& name : clone->arg_type_names) {
217235
if (IsPointerTypeName(name)) {
218236
name = "buffer";

β€Žsrc/node_ffi.ccβ€Ž

Lines changed: 27 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,17 @@ using v8::Value;
4242

4343
namespaceffi {
4444

45+
voidFFIFunction::Invoke(void* result, void** values) {
46+
#if defined(NODE_FFI_HAS_FAST_CALL_PLAN)
47+
if (call_plan != nullptr) {
48+
ffi_call_plan_invoke(call_plan.get(), FFI_FN(ptr), result, values);
49+
return;
50+
}
51+
#endif
52+
53+
ffi_call(&cif, FFI_FN(ptr), result, values);
54+
}
55+
4556
voidFFIFunctionInfo::MemoryInfo(MemoryTracker* tracker) const {
4657
tracker->TrackField("sb_backing", sb_backing);
4758
}
@@ -146,14 +157,12 @@ Maybe<DynamicLibrary::PreparedFunction> DynamicLibrary::PrepareFunction(
146157

147158
should_cache_symbol = symbols_.find(name) == symbols_.end();
148159

149-
fn = std::make_shared<FFIFunction>(
150-
FFIFunction{.closed = false,
151-
.ptr = ptr,
152-
.cif = {},
153-
.args = args,
154-
.return_type = return_type,
155-
.arg_type_names = std::move(arg_type_names),
156-
.return_type_name = std::move(return_type_name)});
160+
fn = std::make_shared<FFIFunction>();
161+
fn->ptr = ptr;
162+
fn->args = std::move(args);
163+
fn->return_type = return_type;
164+
fn->arg_type_names = std::move(arg_type_names);
165+
fn->return_type_name = std::move(return_type_name);
157166

158167
ffi_status status = ffi_prep_cif(&fn->cif,
159168
FFI_DEFAULT_ABI,
@@ -178,6 +187,14 @@ Maybe<DynamicLibrary::PreparedFunction> DynamicLibrary::PrepareFunction(
178187
return {};
179188
}
180189

190+
#if defined(NODE_FFI_HAS_FAST_CALL_PLAN)
191+
// Allocation failure is non-fatal. Invoke() falls back to ffi_call().
192+
ffi_call_plan* call_plan = ffi_call_plan_alloc(&fn->cif);
193+
if (call_plan != nullptr) {
194+
fn->call_plan.reset(call_plan);
195+
}
196+
#endif
197+
181198
should_cache_function = true;
182199
} else {
183200
fn = existing->second;
@@ -552,7 +569,7 @@ void DynamicLibrary::InvokeFunction(const FunctionCallbackInfo<Value>& args) {
552569
result = Malloc(GetFFIReturnValueStorageSize(fn->return_type));
553570
}
554571

555-
ffi_call(&fn->cif, FFI_FN(fn->ptr), result, ffi_args.data());
572+
fn->Invoke(result, ffi_args.data());
556573

557574
// Return result back to Javascript
558575
ToJSReturnValue(env, args, fn->return_type, result);
@@ -611,7 +628,7 @@ void DynamicLibrary::InvokeFunctionSB(const FunctionCallbackInfo<Value>& args) {
611628
alignas(8) uint8_t result_storage[kSBResultStorageSize] = {0};
612629
void* result = (fn->return_type != &ffi_type_void) ? result_storage : nullptr;
613630

614-
ffi_call(&fn->cif, FFI_FN(fn->ptr), result, ffi_args.data());
631+
fn->Invoke(result, ffi_args.data());
615632

616633
if (result != nullptr) {
617634
WriteFFIReturnToBuffer(fn->return_type, result, buffer, 0);

β€Žsrc/node_ffi.hβ€Ž

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,41 @@
1414
#include<unordered_map>
1515
#include<vector>
1616

17+
// libffi only accelerates reusable call plans on x86-64 System V. Other
18+
// targets implement the API by calling ffi_call(), which adds no benefit.
19+
#if defined(FFI_VERSION_NUMBER) && FFI_VERSION_NUMBER >= 30700 && \
20+
defined(__x86_64__) && !defined(__ILP32__) && !defined(X86_WIN64) && \
21+
!defined(_WIN32)
22+
#defineNODE_FFI_HAS_FAST_CALL_PLAN1
23+
#endif
24+
1725
namespacenode::ffi {
1826

1927
classDynamicLibrary;
2028
structFFIFunction;
2129

2230
structFFIFunction {
23-
bool closed;
31+
FFIFunction() = default;
32+
FFIFunction(const FFIFunction&) = delete;
33+
FFIFunction& operator=(const FFIFunction&) = delete;
34+
FFIFunction(FFIFunction&&) = delete;
35+
FFIFunction& operator=(FFIFunction&&) = delete;
2436

25-
void* ptr;
26-
ffi_cif cif;
37+
bool closed = false;
38+
39+
void* ptr = nullptr;
40+
ffi_cif cif = {};
2741
std::vector<ffi_type*> args;
28-
ffi_type* return_type;
42+
ffi_type* return_type = nullptr;
2943
std::vector<std::string> arg_type_names;
3044
std::string return_type_name;
45+
#if defined(NODE_FFI_HAS_FAST_CALL_PLAN)
46+
// The plan borrows cif, so it must remain uniquely owned by this instance.
47+
std::unique_ptr<ffi_call_plan, decltype(&ffi_call_plan_free)> call_plan{
48+
nullptr, ffi_call_plan_free};
49+
#endif
50+
51+
voidInvoke(void* result, void** values);
3152
};
3253

3354
classFFIFunctionInfofinal : public BaseObject {

0 commit comments

Comments
Β (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

Commit 5cac7c2

Browse files
umuoy1aduh95
authored andcommitted
ffi: reuse libffi call plans
Precompute a libffi call plan for each fixed signature on x86-64 System V and reuse it from the generic and SharedBuffer invokers. This avoids repeating argument-placement work for every call. Continue to use ffi_call() with libffi older than 3.7, on other ABIs, and when plan allocation fails. Signed-off-by: umuoy1 <burningdian@gmail.com> PR-URL: #64958Fixes: #64562 Refs: libffi/libffi@3cc6beb Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Gürgün Dayıoğlu <hey@gurgun.day> Reviewed-By: Paolo Insogna <paolo@cowtech.it> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
1 parent 044402c commit 5cac7c2

4 files changed

Lines changed: 152 additions & 17 deletions

File tree

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
'use strict';
2+
3+
constassert=require('node:assert');
4+
constcommon=require('../common.js');
5+
const{ libraryPath, ensureFixtureLibrary }=require('./common.js');
6+
7+
// Measure the invocation (call) path for signatures that bypass V8 Fast API
8+
// and use libffi through FFIFunction::Invoke(). On x86-64 System V with
9+
// libffi >= 3.7, Invoke() reuses a precomputed call plan that avoids repeating
10+
// argument-placement work on every call. This benchmark quantifies the
11+
// per-call benefit.
12+
//
13+
// Signatures chosen to bypass both V8 Fast API and keep native work minimal:
14+
// - call_int_callback (null): 'function' type forces the generic path; null
15+
// pointer triggers the early return in C so native computation is negligible.
16+
// From libffi's perspective this is a register-only plan (2 pointer-sized
17+
// args both fit in GP registers on x86-64 System V).
18+
// - sum_8_i32: 8 GP args exceed the x86-64 Fast API register cap (6), forcing
19+
// the generic path. From libffi's perspective 6 args go in registers and 2
20+
// spill to the stack, exercising a stack-spilled plan.
21+
22+
constbench=common.createBenchmark(main,{
23+
n: [1e7],
24+
symbol: ['call_int_callback','sum_8_i32'],
25+
},{
26+
flags: ['--experimental-ffi','--no-warnings'],
27+
});
28+
29+
ensureFixtureLibrary();
30+
31+
functionmain({ n, symbol }){
32+
constffi=require('node:ffi');
33+
34+
if(symbol==='call_int_callback'){
35+
// 'function' type bypasses Fast API (IsFastCallEligible rejects it).
36+
// Pass 0n (null function pointer) so the native function returns -1
37+
// immediately without invoking any callback, keeping per-call overhead
38+
// dominated by the FFI call machinery itself.
39+
const{ lib, functions }=ffi.dlopen(libraryPath,{
40+
call_int_callback: {return: 'i32',arguments: ['function','i32']},
41+
});
42+
43+
try{
44+
// Verify the null-pointer early return.
45+
assert.strictEqual(functions.call_int_callback(0n,7),-1);
46+
47+
bench.start();
48+
for(leti=0;i<n;++i)
49+
functions.call_int_callback(0n,21);
50+
bench.end(n);
51+
}finally{
52+
lib.close();
53+
}
54+
}else{
55+
// 8 integer args exceed the x86-64 SysV GP register cap (6), which makes
56+
// CreateFastFFIMetadata reject the signature. Calls go through the
57+
// SharedBuffer or generic invoker into FFIFunction::Invoke().
58+
const{ lib, functions }=ffi.dlopen(libraryPath,{
59+
sum_8_i32: {
60+
return: 'i32',
61+
arguments: [
62+
'i32','i32','i32','i32',
63+
'i32','i32','i32','i32',
64+
],
65+
},
66+
});
67+
68+
constfn=functions.sum_8_i32;
69+
70+
assert.strictEqual(fn(1,2,3,4,5,6,7,8),36);
71+
72+
bench.start();
73+
for(leti=0;i<n;++i)
74+
fn(1,2,3,4,5,6,7,14);
75+
bench.end(n);
76+
77+
lib.close();
78+
}
79+
}

β€Žsrc/ffi/fast.ccβ€Ž

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -192,13 +192,31 @@ bool SignatureNeedsFastBufferInvoke(const FFIFunction& fn) {
192192
IsBufferTypeName(fn.arg_type_names[0]));
193193
}
194194

195+
namespace {
196+
197+
std::shared_ptr<FFIFunction> CloneForFastMetadata(
198+
const std::shared_ptr<FFIFunction>& fn) {
199+
// Fast metadata only needs the native target and signature. In particular,
200+
// its temporary clone must not borrow the original function's cif or plan.
201+
auto clone = std::make_shared<FFIFunction>();
202+
clone->closed = fn->closed;
203+
clone->ptr = fn->ptr;
204+
clone->args = fn->args;
205+
clone->return_type = fn->return_type;
206+
clone->arg_type_names = fn->arg_type_names;
207+
clone->return_type_name = fn->return_type_name;
208+
return clone;
209+
}
210+
211+
} // namespace
212+
195213
std::shared_ptr<FFIFunction> CloneWithRawPointerArgNames(
196214
const std::shared_ptr<FFIFunction>& fn) {
197215
// The primary Fast API entrypoint receives pointer-compatible values as
198216
// BigInts after the JS wrapper has converted strings, nullish values, and
199217
// memory-backed objects. A secondary entrypoint handles the monomorphic
200218
// memory-backed case without extracting the pointer in JS.
201-
auto clone = std::make_shared<FFIFunction>(*fn);
219+
auto clone = CloneForFastMetadata(fn);
202220
for (std::string& name : clone->arg_type_names) {
203221
if (IsBufferTypeName(name)) {
204222
name = "pointer";
@@ -209,10 +227,10 @@ std::shared_ptr<FFIFunction> CloneWithRawPointerArgNames(
209227

210228
std::shared_ptr<FFIFunction> CloneWithFastBufferArgNames(
211229
const std::shared_ptr<FFIFunction>& fn) {
212-
// Reuse the same native target and libffi metadata, but describe the JS
230+
// Reuse the same native target and signature metadata, but describe the JS
213231
// argument as `buffer` so CreateFastFFIMetadata() emits a trampoline that
214232
// receives a V8 value and calls node_ffi_fast_buffer_data().
215-
auto clone = std::make_shared<FFIFunction>(*fn);
233+
auto clone = CloneForFastMetadata(fn);
216234
for (std::string& name : clone->arg_type_names) {
217235
if (IsPointerTypeName(name)) {
218236
name = "buffer";

β€Žsrc/node_ffi.ccβ€Ž

Lines changed: 27 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,17 @@ using v8::Value;
4242

4343
namespaceffi {
4444

45+
voidFFIFunction::Invoke(void* result, void** values) {
46+
#if defined(NODE_FFI_HAS_FAST_CALL_PLAN)
47+
if (call_plan != nullptr) {
48+
ffi_call_plan_invoke(call_plan.get(), FFI_FN(ptr), result, values);
49+
return;
50+
}
51+
#endif
52+
53+
ffi_call(&cif, FFI_FN(ptr), result, values);
54+
}
55+
4556
voidFFIFunctionInfo::MemoryInfo(MemoryTracker* tracker) const {
4657
tracker->TrackField("sb_backing", sb_backing);
4758
}
@@ -146,14 +157,12 @@ Maybe<DynamicLibrary::PreparedFunction> DynamicLibrary::PrepareFunction(
146157

147158
should_cache_symbol = symbols_.find(name) == symbols_.end();
148159

149-
fn = std::make_shared<FFIFunction>(
150-
FFIFunction{.closed = false,
151-
.ptr = ptr,
152-
.cif = {},
153-
.args = args,
154-
.return_type = return_type,
155-
.arg_type_names = std::move(arg_type_names),
156-
.return_type_name = std::move(return_type_name)});
160+
fn = std::make_shared<FFIFunction>();
161+
fn->ptr = ptr;
162+
fn->args = std::move(args);
163+
fn->return_type = return_type;
164+
fn->arg_type_names = std::move(arg_type_names);
165+
fn->return_type_name = std::move(return_type_name);
157166

158167
ffi_status status = ffi_prep_cif(&fn->cif,
159168
FFI_DEFAULT_ABI,
@@ -178,6 +187,14 @@ Maybe<DynamicLibrary::PreparedFunction> DynamicLibrary::PrepareFunction(
178187
return {};
179188
}
180189

190+
#if defined(NODE_FFI_HAS_FAST_CALL_PLAN)
191+
// Allocation failure is non-fatal. Invoke() falls back to ffi_call().
192+
ffi_call_plan* call_plan = ffi_call_plan_alloc(&fn->cif);
193+
if (call_plan != nullptr) {
194+
fn->call_plan.reset(call_plan);
195+
}
196+
#endif
197+
181198
should_cache_function = true;
182199
} else {
183200
fn = existing->second;
@@ -552,7 +569,7 @@ void DynamicLibrary::InvokeFunction(const FunctionCallbackInfo<Value>& args) {
552569
result = Malloc(GetFFIReturnValueStorageSize(fn->return_type));
553570
}
554571

555-
ffi_call(&fn->cif, FFI_FN(fn->ptr), result, ffi_args.data());
572+
fn->Invoke(result, ffi_args.data());
556573

557574
// Return result back to Javascript
558575
ToJSReturnValue(env, args, fn->return_type, result);
@@ -611,7 +628,7 @@ void DynamicLibrary::InvokeFunctionSB(const FunctionCallbackInfo<Value>& args) {
611628
alignas(8) uint8_t result_storage[kSBResultStorageSize] = {0};
612629
void* result = (fn->return_type != &ffi_type_void) ? result_storage : nullptr;
613630

614-
ffi_call(&fn->cif, FFI_FN(fn->ptr), result, ffi_args.data());
631+
fn->Invoke(result, ffi_args.data());
615632

616633
if (result != nullptr) {
617634
WriteFFIReturnToBuffer(fn->return_type, result, buffer, 0);

β€Žsrc/node_ffi.hβ€Ž

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,41 @@
1414
#include<unordered_map>
1515
#include<vector>
1616

17+
// libffi only accelerates reusable call plans on x86-64 System V. Other
18+
// targets implement the API by calling ffi_call(), which adds no benefit.
19+
#if defined(FFI_VERSION_NUMBER) && FFI_VERSION_NUMBER >= 30700 && \
20+
defined(__x86_64__) && !defined(__ILP32__) && !defined(X86_WIN64) && \
21+
!defined(_WIN32)
22+
#defineNODE_FFI_HAS_FAST_CALL_PLAN1
23+
#endif
24+
1725
namespacenode::ffi {
1826

1927
classDynamicLibrary;
2028
structFFIFunction;
2129

2230
structFFIFunction {
23-
bool closed;
31+
FFIFunction() = default;
32+
FFIFunction(const FFIFunction&) = delete;
33+
FFIFunction& operator=(const FFIFunction&) = delete;
34+
FFIFunction(FFIFunction&&) = delete;
35+
FFIFunction& operator=(FFIFunction&&) = delete;
2436

25-
void* ptr;
26-
ffi_cif cif;
37+
bool closed = false;
38+
39+
void* ptr = nullptr;
40+
ffi_cif cif = {};
2741
std::vector<ffi_type*> args;
28-
ffi_type* return_type;
42+
ffi_type* return_type = nullptr;
2943
std::vector<std::string> arg_type_names;
3044
std::string return_type_name;
45+
#if defined(NODE_FFI_HAS_FAST_CALL_PLAN)
46+
// The plan borrows cif, so it must remain uniquely owned by this instance.
47+
std::unique_ptr<ffi_call_plan, decltype(&ffi_call_plan_free)> call_plan{
48+
nullptr, ffi_call_plan_free};
49+
#endif
50+
51+
voidInvoke(void* result, void** values);
3152
};
3253

3354
classFFIFunctionInfofinal : public BaseObject {

0 commit comments

Comments
Β (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Commit 5cac7c2

Browse files
umuoy1aduh95
authored andcommitted
ffi: reuse libffi call plans
Precompute a libffi call plan for each fixed signature on x86-64 System V and reuse it from the generic and SharedBuffer invokers. This avoids repeating argument-placement work for every call. Continue to use ffi_call() with libffi older than 3.7, on other ABIs, and when plan allocation fails. Signed-off-by: umuoy1 <burningdian@gmail.com> PR-URL: #64958Fixes: #64562 Refs: libffi/libffi@3cc6beb Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Gürgün Dayıoğlu <hey@gurgun.day> Reviewed-By: Paolo Insogna <paolo@cowtech.it> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
1 parent 044402c commit 5cac7c2

4 files changed

Lines changed: 152 additions & 17 deletions

File tree

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
'use strict';
2+
3+
constassert=require('node:assert');
4+
constcommon=require('../common.js');
5+
const{ libraryPath, ensureFixtureLibrary }=require('./common.js');
6+
7+
// Measure the invocation (call) path for signatures that bypass V8 Fast API
8+
// and use libffi through FFIFunction::Invoke(). On x86-64 System V with
9+
// libffi >= 3.7, Invoke() reuses a precomputed call plan that avoids repeating
10+
// argument-placement work on every call. This benchmark quantifies the
11+
// per-call benefit.
12+
//
13+
// Signatures chosen to bypass both V8 Fast API and keep native work minimal:
14+
// - call_int_callback (null): 'function' type forces the generic path; null
15+
// pointer triggers the early return in C so native computation is negligible.
16+
// From libffi's perspective this is a register-only plan (2 pointer-sized
17+
// args both fit in GP registers on x86-64 System V).
18+
// - sum_8_i32: 8 GP args exceed the x86-64 Fast API register cap (6), forcing
19+
// the generic path. From libffi's perspective 6 args go in registers and 2
20+
// spill to the stack, exercising a stack-spilled plan.
21+
22+
constbench=common.createBenchmark(main,{
23+
n: [1e7],
24+
symbol: ['call_int_callback','sum_8_i32'],
25+
},{
26+
flags: ['--experimental-ffi','--no-warnings'],
27+
});
28+
29+
ensureFixtureLibrary();
30+
31+
functionmain({ n, symbol }){
32+
constffi=require('node:ffi');
33+
34+
if(symbol==='call_int_callback'){
35+
// 'function' type bypasses Fast API (IsFastCallEligible rejects it).
36+
// Pass 0n (null function pointer) so the native function returns -1
37+
// immediately without invoking any callback, keeping per-call overhead
38+
// dominated by the FFI call machinery itself.
39+
const{ lib, functions }=ffi.dlopen(libraryPath,{
40+
call_int_callback: {return: 'i32',arguments: ['function','i32']},
41+
});
42+
43+
try{
44+
// Verify the null-pointer early return.
45+
assert.strictEqual(functions.call_int_callback(0n,7),-1);
46+
47+
bench.start();
48+
for(leti=0;i<n;++i)
49+
functions.call_int_callback(0n,21);
50+
bench.end(n);
51+
}finally{
52+
lib.close();
53+
}
54+
}else{
55+
// 8 integer args exceed the x86-64 SysV GP register cap (6), which makes
56+
// CreateFastFFIMetadata reject the signature. Calls go through the
57+
// SharedBuffer or generic invoker into FFIFunction::Invoke().
58+
const{ lib, functions }=ffi.dlopen(libraryPath,{
59+
sum_8_i32: {
60+
return: 'i32',
61+
arguments: [
62+
'i32','i32','i32','i32',
63+
'i32','i32','i32','i32',
64+
],
65+
},
66+
});
67+
68+
constfn=functions.sum_8_i32;
69+
70+
assert.strictEqual(fn(1,2,3,4,5,6,7,8),36);
71+
72+
bench.start();
73+
for(leti=0;i<n;++i)
74+
fn(1,2,3,4,5,6,7,14);
75+
bench.end(n);
76+
77+
lib.close();
78+
}
79+
}

β€Žsrc/ffi/fast.ccβ€Ž

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -192,13 +192,31 @@ bool SignatureNeedsFastBufferInvoke(const FFIFunction& fn) {
192192
IsBufferTypeName(fn.arg_type_names[0]));
193193
}
194194

195+
namespace {
196+
197+
std::shared_ptr<FFIFunction> CloneForFastMetadata(
198+
const std::shared_ptr<FFIFunction>& fn) {
199+
// Fast metadata only needs the native target and signature. In particular,
200+
// its temporary clone must not borrow the original function's cif or plan.
201+
auto clone = std::make_shared<FFIFunction>();
202+
clone->closed = fn->closed;
203+
clone->ptr = fn->ptr;
204+
clone->args = fn->args;
205+
clone->return_type = fn->return_type;
206+
clone->arg_type_names = fn->arg_type_names;
207+
clone->return_type_name = fn->return_type_name;
208+
return clone;
209+
}
210+
211+
} // namespace
212+
195213
std::shared_ptr<FFIFunction> CloneWithRawPointerArgNames(
196214
const std::shared_ptr<FFIFunction>& fn) {
197215
// The primary Fast API entrypoint receives pointer-compatible values as
198216
// BigInts after the JS wrapper has converted strings, nullish values, and
199217
// memory-backed objects. A secondary entrypoint handles the monomorphic
200218
// memory-backed case without extracting the pointer in JS.
201-
auto clone = std::make_shared<FFIFunction>(*fn);
219+
auto clone = CloneForFastMetadata(fn);
202220
for (std::string& name : clone->arg_type_names) {
203221
if (IsBufferTypeName(name)) {
204222
name = "pointer";
@@ -209,10 +227,10 @@ std::shared_ptr<FFIFunction> CloneWithRawPointerArgNames(
209227

210228
std::shared_ptr<FFIFunction> CloneWithFastBufferArgNames(
211229
const std::shared_ptr<FFIFunction>& fn) {
212-
// Reuse the same native target and libffi metadata, but describe the JS
230+
// Reuse the same native target and signature metadata, but describe the JS
213231
// argument as `buffer` so CreateFastFFIMetadata() emits a trampoline that
214232
// receives a V8 value and calls node_ffi_fast_buffer_data().
215-
auto clone = std::make_shared<FFIFunction>(*fn);
233+
auto clone = CloneForFastMetadata(fn);
216234
for (std::string& name : clone->arg_type_names) {
217235
if (IsPointerTypeName(name)) {
218236
name = "buffer";

β€Žsrc/node_ffi.ccβ€Ž

Lines changed: 27 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,17 @@ using v8::Value;
4242

4343
namespaceffi {
4444

45+
voidFFIFunction::Invoke(void* result, void** values) {
46+
#if defined(NODE_FFI_HAS_FAST_CALL_PLAN)
47+
if (call_plan != nullptr) {
48+
ffi_call_plan_invoke(call_plan.get(), FFI_FN(ptr), result, values);
49+
return;
50+
}
51+
#endif
52+
53+
ffi_call(&cif, FFI_FN(ptr), result, values);
54+
}
55+
4556
voidFFIFunctionInfo::MemoryInfo(MemoryTracker* tracker) const {
4657
tracker->TrackField("sb_backing", sb_backing);
4758
}
@@ -146,14 +157,12 @@ Maybe<DynamicLibrary::PreparedFunction> DynamicLibrary::PrepareFunction(
146157

147158
should_cache_symbol = symbols_.find(name) == symbols_.end();
148159

149-
fn = std::make_shared<FFIFunction>(
150-
FFIFunction{.closed = false,
151-
.ptr = ptr,
152-
.cif = {},
153-
.args = args,
154-
.return_type = return_type,
155-
.arg_type_names = std::move(arg_type_names),
156-
.return_type_name = std::move(return_type_name)});
160+
fn = std::make_shared<FFIFunction>();
161+
fn->ptr = ptr;
162+
fn->args = std::move(args);
163+
fn->return_type = return_type;
164+
fn->arg_type_names = std::move(arg_type_names);
165+
fn->return_type_name = std::move(return_type_name);
157166

158167
ffi_status status = ffi_prep_cif(&fn->cif,
159168
FFI_DEFAULT_ABI,
@@ -178,6 +187,14 @@ Maybe<DynamicLibrary::PreparedFunction> DynamicLibrary::PrepareFunction(
178187
return {};
179188
}
180189

190+
#if defined(NODE_FFI_HAS_FAST_CALL_PLAN)
191+
// Allocation failure is non-fatal. Invoke() falls back to ffi_call().
192+
ffi_call_plan* call_plan = ffi_call_plan_alloc(&fn->cif);
193+
if (call_plan != nullptr) {
194+
fn->call_plan.reset(call_plan);
195+
}
196+
#endif
197+
181198
should_cache_function = true;
182199
} else {
183200
fn = existing->second;
@@ -552,7 +569,7 @@ void DynamicLibrary::InvokeFunction(const FunctionCallbackInfo<Value>& args) {
552569
result = Malloc(GetFFIReturnValueStorageSize(fn->return_type));
553570
}
554571

555-
ffi_call(&fn->cif, FFI_FN(fn->ptr), result, ffi_args.data());
572+
fn->Invoke(result, ffi_args.data());
556573

557574
// Return result back to Javascript
558575
ToJSReturnValue(env, args, fn->return_type, result);
@@ -611,7 +628,7 @@ void DynamicLibrary::InvokeFunctionSB(const FunctionCallbackInfo<Value>& args) {
611628
alignas(8) uint8_t result_storage[kSBResultStorageSize] = {0};
612629
void* result = (fn->return_type != &ffi_type_void) ? result_storage : nullptr;
613630

614-
ffi_call(&fn->cif, FFI_FN(fn->ptr), result, ffi_args.data());
631+
fn->Invoke(result, ffi_args.data());
615632

616633
if (result != nullptr) {
617634
WriteFFIReturnToBuffer(fn->return_type, result, buffer, 0);

β€Žsrc/node_ffi.hβ€Ž

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,41 @@
1414
#include<unordered_map>
1515
#include<vector>
1616

17+
// libffi only accelerates reusable call plans on x86-64 System V. Other
18+
// targets implement the API by calling ffi_call(), which adds no benefit.
19+
#if defined(FFI_VERSION_NUMBER) && FFI_VERSION_NUMBER >= 30700 && \
20+
defined(__x86_64__) && !defined(__ILP32__) && !defined(X86_WIN64) && \
21+
!defined(_WIN32)
22+
#defineNODE_FFI_HAS_FAST_CALL_PLAN1
23+
#endif
24+
1725
namespacenode::ffi {
1826

1927
classDynamicLibrary;
2028
structFFIFunction;
2129

2230
structFFIFunction {
23-
bool closed;
31+
FFIFunction() = default;
32+
FFIFunction(const FFIFunction&) = delete;
33+
FFIFunction& operator=(const FFIFunction&) = delete;
34+
FFIFunction(FFIFunction&&) = delete;
35+
FFIFunction& operator=(FFIFunction&&) = delete;
2436

25-
void* ptr;
26-
ffi_cif cif;
37+
bool closed = false;
38+
39+
void* ptr = nullptr;
40+
ffi_cif cif = {};
2741
std::vector<ffi_type*> args;
28-
ffi_type* return_type;
42+
ffi_type* return_type = nullptr;
2943
std::vector<std::string> arg_type_names;
3044
std::string return_type_name;
45+
#if defined(NODE_FFI_HAS_FAST_CALL_PLAN)
46+
// The plan borrows cif, so it must remain uniquely owned by this instance.
47+
std::unique_ptr<ffi_call_plan, decltype(&ffi_call_plan_free)> call_plan{
48+
nullptr, ffi_call_plan_free};
49+
#endif
50+
51+
voidInvoke(void* result, void** values);
3152
};
3253

3354
classFFIFunctionInfofinal : public BaseObject {

0 commit comments

Comments
Β (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Commit 5cac7c2

Browse files
umuoy1aduh95
authored andcommitted
ffi: reuse libffi call plans
Precompute a libffi call plan for each fixed signature on x86-64 System V and reuse it from the generic and SharedBuffer invokers. This avoids repeating argument-placement work for every call. Continue to use ffi_call() with libffi older than 3.7, on other ABIs, and when plan allocation fails. Signed-off-by: umuoy1 <burningdian@gmail.com> PR-URL: #64958Fixes: #64562 Refs: libffi/libffi@3cc6beb Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Gürgün Dayıoğlu <hey@gurgun.day> Reviewed-By: Paolo Insogna <paolo@cowtech.it> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
1 parent 044402c commit 5cac7c2

4 files changed

Lines changed: 152 additions & 17 deletions

File tree

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
'use strict';
2+
3+
constassert=require('node:assert');
4+
constcommon=require('../common.js');
5+
const{ libraryPath, ensureFixtureLibrary }=require('./common.js');
6+
7+
// Measure the invocation (call) path for signatures that bypass V8 Fast API
8+
// and use libffi through FFIFunction::Invoke(). On x86-64 System V with
9+
// libffi >= 3.7, Invoke() reuses a precomputed call plan that avoids repeating
10+
// argument-placement work on every call. This benchmark quantifies the
11+
// per-call benefit.
12+
//
13+
// Signatures chosen to bypass both V8 Fast API and keep native work minimal:
14+
// - call_int_callback (null): 'function' type forces the generic path; null
15+
// pointer triggers the early return in C so native computation is negligible.
16+
// From libffi's perspective this is a register-only plan (2 pointer-sized
17+
// args both fit in GP registers on x86-64 System V).
18+
// - sum_8_i32: 8 GP args exceed the x86-64 Fast API register cap (6), forcing
19+
// the generic path. From libffi's perspective 6 args go in registers and 2
20+
// spill to the stack, exercising a stack-spilled plan.
21+
22+
constbench=common.createBenchmark(main,{
23+
n: [1e7],
24+
symbol: ['call_int_callback','sum_8_i32'],
25+
},{
26+
flags: ['--experimental-ffi','--no-warnings'],
27+
});
28+
29+
ensureFixtureLibrary();
30+
31+
functionmain({ n, symbol }){
32+
constffi=require('node:ffi');
33+
34+
if(symbol==='call_int_callback'){
35+
// 'function' type bypasses Fast API (IsFastCallEligible rejects it).
36+
// Pass 0n (null function pointer) so the native function returns -1
37+
// immediately without invoking any callback, keeping per-call overhead
38+
// dominated by the FFI call machinery itself.
39+
const{ lib, functions }=ffi.dlopen(libraryPath,{
40+
call_int_callback: {return: 'i32',arguments: ['function','i32']},
41+
});
42+
43+
try{
44+
// Verify the null-pointer early return.
45+
assert.strictEqual(functions.call_int_callback(0n,7),-1);
46+
47+
bench.start();
48+
for(leti=0;i<n;++i)
49+
functions.call_int_callback(0n,21);
50+
bench.end(n);
51+
}finally{
52+
lib.close();
53+
}
54+
}else{
55+
// 8 integer args exceed the x86-64 SysV GP register cap (6), which makes
56+
// CreateFastFFIMetadata reject the signature. Calls go through the
57+
// SharedBuffer or generic invoker into FFIFunction::Invoke().
58+
const{ lib, functions }=ffi.dlopen(libraryPath,{
59+
sum_8_i32: {
60+
return: 'i32',
61+
arguments: [
62+
'i32','i32','i32','i32',
63+
'i32','i32','i32','i32',
64+
],
65+
},
66+
});
67+
68+
constfn=functions.sum_8_i32;
69+
70+
assert.strictEqual(fn(1,2,3,4,5,6,7,8),36);
71+
72+
bench.start();
73+
for(leti=0;i<n;++i)
74+
fn(1,2,3,4,5,6,7,14);
75+
bench.end(n);
76+
77+
lib.close();
78+
}
79+
}

β€Žsrc/ffi/fast.ccβ€Ž

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -192,13 +192,31 @@ bool SignatureNeedsFastBufferInvoke(const FFIFunction& fn) {
192192
IsBufferTypeName(fn.arg_type_names[0]));
193193
}
194194

195+
namespace {
196+
197+
std::shared_ptr<FFIFunction> CloneForFastMetadata(
198+
const std::shared_ptr<FFIFunction>& fn) {
199+
// Fast metadata only needs the native target and signature. In particular,
200+
// its temporary clone must not borrow the original function's cif or plan.
201+
auto clone = std::make_shared<FFIFunction>();
202+
clone->closed = fn->closed;
203+
clone->ptr = fn->ptr;
204+
clone->args = fn->args;
205+
clone->return_type = fn->return_type;
206+
clone->arg_type_names = fn->arg_type_names;
207+
clone->return_type_name = fn->return_type_name;
208+
return clone;
209+
}
210+
211+
} // namespace
212+
195213
std::shared_ptr<FFIFunction> CloneWithRawPointerArgNames(
196214
const std::shared_ptr<FFIFunction>& fn) {
197215
// The primary Fast API entrypoint receives pointer-compatible values as
198216
// BigInts after the JS wrapper has converted strings, nullish values, and
199217
// memory-backed objects. A secondary entrypoint handles the monomorphic
200218
// memory-backed case without extracting the pointer in JS.
201-
auto clone = std::make_shared<FFIFunction>(*fn);
219+
auto clone = CloneForFastMetadata(fn);
202220
for (std::string& name : clone->arg_type_names) {
203221
if (IsBufferTypeName(name)) {
204222
name = "pointer";
@@ -209,10 +227,10 @@ std::shared_ptr<FFIFunction> CloneWithRawPointerArgNames(
209227

210228
std::shared_ptr<FFIFunction> CloneWithFastBufferArgNames(
211229
const std::shared_ptr<FFIFunction>& fn) {
212-
// Reuse the same native target and libffi metadata, but describe the JS
230+
// Reuse the same native target and signature metadata, but describe the JS
213231
// argument as `buffer` so CreateFastFFIMetadata() emits a trampoline that
214232
// receives a V8 value and calls node_ffi_fast_buffer_data().
215-
auto clone = std::make_shared<FFIFunction>(*fn);
233+
auto clone = CloneForFastMetadata(fn);
216234
for (std::string& name : clone->arg_type_names) {
217235
if (IsPointerTypeName(name)) {
218236
name = "buffer";

β€Žsrc/node_ffi.ccβ€Ž

Lines changed: 27 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,17 @@ using v8::Value;
4242

4343
namespaceffi {
4444

45+
voidFFIFunction::Invoke(void* result, void** values) {
46+
#if defined(NODE_FFI_HAS_FAST_CALL_PLAN)
47+
if (call_plan != nullptr) {
48+
ffi_call_plan_invoke(call_plan.get(), FFI_FN(ptr), result, values);
49+
return;
50+
}
51+
#endif
52+
53+
ffi_call(&cif, FFI_FN(ptr), result, values);
54+
}
55+
4556
voidFFIFunctionInfo::MemoryInfo(MemoryTracker* tracker) const {
4657
tracker->TrackField("sb_backing", sb_backing);
4758
}
@@ -146,14 +157,12 @@ Maybe<DynamicLibrary::PreparedFunction> DynamicLibrary::PrepareFunction(
146157

147158
should_cache_symbol = symbols_.find(name) == symbols_.end();
148159

149-
fn = std::make_shared<FFIFunction>(
150-
FFIFunction{.closed = false,
151-
.ptr = ptr,
152-
.cif = {},
153-
.args = args,
154-
.return_type = return_type,
155-
.arg_type_names = std::move(arg_type_names),
156-
.return_type_name = std::move(return_type_name)});
160+
fn = std::make_shared<FFIFunction>();
161+
fn->ptr = ptr;
162+
fn->args = std::move(args);
163+
fn->return_type = return_type;
164+
fn->arg_type_names = std::move(arg_type_names);
165+
fn->return_type_name = std::move(return_type_name);
157166

158167
ffi_status status = ffi_prep_cif(&fn->cif,
159168
FFI_DEFAULT_ABI,
@@ -178,6 +187,14 @@ Maybe<DynamicLibrary::PreparedFunction> DynamicLibrary::PrepareFunction(
178187
return {};
179188
}
180189

190+
#if defined(NODE_FFI_HAS_FAST_CALL_PLAN)
191+
// Allocation failure is non-fatal. Invoke() falls back to ffi_call().
192+
ffi_call_plan* call_plan = ffi_call_plan_alloc(&fn->cif);
193+
if (call_plan != nullptr) {
194+
fn->call_plan.reset(call_plan);
195+
}
196+
#endif
197+
181198
should_cache_function = true;
182199
} else {
183200
fn = existing->second;
@@ -552,7 +569,7 @@ void DynamicLibrary::InvokeFunction(const FunctionCallbackInfo<Value>& args) {
552569
result = Malloc(GetFFIReturnValueStorageSize(fn->return_type));
553570
}
554571

555-
ffi_call(&fn->cif, FFI_FN(fn->ptr), result, ffi_args.data());
572+
fn->Invoke(result, ffi_args.data());
556573

557574
// Return result back to Javascript
558575
ToJSReturnValue(env, args, fn->return_type, result);
@@ -611,7 +628,7 @@ void DynamicLibrary::InvokeFunctionSB(const FunctionCallbackInfo<Value>& args) {
611628
alignas(8) uint8_t result_storage[kSBResultStorageSize] = {0};
612629
void* result = (fn->return_type != &ffi_type_void) ? result_storage : nullptr;
613630

614-
ffi_call(&fn->cif, FFI_FN(fn->ptr), result, ffi_args.data());
631+
fn->Invoke(result, ffi_args.data());
615632

616633
if (result != nullptr) {
617634
WriteFFIReturnToBuffer(fn->return_type, result, buffer, 0);

β€Žsrc/node_ffi.hβ€Ž

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,41 @@
1414
#include<unordered_map>
1515
#include<vector>
1616

17+
// libffi only accelerates reusable call plans on x86-64 System V. Other
18+
// targets implement the API by calling ffi_call(), which adds no benefit.
19+
#if defined(FFI_VERSION_NUMBER) && FFI_VERSION_NUMBER >= 30700 && \
20+
defined(__x86_64__) && !defined(__ILP32__) && !defined(X86_WIN64) && \
21+
!defined(_WIN32)
22+
#defineNODE_FFI_HAS_FAST_CALL_PLAN1
23+
#endif
24+
1725
namespacenode::ffi {
1826

1927
classDynamicLibrary;
2028
structFFIFunction;
2129

2230
structFFIFunction {
23-
bool closed;
31+
FFIFunction() = default;
32+
FFIFunction(const FFIFunction&) = delete;
33+
FFIFunction& operator=(const FFIFunction&) = delete;
34+
FFIFunction(FFIFunction&&) = delete;
35+
FFIFunction& operator=(FFIFunction&&) = delete;
2436

25-
void* ptr;
26-
ffi_cif cif;
37+
bool closed = false;
38+
39+
void* ptr = nullptr;
40+
ffi_cif cif = {};
2741
std::vector<ffi_type*> args;
28-
ffi_type* return_type;
42+
ffi_type* return_type = nullptr;
2943
std::vector<std::string> arg_type_names;
3044
std::string return_type_name;
45+
#if defined(NODE_FFI_HAS_FAST_CALL_PLAN)
46+
// The plan borrows cif, so it must remain uniquely owned by this instance.
47+
std::unique_ptr<ffi_call_plan, decltype(&ffi_call_plan_free)> call_plan{
48+
nullptr, ffi_call_plan_free};
49+
#endif
50+
51+
voidInvoke(void* result, void** values);
3152
};
3253

3354
classFFIFunctionInfofinal : public BaseObject {

0 commit comments

Comments
Β (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

Commit 5cac7c2

Browse files
umuoy1aduh95
authored andcommitted
ffi: reuse libffi call plans
Precompute a libffi call plan for each fixed signature on x86-64 System V and reuse it from the generic and SharedBuffer invokers. This avoids repeating argument-placement work for every call. Continue to use ffi_call() with libffi older than 3.7, on other ABIs, and when plan allocation fails. Signed-off-by: umuoy1 <burningdian@gmail.com> PR-URL: #64958Fixes: #64562 Refs: libffi/libffi@3cc6beb Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Gürgün Dayıoğlu <hey@gurgun.day> Reviewed-By: Paolo Insogna <paolo@cowtech.it> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
1 parent 044402c commit 5cac7c2

4 files changed

Lines changed: 152 additions & 17 deletions

File tree

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
'use strict';
2+
3+
constassert=require('node:assert');
4+
constcommon=require('../common.js');
5+
const{ libraryPath, ensureFixtureLibrary }=require('./common.js');
6+
7+
// Measure the invocation (call) path for signatures that bypass V8 Fast API
8+
// and use libffi through FFIFunction::Invoke(). On x86-64 System V with
9+
// libffi >= 3.7, Invoke() reuses a precomputed call plan that avoids repeating
10+
// argument-placement work on every call. This benchmark quantifies the
11+
// per-call benefit.
12+
//
13+
// Signatures chosen to bypass both V8 Fast API and keep native work minimal:
14+
// - call_int_callback (null): 'function' type forces the generic path; null
15+
// pointer triggers the early return in C so native computation is negligible.
16+
// From libffi's perspective this is a register-only plan (2 pointer-sized
17+
// args both fit in GP registers on x86-64 System V).
18+
// - sum_8_i32: 8 GP args exceed the x86-64 Fast API register cap (6), forcing
19+
// the generic path. From libffi's perspective 6 args go in registers and 2
20+
// spill to the stack, exercising a stack-spilled plan.
21+
22+
constbench=common.createBenchmark(main,{
23+
n: [1e7],
24+
symbol: ['call_int_callback','sum_8_i32'],
25+
},{
26+
flags: ['--experimental-ffi','--no-warnings'],
27+
});
28+
29+
ensureFixtureLibrary();
30+
31+
functionmain({ n, symbol }){
32+
constffi=require('node:ffi');
33+
34+
if(symbol==='call_int_callback'){
35+
// 'function' type bypasses Fast API (IsFastCallEligible rejects it).
36+
// Pass 0n (null function pointer) so the native function returns -1
37+
// immediately without invoking any callback, keeping per-call overhead
38+
// dominated by the FFI call machinery itself.
39+
const{ lib, functions }=ffi.dlopen(libraryPath,{
40+
call_int_callback: {return: 'i32',arguments: ['function','i32']},
41+
});
42+
43+
try{
44+
// Verify the null-pointer early return.
45+
assert.strictEqual(functions.call_int_callback(0n,7),-1);
46+
47+
bench.start();
48+
for(leti=0;i<n;++i)
49+
functions.call_int_callback(0n,21);
50+
bench.end(n);
51+
}finally{
52+
lib.close();
53+
}
54+
}else{
55+
// 8 integer args exceed the x86-64 SysV GP register cap (6), which makes
56+
// CreateFastFFIMetadata reject the signature. Calls go through the
57+
// SharedBuffer or generic invoker into FFIFunction::Invoke().
58+
const{ lib, functions }=ffi.dlopen(libraryPath,{
59+
sum_8_i32: {
60+
return: 'i32',
61+
arguments: [
62+
'i32','i32','i32','i32',
63+
'i32','i32','i32','i32',
64+
],
65+
},
66+
});
67+
68+
constfn=functions.sum_8_i32;
69+
70+
assert.strictEqual(fn(1,2,3,4,5,6,7,8),36);
71+
72+
bench.start();
73+
for(leti=0;i<n;++i)
74+
fn(1,2,3,4,5,6,7,14);
75+
bench.end(n);
76+
77+
lib.close();
78+
}
79+
}

β€Žsrc/ffi/fast.ccβ€Ž

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -192,13 +192,31 @@ bool SignatureNeedsFastBufferInvoke(const FFIFunction& fn) {
192192
IsBufferTypeName(fn.arg_type_names[0]));
193193
}
194194

195+
namespace {
196+
197+
std::shared_ptr<FFIFunction> CloneForFastMetadata(
198+
const std::shared_ptr<FFIFunction>& fn) {
199+
// Fast metadata only needs the native target and signature. In particular,
200+
// its temporary clone must not borrow the original function's cif or plan.
201+
auto clone = std::make_shared<FFIFunction>();
202+
clone->closed = fn->closed;
203+
clone->ptr = fn->ptr;
204+
clone->args = fn->args;
205+
clone->return_type = fn->return_type;
206+
clone->arg_type_names = fn->arg_type_names;
207+
clone->return_type_name = fn->return_type_name;
208+
return clone;
209+
}
210+
211+
} // namespace
212+
195213
std::shared_ptr<FFIFunction> CloneWithRawPointerArgNames(
196214
const std::shared_ptr<FFIFunction>& fn) {
197215
// The primary Fast API entrypoint receives pointer-compatible values as
198216
// BigInts after the JS wrapper has converted strings, nullish values, and
199217
// memory-backed objects. A secondary entrypoint handles the monomorphic
200218
// memory-backed case without extracting the pointer in JS.
201-
auto clone = std::make_shared<FFIFunction>(*fn);
219+
auto clone = CloneForFastMetadata(fn);
202220
for (std::string& name : clone->arg_type_names) {
203221
if (IsBufferTypeName(name)) {
204222
name = "pointer";
@@ -209,10 +227,10 @@ std::shared_ptr<FFIFunction> CloneWithRawPointerArgNames(
209227

210228
std::shared_ptr<FFIFunction> CloneWithFastBufferArgNames(
211229
const std::shared_ptr<FFIFunction>& fn) {
212-
// Reuse the same native target and libffi metadata, but describe the JS
230+
// Reuse the same native target and signature metadata, but describe the JS
213231
// argument as `buffer` so CreateFastFFIMetadata() emits a trampoline that
214232
// receives a V8 value and calls node_ffi_fast_buffer_data().
215-
auto clone = std::make_shared<FFIFunction>(*fn);
233+
auto clone = CloneForFastMetadata(fn);
216234
for (std::string& name : clone->arg_type_names) {
217235
if (IsPointerTypeName(name)) {
218236
name = "buffer";

β€Žsrc/node_ffi.ccβ€Ž

Lines changed: 27 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,17 @@ using v8::Value;
4242

4343
namespaceffi {
4444

45+
voidFFIFunction::Invoke(void* result, void** values) {
46+
#if defined(NODE_FFI_HAS_FAST_CALL_PLAN)
47+
if (call_plan != nullptr) {
48+
ffi_call_plan_invoke(call_plan.get(), FFI_FN(ptr), result, values);
49+
return;
50+
}
51+
#endif
52+
53+
ffi_call(&cif, FFI_FN(ptr), result, values);
54+
}
55+
4556
voidFFIFunctionInfo::MemoryInfo(MemoryTracker* tracker) const {
4657
tracker->TrackField("sb_backing", sb_backing);
4758
}
@@ -146,14 +157,12 @@ Maybe<DynamicLibrary::PreparedFunction> DynamicLibrary::PrepareFunction(
146157

147158
should_cache_symbol = symbols_.find(name) == symbols_.end();
148159

149-
fn = std::make_shared<FFIFunction>(
150-
FFIFunction{.closed = false,
151-
.ptr = ptr,
152-
.cif = {},
153-
.args = args,
154-
.return_type = return_type,
155-
.arg_type_names = std::move(arg_type_names),
156-
.return_type_name = std::move(return_type_name)});
160+
fn = std::make_shared<FFIFunction>();
161+
fn->ptr = ptr;
162+
fn->args = std::move(args);
163+
fn->return_type = return_type;
164+
fn->arg_type_names = std::move(arg_type_names);
165+
fn->return_type_name = std::move(return_type_name);
157166

158167
ffi_status status = ffi_prep_cif(&fn->cif,
159168
FFI_DEFAULT_ABI,
@@ -178,6 +187,14 @@ Maybe<DynamicLibrary::PreparedFunction> DynamicLibrary::PrepareFunction(
178187
return {};
179188
}
180189

190+
#if defined(NODE_FFI_HAS_FAST_CALL_PLAN)
191+
// Allocation failure is non-fatal. Invoke() falls back to ffi_call().
192+
ffi_call_plan* call_plan = ffi_call_plan_alloc(&fn->cif);
193+
if (call_plan != nullptr) {
194+
fn->call_plan.reset(call_plan);
195+
}
196+
#endif
197+
181198
should_cache_function = true;
182199
} else {
183200
fn = existing->second;
@@ -552,7 +569,7 @@ void DynamicLibrary::InvokeFunction(const FunctionCallbackInfo<Value>& args) {
552569
result = Malloc(GetFFIReturnValueStorageSize(fn->return_type));
553570
}
554571

555-
ffi_call(&fn->cif, FFI_FN(fn->ptr), result, ffi_args.data());
572+
fn->Invoke(result, ffi_args.data());
556573

557574
// Return result back to Javascript
558575
ToJSReturnValue(env, args, fn->return_type, result);
@@ -611,7 +628,7 @@ void DynamicLibrary::InvokeFunctionSB(const FunctionCallbackInfo<Value>& args) {
611628
alignas(8) uint8_t result_storage[kSBResultStorageSize] = {0};
612629
void* result = (fn->return_type != &ffi_type_void) ? result_storage : nullptr;
613630

614-
ffi_call(&fn->cif, FFI_FN(fn->ptr), result, ffi_args.data());
631+
fn->Invoke(result, ffi_args.data());
615632

616633
if (result != nullptr) {
617634
WriteFFIReturnToBuffer(fn->return_type, result, buffer, 0);

β€Žsrc/node_ffi.hβ€Ž

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,41 @@
1414
#include<unordered_map>
1515
#include<vector>
1616

17+
// libffi only accelerates reusable call plans on x86-64 System V. Other
18+
// targets implement the API by calling ffi_call(), which adds no benefit.
19+
#if defined(FFI_VERSION_NUMBER) && FFI_VERSION_NUMBER >= 30700 && \
20+
defined(__x86_64__) && !defined(__ILP32__) && !defined(X86_WIN64) && \
21+
!defined(_WIN32)
22+
#defineNODE_FFI_HAS_FAST_CALL_PLAN1
23+
#endif
24+
1725
namespacenode::ffi {
1826

1927
classDynamicLibrary;
2028
structFFIFunction;
2129

2230
structFFIFunction {
23-
bool closed;
31+
FFIFunction() = default;
32+
FFIFunction(const FFIFunction&) = delete;
33+
FFIFunction& operator=(const FFIFunction&) = delete;
34+
FFIFunction(FFIFunction&&) = delete;
35+
FFIFunction& operator=(FFIFunction&&) = delete;
2436

25-
void* ptr;
26-
ffi_cif cif;
37+
bool closed = false;
38+
39+
void* ptr = nullptr;
40+
ffi_cif cif = {};
2741
std::vector<ffi_type*> args;
28-
ffi_type* return_type;
42+
ffi_type* return_type = nullptr;
2943
std::vector<std::string> arg_type_names;
3044
std::string return_type_name;
45+
#if defined(NODE_FFI_HAS_FAST_CALL_PLAN)
46+
// The plan borrows cif, so it must remain uniquely owned by this instance.
47+
std::unique_ptr<ffi_call_plan, decltype(&ffi_call_plan_free)> call_plan{
48+
nullptr, ffi_call_plan_free};
49+
#endif
50+
51+
voidInvoke(void* result, void** values);
3152
};
3253

3354
classFFIFunctionInfofinal : public BaseObject {

0 commit comments

Comments
Β (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Commit 5cac7c2

Browse files
umuoy1aduh95
authored andcommitted
ffi: reuse libffi call plans
Precompute a libffi call plan for each fixed signature on x86-64 System V and reuse it from the generic and SharedBuffer invokers. This avoids repeating argument-placement work for every call. Continue to use ffi_call() with libffi older than 3.7, on other ABIs, and when plan allocation fails. Signed-off-by: umuoy1 <burningdian@gmail.com> PR-URL: #64958Fixes: #64562 Refs: libffi/libffi@3cc6beb Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Gürgün Dayıoğlu <hey@gurgun.day> Reviewed-By: Paolo Insogna <paolo@cowtech.it> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
1 parent 044402c commit 5cac7c2

4 files changed

Lines changed: 152 additions & 17 deletions

File tree

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
'use strict';
2+
3+
constassert=require('node:assert');
4+
constcommon=require('../common.js');
5+
const{ libraryPath, ensureFixtureLibrary }=require('./common.js');
6+
7+
// Measure the invocation (call) path for signatures that bypass V8 Fast API
8+
// and use libffi through FFIFunction::Invoke(). On x86-64 System V with
9+
// libffi >= 3.7, Invoke() reuses a precomputed call plan that avoids repeating
10+
// argument-placement work on every call. This benchmark quantifies the
11+
// per-call benefit.
12+
//
13+
// Signatures chosen to bypass both V8 Fast API and keep native work minimal:
14+
// - call_int_callback (null): 'function' type forces the generic path; null
15+
// pointer triggers the early return in C so native computation is negligible.
16+
// From libffi's perspective this is a register-only plan (2 pointer-sized
17+
// args both fit in GP registers on x86-64 System V).
18+
// - sum_8_i32: 8 GP args exceed the x86-64 Fast API register cap (6), forcing
19+
// the generic path. From libffi's perspective 6 args go in registers and 2
20+
// spill to the stack, exercising a stack-spilled plan.
21+
22+
constbench=common.createBenchmark(main,{
23+
n: [1e7],
24+
symbol: ['call_int_callback','sum_8_i32'],
25+
},{
26+
flags: ['--experimental-ffi','--no-warnings'],
27+
});
28+
29+
ensureFixtureLibrary();
30+
31+
functionmain({ n, symbol }){
32+
constffi=require('node:ffi');
33+
34+
if(symbol==='call_int_callback'){
35+
// 'function' type bypasses Fast API (IsFastCallEligible rejects it).
36+
// Pass 0n (null function pointer) so the native function returns -1
37+
// immediately without invoking any callback, keeping per-call overhead
38+
// dominated by the FFI call machinery itself.
39+
const{ lib, functions }=ffi.dlopen(libraryPath,{
40+
call_int_callback: {return: 'i32',arguments: ['function','i32']},
41+
});
42+
43+
try{
44+
// Verify the null-pointer early return.
45+
assert.strictEqual(functions.call_int_callback(0n,7),-1);
46+
47+
bench.start();
48+
for(leti=0;i<n;++i)
49+
functions.call_int_callback(0n,21);
50+
bench.end(n);
51+
}finally{
52+
lib.close();
53+
}
54+
}else{
55+
// 8 integer args exceed the x86-64 SysV GP register cap (6), which makes
56+
// CreateFastFFIMetadata reject the signature. Calls go through the
57+
// SharedBuffer or generic invoker into FFIFunction::Invoke().
58+
const{ lib, functions }=ffi.dlopen(libraryPath,{
59+
sum_8_i32: {
60+
return: 'i32',
61+
arguments: [
62+
'i32','i32','i32','i32',
63+
'i32','i32','i32','i32',
64+
],
65+
},
66+
});
67+
68+
constfn=functions.sum_8_i32;
69+
70+
assert.strictEqual(fn(1,2,3,4,5,6,7,8),36);
71+
72+
bench.start();
73+
for(leti=0;i<n;++i)
74+
fn(1,2,3,4,5,6,7,14);
75+
bench.end(n);
76+
77+
lib.close();
78+
}
79+
}

β€Žsrc/ffi/fast.ccβ€Ž

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -192,13 +192,31 @@ bool SignatureNeedsFastBufferInvoke(const FFIFunction& fn) {
192192
IsBufferTypeName(fn.arg_type_names[0]));
193193
}
194194

195+
namespace {
196+
197+
std::shared_ptr<FFIFunction> CloneForFastMetadata(
198+
const std::shared_ptr<FFIFunction>& fn) {
199+
// Fast metadata only needs the native target and signature. In particular,
200+
// its temporary clone must not borrow the original function's cif or plan.
201+
auto clone = std::make_shared<FFIFunction>();
202+
clone->closed = fn->closed;
203+
clone->ptr = fn->ptr;
204+
clone->args = fn->args;
205+
clone->return_type = fn->return_type;
206+
clone->arg_type_names = fn->arg_type_names;
207+
clone->return_type_name = fn->return_type_name;
208+
return clone;
209+
}
210+
211+
} // namespace
212+
195213
std::shared_ptr<FFIFunction> CloneWithRawPointerArgNames(
196214
const std::shared_ptr<FFIFunction>& fn) {
197215
// The primary Fast API entrypoint receives pointer-compatible values as
198216
// BigInts after the JS wrapper has converted strings, nullish values, and
199217
// memory-backed objects. A secondary entrypoint handles the monomorphic
200218
// memory-backed case without extracting the pointer in JS.
201-
auto clone = std::make_shared<FFIFunction>(*fn);
219+
auto clone = CloneForFastMetadata(fn);
202220
for (std::string& name : clone->arg_type_names) {
203221
if (IsBufferTypeName(name)) {
204222
name = "pointer";
@@ -209,10 +227,10 @@ std::shared_ptr<FFIFunction> CloneWithRawPointerArgNames(
209227

210228
std::shared_ptr<FFIFunction> CloneWithFastBufferArgNames(
211229
const std::shared_ptr<FFIFunction>& fn) {
212-
// Reuse the same native target and libffi metadata, but describe the JS
230+
// Reuse the same native target and signature metadata, but describe the JS
213231
// argument as `buffer` so CreateFastFFIMetadata() emits a trampoline that
214232
// receives a V8 value and calls node_ffi_fast_buffer_data().
215-
auto clone = std::make_shared<FFIFunction>(*fn);
233+
auto clone = CloneForFastMetadata(fn);
216234
for (std::string& name : clone->arg_type_names) {
217235
if (IsPointerTypeName(name)) {
218236
name = "buffer";

β€Žsrc/node_ffi.ccβ€Ž

Lines changed: 27 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,17 @@ using v8::Value;
4242

4343
namespaceffi {
4444

45+
voidFFIFunction::Invoke(void* result, void** values) {
46+
#if defined(NODE_FFI_HAS_FAST_CALL_PLAN)
47+
if (call_plan != nullptr) {
48+
ffi_call_plan_invoke(call_plan.get(), FFI_FN(ptr), result, values);
49+
return;
50+
}
51+
#endif
52+
53+
ffi_call(&cif, FFI_FN(ptr), result, values);
54+
}
55+
4556
voidFFIFunctionInfo::MemoryInfo(MemoryTracker* tracker) const {
4657
tracker->TrackField("sb_backing", sb_backing);
4758
}
@@ -146,14 +157,12 @@ Maybe<DynamicLibrary::PreparedFunction> DynamicLibrary::PrepareFunction(
146157

147158
should_cache_symbol = symbols_.find(name) == symbols_.end();
148159

149-
fn = std::make_shared<FFIFunction>(
150-
FFIFunction{.closed = false,
151-
.ptr = ptr,
152-
.cif = {},
153-
.args = args,
154-
.return_type = return_type,
155-
.arg_type_names = std::move(arg_type_names),
156-
.return_type_name = std::move(return_type_name)});
160+
fn = std::make_shared<FFIFunction>();
161+
fn->ptr = ptr;
162+
fn->args = std::move(args);
163+
fn->return_type = return_type;
164+
fn->arg_type_names = std::move(arg_type_names);
165+
fn->return_type_name = std::move(return_type_name);
157166

158167
ffi_status status = ffi_prep_cif(&fn->cif,
159168
FFI_DEFAULT_ABI,
@@ -178,6 +187,14 @@ Maybe<DynamicLibrary::PreparedFunction> DynamicLibrary::PrepareFunction(
178187
return {};
179188
}
180189

190+
#if defined(NODE_FFI_HAS_FAST_CALL_PLAN)
191+
// Allocation failure is non-fatal. Invoke() falls back to ffi_call().
192+
ffi_call_plan* call_plan = ffi_call_plan_alloc(&fn->cif);
193+
if (call_plan != nullptr) {
194+
fn->call_plan.reset(call_plan);
195+
}
196+
#endif
197+
181198
should_cache_function = true;
182199
} else {
183200
fn = existing->second;
@@ -552,7 +569,7 @@ void DynamicLibrary::InvokeFunction(const FunctionCallbackInfo<Value>& args) {
552569
result = Malloc(GetFFIReturnValueStorageSize(fn->return_type));
553570
}
554571

555-
ffi_call(&fn->cif, FFI_FN(fn->ptr), result, ffi_args.data());
572+
fn->Invoke(result, ffi_args.data());
556573

557574
// Return result back to Javascript
558575
ToJSReturnValue(env, args, fn->return_type, result);
@@ -611,7 +628,7 @@ void DynamicLibrary::InvokeFunctionSB(const FunctionCallbackInfo<Value>& args) {
611628
alignas(8) uint8_t result_storage[kSBResultStorageSize] = {0};
612629
void* result = (fn->return_type != &ffi_type_void) ? result_storage : nullptr;
613630

614-
ffi_call(&fn->cif, FFI_FN(fn->ptr), result, ffi_args.data());
631+
fn->Invoke(result, ffi_args.data());
615632

616633
if (result != nullptr) {
617634
WriteFFIReturnToBuffer(fn->return_type, result, buffer, 0);

β€Žsrc/node_ffi.hβ€Ž

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,41 @@
1414
#include<unordered_map>
1515
#include<vector>
1616

17+
// libffi only accelerates reusable call plans on x86-64 System V. Other
18+
// targets implement the API by calling ffi_call(), which adds no benefit.
19+
#if defined(FFI_VERSION_NUMBER) && FFI_VERSION_NUMBER >= 30700 && \
20+
defined(__x86_64__) && !defined(__ILP32__) && !defined(X86_WIN64) && \
21+
!defined(_WIN32)
22+
#defineNODE_FFI_HAS_FAST_CALL_PLAN1
23+
#endif
24+
1725
namespacenode::ffi {
1826

1927
classDynamicLibrary;
2028
structFFIFunction;
2129

2230
structFFIFunction {
23-
bool closed;
31+
FFIFunction() = default;
32+
FFIFunction(const FFIFunction&) = delete;
33+
FFIFunction& operator=(const FFIFunction&) = delete;
34+
FFIFunction(FFIFunction&&) = delete;
35+
FFIFunction& operator=(FFIFunction&&) = delete;
2436

25-
void* ptr;
26-
ffi_cif cif;
37+
bool closed = false;
38+
39+
void* ptr = nullptr;
40+
ffi_cif cif = {};
2741
std::vector<ffi_type*> args;
28-
ffi_type* return_type;
42+
ffi_type* return_type = nullptr;
2943
std::vector<std::string> arg_type_names;
3044
std::string return_type_name;
45+
#if defined(NODE_FFI_HAS_FAST_CALL_PLAN)
46+
// The plan borrows cif, so it must remain uniquely owned by this instance.
47+
std::unique_ptr<ffi_call_plan, decltype(&ffi_call_plan_free)> call_plan{
48+
nullptr, ffi_call_plan_free};
49+
#endif
50+
51+
voidInvoke(void* result, void** values);
3152
};
3253

3354
classFFIFunctionInfofinal : public BaseObject {

0 commit comments

Comments
Β (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Commit 5cac7c2

Browse files
umuoy1aduh95
authored andcommitted
ffi: reuse libffi call plans
Precompute a libffi call plan for each fixed signature on x86-64 System V and reuse it from the generic and SharedBuffer invokers. This avoids repeating argument-placement work for every call. Continue to use ffi_call() with libffi older than 3.7, on other ABIs, and when plan allocation fails. Signed-off-by: umuoy1 <burningdian@gmail.com> PR-URL: #64958Fixes: #64562 Refs: libffi/libffi@3cc6beb Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Gürgün Dayıoğlu <hey@gurgun.day> Reviewed-By: Paolo Insogna <paolo@cowtech.it> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
1 parent 044402c commit 5cac7c2

4 files changed

Lines changed: 152 additions & 17 deletions

File tree

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
'use strict';
2+
3+
constassert=require('node:assert');
4+
constcommon=require('../common.js');
5+
const{ libraryPath, ensureFixtureLibrary }=require('./common.js');
6+
7+
// Measure the invocation (call) path for signatures that bypass V8 Fast API
8+
// and use libffi through FFIFunction::Invoke(). On x86-64 System V with
9+
// libffi >= 3.7, Invoke() reuses a precomputed call plan that avoids repeating
10+
// argument-placement work on every call. This benchmark quantifies the
11+
// per-call benefit.
12+
//
13+
// Signatures chosen to bypass both V8 Fast API and keep native work minimal:
14+
// - call_int_callback (null): 'function' type forces the generic path; null
15+
// pointer triggers the early return in C so native computation is negligible.
16+
// From libffi's perspective this is a register-only plan (2 pointer-sized
17+
// args both fit in GP registers on x86-64 System V).
18+
// - sum_8_i32: 8 GP args exceed the x86-64 Fast API register cap (6), forcing
19+
// the generic path. From libffi's perspective 6 args go in registers and 2
20+
// spill to the stack, exercising a stack-spilled plan.
21+
22+
constbench=common.createBenchmark(main,{
23+
n: [1e7],
24+
symbol: ['call_int_callback','sum_8_i32'],
25+
},{
26+
flags: ['--experimental-ffi','--no-warnings'],
27+
});
28+
29+
ensureFixtureLibrary();
30+
31+
functionmain({ n, symbol }){
32+
constffi=require('node:ffi');
33+
34+
if(symbol==='call_int_callback'){
35+
// 'function' type bypasses Fast API (IsFastCallEligible rejects it).
36+
// Pass 0n (null function pointer) so the native function returns -1
37+
// immediately without invoking any callback, keeping per-call overhead
38+
// dominated by the FFI call machinery itself.
39+
const{ lib, functions }=ffi.dlopen(libraryPath,{
40+
call_int_callback: {return: 'i32',arguments: ['function','i32']},
41+
});
42+
43+
try{
44+
// Verify the null-pointer early return.
45+
assert.strictEqual(functions.call_int_callback(0n,7),-1);
46+
47+
bench.start();
48+
for(leti=0;i<n;++i)
49+
functions.call_int_callback(0n,21);
50+
bench.end(n);
51+
}finally{
52+
lib.close();
53+
}
54+
}else{
55+
// 8 integer args exceed the x86-64 SysV GP register cap (6), which makes
56+
// CreateFastFFIMetadata reject the signature. Calls go through the
57+
// SharedBuffer or generic invoker into FFIFunction::Invoke().
58+
const{ lib, functions }=ffi.dlopen(libraryPath,{
59+
sum_8_i32: {
60+
return: 'i32',
61+
arguments: [
62+
'i32','i32','i32','i32',
63+
'i32','i32','i32','i32',
64+
],
65+
},
66+
});
67+
68+
constfn=functions.sum_8_i32;
69+
70+
assert.strictEqual(fn(1,2,3,4,5,6,7,8),36);
71+
72+
bench.start();
73+
for(leti=0;i<n;++i)
74+
fn(1,2,3,4,5,6,7,14);
75+
bench.end(n);
76+
77+
lib.close();
78+
}
79+
}

β€Žsrc/ffi/fast.ccβ€Ž

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -192,13 +192,31 @@ bool SignatureNeedsFastBufferInvoke(const FFIFunction& fn) {
192192
IsBufferTypeName(fn.arg_type_names[0]));
193193
}
194194

195+
namespace {
196+
197+
std::shared_ptr<FFIFunction> CloneForFastMetadata(
198+
const std::shared_ptr<FFIFunction>& fn) {
199+
// Fast metadata only needs the native target and signature. In particular,
200+
// its temporary clone must not borrow the original function's cif or plan.
201+
auto clone = std::make_shared<FFIFunction>();
202+
clone->closed = fn->closed;
203+
clone->ptr = fn->ptr;
204+
clone->args = fn->args;
205+
clone->return_type = fn->return_type;
206+
clone->arg_type_names = fn->arg_type_names;
207+
clone->return_type_name = fn->return_type_name;
208+
return clone;
209+
}
210+
211+
} // namespace
212+
195213
std::shared_ptr<FFIFunction> CloneWithRawPointerArgNames(
196214
const std::shared_ptr<FFIFunction>& fn) {
197215
// The primary Fast API entrypoint receives pointer-compatible values as
198216
// BigInts after the JS wrapper has converted strings, nullish values, and
199217
// memory-backed objects. A secondary entrypoint handles the monomorphic
200218
// memory-backed case without extracting the pointer in JS.
201-
auto clone = std::make_shared<FFIFunction>(*fn);
219+
auto clone = CloneForFastMetadata(fn);
202220
for (std::string& name : clone->arg_type_names) {
203221
if (IsBufferTypeName(name)) {
204222
name = "pointer";
@@ -209,10 +227,10 @@ std::shared_ptr<FFIFunction> CloneWithRawPointerArgNames(
209227

210228
std::shared_ptr<FFIFunction> CloneWithFastBufferArgNames(
211229
const std::shared_ptr<FFIFunction>& fn) {
212-
// Reuse the same native target and libffi metadata, but describe the JS
230+
// Reuse the same native target and signature metadata, but describe the JS
213231
// argument as `buffer` so CreateFastFFIMetadata() emits a trampoline that
214232
// receives a V8 value and calls node_ffi_fast_buffer_data().
215-
auto clone = std::make_shared<FFIFunction>(*fn);
233+
auto clone = CloneForFastMetadata(fn);
216234
for (std::string& name : clone->arg_type_names) {
217235
if (IsPointerTypeName(name)) {
218236
name = "buffer";

β€Žsrc/node_ffi.ccβ€Ž

Lines changed: 27 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,17 @@ using v8::Value;
4242

4343
namespaceffi {
4444

45+
voidFFIFunction::Invoke(void* result, void** values) {
46+
#if defined(NODE_FFI_HAS_FAST_CALL_PLAN)
47+
if (call_plan != nullptr) {
48+
ffi_call_plan_invoke(call_plan.get(), FFI_FN(ptr), result, values);
49+
return;
50+
}
51+
#endif
52+
53+
ffi_call(&cif, FFI_FN(ptr), result, values);
54+
}
55+
4556
voidFFIFunctionInfo::MemoryInfo(MemoryTracker* tracker) const {
4657
tracker->TrackField("sb_backing", sb_backing);
4758
}
@@ -146,14 +157,12 @@ Maybe<DynamicLibrary::PreparedFunction> DynamicLibrary::PrepareFunction(
146157

147158
should_cache_symbol = symbols_.find(name) == symbols_.end();
148159

149-
fn = std::make_shared<FFIFunction>(
150-
FFIFunction{.closed = false,
151-
.ptr = ptr,
152-
.cif = {},
153-
.args = args,
154-
.return_type = return_type,
155-
.arg_type_names = std::move(arg_type_names),
156-
.return_type_name = std::move(return_type_name)});
160+
fn = std::make_shared<FFIFunction>();
161+
fn->ptr = ptr;
162+
fn->args = std::move(args);
163+
fn->return_type = return_type;
164+
fn->arg_type_names = std::move(arg_type_names);
165+
fn->return_type_name = std::move(return_type_name);
157166

158167
ffi_status status = ffi_prep_cif(&fn->cif,
159168
FFI_DEFAULT_ABI,
@@ -178,6 +187,14 @@ Maybe<DynamicLibrary::PreparedFunction> DynamicLibrary::PrepareFunction(
178187
return {};
179188
}
180189

190+
#if defined(NODE_FFI_HAS_FAST_CALL_PLAN)
191+
// Allocation failure is non-fatal. Invoke() falls back to ffi_call().
192+
ffi_call_plan* call_plan = ffi_call_plan_alloc(&fn->cif);
193+
if (call_plan != nullptr) {
194+
fn->call_plan.reset(call_plan);
195+
}
196+
#endif
197+
181198
should_cache_function = true;
182199
} else {
183200
fn = existing->second;
@@ -552,7 +569,7 @@ void DynamicLibrary::InvokeFunction(const FunctionCallbackInfo<Value>& args) {
552569
result = Malloc(GetFFIReturnValueStorageSize(fn->return_type));
553570
}
554571

555-
ffi_call(&fn->cif, FFI_FN(fn->ptr), result, ffi_args.data());
572+
fn->Invoke(result, ffi_args.data());
556573

557574
// Return result back to Javascript
558575
ToJSReturnValue(env, args, fn->return_type, result);
@@ -611,7 +628,7 @@ void DynamicLibrary::InvokeFunctionSB(const FunctionCallbackInfo<Value>& args) {
611628
alignas(8) uint8_t result_storage[kSBResultStorageSize] = {0};
612629
void* result = (fn->return_type != &ffi_type_void) ? result_storage : nullptr;
613630

614-
ffi_call(&fn->cif, FFI_FN(fn->ptr), result, ffi_args.data());
631+
fn->Invoke(result, ffi_args.data());
615632

616633
if (result != nullptr) {
617634
WriteFFIReturnToBuffer(fn->return_type, result, buffer, 0);

β€Žsrc/node_ffi.hβ€Ž

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,41 @@
1414
#include<unordered_map>
1515
#include<vector>
1616

17+
// libffi only accelerates reusable call plans on x86-64 System V. Other
18+
// targets implement the API by calling ffi_call(), which adds no benefit.
19+
#if defined(FFI_VERSION_NUMBER) && FFI_VERSION_NUMBER >= 30700 && \
20+
defined(__x86_64__) && !defined(__ILP32__) && !defined(X86_WIN64) && \
21+
!defined(_WIN32)
22+
#defineNODE_FFI_HAS_FAST_CALL_PLAN1
23+
#endif
24+
1725
namespacenode::ffi {
1826

1927
classDynamicLibrary;
2028
structFFIFunction;
2129

2230
structFFIFunction {
23-
bool closed;
31+
FFIFunction() = default;
32+
FFIFunction(const FFIFunction&) = delete;
33+
FFIFunction& operator=(const FFIFunction&) = delete;
34+
FFIFunction(FFIFunction&&) = delete;
35+
FFIFunction& operator=(FFIFunction&&) = delete;
2436

25-
void* ptr;
26-
ffi_cif cif;
37+
bool closed = false;
38+
39+
void* ptr = nullptr;
40+
ffi_cif cif = {};
2741
std::vector<ffi_type*> args;
28-
ffi_type* return_type;
42+
ffi_type* return_type = nullptr;
2943
std::vector<std::string> arg_type_names;
3044
std::string return_type_name;
45+
#if defined(NODE_FFI_HAS_FAST_CALL_PLAN)
46+
// The plan borrows cif, so it must remain uniquely owned by this instance.
47+
std::unique_ptr<ffi_call_plan, decltype(&ffi_call_plan_free)> call_plan{
48+
nullptr, ffi_call_plan_free};
49+
#endif
50+
51+
voidInvoke(void* result, void** values);
3152
};
3253

3354
classFFIFunctionInfofinal : public BaseObject {

0 commit comments

Comments
Β (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

Commit 5cac7c2

Browse files
umuoy1aduh95
authored andcommitted
ffi: reuse libffi call plans
Precompute a libffi call plan for each fixed signature on x86-64 System V and reuse it from the generic and SharedBuffer invokers. This avoids repeating argument-placement work for every call. Continue to use ffi_call() with libffi older than 3.7, on other ABIs, and when plan allocation fails. Signed-off-by: umuoy1 <burningdian@gmail.com> PR-URL: #64958Fixes: #64562 Refs: libffi/libffi@3cc6beb Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Gürgün Dayıoğlu <hey@gurgun.day> Reviewed-By: Paolo Insogna <paolo@cowtech.it> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
1 parent 044402c commit 5cac7c2

4 files changed

Lines changed: 152 additions & 17 deletions

File tree

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
'use strict';
2+
3+
constassert=require('node:assert');
4+
constcommon=require('../common.js');
5+
const{ libraryPath, ensureFixtureLibrary }=require('./common.js');
6+
7+
// Measure the invocation (call) path for signatures that bypass V8 Fast API
8+
// and use libffi through FFIFunction::Invoke(). On x86-64 System V with
9+
// libffi >= 3.7, Invoke() reuses a precomputed call plan that avoids repeating
10+
// argument-placement work on every call. This benchmark quantifies the
11+
// per-call benefit.
12+
//
13+
// Signatures chosen to bypass both V8 Fast API and keep native work minimal:
14+
// - call_int_callback (null): 'function' type forces the generic path; null
15+
// pointer triggers the early return in C so native computation is negligible.
16+
// From libffi's perspective this is a register-only plan (2 pointer-sized
17+
// args both fit in GP registers on x86-64 System V).
18+
// - sum_8_i32: 8 GP args exceed the x86-64 Fast API register cap (6), forcing
19+
// the generic path. From libffi's perspective 6 args go in registers and 2
20+
// spill to the stack, exercising a stack-spilled plan.
21+
22+
constbench=common.createBenchmark(main,{
23+
n: [1e7],
24+
symbol: ['call_int_callback','sum_8_i32'],
25+
},{
26+
flags: ['--experimental-ffi','--no-warnings'],
27+
});
28+
29+
ensureFixtureLibrary();
30+
31+
functionmain({ n, symbol }){
32+
constffi=require('node:ffi');
33+
34+
if(symbol==='call_int_callback'){
35+
// 'function' type bypasses Fast API (IsFastCallEligible rejects it).
36+
// Pass 0n (null function pointer) so the native function returns -1
37+
// immediately without invoking any callback, keeping per-call overhead
38+
// dominated by the FFI call machinery itself.
39+
const{ lib, functions }=ffi.dlopen(libraryPath,{
40+
call_int_callback: {return: 'i32',arguments: ['function','i32']},
41+
});
42+
43+
try{
44+
// Verify the null-pointer early return.
45+
assert.strictEqual(functions.call_int_callback(0n,7),-1);
46+
47+
bench.start();
48+
for(leti=0;i<n;++i)
49+
functions.call_int_callback(0n,21);
50+
bench.end(n);
51+
}finally{
52+
lib.close();
53+
}
54+
}else{
55+
// 8 integer args exceed the x86-64 SysV GP register cap (6), which makes
56+
// CreateFastFFIMetadata reject the signature. Calls go through the
57+
// SharedBuffer or generic invoker into FFIFunction::Invoke().
58+
const{ lib, functions }=ffi.dlopen(libraryPath,{
59+
sum_8_i32: {
60+
return: 'i32',
61+
arguments: [
62+
'i32','i32','i32','i32',
63+
'i32','i32','i32','i32',
64+
],
65+
},
66+
});
67+
68+
constfn=functions.sum_8_i32;
69+
70+
assert.strictEqual(fn(1,2,3,4,5,6,7,8),36);
71+
72+
bench.start();
73+
for(leti=0;i<n;++i)
74+
fn(1,2,3,4,5,6,7,14);
75+
bench.end(n);
76+
77+
lib.close();
78+
}
79+
}

β€Žsrc/ffi/fast.ccβ€Ž

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -192,13 +192,31 @@ bool SignatureNeedsFastBufferInvoke(const FFIFunction& fn) {
192192
IsBufferTypeName(fn.arg_type_names[0]));
193193
}
194194

195+
namespace {
196+
197+
std::shared_ptr<FFIFunction> CloneForFastMetadata(
198+
const std::shared_ptr<FFIFunction>& fn) {
199+
// Fast metadata only needs the native target and signature. In particular,
200+
// its temporary clone must not borrow the original function's cif or plan.
201+
auto clone = std::make_shared<FFIFunction>();
202+
clone->closed = fn->closed;
203+
clone->ptr = fn->ptr;
204+
clone->args = fn->args;
205+
clone->return_type = fn->return_type;
206+
clone->arg_type_names = fn->arg_type_names;
207+
clone->return_type_name = fn->return_type_name;
208+
return clone;
209+
}
210+
211+
} // namespace
212+
195213
std::shared_ptr<FFIFunction> CloneWithRawPointerArgNames(
196214
const std::shared_ptr<FFIFunction>& fn) {
197215
// The primary Fast API entrypoint receives pointer-compatible values as
198216
// BigInts after the JS wrapper has converted strings, nullish values, and
199217
// memory-backed objects. A secondary entrypoint handles the monomorphic
200218
// memory-backed case without extracting the pointer in JS.
201-
auto clone = std::make_shared<FFIFunction>(*fn);
219+
auto clone = CloneForFastMetadata(fn);
202220
for (std::string& name : clone->arg_type_names) {
203221
if (IsBufferTypeName(name)) {
204222
name = "pointer";
@@ -209,10 +227,10 @@ std::shared_ptr<FFIFunction> CloneWithRawPointerArgNames(
209227

210228
std::shared_ptr<FFIFunction> CloneWithFastBufferArgNames(
211229
const std::shared_ptr<FFIFunction>& fn) {
212-
// Reuse the same native target and libffi metadata, but describe the JS
230+
// Reuse the same native target and signature metadata, but describe the JS
213231
// argument as `buffer` so CreateFastFFIMetadata() emits a trampoline that
214232
// receives a V8 value and calls node_ffi_fast_buffer_data().
215-
auto clone = std::make_shared<FFIFunction>(*fn);
233+
auto clone = CloneForFastMetadata(fn);
216234
for (std::string& name : clone->arg_type_names) {
217235
if (IsPointerTypeName(name)) {
218236
name = "buffer";

β€Žsrc/node_ffi.ccβ€Ž

Lines changed: 27 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,17 @@ using v8::Value;
4242

4343
namespaceffi {
4444

45+
voidFFIFunction::Invoke(void* result, void** values) {
46+
#if defined(NODE_FFI_HAS_FAST_CALL_PLAN)
47+
if (call_plan != nullptr) {
48+
ffi_call_plan_invoke(call_plan.get(), FFI_FN(ptr), result, values);
49+
return;
50+
}
51+
#endif
52+
53+
ffi_call(&cif, FFI_FN(ptr), result, values);
54+
}
55+
4556
voidFFIFunctionInfo::MemoryInfo(MemoryTracker* tracker) const {
4657
tracker->TrackField("sb_backing", sb_backing);
4758
}
@@ -146,14 +157,12 @@ Maybe<DynamicLibrary::PreparedFunction> DynamicLibrary::PrepareFunction(
146157

147158
should_cache_symbol = symbols_.find(name) == symbols_.end();
148159

149-
fn = std::make_shared<FFIFunction>(
150-
FFIFunction{.closed = false,
151-
.ptr = ptr,
152-
.cif = {},
153-
.args = args,
154-
.return_type = return_type,
155-
.arg_type_names = std::move(arg_type_names),
156-
.return_type_name = std::move(return_type_name)});
160+
fn = std::make_shared<FFIFunction>();
161+
fn->ptr = ptr;
162+
fn->args = std::move(args);
163+
fn->return_type = return_type;
164+
fn->arg_type_names = std::move(arg_type_names);
165+
fn->return_type_name = std::move(return_type_name);
157166

158167
ffi_status status = ffi_prep_cif(&fn->cif,
159168
FFI_DEFAULT_ABI,
@@ -178,6 +187,14 @@ Maybe<DynamicLibrary::PreparedFunction> DynamicLibrary::PrepareFunction(
178187
return {};
179188
}
180189

190+
#if defined(NODE_FFI_HAS_FAST_CALL_PLAN)
191+
// Allocation failure is non-fatal. Invoke() falls back to ffi_call().
192+
ffi_call_plan* call_plan = ffi_call_plan_alloc(&fn->cif);
193+
if (call_plan != nullptr) {
194+
fn->call_plan.reset(call_plan);
195+
}
196+
#endif
197+
181198
should_cache_function = true;
182199
} else {
183200
fn = existing->second;
@@ -552,7 +569,7 @@ void DynamicLibrary::InvokeFunction(const FunctionCallbackInfo<Value>& args) {
552569
result = Malloc(GetFFIReturnValueStorageSize(fn->return_type));
553570
}
554571

555-
ffi_call(&fn->cif, FFI_FN(fn->ptr), result, ffi_args.data());
572+
fn->Invoke(result, ffi_args.data());
556573

557574
// Return result back to Javascript
558575
ToJSReturnValue(env, args, fn->return_type, result);
@@ -611,7 +628,7 @@ void DynamicLibrary::InvokeFunctionSB(const FunctionCallbackInfo<Value>& args) {
611628
alignas(8) uint8_t result_storage[kSBResultStorageSize] = {0};
612629
void* result = (fn->return_type != &ffi_type_void) ? result_storage : nullptr;
613630

614-
ffi_call(&fn->cif, FFI_FN(fn->ptr), result, ffi_args.data());
631+
fn->Invoke(result, ffi_args.data());
615632

616633
if (result != nullptr) {
617634
WriteFFIReturnToBuffer(fn->return_type, result, buffer, 0);

β€Žsrc/node_ffi.hβ€Ž

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,41 @@
1414
#include<unordered_map>
1515
#include<vector>
1616

17+
// libffi only accelerates reusable call plans on x86-64 System V. Other
18+
// targets implement the API by calling ffi_call(), which adds no benefit.
19+
#if defined(FFI_VERSION_NUMBER) && FFI_VERSION_NUMBER >= 30700 && \
20+
defined(__x86_64__) && !defined(__ILP32__) && !defined(X86_WIN64) && \
21+
!defined(_WIN32)
22+
#defineNODE_FFI_HAS_FAST_CALL_PLAN1
23+
#endif
24+
1725
namespacenode::ffi {
1826

1927
classDynamicLibrary;
2028
structFFIFunction;
2129

2230
structFFIFunction {
23-
bool closed;
31+
FFIFunction() = default;
32+
FFIFunction(const FFIFunction&) = delete;
33+
FFIFunction& operator=(const FFIFunction&) = delete;
34+
FFIFunction(FFIFunction&&) = delete;
35+
FFIFunction& operator=(FFIFunction&&) = delete;
2436

25-
void* ptr;
26-
ffi_cif cif;
37+
bool closed = false;
38+
39+
void* ptr = nullptr;
40+
ffi_cif cif = {};
2741
std::vector<ffi_type*> args;
28-
ffi_type* return_type;
42+
ffi_type* return_type = nullptr;
2943
std::vector<std::string> arg_type_names;
3044
std::string return_type_name;
45+
#if defined(NODE_FFI_HAS_FAST_CALL_PLAN)
46+
// The plan borrows cif, so it must remain uniquely owned by this instance.
47+
std::unique_ptr<ffi_call_plan, decltype(&ffi_call_plan_free)> call_plan{
48+
nullptr, ffi_call_plan_free};
49+
#endif
50+
51+
voidInvoke(void* result, void** values);
3152
};
3253

3354
classFFIFunctionInfofinal : public BaseObject {

0 commit comments

Comments
Β (0)