#include <MTAAnnotator.h>

Inheritance diagram for SVF::MTAAnnotator:

Public Types
typedef Set< const Instruction * >	InstSet

Public Member Functions
	MTAAnnotator ()
	Constructor. More...

virtual	~MTAAnnotator ()
	Destructor. More...

void	annotateDRCheck (Instruction *inst)
	Annotation. More...

void	initialize (MHP mhp, LockAnalysis lsa)
	Initialize. More...

void	pruneThreadLocal (PointerAnalysis *pta)
	Prune candidate instructions that are thread local. More...

void	pruneAliasMHP (PointerAnalysis *pta)
	Prune candidate instructions that non-mhp and non-alias with others. More...

void	performAnnotate ()
	Perform annotation. More...

void	collectLoadStoreInst (SVFModule *mod)
	Collect all load and store instruction. More...

const Value *	getStoreOperand (const Instruction *inst)
	Get operand of store and load. More...

const Value *	getLoadOperand (const Instruction *inst)

bool	isMemset (const Instruction *I)
	Check if Function "F" is memset. More...

bool	isMemcpy (const Instruction *I)
	Check if Function "F" is memcpy. More...

Public Member Functions inherited from SVF::Annotator
	Annotator ()
	Constructor. More...

virtual	~Annotator ()
	Destructor. More...

bool	hasSBSourceFlag (Instruction *inst) const
	SB Has flag methods. More...

bool	hasSBSinkFlag (Instruction *inst) const

bool	hasDRNotCheckFlag (Instruction *inst) const
	Race Detection Has flag methods. More...

bool	hasDRNotCheckFlag (const Instruction *inst) const

bool	hasDRCheckFlag (Instruction *inst) const

bool	hasDRCheckFlag (const Instruction *inst) const

void	addMDTag (Instruction *inst, std::string str)
	Simple add/remove meta data information. More...

void	removeMDTag (Instruction *inst, std::string str)

void	addMDTag (Instruction inst, Value val, std::string str)
	manipulate llvm meta data on instructions for a specific value More...

void	removeMDTag (Instruction inst, Value val, std::string str)
	remove flag from llvm metadata More...

Public Attributes
u32_t	numOfAllSt

u32_t	numOfAllLd

u32_t	numOfNonLocalSt

u32_t	numOfNonLocalLd

u32_t	numOfAliasSt

u32_t	numOfAliasLd

u32_t	numOfMHPSt

u32_t	numOfMHPLd

u32_t	numOfAnnotatedSt

u32_t	numOfAnnotatedLd

Static Public Attributes
static const u32_t	ANNO_MHP = 0x04
	Constant INTERLEV_FLAG values. More...

static const u32_t	ANNO_ALIAS = 0x02

static const u32_t	ANNO_LOCAL = 0x01

Private Attributes
MHP *	mhp

LockAnalysis *	lsa

InstSet	loadset

InstSet	storeset

Additional Inherited Members
Protected Attributes inherited from SVF::Annotator
const char *	SB_SLICESOURCE
	Saber annotations. More...

const char *	SB_SLICESINK

const char *	SB_FESIBLE

const char *	SB_INFESIBLE

const char *	DR_NOT_CHECK
	Race Detection annotations. More...

const char *	DR_CHECK

Detailed Description

MTA annotation

Definition at line 23 of file MTAAnnotator.h.

Member Typedef Documentation

◆ InstSet

typedef Set<const Instruction*> SVF::MTAAnnotator::InstSet

Definition at line 27 of file MTAAnnotator.h.

Constructor & Destructor Documentation

◆ MTAAnnotator()

SVF::MTAAnnotator::MTAAnnotator ( )

inline

Constructor.

Definition at line 29 of file MTAAnnotator.h.

                   : mhp(nullptr),lsa(nullptr)
     {
         numOfAllSt = 0;
         numOfAllLd = 0;
         numOfNonLocalSt = 0;
         numOfNonLocalLd = 0;
         numOfAliasSt = 0;
         numOfAliasLd = 0;
         numOfMHPSt = 0;
         numOfMHPLd = 0;
         numOfAnnotatedSt = 0;
         numOfAnnotatedLd = 0;
     }

