1 /*
2 * Copyright (c) 2003, 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. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26 package jdk.internal.access;
27
28 import java.io.InputStream;
29 import java.io.PrintStream;
30 import java.lang.annotation.Annotation;
31 import java.lang.foreign.MemorySegment;
32 import java.lang.invoke.MethodHandle;
33 import java.lang.invoke.MethodType;
34 import java.lang.module.ModuleDescriptor;
35 import java.lang.reflect.Executable;
36 import java.lang.reflect.Method;
37 import java.net.URI;
38 import java.nio.charset.CharacterCodingException;
39 import java.nio.charset.Charset;
40 import java.security.AccessControlContext;
41 import java.security.ProtectionDomain;
42 import java.util.List;
43 import java.util.Map;
44 import java.util.Set;
45 import java.util.concurrent.ConcurrentHashMap;
46 import java.util.concurrent.Executor;
47 import java.util.concurrent.RejectedExecutionException;
48 import java.util.concurrent.ScheduledExecutorService;
49 import java.util.stream.Stream;
50
51 import jdk.internal.misc.CarrierThreadLocal;
52 import jdk.internal.module.ServicesCatalog;
53 import jdk.internal.reflect.ConstantPool;
54 import jdk.internal.vm.Continuation;
55 import jdk.internal.vm.ContinuationScope;
56 import jdk.internal.vm.StackableScope;
57 import jdk.internal.vm.ThreadContainer;
58 import sun.reflect.annotation.AnnotationType;
59 import sun.nio.ch.Interruptible;
60
61 public interface JavaLangAccess {
62
63 /**
64 * Returns the list of {@code Method} objects for the declared public
65 * methods of this class or interface that have the specified method name
66 * and parameter types.
67 */
68 List<Method> getDeclaredPublicMethods(Class<?> klass, String name, Class<?>... parameterTypes);
69
70 /**
71 * Return most specific method that matches name and parameterTypes.
72 */
73 Method findMethod(Class<?> klass, boolean publicOnly, String name, Class<?>... parameterTypes);
74
75 /**
76 * Return the constant pool for a class.
77 */
78 ConstantPool getConstantPool(Class<?> klass);
79
80 /**
81 * Compare-And-Set the AnnotationType instance corresponding to this class.
82 * (This method only applies to annotation types.)
83 */
84 boolean casAnnotationType(Class<?> klass, AnnotationType oldType, AnnotationType newType);
85
86 /**
87 * Get the AnnotationType instance corresponding to this class.
88 * (This method only applies to annotation types.)
89 */
90 AnnotationType getAnnotationType(Class<?> klass);
91
92 /**
93 * Get the declared annotations for a given class, indexed by their types.
94 */
95 Map<Class<? extends Annotation>, Annotation> getDeclaredAnnotationMap(Class<?> klass);
96
97 /**
98 * Get the array of bytes that is the class-file representation
99 * of this Class' annotations.
100 */
101 byte[] getRawClassAnnotations(Class<?> klass);
102
103 /**
104 * Get the array of bytes that is the class-file representation
105 * of this Class' type annotations.
106 */
107 byte[] getRawClassTypeAnnotations(Class<?> klass);
108
109 /**
110 * Get the array of bytes that is the class-file representation
111 * of this Executable's type annotations.
112 */
113 byte[] getRawExecutableTypeAnnotations(Executable executable);
114
115 /**
116 * Returns the elements of an enum class or null if the
117 * Class object does not represent an enum type;
118 * the result is uncloned, cached, and shared by all callers.
119 */
120 <E extends Enum<E>> E[] getEnumConstantsShared(Class<E> klass);
121
122 /**
123 * Set current thread's blocker field.
124 */
125 void blockedOn(Interruptible b);
126
127 /**
128 * Registers a shutdown hook.
129 *
130 * It is expected that this method with registerShutdownInProgress=true
131 * is only used to register DeleteOnExitHook since the first file
132 * may be added to the delete on exit list by the application shutdown
133 * hooks.
134 *
135 * @param slot the slot in the shutdown hook array, whose element
136 * will be invoked in order during shutdown
137 * @param registerShutdownInProgress true to allow the hook
138 * to be registered even if the shutdown is in progress.
139 * @param hook the hook to be registered
140 *
141 * @throws IllegalStateException if shutdown is in progress and
142 * the slot is not valid to register.
143 */
144 void registerShutdownHook(int slot, boolean registerShutdownInProgress, Runnable hook);
145
146 /**
147 * Returns a new Thread with the given Runnable and an
148 * inherited AccessControlContext.
149 */
150 Thread newThreadWithAcc(Runnable target, @SuppressWarnings("removal") AccessControlContext acc);
151
152 /**
153 * Invokes the finalize method of the given object.
154 */
155 void invokeFinalize(Object o) throws Throwable;
156
157 /**
158 * Returns the ConcurrentHashMap used as a storage for ClassLoaderValue(s)
159 * associated with the given class loader, creating it if it doesn't already exist.
160 */
161 ConcurrentHashMap<?, ?> createOrGetClassLoaderValueMap(ClassLoader cl);
162
163 /**
164 * Defines a class with the given name to a class loader.
165 */
166 Class<?> defineClass(ClassLoader cl, String name, byte[] b, ProtectionDomain pd, String source);
167
168 /**
169 * Defines a class with the given name to a class loader with
170 * the given flags and class data.
171 *
172 * @see java.lang.invoke.MethodHandles.Lookup#defineClass
173 */
174 Class<?> defineClass(ClassLoader cl, Class<?> lookup, String name, byte[] b, ProtectionDomain pd, boolean initialize, int flags, Object classData);
175
176 /**
177 * Returns a class loaded by the bootstrap class loader.
178 */
179 Class<?> findBootstrapClassOrNull(String name);
180
181 /**
182 * Define a Package of the given name and module by the given class loader.
183 */
184 Package definePackage(ClassLoader cl, String name, Module module);
185
186 /**
187 * Record the non-exported packages of the modules in the given layer
188 */
189 void addNonExportedPackages(ModuleLayer layer);
190
191 /**
192 * Invalidate package access cache
193 */
194 void invalidatePackageAccessCache();
195
196 /**
197 * Defines a new module to the Java virtual machine. The module
198 * is defined to the given class loader.
199 *
200 * The URI is for information purposes only, it can be {@code null}.
201 */
202 Module defineModule(ClassLoader loader, ModuleDescriptor descriptor, URI uri);
203
204 /**
205 * Defines the unnamed module for the given class loader.
206 */
207 Module defineUnnamedModule(ClassLoader loader);
208
209 /**
210 * Updates the readability so that module m1 reads m2. The new read edge
211 * does not result in a strong reference to m2 (m2 can be GC'ed).
212 *
213 * This method is the same as m1.addReads(m2) but without a permission check.
214 */
215 void addReads(Module m1, Module m2);
216
217 /**
218 * Updates module m to read all unnamed modules.
219 */
220 void addReadsAllUnnamed(Module m);
221
222 /**
223 * Updates module m1 to export a package unconditionally.
224 */
225 void addExports(Module m1, String pkg);
226
227 /**
228 * Updates module m1 to export a package to module m2. The export does
229 * not result in a strong reference to m2 (m2 can be GC'ed).
230 */
231 void addExports(Module m1, String pkg, Module m2);
232
233 /**
234 * Updates a module m to export a package to all unnamed modules.
235 */
236 void addExportsToAllUnnamed(Module m, String pkg);
237
238 /**
239 * Updates module m1 to open a package to module m2. Opening the
240 * package does not result in a strong reference to m2 (m2 can be GC'ed).
241 */
242 void addOpens(Module m1, String pkg, Module m2);
243
244 /**
245 * Updates module m to open a package to all unnamed modules.
246 */
247 void addOpensToAllUnnamed(Module m, String pkg);
248
249 /**
250 * Updates module m to open all packages in the given sets.
251 */
252 void addOpensToAllUnnamed(Module m, Set<String> concealedPkgs, Set<String> exportedPkgs);
253
254 /**
255 * Updates module m to use a service.
256 */
257 void addUses(Module m, Class<?> service);
258
259 /**
260 * Returns true if module m reflectively exports a package to other
261 */
262 boolean isReflectivelyExported(Module module, String pn, Module other);
263
264 /**
265 * Returns true if module m reflectively opens a package to other
266 */
267 boolean isReflectivelyOpened(Module module, String pn, Module other);
268
269 /**
270 * Updates module m to allow access to restricted methods.
271 */
272 Module addEnableNativeAccess(Module m);
273
274 /**
275 * Updates module named {@code name} in layer {@code layer} to allow access to restricted methods.
276 * Returns true iff the given module exists in the given layer.
277 */
278 boolean addEnableNativeAccess(ModuleLayer layer, String name);
279
280 /**
281 * Updates all unnamed modules to allow access to restricted methods.
282 */
283 void addEnableNativeAccessToAllUnnamed();
284
285 /**
286 * Ensure that the given module has native access. If not, warn or
287 * throw exception depending on the configuration.
288 */
289 void ensureNativeAccess(Module m, Class<?> owner, String methodName, Class<?> currentClass);
290
291 /**
292 * Returns the ServicesCatalog for the given Layer.
293 */
294 ServicesCatalog getServicesCatalog(ModuleLayer layer);
295
296 /**
297 * Record that this layer has at least one module defined to the given
298 * class loader.
299 */
300 void bindToLoader(ModuleLayer layer, ClassLoader loader);
301
302 /**
303 * Returns an ordered stream of layers. The first element is the
304 * given layer, the remaining elements are its parents, in DFS order.
305 */
306 Stream<ModuleLayer> layers(ModuleLayer layer);
307
308 /**
309 * Returns a stream of the layers that have modules defined to the
310 * given class loader.
311 */
312 Stream<ModuleLayer> layers(ClassLoader loader);
313
314 /**
315 * Count the number of leading positive bytes in the range.
316 */
317 int countPositives(byte[] ba, int off, int len);
318
319 /**
320 * Constructs a new {@code String} by decoding the specified subarray of
321 * bytes using the specified {@linkplain java.nio.charset.Charset charset}.
322 *
323 * The caller of this method shall relinquish and transfer the ownership of
324 * the byte array to the callee since the later will not make a copy.
325 *
326 * @param bytes the byte array source
327 * @param cs the Charset
328 * @return the newly created string
329 * @throws CharacterCodingException for malformed or unmappable bytes
330 */
331 String newStringNoRepl(byte[] bytes, Charset cs) throws CharacterCodingException;
332
333 /**
334 * Encode the given string into a sequence of bytes using the specified Charset.
335 *
336 * This method avoids copying the String's internal representation if the input
337 * is ASCII.
338 *
339 * This method throws CharacterCodingException instead of replacing when
340 * malformed input or unmappable characters are encountered.
341 *
342 * @param s the string to encode
343 * @param cs the charset
344 * @return the encoded bytes
345 * @throws CharacterCodingException for malformed input or unmappable characters
346 */
347 byte[] getBytesNoRepl(String s, Charset cs) throws CharacterCodingException;
348
349 /**
350 * Returns a new string by decoding from the given utf8 bytes array.
351 *
352 * @param off the index of the first byte to decode
353 * @param len the number of bytes to decode
354 * @return the newly created string
355 * @throws IllegalArgumentException for malformed or unmappable bytes.
356 */
357 String newStringUTF8NoRepl(byte[] bytes, int off, int len);
358
359 /**
360 * Get the char at index in a byte[] in internal UTF-16 representation,
361 * with no bounds checks.
362 *
363 * @param bytes the UTF-16 encoded bytes
364 * @param index of the char to retrieve, 0 <= index < (bytes.length >> 1)
365 * @return the char value
366 */
367 char getUTF16Char(byte[] bytes, int index);
368
369 /**
370 * Put the char at index in a byte[] in internal UTF-16 representation,
371 * with no bounds checks.
372 *
373 * @param bytes the UTF-16 encoded bytes
374 * @param index of the char to retrieve, 0 <= index < (bytes.length >> 1)
375 */
376 void putCharUTF16(byte[] bytes, int index, int ch);
377
378 /**
379 * Encode the given string into a sequence of bytes using utf8.
380 *
381 * @param s the string to encode
382 * @return the encoded bytes in utf8
383 * @throws IllegalArgumentException for malformed surrogates
384 */
385 byte[] getBytesUTF8NoRepl(String s);
386
387 /**
388 * Inflated copy from byte[] to char[], as defined by StringLatin1.inflate
389 */
390 void inflateBytesToChars(byte[] src, int srcOff, char[] dst, int dstOff, int len);
391
392 /**
393 * Decodes ASCII from the source byte array into the destination
394 * char array.
395 *
396 * @return the number of bytes successfully decoded, at most len
397 */
398 int decodeASCII(byte[] src, int srcOff, char[] dst, int dstOff, int len);
399
400 /**
401 * Returns the initial `System.in` to determine if it is replaced
402 * with `System.setIn(newIn)` method
403 */
404 InputStream initialSystemIn();
405
406 /**
407 * Returns the initial value of System.err.
408 */
409 PrintStream initialSystemErr();
410
411 /**
412 * Encodes ASCII codepoints as possible from the source array into
413 * the destination byte array, assuming that the encoding is ASCII
414 * compatible
415 *
416 * @return the number of bytes successfully encoded, or 0 if none
417 */
418 int encodeASCII(char[] src, int srcOff, byte[] dst, int dstOff, int len);
419
420 /**
421 * Set the cause of Throwable
422 * @param cause set t's cause to new value
423 */
424 void setCause(Throwable t, Throwable cause);
425
426 /**
427 * Get protection domain of the given Class
428 */
429 ProtectionDomain protectionDomain(Class<?> c);
430
431 /**
432 * Get a method handle of string concat helper method
433 */
434 MethodHandle stringConcatHelper(String name, MethodType methodType);
435
436 /**
437 * Get the string concat initial coder
438 */
439 long stringConcatInitialCoder();
440
441 /**
442 * Update lengthCoder for constant
443 */
444 long stringConcatMix(long lengthCoder, String constant);
445
446 /**
447 * Mix value length and coder into current length and coder.
448 */
449 long stringConcatMix(long lengthCoder, char value);
450
451 /**
452 * Join strings
453 */
454 String join(String prefix, String suffix, String delimiter, String[] elements, int size);
455
456 /*
457 * Get the class data associated with the given class.
458 * @param c the class
459 * @see java.lang.invoke.MethodHandles.Lookup#defineHiddenClass(byte[], boolean, MethodHandles.Lookup.ClassOption...)
460 */
461 Object classData(Class<?> c);
462
463 int stringSize(long i);
464
465 int getCharsLatin1(long i, int index, byte[] buf);
466
467 int getCharsUTF16(long i, int index, byte[] buf);
468
469 long findNative(ClassLoader loader, String entry);
470
471 /**
472 * Direct access to Shutdown.exit to avoid security manager checks
473 * @param statusCode the status code
474 */
475 void exit(int statusCode);
476
477 /**
478 * Returns an array of all platform threads.
479 */
480 Thread[] getAllThreads();
481
482 /**
483 * Returns the ThreadContainer for a thread, may be null.
484 */
485 ThreadContainer threadContainer(Thread thread);
486
487 /**
488 * Starts a thread in the given ThreadContainer.
489 */
490 void start(Thread thread, ThreadContainer container);
491
492 /**
493 * Returns the top of the given thread's stackable scope stack.
494 */
495 StackableScope headStackableScope(Thread thread);
496
497 /**
498 * Sets the top of the current thread's stackable scope stack.
499 */
500 void setHeadStackableScope(StackableScope scope);
501
502 /**
503 * Returns the Thread object for the current platform thread. If the
504 * current thread is a virtual thread then this method returns the carrier.
505 */
506 Thread currentCarrierThread();
507
508 /**
509 * Returns the value of the current carrier thread's copy of a thread-local.
510 */
511 <T> T getCarrierThreadLocal(CarrierThreadLocal<T> local);
512
513 /**
514 * Sets the value of the current carrier thread's copy of a thread-local.
515 */
516 <T> void setCarrierThreadLocal(CarrierThreadLocal<T> local, T value);
517
518 /**
519 * Removes the value of the current carrier thread's copy of a thread-local.
520 */
521 void removeCarrierThreadLocal(CarrierThreadLocal<?> local);
522
523 /**
524 * Returns {@code true} if there is a value in the current carrier thread's copy of
525 * thread-local, even if that values is {@code null}.
526 */
527 boolean isCarrierThreadLocalPresent(CarrierThreadLocal<?> local);
528
529 /**
530 * Returns the current thread's scoped values cache
531 */
532 Object[] scopedValueCache();
533
534 /**
535 * Sets the current thread's scoped values cache
536 */
537 void setScopedValueCache(Object[] cache);
538
539 /**
540 * Return the current thread's scoped value bindings.
541 */
542 Object scopedValueBindings();
543
544 /**
545 * Returns the innermost mounted continuation
546 */
547 Continuation getContinuation(Thread thread);
548
549 /**
550 * Sets the innermost mounted continuation
551 */
552 void setContinuation(Thread thread, Continuation continuation);
553
554 /**
555 * The ContinuationScope of virtual thread continuations
556 */
557 ContinuationScope virtualThreadContinuationScope();
558
559 /**
560 * Parks the current virtual thread.
561 * @throws WrongThreadException if the current thread is not a virtual thread
562 */
563 void parkVirtualThread();
564
565 /**
566 * Parks the current virtual thread for up to the given waiting time.
567 * @param nanos the maximum number of nanoseconds to wait
568 * @throws WrongThreadException if the current thread is not a virtual thread
569 */
570 void parkVirtualThread(long nanos);
571
572 /**
573 * Re-enables a virtual thread for scheduling. If the thread was parked then
574 * it will be unblocked, otherwise its next attempt to park will not block
575 * @param thread the virtual thread to unpark
576 * @throws IllegalArgumentException if the thread is not a virtual thread
577 * @throws RejectedExecutionException if the scheduler cannot accept a task
578 */
579 void unparkVirtualThread(Thread thread);
580
581 /**
582 * Returns the virtual thread default scheduler.
583 */
584 Executor virtualThreadDefaultScheduler();
585
586 /**
587 * Returns a stream of the delayed task schedulers used for virtual threads.
588 */
589 Stream<ScheduledExecutorService> virtualThreadDelayedTaskSchedulers();
590
591 /**
592 * Creates a new StackWalker
593 */
594 StackWalker newStackWalkerInstance(Set<StackWalker.Option> options,
595 ContinuationScope contScope,
596 Continuation continuation);
597 /**
598 * Returns '<loader-name>' @<id> if classloader has a name
599 * explicitly set otherwise <qualified-class-name> @<id>
600 */
601 String getLoaderNameID(ClassLoader loader);
602
603 /**
604 * Copy the string bytes to an existing segment, avoiding intermediate copies.
605 */
606 void copyToSegmentRaw(String string, MemorySegment segment, long offset);
607
608 /**
609 * Are the string bytes compatible with the given charset?
610 */
611 boolean bytesCompatible(String string, Charset charset);
612
613 /**
614 * Is a security manager already set or allowed to be set
615 * (using -Djava.security.manager=allow)?
616 */
617 boolean allowSecurityManager();
618 }