SVF::SVFModule Class Reference

#include <SVFModule.h>

Public Types
typedef std::vector< const SVFFunction * >	FunctionSetType
typedef std::vector< SVFGlobalValue * >	GlobalSetType
typedef std::vector< SVFGlobalValue * >	AliasSetType
typedef std::vector< SVFConstant * >	ConstantType
typedef std::vector< SVFOtherValue * >	OtherValueType
typedef FunctionSetType::iterator	iterator
	Iterators type def. More...
typedef FunctionSetType::const_iterator	const_iterator
typedef GlobalSetType::iterator	global_iterator
typedef GlobalSetType::const_iterator	const_global_iterator
typedef AliasSetType::iterator	alias_iterator
typedef AliasSetType::const_iterator	const_alias_iterator
typedef ConstantType::iterator	cdata_iterator
typedef ConstantType::const_iterator	const_cdata_iterator
typedef OtherValueType::iterator	ovalue_iterator
typedef OtherValueType::const_iterator	const_ovalue_iterator

Public Member Functions
	~SVFModule ()
void	setModuleIdentifier (const std::string &moduleIdentifier)
const SVFFunction *	getSVFFunction (const std::string &name)
const std::string &	getModuleIdentifier () const
const FunctionSetType &	getFunctionSet () const
const ConstantType &	getConstantSet () const
const GlobalSetType &	getGlobalSet () const
const AliasSetType &	getAliasSet () const
const OtherValueType &	getOtherValueSet () const
void	addFunctionSet (SVFFunction *svfFunc)
void	addGlobalSet (SVFGlobalValue *glob)
void	addAliasSet (SVFGlobalValue *alias)
void	addConstant (SVFConstant *cd)
void	addOtherValue (SVFOtherValue *ov)
global_iterator	global_begin ()
const_global_iterator	global_begin () const
global_iterator	global_end ()
const_global_iterator	global_end () const
alias_iterator	alias_begin ()
const_alias_iterator	alias_begin () const
alias_iterator	alias_end ()
const_alias_iterator	alias_end () const
cdata_iterator	constant_begin ()
const_cdata_iterator	constant_begin () const
cdata_iterator	constant_end ()
const_cdata_iterator	constant_end () const

Static Public Member Functions
static SVFModule *	getSVFModule ()
static void	releaseSVFModule ()
static void	setPagFromTXT (const std::string &txt)
static std::string	pagFileName ()
static bool	pagReadFromTXT ()

Private Member Functions
	SVFModule ()=default
	Constructors. More...

Private Attributes
std::string	moduleIdentifier
FunctionSetType	FunctionSet
	The Functions in the module. More...
GlobalSetType	GlobalSet
	The Global Variables in the module. More...
AliasSetType	AliasSet
	The Aliases in the module. More...
ConstantType	ConstantSet
	The ConstantData in the module. More...
OtherValueType	OtherValueSet
	All other values in the module. More...

Static Private Attributes
static SVFModule *	svfModule = nullptr
static std::string	pagReadFromTxt = ""

Friends
class	SVFIRWriter
class	SVFIRReader

Detailed Description

Definition at line 40 of file SVFModule.h.

Member Typedef Documentation

alias_iterator

typedef AliasSetType::iterator SVF::SVFModule::alias_iterator

Definition at line 57 of file SVFModule.h.

AliasSetType

typedef std::vector<SVFGlobalValue*> SVF::SVFModule::AliasSetType

Definition at line 48 of file SVFModule.h.

cdata_iterator

typedef ConstantType::iterator SVF::SVFModule::cdata_iterator

Definition at line 59 of file SVFModule.h.

const_alias_iterator

typedef AliasSetType::const_iterator SVF::SVFModule::const_alias_iterator

Definition at line 58 of file SVFModule.h.

const_cdata_iterator

typedef ConstantType::const_iterator SVF::SVFModule::const_cdata_iterator

Definition at line 60 of file SVFModule.h.

const_global_iterator

typedef GlobalSetType::const_iterator SVF::SVFModule::const_global_iterator

Definition at line 56 of file SVFModule.h.

const_iterator

typedef FunctionSetType::const_iterator SVF::SVFModule::const_iterator

Definition at line 54 of file SVFModule.h.

const_ovalue_iterator

typedef OtherValueType::const_iterator SVF::SVFModule::const_ovalue_iterator

Definition at line 62 of file SVFModule.h.

ConstantType

typedef std::vector<SVFConstant*> SVF::SVFModule::ConstantType

Definition at line 49 of file SVFModule.h.

FunctionSetType

typedef std::vector<const SVFFunction*> SVF::SVFModule::FunctionSetType

Definition at line 46 of file SVFModule.h.

global_iterator

typedef GlobalSetType::iterator SVF::SVFModule::global_iterator

