Package com.pnfsoftware.jeb.core.units.code.asm.type

Class CallingConvention

java.lang.Object

com.pnfsoftware.jeb.core.units.code.asm.type.CallingConvention

All Implemented Interfaces:

ICallingConvention

@Ser
public class CallingConvention
extends Object
implements ICallingConvention

Standard implementation of a calling convention object. It can be sub-classed to generate custom input/output layout.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	CallingConvention.ArgLocationGenerator	Storage-location generator for routine arguments (inputs).
class	CallingConvention.RetLocationGenerator	Storage-location generator for routine return values (outputs).

Field Summary

Fields inherited from interface com.pnfsoftware.jeb.core.units.code.asm.type.ICallingConvention

FLAG_COMPOSITE_INPUT_ON_STACK, FLAG_FIRST_ARG_IS_THIS_POINTER, FLAG_FLOAT_INPUT_ON_STACK, FLAG_FORBID_PARAMS_2SLOTSUP, FLAG_FORBID_PARAMS_3SLOTSUP, FLAG_IPRD, FLAG_LINK_AFTER_INPUT, FLAG_OUTPUT_AFTER_INPUT, FLAG_OUTPUT_PUSHED, FLAG_PARALLEL_INPUT_REGISTER_STACKS, FLAG_SKIP_PASSED_INPUT_REGISTERS, FLAG_STACK_CLEANED_BY_CALLEE

Constructor Summary

Constructors

Constructor	Description
CallingConvention()	Reserved.

Method Summary

Modifier and Type	Method	Description
CallingConvention	clone()
int	determineSlotcountAlignment(int requestedSlotcount)	Determine the slotcount alignment requirement of a non-composite type.
String	format(int type)
String	formatParseable()
String	formatUser()
List<String>	getAlternateNames()	Get a list of alternate names for this calling convention.
List<CompilerType>	getCompilerTypes()	Get the list of compiler types this calling convention may work with.
int	getFlags()
long	getIdentifierKey()	Get an internally-generated identifier for this calling convention object.
CallingConvention.ArgLocationGenerator	getInputsGenerator()	Create a storage-location generator for the inputs provided to a routine using this calling convention.
int	getInputSlotCountHint()	Return the number of slots that are reserved for parameters.
ICallingConvention	getIPRDConvention()	Retrieve the optional calling convention, derived from this convention, used to return large composite prototypes.
StorageEntry	getIPRDInputPtrEntry()
int	getIPRDMinimumSlotCount()
StorageEntry	getIPRDOutputPtrEntry()
String	getName()	Get the common name of this calling convention.
List<String>	getNames()	Retrieve all names for this calling convention (principal and alternates).
String	getNotes()
StorageEntry	getOutput(TypeLayoutInfo ti, int inputStackSlotCount)	Convenience method to retrieve the storage location of the single return value for this calling convention.
CallingConvention.RetLocationGenerator	getOutputsGenerator(int inputStackSlotCount)	Create a storage-location generator for the outputs provided to a routine using this calling convention.
int	getOutputSlotCountHint()	Return the number of slots that are reserved for return values.
ProcessorType	getPrimaryProcessorType()
List<ProcessorType>	getProcessorTypes()	Get the list of processor types this calling convention may work with.
Collection<Long>	getPureSpoiledRegisters()	Get the list of registers that are spoiled by a callee, in the strictest sense, i.e.
StorageEntry	getReturnAddressSlot()
StorageEntry	getReturnAddressSlot(Integer inputStackSlotCount)
Map<Integer,Integer>	getSlotcountAlignmentMap()	Alignment specifications for non-composite types.
Collection<Long>	getSpoiledRegisters()	Get the list of all registers that may be modified and/or spoiled by a callee, in the most general sense.
List<SubsystemType>	getSubsystemTypes()	Get the list of subsystem types this calling convention may work with.
boolean	hasFlag(int f)
boolean	isCompatibleWith(ProcessorType wantedProcessor, SubsystemType wantedSubsystem, CompilerType wantedCompiler)	Determine whether this calling convention is compatible with the provided triple (processor, subsystem, compiler).
boolean	isUnknown()
String	toString()

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.pnfsoftware.jeb.core.units.code.asm.type.ICallingConvention

