From 4ba6283f9c7db4513ca2d9cbde7df3a58ba941f7 Mon Sep 17 00:00:00 2001 From: Ted Kremenek Date: Thu, 27 Mar 2008 22:05:32 +0000 Subject: [PATCH] Expanded NSString checking to check for nil for a few more methods. git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@48898 91177308-0d34-0410-b5e6-96231b3b80d8 --- lib/Analysis/BasicObjCFoundationChecks.cpp | 125 +++++++++++++++------ test/Analysis-Apple/NSString.m | 27 ++++- 2 files changed, 119 insertions(+), 33 deletions(-) diff --git a/lib/Analysis/BasicObjCFoundationChecks.cpp b/lib/Analysis/BasicObjCFoundationChecks.cpp index d158067e56..f6b4224f05 100644 --- a/lib/Analysis/BasicObjCFoundationChecks.cpp +++ b/lib/Analysis/BasicObjCFoundationChecks.cpp @@ -25,6 +25,7 @@ #include "llvm/Support/Compiler.h" #include +#include using namespace clang; @@ -43,7 +44,10 @@ class VISIBILITY_HIDDEN BasicObjCFoundationChecks : public GRSimpleAPICheck { bool isNSString(ObjCInterfaceType* T, const char* suffix); bool AuditNSString(NodeTy* N, ObjCMessageExpr* ME); - void Warn(NodeTy* N, Expr* E, const char *msg); + void Warn(NodeTy* N, Expr* E, const std::string& s); + void WarnNilArg(NodeTy* N, Expr* E); + + bool CheckNilArg(NodeTy* N, unsigned Arg); public: BasicObjCFoundationChecks(ASTContext& ctx, ValueStateManager* vmgr) @@ -67,28 +71,39 @@ clang::CreateBasicObjCFoundationChecks(ASTContext& Ctx, return new BasicObjCFoundationChecks(Ctx, VMgr); } +static ObjCInterfaceType* GetReceiverType(ObjCMessageExpr* ME) { + Expr* Receiver = ME->getReceiver(); + + if (!Receiver) + return NULL; + + assert (Receiver->getType()->isPointerType()); + + const PointerType* T = Receiver->getType()->getAsPointerType(); + + return dyn_cast(T->getPointeeType().getTypePtr()); +} + +static const char* GetReceiverNameType(ObjCMessageExpr* ME) { + ObjCInterfaceType* ReceiverType = GetReceiverType(ME); + return ReceiverType ? ReceiverType->getDecl()->getIdentifier()->getName() + : NULL; +} bool BasicObjCFoundationChecks::Audit(ExplodedNode* N) { ObjCMessageExpr* ME = cast(cast(N->getLocation()).getStmt()); - - Expr* Receiver = ME->getReceiver(); - - if (!Receiver) - return false; - - assert (Receiver->getType()->isPointerType()); - const PointerType* T = Receiver->getType()->getAsPointerType(); - - ObjCInterfaceType* ReceiverType = - dyn_cast(T->getPointeeType().getTypePtr()); + ObjCInterfaceType* ReceiverType = GetReceiverType(ME); if (!ReceiverType) - return false; + return NULL; - const char* name = ReceiverType->getDecl()->getIdentifier()->getName(); + const char* name = ReceiverType->getDecl()->getIdentifier()->getName(); + + if (!name) + return false; if (name[0] != 'N' || name[1] != 'S') return false; @@ -112,11 +127,9 @@ static inline bool isNil(RVal X) { //===----------------------------------------------------------------------===// -void BasicObjCFoundationChecks::Warn(NodeTy* N, - Expr* E, const char *msg) { - +void BasicObjCFoundationChecks::Warn(NodeTy* N, Expr* E, const std::string& s) { Errors.push_back(AnnotatedPath()); - Errors.back().push_back(N, msg, E); + Errors.back().push_back(N, s, E); } void BasicObjCFoundationChecks::ReportResults(Diagnostic& D) { @@ -139,6 +152,34 @@ void BasicObjCFoundationChecks::ReportResults(Diagnostic& D) { } } +void BasicObjCFoundationChecks::WarnNilArg(NodeTy* N, Expr* E) { + + ObjCMessageExpr* ME = + cast(cast(N->getLocation()).getStmt()); + + std::ostringstream os; + + os << "Argument to '" << GetReceiverNameType(ME) << "' method '" + << ME->getSelector().getName() + << "' cannot be nil."; + + Warn(N, E, os.str()); +} + +bool BasicObjCFoundationChecks::CheckNilArg(NodeTy* N, unsigned Arg) { + ObjCMessageExpr* ME = + cast(cast(N->getLocation()).getStmt()); + + Expr * E = ME->getArg(Arg); + + if (isNil(GetRVal(N->getState(), E))) { + WarnNilArg(N, E); + return true; + } + + return false; +} + //===----------------------------------------------------------------------===// // NSString checking. //===----------------------------------------------------------------------===// @@ -164,27 +205,47 @@ bool BasicObjCFoundationChecks::AuditNSString(NodeTy* N, assert (!name.empty()); const char* cstr = &name[0]; unsigned len = name.size(); - - - ValueState* St = N->getState(); - + switch (len) { default: break; case 8: - if (!strcmp(cstr, "compare:")) { - // Check if the compared NSString is nil. - Expr * E = ME->getArg(0); + + if (!strcmp(cstr, "compare:")) + return CheckNilArg(N, 0); + + break; - if (isNil(GetRVal(St, E))) { - Warn(N, E, "Argument to NSString method 'compare:' cannot be nil."); - return false; - } - - break; - } + case 16: + if (!strcmp(cstr, "compare:options:")) + return CheckNilArg(N, 0); break; + + case 22: + if (!strcmp(cstr, "compare:options:range:")) + return CheckNilArg(N, 0); + + break; + + case 23: + + if (!strcmp(cstr, "caseInsensitiveCompare:")) + return CheckNilArg(N, 0); + + break; + + case 29: + if (!strcmp(cstr, "compare:options:range:locale:")) + return CheckNilArg(N, 0); + + break; + + case 37: + if (!strcmp(cstr, "componentsSeparatedByCharactersInSet:")) + return CheckNilArg(N, 0); + + break; } return false; diff --git a/test/Analysis-Apple/NSString.m b/test/Analysis-Apple/NSString.m index d3a8d913ac..d562a2b967 100644 --- a/test/Analysis-Apple/NSString.m +++ b/test/Analysis-Apple/NSString.m @@ -2,8 +2,33 @@ #include #include +#include NSComparisonResult f1(NSString* s) { NSString *aString = nil; - return [s compare:aString]; // expected-warning {{Argument to NSString method 'compare:' cannot be nil.}} + return [s compare:aString]; // expected-warning {{Argument to 'NSString' method 'compare:' cannot be nil.}} +} + +NSComparisonResult f2(NSString* s) { + NSString *aString = nil; + return [s caseInsensitiveCompare:aString]; // expected-warning {{Argument to 'NSString' method 'caseInsensitiveCompare:' cannot be nil.}} +} + +NSComparisonResult f3(NSString* s, NSStringCompareOptions op) { + NSString *aString = nil; + return [s compare:aString options:op]; // expected-warning {{Argument to 'NSString' method 'compare:options:' cannot be nil.}} +} + +NSComparisonResult f4(NSString* s, NSStringCompareOptions op, NSRange R) { + NSString *aString = nil; + return [s compare:aString options:op range:R]; // expected-warning {{Argument to 'NSString' method 'compare:options:range:' cannot be nil.}} +} + +NSComparisonResult f5(NSString* s, NSStringCompareOptions op, NSRange R) { + NSString *aString = nil; + return [s compare:aString options:op range:R locale:nil]; // expected-warning {{Argument to 'NSString' method 'compare:options:range:locale:' cannot be nil.}} +} + +NSComparisonResult f6(NSString* s) { + return [s componentsSeparatedByCharactersInSet:nil]; // expected-warning {{Argument to 'NSString' method 'componentsSeparatedByCharactersInSet:' cannot be nil.}} }