koffi 2.3.7 → 2.3.8

package/CHANGELOG.md

@@ -4,6 +4,14 @@
 
 ### Koffi 2.3
 
+#### Koffi 2.3.8
+
+**Main fixes:**
+
+- Disable non-ready union support
+- Simplify Windows stack allocation and drop NOACCESS and GUARD pages
+- Adjust Windows TEB SEH chain and GuaranteedStackBytes for Koffi calls
+
 #### Koffi 2.3.7
 
 **Main fixes:**

package/package.json

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

package/src/koffi/src/abi_arm64.cc

@@ -559,18 +559,24 @@ void CallData::Execute(const FunctionInfo *func)
     TEB *teb = GetTEB();
 
     // Restore previous stack limits at the end
-    RG_DEFER_C(base = teb->StackBase,
+    RG_DEFER_C(exception_list = teb->ExceptionList,
+               base = teb->StackBase,
                limit = teb->StackLimit,
-               dealloc = teb->DeallocationStack) {
+               dealloc = teb->DeallocationStack,
+               guaranteed = teb->GuaranteedStackBytes) {
+        teb->ExceptionList = exception_list;
         teb->StackBase = base;
         teb->StackLimit = limit;
         teb->DeallocationStack = dealloc;
+        teb->GuaranteedStackBytes = guaranteed;
     };
 
     // Adjust stack limits so SEH works correctly
+    teb->ExceptionList = (void *)-1; // EXCEPTION_CHAIN_END
     teb->StackBase = mem->stack0.end();
     teb->StackLimit = mem->stack0.ptr;
     teb->DeallocationStack = mem->stack0.ptr;
+    teb->GuaranteedStackBytes = 0;
 #endif
 
 #define PERFORM_CALL(Suffix) \

package/src/koffi/src/abi_x64_win.cc

@@ -221,18 +221,24 @@ void CallData::Execute(const FunctionInfo *func)
     TEB *teb = GetTEB();
 
     // Restore previous stack limits at the end
-    RG_DEFER_C(base = teb->StackBase,
+    RG_DEFER_C(exception_list = teb->ExceptionList,
+               base = teb->StackBase,
                limit = teb->StackLimit,
-               dealloc = teb->DeallocationStack) {
+               dealloc = teb->DeallocationStack,
+               guaranteed = teb->GuaranteedStackBytes) {
+        teb->ExceptionList = exception_list;
         teb->StackBase = base;
         teb->StackLimit = limit;
         teb->DeallocationStack = dealloc;
+        teb->GuaranteedStackBytes = guaranteed;
     };
 
     // Adjust stack limits so SEH works correctly
+    teb->ExceptionList = (void *)-1; // EXCEPTION_CHAIN_END
     teb->StackBase = mem->stack0.end();
     teb->StackLimit = mem->stack0.ptr;
     teb->DeallocationStack = mem->stack0.ptr;
+    teb->GuaranteedStackBytes = 0;
 
 #define PERFORM_CALL(Suffix) \
         ([&]() { \

package/src/koffi/src/abi_x86.cc

@@ -306,18 +306,24 @@ void CallData::Execute(const FunctionInfo *func)
     TEB *teb = GetTEB();
 
     // Restore previous stack limits at the end
-    RG_DEFER_C(base = teb->StackBase,
+    RG_DEFER_C(exception_list = teb->ExceptionList,
+               base = teb->StackBase,
                limit = teb->StackLimit,
-               dealloc = teb->DeallocationStack) {
+               dealloc = teb->DeallocationStack,
+               guaranteed = teb->GuaranteedStackBytes) {
+        teb->ExceptionList = exception_list;
         teb->StackBase = base;
         teb->StackLimit = limit;
         teb->DeallocationStack = dealloc;
+        teb->GuaranteedStackBytes = guaranteed;
     };
 
     // Adjust stack limits so SEH works correctly
+    teb->ExceptionList = (void *)-1; // EXCEPTION_CHAIN_END
     teb->StackBase = mem->stack0.end();
     teb->StackLimit = mem->stack0.ptr;
     teb->DeallocationStack = mem->stack0.ptr;
+    teb->GuaranteedStackBytes = 0;
 #endif
 
 #define PERFORM_CALL(Suffix) \

package/src/koffi/src/ffi.cc

@@ -1144,30 +1144,11 @@ static InstanceMemory *AllocateMemory(InstanceData *instance, Size stack_size, S
     stack_size = AlignLen(stack_size, Kibibytes(64));
 
 #if defined(_WIN32)
-    static const int PageSize = ([]() {
-        SYSTEM_INFO info = {};
-
-        GetNativeSystemInfo(&info);
-        RG_ASSERT(info.dwPageSize);
-
-        return (int)info.dwPageSize;
-    })();
-
     // Allocate stack memory
-    {
-        mem->stack.len = stack_size;
-        mem->stack.ptr = (uint8_t *)VirtualAlloc(nullptr, mem->stack.len + 2 * PageSize, MEM_RESERVE, PAGE_NOACCESS);
-
-        RG_CRITICAL(mem->stack.ptr, "Failed to allocate %1 of memory", mem->stack.len);
-
-        bool success = true;
-
-        success &= !!VirtualAlloc(mem->stack.ptr + 0 * PageSize, PageSize, MEM_COMMIT, PAGE_NOACCESS);
-        success &= !!VirtualAlloc(mem->stack.ptr + 1 * PageSize, PageSize, MEM_COMMIT, PAGE_READWRITE | PAGE_GUARD);
-        success &= !!VirtualAlloc(mem->stack.ptr + 2 * PageSize, mem->stack.len, MEM_COMMIT, PAGE_READWRITE);
+    mem->stack.len = stack_size;
+    mem->stack.ptr = (uint8_t *)VirtualAlloc(nullptr, mem->stack.len, MEM_RESERVE | MEM_COMMIT, PAGE_READWRITE);
 
-        RG_CRITICAL(success, "Cannot commit stack memory: %1", GetWin32ErrorString());
-    }
+    RG_CRITICAL(mem->stack.ptr, "Failed to allocate %1 of memory", mem->stack.len);
 #else
     mem->stack.len = stack_size;
     mem->stack.ptr = (uint8_t *)mmap(nullptr, mem->stack.len, PROT_READ | PROT_WRITE, MAP_PRIVATE | MAP_ANON | MAP_STACK, -1, 0);
@@ -2021,8 +2002,8 @@ static void SetExports(Napi::Env env, Func func)
 
     func("struct", Napi::Function::New(env, CreatePaddedStructType));
     func("pack", Napi::Function::New(env, CreatePackedStructType));
-    func("union", Napi::Function::New(env, CreateUnionType));
-    func("Union", Napi::Function::New(env, InstantiateUnion));
+    // func("union", Napi::Function::New(env, CreateUnionType));
+    // func("Union", Napi::Function::New(env, InstantiateUnion));
     func("opaque", Napi::Function::New(env, CreateOpaqueType));
     func("pointer", Napi::Function::New(env, CreatePointerType));
     func("array", Napi::Function::New(env, CreateArrayType));

package/src/koffi/src/index.d.ts

@@ -20,7 +20,7 @@ declare module 'koffi' {
 
     type PrimitiveKind = 'Void' | 'Bool' | 'Int8' | 'UInt8' | 'Int16' | 'Int16S' | 'UInt16' | 'UInt16S' |
                          'Int32' | 'Int32S' | 'UInt32' | 'UInt32S' | 'Int64' | 'Int64S' | 'UInt64' | 'UInt64S' |
-                         'String' | 'String16' | 'Pointer' | 'Record' | 'Union' | 'Array' | 'Float32' | 'Float64' |
+                         'String' | 'String16' | 'Pointer' | 'Record' /* | 'Union' */ | 'Array' | 'Float32' | 'Float64' |
                          'Prototype' | 'Callback';
     type ArrayHint = 'Array' | 'Typed' | 'String';
 
@@ -78,8 +78,8 @@ declare module 'koffi' {
     export function pack(name: string, def: Record<string, TypeSpecWithAlignment>): IKoffiCType;
     export function pack(def: Record<string, TypeSpecWithAlignment>): IKoffiCType;
 
-    export function union(name: string, def: Record<string, TypeSpecWithAlignment>): IKoffiCType;
-    export function union(def: Record<string, TypeSpecWithAlignment>): IKoffiCType;
+    // export function union(name: string, def: Record<string, TypeSpecWithAlignment>): IKoffiCType;
+    // export function union(def: Record<string, TypeSpecWithAlignment>): IKoffiCType;
 
     export function array(ref: TypeSpec, len: number, hint?: ArrayHint | null): IKoffiCType;
 

package/src/koffi/src/win32.hh

@@ -22,24 +22,30 @@ namespace RG {
 #if _WIN64
 
 struct TEB {
-    char _pad1[8];
+    void *ExceptionList;
     void *StackBase;
     void *StackLimit;
-    char _pad2[5216];
+    char _pad1[5216];
     void *DeallocationStack;
+    char _pad2[712];
+    uint32_t GuaranteedStackBytes;
 };
 RG_STATIC_ASSERT(RG_OFFSET_OF(TEB, DeallocationStack) == 0x1478);
+RG_STATIC_ASSERT(RG_OFFSET_OF(TEB, GuaranteedStackBytes) == 0x1748);
 
 #else
 
 struct TEB {
-    char _pad1[4];
+    void *ExceptionList;
     void *StackBase;
     void *StackLimit;
-    char _pad2[3584];
+    char _pad1[3584];
     void *DeallocationStack;
+    char _pad2[360];
+    uint32_t GuaranteedStackBytes;
 };
 RG_STATIC_ASSERT(RG_OFFSET_OF(TEB, DeallocationStack) == 0xE0C);
+RG_STATIC_ASSERT(RG_OFFSET_OF(TEB, GuaranteedStackBytes) == 0x0F78);
 
 #endif