1 /*
   2  * Copyright (c) 1999, 2013, 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 
  36 class ciMethodBlocks;
  37 class MethodLiveness;
  38 class BitMap;
  39 class Arena;
  40 class BCEscapeAnalyzer;
  41 
  42 
  43 // ciMethod
  44 //
  45 // This class represents a Method* in the HotSpot virtual
  46 // machine.
  47 class 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   friend class ciReplay;
  55 
  56  private:
  57   // General method information.
  58   ciFlags          _flags;
  59   ciSymbol*        _name;
  60   ciInstanceKlass* _holder;
  61   ciSignature*     _signature;
  62   ciMethodData*    _method_data;
  63   ciMethodBlocks*   _method_blocks;
  64 
  65   // Code attributes.
  66   int _code_size;
  67   int _max_stack;
  68   int _max_locals;
  69   vmIntrinsics::ID _intrinsic_id;
  70   int _handler_count;
  71   int _nmethod_age;
  72   int _interpreter_invocation_count;
  73   int _interpreter_throwout_count;
  74   int _instructions_size;
  75   int _size_of_parameters;
  76 
  77   bool _uses_monitors;
  78   bool _balanced_monitors;
  79   bool _is_c1_compilable;
  80   bool _is_c2_compilable;
  81   bool _can_be_statically_bound;
  82 
  83   // Lazy fields, filled in on demand
  84   address              _code;
  85   ciExceptionHandler** _exception_handlers;
  86 
  87   // Optional liveness analyzer.
  88   MethodLiveness* _liveness;
  89 #if defined(COMPILER2) || defined(SHARK)
  90   ciTypeFlow*         _flow;
  91   BCEscapeAnalyzer*   _bcea;
  92 #endif
  93 
  94   ciMethod(methodHandle h_m, ciInstanceKlass* holder);
  95   ciMethod(ciInstanceKlass* holder, ciSymbol* name, ciSymbol* signature, ciInstanceKlass* accessor);
  96 
  97   Method* get_Method() const {
  98     Method* m = (Method*)_metadata;
  99     assert(m != NULL, "illegal use of unloaded method");
 100     return m;
 101   }
 102 
 103   oop loader() const                             { return _holder->loader(); }
 104 
 105   const char* type_string()                      { return "ciMethod"; }
 106 
 107   void print_impl(outputStream* st);
 108 
 109   void load_code();
 110 
 111   void check_is_loaded() const                   { assert(is_loaded(), "not loaded"); }
 112 
 113   bool ensure_method_data(methodHandle h_m);
 114 
 115   void code_at_put(int bci, Bytecodes::Code code) {
 116     Bytecodes::check(code);
 117     assert(0 <= bci && bci < code_size(), "valid bci");
 118     address bcp = _code + bci;
 119     *bcp = code;
 120   }
 121 
 122   // Check bytecode and profile data collected are compatible
 123   void assert_virtual_call_type_ok(int bci);
 124   void assert_call_type_ok(int bci);
 125 
 126  public:
 127   // Basic method information.
 128   ciFlags flags() const                          { check_is_loaded(); return _flags; }
 129   ciSymbol* name() const                         { return _name; }
 130   ciInstanceKlass* holder() const                { return _holder; }
 131   ciMethodData* method_data();
 132   ciMethodData* method_data_or_null();
 133 
 134   // Signature information.
 135   ciSignature* signature() const                 { return _signature; }
 136   ciType*      return_type() const               { return _signature->return_type(); }
 137   int          arg_size_no_receiver() const      { return _signature->size(); }
 138   // Can only be used on loaded ciMethods
 139   int          arg_size() const                  {
 140     check_is_loaded();
 141     return _signature->size() + (_flags.is_static() ? 0 : 1);
 142   }
 143   // Report the number of elements on stack when invoking this method.
 144   // This is different than the regular arg_size because invokedynamic
 145   // has an implicit receiver.
 146   int invoke_arg_size(Bytecodes::Code code) const {
 147     if (is_loaded()) {
 148       return arg_size();
 149     } else {
 150       int arg_size = _signature->size();
 151       // Add a receiver argument, maybe:
 152       if (code != Bytecodes::_invokestatic &&
 153           code != Bytecodes::_invokedynamic) {
 154         arg_size++;
 155       }
 156       return arg_size;
 157     }
 158   }
 159 
 160 
 161   // Method code and related information.
 162   address code()                                 { if (_code == NULL) load_code(); return _code; }
 163   int code_size() const                          { check_is_loaded(); return _code_size; }
 164   int max_stack() const                          { check_is_loaded(); return _max_stack; }
 165   int max_locals() const                         { check_is_loaded(); return _max_locals; }
 166   vmIntrinsics::ID intrinsic_id() const          { check_is_loaded(); return _intrinsic_id; }
 167   bool has_exception_handlers() const            { check_is_loaded(); return _handler_count > 0; }
 168   int exception_table_length() const             { check_is_loaded(); return _handler_count; }
 169   int interpreter_invocation_count() const       { check_is_loaded(); return _interpreter_invocation_count; }
 170   int interpreter_throwout_count() const         { check_is_loaded(); return _interpreter_throwout_count; }
 171   int size_of_parameters() const                 { check_is_loaded(); return _size_of_parameters; }
 172   int nmethod_age() const                        { check_is_loaded(); return _nmethod_age; }
 173 
 174   // Should the method be compiled with an age counter?
 175   bool profile_aging() const;
 176 
 177   // Code size for inlining decisions.
 178   int code_size_for_inlining();
 179 
 180   bool caller_sensitive() { return get_Method()->caller_sensitive(); }
 181   bool force_inline()     { return get_Method()->force_inline();     }
 182   bool dont_inline()      { return get_Method()->dont_inline();      }
 183   bool is_shared()        { return get_Method()->is_shared();   }
 184 
 185   int comp_level();
 186   int highest_osr_comp_level();
 187 
 188   Bytecodes::Code java_code_at_bci(int bci) {
 189     address bcp = code() + bci;
 190     return Bytecodes::java_code_at(NULL, bcp);
 191   }
 192   Bytecodes::Code raw_code_at_bci(int bci) {
 193     address bcp = code() + bci;
 194     return Bytecodes::code_at(NULL, bcp);
 195   }
 196   BCEscapeAnalyzer  *get_bcea();
 197   ciMethodBlocks    *get_method_blocks();
 198 
 199   bool    has_linenumber_table() const;          // length unknown until decompression
 200   u_char* compressed_linenumber_table() const;   // not preserved by gc
 201 
 202   int line_number_from_bci(int bci) const;
 203 
 204   // Runtime information.
 205   int           vtable_index();
 206 #ifdef SHARK
 207   int           itable_index();
 208 #endif // SHARK
 209   address       native_entry();
 210   address       interpreter_entry();
 211 
 212   // Analysis and profiling.
 213   //
 214   // Usage note: liveness_at_bci and init_vars should be wrapped in ResourceMarks.
 215   bool          has_monitor_bytecodes() const    { return _uses_monitors; }
 216   bool          has_balanced_monitors();
 217 
 218   // Returns a bitmap indicating which locals are required to be
 219   // maintained as live for deopt.  raw_liveness_at_bci is always the
 220   // direct output of the liveness computation while liveness_at_bci
 221   // may mark all locals as live to improve support for debugging Java
 222   // code by maintaining the state of as many locals as possible.
 223   MethodLivenessResult raw_liveness_at_bci(int bci);
 224   MethodLivenessResult liveness_at_bci(int bci);
 225 
 226   // Get the interpreters viewpoint on oop liveness.  MethodLiveness is
 227   // conservative in the sense that it may consider locals to be live which
 228   // cannot be live, like in the case where a local could contain an oop or
 229   // a primitive along different paths.  In that case the local must be
 230   // dead when those paths merge. Since the interpreter's viewpoint is
 231   // used when gc'ing an interpreter frame we need to use its viewpoint
 232   // during OSR when loading the locals.
 233 
 234   BitMap  live_local_oops_at_bci(int bci);
 235 
 236 #ifdef COMPILER1
 237   const BitMap  bci_block_start();
 238 #endif
 239 
 240   ciTypeFlow*   get_flow_analysis();
 241   ciTypeFlow*   get_osr_flow_analysis(int osr_bci);  // alternate entry point
 242   ciCallProfile call_profile_at_bci(int bci);
 243   int           interpreter_call_site_count(int bci);
 244 
 245   // Does type profiling provide any useful information at this point?
 246   bool          argument_profiled_type(int bci, int i, ciKlass*& type, bool& maybe_null);
 247   bool          parameter_profiled_type(int i, ciKlass*& type, bool& maybe_null);
 248   bool          return_profiled_type(int bci, ciKlass*& type, bool& maybe_null);
 249 
 250   ciField*      get_field_at_bci( int bci, bool &will_link);
 251   ciMethod*     get_method_at_bci(int bci, bool &will_link, ciSignature* *declared_signature);
 252   // Given a certain calling environment, find the monomorphic target
 253   // for the call.  Return NULL if the call is not monomorphic in
 254   // its calling environment.
 255   ciMethod* find_monomorphic_target(ciInstanceKlass* caller,
 256                                     ciInstanceKlass* callee_holder,
 257                                     ciInstanceKlass* actual_receiver);
 258 
 259   // Given a known receiver klass, find the target for the call.
 260   // Return NULL if the call has no target or is abstract.
 261   ciMethod* resolve_invoke(ciKlass* caller, ciKlass* exact_receiver);
 262 
 263   // Find the proper vtable index to invoke this method.
 264   int resolve_vtable_index(ciKlass* caller, ciKlass* receiver);
 265 
 266   // Compilation directives
 267   bool should_exclude();
 268   bool should_inline();
 269   bool should_not_inline();
 270   bool should_print_assembly();
 271   bool break_at_execute();
 272   bool has_option(const char *option);
 273   template<typename T>
 274   bool has_option_value(const char* option, T& value);
 275   bool can_be_compiled();
 276   bool can_be_osr_compiled(int entry_bci);
 277   void set_not_compilable(const char* reason = NULL);
 278   bool has_compiled_code();
 279   void log_nmethod_identity(xmlStream* log);
 280   bool is_not_reached(int bci);
 281   bool was_executed_more_than(int times);
 282   bool has_unloaded_classes_in_signature();
 283   bool is_klass_loaded(int refinfo_index, bool must_be_resolved) const;
 284   bool check_call(int refinfo_index, bool is_static) const;
 285   bool ensure_method_data();  // make sure it exists in the VM also
 286   MethodCounters* ensure_method_counters();
 287   int instructions_size();
 288   int scale_count(int count, float prof_factor = 1.);  // make MDO count commensurate with IIC
 289 
 290   // Stack walking support
 291   bool is_ignored_by_security_stack_walk() const;
 292 
 293   // JSR 292 support
 294   bool is_method_handle_intrinsic()  const;
 295   bool is_compiled_lambda_form() const;
 296   bool has_member_arg() const;
 297 
 298   // What kind of ciObject is this?
 299   bool is_method() const                         { return true; }
 300 
 301   // Java access flags
 302   bool is_public      () const                   { return flags().is_public(); }
 303   bool is_private     () const                   { return flags().is_private(); }
 304   bool is_protected   () const                   { return flags().is_protected(); }
 305   bool is_static      () const                   { return flags().is_static(); }
 306   bool is_final       () const                   { return flags().is_final(); }
 307   bool is_synchronized() const                   { return flags().is_synchronized(); }
 308   bool is_native      () const                   { return flags().is_native(); }
 309   bool is_interface   () const                   { return flags().is_interface(); }
 310   bool is_abstract    () const                   { return flags().is_abstract(); }
 311   bool is_strict      () const                   { return flags().is_strict(); }
 312 
 313   // Other flags
 314   bool is_empty_method() const;
 315   bool is_vanilla_constructor() const;
 316   bool is_final_method() const                   { return is_final() || holder()->is_final(); }
 317   bool has_loops      () const;
 318   bool has_jsrs       () const;
 319   bool is_accessor    () const;
 320   bool is_initializer () const;
 321   bool can_be_statically_bound() const           { return _can_be_statically_bound; }
 322   bool is_boxing_method() const;
 323   bool is_unboxing_method() const;
 324 
 325   // Replay data methods
 326   void dump_name_as_ascii(outputStream* st);
 327   void dump_replay_data(outputStream* st);
 328 
 329   // Print the bytecodes of this method.
 330   void print_codes_on(outputStream* st);
 331   void print_codes() {
 332     print_codes_on(tty);
 333   }
 334   void print_codes_on(int from, int to, outputStream* st);
 335 
 336   // Print the name of this method in various incarnations.
 337   void print_name(outputStream* st = tty);
 338   void print_short_name(outputStream* st = tty);
 339 };
 340 
 341 #endif // SHARE_VM_CI_CIMETHOD_HPP