1 /*
  2  * Copyright (c) 2003, 2021, 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.lang.annotation.Annotation;
 29 import java.lang.invoke.MethodHandle;
 30 import java.lang.invoke.MethodHandles;
 31 import java.lang.invoke.MethodType;
 32 import java.lang.module.ModuleDescriptor;
 33 import java.lang.reflect.Executable;
 34 import java.lang.reflect.Method;
 35 import java.net.URI;
 36 import java.nio.charset.CharacterCodingException;
 37 import java.nio.charset.Charset;
 38 import java.security.AccessControlContext;
 39 import java.security.ProtectionDomain;
 40 import java.util.List;
 41 import java.util.Map;
 42 import java.util.Set;
 43 import java.util.concurrent.Callable;
 44 import java.util.concurrent.ConcurrentHashMap;
 45 import java.util.concurrent.RejectedExecutionException;
 46 import java.util.stream.Stream;
 47 
 48 import jdk.internal.module.ServicesCatalog;
 49 import jdk.internal.reflect.ConstantPool;
 50 import jdk.internal.vm.Continuation;
 51 import jdk.internal.vm.ContinuationScope;
 52 import jdk.internal.vm.ThreadContainer;
 53 import sun.reflect.annotation.AnnotationType;
 54 import sun.nio.ch.Interruptible;
 55 
 56 public interface JavaLangAccess {
 57 
 58     /**
 59      * Returns the list of {@code Method} objects for the declared public
 60      * methods of this class or interface that have the specified method name
 61      * and parameter types.
 62      */
 63     List<Method> getDeclaredPublicMethods(Class<?> klass, String name, Class<?>... parameterTypes);
 64 
 65     /**
 66      * Return the constant pool for a class.
 67      */
 68     ConstantPool getConstantPool(Class<?> klass);
 69 
 70     /**
 71      * Compare-And-Set the AnnotationType instance corresponding to this class.
 72      * (This method only applies to annotation types.)
 73      */
 74     boolean casAnnotationType(Class<?> klass, AnnotationType oldType, AnnotationType newType);
 75 
 76     /**
 77      * Get the AnnotationType instance corresponding to this class.
 78      * (This method only applies to annotation types.)
 79      */
 80     AnnotationType getAnnotationType(Class<?> klass);
 81 
 82     /**
 83      * Get the declared annotations for a given class, indexed by their types.
 84      */
 85     Map<Class<? extends Annotation>, Annotation> getDeclaredAnnotationMap(Class<?> klass);
 86 
 87     /**
 88      * Get the array of bytes that is the class-file representation
 89      * of this Class' annotations.
 90      */
 91     byte[] getRawClassAnnotations(Class<?> klass);
 92 
 93     /**
 94      * Get the array of bytes that is the class-file representation
 95      * of this Class' type annotations.
 96      */
 97     byte[] getRawClassTypeAnnotations(Class<?> klass);
 98 
 99     /**
100      * Get the array of bytes that is the class-file representation
101      * of this Executable's type annotations.
102      */
103     byte[] getRawExecutableTypeAnnotations(Executable executable);
104 
105     /**
106      * Returns the elements of an enum class or null if the
107      * Class object does not represent an enum type;
108      * the result is uncloned, cached, and shared by all callers.
109      */
110     <E extends Enum<E>> E[] getEnumConstantsShared(Class<E> klass);
111 
112     /**
113      * Set current thread's blocker field.
114      */
115     void blockedOn(Interruptible b);
116 
117     /**
118      * Registers a shutdown hook.
119      *
120      * It is expected that this method with registerShutdownInProgress=true
121      * is only used to register DeleteOnExitHook since the first file
122      * may be added to the delete on exit list by the application shutdown
123      * hooks.
124      *
125      * @param slot  the slot in the shutdown hook array, whose element
126      *              will be invoked in order during shutdown
127      * @param registerShutdownInProgress true to allow the hook
128      *        to be registered even if the shutdown is in progress.
129      * @param hook  the hook to be registered
130      *
131      * @throws IllegalStateException if shutdown is in progress and
132      *         the slot is not valid to register.
133      */
134     void registerShutdownHook(int slot, boolean registerShutdownInProgress, Runnable hook);
135 
136     /**
137      * Returns a new Thread with the given Runnable and an
138      * inherited AccessControlContext.
139      */
140     Thread newThreadWithAcc(Runnable target, @SuppressWarnings("removal") AccessControlContext acc);
141 
142     /**
143      * Invokes the finalize method of the given object.
144      */
145     void invokeFinalize(Object o) throws Throwable;
146 
147     /**
148      * Returns the ConcurrentHashMap used as a storage for ClassLoaderValue(s)
149      * associated with the given class loader, creating it if it doesn't already exist.
150      */
151     ConcurrentHashMap<?, ?> createOrGetClassLoaderValueMap(ClassLoader cl);
152 
153     /**
154      * Defines a class with the given name to a class loader.
155      */
156     Class<?> defineClass(ClassLoader cl, String name, byte[] b, ProtectionDomain pd, String source);
157 
158     /**
159      * Defines a class with the given name to a class loader with
160      * the given flags and class data.
161      *
162      * @see java.lang.invoke.MethodHandles.Lookup#defineClass
163      */
164     Class<?> defineClass(ClassLoader cl, Class<?> lookup, String name, byte[] b, ProtectionDomain pd, boolean initialize, int flags, Object classData);
165 
166     /**
167      * Returns a class loaded by the bootstrap class loader.
168      */
169     Class<?> findBootstrapClassOrNull(String name);
170 
171     /**
172      * Define a Package of the given name and module by the given class loader.
173      */
174     Package definePackage(ClassLoader cl, String name, Module module);
175 
176     /**
177      * Invokes Long.fastUUID
178      */
179     String fastUUID(long lsb, long msb);
180 
181     /**
182      * Record the non-exported packages of the modules in the given layer
183      */
184     void addNonExportedPackages(ModuleLayer layer);
185 
186     /**
187      * Invalidate package access cache
188      */
189     void invalidatePackageAccessCache();
190 
191     /**
192      * Defines a new module to the Java virtual machine. The module
193      * is defined to the given class loader.
194      *
195      * The URI is for information purposes only, it can be {@code null}.
196      */
197     Module defineModule(ClassLoader loader, ModuleDescriptor descriptor, URI uri);
198 
199     /**
200      * Defines the unnamed module for the given class loader.
201      */
202     Module defineUnnamedModule(ClassLoader loader);
203 
204     /**
205      * Updates the readability so that module m1 reads m2. The new read edge
206      * does not result in a strong reference to m2 (m2 can be GC'ed).
207      *
208      * This method is the same as m1.addReads(m2) but without a permission check.
209      */
210     void addReads(Module m1, Module m2);
211 
212     /**
213      * Updates module m to read all unnamed modules.
214      */
215     void addReadsAllUnnamed(Module m);
216 
217     /**
218      * Updates module m1 to export a package unconditionally.
219      */
220     void addExports(Module m1, String pkg);
221 
222     /**
223      * Updates module m1 to export a package to module m2. The export does
224      * not result in a strong reference to m2 (m2 can be GC'ed).
225      */
226     void addExports(Module m1, String pkg, Module m2);
227 
228     /**
229      * Updates a module m to export a package to all unnamed modules.
230      */
231     void addExportsToAllUnnamed(Module m, String pkg);
232 
233     /**
234      * Updates module m1 to open a package to module m2. Opening the
235      * package does not result in a strong reference to m2 (m2 can be GC'ed).
236      */
237     void addOpens(Module m1, String pkg, Module m2);
238 
239     /**
240      * Updates module m to open a package to all unnamed modules.
241      */
242     void addOpensToAllUnnamed(Module m, String pkg);
243 
244     /**
245      * Updates module m to open all packages in the given sets.
246      */
247     void addOpensToAllUnnamed(Module m, Set<String> concealedPkgs, Set<String> exportedPkgs);
248 
249     /**
250      * Updates module m to use a service.
251      */
252     void addUses(Module m, Class<?> service);
253 
254     /**
255      * Returns true if module m reflectively exports a package to other
256      */
257     boolean isReflectivelyExported(Module module, String pn, Module other);
258 
259     /**
260      * Returns true if module m reflectively opens a package to other
261      */
262     boolean isReflectivelyOpened(Module module, String pn, Module other);
263 
264     /**
265      * Updates module m to allow access to restricted methods.
266      */
267     Module addEnableNativeAccess(Module m);
268 
269     /**
270      * Updates all unnamed modules to allow access to restricted methods.
271      */
272     void addEnableNativeAccessAllUnnamed();
273 
274     /**
275      * Returns true if module m can access restricted methods.
276      */
277     boolean isEnableNativeAccess(Module m);
278 
279     /**
280      * Returns the ServicesCatalog for the given Layer.
281      */
282     ServicesCatalog getServicesCatalog(ModuleLayer layer);
283 
284     /**
285      * Record that this layer has at least one module defined to the given
286      * class loader.
287      */
288     void bindToLoader(ModuleLayer layer, ClassLoader loader);
289 
290     /**
291      * Returns an ordered stream of layers. The first element is the
292      * given layer, the remaining elements are its parents, in DFS order.
293      */
294     Stream<ModuleLayer> layers(ModuleLayer layer);
295 
296     /**
297      * Returns a stream of the layers that have modules defined to the
298      * given class loader.
299      */
300     Stream<ModuleLayer> layers(ClassLoader loader);
301 
302     /**
303      * Constructs a new {@code String} by decoding the specified subarray of
304      * bytes using the specified {@linkplain java.nio.charset.Charset charset}.
305      *
306      * The caller of this method shall relinquish and transfer the ownership of
307      * the byte array to the callee since the later will not make a copy.
308      *
309      * @param bytes the byte array source
310      * @param cs the Charset
311      * @return the newly created string
312      * @throws CharacterCodingException for malformed or unmappable bytes
313      */
314     String newStringNoRepl(byte[] bytes, Charset cs) throws CharacterCodingException;
315 
316     /**
317      * Encode the given string into a sequence of bytes using the specified Charset.
318      *
319      * This method avoids copying the String's internal representation if the input
320      * is ASCII.
321      *
322      * This method throws CharacterCodingException instead of replacing when
323      * malformed input or unmappable characters are encountered.
324      *
325      * @param s the string to encode
326      * @param cs the charset
327      * @return the encoded bytes
328      * @throws CharacterCodingException for malformed input or unmappable characters
329      */
330     byte[] getBytesNoRepl(String s, Charset cs) throws CharacterCodingException;
331 
332     /**
333      * Returns a new string by decoding from the given utf8 bytes array.
334      *
335      * @param off the index of the first byte to decode
336      * @param len the number of bytes to decode
337      * @return the newly created string
338      * @throws IllegalArgumentException for malformed or unmappable bytes.
339      */
340     String newStringUTF8NoRepl(byte[] bytes, int off, int len);
341 
342     /**
343      * Encode the given string into a sequence of bytes using utf8.
344      *
345      * @param s the string to encode
346      * @return the encoded bytes in utf8
347      * @throws IllegalArgumentException for malformed surrogates
348      */
349     byte[] getBytesUTF8NoRepl(String s);
350 
351     /**
352      * Inflated copy from byte[] to char[], as defined by StringLatin1.inflate
353      */
354     void inflateBytesToChars(byte[] src, int srcOff, char[] dst, int dstOff, int len);
355 
356     /**
357      * Decodes ASCII from the source byte array into the destination
358      * char array.
359      *
360      * @return the number of bytes successfully decoded, at most len
361      */
362     int decodeASCII(byte[] src, int srcOff, char[] dst, int dstOff, int len);
363 
364     /**
365      * Encodes ASCII codepoints as possible from the source array into
366      * the destination byte array, assuming that the encoding is ASCII
367      * compatible
368      *
369      * @return the number of bytes successfully encoded, or 0 if none
370      */
371     int encodeASCII(char[] src, int srcOff, byte[] dst, int dstOff, int len);
372 
373     /**
374      * Set the cause of Throwable
375      * @param cause set t's cause to new value
376      */
377     void setCause(Throwable t, Throwable cause);
378 
379     /**
380      * Get protection domain of the given Class
381      */
382     ProtectionDomain protectionDomain(Class<?> c);
383 
384     /**
385      * Get a method handle of string concat helper method
386      */
387     MethodHandle stringConcatHelper(String name, MethodType methodType);
388 
389     /**
390      * Get the string concat initial coder
391      */
392     long stringConcatInitialCoder();
393 
394     /**
395      * Update lengthCoder for constant
396      */
397     long stringConcatMix(long lengthCoder, String constant);
398 
399     /**
400      * Join strings
401      */
402     String join(String prefix, String suffix, String delimiter, String[] elements, int size);
403 
404     /*
405      * Get the class data associated with the given class.
406      * @param c the class
407      * @see java.lang.invoke.MethodHandles.Lookup#defineHiddenClass(byte[], boolean, MethodHandles.Lookup.ClassOption...)
408      */
409     Object classData(Class<?> c);
410 
411     long findNative(ClassLoader loader, String entry);
412 
413     /**
414      * Direct access to Shutdown.exit to avoid security manager checks
415      * @param statusCode the status code
416      */
417     void exit(int statusCode);
418     /**
419      * Returns an array of all platform threads.
420      */
421     Thread[] getAllThreads();
422 
423     /**
424      * Returns the ThreadContainer for a thread, may be null.
425      */
426     ThreadContainer threadContainer(Thread thread);
427 
428     /**
429      * Starts a thread in the given ThreadContainer.
430      */
431     void start(Thread thread, ThreadContainer container);
432 
433     /**
434      * Returns the thread container at the head/top of the stack.
435      */
436     ThreadContainer headThreadContainer(Thread thread);
437 
438     /**
439      * Pushes a thread container to the top of the current thread's stack.
440      * @return the current thread's scope local bindings
441      */
442     Object pushThreadContainer(ThreadContainer container);
443 
444     /**
445      * Pops a thread container from the current thread's stack.
446      */
447     void popThreadContainer(ThreadContainer container);
448 
449     /**
450      * Returns a reference to the Thread object for the currently executing
451      * carrier thread.
452      */
453     Thread currentCarrierThread();
454 
455     /**
456      * Executes the given value returning task on the current carrier thread.
457      */
458     <V> V executeOnCarrierThread(Callable<V> task) throws Exception;
459 
460     /**
461      * Returns the value of the current carrier thread's copy of a thread-local.
462      */
463     <T> T getCarrierThreadLocal(ThreadLocal<T> local);
464 
465     /**
466      * Sets the value of the current carrier thread's copy of a thread-local.
467      */
468     <T> void setCarrierThreadLocal(ThreadLocal<T> local, T value);
469 
470     /**
471      * Returns the current thread's scope locals cache
472      */
473     Object[] scopeLocalCache();
474 
475     /**
476      * Sets the current thread's scope locals cache
477      */
478     void setScopeLocalCache(Object[] cache);
479 
480     /**
481      * Returns the innermost mounted continuation
482      */
483      Continuation getContinuation(Thread thread);
484 
485     /**
486      * Sets the innermost mounted continuation
487      */
488     void setContinuation(Thread thread, Continuation continuation);
489 
490     /**
491      * Parks the current virtual thread.
492      */
493     void parkVirtualThread();
494 
495     /**
496      * Parks the current virtual thread for up to the given waiting time.
497      */
498     void parkVirtualThread(long nanos);
499 
500     /**
501      * Unparks a virtual thread.
502      * @throws RejectedExecutionException if the scheduler cannot accept a task
503      */
504     void unparkVirtualThread(Thread thread);
505 
506     /**
507      * Creates a new StackWalker
508      */
509     StackWalker newStackWalkerInstance(Set<StackWalker.Option> options,
510                                        ContinuationScope contScope,
511                                        Continuation continuation);
512 }