GCC Code Coverage Report
Directory: ./ Exec Total Coverage
File: tcp_wrap.cc Lines: 202 212 95.3 %
Date: 2022-08-31 04:20:31 Branches: 62 114 54.4 %

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 "tcp_wrap.h"
23
24
#include "connect_wrap.h"
25
#include "connection_wrap.h"
26
#include "env-inl.h"
27
#include "handle_wrap.h"
28
#include "node_buffer.h"
29
#include "node_external_reference.h"
30
#include "node_internals.h"
31
#include "stream_base-inl.h"
32
#include "stream_wrap.h"
33
#include "util-inl.h"
34
35
#include <cstdlib>
36
37
38
namespace node {
39
40
using v8::Boolean;
41
using v8::Context;
42
using v8::EscapableHandleScope;
43
using v8::Function;
44
using v8::FunctionCallbackInfo;
45
using v8::FunctionTemplate;
46
using v8::Int32;
47
using v8::Integer;
48
using v8::Isolate;
49
using v8::Local;
50
using v8::MaybeLocal;
51
using v8::Object;
52
using v8::String;
53
using v8::Uint32;
54
using v8::Value;
55
56
5047
MaybeLocal<Object> TCPWrap::Instantiate(Environment* env,
57
                                        AsyncWrap* parent,
58
                                        TCPWrap::SocketType type) {
59
5047
  EscapableHandleScope handle_scope(env->isolate());
60
5047
  AsyncHooks::DefaultTriggerAsyncIdScope trigger_scope(parent);
61
10094
  CHECK_EQ(env->tcp_constructor_template().IsEmpty(), false);
62
5047
  Local<Function> constructor = env->tcp_constructor_template()
63
5047
                                    ->GetFunction(env->context())
64
5047
                                    .ToLocalChecked();
65
5047
  CHECK_EQ(constructor.IsEmpty(), false);
66
10094
  Local<Value> type_value = Int32::New(env->isolate(), type);
67
  return handle_scope.EscapeMaybe(
68
10094
      constructor->NewInstance(env->context(), 1, &type_value));
69
}
70
71
72
6158
void TCPWrap::Initialize(Local<Object> target,
73
                         Local<Value> unused,
74
                         Local<Context> context,
75
                         void* priv) {
76
6158
  Environment* env = Environment::GetCurrent(context);
77
6158
  Isolate* isolate = env->isolate();
78
79
6158
  Local<FunctionTemplate> t = NewFunctionTemplate(isolate, New);
80
12316
  t->InstanceTemplate()->SetInternalFieldCount(StreamBase::kInternalFieldCount);
81
82
  // Init properties
83
24632
  t->InstanceTemplate()->Set(FIXED_ONE_BYTE_STRING(env->isolate(), "reading"),
84
                             Boolean::New(env->isolate(), false));
85
24632
  t->InstanceTemplate()->Set(env->owner_symbol(), Null(env->isolate()));
86
24632
  t->InstanceTemplate()->Set(env->onconnection_string(), Null(env->isolate()));
87
88
6158
  t->Inherit(LibuvStreamWrap::GetConstructorTemplate(env));
89
90
6158
  SetProtoMethod(isolate, t, "open", Open);
91
6158
  SetProtoMethod(isolate, t, "bind", Bind);
92
6158
  SetProtoMethod(isolate, t, "listen", Listen);
93
6158
  SetProtoMethod(isolate, t, "connect", Connect);
94
6158
  SetProtoMethod(isolate, t, "bind6", Bind6);
95
6158
  SetProtoMethod(isolate, t, "connect6", Connect6);
96
6158
  SetProtoMethod(isolate,
97
                 t,
98
                 "getsockname",
99
                 GetSockOrPeerName<TCPWrap, uv_tcp_getsockname>);
100
6158
  SetProtoMethod(isolate,
101
                 t,
102
                 "getpeername",
103
                 GetSockOrPeerName<TCPWrap, uv_tcp_getpeername>);
104
6158
  SetProtoMethod(isolate, t, "setNoDelay", SetNoDelay);
105
6158
  SetProtoMethod(isolate, t, "setKeepAlive", SetKeepAlive);
106
6158
  SetProtoMethod(isolate, t, "reset", Reset);
107
108
#ifdef _WIN32
109
  SetProtoMethod(isolate, t, "setSimultaneousAccepts", SetSimultaneousAccepts);
110
#endif
111
112
6158
  SetConstructorFunction(context, target, "TCP", t);
113
6158
  env->set_tcp_constructor_template(t);
114
115
  // Create FunctionTemplate for TCPConnectWrap.
116
  Local<FunctionTemplate> cwt =
117
6158
      BaseObject::MakeLazilyInitializedJSTemplate(env);
118
6158
  cwt->Inherit(AsyncWrap::GetConstructorTemplate(env));
119
6158
  SetConstructorFunction(context, target, "TCPConnectWrap", cwt);
120
121
  // Define constants
122
6158
  Local<Object> constants = Object::New(env->isolate());
123
18474
  NODE_DEFINE_CONSTANT(constants, SOCKET);
124
18474
  NODE_DEFINE_CONSTANT(constants, SERVER);
125
18474
  NODE_DEFINE_CONSTANT(constants, UV_TCP_IPV6ONLY);
126
6158
  target->Set(context,
127
              env->constants_string(),
128
12316
              constants).Check();
129
6158
}
130
131
5422
void TCPWrap::RegisterExternalReferences(ExternalReferenceRegistry* registry) {
132
5422
  registry->Register(New);
133
5422
  registry->Register(Open);
134
5422
  registry->Register(Bind);
135
5422
  registry->Register(Listen);
136
5422
  registry->Register(Connect);
137
5422
  registry->Register(Bind6);
138
5422
  registry->Register(Connect6);
139
140
5422
  registry->Register(GetSockOrPeerName<TCPWrap, uv_tcp_getsockname>);
141
5422
  registry->Register(GetSockOrPeerName<TCPWrap, uv_tcp_getpeername>);
142
5422
  registry->Register(SetNoDelay);
143
5422
  registry->Register(SetKeepAlive);
144
5422
  registry->Register(Reset);
145
#ifdef _WIN32
146
  registry->Register(SetSimultaneousAccepts);
147
#endif
148
5422
}
149
150
12832
void TCPWrap::New(const FunctionCallbackInfo<Value>& args) {
151
  // This constructor should not be exposed to public javascript.
152
  // Therefore we assert that we are not trying to call this as a
153
  // normal function.
154
12832
  CHECK(args.IsConstructCall());
155
12832
  CHECK(args[0]->IsInt32());
156
12832
  Environment* env = Environment::GetCurrent(args);
157
158
25664
  int type_value = args[0].As<Int32>()->Value();
159
12832
  TCPWrap::SocketType type = static_cast<TCPWrap::SocketType>(type_value);
160
161
  ProviderType provider;
162
12832
  switch (type) {
163
11034
    case SOCKET:
164
11034
      provider = PROVIDER_TCPWRAP;
165
11034
      break;
166
1798
    case SERVER:
167
1798
      provider = PROVIDER_TCPSERVERWRAP;
168
1798
      break;
169
    default:
170
      UNREACHABLE();
171
  }
172
173
12832
  new TCPWrap(env, args.This(), provider);
174
12832
}
175
176
177
12832
TCPWrap::TCPWrap(Environment* env, Local<Object> object, ProviderType provider)
178
12832
    : ConnectionWrap(env, object, provider) {
179
12832
  int r = uv_tcp_init(env->event_loop(), &handle_);
180
12832
  CHECK_EQ(r, 0);  // How do we proxy this error up to javascript?
181
                   // Suggestion: uv_tcp_init() returns void.
182
12832
}
183
184
185
5759
void TCPWrap::SetNoDelay(const FunctionCallbackInfo<Value>& args) {
186
  TCPWrap* wrap;
187
5759
  ASSIGN_OR_RETURN_UNWRAP(&wrap,
188
                          args.Holder(),
189
                          args.GetReturnValue().Set(UV_EBADF));
190
5759
  int enable = static_cast<int>(args[0]->IsTrue());
191
5759
  int err = uv_tcp_nodelay(&wrap->handle_, enable);
192
11518
  args.GetReturnValue().Set(err);
193
}
194
195
196
2391
void TCPWrap::SetKeepAlive(const FunctionCallbackInfo<Value>& args) {
197
  TCPWrap* wrap;
198
2391
  ASSIGN_OR_RETURN_UNWRAP(&wrap,
199
                          args.Holder(),
200
                          args.GetReturnValue().Set(UV_EBADF));
201
2391
  Environment* env = wrap->env();
202
  int enable;
203
4782
  if (!args[0]->Int32Value(env->context()).To(&enable)) return;
204
4782
  unsigned int delay = static_cast<unsigned int>(args[1].As<Uint32>()->Value());
205
2391
  int err = uv_tcp_keepalive(&wrap->handle_, enable, delay);
206
4782
  args.GetReturnValue().Set(err);
207
}
208
209
210
#ifdef _WIN32
211
void TCPWrap::SetSimultaneousAccepts(const FunctionCallbackInfo<Value>& args) {
212
  TCPWrap* wrap;
213
  ASSIGN_OR_RETURN_UNWRAP(&wrap,
214
                          args.Holder(),
215
                          args.GetReturnValue().Set(UV_EBADF));
216
  bool enable = args[0]->IsTrue();
217
  int err = uv_tcp_simultaneous_accepts(&wrap->handle_, enable);
218
  args.GetReturnValue().Set(err);
219
}
220
#endif
221
222
223
2
void TCPWrap::Open(const FunctionCallbackInfo<Value>& args) {
224
  TCPWrap* wrap;
225
2
  ASSIGN_OR_RETURN_UNWRAP(&wrap,
226
                          args.Holder(),
227
                          args.GetReturnValue().Set(UV_EBADF));
228
  int64_t val;
229
4
  if (!args[0]->IntegerValue(args.GetIsolate()->GetCurrentContext()).To(&val))
230
    return;
231
2
  int fd = static_cast<int>(val);
232
2
  int err = uv_tcp_open(&wrap->handle_, fd);
233
234
2
  if (err == 0)
235
2
    wrap->set_fd(fd);
236
237
4
  args.GetReturnValue().Set(err);
238
}
239
240
template <typename T>
241
3642
void TCPWrap::Bind(
242
    const FunctionCallbackInfo<Value>& args,
243
    int family,
244
    std::function<int(const char* ip_address, int port, T* addr)> uv_ip_addr) {
245
  TCPWrap* wrap;
246

1821
  ASSIGN_OR_RETURN_UNWRAP(&wrap,
247
                          args.Holder(),
248
                          args.GetReturnValue().Set(UV_EBADF));
249
1821
  Environment* env = wrap->env();
250
1821
  node::Utf8Value ip_address(env->isolate(), args[0]);
251
  int port;
252

1821
  unsigned int flags = 0;
253

3642
  if (!args[1]->Int32Value(env->context()).To(&port)) return;
254

3510
  if (family == AF_INET6 &&
255


5199
      !args[2]->Uint32Value(env->context()).To(&flags)) {
256
    return;
257
  }
258
259
  T addr;
260
1821
  int err = uv_ip_addr(*ip_address, port, &addr);
261
262

1821
  if (err == 0) {
263
1819
    err = uv_tcp_bind(&wrap->handle_,
264
                      reinterpret_cast<const sockaddr*>(&addr),
265
                      flags);
266
  }
267
3642
  args.GetReturnValue().Set(err);
268
}
269
270
132
void TCPWrap::Bind(const FunctionCallbackInfo<Value>& args) {
271
132
  Bind<sockaddr_in>(args, AF_INET, uv_ip4_addr);
272
132
}
273
274
275
1689
void TCPWrap::Bind6(const FunctionCallbackInfo<Value>& args) {
276
1689
  Bind<sockaddr_in6>(args, AF_INET6, uv_ip6_addr);
277
1689
}
278
279
280
1804
void TCPWrap::Listen(const FunctionCallbackInfo<Value>& args) {
281
  TCPWrap* wrap;
282
1804
  ASSIGN_OR_RETURN_UNWRAP(&wrap,
283
                          args.Holder(),
284
                          args.GetReturnValue().Set(UV_EBADF));
285
1804
  Environment* env = wrap->env();
286
  int backlog;
287
3608
  if (!args[0]->Int32Value(env->context()).To(&backlog)) return;
288
1804
  int err = uv_listen(reinterpret_cast<uv_stream_t*>(&wrap->handle_),
289
                      backlog,
290
                      OnConnection);
291
3608
  args.GetReturnValue().Set(err);
292
}
293
294
295
642
void TCPWrap::Connect(const FunctionCallbackInfo<Value>& args) {
296
642
  CHECK(args[2]->IsUint32());
297
  // explicit cast to fit to libuv's type expectation
298
1284
  int port = static_cast<int>(args[2].As<Uint32>()->Value());
299
642
  Connect<sockaddr_in>(args,
300
642
                       [port](const char* ip_address, sockaddr_in* addr) {
301
642
      return uv_ip4_addr(ip_address, port, addr);
302
  });
303
642
}
304
305
306
4845
void TCPWrap::Connect6(const FunctionCallbackInfo<Value>& args) {
307
4845
  Environment* env = Environment::GetCurrent(args);
308
4845
  CHECK(args[2]->IsUint32());
309
  int port;
310
9690
  if (!args[2]->Int32Value(env->context()).To(&port)) return;
311
4845
  Connect<sockaddr_in6>(args,
312
4845
                        [port](const char* ip_address, sockaddr_in6* addr) {
313
4845
      return uv_ip6_addr(ip_address, port, addr);
314
  });
315
}
316
317
template <typename T>
318
10974
void TCPWrap::Connect(const FunctionCallbackInfo<Value>& args,
319
    std::function<int(const char* ip_address, T* addr)> uv_ip_addr) {
320
10974
  Environment* env = Environment::GetCurrent(args);
321
322
  TCPWrap* wrap;
323
10974
  ASSIGN_OR_RETURN_UNWRAP(&wrap,
324
                          args.Holder(),
325
                          args.GetReturnValue().Set(UV_EBADF));
326
327
10974
  CHECK(args[0]->IsObject());
328
21948
  CHECK(args[1]->IsString());
329
330
21948
  Local<Object> req_wrap_obj = args[0].As<Object>();
331
10974
  node::Utf8Value ip_address(env->isolate(), args[1]);
332
333
  T addr;
334
10974
  int err = uv_ip_addr(*ip_address, &addr);
335
336
10974
  if (err == 0) {
337
21948
    AsyncHooks::DefaultTriggerAsyncIdScope trigger_scope(wrap);
338
21948
    ConnectWrap* req_wrap =
339
10974
        new ConnectWrap(env, req_wrap_obj, AsyncWrap::PROVIDER_TCPCONNECTWRAP);
340
21948
    err = req_wrap->Dispatch(uv_tcp_connect,
341
10974
                             &wrap->handle_,
342
                             reinterpret_cast<const sockaddr*>(&addr),
343
                             AfterConnect);
344
10974
    if (err) {
345
      delete req_wrap;
346
    } else {
347
21948
      int port = args[2]->Uint32Value(env->context()).FromJust();
348

12870
      TRACE_EVENT_NESTABLE_ASYNC_BEGIN2(TRACING_CATEGORY_NODE2(net, native),
349
                                        "connect",
350
                                        req_wrap,
351
                                        "ip",
352
                                        TRACE_STR_COPY(*ip_address),
353
                                        "port",
354
                                        port);
355
    }
356
  }
357
358
21948
  args.GetReturnValue().Set(err);
359
}
360
5
void TCPWrap::Reset(const FunctionCallbackInfo<Value>& args) {
361
  TCPWrap* wrap;
362
5
  ASSIGN_OR_RETURN_UNWRAP(
363
      &wrap, args.Holder(), args.GetReturnValue().Set(UV_EBADF));
364
365
10
  int err = wrap->Reset(args[0]);
366
367
10
  args.GetReturnValue().Set(err);
368
}
369
370
5
int TCPWrap::Reset(Local<Value> close_callback) {
371
5
  if (state_ != kInitialized) return 0;
372
373
5
  int err = uv_tcp_close_reset(&handle_, OnClose);
374
5
  state_ = kClosing;
375

15
  if (!err & !close_callback.IsEmpty() && close_callback->IsFunction() &&
376
5
      !persistent().IsEmpty()) {
377
5
    object()
378
15
        ->Set(env()->context(), env()->handle_onclose_symbol(), close_callback)
379
        .Check();
380
  }
381
5
  return err;
382
}
383
384
// also used by udp_wrap.cc
385
4909
MaybeLocal<Object> AddressToJS(Environment* env,
386
                               const sockaddr* addr,
387
                               Local<Object> info) {
388
4909
  EscapableHandleScope scope(env->isolate());
389
  char ip[INET6_ADDRSTRLEN + UV_IF_NAMESIZE];
390
  const sockaddr_in* a4;
391
  const sockaddr_in6* a6;
392
393
  int port;
394
395
4909
  if (info.IsEmpty())
396
367
    info = Object::New(env->isolate());
397
398
4909
  switch (addr->sa_family) {
399
4277
  case AF_INET6:
400
4277
    a6 = reinterpret_cast<const sockaddr_in6*>(addr);
401
4277
    uv_inet_ntop(AF_INET6, &a6->sin6_addr, ip, sizeof ip);
402
    // Add an interface identifier to a link local address.
403

4277
    if (IN6_IS_ADDR_LINKLOCAL(&a6->sin6_addr) && a6->sin6_scope_id > 0) {
404
2
      const size_t addrlen = strlen(ip);
405
2
      CHECK_LT(addrlen, sizeof(ip));
406
2
      ip[addrlen] = '%';
407
2
      size_t scopeidlen = sizeof(ip) - addrlen - 1;
408
2
      CHECK_GE(scopeidlen, UV_IF_NAMESIZE);
409
2
      const int r = uv_if_indextoiid(a6->sin6_scope_id,
410
2
                                     ip + addrlen + 1,
411
                                     &scopeidlen);
412
2
      if (r) {
413
        env->ThrowUVException(r, "uv_if_indextoiid");
414
        return {};
415
      }
416
    }
417
4277
    port = ntohs(a6->sin6_port);
418
4277
    info->Set(env->context(),
419
              env->address_string(),
420
17108
              OneByteString(env->isolate(), ip)).Check();
421
17108
    info->Set(env->context(), env->family_string(), env->ipv6_string()).Check();
422
4277
    info->Set(env->context(),
423
              env->port_string(),
424
12831
              Integer::New(env->isolate(), port)).Check();
425
4277
    break;
426
427
632
  case AF_INET:
428
632
    a4 = reinterpret_cast<const sockaddr_in*>(addr);
429
632
    uv_inet_ntop(AF_INET, &a4->sin_addr, ip, sizeof ip);
430
632
    port = ntohs(a4->sin_port);
431
632
    info->Set(env->context(),
432
              env->address_string(),
433
2528
              OneByteString(env->isolate(), ip)).Check();
434
2528
    info->Set(env->context(), env->family_string(), env->ipv4_string()).Check();
435
632
    info->Set(env->context(),
436
              env->port_string(),
437
1896
              Integer::New(env->isolate(), port)).Check();
438
632
    break;
439
440
  default:
441
    info->Set(env->context(),
442
              env->address_string(),
443
              String::Empty(env->isolate())).Check();
444
  }
445
446
4909
  return scope.Escape(info);
447
}
448
449
450
}  // namespace node
451
452
5494
NODE_MODULE_CONTEXT_AWARE_INTERNAL(tcp_wrap, node::TCPWrap::Initialize)
453
5422
NODE_MODULE_EXTERNAL_REFERENCE(tcp_wrap,
454
                               node::TCPWrap::RegisterExternalReferences)