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