[esock,kernel] net -> prim_net and add (new) net

Renamed the current preloaded net module to prim_net
and removed the deprecated functions (call, cast, ...).
Introduce a "new" net module (in kernel) as an interface
module to the (preloaded) prim_net. This one also contains
the deprecated functions (call, cast, ...).

OTP-15765

14 files changed, 309 insertions, 88 deletions

diff --git a/erts/emulator/Makefile.in b/erts/emulator/Makefile.in
index a9f3bb8e89..ba5ba8abef 100644
--- a/erts/emulator/Makefile.in
+++ b/erts/emulator/Makefile.in
@@ -636,10 +636,9 @@ GENERATE += $(TTF_DIR)/driver_tab.c
 ifeq ($(USE_ESOCK), yes)
 ESOCK_PRELOAD_BEAM = \
 	$(ERL_TOP)/erts/preloaded/ebin/socket.beam \
-	$(ERL_TOP)/erts/preloaded/ebin/net.beam
+	$(ERL_TOP)/erts/preloaded/ebin/prim_net.beam
 else
-ESOCK_PRELOAD_BEAM = \
-	$(ERL_TOP)/erts/preloaded/ebin/net.beam
+ESOCK_PRELOAD_BEAM =
 endif
 
 PRELOAD_BEAM =	$(ERL_TOP)/erts/preloaded/ebin/erts_code_purger.beam \
@@ -850,7 +849,7 @@ ifeq ($(USE_ESOCK), yes)
 
 ESOCK_NIF_OBJS = \
 	$(OBJDIR)/socket_nif.o \
-	$(OBJDIR)/net_nif.o
+	$(OBJDIR)/prim_net_nif.o
 
 ifneq ($(TARGET), win32)
 # These are *currently* only needed for non-win32,
diff --git a/erts/emulator/nifs/common/net_nif.c b/erts/emulator/nifs/common/prim_net_nif.c
index 8a69052935..11a8ff724e 100644
--- a/erts/emulator/nifs/common/net_nif.c
+++ b/erts/emulator/nifs/common/prim_net_nif.c
@@ -1653,4 +1653,4 @@ LOCAL_ERROR_REASON_ATOMS
     return !net;
 }
 
-ERL_NIF_INIT(net, net_funcs, on_load, NULL, NULL, NULL)
+ERL_NIF_INIT(prim_net, net_funcs, on_load, NULL, NULL, NULL)
diff --git a/erts/emulator/test/net_SUITE.erl b/erts/emulator/test/net_SUITE.erl
index 6111fc76a5..c6e77a5373 100644
--- a/erts/emulator/test/net_SUITE.erl
+++ b/erts/emulator/test/net_SUITE.erl
@@ -20,6 +20,8 @@
 
 %%
 %% This test suite is basically a "placeholder" for a proper test suite...
+%% Also we should really call prim_net directly, and not net (since that does
+%% not even reside here).
 %%
 
 %% Run the entire test suite: 
@@ -127,6 +129,7 @@ api_basic_cases() ->
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 init_per_suite(Config) ->
+    %% We test on the socket module for simplicity
     case lists:member(socket, erlang:loaded()) of
         true ->
             case os:type() of
diff --git a/erts/preloaded/ebin/erl_init.beam b/erts/preloaded/ebin/erl_init.beam
index 0c032e8e91..1d54e0cead 100644
--- a/erts/preloaded/ebin/erl_init.beam
+++ b/erts/preloaded/ebin/erl_init.beam
diff --git a/erts/preloaded/ebin/net.beam b/erts/preloaded/ebin/net.beam
deleted file mode 100644
index 88d546a3af..0000000000
--- a/erts/preloaded/ebin/net.beam
+++ /dev/null
diff --git a/erts/preloaded/ebin/prim_net.beam b/erts/preloaded/ebin/prim_net.beam
new file mode 100644
index 0000000000..9d50b3210f
--- /dev/null
+++ b/erts/preloaded/ebin/prim_net.beam
diff --git a/erts/preloaded/src/Makefile b/erts/preloaded/src/Makefile
index 27d450c873..e1bb2ee5c4 100644
--- a/erts/preloaded/src/Makefile
+++ b/erts/preloaded/src/Makefile
@@ -36,10 +36,9 @@ include $(ERL_TOP)/lib/kernel/vsn.mk
 ifeq ($(USE_ESOCK), yes)
 PRE_LOADED_ERL_ESOCK_MODULES = \
 	socket \
