[mono] Add iOS app builder project #34563

EgorBo · 2020-04-05T13:18:26Z

This PR adds a project with a single msbuild task. This task creates an *.app bundle for iOS (device or simulator) from a list of *.dll files with some simple UI (can be configured).

Usage:

  <UsingTask TaskName="AppleAppBuilderTask" 
             AssemblyFile="$(ArtifactsObjDir)mono\AppleAppBuilder\$(TargetArchitecture)\$(Configuration)\AppleAppBuilder.dll" />

  <Target Name="BuildAppleApp">
    <AppleAppBuilderTask 
        Arch="$(TargetArchitecture)"
        ProjectName="$(ProjectName)"
        Optimized="$(Optimized)"
        MonoInclude="$(BinDir)include\mono-2.0"
        CrossCompiler="$(BinDir)cross\mono-aot-cross"
        MainLibraryFileName="$(MainLibraryFileName)"
        NativeMainSource="$(NativeMainSource)"
        GenerateXcodeProject="$(GenerateXcodeProject)"
        BuildAppBundle="$(BuildAppBundle)"
        DevTeamProvisioning="$(DevTeamProvisioning)"
        AppDir="$(AppDir)">
        <Output TaskParameter="AppBundlePath" PropertyName="AppBundlePath" />
        <Output TaskParameter="XcodeProjectPath" PropertyName="XcodeProjectPath" />
    </AppleAppBuilderTask>
    <Message Importance="High" Text="Xcode: $(XcodeProjectPath)"/>
    <Message Importance="High" Text="App: $(AppBundlePath)"/>
  </Target>

For x64 (Simulator) DevTeamProvisioning and CrossCompiler are not required.

How it works

First of all it needs a AppDir directory (e.g. dotnet publish result) with:

Entry point library (e.g. Program.dll) it can be a hand-made xunit runner or a HelloWorld app
All managed dependencies including BCL libraries and System.Private.CoreLib.dll (mono's one)
All static files: libmono.a, libSystem.Native.a, etc.
Other files are bundled as resources (e.g. pdb, configs, etc)

AotCompiler runs FullAOT compilation and produces *.dll.o files with help of clang (it does it in parallel).
Also, it creates modules.m file where it lists all the linking symbols from all *.dll.o.
Then it creates a CMakeLists.txt in order to create an xcode project via cmake.
That xcode project produces app bundles via xcodebuild command.

These app bundles are ready-to-use e.g. to be deployed to simulators via xcrun simctl install/launch or to real devices via mlaunch or ios-deploy tools.

Notes:
FullAOT compilation is used only for arm64 builds
Some tests crash (e.g. all with remote executor)

I'll add a hand-made xunit runner app in a separate PR.

How to run the sample:

git clone git@github.com:dotnet/runtime.git
cd runtime/src/mono/netcore/iOS
make MONO_ARCH=arm64

/cc @steveisok @marek-safar @akoeplinger

…ntime

src/mono/netcore/sample/iOS/Makefile

marek-safar

/cc @rolfbjarne

src/mono/IosAppBuilderTasks/AotCompiler.cs

src/mono/IosAppBuilderTasks/IosAppBuilderTask.cs

src/mono/IosAppBuilderTasks/IosAppBuilderTasks.csproj

src/mono/IosAppBuilderTasks/IosAppBuilderTask.cs

rolfbjarne · 2020-04-06T11:30:29Z

Is this a task that you're going to ship? Or is it for internal consumption? What we need is a task that only does the AOT compilation (takes the managed assemblies as input, and produces .o/.m files as output).

EgorBo · 2020-04-06T11:34:59Z

What we need is a task that only does the AOT compilation

It'd make sense to sync with @akoeplinger as he has been working on same thing

@marek-safar @rolfbjarne It looks like there is a miscommunication, I was asked to make a task from my makefile scripts to produce app bundles from libraries (tests)

# Conflicts: # src/mono/mono.proj

src/mono/IosAppBuilderTasks/Utils.cs

src/mono/IosAppBuilderTasks/Xcode.cs

src/mono/mono.proj

marek-safar · 2020-04-07T14:43:13Z

src/mono/AppleAppBuilder/AppleAppBuilder.cs

+                .Select(i => i.ItemSpec)
+                .ToArray();
+        }
+        string[] libsToAot = Directory.GetFiles(AppDir, "*.dll")


