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 
24 
25 package org.graalvm.compiler.hotspot.nodes;
26 
27 import static org.graalvm.compiler.nodeinfo.InputType.Memory;
28 import static org.graalvm.compiler.nodeinfo.NodeCycles.CYCLES_UNKNOWN;
29 import static org.graalvm.compiler.nodeinfo.NodeSize.SIZE_UNKNOWN;
30 
31 import java.util.Arrays;
32 
33 import org.graalvm.compiler.core.common.spi.ForeignCallDescriptor;
34 import org.graalvm.compiler.core.common.spi.ForeignCallLinkage;
35 import org.graalvm.compiler.core.common.spi.ForeignCallsProvider;
36 import org.graalvm.compiler.core.common.type.Stamp;
37 import org.graalvm.compiler.graph.NodeClass;
38 import org.graalvm.compiler.graph.NodeInputList;
39 import org.graalvm.compiler.hotspot.replacements.HotSpotReplacementsUtil;
40 import org.graalvm.compiler.nodeinfo.NodeInfo;
41 import org.graalvm.compiler.nodeinfo.Verbosity;
42 import org.graalvm.compiler.nodes.FixedWithNextNode;
43 import org.graalvm.compiler.nodes.ValueNode;
44 import org.graalvm.compiler.nodes.memory.MemoryCheckpoint;
45 import org.graalvm.compiler.nodes.spi.LIRLowerable;
46 import org.graalvm.compiler.nodes.spi.NodeLIRBuilderTool;
47 import jdk.internal.vm.compiler.word.LocationIdentity;
48 
49 import jdk.vm.ci.meta.Value;
50 
51 /**
52  * Node for a {@linkplain ForeignCallDescriptor foreign} call from within a stub.
53  */
54 @NodeInfo(nameTemplate = "StubForeignCall#{p#descriptor/s}", allowedUsageTypes = Memory, cycles = CYCLES_UNKNOWN, size = SIZE_UNKNOWN)
55 public final class StubForeignCallNode extends FixedWithNextNode implements LIRLowerable, MemoryCheckpoint.Multi {
56 
57     public static final NodeClass<StubForeignCallNode> TYPE = NodeClass.create(StubForeignCallNode.class);
58     @Input NodeInputList<ValueNode> arguments;
59     protected final ForeignCallsProvider foreignCalls;
60 
61     protected final ForeignCallDescriptor descriptor;
62 
StubForeignCallNode(@njectedNodeParameter ForeignCallsProvider foreignCalls, @InjectedNodeParameter Stamp stamp, ForeignCallDescriptor descriptor, ValueNode... arguments)63     public StubForeignCallNode(@InjectedNodeParameter ForeignCallsProvider foreignCalls, @InjectedNodeParameter Stamp stamp, ForeignCallDescriptor descriptor, ValueNode... arguments) {
64         super(TYPE, stamp);
65         this.arguments = new NodeInputList<>(this, arguments);
66         this.descriptor = descriptor;
67         this.foreignCalls = foreignCalls;
68     }
69 
getDescriptor()70     public ForeignCallDescriptor getDescriptor() {
71         return descriptor;
72     }
73 
74     @Override
getLocationIdentities()75     public LocationIdentity[] getLocationIdentities() {
76         LocationIdentity[] killedLocations = foreignCalls.getKilledLocations(descriptor);
77         killedLocations = Arrays.copyOf(killedLocations, killedLocations.length + 1);
78         killedLocations[killedLocations.length - 1] = HotSpotReplacementsUtil.PENDING_EXCEPTION_LOCATION;
79         return killedLocations;
80     }
81 
operands(NodeLIRBuilderTool gen)82     protected Value[] operands(NodeLIRBuilderTool gen) {
83         Value[] operands = new Value[arguments.size()];
84         for (int i = 0; i < operands.length; i++) {
85             operands[i] = gen.operand(arguments.get(i));
86         }
87         return operands;
88     }
89 
90     @Override
generate(NodeLIRBuilderTool gen)91     public void generate(NodeLIRBuilderTool gen) {
92         assert graph().start() instanceof StubStartNode;
93         ForeignCallLinkage linkage = foreignCalls.lookupForeignCall(descriptor);
94         Value[] operands = operands(gen);
95         Value result = gen.getLIRGeneratorTool().emitForeignCall(linkage, null, operands);
96         if (result != null) {
97             gen.setResult(this, result);
98         }
99     }
100 
101     @Override
toString(Verbosity verbosity)102     public String toString(Verbosity verbosity) {
103         if (verbosity == Verbosity.Name) {
104             return super.toString(verbosity) + "#" + descriptor;
105         }
106         return super.toString(verbosity);
107     }
108 }
109