Description

Description of a local stack variable within a function.

Definition at line 20 of file StackVariable.h.

#include <Rose/BinaryAnalysis/Variables/StackVariable.h>

Inheritance diagram for Rose::BinaryAnalysis::Variables::StackVariable:

[legend]

Collaboration diagram for Rose::BinaryAnalysis::Variables::StackVariable:

[legend]

Classes
struct	Boundary
	Boundary between stack variables. More...

Public Types
enum class	Purpose { RETURN_ADDRESS , FRAME_POINTER , STACK_POINTER , SPILL_AREA , NORMAL , UNKNOWN , OTHER }
	Purpose of variable. More...

using	Boundaries = std::vector< Boundary >
	List of boundaries.

Public Member Functions
	StackVariable ()
	Default constructor.

	StackVariable (const Partitioner2::FunctionPtr &, int64_t stackOffset, Address maxSizeBytes, Purpose, const std::vector< InstructionAccess > &definingInstructions=std::vector< InstructionAccess >(), const std::string &name="")
	Construct a variable descriptor.

	StackVariable (const StackVariable &)

StackVariable &	operator= (const StackVariable &)

const std::string &	setDefaultName ()
	Give variable a defult name.

OffsetInterval	interval () const
	Location of variable w.r.t.

	operator bool () const
	Predicate to test whether variable is valid.

bool	operator! () const
	Predicate to test whether variable is invalid.


Partitioner2::FunctionPtr	function () const
	Property: Function owning the variable.

void	function (const Partitioner2::FunctionPtr &)
	Property: Function owning the variable.


int64_t	stackOffset () const
	Property: Stack offset.

void	stackOffset (int64_t offset)
	Property: Stack offset.


Purpose	purpose () const
	Property: Purpose.

void	purpose (Purpose p)
	Property: Purpose.


bool	operator== (const StackVariable &other) const
	Compare two local variables.

bool	operator!= (const StackVariable &other) const
	Compare two local variables.


void	print (std::ostream &) const
	Printing local variable.

std::string	toString () const
	Printing local variable.

Public Member Functions inherited from Rose::BinaryAnalysis::Variables::BaseVariable
	BaseVariable (const BaseVariable &)

BaseVariable &	operator= (const BaseVariable &)

AccessFlags	accessFlags () const
	Read/write status.

InstructionSemantics::BaseSemantics::InputOutputPropertySet	ioProperties () const
	Property: I/O properties.

void	insertAccess (Address insnAddr, AccessFlags)
	Insert information about how an instruction accesses this variable.

Address	maxSizeBytes () const
	Property: Maximum variable size in bytes.

void	maxSizeBytes (Address size)
	Property: Maximum variable size in bytes.

const std::vector< InstructionAccess > &	instructionsAccessing () const
	Property: Defining instructions.

void	instructionsAccessing (const std::vector< InstructionAccess > &)
	Property: Defining instructions.

const std::string &	name () const
	Property: Optional variable name.

void	name (const std::string &s)
	Property: Optional variable name.

Static Public Member Functions
static void	printBoundary (std::ostream &, const Boundary &, const std::string &prefix="")
	Print information about a boundary.


static Boundary &	insertBoundary (Boundaries &, int64_t stackOffset, const InstructionAccess &)
	Insert a new boundary or adjust an existing boundary.

static Boundary &	insertBoundaryImplied (Boundaries &, int64_t stackOffset)
	Insert a new boundary or adjust an existing boundary.

Additional Inherited Members
Protected Member Functions inherited from Rose::BinaryAnalysis::Variables::BaseVariable
	BaseVariable ()
	Default constructor.

	BaseVariable (size_t maxSizeBytes, const std::vector< InstructionAccess > &definingInstructions, const std::string &name)
	Construct a variable with a given maximum size.

Member Typedef Documentation

◆ Boundaries

using Rose::BinaryAnalysis::Variables::StackVariable::Boundaries = std::vector<Boundary>

List of boundaries.

Definition at line 44 of file StackVariable.h.

Member Enumeration Documentation

◆ Purpose

enum class Rose::BinaryAnalysis::Variables::StackVariable::Purpose

strong

Purpose of variable.

Enumerator
RETURN_ADDRESS	Possible or known return address.
FRAME_POINTER	Pointer to previous stack frame.
STACK_POINTER	Saved stack pointer.
SPILL_AREA	Callee-saved registers.
NORMAL	Normal source code level variable.
UNKNOWN	Purpose is unknown.
OTHER	None of the above purposes.

