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