CLR hosting #9572

grendello · 2024-12-02T21:16:21Z

Required CoreCLR runtime changes: dotnet/runtime#112705

build-tools/create-packs/Microsoft.Android.Runtime.proj

jonathanpeppers · 2025-01-15T15:58:08Z

Configuration.props

@@ -216,5 +218,6 @@
  <ItemGroup>
    <AndroidAbiAndRuntimeFlavor Include="@(AndroidSupportedTargetJitAbi)" AndroidRuntime="Mono" />
    <AndroidAbiAndRuntimeFlavor Include="@(AndroidSupportedTargetJitAbi)" AndroidRuntime="NativeAOT" />
+    <AndroidAbiAndRuntimeFlavor Include="@(AndroidSupportedTargetJitAbi)" AndroidRuntime="CoreCLR" />


I couldn't figure out if we should case it CoreClr or CoreCLR:

https://grep.app/search?q=CoreCLR&case=true&filter[repo][0]=dotnet/runtime

https://grep.app/search?q=CoreClr&case=true&filter[repo][0]=dotnet/runtime

I found both, so we can probably decide which we prefer?

I like CoreCLR better, since CLR is an acronym

jonathanpeppers · 2025-01-15T16:01:39Z

...d.Build.Tasks/Microsoft.Android.Sdk/targets/Microsoft.Android.Sdk.AssemblyResolution.targets

+      <_ExcludedNativeLibraries Condition=" '$(AndroidRuntime)' == 'Mono' Or '$(AndroidRuntime)' == '' " Include="libnet-android.debug" />
+      <_ExcludedNativeLibraries Condition=" '$(AndroidRuntime)' == 'Mono' Or '$(AndroidRuntime)' == '' " Include="libnet-android.release" />
+      <_ExcludedNativeLibraries Condition=" '$(AndroidRuntime)' == 'CoreCLR' " Include="libmono-android.debug" />
+      <_ExcludedNativeLibraries Condition=" '$(AndroidRuntime)' == 'CoreCLR' " Include="libmono-android.release" />


So, $(AndroidRuntime) isn't defined for customer's project builds. I think it would always be blank?

Right now, we only have these:

$(UseMonoRuntime)=true

$(_AndroidNativeAot)=true

Maybe we need to figure out what property xamarin/xamarin-macios uses to identify CoreCLR? You can use it for macOS, to choose between Mono & CoreCLR.

Yeah, it would always be blank now and I think we should always expect a value in there. The macios way looks fine.

jonathanpeppers · 2025-01-15T16:06:58Z

src/Xamarin.Android.Build.Tasks/Xamarin.Android.Common.targets

+  <_AndroidUseCLR Condition=" '$(AndroidRuntime)' == 'CoreCLR' ">True</_AndroidUseCLR>
+  <_AndroidUseCLR Condition=" '$(AndroidRuntime)' != 'CoreCLR' ">False</_AndroidUseCLR>


$(AndroidRuntime) is probably always blank in customer's Android projects, but is this the property to select a runtime? Should the property be in DefaultProperties.targets?

Maybe we should align with xamarin/xamarin-macios?

jonathanpeppers · 2025-01-15T16:42:34Z

Ok, here is what we should do for MSBuild properties for now:

$(_AndroidRuntime) is the property we use throughout Android project builds (customer projects), it can say MonoVM, NativeAOT, or CoreCLR. It is a private property.
If PublishAot=true, $(_AndroidRuntime)=NativeAOT
If UseMonoRuntime=false, $(_AndroidRuntime)=CoreCLR
If $(UseMonoRuntime)="", we default to $(UseMonoRuntime)=true in DefaultProperties.targets
If UseMonoRuntime=true, $(_AndroidRuntime)=MonoVM

We could remove $(_AndroidNativeAot) and check '$(_AndroidRuntime)' == 'NativeAOT' instead. If we keep it, we should introduce $(_AndroidCoreClr).

grendello · 2025-01-15T17:00:39Z

Ok, here is what we should do for MSBuild properties for now:
* `$(_AndroidRuntime)` is the property we use throughout Android project builds (customer projects), it can say `MonoVM`, `NativeAOT`, or `CoreCLR`. It is a private property.

* If `PublishAot=true`, `$(_AndroidRuntime)=NativeAOT`

* If `UseMonoRuntime=false`, `$(_AndroidRuntime)=CoreCLR`

* If `$(UseMonoRuntime)=""`, we default to `$(UseMonoRuntime)=true` in `DefaultProperties.targets`

* If `UseMonoRuntime=true`, `$(_AndroidRuntime)=MonoVM`
We could remove $(_AndroidNativeAot) and check '$(_AndroidRuntime)' == 'NativeAOT' instead. If we keep it, we should introduce $(_AndroidCoreClr).

I like $(_AndroidRuntime) for this, it's much leaner and reads better IMO :)

