koffi 2.2.0 → 2.2.1

package/ChangeLog.md

@@ -2,6 +2,12 @@
 
 ## History
 
+### Koffi 2.2.1
+
+**Main fixes:**
+
+- Fix crash when [calling callback again after FFI call inside previous callback](https://github.com/Koromix/rygel/issues/15)
+
 ### Koffi 2.2.0
 
 **New features:**

package/package.json

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

package/src/koffi/src/abi_arm32.cc

@@ -495,6 +495,7 @@ bool CallData::Prepare(const Napi::CallbackInfo &info)
 
 void CallData::Execute()
 {
+    RG_DEFER_C(prev_call = exec_call) { exec_call = prev_call; };
     exec_call = this;
 
 #define PERFORM_CALL(Suffix) \

package/src/koffi/src/abi_arm64.cc

@@ -563,6 +563,7 @@ bool CallData::Prepare(const Napi::CallbackInfo &info)
 
 void CallData::Execute()
 {
+    RG_DEFER_C(prev_call = exec_call) { exec_call = prev_call; };
     exec_call = this;
 
 #define PERFORM_CALL(Suffix) \

package/src/koffi/src/abi_riscv64.cc

@@ -410,6 +410,7 @@ bool CallData::Prepare(const Napi::CallbackInfo &info)
 
 void CallData::Execute()
 {
+    RG_DEFER_C(prev_call = exec_call) { exec_call = prev_call; };
     exec_call = this;
 
 #define PERFORM_CALL(Suffix) \

package/src/koffi/src/abi_x64_sysv.cc

@@ -474,6 +474,7 @@ bool CallData::Prepare(const Napi::CallbackInfo &info)
 
 void CallData::Execute()
 {
+    RG_DEFER_C(prev_call = exec_call) { exec_call = prev_call; };
     exec_call = this;
 
 #define PERFORM_CALL(Suffix) \

package/src/koffi/src/abi_x64_win.cc

@@ -285,6 +285,7 @@ bool CallData::Prepare(const Napi::CallbackInfo &info)
 
 void CallData::Execute()
 {
+    RG_DEFER_C(prev_call = exec_call) { exec_call = prev_call; };
     exec_call = this;
 
 #define PERFORM_CALL(Suffix) \

package/src/koffi/src/abi_x86.cc

@@ -366,6 +366,7 @@ bool CallData::Prepare(const Napi::CallbackInfo &info)
 
 void CallData::Execute()
 {
+    RG_DEFER_C(prev_call = exec_call) { exec_call = prev_call; };
     exec_call = this;
 
 #define PERFORM_CALL(Suffix) \

package/src/koffi/src/call.cc

@@ -46,6 +46,8 @@ CallData::~CallData()
     if (!--mem->depth && mem->temporary) {
         delete mem;
     }
+
+    instance = nullptr;
 }
 
 bool CallData::PushString(Napi::Value value, int directions, const char **out_str)

package/src/koffi/src/ffi.cc

@@ -972,16 +972,16 @@ static Napi::Value GetTypeDefinition(const Napi::CallbackInfo &info)
                 Napi::Object members = Napi::Object::New(env);
 
                 for (const RecordMember &member: type->members) {
-                    Napi::Object info = Napi::Object::New(env);
+                    Napi::Object obj = Napi::Object::New(env);
 
                     Napi::External<TypeInfo> external = Napi::External<TypeInfo>::New(env, (TypeInfo *)member.type);
                     SetValueTag(instance, external, &TypeInfoMarker);
 
-                    info.Set("name", member.name);
-                    info.Set("type", external);
-                    info.Set("offset", member.offset);
+                    obj.Set("name", member.name);
+                    obj.Set("type", external);
+                    obj.Set("offset", member.offset);
 
-                    members.Set(member.name, info);
+                    members.Set(member.name, obj);
                 }
 
                 defn.Set("members", members);

package/src/koffi/test/callbacks.js

@@ -41,6 +41,7 @@ const ApplyCallback = koffi.callback('int __stdcall ApplyCallback(int a, int b,
 const IntCallback = koffi.callback('int IntCallback(int x)');
 const VectorCallback = koffi.callback('int VectorCallback(int len, Vec2 *vec)');
 const SortCallback = koffi.callback('int SortCallback(const void *ptr1, const void *ptr2)');
+const CharCallback = koffi.callback('int CharCallback(int idx, char c)');
 
 const StructCallbacks = koffi.struct('StructCallbacks', {
     first: koffi.pointer(IntCallback),
@@ -75,6 +76,8 @@ async function test() {
     const CallCallback = lib.func('int CallCallback(int x)');
     const MakeVectors = lib.func('int MakeVectors(int len, VectorCallback *func)');
     const CallQSort = lib.func('void CallQSort(_Inout_ void *base, size_t nmemb, size_t size, SortCallback *cb)');
+    const CallMeChar = lib.func('int CallMeChar(CharCallback *func)');
+    const GetMinusOne1 = lib.func('int8_t GetMinusOne1(void)');
 
     // Simple test similar to README example
     {
@@ -230,4 +233,20 @@ async function test() {
 
         assert.deepEqual(array, ['123', 'bar', 'foo', 'foobar']);
     }
+
+    // Make sure thread local CallData is restored after nested call inside callback
+    // Regression test for issue #15
+    {
+        let chars = [97, 98];
+
+        let cb = koffi.register((idx, c) => {
+            assert.equal(GetMinusOne1(), -1);
+            assert.equal(c, chars[idx]);
+
+            return c;
+        }, 'CharCallback *');
+
+        let ret = CallMeChar(cb);
+        assert.equal(ret, 97 + 98);
+    }
 }

package/src/koffi/test/misc.c

@@ -169,6 +169,7 @@ typedef struct Vec2 {
 
 typedef int VectorCallback(int len, Vec2 *vec);
 typedef int SortCallback(const void *ptr1, const void *ptr2);
+typedef int CharCallback(int idx, char c);
 
 EXPORT int8_t GetMinusOne1(void)
 {
@@ -776,3 +777,13 @@ EXPORT void CallQSort(void *base, size_t nmemb, size_t size, SortCallback *cb)
 {
     qsort(base, nmemb, size, cb);
 }
+
+EXPORT int CallMeChar(CharCallback *func)
+{
+    int ret = 0;
+
+    ret += func(0, 'a');
+    ret += func(1, 'b');
+
+    return ret;
+}