koffi 2.3.6 → 2.3.8

package/CHANGELOG.md

@@ -4,6 +4,21 @@
 
 ### 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:**
+
+- Fix missing require in index.js ([@gastonFrecceroNapse](https://github.com/gastonFrecceroNapse))
+- Reduce NPM package bloat (from 65 MB to 20 MB) caused by changes in 2.3.6
+
 #### Koffi 2.3.6
 
 **Main changes:**

package/package.json

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

package/src/cnoke/cnoke.js

@@ -16,10 +16,9 @@
 'use strict';
 
 const fs = require('fs');
-const { Builder } = require('./src/index.js');
+const cnoke = require('./src/index.js');
 
 const VALID_COMMANDS = ['build', 'configure', 'clean'];
-const DEFAULT_MODE = 'RelWithDebInfo';
 
 main();
 
@@ -27,9 +26,6 @@ async function main() {
     let config = {};
     let command = 'build';
 
-    // Default options
-    config.mode = DEFAULT_MODE;
-
     // Parse options
     {
         let i = 2;
@@ -127,7 +123,7 @@ async function main() {
     }
 
     try {
-        let builder = new Builder(config);
+        let builder = new cnoke.Builder(config);
         await builder[command]();
     } catch (err) {
         console.error(err);
@@ -148,7 +144,7 @@ Options:
                                          (default: current working directory)
 
     -B, --config <CONFIG>                Change build type: RelWithDebInfo, Debug, Release
-                                         (default: ${DEFAULT_MODE})
+                                         (default: ${cnoke.DefaultOptions.mode})
     -D, --debug                          Shortcut for --config Debug
 
         --prebuild                       Use prebuilt binari if available

package/src/cnoke/src/builder.js

@@ -19,6 +19,10 @@ const path = require('path');
 const { spawnSync } = require('child_process');
 const tools = require('./tools.js');
 
+const DefaultOptions = {
+    mode: 'RelWithDebInfo'
+};
+
 function Builder(config = {}) {
     let self = this;
 
@@ -38,7 +42,7 @@ function Builder(config = {}) {
     let arch = config.arch;
     let toolset = config.toolset || null;
     let prefer_clang = config.prefer_clang || false;
-    let mode = config.mode;
+    let mode = config.mode || DefaultOptions.mode;
     let targets = config.targets || [];
     let verbose = config.verbose || false;
     let prebuild = config.prebuild || false;
@@ -49,8 +53,6 @@ function Builder(config = {}) {
         runtime_version = runtime_version.substr(1);
     if (arch == null)
         arch = tools.determine_arch();
-    if (mode == null)
-        throw new Error('Missing required mode setting');
 
     let cache_dir = get_cache_directory();
     let build_dir = config.build_dir;
@@ -447,5 +449,6 @@ function Builder(config = {}) {
 }
 
 module.exports = {
-    Builder
+    Builder,
+    DefaultOptions
 };

package/src/cnoke/src/index.js

@@ -11,10 +11,10 @@
 // You should have received a copy of the GNU Lesser General Public License
 // along with this program. If not, see https://www.gnu.org/licenses/.
 
-const { Builder } = require('./builder.js');
+const builder = require('./builder.js');
 const tools = require('./tools.js');
 
 module.exports = {
-    Builder,
+    ...builder,
     ...tools
 };

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);

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';
 

package/src/koffi/src/index.js

@@ -15,6 +15,7 @@
 
 const cnoke = require('../../cnoke/src/index.js');
 const util = require('util');
+const fs = require('fs');
 
 const pkg = (() => {
     try {

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
 

package/vendor/brotli/BUILD

@@ -1,144 +0,0 @@
-# Description:
-#   Brotli is a generic-purpose lossless compression algorithm.
-
-package(
-    default_visibility = ["//visibility:public"],
-)
-
-licenses(["notice"])  # MIT
-
-exports_files(["LICENSE"])
-
-config_setting(
-    name = "darwin",
-    values = {"cpu": "darwin"},
-    visibility = ["//visibility:public"],
-)
-
-config_setting(
-    name = "darwin_x86_64",
-    values = {"cpu": "darwin_x86_64"},
-    visibility = ["//visibility:public"],
-)
-
-config_setting(
-    name = "windows",
-    values = {"cpu": "x64_windows"},
-    visibility = ["//visibility:public"],
-)
-
-config_setting(
-    name = "windows_msvc",
-    values = {"cpu": "x64_windows_msvc"},
-    visibility = ["//visibility:public"],
-)
-
-config_setting(
-    name = "windows_msys",
-    values = {"cpu": "x64_windows_msys"},
-    visibility = ["//visibility:public"],
-)
-
-load(":compiler_config_setting.bzl", "create_msvc_config")
-
-create_msvc_config()
-
-STRICT_C_OPTIONS = select({
-    ":msvc": [],
-    "//conditions:default": [
-        "--pedantic-errors",
-        "-Wall",
-        "-Wconversion",
-        "-Werror",
-        "-Wextra",
-        "-Wlong-long",
-        "-Wmissing-declarations",
-        "-Wmissing-prototypes",
-        "-Wno-strict-aliasing",
-        "-Wshadow",
-        "-Wsign-compare",
-    ],
-})
-
-filegroup(
-    name = "public_headers",
-    srcs = glob(["c/include/brotli/*.h"]),
-)
-
-filegroup(
-    name = "common_headers",
-    srcs = glob(["c/common/*.h"]),
-)
-
-filegroup(
-    name = "common_sources",
-    srcs = glob(["c/common/*.c"]),
-)
-
-filegroup(
-    name = "dec_headers",
-    srcs = glob(["c/dec/*.h"]),
-)
-
-filegroup(
-    name = "dec_sources",
-    srcs = glob(["c/dec/*.c"]),
-)
-
-filegroup(
-    name = "enc_headers",
-    srcs = glob(["c/enc/*.h"]),
-)
-
-filegroup(
-    name = "enc_sources",
-    srcs = glob(["c/enc/*.c"]),
-)
-
-cc_library(
-    name = "brotli_inc",
-    hdrs = [":public_headers"],
-    copts = STRICT_C_OPTIONS,
-    strip_include_prefix = "c/include",
-)
-
-cc_library(
-    name = "brotlicommon",
-    srcs = [":common_sources"],
-    hdrs = [":common_headers"],
-    copts = STRICT_C_OPTIONS,
-    deps = [":brotli_inc"],
-)
-
-cc_library(
-    name = "brotlidec",
-    srcs = [":dec_sources"],
-    hdrs = [":dec_headers"],
-    copts = STRICT_C_OPTIONS,
-    deps = [":brotlicommon"],
-)
-
-cc_library(
-    name = "brotlienc",
-    srcs = [":enc_sources"],
-    hdrs = [":enc_headers"],
-    copts = STRICT_C_OPTIONS,
-    linkopts = ["-lm"],
-    deps = [":brotlicommon"],
-)
-
-cc_binary(
-    name = "brotli",
-    srcs = ["c/tools/brotli.c"],
-    copts = STRICT_C_OPTIONS,
-    linkstatic = 1,
-    deps = [
-        ":brotlidec",
-        ":brotlienc",
-    ],
-)
-
-filegroup(
-    name = "dictionary",
-    srcs = ["c/common/dictionary.bin"],
-)