koffi 2.5.20 → 2.5.21-beta.1

package/doc/contribute.md

@@ -127,6 +127,18 @@ Each machine is configured to run a VNC server available locally, which you can
 node qemu.js info debian_x64
 ```
 
+## Making a release
+
+First, change the version numbers in `package.json`. Then publish a new release with the following commands:
+
+```sh
+node qemu.js test
+node qemu.js dist
+
+cd build/dist
+npm publish
+```
+
 ## Code style
 
 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.

package/package.json

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

package/src/index.js

@@ -378,7 +378,7 @@ var require_package = __commonJS({
   "build/dist/src/koffi/package.json"(exports2, module2) {
     module2.exports = {
       name: "koffi",
-      version: "2.5.20",
+      version: "2.5.21-beta.1",
       stable: "2.5.20",
       description: "Fast and simple C FFI (foreign function interface) for Node.js",
       keywords: [
@@ -413,6 +413,7 @@ var require_package = __commonJS({
         chalk: "^4.1.2",
         esbuild: "^0.19.2",
         "ffi-napi": "^4.0.3",
+        "ffi-rs": "^1.0.12",
         minimatch: "^5.0.1",
         "node-ssh": "^12.0.3",
         raylib: "^0.9.2",

package/src/koffi/CMakeLists.txt

@@ -66,6 +66,7 @@ set(KOFFI_SRC
     src/ffi.cc
     src/parser.cc
     src/util.cc
+    src/win32.cc
     ../../src/core/libcc/libcc.cc
 )
 if(CMAKE_SIZEOF_VOID_P EQUAL 8)

package/src/koffi/src/ffi.cc

@@ -1568,6 +1568,32 @@ static Napi::Value UnloadLibrary(const Napi::CallbackInfo &info)
     return env.Undefined();
 }
 
+#ifdef _WIN32
+static HANDLE LoadWindowsLibrary(Napi::Env env, const char16_t *filename)
+{
+    HANDLE module = LoadLibraryW((LPCWSTR)filename);
+
+    if (!module) {
+        if (GetLastError() == ERROR_BAD_EXE_FORMAT) {
+            int process = GetSelfMachine();
+            int dll = GetDllMachine(filename);
+
+            if (process >= 0 && dll >= 0 && dll != process) {
+                ThrowError<Napi::Error>(env, "Cannot load '%1' DLL in '%2' process",
+                                        WindowsMachineNames.FindValue(dll, "Unknown"),
+                                        WindowsMachineNames.FindValue(process, "Unknown"));
+                return nullptr;
+            }
+        }
+
+        ThrowError<Napi::Error>(env, "Failed to load shared library: %1", GetWin32ErrorString());
+        return nullptr;
+    }
+
+    return module;
+}
+#endif
+
 static Napi::Value LoadSharedLibrary(const Napi::CallbackInfo &info)
 {
     Napi::Env env = info.Env();
@@ -1592,12 +1618,10 @@ static Napi::Value LoadSharedLibrary(const Napi::CallbackInfo &info)
 #ifdef _WIN32
     if (info[0].IsString()) {
         std::u16string filename = info[0].As<Napi::String>();
-        module = LoadLibraryW((LPCWSTR)filename.c_str());
+        module = LoadWindowsLibrary(env, filename.c_str());
 
-        if (!module) {
-            ThrowError<Napi::Error>(env, "Failed to load shared library: %1", GetWin32ErrorString());
+        if (!module)
             return env.Null();
-        }
     } else {
         module = GetModuleHandle(nullptr);
         RG_ASSERT(module);

package/src/koffi/src/win32.cc

@@ -0,0 +1,155 @@
+// Copyright 2023 Niels Martignène <niels.martignene@protonmail.com>
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy of
+// this software and associated documentation files (the “Software”), to deal in 
+// the Software without restriction, including without limitation the rights to use,
+// copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
+// Software, and to permit persons to whom the Software is furnished to do so,
+// subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
+// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+// OTHER DEALINGS IN THE SOFTWARE.
+
+#ifdef _WIN32
+
+#include "win32.hh"
+
+#ifndef NOMINMAX
+    #define NOMINMAX
+#endif
+#ifndef WIN32_LEAN_AND_MEAN
+    #define WIN32_LEAN_AND_MEAN
+#endif
+#include <windows.h>
+#include <ntsecapi.h>
+#include <processthreadsapi.h>
+
+namespace RG {
+
+const HashMap<int, const char *> WindowsMachineNames = {
+    { 0x184, "Alpha AXP, 32-bit" },
+    { 0x284, "Alpha 64" },
+    { 0x1d3, "Matsushita AM33" },
+    { 0x8664, "AMD x64" },
+    { 0x1c0, "ARM little endian" },
+    { 0xaa64, "ARM64 little endian" },
+    { 0x1c4, "ARM Thumb-2 little endian" },
+    { 0x284, "AXP 64" },
+    { 0xebc, "EFI byte code" },
+    { 0x14c, "Intel 386+" },
+    { 0x200, "Intel Itanium" },
+    { 0x6232, "LoongArch 32-bit" },
+    { 0x6264, "LoongArch 64-bit" },
+    { 0x9041, "Mitsubishi M32R little endian" },
+    { 0x266, "MIPS16" },
+    { 0x366, "MIPS with FPU" },
+    { 0x466, "MIPS16 with FPU" },
+    { 0x1f0, "Power PC little endian" },
+    { 0x1f1, "Power PC with FP support" },
+    { 0x166, "MIPS little endian" },
+    { 0x5032, "RISC-V 32-bit" },
+    { 0x5064, "RISC-V 64-bit" },
+    { 0x5128, "RISC-V 128-bit" },
+    { 0x1a2, "Hitachi SH3" },
+    { 0x1a3, "Hitachi SH3 DSP" },
+    { 0x1a6, "Hitachi SH4" },
+    { 0x1a8, "Hitachi SH5" },
+    { 0x1c2, "Thumb" },
+    { 0x169, "MIPS little-endian WCE v2" }
+};
+
+// Fails silently on purpose
+static bool ReadAt(HANDLE h, int32_t offset, void *buf, int len)
+{
+    OVERLAPPED ov = {};
+    DWORD read;
+
+    ov.Offset = offset & 0x7FFFFFFFu;
+
+    if (offset < 0)
+        return false;
+    if (!ReadFile(h, buf, (DWORD)len, &read, &ov))
+        return false;
+    if (read != len)
+        return false;
+
+    return true;
+}
+
+static int GetFileMachine(HANDLE h, bool check_dll)
+{
+    PE_DOS_HEADER dos = {};
+    PE_NT_HEADERS nt = {};
+
+    if (!ReadAt(h, 0, &dos, RG_SIZE(dos)))
+        goto generic;
+    if (!ReadAt(h, dos.e_lfanew, &nt, RG_SIZE(nt)))
+        goto generic;
+
+    if (dos.e_magic != 0x5A4D) // MZ
+        goto generic;
+    if (nt.Signature != 0x00004550) // PE\0\0
+        goto generic;
+    if (check_dll && !(nt.FileHeader.Characteristics & IMAGE_FILE_DLL))
+        goto generic;
+
+    return (int)nt.FileHeader.Machine;
+
+generic:
+    LogError("Invalid or forbidden %1 file: %2", check_dll ? "DLL" : "executable", GetWin32ErrorString());
+    return -1;
+}
+
+int GetSelfMachine()
+{
+    const char *filename = GetApplicationExecutable();
+
+    HANDLE h;
+    if (IsWin32Utf8()) {
+        h = CreateFileA(filename, GENERIC_READ,
+                        FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
+                        nullptr, OPEN_EXISTING, 0, nullptr);
+    } else {
+        wchar_t filename_w[4096];
+        if (ConvertUtf8ToWin32Wide(filename, filename_w) < 0)
+            return -1;
+
+        h = CreateFileW(filename_w, GENERIC_READ,
+                        FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
+                        nullptr, OPEN_EXISTING, 0, nullptr);
+    }
+    if (h == INVALID_HANDLE_VALUE) {
+        LogError("Cannot open '%1': %2", filename, GetWin32ErrorString());
+        return -1;
+    }
+    RG_DEFER { CloseHandle(h); };
+
+    return GetFileMachine(h, false);
+}
+
+int GetDllMachine(const char16_t *filename)
+{
+    HANDLE h = CreateFileW((LPCWSTR)filename, GENERIC_READ,
+                           FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
+                           nullptr, OPEN_EXISTING, 0, nullptr);
+    if (h == INVALID_HANDLE_VALUE) {
+        LogError("Cannot open '%1': %2", filename, GetWin32ErrorString());
+        return -1;
+    }
+    RG_DEFER { CloseHandle(h); };
+
+    return GetFileMachine(h, true);
+}
+
+}
+
+#endif

package/src/koffi/src/win32.hh

@@ -27,6 +27,45 @@
 
 namespace RG {
 
+struct PE_DOS_HEADER {
+    uint16_t e_magic;
+    uint16_t e_cblp;
+    uint16_t e_cp;
+    uint16_t e_crlc;
+    uint16_t e_cparhdr;
+    uint16_t e_minalloc;
+    uint16_t e_maxalloc;
+    uint16_t e_ss;
+    uint16_t e_sp;
+    uint16_t e_csum;
+    uint16_t e_ip;
+    uint16_t e_cs;
+    uint16_t e_lfarlc;
+    uint16_t e_ovno;
+    uint16_t e_res[4];
+    uint16_t e_oemid;
+    uint16_t e_oeminfo;
+    uint16_t e_res2[10];
+    uint32_t e_lfanew;
+};
+
+struct PE_FILE_HEADER {
+    uint16_t Machine;
+    uint16_t NumberOfSections;
+    uint32_t TimeDateStamp;
+    uint32_t PointerToSymbolTable;
+    uint32_t NumberOfSymbols;
+    uint16_t SizeOfOptionalHeader;
+    uint16_t Characteristics;
+};
+
+struct PE_NT_HEADERS {
+    uint32_t Signature;
+    PE_FILE_HEADER FileHeader;
+
+    // ... OptionalHeader;
+};
+
 #if _WIN64
 
 struct TEB {
@@ -70,4 +109,9 @@ static inline TEB *GetTEB()
     return teb;
 }
 
+extern const HashMap<int, const char *> WindowsMachineNames;
+
+int GetSelfMachine();
+int GetDllMachine(const char16_t *filename);
+
 }