decompiler  1.0.0
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
ghidra::TypeArray Class Reference

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

#include <type.hh>

Inheritance diagram for ghidra::TypeArray:
ghidra::Datatype

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.
 
DatatypegetBase (void) const
 Get the element data-type.
 
int4 numElements (void) const
 Get the number of elements.
 
DatatypegetSubEntry (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 DatatypegetSubType (int8 off, int8 *newoff) const
 Recover component data-type one-level down. More...
 
virtual int4 getHoleSize (int4 off) const
 Get number of bytes at the given offset that are padding.
 
virtual int4 numDepend (void) const
 Return number of component sub-types.
 
virtual DatatypegetDepend (int4 index) const
 Return the i-th component sub-type.
 
virtual void printNameBase (ostream &s) const
 Print name as short prefix.
 
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 Datatypeclone (void) const
 Clone the data-type.
 
virtual void encode (Encoder &encoder) const
 Encode the data-type to a stream. More...
 
virtual DatatyperesolveInFlow (PcodeOp *op, int4 slot)
 Tailor data-type propagation based on Varnode use. More...
 
virtual DatatypefindResolve (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, 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 isPowerOfTwo (void) const
 Is this a flag-based enumeration.
 
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 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.
 
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.
 
int4 getSize (void) const
 Get the type size.
 
const string & getName (void) const
 Get the type name.
 
const string & getDisplayName (void) const
 Get string to use in display.
 
DatatypegetTypedef (void) const
 Get the data-type immediately typedefed by this (or null)
 
virtual const TypeFieldfindTruncation (int8 off, int4 sz, const PcodeOp *op, int4 slot, int8 &newoff) const
 Find an immediate subfield of this data-type. More...
 
virtual DatatypenearestArrayedComponentForward (int8 off, int8 *newoff, int8 *elSize) const
 
virtual DatatypenearestArrayedComponentBackward (int8 off, int8 *newoff, int8 *elSize) const
 
virtual bool isPtrsubMatching (uintb off) const
 Is this data-type suitable as input to a CPUI_PTRSUB op. More...
 
virtual DatatypegetStripped (void) const
 Get a stripped version of this for formal use in formal declarations. More...
 
virtual const TypeFieldresolveTruncation (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...
 

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

Protected Attributes

Datatypearrayof
 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 of the meta-type, for comparisons.
 
DatatypetypedefImm
 The immediate data-type being typedefed by this.
 

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
}
 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 Protected Attributes inherited from ghidra::Datatype
static sub_metatype base2sub [15]
 

Detailed Description

Datatype object representing an array of elements.

Member Function Documentation

◆ 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
opis the data-type to compare with this
levelis 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
opis 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
decoderis the stream decoder
typegrpis the factory owning this data-type

References ghidra::Datatype::decodeBasic(), ghidra::TypeFactory::decodeType(), ghidra::Datatype::flags, 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
encoderis the stream encoder

Reimplemented from ghidra::Datatype.

References ghidra::Encoder::closeElement(), ghidra::Datatype::encodeBasic(), ghidra::Datatype::encodeTypedef(), 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
ctis the given data-type
Returns
the index of the matching form or -1

Reimplemented from ghidra::Datatype.

References 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
opis the PcodeOp using the Varnode assigned with this data-type
slotis the slot reading or writing the Varnode
Returns
the resolved subtype or the original data-type

Reimplemented from ghidra::Datatype.

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

◆ 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
offis the offset into the array
szis the size of the piece (in bytes)
newoffis a pointer to the renormalized offset to pass back
elis a pointer to the array index to pass back
Returns
the element data-type or NULL if the piece overlaps more than one

References ghidra::Datatype::getSize().

◆ 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
offis the offset into this data-type
newoffis a pointer to the passed-back offset
Returns
a pointer to the component data-type or NULL

Reimplemented from ghidra::Datatype.

References ghidra::Datatype::getSize().

◆ 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
sis the output stream

Reimplemented from ghidra::Datatype.

◆ 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
opis the specific PcodeOp
slotindicates 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: