Datatype object representing an array of elements. More...

#include <type.hh>

Inheritance diagram for ghidra::TypeArray:

Public Member Functions
	TypeArray (const TypeArray &op)
	Construct from another TypeArray.

	TypeArray (int4 n, Datatype *ao)
	Construct given an array size and element data-type.

Datatype *	getBase (void) const
	Get the element data-type.

int4	numElements (void) const
	Get the number of elements.

Datatype *	getSubEntry (int4 off, int4 sz, int4 newoff, int4 el) const
	Figure out what a byte range overlaps. More...

virtual void	printRaw (ostream &s) const
	Print a description of the type to stream. More...

virtual Datatype *	getSubType (int8 off, int8 *newoff) const
	Recover component data-type one-level down. More...

virtual int8	nearestArrayedComponentForward (int8 off, int8 max, int8 newoff, int8 elSize) const

virtual int8	nearestArrayedComponentBackward (int8 off, int8 max, int8 newoff, int8 elSize) const

virtual int4	getHoleSize (int4 off) const
	Get number of bytes at the given offset that are padding. More...

virtual int4	numDepend (void) const
	Get the number of component sub-types making up this data-type. More...

virtual Datatype *	getDepend (int4 index) const
	Get a specific component sub-type by index. More...

virtual void	printNameBase (ostream &s) const
	Print (part of) the name of this data-type as short prefix for a label. More...

virtual int4	compare (const Datatype &op, int4 level) const
	Order types for propagation. More...

virtual int4	compareDependency (const Datatype &op) const
	Compare for storage in tree structure. More...

virtual Datatype *	clone (void) const
	Clone the data-type. More...

virtual void	encode (Encoder &encoder) const
	Encode the data-type to a stream. More...

virtual Datatype *	resolveInFlow (PcodeOp *op, int4 slot)
	Tailor data-type propagation based on Varnode use. More...

virtual Datatype *	findResolve (const PcodeOp *op, int4 slot)
	Find a previously resolved sub-type. More...

virtual int4	findCompatibleResolve (Datatype *ct) const
	Find a resolution compatible with the given data-type. More...

Public Member Functions inherited from ghidra::Datatype
	Datatype (const Datatype &op)
	Construct the base data-type copying low-level properties of another.

	Datatype (int4 s, int4 align, type_metatype m)
	Construct the base data-type providing size and meta-type.

virtual	~Datatype (void)
	Destructor.

bool	isCoreType (void) const
	Is this a core data-type.

bool	isCharPrint (void) const
	Does this print as a 'char'.

bool	isEnumType (void) const
	Is this an enumerated type.

bool	isASCII (void) const
	Does this print as an ASCII 'char'.

bool	isUTF16 (void) const
	Does this print as UTF16 'wchar'.

bool	isUTF32 (void) const
	Does this print as UTF32 'wchar'.

bool	isVariableLength (void) const
	Is this a variable length structure.

bool	hasSameVariableBase (const Datatype *ct) const
	Are these the same variable length data-type. More...

bool	isOpaqueString (void) const
	Is this an opaquely encoded string.

bool	isPointerToArray (void) const
	Is this a pointer to an array.

bool	isPointerRel (void) const
	Is this a TypePointerRel.

bool	isFormalPointerRel (void) const
	Is this a non-ephemeral TypePointerRel.

bool	hasStripped (void) const
	Return true if this has a stripped form.

bool	isIncomplete (void) const
	Is this an incompletely defined data-type.

bool	needsResolution (void) const
	Is this a union or a pointer to union.

bool	hasWarning (void) const
	Has a warning been issued about this data-type.

bool	hasBitfields (void) const
	Return true if this contains/overlaps bitfields.

uint4	getInheritable (void) const
	Get properties pointers inherit.

uint4	getDisplayFormat (void) const
	Get the display format for constants with this data-type. More...

type_metatype	getMetatype (void) const
	Get the type meta-type.

sub_metatype	getSubMeta (void) const
	Get the sub-metatype.

uint8	getId (void) const
	Get the type id.

uint8	getUnsizedId (void) const
	Get the type id, without variable length size adjustment. More...

