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