[Hello-NativeAOTFromJNI] Add NativeAOT sample

Java.Interop.sln

@@ -113,6 +113,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Java.Interop.Tools.Expressi
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Java.Interop.Tools.Expressions-Tests", "tests\Java.Interop.Tools.Expressions-Tests\Java.Interop.Tools.Expressions-Tests.csproj", "{211BAA88-66B1-41B2-88B2-530DBD8DF702}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Hello-NativeAOTFromJNI", "samples\Hello-NativeAOTFromJNI\Hello-NativeAOTFromJNI.csproj", "{8DB3842B-73D7-491C-96F9-EBC863E2C917}"
+EndProject
 Global
 	GlobalSection(SharedMSBuildProjectFiles) = preSolution
 		src\Java.Interop.NamingCustomAttributes\Java.Interop.NamingCustomAttributes.projitems*{58b564a1-570d-4da2-b02d-25bddb1a9f4f}*SharedItemsImports = 5
@@ -320,6 +322,10 @@ Global
 		{211BAA88-66B1-41B2-88B2-530DBD8DF702}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{211BAA88-66B1-41B2-88B2-530DBD8DF702}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{211BAA88-66B1-41B2-88B2-530DBD8DF702}.Release|Any CPU.Build.0 = Release|Any CPU
+		{8DB3842B-73D7-491C-96F9-EBC863E2C917}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{8DB3842B-73D7-491C-96F9-EBC863E2C917}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{8DB3842B-73D7-491C-96F9-EBC863E2C917}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{8DB3842B-73D7-491C-96F9-EBC863E2C917}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -374,6 +380,7 @@ Global
 		{CB05E11B-B96F-4179-A4E9-5D6BDE29A8FC} = {271C9F30-F679-4793-942B-0D9527CB3E2F}
 		{1A0262FE-3CDB-4AF2-AAD8-65C59524FE8A} = {0998E45F-8BCE-4791-A944-962CD54E2D80}
 		{211BAA88-66B1-41B2-88B2-530DBD8DF702} = {271C9F30-F679-4793-942B-0D9527CB3E2F}
+		{8DB3842B-73D7-491C-96F9-EBC863E2C917} = {D5A93398-AEB1-49F3-89DC-3904A47DB0C7}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {29204E0C-382A-49A0-A814-AD7FBF9774A5}

build-tools/automation/azure-pipelines.yaml

@@ -57,6 +57,7 @@ jobs:
   - template: templates\core-tests.yaml
     parameters:
       runNativeDotnetTests: true
+      nativeAotRid: win-x64
       platformName: .NET - Windows
 
   - template: templates\fail-on-issue.yaml
@@ -87,6 +88,7 @@ jobs:
   - template: templates\core-tests.yaml
     parameters:
       runNativeTests: true
+      nativeAotRid: osx-x64
       platformName: .NET - MacOS
 
   - template: templates\fail-on-issue.yaml

build-tools/automation/templates/core-tests.yaml

@@ -2,6 +2,7 @@ parameters:
   condition: succeeded()
   runNativeTests: false
   platformName:
+  nativeAotRid:
 
 steps:
 - task: DotNetCoreCLI@2
@@ -173,6 +174,19 @@ steps:
     arguments: -c $(Build.Configuration) tools/java-source-utils/java-source-utils.csproj -t:RunTests
   continueOnError: true
 
+- powershell: >
+    dotnet publish -c $(Build.Configuration) -r ${{ parameters.nativeAotRid }}
+    samples/Hello-NativeAOTFromJNI/Hello-NativeAOTFromJNI.csproj
+  displayName: 'Tests: publish Hello-NativeAOTFromJNI'
+  continueOnError: true
+
+- powershell: >
+    dotnet build -c $(Build.Configuration) -r ${{ parameters.nativeAotRid }}
+    -t:RunJavaSample
+    samples/Hello-NativeAOTFromJNI/Hello-NativeAOTFromJNI.csproj
+  displayName: 'Tests: run Hello-NativeAOTFromJNI'
+  continueOnError: true
+
 - task: PublishTestResults@2
   displayName: Publish JUnit Test Results
   inputs:

samples/Hello-NativeAOTFromJNI/App.cs

