An enumerated Datatype object: an integer with named values. More...

#include <type.hh>

Inheritance diagram for ghidra::TypeEnum:

Collaboration diagram for ghidra::TypeEnum:

Classes
class	Representation
	Class describing how a particular enumeration value is constructed using tokens. More...

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

	TypeEnum (int4 s, type_metatype m)
	Construct from a size and meta-type (TYPE_INT or TYPE_UINT)

	TypeEnum (int4 s, type_metatype m, const string &nm)
	Construct from a size, meta-type, and name.

map< uintb, string >::const_iterator	beginEnum (void) const
	Beginning of name map.

map< uintb, string >::const_iterator	endEnum (void) const
	End of name map.

virtual bool	hasNamedValue (uintb val) const
	Does this have a (single) name for the given value.

virtual void	getMatches (uintb val, Representation &rep) const
	Recover the named representation.

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

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

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

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

Public Member Functions inherited from ghidra::TypeBase
	TypeBase (const TypeBase &op)
	Construct TypeBase copying properties from another data-type.

	TypeBase (int4 s, type_metatype m)
	Construct TypeBase from a size and meta-type.

	TypeBase (int4 s, type_metatype m, const string &n)
	Construct TypeBase from a size, meta-type, and name.

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.

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.

uint4	getInheritable (void) const
	Get properties pointers inherit.

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

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.

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.

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

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

virtual Datatype *	nearestArrayedComponentForward (int8 off, int8 newoff, int8 elSize) const

virtual Datatype *	nearestArrayedComponentBackward (int8 off, int8 newoff, int8 elSize) const

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

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

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

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

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

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

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

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

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

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.

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.

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

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

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

Static Public Member Functions
static void	assignValues (map< uintb, string > &nmap, const vector< string > &namelist, vector< uintb > &vallist, const vector< bool > &assignlist, const TypeEnum *te)

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

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

Protected Member Functions
void	setNameMap (const map< uintb, string > &nmap)
	Establish the value -> name map.

string	decode (Decoder &decoder, TypeFactory &typegrp)
	Restore this enum data-type from a stream.

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

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

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

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

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

Protected Attributes
map< uintb, string >	namemap
	Map from integer to name.

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 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
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 }
	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.

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

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

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

Detailed Description

An enumerated Datatype object: an integer with named values.

This supports combinations of the enumeration values (using logical OR and bit-wise complement) by defining independent bit-fields.

Member Function Documentation

◆ assignValues()

void ghidra::TypeEnum::assignValues	(	map< uintb, string > &	nmap,
		const vector< string > &	namelist,
		vector< uintb > &	vallist,
		const vector< bool > &	assignlist,
		const TypeEnum *	te
	)

static

Establish unique enumeration values for a TypeEnum. Fill in any values for any names that weren't explicitly assigned and check for duplicates.

Parameters

nmap	will contain the map from values to names
namelist	is the list of names in the enumeration
vallist	is the corresponding list of values assigned to names in namelist
assignlist	is true if the corresponding name in namelist has an assigned value
te	is the TypeEnum that will eventually hold the enumeration values

References ghidra::calc_mask(), ghidra::Datatype::getSize(), and ghidra::Datatype::name.

◆ clone()

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

inlinevirtual

Clone the data-type.

Reimplemented from ghidra::TypeBase.

Reimplemented in ghidra::TypePartialEnum.

◆ compare()

int4 ghidra::TypeEnum::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.

Reimplemented in ghidra::TypePartialEnum.

References compareDependency().

Referenced by ghidra::TypePartialEnum::compare().

◆ compareDependency()

int4 ghidra::TypeEnum::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.

Reimplemented in ghidra::TypePartialEnum.

References ghidra::Datatype::compareDependency(), and namemap.

Referenced by compare().

◆ decode()

string ghidra::TypeEnum::decode	(	Decoder &	decoder,
		TypeFactory &	typegrp
	)

protected

Restore this enum data-type from a stream.

Parse a <type> element with children describing each specific enumeration value.

Parameters

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

Returns: any warning associated with the enum

References ghidra::calc_mask(), ghidra::Decoder::closeElement(), ghidra::Datatype::decodeBasic(), ghidra::Decoder::getNextAttributeId(), ghidra::Datatype::metatype, ghidra::Datatype::name, ghidra::Decoder::openElement(), ghidra::Decoder::readSignedInteger(), ghidra::Decoder::readString(), setNameMap(), ghidra::Datatype::size, ghidra::TYPE_ENUM_INT, ghidra::TYPE_INT, and ghidra::TYPE_UINT.

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

◆ encode()

void ghidra::TypeEnum::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.

Reimplemented in ghidra::TypePartialEnum.

References ghidra::Encoder::closeElement(), ghidra::Datatype::encodeBasic(), ghidra::Datatype::encodeTypedef(), ghidra::Datatype::metatype, namemap, ghidra::Encoder::openElement(), ghidra::TYPE_ENUM_INT, ghidra::TYPE_ENUM_UINT, ghidra::TYPE_INT, ghidra::Datatype::typedefImm, ghidra::Encoder::writeString(), and ghidra::Encoder::writeUnsignedInteger().

◆ getMatches()

void ghidra::TypeEnum::getMatches	(	uintb	val,
		Representation &	rep
	)		const

virtual

Recover the named representation.

Given a specific value of the enumeration, calculate the named representation of that value. The representation is returned as a list of names that must logically ORed and possibly complemented. If no representation is possible, no names will be returned.

Parameters

val	is the value to find the representation for
rep	will contain the individual names in the representation and other transforms

Reimplemented in ghidra::TypePartialEnum.

References ghidra::calc_mask(), ghidra::TypeEnum::Representation::complement, ghidra::TypeEnum::Representation::matchname, namemap, and ghidra::Datatype::size.

Referenced by ghidra::TypePartialEnum::getMatches(), and ghidra::PrintC::pushEnumConstant().

◆ hasNamedValue()

bool ghidra::TypeEnum::hasNamedValue ( uintb val ) const

virtual

Does this have a (single) name for the given value.

Parameters

val	is the given value to test

Returns: true if this enumeration has a name with the value

Reimplemented in ghidra::TypePartialEnum.

References namemap.

Referenced by ghidra::RuleAddUnsigned::applyOp(), and ghidra::TypePartialEnum::hasNamedValue().

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

/builds/appsec/reveng-binrw/ghidraplusplus/src/dec/type.hh
/builds/appsec/reveng-binrw/ghidraplusplus/src/dec/type.cc

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ assignValues()

◆ clone()

◆ compare()

◆ compareDependency()

◆ decode()

◆ encode()

◆ getMatches()

◆ hasNamedValue()