ExprEngineCallAndReturn.cpp revision fbcb3f11fc90e9f00e6074e9b118b8dc11ca604c
1//=-- ExprEngineCallAndReturn.cpp - Support for call/return -----*- 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 ExprEngine's support for calls and returns. 11// 12//===----------------------------------------------------------------------===// 13 14#define DEBUG_TYPE "ExprEngine" 15 16#include "clang/Analysis/Analyses/LiveVariables.h" 17#include "clang/StaticAnalyzer/Core/CheckerManager.h" 18#include "clang/StaticAnalyzer/Core/PathSensitive/ExprEngine.h" 19#include "clang/StaticAnalyzer/Core/PathSensitive/CallEvent.h" 20#include "clang/AST/DeclCXX.h" 21#include "clang/AST/ParentMap.h" 22#include "llvm/ADT/SmallSet.h" 23#include "llvm/ADT/Statistic.h" 24#include "llvm/Support/SaveAndRestore.h" 25 26using namespace clang; 27using namespace ento; 28 29STATISTIC(NumOfDynamicDispatchPathSplits, 30 "The # of times we split the path due to imprecise dynamic dispatch info"); 31 32STATISTIC(NumInlinedCalls, 33 "The # of times we inlined a call"); 34 35void ExprEngine::processCallEnter(CallEnter CE, ExplodedNode *Pred) { 36 // Get the entry block in the CFG of the callee. 37 const StackFrameContext *calleeCtx = CE.getCalleeContext(); 38 const CFG *CalleeCFG = calleeCtx->getCFG(); 39 const CFGBlock *Entry = &(CalleeCFG->getEntry()); 40 41 // Validate the CFG. 42 assert(Entry->empty()); 43 assert(Entry->succ_size() == 1); 44 45 // Get the solitary sucessor. 46 const CFGBlock *Succ = *(Entry->succ_begin()); 47 48 // Construct an edge representing the starting location in the callee. 49 BlockEdge Loc(Entry, Succ, calleeCtx); 50 51 ProgramStateRef state = Pred->getState(); 52 53 // Construct a new node and add it to the worklist. 54 bool isNew; 55 ExplodedNode *Node = G.getNode(Loc, state, false, &isNew); 56 Node->addPredecessor(Pred, G); 57 if (isNew) 58 Engine.getWorkList()->enqueue(Node); 59} 60 61// Find the last statement on the path to the exploded node and the 62// corresponding Block. 63static std::pair<const Stmt*, 64 const CFGBlock*> getLastStmt(const ExplodedNode *Node) { 65 const Stmt *S = 0; 66 const StackFrameContext *SF = 67 Node->getLocation().getLocationContext()->getCurrentStackFrame(); 68 69 // Back up through the ExplodedGraph until we reach a statement node in this 70 // stack frame. 71 while (Node) { 72 const ProgramPoint &PP = Node->getLocation(); 73 74 if (PP.getLocationContext()->getCurrentStackFrame() == SF) { 75 if (const StmtPoint *SP = dyn_cast<StmtPoint>(&PP)) { 76 S = SP->getStmt(); 77 break; 78 } else if (const CallExitEnd *CEE = dyn_cast<CallExitEnd>(&PP)) { 79 S = CEE->getCalleeContext()->getCallSite(); 80 if (S) 81 break; 82 83 // If there is no statement, this is an implicitly-generated call. 84 // We'll walk backwards over it and then continue the loop to find 85 // an actual statement. 86 const CallEnter *CE; 87 do { 88 Node = Node->getFirstPred(); 89 CE = Node->getLocationAs<CallEnter>(); 90 } while (!CE || CE->getCalleeContext() != CEE->getCalleeContext()); 91 92 // Continue searching the graph. 93 } 94 } else if (const CallEnter *CE = dyn_cast<CallEnter>(&PP)) { 95 // If we reached the CallEnter for this function, it has no statements. 96 if (CE->getCalleeContext() == SF) 97 break; 98 } 99 100 Node = *Node->pred_begin(); 101 } 102 103 const CFGBlock *Blk = 0; 104 if (S) { 105 // Now, get the enclosing basic block. 106 while (Node && Node->pred_size() >=1 ) { 107 const ProgramPoint &PP = Node->getLocation(); 108 if (isa<BlockEdge>(PP) && 109 (PP.getLocationContext()->getCurrentStackFrame() == SF)) { 110 BlockEdge &EPP = cast<BlockEdge>(PP); 111 Blk = EPP.getDst(); 112 break; 113 } 114 Node = *Node->pred_begin(); 115 } 116 } 117 118 return std::pair<const Stmt*, const CFGBlock*>(S, Blk); 119} 120 121/// The call exit is simulated with a sequence of nodes, which occur between 122/// CallExitBegin and CallExitEnd. The following operations occur between the 123/// two program points: 124/// 1. CallExitBegin (triggers the start of call exit sequence) 125/// 2. Bind the return value 126/// 3. Run Remove dead bindings to clean up the dead symbols from the callee. 127/// 4. CallExitEnd (switch to the caller context) 128/// 5. PostStmt<CallExpr> 129void ExprEngine::processCallExit(ExplodedNode *CEBNode) { 130 // Step 1 CEBNode was generated before the call. 131 132 const StackFrameContext *calleeCtx = 133 CEBNode->getLocationContext()->getCurrentStackFrame(); 134 135 // The parent context might not be a stack frame, so make sure we 136 // look up the first enclosing stack frame. 137 const StackFrameContext *callerCtx = 138 calleeCtx->getParent()->getCurrentStackFrame(); 139 140 const Stmt *CE = calleeCtx->getCallSite(); 141 ProgramStateRef state = CEBNode->getState(); 142 // Find the last statement in the function and the corresponding basic block. 143 const Stmt *LastSt = 0; 144 const CFGBlock *Blk = 0; 145 llvm::tie(LastSt, Blk) = getLastStmt(CEBNode); 146 147 // Step 2: generate node with bound return value: CEBNode -> BindedRetNode. 148 149 // If the callee returns an expression, bind its value to CallExpr. 150 if (CE) { 151 if (const ReturnStmt *RS = dyn_cast_or_null<ReturnStmt>(LastSt)) { 152 const LocationContext *LCtx = CEBNode->getLocationContext(); 153 SVal V = state->getSVal(RS, LCtx); 154 state = state->BindExpr(CE, callerCtx, V); 155 } 156 157 // Bind the constructed object value to CXXConstructExpr. 158 if (const CXXConstructExpr *CCE = dyn_cast<CXXConstructExpr>(CE)) { 159 loc::MemRegionVal This = 160 svalBuilder.getCXXThis(CCE->getConstructor()->getParent(), calleeCtx); 161 SVal ThisV = state->getSVal(This); 162 163 // Always bind the region to the CXXConstructExpr. 164 state = state->BindExpr(CCE, callerCtx, ThisV); 165 } 166 } 167 168 // Generate a CallEvent /before/ cleaning the state, so that we can get the 169 // correct value for 'this' (if necessary). 170 CallEventManager &CEMgr = getStateManager().getCallEventManager(); 171 CallEventRef<> Call = CEMgr.getCaller(calleeCtx, state); 172 173 // Step 3: BindedRetNode -> CleanedNodes 174 // If we can find a statement and a block in the inlined function, run remove 175 // dead bindings before returning from the call. This is important to ensure 176 // that we report the issues such as leaks in the stack contexts in which 177 // they occurred. 178 ExplodedNodeSet CleanedNodes; 179 if (LastSt && Blk && AMgr.options.AnalysisPurgeOpt != PurgeNone) { 180 static SimpleProgramPointTag retValBind("ExprEngine : Bind Return Value"); 181 PostStmt Loc(LastSt, calleeCtx, &retValBind); 182 bool isNew; 183 ExplodedNode *BindedRetNode = G.getNode(Loc, state, false, &isNew); 184 BindedRetNode->addPredecessor(CEBNode, G); 185 if (!isNew) 186 return; 187 188 NodeBuilderContext Ctx(getCoreEngine(), Blk, BindedRetNode); 189 currBldrCtx = &Ctx; 190 // Here, we call the Symbol Reaper with 0 statement and caller location 191 // context, telling it to clean up everything in the callee's context 192 // (and it's children). We use LastStmt as a diagnostic statement, which 193 // which the PreStmtPurge Dead point will be associated. 194 removeDead(BindedRetNode, CleanedNodes, 0, callerCtx, LastSt, 195 ProgramPoint::PostStmtPurgeDeadSymbolsKind); 196 currBldrCtx = 0; 197 } else { 198 CleanedNodes.Add(CEBNode); 199 } 200 201 for (ExplodedNodeSet::iterator I = CleanedNodes.begin(), 202 E = CleanedNodes.end(); I != E; ++I) { 203 204 // Step 4: Generate the CallExit and leave the callee's context. 205 // CleanedNodes -> CEENode 206 CallExitEnd Loc(calleeCtx, callerCtx); 207 bool isNew; 208 ProgramStateRef CEEState = (*I == CEBNode) ? state : (*I)->getState(); 209 ExplodedNode *CEENode = G.getNode(Loc, CEEState, false, &isNew); 210 CEENode->addPredecessor(*I, G); 211 if (!isNew) 212 return; 213 214 // Step 5: Perform the post-condition check of the CallExpr and enqueue the 215 // result onto the work list. 216 // CEENode -> Dst -> WorkList 217 NodeBuilderContext Ctx(Engine, calleeCtx->getCallSiteBlock(), CEENode); 218 SaveAndRestore<const NodeBuilderContext*> NBCSave(currBldrCtx, 219 &Ctx); 220 SaveAndRestore<unsigned> CBISave(currStmtIdx, calleeCtx->getIndex()); 221 222 CallEventRef<> UpdatedCall = Call.cloneWithState(CEEState); 223 224 ExplodedNodeSet DstPostCall; 225 getCheckerManager().runCheckersForPostCall(DstPostCall, CEENode, 226 *UpdatedCall, *this, 227 /*WasInlined=*/true); 228 229 ExplodedNodeSet Dst; 230 if (const ObjCMethodCall *Msg = dyn_cast<ObjCMethodCall>(Call)) { 231 getCheckerManager().runCheckersForPostObjCMessage(Dst, DstPostCall, *Msg, 232 *this, 233 /*WasInlined=*/true); 234 } else if (CE) { 235 getCheckerManager().runCheckersForPostStmt(Dst, DstPostCall, CE, 236 *this, /*WasInlined=*/true); 237 } else { 238 Dst.insert(DstPostCall); 239 } 240 241 // Enqueue the next element in the block. 242 for (ExplodedNodeSet::iterator PSI = Dst.begin(), PSE = Dst.end(); 243 PSI != PSE; ++PSI) { 244 Engine.getWorkList()->enqueue(*PSI, calleeCtx->getCallSiteBlock(), 245 calleeCtx->getIndex()+1); 246 } 247 } 248} 249 250static unsigned getNumberStackFrames(const LocationContext *LCtx) { 251 unsigned count = 0; 252 while (LCtx) { 253 if (isa<StackFrameContext>(LCtx)) 254 ++count; 255 LCtx = LCtx->getParent(); 256 } 257 return count; 258} 259 260// Determine if we should inline the call. 261bool ExprEngine::shouldInlineDecl(const Decl *D, ExplodedNode *Pred) { 262 AnalysisDeclContext *CalleeADC = AMgr.getAnalysisDeclContext(D); 263 const CFG *CalleeCFG = CalleeADC->getCFG(); 264 265 // It is possible that the CFG cannot be constructed. 266 // Be safe, and check if the CalleeCFG is valid. 267 if (!CalleeCFG) 268 return false; 269 270 if (getNumberStackFrames(Pred->getLocationContext()) 271 == AMgr.options.InlineMaxStackDepth) 272 return false; 273 274 if (Engine.FunctionSummaries->hasReachedMaxBlockCount(D)) 275 return false; 276 277 if (CalleeCFG->getNumBlockIDs() > AMgr.options.InlineMaxFunctionSize) 278 return false; 279 280 // Do not inline variadic calls (for now). 281 if (const BlockDecl *BD = dyn_cast<BlockDecl>(D)) { 282 if (BD->isVariadic()) 283 return false; 284 } 285 else if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) { 286 if (FD->isVariadic()) 287 return false; 288 } 289 290 // It is possible that the live variables analysis cannot be 291 // run. If so, bail out. 292 if (!CalleeADC->getAnalysis<RelaxedLiveVariables>()) 293 return false; 294 295 return true; 296} 297 298/// The GDM component containing the dynamic dispatch bifurcation info. When 299/// the exact type of the receiver is not known, we want to explore both paths - 300/// one on which we do inline it and the other one on which we don't. This is 301/// done to ensure we do not drop coverage. 302/// This is the map from the receiver region to a bool, specifying either we 303/// consider this region's information precise or not along the given path. 304namespace clang { 305namespace ento { 306enum DynamicDispatchMode { DynamicDispatchModeInlined = 1, 307 DynamicDispatchModeConservative }; 308 309struct DynamicDispatchBifurcationMap {}; 310typedef llvm::ImmutableMap<const MemRegion*, 311 unsigned int> DynamicDispatchBifur; 312template<> struct ProgramStateTrait<DynamicDispatchBifurcationMap> 313 : public ProgramStatePartialTrait<DynamicDispatchBifur> { 314 static void *GDMIndex() { static int index; return &index; } 315}; 316 317}} 318 319static bool shouldInlineCXX(AnalysisManager &AMgr) { 320 switch (AMgr.options.IPAMode) { 321 case None: 322 case BasicInlining: 323 return false; 324 case Inlining: 325 case DynamicDispatch: 326 case DynamicDispatchBifurcate: 327 return true; 328 case NumIPAModes: 329 llvm_unreachable("not actually a valid option"); 330 } 331 llvm_unreachable("bogus IPAMode"); 332} 333 334bool ExprEngine::inlineCall(const CallEvent &Call, const Decl *D, 335 NodeBuilder &Bldr, ExplodedNode *Pred, 336 ProgramStateRef State) { 337 assert(D); 338 339 const LocationContext *CurLC = Pred->getLocationContext(); 340 const StackFrameContext *CallerSFC = CurLC->getCurrentStackFrame(); 341 const LocationContext *ParentOfCallee = 0; 342 343 // FIXME: Refactor this check into a hypothetical CallEvent::canInline. 344 switch (Call.getKind()) { 345 case CE_Function: 346 break; 347 case CE_CXXMember: 348 case CE_CXXMemberOperator: 349 if (!shouldInlineCXX(getAnalysisManager())) 350 return false; 351 break; 352 case CE_CXXConstructor: { 353 if (!shouldInlineCXX(getAnalysisManager())) 354 return false; 355 356 const CXXConstructorCall &Ctor = cast<CXXConstructorCall>(Call); 357 358 // FIXME: We don't handle constructors or destructors for arrays properly. 359 const MemRegion *Target = Ctor.getCXXThisVal().getAsRegion(); 360 if (Target && isa<ElementRegion>(Target)) 361 return false; 362 363 // FIXME: This is a hack. We don't use the correct region for a new 364 // expression, so if we inline the constructor its result will just be 365 // thrown away. This short-term hack is tracked in <rdar://problem/12180598> 366 // and the longer-term possible fix is discussed in PR12014. 367 const CXXConstructExpr *CtorExpr = Ctor.getOriginExpr(); 368 if (const Stmt *Parent = CurLC->getParentMap().getParent(CtorExpr)) 369 if (isa<CXXNewExpr>(Parent)) 370 return false; 371 372 // If the destructor is trivial, it's always safe to inline the constructor. 373 if (Ctor.getDecl()->getParent()->hasTrivialDestructor()) 374 break; 375 376 // For other types, only inline constructors if we built the CFGs for the 377 // destructor properly. 378 const AnalysisDeclContext *ADC = CallerSFC->getAnalysisDeclContext(); 379 assert(ADC->getCFGBuildOptions().AddInitializers && "No CFG initializers"); 380 if (!ADC->getCFGBuildOptions().AddImplicitDtors) 381 return false; 382 383 // FIXME: This is a hack. We don't handle temporary destructors 384 // right now, so we shouldn't inline their constructors. 385 if (CtorExpr->getConstructionKind() == CXXConstructExpr::CK_Complete) 386 if (!Target || !isa<DeclRegion>(Target)) 387 return false; 388 389 break; 390 } 391 case CE_CXXDestructor: { 392 if (!shouldInlineCXX(getAnalysisManager())) 393 return false; 394 395 // Only inline constructors and destructors if we built the CFGs for them 396 // properly. 397 const AnalysisDeclContext *ADC = CallerSFC->getAnalysisDeclContext(); 398 if (!ADC->getCFGBuildOptions().AddImplicitDtors) 399 return false; 400 401 const CXXDestructorCall &Dtor = cast<CXXDestructorCall>(Call); 402 403 // FIXME: We don't handle constructors or destructors for arrays properly. 404 const MemRegion *Target = Dtor.getCXXThisVal().getAsRegion(); 405 if (Target && isa<ElementRegion>(Target)) 406 return false; 407 408 break; 409 } 410 case CE_CXXAllocator: 411 if (!shouldInlineCXX(getAnalysisManager())) 412 return false; 413 414 // Do not inline allocators until we model deallocators. 415 // This is unfortunate, but basically necessary for smart pointers and such. 416 return false; 417 case CE_Block: { 418 const BlockDataRegion *BR = cast<BlockCall>(Call).getBlockRegion(); 419 assert(BR && "If we have the block definition we should have its region"); 420 AnalysisDeclContext *BlockCtx = AMgr.getAnalysisDeclContext(D); 421 ParentOfCallee = BlockCtx->getBlockInvocationContext(CallerSFC, 422 cast<BlockDecl>(D), 423 BR); 424 break; 425 } 426 case CE_ObjCMessage: 427 if (!(getAnalysisManager().options.IPAMode == DynamicDispatch || 428 getAnalysisManager().options.IPAMode == DynamicDispatchBifurcate)) 429 return false; 430 break; 431 } 432 433 if (!shouldInlineDecl(D, Pred)) 434 return false; 435 436 if (!ParentOfCallee) 437 ParentOfCallee = CallerSFC; 438 439 // This may be NULL, but that's fine. 440 const Expr *CallE = Call.getOriginExpr(); 441 442 // Construct a new stack frame for the callee. 443 AnalysisDeclContext *CalleeADC = AMgr.getAnalysisDeclContext(D); 444 const StackFrameContext *CalleeSFC = 445 CalleeADC->getStackFrame(ParentOfCallee, CallE, 446 currBldrCtx->getBlock(), 447 currStmtIdx); 448 449 CallEnter Loc(CallE, CalleeSFC, CurLC); 450 451 // Construct a new state which contains the mapping from actual to 452 // formal arguments. 453 State = State->enterStackFrame(Call, CalleeSFC); 454 455 bool isNew; 456 if (ExplodedNode *N = G.getNode(Loc, State, false, &isNew)) { 457 N->addPredecessor(Pred, G); 458 if (isNew) 459 Engine.getWorkList()->enqueue(N); 460 } 461 462 // If we decided to inline the call, the successor has been manually 463 // added onto the work list so remove it from the node builder. 464 Bldr.takeNodes(Pred); 465 466 NumInlinedCalls++; 467 468 // Mark the decl as visited. 469 if (VisitedCallees) 470 VisitedCallees->insert(D); 471 472 return true; 473} 474 475static ProgramStateRef getInlineFailedState(ProgramStateRef State, 476 const Stmt *CallE) { 477 void *ReplayState = State->get<ReplayWithoutInlining>(); 478 if (!ReplayState) 479 return 0; 480 481 assert(ReplayState == (const void*)CallE && "Backtracked to the wrong call."); 482 (void)CallE; 483 484 return State->remove<ReplayWithoutInlining>(); 485} 486 487void ExprEngine::VisitCallExpr(const CallExpr *CE, ExplodedNode *Pred, 488 ExplodedNodeSet &dst) { 489 // Perform the previsit of the CallExpr. 490 ExplodedNodeSet dstPreVisit; 491 getCheckerManager().runCheckersForPreStmt(dstPreVisit, Pred, CE, *this); 492 493 // Get the call in its initial state. We use this as a template to perform 494 // all the checks. 495 CallEventManager &CEMgr = getStateManager().getCallEventManager(); 496 CallEventRef<> CallTemplate 497 = CEMgr.getSimpleCall(CE, Pred->getState(), Pred->getLocationContext()); 498 499 // Evaluate the function call. We try each of the checkers 500 // to see if the can evaluate the function call. 501 ExplodedNodeSet dstCallEvaluated; 502 for (ExplodedNodeSet::iterator I = dstPreVisit.begin(), E = dstPreVisit.end(); 503 I != E; ++I) { 504 evalCall(dstCallEvaluated, *I, *CallTemplate); 505 } 506 507 // Finally, perform the post-condition check of the CallExpr and store 508 // the created nodes in 'Dst'. 509 // Note that if the call was inlined, dstCallEvaluated will be empty. 510 // The post-CallExpr check will occur in processCallExit. 511 getCheckerManager().runCheckersForPostStmt(dst, dstCallEvaluated, CE, 512 *this); 513} 514 515void ExprEngine::evalCall(ExplodedNodeSet &Dst, ExplodedNode *Pred, 516 const CallEvent &Call) { 517 // WARNING: At this time, the state attached to 'Call' may be older than the 518 // state in 'Pred'. This is a minor optimization since CheckerManager will 519 // use an updated CallEvent instance when calling checkers, but if 'Call' is 520 // ever used directly in this function all callers should be updated to pass 521 // the most recent state. (It is probably not worth doing the work here since 522 // for some callers this will not be necessary.) 523 524 // Run any pre-call checks using the generic call interface. 525 ExplodedNodeSet dstPreVisit; 526 getCheckerManager().runCheckersForPreCall(dstPreVisit, Pred, Call, *this); 527 528 // Actually evaluate the function call. We try each of the checkers 529 // to see if the can evaluate the function call, and get a callback at 530 // defaultEvalCall if all of them fail. 531 ExplodedNodeSet dstCallEvaluated; 532 getCheckerManager().runCheckersForEvalCall(dstCallEvaluated, dstPreVisit, 533 Call, *this); 534 535 // Finally, run any post-call checks. 536 getCheckerManager().runCheckersForPostCall(Dst, dstCallEvaluated, 537 Call, *this); 538} 539 540ProgramStateRef ExprEngine::bindReturnValue(const CallEvent &Call, 541 const LocationContext *LCtx, 542 ProgramStateRef State) { 543 const Expr *E = Call.getOriginExpr(); 544 if (!E) 545 return State; 546 547 // Some method families have known return values. 548 if (const ObjCMethodCall *Msg = dyn_cast<ObjCMethodCall>(&Call)) { 549 switch (Msg->getMethodFamily()) { 550 default: 551 break; 552 case OMF_autorelease: 553 case OMF_retain: 554 case OMF_self: { 555 // These methods return their receivers. 556 return State->BindExpr(E, LCtx, Msg->getReceiverSVal()); 557 } 558 } 559 } else if (const CXXConstructorCall *C = dyn_cast<CXXConstructorCall>(&Call)){ 560 return State->BindExpr(E, LCtx, C->getCXXThisVal()); 561 } 562 563 // Conjure a symbol if the return value is unknown. 564 QualType ResultTy = Call.getResultType(); 565 SValBuilder &SVB = getSValBuilder(); 566 unsigned Count = currBldrCtx->blockCount(); 567 SVal R = SVB.conjureSymbolVal(0, E, LCtx, ResultTy, Count); 568 return State->BindExpr(E, LCtx, R); 569} 570 571// Conservatively evaluate call by invalidating regions and binding 572// a conjured return value. 573void ExprEngine::conservativeEvalCall(const CallEvent &Call, NodeBuilder &Bldr, 574 ExplodedNode *Pred, ProgramStateRef State) { 575 State = Call.invalidateRegions(currBldrCtx->blockCount(), State); 576 State = bindReturnValue(Call, Pred->getLocationContext(), State); 577 578 // And make the result node. 579 Bldr.generateNode(Call.getProgramPoint(), State, Pred); 580} 581 582void ExprEngine::defaultEvalCall(NodeBuilder &Bldr, ExplodedNode *Pred, 583 const CallEvent &CallTemplate) { 584 // Make sure we have the most recent state attached to the call. 585 ProgramStateRef State = Pred->getState(); 586 CallEventRef<> Call = CallTemplate.cloneWithState(State); 587 588 if (!getAnalysisManager().shouldInlineCall()) { 589 conservativeEvalCall(*Call, Bldr, Pred, State); 590 return; 591 } 592 // Try to inline the call. 593 // The origin expression here is just used as a kind of checksum; 594 // this should still be safe even for CallEvents that don't come from exprs. 595 const Expr *E = Call->getOriginExpr(); 596 ProgramStateRef InlinedFailedState = getInlineFailedState(State, E); 597 598 if (InlinedFailedState) { 599 // If we already tried once and failed, make sure we don't retry later. 600 State = InlinedFailedState; 601 } else { 602 RuntimeDefinition RD = Call->getRuntimeDefinition(); 603 const Decl *D = RD.getDecl(); 604 if (D) { 605 if (RD.mayHaveOtherDefinitions()) { 606 // Explore with and without inlining the call. 607 if (getAnalysisManager().options.IPAMode == DynamicDispatchBifurcate) { 608 BifurcateCall(RD.getDispatchRegion(), *Call, D, Bldr, Pred); 609 return; 610 } 611 612 // Don't inline if we're not in any dynamic dispatch mode. 613 if (getAnalysisManager().options.IPAMode != DynamicDispatch) { 614 conservativeEvalCall(*Call, Bldr, Pred, State); 615 return; 616 } 617 } 618 619 // We are not bifurcating and we do have a Decl, so just inline. 620 if (inlineCall(*Call, D, Bldr, Pred, State)) 621 return; 622 } 623 } 624 625 // If we can't inline it, handle the return value and invalidate the regions. 626 conservativeEvalCall(*Call, Bldr, Pred, State); 627} 628 629void ExprEngine::BifurcateCall(const MemRegion *BifurReg, 630 const CallEvent &Call, const Decl *D, 631 NodeBuilder &Bldr, ExplodedNode *Pred) { 632 assert(BifurReg); 633 BifurReg = BifurReg->StripCasts(); 634 635 // Check if we've performed the split already - note, we only want 636 // to split the path once per memory region. 637 ProgramStateRef State = Pred->getState(); 638 const unsigned int *BState = 639 State->get<DynamicDispatchBifurcationMap>(BifurReg); 640 if (BState) { 641 // If we are on "inline path", keep inlining if possible. 642 if (*BState == DynamicDispatchModeInlined) 643 if (inlineCall(Call, D, Bldr, Pred, State)) 644 return; 645 // If inline failed, or we are on the path where we assume we 646 // don't have enough info about the receiver to inline, conjure the 647 // return value and invalidate the regions. 648 conservativeEvalCall(Call, Bldr, Pred, State); 649 return; 650 } 651 652 // If we got here, this is the first time we process a message to this 653 // region, so split the path. 654 ProgramStateRef IState = 655 State->set<DynamicDispatchBifurcationMap>(BifurReg, 656 DynamicDispatchModeInlined); 657 inlineCall(Call, D, Bldr, Pred, IState); 658 659 ProgramStateRef NoIState = 660 State->set<DynamicDispatchBifurcationMap>(BifurReg, 661 DynamicDispatchModeConservative); 662 conservativeEvalCall(Call, Bldr, Pred, NoIState); 663 664 NumOfDynamicDispatchPathSplits++; 665 return; 666} 667 668 669void ExprEngine::VisitReturnStmt(const ReturnStmt *RS, ExplodedNode *Pred, 670 ExplodedNodeSet &Dst) { 671 672 ExplodedNodeSet dstPreVisit; 673 getCheckerManager().runCheckersForPreStmt(dstPreVisit, Pred, RS, *this); 674 675 StmtNodeBuilder B(dstPreVisit, Dst, *currBldrCtx); 676 677 if (RS->getRetValue()) { 678 for (ExplodedNodeSet::iterator it = dstPreVisit.begin(), 679 ei = dstPreVisit.end(); it != ei; ++it) { 680 B.generateNode(RS, *it, (*it)->getState()); 681 } 682 } 683} 684