1 /*
2 * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 *
23 */
24
25 #ifndef SHARE_VM_RUNTIME_FIELDDESCRIPTOR_HPP
26 #define SHARE_VM_RUNTIME_FIELDDESCRIPTOR_HPP
27
28 #include "oops/constantPool.hpp"
29 #include "oops/symbol.hpp"
30 #include "runtime/fieldType.hpp"
31 #include "utilities/accessFlags.hpp"
32 #include "utilities/constantTag.hpp"
33
34 // A fieldDescriptor describes the attributes of a single field (instance or class variable).
35 // It needs the class constant pool to work (because it only holds indices into the pool
36 // rather than the actual info).
37
38 class fieldDescriptor VALUE_OBJ_CLASS_SPEC {
39 private:
40 AccessFlags _access_flags;
41 int _index; // the field index
42 constantPoolHandle _cp;
43 u2 _putAccessor;
44 u2 _getAccessor;
45 bool _is_accessor;
46 u2 _field_name_from_accessor;
47 FieldInfo* _accessor_info;
48 Symbol* _sig_for_accessor;
49
50
51 // update the access_flags for the field in the klass
52 void update_klass_field_access_flag() {
53 InstanceKlass* ik = field_holder();
54 ik->field(index())->set_access_flags(_access_flags.as_short());
55 }
56
57 FieldInfo* field() const {
58 if (_is_accessor) {
59 return _accessor_info;
60 }else {
61 InstanceKlass* ik = field_holder();
62 return ik->field(_index);
63 }
64 }
65
66 public:
67 fieldDescriptor() {
68 DEBUG_ONLY(_index = badInt);
69 _is_accessor = false;
70 _index = -1;
71 _accessor_info = NULL;
72 }
73 fieldDescriptor(InstanceKlass* ik, int index) {
74 DEBUG_ONLY(_index = badInt);
75 reinitialize(ik, index);
76 }
77
78 void set_sig_for_accessor(Symbol* sig) {
79 this->_sig_for_accessor = sig;
80 }
81
82 void set_field_name_from_accessor(u2 field_name_from_accessor) {
83 this->_field_name_from_accessor = field_name_from_accessor;
84 }
85
86 bool is_accessor() {
87 return _is_accessor;
88 }
89
90 u2 get_get_accessor() {
91 return _getAccessor;
92 }
93
94 u2 get_put_accessor() {
95 return _putAccessor;
96 }
97
98 void set_get_accessor(u2 index) {
99 _getAccessor = index;
100 }
101
102 void set_put_accessor(u2 index) {
103 _putAccessor = index;
104 }
105
106 Symbol* name() const {
107 return _is_accessor ? constants()->symbol_at(_field_name_from_accessor) : field()->name(_cp);
108 }
109 Symbol* signature() const {
110 return _is_accessor ? _sig_for_accessor : field()->signature(_cp);
111 }
112 InstanceKlass* field_holder() const { return _cp->pool_holder(); }
113 ConstantPool* constants() const { return _cp(); }
114 AccessFlags access_flags() const { return _access_flags; }
115 oop loader() const;
116 // Offset (in words) of field from start of instanceOop / Klass*
117 int offset() const { return field()->offset(); }
118 Symbol* generic_signature() const;
119 int index() const { return _index; }
120 AnnotationArray* annotations() const;
121 AnnotationArray* type_annotations() const;
122
123 // Initial field value
124 bool has_initial_value() const { return field()->initval_index() != 0; }
125 int initial_value_index() const { return field()->initval_index(); }
126 constantTag initial_value_tag() const; // The tag will return true on one of is_int(), is_long(), is_single(), is_double()
127 jint int_initial_value() const;
128 jlong long_initial_value() const;
129 jfloat float_initial_value() const;
130 jdouble double_initial_value() const;
131 oop string_initial_value(TRAPS) const;
132
133 // Field signature type
134 BasicType field_type() const { return FieldType::basic_type(signature()); }
135
136 // Access flags
137 bool is_public() const { return access_flags().is_public(); }
138 bool is_private() const { return access_flags().is_private(); }
139 bool is_protected() const { return access_flags().is_protected(); }
140 bool is_package_private() const { return !is_public() && !is_private() && !is_protected(); }
141
142 bool is_static() const { return access_flags().is_static(); }
143 bool is_final() const { return access_flags().is_final(); }
144 bool is_volatile() const { return access_flags().is_volatile(); }
145 bool is_transient() const { return access_flags().is_transient(); }
146
147 bool is_synthetic() const { return access_flags().is_synthetic(); }
148
149 bool is_field_access_watched() const { return access_flags().is_field_access_watched(); }
150 bool is_field_modification_watched() const
151 { return access_flags().is_field_modification_watched(); }
152 bool has_generic_signature() const { return access_flags().field_has_generic_signature(); }
153
154 void set_is_field_access_watched(const bool value) {
155 _access_flags.set_is_field_access_watched(value);
156 update_klass_field_access_flag();
157 }
158
159 void set_is_field_modification_watched(const bool value) {
160 _access_flags.set_is_field_modification_watched(value);
161 update_klass_field_access_flag();
162 }
163
164 // Initialization
165 void reinitialize(InstanceKlass* ik, int index);
166 void reinitialize_accessor(InstanceKlass* ik);
167
168 // Print
169 void print() { print_on(tty); }
170 void print_on(outputStream* st) const PRODUCT_RETURN;
171 void print_on_for(outputStream* st, oop obj) PRODUCT_RETURN;
172 void verify() const PRODUCT_RETURN;
173 };
174
175 #endif // SHARE_VM_RUNTIME_FIELDDESCRIPTOR_HPP