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