• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 #include <stdlib.h>
2 #include <uv.h>
3 #include <node_api.h>
4 #include "../../js-native-api/common.h"
5 
6 typedef struct {
7   napi_ref js_cb_ref;
8   napi_ref js_tsfn_finalizer_ref;
9   napi_threadsafe_function tsfn;
10   uv_thread_t thread;
11 } AddonData;
12 
AsyncWorkCbExecute(napi_env env,void * data)13 static void AsyncWorkCbExecute(napi_env env, void* data) {
14   (void) env;
15   (void) data;
16 }
17 
call_cb_and_delete_ref(napi_env env,napi_ref * optional_ref)18 static void call_cb_and_delete_ref(napi_env env, napi_ref* optional_ref) {
19   napi_value js_cb, undefined;
20 
21   if (optional_ref == NULL) {
22     AddonData* data;
23     NODE_API_CALL_RETURN_VOID(env, napi_get_instance_data(env, (void**)&data));
24     optional_ref = &data->js_cb_ref;
25   }
26 
27   NODE_API_CALL_RETURN_VOID(env,
28       napi_get_reference_value(env, *optional_ref, &js_cb));
29   NODE_API_CALL_RETURN_VOID(env, napi_get_undefined(env, &undefined));
30   NODE_API_CALL_RETURN_VOID(env,
31       napi_call_function(env, undefined, js_cb, 0, NULL, NULL));
32   NODE_API_CALL_RETURN_VOID(env, napi_delete_reference(env, *optional_ref));
33 
34   *optional_ref = NULL;
35 }
36 
AsyncWorkCbComplete(napi_env env,napi_status status,void * data)37 static void AsyncWorkCbComplete(napi_env env,
38                                    napi_status status,
39                                    void* data) {
40   (void) status;
41   (void) data;
42   call_cb_and_delete_ref(env, NULL);
43 }
44 
establish_callback_ref(napi_env env,napi_callback_info info)45 static bool establish_callback_ref(napi_env env, napi_callback_info info) {
46   AddonData* data;
47   size_t argc = 1;
48   napi_value js_cb;
49 
50   NODE_API_CALL_BASE(env, napi_get_instance_data(env, (void**)&data), false);
51   NODE_API_ASSERT_BASE(
52       env, data->js_cb_ref == NULL, "reference must be NULL", false);
53   NODE_API_CALL_BASE(
54       env, napi_get_cb_info(env, info, &argc, &js_cb, NULL, NULL), false);
55   NODE_API_CALL_BASE(
56       env, napi_create_reference(env, js_cb, 1, &data->js_cb_ref), false);
57 
58   return true;
59 }
60 
AsyncWorkCallback(napi_env env,napi_callback_info info)61 static napi_value AsyncWorkCallback(napi_env env, napi_callback_info info) {
62   if (establish_callback_ref(env, info)) {
63     napi_value resource_name;
64     napi_async_work work;
65 
66     NODE_API_CALL(env,
67         napi_create_string_utf8(
68             env, "AsyncIncrement", NAPI_AUTO_LENGTH, &resource_name));
69     NODE_API_CALL(env,
70         napi_create_async_work(
71             env, NULL, resource_name, AsyncWorkCbExecute, AsyncWorkCbComplete,
72             NULL, &work));
73     NODE_API_CALL(env, napi_queue_async_work(env, work));
74   }
75 
76   return NULL;
77 }
78 
TestBufferFinalizerCallback(napi_env env,void * data,void * hint)79 static void TestBufferFinalizerCallback(napi_env env, void* data, void* hint) {
80   (void) data;
81   (void) hint;
82   call_cb_and_delete_ref(env, NULL);
83 }
84 
TestBufferFinalizer(napi_env env,napi_callback_info info)85 static napi_value TestBufferFinalizer(napi_env env, napi_callback_info info) {
86   napi_value buffer = NULL;
87   if (establish_callback_ref(env, info)) {
88     NODE_API_CALL(env,
89         napi_create_external_buffer(
90             env, sizeof(napi_callback), TestBufferFinalizer,
91             TestBufferFinalizerCallback, NULL, &buffer));
92   }
93   return buffer;
94 }
95 
ThreadsafeFunctionCallJS(napi_env env,napi_value tsfn_cb,void * context,void * data)96 static void ThreadsafeFunctionCallJS(napi_env env,
97                                      napi_value tsfn_cb,
98                                      void* context,
99                                      void* data) {
100   (void) tsfn_cb;
101   (void) context;
102   (void) data;
103   call_cb_and_delete_ref(env, NULL);
104 }
105 
ThreadsafeFunctionTestThread(void * raw_data)106 static void ThreadsafeFunctionTestThread(void* raw_data) {
107   AddonData* data = raw_data;
108   napi_status status;
109 
110   // No need to call `napi_acquire_threadsafe_function()` because the main
111   // thread has set the refcount to 1 and there is only this one secondary
112   // thread.
113   status = napi_call_threadsafe_function(data->tsfn,
114                                          ThreadsafeFunctionCallJS,
115                                          napi_tsfn_nonblocking);
116   if (status != napi_ok) {
117     napi_fatal_error("ThreadSafeFunctionTestThread",
118                      NAPI_AUTO_LENGTH,
119                      "Failed to call TSFN",
120                      NAPI_AUTO_LENGTH);
121   }
122 
123   status = napi_release_threadsafe_function(data->tsfn, napi_tsfn_release);
124   if (status != napi_ok) {
125     napi_fatal_error("ThreadSafeFunctionTestThread",
126                      NAPI_AUTO_LENGTH,
127                      "Failed to release TSFN",
128                      NAPI_AUTO_LENGTH);
129   }
130 
131 }
132 
FinalizeThreadsafeFunction(napi_env env,void * raw,void * hint)133 static void FinalizeThreadsafeFunction(napi_env env, void* raw, void* hint) {
134   AddonData* data;
135   NODE_API_CALL_RETURN_VOID(env, napi_get_instance_data(env, (void**)&data));
136   NODE_API_ASSERT_RETURN_VOID(env,
137       uv_thread_join(&data->thread) == 0, "Failed to join the thread");
138   call_cb_and_delete_ref(env, &data->js_tsfn_finalizer_ref);
139   data->tsfn = NULL;
140 }
141 
142 // Ths function accepts two arguments: the JS callback, and the finalize
143 // callback. The latter moves the test forward.
144 static napi_value
TestThreadsafeFunction(napi_env env,napi_callback_info info)145 TestThreadsafeFunction(napi_env env, napi_callback_info info) {
146   AddonData* data;
147   size_t argc = 2;
148   napi_value argv[2], resource_name;
149 
150   NODE_API_CALL(env, napi_get_cb_info(env, info, &argc, argv, NULL, NULL));
151   NODE_API_CALL(env, napi_get_instance_data(env, (void**)&data));
152   NODE_API_ASSERT(env, data->js_cb_ref == NULL, "reference must be NULL");
153   NODE_API_ASSERT(
154       env, data->js_tsfn_finalizer_ref == NULL,
155       "tsfn finalizer reference must be NULL");
156   NODE_API_CALL(env, napi_create_reference(env, argv[0], 1, &data->js_cb_ref));
157   NODE_API_CALL(env,
158       napi_create_reference(env, argv[1], 1, &data->js_tsfn_finalizer_ref));
159   NODE_API_CALL(env,
160       napi_create_string_utf8(
161           env, "TSFN instance data test", NAPI_AUTO_LENGTH, &resource_name));
162   NODE_API_CALL(env,
163       napi_create_threadsafe_function(
164           env, NULL, NULL, resource_name, 0, 1, NULL,
165           FinalizeThreadsafeFunction, NULL, ThreadsafeFunctionCallJS,
166           &data->tsfn));
167   NODE_API_ASSERT(env,
168       uv_thread_create(&data->thread, ThreadsafeFunctionTestThread, data) == 0,
169       "uv_thread_create failed");
170 
171   return NULL;
172 }
173 
DeleteAddonData(napi_env env,void * raw_data,void * hint)174 static void DeleteAddonData(napi_env env, void* raw_data, void* hint) {
175   AddonData* data = raw_data;
176   if (data->js_cb_ref) {
177     NODE_API_CALL_RETURN_VOID(env, napi_delete_reference(env, data->js_cb_ref));
178   }
179   if (data->js_tsfn_finalizer_ref) {
180     NODE_API_CALL_RETURN_VOID(env,
181         napi_delete_reference(env, data->js_tsfn_finalizer_ref));
182   }
183   free(data);
184 }
185 
Init(napi_env env,napi_value exports)186 static napi_value Init(napi_env env, napi_value exports) {
187   AddonData* data = malloc(sizeof(*data));
188   data->js_cb_ref = NULL;
189   data->js_tsfn_finalizer_ref = NULL;
190 
191   NODE_API_CALL(env, napi_set_instance_data(env, data, DeleteAddonData, NULL));
192 
193   napi_property_descriptor props[] = {
194     DECLARE_NODE_API_PROPERTY("asyncWorkCallback", AsyncWorkCallback),
195     DECLARE_NODE_API_PROPERTY("testBufferFinalizer", TestBufferFinalizer),
196     DECLARE_NODE_API_PROPERTY("testThreadsafeFunction", TestThreadsafeFunction),
197   };
198 
199   NODE_API_CALL(env,
200       napi_define_properties(
201           env, exports, sizeof(props) / sizeof(*props), props));
202 
203   return exports;
204 }
205 
206 NAPI_MODULE(NODE_GYP_MODULE_NAME, Init)
207