|
| 1 | +/* |
| 2 | + * Copyright (c) 2023, 2023, 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 | +package com.oracle.graal.pointsto; |
| 26 | + |
| 27 | +import java.lang.reflect.Executable; |
| 28 | +import java.lang.reflect.Field; |
| 29 | +import java.lang.reflect.Member; |
| 30 | +import java.lang.reflect.Modifier; |
| 31 | + |
| 32 | +import org.graalvm.nativeimage.AnnotationAccess; |
| 33 | + |
| 34 | +import com.oracle.graal.pointsto.meta.AnalysisMethod; |
| 35 | + |
| 36 | +import jdk.graal.compiler.api.replacements.Fold; |
| 37 | + |
| 38 | +/** |
| 39 | + * Policy used to determine which classes, methods and fields need to be included in the image when |
| 40 | + * the {@code IncludeAllFromPath} and/or {@code IncludeAllFromModule} options are specified |
| 41 | + * depending on the configuration. |
| 42 | + */ |
| 43 | +public abstract class ClassInclusionPolicy { |
| 44 | + protected BigBang bb; |
| 45 | + protected final Object reason; |
| 46 | + |
| 47 | + public ClassInclusionPolicy(Object reason) { |
| 48 | + this.reason = reason; |
| 49 | + } |
| 50 | + |
| 51 | + public void setBigBang(BigBang bb) { |
| 52 | + this.bb = bb; |
| 53 | + } |
| 54 | + |
| 55 | + /** |
| 56 | + * Determine if the given class needs to be included in the image according to the policy. |
| 57 | + */ |
| 58 | + public abstract boolean isClassIncluded(Class<?> cls); |
| 59 | + |
| 60 | + /** |
| 61 | + * Determine if the given method needs to be included in the image according to the policy. |
| 62 | + */ |
| 63 | + public boolean isMethodIncluded(Executable method) { |
| 64 | + /* |
| 65 | + * Methods annotated with @Fold should not be included in the base image as they must be |
| 66 | + * inlined. An extension image would inline the method as well and would not use the method |
| 67 | + * from the base image. |
| 68 | + */ |
| 69 | + return !AnnotationAccess.isAnnotationPresent(bb.getMetaAccess().lookupJavaMethod(method), Fold.class); |
| 70 | + } |
| 71 | + |
| 72 | + /** |
| 73 | + * Determine if the given field needs to be included in the image according to the policy. |
| 74 | + */ |
| 75 | + public boolean isFieldIncluded(Field field) { |
| 76 | + if (!bb.getHostVM().platformSupported(field)) { |
| 77 | + return false; |
| 78 | + } |
| 79 | + return bb.getHostVM().isFieldIncluded(bb, field); |
| 80 | + } |
| 81 | + |
| 82 | + /** |
| 83 | + * Includes the given class in the image. |
| 84 | + */ |
| 85 | + public void includeClass(Class<?> cls) { |
| 86 | + /* |
| 87 | + * Those classes cannot be registered as allocated as they cannot be instantiated. They are |
| 88 | + * instead registered as reachable as they can still have methods or fields that could be |
| 89 | + * used by an extension image. |
| 90 | + */ |
| 91 | + if (Modifier.isAbstract(cls.getModifiers()) || cls.isInterface() || cls.isPrimitive()) { |
| 92 | + bb.getMetaAccess().lookupJavaType(cls).registerAsReachable(reason); |
| 93 | + } else { |
| 94 | + bb.getMetaAccess().lookupJavaType(cls).registerAsAllocated(reason); |
| 95 | + } |
| 96 | + } |
| 97 | + |
| 98 | + /** |
| 99 | + * Includes the given method in the image. |
| 100 | + */ |
| 101 | + public abstract void includeMethod(Executable method); |
| 102 | + |
| 103 | + /** |
| 104 | + * Includes the given field in the image. |
| 105 | + */ |
| 106 | + public void includeField(Field field) { |
| 107 | + bb.postTask(debug -> bb.addRootField(field)); |
| 108 | + } |
| 109 | + |
| 110 | + /** |
| 111 | + * The analysis for the base layer of a layered image assumes that any method that is reachable |
| 112 | + * using the base java access rules can be an entry point. An upper layer does not have access |
| 113 | + * to the packages from a lower layer. Thus, only the public classes with their public and |
| 114 | + * protected inner classes and methods can be accessed by an upper layer. |
| 115 | + * <p> |
| 116 | + * Protected elements from a final or sealed class cannot be accessed as an upper layer cannot |
| 117 | + * create a new class that extends the final or sealed class. |
| 118 | + * <p> |
| 119 | + * All the fields are included disregarding access rules as a missing field would cause issues |
| 120 | + * in the object layout. |
| 121 | + */ |
| 122 | + public static class LayeredBaseImageInclusionPolicy extends ClassInclusionPolicy { |
| 123 | + public LayeredBaseImageInclusionPolicy(Object reason) { |
| 124 | + super(reason); |
| 125 | + } |
| 126 | + |
| 127 | + @Override |
| 128 | + public boolean isClassIncluded(Class<?> cls) { |
| 129 | + Class<?> enclosingClass = cls.getEnclosingClass(); |
| 130 | + int classModifiers = cls.getModifiers(); |
| 131 | + if (enclosingClass != null) { |
| 132 | + return isAccessible(enclosingClass, classModifiers) && isClassIncluded(enclosingClass); |
| 133 | + } else { |
| 134 | + return Modifier.isPublic(classModifiers); |
| 135 | + } |
| 136 | + } |
| 137 | + |
| 138 | + @Override |
| 139 | + public boolean isMethodIncluded(Executable method) { |
| 140 | + return !Modifier.isAbstract(method.getModifiers()) && isAccessible(method) && super.isMethodIncluded(method); |
| 141 | + } |
| 142 | + |
| 143 | + @Override |
| 144 | + public void includeMethod(Executable method) { |
| 145 | + bb.postTask(debug -> { |
| 146 | + /* |
| 147 | + * Non-abstract methods from an abstract class or default methods from an interface |
| 148 | + * are not registered as implementation invoked by the analysis because their |
| 149 | + * declaring class cannot be marked as instantiated and AnalysisType.getTypeFlow |
| 150 | + * only includes instantiated types (see TypeFlow.addObserver). For now, to ensure |
| 151 | + * those methods are included in the image, they are manually registered as |
| 152 | + * implementation invoked. |
| 153 | + */ |
| 154 | + Class<?> declaringClass = method.getDeclaringClass(); |
| 155 | + if (!Modifier.isAbstract(method.getModifiers()) && (declaringClass.isInterface() || Modifier.isAbstract(declaringClass.getModifiers()))) { |
| 156 | + AnalysisMethod analysisMethod = bb.getMetaAccess().lookupJavaMethod(method); |
| 157 | + analysisMethod.registerAsDirectRootMethod(reason); |
| 158 | + analysisMethod.registerAsImplementationInvoked(reason); |
| 159 | + } |
| 160 | + bb.forcedAddRootMethod(method, false, reason); |
| 161 | + }); |
| 162 | + } |
| 163 | + } |
| 164 | + |
| 165 | + /** |
| 166 | + * The default inclusion policy. Includes all classes and methods. Including all fields causes |
| 167 | + * issues at the moment, so the same rules as for the {@link LayeredBaseImageInclusionPolicy} |
| 168 | + * are used. |
| 169 | + */ |
| 170 | + public static class DefaultAllInclusionPolicy extends ClassInclusionPolicy { |
| 171 | + public DefaultAllInclusionPolicy(Object reason) { |
| 172 | + super(reason); |
| 173 | + } |
| 174 | + |
| 175 | + @Override |
| 176 | + public boolean isClassIncluded(Class<?> cls) { |
| 177 | + return true; |
| 178 | + } |
| 179 | + |
| 180 | + @Override |
| 181 | + public void includeMethod(Executable method) { |
| 182 | + bb.postTask(debug -> bb.addRootMethod(method, false, reason)); |
| 183 | + } |
| 184 | + } |
| 185 | + |
| 186 | + protected boolean isAccessible(Member member) { |
| 187 | + Class<?> cls = member.getDeclaringClass(); |
| 188 | + int modifiers = member.getModifiers(); |
| 189 | + return isAccessible(cls, modifiers); |
| 190 | + } |
| 191 | + |
| 192 | + protected boolean isAccessible(Class<?> cls, int modifiers) { |
| 193 | + return Modifier.isPublic(modifiers) || (!Modifier.isFinal(cls.getModifiers()) && !cls.isSealed() && Modifier.isProtected(modifiers)); |
| 194 | + } |
| 195 | +} |
0 commit comments