Skip to content

[XABT] Move JLO scanning needed for typemap generation to a linker step. #10015

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 30, 2025
Merged

[XABT] Move JLO scanning needed for typemap generation to a linker step. #10015

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
eae6b50
[XABT] Move JLO scanning needed for typemap generation to a linker s…
jpobst Apr 8, 2025
ba85244
Address review feedback.
jpobst Apr 21, 2025
eee3b1c
Merge branch 'main' into dev/jpobst/link-step-typemaps
jpobst Apr 25, 2025
973ef24
Unnest `SaveChangedAssemblyStep`.
jpobst Apr 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/Xamarin.Android.Build.Tasks/Linker/MonoDroid.Tuner/AddKeepAlivesStep.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,13 @@ protected override void ProcessAssembly (AssemblyDefinition assembly)
}

#if !ILLINK
public bool ProcessAssembly (AssemblyDefinition assembly, StepContext context)
public void ProcessAssembly (AssemblyDefinition assembly, StepContext context)
{
// Only run this step on user Android assemblies
if (!context.IsAndroidUserAssembly)
return false;
return;

return AddKeepAlives (assembly);
context.IsAssemblyModified |= AddKeepAlives (assembly);
}
#endif // !ILLINK

Expand Down
6 changes: 1 addition & 5 deletions src/Xamarin.Android.Build.Tasks/Linker/MonoDroid.Tuner/FindJavaObjectsStep.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,19 +29,15 @@ public class FindJavaObjectsStep : BaseStep, IAssemblyModifierPipelineStep

public FindJavaObjectsStep (TaskLoggingHelper log) => Log = log;

public bool ProcessAssembly (AssemblyDefinition assembly, StepContext context)
public void ProcessAssembly (AssemblyDefinition assembly, StepContext context)
{
var destinationJLOXml = JavaObjectsXmlFile.GetJavaObjectsXmlFilePath (context.Destination.ItemSpec);
var scanned = ScanAssembly (assembly, context, destinationJLOXml);

if (!scanned) {
// We didn't scan for Java objects, so write an empty .xml file for later steps
JavaObjectsXmlFile.WriteEmptyFile (destinationJLOXml, Log);
return false;
}

// This step does not change the assembly
return false;
}

public bool ScanAssembly (AssemblyDefinition assembly, StepContext context, string destinationJLOXml)
Expand Down
73 changes: 73 additions & 0 deletions src/Xamarin.Android.Build.Tasks/Linker/MonoDroid.Tuner/FindTypeMapObjectsStep.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
#nullable enable
using System;
using System.Collections.Generic;
using System.Linq;
using Microsoft.Android.Build.Tasks;
using Microsoft.Build.Utilities;
using Mono.Cecil;
using Mono.Linker.Steps;
using Xamarin.Android.Tasks;

namespace MonoDroid.Tuner;

/// <summary>
/// Scans an assembly for JLOs that need to be in the typemap and writes them to an XML file.
/// </summary>
public class FindTypeMapObjectsStep : BaseStep, IAssemblyModifierPipelineStep
{
public bool Debug { get; set; }

public bool ErrorOnCustomJavaObject { get; set; }

public TaskLoggingHelper Log { get; set; }

public FindTypeMapObjectsStep (TaskLoggingHelper log) => Log = log;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As a "ha ha only serious" / "future coding guidelines" question/discussion: should we start using C# primary constructors?

public partial class FindTypeMapObjectStep (TaskLoggingHelper Log) : BaseStep, IAssemblyModifierPipelineStep {
    // …
}

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't love primary constructors, but if that's what we decide we want to standardize as a team it won't kill me. 😁

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not a fan of primary constructors either... :)


