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