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 
 255 //----------------------------------------------------------------------------------------------------
 256 // Implementation of AdapterBlob
 257 
 258 AdapterBlob::AdapterBlob(int size, CodeBuffer* cb) :
 259   BufferBlob("I2C/C2I adapters", size, cb) {
 260   CodeCache::commit(this);
 261 }
 262 
 263 AdapterBlob* AdapterBlob::create(CodeBuffer* cb) {
 264   ThreadInVMfromUnknown __tiv;  // get to VM state in case we block on CodeCache_lock
 265 
 266   AdapterBlob* blob = NULL;
 267   unsigned int size = allocation_size(cb, sizeof(AdapterBlob));
 268   {
 269     MutexLockerEx mu(CodeCache_lock, Mutex::_no_safepoint_check_flag);
 270     blob = new (size) AdapterBlob(size, cb);
 271   }
 272   // Track memory usage statistic after releasing CodeCache_lock
 273   MemoryService::track_code_cache_memory_usage();
 274 
 275   return blob;
 276 }
 277 
 278 
 279 //----------------------------------------------------------------------------------------------------
 280 // Implementation of MethodHandlesAdapterBlob
 281 
 282 MethodHandlesAdapterBlob* MethodHandlesAdapterBlob::create(int buffer_size) {
 283   ThreadInVMfromUnknown __tiv;  // get to VM state in case we block on CodeCache_lock
 284 
 285   MethodHandlesAdapterBlob* blob = NULL;
 286   unsigned int size = sizeof(MethodHandlesAdapterBlob);
 287   CodeCacheExtensions::size_blob("MethodHandles adapters", &buffer_size);
 288   // align the size to CodeEntryAlignment
 289   size = align_code_offset(size);
 290   size += round_to(buffer_size, oopSize);
 291   {
 292     MutexLockerEx mu(CodeCache_lock, Mutex::_no_safepoint_check_flag);
 293     blob = new (size) MethodHandlesAdapterBlob(size);
 294     if (blob == NULL) {
 295       vm_exit_out_of_memory(size, OOM_MALLOC_ERROR, "CodeCache: no room for method handle adapter blob");
 296     }
 297   }
 298   // Track memory usage statistic after releasing CodeCache_lock
 299   MemoryService::track_code_cache_memory_usage();
 300 
 301   return blob;
 302 }
 303 
 304 //----------------------------------------------------------------------------------------------------
 305 // Implementation of RuntimeStub
 306 
 307 RuntimeStub::RuntimeStub(
 308   const char* name,
 309   CodeBuffer* cb,
 310   int         size,
 311   int         frame_complete,
 312   int         frame_size,
 313   OopMapSet*  oop_maps,
 314   bool        caller_must_gc_arguments
 315 )
 316 : CodeBlob(name, cb, sizeof(RuntimeStub), size, frame_complete, frame_size, oop_maps)
 317 {
 318   _caller_must_gc_arguments = caller_must_gc_arguments;
 319 }
 320 
 321 
 322 RuntimeStub* RuntimeStub::new_runtime_stub(const char* stub_name,
 323                                            CodeBuffer* cb,
 324                                            int frame_complete,
 325                                            int frame_size,
 326                                            OopMapSet* oop_maps,
 327                                            bool caller_must_gc_arguments)
 328 {
 329   RuntimeStub* stub = NULL;
 330   ThreadInVMfromUnknown __tiv;  // get to VM state in case we block on CodeCache_lock
 331   if (!CodeCacheExtensions::skip_code_generation()) {
 332     // bypass useless code generation
 333     MutexLockerEx mu(CodeCache_lock, Mutex::_no_safepoint_check_flag);
 334     unsigned int size = allocation_size(cb, sizeof(RuntimeStub));
 335     stub = new (size) RuntimeStub(stub_name, cb, size, frame_complete, frame_size, oop_maps, caller_must_gc_arguments);
 336   }
 337   stub = (RuntimeStub*) CodeCacheExtensions::handle_generated_blob(stub, stub_name);
 338 
 339   trace_new_stub(stub, "RuntimeStub - ", stub_name);
 340 
 341   return stub;
 342 }
 343 
 344 
 345 void* RuntimeStub::operator new(size_t s, unsigned size) throw() {
 346   void* p = CodeCache::allocate(size, CodeBlobType::NonNMethod);
 347   if (!p) fatal("Initial size of CodeCache is too small");
 348   return p;
 349 }
 350 
 351 // operator new shared by all singletons:
 352 void* SingletonBlob::operator new(size_t s, unsigned size) throw() {
 353   void* p = CodeCache::allocate(size, CodeBlobType::NonNMethod);
 354   if (!p) fatal("Initial size of CodeCache is too small");
 355   return p;
 356 }
 357 
 358 
 359 //----------------------------------------------------------------------------------------------------
 360 // Implementation of DeoptimizationBlob
 361 
 362 DeoptimizationBlob::DeoptimizationBlob(
 363   CodeBuffer* cb,
 364   int         size,
 365   OopMapSet*  oop_maps,
 366   int         unpack_offset,
 367   int         unpack_with_exception_offset,
 368   int         unpack_with_reexecution_offset,
 369   int         frame_size
 370 )
 371 : SingletonBlob("DeoptimizationBlob", cb, sizeof(DeoptimizationBlob), size, frame_size, oop_maps)
 372 {
 373   _unpack_offset           = unpack_offset;
 374   _unpack_with_exception   = unpack_with_exception_offset;
 375   _unpack_with_reexecution = unpack_with_reexecution_offset;
 376 #ifdef COMPILER1
 377   _unpack_with_exception_in_tls   = -1;
 378 #endif
 379 }
 380 
 381 
 382 DeoptimizationBlob* DeoptimizationBlob::create(
 383   CodeBuffer* cb,
 384   OopMapSet*  oop_maps,
 385   int        unpack_offset,
 386   int        unpack_with_exception_offset,
 387   int        unpack_with_reexecution_offset,
 388   int        frame_size)
 389 {
 390   DeoptimizationBlob* blob = NULL;
 391   ThreadInVMfromUnknown __tiv;  // get to VM state in case we block on CodeCache_lock
 392   {
 393     MutexLockerEx mu(CodeCache_lock, Mutex::_no_safepoint_check_flag);
 394     unsigned int size = allocation_size(cb, sizeof(DeoptimizationBlob));
 395     blob = new (size) DeoptimizationBlob(cb,
 396                                          size,
 397                                          oop_maps,
 398                                          unpack_offset,
 399                                          unpack_with_exception_offset,
 400                                          unpack_with_reexecution_offset,
 401                                          frame_size);
 402   }
 403 
 404   trace_new_stub(blob, "DeoptimizationBlob");
 405 
 406   return blob;
 407 }
 408 
 409 
 410 //----------------------------------------------------------------------------------------------------
 411 // Implementation of UncommonTrapBlob
 412 
 413 #ifdef COMPILER2
 414 UncommonTrapBlob::UncommonTrapBlob(
 415   CodeBuffer* cb,
 416   int         size,
 417   OopMapSet*  oop_maps,
 418   int         frame_size
 419 )
 420 : SingletonBlob("UncommonTrapBlob", cb, sizeof(UncommonTrapBlob), size, frame_size, oop_maps)
 421 {}
 422 
 423 
 424 UncommonTrapBlob* UncommonTrapBlob::create(
 425   CodeBuffer* cb,
 426   OopMapSet*  oop_maps,
 427   int        frame_size)
 428 {
 429   UncommonTrapBlob* blob = NULL;
 430   ThreadInVMfromUnknown __tiv;  // get to VM state in case we block on CodeCache_lock
 431   {
 432     MutexLockerEx mu(CodeCache_lock, Mutex::_no_safepoint_check_flag);
 433     unsigned int size = allocation_size(cb, sizeof(UncommonTrapBlob));
 434     blob = new (size) UncommonTrapBlob(cb, size, oop_maps, frame_size);
 435   }
 436 
 437   trace_new_stub(blob, "UncommonTrapBlob");
 438 
 439   return blob;
 440 }
 441 
 442 
 443 #endif // COMPILER2
 444 
 445 
 446 //----------------------------------------------------------------------------------------------------
 447 // Implementation of ExceptionBlob
 448 
 449 #ifdef COMPILER2
 450 ExceptionBlob::ExceptionBlob(
 451   CodeBuffer* cb,
 452   int         size,
 453   OopMapSet*  oop_maps,
 454   int         frame_size
 455 )
 456 : SingletonBlob("ExceptionBlob", cb, sizeof(ExceptionBlob), size, frame_size, oop_maps)
 457 {}
 458 
 459 
 460 ExceptionBlob* ExceptionBlob::create(
 461   CodeBuffer* cb,
 462   OopMapSet*  oop_maps,
 463   int         frame_size)
 464 {
 465   ExceptionBlob* blob = NULL;
 466   ThreadInVMfromUnknown __tiv;  // get to VM state in case we block on CodeCache_lock
 467   {
 468     MutexLockerEx mu(CodeCache_lock, Mutex::_no_safepoint_check_flag);
 469     unsigned int size = allocation_size(cb, sizeof(ExceptionBlob));
 470     blob = new (size) ExceptionBlob(cb, size, oop_maps, frame_size);
 471   }
 472 
 473   trace_new_stub(blob, "ExceptionBlob");
 474 
 475   return blob;
 476 }
 477 
 478 
 479 #endif // COMPILER2
 480 
 481 
 482 //----------------------------------------------------------------------------------------------------
 483 // Implementation of SafepointBlob
 484 
 485 SafepointBlob::SafepointBlob(
 486   CodeBuffer* cb,
 487   int         size,
 488   OopMapSet*  oop_maps,
 489   int         frame_size
 490 )
 491 : SingletonBlob("SafepointBlob", cb, sizeof(SafepointBlob), size, frame_size, oop_maps)
 492 {}
 493 
 494 
 495 SafepointBlob* SafepointBlob::create(
 496   CodeBuffer* cb,
 497   OopMapSet*  oop_maps,
 498   int         frame_size)
 499 {
 500   SafepointBlob* blob = NULL;
 501   ThreadInVMfromUnknown __tiv;  // get to VM state in case we block on CodeCache_lock
 502   {
 503     MutexLockerEx mu(CodeCache_lock, Mutex::_no_safepoint_check_flag);
 504     unsigned int size = allocation_size(cb, sizeof(SafepointBlob));
 505     blob = new (size) SafepointBlob(cb, size, oop_maps, frame_size);
 506   }
 507 
 508   trace_new_stub(blob, "SafepointBlob");
 509 
 510   return blob;
 511 }
 512 
 513 
 514 //----------------------------------------------------------------------------------------------------
 515 // Verification and printing
 516 
 517 void CodeBlob::verify() {
 518   ShouldNotReachHere();
 519 }
 520 
 521 void CodeBlob::print_on(outputStream* st) const {
 522   st->print_cr("[CodeBlob (" INTPTR_FORMAT ")]", p2i(this));
 523   st->print_cr("Framesize: %d", _frame_size);
 524 }
 525 
 526 void CodeBlob::print_value_on(outputStream* st) const {
 527   st->print_cr("[CodeBlob]");
 528 }
 529 
 530 void BufferBlob::verify() {
 531   // unimplemented
 532 }
 533 
 534 void BufferBlob::print_on(outputStream* st) const {
 535   CodeBlob::print_on(st);
 536   print_value_on(st);
 537 }
 538 
 539 void BufferBlob::print_value_on(outputStream* st) const {
 540   st->print_cr("BufferBlob (" INTPTR_FORMAT  ") used for %s", p2i(this), name());
 541 }
 542 
 543 void RuntimeStub::verify() {
 544   // unimplemented
 545 }
 546 
 547 void RuntimeStub::print_on(outputStream* st) const {
 548   ttyLocker ttyl;
 549   CodeBlob::print_on(st);
 550   st->print("Runtime Stub (" INTPTR_FORMAT "): ", p2i(this));
 551   st->print_cr("%s", name());
 552   Disassembler::decode((CodeBlob*)this, st);
 553 }
 554 
 555 void RuntimeStub::print_value_on(outputStream* st) const {
 556   st->print("RuntimeStub (" INTPTR_FORMAT "): ", p2i(this)); st->print("%s", name());
 557 }
 558 
 559 void SingletonBlob::verify() {
 560   // unimplemented
 561 }
 562 
 563 void SingletonBlob::print_on(outputStream* st) const {
 564   ttyLocker ttyl;
 565   CodeBlob::print_on(st);
 566   st->print_cr("%s", name());
 567   Disassembler::decode((CodeBlob*)this, st);
 568 }
 569 
 570 void SingletonBlob::print_value_on(outputStream* st) const {
 571   st->print_cr("%s", name());
 572 }
 573 
 574 void DeoptimizationBlob::print_value_on(outputStream* st) const {
 575   st->print_cr("Deoptimization (frame not available)");
 576 }