[WIP] Remove android_coreclr_initialize and modify the existing one

Signature is altered on Android, by adding a pointer to the host contract
structure.

The host contract structure also gains a new pointer, `external_assembly_probe`
(proposed in dotnet#112706) which is used, if
present, when `bundle_probe` is `nullptr` or if it returns `false` when called.

Either `bundle_probe` or `external_assembly_probe` must be set in the contract

Author: grendello

src/coreclr/dlls/mscoree/exports.cpp

@@ -147,31 +147,6 @@ static void InitializeStartupFlags(STARTUP_FLAGS* startupFlagsRef)
     *startupFlagsRef = startupFlags;
 }
 
-#if defined(TARGET_ANDROID)
-static void ConvertConfigPropertiesToUnicode(
-    const host_configuration_properties* properties,
-    LPCWSTR** propertyKeysWRef,
-    LPCWSTR** propertyValuesWRef)
-{
-    LPCWSTR* propertyKeysW = new (nothrow) LPCWSTR[properties->nitems];
-    ASSERTE_ALL_BUILDS(propertyKeysW != nullptr);
-
-    LPCWSTR* propertyValuesW = new (nothrow) LPCWSTR[properties->nitems];
-    ASSERTE_ALL_BUILDS(propertyValuesW != nullptr);
-
-    for (size_t propertyIndex = 0; propertyIndex < properties->nitems; ++propertyIndex)
-    {
-        host_configuration_property const& prop = properties->data[propertyIndex];
-        propertyKeysW[propertyIndex] = prop.name;
-        propertyValuesW[propertyIndex] = prop.value;
-    }
-
-    *propertyKeysWRef = propertyKeysW;
-    *propertyValuesWRef = propertyValuesW;
-}
-
-#else // TARGET_ANDROID
-
 static void ConvertConfigPropertiesToUnicode(
     const char** propertyKeys,
     const char** propertyValues,
@@ -230,7 +205,6 @@ static void ConvertConfigPropertiesToUnicode(
     *propertyKeysWRef = propertyKeysW;
     *propertyValuesWRef = propertyValuesW;
 }
-#endif // !TARGET_ANDROID
 coreclr_error_writer_callback_fn g_errorWriter = nullptr;
 
 //
@@ -256,103 +230,6 @@ GetInfoForMethodDelegate getInfoForMethodDelegate = NULL;
 extern "C" int coreclr_create_delegate(void*, unsigned int, const char*, const char*, const char*, void**);
 #endif //FEATURE_GDBJIT
 
-#if defined(TARGET_ANDROID)
-extern "C"
-NOINLINE
-DLLEXPORT
-int android_coreclr_initialize(
-    const char* appName,
-    const char16_t* appDomainFriendlyName,
-    host_runtime_contract* hostContract,
-    const host_configuration_properties* properties,
-    void **hostHandle,
-    unsigned int* domainId)
-{
-    HostingApiFrameHolder apiFrameHolder(_ReturnAddress());
-
-    if (properties == nullptr) { [[unlikely]]
-        LogErrorToLogcat(ANDROID_LOG_FATAL, "Initialization routine was not passed the required configuration properties pointer.");
-        return HOST_E_INVALIDOPERATION;
-    }
-
-    if (properties->data == nullptr) { [[unlikely]]
-        LogErrorToLogcat(ANDROID_LOG_FATAL, "Initialization routine was not passed valid configuration properties data.");
-        return HOST_E_INVALIDOPERATION;
-    }
-
-    if (hostContract == nullptr) { [[unlikely]]
-        LogErrorToLogcat(ANDROID_LOG_FATAL, "Initialization routine was not passed the required host contract pointer.");
-        return HOST_E_INVALIDOPERATION;
-    }
-
-    if (hostContract->pinvoke_override == nullptr) { [[unlikely]]
-        LogErrorToLogcat(ANDROID_LOG_FATAL, "Host contract isn't initialized properly: missing p/invoke override handler.");
-        return HOST_E_INVALIDOPERATION;
-    }
-
-    if (hostContract->android_bundle_probe == nullptr) { [[unlikely]]
-        LogErrorToLogcat(ANDROID_LOG_FATAL, "Host contract isn't initialized properly: missing bundle probe handler.");
-        return HOST_E_INVALIDOPERATION;
-    }
-
-    LPCWSTR* propertyKeysW = nullptr;
-    LPCWSTR* propertyValuesW = nullptr;
-    ConvertConfigPropertiesToUnicode (properties, &propertyKeysW, &propertyValuesW);
-
-    // Android doesn't have executables as such (at least as far as Android applications are concerned),
-    // so we will use application name (package name) as the "executable path" here.
-    DWORD error = PAL_InitializeCoreCLR(appName, g_coreclr_embedded);
-    HRESULT hr = HRESULT_FROM_WIN32(error);
-
-    // If PAL initialization failed, then we should return right away and avoid
-    // calling any other APIs because they can end up calling into the PAL layer again.
-    if (FAILED(hr))
-    {
-        return hr;
-    }
-
-    HostInformation::SetContract(hostContract);
-    PInvokeOverride::SetPInvokeOverride(hostContract->pinvoke_override, PInvokeOverride::Source::RuntimeConfiguration);
-
-    ReleaseHolder<ICLRRuntimeHost4> host;
-    hr = CorHost2::CreateObject(IID_ICLRRuntimeHost4, (void**)&host);
-    IfFailRet(hr);
-
-    static Bundle bundle(appName, hostContract->android_bundle_probe);
-    Bundle::AppBundle = &bundle;
-
-    // This will take ownership of propertyKeysWTemp and propertyValuesWTemp
-    Configuration::InitializeConfigurationKnobs(static_cast<int>(properties->nitems), propertyKeysW, propertyValuesW);
-
-    STARTUP_FLAGS startupFlags;
-    InitializeStartupFlags(&startupFlags);
-
-    hr = host->SetStartupFlags(startupFlags);
-    IfFailRet(hr);
-
-    hr = host->Start();
-    IfFailRet(hr);
-
-    hr = host->CreateAppDomainWithManager(
-        appDomainFriendlyName,
-        APPDOMAIN_SECURITY_DEFAULT,
-        nullptr,                    // Name of the assembly that contains the AppDomainManager implementation
-        nullptr,                    // The AppDomainManager implementation type name
-        static_cast<int>(properties->nitems),
-        propertyKeysW,
-        propertyValuesW,
-        (DWORD *)domainId);
-
-    if (SUCCEEDED(hr))
-    {
-        host.SuppressRelease();
-        *hostHandle = host;
-    }
-    return hr;
-}
-
-#endif // TARGET_ANDROID
-
 //
 // Initialize the CoreCLR. Creates and starts CoreCLR host and creates an app domain
 //
@@ -372,6 +249,9 @@ extern "C"
 NOINLINE
 DLLEXPORT
 int coreclr_initialize(
+#if defined(TARGET_ANDROID)
+            host_runtime_contract* contract,
+#endif
             const char* exePath,
             const char* appDomainFriendlyName,
             int propertyCount,
@@ -380,14 +260,13 @@ int coreclr_initialize(
             void** hostHandle,
             unsigned int* domainId)
 {
-#if !defined(TARGET_ANDROID)
     HRESULT hr;
 
     LPCWSTR* propertyKeysW;
     LPCWSTR* propertyValuesW;
     BundleProbeFn* bundleProbe = nullptr;
     PInvokeOverrideFn* pinvokeOverride = nullptr;
-    host_runtime_contract* hostContract = nullptr;
+    host_runtime_contract* hostContract = contract;
 
 #ifdef TARGET_UNIX
     HostingApiFrameHolder apiFrameHolder(_ReturnAddress());
@@ -432,9 +311,10 @@ int coreclr_initialize(
 
     ConstWStringHolder appDomainFriendlyNameW = StringToUnicode(appDomainFriendlyName);
 
-    if (bundleProbe != nullptr)
+    ExternalAssemblyProbeFn* externalAssemblyProbe = contract != nullptr ? contract->external_assembly_probe : nullptr;
+    if (bundleProbe != nullptr || externalAssemblyProbe != nullptr)
     {
-        static Bundle bundle(exePath, bundleProbe);
+        static Bundle bundle(exePath, bundleProbe, externalAssemblyProbe);
         Bundle::AppBundle = &bundle;
     }
 
@@ -485,9 +365,6 @@ int coreclr_initialize(
 #endif
     }
     return hr;
-#else // TARGET_ANDROID
-    return HOST_E_INVALIDOPERATION;
-#endif
 }
 
 //

src/coreclr/dlls/mscoree/mscorwks_unixexports.src

@@ -1,6 +1,3 @@
-; Android hosting API
-android_coreclr_initialize
-
 ; Unix hosting API
 coreclr_create_delegate
 coreclr_execute_assembly

src/coreclr/hosts/corerun/corerun.cpp

@@ -404,6 +404,9 @@ static int run(const configuration& config)
 
     int result;
     result = coreclr_init_func(
+#if defined(TARGET_ANDROID)
+        nullptr, // contract
+#endif
         exe_path_utf8.c_str(),
         "corerun",
         propertyCount,

src/coreclr/hosts/inc/coreclrhost.h

@@ -33,19 +33,11 @@
     CORECLR_HOSTING_API_LINKAGE int CORECLR_CALLING_CONVENTION function(__VA_ARGS__); \
     typedef int (CORECLR_CALLING_CONVENTION *function##_ptr)(__VA_ARGS__)
 
-#if defined(TARGET_ANDROID)
-CORECLR_HOSTING_API(android_coreclr_initialize,
-            const char* appName,
-            const char16_t* appDomainFriendlyName,
-            host_runtime_contract* hostContract,
-            const host_configuration_properties* properties,
-            void **hostHandle,
-            unsigned int* domainId);
-#endif
 //
 // Initialize the CoreCLR. Creates and starts CoreCLR host and creates an app domain
 //
 // Parameters:
+//  hostContract            - (Android only) pointer to the host contract structure
 //  exePath                 - Absolute path of the executable that invoked the ExecuteAssembly (the native host application)
 //  appDomainFriendlyName   - Friendly name of the app domain that will be created to execute the assembly
 //  propertyCount           - Number of properties (elements of the following two arguments)
@@ -58,6 +50,9 @@ CORECLR_HOSTING_API(android_coreclr_initialize,
 //  HRESULT indicating status of the operation. S_OK if the assembly was successfully executed
 //
 CORECLR_HOSTING_API(coreclr_initialize,
+#if defined(TARGET_ANDROID)
+            host_runtime_contract* contract,
+#endif
             const char* exePath,
             const char* appDomainFriendlyName,
             int propertyCount,
@@ -163,11 +158,8 @@ CORECLR_HOSTING_API(coreclr_execute_assembly,
 //
 // Callback types used by the hosts
 //
-#if defined(TARGET_ANDROID)
-using BundleProbeFn = bool(const char* path, void** data_start, int64_t* size);
-#else
+using ExternalAssemblyProbeFn = bool(const char* path, void** data_start, int64_t* size);
 typedef bool(CORECLR_CALLING_CONVENTION BundleProbeFn)(const char* path, int64_t* offset, int64_t* size, int64_t* compressedSize);
-#endif
 typedef const void* (CORECLR_CALLING_CONVENTION PInvokeOverrideFn)(const char* libraryName, const char* entrypointName);
 
 

src/coreclr/inc/bundle.h

@@ -18,26 +18,18 @@ class Bundle;
 struct BundleFileLocation
 {
     INT64 Size;
-#if defined(TARGET_ANDROID)
     void* DataStart;
-    constexpr static INT64 Offset = 0;
-    constexpr static INT64 UncompresedSize = 0;
-#else
     INT64 Offset;
     INT64 UncompresedSize;
-#endif
 
     BundleFileLocation()
     {
         LIMITED_METHOD_CONTRACT;
 
         Size = 0;
-#if defined(TARGET_ANDROID)
         DataStart = INVALID_HANDLE_VALUE;
-#else
         Offset = 0;
         UncompresedSize = 0;
-#endif
     }
 
     static BundleFileLocation Invalid() { LIMITED_METHOD_CONTRACT; return BundleFileLocation(); }
@@ -54,7 +46,7 @@ struct BundleFileLocation
 class Bundle
 {
 public:
-    Bundle(LPCSTR bundlePath, BundleProbeFn *probe);
+    Bundle(LPCSTR bundlePath, BundleProbeFn *probe, ExternalAssemblyProbeFn* externalAssemblyProbe = nullptr);
     BundleFileLocation Probe(const SString& path, bool pathIsBundleRelative = false) const;
 
     const SString &Path() const { LIMITED_METHOD_CONTRACT; return m_path; }
@@ -70,6 +62,7 @@ class Bundle
 #endif
     SString m_path; // The path to single-file executable
     BundleProbeFn *m_probe;
+    ExternalAssemblyProbeFn *m_externalAssemblyProbe;
 
     SString m_basePath; // The prefix to denote a path within the bundle
     COUNT_T m_basePathLength = 0;

src/coreclr/vm/bundle.cpp

@@ -42,12 +42,13 @@ const SString &BundleFileLocation::AppName() const
 }
 #endif
 
-Bundle::Bundle(LPCSTR bundlePath, BundleProbeFn *probe)
+Bundle::Bundle(LPCSTR bundlePath, BundleProbeFn *probe, ExternalAssemblyProbeFn* externalAssemblyProbe)
 {
     STANDARD_VM_CONTRACT;
 
-    _ASSERTE(probe != nullptr);
+    _ASSERTE(probe != nullptr || externalAssemblyProbe != nullptr);
     m_probe = probe;
+    m_externalAssemblyProbe = externalAssemblyProbe;
 #if defined(TARGET_ANDROID)
     m_appName.SetUTF8(bundlePath);
 #else
@@ -105,11 +106,24 @@ BundleFileLocation Bundle::Probe(const SString& path, bool pathIsBundleRelative)
 #endif // !TARGET_ANDROID
     INT64 fileSize = 0;
     INT64 compressedSize = 0;
+    bool assemblyFound = false;
 
-#if defined(TARGET_ANDROID)
-    m_probe(utf8Path, &loc.DataStart, &loc.Size);
-#else
-    m_probe(utf8Path, &loc.Offset, &fileSize, &compressedSize);
+    if (m_probe != nullptr)
+    {
+        assemblyFound = m_probe(utf8Path, &loc.Offset, &fileSize, &compressedSize);
+        loc.DataStart = nullptr; // Location is based on the bundle file start
+    }
+
+    if (!assemblyFound && m_externalAssemblyProbe != nullptr)
+    {
+        m_externalAssemblyProbe (utf8Path, &loc.DataStart, &fileSize);
+
+        // Host takes care of decompression, if any
+        compressedSize = 0;
+
+        // Must always be 0 in this mode, since loc.DataStart points to the beginning of data
+        loc.Offset = 0;
+    }
 
     if (compressedSize)
     {
@@ -121,7 +135,7 @@ BundleFileLocation Bundle::Probe(const SString& path, bool pathIsBundleRelative)
         loc.Size = fileSize;
         loc.UncompresedSize = 0;
     }
-#endif
+
     return loc;
 }
 

src/coreclr/vm/peimagelayout.cpp

@@ -638,7 +638,7 @@ FlatImageLayout::FlatImageLayout(PEImage* pOwner)
 #else // !TARGET_ANDROID
     INT64 size = pOwner->GetSize();
     HANDLE mapBegin = pOwner->AndroidGetDataStart();
-    if (size == 0) {
+    if (size == 0 || mapBegin == nullptr) {
         // TODO: throw something
     }
 #endif // TARGET_ANDROID

src/native/corehost/host_runtime_contract.h

@@ -38,12 +38,12 @@ struct host_runtime_contract
         size_t value_buffer_size,
         void* contract_context);
 
-#if defined(TARGET_ANDROID)
-    bool(HOST_CONTRACT_CALLTYPE* android_bundle_probe)(
+    // Probe the host for `path`. Sets pointer to data start and its size, if found.
+    bool(HOST_CONTRACT_CALLTYPE* external_assembly_probe)(
         const char* path,
         void **data_start,
         int64_t* size);
-#endif
+
     // Probe an app bundle for `path`. Sets its location (`offset`, `size`) in the bundle if found.
     // Returns true if found, false otherwise.
     bool(HOST_CONTRACT_CALLTYPE* bundle_probe)(