1 /* 2 * Copyright (c) 1999, 2024, 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 #ifndef SHARE_CI_CIMETHOD_HPP 26 #define SHARE_CI_CIMETHOD_HPP 27 28 #include "ci/ciFlags.hpp" 29 #include "ci/ciInstanceKlass.hpp" 30 #include "ci/ciObject.hpp" 31 #include "ci/ciSignature.hpp" 32 #include "classfile/vmIntrinsics.hpp" 33 #include "compiler/methodLiveness.hpp" 34 #include "oops/method.hpp" 35 #include "runtime/handles.hpp" 36 #include "utilities/bitMap.hpp" 37 #include "utilities/vmEnums.hpp" 38 39 class ciMethodBlocks; 40 class MethodLiveness; 41 class Arena; 42 class BCEscapeAnalyzer; 43 class InlineTree; 44 class xmlStream; 45 46 // Whether profiling found an oop to be always, never or sometimes 47 // null 48 enum ProfilePtrKind { 49 ProfileUnknownNull, 50 ProfileAlwaysNull, 51 ProfileNeverNull, 52 ProfileMaybeNull 53 }; 54 55 // ciMethod 56 // 57 // This class represents a Method* in the HotSpot virtual 58 // machine. 59 class ciMethod : public ciMetadata { 60 friend class CompileBroker; 61 CI_PACKAGE_ACCESS 62 friend class ciEnv; 63 friend class ciExceptionHandlerStream; 64 friend class ciBytecodeStream; 65 friend class ciMethodHandle; 66 friend class ciReplay; 67 friend class InlineTree; 68 69 private: 70 // General method information. 71 ciFlags _flags; 72 ciSymbol* _name; 73 ciInstanceKlass* _holder; 74 ciSignature* _signature; 75 ciMethodData* _method_data; 76 ciMethodBlocks* _method_blocks; 77 78 // Code attributes. 79 int _code_size; 80 int _max_stack; 81 int _max_locals; 82 vmIntrinsicID _intrinsic_id; 83 int _handler_count; 84 int _interpreter_invocation_count; 85 int _interpreter_throwout_count; 86 int _inline_instructions_size; 87 int _size_of_parameters; 88 89 bool _uses_monitors; 90 bool _balanced_monitors; 91 bool _is_c1_compilable; 92 bool _is_c2_compilable; 93 bool _can_be_parsed; 94 bool _can_be_statically_bound; 95 bool _can_omit_stack_trace; 96 bool _has_reserved_stack_access; 97 bool _is_overpass; 98 99 // Lazy fields, filled in on demand 100 address _code; 101 ciExceptionHandler** _exception_handlers; 102 103 // Optional liveness analyzer. 104 MethodLiveness* _liveness; 105 #if defined(COMPILER2) 106 ciTypeFlow* _flow; 107 BCEscapeAnalyzer* _bcea; 108 #endif 109 110 ciMethod(const methodHandle& h_m, ciInstanceKlass* holder); 111 ciMethod(ciInstanceKlass* holder, ciSymbol* name, ciSymbol* signature, ciInstanceKlass* accessor); 112 113 oop loader() const { return _holder->loader(); } 114 115 const char* type_string() { return "ciMethod"; } 116 117 void print_impl(outputStream* st); 118 119 void load_code(); 120 121 bool ensure_method_data(const methodHandle& h_m); 122 123 void code_at_put(int bci, Bytecodes::Code code) { 124 Bytecodes::check(code); 125 assert(0 <= bci && bci < code_size(), "valid bci"); 126 address bcp = _code + bci; 127 *bcp = code; 128 } 129 130 // Check bytecode and profile data collected are compatible 131 void assert_virtual_call_type_ok(int bci); 132 void assert_call_type_ok(int bci); 133 134 // Check and update the profile counter in case of overflow 135 static int check_overflow(int c, Bytecodes::Code code); 136 137 public: 138 void check_is_loaded() const { assert(is_loaded(), "not loaded"); } 139 140 // Basic method information. 141 ciFlags flags() const { check_is_loaded(); return _flags; } 142 ciSymbol* name() const { return _name; } 143 ciInstanceKlass* holder() const { return _holder; } 144 ciMethodData* method_data(); 145 ciMethodData* method_data_or_null(); 146 147 // Signature information. 148 ciSignature* signature() const { return _signature; } 149 ciType* return_type() const { return _signature->return_type(); } 150 int arg_size_no_receiver() const { return _signature->size(); } 151 // Can only be used on loaded ciMethods 152 int arg_size() const { 153 check_is_loaded(); 154 return _signature->size() + (_flags.is_static() ? 0 : 1); 155 } 156 // Report the number of elements on stack when invoking the current method. 157 // If the method is loaded, arg_size() gives precise information about the 158 // number of stack elements (using the method's signature and its flags). 159 // However, if the method is not loaded, the number of stack elements must 160 // be determined differently, as the method's flags are not yet available. 161 // The invoke_arg_size() method assumes in that case that all bytecodes except 162 // invokestatic and invokedynamic have a receiver that is also pushed onto the 163 // stack by the caller of the current method. 164 int invoke_arg_size(Bytecodes::Code code) const { 165 if (is_loaded()) { 166 return arg_size(); 167 } else { 168 int arg_size = _signature->size(); 169 if (code != Bytecodes::_invokestatic && 170 code != Bytecodes::_invokedynamic) { 171 arg_size++; 172 } 173 return arg_size; 174 } 175 } 176 177 Method* get_Method() const { 178 Method* m = (Method*)_metadata; 179 assert(m != nullptr, "illegal use of unloaded method"); 180 return m; 181 } 182 183 // Method code and related information. 184 address code() { if (_code == nullptr) load_code(); return _code; } 185 int code_size() const { check_is_loaded(); return _code_size; } 186 int max_stack() const { check_is_loaded(); return _max_stack; } 187 int max_locals() const { check_is_loaded(); return _max_locals; } 188 vmIntrinsicID intrinsic_id() const { check_is_loaded(); return _intrinsic_id; } 189 bool has_exception_handlers() const { check_is_loaded(); return _handler_count > 0; } 190 int exception_table_length() const { check_is_loaded(); return _handler_count; } 191 int interpreter_invocation_count() const { check_is_loaded(); return _interpreter_invocation_count; } 192 int interpreter_throwout_count() const { check_is_loaded(); return _interpreter_throwout_count; } 193 int size_of_parameters() const { check_is_loaded(); return _size_of_parameters; } 194 195 // Code size for inlining decisions. 196 int code_size_for_inlining(); 197 198 bool caller_sensitive() const { return get_Method()->caller_sensitive(); } 199 bool force_inline() const { return get_Method()->force_inline(); } 200 bool dont_inline() const { return get_Method()->dont_inline(); } 201 bool intrinsic_candidate() const { return get_Method()->intrinsic_candidate(); } 202 bool is_class_initializer() const { return get_Method()->is_class_initializer(); } 203 bool changes_current_thread() const { return get_Method()->changes_current_thread(); } 204 bool deprecated() const { return is_loaded() && get_Method()->deprecated(); } 205 206 bool check_intrinsic_candidate() const { 207 if (intrinsic_id() == vmIntrinsics::_blackhole) { 208 // This is the intrinsic without an associated method, so no intrinsic_candidate 209 // flag is set. The intrinsic is still correct. 210 return true; 211 } 212 return (CheckIntrinsics ? intrinsic_candidate() : true); 213 } 214 215 int highest_osr_comp_level(); 216 217 Bytecodes::Code java_code_at_bci(int bci) { 218 address bcp = code() + bci; 219 return Bytecodes::java_code_at(nullptr, bcp); 220 } 221 Bytecodes::Code raw_code_at_bci(int bci) { 222 address bcp = code() + bci; 223 return Bytecodes::code_at(nullptr, bcp); 224 } 225 BCEscapeAnalyzer *get_bcea(); 226 ciMethodBlocks *get_method_blocks(); 227 228 bool has_linenumber_table() const; // length unknown until decompression 229 230 int line_number_from_bci(int bci) const; 231 232 // Runtime information. 233 int vtable_index(); 234 235 // Analysis and profiling. 236 // 237 // Usage note: liveness_at_bci and init_vars should be wrapped in ResourceMarks. 238 bool has_monitor_bytecodes() const { return _uses_monitors; } 239 bool has_balanced_monitors(); 240 241 // Returns a bitmap indicating which locals are required to be 242 // maintained as live for deopt. raw_liveness_at_bci is always the 243 // direct output of the liveness computation while liveness_at_bci 244 // may mark all locals as live to improve support for debugging Java 245 // code by maintaining the state of as many locals as possible. 246 MethodLivenessResult raw_liveness_at_bci(int bci); 247 MethodLivenessResult liveness_at_bci(int bci); 248 249 // Get the interpreters viewpoint on oop liveness. MethodLiveness is 250 // conservative in the sense that it may consider locals to be live which 251 // cannot be live, like in the case where a local could contain an oop or 252 // a primitive along different paths. In that case the local must be 253 // dead when those paths merge. Since the interpreter's viewpoint is 254 // used when gc'ing an interpreter frame we need to use its viewpoint 255 // during OSR when loading the locals. 256 257 ResourceBitMap live_local_oops_at_bci(int bci); 258 259 bool needs_clinit_barrier() const; 260 261 #ifdef COMPILER1 262 const BitMap& bci_block_start(); 263 #endif 264 265 ciTypeFlow* get_flow_analysis(); 266 ciTypeFlow* get_osr_flow_analysis(int osr_bci); // alternate entry point 267 ciCallProfile call_profile_at_bci(int bci); 268 269 // Does type profiling provide any useful information at this point? 270 bool argument_profiled_type(int bci, int i, ciKlass*& type, ProfilePtrKind& ptr_kind); 271 bool parameter_profiled_type(int i, ciKlass*& type, ProfilePtrKind& ptr_kind); 272 bool return_profiled_type(int bci, ciKlass*& type, ProfilePtrKind& ptr_kind); 273 bool array_access_profiled_type(int bci, ciKlass*& array_type, ciKlass*& element_type, ProfilePtrKind& element_ptr, bool &flat_array, bool &null_free); 274 bool acmp_profiled_type(int bci, ciKlass*& left_type, ciKlass*& right_type, 275 ProfilePtrKind& left_ptr, ProfilePtrKind& right_ptr, 276 bool &left_inline_type, bool &right_inline_type); 277 ciField* get_field_at_bci( int bci, bool &will_link); 278 ciMethod* get_method_at_bci(int bci, bool &will_link, ciSignature* *declared_signature); 279 ciMethod* get_method_at_bci(int bci) { 280 bool ignored_will_link; 281 ciSignature* ignored_declared_signature; 282 return get_method_at_bci(bci, ignored_will_link, &ignored_declared_signature); 283 } 284 285 ciKlass* get_declared_method_holder_at_bci(int bci); 286 287 ciSignature* get_declared_signature_at_bci(int bci) { 288 bool ignored_will_link; 289 ciSignature* declared_signature; 290 get_method_at_bci(bci, ignored_will_link, &declared_signature); 291 assert(declared_signature != nullptr, "cannot be null"); 292 return declared_signature; 293 } 294 295 // Given a certain calling environment, find the monomorphic target 296 // for the call. Return null if the call is not monomorphic in 297 // its calling environment. 298 ciMethod* find_monomorphic_target(ciInstanceKlass* caller, 299 ciInstanceKlass* callee_holder, 300 ciInstanceKlass* actual_receiver, 301 bool check_access = true); 302 303 // Given a known receiver klass, find the target for the call. 304 // Return null if the call has no target or is abstract. 305 ciMethod* resolve_invoke(ciKlass* caller, ciKlass* exact_receiver, bool check_access = true, bool allow_abstract = false); 306 307 // Find the proper vtable index to invoke this method. 308 int resolve_vtable_index(ciKlass* caller, ciKlass* receiver); 309 310 bool has_option(CompileCommandEnum option); 311 bool has_option_value(CompileCommandEnum option, double& value); 312 bool can_be_compiled(); 313 bool can_be_parsed() const { return _can_be_parsed; } 314 bool has_compiled_code(); 315 void log_nmethod_identity(xmlStream* log); 316 bool is_not_reached(int bci); 317 bool was_executed_more_than(int times); 318 bool has_unloaded_classes_in_signature(); 319 bool is_klass_loaded(int refinfo_index, Bytecodes::Code bc, bool must_be_resolved) const; 320 bool check_call(int refinfo_index, bool is_static) const; 321 bool ensure_method_data(); // make sure it exists in the VM also 322 MethodCounters* ensure_method_counters(); 323 324 int inline_instructions_size(); 325 int scale_count(int count, float prof_factor = 1.); // make MDO count commensurate with IIC 326 327 // Stack walking support 328 bool is_ignored_by_security_stack_walk() const; 329 330 // JSR 292 support 331 bool is_method_handle_intrinsic() const; 332 bool is_compiled_lambda_form() const; 333 bool has_member_arg() const; 334 335 // What kind of ciObject is this? 336 bool is_method() const { return true; } 337 338 // Java access flags 339 bool is_public () const { return flags().is_public(); } 340 bool is_private () const { return flags().is_private(); } 341 bool is_protected () const { return flags().is_protected(); } 342 bool is_static () const { return flags().is_static(); } 343 bool is_final () const { return flags().is_final(); } 344 bool is_synchronized() const { return flags().is_synchronized(); } 345 bool is_native () const { return flags().is_native(); } 346 bool is_interface () const { return flags().is_interface(); } 347 bool is_abstract () const { return flags().is_abstract(); } 348 bool has_vararg () const { return flags().has_vararg(); } 349 350 // Other flags 351 bool is_final_method() const { return is_final() || holder()->is_final(); } 352 bool is_default_method() const { return !is_abstract() && !is_private() && 353 holder()->is_interface(); } 354 bool is_overpass () const { check_is_loaded(); return _is_overpass; } 355 bool has_loops () const; 356 bool has_jsrs () const; 357 bool is_getter () const; 358 bool is_setter () const; 359 bool is_accessor () const; 360 bool is_empty () const; 361 bool can_be_statically_bound() const { return _can_be_statically_bound; } 362 bool has_reserved_stack_access() const { return _has_reserved_stack_access; } 363 bool is_boxing_method() const; 364 bool is_unboxing_method() const; 365 bool is_object_constructor() const; 366 bool is_vector_method() const; 367 368 bool can_be_statically_bound(ciInstanceKlass* context) const; 369 370 bool can_omit_stack_trace() const; 371 372 // Replay data methods 373 static void dump_name_as_ascii(outputStream* st, Method* method); 374 void dump_name_as_ascii(outputStream* st); 375 void dump_replay_data(outputStream* st); 376 377 // Print the bytecodes of this method. 378 void print_codes_on(outputStream* st); 379 void print_codes() { 380 print_codes_on(tty); 381 } 382 void print_codes_on(int from, int to, outputStream* st); 383 384 // Print the name of this method in various incarnations. 385 void print_name(outputStream* st = tty); 386 void print_short_name(outputStream* st = tty); 387 388 static bool is_consistent_info(ciMethod* declared_method, ciMethod* resolved_method); 389 390 // Support for the inline type calling convention 391 bool is_scalarized_arg(int idx) const; 392 bool has_scalarized_args() const; 393 const GrowableArray<SigEntry>* get_sig_cc() const; 394 }; 395 396 #endif // SHARE_CI_CIMETHOD_HPP