Definition at line 55 of file SVFModule.h.

GlobalSetType

typedef std::vector<SVFGlobalValue*> SVF::SVFModule::GlobalSetType

Definition at line 47 of file SVFModule.h.

iterator

typedef FunctionSetType::iterator SVF::SVFModule::iterator

Iterators type def.

Definition at line 53 of file SVFModule.h.

OtherValueType

typedef std::vector<SVFOtherValue*> SVF::SVFModule::OtherValueType

Definition at line 50 of file SVFModule.h.

ovalue_iterator

typedef OtherValueType::iterator SVF::SVFModule::ovalue_iterator

Definition at line 61 of file SVFModule.h.

Constructor & Destructor Documentation

SVFModule()

SVF::SVFModule::SVFModule ( )

privatedefault

Constructors.

~SVFModule()

SVFModule::~SVFModule

(

)

Definition at line 35 of file SVFModule.cpp.

{
    for (const SVFFunction* f : FunctionSet)
        delete f;
    for (const SVFConstant* c : ConstantSet)
        delete c;
    for (const SVFValue* o : OtherValueSet)
        delete o;
    NodeIDAllocator::unset();
    ThreadAPI::destroy();
    ExtAPI::destory();
}

Member Function Documentation

addAliasSet()

void SVF::SVFModule::addAliasSet ( SVFGlobalValue *  alias )

inline

Definition at line 115 of file SVFModule.h.

    {
        AliasSet.push_back(alias);
        addConstant(alias);
    }

addConstant()

void SVF::SVFModule::addConstant ( SVFConstant *  cd )

inline

Definition at line 120 of file SVFModule.h.

    {
        ConstantSet.push_back(cd);
    }

addFunctionSet()

void SVF::SVFModule::addFunctionSet ( SVFFunction *  svfFunc )

inline

Definition at line 106 of file SVFModule.h.

    {
        FunctionSet.push_back(svfFunc);
    }

addGlobalSet()

void SVF::SVFModule::addGlobalSet ( SVFGlobalValue *  glob )

inline

Definition at line 110 of file SVFModule.h.

    {
        GlobalSet.push_back(glob);
        addConstant(glob);
    }

addOtherValue()

void SVF::SVFModule::addOtherValue ( SVFOtherValue *  ov )

inline

Definition at line 124 of file SVFModule.h.

    {
        OtherValueSet.push_back(ov);
    }

alias_begin() [1/2]

alias_iterator SVF::SVFModule::alias_begin ( )

inline

Definition at line 150 of file SVFModule.h.

    {
        return AliasSet.begin();
    }

alias_begin() [2/2]

const_alias_iterator SVF::SVFModule::alias_begin ( ) const

inline

Definition at line 154 of file SVFModule.h.

    {
        return AliasSet.begin();
    }

alias_end() [1/2]

alias_iterator SVF::SVFModule::alias_end ( )

inline

Definition at line 158 of file SVFModule.h.

    {
        return AliasSet.end();
    }

alias_end() [2/2]

const_alias_iterator SVF::SVFModule::alias_end ( ) const

inline

Definition at line 162 of file SVFModule.h.

    {
        return AliasSet.end();
    }

constant_begin() [1/2]

cdata_iterator SVF::SVFModule::constant_begin ( )

inline

Definition at line 167 of file SVFModule.h.

    {
        return ConstantSet.begin();
    }

constant_begin() [2/2]

const_cdata_iterator SVF::SVFModule::constant_begin ( ) const

inline

Definition at line 171 of file SVFModule.h.

    {
        return ConstantSet.begin();
    }

constant_end() [1/2]

cdata_iterator SVF::SVFModule::constant_end ( )

inline

Definition at line 175 of file SVFModule.h.

    {
        return ConstantSet.end();
    }

constant_end() [2/2]

const_cdata_iterator SVF::SVFModule::constant_end ( ) const

inline

Definition at line 179 of file SVFModule.h.

    {
        return ConstantSet.end();
    }

getAliasSet()

const AliasSetType& SVF::SVFModule::getAliasSet ( ) const

inline

Definition at line 211 of file SVFModule.h.

    {
        return AliasSet;
    }

getConstantSet()

const ConstantType& SVF::SVFModule::getConstantSet ( ) const

inline

Definition at line 203 of file SVFModule.h.

    {
        return ConstantSet;
    }

getFunctionSet()

const FunctionSetType& SVF::SVFModule::getFunctionSet ( ) const

inline

Definition at line 199 of file SVFModule.h.

    {
        return FunctionSet;
    }

getGlobalSet()

const GlobalSetType& SVF::SVFModule::getGlobalSet ( ) const

inline

Definition at line 207 of file SVFModule.h.

    {
        return GlobalSet;
    }

