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