Add Android build configurations for Mono/Libraries (#33881)

* Add Android build configurations

* Enable System.Globalization.Native on Android

Dynamically load the libicu from the system. Android NDK doesn't ship with icu headers so for now define prototypes for all the functions we use ourselves.

* Add temporary stub HashProvider that throws NIE on Android

We still need to hook up the native System.Security.Native library.

Unblocks Xamarin.Forms startup.

Author: akoeplinger

eng/Subsets.props

@@ -58,7 +58,7 @@
 
   <PropertyGroup>
     <DefaultSubsetCategories>libraries-installer-coreclr-mono</DefaultSubsetCategories>
-    <DefaultSubsetCategories Condition="'$(TargetOS)' == 'iOS'">libraries-mono</DefaultSubsetCategories>
+    <DefaultSubsetCategories Condition="'$(TargetOS)' == 'iOS' or '$(TargetOS)' == 'Android'">libraries-mono</DefaultSubsetCategories>
     <DefaultInstallerSubsets>corehost-managed-depproj-pkgproj-bundle-installers-test</DefaultInstallerSubsets>
     <!-- TODO: Split into multiple sets. -->
     <DefaultLibrariesSubsets>all</DefaultLibrariesSubsets>
@@ -78,7 +78,7 @@
   </PropertyGroup>
 
   <PropertyGroup>
-    <RuntimeFlavor Condition="'$(TargetOS)' == 'iOS'">Mono</RuntimeFlavor>
+    <RuntimeFlavor Condition="'$(TargetOS)' == 'iOS' or '$(TargetOS)' == 'Android'">Mono</RuntimeFlavor>
     <RuntimeFlavor Condition="'$(RuntimeFlavor)' == '' and $(_subsetCategory.Contains('mono')) and !$(_subsetCategory.Contains('coreclr'))">Mono</RuntimeFlavor>
     <RuntimeFlavor Condition="'$(RuntimeFlavor)' == ''">CoreCLR</RuntimeFlavor>
   </PropertyGroup>

eng/build.sh

@@ -19,7 +19,7 @@ usage()
   echo "Common settings:"
   echo "  --subset                   Build a subset, print available subsets with -subset help"
   echo "  --subsetCategory           Build a subsetCategory, print available subsetCategories with -subset help"
-  echo "  --os                       Build operating system: Windows_NT or Unix"
+  echo "  --os                       Build operating system: Windows_NT, Linux, FreeBSD, OSX, iOS or Android"
   echo "  --arch                     Build platform: x86, x64, arm or arm64"
   echo "  --configuration            Build configuration: Debug, Release or [CoreCLR]Checked (short: -c)"
   echo "  --runtimeConfiguration     Runtime build configuration: Debug, Release or [CoreCLR]Checked"

eng/codeOptimization.targets

@@ -9,7 +9,7 @@
            IBCMerge optimizations on Mac for now to unblock the offical build.
            See issue https://github.com/dotnet/runtime/issues/33303
       -->
-      <IsEligibleForNgenOptimization Condition="'$(TargetOS)' == 'OSX' or '$(TargetOS)' == 'iOS'">false</IsEligibleForNgenOptimization>
+      <IsEligibleForNgenOptimization Condition="'$(TargetOS)' == 'OSX' or '$(TargetOS)' == 'iOS' or '$(TargetOS)' == 'Android'">false</IsEligibleForNgenOptimization>
   </PropertyGroup>
 
   <Target Name="SetApplyNgenOptimization"

eng/native/configureplatform.cmake

@@ -11,9 +11,9 @@ set(PRERELEASE 1)
 #     - for windows we use the passed in parameter to CMAKE to determine build arch
 #----------------------------------------
 set(CLR_CMAKE_HOST_OS ${CMAKE_SYSTEM_NAME})
-if(CLR_CMAKE_HOST_OS STREQUAL Linux OR CLR_CMAKE_HOST_OS STREQUAL Android)
+if(CLR_CMAKE_HOST_OS STREQUAL Linux)
     set(CLR_CMAKE_HOST_UNIX 1)
-    if(CLR_CROSS_COMPONENTS_BUILD AND NOT CLR_CMAKE_HOST_OS STREQUAL Android)
+    if(CLR_CROSS_COMPONENTS_BUILD)
         # CMAKE_HOST_SYSTEM_PROCESSOR returns the value of `uname -p` on host.
         if(CMAKE_HOST_SYSTEM_PROCESSOR STREQUAL x86_64 OR CMAKE_HOST_SYSTEM_PROCESSOR STREQUAL amd64)
             if(CLR_CMAKE_TARGET_ARCH STREQUAL "arm" OR CLR_CMAKE_TARGET_ARCH STREQUAL "armel")
@@ -74,12 +74,7 @@ if(CLR_CMAKE_HOST_OS STREQUAL Linux OR CLR_CMAKE_HOST_OS STREQUAL Android)
             set(CLR_CMAKE_HOST_OS ${CLR_CMAKE_LINUX_ID})
         endif()
     endif(DEFINED CLR_CMAKE_LINUX_ID)
-
-    if(CLR_CMAKE_HOST_OS STREQUAL Android)
-        set(CLR_CMAKE_HOST_ANDROID 1)
-        set(CLR_CMAKE_HOST_OS ${CLR_CMAKE_HOST_OS})
-    endif()
-endif(CLR_CMAKE_HOST_OS STREQUAL Linux OR CLR_CMAKE_HOST_OS STREQUAL Android)
+endif(CLR_CMAKE_HOST_OS STREQUAL Linux)
 
 if(CLR_CMAKE_HOST_OS STREQUAL Darwin)
     set(CLR_CMAKE_HOST_UNIX 1)
@@ -102,6 +97,23 @@ if(CLR_CMAKE_HOST_OS STREQUAL iOS)
     endif()
 endif(CLR_CMAKE_HOST_OS STREQUAL iOS)
 
+if(CLR_CMAKE_HOST_OS STREQUAL Android)
+    set(CLR_CMAKE_HOST_UNIX 1)
+    set(CLR_CMAKE_HOST_LINUX 1)
+    set(CLR_CMAKE_HOST_ANDROID 1)
+    if(CMAKE_SYSTEM_PROCESSOR STREQUAL x86_64)
+        set(CLR_CMAKE_HOST_UNIX_AMD64 1)
+    elseif(CMAKE_SYSTEM_PROCESSOR STREQUAL armv7-a)
+        set(CLR_CMAKE_HOST_UNIX_ARM 1)
+    elseif(CMAKE_SYSTEM_PROCESSOR STREQUAL aarch64)
+        set(CLR_CMAKE_HOST_UNIX_ARM64 1)
+    elseif(CMAKE_SYSTEM_PROCESSOR STREQUAL i686)
+        set(CLR_CMAKE_HOST_UNIX_X86 1)
+    else()
+        clr_unknown_arch()
+    endif()
+endif(CLR_CMAKE_HOST_OS STREQUAL Android)
+
 if(CLR_CMAKE_HOST_OS STREQUAL FreeBSD)
     set(CLR_CMAKE_HOST_UNIX 1)
     set(CLR_CMAKE_HOST_UNIX_AMD64 1)
@@ -315,6 +327,7 @@ else()
 endif()
 
 if(NOT CLR_CMAKE_HOST_ARCH_WASM)
+if(NOT CLR_CMAKE_TARGET_ANDROID) # Android requires PIC and CMake handles this so we don't need the check
     # All code we build should be compiled as position independent
     get_property(languages GLOBAL PROPERTY ENABLED_LANGUAGES)
     if("CXX" IN_LIST languages)
@@ -328,6 +341,5 @@ if(NOT CLR_CMAKE_HOST_ARCH_WASM)
                   "PIE link options will not be passed to linker.")
     endif()
     set(CMAKE_POSITION_INDEPENDENT_CODE ON)
