Adding HelloiOS sample for NativeAOT #82249

ivanpovazan · 2023-02-16T18:00:14Z

This PR introduces necessary changes to build and run a sample application with NativeAOT on iOS-like platforms.
The application is intended to be used by developers who work on enabling NativeAOT on iOS-like platforms and can serve as PoC.

What is included

AppleAppBuilder adaptations to support NativeAOT-specific configuration
Sample project configured for building with NativeAOT and a makefile used for building the dependencies and the application
README.md which explains how to build/run the application

Takeaways

Currently still relies on dotnet/runtime internals and requires local builds instead of package references
The application uses InvariantGlobalization as the libraries are still not being built for NativeAOT on iOS Fix NativeAOT ICU build integration for Apple mobile platforms #82389
The app has been locally tested on: ios-arm64/iossimulator-arm64/maccatalyst-arm64
Aligned naming of NativeDependencies property with AndroidAppBuilder work: [android][ios] Add LibraryBuilder task to support aot library mode #81919

Contributes to: #80911

ghost · 2023-02-16T18:01:09Z

Tagging subscribers to this area: @agocke, @MichalStrehovsky, @jkotas
See info in area-owners.md if you want to be subscribed.

Issue Details

This PR introduces necessary changes to build and run a sample application with NativeAOT on iOS-like platforms.

What is included

AppleAppBuilder adaptations to support NativeAOT-specific configuration
Sample project configured for building with NativeAOT and a makefile used for building the dependencies and the application
README.md which explains how to build/run the application

Takeaways

The application is currently located in src/mono/sample/iOS-NativeAOT directory, which is not ideal and will be changed in the future. I wanted to avoid interrupting the repo tree and believe that for now (in this initial NativeAOT on iOS support) the location is good enough. Later, once we have more complete NativeAOT on iOS support, we should move the sample into a tests directory where it should become a functional test. Nevertheless, I am open for suggestions where to place the application.
The PR is marked as a draft, as it depends on: Update NativeAOT build integration targets to include ioslike platforms #82086 which includes changes introduced in the last commit of this PR (should be reverted once merged).
The app has been locally tested on ios-arm64/iossimulator-arm64/maccatalyst-arm64

Fixes #80911

Author:	ivanpovazan
Assignees:	ivanpovazan
Labels:	`area-NativeAOT-coreclr`
Milestone:	-

ghost · 2023-02-16T18:01:43Z

Tagging subscribers to 'os-ios': @steveisok, @akoeplinger
See info in area-owners.md if you want to be subscribed.

Issue Details

This PR introduces necessary changes to build and run a sample application with NativeAOT on iOS-like platforms.

What is included

AppleAppBuilder adaptations to support NativeAOT-specific configuration
Sample project configured for building with NativeAOT and a makefile used for building the dependencies and the application
README.md which explains how to build/run the application

Takeaways

The application is currently located in src/mono/sample/iOS-NativeAOT directory, which is not ideal and will be changed in the future. I wanted to avoid interrupting the repo tree and believe that for now (in this initial NativeAOT on iOS support) the location is good enough. Later, once we have more complete NativeAOT on iOS support, we should move the sample into a tests directory where it should become a functional test. Nevertheless, I am open for suggestions where to place the application.
The PR is marked as a draft, as it depends on: Update NativeAOT build integration targets to include ioslike platforms #82086 which includes changes introduced in the last commit of this PR (should be reverted once merged).
The app has been locally tested on ios-arm64/iossimulator-arm64/maccatalyst-arm64

Fixes #80911

Author:	ivanpovazan
Assignees:	ivanpovazan
Labels:	`os-ios`, `area-NativeAOT-coreclr`
Milestone:	-

ivanpovazan · 2023-02-17T10:18:39Z

~~Failures are related~~

ivanpovazan · 2023-02-17T13:25:01Z

/azp run runtime-extra-platforms

azure-pipelines · 2023-02-17T13:25:25Z

Azure Pipelines successfully started running 1 pipeline(s).

src/mono/sample/iOS-NativeAOT/Makefile

src/mono/sample/iOS-NativeAOT/Program.csproj

ivanpovazan · 2023-02-17T16:56:04Z

/azp run runtime-extra-platforms

azure-pipelines · 2023-02-17T16:56:27Z

Azure Pipelines successfully started running 1 pipeline(s).

