[socket-nif] Add support for socket (level ip) option multicast_ttl

Added support for the IP option MULTICAST_TTL.

OTP-14831

4 files changed, 72 insertions, 16 deletions

diff --git a/erts/emulator/nifs/common/socket_nif.c b/erts/emulator/nifs/common/socket_nif.c
index 95f29f3dd8..f73364f28f 100644
--- a/erts/emulator/nifs/common/socket_nif.c
+++ b/erts/emulator/nifs/common/socket_nif.c
@@ -363,6 +363,7 @@ typedef union {
 #define SOCKET_OPT_SOCK_TYPE       32
 
 #define SOCKET_OPT_IP_MULTICAST_LOOP 15
+#define SOCKET_OPT_IP_MULTICAST_TTL  16
 #define SOCKET_OPT_IP_RECVTOS        25
 #define SOCKET_OPT_IP_ROUTER_ALERT   28
 #define SOCKET_OPT_IP_TOS            30
@@ -849,6 +850,11 @@ static ERL_NIF_TERM nsetopt_lvl_ip_multicast_loop(ErlNifEnv*        env,
                                                   SocketDescriptor* descP,
                                                   ERL_NIF_TERM      eVal);
 #endif
+#if defined(IP_MULTICAST_TTL)
+static ERL_NIF_TERM nsetopt_lvl_ip_multicast_ttl(ErlNifEnv*        env,
+                                                 SocketDescriptor* descP,
+                                                 ERL_NIF_TERM      eVal);
+#endif
 #if defined(IP_RECVTOS)
 static ERL_NIF_TERM nsetopt_lvl_ip_recvtos(ErlNifEnv*        env,
                                            SocketDescriptor* descP,
@@ -1021,6 +1027,10 @@ static ERL_NIF_TERM ngetopt_lvl_ip(ErlNifEnv*        env,
 static ERL_NIF_TERM ngetopt_lvl_ip_multicast_loop(ErlNifEnv*        env,
                                                   SocketDescriptor* descP);
 #endif
+#if defined(IP_MULTICAST_TTL)
+static ERL_NIF_TERM ngetopt_lvl_ip_multicast_ttl(ErlNifEnv*        env,
+                                                 SocketDescriptor* descP);
+#endif
 #if defined(IP_RECVTOS)
 static ERL_NIF_TERM ngetopt_lvl_ip_recvtos(ErlNifEnv*        env,
                                            SocketDescriptor* descP);
@@ -3952,6 +3962,12 @@ ERL_NIF_TERM nsetopt_lvl_ip(ErlNifEnv*        env,
         break;
 #endif
 
+#if defined(IP_MULTICAST_TTL)
+    case SOCKET_OPT_IP_MULTICAST_TTL:
+        result = nsetopt_lvl_ip_multicast_ttl(env, descP, eVal);
+        break;
+#endif
+
 #if defined(IP_RECVTOS)
     case SOCKET_OPT_IP_RECVTOS:
         result = nsetopt_lvl_ip_recvtos(env, descP, eVal);
@@ -4004,6 +4020,25 @@ ERL_NIF_TERM nsetopt_lvl_ip_multicast_loop(ErlNifEnv*        env,
 #endif
 
 
+/* nsetopt_lvl_ip_multicast_ttl - Level IP MULTICAST_TTL option
+ */
+#if defined(IP_MULTICAST_TTL)
+static
+ERL_NIF_TERM nsetopt_lvl_ip_multicast_ttl(ErlNifEnv*        env,
+                                          SocketDescriptor* descP,
+                                          ERL_NIF_TERM      eVal)
+{
+#if defined(SOL_IP)
+    int level = SOL_IP;
+#else
+    int level = IPPROTO_IP;
+#endif
+
+    return nsetopt_int_opt(env, descP, level, IP_MULTICAST_TTL, eVal);
+}
+#endif
+
+
 /* nsetopt_lvl_ip_recvtos - Level IP RECVTOS option
  */
 #if defined(IP_RECVTOS)
@@ -5237,6 +5272,12 @@ ERL_NIF_TERM ngetopt_lvl_ip(ErlNifEnv*        env,
         break;
 #endif
 
+#if defined(IP_MULTICAST_TTL)
+    case SOCKET_OPT_IP_MULTICAST_TTL:
+        result = ngetopt_lvl_ip_multicast_ttl(env, descP);
+        break;
+#endif
+
 #if defined(IP_RECVTOS)
     case SOCKET_OPT_IP_RECVTOS:
         result = ngetopt_lvl_ip_recvtos(env, descP);
@@ -5272,7 +5313,7 @@ ERL_NIF_TERM ngetopt_lvl_ip(ErlNifEnv*        env,
 
 /* ngetopt_lvl_ip_multicast_loop - Level IP MULTICAST_LOOP option
  */
-#if defined(IP_RECVTOS)
+#if defined(IP_MULTICAST_LOOP)
 static
 ERL_NIF_TERM ngetopt_lvl_ip_multicast_loop(ErlNifEnv*        env,
                                            SocketDescriptor* descP)
@@ -5288,6 +5329,24 @@ ERL_NIF_TERM ngetopt_lvl_ip_multicast_loop(ErlNifEnv*        env,
 #endif
 
 
+/* ngetopt_lvl_ip_multicast_ttl - Level IP MULTICAST_TTL option
+ */
+#if defined(IP_MULTICAST_TTL)
+static
+ERL_NIF_TERM ngetopt_lvl_ip_multicast_ttl(ErlNifEnv*        env,
+                                          SocketDescriptor* descP)
+{
+#if defined(SOL_IP)
+    int level = SOL_IP;
+#else
+    int level = IPPROTO_IP;
+#endif
+
+    return ngetopt_int_opt(env, descP, level, IP_MULTICAST_TTL);
+}
+#endif
+
+
 /* ngetopt_lvl_ip_recvtos - Level IP RECVTOS option
  */
 #if defined(IP_RECVTOS)
diff --git a/erts/preloaded/ebin/socket.beam b/erts/preloaded/ebin/socket.beam
index 0f49c421fa..4ffa22f70d 100644
--- a/erts/preloaded/ebin/socket.beam
+++ b/erts/preloaded/ebin/socket.beam
diff --git a/erts/preloaded/src/socket.erl b/erts/preloaded/src/socket.erl
index d2ed733b3c..f243559ceb 100644
--- a/erts/preloaded/src/socket.erl
+++ b/erts/preloaded/src/socket.erl
@@ -512,7 +512,7 @@
 %% -define(SOCKET_OPT_IP_MULTICAST_ALL,         13).
 %% -define(SOCKET_OPT_IP_MULTICAST_IF,          14).
 -define(SOCKET_OPT_IP_MULTICAST_LOOP,        15).
-%% -define(SOCKET_OPT_IP_MULTICAST_TTL,         16).
+-define(SOCKET_OPT_IP_MULTICAST_TTL,         16).
 %% -define(SOCKET_OPT_IP_NODEFRAG,              17).
 %% -define(SOCKET_OPT_IP_OPTIONS,               18).
 %% -define(SOCKET_OPT_IP_PKTINFO,               19).
@@ -1958,6 +1958,9 @@ enc_setopt_value(socket = L, Opt, V, _D, _T, _P) ->
 enc_setopt_value(ip, multicast_loop, V, _D, _T, _P)
   when is_boolean(V) ->
     V;
+enc_setopt_value(ip, multicast_ttl, V, _D, _T, _P)
+  when is_integer(V) andalso (0 =< V) andalso (V =< 255) ->
+    V;
 enc_setopt_value(ip, recvtos, V, _D, _T, _P)
   when is_boolean(V) ->
     V;
@@ -2252,8 +2255,8 @@ enc_sockopt_key(ip = L, multicast_if = Opt, _Dir, _D, _T, _P) ->
     not_supported({L, Opt});
 enc_sockopt_key(ip = _L, multicast_loop = _Opt, _Dir, _D, _T, _P) ->
     ?SOCKET_OPT_IP_MULTICAST_LOOP;
-enc_sockopt_key(ip = L, multicast_ttl = Opt, _Dir, _D, _T, _P) ->
-    not_supported({L, Opt});
+enc_sockopt_key(ip = _L, multicast_ttl = _Opt, _Dir, _D, _T, _P) ->
+    ?SOCKET_OPT_IP_MULTICAST_TTL;
 enc_sockopt_key(ip = L, nodefrag = Opt, _Dir, _D, raw = _T, _P) ->
     not_supported({L, Opt});
 enc_sockopt_key(ip = L, options = Opt, _Dir, _D, _T, _P) ->
diff --git a/lib/kernel/test/socket_server.erl b/lib/kernel/test/socket_server.erl
index 9c6ef47fbc..9e4e355179 100644
--- a/lib/kernel/test/socket_server.erl
+++ b/lib/kernel/test/socket_server.erl
@@ -283,18 +283,10 @@ acceptor_do_init(Domain, Type, Proto) ->
                   end
         end,
     i("(socket) open (~s,~s,~s): "
-      "~n   dontroute: ~s"
-      "~n   keepalive: ~s"
-      "~n   reuseaddr: ~s"
-      "~n   linger:    ~s"
       "~n   debug:     ~s"
       "~n   prio:      ~s"
-      "~n   rcvbuf:    ~s"
-      "~n   sndbuf:    ~s"
       "~n   => try find (local) address", 
-      [F(domain), F(type), F(protocol), 
-       F(dontroute), F(keepalive), F(reuseaddr), F(linger),
-       F(debug), F(priority), F(rcvbuf), F(sndbuf)]),
+      [F(domain), F(type), F(protocol), F(debug), F(priority)]),
     Addr = which_addr(Domain),
     SA = #{family => Domain,
            addr   => Addr},
@@ -442,7 +434,8 @@ handler_init(Manager, ID, Peek, Sock) ->
             {ok, SndBuf} = socket:getopt(Sock, socket, sndbuf),
             {ok, RcvBuf} = socket:getopt(Sock, socket, rcvbuf),
             {ok, Linger} = socket:getopt(Sock, socket, linger),
-            {ok, ML}     = socket:getopt(Sock, ip,     multicast_loop),
+            {ok, MLoop}  = socket:getopt(Sock, ip,     multicast_loop),
+            {ok, MTTL}   = socket:getopt(Sock, ip,     multicast_ttl),
             i("got continue when: "
               "~n   (socket) Domain:         ~p"
               "~n   (socket) Type:           ~p"
@@ -451,9 +444,10 @@ handler_init(Manager, ID, Peek, Sock) ->
               "~n   (socket) SndBuf:         ~p"
               "~n   (socket) RcvBuf:         ~p"
               "~n   (socket) Linger:         ~p"
-              "~n   (ip)     Multicast Loop: ~p", 
+              "~n   (ip)     Multicast Loop: ~p"
+              "~n   (ip)     Multicast TTL:  ~p", 
               [Domain, Type, Proto, 
-               OOBI, SndBuf, RcvBuf, Linger, ML]),
+               OOBI, SndBuf, RcvBuf, Linger, MLoop, MTTL]),
             %% socket:setopt(Sock, otp, debug, true),
             handler_loop(#handler{peek    = Peek,
                                   manager = Manager,