/*

 * Copyright (c) 2011, 2019, 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_JVMCI_JVMCICOMPILERTOVM_HPP

#define SHARE_JVMCI_JVMCICOMPILERTOVM_HPP

#include "jni.h"

#include "runtime/javaCalls.hpp"

#include "jvmci/jvmciJavaClasses.hpp"

// Helper class to ensure that references to Klass* are kept alive for G1

class JVMCIKlassHandle : public StackObj {

 private:

  Klass*     _klass;

  Handle     _holder;

  Thread*    _thread;

  Klass*        klass() const                     { return _klass; }

  Klass*        non_null_klass() const            { assert(_klass != NULL, "resolving NULL _klass"); return _klass; }

 public:

  /* Constructors */

  JVMCIKlassHandle (Thread* thread) : _klass(NULL), _thread(thread) {}

  JVMCIKlassHandle (Thread* thread, Klass* klass);

  JVMCIKlassHandle (const JVMCIKlassHandle &h): _klass(h._klass), _holder(h._holder), _thread(h._thread) {}

  JVMCIKlassHandle& operator=(const JVMCIKlassHandle &s);

  JVMCIKlassHandle& operator=(Klass* klass);

  /* Operators for ease of use */

  Klass*        operator () () const            { return klass(); }

  Klass*        operator -> () const            { return non_null_klass(); }

  bool    operator == (Klass* o) const          { return klass() == o; }

  bool    operator == (const JVMCIKlassHandle& h) const  { return klass() == h.klass(); }

  /* Null checks */

  bool    is_null() const                      { return _klass == NULL; }

  bool    not_null() const                     { return _klass != NULL; }

};

class CompilerToVM {

 public:

  class Data {

    friend class JVMCIVMStructs;

   private:

    static int Klass_vtable_start_offset;

    static int Klass_vtable_length_offset;

    static int Method_extra_stack_entries;

    static address SharedRuntime_ic_miss_stub;

    static address SharedRuntime_handle_wrong_method_stub;

    static address SharedRuntime_deopt_blob_unpack;

    static address SharedRuntime_deopt_blob_uncommon_trap;

    static size_t ThreadLocalAllocBuffer_alignment_reserve;

    static CollectedHeap* Universe_collectedHeap;

    static int Universe_base_vtable_size;

    static address Universe_narrow_oop_base;

    static int Universe_narrow_oop_shift;

    static address Universe_narrow_klass_base;

    static int Universe_narrow_klass_shift;

    static uintptr_t Universe_verify_oop_mask;

    static uintptr_t Universe_verify_oop_bits;

    static void* Universe_non_oop_bits;

    static bool _supports_inline_contig_alloc;

    static HeapWord** _heap_end_addr;

    static HeapWord* volatile* _heap_top_addr;

    static int _max_oop_map_stack_offset;

    static int _fields_annotations_base_offset;

    static CardTable::CardValue* cardtable_start_address;

    static int cardtable_shift;

    static int vm_page_size;

    static int sizeof_vtableEntry;

    static int sizeof_ExceptionTableElement;

    static int sizeof_LocalVariableTableElement;

    static int sizeof_ConstantPool;

    static int sizeof_narrowKlass;

    static int sizeof_arrayOopDesc;

    static int sizeof_BasicLock;

    static address dsin;

    static address dcos;

    static address dtan;

    static address dexp;

    static address dlog;

    static address dlog10;

    static address dpow;

    static address symbol_init;

    static address symbol_clinit;

   public:

    static void initialize(TRAPS);

    static int max_oop_map_stack_offset() {

      assert(_max_oop_map_stack_offset > 0, "must be initialized");

      return Data::_max_oop_map_stack_offset;

    }

  };

  static bool cstring_equals(const char* const& s0, const char* const& s1) {

    return strcmp(s0, s1) == 0;

  }

  static unsigned cstring_hash(const char* const& s) {

    int h = 0;

    const char* p = s;

    while (*p != '\0') {

      h = 31 * h + *p;

      p++;

    }

    return h;

  }

  static JNINativeMethod methods[];

  static objArrayHandle initialize_intrinsics(TRAPS);

 public:

  static int methods_count();

  static inline Method* asMethod(jobject jvmci_method) {

    return (Method*) (address) HotSpotResolvedJavaMethodImpl::metaspaceMethod(jvmci_method);

  }

  static inline Method* asMethod(Handle jvmci_method) {

    return (Method*) (address) HotSpotResolvedJavaMethodImpl::metaspaceMethod(jvmci_method);

  }

  static inline Method* asMethod(oop jvmci_method) {

    return (Method*) (address) HotSpotResolvedJavaMethodImpl::metaspaceMethod(jvmci_method);

  }

