[marshal methods] Make AndroidEnvironmentInternal.UnhandledException … #10607
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| using System; | ||
| using System.Collections.Generic; | ||
| using System.IO; | ||
| using Microsoft.Android.Build.Tasks; | ||
| using Microsoft.Build.Framework; | ||
|
|
||
| namespace Xamarin.Android.Tasks; | ||
|
|
||
| public class FixUpMonoAndroidRuntime : AndroidTask | ||
| { | ||
| public override string TaskPrefix => "FUMAR"; | ||
|
|
||
| [Required] | ||
| public ITaskItem[] ResolvedAssemblies { get; set; } = []; | ||
|
|
||
| public override bool RunTask () | ||
| { | ||
| List<ITaskItem> monoAndroidRuntimeItems = new (); | ||
| foreach (ITaskItem item in ResolvedAssemblies) { | ||
| if (!MonoAndroidHelper.StringEquals (Path.GetFileName (item.ItemSpec), "Mono.Android.Runtime.dll", StringComparison.OrdinalIgnoreCase)) { | ||
| continue; | ||
| } | ||
| monoAndroidRuntimeItems.Add (item); | ||
| } | ||
|
|
||
| if (monoAndroidRuntimeItems.Count == 0) { | ||
| Log.LogDebugMessage ("No 'Mono.Android.Runtime.dll' items found"); | ||
| return !Log.HasLoggedErrors; | ||
| } | ||
|
|
||
| return MonoAndroidRuntimeMarshalMethodsFixUp.Run (Log, monoAndroidRuntimeItems) && !Log.HasLoggedErrors; | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
| using System.Collections.Generic; | ||
| using System.IO; | ||
| using Microsoft.Android.Build.Tasks; | ||
| using Microsoft.Build.Framework; | ||
| using Microsoft.Build.Utilities; | ||
| using Mono.Cecil; | ||
|
|
||
| namespace Xamarin.Android.Tasks; | ||
|
|
||
| class MonoAndroidRuntimeMarshalMethodsFixUp | ||
| { | ||
| const string RuntimeTypeName = "Android.Runtime.AndroidEnvironmentInternal"; | ||
|
|
||
| public static bool Run (TaskLoggingHelper log, List<ITaskItem> items) | ||
| { | ||
| bool everythingWorked = true; | ||
| foreach (ITaskItem item in items) { | ||
| if (!ApplyFixUp (log, item)) { | ||
| everythingWorked = false; | ||
| } | ||
| } | ||
grendello marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| return everythingWorked; | ||
| } | ||
|
|
||
| static bool ApplyFixUp (TaskLoggingHelper log, ITaskItem monoAndroidRuntime) | ||
| { | ||
| string newDirPath = Path.Combine (Path.GetDirectoryName (monoAndroidRuntime.ItemSpec), "new")!; | ||
| string newFilePath = Path.Combine (newDirPath, Path.GetFileName (monoAndroidRuntime.ItemSpec)); | ||
| Directory.CreateDirectory (newDirPath); | ||
|
|
||
| string origPdbPath = Path.ChangeExtension (monoAndroidRuntime.ItemSpec, ".pdb"); | ||
| bool havePdb = File.Exists (origPdbPath); | ||
|
|
||
| log.LogDebugMessage ($"Fixing up {monoAndroidRuntime.ItemSpec}"); | ||
| var readerParams = new ReaderParameters () { | ||
| InMemory = true, | ||
| ReadSymbols = havePdb, | ||
| }; | ||
| using AssemblyDefinition asmdef = AssemblyDefinition.ReadAssembly (monoAndroidRuntime.ItemSpec, readerParams); | ||
| TypeDefinition? androidRuntimeInternal = null; | ||
| foreach (ModuleDefinition module in asmdef.Modules) { | ||
| androidRuntimeInternal = FindAndroidRuntimeInternal (module); | ||
| if (androidRuntimeInternal != null) { | ||
| break; | ||
| } | ||
| } | ||
|
|
||
| if (androidRuntimeInternal == null) { | ||
| log.LogDebugMessage ($"'{RuntimeTypeName}' not found in {monoAndroidRuntime.ItemSpec}"); | ||
| return true; // Not an error, per se... | ||
| } | ||
| log.LogDebugMessage ($"Found '{RuntimeTypeName}', making it public"); | ||
| androidRuntimeInternal.IsPublic = true; | ||
|
|
||
| var writerParams = new WriterParameters { | ||
| WriteSymbols = havePdb, | ||
| }; | ||
| asmdef.Write (newFilePath, writerParams); | ||
|
|
||
| CopyFile (log, newFilePath, monoAndroidRuntime.ItemSpec); | ||
| RemoveFile (log, newFilePath); | ||
|
|
||
| if (!havePdb) { | ||
| return true; | ||
| } | ||
|
|
||
| string pdbPath = Path.ChangeExtension (newFilePath, ".pdb"); | ||
| havePdb = File.Exists (pdbPath); | ||
| if (!havePdb) { | ||
| return true; | ||
| } | ||
|
|
||
| CopyFile (log, pdbPath, origPdbPath); | ||
| RemoveFile (log, pdbPath); | ||
|
|
||
| return true; | ||
| } | ||
|
|
||
| static void CopyFile (TaskLoggingHelper log, string source, string target) | ||
| { | ||
| log.LogDebugMessage ($"Copying rewritten assembly: {source} -> {target}"); | ||
| MonoAndroidHelper.CopyFileAvoidSharingViolations (log, source, target); | ||
|
Member
There was a problem hiding this comment. Did you find you needed this before this PR was green? Is it because the
Contributor
Author
There was a problem hiding this comment. Yeah, it would hit the sharing violation exception from time to time. It might be due to the code you pointed to, but fixing this should be done in a separate PR. |
||
| } | ||
|
|
||
| static void RemoveFile (TaskLoggingHelper log, string? path) | ||
| { | ||
| log.LogDebugMessage ($"Deleting: {path}"); | ||
| MonoAndroidHelper.TryRemoveFile (log, path); | ||
| } | ||
|
|
||
| static TypeDefinition? FindAndroidRuntimeInternal (ModuleDefinition module) | ||
| { | ||
| foreach (TypeDefinition t in module.Types) { | ||
| if (MonoAndroidHelper.StringEquals (RuntimeTypeName, t.FullName)) { | ||
| return t; | ||
| } | ||
| } | ||
grendello marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| return null; | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Isn't this the only change required? I don't understand why we need to go through the assembly rewriting step that modifies this exact method's visibility? What am I missing?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's an API and ABI change, we can't do it in a stable project and the fix needs to be backported to net10.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
But we're not modifying the callsites that invoke this method, but we're changing the Mono.Android.Runtime.dll assembly with
androidRuntimeInternal.IsPublic = true;. So if we just makeinternal static class AndroidEnvironmentInternalpublic, instead of just makingvoid UnhandledExceptionpublic, any build which runs this fixup task will be already using the fixedMono.Android.Runtime.dllwith the public class and method, won't it?