src: add suffix and types

Signed-off-by: Paolo Insogna <[email protected]>

Author: ShogunPanda

deps/libffi/libffi.gyp

@@ -178,7 +178,6 @@
                 'preprocess_asm.py',
                 'include/ffi_cfi.h',
                 'src/aarch64/internal.h',
-                'src/aarch64/ksarm64.h',
                 'src/aarch64/win64_armasm.S',
                 '<(INTERMEDIATE_DIR)/ffi.h',
                 '<(INTERMEDIATE_DIR)/fficonfig.h',

doc/api/ffi.md

@@ -76,6 +76,29 @@ Supported type names:
 * `arraybuffer`
 * `function`
 
+These type names are also exposed as constants on `ffi.types`:
+
+* `ffi.types.VOID` = `'void'`
+* `ffi.types.POINTER` = `'pointer'`
+* `ffi.types.BUFFER` = `'buffer'`
+* `ffi.types.ARRAY_BUFFER` = `'arraybuffer'`
+* `ffi.types.FUNCTION` = `'function'`
+* `ffi.types.BOOL` = `'bool'`
+* `ffi.types.CHAR` = `'char'`
+* `ffi.types.STRING` = `'string'`
+* `ffi.types.FLOAT` = `'float'`
+* `ffi.types.DOUBLE` = `'double'`
+* `ffi.types.INT_8` = `'int8'`
+* `ffi.types.UINT_8` = `'uint8'`
+* `ffi.types.INT_16` = `'int16'`
+* `ffi.types.UINT_16` = `'uint16'`
+* `ffi.types.INT_32` = `'int32'`
+* `ffi.types.UINT_32` = `'uint32'`
+* `ffi.types.INT_64` = `'int64'`
+* `ffi.types.UINT_64` = `'uint64'`
+* `ffi.types.FLOAT_32` = `'float32'`
+* `ffi.types.FLOAT_64` = `'float64'`
+
 Pointer-like types (`pointer`, `string`, `buffer`, `arraybuffer`, and
 `function`) are all passed through the native layer as pointers.
 
@@ -114,6 +137,28 @@ const signature = {
 };
 ```
 
+## `ffi.suffix`
+
+<!-- YAML
+added: REPLACEME
+-->
+
+* {string}
+
+The native shared library suffix for the current platform:
+
+* `'dylib'` on macOS
+* `'so'` on Unix-like platforms
+* `'dll'` on Windows
+
+This can be used to build portable library paths:
+
+```cjs
+const { suffix } = require('node:ffi');
+
+const path = `libsqlite3.${suffix}`;
+```
+
 ## `ffi.dlopen(path[, definitions])`
 
 <!-- YAML

lib/ffi.js

@@ -131,6 +131,33 @@ function exportBuffer(buffer, data, len) {
   buffer.copy(targetBuffer, 0, 0, buffer.length);
 }
 
+const suffix = process.platform === 'win32' ? 'dll' : process.platform === 'darwin' ? 'dylib' : 'so';
+
+const types = ObjectFreeze({
+  __proto__: null,
+  VOID: 'void',
+  POINTER: 'pointer',
+  BUFFER: 'buffer',
+  ARRAY_BUFFER: 'arraybuffer',
+  FUNCTION: 'function',
+  BOOL: 'bool',
+  CHAR: 'char',
+  STRING: 'string',
+  FLOAT: 'float',
+  DOUBLE: 'double',
+  INT_8: 'int8',
+  UINT_8: 'uint8',
+  INT_16: 'int16',
+  UINT_16: 'uint16',
+  INT_32: 'int32',
+  UINT_32: 'uint32',
+  INT_64: 'int64',
+  UINT_64: 'uint64',
+  FLOAT_32: 'float32',
+  FLOAT_64: 'float64',
+});
+
+
 module.exports = {
   DynamicLibrary,
   dlopen,
@@ -158,7 +185,9 @@ module.exports = {
   setUint64,
   setFloat32,
   setFloat64,
+  suffix,
   toString,
   toArrayBuffer,
   toBuffer,
+  types,
 };

test/ffi/test-ffi-module.js

@@ -105,9 +105,11 @@ test('ffi exports expected API surface', () => {
     'setUint32',
     'setUint64',
     'setUint8',
+    'suffix',
     'toArrayBuffer',
     'toBuffer',
     'toString',
+    'types',
   ];
 
   assert.deepStrictEqual(Object.keys(ffi).sort(), expected);
@@ -140,4 +142,35 @@ test('ffi exports expected API surface', () => {
   assert.strictEqual(typeof ffi.toString, 'function');
   assert.strictEqual(typeof ffi.toBuffer, 'function');
   assert.strictEqual(typeof ffi.toArrayBuffer, 'function');
+  assert.strictEqual(typeof ffi.types, 'object');
+});
+
+test('ffi.types exports canonical type constants', () => {
+  const ffi = require('node:ffi');
+  const expected = {
+    __proto__: null,
+    VOID: 'void',
+    POINTER: 'pointer',
+    BUFFER: 'buffer',
+    ARRAY_BUFFER: 'arraybuffer',
+    FUNCTION: 'function',
+    BOOL: 'bool',
+    CHAR: 'char',
+    STRING: 'string',
+    FLOAT: 'float',
+    DOUBLE: 'double',
+    INT_8: 'int8',
+    UINT_8: 'uint8',
+    INT_16: 'int16',
+    UINT_16: 'uint16',
+    INT_32: 'int32',
+    UINT_32: 'uint32',
+    INT_64: 'int64',
+    UINT_64: 'uint64',
+    FLOAT_32: 'float32',
+    FLOAT_64: 'float64',
+  };
+
+  assert.deepStrictEqual(ffi.types, expected);
+  assert.strictEqual(Object.isFrozen(ffi.types), true);
 });

tools/nix/non-v8-deps-mock.nix

@@ -56,6 +56,7 @@ symlinkJoin (finalAttrs: {
     configureFlags = [
       "--without-lief"
       "--without-sqlite"
+      "--without-ffi"
       "--without-ssl"
     ]
     ++ (lib.concatMap (sharedLibName: [