/*

 * Copyright (c) 1997, 2016, 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_CLASSFILE_JAVACLASSES_HPP

#define SHARE_VM_CLASSFILE_JAVACLASSES_HPP

#include "classfile/systemDictionary.hpp"

#include "jvmtifiles/jvmti.h"

#include "oops/oop.hpp"

#include "runtime/os.hpp"

#include "utilities/utf8.hpp"

// Interface for manipulating the basic Java classes.

//

// All dependencies on layout of actual Java classes should be kept here.

// If the layout of any of the classes above changes the offsets must be adjusted.

//

// For most classes we hardwire the offsets for performance reasons. In certain

// cases (e.g. java.security.AccessControlContext) we compute the offsets at

// startup since the layout here differs between JDK1.2 and JDK1.3.

//

// Note that fields (static and non-static) are arranged with oops before non-oops

// on a per class basis. The offsets below have to reflect this ordering.

//

// When editing the layouts please update the check_offset verification code

// correspondingly. The names in the enums must be identical to the actual field

// names in order for the verification code to work.

// Interface to java.lang.String objects

class java_lang_String : AllStatic {

 private:

  static int value_offset;

  static int hash_offset;

  static int coder_offset;

  static bool initialized;

  static Handle basic_create(int length, bool byte_arr, TRAPS);

  static inline void set_coder(oop string, jbyte coder);

 public:

  // Coders

  enum Coder {

    CODER_LATIN1 =  0,

    CODER_UTF16  =  1

  };

  static void compute_offsets();

  // Instance creation

  static Handle create_from_unicode(jchar* unicode, int len, TRAPS);

  static oop    create_oop_from_unicode(jchar* unicode, int len, TRAPS);

  static Handle create_from_str(const char* utf8_str, TRAPS);

  static oop    create_oop_from_str(const char* utf8_str, TRAPS);

  static Handle create_from_symbol(Symbol* symbol, TRAPS);

  static Handle create_from_platform_dependent_str(const char* str, TRAPS);

  static Handle char_converter(Handle java_string, jchar from_char, jchar to_char, TRAPS);

  static bool has_hash_field()  {

    assert(initialized, "Must be initialized");

    return (hash_offset > 0);

  }

  static bool has_coder_field()  {

    assert(initialized, "Must be initialized");

    return (coder_offset > 0);

  }

  static void set_compact_strings(bool value);

  static int value_offset_in_bytes()  {

    assert(initialized && (value_offset > 0), "Must be initialized");

    return value_offset;

  }

  static int hash_offset_in_bytes()   {

    assert(initialized && (hash_offset > 0), "Must be initialized");

    return hash_offset;

  }

  static int coder_offset_in_bytes()   {

    assert(initialized && (coder_offset > 0), "Must be initialized");

    return coder_offset;

  }

  static inline void set_value_raw(oop string, typeArrayOop buffer);

  static inline void set_value(oop string, typeArrayOop buffer);

  static inline void set_hash(oop string, unsigned int hash);

  // Accessors

  static inline typeArrayOop value(oop java_string);

  static inline unsigned int hash(oop java_string);

  static inline bool is_latin1(oop java_string);

  static inline int length(oop java_string);

  static int utf8_length(oop java_string);

  // String converters

  static char*  as_utf8_string(oop java_string);

  static char*  as_utf8_string(oop java_string, char* buf, int buflen);

  static char*  as_utf8_string(oop java_string, int start, int len);

  static char*  as_utf8_string(oop java_string, int start, int len, char* buf, int buflen);

  static char*  as_platform_dependent_str(Handle java_string, TRAPS);

  static jchar* as_unicode_string(oop java_string, int& length, TRAPS);

  // produce an ascii string with all other values quoted using \u####

  static char*  as_quoted_ascii(oop java_string);

  // Compute the hash value for a java.lang.String object which would

  // contain the characters passed in.

  //

  // As the hash value used by the String object itself, in

  // String.hashCode().  This value is normally calculated in Java code

  // in the String.hashCode method(), but is precomputed for String

  // objects in the shared archive file.

  // hash P(31) from Kernighan & Ritchie

  //

  // For this reason, THIS ALGORITHM MUST MATCH String.hashCode().

  static unsigned int hash_code(const jchar* s, int len) {

    unsigned int h = 0;

    while (len-- > 0) {

      h = 31*h + (unsigned int) *s;

      s++;

    }

    return h;

  }

  static unsigned int hash_code(const jbyte* s, int len) {

    unsigned int h = 0;

    while (len-- > 0) {

      h = 31*h + (((unsigned int) *s) & 0xFF);

      s++;

    }

    return h;

  }

  static unsigned int hash_code(oop java_string);

  static bool equals(oop java_string, jchar* chars, int len);

  static bool equals(oop str1, oop str2);

  // Conversion between '.' and '/' formats

  static Handle externalize_classname(Handle java_string, TRAPS) { return char_converter(java_string, '/', '.', THREAD); }

  static Handle internalize_classname(Handle java_string, TRAPS) { return char_converter(java_string, '.', '/', THREAD); }

  // Conversion

  static Symbol* as_symbol(Handle java_string, TRAPS);

  static Symbol* as_symbol_or_null(oop java_string);

  // Testers

  static bool is_instance(oop obj);

  static inline bool is_instance_inlined(oop obj);

  // Debugging

  static void print(oop java_string, outputStream* st);

  friend class JavaClasses;

  friend class StringTable;

};

// Interface to java.lang.Class objects

#define CLASS_INJECTED_FIELDS(macro)                                       \

  macro(java_lang_Class, klass,                  intptr_signature,  false) \

  macro(java_lang_Class, array_klass,            intptr_signature,  false) \

  macro(java_lang_Class, oop_size,               int_signature,     false) \

  macro(java_lang_Class, static_oop_field_count, int_signature,     false) \

  macro(java_lang_Class, protection_domain,      object_signature,  false) \

  macro(java_lang_Class, signers,                object_signature,  false)

class java_lang_Class : AllStatic {

  friend class VMStructs;

  friend class JVMCIVMStructs;

 private:

  // The fake offsets are added by the class loader when java.lang.Class is loaded

  static int _klass_offset;

  static int _array_klass_offset;

  static int _oop_size_offset;

  static int _static_oop_field_count_offset;

  static int _protection_domain_offset;

  static int _init_lock_offset;

  static int _signers_offset;

  static int _class_loader_offset;

  static int _module_offset;

  static int _component_mirror_offset;

  static bool offsets_computed;

  static int classRedefinedCount_offset;

  static GrowableArray<Klass*>* _fixup_mirror_list;

  static GrowableArray<Klass*>* _fixup_module_field_list;

  static void set_init_lock(oop java_class, oop init_lock);

  static void set_protection_domain(oop java_class, oop protection_domain);

  static void set_class_loader(oop java_class, oop class_loader);

  static void set_component_mirror(oop java_class, oop comp_mirror);

  static void initialize_mirror_fields(KlassHandle k, Handle mirror, Handle protection_domain, TRAPS);

 public:

  static void compute_offsets();

  // Instance creation

  static void create_mirror(KlassHandle k, Handle class_loader, Handle module,

                            Handle protection_domain, TRAPS);

  static void fixup_mirror(KlassHandle k, TRAPS);

  static oop  create_basic_type_mirror(const char* basic_type_name, BasicType type, TRAPS);

  static void fixup_module_field(KlassHandle k, Handle module);

  // Conversion

  static Klass* as_Klass(oop java_class);

  static void set_klass(oop java_class, Klass* klass);

  static BasicType as_BasicType(oop java_class, Klass** reference_klass = NULL);

  static BasicType as_BasicType(oop java_class, KlassHandle* reference_klass) {

    Klass* refk_oop = NULL;

    BasicType result = as_BasicType(java_class, &refk_oop);

    (*reference_klass) = KlassHandle(refk_oop);

    return result;

  }

  static Symbol* as_signature(oop java_class, bool intern_if_not_found, TRAPS);

  static void print_signature(oop java_class, outputStream *st);

  static const char* as_external_name(oop java_class);

  // Testing

  static bool is_instance(oop obj);

  static bool is_primitive(oop java_class);

  static BasicType primitive_type(oop java_class);

  static oop primitive_mirror(BasicType t);

  // JVM_NewArray support

  static Klass* array_klass(oop java_class);

  static void set_array_klass(oop java_class, Klass* klass);

  // compiler support for class operations

  static int klass_offset_in_bytes()                { return _klass_offset; }

  static int array_klass_offset_in_bytes()          { return _array_klass_offset; }

  // Support for classRedefinedCount field

  static int classRedefinedCount(oop the_class_mirror);

  static void set_classRedefinedCount(oop the_class_mirror, int value);

  // Support for embedded per-class oops

  static oop  protection_domain(oop java_class);

  static oop  init_lock(oop java_class);

  static oop  component_mirror(oop java_class);

  static objArrayOop  signers(oop java_class);

  static void set_signers(oop java_class, objArrayOop signers);

  static oop class_loader(oop java_class);

  static void set_module(oop java_class, oop module);

  static oop module(oop java_class);

  static int oop_size(oop java_class);

  static void set_oop_size(oop java_class, int size);

  static int static_oop_field_count(oop java_class);

  static void set_static_oop_field_count(oop java_class, int size);

  static GrowableArray<Klass*>* fixup_mirror_list() {

    return _fixup_mirror_list;

  }

  static void set_fixup_mirror_list(GrowableArray<Klass*>* v) {

    _fixup_mirror_list = v;

  }

  static GrowableArray<Klass*>* fixup_module_field_list() {

    return _fixup_module_field_list;

  }

  static void set_fixup_module_field_list(GrowableArray<Klass*>* v) {

    _fixup_module_field_list = v;

  }

  // Debugging

  friend class JavaClasses;

  friend class InstanceKlass;   // verification code accesses offsets

  friend class ClassFileParser; // access to number_of_fake_fields

};

// Interface to java.lang.Thread objects

class java_lang_Thread : AllStatic {

 private:

  // Note that for this class the layout changed between JDK1.2 and JDK1.3,

  // so we compute the offsets at startup rather than hard-wiring them.

  static int _name_offset;

  static int _group_offset;

  static int _contextClassLoader_offset;

  static int _inheritedAccessControlContext_offset;

  static int _priority_offset;

  static int _eetop_offset;

  static int _daemon_offset;

  static int _stillborn_offset;

  static int _stackSize_offset;

  static int _tid_offset;

  static int _thread_status_offset;

  static int _park_blocker_offset;

  static int _park_event_offset ;

  static void compute_offsets();

 public:

  // Instance creation

  static oop create();

  // Returns the JavaThread associated with the thread obj

  static JavaThread* thread(oop java_thread);

  // Set JavaThread for instance

  static void set_thread(oop java_thread, JavaThread* thread);

  // Name

  static oop name(oop java_thread);

  static void set_name(oop java_thread, oop name);

  // Priority

  static ThreadPriority priority(oop java_thread);

  static void set_priority(oop java_thread, ThreadPriority priority);

  // Thread group

  static oop  threadGroup(oop java_thread);

  // Stillborn

  static bool is_stillborn(oop java_thread);

  static void set_stillborn(oop java_thread);

  // Alive (NOTE: this is not really a field, but provides the correct

  // definition without doing a Java call)

  static bool is_alive(oop java_thread);

  // Daemon

  static bool is_daemon(oop java_thread);

  static void set_daemon(oop java_thread);

  // Context ClassLoader

  static oop context_class_loader(oop java_thread);

  // Control context

  static oop inherited_access_control_context(oop java_thread);

  // Stack size hint

  static jlong stackSize(oop java_thread);

  // Thread ID

  static jlong thread_id(oop java_thread);

  // Blocker object responsible for thread parking

  static oop park_blocker(oop java_thread);

  // Pointer to type-stable park handler, encoded as jlong.

  // Should be set when apparently null

  // For details, see unsafe.cpp Unsafe_Unpark

  static jlong park_event(oop java_thread);

  static bool set_park_event(oop java_thread, jlong ptr);

  // Java Thread Status for JVMTI and M&M use.

  // This thread status info is saved in threadStatus field of

  // java.lang.Thread java class.

  enum ThreadStatus {

    NEW                      = 0,

    RUNNABLE                 = JVMTI_THREAD_STATE_ALIVE +          // runnable / running

                               JVMTI_THREAD_STATE_RUNNABLE,

    SLEEPING                 = JVMTI_THREAD_STATE_ALIVE +          // Thread.sleep()

                               JVMTI_THREAD_STATE_WAITING +

                               JVMTI_THREAD_STATE_WAITING_WITH_TIMEOUT +

                               JVMTI_THREAD_STATE_SLEEPING,

    IN_OBJECT_WAIT           = JVMTI_THREAD_STATE_ALIVE +          // Object.wait()

                               JVMTI_THREAD_STATE_WAITING +

                               JVMTI_THREAD_STATE_WAITING_INDEFINITELY +

                               JVMTI_THREAD_STATE_IN_OBJECT_WAIT,

    IN_OBJECT_WAIT_TIMED     = JVMTI_THREAD_STATE_ALIVE +          // Object.wait(long)

                               JVMTI_THREAD_STATE_WAITING +

                               JVMTI_THREAD_STATE_WAITING_WITH_TIMEOUT +

                               JVMTI_THREAD_STATE_IN_OBJECT_WAIT,

    PARKED                   = JVMTI_THREAD_STATE_ALIVE +          // LockSupport.park()

                               JVMTI_THREAD_STATE_WAITING +

                               JVMTI_THREAD_STATE_WAITING_INDEFINITELY +

                               JVMTI_THREAD_STATE_PARKED,

    PARKED_TIMED             = JVMTI_THREAD_STATE_ALIVE +          // LockSupport.park(long)

                               JVMTI_THREAD_STATE_WAITING +

                               JVMTI_THREAD_STATE_WAITING_WITH_TIMEOUT +

                               JVMTI_THREAD_STATE_PARKED,

    BLOCKED_ON_MONITOR_ENTER = JVMTI_THREAD_STATE_ALIVE +          // (re-)entering a synchronization block

                               JVMTI_THREAD_STATE_BLOCKED_ON_MONITOR_ENTER,

    TERMINATED               = JVMTI_THREAD_STATE_TERMINATED

  };

  // Write thread status info to threadStatus field of java.lang.Thread.

  static void set_thread_status(oop java_thread_oop, ThreadStatus status);

  // Read thread status info from threadStatus field of java.lang.Thread.

  static ThreadStatus get_thread_status(oop java_thread_oop);

  static const char*  thread_status_name(oop java_thread_oop);

  // Debugging

  friend class JavaClasses;

};

// Interface to java.lang.ThreadGroup objects

class java_lang_ThreadGroup : AllStatic {

 private:

  static int _parent_offset;

  static int _name_offset;

  static int _threads_offset;

  static int _groups_offset;

  static int _maxPriority_offset;

  static int _destroyed_offset;

  static int _daemon_offset;

  static int _nthreads_offset;

  static int _ngroups_offset;

  static void compute_offsets();

 public:

  // parent ThreadGroup

  static oop  parent(oop java_thread_group);

  // name

  static const char* name(oop java_thread_group);

  // ("name as oop" accessor is not necessary)

  // Number of threads in group

  static int nthreads(oop java_thread_group);

  // threads

  static objArrayOop threads(oop java_thread_group);

  // Number of threads in group

  static int ngroups(oop java_thread_group);

  // groups

  static objArrayOop groups(oop java_thread_group);

  // maxPriority in group

  static ThreadPriority maxPriority(oop java_thread_group);

  // Destroyed

  static bool is_destroyed(oop java_thread_group);

  // Daemon

  static bool is_daemon(oop java_thread_group);

  // Debugging

  friend class JavaClasses;

};

// Interface to java.lang.Throwable objects

class java_lang_Throwable: AllStatic {

  friend class BacktraceBuilder;

  friend class BacktraceIterator;

 private:

  // Offsets

  enum {

    hc_backtrace_offset     =  0,

    hc_detailMessage_offset =  1,

    hc_cause_offset         =  2,  // New since 1.4

    hc_stackTrace_offset    =  3   // New since 1.4

  };

  enum {

      hc_static_unassigned_stacktrace_offset = 0  // New since 1.7

  };

  // Trace constants

  enum {

    trace_methods_offset = 0,

    trace_bcis_offset    = 1,

    trace_mirrors_offset = 2,

    trace_cprefs_offset  = 3,

    trace_next_offset    = 4,

    trace_size           = 5,

    trace_chunk_size     = 32

  };

  static int backtrace_offset;

  static int detailMessage_offset;

  static int stackTrace_offset;

  static int depth_offset;

  static int static_unassigned_stacktrace_offset;

  // StackTrace (programmatic access, new since 1.4)

  static void clear_stacktrace(oop throwable);

  // Stacktrace (post JDK 1.7.0 to allow immutability protocol to be followed)

  static void set_stacktrace(oop throwable, oop st_element_array);

  static oop unassigned_stacktrace();

 public:

  // Backtrace

  static oop backtrace(oop throwable);

  static void set_backtrace(oop throwable, oop value);

  static int depth(oop throwable);

  static void set_depth(oop throwable, int value);

  // Needed by JVMTI to filter out this internal field.

  static int get_backtrace_offset() { return backtrace_offset;}

  static int get_detailMessage_offset() { return detailMessage_offset;}

  // Message

  static oop message(Handle throwable);

  static void set_message(oop throwable, oop value);

  static Symbol* detail_message(oop throwable);

  static void print_stack_element(outputStream *st, const methodHandle& method, int bci);

  static void print_stack_usage(Handle stream);

  static void compute_offsets();

  // Allocate space for backtrace (created but stack trace not filled in)

  static void allocate_backtrace(Handle throwable, TRAPS);