Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Use explicit full-path for loading MsQuic.dll on Windows #109963

Merged
merged 2 commits into from
Nov 20, 2024
Merged

Use explicit full-path for loading MsQuic.dll on Windows #109963

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e8ae0bb
Use explicit full-path for loading MsQuic.dll on Windows
rzikm Oct 7, 2024
ae1737f
Suppress IL3000 in MsQuicApi constructor
elinor-fung Oct 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 19 additions & 2 deletions src/libraries/System.Net.Quic/src/System/Net/Quic/Internal/MsQuicApi.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,8 @@ private MsQuicApi(QUIC_API_TABLE* apiTable)
internal static bool Tls13ClientMayBeDisabled { get; }

#pragma warning disable CA1810 // Initialize all static fields in 'MsQuicApi' when those fields are declared and remove the explicit static constructor
[UnconditionalSuppressMessage("SingleFile", "IL3000: Avoid accessing Assembly file path when publishing as a single file",
Justification = "The code handles the Assembly.Location being null/empty by falling back to AppContext.BaseDirectory")]
static MsQuicApi()
{
bool loaded = false;
Expand All @@ -89,8 +91,23 @@ static MsQuicApi()

if (OperatingSystem.IsWindows())
{
// Windows ships msquic in the assembly directory.
loaded = NativeLibrary.TryLoad(Interop.Libraries.MsQuic, typeof(MsQuicApi).Assembly, DllImportSearchPath.AssemblyDirectory, out msQuicHandle);
rzikm marked this conversation as resolved.
Show resolved Hide resolved
#pragma warning disable IL3000 // Avoid accessing Assembly file path when publishing as a single file
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why adding this pragma? The UnconditionalSuppress should already suppress this. Feels like this will just make it more likely to get #109958 resurface, whenever someone just mindlessly copies/pastes this code to somewhere else.

// Windows ships msquic in the assembly directory next to System.Net.Quic, so load that.
// For single-file deployments, the assembly location is an empty string so we fall back
// to AppContext.BaseDirectory which is the directory containing the single-file executable.
string path = typeof(MsQuicApi).Assembly.Location is string assemblyLocation && !string.IsNullOrEmpty(assemblyLocation)
? System.IO.Path.GetDirectoryName(assemblyLocation)!
: AppContext.BaseDirectory;
#pragma warning restore IL3000

path = System.IO.Path.Combine(path, Interop.Libraries.MsQuic);

if (NetEventSource.Log.IsEnabled())
{
NetEventSource.Info(null, $"Attempting to load MsQuic from {path}");
}

loaded = NativeLibrary.TryLoad(path, typeof(MsQuicApi).Assembly, DllImportSearchPath.LegacyBehavior, out msQuicHandle);
}
else
{
Expand Down
Loading