…er changes

marek-safar · 2023-02-20T09:56:40Z

src/mono/sample/iOS-NativeAOT/README.md

@@ -0,0 +1,55 @@
+# NativeAOT iOS sample app


Why is it under mono folder?

I agree the location is not ideal as I wrote in the description, I wanted to avoid interrupting the repo tree and think that until we have more complete support with NativeAOT it might stay like this, as these samples are generally used as PoC. Later, once we have more complete NativeAOT on iOS support, we should move the sample into a tests directory where it should become a functional test. Nevertheless, I am open for suggestions where to place the application.

FWIW NativeAOT keeps samples here: https://github.com/dotnet/samples/tree/main/core/nativeaot

There's also https://github.com/dotnet/runtime/tree/main/src/samples which may be better than the mono location. I assume the desire is to keep it in the same repository to allow quick iteration of AppleAppBuilder changes.

@MichalStrehovsky what do you think?

I don't have a strong opinion. If the sample is not building/testing, it will go stale and stop working quickly. This sample is digging into too many unstable internals to be placed in the dotnet/samples repo.

I don't know about the src/samples directory. It looks like it's something we imported from runtimelab. It's unclear if intentionally; can't find any docs for what it is. If I try to dotnet build the project in it, it doesn't seem to build.

It's not clear to me who the target audience for the sample is. I don't have an opinion on where it should be.

It's not clear to me who the target audience for the sample is.

The target audience, for now, are developers contributing to NativeAOT on iOS work and the sample serves as a verification method to locally test a change (or series of changes).

On the other hand, the sample is also a "proof" that with the current state of dotnet/runtime main, one can build an iOS-like application targeting different platforms with NativeAOT.

Once we have runtime packages ready, they will be referenced instead of referencing internals explicitly.

What I was trying to say is that if this is not building/running, it will go stale and might as well live in a personal repo of one of the devs. It will likely get regularly broken now or in the future. If it's building and running, it would qualify as a test and would go to src/tests. I'm not firm on any of this but I was asked for an opinion :)

I understand, and I am grateful for your input! :)
I was just describing the reasoning behind it.
Another thing I forgot the mention, is that the Mono sample, living in: https://github.com/dotnet/runtime/tree/main/src/mono/sample/iOS, is built regularly in size/performance regression tracking, so was thinking that in the future the same approach can be used for NativeAOT as well. This would prevent the sample to go stale.

We had very similar discussion when src/mono/sample was added initially. The problem is that we have overloaded meaning of samples.

Product samples that customers can copy&paste and they just work. These samples live in dotnet/samples repo. Samples under src/mono/sample or src/samples are not that. They depend on the rest of the repo, internal details and they are not generally something we would like to see replicated in uncontrolled way.

Basic apps that people working on the dotnet/runtime repo find convenient for ad-hoc testing and that are sometimes used for other purposes, like perf testing. They are simple end-to-end tests more than anything else. We use multiple conventions for these projects. src\coreclr\tools\aot\ILCompiler\repro is another example of this kind of convenience project. I think it is confusing that we call these samples.

ivanpovazan · 2023-02-20T13:01:17Z

Seems like: https://dev.azure.com/dnceng-public/public/_build/results?buildId=178099&view=logs&jobId=d3a6f3fc-d50c-54c5-b06b-38eb411e3534&j=d3a6f3fc-d50c-54c5-b06b-38eb411e3534&t=b8f6f537-58cb-57ff-5e95-0ff9364a40c9
is the same issue as: #81123

ivanpovazan · 2023-02-20T14:22:23Z

/azp run runtime-extra-platforms

azure-pipelines · 2023-02-20T14:22:52Z

Azure Pipelines successfully started running 1 pipeline(s).

steveisok · 2023-02-20T15:27:22Z

@ivanpovazan @akoeplinger should there be a nativeaot pipeline to avoid running the kitchen sink?

ivanpovazan · 2023-02-20T15:43:33Z

@ivanpovazan @akoeplinger should there be a nativeaot pipeline to avoid running the kitchen sink?

Yes, maybe not required at the moment, but would be good to have some way of verifying the changes in the future (I suppose maccatalyst as a test platform?).

The reason I ran runtime-extra-platforms here, is to verify I did not break anything in AppleAppBuilder for Mono.

kotlarmilos