-	net
+	prim_net
 else
-PRE_LOADED_ERL_ESOCK_MODULES = \
-	net
+PRE_LOADED_ERL_ESOCK_MODULES =
 endif
 
 PRE_LOADED_ERL_MODULES = \
@@ -82,9 +81,9 @@ APP_FILE= erts.app
 APP_SRC= $(APP_FILE).src
 APP_TARGET= $(STATIC_EBIN)/$(APP_FILE)
 ifeq ($(USE_ESOCK), yes)
-APP_ESOCK_MODS= net, socket
+APP_ESOCK_MODS= prim_net, socket
 else
-APP_ESOCK_MODS= net
+APP_ESOCK_MODS=
 endif
 
 
diff --git a/erts/preloaded/src/erl_init.erl b/erts/preloaded/src/erl_init.erl
index d209c4033b..9fcb3969e4 100644
--- a/erts/preloaded/src/erl_init.erl
+++ b/erts/preloaded/src/erl_init.erl
@@ -35,7 +35,8 @@ start(Mod, BootArgs) ->
     erl_tracer:on_load(),
     prim_buffer:on_load(),
     prim_file:on_load(),
-    conditional_load(socket, [socket, net]), % socket:on_load(), net:on_load(),
+    %% socket:on_load(), prim_net:on_load(),
+    conditional_load(socket, [socket, prim_net]),
     %% Proceed to the specified boot module
     run(Mod, boot, BootArgs).
 
diff --git a/erts/preloaded/src/net.erl b/erts/preloaded/src/prim_net.erl
index 13d2e3a117..107043d1aa 100644
--- a/erts/preloaded/src/net.erl
+++ b/erts/preloaded/src/prim_net.erl
@@ -18,7 +18,7 @@
 %% %CopyrightEnd%
 %%
 
--module(net).
+-module(prim_net).
 
 -compile(no_native).
 
@@ -31,22 +31,14 @@
 
 -export([
          gethostname/0,
-         getnameinfo/1, getnameinfo/2,
-         getaddrinfo/1, getaddrinfo/2,
+         getnameinfo/2,
+         getaddrinfo/2,
 
          if_name2index/1,
          if_index2name/1,
          if_names/0
         ]).
 
-%% Deprecated functions from the "old" net module
--export([call/4,
-	 cast/4,
-	 broadcast/3,
-	 ping/1,
-	 relay/1,
-	 sleep/1]).
-
 -export_type([
               address_info/0,
               name_info/0,
@@ -59,13 +51,6 @@
               network_interface_index/0
              ]).
 
--deprecated({call,      4, eventually}).
--deprecated({cast,      4, eventually}).
--deprecated({broadcast, 3, eventually}).
--deprecated({ping,      1, eventually}).
--deprecated({relay,     1, eventually}).
--deprecated({sleep,     1, eventually}).
-
 
 -type name_info_flags()         :: [name_info_flag()|name_info_flag_ext()].
 -type name_info_flag()          :: namereqd |
@@ -88,21 +73,6 @@
 
 %% ===========================================================================
 %%
-%% D E P R E C A T E D   F U N C T I O N S
-%%
-%% ===========================================================================
-
-call(N,M,F,A) -> rpc:call(N,M,F,A).
-cast(N,M,F,A) -> rpc:cast(N,M,F,A).
-broadcast(M,F,A) -> rpc:eval_everywhere(M,F,A).
-ping(Node) -> net_adm:ping(Node).
-sleep(T) -> receive after T -> ok end.
-relay(X) -> slave:relay(X).
-
-
-
-%% ===========================================================================
-%%
 %% Administrative and utility API
 %%
 %% ===========================================================================
