Adding HelloiOS sample for NativeAOT#82249

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

Merged
ivanpovazan merged 10 commits into from
Feb 24, 2023
Merged

Adding HelloiOS sample for NativeAOT #82249

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
e0b8ca3
Integrate AppleAppBuilder with NativeAOT runtime
ivanpovazan Feb 16, 2023
53baa49
Add HelloiOS sample variant for NativeAOT
ivanpovazan Feb 16, 2023
433f8df
Adding a README.md
ivanpovazan Feb 16, 2023
ba174d2
Bump the version displayed on the screen when running HelloiOS app
ivanpovazan Feb 16, 2023
65b08e3
Use util.m with Mono as well and fix the build
ivanpovazan Feb 17, 2023
c09b462
Use NativeDependencies property instead to align with AndroidAppBuild…
ivanpovazan Feb 17, 2023
b369a36
Adding fixes according to review feedback
ivanpovazan Feb 21, 2023
b621221
Adding fixes according to review feedback
ivanpovazan Feb 23, 2023
d42f3e3
Adding more details into the app README.md file to clarify the applic…
ivanpovazan Feb 24, 2023
d69ba2e
Markdown cleanup
ivanpovazan Feb 24, 2023
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
50 changes: 50 additions & 0 deletions src/mono/sample/iOS-NativeAOT/Makefile
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
.DEFAULT_GOAL := all

TOP=../../../../

BUILD_CONFIG?=Debug
TARGET_ARCH?=$(shell . $(TOP)eng/native/init-os-and-arch.sh && echo $${arch})
TARGET_OS?=iossimulator
DEPLOY_AND_RUN?=false
STRIP_DEBUG_SYMBOLS?=false

REPO_DIR=$(realpath $(TOP))
TASKS_DIR=$(REPO_DIR)/src/tasks
DOTNET=$(REPO_DIR)/dotnet.sh
BUILD_SCRIPT=$(REPO_DIR)/build.sh

world: build-deps all

# build all dependencies: runtime, nativeAot and all the libs
build-deps: build-runtime-ilc build-libs-all

# building for host
build-runtime-ilc:
$(BUILD_SCRIPT) clr+clr.aot -c $(BUILD_CONFIG)

build-ilc:
Comment thread
kotlarmilos marked this conversation as resolved.
Outdated
$(BUILD_SCRIPT) clr.aot -c $(BUILD_CONFIG)

# building for target platform
build-libs-all:
$(BUILD_SCRIPT) clr.nativeaotruntime+clr.nativeaotlibs+libs -c $(BUILD_CONFIG) -os $(TARGET_OS) -arch $(TARGET_ARCH)

build-libs-nativeaot:
$(BUILD_SCRIPT) clr.nativeaotruntime+clr.nativeaotlibs -c $(BUILD_CONFIG) -os $(TARGET_OS) -arch $(TARGET_ARCH)

all: appbuilder hello-app

appbuilder:
$(DOTNET) build -c $(BUILD_CONFIG) $(TASKS_DIR)/AppleAppBuilder/AppleAppBuilder.csproj

hello-app: clean
$(DOTNET) \
build -c $(BUILD_CONFIG) \
-p:TargetOS=$(TARGET_OS) \
-p:TargetArchitecture=$(TARGET_ARCH) \
-p:DeployAndRun=$(DEPLOY_AND_RUN) \
-p:StripDebugSymbols=$(STRIP_DEBUG_SYMBOLS) \
-bl
Comment thread
kotlarmilos marked this conversation as resolved.

clean:
rm -rf obj bin
95 changes: 95 additions & 0 deletions src/mono/sample/iOS-NativeAOT/Program.csproj
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<OutputType>Exe</OutputType>
<OutputPath>bin</OutputPath>
<IntermediateOutputPath>$(MSBuildThisFileDirectory)/obj/</IntermediateOutputPath>
<TargetFramework>$(NetCoreAppCurrent)</TargetFramework>
<TargetOS Condition="'$(TargetOS)' == ''">ios</TargetOS>
<TargetOS Condition="'$(TargetsiOSSimulator)' == 'true'">iossimulator</TargetOS>
<DeployAndRun Condition="'$(DeployAndRun)' == ''">true</DeployAndRun>
<RuntimeIdentifier>$(TargetOS)-$(TargetArchitecture)</RuntimeIdentifier>
<AppName>HelloiOS</AppName>
Comment thread
kotlarmilos marked this conversation as resolved.
Outdated
<StripDebugSymbols Condition="'$(StripDebugSymbols)' == ''">false</StripDebugSymbols>
<!-- NativeAOT-specific props -->
<NativeLib>static</NativeLib>
<CustomNativeMain>true</CustomNativeMain>
<UseNativeAOTRuntime Condition="'$(UseNativeAOTRuntime)' == ''">true</UseNativeAOTRuntime>
<!-- FIXME: Once we support building System.Globalization.Native and icu, should be removed -->
<InvariantGlobalization>true</InvariantGlobalization>
<!-- FIXME: We do not use publish targets yet, but we need to create a publish directory -->
<PublishDir Condition="'$(PublishDir)' == ''">$(OutputPath)/publish</PublishDir>
</PropertyGroup>

<ItemGroup>
<Compile Include="..\iOS\Program.cs" Link="Program.cs" />
<DirectPInvoke Include="__Internal" />
</ItemGroup>

<PropertyGroup Condition="'$(TargetOS)' == 'maccatalyst'">
Comment thread
ivanpovazan marked this conversation as resolved.
<DevTeamProvisioning Condition="'$(DevTeamProvisioning)' == ''">adhoc</DevTeamProvisioning>
<EnableAppSandbox Condition="'$(EnableAppSandbox)' == ''">false</EnableAppSandbox>
</PropertyGroup>

<Import Project="$(CoreClrProjectRoot)nativeaot\BuildIntegration\Microsoft.NETCore.Native.targets" />
<UsingTask TaskName="AppleAppBuilderTask"
AssemblyFile="$(AppleAppBuilderTasksAssemblyPath)" />

<!-- FIXME: Once we set up builing appropriate runtime package for iOS-like platforms the following properties should be removed -->
<Target Name="ConfigureIlcPathsForiOSCrossCompilation">
<PropertyGroup>
<IlcPath>$([MSBuild]::NormalizeDirectory('$(RepoRoot)', 'artifacts', 'bin', 'coreclr', '$(HostOS).$(BuildArchitecture).$(CoreCLRConfiguration)', 'ilc'))</IlcPath>
<IlcToolsPath>$(IlcPath)</IlcToolsPath>
<IlcSdkPath>$(CoreCLRAotSdkDir)</IlcSdkPath>
<IlcFrameworkPath>$(LibrariesAllBinArtifactsPath)</IlcFrameworkPath>
<IlcFrameworkNativePath>$(LibrariesAllBinArtifactsPath)</IlcFrameworkNativePath>
</PropertyGroup>
</Target>

<Target Name="BuildAppBundle"
AfterTargets="Build"
DependsOnTargets="ConfigureIlcPathsForiOSCrossCompilation;SetupProperties;ComputeIlcCompileInputs;IlcCompile">

<PropertyGroup>
<AppDir>$(MSBuildThisFileDirectory)$(PublishDir)\app</AppDir>
<IosSimulator Condition="'$(TargetsiOSSimulator)' == 'true'">iPhone 11</IosSimulator>
<Optimized Condition="'$(Configuration)' == 'Release'">True</Optimized>
</PropertyGroup>

<ItemGroup>
<NativeLibrary Include="%(ManagedBinary.IlcOutputFile)" />
</ItemGroup>

<RemoveDir Directories="$(AppDir)" />

<AppleAppBuilderTask
UseNativeAOTRuntime="$(UseNativeAOTRuntime)"
NativeDependencies="@(NativeLibrary)"
TargetOS="$(TargetOS)"
Arch="$(TargetArchitecture)"
ProjectName="$(AppName)"
Assemblies="@(BundleAssemblies)"
GenerateXcodeProject="True"
BuildAppBundle="True"
DevTeamProvisioning="$(DevTeamProvisioning)"
OutputDirectory="$(AppDir)"
Optimized="$(Optimized)"
InvariantGlobalization="$(InvariantGlobalization)"
StripSymbolTable="$(StripDebugSymbols)"
AppDir="$(MSBuildThisFileDirectory)$(PublishDir)" >
<Output TaskParameter="AppBundlePath" PropertyName="AppBundlePath" />
<Output TaskParameter="XcodeProjectPath" PropertyName="XcodeProjectPath" />
</AppleAppBuilderTask>

<Message Importance="High" Text="Xcode: $(XcodeProjectPath)"/>
<Message Importance="High" Text="App: $(AppBundlePath)"/>

</Target>

<Target Name="RunAppBundle"
AfterTargets="BuildAppBundle"
Condition="'$(DeployAndRun)' == 'true'">
<Exec Condition="'$(TargetOS)' == 'iossimulator'" Command="dotnet xharness apple run --app=$(AppBundlePath) --targets=ios-simulator-64 --output-directory=/tmp/out" />
<Exec Condition="'$(TargetOS)' == 'ios'" Command="dotnet xharness apple run --app=$(AppBundlePath) --targets=ios-device --output-directory=/tmp/out" />
</Target>

</Project>
79 changes: 79 additions & 0 deletions src/mono/sample/iOS-NativeAOT/README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
# NativeAOT iOS sample app

@marek-safarmarek-safarFeb 20, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Why is it under mono folder?

@ivanpovazanivanpovazanFeb 20, 2023•
edited
Loading

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

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.

@ivanpovazanivanpovazanFeb 20, 2023

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

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

@filipnavarafilipnavaraFeb 20, 2023•
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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.

@ivanpovazanivanpovazanFeb 21, 2023

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

@MichalStrehovsky what do you think?

@MichalStrehovskyMichalStrehovskyFeb 21, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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.

@ivanpovazanivanpovazanFeb 21, 2023•
edited
Loading

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

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.

@MichalStrehovskyMichalStrehovskyFeb 21, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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 :)

@ivanpovazanivanpovazanFeb 21, 2023

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

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.

@jkotasjkotasFeb 21, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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.


## Description

This sample application is intended to be used by developers who work on enabling NativeAOT on iOS-like platforms and can serve as PoC for verifying support for the following systems:
- ios
- iossimulator
- tvos
- tvossimulator
- maccatalyst

The sample shares the source code with the Mono sample specified at: `../iOS/Program.cs` and in general should have the same behavior as MonoAOT.

## Limitations

The application is **_currently_** relying on the following:
1. Internal dependencies - locally building the internals is required as runtime and tools nuget packages are still not being produced
2. Invariant globalization - `System.Globalization.Native` is currently not being built as part of NativeAOT framework for iOS-like platforms
3. No publish targets - the SDK and MSBuild integration is still not complete

## How to build and test

### Building for the first time

When building for the first time (on a clean checkout) run from this directory the following `make` command:
``` bash
make world
```
This will first build all required runtime components and dependencies, after which it will build the sample app and bundle it into an application bundle.
By default the build will use `Debug` build configuration and target `iossimulator`.
To change this behavior, specify the desired setting in the following way:
``` bash
make world BUILD_CONFIG=Release TARGET_OS=ios
```

### To avoid building all the dependencies

For future builds, you can run just:
``` bash
make
```
which will skip building all the runtime dependencies, assuming those have been already properly built, and build the MSBuild task used for bundling the application and the application it self.

For convenience, it is also possible to rebuild only the application it self with:
``` bash
make hello-app
```

### Deploy and run

#### Simulator

To test the application on a simulator include the following in your make command `DEPLOY_AND_RUN=true` e.g.,:
``` bash
make hello-app DEPLOY_AND_RUN=true
```

#### Device

To test the application on a device, a provisioning profile needs to be specified.
This can be achieved by defining `DevTeamProvisioning` environment variable with a valid team ID (see [developer.apple.com/account/#/membership](https://developer.apple.com/account/#/membership), scroll down to `Team ID`) for example:
``` bash
export DevTeamProvisioning=A1B2C3D4E5; make hello-app TARGET_OS=ios DEPLOY_AND_RUN=true
```
Assuming `A1B2C3D4E5` is a valid team ID.

#### One-liner

On a clean dotnet/runtime checkout, from this directory, run:

``` bash
export DevTeamProvisioning=A1B2C3D4E5; make world BUILD_CONFIG=Release TARGET_OS=ios DEPLOY_AND_RUN=true
```

This command will build everything necessary to run and deploy the application on an iOS device.

### Custom builds

Check the `Makefile` for individual list of targets and variables to customize the build.
2 changes: 1 addition & 1 deletion src/mono/sample/iOS/Program.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,7 @@ public static async Task Main(string[] args)
delegate* unmanaged<void> unmanagedPtr = &OnButtonClick;
ios_register_button_click(unmanagedPtr);
}
const string msg = "Hello World!\n.NET 5.0";
const string msg = "Hello World!\n.NET 8.0";
for (int i = 0; i < msg.Length; i++)
{
// a kind of an animation
Expand Down
10 changes: 10 additions & 0 deletions src/tasks/AppleAppBuilder/AppleAppBuilder.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -171,6 +171,11 @@ public string TargetOS
/// </summary>
public bool UseNativeAOTRuntime { get; set; }

/// <summary>
/// Extra native dependencies to link into the app
/// </summary>
public string[] NativeDependencies { get; set; } = Array.Empty<string>();

public void ValidateRuntimeSelection()
{
if (UseNativeAOTRuntime)
Expand DownExpand Up@@ -267,6 +272,11 @@ public override bool Execute()
}
}

foreach (var nativeDependency in NativeDependencies)
{
assemblerFilesToLink.Add(nativeDependency);
}

if (!ForceInterpreter && (isDevice || ForceAOT) && (assemblerFiles.Count == 0 && !UseNativeAOTRuntime))
{
throw new InvalidOperationException("Need list of AOT files for device builds.");
Expand Down
11 changes: 10 additions & 1 deletion src/tasks/AppleAppBuilder/Templates/CMakeLists.txt.template
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,8 @@ add_executable(
%ProjectName%
%MainSource%
${APP_RESOURCES}
util.h
util.m
)

if(NOT %UseNativeAOTRuntime%)
Expand DownExpand Up@@ -73,5 +75,12 @@ target_link_libraries(
"-lz"
"-lc++"
"-liconv"
%NativeLibrariesToLink%
%NativeLibrariesToLink%
)

if(%UseNativeAOTRuntime%)
target_link_libraries(
%ProjectName%
"-Wl,-u,_NativeAOT_StaticInitialization"
)
endif()
11 changes: 8 additions & 3 deletions src/tasks/AppleAppBuilder/Templates/main-simple.m
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,8 @@
#if !USE_NATIVE_AOT
#import "runtime.h"
#else
extern void* NativeAOT_StaticInitialization();
#import <os/log.h>
#import "util.h"
extern int __managed__Main(int argc, char* argv[]);
#endif

Expand DownExpand Up@@ -57,8 +58,12 @@ - (void)viewDidLoad {
#if INVARIANT_GLOBALIZATION
setenv ("DOTNET_SYSTEM_GLOBALIZATION_INVARIANT", "1", TRUE);
#endif
NativeAOT_StaticInitialization();
int ret_val = __managed__Main(0, NULL);
char **managed_argv;
int managed_argc = get_managed_args (&managed_argv);
int ret_val = __managed__Main (managed_argc, managed_argv);
free_managed_args (&managed_argv, managed_argc);
Comment thread
akoeplinger marked this conversation as resolved.
os_log_info (OS_LOG_DEFAULT, EXIT_CODE_TAG ": %d", ret_val);
exit (ret_val);
#endif
});
}
Expand Down
17 changes: 6 additions & 11 deletions src/tasks/AppleAppBuilder/Templates/runtime.m
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,15 +20,14 @@
#include <stdlib.h>
#include <stdio.h>

#import "util.h"

static char *bundle_path;

#define APPLE_RUNTIME_IDENTIFIER "//%APPLE_RUNTIME_IDENTIFIER%"

#define RUNTIMECONFIG_BIN_FILE "runtimeconfig.bin"

// XHarness is looking for this tag in app's output to determine the exit code
#define EXIT_CODE_TAG "DOTNET.APP_EXIT_CODE"

const char *
get_bundle_path (void)
{
Expand DownExpand Up@@ -254,14 +253,8 @@
setenv ("DOTNET_DiagnosticPorts", DIAGNOSTIC_PORTS, true);
#endif

id args_array = [[NSProcessInfo processInfo] arguments];
assert ([args_array count] <= 128);
const char *managed_argv [128];
int argi;
for (argi = 0; argi < [args_array count]; argi++) {
NSString* arg = [args_array objectAtIndex: argi];
managed_argv[argi] = [arg UTF8String];
}
char **managed_argv;
int argi = get_managed_args (&managed_argv);

bool wait_for_debugger = FALSE;

Expand DownExpand Up@@ -373,5 +366,7 @@

mono_jit_cleanup (domain);

free_managed_args (&managed_argv, argi);

exit (res);
}
13 changes: 13 additions & 0 deletions src/tasks/AppleAppBuilder/Templates/util.h
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

#ifndef util_h
#define util_h

// XHarness is looking for this tag in app's output to determine the exit code
#define EXIT_CODE_TAG "DOTNET.APP_EXIT_CODE"

size_t get_managed_args (char*** managed_args_array);
void free_managed_args (char*** managed_args_array, size_t array_size);

#endif /* util_h */
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Adding HelloiOS sample for NativeAOT#82249

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

 Merged

ivanpovazan
merged 10 commits into

from

Feb 24, 2023
 Merged


Adding HelloiOS sample for NativeAOT
#82249
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
e0b8ca3

Integrate AppleAppBuilder with NativeAOT runtime


ivanpovazan Feb 16, 2023
53baa49

Add HelloiOS sample variant for NativeAOT