Definition at line 23 of file StackVariable.h.

Constructor & Destructor Documentation

◆ StackVariable()

Rose::BinaryAnalysis::Variables::StackVariable::StackVariable ( )

Default constructor.

Creates an invalid (zero-sized) variable descriptor.

Member Function Documentation

◆ function() [1/2]

Partitioner2::FunctionPtr Rose::BinaryAnalysis::Variables::StackVariable::function ( ) const

Property: Function owning the variable.

A default constructed object will have a null function pointer. All other objects have a valid function pointer.

◆ function() [2/2]

void Rose::BinaryAnalysis::Variables::StackVariable::function ( const Partitioner2::FunctionPtr & )

Property: Function owning the variable.

A default constructed object will have a null function pointer. All other objects have a valid function pointer.

◆ stackOffset() [1/2]

int64_t Rose::BinaryAnalysis::Variables::StackVariable::stackOffset ( ) const

Property: Stack offset.

This is the address of the variable relative to the function's initial stack pointer. For multi-byte variables, this is the lowest address of the variable. Depending on the architecture, this offset might be positive or negative.

◆ stackOffset() [2/2]

void Rose::BinaryAnalysis::Variables::StackVariable::stackOffset ( int64_t offset )

Property: Stack offset.

This is the address of the variable relative to the function's initial stack pointer. For multi-byte variables, this is the lowest address of the variable. Depending on the architecture, this offset might be positive or negative.

◆ purpose() [1/2]

Purpose Rose::BinaryAnalysis::Variables::StackVariable::purpose ( ) const

Property: Purpose.

Areas of a stack frame serve different purposes. This property describes the purpose.

◆ purpose() [2/2]

void Rose::BinaryAnalysis::Variables::StackVariable::purpose ( Purpose p )

Property: Purpose.

Areas of a stack frame serve different purposes. This property describes the purpose.

◆ setDefaultName()

const std::string & Rose::BinaryAnalysis::Variables::StackVariable::setDefaultName ( )

Give variable a defult name.

This variable's name is replaced by a generated name and the name is returned.

◆ operator==()

bool Rose::BinaryAnalysis::Variables::StackVariable::operator== ( const StackVariable & other ) const

Compare two local variables.

Local variables are equal if and only if they belong to the same function, have the same stack offset, and have the same maximum size or both are default constructed.

◆ operator!=()

bool Rose::BinaryAnalysis::Variables::StackVariable::operator!= ( const StackVariable & other ) const

Compare two local variables.

Local variables are equal if and only if they belong to the same function, have the same stack offset, and have the same maximum size or both are default constructed.

◆ interval()

OffsetInterval Rose::BinaryAnalysis::Variables::StackVariable::interval ( ) const

Location of variable w.r.t.

function's stack.

Returns the concrete location of this local stack variable w.r.t. this function's initial stack pointer.

Referenced by operator bool(), and operator!().

◆ insertBoundary()

static Boundary & Rose::BinaryAnalysis::Variables::StackVariable::insertBoundary	(	Boundaries &	,
		int64_t	stackOffset,
		const InstructionAccess &
	)

static

Insert a new boundary or adjust an existing boundary.

The boundaries are assumed to be unsorted, and if a new boundary is inserted it is inserted at the end of the list.

◆ insertBoundaryImplied()

static Boundary & Rose::BinaryAnalysis::Variables::StackVariable::insertBoundaryImplied	(	Boundaries &	,
		int64_t	stackOffset
	)

static

Insert a new boundary or adjust an existing boundary.

The boundaries are assumed to be unsorted, and if a new boundary is inserted it is inserted at the end of the list.

◆ operator bool()

Rose::BinaryAnalysis::Variables::StackVariable::operator bool ( ) const

inlineexplicit

Predicate to test whether variable is valid.

Returns true if the variable is valid, i.e., if it has a non-zero size. Default constructed variables have a zero size.

Definition at line 151 of file StackVariable.h.

References interval(), and Sawyer::Container::Interval< T >::isEmpty().

◆ operator!()

bool Rose::BinaryAnalysis::Variables::StackVariable::operator! ( ) const

inline

Predicate to test whether variable is invalid.

Returns true if the variable is invalid, i.e., if it has a zero size.

Definition at line 158 of file StackVariable.h.