A standard model for parameters as an ordered list of storage resources. More...

#include <fspec.hh>

Inheritance diagram for ParamListStandard:

Public Member Functions
	ParamListStandard (void)
	Construct for use with restoreXml()

	ParamListStandard (const ParamListStandard &op2)
	Copy constructor.

const vector< ParamEntry > &	getEntry (void) const
	Get the list of parameter entries.

virtual uint4	getType (void) const
	Get the type of parameter list.

virtual void	assignMap (const vector< Datatype * > &proto, bool isinput, TypeFactory &typefactory, vector< ParameterPieces > &res) const
	Given list of data-types, map the list positions to storage locations. More...

virtual void	fillinMap (ParamActive *active) const
	Given an unordered list of storage locations, calculate a function prototype. More...

virtual bool	checkJoin (const Address &hiaddr, int4 hisize, const Address &loaddr, int4 losize) const
	Check if the given two storage locations can represent a single logical parameter. More...

virtual bool	checkSplit (const Address &loc, int4 size, int4 splitpoint) const
	Check if it makes sense to split a single storage location into two parameters. More...

virtual bool	possibleParam (const Address &loc, int4 size) const
	Does the given storage location make sense as a parameter. More...

virtual bool	possibleParamWithSlot (const Address &loc, int4 size, int4 &slot, int4 &slotsize) const
	Pass-back the slot and slot size for the given storage location as a parameter. More...

virtual bool	unjustifiedContainer (const Address &loc, int4 size, VarnodeData &res) const
	Check if the given storage location looks like an unjustified parameter. More...

virtual OpCode	assumedExtension (const Address &addr, int4 size, VarnodeData &res) const
	Get the type of extension and containing parameter for the given storage. More...

virtual AddrSpace *	getSpacebase (void) const
	Get the address space associated with any stack based parameters in this list. More...

virtual void	getRangeList (AddrSpace *spc, RangeList &res) const
	For a given address space, collect all the parameter locations within that space. More...

virtual int4	getMaxDelay (void) const
	Return the maximum heritage delay across all possible parameters. More...

virtual void	restoreXml (const Element el, const AddrSpaceManager manage, vector< EffectRecord > &effectlist, bool normalstack)
	Restore the model from an XML stream. More...

virtual ParamList *	clone (void) const
	Clone this parameter list model.

Public Member Functions inherited from ParamList
virtual	~ParamList (void)
	Destructor.

Protected Member Functions
int4	findEntry (const Address &loc, int4 size) const
	Given storage location find matching ParamEntry. More...

Address	assignAddress (const Datatype *tp, vector< int4 > &status) const
	Assign storage for given parameter data-type. More...

void	buildTrialMap (ParamActive *active) const
	Build map from parameter trials to model ParamEntrys. More...

void	separateFloat (ParamActive *active, int4 &floatstart, int4 &floatstop, int4 &start, int4 &stop) const
	Calculate the range of floating-point entries within a given set of parameter trials. More...

void	forceExclusionGroup (ParamActive *active) const
	Enforce exclusion rules for the given set of parameter trials. More...

void	forceNoUse (ParamActive *active, int4 start, int4 stop) const
	Mark every trial above the first "definitely not used" as inactive. More...

void	forceInactiveChain (ParamActive *active, int4 maxchain, int4 start, int4 stop) const
	Enforce rules about chains of inactive slots. More...

void	calcDelay (void)
	Calculate the maximum heritage delay for any potential parameter in this list.

Protected Attributes
int4	numgroup
	Number of groups in this parameter convention.

int4	maxdelay
	Maximum heritage delay across all parameters.

int4	pointermax
	If non-zero, maximum size of a data-type before converting to a pointer.

bool	thisbeforeret
	Does a this parameter come before a hidden return parameter.

int4	nonfloatgroup
	Group of first entry which is not marked float.

vector< ParamEntry >	entry
	The ordered list of parameter entries.

AddrSpace *	spacebase
	Address space containing relative offset parameters.

Additional Inherited Members
Public Types inherited from ParamList
enum	{ p_standard, p_standard_out, p_register, p_merged }

Detailed Description

A standard model for parameters as an ordered list of storage resources.

This is a configurable model for passing (input) parameters as a list to a function. The model allows 1 or more resource lists based on data-type, either TYPE_UNKNOWN for general purpose or TYPE_FLOAT for floating-point registers. Within a resource list, any number of parameters can be used but they must come starting at the beginning of the list with no holes (skipped resources). A resource list can include (at the end) stack parameters that are allocated based on an alignment. Optionally, the model supports converting data-types larger than a specified size to pointers within the parameter list.

