BlinkGCPlugin: Support overloaded trace() call from template.

tools/clang/blink_gc_plugin/BlinkGCPlugin.cpp

 // Copyright 2014 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 // This clang plugin checks various invariants of the Blink garbage
 // collection infrastructure.
 //
 // Errors are described at:
 // http://www.chromium.org/developers/blink-gc-plugin-errors
 
@@ skipping 347 matching lines @@
       return true;
     }
 
     // A tracing call will have either a |visitor| or a |m_field| argument.
     // A registerWeakMembers call will have a |this| argument.
     if (call->getNumArgs() != 1)
       return true;
     Expr* arg = call->getArg(0);
 
     if (UnresolvedMemberExpr* expr = dyn_cast<UnresolvedMemberExpr>(callee)) {
+      // This could be a trace call of a base class, as explained in the
+      // comments of CheckTraceBaseCall().
+      if (CheckTraceBaseCall(call))
+        return true;
+
       // If we find a call to registerWeakMembers which is unresolved we
       // unsoundly consider all weak members as traced.
       // TODO: Find out how to validate weak member tracing for unresolved call.
       if (expr->getMemberName().getAsString() == kRegisterWeakMembersName) {
         for (RecordInfo::Fields::iterator it = info_->GetFields().begin();
              it != info_->GetFields().end();
              ++it) {
           if (it->second.edge()->IsWeakMember())
             it->second.MarkTraced();
         }
@@ skipping 18 matching lines @@
         delegates_to_traceimpl_ = true;
         return true;
       }
     }
 
     CheckTraceBaseCall(call);
     return true;
   }
 
  private:
-
   CXXRecordDecl* GetDependentTemplatedDecl(CXXDependentScopeMemberExpr* expr) {
     NestedNameSpecifier* qual = expr->getQualifier();
     if (!qual)
       return 0;
 
     const Type* type = qual->getAsType();
     if (!type)
       return 0;
 
     return RecordInfo::GetDependentTemplatedDecl(*type);
@@ skipping 37 matching lines @@
     if (call->getNumArgs() == 2 && fn_name == kTraceName &&
         tmpl->getName() == kTraceIfNeededName) {
       FindFieldVisitor finder;
       finder.TraverseStmt(call->getArg(1));
       if (finder.field())
         FoundField(finder.field());
     }
   }
 
   bool CheckTraceBaseCall(CallExpr* call) {
-    MemberExpr* callee = dyn_cast<MemberExpr>(call->getCallee());
-    if (!callee)
-      return false;
+    // Checks for "Base::trace(visitor)"-like calls.
 
-    FunctionDecl* fn = dyn_cast<FunctionDecl>(callee->getMemberDecl());
-    if (!fn || !Config::IsTraceMethod(fn))
-      return false;
+    // Checking code for these two variables is shared among MemberExpr* case
+    // and UnresolvedMemberCase* case below.
+    //
+    // For example, if we've got "Base::trace(visitor)" as |call|,
+    // callee_record will be "Base", and func_name will be "trace".
+    CXXRecordDecl* callee_record = nullptr;
+    std::string func_name;
+
+    if (MemberExpr* callee = dyn_cast<MemberExpr>(call->getCallee())) {
+      if (!callee->hasQualifier())
+        return false;
+
+      FunctionDecl* trace_decl =
+          dyn_cast<FunctionDecl>(callee->getMemberDecl());
+      if (!trace_decl || !Config::IsTraceMethod(trace_decl))
+        return false;
+
+      const Type* type = callee->getQualifier()->getAsType();
+      if (!type)
+        return false;
+
+      callee_record = type->getAsCXXRecordDecl();
+      func_name = trace_decl->getName();
+    } else if (UnresolvedMemberExpr* callee =
+               dyn_cast<UnresolvedMemberExpr>(call->getCallee())) {
+      // Callee part may become unresolved if the type of the argument
+      // ("visitor") is a template parameter and the called function is
+      // overloaded (i.e. trace(Visitor*) and
+      // trace(InlinedGlobalMarkingVisitor)).
+      //
+      // Here, we try to find a function that looks like trace() from the
+      // candidate overloaded functions, and if we find one, we assume it is
+      // called here.
+
+      CXXMethodDecl* trace_decl = nullptr;
+      for (NamedDecl* named_decl : callee->decls()) {
+        if (CXXMethodDecl* method_decl = dyn_cast<CXXMethodDecl>(named_decl)) {
+          if (Config::IsTraceMethod(method_decl)) {
+            trace_decl = method_decl;
+            break;
+          }
+        }
+      }
+      if (!trace_decl)
+        return false;
+
+      // Check if the passed argument is named "visitor".

[kouhei (in TOK), 2015/02/24 07:46:32]

Nit: Should we document this change in CL desc?

[Yuta Kitamura, 2015/02/24 08:35:58]

Done.

+      if (call->getNumArgs() != 1)
+        return false;
+      DeclRefExpr* arg = dyn_cast<DeclRefExpr>(call->getArg(0));
+      if (!arg || arg->getNameInfo().getAsString() != kVisitorVarName)
+        return false;
+
+      callee_record = trace_decl->getParent();
+      func_name = callee->getMemberName().getAsString();
+    }
 
     if (trace_->getName() == kTraceImplName) {
-      if (fn->getName() != kTraceName)
+      if (func_name != kTraceName)
         return false;
     } else if (trace_->getName() == kTraceAfterDispatchImplName) {
-      if (fn->getName() != kTraceAfterDispatchName)
+      if (func_name != kTraceAfterDispatchName)
         return false;
     } else {
       // Currently, a manually dispatched class cannot have mixin bases (having
       // one would add a vtable which we explicitly check against). This means
       // that we can only make calls to a trace method of the same name. Revisit
       // this if our mixin/vtable assumption changes.
-      if (fn->getName() != trace_->getName())
+      if (func_name != trace_->getName())
         return false;
     }
 
-    CXXRecordDecl* decl = 0;
-    if (callee && callee->hasQualifier()) {
-      if (const Type* type = callee->getQualifier()->getAsType())
-        decl = type->getAsCXXRecordDecl();
-    }
-    if (!decl)
+    if (!callee_record)
+      return false;
+    RecordInfo::Bases::iterator iter = info_->GetBases().find(callee_record);
+    if (iter == info_->GetBases().end())
       return false;
 
-    RecordInfo::Bases::iterator it = info_->GetBases().find(decl);
-    if (it != info_->GetBases().end()) {
-      it->second.MarkTraced();
-    }
-
+    iter->second.MarkTraced();
     return true;
   }
 
   bool CheckTraceFieldCall(CXXMemberCallExpr* call) {
     return CheckTraceFieldCall(call->getMethodDecl()->getNameAsString(),
                                call->getRecordDecl(),
                                call->getArg(0));
   }
 
   bool CheckTraceFieldCall(string name, CXXRecordDecl* callee, Expr* arg) {
@@ skipping 1431 matching lines @@
 
  private:
   BlinkGCPluginOptions options_;
 };
 
 }  // namespace
 
 static FrontendPluginRegistry::Add<BlinkGCPluginAction> X(
     "blink-gc-plugin",
     "Check Blink GC invariants");