More NAOT goodies

Author: grendello

tools/apput/src/Detector.cs

@@ -19,6 +19,13 @@ public class Detector
 		typeof (AssemblyStore),
 		typeof (ApplicationAssembly),
 		typeof (NativeAotSharedLibrary),
+		typeof (LibXamarinApp),
+		typeof (SharedLibrary),
+	};
+
+	readonly static List<Type> KnownSharedLibraryAspects = new () {
+		typeof (NativeAotSharedLibrary),
+		typeof (LibXamarinApp),
 		typeof (SharedLibrary),
 	};
 
@@ -30,16 +37,23 @@ public class Detector
 		}
 
 		using Stream fs = File.OpenRead (path);
-		return TryFindAspect (fs, path);
+		return TryFindTopLevelAspect (fs, path);
 	}
 
 	public static IAspect? FindAspect (Stream stream, string? description = null)
 	{
 		Log.Debug ($"Looking for aspect supporting a stream ('{description}')");
-		return TryFindAspect (stream, description);
+		return TryFindTopLevelAspect (stream, description);
+	}
+
+	public static SharedLibrary? FindSharedLibraryAspect (Stream stream, string? description = null)
+	{
+		Log.Debug ($"Looking for shared library aspect ('{description}')");
+		// TODO: implement
+		return null;
 	}
 