@@ -117,7 +87,7 @@ on_load() ->
       Extra :: map().
 
 on_load(Extra) ->
-    ok = erlang:load_nif(atom_to_list(?MODULE), Extra).
+    ok = erlang:load_nif(atom_to_list(net), Extra).
 
 
 -spec info() -> list().
@@ -159,14 +129,6 @@ gethostname() ->
 %%
 %%
 
--spec getnameinfo(SockAddr) -> {ok, Info} | {error, Reason} when
-      SockAddr :: socket:sockaddr(),
-      Info     :: name_info(),
-      Reason   :: term().
-
-getnameinfo(SockAddr) ->
-    getnameinfo(SockAddr, undefined).
-
 -spec getnameinfo(SockAddr, Flags) -> {ok, Info} | {error, Reason} when
       SockAddr :: socket:sockaddr(),
       Flags    :: name_info_flags() | undefined,
@@ -178,44 +140,18 @@ getnameinfo(SockAddr, [] = _Flags) ->
 getnameinfo(#{family := Fam, addr := _Addr} = SockAddr, Flags)
   when ((Fam =:= inet) orelse (Fam =:= inet6)) andalso 
        (is_list(Flags) orelse (Flags =:= undefined)) ->
-    nif_getnameinfo((catch ensure_sockaddr(SockAddr)), Flags);
+    nif_getnameinfo(socket:ensure_sockaddr(SockAddr), Flags);
 getnameinfo(#{family := Fam, path := _Path} = SockAddr, Flags)
   when (Fam =:= local) andalso (is_list(Flags) orelse (Flags =:= undefined)) ->
     nif_getnameinfo(SockAddr, Flags).
 
 
-%% This function is intended to "handle" the case when the user
-%% has built their (OTP) system with "--disable-esock".
-%% That means the socket module does not exist. This is not really
-%% a problem since the nif_getnameinfo won't work either (since
-%% the nif file is not part of the system). The result of calling
-%% getnameinfo will be a undef exception (erlang:nif_error(undef)).
-%%
-%% The only functions in this module that actually work in this case
-%% (--disable-esock) is the depricated stuff (call, cast, ...).
-%%
-ensure_sockaddr(SockAddr) ->
-    try socket:ensure_sockaddr(SockAddr)
-    catch
-        error:undef:_ ->
-            undefined
-    end.
-
 %% ===========================================================================
 %%
 %% getaddrinfo - Network address and service translation
 %%
 %% There is also a "hint" argument that we "at some point" should implement.
 
--spec getaddrinfo(Host) -> {ok, Info} | {error, Reason} when
-      Host    :: string(),
-      Info    :: [address_info()],
-      Reason  :: term().
-
-getaddrinfo(Host) when is_list(Host) ->
-    getaddrinfo(Host, undefined).
-
-
 -spec getaddrinfo(Host, undefined) -> {ok, Info} | {error, Reason} when
       Host    :: string(),
       Info    :: [address_info()],
diff --git a/lib/kernel/src/Makefile b/lib/kernel/src/Makefile
index fcb599859b..88752431eb 100644
--- a/lib/kernel/src/Makefile
+++ b/lib/kernel/src/Makefile
@@ -1,7 +1,7 @@
 #
 # %CopyrightBegin%
 #
-# Copyright Ericsson AB 1996-2018. All Rights Reserved.
+# Copyright Ericsson AB 1996-2019. All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -123,6 +123,7 @@ MODULES = \
         logger_server \
         logger_simple_h \
         logger_sup \
+	net \
 	net_adm \
 	net_kernel \
 	os \
@@ -180,6 +181,7 @@ ERL_COMPILE_FLAGS += -Werror
 endif
 ERL_COMPILE_FLAGS += -I../include
 
+
 # ----------------------------------------------------
 # Targets
 # ----------------------------------------------------
diff --git a/lib/kernel/src/net.erl b/lib/kernel/src/net.erl
new file mode 100644
index 0000000000..ac8b600e4b
--- /dev/null
+++ b/lib/kernel/src/net.erl
@@ -0,0 +1,278 @@
+%%
+%% %CopyrightBegin%
+%%
+%% Copyright Ericsson AB 2019-2019. All Rights Reserved.
+%%
+%% Licensed under the Apache License, Version 2.0 (the "License");
+%% you may not use this file except in compliance with the License.
+%% You may obtain a copy of the License at
+%%
+%%     http://www.apache.org/licenses/LICENSE-2.0
+%%
+%% Unless required by applicable law or agreed to in writing, software
+%% distributed under the License is distributed on an "AS IS" BASIS,
+%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+%% See the License for the specific language governing permissions and
+%% limitations under the License.
+%%
+%% %CopyrightEnd%
+%%
+
+-module(net).
+
+-ifdef(USE_ESOCK).
+%% Administrative and utility functions
+-export([
+	 info/0,
+         command/1
+        ]).
+
+-export([
+         gethostname/0,
+         getnameinfo/1, getnameinfo/2,
+         getaddrinfo/1, getaddrinfo/2,
+
+         if_name2index/1,
+         if_index2name/1,
+         if_names/0
+        ]).
+-endif.
+
+%% Deprecated functions from the "old" net module
+-export([call/4,
+	 cast/4,
+	 broadcast/3,
+	 ping/1,
+	 relay/1,
+	 sleep/1]).
+
+-ifdef(USE_ESOCK).
+
+%% Should we define these here or refer to the prim_net module
+-export_type([
+              address_info/0,
+              name_info/0,
+
+              name_info_flags/0,
+              name_info_flag/0,
+              name_info_flag_ext/0,
+
+              network_interface_name/0,
+              network_interface_index/0
+             ]).
+-endif.
+
+-deprecated({call,      4, eventually}).
+-deprecated({cast,      4, eventually}).
+-deprecated({broadcast, 3, eventually}).
+-deprecated({ping,      1, eventually}).
+-deprecated({relay,     1, eventually}).
+-deprecated({sleep,     1, eventually}).
+
+
+-ifdef(USE_ESOCK).
+-type name_info_flags()         :: prim_net:name_info_flags().
+-type name_info_flag()          :: prim_net:name_info_flag().
+-type name_info_flag_ext()      :: prim_net:name_info_flag_ext().
+-type name_info()               :: prim_net:name_info().
+-type address_info()            :: prim_net:address_info().
+-type network_interface_name()  :: prim_net:network_interface_name().
+-type network_interface_index() :: prim_net:network_interface_index().
+
+%% -type name_info_flags()         :: [name_info_flag()|name_info_flag_ext()].
+%% -type name_info_flag()          :: namereqd |
+%%                                    dgram |
+%%                                    nofqdn |
+%%                                    numerichost |
+%%                                    nomericserv.
+%% -type name_info_flag_ext()      :: idn |
+%%                                    idna_allow_unassigned |
+%%                                    idna_use_std3_ascii_rules.
+%% -type name_info()               :: #{host    := string(),
+%%                                      service := string()}.
+%% -type address_info()            :: #{family   := socket:domain(),
+%%                                      socktype := socket:type(),
+%%                                      protocol := socket:protocol(),
+%%                                      address  := socket:sockaddr()}.
+%% -type network_interface_name()  :: string().
+%% -type network_interface_index() :: non_neg_integer().
+
+-endif.
+
+
+%% ===========================================================================
+%%
+%% D E P R E C A T E D   F U N C T I O N S
+%%
+%% ===========================================================================
+
+call(N,M,F,A) -> rpc:call(N,M,F,A).
+cast(N,M,F,A) -> rpc:cast(N,M,F,A).
+broadcast(M,F,A) -> rpc:eval_everywhere(M,F,A).
+ping(Node) -> net_adm:ping(Node).
+sleep(T) -> receive after T -> ok end.
+relay(X) -> slave:relay(X).
+
+
+-ifdef(USE_ESOCK).
+
+%% ===========================================================================
+%%
+%% Administrative and utility API
+%%
+%% ===========================================================================
+
+-spec info() -> list().
+
+info() ->
+    prim_net:info().
+
+
+-spec command(Cmd :: term()) -> term().
+
+command(Cmd) ->
+    prim_net:command(Cmd).
+
+
+
+%% ===========================================================================
+%%
+%% The proper net API
+%%
+%% ===========================================================================
+
+%% ===========================================================================
+%%
+%% gethostname - Get the name of the current host.
+%%
+%%
+
+-spec gethostname() -> {ok, HostName} | {error, Reason} when
+      HostName :: string(),
+      Reason   :: term().
+
+gethostname() ->
+    prim_net:gethostname().
+
+
+%% ===========================================================================
+%%
+%% getnameinfo - Address-to-name translation in protocol-independent manner.
+%%
+%%
+
+-spec getnameinfo(SockAddr) -> {ok, Info} | {error, Reason} when
+      SockAddr :: socket:sockaddr(),
+      Info     :: name_info(),
+      Reason   :: term().
+
+getnameinfo(SockAddr) ->
+    getnameinfo(SockAddr, undefined).
+
+-spec getnameinfo(SockAddr, Flags) -> {ok, Info} | {error, Reason} when
+      SockAddr :: socket:sockaddr(),
+      Flags    :: name_info_flags() | undefined,
+      Info     :: name_info(),
+      Reason   :: term().
+
+getnameinfo(SockAddr, [] = _Flags) ->
+    getnameinfo(SockAddr, undefined);
+getnameinfo(#{family := Fam, addr := _Addr} = SockAddr, Flags)
+  when ((Fam =:= inet) orelse (Fam =:= inet6)) andalso 
+       (is_list(Flags) orelse (Flags =:= undefined)) ->
+    prim_net:getnameinfo(socket:ensure_sockaddr(SockAddr), Flags);
+getnameinfo(#{family := Fam, path := _Path} = SockAddr, Flags)
+  when (Fam =:= local) andalso (is_list(Flags) orelse (Flags =:= undefined)) ->
+    prim_net:getnameinfo(SockAddr, Flags).
+
+
+
+%% ===========================================================================
+%%
+%% getaddrinfo - Network address and service translation
+%%
+%% There is also a "hint" argument that we "at some point" should implement.
+
+-spec getaddrinfo(Host) -> {ok, Info} | {error, Reason} when
+      Host    :: string(),
+      Info    :: [address_info()],
+      Reason  :: term().
+
+getaddrinfo(Host) when is_list(Host) ->
+    getaddrinfo(Host, undefined).
+
+
+-spec getaddrinfo(Host, undefined) -> {ok, Info} | {error, Reason} when
+      Host    :: string(),
+      Info    :: [address_info()],
+      Reason  :: term()
+                 ; (undefined, Service) -> {ok, Info} | {error, Reason} when
+      Service :: string(),
+      Info    :: [address_info()],
+      Reason  :: term()
+                 ; (Host, Service) -> {ok, Info} | {error, Reason} when
+      Host    :: string(),
+      Service :: string(),
+      Info    :: [address_info()],
+      Reason  :: term().
+
+getaddrinfo(Host, Service)
+  when (is_list(Host) orelse (Host =:= undefined)) andalso
+       (is_list(Service) orelse (Service =:= undefined)) andalso
+       (not ((Service =:= undefined) andalso (Host =:= undefined))) ->
+    prim_net:getaddrinfo(Host, Service).
+
+
+
+%% ===========================================================================
+%%
+%% if_name2index - Mappings between network interface names and indexes:
+%%                 name -> idx
+%%
+%%
+
+-spec if_name2index(Name) -> {ok, Idx} | {error, Reason} when
+      Name   :: network_interface_name(),
+      Idx    :: network_interface_index(),
+      Reason :: term().
+
+if_name2index(If) when is_list(If) ->
+    prim_net:if_name2index(If).
+
+
+
+%% ===========================================================================
+%%
+%% if_index2name - Mappings between network interface index and names:
+%%                 idx -> name
+%%
+%%
+
+-spec if_index2name(Idx) -> {ok, Name} | {error, Reason} when
+      Idx    :: network_interface_index(),
+      Name   :: network_interface_name(),
+      Reason :: term().
+
+if_index2name(Idx) when is_integer(Idx) ->
+    prim_net:if_index2name(Idx).
+
+
+
+%% ===========================================================================
+%%
+%% if_names - Get network interface names and indexes
+%%
+%%
+
+-spec if_names() -> Names | {error, Reason} when
+      Names  :: [{Idx, If}],
+      Idx    :: network_interface_index(),
+      If     :: network_interface_name(),
+      Reason :: term().
+
+if_names() ->
+    prim_net:if_names().
+
+
+
+-endif.
diff --git a/lib/sasl/src/Makefile b/lib/sasl/src/Makefile
index fd62588f5c..a5b9a5e731 100644
--- a/lib/sasl/src/Makefile
+++ b/lib/sasl/src/Makefile
@@ -63,9 +63,6 @@ TARGET_FILES= $(MODULES:%=$(EBIN)/%.$(EMULATOR)) $(APP_TARGET) $(APPUP_TARGET)
 # ----------------------------------------------------
 
 ERL_COMPILE_FLAGS += -I../../stdlib/include -Werror
-ifeq ($(USE_ESOCK), yes)
-ERL_COMPILE_FLAGS += -DUSE_ESOCK=true
-endif
 
 
 # ----------------------------------------------------
diff --git a/lib/sasl/src/systools_make.erl b/lib/sasl/src/systools_make.erl
index b5a6b44f93..c5d4b9bef3 100644
--- a/lib/sasl/src/systools_make.erl
+++ b/lib/sasl/src/systools_make.erl
@@ -47,9 +47,11 @@
 -compile({inline,[{badarg,2}]}).
 
 -ifdef(USE_ESOCK).
--define(ESOCK_MODS, [socket]).
+-define(ESOCK_SOCKET_MODS, [socket]).
+-define(ESOCK_NET_MODS,    [prim_net]).
 -else.
--define(ESOCK_MODS, []).
+-define(ESOCK_SOCKET_MODS, []).
+-define(ESOCK_NET_MODS,    []).
 -endif.
 
 
@@ -1573,8 +1575,8 @@ preloaded() ->
     [atomics,counters,erl_init,erl_prim_loader,erl_tracer,erlang,
      erts_code_purger,erts_dirty_process_signal_handler,
      erts_internal,erts_literal_area_collector,
-     init,net,persistent_term,prim_buffer,prim_eval,prim_file,
-     prim_inet,prim_zip] ++ ?ESOCK_MODS ++ [zlib].
+     init,persistent_term,prim_buffer,prim_eval,prim_file,
+     prim_inet] ++ ?ESOCK_NET_MODS ++ [prim_zip] ++ ?ESOCK_SOCKET_MODS ++ [zlib].
 
 %%______________________________________________________________________
 %% Kernel processes; processes that are specially treated by the init
diff --git a/make/otp.mk.in b/make/otp.mk.in
index cdddb90734..cc76f00e7e 100644
--- a/make/otp.mk.in
+++ b/make/otp.mk.in
@@ -110,6 +110,10 @@ ifdef BOOTSTRAP
 else
   ERL_COMPILE_FLAGS += +debug_info
 endif
+ifeq ($(USE_ESOCK),yes)
+ERL_COMPILE_FLAGS += -DUSE_ESOCK=true
+endif
+
 ERLC_WFLAGS = -W
 ERLC = erlc $(ERLC_WFLAGS) $(ERLC_FLAGS)
 ERL = erl -boot start_clean