Ted Kremenek | 0d8019e | 2008-07-11 22:40:47 +0000 | [diff] [blame] | 1 | //=- CheckObjCInstMethodRetTy.cpp - Check ObjC method signatures -*- C++ -*-==// |
| 2 | // |
| 3 | // The LLVM Compiler Infrastructure |
| 4 | // |
| 5 | // This file is distributed under the University of Illinois Open Source |
| 6 | // License. See LICENSE.TXT for details. |
| 7 | // |
| 8 | //===----------------------------------------------------------------------===// |
| 9 | // |
| 10 | // This file defines a CheckObjCInstMethSignature, a flow-insenstive check |
| 11 | // that determines if an Objective-C class interface incorrectly redefines |
| 12 | // the method signature in a subclass. |
| 13 | // |
| 14 | //===----------------------------------------------------------------------===// |
| 15 | |
Argyrios Kyrtzidis | 7dd445e | 2011-02-17 21:39:33 +0000 | [diff] [blame] | 16 | #include "ClangSACheckers.h" |
Chandler Carruth | 55fc873 | 2012-12-04 09:13:33 +0000 | [diff] [blame] | 17 | #include "clang/AST/ASTContext.h" |
Ted Kremenek | 0d8019e | 2008-07-11 22:40:47 +0000 | [diff] [blame] | 18 | #include "clang/AST/DeclObjC.h" |
| 19 | #include "clang/AST/Type.h" |
Chandler Carruth | 55fc873 | 2012-12-04 09:13:33 +0000 | [diff] [blame] | 20 | #include "clang/StaticAnalyzer/Core/BugReporter/BugReporter.h" |
| 21 | #include "clang/StaticAnalyzer/Core/BugReporter/PathDiagnostic.h" |
| 22 | #include "clang/StaticAnalyzer/Core/Checker.h" |
Ted Kremenek | 0d8019e | 2008-07-11 22:40:47 +0000 | [diff] [blame] | 23 | #include "llvm/ADT/DenseMap.h" |
Ted Kremenek | 13493ea | 2009-04-02 02:44:03 +0000 | [diff] [blame] | 24 | #include "llvm/Support/raw_ostream.h" |
Ted Kremenek | 0d8019e | 2008-07-11 22:40:47 +0000 | [diff] [blame] | 25 | |
| 26 | using namespace clang; |
Ted Kremenek | 9ef6537 | 2010-12-23 07:20:52 +0000 | [diff] [blame] | 27 | using namespace ento; |
Ted Kremenek | 0d8019e | 2008-07-11 22:40:47 +0000 | [diff] [blame] | 28 | |
| 29 | static bool AreTypesCompatible(QualType Derived, QualType Ancestor, |
Ted Kremenek | 9c378f7 | 2011-08-12 23:37:29 +0000 | [diff] [blame] | 30 | ASTContext &C) { |
Ted Kremenek | 0d8019e | 2008-07-11 22:40:47 +0000 | [diff] [blame] | 31 | |
| 32 | // Right now don't compare the compatibility of pointers. That involves |
| 33 | // looking at subtyping relationships. FIXME: Future patch. |
Steve Naroff | 58f9f2c | 2009-07-14 18:25:06 +0000 | [diff] [blame] | 34 | if (Derived->isAnyPointerType() && Ancestor->isAnyPointerType()) |
Ted Kremenek | 0d8019e | 2008-07-11 22:40:47 +0000 | [diff] [blame] | 35 | return true; |
| 36 | |
| 37 | return C.typesAreCompatible(Derived, Ancestor); |
| 38 | } |
| 39 | |
Ted Kremenek | 2376002 | 2009-08-21 23:58:43 +0000 | [diff] [blame] | 40 | static void CompareReturnTypes(const ObjCMethodDecl *MethDerived, |
| 41 | const ObjCMethodDecl *MethAncestor, |
| 42 | BugReporter &BR, ASTContext &Ctx, |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 43 | const ObjCImplementationDecl *ID, |
| 44 | const CheckerBase *Checker) { |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 45 | |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 46 | QualType ResDerived = MethDerived->getReturnType(); |
| 47 | QualType ResAncestor = MethAncestor->getReturnType(); |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 48 | |
Ted Kremenek | 0d8019e | 2008-07-11 22:40:47 +0000 | [diff] [blame] | 49 | if (!AreTypesCompatible(ResDerived, ResAncestor, Ctx)) { |
Ted Kremenek | 13493ea | 2009-04-02 02:44:03 +0000 | [diff] [blame] | 50 | std::string sbuf; |
| 51 | llvm::raw_string_ostream os(sbuf); |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 52 | |
Ted Kremenek | 0d8019e | 2008-07-11 22:40:47 +0000 | [diff] [blame] | 53 | os << "The Objective-C class '" |
Benjamin Kramer | b8989f2 | 2011-10-14 18:45:37 +0000 | [diff] [blame] | 54 | << *MethDerived->getClassInterface() |
Ted Kremenek | 0d8019e | 2008-07-11 22:40:47 +0000 | [diff] [blame] | 55 | << "', which is derived from class '" |
Benjamin Kramer | b8989f2 | 2011-10-14 18:45:37 +0000 | [diff] [blame] | 56 | << *MethAncestor->getClassInterface() |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 57 | << "', defines the instance method '"; |
| 58 | MethDerived->getSelector().print(os); |
| 59 | os << "' whose return type is '" |
Ted Kremenek | 0d8019e | 2008-07-11 22:40:47 +0000 | [diff] [blame] | 60 | << ResDerived.getAsString() |
Ted Kremenek | e4773eb | 2008-07-11 23:17:01 +0000 | [diff] [blame] | 61 | << "'. A method with the same name (same selector) is also defined in " |
| 62 | "class '" |
Benjamin Kramer | b8989f2 | 2011-10-14 18:45:37 +0000 | [diff] [blame] | 63 | << *MethAncestor->getClassInterface() |
Ted Kremenek | e4773eb | 2008-07-11 23:17:01 +0000 | [diff] [blame] | 64 | << "' and has a return type of '" |
Ted Kremenek | 0d8019e | 2008-07-11 22:40:47 +0000 | [diff] [blame] | 65 | << ResAncestor.getAsString() |
| 66 | << "'. These two types are incompatible, and may result in undefined " |
| 67 | "behavior for clients of these classes."; |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 68 | |
Anna Zaks | 590dd8e | 2011-09-20 21:38:35 +0000 | [diff] [blame] | 69 | PathDiagnosticLocation MethDLoc = |
| 70 | PathDiagnosticLocation::createBegin(MethDerived, |
| 71 | BR.getSourceManager()); |
| 72 | |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 73 | BR.EmitBasicReport( |
| 74 | MethDerived, Checker, "Incompatible instance method return type", |
| 75 | categories::CoreFoundationObjectiveC, os.str(), MethDLoc); |
Ted Kremenek | 0d8019e | 2008-07-11 22:40:47 +0000 | [diff] [blame] | 76 | } |
| 77 | } |
| 78 | |
Ted Kremenek | 9c378f7 | 2011-08-12 23:37:29 +0000 | [diff] [blame] | 79 | static void CheckObjCInstMethSignature(const ObjCImplementationDecl *ID, |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 80 | BugReporter &BR, |
| 81 | const CheckerBase *Checker) { |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 82 | |
Ted Kremenek | 9c378f7 | 2011-08-12 23:37:29 +0000 | [diff] [blame] | 83 | const ObjCInterfaceDecl *D = ID->getClassInterface(); |
| 84 | const ObjCInterfaceDecl *C = D->getSuperClass(); |
Ted Kremenek | 0d8019e | 2008-07-11 22:40:47 +0000 | [diff] [blame] | 85 | |
| 86 | if (!C) |
| 87 | return; |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 88 | |
Ted Kremenek | 9c378f7 | 2011-08-12 23:37:29 +0000 | [diff] [blame] | 89 | ASTContext &Ctx = BR.getContext(); |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 90 | |
Ted Kremenek | 0d8019e | 2008-07-11 22:40:47 +0000 | [diff] [blame] | 91 | // Build a DenseMap of the methods for quick querying. |
| 92 | typedef llvm::DenseMap<Selector,ObjCMethodDecl*> MapTy; |
| 93 | MapTy IMeths; |
| 94 | unsigned NumMethods = 0; |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 95 | |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 96 | for (auto *M : ID->instance_methods()) { |
Ted Kremenek | 0d8019e | 2008-07-11 22:40:47 +0000 | [diff] [blame] | 97 | IMeths[M->getSelector()] = M; |
| 98 | ++NumMethods; |
| 99 | } |
| 100 | |
| 101 | // Now recurse the class hierarchy chain looking for methods with the |
| 102 | // same signatures. |
Ted Kremenek | 0d8019e | 2008-07-11 22:40:47 +0000 | [diff] [blame] | 103 | while (C && NumMethods) { |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 104 | for (const auto *M : C->instance_methods()) { |
Ted Kremenek | 0d8019e | 2008-07-11 22:40:47 +0000 | [diff] [blame] | 105 | Selector S = M->getSelector(); |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 106 | |
Ted Kremenek | 0d8019e | 2008-07-11 22:40:47 +0000 | [diff] [blame] | 107 | MapTy::iterator MI = IMeths.find(S); |
| 108 | |
Stephen Hines | 6bcf27b | 2014-05-29 04:14:42 -0700 | [diff] [blame^] | 109 | if (MI == IMeths.end() || MI->second == nullptr) |
Ted Kremenek | 0d8019e | 2008-07-11 22:40:47 +0000 | [diff] [blame] | 110 | continue; |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 111 | |
Ted Kremenek | 0d8019e | 2008-07-11 22:40:47 +0000 | [diff] [blame] | 112 | --NumMethods; |
Ted Kremenek | 9c378f7 | 2011-08-12 23:37:29 +0000 | [diff] [blame] | 113 | ObjCMethodDecl *MethDerived = MI->second; |
Stephen Hines | 6bcf27b | 2014-05-29 04:14:42 -0700 | [diff] [blame^] | 114 | MI->second = nullptr; |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 115 | |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 116 | CompareReturnTypes(MethDerived, M, BR, Ctx, ID, Checker); |
Ted Kremenek | 0d8019e | 2008-07-11 22:40:47 +0000 | [diff] [blame] | 117 | } |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 118 | |
Ted Kremenek | 0d8019e | 2008-07-11 22:40:47 +0000 | [diff] [blame] | 119 | C = C->getSuperClass(); |
| 120 | } |
| 121 | } |
Argyrios Kyrtzidis | 7dd445e | 2011-02-17 21:39:33 +0000 | [diff] [blame] | 122 | |
| 123 | //===----------------------------------------------------------------------===// |
| 124 | // ObjCMethSigsChecker |
| 125 | //===----------------------------------------------------------------------===// |
| 126 | |
| 127 | namespace { |
Argyrios Kyrtzidis | ec8605f | 2011-03-01 01:16:21 +0000 | [diff] [blame] | 128 | class ObjCMethSigsChecker : public Checker< |
Argyrios Kyrtzidis | 7dd445e | 2011-02-17 21:39:33 +0000 | [diff] [blame] | 129 | check::ASTDecl<ObjCImplementationDecl> > { |
| 130 | public: |
| 131 | void checkASTDecl(const ObjCImplementationDecl *D, AnalysisManager& mgr, |
| 132 | BugReporter &BR) const { |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 133 | CheckObjCInstMethSignature(D, BR, this); |
Argyrios Kyrtzidis | 7dd445e | 2011-02-17 21:39:33 +0000 | [diff] [blame] | 134 | } |
| 135 | }; |
| 136 | } |
| 137 | |
| 138 | void ento::registerObjCMethSigsChecker(CheckerManager &mgr) { |
| 139 | mgr.registerChecker<ObjCMethSigsChecker>(); |
| 140 | } |