int4	getSize (void) const
	Get the type size.

int4	getAlignSize (void) const
	Get size rounded up to multiple of alignment.

int4	getAlignment (void) const
	Get the expected byte alignment.

const string &	getName (void) const
	Get the type name.

const string &	getDisplayName (void) const
	Get string to use in display.

Datatype *	getTypedef (void) const
	Get the data-type immediately typedefed by this (or null)

virtual void	printRaw (ostream &s) const
	Print a description of the type to stream. More...

virtual const TypeField *	findTruncation (int8 off, int4 sz, const PcodeOp *op, int4 slot, int8 &newoff) const
	Find an immediate subfield of this data-type. More...

virtual Datatype *	getSubType (int8 off, int8 *newoff) const
	Recover component data-type one-level down. More...

virtual int8	nearestArrayedComponentForward (int8 off, int8 max, int8 newoff, int8 elSize) const

virtual int8	nearestArrayedComponentBackward (int8 off, int8 max, int8 newoff, int8 elSize) const

virtual int4	getHoleSize (int4 off) const
	Get number of bytes at the given offset that are padding. More...

virtual int4	numDepend (void) const
	Get the number of component sub-types making up this data-type. More...

virtual Datatype *	getDepend (int4 index) const
	Get a specific component sub-type by index. More...

virtual Datatype *	getPtrInto (int4 &off) const
	If this is a pointer, return the large data-type this points into. More...

virtual void	printNameBase (ostream &s) const
	Print (part of) the name of this data-type as short prefix for a label. More...

virtual int4	compare (const Datatype &op, int4 level) const
	Order types for propagation. More...

virtual int4	compareDependency (const Datatype &op) const
	Compare for storage in tree structure. More...

virtual void	encode (Encoder &encoder) const
	Encode the data-type to a stream. More...

virtual bool	isPtrsubMatching (int8 off, int8 extra, int8 multiplier) const
	Is this data-type suitable as input to a CPUI_PTRSUB op. More...

virtual Datatype *	getStripped (void) const
	Get a stripped version of this for formal use in formal declarations. More...

virtual Datatype *	resolveInFlow (PcodeOp *op, int4 slot)
	Tailor data-type propagation based on Varnode use. More...

virtual Datatype *	findResolve (const PcodeOp *op, int4 slot)
	Find a previously resolved sub-type. More...

virtual int4	findCompatibleResolve (Datatype *ct) const
	Find a resolution compatible with the given data-type. More...

virtual const TypeField *	resolveTruncation (int8 offset, PcodeOp *op, int4 slot, int8 &newoff)
	Resolve which union field is being used for a given PcodeOp when a truncation is involved. More...

int4	typeOrder (const Datatype &op) const
	Order this with -op- datatype.

int4	typeOrderBool (const Datatype &op) const
	Order this with -op-, treating bool data-type as special. More...

void	encodeRef (Encoder &encoder) const
	Encode a reference of this to a stream. More...

bool	isPieceStructured (void) const
	Does this data-type consist of separate pieces? More...

bool	isPrimitiveWhole (void) const
	Is this made up of a single primitive. More...

Protected Member Functions
void	decode (Decoder &decoder, TypeFactory &typegrp)

	TypeArray (void)
	Internal constructor for decode.

Protected Member Functions inherited from ghidra::Datatype
void	decodeBasic (Decoder &decoder)
	Recover basic data-type properties. More...

void	encodeBasic (type_metatype meta, int4 align, Encoder &encoder) const
	Encode basic data-type properties. More...

void	encodeTypedef (Encoder &encoder) const
	Encode this as a typedef element to a stream. More...

void	markComplete (void)
	Mark this data-type as completely defined.

void	setDisplayFormat (uint4 format)
	Set a specific display format. More...

virtual Datatype *	clone (void) const =0
	Clone the data-type. More...

Protected Attributes
Datatype *	arrayof
	type of which we have an array

int4	arraysize
	Number of elements in the array.

Protected Attributes inherited from ghidra::Datatype
uint8	id
	A unique id for the type (or 0 if an id is not assigned)

int4	size
	Size (of variable holding a value of this type)

uint4	flags
	Boolean properties of the type.

