Moving on with reporters

Author: grendello

tools/apput/src/Common/AspectReporterAttribute.cs

@@ -2,7 +2,7 @@
 
 namespace ApplicationUtility;
 
-[AttributeUsage (AttributeTargets.Class, Inherited = false, AllowMultiple = false)]
+[AttributeUsage (AttributeTargets.Class, Inherited = false, AllowMultiple = true)]
 class AspectReporterAttribute : Attribute
 {
 	public Type AspectType { get; }

tools/apput/src/Detector.cs

@@ -15,17 +15,19 @@ public class Detector
 	// Aspects must be listed in the order of detection, from the biggest (the most generic) to the
 	// smallest (the least generic) aspects.
 	public readonly static List<Type> KnownTopLevelAspects = new () {
-		typeof (ApplicationPackage),
+		typeof (PackageAPK),
+		typeof (PackageAAB),
+		typeof (PackageBase),
 		typeof (AssemblyStore),
 		typeof (ApplicationAssembly),
 		typeof (NativeAotSharedLibrary),
-		typeof (LibXamarinApp),
+		typeof (XamarinAppSharedLibrary),
 		typeof (SharedLibrary),
 	};
 
 	readonly static List<Type> KnownSharedLibraryAspects = new () {
 		typeof (NativeAotSharedLibrary),
-		typeof (LibXamarinApp),
+		typeof (XamarinAppSharedLibrary),
 		typeof (SharedLibrary),
 	};
 
@@ -49,44 +51,53 @@ public class Detector
 	public static SharedLibrary? FindSharedLibraryAspect (Stream stream, string? description = null)
 	{
 		Log.Debug ($"Looking for shared library aspect ('{description}')");
-		// TODO: implement
+		return (SharedLibrary?)TryFindAspect (KnownSharedLibraryAspects, stream, description);
+	}
+
+	static IAspect? TryFindTopLevelAspect (Stream stream, string? description) => TryFindAspect (KnownTopLevelAspects, stream, description);
+
+	static IAspect? TryFindAspect (List<Type> aspectTypes, Stream stream, string? description)
+	{
+		foreach (Type aspectType in aspectTypes) {
+			IAspect? aspect = TryProbeAndLoadAspect (aspectType, stream, description);
+			if (aspect != null) {
+				return aspect;
+			}
+		}
+
 		return null;
 	}
 
-	static IAspect? TryFindTopLevelAspect (Stream stream, string? description)
+	static IAspect? TryProbeAndLoadAspect (Type aspect, Stream stream, string? description)
 	{
-		var flags = BindingFlags.InvokeMethod | BindingFlags.Public | BindingFlags.Static;
+		const BindingFlags flags = BindingFlags.InvokeMethod | BindingFlags.Public | BindingFlags.Static | BindingFlags.FlattenHierarchy;
 
-		foreach (Type aspect in KnownTopLevelAspects) {
-			LogBanner ($"Probing aspect: {aspect}");
+		LogBanner ($"Probing aspect: {aspect}");
+		object? result = aspect.InvokeMember (
+			"ProbeAspect", flags, null, null, new object?[] { stream, description }
+		);
 
-			object? result = aspect.InvokeMember (
-				"ProbeAspect", flags, null, null, new object?[] { stream, description }
-			);
+		var state = result as IAspectState;
+		if (state == null || !state.Success) {
+			return null;
+		}
 
-			var state = result as IAspectState;
-			if (state == null || !state.Success) {
-				continue;
-			}
+		LogBanner ($"Loading aspect: {aspect}");
+		result = aspect.InvokeMember (
+			"LoadAspect", flags, null, null, new object?[] { stream, state, description }
+		);
 
-			LogBanner ($"Loading aspect: {aspect}");
-			result = aspect.InvokeMember (
-				"LoadAspect", flags, null, null, new object?[] { stream, state, description }
-			);
-			if (result != null) {
-				return (IAspect)result;
-			}
+		if (result != null) {
+			return (IAspect)result;
 		}
 
 		return null;
 
 		void LogBanner (string what)
 		{
 			Log.Debug ();
-			Log.Debug ("##########");
-			Log.Debug (what);
+			Log.Debug ($"# {what}");
 			Log.Debug ();
 		}
 	}
-
 }

tools/apput/src/Native/AnELF.cs

@@ -242,6 +242,7 @@ public static bool TryLoad (string filePath, out AnELF? anElf)
 	public static bool TryLoad (Stream stream, string filePath, out AnELF? anElf)
 	{
 		anElf = null;
+		stream.Seek (0, SeekOrigin.Begin);
 		Class elfClass = ELFReader.CheckELFType (stream);
 		if (elfClass == Class.NotELF) {
 			Log.Warning ($"AnELF.TryLoad: {filePath} is not an ELF binary");

tools/apput/src/Native/LibXamarinApp.cs

@@ -35,7 +35,7 @@ protected NativeAotSharedLibrary (Stream stream, string libraryName)
 
 	public new static IAspectState ProbeAspect (Stream stream, string? description) => new BasicAspectState (IsNativeAotSharedLibrary (stream, description));
 
-	static bool IsNativeAotSharedLibrary (Stream stream, string description)
+	static bool IsNativeAotSharedLibrary (Stream stream, string? description)
 	{
 		if (!IsSupportedELFSharedLibrary (stream, description, out IELF? elf) || elf == null) {
 			return false;

tools/apput/src/Native/NativeAotSharedLibrary.cs

@@ -2,7 +2,7 @@ namespace ApplicationUtility;
 
 public class NativeAppInfo
 {
-	internal NativeAppInfo (LibXamarinApp xamarinAppLibrary)
+	internal NativeAppInfo (XamarinAppSharedLibrary xamarinAppLibrary)
 	{
 	}
 }

tools/apput/src/Native/NativeAppInfo.cs

@@ -0,0 +1,12 @@
+namespace ApplicationUtility;
+
+class XamarinAppLibraryAspectState : BasicAspectState
+{
+	public ulong FormatTag { get; }
+
+	public XamarinAppLibraryAspectState (bool success, ulong formatTag)
+		: base (success)
+	{
+		FormatTag = formatTag;
+	}
+}

tools/apput/src/Native/XamarinAppLibraryAspectState.cs

@@ -0,0 +1,65 @@
+using System;
+using System.IO;
+
+using ELFSharp.ELF;
+
+namespace ApplicationUtility;
+
+// TODO: make it an abstract class, we need to support different formats
+class XamarinAppSharedLibrary : SharedLibrary
+{
+	const string FormatTagSymbol = "format_tag";
+
+	public ulong FormatTag { get; }
+
+	XamarinAppSharedLibrary (Stream stream, string description, XamarinAppLibraryAspectState state)
+		: base (stream, description)
+	{
+		FormatTag = state.FormatTag;
+	}
+
+	public static new IAspect LoadAspect (Stream stream, IAspectState state, string? description)
+	{
+		if (String.IsNullOrEmpty (description)) {
+			throw new ArgumentException ("Must be a shared library name", nameof (description));
+		}
+
+		if (!IsSupportedELFSharedLibrary (stream, description)) {
+			throw new InvalidOperationException ("Stream is not a supported ELF shared library");
+		}
+
+		// TODO: this needs to be versioned
+		return new XamarinAppSharedLibrary (stream, description, (XamarinAppLibraryAspectState)state);
+	}
+
+	public static new IAspectState ProbeAspect (Stream stream, string? description) => IsXamarinAppSharedLibrary (stream, description);
+
+	static XamarinAppLibraryAspectState IsXamarinAppSharedLibrary (Stream stream, string? description)
+	{
+		if (!IsSupportedELFSharedLibrary (stream, description, out IELF? elf) || elf == null) {
+			return GetErrorState ();
+		}
+
+		if (!AnELF.TryLoad (stream, description ?? String.Empty, out AnELF? anElf) || anElf == null) {
+			Log.Debug ($"Failed to load '{description}' as a Xamarin.Android application shared library");
+			return GetErrorState ();
+		}
+
+		if (!anElf.HasSymbol (FormatTagSymbol)) {
+			return LogMissingSymbolAndReturn (FormatTagSymbol);
+		}
+		ulong formatTag = anElf.GetUInt64 (FormatTagSymbol);
+
+		// TODO: check for presence of a handful of fields more
+		return GetState (success: true, formatTag);
+
+		XamarinAppLibraryAspectState LogMissingSymbolAndReturn (string name)
+		{
+			Log.Debug ($"{description} is not a Xamarin.Android application shared library, it doesn't have the '{name}' symbol.");
+			return GetErrorState ();
+		}
+
+		XamarinAppLibraryAspectState GetState (bool success, ulong formatTag) => new XamarinAppLibraryAspectState (success, formatTag);
+		XamarinAppLibraryAspectState GetErrorState () => GetState (success: false, formatTag: 0);
+	}
+}