Remove always searching executable directory for native libraries in single-file applications #115236

elinor-fung · 2025-05-02T02:55:18Z

Avoid always searching the application directory for native libraries in single-file applications. The assembly directory, which is searched by default and when DllImportSearchPath.AssemblyDirectory is specified, is treated as the application directory.

Single-file
- Stop adding the app directory and extraction directory to NATIVE_DLL_SEARCH_DIRECTORIES (paths which are always searched)
- When looking for native libraries, treat assembly directory for bundled assemblies as the bundle directory
  - If the bundle has extracted assets, also look in the extraction path (if not found in the bundle directory)
NativeAOT
- Update p/invoke default to search assembly directory
- Don't set RPATH by default
- Remove IlcRPath property

Resolves #114717

cc @dotnet/appmodel @dotnet/interop-contrib @MichalStrehovsky @jkotas

…_DIRECTORIES

…e libraries

dotnet-policy-service · 2025-05-02T20:30:17Z

Added needs-breaking-change-doc-created label because this PR has the breaking-change label.

When you commit this breaking change:

Create and link to this PR and the issue a matching issue in the dotnet/docs repo using the breaking change documentation template, then remove this needs-breaking-change-doc-created label.
Ask a committer to mail the .NET Breaking Change Notification DL.

Tagging @dotnet/compat for awareness of the breaking change.

filipnavara · 2025-05-03T07:49:26Z

You should validate the use of IlcRPath in dotnet/macios workloads. They create app boundles where it's essential to set it.

am11 · 2025-05-03T08:59:21Z

src/coreclr/nativeaot/BuildIntegration/Microsoft.NETCore.Native.Unix.targets

+      <LinkerArg Include="-Wl,-rpath,'$(IlcRPath)'" Condition="'$(IlcRPath)' != '' and '$(StaticExecutable)' != 'true' and !$([MSBuild]::IsOSPlatform('Windows'))" />
+      <LinkerArg Include="-Wl,-rpath,&quot;$(IlcRPath)&quot;" Condition="'$(IlcRPath)' != '' and '$(StaticExecutable)' != 'true' and $([MSBuild]::IsOSPlatform('Windows'))" />


I think we can just delete this line; it's unlikely users will remember the correct -rpath value per platform (e.g., macOS vs. Linux). It's more simpler for them to specify <LinkerArg Include="-Wl,-rpath,..."> directly in their own projects (if they really need it for some reason), as they already do for other platform-specific linker options we don't cover.

Suggested change

<LinkerArg Include="-Wl,-rpath,'$(IlcRPath)'" Condition="'$(IlcRPath)' != '' and '$(StaticExecutable)' != 'true' and !$([MSBuild]::IsOSPlatform('Windows'))" />

<LinkerArg Include="-Wl,-rpath,"$(IlcRPath)"" Condition="'$(IlcRPath)' != '' and '$(StaticExecutable)' != 'true' and $([MSBuild]::IsOSPlatform('Windows'))" />

Yes, I think we can just delete IlcRpath. It was never documented and I can't see any uses of this property outside the dotnet/runtime repo. The only remaining use is in our test tree, but we can replace that one with a direct use of LinkerArg ItemGroup.

elinor-fung · 2025-05-05T20:13:37Z

You should validate the use of IlcRPath in dotnet/macios workloads. They create app boundles where it's essential to set it.

Should just template apps with NativeAOT enabled for macOS or Mac Catalyst be enough to see them fail (presumably) without rpath set? I don't have a Mac to try on right now, but will try those when I do.

filipnavara · 2025-05-05T20:22:50Z

Should just template apps with NativeAOT enabled for macOS or Mac Catalyst be enough to see them fail (presumably) without rpath set?

Yes, anything that calls into System.Native should be enough, so probably even Console.WriteLine (with netX-macos TFM).

MichalStrehovsky · 2025-05-06T17:06:31Z

Should just template apps with NativeAOT enabled for macOS or Mac Catalyst be enough to see them fail (presumably) without rpath set?

Yes, anything that calls into System.Native should be enough, so probably even Console.WriteLine (with netX-macos TFM).

It might not be necessary to test this - I don't see how this could affect things. Xamarin targets don't seem to use IlcRpath or the LinkerArg ItemGroup and I don't see anything else affected by this.