◆ ~MTAAnnotator()

virtual SVF::MTAAnnotator::~MTAAnnotator ( )

inlinevirtual

Destructor.

Definition at line 43 of file MTAAnnotator.h.

     {
  
     }

Member Function Documentation

◆ annotateDRCheck()

void MTAAnnotator::annotateDRCheck ( Instruction * inst )

Annotation.

memcpy and memset is not annotated

Definition at line 18 of file MTAAnnotator.cpp.

 {
     std::string str;
     std::stringstream rawstr(str);
     rawstr << DR_CHECK;
  
     if (StoreInst* st = SVFUtil::dyn_cast<StoreInst>(inst))
     {
         numOfAnnotatedSt++;
         addMDTag(inst, st->getPointerOperand(), rawstr.str());
     }
     else if (LoadInst* ld = SVFUtil::dyn_cast<LoadInst>(inst))
     {
         numOfAnnotatedLd++;
         addMDTag(inst, ld->getPointerOperand(), rawstr.str());
     }
 }

◆ collectLoadStoreInst()

void MTAAnnotator::collectLoadStoreInst ( SVFModule * mod )

Collect all load and store instruction.

Definition at line 37 of file MTAAnnotator.cpp.

 {
  
     for (Module& M : LLVMModuleSet::getLLVMModuleSet()->getLLVMModules())
     {
         for (Module::const_iterator F = M.begin(), E = M.end(); F != E; ++F)
         {
             if (SVFUtil::isExtCall(LLVMModuleSet::getLLVMModuleSet()->getSVFFunction(&*F)))
                 continue;
             for (const_inst_iterator II = inst_begin(*F), E = inst_end(*F); II != E; ++II)
             {
                 const Instruction* inst = &*II;
                 if (SVFUtil::isa<LoadInst>(inst))
                 {
                     loadset.insert(inst);
                 }
                 else if (SVFUtil::isa<StoreInst>(inst))
                 {
                     storeset.insert(inst);
                 }
                 else if (isMemset(inst))
                 {
                     storeset.insert(inst);
                 }
                 else if (isMemcpy(inst))
                 {
                     storeset.insert(inst);
                     loadset.insert(inst);
                 }
             }
         }
     }
  
     numOfAllSt = storeset.size();
     numOfAllLd = loadset.size();
 }

◆ getLoadOperand()

const Value * MTAAnnotator::getLoadOperand ( const Instruction * inst )

Definition at line 92 of file MTAAnnotator.cpp.

 {
     if (const LoadInst* ld = SVFUtil::dyn_cast<LoadInst>(inst))
     {
         return ld->getPointerOperand();
     }
     else if (isMemcpy(inst))
     {
         return inst->getOperand(1);
     }
  
     assert(false);
     return nullptr;
 }

◆ getStoreOperand()

const Value * MTAAnnotator::getStoreOperand ( const Instruction * inst )

Get operand of store and load.

Definition at line 74 of file MTAAnnotator.cpp.

 {
     if (const StoreInst* st = SVFUtil::dyn_cast<StoreInst>(inst))
     {
         return st->getPointerOperand();
     }
     else if (isMemset(inst))
     {
         return inst->getOperand(0);
     }
     else if (isMemcpy(inst))
     {
         return inst->getOperand(0);
     }
  
     assert(false);
     return nullptr;
 }

◆ initialize()

void MTAAnnotator::initialize	(	MHP *	mhp,
		LockAnalysis *	lsa
	)

Initialize.

Definition at line 107 of file MTAAnnotator.cpp.

 {
     mhp = m;
     lsa = la;
     if (!Options::AnnoFlag())
         return;
     collectLoadStoreInst(mhp->getTCT()->getPTA()->getModule());
 }

◆ isMemcpy()

bool SVF::MTAAnnotator::isMemcpy ( const Instruction * I )

inline

Check if Function "F" is memcpy.