Member Function Documentation

◆ assignAddress()

Address ParamListStandard::assignAddress	(	const Datatype *	tp,
		vector< int4 > &	status
	)		const

protected

Assign storage for given parameter data-type.

Given the next data-type and the status of previously allocated slots, select the storage location for the parameter. The status array is indexed by group: a positive value indicates how many slots have been allocated from that group, and a -1 indicates the group/resource is fully consumed.

Parameters

tp	is the data-type of the next parameter
status	is an array marking how many slots have already been consumed in a group

Returns: the newly assigned address for the parameter

References entry, Datatype::getMetatype(), Datatype::getSize(), getType(), Address::isInvalid(), and TYPE_UNKNOWN.

Referenced by assignMap(), and ParamListStandardOut::assignMap().

◆ assignMap()

void ParamListStandard::assignMap	(	const vector< Datatype * > &	proto,
		bool	isinput,
		TypeFactory &	typefactory,
		vector< ParameterPieces > &	res
	)		const

virtual

Given list of data-types, map the list positions to storage locations.

If we know the function prototype, recover how parameters are actually stored using the model.

Parameters

proto	is the ordered list of data-types
isinput	is true for the input prototype, false for output prototype
typefactory	is the TypeFactory (for constructing pointers)
res	will contain the storage locations corresponding to the datatypes

Implements ParamList.

Reimplemented in ParamListMerged, and ParamListStandardOut.

References assignAddress(), AddrSpace::getAddrSize(), TypeFactory::getArch(), AddrSpaceManager::getDefaultSpace(), TypeFactory::getTypePointerAbsolute(), AddrSpace::getWordSize(), Varnode::hiddenretparm, Varnode::indirectstorage, numgroup, pointermax, spacebase, and TYPE_VOID.

◆ assumedExtension()

OpCode ParamListStandard::assumedExtension	(	const Address &	addr,
		int4	size,
		VarnodeData &	res
	)		const

virtual

Get the type of extension and containing parameter for the given storage.

If the given storage is properly contained within a normal parameter and the model typically extends a small value into the full container, pass back the full container and the type of extension.

Parameters

addr	is the starting address of the given storage
size	is the number of bytes in the given storage
res	is the parameter storage to pass back

Returns: the extension operator (INT_ZEXT INT_SEXT) or INT_COPY if there is no extension. INT_PIECE indicates the extension is determined by the specific prototype.

Implements ParamList.

References CPUI_COPY, and entry.

◆ buildTrialMap()

void ParamListStandard::buildTrialMap ( ParamActive * active ) const

protected

Build map from parameter trials to model ParamEntrys.

Given a set of trials (putative Varnode parameters) as ParamTrial objects, associate each trial with a model ParamEntry within this list. Trials for for which there are no matching entries are marked as unused. Any holes in the resource list are filled with unreferenced trials. The trial list is sorted.

Parameters

active is the set of trials to map and organize

References entry, findEntry(), ParamEntry::getAddrBySlot(), ParamEntry::getAlign(), ParamEntry::getGroup(), ParamActive::getNumTrials(), ParamEntry::getSize(), ParamEntry::getSlot(), ParamActive::getTrial(), ParamEntry::getType(), ParamEntry::isExclusion(), ParamTrial::markUnref(), ParamActive::registerTrial(), ParamActive::sortTrials(), and TYPE_FLOAT.

Referenced by fillinMap().

◆ checkJoin()

bool ParamListStandard::checkJoin	(	const Address &	hiaddr,
		int4	hisize,
		const Address &	loaddr,
		int4	losize
	)		const

virtual

Check if the given two storage locations can represent a single logical parameter.

Within the conventions of this model, do the two (hi/lo) locations represent consecutive parameter locations that can be replaced by a single logical parameter.

Parameters

hiaddr	is the address of the most significant part of the value
hisize	is the size of the most significant part in bytes
loaddr	is the address of the least significant part of the value
losize	is the size of the least significant part in bytes

Returns: true if the two pieces can be joined

Implements ParamList.

References entry, findEntry(), ParamEntry::getAlign(), ParamEntry::getGroup(), Address::getOffset(), Address::isContiguous(), and ParamEntry::isExclusion().

◆ checkSplit()

bool ParamListStandard::checkSplit	(	const Address &	loc,
		int4	size,
		int4	splitpoint
	)		const

