dotnet / dotnet/Silk.NET

[2.x] Tracking issue for RID-related binary loading issues on Linux

Open
#2,610 2 comments 0 reactions 0 assignees View on GitHub
bug good first issue verify-3.0
Dominant language
C#
Stars
5.2k
Forks
477
Avg merge
3d 16h
Merged PRs (30d)
2

Description

# Summary

This is an issue I'm opening specifically to track the other open issues related to the RID-related binary loading issue. Solving this issue should solve the related issues.

The symptom of this issue is that Silk 2 fails to find binaries located in the `runtimes` folder.
Moving the binary out and next to the built executable is a common workaround for this issue.

At its core, the problem is the following:
```cs
// linux-x64
Console.WriteLine(System.Runtime.InteropServices.RuntimeInformation.RuntimeIdentifier);

// vanilla.2.0-x64 - This is what Silk 2 uses
Console.WriteLine(Microsoft.DotNet.PlatformAbstractions.RuntimeEnvironment.GetRuntimeIdentifier());
```

`vanilla...` and many other RIDs obtained from the `PlatformAbstractions` call don't exist as part of the RID graph found here: https://github.com/dotnet/runtime/blob/main/src/libraries/Microsoft.NETCore.Platforms/src/runtime.json

`Microsoft.DotNet.PlatformAbstractions.RuntimeEnvironment.GetRuntimeIdentifier()` is called here:
https://github.com/dotnet/Silk.NET/blob/57e0f8643c07702a16e14c027b1f15d60809d15b/src/Core/Silk.NET.Core/Loader/DefaultPathResolver.cs#L357

# Steps to reproduce

For a given affected distro, run the code above and see what RIDs are produced. The second RID is the one that Silk uses. If that RID is not part of the RID graph, then that's why the binary fails to be found as part of the runtimes folder.

# Comments

There's a lot of workarounds and fixes suggested in these issues, but I think a better fix is that we make use of the `System.Runtime.InteropServices.RuntimeInformation.RuntimeIdentifier` value instead.

From what I remember, modern .NET is no longer including per-distro RIDS anymore, so it makes sense that these distro RIDs are not part of the graph.

I also remember seeing some `#if` preprocessors related to the `RuntimeInformation` code, so I'm guessing that the `RuntimeInformation` APIs are not available on .NET Standard or something. If my guess is wrong, then this fix is easy and we just use both so we preserve the old behavior and fallback to the new.

My investigation of this issue can be found here: https://discord.com/channels/521092042781229087/607634593201520651/1540594381956972695

Edit: Apparently this exact underlying issue was mentioned here and probably not investigated further: https://discord.com/channels/521092042781229087/607634593201520651/1331176382339743755

# Directly related issues

Solving this issue should close all of the following issues:
- https://github.com/dotnet/Silk.NET/issues/2601 (and technically unresolved, https://github.com/dotnet/Silk.NET/issues/2599)
- https://github.com/dotnet/Silk.NET/issues/2571
- https://github.com/dotnet/Silk.NET/issues/2568
- https://github.com/dotnet/Silk.NET/issues/2465
- RID/distro not specified, but very likely to be this issue

Fedora is part of the RID graph, but only versions v39 and before. Latest is v44.
Ubuntu is part of the RID graph, but only versions v23 and before. Latest is v26.

Vanilla OS is another report I got from a user in Discord (https://discord.com/channels/521092042781229087/607634593201520651/1540577683195568178), which is also not part of the RID graph.

Once this issue is fixed and a new version of Silk is published, we should go through these issues, ask if the issue is fixed, and close the issues after a week or so if resolved or no response.

Contributor guide

Open the contributing guide

Research direction

Start in src/Core/Silk.NET.Core/Loader/DefaultPathResolver.cs around line 357, then compare the two runtime identifier APIs with the runtime.json RID graph. Reproduce the identifiers on an affected Linux distribution and verify the chosen identifier can locate binaries in runtimes; check the directly related issues after a new Silk version is published.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, linux
Domain
operating-systems
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.