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