[WIP] Include blob in apk and load it on runtime

grendello · grendello · commit 69eabe6ad75a · 2021-06-10T23:03:47.000+02:00
diff --git a/src/Xamarin.Android.Build.Tasks/Microsoft.Android.Sdk/targets/Microsoft.Android.Sdk.RuntimeConfig.targets b/src/Xamarin.Android.Build.Tasks/Microsoft.Android.Sdk/targets/Microsoft.Android.Sdk.RuntimeConfig.targets
@@ -40,6 +40,7 @@ See: https://github.com/dotnet/runtime/blob/b13715b6984889a709ba29ea8a1961db469f
 
   <Target Name="_ParseRuntimeConfigFiles"
       AfterTargets="GenerateBuildRuntimeConfigurationFiles"
+      Condition=" '$(GenerateRuntimeConfigurationFiles)' == 'true' "
       Inputs="$(ProjectRuntimeConfigFilePath)"
       Outputs="$(_BinaryRuntimeConfigPath)">
     <RuntimeConfigParserTask
diff --git a/src/Xamarin.Android.Build.Tasks/Tasks/BuildApk.cs b/src/Xamarin.Android.Build.Tasks/Tasks/BuildApk.cs
@@ -89,6 +89,8 @@ public class BuildApk : AndroidTask
 
 		public string CheckedBuild { get; set; }
 
+		public string RuntimeConfigBinFilePath { get; set; }
+
 		[Required]
 		public string ProjectFullPath { get; set; }
 
@@ -190,6 +192,10 @@ void ExecuteWithAbi (string [] supportedAbis, string apkInputPath, string apkOut
 					}
 				}
 
+				if (!String.IsNullOrEmpty (RuntimeConfigBinFilePath) && File.Exists (RuntimeConfigBinFilePath)) {
+					AddFileToArchiveIfNewer (apk, RuntimeConfigBinFilePath, $"{AssembliesPath}rc.bin", compressionMethod: UncompressedMethod);
+				}
+
 				int count = 0;
 				foreach (var file in files) {
 					var item = Path.Combine (file.archivePath.Replace (Path.DirectorySeparatorChar, '/'));
diff --git a/src/Xamarin.Android.Build.Tasks/Tasks/GeneratePackageManagerJava.cs b/src/Xamarin.Android.Build.Tasks/Tasks/GeneratePackageManagerJava.cs
@@ -59,6 +59,7 @@ public class GeneratePackageManagerJava : AndroidTask
 		[Required]
 		public bool InstantRunEnabled { get; set; }
 
+		public string RuntimeConfigBinFilePath { get; set; }
 		public string BoundExceptionType { get; set; }
 
 		public string PackageNamingPolicy { get; set; }
@@ -261,6 +262,7 @@ void AddEnvironment ()
 				throw new InvalidOperationException ($"Unsupported BoundExceptionType value '{BoundExceptionType}'");
 			}
 
