/*

 * Copyright (c) 1998, 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_CODE_CODEBLOB_HPP

#define SHARE_VM_CODE_CODEBLOB_HPP

#include "asm/codeBuffer.hpp"

#include "compiler/oopMap.hpp"

#include "runtime/frame.hpp"

#include "runtime/handles.hpp"

// CodeBlob - superclass for all entries in the CodeCache.

//

// Suptypes are:

//   nmethod            : Compiled Java methods (include method that calls to native code)

//   RuntimeStub        : Call to VM runtime methods

//   DeoptimizationBlob : Used for deoptimizatation

//   ExceptionBlob      : Used for stack unrolling

//   SafepointBlob      : Used to handle illegal instruction exceptions

//

//

// Layout:

//   - header

//   - relocation

//   - content space

//     - instruction space

//   - data space

class DeoptimizationBlob;

class CodeBlob VALUE_OBJ_CLASS_SPEC {

  friend class VMStructs;

 private:

  const char* _name;

  int        _size;                              // total size of CodeBlob in bytes

  int        _header_size;                       // size of header (depends on subclass)

  int        _relocation_size;                   // size of relocation

  int        _content_offset;                    // offset to where content region begins (this includes consts, insts, stubs)

  int        _code_offset;                       // offset to where instructions region begins (this includes insts, stubs)

  int        _frame_complete_offset;             // instruction offsets in [0.._frame_complete_offset) have

                                                 // not finished setting up their frame. Beware of pc's in

                                                 // that range. There is a similar range(s) on returns

                                                 // which we don't detect.

  int        _data_offset;                       // offset to where data region begins

  int        _frame_size;                        // size of stack frame

  OopMapSet* _oop_maps;                          // OopMap for this CodeBlob

  CodeStrings _strings;

 public:

  // Returns the space needed for CodeBlob

  static unsigned int allocation_size(CodeBuffer* cb, int header_size);

  // Creation

  // a) simple CodeBlob

  // frame_complete is the offset from the beginning of the instructions

  // to where the frame setup (from stackwalk viewpoint) is complete.

  CodeBlob(const char* name, int header_size, int size, int frame_complete, int locs_size);

  // b) full CodeBlob

  CodeBlob(

    const char* name,

    CodeBuffer* cb,

    int         header_size,

    int         size,

    int         frame_complete,

    int         frame_size,

    OopMapSet*  oop_maps

  );

  // Deletion

  void flush();

  // Typing

  virtual bool is_buffer_blob() const            { return false; }

  virtual bool is_nmethod() const                { return false; }

  virtual bool is_runtime_stub() const           { return false; }

  virtual bool is_deoptimization_stub() const    { return false; }

  virtual bool is_uncommon_trap_stub() const     { return false; }

  virtual bool is_exception_stub() const         { return false; }

  virtual bool is_safepoint_stub() const              { return false; }

  virtual bool is_adapter_blob() const                { return false; }

  virtual bool is_method_handles_adapter_blob() const { return false; }

  virtual bool is_compiled_by_c2() const         { return false; }

  virtual bool is_compiled_by_c1() const         { return false; }

  // Casting

  nmethod* as_nmethod_or_null()                  { return is_nmethod() ? (nmethod*) this : NULL; }

  // Boundaries

  address    header_begin() const                { return (address)    this; }

  address    header_end() const                  { return ((address)   this) + _header_size; };

  relocInfo* relocation_begin() const            { return (relocInfo*) header_end(); };

  relocInfo* relocation_end() const              { return (relocInfo*)(header_end()   + _relocation_size); }

  address    content_begin() const               { return (address)    header_begin() + _content_offset; }

  address    content_end() const                 { return (address)    header_begin() + _data_offset; }

  address    code_begin() const                  { return (address)    header_begin() + _code_offset; }

  address    code_end() const                    { return (address)    header_begin() + _data_offset; }

  address    data_begin() const                  { return (address)    header_begin() + _data_offset; }

  address    data_end() const                    { return (address)    header_begin() + _size; }

  // Offsets

  int relocation_offset() const                  { return _header_size; }

  int content_offset() const                     { return _content_offset; }

  int code_offset() const                        { return _code_offset; }

  int data_offset() const                        { return _data_offset; }

  // Sizes

  int size() const                               { return _size; }

  int header_size() const                        { return _header_size; }

  int relocation_size() const                    { return (address) relocation_end() - (address) relocation_begin(); }

  int content_size() const                       { return           content_end()    -           content_begin();    }

  int code_size() const                          { return           code_end()       -           code_begin();       }

  int data_size() const                          { return           data_end()       -           data_begin();       }

  // Containment

  bool blob_contains(address addr) const         { return header_begin()       <= addr && addr < data_end();       }

  bool relocation_contains(relocInfo* addr) const{ return relocation_begin()   <= addr && addr < relocation_end(); }

  bool content_contains(address addr) const      { return content_begin()      <= addr && addr < content_end();    }

  bool code_contains(address addr) const         { return code_begin()         <= addr && addr < code_end();       }

  bool data_contains(address addr) const         { return data_begin()         <= addr && addr < data_end();       }

  bool contains(address addr) const              { return content_contains(addr); }

  bool is_frame_complete_at(address addr) const  { return code_contains(addr) &&

                                                          addr >= code_begin() + _frame_complete_offset; }

  // CodeCache support: really only used by the nmethods, but in order to get

  // asserts and certain bookkeeping to work in the CodeCache they are defined

  // virtual here.

  virtual bool is_zombie() const                 { return false; }

  virtual bool is_locked_by_vm() const           { return false; }

  virtual bool is_unloaded() const               { return false; }

  virtual bool is_not_entrant() const            { return false; }

  // GC support

  virtual bool is_alive() const                  = 0;

  // OopMap for frame

  OopMapSet* oop_maps() const                    { return _oop_maps; }

  void set_oop_maps(OopMapSet* p);

  OopMap* oop_map_for_return_address(address return_address);

  virtual void preserve_callee_argument_oops(frame fr, const RegisterMap* reg_map, OopClosure* f)  { ShouldNotReachHere(); }

  // Frame support

  int  frame_size() const                        { return _frame_size; }

  void set_frame_size(int size)                  { _frame_size = size; }

  // Returns true, if the next frame is responsible for GC'ing oops passed as arguments

  virtual bool caller_must_gc_arguments(JavaThread* thread) const { return false; }

  // Naming

  const char* name() const                       { return _name; }

  void set_name(const char* name)                { _name = name; }

  // Debugging

  virtual void verify();

  void print() const                             { print_on(tty); }

  virtual void print_on(outputStream* st) const;

  virtual void print_value_on(outputStream* st) const;

  // Deal with Disassembler, VTune, Forte, JvmtiExport, MemoryService.

  static void trace_new_stub(CodeBlob* blob, const char* name1, const char* name2 = "");

  // Print the comment associated with offset on stream, if there is one

  virtual void print_block_comment(outputStream* stream, address block_begin) const {

    intptr_t offset = (intptr_t)(block_begin - code_begin());

    _strings.print_block_comment(stream, offset);

  }

  // Transfer ownership of comments to this CodeBlob

  void set_strings(CodeStrings& strings) {

    _strings.assign(strings);

  }

};

//----------------------------------------------------------------------------------------------------

// BufferBlob: used to hold non-relocatable machine code such as the interpreter, stubroutines, etc.

class BufferBlob: public CodeBlob {

  friend class VMStructs;

  friend class AdapterBlob;

  friend class MethodHandlesAdapterBlob;

 private:

  // Creation support

  BufferBlob(const char* name, int size);

  BufferBlob(const char* name, int size, CodeBuffer* cb);

  void* operator new(size_t s, unsigned size, bool is_critical = false) throw();

 public:

  // Creation

  static BufferBlob* create(const char* name, int buffer_size);

  static BufferBlob* create(const char* name, CodeBuffer* cb);

  static void free(BufferBlob* buf);

  // Typing

  virtual bool is_buffer_blob() const            { return true; }

  // GC/Verification support

  void preserve_callee_argument_oops(frame fr, const RegisterMap* reg_map, OopClosure* f)  { /* nothing to do */ }

  bool is_alive() const                          { return true; }

  void verify();

  void print_on(outputStream* st) const;

  void print_value_on(outputStream* st) const;

};