+endif(NOT CLR_CMAKE_TARGET_ANDROID)
 endif(NOT CLR_CMAKE_HOST_ARCH_WASM)
-
-set(CLR_CMAKE_CONFIGURE_PLATFORM_INCLUDED 1)

eng/native/configuretools.cmake

@@ -47,11 +47,11 @@ if(NOT WIN32)
     locate_toolchain_exec(ranlib CMAKE_RANLIB)
   endif()
 
-  if(NOT CLR_CMAKE_TARGET_OSX AND NOT CLR_CMAKE_TARGET_IOS)
+  if(NOT CLR_CMAKE_TARGET_OSX AND NOT CLR_CMAKE_TARGET_IOS AND (NOT CLR_CMAKE_TARGET_ANDROID OR CROSS_ROOTFS))
     locate_toolchain_exec(objdump CMAKE_OBJDUMP)
 
-    if(CMAKE_SYSTEM_NAME STREQUAL Android)
-      set(TOOSET_PREFIX ${ANDROID_TOOLCHAIN_PREFIX})
+    if(CLR_CMAKE_TARGET_ANDROID)
+      set(TOOLSET_PREFIX ${ANDROID_TOOLCHAIN_PREFIX})
     elseif(CMAKE_CROSSCOMPILING AND NOT DEFINED CLR_CROSS_COMPONENTS_BUILD AND (CMAKE_SYSTEM_PROCESSOR STREQUAL armv7l OR
        CMAKE_SYSTEM_PROCESSOR STREQUAL aarch64 OR CMAKE_SYSTEM_PROCESSOR STREQUAL arm))
       set(TOOLSET_PREFIX "${TOOLCHAIN}-")
