Add support for building CoreCLR for iOS/tvOS simulator #98127

filipnavara · 2024-02-07T21:33:51Z

Build instructions:

Build the runtime pack and tools: ./build.sh clr+clr.runtime+libs+packs -os [iossimulator/tvossimulator/maccatalyst] -arch [x64/arm64] -cross -c Release
Run the sample app in iOS simulator: ./dotnet.sh publish src/mono/sample/iOS/Program.csproj -c Release /p:TargetOS=iossimulator /p:TargetArchitecture=arm64 /p:DeployAndRun=true /p:UseMonoRuntime=false /p:RunAOTCompilation=false /p:MonoForceInterpreter=false

Additional work outside of dotnet/runtime:

Counter-part Xamarin changes needed to build full workload and run MAUI apps: https://github.com/xamarin/xamarin-macios/compare/net8.0...filipnavara:xamarin-macios:net8.0-coreclr-ioslike?expand=1
SDK would need to be updated with RIDs in KnownRuntimeFramework to use this

Obligatory screenshot:

ghost · 2024-02-07T21:34:20Z

Tagging subscribers to 'os-ios': @steveisok, @akoeplinger, @kotlarmilos
See info in area-owners.md if you want to be subscribed.

Issue Details

Build instructions:

Build the runtime pack and tools: ./build.sh clr+clr.runtime+libs+packs -os [iossimulator/tvossimulator/maccatalyst] -arch [x64/arm64] -cross -c Release
Run the sample app in iOS simulator: ./dotnet.sh publish src/mono/sample/iOS/Program.csproj -c Release /p:TargetOS=iossimulator /p:TargetArchitecture=arm64 /p:DeployAndRun=true /p:UseMonoRuntime=false /p:RunAOTCompilation=false /p:MonoForceInterpreter=false

Additional work outside of dotnet/runtime:

Counter-part Xamarin changes needed to build full workload and run MAUI apps: https://github.com/xamarin/xamarin-macios/compare/net8.0...filipnavara:xamarin-macios:net8.0-coreclr-ioslike?expand=1
SDK would need to be updated with RIDs in KnownRuntimeFramework to use this

Obligatory screenshot:

Author:	filipnavara
Assignees:	-
Labels:	`os-ios`, `community-contribution`, `needs-area-label`
Milestone:	-

teo-tsirpanis · 2024-02-08T01:07:47Z

For my own curiosity, will CoreCLR iOS apps be possible to be shipped in the third-party app stores that will come to the EU?

ghost · 2024-02-08T01:33:43Z

Tagging subscribers to this area: @hoyosjs
See info in area-owners.md if you want to be subscribed.

Issue Details

Build instructions:

Build the runtime pack and tools: ./build.sh clr+clr.runtime+libs+packs -os [iossimulator/tvossimulator/maccatalyst] -arch [x64/arm64] -cross -c Release
Run the sample app in iOS simulator: ./dotnet.sh publish src/mono/sample/iOS/Program.csproj -c Release /p:TargetOS=iossimulator /p:TargetArchitecture=arm64 /p:DeployAndRun=true /p:UseMonoRuntime=false /p:RunAOTCompilation=false /p:MonoForceInterpreter=false

Additional work outside of dotnet/runtime:

Counter-part Xamarin changes needed to build full workload and run MAUI apps: https://github.com/xamarin/xamarin-macios/compare/net8.0...filipnavara:xamarin-macios:net8.0-coreclr-ioslike?expand=1
SDK would need to be updated with RIDs in KnownRuntimeFramework to use this

Obligatory screenshot:

Author:	filipnavara
Assignees:	-
Labels:	`area-Infrastructure-coreclr`, `os-ios`, `community-contribution`, `needs-area-label`
Milestone:	-

ryujit-bot · 2024-02-08T03:11:28Z

Diff results for #98127

Throughput diffs

Throughput diffs for windows/arm64 ran on windows/x64

MinOpts (-0.00% to +0.01%)

Collection	PDIFF
libraries.pmi.windows.arm64.checked.mch	+0.01%

Details here

jkotas · 2024-02-08T05:07:39Z

