Add support for using NativeAOT. #17374

rolfbjarne · 2023-01-25T15:11:27Z

Add support for using NativeAOT on all our platforms.

This contains numerous changes in a lot of places to add support for NativeAOT:

build logic
runtime
managed code
tests

And it all pretty much consists of special-casing NativeAOT everywhere we need to.

Note: NativeAOT doesn't work on macOS yet, because a dotnet/runtime fix is required, and thus the corresponding test variations for monotouch-test have been commented out.

This PR is best reviewed commit-by-commit.

This contributes towards #17339.

ivanpovazan · 2023-05-19T13:08:53Z

FWIW here are adaptations that work for building a MAUI template app with NativeAOT on a iOS device
https://github.com/ivanpovazan/xamarin-macios/tree/net8.0-msr-naot combined with dotnet/runtime#85996
(credits to @filipnavara 🚀 )

ivanpovazan · 2023-05-24T22:43:18Z

@rolfbjarne we should consider adding something like this in the native linker configuration: dotnet/runtime#86707 (comment)
It shaves off 20Mb of zeroes from the binary for NativeAOT builds.

rolfbjarne · 2023-05-25T05:51:29Z

@rolfbjarne we should consider adding something like this in the native linker configuration: dotnet/runtime#86707 (comment) It shaves off 20Mb of zeroes from the binary for NativeAOT builds.

I've filed #18332 to look into this.

…and use them ourselves.

…hen using NativeAOT (and warn if someone asks otherwise).

…get the correct BCL libraries.

This is because NativeAOT contains swift code, and we'd have to add code to embed the Swift libraries in any apps that target early OS versions. We could eventually implement this, but let's wait and see if there's a demand first.

… supports.

This matches how NativeAOT works for other platforms.

…sing NativeAOT.

…NativeAOT.

… build when using NativeAOT.

…7 tests. We had to bump NUnitLite and Touch.Unit's TargetFramework properties to net8.0-* (otherwise projects using NativeAOT fails if these projects are referenced), which means they can't be used from .NET 7 (aka our .NET 7 tests). So just don't reference NUnitLite and Touch.Unit in this test.

… waiting for a dotnet/runtime fix.

…, we need a few upstream fixes.

We can fix this better once this fix reaches us: dotnet/runtime#87813 because then we can set the ICU data file at build time (to a relative path).

vs-mobiletools-engineering-service2 · 2023-06-22T07:51:04Z

💻 [CI Build] Windows Integration Tests passed 💻

✅ All Windows Integration Tests passed.

Pipeline on Agent
Hash: b4e3361a10ce6856d77d6ee9c9df7460489eefe6 [PR build]

vs-mobiletools-engineering-service2 · 2023-06-22T08:01:32Z

📚 [PR Build] Artifacts 📚

Packages generated

View packages

Pipeline on Agent
Hash: [PR build]

vs-mobiletools-engineering-service2 · 2023-06-22T08:05:05Z

❌ [PR Build] Tests on macOS M1 - Mac Ventura (13.0) failed ❌

Failed tests are:

linksdk
monotouch-test

Pipeline on Agent
Hash: [PR build]

vs-mobiletools-engineering-service2 · 2023-06-22T08:05:10Z

❌ [PR Build] Tests on macOS M1 - Mac Big Sur (11.5) failed ❌

Failed tests are:

linksdk
monotouch-test

Pipeline on Agent
Hash: [PR build]

vs-mobiletools-engineering-service2 · 2023-06-22T08:14:13Z

✅ API diff for current PR / commit

NET (empty diffs)

~~iOS~~: (empty diff detected)
~~tvOS~~: (empty diff detected)
~~MacCatalyst~~: (empty diff detected)
~~macOS~~: (empty diff detected)

✅ API diff vs stable

.NET (No breaking changes)

iOS: vsdrops gist (No breaking changes)
tvOS: vsdrops gist (No breaking changes)
MacCatalyst: vsdrops gist (No breaking changes)
macOS: vsdrops gist (No breaking changes)
Microsoft.iOS vs Microsoft.MacCatalyst: vsdrops gist

ℹ️ Generator diff

Generator Diff: vsdrops (html) vsdrops (raw diff) gist (raw diff) - Please review changes)

