File 2020-esock-Add-support-for-ioctl-request-sifmtu... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 2020-esock-Add-support-for-ioctl-request-sifmtu.patch of Package erlang (Revision e62e4225e41cf032f11f17868c8e4330)

Currently displaying revision e62e4225e41cf032f11f17868c8e4330 , Show latest

From 223088895c2ed064a13b55898e1055b01d472e34 Mon Sep 17 00:00:00 2001
From: Micael Karlberg <bmk@erlang.org>
Date: Fri, 29 Oct 2021 16:59:03 +0200
Subject: [PATCH 20/58] [esock] Add support for ioctl request 'sifmtu'

When doing simple testing, setting was allowed,
but when reading the value after, it was unchanged.
More testing needed...

OTP-17528
---
 erts/emulator/nifs/common/prim_socket_nif.c | 177 +++++++++++++++++++-
 lib/kernel/doc/src/socket.xml               |  23 +++
 lib/kernel/src/socket.erl                   |  15 +-
 3 files changed, 209 insertions(+), 6 deletions(-)

diff --git a/erts/emulator/nifs/common/prim_socket_nif.c b/erts/emulator/nifs/common/prim_socket_nif.c
index 279916c6dd..f6f5bfe3d6 100644
--- a/erts/emulator/nifs/common/prim_socket_nif.c
+++ b/erts/emulator/nifs/common/prim_socket_nif.c
@@ -1891,6 +1891,11 @@ static ERL_NIF_TERM esock_ioctl2(ErlNifEnv*       env,
 				 ESockDescriptor* descP,
 				 unsigned long    req,
 				 ERL_NIF_TERM     arg);