ivanpovazan Feb 16, 2023
433f8df

Adding a README.md


ivanpovazan Feb 16, 2023
ba174d2

Bump the version displayed on the screen when running HelloiOS app


ivanpovazan Feb 16, 2023
65b08e3

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


ivanpovazan Feb 17, 2023
c09b462

Use NativeDependencies property instead to align with AndroidAppBuild…


ivanpovazan Feb 17, 2023
b369a36

Adding fixes according to review feedback


ivanpovazan Feb 21, 2023
b621221

Adding fixes according to review feedback


ivanpovazan Feb 23, 2023
d42f3e3

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


ivanpovazan Feb 24, 2023
d69ba2e

Markdown cleanup


ivanpovazan Feb 24, 2023

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


50 changes: 50 additions & 0 deletions
src/mono/sample/iOS-NativeAOT/Makefile

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
.DEFAULT_GOAL := all

TOP=../../../../

BUILD_CONFIG?=Debug
TARGET_ARCH?=$(shell . $(TOP)eng/native/init-os-and-arch.sh && echo $${arch})
TARGET_OS?=iossimulator
DEPLOY_AND_RUN?=false
STRIP_DEBUG_SYMBOLS?=false

REPO_DIR=$(realpath $(TOP))
TASKS_DIR=$(REPO_DIR)/src/tasks
DOTNET=$(REPO_DIR)/dotnet.sh
BUILD_SCRIPT=$(REPO_DIR)/build.sh

world: build-deps all

# build all dependencies: runtime, nativeAot and all the libs
build-deps: build-runtime-ilc build-libs-all

# building for host
build-runtime-ilc:
	$(BUILD_SCRIPT) clr+clr.aot -c $(BUILD_CONFIG)

build-ilc:
Comment thread
kotlarmilos marked this conversation as resolved.


Outdated

	$(BUILD_SCRIPT) clr.aot -c $(BUILD_CONFIG)

# building for target platform
build-libs-all:
	$(BUILD_SCRIPT) clr.nativeaotruntime+clr.nativeaotlibs+libs -c $(BUILD_CONFIG) -os $(TARGET_OS) -arch $(TARGET_ARCH)

build-libs-nativeaot:
	$(BUILD_SCRIPT) clr.nativeaotruntime+clr.nativeaotlibs -c $(BUILD_CONFIG) -os $(TARGET_OS) -arch $(TARGET_ARCH)

all: appbuilder hello-app

appbuilder:
	$(DOTNET) build -c $(BUILD_CONFIG) $(TASKS_DIR)/AppleAppBuilder/AppleAppBuilder.csproj

hello-app: clean
	$(DOTNET) \
	build -c $(BUILD_CONFIG) \
	-p:TargetOS=$(TARGET_OS) \
	-p:TargetArchitecture=$(TARGET_ARCH) \
	-p:DeployAndRun=$(DEPLOY_AND_RUN) \
	-p:StripDebugSymbols=$(STRIP_DEBUG_SYMBOLS) \
	-bl
Comment thread
kotlarmilos marked this conversation as resolved.


clean:
	rm -rf obj bin

95 changes: 95 additions & 0 deletions
src/mono/sample/iOS-NativeAOT/Program.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
<Project Sdk="Microsoft.NET.Sdk">
 <PropertyGroup>
 <OutputType>Exe</OutputType>
 <OutputPath>bin</OutputPath>
 <IntermediateOutputPath>$(MSBuildThisFileDirectory)/obj/</IntermediateOutputPath>
 <TargetFramework>$(NetCoreAppCurrent)</TargetFramework>
 <TargetOS Condition="'$(TargetOS)' == ''">ios</TargetOS>
 <TargetOS Condition="'$(TargetsiOSSimulator)' == 'true'">iossimulator</TargetOS>
 <DeployAndRun Condition="'$(DeployAndRun)' == ''">true</DeployAndRun>
 <RuntimeIdentifier>$(TargetOS)-$(TargetArchitecture)</RuntimeIdentifier>
 <AppName>HelloiOS</AppName>
Comment thread
kotlarmilos marked this conversation as resolved.


Outdated

 <StripDebugSymbols Condition="'$(StripDebugSymbols)' == ''">false</StripDebugSymbols>
 <!-- NativeAOT-specific props -->
 <NativeLib>static</NativeLib>
 <CustomNativeMain>true</CustomNativeMain>
 <UseNativeAOTRuntime Condition="'$(UseNativeAOTRuntime)' == ''">true</UseNativeAOTRuntime>
 <!-- FIXME: Once we support building System.Globalization.Native and icu, should be removed -->
 <InvariantGlobalization>true</InvariantGlobalization>
 <!-- FIXME: We do not use publish targets yet, but we need to create a publish directory -->
 <PublishDir Condition="'$(PublishDir)' == ''">$(OutputPath)/publish</PublishDir>
 </PropertyGroup>

 <ItemGroup>
 <Compile Include="..\iOS\Program.cs" Link="Program.cs" />
 <DirectPInvoke Include="__Internal" />
 </ItemGroup>

 <PropertyGroup Condition="'$(TargetOS)' == 'maccatalyst'">
Comment thread
ivanpovazan marked this conversation as resolved.

 <DevTeamProvisioning Condition="'$(DevTeamProvisioning)' == ''">adhoc</DevTeamProvisioning>
 <EnableAppSandbox Condition="'$(EnableAppSandbox)' == ''">false</EnableAppSandbox>
 </PropertyGroup>

 <Import Project="$(CoreClrProjectRoot)nativeaot\BuildIntegration\Microsoft.NETCore.Native.targets" />
 <UsingTask TaskName="AppleAppBuilderTask"
 AssemblyFile="$(AppleAppBuilderTasksAssemblyPath)" />

 <!-- FIXME: Once we set up builing appropriate runtime package for iOS-like platforms the following properties should be removed -->
 <Target Name="ConfigureIlcPathsForiOSCrossCompilation">
 <PropertyGroup>
 <IlcPath>$([MSBuild]::NormalizeDirectory('$(RepoRoot)', 'artifacts', 'bin', 'coreclr', '$(HostOS).$(BuildArchitecture).$(CoreCLRConfiguration)', 'ilc'))</IlcPath>
 <IlcToolsPath>$(IlcPath)</IlcToolsPath>
 <IlcSdkPath>$(CoreCLRAotSdkDir)</IlcSdkPath>
 <IlcFrameworkPath>$(LibrariesAllBinArtifactsPath)</IlcFrameworkPath>
 <IlcFrameworkNativePath>$(LibrariesAllBinArtifactsPath)</IlcFrameworkNativePath>
 </PropertyGroup>
 </Target>

 <Target Name="BuildAppBundle"
 AfterTargets="Build"
 DependsOnTargets="ConfigureIlcPathsForiOSCrossCompilation;SetupProperties;ComputeIlcCompileInputs;IlcCompile">

 <PropertyGroup>
 <AppDir>$(MSBuildThisFileDirectory)$(PublishDir)\app</AppDir>
 <IosSimulator Condition="'$(TargetsiOSSimulator)' == 'true'">iPhone 11</IosSimulator>
 <Optimized Condition="'$(Configuration)' == 'Release'">True</Optimized>
 </PropertyGroup>

 <ItemGroup>
 <NativeLibrary Include="%(ManagedBinary.IlcOutputFile)" />
 </ItemGroup>

 <RemoveDir Directories="$(AppDir)" />

 <AppleAppBuilderTask
 UseNativeAOTRuntime="$(UseNativeAOTRuntime)"
 NativeDependencies="@(NativeLibrary)"
 TargetOS="$(TargetOS)"
 Arch="$(TargetArchitecture)"
 ProjectName="$(AppName)"
 Assemblies="@(BundleAssemblies)"
 GenerateXcodeProject="True"
 BuildAppBundle="True"
 DevTeamProvisioning="$(DevTeamProvisioning)"
 OutputDirectory="$(AppDir)"
 Optimized="$(Optimized)"
 InvariantGlobalization="$(InvariantGlobalization)"
 StripSymbolTable="$(StripDebugSymbols)"
 AppDir="$(MSBuildThisFileDirectory)$(PublishDir)" >
 <Output TaskParameter="AppBundlePath" PropertyName="AppBundlePath" />
 <Output TaskParameter="XcodeProjectPath" PropertyName="XcodeProjectPath" />
 </AppleAppBuilderTask>

 <Message Importance="High" Text="Xcode: $(XcodeProjectPath)"/>
 <Message Importance="High" Text="App: $(AppBundlePath)"/>

 </Target>

 <Target Name="RunAppBundle"
 AfterTargets="BuildAppBundle"
 Condition="'$(DeployAndRun)' == 'true'">
 <Exec Condition="'$(TargetOS)' == 'iossimulator'" Command="dotnet xharness apple run --app=$(AppBundlePath) --targets=ios-simulator-64 --output-directory=/tmp/out" />
 <Exec Condition="'$(TargetOS)' == 'ios'" Command="dotnet xharness apple run --app=$(AppBundlePath) --targets=ios-device --output-directory=/tmp/out" />
 </Target>

</Project>

79 changes: 79 additions & 0 deletions
src/mono/sample/iOS-NativeAOT/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
# NativeAOT iOS sample app
@marek-safarmarek-safarFeb 20, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Why is it under mono folder?
@ivanpovazanivanpovazanFeb 20, 2023•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

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.
@ivanpovazanivanpovazanFeb 20, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

FWIW NativeAOT keeps samples here: https://github.com/dotnet/samples/tree/main/core/nativeaot
@filipnavarafilipnavaraFeb 20, 2023•

edited

Loading

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

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.
@ivanpovazanivanpovazanFeb 21, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

@MichalStrehovsky what do you think?
@MichalStrehovskyMichalStrehovskyFeb 21, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

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.
@ivanpovazanivanpovazanFeb 21, 2023•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

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.
@MichalStrehovskyMichalStrehovskyFeb 21, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

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 :)
@ivanpovazanivanpovazanFeb 21, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

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.
@jkotasjkotasFeb 21, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

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.

## Description

This sample application is intended to be used by developers who work on enabling NativeAOT on iOS-like platforms and can serve as PoC for verifying support for the following systems:
- ios
- iossimulator
- tvos
- tvossimulator
- maccatalyst

The sample shares the source code with the Mono sample specified at: `../iOS/Program.cs` and in general should have the same behavior as MonoAOT.

## Limitations

The application is **_currently_** relying on the following:
1. Internal dependencies - locally building the internals is required as runtime and tools nuget packages are still not being produced
2. Invariant globalization - `System.Globalization.Native` is currently not being built as part of NativeAOT framework for iOS-like platforms
3. No publish targets - the SDK and MSBuild integration is still not complete

## How to build and test

### Building for the first time

When building for the first time (on a clean checkout) run from this directory the following `make` command:
``` bash
make world
```
This will first build all required runtime components and dependencies, after which it will build the sample app and bundle it into an application bundle.
By default the build will use `Debug` build configuration and target `iossimulator`.
To change this behavior, specify the desired setting in the following way:
``` bash
make world BUILD_CONFIG=Release TARGET_OS=ios
```

### To avoid building all the dependencies

For future builds, you can run just:
``` bash
make
```
which will skip building all the runtime dependencies, assuming those have been already properly built, and build the MSBuild task used for bundling the application and the application it self.

For convenience, it is also possible to rebuild only the application it self with:
``` bash
make hello-app
```

### Deploy and run

#### Simulator

To test the application on a simulator include the following in your make command `DEPLOY_AND_RUN=true` e.g.,:
``` bash
make hello-app DEPLOY_AND_RUN=true
```

#### Device

To test the application on a device, a provisioning profile needs to be specified.
This can be achieved by defining `DevTeamProvisioning` environment variable with a valid team ID (see [developer.apple.com/account/#/membership](https://developer.apple.com/account/#/membership), scroll down to `Team ID`) for example:
``` bash
export DevTeamProvisioning=A1B2C3D4E5; make hello-app TARGET_OS=ios DEPLOY_AND_RUN=true
```
Assuming `A1B2C3D4E5` is a valid team ID.

#### One-liner

On a clean dotnet/runtime checkout, from this directory, run:

``` bash
export DevTeamProvisioning=A1B2C3D4E5; make world BUILD_CONFIG=Release TARGET_OS=ios DEPLOY_AND_RUN=true
```

This command will build everything necessary to run and deploy the application on an iOS device.

### Custom builds

Check the `Makefile` for individual list of targets and variables to customize the build.

2 changes: 1 addition & 1 deletion
src/mono/sample/iOS/Program.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,7 @@ public static async Task Main(string[] args)
 delegate* unmanaged<void> unmanagedPtr = &OnButtonClick;
 ios_register_button_click(unmanagedPtr);
 }
 const string msg = "Hello World!\n.NET 5.0";
 const string msg = "Hello World!\n.NET 8.0";
 for (int i = 0; i < msg.Length; i++)
 {
 // a kind of an animation
Expand Down

10 changes: 10 additions & 0 deletions
src/tasks/AppleAppBuilder/AppleAppBuilder.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -171,6 +171,11 @@ public string TargetOS
 /// </summary>
 public bool UseNativeAOTRuntime { get; set; }

 /// <summary>
 /// Extra native dependencies to link into the app
 /// </summary>
 public string[] NativeDependencies { get; set; } = Array.Empty<string>();

 public void ValidateRuntimeSelection()
 {
 if (UseNativeAOTRuntime)
Expand DownExpand Up@@ -267,6 +272,11 @@ public override bool Execute()
 }
 }

 foreach (var nativeDependency in NativeDependencies)
 {
 assemblerFilesToLink.Add(nativeDependency);
 }

 if (!ForceInterpreter && (isDevice || ForceAOT) && (assemblerFiles.Count == 0 && !UseNativeAOTRuntime))
 {
 throw new InvalidOperationException("Need list of AOT files for device builds.");
Expand Down

11 changes: 10 additions & 1 deletion
src/tasks/AppleAppBuilder/Templates/CMakeLists.txt.template

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,8 @@ add_executable(
 %ProjectName%
 %MainSource%
 ${APP_RESOURCES}
 util.h
 util.m
)

if(NOT %UseNativeAOTRuntime%)
Expand DownExpand Up@@ -73,5 +75,12 @@ target_link_libraries(
 "-lz"
 "-lc++"
 "-liconv"
%NativeLibrariesToLink%
%NativeLibrariesToLink%
)

if(%UseNativeAOTRuntime%)
target_link_libraries(
 %ProjectName%
 "-Wl,-u,_NativeAOT_StaticInitialization"
)
endif()

11 changes: 8 additions & 3 deletions
src/tasks/AppleAppBuilder/Templates/main-simple.m

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,8 @@
#if !USE_NATIVE_AOT
#import "runtime.h"
#else
extern void* NativeAOT_StaticInitialization();
#import <os/log.h>
#import "util.h"
extern int __managed__Main(int argc, char* argv[]);
#endif

Expand DownExpand Up@@ -57,8 +58,12 @@ - (void)viewDidLoad {
#if INVARIANT_GLOBALIZATION
 setenv ("DOTNET_SYSTEM_GLOBALIZATION_INVARIANT", "1", TRUE);
#endif
 NativeAOT_StaticInitialization();
 int ret_val = __managed__Main(0, NULL);
 char **managed_argv;
 int managed_argc = get_managed_args (&managed_argv);
 int ret_val = __managed__Main (managed_argc, managed_argv);
 free_managed_args (&managed_argv, managed_argc);
Comment thread
akoeplinger marked this conversation as resolved.

 os_log_info (OS_LOG_DEFAULT, EXIT_CODE_TAG ": %d", ret_val);
 exit (ret_val);
#endif
 });
}
Expand Down

17 changes: 6 additions & 11 deletions
src/tasks/AppleAppBuilder/Templates/runtime.m

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,15 +20,14 @@
#include <stdlib.h>
#include <stdio.h>

#import "util.h"

static char *bundle_path;

#define APPLE_RUNTIME_IDENTIFIER "//%APPLE_RUNTIME_IDENTIFIER%"

#define RUNTIMECONFIG_BIN_FILE "runtimeconfig.bin"

// XHarness is looking for this tag in app's output to determine the exit code
#define EXIT_CODE_TAG "DOTNET.APP_EXIT_CODE"

const char *
get_bundle_path (void)
{
Expand DownExpand Up@@ -254,14 +253,8 @@
 setenv ("DOTNET_DiagnosticPorts", DIAGNOSTIC_PORTS, true);
#endif

 id args_array = [[NSProcessInfo processInfo] arguments];
 assert ([args_array count] <= 128);
 const char *managed_argv [128];
 int argi;
 for (argi = 0; argi < [args_array count]; argi++) {
 NSString* arg = [args_array objectAtIndex: argi];
 managed_argv[argi] = [arg UTF8String];
 }
 char **managed_argv;
 int argi = get_managed_args (&managed_argv);

 bool wait_for_debugger = FALSE;

Expand DownExpand Up@@ -373,5 +366,7 @@

 mono_jit_cleanup (domain);

 free_managed_args (&managed_argv, argi);

 exit (res);
}

13 changes: 13 additions & 0 deletions
src/tasks/AppleAppBuilder/Templates/util.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

#ifndef util_h
#define util_h

// XHarness is looking for this tag in app's output to determine the exit code
#define EXIT_CODE_TAG "DOTNET.APP_EXIT_CODE"

size_t get_managed_args (char*** managed_args_array);
void free_managed_args (char*** managed_args_array, size_t array_size);

#endif /* util_h */
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Adding HelloiOS sample for NativeAOT#82249

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

 Merged

ivanpovazan
merged 10 commits into

from

Feb 24, 2023
 Merged


Adding HelloiOS sample for NativeAOT
#82249
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
e0b8ca3

Integrate AppleAppBuilder with NativeAOT runtime


ivanpovazan Feb 16, 2023
53baa49