Pipeline on Agent
Hash: b4e3361a10ce6856d77d6ee9c9df7460489eefe6 [PR build]

vs-mobiletools-engineering-service2 · 2023-06-22T14:56:29Z

🔥 [CI Build] Test results 🔥

Test results

❌ Tests failed on VSTS: simulator tests

0 tests crashed, 1 tests failed, 91 tests passed.

Failures

❌ dotnettests tests [attempt 2]

1 tests failed, 0 tests passed.

DotNet tests: Failed (Execution failed with exit code 1)

Html Report (VSDrops) Download

Successes

⚠️ bcl: No tests selected. Html Report (VSDrops) Download
✅ cecil: All 1 tests passed. Html Report (VSDrops) Download
✅ fsharp: All 4 tests passed. Html Report (VSDrops) Download
✅ framework: All 4 tests passed. Html Report (VSDrops) Download
✅ generator: All 1 tests passed. Html Report (VSDrops) Download
✅ interdependent_binding_projects: All 4 tests passed. Html Report (VSDrops) Download
⚠️ install_source: No tests selected. Html Report (VSDrops) Download
✅ introspection: All 4 tests passed. Html Report (VSDrops) Download
✅ linker: All 40 tests passed. Html Report (VSDrops) Download
⚠️ mac_binding_project: No tests selected. Html Report (VSDrops) Download
⚠️ mmp: No tests selected. Html Report (VSDrops) Download
⚠️ mononative: No tests selected. Html Report (VSDrops) Download
✅ monotouch: All 26 tests passed. [attempt 2] Html Report (VSDrops) Download
✅ msbuild: All 2 tests passed. Html Report (VSDrops) Download
⚠️ mtouch: No tests selected. Html Report (VSDrops) Download
⚠️ xammac: No tests selected. Html Report (VSDrops) Download
✅ xcframework: All 4 tests passed. Html Report (VSDrops) Download
✅ xtro: All 1 tests passed. Html Report (VSDrops) Download

Pipeline on Agent
Hash: b4e3361a10ce6856d77d6ee9c9df7460489eefe6 [PR build]

stephen-hawley · 2023-06-22T14:56:09Z

src/ObjCRuntime/Runtime.CoreCLR.cs