I still think this should come as input to the task (e.g. from publish)

the AppDir is basically the dotnet publish location - we need everything in the directory anyway.
Collection of files as an input makes it harder to use via command line 🙁

marek-safar · 2020-04-07T14:46:00Z

src/mono/mono.proj

+        Arch="$(TargetArchitecture)"
+        ProjectName="$(ProjectName)"
+        Optimized="$(Optimized)"
+        MonoInclude="$(BinDir)include\mono-2.0"


This should better come from runtime pack

cc @steveisok @akoeplinger
how do I build the "runtime pack", I've just built my repo with build.sh -c Release -os iOS -arch arm64 -subset Mono+Libs+Libs.Tests and don't see any runtime packs. The only location where I can find mono-2.0 headers and mono-aot-cross is this $(BinDir)

It's in a PR. You'll have to update src/mono/netcore/sample/iOS/Program.csproj when it's ready.

steveisok · 2020-04-10T13:54:53Z

src/mono/mono.proj

+        ProjectName="$(ProjectName)"
+        Optimized="$(Optimized)"
+        MonoInclude="$(BinDir)include\mono-2.0"
+        CrossCompiler="$(BinDir)cross\mono-aot-cross"


This should also come from the runtime pack.

akoeplinger

LGTM once you address the comments

akoeplinger · 2020-04-10T16:41:25Z

src/mono/msbuild/AppleAppBuilder/Utils.cs

+        }
+
+        Process process = Process.Start(processStartInfo)!;
+        process.ErrorDataReceived += (sender, e) =>


We should attach ErrorDataReceived and OutputDataReceived before we start the process or we could miss some output.

And maybe also follow the recommendations from #18789 (comment)

We should attach ErrorDataReceived and OutputDataReceived before we start the process or we could miss some output.

Looks like it won't miss anything, furthermore you can't start listening for outputs before you start the actual process - it throws StandardOut has not been redirected or the process hasn't started yet

#18789 (comment) doesn't apply here since I actually use the parameterless overload

steveisok · 2020-04-13T16:44:05Z

@marek-safar I think this is good to go. We'll likely need a follow up PR once the in-tree runtime pack functionality is there. Since we want to make available some kind of test runner, I think this PR shouldn't wait.

marek-safar

@steveisok please extract the remaining work items into tracking issue

EgorBo added 3 commits April 5, 2020 15:26

Add iosAppBuilderTasks project

610b50a

Escape spaces in ProjectName

df88839

Remove add_definitions(-DDEVICE)

f7d8299

EgorBo requested a review from marek-safar as a code owner April 5, 2020 13:18

Dotnet-GitSync-Bot added the area-Infrastructure label Apr 5, 2020

EgorBo added area-Infrastructure-mono os-ios Apple iOS and removed area-Infrastructure labels Apr 5, 2020

EgorBo requested review from steveisok and akoeplinger April 5, 2020 13:19

EgorBo added 2 commits April 5, 2020 20:46

Fix typoe Buillder -> Builder, also build the task as part of mono ru…

08d6e92

…ntime

Rewrite HelloiOS sample (to use the task)

bafe2e4

EgorBo requested a review from vargaz as a code owner April 5, 2020 19:11

EgorBo added 3 commits April 5, 2020 22:20

Fix build

ee568ec

Clean up

8449e82

Add license headers

15a1682

EgorBo commented Apr 5, 2020

View reviewed changes

src/mono/netcore/sample/iOS/Makefile Show resolved Hide resolved

EgorBo added 2 commits April 6, 2020 03:30

Clean up

19390d1

dont build app if provisionig is not set

183482b

marek-safar requested changes Apr 6, 2020

View reviewed changes

