SVF::BufferOverflowBug Class Reference

#include <SVFBugReport.h>

Inheritance diagram for SVF::BufferOverflowBug:

Public Member Functions
	BufferOverflowBug (GenericBug::BugType bugType, const EventStack &eventStack, s64_t allocLowerBound, s64_t allocUpperBound, s64_t accessLowerBound, s64_t accessUpperBound)
cJSON *	getBugDescription () const
void	printBugToTerminal () const
Public Member Functions inherited from SVF::GenericBug
	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

Static Public Member Functions
static bool	classof (const GenericBug *bug)
	ClassOf.

Protected Attributes
s64_t	allocLowerBound
s64_t	allocUpperBound
s64_t	accessLowerBound
s64_t	accessUpperBound
Protected Attributes inherited from SVF::GenericBug
BugType	bugType
const EventStack	bugEventStack

Additional Inherited Members
Public Types inherited from SVF::GenericBug
enum	BugType {   FULLBUFOVERFLOW , PARTIALBUFOVERFLOW , NEVERFREE , PARTIALLEAK ,   DOUBLEFREE , FILENEVERCLOSE , FILEPARTIALCLOSE , FULLNULLPTRDEREFERENCE ,   PARTIALNULLPTRDEREFERENCE }
typedef std::vector< SVFBugEvent >	EventStack
Static Public Attributes inherited from SVF::GenericBug
static const std::map< GenericBug::BugType, std::string >	BugType2Str

Detailed Description

Definition at line 121 of file SVFBugReport.h.

Constructor & Destructor Documentation

BufferOverflowBug()

SVF::BufferOverflowBug::BufferOverflowBug ( GenericBug::BugType  bugType, const EventStack &  eventStack, s64_t  allocLowerBound, s64_t  allocUpperBound, s64_t  accessLowerBound, s64_t  accessUpperBound  )

inline

Definition at line 127 of file SVFBugReport.h.

                                                                     :
        GenericBug(bugType, eventStack), allocLowerBound(allocLowerBound),
        allocUpperBound(allocUpperBound), accessLowerBound(accessLowerBound),
        accessUpperBound(accessUpperBound) { }

Member Function Documentation

classof()

static bool SVF::BufferOverflowBug::classof ( const GenericBug *  bug )

inlinestatic

ClassOf.

Definition at line 138 of file SVFBugReport.h.

    {
        return bug->getBugType() == GenericBug::PARTIALBUFOVERFLOW || bug->getBugType() == GenericBug::FULLBUFOVERFLOW;
    }

getBugDescription()

cJSON * BufferOverflowBug::getBugDescription ( ) const

virtual

Implements SVF::GenericBug.

Definition at line 63 of file SVFBugReport.cpp.

{
    cJSON *bugDescription = cJSON_CreateObject();
    cJSON *allocLB = cJSON_CreateNumber(allocLowerBound);
    cJSON *allocUB = cJSON_CreateNumber(allocUpperBound);
    cJSON *accessLB = cJSON_CreateNumber(accessLowerBound);
    cJSON *accessUB = cJSON_CreateNumber(accessUpperBound);
 
    cJSON_AddItemToObject(bugDescription, "AllocLowerBound", allocLB);
    cJSON_AddItemToObject(bugDescription, "AllocUpperBound", allocUB);
    cJSON_AddItemToObject(bugDescription, "AccessLowerBound", accessLB);
    cJSON_AddItemToObject(bugDescription, "AccessUpperBound", accessUB);
 
    return bugDescription;
}

printBugToTerminal()

void BufferOverflowBug::printBugToTerminal ( ) const

virtual

Implements SVF::GenericBug.

Definition at line 79 of file SVFBugReport.cpp.

{
    stringstream bugInfo;
    if(FullBufferOverflowBug::classof(this))
    {
        SVFUtil::errs() << SVFUtil::bugMsg1("\t Full Overflow :") <<  " accessing at : ("
                        << GenericBug::getLoc() << ")\n";
 
    }
    else
    {
        SVFUtil::errs() << SVFUtil::bugMsg1("\t Partial Overflow :") <<  " accessing at : ("
                        << GenericBug::getLoc() << ")\n";
    }
    bugInfo << "\t\t  allocate size : [" << allocLowerBound << ", " << allocUpperBound << "], ";
    bugInfo << "access size : [" << accessLowerBound << ", " << accessUpperBound << "]\n";
    SVFUtil::errs() << "\t\t Info : \n" << bugInfo.str();
    SVFUtil::errs() << "\t\t Events : \n";
 
    for(auto event : bugEventStack)
    {
        switch(event.getEventType())
        {
        case SVFBugEvent::CallSite:
        {
            SVFUtil::errs() << "\t\t  callsite at : ( " << event.getEventLoc() << " )\n";
            break;
        }
        default:
        {
            // TODO: implement more events when needed
            break;
        }
        }
    }
}

Member Data Documentation

accessLowerBound

s64_t SVF::BufferOverflowBug::accessLowerBound

protected

Definition at line 124 of file SVFBugReport.h.

accessUpperBound

s64_t SVF::BufferOverflowBug::accessUpperBound

protected

Definition at line 124 of file SVFBugReport.h.

allocLowerBound

s64_t SVF::BufferOverflowBug::allocLowerBound

protected

Definition at line 124 of file SVFBugReport.h.

allocUpperBound

s64_t SVF::BufferOverflowBug::allocUpperBound

protected

Definition at line 124 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