string	name
	Name of type.

string	displayName
	Name to display in output.

type_metatype	metatype
	Meta-type - type disregarding size.

sub_metatype	submeta
	Sub-type of the meta-type, for comparisons.

Datatype *	typedefImm
	The immediate data-type being typedefed by this.

int4	alignment
	Byte alignment expected for this data-type in addressable memory.

int4	alignSize
	Size of data-type rounded up to a multiple of alignment.

Friends
class	TypeFactory

Additional Inherited Members
Static Public Member Functions inherited from ghidra::Datatype
static uint4	encodeIntegerFormat (const string &val)
	Encode the format attribute from an XML element. More...

static string	decodeIntegerFormat (uint4 val)
	Decode the given format value into an XML attribute string. More...

Protected Types inherited from ghidra::Datatype
enum	{ coretype = 1 , chartype = 2 , enumtype = 4 , poweroftwo = 8 , utf16 = 16 , utf32 = 32 , opaque_string = 64 , variable_length = 128 , has_stripped = 0x100 , is_ptrrel = 0x200 , type_incomplete = 0x400 , needs_resolution = 0x800 , force_format = 0x7000 , truncate_bigendian = 0x8000 , pointer_to_array = 0x10000 , warning_issued = 0x20000 , has_bitfields = 0x40000 }
	Boolean properties of datatypes. More...

Static Protected Member Functions inherited from ghidra::Datatype
static uint8	hashName (const string &nm)
	Produce a data-type id by hashing the type name. More...

static uint8	hashSize (uint8 id, int4 size)
	Reversibly hash size into id. More...

static int4	calcAlignSize (int4 sz, int4 align)
	Calculate aligned size, given size and alignment of data-type. More...

Static Protected Attributes inherited from ghidra::Datatype
static sub_metatype	base2sub [18]

Detailed Description

Datatype object representing an array of elements.

Member Function Documentation

◆ clone()

virtual Datatype * ghidra::TypeArray::clone ( void ) const

inlinevirtual

Clone the data-type.

Implements ghidra::Datatype.

References TypeArray().

◆ compare()

int4 ghidra::TypeArray::compare	(	const Datatype &	op,
		int4	level
	)		const

virtual

Order types for propagation.

Order this with another data-type, in a way suitable for the type propagation algorithm. Bigger types come earlier. More specific types come earlier.

Parameters

op	is the data-type to compare with this
level	is maximum level to descend when recursively comparing

Returns: negative, 0, positive depending on ordering of types

Reimplemented from ghidra::Datatype.

References arrayof, ghidra::Datatype::compare(), and ghidra::Datatype::getId().

◆ compareDependency()

int4 ghidra::TypeArray::compareDependency ( const Datatype & op ) const

virtual

Compare for storage in tree structure.

Sort data-types for the main TypeFactory container. The sort needs to be based on the data-type structure so that an example data-type, constructed outside the factory, can be used to find the equivalent object inside the factory. This means the comparison should not examine the data-type id. In practice, the comparison only needs to go down one level in the component structure before just comparing component pointers.

Parameters

op	is the data-type to compare with this

Returns: negative, 0, positive depending on ordering of types

Reimplemented from ghidra::Datatype.

References arrayof, ghidra::Datatype::getSize(), ghidra::Datatype::getSubMeta(), ghidra::Datatype::size, and ghidra::Datatype::submeta.

◆ decode()

void ghidra::TypeArray::decode	(	Decoder &	decoder,
		TypeFactory &	typegrp
	)

protected

Restore this array from a stream

Parse a <type> element with a child describing the array element data-type.

Parameters

decoder	is the stream decoder
typegrp	is the factory owning this data-type

References ghidra::Datatype::alignment, arrayof, arraysize, ghidra::Datatype::decodeBasic(), ghidra::TypeFactory::decodeType(), ghidra::Datatype::flags, ghidra::Datatype::getAlignment(), ghidra::Datatype::getAlignSize(), ghidra::Datatype::getName(), ghidra::Decoder::getNextAttributeId(), ghidra::Datatype::needs_resolution, ghidra::Decoder::readSignedInteger(), ghidra::Decoder::rewindAttributes(), and ghidra::Datatype::size.

