ciMethod.hpp revision 3602:da91efe96a93 
1/*
2 * Copyright (c) 1999, 2012, 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
36class ciMethodBlocks;
37class MethodLiveness;
38class BitMap;
39class Arena;
40class BCEscapeAnalyzer;
41
42
43// ciMethod
44//
45// This class represents a Method* in the HotSpot virtual
46// machine.
47class ciMethod : public ciMetadata {
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, ciInstanceKlass* accessor);
92
93  Method* get_Method() const {
94    Method* m = (Method*)_metadata;
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 invokedynamic
137  // has an implicit receiver.
138  int invoke_arg_size(Bytecodes::Code code) const {
139    if (is_loaded()) {
140      return arg_size();
141    } else {
142      int arg_size = _signature->size();
143      // Add a receiver argument, maybe:
144      if (code != Bytecodes::_invokestatic &&
145          code != Bytecodes::_invokedynamic) {
146        arg_size++;
147      }
148      return arg_size;
149    }
150  }
151
152
153  // Method code and related information.
154  address code()                                 { if (_code == NULL) load_code(); return _code; }
155  int code_size() const                          { check_is_loaded(); return _code_size; }
156  int max_stack() const                          { check_is_loaded(); return _max_stack; }
157  int max_locals() const                         { check_is_loaded(); return _max_locals; }
158  vmIntrinsics::ID intrinsic_id() const          { check_is_loaded(); return _intrinsic_id; }
159  bool has_exception_handlers() const            { check_is_loaded(); return _handler_count > 0; }
160  int exception_table_length() const             { check_is_loaded(); return _handler_count; }
161  int interpreter_invocation_count() const       { check_is_loaded(); return _interpreter_invocation_count; }
162  int interpreter_throwout_count() const         { check_is_loaded(); return _interpreter_throwout_count; }
163
164  // Code size for inlining decisions.
165  int code_size_for_inlining();
166
167  bool force_inline() { return get_Method()->force_inline(); }
168  bool dont_inline()  { return get_Method()->dont_inline();  }
169
170  int comp_level();
171  int highest_osr_comp_level();
172
173  Bytecodes::Code java_code_at_bci(int bci) {
174    address bcp = code() + bci;
175    return Bytecodes::java_code_at(NULL, bcp);
176  }
177  BCEscapeAnalyzer  *get_bcea();
178  ciMethodBlocks    *get_method_blocks();
179
180  bool    has_linenumber_table() const;          // length unknown until decompression
181  u_char* compressed_linenumber_table() const;   // not preserved by gc
182
183  int line_number_from_bci(int bci) const;
184
185  // Runtime information.
186  int           vtable_index();
187#ifdef SHARK
188  int           itable_index();
189#endif // SHARK
190  address       native_entry();
191  address       interpreter_entry();
192
193  // Analysis and profiling.
194  //
195  // Usage note: liveness_at_bci and init_vars should be wrapped in ResourceMarks.
196  bool          uses_monitors() const            { return _uses_monitors; } // this one should go away, it has a misleading name
197  bool          has_monitor_bytecodes() const    { return _uses_monitors; }
198  bool          has_balanced_monitors();
199
200  // Returns a bitmap indicating which locals are required to be
201  // maintained as live for deopt.  raw_liveness_at_bci is always the
202  // direct output of the liveness computation while liveness_at_bci
203  // may mark all locals as live to improve support for debugging Java
204  // code by maintaining the state of as many locals as possible.
205  MethodLivenessResult raw_liveness_at_bci(int bci);
206  MethodLivenessResult liveness_at_bci(int bci);
207
208  // Get the interpreters viewpoint on oop liveness.  MethodLiveness is
209  // conservative in the sense that it may consider locals to be live which
210  // cannot be live, like in the case where a local could contain an oop or
211  // a primitive along different paths.  In that case the local must be
212  // dead when those paths merge. Since the interpreter's viewpoint is
213  // used when gc'ing an interpreter frame we need to use its viewpoint
214  // during OSR when loading the locals.
215
216  BitMap  live_local_oops_at_bci(int bci);
217
218#ifdef COMPILER1
219  const BitMap  bci_block_start();
220#endif
221
222  ciTypeFlow*   get_flow_analysis();
223  ciTypeFlow*   get_osr_flow_analysis(int osr_bci);  // alternate entry point
224  ciCallProfile call_profile_at_bci(int bci);
225  int           interpreter_call_site_count(int bci);
226
227  // Given a certain calling environment, find the monomorphic target
228  // for the call.  Return NULL if the call is not monomorphic in
229  // its calling environment.
230  ciMethod* find_monomorphic_target(ciInstanceKlass* caller,
231                                    ciInstanceKlass* callee_holder,
232                                    ciInstanceKlass* actual_receiver);
233
234  // Given a known receiver klass, find the target for the call.
235  // Return NULL if the call has no target or is abstract.
236  ciMethod* resolve_invoke(ciKlass* caller, ciKlass* exact_receiver);
237
238  // Find the proper vtable index to invoke this method.
239  int resolve_vtable_index(ciKlass* caller, ciKlass* receiver);
240
241  // Compilation directives
242  bool will_link(ciKlass* accessing_klass,
243                 ciKlass* declared_method_holder,
244                 Bytecodes::Code bc);
245  bool should_exclude();
246  bool should_inline();
247  bool should_not_inline();
248  bool should_print_assembly();
249  bool break_at_execute();
250  bool has_option(const char *option);
251  bool can_be_compiled();
252  bool can_be_osr_compiled(int entry_bci);
253  void set_not_compilable();
254  bool has_compiled_code();
255  int  instructions_size(int comp_level = CompLevel_any);
256  void log_nmethod_identity(xmlStream* log);
257  bool is_not_reached(int bci);
258  bool was_executed_more_than(int times);
259  bool has_unloaded_classes_in_signature();
260  bool is_klass_loaded(int refinfo_index, bool must_be_resolved) const;
261  bool check_call(int refinfo_index, bool is_static) const;
262  bool ensure_method_data();  // make sure it exists in the VM also
263  int scale_count(int count, float prof_factor = 1.);  // make MDO count commensurate with IIC
264
265  // JSR 292 support
266  bool is_method_handle_intrinsic()  const;
267  bool is_compiled_lambda_form() const;
268  bool has_member_arg() const;
269
270  // What kind of ciObject is this?
271  bool is_method() const                         { return true; }
272
273  // Java access flags
274  bool is_public      () const                   { return flags().is_public(); }
275  bool is_private     () const                   { return flags().is_private(); }
276  bool is_protected   () const                   { return flags().is_protected(); }
277  bool is_static      () const                   { return flags().is_static(); }
278  bool is_final       () const                   { return flags().is_final(); }
279  bool is_synchronized() const                   { return flags().is_synchronized(); }
280  bool is_native      () const                   { return flags().is_native(); }
281  bool is_interface   () const                   { return flags().is_interface(); }
282  bool is_abstract    () const                   { return flags().is_abstract(); }
283  bool is_strict      () const                   { return flags().is_strict(); }
284
285  // Other flags
286  bool is_empty_method() const;
287  bool is_vanilla_constructor() const;
288  bool is_final_method() const                   { return is_final() || holder()->is_final(); }
289  bool has_loops      () const;
290  bool has_jsrs       () const;
291  bool is_accessor    () const;
292  bool is_initializer () const;
293  bool can_be_statically_bound() const           { return _can_be_statically_bound; }
294
295  // Print the bytecodes of this method.
296  void print_codes_on(outputStream* st);
297  void print_codes() {
298    print_codes_on(tty);
299  }
300  void print_codes_on(int from, int to, outputStream* st);
301
302  // Print the name of this method in various incarnations.
303  void print_name(outputStream* st = tty);
304  void print_short_name(outputStream* st = tty);
305};
306
307#endif // SHARE_VM_CI_CIMETHOD_HPP
308