koffi 2.8.6 → 2.8.8

package/CHANGELOG.md

@@ -4,6 +4,14 @@
 
 ### Koffi 2.8
 
+#### Koffi 2.8.8 (2024-04-26)
+
+- Support use of buffers with mismatched size (truncation or zero-filling)
+
+#### Koffi 2.8.7 (2024-04-23)
+
+- Improve compatibility with SEHOP on Windows ([@longhun12346](https://github.com/longhun12346))
+
 #### Koffi 2.8.6 (2024-04-12)
 
 - Support [loading library](functions.md#loading-options) with RTLD_DEEPBIND where supported

package/doc/contribute.md

@@ -60,15 +60,7 @@ Once Koffi is built, you can build the tests and run them with the following com
 cd src/koffi/test
 node ../../cnoke/cnoke.js
 
-node sync.js # Run synchronous unit tests
-node async.js # Run asynchronous unit tests
-node callbacks.js # Run callback unit tests
-node union.js # Run union unit tests
-node posix.js # Run POSIX-specific unit tests (not for Windows)
-node win32.js # Run Windows-specific unit tests (only on Windows)
-
-node sqlite.js # Run SQLite integration tests
-node raylib.js # Run Raylib integration tests
+node test.js
 ```
 
 ### On virtual machines
@@ -153,3 +145,5 @@ Some platforms are emulated so this can take a few minutes until the pre-built b
 Koffi is programmed in a mix of C++ and assembly code (architecture-specific code). It uses [node-addon-api](https://github.com/nodejs/node-addon-api) (C++ N-API wrapper) to interact with Node.js.
 
 My personal preference goes to a rather C-like C++ style, with careful use of templates (mainly for containers) and little object-oriented programming. I strongly prefer tagged unions and code locality over inheritance and virtual methods. Exceptions are disabled.
+
+Find more information about code style in the [monorepository README](https://github.com/Koromix/rygel/?tab=readme-ov-file#c-flavor) file.

package/index.js

@@ -378,8 +378,8 @@ var require_package = __commonJS({
   "build/dist/src/koffi/package.json"(exports2, module2) {
     module2.exports = {
       name: "koffi",
-      version: "2.8.6",
-      stable: "2.8.6",
+      version: "2.8.8",
+      stable: "2.8.8",
       description: "Fast and simple C FFI (foreign function interface) for Node.js",
       keywords: [
         "foreign",

package/indirect.js

@@ -378,8 +378,8 @@ var require_package = __commonJS({
   "build/dist/src/koffi/package.json"(exports2, module2) {
     module2.exports = {
       name: "koffi",
-      version: "2.8.6",
-      stable: "2.8.6",
+      version: "2.8.8",
+      stable: "2.8.8",
       description: "Fast and simple C FFI (foreign function interface) for Node.js",
       keywords: [
         "foreign",

package/package.json

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

package/src/koffi/src/abi_x64_win.cc

@@ -233,12 +233,14 @@ void CallData::Execute(const FunctionInfo *func, void *native)
                base = teb->StackBase,
                limit = teb->StackLimit,
                dealloc = teb->DeallocationStack,
-               guaranteed = teb->GuaranteedStackBytes) {
+               guaranteed = teb->GuaranteedStackBytes,
+               stfs = teb->SameTebFlags) {
         teb->ExceptionList = exception_list;
         teb->StackBase = base;
         teb->StackLimit = limit;
         teb->DeallocationStack = dealloc;
         teb->GuaranteedStackBytes = guaranteed;
+        teb->SameTebFlags = stfs;
 
         instance->last_error = teb->LastErrorValue;
     };
@@ -249,6 +251,7 @@ void CallData::Execute(const FunctionInfo *func, void *native)
     teb->StackLimit = mem->stack0.ptr;
     teb->DeallocationStack = mem->stack0.ptr;
     teb->GuaranteedStackBytes = 0;
+    teb->SameTebFlags &= ~0x200;
 
     teb->LastErrorValue = instance->last_error;
 

package/src/koffi/src/abi_x86.cc

@@ -330,12 +330,14 @@ void CallData::Execute(const FunctionInfo *func, void *native)
                base = teb->StackBase,
                limit = teb->StackLimit,
                dealloc = teb->DeallocationStack,
-               guaranteed = teb->GuaranteedStackBytes) {
+               guaranteed = teb->GuaranteedStackBytes,
+               stfs = teb->SameTebFlags) {
         teb->ExceptionList = exception_list;
         teb->StackBase = base;
         teb->StackLimit = limit;
         teb->DeallocationStack = dealloc;
         teb->GuaranteedStackBytes = guaranteed;
+        teb->SameTebFlags = stfs;
 
         instance->last_error = teb->LastErrorValue;
     };
@@ -346,6 +348,7 @@ void CallData::Execute(const FunctionInfo *func, void *native)
     teb->StackLimit = mem->stack0.ptr;
     teb->DeallocationStack = mem->stack0.ptr;
     teb->GuaranteedStackBytes = 0;
+    teb->SameTebFlags &= ~0x200;
 
     teb->LastErrorValue = instance->last_error;
 #endif

package/src/koffi/src/call.cc

@@ -593,9 +593,7 @@ bool CallData::PushObject(Napi::Object obj, const TypeInfo *type, uint8_t *origi
                         return false;
                 } else if (IsRawBuffer(value)) {
                     Span<const uint8_t> buffer = GetRawBuffer(value);
-
-                    if (!PushBuffer(buffer, member.type->size, member.type, dest))
-                        return false;
+                    PushBuffer(buffer, member.type->size, member.type, dest);
                 } else if (value.IsString()) {
                     if (!PushStringArray(value, member.type, dest))
                         return false;
@@ -830,9 +828,7 @@ bool CallData::PushNormalArray(Napi::Array array, Size len, const TypeInfo *type
                         return false;
                 } else if (IsRawBuffer(value)) {
                     Span<const uint8_t> buffer = GetRawBuffer(value);
-
-                    if (!PushBuffer(buffer, ref->size, ref, dest))
-                        return false;
+                    PushBuffer(buffer, ref->size, ref, dest);
                 } else if (value.IsString()) {
                     if (!PushStringArray(value, ref, dest))
                         return false;
@@ -896,15 +892,13 @@ bool CallData::PushNormalArray(Napi::Array array, Size len, const TypeInfo *type
     return true;
 }
 
-bool CallData::PushBuffer(Span<const uint8_t> buffer, Size size, const TypeInfo *type, uint8_t *origin)
+void CallData::PushBuffer(Span<const uint8_t> buffer, Size size, const TypeInfo *type, uint8_t *origin)
 {
-    if (buffer.len != size) [[unlikely]] {
-        ThrowError<Napi::Error>(env, "Expected array or buffer of size %1, got %2", size, buffer.len);
-        return false;
-    }
+    buffer.len = std::min(buffer.len, size);
 
-    // Go fast yeaaaah :)
+    // Go fast brrrrrrr :)
     memcpy_safe(origin, buffer.ptr, (size_t)buffer.len);
+    memset_safe(origin + buffer.len, 0, (size_t)(size - buffer.len));
 
 #define SWAP(CType) \
         do { \
@@ -929,8 +923,6 @@ bool CallData::PushBuffer(Span<const uint8_t> buffer, Size size, const TypeInfo
     }
 
 #undef SWAP
-
-    return true;
 }
 
 bool CallData::PushStringArray(Napi::Value obj, const TypeInfo *type, uint8_t *origin)

package/src/koffi/src/call.hh

@@ -119,7 +119,7 @@ public:
     Size PushString16Value(Napi::Value value, const char16_t **out_str16);
     bool PushObject(Napi::Object obj, const TypeInfo *type, uint8_t *origin);
     bool PushNormalArray(Napi::Array array, Size len, const TypeInfo *type, uint8_t *origin);
-    bool PushBuffer(Span<const uint8_t> buffer, Size size, const TypeInfo *type, uint8_t *origin);
+    void PushBuffer(Span<const uint8_t> buffer, Size size, const TypeInfo *type, uint8_t *origin);
     bool PushStringArray(Napi::Value value, const TypeInfo *type, uint8_t *origin);
     bool PushPointer(Napi::Value value, const TypeInfo *type, int directions, void **out_ptr);
     Size PushIndirectString(Napi::Array array, const TypeInfo *ref, uint8_t **out_ptr);

package/src/koffi/src/util.cc

@@ -1446,9 +1446,7 @@ bool Encode(Napi::Env env, uint8_t *origin, Napi::Value value, const TypeInfo *t
                     return false;
             } else if (IsRawBuffer(value)) {
                 Span<const uint8_t> buffer = GetRawBuffer(value);
-
-                if (!call.PushBuffer(buffer, type->size, type, origin))
-                    return false;
+                call.PushBuffer(buffer, type->size, type, origin);
             } else if (value.IsString()) {
                 if (!call.PushStringArray(value, type, origin))
                     return false;

package/src/koffi/src/win32.hh

@@ -79,9 +79,12 @@ struct TEB {
     void *DeallocationStack;
     char _pad3[712];
     uint32_t GuaranteedStackBytes;
+    char _pad4[162];
+    uint16_t SameTebFlags;
 };
 static_assert(RG_OFFSET_OF(TEB, DeallocationStack) == 0x1478);
 static_assert(RG_OFFSET_OF(TEB, GuaranteedStackBytes) == 0x1748);
+static_assert(RG_OFFSET_OF(TEB, SameTebFlags) == 0x17EE);
 
 #else
 
@@ -95,9 +98,12 @@ struct TEB {
     void *DeallocationStack;
     char _pad3[360];
     uint32_t GuaranteedStackBytes;
+    char _pad4[78];
+    uint16_t SameTebFlags;
 };
 static_assert(RG_OFFSET_OF(TEB, DeallocationStack) == 0xE0C);
 static_assert(RG_OFFSET_OF(TEB, GuaranteedStackBytes) == 0x0F78);
+static_assert(RG_OFFSET_OF(TEB, SameTebFlags) == 0xFCA);
 
 #endif