File 1213-Implement-undocumented-functions.patch of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 1213-Implement-undocumented-functions.patch of Package erlang (Revision 0fe77e0430484896ced2a4b48bef03d8)

Currently displaying revision 0fe77e0430484896ced2a4b48bef03d8 , Show latest

From e5d56f3579fe72c7c82051816f7726e8ae020795 Mon Sep 17 00:00:00 2001
From: Raimo Niskanen <raimo@erlang.org>
Date: Thu, 27 May 2021 14:30:51 +0200
Subject: [PATCH 3/3] Implement undocumented functions

---
 erts/emulator/nifs/common/prim_socket_nif.c |   2 +-
 lib/kernel/src/gen_tcp_socket.erl           | 103 +++++++++++--
 lib/kernel/src/inet.erl                     | 160 ++++++++++----------
 3 files changed, 167 insertions(+), 98 deletions(-)

diff --git a/erts/emulator/nifs/common/prim_socket_nif.c b/erts/emulator/nifs/common/prim_socket_nif.c
index 73004c5ab8..7ddc8ff2bb 100644
--- a/erts/emulator/nifs/common/prim_socket_nif.c
+++ b/erts/emulator/nifs/common/prim_socket_nif.c
@@ -8013,7 +8013,7 @@ ERL_NIF_TERM esock_recv(ErlNifEnv*       env,
     size_t       bufSz = (len != 0 ? len : descP->rBufSz);
 
     SSDBG( descP, ("SOCKET", "esock_recv {%d} -> entry with"
-                   "\r\n   count,size: (%ld:%u:lu)"
+                   "\r\n   count,size: (%ld:%u:%lu)"
                    "\r\n", descP->sock,
                    (long) len, descP->rNumCnt, (unsigned long) bufSz) );
 
diff --git a/lib/kernel/src/gen_tcp_socket.erl b/lib/kernel/src/gen_tcp_socket.erl
index cde37ebe24..83e897326d 100644
--- a/lib/kernel/src/gen_tcp_socket.erl
+++ b/lib/kernel/src/gen_tcp_socket.erl
@@ -39,10 +39,10 @@
 %% Utility
 -export([info/1, which_sockets/0, which_packet_type/1, socket_to_list/1]).
 
--ifdef(undefined).
+%% Undocumented or unsupported
 -export([unrecv/2]).
 -export([fdopen/2]).
--endif.
+
 
 %% gen_statem callbacks
 -export([init/1, callback_mode/0, terminate/3]).
@@ -150,14 +150,17 @@ connect_open(Addrs, Domain, ConnectOpts, Opts, ExtraOpts, Timer, BindAddr) ->
 	  ExtraOpts)
     of
         {ok, Server} ->
-            {Setopts, _} =
+            {Setopts_1, _} =
                 setopts_split(
                   #{socket => [], server_read => [], server_write => []},
                   ConnectOpts),
+            Setopts =
+                default_active_true(
+                  [{start_opts, StartOpts}] ++ SocketOpts ++ Setopts_1),
             ErrRef = make_ref(),
             try
-                ok(ErrRef, call(Server, {setopts, SocketOpts ++ Setopts})),
                 ok(ErrRef, call_bind(Server, BindAddr)),
+                ok(ErrRef, call(Server, {setopts, Setopts})),
                 DefaultError = {error, einval},
                 Socket =  
                     val(ErrRef,
@@ -200,6 +203,19 @@ extra_opts(OpenOpts) when is_list(OpenOpts) ->
    maps:from_list(OpenOpts).
 
 
+default_any(Domain, undefined = Undefined) ->
+    if
+        Domain =:= inet;
+        Domain =:= inet6 ->
+            #{family => Domain,
+              addr   => any,
+              port   => 0};
+        true ->
+            Undefined
+    end;
+default_any(_Domain, BindAddr) ->
+    BindAddr.
+
 bind_addr(_Domain, BindIP, BindPort) when BindIP =:= undefined ->
     0 = BindPort, % Assert
     %% Do not bind!
@@ -221,6 +237,15 @@ call_bind(_Server, undefined) ->
 call_bind(Server, BindAddr) ->
     call(Server, {bind, BindAddr}).
 
+
+default_active_true(Opts) ->
+    case lists:keyfind(active, 1, Opts) of
+        {active,_} ->
+            Opts;
+        _ ->
+            [{active,true} | Opts]
+    end.
+
 %% -------------------------------------------------------------------------
 
 listen(Port, Opts) ->
