1 /* 2 * Copyright (c) 2015, 2016, 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. 8 * 9 * This code is distributed in the hope that it will be useful, but WITHOUT 10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 12 * version 2 for more details (a copy is included in the LICENSE file that 13 * accompanied this code). 14 * 15 * You should have received a copy of the GNU General Public License version 16 * 2 along with this work; if not, write to the Free Software Foundation, 17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 18 * 19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 20 * or visit www.oracle.com if you need additional information or have any 21 * questions. 22 */ 23 24 25 package org.graalvm.compiler.replacements.amd64; 26 27 import static org.graalvm.compiler.replacements.StandardGraphBuilderPlugins.registerPlatformSpecificUnsafePlugins; 28 import static org.graalvm.compiler.replacements.nodes.BinaryMathIntrinsicNode.BinaryOperation.POW; 29 import static org.graalvm.compiler.replacements.nodes.UnaryMathIntrinsicNode.UnaryOperation.COS; 30 import static org.graalvm.compiler.replacements.nodes.UnaryMathIntrinsicNode.UnaryOperation.EXP; 31 import static org.graalvm.compiler.replacements.nodes.UnaryMathIntrinsicNode.UnaryOperation.LOG; 32 import static org.graalvm.compiler.replacements.nodes.UnaryMathIntrinsicNode.UnaryOperation.LOG10; 33 import static org.graalvm.compiler.replacements.nodes.UnaryMathIntrinsicNode.UnaryOperation.SIN; 34 import static org.graalvm.compiler.replacements.nodes.UnaryMathIntrinsicNode.UnaryOperation.TAN; 35 import static org.graalvm.compiler.serviceprovider.GraalServices.JAVA_SPECIFICATION_VERSION; 36 import static org.graalvm.compiler.serviceprovider.GraalServices.Java11OrEarlier; 37 import static org.graalvm.compiler.serviceprovider.GraalServices.Java8OrEarlier; 38 39 import java.util.Arrays; 40 41 import org.graalvm.compiler.bytecode.BytecodeProvider; 42 import org.graalvm.compiler.lir.amd64.AMD64ArithmeticLIRGeneratorTool.RoundingMode; 43 import org.graalvm.compiler.nodes.ValueNode; 44 import org.graalvm.compiler.nodes.graphbuilderconf.GraphBuilderConfiguration.Plugins; 45 import org.graalvm.compiler.nodes.graphbuilderconf.GraphBuilderContext; 46 import org.graalvm.compiler.nodes.graphbuilderconf.InvocationPlugin; 47 import org.graalvm.compiler.nodes.graphbuilderconf.InvocationPlugin.Receiver; 48 import org.graalvm.compiler.nodes.graphbuilderconf.InvocationPlugins; 49 import org.graalvm.compiler.nodes.graphbuilderconf.InvocationPlugins.Registration; 50 import org.graalvm.compiler.nodes.java.AtomicReadAndAddNode; 51 import org.graalvm.compiler.nodes.java.AtomicReadAndWriteNode; 52 import org.graalvm.compiler.nodes.memory.address.OffsetAddressNode; 53 import org.graalvm.compiler.replacements.ArraysSubstitutions; 54 import org.graalvm.compiler.replacements.IntegerSubstitutions; 55 import org.graalvm.compiler.replacements.LongSubstitutions; 56 import org.graalvm.compiler.replacements.StandardGraphBuilderPlugins.UnsafeAccessPlugin; 57 import org.graalvm.compiler.replacements.StandardGraphBuilderPlugins.UnsafeGetPlugin; 58 import org.graalvm.compiler.replacements.StandardGraphBuilderPlugins.UnsafePutPlugin; 59 import org.graalvm.compiler.replacements.nodes.BinaryMathIntrinsicNode; 60 import org.graalvm.compiler.replacements.nodes.BinaryMathIntrinsicNode.BinaryOperation; 61 import org.graalvm.compiler.replacements.nodes.BitCountNode; 62 import org.graalvm.compiler.replacements.nodes.UnaryMathIntrinsicNode; 63 import org.graalvm.compiler.replacements.nodes.UnaryMathIntrinsicNode.UnaryOperation; 64 65 import jdk.vm.ci.amd64.AMD64; 66 import jdk.vm.ci.amd64.AMD64.CPUFeature; 67 import jdk.vm.ci.meta.JavaKind; 68 import jdk.vm.ci.meta.ResolvedJavaMethod; 69 import sun.misc.Unsafe; 70 71 public class AMD64GraphBuilderPlugins { 72 73 public static void register(Plugins plugins, BytecodeProvider replacementsBytecodeProvider, AMD64 arch, boolean arithmeticStubs, boolean explicitUnsafeNullChecks) { 74 InvocationPlugins invocationPlugins = plugins.getInvocationPlugins(); 75 invocationPlugins.defer(new Runnable() { 76 @Override 77 public void run() { 78 registerIntegerLongPlugins(invocationPlugins, IntegerSubstitutions.class, JavaKind.Int, arch, replacementsBytecodeProvider); 79 registerIntegerLongPlugins(invocationPlugins, LongSubstitutions.class, JavaKind.Long, arch, replacementsBytecodeProvider); 80 registerPlatformSpecificUnsafePlugins(invocationPlugins, replacementsBytecodeProvider, explicitUnsafeNullChecks, 81 new JavaKind[]{JavaKind.Int, JavaKind.Long, JavaKind.Object, JavaKind.Boolean, JavaKind.Byte, JavaKind.Short, JavaKind.Char, JavaKind.Float, JavaKind.Double}); 82 registerUnsafePlugins(invocationPlugins, replacementsBytecodeProvider, explicitUnsafeNullChecks); 83 registerStringPlugins(invocationPlugins, arch, replacementsBytecodeProvider); 84 registerStringLatin1Plugins(invocationPlugins, arch, replacementsBytecodeProvider); 85 registerStringUTF16Plugins(invocationPlugins, arch, replacementsBytecodeProvider); 86 registerMathPlugins(invocationPlugins, arch, arithmeticStubs, replacementsBytecodeProvider); 87 registerArraysEqualsPlugins(invocationPlugins, replacementsBytecodeProvider); 88 } 89 }); 90 } 91 92 private static void registerIntegerLongPlugins(InvocationPlugins plugins, Class<?> substituteDeclaringClass, JavaKind kind, AMD64 arch, BytecodeProvider bytecodeProvider) { 93 Class<?> declaringClass = kind.toBoxedJavaClass(); 94 Class<?> type = kind.toJavaClass(); 95 Registration r = new Registration(plugins, declaringClass, bytecodeProvider); 96 if (arch.getFeatures().contains(AMD64.CPUFeature.LZCNT) && arch.getFlags().contains(AMD64.Flag.UseCountLeadingZerosInstruction)) { 97 r.register1("numberOfLeadingZeros", type, new InvocationPlugin() { 98 @Override 99 public boolean apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, Receiver receiver, ValueNode value) { 100 ValueNode folded = AMD64CountLeadingZerosNode.tryFold(value); 101 if (folded != null) { 102 b.addPush(JavaKind.Int, folded); 103 } else { 104 b.addPush(JavaKind.Int, new AMD64CountLeadingZerosNode(value)); 105 } 106 return true; 107 } 108 }); 109 } else { 110 r.registerMethodSubstitution(substituteDeclaringClass, "numberOfLeadingZeros", type); 111 } 112 if (arch.getFeatures().contains(AMD64.CPUFeature.BMI1) && arch.getFlags().contains(AMD64.Flag.UseCountTrailingZerosInstruction)) { 113 r.register1("numberOfTrailingZeros", type, new InvocationPlugin() { 114 @Override 115 public boolean apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, Receiver receiver, ValueNode value) { 116 ValueNode folded = AMD64CountTrailingZerosNode.tryFold(value); 117 if (folded != null) { 118 b.addPush(JavaKind.Int, folded); 119 } else { 120 b.addPush(JavaKind.Int, new AMD64CountTrailingZerosNode(value)); 121 } 122 return true; 123 } 124 }); 125 } else { 126 r.registerMethodSubstitution(substituteDeclaringClass, "numberOfTrailingZeros", type); 127 } 128 129 if (arch.getFeatures().contains(AMD64.CPUFeature.POPCNT)) { 130 r.register1("bitCount", type, new InvocationPlugin() { 131 @Override 132 public boolean apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, Receiver receiver, ValueNode value) { 133 b.push(JavaKind.Int, b.append(new BitCountNode(value).canonical(null))); 134 return true; 135 } 136 }); 137 } 138 } 139 140 private static void registerMathPlugins(InvocationPlugins plugins, AMD64 arch, boolean arithmeticStubs, BytecodeProvider bytecodeProvider) { 141 Registration r = new Registration(plugins, Math.class, bytecodeProvider); 142 registerUnaryMath(r, "log", LOG); 143 registerUnaryMath(r, "log10", LOG10); 144 registerUnaryMath(r, "exp", EXP); 145 registerBinaryMath(r, "pow", POW); 146 if (arithmeticStubs) { 147 registerUnaryMath(r, "sin", SIN); 148 registerUnaryMath(r, "cos", COS); 149 registerUnaryMath(r, "tan", TAN); 150 } else { 151 r.registerMethodSubstitution(AMD64MathSubstitutions.class, "sin", double.class); 152 r.registerMethodSubstitution(AMD64MathSubstitutions.class, "cos", double.class); 153 r.registerMethodSubstitution(AMD64MathSubstitutions.class, "tan", double.class); 154 } 155 156 if (arch.getFeatures().contains(CPUFeature.SSE4_1)) { 157 registerRound(r, "rint", RoundingMode.NEAREST); 158 registerRound(r, "ceil", RoundingMode.UP); 159 registerRound(r, "floor", RoundingMode.DOWN); 160 } 161 } 162 163 private static void registerUnaryMath(Registration r, String name, UnaryOperation operation) { 164 r.register1(name, Double.TYPE, new InvocationPlugin() { 165 @Override 166 public boolean apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, Receiver receiver, ValueNode value) { 167 b.push(JavaKind.Double, b.append(UnaryMathIntrinsicNode.create(value, operation))); 168 return true; 169 } 170 }); 171 } 172 173 private static void registerBinaryMath(Registration r, String name, BinaryOperation operation) { 174 r.register2(name, Double.TYPE, Double.TYPE, new InvocationPlugin() { 175 @Override 176 public boolean apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, Receiver receiver, ValueNode x, ValueNode y) { 177 b.push(JavaKind.Double, b.append(BinaryMathIntrinsicNode.create(x, y, operation))); 178 return true; 179 } 180 }); 181 } 182 183 private static void registerRound(Registration r, String name, RoundingMode mode) { 184 r.register1(name, Double.TYPE, new InvocationPlugin() { 185 @Override 186 public boolean apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, Receiver receiver, ValueNode arg) { 187 b.push(JavaKind.Double, b.append(new AMD64RoundNode(arg, mode))); 188 return true; 189 } 190 }); 191 } 192 193 private static void registerStringPlugins(InvocationPlugins plugins, AMD64 arch, BytecodeProvider replacementsBytecodeProvider) { 194 if (Java8OrEarlier) { 195 Registration r; 196 r = new Registration(plugins, String.class, replacementsBytecodeProvider); 197 r.setAllowOverwrite(true); 198 if (arch.getFeatures().contains(CPUFeature.SSE4_2)) { 199 r.registerMethodSubstitution(AMD64StringSubstitutions.class, "indexOf", char[].class, int.class, 200 int.class, char[].class, int.class, int.class, int.class); 201 } 202 if (arch.getFeatures().contains(CPUFeature.SSSE3)) { 203 r.registerMethodSubstitution(AMD64StringSubstitutions.class, "indexOf", Receiver.class, int.class, int.class); 204 } 205 r.registerMethodSubstitution(AMD64StringSubstitutions.class, "compareTo", Receiver.class, String.class); 206 } 207 } 208 209 private static void registerStringLatin1Plugins(InvocationPlugins plugins, AMD64 arch, BytecodeProvider replacementsBytecodeProvider) { 210 if (JAVA_SPECIFICATION_VERSION >= 9) { 211 Registration r = new Registration(plugins, "java.lang.StringLatin1", replacementsBytecodeProvider); 212 r.setAllowOverwrite(true); 213 r.registerMethodSubstitution(AMD64StringLatin1Substitutions.class, "compareTo", byte[].class, byte[].class); 214 r.registerMethodSubstitution(AMD64StringLatin1Substitutions.class, "compareToUTF16", byte[].class, byte[].class); 215 if (arch.getFeatures().contains(CPUFeature.SSSE3)) { 216 r.registerMethodSubstitution(AMD64StringLatin1Substitutions.class, "indexOf", byte[].class, int.class, int.class); 217 } 218 } 219 } 220 221 private static void registerStringUTF16Plugins(InvocationPlugins plugins, AMD64 arch, BytecodeProvider replacementsBytecodeProvider) { 222 if (JAVA_SPECIFICATION_VERSION >= 9) { 223 Registration r = new Registration(plugins, "java.lang.StringUTF16", replacementsBytecodeProvider); 224 r.setAllowOverwrite(true); 225 r.registerMethodSubstitution(AMD64StringUTF16Substitutions.class, "compareTo", byte[].class, byte[].class); 226 r.registerMethodSubstitution(AMD64StringUTF16Substitutions.class, "compareToLatin1", byte[].class, byte[].class); 227 if (arch.getFeatures().contains(CPUFeature.SSSE3)) { 228 r.registerMethodSubstitution(AMD64StringUTF16Substitutions.class, "indexOfCharUnsafe", byte[].class, int.class, int.class, int.class); 229 } 230 } 231 } 232 233 private static void registerUnsafePlugins(InvocationPlugins plugins, BytecodeProvider replacementsBytecodeProvider, boolean explicitUnsafeNullChecks) { 234 registerUnsafePlugins(new Registration(plugins, Unsafe.class), explicitUnsafeNullChecks, new JavaKind[]{JavaKind.Int, JavaKind.Long, JavaKind.Object}, true); 235 if (!Java8OrEarlier) { 236 registerUnsafePlugins(new Registration(plugins, "jdk.internal.misc.Unsafe", replacementsBytecodeProvider), explicitUnsafeNullChecks, 237 new JavaKind[]{JavaKind.Boolean, JavaKind.Byte, JavaKind.Char, JavaKind.Short, JavaKind.Int, JavaKind.Long, JavaKind.Object}, Java11OrEarlier); 238 } 239 } 240 241 private static void registerUnsafePlugins(Registration r, boolean explicitUnsafeNullChecks, JavaKind[] unsafeJavaKinds, boolean java11OrEarlier) { 242 for (JavaKind kind : unsafeJavaKinds) { 243 Class<?> javaClass = kind == JavaKind.Object ? Object.class : kind.toJavaClass(); 244 String kindName = (kind == JavaKind.Object && !java11OrEarlier) ? "Reference" : kind.name(); 245 r.register4("getAndSet" + kindName, Receiver.class, Object.class, long.class, javaClass, new UnsafeAccessPlugin(kind, explicitUnsafeNullChecks) { 246 @Override 247 public boolean apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, Receiver unsafe, ValueNode object, ValueNode offset, ValueNode value) { 248 // Emits a null-check for the otherwise unused receiver 249 unsafe.get(); 250 createUnsafeAccess(object, b, (obj, loc) -> new AtomicReadAndWriteNode(obj, offset, value, kind, loc)); 251 return true; 252 } 253 }); 254 if (kind != JavaKind.Boolean && kind.isNumericInteger()) { 255 r.register4("getAndAdd" + kindName, Receiver.class, Object.class, long.class, javaClass, new UnsafeAccessPlugin(kind, explicitUnsafeNullChecks) { 256 @Override 257 public boolean apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, Receiver unsafe, ValueNode object, ValueNode offset, ValueNode delta) { 258 // Emits a null-check for the otherwise unused receiver 259 unsafe.get(); 260 createUnsafeAccess(object, b, (obj, loc) -> new AtomicReadAndAddNode(b.add(new OffsetAddressNode(obj, offset)), delta, kind, loc)); 261 return true; 262 } 263 }); 264 } 265 } 266 267 for (JavaKind kind : new JavaKind[]{JavaKind.Char, JavaKind.Short, JavaKind.Int, JavaKind.Long}) { 268 Class<?> javaClass = kind.toJavaClass(); 269 r.registerOptional3("get" + kind.name() + "Unaligned", Receiver.class, Object.class, long.class, new UnsafeGetPlugin(kind, explicitUnsafeNullChecks)); 270 r.registerOptional4("put" + kind.name() + "Unaligned", Receiver.class, Object.class, long.class, javaClass, new UnsafePutPlugin(kind, explicitUnsafeNullChecks)); 271 } 272 } 273 274 private static void registerArraysEqualsPlugins(InvocationPlugins plugins, BytecodeProvider bytecodeProvider) { 275 Registration r = new Registration(plugins, Arrays.class, bytecodeProvider); 276 r.registerMethodSubstitution(ArraysSubstitutions.class, "equals", float[].class, float[].class); 277 r.registerMethodSubstitution(ArraysSubstitutions.class, "equals", double[].class, double[].class); 278 } 279 }