coins.sym
Class ElemImpl

java.lang.Object
  coins.sym.SymImpl
      coins.sym.VarImpl
          coins.sym.ElemImpl

All Implemented Interfaces:

java.lang.Cloneable, Elem, FlowAnalSym, HasStringObject, Sym, Sym0, Var

public class ElemImpl

extends VarImpl

implements Elem

class Elem

Field Summary

Fields inherited from class coins.sym.VarImpl

fDefList, fDefUseList, fIndex, fOperandSet, fUseList

Fields inherited from class coins.sym.SymImpl

fDbgLevel, fDefinedIn, fFlagBox, fKind, fName, fNextSym, fRecordedIn, fSourceInf, fSymInf, fType, fUniqueNameSym, fWork, machineParam, sourceLanguage, symRoot

Fields inherited from interface coins.sym.Var

STORAGECLASS, VAR_AUTO, VAR_REGISTER, VAR_STATIC

Fields inherited from interface coins.sym.Sym

KIND_NAME, VISIBILITY

Fields inherited from interface coins.sym.Sym0

FLAG_ADDRESS_TAKEN, FLAG_CASTLESS_SUBP, FLAG_COMMON, FLAG_COMPLEX_STRUCT, FLAG_DERIVED_SYM, FLAG_GENERATED_SYM, FLAG_INCOMPLETE_TYPE, FLAG_POINTER_OPERATION, FLAG_REGION_ELEM, FLAG_RESERVED_NAME, FLAG_SIZEOF_TAKEN, FLAG_UNFIXED_SIZE, FLAG_UNIFORM_SIZE, FLAG_VALUE_IS_ASSIGNED, KIND_AREG, KIND_BOOL_CONST, KIND_CHAR_CONST, KIND_CONST_FIRST, KIND_CONST_LAST, KIND_ELEM, KIND_EXP_ID, KIND_FLOAT_CONST, KIND_INT_CONST, KIND_LABEL, KIND_MREG, KIND_NAMED_CONST, KIND_OTHER, KIND_PARAM, KIND_REMOVED, KIND_STRING_CONST, KIND_SUBP, KIND_TAG, KIND_TYPE, KIND_VAR, SYM_COMPILE_UNIT, SYM_EXTERN, SYM_PRIVATE, SYM_PROTECTED, SYM_PUBLIC

Constructor Summary

ElemImpl(SymRoot pSymRoot)

ElemImpl(SymRoot pSymRoot, java.lang.String pElemName, Sym pDefinedIn)

ElemImpl(SymRoot pSymRoot, java.lang.String pElemName, Sym pDefinedIn, Exp pDispExp)

Method Summary

long	evaluateDisp() evaluateDisp "this" should be an element of struct/union type symbol.
int	getBitOffset() getBitOffset See also setBitFieldOffset method.
int	getBitSize() getBitSize See also setBitFieldOffset method.
Type	getUpperType() getUpperType
boolean	isBitField() isBitField
boolean	isDispEvaluable() isDispEvaluable Get the displacement of elements.
Elem	searchElem(Type pRecordedIn) searchElem Get the proper element having the same name as this symbol in pRecordedIn construct (structure or union).
Elem	searchElem(Var pVar) searchElem Get the proper element having the same name as this symbol in the struct/union variable pVar.
void	setBitField(int pBitSize, int pBitOffset)
void	setBitFieldOffset(int pBitOffset) setBitFieldOffset
void	setBitFieldSize(int pBitSize) Set the size of bit field and set an indication showing that this element is a bit field.
void	setDispExp(Exp pDispExp) setDispExp Set the displacement of this element.
void	setDisplacement(long pDisplacement)
java.lang.String	toString() Get the string image of object.

Methods inherited from class coins.sym.VarImpl

addOperand, evaluateAsObject, getDimension, getIndex, getInitialValue, getNext, getOperandSet, getSize, getStorageClass, getVisibility, isSizeEvaluable, resetFlowAnalInf, setIndex, setInitialValue, setNext, setStorageClass, setVisibility, toStringDetail

Methods inherited from class coins.sym.SymImpl

bareStringConst, baseType, boolConst, charConst, charConst, charConst, definedType, definedType, defineElem, defineLabel, defineParam, defineRegionVar, defineSubp, defineVar, defineVar, derivedSym, enumType, enumType, floatConst, floatConst, getDefinedColumn, getDefinedFile, getDefinedIn, getDefinedInName, getDefinedLine, getFlag, getInf, getName, getNameOrNull, getNextSym, getOrAddInf, getOriginalSym, getOriginalSym, getPureName, getRecordedIn, getSourceInf, getSymKind, getSymKindName, getSymType, getUniqueName, getWork, intConst, intConst, intObject, isGlobal, isHIR, isRemoved, isSym, linkSym, makeCstring, makeCstringWithTrailing0, makeEnumTypeName, makeExpString, makeJavaString, makeStructUnionTypeName, makeSubpTypeName, makeSubpTypeName, makeVectorTypeName, makeVectorTypeName, makeVectorTypeName, namedConst, namedConst, pointerType, pointerType, pointerType, pointerType, pointerType, print, print, regionType, regionType, remove, setDefinedFile, setDefinedIn, setDefinedLine, setFlag, setOriginalSym, setParameters, setRecordedIn, setSourceInf, setSymKind, setSymType, setUniqueNameSym, setWork, stringConst, stringConstFromQuotedString, structType, structType, subpType, subpType, symbol, toStringShort, unionType, unionType, vectorType, vectorType, vectorType, vectorType, vectorTypeUnfixed, vectorTypeUnfixed

