async-wrap: add provider id and object info cb

Re-add the wrapper class id to AsyncWrap instances so they can be tracked directly in a heapdump. Previously the class id was given without setting the heap dump wrapper class info provider. Causing a segfault when a heapdump was taken. This has been added, and the label_ set to the given provider name so each instance can be identified. The id will not be set of the passed object has no internal field count. As the class pointer cannot be retrieved from the object. In order to properly report the allocated size of each class, the new pure virtual method self_size() has been introduces. PR-URL: #1896 Reviewed-By: Ben Noordhuis <[email protected]>

Author: trevnorris

src/async-wrap-inl.h

@@ -18,6 +18,11 @@ inline AsyncWrap::AsyncWrap(Environment* env,
  ProviderType provider,
  AsyncWrap* parent)
  : BaseObject(env, object), bits_(static_cast<uint32_t>(provider) << 1){
+// Only set wrapper class id if object will be Wrap'd.
+if (object->InternalFieldCount() > 0)
+// Shift provider value over to prevent id collision.
+persistent().SetWrapperClassId(NODE_ASYNC_ID_OFFSET + provider);
+
 // Check user controlled flag to see if the init callback should run.
 if (!env->using_asyncwrap())
 return;

src/async-wrap.cc

@@ -6,23 +6,103 @@
 #include"util-inl.h"
 
 #include"v8.h"
+#include"v8-profiler.h"
 
 using v8::Array;
 using v8::Context;
 using v8::Function;
 using v8::FunctionCallbackInfo;
 using v8::Handle;
 using v8::HandleScope;
+using v8::HeapProfiler;
 using v8::Integer;
 using v8::Isolate;
 using v8::Local;
 using v8::Object;
+using v8::RetainedObjectInfo;
 using v8::TryCatch;
 using v8::Value;
 using v8::kExternalUint32Array;
 
 namespacenode{
 
+staticconstchar* const provider_names[] ={
+#defineV(PROVIDER) \
+ #PROVIDER,
+NODE_ASYNC_PROVIDER_TYPES(V)
+#undef V
+};
+
+
+classRetainedAsyncInfo: publicRetainedObjectInfo{
+public:
+explicitRetainedAsyncInfo(uint16_t class_id, AsyncWrap* wrap);
+
+virtualvoidDispose() override;
+virtualboolIsEquivalent(RetainedObjectInfo* other) override;
+virtualintptr_tGetHash() override;
+virtualconstchar* GetLabel() override;
+virtualintptr_tGetSizeInBytes() override;
+
+private:
+constchar* label_;
+const AsyncWrap* wrap_;
+constint length_;
+};
+
+
+RetainedAsyncInfo::RetainedAsyncInfo(uint16_t class_id, AsyncWrap* wrap)
+ : label_(provider_names[class_id - NODE_ASYNC_ID_OFFSET]),
+wrap_(wrap),
+ length_(wrap->self_size()){
+}
+
+
+voidRetainedAsyncInfo::Dispose(){
+deletethis;
+}
+
+
+boolRetainedAsyncInfo::IsEquivalent(RetainedObjectInfo* other){
+return label_ == other->GetLabel() &&
+ wrap_ == static_cast<RetainedAsyncInfo*>(other)->wrap_;
+}
+
+
+intptr_tRetainedAsyncInfo::GetHash(){
+returnreinterpret_cast<intptr_t>(wrap_);
+}
+
+
+constchar* RetainedAsyncInfo::GetLabel(){
+return label_;
+}
+
+
+intptr_tRetainedAsyncInfo::GetSizeInBytes(){
+return length_;
+}
+
+
+RetainedObjectInfo* WrapperInfo(uint16_t class_id, Handle<Value> wrapper){
+// No class_id should be the provider type of NONE.
+CHECK_NE(NODE_ASYNC_ID_OFFSET, class_id);
+CHECK(wrapper->IsObject());
+CHECK(!wrapper.IsEmpty());
+
+ Local<Object> object = wrapper.As<Object>();
+CHECK_GT(object->InternalFieldCount(), 0);
+
+ AsyncWrap* wrap = Unwrap<AsyncWrap>(object);
+CHECK_NE(nullptr, wrap);
+
+returnnewRetainedAsyncInfo(class_id, wrap);
+}
+
+
+// end RetainedAsyncInfo
+
+
 staticvoidEnableHooksJS(const FunctionCallbackInfo<Value>& args){
  Environment* env = Environment::GetCurrent(args);
  env->async_hooks()->set_enable_callbacks(1);
@@ -71,6 +151,16 @@ static void Initialize(Handle<Object> target,
 }
 
 
+voidLoadAsyncWrapperInfo(Environment* env){
+ HeapProfiler* heap_profiler = env->isolate()->GetHeapProfiler();
+#defineV(PROVIDER) \
+ heap_profiler->SetWrapperClassInfoProvider( \
+ (NODE_ASYNC_ID_OFFSET + AsyncWrap::PROVIDER_ ## PROVIDER), WrapperInfo);
+NODE_ASYNC_PROVIDER_TYPES(V)
+#undef V
+}
+
+
 Handle<Value> AsyncWrap::MakeCallback(const Handle<Function> cb,
 int argc,
  Handle<Value>* argv){

src/async-wrap.h

@@ -8,6 +8,8 @@
 
 namespacenode{
 
+#defineNODE_ASYNC_ID_OFFSET0xA1C
+
 #defineNODE_ASYNC_PROVIDER_TYPES(V) \
 V(NONE) \
 V(CARES) \
@@ -64,6 +66,8 @@ class AsyncWrap : public BaseObject{
 int argc,
  v8::Handle<v8::Value>* argv);
 
+virtualsize_tself_size() const = 0;
+
 private:
 inlineAsyncWrap();
 inlineboolhas_async_queue() const;
@@ -74,6 +78,8 @@ class AsyncWrap : public BaseObject{
 uint32_t bits_;
 };
 
+voidLoadAsyncWrapperInfo(Environment* env);
+
 } // namespace node
 
 

src/cares_wrap.cc

@@ -51,6 +51,8 @@ using v8::Value;
 classGetAddrInfoReqWrap : publicReqWrap<uv_getaddrinfo_t>{
 public:
 GetAddrInfoReqWrap(Environment* env, Local<Object> req_wrap_obj);
+
+size_tself_size() constoverride{returnsizeof(*this)}
 };
 
 GetAddrInfoReqWrap::GetAddrInfoReqWrap(Environment* env,
@@ -66,8 +68,10 @@ static void NewGetAddrInfoReqWrap(const FunctionCallbackInfo<Value>& args){
 
 
 classGetNameInfoReqWrap : publicReqWrap<uv_getnameinfo_t>{
-public:
-GetNameInfoReqWrap(Environment* env, Local<Object> req_wrap_obj);
+public:
+GetNameInfoReqWrap(Environment* env, Local<Object> req_wrap_obj);
+
+size_tself_size() constoverride{returnsizeof(*this)}
 };
 
 GetNameInfoReqWrap::GetNameInfoReqWrap(Environment* env,
@@ -385,6 +389,8 @@ class QueryAWrap: public QueryWrap{
 return0;
  }
 
+size_tself_size() constoverride{returnsizeof(*this)}
+
 protected:
 voidParse(unsignedchar* buf, int len) override{
  HandleScope handle_scope(env()->isolate());
@@ -422,6 +428,8 @@ class QueryAaaaWrap: public QueryWrap{
 return0;
  }
 
+size_tself_size() constoverride{returnsizeof(*this)}
+
 protected:
 voidParse(unsignedchar* buf, int len) override{
  HandleScope handle_scope(env()->isolate());
@@ -459,6 +467,8 @@ class QueryCnameWrap: public QueryWrap{
 return0;
  }
 
+size_tself_size() constoverride{returnsizeof(*this)}
+
 protected:
 voidParse(unsignedchar* buf, int len) override{
  HandleScope handle_scope(env()->isolate());
@@ -498,6 +508,8 @@ class QueryMxWrap: public QueryWrap{
 return0;
  }
 
+size_tself_size() constoverride{returnsizeof(*this)}
+
 protected:
 voidParse(unsignedchar* buf, int len) override{
  HandleScope handle_scope(env()->isolate());
@@ -547,6 +559,8 @@ class QueryNsWrap: public QueryWrap{
 return0;
  }
 
+size_tself_size() constoverride{returnsizeof(*this)}
+
 protected:
 voidParse(unsignedchar* buf, int len) override{
  HandleScope handle_scope(env()->isolate());
@@ -583,6 +597,8 @@ class QueryTxtWrap: public QueryWrap{
 return0;
  }
 
+size_tself_size() constoverride{returnsizeof(*this)}
+
 protected:
 voidParse(unsignedchar* buf, int len) override{
  HandleScope handle_scope(env()->isolate());
@@ -638,6 +654,8 @@ class QuerySrvWrap: public QueryWrap{
 return0;
  }
 
+size_tself_size() constoverride{returnsizeof(*this)}
+
 protected:
 voidParse(unsignedchar* buf, int len) override{
  HandleScope handle_scope(env()->isolate());
@@ -692,6 +710,8 @@ class QueryNaptrWrap: public QueryWrap{
 return0;
  }
 
+size_tself_size() constoverride{returnsizeof(*this)}
+
 protected:
 voidParse(unsignedchar* buf, int len) override{
  HandleScope handle_scope(env()->isolate());
@@ -754,6 +774,8 @@ class QuerySoaWrap: public QueryWrap{
 return0;
  }
 
+size_tself_size() constoverride{returnsizeof(*this)}
+
 protected:
 voidParse(unsignedchar* buf, int len) override{
  HandleScope handle_scope(env()->isolate());
@@ -820,6 +842,8 @@ class GetHostByAddrWrap: public QueryWrap{
 return0;
  }
 
+size_tself_size() constoverride{returnsizeof(*this)}
+
 protected:
 voidParse(structhostent* host) override{
  HandleScope handle_scope(env()->isolate());

src/fs_event_wrap.cc

@@ -31,6 +31,8 @@ class FSEventWrap: public HandleWrap{
 staticvoidStart(const FunctionCallbackInfo<Value>& args);
 staticvoidClose(const FunctionCallbackInfo<Value>& args);
 
+size_tself_size() constoverride{returnsizeof(*this)}
+
 private:
 FSEventWrap(Environment* env, Handle<Object> object);
 virtual~FSEventWrap() override;

src/js_stream.h

@@ -28,6 +28,8 @@ class JSStream : public StreamBase, public AsyncWrap{
 size_t count,
 uv_stream_t* send_handle) override;
 
+size_tself_size() constoverride{returnsizeof(*this)}
+
 protected:
 JSStream(Environment* env, v8::Handle<v8::Object> obj, AsyncWrap* parent);
 

src/node.cc

@@ -3872,6 +3872,7 @@ Environment* CreateEnvironment(Isolate* isolate,
  env->set_process_object(process_object);
 
 SetupProcessObject(env, argc, argv, exec_argc, exec_argv);
+LoadAsyncWrapperInfo(env);
 
 return env;
 }

src/node_crypto.cc

@@ -4546,6 +4546,8 @@ class PBKDF2Request : public AsyncWrap{
  error_ = err;
  }
 
+size_tself_size() constoverride{returnsizeof(*this)}
+
 uv_work_t work_req_;
 
 private:
@@ -4776,6 +4778,8 @@ class RandomBytesRequest : public AsyncWrap{
  error_ = err;
  }
 
+size_tself_size() constoverride{returnsizeof(*this)}
+
 uv_work_t work_req_;
 
 private:

src/node_crypto.h

@@ -308,6 +308,8 @@ class Connection : public SSLWrap<Connection>, public AsyncWrap{
  v8::Persistent<v8::String> servername_;
 #endif
 
+size_tself_size() constoverride{returnsizeof(*this)}
+
 protected:
 staticvoidNew(const v8::FunctionCallbackInfo<v8::Value>& args);
 staticvoidEncIn(const v8::FunctionCallbackInfo<v8::Value>& args);
@@ -702,6 +704,8 @@ class Certificate : public AsyncWrap{
 constchar* ExportPublicKey(constchar* data, int len);
 constchar* ExportChallenge(constchar* data, int len);
 
+size_tself_size() constoverride{returnsizeof(*this)}
+
 protected:
 staticvoidNew(const v8::FunctionCallbackInfo<v8::Value>& args);
 staticvoidVerifySpkac(const v8::FunctionCallbackInfo<v8::Value>& args);

src/node_file.cc

@@ -73,6 +73,8 @@ class FSReqWrap: public ReqWrap<uv_fs_t>{
 constchar* syscall() const{return syscall_}
 constchar* data() const{return data_}
 
+size_tself_size() constoverride{returnsizeof(*this)}
+
 private:
 FSReqWrap(Environment* env,
  Local<Object> req,