1 /*
2 * Copyright (c) 2022, 2025, 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 * @test
26 * @bug 8266670 8293626 8297271
27 * @summary Basic tests of AccessFlag
28 * @run junit BasicAccessFlagTest
29 */
30
31 import java.lang.classfile.ClassFile;
32 import java.lang.reflect.AccessFlag;
33 import java.lang.reflect.ClassFileFormatVersion;
34 import java.lang.reflect.Field;
35 import java.lang.reflect.Modifier;
36 import java.util.EnumSet;
37 import java.util.Map;
38 import java.util.LinkedHashMap;
39 import java.util.HashSet;
40 import java.util.Set;
41
42 import org.junit.Test;
43 import org.junit.jupiter.api.Assertions;
44
45 import static org.junit.jupiter.api.Assertions.*;
46
47 public class BasicAccessFlagTest {
48
49 /*
50 * Verify sourceModifier() == true access flags have a
51 * corresponding constant in java.lang.reflect.Modifier.
52 */
53 @Test
54 public void testSourceModifiers() throws Exception {
55 Class<?> modifierClass = Modifier.class;
56
57 for(AccessFlag accessFlag : AccessFlag.values()) {
58 if (accessFlag.sourceModifier()) {
59 // Check for consistency
60 Field f = modifierClass.getField(accessFlag.name());
61 assertEquals(f.getInt(null), accessFlag.mask(), accessFlag + " mask");
62 }
63 }
64 }
65
66 // The mask values of the enum constants must be non-decreasing;
67 // in other words stay the same (for colliding mask values) or go
68 // up.
69 @Test
70 public void testMaskOrdering() {
71 AccessFlag[] values = AccessFlag.values();
72 for (int i = 1; i < values.length; i++) {
73 AccessFlag left = values[i-1];
74 AccessFlag right = values[i];
75 assertTrue(left.mask() <= right.mask(), () -> left
76 + "has a greater mask than "
77 + right);
78 }
79 }
80
81 // Test that if access flags have a matching mask, their locations
82 // are disjoint.
83 @Test
84 public void testDisjoint() {
85 // First build the mask -> access flags map...
86 Map<Integer, Set<AccessFlag>> maskToFlags = new LinkedHashMap<>();
87
88 for (var accessFlag : AccessFlag.values()) {
89 Integer mask = accessFlag.mask();
90 Set<AccessFlag> flags = maskToFlags.get(mask);
91
92 if (flags == null) {
93 flags = new HashSet<>();
94 flags.add(accessFlag);
95 maskToFlags.put(mask, flags);
96 } else {
97 flags.add(accessFlag);
98 }
99 }
100
101 // ...then test for disjointness
102 for (var entry : maskToFlags.entrySet()) {
103 var value = entry.getValue();
104 if (value.size() == 0) {
105 throw new AssertionError("Bad flag set " + entry);
106 } else if (value.size() == 1) {
107 // Need at least two flags to be non-disjointness to
108 // be possible
109 continue;
110 }
111
112 Set<AccessFlag.Location> locations = new HashSet<>();
113 for (var accessFlag : value) {
114 for (var location : accessFlag.locations()) {
115 boolean added = locations.add(location);
116 if (!added) {
117 reportError(location, accessFlag,
118 entry.getKey(), value);
119 }
120 }
121 }
122 }
123 }
124
125 private static void reportError(AccessFlag.Location location,
126 AccessFlag accessFlag,
127 Integer mask, Set<AccessFlag> value) {
128 System.err.println("Location " + location +
129 " from " + accessFlag +
130 " already present for 0x" +
131 Integer.toHexString(mask) + ": " + value);
132 throw new RuntimeException();
133 }
134
135 // For each access flag, make sure it is recognized on every kind
136 // of location it can apply to
137 @Test
138 public void testMaskToAccessFlagsPositive() {
139 for (var accessFlag : AccessFlag.values()) {
140 Set<AccessFlag> expectedSet = EnumSet.of(accessFlag);
141 for (var location : accessFlag.locations()) {
142 Set<AccessFlag> computedSet =
143 AccessFlag.maskToAccessFlags(accessFlag.mask(), location);
144 if (!expectedSet.equals(computedSet)) {
145 throw new RuntimeException("Bad set computation on " +
146 accessFlag + ", " + location);
147 }
148 }
149 for (var cffv : ClassFileFormatVersion.values()) {
150 for (var location : accessFlag.locations(cffv)) {
151 Set<AccessFlag> computedSet =
152 AccessFlag.maskToAccessFlags(accessFlag.mask(), location, cffv);
153 if (!expectedSet.equals(computedSet)) {
154 throw new RuntimeException("Bad set computation on " +
155 accessFlag + ", " + location);
156 }
157 }
158 }
159 }
160 assertEquals(Set.of(AccessFlag.STRICT), AccessFlag.maskToAccessFlags(Modifier.STRICT, AccessFlag.Location.METHOD, ClassFileFormatVersion.RELEASE_8));
161 }
162
163 @Test
164 public void testMaskToAccessFlagsNegative() {
165 assertThrows(IllegalArgumentException.class, () -> AccessFlag.maskToAccessFlags(Modifier.STRICT, AccessFlag.Location.METHOD));
166 assertThrows(IllegalArgumentException.class, () -> AccessFlag.maskToAccessFlags(Modifier.STRICT, AccessFlag.Location.METHOD, ClassFileFormatVersion.RELEASE_17));
167 assertThrows(IllegalArgumentException.class, () -> AccessFlag.maskToAccessFlags(Modifier.STRICT, AccessFlag.Location.METHOD, ClassFileFormatVersion.RELEASE_1));
168 assertThrows(IllegalArgumentException.class, () -> AccessFlag.maskToAccessFlags(Modifier.PRIVATE, AccessFlag.Location.CLASS));
169 assertThrows(IllegalArgumentException.class, () -> AccessFlag.maskToAccessFlags(ClassFile.ACC_MODULE, AccessFlag.Location.CLASS, ClassFileFormatVersion.RELEASE_8));
170 assertThrows(IllegalArgumentException.class, () -> AccessFlag.maskToAccessFlags(ClassFile.ACC_ANNOTATION, AccessFlag.Location.CLASS, ClassFileFormatVersion.RELEASE_4));
171 assertThrows(IllegalArgumentException.class, () -> AccessFlag.maskToAccessFlags(ClassFile.ACC_ENUM, AccessFlag.Location.FIELD, ClassFileFormatVersion.RELEASE_4));
172 assertThrows(IllegalArgumentException.class, () -> AccessFlag.maskToAccessFlags(ClassFile.ACC_SYNTHETIC, AccessFlag.Location.INNER_CLASS, ClassFileFormatVersion.RELEASE_4));
173 assertThrows(IllegalArgumentException.class, () -> AccessFlag.maskToAccessFlags(ClassFile.ACC_PUBLIC, AccessFlag.Location.INNER_CLASS, ClassFileFormatVersion.RELEASE_0));
174 assertThrows(IllegalArgumentException.class, () -> AccessFlag.maskToAccessFlags(ClassFile.ACC_MANDATED, AccessFlag.Location.METHOD_PARAMETER, ClassFileFormatVersion.RELEASE_7));
175 assertThrows(IllegalArgumentException.class, () -> AccessFlag.maskToAccessFlags(ClassFile.ACC_MANDATED, AccessFlag.Location.MODULE, ClassFileFormatVersion.RELEASE_7));
176 }
177
178 @Test
179 public void testLocationsNullHandling() {
180 for (var flag : AccessFlag.values()) {
181 assertThrows(NullPointerException.class, () -> flag.locations(null));
182 }
183
184 for (var location : AccessFlag.Location.values()) {
185 assertThrows(NullPointerException.class, () -> location.flags(null));
186 }
187
188 for (var location : AccessFlag.Location.values()) {
189 try {
190 location.flags(null);
191 throw new RuntimeException("Did not get NPE on " + location + ".flags(null)");
192 } catch (NullPointerException npe ) {
193 ; // Expected
194 }
195 try {
196 location.flagsMask(null);
197 throw new RuntimeException("Did not get NPE on " + location + ".flagsMask(null)");
198 } catch (NullPointerException npe ) {
199 ; // Expected
200 }
201 }
202 }
203 }