/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 *

 */

package sun.jvm.hotspot.oops;

import java.io.*;

import java.util.*;

import sun.jvm.hotspot.debugger.*;

import sun.jvm.hotspot.memory.*;

import sun.jvm.hotspot.runtime.*;

import sun.jvm.hotspot.types.*;

import sun.jvm.hotspot.utilities.*;

// An InstanceKlass is the VM level representation of a Java class.

public class InstanceKlass extends Klass {

  static {

    VM.registerVMInitializedObserver(new Observer() {

        public void update(Observable o, Object data) {

          initialize(VM.getVM().getTypeDataBase());

        }

      });

  }

  // field offset constants

  private static int ACCESS_FLAGS_OFFSET;

  private static int NAME_INDEX_OFFSET;

  private static int SIGNATURE_INDEX_OFFSET;

  private static int INITVAL_INDEX_OFFSET;

  private static int LOW_OFFSET;

  private static int HIGH_OFFSET;

  private static int GENERIC_SIGNATURE_INDEX_OFFSET;

  private static int FIELD_SLOTS;

  // ClassState constants

  private static int CLASS_STATE_UNPARSABLE_BY_GC;

  private static int CLASS_STATE_ALLOCATED;

  private static int CLASS_STATE_LOADED;

  private static int CLASS_STATE_LINKED;

  private static int CLASS_STATE_BEING_INITIALIZED;

  private static int CLASS_STATE_FULLY_INITIALIZED;

  private static int CLASS_STATE_INITIALIZATION_ERROR;

  private static synchronized void initialize(TypeDataBase db) throws WrongTypeException {

    Type type            = db.lookupType("instanceKlass");

    arrayKlasses         = new OopField(type.getOopField("_array_klasses"), Oop.getHeaderSize());

    methods              = new OopField(type.getOopField("_methods"), Oop.getHeaderSize());

    methodOrdering       = new OopField(type.getOopField("_method_ordering"), Oop.getHeaderSize());

    localInterfaces      = new OopField(type.getOopField("_local_interfaces"), Oop.getHeaderSize());

    transitiveInterfaces = new OopField(type.getOopField("_transitive_interfaces"), Oop.getHeaderSize());

    fields               = new OopField(type.getOopField("_fields"), Oop.getHeaderSize());

    javaFieldsCount      = new CIntField(type.getCIntegerField("_java_fields_count"), Oop.getHeaderSize());

    constants            = new OopField(type.getOopField("_constants"), Oop.getHeaderSize());

    classLoader          = new OopField(type.getOopField("_class_loader"), Oop.getHeaderSize());

    protectionDomain     = new OopField(type.getOopField("_protection_domain"), Oop.getHeaderSize());

    signers              = new OopField(type.getOopField("_signers"), Oop.getHeaderSize());

    sourceFileName       = type.getAddressField("_source_file_name");

    sourceDebugExtension = type.getAddressField("_source_debug_extension");

    innerClasses         = new OopField(type.getOopField("_inner_classes"), Oop.getHeaderSize());

    nonstaticFieldSize   = new CIntField(type.getCIntegerField("_nonstatic_field_size"), Oop.getHeaderSize());

    staticFieldSize      = new CIntField(type.getCIntegerField("_static_field_size"), Oop.getHeaderSize());

    staticOopFieldCount   = new CIntField(type.getCIntegerField("_static_oop_field_count"), Oop.getHeaderSize());

    nonstaticOopMapSize  = new CIntField(type.getCIntegerField("_nonstatic_oop_map_size"), Oop.getHeaderSize());

    isMarkedDependent    = new CIntField(type.getCIntegerField("_is_marked_dependent"), Oop.getHeaderSize());

    initState            = new CIntField(type.getCIntegerField("_init_state"), Oop.getHeaderSize());

    vtableLen            = new CIntField(type.getCIntegerField("_vtable_len"), Oop.getHeaderSize());

    itableLen            = new CIntField(type.getCIntegerField("_itable_len"), Oop.getHeaderSize());

    breakpoints          = type.getAddressField("_breakpoints");

    genericSignature     = type.getAddressField("_generic_signature");

    majorVersion         = new CIntField(type.getCIntegerField("_major_version"), Oop.getHeaderSize());

    minorVersion         = new CIntField(type.getCIntegerField("_minor_version"), Oop.getHeaderSize());

    headerSize           = alignObjectOffset(Oop.getHeaderSize() + type.getSize());

    // read field offset constants

    ACCESS_FLAGS_OFFSET            = db.lookupIntConstant("FieldInfo::access_flags_offset").intValue();

    NAME_INDEX_OFFSET              = db.lookupIntConstant("FieldInfo::name_index_offset").intValue();

    SIGNATURE_INDEX_OFFSET         = db.lookupIntConstant("FieldInfo::signature_index_offset").intValue();

    INITVAL_INDEX_OFFSET           = db.lookupIntConstant("FieldInfo::initval_index_offset").intValue();

    LOW_OFFSET                     = db.lookupIntConstant("FieldInfo::low_offset").intValue();

    HIGH_OFFSET                    = db.lookupIntConstant("FieldInfo::high_offset").intValue();

    GENERIC_SIGNATURE_INDEX_OFFSET = db.lookupIntConstant("FieldInfo::generic_signature_offset").intValue();

    FIELD_SLOTS                    = db.lookupIntConstant("FieldInfo::field_slots").intValue();

    // read ClassState constants

    CLASS_STATE_UNPARSABLE_BY_GC = db.lookupIntConstant("instanceKlass::unparsable_by_gc").intValue();

    CLASS_STATE_ALLOCATED = db.lookupIntConstant("instanceKlass::allocated").intValue();

    CLASS_STATE_LOADED = db.lookupIntConstant("instanceKlass::loaded").intValue();

    CLASS_STATE_LINKED = db.lookupIntConstant("instanceKlass::linked").intValue();

    CLASS_STATE_BEING_INITIALIZED = db.lookupIntConstant("instanceKlass::being_initialized").intValue();

    CLASS_STATE_FULLY_INITIALIZED = db.lookupIntConstant("instanceKlass::fully_initialized").intValue();

    CLASS_STATE_INITIALIZATION_ERROR = db.lookupIntConstant("instanceKlass::initialization_error").intValue();

  }