@@ -0,0 +1,31 @@
+using System.Runtime.InteropServices;
+
+using Java.Interop;
+
+namespace Hello_NativeAOTFromJNI;
+
+static class App {
+
+	// symbol name from `$(IntermediateOutputPath)obj/Release/osx-x64/h-classes/net_dot_jni_hello_App.h`
+	[UnmanagedCallersOnly (EntryPoint="Java_net_dot_jni_hello_App_sayHello")]
+	static IntPtr sayHello (IntPtr jnienv, IntPtr klass)
+	{
+		var envp = new JniTransition (jnienv);
+		try {
+			var s = $"Hello from .NET NativeAOT!";
+			Console.WriteLine (s);
+			var h = JniEnvironment.Strings.NewString (s);
+			var r = JniEnvironment.References.NewReturnToJniRef (h);
+			JniObjectReference.Dispose (ref h);
+			return r;
+		}
+		catch (Exception e) {
+			Console.Error.WriteLine ($"Error in App.sayHello(): {e.ToString ()}");
+			envp.SetPendingException (e);
+		}
+		finally {
+			envp.Dispose ();
+		}
+		return nint.Zero;
+	}
+}

samples/Hello-NativeAOTFromJNI/Hello-NativeAOTFromJNI.csproj

@@ -0,0 +1,52 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>$(DotNetTargetFramework)</TargetFramework>
+  </PropertyGroup>
+
+  <Import Project="..\..\TargetFrameworkDependentValues.props" />
+
+  <PropertyGroup>
+    <RootNamespace>Hello_NativeAOTFromJNI</RootNamespace>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+    <PublishAot>true</PublishAot>
+    <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
+    <NativeLib>Shared</NativeLib>
+    <!-- Needed for cross-compilation, e.g. build osx-x64 from osx-arm64 -->
+    <PlatformTarget>AnyCPU</PlatformTarget>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\..\src\Java.Interop\Java.Interop.csproj" />
+    <ProjectReference Include="..\..\src\Java.Runtime.Environment\Java.Runtime.Environment.csproj" />
+    <ProjectReference Include="..\..\src\Java.Base\Java.Base.csproj" />
+    <ProjectReference Include="..\..\src\Java.Interop.Export\Java.Interop.Export.csproj" />
+    <ProjectReference
+        Include="..\..\tools\jcw-gen\jcw-gen.csproj"
+        ReferenceOutputAssembly="false"
+    />
+    <ProjectReference
+        Include="..\..\tools\jnimarshalmethod-gen\Xamarin.Android.Tools.JniMarshalMethodGenerator.csproj"
+        ReferenceOutputAssembly="false"
+    />
+  </ItemGroup>
+
+  <ItemGroup>
+    <TrimmerRootAssembly Include="Hello-NativeAOTFromJNI" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <Content Include="$(OutputPath)hello-from-java.jar" CopyToPublishDirectory="PreserveNewest" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <HelloNativeAOTFromJNIJar Include="$(MSBuildThisFileDirectory)java\**\*.java" />
+  </ItemGroup>
+
+  <ItemGroup Condition=" $([MSBuild]::IsOSPlatform('linux')) Or $([MSBuild]::IsOSPlatform('FreeBSD')) Or $([MSBuild]::IsOSPlatform('Android')) ">
+    <CustomLinkerArg Include="-Wl,-soname,lib$(NativeBinary)$(NativeBinaryExt)" />
+  </ItemGroup>
+
+  <Import Project="Hello-NativeAOTFromJNI.targets" />
+</Project>

samples/Hello-NativeAOTFromJNI/Hello-NativeAOTFromJNI.targets

