1 /*
2 * Copyright (c) 1997, 2023, 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_UTILITIES_ACCESSFLAGS_HPP
26 #define SHARE_UTILITIES_ACCESSFLAGS_HPP
27
28 #include "jvm_constants.h"
29 #include "utilities/debug.hpp"
30 #include "utilities/globalDefinitions.hpp"
31 #include "utilities/macros.hpp"
32
33 // AccessFlags is an abstraction over Java access flags.
34
35 class outputStream;
36
37 enum {
38 // See jvm.h for shared JVM_ACC_XXX access flags
39
40 // flags actually put in .class file
41 JVM_ACC_WRITTEN_FLAGS = 0x00007FFF,
42
43 // HotSpot-specific access flags
44 // These Klass flags should be migrated, to a field such as InstanceKlass::_misc_flags,
45 // or to a similar flags field in Klass itself.
46 // Do not add new ACC flags here.
47 JVM_ACC_HAS_FINALIZER = 0x40000000, // True if klass has a non-empty finalize() method
48 JVM_ACC_IS_CLONEABLE_FAST = (int)0x80000000,// True if klass implements the Cloneable interface and can be optimized in generated code
49 JVM_ACC_IS_HIDDEN_CLASS = 0x04000000, // True if klass is hidden
50 JVM_ACC_IS_VALUE_BASED_CLASS = 0x08000000, // True if klass is marked as a ValueBased class
51 };
52
53
54 class AccessFlags {
55 friend class VMStructs;
56 private:
57 jint _flags; // TODO: move 4 access flags above to Klass and change to u2
58
59 public:
60 AccessFlags() : _flags(0) {}
61 explicit AccessFlags(jint flags) : _flags(flags) {}
62
63 // Java access flags
64 bool is_public () const { return (_flags & JVM_ACC_PUBLIC ) != 0; }
65 bool is_private () const { return (_flags & JVM_ACC_PRIVATE ) != 0; }
66 bool is_protected () const { return (_flags & JVM_ACC_PROTECTED ) != 0; }
67 bool is_static () const { return (_flags & JVM_ACC_STATIC ) != 0; }
68 bool is_final () const { return (_flags & JVM_ACC_FINAL ) != 0; }
69 bool is_synchronized() const { return (_flags & JVM_ACC_SYNCHRONIZED) != 0; }
70 bool is_volatile () const { return (_flags & JVM_ACC_VOLATILE ) != 0; }
71 bool is_transient () const { return (_flags & JVM_ACC_TRANSIENT ) != 0; }
72 bool is_native () const { return (_flags & JVM_ACC_NATIVE ) != 0; }
73 bool is_interface () const { return (_flags & JVM_ACC_INTERFACE ) != 0; }
74 bool is_abstract () const { return (_flags & JVM_ACC_ABSTRACT ) != 0; }
75 bool is_value_class () const { return (_flags & JVM_ACC_VALUE ) != 0; }
76 bool is_primitive_class () const { return (_flags & JVM_ACC_PRIMITIVE ) != 0; }
77 bool is_identity_class () const { return (_flags & JVM_ACC_IDENTITY ) != 0; }
78
79 // Attribute flags
80 bool is_synthetic () const { return (_flags & JVM_ACC_SYNTHETIC ) != 0; }
81
82 // Klass* flags
83 bool has_finalizer () const { return (_flags & JVM_ACC_HAS_FINALIZER ) != 0; }
84 bool is_cloneable_fast () const { return (_flags & JVM_ACC_IS_CLONEABLE_FAST ) != 0; }
85 bool is_hidden_class () const { return (_flags & JVM_ACC_IS_HIDDEN_CLASS ) != 0; }
86 bool is_value_based_class () const { return (_flags & JVM_ACC_IS_VALUE_BASED_CLASS ) != 0; }
87
88 // get .class file flags
89 jint get_flags () const { return (_flags & JVM_ACC_WRITTEN_FLAGS); }
90
91 // Initialization
92 void set_field_flags(jint flags) {
93 assert((flags & JVM_RECOGNIZED_FIELD_MODIFIERS) == flags, "only recognized flags");
94 _flags = (flags & JVM_RECOGNIZED_FIELD_MODIFIERS);
95 }
96 void set_flags(jint flags) { _flags = (flags & JVM_ACC_WRITTEN_FLAGS); }
97
98 private:
99 friend class Klass;
100 friend class ClassFileParser;
101 // the functions below should only be called on the _access_flags inst var directly,
102 // otherwise they are just changing a copy of the flags
103
104 // attribute flags
105 void set_is_synthetic() { _flags |= JVM_ACC_SYNTHETIC; }
106
107 // Klass* flags
108 // These are set at classfile parsing time so do not require atomic access.
109 void set_has_finalizer() { _flags |= JVM_ACC_HAS_FINALIZER; }
110 void set_is_cloneable_fast() { _flags |= JVM_ACC_IS_CLONEABLE_FAST; }
111 void set_is_hidden_class() { _flags |= JVM_ACC_IS_HIDDEN_CLASS; }
112 void set_is_value_based_class() { _flags |= JVM_ACC_IS_VALUE_BASED_CLASS; }
113
114 public:
115 // Conversion
116 jshort as_short() const { return (jshort)_flags; }
117 jint as_int() const { return _flags; }
118
119 inline friend AccessFlags accessFlags_from(jint flags);
120
121 // Printing/debugging
122 #if INCLUDE_JVMTI
123 void print_on(outputStream* st) const;
124 #else
125 void print_on(outputStream* st) const PRODUCT_RETURN;
126 #endif
127 };
128
129 inline AccessFlags accessFlags_from(jint flags) {
130 AccessFlags af;
131 af._flags = flags;
132 return af;
133 }
134
135 #endif // SHARE_UTILITIES_ACCESSFLAGS_HPP