GCC Code Coverage Report
Directory: ./ Exec Total Coverage
File: handle_wrap.cc Lines: 79 83 95.2 %
Date: 2022-06-03 04:15:39 Branches: 38 50 76.0 %

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
24966
void HandleWrap::Ref(const FunctionCallbackInfo<Value>& args) {
40
  HandleWrap* wrap;
41
24966
  ASSIGN_OR_RETURN_UNWRAP(&wrap, args.Holder());
42
43
24965
  if (IsAlive(wrap))
44
24964
    uv_ref(wrap->GetHandle());
45
}
46
47
48
63109
void HandleWrap::Unref(const FunctionCallbackInfo<Value>& args) {
49
  HandleWrap* wrap;
50
63109
  ASSIGN_OR_RETURN_UNWRAP(&wrap, args.Holder());
51
52
61004
  if (IsAlive(wrap))
53
61002
    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
29317
void HandleWrap::Close(const FunctionCallbackInfo<Value>& args) {
65
  HandleWrap* wrap;
66
29317
  ASSIGN_OR_RETURN_UNWRAP(&wrap, args.Holder());
67
68
58632
  wrap->Close(args[0]);
69
}
70
71
55853
void HandleWrap::Close(Local<Value> close_callback) {
72
55853
  if (state_ != kInitialized)
73
508
    return;
74
75
55345
  uv_close(handle_, OnClose);
76
55345
  state_ = kClosing;
77
78

98201
  if (!close_callback.IsEmpty() && close_callback->IsFunction() &&
79
14039
      !persistent().IsEmpty()) {
80
14039
    object()->Set(env()->context(),
81
                  env()->handle_onclose_symbol(),
82
42117
                  close_callback).Check();
83
  }
84
}
85
86
87
55108
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
55108
  if (state_ != kClosed) {
94
4
    Close();
95
  } else {
96
55106
    BaseObject::OnGCCollect();
97
  }
98
55108
}
99
100
101
bool HandleWrap::IsNotIndicativeOfMemoryLeakAtExit() const {
102
  return IsWeakOrDetached() ||
103
         !HandleWrap::HasRef(this) ||
104
         !uv_is_active(GetHandle());
105
}
106
107
108
1854
void HandleWrap::MarkAsInitialized() {
109
1854
  env()->handle_wrap_queue()->PushBack(this);
110
1854
  state_ = kInitialized;
111
1854
}
112
113
114
1876
void HandleWrap::MarkAsUninitialized() {
115
1876
  handle_wrap_queue_.Remove();
116
1876
  state_ = kClosed;
117
1876
}
118
119
120
56138
HandleWrap::HandleWrap(Environment* env,
121
                       Local<Object> object,
122
                       uv_handle_t* handle,
123
56138
                       AsyncWrap::ProviderType provider)
124
    : AsyncWrap(env, object, provider),
125
      state_(kInitialized),
126
56138
      handle_(handle) {
127
56138
  handle_->data = this;
128
112276
  HandleScope scope(env->isolate());
129
56138
  CHECK(env->has_run_bootstrapping_code());
130
56138
  env->handle_wrap_queue()->PushBack(this);
131
56138
}
132
133
134
55111
void HandleWrap::OnClose(uv_handle_t* handle) {
135
55111
  CHECK_NOT_NULL(handle->data);
136
110217
  BaseObjectPtr<HandleWrap> wrap { static_cast<HandleWrap*>(handle->data) };
137
55111
  wrap->Detach();
138
139
55111
  Environment* env = wrap->env();
140
110217
  HandleScope scope(env->isolate());
141
55111
  Context::Scope context_scope(env->context());
142
143
55111
  CHECK_EQ(wrap->state_, kClosing);
144
145
55111
  wrap->state_ = kClosed;
146
147
55111
  wrap->OnClose();
148
55111
  wrap->handle_wrap_queue_.Remove();
149
150
110220
  if (!wrap->persistent().IsEmpty() &&
151
165327
      wrap->object()->Has(env->context(), env->handle_onclose_symbol())
152

165329
      .FromMaybe(false)) {
153
48917
    wrap->MakeCallback(env->handle_onclose_symbol(), 0, nullptr);
154
  }
155
55106
}
156
157
18007
Local<FunctionTemplate> HandleWrap::GetConstructorTemplate(Environment* env) {
158
18007
  Local<FunctionTemplate> tmpl = env->handle_wrap_ctor_template();
159
18007
  if (tmpl.IsEmpty()) {
160
843
    tmpl = env->NewFunctionTemplate(nullptr);
161
843
    tmpl->SetClassName(FIXED_ONE_BYTE_STRING(env->isolate(), "HandleWrap"));
162
843
    tmpl->Inherit(AsyncWrap::GetConstructorTemplate(env));
163
843
    env->SetProtoMethod(tmpl, "close", HandleWrap::Close);
164
843
    env->SetProtoMethodNoSideEffect(tmpl, "hasRef", HandleWrap::HasRef);
165
843
    env->SetProtoMethod(tmpl, "ref", HandleWrap::Ref);
166
843
    env->SetProtoMethod(tmpl, "unref", HandleWrap::Unref);
167
843
    env->set_handle_wrap_ctor_template(tmpl);
168
  }
169
18007
  return tmpl;
170
}
171
172
5128
void HandleWrap::RegisterExternalReferences(
173
    ExternalReferenceRegistry* registry) {
174
5128
  registry->Register(HandleWrap::Close);
175
5128
  registry->Register(HandleWrap::HasRef);
176
5128
  registry->Register(HandleWrap::Ref);
177
5128
  registry->Register(HandleWrap::Unref);
178
5128
}
179
180
}  // namespace node
181
182
5128
NODE_MODULE_EXTERNAL_REFERENCE(handle_wrap,
183
                               node::HandleWrap::RegisterExternalReferences)