Socket.SendFile() should fail with a consistent exception for connectionless sockets

[antonfirsov]

Socket.SendFile() is not supported on Windows, but the exceptions being thrown are not consistent. The first call throws SocketException, while the second attempt leads to NotSupportedException.

Repro

The twice=true case fails:

[Theory]
[InlineData(false)]
[InlineData(true)]
public void UDP_SendFile(bool twice)
{
    string tempFile = Path.GetTempFileName();
    File.WriteAllBytes(tempFile, new byte[128]);

    using var client = new Socket(AddressFamily.InterNetwork, SocketType.Dgram, ProtocolType.Udp);
    using var listener = new Socket(AddressFamily.InterNetwork, SocketType.Dgram, ProtocolType.Udp);
    listener.BindToAnonymousPort(IPAddress.Loopback);

    client.Connect(listener.LocalEndPoint);

    Assert.Throws<SocketException>(() => client.SendFile(tempFile));
    if (twice)
    {
        Assert.Throws<SocketException>(() => client.SendFile(tempFile)); // Throws NotSupportedException
    }
}

Edit (after discussion below)

On Linux the call does not fail. We should fail NotSupportedException for connectionless sockets on all OS-es in all cases.

[ghost]

Tagging subscribers to this area: @dotnet/ncl
See info in area-owners.md if you want to be subscribed.

Issue Details

---

Socket.SendFile() is not supported on Windows, but the exceptions being thrown are not consistent. The first call throws SocketException, while the second attempt leads to NotSupportedException.

Repro

The twice=true case fails:

[Theory]
[InlineData(false)]
[InlineData(true)]
public void UDP_SendFile(bool twice)
{
    string tempFile = Path.GetTempFileName();
    File.WriteAllBytes(tempFile, new byte[128]);

    using var client = new Socket(AddressFamily.InterNetwork, SocketType.Dgram, ProtocolType.Udp);
    using var listener = new Socket(AddressFamily.InterNetwork, SocketType.Dgram, ProtocolType.Udp);
    listener.BindToAnonymousPort(IPAddress.Loopback);

    client.Connect(listener.LocalEndPoint);

    Assert.Throws<SocketException>(() => client.SendFile(tempFile));
    if (twice)
    {
        Assert.Throws<SocketException>(() => client.SendFile(tempFile)); // Throws NotSupportedException
    }
}

Author:	antonfirsov
Assignees:	-
Labels:	area-System.Net.Sockets, untriaged
Milestone:	-

[geoffkizer]

What do we do on Linux?

[geoffkizer]

related: #47287

[antonfirsov]

It does not throw. Maybe sendfile just works on Linux with UDP?

[gfoidl]

From the manpage:

sendfile() copies data between one file descriptor and another.

This doesn't exclude UDP, so on linux it should work?

[wfurt]

of course with UDP, there is no way to now if what was sent is what was received. It would just blast content of the file without any feedback,

[antonfirsov]

I also think so (would be nice to double-check with a small app or test).

On Windows, it would be nice to throw consistent exceptions.

I wonder if we should explicitly invest efforts to document these platform differences better, or are these corner cases we don't care about much, since we don't expect users to meet them?

[geoffkizer]

Using SendFile with UDP doesn't really make much sense. The point of SendFile is to send large-ish files efficiently. Max size of a UDP packet is ~1500 bytes. It would be really weird to use SendFile with UDP.

Additionally, on Linux, the platform sendfile() API itself doesn't support pre and post buffers -- it just takes a fd. So we mimic the Windows behavior by sending the pre and post buffers manually using send(). But if you are using UDP, this probably isn't what you want -- the pre and post buffers will end up getting sent in different packets.

As such, I think we should just fail if you try to do SendFile on UDP for both Linux and Windows. The fact that this doesn't fail on Linux today is really an oversight.

Also, it seems fine to just always throw NotSupportedException here.

[antonfirsov]

Seems like we agree on this, I repurposed the issue based on the discussion outcome.

[ManickaP]

Triage: to keep is consistent we should throw on Linux, we should fix this for 6.0 until someone depends on not throwing.

[karelz]

Triage: Not a regression, UDP -- low usage. Fine to move to Future.