[dotnet] Add support for generating a binary version of runtimeconfig.json. Fixes #11745. #11887

rolfbjarne · 2021-06-10T14:52:17Z

Use Mono's RuntimeConfigParserTask to parse the *.runtimeconfig.json file and
produce a binary version of it. This way Mono doesn't have to do json parsing
at runtime, which makes it possible to make the runtimer smaller and execution
faster.

This also means implementing support for finding the on-disk location of the
file at runtime, and passing it to mono.

Ref: https://github.com/dotnet/runtime/blob/01b7e73cd378145264a7cb7a09365b41ed42b240/docs/design/mono/mobile-runtimeconfig-json.md

Fixes #11745.

….json. Fixes dotnet#11745. Use Mono's RuntimeConfigParserTask to parse the *.runtimeconfig.json file and produce a binary version of it. This way Mono doesn't have to do json parsing at runtime, which makes it possible to make the runtimer smaller and execution faster. This also means implementing support for finding the on-disk location of the file at runtime, and passing it to mono. Ref: https://github.com/dotnet/runtime/blob/01b7e73cd378145264a7cb7a09365b41ed42b240/docs/design/mono/mobile-runtimeconfig-json.md Fixes dotnet#11745.

rolfbjarne · 2021-06-10T15:20:21Z

CC @jonathanpeppers

jonathanpeppers · 2021-06-10T15:52:22Z

dotnet/targets/Xamarin.Shared.Sdk.targets

 	<!-- App bundle creation tasks -->
+
+	<Target Name="_CreateRuntimeConfiguration"
+		Condition="'$(UseMonoRuntime)' != 'false'"


You might also check here if $(GenerateRuntimeConfigurationFiles) is true?

If a user sets it to false in their project, I think the *.runtimeconfig.json file would not be created:

https://github.com/dotnet/sdk/blob/415f1b90e14ddbbcfd6e2cb2d91b27e72db54db0/src/Tasks/Microsoft.NET.Build.Tasks/targets/Microsoft.NET.Sdk.targets#L238

Hm yeah, good point, maybe we could even warn that some features won't work in that case.

spouliot

which makes it possible to make the runtimer

typo runtime[r]

smaller and execution faster.

Any numbers ?

spouliot · 2021-06-10T17:18:34Z

runtime/monovm-bridge.m


+	xamarin_initialize_runtime_config ();
+
 	rv = monovm_initialize (propertyCount, propertyKeys, propertyValues);


does not this call reset the values of the config file ?

No, the values we pass to the task here:

https://github.com/xamarin/xamarin-macios/pull/11887/files#diff-2e24f1b6f44df7580244d00f106fa1a9e2257536fbca9d7bbdc74571549324a9R522-R524

list the values we will later pass to monovm_initialize, so that the task can make sure there are no duplicates.

This is documented here: https://github.com/dotnet/runtime/blob/01b7e73cd378145264a7cb7a09365b41ed42b240/docs/design/mono/mobile-runtimeconfig-json.md#design-overview

rolfbjarne · 2021-06-10T18:12:45Z

smaller and execution faster.

Any numbers ?

No, I didn't measure this, it's partially mentioned here: https://github.com/dotnet/runtime/blob/01b7e73cd378145264a7cb7a09365b41ed42b240/docs/design/mono/mobile-runtimeconfig-json.md#motivation, but I've also seen it elsewhere (although I don't remember exactly where anymore).

spouliot

@rolfbjarne ah, I see

This way Mono doesn't have to do json parsing at runtime, which makes it possible to make the runtimer smaller and execution faster.

and

To minimize the impact on the app startup time, the design constraints are as follows:

are two different things.

The format minimize the impact (size / perf) versus a textual JSON file.

However that theoretical as we have no such thing today. As such it will not be possible to make the runtime smaller and faster than what we have today.

I'm fine just delete that phrase when committing the PR.

vs-mobiletools-engineering-service2 · 2021-06-10T20:38:30Z

❌ [PR Build] Tests failed on Build ❌

Tests failed on Build.

API diff

✅ API Diff from stable

View API diff

iOS vsdrops gist
macOS vsdrops gist
macCat vsdrops gist
macCatiOS gist
tvOS vsdrops gist
watchOS vsdrops gist

API & Generator diff

✅ API Diff (from PR only) (no change)
✅ Generator Diff (no change)

GitHub pages

Results can be found in the following github pages (it might take some time to publish):

Test results

2 tests failed, 108 tests passed.

Failed tests

MSBuild tests/Integration: Failed (Execution failed with exit code 32)
DotNet tests: Failed (Execution failed with exit code 1)

Pipeline on Agent XAMBOT-1104.BigSur'
Merge 8798580 into 8ca5d5e

…parser