Add HelloiOS sample variant for NativeAOT


ivanpovazan Feb 16, 2023
433f8df

Adding a README.md


ivanpovazan Feb 16, 2023
ba174d2

Bump the version displayed on the screen when running HelloiOS app


ivanpovazan Feb 16, 2023
65b08e3

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


ivanpovazan Feb 17, 2023
c09b462

Use NativeDependencies property instead to align with AndroidAppBuild…


ivanpovazan Feb 17, 2023
b369a36

Adding fixes according to review feedback


ivanpovazan Feb 21, 2023
b621221

Adding fixes according to review feedback


ivanpovazan Feb 23, 2023
d42f3e3

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


ivanpovazan Feb 24, 2023
d69ba2e

Markdown cleanup


ivanpovazan Feb 24, 2023

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


50 changes: 50 additions & 0 deletions
src/mono/sample/iOS-NativeAOT/Makefile

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
.DEFAULT_GOAL := all

TOP=../../../../

BUILD_CONFIG?=Debug
TARGET_ARCH?=$(shell . $(TOP)eng/native/init-os-and-arch.sh && echo $${arch})
TARGET_OS?=iossimulator
DEPLOY_AND_RUN?=false
STRIP_DEBUG_SYMBOLS?=false

REPO_DIR=$(realpath $(TOP))
TASKS_DIR=$(REPO_DIR)/src/tasks
DOTNET=$(REPO_DIR)/dotnet.sh
BUILD_SCRIPT=$(REPO_DIR)/build.sh

world: build-deps all

# build all dependencies: runtime, nativeAot and all the libs
build-deps: build-runtime-ilc build-libs-all

# building for host
build-runtime-ilc:
	$(BUILD_SCRIPT) clr+clr.aot -c $(BUILD_CONFIG)

build-ilc:
Comment thread
kotlarmilos marked this conversation as resolved.


Outdated

	$(BUILD_SCRIPT) clr.aot -c $(BUILD_CONFIG)

# building for target platform
build-libs-all:
	$(BUILD_SCRIPT) clr.nativeaotruntime+clr.nativeaotlibs+libs -c $(BUILD_CONFIG) -os $(TARGET_OS) -arch $(TARGET_ARCH)

build-libs-nativeaot:
	$(BUILD_SCRIPT) clr.nativeaotruntime+clr.nativeaotlibs -c $(BUILD_CONFIG) -os $(TARGET_OS) -arch $(TARGET_ARCH)

all: appbuilder hello-app

appbuilder:
	$(DOTNET) build -c $(BUILD_CONFIG) $(TASKS_DIR)/AppleAppBuilder/AppleAppBuilder.csproj

hello-app: clean
	$(DOTNET) \
	build -c $(BUILD_CONFIG) \
	-p:TargetOS=$(TARGET_OS) \
	-p:TargetArchitecture=$(TARGET_ARCH) \
	-p:DeployAndRun=$(DEPLOY_AND_RUN) \
	-p:StripDebugSymbols=$(STRIP_DEBUG_SYMBOLS) \
	-bl
Comment thread
kotlarmilos marked this conversation as resolved.


clean:
	rm -rf obj bin

95 changes: 95 additions & 0 deletions
src/mono/sample/iOS-NativeAOT/Program.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
<Project Sdk="Microsoft.NET.Sdk">
 <PropertyGroup>
 <OutputType>Exe</OutputType>
 <OutputPath>bin</OutputPath>
 <IntermediateOutputPath>$(MSBuildThisFileDirectory)/obj/</IntermediateOutputPath>
 <TargetFramework>$(NetCoreAppCurrent)</TargetFramework>
 <TargetOS Condition="'$(TargetOS)' == ''">ios</TargetOS>
 <TargetOS Condition="'$(TargetsiOSSimulator)' == 'true'">iossimulator</TargetOS>
 <DeployAndRun Condition="'$(DeployAndRun)' == ''">true</DeployAndRun>
 <RuntimeIdentifier>$(TargetOS)-$(TargetArchitecture)</RuntimeIdentifier>
 <AppName>HelloiOS</AppName>
Comment thread
kotlarmilos marked this conversation as resolved.


Outdated

 <StripDebugSymbols Condition="'$(StripDebugSymbols)' == ''">false</StripDebugSymbols>
 <!-- NativeAOT-specific props -->
 <NativeLib>static</NativeLib>
 <CustomNativeMain>true</CustomNativeMain>
 <UseNativeAOTRuntime Condition="'$(UseNativeAOTRuntime)' == ''">true</UseNativeAOTRuntime>
 <!-- FIXME: Once we support building System.Globalization.Native and icu, should be removed -->
 <InvariantGlobalization>true</InvariantGlobalization>
 <!-- FIXME: We do not use publish targets yet, but we need to create a publish directory -->
 <PublishDir Condition="'$(PublishDir)' == ''">$(OutputPath)/publish</PublishDir>
 </PropertyGroup>

 <ItemGroup>
 <Compile Include="..\iOS\Program.cs" Link="Program.cs" />
 <DirectPInvoke Include="__Internal" />
 </ItemGroup>

 <PropertyGroup Condition="'$(TargetOS)' == 'maccatalyst'">
Comment thread
ivanpovazan marked this conversation as resolved.

 <DevTeamProvisioning Condition="'$(DevTeamProvisioning)' == ''">adhoc</DevTeamProvisioning>
 <EnableAppSandbox Condition="'$(EnableAppSandbox)' == ''">false</EnableAppSandbox>
 </PropertyGroup>

 <Import Project="$(CoreClrProjectRoot)nativeaot\BuildIntegration\Microsoft.NETCore.Native.targets" />
 <UsingTask TaskName="AppleAppBuilderTask"
 AssemblyFile="$(AppleAppBuilderTasksAssemblyPath)" />

 <!-- FIXME: Once we set up builing appropriate runtime package for iOS-like platforms the following properties should be removed -->
 <Target Name="ConfigureIlcPathsForiOSCrossCompilation">
 <PropertyGroup>
 <IlcPath>$([MSBuild]::NormalizeDirectory('$(RepoRoot)', 'artifacts', 'bin', 'coreclr', '$(HostOS).$(BuildArchitecture).$(CoreCLRConfiguration)', 'ilc'))</IlcPath>
 <IlcToolsPath>$(IlcPath)</IlcToolsPath>
 <IlcSdkPath>$(CoreCLRAotSdkDir)</IlcSdkPath>
 <IlcFrameworkPath>$(LibrariesAllBinArtifactsPath)</IlcFrameworkPath>
 <IlcFrameworkNativePath>$(LibrariesAllBinArtifactsPath)</IlcFrameworkNativePath>
 </PropertyGroup>
 </Target>

 <Target Name="BuildAppBundle"
 AfterTargets="Build"
 DependsOnTargets="ConfigureIlcPathsForiOSCrossCompilation;SetupProperties;ComputeIlcCompileInputs;IlcCompile">

 <PropertyGroup>
 <AppDir>$(MSBuildThisFileDirectory)$(PublishDir)\app</AppDir>
 <IosSimulator Condition="'$(TargetsiOSSimulator)' == 'true'">iPhone 11</IosSimulator>
 <Optimized Condition="'$(Configuration)' == 'Release'">True</Optimized>
 </PropertyGroup>

 <ItemGroup>
 <NativeLibrary Include="%(ManagedBinary.IlcOutputFile)" />
 </ItemGroup>

 <RemoveDir Directories="$(AppDir)" />

 <AppleAppBuilderTask
 UseNativeAOTRuntime="$(UseNativeAOTRuntime)"
 NativeDependencies="@(NativeLibrary)"
 TargetOS="$(TargetOS)"
 Arch="$(TargetArchitecture)"
 ProjectName="$(AppName)"
 Assemblies="@(BundleAssemblies)"
 GenerateXcodeProject="True"
 BuildAppBundle="True"
 DevTeamProvisioning="$(DevTeamProvisioning)"
 OutputDirectory="$(AppDir)"
 Optimized="$(Optimized)"
 InvariantGlobalization="$(InvariantGlobalization)"
 StripSymbolTable="$(StripDebugSymbols)"
 AppDir="$(MSBuildThisFileDirectory)$(PublishDir)" >
 <Output TaskParameter="AppBundlePath" PropertyName="AppBundlePath" />
 <Output TaskParameter="XcodeProjectPath" PropertyName="XcodeProjectPath" />
 </AppleAppBuilderTask>

 <Message Importance="High" Text="Xcode: $(XcodeProjectPath)"/>
 <Message Importance="High" Text="App: $(AppBundlePath)"/>

 </Target>

 <Target Name="RunAppBundle"
 AfterTargets="BuildAppBundle"
 Condition="'$(DeployAndRun)' == 'true'">
 <Exec Condition="'$(TargetOS)' == 'iossimulator'" Command="dotnet xharness apple run --app=$(AppBundlePath) --targets=ios-simulator-64 --output-directory=/tmp/out" />
 <Exec Condition="'$(TargetOS)' == 'ios'" Command="dotnet xharness apple run --app=$(AppBundlePath) --targets=ios-device --output-directory=/tmp/out" />
 </Target>

</Project>

79 changes: 79 additions & 0 deletions
src/mono/sample/iOS-NativeAOT/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
# NativeAOT iOS sample app
@marek-safarmarek-safarFeb 20, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Why is it under mono folder?
@ivanpovazanivanpovazanFeb 20, 2023•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

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.
@ivanpovazanivanpovazanFeb 20, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

FWIW NativeAOT keeps samples here: https://github.com/dotnet/samples/tree/main/core/nativeaot
@filipnavarafilipnavaraFeb 20, 2023•

edited

Loading

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

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.
@ivanpovazanivanpovazanFeb 21, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

@MichalStrehovsky what do you think?
@MichalStrehovskyMichalStrehovskyFeb 21, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

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.
@ivanpovazanivanpovazanFeb 21, 2023•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

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.
@MichalStrehovskyMichalStrehovskyFeb 21, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

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 :)
@ivanpovazanivanpovazanFeb 21, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

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.
@jkotasjkotasFeb 21, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

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.

## Description

This sample application is intended to be used by developers who work on enabling NativeAOT on iOS-like platforms and can serve as PoC for verifying support for the following systems:
- ios
- iossimulator
- tvos
- tvossimulator
- maccatalyst

The sample shares the source code with the Mono sample specified at: `../iOS/Program.cs` and in general should have the same behavior as MonoAOT.

## Limitations

The application is **_currently_** relying on the following:
1. Internal dependencies - locally building the internals is required as runtime and tools nuget packages are still not being produced
2. Invariant globalization - `System.Globalization.Native` is currently not being built as part of NativeAOT framework for iOS-like platforms
3. No publish targets - the SDK and MSBuild integration is still not complete

## How to build and test

### Building for the first time

When building for the first time (on a clean checkout) run from this directory the following `make` command:
``` bash
make world
```
This will first build all required runtime components and dependencies, after which it will build the sample app and bundle it into an application bundle.
By default the build will use `Debug` build configuration and target `iossimulator`.
To change this behavior, specify the desired setting in the following way:
``` bash
make world BUILD_CONFIG=Release TARGET_OS=ios
```

### To avoid building all the dependencies

For future builds, you can run just:
``` bash
make
```
which will skip building all the runtime dependencies, assuming those have been already properly built, and build the MSBuild task used for bundling the application and the application it self.

For convenience, it is also possible to rebuild only the application it self with:
``` bash
make hello-app
```

### Deploy and run

#### Simulator

To test the application on a simulator include the following in your make command `DEPLOY_AND_RUN=true` e.g.,:
``` bash
make hello-app DEPLOY_AND_RUN=true
```

#### Device

To test the application on a device, a provisioning profile needs to be specified.
This can be achieved by defining `DevTeamProvisioning` environment variable with a valid team ID (see [developer.apple.com/account/#/membership](https://developer.apple.com/account/#/membership), scroll down to `Team ID`) for example:
``` bash
export DevTeamProvisioning=A1B2C3D4E5; make hello-app TARGET_OS=ios DEPLOY_AND_RUN=true
```
Assuming `A1B2C3D4E5` is a valid team ID.

#### One-liner

On a clean dotnet/runtime checkout, from this directory, run:

``` bash
export DevTeamProvisioning=A1B2C3D4E5; make world BUILD_CONFIG=Release TARGET_OS=ios DEPLOY_AND_RUN=true
```

This command will build everything necessary to run and deploy the application on an iOS device.

### Custom builds

Check the `Makefile` for individual list of targets and variables to customize the build.

2 changes: 1 addition & 1 deletion
src/mono/sample/iOS/Program.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,7 @@ public static async Task Main(string[] args)
 delegate* unmanaged<void> unmanagedPtr = &OnButtonClick;
 ios_register_button_click(unmanagedPtr);
 }
 const string msg = "Hello World!\n.NET 5.0";
 const string msg = "Hello World!\n.NET 8.0";
 for (int i = 0; i < msg.Length; i++)
 {
 // a kind of an animation
Expand Down

10 changes: 10 additions & 0 deletions
src/tasks/AppleAppBuilder/AppleAppBuilder.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -171,6 +171,11 @@ public string TargetOS
 /// </summary>
 public bool UseNativeAOTRuntime { get; set; }

 /// <summary>
 /// Extra native dependencies to link into the app
 /// </summary>
 public string[] NativeDependencies { get; set; } = Array.Empty<string>();

 public void ValidateRuntimeSelection()
 {
 if (UseNativeAOTRuntime)
Expand DownExpand Up@@ -267,6 +272,11 @@ public override bool Execute()
 }
 }

 foreach (var nativeDependency in NativeDependencies)
 {
 assemblerFilesToLink.Add(nativeDependency);
 }

 if (!ForceInterpreter && (isDevice || ForceAOT) && (assemblerFiles.Count == 0 && !UseNativeAOTRuntime))
 {
 throw new InvalidOperationException("Need list of AOT files for device builds.");
Expand Down

11 changes: 10 additions & 1 deletion
src/tasks/AppleAppBuilder/Templates/CMakeLists.txt.template

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,8 @@ add_executable(
 %ProjectName%
 %MainSource%
 ${APP_RESOURCES}
 util.h
 util.m
)

if(NOT %UseNativeAOTRuntime%)
Expand DownExpand Up@@ -73,5 +75,12 @@ target_link_libraries(
 "-lz"
 "-lc++"
 "-liconv"
%NativeLibrariesToLink%
%NativeLibrariesToLink%
)

if(%UseNativeAOTRuntime%)
target_link_libraries(
 %ProjectName%
 "-Wl,-u,_NativeAOT_StaticInitialization"
)
endif()

11 changes: 8 additions & 3 deletions
src/tasks/AppleAppBuilder/Templates/main-simple.m

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,8 @@
#if !USE_NATIVE_AOT
#import "runtime.h"
#else
extern void* NativeAOT_StaticInitialization();
#import <os/log.h>
#import "util.h"
extern int __managed__Main(int argc, char* argv[]);
#endif

Expand DownExpand Up@@ -57,8 +58,12 @@ - (void)viewDidLoad {
#if INVARIANT_GLOBALIZATION
 setenv ("DOTNET_SYSTEM_GLOBALIZATION_INVARIANT", "1", TRUE);
#endif
 NativeAOT_StaticInitialization();
 int ret_val = __managed__Main(0, NULL);
 char **managed_argv;
 int managed_argc = get_managed_args (&managed_argv);
 int ret_val = __managed__Main (managed_argc, managed_argv);
 free_managed_args (&managed_argv, managed_argc);
Comment thread
akoeplinger marked this conversation as resolved.

 os_log_info (OS_LOG_DEFAULT, EXIT_CODE_TAG ": %d", ret_val);
 exit (ret_val);
#endif
 });
}
Expand Down

17 changes: 6 additions & 11 deletions
src/tasks/AppleAppBuilder/Templates/runtime.m

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,15 +20,14 @@
#include <stdlib.h>
#include <stdio.h>

#import "util.h"

static char *bundle_path;

#define APPLE_RUNTIME_IDENTIFIER "//%APPLE_RUNTIME_IDENTIFIER%"

#define RUNTIMECONFIG_BIN_FILE "runtimeconfig.bin"

// XHarness is looking for this tag in app's output to determine the exit code
#define EXIT_CODE_TAG "DOTNET.APP_EXIT_CODE"

const char *
get_bundle_path (void)
{
Expand DownExpand Up@@ -254,14 +253,8 @@
 setenv ("DOTNET_DiagnosticPorts", DIAGNOSTIC_PORTS, true);
#endif

 id args_array = [[NSProcessInfo processInfo] arguments];
 assert ([args_array count] <= 128);
 const char *managed_argv [128];
 int argi;
 for (argi = 0; argi < [args_array count]; argi++) {
 NSString* arg = [args_array objectAtIndex: argi];
 managed_argv[argi] = [arg UTF8String];
 }
 char **managed_argv;
 int argi = get_managed_args (&managed_argv);

 bool wait_for_debugger = FALSE;

Expand DownExpand Up@@ -373,5 +366,7 @@

 mono_jit_cleanup (domain);

 free_managed_args (&managed_argv, argi);

 exit (res);
}

13 changes: 13 additions & 0 deletions
src/tasks/AppleAppBuilder/Templates/util.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

#ifndef util_h
#define util_h

// XHarness is looking for this tag in app's output to determine the exit code
#define EXIT_CODE_TAG "DOTNET.APP_EXIT_CODE"

size_t get_managed_args (char*** managed_args_array);
void free_managed_args (char*** managed_args_array, size_t array_size);

#endif /* util_h */
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Adding HelloiOS sample for NativeAOT#82249

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

 Merged

ivanpovazan
merged 10 commits into

from

Feb 24, 2023
 Merged


Adding HelloiOS sample for NativeAOT
#82249
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
e0b8ca3

Integrate AppleAppBuilder with NativeAOT runtime