Referenced by ghidra::TypeFactory::decodeTypeNoRef().

◆ encode()

void ghidra::TypeArray::encode ( Encoder & encoder ) const

virtual

Encode the data-type to a stream.

Encode a formal description of the data-type as a <type> element. For composite data-types, the description goes down one level, describing the component types only by reference.

Parameters

encoder is the stream encoder

Reimplemented from ghidra::Datatype.

References arrayof, arraysize, ghidra::Encoder::closeElement(), ghidra::Datatype::encodeBasic(), ghidra::Datatype::encodeRef(), ghidra::Datatype::encodeTypedef(), ghidra::Datatype::metatype, ghidra::Encoder::openElement(), ghidra::Datatype::typedefImm, and ghidra::Encoder::writeSignedInteger().

◆ findCompatibleResolve()

int4 ghidra::TypeArray::findCompatibleResolve ( Datatype * ct ) const

virtual

Find a resolution compatible with the given data-type.

If this data-type has an alternate data-type form that matches the given data-type, return an index indicating this form, otherwise return -1.

Parameters

ct	is the given data-type

Returns: the index of the matching form or -1

Reimplemented from ghidra::Datatype.

References arrayof, ghidra::Datatype::findCompatibleResolve(), and ghidra::Datatype::needsResolution().

◆ findResolve()

Datatype * ghidra::TypeArray::findResolve	(	const PcodeOp *	op,
		int4	slot
	)

virtual

Find a previously resolved sub-type.

This is the constant version of resolveInFlow. If a resulting subtype has already been calculated, for the particular read (slot >= 0) or write (slot == -1), then return it. Otherwise return the original data-type.

Parameters

op	is the PcodeOp using the Varnode assigned with this data-type
slot	is the slot reading or writing the Varnode

Returns: the resolved subtype or the original data-type

Reimplemented from ghidra::Datatype.

References arrayof, ghidra::ResolvedUnion::getDatatype(), ghidra::BlockBasic::getFuncdata(), ghidra::PcodeOp::getParent(), and ghidra::Funcdata::getUnionField().

◆ getDepend()

virtual Datatype * ghidra::TypeArray::getDepend ( int4 index ) const

inlinevirtual

Get a specific component sub-type by index.

Parameters

index is the index specifying which sub-type to return

Returns: the i-th component sub-type

Reimplemented from ghidra::Datatype.

References arrayof.

◆ getHoleSize()

int4 ghidra::TypeArray::getHoleSize ( int4 off ) const

virtual

Get number of bytes at the given offset that are padding.

For the given offset into this data-type, determine if the byte at that offset is considered padding, and if so, return the number of bytes in the padding. Otherwise, return 0.

Returns: the number of bytes of padding or 0

Reimplemented from ghidra::Datatype.

References arrayof, ghidra::Datatype::getAlignSize(), and ghidra::Datatype::getHoleSize().

◆ getSubEntry()

Datatype * ghidra::TypeArray::getSubEntry	(	int4	off,
		int4	sz,
		int4 *	newoff,
		int4 *	el
	)		const

Figure out what a byte range overlaps.

Given some contiguous piece of the array, figure out which element overlaps the piece, and pass back the element index and the renormalized offset

Parameters

off	is the offset into the array
sz	is the size of the piece (in bytes)
newoff	is a pointer to the renormalized offset to pass back
el	is a pointer to the array index to pass back

Returns: the element data-type or NULL if the piece overlaps more than one

References arrayof, and ghidra::Datatype::getAlignSize().

◆ getSubType()

Datatype * ghidra::TypeArray::getSubType	(	int8	off,
		int8 *	newoff
	)		const

virtual

Recover component data-type one-level down.

Given an offset into this data-type, return the component data-type at that offset. Also, pass back a "renormalized" offset suitable for recursize getSubType() calls: i.e. if the original offset hits the exact start of the sub-type, 0 is passed back. If there is no valid component data-type at the offset, return NULL and pass back the original offset

Parameters

off	is the offset into this data-type
newoff	is a pointer to the passed-back offset

