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