Skip to content

Commit

Permalink
C#+iOS: Cache AOT compilater output
Browse files Browse the repository at this point in the history
Implemented some basic caching to avoid unnecessary AOT compilation
of unchanged assemblies that were already compiled previously.
This reduces iOS export times considerably for subsequent builds
since many dependencies never change, such as framework assemblies
and the Godot bindings.

The AOT compiler asm output and object files are now placed in
`res://.mono/temp/obj/<CONFIG>/godot-aot-cache/` instead of a
temporary directory.
  • Loading branch information
neikeq committed Aug 2, 2021
1 parent 4542e33 commit e72fdc4
Show file tree
Hide file tree
Showing 2 changed files with 195 additions and 34 deletions.
85 changes: 51 additions & 34 deletions modules/mono/editor/GodotTools/GodotTools/Export/AotBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -249,55 +249,72 @@ string CompileForArch(string arch)

var aotObjFilePaths = new List<string>(assemblies.Count);

foreach (var assembly in assemblies)
{
string assemblyName = assembly.Key;
string assemblyPath = assembly.Value;
string compilerDirPath = Path.Combine(GodotSharpDirs.DataEditorToolsDir, "aot-compilers",
$"{OS.Platforms.iOS}-arm64");
string crossCompiler = FindCrossCompiler(compilerDirPath);

string aotCacheDir = Path.Combine(ProjectSettings.GlobalizePath(GodotSharpDirs.ResTempDir),
"obj", isDebug ? "ExportDebug" : "ExportRelease", "godot-aot-cache");

if (!Directory.Exists(aotCacheDir))
Directory.CreateDirectory(aotCacheDir);

string asmFileName = assemblyName + ".dll.S";
string objFileName = assemblyName + ".dll.o";
var aotCache = new AotCache(Path.Combine(aotCacheDir, "cache.json"));

try
{
foreach (var assembly in assemblies)
{
string asmFilePath = Path.Combine(aotTempDir, asmFileName);
string assemblyName = assembly.Key;
string assemblyPath = assembly.Value;

var compilerArgs = GetAotCompilerArgs(OS.Platforms.iOS, isDebug, "arm64", aotOpts, assemblyPath, asmFilePath);
string asmFilePath = Path.Combine(aotCacheDir, assemblyName + ".dll.S");
string objFilePath = Path.Combine(aotCacheDir, assemblyName + ".dll.o");

string compilerDirPath = Path.Combine(GodotSharpDirs.DataEditorToolsDir, "aot-compilers", $"{OS.Platforms.iOS}-arm64");
aotCache.RunCached(name: assemblyName, input: assemblyPath, output: objFilePath, () =>
{
Console.WriteLine($"AOT compiler: Compiling '{assemblyName}'...");

ExecuteCompiler(FindCrossCompiler(compilerDirPath), compilerArgs, bclDir);
var compilerArgs = GetAotCompilerArgs(OS.Platforms.iOS, isDebug,
"arm64", aotOpts, assemblyPath, asmFilePath);

// Assembling
const string iOSPlatformName = "iPhoneOS";
const string versionMin = "10.0"; // TODO: Turn this hard-coded version into an exporter setting
string iOSSdkPath = Path.Combine(XcodeHelper.XcodePath,
$"Contents/Developer/Platforms/{iOSPlatformName}.platform/Developer/SDKs/{iOSPlatformName}.sdk");
ExecuteCompiler(crossCompiler, compilerArgs, bclDir);

string objFilePath = Path.Combine(aotTempDir, objFileName);
// Assembling
const string iOSPlatformName = "iPhoneOS";
const string versionMin = "10.0"; // TODO: Turn this hard-coded version into an exporter setting
string iOSSdkPath = Path.Combine(XcodeHelper.XcodePath,
$"Contents/Developer/Platforms/{iOSPlatformName}.platform/Developer/SDKs/{iOSPlatformName}.sdk");

var clangArgs = new List<string>()
{
"-isysroot", iOSSdkPath,
"-Qunused-arguments",
$"-miphoneos-version-min={versionMin}",
"-arch", "arm64",
"-c",
"-o", objFilePath,
"-x", "assembler"
};
var clangArgs = new List<string>()
{
"-isysroot", iOSSdkPath,
"-Qunused-arguments",
$"-miphoneos-version-min={versionMin}",
"-arch", "arm64",
"-c",
"-o", objFilePath,
"-x", "assembler"
};

if (isDebug)
clangArgs.Add("-DDEBUG");
if (isDebug)
clangArgs.Add("-DDEBUG");

clangArgs.Add(asmFilePath);
clangArgs.Add(asmFilePath);

int clangExitCode = OS.ExecuteCommand(XcodeHelper.FindXcodeTool("clang"), clangArgs);
if (clangExitCode != 0)
throw new Exception($"Command 'clang' exited with code: {clangExitCode}");
int clangExitCode = OS.ExecuteCommand(XcodeHelper.FindXcodeTool("clang"), clangArgs);
if (clangExitCode != 0)
throw new Exception($"Command 'clang' exited with code: {clangExitCode}");
});

aotObjFilePaths.Add(objFilePath);
}

aotModuleInfoSymbols.Add($"mono_aot_module_{AssemblyNameToAotSymbol(assemblyName)}_info");
aotModuleInfoSymbols.Add($"mono_aot_module_{AssemblyNameToAotSymbol(assemblyName)}_info");
}
}
finally
{
aotCache.SaveCache();
}

