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