Definition at line 81 of file MTAAnnotator.h.

     {
         const SVFInstruction* svfInst = LLVMModuleSet::getLLVMModuleSet()->getSVFInstruction(I);
         const SVFFunction* F = SVFUtil::getCallee(svfInst);
         return F && F->getName().find("llvm.memcpy") != std::string::npos;
     }

◆ isMemset()

bool SVF::MTAAnnotator::isMemset ( const Instruction * I )

inline

Check if Function "F" is memset.

Definition at line 73 of file MTAAnnotator.h.

     {
         const SVFInstruction* svfInst = LLVMModuleSet::getLLVMModuleSet()->getSVFInstruction(I);
         const SVFFunction* F =SVFUtil::getCallee(svfInst);
         return F && F->getName().find("llvm.memset") != std::string::npos;
     }

◆ performAnnotate()

void MTAAnnotator::performAnnotate ( )

Perform annotation.

Definition at line 281 of file MTAAnnotator.cpp.

 {
     if (!Options::AnnoFlag())
         return;
     for (InstSet::iterator it = storeset.begin(), eit = storeset.end(); it != eit; ++it)
     {
         annotateDRCheck(const_cast<Instruction*>(*it));
     }
     for (InstSet::iterator it = loadset.begin(), eit = loadset.end(); it != eit; ++it)
     {
         annotateDRCheck(const_cast<Instruction*>(*it));
     }
 }

◆ pruneAliasMHP()

void MTAAnnotator::pruneAliasMHP ( PointerAnalysis * pta )

Prune candidate instructions that non-mhp and non-alias with others.

if it1 == it2, mhp analysis will annotate it1 that locates in loop or recursion. but alias analysis fails to determine whether it1 is in loop or recursion, that means all store instructions will be annotated by alias analysis to guarantee sound.

Definition at line 202 of file MTAAnnotator.cpp.

 {
  
     bool AnnoMHP = Options::AnnoFlag() & ANNO_MHP;
     bool AnnoAlias = Options::AnnoFlag() & ANNO_ALIAS;
  
     if (!AnnoMHP && !AnnoAlias)
         return;
  
     DBOUT(DGENERAL, outs() << pasMsg("Run annotator prune Alias or MHP pairs\n"));
     InstSet needannost;
     InstSet needannold;
     for (InstSet::iterator it1 = storeset.begin(), eit1 = storeset.end(); it1 != eit1; ++it1)
     {
         const SVFInstruction* inst1 = LLVMModuleSet::getLLVMModuleSet()->getSVFInstruction(*it1);
         for (InstSet::iterator it2 = it1, eit2 = storeset.end(); it2 != eit2; ++it2)
         {
             const SVFInstruction* inst2 = LLVMModuleSet::getLLVMModuleSet()->getSVFInstruction(*it2);
             const SVFValue* v1 = LLVMModuleSet::getLLVMModuleSet()->getSVFValue(getStoreOperand(*it1));
             const SVFValue* v2 = LLVMModuleSet::getLLVMModuleSet()->getSVFValue(getStoreOperand(*it2));
  
             if(!pta->alias(v1, v2))
                 continue;
  
             if (AnnoMHP)
             {
                 if (mhp->mayHappenInParallel(inst1, inst2) && !lsa->isProtectedByCommonLock(inst1, inst2))
                 {
                     needannost.insert(*it1);
                     needannost.insert(*it2);
                 }
             }
             else
             {
                 needannost.insert(*it1);
                 needannost.insert(*it2);
             }
         }
         for (InstSet::iterator it2 = loadset.begin(), eit2 = loadset.end(); it2 != eit2; ++it2)
         {
             const SVFInstruction* inst2 = LLVMModuleSet::getLLVMModuleSet()->getSVFInstruction(*it2);
             const SVFValue* v1 = LLVMModuleSet::getLLVMModuleSet()->getSVFValue(getStoreOperand(*it1));
             const SVFValue* v2 = LLVMModuleSet::getLLVMModuleSet()->getSVFValue(getLoadOperand(*it2));
  
             if(!pta->alias(v1,v2))
                 continue;
  
             if (AnnoMHP)
             {
                 if (mhp->mayHappenInParallel(inst1, inst2) && !lsa->isProtectedByCommonLock(inst1, inst2))
                 {
                     needannost.insert(*it1);
                     needannold.insert(*it2);
                 }
             }
             else
             {
                 needannost.insert(*it1);
                 needannold.insert(*it2);
             }
         }
     }
     storeset = needannost;
     loadset = needannold;
  
     if (AnnoMHP)
     {
         numOfMHPSt = storeset.size();
         numOfMHPLd = loadset.size();
     }
     else if (AnnoAlias)
     {
         numOfAliasSt = storeset.size();
         numOfAliasLd = loadset.size();
     }
 }

