Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

napi: add finalize hint support #155

Merged
merged 2 commits into from
Mar 16, 2017
Merged

napi: add finalize hint support #155

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1af6489
napi: add finalize hint support
digitalinfinity Mar 16, 2017
58f13cf
Fix comment position
digitalinfinity Mar 16, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 35 additions & 9 deletions src/node_jsvmapi.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,13 +141,15 @@ class Reference {
int initialRefcount,
bool deleteSelf,
napi_finalize finalizeCallback = nullptr,
void* finalizeData = nullptr)
: _isolate(isolate),
void* finalizeData = nullptr,
void* finalizeHint = nullptr)
: _isolate(isolate),
_persistent(isolate, value),
_refcount(initialRefcount),
_deleteSelf(deleteSelf),
_finalizeCallback(finalizeCallback),
_finalizeData(finalizeData) {
_finalizeData(finalizeData),
_finalizeHint(finalizeHint) {
if (initialRefcount == 0) {
if (_finalizeCallback != nullptr || _deleteSelf) {
_persistent.SetWeak(
Expand Down Expand Up @@ -209,7 +211,8 @@ class Reference {
bool deleteSelf = reference->_deleteSelf;

if (reference->_finalizeCallback != nullptr) {
reference->_finalizeCallback(reference->_finalizeData);
reference->_finalizeCallback(reference->_finalizeData,
reference->_finalizeHint);
}

if (deleteSelf) {
Expand All @@ -223,6 +226,7 @@ class Reference {
bool _deleteSelf;
napi_finalize _finalizeCallback;
void* _finalizeData;
void* _finalizeHint;
};

class TryCatch : public v8::TryCatch {
Expand Down Expand Up @@ -1733,6 +1737,7 @@ napi_status napi_wrap(napi_env e,
napi_value jsObject,
void* nativeObj,
napi_finalize finalize_cb,
void* finalize_hint,
napi_ref* result) {
NAPI_PREAMBLE(e);
CHECK_ARG(jsObject);
Expand All @@ -1751,7 +1756,13 @@ napi_status napi_wrap(napi_env e,
// Create a separate self-deleting reference for the finalizer callback.
// This ensures the finalizer is not dependent on the lifetime of the
// returned reference.
new v8impl::Reference(isolate, obj, 0, true, finalize_cb, nativeObj);
new v8impl::Reference(isolate,
obj,
0,
true,
finalize_cb,
nativeObj,
finalize_hint);
}

if (result != nullptr) {
Expand All @@ -1761,7 +1772,7 @@ napi_status napi_wrap(napi_env e,
// deleted via
// napi_delete_reference() when it is no longer needed.
v8impl::Reference* reference =
new v8impl::Reference(isolate, obj, 0, false, nullptr, nullptr);
new v8impl::Reference(isolate, obj, 0, false);
*result = reinterpret_cast<napi_ref>(reference);
}

Expand Down Expand Up @@ -1789,6 +1800,7 @@ napi_status napi_unwrap(napi_env e, napi_value jsObject, void** result) {
napi_status napi_create_external(napi_env e,
void* data,
napi_finalize finalize_cb,
void* finalize_hint,
napi_value* result) {
NAPI_PREAMBLE(e);
CHECK_ARG(result);
Expand All @@ -1799,7 +1811,13 @@ napi_status napi_create_external(napi_env e,

// The Reference object will delete itself after invoking the finalizer
// callback.
new v8impl::Reference(isolate, externalValue, 0, true, finalize_cb, data);
new v8impl::Reference(isolate,
externalValue,
0,
true,
finalize_cb,
data,
finalize_hint);

*result = v8impl::JsValueFromV8LocalValue(externalValue);

Expand Down Expand Up @@ -2126,6 +2144,7 @@ napi_status napi_create_external_buffer(napi_env e,
size_t size,
void* data,
napi_finalize finalize_cb,
void* finalize_hint,
napi_value* result) {
NAPI_PREAMBLE(e);
CHECK_ARG(result);
Expand All @@ -2134,7 +2153,7 @@ napi_status napi_create_external_buffer(napi_env e,
static_cast<char*>(data),
size,
(node::Buffer::FreeCallback)finalize_cb,
nullptr);
finalize_hint);

CHECK_MAYBE_EMPTY(maybe, napi_generic_failure);

Expand Down Expand Up @@ -2220,6 +2239,7 @@ napi_status napi_create_external_arraybuffer(napi_env e,
void* external_data,
size_t byte_length,
napi_finalize finalize_cb,
void* finalize_hint,
napi_value* result) {
NAPI_PREAMBLE(e);
CHECK_ARG(result);
Expand All @@ -2231,7 +2251,13 @@ napi_status napi_create_external_arraybuffer(napi_env e,
if (finalize_cb != nullptr) {
// Create a self-deleting weak reference that invokes the finalizer
// callback.
new v8impl::Reference(isolate, buffer, 0, true, finalize_cb, external_data);
new v8impl::Reference(isolate,
buffer,
0,
true,
finalize_cb,
external_data,
finalize_hint);
}

*result = v8impl::JsValueFromV8LocalValue(buffer);
Expand Down
4 changes: 4 additions & 0 deletions src/node_jsvmapi.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -310,13 +310,15 @@ NODE_EXTERN napi_status napi_wrap(napi_env e,
napi_value jsObject,
void* nativeObj,
napi_finalize finalize_cb,
void* finalize_hint,
napi_ref* result);
NODE_EXTERN napi_status napi_unwrap(napi_env e,
napi_value jsObject,
void** result);
NODE_EXTERN napi_status napi_create_external(napi_env e,
void* data,
napi_finalize finalize_cb,
void* finalize_hint,
napi_value* result);
NODE_EXTERN napi_status napi_get_value_external(napi_env e,
napi_value v,
Expand Down Expand Up @@ -393,6 +395,7 @@ NODE_EXTERN napi_status napi_create_external_buffer(napi_env e,
size_t size,
void* data,
napi_finalize finalize_cb,
void* finalize_hint,
napi_value* result);
NODE_EXTERN napi_status napi_create_buffer_copy(napi_env e,
const void* data,
Expand All @@ -417,6 +420,7 @@ napi_create_external_arraybuffer(napi_env env,
void* external_data,
size_t byte_length,
napi_finalize finalize_cb,
void* finalize_hint,
napi_value* result);
NODE_EXTERN napi_status napi_get_arraybuffer_info(napi_env env,
napi_value arraybuffer,
Expand Down
2 changes: 1 addition & 1 deletion src/node_jsvmapi_types.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ typedef struct napi_propertyname__ *napi_propertyname;
typedef struct napi_callback_info__ *napi_callback_info;

typedef void (*napi_callback)(napi_env, napi_callback_info);
typedef void (*napi_finalize)(void* v);
typedef void (*napi_finalize)(void* finalize_data, void* finalize_hint);

enum napi_property_attributes {
napi_default = 0,
Expand Down
3 changes: 2 additions & 1 deletion test/addons-abi/6_object_wrap/myobject.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ MyObject::MyObject(double value)

MyObject::~MyObject() { napi_delete_reference(env_, wrapper_); }

void MyObject::Destructor(void* nativeObject) {
void MyObject::Destructor(void* nativeObject, void* /*finalize_hint*/) {
reinterpret_cast<MyObject*>(nativeObject)->~MyObject();
}

Expand Down Expand Up @@ -70,6 +70,7 @@ void MyObject::New(napi_env env, napi_callback_info info) {
jsthis,
reinterpret_cast<void*>(obj),
MyObject::Destructor,
nullptr, // finalize_hint
&obj->wrapper_);
if (status != napi_ok) return;

Expand Down
2 changes: 1 addition & 1 deletion test/addons-abi/6_object_wrap/myobject.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
class MyObject {
public:
static void Init(napi_env env, napi_value exports);
static void Destructor(void* nativeObject);
static void Destructor(void* nativeObject, void* finalize_hint);

private:
explicit MyObject(double value_ = 0);
Expand Down
3 changes: 2 additions & 1 deletion test/addons-abi/7_factory_wrap/myobject.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ MyObject::MyObject() : env_(nullptr), wrapper_(nullptr) {}

MyObject::~MyObject() { napi_delete_reference(env_, wrapper_); }

void MyObject::Destructor(void* nativeObject) {
void MyObject::Destructor(void* nativeObject, void* /*finalize_hint*/) {
reinterpret_cast<MyObject*>(nativeObject)->~MyObject();
}

Expand Down Expand Up @@ -56,6 +56,7 @@ void MyObject::New(napi_env env, napi_callback_info info) {
jsthis,
reinterpret_cast<void*>(obj),
MyObject::Destructor,
nullptr, /* finalize_hint */
&obj->wrapper_);
if (status != napi_ok) return;

Expand Down
2 changes: 1 addition & 1 deletion test/addons-abi/7_factory_wrap/myobject.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
class MyObject {
public:
static napi_status Init(napi_env env);
static void Destructor(void* nativeObject);
static void Destructor(void* nativeObject, void* /*finalize_hint*/);
static napi_status NewInstance(napi_env env,
napi_value arg,
napi_value* instance);
Expand Down
3 changes: 2 additions & 1 deletion test/addons-abi/8_passing_wrapped/myobject.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ MyObject::MyObject() : env_(nullptr), wrapper_(nullptr) {}

MyObject::~MyObject() { napi_delete_reference(env_, wrapper_); }

void MyObject::Destructor(void* nativeObject) {
void MyObject::Destructor(void* nativeObject, void* /*finalize_hint*/) {
reinterpret_cast<MyObject*>(nativeObject)->~MyObject();
}

Expand Down Expand Up @@ -53,6 +53,7 @@ void MyObject::New(napi_env env, napi_callback_info info) {
jsthis,
reinterpret_cast<void*>(obj),
MyObject::Destructor,
nullptr, // finalize_hint
&obj->wrapper_);
if (status != napi_ok) return;

Expand Down
2 changes: 1 addition & 1 deletion test/addons-abi/8_passing_wrapped/myobject.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
class MyObject {
public:
static napi_status Init(napi_env env);
static void Destructor(void* nativeObject);
static void Destructor(void* nativeObject, void* finalize_hint);
static napi_status NewInstance(napi_env env,
napi_value arg,
napi_value* instance);
Expand Down
12 changes: 9 additions & 3 deletions test/addons-abi/test_buffer/test_buffer.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,12 @@ static const char theText[] =
"Lorem ipsum dolor sit amet, consectetur adipiscing elit.";

static int deleterCallCount = 0;
static void deleteTheText(void *data) {
static void deleteTheText(void *data, void* /*finalize_hint*/) {
delete reinterpret_cast<char *>(data);
deleterCallCount++;
}

static void noopDeleter(void *data) { deleterCallCount++; }
static void noopDeleter(void *data, void* /*finalize_hint*/) { deleterCallCount++; }

void newBuffer(napi_env env, napi_callback_info info) {
napi_value theBuffer;
Expand All @@ -52,7 +52,12 @@ void newExternalBuffer(napi_env env, napi_callback_info info) {
JS_ASSERT(env, theCopy, "Failed to copy static text for newExternalBuffer");
NAPI_CALL(env,
napi_create_external_buffer(
env, sizeof(theText), theCopy, deleteTheText, &theBuffer));
env,
sizeof(theText),
theCopy,
deleteTheText,
nullptr, // finalize_hint
&theBuffer));
NAPI_CALL(env, napi_set_return_value(env, info, theBuffer));
}

Expand Down Expand Up @@ -116,6 +121,7 @@ void staticBuffer(napi_env env, napi_callback_info info) {
sizeof(theText),
const_cast<char *>(theText),
noopDeleter,
nullptr, // finalize_hint
&theBuffer));
NAPI_CALL(env, napi_set_return_value(env, info, theBuffer));
}
Expand Down
7 changes: 6 additions & 1 deletion test/addons-abi/test_typedarray/test_typedarray.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,12 @@ void External(napi_env env, napi_callback_info info) {

napi_value output_buffer;
napi_status status = napi_create_external_arraybuffer(
env, externalData, sizeof(externalData), nullptr, &output_buffer);
env,
externalData,
sizeof(externalData),
nullptr, // finalize_callback
nullptr, // finalize_hint
&output_buffer);
if (status != napi_ok) return;

napi_value output_array;
Expand Down