[assembly-preparer] Create a new tool to replace pre-mark custom linker steps. - #25652
Merged
Conversation
Member
Author
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
Member
Author
|
/review |
Contributor
|
✅ .NET for Apple Platforms PR Reviewer completed successfully! |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR introduces an opt-in “assembly-preparer” pipeline that moves several pre-mark custom linker behaviors into a standalone assembly pre-processing step, enabled via PrepareAssemblies=true, and wires it into the build/test infrastructure so it can be validated independently of ILLink.
Changes:
- Added a new
tools/assembly-preparer/library (plustools/ap-launcher/) to run and debug assembly preparation outside the trimmer. - Added an MSBuild
PrepareAssembliestask +_PrepareAssembliestarget, and updated the trimmer pipeline to disable/shift several custom steps whenPrepareAssemblies=true. - Added
tests/assembly-preparer/plus new xharness labels/variations and supporting test infrastructure updates.
Reviewed changes
Copilot reviewed 121 out of 122 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| tools/tools.slnx | Add assembly-preparer project |
| tools/mtouch/mtouch.csproj | Link shared tooling sources |
| tools/mtouch/mtouch.cs | Switch to new Application() ctor |
| tools/mtouch/Errors.resx | Add MX1504 message |
| tools/mtouch/Errors.designer.cs | Resource accessor for MX1504 |
| tools/Makefile | Build assembly-preparer |
| tools/linker/RegistrarRemovalTrackingStep.cs | Use OptimizeGeneratedCode helper |
| tools/linker/ObjCExtensions.cs | ASSEMBLY_PREPARER resolver path |
| tools/linker/MonoTouch.Tuner/Extensions.cs | LinkContext alias guards |
| tools/linker/MobileExtensions.cs | Use Any() for attribute check |
| tools/linker/MarkNSObjects.cs | Exclude class in ASSEMBLY_PREPARER |
| tools/linker/CoreTypeMapStep.cs | Nullability + resolver tweaks |
| tools/dotnet-linker/Steps/TrimmableRegistrarStep.cs | Track added assemblies + paths |
| tools/dotnet-linker/Steps/SetBeforeFieldInitStep.cs | Dual-mode step implementation |
| tools/dotnet-linker/Steps/PreserveBlockCodeHandler.cs | Add Cecil IL/Rocks usings |
| tools/dotnet-linker/Steps/ManagedRegistrarStep.cs | Persist/collect UCO trampoline map |
| tools/dotnet-linker/Steps/ManagedRegistrarLookupTablesStep.cs | Collect registrar type post-prepare |
| tools/dotnet-linker/Steps/InlineDlfcnMethodsStep.cs | Namespace selection tweak |
| tools/dotnet-linker/Steps/ExceptionalMarkHandler.cs | Share abr + prep guard |
| tools/dotnet-linker/OptimizeGeneratedCodeStep.cs | Move to OptimizeGeneratedCode |
| tools/dotnet-linker/MarkIProtocolHandler.cs | Use DynamicDependency for protocols |
| tools/dotnet-linker/DotNetResolver.cs | Cache lookup behavior for preparer |
| tools/dotnet-linker/DotNetGlobals.cs | Add System.Linq global using |
| tools/dotnet-linker/dotnet-linker.csproj | Share comparer/registrar + OptimizeGeneratedCode |
| tools/dotnet-linker/Compat.cs | Nullable assembly return type |
| tools/dotnet-linker/BackingFieldDelayHandler.cs | Use OptimizeGeneratedCode helper |
| tools/dotnet-linker/ApplyPreserveAttributeStep.cs | ASSEMBLY_PREPARER behaviors |
| tools/dotnet-linker/ApplyPreserveAttributeBase.cs | Exclude substep in preparer |
| tools/dotnet-linker/AppBundleRewriter.cs | Add helpers + KeepAlive workaround |
| tools/devops/automation/templates/common/configure.yml | Add assembly-processing label config |
| tools/create-dotnet-linker-launch-json/Program.cs | Emit ap-launcher launch.json support |
| tools/common/StaticRegistrar.cs | Disable some logic under preparer |
| tools/common/RegistrarMode.cs | New shared RegistrarMode enum |
| tools/common/Optimizations.cs | Fix variable used in NativeAOT warning |
| tools/common/NullableAttributes.cs | Add NotNull/MaybeNullWhen for !NET |
| tools/common/NormalizedStringComparer.cs | New shared comparer type |
| tools/common/Makefile | New make entrypoint for common |
| tools/common/Make.common | Generate SdkVersions/ProductConstants |
| tools/common/IToolLog.cs | Switch to ProductException diagnostics |
| tools/common/ErrorHelper.tools.cs | Expose warning levels lookup |
| tools/common/error.cs | Add GetWarningLevel helper |
| tools/common/Driver.cs | Make verbosity file tool-specific |
| tools/common/DerivedLinkContext.cs | Add Registrar + GetProductAssembly |
| tools/common/CoreResolver.cs | Add Xamarin.Utils using |
| tools/common/cache.cs | Add ASSEMBLY_PREPARER cache name |
| tools/common/Assembly.cs | Move comparer out + symbols guard |
| tools/common/Application.cs | PrepareAssemblies flags + logging routing |
| tools/assembly-preparer/System_Range.cs | Range polyfill for netstandard2.0 |
| tools/assembly-preparer/System_Index.cs | Index polyfill for netstandard2.0 |
| tools/assembly-preparer/System_Diagnostics_UnreachableException.cs | UnreachableException polyfill |
| tools/assembly-preparer/Scaffolding/Target.cs | Stub Target type |
| tools/assembly-preparer/Scaffolding/LinkContext.cs | LinkContext scaffolding |
| tools/assembly-preparer/Scaffolding/IStep.cs | Step interface scaffolding |
| tools/assembly-preparer/Scaffolding/BaseStep.cs | BaseStep scaffolding |
| tools/assembly-preparer/Scaffolding/AssemblyAction.cs | AssemblyAction scaffolding |
| tools/assembly-preparer/Scaffolding/AnnotationStore.cs | Minimal annotation/override map |
| tools/assembly-preparer/README.md | New tool documentation |
| tools/assembly-preparer/NetStandardExtensions.cs | netstandard polyfill extensions |
| tools/assembly-preparer/Makefile | Build/test targets |
| tools/assembly-preparer/IAssemblyPreparerLog.cs | Assembly-preparer logging interface |
| tools/assembly-preparer/GlobalUsings.cs | Global usings + placeholder namespaces |
| tools/assembly-preparer/DynamicallyAccessedMemberTypes.cs | netstandard DAMT polyfill |
| tools/assembly-preparer/AssemblyPreparer.cs | Core assembly preparation pipeline |
| tools/assembly-preparer/assembly-preparer.slnx | Tool solution |
| tools/assembly-preparer/.vscode/tasks.json | VS Code build task |
| tools/assembly-preparer/.gitignore | Ignore generated csproj.inc |
| tools/ap-launcher/README.md | ap-launcher purpose |
| tools/ap-launcher/Program.cs | Command-line launcher for debugging |
| tools/ap-launcher/Makefile | Build target |
| tools/ap-launcher/ap-launcher.slnx | Launcher solution |
| tools/ap-launcher/ap-launcher.csproj | Launcher project |
| tools/ap-launcher/.vscode/tasks.json | VS Code build task |
| tools/ap-launcher/.gitignore | Ignore build stamp |
| tools/.vscode/tasks.json | Add tools-level make task |
| tests/xharness/TestLabel.cs | Add AssemblyProcessing label |
| tests/xharness/Jenkins/TestVariationsFactory.cs | Add prepare-assemblies variations |
| tests/xharness/Harness.cs | Add assembly-preparer unit test project |
| tests/mtouch/MLaunchTool.cs | Use iOS-specific SDK version |
| tests/msbuild/Xamarin.MacDev.Tasks.Tests/TestHelpers/TestBase.cs | Switch to XcodeLocation |
| tests/msbuild/Xamarin.MacDev.Tasks.Tests/TaskTests/MergeAppBundleTaskTest.cs | Switch to XcodeLocation |
| tests/msbuild/Xamarin.MacDev.Tasks.Tests/TaskTests/IBToolTaskTests.cs | Switch to XcodeLocation |
| tests/msbuild/Xamarin.MacDev.Tasks.Tests/TaskTests/GetAvailableDevicesTest.cs | Switch to XcodeLocation |
| tests/msbuild/Xamarin.MacDev.Tasks.Tests/TaskTests/ACToolTaskTest.cs | Switch to XcodeLocation |
| tests/msbuild/Xamarin.MacDev.Tasks.Tests/AssemblySetup.cs | DEVELOPER_DIR from XcodeLocation |
| tests/Makefile | Emit SDK_VERSION vars per platform |
| tests/linker/link all/dotnet/shared.csproj | Add nowarn for MT2003 |
| tests/dotnet/UnitTests/TestBaseClass.cs | Special-case monotouch-test path |
| tests/dotnet/UnitTests/PerformanceTests.cs | Add PrepareAssemblies perf test harness |
| tests/dotnet/UnitTests/AssetsTest.cs | Use ios_sdk_version |
| tests/common/test-variations.csproj | Add prepare-assemblies variation |
| tests/common/DotNet.cs | Track duration in ExecutionResult |
| tests/common/Configuration.cs | SDK version refactor + assembly lists helpers |
| tests/assembly-preparer/ReproTest.cs | Repro roundtrip + binlog debug test |
| tests/assembly-preparer/PreserveSmartEnumConversionsTest.cs | New step test coverage |
| tests/assembly-preparer/PreserveBlockCodeHandlerTests.cs | New step test coverage |
| tests/assembly-preparer/OptimizeGeneratedCodeHandlerTests.cs | New optimization tests |
| tests/assembly-preparer/MarkIProtocolHandlerTests.cs | Protocol preservation tests |
| tests/assembly-preparer/Makefile | Build/test targets |
| tests/assembly-preparer/InlineDlfcnMethodsStepTests.cs | InlineDlfcn test coverage |
| tests/assembly-preparer/GlobalUsings.cs | Test global usings |
| tests/assembly-preparer/BaseClass.cs | Shared test harness |
| tests/assembly-preparer/assembly-preparer.slnx | Test solution |
| tests/assembly-preparer/assembly-preparer-tests.csproj | New test project |
| src/ObjCRuntime/Registrar.cs | Add non-NET null guards |
| src/ObjCRuntime/Registrar.core.cs | Add non-NET null guards |
| src/bgen/BindingTouch.cs | Add warning/error ProductException logging |
| msbuild/Xamarin.Shared/Xamarin.Shared.targets | Add PrepareAssemblies task/target wiring |
| msbuild/Xamarin.MacDev.Tasks/Xamarin.MacDev.Tasks.csproj | Reference assembly-preparer + TFM tweak |
| msbuild/Xamarin.MacDev.Tasks/Tasks/XamarinTask.cs | Route ProductException diagnostics correctly |
| msbuild/Xamarin.MacDev.Tasks/Tasks/PrepareAssemblies.cs | New MSBuild task implementation |
| msbuild/Xamarin.MacDev.Tasks/LoggingExtensions.cs | Add line-numbered log helpers |
| msbuild/Xamarin.MacDev.Tasks/ErrorHelper.msbuild.cs | Remove duplicate msbuild ErrorHelper impl |
| msbuild/Xamarin.MacDev.Tasks/ConsoleToTaskWriter.cs | Detect/flag Console output in tasks |
| msbuild/Xamarin.MacDev.Tasks.slnx | Add assembly-preparer to solution |
| msbuild/Xamarin.Localization.MSBuild/MSBStrings.resx | Add E7178 text |
| msbuild/ILMerge.targets | Merge assembly-preparer into tasks assembly |
| msbuild/.vscode/tasks.json | Add msbuild-level make task |
| dotnet/targets/Xamarin.Shared.Sdk.targets | Integrate PrepareAssemblies into trimmer flow |
Files not reviewed (1)
- tools/mtouch/Errors.designer.cs: Language not supported
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
dalexsoto
approved these changes
Jun 8, 2026
mauroa
approved these changes
Jun 15, 2026
Member
Author
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
Member
Author
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
Extract the static optimization methods from OptimizeGeneratedCodeHandler into a new standalone OptimizeGeneratedCode class. The handler class now only contains the linker-specific scaffolding and delegates to the new class. This makes the optimization logic reusable without depending on the linker's ExceptionalMarkHandler base class. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Refactor the big switch statement in the LinkerConfiguration constructor into a GetConfigurator() method that returns a dictionary of (Load, Save) delegate pairs for each configuration key. This enables both reading configuration from file and writing/serializing the current configuration state. Also add a Save() method that uses the configurator to write out the current configuration state. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
… AppBundleRewriter. Move FindNSObjectConstructor, FindINativeObjectConstructor, ImplementConstructNSObjectFactoryMethod, ImplementConstructINativeObjectFactoryMethod, and AddTypeInterfaceImplementation from ManagedRegistrarLookupTablesStep to AppBundleRewriter, and update all call sites accordingly. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…er steps. Create an 'assembly-preparer' tool that performs assembly pre-processing (currently done by custom linker steps) as a standalone build step, gated behind the opt-in `PrepareAssemblies=true` MSBuild property. Key changes: * New `tools/assembly-preparer/` library with scaffolding that emulates a subset of ILLink's API (this makes it easy to reuse the code for existing custom trimmer step by just running the same steps in the new assembly-preparer tool instead). * New `PrepareAssemblies` MSBuild task and `_PrepareAssemblies` target in Xamarin.Shared.targets. * When `PrepareAssemblies=true`, most custom linker steps/mark handlers are disabled in the trimmer pipeline (conditions added to Xamarin.Shared.Sdk.targets). * Refactor `LinkerConfiguration.cs` with `#if ASSEMBLY_PREPARER` to support both linker and assembly-preparer contexts. * New test project `tests/assembly-preparer/` with tests for the assembly preparation steps. * Add xharness test variation for running with assembly-preparer enabled. * New `tools/ap-launcher/` to invoke the tool from the command line; this is useful during debugging. Contributes towards #17693.
rolfbjarne
force-pushed
the
dev/rolf/assembly-preparer
branch
from
June 17, 2026 14:34
743a6c6 to
23cb3bc
Compare
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
Collaborator
✅ [PR Build #23cb3bc] Build passed (Build packages) ✅Pipeline on Agent |
Collaborator
✅ [PR Build #23cb3bc] Build passed (Build macOS tests) ✅Pipeline on Agent |
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
Collaborator
✅ [PR Build #23cb3bc] Build passed (Detect API changes) ✅Pipeline on Agent |
Collaborator
🚀 [CI Build #23cb3bc] Test results 🚀Test results✅ All tests passed on VSTS: test results. 🎉 All 220 tests passed 🎉 Tests counts✅ assembly-processing: All 1 tests passed. Html Report (VSDrops) Download macOS tests✅ Tests on macOS Monterey (12): All 5 tests passed. Html Report (VSDrops) Download Linux Build VerificationPipeline on Agent |
Collaborator
✅ API diff for current PR / commitNET (empty diffs)✅ API diff vs stableNET (empty diffs)ℹ️ Generator diffGenerator Diff: vsdrops (html) vsdrops (raw diff) gist (raw diff) - Please review changes) Pipeline on Agent |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Create an 'assembly-preparer' tool that performs assembly pre-processing (currently done by custom linker steps) as a standalone build step, gated behind the opt-in
PrepareAssemblies=trueMSBuild property.Key changes:
tools/assembly-preparer/library with scaffolding that emulates a subset of ILLink's API (this makes it easy to reuse the code for existing custom trimmer step by just running the same steps in the new assembly-preparer tool instead).PrepareAssembliesMSBuild task and_PrepareAssembliestarget in Xamarin.Shared.targets.PrepareAssemblies=true, most custom linker steps/mark handlers are disabled in the trimmer pipeline (conditions added to Xamarin.Shared.Sdk.targets).LinkerConfiguration.cswith#if ASSEMBLY_PREPARERto support both linker and assembly-preparer contexts.tests/assembly-preparer/with tests for the assembly preparation steps.tools/ap-launcher/to invoke the tool from the command line; this is useful during debugging.Contributes towards #17693.