NoReturnFunctionChecker.cpp revision 249423
1283276Sgonzo//=== NoReturnFunctionChecker.cpp -------------------------------*- C++ -*-===// 2283276Sgonzo// 3283276Sgonzo// The LLVM Compiler Infrastructure 4283276Sgonzo// 5283276Sgonzo// This file is distributed under the University of Illinois Open Source 6283276Sgonzo// License. See LICENSE.TXT for details. 7283276Sgonzo// 8283276Sgonzo//===----------------------------------------------------------------------===// 9283276Sgonzo// 10283276Sgonzo// This defines NoReturnFunctionChecker, which evaluates functions that do not 11283276Sgonzo// return to the caller. 12283276Sgonzo// 13283276Sgonzo//===----------------------------------------------------------------------===// 14283276Sgonzo 15283276Sgonzo#include "ClangSACheckers.h" 16283276Sgonzo#include "clang/AST/Attr.h" 17283276Sgonzo#include "clang/StaticAnalyzer/Core/Checker.h" 18283276Sgonzo#include "clang/StaticAnalyzer/Core/CheckerManager.h" 19283276Sgonzo#include "clang/StaticAnalyzer/Core/PathSensitive/CallEvent.h" 20283276Sgonzo#include "clang/StaticAnalyzer/Core/PathSensitive/CheckerContext.h" 21283276Sgonzo#include "llvm/ADT/StringSwitch.h" 22283276Sgonzo#include <cstdarg> 23283276Sgonzo 24283276Sgonzousing namespace clang; 25283276Sgonzousing namespace ento; 26283276Sgonzo 27283276Sgonzonamespace { 28283276Sgonzo 29283276Sgonzoclass NoReturnFunctionChecker : public Checker< check::PostStmt<CallExpr>, 30283276Sgonzo check::PostObjCMessage > { 31283276Sgonzopublic: 32283276Sgonzo void checkPostStmt(const CallExpr *CE, CheckerContext &C) const; 33283276Sgonzo void checkPostObjCMessage(const ObjCMethodCall &msg, CheckerContext &C) const; 34283276Sgonzo}; 35283276Sgonzo 36283276Sgonzo} 37283276Sgonzo 38283276Sgonzovoid NoReturnFunctionChecker::checkPostStmt(const CallExpr *CE, 39283276Sgonzo CheckerContext &C) const { 40283276Sgonzo ProgramStateRef state = C.getState(); 41283276Sgonzo const Expr *Callee = CE->getCallee(); 42283276Sgonzo 43283276Sgonzo bool BuildSinks = getFunctionExtInfo(Callee->getType()).getNoReturn(); 44295655Sskra 45295655Sskra if (!BuildSinks) { 46295655Sskra SVal L = state->getSVal(Callee, C.getLocationContext()); 47295655Sskra const FunctionDecl *FD = L.getAsFunctionDecl(); 48283276Sgonzo if (!FD) 49283276Sgonzo return; 50283276Sgonzo 51283276Sgonzo if (FD->getAttr<AnalyzerNoReturnAttr>() || FD->isNoReturn()) 52283276Sgonzo BuildSinks = true; 53283276Sgonzo else if (const IdentifierInfo *II = FD->getIdentifier()) { 54 // HACK: Some functions are not marked noreturn, and don't return. 55 // Here are a few hardwired ones. If this takes too long, we can 56 // potentially cache these results. 57 BuildSinks 58 = llvm::StringSwitch<bool>(StringRef(II->getName())) 59 .Case("exit", true) 60 .Case("panic", true) 61 .Case("error", true) 62 .Case("Assert", true) 63 // FIXME: This is just a wrapper around throwing an exception. 64 // Eventually inter-procedural analysis should handle this easily. 65 .Case("ziperr", true) 66 .Case("assfail", true) 67 .Case("db_error", true) 68 .Case("__assert", true) 69 .Case("__assert_rtn", true) 70 .Case("__assert_fail", true) 71 .Case("dtrace_assfail", true) 72 .Case("yy_fatal_error", true) 73 .Case("_XCAssertionFailureHandler", true) 74 .Case("_DTAssertionFailureHandler", true) 75 .Case("_TSAssertionFailureHandler", true) 76 .Default(false); 77 } 78 } 79 80 if (BuildSinks) 81 C.generateSink(); 82} 83 84static bool END_WITH_NULL isMultiArgSelector(const Selector *Sel, ...) { 85 va_list argp; 86 va_start(argp, Sel); 87 88 unsigned Slot = 0; 89 const char *Arg; 90 while ((Arg = va_arg(argp, const char *))) { 91 if (!Sel->getNameForSlot(Slot).equals(Arg)) 92 break; // still need to va_end! 93 ++Slot; 94 } 95 96 va_end(argp); 97 98 // We only succeeded if we made it to the end of the argument list. 99 return (Arg == NULL); 100} 101 102void NoReturnFunctionChecker::checkPostObjCMessage(const ObjCMethodCall &Msg, 103 CheckerContext &C) const { 104 // Check if the method is annotated with analyzer_noreturn. 105 if (const ObjCMethodDecl *MD = Msg.getDecl()) { 106 MD = MD->getCanonicalDecl(); 107 if (MD->hasAttr<AnalyzerNoReturnAttr>()) { 108 C.generateSink(); 109 return; 110 } 111 } 112 113 // HACK: This entire check is to handle two messages in the Cocoa frameworks: 114 // -[NSAssertionHandler 115 // handleFailureInMethod:object:file:lineNumber:description:] 116 // -[NSAssertionHandler 117 // handleFailureInFunction:file:lineNumber:description:] 118 // Eventually these should be annotated with __attribute__((noreturn)). 119 // Because ObjC messages use dynamic dispatch, it is not generally safe to 120 // assume certain methods can't return. In cases where it is definitely valid, 121 // see if you can mark the methods noreturn or analyzer_noreturn instead of 122 // adding more explicit checks to this method. 123 124 if (!Msg.isInstanceMessage()) 125 return; 126 127 const ObjCInterfaceDecl *Receiver = Msg.getReceiverInterface(); 128 if (!Receiver) 129 return; 130 if (!Receiver->getIdentifier()->isStr("NSAssertionHandler")) 131 return; 132 133 Selector Sel = Msg.getSelector(); 134 switch (Sel.getNumArgs()) { 135 default: 136 return; 137 case 4: 138 if (!isMultiArgSelector(&Sel, "handleFailureInFunction", "file", 139 "lineNumber", "description", NULL)) 140 return; 141 break; 142 case 5: 143 if (!isMultiArgSelector(&Sel, "handleFailureInMethod", "object", "file", 144 "lineNumber", "description", NULL)) 145 return; 146 break; 147 } 148 149 // If we got here, it's one of the messages we care about. 150 C.generateSink(); 151} 152 153 154void ento::registerNoReturnFunctionChecker(CheckerManager &mgr) { 155 mgr.registerChecker<NoReturnFunctionChecker>(); 156} 157