// 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 "udp_wrap.h" #include "allocated_buffer-inl.h" #include "env-inl.h" #include "node_buffer.h" #include "node_sockaddr-inl.h" #include "handle_wrap.h" #include "req_wrap-inl.h" #include "util-inl.h" namespace node { using v8::Array; using v8::Context; using v8::DontDelete; using v8::FunctionCallbackInfo; using v8::FunctionTemplate; using v8::HandleScope; using v8::Integer; using v8::Local; using v8::MaybeLocal; using v8::Object; using v8::PropertyAttribute; using v8::ReadOnly; using v8::Signature; using v8::String; using v8::Uint32; using v8::Undefined; using v8::Value; class SendWrap : public ReqWrap { public: SendWrap(Environment* env, Local req_wrap_obj, bool have_callback); inline bool have_callback() const; size_t msg_size; SET_NO_MEMORY_INFO() SET_MEMORY_INFO_NAME(SendWrap) SET_SELF_SIZE(SendWrap) private: const bool have_callback_; }; SendWrap::SendWrap(Environment* env, Local req_wrap_obj, bool have_callback) : ReqWrap(env, req_wrap_obj, AsyncWrap::PROVIDER_UDPSENDWRAP), have_callback_(have_callback) { } bool SendWrap::have_callback() const { return have_callback_; } UDPListener::~UDPListener() { if (wrap_ != nullptr) wrap_->set_listener(nullptr); } UDPWrapBase::~UDPWrapBase() { set_listener(nullptr); } UDPListener* UDPWrapBase::listener() const { CHECK_NOT_NULL(listener_); return listener_; } void UDPWrapBase::set_listener(UDPListener* listener) { if (listener_ != nullptr) listener_->wrap_ = nullptr; listener_ = listener; if (listener_ != nullptr) { CHECK_NULL(listener_->wrap_); listener_->wrap_ = this; } } UDPWrapBase* UDPWrapBase::FromObject(Local obj) { CHECK_GT(obj->InternalFieldCount(), UDPWrapBase::kUDPWrapBaseField); return static_cast( obj->GetAlignedPointerFromInternalField(UDPWrapBase::kUDPWrapBaseField)); } void UDPWrapBase::AddMethods(Environment* env, Local t) { env->SetProtoMethod(t, "recvStart", RecvStart); env->SetProtoMethod(t, "recvStop", RecvStop); } UDPWrap::UDPWrap(Environment* env, Local object) : HandleWrap(env, object, reinterpret_cast(&handle_), AsyncWrap::PROVIDER_UDPWRAP) { object->SetAlignedPointerInInternalField( UDPWrapBase::kUDPWrapBaseField, static_cast(this)); int r = uv_udp_init(env->event_loop(), &handle_); CHECK_EQ(r, 0); // can't fail anyway set_listener(this); } void UDPWrap::Initialize(Local target, Local unused, Local context, void* priv) { Environment* env = Environment::GetCurrent(context); Local t = env->NewFunctionTemplate(New); t->InstanceTemplate()->SetInternalFieldCount( UDPWrapBase::kInternalFieldCount); Local udpString = FIXED_ONE_BYTE_STRING(env->isolate(), "UDP"); t->SetClassName(udpString); enum PropertyAttribute attributes = static_cast(ReadOnly | DontDelete); Local signature = Signature::New(env->isolate(), t); Local get_fd_templ = FunctionTemplate::New(env->isolate(), UDPWrap::GetFD, Local(), signature); t->PrototypeTemplate()->SetAccessorProperty(env->fd_string(), get_fd_templ, Local(), attributes); UDPWrapBase::AddMethods(env, t); env->SetProtoMethod(t, "open", Open); env->SetProtoMethod(t, "bind", Bind); env->SetProtoMethod(t, "connect", Connect); env->SetProtoMethod(t, "send", Send); env->SetProtoMethod(t, "bind6", Bind6); env->SetProtoMethod(t, "connect6", Connect6); env->SetProtoMethod(t, "send6", Send6); env->SetProtoMethod(t, "disconnect", Disconnect); env->SetProtoMethod(t, "getpeername", GetSockOrPeerName); env->SetProtoMethod(t, "getsockname", GetSockOrPeerName); env->SetProtoMethod(t, "addMembership", AddMembership); env->SetProtoMethod(t, "dropMembership", DropMembership); env->SetProtoMethod(t, "addSourceSpecificMembership", AddSourceSpecificMembership); env->SetProtoMethod(t, "dropSourceSpecificMembership", DropSourceSpecificMembership); env->SetProtoMethod(t, "setMulticastInterface", SetMulticastInterface); env->SetProtoMethod(t, "setMulticastTTL", SetMulticastTTL); env->SetProtoMethod(t, "setMulticastLoopback", SetMulticastLoopback); env->SetProtoMethod(t, "setBroadcast", SetBroadcast); env->SetProtoMethod(t, "setTTL", SetTTL); env->SetProtoMethod(t, "bufferSize", BufferSize); t->Inherit(HandleWrap::GetConstructorTemplate(env)); target->Set(env->context(), udpString, t->GetFunction(env->context()).ToLocalChecked()).Check(); env->set_udp_constructor_function( t->GetFunction(env->context()).ToLocalChecked()); // Create FunctionTemplate for SendWrap Local swt = BaseObject::MakeLazilyInitializedJSTemplate(env); swt->Inherit(AsyncWrap::GetConstructorTemplate(env)); Local sendWrapString = FIXED_ONE_BYTE_STRING(env->isolate(), "SendWrap"); swt->SetClassName(sendWrapString); target->Set(env->context(), sendWrapString, swt->GetFunction(env->context()).ToLocalChecked()).Check(); Local constants = Object::New(env->isolate()); NODE_DEFINE_CONSTANT(constants, UV_UDP_IPV6ONLY); NODE_DEFINE_CONSTANT(constants, UV_UDP_REUSEADDR); target->Set(context, env->constants_string(), constants).Check(); } void UDPWrap::New(const FunctionCallbackInfo& args) { CHECK(args.IsConstructCall()); Environment* env = Environment::GetCurrent(args); new UDPWrap(env, args.This()); } void UDPWrap::GetFD(const FunctionCallbackInfo& args) { int fd = UV_EBADF; #if !defined(_WIN32) UDPWrap* wrap = Unwrap(args.This()); if (wrap != nullptr) uv_fileno(reinterpret_cast(&wrap->handle_), &fd); #endif args.GetReturnValue().Set(fd); } int sockaddr_for_family(int address_family, const char* address, const unsigned short port, struct sockaddr_storage* addr) { switch (address_family) { case AF_INET: return uv_ip4_addr(address, port, reinterpret_cast(addr)); case AF_INET6: return uv_ip6_addr(address, port, reinterpret_cast(addr)); default: CHECK(0 && "unexpected address family"); } } void UDPWrap::DoBind(const FunctionCallbackInfo& args, int family) { UDPWrap* wrap; ASSIGN_OR_RETURN_UNWRAP(&wrap, args.Holder(), args.GetReturnValue().Set(UV_EBADF)); // bind(ip, port, flags) CHECK_EQ(args.Length(), 3); node::Utf8Value address(args.GetIsolate(), args[0]); Local ctx = args.GetIsolate()->GetCurrentContext(); uint32_t port, flags; if (!args[1]->Uint32Value(ctx).To(&port) || !args[2]->Uint32Value(ctx).To(&flags)) return; struct sockaddr_storage addr_storage; int err = sockaddr_for_family(family, address.out(), port, &addr_storage); if (err == 0) { err = uv_udp_bind(&wrap->handle_, reinterpret_cast(&addr_storage), flags); } if (err == 0) wrap->listener()->OnAfterBind(); args.GetReturnValue().Set(err); } void UDPWrap::DoConnect(const FunctionCallbackInfo& args, int family) { UDPWrap* wrap; ASSIGN_OR_RETURN_UNWRAP(&wrap, args.Holder(), args.GetReturnValue().Set(UV_EBADF)); CHECK_EQ(args.Length(), 2); node::Utf8Value address(args.GetIsolate(), args[0]); Local ctx = args.GetIsolate()->GetCurrentContext(); uint32_t port; if (!args[1]->Uint32Value(ctx).To(&port)) return; struct sockaddr_storage addr_storage; int err = sockaddr_for_family(family, address.out(), port, &addr_storage); if (err == 0) { err = uv_udp_connect(&wrap->handle_, reinterpret_cast(&addr_storage)); } args.GetReturnValue().Set(err); } void UDPWrap::Open(const FunctionCallbackInfo& args) { UDPWrap* wrap; ASSIGN_OR_RETURN_UNWRAP(&wrap, args.Holder(), args.GetReturnValue().Set(UV_EBADF)); CHECK(args[0]->IsNumber()); int fd = static_cast(args[0].As()->Value()); int err = uv_udp_open(&wrap->handle_, fd); args.GetReturnValue().Set(err); } void UDPWrap::Bind(const FunctionCallbackInfo& args) { DoBind(args, AF_INET); } void UDPWrap::Bind6(const FunctionCallbackInfo& args) { DoBind(args, AF_INET6); } void UDPWrap::BufferSize(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); UDPWrap* wrap; ASSIGN_OR_RETURN_UNWRAP(&wrap, args.Holder(), args.GetReturnValue().Set(UV_EBADF)); CHECK(args[0]->IsUint32()); CHECK(args[1]->IsBoolean()); bool is_recv = args[1].As()->Value(); const char* uv_func_name = is_recv ? "uv_recv_buffer_size" : "uv_send_buffer_size"; if (!args[0]->IsInt32()) { env->CollectUVExceptionInfo(args[2], UV_EINVAL, uv_func_name); return args.GetReturnValue().SetUndefined(); } uv_handle_t* handle = reinterpret_cast(&wrap->handle_); int size = static_cast(args[0].As()->Value()); int err; if (is_recv) err = uv_recv_buffer_size(handle, &size); else err = uv_send_buffer_size(handle, &size); if (err != 0) { env->CollectUVExceptionInfo(args[2], err, uv_func_name); return args.GetReturnValue().SetUndefined(); } args.GetReturnValue().Set(size); } void UDPWrap::Connect(const FunctionCallbackInfo& args) { DoConnect(args, AF_INET); } void UDPWrap::Connect6(const FunctionCallbackInfo& args) { DoConnect(args, AF_INET6); } void UDPWrap::Disconnect(const FunctionCallbackInfo& args) { UDPWrap* wrap; ASSIGN_OR_RETURN_UNWRAP(&wrap, args.Holder(), args.GetReturnValue().Set(UV_EBADF)); CHECK_EQ(args.Length(), 0); int err = uv_udp_connect(&wrap->handle_, nullptr); args.GetReturnValue().Set(err); } #define X(name, fn) \ void UDPWrap::name(const FunctionCallbackInfo& args) { \ UDPWrap* wrap = Unwrap(args.Holder()); \ Environment* env = wrap->env(); \ CHECK_EQ(args.Length(), 1); \ int flag; \ if (!args[0]->Int32Value(env->context()).To(&flag)) { \ return; \ } \ int err = wrap == nullptr ? UV_EBADF : fn(&wrap->handle_, flag); \ args.GetReturnValue().Set(err); \ } X(SetTTL, uv_udp_set_ttl) X(SetBroadcast, uv_udp_set_broadcast) X(SetMulticastTTL, uv_udp_set_multicast_ttl) X(SetMulticastLoopback, uv_udp_set_multicast_loop) #undef X void UDPWrap::SetMulticastInterface(const FunctionCallbackInfo& args) { UDPWrap* wrap; ASSIGN_OR_RETURN_UNWRAP(&wrap, args.Holder(), args.GetReturnValue().Set(UV_EBADF)); CHECK_EQ(args.Length(), 1); CHECK(args[0]->IsString()); Utf8Value iface(args.GetIsolate(), args[0]); const char* iface_cstr = *iface; int err = uv_udp_set_multicast_interface(&wrap->handle_, iface_cstr); args.GetReturnValue().Set(err); } void UDPWrap::SetMembership(const FunctionCallbackInfo& args, uv_membership membership) { UDPWrap* wrap; ASSIGN_OR_RETURN_UNWRAP(&wrap, args.Holder(), args.GetReturnValue().Set(UV_EBADF)); CHECK_EQ(args.Length(), 2); node::Utf8Value address(args.GetIsolate(), args[0]); node::Utf8Value iface(args.GetIsolate(), args[1]); const char* iface_cstr = *iface; if (args[1]->IsUndefined() || args[1]->IsNull()) { iface_cstr = nullptr; } int err = uv_udp_set_membership(&wrap->handle_, *address, iface_cstr, membership); args.GetReturnValue().Set(err); } void UDPWrap::AddMembership(const FunctionCallbackInfo& args) { SetMembership(args, UV_JOIN_GROUP); } void UDPWrap::DropMembership(const FunctionCallbackInfo& args) { SetMembership(args, UV_LEAVE_GROUP); } void UDPWrap::SetSourceMembership(const FunctionCallbackInfo& args, uv_membership membership) { UDPWrap* wrap; ASSIGN_OR_RETURN_UNWRAP(&wrap, args.Holder(), args.GetReturnValue().Set(UV_EBADF)); CHECK_EQ(args.Length(), 3); node::Utf8Value source_address(args.GetIsolate(), args[0]); node::Utf8Value group_address(args.GetIsolate(), args[1]); node::Utf8Value iface(args.GetIsolate(), args[2]); if (*iface == nullptr) return; const char* iface_cstr = *iface; if (args[2]->IsUndefined() || args[2]->IsNull()) { iface_cstr = nullptr; } int err = uv_udp_set_source_membership(&wrap->handle_, *group_address, iface_cstr, *source_address, membership); args.GetReturnValue().Set(err); } void UDPWrap::AddSourceSpecificMembership( const FunctionCallbackInfo& args) { SetSourceMembership(args, UV_JOIN_GROUP); } void UDPWrap::DropSourceSpecificMembership( const FunctionCallbackInfo& args) { SetSourceMembership(args, UV_LEAVE_GROUP); } void UDPWrap::DoSend(const FunctionCallbackInfo& args, int family) { Environment* env = Environment::GetCurrent(args); UDPWrap* wrap; ASSIGN_OR_RETURN_UNWRAP(&wrap, args.Holder(), args.GetReturnValue().Set(UV_EBADF)); CHECK(args.Length() == 4 || args.Length() == 6); CHECK(args[0]->IsObject()); CHECK(args[1]->IsArray()); CHECK(args[2]->IsUint32()); bool sendto = args.Length() == 6; if (sendto) { // send(req, list, list.length, port, address, hasCallback) CHECK(args[3]->IsUint32()); CHECK(args[4]->IsString()); CHECK(args[5]->IsBoolean()); } else { // send(req, list, list.length, hasCallback) CHECK(args[3]->IsBoolean()); } Local chunks = args[1].As(); // it is faster to fetch the length of the // array in js-land size_t count = args[2].As()->Value(); MaybeStackBuffer bufs(count); // construct uv_buf_t array for (size_t i = 0; i < count; i++) { Local chunk; if (!chunks->Get(env->context(), i).ToLocal(&chunk)) return; size_t length = Buffer::Length(chunk); bufs[i] = uv_buf_init(Buffer::Data(chunk), length); } int err = 0; struct sockaddr_storage addr_storage; sockaddr* addr = nullptr; if (sendto) { const unsigned short port = args[3].As()->Value(); node::Utf8Value address(env->isolate(), args[4]); err = sockaddr_for_family(family, address.out(), port, &addr_storage); if (err == 0) addr = reinterpret_cast(&addr_storage); } if (err == 0) { wrap->current_send_req_wrap_ = args[0].As(); wrap->current_send_has_callback_ = sendto ? args[5]->IsTrue() : args[3]->IsTrue(); err = wrap->Send(*bufs, count, addr); wrap->current_send_req_wrap_.Clear(); wrap->current_send_has_callback_ = false; } args.GetReturnValue().Set(err); } ssize_t UDPWrap::Send(uv_buf_t* bufs_ptr, size_t count, const sockaddr* addr) { if (IsHandleClosing()) return UV_EBADF; size_t msg_size = 0; for (size_t i = 0; i < count; i++) msg_size += bufs_ptr[i].len; int err = 0; if (!UNLIKELY(env()->options()->test_udp_no_try_send)) { err = uv_udp_try_send(&handle_, bufs_ptr, count, addr); if (err == UV_ENOSYS || err == UV_EAGAIN) { err = 0; } else if (err >= 0) { size_t sent = err; while (count > 0 && bufs_ptr->len <= sent) { sent -= bufs_ptr->len; bufs_ptr++; count--; } if (count > 0) { CHECK_LT(sent, bufs_ptr->len); bufs_ptr->base += sent; bufs_ptr->len -= sent; } else { CHECK_EQ(static_cast(err), msg_size); // + 1 so that the JS side can distinguish 0-length async sends from // 0-length sync sends. return msg_size + 1; } } } if (err == 0) { AsyncHooks::DefaultTriggerAsyncIdScope trigger_scope(this); ReqWrap* req_wrap = listener()->CreateSendWrap(msg_size); if (req_wrap == nullptr) return UV_ENOSYS; err = req_wrap->Dispatch( uv_udp_send, &handle_, bufs_ptr, count, addr, uv_udp_send_cb{[](uv_udp_send_t* req, int status) { UDPWrap* self = ContainerOf(&UDPWrap::handle_, req->handle); self->listener()->OnSendDone( ReqWrap::from_req(req), status); }}); if (err) delete req_wrap; } return err; } ReqWrap* UDPWrap::CreateSendWrap(size_t msg_size) { SendWrap* req_wrap = new SendWrap(env(), current_send_req_wrap_, current_send_has_callback_); req_wrap->msg_size = msg_size; return req_wrap; } void UDPWrap::Send(const FunctionCallbackInfo& args) { DoSend(args, AF_INET); } void UDPWrap::Send6(const FunctionCallbackInfo& args) { DoSend(args, AF_INET6); } AsyncWrap* UDPWrap::GetAsyncWrap() { return this; } SocketAddress UDPWrap::GetPeerName() { return SocketAddress::FromPeerName(handle_); } SocketAddress UDPWrap::GetSockName() { return SocketAddress::FromSockName(handle_); } void UDPWrapBase::RecvStart(const FunctionCallbackInfo& args) { UDPWrapBase* wrap = UDPWrapBase::FromObject(args.Holder()); args.GetReturnValue().Set(wrap == nullptr ? UV_EBADF : wrap->RecvStart()); } int UDPWrap::RecvStart() { if (IsHandleClosing()) return UV_EBADF; int err = uv_udp_recv_start(&handle_, OnAlloc, OnRecv); // UV_EALREADY means that the socket is already bound but that's okay if (err == UV_EALREADY) err = 0; return err; } void UDPWrapBase::RecvStop(const FunctionCallbackInfo& args) { UDPWrapBase* wrap = UDPWrapBase::FromObject(args.Holder()); args.GetReturnValue().Set(wrap == nullptr ? UV_EBADF : wrap->RecvStop()); } int UDPWrap::RecvStop() { if (IsHandleClosing()) return UV_EBADF; return uv_udp_recv_stop(&handle_); } void UDPWrap::OnSendDone(ReqWrap* req, int status) { std::unique_ptr req_wrap{static_cast(req)}; if (req_wrap->have_callback()) { Environment* env = req_wrap->env(); HandleScope handle_scope(env->isolate()); Context::Scope context_scope(env->context()); Local arg[] = { Integer::New(env->isolate(), status), Integer::New(env->isolate(), req_wrap->msg_size), }; req_wrap->MakeCallback(env->oncomplete_string(), 2, arg); } } void UDPWrap::OnAlloc(uv_handle_t* handle, size_t suggested_size, uv_buf_t* buf) { UDPWrap* wrap = ContainerOf(&UDPWrap::handle_, reinterpret_cast(handle)); *buf = wrap->listener()->OnAlloc(suggested_size); } uv_buf_t UDPWrap::OnAlloc(size_t suggested_size) { return AllocatedBuffer::AllocateManaged(env(), suggested_size).release(); } void UDPWrap::OnRecv(uv_udp_t* handle, ssize_t nread, const uv_buf_t* buf, const sockaddr* addr, unsigned int flags) { UDPWrap* wrap = ContainerOf(&UDPWrap::handle_, handle); wrap->listener()->OnRecv(nread, *buf, addr, flags); } void UDPWrap::OnRecv(ssize_t nread, const uv_buf_t& buf_, const sockaddr* addr, unsigned int flags) { Environment* env = this->env(); AllocatedBuffer buf(env, buf_); if (nread == 0 && addr == nullptr) { return; } HandleScope handle_scope(env->isolate()); Context::Scope context_scope(env->context()); Local argv[] = { Integer::New(env->isolate(), nread), object(), Undefined(env->isolate()), Undefined(env->isolate()) }; if (nread < 0) { MakeCallback(env->onmessage_string(), arraysize(argv), argv); return; } buf.Resize(nread); argv[2] = buf.ToBuffer().ToLocalChecked(); argv[3] = AddressToJS(env, addr); MakeCallback(env->onmessage_string(), arraysize(argv), argv); } MaybeLocal UDPWrap::Instantiate(Environment* env, AsyncWrap* parent, UDPWrap::SocketType type) { AsyncHooks::DefaultTriggerAsyncIdScope trigger_scope(parent); // If this assert fires then Initialize hasn't been called yet. CHECK_EQ(env->udp_constructor_function().IsEmpty(), false); return env->udp_constructor_function()->NewInstance(env->context()); } } // namespace node NODE_MODULE_CONTEXT_AWARE_INTERNAL(udp_wrap, node::UDPWrap::Initialize)