  InstanceKlass(OopHandle handle, ObjectHeap heap) {

    super(handle, heap);

    if (getJavaFieldsCount() != getAllFieldsCount()) {

      // Exercise the injected field logic

      for (int i = getJavaFieldsCount(); i < getAllFieldsCount(); i++) {

        getFieldName(i);

        getFieldSignature(i);

      }

    }

  }

  private static OopField  arrayKlasses;

  private static OopField  methods;

  private static OopField  methodOrdering;

  private static OopField  localInterfaces;

  private static OopField  transitiveInterfaces;

  private static OopField  fields;

  private static CIntField javaFieldsCount;

  private static OopField  constants;

  private static OopField  classLoader;

  private static OopField  protectionDomain;

  private static OopField  signers;

  private static AddressField  sourceFileName;

  private static AddressField  sourceDebugExtension;

  private static OopField  innerClasses;

  private static CIntField nonstaticFieldSize;

  private static CIntField staticFieldSize;

  private static CIntField staticOopFieldCount;

  private static CIntField nonstaticOopMapSize;

  private static CIntField isMarkedDependent;

  private static CIntField initState;

  private static CIntField vtableLen;

  private static CIntField itableLen;

  private static AddressField breakpoints;

  private static AddressField  genericSignature;

  private static CIntField majorVersion;

  private static CIntField minorVersion;

  // type safe enum for ClassState from instanceKlass.hpp

  public static class ClassState {

     public static final ClassState UNPARSABLE_BY_GC = new ClassState("unparsable_by_gc");

     public static final ClassState ALLOCATED    = new ClassState("allocated");

     public static final ClassState LOADED       = new ClassState("loaded");

     public static final ClassState LINKED       = new ClassState("linked");

     public static final ClassState BEING_INITIALIZED      = new ClassState("beingInitialized");

     public static final ClassState FULLY_INITIALIZED    = new ClassState("fullyInitialized");

     public static final ClassState INITIALIZATION_ERROR = new ClassState("initializationError");

     private ClassState(String value) {

        this.value = value;

     }

     public String toString() {

        return value;

     }

     private String value;

  }

  public int  getInitStateAsInt() { return (int) initState.getValue(this); }

  public ClassState getInitState() {

     int state = getInitStateAsInt();

     if (state == CLASS_STATE_UNPARSABLE_BY_GC) {

        return ClassState.UNPARSABLE_BY_GC;

     } else if (state == CLASS_STATE_ALLOCATED) {

        return ClassState.ALLOCATED;

     } else if (state == CLASS_STATE_LOADED) {

        return ClassState.LOADED;

     } else if (state == CLASS_STATE_LINKED) {

        return ClassState.LINKED;

     } else if (state == CLASS_STATE_BEING_INITIALIZED) {

        return ClassState.BEING_INITIALIZED;

     } else if (state == CLASS_STATE_FULLY_INITIALIZED) {

        return ClassState.FULLY_INITIALIZED;

     } else if (state == CLASS_STATE_INITIALIZATION_ERROR) {

        return ClassState.INITIALIZATION_ERROR;

     } else {

        throw new RuntimeException("should not reach here");

     }

  }