ivanpovazan Feb 16, 2023
53baa49

Add HelloiOS sample variant for NativeAOT


ivanpovazan Feb 16, 2023
433f8df

Adding a README.md


ivanpovazan Feb 16, 2023
ba174d2

Bump the version displayed on the screen when running HelloiOS app


ivanpovazan Feb 16, 2023
65b08e3

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


ivanpovazan Feb 17, 2023
c09b462

Use NativeDependencies property instead to align with AndroidAppBuild…


ivanpovazan Feb 17, 2023
b369a36

Adding fixes according to review feedback


ivanpovazan Feb 21, 2023
b621221

Adding fixes according to review feedback


ivanpovazan Feb 23, 2023
d42f3e3

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


ivanpovazan Feb 24, 2023
d69ba2e

Markdown cleanup


ivanpovazan Feb 24, 2023

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


50 changes: 50 additions & 0 deletions
src/mono/sample/iOS-NativeAOT/Makefile

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
.DEFAULT_GOAL := all

TOP=../../../../

BUILD_CONFIG?=Debug
TARGET_ARCH?=$(shell . $(TOP)eng/native/init-os-and-arch.sh && echo $${arch})
TARGET_OS?=iossimulator
DEPLOY_AND_RUN?=false
STRIP_DEBUG_SYMBOLS?=false

REPO_DIR=$(realpath $(TOP))
TASKS_DIR=$(REPO_DIR)/src/tasks
DOTNET=$(REPO_DIR)/dotnet.sh
BUILD_SCRIPT=$(REPO_DIR)/build.sh

world: build-deps all

# build all dependencies: runtime, nativeAot and all the libs
build-deps: build-runtime-ilc build-libs-all

# building for host
build-runtime-ilc:
	$(BUILD_SCRIPT) clr+clr.aot -c $(BUILD_CONFIG)

build-ilc:
Comment thread
kotlarmilos marked this conversation as resolved.


Outdated

	$(BUILD_SCRIPT) clr.aot -c $(BUILD_CONFIG)

# building for target platform
build-libs-all:
	$(BUILD_SCRIPT) clr.nativeaotruntime+clr.nativeaotlibs+libs -c $(BUILD_CONFIG) -os $(TARGET_OS) -arch $(TARGET_ARCH)

build-libs-nativeaot:
	$(BUILD_SCRIPT) clr.nativeaotruntime+clr.nativeaotlibs -c $(BUILD_CONFIG) -os $(TARGET_OS) -arch $(TARGET_ARCH)

all: appbuilder hello-app

appbuilder:
	$(DOTNET) build -c $(BUILD_CONFIG) $(TASKS_DIR)/AppleAppBuilder/AppleAppBuilder.csproj

hello-app: clean
	$(DOTNET) \
	build -c $(BUILD_CONFIG) \
	-p:TargetOS=$(TARGET_OS) \
	-p:TargetArchitecture=$(TARGET_ARCH) \
	-p:DeployAndRun=$(DEPLOY_AND_RUN) \
	-p:StripDebugSymbols=$(STRIP_DEBUG_SYMBOLS) \
	-bl
Comment thread
kotlarmilos marked this conversation as resolved.


clean:
	rm -rf obj bin

95 changes: 95 additions & 0 deletions
src/mono/sample/iOS-NativeAOT/Program.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
<Project Sdk="Microsoft.NET.Sdk">
 <PropertyGroup>
 <OutputType>Exe</OutputType>
 <OutputPath>bin</OutputPath>
 <IntermediateOutputPath>$(MSBuildThisFileDirectory)/obj/</IntermediateOutputPath>
 <TargetFramework>$(NetCoreAppCurrent)</TargetFramework>
 <TargetOS Condition="'$(TargetOS)' == ''">ios</TargetOS>
 <TargetOS Condition="'$(TargetsiOSSimulator)' == 'true'">iossimulator</TargetOS>
 <DeployAndRun Condition="'$(DeployAndRun)' == ''">true</DeployAndRun>
 <RuntimeIdentifier>$(TargetOS)-$(TargetArchitecture)</RuntimeIdentifier>
 <AppName>HelloiOS</AppName>
Comment thread
kotlarmilos marked this conversation as resolved.


Outdated

 <StripDebugSymbols Condition="'$(StripDebugSymbols)' == ''">false</StripDebugSymbols>
 <!-- NativeAOT-specific props -->
 <NativeLib>static</NativeLib>
 <CustomNativeMain>true</CustomNativeMain>
 <UseNativeAOTRuntime Condition="'$(UseNativeAOTRuntime)' == ''">true</UseNativeAOTRuntime>
 <!-- FIXME: Once we support building System.Globalization.Native and icu, should be removed -->
 <InvariantGlobalization>true</InvariantGlobalization>
 <!-- FIXME: We do not use publish targets yet, but we need to create a publish directory -->
 <PublishDir Condition="'$(PublishDir)' == ''">$(OutputPath)/publish</PublishDir>
 </PropertyGroup>

 <ItemGroup>
 <Compile Include="..\iOS\Program.cs" Link="Program.cs" />
 <DirectPInvoke Include="__Internal" />
 </ItemGroup>

 <PropertyGroup Condition="'$(TargetOS)' == 'maccatalyst'">
Comment thread
ivanpovazan marked this conversation as resolved.

 <DevTeamProvisioning Condition="'$(DevTeamProvisioning)' == ''">adhoc</DevTeamProvisioning>
 <EnableAppSandbox Condition="'$(EnableAppSandbox)' == ''">false</EnableAppSandbox>
 </PropertyGroup>

 <Import Project="$(CoreClrProjectRoot)nativeaot\BuildIntegration\Microsoft.NETCore.Native.targets" />
 <UsingTask TaskName="AppleAppBuilderTask"
 AssemblyFile="$(AppleAppBuilderTasksAssemblyPath)" />

 <!-- FIXME: Once we set up builing appropriate runtime package for iOS-like platforms the following properties should be removed -->
 <Target Name="ConfigureIlcPathsForiOSCrossCompilation">
 <PropertyGroup>
 <IlcPath>$([MSBuild]::NormalizeDirectory('$(RepoRoot)', 'artifacts', 'bin', 'coreclr', '$(HostOS).$(BuildArchitecture).$(CoreCLRConfiguration)', 'ilc'))</IlcPath>
 <IlcToolsPath>$(IlcPath)</IlcToolsPath>
 <IlcSdkPath>$(CoreCLRAotSdkDir)</IlcSdkPath>
 <IlcFrameworkPath>$(LibrariesAllBinArtifactsPath)</IlcFrameworkPath>
 <IlcFrameworkNativePath>$(LibrariesAllBinArtifactsPath)</IlcFrameworkNativePath>
 </PropertyGroup>
 </Target>

 <Target Name="BuildAppBundle"
 AfterTargets="Build"
 DependsOnTargets="ConfigureIlcPathsForiOSCrossCompilation;SetupProperties;ComputeIlcCompileInputs;IlcCompile">

 <PropertyGroup>
 <AppDir>$(MSBuildThisFileDirectory)$(PublishDir)\app</AppDir>
 <IosSimulator Condition="'$(TargetsiOSSimulator)' == 'true'">iPhone 11</IosSimulator>
 <Optimized Condition="'$(Configuration)' == 'Release'">True</Optimized>
 </PropertyGroup>

 <ItemGroup>
 <NativeLibrary Include="%(ManagedBinary.IlcOutputFile)" />
 </ItemGroup>

 <RemoveDir Directories="$(AppDir)" />

 <AppleAppBuilderTask
 UseNativeAOTRuntime="$(UseNativeAOTRuntime)"
 NativeDependencies="@(NativeLibrary)"
 TargetOS="$(TargetOS)"
 Arch="$(TargetArchitecture)"
 ProjectName="$(AppName)"
 Assemblies="@(BundleAssemblies)"
 GenerateXcodeProject="True"
 BuildAppBundle="True"
 DevTeamProvisioning="$(DevTeamProvisioning)"
 OutputDirectory="$(AppDir)"
 Optimized="$(Optimized)"
 InvariantGlobalization="$(InvariantGlobalization)"
 StripSymbolTable="$(StripDebugSymbols)"
 AppDir="$(MSBuildThisFileDirectory)$(PublishDir)" >
 <Output TaskParameter="AppBundlePath" PropertyName="AppBundlePath" />
 <Output TaskParameter="XcodeProjectPath" PropertyName="XcodeProjectPath" />
 </AppleAppBuilderTask>

 <Message Importance="High" Text="Xcode: $(XcodeProjectPath)"/>
 <Message Importance="High" Text="App: $(AppBundlePath)"/>

 </Target>

 <Target Name="RunAppBundle"
 AfterTargets="BuildAppBundle"
 Condition="'$(DeployAndRun)' == 'true'">
 <Exec Condition="'$(TargetOS)' == 'iossimulator'" Command="dotnet xharness apple run --app=$(AppBundlePath) --targets=ios-simulator-64 --output-directory=/tmp/out" />
 <Exec Condition="'$(TargetOS)' == 'ios'" Command="dotnet xharness apple run --app=$(AppBundlePath) --targets=ios-device --output-directory=/tmp/out" />
 </Target>

</Project>

79 changes: 79 additions & 0 deletions
src/mono/sample/iOS-NativeAOT/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
# NativeAOT iOS sample app
@marek-safarmarek-safarFeb 20, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Why is it under mono folder?
@ivanpovazanivanpovazanFeb 20, 2023•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

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.
@ivanpovazanivanpovazanFeb 20, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

FWIW NativeAOT keeps samples here: https://github.com/dotnet/samples/tree/main/core/nativeaot
@filipnavarafilipnavaraFeb 20, 2023•

edited

Loading

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

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.
@ivanpovazanivanpovazanFeb 21, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

@MichalStrehovsky what do you think?
@MichalStrehovskyMichalStrehovskyFeb 21, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

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.
@ivanpovazanivanpovazanFeb 21, 2023•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

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.
@MichalStrehovskyMichalStrehovskyFeb 21, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

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 :)
@ivanpovazanivanpovazanFeb 21, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

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.
@jkotasjkotasFeb 21, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

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.

## Description

This sample application is intended to be used by developers who work on enabling NativeAOT on iOS-like platforms and can serve as PoC for verifying support for the following systems:
- ios
- iossimulator
- tvos
- tvossimulator
- maccatalyst

The sample shares the source code with the Mono sample specified at: `../iOS/Program.cs` and in general should have the same behavior as MonoAOT.

## Limitations

The application is **_currently_** relying on the following:
1. Internal dependencies - locally building the internals is required as runtime and tools nuget packages are still not being produced
2. Invariant globalization - `System.Globalization.Native` is currently not being built as part of NativeAOT framework for iOS-like platforms
3. No publish targets - the SDK and MSBuild integration is still not complete

## How to build and test

### Building for the first time

When building for the first time (on a clean checkout) run from this directory the following `make` command:
``` bash
make world
```
This will first build all required runtime components and dependencies, after which it will build the sample app and bundle it into an application bundle.
By default the build will use `Debug` build configuration and target `iossimulator`.
To change this behavior, specify the desired setting in the following way:
``` bash
make world BUILD_CONFIG=Release TARGET_OS=ios
```

### To avoid building all the dependencies

For future builds, you can run just:
``` bash
make
```
which will skip building all the runtime dependencies, assuming those have been already properly built, and build the MSBuild task used for bundling the application and the application it self.

For convenience, it is also possible to rebuild only the application it self with:
``` bash
make hello-app
```

### Deploy and run

#### Simulator

To test the application on a simulator include the following in your make command `DEPLOY_AND_RUN=true` e.g.,:
``` bash
make hello-app DEPLOY_AND_RUN=true
```

#### Device

To test the application on a device, a provisioning profile needs to be specified.
This can be achieved by defining `DevTeamProvisioning` environment variable with a valid team ID (see [developer.apple.com/account/#/membership](https://developer.apple.com/account/#/membership), scroll down to `Team ID`) for example:
``` bash
export DevTeamProvisioning=A1B2C3D4E5; make hello-app TARGET_OS=ios DEPLOY_AND_RUN=true
```
Assuming `A1B2C3D4E5` is a valid team ID.

#### One-liner

On a clean dotnet/runtime checkout, from this directory, run:

``` bash
export DevTeamProvisioning=A1B2C3D4E5; make world BUILD_CONFIG=Release TARGET_OS=ios DEPLOY_AND_RUN=true
```

This command will build everything necessary to run and deploy the application on an iOS device.

### Custom builds

Check the `Makefile` for individual list of targets and variables to customize the build.

2 changes: 1 addition & 1 deletion
src/mono/sample/iOS/Program.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,7 @@ public static async Task Main(string[] args)
 delegate* unmanaged<void> unmanagedPtr = &OnButtonClick;
 ios_register_button_click(unmanagedPtr);
 }
 const string msg = "Hello World!\n.NET 5.0";
 const string msg = "Hello World!\n.NET 8.0";
 for (int i = 0; i < msg.Length; i++)
 {
 // a kind of an animation
Expand Down

10 changes: 10 additions & 0 deletions
src/tasks/AppleAppBuilder/AppleAppBuilder.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -171,6 +171,11 @@ public string TargetOS
 /// </summary>
 public bool UseNativeAOTRuntime { get; set; }

 /// <summary>
 /// Extra native dependencies to link into the app
 /// </summary>
 public string[] NativeDependencies { get; set; } = Array.Empty<string>();

 public void ValidateRuntimeSelection()
 {
 if (UseNativeAOTRuntime)
Expand DownExpand Up@@ -267,6 +272,11 @@ public override bool Execute()
 }
 }

 foreach (var nativeDependency in NativeDependencies)
 {
 assemblerFilesToLink.Add(nativeDependency);
 }

 if (!ForceInterpreter && (isDevice || ForceAOT) && (assemblerFiles.Count == 0 && !UseNativeAOTRuntime))
 {
 throw new InvalidOperationException("Need list of AOT files for device builds.");
Expand Down

11 changes: 10 additions & 1 deletion
src/tasks/AppleAppBuilder/Templates/CMakeLists.txt.template

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,8 @@ add_executable(
 %ProjectName%
 %MainSource%
 ${APP_RESOURCES}
 util.h
 util.m
)

if(NOT %UseNativeAOTRuntime%)
Expand DownExpand Up@@ -73,5 +75,12 @@ target_link_libraries(
 "-lz"
 "-lc++"
 "-liconv"
%NativeLibrariesToLink%
%NativeLibrariesToLink%
)

if(%UseNativeAOTRuntime%)
target_link_libraries(
 %ProjectName%
 "-Wl,-u,_NativeAOT_StaticInitialization"
)
endif()

11 changes: 8 additions & 3 deletions
src/tasks/AppleAppBuilder/Templates/main-simple.m

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,8 @@
#if !USE_NATIVE_AOT
#import "runtime.h"
#else
extern void* NativeAOT_StaticInitialization();
#import <os/log.h>
#import "util.h"
extern int __managed__Main(int argc, char* argv[]);
#endif

Expand DownExpand Up@@ -57,8 +58,12 @@ - (void)viewDidLoad {
#if INVARIANT_GLOBALIZATION
 setenv ("DOTNET_SYSTEM_GLOBALIZATION_INVARIANT", "1", TRUE);
#endif
 NativeAOT_StaticInitialization();
 int ret_val = __managed__Main(0, NULL);
 char **managed_argv;
 int managed_argc = get_managed_args (&managed_argv);
 int ret_val = __managed__Main (managed_argc, managed_argv);
 free_managed_args (&managed_argv, managed_argc);
Comment thread
akoeplinger marked this conversation as resolved.

 os_log_info (OS_LOG_DEFAULT, EXIT_CODE_TAG ": %d", ret_val);
 exit (ret_val);
#endif
 });
}
Expand Down

17 changes: 6 additions & 11 deletions
src/tasks/AppleAppBuilder/Templates/runtime.m

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,15 +20,14 @@
#include <stdlib.h>
#include <stdio.h>

#import "util.h"

static char *bundle_path;

#define APPLE_RUNTIME_IDENTIFIER "//%APPLE_RUNTIME_IDENTIFIER%"

#define RUNTIMECONFIG_BIN_FILE "runtimeconfig.bin"

// XHarness is looking for this tag in app's output to determine the exit code
#define EXIT_CODE_TAG "DOTNET.APP_EXIT_CODE"

const char *
get_bundle_path (void)
{
Expand DownExpand Up@@ -254,14 +253,8 @@
 setenv ("DOTNET_DiagnosticPorts", DIAGNOSTIC_PORTS, true);
#endif

 id args_array = [[NSProcessInfo processInfo] arguments];
 assert ([args_array count] <= 128);
 const char *managed_argv [128];
 int argi;
 for (argi = 0; argi < [args_array count]; argi++) {
 NSString* arg = [args_array objectAtIndex: argi];
 managed_argv[argi] = [arg UTF8String];
 }
 char **managed_argv;
 int argi = get_managed_args (&managed_argv);

 bool wait_for_debugger = FALSE;

Expand DownExpand Up@@ -373,5 +366,7 @@

 mono_jit_cleanup (domain);

 free_managed_args (&managed_argv, argi);

 exit (res);
}

13 changes: 13 additions & 0 deletions
src/tasks/AppleAppBuilder/Templates/util.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

#ifndef util_h
#define util_h

// XHarness is looking for this tag in app's output to determine the exit code
#define EXIT_CODE_TAG "DOTNET.APP_EXIT_CODE"

size_t get_managed_args (char*** managed_args_array);
void free_managed_args (char*** managed_args_array, size_t array_size);

#endif /* util_h */
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Adding HelloiOS sample for NativeAOT#82249

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

 Merged

ivanpovazan
merged 10 commits into

from

Feb 24, 2023
 Merged


Adding HelloiOS sample for NativeAOT
#82249
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
e0b8ca3

