1 /*
   2  * Copyright (c) 2016, 2019, 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.nodes.calc;
  26 
  27 import static org.graalvm.compiler.nodeinfo.NodeCycles.CYCLES_32;
  28 import static org.graalvm.compiler.nodeinfo.NodeSize.SIZE_1;
  29 
  30 import org.graalvm.compiler.core.common.type.IntegerStamp;
  31 import org.graalvm.compiler.core.common.type.Stamp;
  32 import org.graalvm.compiler.graph.IterableNodeType;
  33 import org.graalvm.compiler.graph.NodeClass;
  34 import org.graalvm.compiler.nodeinfo.InputType;
  35 import org.graalvm.compiler.nodeinfo.NodeInfo;
  36 import org.graalvm.compiler.nodes.NodeView;
  37 import org.graalvm.compiler.nodes.ValueNode;
  38 import org.graalvm.compiler.nodes.extended.GuardingNode;
  39 import org.graalvm.compiler.nodes.spi.Lowerable;
  40 import org.graalvm.compiler.nodes.spi.LoweringTool;
  41 
  42 @NodeInfo(cycles = CYCLES_32, size = SIZE_1)
  43 public abstract class IntegerDivRemNode extends FixedBinaryNode implements Lowerable, IterableNodeType {
  44 
  45     public static final NodeClass<IntegerDivRemNode> TYPE = NodeClass.create(IntegerDivRemNode.class);
  46 
  47     public enum Op {
  48         DIV,
  49         REM
  50     }
  51 
  52     public enum Type {
  53         SIGNED,
  54         UNSIGNED
  55     }
  56 
  57     @OptionalInput(InputType.Guard) private GuardingNode zeroCheck;
  58 
  59     private final Op op;
  60     private final Type type;
  61     private final boolean canDeopt;
  62 
  63     protected IntegerDivRemNode(NodeClass<? extends IntegerDivRemNode> c, Stamp stamp, Op op, Type type, ValueNode x, ValueNode y, GuardingNode zeroCheck) {
  64         super(c, stamp, x, y);
  65         this.zeroCheck = zeroCheck;
  66         this.op = op;
  67         this.type = type;
  68 
  69         // Assigning canDeopt during constructor, because it must never change during lifetime of
  70         // the node.
  71         IntegerStamp yStamp = (IntegerStamp) getY().stamp(NodeView.DEFAULT);
  72         this.canDeopt = (yStamp.contains(0) && zeroCheck == null) || yStamp.contains(-1);
  73     }
  74 
  75     public final GuardingNode getZeroCheck() {
  76         return zeroCheck;
  77     }
  78 
  79     public final Op getOp() {
  80         return op;
  81     }
  82 
  83     public final Type getType() {
  84         return type;
  85     }
  86 
  87     @Override
  88     public void lower(LoweringTool tool) {
  89         tool.getLowerer().lower(this, tool);
  90     }
  91 
  92     @Override
  93     public boolean canDeoptimize() {
  94         return canDeopt;
  95     }
  96 }