1 /*
2 * Copyright (c) 1999, 2010, 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 class ciMethodBlocks;
26 class MethodLiveness;
27 class BitMap;
28 class Arena;
29 class BCEscapeAnalyzer;
30
31
32 // ciMethod
33 //
34 // This class represents a methodOop in the HotSpot virtual
35 // machine.
36 class ciMethod : public ciObject {
37 friend class CompileBroker;
38 CI_PACKAGE_ACCESS
39 friend class ciEnv;
40 friend class ciExceptionHandlerStream;
41 friend class ciBytecodeStream;
42 friend class ciMethodHandle;
43
44 private:
45 // General method information.
46 ciFlags _flags;
47 ciSymbol* _name;
48 ciInstanceKlass* _holder;
49 ciSignature* _signature;
50 ciMethodData* _method_data;
51 ciMethodBlocks* _method_blocks;
52
53 // Code attributes.
54 int _code_size;
55 int _max_stack;
56 int _max_locals;
57 vmIntrinsics::ID _intrinsic_id;
58 int _handler_count;
59 int _interpreter_invocation_count;
60 int _interpreter_throwout_count;
61
62 bool _uses_monitors;
63 bool _balanced_monitors;
64 bool _is_c1_compilable;
65 bool _is_c2_compilable;
66 bool _can_be_statically_bound;
67
68 // Lazy fields, filled in on demand
69 address _code;
70 ciExceptionHandler** _exception_handlers;
71
72 // Optional liveness analyzer.
73 MethodLiveness* _liveness;
74 #if defined(COMPILER2) || defined(SHARK)
75 ciTypeFlow* _flow;
76 BCEscapeAnalyzer* _bcea;
77 #endif
78
79 ciMethod(methodHandle h_m);
80 ciMethod(ciInstanceKlass* holder, ciSymbol* name, ciSymbol* signature);
81
82 methodOop get_methodOop() const {
83 methodOop m = (methodOop)get_oop();
84 assert(m != NULL, "illegal use of unloaded method");
85 return m;
86 }
87
88 oop loader() const { return _holder->loader(); }
89
90 const char* type_string() { return "ciMethod"; }
91
92 void print_impl(outputStream* st);
93
94 void load_code();
95
96 void check_is_loaded() const { assert(is_loaded(), "not loaded"); }
97
98 void build_method_data(methodHandle h_m);
99
100 void code_at_put(int bci, Bytecodes::Code code) {
101 Bytecodes::check(code);
102 assert(0 <= bci && bci < code_size(), "valid bci");
103 address bcp = _code + bci;
104 *bcp = code;
105 }
106
107 public:
108 // Basic method information.
109 ciFlags flags() const { check_is_loaded(); return _flags; }
110 ciSymbol* name() const { return _name; }
111 ciInstanceKlass* holder() const { return _holder; }
112 ciMethodData* method_data();
113
114 // Signature information.
115 ciSignature* signature() const { return _signature; }
116 ciType* return_type() const { return _signature->return_type(); }
117 int arg_size_no_receiver() const { return _signature->size(); }
118 int arg_size() const { return _signature->size() + (_flags.is_static() ? 0 : 1); }
119
120 // Method code and related information.
121 address code() { if (_code == NULL) load_code(); return _code; }
122 int code_size() const { check_is_loaded(); return _code_size; }
123 int max_stack() const { check_is_loaded(); return _max_stack; }
124 int max_locals() const { check_is_loaded(); return _max_locals; }
125 vmIntrinsics::ID intrinsic_id() const { check_is_loaded(); return _intrinsic_id; }
126 bool has_exception_handlers() const { check_is_loaded(); return _handler_count > 0; }
127 int exception_table_length() const { check_is_loaded(); return _handler_count; }
128 int interpreter_invocation_count() const { check_is_loaded(); return _interpreter_invocation_count; }
129 int interpreter_throwout_count() const { check_is_loaded(); return _interpreter_throwout_count; }
130
131 int comp_level();
132
133 Bytecodes::Code java_code_at_bci(int bci) {
134 address bcp = code() + bci;
135 return Bytecodes::java_code_at(bcp);
136 }
137 BCEscapeAnalyzer *get_bcea();
138 ciMethodBlocks *get_method_blocks();
139
140 bool has_linenumber_table() const; // length unknown until decompression
141 u_char* compressed_linenumber_table() const; // not preserved by gc
142
143 int line_number_from_bci(int bci) const;
144
145 // Runtime information.
146 int vtable_index();
147 #ifdef SHARK
148 int itable_index();
149 #endif // SHARK
150 address native_entry();
151 address interpreter_entry();
152
153 // Analysis and profiling.
154 //
155 // Usage note: liveness_at_bci and init_vars should be wrapped in ResourceMarks.
156 bool uses_monitors() const { return _uses_monitors; } // this one should go away, it has a misleading name
157 bool has_monitor_bytecodes() const { return _uses_monitors; }
158 bool has_balanced_monitors();
159
160 // Returns a bitmap indicating which locals are required to be
161 // maintained as live for deopt. raw_liveness_at_bci is always the
162 // direct output of the liveness computation while liveness_at_bci
163 // may mark all locals as live to improve support for debugging Java
164 // code by maintaining the state of as many locals as possible.
165 MethodLivenessResult raw_liveness_at_bci(int bci);
166 MethodLivenessResult liveness_at_bci(int bci);
167
168 // Get the interpreters viewpoint on oop liveness. MethodLiveness is
169 // conservative in the sense that it may consider locals to be live which
170 // cannot be live, like in the case where a local could contain an oop or
171 // a primitive along different paths. In that case the local must be
172 // dead when those paths merge. Since the interpreter's viewpoint is
173 // used when gc'ing an interpreter frame we need to use its viewpoint
174 // during OSR when loading the locals.
175
176 BitMap live_local_oops_at_bci(int bci);
177
178 #ifdef COMPILER1
179 const BitMap bci_block_start();
180 #endif
181
182 ciTypeFlow* get_flow_analysis();
183 ciTypeFlow* get_osr_flow_analysis(int osr_bci); // alternate entry point
184 ciCallProfile call_profile_at_bci(int bci);
185 int interpreter_call_site_count(int bci);
186
187 // Given a certain calling environment, find the monomorphic target
188 // for the call. Return NULL if the call is not monomorphic in
189 // its calling environment.
190 ciMethod* find_monomorphic_target(ciInstanceKlass* caller,
191 ciInstanceKlass* callee_holder,
192 ciInstanceKlass* actual_receiver);
193
194 // Given a known receiver klass, find the target for the call.
195 // Return NULL if the call has no target or is abstract.
196 ciMethod* resolve_invoke(ciKlass* caller, ciKlass* exact_receiver);
197
198 // Find the proper vtable index to invoke this method.
199 int resolve_vtable_index(ciKlass* caller, ciKlass* receiver);
200
201 // Compilation directives
202 bool will_link(ciKlass* accessing_klass,
203 ciKlass* declared_method_holder,
204 Bytecodes::Code bc);
205 bool should_exclude();
206 bool should_inline();
207 bool should_not_inline();
208 bool should_print_assembly();
209 bool break_at_execute();
210 bool has_option(const char *option);
211 bool can_be_compiled();
212 bool can_be_osr_compiled(int entry_bci);
213 void set_not_compilable();
214 bool has_compiled_code();
215 int instructions_size(int comp_level = CompLevel_any);
216 void log_nmethod_identity(xmlStream* log);
217 bool is_not_reached(int bci);
218 bool was_executed_more_than(int times);
219 bool has_unloaded_classes_in_signature();
220 bool is_klass_loaded(int refinfo_index, bool must_be_resolved) const;
221 bool check_call(int refinfo_index, bool is_static) const;
222 void build_method_data(); // make sure it exists in the VM also
223 int scale_count(int count, float prof_factor = 1.); // make MDO count commensurate with IIC
224
225 // JSR 292 support
226 bool is_method_handle_invoke() const;
227 bool is_method_handle_adapter() const;
228 ciInstance* method_handle_type();
229
230 // What kind of ciObject is this?
231 bool is_method() { return true; }
232
233 // Java access flags
234 bool is_public () const { return flags().is_public(); }
235 bool is_private () const { return flags().is_private(); }
236 bool is_protected () const { return flags().is_protected(); }
237 bool is_static () const { return flags().is_static(); }
238 bool is_final () const { return flags().is_final(); }
239 bool is_synchronized() const { return flags().is_synchronized(); }
240 bool is_native () const { return flags().is_native(); }
241 bool is_interface () const { return flags().is_interface(); }
242 bool is_abstract () const { return flags().is_abstract(); }
243 bool is_strict () const { return flags().is_strict(); }
244
245 // Other flags
246 bool is_empty_method() const;
247 bool is_vanilla_constructor() const;
248 bool is_final_method() const { return is_final() || holder()->is_final(); }
249 bool has_loops () const;
250 bool has_jsrs () const;
251 bool is_accessor () const;
252 bool is_initializer () const;
253 bool can_be_statically_bound() const { return _can_be_statically_bound; }
254
255 // Print the bytecodes of this method.
256 void print_codes_on(outputStream* st);
257 void print_codes() {
258 print_codes_on(tty);
259 }
260 void print_codes_on(int from, int to, outputStream* st);
261
262 // Print the name of this method in various incarnations.
263 void print_name(outputStream* st = tty);
264 void print_short_name(outputStream* st = tty);
265
266 methodOop get_method_handle_target() {
267 klassOop receiver_limit_oop = NULL;
268 int flags = 0;
269 return MethodHandles::decode_method(get_oop(), receiver_limit_oop, flags);
270 }
271 };