Head

GCC Code Coverage Report

Directory:	./		Exec	Total	Coverage
File:	handle_wrap.cc	Lines:	79	83	95.2 %
Date:	2022-06-12 04:16:28	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::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()) {
    tmpl = env->NewFunctionTemplate(nullptr);
    tmpl->SetClassName(FIXED_ONE_BYTE_STRING(env->isolate(), "HandleWrap"));
    tmpl->Inherit(AsyncWrap::GetConstructorTemplate(env));
    env->SetProtoMethod(tmpl, "close", HandleWrap::Close);
    env->SetProtoMethodNoSideEffect(tmpl, "hasRef", HandleWrap::HasRef);
    env->SetProtoMethod(tmpl, "ref", HandleWrap::Ref);
    env->SetProtoMethod(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::Local;
35			using v8::Object;
36			using v8::Value;
37
38
39		24983	void HandleWrap::Ref(const FunctionCallbackInfo<Value>& args) {
40			HandleWrap* wrap;
41	✓✓	24983	ASSIGN_OR_RETURN_UNWRAP(&wrap, args.Holder());
42
43	✓✓	24982	if (IsAlive(wrap))
44		24981	uv_ref(wrap->GetHandle());
45			}
46
47
48		63188	void HandleWrap::Unref(const FunctionCallbackInfo<Value>& args) {
49			HandleWrap* wrap;
50	✓✓	63188	ASSIGN_OR_RETURN_UNWRAP(&wrap, args.Holder());
51
52	✓✓	61069	if (IsAlive(wrap))
53		61067	uv_unref(wrap->GetHandle());
54			}
55
56
57		58	void HandleWrap::HasRef(const FunctionCallbackInfo<Value>& args) {
58			HandleWrap* wrap;
59	✓✓	58	ASSIGN_OR_RETURN_UNWRAP(&wrap, args.Holder());
60	✓✓	110	args.GetReturnValue().Set(HasRef(wrap));
61			}
62
63
64		29606	void HandleWrap::Close(const FunctionCallbackInfo<Value>& args) {
65			HandleWrap* wrap;
66	✓✓	29606	ASSIGN_OR_RETURN_UNWRAP(&wrap, args.Holder());
67
68	✓✗	59210	wrap->Close(args[0]);
69			}
70
71		56265	void HandleWrap::Close(Local<Value> close_callback) {
72	✓✓	56265	if (state_ != kInitialized)
73		508	return;
74
75		55757	uv_close(handle_, OnClose);
76		55757	state_ = kClosing;
77
78	✓✓✓✓ ✓✓	99119	if (!close_callback.IsEmpty() && close_callback->IsFunction() &&
79	✓✗	14256	!persistent().IsEmpty()) {
80		14256	object()->Set(env()->context(),
81			env()->handle_onclose_symbol(),
82		42768	close_callback).Check();
83			}
84			}
85
86
87		55642	void HandleWrap::OnGCCollect() {
88			// When all references to a HandleWrap are lost and the object is supposed to
89			// be destroyed, we first call Close() to clean up the underlying libuv
90			// handle. The OnClose callback then acquires and destroys another reference
91			// to that object, and when that reference is lost, we perform the default
92			// action (i.e. destroying `this`).
93	✓✓	55642	if (state_ != kClosed) {
94		4	Close();
95			} else {
96		55640	BaseObject::OnGCCollect();
97			}
98		55642	}
99
100
101			bool HandleWrap::IsNotIndicativeOfMemoryLeakAtExit() const {
102			return IsWeakOrDetached() \|\|
103			!HandleWrap::HasRef(this) \|\|
104			!uv_is_active(GetHandle());
105			}
106
107
108		1882	void HandleWrap::MarkAsInitialized() {
109		1882	env()->handle_wrap_queue()->PushBack(this);
110		1882	state_ = kInitialized;
111		1882	}
112
113
114		1904	void HandleWrap::MarkAsUninitialized() {
115		1904	handle_wrap_queue_.Remove();
116		1904	state_ = kClosed;
117		1904	}
118
119
120		56357	HandleWrap::HandleWrap(Environment* env,
121			Local<Object> object,
122			uv_handle_t* handle,
123		56357	AsyncWrap::ProviderType provider)
124			: AsyncWrap(env, object, provider),
125			state_(kInitialized),
126		56357	handle_(handle) {
127		56357	handle_->data = this;
128		112714	HandleScope scope(env->isolate());
129	✗✓	56357	CHECK(env->has_run_bootstrapping_code());
130		56357	env->handle_wrap_queue()->PushBack(this);
131		56357	}
132
133
134		55643	void HandleWrap::OnClose(uv_handle_t* handle) {
135	✗✓	55643	CHECK_NOT_NULL(handle->data);
136		111283	BaseObjectPtr<HandleWrap> wrap { static_cast<HandleWrap*>(handle->data) };
137		55643	wrap->Detach();
138
139		55643	Environment* env = wrap->env();
140		111283	HandleScope scope(env->isolate());
141		55643	Context::Scope context_scope(env->context());
142
143	✗✓	55643	CHECK_EQ(wrap->state_, kClosing);
144
145		55643	wrap->state_ = kClosed;
146
147		55643	wrap->OnClose();
148		55643	wrap->handle_wrap_queue_.Remove();
149
150	✓✓	111284	if (!wrap->persistent().IsEmpty() &&
151		166923	wrap->object()->Has(env->context(), env->handle_onclose_symbol())
152	✓✗✓✓ ✓✓	166925	.FromMaybe(false)) {
153		49200	wrap->MakeCallback(env->handle_onclose_symbol(), 0, nullptr);
154			}
155		55640	}
156
157		18181	Local<FunctionTemplate> HandleWrap::GetConstructorTemplate(Environment* env) {
158		18181	Local<FunctionTemplate> tmpl = env->handle_wrap_ctor_template();
159	✓✓	18181	if (tmpl.IsEmpty()) {
160		854	tmpl = env->NewFunctionTemplate(nullptr);
161		854	tmpl->SetClassName(FIXED_ONE_BYTE_STRING(env->isolate(), "HandleWrap"));
162		854	tmpl->Inherit(AsyncWrap::GetConstructorTemplate(env));
163		854	env->SetProtoMethod(tmpl, "close", HandleWrap::Close);
164		854	env->SetProtoMethodNoSideEffect(tmpl, "hasRef", HandleWrap::HasRef);
165		854	env->SetProtoMethod(tmpl, "ref", HandleWrap::Ref);
166		854	env->SetProtoMethod(tmpl, "unref", HandleWrap::Unref);
167		854	env->set_handle_wrap_ctor_template(tmpl);
168			}
169		18181	return tmpl;
170			}
171
172		5204	void HandleWrap::RegisterExternalReferences(
173			ExternalReferenceRegistry* registry) {
174		5204	registry->Register(HandleWrap::Close);
175		5204	registry->Register(HandleWrap::HasRef);
176		5204	registry->Register(HandleWrap::Ref);
177		5204	registry->Register(HandleWrap::Unref);
178		5204	}
179
180			} // namespace node
181
182		5204	NODE_MODULE_EXTERNAL_REFERENCE(handle_wrap,
183			node::HandleWrap::RegisterExternalReferences)