1 /* 2 * Copyright (c) 2013, 2015, 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 org.graalvm.compiler.hotspot; 24 25 import static jdk.vm.ci.code.CodeUtil.K; 26 import static jdk.vm.ci.code.CodeUtil.getCallingConvention; 27 import static jdk.vm.ci.common.InitTimer.timer; 28 29 import java.util.Collections; 30 31 import org.graalvm.compiler.core.common.NumUtil; 32 import org.graalvm.compiler.core.common.spi.ForeignCallDescriptor; 33 import org.graalvm.compiler.debug.DebugHandlersFactory; 34 import org.graalvm.compiler.hotspot.meta.HotSpotHostForeignCallsProvider; 35 import org.graalvm.compiler.hotspot.meta.HotSpotLoweringProvider; 36 import org.graalvm.compiler.hotspot.meta.HotSpotProviders; 37 import org.graalvm.compiler.hotspot.stubs.Stub; 38 import org.graalvm.compiler.lir.asm.CompilationResultBuilder; 39 import org.graalvm.compiler.lir.framemap.ReferenceMapBuilder; 40 import org.graalvm.compiler.nodes.StructuredGraph; 41 import org.graalvm.compiler.options.OptionValues; 42 import org.graalvm.compiler.printer.GraalDebugHandlersFactory; 43 44 import jdk.vm.ci.code.CallingConvention; 45 import jdk.vm.ci.common.InitTimer; 46 import jdk.vm.ci.hotspot.HotSpotCallingConventionType; 47 import jdk.vm.ci.hotspot.HotSpotJVMCIRuntime; 48 import jdk.vm.ci.meta.JavaType; 49 import jdk.vm.ci.runtime.JVMCICompiler; 50 51 /** 52 * Common functionality of HotSpot host backends. 53 */ 54 public abstract class HotSpotHostBackend extends HotSpotBackend { 55 56 /** 57 * Descriptor for {@code SharedRuntime::deopt_blob()->unpack()}. 58 */ 59 public static final ForeignCallDescriptor DEOPTIMIZATION_HANDLER = new ForeignCallDescriptor("deoptHandler", void.class); 60 61 /** 62 * Descriptor for {@code SharedRuntime::deopt_blob()->uncommon_trap()}. 63 */ 64 public static final ForeignCallDescriptor UNCOMMON_TRAP_HANDLER = new ForeignCallDescriptor("uncommonTrapHandler", void.class); 65 66 protected final GraalHotSpotVMConfig config; 67 68 public HotSpotHostBackend(GraalHotSpotVMConfig config, HotSpotGraalRuntimeProvider runtime, HotSpotProviders providers) { 69 super(runtime, providers); 70 this.config = config; 71 } 72 73 @Override 74 @SuppressWarnings("try") 75 public void completeInitialization(HotSpotJVMCIRuntime jvmciRuntime, OptionValues options) { 76 final HotSpotProviders providers = getProviders(); 77 HotSpotHostForeignCallsProvider foreignCalls = (HotSpotHostForeignCallsProvider) providers.getForeignCalls(); 78 final HotSpotLoweringProvider lowerer = (HotSpotLoweringProvider) providers.getLowerer(); 79 80 try (InitTimer st = timer("foreignCalls.initialize")) { 81 foreignCalls.initialize(providers, options); 82 } 83 try (InitTimer st = timer("lowerer.initialize")) { 84 Iterable<DebugHandlersFactory> factories = Collections.singletonList(new GraalDebugHandlersFactory(providers.getSnippetReflection())); 85 lowerer.initialize(options, factories, providers, config); 86 } 87 } 88 89 protected CallingConvention makeCallingConvention(StructuredGraph graph, Stub stub) { 90 if (stub != null) { 91 return stub.getLinkage().getIncomingCallingConvention(); 92 } 93 94 CallingConvention cc = getCallingConvention(getCodeCache(), HotSpotCallingConventionType.JavaCallee, graph.method(), this); 95 if (graph.getEntryBCI() != JVMCICompiler.INVOCATION_ENTRY_BCI) { 96 // for OSR, only a pointer is passed to the method. 97 JavaType[] parameterTypes = new JavaType[]{getMetaAccess().lookupJavaType(long.class)}; 98 CallingConvention tmp = getCodeCache().getRegisterConfig().getCallingConvention(HotSpotCallingConventionType.JavaCallee, getMetaAccess().lookupJavaType(void.class), parameterTypes, this); 99 cc = new CallingConvention(cc.getStackSize(), cc.getReturn(), tmp.getArgument(0)); 100 } 101 return cc; 102 } 103 104 public void emitStackOverflowCheck(CompilationResultBuilder crb) { 105 if (config.useStackBanging) { 106 // Each code entry causes one stack bang n pages down the stack where n 107 // is configurable by StackShadowPages. The setting depends on the maximum 108 // depth of VM call stack or native before going back into java code, 109 // since only java code can raise a stack overflow exception using the 110 // stack banging mechanism. The VM and native code does not detect stack 111 // overflow. 112 // The code in JavaCalls::call() checks that there is at least n pages 113 // available, so all entry code needs to do is bang once for the end of 114 // this shadow zone. 115 // The entry code may need to bang additional pages if the framesize 116 // is greater than a page. 117 118 int pageSize = config.vmPageSize; 119 int bangEnd = NumUtil.roundUp(config.stackShadowPages * 4 * K, pageSize); 120 121 // This is how far the previous frame's stack banging extended. 122 int bangEndSafe = bangEnd; 123 124 int frameSize = Math.max(crb.frameMap.frameSize(), crb.compilationResult.getMaxInterpreterFrameSize()); 125 if (frameSize > pageSize) { 126 bangEnd += frameSize; 127 } 128 129 int bangOffset = bangEndSafe; 130 if (bangOffset <= bangEnd) { 131 crb.blockComment("[stack overflow check]"); 132 } 133 while (bangOffset <= bangEnd) { 134 // Need at least one stack bang at end of shadow zone. 135 bangStackWithOffset(crb, bangOffset); 136 bangOffset += pageSize; 137 } 138 } 139 } 140 141 protected abstract void bangStackWithOffset(CompilationResultBuilder crb, int bangOffset); 142 143 @Override 144 public ReferenceMapBuilder newReferenceMapBuilder(int totalFrameSize) { 145 return new HotSpotReferenceMapBuilder(totalFrameSize, config.maxOopMapStackOffset); 146 } 147 148 }