1 /*
2 * Copyright (c) 1997, 2024, 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 // Do not add new ACC flags here.
44 };
45
46
47 class AccessFlags {
48 friend class VMStructs;
49 private:
50 jint _flags; // TODO: move 4 access flags above to Klass and change to u2
51
52 public:
53 AccessFlags() : _flags(0) {}
54 explicit AccessFlags(jint flags) : _flags(flags) {}
55
56 // Java access flags
57 bool is_public () const { return (_flags & JVM_ACC_PUBLIC ) != 0; }
58 bool is_private () const { return (_flags & JVM_ACC_PRIVATE ) != 0; }
59 bool is_protected () const { return (_flags & JVM_ACC_PROTECTED ) != 0; }
60 bool is_static () const { return (_flags & JVM_ACC_STATIC ) != 0; }
61 bool is_final () const { return (_flags & JVM_ACC_FINAL ) != 0; }
62 bool is_synchronized() const { return (_flags & JVM_ACC_SYNCHRONIZED) != 0; }
63 bool is_super () const { return (_flags & JVM_ACC_SUPER ) != 0; }
64 bool is_volatile () const { return (_flags & JVM_ACC_VOLATILE ) != 0; }
65 bool is_transient () const { return (_flags & JVM_ACC_TRANSIENT ) != 0; }
66 bool is_native () const { return (_flags & JVM_ACC_NATIVE ) != 0; }
67 bool is_interface () const { return (_flags & JVM_ACC_INTERFACE ) != 0; }
68 bool is_abstract () const { return (_flags & JVM_ACC_ABSTRACT ) != 0; }
69
70 // Attribute flags
71 bool is_synthetic () const { return (_flags & JVM_ACC_SYNTHETIC ) != 0; }
72
73 // get .class file flags
74 jint get_flags () const { return (_flags & JVM_ACC_WRITTEN_FLAGS); }
75
76 // Initialization
77 void set_field_flags(jint flags) {
78 assert((flags & JVM_RECOGNIZED_FIELD_MODIFIERS) == flags, "only recognized flags");
79 _flags = (flags & JVM_RECOGNIZED_FIELD_MODIFIERS);
80 }
81 void set_flags(jint flags) { _flags = (flags & JVM_ACC_WRITTEN_FLAGS); }
82
83 private:
84 friend class Klass;
85 friend class ClassFileParser;
86 // the functions below should only be called on the _access_flags inst var directly,
87 // otherwise they are just changing a copy of the flags
88
89 // attribute flags
90 void set_is_synthetic() { _flags |= JVM_ACC_SYNTHETIC; }
91
92 public:
93 // Conversion
94 jshort as_short() const { return (jshort)_flags; }
95 jint as_int() const { return _flags; }
96
97 inline friend AccessFlags accessFlags_from(jint flags);
98
99 // Printing/debugging
100 #if INCLUDE_JVMTI
101 void print_on(outputStream* st) const;
102 #else
103 void print_on(outputStream* st) const PRODUCT_RETURN;
104 #endif
105 };
106
107 inline AccessFlags accessFlags_from(jint flags) {
108 AccessFlags af;
109 af._flags = flags;
110 return af;
111 }
112
113 #endif // SHARE_UTILITIES_ACCESSFLAGS_HPP