1 /* 2 * Copyright (c) 2017, 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 java.lang.runtime; 27 28 import java.lang.invoke.ConstantCallSite; 29 import java.lang.invoke.MethodHandle; 30 import java.lang.invoke.MethodHandles; 31 import java.lang.invoke.MethodType; 32 import java.lang.invoke.TypeDescriptor; 33 import java.security.AccessController; 34 import java.security.PrivilegedAction; 35 import java.util.Arrays; 36 import java.util.HashMap; 37 import java.util.List; 38 import java.util.Objects; 39 40 /** 41 * Bootstrap methods for state-driven implementations of core methods, 42 * including {@link Object#equals(Object)}, {@link Object#hashCode()}, and 43 * {@link Object#toString()}. These methods may be used, for example, by 44 * Java compiler implementations to implement the bodies of {@link Object} 45 * methods for record classes. 46 * 47 * @since 16 48 */ 49 public class ObjectMethods { 50 ObjectMethods()51 private ObjectMethods() { } 52 53 private static final MethodType DESCRIPTOR_MT = MethodType.methodType(MethodType.class); 54 private static final MethodType NAMES_MT = MethodType.methodType(List.class); 55 private static final MethodHandle FALSE = MethodHandles.constant(boolean.class, false); 56 private static final MethodHandle TRUE = MethodHandles.constant(boolean.class, true); 57 private static final MethodHandle ZERO = MethodHandles.constant(int.class, 0); 58 private static final MethodHandle CLASS_IS_INSTANCE; 59 private static final MethodHandle OBJECT_EQUALS; 60 private static final MethodHandle OBJECTS_EQUALS; 61 private static final MethodHandle OBJECTS_HASHCODE; 62 private static final MethodHandle OBJECTS_TOSTRING; 63 private static final MethodHandle OBJECT_EQ; 64 private static final MethodHandle OBJECT_HASHCODE; 65 private static final MethodHandle OBJECT_TO_STRING; 66 private static final MethodHandle STRING_FORMAT; 67 private static final MethodHandle HASH_COMBINER; 68 69 private static final HashMap<Class<?>, MethodHandle> primitiveEquals = new HashMap<>(); 70 private static final HashMap<Class<?>, MethodHandle> primitiveHashers = new HashMap<>(); 71 private static final HashMap<Class<?>, MethodHandle> primitiveToString = new HashMap<>(); 72 73 static { 74 try { 75 Class<ObjectMethods> OBJECT_METHODS_CLASS = ObjectMethods.class; 76 MethodHandles.Lookup publicLookup = MethodHandles.publicLookup(); 77 MethodHandles.Lookup lookup = MethodHandles.lookup(); 78 79 @SuppressWarnings("removal") 80 ClassLoader loader = AccessController.doPrivileged(new PrivilegedAction<ClassLoader>() { 81 @Override public ClassLoader run() { return ClassLoader.getPlatformClassLoader(); } 82 }); 83 84 CLASS_IS_INSTANCE = publicLookup.findVirtual(Class.class, "isInstance", 85 MethodType.methodType(boolean.class, Object.class)); 86 OBJECT_EQUALS = publicLookup.findVirtual(Object.class, "equals", 87 MethodType.methodType(boolean.class, Object.class)); 88 OBJECT_HASHCODE = publicLookup.findVirtual(Object.class, "hashCode", 89 MethodType.fromMethodDescriptorString("()I", loader)); 90 OBJECT_TO_STRING = publicLookup.findVirtual(Object.class, "toString", 91 MethodType.methodType(String.class)); 92 STRING_FORMAT = publicLookup.findStatic(String.class, "format", 93 MethodType.methodType(String.class, String.class, Object[].class)); 94 OBJECTS_EQUALS = publicLookup.findStatic(Objects.class, "equals", 95 MethodType.methodType(boolean.class, Object.class, Object.class)); 96 OBJECTS_HASHCODE = publicLookup.findStatic(Objects.class, "hashCode", 97 MethodType.methodType(int.class, Object.class)); 98 OBJECTS_TOSTRING = publicLookup.findStatic(Objects.class, "toString", 99 MethodType.methodType(String.class, Object.class)); 100 101 OBJECT_EQ = lookup.findStatic(OBJECT_METHODS_CLASS, "eq", 102 MethodType.methodType(boolean.class, Object.class, Object.class)); 103 HASH_COMBINER = lookup.findStatic(OBJECT_METHODS_CLASS, "hashCombiner", 104 MethodType.fromMethodDescriptorString("(II)I", loader)); 105 primitiveEquals.put(byte.class, lookup.findStatic(OBJECT_METHODS_CLASS, R, MethodType.fromMethodDescriptorString(R, loader)))106 primitiveEquals.put(byte.class, lookup.findStatic(OBJECT_METHODS_CLASS, "eq", 107 MethodType.fromMethodDescriptorString("(BB)Z", loader))); primitiveEquals.put(short.class, lookup.findStatic(OBJECT_METHODS_CLASS, R, MethodType.fromMethodDescriptorString(R, loader)))108 primitiveEquals.put(short.class, lookup.findStatic(OBJECT_METHODS_CLASS, "eq", 109 MethodType.fromMethodDescriptorString("(SS)Z", loader))); primitiveEquals.put(char.class, lookup.findStatic(OBJECT_METHODS_CLASS, R, MethodType.fromMethodDescriptorString(R, loader)))110 primitiveEquals.put(char.class, lookup.findStatic(OBJECT_METHODS_CLASS, "eq", 111 MethodType.fromMethodDescriptorString("(CC)Z", loader))); primitiveEquals.put(int.class, lookup.findStatic(OBJECT_METHODS_CLASS, R, MethodType.fromMethodDescriptorString(R, loader)))112 primitiveEquals.put(int.class, lookup.findStatic(OBJECT_METHODS_CLASS, "eq", 113 MethodType.fromMethodDescriptorString("(II)Z", loader))); primitiveEquals.put(long.class, lookup.findStatic(OBJECT_METHODS_CLASS, R, MethodType.fromMethodDescriptorString(R, loader)))114 primitiveEquals.put(long.class, lookup.findStatic(OBJECT_METHODS_CLASS, "eq", 115 MethodType.fromMethodDescriptorString("(JJ)Z", loader))); primitiveEquals.put(float.class, lookup.findStatic(OBJECT_METHODS_CLASS, R, MethodType.fromMethodDescriptorString(R, loader)))116 primitiveEquals.put(float.class, lookup.findStatic(OBJECT_METHODS_CLASS, "eq", 117 MethodType.fromMethodDescriptorString("(FF)Z", loader))); primitiveEquals.put(double.class, lookup.findStatic(OBJECT_METHODS_CLASS, R, MethodType.fromMethodDescriptorString(R, loader)))118 primitiveEquals.put(double.class, lookup.findStatic(OBJECT_METHODS_CLASS, "eq", 119 MethodType.fromMethodDescriptorString("(DD)Z", loader))); primitiveEquals.put(boolean.class, lookup.findStatic(OBJECT_METHODS_CLASS, R, MethodType.fromMethodDescriptorString(R, loader)))120 primitiveEquals.put(boolean.class, lookup.findStatic(OBJECT_METHODS_CLASS, "eq", 121 MethodType.fromMethodDescriptorString("(ZZ)Z", loader))); 122 primitiveHashers.put(byte.class, lookup.findStatic(Byte.class, R, MethodType.fromMethodDescriptorString(R, loader)))123 primitiveHashers.put(byte.class, lookup.findStatic(Byte.class, "hashCode", 124 MethodType.fromMethodDescriptorString("(B)I", loader))); primitiveHashers.put(short.class, lookup.findStatic(Short.class, R, MethodType.fromMethodDescriptorString(R, loader)))125 primitiveHashers.put(short.class, lookup.findStatic(Short.class, "hashCode", 126 MethodType.fromMethodDescriptorString("(S)I", loader))); primitiveHashers.put(char.class, lookup.findStatic(Character.class, R, MethodType.fromMethodDescriptorString(R, loader)))127 primitiveHashers.put(char.class, lookup.findStatic(Character.class, "hashCode", 128 MethodType.fromMethodDescriptorString("(C)I", loader))); primitiveHashers.put(int.class, lookup.findStatic(Integer.class, R, MethodType.fromMethodDescriptorString(R, loader)))129 primitiveHashers.put(int.class, lookup.findStatic(Integer.class, "hashCode", 130 MethodType.fromMethodDescriptorString("(I)I", loader))); primitiveHashers.put(long.class, lookup.findStatic(Long.class, R, MethodType.fromMethodDescriptorString(R, loader)))131 primitiveHashers.put(long.class, lookup.findStatic(Long.class, "hashCode", 132 MethodType.fromMethodDescriptorString("(J)I", loader))); primitiveHashers.put(float.class, lookup.findStatic(Float.class, R, MethodType.fromMethodDescriptorString(R, loader)))133 primitiveHashers.put(float.class, lookup.findStatic(Float.class, "hashCode", 134 MethodType.fromMethodDescriptorString("(F)I", loader))); primitiveHashers.put(double.class, lookup.findStatic(Double.class, R, MethodType.fromMethodDescriptorString(R, loader)))135 primitiveHashers.put(double.class, lookup.findStatic(Double.class, "hashCode", 136 MethodType.fromMethodDescriptorString("(D)I", loader))); primitiveHashers.put(boolean.class, lookup.findStatic(Boolean.class, R, MethodType.fromMethodDescriptorString(R, loader)))137 primitiveHashers.put(boolean.class, lookup.findStatic(Boolean.class, "hashCode", 138 MethodType.fromMethodDescriptorString("(Z)I", loader))); 139 primitiveToString.put(byte.class, lookup.findStatic(Byte.class, R, MethodType.methodType(String.class, byte.class)))140 primitiveToString.put(byte.class, lookup.findStatic(Byte.class, "toString", 141 MethodType.methodType(String.class, byte.class))); primitiveToString.put(short.class, lookup.findStatic(Short.class, R, MethodType.methodType(String.class, short.class)))142 primitiveToString.put(short.class, lookup.findStatic(Short.class, "toString", 143 MethodType.methodType(String.class, short.class))); primitiveToString.put(char.class, lookup.findStatic(Character.class, R, MethodType.methodType(String.class, char.class)))144 primitiveToString.put(char.class, lookup.findStatic(Character.class, "toString", 145 MethodType.methodType(String.class, char.class))); primitiveToString.put(int.class, lookup.findStatic(Integer.class, R, MethodType.methodType(String.class, int.class)))146 primitiveToString.put(int.class, lookup.findStatic(Integer.class, "toString", 147 MethodType.methodType(String.class, int.class))); primitiveToString.put(long.class, lookup.findStatic(Long.class, R, MethodType.methodType(String.class, long.class)))148 primitiveToString.put(long.class, lookup.findStatic(Long.class, "toString", 149 MethodType.methodType(String.class, long.class))); primitiveToString.put(float.class, lookup.findStatic(Float.class, R, MethodType.methodType(String.class, float.class)))150 primitiveToString.put(float.class, lookup.findStatic(Float.class, "toString", 151 MethodType.methodType(String.class, float.class))); primitiveToString.put(double.class, lookup.findStatic(Double.class, R, MethodType.methodType(String.class, double.class)))152 primitiveToString.put(double.class, lookup.findStatic(Double.class, "toString", 153 MethodType.methodType(String.class, double.class))); primitiveToString.put(boolean.class, lookup.findStatic(Boolean.class, R, MethodType.methodType(String.class, boolean.class)))154 primitiveToString.put(boolean.class, lookup.findStatic(Boolean.class, "toString", 155 MethodType.methodType(String.class, boolean.class))); 156 } 157 catch (ReflectiveOperationException e) { 158 throw new RuntimeException(e); 159 } 160 } 161 hashCombiner(int x, int y)162 private static int hashCombiner(int x, int y) { 163 return x*31 + y; 164 } 165 eq(Object a, Object b)166 private static boolean eq(Object a, Object b) { return a == b; } eq(byte a, byte b)167 private static boolean eq(byte a, byte b) { return a == b; } eq(short a, short b)168 private static boolean eq(short a, short b) { return a == b; } eq(char a, char b)169 private static boolean eq(char a, char b) { return a == b; } eq(int a, int b)170 private static boolean eq(int a, int b) { return a == b; } eq(long a, long b)171 private static boolean eq(long a, long b) { return a == b; } eq(float a, float b)172 private static boolean eq(float a, float b) { return Float.compare(a, b) == 0; } eq(double a, double b)173 private static boolean eq(double a, double b) { return Double.compare(a, b) == 0; } eq(boolean a, boolean b)174 private static boolean eq(boolean a, boolean b) { return a == b; } 175 176 /** Get the method handle for combining two values of a given type */ equalator(Class<?> clazz)177 private static MethodHandle equalator(Class<?> clazz) { 178 return (clazz.isPrimitive() 179 ? primitiveEquals.get(clazz) 180 : OBJECTS_EQUALS.asType(MethodType.methodType(boolean.class, clazz, clazz))); 181 } 182 183 /** Get the hasher for a value of a given type */ hasher(Class<?> clazz)184 private static MethodHandle hasher(Class<?> clazz) { 185 return (clazz.isPrimitive() 186 ? primitiveHashers.get(clazz) 187 : OBJECTS_HASHCODE.asType(MethodType.methodType(int.class, clazz))); 188 } 189 190 /** Get the stringifier for a value of a given type */ stringifier(Class<?> clazz)191 private static MethodHandle stringifier(Class<?> clazz) { 192 return (clazz.isPrimitive() 193 ? primitiveToString.get(clazz) 194 : OBJECTS_TOSTRING.asType(MethodType.methodType(String.class, clazz))); 195 } 196 197 /** 198 * Generates a method handle for the {@code equals} method for a given data class 199 * @param receiverClass the data class 200 * @param getters the list of getters 201 * @return the method handle 202 */ makeEquals(Class<?> receiverClass, List<MethodHandle> getters)203 private static MethodHandle makeEquals(Class<?> receiverClass, 204 List<MethodHandle> getters) { 205 MethodType rr = MethodType.methodType(boolean.class, receiverClass, receiverClass); 206 MethodType ro = MethodType.methodType(boolean.class, receiverClass, Object.class); 207 MethodHandle instanceFalse = MethodHandles.dropArguments(FALSE, 0, receiverClass, Object.class); // (RO)Z 208 MethodHandle instanceTrue = MethodHandles.dropArguments(TRUE, 0, receiverClass, Object.class); // (RO)Z 209 MethodHandle isSameObject = OBJECT_EQ.asType(ro); // (RO)Z 210 MethodHandle isInstance = MethodHandles.dropArguments(CLASS_IS_INSTANCE.bindTo(receiverClass), 0, receiverClass); // (RO)Z 211 MethodHandle accumulator = MethodHandles.dropArguments(TRUE, 0, receiverClass, receiverClass); // (RR)Z 212 213 for (MethodHandle getter : getters) { 214 MethodHandle equalator = equalator(getter.type().returnType()); // (TT)Z 215 MethodHandle thisFieldEqual = MethodHandles.filterArguments(equalator, 0, getter, getter); // (RR)Z 216 accumulator = MethodHandles.guardWithTest(thisFieldEqual, accumulator, instanceFalse.asType(rr)); 217 } 218 219 return MethodHandles.guardWithTest(isSameObject, 220 instanceTrue, 221 MethodHandles.guardWithTest(isInstance, accumulator.asType(ro), instanceFalse)); 222 } 223 224 /** 225 * Generates a method handle for the {@code hashCode} method for a given data class 226 * @param receiverClass the data class 227 * @param getters the list of getters 228 * @return the method handle 229 */ makeHashCode(Class<?> receiverClass, List<MethodHandle> getters)230 private static MethodHandle makeHashCode(Class<?> receiverClass, 231 List<MethodHandle> getters) { 232 MethodHandle accumulator = MethodHandles.dropArguments(ZERO, 0, receiverClass); // (R)I 233 234 // @@@ Use loop combinator instead? 235 for (MethodHandle getter : getters) { 236 MethodHandle hasher = hasher(getter.type().returnType()); // (T)I 237 MethodHandle hashThisField = MethodHandles.filterArguments(hasher, 0, getter); // (R)I 238 MethodHandle combineHashes = MethodHandles.filterArguments(HASH_COMBINER, 0, accumulator, hashThisField); // (RR)I 239 accumulator = MethodHandles.permuteArguments(combineHashes, accumulator.type(), 0, 0); // adapt (R)I to (RR)I 240 } 241 242 return accumulator; 243 } 244 245 /** 246 * Generates a method handle for the {@code toString} method for a given data class 247 * @param receiverClass the data class 248 * @param getters the list of getters 249 * @param names the names 250 * @return the method handle 251 */ makeToString(Class<?> receiverClass, List<MethodHandle> getters, List<String> names)252 private static MethodHandle makeToString(Class<?> receiverClass, 253 List<MethodHandle> getters, 254 List<String> names) { 255 // This is a pretty lousy algorithm; we spread the receiver over N places, 256 // apply the N getters, apply N toString operations, and concat the result with String.format 257 // Better to use String.format directly, or delegate to StringConcatFactory 258 // Also probably want some quoting around String components 259 260 assert getters.size() == names.size(); 261 262 int[] invArgs = new int[getters.size()]; 263 Arrays.fill(invArgs, 0); 264 MethodHandle[] filters = new MethodHandle[getters.size()]; 265 StringBuilder sb = new StringBuilder(); 266 sb.append(receiverClass.getSimpleName()).append("["); 267 for (int i=0; i<getters.size(); i++) { 268 MethodHandle getter = getters.get(i); // (R)T 269 MethodHandle stringify = stringifier(getter.type().returnType()); // (T)String 270 MethodHandle stringifyThisField = MethodHandles.filterArguments(stringify, 0, getter); // (R)String 271 filters[i] = stringifyThisField; 272 sb.append(names.get(i)).append("=%s"); 273 if (i != getters.size() - 1) 274 sb.append(", "); 275 } 276 sb.append(']'); 277 String formatString = sb.toString(); 278 MethodHandle formatter = MethodHandles.insertArguments(STRING_FORMAT, 0, formatString) 279 .asCollector(String[].class, getters.size()); // (R*)String 280 if (getters.size() == 0) { 281 // Add back extra R 282 formatter = MethodHandles.dropArguments(formatter, 0, receiverClass); 283 } 284 else { 285 MethodHandle filtered = MethodHandles.filterArguments(formatter, 0, filters); 286 formatter = MethodHandles.permuteArguments(filtered, MethodType.methodType(String.class, receiverClass), invArgs); 287 } 288 289 return formatter; 290 } 291 292 /** 293 * Bootstrap method to generate the {@link Object#equals(Object)}, 294 * {@link Object#hashCode()}, and {@link Object#toString()} methods, based 295 * on a description of the component names and accessor methods, for either 296 * {@code invokedynamic} call sites or dynamic constant pool entries. 297 * 298 * For more detail on the semantics of the generated methods see the specification 299 * of {@link java.lang.Record#equals(Object)}, {@link java.lang.Record#hashCode()} and 300 * {@link java.lang.Record#toString()}. 301 * 302 * 303 * @param lookup Every bootstrap method is expected to have a {@code lookup} 304 * which usually represents a lookup context with the 305 * accessibility privileges of the caller. This is because 306 * {@code invokedynamic} call sites always provide a {@code lookup} 307 * to the corresponding bootstrap method, but this method just 308 * ignores the {@code lookup} parameter 309 * @param methodName the name of the method to generate, which must be one of 310 * {@code "equals"}, {@code "hashCode"}, or {@code "toString"} 311 * @param type a {@link MethodType} corresponding the descriptor type 312 * for the method, which must correspond to the descriptor 313 * for the corresponding {@link Object} method, if linking 314 * an {@code invokedynamic} call site, or the 315 * constant {@code MethodHandle.class}, if linking a 316 * dynamic constant 317 * @param recordClass the record class hosting the record components 318 * @param names the list of component names, joined into a string 319 * separated by ";", or the empty string if there are no 320 * components. Maybe be null, if the {@code methodName} 321 * is {@code "equals"} or {@code "hashCode"}. 322 * @param getters method handles for the accessor methods for the components 323 * @return a call site if invoked by indy, or a method handle 324 * if invoked by a condy 325 * @throws IllegalArgumentException if the bootstrap arguments are invalid 326 * or inconsistent 327 * @throws Throwable if any exception is thrown during call site construction 328 */ bootstrap(MethodHandles.Lookup lookup, String methodName, TypeDescriptor type, Class<?> recordClass, String names, MethodHandle... getters)329 public static Object bootstrap(MethodHandles.Lookup lookup, String methodName, TypeDescriptor type, 330 Class<?> recordClass, 331 String names, 332 MethodHandle... getters) throws Throwable { 333 MethodType methodType; 334 if (type instanceof MethodType) 335 methodType = (MethodType) type; 336 else { 337 methodType = null; 338 if (!MethodHandle.class.equals(type)) 339 throw new IllegalArgumentException(type.toString()); 340 } 341 List<MethodHandle> getterList = List.of(getters); 342 MethodHandle handle = switch (methodName) { 343 case "equals" -> { 344 if (methodType != null && !methodType.equals(MethodType.methodType(boolean.class, recordClass, Object.class))) 345 throw new IllegalArgumentException("Bad method type: " + methodType); 346 yield makeEquals(recordClass, getterList); 347 } 348 case "hashCode" -> { 349 if (methodType != null && !methodType.equals(MethodType.methodType(int.class, recordClass))) 350 throw new IllegalArgumentException("Bad method type: " + methodType); 351 yield makeHashCode(recordClass, getterList); 352 } 353 case "toString" -> { 354 if (methodType != null && !methodType.equals(MethodType.methodType(String.class, recordClass))) 355 throw new IllegalArgumentException("Bad method type: " + methodType); 356 List<String> nameList = "".equals(names) ? List.of() : List.of(names.split(";")); 357 if (nameList.size() != getterList.size()) 358 throw new IllegalArgumentException("Name list and accessor list do not match"); 359 yield makeToString(recordClass, getterList, nameList); 360 } 361 default -> throw new IllegalArgumentException(methodName); 362 }; 363 return methodType != null ? new ConstantCallSite(handle) : handle; 364 } 365 } 366