[clr-interp] Enable CoreCLR interpreter functional test on iOS and MacCatalyst (#119177)

* [clr-interp] Setup fully interpreted functional test on Apple mobile

* Run tests in runtime.yml pipeline

* Run arm64 architecture only

* Fix build

* Remove tvOS platform

* Test linker option

* Fix compiler flag

* Link interpreter into coreclr library

* Fix wasm build

* Test maccatalyst build

* Revery no-overriding-t-option flag

* Test maccatalyst build

* Revert no-overriding-t-option flag

* Test maccatalyst build

* Add SystemNative_Log and SystemNative_LogError declarations

* Remove tvos_arm64 platform

* Update APPLE_RUNTIME_IDENTIFIER to use placeholder

* Update maccatalyst build args

* Use checked configuration

* Remove iOS device build from runtime pipeline

* Fix interpreter build exports

* Fix failing build

* Fix R2R condition

* Test debug config

* Test checked build on MacCatalyst and simulator

* Test debug config

* Test checked configuration

* Fix comment

* Remove dependency on dn-containers

* Define PAL_JitWriteProtect macro for platforms that don't allow JIT write protection

* Update install_clr destination to sharedFramework

* Fix build

Author: kotlarmilos

eng/native/build-commons.sh

@@ -89,7 +89,11 @@ build_native()
     fi
 
     if [[ "$targetOS" == maccatalyst ]]; then
-        cmakeArgs="-DCMAKE_SYSTEM_VARIANT=maccatalyst $cmakeArgs"
+        cmakeArgs="-C $__RepoRootDir/eng/native/tryrun_ios_tvos.cmake $cmakeArgs"
+
+        # set default macCatalyst deployment target
+        # keep in sync with SetOSTargetMinVersions in the root Directory.Build.props
+        cmakeArgs="-DCMAKE_SYSTEM_NAME=Darwin -DCMAKE_OSX_SYSROOT=macosx -DCMAKE_SYSTEM_VARIANT=maccatalyst -DCMAKE_OSX_DEPLOYMENT_TARGET=15.0 $cmakeArgs"
     fi
 
     if [[ "$targetOS" == android || "$targetOS" == linux-bionic ]]; then

eng/pipelines/extra-platforms/runtime-extra-platforms-ioslike.yml

@@ -166,3 +166,36 @@ jobs:
             testBuildArgs: tree nativeaot/SmokeTests /p:BuildNativeAOTRuntimePack=true
             testRunNamePrefixSuffix: NativeAOT_$(_BuildConfig)
             buildAllTestsAsStandalone: true
+
+#
+# Build the whole product using CoreCLR and run functional tests
+#
+- template: /eng/pipelines/common/platform-matrix.yml
+  parameters:
+    jobTemplate: /eng/pipelines/common/global-build-job.yml
+    helixQueuesTemplate: /eng/pipelines/libraries/helix-queues-setup.yml
+    buildConfig: Checked
+    runtimeFlavor: coreclr
+    isExtraPlatformsBuild: ${{ parameters.isExtraPlatformsBuild }}
+    isiOSLikeOnlyBuild: ${{ parameters.isiOSLikeOnlyBuild }}
+    platforms:
+      - ios_arm64
+    variables:
+      # map dependencies variables to local variables
+      - name: librariesContainsChange
+        value: $[ stageDependencies.EvaluatePaths.evaluate_paths.outputs['SetPathVars_libraries.containsChange'] ]
+      - name: coreclrContainsChange
+        value: $[ stageDependencies.EvaluatePaths.evaluate_paths.outputs['SetPathVars_coreclr.containsChange'] ]
+      - name: illinkContainsChange
+        value: $[ stageDependencies.EvaluatePaths.evaluate_paths.outputs['SetPathVars_tools_illink.containsChange'] ]
+    jobParameters:
+      testGroup: innerloop
+      nameSuffix: AllSubsets_CoreCLR
+      buildArgs: -s clr+clr.runtime+libs+packs+libs.tests -c $(_BuildConfig) /p:ArchiveTests=true /p:DevTeamProvisioning=- /p:RunAOTCompilation=false /p:UseMonoRuntime=false /p:MonoForceInterpreter=false /p:BuildTestsOnHelix=false /p:UseNativeAOTRuntime=false /p:RunSmokeTestsOnly=true
+      timeoutInMinutes: 120
+      # extra steps, run tests
+      postBuildSteps:
+        - template: /eng/pipelines/libraries/helix.yml
+          parameters:
+            creator: dotnet-bot
+            testRunNamePrefixSuffix: CoreCLR_$(_BuildConfig)

eng/pipelines/extra-platforms/runtime-extra-platforms-ioslikesimulator.yml

@@ -135,14 +135,13 @@ jobs:
             buildAllTestsAsStandalone: true
 
 #
-# iOS simulator
 # Build the whole product using CoreCLR and run functional tests
 #
 - template: /eng/pipelines/common/platform-matrix.yml
   parameters:
     jobTemplate: /eng/pipelines/common/global-build-job.yml
     helixQueuesTemplate: /eng/pipelines/libraries/helix-queues-setup.yml
-    buildConfig: checked
+    buildConfig: Checked
     runtimeFlavor: coreclr
     isExtraPlatformsBuild: ${{ parameters.isExtraPlatformsBuild }}
     isiOSLikeSimulatorOnlyBuild: ${{ parameters.isiOSLikeSimulatorOnlyBuild }}

eng/pipelines/extra-platforms/runtime-extra-platforms-maccatalyst.yml

@@ -202,3 +202,36 @@ jobs:
             buildAllTestsAsStandalone: true
             testBuildArgs: tree nativeaot/SmokeTests /p:BuildNativeAOTRuntimePack=true /p:DevTeamProvisioning=adhoc /p:EnableAppSandbox=true
             testRunNamePrefixSuffix: NativeAOT_$(_BuildConfig)
+
+#
+# Build the whole product using CoreCLR and run functional tests
+#
+- template: /eng/pipelines/common/platform-matrix.yml
+  parameters:
+    jobTemplate: /eng/pipelines/common/global-build-job.yml
+    helixQueuesTemplate: /eng/pipelines/libraries/helix-queues-setup.yml
+    buildConfig: Checked
+    runtimeFlavor: coreclr
+    isExtraPlatformsBuild: ${{ parameters.isExtraPlatformsBuild }}
+    isMacCatalystOnlyBuild: ${{ parameters.isMacCatalystOnlyBuild }}
+    platforms:
+      - maccatalyst_arm64
+    variables:
+      # map dependencies variables to local variables
+      - name: librariesContainsChange
+        value: $[ stageDependencies.EvaluatePaths.evaluate_paths.outputs['SetPathVars_libraries.containsChange'] ]
+      - name: coreclrContainsChange
+        value: $[ stageDependencies.EvaluatePaths.evaluate_paths.outputs['SetPathVars_coreclr.containsChange'] ]
+      - name: illinkContainsChange
+        value: $[ stageDependencies.EvaluatePaths.evaluate_paths.outputs['SetPathVars_tools_illink.containsChange'] ]
+    jobParameters:
+      testGroup: innerloop
+      nameSuffix: AllSubsets_CoreCLR
+      buildArgs: -s clr+clr.runtime+libs+packs+libs.tests -c $(_BuildConfig) /p:ArchiveTests=true /p:DevTeamProvisioning=- /p:RunAOTCompilation=false /p:UseMonoRuntime=false /p:MonoForceInterpreter=false /p:BuildTestsOnHelix=false /p:UseNativeAOTRuntime=false /p:RunSmokeTestsOnly=true
+      timeoutInMinutes: 120
+      # extra steps, run tests
+      postBuildSteps:
+        - template: /eng/pipelines/libraries/helix.yml
+          parameters:
+            creator: dotnet-bot
+            testRunNamePrefixSuffix: CoreCLR_$(_BuildConfig)

src/coreclr/clrdefinitions.cmake

@@ -222,8 +222,7 @@ if (FEATURE_CORECLR_FLUSH_INSTRUCTION_CACHE_TO_PROTECT_STUB_READS)
 endif()
 
 if (CLR_CMAKE_TARGET_APPLE)
-#  Re-enable when dbgshim containing https://github.com/dotnet/diagnostics/pull/5487 is generally available
-#  add_definitions(-DFEATURE_MAP_THUNKS_FROM_IMAGE)
+ add_definitions(-DFEATURE_MAP_THUNKS_FROM_IMAGE)
 endif()
 
 # Use this function to enable building with a specific target OS and architecture set of defines

src/coreclr/clrfeatures.cmake

@@ -1,9 +1,12 @@
-if (NOT CLR_CMAKE_TARGET_ARCH_WASM AND NOT CLR_CMAKE_TARGET_IOS AND NOT CLR_CMAKE_TARGET_TVOS AND NOT CLR_CMAKE_TARGET_MACCATALYST)
-  set(FEATURE_JIT 1)
+if (NOT CLR_CMAKE_TARGET_ARCH_WASM)
   set(FEATURE_TIERED_COMPILATION 1)
   set(FEATURE_REJIT 1)
 endif()
 
+if (NOT CLR_CMAKE_TARGET_ARCH_WASM AND NOT CLR_CMAKE_TARGET_IOS AND NOT CLR_CMAKE_TARGET_TVOS AND NOT CLR_CMAKE_TARGET_MACCATALYST)
+  set(FEATURE_JIT 1)
+endif()
+
 if (CLR_CMAKE_TARGET_ARCH_WASM OR CLR_CMAKE_TARGET_IOS OR CLR_CMAKE_TARGET_TVOS OR CLR_CMAKE_TARGET_MACCATALYST)
   set(FEATURE_STATICALLY_LINKED 1)
 endif()

src/coreclr/dlls/mscoree/coreclr/CMakeLists.txt

@@ -187,7 +187,7 @@ if (FEATURE_STATICALLY_LINKED)
         set(CLRJIT_STATIC clrjit_static gcinfo)
     endif(FEATURE_JIT)
     if (FEATURE_INTERPRETER)
-        set(CLRINTERPRETER_STATIC clrinterpreter)
+        set(CLRINTERPRETER_STATIC clrinterpreter_objects dn-containers gcinfo)
     endif(FEATURE_INTERPRETER)
 endif(FEATURE_STATICALLY_LINKED)
 
@@ -209,7 +209,7 @@ if(NOT CLR_CMAKE_HOST_ARCH_WASM)
     target_link_libraries(coreclr PUBLIC ${CORECLR_LIBRARIES} ${CLRJIT_STATIC} ${CLRINTERPRETER_STATIC} cee_wks_core cee_wks ${FOUNDATION})
 endif(NOT CLR_CMAKE_HOST_ARCH_WASM)
 
-target_link_libraries(coreclr_static PUBLIC ${CORECLR_LIBRARIES} cee_wks_core ${CORECLR_STATIC_CLRJIT_STATIC} ${CEE_WKS_STATIC} ${FOUNDATION})
+target_link_libraries(coreclr_static PUBLIC ${CORECLR_LIBRARIES} cee_wks_core ${CORECLR_STATIC_CLRJIT_STATIC} ${CLRINTERPRETER_STATIC} ${CEE_WKS_STATIC} ${FOUNDATION})
 target_compile_definitions(coreclr_static PUBLIC CORECLR_EMBEDDED)
 
 if (CLR_CMAKE_HOST_ANDROID)

src/coreclr/hosts/corewasmrun/CMakeLists.txt

@@ -20,7 +20,6 @@ target_link_options(corewasmrun PRIVATE -fwasm-exceptions -sEXIT_RUNTIME=1 -sINI
 
 target_link_libraries(corewasmrun PRIVATE
   coreclr_static
-  clrinterpreter
   icuuc
   icui18n
   icudata)

src/coreclr/inc/clrconfigvalues.h

@@ -244,7 +244,11 @@ CONFIG_DWORD_INFO(INTERNAL_FastGCCheckStack, W("FastGCCheckStack"), 0, "")
 CONFIG_DWORD_INFO(INTERNAL_FastGCStress, W("FastGCStress"), 0, "Reduce the number of GCs done by enabling GCStress")
 RETAIL_CONFIG_DWORD_INFO(UNSUPPORTED_GCBreakOnOOM, W("GCBreakOnOOM"), 0, "Does a DebugBreak at the soonest time we detect an OOM")
 RETAIL_CONFIG_DWORD_INFO(UNSUPPORTED_gcConcurrent, W("gcConcurrent"), (DWORD)-1, "Enables/Disables concurrent GC")
+#if defined(TARGET_IOS) || defined(TARGET_TVOS) || defined(TARGET_MACCATALYST)
+RETAIL_CONFIG_DWORD_INFO(UNSUPPORTED_UseGCWriteBarrierCopy, W("UseGCWriteBarrierCopy"), 0, "Use a copy of the write barrier for the GC. This is somewhat faster and for optimizations where the barrier is mutated as the program runs. Setting this to 0 removes scenarios where the write barrier is ever mutable.")
+#else
 RETAIL_CONFIG_DWORD_INFO(UNSUPPORTED_UseGCWriteBarrierCopy, W("UseGCWriteBarrierCopy"), 1, "Use a copy of the write barrier for the GC. This is somewhat faster and for optimizations where the barrier is mutated as the program runs. Setting this to 0 removes scenarios where the write barrier is ever mutable.")
+#endif // defined(TARGET_IOS) || defined(TARGET_TVOS) || defined(TARGET_MACCATALYST)
 
 #ifdef FEATURE_CONSERVATIVE_GC
 RETAIL_CONFIG_DWORD_INFO(UNSUPPORTED_gcConservative, W("gcConservative"), 0, "Enables/Disables conservative GC")
@@ -554,8 +558,11 @@ RETAIL_CONFIG_DWORD_INFO(EXTERNAL_VirtualCallStubLogging, W("VirtualCallStubLogg
 CONFIG_DWORD_INFO(INTERNAL_VirtualCallStubMissCount, W("VirtualCallStubMissCount"), 100, "Used only when STUB_LOGGING is defined, which by default is not.")
 CONFIG_DWORD_INFO(INTERNAL_VirtualCallStubResetCacheCounter, W("VirtualCallStubResetCacheCounter"), 0, "Used only when STUB_LOGGING is defined, which by default is not.")
 CONFIG_DWORD_INFO(INTERNAL_VirtualCallStubResetCacheIncr, W("VirtualCallStubResetCacheIncr"), 0, "Used only when STUB_LOGGING is defined, which by default is not.")
+#if defined(TARGET_IOS) || defined(TARGET_TVOS) || defined(TARGET_MACCATALYST)
+CONFIG_DWORD_INFO(INTERNAL_UseCachedInterfaceDispatch, W("UseCachedInterfaceDispatch"), 1, "If cached interface dispatch is compiled in, use that instead of virtual stub dispatch")
+#else
 CONFIG_DWORD_INFO(INTERNAL_UseCachedInterfaceDispatch, W("UseCachedInterfaceDispatch"), 0, "If cached interface dispatch is compiled in, use that instead of virtual stub dispatch")
-
+#endif // defined(TARGET_IOS) || defined(TARGET_TVOS) || defined(TARGET_MACCATALYST)
 ///
 /// Watson
 ///
@@ -573,7 +580,11 @@ 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/CMakeLists.txt

@@ -1,8 +1,5 @@
 set(CMAKE_INCLUDE_CURRENT_DIR ON)
 
-# So simdhash will build correctly without a dn-config.h
-add_compile_definitions(NO_CONFIG_H)
-
 set(INTERPRETER_SOURCES
   compiler.cpp
   compileropt.cpp
@@ -12,10 +9,7 @@ set(INTERPRETER_SOURCES
   stackmap.cpp
   naming.cpp
   methodset.cpp
-  intrinsics.cpp
-  ../../native/containers/dn-simdhash.c
-  ../../native/containers/dn-simdhash-ght-compatible.c
-  ../../native/containers/dn-simdhash-ptr-ptr.c)
+  intrinsics.cpp)
 
 set(INTERPRETER_LINK_LIBRARIES
   gcinfo
@@ -32,39 +26,39 @@ if(CLR_CMAKE_HOST_WIN32)
     set(CLRINTERPRETER_EXPORTS ${CMAKE_CURRENT_LIST_DIR}/clrinterpreter.exports)
     set(EXPORTS_FILE ${CMAKE_CURRENT_BINARY_DIR}/clrinterpreter.def)
     preprocess_file(${CLRINTERPRETER_EXPORTS} ${EXPORTS_FILE})
-    list(APPEND INTERPRETER_SOURCES ${EXPORTS_FILE})
-    add_custom_target(interpreter_exports DEPENDS ${EXPORTS_FILE})
+    add_custom_target(clrinterpreter_exports DEPENDS ${EXPORTS_FILE})
 else()
     set(CLRINTERPRETER_EXPORTS ${CMAKE_CURRENT_LIST_DIR}/clrinterpreter_unixexports.src)
     set(EXPORTS_FILE ${CMAKE_CURRENT_BINARY_DIR}/clrinterpreter.exports)
     generate_exports_file(${CLRINTERPRETER_EXPORTS} ${EXPORTS_FILE})
-    add_custom_target(interpreter_exports DEPENDS ${EXPORTS_FILE})
+    add_custom_target(clrinterpreter_exports DEPENDS ${EXPORTS_FILE})
 endif()
 
-if(FEATURE_STATICALLY_LINKED AND NOT FEATURE_JIT)
-  set(LIBRARY_TYPE STATIC)
-else()
-  set(LIBRARY_TYPE SHARED)
+add_library_clr(clrinterpreter_objects OBJECT ${INTERPRETER_SOURCES})
+
+if (NOT CMAKE_GENERATOR MATCHES "Visual Studio")
+  set_target_properties(clrinterpreter_objects PROPERTIES EXCLUDE_FROM_ALL $<NOT:${FEATURE_INTERPRETER}>)
 endif()
 
-add_library_clr(clrinterpreter ${LIBRARY_TYPE} ${INTERPRETER_SOURCES})
+add_library_clr(clrinterpreter SHARED $<TARGET_OBJECTS:clrinterpreter_objects> $<TARGET_OBJECTS:dn-containers>)
 
 if (NOT CMAKE_GENERATOR MATCHES "Visual Studio")
   set_target_properties(clrinterpreter PROPERTIES EXCLUDE_FROM_ALL $<NOT:${FEATURE_INTERPRETER}>)
 endif()
 
-add_dependencies(clrinterpreter interpreter_exports)
-
-if(NOT CLR_CMAKE_HOST_WIN32)
+if(CLR_CMAKE_HOST_WIN32)
+    target_sources(clrinterpreter PRIVATE ${EXPORTS_FILE})
+else()
     set_exports_linker_option(${EXPORTS_FILE})
     set_property(TARGET clrinterpreter APPEND_STRING PROPERTY LINK_FLAGS ${EXPORTS_LINKER_OPTION})
 endif()
 
+set_property(TARGET clrinterpreter APPEND_STRING PROPERTY LINK_DEPENDS ${EXPORTS_FILE})
+add_dependencies(clrinterpreter clrinterpreter_exports)
+
 target_link_libraries(clrinterpreter
         PRIVATE
         ${INTERPRETER_LINK_LIBRARIES}
     )
 
-set_property(TARGET clrinterpreter APPEND_STRING PROPERTY LINK_DEPENDS ${EXPORTS_FILE})
-
 install_clr(TARGETS clrinterpreter DESTINATIONS . sharedFramework COMPONENT runtime OPTIONAL)