  // initialization state quaries

  public boolean isLoaded() {

     return getInitStateAsInt() >= CLASS_STATE_LOADED;

  }

  public boolean isLinked() {

     return getInitStateAsInt() >= CLASS_STATE_LINKED;

  }

  public boolean isInitialized() {

     return getInitStateAsInt() == CLASS_STATE_FULLY_INITIALIZED;

  }

  public boolean isNotInitialized() {

     return getInitStateAsInt() < CLASS_STATE_BEING_INITIALIZED;

  }

  public boolean isBeingInitialized() {

     return getInitStateAsInt() == CLASS_STATE_BEING_INITIALIZED;

  }

  public boolean isInErrorState() {

     return getInitStateAsInt() == CLASS_STATE_INITIALIZATION_ERROR;

  }

  public int getClassStatus() {

     int result = 0;

     if (isLinked()) {

        result |= JVMDIClassStatus.VERIFIED | JVMDIClassStatus.PREPARED;

     }

     if (isInitialized()) {

        if (Assert.ASSERTS_ENABLED) {

           Assert.that(isLinked(), "Class status is not consistent");

        }

        result |= JVMDIClassStatus.INITIALIZED;

     }

     if (isInErrorState()) {

        result |= JVMDIClassStatus.ERROR;

     }

     return result;

  }

  // Byteside of the header

  private static long headerSize;

  public long getObjectSize(Oop object) {

    return getSizeHelper() * VM.getVM().getAddressSize();

  }

  public static long getHeaderSize() { return headerSize; }

  public short getFieldAccessFlags(int index) {

    return getFields().getShortAt(index * FIELD_SLOTS + ACCESS_FLAGS_OFFSET);

  }

  public short getFieldNameIndex(int index) {

    if (index >= getJavaFieldsCount()) throw new IndexOutOfBoundsException("not a Java field;");

    return getFields().getShortAt(index * FIELD_SLOTS + NAME_INDEX_OFFSET);

  }

  public Symbol getFieldName(int index) {

    int nameIndex = getFields().getShortAt(index * FIELD_SLOTS + NAME_INDEX_OFFSET);

    if (index < getJavaFieldsCount()) {

      return getConstants().getSymbolAt(nameIndex);

    } else {

      return vmSymbols.symbolAt(nameIndex);

    }

  }

  public short getFieldSignatureIndex(int index) {

    if (index >= getJavaFieldsCount()) throw new IndexOutOfBoundsException("not a Java field;");

    return getFields().getShortAt(index * FIELD_SLOTS + SIGNATURE_INDEX_OFFSET);

  }

  public Symbol getFieldSignature(int index) {

    int signatureIndex = getFields().getShortAt(index * FIELD_SLOTS + SIGNATURE_INDEX_OFFSET);

    if (index < getJavaFieldsCount()) {

      return getConstants().getSymbolAt(signatureIndex);

    } else {

      return vmSymbols.symbolAt(signatureIndex);

    }

  }

  public short getFieldGenericSignatureIndex(int index) {

    return getFields().getShortAt(index * FIELD_SLOTS + GENERIC_SIGNATURE_INDEX_OFFSET);

  }

  public Symbol getFieldGenericSignature(int index) {

    short genericSignatureIndex = getFieldGenericSignatureIndex(index);

    if (genericSignatureIndex != 0)  {

      return getConstants().getSymbolAt(genericSignatureIndex);

    }

    return null;

  }

  public short getFieldInitialValueIndex(int index) {

    if (index >= getJavaFieldsCount()) throw new IndexOutOfBoundsException("not a Java field;");

    return getFields().getShortAt(index * FIELD_SLOTS + INITVAL_INDEX_OFFSET);

  }

  public int getFieldOffset(int index) {

    TypeArray fields = getFields();

    return VM.getVM().buildIntFromShorts(fields.getShortAt(index * FIELD_SLOTS + LOW_OFFSET),

                                         fields.getShortAt(index * FIELD_SLOTS + HIGH_OFFSET));

  }

  // Accessors for declared fields

  public Klass     getArrayKlasses()        { return (Klass)        arrayKlasses.getValue(this); }

  public ObjArray  getMethods()             { return (ObjArray)     methods.getValue(this); }

  public TypeArray getMethodOrdering()      { return (TypeArray)    methodOrdering.getValue(this); }

