My Project
Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
RangeHint Class Reference

Partial data-type information mapped to a specific range of bytes. More...

#include <varmap.hh>

Public Types

enum  RangeType { fixed = 0, open = 1, endpoint = 2 }
 The basic categorization of the range. More...
 

Public Member Functions

 RangeHint (void)
 Uninitialized constructor.
 
 RangeHint (uintb st, int4 sz, intb sst, Datatype *ct, uint4 fl, RangeType rt, int4 hi)
 Initialized constructor.
 
bool reconcile (const RangeHint *b) const
 Can the given intersecting RangeHint coexist with this at their given offsets. More...
 
bool contain (const RangeHint *b) const
 Return true if this or the given range contains the other. More...
 
bool preferred (const RangeHint *b, bool reconcile) const
 Return true if the this range's data-type is preferred over the other given range. More...
 
bool absorb (RangeHint *b)
 Try to absorb the other RangeHint into this. More...
 
bool merge (RangeHint *b, AddrSpace *space, TypeFactory *typeFactory)
 Try to form the union of this with another RangeHint. More...
 
int4 compare (const RangeHint &op2) const
 Order this with another RangeHint. More...
 

Static Public Member Functions

static bool compareRanges (const RangeHint *a, const RangeHint *b)
 Compare two RangeHint pointers.
 

Friends

class MapState
 
class ScopeLocal
 

Detailed Description

Partial data-type information mapped to a specific range of bytes.

This object gives a hint about the data-type for a sequence of bytes starting at a specific address offset (typically on the stack). It describes where the data-type starts, what data-type it might be, and how far it extends from the start point (possibly as an array).

Member Enumeration Documentation

◆ RangeType

The basic categorization of the range.

Enumerator
fixed 

A data-type with a fixed size.

open 

An array with a (possibly unknown) number of elements.

endpoint 

An (artificial) boundary to the range of bytes getting analyzed.

Member Function Documentation

◆ absorb()

bool RangeHint::absorb ( RangeHint b)

Try to absorb the other RangeHint into this.

If this RangeHint is an array and the following details line up, adjust this so that it absorbs the other given RangeHint and return true. The second RangeHint:

  • must have the same element size
  • must have close to the same data-type
  • must line up with the step of the first array
  • must not be a locked data-type
  • must not extend the size of the first array beyond what is known of its limits
Parameters
bis the other RangeHint to absorb
Returns
true if the other RangeHint was successfully absorbed

◆ compare()

int4 RangeHint::compare ( const RangeHint op2) const

Order this with another RangeHint.

Compare (signed) offset, size, RangeType, type lock, and high index, in that order. Datatype is not compared.

Parameters
op2is the other RangeHint to compare with this
Returns
-1, 0, or 1 depending on if this comes before, is equal to, or comes after

◆ contain()

bool RangeHint::contain ( const RangeHint b) const

Return true if this or the given range contains the other.

We assume this range starts at least as early as the given range and that the two ranges intersect.

Parameters
bis the given range to check for containment with this
Returns
true if one contains the other

◆ merge()

bool RangeHint::merge ( RangeHint b,
AddrSpace space,
TypeFactory typeFactory 
)

Try to form the union of this with another RangeHint.

Given that this and the other RangeHint intersect, redefine this so that it becomes the union of the two original ranges. The union must succeed in some form. An attempt is made to preserve the data-type information of both the original ranges, but changes will be made if necessary. An exception is thrown if the data-types are locked and cannot be reconciled.

Parameters
bis the other RangeHint to merge with this
spaceis the address space holding the ranges
typeFactoryis a factory for producing data-types
Returns
true if there was an overlap that could be reconciled

◆ preferred()

bool RangeHint::preferred ( const RangeHint b,
bool  reconcile 
) const

Return true if the this range's data-type is preferred over the other given range.

A locked data-type is preferred over unlocked. A fixed size over open size. Otherwise data-type ordering is used.

Parameters
bis the other given range
reconcileis true is the two ranges have reconciled data-types
Returns
true if the this ranges's data-type is preferred

◆ reconcile()

bool RangeHint::reconcile ( const RangeHint b) const

Can the given intersecting RangeHint coexist with this at their given offsets.

Determine if the data-type information in the two ranges line up properly, in which case the union of the two ranges can exist without destroying data-type information.

Parameters
bis the range to reconcile with this

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