1 /*
   2  * Copyright (c) 1999, 2025, 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 "cds/aotLinkedClassBulkLoader.hpp"
  26 #include "ci/ciCallProfile.hpp"
  27 #include "ci/ciExceptionHandler.hpp"
  28 #include "ci/ciInstanceKlass.hpp"
  29 #include "ci/ciMethod.hpp"
  30 #include "ci/ciMethodBlocks.hpp"
  31 #include "ci/ciMethodData.hpp"
  32 #include "ci/ciReplay.hpp"
  33 #include "ci/ciStreams.hpp"
  34 #include "ci/ciSymbol.hpp"
  35 #include "ci/ciSymbols.hpp"
  36 #include "ci/ciUtilities.inline.hpp"
  37 #include "code/aotCodeCache.hpp"
  38 #include "compiler/abstractCompiler.hpp"
  39 #include "compiler/compilerDefinitions.inline.hpp"
  40 #include "compiler/compilerOracle.hpp"
  41 #include "compiler/compileTask.hpp"
  42 #include "compiler/methodLiveness.hpp"
  43 #include "interpreter/interpreter.hpp"
  44 #include "interpreter/linkResolver.hpp"
  45 #include "interpreter/oopMapCache.hpp"
  46 #include "logging/log.hpp"
  47 #include "logging/logStream.hpp"
  48 #include "memory/allocation.inline.hpp"
  49 #include "memory/resourceArea.hpp"
  50 #include "oops/generateOopMap.hpp"
  51 #include "oops/method.inline.hpp"
  52 #include "oops/oop.inline.hpp"
  53 #include "oops/trainingData.hpp"
  54 #include "prims/methodHandles.hpp"
  55 #include "runtime/deoptimization.hpp"
  56 #include "runtime/handles.inline.hpp"
  57 #include "utilities/bitMap.inline.hpp"
  58 #include "utilities/xmlstream.hpp"
  59 #ifdef COMPILER2
  60 #include "ci/bcEscapeAnalyzer.hpp"
  61 #include "ci/ciTypeFlow.hpp"
  62 #include "oops/method.hpp"
  63 #endif
  64 
  65 // ciMethod
  66 //
  67 // This class represents a Method* in the HotSpot virtual
  68 // machine.
  69 
  70 
  71 // ------------------------------------------------------------------
  72 // ciMethod::ciMethod
  73 //
  74 // Loaded method.
  75 ciMethod::ciMethod(const methodHandle& h_m, ciInstanceKlass* holder) :
  76   ciMetadata(h_m()),
  77   _holder(holder)
  78 {
  79   assert(h_m() != nullptr, "no null method");
  80   assert(_holder->get_instanceKlass() == h_m->method_holder(), "");
  81 
  82   // These fields are always filled in in loaded methods.
  83   _flags = ciFlags(h_m->access_flags());
  84 
  85   // Easy to compute, so fill them in now.
  86   _max_stack          = h_m->max_stack();
  87   _max_locals         = h_m->max_locals();
  88   _code_size          = h_m->code_size();
  89   _handler_count      = h_m->exception_table_length();
  90   _size_of_parameters = h_m->size_of_parameters();
  91   _uses_monitors      = h_m->has_monitor_bytecodes();
  92   _balanced_monitors  = !_uses_monitors || h_m->guaranteed_monitor_matching();
  93   _is_c1_compilable   = !h_m->is_not_c1_compilable();
  94   _is_c2_compilable   = !h_m->is_not_c2_compilable();
  95   _can_be_parsed      = true;
  96   _has_reserved_stack_access = h_m->has_reserved_stack_access();
  97   _is_overpass        = h_m->is_overpass();
  98   // Lazy fields, filled in on demand.  Require allocation.
  99   _code               = nullptr;
 100   _exception_handlers = nullptr;
 101   _liveness           = nullptr;
 102   _method_blocks = nullptr;
 103 #if defined(COMPILER2)
 104   _flow               = nullptr;
 105   _bcea               = nullptr;
 106 #endif // COMPILER2
 107 
 108   // Check for blackhole intrinsic and then populate the intrinsic ID.
 109   CompilerOracle::tag_blackhole_if_possible(h_m);
 110   _intrinsic_id       = h_m->intrinsic_id();
 111 
 112   ciEnv *env = CURRENT_ENV;
 113   if (env->jvmti_can_hotswap_or_post_breakpoint()) {
 114     // 6328518 check hotswap conditions under the right lock.
 115     bool should_take_Compile_lock = !Compile_lock->owned_by_self();
 116     ConditionalMutexLocker locker(Compile_lock, should_take_Compile_lock, Mutex::_safepoint_check_flag);
 117     if (Dependencies::check_evol_method(h_m()) != nullptr) {
 118       _is_c1_compilable = false;
 119       _is_c2_compilable = false;
 120       _can_be_parsed = false;
 121     }
 122   } else {
 123     DEBUG_ONLY(CompilerThread::current()->check_possible_safepoint());
 124   }
 125 
 126   if (h_m->method_holder()->is_linked()) {
 127     _can_be_statically_bound = h_m->can_be_statically_bound();
 128     _can_omit_stack_trace = h_m->can_omit_stack_trace();
 129   } else {
 130     // Have to use a conservative value in this case.
 131     _can_be_statically_bound = false;
 132     _can_omit_stack_trace = true;
 133   }
 134 
 135   // Adjust the definition of this condition to be more useful:
 136   // %%% take these conditions into account in vtable generation
 137   if (!_can_be_statically_bound && h_m->is_private())
 138     _can_be_statically_bound = true;
 139   if (_can_be_statically_bound && h_m->is_abstract())
 140     _can_be_statically_bound = false;
 141 
 142   // generating _signature may allow GC and therefore move m.
 143   // These fields are always filled in.
 144   _name = env->get_symbol(h_m->name());
 145   ciSymbol* sig_symbol = env->get_symbol(h_m->signature());
 146   constantPoolHandle cpool(Thread::current(), h_m->constants());
 147   _signature = new (env->arena()) ciSignature(_holder, cpool, sig_symbol);
 148   _method_data = nullptr;
 149   _method_data_recorded = nullptr;
 150   // Take a snapshot of these values, so they will be commensurate with the MDO.
 151   if (ProfileInterpreter || CompilerConfig::is_c1_profiling()) {
 152     int invcnt = h_m->interpreter_invocation_count();
 153     // if the value overflowed report it as max int
 154     _interpreter_invocation_count = invcnt < 0 ? max_jint : invcnt ;
 155     _interpreter_throwout_count   = h_m->interpreter_throwout_count();
 156   } else {
 157     _interpreter_invocation_count = 0;
 158     _interpreter_throwout_count = 0;
 159   }
 160   if (_interpreter_invocation_count == 0)
 161     _interpreter_invocation_count = 1;
 162   _inline_instructions_size = -1;
 163   if (ReplayCompiles) {
 164     ciReplay::initialize(this);
 165   }
 166   DirectiveSet* directives = DirectivesStack::getMatchingDirective(h_m, CURRENT_ENV->task()->compiler());
 167   ccstrlist bci_list = directives->TooManyTrapsAtBCIOption;
 168   int len = (int)strlen(bci_list);
 169   Arena* arena = CURRENT_ENV->arena();
 170   _has_trap_at_bci = new (arena) GrowableArray<int>(arena, 2, 0, 0);
 171   for (int i = 0; i < len; i++) {
 172     int v = -1;
 173     int read;
 174     if (sscanf(bci_list + i, "%i%n", &v, &read) != 1) {
 175       warning("wrong format for TooManyTrapsAtBCI option: \"%s\"", bci_list);
 176       break;
 177     }
 178     assert(v >= 0 && v < (1<<16), "%i", v);
 179     _has_trap_at_bci->append_if_missing(v);
 180     i += read;
 181   }
 182 }
 183 
 184 
 185 // ------------------------------------------------------------------
 186 // ciMethod::ciMethod
 187 //
 188 // Unloaded method.
 189 ciMethod::ciMethod(ciInstanceKlass* holder,
 190                    ciSymbol*        name,
 191                    ciSymbol*        signature,
 192                    ciInstanceKlass* accessor) :
 193   ciMetadata((Metadata*)nullptr),
 194   _name(                   name),
 195   _holder(                 holder),
 196   _method_data(            nullptr),
 197   _method_data_recorded(   nullptr),
 198   _method_blocks(          nullptr),
 199   _intrinsic_id(           vmIntrinsics::_none),
 200   _inline_instructions_size(-1),
 201   _can_be_statically_bound(false),
 202   _can_omit_stack_trace(true),
 203   _has_trap_at_bci(        nullptr),
 204   _liveness(               nullptr)
 205 #if defined(COMPILER2)
 206   ,
 207   _flow(                   nullptr),
 208   _bcea(                   nullptr)
 209 #endif // COMPILER2
 210 {
 211   // Usually holder and accessor are the same type but in some cases
 212   // the holder has the wrong class loader (e.g. invokedynamic call
 213   // sites) so we pass the accessor.
 214   _signature = new (CURRENT_ENV->arena()) ciSignature(accessor, constantPoolHandle(), signature);
 215 }
 216 
 217 
 218 // ------------------------------------------------------------------
 219 // ciMethod::load_code
 220 //
 221 // Load the bytecodes and exception handler table for this method.
 222 void ciMethod::load_code() {
 223   VM_ENTRY_MARK;
 224   assert(is_loaded(), "only loaded methods have code");
 225 
 226   Method* me = get_Method();
 227   Arena* arena = CURRENT_THREAD_ENV->arena();
 228 
 229   // Load the bytecodes.
 230   _code = (address)arena->Amalloc(code_size());
 231   memcpy(_code, me->code_base(), code_size());
 232 
 233 #if INCLUDE_JVMTI
 234   // Revert any breakpoint bytecodes in ci's copy
 235   if (me->number_of_breakpoints() > 0) {
 236     BreakpointInfo* bp = me->method_holder()->breakpoints();
 237     for (; bp != nullptr; bp = bp->next()) {
 238       if (bp->match(me)) {
 239         code_at_put(bp->bci(), bp->orig_bytecode());
 240       }
 241     }
 242   }
 243 #endif
 244 
 245   // And load the exception table.
 246   ExceptionTable exc_table(me);
 247 
 248   // Allocate one extra spot in our list of exceptions.  This
 249   // last entry will be used to represent the possibility that
 250   // an exception escapes the method.  See ciExceptionHandlerStream
 251   // for details.
 252   _exception_handlers =
 253     (ciExceptionHandler**)arena->Amalloc(sizeof(ciExceptionHandler*)
 254                                          * (_handler_count + 1));
 255   if (_handler_count > 0) {
 256     for (int i=0; i<_handler_count; i++) {
 257       _exception_handlers[i] = new (arena) ciExceptionHandler(
 258                                 holder(),
 259             /* start    */      exc_table.start_pc(i),
 260             /* limit    */      exc_table.end_pc(i),
 261             /* goto pc  */      exc_table.handler_pc(i),
 262             /* cp index */      exc_table.catch_type_index(i));
 263     }
 264   }
 265 
 266   // Put an entry at the end of our list to represent the possibility
 267   // of exceptional exit.
 268   _exception_handlers[_handler_count] =
 269     new (arena) ciExceptionHandler(holder(), 0, code_size(), -1, 0);
 270 
 271   if (CIPrintMethodCodes) {
 272     print_codes();
 273   }
 274 }
 275 
 276 
 277 // ------------------------------------------------------------------
 278 // ciMethod::has_linenumber_table
 279 //
 280 // length unknown until decompression
 281 bool    ciMethod::has_linenumber_table() const {
 282   check_is_loaded();
 283   VM_ENTRY_MARK;
 284   return get_Method()->has_linenumber_table();
 285 }
 286 
 287 
 288 // ------------------------------------------------------------------
 289 // ciMethod::line_number_from_bci
 290 int ciMethod::line_number_from_bci(int bci) const {
 291   check_is_loaded();
 292   VM_ENTRY_MARK;
 293   return get_Method()->line_number_from_bci(bci);
 294 }
 295 
 296 
 297 // ------------------------------------------------------------------
 298 // ciMethod::vtable_index
 299 //
 300 // Get the position of this method's entry in the vtable, if any.
 301 int ciMethod::vtable_index() {
 302   check_is_loaded();
 303   assert(holder()->is_linked(), "must be linked");
 304   VM_ENTRY_MARK;
 305   return get_Method()->vtable_index();
 306 }
 307 
 308 // ------------------------------------------------------------------
 309 // ciMethod::uses_balanced_monitors
 310 //
 311 // Does this method use monitors in a strict stack-disciplined manner?
 312 bool ciMethod::has_balanced_monitors() {
 313   check_is_loaded();
 314   if (_balanced_monitors) return true;
 315 
 316   // Analyze the method to see if monitors are used properly.
 317   VM_ENTRY_MARK;
 318   methodHandle method(THREAD, get_Method());
 319   assert(method->has_monitor_bytecodes(), "should have checked this");
 320 
 321   // Check to see if a previous compilation computed the
 322   // monitor-matching analysis.
 323   if (method->guaranteed_monitor_matching()) {
 324     _balanced_monitors = true;
 325     return true;
 326   }
 327 
 328   {
 329     ExceptionMark em(THREAD);
 330     ResourceMark rm(THREAD);
 331     GeneratePairingInfo gpi(method);
 332     if (!gpi.compute_map(THREAD)) {
 333       fatal("Unrecoverable verification or out-of-memory error");
 334     }
 335     if (!gpi.monitor_safe()) {
 336       return false;
 337     }
 338     method->set_guaranteed_monitor_matching();
 339     _balanced_monitors = true;
 340   }
 341   return true;
 342 }
 343 
 344 
 345 // ------------------------------------------------------------------
 346 // ciMethod::get_flow_analysis
 347 ciTypeFlow* ciMethod::get_flow_analysis() {
 348 #if defined(COMPILER2)
 349   if (_flow == nullptr) {
 350     ciEnv* env = CURRENT_ENV;
 351     _flow = new (env->arena()) ciTypeFlow(env, this);
 352     _flow->do_flow();
 353   }
 354   return _flow;
 355 #else // COMPILER2
 356   ShouldNotReachHere();
 357   return nullptr;
 358 #endif // COMPILER2
 359 }
 360 
 361 
 362 // ------------------------------------------------------------------
 363 // ciMethod::get_osr_flow_analysis
 364 ciTypeFlow* ciMethod::get_osr_flow_analysis(int osr_bci) {
 365 #if defined(COMPILER2)
 366   // OSR entry points are always place after a call bytecode of some sort
 367   assert(osr_bci >= 0, "must supply valid OSR entry point");
 368   ciEnv* env = CURRENT_ENV;
 369   ciTypeFlow* flow = new (env->arena()) ciTypeFlow(env, this, osr_bci);
 370   flow->do_flow();
 371   return flow;
 372 #else // COMPILER2
 373   ShouldNotReachHere();
 374   return nullptr;
 375 #endif // COMPILER2
 376 }
 377 
 378 // ------------------------------------------------------------------
 379 // ciMethod::raw_liveness_at_bci
 380 //
 381 // Which local variables are live at a specific bci?
 382 MethodLivenessResult ciMethod::raw_liveness_at_bci(int bci) {
 383   check_is_loaded();
 384   if (_liveness == nullptr) {
 385     // Create the liveness analyzer.
 386     Arena* arena = CURRENT_ENV->arena();
 387     _liveness = new (arena) MethodLiveness(arena, this);
 388     _liveness->compute_liveness();
 389   }
 390   return _liveness->get_liveness_at(bci);
 391 }
 392 
 393 // ------------------------------------------------------------------
 394 // ciMethod::liveness_at_bci
 395 //
 396 // Which local variables are live at a specific bci?  When debugging
 397 // will return true for all locals in some cases to improve debug
 398 // information.
 399 MethodLivenessResult ciMethod::liveness_at_bci(int bci) {
 400   if (CURRENT_ENV->should_retain_local_variables() || DeoptimizeALot) {
 401     // Keep all locals live for the user's edification and amusement.
 402     MethodLivenessResult result(_max_locals);
 403     result.set_range(0, _max_locals);
 404     result.set_is_valid();
 405     return result;
 406   }
 407   return raw_liveness_at_bci(bci);
 408 }
 409 
 410 // ciMethod::live_local_oops_at_bci
 411 //
 412 // find all the live oops in the locals array for a particular bci
 413 // Compute what the interpreter believes by using the interpreter
 414 // oopmap generator. This is used as a double check during osr to
 415 // guard against conservative result from MethodLiveness making us
 416 // think a dead oop is live.  MethodLiveness is conservative in the
 417 // sense that it may consider locals to be live which cannot be live,
 418 // like in the case where a local could contain an oop or  a primitive
 419 // along different paths.  In that case the local must be dead when
 420 // those paths merge. Since the interpreter's viewpoint is used when
 421 // gc'ing an interpreter frame we need to use its viewpoint  during
 422 // OSR when loading the locals.
 423 
 424 ResourceBitMap ciMethod::live_local_oops_at_bci(int bci) {
 425   VM_ENTRY_MARK;
 426   InterpreterOopMap mask;
 427   OopMapCache::compute_one_oop_map(methodHandle(THREAD, get_Method()), bci, &mask);
 428   int mask_size = max_locals();
 429   ResourceBitMap result(mask_size);
 430   int i;
 431   for (i = 0; i < mask_size ; i++ ) {
 432     if (mask.is_oop(i)) result.set_bit(i);
 433   }
 434   return result;
 435 }
 436 
 437 
 438 #ifdef COMPILER1
 439 // ------------------------------------------------------------------
 440 // ciMethod::bci_block_start
 441 //
 442 // Marks all bcis where a new basic block starts
 443 const BitMap& ciMethod::bci_block_start() {
 444   check_is_loaded();
 445   if (_liveness == nullptr) {
 446     // Create the liveness analyzer.
 447     Arena* arena = CURRENT_ENV->arena();
 448     _liveness = new (arena) MethodLiveness(arena, this);
 449     _liveness->compute_liveness();
 450   }
 451 
 452   return _liveness->get_bci_block_start();
 453 }
 454 #endif // COMPILER1
 455 
 456 
 457 // ------------------------------------------------------------------
 458 // ciMethod::check_overflow
 459 //
 460 // Check whether the profile counter is overflowed and adjust if true.
 461 // For invoke* it will turn negative values into max_jint,
 462 // and for checkcast/aastore/instanceof turn positive values into min_jint.
 463 int ciMethod::check_overflow(int c, Bytecodes::Code code) {
 464   switch (code) {
 465     case Bytecodes::_aastore:    // fall-through
 466     case Bytecodes::_checkcast:  // fall-through
 467     case Bytecodes::_instanceof: {
 468       if (VM_Version::profile_all_receivers_at_type_check()) {
 469         return (c < 0 ? max_jint : c); // always non-negative
 470       }
 471       return (c > 0 ? min_jint : c); // always non-positive
 472     }
 473     default: {
 474       assert(Bytecodes::is_invoke(code), "%s", Bytecodes::name(code));
 475       return (c < 0 ? max_jint : c); // always non-negative
 476     }
 477   }
 478 }
 479 
 480 
 481 // ------------------------------------------------------------------
 482 // ciMethod::call_profile_at_bci
 483 //
 484 // Get the ciCallProfile for the invocation of this method.
 485 // Also reports receiver types for non-call type checks (if TypeProfileCasts).
 486 ciCallProfile ciMethod::call_profile_at_bci(int bci) {
 487   ResourceMark rm;
 488   ciCallProfile result;
 489   if (method_data() != nullptr && method_data()->is_mature()) {
 490     ciProfileData* data = method_data()->bci_to_data(bci);
 491     if (data != nullptr && data->is_CounterData()) {
 492       // Every profiled call site has a counter.
 493       int count = check_overflow(data->as_CounterData()->count(), java_code_at_bci(bci));
 494 
 495       if (!data->is_ReceiverTypeData()) {
 496         result._receiver_count[0] = 0;  // that's a definite zero
 497       } else { // ReceiverTypeData is a subclass of CounterData
 498         ciReceiverTypeData* call = (ciReceiverTypeData*)data->as_ReceiverTypeData();
 499         // In addition, virtual call sites have receiver type information
 500         int receivers_count_total = 0;
 501         int morphism = 0;
 502         // Precompute morphism for the possible fixup
 503         for (uint i = 0; i < call->row_limit(); i++) {
 504           ciKlass* receiver = call->receiver(i);
 505           if (receiver == nullptr)  continue;
 506           morphism++;
 507         }
 508         int epsilon = 0;
 509         // For a call, it is assumed that either the type of the receiver(s)
 510         // is recorded or an associated counter is incremented, but not both. With
 511         // tiered compilation, however, both can happen due to the interpreter and
 512         // C1 profiling invocations differently. Address that inconsistency here.
 513         if (morphism == 1 && count > 0) {
 514           epsilon = count;
 515           count = 0;
 516         }
 517         for (uint i = 0; i < call->row_limit(); i++) {
 518           ciKlass* receiver = call->receiver(i);
 519           if (receiver == nullptr)  continue;
 520           int rcount = saturated_add(call->receiver_count(i), epsilon);
 521           if (rcount == 0) rcount = 1; // Should be valid value
 522           receivers_count_total = saturated_add(receivers_count_total, rcount);
 523           // Add the receiver to result data.
 524           result.add_receiver(receiver, rcount);
 525           // If we extend profiling to record methods,
 526           // we will set result._method also.
 527         }
 528         // Determine call site's morphism.
 529         // The call site count is 0 with known morphism (only 1 or 2 receivers)
 530         // or < 0 in the case of a type check failure for checkcast, aastore, instanceof.
 531         // The call site count is > 0 in the case of a polymorphic virtual call.
 532         if (morphism > 0 && morphism == result._limit) {
 533            // The morphism <= MorphismLimit.
 534            if ((morphism <  ciCallProfile::MorphismLimit) ||
 535                (morphism == ciCallProfile::MorphismLimit && count == 0)) {
 536 #ifdef ASSERT
 537              if (count > 0) {
 538                this->print_short_name(tty);
 539                tty->print_cr(" @ bci:%d", bci);
 540                this->print_codes();
 541                assert(false, "this call site should not be polymorphic");
 542              }
 543 #endif
 544              result._morphism = morphism;
 545            }
 546         }
 547         // Make the count consistent if this is a call profile. If count is
 548         // zero or less, presume that this is a typecheck profile and
 549         // do nothing.  Otherwise, increase count to be the sum of all
 550         // receiver's counts.
 551         if (count >= 0) {
 552           count = saturated_add(count, receivers_count_total);
 553         }
 554       }
 555       result._count = count;
 556     }
 557   }
 558   return result;
 559 }
 560 
 561 // ------------------------------------------------------------------
 562 // Add new receiver and sort data by receiver's profile count.
 563 void ciCallProfile::add_receiver(ciKlass* receiver, int receiver_count) {
 564   // Add new receiver and sort data by receiver's counts when we have space
 565   // for it otherwise replace the less called receiver (less called receiver
 566   // is placed to the last array element which is not used).
 567   // First array's element contains most called receiver.
 568   int i = _limit;
 569   for (; i > 0 && receiver_count > _receiver_count[i-1]; i--) {
 570     _receiver[i] = _receiver[i-1];
 571     _receiver_count[i] = _receiver_count[i-1];
 572   }
 573   _receiver[i] = receiver;
 574   _receiver_count[i] = receiver_count;
 575   if (_limit < MorphismLimit) _limit++;
 576 }
 577 
 578 
 579 void ciMethod::assert_virtual_call_type_ok(int bci) {
 580   assert(java_code_at_bci(bci) == Bytecodes::_invokevirtual ||
 581          java_code_at_bci(bci) == Bytecodes::_invokeinterface, "unexpected bytecode %s", Bytecodes::name(java_code_at_bci(bci)));
 582 }
 583 
 584 void ciMethod::assert_call_type_ok(int bci) {
 585   assert(java_code_at_bci(bci) == Bytecodes::_invokestatic ||
 586          java_code_at_bci(bci) == Bytecodes::_invokespecial ||
 587          java_code_at_bci(bci) == Bytecodes::_invokedynamic, "unexpected bytecode %s", Bytecodes::name(java_code_at_bci(bci)));
 588 }
 589 
 590 /**
 591  * Check whether profiling provides a type for the argument i to the
 592  * call at bci bci
 593  *
 594  * @param [in]bci         bci of the call
 595  * @param [in]i           argument number
 596  * @param [out]type       profiled type of argument, null if none
 597  * @param [out]ptr_kind   whether always null, never null or maybe null
 598  * @return                true if profiling exists
 599  *
 600  */
 601 bool ciMethod::argument_profiled_type(int bci, int i, ciKlass*& type, ProfilePtrKind& ptr_kind) {
 602   if (MethodData::profile_parameters() && method_data() != nullptr && method_data()->is_mature()) {
 603     ciProfileData* data = method_data()->bci_to_data(bci);
 604     if (data != nullptr) {
 605       if (data->is_VirtualCallTypeData()) {
 606         assert_virtual_call_type_ok(bci);
 607         ciVirtualCallTypeData* call = (ciVirtualCallTypeData*)data->as_VirtualCallTypeData();
 608         if (i >= call->number_of_arguments()) {
 609           return false;
 610         }
 611         type = call->valid_argument_type(i);
 612         ptr_kind = call->argument_ptr_kind(i);
 613         return true;
 614       } else if (data->is_CallTypeData()) {
 615         assert_call_type_ok(bci);
 616         ciCallTypeData* call = (ciCallTypeData*)data->as_CallTypeData();
 617         if (i >= call->number_of_arguments()) {
 618           return false;
 619         }
 620         type = call->valid_argument_type(i);
 621         ptr_kind = call->argument_ptr_kind(i);
 622         return true;
 623       }
 624     }
 625   }
 626   return false;
 627 }
 628 
 629 /**
 630  * Check whether profiling provides a type for the return value from
 631  * the call at bci bci
 632  *
 633  * @param [in]bci         bci of the call
 634  * @param [out]type       profiled type of argument, null if none
 635  * @param [out]ptr_kind   whether always null, never null or maybe null
 636  * @return                true if profiling exists
 637  *
 638  */
 639 bool ciMethod::return_profiled_type(int bci, ciKlass*& type, ProfilePtrKind& ptr_kind) {
 640   if (MethodData::profile_return() && method_data() != nullptr && method_data()->is_mature()) {
 641     ciProfileData* data = method_data()->bci_to_data(bci);
 642     if (data != nullptr) {
 643       if (data->is_VirtualCallTypeData()) {
 644         assert_virtual_call_type_ok(bci);
 645         ciVirtualCallTypeData* call = (ciVirtualCallTypeData*)data->as_VirtualCallTypeData();
 646         if (call->has_return()) {
 647           type = call->valid_return_type();
 648           ptr_kind = call->return_ptr_kind();
 649           return true;
 650         }
 651       } else if (data->is_CallTypeData()) {
 652         assert_call_type_ok(bci);
 653         ciCallTypeData* call = (ciCallTypeData*)data->as_CallTypeData();
 654         if (call->has_return()) {
 655           type = call->valid_return_type();
 656           ptr_kind = call->return_ptr_kind();
 657         }
 658         return true;
 659       }
 660     }
 661   }
 662   return false;
 663 }
 664 
 665 /**
 666  * Check whether profiling provides a type for the parameter i
 667  *
 668  * @param [in]i           parameter number
 669  * @param [out]type       profiled type of parameter, null if none
 670  * @param [out]ptr_kind   whether always null, never null or maybe null
 671  * @return                true if profiling exists
 672  *
 673  */
 674 bool ciMethod::parameter_profiled_type(int i, ciKlass*& type, ProfilePtrKind& ptr_kind) {
 675   if (MethodData::profile_parameters() && method_data() != nullptr && method_data()->is_mature()) {
 676     ciParametersTypeData* parameters = method_data()->parameters_type_data();
 677     if (parameters != nullptr && i < parameters->number_of_parameters()) {
 678       type = parameters->valid_parameter_type(i);
 679       ptr_kind = parameters->parameter_ptr_kind(i);
 680       return true;
 681     }
 682   }
 683   return false;
 684 }
 685 
 686 
 687 // ------------------------------------------------------------------
 688 // ciMethod::find_monomorphic_target
 689 //
 690 // Given a certain calling environment, find the monomorphic target
 691 // for the call.  Return null if the call is not monomorphic in
 692 // its calling environment, or if there are only abstract methods.
 693 // The returned method is never abstract.
 694 // Note: If caller uses a non-null result, it must inform dependencies
 695 // via assert_unique_concrete_method or assert_leaf_type.
 696 ciMethod* ciMethod::find_monomorphic_target(ciInstanceKlass* caller,
 697                                             ciInstanceKlass* callee_holder,
 698                                             ciInstanceKlass* actual_recv,
 699                                             bool check_access) {
 700   check_is_loaded();
 701 
 702   if (actual_recv->is_interface()) {
 703     // %%% We cannot trust interface types, yet.  See bug 6312651.
 704     return nullptr;
 705   }
 706 
 707   ciMethod* root_m = resolve_invoke(caller, actual_recv, check_access, true /* allow_abstract */);
 708   if (root_m == nullptr) {
 709     // Something went wrong looking up the actual receiver method.
 710     return nullptr;
 711   }
 712 
 713   // Make certain quick checks even if UseCHA is false.
 714 
 715   // Is it private or final?
 716   if (root_m->can_be_statically_bound()) {
 717     assert(!root_m->is_abstract(), "sanity");
 718     return root_m;
 719   }
 720 
 721   if (actual_recv->is_leaf_type() && actual_recv == root_m->holder()) {
 722     // Easy case.  There is no other place to put a method, so don't bother
 723     // to go through the VM_ENTRY_MARK and all the rest.
 724     if (root_m->is_abstract()) {
 725       return nullptr;
 726     }
 727     return root_m;
 728   }
 729 
 730   // Array methods (clone, hashCode, etc.) are always statically bound.
 731   // If we were to see an array type here, we'd return root_m.
 732   // However, this method processes only ciInstanceKlasses.  (See 4962591.)
 733   // The inline_native_clone intrinsic narrows Object to T[] properly,
 734   // so there is no need to do the same job here.
 735 
 736   if (!UseCHA)  return nullptr;
 737 
 738   VM_ENTRY_MARK;
 739 
 740   methodHandle target;
 741   {
 742     MutexLocker locker(Compile_lock);
 743     InstanceKlass* context = actual_recv->get_instanceKlass();
 744     target = methodHandle(THREAD, Dependencies::find_unique_concrete_method(context,
 745                                                                             root_m->get_Method(),
 746                                                                             callee_holder->get_Klass(),
 747                                                                             this->get_Method()));
 748     assert(target() == nullptr || !target()->is_abstract(), "not allowed");
 749     // %%% Should upgrade this ciMethod API to look for 1 or 2 concrete methods.
 750   }
 751 
 752 #ifndef PRODUCT
 753   LogTarget(Debug, dependencies) lt;
 754   if (lt.is_enabled() && target() != nullptr && target() != root_m->get_Method()) {
 755     LogStream ls(&lt);
 756     ls.print("found a non-root unique target method");
 757     ls.print_cr("  context = %s", actual_recv->get_Klass()->external_name());
 758     ls.print("  method  = ");
 759     target->print_short_name(&ls);
 760     ls.cr();
 761   }
 762 #endif //PRODUCT
 763 
 764   if (target() == nullptr) {
 765     return nullptr;
 766   }
 767 
 768   // Redefinition support.
 769   if (this->is_old() || root_m->is_old() || target->is_old()) {
 770     guarantee(CURRENT_THREAD_ENV->jvmti_state_changed(), "old method not detected");
 771     return nullptr;
 772   }
 773 
 774   if (target() == root_m->get_Method()) {
 775     return root_m;
 776   }
 777   if (!root_m->is_public() &&
 778       !root_m->is_protected()) {
 779     // If we are going to reason about inheritance, it's easiest
 780     // if the method in question is public, protected, or private.
 781     // If the answer is not root_m, it is conservatively correct
 782     // to return null, even if the CHA encountered irrelevant
 783     // methods in other packages.
 784     // %%% TO DO: Work out logic for package-private methods
 785     // with the same name but different vtable indexes.
 786     return nullptr;
 787   }
 788   return CURRENT_THREAD_ENV->get_method(target());
 789 }
 790 
 791 // ------------------------------------------------------------------
 792 // ciMethod::can_be_statically_bound
 793 //
 794 // Tries to determine whether a method can be statically bound in some context.
 795 bool ciMethod::can_be_statically_bound(ciInstanceKlass* context) const {
 796   return (holder() == context) && can_be_statically_bound();
 797 }
 798 
 799 // ------------------------------------------------------------------
 800 // ciMethod::can_omit_stack_trace
 801 //
 802 // Tries to determine whether a method can omit stack trace in throw in compiled code.
 803 bool ciMethod::can_omit_stack_trace() const {
 804   if (!StackTraceInThrowable) {
 805     return true; // stack trace is switched off.
 806   }
 807   if (!OmitStackTraceInFastThrow) {
 808     return false; // Have to provide stack trace.
 809   }
 810   return _can_omit_stack_trace;
 811 }
 812 
 813 // ------------------------------------------------------------------
 814 // ciMethod::resolve_invoke
 815 //
 816 // Given a known receiver klass, find the target for the call.
 817 // Return null if the call has no target or the target is abstract.
 818 ciMethod* ciMethod::resolve_invoke(ciKlass* caller, ciKlass* exact_receiver, bool check_access, bool allow_abstract) {
 819   check_is_loaded();
 820   VM_ENTRY_MARK;
 821 
 822   Klass* caller_klass = caller->get_Klass();
 823   Klass* recv         = exact_receiver->get_Klass();
 824   Klass* resolved     = holder()->get_Klass();
 825   Symbol* h_name      = name()->get_symbol();
 826   Symbol* h_signature = signature()->get_symbol();
 827 
 828   LinkInfo link_info(resolved, h_name, h_signature, caller_klass,
 829                      check_access ? LinkInfo::AccessCheck::required : LinkInfo::AccessCheck::skip,
 830                      check_access ? LinkInfo::LoaderConstraintCheck::required : LinkInfo::LoaderConstraintCheck::skip);
 831   Method* m = nullptr;
 832   // Only do exact lookup if receiver klass has been linked.  Otherwise,
 833   // the vtable has not been setup, and the LinkResolver will fail.
 834   if (recv->is_array_klass()
 835        ||
 836       (InstanceKlass::cast(recv)->is_linked() && !exact_receiver->is_interface())) {
 837     if (holder()->is_interface()) {
 838       m = LinkResolver::resolve_interface_call_or_null(recv, link_info);
 839     } else {
 840       m = LinkResolver::resolve_virtual_call_or_null(recv, link_info);
 841     }
 842   }
 843 
 844   if (m == nullptr) {
 845     // Return null only if there was a problem with lookup (uninitialized class, etc.)
 846     return nullptr;
 847   }
 848 
 849   ciMethod* result = this;
 850   if (m != get_Method()) {
 851     // Redefinition support.
 852     if (this->is_old() || m->is_old()) {
 853       guarantee(CURRENT_THREAD_ENV->jvmti_state_changed(), "old method not detected");
 854       return nullptr;
 855     }
 856 
 857     result = CURRENT_THREAD_ENV->get_method(m);
 858   }
 859 
 860   if (result->is_abstract() && !allow_abstract) {
 861     // Don't return abstract methods because they aren't optimizable or interesting.
 862     return nullptr;
 863   }
 864   return result;
 865 }
 866 
 867 // ------------------------------------------------------------------
 868 // ciMethod::resolve_vtable_index
 869 //
 870 // Given a known receiver klass, find the vtable index for the call.
 871 // Return Method::invalid_vtable_index if the vtable_index is unknown.
 872 int ciMethod::resolve_vtable_index(ciKlass* caller, ciKlass* receiver) {
 873    check_is_loaded();
 874 
 875    int vtable_index = Method::invalid_vtable_index;
 876    // Only do lookup if receiver klass has been linked.  Otherwise,
 877    // the vtable has not been setup, and the LinkResolver will fail.
 878    if (!receiver->is_interface()
 879        && (!receiver->is_instance_klass() ||
 880            receiver->as_instance_klass()->is_linked())) {
 881      VM_ENTRY_MARK;
 882 
 883      Klass* caller_klass = caller->get_Klass();
 884      Klass* recv         = receiver->get_Klass();
 885      Symbol* h_name = name()->get_symbol();
 886      Symbol* h_signature = signature()->get_symbol();
 887 
 888      LinkInfo link_info(recv, h_name, h_signature, caller_klass);
 889      vtable_index = LinkResolver::resolve_virtual_vtable_index(recv, link_info);
 890      if (vtable_index == Method::nonvirtual_vtable_index) {
 891        // A statically bound method.  Return "no such index".
 892        vtable_index = Method::invalid_vtable_index;
 893      }
 894    }
 895 
 896    return vtable_index;
 897 }
 898 
 899 // ------------------------------------------------------------------
 900 // ciMethod::get_field_at_bci
 901 ciField* ciMethod::get_field_at_bci(int bci, bool &will_link) {
 902   ciBytecodeStream iter(this);
 903   iter.reset_to_bci(bci);
 904   iter.next();
 905   return iter.get_field(will_link);
 906 }
 907 
 908 // ------------------------------------------------------------------
 909 // ciMethod::get_method_at_bci
 910 ciMethod* ciMethod::get_method_at_bci(int bci, bool &will_link, ciSignature* *declared_signature) {
 911   ciBytecodeStream iter(this);
 912   iter.reset_to_bci(bci);
 913   iter.next();
 914   return iter.get_method(will_link, declared_signature);
 915 }
 916 
 917 // ------------------------------------------------------------------
 918 ciKlass* ciMethod::get_declared_method_holder_at_bci(int bci) {
 919   ciBytecodeStream iter(this);
 920   iter.reset_to_bci(bci);
 921   iter.next();
 922   return iter.get_declared_method_holder();
 923 }
 924 
 925 // ------------------------------------------------------------------
 926 // Adjust a CounterData count to be commensurate with
 927 // interpreter_invocation_count.  If the MDO exists for
 928 // only 25% of the time the method exists, then the
 929 // counts in the MDO should be scaled by 4X, so that
 930 // they can be usefully and stably compared against the
 931 // invocation counts in methods.
 932 int ciMethod::scale_count(int count, float prof_factor) {
 933   if (count > 0 && method_data() != nullptr) {
 934     int counter_life = method_data()->invocation_count();
 935     int method_life = interpreter_invocation_count();
 936     if (method_life < counter_life) { // may happen because of the snapshot timing
 937       method_life = counter_life;
 938     }
 939     if (counter_life > 0) {
 940       double count_d = (double)count * prof_factor * method_life / counter_life + 0.5;
 941       if (count_d >= static_cast<double>(INT_MAX)) {
 942         // Clamp in case of overflowing int range.
 943         count = INT_MAX;
 944       } else {
 945         count = int(count_d);
 946         count = (count > 0) ? count : 1;
 947       }
 948     } else {
 949       count = 1;
 950     }
 951   }
 952   return count;
 953 }
 954 
 955 
 956 // ------------------------------------------------------------------
 957 // ciMethod::is_special_get_caller_class_method
 958 //
 959 bool ciMethod::is_ignored_by_security_stack_walk() const {
 960   check_is_loaded();
 961   VM_ENTRY_MARK;
 962   return get_Method()->is_ignored_by_security_stack_walk();
 963 }
 964 
 965 // ------------------------------------------------------------------
 966 // ciMethod::needs_clinit_barrier
 967 //
 968 bool ciMethod::needs_clinit_barrier() const {
 969   check_is_loaded();
 970   return is_static() && !holder()->is_initialized();
 971 }
 972 
 973 // ------------------------------------------------------------------
 974 // invokedynamic support
 975 
 976 // ------------------------------------------------------------------
 977 // ciMethod::is_method_handle_intrinsic
 978 //
 979 // Return true if the method is an instance of the JVM-generated
 980 // signature-polymorphic MethodHandle methods, _invokeBasic, _linkToVirtual, etc.
 981 bool ciMethod::is_method_handle_intrinsic() const {
 982   vmIntrinsics::ID iid = _intrinsic_id;  // do not check if loaded
 983   return (MethodHandles::is_signature_polymorphic(iid) &&
 984           MethodHandles::is_signature_polymorphic_intrinsic(iid));
 985 }
 986 
 987 // ------------------------------------------------------------------
 988 // ciMethod::is_compiled_lambda_form
 989 //
 990 // Return true if the method is a generated MethodHandle adapter.
 991 // These are built by Java code.
 992 bool ciMethod::is_compiled_lambda_form() const {
 993   vmIntrinsics::ID iid = _intrinsic_id;  // do not check if loaded
 994   return iid == vmIntrinsics::_compiledLambdaForm;
 995 }
 996 
 997 // ------------------------------------------------------------------
 998 // ciMethod::is_object_initializer
 999 //
