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