public void ProcessAssembly (AssemblyDefinition assembly, StepContext context)
{
var destinationTypeMapXml = TypeMapObjectsXmlFile.GetTypeMapObjectsXmlFilePath (context.Destination.ItemSpec);

// We only care about assemblies that can contains JLOs
if (!context.IsAndroidAssembly) {
Log.LogDebugMessage ($"Skipping assembly '{assembly.Name.Name}' because it is not an Android assembly");
TypeMapObjectsXmlFile.WriteEmptyFile (destinationTypeMapXml, Log);
return;
}

var types = ScanForJavaTypes (assembly);

var xml = new TypeMapObjectsXmlFile {
AssemblyName = assembly.Name.Name,
};

if (Debug) {
var (javaToManaged, managedToJava, foundJniNativeRegistration) = TypeMapCecilAdapter.GetDebugNativeEntries (types, Context);

xml.JavaToManagedDebugEntries.AddRange (javaToManaged);
xml.ManagedToJavaDebugEntries.AddRange (managedToJava);
xml.FoundJniNativeRegistration = foundJniNativeRegistration;
} else {
var genState = TypeMapCecilAdapter.GetReleaseGenerationState (types, Context, out var foundJniNativeRegistration);
xml.ModuleReleaseData = genState.TempModules.SingleOrDefault ().Value;
}

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

…to here, as:

if (!xml.HasDebugEntries && xml.ModuleReleaseData == null) {
    Log.LogDebugMessage ("No Java types found…");
    TypeMapObjectsXmlFile.WriteEmptyFile (destinationTypeMapXml, Log)
    return;
}

xml.Export (destinationTypeMapXml, Log);
}

List<TypeDefinition> ScanForJavaTypes (AssemblyDefinition assembly)
{
var types = new List<TypeDefinition> ();

var scanner = new XAJavaTypeScanner (Xamarin.Android.Tools.AndroidTargetArch.None, Log, Context) {
ErrorOnCustomJavaObject = ErrorOnCustomJavaObject
};

foreach (ModuleDefinition md in assembly.Modules) {
foreach (TypeDefinition td in md.Types) {
scanner.AddJavaType (td, types);
}
}

return types;
}
}
6 changes: 3 additions & 3 deletions src/Xamarin.Android.Build.Tasks/Linker/MonoDroid.Tuner/FixAbstractMethodsStep.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,13 +83,13 @@ internal bool FixAbstractMethods (AssemblyDefinition assembly)
}

#if !ILLINK
public bool ProcessAssembly (AssemblyDefinition assembly, StepContext context)
public void ProcessAssembly (AssemblyDefinition assembly, StepContext context)
{
// Only run this step on non-main user Android assemblies
if (context.IsMainAssembly || !context.IsAndroidUserAssembly)
return false;
return;

return FixAbstractMethods (assembly);
context.IsAssemblyModified |= FixAbstractMethods (assembly);
}
#endif // !ILLINK

Expand Down
6 changes: 3 additions & 3 deletions src/Xamarin.Android.Build.Tasks/Linker/MonoDroid.Tuner/FixLegacyResourceDesignerStep.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,13 +71,13 @@ protected override void LoadDesigner ()
}

#if !ILLINK
public bool ProcessAssembly (AssemblyDefinition assembly, Xamarin.Android.Tasks.StepContext context)
public void ProcessAssembly (AssemblyDefinition assembly, Xamarin.Android.Tasks.StepContext context)
{
// Only run this step on non-main user Android assemblies
if (context.IsMainAssembly || !context.IsAndroidUserAssembly)
return false;
return;

return ProcessAssemblyDesigner (assembly);
context.IsAssemblyModified |= ProcessAssemblyDesigner (assembly);
}
#endif // !ILLINK

Expand Down
81 changes: 57 additions & 24 deletions src/Xamarin.Android.Build.Tasks/Tasks/AssemblyModifierPipeline.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
using Java.Interop.Tools.TypeNameMappings;
using Microsoft.Android.Build.Tasks;
using Microsoft.Build.Framework;
using Microsoft.Build.Utilities;
using Mono.Cecil;
using MonoDroid.Tuner;
using Xamarin.Android.Tools;
Expand Down Expand Up @@ -78,10 +79,6 @@ public override bool RunTask ()
ReadSymbols = ReadSymbols,
};

var writerParameters = new WriterParameters {
DeterministicMvid = Deterministic,
};

Dictionary<AndroidTargetArch, Dictionary<string, ITaskItem>> perArchAssemblies = MonoAndroidHelper.GetPerArchAssemblies (ResolvedAssemblies, Array.Empty<string> (), validate: false);

AssemblyPipeline? pipeline = null;
Expand Down Expand Up @@ -122,7 +119,7 @@ public override bool RunTask ()

Directory.CreateDirectory (Path.GetDirectoryName (destination.ItemSpec));

RunPipeline (pipeline!, source, destination, writerParameters);
RunPipeline (pipeline!, source, destination);
}

