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