/*
 * Copyright (c) 2021, 2024, 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_PRIMS_VECTORSUPPORT_HPP
#define SHARE_PRIMS_VECTORSUPPORT_HPP

#include "code/debugInfo.hpp"
#include "jni.h"
#include "memory/allStatic.hpp"
#include "oops/typeArrayOop.hpp"
#include "runtime/registerMap.hpp"
#include "utilities/exceptions.hpp"

extern "C" {
  void JNICALL JVM_RegisterVectorSupportMethods(JNIEnv* env, jclass vsclass);
}

class VectorSupport : AllStatic {
 private:
  static Handle allocate_vector_payload(InstanceKlass* ik, frame* fr, RegisterMap* reg_map, ScopeValue* payload, TRAPS);
  static Handle allocate_vector_payload_helper(InstanceKlass* ik, frame* fr, RegisterMap* reg_map, Location location, TRAPS);

  static void init_payload_element(typeArrayOop arr, BasicType elem_bt, int index, address addr);

  static BasicType klass2bt(InstanceKlass* ik);
  static jint klass2length(InstanceKlass* ik);

 public:

   // Should be aligned with constants in jdk.internal.vm.vector.VectorSupport
  enum VectorOperation {
    // Unary
    VECTOR_OP_ABS     = 0,
    VECTOR_OP_NEG     = 1,
    VECTOR_OP_SQRT    = 2,
    VECTOR_OP_BIT_COUNT = 3,

    // Binary
    VECTOR_OP_ADD     = 4,
    VECTOR_OP_SUB     = 5,
    VECTOR_OP_MUL     = 6,
    VECTOR_OP_DIV     = 7,
    VECTOR_OP_MIN     = 8,
    VECTOR_OP_MAX     = 9,
    VECTOR_OP_AND     = 10,
    VECTOR_OP_OR      = 11,
    VECTOR_OP_XOR     = 12,

    // Ternary
    VECTOR_OP_FMA     = 13,

    // Broadcast int
    VECTOR_OP_LSHIFT  = 14,
    VECTOR_OP_RSHIFT  = 15,
    VECTOR_OP_URSHIFT = 16,

    // Convert
    VECTOR_OP_CAST        = 17,
    VECTOR_OP_UCAST       = 18,
    VECTOR_OP_REINTERPRET = 19,

    // Mask manipulation operations
    VECTOR_OP_MASK_TRUECOUNT = 20,
    VECTOR_OP_MASK_FIRSTTRUE = 21,
    VECTOR_OP_MASK_LASTTRUE  = 22,
    VECTOR_OP_MASK_TOLONG    = 23,

    // Rotate operations
    VECTOR_OP_LROTATE = 24,
    VECTOR_OP_RROTATE = 25,

    VECTOR_OP_COMPRESS = 26,
    VECTOR_OP_EXPAND = 27,
    VECTOR_OP_MASK_COMPRESS = 28,

    VECTOR_OP_TZ_COUNT = 29,
    VECTOR_OP_LZ_COUNT = 30,
    VECTOR_OP_REVERSE  = 31,
    VECTOR_OP_REVERSE_BYTES = 32,
    VECTOR_OP_COMPRESS_BITS = 33,
    VECTOR_OP_EXPAND_BITS = 34,

    VECTOR_OP_SADD  = 119,
    VECTOR_OP_SSUB  = 120,
    VECTOR_OP_SUADD = 121,
    VECTOR_OP_SUSUB = 122,
    VECTOR_OP_UMIN  = 123,
    VECTOR_OP_UMAX  = 124,
  };

  enum {
    VEC_SIZE_64 = 0,
    VEC_SIZE_128 = 1,
    VEC_SIZE_256 = 2,
    VEC_SIZE_512 = 3,
    VEC_SIZE_SCALABLE = 4,
    NUM_VEC_SIZES = 5
  };

  enum {
    MODE_BROADCAST = 0,
    MODE_BITS_COERCED_LONG_TO_MASK = 1
  };

  static int vop2ideal(jint vop, BasicType bt);
  static bool has_scalar_op(jint id);
  static bool is_unsigned_op(jint id);

  static instanceOop allocate_vector(InstanceKlass* holder, frame* fr, RegisterMap* reg_map, ObjectValue* sv, TRAPS);

  static bool is_vector(Klass* klass);
  static bool is_vector_mask(Klass* klass);
};
#endif // SHARE_PRIMS_VECTORSUPPORT_HPP