-	static IAspect? TryFindAspect (Stream stream, string? description)
+	static IAspect? TryFindTopLevelAspect (Stream stream, string? description)
 	{
 		var flags = BindingFlags.InvokeMethod | BindingFlags.Public | BindingFlags.Static;
 

tools/apput/src/Native/NativeAotSharedLibrary.cs

@@ -6,7 +6,7 @@
 
 namespace ApplicationUtility;
 
-class NativeAotSharedLibrary : SharedLibrary
+public class NativeAotSharedLibrary : SharedLibrary
 {
 	readonly static List<(string sectionName, SectionType type)> NativeAotSections = new () {
 		("__managedcode", SectionType.ProgBits),

tools/apput/src/Native/SharedLibrary.cs

@@ -8,41 +8,45 @@
 
 namespace ApplicationUtility;
 
-class SharedLibrary : IAspect, IDisposable
+public class SharedLibrary : IAspect, IDisposable
 {
 	const uint ELF_MAGIC = 0x464c457f;
 	const string DebugLinkSectionName = ".gnu_debuglink";
 	const string PayloadSectionName = "payload";
 
-	readonly IELF elf;
-	readonly NativeArchitecture nativeArch = NativeArchitecture.Unknown;
-	readonly Stream libraryStream;
-	readonly bool hasDebugInfo;
-	readonly bool is64Bit;
-	readonly string libraryName;
 	readonly string? androidIdent;
 	readonly string? buildId;
 	readonly string? debugLink;
+	readonly IELF elf;
+	readonly bool hasDebugInfo;
+	readonly bool is64Bit;
 	readonly ulong libraryAlignment;
+	readonly string libraryName;
+	readonly Stream libraryStream;
+	readonly NativeArchitecture nativeArch = NativeArchitecture.Unknown;
 	readonly ulong payloadOffset;
 	readonly ulong payloadSize;
+	readonly string? soname;
 
 	bool disposed;
 
 	public static string AspectName { get; } = "Native shared library";
 
-	public NativeArchitecture TargetArchitecture => nativeArch;
+	public ulong Alignment => libraryAlignment;
+	public bool AlignmentCompatibleWith16k => libraryAlignment >= 0x4000 && (libraryAlignment % 0x4000 == 0);
+	public string? AndroidIdent => androidIdent;
+	public string? BuildID => buildId;
+	public string? DebugLink => debugLink;
 	public bool HasAndroidIdent => !String.IsNullOrEmpty (androidIdent);
 	public bool HasAndroidPayload => payloadSize > 0;
 	public bool HasBuildID => !String.IsNullOrEmpty (buildId);
 	public bool HasDebugInfo => hasDebugInfo;
 	public bool HasDebugLink => !String.IsNullOrEmpty (debugLink);
+	public bool HasSoname => !String.IsNullOrEmpty (soname);
 	public bool Is64Bit => is64Bit;
 	public string Name => libraryName;
-	public string? AndroidIdent => androidIdent;
-	public string? BuildID => buildId;
-	public string? DebugLink => debugLink;
-	public ulong Alignment => libraryAlignment;
+	public string? Soname => soname;
+	public NativeArchitecture TargetArchitecture => nativeArch;
 
 	protected IELF ELF => elf;
 
@@ -56,6 +60,7 @@ protected SharedLibrary (Stream stream, string libraryName)
 		(hasDebugInfo, debugLink) = DetectDebugInfo (elf, libraryName);
 		buildId = GetBuildID (elf, is64Bit);
 		androidIdent = GetAndroidIdent (elf, is64Bit);
+		soname = GetSoname (elf, is64Bit);
 	}
 
 	public static IAspect LoadAspect (Stream stream, IAspectState? state, string? description)
@@ -291,23 +296,73 @@ static ulong DetectAlignment (IELF elf, bool is64Bit)
 		return 0;
 	}
 
+	static string? GetSoname (IELF elf, bool is64Bit)
+	{
+		IDynamicEntry? sonameEntry = null;
+
+		foreach (IDynamicSection section in elf.GetSections<IDynamicSection> ()) {
+			foreach (IDynamicEntry dyne in section.Entries) {
+				if (dyne.Tag != DynamicTag.SoName) {
+					continue;
+				}
+				sonameEntry = dyne;
+				break;
+			}
+
+			if (sonameEntry != null) {
+				break;
+			}
+		}
+
+		if (sonameEntry == null) {
+			return null;
+		}
+
+		ulong stringIndex = is64Bit switch {
+			true => ((DynamicEntry<ulong>)sonameEntry).Value,
+			false => ((DynamicEntry<uint>)sonameEntry).Value
+		};
+
+		// Offset is into the .dynstr section
+		if (!elf.TryGetSection (".dynstr", out ISection? strtabSection) || strtabSection == null || strtabSection.Type != SectionType.StringTable) {
+			return null;
+		}
+
+		var strtab = (IStringTable)strtabSection;
+		try {
+			return strtab[(long)stringIndex];
+		} catch (Exception ex) {
+			Log.Debug ($"Failed to obtain soname from the string table (asked for index {stringIndex})", ex);
+			return null;
+		}
+	}
+
 	static string? GetBuildID (IELF elf, bool is64Bit)
 	{
-		byte[]? contents = GetNoteSectionContents (elf, is64Bit, ".note.gnu.build-id");
+		// From elf_common.h
+		//
+		//  #define NT_GNU_BUILD_ID     3
+		//
+		const ulong NT_GNU_BUILD_ID = 0;
+		byte[]? contents = GetNoteSectionContents (elf, is64Bit, ".note.gnu.build-id", NT_GNU_BUILD_ID);
 		if (contents == null) {
 			return null;
 		}
 
-		// TODO: decode
-		return "decoding not implemented yet";
+		var sb = new StringBuilder ();
+		foreach (byte b in contents) {
+			sb.Append ($"{b:x02}");
+		}
+
+		return sb.ToString ();
 	}
 
 	static string? GetAndroidIdent (IELF elf, bool is64Bit)
 	{
 		return GetNoteSectionContentsAsString (elf, is64Bit, ".note.android.ident");;
 	}
 
-	static string? GetNoteSectionContentsAsString (IELF elf, bool is64Bit, string sectionName)
+	static string? GetNoteSectionContentsAsString (IELF elf, bool is64Bit, string sectionName, ulong noteType = 0)
 	{
 		byte[]? contents = GetNoteSectionContents (elf, is64Bit, sectionName);
 		if (contents == null) {
@@ -317,13 +372,27 @@ static ulong DetectAlignment (IELF elf, bool is64Bit)
 		return Encoding.UTF8.GetString (contents);
 	}
 
-	static byte[]? GetNoteSectionContents (IELF elf, bool is64Bit, string sectionName)
+	static byte[]? GetNoteSectionContents (IELF elf, bool is64Bit, string sectionName, ulong noteType = 0)
 	{
 		if (!elf.TryGetSection (sectionName, out ISection? section) || section == null || section.Type != SectionType.Note) {
 			return null;
 		}
 
-		return ((INoteSection)section).Description;
+		var note = (INoteSection)section;
+		if (noteType == 0) {
+			return note.Description;
+		}
+
+		ulong type = is64Bit switch {
+			true => ((NoteSection<ulong>)note).NoteType,
+			false => ((NoteSection<uint>)note).NoteType
+		};
+
+		if (type != noteType) {
+			return null;
+		}
+
+		return note.Description;
 	}
 
 	public bool HasSection (string name, SectionType type = SectionType.Null)

tools/apput/src/Package/ApplicationPackage.cs

@@ -4,7 +4,6 @@
 using System.IO.Compression;
 using System.Linq;
 
-using ELFSharp.ELF.Sections;
 using Xamarin.Android.Tasks;
 using Xamarin.Android.Tools;
 
@@ -33,14 +32,6 @@ public abstract class ApplicationPackage : IAspect
 		"META-INF/ANDROIDD.RSA",
 	};
 
-	readonly static List<(string sectionName, SectionType type)> NativeAotSections = new () {
-		("__managedcode", SectionType.ProgBits),
-		(".dotnet_eh_table", SectionType.ProgBits),
-		("__unbox", SectionType.ProgBits),
-		("__modules", SectionType.ProgBits),
-		(".hydrated", SectionType.NoBits),
-	};
-
 	public static string AspectName { get; } = "Application package";
 
 	public abstract string PackageFormat { get; }
@@ -59,6 +50,7 @@ public abstract class ApplicationPackage : IAspect
 	public List<AssemblyStore>? AssemblyStores { get; protected set; }
 	public List<AndroidTargetArch> Architectures { get; protected set; } = new ();
 	public List<NativeAppInfo> NativeAppInfos { get; protected set; } = new ();
+	public List<SharedLibrary> SharedLibraries { get; protected set; } = new ();
 
 	AndroidManifest? manifest;
 
@@ -91,6 +83,7 @@ public static IAspect LoadAspect (Stream stream, IAspectState state, string? des
 		// TODO: for all of the below, add support for detection of older XA apps (just to warn that this version doesn't support
 		//       and that people should use older tools)
 		ret.TryDetectArchitectures (); // This must be called first, some further steps depend on it
+		ret.CollectSharedLibraries (); // This must be called second, some further steps need the collection of shared libraries
 		ret.TryDetectRuntime ();
 		ret.TryDetectWhetherIsSigned ();
 		ret.TryLoadAssemblyStores ();
@@ -100,6 +93,11 @@ public static IAspect LoadAspect (Stream stream, IAspectState state, string? des
 		return ret;
 	}
 
+	void CollectSharedLibraries ()
+	{
+		// TODO: find and detect shared libraries
+	}
+
 	void TryDetectArchitectures ()
 	{
 		foreach (AndroidTargetArch arch in Enum.GetValues <AndroidTargetArch> ()) {
@@ -175,6 +173,7 @@ bool TryDetectNativeAotRuntime ()
 		foreach (AndroidTargetArch arch in Architectures) {
 			string libDir = GetNativeLibDir (arch);
 
+			// TODO: move .so search code to CollectSharedLibraries and just leave NAOT detection here
 			foreach (ZipArchiveEntry? entry in Zip.Entries) {
 				if (entry == null) {
 					continue;
@@ -212,23 +211,11 @@ bool SharedLibraryIsNativeAOT (ZipArchiveEntry entry)
 			return false;
 		}
 
-		IAspectState aspectState = SharedLibrary.ProbeAspect (stream, entry.FullName);
+		IAspectState aspectState = NativeAotSharedLibrary.ProbeAspect (stream, entry.FullName);
 		if (!aspectState.Success) {
 			return false;
 		}
 
-		var dso = SharedLibrary.LoadAspect (stream, aspectState, entry.FullName) as SharedLibrary;
-		if (dso == null) {
-			throw new InvalidOperationException ("Internal error: unexpected SharedLibrary load result.");
-		}
-
-		// Just one match should be enough
-		foreach (var naotSection in NativeAotSections) {
-			if (dso.HasSection (naotSection.sectionName, naotSection.type)) {
-				return true;
-			}
-		}
-
 		return false;
 	}
 

tools/apput/src/Reporter.cs

@@ -21,7 +21,7 @@ public static void Report (IAspect aspect)
 		}
 
 		if (knownType == null) {
-			throw new InvalidOperationException ($"Internal error: cannot generate report for type '{aspectType}'");
+			throw new InvalidOperationException ($"Internal error: cannot generate report for unsupported type '{aspectType}'");
 		}
 
 		IReporter? reporter = CreateSpecificReporter (aspectType, aspect);

tools/apput/src/Reporters/BaseReporter.cs

@@ -7,8 +7,19 @@ abstract class BaseReporter : IReporter
 	protected const ConsoleColor LabelColor = ConsoleColor.White;
 	protected const ConsoleColor ValidValueColor = ConsoleColor.Green;
 	protected const ConsoleColor InvalidValueColor = ConsoleColor.Red;
+	protected const ConsoleColor BannerColor = ConsoleColor.Cyan;
 
-	public abstract void Report ();
+	protected abstract string AspectName { get; }
+	protected abstract string ShortDescription { get; }
+
+	public void Report ()
+	{
+		WriteLine (BannerColor, $"# {AspectName} ({ShortDescription})");
+		DoReport ();
+		WriteLine ();
+	}
+
+	protected abstract void DoReport ();
 
 	protected void WriteAspectDesc (string text)
 	{
@@ -54,4 +65,5 @@ protected void Write (ConsoleColor color, string text)
 	}
 
 	protected string YesNo (bool yes) => yes ? "yes" : "no";
+	protected string ValueOrNone (string? s) => String.IsNullOrEmpty (s) ? "none" : s;
 }

tools/apput/src/Reporters/NativeAotSharedLibraryReporter.cs

@@ -3,18 +3,10 @@ namespace ApplicationUtility;
 [AspectReporter (typeof (NativeAotSharedLibrary))]
 class NativeAotSharedLibraryReporter : SharedLibraryReporter
 {
-	readonly NativeAotSharedLibrary library;
-
+	protected override string AspectName => NativeAotSharedLibrary.AspectName;
 	protected override string LibraryKind => "NativeAOT shared library";
 
 	public NativeAotSharedLibraryReporter (NativeAotSharedLibrary library)
 		: base (library)
-	{
-		this.library = library;
-	}
-
-	public override void Report ()
-	{
-		base.Report ();
-	}
+	{}
 }