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 #include "precompiled.hpp"
  26 #include "code/codeBlob.hpp"
  27 #include "code/codeCache.hpp"
  28 #include "code/codeCacheExtensions.hpp"
  29 #include "code/relocInfo.hpp"
  30 #include "compiler/disassembler.hpp"
  31 #include "interpreter/bytecode.hpp"
  32 #include "memory/allocation.inline.hpp"
  33 #include "memory/heap.hpp"
  34 #include "oops/oop.inline.hpp"
  35 #include "prims/forte.hpp"
  36 #include "runtime/handles.inline.hpp"
  37 #include "runtime/interfaceSupport.hpp"
  38 #include "runtime/mutexLocker.hpp"
  39 #include "runtime/safepoint.hpp"
  40 #include "runtime/sharedRuntime.hpp"
  41 #include "runtime/vframe.hpp"
  42 #include "services/memoryService.hpp"
  43 #ifdef COMPILER1
  44 #include "c1/c1_Runtime1.hpp"
  45 #endif
  46 
  47 unsigned int CodeBlob::align_code_offset(int offset) {
  48   // align the size to CodeEntryAlignment
  49   return
  50     ((offset + (int)CodeHeap::header_size() + (CodeEntryAlignment-1)) & ~(CodeEntryAlignment-1))
  51     - (int)CodeHeap::header_size();
  52 }
  53 
  54 
  55 // This must be consistent with the CodeBlob constructor's layout actions.
  56 unsigned int CodeBlob::allocation_size(CodeBuffer* cb, int header_size) {
  57   unsigned int size = header_size;
  58   size += round_to(cb->total_relocation_size(), oopSize);
  59   // align the size to CodeEntryAlignment
  60   size = align_code_offset(size);
  61   size += round_to(cb->total_content_size(), oopSize);
  62   size += round_to(cb->total_oop_size(), oopSize);
  63   size += round_to(cb->total_metadata_size(), oopSize);
  64   return size;
  65 }
  66 
  67 
  68 // Creates a simple CodeBlob. Sets up the size of the different regions.
  69 CodeBlob::CodeBlob(const char* name, int header_size, int size, int frame_complete, int locs_size) {
  70   assert(size        == round_to(size,        oopSize), "unaligned size");
  71   assert(locs_size   == round_to(locs_size,   oopSize), "unaligned size");
  72   assert(header_size == round_to(header_size, oopSize), "unaligned size");
  73   assert(!UseRelocIndex, "no space allocated for reloc index yet");
  74 
  75   // Note: If UseRelocIndex is enabled, there needs to be (at least) one
  76   //       extra word for the relocation information, containing the reloc
  77   //       index table length. Unfortunately, the reloc index table imple-
  78   //       mentation is not easily understandable and thus it is not clear
  79   //       what exactly the format is supposed to be. For now, we just turn
  80   //       off the use of this table (gri 7/6/2000).
  81 
  82   _name                  = name;
  83   _size                  = size;
  84   _frame_complete_offset = frame_complete;
  85   _header_size           = header_size;
  86   _relocation_size       = locs_size;
  87   _content_offset        = align_code_offset(header_size + _relocation_size);
  88   _code_offset           = _content_offset;
  89   _data_offset           = size;
  90   _frame_size            =  0;
  91   set_oop_maps(NULL);
  92   _strings               = CodeStrings();
  93 }
  94 
  95 
  96 // Creates a CodeBlob from a CodeBuffer. Sets up the size of the different regions,
  97 // and copy code and relocation info.
  98 CodeBlob::CodeBlob(
  99   const char* name,
 100   CodeBuffer* cb,
 101   int         header_size,
 102   int         size,
 103   int         frame_complete,
 104   int         frame_size,
 105   OopMapSet*  oop_maps
 106 ) {
 107   assert(size        == round_to(size,        oopSize), "unaligned size");
 108   assert(header_size == round_to(header_size, oopSize), "unaligned size");
 109 
 110   _name                  = name;
 111   _size                  = size;
 112   _frame_complete_offset = frame_complete;
 113   _header_size           = header_size;
 114   _relocation_size       = round_to(cb->total_relocation_size(), oopSize);
 115   _content_offset        = align_code_offset(header_size + _relocation_size);
 116   _code_offset           = _content_offset + cb->total_offset_of(cb->insts());
 117   _data_offset           = _content_offset + round_to(cb->total_content_size(), oopSize);
 118   assert(_data_offset <= size, "codeBlob is too small");
 119   _strings               = CodeStrings();
 120 
 121   cb->copy_code_and_locs_to(this);
 122   set_oop_maps(oop_maps);
 123   _frame_size = frame_size;
 124 #ifdef COMPILER1
 125   // probably wrong for tiered
 126   assert(_frame_size >= -1, "must use frame size or -1 for runtime stubs");
 127 #endif // COMPILER1
 128 }
 129 
 130 
 131 void CodeBlob::set_oop_maps(OopMapSet* p) {
 132   // Danger Will Robinson! This method allocates a big
 133   // chunk of memory, its your job to free it.
 134   if (p != NULL) {
 135     _oop_maps = ImmutableOopMapSet::build_from(p);
 136   } else {
 137     _oop_maps = NULL;
 138   }
 139 }
 140 
 141 
 142 void CodeBlob::trace_new_stub(CodeBlob* stub, const char* name1, const char* name2) {
 143   // Do not hold the CodeCache lock during name formatting.
 144   assert(!CodeCache_lock->owned_by_self(), "release CodeCache before registering the stub");
 145 
 146   if (stub != NULL) {
 147     char stub_id[256];
 148     assert(strlen(name1) + strlen(name2) < sizeof(stub_id), "");
 149     jio_snprintf(stub_id, sizeof(stub_id), "%s%s", name1, name2);
 150     if (PrintStubCode) {
 151       ttyLocker ttyl;
 152       tty->print_cr("Decoding %s " INTPTR_FORMAT, stub_id, (intptr_t) stub);
 153       Disassembler::decode(stub->code_begin(), stub->code_end());
 154       tty->cr();
 155     }
 156     Forte::register_stub(stub_id, stub->code_begin(), stub->code_end());
 157 
 158     if (JvmtiExport::should_post_dynamic_code_generated()) {
 159       const char* stub_name = name2;
 160       if (name2[0] == '\0')  stub_name = name1;
 161       JvmtiExport::post_dynamic_code_generated(stub_name, stub->code_begin(), stub->code_end());
 162     }
 163   }
 164 
 165   // Track memory usage statistic after releasing CodeCache_lock
 166   MemoryService::track_code_cache_memory_usage();
 167 }
 168 
 169 
 170 void CodeBlob::flush() {
 171   if (_oop_maps) {
 172     FREE_C_HEAP_ARRAY(unsigned char, _oop_maps);
 173     _oop_maps = NULL;
 174   }
 175   _strings.free();
 176 }
 177 
 178 
 179 const ImmutableOopMap* CodeBlob::oop_map_for_return_address(address return_address) {
 180   assert(oop_maps() != NULL, "nope");
 181   return oop_maps()->find_map_at_offset((intptr_t) return_address - (intptr_t) code_begin());
 182 }
 183 
 184 void CodeBlob::print_code() {
 185   HandleMark hm;
 186   ResourceMark m;
 187   Disassembler::decode(this, tty);
 188 }
 189 
 190 //----------------------------------------------------------------------------------------------------
 191 // Implementation of BufferBlob
 192 
 193 
 194 BufferBlob::BufferBlob(const char* name, int size)
 195 : CodeBlob(name, sizeof(BufferBlob), size, CodeOffsets::frame_never_safe, /*locs_size:*/ 0)
 196 {}
 197 
 198 BufferBlob* BufferBlob::create(const char* name, int buffer_size) {
 199   ThreadInVMfromUnknown __tiv;  // get to VM state in case we block on CodeCache_lock
 200 
 201   BufferBlob* blob = NULL;
 202   unsigned int size = sizeof(BufferBlob);
 203   CodeCacheExtensions::size_blob(name, &buffer_size);
 204   // align the size to CodeEntryAlignment
 205   size = align_code_offset(size);
 206   size += round_to(buffer_size, oopSize);
 207   assert(name != NULL, "must provide a name");
 208   {
 209     MutexLockerEx mu(CodeCache_lock, Mutex::_no_safepoint_check_flag);
 210     blob = new (size) BufferBlob(name, size);
 211   }
 212   // Track memory usage statistic after releasing CodeCache_lock
 213   MemoryService::track_code_cache_memory_usage();
 214 
 215   return blob;
 216 }
 217 
 218 
 219 BufferBlob::BufferBlob(const char* name, int size, CodeBuffer* cb)
 220   : CodeBlob(name, cb, sizeof(BufferBlob), size, CodeOffsets::frame_never_safe, 0, NULL)
 221 {}
 222 
 223 BufferBlob* BufferBlob::create(const char* name, CodeBuffer* cb) {
 224   ThreadInVMfromUnknown __tiv;  // get to VM state in case we block on CodeCache_lock
 225 
 226   BufferBlob* blob = NULL;
 227   unsigned int size = allocation_size(cb, sizeof(BufferBlob));
 228   assert(name != NULL, "must provide a name");
 229   {
 230     MutexLockerEx mu(CodeCache_lock, Mutex::_no_safepoint_check_flag);
 231     blob = new (size) BufferBlob(name, size, cb);
 232   }
 233   // Track memory usage statistic after releasing CodeCache_lock
 234   MemoryService::track_code_cache_memory_usage();
 235 
 236   return blob;
 237 }
 238 
 239 void* BufferBlob::operator new(size_t s, unsigned size) throw() {
 240   return CodeCache::allocate(size, CodeBlobType::NonNMethod);
 241 }
 242 
 243 void BufferBlob::free(BufferBlob *blob) {
 244   ThreadInVMfromUnknown __tiv;  // get to VM state in case we block on CodeCache_lock
 245   blob->flush();
 246   {
 247     MutexLockerEx mu(CodeCache_lock, Mutex::_no_safepoint_check_flag);
 248     CodeCache::free((CodeBlob*)blob);
 249   }
 250   // Track memory usage statistic after releasing CodeCache_lock
 251   MemoryService::track_code_cache_memory_usage();
 252 }
 253 
 254 BufferBlob::BufferBlob(const char* name, int size, CodeBuffer* cb, int frame_complete, int frame_size, OopMapSet* oop_maps)
 255   : CodeBlob(name, cb, sizeof(BufferBlob), size, frame_complete, frame_size, oop_maps)
 256 {}
 257 
 258 
 259 //----------------------------------------------------------------------------------------------------
 260 // Implementation of AdapterBlob
 261 
 262 AdapterBlob::AdapterBlob(int size, CodeBuffer* cb, int frame_complete, int frame_size, OopMapSet* oop_maps) :
 263   BufferBlob("I2C/C2I adapters", size, cb, frame_complete, frame_size, oop_maps) {
 264   CodeCache::commit(this);
 265 }
 266 
 267 AdapterBlob* AdapterBlob::create(CodeBuffer* cb, int frame_complete, int frame_size, OopMapSet* oop_maps) {
 268   ThreadInVMfromUnknown __tiv;  // get to VM state in case we block on CodeCache_lock
 269 
 270   AdapterBlob* blob = NULL;
 271   unsigned int size = allocation_size(cb, sizeof(AdapterBlob));
 272   {
 273     MutexLockerEx mu(CodeCache_lock, Mutex::_no_safepoint_check_flag);
 274     blob = new (size) AdapterBlob(size, cb, frame_complete, frame_size, oop_maps);
 275   }
 276   // Track memory usage statistic after releasing CodeCache_lock
 277   MemoryService::track_code_cache_memory_usage();
 278 
 279   return blob;
 280 }
 281 
 282 
 283 //----------------------------------------------------------------------------------------------------
 284 // Implementation of MethodHandlesAdapterBlob
 285 
 286 MethodHandlesAdapterBlob* MethodHandlesAdapterBlob::create(int buffer_size) {
 287   ThreadInVMfromUnknown __tiv;  // get to VM state in case we block on CodeCache_lock
 288 
 289   MethodHandlesAdapterBlob* blob = NULL;
 290   unsigned int size = sizeof(MethodHandlesAdapterBlob);
 291   CodeCacheExtensions::size_blob("MethodHandles adapters", &buffer_size);
 292   // align the size to CodeEntryAlignment
 293   size = align_code_offset(size);
 294   size += round_to(buffer_size, oopSize);
 295   {
 296     MutexLockerEx mu(CodeCache_lock, Mutex::_no_safepoint_check_flag);
 297     blob = new (size) MethodHandlesAdapterBlob(size);
 298     if (blob == NULL) {
 299       vm_exit_out_of_memory(size, OOM_MALLOC_ERROR, "CodeCache: no room for method handle adapter blob");
 300     }
 301   }
 302   // Track memory usage statistic after releasing CodeCache_lock
 303   MemoryService::track_code_cache_memory_usage();
 304 
 305   return blob;
 306 }
 307 
 308 //----------------------------------------------------------------------------------------------------
 309 // Implementation of RuntimeStub
 310 
 311 RuntimeStub::RuntimeStub(
 312   const char* name,
 313   CodeBuffer* cb,
 314   int         size,
 315   int         frame_complete,
 316   int         frame_size,
 317   OopMapSet*  oop_maps,
 318   bool        caller_must_gc_arguments
 319 )
 320 : CodeBlob(name, cb, sizeof(RuntimeStub), size, frame_complete, frame_size, oop_maps)
 321 {
 322   _caller_must_gc_arguments = caller_must_gc_arguments;
 323 }
 324 
 325 
 326 RuntimeStub* RuntimeStub::new_runtime_stub(const char* stub_name,
 327                                            CodeBuffer* cb,
 328                                            int frame_complete,
 329                                            int frame_size,
 330                                            OopMapSet* oop_maps,
 331                                            bool caller_must_gc_arguments)
 332 {
 333   RuntimeStub* stub = NULL;
 334   ThreadInVMfromUnknown __tiv;  // get to VM state in case we block on CodeCache_lock
 335   if (!CodeCacheExtensions::skip_code_generation()) {
 336     // bypass useless code generation
 337     MutexLockerEx mu(CodeCache_lock, Mutex::_no_safepoint_check_flag);
 338     unsigned int size = allocation_size(cb, sizeof(RuntimeStub));
 339     stub = new (size) RuntimeStub(stub_name, cb, size, frame_complete, frame_size, oop_maps, caller_must_gc_arguments);
 340   }
 341   stub = (RuntimeStub*) CodeCacheExtensions::handle_generated_blob(stub, stub_name);
 342 
 343   trace_new_stub(stub, "RuntimeStub - ", stub_name);
 344 
 345   return stub;
 346 }
 347 
 348 
 349 void* RuntimeStub::operator new(size_t s, unsigned size) throw() {
 350   void* p = CodeCache::allocate(size, CodeBlobType::NonNMethod);
 351   if (!p) fatal("Initial size of CodeCache is too small");
 352   return p;
 353 }
 354 
 355 // operator new shared by all singletons:
 356 void* SingletonBlob::operator new(size_t s, unsigned size) throw() {
 357   void* p = CodeCache::allocate(size, CodeBlobType::NonNMethod);
 358   if (!p) fatal("Initial size of CodeCache is too small");
 359   return p;
 360 }
 361 
 362 
 363 //----------------------------------------------------------------------------------------------------
 364 // Implementation of DeoptimizationBlob
 365 
 366 DeoptimizationBlob::DeoptimizationBlob(
 367   CodeBuffer* cb,
 368   int         size,
 369   OopMapSet*  oop_maps,
 370   int         unpack_offset,
 371   int         unpack_with_exception_offset,
 372   int         unpack_with_reexecution_offset,
 373   int         frame_size
 374 )
 375 : SingletonBlob("DeoptimizationBlob", cb, sizeof(DeoptimizationBlob), size, frame_size, oop_maps)
 376 {
 377   _unpack_offset           = unpack_offset;
 378   _unpack_with_exception   = unpack_with_exception_offset;
 379   _unpack_with_reexecution = unpack_with_reexecution_offset;
 380 #ifdef COMPILER1
 381   _unpack_with_exception_in_tls   = -1;
 382 #endif
 383 }
 384 
 385 
 386 DeoptimizationBlob* DeoptimizationBlob::create(
 387   CodeBuffer* cb,
 388   OopMapSet*  oop_maps,
 389   int        unpack_offset,
 390   int        unpack_with_exception_offset,
 391   int        unpack_with_reexecution_offset,
 392   int        frame_size)
 393 {
 394   DeoptimizationBlob* blob = NULL;
 395   ThreadInVMfromUnknown __tiv;  // get to VM state in case we block on CodeCache_lock
 396   {
 397     MutexLockerEx mu(CodeCache_lock, Mutex::_no_safepoint_check_flag);
 398     unsigned int size = allocation_size(cb, sizeof(DeoptimizationBlob));
 399     blob = new (size) DeoptimizationBlob(cb,
 400                                          size,
 401                                          oop_maps,
 402                                          unpack_offset,
 403                                          unpack_with_exception_offset,
 404                                          unpack_with_reexecution_offset,
 405                                          frame_size);
 406   }
 407 
 408   trace_new_stub(blob, "DeoptimizationBlob");
 409 
 410   return blob;
 411 }
 412 
 413 
 414 //----------------------------------------------------------------------------------------------------
 415 // Implementation of UncommonTrapBlob
 416 
 417 #ifdef COMPILER2
 418 UncommonTrapBlob::UncommonTrapBlob(
 419   CodeBuffer* cb,
 420   int         size,
 421   OopMapSet*  oop_maps,
 422   int         frame_size
 423 )
 424 : SingletonBlob("UncommonTrapBlob", cb, sizeof(UncommonTrapBlob), size, frame_size, oop_maps)
 425 {}
 426 
 427 
 428 UncommonTrapBlob* UncommonTrapBlob::create(
 429   CodeBuffer* cb,
 430   OopMapSet*  oop_maps,
 431   int        frame_size)
 432 {
 433   UncommonTrapBlob* blob = NULL;
 434   ThreadInVMfromUnknown __tiv;  // get to VM state in case we block on CodeCache_lock
 435   {
 436     MutexLockerEx mu(CodeCache_lock, Mutex::_no_safepoint_check_flag);
 437     unsigned int size = allocation_size(cb, sizeof(UncommonTrapBlob));
 438     blob = new (size) UncommonTrapBlob(cb, size, oop_maps, frame_size);
 439   }
 440 
 441   trace_new_stub(blob, "UncommonTrapBlob");
 442 
 443   return blob;
 444 }
 445 
 446 
 447 #endif // COMPILER2
 448 
 449 
 450 //----------------------------------------------------------------------------------------------------
 451 // Implementation of ExceptionBlob
 452 
 453 #ifdef COMPILER2
 454 ExceptionBlob::ExceptionBlob(
 455   CodeBuffer* cb,
 456   int         size,
 457   OopMapSet*  oop_maps,
 458   int         frame_size
 459 )
 460 : SingletonBlob("ExceptionBlob", cb, sizeof(ExceptionBlob), size, frame_size, oop_maps)
 461 {}
 462 
 463 
 464 ExceptionBlob* ExceptionBlob::create(
 465   CodeBuffer* cb,
 466   OopMapSet*  oop_maps,
 467   int         frame_size)
 468 {
 469   ExceptionBlob* blob = NULL;
 470   ThreadInVMfromUnknown __tiv;  // get to VM state in case we block on CodeCache_lock
 471   {
 472     MutexLockerEx mu(CodeCache_lock, Mutex::_no_safepoint_check_flag);
 473     unsigned int size = allocation_size(cb, sizeof(ExceptionBlob));
 474     blob = new (size) ExceptionBlob(cb, size, oop_maps, frame_size);
 475   }
 476 
 477   trace_new_stub(blob, "ExceptionBlob");
 478 
 479   return blob;
 480 }
 481 
 482 
 483 #endif // COMPILER2
 484 
 485 
 486 //----------------------------------------------------------------------------------------------------
 487 // Implementation of SafepointBlob
 488 
 489 SafepointBlob::SafepointBlob(
 490   CodeBuffer* cb,
 491   int         size,
 492   OopMapSet*  oop_maps,
 493   int         frame_size
 494 )
 495 : SingletonBlob("SafepointBlob", cb, sizeof(SafepointBlob), size, frame_size, oop_maps)
 496 {}
 497 
 498 
 499 SafepointBlob* SafepointBlob::create(
 500   CodeBuffer* cb,
 501   OopMapSet*  oop_maps,
 502   int         frame_size)
 503 {
 504   SafepointBlob* blob = NULL;
 505   ThreadInVMfromUnknown __tiv;  // get to VM state in case we block on CodeCache_lock
 506   {
 507     MutexLockerEx mu(CodeCache_lock, Mutex::_no_safepoint_check_flag);
 508     unsigned int size = allocation_size(cb, sizeof(SafepointBlob));
 509     blob = new (size) SafepointBlob(cb, size, oop_maps, frame_size);
 510   }
 511 
 512   trace_new_stub(blob, "SafepointBlob");
 513 
 514   return blob;
 515 }
 516 
 517 
 518 //----------------------------------------------------------------------------------------------------
 519 // Verification and printing
 520 
 521 void CodeBlob::verify() {
 522   ShouldNotReachHere();
 523 }
 524 
 525 void CodeBlob::print_on(outputStream* st) const {
 526   st->print_cr("[CodeBlob (" INTPTR_FORMAT ")]", p2i(this));
 527   st->print_cr("Framesize: %d", _frame_size);
 528 }
 529 
 530 void CodeBlob::print_value_on(outputStream* st) const {
 531   st->print_cr("[CodeBlob]");
 532 }
 533 
 534 void BufferBlob::verify() {
 535   // unimplemented
 536 }
 537 
 538 void BufferBlob::print_on(outputStream* st) const {
 539   CodeBlob::print_on(st);
 540   print_value_on(st);
 541 }
 542 
 543 void BufferBlob::print_value_on(outputStream* st) const {
 544   st->print_cr("BufferBlob (" INTPTR_FORMAT  ") used for %s", p2i(this), name());
 545 }
 546 
 547 void RuntimeStub::verify() {
 548   // unimplemented
 549 }
 550 
 551 void RuntimeStub::print_on(outputStream* st) const {
 552   ttyLocker ttyl;
 553   CodeBlob::print_on(st);
 554   st->print("Runtime Stub (" INTPTR_FORMAT "): ", p2i(this));
 555   st->print_cr("%s", name());
 556   Disassembler::decode((CodeBlob*)this, st);
 557 }
 558 
 559 void RuntimeStub::print_value_on(outputStream* st) const {
 560   st->print("RuntimeStub (" INTPTR_FORMAT "): ", p2i(this)); st->print("%s", name());
 561 }
 562 
 563 void SingletonBlob::verify() {
 564   // unimplemented
 565 }
 566 
 567 void SingletonBlob::print_on(outputStream* st) const {
 568   ttyLocker ttyl;
 569   CodeBlob::print_on(st);
 570   st->print_cr("%s", name());
 571   Disassembler::decode((CodeBlob*)this, st);
 572 }
 573 
 574 void SingletonBlob::print_value_on(outputStream* st) const {
 575   st->print_cr("%s", name());
 576 }
 577 
 578 void DeoptimizationBlob::print_value_on(outputStream* st) const {
 579   st->print_cr("Deoptimization (frame not available)");
 580 }