@@ -275,19 +300,18 @@ listen_open(Domain, ListenOpts, Opts, ExtraOpts, Backlog, BindAddr) ->
     case start_server(Domain, StartOpts, ExtraOpts) of
         {ok, Server} ->
 	    %% ?DBG([{server_started, Server}]),
-            {Setopts, _} =
+            {Setopts_1, _} =
                 setopts_split(
                   #{socket => [], server_read => [], server_write => []},
                   ListenOpts),
-	    %% ?DBG([{setopts, Setopts}]),
+	    %% ?DBG([{setopts, Setopts_1}]),
+            Setopts =
+                default_active_true(
+                  [{start_opts, StartOpts}] ++ SocketOpts ++ Setopts_1),
             ErrRef = make_ref(),
             try
-                ok(ErrRef,
-                   call(
-                     Server,
-                     {setopts,
-                      [{start_opts, StartOpts}] ++ SocketOpts ++ Setopts})),
-                ok(ErrRef, call_bind(Server, BindAddr)),
+                ok(ErrRef, call_bind(Server, default_any(Domain, BindAddr))),
+                ok(ErrRef, call(Server, {setopts, Setopts})),
                 Socket = val(ErrRef, call(Server, {listen, Backlog})),
                 {ok, ?MODULE_socket(Server, Socket)}
             catch
@@ -593,7 +617,51 @@ which_packet_type(?MODULE_socket(_Server, Socket)) ->
 	    error
     end.
 
-
+
+%% -------------------------------------------------------------------------
+%% Undocumented or unsupported
+%% -------------------------------------------------------------------------
+
+unrecv(?MODULE_socket(_Server, _Socket), _Data) ->
+    {error, enotsup}.
+
+fdopen(Fd, Opts) when is_integer(Fd), 0 =< Fd, is_list(Opts) ->
+    %% ?DBG({Fd, Opts}),
+    {EinvalOpts, Opts_1} = setopts_split(einval, Opts),
+    EinvalOpts =:= [] orelse exit(badarg),
+    {Mod, Opts_2} = inet:tcp_module(Opts_1),
+    Domain = domain(Mod),
+    {StartOpts_1, Opts_3} = setopts_split(start, Opts_2),
+    {SocketOpts, StartOpts} = setopts_split(socket, StartOpts_1),
+    ExtraOpts = extra_opts(Fd),
+    case
+        start_server(
+          Domain,
+          [{timeout, infinity} | start_opts(StartOpts)],
+          ExtraOpts)
+    of
+        {ok, Server} ->
+            {Setopts_1, _} =
+                setopts_split(
+                  #{socket => [], server_read => [], server_write => []},
+                  Opts_3),
+            Setopts = [{start_opts, StartOpts}] ++ SocketOpts ++ Setopts_1,
+            ErrRef = make_ref(),
+            try
+                ok(ErrRef, call(Server, {setopts, Setopts})),
+                Socket = val(ErrRef, call(Server, fdopen)),
+                {ok, ?MODULE_socket(Server, Socket)}
+            catch
+                throw : {ErrRef, Reason} ->
+                    close_server(Server),
+                    ?badarg_exit({error, Reason})
+            end;
+        {error, {shutdown, Reason}} ->
+            ?badarg_exit({error, Reason});
+        {error, _} = Error ->
+            ?badarg_exit(Error)
+    end.
+
 %%% ========================================================================
 %%% Socket glue code
 %%%