@@ -0,0 +1,106 @@
+<Project>
+
+  <PropertyGroup>
+    <DotnetToolPath>"$(DOTNET_HOST_PATH)"</DotnetToolPath>
+  </PropertyGroup>
+
+  <Target Name="_CreateJavaCallableWrappers"
+      Condition=" '$(TargetPath)' != '' "
+      BeforeTargets="BuildNativeAOTFromJNIJar"
+      Inputs="$(TargetPath)"
+      Outputs="$(IntermediateOutputPath)java\.stamp">
+    <RemoveDir Directories="$(IntermediateOutputPath)java" />
+    <MakeDir Directories="$(IntermediateOutputPath)java" />
+    <ItemGroup>
+      <!-- I can't find a good way to trim the trailing `\`, so append with `.` so we can sanely quote for $(_Libpath) -->
+      <_JcwGenRefAsmDirs Include="@(ReferencePathWithRefAssemblies->'%(RootDir)%(Directory).'->Distinct())" />
+    </ItemGroup>
+    <PropertyGroup>
+      <_JcwGen>"$(UtilityOutputFullPath)/jcw-gen.dll"</_JcwGen>
+      <_Target>--codegen-target JavaInterop1</_Target>
+      <_Output>-o "$(IntermediateOutputPath)/java"</_Output>
+      <_Libpath>@(_JcwGenRefAsmDirs->'-L "%(Identity)"', ' ')</_Libpath>
+    </PropertyGroup>
+    <Exec Command="$(DotnetToolPath) $(_JcwGen) &quot;$(TargetPath)&quot; $(_Target) $(_Output) $(_Libpath)" />
+    <Touch Files="$(IntermediateOutputPath)java\.stamp" AlwaysCreate="True" />
+  </Target>
+
+  <Target Name="_AddMarshalMethods"
+      Condition=" '$(TargetPath)' != '' "
+      Inputs="$(TargetPath)"
+      Outputs="$(IntermediateOutputPath).added-marshal-methods"
+      AfterTargets="_CreateJavaCallableWrappers">
+    <ItemGroup>
+      <!-- I can't find a good way to trim the trailing `\`, so append with `.` so we can sanely quote for $(_Libpath) -->
+      <_JnimmRefAsmDirs Include="@(RuntimePackAsset->'%(RootDir)%(Directory).'->Distinct())" />
+    </ItemGroup>
+    <PropertyGroup>
+      <_JnimarshalmethodGen>"$(UtilityOutputFullPath)/jnimarshalmethod-gen.dll"</_JnimarshalmethodGen>
+      <_Verbosity>-v -v --keeptemp</_Verbosity>
+      <_Libpath>-L "$(TargetDir)" @(_JnimmRefAsmDirs->'-L "%(Identity)"', ' ')</_Libpath>
+      <!-- <_Output>-o "$(IntermediateOutputPath)/jonp"</_Output> -->
+    </PropertyGroup>
+
+    <Exec Command="$(DotnetToolPath) $(_JnimarshalmethodGen) &quot;$(TargetPath)&quot; $(_Verbosity) $(_Libpath)" />
+
+    <!-- the IlcCompile target uses files from `$(IntermediateOutputPath)`, not `$(TargetPath)`, so… update both? -->
+    <Copy SourceFiles="$(TargetPath)" DestinationFolder="$(IntermediateOutputPath)" />
+
+    <Touch Files="$(IntermediateOutputPath).added-marshal-methods" AlwaysCreate="True" />
+  </Target>
+
+  <Target Name="BuildNativeAOTFromJNIJar"
+      AfterTargets="Build"
+      Inputs="@(HelloNativeAOTFromJNIJar)"
+      Outputs="$(OutputPath)hello-from-java.jar">
+    <MakeDir Directories="$(IntermediateOutputPath)h-classes" />
+    <ItemGroup>
+      <_JcwSource Include="$(IntermediateOutputPath)java\**\*.java" />
+    </ItemGroup>
+    <ItemGroup>
+      <_Source Include="@(_JcwSource->Replace('%5c', '/'))" />
+      <_Source Include="@(HelloNativeAOTFromJNIJar->Replace('%5c', '/'))" />
+    </ItemGroup>
+    <WriteLinesToFile
+        File="$(IntermediateOutputPath)_java_sources.txt"
+        Lines="@(_Source)"
+        Overwrite="True"
+    />
+    <ItemGroup>
+      <_JavacOpt Include="$(_JavacSourceOptions)" />
+      <_JavacOpt Include="-d &quot;$(IntermediateOutputPath)h-classes&quot; " />
+      <_JavacOpt Include="-classpath &quot;$(OutputPath)java-interop.jar&quot; " />
+      <_JavacOpt Include="&quot;@$(IntermediateOutputPath)_java_sources.txt&quot;" />
+      <_JavacOpt Include="-h &quot;$(IntermediateOutputPath)h-classes&quot; " />
+    </ItemGroup>
+    <Exec Command="&quot;$(JavaCPath)&quot; @(_JavacOpt, ' ')" />
+    <Delete Files="$(IntermediateOutputPath)_java_sources.txt" />
+    <Exec Command="&quot;$(JarPath)&quot; cf &quot;$(OutputPath)hello-from-java.jar&quot; -C &quot;$(IntermediateOutputPath)h-classes&quot; ." />
+  </Target>
+
+  <Target Name="_NativeLibRequiresLibPrefix"
+      AfterTargets="Publish">
+    <Copy
+        Condition=" '$(OS)' != 'Windows_NT' "
+        SourceFiles="$(PublishDir)$(AssemblyName).dylib"
+        DestinationFiles="$(PublishDir)lib$(AssemblyName).dylib"
+    />
+    <Copy SourceFiles="$(OutputPath)hello-from-java.jar" DestinationFolder="$(PublishDir)" />
+  </Target>
+
+  <Target Name="RunJavaSample">
+    <ItemGroup>
+      <_Classpath Include="hello-from-java.jar" />
+      <_Classpath Include="java-interop.jar" />
+    </ItemGroup>
+    <PropertyGroup>
+      <_CPSep Condition=" '$(OS)' == 'Windows_NT' ">;</_CPSep>
+      <_CPSep Condition=" '$(_CPSep)' == '' ">:</_CPSep>
+      <_CP>@(_Classpath, '$(_CPSep)')</_CP>
+    </PropertyGroup>
+    <Exec
+        Command="&quot;$(JavaPath)&quot; -classpath &quot;$(_CP)&quot; net/dot/jni/hello/App"
+        WorkingDirectory="$(MSBuildThisFileDirectory)$(PublishDir)"
+    />
+  </Target>
+</Project>