@@ -60,5 +60,5 @@ if(NOT WIN32)
     endif()
 
     locate_toolchain_exec(objcopy CMAKE_OBJCOPY)
-  endif(NOT CLR_CMAKE_TARGET_OSX AND NOT CLR_CMAKE_TARGET_IOS)
+  endif()
 endif()

eng/native/init-distro-rid.sh

@@ -163,6 +163,8 @@ initDistroRidGlobal()
                 distroRid="osx-$buildArch"
             elif [ "$targetOs" = "iOS" ]; then
                 distroRid="ios-$buildArch"
+            elif [ "$targetOs" = "Android" ]; then
+                distroRid="android-$buildArch"
             elif [ "$targetOs" = "FreeBSD" ]; then
                 distroRid="freebsd-$buildArch"
             fi

src/libraries/Directory.Build.props

@@ -63,12 +63,14 @@
     <ArchGroup Condition="'$(ArchGroup)' == '' and '$(HostArch)' == 'arm64'">arm64</ArchGroup>
     <ArchGroup Condition="'$(ArchGroup)' == '' and '$(TargetOS)' == 'WebAssembly'">wasm</ArchGroup>
     <ArchGroup Condition="'$(ArchGroup)' == '' and '$(TargetOS)' == 'iOS'">x64</ArchGroup>
+    <ArchGroup Condition="'$(ArchGroup)' == '' and '$(TargetOS)' == 'Android'">x64</ArchGroup>
     <ArchGroup Condition="'$(ArchGroup)' == ''">x64</ArchGroup>
 
-    <!-- RuntimeOS is calculated based on the build system OS, however if building for WebAssembly or iOS we need to let
-         the build system to use webassembly/ios as the RuntimeOS for produced package RIDs. -->
+    <!-- RuntimeOS is calculated based on the build system OS, however if building for WebAssembly/iOS/Android we need to let
+         the build system to use webassembly/ios/android as the RuntimeOS for produced package RIDs. -->
     <RuntimeOS Condition="'$(TargetOS)' == 'WebAssembly'">$(TargetOS.ToLowerInvariant())</RuntimeOS>
     <RuntimeOS Condition="'$(TargetOS)' == 'iOS'">$(TargetOS.ToLowerInvariant())</RuntimeOS>
+    <RuntimeOS Condition="'$(TargetOS)' == 'Android'">$(TargetOS.ToLowerInvariant())</RuntimeOS>
 
     <!-- Initialize BuildSettings from the individual properties if it wasn't already explicitly set -->
     <Configuration Condition="'$(Configuration)'==''">Debug</Configuration>
@@ -95,6 +97,14 @@
         <PackageTargetRuntime>linux</PackageTargetRuntime>
       </PropertyGroup>
     </When>
+    <When Condition="'$(TargetFrameworkSuffix)' == 'Android'">
+      <PropertyGroup>
+        <TargetsUnix>true</TargetsUnix>
+        <TargetsLinux>true</TargetsLinux>
+        <TargetsAndroid>true</TargetsAndroid>
+        <PackageTargetRuntime>android</PackageTargetRuntime>
+      </PropertyGroup>
+    </When>
     <When Condition="'$(TargetFrameworkSuffix)' == 'OSX'">
       <PropertyGroup>
         <TargetsUnix>true</TargetsUnix>