virtual

Check if it makes sense to split a single storage location into two parameters.

A storage location and split point is provided, implying two new storage locations. Does this model allow these locations to be considered parameters.

Parameters

loc	is the starting address of provided storage location
size	is the size of the location in bytes
splitpoint	is the number of bytes to consider in the first (in address order) piece

Returns: true if the storage location can be split

Implements ParamList.

References findEntry().

◆ fillinMap()

void ParamListStandard::fillinMap ( ParamActive * active ) const

virtual

Given an unordered list of storage locations, calculate a function prototype.

A list of input (or output) trials is given, which may have holes, invalid inputs etc. Decide on the formal ordered parameter list. Trials within the ParamActive are added, removed, or reordered as needed.

Parameters

active is the given list of trials

Implements ParamList.

Reimplemented in ParamListMerged, ParamListRegister, and ParamListStandardOut.

References buildTrialMap(), forceExclusionGroup(), forceInactiveChain(), forceNoUse(), ParamActive::getNumTrials(), ParamActive::getTrial(), ParamTrial::markUsed(), and separateFloat().

◆ findEntry()

int4 ParamListStandard::findEntry	(	const Address &	loc,
		int4	size
	)		const

protected

Given storage location find matching ParamEntry.

Find the (first) entry containing the given memory range

Parameters

loc	is the starting address of the range
size	is the number of bytes in the range

Returns: the index of the matching ParamEntry or -1 if none exists

References entry.

Referenced by buildTrialMap(), checkJoin(), checkSplit(), ParamListRegister::fillinMap(), possibleParam(), and possibleParamWithSlot().

◆ forceExclusionGroup()

void ParamListStandard::forceExclusionGroup ( ParamActive * active ) const

protected

Enforce exclusion rules for the given set of parameter trials.

If there are more than one active trials in a single group, and if that group is an exclusion group, mark all but the first trial to inactive.

Parameters

active is the set of trials

References ParamTrial::getEntry(), ParamEntry::getGroup(), ParamActive::getNumTrials(), and ParamActive::getTrial().

Referenced by fillinMap().

◆ forceInactiveChain()

void ParamListStandard::forceInactiveChain	(	ParamActive *	active,
		int4	maxchain,
		int4	start,
		int4	stop
	)		const

protected

Enforce rules about chains of inactive slots.

