FindBadConstructs.cpp revision 2a99a7e74a7f215066514fe81d2bfa6639d9eddd
15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// This file defines a bunch of recurring problems in the Chromium C++ code. 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Checks that are implemented: 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// - Constructors/Destructors should not be inlined if they are of a complex 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// class type. 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// - Missing "virtual" keywords on methods that should be virtual. 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// - Non-annotated overriding virtual methods. 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// - Virtual methods with nonempty implementations in their headers. 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// - Classes that derive from base::RefCounted / base::RefCountedThreadSafe 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// should have protected or private destructors. 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "clang/AST/ASTConsumer.h" 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "clang/AST/AST.h" 182a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "clang/AST/Attr.h" 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "clang/AST/CXXInheritance.h" 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "clang/AST/TypeLoc.h" 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "clang/Basic/SourceManager.h" 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "clang/Frontend/CompilerInstance.h" 232a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "clang/Frontend/FrontendPluginRegistry.h" 242a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "clang/Lex/Lexer.h" 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "llvm/Support/raw_ostream.h" 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ChromeClassTester.h" 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)using namespace clang; 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace { 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 332a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)const char kMethodRequiresOverride[] = 342a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) "[chromium-style] Overriding method must be marked with OVERRIDE."; 352a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)const char kMethodRequiresVirtual[] = 362a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) "[chromium-style] Overriding method must have \"virtual\" keyword."; 372a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)const char kNoExplicitDtor[] = 382a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) "[chromium-style] Classes that are ref-counted should have explicit " 392a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) "destructors that are declared protected or private."; 402a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)const char kPublicDtor[] = 412a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) "[chromium-style] Classes that are ref-counted should have " 422a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) "destructors that are declared protected or private."; 432a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)const char kProtectedNonVirtualDtor[] = 442a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) "[chromium-style] Classes that are ref-counted and have non-private " 452a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) "destructors should declare their destructor virtual."; 462a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)const char kNoteInheritance[] = 472a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) "[chromium-style] %0 inherits from %1 here"; 482a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)const char kNoteImplicitDtor[] = 492a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) "[chromium-style] No explicit destructor for %0 defined"; 502a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)const char kNotePublicDtor[] = 512a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) "[chromium-style] Public destructor declared here"; 522a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)const char kNoteProtectedNonVirtualDtor[] = 532a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) "[chromium-style] Protected non-virtual destructor declared here"; 542a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)bool TypeHasNonTrivialDtor(const Type* type) { 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (const CXXRecordDecl* cxx_r = type->getPointeeCXXRecordDecl()) 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return cxx_r->hasTrivialDestructor(); 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return false; 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Returns the underlying Type for |type| by expanding typedefs and removing 632a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// any namespace qualifiers. This is similar to desugaring, except that for 642a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// ElaboratedTypes, desugar will unwrap too much. 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)const Type* UnwrapType(const Type* type) { 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (const ElaboratedType* elaborated = dyn_cast<ElaboratedType>(type)) 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return UnwrapType(elaborated->getNamedType().getTypePtr()); 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (const TypedefType* typedefed = dyn_cast<TypedefType>(type)) 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return UnwrapType(typedefed->desugar().getTypePtr()); 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return type; 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Searches for constructs that we know we don't want in the Chromium code base. 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class FindBadConstructsConsumer : public ChromeClassTester { 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) FindBadConstructsConsumer(CompilerInstance& instance, 772a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool check_base_classes, 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool check_virtuals_in_implementations) 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) : ChromeClassTester(instance), 802a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) check_base_classes_(check_base_classes), 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) check_virtuals_in_implementations_(check_virtuals_in_implementations) { 822a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Register warning/error messages. 832a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) diag_method_requires_override_ = diagnostic().getCustomDiagID( 842a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) getErrorLevel(), kMethodRequiresOverride); 852a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) diag_method_requires_virtual_ = diagnostic().getCustomDiagID( 862a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) getErrorLevel(), kMethodRequiresVirtual); 872a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) diag_no_explicit_dtor_ = diagnostic().getCustomDiagID( 882a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) getErrorLevel(), kNoExplicitDtor); 892a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) diag_public_dtor_ = diagnostic().getCustomDiagID( 902a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) getErrorLevel(), kPublicDtor); 912a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) diag_protected_non_virtual_dtor_ = diagnostic().getCustomDiagID( 922a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) getErrorLevel(), kProtectedNonVirtualDtor); 932a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 942a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Registers notes to make it easier to interpret warnings. 952a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) diag_note_inheritance_ = diagnostic().getCustomDiagID( 962a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) DiagnosticsEngine::Note, kNoteInheritance); 972a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) diag_note_implicit_dtor_ = diagnostic().getCustomDiagID( 982a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) DiagnosticsEngine::Note, kNoteImplicitDtor); 992a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) diag_note_public_dtor_ = diagnostic().getCustomDiagID( 1002a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) DiagnosticsEngine::Note, kNotePublicDtor); 1012a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) diag_note_protected_non_virtual_dtor_ = diagnostic().getCustomDiagID( 1022a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) DiagnosticsEngine::Note, kNoteProtectedNonVirtualDtor); 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void CheckChromeClass(SourceLocation record_location, 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) CXXRecordDecl* record) { 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool implementation_file = InImplementationFile(record_location); 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (!implementation_file) { 1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Only check for "heavy" constructors/destructors in header files; 1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // within implementation files, there is no performance cost. 1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) CheckCtorDtorWeight(record_location, record); 1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (!implementation_file || check_virtuals_in_implementations_) { 1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool warn_on_inline_bodies = !implementation_file; 1175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Check that all virtual methods are marked accordingly with both 1195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // virtual and OVERRIDE. 1205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) CheckVirtualMethods(record_location, record, warn_on_inline_bodies); 1215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1232a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) CheckRefCountedDtors(record_location, record); 1245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 1272a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // The type of problematic ref-counting pattern that was encountered. 1282a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) enum RefcountIssue { 1292a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) None, 1302a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) ImplicitDestructor, 1312a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) PublicDestructor 1322a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) }; 1332a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1342a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool check_base_classes_; 1355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool check_virtuals_in_implementations_; 1365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1372a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) unsigned diag_method_requires_override_; 1382a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) unsigned diag_method_requires_virtual_; 1392a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) unsigned diag_no_explicit_dtor_; 1402a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) unsigned diag_public_dtor_; 1412a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) unsigned diag_protected_non_virtual_dtor_; 1422a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) unsigned diag_note_inheritance_; 1432a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) unsigned diag_note_implicit_dtor_; 1442a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) unsigned diag_note_public_dtor_; 1452a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) unsigned diag_note_protected_non_virtual_dtor_; 1465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Prints errors if the constructor/destructor weight is too heavy. 1485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void CheckCtorDtorWeight(SourceLocation record_location, 1495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) CXXRecordDecl* record) { 1505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // We don't handle anonymous structs. If this record doesn't have a 1515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // name, it's of the form: 1525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 1535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // struct { 1545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // ... 1555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // } name_; 1565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (record->getIdentifier() == NULL) 1575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return; 1585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Count the number of templated base classes as a feature of whether the 1605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // destructor can be inlined. 1615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int templated_base_classes = 0; 1625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) for (CXXRecordDecl::base_class_const_iterator it = record->bases_begin(); 1635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) it != record->bases_end(); ++it) { 1645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (it->getTypeSourceInfo()->getTypeLoc().getTypeLocClass() == 1655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TypeLoc::TemplateSpecialization) { 1665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ++templated_base_classes; 1675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Count the number of trivial and non-trivial member variables. 1715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int trivial_member = 0; 1725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int non_trivial_member = 0; 1735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int templated_non_trivial_member = 0; 1745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) for (RecordDecl::field_iterator it = record->field_begin(); 1755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) it != record->field_end(); ++it) { 1765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) CountType(it->getType().getTypePtr(), 1775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) &trivial_member, 1785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) &non_trivial_member, 1795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) &templated_non_trivial_member); 1805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Check to see if we need to ban inlined/synthesized constructors. Note 1835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // that the cutoffs here are kind of arbitrary. Scores over 10 break. 1845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int dtor_score = 0; 1855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Deriving from a templated base class shouldn't be enough to trigger 1865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the ctor warning, but if you do *anything* else, it should. 1875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 1885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // TODO(erg): This is motivated by templated base classes that don't have 1895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // any data members. Somehow detect when templated base classes have data 1905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // members and treat them differently. 1915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) dtor_score += templated_base_classes * 9; 1925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Instantiating a template is an insta-hit. 1935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) dtor_score += templated_non_trivial_member * 10; 1945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The fourth normal class member should trigger the warning. 1955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) dtor_score += non_trivial_member * 3; 1965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int ctor_score = dtor_score; 1985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // You should be able to have 9 ints before we warn you. 1995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ctor_score += trivial_member; 2005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (ctor_score >= 10) { 2025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (!record->hasUserDeclaredConstructor()) { 2035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) emitWarning(record_location, 2045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) "Complex class/struct needs an explicit out-of-line " 2055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) "constructor."); 2065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } else { 2075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Iterate across all the constructors in this file and yell if we 2085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // find one that tries to be inline. 2095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) for (CXXRecordDecl::ctor_iterator it = record->ctor_begin(); 2105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) it != record->ctor_end(); ++it) { 2115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (it->hasInlineBody()) { 2125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (it->isCopyConstructor() && 2135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) !record->hasUserDeclaredCopyConstructor()) { 2145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) emitWarning(record_location, 2155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) "Complex class/struct needs an explicit out-of-line " 2165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) "copy constructor."); 2175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } else { 2185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) emitWarning(it->getInnerLocStart(), 2195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) "Complex constructor has an inlined body."); 2205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 2215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 2225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 2235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 2245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 2255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The destructor side is equivalent except that we don't check for 2275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // trivial members; 20 ints don't need a destructor. 2285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (dtor_score >= 10 && !record->hasTrivialDestructor()) { 2295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (!record->hasUserDeclaredDestructor()) { 2305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) emitWarning( 2315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) record_location, 2325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) "Complex class/struct needs an explicit out-of-line " 2335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) "destructor."); 2345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } else if (CXXDestructorDecl* dtor = record->getDestructor()) { 2355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (dtor->hasInlineBody()) { 2365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) emitWarning(dtor->getInnerLocStart(), 2375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) "Complex destructor has an inline body."); 2385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 2395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 2405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 2415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 2425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void CheckVirtualMethod(const CXXMethodDecl* method, 2445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool warn_on_inline_bodies) { 2455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (!method->isVirtual()) 2465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return; 2475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (!method->isVirtualAsWritten()) { 2495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) SourceLocation loc = method->getTypeSpecStartLoc(); 2505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (isa<CXXDestructorDecl>(method)) 2515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) loc = method->getInnerLocStart(); 2522a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) SourceManager& manager = instance().getSourceManager(); 2532a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) FullSourceLoc full_loc(loc, manager); 2542a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) SourceLocation spelling_loc = manager.getSpellingLoc(loc); 2552a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) diagnostic().Report(full_loc, diag_method_requires_virtual_) 2562a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) << FixItHint::CreateInsertion(spelling_loc, "virtual "); 2575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 2585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Virtual methods should not have inline definitions beyond "{}". This 2605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // only matters for header files. 2615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (warn_on_inline_bodies && method->hasBody() && 2625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) method->hasInlineBody()) { 2635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (CompoundStmt* cs = dyn_cast<CompoundStmt>(method->getBody())) { 2645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (cs->size()) { 2655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) emitWarning( 2665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) cs->getLBracLoc(), 2675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) "virtual methods with non-empty bodies shouldn't be " 2685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) "declared inline."); 2695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 2705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 2715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 2725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 2735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool InTestingNamespace(const Decl* record) { 2755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return GetNamespace(record).find("testing") != std::string::npos; 2765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 2775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2782a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool IsMethodInBannedOrTestingNamespace(const CXXMethodDecl* method) { 2795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (InBannedNamespace(method)) 2805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return true; 2815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) for (CXXMethodDecl::method_iterator i = method->begin_overridden_methods(); 2825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) i != method->end_overridden_methods(); 2835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ++i) { 2845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const CXXMethodDecl* overridden = *i; 2852a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) if (IsMethodInBannedOrTestingNamespace(overridden) || 2862a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) InTestingNamespace(overridden)) { 2875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return true; 2882a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) } 2895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 2905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return false; 2925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 2935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void CheckOverriddenMethod(const CXXMethodDecl* method) { 2955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (!method->size_overridden_methods() || method->getAttr<OverrideAttr>()) 2965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return; 2975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (isa<CXXDestructorDecl>(method) || method->isPure()) 2995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return; 3005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3012a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) if (IsMethodInBannedOrTestingNamespace(method)) 3025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return; 3035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3042a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) SourceManager& manager = instance().getSourceManager(); 3052a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) SourceRange type_info_range = 3062a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) method->getTypeSourceInfo()->getTypeLoc().getSourceRange(); 3072a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) FullSourceLoc loc(type_info_range.getBegin(), manager); 3082a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 3092a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Build the FixIt insertion point after the end of the method definition, 3102a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // including any const-qualifiers and attributes, and before the opening 3112a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // of the l-curly-brace (if inline) or the semi-color (if a declaration). 3122a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) SourceLocation spelling_end = 3132a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) manager.getSpellingLoc(type_info_range.getEnd()); 3142a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) if (spelling_end.isValid()) { 3152a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) SourceLocation token_end = Lexer::getLocForEndOfToken( 3162a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) spelling_end, 0, manager, LangOptions()); 3172a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) diagnostic().Report(token_end, diag_method_requires_override_) 3182a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) << FixItHint::CreateInsertion(token_end, " OVERRIDE"); 3192a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) } else { 3202a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) diagnostic().Report(loc, diag_method_requires_override_); 3212a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) } 3225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 3235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Makes sure there is a "virtual" keyword on virtual methods. 3255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 3265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Gmock objects trigger these for each MOCK_BLAH() macro used. So we have a 3275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // trick to get around that. If a class has member variables whose types are 3285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // in the "testing" namespace (which is how gmock works behind the scenes), 3295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // there's a really high chance we won't care about these errors 3305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void CheckVirtualMethods(SourceLocation record_location, 3315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) CXXRecordDecl* record, 3325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool warn_on_inline_bodies) { 3335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) for (CXXRecordDecl::field_iterator it = record->field_begin(); 3345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) it != record->field_end(); ++it) { 3355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) CXXRecordDecl* record_type = 3365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) it->getTypeSourceInfo()->getTypeLoc().getTypePtr()-> 3375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) getAsCXXRecordDecl(); 3385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (record_type) { 3395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (InTestingNamespace(record_type)) { 3405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return; 3415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 3425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 3435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 3445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) for (CXXRecordDecl::method_iterator it = record->method_begin(); 3465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) it != record->method_end(); ++it) { 3475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (it->isCopyAssignmentOperator() || isa<CXXConstructorDecl>(*it)) { 3485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Ignore constructors and assignment operators. 3495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } else if (isa<CXXDestructorDecl>(*it) && 3505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) !record->hasUserDeclaredDestructor()) { 3515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Ignore non-user-declared destructors. 3525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } else { 3535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) CheckVirtualMethod(*it, warn_on_inline_bodies); 3545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) CheckOverriddenMethod(*it); 3555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 3565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 3575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 3585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void CountType(const Type* type, 3605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int* trivial_member, 3615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int* non_trivial_member, 3625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int* templated_non_trivial_member) { 3635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) switch (type->getTypeClass()) { 3645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) case Type::Record: { 3655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Simplifying; the whole class isn't trivial if the dtor is, but 3665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // we use this as a signal about complexity. 3675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (TypeHasNonTrivialDtor(type)) 3685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) (*trivial_member)++; 3695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) else 3705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) (*non_trivial_member)++; 3715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) break; 3725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 3735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) case Type::TemplateSpecialization: { 3745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TemplateName name = 3755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) dyn_cast<TemplateSpecializationType>(type)->getTemplateName(); 3765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool whitelisted_template = false; 3775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // HACK: I'm at a loss about how to get the syntax checker to get 3795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // whether a template is exterened or not. For the first pass here, 3805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // just do retarded string comparisons. 3815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (TemplateDecl* decl = name.getAsTemplateDecl()) { 3825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string base_name = decl->getNameAsString(); 3835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (base_name == "basic_string") 3845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) whitelisted_template = true; 3855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 3865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (whitelisted_template) 3885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) (*non_trivial_member)++; 3895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) else 3905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) (*templated_non_trivial_member)++; 3915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) break; 3925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 3935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) case Type::Elaborated: { 3945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) CountType( 3955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) dyn_cast<ElaboratedType>(type)->getNamedType().getTypePtr(), 3965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) trivial_member, non_trivial_member, templated_non_trivial_member); 3975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) break; 3985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 3995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) case Type::Typedef: { 4005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) while (const TypedefType* TT = dyn_cast<TypedefType>(type)) { 4015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) type = TT->getDecl()->getUnderlyingType().getTypePtr(); 4025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 4035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) CountType(type, trivial_member, non_trivial_member, 4045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) templated_non_trivial_member); 4055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) break; 4065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 4075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) default: { 4085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Stupid assumption: anything we see that isn't the above is one of 4095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the 20 integer types. 4105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) (*trivial_member)++; 4115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) break; 4125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 4135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 4145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 4152a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 4162a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Check |record| for issues that are problematic for ref-counted types. 4172a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Note that |record| may not be a ref-counted type, but a base class for 4182a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // a type that is. 4192a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // If there are issues, update |loc| with the SourceLocation of the issue 4202a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // and returns appropriately, or returns None if there are no issues. 4212a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) static RefcountIssue CheckRecordForRefcountIssue( 4222a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const CXXRecordDecl* record, 4232a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) SourceLocation &loc) { 4242a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) if (!record->hasUserDeclaredDestructor()) { 4252a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) loc = record->getLocation(); 4262a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) return ImplicitDestructor; 4272a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) } 4282a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 4292a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) if (CXXDestructorDecl* dtor = record->getDestructor()) { 4302a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) if (dtor->getAccess() == AS_public) { 4312a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) loc = dtor->getInnerLocStart(); 4322a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) return PublicDestructor; 4332a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) } 4342a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) } 4352a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 4362a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) return None; 4372a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) } 4382a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 4392a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Adds either a warning or error, based on the current handling of 4402a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // -Werror. 4412a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) DiagnosticsEngine::Level getErrorLevel() { 4422a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) return diagnostic().getWarningsAsErrors() ? 4432a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) DiagnosticsEngine::Error : DiagnosticsEngine::Warning; 4442a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) } 4452a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 4462a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Returns true if |base| specifies one of the Chromium reference counted 4472a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // classes (base::RefCounted / base::RefCountedThreadSafe). 4482a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) static bool IsRefCountedCallback(const CXXBaseSpecifier* base, 4492a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) CXXBasePath& path, 4502a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) void* user_data) { 4512a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) FindBadConstructsConsumer* self = 4522a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) static_cast<FindBadConstructsConsumer*>(user_data); 4532a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 4542a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const TemplateSpecializationType* base_type = 4552a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) dyn_cast<TemplateSpecializationType>( 4562a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) UnwrapType(base->getType().getTypePtr())); 4572a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) if (!base_type) { 4582a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Base-most definition is not a template, so this cannot derive from 4592a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // base::RefCounted. However, it may still be possible to use with a 4602a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // scoped_refptr<> and support ref-counting, so this is not a perfect 4612a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // guarantee of safety. 4622a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) return false; 4632a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) } 4642a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 4652a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) TemplateName name = base_type->getTemplateName(); 4662a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) if (TemplateDecl* decl = name.getAsTemplateDecl()) { 4672a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) std::string base_name = decl->getNameAsString(); 4682a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 4692a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Check for both base::RefCounted and base::RefCountedThreadSafe. 4702a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) if (base_name.compare(0, 10, "RefCounted") == 0 && 4712a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) self->GetNamespace(decl) == "base") { 4722a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) return true; 4732a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) } 4742a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) } 4752a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 4762a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) return false; 4772a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) } 4782a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 4792a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Returns true if |base| specifies a class that has a public destructor, 4802a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // either explicitly or implicitly. 4812a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) static bool HasPublicDtorCallback(const CXXBaseSpecifier* base, 4822a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) CXXBasePath& path, 4832a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) void* user_data) { 4842a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Only examine paths that have public inheritance, as they are the 4852a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // only ones which will result in the destructor potentially being 4862a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // exposed. This check is largely redundant, as Chromium code should be 4872a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // exclusively using public inheritance. 4882a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) if (path.Access != AS_public) 4892a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) return false; 4902a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 4912a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) CXXRecordDecl* record = dyn_cast<CXXRecordDecl>( 4922a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) base->getType()->getAs<RecordType>()->getDecl()); 4932a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) SourceLocation unused; 4942a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) return None != CheckRecordForRefcountIssue(record, unused); 4952a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) } 4962a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 4972a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Outputs a C++ inheritance chain as a diagnostic aid. 4982a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) void PrintInheritanceChain(const CXXBasePath& path) { 4992a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) for (CXXBasePath::const_iterator it = path.begin(); it != path.end(); 5002a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) ++it) { 5012a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) diagnostic().Report(it->Base->getLocStart(), diag_note_inheritance_) 5022a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) << it->Class << it->Base->getType(); 5032a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) } 5042a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) } 5052a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 5062a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) unsigned DiagnosticForIssue(RefcountIssue issue) { 5072a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) switch (issue) { 5082a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) case ImplicitDestructor: 5092a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) return diag_no_explicit_dtor_; 5102a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) case PublicDestructor: 5112a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) return diag_public_dtor_; 5122a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) case None: 5132a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) assert(false && "Do not call DiagnosticForIssue with issue None"); 5142a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) return 0; 5152a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) } 5162a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) } 5172a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 5182a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Check |record| to determine if it has any problematic refcounting 5192a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // issues and, if so, print them as warnings/errors based on the current 5202a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // value of getErrorLevel(). 5212a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // 5222a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // If |record| is a C++ class, and if it inherits from one of the Chromium 5232a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // ref-counting classes (base::RefCounted / base::RefCountedThreadSafe), 5242a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // ensure that there are no public destructors in the class hierarchy. This 5252a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // is to guard against accidentally stack-allocating a RefCounted class or 5262a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // sticking it in a non-ref-counted container (like scoped_ptr<>). 5272a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) void CheckRefCountedDtors(SourceLocation record_location, 5282a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) CXXRecordDecl* record) { 5292a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Skip anonymous structs. 5302a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) if (record->getIdentifier() == NULL) 5312a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) return; 5322a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 5332a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Determine if the current type is even ref-counted. 5342a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) CXXBasePaths refcounted_path; 5352a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) if (!record->lookupInBases( 5362a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) &FindBadConstructsConsumer::IsRefCountedCallback, this, 5372a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) refcounted_path)) { 5382a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) return; // Class does not derive from a ref-counted base class. 5392a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) } 5402a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 5412a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Easy check: Check to see if the current type is problematic. 5422a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) SourceLocation loc; 5432a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) RefcountIssue issue = CheckRecordForRefcountIssue(record, loc); 5442a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) if (issue != None) { 5452a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) diagnostic().Report(loc, DiagnosticForIssue(issue)); 5462a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) PrintInheritanceChain(refcounted_path.front()); 5472a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) return; 5482a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) } 5492a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) if (CXXDestructorDecl* dtor = 5502a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) refcounted_path.begin()->back().Class->getDestructor()) { 5512a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) if (dtor->getAccess() == AS_protected && 5522a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) !dtor->isVirtual()) { 5532a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) loc = dtor->getInnerLocStart(); 5542a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) diagnostic().Report(loc, diag_protected_non_virtual_dtor_); 5552a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) return; 5562a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) } 5572a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) } 5582a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 5592a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Long check: Check all possible base classes for problematic 5602a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // destructors. This checks for situations involving multiple 5612a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // inheritance, where the ref-counted class may be implementing an 5622a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // interface that has a public or implicit destructor. 5632a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // 5642a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // struct SomeInterface { 5652a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // virtual void DoFoo(); 5662a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // }; 5672a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // 5682a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // struct RefCountedInterface 5692a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // : public base::RefCounted<RefCountedInterface>, 5702a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // public SomeInterface { 5712a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // private: 5722a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // friend class base::Refcounted<RefCountedInterface>; 5732a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // virtual ~RefCountedInterface() {} 5742a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // }; 5752a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // 5762a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // While RefCountedInterface is "safe", in that its destructor is 5772a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // private, it's possible to do the following "unsafe" code: 5782a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // scoped_refptr<RefCountedInterface> some_class( 5792a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // new RefCountedInterface); 5802a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // // Calls SomeInterface::~SomeInterface(), which is unsafe. 5812a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // delete static_cast<SomeInterface*>(some_class.get()); 5822a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) if (!check_base_classes_) 5832a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) return; 5842a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 5852a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Find all public destructors. This will record the class hierarchy 5862a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // that leads to the public destructor in |dtor_paths|. 5872a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) CXXBasePaths dtor_paths; 5882a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) if (!record->lookupInBases( 5892a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) &FindBadConstructsConsumer::HasPublicDtorCallback, this, 5902a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) dtor_paths)) { 5912a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) return; 5922a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) } 5932a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 5942a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) for (CXXBasePaths::const_paths_iterator it = dtor_paths.begin(); 5952a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) it != dtor_paths.end(); ++it) { 5962a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // The record with the problem will always be the last record 5972a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // in the path, since it is the record that stopped the search. 5982a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const CXXRecordDecl* problem_record = dyn_cast<CXXRecordDecl>( 5992a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) it->back().Base->getType()->getAs<RecordType>()->getDecl()); 6002a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 6012a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) issue = CheckRecordForRefcountIssue(problem_record, loc); 6022a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 6032a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) if (issue == ImplicitDestructor) { 6042a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) diagnostic().Report(record_location, diag_no_explicit_dtor_); 6052a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) PrintInheritanceChain(refcounted_path.front()); 6062a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) diagnostic().Report(loc, diag_note_implicit_dtor_) << problem_record; 6072a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) PrintInheritanceChain(*it); 6082a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) } else if (issue == PublicDestructor) { 6092a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) diagnostic().Report(record_location, diag_public_dtor_); 6102a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) PrintInheritanceChain(refcounted_path.front()); 6112a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) diagnostic().Report(loc, diag_note_public_dtor_); 6122a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) PrintInheritanceChain(*it); 6132a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) } 6142a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) } 6152a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) } 6165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 6175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class FindBadConstructsAction : public PluginASTAction { 6195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 6205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) FindBadConstructsAction() 6212a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) : check_base_classes_(false), 6225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) check_virtuals_in_implementations_(true) { 6235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 6245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) protected: 6265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Overridden from PluginASTAction: 6275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ASTConsumer* CreateASTConsumer(CompilerInstance& instance, 6285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) llvm::StringRef ref) { 6295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return new FindBadConstructsConsumer( 6302a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) instance, check_base_classes_, check_virtuals_in_implementations_); 6315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 6325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool ParseArgs(const CompilerInstance& instance, 6345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const std::vector<std::string>& args) { 6355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool parsed = true; 6365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) for (size_t i = 0; i < args.size() && parsed; ++i) { 6382a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) if (args[i] == "skip-virtuals-in-implementations") { 6392a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // TODO(rsleevi): Remove this once http://crbug.com/115047 is fixed. 6405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) check_virtuals_in_implementations_ = false; 6412a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) } else if (args[i] == "check-base-classes") { 6422a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // TODO(rsleevi): Remove this once http://crbug.com/123295 is fixed. 6432a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) check_base_classes_ = true; 6445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } else { 6455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) parsed = false; 6465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) llvm::errs() << "Unknown clang plugin argument: " << args[i] << "\n"; 6475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 6485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 6495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return parsed; 6515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 6525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 6542a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool check_base_classes_; 6555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool check_virtuals_in_implementations_; 6565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 6575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace 6595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)static FrontendPluginRegistry::Add<FindBadConstructsAction> 6615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)X("find-bad-constructs", "Finds bad C++ constructs"); 662