fix PacketInformation and enable the test

dotnet · pavelsavara · Oct 2, 2024 · Sep 23, 2024 · Sep 23, 2024 · Sep 23, 2024
commit 1a14c50e4fa5100d2be7bae57510e4b8db257c52
diff --git a/src/libraries/System.Net.Sockets/src/System/Net/Sockets/Socket.cs b/src/libraries/System.Net.Sockets/src/System/Net/Sockets/Socket.cs
@@ -64,7 +64,7 @@ public partial class Socket : IDisposable
         private ProtocolType _protocolType;
 
         // Bool marked true if the native socket option IP_PKTINFO or IPV6_PKTINFO has been set.
-        private bool _receivingPacketInformation;
+        private bool _receivingPacketInformation = OperatingSystem.IsWasi();
 
         private int _closeTimeout = Socket.DefaultCloseTimeout;
         private bool _disposed;
@@ -3166,7 +3166,7 @@ private bool ReceiveMessageFromAsync(SocketAsyncEventArgs e, CancellationToken c
             // e.m_SocketAddres for Create to work later.
             e.RemoteEndPoint = endPointSnapshot;
 
-            if (!OperatingSystem.IsWasi()) SetReceivingPacketInformation();
+            SetReceivingPacketInformation();
 
             // Prepare for and make the native call.
             e.StartOperationCommon(this, SocketAsyncOperation.ReceiveMessageFrom);
@@ -3559,6 +3559,8 @@ internal void SetReceivingPacketInformation()
         {
             if (!_receivingPacketInformation)
             {
+                if (OperatingSystem.IsWasi()) return; // WASI is always set to receive PacketInformation
+
                 // DualMode: When bound to IPv6Any you must enable both socket options.
                 // When bound to an IPv4 mapped IPv6 address you must enable the IPv4 socket option.
                 IPEndPoint? ipEndPoint = _rightEndPoint as IPEndPoint;
@@ -3586,6 +3588,16 @@ internal void SetReceivingPacketInformation()
 
         internal unsafe void SetSocketOption(SocketOptionLevel optionLevel, SocketOptionName optionName, int optionValue, bool silent)
         {
+            // WASI is always set to receive PacketInformation
+            if (OperatingSystem.IsWasi() && optionName == SocketOptionName.PacketInformation)
+            {
+                if (optionValue == 0)
+                {
+                    UpdateStatusAfterSocketOptionErrorAndThrowException(SocketError.ProtocolOption);
+                }
+                return;
+            }
+
             if (silent && (Disposed || _handle.IsInvalid))
             {
                 if (NetEventSource.Log.IsEnabled()) NetEventSource.Info(this, "skipping the call");

diff --git a/src/libraries/System.Net.Sockets/tests/FunctionalTests/IPPacketInformationTest.cs b/src/libraries/System.Net.Sockets/tests/FunctionalTests/IPPacketInformationTest.cs
@@ -2,12 +2,12 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using System.Threading;
+using System.Threading.Tasks;
 
 using Xunit;
 
 namespace System.Net.Sockets.Tests
 {
-    [SkipOnPlatform(TestPlatforms.Wasi, "Wasi doesn't support IPPacketInformation")]
     public class IPPacketInformationTest
     {
         [Fact]
@@ -28,9 +28,9 @@ public void GetHashCode_DefaultValues_Success()
         }
 
         [Fact]
-        public void Equals_NonDefaultValue_Success()
+        public async Task Equals_NonDefaultValue_Success()
         {
-            IPPacketInformation packetInfo = GetNonDefaultIPPacketInformation();
+            IPPacketInformation packetInfo = await GetNonDefaultIPPacketInformation();
             IPPacketInformation packetInfoCopy = packetInfo;
 
             Assert.Equal(packetInfo, packetInfoCopy);
@@ -49,40 +49,28 @@ public void Equals_NonDefaultValue_Success()
         }
 
         [Fact]
-        public void GetHashCode_NonDefaultValue_Success()
+        public async Task GetHashCode_NonDefaultValue_Success()
         {
-            IPPacketInformation packetInfo = GetNonDefaultIPPacketInformation();
+            IPPacketInformation packetInfo = await GetNonDefaultIPPacketInformation();
 
             Assert.Equal(packetInfo.GetHashCode(), packetInfo.GetHashCode());
         }
 
-        private IPPacketInformation GetNonDefaultIPPacketInformation()
+        private async Task<IPPacketInformation> GetNonDefaultIPPacketInformation()
         {
-            const int ReceiveTimeout = 10000;
-
             using (var receiver = new Socket(AddressFamily.InterNetwork, SocketType.Dgram, ProtocolType.Udp))
             using (var sender = new Socket(AddressFamily.InterNetwork, SocketType.Dgram, ProtocolType.Udp))
             {
                 int port = receiver.BindToAnonymousPort(IPAddress.Loopback);
-
-                var waitHandle = new ManualResetEvent(false);
-
-                SocketAsyncEventArgs receiveArgs = new SocketAsyncEventArgs {
-                    RemoteEndPoint = new IPEndPoint(IPAddress.Loopback, port),
-                    UserToken = waitHandle
-                };
-
-                receiveArgs.SetBuffer(new byte[1], 0, 1);
-                receiveArgs.Completed += (_, args) => ((ManualResetEvent)args.UserToken).Set();
-
-                Assert.True(receiver.ReceiveMessageFromAsync(receiveArgs), "receiver.ReceiveMessageFromAsync");
-
                 // Send a few packets, in case they aren't delivered reliably.
-                sender.SendTo(new byte[1], new IPEndPoint(IPAddress.Loopback, port));
+                var receiveTask = receiver.ReceiveMessageFromAsync(new byte[1], new IPEndPoint(IPAddress.Loopback, port));
+                var sendTask = sender.SendToAsync(new byte[1], new IPEndPoint(IPAddress.Loopback, port));
+
+                Assert.True(await Task.WhenAny(receiveTask, Task.Delay(TestSettings.PassingTestTimeout)) == receiveTask, "Timed out");
 
-                Assert.True(waitHandle.WaitOne(ReceiveTimeout), "waitHandle.WaitOne");
+                var result = await receiveTask;
 
-                return receiveArgs.ReceiveMessageFromPacketInfo;
+                return result.PacketInformation;
             }
         }
     }

diff --git a/src/libraries/System.Net.Sockets/tests/FunctionalTests/ReceiveMessageFrom.cs b/src/libraries/System.Net.Sockets/tests/FunctionalTests/ReceiveMessageFrom.cs
@@ -127,7 +127,7 @@ public async Task ReceiveSent_UDP_Success(bool ipv4)
             using Socket receiver = new Socket(address.AddressFamily, SocketType.Dgram, ProtocolType.Udp);
             using Socket sender = new Socket(address.AddressFamily, SocketType.Dgram, ProtocolType.Udp);
 
-            if (!OperatingSystem.IsWasi()) receiver.SetSocketOption(ipv4 ? SocketOptionLevel.IP : SocketOptionLevel.IPv6, SocketOptionName.PacketInformation, true);
+            receiver.SetSocketOption(ipv4 ? SocketOptionLevel.IP : SocketOptionLevel.IPv6, SocketOptionName.PacketInformation, true);
             ConfigureNonBlocking(sender);
             ConfigureNonBlocking(receiver);
 
@@ -154,11 +154,8 @@ public async Task ReceiveSent_UDP_Success(bool ipv4)
                 AssertExtensions.SequenceEqual(emptyBuffer, new ReadOnlySpan<byte>(receiveInternalBuffer, 0, Offset));
                 AssertExtensions.SequenceEqual(sendBuffer, new ReadOnlySpan<byte>(receiveInternalBuffer, Offset, DatagramSize));
                 Assert.Equal(sender.LocalEndPoint, result.RemoteEndPoint);
-                if (!OperatingSystem.IsWasi())
-                {
-                    IPPacketInformation packetInformation = result.PacketInformation;
-                    Assert.Equal(((IPEndPoint)sender.LocalEndPoint).Address, packetInformation.Address);
-                }
+                IPPacketInformation packetInformation = result.PacketInformation;
+                Assert.Equal(((IPEndPoint)sender.LocalEndPoint).Address, packetInformation.Address);
             }
         }
 

diff --git a/src/native/libs/System.Native/pal_networking.c b/src/native/libs/System.Native/pal_networking.c
@@ -1054,7 +1054,6 @@ static struct cmsghdr* GET_CMSG_NXTHDR(struct msghdr* mhdr, struct cmsghdr* cmsg
 #pragma clang diagnostic pop
 #endif
 }
-#endif // CMSG_SPACE
 
 int32_t
 SystemNative_TryGetIPPacketInformation(MessageHeader* messageHeader, int32_t isIPv4, IPPacketInformation* packetInfo)
@@ -1064,7 +1063,6 @@ SystemNative_TryGetIPPacketInformation(MessageHeader* messageHeader, int32_t isI
         return 0;
     }
 
-#if defined(CMSG_SPACE)
     struct msghdr header;
     ConvertMessageHeaderToMsghdr(&header, messageHeader, -1);
 
@@ -1093,13 +1091,35 @@ SystemNative_TryGetIPPacketInformation(MessageHeader* messageHeader, int32_t isI
     }
 
     return 0;
-#else // CMSG_SPACE
-    (void)messageHeader;
-    (void)isIPv4;
-    (void)packetInfo;
-    return Error_ENOTSUP;
-#endif // CMSG_SPACE
 }
+#else // !CMSG_SPACE
+int32_t
+SystemNative_TryGetIPPacketInformation(MessageHeader* messageHeader, int32_t isIPv4, IPPacketInformation* packetInfo)
+{
+    if (messageHeader == NULL || packetInfo == NULL)
+    {
+        return 0;
+    }
+
+    if (isIPv4 != 0)
+    {
+        struct sockaddr_in* inetSockAddr = (struct sockaddr_in*)messageHeader->SocketAddress;
+
+        ConvertInAddrToByteArray(&packetInfo->Address.Address[0], NUM_BYTES_IN_IPV4_ADDRESS, &inetSockAddr->sin_addr);
+        packetInfo->Address.IsIPv6 = 0;
+    }
+    else
+    {
+        struct sockaddr_in6* inet6SockAddr = (struct sockaddr_in6*)messageHeader->SocketAddress;
+
+        ConvertIn6AddrToByteArray(&packetInfo->Address.Address[0], NUM_BYTES_IN_IPV6_ADDRESS, &inet6SockAddr->sin6_addr);
+        packetInfo->Address.IsIPv6 = 1;
+        packetInfo->Address.ScopeId = inet6SockAddr->sin6_scope_id;
+    }
+    packetInfo->InterfaceIndex = 0;
+    return 1;
+}
+#endif // !CMSG_SPACE
 
 static int8_t GetMulticastOptionName(int32_t multicastOption, int8_t isIPv6, int* optionName)
 {
@@ -1553,18 +1573,16 @@ int32_t SystemNative_ReceiveMessage(intptr_t socket, MessageHeader* messageHeade
     }
 
     ssize_t res;
-#if defined(CMSG_SPACE)
+#if !defined(CMSG_SPACE)
+    // we will only use 0th buffer
+    struct iovec* msg_iov = (struct iovec*)messageHeader->IOVectors;
+    while ((res = recvfrom(fd, msg_iov[0].iov_base, msg_iov[0].iov_len, socketFlags, (sockaddr *)messageHeader->SocketAddress, (socklen_t*) &(messageHeader->SocketAddressLen))) < 0 && errno == EINTR);
+#else // CMSG_SPACE
     struct msghdr header;
     ConvertMessageHeaderToMsghdr(&header, messageHeader, fd);
 
     while ((res = recvmsg(fd, &header, socketFlags)) < 0 && errno == EINTR);
-#else // CMSG_SPACE
-    // we will only use 0th buffer
-    struct iovec* msg_iov = (struct iovec*)messageHeader->IOVectors;
-    while ((res = recvfrom(fd, msg_iov[0].iov_base, msg_iov[0].iov_len, socketFlags, (sockaddr *)messageHeader->SocketAddress, (socklen_t*) &(messageHeader->SocketAddressLen))) < 0 && errno == EINTR);
-#endif // CMSG_SPACE
 
-#if defined(CMSG_SPACE)
     assert(header.msg_name == messageHeader->SocketAddress); // should still be the same location as set in ConvertMessageHeaderToMsghdr
     assert(header.msg_control == messageHeader->ControlBuffer);