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