//----------------------------------------------------------------------------------------------------

// AdapterBlob: used to hold C2I/I2C adapters

class AdapterBlob: public BufferBlob {

private:

  AdapterBlob(int size, CodeBuffer* cb);

public:

  // Creation

  static AdapterBlob* create(CodeBuffer* cb);

  // Typing

  virtual bool is_adapter_blob() const { return true; }

};

//----------------------------------------------------------------------------------------------------

// MethodHandlesAdapterBlob: used to hold MethodHandles adapters

class MethodHandlesAdapterBlob: public BufferBlob {

private:

  MethodHandlesAdapterBlob(int size)                 : BufferBlob("MethodHandles adapters", size) {}

public:

  // Creation

  static MethodHandlesAdapterBlob* create(int buffer_size);

  // Typing

  virtual bool is_method_handles_adapter_blob() const { return true; }

};

//----------------------------------------------------------------------------------------------------

// RuntimeStub: describes stubs used by compiled code to call a (static) C++ runtime routine

class RuntimeStub: public CodeBlob {

  friend class VMStructs;

 private:

  bool        _caller_must_gc_arguments;

  // Creation support

  RuntimeStub(

    const char* name,

    CodeBuffer* cb,

    int         size,

    int         frame_complete,

    int         frame_size,

    OopMapSet*  oop_maps,

    bool        caller_must_gc_arguments

  );

