1 /*
2 * Copyright (c) 1997, 2015, 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_UTILITIES_ACCESSFLAGS_HPP
26 #define SHARE_VM_UTILITIES_ACCESSFLAGS_HPP
27
28 #include "prims/jvm.h"
29 #include "utilities/top.hpp"
30
31 // AccessFlags is an abstraction over Java access flags.
32
33
34 enum {
35 // See jvm.h for shared JVM_ACC_XXX access flags
36
37 // HotSpot-specific access flags
38
39 // flags actually put in .class file
40 JVM_ACC_WRITTEN_FLAGS = 0x00007FFF,
41
42 // Method* flags
43 JVM_ACC_MONITOR_MATCH = 0x10000000, // True if we know that monitorenter/monitorexit bytecodes match
44 JVM_ACC_HAS_MONITOR_BYTECODES = 0x20000000, // Method contains monitorenter/monitorexit bytecodes
45 JVM_ACC_HAS_LOOPS = 0x40000000, // Method has loops
46 JVM_ACC_LOOPS_FLAG_INIT = (int)0x80000000,// The loop flag has been initialized
47 JVM_ACC_QUEUED = 0x01000000, // Queued for compilation
48 JVM_ACC_NOT_C2_COMPILABLE = 0x02000000,
49 JVM_ACC_NOT_C1_COMPILABLE = 0x04000000,
50 JVM_ACC_NOT_C2_OSR_COMPILABLE = 0x08000000,
51 JVM_ACC_HAS_LINE_NUMBER_TABLE = 0x00100000,
52 JVM_ACC_HAS_CHECKED_EXCEPTIONS = 0x00400000,
53 JVM_ACC_HAS_JSRS = 0x00800000,
54 JVM_ACC_IS_OLD = 0x00010000, // RedefineClasses() has replaced this method
55 JVM_ACC_IS_OBSOLETE = 0x00020000, // RedefineClasses() has made method obsolete
56 JVM_ACC_IS_PREFIXED_NATIVE = 0x00040000, // JVMTI has prefixed this native method
57 JVM_ACC_ON_STACK = 0x00080000, // RedefineClasses() was used on the stack
58 JVM_ACC_IS_DELETED = 0x00008000, // RedefineClasses() has deleted this method
59
60 // Klass* flags
61 JVM_ACC_HAS_MIRANDA_METHODS = 0x10000000, // True if this class has miranda methods in it's vtable
62 JVM_ACC_HAS_VANILLA_CONSTRUCTOR = 0x20000000, // True if klass has a vanilla default constructor
63 JVM_ACC_HAS_FINALIZER = 0x40000000, // True if klass has a non-empty finalize() method
64 JVM_ACC_IS_CLONEABLE = (int)0x80000000,// True if klass supports the Clonable interface
65 JVM_ACC_HAS_FINAL_METHOD = 0x01000000, // True if klass has final method
66
67 // Klass* and Method* flags
68 JVM_ACC_HAS_LOCAL_VARIABLE_TABLE= 0x00200000,
69
70 JVM_ACC_PROMOTED_FLAGS = 0x00200000, // flags promoted from methods to the holding klass
71
72 // field flags
73 // Note: these flags must be defined in the low order 16 bits because
74 // InstanceKlass only stores a ushort worth of information from the
75 // AccessFlags value.
76 // These bits must not conflict with any other field-related access flags
77 // (e.g., ACC_ENUM).
78 // Note that the class-related ACC_ANNOTATION bit conflicts with these flags.
79 JVM_ACC_FIELD_ACCESS_WATCHED = 0x00002000, // field access is watched by JVMTI
80 JVM_ACC_FIELD_MODIFICATION_WATCHED = 0x00008000, // field modification is watched by JVMTI
81 JVM_ACC_FIELD_INTERNAL = 0x00000400, // internal field, same as JVM_ACC_ABSTRACT
82 JVM_ACC_FIELD_STABLE = 0x00000020, // @Stable field, same as JVM_ACC_SYNCHRONIZED and JVM_ACC_SUPER
83 JVM_ACC_FIELD_INITIALIZED_FINAL_UPDATE = 0x00000100, // (static) final field updated outside (class) initializer, same as JVM_ACC_NATIVE
84 JVM_ACC_FIELD_HAS_GENERIC_SIGNATURE = 0x00000800, // field has generic signature
85
86 JVM_ACC_FIELD_INTERNAL_FLAGS = JVM_ACC_FIELD_ACCESS_WATCHED |
87 JVM_ACC_FIELD_MODIFICATION_WATCHED |
88 JVM_ACC_FIELD_INTERNAL |
89 JVM_ACC_FIELD_STABLE |
90 JVM_ACC_FIELD_HAS_GENERIC_SIGNATURE,
91
92 // flags accepted by set_field_flags()
93 JVM_ACC_FIELD_FLAGS = JVM_RECOGNIZED_FIELD_MODIFIERS | JVM_ACC_FIELD_INTERNAL_FLAGS
94
95 };
96
97
98 class AccessFlags VALUE_OBJ_CLASS_SPEC {
99 friend class VMStructs;
100 private:
101 jint _flags;
102
103 public:
104 // Java access flags
105 bool is_public () const { return (_flags & JVM_ACC_PUBLIC ) != 0; }
106 bool is_private () const { return (_flags & JVM_ACC_PRIVATE ) != 0; }
107 bool is_protected () const { return (_flags & JVM_ACC_PROTECTED ) != 0; }
108 bool is_static () const { return (_flags & JVM_ACC_STATIC ) != 0; }
109 bool is_final () const { return (_flags & JVM_ACC_FINAL ) != 0; }
110 bool is_synchronized() const { return (_flags & JVM_ACC_SYNCHRONIZED) != 0; }
111 bool is_super () const { return (_flags & JVM_ACC_SUPER ) != 0; }
112 bool is_volatile () const { return (_flags & JVM_ACC_VOLATILE ) != 0; }
113 bool is_transient () const { return (_flags & JVM_ACC_TRANSIENT ) != 0; }
114 bool is_native () const { return (_flags & JVM_ACC_NATIVE ) != 0; }
115 bool is_interface () const { return (_flags & JVM_ACC_INTERFACE ) != 0; }
116 bool is_abstract () const { return (_flags & JVM_ACC_ABSTRACT ) != 0; }
117 bool is_strict () const { return (_flags & JVM_ACC_STRICT ) != 0; }
118
119 // Attribute flags
120 bool is_synthetic () const { return (_flags & JVM_ACC_SYNTHETIC ) != 0; }
121
122 // Method* flags
123 bool is_monitor_matching () const { return (_flags & JVM_ACC_MONITOR_MATCH ) != 0; }
124 bool has_monitor_bytecodes () const { return (_flags & JVM_ACC_HAS_MONITOR_BYTECODES ) != 0; }
125 bool has_loops () const { return (_flags & JVM_ACC_HAS_LOOPS ) != 0; }
126 bool loops_flag_init () const { return (_flags & JVM_ACC_LOOPS_FLAG_INIT ) != 0; }
127 bool queued_for_compilation () const { return (_flags & JVM_ACC_QUEUED ) != 0; }
128 bool is_not_c1_compilable () const { return (_flags & JVM_ACC_NOT_C1_COMPILABLE ) != 0; }
129 bool is_not_c2_compilable () const { return (_flags & JVM_ACC_NOT_C2_COMPILABLE ) != 0; }
130 bool is_not_c2_osr_compilable() const { return (_flags & JVM_ACC_NOT_C2_OSR_COMPILABLE ) != 0; }
131 bool has_linenumber_table () const { return (_flags & JVM_ACC_HAS_LINE_NUMBER_TABLE ) != 0; }
132 bool has_checked_exceptions () const { return (_flags & JVM_ACC_HAS_CHECKED_EXCEPTIONS ) != 0; }
133 bool has_jsrs () const { return (_flags & JVM_ACC_HAS_JSRS ) != 0; }
134 bool is_old () const { return (_flags & JVM_ACC_IS_OLD ) != 0; }
135 bool is_obsolete () const { return (_flags & JVM_ACC_IS_OBSOLETE ) != 0; }
136 bool is_deleted () const { return (_flags & JVM_ACC_IS_DELETED ) != 0; }
137 bool is_prefixed_native () const { return (_flags & JVM_ACC_IS_PREFIXED_NATIVE ) != 0; }
138
139 // Klass* flags
140 bool has_miranda_methods () const { return (_flags & JVM_ACC_HAS_MIRANDA_METHODS ) != 0; }
141 bool has_vanilla_constructor () const { return (_flags & JVM_ACC_HAS_VANILLA_CONSTRUCTOR) != 0; }
142 bool has_finalizer () const { return (_flags & JVM_ACC_HAS_FINALIZER ) != 0; }
143 bool has_final_method () const { return (_flags & JVM_ACC_HAS_FINAL_METHOD ) != 0; }
144 bool is_cloneable () const { return (_flags & JVM_ACC_IS_CLONEABLE ) != 0; }
145 // Klass* and Method* flags
146 bool has_localvariable_table () const { return (_flags & JVM_ACC_HAS_LOCAL_VARIABLE_TABLE) != 0; }
147 void set_has_localvariable_table() { atomic_set_bits(JVM_ACC_HAS_LOCAL_VARIABLE_TABLE); }
148 void clear_has_localvariable_table() { atomic_clear_bits(JVM_ACC_HAS_LOCAL_VARIABLE_TABLE); }
149
150 // field flags
151 bool is_field_access_watched() const { return (_flags & JVM_ACC_FIELD_ACCESS_WATCHED) != 0; }
152 bool is_field_modification_watched() const
153 { return (_flags & JVM_ACC_FIELD_MODIFICATION_WATCHED) != 0; }
154 bool has_field_initialized_final_update() const
155 { return (_flags & JVM_ACC_FIELD_INITIALIZED_FINAL_UPDATE) != 0; }
156 bool on_stack() const { return (_flags & JVM_ACC_ON_STACK) != 0; }
157 bool is_internal() const { return (_flags & JVM_ACC_FIELD_INTERNAL) != 0; }
158 bool is_stable() const { return (_flags & JVM_ACC_FIELD_STABLE) != 0; }
159 bool field_has_generic_signature() const
160 { return (_flags & JVM_ACC_FIELD_HAS_GENERIC_SIGNATURE) != 0; }
161
162 // get .class file flags
163 jint get_flags () const { return (_flags & JVM_ACC_WRITTEN_FLAGS); }
164
165 // Initialization
166 void add_promoted_flags(jint flags) { _flags |= (flags & JVM_ACC_PROMOTED_FLAGS); }
167 void set_field_flags(jint flags) {
168 assert((flags & JVM_ACC_FIELD_FLAGS) == flags, "only recognized flags");
169 _flags = (flags & JVM_ACC_FIELD_FLAGS);
170 }
171 void set_flags(jint flags) { _flags = (flags & JVM_ACC_WRITTEN_FLAGS); }
172
173 void set_queued_for_compilation() { atomic_set_bits(JVM_ACC_QUEUED); }
174 void clear_queued_for_compilation() { atomic_clear_bits(JVM_ACC_QUEUED); }
175
176 // Atomic update of flags
177 void atomic_set_bits(jint bits);
178 bool atomic_set_one_bit(jint bit);
179 void atomic_clear_bits(jint bits);
180
181 private:
182 friend class Method;
183 friend class Klass;
184 friend class ClassFileParser;
185 // the functions below should only be called on the _access_flags inst var directly,
186 // otherwise they are just changing a copy of the flags
187
188 // attribute flags
189 void set_is_synthetic() { atomic_set_bits(JVM_ACC_SYNTHETIC); }
190
191 // Method* flags
192 void set_monitor_matching() { atomic_set_bits(JVM_ACC_MONITOR_MATCH); }
193 void set_has_monitor_bytecodes() { atomic_set_bits(JVM_ACC_HAS_MONITOR_BYTECODES); }
194 void set_has_loops() { atomic_set_bits(JVM_ACC_HAS_LOOPS); }
195 void set_loops_flag_init() { atomic_set_bits(JVM_ACC_LOOPS_FLAG_INIT); }
196 void set_not_c1_compilable() { atomic_set_bits(JVM_ACC_NOT_C1_COMPILABLE); }
197 void set_not_c2_compilable() { atomic_set_bits(JVM_ACC_NOT_C2_COMPILABLE); }
198 void set_not_c2_osr_compilable() { atomic_set_bits(JVM_ACC_NOT_C2_OSR_COMPILABLE); }
199 void set_has_linenumber_table() { atomic_set_bits(JVM_ACC_HAS_LINE_NUMBER_TABLE); }
200 void set_has_checked_exceptions() { atomic_set_bits(JVM_ACC_HAS_CHECKED_EXCEPTIONS); }
201 void set_has_jsrs() { atomic_set_bits(JVM_ACC_HAS_JSRS); }
202 void set_is_old() { atomic_set_bits(JVM_ACC_IS_OLD); }
203 void set_is_obsolete() { atomic_set_bits(JVM_ACC_IS_OBSOLETE); }
204 void set_is_deleted() { atomic_set_bits(JVM_ACC_IS_DELETED); }
205 void set_is_prefixed_native() { atomic_set_bits(JVM_ACC_IS_PREFIXED_NATIVE); }
206
207 void clear_not_c1_compilable() { atomic_clear_bits(JVM_ACC_NOT_C1_COMPILABLE); }
208 void clear_not_c2_compilable() { atomic_clear_bits(JVM_ACC_NOT_C2_COMPILABLE); }
209 void clear_not_c2_osr_compilable() { atomic_clear_bits(JVM_ACC_NOT_C2_OSR_COMPILABLE); }
210 // Klass* flags
211 void set_has_vanilla_constructor() { atomic_set_bits(JVM_ACC_HAS_VANILLA_CONSTRUCTOR); }
212 void set_has_finalizer() { atomic_set_bits(JVM_ACC_HAS_FINALIZER); }
213 void set_has_final_method() { atomic_set_bits(JVM_ACC_HAS_FINAL_METHOD); }
214 void set_is_cloneable() { atomic_set_bits(JVM_ACC_IS_CLONEABLE); }
215 void set_has_miranda_methods() { atomic_set_bits(JVM_ACC_HAS_MIRANDA_METHODS); }
216
217 public:
218 // field flags
219 void set_is_field_access_watched(const bool value)
220 {
221 if (value) {
222 atomic_set_bits(JVM_ACC_FIELD_ACCESS_WATCHED);
223 } else {
224 atomic_clear_bits(JVM_ACC_FIELD_ACCESS_WATCHED);
225 }
226 }
227 void set_is_field_modification_watched(const bool value)
228 {
229 if (value) {
230 atomic_set_bits(JVM_ACC_FIELD_MODIFICATION_WATCHED);
231 } else {
232 atomic_clear_bits(JVM_ACC_FIELD_MODIFICATION_WATCHED);
233 }
234 }
235
236 void set_has_field_initialized_final_update(const bool value) {
237 if (value) {
238 atomic_set_bits(JVM_ACC_FIELD_INITIALIZED_FINAL_UPDATE);
239 } else {
240 atomic_clear_bits(JVM_ACC_FIELD_INITIALIZED_FINAL_UPDATE);
241 }
242 }
243
244 void set_field_has_generic_signature()
245 {
246 atomic_set_bits(JVM_ACC_FIELD_HAS_GENERIC_SIGNATURE);
247 }
248
249 bool set_on_stack(const bool value)
250 {
251 if (value) {
252 return atomic_set_one_bit(JVM_ACC_ON_STACK);
253 } else {
254 atomic_clear_bits(JVM_ACC_ON_STACK);
255 return true; // Ignored
256 }
257 }
258 // Conversion
259 jshort as_short() const { return (jshort)_flags; }
260 jint as_int() const { return _flags; }
261
262 inline friend AccessFlags accessFlags_from(jint flags);
263
264 // Printing/debugging
265 #if INCLUDE_JVMTI
266 void print_on(outputStream* st) const;
267 #else
268 void print_on(outputStream* st) const PRODUCT_RETURN;
269 #endif
270 };
271
272 inline AccessFlags accessFlags_from(jint flags) {
273 AccessFlags af;
274 af._flags = flags;
275 return af;
276 }
277
278 #endif // SHARE_VM_UTILITIES_ACCESSFLAGS_HPP