Methods inherited from class java.lang.Object

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

Methods inherited from interface coins.sym.Var

evaluateAsObject, getDimension, getInitialValue, getNext, getSize, getStorageClass, getVisibility, isSizeEvaluable, setInitialValue, setNext, setStorageClass, setVisibility

Methods inherited from interface coins.sym.Sym

baseType, boolConst, charConst, defineVar, derivedSym, floatConst, getDefinedColumn, getDefinedInName, getDefinedLine, getInf, getNameOrNull, getOrAddInf, getOriginalSym, getOriginalSym, getPureName, getSymKindName, getWork, intConst, intObject, isRemoved, makeCstring, makeCstringWithTrailing0, makeEnumTypeName, makeJavaString, makeStructUnionTypeName, makeSubpTypeName, makeVectorTypeName, makeVectorTypeName, makeVectorTypeName, namedConst, pointerType, pointerType, pointerType, regionType, remove, setDefinedFile, setDefinedIn, setDefinedLine, setRecordedIn, setSymKind, setSymType, setUniqueNameSym, setWork, stringConstFromQuotedString, symbol, toStringDetail, toStringShort, vectorType, vectorType, vectorType, vectorTypeUnfixed

Methods inherited from interface coins.sym.Sym0

charConst, definedType, defineElem, defineLabel, defineParam, defineSubp, defineVar, enumType, floatConst, getDefinedFile, getDefinedIn, getFlag, getName, getNextSym, getRecordedIn, getSymKind, getSymType, getUniqueName, intConst, isGlobal, namedConst, pointerType, setFlag, stringConst, structType, subpType, unionType, vectorType, vectorTypeUnfixed

Constructor Detail

ElemImpl

public ElemImpl(SymRoot pSymRoot)

ElemImpl

public ElemImpl(SymRoot pSymRoot,
                java.lang.String pElemName,
                Sym pDefinedIn)

ElemImpl

public ElemImpl(SymRoot pSymRoot,
                java.lang.String pElemName,
                Sym pDefinedIn,
                Exp pDispExp)

Method Detail

isDispEvaluable

public boolean isDispEvaluable()

isDispEvaluable Get the displacement of elements. "this" should be an element of struct/union type symbol.

Specified by:

isDispEvaluable in interface Elem

Returns:

true if the displacement of this element is evaluable as integer value, false otherwise.

evaluateDisp

public long evaluateDisp()

evaluateDisp "this" should be an element of struct/union type symbol.

Specified by:

evaluateDisp in interface Elem

Returns:

integer value representing the displacement

setDispExp

public void setDispExp(Exp pDispExp)

Description copied from interface: Elem

setDispExp Set the displacement of this element.

Specified by:

setDispExp in interface Elem

Parameters:

pDispExp - Expression representing the displacement of this element in byte.

setDisplacement

public void setDisplacement(long pDisplacement)

Specified by:

setDisplacement in interface Elem

setBitFieldSize

public void setBitFieldSize(int pBitSize)

Description copied from interface: Elem

 Set the size of bit field and set an indication showing
 that this element is a bit field.
 The size of bit field should not exceed the bit width
 of long (typeLong.getSizeValue()*8).
 See also setBitFieldOffset method.

Specified by:

setBitFieldSize in interface Elem

Parameters:

pBitSize - number of bits in this bit field.

setBitFieldOffset

public void setBitFieldOffset(int pBitOffset)

Description copied from interface: Elem