+				return IntPtr.Zero;
+
+			string location;
+			if (IsNativeAOT) {


When I read this, it raises some questions to me: what is wrong with asm?.Location in the IsNativeAOT case?
Docs say that this is a path unless it was loaded from a byte array in which case it will be "". Is that the case here? Because if it is, maybe the test should be if it's empty string which would catch more cases maybe?

Assembly.Location doesn't return anything meaningful when using NativeAOT, because there's no assembly on disk.

Additionally, the NativeAOT toolchain will show a warning if Assembly.Location is called, so we have to avoid it if we want to be warning-free (these warnings will show up for every customer as well, so it's much better to just avoid the warning instead of having the code path that copes with whatever it returns + the warning.

NativeAOT doesn't have the assemblies as files, similar to the single-file CoreCLR deployment mode. They are all linked together into the same executable.

Here's one place where it is documented: https://learn.microsoft.com/en-us/dotnet/core/deploying/single-file/overview?tabs=cli#api-incompatibility

FWIW, here is another related workaround for NativeAOT which explains the limitations in the PR description: xamarin/Touch.Unit#116 (comment)

rolfbjarne · 2023-06-22T15:00:29Z

Test failures are unrelated.

This comment has been minimized.

Sign in to view

rolfbjarne changed the base branch from main to net8.0 April 28, 2023 09:59

rolfbjarne force-pushed the nativeaot-bridge branch from 3e23d85 to 190a850 Compare April 28, 2023 10:01

This comment has been minimized.

Sign in to view

kotlarmilos mentioned this pull request May 10, 2023

Enable dotnet SDK to support targeting iOS with NativeAOT dotnet/sdk#30068

Closed

4 tasks

rolfbjarne force-pushed the nativeaot-bridge branch from 190a850 to 53de0d6 Compare June 5, 2023 16:33

This comment was marked as outdated.

Sign in to view

This comment has been minimized.

Sign in to view

rolfbjarne force-pushed the nativeaot-bridge branch from e5eab3a to 4b99217 Compare June 6, 2023 09:14

This comment was marked as outdated.

Sign in to view

This comment has been minimized.

Sign in to view

rolfbjarne added 17 commits June 21, 2023 20:49

[dotnet] Collect all the native linker arguments ILC would have used …

2ee5326

…and use them ourselves.

[dotnet] Enforce that the linker must be enabled for all assemblies w…

617f64e

…hen using NativeAOT (and warn if someone asks otherwise).

[dotnet] Set PublishAotUsingRuntimePack=true when using NativeAOT to …

d601e51

…get the correct BCL libraries.

[dotnet] Turn off some publishing behavior we don't need

e3228d0

[dotnet] Fix items in TrimmerRootAssembly to follow docs and what ILC…

a1d707c

… supports.

[tests] Fix computing when the dynamic registrar is used.

0adbf77

[dotnet/tests] Only use NativeAOT when publishing.

7d65804

This matches how NativeAOT works for other platforms.

[dotnet] Remove libSystem.Net.Security.Native from tvOS builds when u…

97b91f1

…sing NativeAOT.

[tests] Adjust ConfigTest to cope with different behavior when using …

c49888b

…NativeAOT.

[dotnet] Disable SelfContained for the outer build of a universal app…

264be70

… build when using NativeAOT.

[xharness] Disable NativeAOT test variations for macOS for now, we're…

e31b0a6

… waiting for a dotnet/runtime fix.

[xharness] Disable NativeAOT test variations for Mac Catalyst for now…

94cdec2

…, we need a few upstream fixes.

[dotnet] Set a flag to avoid a bug with the NativeAOT compiler

42d6121

[dotnet] Treat the ICU data file as a resource instead of an assembly.

3c912d7

We can fix this better once this fix reaches us: dotnet/runtime#87813 because then we can set the ICU data file at build time (to a relative path).

[dotnet] Tell ILC about any satellite assemblies.

b4e3361

rolfbjarne force-pushed the nativeaot-bridge branch from 7e1482c to b4e3361 Compare June 22, 2023 06:46

This comment has been minimized.

Sign in to view

stephen-hawley approved these changes Jun 22, 2023

View reviewed changes

rolfbjarne merged commit 9b72a75 into xamarin:net8.0 Jun 22, 2023

rolfbjarne deleted the nativeaot-bridge branch June 22, 2023 15:00

ivanpovazan mentioned this pull request Jun 30, 2023

Enable support for NativeAOT targeting iOS via opt-in feature dotnet/runtime#80905

Open

52 tasks

Add support for using NativeAOT. #17374

Add support for using NativeAOT. #17374

Conversation

rolfbjarne commented Jan 25, 2023 • edited Loading

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

ivanpovazan commented May 19, 2023

ivanpovazan commented May 24, 2023

rolfbjarne commented May 25, 2023

This comment was marked as outdated.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment was marked as outdated.

This comment has been minimized.

This comment has been minimized.

vs-mobiletools-engineering-service2 commented Jun 22, 2023

💻 [CI Build] Windows Integration Tests passed 💻

vs-mobiletools-engineering-service2 commented Jun 22, 2023

📚 [PR Build] Artifacts 📚

Packages generated

vs-mobiletools-engineering-service2 commented Jun 22, 2023

❌ [PR Build] Tests on macOS M1 - Mac Ventura (13.0) failed ❌

vs-mobiletools-engineering-service2 commented Jun 22, 2023

❌ [PR Build] Tests on macOS M1 - Mac Big Sur (11.5) failed ❌

vs-mobiletools-engineering-service2 commented Jun 22, 2023

✅ API diff for current PR / commit

✅ API diff vs stable

ℹ️ Generator diff

This comment has been minimized.

vs-mobiletools-engineering-service2 commented Jun 22, 2023

🔥 [CI Build] Test results 🔥

Test results

Failures

❌ dotnettests tests [attempt 2]

Successes

stephen-hawley Jun 22, 2023

Choose a reason for hiding this comment

rolfbjarne Jun 22, 2023

Choose a reason for hiding this comment

filipnavara Jun 22, 2023

Choose a reason for hiding this comment

ivanpovazan Jun 22, 2023

Choose a reason for hiding this comment

rolfbjarne commented Jun 22, 2023

rolfbjarne commented Jan 25, 2023 •

edited

Loading