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