1 /* 2 * Copyright (c) 2011, 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 package jdk.vm.ci.hotspot.amd64; 24 25 import static jdk.vm.ci.amd64.AMD64.r12; 26 import static jdk.vm.ci.amd64.AMD64.r15; 27 import static jdk.vm.ci.amd64.AMD64.r8; 28 import static jdk.vm.ci.amd64.AMD64.r9; 29 import static jdk.vm.ci.amd64.AMD64.rax; 30 import static jdk.vm.ci.amd64.AMD64.rcx; 31 import static jdk.vm.ci.amd64.AMD64.rdi; 32 import static jdk.vm.ci.amd64.AMD64.rdx; 33 import static jdk.vm.ci.amd64.AMD64.rsi; 34 import static jdk.vm.ci.amd64.AMD64.rsp; 35 import static jdk.vm.ci.amd64.AMD64.xmm0; 36 import static jdk.vm.ci.amd64.AMD64.xmm1; 37 import static jdk.vm.ci.amd64.AMD64.xmm2; 38 import static jdk.vm.ci.amd64.AMD64.xmm3; 39 import static jdk.vm.ci.amd64.AMD64.xmm4; 40 import static jdk.vm.ci.amd64.AMD64.xmm5; 41 import static jdk.vm.ci.amd64.AMD64.xmm6; 42 import static jdk.vm.ci.amd64.AMD64.xmm7; 43 44 import java.util.ArrayList; 45 import java.util.HashSet; 46 import java.util.List; 47 import java.util.Set; 48 49 import jdk.vm.ci.code.Architecture; 50 import jdk.vm.ci.code.CallingConvention; 51 import jdk.vm.ci.code.CallingConvention.Type; 52 import jdk.vm.ci.code.Register; 53 import jdk.vm.ci.code.RegisterArray; 54 import jdk.vm.ci.code.RegisterAttributes; 55 import jdk.vm.ci.code.RegisterConfig; 56 import jdk.vm.ci.code.StackSlot; 57 import jdk.vm.ci.code.TargetDescription; 58 import jdk.vm.ci.code.ValueKindFactory; 59 import jdk.vm.ci.common.JVMCIError; 60 import jdk.vm.ci.hotspot.HotSpotCallingConventionType; 61 import jdk.vm.ci.meta.AllocatableValue; 62 import jdk.vm.ci.meta.JavaKind; 63 import jdk.vm.ci.meta.JavaType; 64 import jdk.vm.ci.meta.PlatformKind; 65 import jdk.vm.ci.meta.Value; 66 import jdk.vm.ci.meta.ValueKind; 67 68 public class AMD64HotSpotRegisterConfig implements RegisterConfig { 69 70 private final TargetDescription target; 71 72 private final RegisterArray allocatable; 73 74 /** 75 * The caller saved registers always include all parameter registers. 76 */ 77 private final RegisterArray callerSaved; 78 79 private final boolean allAllocatableAreCallerSaved; 80 81 private final RegisterAttributes[] attributesMap; 82 83 @Override 84 public RegisterArray getAllocatableRegisters() { 85 return allocatable; 86 } 87 88 @Override 89 public RegisterArray filterAllocatableRegisters(PlatformKind kind, RegisterArray registers) { 90 ArrayList<Register> list = new ArrayList<>(); 91 for (Register reg : registers) { 92 if (target.arch.canStoreValue(reg.getRegisterCategory(), kind)) { 93 list.add(reg); 94 } 95 } 96 97 RegisterArray ret = new RegisterArray(list); 98 return ret; 99 } 100 101 @Override 102 public RegisterAttributes[] getAttributesMap() { 103 return attributesMap.clone(); 104 } 105 106 private final RegisterArray javaGeneralParameterRegisters; 107 private final RegisterArray nativeGeneralParameterRegisters; 108 private final RegisterArray javaXMMParameterRegisters; 109 private final RegisterArray nativeXMMParameterRegisters; 110 private final boolean windowsOS; 111 112 /* 113 * Some ABIs (e.g. Windows) require a so-called "home space", that is a save area on the stack 114 * to store the argument registers 115 */ 116 private final boolean needsNativeStackHomeSpace; 117 118 private static final RegisterArray reservedRegisters = new RegisterArray(rsp, r15); 119 120 private static RegisterArray initAllocatable(Architecture arch, boolean reserveForHeapBase) { 121 RegisterArray allRegisters = arch.getAvailableValueRegisters(); 122 Register[] registers = new Register[allRegisters.size() - reservedRegisters.size() - (reserveForHeapBase ? 1 : 0)]; 123 List<Register> reservedRegistersList = reservedRegisters.asList(); 124 125 int idx = 0; 126 for (Register reg : allRegisters) { 127 if (reservedRegistersList.contains(reg)) { 128 // skip reserved registers 129 continue; 130 } 131 if (reserveForHeapBase && reg.equals(r12)) { 132 // skip heap base register 133 continue; 134 } 135 136 registers[idx++] = reg; 137 } 138 139 assert idx == registers.length; 140 return new RegisterArray(registers); 141 } 142 143 public AMD64HotSpotRegisterConfig(TargetDescription target, boolean useCompressedOops, boolean windowsOs) { 144 this(target, initAllocatable(target.arch, useCompressedOops), windowsOs); 145 assert callerSaved.size() >= allocatable.size(); 146 } 147 148 public AMD64HotSpotRegisterConfig(TargetDescription target, RegisterArray allocatable, boolean windowsOS) { 149 this.target = target; 150 this.windowsOS = windowsOS; 151 152 if (windowsOS) { 153 javaGeneralParameterRegisters = new RegisterArray(rdx, r8, r9, rdi, rsi, rcx); 154 nativeGeneralParameterRegisters = new RegisterArray(rcx, rdx, r8, r9); 155 nativeXMMParameterRegisters = new RegisterArray(xmm0, xmm1, xmm2, xmm3); 156 this.needsNativeStackHomeSpace = true; 157 } else { 158 javaGeneralParameterRegisters = new RegisterArray(rsi, rdx, rcx, r8, r9, rdi); 159 nativeGeneralParameterRegisters = new RegisterArray(rdi, rsi, rdx, rcx, r8, r9); 160 nativeXMMParameterRegisters = new RegisterArray(xmm0, xmm1, xmm2, xmm3, xmm4, xmm5, xmm6, xmm7); 161 this.needsNativeStackHomeSpace = false; 162 } 163 javaXMMParameterRegisters = new RegisterArray(xmm0, xmm1, xmm2, xmm3, xmm4, xmm5, xmm6, xmm7); 164 165 this.allocatable = allocatable; 166 Set<Register> callerSaveSet = new HashSet<>(); 167 allocatable.addTo(callerSaveSet); 168 javaXMMParameterRegisters.addTo(callerSaveSet); 169 callerSaveSet.addAll(javaGeneralParameterRegisters.asList()); 170 nativeGeneralParameterRegisters.addTo(callerSaveSet); 171 callerSaved = new RegisterArray(callerSaveSet); 172 173 allAllocatableAreCallerSaved = true; 174 attributesMap = RegisterAttributes.createMap(this, target.arch.getRegisters()); 175 } 176 177 @Override 178 public RegisterArray getCallerSaveRegisters() { 179 return callerSaved; 180 } 181 182 @Override 183 public RegisterArray getCalleeSaveRegisters() { 184 return null; 185 } 186 187 @Override 188 public boolean areAllAllocatableRegistersCallerSaved() { 189 return allAllocatableAreCallerSaved; 190 } 191 192 @Override 193 public CallingConvention getCallingConvention(Type type, JavaType returnType, JavaType[] parameterTypes, ValueKindFactory<?> valueKindFactory) { 194 HotSpotCallingConventionType hotspotType = (HotSpotCallingConventionType) type; 195 if (type == HotSpotCallingConventionType.NativeCall) { 196 return callingConvention(nativeGeneralParameterRegisters, nativeXMMParameterRegisters, windowsOS, returnType, parameterTypes, hotspotType, valueKindFactory); 197 } 198 // On x64, parameter locations are the same whether viewed 199 // from the caller or callee perspective 200 return callingConvention(javaGeneralParameterRegisters, javaXMMParameterRegisters, false, returnType, parameterTypes, hotspotType, valueKindFactory); 201 } 202 203 @Override 204 public RegisterArray getCallingConventionRegisters(Type type, JavaKind kind) { 205 HotSpotCallingConventionType hotspotType = (HotSpotCallingConventionType) type; 206 switch (kind) { 207 case Boolean: 208 case Byte: 209 case Short: 210 case Char: 211 case Int: 212 case Long: 213 case Object: 214 return hotspotType == HotSpotCallingConventionType.NativeCall ? nativeGeneralParameterRegisters : javaGeneralParameterRegisters; 215 case Float: 216 case Double: 217 return hotspotType == HotSpotCallingConventionType.NativeCall ? nativeXMMParameterRegisters : javaXMMParameterRegisters; 218 default: 219 throw JVMCIError.shouldNotReachHere(); 220 } 221 } 222 223 /** 224 * Hand out registers matching the calling convention from the {@code generalParameterRegisters} 225 * and {@code xmmParameterRegisters} sets. Normally registers are handed out from each set 226 * individually based on the type of the argument. If the {@code unified} flag is true then hand 227 * out registers in a single sequence, selecting between the sets based on the type. This is to 228 * support the Windows calling convention which only ever passes 4 arguments in registers, no 229 * matter their types. 230 * 231 * @param generalParameterRegisters 232 * @param xmmParameterRegisters 233 * @param unified 234 * @param returnType 235 * @param parameterTypes 236 * @param type 237 * @param valueKindFactory 238 * @return the resulting calling convention 239 */ 240 private CallingConvention callingConvention(RegisterArray generalParameterRegisters, RegisterArray xmmParameterRegisters, boolean unified, JavaType returnType, JavaType[] parameterTypes, 241 HotSpotCallingConventionType type, 242 ValueKindFactory<?> valueKindFactory) { 243 assert !unified || generalParameterRegisters.size() == xmmParameterRegisters.size() : "must be same size in unified mode"; 244 AllocatableValue[] locations = new AllocatableValue[parameterTypes.length]; 245 246 int currentGeneral = 0; 247 int currentXMM = 0; 248 int currentStackOffset = type == HotSpotCallingConventionType.NativeCall && needsNativeStackHomeSpace ? generalParameterRegisters.size() * target.wordSize : 0; 249 250 for (int i = 0; i < parameterTypes.length; i++) { 251 final JavaKind kind = parameterTypes[i].getJavaKind().getStackKind(); 252 253 switch (kind) { 254 case Byte: 255 case Boolean: 256 case Short: 257 case Char: 258 case Int: 259 case Long: 260 case Object: 261 if (currentGeneral < generalParameterRegisters.size()) { 262 Register register = generalParameterRegisters.get(currentGeneral++); 263 locations[i] = register.asValue(valueKindFactory.getValueKind(kind)); 264 } 265 break; 266 case Float: 267 case Double: 268 if ((unified ? currentGeneral : currentXMM) < xmmParameterRegisters.size()) { 269 Register register = xmmParameterRegisters.get(unified ? currentGeneral++ : currentXMM++); 270 locations[i] = register.asValue(valueKindFactory.getValueKind(kind)); 271 } 272 break; 273 default: 274 throw JVMCIError.shouldNotReachHere(); 275 } 276 277 if (locations[i] == null) { 278 ValueKind<?> valueKind = valueKindFactory.getValueKind(kind); 279 locations[i] = StackSlot.get(valueKind, currentStackOffset, !type.out); 280 currentStackOffset += Math.max(valueKind.getPlatformKind().getSizeInBytes(), target.wordSize); 281 } 282 } 283 assert !unified || currentXMM == 0 : "shouldn't be used in unified mode"; 284 285 JavaKind returnKind = returnType == null ? JavaKind.Void : returnType.getJavaKind(); 286 AllocatableValue returnLocation = returnKind == JavaKind.Void ? Value.ILLEGAL : getReturnRegister(returnKind).asValue(valueKindFactory.getValueKind(returnKind.getStackKind())); 287 return new CallingConvention(currentStackOffset, returnLocation, locations); 288 } 289 290 @Override 291 public Register getReturnRegister(JavaKind kind) { 292 switch (kind) { 293 case Boolean: 294 case Byte: 295 case Char: 296 case Short: 297 case Int: 298 case Long: 299 case Object: 300 return rax; 301 case Float: 302 case Double: 303 return xmm0; 304 case Void: 305 case Illegal: 306 return null; 307 default: 308 throw new UnsupportedOperationException("no return register for type " + kind); 309 } 310 } 311 312 @Override 313 public Register getFrameRegister() { 314 return rsp; 315 } 316 317 @Override 318 public String toString() { 319 return String.format("Allocatable: " + getAllocatableRegisters() + "%n" + "CallerSave: " + getCallerSaveRegisters() + "%n"); 320 } 321 }