  public ObjArray  getLocalInterfaces()     { return (ObjArray)     localInterfaces.getValue(this); }

  public ObjArray  getTransitiveInterfaces() { return (ObjArray)     transitiveInterfaces.getValue(this); }

  public TypeArray getFields()              { return (TypeArray)    fields.getValue(this); }

  public int       getJavaFieldsCount()     { return                (int) javaFieldsCount.getValue(this); }

  public int       getAllFieldsCount()      { return                (int)getFields().getLength() / FIELD_SLOTS; }

  public ConstantPool getConstants()        { return (ConstantPool) constants.getValue(this); }

  public Oop       getClassLoader()         { return                classLoader.getValue(this); }

  public Oop       getProtectionDomain()    { return                protectionDomain.getValue(this); }

  public ObjArray  getSigners()             { return (ObjArray)     signers.getValue(this); }

  public Symbol    getSourceFileName()      { return getSymbol(sourceFileName); }

  public Symbol    getSourceDebugExtension(){ return getSymbol(sourceDebugExtension); }

  public TypeArray getInnerClasses()        { return (TypeArray)    innerClasses.getValue(this); }

  public long      getNonstaticFieldSize()  { return                nonstaticFieldSize.getValue(this); }

  public long      getStaticOopFieldCount() { return                staticOopFieldCount.getValue(this); }

  public long      getNonstaticOopMapSize() { return                nonstaticOopMapSize.getValue(this); }

  public boolean   getIsMarkedDependent()   { return                isMarkedDependent.getValue(this) != 0; }

  public long      getVtableLen()           { return                vtableLen.getValue(this); }

  public long      getItableLen()           { return                itableLen.getValue(this); }

  public Symbol    getGenericSignature()    { return getSymbol(genericSignature); }

  public long      majorVersion()           { return                majorVersion.getValue(this); }

  public long      minorVersion()           { return                minorVersion.getValue(this); }

  // "size helper" == instance size in words

  public long getSizeHelper() {

    int lh = getLayoutHelper();

    if (Assert.ASSERTS_ENABLED) {

      Assert.that(lh > 0, "layout helper initialized for instance class");

    }

    return lh / VM.getVM().getAddressSize();

  }

  // same as enum InnerClassAttributeOffset in VM code.

  public static interface InnerClassAttributeOffset {

    // from JVM spec. "InnerClasses" attribute

    public static final int innerClassInnerClassInfoOffset = 0;

    public static final int innerClassOuterClassInfoOffset = 1;

    public static final int innerClassInnerNameOffset = 2;

    public static final int innerClassAccessFlagsOffset = 3;

    public static final int innerClassNextOffset = 4;

  };

  public static interface EnclosingMethodAttributeOffset {

    public static final int enclosing_method_class_index_offset = 0;

    public static final int enclosing_method_method_index_offset = 1;

    public static final int enclosing_method_attribute_size = 2;

  };

  // refer to compute_modifier_flags in VM code.

  public long computeModifierFlags() {

    long access = getAccessFlags();

    // But check if it happens to be member class.

    TypeArray innerClassList = getInnerClasses();

    int length = ( innerClassList == null)? 0 : (int) innerClassList.getLength();

    if (length > 0) {

       if (Assert.ASSERTS_ENABLED) {

          Assert.that(length % InnerClassAttributeOffset.innerClassNextOffset == 0 ||

                      length % InnerClassAttributeOffset.innerClassNextOffset == EnclosingMethodAttributeOffset.enclosing_method_attribute_size,

                      "just checking");

       }

       for (int i = 0; i < length; i += InnerClassAttributeOffset.innerClassNextOffset) {

          if (i == length - EnclosingMethodAttributeOffset.enclosing_method_attribute_size) {

              break;

          }

          int ioff = innerClassList.getShortAt(i +

                         InnerClassAttributeOffset.innerClassInnerClassInfoOffset);

          // 'ioff' can be zero.

          // refer to JVM spec. section 4.7.5.

          if (ioff != 0) {

             // only look at classes that are already loaded

             // since we are looking for the flags for our self.

             ConstantPool.CPSlot classInfo = getConstants().getSlotAt(ioff);

             Symbol name = null;

             if (classInfo.isOop()) {

               name = ((Klass) classInfo.getOop()).getName();

             } else if (classInfo.isMetaData()) {

               name = classInfo.getSymbol();

             } else {

                throw new RuntimeException("should not reach here");

             }

             if (name.equals(getName())) {

                // This is really a member class

                access = innerClassList.getShortAt(i +

                        InnerClassAttributeOffset.innerClassAccessFlagsOffset);

                break;

             }

          }

       } // for inner classes

    }

    // Remember to strip ACC_SUPER bit

    return (access & (~JVM_ACC_SUPER)) & JVM_ACC_WRITTEN_FLAGS;

  }

