SVF::Annotator Class Reference

#include <Annotator.h>

Public Member Functions
	Annotator ()
	Constructor.
virtual	~Annotator ()
	Destructor.
bool	hasSBSourceFlag (Instruction *inst) const
	SB Has flag methods.
bool	hasSBSinkFlag (Instruction *inst) const
bool	hasDRNotCheckFlag (Instruction *inst) const
	Race Detection Has flag methods.
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.
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
void	removeMDTag (Instruction *inst, Value *val, std::string str)
	remove flag from llvm metadata

Protected Attributes
const char *	SB_SLICESOURCE
	Saber annotations.
const char *	SB_SLICESINK
const char *	SB_FESIBLE
const char *	SB_INFESIBLE
const char *	DR_NOT_CHECK
	Race Detection annotations.
const char *	DR_CHECK

Private Member Functions
bool	evalMDTag (const Instruction *inst, const Value *val, std::string str, std::vector< Value * > &) const
	evaluate llvm metadata

Detailed Description

Program annotator to write meta data information on LLVM IR

Definition at line 21 of file Annotator.h.

Constructor & Destructor Documentation

Annotator()

SVF::Annotator::Annotator ( )

inline

Constructor.

Definition at line 26 of file Annotator.h.

    {
        SB_SLICESOURCE = "SOURCE_";
        SB_SLICESINK = "SINK_";
        SB_FESIBLE = "FESIBLE_";
        SB_INFESIBLE = "INFESIBLE_";
 
        DR_NOT_CHECK = "DRNOTCHECK_";
        DR_CHECK = "DRCHECK_";
    }

~Annotator()

virtual SVF::Annotator::~Annotator ( )

inlinevirtual

Destructor.

Definition at line 38 of file Annotator.h.

    {
    }

Member Function Documentation

addMDTag() [1/2]

void SVF::Annotator::addMDTag ( Instruction *  inst, std::string  str  )

inline

Simple add/remove meta data information.

Definition at line 90 of file Annotator.h.

    {
        addMDTag(inst, inst, str);
    }

addMDTag() [2/2]

void SVF::Annotator::addMDTag ( Instruction *  inst, Value *  val, std::string  str  )

inline

manipulate llvm meta data on instructions for a specific value

add flag to llvm metadata

Definition at line 103 of file Annotator.h.

    {
        assert(!val->getType()->isVoidTy() && "expecting non-void value for MD!");
        std::vector<Value* > values;
        //std::vector<llvm::Metadata *> metavalues;
        // add the flag if we did not see it before
        if (evalMDTag(inst, val, str, values) == false)
        {
 
            values.push_back(val);
            //llvm::ArrayRef<llvm::Metadata*> ar(metavalues);
            // FIXME: delete the old MDNode
            inst->setMetadata(str, MDNode::get(inst->getContext(), nullptr));
            //inst->setMetadata(str, llvm::MDNode::get(inst->getContext(), ar));
        }
    }

evalMDTag()

bool SVF::Annotator::evalMDTag ( const Instruction *  inst, const Value *  val, std::string  str, std::vector< Value * > &    ) const

inlineprivate

evaluate llvm metadata

When mdNode has operands and value is not null

Definition at line 139 of file Annotator.h.

    {
 
        assert(val && "value should not be null");
 
        bool hasFlag = false;
        if (MDNode *mdNode = inst->getMetadata(str))
        {
            for (unsigned k = 0; k < mdNode->getNumOperands(); ++k)
            {
                //Value* v = mdNode->getOperand(k);
                // if (v == val)
                //    hasFlag = true;
                //else
                //    values.push_back(v);
            }
        }
        return hasFlag;
    }

hasDRCheckFlag() [1/2]

bool SVF::Annotator::hasDRCheckFlag ( const Instruction *  inst ) const

inline

Definition at line 80 of file Annotator.h.

    {
        //std::vector<Value* > values;
        //return evalMDTag(inst, inst, DR_CHECK, values);
        return inst->getMetadata(DR_CHECK);
    }

hasDRCheckFlag() [2/2]

bool SVF::Annotator::hasDRCheckFlag ( Instruction *  inst ) const

inline

Definition at line 73 of file Annotator.h.

    {
        //std::vector<Value* > values;
        //return evalMDTag(inst, inst, DR_CHECK, values);
        return inst->getMetadata(DR_CHECK);
    }

hasDRNotCheckFlag() [1/2]

bool SVF::Annotator::hasDRNotCheckFlag ( const Instruction *  inst ) const

inline

Definition at line 66 of file Annotator.h.

    {
        //std::vector<Value* > values;
        //return evalMDTag(inst, inst, DR_NOT_CHECK, values);
        return inst->getMetadata(DR_NOT_CHECK);
    }

hasDRNotCheckFlag() [2/2]

bool SVF::Annotator::hasDRNotCheckFlag ( Instruction *  inst ) const

inline

Race Detection Has flag methods.

Definition at line 59 of file Annotator.h.

    {
        //std::vector<Value* > values;
        //return evalMDTag(inst, inst, DR_NOT_CHECK, values);
        return inst->getMetadata(DR_NOT_CHECK);
    }

hasSBSinkFlag()

bool SVF::Annotator::hasSBSinkFlag ( Instruction *  inst ) const

inline

Definition at line 50 of file Annotator.h.

    {
        std::vector<Value* > values;
        return evalMDTag(inst, inst, SB_SLICESINK, values);
    }

hasSBSourceFlag()

bool SVF::Annotator::hasSBSourceFlag ( Instruction *  inst ) const

inline

SB Has flag methods.

Definition at line 44 of file Annotator.h.

    {
        std::vector<Value* > values;
        return evalMDTag(inst, inst, SB_SLICESOURCE, values);
    }

removeMDTag() [1/2]

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

inline

Definition at line 94 of file Annotator.h.

    {
        removeMDTag(inst, inst, str);
    }

removeMDTag() [2/2]

void SVF::Annotator::removeMDTag ( Instruction *  inst, Value *  val, std::string  str  )

inline

remove flag from llvm metadata

Definition at line 121 of file Annotator.h.

    {
        assert(!val->getType()->isVoidTy() && "expecting non-void value for MD!");
        std::vector<Value* > values;
 
        // remove the flag if it is there
        if (evalMDTag(inst, val, str, values) == true)
        {
            llvm::ArrayRef<Value* > ar(values);
            // FIXME: delete the old MDNode
            //inst->setMetadata(str, llvm::MDNode::get(inst->getContext(), ar));
        }
    }

Member Data Documentation

DR_CHECK

const char* SVF::Annotator::DR_CHECK

protected

Definition at line 174 of file Annotator.h.

DR_NOT_CHECK

const char* SVF::Annotator::DR_NOT_CHECK

protected

Race Detection annotations.

Definition at line 173 of file Annotator.h.

SB_FESIBLE

const char* SVF::Annotator::SB_FESIBLE

protected

Definition at line 167 of file Annotator.h.

SB_INFESIBLE

const char* SVF::Annotator::SB_INFESIBLE

protected

Definition at line 168 of file Annotator.h.

SB_SLICESINK

const char* SVF::Annotator::SB_SLICESINK

protected

Definition at line 166 of file Annotator.h.

SB_SLICESOURCE

const char* SVF::Annotator::SB_SLICESOURCE

protected

Saber annotations.

Definition at line 165 of file Annotator.h.

---

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

• /home/runner/work/SVF/SVF/svf/include/Util/Annotator.h