Add OpenBSD support in System.Net.NetworkInformation

[sethjackson]

There is already support in System.Native for this. Just need to enable it in the managed layer for OpenBSD.

Note that FreeBSD includes what appears to be a spurious FreeBSD specific Interop.Libraries.cs file which only contains the MsQuic constant and since that doesn't appear to be used in System.Net.NetworkInformation I haven't included it here and msquic won't work as it stands on OpenBSD today anyways.

Contributes to #124911.

[dotnet-policy-service]

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

[am11]

Did you try running its tests on the device? If not, bootstrap docs in main branch have steps to build single library with zip archive, copy the zip archive and testhost from host to OpenBSD machine and invoke RunTests.sh command mentioned in the docs.

[sethjackson]

I did not run tests but I’ll look at the docs and run them and post back.

[sethjackson]

I was struggling to get this to run on my system then I realized that I was on 7.9 which was recently released but cross build infra is on 7.8.

What is involved in updating that to 7.9 besides updating the cross root FS stuff in dotnet/arcade?

On 7.8 the tests fail with the following:

System.PlatformNotSupportedException : System.Net.NetworkInformation  is not supported on this platform.

A longer trace:

System.Net.NetworkInformation.Tests.ConnectionsParsingTests.ActiveTcpConnectionsParsing [FAIL]
      System.PlatformNotSupportedException : System.Net.NetworkInformation is not supported on this platform.
      Stack Trace:
        /runtime/artifacts/obj/System.Net.NetworkInformation/Debug/net11.0/System.Net.NetworkInformation.notsupported.cs(548,0): at System.Net.NetworkInformation.TcpConnectionInformation..ctor()
        /runtime/src/libraries/System.Net.NetworkInformation/src/System/Net/NetworkInformation/SimpleTcpConnectionInformation.Unix.cs(8,0): at System.Net.NetworkInformation.SimpleTcpConnectionInformation..ctor(IPEndPoint localEndPoint, IPEndPoint remoteEndPoint, TcpState state)
        /runtime/src/libraries/System.Net.NetworkInformation/src/System/Net/NetworkInformation/StringParsingHelpers.Connections.cs(265,0): at System.Net.NetworkInformation.StringParsingHelpers.ParseTcpConnectionInformationFromLine(String line)
        /runtime/src/libraries/System.Net.NetworkInformation/src/System/Net/NetworkInformation/StringParsingHelpers.Connections.cs(71,0): at System.Net.NetworkInformation.StringParsingHelpers.ParseActiveTcpConnectionsFromFiles(String tcp4ConnectionsFile, String tcp6ConnectionsFile)
        /runtime/src/libraries/System.Net.NetworkInformation/tests/FunctionalTests/ConnectionsParsingTests.cs(48,0): at System.Net.NetworkInformation.Tests.ConnectionsParsingTests.ActiveTcpConnectionsParsing()
           at System.RuntimeMethodHandle.InvokeMethod(ObjectHandleOnStack target, Void** arguments, ObjectHandleOnStack sig, BOOL isConstructor, ObjectHandleOnStack result)
        /runtime/src/coreclr/System.Private.CoreLib/src/System/RuntimeHandles.cs(1188,0): at System.RuntimeMethodHandle.InvokeMethod(Object target, Void** arguments, Signature sig, Boolean isConstructor)
        /runtime/src/coreclr/System.Private.CoreLib/src/System/Reflection/MethodBaseInvoker.CoreCLR.cs(37,0): at System.Reflection.MethodBaseInvoker.InterpretedInvoke_Method(Object obj, IntPtr* args)
        /runtime/src/libraries/System.Private.CoreLib/src/System/Reflection/MethodBaseInvoker.cs(57,0): at System.Reflection.MethodBaseInvoker.InvokeWithNoArgs(Object obj, BindingFlags invokeAttr)

So not entirely sure what I did wrong here? I did the cross build and test packaging from my branch that has this patch.

[sethjackson]

Oh oops. I think I figured it out. I need to add $(NetCoreAppCurrent)-openbsd to <TargetFrameworks> as well right?
Here https://github.com/dotnet/runtime/blob/main/src/libraries/System.Net.NetworkInformation/src/System.Net.NetworkInformation.csproj#L4?

Because otherwise we hit this?
https://github.com/dotnet/runtime/blob/main/src/libraries/System.Net.NetworkInformation/src/System.Net.NetworkInformation.csproj#L12

[am11]

I was struggling to get this to run on my system then I realized that I was on 7.9 which was recently released but cross build infra is on 7.8.

It is best to start with "lowest version which is not out of support" and that version is 7.8. What is the error on 7.9? Lets discuss it in main thread #124911.

PlatformNotSupportedException

When in doubt, piggyback on git grep -i freebsd -- ':/src/libraries/System.Net.NetworkInformation'

[sethjackson]

So I need to add openbsd to <TargetFrameworks> so that the <TargetPlatformIdentifier> gets set properly with:

