/*
 * Copyright (c) 2013, 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.
 *
 */

#ifndef SHARE_VM_OPTO_MATHEXACTNODE_HPP
#define SHARE_VM_OPTO_MATHEXACTNODE_HPP

#include "opto/multnode.hpp"
#include "opto/node.hpp"
#include "opto/addnode.hpp"
#include "opto/subnode.hpp"
#include "opto/type.hpp"

class PhaseGVN;
class PhaseTransform;

class OverflowNode : public CmpNode {
public:
  OverflowNode(Node* in1);
  OverflowNode(Node* in1, Node* in2);
  virtual uint ideal_reg() const { return Op_RegFlags; }

  template <typename OverflowOp>
  class AddHelper {
  public:
    typedef typename OverflowOp::ConstantType ConstantType;
    typedef typename OverflowOp::TypeClass TypeClass;
    static bool will_overflow(ConstantType value1, ConstantType value2);
    static bool can_overflow(const Type* type1, const Type* type2);
  };
  template <typename OverflowOp>
  class SubHelper {
  public:
    typedef typename OverflowOp::ConstantType ConstantType;
    typedef typename OverflowOp::TypeClass TypeClass;
    static bool will_overflow(ConstantType value1, ConstantType value2);
    static bool can_overflow(const Type* type1, const Type* type2);
  };

  template <typename OverflowOp>
  class MulHelper {
  public:
    typedef typename OverflowOp::ConstantType ConstantType;
    typedef typename OverflowOp::TypeClass TypeClass;
    static bool can_overflow(const Type* type1, const Type* type2);
  };
};

class OverflowINode : public OverflowNode {
public:
  enum {
    IsLong = false
  };
  typedef jint ConstantType;
  typedef TypeInt TypeClass;

  OverflowINode(Node* in1) : OverflowNode(in1) {}
  OverflowINode(Node* in1, Node* in2) : OverflowNode(in1, in2) {}
  Node* Ideal(PhaseGVN* phase, bool can_reshape);
  const Type* Value(PhaseTransform* phase) const;
  const Type* sub(const Type* t1, const Type* t2) const;

  virtual bool will_overflow(jint v1, jint v2) const;
  virtual bool can_overflow(const Type* t1, const Type* t2) const;
};


class OverflowLNode : public OverflowNode {
public:
  enum {
    IsLong = true
  };
  typedef jlong ConstantType;
  typedef TypeLong TypeClass;

  OverflowLNode(Node* in1) : OverflowNode(in1) {}
  OverflowLNode(Node* in1, Node* in2) : OverflowNode(in1, in2) {}
  virtual Node* Ideal(PhaseGVN* phase, bool can_reshape);
  const Type* sub(const Type* t1, const Type* t2) const;
  const Type* Value(PhaseTransform* phase) const;

  virtual bool will_overflow(jlong v1, jlong v2) const;
  virtual bool can_overflow(const Type* t1, const Type* t2) const;
};

class OverflowAddINode : public OverflowINode {
public:
  typedef AddINode MathOp;
  typedef OverflowNode::AddHelper<OverflowINode> OverflowHelper;

  OverflowAddINode(Node* in1, Node* in2) : OverflowINode(in1, in2) {}
  virtual int Opcode() const;

  virtual bool will_overflow(jint v1, jint v2) const;
  virtual bool can_overflow(const Type* t1, const Type* t2) const;
};

class OverflowSubINode : public OverflowINode {
public:
  typedef SubINode MathOp;
  typedef OverflowNode::SubHelper<OverflowINode> OverflowHelper;

  OverflowSubINode(Node* in1, Node* in2) : OverflowINode(in1, in2) {}
  virtual int Opcode() const;

  virtual bool will_overflow(jint v1, jint v2) const;
  virtual bool can_overflow(const Type* t1, const Type* t2) const;
};

class OverflowMulINode : public OverflowINode {
public:
  typedef MulINode MathOp;
  typedef OverflowNode::MulHelper<OverflowINode> OverflowHelper;

  OverflowMulINode(Node* in1, Node* in2) : OverflowINode(in1, in2) {}
  virtual int Opcode() const;

  virtual bool will_overflow(jint v1, jint v2) const;
  virtual bool can_overflow(const Type* t1, const Type* t2) const;
};

class OverflowAddLNode : public OverflowLNode {
public:
  typedef AddLNode MathOp;
  typedef OverflowNode::AddHelper<OverflowLNode> OverflowHelper;

  OverflowAddLNode(Node* in1, Node* in2) : OverflowLNode(in1, in2) {}
  virtual int Opcode() const;

  virtual bool will_overflow(jlong v1, jlong v2) const;
  virtual bool can_overflow(const Type* t1, const Type* t2) const;
};

class OverflowSubLNode : public OverflowLNode {
public:
  typedef SubLNode MathOp;
  typedef OverflowNode::SubHelper<OverflowLNode> OverflowHelper;

  OverflowSubLNode(Node* in1, Node* in2) : OverflowLNode(in1, in2) {}
  virtual int Opcode() const;

  virtual bool will_overflow(jlong v1, jlong v2) const;
  virtual bool can_overflow(const Type* t1, const Type* t2) const;
};

class OverflowMulLNode : public OverflowLNode {
public:
  typedef MulLNode MathOp;
  typedef OverflowNode::MulHelper<OverflowLNode> OverflowHelper;

  OverflowMulLNode(Node* in1, Node* in2) : OverflowLNode(in1, in2) {}
  virtual int Opcode() const;

  virtual bool will_overflow(jlong v1, jlong v2) const;
  virtual bool can_overflow(const Type* t1, const Type* t2) const;
};

#endif