Head

GCC Code Coverage Report

Directory:	./		Exec	Total	Coverage
File:	handle_wrap.cc	Lines:	80	84	95.2 %
Date:	2022-08-21 04:19:51	Branches:	38	50	76.0 %


// Copyright Joyent, Inc. and other Node contributors.
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to permit
// persons to whom the Software is furnished to do so, subject to the
// following conditions:
//
// The above copyright notice and this permission notice shall be included
// in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
// NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
// USE OR OTHER DEALINGS IN THE SOFTWARE.

#include "handle_wrap.h"
#include "async_wrap-inl.h"
#include "env-inl.h"
#include "node_external_reference.h"
#include "util-inl.h"

namespace node {

using v8::Context;
using v8::FunctionCallbackInfo;
using v8::FunctionTemplate;
using v8::HandleScope;
using v8::Isolate;
using v8::Local;
using v8::Object;
using v8::Value;


void HandleWrap::Ref(const FunctionCallbackInfo<Value>& args) {
  HandleWrap* wrap;
  ASSIGN_OR_RETURN_UNWRAP(&wrap, args.Holder());

  if (IsAlive(wrap))
    uv_ref(wrap->GetHandle());
}


void HandleWrap::Unref(const FunctionCallbackInfo<Value>& args) {
  HandleWrap* wrap;
  ASSIGN_OR_RETURN_UNWRAP(&wrap, args.Holder());

  if (IsAlive(wrap))
    uv_unref(wrap->GetHandle());
}


void HandleWrap::HasRef(const FunctionCallbackInfo<Value>& args) {
  HandleWrap* wrap;
  ASSIGN_OR_RETURN_UNWRAP(&wrap, args.Holder());
  args.GetReturnValue().Set(HasRef(wrap));
}


void HandleWrap::Close(const FunctionCallbackInfo<Value>& args) {
  HandleWrap* wrap;
  ASSIGN_OR_RETURN_UNWRAP(&wrap, args.Holder());

  wrap->Close(args[0]);
}

void HandleWrap::Close(Local<Value> close_callback) {
  if (state_ != kInitialized)
    return;

  uv_close(handle_, OnClose);
  state_ = kClosing;

  if (!close_callback.IsEmpty() && close_callback->IsFunction() &&
      !persistent().IsEmpty()) {
    object()->Set(env()->context(),
                  env()->handle_onclose_symbol(),
                  close_callback).Check();
  }
}


void HandleWrap::OnGCCollect() {
  // When all references to a HandleWrap are lost and the object is supposed to
  // be destroyed, we first call Close() to clean up the underlying libuv
  // handle. The OnClose callback then acquires and destroys another reference
  // to that object, and when that reference is lost, we perform the default
  // action (i.e. destroying `this`).
  if (state_ != kClosed) {
    Close();
  } else {
    BaseObject::OnGCCollect();
  }
}


bool HandleWrap::IsNotIndicativeOfMemoryLeakAtExit() const {
  return IsWeakOrDetached() ||
         !HandleWrap::HasRef(this) ||
         !uv_is_active(GetHandle());
}


void HandleWrap::MarkAsInitialized() {
  env()->handle_wrap_queue()->PushBack(this);
  state_ = kInitialized;
}


void HandleWrap::MarkAsUninitialized() {
  handle_wrap_queue_.Remove();
  state_ = kClosed;
}


HandleWrap::HandleWrap(Environment* env,
                       Local<Object> object,
                       uv_handle_t* handle,
                       AsyncWrap::ProviderType provider)
    : AsyncWrap(env, object, provider),
      state_(kInitialized),
      handle_(handle) {
  handle_->data = this;
  HandleScope scope(env->isolate());
  CHECK(env->has_run_bootstrapping_code());
  env->handle_wrap_queue()->PushBack(this);
}


void HandleWrap::OnClose(uv_handle_t* handle) {
  CHECK_NOT_NULL(handle->data);
  BaseObjectPtr<HandleWrap> wrap { static_cast<HandleWrap*>(handle->data) };
  wrap->Detach();

  Environment* env = wrap->env();
  HandleScope scope(env->isolate());
  Context::Scope context_scope(env->context());

  CHECK_EQ(wrap->state_, kClosing);

  wrap->state_ = kClosed;

  wrap->OnClose();
  wrap->handle_wrap_queue_.Remove();

  if (!wrap->persistent().IsEmpty() &&
      wrap->object()->Has(env->context(), env->handle_onclose_symbol())
      .FromMaybe(false)) {
    wrap->MakeCallback(env->handle_onclose_symbol(), 0, nullptr);
  }
}

Local<FunctionTemplate> HandleWrap::GetConstructorTemplate(Environment* env) {
  Local<FunctionTemplate> tmpl = env->handle_wrap_ctor_template();
  if (tmpl.IsEmpty()) {
    Isolate* isolate = env->isolate();
    tmpl = NewFunctionTemplate(isolate, nullptr);
    tmpl->SetClassName(FIXED_ONE_BYTE_STRING(env->isolate(), "HandleWrap"));
    tmpl->Inherit(AsyncWrap::GetConstructorTemplate(env));
    SetProtoMethod(isolate, tmpl, "close", HandleWrap::Close);
    SetProtoMethodNoSideEffect(isolate, tmpl, "hasRef", HandleWrap::HasRef);
    SetProtoMethod(isolate, tmpl, "ref", HandleWrap::Ref);
    SetProtoMethod(isolate, tmpl, "unref", HandleWrap::Unref);
    env->set_handle_wrap_ctor_template(tmpl);
  }
  return tmpl;
}

void HandleWrap::RegisterExternalReferences(
    ExternalReferenceRegistry* registry) {
  registry->Register(HandleWrap::Close);
  registry->Register(HandleWrap::HasRef);
  registry->Register(HandleWrap::Ref);
  registry->Register(HandleWrap::Unref);
}

}  // namespace node

