Add support for iOS sample app to publish and run with R2R on coreclr

src/coreclr/inc/clrconfigvalues.h

@@ -579,11 +579,7 @@ RETAIL_CONFIG_DWORD_INFO(INTERNAL_CreateDumpDiagnostics, W("CreateDumpDiagnostic
 /// R2R
 ///
 RETAIL_CONFIG_STRING_INFO(INTERNAL_NativeImageSearchPaths, W("NativeImageSearchPaths"), "Extra search paths for native composite R2R images")
-#if defined(TARGET_IOS) || defined(TARGET_TVOS) || defined(TARGET_MACCATALYST)
-RETAIL_CONFIG_DWORD_INFO(EXTERNAL_ReadyToRun, W("ReadyToRun"), 0, "Enable/disable use of ReadyToRun native code") // Off by default for Apple mobile
-#else
 RETAIL_CONFIG_DWORD_INFO(EXTERNAL_ReadyToRun, W("ReadyToRun"), 1, "Enable/disable use of ReadyToRun native code") // On by default for CoreCLR
-#endif // defined(TARGET_IOS) || defined(TARGET_TVOS) || defined(TARGET_MACCATALYST)
 RETAIL_CONFIG_STRING_INFO(EXTERNAL_ReadyToRunExcludeList, W("ReadyToRunExcludeList"), "List of assemblies that cannot use Ready to Run images")
 RETAIL_CONFIG_STRING_INFO(EXTERNAL_ReadyToRunLogFile, W("ReadyToRunLogFile"), "Name of file to log success/failure of using Ready to Run images")
 

src/coreclr/interpreter/eeinterp.cpp

@@ -85,8 +85,8 @@ CorJitResult CILInterp::compileMethod(ICorJitInfo*         compHnd,
                 break;
         }
 
-#ifdef TARGET_WASM
-        // interpret everything on wasm
+#if !defined(FEATURE_JIT)
+        // interpret everything when we do not have a JIT
         doInterpret = true;
 #else
         // NOTE: We do this check even if doInterpret==true in order to populate g_interpModule

src/mono/msbuild/apple/build/AppleBuild.InTree.targets

@@ -33,4 +33,19 @@
     </ItemGroup>
     <Message Text="Used runtime pack: %(ResolvedRuntimePack.PackageDirectory)" Importance="high" />
   </Target>
+
+  <!-- Override the ResolveReadyToRunCompilers target to use the in-build crossgen2.
+       This needs to be imported after SDK targets, so any project requiring this should set AfterMicrosoftNETSdkTargets -->
+  <Target Name="ResolveReadyToRunCompilers" Condition="'$(PublishReadyToRun)' == true" DependsOnTargets="ResolveRuntimeFilesFromLocalBuild">
+    <PropertyGroup>
+      <Crossgen2Path>$([MSBuild]::NormalizePath('$(Crossgen2InBuildDir)', 'crossgen2$(ExeSuffix)'))</Crossgen2Path>
+    </PropertyGroup>
+
+    <ItemGroup>
+      <Crossgen2Tool Include="$(Crossgen2Path)"
+                     TargetArch="$(TargetArchitecture)"
+                     TargetOS="$(TargetOS)"
+                     PerfmapFormatVersion="$(PublishReadyToRunPerfmapFormatVersion)"/>
+    </ItemGroup>
+  </Target>
 </Project>

src/mono/msbuild/apple/build/AppleBuild.targets

@@ -257,7 +257,7 @@
       <_MonoLLVMPath Condition="'$(_MonoLLVMPath)' == '' and '$(MonoEnableLLVM)' == 'true'">$([System.IO.Path]::GetDirectoryName("$(_CompilerBinaryPath)"))</_MonoLLVMPath>
     </PropertyGroup>
 
-    <MonoAOTCompiler Condition="'$(RunAOTCompilation)' == 'true'"
+    <MonoAOTCompiler Condition="'$(RunAOTCompilation)' == 'true' and '$(UseMonoRuntime)' != 'false'"
         AotModulesTablePath="$(_AotModuleTablePath)"
         AotModulesTableLanguage="ObjC"
         Assemblies="@(_AotInputAssemblies)"

src/mono/sample/iOS/Makefile

@@ -11,6 +11,7 @@ APP_SANDBOX?=false
 STRIP_DEBUG_SYMBOLS?=false # only used when measuring SOD via build-appbundle make target
 USE_MONO_RUNTIME?=true
 AOT?=true
+R2R?=false
 
 #If DIAGNOSTIC_PORTS is enabled, @(RuntimeComponents) must also include 'diagnostics_tracing'.
 #If @(RuntimeComponents) includes 'diagnostics_tracing', DIAGNOSTIC_PORTS is optional.
@@ -44,6 +45,7 @@ build-appbundle: clean appbuilder
 	/p:DeployAndRun=false \
 	/p:RunAOTCompilation=$(AOT) \
 	/p:UseMonoRuntime=$(USE_MONO_RUNTIME) \
+	/p:PublishReadyToRun=$(R2R) \
 	/bl
 
 run: clean appbuilder

src/mono/sample/iOS/Program.csproj

@@ -26,15 +26,24 @@
     <BuildAppBundleDependsOnTargets Condition="'$(ArchiveTests)' == 'true'">Publish</BuildAppBundleDependsOnTargets>
   </PropertyGroup>
 
+  <PropertyGroup Condition="'$(PublishReadyToRun)' == 'true' and '$(UseMonoRuntime)' != 'true'">
+    <PublishReadyToRunComposite>true</PublishReadyToRunComposite>
+    <PublishReadyToRunContainerFormat>macho</PublishReadyToRunContainerFormat>
+  </PropertyGroup>
+
   <ItemGroup>
     <RuntimeComponents Condition="'$(DiagnosticPorts)' != ''" Include="diagnostics_tracing" />
-    <EnvironmentVariables Condition="'$(UseMonoRuntime)' != 'true'" Include="DOTNET_Interpreter=%2A%21%2A" />
-    <EnvironmentVariables Condition="'$(UseMonoRuntime)' != 'true'" Include="DOTNET_InterpMode=3" />
-    <EnvironmentVariables Condition="'$(UseMonoRuntime)' != 'true'" Include="DOTNET_ReadyToRun=0" />
   </ItemGroup>
 
+  <!-- Use the repo's CrossGen props/targets.
+       This can be removed once we upstream Mach-O support in the targets to the SDK -->
+  <Import Project="$(Crossgen2SdkOverridePropsPath)" Condition="'$(PublishReadyToRun)' == 'true' and '$(Crossgen2SdkOverridePropsPath)' != ''" />
   <Import Project="$(MonoProjectRoot)\msbuild\apple\build\AppleBuild.props" />
-  <Import Project="$(MonoProjectRoot)\msbuild\apple\build\AppleBuild.InTree.targets" />
+  <PropertyGroup>
+    <!-- Import after SDK targets in order to override R2R-related targets in the SDK -->
+    <AfterMicrosoftNETSdkTargets Condition="'$(PublishReadyToRun)' == 'true' and '$(Crossgen2SdkOverrideTargetsPath)' != ''">$(Crossgen2SdkOverrideTargetsPath)</AfterMicrosoftNETSdkTargets>
+    <AfterMicrosoftNETSdkTargets>$(AfterMicrosoftNETSdkTargets);$(MonoProjectRoot)\msbuild\apple\build\AppleBuild.InTree.targets</AfterMicrosoftNETSdkTargets>
+  </PropertyGroup>
 
   <Target Name="BuildAppBundle" AfterTargets="$(BuildAppBundleAfterTargets)" DependsOnTargets="$(BuildAppBundleDependsOnTargets)"/>
   <Target Name="_SetAppleGenerateAppBundleProps" Condition="'$(TargetOS)' != 'ios' and '$(ArchiveTests)' != 'true'" BeforeTargets="_AppleGenerateAppBundle">

src/tasks/AppleAppBuilder/AppleAppBuilder.csproj

@@ -10,6 +10,7 @@
   <ItemGroup>
     <EmbeddedResource Include="Templates\*.*" />
     <EmbeddedResource Include="$(CoreClrProjectRoot)hosts\inc\coreclrhost.h" Link="Templates\coreclrhost.h" />
+    <EmbeddedResource Include="$(SharedNativeRoot)corehost\host_runtime_contract.h" Link="Templates\host_runtime_contract.h" />
   </ItemGroup>
   <ItemGroup>
     <Compile Include="AppleAppBuilder.cs" />

src/tasks/AppleAppBuilder/Templates/CMakeLists.txt.template

@@ -79,6 +79,12 @@ add_custom_command(
         if ls -1 $CODESIGNING_FOLDER_PATH/*.dylib 2>/dev/null | grep -q .\; then
           codesign --force --sign \"$SIGN_IDENTITY\" --timestamp $CODESIGNING_FOLDER_PATH/*.dylib\;
         fi\;
+        if ls -1 $CODESIGNING_FOLDER_PATH/Contents/Resources/*.r2r.dylib 2>/dev/null | grep -q .\; then
+          codesign --force --sign \"$SIGN_IDENTITY\" --timestamp $CODESIGNING_FOLDER_PATH/Contents/Resources/*.r2r.dylib\;
+        fi\;
+        if ls -1 $CODESIGNING_FOLDER_PATH/*.r2r.dylib 2>/dev/null | grep -q .\; then
+          codesign --force --sign \"$SIGN_IDENTITY\" --timestamp $CODESIGNING_FOLDER_PATH/*.r2r.dylib\;
+        fi\;
       fi\;
     fi
 )

src/tasks/AppleAppBuilder/Templates/runtime-coreclr.m

@@ -3,6 +3,7 @@
 
 #import <Foundation/Foundation.h>
 #include "coreclrhost.h"
+#include "host_runtime_contract.h"
 #include <TargetConditionals.h>
 #import <os/log.h>
 #include <sys/stat.h>
@@ -68,7 +69,7 @@
     return strdup([joined UTF8String]);
 }
 
-void*
+const void*
 pinvoke_override (const char *libraryName, const char *entrypointName)
 {
     if (!strcmp (libraryName, "__Internal"))
@@ -79,6 +80,75 @@
     return NULL;
 }
 
+#include <mach-o/dyld.h>
+#include <mach-o/loader.h>
+size_t get_image_size(const struct mach_header_64* header)
+{
+    const struct load_command* cmd = (const struct load_command*)((const char*)header + sizeof(struct mach_header_64));
+
+    size_t image_size = 0;
+    for (uint32_t j = 0; j < header->ncmds; ++j)
+    {
+        if (cmd->cmd == LC_SEGMENT_64)
+        {
+            const struct segment_command_64* seg = (const struct segment_command_64*)cmd;
+            size_t end_addr = (size_t)(seg->vmaddr + seg->vmsize);
+            if (end_addr > image_size)
+                image_size = end_addr;
+        }
+
+        cmd = (const struct load_command*)((const char*)cmd + cmd->cmdsize);
+    }
+
+    return image_size;
+}
+
+bool get_native_code_data(const struct host_runtime_contract_native_code_context* context, struct host_runtime_contract_native_code_data* data)
+{
+    if (!context || !data || !context->assembly_path || !context->owner_composite_name)
+        return false;
+
+    // Look for the owner composite R2R image in the same directory as the assembly
+    char r2r_path[PATH_MAX];
+    const char *last_slash = strrchr(context->assembly_path, '/');
+    size_t dir_len = last_slash ? (size_t)(last_slash - context->assembly_path) : 0;
+    if (dir_len >= sizeof(r2r_path) - 1)
+        return false;
+
+    strncpy(r2r_path, context->assembly_path, dir_len);
+    int written = snprintf(r2r_path + dir_len, sizeof(r2r_path) - dir_len, "/%s", context->owner_composite_name);
+    if (written <= 0 || (size_t)written >= sizeof(r2r_path) - dir_len)
+        return false;
+
+    void* handle = dlopen(r2r_path, RTLD_LAZY | RTLD_LOCAL);
+    if (handle == NULL)
+        return false;
+
+    void* r2r_header = dlsym(handle, "RTR_HEADER");
+    if (r2r_header == NULL)
+    {
+        dlclose(handle);
+        return false;
+    }
+
+    Dl_info info;
+    if (dladdr(r2r_header, &info) == 0)
+    {
+        dlclose(handle);
+        return false;
+    }
+
+    // The base address points to the Mach header
+    void* base_address = info.dli_fbase;
+    const struct mach_header_64* header = (const struct mach_header_64*)base_address;
+
+    data->size = sizeof(struct host_runtime_contract_native_code_data);
+    data->r2r_header_ptr = r2r_header;
+    data->image_size = get_image_size(header);
+    data->image_base = base_address;
+    return true;
+}
+
 void
 mono_ios_runtime_init (void)
 {
@@ -116,15 +186,22 @@
 #endif
     assert (res > 0);
 
-    char pinvoke_override_addr [16];
-    sprintf (pinvoke_override_addr, "%p", &pinvoke_override);
+    // Contract lasts the lifetime of the app. The app exists before the end of this function.
+    struct host_runtime_contract host_contract = {
+        .size = sizeof(struct host_runtime_contract),
+        .pinvoke_override = &pinvoke_override,
+        .get_native_code_data = &get_native_code_data
+    };
+
+    char contract_str[19]; // 0x + 16 hex digits + '\0'
+    snprintf(contract_str, 19, "0x%zx", (size_t)(&host_contract));
 
     // TODO: set TRUSTED_PLATFORM_ASSEMBLIES, APP_PATHS and NATIVE_DLL_SEARCH_DIRECTORIES
     const char *appctx_keys [] = {
         "RUNTIME_IDENTIFIER",
         "APP_CONTEXT_BASE_DIRECTORY",
         "TRUSTED_PLATFORM_ASSEMBLIES",
-        "PINVOKE_OVERRIDE",
+        "HOST_RUNTIME_CONTRACT",
 #if !defined(INVARIANT_GLOBALIZATION)
         "ICU_DAT_FILE_PATH"
 #endif
@@ -133,7 +210,7 @@
         APPLE_RUNTIME_IDENTIFIER,
         bundle,
         compute_trusted_platform_assemblies(),
-        pinvoke_override_addr,
+        contract_str,
 #if !defined(INVARIANT_GLOBALIZATION)
         icu_dat_path
 #endif

src/tasks/AppleAppBuilder/Xcode.cs

@@ -618,6 +618,8 @@ public string GenerateCMake(
             {
                 File.WriteAllText(Path.Combine(binDir, "coreclrhost.h"),
                     Utils.GetEmbeddedResource("coreclrhost.h"));
+                File.WriteAllText(Path.Combine(binDir, "host_runtime_contract.h"),
+                    Utils.GetEmbeddedResource("host_runtime_contract.h"));
 
                 // NOTE: Library mode is not supported yet
                 File.WriteAllText(Path.Combine(binDir, "runtime.m"),