SVF::GenericBug Class Reference

#include <SVFBugReport.h>

Inheritance diagram for SVF::GenericBug:

Public Types
enum	BugType {   FULLBUFOVERFLOW , PARTIALBUFOVERFLOW , NEVERFREE , PARTIALLEAK ,   DOUBLEFREE , FILENEVERCLOSE , FILEPARTIALCLOSE , FULLNULLPTRDEREFERENCE ,   PARTIALNULLPTRDEREFERENCE }
typedef std::vector< SVFBugEvent >	EventStack

Public Member Functions
	GenericBug (BugType bugType, const EventStack &bugEventStack)
	note: should be initialized with a bugEventStack
virtual	~GenericBug ()=default
BugType	getBugType () const
	returns bug type
const std::string	getLoc () const
	returns bug location as json format string
const std::string	getFuncName () const
	return bug source function name
const EventStack &	getEventStack () const
virtual cJSON *	getBugDescription () const =0
virtual void	printBugToTerminal () const =0

Static Public Attributes
static const std::map< GenericBug::BugType, std::string >	BugType2Str

Protected Attributes
BugType	bugType
const EventStack	bugEventStack

Detailed Description

Definition at line 80 of file SVFBugReport.h.

Member Typedef Documentation

EventStack

typedef std::vector<SVFBugEvent> SVF::GenericBug::EventStack

Definition at line 83 of file SVFBugReport.h.

Member Enumeration Documentation

BugType

enum SVF::GenericBug::BugType

Enumerator
FULLBUFOVERFLOW
PARTIALBUFOVERFLOW
NEVERFREE
PARTIALLEAK
DOUBLEFREE
FILENEVERCLOSE
FILEPARTIALCLOSE
FULLNULLPTRDEREFERENCE
PARTIALNULLPTRDEREFERENCE

Definition at line 86 of file SVFBugReport.h.

{FULLBUFOVERFLOW, PARTIALBUFOVERFLOW, NEVERFREE, PARTIALLEAK, DOUBLEFREE, FILENEVERCLOSE, FILEPARTIALCLOSE, FULLNULLPTRDEREFERENCE, PARTIALNULLPTRDEREFERENCE};

Constructor & Destructor Documentation

GenericBug()

SVF::GenericBug::GenericBug ( BugType  bugType, const EventStack &  bugEventStack  )

inline

note: should be initialized with a bugEventStack

Definition at line 95 of file SVFBugReport.h.

                                                                :
        bugType(bugType), bugEventStack(bugEventStack)
    {
        assert(bugEventStack.size() != 0 && "bugEventStack should NOT be empty!");
    }

~GenericBug()

virtual SVF::GenericBug::~GenericBug ( )

virtualdefault

Member Function Documentation

getBugDescription()

virtual cJSON * SVF::GenericBug::getBugDescription ( ) const

pure virtual

Implemented in SVF::BufferOverflowBug, SVF::NeverFreeBug, SVF::PartialLeakBug, SVF::DoubleFreeBug, SVF::FileNeverCloseBug, SVF::FilePartialCloseBug, SVF::FullNullPtrDereferenceBug, and SVF::PartialNullPtrDereferenceBug.

getBugType()

BugType SVF::GenericBug::getBugType ( ) const

inline

returns bug type

Definition at line 103 of file SVFBugReport.h.

    {
        return bugType;
    }

getEventStack()

const EventStack & SVF::GenericBug::getEventStack ( ) const

inline

Definition at line 112 of file SVFBugReport.h.

    {
        return bugEventStack;
    }

getFuncName()

const std::string GenericBug::getFuncName

(

)

const

return bug source function name

Definition at line 57 of file SVFBugReport.cpp.

{
    const SVFBugEvent&sourceInstEvent = bugEventStack.at(bugEventStack.size() -1);
    return sourceInstEvent.getFuncName();
}

getLoc()

const std::string GenericBug::getLoc

(

)

const

returns bug location as json format string

Definition at line 51 of file SVFBugReport.cpp.

{
    const SVFBugEvent&sourceInstEvent = bugEventStack.at(bugEventStack.size() -1);
    return sourceInstEvent.getEventLoc();
}

printBugToTerminal()

virtual void SVF::GenericBug::printBugToTerminal ( ) const

pure virtual

Implemented in SVF::BufferOverflowBug, SVF::NeverFreeBug, SVF::PartialLeakBug, SVF::DoubleFreeBug, SVF::FileNeverCloseBug, SVF::FilePartialCloseBug, SVF::FullNullPtrDereferenceBug, and SVF::PartialNullPtrDereferenceBug.

Member Data Documentation

bugEventStack

const EventStack SVF::GenericBug::bugEventStack

protected

Definition at line 91 of file SVFBugReport.h.

bugType

BugType SVF::GenericBug::bugType

protected

Definition at line 90 of file SVFBugReport.h.

BugType2Str

const std::map< GenericBug::BugType, std::string > GenericBug::BugType2Str

static

Initial value:

=
{
    {GenericBug::FULLBUFOVERFLOW, "Full Buffer Overflow"},
    {GenericBug::PARTIALBUFOVERFLOW, "Partial Buffer Overflow"},
    {GenericBug::NEVERFREE, "Never Free"},
    {GenericBug::PARTIALLEAK, "Partial Leak"},
    {GenericBug::FILENEVERCLOSE, "File Never Close"},
    {GenericBug::FILEPARTIALCLOSE, "File Partial Close"},
    {GenericBug::DOUBLEFREE, "Double Free"},
    {GenericBug::FULLNULLPTRDEREFERENCE, "Full Null Ptr Dereference"},
    {GenericBug::PARTIALNULLPTRDEREFERENCE, "Partial Null Ptr Dereference"}
}

Definition at line 87 of file SVFBugReport.h.

---

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

• /home/runner/work/SVF/SVF/svf/include/Util/SVFBugReport.h
• /home/runner/work/SVF/SVF/svf/lib/Util/SVFBugReport.cpp