Context: #9572 (comment) Context: https://github.com/xamarin/xamarin-macios/blob/2009c571aa8a975ab0e0b1785e5484dbd64d6f9b/dotnet/targets/Xamarin.Shared.Sdk.targets#L1004-L1006 To align with xamarin/xamarin-macios, the following public MSBuild properties can be used to select a runtime for iOS, macOS, etc.: * `$(UseMonoRuntime)=true`: MonoVM * `$(UseMonoRuntime)=false`: CoreCLR * `$(PublishAot)=true`: NativeAOT * Defaults if blank, select MonoVM Introduce a private `$(_AndroidRuntime)` property we can use throughout our build to know which runtime is being targetted. This way, if a new property is designed in the future, we can keep using `$(_AndroidRuntime)` and simply update the defaults.

…#9686) Context: #9572 (comment) Context: https://github.com/xamarin/xamarin-macios/blob/2009c571aa8a975ab0e0b1785e5484dbd64d6f9b/dotnet/targets/Xamarin.Shared.Sdk.targets#L1004-L1006 To align with xamarin/xamarin-macios, the following public MSBuild properties can be used to select a runtime for iOS, macOS, etc.: * `$(UseMonoRuntime)=true`: MonoVM * `$(UseMonoRuntime)=false`: CoreCLR * `$(PublishAot)=true`: NativeAOT * Defaults if blank, select MonoVM Introduce a private `$(_AndroidRuntime)` property we can use throughout our build to know which runtime is being targeted. This way, if a new property is designed in the future, we can keep using `$(_AndroidRuntime)` and simply update the defaults.

...d.Build.Tasks/Microsoft.Android.Sdk/targets/Microsoft.Android.Sdk.AssemblyResolution.targets

Context: #9572 #9572 is prototyping CoreCLR support, and as part of that it renamed e.g. `src/native/monodroid` to `src/native/mono/monodroid` -- "inserting" a "runtime" value underneath `src/native` -- so that CoreCLR code won't be intermingled with MonoVM code. Separate out these file moves into a separate PR, to reduce the size and review complexity of #9572.

Context: #9572 Add support for Unicode strings to the LLVM IR generator, together with de-duplication and support for outputting the same string encoded both as UTF-8 and Unicode (UTF16LE). Additionally, since all the files are generated from separate tasks, we don't have a global LLVM IR state which can keep track of strings and ensure that there are no duplicate symbol names. To prevent potential clashes, each generator now sets the default string group name which is unique for each module. ; From marshal_methods.arm64-v8a.ll @.mm.0 = dso_local constant [102 x i8] c"Android.App.Activity, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=84e04ff9cfb79065\00", align 1 ; from environment.arm64-v8a.ll @.env.0 = dso_local constant [7 x i8] c"normal\00", align 1 ; from typemaps.arm64-v8a.ll @.tmr.0 = dso_local constant [22 x i8] c"android/os/BaseBundle\00", align 1 `mm`, `env`, and `tmr` are the default string groups for each module. In the future, we should try to manage strings globally (which would also result in more de-duplication).

Context: #9572 Add a new `src/native/common` for files which can be shared between MonoVM and CoreCLR, and move common infrastructural source there, such as `jni-wrappers.hh` and `strings.hh`. Copy the parts of `src/native/mono` that will be used by #9572 but require modification to be used with CoreCLR into `src/native/clr`. `src/native/clr` is not yet compiled; this merely serves the purpose of making #9572 smaller and easier to review, copying code from the existing MonoVM implementation to the CoreCLR one, mostly without functional changes. There are very few functional changes, most code is copied verbatim with the only changes being formatting, function declaration syntax and, sometimes, the class in which the code lives. Only the code that's actually used in #9572 is copied. This allows us to refresh our runtime code while cleaning it up at the same time, with the goal of having an implementation that is tailored strictly towards CoreCLR (which doesn't have e.g. Mono's embedding APIs)

...d.Build.Tasks/Microsoft.Android.Sdk/targets/Microsoft.Android.Sdk.AssemblyResolution.targets

This is needed until #9572 is merged, since the != 'NativeAOT' would enable the guarded code to run also for `CoreCLR`, which is not fully functional in this PR.

Context: #9572 PR #9572 is quite large. Extract out a set of changes for easier review. Co-authored-by: Jonathan Pryor <[email protected]> Co-authored-by: Jonathan Peppers <[email protected]>

Caveats: * Trimming must be turned off * Typemaps don't work (everything is resolved dynamically) * Marshal methods must be turned off (they use MonoVM embedding API)

