/*

 * Copyright (c) 2007, 2012, 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_VECTORNODE_HPP

#define SHARE_VM_OPTO_VECTORNODE_HPP

#include "opto/matcher.hpp"

#include "opto/memnode.hpp"

#include "opto/node.hpp"

#include "opto/opcodes.hpp"

// Vector Operation

class VectorNode : public TypeNode {

 public:

  VectorNode(Node* n1, const TypeVect* vt) : TypeNode(vt, 2) {

    init_class_id(Class_Vector);

    init_req(1, n1);

  }

  VectorNode(Node* n1, Node* n2, const TypeVect* vt) : TypeNode(vt, 3) {

    init_class_id(Class_Vector);

    init_req(1, n1);

    init_req(2, n2);

  }

  const TypeVect* vect_type() const { return type()->is_vect(); }

  uint length() const { return vect_type()->length(); } // Vector length

  uint length_in_bytes() const { return vect_type()->length_in_bytes(); }

  virtual int Opcode() const;

  virtual uint ideal_reg() const { return Matcher::vector_ideal_reg(vect_type()->length_in_bytes()); }

  static VectorNode* scalar2vector(Compile* C, Node* s, uint vlen, const Type* opd_t);

  static VectorNode* make(Compile* C, int opc, Node* n1, Node* n2, uint vlen, BasicType bt);

  static int  opcode(int opc, BasicType bt);

  static bool implemented(int opc, uint vlen, BasicType bt);

  static bool is_shift(Node* n);

  static bool is_invariant_vector(Node* n);

  // [Start, end) half-open range defining which operands are vectors

  static void vector_operands(Node* n, uint* start, uint* end);

};

// Vector add byte

class AddVBNode : public VectorNode {

 public:

  AddVBNode(Node* in1, Node* in2, const TypeVect* vt) : VectorNode(in1,in2,vt) {}

  virtual int Opcode() const;

};

// Vector add char/short

class AddVSNode : public VectorNode {

 public:

  AddVSNode(Node* in1, Node* in2, const TypeVect* vt) : VectorNode(in1,in2,vt) {}

  virtual int Opcode() const;

};

// Vector add int

class AddVINode : public VectorNode {

 public:

  AddVINode(Node* in1, Node* in2, const TypeVect* vt) : VectorNode(in1,in2,vt) {}

  virtual int Opcode() const;

};

// Vector add long

class AddVLNode : public VectorNode {

 public:

  AddVLNode(Node* in1, Node* in2, const TypeVect* vt) : VectorNode(in1,in2,vt) {}

  virtual int Opcode() const;

};

// Vector add float

class AddVFNode : public VectorNode {

 public:

  AddVFNode(Node* in1, Node* in2, const TypeVect* vt) : VectorNode(in1,in2,vt) {}

  virtual int Opcode() const;

};

// Vector add double

class AddVDNode : public VectorNode {

 public:

  AddVDNode(Node* in1, Node* in2, const TypeVect* vt) : VectorNode(in1,in2,vt) {}

  virtual int Opcode() const;

};

// Vector subtract byte

class SubVBNode : public VectorNode {

 public:

  SubVBNode(Node* in1, Node* in2, const TypeVect* vt) : VectorNode(in1,in2,vt) {}

  virtual int Opcode() const;

};

// Vector subtract short

class SubVSNode : public VectorNode {

 public:

  SubVSNode(Node* in1, Node* in2, const TypeVect* vt) : VectorNode(in1,in2,vt) {}

  virtual int Opcode() const;

};

// Vector subtract int

class SubVINode : public VectorNode {

 public:

  SubVINode(Node* in1, Node* in2, const TypeVect* vt) : VectorNode(in1,in2,vt) {}

  virtual int Opcode() const;

};

// Vector subtract long

class SubVLNode : public VectorNode {

 public:

  SubVLNode(Node* in1, Node* in2, const TypeVect* vt) : VectorNode(in1,in2,vt) {}

  virtual int Opcode() const;

};

// Vector subtract float

class SubVFNode : public VectorNode {

 public:

  SubVFNode(Node* in1, Node* in2, const TypeVect* vt) : VectorNode(in1,in2,vt) {}

  virtual int Opcode() const;

};

// Vector subtract double

class SubVDNode : public VectorNode {

 public:

  SubVDNode(Node* in1, Node* in2, const TypeVect* vt) : VectorNode(in1,in2,vt) {}

  virtual int Opcode() const;

};

// Vector multiply short

class MulVSNode : public VectorNode {

 public:

  MulVSNode(Node* in1, Node* in2, const TypeVect* vt) : VectorNode(in1,in2,vt) {}

  virtual int Opcode() const;

};

// Vector multiply int

class MulVINode : public VectorNode {

 public:

  MulVINode(Node* in1, Node* in2, const TypeVect* vt) : VectorNode(in1,in2,vt) {}

  virtual int Opcode() const;

};

// Vector multiply float

class MulVFNode : public VectorNode {

 public:

  MulVFNode(Node* in1, Node* in2, const TypeVect* vt) : VectorNode(in1,in2,vt) {}

  virtual int Opcode() const;

};

// Vector multiply double

class MulVDNode : public VectorNode {

 public:

  MulVDNode(Node* in1, Node* in2, const TypeVect* vt) : VectorNode(in1,in2,vt) {}

  virtual int Opcode() const;

};

// Vector divide float

class DivVFNode : public VectorNode {

 public:

  DivVFNode(Node* in1, Node* in2, const TypeVect* vt) : VectorNode(in1,in2,vt) {}

  virtual int Opcode() const;

};

// Vector Divide double

class DivVDNode : public VectorNode {

 public:

  DivVDNode(Node* in1, Node* in2, const TypeVect* vt) : VectorNode(in1,in2,vt) {}

  virtual int Opcode() const;

};

// Vector left shift bytes

class LShiftVBNode : public VectorNode {

 public:

  LShiftVBNode(Node* in1, Node* in2, const TypeVect* vt) : VectorNode(in1,in2,vt) {}

  virtual int Opcode() const;

};

// Vector left shift shorts

class LShiftVSNode : public VectorNode {

 public:

  LShiftVSNode(Node* in1, Node* in2, const TypeVect* vt) : VectorNode(in1,in2,vt) {}

  virtual int Opcode() const;

};

// Vector left shift ints

class LShiftVINode : public VectorNode {

 public:

  LShiftVINode(Node* in1, Node* in2, const TypeVect* vt) : VectorNode(in1,in2,vt) {}

  virtual int Opcode() const;

};

// Vector left shift longs

class LShiftVLNode : public VectorNode {

 public:

  LShiftVLNode(Node* in1, Node* in2, const TypeVect* vt) : VectorNode(in1,in2,vt) {}

  virtual int Opcode() const;

};

// Vector right arithmetic (signed) shift bytes

class RShiftVBNode : public VectorNode {

 public:

  RShiftVBNode(Node* in1, Node* in2, const TypeVect* vt) : VectorNode(in1,in2,vt) {}

  virtual int Opcode() const;

};

// Vector right arithmetic (signed) shift shorts

class RShiftVSNode : public VectorNode {

 public:

  RShiftVSNode(Node* in1, Node* in2, const TypeVect* vt) : VectorNode(in1,in2,vt) {}

  virtual int Opcode() const;

};

// Vector right arithmetic (signed) shift ints

class RShiftVINode : public VectorNode {

 public:

  RShiftVINode(Node* in1, Node* in2, const TypeVect* vt) : VectorNode(in1,in2,vt) {}

  virtual int Opcode() const;

};

// Vector right arithmetic (signed) shift longs

class RShiftVLNode : public VectorNode {

 public:

  RShiftVLNode(Node* in1, Node* in2, const TypeVect* vt) : VectorNode(in1,in2,vt) {}

  virtual int Opcode() const;

};

// Vector right logical (unsigned) shift bytes

class URShiftVBNode : public VectorNode {

 public:

  URShiftVBNode(Node* in1, Node* in2, const TypeVect* vt) : VectorNode(in1,in2,vt) {}

  virtual int Opcode() const;

};

// Vector right logical (unsigned) shift shorts

class URShiftVSNode : public VectorNode {

 public:

  URShiftVSNode(Node* in1, Node* in2, const TypeVect* vt) : VectorNode(in1,in2,vt) {}

  virtual int Opcode() const;

};

// Vector right logical (unsigned) shift ints

class URShiftVINode : public VectorNode {

 public:

  URShiftVINode(Node* in1, Node* in2, const TypeVect* vt) : VectorNode(in1,in2,vt) {}

  virtual int Opcode() const;

};

// Vector right logical (unsigned) shift longs

class URShiftVLNode : public VectorNode {

 public:

  URShiftVLNode(Node* in1, Node* in2, const TypeVect* vt) : VectorNode(in1,in2,vt) {}

  virtual int Opcode() const;

};

//------------------------------AndVNode---------------------------------------

// Vector and integer

class AndVNode : public VectorNode {

 public:

  AndVNode(Node* in1, Node* in2, const TypeVect* vt) : VectorNode(in1,in2,vt) {}

  virtual int Opcode() const;

};

//------------------------------OrVNode---------------------------------------

// Vector or integer

class OrVNode : public VectorNode {

 public:

  OrVNode(Node* in1, Node* in2, const TypeVect* vt) : VectorNode(in1,in2,vt) {}

  virtual int Opcode() const;

};

//------------------------------XorVNode---------------------------------------

// Vector xor integer

class XorVNode : public VectorNode {

 public:

  XorVNode(Node* in1, Node* in2, const TypeVect* vt) : VectorNode(in1,in2,vt) {}

  virtual int Opcode() const;

};

//================================= M E M O R Y ===============================

//------------------------------LoadVectorNode---------------------------------

// Load Vector from memory

class LoadVectorNode : public LoadNode {

 public:

  LoadVectorNode(Node* c, Node* mem, Node* adr, const TypePtr* at, const TypeVect* vt)

    : LoadNode(c, mem, adr, at, vt) {

    init_class_id(Class_LoadVector);

  }

  const TypeVect* vect_type() const { return type()->is_vect(); }

  uint length() const { return vect_type()->length(); } // Vector length

  virtual int Opcode() const;

  virtual uint ideal_reg() const  { return Matcher::vector_ideal_reg(memory_size()); }

  virtual BasicType memory_type() const { return T_VOID; }

  virtual int memory_size() const { return vect_type()->length_in_bytes(); }

  virtual int store_Opcode() const { return Op_StoreVector; }

  static LoadVectorNode* make(Compile* C, int opc, Node* ctl, Node* mem,

                              Node* adr, const TypePtr* atyp, uint vlen, BasicType bt);

};

//------------------------------StoreVectorNode--------------------------------

// Store Vector to memory

class StoreVectorNode : public StoreNode {

 public:

  StoreVectorNode(Node* c, Node* mem, Node* adr, const TypePtr* at, Node* val)

    : StoreNode(c, mem, adr, at, val) {

    assert(val->is_Vector() || val->is_LoadVector(), "sanity");

    init_class_id(Class_StoreVector);

  }

  const TypeVect* vect_type() const { return in(MemNode::ValueIn)->bottom_type()->is_vect(); }

  uint length() const { return vect_type()->length(); } // Vector length

  virtual int Opcode() const;

  virtual uint ideal_reg() const  { return Matcher::vector_ideal_reg(memory_size()); }

  virtual BasicType memory_type() const { return T_VOID; }

  virtual int memory_size() const { return vect_type()->length_in_bytes(); }

  static StoreVectorNode* make(Compile* C, int opc, Node* ctl, Node* mem,

                               Node* adr, const TypePtr* atyp, Node* val,

                               uint vlen);

};

//=========================Promote_Scalar_to_Vector============================

//------------------------------ReplicateBNode---------------------------------

// Replicate byte scalar to be vector

class ReplicateBNode : public VectorNode {

 public:

  ReplicateBNode(Node* in1, const TypeVect* vt) : VectorNode(in1, vt) {}

  virtual int Opcode() const;

};

//------------------------------ReplicateSNode---------------------------------

// Replicate short scalar to be vector

class ReplicateSNode : public VectorNode {

 public:

  ReplicateSNode(Node* in1, const TypeVect* vt) : VectorNode(in1, vt) {}

  virtual int Opcode() const;

};

//------------------------------ReplicateINode---------------------------------

// Replicate int scalar to be vector

class ReplicateINode : public VectorNode {

 public:

  ReplicateINode(Node* in1, const TypeVect* vt) : VectorNode(in1, vt) {}

  virtual int Opcode() const;

};

//------------------------------ReplicateLNode---------------------------------

// Replicate long scalar to be vector

class ReplicateLNode : public VectorNode {

 public:

  ReplicateLNode(Node* in1, const TypeVect* vt) : VectorNode(in1, vt) {}

  virtual int Opcode() const;

};

//------------------------------ReplicateFNode---------------------------------

// Replicate float scalar to be vector

class ReplicateFNode : public VectorNode {

 public:

  ReplicateFNode(Node* in1, const TypeVect* vt) : VectorNode(in1, vt) {}

  virtual int Opcode() const;

};

//------------------------------ReplicateDNode---------------------------------

// Replicate double scalar to be vector

class ReplicateDNode : public VectorNode {

 public:

  ReplicateDNode(Node* in1, const TypeVect* vt) : VectorNode(in1, vt) {}

  virtual int Opcode() const;

};

//========================Pack_Scalars_into_a_Vector===========================

//------------------------------PackNode---------------------------------------

// Pack parent class (not for code generation).

class PackNode : public VectorNode {

 public:

  PackNode(Node* in1, const TypeVect* vt) : VectorNode(in1, vt) {}

  PackNode(Node* in1, Node* n2, const TypeVect* vt) : VectorNode(in1, n2, vt) {}

  virtual int Opcode() const;

  void add_opd(Node* n) {

    add_req(n);

  }

  // Create a binary tree form for Packs. [lo, hi) (half-open) range

  PackNode* binary_tree_pack(Compile* C, int lo, int hi);

  static PackNode* make(Compile* C, Node* s, uint vlen, BasicType bt);

};

// Pack byte scalars into vector

class PackBNode : public PackNode {

 public:

  PackBNode(Node* in1, const TypeVect* vt)  : PackNode(in1, vt) {}

  virtual int Opcode() const;

};

// Pack short scalars into a vector

class PackSNode : public PackNode {

 public:

  PackSNode(Node* in1, const TypeVect* vt)  : PackNode(in1, vt) {}

  PackSNode(Node* in1, Node* in2, const TypeVect* vt) : PackNode(in1, in2, vt) {}

  virtual int Opcode() const;

};

// Pack integer scalars into a vector

class PackINode : public PackNode {

 public:

  PackINode(Node* in1, const TypeVect* vt)  : PackNode(in1, vt) {}

  PackINode(Node* in1, Node* in2, const TypeVect* vt) : PackNode(in1, in2, vt) {}

  virtual int Opcode() const;

};