  void* operator new(size_t s, unsigned size) throw();

 public:

  // Creation

  static RuntimeStub* new_runtime_stub(

    const char* stub_name,

    CodeBuffer* cb,

    int         frame_complete,

    int         frame_size,

    OopMapSet*  oop_maps,

    bool        caller_must_gc_arguments

  );

  // Typing

  bool is_runtime_stub() const                   { return true; }

  // GC support

  bool caller_must_gc_arguments(JavaThread* thread) const { return _caller_must_gc_arguments; }

  address entry_point()                          { return code_begin(); }

  // GC/Verification support

  void preserve_callee_argument_oops(frame fr, const RegisterMap *reg_map, OopClosure* f)  { /* nothing to do */ }

  bool is_alive() const                          { return true; }

  void verify();

  void print_on(outputStream* st) const;

  void print_value_on(outputStream* st) const;

};

//----------------------------------------------------------------------------------------------------

// Super-class for all blobs that exist in only one instance. Implements default behaviour.

class SingletonBlob: public CodeBlob {

  friend class VMStructs;

 protected:

  void* operator new(size_t s, unsigned size) throw();

 public:

   SingletonBlob(

     const char* name,

     CodeBuffer* cb,

     int         header_size,

     int         size,

     int         frame_size,

     OopMapSet*  oop_maps

   )

   : CodeBlob(name, cb, header_size, size, CodeOffsets::frame_never_safe, frame_size, oop_maps)

  {};

  address entry_point()                          { return code_begin(); }

  bool is_alive() const                          { return true; }

  void verify(); // does nothing

  void print_on(outputStream* st) const;

  void print_value_on(outputStream* st) const;

};

//----------------------------------------------------------------------------------------------------

// DeoptimizationBlob

class DeoptimizationBlob: public SingletonBlob {

  friend class VMStructs;

 private:

  int _unpack_offset;

  int _unpack_with_exception;

  int _unpack_with_reexecution;

  int _unpack_with_exception_in_tls;

  // Creation support

  DeoptimizationBlob(

    CodeBuffer* cb,

    int         size,

    OopMapSet*  oop_maps,

    int         unpack_offset,

    int         unpack_with_exception_offset,

    int         unpack_with_reexecution_offset,

    int         frame_size

  );

 public:

  // Creation