src/native/libs/System.Native/entrypoints.c

@@ -34,6 +34,7 @@
 static const Entry s_sysNative[] =
 {
    DllImportEntry(SystemNative_FStat)
+#if !defined(TARGET_APPLE) || defined(TARGET_OSX)


src/native/libs are shared with Mono. How does this work on iOS - why are these changes not needed for Mono/iOS?

This file is used only for the static entrypoint resolution in apphost. Technically we would not need it here either if I removed the (unused) apphost build.

filipnavara · 2024-02-08T05:30:58Z

For my own curiosity, will CoreCLR iOS apps be possible to be shipped in the third-party app stores that will come to the EU?

Probably not. I was hoping that there would be a change to allow deployment to your own device for debugging purposes, but you still need a restricted entitlement (JIT) for that and Apple won’t let you get it for signing.

filipnavara · 2024-02-08T08:29:41Z

Unfortunately, the debugger doesn't work yet (CORDBG_E_DEBUG_COMPONENT_MISSING). I think I didn't compile all the components. I'll drop the tvOS part with next rebase, it's not polished...

dotnet-policy-service · 2024-03-09T13:53:04Z

Draft Pull Request was automatically closed for 30 days of inactivity. Please let us know if you'd like to reopen it.

vitek-karas · 2024-03-11T08:51:12Z

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

+mono_ios_runtime_init (void)
+{
+#if INVARIANT_GLOBALIZATION
+    setenv ("DOTNET_SYSTEM_GLOBALIZATION_INVARIANT", "1", TRUE);


Would it work if these were passed via runtime properties? It feels wrong to pollute the process env. variable space like this.

FWIW this is preexisting code from

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

Lines 260 to 262 in 5161ccd

#if INVARIANT_GLOBALIZATION

setenv ("DOTNET_SYSTEM_GLOBALIZATION_INVARIANT", "1", TRUE);

#endif

.

I didn't really think it matters when the AppleAppBuilder was used only for tests and samples. However, it got productized as part of shared library building tooling, so maybe we should revisit it.

yes this could use runtimeconfig now, I think this was added way back when we didn't have support for parsing it and this was just used for tests

vitek-karas · 2024-03-11T08:53:06Z

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

+}
+
+void
+mono_ios_runtime_init (void)


Nit: maybe once this is merged, we should followup with some naming cleanup in the samples and rename this to just ios_runtime_init...

kotlarmilos

Thanks, looks great! Could we add some test coverage to this PR? Is it possible to enable functional tests?

kotlarmilos · 2024-03-13T08:14:56Z

docs/workflow/building/coreclr/ios.md

+Build the runtime pack and tools with
+
+```
+./build.sh clr+clr.runtime+libs+packs -os [iossimulator/tvossimulator/maccatalyst] -arch [x64/arm64] -cross -c Release


Is it possible to JIT on arm64 simulators?

Technically yes. You need to call the one API to enable it which is not allowed in headers. I would not do that in production, but I think it's okay for local debugging.

kotlarmilos · 2024-03-13T08:20:15Z

src/coreclr/pal/src/exception/signal.cpp

-#if !HAVE_MACH_EXCEPTIONS
+#if defined(TARGET_TVOS)
+
+static bool SwitchStackAndExecuteHandler(int code, siginfo_t *siginfo, void *context, size_t sp)


Why is this tvOS-specific?

tvOS arbitrarily lacks some of the Mach APIs. I was planning to rebase and drop the tvOS part for now.

kotlarmilos · 2024-03-13T08:26:52Z

src/coreclr/pal/src/include/pal/thread.hpp

@@ -588,7 +588,7 @@ namespace CorUnix
            m_pNext = pNext;
        };

-#if !HAVE_MACH_EXCEPTIONS
+#if !HAVE_MACH_EXCEPTIONS && !defined(TARGET_TVOS)


What scenarios would apply here, if not tvOS-related?

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

kotlarmilos · 2024-03-13T08:36:33Z

src/tasks/AppleAppBuilder/Xcode.cs

@@ -190,10 +190,10 @@ private static string SetArch(string arch)
        string? diagnosticPorts,
        IEnumerable<string> runtimeComponents,
        string? nativeMainSource = null,
-        bool useNativeAOTRuntime = false,
+        TargetRuntime targetRuntime = TargetRuntime.MonoVM,


Thanks for introducing TargetRuntime enum.

kotlarmilos · 2024-03-27T12:49:13Z

Can we integrate this into the official build pipeline and run a functional test in runtime-ioslikesimulator pipeline?

filipnavara · 2024-03-27T13:12:23Z

Sorry for not caring enough about this PR. I hope to give it some attention next week.

Can we integrate this into the official build pipeline and run a functional test in runtime-ioslikesimulator pipeline?

I'll check what would it take but the YAML pipelines are not exactly my strength.

…am.csproj -c Release /p:TargetOS=iossimulator /p:TargetArchitecture=arm64 /p:AppleAppBuilderRuntime=CoreCLR /p:DeployAndRun=true /p:UseMonoRuntime=false /p:RunAOTCompilation=false /p:MonoForceInterpreter=false

Co-authored-by: Adeel Mujahid <3840695+am11@users.noreply.github.com>

filipnavara · 2024-06-12T08:19:21Z

I'll rebase the PR again.

I don't have much time to work on this at the moment. Last time I tried to get the debugger working. First problem is that the app gets native DAC instead of the cross-build DAC and the cross-built one is not signed as part of the build process. I managed to manually copy the right binaries into the deployed app bundle. I proceeded to test with the Samsung .NET Debugger so I can get more info about the errors. The next thing that failed was opening the debug pipe (timeout). Unfortunately, I didn't take notes at that point, so I don't have more details to share.

akoeplinger · 2024-06-12T17:06:00Z

I wonder if we should get the straightforward changes like TARGET_OSX -> TARGET_APPLE extracted to a separate PR?

dotnet-policy-service · 2024-07-12T19:49:28Z

Draft Pull Request was automatically closed for 30 days of inactivity. Please let us know if you'd like to reopen it.

ghost added the community-contribution Indicates that the PR has been added by a community member label Feb 7, 2024

dotnet-issue-labeler bot added the needs-area-label An area label is needed to ensure this gets routed to the appropriate area owners label Feb 7, 2024

filipnavara added the os-ios Apple iOS label Feb 7, 2024

jkotas added area-Infrastructure-coreclr and removed needs-area-label An area label is needed to ensure this gets routed to the appropriate area owners labels Feb 8, 2024

jkotas reviewed Feb 8, 2024

View reviewed changes

build-analysis bot mentioned this pull request Feb 8, 2024

PortableSourceBuild failures in runtime-dev-innerloop #98160

Closed

dotnet-policy-service bot closed this Mar 9, 2024

filipnavara reopened this Mar 9, 2024

jkotas requested a review from vitek-karas March 9, 2024 16:58

build-analysis bot mentioned this pull request Mar 9, 2024

Segmentation fault in System.Runtime.Serialization.Formatters.Tests #98609

Closed

vitek-karas reviewed Mar 11, 2024

View reviewed changes

vitek-karas requested a review from kotlarmilos March 11, 2024 12:07

kotlarmilos reviewed Mar 13, 2024

View reviewed changes

am11 mentioned this pull request Mar 21, 2024

does coreclr support ios platform? #100055

Closed

MichalPetryka mentioned this pull request Mar 21, 2024

Enable FEATURE_PERFMAP on OSX, and update perfjitdump.cpp to work on OSX #99986

Merged

filipnavara and others added 23 commits May 19, 2024 18:00

Build the singlefilehost even if we don't currently use it

684d601

Make coreclrhost.h compatible v C(not++)

5cc117b

Fix TargetOS::IsMacOS

ff2af8a

WIP: AppleAppBuilder support for CoreCLR

24a5a44

Make the sample app working: dotnet publish src/mono/sample/iOS/Progr…

968031f

…am.csproj -c Release /p:TargetOS=iossimulator /p:TargetArchitecture=arm64 /p:AppleAppBuilderRuntime=CoreCLR /p:DeployAndRun=true /p:UseMonoRuntime=false /p:RunAOTCompilation=false /p:MonoForceInterpreter=false

Cleanup

1530eba

Update src/tasks/AppleAppBuilder/AppleAppBuilder.csproj

f9b31b2

Co-authored-by: Adeel Mujahid <3840695+am11@users.noreply.github.com>

Use sys_icache_invalidate for all iOS-like platforms

eaed19b

Consolidate macOS-only entrypoints in a single #if block

970f34c

Apply feedback

cf686b6

Fix jitinterface cross-build

bd7eaac

Infer AppleAppBuilderRuntime from UseMonoRuntime and UseNativeAOTRuntime

1a34be8

Minor changes to test infrastructure

209a762

Add basic documentation

a9778ce

Add nearly complete support for building runtime tests

f58daa1

Fix building seh-unwind with older iOS SDK

91c2b2e

Use enum for TargetRuntime in AppleAppBuilder

1ef8005

Fix LibraryBuilder build

bdd5119

Cleanup

d7aa597

Fix after rebase

f8c704b

Revert accidental change

337751b

Fix tvOS build

bb0cde3

Drop CoreCLR tvOS Simulator support for now

8d293e1

filipnavara force-pushed the coreclr-ioslike branch from eec0c41 to 8d293e1 Compare May 19, 2024 16:04

build-analysis bot mentioned this pull request May 19, 2024

Dead lettering tests #101524

Closed

dotnet-policy-service bot closed this Jul 12, 2024

github-actions bot locked and limited conversation to collaborators Aug 12, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for building CoreCLR for iOS/tvOS simulator #98127

Add support for building CoreCLR for iOS/tvOS simulator #98127

filipnavara commented Feb 7, 2024

ghost commented Feb 7, 2024

teo-tsirpanis commented Feb 8, 2024

ghost commented Feb 8, 2024

ryujit-bot commented Feb 8, 2024

Throughput diffs

Throughput diffs for windows/arm64 ran on windows/x64

jkotas Feb 8, 2024

filipnavara Feb 8, 2024

filipnavara commented Feb 8, 2024

filipnavara commented Feb 8, 2024

dotnet-policy-service bot commented Mar 9, 2024

vitek-karas Mar 11, 2024

filipnavara Mar 11, 2024

akoeplinger Mar 12, 2024

vitek-karas Mar 11, 2024

kotlarmilos left a comment

kotlarmilos Mar 13, 2024

filipnavara Mar 13, 2024

kotlarmilos Mar 13, 2024

filipnavara Mar 13, 2024

kotlarmilos Mar 13, 2024

kotlarmilos Mar 13, 2024

kotlarmilos commented Mar 27, 2024 •

edited

Loading

filipnavara commented Mar 27, 2024

filipnavara commented Jun 12, 2024 •

edited

Loading

akoeplinger commented Jun 12, 2024

dotnet-policy-service bot commented Jul 12, 2024

	#if INVARIANT_GLOBALIZATION
	setenv ("DOTNET_SYSTEM_GLOBALIZATION_INVARIANT", "1", TRUE);
	#endif

Add support for building CoreCLR for iOS/tvOS simulator #98127

Add support for building CoreCLR for iOS/tvOS simulator #98127

Conversation

filipnavara commented Feb 7, 2024

ghost commented Feb 7, 2024

teo-tsirpanis commented Feb 8, 2024

ghost commented Feb 8, 2024

ryujit-bot commented Feb 8, 2024

Throughput diffs

Throughput diffs for windows/arm64 ran on windows/x64

Choose a reason for hiding this comment

Choose a reason for hiding this comment

filipnavara commented Feb 8, 2024

filipnavara commented Feb 8, 2024

dotnet-policy-service bot commented Mar 9, 2024

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

kotlarmilos 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kotlarmilos commented Mar 27, 2024 • edited Loading

filipnavara commented Mar 27, 2024

filipnavara commented Jun 12, 2024 • edited Loading

akoeplinger commented Jun 12, 2024

dotnet-policy-service bot commented Jul 12, 2024

kotlarmilos commented Mar 27, 2024 •

edited

Loading

filipnavara commented Jun 12, 2024 •

edited

Loading