  static inline ConstantPool* asConstantPool(jobject jvmci_constant_pool) {

    return (ConstantPool*) (address) HotSpotConstantPool::metaspaceConstantPool(jvmci_constant_pool);

  }

  static inline ConstantPool* asConstantPool(Handle jvmci_constant_pool) {

    return (ConstantPool*) (address) HotSpotConstantPool::metaspaceConstantPool(jvmci_constant_pool);

  }

  static inline ConstantPool* asConstantPool(oop jvmci_constant_pool) {

    return (ConstantPool*) (address) HotSpotConstantPool::metaspaceConstantPool(jvmci_constant_pool);

  }

  static inline Klass* asKlass(jobject jvmci_type) {

    return java_lang_Class::as_Klass(HotSpotResolvedObjectTypeImpl::javaClass(jvmci_type));

  }

  static inline Klass* asKlass(Handle jvmci_type) {

    return java_lang_Class::as_Klass(HotSpotResolvedObjectTypeImpl::javaClass(jvmci_type));

  }

  static inline Klass* asKlass(oop jvmci_type) {

    return java_lang_Class::as_Klass(HotSpotResolvedObjectTypeImpl::javaClass(jvmci_type));

  }

  static inline Klass* asKlass(jlong metaspaceKlass) {

    return (Klass*) (address) metaspaceKlass;

  }

  static inline MethodData* asMethodData(jlong metaspaceMethodData) {

    return (MethodData*) (address) metaspaceMethodData;

  }

  static oop get_jvmci_method(const methodHandle& method, TRAPS);

  static oop get_jvmci_type(JVMCIKlassHandle& klass, TRAPS);

};

class JavaArgumentUnboxer : public SignatureIterator {

 protected:

  JavaCallArguments*  _jca;

  arrayOop _args;

  int _index;

  Handle next_arg(BasicType expectedType);

 public:

  JavaArgumentUnboxer(Symbol* signature, JavaCallArguments*  jca, arrayOop args, bool is_static) : SignatureIterator(signature) {

    this->_return_type = T_ILLEGAL;

    _jca = jca;

    _index = 0;

    _args = args;

    if (!is_static) {

      _jca->push_oop(next_arg(T_OBJECT));

    }

    iterate();

    assert(_index == args->length(), "arg count mismatch with signature");

  }

  inline void do_bool()   { if (!is_return_type()) _jca->push_int(next_arg(T_BOOLEAN)->bool_field(java_lang_boxing_object::value_offset_in_bytes(T_BOOLEAN))); }

  inline void do_char()   { if (!is_return_type()) _jca->push_int(next_arg(T_CHAR)->char_field(java_lang_boxing_object::value_offset_in_bytes(T_CHAR))); }

  inline void do_short()  { if (!is_return_type()) _jca->push_int(next_arg(T_SHORT)->short_field(java_lang_boxing_object::value_offset_in_bytes(T_SHORT))); }

  inline void do_byte()   { if (!is_return_type()) _jca->push_int(next_arg(T_BYTE)->byte_field(java_lang_boxing_object::value_offset_in_bytes(T_BYTE))); }

  inline void do_int()    { if (!is_return_type()) _jca->push_int(next_arg(T_INT)->int_field(java_lang_boxing_object::value_offset_in_bytes(T_INT))); }

  inline void do_long()   { if (!is_return_type()) _jca->push_long(next_arg(T_LONG)->long_field(java_lang_boxing_object::value_offset_in_bytes(T_LONG))); }

  inline void do_float()  { if (!is_return_type()) _jca->push_float(next_arg(T_FLOAT)->float_field(java_lang_boxing_object::value_offset_in_bytes(T_FLOAT))); }

  inline void do_double() { if (!is_return_type()) _jca->push_double(next_arg(T_DOUBLE)->double_field(java_lang_boxing_object::value_offset_in_bytes(T_DOUBLE))); }

  inline void do_object() { _jca->push_oop(next_arg(T_OBJECT)); }

  inline void do_object(int begin, int end) { if (!is_return_type()) _jca->push_oop(next_arg(T_OBJECT)); }

  inline void do_array(int begin, int end)  { if (!is_return_type()) _jca->push_oop(next_arg(T_OBJECT)); }

  inline void do_void()                     { }

};

class JNIHandleMark : public StackObj {

  public:

    JNIHandleMark() { push_jni_handle_block(); }

    ~JNIHandleMark() { pop_jni_handle_block(); }

  private:

    static void push_jni_handle_block();

    static void pop_jni_handle_block();

};

#endif // SHARE_JVMCI_JVMCICOMPILERTOVM_HPP