1 /*
2 * Copyright (c) 1999, 2024, 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_CI_CIMETHOD_HPP
26 #define SHARE_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 "classfile/vmIntrinsics.hpp"
33 #include "compiler/methodLiveness.hpp"
34 #include "oops/method.hpp"
35 #include "runtime/handles.hpp"
36 #include "utilities/bitMap.hpp"
37 #include "utilities/vmEnums.hpp"
38
39 class ciMethodBlocks;
40 class MethodLiveness;
41 class Arena;
42 class BCEscapeAnalyzer;
43 class InlineTree;
44 class xmlStream;
45
46 // Whether profiling found an oop to be always, never or sometimes
47 // null
48 enum ProfilePtrKind {
49 ProfileAlwaysNull,
50 ProfileNeverNull,
51 ProfileMaybeNull
52 };
53
54 // ciMethod
55 //
56 // This class represents a Method* in the HotSpot virtual
57 // machine.
58 class ciMethod : public ciMetadata {
59 friend class CompileBroker;
60 CI_PACKAGE_ACCESS
61 friend class ciEnv;
62 friend class ciExceptionHandlerStream;
63 friend class ciBytecodeStream;
64 friend class ciMethodHandle;
65 friend class ciReplay;
66 friend class InlineTree;
67
68 private:
69 // General method information.
70 ciFlags _flags;
71 ciSymbol* _name;
72 ciInstanceKlass* _holder;
73 ciSignature* _signature;
74 ciMethodData* _method_data;
75 ciMethodData* _method_data_recorded;
76 ciMethodBlocks* _method_blocks;
77
78 // Code attributes.
79 int _code_size;
80 int _max_stack;
81 int _max_locals;
82 vmIntrinsicID _intrinsic_id;
83 int _handler_count;
84 int _interpreter_invocation_count;
85 int _interpreter_throwout_count;
86 int _inline_instructions_size;
87 int _size_of_parameters;
88
89 bool _uses_monitors;
90 bool _balanced_monitors;
91 bool _is_c1_compilable;
92 bool _is_c2_compilable;
93 bool _can_be_parsed;
94 bool _can_be_statically_bound;
95 bool _can_omit_stack_trace;
96 bool _has_reserved_stack_access;
97 bool _is_overpass;
98
99 GrowableArray<int>* _has_trap_at_bci;
100
101 // Lazy fields, filled in on demand
102 address _code;
103 ciExceptionHandler** _exception_handlers;
104
105 // Optional liveness analyzer.
106 MethodLiveness* _liveness;
107 #if defined(COMPILER2)
108 ciTypeFlow* _flow;
109 BCEscapeAnalyzer* _bcea;
110 #endif
111
112 ciMethod(const methodHandle& h_m, ciInstanceKlass* holder);
113 ciMethod(ciInstanceKlass* holder, ciSymbol* name, ciSymbol* signature, ciInstanceKlass* accessor);
114
115 oop loader() const { return _holder->loader(); }
116
117 const char* type_string() { return "ciMethod"; }
118
119 void print_impl(outputStream* st);
120
121 void load_code();
122
123 bool ensure_method_data(const methodHandle& h_m, bool training_data_only);
124
125 void code_at_put(int bci, Bytecodes::Code code) {
126 Bytecodes::check(code);
127 assert(0 <= bci && bci < code_size(), "valid bci");
128 address bcp = _code + bci;
129 *bcp = code;
130 }
131
132 // Check bytecode and profile data collected are compatible
133 void assert_virtual_call_type_ok(int bci);
134 void assert_call_type_ok(int bci);
135
136 // Check and update the profile counter in case of overflow
137 static int check_overflow(int c, Bytecodes::Code code);
138
139 public:
140 void check_is_loaded() const { assert(is_loaded(), "not loaded"); }
141
142 // Basic method information.
143 ciFlags flags() const { check_is_loaded(); return _flags; }
144 ciSymbol* name() const { return _name; }
145 ciInstanceKlass* holder() const { return _holder; }
146 ciMethodData* method_data();
147 ciMethodData* method_data_or_null();
148
149 // Signature information.
150 ciSignature* signature() const { return _signature; }
151 ciType* return_type() const { return _signature->return_type(); }
152 int arg_size_no_receiver() const { return _signature->size(); }
153 // Can only be used on loaded ciMethods
154 int arg_size() const {
155 check_is_loaded();
156 return _signature->size() + (_flags.is_static() ? 0 : 1);
157 }
158 // Report the number of elements on stack when invoking the current method.
159 // If the method is loaded, arg_size() gives precise information about the
160 // number of stack elements (using the method's signature and its flags).
161 // However, if the method is not loaded, the number of stack elements must
162 // be determined differently, as the method's flags are not yet available.
163 // The invoke_arg_size() method assumes in that case that all bytecodes except
164 // invokestatic and invokedynamic have a receiver that is also pushed onto the
165 // stack by the caller of the current method.
166 int invoke_arg_size(Bytecodes::Code code) const {
167 if (is_loaded()) {
168 return arg_size();
169 } else {
170 int arg_size = _signature->size();
171 if (code != Bytecodes::_invokestatic &&
172 code != Bytecodes::_invokedynamic) {
173 arg_size++;
174 }
175 return arg_size;
176 }
177 }
178
179 Method* get_Method() const {
180 Method* m = (Method*)_metadata;
181 assert(m != nullptr, "illegal use of unloaded method");
182 return m;
183 }
184
185 // Method code and related information.
186 address code() { if (_code == nullptr) load_code(); return _code; }
187 int code_size() const { check_is_loaded(); return _code_size; }
188 int max_stack() const { check_is_loaded(); return _max_stack; }
189 int max_locals() const { check_is_loaded(); return _max_locals; }
190 vmIntrinsicID intrinsic_id() const { check_is_loaded(); return _intrinsic_id; }
191 bool has_exception_handlers() const { check_is_loaded(); return _handler_count > 0; }
192 int exception_table_length() const { check_is_loaded(); return _handler_count; }
193 int interpreter_invocation_count() const { check_is_loaded(); return _interpreter_invocation_count; }
194 int interpreter_throwout_count() const { check_is_loaded(); return _interpreter_throwout_count; }
195 int size_of_parameters() const { check_is_loaded(); return _size_of_parameters; }
196
197 // Code size for inlining decisions.
198 int code_size_for_inlining();
199
200 bool caller_sensitive() const { return get_Method()->caller_sensitive(); }
201 bool force_inline() const { return get_Method()->force_inline(); }
202 bool dont_inline() const { return get_Method()->dont_inline(); }
203 bool intrinsic_candidate() const { return get_Method()->intrinsic_candidate(); }
204 bool is_static_initializer() const { return get_Method()->is_static_initializer(); }
205 bool changes_current_thread() const { return get_Method()->changes_current_thread(); }
206 bool deprecated() const { return is_loaded() && get_Method()->deprecated(); }
207 bool has_upcall_on_method_entry() const { return get_Method()->has_upcall_on_method_entry(); }
208 bool has_upcall_on_method_exit() const { return get_Method()->has_upcall_on_method_exit(); }
209
210 bool check_intrinsic_candidate() const {
211 if (intrinsic_id() == vmIntrinsics::_blackhole) {
212 // This is the intrinsic without an associated method, so no intrinsic_candidate
213 // flag is set. The intrinsic is still correct.
214 return true;
215 }
216 return (CheckIntrinsics ? intrinsic_candidate() : true);
217 }
218
219 int highest_osr_comp_level();
220
221 Bytecodes::Code java_code_at_bci(int bci) {
222 address bcp = code() + bci;
223 return Bytecodes::java_code_at(nullptr, bcp);
224 }
225 Bytecodes::Code raw_code_at_bci(int bci) {
226 address bcp = code() + bci;
227 return Bytecodes::code_at(nullptr, bcp);
228 }
229 BCEscapeAnalyzer *get_bcea();
230 ciMethodBlocks *get_method_blocks();
231
232 bool has_linenumber_table() const; // length unknown until decompression
233
234 int line_number_from_bci(int bci) const;
235
236 // Runtime information.
237 int vtable_index();
238
239 // Analysis and profiling.
240 //
241 // Usage note: liveness_at_bci and init_vars should be wrapped in ResourceMarks.
242 bool has_monitor_bytecodes() const { return _uses_monitors; }
243 bool has_balanced_monitors();
244
245 // Returns a bitmap indicating which locals are required to be
246 // maintained as live for deopt. raw_liveness_at_bci is always the
247 // direct output of the liveness computation while liveness_at_bci
248 // may mark all locals as live to improve support for debugging Java
249 // code by maintaining the state of as many locals as possible.
250 MethodLivenessResult raw_liveness_at_bci(int bci);
251 MethodLivenessResult liveness_at_bci(int bci);
252
253 // Get the interpreters viewpoint on oop liveness. MethodLiveness is
254 // conservative in the sense that it may consider locals to be live which
255 // cannot be live, like in the case where a local could contain an oop or
256 // a primitive along different paths. In that case the local must be
257 // dead when those paths merge. Since the interpreter's viewpoint is
258 // used when gc'ing an interpreter frame we need to use its viewpoint
259 // during OSR when loading the locals.
260
261 ResourceBitMap live_local_oops_at_bci(int bci);
262
263 bool needs_clinit_barrier() const;
264
265 #ifdef COMPILER1
266 const BitMap& bci_block_start();
267 #endif
268
269 ciTypeFlow* get_flow_analysis();
270 ciTypeFlow* get_osr_flow_analysis(int osr_bci); // alternate entry point
271 ciCallProfile call_profile_at_bci(int bci);
272
273 // Does type profiling provide any useful information at this point?
274 bool argument_profiled_type(int bci, int i, ciKlass*& type, ProfilePtrKind& ptr_kind);
275 bool parameter_profiled_type(int i, ciKlass*& type, ProfilePtrKind& ptr_kind);
276 bool return_profiled_type(int bci, ciKlass*& type, ProfilePtrKind& ptr_kind);
277
278 ciField* get_field_at_bci( int bci, bool &will_link);
279 ciMethod* get_method_at_bci(int bci, bool &will_link, ciSignature* *declared_signature);
280 ciMethod* get_method_at_bci(int bci) {
281 bool ignored_will_link;
282 ciSignature* ignored_declared_signature;
283 return get_method_at_bci(bci, ignored_will_link, &ignored_declared_signature);
284 }
285
286 ciKlass* get_declared_method_holder_at_bci(int bci);
287
288 ciSignature* get_declared_signature_at_bci(int bci) {
289 bool ignored_will_link;
290 ciSignature* declared_signature;
291 get_method_at_bci(bci, ignored_will_link, &declared_signature);
292 assert(declared_signature != nullptr, "cannot be null");
293 return declared_signature;
294 }
295
296 // Given a certain calling environment, find the monomorphic target
297 // for the call. Return null if the call is not monomorphic in
298 // its calling environment.
299 ciMethod* find_monomorphic_target(ciInstanceKlass* caller,
300 ciInstanceKlass* callee_holder,
301 ciInstanceKlass* actual_receiver,
302 bool check_access = true);
303
304 // Given a known receiver klass, find the target for the call.
305 // Return null if the call has no target or is abstract.
306 ciMethod* resolve_invoke(ciKlass* caller, ciKlass* exact_receiver, bool check_access = true, bool allow_abstract = false);
307
308 // Find the proper vtable index to invoke this method.
309 int resolve_vtable_index(ciKlass* caller, ciKlass* receiver);
310
311 bool has_option(CompileCommandEnum option);
312 bool has_option_value(CompileCommandEnum option, double& value);
313 bool can_be_compiled();
314 bool can_be_parsed() const { return _can_be_parsed; }
315 bool has_compiled_code();
316 void log_nmethod_identity(xmlStream* log);
317 bool is_not_reached(int bci);
318 bool was_executed_more_than(int times);
319 bool has_unloaded_classes_in_signature();
320 bool is_klass_loaded(int refinfo_index, Bytecodes::Code bc, bool must_be_resolved) const;
321 bool check_call(int refinfo_index, bool is_static) const;
322 bool ensure_method_data(bool training_data_only = false); // make sure it exists in the VM also
323 MethodCounters* ensure_method_counters();
324
325 int inline_instructions_size();
326 int scale_count(int count, float prof_factor = 1.); // make MDO count commensurate with IIC
327
328 // Stack walking support
329 bool is_ignored_by_security_stack_walk() const;
330
331 // JSR 292 support
332 bool is_method_handle_intrinsic() const;
333 bool is_compiled_lambda_form() const;
334 bool has_member_arg() const;
335
336 // What kind of ciObject is this?
337 bool is_method() const { return true; }
338
339 // Java access flags
340 bool is_public () const { return flags().is_public(); }
341 bool is_private () const { return flags().is_private(); }
342 bool is_protected () const { return flags().is_protected(); }
343 bool is_static () const { return flags().is_static(); }
344 bool is_final () const { return flags().is_final(); }
345 bool is_synchronized() const { return flags().is_synchronized(); }
346 bool is_native () const { return flags().is_native(); }
347 bool is_interface () const { return flags().is_interface(); }
348 bool is_abstract () const { return flags().is_abstract(); }
349
350 // Other flags
351 bool is_final_method() const { return is_final() || holder()->is_final(); }
352 bool is_default_method() const { return !is_abstract() && !is_private() &&
353 holder()->is_interface(); }
354 bool is_overpass () const { check_is_loaded(); return _is_overpass; }
355 bool has_loops () const;
356 bool has_jsrs () const;
357 bool is_getter () const;
358 bool is_setter () const;
359 bool is_accessor () const;
360 bool is_empty () const;
361 bool can_be_statically_bound() const { return _can_be_statically_bound; }
362 bool has_reserved_stack_access() const { return _has_reserved_stack_access; }
363 bool is_boxing_method() const;
364 bool is_unboxing_method() const;
365 bool is_vector_method() const;
366 bool is_object_initializer() const;
367 bool is_scoped() const;
368
369 bool can_be_statically_bound(ciInstanceKlass* context) const;
370
371 bool can_omit_stack_trace() const;
372
373 bool equals(const ciMethod* m) const;
374
375 // Replay data methods
376 static void dump_name_as_ascii(outputStream* st, Method* method);
377 void dump_name_as_ascii(outputStream* st);
378 void dump_replay_data(outputStream* st);
379
380 // Print the bytecodes of this method.
381 void print_codes_on(outputStream* st);
382 void print_codes() {
383 print_codes_on(tty);
384 }
385 void print_codes_on(int from, int to, outputStream* st);
386
387 // Print the name of this method in various incarnations.
388 void print_name(outputStream* st = tty);
389 void print_short_name(outputStream* st = tty);
390
391 static bool is_consistent_info(ciMethod* declared_method, ciMethod* resolved_method);
392 bool has_trap_at(int bci) {
393 return _has_trap_at_bci != nullptr &&
394 _has_trap_at_bci->contains(bci);
395 }
396 };
397
398 #endif // SHARE_CI_CIMETHOD_HPP