koffi 2.8.2 → 2.8.3

package/CHANGELOG.md

@@ -4,6 +4,10 @@
 
 ### Koffi 2.8
 
+#### Koffi 2.8.3 (2024-04-08)
+
+- Use simpler workaround for Node 20.12+ and 21.6+ to avoid excessive memory use
+
 #### Koffi 2.8.2 (2024-04-07)
 
 - Support [loading library](functions.md#loading-options) with RTLD_GLOBAL on POSIX platforms

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.2",
-      stable: "2.8.2",
+      version: "2.8.3",
+      stable: "2.8.3",
       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.2",
-      stable: "2.8.2",
+      version: "2.8.3",
+      stable: "2.8.3",
       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.2",
-    "stable": "2.8.2",
+    "version": "2.8.3",
+    "stable": "2.8.3",
     "description": "Fast and simple C FFI (foreign function interface) for Node.js",
     "keywords": [
         "foreign",

package/src/koffi/src/ffi.cc

@@ -2247,7 +2247,6 @@ static InstanceData *CreateInstance()
     instance->main_thread_id = std::this_thread::get_id();
 
     instance->debug = GetDebugFlag("DUMP_CALLS");
-    FillRandomSafe(&instance->tag_lower, RG_SIZE(instance->tag_lower));
 
 #ifdef _WIN32
     TEB *teb = GetTEB();

package/src/koffi/src/ffi.hh

@@ -40,8 +40,10 @@ static const Size MaxParameters = 64;
 static const Size MaxTrampolines = 8192;
 
 enum class PrimitiveKind {
-    Void,
+    // Void is explictly not first so that it is not 0, for reasons related to N-API type tags.
+    // Look at TypeInfo definition for more information!
     Bool,
+    Void,
     Int8,
     UInt8,
     Int16,
@@ -68,8 +70,8 @@ enum class PrimitiveKind {
     Callback
 };
 static const char *const PrimitiveKindNames[] = {
-    "Void",
     "Bool",
+    "Void",
     "Int8",
     "UInt8",
     "Int16",
@@ -123,7 +125,12 @@ static const char *const ArrayHintNames[] = {
 struct TypeInfo {
     const char *name;
 
-    PrimitiveKind primitive;
+    // Make sure primitie ends up as the upper N-API tag value when we cast TypeInfo pointers to
+    // napi_type_tag pointers. Yes, I want to do this. We don't do strict aliasing here.
+    // N.B. Some node versions don't like when one of the two tag values is 0, so make sure
+    // this does not happen! It would happen if primitive is 0 and size is 0. To avoid this
+    // situation, PrimitiveKind::Void (the only type with size 0) is explictly not 0.
+    alignas(8) PrimitiveKind primitive;
     int32_t size;
     int16_t align;
     uint16_t flags;
@@ -273,10 +280,6 @@ struct InstanceData {
 
     bool debug;
 
-    uint64_t tag_lower;
-    BucketArray<napi_type_tag> tags;
-    HashMap<const void *, napi_type_tag *> tags_map;
-
     const TypeInfo *void_type;
     const TypeInfo *char_type;
     const TypeInfo *char16_type;

package/src/koffi/src/util.cc

@@ -29,9 +29,9 @@
 namespace RG {
 
 // Value does not matter, the tag system uses memory addresses
-const int TypeInfoMarker = 0xDEADBEEF;
-const int CastMarker = 0xDEADBEEF;
-const int MagicUnionMarker = 0xDEADBEEF;
+const napi_type_tag TypeInfoMarker = { 0x1cc449675b294374, 0xbb13a50e97dcb017 };
+const napi_type_tag CastMarker = { 0x77f459614a0a412f, 0x80b3dda1341dc8df };
+const napi_type_tag MagicUnionMarker = { 0x5eaf2245526a4c7d, 0x8c86c9ee2b96ffc8 };
 
 Napi::Function MagicUnion::InitClass(Napi::Env env, const TypeInfo *type)
 {
@@ -579,20 +579,20 @@ const char *GetValueType(const InstanceData *instance, Napi::Value value)
     return "Unknown";
 }
 
-void SetValueTag(InstanceData *instance, Napi::Value value, const void *marker)
+void SetValueTag(const InstanceData *instance, Napi::Value value, const void *marker)
 {
-    RG_ASSERT(marker);
-
-    napi_type_tag *tag = instance->tags_map.FindValue(marker, nullptr);
-
-    if (!tag) {
-        tag = instance->tags.AppendDefault();
-
-        tag->lower = instance->tag_lower;
-        tag->upper = (uint64_t)marker;
-
-        instance->tags_map.Set(marker, tag);
-    }
+    static_assert(RG_SIZE(TypeInfo) >= 16);
+
+    // We used to make a temporary tag on the stack with lower set to a constant value and
+    // upper to the pointer address, but this broke in Node 20.12 and Node 21.6 due to ExternalWrapper
+    // storing a pointer to the tag and not the tag value itself (which seems wrong, but anyway).
+    //
+    // Since this is no longer an option, we just type alias whatever marker points to to napi_type_tag.
+    // This may seem gross, but we disable strict aliasing anyway, so as long as what marker points
+    // to is bigger than 16 bytes and does not change, it works!
+    // Which holds true for us: the main thing pointed to is TypeInfo, which is constant and big enough,
+    // and the few other markers we use, such as CastMarker, are actual const napi_type_tag structs.
+    const napi_type_tag *tag = (const napi_type_tag *)marker;
 
     napi_status status = napi_type_tag_object(value.Env(), value, tag);
     RG_ASSERT(status == napi_ok);
@@ -600,13 +600,11 @@ void SetValueTag(InstanceData *instance, Napi::Value value, const void *marker)
 
 bool CheckValueTag(const InstanceData *instance, Napi::Value value, const void *marker)
 {
-    RG_ASSERT(marker);
-
     bool match = false;
 
     if (!IsNullOrUndefined(value)) {
-        napi_type_tag tag = { instance->tag_lower, (uint64_t)marker };
-        napi_check_object_type_tag(value.Env(), value, &tag, &match);
+        const napi_type_tag *tag = (const napi_type_tag *)marker;
+        napi_check_object_type_tag(value.Env(), value, tag, &match);
     }
 
     return match;

package/src/koffi/src/util.hh

@@ -28,9 +28,9 @@
 
 namespace RG {
 
-extern const int TypeInfoMarker;
-extern const int CastMarker;
-extern const int MagicUnionMarker;
+extern const napi_type_tag TypeInfoMarker;
+extern const napi_type_tag CastMarker;
+extern const napi_type_tag MagicUnionMarker;
 
 class MagicUnion: public Napi::ObjectWrap<MagicUnion> {
     const TypeInfo *type;
@@ -102,7 +102,7 @@ bool CanStoreType(const TypeInfo *type);
 // Can be slow, only use for error messages
 const char *GetValueType(const InstanceData *instance, Napi::Value value);
 
-void SetValueTag(InstanceData *instance, Napi::Value value, const void *marker);
+void SetValueTag(const InstanceData *instance, Napi::Value value, const void *marker);
 bool CheckValueTag(const InstanceData *instance, Napi::Value value, const void *marker);
 
 static inline bool IsNullOrUndefined(Napi::Value value)