samples/Hello-NativeAOTFromJNI/JavaInteropRuntime.cs

@@ -0,0 +1,40 @@
+using System.Runtime.InteropServices;
+
+using Java.Interop;
+
+namespace Hello_NativeAOTFromJNI;
+
+static class JavaInteropRuntime
+{
+	static JniRuntime? runtime;
+
+	[UnmanagedCallersOnly (EntryPoint="JNI_OnLoad")]
+	static int JNI_OnLoad (IntPtr vm, IntPtr reserved)
+	{
+		return (int) JniVersion.v1_6;
+	}
+
+	[UnmanagedCallersOnly (EntryPoint="JNI_OnUnload")]
+	static void JNI_OnUnload (IntPtr vm, IntPtr reserved)
+	{
+		runtime?.Dispose ();
+	}
+
+	// symbol name from `$(IntermediateOutputPath)obj/Release/osx-arm64/h-classes/net_dot_jni_hello_JavaInteropRuntime.h`
+	[UnmanagedCallersOnly (EntryPoint="Java_net_dot_jni_hello_JavaInteropRuntime_init")]
+	static void init (IntPtr jnienv, IntPtr klass)
+	{
+		Console.WriteLine ($"C# init()");
+		try {
+			var options = new JreRuntimeOptions {
+				EnvironmentPointer  = jnienv,
+				TypeManager             = new NativeAotTypeManager (),
+				UseMarshalMemberBuilder = false,
+			};
+			runtime = options.CreateJreVM ();
+		}
+		catch (Exception e) {
+			Console.Error.WriteLine ($"JavaInteropRuntime.init: error: {e}");
+		}
+	}
+}

samples/Hello-NativeAOTFromJNI/ManagedType.cs

@@ -0,0 +1,22 @@
+namespace Example;
+
+using Java.Interop;
+
+[JniTypeSignature (JniTypeName)]
+class ManagedType : Java.Lang.Object {
+	internal const string JniTypeName = "example/ManagedType";
+
+	[JavaCallableConstructor(SuperConstructorExpression="")]
+	public ManagedType (int value)
+	{
+		this.value = value;
+	}
+
+	int value;
+
+	[JavaCallable ("getString")]
+	public Java.Lang.String GetString ()
+	{
+		return new Java.Lang.String ($"Hello from C#, via Java.Interop! Value={value}");
+	}
+}

samples/Hello-NativeAOTFromJNI/NativeAotTypeManager.cs

@@ -0,0 +1,37 @@
+using Java.Interop;
+
+namespace Hello_NativeAOTFromJNI;
+
+class NativeAotTypeManager : JniRuntime.JniTypeManager {
+
+#pragma warning disable IL2026
+	Dictionary<string, Type> typeMappings = new () {
+		[Example.ManagedType.JniTypeName]   = typeof (Example.ManagedType),
+	};
+#pragma warning restore IL2026
+
+
+	protected override IEnumerable<Type> GetTypesForSimpleReference (string jniSimpleReference)
+	{
+		if (typeMappings.TryGetValue (jniSimpleReference, out var target))
+			yield return target;
+		foreach (var t in base.GetTypesForSimpleReference (jniSimpleReference))
+			yield return t;
+	}
+
+	protected override IEnumerable<string> GetSimpleReferences (Type type)
+	{
+		return base.GetSimpleReferences (type)
+			.Concat (CreateSimpleReferencesEnumerator (type));
+	}
+
+	IEnumerable<string> CreateSimpleReferencesEnumerator (Type type)
+	{
+		if (typeMappings == null)
+			yield break;
+		foreach (var e in typeMappings) {
+			if (e.Value == type)
+				yield return e.Key;
+		}
+	}
+}