mirror of https://github.com/icsharpcode/ILSpy.git
4 changed files with 510 additions and 2 deletions
@ -0,0 +1,201 @@
@@ -0,0 +1,201 @@
|
||||
// Copyright (c) 2026 Siegfried Pammer
|
||||
//
|
||||
// Permission is hereby granted, free of charge, to any person obtaining a copy of this
|
||||
// software and associated documentation files (the "Software"), to deal in the Software
|
||||
// without restriction, including without limitation the rights to use, copy, modify, merge,
|
||||
// publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
|
||||
// to whom the Software is furnished to do so, subject to the following conditions:
|
||||
//
|
||||
// The above copyright notice and this permission notice shall be included in all copies or
|
||||
// substantial portions of the Software.
|
||||
//
|
||||
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
|
||||
// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
|
||||
// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
|
||||
// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
|
||||
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
||||
// DEALINGS IN THE SOFTWARE.
|
||||
|
||||
// The --ilast options exist in debug builds only, so this fixture compiles away with them.
|
||||
#if DEBUG
|
||||
|
||||
using System.IO; |
||||
using System.Threading.Tasks; |
||||
|
||||
using NUnit.Framework; |
||||
|
||||
using static ICSharpCode.ILSpyCmd.Tests.CliTestRunner; |
||||
|
||||
namespace ICSharpCode.ILSpyCmd.Tests |
||||
{ |
||||
[TestFixture] |
||||
public class ILAstOptionTests |
||||
{ |
||||
static readonly string testAssemblyPath = typeof(ILAstOptionTests).Assembly.Location; |
||||
|
||||
const string sumLoopId = "M:ICSharpCode.ILSpyCmd.Tests.ILAstSample.SumLoop(System.Int32)"; |
||||
|
||||
static Task<(int ExitCode, string Output, string Error)> RunILAstAsync(params string[] args) |
||||
{ |
||||
string[] common = { testAssemblyPath, "--disable-updatecheck", "-m", sumLoopId }; |
||||
string[] all = new string[common.Length + args.Length]; |
||||
common.CopyTo(all, 0); |
||||
args.CopyTo(all, common.Length); |
||||
return RunAsync(all); |
||||
} |
||||
|
||||
[Test] |
||||
public async Task ILAstOfSelectedMethodIsWritten() |
||||
{ |
||||
var result = await RunILAstAsync("--ilast"); |
||||
|
||||
Assert.That(result.ExitCode, Is.EqualTo(0), result.Error); |
||||
Assert.That(result.Output, Does.Contain(nameof(ILAstSample.SumLoop))); |
||||
Assert.That(result.Output, Does.Contain("ILFunction")); |
||||
} |
||||
|
||||
// the loop of SumLoop is only recognised by HighLevelLoopTransform, at the very end of the
|
||||
// pipeline: its presence tells a full run from a truncated one, while the header line
|
||||
// (which names the requested transform count) would differ either way
|
||||
const string structuredLoop = "BlockContainer (for)"; |
||||
|
||||
[Test] |
||||
public async Task StoppingAfterATransformYieldsDifferentILAst() |
||||
{ |
||||
var full = await RunILAstAsync("--ilast"); |
||||
// ILInlining is the third transform of the pipeline; stopping there leaves the
|
||||
// method as unstructured blocks, while the full run has loops and expressions.
|
||||
var partial = await RunILAstAsync("--after-transform", "ILInlining"); |
||||
|
||||
Assert.That(full.ExitCode, Is.EqualTo(0), full.Error); |
||||
Assert.That(partial.ExitCode, Is.EqualTo(0), partial.Error); |
||||
Assert.That(partial.Output, Does.Contain(nameof(ILAstSample.SumLoop))); |
||||
Assert.That(full.Output, Does.Contain(structuredLoop)); |
||||
Assert.That(partial.Output, Does.Not.Contain(structuredLoop)); |
||||
} |
||||
|
||||
[Test] |
||||
public async Task TransformCanBeSelectedByIndex() |
||||
{ |
||||
var partial = await RunILAstAsync("--after-transform", "1"); |
||||
|
||||
Assert.That(partial.ExitCode, Is.EqualTo(0), partial.Error); |
||||
Assert.That(partial.Output, Does.Contain(nameof(ILAstSample.SumLoop))); |
||||
Assert.That(partial.Output, Does.Not.Contain(structuredLoop)); |
||||
// AssignVariableNames is the last transform, so the locals still carry their IL names
|
||||
Assert.That(partial.Output, Does.Contain("local V_0")); |
||||
} |
||||
|
||||
[Test] |
||||
public async Task UnknownTransformNameListsThePipeline() |
||||
{ |
||||
var result = await RunILAstAsync("--after-transform", "NoSuchTransform"); |
||||
|
||||
Assert.That(result.ExitCode, Is.EqualTo(ProgramExitCodes.EX_USAGE)); |
||||
// the error must be actionable on its own: it lists the pipeline in run order
|
||||
Assert.That(result.Error, Does.Contain("ControlFlowSimplification")); |
||||
Assert.That(result.Error, Does.Contain("AssignVariableNames")); |
||||
} |
||||
|
||||
[Test] |
||||
public async Task AmbiguousTransformNameReportsItsOccurrences() |
||||
{ |
||||
// SplitVariables runs more than once; the name alone cannot identify a stop point
|
||||
var result = await RunILAstAsync("--after-transform", "SplitVariables"); |
||||
|
||||
Assert.That(result.ExitCode, Is.EqualTo(ProgramExitCodes.EX_USAGE)); |
||||
// the message has to be the ambiguity one, not the unknown-name listing, which
|
||||
// mentions every transform of the pipeline as well
|
||||
Assert.That(result.Error, Does.Contain("'SplitVariables' runs")); |
||||
Assert.That(result.Error, Does.Contain("times, at index")); |
||||
Assert.That(result.Error, Does.Not.Contain("Unknown transform")); |
||||
} |
||||
|
||||
[Test] |
||||
public async Task NestedTransformNamesTheEntryThatRunsIt() |
||||
{ |
||||
// LoopDetection runs inside a BlockILTransform, so it has no stop point of its own;
|
||||
// the pipeline listing has to show where it runs instead of hiding it
|
||||
var result = await RunILAstAsync("--after-transform", "LoopDetection"); |
||||
|
||||
Assert.That(result.ExitCode, Is.EqualTo(ProgramExitCodes.EX_USAGE)); |
||||
Assert.That(result.Error, Does.Contain("runs inside the transform at index")); |
||||
Assert.That(result.Error, Does.Contain("BlockILTransform (LoopDetection")); |
||||
} |
||||
|
||||
[Test] |
||||
public async Task DebugSymbolsProvideLocalVariableNames() |
||||
{ |
||||
var withPdb = await RunILAstAsync("--ilast", "-usepdb"); |
||||
var withoutPdb = await RunILAstAsync("--ilast"); |
||||
|
||||
Assert.That(withPdb.ExitCode, Is.EqualTo(0), withPdb.Error); |
||||
// the PDB's name for the accumulator, instead of the generated 'num'
|
||||
Assert.That(withPdb.Output, Does.Contain("local sum")); |
||||
Assert.That(withoutPdb.Output, Does.Not.Contain("local sum")); |
||||
} |
||||
|
||||
[Test] |
||||
public async Task WholeTypeCanBeDumped() |
||||
{ |
||||
var result = await RunAsync(testAssemblyPath, "--disable-updatecheck", |
||||
"-t", "ICSharpCode.ILSpyCmd.Tests.ILAstSample", "--ilast"); |
||||
|
||||
Assert.That(result.ExitCode, Is.EqualTo(0), result.Error); |
||||
Assert.That(result.Output, Does.Contain(nameof(ILAstSample.SumLoop))); |
||||
Assert.That(result.Output, Does.Contain(nameof(ILAstSample.Identity))); |
||||
// accessors are methods with bodies too, and the type system's Methods hides them
|
||||
Assert.That(result.Output, Does.Contain("get_" + nameof(ILAstSample.Counter))); |
||||
} |
||||
|
||||
[Test] |
||||
public async Task OutputDirWritesEveryAssemblyCompletely() |
||||
{ |
||||
// Two input assemblies, so the per-file output writer is swapped between files;
|
||||
// a writer that is replaced without being flushed truncates the earlier file.
|
||||
string ilspyCmdAssemblyPath = typeof(ILSpyCmdProgram).Assembly.Location; |
||||
string outputDir = Path.Combine(Path.GetTempPath(), Path.GetRandomFileName()); |
||||
Directory.CreateDirectory(outputDir); |
||||
try |
||||
{ |
||||
// one transform only: this dumps every method of both assemblies, and the
|
||||
// truncation it guards against does not depend on the pipeline length
|
||||
var result = await RunAsync(testAssemblyPath, ilspyCmdAssemblyPath, |
||||
"--disable-updatecheck", "--after-transform", "1", "-o", outputDir); |
||||
|
||||
Assert.That(result.ExitCode, Is.EqualTo(0), result.Error); |
||||
foreach (string assemblyPath in new[] { testAssemblyPath, ilspyCmdAssemblyPath }) |
||||
{ |
||||
string outputFile = Path.Combine(outputDir, Path.GetFileNameWithoutExtension(assemblyPath) + ".ilast"); |
||||
Assert.That(File.Exists(outputFile), Is.True, outputFile); |
||||
// every function ends with its closing brace; a truncated file breaks off
|
||||
// wherever the writer's buffer happened to end
|
||||
Assert.That(File.ReadAllText(outputFile).TrimEnd(), Does.EndWith("}"), outputFile); |
||||
} |
||||
} |
||||
finally |
||||
{ |
||||
Directory.Delete(outputDir, recursive: true); |
||||
} |
||||
} |
||||
} |
||||
|
||||
public static class ILAstSample |
||||
{ |
||||
public static int SumLoop(int n) |
||||
{ |
||||
int sum = 0; |
||||
for (int i = 0; i < n; i++) |
||||
{ |
||||
sum += i; |
||||
} |
||||
return sum; |
||||
} |
||||
|
||||
public static string Identity(string value) => value; |
||||
|
||||
public static int Counter { get; set; } |
||||
} |
||||
} |
||||
|
||||
#endif
|
||||
@ -0,0 +1,209 @@
@@ -0,0 +1,209 @@
|
||||
// Copyright (c) 2026 Siegfried Pammer
|
||||
//
|
||||
// Permission is hereby granted, free of charge, to any person obtaining a copy of this
|
||||
// software and associated documentation files (the "Software"), to deal in the Software
|
||||
// without restriction, including without limitation the rights to use, copy, modify, merge,
|
||||
// publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
|
||||
// to whom the Software is furnished to do so, subject to the following conditions:
|
||||
//
|
||||
// The above copyright notice and this permission notice shall be included in all copies or
|
||||
// substantial portions of the Software.
|
||||
//
|
||||
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
|
||||
// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
|
||||
// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
|
||||
// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
|
||||
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
||||
// DEALINGS IN THE SOFTWARE.
|
||||
|
||||
#if DEBUG
|
||||
|
||||
using System; |
||||
using System.Collections.Generic; |
||||
using System.Globalization; |
||||
using System.Linq; |
||||
using System.Reflection.Metadata; |
||||
using System.Threading; |
||||
|
||||
using ICSharpCode.Decompiler; |
||||
using ICSharpCode.Decompiler.CSharp; |
||||
using ICSharpCode.Decompiler.IL; |
||||
using ICSharpCode.Decompiler.IL.Transforms; |
||||
using ICSharpCode.Decompiler.Metadata; |
||||
using ICSharpCode.Decompiler.TypeSystem; |
||||
|
||||
namespace ICSharpCode.ILSpyCmd |
||||
{ |
||||
/// <summary>
|
||||
/// Writes the decompiler's intermediate representation (ILAst) of a method body, optionally
|
||||
/// stopping the IL transform pipeline after a chosen transform. This is the command-line
|
||||
/// counterpart of the UI's "ILAst" language, and makes transform output diffable.
|
||||
/// </summary>
|
||||
class ILAstDumper |
||||
{ |
||||
static readonly IReadOnlyList<IILTransform> transforms = CSharpDecompiler.GetILTransforms(); |
||||
|
||||
readonly ILAstWritingOptions writingOptions = new ILAstWritingOptions { |
||||
// same sugar as the UI's ILAst pane, so its output and this one are diffable
|
||||
UseFieldSugar = true, |
||||
UseLogicOperationSugar = true, |
||||
}; |
||||
|
||||
/// <summary>
|
||||
/// Names of the IL transforms, in the order they run, as <c>--after-transform</c> accepts
|
||||
/// them. Transforms nested inside a BlockILTransform (LoopDetection, ConditionDetection,
|
||||
/// the statement transforms, ...) have no name of their own here: they run as part of
|
||||
/// their containing entry and cannot be stopped after individually.
|
||||
/// </summary>
|
||||
public static IReadOnlyList<string> TransformNames { get; } = |
||||
transforms.Select(t => t.GetType().Name).ToArray(); |
||||
|
||||
public static int TransformCount => TransformNames.Count; |
||||
|
||||
/// <summary>
|
||||
/// How a pipeline entry is displayed: a BlockILTransform also names the transforms it
|
||||
/// runs, which are otherwise invisible - and two BlockILTransform entries would be
|
||||
/// indistinguishable.
|
||||
/// </summary>
|
||||
static string Describe(int index) |
||||
{ |
||||
return transforms[index] is BlockILTransform block ? block.ToString() : TransformNames[index]; |
||||
} |
||||
|
||||
/// <summary>
|
||||
/// The 1-based index of the pipeline entry running <paramref name="name"/> as one of its
|
||||
/// nested transforms, or 0 if no entry does.
|
||||
/// </summary>
|
||||
static int FindContainingEntry(string name) |
||||
{ |
||||
for (int i = 0; i < transforms.Count; i++) |
||||
{ |
||||
if (transforms[i] is BlockILTransform block |
||||
&& block.PreOrderTransforms.Concat(block.PostOrderTransforms) |
||||
.Any(t => string.Equals(t.GetType().Name, name, StringComparison.OrdinalIgnoreCase))) |
||||
{ |
||||
return i + 1; |
||||
} |
||||
} |
||||
return 0; |
||||
} |
||||
|
||||
/// <summary>
|
||||
/// The pipeline as displayed to the user: one transform per line, prefixed by the
|
||||
/// 1-based index that <c>--after-transform</c> accepts.
|
||||
/// </summary>
|
||||
public static string DescribePipeline() |
||||
{ |
||||
return string.Join(Environment.NewLine, |
||||
Enumerable.Range(0, TransformCount).Select(index => $" {index + 1,3} {Describe(index)}")); |
||||
} |
||||
|
||||
/// <summary>
|
||||
/// Maps the value of <c>--after-transform</c> to the number of transforms to run.
|
||||
/// Accepts a 1-based pipeline index, or a transform name if it occurs exactly once;
|
||||
/// names that run repeatedly (SplitVariables, ControlFlowSimplification, ...) have to
|
||||
/// be selected by index.
|
||||
/// </summary>
|
||||
public static bool TryResolveTransformCount(string nameOrIndex, out int count, out string error) |
||||
{ |
||||
count = 0; |
||||
error = null; |
||||
string trimmed = nameOrIndex.Trim(); |
||||
|
||||
if (int.TryParse(trimmed, NumberStyles.None, CultureInfo.InvariantCulture, out int index)) |
||||
{ |
||||
if (index < 1 || index > TransformCount) |
||||
{ |
||||
error = $"'{trimmed}' is out of range; the pipeline has {TransformCount} transforms:{Environment.NewLine}{DescribePipeline()}"; |
||||
return false; |
||||
} |
||||
count = index; |
||||
return true; |
||||
} |
||||
|
||||
var occurrences = TransformNames |
||||
.Select((name, i) => (name, position: i + 1)) |
||||
.Where(t => string.Equals(t.name, trimmed, StringComparison.OrdinalIgnoreCase)) |
||||
.Select(t => t.position) |
||||
.ToArray(); |
||||
|
||||
if (occurrences.Length == 0) |
||||
{ |
||||
int containingEntry = FindContainingEntry(trimmed); |
||||
error = containingEntry > 0 |
||||
? $"'{trimmed}' runs inside the transform at index {containingEntry} and cannot be stopped after on its own. Pass that index to stop after the whole entry:{Environment.NewLine}{DescribePipeline()}" |
||||
: $"Unknown transform '{trimmed}'. Pass one of these names, or its index:{Environment.NewLine}{DescribePipeline()}"; |
||||
return false; |
||||
} |
||||
if (occurrences.Length > 1) |
||||
{ |
||||
error = $"'{trimmed}' runs {occurrences.Length} times, at index {string.Join(", ", occurrences)}. Pass the index of the occurrence to stop after."; |
||||
return false; |
||||
} |
||||
|
||||
count = occurrences[0]; |
||||
return true; |
||||
} |
||||
|
||||
/// <summary>
|
||||
/// Writes the ILAst of a single method, or nothing at all if the method has no body
|
||||
/// (abstract, extern or a runtime-provided implementation). Returns the failure if the
|
||||
/// body could not be read, transformed or written, so that one broken method neither
|
||||
/// aborts the dump nor makes the run look successful.
|
||||
/// </summary>
|
||||
public DecompilerException WriteMethod(CSharpDecompiler decompiler, DecompilerSettings settings, IMethod method, |
||||
int transformCount, ITextOutput output, CancellationToken cancellationToken) |
||||
{ |
||||
if (method == null || method.MetadataToken.IsNil || method.MetadataToken.Kind != HandleKind.MethodDefinition) |
||||
return null; |
||||
var module = decompiler.TypeSystem.MainModule; |
||||
var metadataFile = module.MetadataFile; |
||||
var handle = (MethodDefinitionHandle)method.MetadataToken; |
||||
var methodDefinition = metadataFile.Metadata.GetMethodDefinition(handle); |
||||
if (!methodDefinition.HasBody()) |
||||
return null; |
||||
|
||||
output.WriteLine($"// {method.FullName}"); |
||||
output.WriteLine($"// ILAst after {transformCount} of {TransformCount} transforms ({Describe(transformCount - 1)})"); |
||||
|
||||
DecompilerException error = null; |
||||
ILFunction function = null; |
||||
try |
||||
{ |
||||
var reader = new ILReader(module) { |
||||
UseDebugSymbols = settings.UseDebugSymbols, |
||||
UseRefLocalsForAccurateOrderOfEvaluation = settings.UseRefLocalsForAccurateOrderOfEvaluation, |
||||
DebugInfo = decompiler.DebugInfoProvider, |
||||
}; |
||||
var body = metadataFile.GetMethodBody(methodDefinition.RelativeVirtualAddress); |
||||
function = reader.ReadIL(handle, body, kind: ILFunctionKind.TopLevelFunction, |
||||
cancellationToken: cancellationToken); |
||||
ILTransformContext context = decompiler.CreateILTransformContext(function); |
||||
function.RunTransforms(transforms.Take(transformCount), context); |
||||
} |
||||
catch (Exception ex) |
||||
{ |
||||
// Showing how far the pipeline got is the point of this command, so a crashing
|
||||
// transform prints its exception and then the partially transformed function
|
||||
// rather than aborting the whole dump.
|
||||
output.WriteLine(ex.ToString()); |
||||
output.WriteLine("// ILAst after the crash:"); |
||||
error = new DecompilerException(module, method, ex); |
||||
} |
||||
try |
||||
{ |
||||
function?.WriteTo(output, writingOptions); |
||||
} |
||||
catch (Exception ex) |
||||
{ |
||||
output.WriteLine(ex.ToString()); |
||||
error ??= new DecompilerException(module, method, ex); |
||||
} |
||||
output.WriteLine(); |
||||
output.WriteLine(); |
||||
return error; |
||||
} |
||||
} |
||||
} |
||||
|
||||
#endif
|
||||
Loading…
Reference in new issue