// 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.Concurrent; using System.Collections.Generic; using System.Linq; using System.Threading; using dnlib.DotNet; using dnlib.DotNet.Emit; using dnSpy.Analyzer.Properties; using dnSpy.Contracts.Decompiler; using dnSpy.Contracts.Text; namespace dnSpy.Analyzer.TreeNodes { sealed class VirtualMethodUsedByNode : SearchNode { readonly MethodDef analyzedMethod; readonly bool isSetter; PropertyDef? property; ConcurrentDictionary? foundMethods; MethodDef? baseMethod; Guid comGuid; bool isComType; int vtblIndex; public VirtualMethodUsedByNode(MethodDef analyzedMethod, bool isSetter) { this.analyzedMethod = analyzedMethod ?? throw new ArgumentNullException(nameof(analyzedMethod)); this.isSetter = isSetter; } protected override void Write(ITextColorWriter output, IDecompiler decompiler) => output.Write(BoxedTextColor.Text, dnSpy_Analyzer_Resources.UsedByTreeNode); protected override IEnumerable FetchChildren(CancellationToken ct) { InitializeAnalyzer(); if (isSetter) property = analyzedMethod.DeclaringType.Properties.FirstOrDefault(a => a.SetMethod == analyzedMethod); var includeAllModules = property is not null && CustomAttributesUtils.IsPseudoCustomAttributeType(analyzedMethod.DeclaringType); ComUtils.GetMemberInfo(analyzedMethod, out isComType, out comGuid, out vtblIndex); includeAllModules |= isComType; var options = ScopedWhereUsedAnalyzerOptions.None; if (includeAllModules) options |= ScopedWhereUsedAnalyzerOptions.IncludeAllModules; if (isComType) options |= ScopedWhereUsedAnalyzerOptions.ForcePublic; var analyzer = new ScopedWhereUsedAnalyzer(Context.DocumentService, analyzedMethod, FindReferencesInType, options); foreach (var child in analyzer.PerformAnalysis(ct)) { yield return child; } if (property is not null) { var hash = new HashSet(); foreach (var module in analyzer.AllModules) { if (module.Assembly is AssemblyDef asm && hash.Add(module.Assembly)) { foreach (var node in FieldAccessNode.CheckCustomAttributeNamedArgumentWrite(Context, asm, property)) yield return node; } foreach (var node in FieldAccessNode.CheckCustomAttributeNamedArgumentWrite(Context, module, property)) yield return node; } } ReleaseAnalyzer(); } void InitializeAnalyzer() { foundMethods = new ConcurrentDictionary(); var baseMethods = TypesHierarchyHelpers.FindBaseMethods(analyzedMethod).ToArray(); if (baseMethods.Length > 0) { baseMethod = baseMethods[baseMethods.Length - 1]; } else baseMethod = analyzedMethod; } void ReleaseAnalyzer() { foundMethods = null; baseMethod = null; } IEnumerable FindReferencesInType(TypeDef type) { string name = analyzedMethod.Name; foreach (MethodDef method in type.Methods) { if (!method.HasBody) continue; Instruction? foundInstr = null; foreach (Instruction instr in method.Body.Instructions) { if (!(instr.Operand is IMethod mr) || mr.IsField) continue; MethodDef? md = null; if (isComType) { md ??= mr.ResolveMethodDef(); if (md is not null) { ComUtils.GetMemberInfo(md, out bool otherIsComType, out var otherComGuid, out int otherVtblIndex); if (otherIsComType && comGuid == otherComGuid && vtblIndex == otherVtblIndex) { foundInstr = instr; break; } } } if (mr.Name == name) { // explicit call to the requested method if (Helpers.IsReferencedBy(analyzedMethod.DeclaringType, mr.DeclaringType) && CheckEquals(md ??= mr.ResolveMethodDef(), analyzedMethod)) { foundInstr = instr; break; } // virtual call to base method if (instr.OpCode.Code == Code.Callvirt || instr.OpCode.Code == Code.Ldvirtftn) { md ??= mr.ResolveMethodDef(); if (md is null) { // cannot resolve the operand, so ignore this method break; } if (CheckEquals(md, baseMethod)) { foundInstr = instr; break; } } } } if (foundInstr is not null) { if (GetOriginalCodeLocation(method) is MethodDef codeLocation && !HasAlreadyBeenFound(codeLocation)) { var node = new MethodNode(codeLocation) { Context = Context }; if (codeLocation == method) node.SourceRef = new SourceRef(method, foundInstr.Offset, foundInstr.Operand as IMDTokenProvider); yield return node; } } } if (property is not null) { foreach (var node in FieldAccessNode.CheckCustomAttributeNamedArgumentWrite(Context, type, property)) { if (node is MethodNode methodNode && methodNode.Member is MethodDef method && HasAlreadyBeenFound(method)) continue; yield return node; } } } bool HasAlreadyBeenFound(MethodDef method) => !foundMethods!.TryAdd(method, 0); } }