forked from vescon/MethodBoundaryAspect.Fody
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ModuleWeaver.cs
361 lines (300 loc) · 12.7 KB
/
ModuleWeaver.cs
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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.IO;
using System.Linq;
using System.Runtime.CompilerServices;
using Fody;
using MethodBoundaryAspect.Fody.Ordering;
using Mono.Cecil;
using Mono.Cecil.Pdb;
using Mono.Collections.Generic;
namespace MethodBoundaryAspect.Fody
{
/// <summary>
/// Used tools:
/// - .NET Reflector + Addins "Reflexil" / IL Spy / LinqPad
/// - PEVerify
/// - ILDasm
/// - Mono.Cecil
/// - Fody
///
/// TODO:
/// Fix pdb files -> fixed
/// Intetgrate with Fody -> ok
/// Support for class aspects -> ok
/// Support for assembly aspects -> ok
/// Implement CompileTimeValidate
/// Optimize weaving: Dont generate code of "OnXXX()" method is empty or not used -> ok
/// Optimize weaving: remove runtime dependency on "MethodBoundaryAspect.Attributes" assembly
/// Optimize weaving: only put arguments in MethodExecutionArgs if they are accessed in "OnXXX()" method
/// Optimize weaving: store GetCurrentMethod() result in static Dictionary in MethodBoundaryAspect with generated id for lookup to prevent reflection penalty -> ok
/// </summary>
public class ModuleWeaver : BaseModuleWeaver
{
private MethodInfoCompileTimeWeaver _methodInfoCompileTimeWeaver;
public ModuleWeaver()
{
}
public bool DisableCompileTimeMethodInfos { get; set; }
public int TotalWeavedTypes { get; private set; }
public int TotalWeavedMethods { get; private set; }
public int TotalWeavedProperties { get; private set; }
public List<string> PropertyFilter { get; } = new List<string>();
public List<string> MethodFilters { get; } = new List<string>();
public List<string> TypeFilters { get; } = new List<string>();
public override void Execute()
{
Execute(ModuleDefinition);
}
public override IEnumerable<string> GetAssembliesForScanning()
{
yield return "mscorlib";
yield return "System";
yield return "System.Runtime";
yield return "System.Reflection";
yield return "System.Diagnostics";
yield return "netstandard";
}
private string CreateShadowAssemblyPath(string assemblyPath, string prefix)
{
var fileInfoSource = new FileInfo(assemblyPath);
return
fileInfoSource.DirectoryName
+ Path.DirectorySeparatorChar
+ "_" + prefix + "_"
+ Path.GetFileNameWithoutExtension(fileInfoSource.Name)
+ "_Weaved_"
+ fileInfoSource.Extension.ToLower();
}
public string WeaveToShadowFile(string assemblyPath, IAssemblyResolver assemblyResolver)
{
var prefix = Environment.TickCount.ToString();
var shadowAssemblyPath = CreateShadowAssemblyPath(assemblyPath, prefix);
File.Copy(assemblyPath, shadowAssemblyPath, true);
var pdbPath = Path.ChangeExtension(assemblyPath, "pdb");
var shadowPdbPath = CreateShadowAssemblyPath(pdbPath, prefix);
if (File.Exists(pdbPath))
File.Copy(pdbPath, shadowPdbPath, true);
Weave(shadowAssemblyPath, assemblyResolver);
return shadowAssemblyPath;
}
public void Weave(string assemblyPath, IAssemblyResolver assemblyResolver)
{
var readerParameters = new ReaderParameters
{
ReadSymbols = true,
SymbolReaderProvider = new PdbReaderProvider(),
ReadWrite = true,
AssemblyResolver = assemblyResolver
};
using (var assemblyDefinition = AssemblyDefinition.ReadAssembly(assemblyPath, readerParameters))
{
var module = assemblyDefinition.MainModule;
Execute(module);
var writerParameters = new WriterParameters
{
WriteSymbols = true,
SymbolWriterProvider = new PdbWriterProvider()
};
assemblyDefinition.Write(writerParameters);
}
}
public void AddClassFilter(string classFilter)
{
TypeFilters.Add(classFilter);
}
public void AddMethodFilter(string methodFilter)
{
MethodFilters.Add(methodFilter);
}
public void AddPropertyFilter(string propertyFilter)
{
PropertyFilter.Add(propertyFilter);
}
private void Execute(ModuleDefinition module)
{
_methodInfoCompileTimeWeaver = new MethodInfoCompileTimeWeaver(module)
{
IsEnabled = !DisableCompileTimeMethodInfos
};
var assemblyMethodBoundaryAspects = module.Assembly.CustomAttributes;
foreach (var type in module.Types.ToList())
WeaveTypeAndNestedTypes(module, type, assemblyMethodBoundaryAspects);
_methodInfoCompileTimeWeaver.Finish();
}
private void WeaveTypeAndNestedTypes(ModuleDefinition module, TypeDefinition type,
Collection<CustomAttribute> assemblyMethodBoundaryAspects)
{
WeaveType(module, type, assemblyMethodBoundaryAspects);
if (type.HasNestedTypes)
{
var classMethodBoundaryAspects = new Collection<CustomAttribute>();
foreach (var assemblyAspect in assemblyMethodBoundaryAspects)
classMethodBoundaryAspects.Add(assemblyAspect);
foreach (var classAspect in type.CustomAttributes)
{
if (classAspect.AttributeType.FullName == typeof(CompilerGeneratedAttribute).FullName)
return;
classMethodBoundaryAspects.Add(classAspect);
}
foreach (var nestedType in type.NestedTypes)
WeaveTypeAndNestedTypes(module, nestedType, classMethodBoundaryAspects);
}
}
private void WeaveType(
ModuleDefinition module,
TypeDefinition type,
Collection<CustomAttribute> assemblyMethodBoundaryAspects)
{
var classMethodBoundaryAspects = type.CustomAttributes;
var propertyGetters = type.Properties
.Where(x => x.GetMethod != null)
.ToDictionary(x => x.GetMethod);
var propertySetters = type.Properties
.Where(x => x.SetMethod != null)
.ToDictionary(x => x.SetMethod);
var weavedAtLeastOneMethod = false;
foreach (var method in type.Methods.ToList())
{
if (!IsWeavableMethod(method))
continue;
Collection<CustomAttribute> methodMethodBoundaryAspects;
if (method.IsGetter)
methodMethodBoundaryAspects = propertyGetters[method].CustomAttributes;
else if (method.IsSetter)
methodMethodBoundaryAspects = propertySetters[method].CustomAttributes;
else
methodMethodBoundaryAspects = method.CustomAttributes;
var methodVisibility = GetMethodVisibility(method);
var aspectInfos = assemblyMethodBoundaryAspects
.Concat(classMethodBoundaryAspects)
.Concat(methodMethodBoundaryAspects)
.Where(IsMethodBoundaryAspect)
.Select(x => new AspectInfo(x))
.Where(info => info.HasTargetMemberAttribute(methodVisibility))
.Where(x => !IsSelfWeaving(type, x))
.ToList();
if (aspectInfos.Count == 0)
continue;
foreach (var aspectInfo in aspectInfos)
aspectInfo.InitOrderIndex(assemblyMethodBoundaryAspects, classMethodBoundaryAspects, methodMethodBoundaryAspects);
weavedAtLeastOneMethod = WeaveMethod(
module,
method,
aspectInfos,
_methodInfoCompileTimeWeaver);
}
if (weavedAtLeastOneMethod)
TotalWeavedTypes++;
}
private static bool IsSelfWeaving(TypeDefinition targetType, AspectInfo aspectInfo)
{
return targetType.FullName == aspectInfo.AspectTypeDefinition.FullName;
}
private bool WeaveMethod(
ModuleDefinition module,
MethodDefinition method,
List<AspectInfo> aspectInfos,
MethodInfoCompileTimeWeaver methodInfoCompileTimeWeaver)
{
aspectInfos = AspectOrderer.Order(aspectInfos);
var aspectInfosWithMethods = aspectInfos
.Where(x => !x.SkipProperties || (!method.IsGetter && !method.IsSetter))
.ToList();
var methodWeaver = MethodWeaverFactory.MakeWeaver(module, method, aspectInfosWithMethods, methodInfoCompileTimeWeaver);
methodWeaver.Weave();
if (methodWeaver.WeaveCounter == 0)
return false;
if (method.IsGetter || method.IsSetter)
TotalWeavedProperties++;
else
TotalWeavedMethods++;
return true;
}
private bool IsMethodBoundaryAspect(TypeDefinition attributeTypeDefinition)
{
var currentType = attributeTypeDefinition.BaseType;
do
{
if (currentType.FullName == AttributeFullNames.OnMethodBoundaryAspect)
return true;
currentType = currentType.Resolve().BaseType;
} while (currentType != null);
return false;
}
private bool IsMethodBoundaryAspect(CustomAttribute customAttribute)
{
return IsMethodBoundaryAspect(customAttribute.AttributeType.Resolve());
}
private bool IsWeavableMethod(MethodDefinition method)
{
var fullName = method.DeclaringType.FullName;
var name = method.Name;
if (IsIgnoredByWeaving(method))
return false;
if (IsUserFiltered(fullName, name))
return false;
if (IsDelegate(method))
return false;
return !(method.IsAbstract // abstract or interface method
|| method.IsConstructor
|| name.StartsWith("<") // anonymous
|| method.IsPInvokeImpl); // extern
}
private bool IsDelegate(MethodDefinition method)
{
return !method.HasBody;
}
private bool IsUserFiltered(string fullName, string name)
{
if (TypeFilters.Any())
{
var classFullName = fullName;
var matched = TypeFilters.Contains(classFullName);
if (!matched)
return true;
}
if (MethodFilters.Any())
{
var methodFullName = $"{fullName}.{name}";
var matched = MethodFilters.Contains(methodFullName);
if (!matched)
return true;
}
if (PropertyFilter.Any())
{
var propertySetterFullName = $"{fullName}.{name}";
var propertyGetterFullName = $"{fullName}.{name}";
var matched = PropertyFilter.Contains(propertySetterFullName) ||
MethodFilters.Contains(propertyGetterFullName);
if (!matched)
return true;
}
return false;
}
private static bool IsIgnoredByWeaving(MethodDefinition method)
{
if (ContainsDisableWeavingAttribute(method.CustomAttributes))
return true;
var currentClass = method.DeclaringType;
do
{
if (ContainsDisableWeavingAttribute(currentClass.CustomAttributes))
return true;
currentClass = currentClass.DeclaringType;
} while (currentClass != null);
if (ContainsDisableWeavingAttribute(method.Module.CustomAttributes))
return true;
if (ContainsDisableWeavingAttribute(method.Module.Assembly.CustomAttributes))
return true;
return false;
}
private static bool ContainsDisableWeavingAttribute(IEnumerable<CustomAttribute> customAttributes)
{
return customAttributes.Any(x => x.AttributeType.FullName == AttributeFullNames.DisableWeavingAttribute);
}
private static MethodAttributes GetMethodVisibility(MethodDefinition method) =>
method.Attributes & MethodAttributes.MemberAccessMask;
}
}