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