using System; using System.Collections.Generic; using System.Linq; using System.Text; using Microsoft.Cci; using Microsoft.Cci.MetadataReader; using Microsoft.Cci.MutableCodeModel; using Microsoft.Cci.Contracts; using Microsoft.Cci.ILToCodeModel; using Bpl = Microsoft.Boogie; using System.Diagnostics.Contracts; namespace BytecodeTranslator { class WholeProgram : TraverserFactory { public override TranslationPlugins.Translator getTranslator(Sink sink, IDictionary contractProviders, IDictionary pdbReaders) { BaseTranslator translator = new BaseTranslator(this, sink, contractProviders, pdbReaders); return translator; } /// /// Table to be filled by the metadata traverser before visiting any assemblies. /// /// The table lists the direct supertypes of all type definitions that it encounters during the /// traversal. (But the table is organized so that subTypes[T] is the list of type definitions /// that are direct subtypes of T.) /// readonly public Dictionary> subTypes = new Dictionary>(); public override BCTMetadataTraverser MakeMetadataTraverser(Sink sink, IDictionary contractProviders, // TODO: remove this parameter? IDictionary pdbReaders) { return new WholeProgramMetadataSemantics(this, sink, pdbReaders, this); } public class WholeProgramMetadataSemantics : BCTMetadataTraverser { readonly WholeProgram parent; readonly Sink sink; readonly Dictionary codeUnderAnalysis = new Dictionary(); public WholeProgramMetadataSemantics(WholeProgram parent, Sink sink, IDictionary pdbReaders, TraverserFactory factory) : base(sink, pdbReaders, factory) { this.parent = parent; this.sink = sink; } public override void TranslateAssemblies(IEnumerable assemblies) { #region traverse all of the units gathering type information var typeRecorder = new RecordSubtypes(this.parent.subTypes); foreach (var a in assemblies) { this.codeUnderAnalysis.Add(a, true); typeRecorder.Traverse((IAssembly)a); } #endregion base.TranslateAssemblies(assemblies); } class RecordSubtypes : MetadataTraverser { Dictionary> subTypes; public RecordSubtypes(Dictionary> subTypes) { this.subTypes = subTypes; } public override void TraverseChildren(ITypeDefinition typeDefinition) { foreach (var baseClass in typeDefinition.BaseClasses) { if (!this.subTypes.ContainsKey(baseClass)) { this.subTypes[baseClass] = new List(); } this.subTypes[baseClass].Add(typeDefinition); } base.TraverseChildren(typeDefinition); } } } public override ExpressionTraverser MakeExpressionTraverser(Sink sink, StatementTraverser/*?*/ statementTraverser, bool contractContext) { return new WholeProgramExpressionSemantics(this, sink, statementTraverser, contractContext); } /// /// implement virtual method calls to methods defined in the CUA (code under analysis, i.e., /// the set of assemblies being translated) by a "switch statement" that dispatches to the /// most derived type's method. I.e., make explicit the dynamic dispatch mechanism. /// public class WholeProgramExpressionSemantics : CLRSemantics.CLRExpressionSemantics { readonly WholeProgram parent; readonly public Dictionary> subTypes; public WholeProgramExpressionSemantics(WholeProgram parent, Sink sink, StatementTraverser/*?*/ statementTraverser, bool contractContext) : base(sink, statementTraverser, contractContext) { this.parent = parent; this.subTypes = parent.subTypes; } public override void TraverseChildren(IMethodCall methodCall) { var resolvedMethod = Sink.Unspecialize(methodCall.MethodToCall).ResolvedMethod; bool isEventAdd = resolvedMethod.IsSpecialName && resolvedMethod.Name.Value.StartsWith("add_"); bool isEventRemove = resolvedMethod.IsSpecialName && resolvedMethod.Name.Value.StartsWith("remove_"); if (isEventAdd || isEventRemove) { base.TraverseChildren(methodCall); return; } if (!methodCall.IsVirtualCall) { base.TraverseChildren(methodCall); return; } var containingType = methodCall.MethodToCall.ContainingType; List subTypesOfContainingType; if (!this.subTypes.TryGetValue(containingType, out subTypesOfContainingType)) { base.TraverseChildren(methodCall); return; } Contract.Assert(0 < subTypesOfContainingType.Count); Contract.Assert(!methodCall.IsStaticCall); Contract.Assert(!resolvedMethod.IsConstructor); var overrides = FindOverrides(containingType, resolvedMethod); if (0 == overrides.Count) { base.TraverseChildren(methodCall); return; } Bpl.IToken token = methodCall.Token(); List inexpr; List outvars; Bpl.IdentifierExpr thisExpr; Dictionary toBoxed; var proc = TranslateArgumentsAndReturnProcedure(token, methodCall.MethodToCall, resolvedMethod, methodCall.IsStaticCall ? null : methodCall.ThisArgument, methodCall.Arguments, out inexpr, out outvars, out thisExpr, out toBoxed); Bpl.QKeyValue attrib = null; foreach (var a in resolvedMethod.Attributes) { if (TypeHelper.GetTypeName(a.Type).EndsWith("AsyncAttribute")) { attrib = new Bpl.QKeyValue(token, "async", new List(), null); break; } } var elseBranch = new Bpl.StmtListBuilder(); var methodname = proc.Name; Bpl.CallCmd call; if (attrib != null) call = new Bpl.CallCmd(token, methodname, inexpr, outvars, attrib); else call = new Bpl.CallCmd(token, methodname, inexpr, outvars); elseBranch.Add(call); Bpl.IfCmd ifcmd = null; Contract.Assume(1 <= overrides.Count); foreach (var typeMethodPair in overrides) { var t = typeMethodPair.Item1; var m = typeMethodPair.Item2; // guard: is#T($DynamicType(local_variable)) var typeFunction = this.sink.FindOrDefineType(t.ResolvedType); if (typeFunction == null) { // BUGBUG!! This just silently skips the branch that would dispatch to t's implementation of the method! continue; } var funcName = String.Format("is#{0}", typeFunction.Name); var identExpr = Bpl.Expr.Ident(new Bpl.LocalVariable(token, new Bpl.TypedIdent(token, funcName, Bpl.Type.Bool))); var funcCall = new Bpl.FunctionCall(identExpr); var exprs = new Bpl.ExprSeq(this.sink.Heap.DynamicType(inexpr[0])); var guard = new Bpl.NAryExpr(token, funcCall, exprs); var thenBranch = new Bpl.StmtListBuilder(); methodname = TranslationHelper.CreateUniqueMethodName(m); // REVIEW: Shouldn't this be call to FindOrCreateProcedure? if (attrib != null) call = new Bpl.CallCmd(token, methodname, inexpr, outvars, attrib); else call = new Bpl.CallCmd(token, methodname, inexpr, outvars); thenBranch.Add(call); ifcmd = new Bpl.IfCmd(token, guard, thenBranch.Collect(token), null, elseBranch.Collect(token) ); elseBranch = new Bpl.StmtListBuilder(); elseBranch.Add(ifcmd); } if (ifcmd == null) { // BUGBUG: then no override made it into the if-statement. // currently that happens when all types are generic. // Should be able to remove this when that is fixed. base.Traverse(methodCall); return; } this.StmtTraverser.StmtBuilder.Add(ifcmd); return; } /// /// Modifies as side-effect. /// private List> FindOverrides(ITypeReference type, IMethodDefinition resolvedMethod) { Contract.Requires(type != null); Contract.Requires(resolvedMethod != null); var overrides = new List>(); foreach (var subType in this.subTypes[type]) { var overriddenMethod = MemberHelper.GetImplicitlyOverridingDerivedClassMethod(resolvedMethod, subType.ResolvedType); if (overriddenMethod != Dummy.Method) { resolvedMethod = overriddenMethod; } overrides.Add(Tuple.Create(subType, resolvedMethod)); if (this.subTypes.ContainsKey(subType)) { overrides.AddRange(FindOverrides(subType, resolvedMethod)); } } return overrides; } } } }