filipnavara · 2025-05-06T17:09:05Z

Xamarin targets don't seem to use IlcRpath or the LinkerArg ItemGroup and I don't see anything else affected by this.

It doesn't seem to use it (anymore?). There were some issues referencing it in the past. Most likely it's going to be fine but I think a simple smoke test would be worth it since the macOS/iOS bundles are easy to break with changes like this one.

elinor-fung · 2025-05-08T00:05:06Z

I validated that the template macOS and Mac Catalyst apps with PublishAot=true publish / run fine without IlcRPath. They do set rpath (it was set to @executable_path/../MonoBundle in my app), but looks like it is handled in their own targets without relying on the NativeAOT ones: https://github.com/dotnet/macios/blob/06b5b841bdb35ed1f42e6bb73bab331b53b92877/dotnet/targets/Xamarin.Shared.Sdk.targets#L1127-L1128

src/coreclr/vm/nativelibrary.cpp

src/native/corehost/host_runtime_contract.h

src/coreclr/vm/nativelibrary.cpp

src/coreclr/inc/bundle.h

src/coreclr/vm/bundle.cpp

…single-file applications (#115236) Avoid always searching the application directory for native libraries in single-file applications. The assembly directory, which is searched by default and when `DllImportSearchPath.AssemblyDirectory` is specified, is treated as the application directory. - Single-file - Stop adding the app directory and extraction directory to `NATIVE_DLL_SEARCH_DIRECTORIES` (paths which are always searched) - When looking for native libraries, treat assembly directory for bundled assemblies as the bundle directory - If the bundle has extracted assets, also look in the extraction path (if not found in the bundle directory) - NativeAOT - Update p/invoke default to search assembly directory - Don't set RPATH by default - Remove `IlcRPath` property

elinor-fung added 3 commits April 30, 2025 16:47

Don't add app directory and extraction directory to NATIVE_DLL_SEARCH…

903f1b3

…_DIRECTORIES

Use application directory when searching assembly directory for nativ…

bca6e22

…e libraries

Check bundle extraction directory if there is one

42a60e0

elinor-fung added the area-Single-File label May 2, 2025

dotnet-policy-service bot assigned elinor-fung May 2, 2025

elinor-fung force-pushed the singleFile-appDirSearch branch from 0288785 to c9d23b7 Compare May 2, 2025 03:59

This was referenced May 2, 2025

[wasm][AOT] emcc : error - received SIGKILL (-9) #89402

Open

CI flakiness: mono interpreter build getting killed #114123

Open

elinor-fung added 6 commits May 2, 2025 11:04

Update tests

179c3f0

Remove SingleFileApiTests for native_search_dirs

fca9b52

Add nativeaot tests

ddf7eeb

Fix default flags for nativeaot

139dc2b

Remove setting IlcRPath by default

0d3839a

Don't always set IlcRPath in tests

7e8a56c

elinor-fung force-pushed the singleFile-appDirSearch branch from c9d23b7 to 7e8a56c Compare May 2, 2025 18:04

elinor-fung marked this pull request as ready for review May 2, 2025 20:29

elinor-fung requested a review from MichalStrehovsky as a code owner May 2, 2025 20:29

elinor-fung added the breaking-change Issue or PR that represents a breaking API or functional change over a prerelease. label May 2, 2025

elinor-fung added this to the 10.0.0 milestone May 2, 2025

dotnet-policy-service bot added the needs-breaking-change-doc-created Breaking changes need an issue opened with https://github.com/dotnet/docs/issues/new?template=dotnet label May 2, 2025

build-analysis bot mentioned this pull request May 2, 2025

/root/helix/work/correlation/scripts/<hash>/execute.sh: Permission denied dotnet/dnceng#3412

Open

3 tasks

am11 reviewed May 3, 2025

View reviewed changes

Remove IlcRPath

486781c

build-analysis bot mentioned this pull request May 7, 2025

Test failure: baseservices/exceptions/stackoverflow/stackoverflowtester/stackoverflowtester.cmd #110173

Open

AaronRobinsonMSFT reviewed May 8, 2025

View reviewed changes

src/coreclr/vm/nativelibrary.cpp Show resolved Hide resolved

AaronRobinsonMSFT reviewed May 8, 2025

View reviewed changes

src/native/corehost/host_runtime_contract.h Show resolved Hide resolved

elinor-fung added 2 commits May 9, 2025 10:02

Update host-runtime-information.md with BUNDLE_EXTRACTION_PATH

f34bd31

Add assert

71bd9ad

elinor-fung requested a review from AaronRobinsonMSFT May 14, 2025 23:06

AaronRobinsonMSFT reviewed May 17, 2025

View reviewed changes

src/coreclr/vm/nativelibrary.cpp Show resolved Hide resolved

AaronRobinsonMSFT reviewed May 17, 2025

View reviewed changes

src/coreclr/inc/bundle.h Show resolved Hide resolved

AaronRobinsonMSFT reviewed May 17, 2025

View reviewed changes

src/coreclr/vm/bundle.cpp Show resolved Hide resolved

Return const WCHAR* instead of SString for extraction path

d00d673

This was referenced May 20, 2025

[QUIC & HTTP/3] Handshake Timeout on tests #104426

Open

[wasm] at System.Net.Http.BrowserHttpInterop.CancellationHelper #112533

Open

System.OperationCanceledException : The operation was canceled. dotnet/dnceng#5278

Open

AaronRobinsonMSFT approved these changes May 20, 2025

View reviewed changes

elinor-fung closed this May 20, 2025

elinor-fung reopened this May 20, 2025

build-analysis bot mentioned this pull request May 21, 2025

The Operation will be canceled. The next steps may not contain expected logs. dotnet/dnceng#3008

Open

3 tasks

elinor-fung merged commit f0230db into dotnet:main May 22, 2025
156 checks passed

elinor-fung mentioned this pull request May 22, 2025

[Breaking change]: Single-file applications no longer always look for native libraries in executable directory dotnet/docs#46356

Open

3 tasks

elinor-fung removed the needs-breaking-change-doc-created Breaking changes need an issue opened with https://github.com/dotnet/docs/issues/new?template=dotnet label May 22, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Remove always searching executable directory for native libraries in single-file applications #115236

Remove always searching executable directory for native libraries in single-file applications #115236

Uh oh!

elinor-fung commented May 2, 2025 •

edited

Loading

Uh oh!

dotnet-policy-service bot commented May 2, 2025 •

edited by elinor-fung

Loading

Uh oh!

filipnavara commented May 3, 2025

Uh oh!

am11 May 3, 2025

Uh oh!

MichalStrehovsky May 6, 2025

Uh oh!

elinor-fung commented May 5, 2025

Uh oh!

filipnavara commented May 5, 2025 •

edited

Loading

Uh oh!

MichalStrehovsky commented May 6, 2025

Uh oh!

filipnavara commented May 6, 2025

Uh oh!

elinor-fung commented May 8, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

		<LinkerArg Include="-Wl,-rpath,'$(IlcRPath)'" Condition="'$(IlcRPath)' != '' and '$(StaticExecutable)' != 'true' and !$([MSBuild]::IsOSPlatform('Windows'))" />
		<LinkerArg Include="-Wl,-rpath,"$(IlcRPath)"" Condition="'$(IlcRPath)' != '' and '$(StaticExecutable)' != 'true' and $([MSBuild]::IsOSPlatform('Windows'))" />

Remove always searching executable directory for native libraries in single-file applications #115236

Remove always searching executable directory for native libraries in single-file applications #115236

Uh oh!

Conversation

elinor-fung commented May 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dotnet-policy-service bot commented May 2, 2025 • edited by elinor-fung Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

filipnavara commented May 3, 2025

Uh oh!

am11 May 3, 2025

Choose a reason for hiding this comment

Uh oh!

MichalStrehovsky May 6, 2025

Choose a reason for hiding this comment

Uh oh!

elinor-fung commented May 5, 2025

Uh oh!

filipnavara commented May 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MichalStrehovsky commented May 6, 2025

Uh oh!

filipnavara commented May 6, 2025

Uh oh!

elinor-fung commented May 8, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

elinor-fung commented May 2, 2025 •

edited

Loading

dotnet-policy-service bot commented May 2, 2025 •

edited by elinor-fung

Loading

filipnavara commented May 5, 2025 •

edited

Loading