@@ -186,6 +196,7 @@
     <_portableOS Condition="'$(_runtimeOSFamily)' == 'FreeBSD'">freebsd</_portableOS>
     <_portableOS Condition="'$(RuntimeOS)' == 'WebAssembly'">webassembly</_portableOS>
     <_portableOS Condition="'$(RuntimeOS)' == 'ios'">ios</_portableOS>
+    <_portableOS Condition="'$(RuntimeOS)' == 'android'">android</_portableOS>
 
     <_runtimeOS>$(RuntimeOS)</_runtimeOS>
     <_runtimeOS Condition="'$(_runtimeOS)' == 'tizen.4.0.0'">linux</_runtimeOS>
@@ -202,6 +213,11 @@
     <ToolRuntimeRID Condition="'$(RuntimeOS)' == 'webassembly' and '$(TargetOS)' != 'Windows_NT' and $(_buildingInOSX)">osx-x64</ToolRuntimeRID>
     <ToolRuntimeRID Condition="'$(RuntimeOS)' == 'webassembly' and '$(TargetOS)' != 'Windows_NT' and !$(_buildingInOSX)">linux-x64</ToolRuntimeRID>
 
+    <!-- There are no Android tools, so use the default ones -->
+    <ToolRuntimeRID Condition="'$(RuntimeOS)' == 'android' and '$(TargetOS)' == 'Windows_NT'">win-x64</ToolRuntimeRID>
+    <ToolRuntimeRID Condition="'$(RuntimeOS)' == 'android' and '$(TargetOS)' != 'Windows_NT' and $(_buildingInOSX)">osx-x64</ToolRuntimeRID>
+    <ToolRuntimeRID Condition="'$(RuntimeOS)' == 'android' and '$(TargetOS)' != 'Windows_NT' and !$(_buildingInOSX)">linux-x64</ToolRuntimeRID>
+
     <!-- There are no iOS tools and it can be built on OSX only, so use that -->
     <ToolRuntimeRID Condition="'$(RuntimeOS)' == 'ios'">osx-x64</ToolRuntimeRID>
 

src/libraries/Native/Unix/CMakeLists.txt

@@ -91,7 +91,9 @@ endif ()
 
 if(CLR_CMAKE_TARGET_ANDROID)
     add_definitions(-DTARGET_ANDROID)
-    include_directories(SYSTEM "${CROSS_ROOTFS}/usr/include")
+    if(CROSS_ROOTFS)
+        include_directories(SYSTEM "${CROSS_ROOTFS}/usr/include")
+    endif()
 endif()
 
 string(TOUPPER ${CMAKE_BUILD_TYPE} UPPERCASE_CMAKE_BUILD_TYPE)
@@ -195,18 +197,22 @@ endif()
 
 add_subdirectory(System.Native)
 
-if (NOT CLR_CMAKE_TARGET_ARCH_WASM)
+if(CLR_CMAKE_TARGET_ARCH_WASM)
+    # skip for now
+elseif(CLR_CMAKE_TARGET_IOS)
     add_subdirectory(System.Net.Security.Native)
-
-if (NOT CLR_CMAKE_TARGET_IOS)
-    # TODO: reenable for iOS
+    #add_subdirectory(System.Globalization.Native) # TODO: reenable
+    # System.Security.Cryptography.Native is intentionally disabled on iOS
+    # it is only used for interacting with OpenSSL which isn't useful there
+elseif(CLR_CMAKE_TARGET_ANDROID AND NOT CROSS_ROOTFS)
     add_subdirectory(System.Globalization.Native)
-
-    # disable System.Security.Cryptography.Native build on iOS,
-    # only used for interacting with OpenSSL which isn't useful there
+    #add_subdirectory(System.Net.Security.Native) # TODO: reenable
+    #add_subdirectory(System.Security.Cryptography.Native) # TODO: reenable
+else()
+    add_subdirectory(System.Globalization.Native)
+    add_subdirectory(System.Net.Security.Native)
     add_subdirectory(System.Security.Cryptography.Native)
 endif()
-endif()
 
 if(CLR_CMAKE_TARGET_OSX OR CLR_CMAKE_TARGET_IOS)
     add_subdirectory(System.Security.Cryptography.Native.Apple)

