src/share/vm/code/codeBlob.hpp

Mon, 18 Mar 2013 13:19:06 +0100

author
roland
date
Mon, 18 Mar 2013 13:19:06 +0100
changeset 4767
a5de0cc2f91c
parent 4107
b31471cdc53e
child 5614
9758d9f36299
permissions
-rw-r--r--

8008555: Debugging code in compiled method sometimes leaks memory
Summary: support for strings that have same life-time as code that uses them.
Reviewed-by: kvn, twisti

     1 /*
     2  * Copyright (c) 1998, 2012, Oracle and/or its affiliates. All rights reserved.
     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     4  *
     5  * This code is free software; you can redistribute it and/or modify it
     6  * under the terms of the GNU General Public License version 2 only, as
     7  * published by the Free Software Foundation.
     8  *
     9  * This code is distributed in the hope that it will be useful, but WITHOUT
    10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    12  * version 2 for more details (a copy is included in the LICENSE file that
    13  * accompanied this code).
    14  *
    15  * You should have received a copy of the GNU General Public License version
    16  * 2 along with this work; if not, write to the Free Software Foundation,
    17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
    18  *
    19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
    20  * or visit www.oracle.com if you need additional information or have any
    21  * questions.
    22  *
    23  */
    25 #ifndef SHARE_VM_CODE_CODEBLOB_HPP
    26 #define SHARE_VM_CODE_CODEBLOB_HPP
    28 #include "asm/codeBuffer.hpp"
    29 #include "compiler/oopMap.hpp"
    30 #include "runtime/frame.hpp"
    31 #include "runtime/handles.hpp"
    33 // CodeBlob - superclass for all entries in the CodeCache.
    34 //
    35 // Suptypes are:
    36 //   nmethod            : Compiled Java methods (include method that calls to native code)
    37 //   RuntimeStub        : Call to VM runtime methods
    38 //   DeoptimizationBlob : Used for deoptimizatation
    39 //   ExceptionBlob      : Used for stack unrolling
    40 //   SafepointBlob      : Used to handle illegal instruction exceptions
    41 //
    42 //
    43 // Layout:
    44 //   - header
    45 //   - relocation
    46 //   - content space
    47 //     - instruction space
    48 //   - data space
    49 class DeoptimizationBlob;
    51 class CodeBlob VALUE_OBJ_CLASS_SPEC {
    53   friend class VMStructs;
    55  private:
    56   const char* _name;
    57   int        _size;                              // total size of CodeBlob in bytes
    58   int        _header_size;                       // size of header (depends on subclass)
    59   int        _relocation_size;                   // size of relocation
    60   int        _content_offset;                    // offset to where content region begins (this includes consts, insts, stubs)
    61   int        _code_offset;                       // offset to where instructions region begins (this includes insts, stubs)
    62   int        _frame_complete_offset;             // instruction offsets in [0.._frame_complete_offset) have
    63                                                  // not finished setting up their frame. Beware of pc's in
    64                                                  // that range. There is a similar range(s) on returns
    65                                                  // which we don't detect.
    66   int        _data_offset;                       // offset to where data region begins
    67   int        _frame_size;                        // size of stack frame
    68   OopMapSet* _oop_maps;                          // OopMap for this CodeBlob
    69   CodeStrings _strings;
    71  public:
    72   // Returns the space needed for CodeBlob
    73   static unsigned int allocation_size(CodeBuffer* cb, int header_size);
    75   // Creation
    76   // a) simple CodeBlob
    77   // frame_complete is the offset from the beginning of the instructions
    78   // to where the frame setup (from stackwalk viewpoint) is complete.
    79   CodeBlob(const char* name, int header_size, int size, int frame_complete, int locs_size);
    81   // b) full CodeBlob
    82   CodeBlob(
    83     const char* name,
    84     CodeBuffer* cb,
    85     int         header_size,
    86     int         size,
    87     int         frame_complete,
    88     int         frame_size,
    89     OopMapSet*  oop_maps
    90   );
    92   // Deletion
    93   void flush();
    95   // Typing
    96   virtual bool is_buffer_blob() const            { return false; }
    97   virtual bool is_nmethod() const                { return false; }
    98   virtual bool is_runtime_stub() const           { return false; }
    99   virtual bool is_deoptimization_stub() const    { return false; }
   100   virtual bool is_uncommon_trap_stub() const     { return false; }
   101   virtual bool is_exception_stub() const         { return false; }
   102   virtual bool is_safepoint_stub() const              { return false; }
   103   virtual bool is_adapter_blob() const                { return false; }
   104   virtual bool is_method_handles_adapter_blob() const { return false; }
   106   virtual bool is_compiled_by_c2() const         { return false; }
   107   virtual bool is_compiled_by_c1() const         { return false; }
   109   // Casting
   110   nmethod* as_nmethod_or_null()                  { return is_nmethod() ? (nmethod*) this : NULL; }
   112   // Boundaries
   113   address    header_begin() const                { return (address)    this; }
   114   address    header_end() const                  { return ((address)   this) + _header_size; };
   115   relocInfo* relocation_begin() const            { return (relocInfo*) header_end(); };
   116   relocInfo* relocation_end() const              { return (relocInfo*)(header_end()   + _relocation_size); }
   117   address    content_begin() const               { return (address)    header_begin() + _content_offset; }
   118   address    content_end() const                 { return (address)    header_begin() + _data_offset; }
   119   address    code_begin() const                  { return (address)    header_begin() + _code_offset; }
   120   address    code_end() const                    { return (address)    header_begin() + _data_offset; }
   121   address    data_begin() const                  { return (address)    header_begin() + _data_offset; }
   122   address    data_end() const                    { return (address)    header_begin() + _size; }
   124   // Offsets
   125   int relocation_offset() const                  { return _header_size; }
   126   int content_offset() const                     { return _content_offset; }
   127   int code_offset() const                        { return _code_offset; }
   128   int data_offset() const                        { return _data_offset; }
   130   // Sizes
   131   int size() const                               { return _size; }
   132   int header_size() const                        { return _header_size; }
   133   int relocation_size() const                    { return (address) relocation_end() - (address) relocation_begin(); }
   134   int content_size() const                       { return           content_end()    -           content_begin();    }
   135   int code_size() const                          { return           code_end()       -           code_begin();       }
   136   int data_size() const                          { return           data_end()       -           data_begin();       }
   138   // Containment
   139   bool blob_contains(address addr) const         { return header_begin()       <= addr && addr < data_end();       }
   140   bool relocation_contains(relocInfo* addr) const{ return relocation_begin()   <= addr && addr < relocation_end(); }
   141   bool content_contains(address addr) const      { return content_begin()      <= addr && addr < content_end();    }
   142   bool code_contains(address addr) const         { return code_begin()         <= addr && addr < code_end();       }
   143   bool data_contains(address addr) const         { return data_begin()         <= addr && addr < data_end();       }
   144   bool contains(address addr) const              { return content_contains(addr); }
   145   bool is_frame_complete_at(address addr) const  { return code_contains(addr) &&
   146                                                           addr >= code_begin() + _frame_complete_offset; }
   148   // CodeCache support: really only used by the nmethods, but in order to get
   149   // asserts and certain bookkeeping to work in the CodeCache they are defined
   150   // virtual here.
   151   virtual bool is_zombie() const                 { return false; }
   152   virtual bool is_locked_by_vm() const           { return false; }
   154   virtual bool is_unloaded() const               { return false; }
   155   virtual bool is_not_entrant() const            { return false; }
   157   // GC support
   158   virtual bool is_alive() const                  = 0;
   160   // OopMap for frame
   161   OopMapSet* oop_maps() const                    { return _oop_maps; }
   162   void set_oop_maps(OopMapSet* p);
   163   OopMap* oop_map_for_return_address(address return_address);
   164   virtual void preserve_callee_argument_oops(frame fr, const RegisterMap* reg_map, OopClosure* f)  { ShouldNotReachHere(); }
   166   // Frame support
   167   int  frame_size() const                        { return _frame_size; }
   168   void set_frame_size(int size)                  { _frame_size = size; }
   170   // Returns true, if the next frame is responsible for GC'ing oops passed as arguments
   171   virtual bool caller_must_gc_arguments(JavaThread* thread) const { return false; }
   173   // Naming
   174   const char* name() const                       { return _name; }
   175   void set_name(const char* name)                { _name = name; }
   177   // Debugging
   178   virtual void verify();
   179   void print() const                             { print_on(tty); }
   180   virtual void print_on(outputStream* st) const;
   181   virtual void print_value_on(outputStream* st) const;
   183   // Deal with Disassembler, VTune, Forte, JvmtiExport, MemoryService.
   184   static void trace_new_stub(CodeBlob* blob, const char* name1, const char* name2 = "");
   186   // Print the comment associated with offset on stream, if there is one
   187   virtual void print_block_comment(outputStream* stream, address block_begin) const {
   188     intptr_t offset = (intptr_t)(block_begin - code_begin());
   189     _strings.print_block_comment(stream, offset);
   190   }
   192   // Transfer ownership of comments to this CodeBlob
   193   void set_strings(CodeStrings& strings) {
   194     _strings.assign(strings);
   195   }
   196 };
   199 //----------------------------------------------------------------------------------------------------
   200 // BufferBlob: used to hold non-relocatable machine code such as the interpreter, stubroutines, etc.
   202 class BufferBlob: public CodeBlob {
   203   friend class VMStructs;
   204   friend class AdapterBlob;
   205   friend class MethodHandlesAdapterBlob;
   207  private:
   208   // Creation support
   209   BufferBlob(const char* name, int size);
   210   BufferBlob(const char* name, int size, CodeBuffer* cb);
   212   void* operator new(size_t s, unsigned size);
   214  public:
   215   // Creation
   216   static BufferBlob* create(const char* name, int buffer_size);
   217   static BufferBlob* create(const char* name, CodeBuffer* cb);
   219   static void free(BufferBlob* buf);
   221   // Typing
   222   virtual bool is_buffer_blob() const            { return true; }
   224   // GC/Verification support
   225   void preserve_callee_argument_oops(frame fr, const RegisterMap* reg_map, OopClosure* f)  { /* nothing to do */ }
   226   bool is_alive() const                          { return true; }
   228   void verify();
   229   void print_on(outputStream* st) const;
   230   void print_value_on(outputStream* st) const;
   231 };
   234 //----------------------------------------------------------------------------------------------------
   235 // AdapterBlob: used to hold C2I/I2C adapters
   237 class AdapterBlob: public BufferBlob {
   238 private:
   239   AdapterBlob(int size, CodeBuffer* cb);
   241 public:
   242   // Creation
   243   static AdapterBlob* create(CodeBuffer* cb);
   245   // Typing
   246   virtual bool is_adapter_blob() const { return true; }
   247 };
   250 //----------------------------------------------------------------------------------------------------
   251 // MethodHandlesAdapterBlob: used to hold MethodHandles adapters
   253 class MethodHandlesAdapterBlob: public BufferBlob {
   254 private:
   255   MethodHandlesAdapterBlob(int size)                 : BufferBlob("MethodHandles adapters", size) {}
   256   MethodHandlesAdapterBlob(int size, CodeBuffer* cb) : BufferBlob("MethodHandles adapters", size, cb) {}
   258 public:
   259   // Creation
   260   static MethodHandlesAdapterBlob* create(int buffer_size);
   262   // Typing
   263   virtual bool is_method_handles_adapter_blob() const { return true; }
   264 };
   267 //----------------------------------------------------------------------------------------------------
   268 // RuntimeStub: describes stubs used by compiled code to call a (static) C++ runtime routine
   270 class RuntimeStub: public CodeBlob {
   271   friend class VMStructs;
   272  private:
   273   bool        _caller_must_gc_arguments;
   275   // Creation support
   276   RuntimeStub(
   277     const char* name,
   278     CodeBuffer* cb,
   279     int         size,
   280     int         frame_complete,
   281     int         frame_size,
   282     OopMapSet*  oop_maps,
   283     bool        caller_must_gc_arguments
   284   );
   286   void* operator new(size_t s, unsigned size);
   288  public:
   289   // Creation
   290   static RuntimeStub* new_runtime_stub(
   291     const char* stub_name,
   292     CodeBuffer* cb,
   293     int         frame_complete,
   294     int         frame_size,
   295     OopMapSet*  oop_maps,
   296     bool        caller_must_gc_arguments
   297   );
   299   // Typing
   300   bool is_runtime_stub() const                   { return true; }
   302   // GC support
   303   bool caller_must_gc_arguments(JavaThread* thread) const { return _caller_must_gc_arguments; }
   305   address entry_point()                          { return code_begin(); }
   307   // GC/Verification support
   308   void preserve_callee_argument_oops(frame fr, const RegisterMap *reg_map, OopClosure* f)  { /* nothing to do */ }
   309   bool is_alive() const                          { return true; }
   311   void verify();
   312   void print_on(outputStream* st) const;
   313   void print_value_on(outputStream* st) const;
   314 };
   317 //----------------------------------------------------------------------------------------------------
   318 // Super-class for all blobs that exist in only one instance. Implements default behaviour.
   320 class SingletonBlob: public CodeBlob {
   321   friend class VMStructs;
   323  protected:
   324   void* operator new(size_t s, unsigned size);
   326  public:
   327    SingletonBlob(
   328      const char* name,
   329      CodeBuffer* cb,
   330      int         header_size,
   331      int         size,
   332      int         frame_size,
   333      OopMapSet*  oop_maps
   334    )
   335    : CodeBlob(name, cb, header_size, size, CodeOffsets::frame_never_safe, frame_size, oop_maps)
   336   {};
   338   address entry_point()                          { return code_begin(); }
   340   bool is_alive() const                          { return true; }
   342   void verify(); // does nothing
   343   void print_on(outputStream* st) const;
   344   void print_value_on(outputStream* st) const;
   345 };
   348 //----------------------------------------------------------------------------------------------------
   349 // DeoptimizationBlob
   351 class DeoptimizationBlob: public SingletonBlob {
   352   friend class VMStructs;
   353  private:
   354   int _unpack_offset;
   355   int _unpack_with_exception;
   356   int _unpack_with_reexecution;
   358   int _unpack_with_exception_in_tls;
   360   // Creation support
   361   DeoptimizationBlob(
   362     CodeBuffer* cb,
   363     int         size,
   364     OopMapSet*  oop_maps,
   365     int         unpack_offset,
   366     int         unpack_with_exception_offset,
   367     int         unpack_with_reexecution_offset,
   368     int         frame_size
   369   );
   371  public:
   372   // Creation
   373   static DeoptimizationBlob* create(
   374     CodeBuffer* cb,
   375     OopMapSet*  oop_maps,
   376     int         unpack_offset,
   377     int         unpack_with_exception_offset,
   378     int         unpack_with_reexecution_offset,
   379     int         frame_size
   380   );
   382   // Typing
   383   bool is_deoptimization_stub() const { return true; }
   384   bool exception_address_is_unpack_entry(address pc) const {
   385     address unpack_pc = unpack();
   386     return (pc == unpack_pc || (pc + frame::pc_return_offset) == unpack_pc);
   387   }
   392   // GC for args
   393   void preserve_callee_argument_oops(frame fr, const RegisterMap *reg_map, OopClosure* f) { /* Nothing to do */ }
   395   // Printing
   396   void print_value_on(outputStream* st) const;
   398   address unpack() const                         { return code_begin() + _unpack_offset;           }
   399   address unpack_with_exception() const          { return code_begin() + _unpack_with_exception;   }
   400   address unpack_with_reexecution() const        { return code_begin() + _unpack_with_reexecution; }
   402   // Alternate entry point for C1 where the exception and issuing pc
   403   // are in JavaThread::_exception_oop and JavaThread::_exception_pc
   404   // instead of being in registers.  This is needed because C1 doesn't
   405   // model exception paths in a way that keeps these registers free so
   406   // there may be live values in those registers during deopt.
   407   void set_unpack_with_exception_in_tls_offset(int offset) {
   408     _unpack_with_exception_in_tls = offset;
   409     assert(code_contains(code_begin() + _unpack_with_exception_in_tls), "must be PC inside codeblob");
   410   }
   411   address unpack_with_exception_in_tls() const   { return code_begin() + _unpack_with_exception_in_tls; }
   412 };
   415 //----------------------------------------------------------------------------------------------------
   416 // UncommonTrapBlob (currently only used by Compiler 2)
   418 #ifdef COMPILER2
   420 class UncommonTrapBlob: public SingletonBlob {
   421   friend class VMStructs;
   422  private:
   423   // Creation support
   424   UncommonTrapBlob(
   425     CodeBuffer* cb,
   426     int         size,
   427     OopMapSet*  oop_maps,
   428     int         frame_size
   429   );
   431  public:
   432   // Creation
   433   static UncommonTrapBlob* create(
   434     CodeBuffer* cb,
   435     OopMapSet*  oop_maps,
   436     int         frame_size
   437   );
   439   // GC for args
   440   void preserve_callee_argument_oops(frame fr, const RegisterMap *reg_map, OopClosure* f)  { /* nothing to do */ }
   442   // Typing
   443   bool is_uncommon_trap_stub() const             { return true; }
   444 };
   447 //----------------------------------------------------------------------------------------------------
   448 // ExceptionBlob: used for exception unwinding in compiled code (currently only used by Compiler 2)
   450 class ExceptionBlob: public SingletonBlob {
   451   friend class VMStructs;
   452  private:
   453   // Creation support
   454   ExceptionBlob(
   455     CodeBuffer* cb,
   456     int         size,
   457     OopMapSet*  oop_maps,
   458     int         frame_size
   459   );
   461  public:
   462   // Creation
   463   static ExceptionBlob* create(
   464     CodeBuffer* cb,
   465     OopMapSet*  oop_maps,
   466     int         frame_size
   467   );
   469   // GC for args
   470   void preserve_callee_argument_oops(frame fr, const RegisterMap* reg_map, OopClosure* f)  { /* nothing to do */ }
   472   // Typing
   473   bool is_exception_stub() const                 { return true; }
   474 };
   475 #endif // COMPILER2
   478 //----------------------------------------------------------------------------------------------------
   479 // SafepointBlob: handles illegal_instruction exceptions during a safepoint
   481 class SafepointBlob: public SingletonBlob {
   482   friend class VMStructs;
   483  private:
   484   // Creation support
   485   SafepointBlob(
   486     CodeBuffer* cb,
   487     int         size,
   488     OopMapSet*  oop_maps,
   489     int         frame_size
   490   );
   492  public:
   493   // Creation
   494   static SafepointBlob* create(
   495     CodeBuffer* cb,
   496     OopMapSet*  oop_maps,
   497     int         frame_size
   498   );
   500   // GC for args
   501   void preserve_callee_argument_oops(frame fr, const RegisterMap* reg_map, OopClosure* f)  { /* nothing to do */ }
   503   // Typing
   504   bool is_safepoint_stub() const                 { return true; }
   505 };
   507 #endif // SHARE_VM_CODE_CODEBLOB_HPP

mercurial