RunAr(aotObjFilePaths, libAotFilePath);
Expand Down
144 changes: 144 additions & 0 deletions modules/mono/editor/GodotTools/GodotTools/Export/AotCache.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,144 @@
using System;
using System.Collections.Generic;
using System.IO;
using System.Security.Cryptography;
using System.Text;
using Newtonsoft.Json;

namespace GodotTools.Export
{
public class AotCache
{
private readonly string _cacheFilePath;
private readonly Cache _cache = new Cache();
private bool _hasUnsavedChanges = false;

public AotCache(string cacheFilePath)
{
_cacheFilePath = cacheFilePath;

if (File.Exists(_cacheFilePath))
LoadCache(_cacheFilePath, out _cache);
}

private static byte[] ComputeSha256Checksum(string filePath)
{
using (var sha256 = SHA256.Create())
{
using (var streamReader = File.OpenRead(filePath))
return sha256.ComputeHash(streamReader);
}
}

private static bool CompareHashes(byte[] a, byte[] b)
{
if (a.Length != b.Length)
return false;

for (int i = 0; i < a.Length; i++)
{
if (a[i] != b[i])
return false;
}

return true;
}

private class Cache
{
[JsonProperty("assemblies")]
public Dictionary<string, CachedChecksums> Assemblies { get; set; } =
new Dictionary<string, CachedChecksums>();
}

private struct CachedChecksums
{
[JsonProperty("input_checksum")] public string InputChecksumBase64 { get; set; }
[JsonProperty("output_checksum")] public string OutputChecksumBase64 { get; set; }
}

private static void LoadCache(string cacheFilePath, out Cache cache)
{
using (var streamReader = new StreamReader(cacheFilePath, Encoding.UTF8))
using (var jsonReader = new JsonTextReader(streamReader))
{
cache = new JsonSerializer().Deserialize<Cache>(jsonReader);
}
}

private static void SaveCache(string cacheFilePath, Cache cache)
{
using (var streamWriter = new StreamWriter(cacheFilePath, append: false, Encoding.UTF8))
using (var jsonWriter = new JsonTextWriter(streamWriter))
{
new JsonSerializer().Serialize(jsonWriter, cache);
}
}

private bool TryGetCachedChecksums(string name, out CachedChecksums cachedChecksums)
=> _cache.Assemblies.TryGetValue(name, out cachedChecksums);

private void ChangeCache(string name, byte[] inputChecksum, byte[] outputChecksum)
{
_cache.Assemblies[name] = new CachedChecksums()
{
InputChecksumBase64 = Convert.ToBase64String(inputChecksum),
OutputChecksumBase64 = Convert.ToBase64String(outputChecksum)
};
_hasUnsavedChanges = true;
}

public void SaveCache()
{
if (!_hasUnsavedChanges)
return;
SaveCache(_cacheFilePath, _cache);
_hasUnsavedChanges = false;
}

private bool IsCached(string name, byte[] inputChecksum, string output)
{
if (!File.Exists(output))
{
return false;
}

if (!TryGetCachedChecksums(name, out var cachedChecksums))
return false;

if (string.IsNullOrEmpty(cachedChecksums.InputChecksumBase64) ||
string.IsNullOrEmpty(cachedChecksums.OutputChecksumBase64))
return false;

var cachedInputChecksum = Convert.FromBase64String(cachedChecksums.InputChecksumBase64);

if (!CompareHashes(inputChecksum, cachedInputChecksum))
return false;

var outputChecksum = ComputeSha256Checksum(output);
var cachedOutputChecksum = Convert.FromBase64String(cachedChecksums.OutputChecksumBase64);

if (!CompareHashes(outputChecksum, cachedOutputChecksum))
return false;

return true;
}

public void RunCached(string name, string input, string output, Action action)
{
var inputChecksum = ComputeSha256Checksum(input);

if (IsCached(name, inputChecksum, output))
{
Console.WriteLine($"AOT compiler cache: '{name}' already compiled.");
return;
}

action();

var outputChecksum = ComputeSha256Checksum(output);

ChangeCache(name, inputChecksum, outputChecksum);
}
}
}

1 comment on commit e72fdc4

@neikeq
Copy link
Contributor Author

@neikeq neikeq commented on e72fdc4 Sep 24, 2021

Choose a reason for hiding this comment

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

C#+iOS: Cache AOT compilater output

I will have to live with this typo for the rest of my life.

Please sign in to comment.