1 /*
   2  * Copyright (c) 1998, 2010, 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  */
  24 
  25 #ifndef SHARE_VM_CODE_CODEBLOB_HPP
  26 #define SHARE_VM_CODE_CODEBLOB_HPP
  27 
  28 #include "asm/codeBuffer.hpp"
  29 #include "compiler/oopMap.hpp"
  30 #include "runtime/frame.hpp"
  31 #include "runtime/handles.hpp"
  32 
  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;
  50 
  51 class CodeBlob VALUE_OBJ_CLASS_SPEC {
  52 
  53   friend class VMStructs;
  54 
  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   CodeComments _comments;
  70 
  71   friend class OopRecorder;
  72 
  73  public:
  74   // Returns the space needed for CodeBlob
  75   static unsigned int allocation_size(CodeBuffer* cb, int header_size);
  76 
  77   // Creation
  78   // a) simple CodeBlob
  79   // frame_complete is the offset from the beginning of the instructions
  80   // to where the frame setup (from stackwalk viewpoint) is complete.
  81   CodeBlob(const char* name, int header_size, int size, int frame_complete, int locs_size);
  82 
  83   // b) full CodeBlob
  84   CodeBlob(
  85     const char* name,
  86     CodeBuffer* cb,
  87     int         header_size,
  88     int         size,
  89     int         frame_complete,
  90     int         frame_size,
  91     OopMapSet*  oop_maps
  92   );
  93 
  94   // Deletion
  95   void flush();
  96 
  97   // Typing
  98   virtual bool is_buffer_blob() const                 { return false; }
  99   virtual bool is_nmethod() const                     { return false; }
 100   virtual bool is_runtime_stub() const                { return false; }
 101   virtual bool is_deoptimization_stub() const         { return false; }
 102   virtual bool is_uncommon_trap_stub() const          { return false; }
 103   virtual bool is_exception_stub() const              { return false; }
 104   virtual bool is_safepoint_stub() const              { return false; }
 105   virtual bool is_adapter_blob() const                { return false; }
 106   virtual bool is_method_handles_adapter_blob() const { return false; }
 107 
 108   virtual bool is_compiled_by_c2() const         { return false; }
 109   virtual bool is_compiled_by_c1() const         { return false; }
 110 
 111   // Casting
 112   nmethod* as_nmethod_or_null()                  { return is_nmethod() ? (nmethod*) this : NULL; }
 113 
 114   // Boundaries
 115   address    header_begin() const                { return (address)    this; }
 116   address    header_end() const                  { return ((address)   this) + _header_size; };
 117   relocInfo* relocation_begin() const            { return (relocInfo*) header_end(); };
 118   relocInfo* relocation_end() const              { return (relocInfo*)(header_end()   + _relocation_size); }
 119   address    content_begin() const               { return (address)    header_begin() + _content_offset; }
 120   address    content_end() const                 { return (address)    header_begin() + _data_offset; }
 121   address    code_begin() const                  { return (address)    header_begin() + _code_offset; }
 122   address    code_end() const                    { return (address)    header_begin() + _data_offset; }
 123   address    data_begin() const                  { return (address)    header_begin() + _data_offset; }
 124   address    data_end() const                    { return (address)    header_begin() + _size; }
 125 
 126   // Offsets
 127   int relocation_offset() const                  { return _header_size; }
 128   int content_offset() const                     { return _content_offset; }
 129   int code_offset() const                        { return _code_offset; }
 130   int data_offset() const                        { return _data_offset; }
 131 
 132   // Sizes
 133   int size() const                               { return _size; }
 134   int header_size() const                        { return _header_size; }
 135   int relocation_size() const                    { return (address) relocation_end() - (address) relocation_begin(); }
 136   int content_size() const                       { return           content_end()    -           content_begin();    }
 137   int code_size() const                          { return           code_end()       -           code_begin();       }
 138   int data_size() const                          { return           data_end()       -           data_begin();       }
 139 
 140   // Containment
 141   bool blob_contains(address addr) const         { return header_begin()       <= addr && addr < data_end();       }
 142   bool relocation_contains(relocInfo* addr) const{ return relocation_begin()   <= addr && addr < relocation_end(); }
 143   bool content_contains(address addr) const      { return content_begin()      <= addr && addr < content_end();    }
 144   bool code_contains(address addr) const         { return code_begin()         <= addr && addr < code_end();       }
 145   bool data_contains(address addr) const         { return data_begin()         <= addr && addr < data_end();       }
 146   bool contains(address addr) const              { return content_contains(addr); }
 147   bool is_frame_complete_at(address addr) const  { return code_contains(addr) &&
 148                                                           addr >= code_begin() + _frame_complete_offset; }
 149 
 150   // CodeCache support: really only used by the nmethods, but in order to get
 151   // asserts and certain bookkeeping to work in the CodeCache they are defined
 152   // virtual here.
 153   virtual bool is_zombie() const                 { return false; }
 154   virtual bool is_locked_by_vm() const           { return false; }
 155 
 156   virtual bool is_unloaded() const               { return false; }
 157   virtual bool is_not_entrant() const            { return false; }
 158 
 159   // GC support
 160   virtual bool is_alive() const                  = 0;
 161 
 162   // OopMap for frame
 163   OopMapSet* oop_maps() const                    { return _oop_maps; }
 164   void set_oop_maps(OopMapSet* p);
 165   OopMap* oop_map_for_return_address(address return_address);
 166   virtual void preserve_callee_argument_oops(frame fr, const RegisterMap* reg_map, OopClosure* f)  { ShouldNotReachHere(); }
 167 
 168   // Frame support
 169   int  frame_size() const                        { return _frame_size; }
 170   void set_frame_size(int size)                  { _frame_size = size; }
 171 
 172   // Returns true, if the next frame is responsible for GC'ing oops passed as arguments
 173   virtual bool caller_must_gc_arguments(JavaThread* thread) const { return false; }
 174 
 175   // Naming
 176   const char* name() const                       { return _name; }
 177   void set_name(const char* name)                { _name = name; }
 178 
 179   // Debugging
 180   virtual void verify();
 181   void print() const                             { print_on(tty); }
 182   virtual void print_on(outputStream* st) const;
 183   virtual void print_value_on(outputStream* st) const;
 184 
 185   // Print the comment associated with offset on stream, if there is one
 186   virtual void print_block_comment(outputStream* stream, address block_begin) {
 187     intptr_t offset = (intptr_t)(block_begin - code_begin());
 188     _comments.print_block_comment(stream, offset);
 189   }
 190 
 191   // Transfer ownership of comments to this CodeBlob
 192   void set_comments(CodeComments& comments) {
 193     _comments.assign(comments);
 194   }
 195 };
 196 
 197 
 198 //----------------------------------------------------------------------------------------------------
 199 // BufferBlob: used to hold non-relocatable machine code such as the interpreter, stubroutines, etc.
 200 
 201 class BufferBlob: public CodeBlob {
 202   friend class VMStructs;
 203   friend class AdapterBlob;
 204   friend class MethodHandlesAdapterBlob;
 205 
 206  private:
 207   // Creation support
 208   BufferBlob(const char* name, int size);
 209   BufferBlob(const char* name, int size, CodeBuffer* cb);
 210 
 211   void* operator new(size_t s, unsigned size);
 212 
 213  public:
 214   // Creation
 215   static BufferBlob* create(const char* name, int buffer_size);
 216   static BufferBlob* create(const char* name, CodeBuffer* cb);
 217 
 218   static void free(BufferBlob* buf);
 219 
 220   // Typing
 221   virtual bool is_buffer_blob() const            { return true; }
 222 
 223   // GC/Verification support
 224   void preserve_callee_argument_oops(frame fr, const RegisterMap* reg_map, OopClosure* f)  { /* nothing to do */ }
 225   bool is_alive() const                          { return true; }
 226 
 227   void verify();
 228   void print_on(outputStream* st) const;
 229   void print_value_on(outputStream* st) const;
 230 };
 231 
 232 
 233 //----------------------------------------------------------------------------------------------------
 234 // AdapterBlob: used to hold C2I/I2C adapters
 235 
 236 class AdapterBlob: public BufferBlob {
 237 private:
 238   AdapterBlob(int size, CodeBuffer* cb);
 239 
 240 public:
 241   // Creation
 242   static AdapterBlob* create(CodeBuffer* cb);
 243 
 244   // Typing
 245   virtual bool is_adapter_blob() const { return true; }
 246 };
 247 
 248 
 249 //----------------------------------------------------------------------------------------------------
 250 // MethodHandlesAdapterBlob: used to hold MethodHandles adapters
 251 
 252 class MethodHandlesAdapterBlob: public BufferBlob {
 253 private:
 254   MethodHandlesAdapterBlob(int size)                 : BufferBlob("MethodHandles adapters", size) {}
 255   MethodHandlesAdapterBlob(int size, CodeBuffer* cb) : BufferBlob("MethodHandles adapters", size, cb) {}
 256 
 257 public:
 258   // Creation
 259   static MethodHandlesAdapterBlob* create(int buffer_size);
 260 
 261   // Typing
 262   virtual bool is_method_handles_adapter_blob() const { return true; }
 263 };
 264 
 265 
 266 //----------------------------------------------------------------------------------------------------
 267 // RuntimeStub: describes stubs used by compiled code to call a (static) C++ runtime routine
 268 
 269 class RuntimeStub: public CodeBlob {
 270   friend class VMStructs;
 271  private:
 272   bool        _caller_must_gc_arguments;
 273 
 274   // Creation support
 275   RuntimeStub(
 276     const char* name,
 277     CodeBuffer* cb,
 278     int         size,
 279     int         frame_complete,
 280     int         frame_size,
 281     OopMapSet*  oop_maps,
 282     bool        caller_must_gc_arguments
 283   );
 284 
 285   void* operator new(size_t s, unsigned size);
 286 
 287  public:
 288   // Creation
 289   static RuntimeStub* new_runtime_stub(
 290     const char* stub_name,
 291     CodeBuffer* cb,
 292     int         frame_complete,
 293     int         frame_size,
 294     OopMapSet*  oop_maps,
 295     bool        caller_must_gc_arguments
 296   );
 297 
 298   // Typing
 299   bool is_runtime_stub() const                   { return true; }
 300 
 301   // GC support
 302   bool caller_must_gc_arguments(JavaThread* thread) const { return _caller_must_gc_arguments; }
 303 
 304   address entry_point()                          { return code_begin(); }
 305 
 306   // GC/Verification support
 307   void preserve_callee_argument_oops(frame fr, const RegisterMap *reg_map, OopClosure* f)  { /* nothing to do */ }
 308   bool is_alive() const                          { return true; }
 309 
 310   void verify();
 311   void print_on(outputStream* st) const;
 312   void print_value_on(outputStream* st) const;
 313 };
 314 
 315 
 316 //----------------------------------------------------------------------------------------------------
 317 // Super-class for all blobs that exist in only one instance. Implements default behaviour.
 318 
 319 class SingletonBlob: public CodeBlob {
 320   friend class VMStructs;
 321   public:
 322    SingletonBlob(
 323      const char* name,
 324      CodeBuffer* cb,
 325      int         header_size,
 326      int         size,
 327      int         frame_size,
 328      OopMapSet*  oop_maps
 329    )
 330    : CodeBlob(name, cb, header_size, size, CodeOffsets::frame_never_safe, frame_size, oop_maps)
 331   {};
 332 
 333   address entry_point()                          { return code_begin(); }
 334 
 335   bool is_alive() const                          { return true; }
 336 
 337   void verify(); // does nothing
 338   void print_on(outputStream* st) const;
 339   void print_value_on(outputStream* st) const;
 340 };
 341 
 342 
 343 //----------------------------------------------------------------------------------------------------
 344 // DeoptimizationBlob
 345 
 346 class DeoptimizationBlob: public SingletonBlob {
 347   friend class VMStructs;
 348  private:
 349   int _unpack_offset;
 350   int _unpack_with_exception;
 351   int _unpack_with_reexecution;
 352 
 353   int _unpack_with_exception_in_tls;
 354 
 355   // Creation support
 356   DeoptimizationBlob(
 357     CodeBuffer* cb,
 358     int         size,
 359     OopMapSet*  oop_maps,
 360     int         unpack_offset,
 361     int         unpack_with_exception_offset,
 362     int         unpack_with_reexecution_offset,
 363     int         frame_size
 364   );
 365 
 366   void* operator new(size_t s, unsigned size);
 367 
 368  public:
 369   // Creation
 370   static DeoptimizationBlob* create(
 371     CodeBuffer* cb,
 372     OopMapSet*  oop_maps,
 373     int         unpack_offset,
 374     int         unpack_with_exception_offset,
 375     int         unpack_with_reexecution_offset,
 376     int         frame_size
 377   );
 378 
 379   // Typing
 380   bool is_deoptimization_stub() const { return true; }
 381   const DeoptimizationBlob *as_deoptimization_stub() const { return this; }
 382   bool exception_address_is_unpack_entry(address pc) const {
 383     address unpack_pc = unpack();
 384     return (pc == unpack_pc || (pc + frame::pc_return_offset) == unpack_pc);
 385   }
 386 
 387 
 388 
 389 
 390   // GC for args
 391   void preserve_callee_argument_oops(frame fr, const RegisterMap *reg_map, OopClosure* f) { /* Nothing to do */ }
 392 
 393   // Printing
 394   void print_value_on(outputStream* st) const;
 395 
 396   address unpack() const                         { return code_begin() + _unpack_offset;           }
 397   address unpack_with_exception() const          { return code_begin() + _unpack_with_exception;   }
 398   address unpack_with_reexecution() const        { return code_begin() + _unpack_with_reexecution; }
 399 
 400   // Alternate entry point for C1 where the exception and issuing pc
 401   // are in JavaThread::_exception_oop and JavaThread::_exception_pc
 402   // instead of being in registers.  This is needed because C1 doesn't
 403   // model exception paths in a way that keeps these registers free so
 404   // there may be live values in those registers during deopt.
 405   void set_unpack_with_exception_in_tls_offset(int offset) {
 406     _unpack_with_exception_in_tls = offset;
 407     assert(code_contains(code_begin() + _unpack_with_exception_in_tls), "must be PC inside codeblob");
 408   }
 409   address unpack_with_exception_in_tls() const   { return code_begin() + _unpack_with_exception_in_tls; }
 410 };
 411 
 412 
 413 //----------------------------------------------------------------------------------------------------
 414 // UncommonTrapBlob (currently only used by Compiler 2)
 415 
 416 #ifdef COMPILER2
 417 
 418 class UncommonTrapBlob: public SingletonBlob {
 419   friend class VMStructs;
 420  private:
 421   // Creation support
 422   UncommonTrapBlob(
 423     CodeBuffer* cb,
 424     int         size,
 425     OopMapSet*  oop_maps,
 426     int         frame_size
 427   );
 428 
 429   void* operator new(size_t s, unsigned size);
 430 
 431  public:
 432   // Creation
 433   static UncommonTrapBlob* create(
 434     CodeBuffer* cb,
 435     OopMapSet*  oop_maps,
 436     int         frame_size
 437   );
 438 
 439   // GC for args
 440   void preserve_callee_argument_oops(frame fr, const RegisterMap *reg_map, OopClosure* f)  { /* nothing to do */ }
 441 
 442   // Typing
 443   bool is_uncommon_trap_stub() const             { return true; }
 444 };
 445 
 446 
 447 //----------------------------------------------------------------------------------------------------
 448 // ExceptionBlob: used for exception unwinding in compiled code (currently only used by Compiler 2)
 449 
 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   );
 460 
 461   void* operator new(size_t s, unsigned size);
 462 
 463  public:
 464   // Creation
 465   static ExceptionBlob* create(
 466     CodeBuffer* cb,
 467     OopMapSet*  oop_maps,
 468     int         frame_size
 469   );
 470 
 471   // GC for args
 472   void preserve_callee_argument_oops(frame fr, const RegisterMap* reg_map, OopClosure* f)  { /* nothing to do */ }
 473 
 474   // Typing
 475   bool is_exception_stub() const                 { return true; }
 476 };
 477 #endif // COMPILER2
 478 
 479 
 480 //----------------------------------------------------------------------------------------------------
 481 // SafepointBlob: handles illegal_instruction exceptions during a safepoint
 482 
 483 class SafepointBlob: public SingletonBlob {
 484   friend class VMStructs;
 485  private:
 486   // Creation support
 487   SafepointBlob(
 488     CodeBuffer* cb,
 489     int         size,
 490     OopMapSet*  oop_maps,
 491     int         frame_size
 492   );
 493 
 494   void* operator new(size_t s, unsigned size);
 495 
 496  public:
 497   // Creation
 498   static SafepointBlob* create(
 499     CodeBuffer* cb,
 500     OopMapSet*  oop_maps,
 501     int         frame_size
 502   );
 503 
 504   // GC for args
 505   void preserve_callee_argument_oops(frame fr, const RegisterMap* reg_map, OopClosure* f)  { /* nothing to do */ }
 506 
 507   // Typing
 508   bool is_safepoint_stub() const                 { return true; }
 509 };
 510 
 511 #endif // SHARE_VM_CODE_CODEBLOB_HPP