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