|
| 1 | +/* |
| 2 | + * Copyright (c) 2025, Oracle and/or its affiliates. All rights reserved. |
| 3 | + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| 4 | + * |
| 5 | + * The Universal Permissive License (UPL), Version 1.0 |
| 6 | + * |
| 7 | + * Subject to the condition set forth below, permission is hereby granted to any |
| 8 | + * person obtaining a copy of this software, associated documentation and/or |
| 9 | + * data (collectively the "Software"), free of charge and under any and all |
| 10 | + * copyright rights in the Software, and any and all patent rights owned or |
| 11 | + * freely licensable by each licensor hereunder covering either (i) the |
| 12 | + * unmodified Software as contributed to or provided by such licensor, or (ii) |
| 13 | + * the Larger Works (as defined below), to deal in both |
| 14 | + * |
| 15 | + * (a) the Software, and |
| 16 | + * |
| 17 | + * (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if |
| 18 | + * one is included with the Software each a "Larger Work" to which the Software |
| 19 | + * is contributed by such licensors), |
| 20 | + * |
| 21 | + * without restriction, including without limitation the rights to copy, create |
| 22 | + * derivative works of, display, perform, and distribute the Software and make, |
| 23 | + * use, sell, offer for sale, import, export, have made, and have sold the |
| 24 | + * Software and the Larger Work(s), and to sublicense the foregoing rights on |
| 25 | + * either these or other terms. |
| 26 | + * |
| 27 | + * This license is subject to the following condition: |
| 28 | + * |
| 29 | + * The above copyright notice and either this complete permission notice or at a |
| 30 | + * minimum a reference to the UPL must be included in all copies or substantial |
| 31 | + * portions of the Software. |
| 32 | + * |
| 33 | + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 34 | + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 35 | + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 36 | + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 37 | + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 38 | + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
| 39 | + * SOFTWARE. |
| 40 | + */ |
| 41 | +package org.graalvm.nativeimage.dynamicaccess; |
| 42 | + |
| 43 | +import org.graalvm.nativeimage.impl.TypeReachabilityCondition; |
| 44 | + |
| 45 | +/** |
| 46 | + * A condition that must be satisfied to register elements for dynamic access (i.e., reflection, |
| 47 | + * serialization, JNI access, resource access, and foreign access at run time). Conditions should be |
| 48 | + * used whenever possible to constrain unnecessary growth of the binary size. |
| 49 | + * <p> |
| 50 | + * There are currently two types of conditions: |
| 51 | + * <ul> |
| 52 | + * <li>{@link #typeReached} - satisfied when the type is both reachable by static analysis at build |
| 53 | + * time, and reached at run time.</li> |
| 54 | + * <li>{@link #unconditional} - a condition that is always satisfied. This condition should be |
| 55 | + * avoided to prevent unnecessary increases in binary size.</li> |
| 56 | + * </ul> |
| 57 | + * <p> |
| 58 | + * Conditions can only be created via the {@link #unconditional} and {@link #typeReached} factory |
| 59 | + * methods. These methods are best used with static import methods. For example: |
| 60 | + * |
| 61 | + * <pre>{@code |
| 62 | + * reflection.register(unconditional(), ReflectivelyAccessed.class); |
| 63 | + * reflection.register(typeReached(ConditionalType.class), ConditionallyAccessed.class) |
| 64 | + * }</pre> |
| 65 | + * |
| 66 | + * @since 25.0.1 |
| 67 | + */ |
| 68 | +public interface AccessCondition { |
| 69 | + |
| 70 | + /** |
| 71 | + * Returns a condition that is always satisfied. Any element that is predicated with this |
| 72 | + * condition will always be included and accessible. |
| 73 | + * |
| 74 | + * @return instance of the condition |
| 75 | + * |
| 76 | + * @since 25.0.1 |
| 77 | + */ |
| 78 | + static AccessCondition unconditional() { |
| 79 | + return TypeReachabilityCondition.JAVA_LANG_OBJECT_REACHED; |
| 80 | + } |
| 81 | + |
| 82 | + /** |
| 83 | + * Creates the {@code typeReached} condition that is satisfied when the type is reached at run |
| 84 | + * time. A type is reached at run time, if the class-initialization is triggered for that type |
| 85 | + * (right before the first step of initialization described in |
| 86 | + * <a href="https://docs.oracle.com/javase/specs/jvms/se14/html/jvms-5.html#jvms-5.5">Java Spec |
| 87 | + * - Initialization</a>), or any of the type's subtypes are reached. Elements predicated with |
| 88 | + * this condition will be included in the image only if the type is <em>reachable</em> at build |
| 89 | + * time, but will be accessible when the type is <em>reached</em> at run time. |
| 90 | + * <p> |
| 91 | + * <strong>Example:</strong> |
| 92 | + * |
| 93 | + * <pre>{@code |
| 94 | + * public class App { |
| 95 | + * public static void main(String[] args) { |
| 96 | + * // ConditionalType not reached => element access not allowed |
| 97 | + * Class<?> clazz = ConditionalType.class; |
| 98 | + * // ConditionalType not reached (ConditionalType.class doesn't start class initialization) |
| 99 | + * // => element access not allowed |
| 100 | + * ConditionalType.singleton(); |
| 101 | + * // ConditionalType reached (already initialized) => element access allowed |
| 102 | + * } |
| 103 | + * } |
| 104 | + * |
| 105 | + * class SuperType { |
| 106 | + * static { |
| 107 | + * // ConditionalType reached (subtype reached) => element access allowed |
| 108 | + * } |
| 109 | + * } |
| 110 | + * |
| 111 | + * class ConditionalType extends SuperType { |
| 112 | + * static { |
| 113 | + * // ConditionalType reached (before static initializer) => element access allowed |
| 114 | + * } |
| 115 | + * |
| 116 | + * static ConditionalType singleton() { |
| 117 | + * // ConditionalType reached (already initialized) => element access allowed |
| 118 | + * } |
| 119 | + * } |
| 120 | + * }</pre> |
| 121 | + * <p> |
| 122 | + * A type is also considered as reached, if it is marked as {@code --initialize-at-build-time} |
| 123 | + * or if any of its subtypes on the classpath are marked as {@code --initialize-at-build-time}. |
| 124 | + * Array types (e.g., <code>int[]</code>) are never marked as reached and therefore cannot be |
| 125 | + * used as the <code>type</code> in a condition. |
| 126 | + * |
| 127 | + * @param type the type that has to be reached for this condition to be satisfied, must not be |
| 128 | + * {@code null} |
| 129 | + * |
| 130 | + * @return instance of the condition |
| 131 | + * |
| 132 | + * @since 25.0.1 |
| 133 | + */ |
| 134 | + static AccessCondition typeReached(Class<?> type) { |
| 135 | + return TypeReachabilityCondition.create(type, true); |
| 136 | + } |
| 137 | +} |
0 commit comments