@@ -1020,7 +1088,7 @@ server_read_write_opts() ->
 server_read_opts() ->
     %% Read side only opts
     maps:merge(
-      #{active => true,
+      #{active => false, % inet_drv also has this default
         mode => list,
         header => 0,
         deliver => term,
@@ -1535,6 +1603,13 @@ handle_event(
   {call, From}, {recv, _Length, _Timeout}, 'connect' = _State, _P_D) ->
     {keep_state_and_data,
      [{reply, From, {error, enotconn}}]};
+%% Call: fdopen/2
+handle_event(
+  {call, From}, fdopen, 'connect' = _State,
+  {#params{socket = Socket} = P, D}) ->
+    handle_connected(
+      P, D#{type => fdopen},
+      [{reply, From, {ok, Socket}}]);
 handle_event(Type, Content, 'connect' = State, P_D) ->
     handle_unexpected(Type, Content, State, P_D);
 %%
diff --git a/lib/kernel/src/inet.erl b/lib/kernel/src/inet.erl
index d4fee7dac6..ca488aa2e0 100644
--- a/lib/kernel/src/inet.erl
+++ b/lib/kernel/src/inet.erl
@@ -1536,8 +1536,9 @@ gethostbyaddr_tm_native(Addr, Timer, Opts) ->
 	Result -> Result
     end.
 
+
 -spec open(Fd_or_OpenOpts :: integer() | list(),
-	   Addr ::
+	   BAddr ::
 	     socket_address() |
 	     {ip_address() | 'any' | 'loopback', % Unofficial
 	      port_number()} |
@@ -1548,7 +1549,7 @@ gethostbyaddr_tm_native(Addr, Timer, Opts) ->
 	      {ip6_address() | 'any' | 'loopback',
 	       port_number()}} |
 	     undefined, % Internal - no bind()
-	   Port :: port_number(),
+	   BPort :: port_number(),
 	   Opts :: [socket_setopt()],
 	   Protocol :: socket_protocol(),
 	   Family :: address_family(),
@@ -1556,51 +1557,20 @@ gethostbyaddr_tm_native(Addr, Timer, Opts) ->
 	   Module :: atom()) ->
 	{'ok', port()} | {'error', posix()}.
 
-open(Fd, Addr, Port, Opts, Protocol, Family, Type, Module)
+open(Fd, BAddr, BPort, Opts, Protocol, Family, Type, Module)
   when is_integer(Fd), 0 =< Fd ->
-    fdopen(Fd, Addr, Port, Opts, Protocol, Family, Type, Module);
-open(Fd_O, Addr, Port, Opts, Protocol, Family, Type, Module) ->
-    open_opts(Fd_O, Addr, Port, Opts, Protocol, Family, Type, Module).
-
-
-open_opts(Fd_O, Addr, Port, Opts, Protocol, Family, Type, Module) ->
-    OpenOpts =
-	if
-            is_list(Fd_O) -> Fd_O;
-	    true -> []
-	end,
-    case prim_inet:open(Protocol, Family, Type, OpenOpts) of
-	{ok,S} ->
-	    case prim_inet:setopts(S, Opts) of
-		ok when Addr =:= undefined ->
-		    inet_db:register_socket(S, Module),
-		    {ok,S};
-		ok ->
-		    case bind(S, Addr, Port) of
-			{ok, _} ->
-			    inet_db:register_socket(S, Module),
-			    {ok,S};
-			Error  ->
-			    prim_inet:close(S),
-			    Error
-		    end;
-		Error  ->
-		    prim_inet:close(S),
-		    Error
-	    end;
-	Error ->
-	    Error
-    end.
-
+    open_fd(Fd, BAddr, BPort, Opts, Protocol, Family, Type, Module);
+open(Fd_or_OpenOpts, BAddr, BPort, Opts, Protocol, Family, Type, Module) ->
+    open_opts(
+      Fd_or_OpenOpts, BAddr, BPort, Opts, Protocol, Family, Type, Module).
 
 %% The only difference between open/8 and open_bind/8 is that
 %% if Fd_O is not a (file descriptor :: non_neg_integer())
 %% the latter translates Addr =:= 'undefined' to 'any',
-%% causing open_opts/8 to bind to the wildcard address
-
+%% causing open_setopts/5 to bind to the wildcard address
 
 -spec open_bind(Fd_or_OpenOpts :: integer() | list(),
-                Addr ::
+                BAddr ::
                   socket_address() |
                   {ip_address() | 'any' | 'loopback', % Unofficial
                    port_number()} |
@@ -1611,7 +1581,7 @@ open_opts(Fd_O, Addr, Port, Opts, Protocol, Family, Type, Module) ->
                    {ip6_address() | 'any' | 'loopback',
                     port_number()}} |
                   undefined, % Internal - translated to 'any'
-                Port :: port_number(),
+                BPort :: port_number(),
                 Opts :: [socket_setopt()],
                 Protocol :: socket_protocol(),
                 Family :: address_family(),
@@ -1619,14 +1589,72 @@ open_opts(Fd_O, Addr, Port, Opts, Protocol, Family, Type, Module) ->
                 Module :: atom()) ->
                        {'ok', port()} | {'error', posix()}.
 
-open_bind(Fd, Addr, Port, Opts, Protocol, Family, Type, Module)
+open_bind(Fd, BAddr, BPort, Opts, Protocol, Family, Type, Module)
   when is_integer(Fd), 0 =< Fd ->
-    fdopen(Fd, Addr, Port, Opts, Protocol, Family, Type, Module);
-open_bind(Fd_O, undefined, Port, Opts, Protocol, Family, Type, Module) ->
-    Addr = translate_ip(any, Family),
-    open_opts(Fd_O, Addr, Port, Opts, Protocol, Family, Type, Module);
-open_bind(Fd_O, Addr, Port, Opts, Protocol, Family, Type, Module) ->
-    open_opts(Fd_O, Addr, Port, Opts, Protocol, Family, Type, Module).
+    open_fd(Fd, BAddr, BPort, Opts, Protocol, Family, Type, Module);
+open_bind(
+  Fd_or_OpenOpts, BAddr, BPort, Opts, Protocol, Family, Type, Module) ->
+    open_opts(
+      Fd_or_OpenOpts,
+      if
+          BAddr =:= undefined ->
+              translate_ip(any, Family);
+          true ->
+              BAddr
+      end, BPort, Opts, Protocol, Family, Type, Module).
+
+
+open_fd(Fd, BAddr, BPort, Opts, Protocol, Family, Type, Module) ->
+    DoNotBind =
+	%% We do not do any binding if no port+addr options
+	%% were given, in order to keep backwards compatability
+	%% with pre Erlang/OTP 17
+        BAddr =:= undefined, % Presumably already bound
+    if
+        DoNotBind ->
+            0 = BPort, ok; % Assertion
+        true ->
+            ok
+    end,
+    case prim_inet:fdopen(Protocol, Family, Type, Fd, DoNotBind) of
+	{ok, S} ->
+            open_setopts(S, BAddr, BPort, Opts, Module);
+        Error ->
+            Error
+    end.
+
+open_opts(Fd_or_OpenOpts, BAddr, BPort, Opts, Protocol, Family, Type, Module) ->
+    OpenOpts =
+	if
+            is_list(Fd_or_OpenOpts) -> Fd_or_OpenOpts;
+	    true -> []
+	end,
+    case prim_inet:open(Protocol, Family, Type, OpenOpts) of
+	{ok,S} ->
+            open_setopts(S, BAddr, BPort, Opts, Module);
+        Error ->
+            Error
+    end.
+
+open_setopts(S, BAddr, BPort, Opts, Module) ->
+    case prim_inet:setopts(S, Opts) of
+        ok when BAddr =:= undefined ->
+            inet_db:register_socket(S, Module),
+            {ok,S};
+        ok ->
+            case bind(S, BAddr, BPort) of
+                {ok, _} ->
+                    inet_db:register_socket(S, Module),
+                    {ok,S};
+                Error  ->
+                    prim_inet:close(S),
+                    Error
+            end;
+        Error  ->
+            prim_inet:close(S),
+            Error
+    end.
+
 
 
 bind(S, Addr, Port) when is_list(Addr) ->
@@ -1672,41 +1700,7 @@ change_bindx_0_port({_IP, _Port}=Addr, _AssignedPort) ->
 
 fdopen(Fd, Opts, Protocol, Family, Type, Module)
   when is_integer(Fd), 0 =< Fd ->
-    fdopen(Fd, undefined, 0, Opts, Protocol, Family, Type, Module).
-
-fdopen(Fd, Addr, Port, Opts, Protocol, Family, Type, Module) ->
-    DoNotBind =
-	%% We do not do any binding if no port+addr options
-	%% were given, in order to keep backwards compatability
-	%% with pre Erlang/OTP 17
-        Addr =:= undefined, % Presumably already bound
-    if
-        DoNotBind ->
-            0 = Port, ok; % Assertion
-        true ->
-            ok
-    end,
-    case prim_inet:fdopen(Protocol, Family, Type, Fd, DoNotBind) of
-	{ok, S} ->
-	    case prim_inet:setopts(S, Opts) of
-		ok when DoNotBind ->
-		    inet_db:register_socket(S, Module),
-		    {ok, S};
-		ok ->
-		    case bind(S, Addr, Port) of
-			{ok, _} ->
-			    inet_db:register_socket(S, Module),
-			    {ok, S};
-			Error  ->
-			    prim_inet:close(S),
-			    Error
-                    end;
-		Error ->
-		    prim_inet:close(S),
-		    Error
-	    end;
-	Error -> Error
-    end.
+    open_fd(Fd, undefined, 0, Opts, Protocol, Family, Type, Module).
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 %%  socket stat
-- 
2.26.2

Places

File 1213-Implement-undocumented-functions.patch of Package erlang (Revision 0fe77e0430484896ced2a4b48bef03d8)

Places