[mono] Add iOS app builder project #34563
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,138 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
| // See the LICENSE file in the project root for more information. | ||
|
|
||
| using System; | ||
| using System.Collections.Generic; | ||
| using System.IO; | ||
| using System.Text; | ||
| using System.Threading.Tasks; | ||
|
|
||
| internal class AotCompiler | ||
| { | ||
| /// <summary> | ||
| /// Precompile all assemblies in parallel | ||
| /// </summary> | ||
| public static void PrecompileLibraries( | ||
| string crossCompiler, | ||
| string arch, | ||
| bool parallel, | ||
| string binDir, | ||
| string[] libsToPrecompile, | ||
| IDictionary<string, string> envVariables, | ||
| bool optimize) | ||
| { | ||
| Parallel.ForEach(libsToPrecompile, | ||
| new ParallelOptions { MaxDegreeOfParallelism = parallel ? Environment.ProcessorCount : 1 }, | ||
| lib => PrecompileLibrary(crossCompiler, binDir, lib, envVariables, optimize)); | ||
| } | ||
|
|
||
| private static void PrecompileLibrary( | ||
| string crossCompiler, | ||
| string arch, | ||
| string binDir, | ||
| string libToPrecompile, | ||
| IDictionary<string, string> envVariables, | ||
| bool optimize) | ||
| { | ||
| Utils.LogInfo($"[AOT] {libToPrecompile}"); | ||
|
|
||
| var crossArgs = new StringBuilder(); | ||
| crossArgs | ||
| .Append(" -O=gsharedvt,float32") | ||
| .Append(" --nollvm") | ||
| .Append(" --debug"); | ||
|
|
||
| string libName = Path.GetFileNameWithoutExtension(libToPrecompile); | ||
| var aotArgs = new StringBuilder(); | ||
| aotArgs | ||
| .Append("mtriple=".Append(arch).Append("-ios,") | ||
| .Append("static,") | ||
| .Append("asmonly,") | ||
| .Append("direct-icalls,") | ||
| .Append("no-direct-calls,") | ||
| .Append("dwarfdebug,") | ||
| .Append("outfile=").Append(Path.Combine(binDir, libName + ".dll.s,")) | ||
| // TODO: | ||
| //.Append("data-outfile=").Append(Path.Combine(binDir, libName + ".aotdata,")) | ||
| .Append("full,"); | ||
|
|
||
| // TODO: enable Interpreter | ||
| // TODO: enable LLVM | ||
| // TODO: enable System.Runtime.Intrinsics.Arm (LLVM-only for now) | ||
| // e.g. .Append("mattr=+crc,") | ||
|
|
||
| crossArgs | ||
| .Append(" --aot=").Append(aotArgs).Append(" ") | ||
| .Append(libToPrecompile); | ||
|
|
||
| Utils.RunProcess(crossCompiler, crossArgs.ToString(), envVariables, binDir); | ||
|
|
||
| var clangArgs = new StringBuilder(); | ||
| if (optimize) | ||
| { | ||
| clangArgs.Append(" -Os"); | ||
| } | ||
| clangArgs | ||
| .Append(" -isysroot ").Append(Xcode.Sysroot) | ||
| .Append(" -miphoneos-version-min=10.1") | ||
| .Append(" -arch ").Append(arch) | ||
| .Append(" -c ").Append(Path.Combine(binDir, libName)).Append(".dll.s") | ||
| .Append(" -o ").Append(Path.Combine(binDir, libName)).Append(".dll.o"); | ||
|
|
||
| Utils.RunProcess("clang", clangArgs.ToString(), workingDir: binDir); | ||
| } | ||
|
|
||
| public static void GenerateLinkAllFile(string[] objFiles, string outputFile) | ||
| { | ||
| // Generates 'modules.m' in order to register all managed libraries | ||
| // | ||
| // | ||
| // extern void *mono_aot_module_Lib1_info; | ||
| // extern void *mono_aot_module_Lib2_info; | ||
| // ... | ||
| // | ||
| // void mono_ios_register_modules (void) | ||
| // { | ||
| // mono_aot_register_module (mono_aot_module_Lib1_info); | ||
| // mono_aot_register_module (mono_aot_module_Lib2_info); | ||
| // ... | ||
| // } | ||
|
|
||
| Utils.LogInfo("Generating 'modules.m'..."); | ||
|
|
||
| var lsDecl = new StringBuilder(); | ||
| lsDecl | ||
| .AppendLine("#include <mono/jit/jit.h>") | ||
| .AppendLine("#include <TargetConditionals.h>") | ||
| .AppendLine() | ||
| .AppendLine("#if TARGET_OS_IPHONE && !TARGET_IPHONE_SIMULATOR") | ||
| .AppendLine(); | ||
|
|
||
| var lsUsage = new StringBuilder(); | ||
| lsUsage | ||
| .AppendLine("void mono_ios_register_modules (void)") | ||
| .AppendLine("{"); | ||
| foreach (string objFile in objFiles) | ||
| { | ||
| string symbol = "mono_aot_module_" + | ||
| Path.GetFileName(objFile) | ||
| .Replace(".dll.o", "") | ||
| .Replace(".", "_") | ||
| .Replace("-", "_") + "_info"; | ||
|
|
||
| lsDecl.Append("extern void *").Append(symbol).Append(';').AppendLine(); | ||
| lsUsage.Append("\tmono_aot_register_module (").Append(symbol).Append(");").AppendLine(); | ||
| } | ||
| lsDecl | ||
| .AppendLine() | ||
| .Append(lsUsage) | ||
| .AppendLine("}") | ||
| .AppendLine() | ||
| .AppendLine("#endif") | ||
| .AppendLine(); | ||
|
|
||
| File.WriteAllText(outputFile, lsDecl.ToString()); | ||
| Utils.LogInfo($"Saved to {outputFile}."); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,187 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
| // See the LICENSE file in the project root for more information. | ||
|
|
||
| using System; | ||
| using System.Collections.Generic; | ||
| using System.Diagnostics; | ||
| using System.IO; | ||
| using System.Linq; | ||
| using Microsoft.Build.Framework; | ||
| using Microsoft.Build.Utilities; | ||
|
|
||
| public class AppleAppBuilderTask : Task | ||
| { | ||
| /// <summary> | ||
| /// Path to arm64 AOT cross-compiler (mono-aot-cross) | ||
| /// It's not used for x64 (Simulator) | ||
| /// </summary> | ||
| public string? CrossCompiler { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// ProjectName is used as an app name, bundleId and xcode project name | ||
| /// </summary> | ||
| [Required] | ||
| public string ProjectName { get; set; } = ""!; | ||
|
|
||
| /// <summary> | ||
| /// Target directory with *dll and other content to be AOT'd and/or bundled | ||
| /// </summary> | ||
| [Required] | ||
| public string AppDir { get; set; } = ""!; | ||
|
|
||
| /// <summary> | ||
| /// Path to Mono public headers (*.h) | ||
| /// </summary> | ||
| [Required] | ||
| public string MonoInclude { get; set; } = ""!; | ||
|
|
||
| /// <summary> | ||
| /// This library will be used as an entry-point (e.g. TestRunner.dll) | ||
| /// </summary> | ||
| [Required] | ||
| public string MainLibraryFileName { get; set; } = ""!; | ||
|
|
||
| /// <summary> | ||
| /// Path to store build artifacts | ||
| /// </summary> | ||
| public string? OutputDirectory { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// Produce optimized binaries (e.g. use -O2 in AOT) | ||
| /// and use 'Release' config in xcode | ||
| /// </summary> | ||
| public bool Optimized { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// Disable parallel AOT compilation | ||
| /// </summary> | ||
| public bool DisableParallelAot { get; set; }; | ||
|
|
||
| /// <summary> | ||
| /// Target arch, can be "arm64" (device) or "x64" (simulator) at the moment | ||
| /// </summary> | ||
| [Required] | ||
| public string Arch { get; set; } = ""!; | ||
|
|
||
| /// <summary> | ||
| /// DEVELOPER_TEAM provisioning, needed for arm64 builds. | ||
| /// </summary> | ||
| public string? DevTeamProvisioning { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// Build *.app bundle (using XCode for now) | ||
| /// </summary> | ||
| public bool BuildAppBundle { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// Generate xcode project | ||
| /// </summary> | ||
| public bool GenerateXcodeProject { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// Files to be ignored in AppDir | ||
| /// </summary> | ||
| public ITaskItem[]? ExcludeFromAppDir { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// Path to a custom main.m with custom UI | ||
| /// A default one is used if it's not set | ||
| /// </summary> | ||
| public string? NativeMainSource { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// Use Console-style native UI template | ||
| /// (use NativeMainSource to override) | ||
| /// </summary> | ||
| public bool UseConsoleUITemplate { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// Path to *.app bundle | ||
| /// </summary> | ||
| [Output] | ||
| public string AppBundlePath { get; set; } = ""!; | ||
|
|
||
| /// <summary> | ||
| /// Path to xcode project | ||
| /// </summary> | ||
| [Output] | ||
| public string XcodeProjectPath { get; set; } = ""!; | ||
|
|
||
| public override bool Execute() | ||
| { | ||
| Utils.Logger = Log; | ||
| bool isDevice = Arch.Equals("arm64", StringComparison.InvariantCultureIgnoreCase); | ||
| if (isDevice && string.IsNullOrEmpty(CrossCompiler)) | ||
| { | ||
| throw new ArgumentException("arm64 arch requires CrossCompiler"); | ||
| } | ||
|
|
||
| if (!File.Exists(Path.Combine(AppDir, MainLibraryFileName))) | ||
| { | ||
| throw new ArgumentException($"MainLibraryFileName='{MainLibraryFileName}' was not found in AppDir='{AppDir}'"); | ||
| } | ||
|
|
||
| // escape spaces | ||
| ProjectName = ProjectName.Replace(" ", "-"); | ||
|
|
||
| string[] excludes = new string[0]; | ||
| if (ExcludeFromAppDir != null) | ||
| { | ||
| excludes = ExcludeFromAppDir | ||
| .Where(i => !string.IsNullOrEmpty(i.ItemSpec)) | ||
| .Select(i => i.ItemSpec) | ||
| .ToArray(); | ||
| } | ||
| string[] libsToAot = Directory.GetFiles(AppDir, "*.dll") | ||
| .Where(f => !excludes.Contains(Path.GetFileName(f))) | ||
| .ToArray(); | ||
|
|
||
| string binDir = Path.Combine(AppDir, $"bin-{ProjectName}-{Arch}"); | ||
| if (!string.IsNullOrEmpty(OutputDirectory)) | ||
| { | ||
| binDir = OutputDirectory; | ||
| } | ||
| Directory.CreateDirectory(binDir); | ||
|
|
||
| // run AOT compilation only for devices | ||
| if (isDevice) | ||
| { | ||
| if (string.IsNullOrEmpty(CrossCompiler)) | ||
| throw new InvalidOperationException("cross-compiler is not set"); | ||
|
|
||
| AotCompiler.PrecompileLibraries(CrossCompiler, Arch, !DisableParallelAot, binDir, libsToAot, | ||
| new Dictionary<string, string> { {"MONO_PATH", AppDir} }, | ||
| Optimized); | ||
| } | ||
|
|
||
| // generate modules.m | ||
| AotCompiler.GenerateLinkAllFile( | ||
| Directory.GetFiles(binDir, "*.dll.o"), | ||
| Path.Combine(binDir, "modules.m")); | ||
|
|
||
| if (GenerateXcodeProject) | ||
| { | ||
| XcodeProjectPath = Xcode.GenerateXCode(ProjectName, MainLibraryFileName, | ||
| AppDir, binDir, MonoInclude, UseConsoleUITemplate, NativeMainSource); | ||
|
|
||
| if (BuildAppBundle) | ||
| { | ||
| if (isDevice && string.IsNullOrEmpty(DevTeamProvisioning)) | ||
| { | ||
| // DevTeamProvisioning shouldn't be empty for arm64 builds | ||
| Utils.LogInfo("DevTeamProvisioning is not set, BuildAppBundle step is skipped."); | ||
| } | ||
| else | ||
| { | ||
| AppBundlePath = Xcode.BuildAppBundle( | ||
| Path.Combine(binDir, ProjectName, ProjectName + ".xcodeproj"), | ||
| Arch, Optimized, DevTeamProvisioning); | ||
| } | ||
| } | ||
| Utils.LogInfo($"Xcode: {XcodeProjectPath}\n App: {AppBundlePath}"); | ||
| } | ||
|
|
||
| return true; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| <Project Sdk="Microsoft.NET.Sdk"> | ||
| <PropertyGroup> | ||
| <OutputType>Library</OutputType> | ||
| <OutputPath>bin</OutputPath> | ||
| <TargetFramework>$(NetCoreAppCurrent)</TargetFramework> | ||
| <Nullable>enable</Nullable> | ||
| <TreatWarningsAsErrors>true</TreatWarningsAsErrors> | ||
| <EnableDefaultCompileItems>false</EnableDefaultCompileItems> | ||
| </PropertyGroup> | ||
| <ItemGroup> | ||
| <EmbeddedResource Include="Templates\*.*" /> | ||
| </ItemGroup> | ||
| <ItemGroup> | ||
| <PackageReference Include="Microsoft.Build" Version="$(RefOnlyMicrosoftBuildVersion)" /> | ||
| <PackageReference Include="Microsoft.Build.Framework" Version="$(RefOnlyMicrosoftBuildFrameworkVersion)" /> | ||
| <PackageReference Include="Microsoft.Build.Tasks.Core" Version="$(RefOnlyMicrosoftBuildTasksCoreVersion)" /> | ||
| <PackageReference Include="Microsoft.Build.Utilities.Core" Version="$(RefOnlyMicrosoftBuildUtilitiesCoreVersion)" /> | ||
| </ItemGroup> | ||
| <ItemGroup> | ||
| <Compile Include="AotCompiler.cs" /> | ||
| <Compile Include="AppleAppBuilder.cs" /> | ||
| <Compile Include="Utils.cs" /> | ||
| <Compile Include="Xcode.cs" /> | ||
| </ItemGroup> | ||
| </Project> |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should better come from runtime pack
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.Testsand don't see any runtime packs. The only location where I can findmono-2.0headers andmono-aot-crossis this$(BinDir)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's in a PR. You'll have to update
src/mono/netcore/sample/iOS/Program.csprojwhen it's ready.