Minor suggestions, LGTM.

src/mono/sample/iOS-NativeAOT/Makefile

src/mono/sample/iOS-NativeAOT/Program.csproj

src/tasks/AppleAppBuilder/Templates/util.m

kotlarmilos · 2023-02-21T12:02:45Z

tvos-arm64 failure is dotnet/arcade#11683.

ivanpovazan · 2023-02-21T13:17:12Z

/azp run runtime-extra-platforms

azure-pipelines · 2023-02-21T13:17:30Z

Azure Pipelines successfully started running 1 pipeline(s).

src/tasks/AppleAppBuilder/Templates/main-simple.m

src/mono/sample/iOS-NativeAOT/Program.csproj

ivanpovazan · 2023-02-23T13:51:34Z

/azp run runtime-ioslike

azure-pipelines · 2023-02-23T13:51:53Z

Azure Pipelines successfully started running 1 pipeline(s).

ivanpovazan · 2023-02-23T17:05:50Z

Failures are unrelated.

…ation's purpose

ivanpovazan requested review from akoeplinger and kotlarmilos February 16, 2023 18:00

ivanpovazan self-assigned this Feb 16, 2023

dotnet-issue-labeler bot added the area-NativeAOT-coreclr label Feb 16, 2023

ivanpovazan changed the title ~~Adding HelloiOS sample for NativeAOT~~ WIP: Adding HelloiOS sample for NativeAOT Feb 16, 2023

ivanpovazan added the os-ios Apple iOS label Feb 16, 2023

ivanpovazan force-pushed the nativeaot-ios branch from 63483f2 to 18cd129 Compare February 16, 2023 18:07

This was referenced Feb 16, 2023

OSX infra issue - prereq check for 'pkg-config' missing #82240

Closed

Roslyn source generator crash on mono/linux/arm64 #81123

Closed

kotlarmilos reviewed Feb 17, 2023

View reviewed changes

src/mono/sample/iOS-NativeAOT/Makefile Show resolved Hide resolved

kotlarmilos reviewed Feb 17, 2023

View reviewed changes

src/mono/sample/iOS-NativeAOT/Program.csproj Outdated Show resolved Hide resolved

kotlarmilos reviewed Feb 17, 2023

View reviewed changes

src/mono/sample/iOS-NativeAOT/Program.csproj Show resolved Hide resolved

build-analysis bot mentioned this pull request Feb 17, 2023

[QUIC] Missing libmsquic on tested platforms #81901

Closed

4 tasks

ivanpovazan added 6 commits February 20, 2023 10:23

Integrate AppleAppBuilder with NativeAOT runtime

e0b8ca3

Add HelloiOS sample variant for NativeAOT

53baa49

Adding a README.md

433f8df

Bump the version displayed on the screen when running HelloiOS app

ba174d2

Use util.m with Mono as well and fix the build

65b08e3

Use NativeDependencies property instead to align with AndroidAppBuild…

c09b462

…er changes

ivanpovazan force-pushed the nativeaot-ios branch from 370033d to c09b462 Compare February 20, 2023 09:38

ivanpovazan marked this pull request as ready for review February 20, 2023 09:39

ivanpovazan requested a review from marek-safar as a code owner February 20, 2023 09:39

ivanpovazan changed the title ~~WIP: Adding HelloiOS sample for NativeAOT~~ Adding HelloiOS sample for NativeAOT Feb 20, 2023

ivanpovazan requested a review from filipnavara February 20, 2023 09:41

marek-safar reviewed Feb 20, 2023

View reviewed changes

kotlarmilos approved these changes Feb 21, 2023

View reviewed changes

Adding fixes according to review feedback

b369a36

build-analysis bot mentioned this pull request Feb 21, 2023

Tracking issue for CI build timeouts #76454

Closed

akoeplinger reviewed Feb 21, 2023

View reviewed changes

Adding fixes according to review feedback

b621221

ivanpovazan added 2 commits February 24, 2023 12:05

Adding more details into the app README.md file to clarify the applic…

d42f3e3

…ation's purpose

Markdown cleanup

d69ba2e

build-analysis bot mentioned this pull request Feb 24, 2023

CI legs failing with "Assembly 'illink' is missing dependency 'Mono.Cecil'" error #82611

Closed

akoeplinger approved these changes Feb 24, 2023

