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<InlineAsm>(llvmValue) ||
514 SVFUtil::isa<DSOLocalEquivalent>(llvmValue) ||
515 SVFUtil::isa<NoCFIValue>(llvmValue))
516 {
517 pag->addAsmPCValNode(iter->second, llvmModuleSet()->getSVFType(llvmValue->getType()));
518 }
519 else if (const Instruction* inst = SVFUtil::dyn_cast<Instruction>(llvmValue))
520 {
522 pag->addIntrinsicValNode(iter->second, llvmModuleSet()->getSVFType(llvmValue->getType()));
523 else
524 {
525 assert(llvmModuleSet()->hasICFGNode(inst) && "LLVM instruction is not associated with an ICFGNode");
526 icfgNode = llvmModuleSet()->getICFGNode(inst);
527 pag->addValNode(iter->second, llvmModuleSet()->getSVFType(llvmValue->getType()), icfgNode);
528 }
529 }
531 pag->getGNode(iter->second));
532 }
533}
534
535
536/*
537 * Initial all the nodes from symbol table
538 */
540{
541 DBOUT(DPAGBuild, outs() << "Initialise SVFIR Nodes ...\n");
542
543
548
551
552 for (LLVMModuleSet::FunToIDMapTy::iterator iter =
553 llvmModuleSet()->retSyms().begin(); iter != llvmModuleSet()->retSyms().end();
554 ++iter)
555 {
556 const Value* llvmValue = iter->first;
557 // retSyms keys are Function*, not Instruction, so dyn_cast<Instruction> always fails.
558 // RetValPN represents the callee's return value, defined at FunExitICFGNode.
559 // External functions have no exit node, so keep nullptr.
560 const FunObjVar* funObjVar = llvmModuleSet()->getFunObjVar(SVFUtil::cast<Function>(llvmValue));
561 const ICFGNode* icfgNode = funObjVar->isDeclaration() ? nullptr : pag->getICFG()->getFunExitICFGNode(funObjVar);
562 DBOUT(DPAGBuild, outs() << "add ret node " << iter->second << "\n");
563 pag->addRetNode(iter->second,
564 funObjVar,
565 llvmModuleSet()->getSVFType(iter->first->getType()), icfgNode);
567 pag->returnFunObjSymMap[funObjVar] = iter->second;
568 }
569
570 for (LLVMModuleSet::FunToIDMapTy::iterator iter =
571 llvmModuleSet()->varargSyms().begin();
572 iter != llvmModuleSet()->varargSyms().end(); ++iter)
573 {
574 const Value* llvmValue = iter->first;
575 // varargSyms keys are Function*, not Instruction.
576 // Variadic arguments are received at the function entry point.
577 // External functions have no entry node, so keep nullptr.
578 const FunObjVar* funObjVar = llvmModuleSet()->getFunObjVar(SVFUtil::cast<Function>(llvmValue));
579 const ICFGNode* icfgNode = funObjVar->isDeclaration() ? nullptr : pag->getICFG()->getFunEntryICFGNode(funObjVar);
580 DBOUT(DPAGBuild, outs() << "add vararg node " << iter->second << "\n");
581 pag->addVarargNode(iter->second,
582 funObjVar,
583 llvmModuleSet()->getSVFType(iter->first->getType()), icfgNode);
585 pag->varargFunObjSymMap[funObjVar] = iter->second;
586 }
587
589 for (LLVMModuleSet::ValueToIDMapTy::iterator iter =
590 llvmModuleSet()->objSyms().begin(); iter != llvmModuleSet()->objSyms().end(); ++iter)
591 {
592 DBOUT(DPAGBuild, outs() << "add address edges for constant node " << iter->second << "\n");
593 const Value* val = iter->first;
595 {
597 if(ptr!= pag->getBlkPtr() && ptr!= pag->getNullPtr())
598 {
600 addAddrEdge(iter->second, ptr);
601 }
602 }
603 }
604
606 && "not all node have been initialized!!!");
607
609 for (auto& fun: llvmModuleSet()->getFunctionSet())
610 {
611 for (const Argument& arg : fun->args())
612 {
613 const_cast<FunObjVar*>(llvmModuleSet()->getFunObjVar(fun))->addArgument(SVFUtil::cast<ArgValVar>(
615 }
616 }
617
618}
619
620/*
621 https://github.com/SVF-tools/SVF/issues/524
622 Handling single value types, for constant index, including pointer, integer, etc
623 e.g. field_idx = getelementptr i8, %i8* %p, i64 -4
624 We can obtain the field index by inferring the byteoffset if %p is casted from a pointer to a struct
625 For another example, the following can be an array access.
626 e.g. field_idx = getelementptr i8, %struct_type %p, i64 1
627
628*/
630{
631 return 0;
632}
633
641{
642 assert(V);
643
644 const llvm::GEPOperator *gepOp = SVFUtil::dyn_cast<const llvm::GEPOperator>(V);
645 DataLayout * dataLayout = getDataLayout(llvmModuleSet()->getMainLLVMModule());
646 llvm::APInt byteOffset(dataLayout->getIndexSizeInBits(gepOp->getPointerAddressSpace()),0,true);
647 if(gepOp && dataLayout && gepOp->accumulateConstantOffset(*dataLayout,byteOffset))
648 {
649 //s32_t bo = byteOffset.getSExtValue();
650 }
651
652 bool isConst = true;
653
654 bool prevPtrOperand = false;
655 for (bridge_gep_iterator gi = bridge_gep_begin(*V), ge = bridge_gep_end(*V);
656 gi != ge; ++gi)
657 {
658 const Type* gepTy = *gi;
660
661 assert((prevPtrOperand && svfGepTy->isPointerTy()) == false &&
662 "Expect no more than one gep operand to be of a pointer type");
663 if(!prevPtrOperand && svfGepTy->isPointerTy()) prevPtrOperand = true;
664 const Value* offsetVal = gi.getOperand();
665 assert(gepTy != offsetVal->getType() && "iteration and operand have the same type?");
666
667 const ArrayType* inferredPtrArrayTy = nullptr;
668 const SVFType* idxGepTy = svfGepTy;
669 if (svfGepTy->isPointerTy() && gepOp->getSourceElementType()->isSingleValueType())
670 {
671 const Type* baseObjType =
673 if (const auto* arrTy = SVFUtil::dyn_cast<ArrayType>(baseObjType))
674 {
675 if (arrTy->getElementType()->isPointerTy())
676 {
679 }
680 }
681 }
682
684
685 //The int value of the current index operand
686 const ConstantInt* op = SVFUtil::dyn_cast<ConstantInt>(offsetVal);
687
688 // if Options::ModelConsts() is disabled. We will treat whole array as one,
689 // but we can distinguish different field of an array of struct, e.g. s[1].f1 is different from s[0].f2
690 if(const ArrayType* arrTy = SVFUtil::dyn_cast<ArrayType>(gepTy))
691 {
692 if (!Options::ModelArrays() && arrTy->getElementType()->isPointerTy())
693 continue;
694 if(!op || (arrTy->getArrayNumElements() <= (u32_t)LLVMUtil::getIntegerValue(op).first))
695 continue;
699 }
700 else if (const StructType *ST = SVFUtil::dyn_cast<StructType>(gepTy))
701 {
702 assert(op && "non-const offset accessing a struct");
703 // guard against negative or out-of-bounds struct indices
704 // (e.g. rust hashbrown bucket back-offset: gep { ... }, ptr %p, i64 -1)
705 // a negative i64 wraps to a huge uint64_t that overflows u32_t,
706 // creating an invalid field index that severs points-to tracking
708 if (rawIdx >= ST->getNumElements())
709 {
710 isConst = false;
711 continue;
712 }
716 }
717 else if (gepTy->isSingleValueType())
718 {
720 {
721 if (!op || (inferredPtrArrayTy->getArrayNumElements() <= (u32_t)LLVMUtil::getIntegerValue(op).first))
722 continue;
726 continue;
727 }
728 // If it's a non-constant offset access
729 // If its point-to target is struct or array, it's likely an array accessing (%result = gep %struct.A* %a, i32 %non-const-index)
730 // If its point-to target is single value (pointer arithmetic), then it's a variant gep (%result = gep i8* %p, i32 %non-const-index)
731 if(!op && gepTy->isPointerTy() && gepOp->getSourceElementType()->isSingleValueType())
732 {
733 isConst = false;
734 }
735
736 // The actual index
737 //s32_t idx = op->getSExtValue();
738
739 // For pointer arithmetic we ignore the byte offset
740 // consider using inferFieldIdxFromByteOffset(geopOp,dataLayout,ap,idx)?
741 // ap.setFldIdx(ap.getConstantFieldIdx() + inferFieldIdxFromByteOffset(geopOp,idx));
742 }
743 }
744 return isConst;
745}
746
751{
752 if (const Constant* ref = SVFUtil::dyn_cast<Constant>(val))
753 {
755 {
756 DBOUT(DPAGBuild, outs() << "handle gep constant expression "
757 << LLVMUtil::dumpValue(ref) << "\n");
758 const Constant* opnd = gepce->getOperand(0);
759 // handle recursive constant express case (gep (bitcast (gep X 1)) 1)
761 auto &GEPOp = llvm::cast<llvm::GEPOperator>(*gepce);
762 Type *pType = GEPOp.getSourceElementType();
763 AccessPath ap(0, llvmModuleSet()->getSVFType(pType));
764 bool constGep = computeGepOffset(gepce, ap);
765 // must invoke pag methods here, otherwise it will be a dead recursion cycle
766 const Value* cval = getCurrentValue();
767 const SVFBasicBlock* cbb = getCurrentBB();
769 /*
770 * The gep edge created are like constexpr (same edge may appear at multiple callsites)
771 * so bb/inst of this edge may be rewritten several times, we treat it as global here.
772 */
775 }
776 else if (const ConstantExpr* castce = isCastConstantExpr(ref))
777 {
778 DBOUT(DPAGBuild, outs() << "handle cast constant expression "
779 << LLVMUtil::dumpValue(ref) << "\n");
780 const Constant* opnd = castce->getOperand(0);
782 const Value* cval = getCurrentValue();
783 const SVFBasicBlock* cbb = getCurrentBB();
787 }
789 {
790 DBOUT(DPAGBuild, outs() << "handle select constant expression "
791 << LLVMUtil::dumpValue(ref) << "\n");
792 const Constant* src1 = selectce->getOperand(1);
793 const Constant* src2 = selectce->getOperand(2);
796 const Value* cval = getCurrentValue();
797 const SVFBasicBlock* cbb = getCurrentBB();
799 NodeID cond = llvmModuleSet()->getValueNode(selectce->getOperand(0));
805 }
806 // if we meet a int2ptr, then it points-to black hole
808 {
809 const Constant* opnd = int2Ptrce->getOperand(0);
811 const SVFBasicBlock* cbb = getCurrentBB();
812 const Value* cval = getCurrentValue();
816 }
818 {
819 const Constant* opnd = ptr2Intce->getOperand(0);
821 const SVFBasicBlock* cbb = getCurrentBB();
822 const Value* cval = getCurrentValue();
826 }
828 {
829 // we don't handle trunc and cmp instruction for now
830 const Value* cval = getCurrentValue();
831 const SVFBasicBlock* cbb = getCurrentBB();
836 }
837 else if (isBinaryConstantExpr(ref))
838 {
839 // we don't handle binary constant expression like add(x,y) now
840 const Value* cval = getCurrentValue();
841 const SVFBasicBlock* cbb = getCurrentBB();
846 }
847 else if (isUnaryConstantExpr(ref))
848 {
849 // we don't handle unary constant expression like fneg(x) now
850 const Value* cval = getCurrentValue();
851 const SVFBasicBlock* cbb = getCurrentBB();
856 }
857 else if (SVFUtil::isa<ConstantAggregate>(ref))
858 {
859 // we don't handle constant aggregate like constant vectors
860 }
861 else if (SVFUtil::isa<BlockAddress>(ref))
862 {
863 // blockaddress instruction (e.g. i8* blockaddress(@run_vm, %182))
864 // is treated as constant data object for now, see LLVMUtil.h:397, SymbolTableInfo.cpp:674 and SVFIRBuilder.cpp:183-194
865 const Value* cval = getCurrentValue();
866 const SVFBasicBlock* cbb = getCurrentBB();
871 }
872 else
873 {
874 if(SVFUtil::isa<ConstantExpr>(val))
875 assert(false && "we don't handle all other constant expression for now!");
876 }
877 }
878}
885{
886
887 // if the global variable do not have any field needs to be initialized
888 if (offset == 0 && gvar->getInitializer()->getType()->isSingleValueType())
889 {
890 return getValueNode(gvar);
891 }
894 else
895 {
897 }
898}
899
900/*For global variable initialization
901 * Give a simple global variable
902 * int x = 10; // store 10 x (constant, non pointer) |
903 * int *y = &x; // store x y (pointer type)
904 * Given a struct
905 * struct Z { int s; int *t;};
906 * Global initialization:
907 * struct Z z = {10,&x}; // store x z.t (struct type)
908 * struct Z *m = &z; // store z m (pointer type)
909 * struct Z n = {10,&z.s}; // store z.s n , &z.s constant expression (constant expression)
910 */
913{
914 DBOUT(DPAGBuild, outs() << "global " << LLVMUtil::dumpValue(gvar)
915 << " constant initializer: "
916 << LLVMUtil::dumpValue(C) << "\n");
917 if (C->getType()->isSingleValueType())
918 {
919 NodeID src = getValueNode(C);
920 // get the field value if it is available, otherwise we create a dummy field node.
922 NodeID field = getGlobalVarField(gvar, offset, llvmModuleSet()->getSVFType(C->getType()));
923
924 if (SVFUtil::isa<GlobalVariable, Function>(C))
925 {
927 addStoreEdge(src, field);
928 }
929 else if (SVFUtil::isa<ConstantExpr>(C))
930 {
931 // add gep edge of C1 itself is a constant expression
932 processCE(C);
934 addStoreEdge(src, field);
935 }
936 else if (SVFUtil::isa<BlockAddress>(C))
937 {
938 // blockaddress instruction (e.g. i8* blockaddress(@run_vm, %182))
939 // is treated as constant data object for now, see LLVMUtil.h:397, SymbolTableInfo.cpp:674 and SVFIRBuilder.cpp:183-194
940 processCE(C);
943 }
944 else
945 {
947 addStoreEdge(src, field);
949 if (C->getType()->isPtrOrPtrVectorTy() && src != pag->getNullPtr())
951 }
952 }
953 else if (SVFUtil::isa<ConstantArray, ConstantStruct>(C))
954 {
956 return;
957 for (u32_t i = 0, e = C->getNumOperands(); i != e; i++)
958 {
960 InitialGlobal(gvar, SVFUtil::cast<Constant>(C->getOperand(i)), offset + off);
961 }
962 }
963 else if(ConstantData* data = SVFUtil::dyn_cast<ConstantData>(C))
964 {
966 {
967 if(ConstantDataSequential* seq = SVFUtil::dyn_cast<ConstantDataSequential>(data))
968 {
969 for(u32_t i = 0; i < seq->getNumElements(); i++)
970 {
971 u32_t off = pag->getFlattenedElemIdx(llvmModuleSet()->getSVFType(C->getType()), i);
972 Constant* ct = seq->getElementAsConstant(i);
974 }
975 }
976 else
977 {
978 assert((SVFUtil::isa<ConstantAggregateZero, UndefValue>(data)) && "Single value type data should have been handled!");
979 }
980 }
981 }
982 else
983 {
984 //TODO:assert(SVFUtil::isa<ConstantVector>(C),"what else do we have");
985 }
986}
987
992{
993
996 {
997 for (Module::global_iterator I = M.global_begin(), E = M.global_end(); I != E; ++I)
998 {
999 GlobalVariable *gvar = &*I;
1002
1005
1006 if (gvar->hasInitializer())
1007 {
1008 Constant *C = gvar->getInitializer();
1009 DBOUT(DPAGBuild, outs() << "add global var node "
1010 << LLVMUtil::dumpValue(gvar) << "\n");
1011 InitialGlobal(gvar, C, 0);
1012 }
1013 }
1014
1015
1017 for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I)
1018 {
1019 const Function* fun = &*I;
1020 NodeID idx = getValueNode(fun);
1021 NodeID obj = getObjectNode(fun);
1022
1023 DBOUT(DPAGBuild, outs() << "add global function node " << fun->getName().str() << "\n");
1024 setCurrentLocation(fun, (SVFBasicBlock*) nullptr);
1026 }
1027
1028 // 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.
1029 for (Module::alias_iterator I = M.alias_begin(), E = M.alias_end(); I != E; I++)
1030 {
1031 const GlobalAlias* alias = &*I;
1032 NodeID dst = llvmModuleSet()->getValueNode(alias);
1033 NodeID src = llvmModuleSet()->getValueNode(alias->getAliasee());
1034 processCE(alias->getAliasee());
1035 setCurrentLocation(alias, (SVFBasicBlock*) nullptr);
1036 addCopyEdge(src, dst, CopyStmt::COPYVAL);
1037 }
1038 }
1039}
1040
1046{
1047
1048 // AllocaInst should always be a pointer type
1049 assert(SVFUtil::isa<PointerType>(inst.getType()));
1050
1052 outs() << "process alloca " << LLVMUtil::dumpValue(&inst) << "\n");
1053 NodeID dst = getValueNode(&inst);
1054
1055 NodeID src = getObjectNode(&inst);
1056
1057 addAddrWithStackArraySz(src, dst, inst);
1058
1059}
1060
1065{
1066
1068 outs() << "process phi " << LLVMUtil::dumpValue(&inst) << "\n");
1069
1070 NodeID dst = getValueNode(&inst);
1071
1072 for (u32_t i = 0; i < inst.getNumIncomingValues(); ++i)
1073 {
1074 const Value* val = inst.getIncomingValue(i);
1075 const Instruction* incomingInst = SVFUtil::dyn_cast<Instruction>(val);
1076 bool matched = (incomingInst == nullptr ||
1077 incomingInst->getFunction() == inst.getFunction());
1078 (void) matched; // Suppress warning of unused variable under release build
1079 assert(matched && "incomingInst's Function incorrect");
1080 const Instruction* predInst = &inst.getIncomingBlock(i)->back();
1081 const ICFGNode* icfgNode = llvmModuleSet()->getICFGNode(predInst);
1082 NodeID src = getValueNode(val);
1083 addPhiStmt(dst,src,icfgNode);
1084 }
1085}
1086
1087/*
1088 * Visit load instructions
1089 */
1091{
1093 outs() << "process load " << LLVMUtil::dumpValue(&inst) << "\n");
1094
1095 NodeID dst = getValueNode(&inst);
1096
1097 NodeID src = getValueNode(inst.getPointerOperand());
1098 const Type* loadedTy = inst.getType();
1099 if (NodeID fieldZero = getDirectAccessFieldZeroValVar(inst.getPointerOperand(), loadedTy))
1100 src = fieldZero;
1101
1102 addLoadEdge(src, dst);
1103}
1104
1109{
1110 // StoreInst itself should always not be a pointer type
1111 assert(!SVFUtil::isa<PointerType>(inst.getType()));
1112
1114 outs() << "process store " << LLVMUtil::dumpValue(&inst) << "\n");
1115
1116 NodeID dst = getValueNode(inst.getPointerOperand());
1117 const Type* storedTy = inst.getValueOperand()->getType();
1118 if (NodeID fieldZero = getDirectAccessFieldZeroValVar(inst.getPointerOperand(), storedTy))
1119 dst = fieldZero;
1120
1121 NodeID src = getValueNode(inst.getValueOperand());
1122
1123 addStoreEdge(src, dst);
1124
1125}
1126
1131{
1132
1133 NodeID dst = getValueNode(&inst);
1134 // GetElementPtrInst should always be a pointer or a vector contains pointers
1135 // for now we don't handle vector type here
1136 if(SVFUtil::isa<VectorType>(inst.getType()))
1137 {
1139 return;
1140 }
1141
1142 assert(SVFUtil::isa<PointerType>(inst.getType()));
1143
1145 outs() << "process gep " << LLVMUtil::dumpValue(&inst) << "\n");
1146
1147 NodeID src = getValueNode(inst.getPointerOperand());
1148
1149 AccessPath ap(0, llvmModuleSet()->getSVFType(inst.getSourceElementType()));
1150 bool constGep = computeGepOffset(&inst, ap);
1152 {
1153 const Type* baseObjType =
1154 LLVMModuleSet::getLLVMModuleSet()->getTypeInference()->inferObjType(inst.getPointerOperand());
1155 if (const auto* arrTy = SVFUtil::dyn_cast<ArrayType>(baseObjType))
1156 {
1157 if (arrTy->getElementType()->isPointerTy())
1158 {
1159 addCopyEdge(src, dst, CopyStmt::COPYVAL);
1160 return;
1161 }
1162 }
1163 }
1164 addGepEdge(src, dst, ap, constGep);
1165}
1166
1167/*
1168 * Visit cast instructions
1169 */
1171{
1172
1174 outs() << "process cast " << LLVMUtil::dumpValue(&inst) << "\n");
1175 NodeID dst = getValueNode(&inst);
1176
1177 const Value* opnd = inst.getOperand(0);
1178 NodeID src = getValueNode(opnd);
1179 addCopyEdge(src, dst, getCopyKind(&inst));
1180}
1181
1186{
1187 NodeID dst = getValueNode(&inst);
1188 assert(inst.getNumOperands() == 2 && "not two operands for BinaryOperator?");
1189 Value* op1 = inst.getOperand(0);
1191 Value* op2 = inst.getOperand(1);
1193 u32_t opcode = inst.getOpcode();
1194 addBinaryOPEdge(op1Node, op2Node, dst, opcode);
1195}
1196
1201{
1202 NodeID dst = getValueNode(&inst);
1203 assert(inst.getNumOperands() == 1 && "not one operand for Unary instruction?");
1204 Value* opnd = inst.getOperand(0);
1205 NodeID src = getValueNode(opnd);
1206 u32_t opcode = inst.getOpcode();
1207 addUnaryOPEdge(src, dst, opcode);
1208}
1209
1214{
1215 NodeID dst = getValueNode(&inst);
1216 assert(inst.getNumOperands() == 2 && "not two operands for compare instruction?");
1217 Value* op1 = inst.getOperand(0);
1219 Value* op2 = inst.getOperand(1);
1221 u32_t predicate = inst.getPredicate();
1222 addCmpEdge(op1Node, op2Node, dst, predicate);
1223}
1224
1225
1230{
1231
1233 outs() << "process select " << LLVMUtil::dumpValue(&inst) << "\n");
1234
1235 NodeID dst = getValueNode(&inst);
1236 NodeID src1 = getValueNode(inst.getTrueValue());
1237 NodeID src2 = getValueNode(inst.getFalseValue());
1238 NodeID cond = getValueNode(inst.getCondition());
1240 addSelectStmt(dst,src1,src2, cond);
1241}
1242
1247
1252
1257
1258/*
1259 * Visit callsites
1260 */
1262{
1263
1264 // skip llvm intrinsics
1265 if(isIntrinsicInst(cs))
1266 return;
1267
1269 outs() << "process callsite " << LLVMUtil::dumpValue(cs) << "\n");
1270
1271 CallICFGNode* callBlockNode = llvmModuleSet()->getCallICFGNode(cs);
1273
1274 pag->addCallSite(callBlockNode);
1275
1277 for (u32_t i = 0; i < cs->arg_size(); i++)
1279 callBlockNode,
1280 pag->getValVar(getValueNode(cs->getArgOperand(i))));
1281
1282 if(!cs->getType()->isVoidTy())
1284
1285 if (callBlockNode->isVirtualCall())
1286 {
1287 const Value* value = cppUtil::getVCallVtblPtr(cs);
1288 callBlockNode->setVtablePtr(pag->getGNode(getValueNode(value)));
1289 }
1290 if (const Function *callee = LLVMUtil::getCallee(cs))
1291 {
1293 {
1294 handleExtCall(cs, callee);
1295 }
1296 else
1297 {
1299 }
1300 }
1301 else
1302 {
1303 //If the callee was not identified as a function (null F), this is indirect.
1304 handleIndCall(cs);
1305 }
1306}
1307
1312{
1313
1314 // ReturnInst itself should always not be a pointer type
1315 assert(!SVFUtil::isa<PointerType>(inst.getType()));
1316
1318 outs() << "process return " << LLVMUtil::dumpValue(&inst) << "\n");
1319
1320 if(Value* src = inst.getReturnValue())
1321 {
1322 const FunObjVar *F = llvmModuleSet()->getFunObjVar(inst.getParent()->getParent());
1323
1325 NodeID vnS = getValueNode(src);
1326 const ICFGNode* icfgNode = llvmModuleSet()->getICFGNode(&inst);
1327 //vnS may be null if src is a null ptr
1328 addPhiStmt(rnF,vnS,icfgNode);
1329 }
1330}
1331
1332
1346
1360
1366{
1367 NodeID brinst = getValueNode(&inst);
1368 NodeID cond;
1369 if (inst.isConditional())
1370 cond = getValueNode(inst.getCondition());
1371 else
1372 cond = pag->getNullPtr();
1373
1374 assert(inst.getNumSuccessors() <= 2 && "if/else has more than two branches?");
1375
1377 std::vector<const Instruction*> nextInsts;
1379 u32_t branchID = 0;
1380 for (const Instruction* succInst : nextInsts)
1381 {
1382 assert(branchID <= 1 && "if/else has more than two branches?");
1383 const ICFGNode* icfgNode = llvmModuleSet()->getICFGNode(succInst);
1384 successors.push_back(std::make_pair(icfgNode, 1-branchID));
1385 branchID++;
1386 }
1387 addBranchStmt(brinst, cond, successors);
1389 if (inst.isConditional())
1390 {
1391 for (auto& edge : llvmModuleSet()->getICFGNode(&inst)->getOutEdges())
1392 {
1393 if (IntraCFGEdge* intraEdge = SVFUtil::dyn_cast<IntraCFGEdge>(edge))
1394 {
1395 intraEdge->setConditionVar(pag->getGNode(cond));
1396 }
1397 }
1398 }
1399}
1400
1401
1445
1448{
1449 NodeID brinst = getValueNode(&inst);
1450 NodeID cond = getValueNode(inst.getCondition());
1451
1453 std::vector<const Instruction*> nextInsts;
1455 for (const Instruction* succInst : nextInsts)
1456 {
1458 const ConstantInt* condVal = inst.findCaseDest(const_cast<BasicBlock*>(succInst->getParent()));
1460 s64_t val = -1;
1461 if (condVal && condVal->getBitWidth() <= 64)
1463 const ICFGNode* icfgNode = llvmModuleSet()->getICFGNode(succInst);
1464 successors.push_back(std::make_pair(icfgNode, val));
1465 }
1466 addBranchStmt(brinst, cond, successors);
1468 for (auto& edge : llvmModuleSet()->getICFGNode(&inst)->getOutEdges())
1469 {
1470 if (IntraCFGEdge* intraEdge = SVFUtil::dyn_cast<IntraCFGEdge>(edge))
1471 {
1472 intraEdge->setConditionVar(pag->getGNode(cond));
1473 }
1474 }
1475}
1476
1477
1484{
1485 NodeID dst = getValueNode(&inst);
1486 Value* opnd = inst.getPointerOperand();
1487 NodeID src = getValueNode(opnd);
1488 addCopyEdge(src, dst, CopyStmt::COPYVAL);
1489}
1490
1496{
1497 NodeID dst = getValueNode(&inst);
1498 for (u32_t i = 0; i < inst.getNumOperands(); i++)
1499 {
1500 Value* opnd = inst.getOperand(i);
1501 NodeID src = getValueNode(opnd);
1502 addCopyEdge(src, dst, CopyStmt::COPYVAL);
1503 }
1504}
1505
1506
1511{
1512
1513 assert(F);
1516 DBOUT(DPAGBuild, outs() << "handle direct call " << LLVMUtil::dumpValue(cs)
1517 << " callee " << F->getName().str() << "\n");
1518
1519 //Only handle the ret.val. if it's used as a ptr.
1521 //Does it actually return a ptr?
1522 if (!cs->getType()->isVoidTy())
1523 {
1527 }
1528 //Iterators for the actual and formal parameters
1529 u32_t itA = 0, ieA = cs->arg_size();
1530 Function::const_arg_iterator itF = F->arg_begin(), ieF = F->arg_end();
1531 //Go through the fixed parameters.
1532 DBOUT(DPAGBuild, outs() << " args:");
1533 for (; itF != ieF; ++itA, ++itF)
1534 {
1535 //Some programs (e.g. Linux kernel) leave unneeded parameters empty.
1536 if (itA == ieA)
1537 {
1538 DBOUT(DPAGBuild, outs() << " !! not enough args\n");
1539 break;
1540 }
1541 const Value* AA = cs->getArgOperand(itA), *FA = &*itF; //current actual/formal arg
1542
1543 DBOUT(DPAGBuild, outs() << "process actual parm "
1544 << LLVMUtil::dumpValue(AA) << "\n");
1545
1550 }
1551 //Any remaining actual args must be varargs.
1552 if (F->isVarArg())
1553 {
1555 DBOUT(DPAGBuild, outs() << "\n varargs:");
1556 for (; itA != ieA; ++itA)
1557 {
1558 const Value* AA = cs->getArgOperand(itA);
1562 }
1563 }
1564 if(itA != ieA)
1565 {
1568 writeWrnMsg("too many args to non-vararg func.");
1569 writeWrnMsg("(" + callICFGNode->getSourceLoc() + ")");
1570
1571 }
1572}
1573
1606{
1607 const Value* value = stripAllCasts(V);
1608 assert(value && "null ptr?");
1610 [this](const GlobalVariable* glob, int64_t byteOffset) -> const Value*
1611 {
1612 if (!glob || !glob->hasInitializer())
1613 return nullptr;
1614
1615 auto* initializer = SVFUtil::dyn_cast<ConstantStruct>(glob->getInitializer());
1616 auto* structType = SVFUtil::dyn_cast<StructType>(glob->getValueType());
1617 if (!initializer || !structType)
1618 return nullptr;
1619
1620 DataLayout* dataLayout = getDataLayout(llvmModuleSet()->getMainLLVMModule());
1621 const StructLayout* layout =
1622 dataLayout->getStructLayout(const_cast<StructType*>(structType));
1623 for (u32_t fieldIdx = 0; fieldIdx < initializer->getNumOperands(); ++fieldIdx)
1624 {
1625 if (layout->getElementOffset(fieldIdx) != static_cast<uint64_t>(byteOffset))
1626 continue;
1627 if (auto* ptrValue =
1628 SVFUtil::dyn_cast<llvm::GlobalVariable>(initializer->getOperand(fieldIdx)))
1629 return ptrValue;
1630 return nullptr;
1631 }
1632 return nullptr;
1633 };
1634
1635 if(const GetElementPtrInst* gep = SVFUtil::dyn_cast<GetElementPtrInst>(value))
1636 {
1637 APOffset totalidx = 0;
1638 for (bridge_gep_iterator gi = bridge_gep_begin(gep), ge = bridge_gep_end(gep); gi != ge; ++gi)
1639 {
1640 if(const ConstantInt* op = SVFUtil::dyn_cast<ConstantInt>(gi.getOperand()))
1642 }
1643 if(totalidx == 0 && !SVFUtil::isa<StructType>(value->getType()))
1644 value = gep->getPointerOperand();
1645 }
1646 else if (const LoadInst* load = SVFUtil::dyn_cast<LoadInst>(value))
1647 {
1648 const Value* loadP = load->getPointerOperand();
1649 if (const GetElementPtrInst* gep = SVFUtil::dyn_cast<GetElementPtrInst>(loadP))
1650 {
1651 DataLayout* dataLayout = getDataLayout(llvmModuleSet()->getMainLLVMModule());
1652 llvm::APInt byteOffset(dataLayout->getIndexSizeInBits(gep->getPointerAddressSpace()), 0, true);
1653 const bool hasByteOffset = dataLayout && gep->accumulateConstantOffset(*dataLayout, byteOffset);
1654
1655 const Value * pointer_operand = gep->getPointerOperand();
1656 if (auto *glob = SVFUtil::dyn_cast<GlobalVariable>(pointer_operand))
1657 {
1658 if (hasByteOffset)
1659 {
1660 if (const Value* ptrValue = getGlobalFieldFromByteOffset(glob, byteOffset.getSExtValue()))
1661 return ptrValue;
1662 }
1663 }
1664 else if (hasByteOffset && !byteOffset.isNegative() &&
1665 SVFUtil::isa<AllocaInst>(pointer_operand) && load->getType()->isPointerTy())
1666 {
1667 const u64_t offset = byteOffset.getZExtValue();
1668 const u64_t accessBytes = dataLayout->getPointerSize(gep->getPointerAddressSpace());
1669
1670 auto isCoveredByMemcpy = [offset, accessBytes](const CallBase* cs) -> bool
1671 {
1672 if (cs->arg_size() < 3)
1673 return false;
1674
1675 const auto* copySize = SVFUtil::dyn_cast<ConstantInt>(cs->getArgOperand(2));
1676 if (!copySize)
1677 return false;
1678
1679 const u64_t copyBytes = copySize->getZExtValue();
1681 };
1682
1683 auto hasInterveningWrite = [load](const Instruction* from) -> bool
1684 {
1685 if (from->getParent() != load->getParent() || !from->comesBefore(load))
1686 return true;
1687
1688 auto it = from->getIterator();
1689 const auto end = load->getIterator();
1690 while (++it != end)
1691 {
1692 if (it->mayWriteToMemory())
1693 return true;
1694 }
1695 return false;
1696 };
1697
1698 for (const auto& use : pointer_operand->users())
1699 {
1700 const auto* cs = SVFUtil::dyn_cast<CallBase>(use);
1701 if (!cs || cs->getParent() != load->getParent() ||
1702 cs->arg_size() < 1 ||
1703 stripAllCasts(cs->getArgOperand(0)) != pointer_operand)
1704 continue;
1705
1706 const Function* calledFun = cs->getCalledFunction();
1709 continue;
1710
1711 const Value* copiedFrom = getBaseValueForExtArg(cs->getArgOperand(1));
1712 if (const auto* copiedGlob = SVFUtil::dyn_cast<GlobalVariable>(copiedFrom))
1713 {
1714 if (const Value* ptrValue =
1715 getGlobalFieldFromByteOffset(copiedGlob, byteOffset.getSExtValue()))
1716 return ptrValue;
1717 }
1718 }
1719 }
1720 }
1721 }
1722
1723 return value;
1724}
1725
1730{
1732 NodeID indFunPtrId = llvmModuleSet()->getValueNode(cs->getCalledOperand());
1733 const_cast<CallICFGNode*>(cbn)->setIndFunPtr(pag->getGNode(indFunPtrId));
1735}
1736
1738{
1739 CallGraph::CallEdgeMap::const_iterator iter = callgraph->getIndCallMap().begin();
1740 CallGraph::CallEdgeMap::const_iterator eiter = callgraph->getIndCallMap().end();
1741 for (; iter != eiter; iter++)
1742 {
1743 const CallICFGNode* callBlock = iter->first;
1744 const CallBase* callbase = SVFUtil::cast<CallBase>(llvmModuleSet()->getLLVMValue(callBlock));
1745 assert(callBlock->isIndirectCall() && "this is not an indirect call?");
1746 const CallGraph::FunctionSet& functions = iter->second;
1747 for (CallGraph::FunctionSet::const_iterator func_iter = functions.begin(); func_iter != functions.end(); func_iter++)
1748 {
1749 const Function* callee = SVFUtil::cast<Function>(llvmModuleSet()->getLLVMValue(*func_iter));
1750
1751 if (isExtCall(*func_iter))
1752 {
1753 setCurrentLocation(callee, callee->empty() ? nullptr : &callee->getEntryBlock());
1755 }
1756 else
1757 {
1758 setCurrentLocation(llvmModuleSet()->getLLVMValue(callBlock), callBlock->getBB());
1759 handleDirectCall(const_cast<CallBase*>(callbase), callee);
1760 }
1761 }
1762 }
1763
1764 // dump SVFIR
1766 pag->dump("svfir_final");
1767}
1768
1769/*
1770 * TODO: more sanity checks might be needed here
1771 */
1773{
1774 for (SVFIR::iterator nIter = pag->begin(); nIter != pag->end(); ++nIter)
1775 {
1776 (void) pag->getGNode(nIter->first);
1777 //TODO::
1778 // (1) every source(root) node of a pag tree should be object node
1779 // if a node has no incoming edge, but has outgoing edges
1780 // then it has to be an object node.
1781 // (2) make sure every variable should be initialized
1782 // otherwise it causes the a null pointer, the aliasing relation may not be captured
1783 // when loading a pointer value should make sure
1784 // some value has been store into this pointer before
1785 // q = load p, some value should stored into p first like store w p;
1786 // (3) make sure PAGNode should not have a const expr value (pointer should have unique def)
1787 // (4) look closely into addComplexConsForExt, make sure program locations(e.g.,inst bb)
1788 // are set correctly for dummy gepval node
1789 // (5) reduce unnecessary copy edge (const casts) and ensure correctness.
1790 }
1791}
1792
1793
1798NodeID SVFIRBuilder::getGepValVar(const Value* val, const AccessPath& ap, const SVFType* elementType)
1799{
1800 NodeID base = getValueNode(val);
1802 if (gepval==UINT_MAX)
1803 {
1804 assert(((int) UINT_MAX)==-1 && "maximum limit of unsigned int is not -1?");
1805 /*
1806 * getGepValVar can only be called from two places:
1807 * 1. SVFIRBuilder::addComplexConsForExt to handle external calls
1808 * 2. SVFIRBuilder::getGlobalVarField to initialize global variable
1809 * so curVal can only be
1810 * 1. Instruction
1811 * 2. GlobalVariable
1812 */
1813 assert(
1814 (SVFUtil::isa<Instruction>(curVal) || SVFUtil::isa<GlobalVariable>(curVal)) && "curVal not an instruction or a globalvariable?");
1815
1816 // We assume every GepValNode and its GepEdge to the baseNode are unique across the whole program
1817 // We preserve the current BB information to restore it after creating the gepNode
1818 const Value* cval = getCurrentValue();
1819 const SVFBasicBlock* cbb = getCurrentBB();
1822 const ICFGNode* node = nullptr;
1823 if (const Instruction* inst = SVFUtil::dyn_cast<Instruction>(curVal))
1824 {
1825 if (llvmmodule->hasICFGNode(inst))
1826 {
1827 node = llvmmodule->getICFGNode(inst);
1828 }
1829 }
1830 else if (SVFUtil::isa<GlobalVariable>(curVal))
1831 {
1832 // GEP on a global variable: the resulting GepValVar belongs to the global ICFG node.
1833 node = pag->getICFG()->getGlobalICFGNode();
1834 }
1836 NodeIDAllocator::get()->allocateValueId(),
1837 llvmmodule->getSVFType(PointerType::getUnqual(llvmmodule->getContext())), node);
1838 addGepEdge(base, gepNode, ap, true);
1840 return gepNode;
1841 }
1842 else
1843 return gepval;
1844}
1845
1847{
1848 if (!Options::ModelArrays() || SVFUtil::isa<llvm::GEPOperator>(ptr))
1849 return 0;
1850
1851 const Type* objTy =
1853 const ArrayType* arrTy = SVFUtil::dyn_cast<ArrayType>(objTy);
1854 if (!arrTy || !arrTy->getElementType()->isPointerTy() ||
1855 arrTy->getElementType() != accessTy)
1856 return 0;
1857
1858 AccessPath ap(0, llvmModuleSet()->getSVFType(arrTy));
1859 return getGepValVar(ptr, ap, llvmModuleSet()->getSVFType(accessTy));
1860}
1861
1862
1863/*
1864 * curVal <--------> PAGEdge
1865 * Instruction Any Edge
1866 * Argument CopyEdge (SVFIR::addFormalParamBlackHoleAddrEdge)
1867 * ConstantExpr CopyEdge (Int2PtrConstantExpr CastConstantExpr SVFIRBuilder::processCE)
1868 * GepEdge (GepConstantExpr SVFIRBuilder::processCE)
1869 * ConstantPointerNull CopyEdge (3-->2 NullPtr-->BlkPtr SVFIR::addNullPtrNode)
1870 * AddrEdge (0-->2 BlkObj-->BlkPtr SVFIR::addNullPtrNode)
1871 * GlobalVariable AddrEdge (SVFIRBuilder::visitGlobal)
1872 * GepEdge (SVFIRBuilder::getGlobalVarField)
1873 * Function AddrEdge (SVFIRBuilder::visitGlobal)
1874 * Constant StoreEdge (SVFIRBuilder::InitialGlobal)
1875 */
1877{
1879 return;
1880
1881 assert(curVal && "current Val is nullptr?");
1882 edge->setBB(curBB!=nullptr ? curBB : nullptr);
1884 ICFGNode* icfgNode = pag->getICFG()->getGlobalICFGNode();
1886 if (const Instruction* curInst = SVFUtil::dyn_cast<Instruction>(curVal))
1887 {
1888 const FunObjVar* srcFun = edge->getSrcNode()->getFunction();
1889 const FunObjVar* dstFun = edge->getDstNode()->getFunction();
1890 if(srcFun!=nullptr && !SVFUtil::isa<RetPE>(edge) && !SVFUtil::isa<FunValVar>(edge->getSrcNode()) && !SVFUtil::isa<FunObjVar>(edge->getSrcNode()))
1891 {
1892 assert(srcFun==llvmMS->getFunObjVar(curInst->getFunction()) && "SrcNode of the PAGEdge not in the same function?");
1893 }
1894 if(dstFun!=nullptr && !SVFUtil::isa<CallPE>(edge) && !SVFUtil::isa<RetValPN>(edge->getDstNode()))
1895 {
1896 assert(dstFun==llvmMS->getFunObjVar(curInst->getFunction()) && "DstNode of the PAGEdge not in the same function?");
1897 }
1898
1900 if (!(SVFUtil::isa<GepStmt>(edge) && SVFUtil::isa<GepValVar>(edge->getDstNode())))
1901 assert(curBB && "instruction does not have a basic block??");
1902
1904 if(SVFUtil::isa<ReturnInst>(curInst))
1905 {
1906 icfgNode = pag->getICFG()->getFunExitICFGNode(llvmMS->getFunObjVar(curInst->getFunction()));
1907 }
1908 else if(const CallPE* callPE = SVFUtil::dyn_cast<CallPE>(edge))
1909 {
1911 icfgNode = const_cast<FunEntryICFGNode*>(callPE->getFunEntryICFGNode());
1912 }
1913 else if(SVFUtil::isa<RetPE>(edge))
1914 {
1915 icfgNode = llvmMS->getRetICFGNode(SVFUtil::cast<Instruction>(curInst));
1916 }
1917 else
1918 {
1919 icfgNode = llvmMS->getICFGNode(SVFUtil::cast<Instruction>(curInst));
1920 }
1921 }
1922 else if (const Argument* arg = SVFUtil::dyn_cast<Argument>(curVal))
1923 {
1925 icfgNode = pag->getICFG()->getFunEntryICFGNode(
1926 llvmModuleSet()->getFunObjVar(SVFUtil::cast<Function>(arg->getParent())));
1927 }
1928 else if (SVFUtil::isa<Constant>(curVal) ||
1929 SVFUtil::isa<Function>(curVal) ||
1930 SVFUtil::isa<MetadataAsValue>(curVal))
1931 {
1932 if (!curBB)
1934 else
1935 {
1936 icfgNode = const_cast<ICFGNode*>(curBB->front());
1937 }
1938 }
1939 else
1940 {
1941 assert(false && "what else value can we have?");
1942 }
1943
1944 pag->addToSVFStmtList(icfgNode,edge);
1945 icfgNode->addSVFStmt(edge);
1946 if(const CallPE* callPE = SVFUtil::dyn_cast<CallPE>(edge))
1947 {
1950 FunEntryICFGNode* entryNode = const_cast<FunEntryICFGNode*>(callPE->getFunEntryICFGNode());
1951 for(u32_t i = 0; i < callPE->getOpVarNum(); i++)
1952 {
1953 CallICFGNode* callNode = const_cast<CallICFGNode*>(callPE->getOpCallICFGNode(i));
1955 SVFUtil::cast<CallCFGEdge>(icfgEdge)->addCallPE(callPE);
1956 }
1957 }
1958 else if(const RetPE* retPE = SVFUtil::dyn_cast<RetPE>(edge))
1959 {
1960 RetICFGNode* retNode = const_cast<RetICFGNode*>(retPE->getCallSite()->getRetICFGNode());
1961 FunExitICFGNode* exitNode = const_cast<FunExitICFGNode*>(retPE->getFunExitICFGNode());
1963 SVFUtil::cast<RetCFGEdge>(edge)->addRetPE(retPE);
1964 }
1965}
1966
1967
1975{
1976 SVFVar* node = pag->getGNode(nodeId);
1979 if(geps.empty())
1980 return AccessPath(0);
1981
1982 assert(geps.size()==1 && "one node can only be connected by at most one gep edge!");
1983 SVFVar::iterator it = geps.begin();
1984 const GepStmt* gepEdge = SVFUtil::cast<GepStmt>(*it);
1985 if(gepEdge->isVariantFieldGep())
1986 return AccessPath(0);
1987 else
1988 return gepEdge->getAccessPath();
1989}
#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:242
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:321
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:325
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:210
FunToIDMapTy & retSyms()
Definition LLVMModule.h:277
const FunObjVar * getFunObjVar(const Function *fun) const
Definition LLVMModule.h:270
static LLVMModuleSet * getLLVMModuleSet()
Definition LLVMModule.h:133
SVFBasicBlock * getSVFBasicBlock(const BasicBlock *bb)
Definition LLVMModule.h:301
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:101
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:93
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:160
const Function * getRealDefFun(const Function *fun) const
Definition LLVMModule.h:188
ValueToIDMapTy & objSyms()
Definition LLVMModule.h:215
void addBasicBlock(FunObjVar *fun, const BasicBlock *bb)
Definition LLVMModule.h:235
FunToIDMapTy & varargSyms()
Definition LLVMModule.h:282
const FunctionSet & getFunctionSet() const
Definition LLVMModule.h:195
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:182
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:181
static const Option< bool > PAGPrint
Definition Options.h:124
static const Option< bool > VtableInSVFIR
Definition Options.h:211
static const Option< bool > LoopAnalysis
Definition Options.h:236
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:614
void print()
Print SVFIR.
Definition SVFIR.cpp:649
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:486
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 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:879
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:852
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:874
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:734
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:51
static double timeOfBuildingSVFIR
Definition SVFStat.h:97
GenericNode< SVFVar, SVFStmt >::GEdgeSetTy SVFStmtSetTy
virtual void setName(const std::string &nameInfo)
Definition SVFValue.h:177
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:294
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:229
const ConstantExpr * isSelectConstantExpr(const Value *val)
Definition LLVMUtil.h:259
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:269
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:239
bool isHeapObj(const Value *val)
Definition LLVMUtil.cpp:687
const ConstantExpr * isUnaryConstantExpr(const Value *val)
Definition LLVMUtil.h:305
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:249
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:219
static DataLayout * getDataLayout(Module *mod)
Definition LLVMUtil.h:317
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:283
std::string pasMsg(const std::string &msg)
Print each pass/phase message by converting a string into blue string output.
Definition SVFUtil.cpp:105
void writeWrnMsg(const std::string &msg)
Writes a message run through wrnMsg.
Definition SVFUtil.cpp:72
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