/*
* Copyright (c) 2012, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package org.graalvm.compiler.replacements;
import static org.graalvm.compiler.core.common.GraalOptions.ImmutableCode;
import static org.graalvm.compiler.replacements.SnippetTemplate.DEFAULT_REPLACER;
import java.util.EnumMap;
import org.graalvm.compiler.api.replacements.Snippet;
import org.graalvm.compiler.api.replacements.Snippet.ConstantParameter;
import org.graalvm.compiler.api.replacements.SnippetReflectionProvider;
import org.graalvm.compiler.debug.Debug;
import org.graalvm.compiler.nodes.ConstantNode;
import org.graalvm.compiler.nodes.PiNode;
import org.graalvm.compiler.nodes.ValueNode;
import org.graalvm.compiler.nodes.calc.FloatingNode;
import org.graalvm.compiler.nodes.extended.BoxNode;
import org.graalvm.compiler.nodes.extended.UnboxNode;
import org.graalvm.compiler.nodes.spi.LoweringTool;
import org.graalvm.compiler.options.OptionValues;
import org.graalvm.compiler.phases.util.Providers;
import org.graalvm.compiler.replacements.SnippetCounter.Group;
import org.graalvm.compiler.replacements.SnippetTemplate.AbstractTemplates;
import org.graalvm.compiler.replacements.SnippetTemplate.Arguments;
import org.graalvm.compiler.replacements.SnippetTemplate.SnippetInfo;
import jdk.vm.ci.code.TargetDescription;
import jdk.vm.ci.meta.ConstantReflectionProvider;
import jdk.vm.ci.meta.JavaConstant;
import jdk.vm.ci.meta.JavaKind;
import jdk.vm.ci.meta.MetaAccessProvider;
public class BoxingSnippets implements Snippets {
@Snippet
public static Object booleanValueOf(boolean value, @ConstantParameter SnippetCounter valueOfCounter) {
valueOfCounter.inc();
return PiNode.piCastToSnippetReplaceeStamp(Boolean.valueOf(value));
}
@Snippet
public static Object byteValueOf(byte value, @ConstantParameter SnippetCounter valueOfCounter) {
valueOfCounter.inc();
return PiNode.piCastToSnippetReplaceeStamp(Byte.valueOf(value));
}
@Snippet
public static Object charValueOf(char value, @ConstantParameter SnippetCounter valueOfCounter) {
valueOfCounter.inc();
return PiNode.piCastToSnippetReplaceeStamp(Character.valueOf(value));
}
@Snippet
public static Object doubleValueOf(double value, @ConstantParameter SnippetCounter valueOfCounter) {
valueOfCounter.inc();
return PiNode.piCastToSnippetReplaceeStamp(Double.valueOf(value));
}
@Snippet
public static Object floatValueOf(float value, @ConstantParameter SnippetCounter valueOfCounter) {
valueOfCounter.inc();
return PiNode.piCastToSnippetReplaceeStamp(Float.valueOf(value));
}
@Snippet
public static Object intValueOf(int value, @ConstantParameter SnippetCounter valueOfCounter) {
valueOfCounter.inc();
return PiNode.piCastToSnippetReplaceeStamp(Integer.valueOf(value));
}
@Snippet
public static Object longValueOf(long value, @ConstantParameter SnippetCounter valueOfCounter) {
valueOfCounter.inc();
return PiNode.piCastToSnippetReplaceeStamp(Long.valueOf(value));
}
@Snippet
public static Object shortValueOf(short value, @ConstantParameter SnippetCounter valueOfCounter) {
valueOfCounter.inc();
return PiNode.piCastToSnippetReplaceeStamp(Short.valueOf(value));
}
@Snippet
public static boolean booleanValue(Boolean value, @ConstantParameter SnippetCounter valueCounter) {
valueCounter.inc();
return value.booleanValue();
}
@Snippet
public static byte byteValue(Byte value, @ConstantParameter SnippetCounter valueCounter) {
valueCounter.inc();
return value.byteValue();
}
@Snippet
public static char charValue(Character value, @ConstantParameter SnippetCounter valueCounter) {
valueCounter.inc();
return value.charValue();
}
@Snippet
public static double doubleValue(Double value, @ConstantParameter SnippetCounter valueCounter) {
valueCounter.inc();
return value.doubleValue();
}
@Snippet
public static float floatValue(Float value, @ConstantParameter SnippetCounter valueCounter) {
valueCounter.inc();
return value.floatValue();
}
@Snippet
public static int intValue(Integer value, @ConstantParameter SnippetCounter valueCounter) {
valueCounter.inc();
return value.intValue();
}
@Snippet
public static long longValue(Long value, @ConstantParameter SnippetCounter valueCounter) {
valueCounter.inc();
return value.longValue();
}
@Snippet
public static short shortValue(Short value, @ConstantParameter SnippetCounter valueCounter) {
valueCounter.inc();
return value.shortValue();
}
public static FloatingNode canonicalizeBoxing(BoxNode box, MetaAccessProvider metaAccess, ConstantReflectionProvider constantReflection) {
ValueNode value = box.getValue();
if (value.isConstant()) {
JavaConstant sourceConstant = value.asJavaConstant();
if (sourceConstant.getJavaKind() != box.getBoxingKind() && sourceConstant.getJavaKind().isNumericInteger()) {
switch (box.getBoxingKind()) {
case Boolean:
sourceConstant = JavaConstant.forBoolean(sourceConstant.asLong() != 0L);
break;
case Byte:
sourceConstant = JavaConstant.forByte((byte) sourceConstant.asLong());
break;
case Char:
sourceConstant = JavaConstant.forChar((char) sourceConstant.asLong());
break;
case Short:
sourceConstant = JavaConstant.forShort((short) sourceConstant.asLong());
break;
}
}
JavaConstant boxedConstant = constantReflection.boxPrimitive(sourceConstant);
if (boxedConstant != null && sourceConstant.getJavaKind() == box.getBoxingKind()) {
return ConstantNode.forConstant(boxedConstant, metaAccess, box.graph());
}
}
return null;
}
public static class Templates extends AbstractTemplates {
private final EnumMap<JavaKind, SnippetInfo> boxSnippets = new EnumMap<>(JavaKind.class);
private final EnumMap<JavaKind, SnippetInfo> unboxSnippets = new EnumMap<>(JavaKind.class);
private final SnippetCounter valueOfCounter;
private final SnippetCounter valueCounter;
public Templates(OptionValues options, SnippetCounter.Group.Factory factory, Providers providers, SnippetReflectionProvider snippetReflection, TargetDescription target) {
super(options, providers, snippetReflection, target);
for (JavaKind kind : new JavaKind[]{JavaKind.Boolean, JavaKind.Byte, JavaKind.Char, JavaKind.Double, JavaKind.Float, JavaKind.Int, JavaKind.Long, JavaKind.Short}) {
boxSnippets.put(kind, snippet(BoxingSnippets.class, kind.getJavaName() + "ValueOf"));
unboxSnippets.put(kind, snippet(BoxingSnippets.class, kind.getJavaName() + "Value"));
}
Group group = factory.createSnippetCounterGroup("Boxing");
valueOfCounter = new SnippetCounter(group, "valueOf", "box intrinsification");
valueCounter = new SnippetCounter(group, "<kind>Value", "unbox intrinsification");
}
public void lower(BoxNode box, LoweringTool tool) {
FloatingNode canonical = canonicalizeBoxing(box, providers.getMetaAccess(), providers.getConstantReflection());
// if in AOT mode, we don't want to embed boxed constants.
if (canonical != null && !ImmutableCode.getValue(box.getOptions())) {
box.graph().replaceFixedWithFloating(box, canonical);
} else {
Arguments args = new Arguments(boxSnippets.get(box.getBoxingKind()), box.graph().getGuardsStage(), tool.getLoweringStage());
args.add("value", box.getValue());
args.addConst("valueOfCounter", valueOfCounter);
SnippetTemplate template = template(args);
Debug.log("Lowering integerValueOf in %s: node=%s, template=%s, arguments=%s", box.graph(), box, template, args);
template.instantiate(providers.getMetaAccess(), box, DEFAULT_REPLACER, args);
}
}
public void lower(UnboxNode unbox, LoweringTool tool) {
Arguments args = new Arguments(unboxSnippets.get(unbox.getBoxingKind()), unbox.graph().getGuardsStage(), tool.getLoweringStage());
args.add("value", unbox.getValue());
args.addConst("valueCounter", valueCounter);
SnippetTemplate template = template(args);
Debug.log("Lowering integerValueOf in %s: node=%s, template=%s, arguments=%s", unbox.graph(), unbox, template, args);
template.instantiate(providers.getMetaAccess(), unbox, DEFAULT_REPLACER, args);
}
}
}