summaryrefslogtreecommitdiff
path: root/ICSharpCode.Decompiler/FlowAnalysis/SsaOptimization.cs
blob: 7169699205dd76d6af774d915cf404a6d8aff1d4 (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
// 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 Mono.Cecil.Cil;

namespace ICSharpCode.Decompiler.FlowAnalysis
{
	/// <summary>
	/// Contains some very simple optimizations that work on the SSA form.
	/// </summary>
	internal static class SsaOptimization
	{
		public static void Optimize(SsaForm ssaForm)
		{
			DirectlyStoreToVariables(ssaForm);
			SimpleCopyPropagation(ssaForm);
			RemoveDeadAssignments(ssaForm);
		}
		
		/// <summary>
		/// When any instructions stores its result in a stack location that's used only once in a 'stloc' or 'starg' instruction,
		/// we optimize this to directly store in the target location.
		/// As optimization this is redundant (does the same as copy propagation), but it'll make us keep the variables named
		/// after locals instead of keeping the temps as using only the simple copy propagation would do.
		/// </summary>
		public static void DirectlyStoreToVariables(SsaForm ssaForm)
		{
			foreach (SsaBlock block in ssaForm.Blocks) {
				block.Instructions.RemoveAll(
					inst => {
						if (inst.Instruction != null && (inst.Instruction.OpCode == OpCodes.Stloc || inst.Instruction.OpCode == OpCodes.Starg)) {
							SsaVariable target = inst.Target;
							SsaVariable temp = inst.Operands[0];
							if (target.IsSingleAssignment && temp.IsSingleAssignment && temp.Usage.Count == 1 && temp.IsStackLocation) {
								temp.Definition.Target = target;
								return true;
							}
						}
						return false;
					});
			}
			ssaForm.ComputeVariableUsage(); // update usage after we modified stuff
		}
		
		public static void SimpleCopyPropagation(SsaForm ssaForm, bool onlyForStackLocations = true)
		{
			foreach (SsaBlock block in ssaForm.Blocks) {
				foreach (SsaInstruction inst in block.Instructions) {
					if (inst.IsMoveInstruction && inst.Target.IsSingleAssignment && inst.Operands[0].IsSingleAssignment) {
						if (inst.Target.IsStackLocation || !onlyForStackLocations) {
							// replace all uses of 'target' with 'operands[0]'.
							foreach (SsaInstruction useInstruction in inst.Target.Usage) {
								useInstruction.ReplaceVariableInOperands(inst.Target, inst.Operands[0]);
							}
						}
					}
				}
			}
			ssaForm.ComputeVariableUsage(); // update usage after we modified stuff
		}
		
		public static void RemoveDeadAssignments(SsaForm ssaForm)
		{
			HashSet<SsaVariable> liveVariables = new HashSet<SsaVariable>();
			// find variables that are used directly
			foreach (SsaBlock block in ssaForm.Blocks) {
				foreach (SsaInstruction inst in block.Instructions) {
					if (!CanRemoveAsDeadCode(inst)) {
						if (inst.Target != null)
							liveVariables.Add(inst.Target);
						foreach (SsaVariable op in inst.Operands) {
							liveVariables.Add(op);
						}
					}
				}
			}
			Queue<SsaVariable> queue = new Queue<SsaVariable>(liveVariables);
			// find variables that are used indirectly
			while (queue.Count > 0) {
				SsaVariable v = queue.Dequeue();
				if (v.IsSingleAssignment) {
					foreach (SsaVariable op in v.Definition.Operands) {
						if (liveVariables.Add(op))
							queue.Enqueue(op);
					}
				}
			}
			// remove assignments to all unused variables
			foreach (SsaBlock block in ssaForm.Blocks) {
				block.Instructions.RemoveAll(
					inst => {
						if (inst.Target != null && !liveVariables.Contains(inst.Target)) {
							Debug.Assert(inst.Target.IsSingleAssignment);
							return true;
						}
						return false;
					});
			}
			ssaForm.ComputeVariableUsage(); // update usage after we modified stuff
		}
		
		static bool CanRemoveAsDeadCode(SsaInstruction inst)
		{
			if (inst.Target != null && !inst.Target.IsSingleAssignment)
				return false;
			switch (inst.SpecialOpCode) {
				case SpecialOpCode.Phi:
				case SpecialOpCode.Exception:
				case SpecialOpCode.Parameter:
				case SpecialOpCode.Uninitialized:
					return true;
				case SpecialOpCode.None:
					return inst.IsMoveInstruction;
				default:
					return false;
			}
		}
	}
}