Integrate AppleAppBuilder with NativeAOT runtime


ivanpovazan Feb 16, 2023
53baa49

Add HelloiOS sample variant for NativeAOT


ivanpovazan Feb 16, 2023
433f8df

Adding a README.md


ivanpovazan Feb 16, 2023
ba174d2

Bump the version displayed on the screen when running HelloiOS app


ivanpovazan Feb 16, 2023
65b08e3

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


ivanpovazan Feb 17, 2023
c09b462

Use NativeDependencies property instead to align with AndroidAppBuild…


ivanpovazan Feb 17, 2023
b369a36

Adding fixes according to review feedback


ivanpovazan Feb 21, 2023
b621221

Adding fixes according to review feedback


ivanpovazan Feb 23, 2023
d42f3e3

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


ivanpovazan Feb 24, 2023
d69ba2e

Markdown cleanup


ivanpovazan Feb 24, 2023

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


50 changes: 50 additions & 0 deletions
src/mono/sample/iOS-NativeAOT/Makefile

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
.DEFAULT_GOAL := all

TOP=../../../../

BUILD_CONFIG?=Debug
TARGET_ARCH?=$(shell . $(TOP)eng/native/init-os-and-arch.sh && echo $${arch})
TARGET_OS?=iossimulator
DEPLOY_AND_RUN?=false
STRIP_DEBUG_SYMBOLS?=false

REPO_DIR=$(realpath $(TOP))
TASKS_DIR=$(REPO_DIR)/src/tasks
DOTNET=$(REPO_DIR)/dotnet.sh
BUILD_SCRIPT=$(REPO_DIR)/build.sh

world: build-deps all

# build all dependencies: runtime, nativeAot and all the libs
build-deps: build-runtime-ilc build-libs-all

# building for host
build-runtime-ilc:
	$(BUILD_SCRIPT) clr+clr.aot -c $(BUILD_CONFIG)

build-ilc:
Comment thread
kotlarmilos marked this conversation as resolved.


Outdated

	$(BUILD_SCRIPT) clr.aot -c $(BUILD_CONFIG)

# building for target platform
build-libs-all:
	$(BUILD_SCRIPT) clr.nativeaotruntime+clr.nativeaotlibs+libs -c $(BUILD_CONFIG) -os $(TARGET_OS) -arch $(TARGET_ARCH)

build-libs-nativeaot:
	$(BUILD_SCRIPT) clr.nativeaotruntime+clr.nativeaotlibs -c $(BUILD_CONFIG) -os $(TARGET_OS) -arch $(TARGET_ARCH)

all: appbuilder hello-app

appbuilder:
	$(DOTNET) build -c $(BUILD_CONFIG) $(TASKS_DIR)/AppleAppBuilder/AppleAppBuilder.csproj

hello-app: clean
	$(DOTNET) \
	build -c $(BUILD_CONFIG) \
	-p:TargetOS=$(TARGET_OS) \
	-p:TargetArchitecture=$(TARGET_ARCH) \
	-p:DeployAndRun=$(DEPLOY_AND_RUN) \
	-p:StripDebugSymbols=$(STRIP_DEBUG_SYMBOLS) \
	-bl
Comment thread
kotlarmilos marked this conversation as resolved.


clean:
	rm -rf obj bin

95 changes: 95 additions & 0 deletions
src/mono/sample/iOS-NativeAOT/Program.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
<Project Sdk="Microsoft.NET.Sdk">
 <PropertyGroup>
 <OutputType>Exe</OutputType>
 <OutputPath>bin</OutputPath>
 <IntermediateOutputPath>$(MSBuildThisFileDirectory)/obj/</IntermediateOutputPath>
 <TargetFramework>$(NetCoreAppCurrent)</TargetFramework>
 <TargetOS Condition="'$(TargetOS)' == ''">ios</TargetOS>
 <TargetOS Condition="'$(TargetsiOSSimulator)' == 'true'">iossimulator</TargetOS>
 <DeployAndRun Condition="'$(DeployAndRun)' == ''">true</DeployAndRun>
 <RuntimeIdentifier>$(TargetOS)-$(TargetArchitecture)</RuntimeIdentifier>
 <AppName>HelloiOS</AppName>
Comment thread
kotlarmilos marked this conversation as resolved.


Outdated

 <StripDebugSymbols Condition="'$(StripDebugSymbols)' == ''">false</StripDebugSymbols>
 <!-- NativeAOT-specific props -->
 <NativeLib>static</NativeLib>
 <CustomNativeMain>true</CustomNativeMain>
 <UseNativeAOTRuntime Condition="'$(UseNativeAOTRuntime)' == ''">true</UseNativeAOTRuntime>
 <!-- FIXME: Once we support building System.Globalization.Native and icu, should be removed -->
 <InvariantGlobalization>true</InvariantGlobalization>
 <!-- FIXME: We do not use publish targets yet, but we need to create a publish directory -->
 <PublishDir Condition="'$(PublishDir)' == ''">$(OutputPath)/publish</PublishDir>
 </PropertyGroup>

 <ItemGroup>
 <Compile Include="..\iOS\Program.cs" Link="Program.cs" />
 <DirectPInvoke Include="__Internal" />
 </ItemGroup>

 <PropertyGroup Condition="'$(TargetOS)' == 'maccatalyst'">
Comment thread
ivanpovazan marked this conversation as resolved.

 <DevTeamProvisioning Condition="'$(DevTeamProvisioning)' == ''">adhoc</DevTeamProvisioning>
 <EnableAppSandbox Condition="'$(EnableAppSandbox)' == ''">false</EnableAppSandbox>
 </PropertyGroup>

 <Import Project="$(CoreClrProjectRoot)nativeaot\BuildIntegration\Microsoft.NETCore.Native.targets" />
 <UsingTask TaskName="AppleAppBuilderTask"
 AssemblyFile="$(AppleAppBuilderTasksAssemblyPath)" />

 <!-- FIXME: Once we set up builing appropriate runtime package for iOS-like platforms the following properties should be removed -->
 <Target Name="ConfigureIlcPathsForiOSCrossCompilation">
 <PropertyGroup>
 <IlcPath>$([MSBuild]::NormalizeDirectory('$(RepoRoot)', 'artifacts', 'bin', 'coreclr', '$(HostOS).$(BuildArchitecture).$(CoreCLRConfiguration)', 'ilc'))</IlcPath>
 <IlcToolsPath>$(IlcPath)</IlcToolsPath>
 <IlcSdkPath>$(CoreCLRAotSdkDir)</IlcSdkPath>
 <IlcFrameworkPath>$(LibrariesAllBinArtifactsPath)</IlcFrameworkPath>
 <IlcFrameworkNativePath>$(LibrariesAllBinArtifactsPath)</IlcFrameworkNativePath>
 </PropertyGroup>
 </Target>

 <Target Name="BuildAppBundle"
 AfterTargets="Build"
 DependsOnTargets="ConfigureIlcPathsForiOSCrossCompilation;SetupProperties;ComputeIlcCompileInputs;IlcCompile">

 <PropertyGroup>
 <AppDir>$(MSBuildThisFileDirectory)$(PublishDir)\app</AppDir>
 <IosSimulator Condition="'$(TargetsiOSSimulator)' == 'true'">iPhone 11</IosSimulator>
 <Optimized Condition="'$(Configuration)' == 'Release'">True</Optimized>
 </PropertyGroup>

 <ItemGroup>
 <NativeLibrary Include="%(ManagedBinary.IlcOutputFile)" />
 </ItemGroup>

 <RemoveDir Directories="$(AppDir)" />

 <AppleAppBuilderTask
 UseNativeAOTRuntime="$(UseNativeAOTRuntime)"
 NativeDependencies="@(NativeLibrary)"
 TargetOS="$(TargetOS)"
 Arch="$(TargetArchitecture)"
 ProjectName="$(AppName)"
 Assemblies="@(BundleAssemblies)"
 GenerateXcodeProject="True"
 BuildAppBundle="True"
 DevTeamProvisioning="$(DevTeamProvisioning)"
 OutputDirectory="$(AppDir)"
 Optimized="$(Optimized)"
 InvariantGlobalization="$(InvariantGlobalization)"
 StripSymbolTable="$(StripDebugSymbols)"
 AppDir="$(MSBuildThisFileDirectory)$(PublishDir)" >
 <Output TaskParameter="AppBundlePath" PropertyName="AppBundlePath" />
 <Output TaskParameter="XcodeProjectPath" PropertyName="XcodeProjectPath" />
 </AppleAppBuilderTask>

 <Message Importance="High" Text="Xcode: $(XcodeProjectPath)"/>
 <Message Importance="High" Text="App: $(AppBundlePath)"/>

 </Target>

 <Target Name="RunAppBundle"
 AfterTargets="BuildAppBundle"
 Condition="'$(DeployAndRun)' == 'true'">
 <Exec Condition="'$(TargetOS)' == 'iossimulator'" Command="dotnet xharness apple run --app=$(AppBundlePath) --targets=ios-simulator-64 --output-directory=/tmp/out" />
 <Exec Condition="'$(TargetOS)' == 'ios'" Command="dotnet xharness apple run --app=$(AppBundlePath) --targets=ios-device --output-directory=/tmp/out" />
 </Target>

</Project>

79 changes: 79 additions & 0 deletions
src/mono/sample/iOS-NativeAOT/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
# NativeAOT iOS sample app
@marek-safarmarek-safarFeb 20, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Why is it under mono folder?
@ivanpovazanivanpovazanFeb 20, 2023•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

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.
@ivanpovazanivanpovazanFeb 20, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

FWIW NativeAOT keeps samples here: https://github.com/dotnet/samples/tree/main/core/nativeaot
@filipnavarafilipnavaraFeb 20, 2023•

edited

Loading

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

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.
@ivanpovazanivanpovazanFeb 21, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

@MichalStrehovsky what do you think?
@MichalStrehovskyMichalStrehovskyFeb 21, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

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.
@ivanpovazanivanpovazanFeb 21, 2023•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

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.
@MichalStrehovskyMichalStrehovskyFeb 21, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

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 :)
@ivanpovazanivanpovazanFeb 21, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

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.
@jkotasjkotasFeb 21, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

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.

## Description

This sample application is intended to be used by developers who work on enabling NativeAOT on iOS-like platforms and can serve as PoC for verifying support for the following systems:
- ios
- iossimulator
- tvos
- tvossimulator
- maccatalyst

The sample shares the source code with the Mono sample specified at: `../iOS/Program.cs` and in general should have the same behavior as MonoAOT.

## Limitations

The application is **_currently_** relying on the following:
1. Internal dependencies - locally building the internals is required as runtime and tools nuget packages are still not being produced
2. Invariant globalization - `System.Globalization.Native` is currently not being built as part of NativeAOT framework for iOS-like platforms
3. No publish targets - the SDK and MSBuild integration is still not complete

## How to build and test

### Building for the first time

When building for the first time (on a clean checkout) run from this directory the following `make` command:
``` bash
make world
```
This will first build all required runtime components and dependencies, after which it will build the sample app and bundle it into an application bundle.
By default the build will use `Debug` build configuration and target `iossimulator`.
To change this behavior, specify the desired setting in the following way:
``` bash
make world BUILD_CONFIG=Release TARGET_OS=ios
```

### To avoid building all the dependencies

For future builds, you can run just:
``` bash
make
```
which will skip building all the runtime dependencies, assuming those have been already properly built, and build the MSBuild task used for bundling the application and the application it self.

For convenience, it is also possible to rebuild only the application it self with:
``` bash
make hello-app
```

### Deploy and run

#### Simulator

To test the application on a simulator include the following in your make command `DEPLOY_AND_RUN=true` e.g.,:
``` bash
make hello-app DEPLOY_AND_RUN=true
```

#### Device

To test the application on a device, a provisioning profile needs to be specified.
This can be achieved by defining `DevTeamProvisioning` environment variable with a valid team ID (see [developer.apple.com/account/#/membership](https://developer.apple.com/account/#/membership), scroll down to `Team ID`) for example:
``` bash
export DevTeamProvisioning=A1B2C3D4E5; make hello-app TARGET_OS=ios DEPLOY_AND_RUN=true
```
Assuming `A1B2C3D4E5` is a valid team ID.

#### One-liner

On a clean dotnet/runtime checkout, from this directory, run:

``` bash
export DevTeamProvisioning=A1B2C3D4E5; make world BUILD_CONFIG=Release TARGET_OS=ios DEPLOY_AND_RUN=true
```

This command will build everything necessary to run and deploy the application on an iOS device.

### Custom builds

Check the `Makefile` for individual list of targets and variables to customize the build.

2 changes: 1 addition & 1 deletion
src/mono/sample/iOS/Program.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,7 @@ public static async Task Main(string[] args)
 delegate* unmanaged<void> unmanagedPtr = &OnButtonClick;
 ios_register_button_click(unmanagedPtr);
 }
 const string msg = "Hello World!\n.NET 5.0";
 const string msg = "Hello World!\n.NET 8.0";
 for (int i = 0; i < msg.Length; i++)
 {
 // a kind of an animation
Expand Down

10 changes: 10 additions & 0 deletions
src/tasks/AppleAppBuilder/AppleAppBuilder.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -171,6 +171,11 @@ public string TargetOS
 /// </summary>
 public bool UseNativeAOTRuntime { get; set; }

 /// <summary>
 /// Extra native dependencies to link into the app
 /// </summary>
 public string[] NativeDependencies { get; set; } = Array.Empty<string>();

 public void ValidateRuntimeSelection()
 {
 if (UseNativeAOTRuntime)
Expand DownExpand Up@@ -267,6 +272,11 @@ public override bool Execute()
 }
 }

 foreach (var nativeDependency in NativeDependencies)
 {
 assemblerFilesToLink.Add(nativeDependency);
 }

 if (!ForceInterpreter && (isDevice || ForceAOT) && (assemblerFiles.Count == 0 && !UseNativeAOTRuntime))
 {
 throw new InvalidOperationException("Need list of AOT files for device builds.");
Expand Down

11 changes: 10 additions & 1 deletion
src/tasks/AppleAppBuilder/Templates/CMakeLists.txt.template

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,8 @@ add_executable(
 %ProjectName%
 %MainSource%
 ${APP_RESOURCES}
 util.h
 util.m
)

if(NOT %UseNativeAOTRuntime%)
Expand DownExpand Up@@ -73,5 +75,12 @@ target_link_libraries(
 "-lz"
 "-lc++"
 "-liconv"
%NativeLibrariesToLink%
%NativeLibrariesToLink%
)

if(%UseNativeAOTRuntime%)
target_link_libraries(
 %ProjectName%
 "-Wl,-u,_NativeAOT_StaticInitialization"
)
endif()

11 changes: 8 additions & 3 deletions
src/tasks/AppleAppBuilder/Templates/main-simple.m

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,8 @@
#if !USE_NATIVE_AOT
#import "runtime.h"
#else
extern void* NativeAOT_StaticInitialization();
#import <os/log.h>
#import "util.h"
extern int __managed__Main(int argc, char* argv[]);
#endif

Expand DownExpand Up@@ -57,8 +58,12 @@ - (void)viewDidLoad {
#if INVARIANT_GLOBALIZATION
 setenv ("DOTNET_SYSTEM_GLOBALIZATION_INVARIANT", "1", TRUE);
#endif
 NativeAOT_StaticInitialization();
 int ret_val = __managed__Main(0, NULL);
 char **managed_argv;
 int managed_argc = get_managed_args (&managed_argv);
 int ret_val = __managed__Main (managed_argc, managed_argv);
 free_managed_args (&managed_argv, managed_argc);
Comment thread
akoeplinger marked this conversation as resolved.

 os_log_info (OS_LOG_DEFAULT, EXIT_CODE_TAG ": %d", ret_val);
 exit (ret_val);
#endif
 });
}
Expand Down

17 changes: 6 additions & 11 deletions
src/tasks/AppleAppBuilder/Templates/runtime.m

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,15 +20,14 @@
#include <stdlib.h>
#include <stdio.h>

#import "util.h"

static char *bundle_path;

#define APPLE_RUNTIME_IDENTIFIER "//%APPLE_RUNTIME_IDENTIFIER%"

#define RUNTIMECONFIG_BIN_FILE "runtimeconfig.bin"

// XHarness is looking for this tag in app's output to determine the exit code
#define EXIT_CODE_TAG "DOTNET.APP_EXIT_CODE"

const char *
get_bundle_path (void)
{
Expand DownExpand Up@@ -254,14 +253,8 @@
 setenv ("DOTNET_DiagnosticPorts", DIAGNOSTIC_PORTS, true);
#endif

 id args_array = [[NSProcessInfo processInfo] arguments];
 assert ([args_array count] <= 128);
 const char *managed_argv [128];
 int argi;
 for (argi = 0; argi < [args_array count]; argi++) {
 NSString* arg = [args_array objectAtIndex: argi];
 managed_argv[argi] = [arg UTF8String];
 }
 char **managed_argv;
 int argi = get_managed_args (&managed_argv);

 bool wait_for_debugger = FALSE;

Expand DownExpand Up@@ -373,5 +366,7 @@

 mono_jit_cleanup (domain);

 free_managed_args (&managed_argv, argi);

 exit (res);
}

13 changes: 13 additions & 0 deletions
src/tasks/AppleAppBuilder/Templates/util.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

#ifndef util_h
#define util_h

// XHarness is looking for this tag in app's output to determine the exit code
#define EXIT_CODE_TAG "DOTNET.APP_EXIT_CODE"

size_t get_managed_args (char*** managed_args_array);
void free_managed_args (char*** managed_args_array, size_t array_size);

#endif /* util_h */
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Adding HelloiOS sample for NativeAOT#82249

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

 Merged

ivanpovazan
merged 10 commits into

from

Feb 24, 2023
 Merged