NODE_MODULE_EXTERNAL_REFERENCE(handle_wrap,
                               node::HandleWrap::RegisterExternalReferences)


Generated by: GCOVR (Version 4.2)

Line	Branch	Exec	Source
1			// Copyright Joyent, Inc. and other Node contributors.
2			//
3			// Permission is hereby granted, free of charge, to any person obtaining a
4			// copy of this software and associated documentation files (the
5			// "Software"), to deal in the Software without restriction, including
6			// without limitation the rights to use, copy, modify, merge, publish,
7			// distribute, sublicense, and/or sell copies of the Software, and to permit
8			// persons to whom the Software is furnished to do so, subject to the
9			// following conditions:
10			//
11			// The above copyright notice and this permission notice shall be included
12			// in all copies or substantial portions of the Software.
13			//
14			// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
15			// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16			// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
17			// NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18			// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
19			// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20			// USE OR OTHER DEALINGS IN THE SOFTWARE.
21
22			#include "handle_wrap.h"
23			#include "async_wrap-inl.h"
24			#include "env-inl.h"
25			#include "node_external_reference.h"
26			#include "util-inl.h"
27
28			namespace node {
29
30			using v8::Context;
31			using v8::FunctionCallbackInfo;
32			using v8::FunctionTemplate;
33			using v8::HandleScope;
34			using v8::Isolate;
35			using v8::Local;
36			using v8::Object;
37			using v8::Value;
38
39
40		24788	void HandleWrap::Ref(const FunctionCallbackInfo<Value>& args) {
41			HandleWrap* wrap;
42	✓✓	24788	ASSIGN_OR_RETURN_UNWRAP(&wrap, args.Holder());
43
44	✓✓	24787	if (IsAlive(wrap))
45		24786	uv_ref(wrap->GetHandle());
46			}
47
48
49		63241	void HandleWrap::Unref(const FunctionCallbackInfo<Value>& args) {
50			HandleWrap* wrap;
51	✓✓	63241	ASSIGN_OR_RETURN_UNWRAP(&wrap, args.Holder());
52
53	✓✓	61363	if (IsAlive(wrap))
54		61361	uv_unref(wrap->GetHandle());
55			}
56
57
58		63	void HandleWrap::HasRef(const FunctionCallbackInfo<Value>& args) {
59			HandleWrap* wrap;
60	✓✓	63	ASSIGN_OR_RETURN_UNWRAP(&wrap, args.Holder());
61	✓✓	120	args.GetReturnValue().Set(HasRef(wrap));
62			}
63
64
65		28833	void HandleWrap::Close(const FunctionCallbackInfo<Value>& args) {
66			HandleWrap* wrap;
67	✓✓	28833	ASSIGN_OR_RETURN_UNWRAP(&wrap, args.Holder());
68
69	✓✗	57664	wrap->Close(args[0]);
70			}
71
72		56068	void HandleWrap::Close(Local<Value> close_callback) {
73	✓✓	56068	if (state_ != kInitialized)
74		515	return;
75
76		55553	uv_close(handle_, OnClose);
77		55553	state_ = kClosing;
78
79	✓✓✓✓ ✓✓	97180	if (!close_callback.IsEmpty() && close_callback->IsFunction() &&
80	✓✗	13301	!persistent().IsEmpty()) {
81		13301	object()->Set(env()->context(),
82			env()->handle_onclose_symbol(),
83		39903	close_callback).Check();
84			}
85			}
86
87
88		55431	void HandleWrap::OnGCCollect() {
89			// When all references to a HandleWrap are lost and the object is supposed to
90			// be destroyed, we first call Close() to clean up the underlying libuv
91			// handle. The OnClose callback then acquires and destroys another reference
92			// to that object, and when that reference is lost, we perform the default
93			// action (i.e. destroying `this`).
94	✓✓	55431	if (state_ != kClosed) {
95		4	Close();
96			} else {
97		55429	BaseObject::OnGCCollect();
98			}
99		55431	}
100
101
102			bool HandleWrap::IsNotIndicativeOfMemoryLeakAtExit() const {
103			return IsWeakOrDetached() \|\|
104			!HandleWrap::HasRef(this) \|\|
105			!uv_is_active(GetHandle());
106			}
107
108
109		1978	void HandleWrap::MarkAsInitialized() {
110		1978	env()->handle_wrap_queue()->PushBack(this);
111		1978	state_ = kInitialized;
112		1978	}
113
114
115		2000	void HandleWrap::MarkAsUninitialized() {
116		2000	handle_wrap_queue_.Remove();
117		2000	state_ = kClosed;
118		2000	}
119
120
121		56212	HandleWrap::HandleWrap(Environment* env,
122			Local<Object> object,
123			uv_handle_t* handle,
124		56212	AsyncWrap::ProviderType provider)
125			: AsyncWrap(env, object, provider),
126			state_(kInitialized),
127		56212	handle_(handle) {
128		56212	handle_->data = this;
129		112424	HandleScope scope(env->isolate());
130	✗✓	56212	CHECK(env->has_run_bootstrapping_code());
131		56212	env->handle_wrap_queue()->PushBack(this);
132		56212	}
133
134
135		55433	void HandleWrap::OnClose(uv_handle_t* handle) {
136	✗✓	55433	CHECK_NOT_NULL(handle->data);
137		110862	BaseObjectPtr<HandleWrap> wrap { static_cast<HandleWrap*>(handle->data) };
138		55433	wrap->Detach();
139
140		55433	Environment* env = wrap->env();
141		110862	HandleScope scope(env->isolate());
142		55433	Context::Scope context_scope(env->context());
143
144	✗✓	55433	CHECK_EQ(wrap->state_, kClosing);
145
146		55433	wrap->state_ = kClosed;
147
148		55433	wrap->OnClose();
149		55433	wrap->handle_wrap_queue_.Remove();
150
151	✓✓	110864	if (!wrap->persistent().IsEmpty() &&
152		166293	wrap->object()->Has(env->context(), env->handle_onclose_symbol())
153	✓✗✓✓ ✓✓	166295	.FromMaybe(false)) {
154		47876	wrap->MakeCallback(env->handle_onclose_symbol(), 0, nullptr);
155			}
156		55429	}
157
158		18055	Local<FunctionTemplate> HandleWrap::GetConstructorTemplate(Environment* env) {
159		18055	Local<FunctionTemplate> tmpl = env->handle_wrap_ctor_template();
160	✓✓	18055	if (tmpl.IsEmpty()) {
161		775	Isolate* isolate = env->isolate();
162		775	tmpl = NewFunctionTemplate(isolate, nullptr);
163		775	tmpl->SetClassName(FIXED_ONE_BYTE_STRING(env->isolate(), "HandleWrap"));
164		775	tmpl->Inherit(AsyncWrap::GetConstructorTemplate(env));
165		775	SetProtoMethod(isolate, tmpl, "close", HandleWrap::Close);
166		775	SetProtoMethodNoSideEffect(isolate, tmpl, "hasRef", HandleWrap::HasRef);
167		775	SetProtoMethod(isolate, tmpl, "ref", HandleWrap::Ref);
168		775	SetProtoMethod(isolate, tmpl, "unref", HandleWrap::Unref);
169		775	env->set_handle_wrap_ctor_template(tmpl);
170			}
171		18055	return tmpl;
172			}
173
174		5357	void HandleWrap::RegisterExternalReferences(
175			ExternalReferenceRegistry* registry) {
176		5357	registry->Register(HandleWrap::Close);
177		5357	registry->Register(HandleWrap::HasRef);
178		5357	registry->Register(HandleWrap::Ref);
179		5357	registry->Register(HandleWrap::Unref);
180		5357	}
181
182			} // namespace node
183
184		5357	NODE_MODULE_EXTERNAL_REFERENCE(handle_wrap,
185			node::HandleWrap::RegisterExternalReferences)