+static ERL_NIF_TERM esock_ioctl3(ErlNifEnv*       env,
+				 ESockDescriptor* descP,
+				 unsigned long    req,
+				 ERL_NIF_TERM     ename,
+				 ERL_NIF_TERM     eval);
 static ERL_NIF_TERM esock_ioctl_gifconf(ErlNifEnv*       env,
 					ESockDescriptor* descP);
 static ERL_NIF_TERM encode_ioctl_ifconf(ErlNifEnv*       env,
@@ -1944,6 +1949,10 @@ static ERL_NIF_TERM esock_ioctl_gifmap(ErlNifEnv*       env,
 static ERL_NIF_TERM esock_ioctl_gifmtu(ErlNifEnv*       env,
 				       ESockDescriptor* descP,
 				       ERL_NIF_TERM     ename);
+static ERL_NIF_TERM esock_ioctl_sifmtu(ErlNifEnv*       env,
+				       ESockDescriptor* descP,
+				       ERL_NIF_TERM     ename,
+				       ERL_NIF_TERM     emtu);
 #if defined(SIOCGIFTXQLEN)
 static ERL_NIF_TERM esock_ioctl_giftxqlen(ErlNifEnv*       env,
 					  ESockDescriptor* descP,
@@ -4108,6 +4117,7 @@ ERL_NIF_TERM esock_atom_socket_tag; // This has a "special" name ('$socket')
     LOCAL_ATOM_DECL(sendfile_tries);   \
     LOCAL_ATOM_DECL(sendfile_waits);   \
     LOCAL_ATOM_DECL(shutdown);         \
+    LOCAL_ATOM_DECL(sifmtu);           \
     LOCAL_ATOM_DECL(slist);            \
     LOCAL_ATOM_DECL(sndctrlbuf);       \
     LOCAL_ATOM_DECL(sockaddr);         \
@@ -5165,6 +5175,7 @@ ERL_NIF_TERM esock_supports_ioctl_requests(ErlNifEnv* env)
 
   requests = MKEL(env);
 
+  /* --- GET REQUESTS --- */
 #if defined(SIOCGIFNAME)
   requests = MKC(env, MKT2(env, atom_gifname, MKUL(env, SIOCGIFNAME)), requests);
 #endif
@@ -5213,6 +5224,11 @@ ERL_NIF_TERM esock_supports_ioctl_requests(ErlNifEnv* env)
   requests = MKC(env, MKT2(env, atom_gifconf, MKUL(env, SIOCGIFCONF)), requests);
 #endif
 
+  /* --- SET REQUESTS --- */
+#if defined(SIOCSIFMTU)
+  requests = MKC(env, MKT2(env, atom_sifmtu, MKUL(env, SIOCSIFMTU)), requests);
+#endif
+
   return requests;
 }
 #endif // #ifndef __WIN32__
@@ -12790,8 +12806,14 @@ ERL_NIF_TERM esock_peername(ErlNifEnv*       env,
  *
  * Arguments:
  * Socket (ref) - Points to the socket descriptor.
- * Get Request  - The ioctl get request
- * Name         - Name of the interface - only for some requests
+ * Request      - The ioctl get/set request
+ * NameOrIdx    - Name or Index of the interface - only for some requests
+ *                Currently only one (get) request does not provide this
+ *                (and the value) argument; gifconf
+ *                Currently, only one (get) request use index; gifname
+ *                All other requests (get and set) use Name as "key".
+ * Val          - Value to *set*
+ *                This argument is *only* provided for set requests.
  */
 
 static
@@ -12808,7 +12830,7 @@ ERL_NIF_TERM nif_ioctl(ErlNifEnv*         env,
 
   SGDBG( ("SOCKET", "nif_ioctl -> entry with argc: %d\r\n", argc) );
 
-  ESOCK_ASSERT( (argc == 2) || (argc == 3) );
+  ESOCK_ASSERT( (argc == 2) || (argc == 3) || (argc == 4) );
 
   if (! ESOCK_GET_RESOURCE(env, argv[0], (void**) &descP)) {
     SGDBG( ("SOCKET", "nif_ioctl -> no resource\r\n") );
@@ -12826,6 +12848,10 @@ ERL_NIF_TERM nif_ioctl(ErlNifEnv*         env,
 
   if (argc == 2) {
 
+    /* Only one request with this number of arguments: gifconf
+     * Socket and request (=gifconf)
+     */
+
     MLOCK(descP->readMtx);
 
     /* One argument: request */
@@ -12834,6 +12860,11 @@ ERL_NIF_TERM nif_ioctl(ErlNifEnv*         env,
     MUNLOCK(descP->readMtx);
 
   } else if (argc == 3) {
+
+    /* (Currently) All *other* get requests has 3 arguments
+     * Socket, request and name/index
+     */
+
     ERL_NIF_TERM earg = argv[2];
 
     MLOCK(descP->readMtx);
@@ -12843,9 +12874,25 @@ ERL_NIF_TERM nif_ioctl(ErlNifEnv*         env,
 
     MUNLOCK(descP->readMtx);
     
+  } else if (argc == 4) {
+
+    /* (Currently) Set requests has 4 arguments
+     * Socket, request, name and value
+     */
+
+    ERL_NIF_TERM earg1 = argv[2]; // (currently) Name
+    ERL_NIF_TERM earg2 = argv[3]; // Value
+
+    MLOCK(descP->readMtx);
+  
+    /* Three arguments: request, arg1 (name) and arg2 (value) */
+    res = esock_ioctl3(env, descP, req, earg1, earg2);
+
+    MUNLOCK(descP->readMtx);
+    
   } else {
 
-    res = esock_atom_einval;
+    res = esock_make_error(env, esock_atom_einval);
 
   }
 
@@ -12893,9 +12940,17 @@ ERL_NIF_TERM esock_ioctl1(ErlNifEnv*       env,
  *
  * Request     arg       arg type
  * -------     -------   --------
- * gifaddr     name      string
  * gifname     ifindex   integer
  * gifindex    name      string
+ * gifflags    name      string
+ * gifaddr     name      string
+ * gifdstaddr  name      string
+ * gifbdraddr  name      string
+ * gifnetmask  name      string
+ * gifmtu      name      string
+ * gifhwaddr   name      string
+ * gifmap      name      string
+ * giftxqlen   name      string
  */
 static
 ERL_NIF_TERM esock_ioctl2(ErlNifEnv*       env,
@@ -12983,6 +13038,39 @@ ERL_NIF_TERM esock_ioctl2(ErlNifEnv*       env,
 }
 
 
+/* The type and value of arg(s) depend on the request,
+ * which we have not yet "analyzed".
+ *
+ * Request     arg1      arg1 type    arg2     arg2 type
+ * -------     -------   ---------    ------   ---------
+ * gifmtu      name      string       MTU      integer
+ */
+static
+ERL_NIF_TERM esock_ioctl3(ErlNifEnv*       env,
+			  ESockDescriptor* descP,
+			  unsigned long    req,
+			  ERL_NIF_TERM     ename,
+			  ERL_NIF_TERM     eval)
+{
+  if (! IS_OPEN(descP->readState))
+    return esock_make_error(env, atom_closed);
+
+  switch (req) {
+
+#if defined(SIOCSIFMTU)
+  case SIOCSIFMTU:
+    return esock_ioctl_sifmtu(env, descP, ename, eval);
+    break;
+#endif
+
+  default:
+    return esock_make_error(env, esock_atom_enotsup);
+    break;
+  }
+
+}
+
+
 static
 ERL_NIF_TERM esock_ioctl_gifconf(ErlNifEnv*       env,
 				 ESockDescriptor* descP)
@@ -13628,6 +13716,84 @@ ERL_NIF_TERM esock_ioctl_gifmtu(ErlNifEnv*       env,
 }
 
 
+static
+ERL_NIF_TERM esock_ioctl_sifmtu(ErlNifEnv*       env,
+				ESockDescriptor* descP,
+				ERL_NIF_TERM     ename,
+				ERL_NIF_TERM     emtu)
+{
+  ERL_NIF_TERM result;
+  struct ifreq ifreq;
+  char*        ifn = NULL;
+  int          nlen;
+
+  SSDBG( descP, ("SOCKET", "esock_ioctl_gifmtu {%d} -> entry with"
+		 "\r\n      (e)Name: %T"
+		 "\r\n", descP->sock, ename) );
+
+  if (!esock_decode_string(env, ename, &ifn)) {
+
+    SSDBG( descP,
+	   ("SOCKET", "esock_ioctl_sifmtu {%d} -> failed decode name: "
+	    "\r\n      ename: %T"
+	    "\r\n", descP->sock, ename) );
+
+    return enif_make_badarg(env);
+  }
+
+  if (! GET_INT(env, emtu, &ifreq.ifr_mtu)) {
+
+    SSDBG( descP,
+	   ("SOCKET", "esock_ioctl_sifmtu {%d} -> failed decode MTU: "
+	    "\r\n      emtu: %T"
+	    "\r\n", descP->sock, emtu) );
+
+    return enif_make_badarg(env);
+  }
+
+
+  // Make sure the length of the string is valid!
+  nlen = esock_strnlen(ifn, IFNAMSIZ);
+  
+  sys_memset(ifreq.ifr_name, '\0', IFNAMSIZ); // Just in case
+  sys_memcpy(ifreq.ifr_name, ifn, 
+	     (nlen >= IFNAMSIZ) ? IFNAMSIZ-1 : nlen);
+
+  
+  SSDBG( descP,
+	 ("SOCKET", "esock_ioctl_gifmtu {%d} -> try ioctl with"
+	  "\r\n      MTU: %d"
+	  "\r\n", descP->sock, ifreq.ifr_mtu) );
+
+  if (ioctl(descP->sock, SIOCSIFMTU, (char *) &ifreq) < 0) {
+    int          saveErrno = sock_errno();
+    ERL_NIF_TERM reason    = MKA(env, erl_errno_id(saveErrno));
+
+    SSDBG( descP,
+	   ("SOCKET", "esock_ioctl_gifmtu {%d} -> failure: "
+	    "\r\n      reason: %T (%d)"
+	    "\r\n", descP->sock, reason, saveErrno) );
+
+    result = esock_make_error(env, reason);
+
+  } else {
+    SSDBG( descP,
+	   ("SOCKET", "esock_ioctl_sifmtu {%d} -> mtu successfully set\r\n",
+	    descP->sock) );
+
+    result = esock_atom_ok;
+  }
+
+  /* We know that if esock_decode_string is successful,
+   * we have "some" form of string, and therefor memory
+   * has been allocated (and need to be freed)... */
+  FREE(ifn);
+
+  return result;
+
+}
+
+
 #if defined(SIOCGIFTXQLEN)
 static
 ERL_NIF_TERM esock_ioctl_giftxqlen(ErlNifEnv*       env,
@@ -19680,6 +19846,7 @@ ErlNifFunc esock_funcs[] =
     {"nif_peername",            1, nif_peername, 0},
     {"nif_ioctl",               2, nif_ioctl, ERL_NIF_DIRTY_JOB_IO_BOUND},
     {"nif_ioctl",               3, nif_ioctl, ERL_NIF_DIRTY_JOB_IO_BOUND},
+    {"nif_ioctl",               4, nif_ioctl, ERL_NIF_DIRTY_JOB_IO_BOUND},
 
     /* Misc utility functions */
 
diff --git a/lib/kernel/doc/src/socket.xml b/lib/kernel/doc/src/socket.xml
index 412952678e..67fd306ec8 100644
--- a/lib/kernel/doc/src/socket.xml
+++ b/lib/kernel/doc/src/socket.xml
@@ -2049,6 +2049,29 @@
       </desc>
     </func>
 
+    <func>
+      <name name="ioctl" arity="4" since="@OTP-17528@"/>
+      <fsummary>Control device.</fsummary>
+      <desc>
+	<p>Set socket (device) parameters.
+	This function sets a specific parameter,
+	according to <c>SetRequest</c> argument. The third
+	argument is the "key", identifying the
+	interface (usually the name of the interface), and the
+	fourth is the "new" value.</p>
+        <taglist>
+
+	  <tag><c>sifmtu</c></tag>
+          <item>
+	    <p>Set the MTU (Maximum Transfer Unit, <c>integer()</c>)
+	    for the interface with the specified name. </p>
+          </item>
+
+	</taglist>
+
+      </desc>
+    </func>
+
     <func>
       <name name="is_supported" arity="1" since="OTP 23.0"/>
       <name name="is_supported" arity="2" since="OTP 23.0"/>
diff --git a/lib/kernel/src/socket.erl b/lib/kernel/src/socket.erl
index 2869b92ac3..4e388f47ac 100644
--- a/lib/kernel/src/socket.erl
+++ b/lib/kernel/src/socket.erl
@@ -69,7 +69,7 @@
          sockname/1,
          peername/1,
 
-         ioctl/2, ioctl/3,
+         ioctl/2, ioctl/3, ioctl/4,
 
          cancel/2
         ]).
@@ -4185,6 +4185,19 @@ ioctl(Socket, GetRequest, Arg) ->
     erlang:error(badarg, [Socket, GetRequest, Arg]).
 
 
+-spec ioctl(Socket, SetRequest, Name, MTU) -> 'ok' | {'error', Reason} when
+      Socket     :: socket(),
+      SetRequest :: 'gifmtu',
+      Name       :: string(),
+      MTU        :: integer(),
+      Reason     :: posix() | 'closed'.
+
+ioctl(?socket(SockRef), sifmtu = SetRequest, Name, MTU)
+  when is_list(Name) andalso is_integer(MTU) ->
+    prim_socket:ioctl(SockRef, SetRequest, Name, MTU);
+ioctl(Socket, SetRequest, Arg1, Arg2) ->
+    erlang:error(badarg, [Socket, SetRequest, Arg1, Arg2]).
+
 
 %% ===========================================================================
 %%
-- 
2.31.1

Places

File 2020-esock-Add-support-for-ioctl-request-sifmtu.patch of Package erlang (Revision e62e4225e41cf032f11f17868c8e4330)

Places