Adding HelloiOS sample for NativeAOT
#82249
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
e0b8ca3

Integrate AppleAppBuilder with NativeAOT runtime


ivanpovazan Feb 16, 2023
53baa49

Add HelloiOS sample variant for NativeAOT


ivanpovazan Feb 16, 2023
433f8df

Adding a README.md


ivanpovazan Feb 16, 2023
ba174d2

Bump the version displayed on the screen when running HelloiOS app


ivanpovazan Feb 16, 2023
65b08e3

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


ivanpovazan Feb 17, 2023
c09b462

Use NativeDependencies property instead to align with AndroidAppBuild…


ivanpovazan Feb 17, 2023
b369a36

Adding fixes according to review feedback


ivanpovazan Feb 21, 2023
b621221

Adding fixes according to review feedback


ivanpovazan Feb 23, 2023
d42f3e3

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


ivanpovazan Feb 24, 2023
d69ba2e

Markdown cleanup


ivanpovazan Feb 24, 2023

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


50 changes: 50 additions & 0 deletions
src/mono/sample/iOS-NativeAOT/Makefile

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
.DEFAULT_GOAL := all

TOP=../../../../

BUILD_CONFIG?=Debug
TARGET_ARCH?=$(shell . $(TOP)eng/native/init-os-and-arch.sh && echo $${arch})
TARGET_OS?=iossimulator
DEPLOY_AND_RUN?=false
STRIP_DEBUG_SYMBOLS?=false

REPO_DIR=$(realpath $(TOP))
TASKS_DIR=$(REPO_DIR)/src/tasks
DOTNET=$(REPO_DIR)/dotnet.sh
BUILD_SCRIPT=$(REPO_DIR)/build.sh

world: build-deps all

# build all dependencies: runtime, nativeAot and all the libs
build-deps: build-runtime-ilc build-libs-all

# building for host
build-runtime-ilc:
	$(BUILD_SCRIPT) clr+clr.aot -c $(BUILD_CONFIG)

build-ilc:
Comment thread
kotlarmilos marked this conversation as resolved.


Outdated

	$(BUILD_SCRIPT) clr.aot -c $(BUILD_CONFIG)

# building for target platform
build-libs-all:
	$(BUILD_SCRIPT) clr.nativeaotruntime+clr.nativeaotlibs+libs -c $(BUILD_CONFIG) -os $(TARGET_OS) -arch $(TARGET_ARCH)

build-libs-nativeaot:
	$(BUILD_SCRIPT) clr.nativeaotruntime+clr.nativeaotlibs -c $(BUILD_CONFIG) -os $(TARGET_OS) -arch $(TARGET_ARCH)

all: appbuilder hello-app

appbuilder:
	$(DOTNET) build -c $(BUILD_CONFIG) $(TASKS_DIR)/AppleAppBuilder/AppleAppBuilder.csproj

hello-app: clean
	$(DOTNET) \
	build -c $(BUILD_CONFIG) \
	-p:TargetOS=$(TARGET_OS) \
	-p:TargetArchitecture=$(TARGET_ARCH) \
	-p:DeployAndRun=$(DEPLOY_AND_RUN) \
	-p:StripDebugSymbols=$(STRIP_DEBUG_SYMBOLS) \
	-bl
Comment thread
kotlarmilos marked this conversation as resolved.


clean:
	rm -rf obj bin

95 changes: 95 additions & 0 deletions
src/mono/sample/iOS-NativeAOT/Program.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
<Project Sdk="Microsoft.NET.Sdk">
 <PropertyGroup>
 <OutputType>Exe</OutputType>
 <OutputPath>bin</OutputPath>
 <IntermediateOutputPath>$(MSBuildThisFileDirectory)/obj/</IntermediateOutputPath>
 <TargetFramework>$(NetCoreAppCurrent)</TargetFramework>
 <TargetOS Condition="'$(TargetOS)' == ''">ios</TargetOS>
 <TargetOS Condition="'$(TargetsiOSSimulator)' == 'true'">iossimulator</TargetOS>
 <DeployAndRun Condition="'$(DeployAndRun)' == ''">true</DeployAndRun>
 <RuntimeIdentifier>$(TargetOS)-$(TargetArchitecture)</RuntimeIdentifier>
 <AppName>HelloiOS</AppName>
Comment thread
kotlarmilos marked this conversation as resolved.


Outdated

 <StripDebugSymbols Condition="'$(StripDebugSymbols)' == ''">false</StripDebugSymbols>
 <!-- NativeAOT-specific props -->
 <NativeLib>static</NativeLib>
 <CustomNativeMain>true</CustomNativeMain>
 <UseNativeAOTRuntime Condition="'$(UseNativeAOTRuntime)' == ''">true</UseNativeAOTRuntime>
 <!-- FIXME: Once we support building System.Globalization.Native and icu, should be removed -->
 <InvariantGlobalization>true</InvariantGlobalization>
 <!-- FIXME: We do not use publish targets yet, but we need to create a publish directory -->
 <PublishDir Condition="'$(PublishDir)' == ''">$(OutputPath)/publish</PublishDir>
 </PropertyGroup>

 <ItemGroup>
 <Compile Include="..\iOS\Program.cs" Link="Program.cs" />
 <DirectPInvoke Include="__Internal" />
 </ItemGroup>

 <PropertyGroup Condition="'$(TargetOS)' == 'maccatalyst'">
Comment thread
ivanpovazan marked this conversation as resolved.

 <DevTeamProvisioning Condition="'$(DevTeamProvisioning)' == ''">adhoc</DevTeamProvisioning>
 <EnableAppSandbox Condition="'$(EnableAppSandbox)' == ''">false</EnableAppSandbox>
 </PropertyGroup>

 <Import Project="$(CoreClrProjectRoot)nativeaot\BuildIntegration\Microsoft.NETCore.Native.targets" />
 <UsingTask TaskName="AppleAppBuilderTask"
 AssemblyFile="$(AppleAppBuilderTasksAssemblyPath)" />

 <!-- FIXME: Once we set up builing appropriate runtime package for iOS-like platforms the following properties should be removed -->
 <Target Name="ConfigureIlcPathsForiOSCrossCompilation">
 <PropertyGroup>
 <IlcPath>$([MSBuild]::NormalizeDirectory('$(RepoRoot)', 'artifacts', 'bin', 'coreclr', '$(HostOS).$(BuildArchitecture).$(CoreCLRConfiguration)', 'ilc'))</IlcPath>
 <IlcToolsPath>$(IlcPath)</IlcToolsPath>
 <IlcSdkPath>$(CoreCLRAotSdkDir)</IlcSdkPath>
 <IlcFrameworkPath>$(LibrariesAllBinArtifactsPath)</IlcFrameworkPath>
 <IlcFrameworkNativePath>$(LibrariesAllBinArtifactsPath)</IlcFrameworkNativePath>
 </PropertyGroup>
 </Target>

 <Target Name="BuildAppBundle"
 AfterTargets="Build"
 DependsOnTargets="ConfigureIlcPathsForiOSCrossCompilation;SetupProperties;ComputeIlcCompileInputs;IlcCompile">

 <PropertyGroup>
 <AppDir>$(MSBuildThisFileDirectory)$(PublishDir)\app</AppDir>
 <IosSimulator Condition="'$(TargetsiOSSimulator)' == 'true'">iPhone 11</IosSimulator>
 <Optimized Condition="'$(Configuration)' == 'Release'">True</Optimized>
 </PropertyGroup>

 <ItemGroup>
 <NativeLibrary Include="%(ManagedBinary.IlcOutputFile)" />
 </ItemGroup>

 <RemoveDir Directories="$(AppDir)" />

 <AppleAppBuilderTask
 UseNativeAOTRuntime="$(UseNativeAOTRuntime)"
 NativeDependencies="@(NativeLibrary)"
 TargetOS="$(TargetOS)"
 Arch="$(TargetArchitecture)"
 ProjectName="$(AppName)"
 Assemblies="@(BundleAssemblies)"
 GenerateXcodeProject="True"
 BuildAppBundle="True"
 DevTeamProvisioning="$(DevTeamProvisioning)"
 OutputDirectory="$(AppDir)"
 Optimized="$(Optimized)"
 InvariantGlobalization="$(InvariantGlobalization)"
 StripSymbolTable="$(StripDebugSymbols)"
 AppDir="$(MSBuildThisFileDirectory)$(PublishDir)" >
 <Output TaskParameter="AppBundlePath" PropertyName="AppBundlePath" />
 <Output TaskParameter="XcodeProjectPath" PropertyName="XcodeProjectPath" />
 </AppleAppBuilderTask>

 <Message Importance="High" Text="Xcode: $(XcodeProjectPath)"/>
 <Message Importance="High" Text="App: $(AppBundlePath)"/>

 </Target>

 <Target Name="RunAppBundle"
 AfterTargets="BuildAppBundle"
 Condition="'$(DeployAndRun)' == 'true'">
 <Exec Condition="'$(TargetOS)' == 'iossimulator'" Command="dotnet xharness apple run --app=$(AppBundlePath) --targets=ios-simulator-64 --output-directory=/tmp/out" />
 <Exec Condition="'$(TargetOS)' == 'ios'" Command="dotnet xharness apple run --app=$(AppBundlePath) --targets=ios-device --output-directory=/tmp/out" />
 </Target>

</Project>

79 changes: 79 additions & 0 deletions
src/mono/sample/iOS-NativeAOT/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
# NativeAOT iOS sample app
@marek-safarmarek-safarFeb 20, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Why is it under mono folder?
@ivanpovazanivanpovazanFeb 20, 2023•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

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.
@ivanpovazanivanpovazanFeb 20, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

FWIW NativeAOT keeps samples here: https://github.com/dotnet/samples/tree/main/core/nativeaot
@filipnavarafilipnavaraFeb 20, 2023•

edited

Loading

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

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.
@ivanpovazanivanpovazanFeb 21, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

@MichalStrehovsky what do you think?
@MichalStrehovskyMichalStrehovskyFeb 21, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

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.
@ivanpovazanivanpovazanFeb 21, 2023•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

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.
@MichalStrehovskyMichalStrehovskyFeb 21, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

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 :)
@ivanpovazanivanpovazanFeb 21, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

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.
@jkotasjkotasFeb 21, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

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.

## Description

This sample application is intended to be used by developers who work on enabling NativeAOT on iOS-like platforms and can serve as PoC for verifying support for the following systems:
- ios
- iossimulator
- tvos
- tvossimulator
- maccatalyst

The sample shares the source code with the Mono sample specified at: `../iOS/Program.cs` and in general should have the same behavior as MonoAOT.

## Limitations

The application is **_currently_** relying on the following:
1. Internal dependencies - locally building the internals is required as runtime and tools nuget packages are still not being produced
2. Invariant globalization - `System.Globalization.Native` is currently not being built as part of NativeAOT framework for iOS-like platforms
3. No publish targets - the SDK and MSBuild integration is still not complete

## How to build and test

### Building for the first time

When building for the first time (on a clean checkout) run from this directory the following `make` command:
``` bash
make world
```
This will first build all required runtime components and dependencies, after which it will build the sample app and bundle it into an application bundle.
By default the build will use `Debug` build configuration and target `iossimulator`.
To change this behavior, specify the desired setting in the following way:
``` bash
make world BUILD_CONFIG=Release TARGET_OS=ios
```

### To avoid building all the dependencies

For future builds, you can run just:
``` bash
make
```
which will skip building all the runtime dependencies, assuming those have been already properly built, and build the MSBuild task used for bundling the application and the application it self.

For convenience, it is also possible to rebuild only the application it self with:
``` bash
make hello-app
```

### Deploy and run

#### Simulator

To test the application on a simulator include the following in your make command `DEPLOY_AND_RUN=true` e.g.,:
``` bash
make hello-app DEPLOY_AND_RUN=true
```

#### Device

To test the application on a device, a provisioning profile needs to be specified.
This can be achieved by defining `DevTeamProvisioning` environment variable with a valid team ID (see [developer.apple.com/account/#/membership](https://developer.apple.com/account/#/membership), scroll down to `Team ID`) for example:
``` bash
export DevTeamProvisioning=A1B2C3D4E5; make hello-app TARGET_OS=ios DEPLOY_AND_RUN=true
```
Assuming `A1B2C3D4E5` is a valid team ID.

#### One-liner

On a clean dotnet/runtime checkout, from this directory, run:

``` bash
export DevTeamProvisioning=A1B2C3D4E5; make world BUILD_CONFIG=Release TARGET_OS=ios DEPLOY_AND_RUN=true
```

This command will build everything necessary to run and deploy the application on an iOS device.

### Custom builds

Check the `Makefile` for individual list of targets and variables to customize the build.

2 changes: 1 addition & 1 deletion
src/mono/sample/iOS/Program.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,7 @@ public static async Task Main(string[] args)
 delegate* unmanaged<void> unmanagedPtr = &OnButtonClick;
 ios_register_button_click(unmanagedPtr);
 }
 const string msg = "Hello World!\n.NET 5.0";
 const string msg = "Hello World!\n.NET 8.0";
 for (int i = 0; i < msg.Length; i++)
 {
 // a kind of an animation
Expand Down

10 changes: 10 additions & 0 deletions
src/tasks/AppleAppBuilder/AppleAppBuilder.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -171,6 +171,11 @@ public string TargetOS
 /// </summary>
 public bool UseNativeAOTRuntime { get; set; }

 /// <summary>
 /// Extra native dependencies to link into the app
 /// </summary>
 public string[] NativeDependencies { get; set; } = Array.Empty<string>();

 public void ValidateRuntimeSelection()
 {
 if (UseNativeAOTRuntime)
Expand DownExpand Up@@ -267,6 +272,11 @@ public override bool Execute()
 }
 }

 foreach (var nativeDependency in NativeDependencies)
 {
 assemblerFilesToLink.Add(nativeDependency);
 }

 if (!ForceInterpreter && (isDevice || ForceAOT) && (assemblerFiles.Count == 0 && !UseNativeAOTRuntime))
 {
 throw new InvalidOperationException("Need list of AOT files for device builds.");
Expand Down

11 changes: 10 additions & 1 deletion
src/tasks/AppleAppBuilder/Templates/CMakeLists.txt.template

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,8 @@ add_executable(
 %ProjectName%
 %MainSource%
 ${APP_RESOURCES}
 util.h
 util.m
)

if(NOT %UseNativeAOTRuntime%)
Expand DownExpand Up@@ -73,5 +75,12 @@ target_link_libraries(
 "-lz"
 "-lc++"
 "-liconv"
%NativeLibrariesToLink%
%NativeLibrariesToLink%
)

if(%UseNativeAOTRuntime%)
target_link_libraries(
 %ProjectName%
 "-Wl,-u,_NativeAOT_StaticInitialization"
)
endif()

11 changes: 8 additions & 3 deletions
src/tasks/AppleAppBuilder/Templates/main-simple.m

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,8 @@
#if !USE_NATIVE_AOT
#import "runtime.h"
#else
extern void* NativeAOT_StaticInitialization();
#import <os/log.h>
#import "util.h"
extern int __managed__Main(int argc, char* argv[]);
#endif

Expand DownExpand Up@@ -57,8 +58,12 @@ - (void)viewDidLoad {
#if INVARIANT_GLOBALIZATION
 setenv ("DOTNET_SYSTEM_GLOBALIZATION_INVARIANT", "1", TRUE);
#endif
 NativeAOT_StaticInitialization();
 int ret_val = __managed__Main(0, NULL);
 char **managed_argv;
 int managed_argc = get_managed_args (&managed_argv);
 int ret_val = __managed__Main (managed_argc, managed_argv);
 free_managed_args (&managed_argv, managed_argc);
Comment thread
akoeplinger marked this conversation as resolved.

 os_log_info (OS_LOG_DEFAULT, EXIT_CODE_TAG ": %d", ret_val);
 exit (ret_val);
#endif
 });
}
Expand Down

17 changes: 6 additions & 11 deletions
src/tasks/AppleAppBuilder/Templates/runtime.m

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,15 +20,14 @@
#include <stdlib.h>
#include <stdio.h>

#import "util.h"

static char *bundle_path;

#define APPLE_RUNTIME_IDENTIFIER "//%APPLE_RUNTIME_IDENTIFIER%"

#define RUNTIMECONFIG_BIN_FILE "runtimeconfig.bin"

// XHarness is looking for this tag in app's output to determine the exit code
#define EXIT_CODE_TAG "DOTNET.APP_EXIT_CODE"

const char *
get_bundle_path (void)
{
Expand DownExpand Up@@ -254,14 +253,8 @@
 setenv ("DOTNET_DiagnosticPorts", DIAGNOSTIC_PORTS, true);
#endif

 id args_array = [[NSProcessInfo processInfo] arguments];
 assert ([args_array count] <= 128);
 const char *managed_argv [128];
 int argi;
 for (argi = 0; argi < [args_array count]; argi++) {
 NSString* arg = [args_array objectAtIndex: argi];
 managed_argv[argi] = [arg UTF8String];
 }
 char **managed_argv;
 int argi = get_managed_args (&managed_argv);

 bool wait_for_debugger = FALSE;

Expand DownExpand Up@@ -373,5 +366,7 @@

 mono_jit_cleanup (domain);

 free_managed_args (&managed_argv, argi);

 exit (res);
}

13 changes: 13 additions & 0 deletions
src/tasks/AppleAppBuilder/Templates/util.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

#ifndef util_h
#define util_h

// XHarness is looking for this tag in app's output to determine the exit code
#define EXIT_CODE_TAG "DOTNET.APP_EXIT_CODE"

size_t get_managed_args (char*** managed_args_array);
void free_managed_args (char*** managed_args_array, size_t array_size);

#endif /* util_h */
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Adding HelloiOS sample for NativeAOT#82249

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

 Merged

ivanpovazan
merged 10 commits into

from