Returns: a pointer to the component data-type or NULL

Reimplemented from ghidra::Datatype.

References arrayof, ghidra::Datatype::getAlignSize(), ghidra::Datatype::getSubType(), and ghidra::Datatype::size.

◆ nearestArrayedComponentBackward()

int8 ghidra::TypeArray::nearestArrayedComponentBackward	(	int8	off,
		int8	max,
		int8 *	newoff,
		int8 *	elSize
	)		const

virtual

If this data-type is (or contains) an array starting before the given offset, return the distance in bytes to the end of the array, and pass back the difference between the component's start and the given offset. Return the component data-type or null if no array is found.

Parameters

off	is the given offset into this data-type
max	is the maximum distance, in bytes, to search
newoff	is used to pass back the offset difference
elSize	is used to pass back the array element size

Returns: the distance to the array or -1 otherwise

Reimplemented from ghidra::Datatype.

References arrayof, ghidra::Datatype::getAlignSize(), and ghidra::Datatype::size.

◆ nearestArrayedComponentForward()

int8 ghidra::TypeArray::nearestArrayedComponentForward	(	int8	off,
		int8	max,
		int8 *	newoff,
		int8 *	elSize
	)		const

virtual

If this data-type is (or contains) an array starting after the given offset, return the distance in bytes to the start of the array, and pass back the difference between the component's start and the given offset.

Parameters

off	is the given offset into this data-type
max	is the maximum distance, in bytes, to search
newoff	is used to pass back the offset difference
elSize	is used to pass back the array element size

Returns: the distance to the array or -1 otherwise

Reimplemented from ghidra::Datatype.

References arrayof, and ghidra::Datatype::getAlignSize().

◆ numDepend()

virtual int4 ghidra::TypeArray::numDepend ( void ) const

inlinevirtual

Get the number of component sub-types making up this data-type.

Returns: the number of components

Reimplemented from ghidra::Datatype.

◆ printNameBase()

virtual void ghidra::TypeArray::printNameBase ( ostream & s ) const

inlinevirtual

Print (part of) the name of this data-type as short prefix for a label.

This is used for building variable names to give some indication of the variable's underlying data-type

Parameters

s	is the stream write the name prefix to

Reimplemented from ghidra::Datatype.

References arrayof, and ghidra::Datatype::printNameBase().

◆ printRaw()

void ghidra::TypeArray::printRaw ( ostream & s ) const

virtual

Print a description of the type to stream.

Print a raw description of the type to stream. Intended for debugging. Not intended to produce parsable C.

Parameters

s	is the output stream

Reimplemented from ghidra::Datatype.

References arrayof, arraysize, and ghidra::Datatype::printRaw().

◆ resolveInFlow()

Datatype * ghidra::TypeArray::resolveInFlow	(	PcodeOp *	op,
		int4	slot
	)

virtual

Tailor data-type propagation based on Varnode use.

For certain data-types, particularly union, variables of that data-type are transformed into a subtype depending on the particular use. Each read or write of the variable may use a different subtype. This method returns the particular subtype required based on a specific PcodeOp. A slot index >=0 indicates which operand reads the variable, or if the index is -1, the variable is written.

Parameters

op	is the specific PcodeOp
slot	indicates the input operand, or the output

Returns: the resolved sub-type

Reimplemented from ghidra::Datatype.

References ghidra::Funcdata::getArch(), ghidra::ResolvedUnion::getDatatype(), ghidra::BlockBasic::getFuncdata(), ghidra::PcodeOp::getParent(), ghidra::Funcdata::getUnionField(), ghidra::TypeStruct::scoreSingleComponent(), ghidra::Funcdata::setUnionField(), and ghidra::Architecture::types.

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

type.hh
type.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ clone()

◆ compare()

◆ compareDependency()

◆ decode()

◆ encode()

◆ findCompatibleResolve()

◆ findResolve()

◆ getDepend()

◆ getHoleSize()

◆ getSubEntry()

◆ getSubType()

◆ nearestArrayedComponentBackward()

◆ nearestArrayedComponentForward()

◆ numDepend()

◆ printNameBase()

◆ printRaw()

◆ resolveInFlow()