1000 bool ciMethod::is_object_initializer() const {
1001    return name() == ciSymbols::object_initializer_name();
1002 }
1003 
1004 // ------------------------------------------------------------------
1005 // ciMethod::is_scoped
1006 //
1007 // Return true for methods annotated with @Scoped
1008 bool ciMethod::is_scoped() const {
1009    return get_Method()->is_scoped();
1010 }
1011 
1012 // ------------------------------------------------------------------
1013 // ciMethod::has_member_arg
1014 //
1015 // Return true if the method is a linker intrinsic like _linkToVirtual.
1016 // These are built by the JVM.
1017 bool ciMethod::has_member_arg() const {
1018   vmIntrinsics::ID iid = _intrinsic_id;  // do not check if loaded
1019   return (MethodHandles::is_signature_polymorphic(iid) &&
1020           MethodHandles::has_member_arg(iid));
1021 }
1022 
1023 // ------------------------------------------------------------------
1024 // ciMethod::ensure_method_data
1025 //
1026 // Generate new MethodData* objects at compile time.
1027 // Return true if allocation was successful or no MDO is required.
1028 bool ciMethod::ensure_method_data(const methodHandle& h_m, bool training_data_only) {
1029   EXCEPTION_CONTEXT;
1030   if (is_native() || is_abstract() || h_m()->is_accessor()) {
1031     return true;
1032   }
1033   if (h_m()->method_data() == nullptr) {
1034     if (training_data_only) {
1035       Method::install_training_method_data(h_m);
1036     } else {
1037       Method::build_profiling_method_data(h_m, THREAD);
1038       if (HAS_PENDING_EXCEPTION) {
1039         CLEAR_PENDING_EXCEPTION;
1040       }
1041     }
1042   }
1043   if (h_m()->method_data() != nullptr) {
1044     _method_data = CURRENT_ENV->get_method_data(h_m()->method_data());
1045     return _method_data->load_data();
1046   } else {
1047     _method_data = CURRENT_ENV->get_empty_methodData();
1048     return false;
1049   }
1050 }
1051 
1052 // public, retroactive version
1053 bool ciMethod::ensure_method_data(bool training_data_only) {
1054   bool result = true;
1055   if (_method_data == nullptr || _method_data->is_empty()) {
1056     GUARDED_VM_ENTRY({
1057       methodHandle mh(Thread::current(), get_Method());
1058       result = ensure_method_data(mh, training_data_only);
1059     });
1060   }
1061   return result;
1062 }
1063 
1064 
1065 // ------------------------------------------------------------------
1066 // ciMethod::method_data
1067 //
1068 ciMethodData* ciMethod::method_data() {
1069   if (CURRENT_ENV->task()->is_aot_compile() && CURRENT_ENV->task()->comp_level() == CompLevel_full_optimization) {
1070     if (_method_data_recorded == nullptr) {
1071       VM_ENTRY_MARK;
1072       methodHandle h_m(thread, get_Method());
1073       MethodTrainingData* mtd = MethodTrainingData::find(h_m);
1074       MethodData* mdo = (mtd != nullptr ? mtd->final_profile() : nullptr);
1075       DirectiveSet* directives = DirectivesStack::getMatchingDirective(h_m, CURRENT_ENV->task()->compiler());
1076       int comp_id = CURRENT_ENV->task()->compile_id();
1077       if (mdo == nullptr || directives->IgnoreRecordedProfileOption) {
1078         if (directives->IgnoreRecordedProfileOption) {
1079           ResourceMark rm;
1080           log_debug(aot, compilation)("%d: Ignore recorded profile for %s", comp_id, h_m->name_and_sig_as_C_string());
1081         } else {
1082           ResourceMark rm;
1083           log_debug(aot, compilation)("%d: No profile for %s", comp_id, h_m->name_and_sig_as_C_string());
1084         }
1085         _method_data_recorded = CURRENT_ENV->get_empty_methodData();
1086       } else {
1087 #if INCLUDE_CDS
1088         if (mdo->extra_data_lock() == nullptr) {
1089           assert(!HAS_PENDING_EXCEPTION, "");
1090           mdo->restore_unshareable_info(thread);
1091           assert(!HAS_PENDING_EXCEPTION, "");
1092         }
1093 #endif
1094         _method_data_recorded = CURRENT_ENV->get_method_data(mdo);
1095         _method_data_recorded->load_data();
1096         {
1097           ResourceMark rm;
1098           log_debug(aot, compilation)("%d: Recorded profile " PTR_FORMAT " for %s", comp_id, p2i(mdo), h_m->name_and_sig_as_C_string());
1099         }
1100       }
1101     }
1102     assert(_method_data_recorded != nullptr, "");
1103     return _method_data_recorded;
1104   } else {
1105     if (_method_data != nullptr) {
1106       return _method_data;
1107     }
1108     VM_ENTRY_MARK;
1109     methodHandle h_m(thread, get_Method());
1110     MethodData* mdo = h_m()->method_data();
1111     if (mdo != nullptr) {
1112       _method_data = CURRENT_ENV->get_method_data(mdo);
1113       _method_data->load_data();
1114     } else {
1115       _method_data = CURRENT_ENV->get_empty_methodData();
1116     }
1117     return _method_data;
1118   }
1119 }
1120 
1121 // ------------------------------------------------------------------
1122 // ciMethod::method_data_or_null
1123 // Returns a pointer to ciMethodData if MDO exists on the VM side,
1124 // null otherwise.
1125 ciMethodData* ciMethod::method_data_or_null() {
1126   ciMethodData *md = method_data();
1127   if (md->is_empty()) {
1128     return nullptr;
1129   }
1130   return md;
1131 }
1132 
1133 // ------------------------------------------------------------------
1134 // ciMethod::ensure_method_counters
1135 //
1136 ciMetadata* ciMethod::ensure_method_counters() {
1137   check_is_loaded();
1138   VM_ENTRY_MARK;
1139   methodHandle mh(THREAD, get_Method());
1140   MethodCounters* method_counters = mh->get_method_counters(THREAD);
1141   if (method_counters != nullptr) {
1142     return CURRENT_ENV->get_method_counters(method_counters);
1143   }
1144   return nullptr;
1145 }
1146 
1147 // ------------------------------------------------------------------
1148 // ciMethod::has_option
1149 //
1150 bool ciMethod::has_option(CompileCommandEnum option) {
1151   check_is_loaded();
1152   VM_ENTRY_MARK;
1153   methodHandle mh(THREAD, get_Method());
1154   return CompilerOracle::has_option(mh, option);
1155 }
1156 
1157 // ------------------------------------------------------------------
1158 // ciMethod::has_option_value
1159 //
1160 bool ciMethod::has_option_value(CompileCommandEnum option, double& value) {
1161   check_is_loaded();
1162   VM_ENTRY_MARK;
1163   methodHandle mh(THREAD, get_Method());
1164   return CompilerOracle::has_option_value(mh, option, value);
1165 }
1166 // ------------------------------------------------------------------
1167 // ciMethod::can_be_compiled
1168 //
1169 // Have previous compilations of this method succeeded?
1170 bool ciMethod::can_be_compiled() {
1171   check_is_loaded();
1172   ciEnv* env = CURRENT_ENV;
1173   if (is_c1_compile(env->comp_level())) {
1174     return _is_c1_compilable;
1175   }
1176 
1177   return _is_c2_compilable;
1178 }
1179 
1180 // ------------------------------------------------------------------
1181 // ciMethod::has_compiled_code
1182 bool ciMethod::has_compiled_code() {
1183   return inline_instructions_size() > 0;
1184 }
1185 
1186 int ciMethod::highest_osr_comp_level() {
1187   check_is_loaded();
1188   VM_ENTRY_MARK;
1189   return get_Method()->highest_osr_comp_level();
1190 }
1191 
1192 // ------------------------------------------------------------------
1193 // ciMethod::code_size_for_inlining
1194 //
1195 // Code size for inlining decisions.  This method returns a code
1196 // size of 1 for methods which has the ForceInline annotation.
1197 int ciMethod::code_size_for_inlining() {
1198   check_is_loaded();
1199   if (get_Method()->force_inline()) {
1200     return 1;
1201   }
1202   return code_size();
1203 }
1204 
1205 // ------------------------------------------------------------------
1206 // ciMethod::inline_instructions_size
1207 //
1208 // This is a rough metric for "fat" methods, compared before inlining
1209 // with InlineSmallCode.  The CodeBlob::code_size accessor includes
1210 // junk like exception handler, stubs, and constant table, which are
1211 // not highly relevant to an inlined method.  So we use the more
1212 // specific accessor nmethod::insts_size.
1213 // Also some instructions inside the code are excluded from inline
1214 // heuristic (e.g. post call nop instructions; see InlineSkippedInstructionsCounter)
1215 int ciMethod::inline_instructions_size() {
1216   if (_inline_instructions_size == -1) {
1217     if (TrainingData::have_data()) {
1218       GUARDED_VM_ENTRY(
1219         CompLevel level = static_cast<CompLevel>(CURRENT_ENV->task()->comp_level());
1220         methodHandle top_level_mh(Thread::current(), CURRENT_ENV->task()->method());
1221         MethodTrainingData* mtd = MethodTrainingData::find(top_level_mh);
1222         if (mtd != nullptr) {
1223           CompileTrainingData* ctd = mtd->compile_data_for_aot_code(level);
1224           if (ctd != nullptr) {
1225             methodHandle mh(Thread::current(), get_Method());
1226             MethodTrainingData* this_mtd = MethodTrainingData::find(mh);
1227             if (this_mtd != nullptr) {
1228               auto r = ctd->ci_records().ciMethod__inline_instructions_size.find(this_mtd);
1229               if (r.is_valid()) {
1230                 _inline_instructions_size = r.result();
1231               }
1232             }
1233           }
1234         }
1235       );
1236     }
1237   }
1238   if (_inline_instructions_size == -1) {
1239     GUARDED_VM_ENTRY(
1240       nmethod* code = get_Method()->code();
1241       if (code != nullptr && (code->comp_level() == CompLevel_full_optimization)) {
1242         int isize = code->is_aot() ? code->aot_code_entry()->inline_instructions_size()
1243                                    : code->inline_instructions_size();
1244         _inline_instructions_size = isize > 0 ? isize : 0;
1245       } else {
1246         _inline_instructions_size = 0;
1247       }
1248       if (TrainingData::need_data()) {
1249         CompileTrainingData* ctd = CURRENT_ENV->task()->training_data();
1250         if (ctd != nullptr) {
1251           methodHandle mh(Thread::current(), get_Method());
1252           MethodTrainingData* this_mtd = MethodTrainingData::make(mh);
1253           ctd->ci_records().ciMethod__inline_instructions_size.append_if_missing(_inline_instructions_size, this_mtd);
1254         }
1255       }
1256     );
1257   }
1258   return _inline_instructions_size;
1259 }
1260 
1261 // ------------------------------------------------------------------
1262 // ciMethod::log_nmethod_identity
1263 void ciMethod::log_nmethod_identity(xmlStream* log) {
1264   GUARDED_VM_ENTRY(
1265     nmethod* code = get_Method()->code();
1266     if (code != nullptr) {
1267       code->log_identity(log);
1268     }
1269   )
1270 }
1271 
1272 // ------------------------------------------------------------------
1273 // ciMethod::is_not_reached
1274 bool ciMethod::is_not_reached(int bci) {
1275   check_is_loaded();
1276   VM_ENTRY_MARK;
1277   return Interpreter::is_not_reached(
1278                methodHandle(THREAD, get_Method()), bci);
1279 }
1280 
1281 // ------------------------------------------------------------------
1282 // ciMethod::was_never_executed
1283 bool ciMethod::was_executed_more_than(int times) {
1284   // Invocation counter is reset when the Method* is compiled.
1285   // If the method has compiled code we therefore assume it has
1286   // be executed more than n times.
1287   if (is_accessor() || is_empty() || has_compiled_code()) {
1288     // interpreter doesn't bump invocation counter of trivial methods
1289     // compiler does not bump invocation counter of compiled methods
1290     return true;
1291   }
1292   if (!method_data()->is_empty()) {
1293     return (method_data()->invocation_count() > times);
1294   }
1295   VM_ENTRY_MARK;
1296   return get_Method()->was_executed_more_than(times);
1297 }
1298 
1299 // ------------------------------------------------------------------
1300 // ciMethod::has_unloaded_classes_in_signature
1301 bool ciMethod::has_unloaded_classes_in_signature() {
1302   // ciSignature is resolved against some accessing class and
1303   // signature classes aren't required to be local. As a benefit,
1304   // it makes signature classes visible through loader constraints.
1305   // So, encountering an unloaded class signals it is absent both in
1306   // the callee (local) and caller contexts.
1307   return signature()->has_unloaded_classes();
1308 }
1309 
1310 // ------------------------------------------------------------------
1311 // ciMethod::is_klass_loaded
1312 bool ciMethod::is_klass_loaded(int refinfo_index, Bytecodes::Code bc, bool must_be_resolved) const {
1313   VM_ENTRY_MARK;
1314   return get_Method()->is_klass_loaded(refinfo_index, bc, must_be_resolved);
1315 }
1316 
1317 // ------------------------------------------------------------------
1318 // ciMethod::check_call
1319 bool ciMethod::check_call(int refinfo_index, bool is_static) const {
1320   // This method is used only in C2 from InlineTree::ok_to_inline,
1321   // and is only used under -Xcomp.
1322   // It appears to fail when applied to an invokeinterface call site.
1323   // FIXME: Remove this method and resolve_method_statically; refactor to use the other LinkResolver entry points.
1324   VM_ENTRY_MARK;
1325   {
1326     ExceptionMark em(THREAD);
1327     HandleMark hm(THREAD);
1328     constantPoolHandle pool (THREAD, get_Method()->constants());
1329     Bytecodes::Code code = (is_static ? Bytecodes::_invokestatic : Bytecodes::_invokevirtual);
1330     Method* spec_method = LinkResolver::resolve_method_statically(code, pool, refinfo_index, THREAD);
1331     if (HAS_PENDING_EXCEPTION) {
1332       CLEAR_PENDING_EXCEPTION;
1333       return false;
1334     } else {
1335       return (spec_method->is_static() == is_static);
1336     }
1337   }
1338   return false;
1339 }
1340 // ------------------------------------------------------------------
1341 // ciMethod::print_codes
1342 //
1343 // Print the bytecodes for this method.
1344 void ciMethod::print_codes_on(outputStream* st) {
1345   check_is_loaded();
1346   GUARDED_VM_ENTRY(get_Method()->print_codes_on(st);)
1347 }
1348 
1349 
1350 #define FETCH_FLAG_FROM_VM(flag_accessor) { \
1351   check_is_loaded(); \
1352   VM_ENTRY_MARK; \
1353   return get_Method()->flag_accessor(); \
1354 }
1355 
1356 bool ciMethod::has_loops      () const {         FETCH_FLAG_FROM_VM(has_loops); }
1357 bool ciMethod::has_jsrs       () const {         FETCH_FLAG_FROM_VM(has_jsrs);  }
1358 bool ciMethod::is_getter      () const {         FETCH_FLAG_FROM_VM(is_getter); }
1359 bool ciMethod::is_setter      () const {         FETCH_FLAG_FROM_VM(is_setter); }
1360 bool ciMethod::is_accessor    () const {         FETCH_FLAG_FROM_VM(is_accessor); }
1361 bool ciMethod::is_empty       () const {         FETCH_FLAG_FROM_VM(is_empty_method); }
1362 
1363 bool ciMethod::is_boxing_method() const {
1364   if (intrinsic_id() != vmIntrinsics::_none && holder()->is_box_klass()) {
1365     switch (intrinsic_id()) {
1366       case vmIntrinsics::_Boolean_valueOf:
1367       case vmIntrinsics::_Byte_valueOf:
1368       case vmIntrinsics::_Character_valueOf:
1369       case vmIntrinsics::_Short_valueOf:
1370       case vmIntrinsics::_Integer_valueOf:
1371       case vmIntrinsics::_Long_valueOf:
1372       case vmIntrinsics::_Float_valueOf:
1373       case vmIntrinsics::_Double_valueOf:
1374         return true;
1375       default:
1376         return false;
1377     }
1378   }
1379   return false;
1380 }
1381 
1382 bool ciMethod::is_unboxing_method() const {
1383   if (intrinsic_id() != vmIntrinsics::_none && holder()->is_box_klass()) {
1384     switch (intrinsic_id()) {
1385       case vmIntrinsics::_booleanValue:
1386       case vmIntrinsics::_byteValue:
1387       case vmIntrinsics::_charValue:
1388       case vmIntrinsics::_shortValue:
1389       case vmIntrinsics::_intValue:
1390       case vmIntrinsics::_longValue:
1391       case vmIntrinsics::_floatValue:
1392       case vmIntrinsics::_doubleValue:
1393         return true;
1394       default:
1395         return false;
1396     }
1397   }
1398   return false;
1399 }
1400 
1401 bool ciMethod::is_vector_method() const {
1402   return (holder() == ciEnv::current()->vector_VectorSupport_klass()) &&
1403          (intrinsic_id() != vmIntrinsics::_none);
1404 }
1405 
1406 BCEscapeAnalyzer  *ciMethod::get_bcea() {
1407 #ifdef COMPILER2
1408   if (_bcea == nullptr) {
1409     _bcea = new (CURRENT_ENV->arena()) BCEscapeAnalyzer(this, nullptr);
1410   }
1411   return _bcea;
1412 #else // COMPILER2
1413   ShouldNotReachHere();
1414   return nullptr;
1415 #endif // COMPILER2
1416 }
1417 
1418 ciMethodBlocks  *ciMethod::get_method_blocks() {
1419   if (_method_blocks == nullptr) {
1420     Arena *arena = CURRENT_ENV->arena();
1421     _method_blocks = new (arena) ciMethodBlocks(arena, this);
1422   }
1423   return _method_blocks;
1424 }
1425 
1426 #undef FETCH_FLAG_FROM_VM
1427 
1428 void ciMethod::dump_name_as_ascii(outputStream* st, Method* method) {
1429   st->print("%s %s %s",
1430             CURRENT_ENV->replay_name(method->method_holder()),
1431             method->name()->as_quoted_ascii(),
1432             method->signature()->as_quoted_ascii());
1433 }
1434 
1435 void ciMethod::dump_name_as_ascii(outputStream* st) {
1436   Method* method = get_Method();
1437   dump_name_as_ascii(st, method);
1438 }
1439 
1440 void ciMethod::dump_replay_data(outputStream* st) {
1441   ResourceMark rm;
1442   Method* method = get_Method();
1443   if (MethodHandles::is_signature_polymorphic_method(method)) {
1444     // ignore for now
1445     return;
1446   }
1447   MethodCounters* mcs = method->method_counters();
1448   st->print("ciMethod ");
1449   dump_name_as_ascii(st);
1450   st->print_cr(" %d %d %d %d %d",
1451                mcs == nullptr ? 0 : mcs->invocation_counter()->raw_counter(),
1452                mcs == nullptr ? 0 : mcs->backedge_counter()->raw_counter(),
1453                interpreter_invocation_count(),
1454                interpreter_throwout_count(),
1455                _inline_instructions_size);
1456 }
1457 
1458 // ------------------------------------------------------------------
1459 // ciMethod::print_codes
1460 //
1461 // Print a range of the bytecodes for this method.
1462 void ciMethod::print_codes_on(int from, int to, outputStream* st) {
1463   check_is_loaded();
1464   GUARDED_VM_ENTRY(get_Method()->print_codes_on(from, to, st);)
1465 }
1466 
1467 // ------------------------------------------------------------------
1468 // ciMethod::print_name
1469 //
1470 // Print the name of this method, including signature and some flags.
1471 void ciMethod::print_name(outputStream* st) {
1472   check_is_loaded();
1473   GUARDED_VM_ENTRY(get_Method()->print_name(st);)
1474 }
1475 
1476 // ------------------------------------------------------------------
1477 // ciMethod::print_short_name
1478 //
1479 // Print the name of this method, without signature.
1480 void ciMethod::print_short_name(outputStream* st) {
1481   if (is_loaded()) {
1482     GUARDED_VM_ENTRY(get_Method()->print_short_name(st););
1483   } else {
1484     // Fall back if method is not loaded.
1485     holder()->print_name_on(st);
1486     st->print("::");
1487     name()->print_symbol_on(st);
1488     if (WizardMode)
1489       signature()->as_symbol()->print_symbol_on(st);
1490   }
1491 }
1492 
1493 // ------------------------------------------------------------------
1494 // ciMethod::print_impl
1495 //
1496 // Implementation of the print method.
1497 void ciMethod::print_impl(outputStream* st) {
1498   ciMetadata::print_impl(st);
1499   st->print(" name=");
1500   name()->print_symbol_on(st);
1501   st->print(" holder=");
1502   holder()->print_name_on(st);
1503   st->print(" signature=");
1504   signature()->as_symbol()->print_symbol_on(st);
1505   if (is_loaded()) {
1506     st->print(" loaded=true");
1507     st->print(" arg_size=%d", arg_size());
1508     st->print(" flags=");
1509     flags().print_member_flags(st);
1510   } else {
1511     st->print(" loaded=false");
1512   }
1513 }
1514 
1515 // ------------------------------------------------------------------
1516 
1517 static BasicType erase_to_word_type(BasicType bt) {
1518   if (is_subword_type(bt))   return T_INT;
1519   if (is_reference_type(bt)) return T_OBJECT;
1520   return bt;
1521 }
1522 
1523 static bool basic_types_match(ciType* t1, ciType* t2) {
1524   if (t1 == t2)  return true;
1525   return erase_to_word_type(t1->basic_type()) == erase_to_word_type(t2->basic_type());
1526 }
1527 
1528 bool ciMethod::is_consistent_info(ciMethod* declared_method, ciMethod* resolved_method) {
1529   bool invoke_through_mh_intrinsic = declared_method->is_method_handle_intrinsic() &&
1530                                   !resolved_method->is_method_handle_intrinsic();
1531 
1532   if (!invoke_through_mh_intrinsic) {
1533     // Method name & descriptor should stay the same.
1534     // Signatures may reference unloaded types and thus they may be not strictly equal.
1535     ciSymbol* declared_signature = declared_method->signature()->as_symbol();
1536     ciSymbol* resolved_signature = resolved_method->signature()->as_symbol();
1537 
1538     return (declared_method->name()->equals(resolved_method->name())) &&
1539            (declared_signature->equals(resolved_signature));
1540   }
1541 
1542   ciMethod* linker = declared_method;
1543   ciMethod* target = resolved_method;
1544   // Linkers have appendix argument which is not passed to callee.
1545   int has_appendix = MethodHandles::has_member_arg(linker->intrinsic_id()) ? 1 : 0;
1546   if (linker->arg_size() != (target->arg_size() + has_appendix)) {
1547     return false; // argument slot count mismatch
1548   }
1549 
1550   ciSignature* linker_sig = linker->signature();
1551   ciSignature* target_sig = target->signature();
1552 
1553   if (linker_sig->count() + (linker->is_static() ? 0 : 1) !=
1554       target_sig->count() + (target->is_static() ? 0 : 1) + has_appendix) {
1555     return false; // argument count mismatch
1556   }
1557 
1558   int sbase = 0, rbase = 0;
1559   switch (linker->intrinsic_id()) {
1560     case vmIntrinsics::_linkToVirtual:
1561     case vmIntrinsics::_linkToInterface:
1562     case vmIntrinsics::_linkToSpecial: {
1563       if (target->is_static()) {
1564         return false;
1565       }
1566       if (linker_sig->type_at(0)->is_primitive_type()) {
1567         return false;  // receiver should be an oop
1568       }
1569       sbase = 1; // skip receiver
1570       break;
1571     }
1572     case vmIntrinsics::_linkToStatic: {
1573       if (!target->is_static()) {
1574         return false;
1575       }
1576       break;
1577     }
1578     case vmIntrinsics::_invokeBasic: {
1579       if (target->is_static()) {
1580         if (target_sig->type_at(0)->is_primitive_type()) {
1581           return false; // receiver should be an oop
1582         }
1583         rbase = 1; // skip receiver
1584       }
1585       break;
1586     }
1587     default:
1588       break;
1589   }
1590   assert(target_sig->count() - rbase == linker_sig->count() - sbase - has_appendix, "argument count mismatch");
1591   int arg_count = target_sig->count() - rbase;
1592   for (int i = 0; i < arg_count; i++) {
1593     if (!basic_types_match(linker_sig->type_at(sbase + i), target_sig->type_at(rbase + i))) {
1594       return false;
1595     }
1596   }
1597   // Only check the return type if the symbolic info has non-void return type.
1598   // I.e. the return value of the resolved method can be dropped.
1599   if (!linker->return_type()->is_void() &&
1600       !basic_types_match(linker->return_type(), target->return_type())) {
1601     return false;
1602   }
1603   return true; // no mismatch found
1604 }
1605 
1606 // ------------------------------------------------------------------
1607 // ciMethod::is_old
1608 //
1609 // Return true for redefined methods
1610 bool ciMethod::is_old() const {
1611   ASSERT_IN_VM;
1612   return get_Method()->is_old();
1613 }