clang 24.0.0git
ExprEngineCallAndReturn.cpp
Go to the documentation of this file.
1//=-- ExprEngineCallAndReturn.cpp - Support for call/return -----*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// This file defines ExprEngine's support for calls and returns.
10//
11//===----------------------------------------------------------------------===//
12
14#include "clang/AST/Decl.h"
15#include "clang/AST/DeclCXX.h"
23#include "llvm/Support/Casting.h"
24#include "llvm/Support/Compiler.h"
25#include "llvm/Support/SaveAndRestore.h"
26#include <optional>
27
28using namespace clang;
29using namespace ento;
30
31#define DEBUG_TYPE "ExprEngine"
32
34 NumOfDynamicDispatchPathSplits,
35 "The # of times we split the path due to imprecise dynamic dispatch info");
36
37STAT_COUNTER(NumInlinedCalls, "The # of times we inlined a call");
38
39STAT_COUNTER(NumReachedInlineCountMax,
40 "The # of times we reached inline count maximum");
41
43 // Get the entry block in the CFG of the callee.
44 const CFGBlock *Entry = CE.getEntry();
45
46 // Validate the CFG.
47 assert(Entry->empty());
48 assert(Entry->succ_size() == 1);
49
50 // Get the solitary successor.
51 const CFGBlock *Succ = *(Entry->succ_begin());
52
53 // Construct an edge representing the starting location in the callee.
54 BlockEdge Loc(Entry, Succ, CE.getCalleeStackFrame());
55
56 ProgramStateRef state = Pred->getState();
57
58 // Construct a new node, notify checkers that analysis of the function has
59 // begun, and add the resultant nodes to the worklist.
60 bool isNew;
61 ExplodedNode *Node = G.getNode(Loc, state, false, &isNew);
62 Node->addPredecessor(Pred, G);
63 if (isNew) {
64 // FIXME: In the `processBeginOfFunction` callback
65 // `ExprEngine::getCurrStackFrame()` can be different from the
66 // `StackFrame` queried from e.g. the `ExplodedNode`s. I'm not
67 // touching this now because this commit is NFC; but in the future it would
68 // be nice to avoid this inconsistency.
69 ExplodedNodeSet DstBegin;
70 processBeginOfFunction(Node, DstBegin, Loc);
71 Engine.enqueue(DstBegin);
72 }
73}
74
75// Find the last statement on the path to the exploded node and the
76// corresponding Block.
77static std::pair<const Stmt*,
78 const CFGBlock*> getLastStmt(const ExplodedNode *Node) {
79 const Stmt *S = nullptr;
80 const CFGBlock *Blk = nullptr;
81 const StackFrame *SF = Node->getStackFrame();
82
83 // Back up through the ExplodedGraph until we reach a statement node in this
84 // stack frame.
85 while (Node) {
86 const ProgramPoint &PP = Node->getLocation();
87
88 if (PP.getStackFrame() == SF) {
89 if (std::optional<StmtPoint> SP = PP.getAs<StmtPoint>()) {
90 S = SP->getStmt();
91 break;
92 } else if (std::optional<CallExitEnd> CEE = PP.getAs<CallExitEnd>()) {
93 S = CEE->getCalleeStackFrame()->getCallSite();
94 if (S)
95 break;
96
97 // If there is no statement, this is an implicitly-generated call.
98 // We'll walk backwards over it and then continue the loop to find
99 // an actual statement.
100 std::optional<CallEnter> CE;
101 do {
102 Node = Node->getFirstPred();
103 CE = Node->getLocationAs<CallEnter>();
104 } while (!CE ||
105 CE->getCalleeStackFrame() != CEE->getCalleeStackFrame());
106
107 // Continue searching the graph.
108 } else if (std::optional<BlockEdge> BE = PP.getAs<BlockEdge>()) {
109 Blk = BE->getSrc();
110 }
111 } else if (std::optional<CallEnter> CE = PP.getAs<CallEnter>()) {
112 // If we reached the CallEnter for this function, it has no statements.
113 if (CE->getCalleeStackFrame() == SF)
114 break;
115 }
116
117 if (Node->pred_empty())
118 return std::make_pair(nullptr, nullptr);
119
120 Node = *Node->pred_begin();
121 }
122
123 return std::make_pair(S, Blk);
124}
125
126/// Adjusts a return value when the called function's return type does not
127/// match the caller's expression type. This can happen when a dynamic call
128/// is devirtualized, and the overriding method has a covariant (more specific)
129/// return type than the parent's method. For C++ objects, this means we need
130/// to add base casts.
131static SVal adjustReturnValue(SVal V, QualType ExpectedTy, QualType ActualTy,
132 StoreManager &StoreMgr) {
133 // For now, the only adjustments we handle apply only to locations.
134 if (!isa<Loc>(V))
135 return V;
136
137 // If the types already match, don't do any unnecessary work.
138 ExpectedTy = ExpectedTy.getCanonicalType();
139 ActualTy = ActualTy.getCanonicalType();
140 if (ExpectedTy == ActualTy)
141 return V;
142
143 // No adjustment is needed between Objective-C pointer types.
144 if (ExpectedTy->isObjCObjectPointerType() &&
145 ActualTy->isObjCObjectPointerType())
146 return V;
147
148 // C++ object pointers may need "derived-to-base" casts.
150 const CXXRecordDecl *ActualClass = ActualTy->getPointeeCXXRecordDecl();
151 if (ExpectedClass && ActualClass) {
152 CXXBasePaths Paths(/*FindAmbiguities=*/true, /*RecordPaths=*/true,
153 /*DetectVirtual=*/false);
154 if (ActualClass->isDerivedFrom(ExpectedClass, Paths) &&
155 !Paths.isAmbiguous(ActualTy->getCanonicalTypeUnqualified())) {
156 return StoreMgr.evalDerivedToBase(V, Paths.front());
157 }
158 }
159
160 // Unfortunately, Objective-C does not enforce that overridden methods have
161 // covariant return types, so we can't assert that that never happens.
162 // Be safe and return UnknownVal().
163 return UnknownVal();
164}
165
167 ExplodedNodeSet &Dst) {
168 // Find the last statement in the function and the corresponding basic block.
169 const Stmt *LastSt = nullptr;
170 const CFGBlock *Blk = nullptr;
171 std::tie(LastSt, Blk) = getLastStmt(Pred);
172 if (!Blk || !LastSt) {
173 Dst.insert(Pred);
174 return;
175 }
176
177 // Here, we destroy the current stack frame. We use the current function's
178 // entire body as a diagnostic statement, with which the program point
179 // will be associated. However, we only want to use LastStmt as a reference
180 // for what to clean up if it's a ReturnStmt; otherwise, everything is dead.
181 const StackFrame *SF = Pred->getStackFrame();
182 removeDead(Pred, Dst, dyn_cast<ReturnStmt>(LastSt), SF,
185}
186
188 const StackFrame *calleeCtx) {
189 const Decl *RuntimeCallee = calleeCtx->getDecl();
190 const Decl *StaticDecl = Call->getDecl();
191 assert(RuntimeCallee);
192 if (!StaticDecl)
193 return true;
194 return RuntimeCallee->getCanonicalDecl() != StaticDecl->getCanonicalDecl();
195}
196
197// Returns the number of elements in the array currently being destructed.
198// If the element count is not found 0 will be returned.
200 const CallEvent &Call, const ProgramStateRef State, SValBuilder &SVB) {
202 "The call event is not a destructor call!");
203
204 const auto &DtorCall = cast<CXXDestructorCall>(Call);
205
206 auto ThisVal = DtorCall.getCXXThisVal();
207
208 if (auto ThisElementRegion = dyn_cast<ElementRegion>(ThisVal.getAsRegion())) {
209 auto ArrayRegion = ThisElementRegion->getAsArrayOffset().getRegion();
210 auto ElementType = ThisElementRegion->getElementType();
211
212 auto ElementCount =
213 getDynamicElementCount(State, ArrayRegion, SVB, ElementType);
214
215 if (!ElementCount.isConstant())
216 return 0;
217
218 return ElementCount.getAsInteger()->getLimitedValue();
219 }
220
221 return 0;
222}
223
224ProgramStateRef ExprEngine::removeStateTraitsUsedForArrayEvaluation(
225 ProgramStateRef State, const CXXConstructExpr *E, const StackFrame *SF) {
226
227 assert(SF && "Stack frame must be provided!");
228
229 if (E) {
230 if (getPendingInitLoop(State, E, SF))
231 State = removePendingInitLoop(State, E, SF);
232
233 if (getIndexOfElementToConstruct(State, E, SF))
234 State = removeIndexOfElementToConstruct(State, E, SF);
235 }
236
237 if (getPendingArrayDestruction(State, SF))
238 State = removePendingArrayDestruction(State, SF);
239
240 return State;
241}
242
243/// The call exit is simulated with a sequence of nodes, which occur between
244/// CallExitBegin and CallExitEnd. The following operations occur between the
245/// two program points:
246/// 1. CallExitBegin (triggers the start of call exit sequence)
247/// 2. Bind the return value
248/// 3. Run Remove dead bindings to clean up the dead symbols from the callee.
249/// 4. CallExitEnd
250/// 5. PostStmt<CallExpr>
251/// Steps 1-3. happen in the callee stack frame; but there is a stack frame
252/// switch and steps 4-5. happen in the caller stack frame.
254 // Step 1 CEBNode was generated before the call.
255 const StackFrame *CalleeSF = CEBNode->getStackFrame();
256
257 const StackFrame *CallerSF = CalleeSF->getParent();
258
259 const Expr *CE = CalleeSF->getCallSite();
260 ProgramStateRef State = CEBNode->getState();
261 // Find the last statement in the function and the corresponding basic block.
262 auto [LastSt, Blk] = getLastStmt(CEBNode);
263
264 const CFGBlock *PrePurgeBlock =
265 isa_and_nonnull<ReturnStmt>(LastSt) ? Blk : &CEBNode->getCFG().getExit();
266 // The first half of this process happens in the callee stack frame:
267 setCurrStackFrameAndBlock(CalleeSF, PrePurgeBlock);
268
269 // Generate a CallEvent /before/ cleaning the State, so that we can get the
270 // correct value for 'this' (if necessary).
272 CallEventRef<> Call = CEMgr.getCaller(CalleeSF, State);
273
274 // Step 2: generate node with bound return value: CEBNode -> BoundRetNode.
275
276 // If this variable is set to 'true' the analyzer will evaluate the call
277 // statement we are about to exit again, instead of continuing the execution
278 // from the statement after the call. This is useful for non-POD type array
279 // construction where the CXXConstructExpr is referenced only once in the CFG,
280 // but we want to evaluate it as many times as many elements the array has.
281 bool ShouldRepeatCall = false;
282
283 if (const auto *DtorDecl =
284 dyn_cast_or_null<CXXDestructorDecl>(Call->getDecl())) {
285 if (auto Idx = getPendingArrayDestruction(State, CallerSF)) {
286 ShouldRepeatCall = *Idx > 0;
287
288 auto ThisVal = svalBuilder.getCXXThis(DtorDecl->getParent(), CalleeSF);
289 State = State->killBinding(ThisVal);
290 }
291 }
292
293 // If the callee returns an expression, bind its value to CallExpr.
294 if (CE) {
295 if (const ReturnStmt *RS = dyn_cast_or_null<ReturnStmt>(LastSt)) {
296 const StackFrame *SF = CEBNode->getStackFrame();
297
298 SVal V = UndefinedVal();
299 if (RS->getRetValue())
300 V = State->getSVal(RS->getRetValue(), SF);
301
302 // Ensure that the return type matches the type of the returned Expr.
303 if (wasDifferentDeclUsedForInlining(Call, CalleeSF)) {
304 QualType ReturnedTy =
306 if (!ReturnedTy.isNull()) {
307 V = adjustReturnValue(V, CE->getType(), ReturnedTy,
309 }
310 }
311
312 State = State->BindExpr(CE, CallerSF, V);
313 }
314
315 // Bind the constructed object value to CXXConstructExpr.
316 if (const CXXConstructExpr *CCE = dyn_cast<CXXConstructExpr>(CE)) {
318 svalBuilder.getCXXThis(CCE->getConstructor()->getParent(), CalleeSF);
319 SVal ThisV = State->getSVal(This);
320 ThisV = State->getSVal(ThisV.castAs<Loc>());
321 State = State->BindExpr(CCE, CallerSF, ThisV);
322
323 ShouldRepeatCall = shouldRepeatCtorCall(State, CCE, CallerSF);
324 }
325
326 if (const auto *CNE = dyn_cast<CXXNewExpr>(CE)) {
327 // We are currently evaluating a CXXNewAllocator CFGElement. It takes a
328 // while to reach the actual CXXNewExpr element from here, so keep the
329 // region for later use.
330 // Additionally cast the return value of the inlined operator new
331 // (which is of type 'void *') to the correct object type.
332 SVal AllocV = State->getSVal(CNE, CallerSF);
333 AllocV = svalBuilder.evalCast(
334 AllocV, CNE->getType(),
335 getContext().getPointerType(getContext().VoidTy));
336
337 State =
338 addObjectUnderConstruction(State, CNE, CalleeSF->getParent(), AllocV);
339 }
340 }
341
342 if (!ShouldRepeatCall) {
343 State = removeStateTraitsUsedForArrayEvaluation(
344 State, dyn_cast_or_null<CXXConstructExpr>(CE), CallerSF);
345 }
346
347 // Step 3: BoundRetNode -> CleanedNodes
348 // If we can find a statement and a block in the inlined function, run remove
349 // dead bindings before returning from the call. This is important to ensure
350 // that we report the issues such as leaks in the stack frames in which
351 // they occurred.
352 ExplodedNodeSet CleanedNodes;
353 if (LastSt && Blk && AMgr.options.AnalysisPurgeOpt != PurgeNone) {
354 static SimpleProgramPointTag RetValBind("ExprEngine", "Bind Return Value");
355 auto Loc = isa<ReturnStmt>(LastSt)
356 ? ProgramPoint{PostStmt(LastSt, CalleeSF, &RetValBind)}
357 : ProgramPoint{EpsilonPoint(CalleeSF, /*Data1=*/nullptr,
358 /*Data2=*/nullptr, &RetValBind)};
359
360 ExplodedNode *BoundRetNode = Engine.makeNode(Loc, State, CEBNode);
361 if (!BoundRetNode)
362 return;
363
364 // We call removeDead in the stack frame of the callee.
365 removeDead(BoundRetNode, CleanedNodes, /*ReferenceStmt=*/nullptr, CalleeSF,
366 /*DiagnosticStmt=*/CalleeSF->getAnalysisDeclContext()->getBody(),
368 } else {
369 CleanedNodes.insert(CEBNode);
370 }
371
372 // The second half of this process happens in the caller stack frame. This is
373 // an exception to the general rule that the current StackFrame and Block
374 // stay the same within a single call to dispatchWorkItem.
376 setCurrStackFrameAndBlock(CallerSF, CalleeSF->getCallSiteBlock());
377 SaveAndRestore CBISave(currStmtIdx, CalleeSF->getIndex());
378
379 for (ExplodedNode *N : CleanedNodes) {
380 // Step 4: Generate the CallExitEnd node.
381 // CleanedNodes -> CEENode
382 CallExitEnd Loc(CalleeSF, CallerSF);
383 ProgramStateRef CEEState = (N == CEBNode) ? State : N->getState();
384
385 ExplodedNode *CEENode = Engine.makeNode(Loc, CEEState, N);
386 if (!CEENode)
387 continue;
388
389 // Step 5: Perform the post-condition check of the CallExpr and enqueue the
390 // result onto the work list.
391 // CEENode -> Dst -> WorkList
392
393 CallEventRef<> UpdatedCall = Call.cloneWithState(CEEState);
394
395 ExplodedNodeSet DstPostPostCallCallback;
396 getCheckerManager().runCheckersForPostCall(DstPostPostCallCallback, CEENode,
397 *UpdatedCall, *this,
398 /*wasInlined=*/true);
399 ExplodedNodeSet DstPostCall;
400 if (llvm::isa_and_nonnull<CXXNewExpr>(CE)) {
401 for (ExplodedNode *I : DstPostPostCallCallback) {
403 cast<CXXAllocatorCall>(*UpdatedCall), DstPostCall, I, *this,
404 /*wasInlined=*/true);
405 }
406 } else {
407 DstPostCall.insert(DstPostPostCallCallback);
408 }
409
410 ExplodedNodeSet Dst;
411 if (const ObjCMethodCall *Msg = dyn_cast<ObjCMethodCall>(Call)) {
412 getCheckerManager().runCheckersForPostObjCMessage(Dst, DstPostCall, *Msg,
413 *this,
414 /*wasInlined=*/true);
415 } else if (CE &&
416 !(isa<CXXNewExpr>(CE) && // Called when visiting CXXNewExpr.
417 AMgr.getAnalyzerOptions().MayInlineCXXAllocator)) {
418 getCheckerManager().runCheckersForPostStmt(Dst, DstPostCall, CE,
419 *this, /*wasInlined=*/true);
420 } else {
421 Dst.insert(DstPostCall);
422 }
423
424 // Enqueue the next element in the block.
425 for (ExplodedNode *DstNode : Dst) {
426 unsigned Idx = CalleeSF->getIndex() + (ShouldRepeatCall ? 0 : 1);
427
428 Engine.getWorkList()->enqueue(DstNode, CalleeSF->getCallSiteBlock(), Idx);
429 }
430 }
431}
432
433bool ExprEngine::isSmall(AnalysisDeclContext *ADC) const {
434 // When there are no branches in the function, it means that there's no
435 // exponential complexity introduced by inlining such function.
436 // Such functions also don't trigger various fundamental problems
437 // with our inlining mechanism, such as the problem of
438 // inlined defensive checks. Hence isLinear().
439 const CFG *Cfg = ADC->getCFG();
440 return Cfg->isLinear() || Cfg->size() <= AMgr.options.AlwaysInlineSize;
441}
442
443bool ExprEngine::isLarge(AnalysisDeclContext *ADC) const {
444 const CFG *Cfg = ADC->getCFG();
445 return Cfg->size() >= AMgr.options.MinCFGSizeTreatFunctionsAsLarge;
446}
447
448bool ExprEngine::isHuge(AnalysisDeclContext *ADC) const {
449 const CFG *Cfg = ADC->getCFG();
450 return Cfg->getNumBlockIDs() > AMgr.options.MaxInlinableSize;
451}
452
453void ExprEngine::examineStackFrames(
454 const Decl *D, llvm::iterator_range<StackFrame::parent_iterator> Frames,
455 bool &IsRecursive, unsigned &StackDepth) {
456 IsRecursive = false;
457 StackDepth = 0;
458
459 for (const StackFrame &Frame : Frames) {
460 const Decl *DI = Frame.getDecl();
461
462 // Mark recursive (and mutually recursive) functions and always count
463 // them when measuring the stack depth.
464 if (DI == D) {
465 IsRecursive = true;
466 ++StackDepth;
467 continue;
468 }
469
470 // Do not count the small functions when determining the stack depth.
471 AnalysisDeclContext *CalleeADC = AMgr.getAnalysisDeclContext(DI);
472 if (!isSmall(CalleeADC))
473 ++StackDepth;
474 }
475}
476
477// The GDM component containing the dynamic dispatch bifurcation info. When
478// the exact type of the receiver is not known, we want to explore both paths -
479// one on which we do inline it and the other one on which we don't. This is
480// done to ensure we do not drop coverage.
481// This is the map from the receiver region to a bool, specifying either we
482// consider this region's information precise or not along the given path.
483namespace {
484 enum DynamicDispatchMode {
485 DynamicDispatchModeInlined = 1,
486 DynamicDispatchModeConservative
487 };
488} // end anonymous namespace
489
490REGISTER_MAP_WITH_PROGRAMSTATE(DynamicDispatchBifurcationMap,
491 const MemRegion *, unsigned)
492REGISTER_TRAIT_WITH_PROGRAMSTATE(CTUDispatchBifurcation, bool)
493
494void ExprEngine::ctuBifurcate(const CallEvent &Call, const Decl *D,
495 ExplodedNodeSet &Dst, ExplodedNode *Pred,
496 ProgramStateRef State) {
497 if (Call.isForeign() && !isSecondPhaseCTU()) {
498 const auto IK = AMgr.options.getCTUPhase1Inlining();
499 const bool DoInline = IK == CTUPhase1InliningKind::All ||
501 isSmall(AMgr.getAnalysisDeclContext(D)));
502 if (DoInline) {
503 inlineCall(Engine.getWorkList(), Call, D, Pred, State);
504 return;
505 }
506 const bool BState = State->get<CTUDispatchBifurcation>();
507 if (!BState) { // This is the first time we see this foreign function.
508 // Enqueue it to be analyzed in the second (ctu) phase.
509 inlineCall(Engine.getCTUWorkList(), Call, D, Pred, State);
510 // Conservatively evaluate in the first phase.
511 State = State->set<CTUDispatchBifurcation>(true);
512 }
513 Dst.insert(conservativeEvalCall(Call, Pred, State));
514 return;
515 }
516 inlineCall(Engine.getWorkList(), Call, D, Pred, State);
517}
518
519void ExprEngine::inlineCall(WorkList *WList, const CallEvent &Call,
520 const Decl *D, ExplodedNode *Pred,
521 ProgramStateRef State) {
522 assert(D);
523
524 const StackFrame *CallerSF = Pred->getStackFrame();
525 const BlockDataRegion *BlockInvocationData = nullptr;
526 if (Call.getKind() == CE_Block &&
527 !cast<BlockCall>(Call).isConversionFromLambda()) {
528 BlockInvocationData = cast<BlockCall>(Call).getBlockRegion();
529 assert(BlockInvocationData &&
530 "If we have the block definition we should have its region");
531 }
532
533 // This may be NULL, but that's fine.
534 const Expr *CallE = Call.getOriginExpr();
535
536 // Construct a new stack frame for the callee.
537 AnalysisDeclContext *CalleeADC = AMgr.getAnalysisDeclContext(D);
538 const StackFrame *CalleeSF = CalleeADC->getStackFrame(
539 CallerSF, BlockInvocationData, CallE, getCurrBlock(),
540 getNumVisitedCurrent(), currStmtIdx);
541
542 CallEnter Loc(CallE, CalleeSF, CallerSF);
543
544 // Construct a new state which contains the mapping from actual to
545 // formal arguments.
546 State = State->enterStackFrame(Call, CalleeSF);
547
548 bool isNew;
549 if (ExplodedNode *N = G.getNode(Loc, State, false, &isNew)) {
550 N->addPredecessor(Pred, G);
551 if (isNew)
552 WList->enqueue(N);
553 }
554
555 NumInlinedCalls++;
556 Engine.FunctionSummaries->bumpNumTimesInlined(D);
557
558 // Do not mark as visited in the 2nd run (CTUWList), so the function will
559 // be visited as top-level, this way we won't loose reports in non-ctu
560 // mode. Considering the case when a function in a foreign TU calls back
561 // into the main TU.
562 // Note, during the 1st run, it doesn't matter if we mark the foreign
563 // functions as visited (or not) because they can never appear as a top level
564 // function in the main TU.
565 if (!isSecondPhaseCTU())
566 // Mark the decl as visited.
567 if (VisitedCallees)
568 VisitedCallees->insert(D);
569}
570
572 const Expr *CallE) {
573 const void *ReplayState = State->get<ReplayWithoutInlining>();
574 if (!ReplayState)
575 return nullptr;
576
577 assert(ReplayState == CallE && "Backtracked to the wrong call.");
578 (void)CallE;
579
580 return State->remove<ReplayWithoutInlining>();
581}
582
584 ExplodedNodeSet &dst) {
585 if (const auto *OCE = dyn_cast<CXXOperatorCallExpr>(CE)) {
586 // For instance method operators, make sure the 'this' argument has a
587 // valid region.
588 // FIXME: Why is this only applied for operator calls and not other calls?
589 const Decl *Callee = OCE->getCalleeDecl();
590 if (const auto *MD = dyn_cast_or_null<CXXMethodDecl>(Callee)) {
591 if (MD->isImplicitObjectMemberFunction()) {
592 ProgramStateRef State = Pred->getState();
593 const StackFrame *SF = Pred->getStackFrame();
594 ProgramStateRef NewState =
595 createTemporaryRegionIfNeeded(State, SF, OCE->getArg(0));
596 if (NewState != State) {
597 PreStmt PS(OCE, SF, /*tag=*/nullptr);
598 Pred = Engine.makeNode(PS, NewState, Pred);
599 if (!Pred)
600 return; // Cached out.
601 }
602 }
603 }
604 }
605 // Perform the previsit of the CallExpr.
606 ExplodedNodeSet dstPreVisit;
607 getCheckerManager().runCheckersForPreStmt(dstPreVisit, Pred, CE, *this);
608
609 // Get the call in its initial state. We use this as a template to perform
610 // all the checks.
612 CallEventRef<> CallTemplate = CEMgr.getSimpleCall(
613 CE, Pred->getState(), Pred->getStackFrame(), getCFGElementRef());
614
615 // Evaluate the function call. We try each of the checkers
616 // to see if the can evaluate the function call.
617 ExplodedNodeSet dstCallEvaluated;
618 for (ExplodedNode *N : dstPreVisit) {
619 evalCall(dstCallEvaluated, N, *CallTemplate);
620 }
621
622 // Finally, perform the post-condition check of the CallExpr and store
623 // the created nodes in 'Dst'.
624 // Note that if the call was inlined, dstCallEvaluated will be empty.
625 // The post-CallExpr check will occur in processCallExit.
626 getCheckerManager().runCheckersForPostStmt(dst, dstCallEvaluated, CE,
627 *this);
628}
629
630ProgramStateRef ExprEngine::finishArgumentConstruction(ProgramStateRef State,
631 const CallEvent &Call) {
632 // WARNING: The state attached to 'Call' may be obsolete, do not call any
633 // methods that rely on it!
634 const Expr *E = Call.getOriginExpr();
635 // FIXME: Constructors to placement arguments of operator new
636 // are not supported yet.
637 if (!E || isa<CXXNewExpr>(E))
638 return State;
639
640 const StackFrame *SF = Call.getStackFrame();
641 for (unsigned CallI = 0, CallN = Call.getNumArgs(); CallI != CallN; ++CallI) {
642 unsigned I = Call.getASTArgumentIndex(CallI);
643 if (std::optional<SVal> V = getObjectUnderConstruction(State, {E, I}, SF)) {
644 SVal VV = *V;
645 (void)VV;
647 ->getStackFrame()
648 ->getParent() == SF);
649 State = finishObjectConstruction(State, {E, I}, SF);
650 }
651 }
652
653 return State;
654}
655
656void ExprEngine::finishArgumentConstruction(ExplodedNodeSet &Dst,
657 ExplodedNode *Pred,
658 const CallEvent &Call) {
659 // WARNING: The state attached to 'Call' may be obsolete, do not call any
660 // methods that rely on it!
661 ProgramStateRef State = Pred->getState();
662 ProgramStateRef CleanedState = finishArgumentConstruction(State, Call);
663 if (CleanedState == State) {
664 Dst.insert(Pred);
665 return;
666 }
667
668 const Expr *E = Call.getOriginExpr();
669 const StackFrame *SF = Call.getStackFrame();
670 static SimpleProgramPointTag Tag("ExprEngine",
671 "Finish argument construction");
672 Dst.insert(Engine.makeNode(PreStmt(E, SF, &Tag), CleanedState, Pred));
673}
674
676 const CallEvent &CallTemplate) {
677 // NOTE: CallTemplate is called a "template" because its attached state may
678 // be obsolete (compared to the state of Pred). The state-dependent methods
679 // of CallEvent should be used only after a `cloneWithState` call that
680 // attaches the up-to-date state to this template object.
681
682 // Run any pre-call checks using the generic call interface.
683 ExplodedNodeSet dstPreVisit;
684 getCheckerManager().runCheckersForPreCall(dstPreVisit, Pred, CallTemplate,
685 *this);
686
687 // Actually evaluate the function call. We try each of the checkers
688 // to see if the can evaluate the function call, and get a callback at
689 // defaultEvalCall if all of them fail.
690 ExplodedNodeSet dstCallEvaluated;
692 dstCallEvaluated, dstPreVisit, CallTemplate, *this, EvalCallOptions());
693
694 // If there were other constructors called for object-type arguments
695 // of this call, clean them up.
696 ExplodedNodeSet dstArgumentCleanup;
697 for (ExplodedNode *I : dstCallEvaluated)
698 finishArgumentConstruction(dstArgumentCleanup, I, CallTemplate);
699
700 ExplodedNodeSet dstPostCall;
701 getCheckerManager().runCheckersForPostCall(dstPostCall, dstArgumentCleanup,
702 CallTemplate, *this);
703
704 // Escaping symbols conjured during invalidating the regions above.
705 // Note that, for inlined calls the nodes were put back into the worklist,
706 // so we can assume that every node belongs to a conservative call at this
707 // point.
708
709 // Run pointerEscape callback with the newly conjured symbols.
711 for (ExplodedNode *I : dstPostCall) {
712 ProgramStateRef State = I->getState();
713 CallEventRef<> Call = CallTemplate.cloneWithState(State);
714 Escaped.clear();
715 {
716 unsigned Arg = -1;
717 for (const ParmVarDecl *PVD : Call->parameters()) {
718 ++Arg;
719 QualType ParamTy = PVD->getType();
720 if (ParamTy.isNull() ||
721 (!ParamTy->isPointerType() && !ParamTy->isReferenceType()))
722 continue;
723 QualType Pointee = ParamTy->getPointeeType();
724 if (Pointee.isConstQualified() || Pointee->isVoidType())
725 continue;
726 if (const MemRegion *MR = Call->getArgSVal(Arg).getAsRegion())
727 Escaped.emplace_back(loc::MemRegionVal(MR), State->getSVal(MR, Pointee));
728 }
729 }
730
731 State = processPointerEscapedOnBind(State, Escaped, I->getStackFrame(),
733
734 if (State != I->getState())
735 I = Engine.makeNode(I->getLocation(), State, I);
736
737 Dst.insert(I);
738 }
739}
740
742 const StackFrame *SF,
743 ProgramStateRef State) {
744 const Expr *E = Call.getOriginExpr();
745 const ConstCFGElementRef &Elem = Call.getCFGElementRef();
746 if (!E)
747 return State;
748
749 // Some method families have known return values.
750 if (const ObjCMethodCall *Msg = dyn_cast<ObjCMethodCall>(&Call)) {
751 switch (Msg->getMethodFamily()) {
752 default:
753 break;
754 case OMF_autorelease:
755 case OMF_retain:
756 case OMF_self: {
757 // These methods return their receivers.
758 return State->BindExpr(E, SF, Msg->getReceiverSVal());
759 }
760 }
761 } else if (const CXXConstructorCall *C = dyn_cast<CXXConstructorCall>(&Call)){
762 SVal ThisV = C->getCXXThisVal();
763 ThisV = State->getSVal(ThisV.castAs<Loc>());
764 return State->BindExpr(E, SF, ThisV);
765 }
766
767 SVal R;
768 QualType ResultTy = Call.getResultType();
769 unsigned Count = getNumVisitedCurrent();
770 if (auto RTC = getCurrentCFGElement().getAs<CFGCXXRecordTypedCall>()) {
771 // Conjure a temporary if the function returns an object by value.
772 SVal Target;
773 assert(RTC->getStmt() == Call.getOriginExpr());
774 EvalCallOptions CallOpts; // FIXME: We won't really need those.
775 std::tie(State, Target) =
776 handleConstructionContext(Call.getOriginExpr(), State, currBldrCtx, SF,
777 RTC->getConstructionContext(), CallOpts);
778 const MemRegion *TargetR = Target.getAsRegion();
779 assert(TargetR);
780 // Invalidate the region so that it didn't look uninitialized. If this is
781 // a field or element constructor, we do not want to invalidate
782 // the whole structure. Pointer escape is meaningless because
783 // the structure is a product of conservative evaluation
784 // and therefore contains nothing interesting at this point.
786 ITraits.setTrait(TargetR,
788 State = State->invalidateRegions(TargetR, Elem, Count, SF,
789 /* CausesPointerEscape=*/false, nullptr,
790 &Call, &ITraits);
791
792 R = State->getSVal(Target.castAs<Loc>(), E->getType());
793 } else {
794 // Conjure a symbol if the return value is unknown.
795
796 // See if we need to conjure a heap pointer instead of
797 // a regular unknown pointer.
798 const auto *CNE = dyn_cast<CXXNewExpr>(E);
799 if (CNE && CNE->getOperatorNew()->isReplaceableGlobalAllocationFunction()) {
800 R = svalBuilder.getConjuredHeapSymbolVal(Elem, SF, E->getType(), Count);
801 const MemRegion *MR = R.getAsRegion()->StripCasts();
802
803 // Store the extent of the allocated object(s).
804 SVal ElementCount;
805 if (const Expr *SizeExpr = CNE->getArraySize().value_or(nullptr)) {
806 ElementCount = State->getSVal(SizeExpr, SF);
807 } else {
808 ElementCount = svalBuilder.makeIntVal(1, /*IsUnsigned=*/true);
809 }
810
811 SVal ElementSize = getElementExtent(CNE->getAllocatedType(), svalBuilder);
812
813 SVal Size =
814 svalBuilder.evalBinOp(State, BO_Mul, ElementCount, ElementSize,
815 svalBuilder.getArrayIndexType());
816
817 // FIXME: This line is to prevent a crash. For more details please check
818 // issue #56264.
819 if (Size.isUndef())
820 Size = UnknownVal();
821
822 State = setDynamicExtent(State, MR, Size.castAs<DefinedOrUnknownSVal>());
823 } else {
824 R = svalBuilder.conjureSymbolVal(Elem, SF, ResultTy, Count);
825 }
826 }
827 return State->BindExpr(E, SF, R);
828}
829
830// Conservatively evaluate call by invalidating regions and binding
831// a conjured return value.
832ExplodedNode *ExprEngine::conservativeEvalCall(const CallEvent &Call,
833 ExplodedNode *Pred,
834 ProgramStateRef State) {
835 State = Call.invalidateRegions(getNumVisitedCurrent(), State);
836 State = bindReturnValue(Call, Pred->getStackFrame(), State);
837
838 // And make the result node.
839 static SimpleProgramPointTag PT("ExprEngine", "Conservative eval call");
840 return Engine.makeNode(Call.getProgramPoint(false, &PT), State, Pred);
841}
842
843ExprEngine::CallInlinePolicy
844ExprEngine::mayInlineCallKind(const CallEvent &Call, const ExplodedNode *Pred,
845 AnalyzerOptions &Opts,
846 const EvalCallOptions &CallOpts) {
847 const StackFrame *CallerSF = Pred->getStackFrame();
848 switch (Call.getKind()) {
849 case CE_Function:
851 case CE_Block:
852 break;
853 case CE_CXXMember:
856 return CIP_DisallowedAlways;
857 break;
858 case CE_CXXConstructor: {
860 return CIP_DisallowedAlways;
861
863
864 const CXXConstructExpr *CtorExpr = Ctor.getOriginExpr();
865
867 const ConstructionContext *CC = CCE ? CCE->getConstructionContext()
868 : nullptr;
869
870 if (llvm::isa_and_nonnull<NewAllocatedObjectConstructionContext>(CC) &&
871 !Opts.MayInlineCXXAllocator)
872 return CIP_DisallowedOnce;
873
874 if (CallOpts.IsArrayCtorOrDtor) {
875 if (!shouldInlineArrayConstruction(Pred->getState(), CtorExpr, CallerSF))
876 return CIP_DisallowedOnce;
877 }
878
879 // Inlining constructors requires including initializers in the CFG.
880 const AnalysisDeclContext *ADC = CallerSF->getAnalysisDeclContext();
881 assert(ADC->getCFGBuildOptions().AddInitializers && "No CFG initializers");
882 (void)ADC;
883
884 // If the destructor is trivial, it's always safe to inline the constructor.
885 if (Ctor.getDecl()->getParent()->hasTrivialDestructor())
886 break;
887
888 // For other types, only inline constructors if destructor inlining is
889 // also enabled.
891 return CIP_DisallowedAlways;
892
894 // If we don't handle temporary destructors, we shouldn't inline
895 // their constructors.
896 if (CallOpts.IsTemporaryCtorOrDtor &&
897 !Opts.ShouldIncludeTemporaryDtorsInCFG)
898 return CIP_DisallowedOnce;
899
900 // If we did not find the correct this-region, it would be pointless
901 // to inline the constructor. Instead we will simply invalidate
902 // the fake temporary target.
904 return CIP_DisallowedOnce;
905
906 // If the temporary is lifetime-extended by binding it to a reference-type
907 // field within an aggregate, automatic destructors don't work properly.
909 return CIP_DisallowedOnce;
910 }
911
912 break;
913 }
915 // This doesn't really increase the cost of inlining ever, because
916 // the stack frame of the inherited constructor is trivial.
917 return CIP_Allowed;
918 }
919 case CE_CXXDestructor: {
921 return CIP_DisallowedAlways;
922
923 // Inlining destructors requires building the CFG correctly.
924 const AnalysisDeclContext *ADC = CallerSF->getAnalysisDeclContext();
925 assert(ADC->getCFGBuildOptions().AddImplicitDtors && "No CFG destructors");
926 (void)ADC;
927
928 if (CallOpts.IsArrayCtorOrDtor) {
929 if (!shouldInlineArrayDestruction(getElementCountOfArrayBeingDestructed(
930 Call, Pred->getState(), svalBuilder))) {
931 return CIP_DisallowedOnce;
932 }
933 }
934
935 // Allow disabling temporary destructor inlining with a separate option.
936 if (CallOpts.IsTemporaryCtorOrDtor &&
937 !Opts.MayInlineCXXTemporaryDtors)
938 return CIP_DisallowedOnce;
939
940 // If we did not find the correct this-region, it would be pointless
941 // to inline the destructor. Instead we will simply invalidate
942 // the fake temporary target.
944 return CIP_DisallowedOnce;
945 break;
946 }
948 [[fallthrough]];
949 case CE_CXXAllocator:
950 if (Opts.MayInlineCXXAllocator)
951 break;
952 // Do not inline allocators until we model deallocators.
953 // This is unfortunate, but basically necessary for smart pointers and such.
954 return CIP_DisallowedAlways;
955 case CE_ObjCMessage:
956 if (!Opts.MayInlineObjCMethod)
957 return CIP_DisallowedAlways;
958 if (!(Opts.getIPAMode() == IPAK_DynamicDispatch ||
960 return CIP_DisallowedAlways;
961 break;
962 }
963
964 return CIP_Allowed;
965}
966
967/// Returns true if the given C++ class contains a member with the given name.
968static bool hasMember(const ASTContext &Ctx, const CXXRecordDecl *RD,
969 StringRef Name) {
970 const IdentifierInfo &II = Ctx.Idents.get(Name);
971 return RD->hasMemberName(Ctx.DeclarationNames.getIdentifier(&II));
972}
973
974/// Returns true if the given C++ class is a container or iterator.
975///
976/// Our heuristic for this is whether it contains a method named 'begin()' or a
977/// nested type named 'iterator' or 'iterator_category'.
978static bool isContainerClass(const ASTContext &Ctx, const CXXRecordDecl *RD) {
979 return hasMember(Ctx, RD, "begin") ||
980 hasMember(Ctx, RD, "iterator") ||
981 hasMember(Ctx, RD, "iterator_category");
982}
983
984/// Returns true if the given function refers to a method of a C++ container
985/// or iterator.
986///
987/// We generally do a poor job modeling most containers right now, and might
988/// prefer not to inline their methods.
989static bool isContainerMethod(const ASTContext &Ctx,
990 const FunctionDecl *FD) {
991 if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(FD))
992 return isContainerClass(Ctx, MD->getParent());
993 return false;
994}
995
996/// Returns true if the given function is the destructor of a class named
997/// "shared_ptr".
998static bool isCXXSharedPtrDtor(const FunctionDecl *FD) {
999 const CXXDestructorDecl *Dtor = dyn_cast<CXXDestructorDecl>(FD);
1000 if (!Dtor)
1001 return false;
1002
1003 const CXXRecordDecl *RD = Dtor->getParent();
1004 if (const IdentifierInfo *II = RD->getDeclName().getAsIdentifierInfo())
1005 if (II->isStr("shared_ptr"))
1006 return true;
1007
1008 return false;
1009}
1010
1011/// Returns true if the function in \p CalleeADC may be inlined in general.
1012///
1013/// This checks static properties of the function, such as its signature and
1014/// CFG, to determine whether the analyzer should ever consider inlining it,
1015/// in any context.
1016bool ExprEngine::mayInlineDecl(AnalysisDeclContext *CalleeADC) const {
1017 AnalyzerOptions &Opts = AMgr.getAnalyzerOptions();
1018 // FIXME: Do not inline variadic calls.
1019 if (CallEvent::isVariadic(CalleeADC->getDecl()))
1020 return false;
1021
1022 // Check certain C++-related inlining policies.
1023 ASTContext &Ctx = CalleeADC->getASTContext();
1024 if (Ctx.getLangOpts().CPlusPlus) {
1025 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(CalleeADC->getDecl())) {
1026 // Conditionally control the inlining of template functions.
1027 if (!Opts.MayInlineTemplateFunctions)
1028 if (FD->getTemplatedKind() != FunctionDecl::TK_NonTemplate)
1029 return false;
1030
1031 // Conditionally control the inlining of C++ standard library functions.
1032 if (!Opts.MayInlineCXXStandardLibrary)
1033 if (Ctx.getSourceManager().isInSystemHeader(FD->getLocation()))
1035 return false;
1036
1037 // Conditionally control the inlining of methods on objects that look
1038 // like C++ containers.
1039 if (!Opts.MayInlineCXXContainerMethods)
1040 if (!AMgr.isInCodeFile(FD->getLocation()))
1041 if (isContainerMethod(Ctx, FD))
1042 return false;
1043
1044 // Conditionally control the inlining of the destructor of C++ shared_ptr.
1045 // We don't currently do a good job modeling shared_ptr because we can't
1046 // see the reference count, so treating as opaque is probably the best
1047 // idea.
1048 if (!Opts.MayInlineCXXSharedPtrDtor)
1049 if (isCXXSharedPtrDtor(FD))
1050 return false;
1051 }
1052 }
1053
1054 // It is possible that the CFG cannot be constructed.
1055 // Be safe, and check if the CalleeCFG is valid.
1056 const CFG *CalleeCFG = CalleeADC->getCFG();
1057 if (!CalleeCFG)
1058 return false;
1059
1060 // Do not inline large functions.
1061 if (isHuge(CalleeADC))
1062 return false;
1063
1064 // It is possible that the live variables analysis cannot be
1065 // run. If so, bail out.
1066 if (!CalleeADC->getAnalysis<RelaxedLiveVariables>())
1067 return false;
1068
1069 return true;
1070}
1071
1072bool ExprEngine::shouldInlineCall(const CallEvent &Call, const Decl *D,
1073 const ExplodedNode *Pred,
1074 const EvalCallOptions &CallOpts) {
1075 if (!D)
1076 return false;
1077
1078 AnalysisManager &AMgr = getAnalysisManager();
1079 AnalyzerOptions &Opts = AMgr.options;
1080 AnalysisDeclContextManager &ADCMgr = AMgr.getAnalysisDeclContextManager();
1081 AnalysisDeclContext *CalleeADC = ADCMgr.getContext(D);
1082
1083 // The auto-synthesized bodies are essential to inline as they are
1084 // usually small and commonly used. Note: we should do this check early on to
1085 // ensure we always inline these calls.
1086 if (CalleeADC->isBodyAutosynthesized())
1087 return true;
1088
1089 if (!AMgr.shouldInlineCall())
1090 return false;
1091
1092 // Check if this function has been marked as non-inlinable.
1093 std::optional<bool> MayInline = Engine.FunctionSummaries->mayInline(D);
1094 if (MayInline) {
1095 if (!*MayInline)
1096 return false;
1097
1098 } else {
1099 // We haven't actually checked the static properties of this function yet.
1100 // Do that now, and record our decision in the function summaries.
1101 if (mayInlineDecl(CalleeADC)) {
1102 Engine.FunctionSummaries->markMayInline(D);
1103 } else {
1104 Engine.FunctionSummaries->markShouldNotInline(D);
1105 return false;
1106 }
1107 }
1108
1109 // Check if we should inline a call based on its kind.
1110 // FIXME: this checks both static and dynamic properties of the call, which
1111 // means we're redoing a bit of work that could be cached in the function
1112 // summary.
1113 CallInlinePolicy CIP = mayInlineCallKind(Call, Pred, Opts, CallOpts);
1114 if (CIP != CIP_Allowed) {
1115 if (CIP == CIP_DisallowedAlways) {
1116 assert(!MayInline || *MayInline);
1117 Engine.FunctionSummaries->markShouldNotInline(D);
1118 }
1119 return false;
1120 }
1121
1122 // Do not inline if recursive or we've reached max stack frame count.
1123 bool IsRecursive = false;
1124 unsigned StackDepth = 0;
1125 examineStackFrames(D, Pred->stackframes(), IsRecursive, StackDepth);
1126 if ((StackDepth >= Opts.InlineMaxStackDepth) &&
1127 (!isSmall(CalleeADC) || IsRecursive))
1128 return false;
1129
1130 // Do not inline large functions too many times.
1131 if ((Engine.FunctionSummaries->getNumTimesInlined(D) >
1132 Opts.MaxTimesInlineLarge) &&
1133 isLarge(CalleeADC)) {
1134 NumReachedInlineCountMax++;
1135 return false;
1136 }
1137
1138 if (HowToInline == Inline_Minimal && (!isSmall(CalleeADC) || IsRecursive))
1139 return false;
1140
1141 return true;
1142}
1143
1144bool ExprEngine::shouldInlineArrayConstruction(const ProgramStateRef State,
1145 const CXXConstructExpr *CE,
1146 const StackFrame *SF) {
1147 if (!CE)
1148 return false;
1149
1150 // FIXME: Handle other arrays types.
1151 if (const auto *CAT = dyn_cast<ConstantArrayType>(CE->getType())) {
1152 unsigned ArrSize = getContext().getConstantArrayElementCount(CAT);
1153
1154 // This might seem conter-intuitive at first glance, but the functions are
1155 // closely related. Reasoning about destructors depends only on the type
1156 // of the expression that initialized the memory region, which is the
1157 // CXXConstructExpr. So to avoid code repetition, the work is delegated
1158 // to the function that reasons about destructor inlining. Also note that
1159 // if the constructors of the array elements are inlined, the destructors
1160 // can also be inlined and if the destructors can be inline, it's safe to
1161 // inline the constructors.
1162 return shouldInlineArrayDestruction(ArrSize);
1163 }
1164
1165 // Check if we're inside an ArrayInitLoopExpr, and it's sufficiently small.
1166 if (auto Size = getPendingInitLoop(State, CE, SF))
1167 return shouldInlineArrayDestruction(*Size);
1168
1169 return false;
1170}
1171
1172bool ExprEngine::shouldInlineArrayDestruction(uint64_t Size) {
1173
1174 uint64_t maxAllowedSize = AMgr.options.maxBlockVisitOnPath;
1175
1176 // Declaring a 0 element array is also possible.
1177 return Size <= maxAllowedSize && Size > 0;
1178}
1179
1180bool ExprEngine::shouldRepeatCtorCall(ProgramStateRef State,
1181 const CXXConstructExpr *E,
1182 const StackFrame *SF) {
1183
1184 if (!E)
1185 return false;
1186
1187 auto Ty = E->getType();
1188
1189 // FIXME: Handle non constant array types
1190 if (const auto *CAT = dyn_cast<ConstantArrayType>(Ty)) {
1192 return Size > getIndexOfElementToConstruct(State, E, SF);
1193 }
1194
1195 if (auto Size = getPendingInitLoop(State, E, SF))
1196 return Size > getIndexOfElementToConstruct(State, E, SF);
1197
1198 return false;
1199}
1200
1202 const CXXInstanceCall *ICall = dyn_cast<CXXInstanceCall>(&Call);
1203 if (!ICall)
1204 return false;
1205
1206 const CXXMethodDecl *MD = dyn_cast_or_null<CXXMethodDecl>(ICall->getDecl());
1207 if (!MD)
1208 return false;
1210 return false;
1211
1212 return MD->isTrivial();
1213}
1214
1216 const CallEvent &Call,
1217 const EvalCallOptions &CallOpts) {
1218 // Make sure we have the most recent state attached to the call.
1219 ProgramStateRef State = Pred->getState();
1220
1221 // Special-case trivial assignment operators.
1223 performTrivialCopy(Dst, Pred, Call);
1224 return;
1225 }
1226
1227 const Expr *E = Call.getOriginExpr();
1228
1229 ProgramStateRef InlinedFailedState = getInlineFailedState(State, E);
1230 if (InlinedFailedState) {
1231 // If we already tried once and failed, make sure we don't retry later.
1232 State = InlinedFailedState;
1233 } else {
1234 RuntimeDefinition RD = Call.getRuntimeDefinition();
1235 Call.setForeign(RD.isForeign());
1236 const Decl *D = RD.getDecl();
1237 if (shouldInlineCall(Call, D, Pred, CallOpts)) {
1238 if (RD.mayHaveOtherDefinitions()) {
1240
1241 // Explore with and without inlining the call.
1242 if (Options.getIPAMode() == IPAK_DynamicDispatchBifurcate) {
1243 dynDispatchBifurcate(RD.getDispatchRegion(), Call, D, Dst, Pred);
1244 return;
1245 }
1246
1247 // Don't inline if we're not in any dynamic dispatch mode.
1248 if (Options.getIPAMode() != IPAK_DynamicDispatch) {
1249 Dst.insert(conservativeEvalCall(Call, Pred, State));
1250 return;
1251 }
1252 }
1253 ctuBifurcate(Call, D, Dst, Pred, State);
1254 return;
1255 }
1256 }
1257
1258 // If we can't inline it, clean up the state traits used only if the function
1259 // is inlined.
1260 State = removeStateTraitsUsedForArrayEvaluation(
1261 State, dyn_cast_or_null<CXXConstructExpr>(E), Call.getStackFrame());
1262
1263 // Also handle the return value and invalidate the regions.
1264 Dst.insert(conservativeEvalCall(Call, Pred, State));
1265}
1266
1267void ExprEngine::dynDispatchBifurcate(const MemRegion *BifurReg,
1268 const CallEvent &Call, const Decl *D,
1269 ExplodedNodeSet &Dst,
1270 ExplodedNode *Pred) {
1271 assert(BifurReg);
1272 BifurReg = BifurReg->StripCasts();
1273
1274 // Check if we've performed the split already - note, we only want
1275 // to split the path once per memory region.
1276 ProgramStateRef State = Pred->getState();
1277 const unsigned *BState =
1278 State->get<DynamicDispatchBifurcationMap>(BifurReg);
1279 if (BState) {
1280 // If we are on "inline path", keep inlining if possible.
1281 if (*BState == DynamicDispatchModeInlined)
1282 ctuBifurcate(Call, D, Dst, Pred, State);
1283 // If inline failed, or we are on the path where we assume we
1284 // don't have enough info about the receiver to inline, conjure the
1285 // return value and invalidate the regions.
1286 Dst.insert(conservativeEvalCall(Call, Pred, State));
1287 return;
1288 }
1289
1290 // If we got here, this is the first time we process a message to this
1291 // region, so split the path.
1292 ProgramStateRef IState =
1293 State->set<DynamicDispatchBifurcationMap>(BifurReg,
1294 DynamicDispatchModeInlined);
1295 ctuBifurcate(Call, D, Dst, Pred, IState);
1296
1297 ProgramStateRef NoIState =
1298 State->set<DynamicDispatchBifurcationMap>(BifurReg,
1299 DynamicDispatchModeConservative);
1300 Dst.insert(conservativeEvalCall(Call, Pred, NoIState));
1301
1302 NumOfDynamicDispatchPathSplits++;
1303}
1304
1306 ExplodedNodeSet &Dst) {
1307 ExplodedNodeSet DstPreVisit;
1308 getCheckerManager().runCheckersForPreStmt(DstPreVisit, Pred, RS, *this);
1309
1310 if (RS->getRetValue()) {
1311 for (ExplodedNode *N : DstPreVisit) {
1312 Dst.insert(Engine.makePostStmtNode(RS, N->getState(), N));
1313 }
1314 } else {
1315 Dst.insert(DstPreVisit);
1316 }
1317}
#define V(N, I)
Defines the C++ Decl subclasses, other than those for templates (found in DeclTemplate....
#define STAT_COUNTER(VARNAME, DESC)
static bool isContainerClass(const ASTContext &Ctx, const CXXRecordDecl *RD)
Returns true if the given C++ class is a container or iterator.
static bool wasDifferentDeclUsedForInlining(CallEventRef<> Call, const StackFrame *calleeCtx)
static std::pair< const Stmt *, const CFGBlock * > getLastStmt(const ExplodedNode *Node)
static bool isTrivialObjectAssignment(const CallEvent &Call)
static bool isCXXSharedPtrDtor(const FunctionDecl *FD)
Returns true if the given function is the destructor of a class named "shared_ptr".
static bool hasMember(const ASTContext &Ctx, const CXXRecordDecl *RD, StringRef Name)
Returns true if the given C++ class contains a member with the given name.
static SVal adjustReturnValue(SVal V, QualType ExpectedTy, QualType ActualTy, StoreManager &StoreMgr)
Adjusts a return value when the called function's return type does not match the caller's expression ...
static bool isContainerMethod(const ASTContext &Ctx, const FunctionDecl *FD)
Returns true if the given function refers to a method of a C++ container or iterator.
static unsigned getElementCountOfArrayBeingDestructed(const CallEvent &Call, const ProgramStateRef State, SValBuilder &SVB)
static ProgramStateRef getInlineFailedState(ProgramStateRef State, const Expr *CallE)
#define REGISTER_MAP_WITH_PROGRAMSTATE(Name, Key, Value)
Declares an immutable map of type NameTy, suitable for placement into the ProgramState.
#define REGISTER_TRAIT_WITH_PROGRAMSTATE(Name, Type)
Declares a program state trait for type Type called Name, and introduce a type named NameTy.
a trap message and trap category.
Holds long-lived AST nodes (such as types and decls) that can be referred to throughout the semantic ...
Definition ASTContext.h:223
SourceManager & getSourceManager()
Definition ASTContext.h:869
DeclarationNameTable DeclarationNames
Definition ASTContext.h:812
IdentifierTable & Idents
Definition ASTContext.h:808
const LangOptions & getLangOpts() const
Definition ASTContext.h:965
uint64_t getConstantArrayElementCount(const ConstantArrayType *CA) const
Return number of constant array elements.
AnalysisDeclContext * getContext(const Decl *D)
AnalysisDeclContext contains the context data for the function, method or block under analysis.
static bool isInStdNamespace(const Decl *D)
ASTContext & getASTContext() const
const StackFrame * getStackFrame(const StackFrame *ParentSF, const void *Data, const Expr *E, const CFGBlock *Blk, unsigned BlockCount, unsigned Index)
Obtain a context of the call stack using its parent context.
CFG::BuildOptions & getCFGBuildOptions()
Stores options for the analyzer from the command line.
bool mayInlineCXXMemberFunction(CXXInlineableMemberKind K) const
Returns the option controlling which C++ member functions will be considered for inlining.
IPAKind getIPAMode() const
Returns the inter-procedural analysis mode.
CTUPhase1InliningKind getCTUPhase1Inlining() const
unsigned InlineMaxStackDepth
The inlining stack depth limit.
Represents a single basic block in a source-level CFG.
Definition CFG.h:652
bool empty() const
Definition CFG.h:1000
succ_iterator succ_begin()
Definition CFG.h:1037
unsigned succ_size() const
Definition CFG.h:1055
Represents C++ constructor call.
Definition CFG.h:161
std::optional< T > getAs() const
Convert to the specified CFGElement type, returning std::nullopt if this CFGElement is not of the des...
Definition CFG.h:113
Represents a source-level, intra-procedural CFG that represents the control-flow of a Stmt.
Definition CFG.h:1271
unsigned size() const
Return the total number of CFGBlocks within the CFG This is simply a renaming of the getNumBlockIDs()...
Definition CFG.h:1469
bool isLinear() const
Returns true if the CFG has no branches.
Definition CFG.cpp:5468
CFGBlock & getExit()
Definition CFG.h:1387
unsigned getNumBlockIDs() const
Returns the total number of BlockIDs allocated (which start at 0).
Definition CFG.h:1464
BasePaths - Represents the set of paths from a derived class to one of its (direct or indirect) bases...
CXXBasePath & front()
bool isAmbiguous(CanQualType BaseType) const
Determine whether the path from the most-derived type to the given base type is ambiguous (i....
Represents a call to a C++ constructor.
Definition ExprCXX.h:1551
CXXConstructionKind getConstructionKind() const
Determine whether this constructor is actually constructing a base class (rather than a complete obje...
Definition ExprCXX.h:1662
Represents a C++ destructor within a class.
Definition DeclCXX.h:2898
Represents a static or instance method of a struct/union/class.
Definition DeclCXX.h:2145
const CXXRecordDecl * getParent() const
Return the parent of this method declaration, which is the class in which this method is defined.
Definition DeclCXX.h:2284
bool isMoveAssignmentOperator() const
Determine whether this is a move assignment operator.
Definition DeclCXX.cpp:2751
bool isCopyAssignmentOperator() const
Determine whether this is a copy-assignment operator, regardless of whether it was declared implicitl...
Definition DeclCXX.cpp:2730
Represents a C++ struct/union/class.
Definition DeclCXX.h:258
bool hasTrivialDestructor() const
Determine whether this class has a trivial destructor (C++ [class.dtor]p3)
Definition DeclCXX.h:1377
bool hasMemberName(DeclarationName N) const
Determine whether this class has a member with the given name, possibly in a non-dependent base class...
bool isDerivedFrom(const CXXRecordDecl *Base) const
Determine whether this class is derived from the class Base.
Represents a point when we begin processing an inlined call.
const StackFrame * getCalleeStackFrame() const
const CFGBlock * getEntry() const
Returns the entry block in the CFG for the entered function.
Represents a point when we finish the call exit sequence (for inlined call).
CallExpr - Represents a function call (C99 6.5.2.2, C++ [expr.call]).
Definition Expr.h:2949
ConstructionContext's subclasses describe different ways of constructing an object in C++.
Decl - This represents one declaration (or definition), e.g.
Definition DeclBase.h:86
virtual Decl * getCanonicalDecl()
Retrieves the "canonical" declaration of the given declaration.
Definition DeclBase.h:995
DeclarationName getIdentifier(const IdentifierInfo *ID)
Create a declaration name that is a simple identifier.
IdentifierInfo * getAsIdentifierInfo() const
Retrieve the IdentifierInfo * stored in this declaration name, or null if this declaration name isn't...
This is a meta program point, which should be skipped by all the diagnostic reasoning etc.
This represents one expression.
Definition Expr.h:112
QualType getType() const
Definition Expr.h:144
Represents a function declaration or definition.
Definition Decl.h:2029
bool isTrivial() const
Whether this function is "trivial" in some specialized C++ senses.
Definition Decl.h:2413
One of these records is kept for each identifier that is lexed.
IdentifierInfo & get(StringRef Name)
Return the identifier token info for the specified named identifier.
DeclarationName getDeclName() const
Get the actual, stored name of the declaration, which may be a special name.
Definition Decl.h:340
Represents a parameter to a function.
Definition Decl.h:1819
const StackFrame * getStackFrame() const
std::optional< T > getAs() const
Convert to the specified ProgramPoint type, returning std::nullopt if this ProgramPoint is not of the...
A (possibly-)qualified type.
Definition TypeBase.h:938
bool isNull() const
Return true if this QualType doesn't point to a type yet.
Definition TypeBase.h:1005
QualType getCanonicalType() const
Definition TypeBase.h:8553
bool isConstQualified() const
Determine whether this type is const-qualified.
Definition TypeBase.h:8574
ReturnStmt - This represents a return, optionally of an expression: return; return 4;.
Definition Stmt.h:3169
Expr * getRetValue()
Definition Stmt.h:3196
bool isInSystemHeader(SourceLocation Loc) const
Returns if a SourceLocation is in a system header.
It represents a stack frame of the call stack.
unsigned getIndex() const
LLVM_ATTRIBUTE_RETURNS_NONNULL AnalysisDeclContext * getAnalysisDeclContext() const
const Expr * getCallSite() const
const Decl * getDecl() const
const StackFrame * getParent() const
It might return null.
const CFGBlock * getCallSiteBlock() const
Stmt - This represents one statement.
Definition Stmt.h:85
bool isVoidType() const
Definition TypeBase.h:9110
bool isPointerType() const
Definition TypeBase.h:8738
CanQualType getCanonicalTypeUnqualified() const
bool isReferenceType() const
Definition TypeBase.h:8762
const CXXRecordDecl * getPointeeCXXRecordDecl() const
If this is a pointer or reference to a RecordType, return the CXXRecordDecl that the type refers to.
Definition Type.cpp:1958
QualType getPointeeType() const
If this is a pointer, ObjC object pointer, or block pointer, this returns the respective pointee.
Definition Type.cpp:789
bool isObjCObjectPointerType() const
Definition TypeBase.h:8917
AnalysisDeclContext * getAnalysisDeclContext(const Decl *D)
Represents a call to a C++ constructor.
Definition CallEvent.h:990
const CXXConstructorDecl * getDecl() const override
Returns the declaration of the function or method that will be called.
Definition CallEvent.h:1021
const CXXConstructExpr * getOriginExpr() const override
Returns the expression whose value will be the result of this call.
Definition CallEvent.h:1017
Represents a non-static C++ member function call, no matter how it is written.
Definition CallEvent.h:686
const FunctionDecl * getDecl() const override
Returns the declaration of the function or method that will be called.
Manages the lifetime of CallEvent objects.
Definition CallEvent.h:1363
CallEventRef getCaller(const StackFrame *CalleeSF, ProgramStateRef State)
Gets an outside caller given a callee context.
CallEventRef getSimpleCall(const CallExpr *E, ProgramStateRef State, const StackFrame *SF, CFGBlock::ConstCFGElementRef ElemRef)
Represents an abstract call to a function or method along a particular path.
Definition CallEvent.h:152
CallEventRef< T > cloneWithState(ProgramStateRef NewState) const
Returns a copy of this CallEvent, but using the given state.
Definition CallEvent.h:1479
static QualType getDeclaredResultType(const Decl *D)
Returns the result type of a function or method declaration.
static bool isVariadic(const Decl *D)
Returns true if the given decl is known to be variadic.
void runCheckersForPreCall(ExplodedNodeSet &Dst, const ExplodedNodeSet &Src, const CallEvent &Call, ExprEngine &Eng)
Run checkers for pre-visiting function calls (including methods, constructors, destructors etc.
void runCheckersForEvalCall(ExplodedNodeSet &Dst, const ExplodedNodeSet &Src, const CallEvent &CE, ExprEngine &Eng, const EvalCallOptions &CallOpts)
Run checkers for evaluating a call.
void runCheckersForPostObjCMessage(ExplodedNodeSet &Dst, const ExplodedNodeSet &Src, const ObjCMethodCall &msg, ExprEngine &Eng, bool wasInlined=false)
Run checkers for post-visiting obj-c messages.
void runCheckersForPostStmt(ExplodedNodeSet &Dst, const ExplodedNodeSet &Src, const Stmt *S, ExprEngine &Eng, bool wasInlined=false)
Run checkers for post-visiting Stmts.
void runCheckersForNewAllocator(const CXXAllocatorCall &Call, ExplodedNodeSet &Dst, ExplodedNode *Pred, ExprEngine &Eng, bool wasInlined=false)
Run checkers between C++ operator new and constructor calls.
void runCheckersForPreStmt(ExplodedNodeSet &Dst, const ExplodedNodeSet &Src, const Stmt *S, ExprEngine &Eng)
Run checkers for pre-visiting Stmts.
void runCheckersForPostCall(ExplodedNodeSet &Dst, const ExplodedNodeSet &Src, const CallEvent &Call, ExprEngine &Eng, bool wasInlined=false)
Run checkers for post-visiting function calls (including methods, constructors, destructors etc.
WorkList * getCTUWorkList() const
Definition CoreEngine.h:162
WorkList * getWorkList() const
Definition CoreEngine.h:161
ExplodedNode * makeNode(const ProgramPoint &Loc, ProgramStateRef State, ExplodedNode *Pred, bool MarkAsSink=false) const
ExplodedNodeSet is a set of ExplodedNode * elements with the invariant that its elements cannot be nu...
void insert(ExplodedNode *N)
const ProgramStateRef & getState() const
ProgramPoint getLocation() const
getLocation - Returns the edge associated with the given node.
void addPredecessor(ExplodedNode *V, ExplodedGraph &G)
addPredeccessor - Adds a predecessor to the current node, and in tandem add this node as a successor ...
std::optional< T > getLocationAs() const &
llvm::iterator_range< StackFrame::parent_iterator > stackframes() const
Iterates over the current stack frame and all of its ancestors.
ExplodedNode * getFirstPred()
const StackFrame * getStackFrame() const
ProgramStateManager & getStateManager()
Definition ExprEngine.h:476
void removeDead(ExplodedNode *Node, ExplodedNodeSet &Out, const Stmt *ReferenceStmt, const StackFrame *SF, const Stmt *DiagnosticStmt=nullptr, ProgramPoint::Kind K=ProgramPoint::PreStmtPurgeDeadSymbolsKind)
Run the analyzer's garbage collection - remove dead symbols and bindings from the state.
void removeDeadOnEndOfFunction(ExplodedNode *Pred, ExplodedNodeSet &Dst)
Remove dead bindings/symbols before exiting a function.
void VisitReturnStmt(const ReturnStmt *R, ExplodedNode *Pred, ExplodedNodeSet &Dst)
VisitReturnStmt - Transfer function logic for return statements.
void processCallEnter(CallEnter CE, ExplodedNode *Pred)
Generate the entry node of the callee.
void processCallExit(ExplodedNode *Pred)
Generate the sequence of nodes that simulate the call exit and the post visit for CallExpr.
CFGElement getCurrentCFGElement()
Return the CFG element corresponding to the worklist element that is currently being processed by Exp...
Definition ExprEngine.h:767
static std::optional< unsigned > getIndexOfElementToConstruct(ProgramStateRef State, const CXXConstructExpr *E, const StackFrame *SF)
Retrieves which element is being constructed in a non-POD type array.
@ Inline_Minimal
Do minimal inlining of callees.
Definition ExprEngine.h:130
ProgramStateRef bindReturnValue(const CallEvent &Call, const StackFrame *SF, ProgramStateRef State)
Create a new state in which the call return value is binded to the call origin expression.
static std::optional< unsigned > getPendingInitLoop(ProgramStateRef State, const CXXConstructExpr *E, const StackFrame *SF)
Retrieves the size of the array in the pending ArrayInitLoopExpr.
void setCurrStackFrameAndBlock(const StackFrame *SF, const CFGBlock *B)
Definition ExprEngine.h:244
void VisitCallExpr(const CallExpr *CE, ExplodedNode *Pred, ExplodedNodeSet &Dst)
VisitCall - Transfer function for function calls.
ASTContext & getContext() const
getContext - Return the ASTContext associated with this analysis.
Definition ExprEngine.h:214
StoreManager & getStoreManager()
Definition ExprEngine.h:479
void evalCall(ExplodedNodeSet &Dst, ExplodedNode *Pred, const CallEvent &Call)
Evaluate a call, running pre- and post-call checkers and allowing checkers to be responsible for hand...
void defaultEvalCall(ExplodedNodeSet &Dst, ExplodedNode *Pred, const CallEvent &Call, const EvalCallOptions &CallOpts={})
Default implementation of call evaluation.
ConstCFGElementRef getCFGElementRef() const
Definition ExprEngine.h:290
static std::optional< unsigned > getPendingArrayDestruction(ProgramStateRef State, const StackFrame *SF)
Retrieves which element is being destructed in a non-POD type array.
ProgramStateRef processPointerEscapedOnBind(ProgramStateRef State, ArrayRef< std::pair< SVal, SVal > > LocAndVals, const StackFrame *SF, PointerEscapeKind Kind, const CallEvent *Call)
Call PointerEscape callback when a value escapes as a result of bind.
CheckerManager & getCheckerManager() const
Definition ExprEngine.h:223
static std::optional< SVal > getObjectUnderConstruction(ProgramStateRef State, const ConstructionContextItem &Item, const StackFrame *SF)
By looking at a certain item that may be potentially part of an object's ConstructionContext,...
void processBeginOfFunction(ExplodedNode *Pred, ExplodedNodeSet &Dst, const BlockEdge &L)
Called by CoreEngine.
unsigned getNumVisitedCurrent() const
Definition ExprEngine.h:299
AnalysisManager & getAnalysisManager()
Definition ExprEngine.h:216
std::pair< ProgramStateRef, SVal > handleConstructionContext(const Expr *E, ProgramStateRef State, const NodeBuilderContext *BldrCtx, const StackFrame *SF, const ConstructionContext *CC, EvalCallOptions &CallOpts, unsigned Idx=0)
A convenient wrapper around computeObjectUnderConstruction and updateObjectsUnderConstruction.
Definition ExprEngine.h:816
const CFGBlock * getCurrBlock() const
Get the 'current' CFGBlock corresponding to the current work item (elementary analysis step handled b...
Definition ExprEngine.h:286
MemRegion - The root abstract class for all memory regions.
Definition MemRegion.h:97
LLVM_ATTRIBUTE_RETURNS_NONNULL const MemRegion * StripCasts(bool StripBaseAndDerivedCasts=true) const
Represents any expression that calls an Objective-C method.
Definition CallEvent.h:1251
CallEventManager & getCallEventManager()
Information about invalidation for a particular region/symbol.
Definition MemRegion.h:1663
void setTrait(SymbolRef Sym, InvalidationKinds IK)
Defines the runtime definition of the called function.
Definition CallEvent.h:109
const MemRegion * getDispatchRegion()
When other definitions are possible, returns the region whose runtime type determines the method defi...
Definition CallEvent.h:140
bool mayHaveOtherDefinitions()
Check if the definition we have is precise.
Definition CallEvent.h:136
SVal - This represents a symbolic expression, which can be either an L-value or an R-value.
Definition SVals.h:57
QualType getType(const ASTContext &) const
Try to get a reasonable type for the given value.
Definition SVals.cpp:180
T castAs() const
Convert to the specified SVal type, asserting that this SVal is of the desired type.
Definition SVals.h:84
SVal evalDerivedToBase(SVal Derived, const CastExpr *Cast)
Evaluates a chain of derived-to-base casts through the path specified in Cast.
Definition Store.cpp:254
virtual void enqueue(const WorkListUnit &U)=0
LLVM_ATTRIBUTE_RETURNS_NONNULL const MemRegion * getRegion() const
Get the underlining region.
Definition SVals.h:499
@ PSK_EscapeOutParameters
Escape for a new symbol that was generated into a region that the analyzer cannot follow during a con...
DefinedOrUnknownSVal getDynamicElementCount(ProgramStateRef State, const MemRegion *MR, SValBuilder &SVB, QualType Ty)
IntrusiveRefCntPtr< const ProgramState > ProgramStateRef
ProgramStateRef setDynamicExtent(ProgramStateRef State, const MemRegion *MR, DefinedOrUnknownSVal Extent)
Set the dynamic extent Extent of the region MR.
@ CE_CXXInheritedConstructor
Definition CallEvent.h:68
@ CE_CXXStaticOperator
Definition CallEvent.h:61
@ CE_CXXDestructor
Definition CallEvent.h:64
@ CE_CXXDeallocator
Definition CallEvent.h:72
@ CE_CXXAllocator
Definition CallEvent.h:71
@ CE_CXXConstructor
Definition CallEvent.h:67
@ CE_CXXMemberOperator
Definition CallEvent.h:63
DefinedOrUnknownSVal getElementExtent(QualType Ty, SValBuilder &SVB)
std::variant< struct RequiresDecl, struct HeaderDecl, struct UmbrellaDirDecl, struct ModuleDecl, struct ExcludeDecl, struct ExportDecl, struct ExportAsDecl, struct ExternModuleDecl, struct UseDecl, struct LinkDecl, struct ConfigMacrosDecl, struct ConflictDecl > Decl
All declarations that can appear in a module declaration.
The JSON file list parser is used to communicate input to InstallAPI.
bool isa(CodeGen::Address addr)
Definition Address.h:330
CFGBlock::ConstCFGElementRef ConstCFGElementRef
Definition CFG.h:1248
@ ExpectedClass
@ IPAK_DynamicDispatch
Enable inlining of dynamically dispatched methods.
@ IPAK_DynamicDispatchBifurcate
Enable inlining of dynamically dispatched methods, bifurcate paths when exact type info is unavailabl...
@ CIMK_Destructors
Refers to destructors (implicit or explicit).
@ CIMK_MemberFunctions
Refers to regular member function and operator calls.
@ CIMK_Constructors
Refers to constructors (implicit or explicit).
U cast(CodeGen::Address addr)
Definition Address.h:327
unsigned long uint64_t
Hints for figuring out if a call should be inlined during evalCall().
Definition ExprEngine.h:93
bool IsTemporaryLifetimeExtendedViaAggregate
This call is a constructor for a temporary that is lifetime-extended by binding it to a reference-typ...
Definition ExprEngine.h:108
bool IsTemporaryCtorOrDtor
This call is a constructor or a destructor of a temporary value.
Definition ExprEngine.h:103
bool IsArrayCtorOrDtor
This call is a constructor or a destructor for a single element within an array, a part of array cons...
Definition ExprEngine.h:100
bool IsCtorOrDtorWithImproperlyModeledTargetRegion
This call is a constructor or a destructor for which we do not currently compute the this-region corr...
Definition ExprEngine.h:96
Traits for storing the call processing policy inside GDM.