+			bool haveRuntimeConfigBlob = !String.IsNullOrEmpty (RuntimeConfigBinFilePath) && File.Exists (RuntimeConfigBinFilePath);
 			var appConfState = BuildEngine4.GetRegisteredTaskObjectAssemblyLocal<ApplicationConfigTaskState> (ApplicationConfigTaskState.RegisterTaskObjectKey, RegisteredTaskObjectLifetime.Build);
 			foreach (string abi in SupportedAbis) {
 				NativeAssemblerTargetProvider asmTargetProvider = GetAssemblyTargetProvider (abi);
@@ -279,6 +281,7 @@ void AddEnvironment ()
 					BoundExceptionType = boundExceptionType,
 					InstantRunEnabled = InstantRunEnabled,
 					JniAddNativeMethodRegistrationAttributePresent = appConfState != null ? appConfState.JniAddNativeMethodRegistrationAttributePresent : false,
+					HaveRuntimeConfigBlob = haveRuntimeConfigBlob,
 				};
 
 				using (var sw = MemoryStreamPool.Shared.CreateStreamWriter ()) {
diff --git a/src/Xamarin.Android.Build.Tasks/Tests/Xamarin.Android.Build.Tests/PackagingTest.cs b/src/Xamarin.Android.Build.Tasks/Tests/Xamarin.Android.Build.Tests/PackagingTest.cs
@@ -86,6 +86,7 @@ public void CheckIncludedAssemblies ()
 				new [] {
 					"Java.Interop.dll",
 					"Mono.Android.dll",
+					"rc.bin",
 					"System.Private.CoreLib.dll",
 					"System.Runtime.dll",
 					"System.Linq.dll",
diff --git a/src/Xamarin.Android.Build.Tasks/Tests/Xamarin.Android.Build.Tests/Utilities/EnvironmentHelper.cs b/src/Xamarin.Android.Build.Tasks/Tests/Xamarin.Android.Build.Tests/Utilities/EnvironmentHelper.cs
@@ -25,6 +25,7 @@ public sealed class ApplicationConfig
 			public bool   broken_exception_transitions;
 			public bool   instant_run_enabled;
 			public bool   jni_add_native_method_registration_attribute_present;
+			public bool   have_runtime_config_blob;
 			public byte   bound_stream_io_exception_type;
 			public uint   package_naming_policy;
 			public uint   environment_variable_count;
@@ -150,27 +151,32 @@ static ApplicationConfig ReadApplicationConfig (string envFile)
 						ret.jni_add_native_method_registration_attribute_present = ConvertFieldToBool ("jni_add_native_method_registration_attribute_present", envFile, i, field [1]);
 						break;
 
-					case 7: // bound_stream_io_exception_type: byte / .byte
+					case 7:
+						AssertFieldType (envFile, ".byte", field [0], i);
+						ret.have_runtime_config_blob = ConvertFieldToBool ("have_runtime_config_blob", envFile, i, field [1]);
+						break;
+
+					case 8: // bound_stream_io_exception_type: byte / .byte
 						AssertFieldType (envFile, ".byte", field [0], i);
 						ret.bound_stream_io_exception_type = ConvertFieldToByte ("bound_stream_io_exception_type", envFile, i, field [1]);
 						break;
 
-					case 8: // package_naming_policy: uint32_t / .word | .long
+					case 9: // package_naming_policy: uint32_t / .word | .long
 						Assert.IsTrue (expectedUInt32Types.Contains (field [0]), $"Unexpected uint32_t field type in '{envFile}:{i}': {field [0]}");
 						ret.package_naming_policy = ConvertFieldToUInt32 ("package_naming_policy", envFile, i, field [1]);
 						break;
 
-					case 9: // environment_variable_count: uint32_t / .word | .long
+					case 10: // environment_variable_count: uint32_t / .word | .long
 						Assert.IsTrue (expectedUInt32Types.Contains (field [0]), $"Unexpected uint32_t field type in '{envFile}:{i}': {field [0]}");
 						ret.environment_variable_count = ConvertFieldToUInt32 ("environment_variable_count", envFile, i, field [1]);
 						break;
 
-					case 10: // system_property_count: uint32_t / .word | .long
+					case 11: // system_property_count: uint32_t / .word | .long
 						Assert.IsTrue (expectedUInt32Types.Contains (field [0]), $"Unexpected uint32_t field type in '{envFile}:{i}': {field [0]}");
 						ret.system_property_count = ConvertFieldToUInt32 ("system_property_count", envFile, i, field [1]);
 						break;
 
-					case 11: // android_package_name: string / [pointer type]
+					case 12: // android_package_name: string / [pointer type]
 						Assert.IsTrue (expectedPointerTypes.Contains (field [0]), $"Unexpected pointer field type in '{envFile}:{i}': {field [0]}");
 						pointers.Add (field [1].Trim ());
 						break;
diff --git a/src/Xamarin.Android.Build.Tasks/Tests/Xamarin.Android.Build.Tests/XASdkTests.cs b/src/Xamarin.Android.Build.Tasks/Tests/Xamarin.Android.Build.Tests/XASdkTests.cs
@@ -412,6 +412,7 @@ public void DotNetBuild (string runtimeIdentifiers, bool isRelease)
 				"es",
 				$"{proj.ProjectName}.dll",
 				$"{proj.ProjectName}.pdb",
+				$"{proj}.runtimeconfig.json",
 				$"{proj.ProjectName}.xml",
 			};
 			CollectionAssert.AreEqual (expectedFiles, files, $"Expected: {string.Join (";", expectedFiles)}\n   Found: {string.Join (";", files)}");
@@ -574,7 +575,7 @@ public abstract class Foo<TVirtualView, TNativeView> : AbstractViewHandler<TVirt
 	where TNativeView : Android.Views.View
 #else
 	where TNativeView : class
-#endif  
+#endif
 {
 		protected Foo (PropertyMapper mapper) : base(mapper)
 		{
diff --git a/src/Xamarin.Android.Build.Tasks/Utilities/ApplicationConfigNativeAssemblyGenerator.cs b/src/Xamarin.Android.Build.Tasks/Utilities/ApplicationConfigNativeAssemblyGenerator.cs
@@ -22,6 +22,7 @@ class ApplicationConfigNativeAssemblyGenerator : NativeAssemblyGenerator
 		public global::Android.Runtime.BoundExceptionType BoundExceptionType { get; set; }
 		public bool InstantRunEnabled { get; set; }
 		public bool JniAddNativeMethodRegistrationAttributePresent { get; set; }
+		public bool HaveRuntimeConfigBlob { get; set; }
 
 		public PackageNamingPolicy PackageNamingPolicy { get; set; }
 
@@ -70,6 +71,9 @@ protected override void WriteSymbols (StreamWriter output)
 				WriteCommentLine (output, "jni_add_native_method_registration_attribute_present");
 				size += WriteData (output, JniAddNativeMethodRegistrationAttributePresent);
 
+				WriteCommentLine (output, "have_runtime_config_blob");
+				size += WriteData (output, HaveRuntimeConfigBlob);
+
 				WriteCommentLine (output, "bound_exception_type");
 				size += WriteData (output, (byte)BoundExceptionType);
 
diff --git a/src/Xamarin.Android.Build.Tasks/Xamarin.Android.Common.targets b/src/Xamarin.Android.Build.Tasks/Xamarin.Android.Common.targets
@@ -1567,6 +1567,7 @@ because xbuild doesn't support framework reference assemblies.
     PackageNamingPolicy="$(AndroidPackageNamingPolicy)"
     BoundExceptionType="$(AndroidBoundExceptionType)"
     InstantRunEnabled="$(_InstantRunEnabled)"
+    RuntimeConfigBinFilePath="$(_BinaryRuntimeConfigPath)"
   >
     <Output TaskParameter="BuildId" PropertyName="_XamarinBuildId" />
   </GeneratePackageManagerJava>
@@ -2036,7 +2037,8 @@ because xbuild doesn't support framework reference assemblies.
     UncompressedFileExtensions="$(AndroidStoreUncompressedFileExtensions)"
     ProjectFullPath="$(MSBuildProjectFullPath)"
     IncludeWrapSh="$(AndroidIncludeWrapSh)"
-    CheckedBuild="$(_AndroidCheckedBuild)">
+    CheckedBuild="$(_AndroidCheckedBuild)"
+    RuntimeConfigBinFilePath="$(_BinaryRuntimeConfigPath)">
     <Output TaskParameter="OutputFiles" ItemName="ApkFiles" />
   </BuildApk>
   <BuildBaseAppBundle
diff --git a/src/monodroid/jni/application_dso_stub.cc b/src/monodroid/jni/application_dso_stub.cc
@@ -42,6 +42,7 @@ ApplicationConfig application_config = {
 	/*.broken_exception_transitions =*/ false,
 	/*.instant_run_enabled =*/ false,
 	/*.jni_add_native_method_registration_attribute_present =*/ false,
+	/*.have_runtime_config_blob =*/ false,
 	/*.bound_exception_type =*/ 0, // System
 	/*.package_naming_policy =*/ 0,
 	/*.environment_variable_count =*/ 0,
diff --git a/src/monodroid/jni/embedded-assemblies-zip.cc b/src/monodroid/jni/embedded-assemblies-zip.cc
@@ -51,6 +51,9 @@ EmbeddedAssemblies::zip_load_entries (int fd, const char *apk_name, monodroid_sh
 	}
 
 	dynamic_local_string<SENSIBLE_PATH_MAX> entry_name;
+#if defined (NET6)
+	bool runtime_config_blob_found = false;
+#endif // def NET6
 
 	// clang-tidy claims we have a leak in the loop:
 	//
@@ -87,6 +90,16 @@ EmbeddedAssemblies::zip_load_entries (int fd, const char *apk_name, monodroid_sh
 		if (strncmp (prefix, file_name, prefix_len) != 0)
 			continue;
 
+#if defined (NET6)
+		if (application_config.have_runtime_config_blob && !runtime_config_blob_found) {
+			if (utils.ends_with (file_name, SharedConstants::RUNTIME_CONFIG_BLOB_NAME)) {
+				runtime_config_blob_found = true;
+				runtime_config_blob_mmap = md_mmap_apk_file (fd, data_offset, file_size, file_name, apk_name);
+				continue;
+			}
+		}
+#endif // def NET6
+
 		// assemblies must be 4-byte aligned, or Bad Things happen
 		if ((data_offset & 0x3) != 0) {
 			log_fatal (LOG_ASSEMBLY, "Assembly '%s' is located at bad offset %lu within the .apk\n", file_name, data_offset);
diff --git a/src/monodroid/jni/embedded-assemblies.hh b/src/monodroid/jni/embedded-assemblies.hh
@@ -3,6 +3,7 @@
 #define INC_MONODROID_EMBEDDED_ASSEMBLIES_H
 
 #include <cstring>
+#include <limits>
 #include <mono/metadata/object.h>
 #include <mono/metadata/assembly.h>
 
@@ -12,6 +13,7 @@
 
 #include "strings.hh"
 #include "xamarin-app.hh"
+#include "cpp-util.hh"
 
 struct TypeMapHeader;
 
@@ -71,6 +73,21 @@ namespace xamarin::android::internal {
 
 		void set_assemblies_prefix (const char *prefix);
 
+#if defined (NET6)
+		void get_runtime_config_blob (const char *& area, uint32_t& size) const
+		{
+			area = static_cast<char*>(runtime_config_blob_mmap.area);
+
+			abort_unless (runtime_config_blob_mmap.size < std::numeric_limits<uint32_t>::max (), "Runtime config binary blob size exceeds %u bytes", std::numeric_limits<uint32_t>::max ());
+			size = static_cast<uint32_t>(runtime_config_blob_mmap.size);
+		}
+
+		bool have_runtime_config_blob () const
+		{
+			return application_config.have_runtime_config_blob && runtime_config_blob_mmap.area != nullptr;
+		}
+#endif
+
 	private:
 		const char* typemap_managed_to_java (MonoType *type, MonoClass *klass, const uint8_t *mvid);
 		MonoReflectionType* typemap_java_to_managed (const char *java_type_name);
@@ -140,6 +157,9 @@ namespace xamarin::android::internal {
 		size_t                 type_map_count;
 #endif // DEBUG || !ANDROID
 		const char            *assemblies_prefix_override = nullptr;
+#if defined (NET6)
+		md_mmap_info           runtime_config_blob_mmap{};
+#endif // def NET6
 	};
 }
 
diff --git a/src/monodroid/jni/monodroid-glue-internal.hh b/src/monodroid/jni/monodroid-glue-internal.hh
@@ -204,6 +204,7 @@ namespace xamarin::android::internal
 		static const char* get_my_location (bool remove_file_name = true);
 #endif  // defined(WINDOWS) || defined(APPLE_OS_X)
 #if defined (NET6)
+		static void  cleanup_runtime_config (MonovmRuntimeConfigArguments *args, void *user_data);
 		static void* load_library_entry (std::string const& library_name, std::string const& entrypoint_name, pinvoke_api_map_ptr api_map);
 		static void* fetch_or_create_pinvoke_map_entry (std::string const& library_name, std::string const& entrypoint_name, pinvoke_api_map_ptr api_map, bool need_lock);
 		static void* monodroid_pinvoke_override (const char *library_name, const char *entrypoint_name);
@@ -305,6 +306,7 @@ namespace xamarin::android::internal
 		static pinvoke_api_map        xa_pinvoke_map;
 		static pinvoke_library_map    other_pinvoke_map;
 		static MonoCoreRuntimeProperties monovm_core_properties;
+		MonovmRuntimeConfigArguments  runtime_config_args;
 #else // def NET6
 		static std::mutex   api_init_lock;
 		static void        *api_dso_handle;
diff --git a/src/monodroid/jni/monodroid-glue.cc b/src/monodroid/jni/monodroid-glue.cc
@@ -843,6 +843,20 @@ MonodroidRuntime::mono_runtime_init ([[maybe_unused]] dynamic_local_string<PROPE
 #endif
 }
 
+#if defined (NET6)
+void
+MonodroidRuntime::cleanup_runtime_config (MonovmRuntimeConfigArguments *args, [[maybe_unused]] void *user_data)
+{
+	if (args == nullptr || args->kind != 1 || args->runtimeconfig.data.data == nullptr) {
+		return;
+	}
+
+#if !defined (WINDOWS)
+	munmap (static_cast<void*>(const_cast<char*>(args->runtimeconfig.data.data)), args->runtimeconfig.data.data_len);
+#endif // ndef WINDOWS
+}
+#endif // def NET6
+
 MonoDomain*
 MonodroidRuntime::create_domain (JNIEnv *env, jstring_array_wrapper &runtimeApks, bool is_root_domain)
 {
@@ -855,6 +869,23 @@ MonodroidRuntime::create_domain (JNIEnv *env, jstring_array_wrapper &runtimeApks
 
 	gather_bundled_assemblies (runtimeApks, &user_assemblies_count);
 
+#if defined (NET6)
+	timing_period blob_time;
+	if (XA_UNLIKELY (utils.should_log (LOG_TIMING)))
+		blob_time.mark_start ();
+
+	if (embeddedAssemblies.have_runtime_config_blob ()) {
+		runtime_config_args.kind = 1;
+		embeddedAssemblies.get_runtime_config_blob (runtime_config_args.runtimeconfig.data.data, runtime_config_args.runtimeconfig.data.data_len);
+		monovm_runtimeconfig_initialize (&runtime_config_args, cleanup_runtime_config, nullptr);
+	}
+
+	if (XA_UNLIKELY (utils.should_log (LOG_TIMING))) {
+		blob_time.mark_end ();
+		Timing::info (blob_time, "Register runtimeconfig binary blob");
+	}
+#endif // def NET6
+
 	if (!have_mono_mkbundle_init && user_assemblies_count == 0 && androidSystem.count_override_assemblies () == 0 && !is_running_on_desktop) {
 		log_fatal (LOG_DEFAULT, "No assemblies found in '%s' or '%s'. Assuming this is part of Fast Deployment. Exiting...",
 		           androidSystem.get_override_dir (0),
diff --git a/src/monodroid/jni/shared-constants.hh b/src/monodroid/jni/shared-constants.hh
@@ -15,6 +15,10 @@ namespace xamarin::android::internal
 	class SharedConstants
 	{
 	public:
+#if defined (NET6)
+		static constexpr char RUNTIME_CONFIG_BLOB_NAME[] = "rc.bin";
+#endif // def NET6
+
 #if defined (ANDROID) || defined (__linux__) || defined (__linux)
 		static constexpr char MONO_SGEN_SO[]      = "libmonosgen-2.0.so";
 		static constexpr char MONO_SGEN_ARCH_SO[] = "libmonosgen-" __BITNESS__ "-2.0.so";
diff --git a/src/monodroid/jni/xamarin-app.hh b/src/monodroid/jni/xamarin-app.hh
@@ -105,6 +105,7 @@ struct ApplicationConfig
 	bool broken_exception_transitions;
 	bool instant_run_enabled;
 	bool jni_add_native_method_registration_attribute_present;
+	bool have_runtime_config_blob;
 	uint8_t bound_exception_type;
 	uint32_t package_naming_policy;
 	uint32_t environment_variable_count;