…runtime config file (and warn if that's not the case).

vs-mobiletools-engineering-service2 · 2021-06-11T16:14:43Z

❌ [PR Build] Tests failed on Build ❌

Tests failed on Build.

API diff

✅ API Diff from stable

View API diff

iOS vsdrops gist
macOS vsdrops gist
macCat vsdrops gist
macCatiOS gist
tvOS vsdrops gist
watchOS vsdrops gist

API & Generator diff

✅ API Diff (from PR only) (no change)
✅ Generator Diff (no change)

GitHub pages

Results can be found in the following github pages (it might take some time to publish):

Test results

3 tests failed, 112 tests passed.

Failed tests

introspection/watchOS 32-bits - simulator/Debug (watchOS 5.0): Failed
MSBuild tests/Integration: Failed (Execution failed with exit code 32)
DotNet tests: Failed (Execution failed with exit code 1)

Pipeline on Agent XAMBOT-1104.BigSur'
Merge 30870b4 into 8bec55e

…in and .NET apps.

vs-mobiletools-engineering-service2 · 2021-06-15T00:42:39Z

❌ [PR Build] Tests failed on Build ❌

Tests failed on Build.

API diff

✅ API Diff from stable

View API diff

iOS vsdrops gist
macOS vsdrops gist
macCat vsdrops gist
macCatiOS gist
tvOS vsdrops gist
watchOS vsdrops gist

API & Generator diff

✅ API Diff (from PR only) (no change)
✅ Generator Diff (no change)

GitHub pages

Results can be found in the following github pages (it might take some time to publish):

Test results

2 tests failed, 173 tests passed.

Failed tests

introspection/watchOS 32-bits - simulator/Debug (watchOS 5.0): Failed
DotNet tests: Failed (Execution failed with exit code 1)

Pipeline on Agent XAMBOT-1102.BigSur'
Merge 7a307d0 into 51f0651

vs-mobiletools-engineering-service2 · 2021-06-15T19:20:02Z

❌ [PR Build] Tests failed on Build ❌

Tests failed on Build.

API diff

✅ API Diff from stable

View API diff

iOS vsdrops gist
macOS vsdrops gist
macCat vsdrops gist
macCatiOS gist
tvOS vsdrops gist
watchOS vsdrops gist

API & Generator diff

✅ API Diff (from PR only) (no change)
✅ Generator Diff (no change)

GitHub pages

Results can be found in the following github pages (it might take some time to publish):

Test results

2 tests failed, 173 tests passed.

Failed tests

introspection/watchOS 32-bits - simulator/Debug (watchOS 5.0): Failed
Generator tests/NUnit: Failed (Execution failed with exit code 1)

Pipeline on Agent XAMBOT-1104.BigSur'
Merge f255cc6 into 447c59d

rolfbjarne · 2021-06-15T22:15:15Z

/azp run

azure-pipelines · 2021-06-15T22:15:46Z

Azure Pipelines successfully started running 1 pipeline(s).

vs-mobiletools-engineering-service2 · 2021-06-15T23:00:51Z

🔥 Tests failed catastrophically on Build (no summary found). 🔥

Result file $(TEST_SUMMARY_PATH) not found.

Pipeline on Agent
Merge f255cc6 into 170ea55

rolfbjarne · 2021-06-16T04:58:40Z

/azp run

azure-pipelines · 2021-06-16T04:58:57Z

Azure Pipelines successfully started running 1 pipeline(s).

vs-mobiletools-engineering-service2 · 2021-06-16T12:09:16Z

❌ [PR Build] Tests failed on Build ❌

Tests failed on Build.

API diff

✅ API Diff from stable

View API diff

iOS vsdrops gist
macOS vsdrops gist
macCat vsdrops gist
macCatiOS gist
tvOS vsdrops gist
watchOS vsdrops gist

API & Generator diff

✅ API Diff (from PR only) (no change)
✅ Generator Diff (no change)

GitHub pages

Results can be found in the following github pages (it might take some time to publish):

Test results

3 tests failed, 172 tests passed.

Failed tests

monotouch-test/Mac [dotnet]/Debug [dotnet]: Failed (Test run crashed)
introspection/watchOS 32-bits - simulator/Debug (watchOS 5.0): Failed
Generator tests/NUnit: Failed (Execution failed with exit code 1)

Pipeline on Agent XAMBOT-1104.BigSur'
Merge f255cc6 into 170ea55

rolfbjarne · 2021-06-16T13:20:56Z

Test failures are unrelated

monotouch-test/Mac [dotnet]/Debug [dotnet]: https://github.com/xamarin/maccore/issues/2442
introspection/watchOS 32-bits - simulator/Debug (watchOS 5.0): https://github.com/xamarin/maccore/issues/2454
Generator tests/NUnit: GeneratorTests.BGenTests.StackOverflow20696157 fails #11947

tipa · 2023-02-15T10:08:11Z

@rolfbjarne I get this warning (which was introduced by this PR) on a iOS extension:
/usr/local/share/dotnet/packs/Microsoft.iOS.Sdk/16.2.1024/targets/Xamarin.Shared.Sdk.targets(979,3): warning : Some features may not work correctly, because the generation of the runtime configure file (*.runtimeconfig.json) has been disabled. [/Users/.../ShareExtension/ShareExtension.csproj]

I have not set GenerateRuntimeConfigurationFiles to false, but when I set it to true explicitly, the warning disappears. On the main project, the warning does not show up, even without having to set GenerateRuntimeConfigurationFiles=false.
Is it safe to ignore the warning? Should I set GenerateRuntimeConfigurationFiles=false or does this have any unwanted side-effects?

rolfbjarne requested a review from spouliot as a code owner June 10, 2021 14:52

rolfbjarne added not-notes-worthy Ignore for release notes run-dotnet-tests Run all the .NET tests labels Jun 10, 2021

jonathanpeppers reviewed Jun 10, 2021

View reviewed changes

mandel-macaque approved these changes Jun 10, 2021

View reviewed changes

spouliot reviewed Jun 10, 2021

View reviewed changes

spouliot approved these changes Jun 10, 2021

View reviewed changes

rolfbjarne added 2 commits June 11, 2021 11:48

Merge remote-tracking branch 'origin/main' into coreclr-runtimeconfig…

ff4ef4e

…parser

Only run the RuntimeConfigParserTask if we the build is generating a …

30870b4

…runtime config file (and warn if that's not the case).

rolfbjarne added 2 commits June 14, 2021 17:44

Dylibs don't go into the frameworks directory.

06d65d6

[tests] Ignore runtimeconfig.bin as a difference between legacy Xamar…

7a307d0

…in and .NET apps.

More fixes for dylibs.

f255cc6

rolfbjarne merged commit c8e854c into dotnet:main Jun 16, 2021

rolfbjarne deleted the coreclr-runtimeconfigparser branch June 16, 2021 13:22

rolfbjarne mentioned this pull request Feb 15, 2023

Warning in extension project: warning : Some features may not work correctly, because the generation of the runtime configure file (*.runtimeconfig.json) has been disabled. #17543

Closed


		xamarin_initialize_runtime_config ();

		rv = monovm_initialize (propertyCount, propertyKeys, propertyValues);

[dotnet] Add support for generating a binary version of runtimeconfig.json. Fixes #11745. #11887

[dotnet] Add support for generating a binary version of runtimeconfig.json. Fixes #11745. #11887

Uh oh!

Conversation

rolfbjarne commented Jun 10, 2021

Uh oh!

rolfbjarne commented Jun 10, 2021

Uh oh!

jonathanpeppers Jun 10, 2021

Choose a reason for hiding this comment

Uh oh!

rolfbjarne Jun 10, 2021

Choose a reason for hiding this comment

Uh oh!

spouliot left a comment

Choose a reason for hiding this comment

Uh oh!

spouliot Jun 10, 2021

Choose a reason for hiding this comment

Uh oh!

rolfbjarne Jun 10, 2021

Choose a reason for hiding this comment

Uh oh!

rolfbjarne commented Jun 10, 2021

Uh oh!

spouliot left a comment

Choose a reason for hiding this comment

Uh oh!

vs-mobiletools-engineering-service2 commented Jun 10, 2021

❌ [PR Build] Tests failed on Build ❌

API diff

API & Generator diff

GitHub pages

Test results

Failed tests

Uh oh!

vs-mobiletools-engineering-service2 commented Jun 11, 2021

❌ [PR Build] Tests failed on Build ❌

API diff

API & Generator diff

GitHub pages

Test results

Failed tests

Uh oh!

vs-mobiletools-engineering-service2 commented Jun 15, 2021

❌ [PR Build] Tests failed on Build ❌

API diff

API & Generator diff

GitHub pages

Test results

Failed tests

Uh oh!

vs-mobiletools-engineering-service2 commented Jun 15, 2021

❌ [PR Build] Tests failed on Build ❌

API diff

API & Generator diff

GitHub pages

Test results

Failed tests

Uh oh!

rolfbjarne commented Jun 15, 2021

Uh oh!

azure-pipelines bot commented Jun 15, 2021

Uh oh!

vs-mobiletools-engineering-service2 commented Jun 15, 2021

🔥 Tests failed catastrophically on Build (no summary found). 🔥

Uh oh!

rolfbjarne commented Jun 16, 2021

Uh oh!

azure-pipelines bot commented Jun 16, 2021

Uh oh!

vs-mobiletools-engineering-service2 commented Jun 16, 2021

❌ [PR Build] Tests failed on Build ❌

API diff

API & Generator diff

GitHub pages

Test results

Failed tests

Uh oh!

rolfbjarne commented Jun 16, 2021