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