<TargetPlatformIdentifier>$([MSBuild]::GetTargetPlatformIdentifier('$(TargetFramework)'))</TargetPlatformIdentifier>

So that the Unix/BSD specific files get included in the build.

However when I do that I get the following:

Build FAILED.

/runtime/artifacts/obj/System.Net.NetworkInformation/Debug/net11.0-openbsd/System.Net.NetworkInformation.AssemblyInfo.cs(30,12): error CA1418: The platform 'openbsd' is not a known platform name (https://learn.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1418) [/runtime/src/libraries/System.Net.NetworkInformation/src/System.Net.NetworkInformation.csproj::TargetFramework=net11.0-openbsd]

And I'm not really sure how to fix this. I trapsed around in the linked docs and in the MSBuild repo but I didn't see anything FreeBSD specific that would make this work so not sure how to fix this for OpenBSD. Any ideas @am11?

[am11]

Add openbsd after

runtime/eng/versioning.targets

Line 86 in f363796

<SupportedPlatform Condition="'$(TargetPlatformIdentifier)' == 'haiku'" Include="Haiku" />

We don't have OSPlatform.OpenBSD API yet, so any upcoming platform which is not yet released needs to be created manually there, so it can call OSPlatform.Create("OPENBSD") instead of OSPlatform.OpenBSD (FreeBSD has mileage in dotnet since 2016-17, so it doesn't have those issues; illumos/solaris/haiku are on this not-yet-release plan).

[sethjackson]

Got it. That fixed it. I didn't see FreeBSD in that file so I didn't add it originally and OperatingSystem.OpenBSD exists but I forgot it is internal vs public.

I'm assuming I should add the change to versioning.targets here in this PR correct? I don't see that file in http://github.com/dotnet/arcade

[am11]

Yes, this PR is the correct place for it; it's the first time we are building a platform-aware library where this validation kicks in.

Also, when you will run the tests, some of them will fail, you may need to sprinkle some TestPlatforms.OpenBSD attribute condition or if (!OSPlatform.Create("OPENBSD"))in C# code to skip them. You will need to make some understanding why those failed/skipped and whether that's expected. In case that's not expected (there is some bug), you can either fix it as part of this PR or open an issue then add this attribute [ActiveIssue("https://github.com/dotnet/runtime/issues/<your issue number>", TestPlatforms.OpenBSD)].

[am11]

OperatingSystem.OpenBSD exists but I forgot it is internal vs public.

There was a typo in my comment I've edited; it was meant to be OSPlatform.OpenBSD and OSPlatform.Create("OPENBSD).

[am11]

I don't see that file in http://github.com/dotnet/arcade

Arcade shared directory is eng/common which gets autosync by bot: https://github.com/dotnet/runtime/blob/a3359b88167e537ef31281887bb259461391f8f6/eng/common/README.md versioning.targets is outside of it.

[am11]

You can merge sethjackson#1 and that change will show up here. With those changes, all tests are appropriately skipped and others passing.

/home/am11/th/artifacts/bin/testhost/net11.0-openbsd-Debug-x64/dotnet exec --runtimeconfig System.Net.NetworkInformation.Functional.Tests.runtimeconfig.json --depsfile System.Net.NetworkInformation.Functional.Tests.deps.json xunit.console.dll System.Net.NetworkInformation.Functional.Tests.dll -xml testResults.xml -nologo -nocolor -notrait category=IgnoreForCI -notrait category=OuterLoop -notrait category=failing
popd
===========================================================================================================
~/system.netinfo ~/system.netinfo
  Discovering: System.Net.NetworkInformation.Functional.Tests (method display = ClassAndMethod, method display options = None)
  Discovered:  System.Net.NetworkInformation.Functional.Tests (found 64 of 99 test cases)
  Starting:    System.Net.NetworkInformation.Functional.Tests (parallel test collections = on [5 threads], stop on fail = off)
  Finished:    System.Net.NetworkInformation.Functional.Tests
=== TEST EXECUTION SUMMARY ===
   System.Net.NetworkInformation.Functional.Tests  Total: 229, Errors: 0, Failed: 0, Skipped: 0, Time: 1.820s

[sethjackson]

Oh nice! I doubt I would have figured that out myself. I merged it. Thanks!

One thing I noticed is that this file:
https://github.com/dotnet/runtime/blob/main/src/tests/Common/XUnitWrapperGenerator/TestPlatforms.cs

Is missing the OpenBSD constant and is therfore missing from AnyUnix as well. I'm not sure that it matters or not but just wanted to point it out as otherwise I wasn't sure where the TestPlatforms.OpenBSD constant was coming from.

[am11]

It's coming from arcade SDK: https://github.com/dotnet/arcade/blob/5f63985fe82894604956e653d43c161ebbc1b576/src/Microsoft.DotNet.XUnitExtensions.Shared/TestPlatforms.cs#L26

src/tests: runtime tests (coreclr-vm,gc,jit,aot etc.).
src/libraries/<name>/tests: runtime libraries tests.

We can add OpenBSD in runtime tests later on, bootstrap docs cover both.