  // whether given Symbol is name of an inner/nested Klass of this Klass?

  // anonymous and local classes are excluded.

  public boolean isInnerClassName(Symbol sym) {

    return isInInnerClasses(sym, false);

  }

  // whether given Symbol is name of an inner/nested Klass of this Klass?

  // anonymous classes excluded, but local classes are included.

  public boolean isInnerOrLocalClassName(Symbol sym) {

    return isInInnerClasses(sym, true);

  }

  private boolean isInInnerClasses(Symbol sym, boolean includeLocals) {

    TypeArray innerClassList = getInnerClasses();

    int length = ( innerClassList == null)? 0 : (int) innerClassList.getLength();

    if (length > 0) {

       if (Assert.ASSERTS_ENABLED) {

         Assert.that(length % InnerClassAttributeOffset.innerClassNextOffset == 0 ||

                     length % InnerClassAttributeOffset.innerClassNextOffset == EnclosingMethodAttributeOffset.enclosing_method_attribute_size,

                     "just checking");

       }

       for (int i = 0; i < length; i += InnerClassAttributeOffset.innerClassNextOffset) {

         if (i == length - EnclosingMethodAttributeOffset.enclosing_method_attribute_size) {

             break;

         }

         int ioff = innerClassList.getShortAt(i +

                        InnerClassAttributeOffset.innerClassInnerClassInfoOffset);

         // 'ioff' can be zero.

         // refer to JVM spec. section 4.7.5.

         if (ioff != 0) {

            ConstantPool.CPSlot iclassInfo = getConstants().getSlotAt(ioff);

            Symbol innerName = null;

            if (iclassInfo.isOop()) {

              innerName = ((Klass) iclassInfo.getOop()).getName();

            } else if (iclassInfo.isMetaData()) {

              innerName = iclassInfo.getSymbol();

            } else {

               throw new RuntimeException("should not reach here");

            }

            Symbol myname = getName();

            int ooff = innerClassList.getShortAt(i +

                        InnerClassAttributeOffset.innerClassOuterClassInfoOffset);

            // for anonymous classes inner_name_index of InnerClasses

            // attribute is zero.

            int innerNameIndex = innerClassList.getShortAt(i +

                        InnerClassAttributeOffset.innerClassInnerNameOffset);

            // if this is not a member (anonymous, local etc.), 'ooff' will be zero

            // refer to JVM spec. section 4.7.5.

            if (ooff == 0) {

               if (includeLocals) {

                  // does it looks like my local class?

                  if (innerName.equals(sym) &&

                     innerName.asString().startsWith(myname.asString())) {

                     // exclude anonymous classes.

                     return (innerNameIndex != 0);

                  }

               }

            } else {

               ConstantPool.CPSlot oclassInfo = getConstants().getSlotAt(ooff);

               Symbol outerName = null;

               if (oclassInfo.isOop()) {

                 outerName = ((Klass) oclassInfo.getOop()).getName();

               } else if (oclassInfo.isMetaData()) {

                 outerName = oclassInfo.getSymbol();

               } else {

                  throw new RuntimeException("should not reach here");

               }

               // include only if current class is outer class.

               if (outerName.equals(myname) && innerName.equals(sym)) {

                  return true;

               }

           }

         }

       } // for inner classes

       return false;

    } else {

       return false;

    }

  }

  public boolean implementsInterface(Klass k) {

    if (Assert.ASSERTS_ENABLED) {

      Assert.that(k.isInterface(), "should not reach here");

    }

    ObjArray interfaces =  getTransitiveInterfaces();

    final int len = (int) interfaces.getLength();

    for (int i = 0; i < len; i++) {

      if (interfaces.getObjAt(i).equals(k)) return true;

    }

    return false;

  }

  boolean computeSubtypeOf(Klass k) {

    if (k.isInterface()) {

      return implementsInterface(k);

    } else {

      return super.computeSubtypeOf(k);

    }

  }

  public void printValueOn(PrintStream tty) {

    tty.print("InstanceKlass for " + getName().asString());

  }

  public void iterateFields(OopVisitor visitor, boolean doVMFields) {

    super.iterateFields(visitor, doVMFields);

    if (doVMFields) {

      visitor.doOop(arrayKlasses, true);

      visitor.doOop(methods, true);

      visitor.doOop(methodOrdering, true);