Feb 24, 2023
 Merged


Adding HelloiOS sample for NativeAOT
#82249
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
e0b8ca3

Integrate AppleAppBuilder with NativeAOT runtime


ivanpovazan Feb 16, 2023
53baa49

Add HelloiOS sample variant for NativeAOT


ivanpovazan Feb 16, 2023
433f8df

Adding a README.md


ivanpovazan Feb 16, 2023
ba174d2

Bump the version displayed on the screen when running HelloiOS app


ivanpovazan Feb 16, 2023
65b08e3

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


ivanpovazan Feb 17, 2023
c09b462

Use NativeDependencies property instead to align with AndroidAppBuild…


ivanpovazan Feb 17, 2023
b369a36

Adding fixes according to review feedback


ivanpovazan Feb 21, 2023
b621221

Adding fixes according to review feedback


ivanpovazan Feb 23, 2023
d42f3e3

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


ivanpovazan Feb 24, 2023
d69ba2e

Markdown cleanup


ivanpovazan Feb 24, 2023

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


50 changes: 50 additions & 0 deletions
src/mono/sample/iOS-NativeAOT/Makefile

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
.DEFAULT_GOAL := all

TOP=../../../../

BUILD_CONFIG?=Debug
TARGET_ARCH?=$(shell . $(TOP)eng/native/init-os-and-arch.sh && echo $${arch})
TARGET_OS?=iossimulator
DEPLOY_AND_RUN?=false
STRIP_DEBUG_SYMBOLS?=false

REPO_DIR=$(realpath $(TOP))
TASKS_DIR=$(REPO_DIR)/src/tasks
DOTNET=$(REPO_DIR)/dotnet.sh
BUILD_SCRIPT=$(REPO_DIR)/build.sh

world: build-deps all

# build all dependencies: runtime, nativeAot and all the libs
build-deps: build-runtime-ilc build-libs-all

# building for host
build-runtime-ilc:
	$(BUILD_SCRIPT) clr+clr.aot -c $(BUILD_CONFIG)

build-ilc:
Comment thread
kotlarmilos marked this conversation as resolved.


Outdated

	$(BUILD_SCRIPT) clr.aot -c $(BUILD_CONFIG)

# building for target platform
build-libs-all:
	$(BUILD_SCRIPT) clr.nativeaotruntime+clr.nativeaotlibs+libs -c $(BUILD_CONFIG) -os $(TARGET_OS) -arch $(TARGET_ARCH)

build-libs-nativeaot:
	$(BUILD_SCRIPT) clr.nativeaotruntime+clr.nativeaotlibs -c $(BUILD_CONFIG) -os $(TARGET_OS) -arch $(TARGET_ARCH)

all: appbuilder hello-app

appbuilder:
	$(DOTNET) build -c $(BUILD_CONFIG) $(TASKS_DIR)/AppleAppBuilder/AppleAppBuilder.csproj

hello-app: clean
	$(DOTNET) \
	build -c $(BUILD_CONFIG) \
	-p:TargetOS=$(TARGET_OS) \
	-p:TargetArchitecture=$(TARGET_ARCH) \
	-p:DeployAndRun=$(DEPLOY_AND_RUN) \
	-p:StripDebugSymbols=$(STRIP_DEBUG_SYMBOLS) \
	-bl
Comment thread
kotlarmilos marked this conversation as resolved.


clean:
	rm -rf obj bin

95 changes: 95 additions & 0 deletions
src/mono/sample/iOS-NativeAOT/Program.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
<Project Sdk="Microsoft.NET.Sdk">
 <PropertyGroup>
 <OutputType>Exe</OutputType>
 <OutputPath>bin</OutputPath>
 <IntermediateOutputPath>$(MSBuildThisFileDirectory)/obj/</IntermediateOutputPath>
 <TargetFramework>$(NetCoreAppCurrent)</TargetFramework>
 <TargetOS Condition="'$(TargetOS)' == ''">ios</TargetOS>
 <TargetOS Condition="'$(TargetsiOSSimulator)' == 'true'">iossimulator</TargetOS>
 <DeployAndRun Condition="'$(DeployAndRun)' == ''">true</DeployAndRun>
 <RuntimeIdentifier>$(TargetOS)-$(TargetArchitecture)</RuntimeIdentifier>
 <AppName>HelloiOS</AppName>
Comment thread
kotlarmilos marked this conversation as resolved.


Outdated

 <StripDebugSymbols Condition="'$(StripDebugSymbols)' == ''">false</StripDebugSymbols>
 <!-- NativeAOT-specific props -->
 <NativeLib>static</NativeLib>
 <CustomNativeMain>true</CustomNativeMain>
 <UseNativeAOTRuntime Condition="'$(UseNativeAOTRuntime)' == ''">true</UseNativeAOTRuntime>
 <!-- FIXME: Once we support building System.Globalization.Native and icu, should be removed -->
 <InvariantGlobalization>true</InvariantGlobalization>
 <!-- FIXME: We do not use publish targets yet, but we need to create a publish directory -->
 <PublishDir Condition="'$(PublishDir)' == ''">$(OutputPath)/publish</PublishDir>
 </PropertyGroup>

 <ItemGroup>
 <Compile Include="..\iOS\Program.cs" Link="Program.cs" />
 <DirectPInvoke Include="__Internal" />
 </ItemGroup>

 <PropertyGroup Condition="'$(TargetOS)' == 'maccatalyst'">
Comment thread
ivanpovazan marked this conversation as resolved.

 <DevTeamProvisioning Condition="'$(DevTeamProvisioning)' == ''">adhoc</DevTeamProvisioning>
 <EnableAppSandbox Condition="'$(EnableAppSandbox)' == ''">false</EnableAppSandbox>
 </PropertyGroup>

 <Import Project="$(CoreClrProjectRoot)nativeaot\BuildIntegration\Microsoft.NETCore.Native.targets" />
 <UsingTask TaskName="AppleAppBuilderTask"
 AssemblyFile="$(AppleAppBuilderTasksAssemblyPath)" />

 <!-- FIXME: Once we set up builing appropriate runtime package for iOS-like platforms the following properties should be removed -->
 <Target Name="ConfigureIlcPathsForiOSCrossCompilation">
 <PropertyGroup>
 <IlcPath>$([MSBuild]::NormalizeDirectory('$(RepoRoot)', 'artifacts', 'bin', 'coreclr', '$(HostOS).$(BuildArchitecture).$(CoreCLRConfiguration)', 'ilc'))</IlcPath>
 <IlcToolsPath>$(IlcPath)</IlcToolsPath>
 <IlcSdkPath>$(CoreCLRAotSdkDir)</IlcSdkPath>
 <IlcFrameworkPath>$(LibrariesAllBinArtifactsPath)</IlcFrameworkPath>
 <IlcFrameworkNativePath>$(LibrariesAllBinArtifactsPath)</IlcFrameworkNativePath>
 </PropertyGroup>
 </Target>

 <Target Name="BuildAppBundle"
 AfterTargets="Build"
 DependsOnTargets="ConfigureIlcPathsForiOSCrossCompilation;SetupProperties;ComputeIlcCompileInputs;IlcCompile">

 <PropertyGroup>
 <AppDir>$(MSBuildThisFileDirectory)$(PublishDir)\app</AppDir>
 <IosSimulator Condition="'$(TargetsiOSSimulator)' == 'true'">iPhone 11</IosSimulator>
 <Optimized Condition="'$(Configuration)' == 'Release'">True</Optimized>
 </PropertyGroup>

 <ItemGroup>
 <NativeLibrary Include="%(ManagedBinary.IlcOutputFile)" />
 </ItemGroup>

 <RemoveDir Directories="$(AppDir)" />

 <AppleAppBuilderTask
 UseNativeAOTRuntime="$(UseNativeAOTRuntime)"
 NativeDependencies="@(NativeLibrary)"
 TargetOS="$(TargetOS)"
 Arch="$(TargetArchitecture)"
 ProjectName="$(AppName)"
 Assemblies="@(BundleAssemblies)"
 GenerateXcodeProject="True"
 BuildAppBundle="True"
 DevTeamProvisioning="$(DevTeamProvisioning)"
 OutputDirectory="$(AppDir)"
 Optimized="$(Optimized)"
 InvariantGlobalization="$(InvariantGlobalization)"
 StripSymbolTable="$(StripDebugSymbols)"
 AppDir="$(MSBuildThisFileDirectory)$(PublishDir)" >
 <Output TaskParameter="AppBundlePath" PropertyName="AppBundlePath" />
 <Output TaskParameter="XcodeProjectPath" PropertyName="XcodeProjectPath" />
 </AppleAppBuilderTask>

 <Message Importance="High" Text="Xcode: $(XcodeProjectPath)"/>
 <Message Importance="High" Text="App: $(AppBundlePath)"/>

 </Target>

 <Target Name="RunAppBundle"
 AfterTargets="BuildAppBundle"
 Condition="'$(DeployAndRun)' == 'true'">
 <Exec Condition="'$(TargetOS)' == 'iossimulator'" Command="dotnet xharness apple run --app=$(AppBundlePath) --targets=ios-simulator-64 --output-directory=/tmp/out" />
 <Exec Condition="'$(TargetOS)' == 'ios'" Command="dotnet xharness apple run --app=$(AppBundlePath) --targets=ios-device --output-directory=/tmp/out" />
 </Target>

</Project>

79 changes: 79 additions & 0 deletions
src/mono/sample/iOS-NativeAOT/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
# NativeAOT iOS sample app
@marek-safarmarek-safarFeb 20, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Why is it under mono folder?
@ivanpovazanivanpovazanFeb 20, 2023•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

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.
@ivanpovazanivanpovazanFeb 20, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

FWIW NativeAOT keeps samples here: https://github.com/dotnet/samples/tree/main/core/nativeaot
@filipnavarafilipnavaraFeb 20, 2023•

edited

Loading

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

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.
@ivanpovazanivanpovazanFeb 21, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

@MichalStrehovsky what do you think?
@MichalStrehovskyMichalStrehovskyFeb 21, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

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.
@ivanpovazanivanpovazanFeb 21, 2023•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

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.
@MichalStrehovskyMichalStrehovskyFeb 21, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

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 :)
@ivanpovazanivanpovazanFeb 21, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

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.
@jkotasjkotasFeb 21, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

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.

## Description

This sample application is intended to be used by developers who work on enabling NativeAOT on iOS-like platforms and can serve as PoC for verifying support for the following systems:
- ios
- iossimulator
- tvos
- tvossimulator
- maccatalyst

The sample shares the source code with the Mono sample specified at: `../iOS/Program.cs` and in general should have the same behavior as MonoAOT.

## Limitations

The application is **_currently_** relying on the following:
1. Internal dependencies - locally building the internals is required as runtime and tools nuget packages are still not being produced
2. Invariant globalization - `System.Globalization.Native` is currently not being built as part of NativeAOT framework for iOS-like platforms
3. No publish targets - the SDK and MSBuild integration is still not complete

## How to build and test

### Building for the first time

When building for the first time (on a clean checkout) run from this directory the following `make` command:
``` bash
make world
```
This will first build all required runtime components and dependencies, after which it will build the sample app and bundle it into an application bundle.
By default the build will use `Debug` build configuration and target `iossimulator`.
To change this behavior, specify the desired setting in the following way:
``` bash
make world BUILD_CONFIG=Release TARGET_OS=ios
```

### To avoid building all the dependencies

For future builds, you can run just:
``` bash
make
```
which will skip building all the runtime dependencies, assuming those have been already properly built, and build the MSBuild task used for bundling the application and the application it self.

For convenience, it is also possible to rebuild only the application it self with:
``` bash
make hello-app
```

### Deploy and run

#### Simulator

To test the application on a simulator include the following in your make command `DEPLOY_AND_RUN=true` e.g.,:
``` bash
make hello-app DEPLOY_AND_RUN=true
```

#### Device

To test the application on a device, a provisioning profile needs to be specified.
This can be achieved by defining `DevTeamProvisioning` environment variable with a valid team ID (see [developer.apple.com/account/#/membership](https://developer.apple.com/account/#/membership), scroll down to `Team ID`) for example:
``` bash
export DevTeamProvisioning=A1B2C3D4E5; make hello-app TARGET_OS=ios DEPLOY_AND_RUN=true
```
Assuming `A1B2C3D4E5` is a valid team ID.

#### One-liner

On a clean dotnet/runtime checkout, from this directory, run:

``` bash
export DevTeamProvisioning=A1B2C3D4E5; make world BUILD_CONFIG=Release TARGET_OS=ios DEPLOY_AND_RUN=true
```

This command will build everything necessary to run and deploy the application on an iOS device.

### Custom builds

Check the `Makefile` for individual list of targets and variables to customize the build.

2 changes: 1 addition & 1 deletion
src/mono/sample/iOS/Program.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,7 @@ public static async Task Main(string[] args)
 delegate* unmanaged<void> unmanagedPtr = &OnButtonClick;
 ios_register_button_click(unmanagedPtr);
 }
 const string msg = "Hello World!\n.NET 5.0";
 const string msg = "Hello World!\n.NET 8.0";
 for (int i = 0; i < msg.Length; i++)
 {
 // a kind of an animation
Expand Down

10 changes: 10 additions & 0 deletions
src/tasks/AppleAppBuilder/AppleAppBuilder.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -171,6 +171,11 @@ public string TargetOS
 /// </summary>
 public bool UseNativeAOTRuntime { get; set; }

 /// <summary>
 /// Extra native dependencies to link into the app
 /// </summary>
 public string[] NativeDependencies { get; set; } = Array.Empty<string>();

 public void ValidateRuntimeSelection()
 {
 if (UseNativeAOTRuntime)
Expand DownExpand Up@@ -267,6 +272,11 @@ public override bool Execute()
 }
 }

 foreach (var nativeDependency in NativeDependencies)
 {
 assemblerFilesToLink.Add(nativeDependency);
 }

 if (!ForceInterpreter && (isDevice || ForceAOT) && (assemblerFiles.Count == 0 && !UseNativeAOTRuntime))
 {
 throw new InvalidOperationException("Need list of AOT files for device builds.");
Expand Down

11 changes: 10 additions & 1 deletion
src/tasks/AppleAppBuilder/Templates/CMakeLists.txt.template

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,8 @@ add_executable(
 %ProjectName%
 %MainSource%
 ${APP_RESOURCES}
 util.h
 util.m
)

if(NOT %UseNativeAOTRuntime%)
Expand DownExpand Up@@ -73,5 +75,12 @@ target_link_libraries(
 "-lz"
 "-lc++"
 "-liconv"
%NativeLibrariesToLink%
%NativeLibrariesToLink%
)

if(%UseNativeAOTRuntime%)
target_link_libraries(
 %ProjectName%
 "-Wl,-u,_NativeAOT_StaticInitialization"
)
endif()

11 changes: 8 additions & 3 deletions
src/tasks/AppleAppBuilder/Templates/main-simple.m

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,8 @@
#if !USE_NATIVE_AOT
#import "runtime.h"
#else
extern void* NativeAOT_StaticInitialization();
#import <os/log.h>
#import "util.h"
extern int __managed__Main(int argc, char* argv[]);
#endif

Expand DownExpand Up@@ -57,8 +58,12 @@ - (void)viewDidLoad {
#if INVARIANT_GLOBALIZATION
 setenv ("DOTNET_SYSTEM_GLOBALIZATION_INVARIANT", "1", TRUE);
#endif
 NativeAOT_StaticInitialization();
 int ret_val = __managed__Main(0, NULL);
 char **managed_argv;
 int managed_argc = get_managed_args (&managed_argv);
 int ret_val = __managed__Main (managed_argc, managed_argv);
 free_managed_args (&managed_argv, managed_argc);
Comment thread
akoeplinger marked this conversation as resolved.

 os_log_info (OS_LOG_DEFAULT, EXIT_CODE_TAG ": %d", ret_val);
 exit (ret_val);
#endif
 });
}
Expand Down

17 changes: 6 additions & 11 deletions
src/tasks/AppleAppBuilder/Templates/runtime.m

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,15 +20,14 @@
#include <stdlib.h>
#include <stdio.h>

#import "util.h"

static char *bundle_path;

#define APPLE_RUNTIME_IDENTIFIER "//%APPLE_RUNTIME_IDENTIFIER%"

#define RUNTIMECONFIG_BIN_FILE "runtimeconfig.bin"

// XHarness is looking for this tag in app's output to determine the exit code
#define EXIT_CODE_TAG "DOTNET.APP_EXIT_CODE"

const char *
get_bundle_path (void)
{
Expand DownExpand Up@@ -254,14 +253,8 @@
 setenv ("DOTNET_DiagnosticPorts", DIAGNOSTIC_PORTS, true);
#endif

 id args_array = [[NSProcessInfo processInfo] arguments];
 assert ([args_array count] <= 128);
 const char *managed_argv [128];
 int argi;
 for (argi = 0; argi < [args_array count]; argi++) {
 NSString* arg = [args_array objectAtIndex: argi];
 managed_argv[argi] = [arg UTF8String];
 }
 char **managed_argv;
 int argi = get_managed_args (&managed_argv);

 bool wait_for_debugger = FALSE;

Expand DownExpand Up@@ -373,5 +366,7 @@

 mono_jit_cleanup (domain);

 free_managed_args (&managed_argv, argi);

 exit (res);
}

13 changes: 13 additions & 0 deletions
src/tasks/AppleAppBuilder/Templates/util.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

#ifndef util_h
#define util_h

// XHarness is looking for this tag in app's output to determine the exit code
#define EXIT_CODE_TAG "DOTNET.APP_EXIT_CODE"

size_t get_managed_args (char*** managed_args_array);
void free_managed_args (char*** managed_args_array, size_t array_size);

#endif /* util_h */
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Adding HelloiOS sample for NativeAOT#82249

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

 Merged

