1 /*
   2  * Copyright (c) 1998, 2015, 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 Types
  34 // Used in the CodeCache to assign CodeBlobs to different CodeHeaps
  35 struct CodeBlobType {
  36   enum {
  37     MethodNonProfiled   = 0,    // Execution level 1 and 4 (non-profiled) nmethods (including native nmethods)
  38     MethodProfiled      = 1,    // Execution level 2 and 3 (profiled) nmethods
  39     NonNMethod          = 2,    // Non-nmethods like Buffers, Adapters and Runtime Stubs
  40     All                 = 3,    // All types (No code cache segmentation)
  41     Pregenerated        = 4,    // Special blobs, managed by CodeCacheExtensions
  42     NumTypes            = 5     // Number of CodeBlobTypes
  43   };
  44 };
  45 
  46 // CodeBlob - superclass for all entries in the CodeCache.
  47 //
  48 // Suptypes are:
  49 //   nmethod            : Compiled Java methods (include method that calls to native code)
  50 //   RuntimeStub        : Call to VM runtime methods
  51 //   DeoptimizationBlob : Used for deoptimizatation
  52 //   ExceptionBlob      : Used for stack unrolling
  53 //   SafepointBlob      : Used to handle illegal instruction exceptions
  54 //
  55 //
  56 // Layout:
  57 //   - header
  58 //   - relocation
  59 //   - content space
  60 //     - instruction space
  61 //   - data space
  62 class DeoptimizationBlob;
  63 
  64 class CodeBlob VALUE_OBJ_CLASS_SPEC {
  65 
  66   friend class VMStructs;
  67   friend class CodeCacheDumper;
  68 
  69  private:
  70   const char* _name;
  71   int        _size;                              // total size of CodeBlob in bytes
  72   int        _header_size;                       // size of header (depends on subclass)
  73   int        _relocation_size;                   // size of relocation
  74   int        _content_offset;                    // offset to where content region begins (this includes consts, insts, stubs)
  75   int        _code_offset;                       // offset to where instructions region begins (this includes insts, stubs)
  76   int        _frame_complete_offset;             // instruction offsets in [0.._frame_complete_offset) have
  77                                                  // not finished setting up their frame. Beware of pc's in
  78                                                  // that range. There is a similar range(s) on returns
  79                                                  // which we don't detect.
  80   int        _data_offset;                       // offset to where data region begins
  81   int        _frame_size;                        // size of stack frame
  82   ImmutableOopMapSet* _oop_maps;                 // OopMap for this CodeBlob
  83   CodeStrings _strings;
  84 
  85  public:
  86   // Returns the space needed for CodeBlob
  87   static unsigned int allocation_size(CodeBuffer* cb, int header_size);
  88   static unsigned int align_code_offset(int offset);
  89 
  90   // Creation
  91   // a) simple CodeBlob
  92   // frame_complete is the offset from the beginning of the instructions
  93   // to where the frame setup (from stackwalk viewpoint) is complete.
  94   CodeBlob(const char* name, int header_size, int size, int frame_complete, int locs_size);
  95 
  96   // b) full CodeBlob
  97   CodeBlob(
  98     const char* name,
  99     CodeBuffer* cb,
 100     int         header_size,
 101     int         size,
 102     int         frame_complete,
 103     int         frame_size,
 104     OopMapSet*  oop_maps
 105   );
 106 
 107   // Deletion
 108   void flush();
 109 
 110   // Typing
 111   virtual bool is_buffer_blob() const            { return false; }
 112   virtual bool is_nmethod() const                { return false; }
 113   virtual bool is_runtime_stub() const           { return false; }
 114   virtual bool is_deoptimization_stub() const    { return false; }
 115   virtual bool is_uncommon_trap_stub() const     { return false; }
 116   virtual bool is_exception_stub() const         { return false; }
 117   virtual bool is_safepoint_stub() const              { return false; }
 118   virtual bool is_adapter_blob() const                { return false; }
 119   virtual bool is_method_handles_adapter_blob() const { return false; }
 120 
 121   virtual bool is_compiled_by_c2() const         { return false; }
 122   virtual bool is_compiled_by_c1() const         { return false; }

 123 
 124   // Casting
 125   nmethod* as_nmethod_or_null()                  { return is_nmethod() ? (nmethod*) this : NULL; }
 126 
 127   // Boundaries
 128   address    header_begin() const                { return (address)    this; }
 129   address    header_end() const                  { return ((address)   this) + _header_size; };
 130   relocInfo* relocation_begin() const            { return (relocInfo*) header_end(); };
 131   relocInfo* relocation_end() const              { return (relocInfo*)(header_end()   + _relocation_size); }
 132   address    content_begin() const               { return (address)    header_begin() + _content_offset; }
 133   address    content_end() const                 { return (address)    header_begin() + _data_offset; }
 134   address    code_begin() const                  { return (address)    header_begin() + _code_offset; }
 135   address    code_end() const                    { return (address)    header_begin() + _data_offset; }
 136   address    data_begin() const                  { return (address)    header_begin() + _data_offset; }
 137   address    data_end() const                    { return (address)    header_begin() + _size; }
 138 
 139   // Offsets
 140   int relocation_offset() const                  { return _header_size; }
 141   int content_offset() const                     { return _content_offset; }
 142   int code_offset() const                        { return _code_offset; }
 143   int data_offset() const                        { return _data_offset; }
 144 
 145   // Sizes
 146   int size() const                               { return _size; }
 147   int header_size() const                        { return _header_size; }
 148   int relocation_size() const                    { return (address) relocation_end() - (address) relocation_begin(); }
 149   int content_size() const                       { return           content_end()    -           content_begin();    }
 150   int code_size() const                          { return           code_end()       -           code_begin();       }
 151   int data_size() const                          { return           data_end()       -           data_begin();       }
 152 
 153   // Containment
 154   bool blob_contains(address addr) const         { return header_begin()       <= addr && addr < data_end();       }
 155   bool relocation_contains(relocInfo* addr) const{ return relocation_begin()   <= addr && addr < relocation_end(); }
 156   bool content_contains(address addr) const      { return content_begin()      <= addr && addr < content_end();    }
 157   bool code_contains(address addr) const         { return code_begin()         <= addr && addr < code_end();       }
 158   bool data_contains(address addr) const         { return data_begin()         <= addr && addr < data_end();       }
 159   bool contains(address addr) const              { return content_contains(addr); }
 160   bool is_frame_complete_at(address addr) const  { return code_contains(addr) &&
 161                                                           addr >= code_begin() + _frame_complete_offset; }
 162 
 163   // CodeCache support: really only used by the nmethods, but in order to get
 164   // asserts and certain bookkeeping to work in the CodeCache they are defined
 165   // virtual here.
 166   virtual bool is_zombie() const                 { return false; }
 167   virtual bool is_locked_by_vm() const           { return false; }
 168 
 169   virtual bool is_unloaded() const               { return false; }
 170   virtual bool is_not_entrant() const            { return false; }
 171 
 172   // GC support
 173   virtual bool is_alive() const                  = 0;
 174 
 175   // OopMap for frame
 176   ImmutableOopMapSet* oop_maps() const           { return _oop_maps; }
 177   void set_oop_maps(OopMapSet* p);
 178   const ImmutableOopMap* oop_map_for_return_address(address return_address);
 179   virtual void preserve_callee_argument_oops(frame fr, const RegisterMap* reg_map, OopClosure* f)  { ShouldNotReachHere(); }
 180 
 181   // Frame support
 182   int  frame_size() const                        { return _frame_size; }
 183   void set_frame_size(int size)                  { _frame_size = size; }
 184 
 185   // Returns true, if the next frame is responsible for GC'ing oops passed as arguments
 186   virtual bool caller_must_gc_arguments(JavaThread* thread) const { return false; }
 187 
 188   // Naming
 189   const char* name() const                       { return _name; }
 190   void set_name(const char* name)                { _name = name; }
 191 
 192   // Debugging
 193   virtual void verify();
 194   void print() const                             { print_on(tty); }
 195   virtual void print_on(outputStream* st) const;
 196   virtual void print_value_on(outputStream* st) const;
 197 
 198   // Deal with Disassembler, VTune, Forte, JvmtiExport, MemoryService.
 199   static void trace_new_stub(CodeBlob* blob, const char* name1, const char* name2 = "");
 200 
 201   // Print the comment associated with offset on stream, if there is one
 202   virtual void print_block_comment(outputStream* stream, address block_begin) const {
 203     intptr_t offset = (intptr_t)(block_begin - code_begin());
 204     _strings.print_block_comment(stream, offset);
 205   }
 206 
 207   // Transfer ownership of comments to this CodeBlob
 208   void set_strings(CodeStrings& strings) {
 209     _strings.assign(strings);
 210   }
 211 
 212   static ByteSize name_field_offset() {
 213     return byte_offset_of(CodeBlob, _name);
 214   }
 215 
 216   static ByteSize oop_maps_field_offset() {
 217     return byte_offset_of(CodeBlob, _oop_maps);
 218   }
 219 };
 220 
 221 class WhiteBox;
 222 //----------------------------------------------------------------------------------------------------
 223 // BufferBlob: used to hold non-relocatable machine code such as the interpreter, stubroutines, etc.
 224 
 225 class BufferBlob: public CodeBlob {
 226   friend class VMStructs;
 227   friend class AdapterBlob;
 228   friend class MethodHandlesAdapterBlob;
 229   friend class WhiteBox;
 230 
 231  private:
 232   // Creation support
 233   BufferBlob(const char* name, int size);
 234   BufferBlob(const char* name, int size, CodeBuffer* cb);
 235 
 236   void* operator new(size_t s, unsigned size) throw();
 237 
 238  public:
 239   // Creation
 240   static BufferBlob* create(const char* name, int buffer_size);
 241   static BufferBlob* create(const char* name, CodeBuffer* cb);
 242 
 243   static void free(BufferBlob* buf);
 244 
 245   // Typing
 246   virtual bool is_buffer_blob() const            { return true; }
 247 
 248   // GC/Verification support
 249   void preserve_callee_argument_oops(frame fr, const RegisterMap* reg_map, OopClosure* f)  { /* nothing to do */ }
 250   bool is_alive() const                          { return true; }
 251 
 252   void verify();
 253   void print_on(outputStream* st) const;
 254   void print_value_on(outputStream* st) const;
 255 };
 256 
 257 
 258 //----------------------------------------------------------------------------------------------------
 259 // AdapterBlob: used to hold C2I/I2C adapters
 260 
 261 class AdapterBlob: public BufferBlob {
 262 private:
 263   AdapterBlob(int size, CodeBuffer* cb);
 264 
 265 public:
 266   // Creation
 267   static AdapterBlob* create(CodeBuffer* cb);
 268 
 269   // Typing
 270   virtual bool is_adapter_blob() const { return true; }
 271 };
 272 
 273 
 274 //----------------------------------------------------------------------------------------------------
 275 // MethodHandlesAdapterBlob: used to hold MethodHandles adapters
 276 
 277 class MethodHandlesAdapterBlob: public BufferBlob {
 278 private:
 279   MethodHandlesAdapterBlob(int size)                 : BufferBlob("MethodHandles adapters", size) {}
 280 
 281 public:
 282   // Creation
 283   static MethodHandlesAdapterBlob* create(int buffer_size);
 284 
 285   // Typing
 286   virtual bool is_method_handles_adapter_blob() const { return true; }
 287 };
 288 
 289 
 290 //----------------------------------------------------------------------------------------------------
 291 // RuntimeStub: describes stubs used by compiled code to call a (static) C++ runtime routine
 292 
 293 class RuntimeStub: public CodeBlob {
 294   friend class VMStructs;
 295  private:
 296   bool        _caller_must_gc_arguments;
 297 
 298   // Creation support
 299   RuntimeStub(
 300     const char* name,
 301     CodeBuffer* cb,
 302     int         size,
 303     int         frame_complete,
 304     int         frame_size,
 305     OopMapSet*  oop_maps,
 306     bool        caller_must_gc_arguments
 307   );
 308 
 309   void* operator new(size_t s, unsigned size) throw();
 310 
 311  public:
 312   // Creation
 313   static RuntimeStub* new_runtime_stub(
 314     const char* stub_name,
 315     CodeBuffer* cb,
 316     int         frame_complete,
 317     int         frame_size,
 318     OopMapSet*  oop_maps,
 319     bool        caller_must_gc_arguments
 320   );
 321 
 322   // Typing
 323   bool is_runtime_stub() const                   { return true; }
 324 
 325   // GC support
 326   bool caller_must_gc_arguments(JavaThread* thread) const { return _caller_must_gc_arguments; }
 327 
 328   address entry_point()                          { return code_begin(); }
 329 
 330   // GC/Verification support
 331   void preserve_callee_argument_oops(frame fr, const RegisterMap *reg_map, OopClosure* f)  { /* nothing to do */ }
 332   bool is_alive() const                          { return true; }
 333 
 334   void verify();
 335   void print_on(outputStream* st) const;
 336   void print_value_on(outputStream* st) const;
 337 };
 338 
 339 
 340 //----------------------------------------------------------------------------------------------------
 341 // Super-class for all blobs that exist in only one instance. Implements default behaviour.
 342 
 343 class SingletonBlob: public CodeBlob {
 344   friend class VMStructs;
 345 
 346  protected:
 347   void* operator new(size_t s, unsigned size) throw();
 348 
 349  public:
 350    SingletonBlob(
 351      const char* name,
 352      CodeBuffer* cb,
 353      int         header_size,
 354      int         size,
 355      int         frame_size,
 356      OopMapSet*  oop_maps
 357    )
 358    : CodeBlob(name, cb, header_size, size, CodeOffsets::frame_never_safe, frame_size, oop_maps)
 359   {};
 360 
 361   address entry_point()                          { return code_begin(); }
 362 
 363   bool is_alive() const                          { return true; }
 364 
 365   void verify(); // does nothing
 366   void print_on(outputStream* st) const;
 367   void print_value_on(outputStream* st) const;
 368 };
 369 
 370 
 371 //----------------------------------------------------------------------------------------------------
 372 // DeoptimizationBlob
 373 
 374 class DeoptimizationBlob: public SingletonBlob {
 375   friend class VMStructs;
 376  private:
 377   int _unpack_offset;
 378   int _unpack_with_exception;
 379   int _unpack_with_reexecution;
 380 
 381   int _unpack_with_exception_in_tls;
 382 






 383   // Creation support
 384   DeoptimizationBlob(
 385     CodeBuffer* cb,
 386     int         size,
 387     OopMapSet*  oop_maps,
 388     int         unpack_offset,
 389     int         unpack_with_exception_offset,
 390     int         unpack_with_reexecution_offset,
 391     int         frame_size
 392   );
 393 
 394  public:
 395   // Creation
 396   static DeoptimizationBlob* create(
 397     CodeBuffer* cb,
 398     OopMapSet*  oop_maps,
 399     int         unpack_offset,
 400     int         unpack_with_exception_offset,
 401     int         unpack_with_reexecution_offset,
 402     int         frame_size
 403   );
 404 
 405   // Typing
 406   bool is_deoptimization_stub() const { return true; }
 407   bool exception_address_is_unpack_entry(address pc) const {
 408     address unpack_pc = unpack();
 409     return (pc == unpack_pc || (pc + frame::pc_return_offset) == unpack_pc);
 410   }
 411 
 412   // GC for args
 413   void preserve_callee_argument_oops(frame fr, const RegisterMap *reg_map, OopClosure* f) { /* Nothing to do */ }
 414 
 415   // Printing
 416   void print_value_on(outputStream* st) const;
 417 
 418   address unpack() const                         { return code_begin() + _unpack_offset;           }
 419   address unpack_with_exception() const          { return code_begin() + _unpack_with_exception;   }
 420   address unpack_with_reexecution() const        { return code_begin() + _unpack_with_reexecution; }
 421 
 422   // Alternate entry point for C1 where the exception and issuing pc
 423   // are in JavaThread::_exception_oop and JavaThread::_exception_pc
 424   // instead of being in registers.  This is needed because C1 doesn't
 425   // model exception paths in a way that keeps these registers free so
 426   // there may be live values in those registers during deopt.
 427   void set_unpack_with_exception_in_tls_offset(int offset) {
 428     _unpack_with_exception_in_tls = offset;
 429     assert(code_contains(code_begin() + _unpack_with_exception_in_tls), "must be PC inside codeblob");
 430   }
 431   address unpack_with_exception_in_tls() const   { return code_begin() + _unpack_with_exception_in_tls; }















 432 };
 433 
 434 
 435 //----------------------------------------------------------------------------------------------------
 436 // UncommonTrapBlob (currently only used by Compiler 2)
 437 
 438 #ifdef COMPILER2
 439 
 440 class UncommonTrapBlob: public SingletonBlob {
 441   friend class VMStructs;
 442  private:
 443   // Creation support
 444   UncommonTrapBlob(
 445     CodeBuffer* cb,
 446     int         size,
 447     OopMapSet*  oop_maps,
 448     int         frame_size
 449   );
 450 
 451  public:
 452   // Creation
 453   static UncommonTrapBlob* create(
 454     CodeBuffer* cb,
 455     OopMapSet*  oop_maps,
 456     int         frame_size
 457   );
 458 
 459   // GC for args
 460   void preserve_callee_argument_oops(frame fr, const RegisterMap *reg_map, OopClosure* f)  { /* nothing to do */ }
 461 
 462   // Typing
 463   bool is_uncommon_trap_stub() const             { return true; }
 464 };
 465 
 466 
 467 //----------------------------------------------------------------------------------------------------
 468 // ExceptionBlob: used for exception unwinding in compiled code (currently only used by Compiler 2)
 469 
 470 class ExceptionBlob: public SingletonBlob {
 471   friend class VMStructs;
 472  private:
 473   // Creation support
 474   ExceptionBlob(
 475     CodeBuffer* cb,
 476     int         size,
 477     OopMapSet*  oop_maps,
 478     int         frame_size
 479   );
 480 
 481  public:
 482   // Creation
 483   static ExceptionBlob* create(
 484     CodeBuffer* cb,
 485     OopMapSet*  oop_maps,
 486     int         frame_size
 487   );
 488 
 489   // GC for args
 490   void preserve_callee_argument_oops(frame fr, const RegisterMap* reg_map, OopClosure* f)  { /* nothing to do */ }
 491 
 492   // Typing
 493   bool is_exception_stub() const                 { return true; }
 494 };
 495 #endif // COMPILER2
 496 
 497 
 498 //----------------------------------------------------------------------------------------------------
 499 // SafepointBlob: handles illegal_instruction exceptions during a safepoint
 500 
 501 class SafepointBlob: public SingletonBlob {
 502   friend class VMStructs;
 503  private:
 504   // Creation support
 505   SafepointBlob(
 506     CodeBuffer* cb,
 507     int         size,
 508     OopMapSet*  oop_maps,
 509     int         frame_size
 510   );
 511 
 512  public:
 513   // Creation
 514   static SafepointBlob* create(
 515     CodeBuffer* cb,
 516     OopMapSet*  oop_maps,
 517     int         frame_size
 518   );
 519 
 520   // GC for args
 521   void preserve_callee_argument_oops(frame fr, const RegisterMap* reg_map, OopClosure* f)  { /* nothing to do */ }
 522 
 523   // Typing
 524   bool is_safepoint_stub() const                 { return true; }
 525 };
 526 
 527 #endif // SHARE_VM_CODE_CODEBLOB_HPP
--- EOF ---