Static Value-Flow Analysis
Loading...
Searching...
No Matches
SVFIRBuilder.cpp
Go to the documentation of this file.
1//===- SVFIRBuilder.cpp -- SVFIR builder-----------------------------------------//
2//
3// SVF: Static Value-Flow Analysis
4//
5// Copyright (C) <2013-2017> <Yulei Sui>
6//
7
8// This program is free software: you can redistribute it and/or modify
9// it under the terms of the GNU Affero General Public License as published by
10// the Free Software Foundation, either version 3 of the License, or
11// (at your option) any later version.
12
13// This program is distributed in the hope that it will be useful,
14// but WITHOUT ANY WARRANTY; without even the implied warranty of
15// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16// GNU Affero General Public License for more details.
17
18// You should have received a copy of the GNU Affero General Public License
19// along with this program. If not, see <http://www.gnu.org/licenses/>.
20//
21//===----------------------------------------------------------------------===//
22
23/*
24 * SVFIRBuilder.cpp
25 *
26 * Created on: Nov 1, 2013
27 * Author: Yulei Sui
28 * Refactored on: Jan 25, 2024
29 * Author: Xiao Cheng, Yulei Sui
30 */
31
33#include "SVF-LLVM/BasicTypes.h"
34#include "SVF-LLVM/CHGBuilder.h"
35#include "SVF-LLVM/CppUtil.h"
37#include "SVF-LLVM/LLVMUtil.h"
42#include "Graphs/CallGraph.h"
43#include "Util/Options.h"
44#include "Util/SVFUtil.h"
45
46using namespace std;
47using namespace SVF;
48using namespace SVFUtil;
49using namespace LLVMUtil;
50
51
56{
57 double startTime = SVFStat::getClk(true);
58
59 DBOUT(DGENERAL, outs() << pasMsg("\t Building SVFIR ...\n"));
60
61 // If the SVFIR has been built before, then we return the unique SVFIR of the program
63 return pag;
64
65
67
70 pag->icfg = icfgbuilder.build();
71
79
80
81
84 std::vector<const FunObjVar*> funset;
85 for (const auto& item: llvmModuleSet()->getFunctionSet())
86 {
88 }
89 pag->callGraph = callGraphBuilder.buildSVFIRCallGraph(funset);
90
91 CHGraph* chg = new CHGraph();
93 chgbuilder.buildCHG();
94 pag->setCHG(chg);
95
98 {
99 for (Module::const_iterator F = M.begin(), E = M.end(); F != E; ++F)
100 {
101 const Function& fun = *F;
102 const FunObjVar* svffun = llvmModuleSet()->getFunObjVar(&fun);
104 if(!fun.isDeclaration())
105 {
111 if (fun.doesNotReturn() == false &&
112 fun.getReturnType()->isVoidTy() == false)
113 {
116 }
117
120 for (Function::const_arg_iterator I = fun.arg_begin(), E = fun.arg_end();
121 I != E; ++I)
122 {
123 setCurrentLocation(&*I,&fun.getEntryBlock());
125 // if this is the function does not have caller (e.g. main)
126 // or a dead function, shall we create a black hole address edge for it?
127 // it is (1) too conservative, and (2) make FormalParmVFGNode defined at blackhole address PAGEdge.
128 // if(SVFUtil::ArgInNoCallerFunction(&*I)) {
129 // if(I->getType()->isPointerTy())
130 // addBlackHoleAddrEdge(argValNodeId);
131 //}
133 }
134 }
135 for (Function::const_iterator bit = fun.begin(), ebit = fun.end();
136 bit != ebit; ++bit)
137 {
138 const BasicBlock& bb = *bit;
139 for (BasicBlock::const_iterator it = bb.begin(), eit = bb.end();
140 it != eit; ++it)
141 {
142 const Instruction& inst = *it;
143 setCurrentLocation(&inst,&bb);
144 visit(const_cast<Instruction&>(inst));
145 }
146 }
147 }
148 }
149
150 sanityCheck();
151
153
155
156 // dump SVFIR
158 pag->dump("svfir_initial");
159
160 // print to command line of the SVFIR graph
161 if (Options::PAGPrint())
162 pag->print();
163
164 // dump ICFG
165 if (Options::DumpICFG())
166 pag->getICFG()->dump("icfg_initial");
167
169 {
172 }
173
174 // dump SVFIR as JSON
175 if (!Options::DumpJson().empty())
176 {
177 assert(false && "please implement SVFIRWriter::writeJsonToPath");
178 }
179
180 double endTime = SVFStat::getClk(true);
181 SVFStat::timeOfBuildingSVFIR = (endTime - startTime) / TIMEINTERVAL;
182
183 return pag;
184}
185
187{
189 {
191 for (const Function& f : mod.functions())
192 {
195
196 if (!LLVMUtil::isExtCall(&f))
197 {
199 }
202 svffun->setRelDefFun(realfun == nullptr ? nullptr : llvmModuleSet()->getFunObjVar(realfun));
203 }
204 }
205
206 // Store annotations of functions in extapi.bc
207 for (const auto& pair : llvmModuleSet()->ExtFun2Annotations)
208 {
210 }
211
212}
213
215{
217 for (Function::const_iterator bit = func->begin(), ebit = func->end(); bit != ebit; ++bit)
218 {
219 const BasicBlock* bb = &*bit;
222 {
225 }
227 {
230 }
231
233 if (svfbb->getSuccessors().empty())
234 {
236 {
238 SVFUtil::isa<ReturnInst>(bb->back())) &&
239 "last inst must be return inst");
240 svfFun->setExitBlock(svfbb);
241 }
242 }
243 }
244 // For no return functions, we set the last block as exit BB
245 // This ensures that each function that has definition must have an exit BB
246 if (svfFun->hasBasicBlock() && svfFun->exitBlock == nullptr)
247 {
248 SVFBasicBlock* retBB = const_cast<SVFBasicBlock*>(svfFun->back());
250 SVFUtil::isa<ReturnInst>(&func->back().back())) &&
251 "last inst must be return inst");
252 svfFun->setExitBlock(retBB);
253 }
254}
255
256
258{
259 if (fun->isDeclaration())
260 return;
261 //process and stored dt & df
264 df.analyze(dt);
266 PostDominatorTree pdt = PostDominatorTree(const_cast<Function&>(*fun));
267 SVFLoopAndDomInfo* ld = svffun->getLoopAndDomInfo();
268
270 for (DominanceFrontierBase::const_iterator dfIter = df.begin(), eDfIter = df.end(); dfIter != eDfIter; dfIter++)
271 {
272 const BasicBlock* keyBB = dfIter->first;
273#if LLVM_VERSION_MAJOR > 16
274 const llvm::SetVector<llvm::BasicBlock* >& domSet = dfIter->second;
275#else
276 const std::set<BasicBlock* >& domSet = dfIter->second;
277#endif
279 for (const BasicBlock* bbValue:domSet)
280 {
282 }
283 }
284 std::vector<const SVFBasicBlock*> reachableBBs;
285 LLVMUtil::getFunReachableBBs(fun, reachableBBs);
286 ld->setReachableBBs(reachableBBs);
287
288 for (Function::const_iterator bit = fun->begin(), beit = fun->end(); bit!=beit; ++bit)
289 {
290 const BasicBlock &bb = *bit;
292 if (DomTreeNode* dtNode = dt.getNode(&bb))
293 {
294 SVFLoopAndDomInfo::BBSet& bbSet = ld->getDomTreeMap()[svfBB];
295 for (const auto domBB : *dtNode)
296 {
297 const auto* domSVFBB = llvmModuleSet()->getSVFBasicBlock(domBB->getBlock());
298 bbSet.insert(domSVFBB);
299 }
300 }
301
302 if (DomTreeNode* pdtNode = pdt.getNode(&bb))
303 {
304 u32_t level = pdtNode->getLevel();
305 ld->getBBPDomLevel()[svfBB] = level;
306 BasicBlock* idomBB = pdtNode->getIDom()->getBlock();
308 ld->getBB2PIdom()[svfBB] = idom;
309
310 SVFLoopAndDomInfo::BBSet& bbSet = ld->getPostDomTreeMap()[svfBB];
311 for (const auto domBB : *pdtNode)
312 {
313 const auto* domSVFBB = llvmModuleSet()->getSVFBasicBlock(domBB->getBlock());
314 bbSet.insert(domSVFBB);
315 }
316 }
317
318 if (const Loop* loop = loopInfo.getLoopFor(&bb))
319 {
320 for (const BasicBlock* loopBlock : loop->getBlocks())
321 {
323 ld->addToBB2LoopMap(svfBB, loopbb);
324 }
325 }
326 }
327}
328
330{
331 std::vector<FunObjVar*> funset;
332 // Iterate over all object symbols in the symbol table
333 for (const auto* fun: llvmModuleSet()->getFunctionSet())
334 {
335 u32_t id = llvmModuleSet()->objSyms()[fun];
336 // Debug output for adding object node
337 DBOUT(DPAGBuild, outs() << "add obj node " << id << "\n");
338
339 // Check if the value is a function and add a function object node
340 pag->addFunObjNode(id, pag->getObjTypeInfo(id), nullptr);
342
343 FunObjVar *funObjVar = SVFUtil::cast<FunObjVar>(pag->getGNode(id));
344 funset.push_back(funObjVar);
345
346 funObjVar->initFunObjVar(fun->isDeclaration(), LLVMUtil::isIntrinsicFun(fun), fun->hasAddressTaken(),
348 SVFUtil::cast<SVFFunctionType>(llvmModuleSet()->getSVFType(fun->getFunctionType())),
349 new SVFLoopAndDomInfo, nullptr, nullptr,
350 {}, nullptr);
351 BasicBlockGraph* bbGraph = new BasicBlockGraph();
352 funObjVar->setBasicBlockGraph(bbGraph);
353
354
355 for (const BasicBlock& bb : *fun)
356 {
357 llvmModuleSet()->addBasicBlock(funObjVar, &bb);
358 }
359
361 for (auto& bb: *funObjVar->bbGraph)
362 {
363 bb.second->setFun(funObjVar);
364 }
366 }
367
369}
370
372{
373 // Iterate over all object symbols in the symbol table
374 for (LLVMModuleSet::ValueToIDMapTy::iterator iter =
375 llvmModuleSet()->objSyms().begin(); iter != llvmModuleSet()->objSyms().end();
376 ++iter)
377 {
378 // Debug output for adding object node
379 DBOUT(DPAGBuild, outs() << "add obj node " << iter->second << "\n");
380
381 // Skip blackhole and constant symbols
382 if(iter->second == pag->blackholeSymID() || iter->second == pag->constantSymID())
383 continue;
384
385 // Get the LLVM value corresponding to the symbol
386 const Value* llvmValue = iter->first;
387
388 const ICFGNode* icfgNode = nullptr;
389 if (const Instruction* inst = SVFUtil::dyn_cast<Instruction>(llvmValue))
390 {
391 if(llvmModuleSet()->hasICFGNode(inst))
392 icfgNode = llvmModuleSet()->getICFGNode(inst);
393 }
394
395 // Check if the value is a function and add a function object node
396 if (SVFUtil::dyn_cast<Function>(llvmValue))
397 {
398 // already one
399 }
400 // Check if the value is a heap object and add a heap object node
402 {
403 NodeID id = llvmModuleSet()->getObjectNode(iter->first);
404 pag->addHeapObjNode(iter->second, pag->getObjTypeInfo(id), icfgNode);
405 }
406 // Check if the value is an alloca instruction and add a stack object node
408 {
409 NodeID id = llvmModuleSet()->getObjectNode(iter->first);
410 pag->addStackObjNode(iter->second, pag->getObjTypeInfo(id), icfgNode);
411 }
412 else if (auto fpValue = SVFUtil::dyn_cast<ConstantFP>(llvmValue))
413 {
414 NodeID id = llvmModuleSet()->getObjectNode(iter->first);
416 }
417 else if (auto intValue = SVFUtil::dyn_cast<ConstantInt>(llvmValue))
418 {
419 NodeID id = llvmModuleSet()->getObjectNode(iter->first);
421 }
422 else if (SVFUtil::isa<ConstantPointerNull>(llvmValue))
423 {
424 NodeID id = llvmModuleSet()->getObjectNode(iter->first);
425 pag->addConstantNullPtrObjNode(iter->second, pag->getObjTypeInfo(id), icfgNode);
426 }
427 else if (SVFUtil::isa<GlobalValue>(llvmValue))
428 {
429 NodeID id = llvmModuleSet()->getObjectNode(iter->first);
430 pag->addGlobalObjNode(iter->second, pag->getObjTypeInfo(id), icfgNode);
431 }
432 else if (SVFUtil::isa<ConstantData, ConstantExpr, MetadataAsValue, BlockAddress>(llvmValue))
433 {
434 NodeID id = llvmModuleSet()->getObjectNode(iter->first);
435 pag->addConstantDataObjNode(iter->second, pag->getObjTypeInfo(id), icfgNode);
436 }
437 else if (SVFUtil::isa<ConstantAggregate>(llvmValue))
438 {
439 NodeID id = llvmModuleSet()->getObjectNode(iter->first);
440 pag->addConstantAggObjNode(iter->second, pag->getObjTypeInfo(id), icfgNode);
441 }
442 // Add a generic object node for other types of values
443 else
444 {
445 NodeID id = llvmModuleSet()->getObjectNode(iter->first);
446 pag->addObjNode(iter->second, pag->getObjTypeInfo(id), icfgNode);
447 }
449 }
450
451}
452
454{
455 // Iterate over all value symbols in the symbol table
456 for (LLVMModuleSet::ValueToIDMapTy::iterator iter =
457 llvmModuleSet()->valSyms().begin(); iter != llvmModuleSet()->valSyms().end();
458 ++iter)
459 {
460 // Debug output for adding value node
461 DBOUT(DPAGBuild, outs() << "add val node " << iter->second << "\n");
462
463 // Skip blackhole and null pointer symbols
464 if(iter->second == pag->blkPtrSymID() || iter->second == pag->nullPtrSymID())
465 continue;
466
467 const ICFGNode* icfgNode = nullptr;
468 auto llvmValue = iter->first;
469
470 // Check if the value is a function and get its call graph node
471 if (const Function* func = SVFUtil::dyn_cast<Function>(llvmValue))
472 {
473 pag->addFunValNode(iter->second, icfgNode, llvmModuleSet()->getFunObjVar(func), llvmModuleSet()->getSVFType(llvmValue->getType()));
474 }
475 else if (auto argval = SVFUtil::dyn_cast<Argument>(llvmValue))
476 {
477 // Formal params are defined at FunEntryICFGNode (where CallPE copies actual args).
478 // External (declaration-only) functions have no entry node, so keep nullptr.
479 const FunObjVar* funObj = llvmModuleSet()->getFunObjVar(argval->getParent());
480 const ICFGNode* entryNode = funObj->isDeclaration() ? nullptr : pag->getICFG()->getFunEntryICFGNode(funObj);
482 iter->second, argval->getArgNo(), entryNode,
483 funObj, llvmModuleSet()->getSVFType(llvmValue->getType()));
484 if (!argval->hasName())
485 pag->getGNode(iter->second)->setName("arg_" + std::to_string(argval->getArgNo()));
486 }
487 else if (auto fpValue = SVFUtil::dyn_cast<ConstantFP>(llvmValue))
488 {
489 pag->addConstantFPValNode(iter->second, LLVMUtil::getDoubleValue(fpValue), icfgNode, llvmModuleSet()->getSVFType(llvmValue->getType()));
490 }
491 else if (auto intValue = SVFUtil::dyn_cast<ConstantInt>(llvmValue))
492 {
493 pag->addConstantIntValNode(iter->second, LLVMUtil::getIntegerValue(intValue), icfgNode, llvmModuleSet()->getSVFType(llvmValue->getType()));
494 }
495 else if (SVFUtil::isa<ConstantPointerNull>(llvmValue))
496 {
497 pag->addConstantNullPtrValNode(iter->second, icfgNode, llvmModuleSet()->getSVFType(llvmValue->getType()));
498 }
499 else if (SVFUtil::isa<GlobalValue>(llvmValue))
500 {
501 // Global variables are defined at the global ICFG node.
503 llvmModuleSet()->getSVFType(llvmValue->getType()));
504 }
505 else if (SVFUtil::isa<ConstantData, ConstantExpr, MetadataAsValue, BlockAddress>(llvmValue))
506 {
507 pag->addConstantDataValNode(iter->second, icfgNode, llvmModuleSet()->getSVFType(llvmValue->getType()));
508 }
509 else if (SVFUtil::isa<ConstantAggregate>(llvmValue))
510 {
511 pag->addConstantAggValNode(iter->second, icfgNode, llvmModuleSet()->getSVFType(llvmValue->getType()));
512 }
513 else if (SVFUtil::isa<BasicBlock>(llvmValue))
514 {
515 pag->addBasicBlockValNode(iter->second, llvmModuleSet()->getSVFType(llvmValue->getType()));
516 }
517 else if (SVFUtil::isa<InlineAsm>(llvmValue) ||
518 SVFUtil::isa<DSOLocalEquivalent>(llvmValue) ||
519 SVFUtil::isa<NoCFIValue>(llvmValue))
520 {
521 pag->addAsmPCValNode(iter->second, llvmModuleSet()->getSVFType(llvmValue->getType()));
522 }
523 else if (const Instruction* inst = SVFUtil::dyn_cast<Instruction>(llvmValue))
524 {
526 pag->addIntrinsicValNode(iter->second, llvmModuleSet()->getSVFType(llvmValue->getType()));
527 else
528 {
529 assert(llvmModuleSet()->hasICFGNode(inst) && "LLVM instruction is not associated with an ICFGNode");
530 icfgNode = llvmModuleSet()->getICFGNode(inst);
531 pag->addValNode(iter->second, llvmModuleSet()->getSVFType(llvmValue->getType()), icfgNode);
532 }
533 }
535 pag->getGNode(iter->second));
536 }
537}
538
539
540/*
541 * Initial all the nodes from symbol table
542 */
544{
545 DBOUT(DPAGBuild, outs() << "Initialise SVFIR Nodes ...\n");
546
547
552
555
556 for (LLVMModuleSet::FunToIDMapTy::iterator iter =
557 llvmModuleSet()->retSyms().begin(); iter != llvmModuleSet()->retSyms().end();
558 ++iter)
559 {
560 const Value* llvmValue = iter->first;
561 // retSyms keys are Function*, not Instruction, so dyn_cast<Instruction> always fails.
562 // RetValPN represents the callee's return value, defined at FunExitICFGNode.
563 // External functions have no exit node, so keep nullptr.
564 const FunObjVar* funObjVar = llvmModuleSet()->getFunObjVar(SVFUtil::cast<Function>(llvmValue));
565 const ICFGNode* icfgNode = funObjVar->isDeclaration() ? nullptr : pag->getICFG()->getFunExitICFGNode(funObjVar);
566 DBOUT(DPAGBuild, outs() << "add ret node " << iter->second << "\n");
567 pag->addRetNode(iter->second,
568 funObjVar,
569 llvmModuleSet()->getSVFType(iter->first->getType()), icfgNode);
571 pag->returnFunObjSymMap[funObjVar] = iter->second;
572 }
573
574 for (LLVMModuleSet::FunToIDMapTy::iterator iter =
575 llvmModuleSet()->varargSyms().begin();
576 iter != llvmModuleSet()->varargSyms().end(); ++iter)
577 {
578 const Value* llvmValue = iter->first;
579 // varargSyms keys are Function*, not Instruction.
580 // Variadic arguments are received at the function entry point.
581 // External functions have no entry node, so keep nullptr.
582 const FunObjVar* funObjVar = llvmModuleSet()->getFunObjVar(SVFUtil::cast<Function>(llvmValue));
583 const ICFGNode* icfgNode = funObjVar->isDeclaration() ? nullptr : pag->getICFG()->getFunEntryICFGNode(funObjVar);
584 DBOUT(DPAGBuild, outs() << "add vararg node " << iter->second << "\n");
585 pag->addVarargNode(iter->second,
586 funObjVar,
587 llvmModuleSet()->getSVFType(iter->first->getType()), icfgNode);
589 pag->varargFunObjSymMap[funObjVar] = iter->second;
590 }
591
593 for (LLVMModuleSet::ValueToIDMapTy::iterator iter =
594 llvmModuleSet()->objSyms().begin(); iter != llvmModuleSet()->objSyms().end(); ++iter)
595 {
596 DBOUT(DPAGBuild, outs() << "add address edges for constant node " << iter->second << "\n");
597 const Value* val = iter->first;
599 {
601 if(ptr!= pag->getBlkPtr() && ptr!= pag->getNullPtr())
602 {
604 addAddrEdge(iter->second, ptr);
605 }
606 }
607 }
608
610 && "not all node have been initialized!!!");
611
613 for (auto& fun: llvmModuleSet()->getFunctionSet())
614 {
615 for (const Argument& arg : fun->args())
616 {
617 const_cast<FunObjVar*>(llvmModuleSet()->getFunObjVar(fun))->addArgument(SVFUtil::cast<ArgValVar>(
619 }
620 }
621
622}
623
624/*
625 https://github.com/SVF-tools/SVF/issues/524
626 Handling single value types, for constant index, including pointer, integer, etc
627 e.g. field_idx = getelementptr i8, %i8* %p, i64 -4
628 We can obtain the field index by inferring the byteoffset if %p is casted from a pointer to a struct
629 For another example, the following can be an array access.
630 e.g. field_idx = getelementptr i8, %struct_type %p, i64 1
631
632*/
634{
635 return 0;
636}
637
645{
646 assert(V);
647
648 const llvm::GEPOperator *gepOp = SVFUtil::dyn_cast<const llvm::GEPOperator>(V);
649 DataLayout * dataLayout = getDataLayout(llvmModuleSet()->getMainLLVMModule());
650 llvm::APInt byteOffset(dataLayout->getIndexSizeInBits(gepOp->getPointerAddressSpace()),0,true);
651 if(gepOp && dataLayout && gepOp->accumulateConstantOffset(*dataLayout,byteOffset))
652 {
653 //s32_t bo = byteOffset.getSExtValue();
654 }
655
656 bool isConst = true;
657
658 bool prevPtrOperand = false;
659 for (bridge_gep_iterator gi = bridge_gep_begin(*V), ge = bridge_gep_end(*V);
660 gi != ge; ++gi)
661 {
662 const Type* gepTy = *gi;
664
665 assert((prevPtrOperand && svfGepTy->isPointerTy()) == false &&
666 "Expect no more than one gep operand to be of a pointer type");
667 if(!prevPtrOperand && svfGepTy->isPointerTy()) prevPtrOperand = true;
668 const Value* offsetVal = gi.getOperand();
669 assert(gepTy != offsetVal->getType() && "iteration and operand have the same type?");
670
671 const ArrayType* inferredPtrArrayTy = nullptr;
672 const SVFType* idxGepTy = svfGepTy;
673 if (svfGepTy->isPointerTy() && gepOp->getSourceElementType()->isSingleValueType())
674 {
675 const Type* baseObjType =
677 if (const auto* arrTy = SVFUtil::dyn_cast<ArrayType>(baseObjType))
678 {
679 if (arrTy->getElementType()->isPointerTy())
680 {
683 }
684 }
685 }
686
688
689 //The int value of the current index operand
690 const ConstantInt* op = SVFUtil::dyn_cast<ConstantInt>(offsetVal);
691
692 // if Options::ModelConsts() is disabled. We will treat whole array as one,
693 // but we can distinguish different field of an array of struct, e.g. s[1].f1 is different from s[0].f2
694 if(const ArrayType* arrTy = SVFUtil::dyn_cast<ArrayType>(gepTy))
695 {
696 if (!Options::ModelArrays() && arrTy->getElementType()->isPointerTy())
697 continue;
698 if(!op || (arrTy->getArrayNumElements() <= (u32_t)LLVMUtil::getIntegerValue(op).first))
699 continue;
703 }
704 else if (const StructType *ST = SVFUtil::dyn_cast<StructType>(gepTy))
705 {
706 assert(op && "non-const offset accessing a struct");
707 // guard against negative or out-of-bounds struct indices
708 // (e.g. rust hashbrown bucket back-offset: gep { ... }, ptr %p, i64 -1)
709 // a negative i64 wraps to a huge uint64_t that overflows u32_t,
710 // creating an invalid field index that severs points-to tracking
712 if (rawIdx >= ST->getNumElements())
713 {
714 isConst = false;
715 continue;
716 }
720 }
721 else if (gepTy->isSingleValueType())
722 {
724 {
725 if (!op || (inferredPtrArrayTy->getArrayNumElements() <= (u32_t)LLVMUtil::getIntegerValue(op).first))
726 continue;
730 continue;
731 }
732 // If it's a non-constant offset access
733 // If its point-to target is struct or array, it's likely an array accessing (%result = gep %struct.A* %a, i32 %non-const-index)
734 // If its point-to target is single value (pointer arithmetic), then it's a variant gep (%result = gep i8* %p, i32 %non-const-index)
735 if(!op && gepTy->isPointerTy() && gepOp->getSourceElementType()->isSingleValueType())
736 {
737 isConst = false;
738 }
739
740 // The actual index
741 //s32_t idx = op->getSExtValue();
742
743 // For pointer arithmetic we ignore the byte offset
744 // consider using inferFieldIdxFromByteOffset(geopOp,dataLayout,ap,idx)?
745 // ap.setFldIdx(ap.getConstantFieldIdx() + inferFieldIdxFromByteOffset(geopOp,idx));
746 }
747 }
748 return isConst;
749}
750
755{
756 if (const Constant* ref = SVFUtil::dyn_cast<Constant>(val))
757 {
759 {
760 DBOUT(DPAGBuild, outs() << "handle gep constant expression " << llvmModuleSet()->getSVFValue(ref)->toString() << "\n");
761 const Constant* opnd = gepce->getOperand(0);
762 // handle recursive constant express case (gep (bitcast (gep X 1)) 1)
764 auto &GEPOp = llvm::cast<llvm::GEPOperator>(*gepce);
765 Type *pType = GEPOp.getSourceElementType();
766 AccessPath ap(0, llvmModuleSet()->getSVFType(pType));
767 bool constGep = computeGepOffset(gepce, ap);
768 // must invoke pag methods here, otherwise it will be a dead recursion cycle
769 const Value* cval = getCurrentValue();
770 const SVFBasicBlock* cbb = getCurrentBB();
772 /*
773 * The gep edge created are like constexpr (same edge may appear at multiple callsites)
774 * so bb/inst of this edge may be rewritten several times, we treat it as global here.
775 */
778 }
779 else if (const ConstantExpr* castce = isCastConstantExpr(ref))
780 {
781 DBOUT(DPAGBuild, outs() << "handle cast constant expression " << llvmModuleSet()->getSVFValue(ref)->toString() << "\n");
782 const Constant* opnd = castce->getOperand(0);
784 const Value* cval = getCurrentValue();
785 const SVFBasicBlock* cbb = getCurrentBB();
789 }
791 {
792 DBOUT(DPAGBuild, outs() << "handle select constant expression " << llvmModuleSet()->getSVFValue(ref)->toString() << "\n");
793 const Constant* src1 = selectce->getOperand(1);
794 const Constant* src2 = selectce->getOperand(2);
797 const Value* cval = getCurrentValue();
798 const SVFBasicBlock* cbb = getCurrentBB();
800 NodeID cond = llvmModuleSet()->getValueNode(selectce->getOperand(0));
806 }
807 // if we meet a int2ptr, then it points-to black hole
809 {
810 const Constant* opnd = int2Ptrce->getOperand(0);
812 const SVFBasicBlock* cbb = getCurrentBB();
813 const Value* cval = getCurrentValue();
817 }
819 {
820 const Constant* opnd = ptr2Intce->getOperand(0);
822 const SVFBasicBlock* cbb = getCurrentBB();
823 const Value* cval = getCurrentValue();
827 }
829 {
830 // we don't handle trunc and cmp instruction for now
831 const Value* cval = getCurrentValue();
832 const SVFBasicBlock* cbb = getCurrentBB();
837 }
838 else if (isBinaryConstantExpr(ref))
839 {
840 // we don't handle binary constant expression like add(x,y) now
841 const Value* cval = getCurrentValue();
842 const SVFBasicBlock* cbb = getCurrentBB();
847 }
848 else if (isUnaryConstantExpr(ref))
849 {
850 // we don't handle unary constant expression like fneg(x) now
851 const Value* cval = getCurrentValue();
852 const SVFBasicBlock* cbb = getCurrentBB();
857 }
858 else if (SVFUtil::isa<ConstantAggregate>(ref))
859 {
860 // we don't handle constant aggregate like constant vectors
861 }
862 else if (SVFUtil::isa<BlockAddress>(ref))
863 {
864 // blockaddress instruction (e.g. i8* blockaddress(@run_vm, %182))
865 // is treated as constant data object for now, see LLVMUtil.h:397, SymbolTableInfo.cpp:674 and SVFIRBuilder.cpp:183-194
866 const Value* cval = getCurrentValue();
867 const SVFBasicBlock* cbb = getCurrentBB();
872 }
873 else
874 {
875 if(SVFUtil::isa<ConstantExpr>(val))
876 assert(false && "we don't handle all other constant expression for now!");
877 }
878 }
879}
886{
887
888 // if the global variable do not have any field needs to be initialized
889 if (offset == 0 && gvar->getInitializer()->getType()->isSingleValueType())
890 {
891 return getValueNode(gvar);
892 }
895 else
896 {
898 }
899}
900
901/*For global variable initialization
902 * Give a simple global variable
903 * int x = 10; // store 10 x (constant, non pointer) |
904 * int *y = &x; // store x y (pointer type)
905 * Given a struct
906 * struct Z { int s; int *t;};
907 * Global initialization:
908 * struct Z z = {10,&x}; // store x z.t (struct type)
909 * struct Z *m = &z; // store z m (pointer type)
910 * struct Z n = {10,&z.s}; // store z.s n , &z.s constant expression (constant expression)
911 */
914{
915 DBOUT(DPAGBuild, outs() << "global " << llvmModuleSet()->getSVFValue(gvar)->toString() << " constant initializer: " << llvmModuleSet()->getSVFValue(C)->toString() << "\n");
916 if (C->getType()->isSingleValueType())
917 {
918 NodeID src = getValueNode(C);
919 // get the field value if it is available, otherwise we create a dummy field node.
921 NodeID field = getGlobalVarField(gvar, offset, llvmModuleSet()->getSVFType(C->getType()));
922
923 if (SVFUtil::isa<GlobalVariable, Function>(C))
924 {
926 addStoreEdge(src, field);
927 }
928 else if (SVFUtil::isa<ConstantExpr>(C))
929 {
930 // add gep edge of C1 itself is a constant expression
931 processCE(C);
933 addStoreEdge(src, field);
934 }
935 else if (SVFUtil::isa<BlockAddress>(C))
936 {
937 // blockaddress instruction (e.g. i8* blockaddress(@run_vm, %182))
938 // is treated as constant data object for now, see LLVMUtil.h:397, SymbolTableInfo.cpp:674 and SVFIRBuilder.cpp:183-194
939 processCE(C);
942 }
943 else
944 {
946 addStoreEdge(src, field);
948 if (C->getType()->isPtrOrPtrVectorTy() && src != pag->getNullPtr())
950 }
951 }
952 else if (SVFUtil::isa<ConstantArray, ConstantStruct>(C))
953 {
955 return;
956 for (u32_t i = 0, e = C->getNumOperands(); i != e; i++)
957 {
959 InitialGlobal(gvar, SVFUtil::cast<Constant>(C->getOperand(i)), offset + off);
960 }
961 }
962 else if(ConstantData* data = SVFUtil::dyn_cast<ConstantData>(C))
963 {
965 {
966 if(ConstantDataSequential* seq = SVFUtil::dyn_cast<ConstantDataSequential>(data))
967 {
968 for(u32_t i = 0; i < seq->getNumElements(); i++)
969 {
970 u32_t off = pag->getFlattenedElemIdx(llvmModuleSet()->getSVFType(C->getType()), i);
971 Constant* ct = seq->getElementAsConstant(i);
973 }
974 }
975 else
976 {
977 assert((SVFUtil::isa<ConstantAggregateZero, UndefValue>(data)) && "Single value type data should have been handled!");
978 }
979 }
980 }
981 else
982 {
983 //TODO:assert(SVFUtil::isa<ConstantVector>(C),"what else do we have");
984 }
985}
986
991{
992
995 {
996 for (Module::global_iterator I = M.global_begin(), E = M.global_end(); I != E; ++I)
997 {
998 GlobalVariable *gvar = &*I;
1001
1004
1005 if (gvar->hasInitializer())
1006 {
1007 Constant *C = gvar->getInitializer();
1008 DBOUT(DPAGBuild, outs() << "add global var node " << llvmModuleSet()->getSVFValue(gvar)->toString() << "\n");
1009 InitialGlobal(gvar, C, 0);
1010 }
1011 }
1012
1013
1015 for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I)
1016 {
1017 const Function* fun = &*I;
1018 NodeID idx = getValueNode(fun);
1019 NodeID obj = getObjectNode(fun);
1020
1021 DBOUT(DPAGBuild, outs() << "add global function node " << fun->getName().str() << "\n");
1022 setCurrentLocation(fun, (SVFBasicBlock*) nullptr);
1024 }
1025
1026 // Handle global aliases (due to linkage of multiple bc files), e.g., @x = internal alias @y. We need to add a copy from y to x.
1027 for (Module::alias_iterator I = M.alias_begin(), E = M.alias_end(); I != E; I++)
1028 {
1029 const GlobalAlias* alias = &*I;
1030 NodeID dst = llvmModuleSet()->getValueNode(alias);
1031 NodeID src = llvmModuleSet()->getValueNode(alias->getAliasee());
1032 processCE(alias->getAliasee());
1033 setCurrentLocation(alias, (SVFBasicBlock*) nullptr);
1034 addCopyEdge(src, dst, CopyStmt::COPYVAL);
1035 }
1036 }
1037}
1038
1044{
1045
1046 // AllocaInst should always be a pointer type
1047 assert(SVFUtil::isa<PointerType>(inst.getType()));
1048
1049 DBOUT(DPAGBuild, outs() << "process alloca " << llvmModuleSet()->getSVFValue(&inst)->toString() << " \n");
1050 NodeID dst = getValueNode(&inst);
1051
1052 NodeID src = getObjectNode(&inst);
1053
1054 addAddrWithStackArraySz(src, dst, inst);
1055
1056}
1057
1062{
1063
1064 DBOUT(DPAGBuild, outs() << "process phi " << llvmModuleSet()->getSVFValue(&inst)->toString() << " \n");
1065
1066 NodeID dst = getValueNode(&inst);
1067
1068 for (u32_t i = 0; i < inst.getNumIncomingValues(); ++i)
1069 {
1070 const Value* val = inst.getIncomingValue(i);
1071 const Instruction* incomingInst = SVFUtil::dyn_cast<Instruction>(val);
1072 bool matched = (incomingInst == nullptr ||
1073 incomingInst->getFunction() == inst.getFunction());
1074 (void) matched; // Suppress warning of unused variable under release build
1075 assert(matched && "incomingInst's Function incorrect");
1076 const Instruction* predInst = &inst.getIncomingBlock(i)->back();
1077 const ICFGNode* icfgNode = llvmModuleSet()->getICFGNode(predInst);
1078 NodeID src = getValueNode(val);
1079 addPhiStmt(dst,src,icfgNode);
1080 }
1081}
1082
1083/*
1084 * Visit load instructions
1085 */
1087{
1088 DBOUT(DPAGBuild, outs() << "process load " << llvmModuleSet()->getSVFValue(&inst)->toString() << " \n");
1089
1090 NodeID dst = getValueNode(&inst);
1091
1092 NodeID src = getValueNode(inst.getPointerOperand());
1093 const Type* loadedTy = inst.getType();
1094 if (NodeID fieldZero = getDirectAccessFieldZeroValVar(inst.getPointerOperand(), loadedTy))
1095 src = fieldZero;
1096
1097 addLoadEdge(src, dst);
1098}
1099
1104{
1105 // StoreInst itself should always not be a pointer type
1106 assert(!SVFUtil::isa<PointerType>(inst.getType()));
1107
1108 DBOUT(DPAGBuild, outs() << "process store " << llvmModuleSet()->getSVFValue(&inst)->toString() << " \n");
1109
1110 NodeID dst = getValueNode(inst.getPointerOperand());
1111 const Type* storedTy = inst.getValueOperand()->getType();
1112 if (NodeID fieldZero = getDirectAccessFieldZeroValVar(inst.getPointerOperand(), storedTy))
1113 dst = fieldZero;
1114
1115 NodeID src = getValueNode(inst.getValueOperand());
1116
1117 addStoreEdge(src, dst);
1118
1119}
1120
1125{
1126
1127 NodeID dst = getValueNode(&inst);
1128 // GetElementPtrInst should always be a pointer or a vector contains pointers
1129 // for now we don't handle vector type here
1130 if(SVFUtil::isa<VectorType>(inst.getType()))
1131 {
1133 return;
1134 }
1135
1136 assert(SVFUtil::isa<PointerType>(inst.getType()));
1137
1138 DBOUT(DPAGBuild, outs() << "process gep " << llvmModuleSet()->getSVFValue(&inst)->toString() << " \n");
1139
1140 NodeID src = getValueNode(inst.getPointerOperand());
1141
1142 AccessPath ap(0, llvmModuleSet()->getSVFType(inst.getSourceElementType()));
1143 bool constGep = computeGepOffset(&inst, ap);
1145 {
1146 const Type* baseObjType =
1147 LLVMModuleSet::getLLVMModuleSet()->getTypeInference()->inferObjType(inst.getPointerOperand());
1148 if (const auto* arrTy = SVFUtil::dyn_cast<ArrayType>(baseObjType))
1149 {
1150 if (arrTy->getElementType()->isPointerTy())
1151 {
1152 addCopyEdge(src, dst, CopyStmt::COPYVAL);
1153 return;
1154 }
1155 }
1156 }
1157 addGepEdge(src, dst, ap, constGep);
1158}
1159
1160/*
1161 * Visit cast instructions
1162 */
1164{
1165
1166 DBOUT(DPAGBuild, outs() << "process cast " << llvmModuleSet()->getSVFValue(&inst)->toString() << " \n");
1167 NodeID dst = getValueNode(&inst);
1168
1169 const Value* opnd = inst.getOperand(0);
1170 NodeID src = getValueNode(opnd);
1171 addCopyEdge(src, dst, getCopyKind(&inst));
1172}
1173
1178{
1179 NodeID dst = getValueNode(&inst);
1180 assert(inst.getNumOperands() == 2 && "not two operands for BinaryOperator?");
1181 Value* op1 = inst.getOperand(0);
1183 Value* op2 = inst.getOperand(1);
1185 u32_t opcode = inst.getOpcode();
1186 addBinaryOPEdge(op1Node, op2Node, dst, opcode);
1187}
1188
1193{
1194 NodeID dst = getValueNode(&inst);
1195 assert(inst.getNumOperands() == 1 && "not one operand for Unary instruction?");
1196 Value* opnd = inst.getOperand(0);
1197 NodeID src = getValueNode(opnd);
1198 u32_t opcode = inst.getOpcode();
1199 addUnaryOPEdge(src, dst, opcode);
1200}
1201
1206{
1207 NodeID dst = getValueNode(&inst);
1208 assert(inst.getNumOperands() == 2 && "not two operands for compare instruction?");
1209 Value* op1 = inst.getOperand(0);
1211 Value* op2 = inst.getOperand(1);
1213 u32_t predicate = inst.getPredicate();
1214 addCmpEdge(op1Node, op2Node, dst, predicate);
1215}
1216
1217
1222{
1223
1224 DBOUT(DPAGBuild, outs() << "process select " << llvmModuleSet()->getSVFValue(&inst)->toString() << " \n");
1225
1226 NodeID dst = getValueNode(&inst);
1227 NodeID src1 = getValueNode(inst.getTrueValue());
1228 NodeID src2 = getValueNode(inst.getFalseValue());
1229 NodeID cond = getValueNode(inst.getCondition());
1231 addSelectStmt(dst,src1,src2, cond);
1232}
1233
1238
1243
1248
1249/*
1250 * Visit callsites
1251 */
1253{
1254
1255 // skip llvm intrinsics
1256 if(isIntrinsicInst(cs))
1257 return;
1258
1260 outs() << "process callsite " << svfcall->valueOnlyToString() << "\n");
1261
1262
1263 CallICFGNode* callBlockNode = llvmModuleSet()->getCallICFGNode(cs);
1265
1266 pag->addCallSite(callBlockNode);
1267
1269 for (u32_t i = 0; i < cs->arg_size(); i++)
1271 callBlockNode,
1272 pag->getValVar(getValueNode(cs->getArgOperand(i))));
1273
1274 if(!cs->getType()->isVoidTy())
1276
1277 if (callBlockNode->isVirtualCall())
1278 {
1279 const Value* value = cppUtil::getVCallVtblPtr(cs);
1280 callBlockNode->setVtablePtr(pag->getGNode(getValueNode(value)));
1281 }
1282 if (const Function *callee = LLVMUtil::getCallee(cs))
1283 {
1285 {
1286 handleExtCall(cs, callee);
1287 }
1288 else
1289 {
1291 }
1292 }
1293 else
1294 {
1295 //If the callee was not identified as a function (null F), this is indirect.
1296 handleIndCall(cs);
1297 }
1298}
1299
1304{
1305
1306 // ReturnInst itself should always not be a pointer type
1307 assert(!SVFUtil::isa<PointerType>(inst.getType()));
1308
1309 DBOUT(DPAGBuild, outs() << "process return " << llvmModuleSet()->getSVFValue(&inst)->toString() << " \n");
1310
1311 if(Value* src = inst.getReturnValue())
1312 {
1313 const FunObjVar *F = llvmModuleSet()->getFunObjVar(inst.getParent()->getParent());
1314
1316 NodeID vnS = getValueNode(src);
1317 const ICFGNode* icfgNode = llvmModuleSet()->getICFGNode(&inst);
1318 //vnS may be null if src is a null ptr
1319 addPhiStmt(rnF,vnS,icfgNode);
1320 }
1321}
1322
1323
1337
1351
1357{
1358 NodeID brinst = getValueNode(&inst);
1359 NodeID cond;
1360 if (inst.isConditional())
1361 cond = getValueNode(inst.getCondition());
1362 else
1363 cond = pag->getNullPtr();
1364
1365 assert(inst.getNumSuccessors() <= 2 && "if/else has more than two branches?");
1366
1368 std::vector<const Instruction*> nextInsts;
1370 u32_t branchID = 0;
1371 for (const Instruction* succInst : nextInsts)
1372 {
1373 assert(branchID <= 1 && "if/else has more than two branches?");
1374 const ICFGNode* icfgNode = llvmModuleSet()->getICFGNode(succInst);
1375 successors.push_back(std::make_pair(icfgNode, 1-branchID));
1376 branchID++;
1377 }
1378 addBranchStmt(brinst, cond, successors);
1380 if (inst.isConditional())
1381 {
1382 for (auto& edge : llvmModuleSet()->getICFGNode(&inst)->getOutEdges())
1383 {
1384 if (IntraCFGEdge* intraEdge = SVFUtil::dyn_cast<IntraCFGEdge>(edge))
1385 {
1386 intraEdge->setConditionVar(pag->getGNode(cond));
1387 }
1388 }
1389 }
1390}
1391
1392
1436
1439{
1440 NodeID brinst = getValueNode(&inst);
1441 NodeID cond = getValueNode(inst.getCondition());
1442
1444 std::vector<const Instruction*> nextInsts;
1446 for (const Instruction* succInst : nextInsts)
1447 {
1449 const ConstantInt* condVal = inst.findCaseDest(const_cast<BasicBlock*>(succInst->getParent()));
1451 s64_t val = -1;
1452 if (condVal && condVal->getBitWidth() <= 64)
1454 const ICFGNode* icfgNode = llvmModuleSet()->getICFGNode(succInst);
1455 successors.push_back(std::make_pair(icfgNode, val));
1456 }
1457 addBranchStmt(brinst, cond, successors);
1459 for (auto& edge : llvmModuleSet()->getICFGNode(&inst)->getOutEdges())
1460 {
1461 if (IntraCFGEdge* intraEdge = SVFUtil::dyn_cast<IntraCFGEdge>(edge))
1462 {
1463 intraEdge->setConditionVar(pag->getGNode(cond));
1464 }
1465 }
1466}
1467
1468
1475{
1476 NodeID dst = getValueNode(&inst);
1477 Value* opnd = inst.getPointerOperand();
1478 NodeID src = getValueNode(opnd);
1479 addCopyEdge(src, dst, CopyStmt::COPYVAL);
1480}
1481
1487{
1488 NodeID dst = getValueNode(&inst);
1489 for (u32_t i = 0; i < inst.getNumOperands(); i++)
1490 {
1491 Value* opnd = inst.getOperand(i);
1492 NodeID src = getValueNode(opnd);
1493 addCopyEdge(src, dst, CopyStmt::COPYVAL);
1494 }
1495}
1496
1497
1502{
1503
1504 assert(F);
1508 outs() << "handle direct call " << LLVMUtil::dumpValue(cs) << " callee " << F->getName().str() << "\n");
1509
1510 //Only handle the ret.val. if it's used as a ptr.
1512 //Does it actually return a ptr?
1513 if (!cs->getType()->isVoidTy())
1514 {
1518 }
1519 //Iterators for the actual and formal parameters
1520 u32_t itA = 0, ieA = cs->arg_size();
1521 Function::const_arg_iterator itF = F->arg_begin(), ieF = F->arg_end();
1522 //Go through the fixed parameters.
1523 DBOUT(DPAGBuild, outs() << " args:");
1524 for (; itF != ieF; ++itA, ++itF)
1525 {
1526 //Some programs (e.g. Linux kernel) leave unneeded parameters empty.
1527 if (itA == ieA)
1528 {
1529 DBOUT(DPAGBuild, outs() << " !! not enough args\n");
1530 break;
1531 }
1532 const Value* AA = cs->getArgOperand(itA), *FA = &*itF; //current actual/formal arg
1533
1534 DBOUT(DPAGBuild, outs() << "process actual parm " << llvmModuleSet()->getSVFValue(AA)->toString() << " \n");
1535
1540 }
1541 //Any remaining actual args must be varargs.
1542 if (F->isVarArg())
1543 {
1545 DBOUT(DPAGBuild, outs() << "\n varargs:");
1546 for (; itA != ieA; ++itA)
1547 {
1548 const Value* AA = cs->getArgOperand(itA);
1552 }
1553 }
1554 if(itA != ieA)
1555 {
1558 writeWrnMsg("too many args to non-vararg func.");
1559 writeWrnMsg("(" + callICFGNode->getSourceLoc() + ")");
1560
1561 }
1562}
1563
1596{
1597 const Value* value = stripAllCasts(V);
1598 assert(value && "null ptr?");
1600 [this](const GlobalVariable* glob, int64_t byteOffset) -> const Value*
1601 {
1602 if (!glob || !glob->hasInitializer())
1603 return nullptr;
1604
1605 auto* initializer = SVFUtil::dyn_cast<ConstantStruct>(glob->getInitializer());
1606 auto* structType = SVFUtil::dyn_cast<StructType>(glob->getValueType());
1607 if (!initializer || !structType)
1608 return nullptr;
1609
1610 DataLayout* dataLayout = getDataLayout(llvmModuleSet()->getMainLLVMModule());
1611 const StructLayout* layout =
1612 dataLayout->getStructLayout(const_cast<StructType*>(structType));
1613 for (u32_t fieldIdx = 0; fieldIdx < initializer->getNumOperands(); ++fieldIdx)
1614 {
1615 if (layout->getElementOffset(fieldIdx) != static_cast<uint64_t>(byteOffset))
1616 continue;
1617 if (auto* ptrValue =
1618 SVFUtil::dyn_cast<llvm::GlobalVariable>(initializer->getOperand(fieldIdx)))
1619 return ptrValue;
1620 return nullptr;
1621 }
1622 return nullptr;
1623 };
1624
1625 if(const GetElementPtrInst* gep = SVFUtil::dyn_cast<GetElementPtrInst>(value))
1626 {
1627 APOffset totalidx = 0;
1628 for (bridge_gep_iterator gi = bridge_gep_begin(gep), ge = bridge_gep_end(gep); gi != ge; ++gi)
1629 {
1630 if(const ConstantInt* op = SVFUtil::dyn_cast<ConstantInt>(gi.getOperand()))
1632 }
1633 if(totalidx == 0 && !SVFUtil::isa<StructType>(value->getType()))
1634 value = gep->getPointerOperand();
1635 }
1636 else if (const LoadInst* load = SVFUtil::dyn_cast<LoadInst>(value))
1637 {
1638 const Value* loadP = load->getPointerOperand();
1639 if (const GetElementPtrInst* gep = SVFUtil::dyn_cast<GetElementPtrInst>(loadP))
1640 {
1641 DataLayout* dataLayout = getDataLayout(llvmModuleSet()->getMainLLVMModule());
1642 llvm::APInt byteOffset(dataLayout->getIndexSizeInBits(gep->getPointerAddressSpace()), 0, true);
1643 const bool hasByteOffset = dataLayout && gep->accumulateConstantOffset(*dataLayout, byteOffset);
1644
1645 const Value * pointer_operand = gep->getPointerOperand();
1646 if (auto *glob = SVFUtil::dyn_cast<GlobalVariable>(pointer_operand))
1647 {
1648 if (hasByteOffset)
1649 {
1650 if (const Value* ptrValue = getGlobalFieldFromByteOffset(glob, byteOffset.getSExtValue()))
1651 return ptrValue;
1652 }
1653 }
1654 else if (hasByteOffset && !byteOffset.isNegative() &&
1655 SVFUtil::isa<AllocaInst>(pointer_operand) && load->getType()->isPointerTy())
1656 {
1657 const u64_t offset = byteOffset.getZExtValue();
1658 const u64_t accessBytes = dataLayout->getPointerSize(gep->getPointerAddressSpace());
1659
1660 auto isCoveredByMemcpy = [offset, accessBytes](const CallBase* cs) -> bool
1661 {
1662 if (cs->arg_size() < 3)
1663 return false;
1664
1665 const auto* copySize = SVFUtil::dyn_cast<ConstantInt>(cs->getArgOperand(2));
1666 if (!copySize)
1667 return false;
1668
1669 const u64_t copyBytes = copySize->getZExtValue();
1671 };
1672
1673 auto hasInterveningWrite = [load](const Instruction* from) -> bool
1674 {
1675 if (from->getParent() != load->getParent() || !from->comesBefore(load))
1676 return true;
1677
1678 auto it = from->getIterator();
1679 const auto end = load->getIterator();
1680 while (++it != end)
1681 {
1682 if (it->mayWriteToMemory())
1683 return true;
1684 }
1685 return false;
1686 };
1687
1688 for (const auto& use : pointer_operand->users())
1689 {
1690 const auto* cs = SVFUtil::dyn_cast<CallBase>(use);
1691 if (!cs || cs->getParent() != load->getParent() ||
1692 cs->arg_size() < 1 ||
1693 stripAllCasts(cs->getArgOperand(0)) != pointer_operand)
1694 continue;
1695
1696 const Function* calledFun = cs->getCalledFunction();
1699 continue;
1700
1701 const Value* copiedFrom = getBaseValueForExtArg(cs->getArgOperand(1));
1702 if (const auto* copiedGlob = SVFUtil::dyn_cast<GlobalVariable>(copiedFrom))
1703 {
1704 if (const Value* ptrValue =
1705 getGlobalFieldFromByteOffset(copiedGlob, byteOffset.getSExtValue()))
1706 return ptrValue;
1707 }
1708 }
1709 }
1710 }
1711 }
1712
1713 return value;
1714}
1715
1720{
1722 NodeID indFunPtrId = llvmModuleSet()->getValueNode(cs->getCalledOperand());
1723 const_cast<CallICFGNode*>(cbn)->setIndFunPtr(pag->getGNode(indFunPtrId));
1725}
1726
1728{
1729 CallGraph::CallEdgeMap::const_iterator iter = callgraph->getIndCallMap().begin();
1730 CallGraph::CallEdgeMap::const_iterator eiter = callgraph->getIndCallMap().end();
1731 for (; iter != eiter; iter++)
1732 {
1733 const CallICFGNode* callBlock = iter->first;
1734 const CallBase* callbase = SVFUtil::cast<CallBase>(llvmModuleSet()->getLLVMValue(callBlock));
1735 assert(callBlock->isIndirectCall() && "this is not an indirect call?");
1736 const CallGraph::FunctionSet& functions = iter->second;
1737 for (CallGraph::FunctionSet::const_iterator func_iter = functions.begin(); func_iter != functions.end(); func_iter++)
1738 {
1739 const Function* callee = SVFUtil::cast<Function>(llvmModuleSet()->getLLVMValue(*func_iter));
1740
1741 if (isExtCall(*func_iter))
1742 {
1743 setCurrentLocation(callee, callee->empty() ? nullptr : &callee->getEntryBlock());
1745 }
1746 else
1747 {
1748 setCurrentLocation(llvmModuleSet()->getLLVMValue(callBlock), callBlock->getBB());
1749 handleDirectCall(const_cast<CallBase*>(callbase), callee);
1750 }
1751 }
1752 }
1753
1754 // dump SVFIR
1756 pag->dump("svfir_final");
1757}
1758
1759/*
1760 * TODO: more sanity checks might be needed here
1761 */
1763{
1764 for (SVFIR::iterator nIter = pag->begin(); nIter != pag->end(); ++nIter)
1765 {
1766 (void) pag->getGNode(nIter->first);
1767 //TODO::
1768 // (1) every source(root) node of a pag tree should be object node
1769 // if a node has no incoming edge, but has outgoing edges
1770 // then it has to be an object node.
1771 // (2) make sure every variable should be initialized
1772 // otherwise it causes the a null pointer, the aliasing relation may not be captured
1773 // when loading a pointer value should make sure
1774 // some value has been store into this pointer before
1775 // q = load p, some value should stored into p first like store w p;
1776 // (3) make sure PAGNode should not have a const expr value (pointer should have unique def)
1777 // (4) look closely into addComplexConsForExt, make sure program locations(e.g.,inst bb)
1778 // are set correctly for dummy gepval node
1779 // (5) reduce unnecessary copy edge (const casts) and ensure correctness.
1780 }
1781}
1782
1783
1788NodeID SVFIRBuilder::getGepValVar(const Value* val, const AccessPath& ap, const SVFType* elementType)
1789{
1790 NodeID base = getValueNode(val);
1792 if (gepval==UINT_MAX)
1793 {
1794 assert(((int) UINT_MAX)==-1 && "maximum limit of unsigned int is not -1?");
1795 /*
1796 * getGepValVar can only be called from two places:
1797 * 1. SVFIRBuilder::addComplexConsForExt to handle external calls
1798 * 2. SVFIRBuilder::getGlobalVarField to initialize global variable
1799 * so curVal can only be
1800 * 1. Instruction
1801 * 2. GlobalVariable
1802 */
1803 assert(
1804 (SVFUtil::isa<Instruction>(curVal) || SVFUtil::isa<GlobalVariable>(curVal)) && "curVal not an instruction or a globalvariable?");
1805
1806 // We assume every GepValNode and its GepEdge to the baseNode are unique across the whole program
1807 // We preserve the current BB information to restore it after creating the gepNode
1808 const Value* cval = getCurrentValue();
1809 const SVFBasicBlock* cbb = getCurrentBB();
1812 const ICFGNode* node = nullptr;
1813 if (const Instruction* inst = SVFUtil::dyn_cast<Instruction>(curVal))
1814 {
1815 if (llvmmodule->hasICFGNode(inst))
1816 {
1817 node = llvmmodule->getICFGNode(inst);
1818 }
1819 }
1820 else if (SVFUtil::isa<GlobalVariable>(curVal))
1821 {
1822 // GEP on a global variable: the resulting GepValVar belongs to the global ICFG node.
1823 node = pag->getICFG()->getGlobalICFGNode();
1824 }
1826 NodeIDAllocator::get()->allocateValueId(),
1827 llvmmodule->getSVFType(PointerType::getUnqual(llvmmodule->getContext())), node);
1828 addGepEdge(base, gepNode, ap, true);
1830 return gepNode;
1831 }
1832 else
1833 return gepval;
1834}
1835
1837{
1838 if (!Options::ModelArrays() || SVFUtil::isa<llvm::GEPOperator>(ptr))
1839 return 0;
1840
1841 const Type* objTy =
1843 const ArrayType* arrTy = SVFUtil::dyn_cast<ArrayType>(objTy);
1844 if (!arrTy || !arrTy->getElementType()->isPointerTy() ||
1845 arrTy->getElementType() != accessTy)
1846 return 0;
1847
1848 AccessPath ap(0, llvmModuleSet()->getSVFType(arrTy));
1849 return getGepValVar(ptr, ap, llvmModuleSet()->getSVFType(accessTy));
1850}
1851
1852
1853/*
1854 * curVal <--------> PAGEdge
1855 * Instruction Any Edge
1856 * Argument CopyEdge (SVFIR::addFormalParamBlackHoleAddrEdge)
1857 * ConstantExpr CopyEdge (Int2PtrConstantExpr CastConstantExpr SVFIRBuilder::processCE)
1858 * GepEdge (GepConstantExpr SVFIRBuilder::processCE)
1859 * ConstantPointerNull CopyEdge (3-->2 NullPtr-->BlkPtr SVFIR::addNullPtrNode)
1860 * AddrEdge (0-->2 BlkObj-->BlkPtr SVFIR::addNullPtrNode)
1861 * GlobalVariable AddrEdge (SVFIRBuilder::visitGlobal)
1862 * GepEdge (SVFIRBuilder::getGlobalVarField)
1863 * Function AddrEdge (SVFIRBuilder::visitGlobal)
1864 * Constant StoreEdge (SVFIRBuilder::InitialGlobal)
1865 */
1867{
1869 return;
1870
1871 assert(curVal && "current Val is nullptr?");
1872 edge->setBB(curBB!=nullptr ? curBB : nullptr);
1874 ICFGNode* icfgNode = pag->getICFG()->getGlobalICFGNode();
1876 if (const Instruction* curInst = SVFUtil::dyn_cast<Instruction>(curVal))
1877 {
1878 const FunObjVar* srcFun = edge->getSrcNode()->getFunction();
1879 const FunObjVar* dstFun = edge->getDstNode()->getFunction();
1880 if(srcFun!=nullptr && !SVFUtil::isa<RetPE>(edge) && !SVFUtil::isa<FunValVar>(edge->getSrcNode()) && !SVFUtil::isa<FunObjVar>(edge->getSrcNode()))
1881 {
1882 assert(srcFun==llvmMS->getFunObjVar(curInst->getFunction()) && "SrcNode of the PAGEdge not in the same function?");
1883 }
1884 if(dstFun!=nullptr && !SVFUtil::isa<CallPE>(edge) && !SVFUtil::isa<RetValPN>(edge->getDstNode()))
1885 {
1886 assert(dstFun==llvmMS->getFunObjVar(curInst->getFunction()) && "DstNode of the PAGEdge not in the same function?");
1887 }
1888
1890 if (!(SVFUtil::isa<GepStmt>(edge) && SVFUtil::isa<GepValVar>(edge->getDstNode())))
1891 assert(curBB && "instruction does not have a basic block??");
1892
1894 if(SVFUtil::isa<ReturnInst>(curInst))
1895 {
1896 icfgNode = pag->getICFG()->getFunExitICFGNode(llvmMS->getFunObjVar(curInst->getFunction()));
1897 }
1898 else if(const CallPE* callPE = SVFUtil::dyn_cast<CallPE>(edge))
1899 {
1901 icfgNode = const_cast<FunEntryICFGNode*>(callPE->getFunEntryICFGNode());
1902 }
1903 else if(SVFUtil::isa<RetPE>(edge))
1904 {
1905 icfgNode = llvmMS->getRetICFGNode(SVFUtil::cast<Instruction>(curInst));
1906 }
1907 else
1908 {
1909 icfgNode = llvmMS->getICFGNode(SVFUtil::cast<Instruction>(curInst));
1910 }
1911 }
1912 else if (const Argument* arg = SVFUtil::dyn_cast<Argument>(curVal))
1913 {
1915 icfgNode = pag->getICFG()->getFunEntryICFGNode(
1916 llvmModuleSet()->getFunObjVar(SVFUtil::cast<Function>(arg->getParent())));
1917 }
1918 else if (SVFUtil::isa<Constant>(curVal) ||
1919 SVFUtil::isa<Function>(curVal) ||
1920 SVFUtil::isa<MetadataAsValue>(curVal))
1921 {
1922 if (!curBB)
1924 else
1925 {
1926 icfgNode = const_cast<ICFGNode*>(curBB->front());
1927 }
1928 }
1929 else
1930 {
1931 assert(false && "what else value can we have?");
1932 }
1933
1934 pag->addToSVFStmtList(icfgNode,edge);
1935 icfgNode->addSVFStmt(edge);
1936 if(const CallPE* callPE = SVFUtil::dyn_cast<CallPE>(edge))
1937 {
1940 FunEntryICFGNode* entryNode = const_cast<FunEntryICFGNode*>(callPE->getFunEntryICFGNode());
1941 for(u32_t i = 0; i < callPE->getOpVarNum(); i++)
1942 {
1943 CallICFGNode* callNode = const_cast<CallICFGNode*>(callPE->getOpCallICFGNode(i));
1945 SVFUtil::cast<CallCFGEdge>(icfgEdge)->addCallPE(callPE);
1946 }
1947 }
1948 else if(const RetPE* retPE = SVFUtil::dyn_cast<RetPE>(edge))
1949 {
1950 RetICFGNode* retNode = const_cast<RetICFGNode*>(retPE->getCallSite()->getRetICFGNode());
1951 FunExitICFGNode* exitNode = const_cast<FunExitICFGNode*>(retPE->getFunExitICFGNode());
1953 SVFUtil::cast<RetCFGEdge>(edge)->addRetPE(retPE);
1954 }
1955}
1956
1957
1965{
1966 SVFVar* node = pag->getGNode(nodeId);
1969 if(geps.empty())
1970 return AccessPath(0);
1971
1972 assert(geps.size()==1 && "one node can only be connected by at most one gep edge!");
1973 SVFVar::iterator it = geps.begin();
1974 const GepStmt* gepEdge = SVFUtil::cast<GepStmt>(*it);
1975 if(gepEdge->isVariantFieldGep())
1976 return AccessPath(0);
1977 else
1978 return gepEdge->getAccessPath();
1979}
#define DBOUT(TYPE, X)
LLVM debug macros, define type of your DBUG model of each pass.
Definition SVFType.h:593
#define TIMEINTERVAL
Definition SVFType.h:621
#define DGENERAL
Definition SVFType.h:599
#define DPAGBuild
Definition SVFType.h:601
buffer offset
Definition cJSON.cpp:1113
cJSON * item
Definition cJSON.h:222
APOffset getConstantStructFldIdx() const
Get methods.
Definition AccessPath.h:98
void setFldIdx(APOffset idx)
Definition AccessPath.h:102
bool addOffsetVarAndGepTypePair(const ValVar *var, const SVFType *gepIterType)
std::vector< std::pair< const ICFGNode *, s32_t > > SuccAndCondPairVec
CallEdgeMap & getIndCallMap()
Get callees from an indirect callsite.
Definition CallGraph.h:331
Set< const FunObjVar * > FunctionSet
Definition CallGraph.h:247
bool isVirtualCall() const
Definition ICFGNode.h:509
void setVtablePtr(SVFVar *v)
Definition ICFGNode.h:514
static ExtAPI * getExtAPI()
Definition ExtAPI.cpp:44
void setExtFuncAnnotations(const FunObjVar *fun, const std::vector< std::string > &funcAnnotations)
Definition ExtAPI.cpp:223
virtual const FunObjVar * getFunction() const
Get containing function, or null for globals/constants.
const SVFBasicBlock * getEntryBlock() const
void setBasicBlockGraph(BasicBlockGraph *graph)
void initFunObjVar(bool decl, bool intrinc, bool addr, bool uncalled, bool notret, bool vararg, const SVFFunctionType *ft, SVFLoopAndDomInfo *ld, const FunObjVar *real, BasicBlockGraph *bbg, const std::vector< const ArgValVar * > &allarg, const SVFBasicBlock *exit)
BasicBlockGraph * bbGraph
the definition of a function across multiple modules
bool isDeclaration() const
iterator begin()
Iterators.
u32_t getTotalNodeNum() const
Get total number of node/edge.
IDToNodeMapTy::iterator iterator
Node Iterators.
NodeType * getGNode(NodeID id) const
Get a node.
GEdgeSetTy::iterator iterator
const GEdgeSetTy & getOutEdges() const
void addSVFStmt(const SVFStmt *edge)
Definition ICFGNode.h:110
FunExitICFGNode * getFunExitICFGNode(const FunObjVar *fun)
Add a function exit node.
Definition ICFG.cpp:249
ICFGEdge * hasInterICFGEdge(ICFGNode *src, ICFGNode *dst, ICFGEdge::ICFGEdgeK kind)
Definition ICFG.cpp:276
void dump(const std::string &file, bool simple=false)
Dump graph into dot file.
Definition ICFG.cpp:411
FunEntryICFGNode * getFunEntryICFGNode(const FunObjVar *fun)
Add a function entry node.
Definition ICFG.cpp:242
GlobalICFGNode * getGlobalICFGNode() const
Definition ICFG.h:244
NodeID constantSymID() const
Definition IRGraph.h:188
u32_t getFlattenedElemIdx(const SVFType *T, u32_t origId)
Flattened element idx of an array or struct by considering stride.
Definition IRGraph.cpp:144
u32_t getNodeNumAfterPAGBuild() const
Definition IRGraph.h:322
void dump(std::string name)
Dump SVFIR.
Definition IRGraph.cpp:316
NodeID getBlkPtr() const
Definition IRGraph.h:255
NodeID blkPtrSymID() const
Definition IRGraph.h:178
NodeID getNullPtr() const
Definition IRGraph.h:259
NodeID nullPtrSymID() const
Definition IRGraph.h:183
u32_t getTotalSymNum() const
Statistics.
Definition IRGraph.h:200
FunObjVarToIDMapTy varargFunObjSymMap
vararg map
Definition IRGraph.h:86
NodeID getReturnNode(const FunObjVar *func) const
GetReturnNode - Return the unique node representing the return value of a function.
Definition IRGraph.cpp:60
void setNodeNumAfterPAGBuild(u32_t num)
Definition IRGraph.h:326
NodeID blackholeSymID() const
Definition IRGraph.h:193
ObjTypeInfo * getObjTypeInfo(NodeID id) const
Definition IRGraph.h:234
NodeID getConstantNode() const
Definition IRGraph.h:251
FunObjVarToIDMapTy returnFunObjSymMap
return map
Definition IRGraph.h:85
virtual void build(ICFG *icfg)
Start from here.
NodeID getValueNode(const Value *V)
ValueToIDMapTy & valSyms()
Definition LLVMModule.h:207
FunToIDMapTy & retSyms()
Definition LLVMModule.h:274
const FunObjVar * getFunObjVar(const Function *fun) const
Definition LLVMModule.h:267
static LLVMModuleSet * getLLVMModuleSet()
Definition LLVMModule.h:131
SVFBasicBlock * getSVFBasicBlock(const BasicBlock *bb)
Definition LLVMModule.h:298
DominatorTree & getDomTree(const Function *fun)
void addToSVFVar2LLVMValueMap(const Value *val, SVFValue *svfBaseNode)
LLVMFun2FunObjVarMap LLVMFun2FunObjVar
Map an LLVM Function to an SVF Funobjvar.
Definition LLVMModule.h:99
SVFType * getSVFType(const Type *T)
Get or create SVFType and typeinfo.
ICFGNode * getICFGNode(const Instruction *inst)
Get a basic block ICFGNode.
CallICFGNode * getCallICFGNode(const Instruction *cs)
get a call node
Fun2AnnoMap ExtFun2Annotations
Record annotations of function in extapi.bc.
Definition LLVMModule.h:91
NodeID getObjectNode(const Value *V)
RetICFGNode * getRetICFGNode(const Instruction *cs)
get a return node
const std::vector< std::reference_wrapper< Module > > & getLLVMModules() const
Definition LLVMModule.h:157
const Function * getRealDefFun(const Function *fun) const
Definition LLVMModule.h:185
ValueToIDMapTy & objSyms()
Definition LLVMModule.h:212
void addBasicBlock(FunObjVar *fun, const BasicBlock *bb)
Definition LLVMModule.h:232
FunToIDMapTy & varargSyms()
Definition LLVMModule.h:279
const FunctionSet & getFunctionSet() const
Definition LLVMModule.h:192
ObjTypeInference * getTypeInference()
static NodeIDAllocator * get(void)
Return (singleton) allocator.
const Type * inferObjType(const Value *var)
get or infer the type of the object pointed by the value
static Option< bool > ModelArrays
Definition Options.h:185
static const Option< bool > PAGDotGraph
Definition Options.h:118
static const Option< std::string > DumpJson
Definition Options.h:121
static Option< bool > ModelConsts
Definition Options.h:184
static const Option< bool > PAGPrint
Definition Options.h:124
static const Option< bool > VtableInSVFIR
Definition Options.h:214
static const Option< bool > LoopAnalysis
Definition Options.h:239
static const Option< bool > DumpICFG
Definition Options.h:120
const FunObjVar * getParent() const
void addPredBasicBlock(const SVFBasicBlock *pred2)
void addSuccBasicBlock(const SVFBasicBlock *succ2)
const ICFGNode * front() const
u32_t inferFieldIdxFromByteOffset(const llvm::GEPOperator *gepOp, DataLayout *dl, AccessPath &ap, APOffset idx)
Infer field index from byteoffset.
CopyStmt::CopyKind getCopyKind(const Value *val)
void sanityCheck()
Sanity check for SVFIR.
SVFIR * getPAG() const
Return SVFIR.
void setCurrentLocation(const Value *val, const BasicBlock *bb)
Set current basic block in order to keep track of control flow information.
NodeID addNullPtrNode()
Add NullPtr PAGNode.
void visitLoadInst(LoadInst &I)
NodeID getVarargNode(const FunObjVar *func)
getVarargNode - Return the node representing the unique variadic argument of a function.
void addPhiStmt(NodeID res, NodeID opnd, const ICFGNode *pred)
Add Copy edge.
void updateCallGraph(CallGraph *callgraph)
connect PAG edges based on callgraph
void initSVFBasicBlock(const Function *func)
void addStoreEdge(NodeID src, NodeID dst)
Add Store edge.
AddrStmt * addAddrEdge(NodeID src, NodeID dst)
Add Address edge.
void visitInvokeInst(InvokeInst &II)
void handleDirectCall(CallBase *cs, const Function *F)
Handle direct call.
void addBinaryOPEdge(NodeID op1, NodeID op2, NodeID dst, u32_t opcode)
Add Copy edge.
void visitCallInst(CallInst &I)
void addLoadEdge(NodeID src, NodeID dst)
Add Load edge.
virtual void handleExtCall(const CallBase *cs, const Function *callee)
void visitGetElementPtrInst(GetElementPtrInst &I)
void visitBranchInst(BranchInst &I)
virtual void visitAllocaInst(AllocaInst &AI)
Our visit overrides.
void addGepEdge(NodeID src, NodeID dst, const AccessPath &ap, bool constGep)
Add Gep edge.
void addCmpEdge(NodeID op1, NodeID op2, NodeID dst, u32_t predict)
Add Copy edge.
LLVMModuleSet * llvmModuleSet()
void visitStoreInst(StoreInst &I)
NodeID getReturnNode(const FunObjVar *func)
getReturnNode - Return the node representing the unique return value of a function.
NodeID getObjectNode(const Value *V)
GetObject - Return the object node (stack/global/heap/function) according to a LLVM Value.
void visitCallSite(CallBase *cs)
void processCE(const Value *val)
Process constant expression.
void handleIndCall(CallBase *cs)
Handle indirect call.
const Value * curVal
Current Value during SVFIR construction when visiting the module.
void addSelectStmt(NodeID res, NodeID op1, NodeID op2, NodeID cond)
Add SelectStmt.
void addBranchStmt(NodeID br, NodeID cond, const BranchStmt::SuccAndCondPairVec &succs)
Add Branch statement.
virtual SVFIR * build()
Start building SVFIR here.
void visitCallBrInst(CallBrInst &I)
void visitExtractValueInst(ExtractValueInst &EVI)
AccessPath getAccessPathFromBaseNode(NodeID nodeId)
const SVFBasicBlock * curBB
Current basic block during SVFIR construction when visiting the module.
void visitSwitchInst(SwitchInst &I)
The following implementation follows ICFGBuilder::processFunBody.
void visitFreezeInst(FreezeInst &I)
const Value * getBaseValueForExtArg(const Value *V)
Get the base value of (i8* src and i8* dst) for external argument (e.g. memcpy(i8* dst,...
void initDomTree(FunObjVar *func, const Function *f)
void addRetEdge(NodeID src, NodeID dst, const CallICFGNode *cs, const FunExitICFGNode *exit)
Add Return edge.
void addBlackHoleAddrEdge(NodeID node)
NodeID getDirectAccessFieldZeroValVar(const Value *ptr, const Type *accessTy)
void visitGlobal()
Handle globals including (global variable and functions)
void addUnaryOPEdge(NodeID src, NodeID dst, u32_t opcode)
Add Unary edge.
const SVFBasicBlock * getCurrentBB() const
void visitPHINode(PHINode &I)
CopyStmt * addCopyEdge(NodeID src, NodeID dst, CopyStmt::CopyKind kind)
void addCallEdge(NodeID src, NodeID dst, const CallICFGNode *cs, const FunEntryICFGNode *entry)
Add Call edge.
void setCurrentBBAndValueForPAGEdge(PAGEdge *edge)
void visitSelectInst(SelectInst &I)
void visitVAArgInst(VAArgInst &)
void visitCmpInst(CmpInst &I)
void visitExtractElementInst(ExtractElementInst &I)
bool computeGepOffset(const User *V, AccessPath &ap)
Compute offset of a gep instruction or gep constant expression.
void visitReturnInst(ReturnInst &I)
const Value * getCurrentValue() const
NodeID getValueNode(const Value *V)
Get different kinds of node.
void visitCastInst(CastInst &I)
AddrStmt * addAddrWithStackArraySz(NodeID src, NodeID dst, llvm::AllocaInst &inst)
Add Address edge from allocinst with arraysize like "%4 = alloca i8, i64 3".
NodeID getGepValVar(const Value *val, const AccessPath &ap, const SVFType *elementType)
void InitialGlobal(const GlobalVariable *gvar, Constant *C, u32_t offset)
void visitUnaryOperator(UnaryOperator &I)
void visitBinaryOperator(BinaryOperator &I)
void initialiseNodes()
Initialize nodes and edges.
NodeID getGlobalVarField(const GlobalVariable *gvar, u32_t offset, SVFType *tpy)
NodeID addGlobalValNode(const NodeID i, const ICFGNode *icfgNode, const SVFType *svfType)
Definition SVFIR.h:702
void addFunArgs(const FunObjVar *fun, const ValVar *arg)
Get/set method for function/callsite arguments and returns.
Definition SVFIR.h:616
NodeID getGepValVar(NodeID curInst, NodeID base, const AccessPath &ap) const
Due to constraint expression, curInst is used to distinguish different instructions (e....
Definition SVFIR.cpp:611
void print()
Print SVFIR.
Definition SVFIR.cpp:646
NodeID addConstantAggObjNode(const NodeID i, ObjTypeInfo *ti, const ICFGNode *node)
Definition SVFIR.h:778
NodeID addBlackholePtrNode()
Definition SVFIR.h:844
NodeID addBlackholeObjNode()
Definition SVFIR.h:836
NodeID addGlobalObjNode(const NodeID i, ObjTypeInfo *ti, const ICFGNode *node)
Definition SVFIR.h:773
NodeID addGepValNode(NodeID curInst, const ValVar *base, const AccessPath &ap, NodeID i, const SVFType *type, const ICFGNode *node)
Add a temp field value node, this method can only invoked by getGepValVar.
Definition SVFIR.cpp:485
NodeID addConstantDataObjNode(const NodeID i, ObjTypeInfo *ti, const ICFGNode *node)
Definition SVFIR.h:783
NodeID addConstantFPObjNode(NodeID i, ObjTypeInfo *ti, double dval, const ICFGNode *node)
Definition SVFIR.h:752
NodeID addObjNode(NodeID i, ObjTypeInfo *ti, const ICFGNode *node)
Add a memory obj node.
Definition SVFIR.h:722
void addFunRet(const FunObjVar *fun, const ValVar *ret)
Add function returns.
Definition SVFIR.h:628
NodeID addBasicBlockValNode(NodeID i, const SVFType *type)
Definition SVFIR.h:852
NodeID addConstantNullPtrValNode(const NodeID i, const ICFGNode *icfgNode, const SVFType *type)
Definition SVFIR.h:696
NodeID addHeapObjNode(NodeID i, ObjTypeInfo *ti, const ICFGNode *node)
Definition SVFIR.h:730
static bool pagReadFromTXT()
Definition SVFIR.h:278
CallGraph * callGraph
all the callsites of a program
Definition SVFIR.h:101
void addToSVFStmtList(ICFGNode *inst, SVFStmt *edge)
Add a SVFStmt into instruction map.
Definition SVFIR.h:326
NodeID addConstantNullPtrObjNode(const NodeID i, ObjTypeInfo *ti, const ICFGNode *node)
Definition SVFIR.h:767
NodeID addConstantDataValNode(const NodeID i, const ICFGNode *icfgNode, const SVFType *type)
Definition SVFIR.h:714
NodeID addIntrinsicValNode(NodeID i, const SVFType *type)
Definition SVFIR.h:848
void addCallSiteArgs(CallICFGNode *callBlockNode, const ValVar *arg)
Add callsite arguments.
Definition SVFIR.h:640
NodeID addStackObjNode(NodeID i, ObjTypeInfo *ti, const ICFGNode *node)
Definition SVFIR.h:739
NodeID addConstantIntValNode(NodeID i, const std::pair< s64_t, u64_t > &intValue, const ICFGNode *icfgNode, const SVFType *type)
Definition SVFIR.h:689
ICFG * getICFG() const
Definition SVFIR.h:229
NodeID addFunValNode(NodeID i, const ICFGNode *icfgNode, const FunObjVar *funObjVar, const SVFType *type)
Definition SVFIR.h:669
NodeID addConstantFPValNode(const NodeID i, double dval, const ICFGNode *icfgNode, const SVFType *type)
Definition SVFIR.h:682
NodeID addConstantAggValNode(const NodeID i, const ICFGNode *icfgNode, const SVFType *svfType)
Definition SVFIR.h:708
void addCallSite(const CallICFGNode *call)
Add callsites.
Definition SVFIR.h:883
NodeID addValNode(NodeID i, const SVFType *type, const ICFGNode *icfgNode)
add node into SVFIR
Definition SVFIR.h:663
NodeID addVarargNode(NodeID i, const FunObjVar *val, const SVFType *type, const ICFGNode *n)
Add a unique vararg node for a procedure.
Definition SVFIR.h:796
NodeID addAsmPCValNode(NodeID i, const SVFType *type)
Definition SVFIR.h:856
void setCHG(CommonCHGraph *c)
Set/Get CHG.
Definition SVFIR.h:235
NodeID addFunObjNode(NodeID id, ObjTypeInfo *ti, const ICFGNode *node)
Definition SVFIR.h:745
ICFG * icfg
Definition SVFIR.h:98
NodeID addConstantIntObjNode(NodeID i, ObjTypeInfo *ti, const std::pair< s64_t, u64_t > &intValue, const ICFGNode *node)
Definition SVFIR.h:759
void addGlobalPAGEdge(const SVFStmt *edge)
Add global PAGEdges (not in a procedure)
Definition SVFIR.h:878
const ValVar * getValVar(NodeID id) const
Definition SVFIR.h:137
void addIndirectCallsites(const CallICFGNode *cs, NodeID funPtr)
Add indirect callsites.
Definition SVFIR.h:652
void initialiseCandidatePointers()
Initialize candidate pointers.
Definition SVFIR.cpp:731
NodeID addRetNode(NodeID i, const FunObjVar *callGraphNode, const SVFType *type, const ICFGNode *icn)
Add a unique return node for a procedure.
Definition SVFIR.h:790
NodeID addArgValNode(NodeID i, u32_t argNo, const ICFGNode *icfgNode, const FunObjVar *callGraphNode, const SVFType *type)
Definition SVFIR.h:675
void addCallSiteRets(RetICFGNode *retBlockNode, const ValVar *arg)
Add callsite returns.
Definition SVFIR.h:646
NodeID addConstantObjNode()
Definition SVFIR.h:840
const Map< const SVFBasicBlock *, BBSet > & getDomFrontierMap() const
Set< const SVFBasicBlock * > BBSet
static double getClk(bool mark=false)
Definition SVFStat.cpp:48
static double timeOfBuildingSVFIR
Definition SVFStat.h:95
GenericNode< SVFVar, SVFStmt >::GEdgeSetTy SVFStmtSetTy
virtual void setName(const std::string &nameInfo)
Definition SVFValue.h:179
SVFStmt::SVFStmtSetTy & getIncomingEdges(SVFStmt::PEDGEK kind)
Edge accessors and checkers.
#define NULL
Definition extapi.c:5
bool isIntrinsicInst(const Instruction *inst)
Return true if it is an intrinsic instruction.
Definition LLVMUtil.cpp:203
const ConstantExpr * isBinaryConstantExpr(const Value *val)
Definition LLVMUtil.h:292
bool isUncalledFunction(const Function *fun)
whether this is a function without any possible caller?
Definition LLVMUtil.cpp:158
double getDoubleValue(const ConstantFP *fpValue)
Definition LLVMUtil.h:55
bool isConstantObjSym(const Value *val)
Check whether this value points-to a constant object.
Definition CppUtil.cpp:747
const Value * stripAllCasts(const Value *val)
Strip off the all casts.
Definition LLVMUtil.cpp:250
const ConstantExpr * isInt2PtrConstantExpr(const Value *val)
Definition LLVMUtil.h:227
const ConstantExpr * isSelectConstantExpr(const Value *val)
Definition LLVMUtil.h:257
bool isMemcpyExtFun(const Function *fun)
Definition LLVMUtil.cpp:389
bool isIntrinsicFun(const Function *func)
Definition LLVMUtil.cpp:190
bool functionDoesNotRet(const Function *fun)
Definition LLVMUtil.cpp:123
const ConstantExpr * isTruncConstantExpr(const Value *val)
Definition LLVMUtil.h:267
std::pair< s64_t, u64_t > getIntegerValue(const ConstantInt *intValue)
Definition LLVMUtil.h:83
void getNextInsts(const Instruction *curInst, std::vector< const Instruction * > &instList)
Get the next instructions following control flow.
Definition LLVMUtil.cpp:578
const ConstantExpr * isPtr2IntConstantExpr(const Value *val)
Definition LLVMUtil.h:237
bool isHeapObj(const Value *val)
Definition LLVMUtil.cpp:687
const ConstantExpr * isUnaryConstantExpr(const Value *val)
Definition LLVMUtil.h:303
void getFunReachableBBs(const Function *svfFun, std::vector< const SVFBasicBlock * > &bbs)
Get reachable basic block from function entry.
Definition LLVMUtil.cpp:75
const ConstantExpr * isCastConstantExpr(const Value *val)
Definition LLVMUtil.h:247
bool isExtCall(const Function *fun)
Definition LLVMUtil.cpp:384
bool basicBlockHasRetInst(const BasicBlock *bb)
Return true if the function has a return instruction.
Definition LLVMUtil.cpp:109
bool isStackObj(const Value *val)
Definition LLVMUtil.cpp:709
const ConstantExpr * isGepConstantExpr(const Value *val)
Return corresponding constant expression, otherwise return nullptr.
Definition LLVMUtil.h:217
static DataLayout * getDataLayout(Module *mod)
Definition LLVMUtil.h:315
const Function * getCallee(const CallBase *cs)
Definition LLVMUtil.h:98
const FunObjVar * getFunObjVar(const std::string &name)
Definition LLVMUtil.cpp:436
std::string dumpValue(const Value *val)
Definition LLVMUtil.cpp:605
const ConstantExpr * isCmpConstantExpr(const Value *val)
Definition LLVMUtil.h:281
std::string pasMsg(const std::string &msg)
Print each pass/phase message by converting a string into blue string output.
Definition SVFUtil.cpp:101
void writeWrnMsg(const std::string &msg)
Writes a message run through wrnMsg.
Definition SVFUtil.cpp:68
std::ostream & outs()
Overwrite llvm::outs()
Definition SVFUtil.h:52
const Value * getVCallVtblPtr(const CallBase *cs)
Definition CppUtil.cpp:612
bool isValVtbl(const Value *val)
Definition CppUtil.cpp:336
for isBitcode
Definition BasicTypes.h:70
llvm::DataLayout DataLayout
Definition BasicTypes.h:112
llvm::GlobalVariable GlobalVariable
Definition BasicTypes.h:137
llvm::GlobalAlias GlobalAlias
Definition BasicTypes.h:135
llvm::ArrayType ArrayType
Definition BasicTypes.h:99
llvm::Type Type
Definition BasicTypes.h:87
llvm::CallBase CallBase
Definition BasicTypes.h:153
llvm::BasicBlock BasicBlock
Definition BasicTypes.h:90
llvm::UnaryOperator UnaryOperator
Definition BasicTypes.h:187
llvm::StructType StructType
LLVM types.
Definition BasicTypes.h:98
llvm::succ_const_iterator succ_const_iterator
LLVM Iterators.
Definition BasicTypes.h:287
unsigned long long u64_t
Definition GeneralType.h:49
llvm::AllocaInst AllocaInst
Definition BasicTypes.h:157
llvm::SwitchInst SwitchInst
Definition BasicTypes.h:162
u32_t NodeID
Definition GeneralType.h:56
llvm::StructLayout StructLayout
Definition BasicTypes.h:109
llvm::InvokeInst InvokeInst
Definition BasicTypes.h:170
llvm::Argument Argument
Definition BasicTypes.h:152
llvm::LoadInst LoadInst
Definition BasicTypes.h:156
s64_t APOffset
Definition GeneralType.h:60
llvm::const_pred_iterator const_pred_iterator
Definition BasicTypes.h:265
llvm::CmpInst CmpInst
Definition BasicTypes.h:166
llvm::Function Function
Definition BasicTypes.h:89
llvm::ConstantData ConstantData
Definition BasicTypes.h:120
llvm::LoopInfo LoopInfo
Definition BasicTypes.h:148
llvm::Instruction Instruction
Definition BasicTypes.h:91
llvm::Constant Constant
Definition BasicTypes.h:128
llvm::DomTreeNode DomTreeNode
Definition BasicTypes.h:141
llvm::ConstantDataSequential ConstantDataSequential
Definition BasicTypes.h:123
llvm::Value Value
LLVM Basic classes.
Definition BasicTypes.h:86
llvm::ConstantExpr ConstantExpr
Definition BasicTypes.h:124
llvm::IRBuilder IRBuilder
Definition BasicTypes.h:76
llvm::CastInst CastInst
Definition BasicTypes.h:165
llvm::FreezeInst FreezeInst
Definition BasicTypes.h:176
llvm::Module Module
Definition BasicTypes.h:88
llvm::BinaryOperator BinaryOperator
Definition BasicTypes.h:186
llvm::PostDominatorTree PostDominatorTree
Definition BasicTypes.h:143
llvm::DominanceFrontier DominanceFrontier
Definition BasicTypes.h:142
llvm::StoreInst StoreInst
Definition BasicTypes.h:155
llvm::SelectInst SelectInst
Definition BasicTypes.h:181
llvm::VAArgInst VAArgInst
Definition BasicTypes.h:182
llvm::Loop Loop
LLVM Loop.
Definition BasicTypes.h:147
llvm::GetElementPtrInst GetElementPtrInst
Definition BasicTypes.h:169
llvm::CallBrInst CallBrInst
Definition BasicTypes.h:163
llvm::ReturnInst ReturnInst
Definition BasicTypes.h:164
llvm::PHINode PHINode
Definition BasicTypes.h:172
llvm::BranchInst BranchInst
Definition BasicTypes.h:161
llvm::ExtractValueInst ExtractValueInst
Definition BasicTypes.h:167
unsigned u32_t
Definition GeneralType.h:47
signed long long s64_t
Definition GeneralType.h:50
llvm::CallInst CallInst
Definition BasicTypes.h:154
llvm::ConstantInt ConstantInt
Definition BasicTypes.h:129
llvm::DominatorTree DominatorTree
LLVM Dominators.
Definition BasicTypes.h:140
llvm::ExtractElementInst ExtractElementInst
Definition BasicTypes.h:168
llvm::User User
Definition BasicTypes.h:149