pipeline?.Dispose ();
Expand All @@ -141,9 +138,26 @@ protected virtual void BuildPipeline (AssemblyPipeline pipeline, MSBuildLinkCont

findJavaObjectsStep.Initialize (context);
pipeline.Steps.Add (findJavaObjectsStep);

// SaveChangedAssemblyStep
var writerParameters = new WriterParameters {
DeterministicMvid = Deterministic,
};

var saveChangedAssemblyStep = new SaveChangedAssemblyStep (Log, writerParameters);
pipeline.Steps.Add (saveChangedAssemblyStep);

// FindTypeMapObjectsStep - this must be run after the assembly has been saved, as saving changes the MVID
var findTypeMapObjectsStep = new FindTypeMapObjectsStep (Log) {
ErrorOnCustomJavaObject = ErrorOnCustomJavaObject,
Debug = Debug,
};

findTypeMapObjectsStep.Initialize (context);
pipeline.Steps.Add (findTypeMapObjectsStep);
}

void RunPipeline (AssemblyPipeline pipeline, ITaskItem source, ITaskItem destination, WriterParameters writerParameters)
void RunPipeline (AssemblyPipeline pipeline, ITaskItem source, ITaskItem destination)
{
var assembly = pipeline.Resolver.GetAssembly (source.ItemSpec);

Expand All @@ -157,28 +171,47 @@ void RunPipeline (AssemblyPipeline pipeline, ITaskItem source, ITaskItem destina
IsUserAssembly = ResolvedUserAssemblies.Any (a => a.ItemSpec == source.ItemSpec),
};

var changed = pipeline.Run (assembly, context);

if (changed) {
Log.LogDebugMessage ($"Saving modified assembly: {destination.ItemSpec}");
Directory.CreateDirectory (Path.GetDirectoryName (destination.ItemSpec));
writerParameters.WriteSymbols = assembly.MainModule.HasSymbols;
assembly.Write (destination.ItemSpec, writerParameters);
} else {
// If we didn't write a modified file, copy the original to the destination
CopyIfChanged (source, destination);
}
pipeline.Run (assembly, context);
}

void CopyIfChanged (ITaskItem source, ITaskItem destination)
class SaveChangedAssemblyStep : IAssemblyModifierPipelineStep
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any particular reason that this is a nested type?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nope, unnested.

{
if (MonoAndroidHelper.CopyAssemblyAndSymbols (source.ItemSpec, destination.ItemSpec)) {
Log.LogDebugMessage ($"Copied: {destination.ItemSpec}");
} else {
Log.LogDebugMessage ($"Skipped unchanged file: {destination.ItemSpec}");
public TaskLoggingHelper Log { get; set; }

public WriterParameters WriterParameters { get; set; }

public SaveChangedAssemblyStep (TaskLoggingHelper log, WriterParameters writerParameters)
{
Log = log;
WriterParameters = writerParameters;
}

// NOTE: We still need to update the timestamp on this file, or this target would run again
File.SetLastWriteTimeUtc (destination.ItemSpec, DateTime.UtcNow);
public void ProcessAssembly (AssemblyDefinition assembly, StepContext context)
{
if (context.IsAssemblyModified) {
Log.LogDebugMessage ($"Saving modified assembly: {context.Destination.ItemSpec}");
Directory.CreateDirectory (Path.GetDirectoryName (context.Destination.ItemSpec));
WriterParameters.WriteSymbols = assembly.MainModule.HasSymbols;
assembly.Write (context.Destination.ItemSpec, WriterParameters);
} else {
// If we didn't write a modified file, copy the original to the destination
CopyIfChanged (context.Source, context.Destination);
}

// We just saved the assembly, so it is no longer modified
context.IsAssemblyModified = false;
}

void CopyIfChanged (ITaskItem source, ITaskItem destination)
{
if (MonoAndroidHelper.CopyAssemblyAndSymbols (source.ItemSpec, destination.ItemSpec)) {
Log.LogDebugMessage ($"Copied: {destination.ItemSpec}");
} else {
Log.LogDebugMessage ($"Skipped unchanged file: {destination.ItemSpec}");

// NOTE: We still need to update the timestamp on this file, or this target would run again
File.SetLastWriteTimeUtc (destination.ItemSpec, DateTime.UtcNow);
}
}
}
}
Loading