If there is a chain of slots whose length is greater than maxchain, where all trials are inactive, mark trials in any later slot as inactive. Mark any inactive trials before this (that aren't in a maximal chain) as active. Inspection and marking is restricted to a given range of trials to facilitate separate analysis of floating-point and general-purpose resources.

Parameters

active	is the set of trials, which must be sorted
maxchain	is the maximum number of inactive trials to allow in a chain
start	is the first index in the range of trials to consider
stop	is the last index (+1) in the range of trials to consider

References ParamActive::getTrial(), IPTR_SPACEBASE, ParamActive::isRecoverSubcall(), ParamTrial::markActive(), nonfloatgroup, ParamTrial::slotGroup(), and TYPE_FLOAT.

Referenced by fillinMap().

◆ forceNoUse()

void ParamListStandard::forceNoUse	(	ParamActive *	active,
		int4	start,
		int4	stop
	)		const

protected

Mark every trial above the first "definitely not used" as inactive.

Inspection and marking only occurs within an indicated range of trials, allowing floating-point and general purpose resources to be treated separately.

Parameters

active	is the set of trials, which must already be ordered
start	is the index of the first trial in the range to consider
stop	is the index (+1) of the last trial in the range to consider

References ParamTrial::getEntry(), ParamEntry::getGroup(), and ParamActive::getTrial().

Referenced by fillinMap().

◆ getMaxDelay()

virtual int4 ParamListStandard::getMaxDelay ( void ) const

inlinevirtual

Return the maximum heritage delay across all possible parameters.

Depending on the address space, data-flow for a parameter may not be available until extra transform passes have completed. This method returns the number of passes that must occur before we can guarantee that all parameters have data-flow info.

Returns: the maximum number of passes across all parameters in this model

Implements ParamList.

References maxdelay.

◆ getRangeList()

void ParamListStandard::getRangeList	(	AddrSpace *	spc,
		RangeList &	res
	)		const

virtual

For a given address space, collect all the parameter locations within that space.

Pass back the memory ranges for any parameter that is stored in the given address space.

Parameters

spc	is the given address space
res	will hold the set of matching memory ranges

Implements ParamList.

References entry, ParamEntry::getBase(), ParamEntry::getSize(), ParamEntry::getSpace(), and RangeList::insertRange().

◆ getSpacebase()

virtual AddrSpace* ParamListStandard::getSpacebase ( void ) const

inlinevirtual

Get the address space associated with any stack based parameters in this list.

Returns: the stack address space, if this models parameters passed on the stack, NULL otherwise

Implements ParamList.

References spacebase.

Referenced by ParamListMerged::foldIn().

◆ possibleParam()

bool ParamListStandard::possibleParam	(	const Address &	loc,
		int4	size
	)		const

virtual

Does the given storage location make sense as a parameter.

Within this model, decide if the storage location can be considered a parameter.

Parameters

loc	is the starting address of the storage location
size	is the number of bytes in the storage location

Returns: true if the location can be a parameter

Implements ParamList.

Reimplemented in ParamListStandardOut.

References findEntry().

◆ possibleParamWithSlot()

bool ParamListStandard::possibleParamWithSlot	(	const Address &	loc,
		int4	size,
		int4 &	slot,
		int4 &	slotsize
	)		const

virtual

Pass-back the slot and slot size for the given storage location as a parameter.

This checks if the given storage location acts as a parameter in this model and passes back the number of slots that it occupies.

Parameters

loc	is the starting address of the storage location
size	is the number of bytes in the storage location
slot	if the slot number to pass back
slotsize	is the number of consumed slots to pass back

Returns: true if the location can be a parameter

Implements ParamList.

References entry, findEntry(), ParamEntry::getAlign(), ParamEntry::getGroupSize(), ParamEntry::getSlot(), and ParamEntry::isExclusion().

◆ restoreXml()

void ParamListStandard::restoreXml	(	const Element *	el,
		const AddrSpaceManager *	manage,
		vector< EffectRecord > &	effectlist,
		bool	normalstack
	)

virtual

Restore the model from an XML stream.

Parameters

el	is the root <input> or <output> element
manage	is used to resolve references to address spaces
effectlist	is a container collecting EffectRecords across all parameters
normalstack	is true if parameters are pushed on the stack in the normal order

Implements ParamList.

Reimplemented in ParamListStandardOut.

References calcDelay(), entry, AddrSpace::getType(), IPTR_SPACEBASE, EffectRecord::killedbycall, nonfloatgroup, numgroup, pointermax, spacebase, thisbeforeret, and TYPE_FLOAT.

Referenced by ParamListStandardOut::restoreXml().

◆ separateFloat()

void ParamListStandard::separateFloat	(	ParamActive *	active,
		int4 &	floatstart,
		int4 &	floatstop,
		int4 &	start,
		int4 &	stop
	)		const

protected

Calculate the range of floating-point entries within a given set of parameter trials.

The trials must already be mapped, which should put floating-point entries first. This method calculates the range of floating-point entries and the range of general purpose entries and passes them back.

Parameters

active	is the given set of parameter trials
floatstart	will pass back the index of the first floating-point trial
floatstop	will pass back the index (+1) of the last floating-point trial
start	will pass back the index of the first general purpose trial
stop	will pass back the index (+1) of the last general purpose trial

References ParamActive::getNumTrials(), ParamActive::getTrial(), and TYPE_FLOAT.

Referenced by fillinMap().

◆ unjustifiedContainer()

bool ParamListStandard::unjustifiedContainer	(	const Address &	loc,
		int4	size,
		VarnodeData &	res
	)		const

virtual

Check if the given storage location looks like an unjustified parameter.

The storage for a value may be contained in a normal parameter location but be unjustified within that container, i.e. the least significant bytes are not being used. If this is the case, pass back the full parameter location and return true.

Parameters

loc	is the starting address of the given storage
size	is the number of bytes in the given storage
res	is the full parameter storage to pass back

Returns: true if the given storage is unjustified within its parameter container

Implements ParamList.

References entry.

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

fspec.hh
fspec.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ assignAddress()

◆ assignMap()

◆ assumedExtension()

◆ buildTrialMap()

◆ checkJoin()

◆ checkSplit()

◆ fillinMap()

◆ findEntry()

◆ forceExclusionGroup()

◆ forceInactiveChain()

◆ forceNoUse()

◆ getMaxDelay()

◆ getRangeList()

◆ getSpacebase()

◆ possibleParam()

◆ possibleParamWithSlot()

◆ restoreXml()

◆ separateFloat()

◆ unjustifiedContainer()