By convention (and often enforced requirement), `$(OutputPath)` ends with `\`, which means that quoting it for use with `<Exec/>`: <Exec Command="whatever "$(OutputPath)"" /> will often result in an *invalid* command, because the `\` escapes the quote! whatever "C:\path\to\output\" # ruh roh! The fix is to instead use `$(OutputPath.OutputPath.TrimEnd('\')`, which ensures that the path does *not* end in `\`, preventing the unintentional escape usage: whatever "C:\path\to\output" # yay!

grendello force-pushed the dev/grendel/clr-host branch 3 times, most recently from c085352 to 13bbd93 Compare December 3, 2024 21:15

jonathanpeppers reviewed Dec 3, 2024

View reviewed changes

build-tools/create-packs/Microsoft.Android.Runtime.proj Outdated Show resolved Hide resolved

grendello force-pushed the dev/grendel/clr-host branch 2 times, most recently from 82cfb8a to 77aa40a Compare December 4, 2024 22:10

jonathanpeppers reviewed Jan 15, 2025

View reviewed changes

jonathanpeppers mentioned this pull request Jan 15, 2025

[Xamarin.Android.Build.Tasks] introduce $(_AndroidRuntime) property #9686

Merged

jonpryor mentioned this pull request Jan 28, 2025

[nativeaot] support for Application subclasses #9716

Merged

grendello mentioned this pull request Feb 4, 2025

Move MonoVM runtime to a subdirectory #9749

Merged

jonathanpeppers reviewed Feb 5, 2025

View reviewed changes

...d.Build.Tasks/Microsoft.Android.Sdk/targets/Microsoft.Android.Sdk.AssemblyResolution.targets Outdated Show resolved Hide resolved

This was referenced Feb 6, 2025

[LLVM IR] Add support for Unicode strings #9764

Merged

CLR hosting bits #9778

Merged

ivanpovazan reviewed Feb 17, 2025

View reviewed changes

...d.Build.Tasks/Microsoft.Android.Sdk/targets/Microsoft.Android.Sdk.AssemblyResolution.targets Outdated Show resolved Hide resolved

grendello added a commit that referenced this pull request Feb 18, 2025

Another set of changes from #9572

9f8b79e

grendello added a commit that referenced this pull request Feb 19, 2025

Another set of changes from #9572

8f03d68

grendello mentioned this pull request Feb 19, 2025

[Android] Add callback to host-runtime contract for getting assembly data dotnet/runtime#112705

Open

grendello added a commit that referenced this pull request Feb 20, 2025

Another set of changes from #9572

59cbd30

grendello force-pushed the dev/grendel/clr-host branch from af8bb41 to c853ea1 Compare February 21, 2025 08:48

simonrozsival mentioned this pull request Feb 21, 2025

[Experimental] Add alternative way of resolving UCO function pointers for Marshal Methods #9805

Open

grendello force-pushed the dev/grendel/clr-host branch from b9bd06b to ee0c8a5 Compare February 21, 2025 16:47

grendello and others added 29 commits February 25, 2025 00:16

Create an LlvmIrStringVariable instance when adding a string variable

b0229c9

Let's try this

1c62823

"Namespace" LLVM IR strings"

7731dc3

Fix string constant options

9db92b3

Hello world now runs.

f43fe11

Caveats: * Trimming must be turned off * Typemaps don't work (everything is resolved dynamically) * Marshal methods must be turned off (they use MonoVM embedding API)

WIP for CoreCLR typemaps

2f35c90

More CoreCLR typemap work

77a2bd8

Share more code between MonoVM and CoreCLR hosts

8be0163

Fix package manager registration for CoreCLR

fe9e40b

Fix pinvoke generator

2d256bd

Update notes

88e5985

Post-merge fixups

6909598

Type map implementation for CLR

79b4d94

MAUI hello world works now

24122be

Add missing parentheses

bbdba75

Some cleanup

8e8d755

Changes

38d8e50

Fix after rebase

cc1bdb8

Typemaps use type token ids again

82c7900

Fix after rebase

8b7c50a

[WIP] Broken, tbc on Monday

03583e8

Use a local CoreCLR runtime build, if requested and present

7a431aa

Forget me not

bbf54a7

[WIP] runtime pack library dirs discovery

7b4404c

Use discovered runtime pack native lib dirs

bd1df3a

Fix build on CoreCLR after main rebase

f7837a9

Add some logs and update structure layout

3783362

Cleanup

8583a0e

grendello force-pushed the dev/grendel/clr-host branch from 620f785 to 8583a0e Compare February 24, 2025 23:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CLR hosting #9572

CLR hosting #9572

grendello commented Dec 2, 2024 •

edited

Loading

jonathanpeppers Jan 15, 2025

grendello Jan 15, 2025

jonathanpeppers Jan 15, 2025

grendello Jan 15, 2025

jonathanpeppers Jan 15, 2025

jonathanpeppers commented Jan 15, 2025

grendello commented Jan 15, 2025

		<_AndroidUseCLR Condition=" '$(AndroidRuntime)' == 'CoreCLR' ">True</_AndroidUseCLR>
		<_AndroidUseCLR Condition=" '$(AndroidRuntime)' != 'CoreCLR' ">False</_AndroidUseCLR>

CLR hosting #9572

Are you sure you want to change the base?

CLR hosting #9572

Conversation

grendello commented Dec 2, 2024 • edited Loading

jonathanpeppers Jan 15, 2025

Choose a reason for hiding this comment

grendello Jan 15, 2025

Choose a reason for hiding this comment

jonathanpeppers Jan 15, 2025

Choose a reason for hiding this comment

grendello Jan 15, 2025

Choose a reason for hiding this comment

jonathanpeppers Jan 15, 2025

Choose a reason for hiding this comment

jonathanpeppers commented Jan 15, 2025

grendello commented Jan 15, 2025

grendello commented Dec 2, 2024 •

edited

Loading