emnapi 0.36.3 → 0.38.0

package/CMakeLists.txt

@@ -70,7 +70,7 @@ if(EMNAPI_FIND_NODE_ADDON_API)
   else()
     string(REGEX REPLACE "(\r?\n)|\"" "" OUTPUT_NAA_INCLUDE_DIR "${OUTPUT_NAA_INCLUDE_DIR}")
     string(REPLACE "\\" "/" OUTPUT_NAA_INCLUDE_DIR "${OUTPUT_NAA_INCLUDE_DIR}")
-    list(PREPEND EMNAPI_INCLUDE "${OUTPUT_NAA_INCLUDE_DIR}")
+    list(APPEND EMNAPI_INCLUDE "${OUTPUT_NAA_INCLUDE_DIR}")
   endif()
 endif()
 
@@ -191,8 +191,6 @@ install(FILES
     ${CMAKE_CURRENT_SOURCE_DIR}/include/emnapi.h
     ${CMAKE_CURRENT_SOURCE_DIR}/include/js_native_api_types.h
     ${CMAKE_CURRENT_SOURCE_DIR}/include/js_native_api.h
-    ${CMAKE_CURRENT_SOURCE_DIR}/include/napi-inl.h
-    ${CMAKE_CURRENT_SOURCE_DIR}/include/napi.h
     ${CMAKE_CURRENT_SOURCE_DIR}/include/node_api_types.h
     ${CMAKE_CURRENT_SOURCE_DIR}/include/node_api.h
     ${CMAKE_CURRENT_SOURCE_DIR}/include/uv.h

package/README.md

@@ -35,6 +35,7 @@ You will need to install:
 - (Optional) CMake `>= v3.13`
 - (Optional) ninja
 - (Optional) make
+- (Optional) [node-addon-api](https://github.com/nodejs/node-addon-api) `>= 6.1.0`
 
 There are several choices to get `make` for Windows user
 
@@ -94,6 +95,9 @@ npm install @emnapi/runtime
 
 # for non-emscripten
 npm install @emnapi/core
+
+# if you use node-addon-api
+npm install node-addon-api
 ```
 
 Each package should match the same version.
@@ -404,9 +408,13 @@ instantiateNapiModule(fetch('./hello.wasm'), {
 
 </details>
 
-### Using C++
+### Using C++ and node-addon-api
 
-Alternatively, you can also use [`node-addon-api`](https://github.com/nodejs/node-addon-api) which is official Node-API C++ wrapper, already shipped ([v6.0.0](https://github.com/nodejs/node-addon-api/releases/tag/v6.0.0)) in this package but without Node.js specific API such as `CallbackScope`.
+Require [`node-addon-api`](https://github.com/nodejs/node-addon-api) `>= 6.1.0`
+
+```bash
+npm install node-addon-api
+```
 
 **Note: C++ wrapper can only be used to target Node.js v14.6.0+ and modern browsers those support `FinalizationRegistry` and `WeakRef` ([v8 engine v8.4+](https://v8.dev/blog/v8-release-84))!**
 
@@ -441,6 +449,7 @@ em++ -O3 \
      -DNAPI_DISABLE_CPP_EXCEPTIONS \
      -DNODE_ADDON_API_ENABLE_MAYBE \
      -I./node_modules/emnapi/include \
+     -I./node_modules/node-addon-api \
      -L./node_modules/emnapi/lib/wasm32-emscripten \
      --js-library=./node_modules/emnapi/dist/library_napi.js \
      -sEXPORTED_FUNCTIONS="['_napi_register_wasm_v1','_malloc','_free']" \
@@ -459,6 +468,7 @@ clang++ -O3 \
         -DNAPI_DISABLE_CPP_EXCEPTIONS \
         -DNODE_ADDON_API_ENABLE_MAYBE \
         -I./node_modules/emnapi/include \
+        -I./node_modules/node-addon-api \
         -L./node_modules/emnapi/lib/wasm32-wasi \
         --target=wasm32-wasi \
         --sysroot=$WASI_SDK_PATH/share/wasi-sysroot \
@@ -563,15 +573,20 @@ elseif((CMAKE_C_COMPILER_TARGET STREQUAL "wasm32") OR (CMAKE_C_COMPILER_TARGET S
 endif()
 ```
 
+If you use node-addon-api, you can use `-DEMNAPI_FIND_NODE_ADDON_API=ON` or manually add node-addon-api directory to the include dir via `include_directories()` or `target_include_directories()`.
+
 ```bash
 mkdir build
 
 # emscripten
-emcmake cmake -DCMAKE_BUILD_TYPE=Release -G Ninja -H. -Bbuild
+emcmake cmake -DCMAKE_BUILD_TYPE=Release \
+              -DEMNAPI_FIND_NODE_ADDON_API=ON \
+              -G Ninja -H. -Bbuild
 
 # wasi-sdk
 cmake -DCMAKE_TOOLCHAIN_FILE=$WASI_SDK_PATH/share/cmake/wasi-sdk.cmake \
       -DWASI_SDK_PREFIX=$WASI_SDK_PATH \
+      -DEMNAPI_FIND_NODE_ADDON_API=ON \
       -DCMAKE_BUILD_TYPE=Release \
       -G Ninja -H. -Bbuild
 
@@ -848,11 +863,15 @@ endif()
 
 ```bash
 # emscripten
-emcmake cmake -DCMAKE_BUILD_TYPE=Release -DEMNAPI_WORKER_POOL_SIZE=4 -G Ninja -H. -Bbuild
+emcmake cmake -DCMAKE_BUILD_TYPE=Release \
+              -DEMNAPI_FIND_NODE_ADDON_API=ON \
+              -DEMNAPI_WORKER_POOL_SIZE=4 \
+              -G Ninja -H. -Bbuild
 
 # wasi-sdk with thread support (Experimental)
 cmake -DCMAKE_TOOLCHAIN_FILE=$WASI_SDK_PATH/share/cmake/wasi-sdk-pthread.cmake \
       -DWASI_SDK_PREFIX=$WASI_SDK_PATH \
+      -DEMNAPI_FIND_NODE_ADDON_API=ON \
       -DCMAKE_BUILD_TYPE=Release \
       -G Ninja -H. -Bbuild
 
@@ -1043,47 +1062,48 @@ This option only has effect if you use emscripten `-pthread`. Default is `1` if
 
 See source code [here](https://github.com/toyobayashi/emnapi/tree/main/packages/bench)
 
-- OS: Windows_NT x64 10.0.22621.963
-- CPU: 11th Gen Intel(R) Core(TM) i7-11800H @ 2.30GHz   2.30 GHz
-- Memory: 16.0 GB
-- Chrome: 108.0.5359.125
-- Emscripten: 3.1.28
-- emnapi: 0.22.0
+- OS: macOS 13.3.1 22E261 arm64
+- CPU: Apple M2 Pro
+- Memory: 32.0 GB
+- Chrome: 112.0.5615.137
+- Emscripten: 3.1.36
+- emnapi: 0.38.0
+- node-addon-api 6.1.0
 
 ```
 binding: function () {}
-                 embind #emptyFunction x 37,148,158 ops/sec ±0.39% (67 runs sampled)
-                 emnapi #emptyFunction x 40,207,668 ops/sec ±0.79% (67 runs sampled)
-node-addon-api + emnapi #emptyFunction x 13,871,523 ops/sec ±0.35% (67 runs sampled)
+                 embind #emptyFunction x 49,956,250 ops/sec ±0.32% (68 runs sampled)
+                 emnapi #emptyFunction x 57,543,501 ops/sec ±0.76% (67 runs sampled)
+node-addon-api + emnapi #emptyFunction x 21,352,147 ops/sec ±0.62% (66 runs sampled)
 Fastest is emnapi #emptyFunction
 
 binding: function (obj) { return obj }
-                 embind #returnParam x 19,230,099 ops/sec ±0.59% (68 runs sampled)
-                 emnapi #returnParam x 14,930,264 ops/sec ±0.68% (64 runs sampled)
-node-addon-api + emnapi #returnParam x 11,402,133 ops/sec ±0.47% (67 runs sampled)
-Fastest is embind #returnParam
+                 embind #returnParam x 21,426,261 ops/sec ±0.67% (67 runs sampled)
+                 emnapi #returnParam x 25,111,317 ops/sec ±0.40% (68 runs sampled)
+node-addon-api + emnapi #returnParam x 17,811,804 ops/sec ±0.24% (68 runs sampled)
+Fastest is emnapi #returnParam
 
 binding: function (int) { return copy(int) }
-                 embind #convertInteger x 9,178,287 ops/sec ±0.67% (67 runs sampled)
-                 emnapi #convertInteger x 9,898,681 ops/sec ±0.56% (66 runs sampled)
-node-addon-api + emnapi #convertInteger x 7,888,491 ops/sec ±0.79% (67 runs sampled)
+                 embind #convertInteger x 9,748,310 ops/sec ±0.52% (68 runs sampled)
+                 emnapi #convertInteger x 16,128,395 ops/sec ±0.38% (70 runs sampled)
+node-addon-api + emnapi #convertInteger x 11,692,687 ops/sec ±0.41% (67 runs sampled)
 Fastest is emnapi #convertInteger
 
 binding: function (str) { return copy(str) }
-                 embind #convertString x 2,574,960 ops/sec ±0.46% (66 runs sampled)
-                 emnapi #convertString x 3,412,941 ops/sec ±0.66% (68 runs sampled)
-node-addon-api + emnapi #convertString x 2,913,797 ops/sec ±0.62% (67 runs sampled)
+                 embind #convertString x 3,681,066 ops/sec ±0.24% (69 runs sampled)
+                 emnapi #convertString x 4,555,446 ops/sec ±0.40% (69 runs sampled)
+node-addon-api + emnapi #convertString x 3,826,496 ops/sec ±0.24% (68 runs sampled)
 Fastest is emnapi #convertString
 
 binding: function (param) { return param.length }
-                 embind #ObjectGet x 6,192,531 ops/sec ±0.73% (67 runs sampled)
-                 emnapi #ObjectGet x 5,268,653 ops/sec ±0.59% (66 runs sampled)
-node-addon-api + emnapi #ObjectGet x 4,828,204 ops/sec ±0.57% (67 runs sampled)
-Fastest is embind #ObjectGet
+                 embind #ObjectGet x 6,874,783 ops/sec ±0.39% (68 runs sampled)
+                 emnapi #ObjectGet x 6,926,130 ops/sec ±0.34% (69 runs sampled)
+node-addon-api + emnapi #ObjectGet x 6,075,822 ops/sec ±0.41% (68 runs sampled)
+Fastest is emnapi #ObjectGet
 
 binding: function (obj, key, value) { obj[key] = value }
-                 embind #ObjectSet x 11,467,433 ops/sec ±0.55% (67 runs sampled)
-                 emnapi #ObjectSet x 9,476,512 ops/sec ±0.91% (66 runs sampled)
-node-addon-api + emnapi #ObjectSet x 7,647,341 ops/sec ±0.36% (66 runs sampled)
-Fastest is embind #ObjectSet
+                 embind #ObjectSet x 11,184,221 ops/sec ±0.35% (66 runs sampled)
+                 emnapi #ObjectSet x 15,812,566 ops/sec ±0.64% (66 runs sampled)
+node-addon-api + emnapi #ObjectSet x 12,022,909 ops/sec ±0.51% (66 runs sampled)
+Fastest is emnapi #ObjectSet
 ```

package/dist/library_napi.js

@@ -212,9 +212,13 @@ function _emnapi_create_memory_view(env, typedarray_type, external_data, byte_le
             case -1 /* emnapi_memory_view_type.emnapi_data_view */:
                 viewDescriptor_1 = { Ctor: DataView, address: external_data, length: byte_length, ownership: 1 /* Ownership.kUserland */, runtimeAllocated: 0 };
                 break;
-            case -2 /* emnapi_memory_view_type.emnapi_buffer */:
+            case -2 /* emnapi_memory_view_type.emnapi_buffer */: {
+                if (!emnapiCtx.feature.Buffer) {
+                    throw emnapiCtx.createNotSupportBufferError("emnapi_create_memory_view", "");
+                }
                 viewDescriptor_1 = { Ctor: emnapiCtx.feature.Buffer, address: external_data, length: byte_length, ownership: 1 /* Ownership.kUserland */, runtimeAllocated: 0 };
                 break;
+            }
             default: return envObject_1.setLastError(1 /* napi_status.napi_invalid_arg */);
         }
         var Ctor_1 = viewDescriptor_1.Ctor;
@@ -399,7 +403,7 @@ emnapiImplement2('emnapi_is_support_weakref', 'i', emnapi_is_support_weakref);
 emnapiImplement2('emnapi_is_support_bigint', 'i', emnapi_is_support_bigint);
 emnapiImplement2('emnapi_is_node_binding_available', 'i', emnapi_is_node_binding_available);
 emnapiImplement2('emnapi_create_memory_view', 'ipippppp', _emnapi_create_memory_view, ['napi_add_finalizer', '$emnapiExternalMemory']);
-emnapiImplement2('emnapi_sync_memory', 'ipppppi', emnapi_sync_memory, ['$emnapiSyncMemory']);
+emnapiImplement2('emnapi_sync_memory', 'ipippp', emnapi_sync_memory, ['$emnapiSyncMemory']);
 emnapiImplement2('emnapi_get_memory_address', 'ipppp', emnapi_get_memory_address, ['$emnapiGetMemoryAddress']);
 function napi_set_instance_data(env, data, finalize_cb, finalize_hint) {
     if (env == 0)
@@ -1380,7 +1384,7 @@ var emnapiExternalMemory = {
         if (!shouldCopy) {
             return info;
         }
-        var pointer = {{{ makeMalloc('$emnapiExternalMemory.getArrayBufferPointer', 'arrayBuffer.byteLength') }}};
+        var pointer = _malloc({{{ to64('arrayBuffer.byteLength') }}});
         if (!pointer)
             throw new Error('Out of memory');
         new Uint8Array(wasmMemory.buffer).set(new Uint8Array(arrayBuffer), pointer);
@@ -2461,22 +2465,15 @@ function napi_run_script(env, script, result) {
     return status;
 }
 emnapiImplement('napi_run_script', 'ippp', napi_run_script, ['napi_set_last_error']);
-/* eslint-disable @typescript-eslint/indent */
 var emnapiString = {
     utf8Decoder: undefined,
     utf16Decoder: undefined,
     init: function () {
 #if !TEXTDECODER || TEXTDECODER == 1
         var fallbackDecoder = {
-            decode: function (input) {
-                var isArrayBuffer = input instanceof ArrayBuffer;
-                var isView = ArrayBuffer.isView(input);
-                if (!isArrayBuffer && !isView) {
-                    throw new TypeError('The "input" argument must be an instance of ArrayBuffer or ArrayBufferView');
-                }
-                var bytes = isArrayBuffer ? new Uint8Array(input) : new Uint8Array(input.buffer, input.byteOffset, input.byteLength);
+            decode: function (bytes) {
                 var inputIndex = 0;
-                var pendingSize = Math.min(256 * 256, bytes.length + 1);
+                var pendingSize = Math.min(0x1000, bytes.length + 1);
                 var pending = new Uint16Array(pendingSize);
                 var chunks = [];
                 var pendingIndex = 0;
@@ -2536,17 +2533,18 @@ var emnapiString = {
 #if !TEXTDECODER || TEXTDECODER == 1
         var fallbackDecoder2 = {
             decode: function (input) {
-                var isArrayBuffer = input instanceof ArrayBuffer;
-                var isView = ArrayBuffer.isView(input);
-                if (!isArrayBuffer && !isView) {
-                    throw new TypeError('The "input" argument must be an instance of ArrayBuffer or ArrayBufferView');
+                var bytes = new Uint16Array(input.buffer, input.byteOffset, input.byteLength / 2);
+                if (bytes.length <= 0x1000) {
+                    return String.fromCharCode.apply(null, bytes);
                 }
-                var bytes = isArrayBuffer ? new Uint16Array(input) : new Uint16Array(input.buffer, input.byteOffset, input.byteLength / 2);
-                var wcharArray = Array(bytes.length);
-                for (var i = 0; i < bytes.length; ++i) {
-                    wcharArray[i] = String.fromCharCode(bytes[i]);
+                var chunks = [];
+                var i = 0;
+                var len = 0;
+                for (; i < bytes.length; i += len) {
+                    len = Math.min(0x1000, bytes.length - i);
+                    chunks.push(String.fromCharCode.apply(null, bytes.subarray(i, i + len)));
                 }
-                return wcharArray.join('');
+                return chunks.join('');
             }
         };
 #endif
@@ -2582,9 +2580,9 @@ var emnapiString = {
         return len;
     },
     UTF8ToString: function (ptr, length) {
-        ptr >>>= 0;
         if (!ptr || !length)
             return '';
+        ptr >>>= 0;
         var HEAPU8 = new Uint8Array(wasmMemory.buffer);
         var end = ptr;
         if (length === -1) {
@@ -2594,6 +2592,40 @@ var emnapiString = {
         else {
             end = ptr + (length >>> 0);
         }
+#if TEXTDECODER != 2
+        length = end - ptr;
+        if (length <= 16) {
+            var idx = ptr;
+            var str = '';
+            while (idx < end) {
+                var u0 = HEAPU8[idx++];
+                if (!(u0 & 0x80)) {
+                    str += String.fromCharCode(u0);
+                    continue;
+                }
+                var u1 = HEAPU8[idx++] & 63;
+                if ((u0 & 0xE0) === 0xC0) {
+                    str += String.fromCharCode(((u0 & 31) << 6) | u1);
+                    continue;
+                }
+                var u2 = HEAPU8[idx++] & 63;
+                if ((u0 & 0xF0) === 0xE0) {
+                    u0 = ((u0 & 15) << 12) | (u1 << 6) | u2;
+                }
+                else {
+                    u0 = ((u0 & 7) << 18) | (u1 << 12) | (u2 << 6) | (HEAPU8[idx++] & 63);
+                }
+                if (u0 < 0x10000) {
+                    str += String.fromCharCode(u0);
+                }
+                else {
+                    var ch = u0 - 0x10000;
+                    str += String.fromCharCode(0xD800 | (ch >> 10), 0xDC00 | (ch & 0x3FF));
+                }
+            }
+            return str;
+        }
+#endif
         return emnapiString.utf8Decoder.decode({{{ getUnsharedTextDecoderView('HEAPU8', 'ptr', 'end') }}});
     },
     stringToUTF8: function (str, outPtr, maxBytesToWrite) {
@@ -2642,9 +2674,9 @@ var emnapiString = {
         return outIdx - startIdx;
     },
     UTF16ToString: function (ptr, length) {
-        ptr >>>= 0;
         if (!ptr || !length)
             return '';
+        ptr >>>= 0;
         var end = ptr;
         if (length === -1) {
             var idx = end >> 1;
@@ -2656,6 +2688,12 @@ var emnapiString = {
         else {
             end = ptr + (length >>> 0) * 2;
         }
+#if TEXTDECODER != 2
+        length = end - ptr;
+        if (length <= 32) {
+            return String.fromCharCode.apply(null, new Uint16Array(wasmMemory.buffer, ptr, length / 2));
+        }
+#endif
         // eslint-disable-next-line @typescript-eslint/no-unused-vars
         var HEAPU8 = new Uint8Array(wasmMemory.buffer);
         return emnapiString.utf16Decoder.decode({{{ getUnsharedTextDecoderView('HEAPU8', 'ptr', 'end') }}});
@@ -2752,7 +2790,7 @@ var emnapiTSFN = {
     },
     initQueue: function (func) {
         var size = 2 * {{{ POINTER_SIZE }}};
-        var queue = {{{ makeMalloc('emnapiTSFN.initQueue', 'size') }}};
+        var queue = _malloc({{{ to64('size') }}});
         if (!queue)
             return false;
         new Uint8Array(wasmMemory.buffer, queue, size).fill(0);
@@ -2771,7 +2809,7 @@ var emnapiTSFN = {
         var tail = emnapiTSFN.loadSizeTypeValue(queue + {{{ POINTER_SIZE }}}, false);
         // eslint-disable-next-line @typescript-eslint/no-unused-vars
         var size = 2 * {{{ POINTER_SIZE }}};
-        var node = {{{ makeMalloc('emnapiTSFN.pushQueue', 'size') }}};
+        var node = _malloc({{{ to64('size') }}});
         if (!node)
             throw new Error('OOM');
         emnapiTSFN.storeSizeTypeValue(node, data, false);
@@ -3361,7 +3399,7 @@ function _napi_create_threadsafe_function(env, func, async_resource, async_resou
     var resource_name = envObject.ensureHandleId(asyncResourceName);
     // tsfn create
     var sizeofTSFN = emnapiTSFN.offset.end;
-    var tsfn = {{{ makeMalloc('napi_create_threadsafe_function', 'sizeofTSFN') }}};
+    var tsfn = _malloc({{{ to64('sizeofTSFN') }}});
     if (!tsfn)
         return envObject.setLastError(9 /* napi_status.napi_generic_failure */);
     new Uint8Array(wasmMemory.buffer).subarray(tsfn, tsfn + sizeofTSFN).fill(0);
@@ -3488,6 +3526,8 @@ function _napi_ref_threadsafe_function(env, func) {
 emnapiDefineVar('$emnapiTSFN', emnapiTSFN, [
     '$emnapiInit',
     '$PThread',
+    'malloc',
+    'free',
     '_emnapi_node_emit_async_init',
     '_emnapi_node_emit_async_destroy',
     '_emnapi_runtime_keepalive_pop',
@@ -5429,8 +5469,11 @@ function napi_create_buffer(env, size, data, result
     try {
         if (result == 0)
             return envObject_56.setLastError(1 /* napi_status.napi_invalid_arg */);
-        {{{ from64("result") }}};
         var Buffer_1 = emnapiCtx.feature.Buffer;
+        if (!Buffer_1) {
+            throw emnapiCtx.createNotSupportBufferError("napi_create_buffer", "");
+        }
+        {{{ from64("result") }}};
         var buffer_2 = void 0;
         {{{ from64("size") }}};
         size = size >>> 0;
@@ -5440,7 +5483,7 @@ function napi_create_buffer(env, size, data, result
             {{{ makeSetValue("result", 0, "value", "*") }}};
         }
         else {
-            pointer = {{{ makeMalloc("napi_create_buffer", "size") }}};
+            pointer = _malloc({{{ to64("size") }}});
             if (!pointer)
                 throw new Error("Out of memory");
             new Uint8Array(wasmMemory.buffer).subarray(pointer, pointer + size).fill(0);
@@ -5483,8 +5526,8 @@ function napi_create_buffer_copy(env, length, data, result_data, result
     try {
         if (result == 0)
             return envObject_57.setLastError(1 /* napi_status.napi_invalid_arg */);
-        var arrayBuffer_3 = emnapiCreateArrayBuffer(length, result_data);
         var Buffer_2 = emnapiCtx.feature.Buffer;
+        var arrayBuffer_3 = emnapiCreateArrayBuffer(length, result_data);
         var buffer_4 = Buffer_2.from(arrayBuffer_3);
         {{{ from64("data") }}};
         {{{ from64("length") }}};

package/include/emnapi_common.h

@@ -2,11 +2,9 @@
 #define EMNAPI_INCLUDE_COMMON_H_
 
 #ifdef __EMSCRIPTEN__
-#define NAPI_EXTERN __attribute__((visibility("default")))                \
-                    __attribute__((__import_module__("env")))
+#define NAPI_EXTERN __attribute__((__import_module__("env")))
 
-#define EMNAPI_EXTERN __attribute__((visibility("default")))              \
-                      __attribute__((__import_module__("env")))
+#define EMNAPI_EXTERN __attribute__((__import_module__("env")))
 #else
 #define NAPI_EXTERN __attribute__((__import_module__("napi")))