[socket-nif] Add support for socket (level ipv6) option multicast_hops

Added support for the IPv6 socket option MULTICAST_HOPS.

OTP-14831.

5 files changed, 80 insertions, 19 deletions

diff --git a/erts/doc/src/socket_usage.xml b/erts/doc/src/socket_usage.xml
index eb1cbf6984..4f18471eb3 100644
--- a/erts/doc/src/socket_usage.xml
+++ b/erts/doc/src/socket_usage.xml
@@ -447,6 +447,13 @@
 	<cell>none</cell>
       </row>
       <row>
+	<cell>multicast_hops</cell>
+	<cell>default | uint8()</cell>
+	<cell>yes</cell>
+	<cell>yes</cell>
+	<cell>none</cell>
+      </row>
+      <row>
 	<cell>v6only</cell>
 	<cell>boolean()</cell>
 	<cell>yes</cell>
diff --git a/erts/emulator/nifs/common/socket_nif.c b/erts/emulator/nifs/common/socket_nif.c
index 7e4504cd2d..5ac190b3ec 100644
--- a/erts/emulator/nifs/common/socket_nif.c
+++ b/erts/emulator/nifs/common/socket_nif.c
@@ -540,6 +540,7 @@ typedef union {
 #define SOCKET_OPT_IPV6_HOPLIMIT             12
 #define SOCKET_OPT_IPV6_MTU                  17
 #define SOCKET_OPT_IPV6_MTU_DISCOVER         18
+#define SOCKET_OPT_IPV6_MULTICAST_HOPS       19
 #define SOCKET_OPT_IPV6_V6ONLY               33
 
 #define SOCKET_OPT_TCP_CONGESTION   1
@@ -1216,6 +1217,11 @@ static ERL_NIF_TERM nsetopt_lvl_ipv6_mtu_discover(ErlNifEnv*        env,
                                                   SocketDescriptor* descP,
                                                   ERL_NIF_TERM      eVal);
 #endif
+#if defined(IPV6_MULTICAST_HOPS)
+static ERL_NIF_TERM nsetopt_lvl_ipv6_multicast_hops(ErlNifEnv*        env,
+                                                    SocketDescriptor* descP,
+                                                    ERL_NIF_TERM      eVal);
+#endif
 #if defined(IPV6_V6ONLY)
 static ERL_NIF_TERM nsetopt_lvl_ipv6_v6only(ErlNifEnv*        env,
                                             SocketDescriptor* descP,
@@ -1505,6 +1511,10 @@ static ERL_NIF_TERM ngetopt_lvl_ipv6_mtu(ErlNifEnv*        env,
 static ERL_NIF_TERM ngetopt_lvl_ipv6_mtu_discover(ErlNifEnv*        env,
                                                   SocketDescriptor* descP);
 #endif
+#if defined(IPV6_MULTICAST_HOPS)
+static ERL_NIF_TERM ngetopt_lvl_ipv6_multicast_hops(ErlNifEnv*        env,
+                                                    SocketDescriptor* descP);
+#endif
 #if defined(IPV6_V6ONLY)
 static ERL_NIF_TERM ngetopt_lvl_ipv6_v6only(ErlNifEnv*        env,
                                             SocketDescriptor* descP);
@@ -5508,6 +5518,12 @@ ERL_NIF_TERM nsetopt_lvl_ipv6(ErlNifEnv*        env,
         break;
 #endif
 
+#if defined(IPV6_MULTICAST_HOPS)
+    case SOCKET_OPT_IPV6_MULTICAST_HOPS:
+        result = nsetopt_lvl_ipv6_multicast_hops(env, descP, eVal);
+        break;
+#endif
+
 #if defined(IPV6_V6ONLY)
     case SOCKET_OPT_IPV6_V6ONLY:
         result = nsetopt_lvl_ipv6_v6only(env, descP, eVal);
@@ -5605,6 +5621,18 @@ ERL_NIF_TERM nsetopt_lvl_ipv6_mtu_discover(ErlNifEnv*        env,
 #endif
 
 
+#if defined(IPV6_MULTICAST_HOPS)
+static
+ERL_NIF_TERM nsetopt_lvl_ipv6_multicast_hops(ErlNifEnv*        env,
+                                             SocketDescriptor* descP,
+                                             ERL_NIF_TERM      eVal)
+{
+    return nsetopt_int_opt(env, descP, SOL_IPV6, IPV6_MULTICAST_HOPS, eVal);
+}
+#endif
+
+
+
 #if defined(IPV6_V6ONLY)
 static
 ERL_NIF_TERM nsetopt_lvl_ipv6_v6only(ErlNifEnv*        env,
@@ -7950,6 +7978,12 @@ ERL_NIF_TERM ngetopt_lvl_ipv6(ErlNifEnv*        env,
         break;
 #endif
 
+#if defined(IPV6_MULTICAST_HOPS)
+    case SOCKET_OPT_IPV6_MULTICAST_HOPS:
+        result = ngetopt_lvl_ipv6_multicast_hops(env, descP);
+        break;
+#endif
+
 #if defined(IPV6_V6ONLY)
     case SOCKET_OPT_IPV6_V6ONLY:
         result = ngetopt_lvl_ipv6_v6only(env, descP);
@@ -8019,6 +8053,16 @@ ERL_NIF_TERM ngetopt_lvl_ipv6_mtu_discover(ErlNifEnv*        env,
 #endif
 
 
+#if defined(IPV6_MULTICAST_HOPS)
+static
+ERL_NIF_TERM ngetopt_lvl_ipv6_multicast_hops(ErlNifEnv*        env,
+                                             SocketDescriptor* descP)
+{
+    return ngetopt_int_opt(env, descP, SOL_IPV6, IPV6_MULTICAST_HOPS);
+}
+#endif
+
+
 #if defined(IPV6_V6ONLY)
 static
 ERL_NIF_TERM ngetopt_lvl_ipv6_v6only(ErlNifEnv*        env,
diff --git a/erts/preloaded/ebin/socket.beam b/erts/preloaded/ebin/socket.beam
index b00d272f8b..0b16eb23e0 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 e9b9f44a2c..fd273951bd 100644
--- a/erts/preloaded/src/socket.erl
+++ b/erts/preloaded/src/socket.erl
@@ -649,7 +649,7 @@
 %% -define(SOCKET_OPT_IPV6_LEAVE_GROUP,       16).
 -define(SOCKET_OPT_IPV6_MTU,               17).
 -define(SOCKET_OPT_IPV6_MTU_DISCOVER,      18).
-%% -define(SOCKET_OPT_IPV6_MULTICAST_HOPS,    19).
+-define(SOCKET_OPT_IPV6_MULTICAST_HOPS,    19).
 %% -define(SOCKET_OPT_IPV6_MULTICAST_IF,      20).
 %% -define(SOCKET_OPT_IPV6_MULTICAST_LOOP,    21).
 %% -define(SOCKET_OPT_IPV6_PORTRANGE,         22).
@@ -2268,6 +2268,12 @@ enc_setopt_value(ipv6, mtu_discover, V, _D, _T, _P)
        (V =:= probe) orelse
        is_integer(V) ->
     V;
+enc_setopt_value(ipv6, multicast_hops, V, _D, _T, _P)
+  when (V =:= default) ->
+    -1;
+enc_setopt_value(ipv6, multicast_hops, V, _D, _T, _P)
+  when is_integer(V) andalso (V >= 0) andalso (V =< 255) ->
+    V;
 enc_setopt_value(ipv6, v6only, V, _D, _T, _P) when is_boolean(V) ->
     V;
 enc_setopt_value(ipv6 = L, Opt, V, _D, _T, _P) ->
@@ -2692,8 +2698,8 @@ enc_sockopt_key(ipv6 = _L, mtu = _Opt, _Dir, _D, _T, _P) ->
     ?SOCKET_OPT_IPV6_MTU;
 enc_sockopt_key(ipv6 = _L, mtu_discover = _Opt, _Dir, _D, _T, _P) ->
     ?SOCKET_OPT_IPV6_MTU_DISCOVER;
-enc_sockopt_key(ipv6 = L, multicast_hops = Opt, _Dir, _D, _T, _P) ->
-    not_supported({L, Opt});
+enc_sockopt_key(ipv6 = _L, multicast_hops = _Opt, _Dir, _D, _T, _P) ->
+    ?SOCKET_OPT_IPV6_MULTICAST_HOPS;
 enc_sockopt_key(ipv6 = L, multicast_if = Opt, _Dir, _D, T, _P) 
   when (T =:= dgram) orelse (T =:= raw) ->
     not_supported({L, Opt});
diff --git a/lib/kernel/test/socket_server.erl b/lib/kernel/test/socket_server.erl
index aa577b6289..28e21c3b8b 100644
--- a/lib/kernel/test/socket_server.erl
+++ b/lib/kernel/test/socket_server.erl
@@ -587,8 +587,9 @@ handler_init(Manager, ID, Peek, Sock) ->
                                     f("error: ~p", [R])
                           end
                 end,
-            GIP = fun(O) -> G(ip, O)     end,
-            GSO = fun(O) -> G(socket, O) end,
+            GSO  = fun(O) -> G(socket, O) end,
+            GIP4 = fun(O) -> G(ip,     O) end,
+            GIP6 = fun(O) -> G(ipv6,   O) end,
             {ok, Domain} = socket:getopt(Sock, socket, domain),
             {ok, Type}   = socket:getopt(Sock, socket, type),
             {ok, Proto}  = socket:getopt(Sock, socket, protocol),
@@ -604,18 +605,19 @@ handler_init(Manager, ID, Peek, Sock) ->
             SndTO        = GSO(sndtimeo),
             Linger       = GSO(linger),
             Timestamp    = GSO(timestamp),
-            FreeBind     = GIP(freebind),
-            MTU          = GIP(mtu),
-            MTUDisc      = GIP(mtu_discover),
-            MALL         = GIP(multicast_all),
-            MIF          = GIP(multicast_if),
-            MLoop        = GIP(multicast_loop),
-            MTTL         = GIP(multicast_ttl),
-            NF           = GIP(nodefrag), % raw only
-            RecvIF       = GIP(recvif),   % Only dgram and raw (and FreeBSD)
-            RecvOPTS     = GIP(recvopts), % Not stream
-            RecvTOS      = GIP(recvtos),
-            RecvTTL      = GIP(recvttl),  % not stream
+            FreeBind     = GIP4(freebind),
+            MTU          = GIP4(mtu),
+            MTUDisc      = GIP4(mtu_discover),
+            MALL         = GIP4(multicast_all),
+            MIF          = GIP4(multicast_if),
+            MLoop        = GIP4(multicast_loop),
+            MTTL         = GIP4(multicast_ttl),
+            NF           = GIP4(nodefrag), % raw only
+            RecvIF       = GIP4(recvif),   % Only dgram and raw (and FreeBSD)
+            RecvOPTS     = GIP4(recvopts), % Not stream
+            RecvTOS      = GIP4(recvtos),
+            RecvTTL      = GIP4(recvttl),  % not stream
+            MHops        = GIP6(multicast_hops),
             i("got continue when: "
               "~n   (socket) Domain:         ~p"
               "~n   (socket) Type:           ~p"
@@ -643,13 +645,15 @@ handler_init(Manager, ID, Peek, Sock) ->
               "~n   (ip)     Recv IF:        ~s"
               "~n   (ip)     Recv OPTS:      ~s"
               "~n   (ip)     Recv TOS:       ~s"
-              "~n   (ip)     Recv TTL:       ~s",
+              "~n   (ip)     Recv TTL:       ~s"
+              "~n   (ipv6)   Multicast Hops: ~s",
               [Domain, Type, Proto,
                RA, RP, B2D, OOBI,
                RcvBuf, RcvLW, RcvTO, SndBuf, SndLW, SndTO,
                Linger, Timestamp,
                FreeBind, MTU, MTUDisc, MALL, MIF, MLoop, MTTL,
-               NF, RecvIF, RecvOPTS, RecvTOS, RecvTTL]),
+               NF, RecvIF, RecvOPTS, RecvTOS, RecvTTL,
+               MHops]),
 
             handler_loop(#handler{peek    = Peek,
                                   manager = Manager,