setBitFieldOffset

  Set bit field offset of this element if it is a bit field.
  Consider bit offset and bit field length of a bit field are
  represented by bitOffset and bitFieldSize each respectively.
  In the case of machineParam.isPackedFromLeft() is true,
  the most significant bit of the 1st field is placed at
  the most significant bit of "containing object" (which is
  explained later), and the bit field is placed at bit positions
     bitOffset through (bitOffset + bitFieldSize - 1)
  in the containing object, where the most significant bit position
  of the containing object is zero and the least significant bit
  position is (bit width of containing object -1).
  In the case of machineParam.isPackedFromLeft() is false, that is,
  machineParam.isPackedFromRight() is true,
  the least significant bit of the 1st field is placed at
  the least significant bit of containing object, and
  the bit field is placed at bit positions
     bitOffset through (bitOffset + bitFieldSize - 1)
  in the containing object, where the least significant bit position
  of the containing object is zero and the most significant bit
  position is (bit width of containing object -1).
  In both cases, displacement of the containing object within the
  surrounding structure is shown by evaluateDisp().
  Source language analyzer is not requested to set bit field offset
  but requested to set only the size of bit fields by
  setBitFieldSize method because the bit offset computation is
  usually done by finishStructType() of StructType.
  "containing object" mentioned in the previous paragraph is a
  hypothetical object that contains bit fields. The alignment/size
  of the containing object is considered to be the alignment/size
  of the largest bit field type among the consecutive
  bit fields (all of which have type int or unsigned int in C).
  When a bit field is encountered in structure declaration and
  the total size of preceding elements is lSize, then
  the displacement of the containing object is computed as
      (lSize / lElemTypeSize) * lElemTypeSize
  where lElemTypeSize is the size of the largest bit field type
  among the consecutive bit fields.
  If the containing object has space to hold the bit field,
  then the bit field is placed in the containing object.
  When there remains no space to hold new bit field after
  successive allocation of preceding bit fields, a new
  containing object is placed adjacent to the old one
  and remaining bit fields are placed in the new containing
  object.
  A bit field is contained in one containing object and does not
  span to multiple containing objects. Multiple bit fields may be
  contained in one containing object if the containing object can
  contain them and bit fields continues successively.
  The structure is supposed to have the alignment greater or equal
  to the alignment of the containing object and its size is the
  multiple of the size of the containing object.
  Consider a C language structure
     struct st1 {
       short s1;
       char  c1;
       unsigned int b1:5;
       unsigned int b2:1;
       unsigned int b3:3;
       char c2;
     };
  on machine having 2 as short size, 4 as int size. Displacements
  and bit offsets in this case will be as follows:
     element displacement  bit offset
       s1      0            -
       c1      2            -
       b1      0           24
       b2      0           29
       b3      4            0
       c2      5            -
  and the structure will have alignment 4 and size 8.
  As for C program
    struct bitField1 {
    unsigned a1:1;
    unsigned b1:1;
  };
  struct bitField2 {
    struct bitField1 st1;
    unsigned char cc1;
    struct bitField1 st2;
   unsigned char cc2;
  };
 Displacements and bit offsets in this case will be as follows:
     element displacement  bit offset
     st1.a1    0            0
     st1.b1    0            1
     cc1       4            -
     st2.a1    8            0
     st2.b1    8            1
     cc2      12            -
  and the structure will have alignment 4 and size 16.

  A bit field can be loaded to register by loading the corresponding
  containing object whose displacement can be get be evaluateDisp().
  Access methods of a bit field shows
    evaluateDisp(): displacement of the containing object containing
                    the bit field.
    getBitSize():   the number of bits in the bit field.
    getBitOffset(): bit offset position in the containing object
                    (its meaning differs according to the value of
                     isPackedFromLeft() as mentioned before).


Specified by:
setBitFieldOffset in interface Elem


Parameters:
pBitOffset - bit offset of the bit field as explained above.

setBitField

public void setBitField(int pBitSize,
                        int pBitOffset)

getBitSize

public int getBitSize()

Description copied from interface: Elem

getBitSize See also setBitFieldOffset method.

Specified by:

getBitSize in interface Elem

Returns:

the number of bits in this field.

getBitOffset

public int getBitOffset()

Description copied from interface: Elem

getBitOffset See also setBitFieldOffset method.

Specified by:

getBitOffset in interface Elem

Returns:

the bit offset of this field.

isBitField

public boolean isBitField()

Description copied from interface: Elem

isBitField

Specified by:

isBitField in interface Elem

Returns:

true if this is a bit field, false otherwise.

searchElem

public Elem searchElem(Var pVar)

Description copied from interface: Elem

searchElem Get the proper element having the same name as this symbol in the struct/union variable pVar. "this" is a symbol having the same name as the element to be searched.

Specified by:

searchElem in interface Elem

Parameters:

pVar - sturcture or union variable.

Returns:

the proper element defined in pDefinedIn. This is used in such case as to distinguish proper element when same element name is used in different structures.

searchElem

public Elem searchElem(Type pRecordedIn)

Description copied from interface: Elem

searchElem Get the proper element having the same name as this symbol in pRecordedIn construct (structure or union). "this" is a symbol having the same name as the element to be searched.

Specified by:

searchElem in interface Elem

Parameters:

pRecordedIn - enclosing construct defining the element to be searched (sturcture type or union type in C).

Returns:

the proper element defined in pRecordedIn. If not found, return null. This is used in such case as to distinguish proper element when same element name is used in different structures.

getUpperType

public Type getUpperType()

Description copied from interface: Elem

getUpperType

Specified by:

getUpperType in interface Elem

Returns:

StructType or UnionType instance containing this element.

toString

public java.lang.String toString()

Description copied from interface: HasStringObject

Get the string image of object.

Specified by:

toString in interface HasStringObject

Overrides:

toString in class SymImpl