36 import java.io.UncheckedIOException;
37 import java.lang.foreign.AddressLayout;
38 import java.lang.foreign.Arena;
39 import java.lang.foreign.FunctionDescriptor;
40 import java.lang.foreign.Linker;
41 import java.lang.foreign.MemoryLayout;
42 import java.lang.foreign.MemorySegment;
43 import java.lang.foreign.SymbolLookup;
44 import java.lang.invoke.MethodHandle;
45 import java.lang.invoke.MethodType;
46 import java.lang.module.ModuleReader;
47 import java.lang.module.ModuleReference;
48 import java.lang.reflect.Method;
49 import java.lang.reflect.Modifier;
50 import java.nio.file.Path;
51 import java.util.Arrays;
52 import java.util.HashSet;
53 import java.util.List;
54 import java.util.Set;
55 import java.util.StringJoiner;
56 import java.util.function.Consumer;
57 import java.util.stream.Collectors;
58 import java.util.stream.Stream;
59
60 import static org.testng.Assert.assertTrue;
61 import static org.testng.Assert.fail;
62
63 /**
64 * This test checks all methods in java.base to make sure that methods annotated with {@link Restricted} are
65 * expected restricted methods. Conversely, the test also checks that there is no expected restricted method
66 * that is not marked with the annotation. For each restricted method, we also check that they are
67 * marked with the {@link CallerSensitive} annotation.
68 */
69 public class TestRestricted {
70
71 record RestrictedMethod(Class<?> owner, String name, MethodType type) {
72 static RestrictedMethod from(Method method) {
73 return of(method.getDeclaringClass(), method.getName(), method.getReturnType(), method.getParameterTypes());
74 }
75
76 static RestrictedMethod of(Class<?> owner, String name, Class<?> returnType, Class<?>... paramTypes) {
77 return new RestrictedMethod(owner, name, MethodType.methodType(returnType, paramTypes));
78 }
79 };
80
81 static final Set<RestrictedMethod> RESTRICTED_METHODS = Set.of(
82 RestrictedMethod.of(SymbolLookup.class, "libraryLookup", SymbolLookup.class, String.class, Arena.class),
83 RestrictedMethod.of(SymbolLookup.class, "libraryLookup", SymbolLookup.class, Path.class, Arena.class),
84 RestrictedMethod.of(Linker.class, "downcallHandle", MethodHandle.class, FunctionDescriptor.class, Linker.Option[].class),
85 RestrictedMethod.of(Linker.class, "downcallHandle", MethodHandle.class, MemorySegment.class, FunctionDescriptor.class, Linker.Option[].class),
86 RestrictedMethod.of(Linker.class, "upcallStub", MemorySegment.class, MethodHandle.class, FunctionDescriptor.class, Arena.class, Linker.Option[].class),
87 RestrictedMethod.of(MemorySegment.class, "reinterpret", MemorySegment.class, long.class),
88 RestrictedMethod.of(MemorySegment.class, "reinterpret", MemorySegment.class, Arena.class, Consumer.class),
89 RestrictedMethod.of(MemorySegment.class, "reinterpret", MemorySegment.class, long.class, Arena.class, Consumer.class),
90 RestrictedMethod.of(AddressLayout.class, "withTargetLayout", AddressLayout.class, MemoryLayout.class),
91 RestrictedMethod.of(ModuleLayer.Controller.class, "enableNativeAccess", ModuleLayer.Controller.class, Module.class),
92 RestrictedMethod.of(System.class, "load", void.class, String.class),
93 RestrictedMethod.of(System.class, "loadLibrary", void.class, String.class),
94 RestrictedMethod.of(Runtime.class, "load", void.class, String.class),
95 RestrictedMethod.of(Runtime.class, "loadLibrary", void.class, String.class)
96 );
97
98 @Test
99 public void testRestricted() {
100 Set<RestrictedMethod> restrictedMethods = new HashSet<>(RESTRICTED_METHODS);
101 restrictedMethods(Object.class.getModule()).forEach(m -> checkRestrictedMethod(m, restrictedMethods));
102 if (!restrictedMethods.isEmpty()) {
103 fail("@Restricted annotation not found for methods: " + restrictedMethods);
104 }
105 }
106
107 void checkRestrictedMethod(Method meth, Set<RestrictedMethod> restrictedMethods) {
108 String sig = meth.getDeclaringClass().getName() + "::" + shortSig(meth);
109 boolean expectRestricted = restrictedMethods.remove(RestrictedMethod.from(meth));
110 assertTrue(expectRestricted, "unexpected @Restricted annotation found on method " + sig);
111 assertTrue(meth.isAnnotationPresent(CallerSensitive.class), "@CallerSensitive annotation not found on restricted method " + sig);
112 }
113
114 /**
115 * Returns a stream of all restricted methods on public classes in packages
|
36 import java.io.UncheckedIOException;
37 import java.lang.foreign.AddressLayout;
38 import java.lang.foreign.Arena;
39 import java.lang.foreign.FunctionDescriptor;
40 import java.lang.foreign.Linker;
41 import java.lang.foreign.MemoryLayout;
42 import java.lang.foreign.MemorySegment;
43 import java.lang.foreign.SymbolLookup;
44 import java.lang.invoke.MethodHandle;
45 import java.lang.invoke.MethodType;
46 import java.lang.module.ModuleReader;
47 import java.lang.module.ModuleReference;
48 import java.lang.reflect.Method;
49 import java.lang.reflect.Modifier;
50 import java.nio.file.Path;
51 import java.util.Arrays;
52 import java.util.HashSet;
53 import java.util.List;
54 import java.util.Set;
55 import java.util.StringJoiner;
56 import java.util.concurrent.Executor;
57 import java.util.function.Consumer;
58 import java.util.stream.Collectors;
59 import java.util.stream.Stream;
60
61 import static org.testng.Assert.assertTrue;
62 import static org.testng.Assert.fail;
63
64 /**
65 * This test checks all methods in java.base to make sure that methods annotated with {@link Restricted} are
66 * expected restricted methods. Conversely, the test also checks that there is no expected restricted method
67 * that is not marked with the annotation. For each restricted method, we also check that they are
68 * marked with the {@link CallerSensitive} annotation.
69 */
70 public class TestRestricted {
71
72 record RestrictedMethod(Class<?> owner, String name, MethodType type) {
73 static RestrictedMethod from(Method method) {
74 return of(method.getDeclaringClass(), method.getName(), method.getReturnType(), method.getParameterTypes());
75 }
76
77 static RestrictedMethod of(Class<?> owner, String name, Class<?> returnType, Class<?>... paramTypes) {
78 return new RestrictedMethod(owner, name, MethodType.methodType(returnType, paramTypes));
79 }
80 };
81
82 static final Set<RestrictedMethod> RESTRICTED_METHODS = Set.of(
83 RestrictedMethod.of(SymbolLookup.class, "libraryLookup", SymbolLookup.class, String.class, Arena.class),
84 RestrictedMethod.of(SymbolLookup.class, "libraryLookup", SymbolLookup.class, Path.class, Arena.class),
85 RestrictedMethod.of(Linker.class, "downcallHandle", MethodHandle.class, FunctionDescriptor.class, Linker.Option[].class),
86 RestrictedMethod.of(Linker.class, "downcallHandle", MethodHandle.class, MemorySegment.class, FunctionDescriptor.class, Linker.Option[].class),
87 RestrictedMethod.of(Linker.class, "upcallStub", MemorySegment.class, MethodHandle.class, FunctionDescriptor.class, Arena.class, Linker.Option[].class),
88 RestrictedMethod.of(MemorySegment.class, "reinterpret", MemorySegment.class, long.class),
89 RestrictedMethod.of(MemorySegment.class, "reinterpret", MemorySegment.class, Arena.class, Consumer.class),
90 RestrictedMethod.of(MemorySegment.class, "reinterpret", MemorySegment.class, long.class, Arena.class, Consumer.class),
91 RestrictedMethod.of(AddressLayout.class, "withTargetLayout", AddressLayout.class, MemoryLayout.class),
92 RestrictedMethod.of(ModuleLayer.Controller.class, "enableNativeAccess", ModuleLayer.Controller.class, Module.class),
93 RestrictedMethod.of(System.class, "load", void.class, String.class),
94 RestrictedMethod.of(System.class, "loadLibrary", void.class, String.class),
95 RestrictedMethod.of(Runtime.class, "load", void.class, String.class),
96 RestrictedMethod.of(Runtime.class, "loadLibrary", void.class, String.class),
97 RestrictedMethod.of(Thread.Builder.OfVirtual.class, "scheduler", Thread.Builder.OfVirtual.class, Executor.class)
98 );
99
100 @Test
101 public void testRestricted() {
102 Set<RestrictedMethod> restrictedMethods = new HashSet<>(RESTRICTED_METHODS);
103 restrictedMethods(Object.class.getModule()).forEach(m -> checkRestrictedMethod(m, restrictedMethods));
104 if (!restrictedMethods.isEmpty()) {
105 fail("@Restricted annotation not found for methods: " + restrictedMethods);
106 }
107 }
108
109 void checkRestrictedMethod(Method meth, Set<RestrictedMethod> restrictedMethods) {
110 String sig = meth.getDeclaringClass().getName() + "::" + shortSig(meth);
111 boolean expectRestricted = restrictedMethods.remove(RestrictedMethod.from(meth));
112 assertTrue(expectRestricted, "unexpected @Restricted annotation found on method " + sig);
113 assertTrue(meth.isAnnotationPresent(CallerSensitive.class), "@CallerSensitive annotation not found on restricted method " + sig);
114 }
115
116 /**
117 * Returns a stream of all restricted methods on public classes in packages
|