never@3137: /*
coleenp@4037:  * Copyright (c) 2011, 2012, Oracle and/or its affiliates. All rights reserved.
never@3137:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
never@3137:  *
never@3137:  * This code is free software; you can redistribute it and/or modify it
never@3137:  * under the terms of the GNU General Public License version 2 only, as
never@3137:  * published by the Free Software Foundation.
never@3137:  *
never@3137:  * This code is distributed in the hope that it will be useful, but WITHOUT
never@3137:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
never@3137:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
never@3137:  * version 2 for more details (a copy is included in the LICENSE file that
never@3137:  * accompanied this code).
never@3137:  *
never@3137:  * You should have received a copy of the GNU General Public License version
never@3137:  * 2 along with this work; if not, write to the Free Software Foundation,
never@3137:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
never@3137:  *
never@3137:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
never@3137:  * or visit www.oracle.com if you need additional information or have any
never@3137:  * questions.
never@3137:  *
never@3137:  */
never@3137: 
never@3137: #ifndef SHARE_VM_OOPS_FIELDSTREAMS_HPP
never@3137: #define SHARE_VM_OOPS_FIELDSTREAMS_HPP
never@3137: 
never@3137: #include "oops/instanceKlass.hpp"
never@3137: #include "oops/fieldInfo.hpp"
never@3137: 
never@3137: // The is the base class for iteration over the fields array
never@3137: // describing the declared fields in the class.  Several subclasses
never@3137: // are provided depending on the kind of iteration required.  The
never@3137: // JavaFieldStream is for iterating over regular Java fields and it
never@3137: // generally the preferred iterator.  InternalFieldStream only
never@3137: // iterates over fields that have been injected by the JVM.
never@3137: // AllFieldStream exposes all fields and should only be used in rare
never@3137: // cases.
never@3137: class FieldStreamBase : public StackObj {
never@3137:  protected:
coleenp@4037:   Array<u2>*          _fields;
never@3137:   constantPoolHandle  _constants;
never@3137:   int                 _index;
never@3137:   int                 _limit;
jiangli@3803:   int                 _generic_signature_slot;
never@3137: 
coleenp@4037:   FieldInfo* field() const { return FieldInfo::from_field_array(_fields, _index); }
never@3137: 
jiangli@3803:   int init_generic_signature_start_slot() {
jiangli@3803:     int length = _fields->length();
jiangli@3803:     int num_fields = 0;
jiangli@3803:     int skipped_generic_signature_slots = 0;
jiangli@3803:     FieldInfo* fi;
jiangli@3803:     AccessFlags flags;
jiangli@3803:     /* Scan from 0 to the current _index. Count the number of generic
jiangli@3803:        signature slots for field[0] to field[_index - 1]. */
jiangli@3803:     for (int i = 0; i < _index; i++) {
coleenp@4037:       fi = FieldInfo::from_field_array(_fields, i);
jiangli@3803:       flags.set_flags(fi->access_flags());
jiangli@3803:       if (flags.field_has_generic_signature()) {
jiangli@3803:         length --;
jiangli@3803:         skipped_generic_signature_slots ++;
jiangli@3803:       }
jiangli@3803:     }
jiangli@3803:     /* Scan from the current _index. */
jiangli@3803:     for (int i = _index; i*FieldInfo::field_slots < length; i++) {
coleenp@4037:       fi = FieldInfo::from_field_array(_fields, i);
jiangli@3803:       flags.set_flags(fi->access_flags());
jiangli@3803:       if (flags.field_has_generic_signature()) {
jiangli@3803:         length --;
jiangli@3803:       }
jiangli@3803:       num_fields ++;
jiangli@3803:     }
jiangli@3803:     _generic_signature_slot = length + skipped_generic_signature_slots;
jiangli@3803:     assert(_generic_signature_slot <= _fields->length(), "");
jiangli@3803:     return num_fields;
jiangli@3803:   }
jiangli@3803: 
coleenp@4037:   FieldStreamBase(Array<u2>* fields, constantPoolHandle constants, int start, int limit) {
never@3137:     _fields = fields;
never@3137:     _constants = constants;
never@3137:     _index = start;
jiangli@3803:     int num_fields = init_generic_signature_start_slot();
jiangli@3803:     if (limit < start) {
jiangli@3803:       _limit = num_fields;
jiangli@3803:     } else {
jiangli@3803:       _limit = limit;
jiangli@3803:     }
never@3137:   }
never@3137: 
coleenp@4037:   FieldStreamBase(Array<u2>* fields, constantPoolHandle constants) {
never@3137:     _fields = fields;
never@3137:     _constants = constants;
never@3137:     _index = 0;
jiangli@3803:     _limit = init_generic_signature_start_slot();
never@3137:   }
never@3137: 
never@3137:  public:
coleenp@4037:   FieldStreamBase(InstanceKlass* klass) {
never@3137:     _fields = klass->fields();
never@3137:     _constants = klass->constants();
never@3137:     _index = 0;
never@3137:     _limit = klass->java_fields_count();
jiangli@3803:     init_generic_signature_start_slot();
never@3137:   }
never@3137:   FieldStreamBase(instanceKlassHandle klass) {
never@3137:     _fields = klass->fields();
never@3137:     _constants = klass->constants();
never@3137:     _index = 0;
never@3137:     _limit = klass->java_fields_count();
jiangli@3803:     init_generic_signature_start_slot();
never@3137:   }
never@3137: 
never@3137:   // accessors
never@3137:   int index() const                 { return _index; }
never@3137: 
jiangli@3803:   void next() {
jiangli@3803:     if (access_flags().field_has_generic_signature()) {
jiangli@3803:       _generic_signature_slot ++;
jiangli@3803:       assert(_generic_signature_slot <= _fields->length(), "");
jiangli@3803:     }
jiangli@3803:     _index += 1;
jiangli@3803:   }
never@3137:   bool done() const { return _index >= _limit; }
never@3137: 
never@3137:   // Accessors for current field
never@3137:   AccessFlags access_flags() const {
never@3137:     AccessFlags flags;
never@3137:     flags.set_flags(field()->access_flags());
never@3137:     return flags;
never@3137:   }
never@3137: 
never@3137:   void set_access_flags(u2 flags) const {
never@3137:     field()->set_access_flags(flags);
never@3137:   }
never@3137: 
never@3137:   void set_access_flags(AccessFlags flags) const {
never@3137:     set_access_flags(flags.as_short());
never@3137:   }
never@3137: 
never@3137:   Symbol* name() const {
never@3137:     return field()->name(_constants);
never@3137:   }
never@3137: 
never@3137:   Symbol* signature() const {
never@3137:     return field()->signature(_constants);
never@3137:   }
never@3137: 
never@3137:   Symbol* generic_signature() const {
jiangli@3803:     if (access_flags().field_has_generic_signature()) {
jiangli@3803:       assert(_generic_signature_slot < _fields->length(), "out of bounds");
coleenp@4037:       int index = _fields->at(_generic_signature_slot);
jiangli@3803:       return _constants->symbol_at(index);
jiangli@3803:     } else {
jiangli@3803:       return NULL;
jiangli@3803:     }
never@3137:   }
never@3137: 
never@3137:   int offset() const {
never@3137:     return field()->offset();
never@3137:   }
never@3137: 
jwilhelm@4430:   int allocation_type() const {
jwilhelm@4430:     return field()->allocation_type();
jwilhelm@4430:   }
jwilhelm@4430: 
never@3137:   void set_offset(int offset) {
never@3137:     field()->set_offset(offset);
never@3137:   }
jwilhelm@4430: 
jwilhelm@4430:   bool is_offset_set() const {
jwilhelm@4430:     return field()->is_offset_set();
jwilhelm@4430:   }
jwilhelm@4430: 
jwilhelm@4430:   bool is_contended() const {
jwilhelm@4430:     return field()->is_contended();
jwilhelm@4430:   }
jwilhelm@4430: 
jwilhelm@4430:   int contended_group() const {
jwilhelm@4430:     return field()->contended_group();
jwilhelm@4430:   }
jwilhelm@4430: 
never@3137: };
never@3137: 
never@3137: // Iterate over only the internal fields
never@3137: class JavaFieldStream : public FieldStreamBase {
never@3137:  public:
never@3137:   JavaFieldStream(instanceKlassHandle k): FieldStreamBase(k->fields(), k->constants(), 0, k->java_fields_count()) {}
never@3137: 
never@3137:   int name_index() const {
never@3137:     assert(!field()->is_internal(), "regular only");
never@3137:     return field()->name_index();
never@3137:   }
never@3137:   void set_name_index(int index) {
never@3137:     assert(!field()->is_internal(), "regular only");
never@3137:     field()->set_name_index(index);
never@3137:   }
never@3137:   int signature_index() const {
never@3137:     assert(!field()->is_internal(), "regular only");
never@3137:     return field()->signature_index();
never@3137:   }
never@3137:   void set_signature_index(int index) {
never@3137:     assert(!field()->is_internal(), "regular only");
never@3137:     field()->set_signature_index(index);
never@3137:   }
never@3137:   int generic_signature_index() const {
never@3137:     assert(!field()->is_internal(), "regular only");
jiangli@3803:     if (access_flags().field_has_generic_signature()) {
jiangli@3803:       assert(_generic_signature_slot < _fields->length(), "out of bounds");
coleenp@4037:       return _fields->at(_generic_signature_slot);
jiangli@3803:     } else {
jiangli@3803:       return 0;
jiangli@3803:     }
never@3137:   }
never@3137:   void set_generic_signature_index(int index) {
never@3137:     assert(!field()->is_internal(), "regular only");
jiangli@3803:     if (access_flags().field_has_generic_signature()) {
jiangli@3803:       assert(_generic_signature_slot < _fields->length(), "out of bounds");
coleenp@4037:       _fields->at_put(_generic_signature_slot, index);
jiangli@3803:     }
never@3137:   }
never@3137:   int initval_index() const {
never@3137:     assert(!field()->is_internal(), "regular only");
never@3137:     return field()->initval_index();
never@3137:   }
never@3137:   void set_initval_index(int index) {
never@3137:     assert(!field()->is_internal(), "regular only");
never@3137:     return field()->set_initval_index(index);
never@3137:   }
never@3137: };
never@3137: 
never@3137: 
never@3137: // Iterate over only the internal fields
never@3137: class InternalFieldStream : public FieldStreamBase {
never@3137:  public:
coleenp@4037:   InternalFieldStream(InstanceKlass* k):      FieldStreamBase(k->fields(), k->constants(), k->java_fields_count(), 0) {}
jiangli@3803:   InternalFieldStream(instanceKlassHandle k): FieldStreamBase(k->fields(), k->constants(), k->java_fields_count(), 0) {}
never@3137: };
never@3137: 
never@3137: 
never@3137: class AllFieldStream : public FieldStreamBase {
never@3137:  public:
coleenp@4037:   AllFieldStream(Array<u2>* fields, constantPoolHandle constants): FieldStreamBase(fields, constants) {}
coleenp@4037:   AllFieldStream(InstanceKlass* k):      FieldStreamBase(k->fields(), k->constants()) {}
never@3137:   AllFieldStream(instanceKlassHandle k): FieldStreamBase(k->fields(), k->constants()) {}
never@3137: };
never@3137: 
never@3137: #endif // SHARE_VM_OOPS_FIELDSTREAMS_HPP