EgorBo added 3 commits April 6, 2020 14:38

Add ExcludeFromAppDir input argument, remove stopwatch

52a3b20

Merge branch 'master' of github.com:dotnet/runtime into ios-app-builder

ee1531e

# Conflicts: # src/mono/mono.proj

Drop DOTNET_SYSTEM_GLOBALIZATION_INVARIANT

fd8e6c6

marek-safar reviewed Apr 7, 2020

View reviewed changes

src/mono/IosAppBuilderTasks/Utils.cs Outdated Show resolved Hide resolved

marek-safar reviewed Apr 7, 2020

View reviewed changes

src/mono/IosAppBuilderTasks/Utils.cs Outdated Show resolved Hide resolved

marek-safar reviewed Apr 7, 2020

View reviewed changes

src/mono/IosAppBuilderTasks/Xcode.cs Outdated Show resolved Hide resolved

marek-safar reviewed Apr 7, 2020

View reviewed changes

src/mono/mono.proj Outdated Show resolved Hide resolved

Merge branch 'master' of github.com:dotnet/runtime into ios-app-builder

a80d1e9

EgorBo added 4 commits April 7, 2020 15:18

Address feedback

0afb383

Validate input

22ada4a

fix build

89f05c1

Disable GenerateXcodeProject by default

be52a9d

marek-safar reviewed Apr 7, 2020

View reviewed changes

jaredpar mentioned this pull request Apr 7, 2020

CI / PR having issues provisioning resources #34647

Closed

EgorBo added 5 commits April 8, 2020 10:37

Merge branch 'master' of github.com:dotnet/runtime into ios-app-builder

5de1957

move to mono/msbuild

0029a05

Add OutputDirectory property

15c013d

Fix sample

fdd7f4b

Minor improvements

aa6d96a

steveisok reviewed Apr 10, 2020

View reviewed changes

steveisok approved these changes Apr 10, 2020

View reviewed changes

akoeplinger approved these changes Apr 10, 2020

View reviewed changes

EgorBo added 2 commits April 13, 2020 13:09

fix build issues

5c11b22

Merge branch 'master' of github.com:dotnet/runtime into ios-app-builder

bfcd8c9

marek-safar approved these changes Apr 14, 2020

View reviewed changes

marek-safar merged commit dda0a57 into dotnet:master Apr 14, 2020

jaredpar mentioned this pull request Apr 23, 2020

Errors installing the SDK during builds #34015

Closed

ghost locked as resolved and limited conversation to collaborators Dec 9, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[mono] Add iOS app builder project #34563

[mono] Add iOS app builder project #34563

EgorBo commented Apr 5, 2020 •

edited

marek-safar left a comment

rolfbjarne commented Apr 6, 2020

EgorBo commented Apr 6, 2020 •

edited

marek-safar Apr 7, 2020

EgorBo Apr 13, 2020 •

edited

marek-safar Apr 7, 2020

EgorBo Apr 13, 2020

steveisok Apr 13, 2020 •

edited

steveisok Apr 10, 2020

akoeplinger left a comment

akoeplinger Apr 10, 2020

akoeplinger Apr 10, 2020

EgorBo Apr 13, 2020

EgorBo Apr 13, 2020

steveisok commented Apr 13, 2020

marek-safar left a comment

[mono] Add iOS app builder project #34563

[mono] Add iOS app builder project #34563

Conversation

EgorBo commented Apr 5, 2020 • edited

Usage:

How it works

How to run the sample:

marek-safar left a comment

Choose a reason for hiding this comment

rolfbjarne commented Apr 6, 2020

EgorBo commented Apr 6, 2020 • edited

Choose a reason for hiding this comment

EgorBo Apr 13, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

steveisok Apr 13, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

akoeplinger left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

steveisok commented Apr 13, 2020

marek-safar left a comment

Choose a reason for hiding this comment

EgorBo commented Apr 5, 2020 •

edited

EgorBo commented Apr 6, 2020 •

edited

EgorBo Apr 13, 2020 •

edited

steveisok Apr 13, 2020 •

edited