Java stack trace implemented

Also: introduce tracing modes, 'basic` for just the method enter/leave
messages and 'full' to include native and java stack traces on method
entry.

src/Xamarin.Android.Build.Tasks/Tasks/GeneratePackageManagerJava.cs

@@ -23,6 +23,7 @@ public class GeneratePackageManagerJava : AndroidTask
 		public override string TaskPrefix => "GPM";
 
 		Guid buildId = Guid.NewGuid ();
+		MarshalMethodsTracingMode mmTracingMode;
 
 		[Required]
 		public ITaskItem[] ResolvedAssemblies { get; set; }
@@ -66,7 +67,7 @@ public class GeneratePackageManagerJava : AndroidTask
 		public bool InstantRunEnabled { get; set; }
 
 		public bool EnableMarshalMethods { get; set; }
-		public bool EnableMarshalMethodTracing { get; set; }
+		public string MarshalMethodsTracingMode { get; set; }
 		public string RuntimeConfigBinFilePath { get; set; }
 		public string BoundExceptionType { get; set; }
 
@@ -93,6 +94,8 @@ bool _Debug {
 
 		public override bool RunTask ()
 		{
+			mmTracingMode = MonoAndroidHelper.ParseMarshalMethodsTracingMode (MarshalMethodsTracingMode);
+
 			BuildId = buildId.ToString ();
 			Log.LogDebugMessage ("  [Output] BuildId: {0}", BuildId);
 
@@ -412,7 +415,7 @@ void AddEnvironment ()
 					uniqueAssemblyNames,
 					marshalMethodsState?.MarshalMethods,
 					Log,
-					EnableMarshalMethodTracing
+					mmTracingMode
 				);
 			} else {
 				marshalMethodsAsmGen = new MarshalMethodsNativeAssemblyGenerator (assemblyCount, uniqueAssemblyNames);

src/Xamarin.Android.Build.Tasks/Tasks/LinkApplicationSharedLibraries.cs

@@ -44,10 +44,16 @@ sealed class InputFiles
 		[Required]
 		public string AndroidBinUtilsDirectory { get; set; }
 
-		public bool EnableMarshalMethodTracing { get; set; }
+		public string MarshalMethodsTracingMode { get; set; }
+
+		MarshalMethodsTracingMode mmTracingMode;
+		bool mmTracingEnabled;
 
 		public override System.Threading.Tasks.Task RunTaskAsync ()
 		{
+			mmTracingMode = MonoAndroidHelper.ParseMarshalMethodsTracingMode (MarshalMethodsTracingMode);
+			mmTracingEnabled = mmTracingMode != Tasks.MarshalMethodsTracingMode.None;
+
 			return this.WhenAll (GetLinkerConfigs (), RunLinker);
 		}
 
@@ -137,7 +143,7 @@ IEnumerable<Config> GetLinkerConfigs ()
 				"--warn-shared-textrel " +
 				"--fatal-warnings";
 
-			string stripSymbolsArg = DebugBuild || EnableMarshalMethodTracing ? String.Empty : " -s";
+			string stripSymbolsArg = DebugBuild || mmTracingEnabled ? String.Empty : " -s";
 
 			string ld = Path.Combine (AndroidBinUtilsDirectory, MonoAndroidHelper.GetExecutablePath (AndroidBinUtilsDirectory, "ld"));
 			var targetLinkerArgs = new List<string> ();
@@ -201,7 +207,7 @@ InputFiles GatherFilesForABI (string runtimeSharedLibrary, string abi, ITaskItem
 		{
 			List<string> extraLibraries = null;
 
-			if (EnableMarshalMethodTracing) {
+			if (mmTracingEnabled) {
 				string RID = MonoAndroidHelper.AbiToRid (abi);
 				AndroidTargetArch targetArch = MonoAndroidHelper.AbiToTargetArch (abi);
 				string clangLibraryAbi = MonoAndroidHelper.ArchToClangLibraryAbi (targetArch);

src/Xamarin.Android.Build.Tasks/Utilities/LlvmIrGenerator/LlvmIrGenerator.Code.cs

@@ -336,7 +336,8 @@ public void EmitLabel (LlvmIrFunction function, string labelName)
 				throw new ArgumentException ("must be reference to native function", nameof (targetRef));
 			}
 
-			if (targetSignature.Parameters.Count > 0) {
+			bool haveParameters = targetSignature.Parameters != null && targetSignature.Parameters.Count > 0;
+			if (haveParameters) {
 				if (arguments == null) {
 					throw new ArgumentNullException (nameof (arguments));
 				}
@@ -377,7 +378,7 @@ public void EmitLabel (LlvmIrFunction function, string labelName)
 
 			Output.Write ($"call {GetKnownIRType (targetSignature.ReturnType)} {targetRef.Reference} (");
 
-			if (targetSignature.Parameters.Count > 0) {
+			if (haveParameters) {
 				for (int i = 0; i < targetSignature.Parameters.Count; i++) {
 					LlvmIrFunctionParameter parameter = targetSignature.Parameters[i];
 					LlvmIrFunctionArgument argument = arguments[i];

src/Xamarin.Android.Build.Tasks/Utilities/MarshalMethodsNativeAssemblyGenerator.cs

@@ -173,6 +173,7 @@ sealed class MarshalMethodName
 
 		const string mm_trace_func_enter_name = "_mm_trace_func_enter";
 		const string mm_trace_func_leave_name = "_mm_trace_func_leave";
+		const string mm_trace_init_name = "_mm_trace_init";
 
 		ICollection<string> uniqueAssemblyNames;
 		int numberOfAssembliesInApk;
@@ -205,9 +206,10 @@ sealed class MarshalMethodName
 		// Tracing
 		LlvmIrVariableReference? mm_trace_func_enter_ref;
 		LlvmIrVariableReference? mm_trace_func_leave_ref;
+		LlvmIrVariableReference? mm_trace_init_ref;
 
 		readonly bool generateEmptyCode;
-		readonly bool emitTracing;
+		readonly MarshalMethodsTracingMode tracingMode;
 
 		/// <summary>
 		/// Constructor to be used ONLY when marshal methods are DISABLED
@@ -222,15 +224,15 @@ public MarshalMethodsNativeAssemblyGenerator (int numberOfAssembliesInApk, IColl
 		/// <summary>
 		/// Constructor to be used ONLY when marshal methods are ENABLED
 		/// </summary>
-		public MarshalMethodsNativeAssemblyGenerator (int numberOfAssembliesInApk, ICollection<string> uniqueAssemblyNames, IDictionary<string, IList<MarshalMethodEntry>> marshalMethods, TaskLoggingHelper logger, bool emitTracing)
+		public MarshalMethodsNativeAssemblyGenerator (int numberOfAssembliesInApk, ICollection<string> uniqueAssemblyNames, IDictionary<string, IList<MarshalMethodEntry>> marshalMethods, TaskLoggingHelper logger, MarshalMethodsTracingMode tracingMode)
 		{
 			this.numberOfAssembliesInApk = numberOfAssembliesInApk;
 			this.uniqueAssemblyNames = uniqueAssemblyNames ?? throw new ArgumentNullException (nameof (uniqueAssemblyNames));
 			this.marshalMethods = marshalMethods;
 			this.logger = logger ?? throw new ArgumentNullException (nameof (logger));
 
 			generateEmptyCode = false;
-			this.emitTracing = emitTracing;
+			this.tracingMode = tracingMode;
 		}
 
 		public override void Init ()
@@ -662,12 +664,22 @@ void RenderMethodNameWithParams (CecilMethodDefinition md, StringBuilder buffer)
 
 		void WriteInitTracing (LlvmIrGenerator generator)
 		{
-			if (!emitTracing) {
+			if (tracingMode == MarshalMethodsTracingMode.None) {
 				return;
 			}
 
 			// Function names and declarations must match those in src/monodroid/jni/marshal-methods-tracing.hh
+			var mm_trace_init_sig = new LlvmNativeFunctionSignature (
+				returnType: typeof(void),
+				parameters: new List<LlvmIrFunctionParameter> {
+					new LlvmIrFunctionParameter (typeof(_JNIEnv), "env", isNativePointer: true), // JNIEnv *env
+				}
+			);
+			mm_trace_init_ref = new LlvmIrVariableReference (mm_trace_init_sig, mm_trace_init_name, isGlobal: true);
+
 			var mm_trace_func_enter_or_leave_params = new List<LlvmIrFunctionParameter> {
+				new LlvmIrFunctionParameter (typeof(_JNIEnv), "env", isNativePointer: true), // JNIEnv *env
+				new LlvmIrFunctionParameter (typeof(int), "tracing_mode"),
 				new LlvmIrFunctionParameter (typeof(uint), "mono_image_index"),
 				new LlvmIrFunctionParameter (typeof(uint), "class_index"),
 				new LlvmIrFunctionParameter (typeof(uint), "method_token"),
@@ -687,6 +699,7 @@ void WriteInitTracing (LlvmIrGenerator generator)
 			);
 			mm_trace_func_leave_ref = new LlvmIrVariableReference (mm_trace_func_leave_sig, mm_trace_func_leave_name, isGlobal: true);
 
+			WriteTraceDeclaration (mm_trace_init_name, mm_trace_init_sig.ReturnType, mm_trace_init_sig.Parameters);
 			WriteTraceDeclaration (mm_trace_func_enter_name, mm_trace_func_enter_sig.ReturnType, mm_trace_func_enter_sig.Parameters);
 			WriteTraceDeclaration (mm_trace_func_leave_name, mm_trace_func_leave_sig.ReturnType, mm_trace_func_leave_sig.Parameters);
 
@@ -749,8 +762,10 @@ void WriteMarshalMethod (LlvmIrGenerator generator, MarshalMethodInfo method, Ll
 
 			List<LlvmIrFunctionArgument>? trace_enter_leave_args = null;
 
-			if (emitTracing) {
+			if (tracingMode != MarshalMethodsTracingMode.None) {
 				trace_enter_leave_args = new List<LlvmIrFunctionArgument> {
+					new LlvmIrFunctionArgument (func.ParameterVariables[0]), // JNIEnv* env
+					new LlvmIrFunctionArgument (typeof(int), (int)tracingMode),
 					new LlvmIrFunctionArgument (typeof(uint), method.AssemblyCacheIndex),
 					new LlvmIrFunctionArgument (typeof(uint), method.ClassCacheIndex),
 					new LlvmIrFunctionArgument (typeof(uint), nativeCallback.MetadataToken.ToUInt32 ()),
@@ -812,7 +827,7 @@ void WriteMarshalMethod (LlvmIrGenerator generator, MarshalMethodInfo method, Ll
 				func.ParameterVariables.Select (pv => new LlvmIrFunctionArgument (pv)).ToList ()
 			);
 
-			if (emitTracing) {
+			if (tracingMode != MarshalMethodsTracingMode.None) {
 				generator.EmitCall (func, mm_trace_func_leave_ref, trace_enter_leave_args);
 			}
 
@@ -846,12 +861,23 @@ LlvmIrVariableReference WriteXamarinAppInitFunction (LlvmIrGenerator generator)
 				returnType: typeof (void),
 				attributeSetID: LlvmIrGenerator.FunctionAttributesXamarinAppInit,
 				parameters: new List<LlvmIrFunctionParameter> {
+					new LlvmIrFunctionParameter (typeof(_JNIEnv), "env", isNativePointer: true), // JNIEnv *env
 					fnParameter,
 				}
 			);
 
 			generator.WriteFunctionStart (func);
 			generator.EmitStoreInstruction (func, fnParameter, new LlvmIrVariableReference (get_function_pointer_sig, GetFunctionPointerFieldName, isGlobal: true));
+			if (tracingMode != MarshalMethodsTracingMode.None) {
+				generator.EmitCall (
+					func,
+					mm_trace_init_ref,
+					new List<LlvmIrFunctionArgument> {
+						new LlvmIrFunctionArgument (func.ParameterVariables[0]), // JNIEnv *env
+					}
+				);
+			}
+
 			generator.WriteFunctionEnd (func);
 
 			return new LlvmIrVariableReference (get_function_pointer_sig, GetFunctionPointerFieldName, isGlobal: true);

src/Xamarin.Android.Build.Tasks/Utilities/MarshalMethodsTracingMode.cs

@@ -0,0 +1,10 @@
+namespace Xamarin.Android.Tasks
+{
+	// Enumeration member numeric values MUST match those in src/monodroid/jni/marshal-methods-tracing.hh
+	public enum MarshalMethodsTracingMode
+	{
+		None  = 0x00,
+		Basic = 0x01,
+		Full  = 0x02,
+	}
+}

src/Xamarin.Android.Build.Tasks/Utilities/MonoAndroidHelper.cs

@@ -614,5 +614,22 @@ public static string ArchToClangLibraryAbi (AndroidTargetArch arch)
 					throw new InvalidOperationException ($"Internal error: unsupported architecture '{arch}'");
 			}
 		}
+
+		public static MarshalMethodsTracingMode ParseMarshalMethodsTracingMode (string input)
+		{
+			if (String.IsNullOrEmpty (input) || String.Compare ("none", input, StringComparison.InvariantCultureIgnoreCase) == 0) {
+				return MarshalMethodsTracingMode.None;
+			}
+
+			if (String.Compare ("basic", input, StringComparison.InvariantCultureIgnoreCase) == 0) {
+				return MarshalMethodsTracingMode.Basic;
+			}
+
+			if (String.Compare ("full", input, StringComparison.InvariantCultureIgnoreCase) == 0) {
+				return MarshalMethodsTracingMode.Full;
+			}
+
+			throw new InvalidOperationException ($"Unsupported marshal methods tracing mode '{input}'");
+		}
 	}
 }

src/Xamarin.Android.Build.Tasks/Xamarin.Android.Common.targets

@@ -340,7 +340,13 @@ Copyright (C) 2011-2012 Xamarin. All rights reserved.
   <AndroidEnableMarshalMethods Condition=" '$(UsingAndroidNETSdk)' != 'True' ">False</AndroidEnableMarshalMethods>
   <_AndroidUseMarshalMethods Condition=" '$(AndroidIncludeDebugSymbols)' == 'True' ">False</_AndroidUseMarshalMethods>
   <_AndroidUseMarshalMethods Condition=" '$(AndroidIncludeDebugSymbols)' != 'True' ">$(AndroidEnableMarshalMethods)</_AndroidUseMarshalMethods>
-  <_AndroidEnableMarshalMethodTracing Condition=" '$(_AndroidEnableMarshalMethodTracing)' == '' ">False</_AndroidEnableMarshalMethodTracing>
+
+  <!-- Accepted values are:
+       none - disable tracing completely (the default)
+       basic - log marshal method function enter/leave messages
+       full - like 'basic' but also include stack traces at the entry to a marshal method
+  -->
+  <_AndroidMarshalMethodsTracingMode Condition=" '$(_AndroidMarshalMethodsTracingMode)' == '' ">none</_AndroidMarshalMethodsTracingMode>
 </PropertyGroup>
 
 <!-- Do not resolve from the GAC under any circumstances in Mobile -->
@@ -1792,7 +1798,7 @@ because xbuild doesn't support framework reference assemblies.
     UsingAndroidNETSdk="$(UsingAndroidNETSdk)"
     UseAssemblyStore="$(AndroidUseAssemblyStore)"
     EnableMarshalMethods="$(_AndroidUseMarshalMethods)"
-    EnableMarshalMethodTracing="$(_AndroidEnableMarshalMethodTracing)"
+    MarshalMethodsTracingMode="$(_AndroidMarshalMethodsTracingMode)"
   >
     <Output TaskParameter="BuildId" PropertyName="_XamarinBuildId" />
   </GeneratePackageManagerJava>
@@ -2087,7 +2093,7 @@ because xbuild doesn't support framework reference assemblies.
       ApplicationSharedLibraries="@(_ApplicationSharedLibrary)"
       DebugBuild="$(AndroidIncludeDebugSymbols)"
       AndroidBinUtilsDirectory="$(AndroidBinUtilsDirectory)"
-      EnableMarshalMethodTracing="$(_AndroidEnableMarshalMethodTracing)"
+      MarshalMethodsTracingMode="$(_AndroidMarshalMethodsTracingMode)"
   />
   <ItemGroup>
     <FileWrites Include="@(_ApplicationSharedLibrary)" />

src/monodroid/jni/application_dso_stub.cc

@@ -202,7 +202,7 @@ const MarshalMethodName mm_method_names[] = {
 	},
 };
 
-void xamarin_app_init ([[maybe_unused]] get_function_pointer_fn fn) noexcept
+void xamarin_app_init ([[maybe_unused]] JNIEnv *env, [[maybe_unused]] get_function_pointer_fn fn) noexcept
 {
 	// Dummy
 }