src/libraries/Native/Unix/Common/pal_config.h.in

@@ -35,6 +35,7 @@
 #cmakedefine01 HAVE_TIOCGWINSZ
 #cmakedefine01 HAVE_SCHED_GETAFFINITY
 #cmakedefine01 HAVE_SCHED_SETAFFINITY
+#cmakedefine01 HAVE_PTHREAD_SETCANCELSTATE
 #cmakedefine01 HAVE_ARC4RANDOM_BUF
 #cmakedefine01 KEVENT_HAS_VOID_UDATA
 #cmakedefine01 HAVE_FDS_BITS
@@ -100,7 +101,6 @@
 #cmakedefine01 HAVE_TCP_H_TCP_KEEPALIVE
 #cmakedefine01 HAVE_BUILTIN_MUL_OVERFLOW
 #cmakedefine01 HAVE_DISCONNECTX
-#cmakedefine01 HAVE_PTHREAD_SETCANCELSTATE
 
 // Mac OS X has stat64, but it is deprecated since plain stat now
 // provides the same 64-bit aware struct when targeting OS X > 10.5

src/libraries/Native/Unix/System.Globalization.Native/CMakeLists.txt

@@ -13,37 +13,39 @@ if(CLR_CMAKE_TARGET_UNIX)
     add_compile_options(-Wno-extra-semi-stmt)
     add_compile_options(-Wno-unknown-warning-option)
 
-    set(ICU_HOMEBREW_INC_PATH "/usr/local/opt/icu4c/include")
+    if (NOT CLR_CMAKE_TARGET_ANDROID)
+        set(ICU_HOMEBREW_INC_PATH "/usr/local/opt/icu4c/include")
 
