Browse Source

Use a simpler loop detection for the disassembler.

pull/1/head^2
Daniel Grunwald 15 years ago
parent
commit
044714fe29
  1. 8
      ICSharpCode.Decompiler/CecilExtensions.cs
  2. 223
      ICSharpCode.Decompiler/Disassembler/ILStructure.cs
  3. 57
      ICSharpCode.Decompiler/Disassembler/MethodBodyDisassembler.cs
  4. 20
      ICSharpCode.Decompiler/FlowAnalysis/ControlFlowGraphBuilder.cs
  5. 2
      ICSharpCode.Decompiler/FlowAnalysis/ControlFlowNode.cs
  6. 18
      ICSharpCode.Decompiler/FlowAnalysis/OpCodeInfo.cs
  7. 1
      ICSharpCode.Decompiler/ICSharpCode.Decompiler.csproj

8
ICSharpCode.Decompiler/CecilExtensions.cs

@ -123,6 +123,14 @@ namespace ICSharpCode.Decompiler @@ -123,6 +123,14 @@ namespace ICSharpCode.Decompiler
}
#endregion
/// <summary>
/// Gets the (exclusive) end offset of this instruction.
/// </summary>
public static int GetEndOffset(this Instruction inst)
{
return inst.Offset + inst.GetSize();
}
public static string OffsetToString(int offset)
{
return string.Format("IL_{0:x4}", offset);

223
ICSharpCode.Decompiler/Disassembler/ILStructure.cs

@ -0,0 +1,223 @@ @@ -0,0 +1,223 @@
// Copyright (c) 2011 AlphaSierraPapa for the SharpDevelop Team
//
// 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.
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using ICSharpCode.Decompiler.FlowAnalysis;
using Mono.Cecil.Cil;
namespace ICSharpCode.Decompiler.Disassembler
{
/// <summary>
/// Specifies the type of an IL structure.
/// </summary>
public enum ILStructureType
{
/// <summary>
/// The root block of the method
/// </summary>
Root,
/// <summary>
/// A nested control structure representing a loop.
/// </summary>
Loop,
/// <summary>
/// A nested control structure representing a try block.
/// </summary>
Try,
/// <summary>
/// A nested control structure representing a catch, finally, or fault block.
/// </summary>
Handler,
/// <summary>
/// A nested control structure representing an exception filter block.
/// </summary>
Filter
}
/// <summary>
/// An IL structure.
/// </summary>
public class ILStructure
{
public readonly ILStructureType Type;
/// <summary>
/// Start position of the structure.
/// </summary>
public readonly int StartOffset;
/// <summary>
/// End position of the structure. (exclusive)
/// </summary>
public readonly int EndOffset;
/// <summary>
/// The exception handler associated with the Try, Filter or Handler block.
/// </summary>
public readonly ExceptionHandler ExceptionHandler;
/// <summary>
/// The loop's entry point.
/// </summary>
public readonly Instruction LoopEntryPoint;
/// <summary>
/// The list of child structures.
/// </summary>
public readonly List<ILStructure> Children = new List<ILStructure>();
public ILStructure(MethodBody body)
: this(ILStructureType.Root, 0, body.CodeSize)
{
// Build the tree of exception structures:
foreach (ExceptionHandler eh in body.ExceptionHandlers) {
AddNestedStructure(new ILStructure(ILStructureType.Try, eh.TryStart.Offset, eh.TryEnd.Offset, eh));
if (eh.HandlerType == ExceptionHandlerType.Filter)
AddNestedStructure(new ILStructure(ILStructureType.Filter, eh.FilterStart.Offset, eh.FilterEnd.Offset, eh));
AddNestedStructure(new ILStructure(ILStructureType.Handler, eh.HandlerStart.Offset, eh.HandlerEnd.Offset, eh));
}
// Very simple loop detection: look for backward branches
List<KeyValuePair<Instruction, Instruction>> allBranches = FindAllBranches(body);
// We go through the branches in reverse so that we find the biggest possible loop boundary first (think loops with "continue;")
for (int i = allBranches.Count - 1; i >= 0; i--) {
int loopEnd = allBranches[i].Key.GetEndOffset();
int loopStart = allBranches[i].Value.Offset;
if (loopStart < loopEnd) {
// We found a backward branch. This is a potential loop.
// Check that is has only one entry point:
Instruction entryPoint = null;
// entry point is first instruction in loop if prev inst isn't an unconditional branch
Instruction prev = allBranches[i].Value.Previous;
if (prev != null && !OpCodeInfo.IsUnconditionalBranch(prev.OpCode))
entryPoint = allBranches[i].Value;
bool multipleEntryPoints = false;
foreach (var pair in allBranches) {
if (pair.Key.Offset < loopStart || pair.Key.Offset >= loopEnd) {
if (loopStart <= pair.Value.Offset && pair.Value.Offset < loopEnd) {
// jump from outside the loop into the loop
if (entryPoint == null)
entryPoint = pair.Value;
else if (pair.Value != entryPoint)
multipleEntryPoints = true;
}
}
}
if (!multipleEntryPoints) {
AddNestedStructure(new ILStructure(ILStructureType.Loop, loopStart, loopEnd, entryPoint));
}
}
}
SortChildren();
}
public ILStructure(ILStructureType type, int startOffset, int endOffset, ExceptionHandler handler = null)
{
Debug.Assert(startOffset < endOffset);
this.Type = type;
this.StartOffset = startOffset;
this.EndOffset = endOffset;
this.ExceptionHandler = handler;
}
public ILStructure(ILStructureType type, int startOffset, int endOffset, Instruction loopEntryPoint)
{
Debug.Assert(startOffset < endOffset);
this.Type = type;
this.StartOffset = startOffset;
this.EndOffset = endOffset;
this.LoopEntryPoint = loopEntryPoint;
}
bool AddNestedStructure(ILStructure newStructure)
{
// special case: don't consider the loop-like structure of "continue;" statements to be nested loops
if (this.Type == ILStructureType.Loop && newStructure.Type == ILStructureType.Loop && newStructure.StartOffset == this.StartOffset)
return false;
// use <= for end-offset comparisons because both end and EndOffset are exclusive
Debug.Assert(StartOffset <= newStructure.StartOffset && newStructure.EndOffset <= EndOffset);
foreach (ILStructure child in this.Children) {
if (child.StartOffset <= newStructure.StartOffset && newStructure.EndOffset <= child.EndOffset) {
return child.AddNestedStructure(newStructure);
} else if (!(child.EndOffset <= newStructure.StartOffset || newStructure.EndOffset <= child.StartOffset)) {
// Overlap (invalid nesting), can't build a tree. -> Don't add the new structure.
return false;
}
}
// Move existing structures into the new structure:
for (int i = 0; i < this.Children.Count; i++) {
ILStructure child = this.Children[i];
if (newStructure.StartOffset <= child.StartOffset && child.EndOffset <= newStructure.EndOffset) {
this.Children.RemoveAt(i--);
newStructure.Children.Add(child);
}
}
// Add the structure here:
this.Children.Add(newStructure);
return true;
}
/// <summary>
/// Finds all branches. Returns list of source offset->target offset mapping.
/// Multiple entries for the same source offset are possible (switch statements).
/// The result is sorted by source offset.
/// </summary>
List<KeyValuePair<Instruction, Instruction>> FindAllBranches(MethodBody body)
{
var result = new List<KeyValuePair<Instruction, Instruction>>();
foreach (Instruction inst in body.Instructions) {
switch (inst.OpCode.OperandType) {
case OperandType.InlineBrTarget:
case OperandType.ShortInlineBrTarget:
result.Add(new KeyValuePair<Instruction, Instruction>(inst, (Instruction)inst.Operand));
break;
case OperandType.InlineSwitch:
foreach (Instruction target in (Instruction[])inst.Operand)
result.Add(new KeyValuePair<Instruction, Instruction>(inst, target));
break;
}
}
return result;
}
void SortChildren()
{
Children.Sort((a, b) => a.StartOffset.CompareTo(b.StartOffset));
foreach (ILStructure child in Children)
child.SortChildren();
}
/// <summary>
/// Gets the innermost structure containing the specified offset.
/// </summary>
public ILStructure GetInnermost(int offset)
{
Debug.Assert(StartOffset <= offset && offset < EndOffset);
foreach (ILStructure child in this.Children) {
if (child.StartOffset <= offset && offset < child.EndOffset)
return child.GetInnermost(offset);
}
return this;
}
}
}

57
ICSharpCode.Decompiler/Disassembler/MethodBodyDisassembler.cs

@ -17,9 +17,9 @@ @@ -17,9 +17,9 @@
// DEALINGS IN THE SOFTWARE.
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading;
using ICSharpCode.Decompiler;
using ICSharpCode.Decompiler.FlowAnalysis;
using Mono.Cecil;
@ -72,12 +72,9 @@ namespace ICSharpCode.Decompiler.Disassembler @@ -72,12 +72,9 @@ namespace ICSharpCode.Decompiler.Disassembler
}
output.WriteLine();
if (detectControlStructure) {
var cfg = ControlFlowGraphBuilder.Build(method.Body);
cfg.ComputeDominance(cancellationToken);
cfg.ComputeDominanceFrontier();
var s = ControlStructureDetector.DetectStructure(cfg, method.Body.ExceptionHandlers, cancellationToken);
WriteStructure(s);
if (detectControlStructure && body.Instructions.Count > 0) {
Instruction inst = body.Instructions[0];
WriteStructureBody(new ILStructure(body), ref inst);
} else {
foreach (var inst in method.Body.Instructions) {
inst.WriteTo(output);
@ -91,23 +88,22 @@ namespace ICSharpCode.Decompiler.Disassembler @@ -91,23 +88,22 @@ namespace ICSharpCode.Decompiler.Disassembler
}
}
void WriteStructure(ControlStructure s)
void WriteStructureHeader(ILStructure s)
{
if (s.Type != ControlStructureType.Root) {
switch (s.Type) {
case ControlStructureType.Loop:
case ILStructureType.Loop:
output.Write("// loop start");
if (s.EntryPoint.Start != null) {
if (s.LoopEntryPoint != null) {
output.Write(" (head: ");
DisassemblerHelpers.WriteOffsetReference(output, s.EntryPoint.Start);
DisassemblerHelpers.WriteOffsetReference(output, s.LoopEntryPoint);
output.Write(')');
}
output.WriteLine();
break;
case ControlStructureType.Try:
case ILStructureType.Try:
output.WriteLine(".try {");
break;
case ControlStructureType.Handler:
case ILStructureType.Handler:
switch (s.ExceptionHandler.HandlerType) {
case Mono.Cecil.Cil.ExceptionHandlerType.Catch:
case Mono.Cecil.Cil.ExceptionHandlerType.Filter:
@ -128,7 +124,7 @@ namespace ICSharpCode.Decompiler.Disassembler @@ -128,7 +124,7 @@ namespace ICSharpCode.Decompiler.Disassembler
throw new NotSupportedException();
}
break;
case ControlStructureType.Filter:
case ILStructureType.Filter:
output.WriteLine("filter {");
break;
default:
@ -136,29 +132,39 @@ namespace ICSharpCode.Decompiler.Disassembler @@ -136,29 +132,39 @@ namespace ICSharpCode.Decompiler.Disassembler
}
output.Indent();
}
foreach (var node in s.Nodes.Concat(from c in s.Children select c.EntryPoint).OrderBy(c => c.Offset)) {
if (s.Nodes.Contains(node)) {
foreach (var inst in node.Instructions) {
void WriteStructureBody(ILStructure s, ref Instruction inst)
{
int childIndex = 0;
while (inst != null && inst.Offset < s.EndOffset) {
int offset = inst.Offset;
if (childIndex < s.Children.Count && s.Children[childIndex].StartOffset <= offset && offset < s.Children[childIndex].EndOffset) {
ILStructure child = s.Children[childIndex++];
WriteStructureHeader(child);
WriteStructureBody(child, ref inst);
WriteStructureFooter(child);
} else {
inst.WriteTo(output);
output.WriteLine();
inst = inst.Next;
}
} else {
WriteStructure(s.Children.Single(c => c.EntryPoint == node));
}
}
if (s.Type != ControlStructureType.Root) {
void WriteStructureFooter(ILStructure s)
{
output.Unindent();
switch (s.Type) {
case ControlStructureType.Loop:
case ILStructureType.Loop:
output.WriteLine("// end loop");
break;
case ControlStructureType.Try:
case ILStructureType.Try:
output.WriteLine("} // end .try");
break;
case ControlStructureType.Handler:
case ILStructureType.Handler:
output.WriteLine("} // end handler");
break;
case ControlStructureType.Filter:
case ILStructureType.Filter:
output.WriteLine("} // end filter");
break;
default:
@ -166,5 +172,4 @@ namespace ICSharpCode.Decompiler.Disassembler @@ -166,5 +172,4 @@ namespace ICSharpCode.Decompiler.Disassembler
}
}
}
}
}

20
ICSharpCode.Decompiler/FlowAnalysis/ControlFlowGraphBuilder.cs

@ -155,7 +155,7 @@ namespace ICSharpCode.Decompiler.FlowAnalysis @@ -155,7 +155,7 @@ namespace ICSharpCode.Decompiler.FlowAnalysis
foreach (ControlFlowNode node in nodes) {
if (node.End != null) {
// create normal edges from one instruction to the next
if (!IsUnconditionalBranch(node.End.OpCode))
if (!OpCodeInfo.IsUnconditionalBranch(node.End.OpCode))
CreateEdge(node, node.End.Next, JumpType.Normal);
// create edges for branch instructions
@ -434,24 +434,6 @@ namespace ICSharpCode.Decompiler.FlowAnalysis @@ -434,24 +434,6 @@ namespace ICSharpCode.Decompiler.FlowAnalysis
throw new NotSupportedException(opcode.FlowControl.ToString());
}
}
static bool IsUnconditionalBranch(OpCode opcode)
{
if (opcode.OpCodeType == OpCodeType.Prefix)
return false;
switch (opcode.FlowControl) {
case FlowControl.Branch:
case FlowControl.Throw:
case FlowControl.Return:
return true;
case FlowControl.Next:
case FlowControl.Call:
case FlowControl.Cond_Branch:
return false;
default:
throw new NotSupportedException(opcode.FlowControl.ToString());
}
}
#endregion
}
}

2
ICSharpCode.Decompiler/FlowAnalysis/ControlFlowNode.cs

@ -248,7 +248,7 @@ namespace ICSharpCode.Decompiler.FlowAnalysis @@ -248,7 +248,7 @@ namespace ICSharpCode.Decompiler.FlowAnalysis
StringWriter writer = new StringWriter();
switch (NodeType) {
case ControlFlowNodeType.Normal:
int endOffset = End.Next != null ? End.Next.Offset : End.Offset + End.GetSize();
int endOffset = End.GetEndOffset();
writer.Write("Block #{0}: IL_{1:x4} to IL_{2:x4}", BlockIndex, Start.Offset, endOffset);
break;
case ControlFlowNodeType.CatchHandler:

18
ICSharpCode.Decompiler/FlowAnalysis/OpCodeInfo.cs

@ -29,6 +29,24 @@ namespace ICSharpCode.Decompiler.FlowAnalysis @@ -29,6 +29,24 @@ namespace ICSharpCode.Decompiler.FlowAnalysis
/// </summary>
sealed class OpCodeInfo
{
public static bool IsUnconditionalBranch(OpCode opcode)
{
if (opcode.OpCodeType == OpCodeType.Prefix)
return false;
switch (opcode.FlowControl) {
case FlowControl.Branch:
case FlowControl.Throw:
case FlowControl.Return:
return true;
case FlowControl.Next:
case FlowControl.Call:
case FlowControl.Cond_Branch:
return false;
default:
throw new NotSupportedException(opcode.FlowControl.ToString());
}
}
static readonly OpCodeInfo[] knownOpCodes = {
#region Base Instructions
new OpCodeInfo(OpCodes.Add) { CanThrow = false },

1
ICSharpCode.Decompiler/ICSharpCode.Decompiler.csproj

@ -51,6 +51,7 @@ @@ -51,6 +51,7 @@
<ItemGroup>
<Compile Include="CecilExtensions.cs" />
<Compile Include="Disassembler\DisassemblerHelpers.cs" />
<Compile Include="Disassembler\ILStructure.cs" />
<Compile Include="Disassembler\MethodBodyDisassembler.cs" />
<Compile Include="Disassembler\ReflectionDisassembler.cs" />
<Compile Include="FlowAnalysis\ControlFlowEdge.cs" />

Loading…
Cancel
Save