◆ pruneThreadLocal()

void MTAAnnotator::pruneThreadLocal ( PointerAnalysis * pta )

Prune candidate instructions that are thread local.

find fork arguments' objects

find global pointer-to objects

find all non-local objects that are transitively pointed by global and fork arguments.

compute all store and load instructions that may operate a non-local object.

Definition at line 116 of file MTAAnnotator.cpp.

 {
     bool AnnoLocal = Options::AnnoFlag() & ANNO_LOCAL;
     if (!AnnoLocal)
         return;
  
     DBOUT(DGENERAL, outs() << pasMsg("Run annotator prune thread local pairs\n"));
     SVFIR* pag = pta->getPAG();
     PointsTo nonlocalobjs;
     PointsTo worklist;
  
     const SVFStmt::SVFStmtSetTy& forkedges = pag->getPTASVFStmtSet(SVFStmt::ThreadFork);
     for (SVFStmt::SVFStmtSetTy::const_iterator it = forkedges.begin(), eit = forkedges.end(); it != eit; ++it)
     {
         PAGEdge* edge = *it;
         worklist |= pta->getPts(edge->getDstID());
         worklist |= pta->getPts(edge->getSrcID());
     }
  
     const SVFIR::SVFStmtSet& globaledges = pag->getGlobalSVFStmtSet();
     for (SVFIR::SVFStmtSet::const_iterator it = globaledges.begin(), eit = globaledges.end(); it != eit; ++it)
     {
         const PAGEdge* edge = *it;
         if (edge->getEdgeKind() == SVFStmt::Addr)
         {
             worklist.set(edge->getSrcID());
         }
     }
  
     while (!worklist.empty())
     {
         NodeID obj = worklist.find_first();
         nonlocalobjs.set(obj);
         worklist.reset(obj);
         PointsTo pts = pta->getPts(obj);
         for (PointsTo::iterator pit = pts.begin(), epit = pts.end(); pit != epit; ++pit)
         {
             if (!nonlocalobjs.test(*pit))
                 worklist.set(*pit);
         }
         NodeBS fields = pag->getAllFieldsObjVars(obj);
         for (NodeBS::iterator pit = fields.begin(), epit = fields.end(); pit != epit; ++pit)
         {
             if (!nonlocalobjs.test(*pit))
                 worklist.set(*pit);
         }
     }
  
     InstSet needannost;
     InstSet needannold;
     for (InstSet::iterator it = storeset.begin(), eit = storeset.end(); it != eit; ++it)
     {
         PointsTo pts = pta->getPts(pag->getValueNode(LLVMModuleSet::getLLVMModuleSet()->getSVFValue(getStoreOperand(*it))));
         for (PointsTo::iterator pit = pts.begin(), epit = pts.end(); pit != epit; ++pit)
         {
             if (nonlocalobjs.test(*pit))
             {
                 needannost.insert(*it);
                 break;
             }
         }
     }
  
     for (InstSet::iterator it = loadset.begin(), eit = loadset.end(); it != eit; ++it)
     {
         PointsTo pts = pta->getPts(pag->getValueNode(LLVMModuleSet::getLLVMModuleSet()->getSVFValue(getLoadOperand(*it))));
         for (PointsTo::iterator pit = pts.begin(), epit = pts.end(); pit != epit; ++pit)
         {
             if (nonlocalobjs.test(*pit))
             {
                 needannold.insert(*it);
                 break;
             }
         }
     }
  
     storeset = needannost;
     loadset = needannold;
  
     numOfNonLocalSt = storeset.size();
     numOfNonLocalLd = loadset.size();
 }

