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