isStackCleanedByCallee, isStackCleanedByCaller

Constructor Details

CallingConvention

public CallingConvention()

Reserved.

Method Details

clone

public CallingConvention clone()

Overrides:

clone in class Object

getIdentifierKey

public long getIdentifierKey()

Description copied from interface: ICallingConvention

Get an internally-generated identifier for this calling convention object. The id is generated using:

• the same names
• same flags
• same processor targets
• same subsystem targets
• same compiler targets

Specified by:

getIdentifierKey in interface ICallingConvention

Returns:

the key for this calling convention

getNotes

public String getNotes()

Specified by:

getNotes in interface ICallingConvention

Returns:

getFlags

public int getFlags()

Specified by:

getFlags in interface ICallingConvention

Returns:

hasFlag

public boolean hasFlag(int f)

Specified by:

hasFlag in interface ICallingConvention

Returns:

isUnknown

public boolean isUnknown()

Specified by:

isUnknown in interface ICallingConvention

Returns:

getName

public String getName()

Description copied from interface: ICallingConvention

Get the common name of this calling convention.

Specified by:

getName in interface ICallingConvention

Returns:

getAlternateNames

public List<String> getAlternateNames()

Description copied from interface: ICallingConvention

Get a list of alternate names for this calling convention.

Specified by:

getAlternateNames in interface ICallingConvention

Returns:

getNames

public List<String> getNames()

Description copied from interface: ICallingConvention

Retrieve all names for this calling convention (principal and alternates).

Specified by:

getNames in interface ICallingConvention

Returns:

getPrimaryProcessorType

public ProcessorType getPrimaryProcessorType()

getProcessorTypes

public List<ProcessorType> getProcessorTypes()

Description copied from interface: ICallingConvention

Get the list of processor types this calling convention may work with.

Specified by:

getProcessorTypes in interface ICallingConvention

Returns:

getSubsystemTypes

public List<SubsystemType> getSubsystemTypes()

Description copied from interface: ICallingConvention

Get the list of subsystem types this calling convention may work with.

Specified by:

getSubsystemTypes in interface ICallingConvention

Returns:

getCompilerTypes

public List<CompilerType> getCompilerTypes()

Description copied from interface: ICallingConvention

Get the list of compiler types this calling convention may work with.

Specified by:

getCompilerTypes in interface ICallingConvention

Returns:

isCompatibleWith

public boolean isCompatibleWith(ProcessorType wantedProcessor,
 SubsystemType wantedSubsystem,
 CompilerType wantedCompiler)

Description copied from interface: ICallingConvention

Determine whether this calling convention is compatible with the provided triple (processor, subsystem, compiler).

Specified by:

isCompatibleWith in interface ICallingConvention

Parameters:

wantedProcessor - mandatory (pass UNKNOWN if not known)

wantedSubsystem - mandatory (pass UNKNOWN if not known)

wantedCompiler - mandatory (pass UNKNOWN if not known)

Returns:

getSpoiledRegisters

public Collection<Long> getSpoiledRegisters()

Description copied from interface: ICallingConvention

Get the list of all registers that may be modified and/or spoiled by a callee, in the most general sense. That set would include any type of return registers.

Specified by:

getSpoiledRegisters in interface ICallingConvention

Returns:

getPureSpoiledRegisters

public Collection<Long> getPureSpoiledRegisters()

Description copied from interface: ICallingConvention

Get the list of registers that are spoiled by a callee, in the strictest sense, i.e. their value may or may not be modified, but it is meaningless and should not be interpreted by the caller upon return. That set would NOT include return registers.

Specified by:

getPureSpoiledRegisters in interface ICallingConvention

Returns:

getReturnAddressSlot

public StorageEntry getReturnAddressSlot()

Specified by:

getReturnAddressSlot in interface ICallingConvention

Returns:

getReturnAddressSlot

public StorageEntry getReturnAddressSlot(Integer inputStackSlotCount)

Specified by:

getReturnAddressSlot in interface ICallingConvention

Returns:

getOutput

public StorageEntry getOutput(TypeLayoutInfo ti,
 int inputStackSlotCount)

Description copied from interface: ICallingConvention

Convenience method to retrieve the storage location of the single return value for this calling convention. Most calling conventions allow the return of a single value.

Specified by:

getOutput in interface ICallingConvention

Parameters:

ti - storage type

inputStackSlotCount - the number of stack slots used to provide input parameters (some calling conventions require that to calculate proper positioning for output values)

Returns:

getInputSlotCountHint

public int getInputSlotCountHint()

Description copied from interface: ICallingConvention

Return the number of slots that are reserved for parameters. Note that this is just a hint on how many parameters are used.

Specified by:

getInputSlotCountHint in interface ICallingConvention

Returns:

getOutputSlotCountHint

public int getOutputSlotCountHint()

Description copied from interface: ICallingConvention

Return the number of slots that are reserved for return values. Note that this is just a hint on how many return values are defined.

Specified by:

getOutputSlotCountHint in interface ICallingConvention

Returns:

getSlotcountAlignmentMap

public Map<Integer,Integer> getSlotcountAlignmentMap()

Description copied from interface: ICallingConvention

Alignment specifications for non-composite types.

Specified by:

getSlotcountAlignmentMap in interface ICallingConvention

Returns:

determineSlotcountAlignment

public int determineSlotcountAlignment(int requestedSlotcount)

Description copied from interface: ICallingConvention

Determine the slotcount alignment requirement of a non-composite type.

Specified by:

determineSlotcountAlignment in interface ICallingConvention

Returns:

getIPRDMinimumSlotCount

public int getIPRDMinimumSlotCount()

Specified by:

getIPRDMinimumSlotCount in interface ICallingConvention

Returns:

getIPRDInputPtrEntry

public StorageEntry getIPRDInputPtrEntry()

Specified by:

getIPRDInputPtrEntry in interface ICallingConvention

Returns:

getIPRDOutputPtrEntry

public StorageEntry getIPRDOutputPtrEntry()

Specified by:

getIPRDOutputPtrEntry in interface ICallingConvention

Returns:

getIPRDConvention

public ICallingConvention getIPRDConvention()

Description copied from interface: ICallingConvention

Retrieve the optional calling convention, derived from this convention, used to return large composite prototypes. This only applies if the flag ICallingConvention.FLAG_IPRD was set.

Specified by:

getIPRDConvention in interface ICallingConvention

Returns:

a linked IPRD (Implicit Pointer to Return Data) convention, or null

toString

public String toString()

Overrides:

toString in class Object

format

public String format(int type)

Specified by:

format in interface ICallingConvention

Parameters:

type - 0: short-form (i.e., #toString()), 1: user-friendly long-form, 2: parseable yaml form

Returns:

formatParseable

public String formatParseable()

formatUser

public String formatUser()

getInputsGenerator

public CallingConvention.ArgLocationGenerator getInputsGenerator()

Description copied from interface: ICallingConvention

Create a storage-location generator for the inputs provided to a routine using this calling convention. convention.

Specified by:

getInputsGenerator in interface ICallingConvention

Returns:

a generator

getOutputsGenerator

public CallingConvention.RetLocationGenerator getOutputsGenerator(int inputStackSlotCount)

Description copied from interface: ICallingConvention

Create a storage-location generator for the outputs provided to a routine using this calling convention.

Specified by:

getOutputsGenerator in interface ICallingConvention

Parameters:

inputStackSlotCount - optional value indicating how many stack slots were used to provide parameters (this value is the calling convention has the flags ICallingConvention.FLAG_OUTPUT_AFTER_INPUT or ICallingConvention.FLAG_OUTPUT_PUSHED)

Returns:

a generator