Member Data Documentation

◆ ANNO_ALIAS

const u32_t SVF::MTAAnnotator::ANNO_ALIAS = 0x02

static

Definition at line 113 of file MTAAnnotator.h.

◆ ANNO_LOCAL

const u32_t SVF::MTAAnnotator::ANNO_LOCAL = 0x01

static

Definition at line 114 of file MTAAnnotator.h.

◆ ANNO_MHP

const u32_t SVF::MTAAnnotator::ANNO_MHP = 0x04

static

Constant INTERLEV_FLAG values.

Definition at line 112 of file MTAAnnotator.h.

◆ loadset

InstSet SVF::MTAAnnotator::loadset

private

Definition at line 91 of file MTAAnnotator.h.

◆ lsa

LockAnalysis* SVF::MTAAnnotator::lsa

private

Definition at line 90 of file MTAAnnotator.h.

◆ mhp

MHP* SVF::MTAAnnotator::mhp

private

Definition at line 89 of file MTAAnnotator.h.

◆ numOfAliasLd

u32_t SVF::MTAAnnotator::numOfAliasLd

Definition at line 104 of file MTAAnnotator.h.

◆ numOfAliasSt

u32_t SVF::MTAAnnotator::numOfAliasSt

Definition at line 103 of file MTAAnnotator.h.

◆ numOfAllLd

u32_t SVF::MTAAnnotator::numOfAllLd

Definition at line 100 of file MTAAnnotator.h.

◆ numOfAllSt

u32_t SVF::MTAAnnotator::numOfAllSt

Definition at line 99 of file MTAAnnotator.h.

◆ numOfAnnotatedLd

u32_t SVF::MTAAnnotator::numOfAnnotatedLd

Definition at line 108 of file MTAAnnotator.h.

◆ numOfAnnotatedSt

u32_t SVF::MTAAnnotator::numOfAnnotatedSt

Definition at line 107 of file MTAAnnotator.h.

◆ numOfMHPLd

u32_t SVF::MTAAnnotator::numOfMHPLd

Definition at line 106 of file MTAAnnotator.h.

◆ numOfMHPSt

u32_t SVF::MTAAnnotator::numOfMHPSt

Definition at line 105 of file MTAAnnotator.h.

◆ numOfNonLocalLd

u32_t SVF::MTAAnnotator::numOfNonLocalLd

Definition at line 102 of file MTAAnnotator.h.

◆ numOfNonLocalSt

u32_t SVF::MTAAnnotator::numOfNonLocalSt

Definition at line 101 of file MTAAnnotator.h.

◆ storeset

InstSet SVF::MTAAnnotator::storeset

private

Definition at line 92 of file MTAAnnotator.h.

The documentation for this class was generated from the following files:

/home/runner/work/SVF/SVF/svf-llvm/tools/MTA/MTAAnnotator.h
/home/runner/work/SVF/SVF/svf-llvm/tools/MTA/MTAAnnotator.cpp

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ InstSet

Constructor & Destructor Documentation

◆ MTAAnnotator()

◆ ~MTAAnnotator()

Member Function Documentation

◆ annotateDRCheck()

◆ collectLoadStoreInst()

◆ getLoadOperand()

◆ getStoreOperand()

◆ initialize()

◆ isMemcpy()

◆ isMemset()

◆ performAnnotate()

◆ pruneAliasMHP()

◆ pruneThreadLocal()

Member Data Documentation

◆ ANNO_ALIAS

◆ ANNO_LOCAL

◆ ANNO_MHP

◆ loadset

◆ lsa

◆ mhp

◆ numOfAliasLd

◆ numOfAliasSt

◆ numOfAllLd

◆ numOfAllSt

◆ numOfAnnotatedLd

◆ numOfAnnotatedSt

◆ numOfMHPLd

◆ numOfMHPSt

◆ numOfNonLocalLd

◆ numOfNonLocalSt

◆ storeset