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