koffi 2.1.0-beta.3 → 2.1.0

package/ChangeLog.md

@@ -2,7 +2,7 @@
 
 ## History
 
-### Koffi 2.1.0 (in beta)
+### Koffi 2.1.0
 
 **Main changes:**
 
@@ -10,6 +10,7 @@
 - Add [endian-sensitive integer types](types.md#endian-sensitive-types): `intX_le_t`, `intX_be_t`
 - Accept typed arrays for `void *` parameters
 - Introduce `koffi.opaque()` to replace `koffi.handle()` (which remains supported until Koffi 3.0)
+- Support JS Array and TypedArray to fill struct and array pointer members
 
 **Other changes:**
 

package/doc/benchmarks.md

@@ -10,8 +10,8 @@ Here is a quick overview of the execution time of Koffi calls on three benchmark
 
 <table style="margin: 0 auto;">
     <tr>
-        <td><a href="_static/perf_linux_20220628.png" target="_blank"><img src="_static/perf_linux_20220628.png" alt="Linux x86_64 performance" style="width: 350px;"/></a></td>
-        <td><a href="_static/perf_windows_20220628.png" target="_blank"><img src="_static/perf_windows_20220628.png" alt="Windows x86_64 performance" style="width: 350px;"/></a></td>
+        <td><a href="_static/perf_linux_20220812.png" target="_blank"><img src="_static/perf_linux_20220812.png" alt="Linux x86_64 performance" style="width: 350px;"/></a></td>
+        <td><a href="_static/perf_windows_20220812.png" target="_blank"><img src="_static/perf_windows_20220812.png" alt="Windows x86_64 performance" style="width: 350px;"/></a></td>
     </tr>
 </table>
 
@@ -31,9 +31,9 @@ This test is based around repeated calls to a simple standard C function atoi, a
 
 Benchmark     | Iteration time | Relative performance | Overhead
 ------------- | -------------- | -------------------- | --------
-rand_napi     | 644 ns         | x1.00                | (ref)
-rand_koffi    | 950 ns         | x0.68                | +48%
-rand_node_ffi | 30350 ns       | x0.02                | +4613%
+rand_napi     | 842 ns         | x1.00                | (ref)
+rand_koffi    | 1114 ns        | x0.76                | +32%
+rand_node_ffi | 44845 ns       | x0.02                | +5224%
 
 Because rand is a pretty small function, the FFI overhead is clearly visible.
 
@@ -43,9 +43,9 @@ This test is similar to the rand one, but it is based on atoi, which takes a str
 
 Benchmark     | Iteration time | Relative performance | Overhead
 ------------- | -------------- | -------------------- | --------
-atoi_napi     | 1104 ns        | x1.00                | (ref)
-atoi_koffi    | 1778 ns        | x0.62                | +61%
-atoi_node_ffi | 125300 ns      | x0.009               | +11250%
+atoi_napi     | 921 ns         | x1.00                | (ref)
+atoi_koffi    | 1357 ns        | x0.68                | +47%
+atoi_node_ffi | 152550 ns      | x0.006               | +16472%
 
 Because atoi is a pretty small function, the FFI overhead is clearly visible.
 
@@ -77,9 +77,9 @@ This test is based around repeated calls to a simple standard C function atoi, a
 
 Benchmark     | Iteration time | Relative performance | Overhead
 ------------- | -------------- | -------------------- | --------
-rand_napi     | 965 ns         | x1.00                | (ref)
-rand_koffi    | 1248 ns        | x0.77                | +29%
-rand_node_ffi | 41500 ns       | x0.02                | +4203%
+rand_napi     | 964 ns         | x1.00                | (ref)
+rand_koffi    | 1274 ns        | x0.76                | +32%
+rand_node_ffi | 42300 ns       | x0.02                | +4289%
 
 Because rand is a pretty small function, the FFI overhead is clearly visible.
 
@@ -91,9 +91,9 @@ The results below were measured on my x86_64 Windows machine (Intel® Core™ i5
 
 Benchmark     | Iteration time | Relative performance | Overhead
 ------------- | -------------- | -------------------- | --------
-atoi_napi     | 1393 ns        | x1.00                | (ref)
-atoi_koffi    | 2246 ns        | x0.62                | +61%
-atoi_node_ffi | 157550 ns      | x0.009               | +11210%
+atoi_napi     | 1415 ns        | x1.00                | (ref)
+atoi_koffi    | 2193 ns        | x0.65                | +55%
+atoi_node_ffi | 168300 ns      | x0.008               | +11792%
 
 Because atoi is a pretty small function, the FFI overhead is clearly visible.
 

package/doc/index.rst

@@ -1,5 +1,5 @@
-Koffi |version|
-===============
+Koffi
+=====
 
 Overview
 --------

package/doc/types.md

@@ -111,16 +111,6 @@ const A = koffi.struct('A', {
 });
 ```
 
-Koffi follows the C and ABI rules regarding struct alignment and padding.
-
-Once a struct is declared, you can use it by name (with a string, like you can do for primitive types) or through the value returned by the call to `koffi.struct()`. Only the latter is possible when declaring an anonymous struct.
-
-```js
-// The following two function declarations are equivalent, and declare a function taking an A value and returning A
-const Function1 = lib.func('A Function(A value)');
-const Function2 = lib.func('Function', A, [A]);
-```
-
 Koffi automatically follows the platform C ABI regarding alignment and padding. However, you can override these rules if needed with:
 
 - Pack all members without padding with `koffi.pack()` (instead of `koffi.struct()`)
@@ -133,13 +123,21 @@ const PackedStruct = koffi.pack('PackedStruct', {
     b: 'int16_t'
 });
 
-// This one is 18 bytes long, the second member has an alignment requirement of 16 bytes
+// This one is 10 bytes long, the second member has an alignment requirement of 8 bytes
 const BigStruct = koffi.struct('BigStruct', {
     a: 'int8_t',
-    b: [16, 'int16_t']
+    b: [8, 'int16_t']
 })
 ```
 
+Once a struct is declared, you can use it by name (with a string, like you can do for primitive types) or through the value returned by the call to `koffi.struct()`. Only the latter is possible when declaring an anonymous struct.
+
+```js
+// The following two function declarations are equivalent, and declare a function taking an A value and returning A
+const Function1 = lib.func('A Function(A value)');
+const Function2 = lib.func('Function', A, [A]);
+```
+
 ### Opaque types
 
 Many C libraries use some kind of object-oriented API, with a pair of functions dedicated to create and delete objects. An obvious example of this can be found in stdio.h, with the opaque `FILE *` pointer. You can open and close files with `fopen()` and `fclose()`, and manipule the opaque pointer with other functions such as `fread()` or `ftell()`.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "koffi",
-  "version": "2.1.0-beta.3",
-  "stable": "2.0.1",
+  "version": "2.1.0",
+  "stable": "2.1.0",
   "description": "Fast and simple C FFI (foreign function interface) for Node.js",
   "keywords": [
     "foreign",

package/qemu/registry/machines.json

@@ -178,7 +178,7 @@
         "qemu": {
             "binary": "qemu-system-x86_64",
             "arguments": ["-m", "3G", "-smp", 4, "-rtc", "clock=host,base=localtime", "-bios", "bios.bin", "-hda", "disk.qcow2", "-netdev", "user,id=mynet,hostfwd=tcp::22205-:22", "-device", "e1000,netdev=mynet", "-vga", "std", "-device", "qemu-xhci", "-device", "usb-tablet", "-vnc", "127.0.0.1:15"],
-            "version": 10,
+            "version": 11,
 
             "ssh_port": 22205,
             "vnc_port": 5915,
@@ -227,7 +227,7 @@
             "Windows x64": {
                 "directory": "C:/Users/windows/Desktop/luigi_x64",
                 "build": {
-                    "Build": "C:\\Node64\\node64.cmd node ../cnoke/cnoke.js -d test --prefer-clang"
+                    "Build": "C:\\Node64\\node64.cmd node ../cnoke/cnoke.js -d test"
                 },
                 "commands": {
                     "Test Sync": "C:\\Node64\\node64.cmd node test/sync.js",

package/qemu/registry/sha256sum.txt

@@ -1,7 +1,7 @@
-917df3320d778ddbaa5c5c7742bc4046bf803c36ed2b050f30844ed206783469 *qemu/windows_x64/VERSION
+25d4f2a86deb5e2574bb3210b67bb24fcc4afb19f93a7b65a057daa874a9d18e *qemu/windows_x64/VERSION
 0a40f87b2a038522e55318a0abde60403bb13a5e81a7a0966a9a736e65d4ae46 *qemu/windows_x64/install.sh
 f8c9a1638a3fc2cdd214f2cbcad6fee0e3b2c9383942bbd49b3915bb4c3da102 *qemu/windows_x64/bios.bin
-60b1fea3f0ec2c27b410a45b659deb53bb8d5367989207a8850fdfcbc2d83eb1 *qemu/windows_x64/disk.qcow2
+62a6f3210acf3c9f8d1c5036998da8cecd24e59b75bb2fd6897e990f83546eec *qemu/windows_x64/disk.qcow2
 1121cfccd5913f0a63fec40a6ffd44ea64f9dc135c66634ba001d10bcf4302a2 *qemu/debian_x64/VERSION
 ba418d2d602981fe324ae7a1a608b0f2d8d7c6113d03a429cc402e24ddc81311 *qemu/debian_x64/vmlinuz-5.10.0-12-amd64
 4d44622e8ce058017c08051d694b8e5afe9ff406b6ad91c17ebc4ec43d205c42 *qemu/debian_x64/install.sh

package/src/abi_arm32.cc

@@ -278,7 +278,7 @@ bool CallData::Prepare(const Napi::CallbackInfo &info)
 #define PUSH_INTEGER_32(CType) \
         do { \
             if (RG_UNLIKELY(!value.IsNumber() && !value.IsBigInt())) { \
-                ThrowError<Napi::TypeError>(env, "Unexpected %1 value for argument %2, expected number", GetValueType(instance, value), param.offset + 1); \
+                ThrowError<Napi::TypeError>(env, "Unexpected %1 value, expected number", GetValueType(instance, value)); \
                 return false; \
             } \
              \
@@ -288,7 +288,7 @@ bool CallData::Prepare(const Napi::CallbackInfo &info)
 #define PUSH_INTEGER_32_SWAP(CType) \
         do { \
             if (RG_UNLIKELY(!value.IsNumber() && !value.IsBigInt())) { \
-                ThrowError<Napi::TypeError>(env, "Unexpected %1 value for argument %2, expected number", GetValueType(instance, value), param.offset + 1); \
+                ThrowError<Napi::TypeError>(env, "Unexpected %1 value, expected number", GetValueType(instance, value)); \
                 return false; \
             } \
              \
@@ -298,7 +298,7 @@ bool CallData::Prepare(const Napi::CallbackInfo &info)
 #define PUSH_INTEGER_64(CType) \
         do { \
             if (RG_UNLIKELY(!value.IsNumber() && !value.IsBigInt())) { \
-                ThrowError<Napi::TypeError>(env, "Unexpected %1 value for argument %2, expected number", GetValueType(instance, value), param.offset + 1); \
+                ThrowError<Napi::TypeError>(env, "Unexpected %1 value, expected number", GetValueType(instance, value)); \
                 return false; \
             } \
              \
@@ -317,7 +317,7 @@ bool CallData::Prepare(const Napi::CallbackInfo &info)
 #define PUSH_INTEGER_64_SWAP(CType) \
         do { \
             if (RG_UNLIKELY(!value.IsNumber() && !value.IsBigInt())) { \
-                ThrowError<Napi::TypeError>(env, "Unexpected %1 value for argument %2, expected number", GetValueType(instance, value), param.offset + 1); \
+                ThrowError<Napi::TypeError>(env, "Unexpected %1 value, expected number", GetValueType(instance, value)); \
                 return false; \
             } \
              \
@@ -346,7 +346,7 @@ bool CallData::Prepare(const Napi::CallbackInfo &info)
 
             case PrimitiveKind::Bool: {
                 if (RG_UNLIKELY(!value.IsBoolean())) {
-                    ThrowError<Napi::TypeError>(env, "Unexpected %1 value for argument %2, expected boolean", GetValueType(instance, value), param.offset + 1);
+                    ThrowError<Napi::TypeError>(env, "Unexpected %1 value, expected boolean", GetValueType(instance, value));
                     return false;
                 }
 
@@ -369,44 +369,28 @@ bool CallData::Prepare(const Napi::CallbackInfo &info)
             case PrimitiveKind::UInt64S: { PUSH_INTEGER_64_SWAP(uint64_t); } break;
             case PrimitiveKind::String: {
                 const char *str;
-                if (RG_LIKELY(value.IsString())) {
-                    str = PushString(value);
-                    if (RG_UNLIKELY(!str))
-                        return false;
-                } else if (IsNullOrUndefined(value)) {
-                    str = nullptr;
-                } else {
-                    ThrowError<Napi::TypeError>(env, "Unexpected %1 value for argument %2, expected string", GetValueType(instance, value), param.offset + 1);
+                if (RG_UNLIKELY(!PushString(value, &str)))
                     return false;
-                }
 
                 *(const char **)((param.gpr_count ? gpr_ptr : args_ptr)++) = str;
             } break;
             case PrimitiveKind::String16: {
                 const char16_t *str16;
-                if (RG_LIKELY(value.IsString())) {
-                    str16 = PushString16(value);
-                    if (RG_UNLIKELY(!str16))
-                        return false;
-                } else if (IsNullOrUndefined(value)) {
-                    str16 = nullptr;
-                } else {
-                    ThrowError<Napi::TypeError>(env, "Unexpected %1 value for argument %2, expected string", GetValueType(instance, value), param.offset + 1);
+                if (RG_UNLIKELY(!PushString16(value, &str16)))
                     return false;
-                }
 
                 *(const char16_t **)((param.gpr_count ? gpr_ptr : args_ptr)++) = str16;
             } break;
             case PrimitiveKind::Pointer: {
                 void *ptr;
-                if (RG_UNLIKELY(!PushPointer(value, param, &ptr)))
+                if (RG_UNLIKELY(!PushPointer(value, param.type, param.directions, &ptr)))
                     return false;
 
                 *(void **)((param.gpr_count ? gpr_ptr : args_ptr)++) = ptr;
             } break;
             case PrimitiveKind::Record: {
                 if (RG_UNLIKELY(!IsObject(value))) {
-                    ThrowError<Napi::TypeError>(env, "Unexpected %1 value for argument %2, expected object", GetValueType(instance, value), param.offset + 1);
+                    ThrowError<Napi::TypeError>(env, "Unexpected %1 value, expected object", GetValueType(instance, value));
                     return false;
                 }
 
@@ -439,7 +423,7 @@ bool CallData::Prepare(const Napi::CallbackInfo &info)
             case PrimitiveKind::Array: { RG_UNREACHABLE(); } break;
             case PrimitiveKind::Float32: {
                 if (RG_UNLIKELY(!value.IsNumber() && !value.IsBigInt())) {
-                    ThrowError<Napi::TypeError>(env, "Unexpected %1 value for argument %2, expected number", GetValueType(instance, value), param.offset + 1);
+                    ThrowError<Napi::TypeError>(env, "Unexpected %1 value, expected number", GetValueType(instance, value));
                     return false;
                 }
 
@@ -455,7 +439,7 @@ bool CallData::Prepare(const Napi::CallbackInfo &info)
             } break;
             case PrimitiveKind::Float64: {
                 if (RG_UNLIKELY(!value.IsNumber() && !value.IsBigInt())) {
-                    ThrowError<Napi::TypeError>(env, "Unexpected %1 value for argument %2, expected number", GetValueType(instance, value), param.offset + 1);
+                    ThrowError<Napi::TypeError>(env, "Unexpected %1 value, expected number", GetValueType(instance, value));
                     return false;
                 }
 
@@ -488,7 +472,7 @@ bool CallData::Prepare(const Napi::CallbackInfo &info)
                 } else if (IsNullOrUndefined(value)) {
                     ptr = nullptr;
                 } else {
-                    ThrowError<Napi::TypeError>(env, "Unexpected %1 value for argument %2, expected %3", GetValueType(instance, value), param.offset + 1, param.type->name);
+                    ThrowError<Napi::TypeError>(env, "Unexpected %1 value, expected %2", GetValueType(instance, value), param.type->name);
                     return false;
                 }
 
@@ -896,7 +880,7 @@ void CallData::Relay(Size idx, uint8_t *own_sp, uint8_t *caller_sp, BackRegister
 #define RETURN_INTEGER_32_SWAP(CType) \
         do { \
             if (RG_UNLIKELY(!value.IsNumber() && !value.IsBigInt())) { \
-                ThrowError<Napi::TypeError>(env, "Unexpected %1 value for return value, expected number", GetValueType(instance, value)); \
+                ThrowError<Napi::TypeError>(env, "Unexpected %1 value, expected number", GetValueType(instance, value)); \
                 return; \
             } \
              \
@@ -906,7 +890,7 @@ void CallData::Relay(Size idx, uint8_t *own_sp, uint8_t *caller_sp, BackRegister
 #define RETURN_INTEGER_64(CType) \
         do { \
             if (RG_UNLIKELY(!value.IsNumber() && !value.IsBigInt())) { \
-                ThrowError<Napi::TypeError>(env, "Unexpected %1 value for return value, expected number", GetValueType(instance, value)); \
+                ThrowError<Napi::TypeError>(env, "Unexpected %1 value, expected number", GetValueType(instance, value)); \
                 return; \
             } \
              \
@@ -918,7 +902,7 @@ void CallData::Relay(Size idx, uint8_t *own_sp, uint8_t *caller_sp, BackRegister
 #define RETURN_INTEGER_64_SWAP(CType) \
         do { \
             if (RG_UNLIKELY(!value.IsNumber() && !value.IsBigInt())) { \
-                ThrowError<Napi::TypeError>(env, "Unexpected %1 value for return value, expected number", GetValueType(instance, value)); \
+                ThrowError<Napi::TypeError>(env, "Unexpected %1 value, expected number", GetValueType(instance, value)); \
                 return; \
             } \
              \
@@ -933,7 +917,7 @@ void CallData::Relay(Size idx, uint8_t *own_sp, uint8_t *caller_sp, BackRegister
         case PrimitiveKind::Void: {} break;
         case PrimitiveKind::Bool: {
             if (RG_UNLIKELY(!value.IsBoolean())) {
-                ThrowError<Napi::TypeError>(env, "Unexpected %1 value for return value, expected boolean", GetValueType(instance, value));
+                ThrowError<Napi::TypeError>(env, "Unexpected %1 value, expected boolean", GetValueType(instance, value));
                 return;
             }
 
@@ -956,31 +940,15 @@ void CallData::Relay(Size idx, uint8_t *own_sp, uint8_t *caller_sp, BackRegister
         case PrimitiveKind::UInt64S: { RETURN_INTEGER_64_SWAP(uint64_t); } break;
         case PrimitiveKind::String: {
             const char *str;
-            if (RG_LIKELY(value.IsString())) {
-                str = PushString(value);
-                if (RG_UNLIKELY(!str))
-                    return;
-            } else if (IsNullOrUndefined(value)) {
-                str = nullptr;
-            } else {
-                ThrowError<Napi::TypeError>(env, "Unexpected %1 value for return value, expected string", GetValueType(instance, value));
+            if (RG_UNLIKELY(!PushString(value, &str)))
                 return;
-            }
 
             out_reg->r0 = (uint32_t)str;
         } break;
         case PrimitiveKind::String16: {
             const char16_t *str16;
-            if (RG_LIKELY(value.IsString())) {
-                str16 = PushString16(value);
-                if (RG_UNLIKELY(!str16))
-                    return;
-            } else if (IsNullOrUndefined(value)) {
-                str16 = nullptr;
-            } else {
-                ThrowError<Napi::TypeError>(env, "Unexpected %1 value for return value, expected string", GetValueType(instance, value));
+            if (RG_UNLIKELY(!PushString16(value, &str16)))
                 return;
-            }
 
             out_reg->r0 = (uint32_t)str16;
         } break;
@@ -999,7 +967,7 @@ void CallData::Relay(Size idx, uint8_t *own_sp, uint8_t *caller_sp, BackRegister
             } else if (IsNullOrUndefined(value)) {
                 ptr = nullptr;
             } else {
-                ThrowError<Napi::TypeError>(env, "Unexpected %1 value for return value, expected %2", GetValueType(instance, value), type->name);
+                ThrowError<Napi::TypeError>(env, "Unexpected %1 value, expected %2", GetValueType(instance, value), type->name);
                 return;
             }
 
@@ -1007,7 +975,7 @@ void CallData::Relay(Size idx, uint8_t *own_sp, uint8_t *caller_sp, BackRegister
         } break;
         case PrimitiveKind::Record: {
             if (RG_UNLIKELY(!IsObject(value))) {
-                ThrowError<Napi::TypeError>(env, "Unexpected %1 value for return value, expected object", GetValueType(instance, value));
+                ThrowError<Napi::TypeError>(env, "Unexpected %1 value, expected object", GetValueType(instance, value));
                 return;
             }
 
@@ -1026,7 +994,7 @@ void CallData::Relay(Size idx, uint8_t *own_sp, uint8_t *caller_sp, BackRegister
         case PrimitiveKind::Array: { RG_UNREACHABLE(); } break;
         case PrimitiveKind::Float32: {
             if (RG_UNLIKELY(!value.IsNumber() && !value.IsBigInt())) {
-                ThrowError<Napi::TypeError>(env, "Unexpected %1 value for return value, expected number", GetValueType(instance, value));
+                ThrowError<Napi::TypeError>(env, "Unexpected %1 value, expected number", GetValueType(instance, value));
                 return;
             }
 
@@ -1039,7 +1007,7 @@ void CallData::Relay(Size idx, uint8_t *own_sp, uint8_t *caller_sp, BackRegister
         } break;
         case PrimitiveKind::Float64: {
             if (RG_UNLIKELY(!value.IsNumber() && !value.IsBigInt())) {
-                ThrowError<Napi::TypeError>(env, "Unexpected %1 value for return value, expected number", GetValueType(instance, value));
+                ThrowError<Napi::TypeError>(env, "Unexpected %1 value, expected number", GetValueType(instance, value));
                 return;
             }
 
@@ -1064,7 +1032,7 @@ void CallData::Relay(Size idx, uint8_t *own_sp, uint8_t *caller_sp, BackRegister
             } else if (IsNullOrUndefined(value)) {
                 ptr = nullptr;
             } else {
-                ThrowError<Napi::TypeError>(env, "Unexpected %1 value for return value, expected %2", GetValueType(instance, value), type->name);
+                ThrowError<Napi::TypeError>(env, "Unexpected %1 value, expected %2", GetValueType(instance, value), type->name);
                 return;
             }