summaryrefslogtreecommitdiff
path: root/ICSharpCode.Decompiler/FlowAnalysis/SsaForm.cs
blob: baf520eb2c9e4460ce8413d24b86a0770af56896 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
// Copyright (c) 2010 Daniel Grunwald
// 
// 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.Collections.ObjectModel;
using System.Diagnostics;
using System.Linq;

using ICSharpCode.NRefactory.Utils;
using Mono.Cecil;
using Mono.Cecil.Cil;

namespace ICSharpCode.Decompiler.FlowAnalysis
{
	/// <summary>
	/// Represents a graph of SsaBlocks.
	/// </summary>
	public sealed class SsaForm
	{
		readonly SsaVariable[] parameters;
		readonly SsaVariable[] locals;
		public readonly ReadOnlyCollection<SsaVariable> OriginalVariables;
		public readonly ReadOnlyCollection<SsaBlock> Blocks;
		readonly bool methodHasThis;
		
		public SsaBlock EntryPoint {
			get { return Blocks[0]; }
		}
		
		public SsaBlock RegularExit {
			get { return Blocks[1]; }
		}
		
		public SsaBlock ExceptionalExit {
			get { return Blocks[2]; }
		}
		
		internal SsaForm(SsaBlock[] blocks, SsaVariable[] parameters, SsaVariable[] locals, SsaVariable[] stackLocations, bool methodHasThis)
		{
			this.parameters = parameters;
			this.locals = locals;
			Blocks = new ReadOnlyCollection<SsaBlock>(blocks);
			OriginalVariables = new ReadOnlyCollection<SsaVariable>(parameters.Concat(locals).Concat(stackLocations).ToList());
			this.methodHasThis = methodHasThis;
			
			Debug.Assert(EntryPoint.NodeType == ControlFlowNodeType.EntryPoint);
			Debug.Assert(RegularExit.NodeType == ControlFlowNodeType.RegularExit);
			Debug.Assert(ExceptionalExit.NodeType == ControlFlowNodeType.ExceptionalExit);
			for (int i = 0; i < OriginalVariables.Count; i++) {
				OriginalVariables[i].OriginalVariableIndex = i;
			}
		}
		
		public GraphVizGraph ExportBlockGraph(Func<SsaBlock, string> labelProvider = null)
		{
			if (labelProvider == null)
				labelProvider = b => b.ToString();
			GraphVizGraph graph = new GraphVizGraph();
			foreach (SsaBlock block in Blocks) {
				graph.AddNode(new GraphVizNode(block.BlockIndex) { label = labelProvider(block), shape = "box" });
			}
			foreach (SsaBlock block in Blocks) {
				foreach (SsaBlock s in block.Successors) {
					graph.AddEdge(new GraphVizEdge(block.BlockIndex, s.BlockIndex));
				}
			}
			return graph;
		}
		
		public GraphVizGraph ExportVariableGraph(Func<SsaVariable, string> labelProvider = null)
		{
			if (labelProvider == null)
				labelProvider = v => v.ToString();
			GraphVizGraph graph = new GraphVizGraph();
			foreach (SsaVariable v in AllVariables) {
				graph.AddNode(new GraphVizNode(v.Name) { label = labelProvider(v) });
			}
			int instructionIndex = 0;
			foreach (SsaBlock block in Blocks) {
				foreach (SsaInstruction inst in block.Instructions) {
					if (inst.Operands.Length == 0 && inst.Target == null)
						continue;
					string id = "instruction" + (++instructionIndex);
					graph.AddNode(new GraphVizNode(id) { label = inst.ToString(), shape = "box" });
					foreach (SsaVariable op in inst.Operands)
						graph.AddEdge(new GraphVizEdge(op.Name, id));
					if (inst.Target != null)
						graph.AddEdge(new GraphVizEdge(id, inst.Target.Name));
				}
			}
			return graph;
		}
		
		public SsaVariable GetOriginalVariable(ParameterReference parameter)
		{
			if (methodHasThis)
				return parameters[parameter.Index + 1];
			else
				return parameters[parameter.Index];
		}
		
		public SsaVariable GetOriginalVariable(VariableReference variable)
		{
			return locals[variable.Index];
		}
		
		#region ComputeVariableUsage
		public void ComputeVariableUsage()
		{
			// clear data from previous runs
			foreach (SsaBlock block in Blocks) {
				foreach (SsaInstruction inst in block.Instructions) {
					foreach (SsaVariable v in inst.Operands) {
						if (v.Usage != null)
							v.Usage.Clear();
					}
					if (inst.Target != null && inst.Target.Usage != null)
						inst.Target.Usage.Clear();
				}
			}
			foreach (SsaBlock block in Blocks) {
				foreach (SsaInstruction inst in block.Instructions) {
					foreach (SsaVariable v in inst.Operands) {
						if (v.Usage == null)
							v.Usage = new List<SsaInstruction>();
						v.Usage.Add(inst);
					}
					if (inst.Target != null && inst.Target.Usage == null)
						inst.Target.Usage = new List<SsaInstruction>();
				}
			}
		}
		#endregion
		
		public IEnumerable<SsaVariable> AllVariables {
			get {
				return (
					from block in Blocks
					from instruction in block.Instructions
					where instruction.Target != null
					select instruction.Target
				).Distinct();
			}
		}
	}
}