summaryrefslogtreecommitdiff
path: root/ICSharpCode.Decompiler/FlowAnalysis/SsaInstruction.cs
blob: c9375852f782547755b1bad2d41e5a869b5ab115 (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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
// 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.Diagnostics;
using System.IO;

using ICSharpCode.Decompiler.Disassembler;
using Mono.Cecil;
using Mono.Cecil.Cil;

namespace ICSharpCode.Decompiler.FlowAnalysis
{
	public enum SpecialOpCode
	{
		/// <summary>
		/// No special op code: SsaInstruction has a normal IL instruction
		/// </summary>
		None,
		/// <summary>
		/// Φ function: chooses the appropriate variable based on which CFG edge was used to enter this block
		/// </summary>
		Phi,
		/// <summary>
		/// Variable is read from before passing it by ref.
		/// This instruction constructs a managed reference to the variable.
		/// </summary>
		PrepareByRefCall,
		/// <summary>
		/// This instruction constructs a managed reference to the variable.
		/// The variable is not really read from.
		/// </summary>
		PrepareByOutCall,
		/// <summary>
		/// This instruction constructs a managed reference to the variable.
		/// The reference is used for a field access on a value type.
		/// </summary>
		PrepareForFieldAccess,
		/// <summary>
		/// Variable is written to after passing it by ref or out.
		/// </summary>
		WriteAfterByRefOrOutCall,
		/// <summary>
		/// Variable is not initialized.
		/// </summary>
		Uninitialized,
		/// <summary>
		/// Value is passed in as parameter
		/// </summary>
		Parameter,
		/// <summary>
		/// Value is a caught exception.
		/// TypeOperand is set to the exception type.
		/// </summary>
		Exception,
		/// <summary>
		/// Initialize a value type. Unlike the real initobj instruction, this one does not take an address
		/// but assigns to the target variable.
		/// TypeOperand is set to the type being created.
		/// </summary>
		InitObj
	}
	
	public sealed class SsaInstruction
	{
		public readonly SsaBlock ParentBlock;
		public readonly SpecialOpCode SpecialOpCode;
		
		/// <summary>
		/// The original IL instruction.
		/// May be null for "invented" instructions (SpecialOpCode != None).
		/// </summary>
		public readonly Instruction Instruction;
		
		/// <summary>
		/// Prefixes in front of the IL instruction.
		/// </summary>
		public readonly Instruction[] Prefixes;
		
		/// <summary>
		/// Gets the type operand. This is used only in combination with some special opcodes.
		/// </summary>
		public readonly TypeReference TypeOperand;
		
		public SsaVariable Target;
		public SsaVariable[] Operands;
		
		static readonly SsaVariable[] emptyVariableArray = {};
		static readonly Instruction[] emptyInstructionArray = {};
		
		public SsaInstruction(SsaBlock parentBlock, Instruction instruction, SsaVariable target, SsaVariable[] operands,
		                      Instruction[] prefixes = null, SpecialOpCode specialOpCode = SpecialOpCode.None,
		                      TypeReference typeOperand = null)
		{
			ParentBlock = parentBlock;
			Instruction = instruction;
			Prefixes = prefixes ?? emptyInstructionArray;
			Target = target;
			Operands = operands ?? emptyVariableArray;
			SpecialOpCode = specialOpCode;
			TypeOperand = typeOperand;
			Debug.Assert((typeOperand != null) == (specialOpCode == SpecialOpCode.Exception || specialOpCode == SpecialOpCode.InitObj));
		}
		
		/// <summary>
		/// Gets whether this instruction is a simple assignment from one variable to another.
		/// </summary>
		public bool IsMoveInstruction {
			get {
				return Target != null && Operands.Length == 1 && Instruction != null && OpCodeInfo.Get(Instruction.OpCode).IsMoveInstruction;
			}
		}
		
		public void ReplaceVariableInOperands(SsaVariable oldVar, SsaVariable newVar)
		{
			for (int i = 0; i < Operands.Length; i++) {
				if (Operands[i] == oldVar)
					Operands[i] = newVar;
			}
		}
		
		public override string ToString()
		{
			StringWriter w = new StringWriter();
			WriteTo(w);
			return w.ToString();
		}
		
		public void WriteTo(TextWriter writer)
		{
			foreach (Instruction prefix in Prefixes) {
				DisassemblerHelpers.WriteTo(prefix, new PlainTextOutput(writer));
				writer.WriteLine();
			}
			if (Instruction != null && Instruction.Offset >= 0) {
				writer.Write(CecilExtensions.OffsetToString(Instruction.Offset));
				writer.Write(": ");
			}
			if (Target != null) {
				writer.Write(Target.ToString());
				writer.Write(" = ");
			}
			if (IsMoveInstruction) {
				writer.Write(Operands[0].ToString());
				if (Instruction != null) {
					writer.Write(" (" + Instruction.OpCode.Name + ")");
				}
			} else {
				if (Instruction == null) {
					writer.Write(SpecialOpCode.ToString());
				} else {
					writer.Write(Instruction.OpCode.Name);
					if(null != Instruction.Operand) {
						writer.Write(' ');
						DisassemblerHelpers.WriteOperand(new PlainTextOutput(writer), Instruction.Operand);
						writer.Write(' ');
					}
				}
				if (TypeOperand != null) {
					writer.Write(' ');
					writer.Write(TypeOperand.ToString());
					writer.Write(' ');
				}
				if (Operands.Length > 0) {
					writer.Write('(');
					for (int i = 0; i < Operands.Length; i++) {
						if (i > 0)
							writer.Write(", ");
						writer.Write(Operands[i].ToString());
					}
					writer.Write(')');
				}
			}
		}
	}
}