-    find_path(UTYPES_H "unicode/utypes.h" PATHS ${ICU_HOMEBREW_INC_PATH})
-    if(UTYPES_H STREQUAL UTYPES_H-NOTFOUND)
-        message(FATAL_ERROR "Cannot find utypes.h, try installing libicu-dev (or the appropriate package for your platform)")
-        return()
-    endif()
-
-    if(CLR_CMAKE_TARGET_OSX)
-        find_library(ICUCORE icucore)
-        if(ICUCORE STREQUAL ICUCORE-NOTFOUND)
-            message(FATAL_ERROR "Cannot find libicucore, skipping build for System.Globalization.Native. .NET globalization is not expected to function.")
-            return()
-        endif()
-        add_definitions(-DOSX_ICU_LIBRARY_PATH=\"${ICUCORE}\")
-        add_definitions(-DU_DISABLE_RENAMING)
-    else()
-        find_library(ICUUC icuuc)
-        if(ICUUC STREQUAL ICUUC-NOTFOUND)
-            message(FATAL_ERROR "Cannot find libicuuc, try installing libicu-dev (or the appropriate package for your platform)")
+        find_path(UTYPES_H "unicode/utypes.h" PATHS ${ICU_HOMEBREW_INC_PATH})
+        if(UTYPES_H STREQUAL UTYPES_H-NOTFOUND)
+            message(FATAL_ERROR "Cannot find utypes.h, try installing libicu-dev (or the appropriate package for your platform)")
             return()
         endif()
 
-        find_library(ICUI18N icui18n)
-        if(ICUI18N STREQUAL ICUI18N-NOTFOUND)
-            message(FATAL_ERROR "Cannot find libicui18n, try installing libicu-dev (or the appropriate package for your platform)")
-            return()
+        if(CLR_CMAKE_TARGET_OSX)
+            find_library(ICUCORE icucore)
+            if(ICUCORE STREQUAL ICUCORE-NOTFOUND)
+                message(FATAL_ERROR "Cannot find libicucore, skipping build for System.Globalization.Native. .NET globalization is not expected to function.")
+                return()
+            endif()
+            add_definitions(-DOSX_ICU_LIBRARY_PATH=\"${ICUCORE}\")
+            add_definitions(-DU_DISABLE_RENAMING)
+        else()
+            find_library(ICUUC icuuc)
+            if(ICUUC STREQUAL ICUUC-NOTFOUND)
+                message(FATAL_ERROR "Cannot find libicuuc, try installing libicu-dev (or the appropriate package for your platform)")
+                return()
+            endif()
+
+            find_library(ICUI18N icui18n)
+            if(ICUI18N STREQUAL ICUI18N-NOTFOUND)
+                message(FATAL_ERROR "Cannot find libicui18n, try installing libicu-dev (or the appropriate package for your platform)")
+                return()
+            endif()
         endif()
-    endif()
 
-    include_directories(${UTYPES_H})
+        include_directories(${UTYPES_H})
+    endif()
 endif()
 
 include(configure.cmake)
@@ -86,7 +88,7 @@ set_target_properties(System.Globalization.Native-Static PROPERTIES OUTPUT_NAME
 
 install (TARGETS System.Globalization.Native-Static DESTINATION .)
 
-if(NOT CLR_CMAKE_TARGET_OSX AND NOT CLR_CMAKE_TARGET_IOS)
+if(NOT CLR_CMAKE_TARGET_OSX AND NOT CLR_CMAKE_TARGET_IOS AND NOT CLR_CMAKE_TARGET_ANDROID)
     if (GEN_SHARED_LIB)
         add_custom_command(TARGET System.Globalization.Native POST_BUILD
             COMMENT "Verifying System.Globalization.Native.so dependencies"

src/libraries/Native/Unix/System.Globalization.Native/configure.cmake

@@ -1,32 +1,32 @@
-include(CheckCSourceCompiles)
-include(CheckSymbolExists)
-
 if(CLR_CMAKE_TARGET_ANDROID)
-    string(REPLACE ";" ":" ANDROID_RPATHS "${CMAKE_C_IMPLICIT_LINK_DIRECTORIES}:${CMAKE_SYSTEM_LIBRARY_PATH}")
-    set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -rpath ${ANDROID_RPATHS}")
-endif()
+    set(HAVE_SET_MAX_VARIABLE 1)
+    set(HAVE_UDAT_STANDALONE_SHORTER_WEEKDAYS 1)
+else()
+    include(CheckCSourceCompiles)
+    include(CheckSymbolExists)
 
-if (CLR_CMAKE_TARGET_UNIX)
-    set(CMAKE_REQUIRED_INCLUDES ${UTYPES_H} ${ICU_HOMEBREW_INC_PATH})
+    if (CLR_CMAKE_TARGET_UNIX)
+        set(CMAKE_REQUIRED_INCLUDES ${UTYPES_H} ${ICU_HOMEBREW_INC_PATH})
 
-    CHECK_C_SOURCE_COMPILES("
-        #include <unicode/udat.h>
-        int main(void) { enum UDateFormatSymbolType e = UDAT_STANDALONE_SHORTER_WEEKDAYS; }
-    " HAVE_UDAT_STANDALONE_SHORTER_WEEKDAYS)
+        CHECK_C_SOURCE_COMPILES("
+            #include <unicode/udat.h>
+            int main(void) { enum UDateFormatSymbolType e = UDAT_STANDALONE_SHORTER_WEEKDAYS; }
+        " HAVE_UDAT_STANDALONE_SHORTER_WEEKDAYS)
 
-    if(CLR_CMAKE_TARGET_OSX)
-        set(CMAKE_REQUIRED_LIBRARIES ${ICUCORE})
-    else()
-        set(CMAKE_REQUIRED_LIBRARIES ${ICUUC} ${ICUI18N})
-    endif()
+        if(CLR_CMAKE_TARGET_OSX)
+            set(CMAKE_REQUIRED_LIBRARIES ${ICUCORE})
+        else()
+            set(CMAKE_REQUIRED_LIBRARIES ${ICUUC} ${ICUI18N})
+        endif()
 
-    check_symbol_exists(
-        ucol_setMaxVariable
-        "unicode/ucol.h"
-        HAVE_SET_MAX_VARIABLE)
+        check_symbol_exists(
+            ucol_setMaxVariable
+            "unicode/ucol.h"
+            HAVE_SET_MAX_VARIABLE)
 
-    unset(CMAKE_REQUIRED_LIBRARIES)
-    unset(CMAKE_REQUIRED_INCLUDES)
+        unset(CMAKE_REQUIRED_LIBRARIES)
+        unset(CMAKE_REQUIRED_INCLUDES)
+    endif()
 endif()
 
 configure_file(