File: SubroutineBuilder.cs

package info (click to toggle)
mono 6.8.0.105%2Bdfsg-3.3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 1,284,512 kB
  • sloc: cs: 11,172,132; xml: 2,850,069; ansic: 671,653; cpp: 122,091; perl: 59,366; javascript: 30,841; asm: 22,168; makefile: 20,093; sh: 15,020; python: 4,827; pascal: 925; sql: 859; sed: 16; php: 1
file content (193 lines) | stat: -rw-r--r-- 6,939 bytes parent folder | download | duplicates (9)
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
192
193
// 
// SubroutineBuilder.cs
// 
// Authors:
// 	Alexander Chebaturkin (chebaturkin@gmail.com)
// 
// Copyright (C) 2011 Alexander Chebaturkin
// 
// 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.Collections.Generic;
using Mono.CodeContracts.Static.AST;
using Mono.CodeContracts.Static.ControlFlow.Blocks;
using Mono.CodeContracts.Static.DataStructures;
using Mono.CodeContracts.Static.Providers;

namespace Mono.CodeContracts.Static.ControlFlow.Subroutines.Builders {
	abstract class SubroutineBuilder<Label> {
		public readonly SubroutineFacade SubroutineFacade;

		private readonly Dictionary<Label, Pair<Method, bool>> labels_for_call_sites = new Dictionary<Label, Pair<Method, bool>> ();
		private readonly Dictionary<Label, Method> labels_for_new_obj_sites = new Dictionary<Label, Method> ();
		private readonly HashSet<Label> labels_starting_blocks = new HashSet<Label> ();
		private readonly HashSet<Label> target_labels = new HashSet<Label> ();

		protected SubroutineBuilder (ICodeProvider<Label> codeProvider,
		                             SubroutineFacade subroutineFacade,
		                             Label entry)
		{
			this.SubroutineFacade = subroutineFacade;
			CodeProvider = codeProvider;
			AddTargetLabel (entry);
		}

		public ICodeProvider<Label> CodeProvider { get; private set; }
		public abstract SubroutineBase<Label> CurrentSubroutine { get; }

		public IMetaDataProvider MetaDataProvider
		{
			get { return this.SubroutineFacade.MetaDataProvider; }
		}

		protected IContractProvider ContractProvider
		{
			get { return this.SubroutineFacade.ContractProvider; }
		}

		public void AddTargetLabel (Label target)
		{
			AddBlockStart (target);
			this.target_labels.Add (target);
		}

		public void AddBlockStart (Label target)
		{
			this.labels_starting_blocks.Add (target);
		}

		protected void Initialize (Label entry)
		{
			new BlockStartGatherer<Label> (this).TraceAggregateSequentally (entry);
		}

		public bool IsBlockStart (Label label)
		{
			return this.labels_starting_blocks.Contains (label);
		}

		public bool IsTargetLabel (Label label)
		{
			return this.target_labels.Contains (label);
		}

		public bool IsMethodCallSite (Label label, out Pair<Method, bool> methodVirtPair)
		{
			return this.labels_for_call_sites.TryGetValue (label, out methodVirtPair);
		}

		public bool IsNewObjSite (Label label, out Method constructor)
		{
			return this.labels_for_new_obj_sites.TryGetValue (label, out constructor);
		}

		protected BlockWithLabels<Label> BuildBlocks (Label entry)
		{
			return BlockBuilder<Label>.BuildBlocks (entry, this);
		}

		public virtual void RecordInformationSameAsOtherBlock (BlockWithLabels<Label> newBlock, BlockWithLabels<Label> currentBlock)
		{
		}

		public virtual BlockWithLabels<Label> RecordInformationForNewBlock (Label currentLabel, BlockWithLabels<Label> previousBlock)
		{
			BlockWithLabels<Label> block = CurrentSubroutine.GetBlock (currentLabel);
			if (previousBlock != null) {
				BlockWithLabels<Label> newBlock = block;
				BlockWithLabels<Label> prevBlock = previousBlock;
				if (block is MethodCallBlock<Label> && previousBlock is MethodCallBlock<Label>) {
					BlockWithLabels<Label> ab = CurrentSubroutine.NewBlock ();
					RecordInformationSameAsOtherBlock (ab, previousBlock);
					newBlock = ab;
					prevBlock = ab;
					CurrentSubroutine.AddSuccessor (previousBlock, EdgeTag.FallThrough, ab);
					CurrentSubroutine.AddSuccessor (ab, EdgeTag.FallThrough, block);
				} else
					CurrentSubroutine.AddSuccessor (previousBlock, EdgeTag.FallThrough, block);

				InsertPostConditionEdges (previousBlock, newBlock);
				InsertPreConditionEdges (prevBlock, block);
			}
			return block;
		}

		protected void InsertPreConditionEdges (BlockWithLabels<Label> previousBlock, BlockWithLabels<Label> newBlock)
		{
			var methodCallBlock = newBlock as MethodCallBlock<Label>;
			if (methodCallBlock == null || CurrentSubroutine.IsContract || CurrentSubroutine.IsOldValue)
				return;

			if (CurrentSubroutine.IsMethod) {
				var methodInfo = CurrentSubroutine as IMethodInfo;
				Property property;
				if (methodInfo != null && MetaDataProvider.IsConstructor (methodInfo.Method)
				    && MetaDataProvider.IsPropertySetter (methodCallBlock.CalledMethod, out property)
				    && MetaDataProvider.IsAutoPropertyMember (methodCallBlock.CalledMethod))
					return;
			}

			EdgeTag callTag = methodCallBlock.IsNewObj ? EdgeTag.BeforeNewObj : EdgeTag.BeforeCall;
			Subroutine requires = this.SubroutineFacade.GetRequires (methodCallBlock.CalledMethod);

			CurrentSubroutine.AddEdgeSubroutine (previousBlock, newBlock, requires, callTag);
		}

		protected void InsertPostConditionEdges (BlockWithLabels<Label> previousBlock, BlockWithLabels<Label> newBlock)
		{
			var methodCallBlock = previousBlock as MethodCallBlock<Label>;
			if (methodCallBlock == null)
				return;

			if (CurrentSubroutine.IsMethod) {
				var methodInfo = CurrentSubroutine as IMethodInfo;
				Property property;
				if (methodInfo != null && MetaDataProvider.IsConstructor (methodInfo.Method)
				    && MetaDataProvider.IsPropertyGetter (methodCallBlock.CalledMethod, out property)
				    && MetaDataProvider.IsAutoPropertyMember (methodCallBlock.CalledMethod))
					return;
			}

			EdgeTag callTag = methodCallBlock.IsNewObj ? EdgeTag.AfterNewObj : EdgeTag.AfterCall;
			Subroutine ensures = this.SubroutineFacade.GetEnsures (methodCallBlock.CalledMethod);

			CurrentSubroutine.AddEdgeSubroutine (previousBlock, newBlock, ensures, callTag);
		}

		public virtual void BeginOldHook (Label label)
		{
		}

		public virtual void EndOldHook (Label label)
		{
		}

		public void AddMethodCallSite (Label pc, Pair<Method, bool> methodVirtPair)
		{
			this.labels_for_call_sites [pc] = methodVirtPair;
		}

		public void AddNewObjSite (Label pc, Method method)
		{
			this.labels_for_new_obj_sites [pc] = method;
		}
	}
}