getModuleIdentifier()

const std::string& SVF::SVFModule::getModuleIdentifier ( ) const

inline

Definition at line 185 of file SVFModule.h.

    {
        if (pagReadFromTxt.empty())
        {
            assert(!moduleIdentifier.empty() &&
                   "No module found! Reading from a file other than LLVM-IR?");
            return moduleIdentifier;
        }
        else
        {
            return pagReadFromTxt;
        }
    }

getOtherValueSet()

const OtherValueType& SVF::SVFModule::getOtherValueSet ( ) const

inline

Definition at line 215 of file SVFModule.h.

    {
        return OtherValueSet;
    }

getSVFFunction()

const SVFFunction * SVFModule::getSVFFunction

(

const std::string &

name

)

Definition at line 48 of file SVFModule.cpp.

{
    for (const SVFFunction* fun : getFunctionSet())
    {
        if (fun->getName() == name)
        {
            return fun;
        }
    }
    return nullptr;
}

getSVFModule()

SVFModule * SVFModule::getSVFModule ( )

static

Definition at line 60 of file SVFModule.cpp.

{
    if (svfModule == nullptr)
    {
        svfModule = new SVFModule;
    }
    return svfModule;
}

global_begin() [1/2]

global_iterator SVF::SVFModule::global_begin ( )

inline

Iterators

Definition at line 133 of file SVFModule.h.

    {
        return GlobalSet.begin();
    }

global_begin() [2/2]

const_global_iterator SVF::SVFModule::global_begin ( ) const

inline

Definition at line 137 of file SVFModule.h.

    {
        return GlobalSet.begin();
    }

global_end() [1/2]

global_iterator SVF::SVFModule::global_end ( )

inline

Definition at line 141 of file SVFModule.h.

    {
        return GlobalSet.end();
    }

global_end() [2/2]

const_global_iterator SVF::SVFModule::global_end ( ) const

inline

Definition at line 145 of file SVFModule.h.

    {
        return GlobalSet.end();
    }

pagFileName()

static std::string SVF::SVFModule::pagFileName ( )

inlinestatic

Definition at line 93 of file SVFModule.h.

    {
        return pagReadFromTxt;
    }

pagReadFromTXT()

static bool SVF::SVFModule::pagReadFromTXT ( )

inlinestatic

Definition at line 98 of file SVFModule.h.

    {
        return !pagReadFromTxt.empty();
    }

releaseSVFModule()

void SVFModule::releaseSVFModule ( )

static

Definition at line 69 of file SVFModule.cpp.

{
    assert(svfModule != nullptr && "SVFModule is not initialized?");
    delete svfModule;
    svfModule = nullptr;
}

setModuleIdentifier()

void SVF::SVFModule::setModuleIdentifier ( const std::string &  moduleIdentifier )

inline

Definition at line 88 of file SVFModule.h.

    {
        this->moduleIdentifier = moduleIdentifier;
    }

setPagFromTXT()

static void SVF::SVFModule::setPagFromTXT ( const std::string &  txt )

inlinestatic

Definition at line 83 of file SVFModule.h.

    {
        pagReadFromTxt = txt;
    }

Friends And Related Function Documentation

SVFIRReader

friend class SVFIRReader

friend

Definition at line 43 of file SVFModule.h.

SVFIRWriter

friend class SVFIRWriter

friend

Definition at line 42 of file SVFModule.h.

Member Data Documentation

AliasSet

AliasSetType SVF::SVFModule::AliasSet

private

The Aliases in the module.

Definition at line 70 of file SVFModule.h.

ConstantSet

ConstantType SVF::SVFModule::ConstantSet

private

The ConstantData in the module.

Definition at line 71 of file SVFModule.h.

FunctionSet

FunctionSetType SVF::SVFModule::FunctionSet

private

The Functions in the module.

Definition at line 68 of file SVFModule.h.

GlobalSet

GlobalSetType SVF::SVFModule::GlobalSet

private

The Global Variables in the module.

Definition at line 69 of file SVFModule.h.

moduleIdentifier

std::string SVF::SVFModule::moduleIdentifier

private

Definition at line 67 of file SVFModule.h.

OtherValueSet

OtherValueType SVF::SVFModule::OtherValueSet

private

All other values in the module.

Definition at line 72 of file SVFModule.h.

pagReadFromTxt

std::string SVFModule::pagReadFromTxt = ""

staticprivate

Definition at line 66 of file SVFModule.h.

svfModule

SVFModule * SVFModule::svfModule = nullptr

staticprivate

Definition at line 65 of file SVFModule.h.

---

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

• /home/runner/work/SVF/SVF/svf/include/SVFIR/SVFModule.h
• /home/runner/work/SVF/SVF/svf/lib/SVFIR/SVFModule.cpp