View reviewed changes

ivanpovazan mentioned this pull request Feb 24, 2023

HelloiOS sample for NativeAOT #80911

Closed

2 tasks

ivanpovazan merged commit 78f8010 into dotnet:main Feb 24, 2023

ghost locked as resolved and limited conversation to collaborators Mar 26, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding HelloiOS sample for NativeAOT #82249

Adding HelloiOS sample for NativeAOT #82249

ivanpovazan commented Feb 16, 2023 •

edited

Loading

ghost commented Feb 16, 2023

What is included

Takeaways

ghost commented Feb 16, 2023

What is included

Takeaways

ivanpovazan commented Feb 17, 2023 •

edited

Loading

ivanpovazan commented Feb 17, 2023

azure-pipelines bot commented Feb 17, 2023

ivanpovazan commented Feb 17, 2023

azure-pipelines bot commented Feb 17, 2023

marek-safar Feb 20, 2023

ivanpovazan Feb 20, 2023 •

edited

Loading

ivanpovazan Feb 20, 2023

filipnavara Feb 20, 2023 •

edited

Loading

ivanpovazan Feb 21, 2023

MichalStrehovsky Feb 21, 2023

ivanpovazan Feb 21, 2023 •

edited

Loading

MichalStrehovsky Feb 21, 2023

ivanpovazan Feb 21, 2023

jkotas Feb 21, 2023

ivanpovazan commented Feb 20, 2023

ivanpovazan commented Feb 20, 2023

azure-pipelines bot commented Feb 20, 2023

steveisok commented Feb 20, 2023

ivanpovazan commented Feb 20, 2023

kotlarmilos left a comment

kotlarmilos commented Feb 21, 2023

ivanpovazan commented Feb 21, 2023

azure-pipelines bot commented Feb 21, 2023

ivanpovazan commented Feb 23, 2023

azure-pipelines bot commented Feb 23, 2023

ivanpovazan commented Feb 23, 2023

Adding HelloiOS sample for NativeAOT #82249

Adding HelloiOS sample for NativeAOT #82249

Conversation

ivanpovazan commented Feb 16, 2023 • edited Loading

What is included

Takeaways

ghost commented Feb 16, 2023

What is included

Takeaways

ghost commented Feb 16, 2023

What is included

Takeaways

ivanpovazan commented Feb 17, 2023 • edited Loading

ivanpovazan commented Feb 17, 2023

azure-pipelines bot commented Feb 17, 2023

ivanpovazan commented Feb 17, 2023

azure-pipelines bot commented Feb 17, 2023

marek-safar Feb 20, 2023

Choose a reason for hiding this comment

ivanpovazan Feb 20, 2023 • edited Loading

Choose a reason for hiding this comment

ivanpovazan Feb 20, 2023

Choose a reason for hiding this comment

filipnavara Feb 20, 2023 • edited Loading

Choose a reason for hiding this comment

ivanpovazan Feb 21, 2023

Choose a reason for hiding this comment

MichalStrehovsky Feb 21, 2023

Choose a reason for hiding this comment

ivanpovazan Feb 21, 2023 • edited Loading

Choose a reason for hiding this comment

MichalStrehovsky Feb 21, 2023

Choose a reason for hiding this comment

ivanpovazan Feb 21, 2023

Choose a reason for hiding this comment

jkotas Feb 21, 2023

Choose a reason for hiding this comment

ivanpovazan commented Feb 20, 2023

ivanpovazan commented Feb 20, 2023

azure-pipelines bot commented Feb 20, 2023

steveisok commented Feb 20, 2023

ivanpovazan commented Feb 20, 2023

kotlarmilos left a comment

Choose a reason for hiding this comment

kotlarmilos commented Feb 21, 2023

ivanpovazan commented Feb 21, 2023

azure-pipelines bot commented Feb 21, 2023

ivanpovazan commented Feb 23, 2023

azure-pipelines bot commented Feb 23, 2023

ivanpovazan commented Feb 23, 2023

ivanpovazan commented Feb 16, 2023 •

edited

Loading

ivanpovazan commented Feb 17, 2023 •

edited

Loading

ivanpovazan Feb 20, 2023 •

edited

Loading

filipnavara Feb 20, 2023 •

edited

Loading

ivanpovazan Feb 21, 2023 •

edited

Loading