ivanpovazan
merged 10 commits into

from

Feb 24, 2023
 Merged


Adding HelloiOS sample for NativeAOT
#82249
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
e0b8ca3

Integrate AppleAppBuilder with NativeAOT runtime


ivanpovazan Feb 16, 2023
53baa49

Add HelloiOS sample variant for NativeAOT


ivanpovazan Feb 16, 2023
433f8df

Adding a README.md


ivanpovazan Feb 16, 2023
ba174d2

Bump the version displayed on the screen when running HelloiOS app


ivanpovazan Feb 16, 2023
65b08e3

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


ivanpovazan Feb 17, 2023
c09b462

Use NativeDependencies property instead to align with AndroidAppBuild…


ivanpovazan Feb 17, 2023
b369a36

Adding fixes according to review feedback


ivanpovazan Feb 21, 2023
b621221

Adding fixes according to review feedback


ivanpovazan Feb 23, 2023
d42f3e3

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


ivanpovazan Feb 24, 2023
d69ba2e

Markdown cleanup


ivanpovazan Feb 24, 2023

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


50 changes: 50 additions & 0 deletions
src/mono/sample/iOS-NativeAOT/Makefile

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
.DEFAULT_GOAL := all

TOP=../../../../

BUILD_CONFIG?=Debug
TARGET_ARCH?=$(shell . $(TOP)eng/native/init-os-and-arch.sh && echo $${arch})
TARGET_OS?=iossimulator
DEPLOY_AND_RUN?=false
STRIP_DEBUG_SYMBOLS?=false

REPO_DIR=$(realpath $(TOP))
TASKS_DIR=$(REPO_DIR)/src/tasks
DOTNET=$(REPO_DIR)/dotnet.sh
BUILD_SCRIPT=$(REPO_DIR)/build.sh

world: build-deps all

# build all dependencies: runtime, nativeAot and all the libs
build-deps: build-runtime-ilc build-libs-all

# building for host
build-runtime-ilc:
	$(BUILD_SCRIPT) clr+clr.aot -c $(BUILD_CONFIG)

build-ilc:
Comment thread
kotlarmilos marked this conversation as resolved.


Outdated

	$(BUILD_SCRIPT) clr.aot -c $(BUILD_CONFIG)

# building for target platform
build-libs-all:
	$(BUILD_SCRIPT) clr.nativeaotruntime+clr.nativeaotlibs+libs -c $(BUILD_CONFIG) -os $(TARGET_OS) -arch $(TARGET_ARCH)

build-libs-nativeaot:
	$(BUILD_SCRIPT) clr.nativeaotruntime+clr.nativeaotlibs -c $(BUILD_CONFIG) -os $(TARGET_OS) -arch $(TARGET_ARCH)

all: appbuilder hello-app

appbuilder:
	$(DOTNET) build -c $(BUILD_CONFIG) $(TASKS_DIR)/AppleAppBuilder/AppleAppBuilder.csproj

hello-app: clean
	$(DOTNET) \
	build -c $(BUILD_CONFIG) \
	-p:TargetOS=$(TARGET_OS) \
	-p:TargetArchitecture=$(TARGET_ARCH) \
	-p:DeployAndRun=$(DEPLOY_AND_RUN) \
	-p:StripDebugSymbols=$(STRIP_DEBUG_SYMBOLS) \
	-bl
Comment thread
kotlarmilos marked this conversation as resolved.


clean:
	rm -rf obj bin

95 changes: 95 additions & 0 deletions
src/mono/sample/iOS-NativeAOT/Program.csproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
<Project Sdk="Microsoft.NET.Sdk">
 <PropertyGroup>
 <OutputType>Exe</OutputType>
 <OutputPath>bin</OutputPath>
 <IntermediateOutputPath>$(MSBuildThisFileDirectory)/obj/</IntermediateOutputPath>
 <TargetFramework>$(NetCoreAppCurrent)</TargetFramework>
 <TargetOS Condition="'$(TargetOS)' == ''">ios</TargetOS>
 <TargetOS Condition="'$(TargetsiOSSimulator)' == 'true'">iossimulator</TargetOS>
 <DeployAndRun Condition="'$(DeployAndRun)' == ''">true</DeployAndRun>
 <RuntimeIdentifier>$(TargetOS)-$(TargetArchitecture)</RuntimeIdentifier>
 <AppName>HelloiOS</AppName>
Comment thread
kotlarmilos marked this conversation as resolved.


Outdated

 <StripDebugSymbols Condition="'$(StripDebugSymbols)' == ''">false</StripDebugSymbols>
 <!-- NativeAOT-specific props -->
 <NativeLib>static</NativeLib>
 <CustomNativeMain>true</CustomNativeMain>
 <UseNativeAOTRuntime Condition="'$(UseNativeAOTRuntime)' == ''">true</UseNativeAOTRuntime>
 <!-- FIXME: Once we support building System.Globalization.Native and icu, should be removed -->
 <InvariantGlobalization>true</InvariantGlobalization>
 <!-- FIXME: We do not use publish targets yet, but we need to create a publish directory -->
 <PublishDir Condition="'$(PublishDir)' == ''">$(OutputPath)/publish</PublishDir>
 </PropertyGroup>

 <ItemGroup>
 <Compile Include="..\iOS\Program.cs" Link="Program.cs" />
 <DirectPInvoke Include="__Internal" />
 </ItemGroup>

 <PropertyGroup Condition="'$(TargetOS)' == 'maccatalyst'">
Comment thread
ivanpovazan marked this conversation as resolved.

 <DevTeamProvisioning Condition="'$(DevTeamProvisioning)' == ''">adhoc</DevTeamProvisioning>
 <EnableAppSandbox Condition="'$(EnableAppSandbox)' == ''">false</EnableAppSandbox>
 </PropertyGroup>

 <Import Project="$(CoreClrProjectRoot)nativeaot\BuildIntegration\Microsoft.NETCore.Native.targets" />
 <UsingTask TaskName="AppleAppBuilderTask"
 AssemblyFile="$(AppleAppBuilderTasksAssemblyPath)" />

 <!-- FIXME: Once we set up builing appropriate runtime package for iOS-like platforms the following properties should be removed -->
 <Target Name="ConfigureIlcPathsForiOSCrossCompilation">
 <PropertyGroup>
 <IlcPath>$([MSBuild]::NormalizeDirectory('$(RepoRoot)', 'artifacts', 'bin', 'coreclr', '$(HostOS).$(BuildArchitecture).$(CoreCLRConfiguration)', 'ilc'))</IlcPath>
 <IlcToolsPath>$(IlcPath)</IlcToolsPath>
 <IlcSdkPath>$(CoreCLRAotSdkDir)</IlcSdkPath>
 <IlcFrameworkPath>$(LibrariesAllBinArtifactsPath)</IlcFrameworkPath>
 <IlcFrameworkNativePath>$(LibrariesAllBinArtifactsPath)</IlcFrameworkNativePath>
 </PropertyGroup>
 </Target>

 <Target Name="BuildAppBundle"
 AfterTargets="Build"
 DependsOnTargets="ConfigureIlcPathsForiOSCrossCompilation;SetupProperties;ComputeIlcCompileInputs;IlcCompile">

 <PropertyGroup>
 <AppDir>$(MSBuildThisFileDirectory)$(PublishDir)\app</AppDir>
 <IosSimulator Condition="'$(TargetsiOSSimulator)' == 'true'">iPhone 11</IosSimulator>
 <Optimized Condition="'$(Configuration)' == 'Release'">True</Optimized>
 </PropertyGroup>

 <ItemGroup>
 <NativeLibrary Include="%(ManagedBinary.IlcOutputFile)" />
 </ItemGroup>

 <RemoveDir Directories="$(AppDir)" />

 <AppleAppBuilderTask
 UseNativeAOTRuntime="$(UseNativeAOTRuntime)"
 NativeDependencies="@(NativeLibrary)"
 TargetOS="$(TargetOS)"
 Arch="$(TargetArchitecture)"
 ProjectName="$(AppName)"
 Assemblies="@(BundleAssemblies)"
 GenerateXcodeProject="True"
 BuildAppBundle="True"
 DevTeamProvisioning="$(DevTeamProvisioning)"
 OutputDirectory="$(AppDir)"
 Optimized="$(Optimized)"
 InvariantGlobalization="$(InvariantGlobalization)"
 StripSymbolTable="$(StripDebugSymbols)"
 AppDir="$(MSBuildThisFileDirectory)$(PublishDir)" >
 <Output TaskParameter="AppBundlePath" PropertyName="AppBundlePath" />
 <Output TaskParameter="XcodeProjectPath" PropertyName="XcodeProjectPath" />
 </AppleAppBuilderTask>

 <Message Importance="High" Text="Xcode: $(XcodeProjectPath)"/>
 <Message Importance="High" Text="App: $(AppBundlePath)"/>

 </Target>

 <Target Name="RunAppBundle"
 AfterTargets="BuildAppBundle"
 Condition="'$(DeployAndRun)' == 'true'">
 <Exec Condition="'$(TargetOS)' == 'iossimulator'" Command="dotnet xharness apple run --app=$(AppBundlePath) --targets=ios-simulator-64 --output-directory=/tmp/out" />
 <Exec Condition="'$(TargetOS)' == 'ios'" Command="dotnet xharness apple run --app=$(AppBundlePath) --targets=ios-device --output-directory=/tmp/out" />
 </Target>

</Project>

79 changes: 79 additions & 0 deletions
src/mono/sample/iOS-NativeAOT/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
# NativeAOT iOS sample app
@marek-safarmarek-safarFeb 20, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Why is it under mono folder?
@ivanpovazanivanpovazanFeb 20, 2023•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

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.
@ivanpovazanivanpovazanFeb 20, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

FWIW NativeAOT keeps samples here: https://github.com/dotnet/samples/tree/main/core/nativeaot
@filipnavarafilipnavaraFeb 20, 2023•

edited

Loading

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

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.
@ivanpovazanivanpovazanFeb 21, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

@MichalStrehovsky what do you think?
@MichalStrehovskyMichalStrehovskyFeb 21, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

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.
@ivanpovazanivanpovazanFeb 21, 2023•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

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.
@MichalStrehovskyMichalStrehovskyFeb 21, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

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 :)
@ivanpovazanivanpovazanFeb 21, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

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.
@jkotasjkotasFeb 21, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

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.

## Description

This sample application is intended to be used by developers who work on enabling NativeAOT on iOS-like platforms and can serve as PoC for verifying support for the following systems:
- ios
- iossimulator
- tvos
- tvossimulator
- maccatalyst

The sample shares the source code with the Mono sample specified at: `../iOS/Program.cs` and in general should have the same behavior as MonoAOT.

## Limitations

The application is **_currently_** relying on the following:
1. Internal dependencies - locally building the internals is required as runtime and tools nuget packages are still not being produced
2. Invariant globalization - `System.Globalization.Native` is currently not being built as part of NativeAOT framework for iOS-like platforms
3. No publish targets - the SDK and MSBuild integration is still not complete

## How to build and test

### Building for the first time

When building for the first time (on a clean checkout) run from this directory the following `make` command:
``` bash
make world
```
This will first build all required runtime components and dependencies, after which it will build the sample app and bundle it into an application bundle.
By default the build will use `Debug` build configuration and target `iossimulator`.
To change this behavior, specify the desired setting in the following way:
``` bash
make world BUILD_CONFIG=Release TARGET_OS=ios
```

### To avoid building all the dependencies

For future builds, you can run just:
``` bash
make
```
which will skip building all the runtime dependencies, assuming those have been already properly built, and build the MSBuild task used for bundling the application and the application it self.

For convenience, it is also possible to rebuild only the application it self with:
``` bash
make hello-app
```

### Deploy and run

#### Simulator

To test the application on a simulator include the following in your make command `DEPLOY_AND_RUN=true` e.g.,:
``` bash
make hello-app DEPLOY_AND_RUN=true
```

#### Device

To test the application on a device, a provisioning profile needs to be specified.
This can be achieved by defining `DevTeamProvisioning` environment variable with a valid team ID (see [developer.apple.com/account/#/membership](https://developer.apple.com/account/#/membership), scroll down to `Team ID`) for example:
``` bash
export DevTeamProvisioning=A1B2C3D4E5; make hello-app TARGET_OS=ios DEPLOY_AND_RUN=true
```
Assuming `A1B2C3D4E5` is a valid team ID.

#### One-liner

On a clean dotnet/runtime checkout, from this directory, run:

``` bash
export DevTeamProvisioning=A1B2C3D4E5; make world BUILD_CONFIG=Release TARGET_OS=ios DEPLOY_AND_RUN=true
```

This command will build everything necessary to run and deploy the application on an iOS device.

### Custom builds

Check the `Makefile` for individual list of targets and variables to customize the build.

2 changes: 1 addition & 1 deletion
src/mono/sample/iOS/Program.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,7 @@ public static async Task Main(string[] args)
 delegate* unmanaged<void> unmanagedPtr = &OnButtonClick;
 ios_register_button_click(unmanagedPtr);
 }
 const string msg = "Hello World!\n.NET 5.0";
 const string msg = "Hello World!\n.NET 8.0";
 for (int i = 0; i < msg.Length; i++)
 {
 // a kind of an animation
Expand Down

10 changes: 10 additions & 0 deletions
src/tasks/AppleAppBuilder/AppleAppBuilder.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -171,6 +171,11 @@ public string TargetOS
 /// </summary>
 public bool UseNativeAOTRuntime { get; set; }

 /// <summary>
 /// Extra native dependencies to link into the app
 /// </summary>
 public string[] NativeDependencies { get; set; } = Array.Empty<string>();

 public void ValidateRuntimeSelection()
 {
 if (UseNativeAOTRuntime)
Expand DownExpand Up@@ -267,6 +272,11 @@ public override bool Execute()
 }
 }

 foreach (var nativeDependency in NativeDependencies)
 {
 assemblerFilesToLink.Add(nativeDependency);
 }

 if (!ForceInterpreter && (isDevice || ForceAOT) && (assemblerFiles.Count == 0 && !UseNativeAOTRuntime))
 {
 throw new InvalidOperationException("Need list of AOT files for device builds.");
Expand Down

11 changes: 10 additions & 1 deletion
src/tasks/AppleAppBuilder/Templates/CMakeLists.txt.template

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,8 @@ add_executable(
 %ProjectName%
 %MainSource%
 ${APP_RESOURCES}
 util.h
 util.m
)

if(NOT %UseNativeAOTRuntime%)
Expand DownExpand Up@@ -73,5 +75,12 @@ target_link_libraries(
 "-lz"
 "-lc++"
 "-liconv"
%NativeLibrariesToLink%
%NativeLibrariesToLink%
)

if(%UseNativeAOTRuntime%)
target_link_libraries(
 %ProjectName%
 "-Wl,-u,_NativeAOT_StaticInitialization"
)
endif()

11 changes: 8 additions & 3 deletions
src/tasks/AppleAppBuilder/Templates/main-simple.m

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,8 @@
#if !USE_NATIVE_AOT
#import "runtime.h"
#else
extern void* NativeAOT_StaticInitialization();
#import <os/log.h>
#import "util.h"
extern int __managed__Main(int argc, char* argv[]);
#endif

Expand DownExpand Up@@ -57,8 +58,12 @@ - (void)viewDidLoad {
#if INVARIANT_GLOBALIZATION
 setenv ("DOTNET_SYSTEM_GLOBALIZATION_INVARIANT", "1", TRUE);
#endif
 NativeAOT_StaticInitialization();
 int ret_val = __managed__Main(0, NULL);
 char **managed_argv;
 int managed_argc = get_managed_args (&managed_argv);
 int ret_val = __managed__Main (managed_argc, managed_argv);
 free_managed_args (&managed_argv, managed_argc);
Comment thread
akoeplinger marked this conversation as resolved.

 os_log_info (OS_LOG_DEFAULT, EXIT_CODE_TAG ": %d", ret_val);
 exit (ret_val);
#endif
 });
}
Expand Down

17 changes: 6 additions & 11 deletions
src/tasks/AppleAppBuilder/Templates/runtime.m

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,15 +20,14 @@
#include <stdlib.h>
#include <stdio.h>

#import "util.h"

static char *bundle_path;

#define APPLE_RUNTIME_IDENTIFIER "//%APPLE_RUNTIME_IDENTIFIER%"

#define RUNTIMECONFIG_BIN_FILE "runtimeconfig.bin"

// XHarness is looking for this tag in app's output to determine the exit code
#define EXIT_CODE_TAG "DOTNET.APP_EXIT_CODE"

const char *
get_bundle_path (void)
{
Expand DownExpand Up@@ -254,14 +253,8 @@
 setenv ("DOTNET_DiagnosticPorts", DIAGNOSTIC_PORTS, true);
#endif

 id args_array = [[NSProcessInfo processInfo] arguments];
 assert ([args_array count] <= 128);
 const char *managed_argv [128];
 int argi;
 for (argi = 0; argi < [args_array count]; argi++) {
 NSString* arg = [args_array objectAtIndex: argi];
 managed_argv[argi] = [arg UTF8String];
 }
 char **managed_argv;
 int argi = get_managed_args (&managed_argv);

 bool wait_for_debugger = FALSE;

Expand DownExpand Up@@ -373,5 +366,7 @@

 mono_jit_cleanup (domain);

 free_managed_args (&managed_argv, argi);

 exit (res);
}

13 changes: 13 additions & 0 deletions
src/tasks/AppleAppBuilder/Templates/util.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

#ifndef util_h
#define util_h

// XHarness is looking for this tag in app's output to determine the exit code
#define EXIT_CODE_TAG "DOTNET.APP_EXIT_CODE"

size_t get_managed_args (char*** managed_args_array);
void free_managed_args (char*** managed_args_array, size_t array_size);

#endif /* util_h */
Loading