  static DeoptimizationBlob* create(

    CodeBuffer* cb,

    OopMapSet*  oop_maps,

    int         unpack_offset,

    int         unpack_with_exception_offset,

    int         unpack_with_reexecution_offset,

    int         frame_size

  );

  // Typing

  bool is_deoptimization_stub() const { return true; }

  bool exception_address_is_unpack_entry(address pc) const {

    address unpack_pc = unpack();

    return (pc == unpack_pc || (pc + frame::pc_return_offset) == unpack_pc);

  }

  // GC for args

  void preserve_callee_argument_oops(frame fr, const RegisterMap *reg_map, OopClosure* f) { /* Nothing to do */ }

  // Printing

  void print_value_on(outputStream* st) const;

  address unpack() const                         { return code_begin() + _unpack_offset;           }

  address unpack_with_exception() const          { return code_begin() + _unpack_with_exception;   }

  address unpack_with_reexecution() const        { return code_begin() + _unpack_with_reexecution; }

  // Alternate entry point for C1 where the exception and issuing pc

  // are in JavaThread::_exception_oop and JavaThread::_exception_pc

  // instead of being in registers.  This is needed because C1 doesn't

  // model exception paths in a way that keeps these registers free so

  // there may be live values in those registers during deopt.

  void set_unpack_with_exception_in_tls_offset(int offset) {

    _unpack_with_exception_in_tls = offset;

    assert(code_contains(code_begin() + _unpack_with_exception_in_tls), "must be PC inside codeblob");

  }

  address unpack_with_exception_in_tls() const   { return code_begin() + _unpack_with_exception_in_tls; }

};

//----------------------------------------------------------------------------------------------------

// UncommonTrapBlob (currently only used by Compiler 2)

#ifdef COMPILER2

class UncommonTrapBlob: public SingletonBlob {

  friend class VMStructs;

 private:

  // Creation support

  UncommonTrapBlob(

    CodeBuffer* cb,

    int         size,

    OopMapSet*  oop_maps,

    int         frame_size

  );

 public:

  // Creation

  static UncommonTrapBlob* create(

    CodeBuffer* cb,

    OopMapSet*  oop_maps,

    int         frame_size

  );

  // GC for args

  void preserve_callee_argument_oops(frame fr, const RegisterMap *reg_map, OopClosure* f)  { /* nothing to do */ }

  // Typing

  bool is_uncommon_trap_stub() const             { return true; }

};

//----------------------------------------------------------------------------------------------------

// ExceptionBlob: used for exception unwinding in compiled code (currently only used by Compiler 2)

class ExceptionBlob: public SingletonBlob {

  friend class VMStructs;

 private:

  // Creation support

  ExceptionBlob(

    CodeBuffer* cb,

    int         size,

    OopMapSet*  oop_maps,

    int         frame_size

  );

 public:

  // Creation

  static ExceptionBlob* create(

    CodeBuffer* cb,

    OopMapSet*  oop_maps,

    int         frame_size

  );

  // GC for args

  void preserve_callee_argument_oops(frame fr, const RegisterMap* reg_map, OopClosure* f)  { /* nothing to do */ }

  // Typing

  bool is_exception_stub() const                 { return true; }

};

#endif // COMPILER2

//----------------------------------------------------------------------------------------------------

// SafepointBlob: handles illegal_instruction exceptions during a safepoint

class SafepointBlob: public SingletonBlob {

  friend class VMStructs;

 private:

  // Creation support

  SafepointBlob(

    CodeBuffer* cb,

    int         size,

    OopMapSet*  oop_maps,

    int         frame_size

  );

 public:

  // Creation

  static SafepointBlob* create(

    CodeBuffer* cb,

    OopMapSet*  oop_maps,

    int         frame_size

  );

  // GC for args

  void preserve_callee_argument_oops(frame fr, const RegisterMap* reg_map, OopClosure* f)  { /* nothing to do */ }

  // Typing

  bool is_safepoint_stub() const                 { return true; }

};

#endif // SHARE_VM_CODE_CODEBLOB_HPP