1 /*
   2  * Copyright (c) 2001, 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_CIMETHODDATA_HPP
  26 #define SHARE_VM_CI_CIMETHODDATA_HPP
  27 
  28 #include "ci/ciClassList.hpp"
  29 #include "ci/ciKlass.hpp"
  30 #include "ci/ciObject.hpp"
  31 #include "ci/ciUtilities.hpp"
  32 #include "oops/methodData.hpp"
  33 #include "oops/oop.inline.hpp"
  34 
  35 class ciBitData;
  36 class ciCounterData;
  37 class ciJumpData;
  38 class ciReceiverTypeData;
  39 class ciRetData;
  40 class ciBranchData;
  41 class ciArrayData;
  42 class ciMultiBranchData;
  43 class ciArgInfoData;
  44 class ciCallTypeData;
  45 class ciVirtualCallTypeData;
  46 
  47 typedef ProfileData ciProfileData;
  48 
  49 class ciBitData : public BitData {
  50 public:
  51   ciBitData(DataLayout* layout) : BitData(layout) {};
  52 };
  53 
  54 class ciCounterData : public CounterData {
  55 public:
  56   ciCounterData(DataLayout* layout) : CounterData(layout) {};
  57 };
  58 
  59 class ciJumpData : public JumpData {
  60 public:
  61   ciJumpData(DataLayout* layout) : JumpData(layout) {};
  62 };
  63 
  64 class ciTypeEntries {
  65 protected:
  66   static intptr_t translate_klass(intptr_t k) {
  67     Klass* v = TypeEntries::valid_klass(k);
  68     if (v != NULL) {
  69       ciKlass* klass = CURRENT_ENV->get_klass(v);
  70       return with_status(klass, k);
  71     }
  72     return with_status(NULL, k);
  73   }
  74 
  75 public:
  76   static ciKlass* valid_ciklass(intptr_t k) {
  77     if (!TypeEntries::is_type_none(k) &&
  78         !TypeEntries::is_type_unknown(k)) {
  79       return (ciKlass*)TypeEntries::klass_part(k);
  80     } else {
  81       return NULL;
  82     }
  83   }
  84 
  85   static intptr_t with_status(ciKlass* k, intptr_t in) {
  86     return TypeEntries::with_status((intptr_t)k, in);
  87   }
  88 
  89 #ifndef PRODUCT
  90   static void print_ciklass(outputStream* st, intptr_t k);
  91 #endif
  92 };
  93 
  94 class ciTypeStackSlotEntries : public TypeStackSlotEntries, ciTypeEntries {
  95 public:
  96   void translate_type_data_from(const TypeStackSlotEntries* args);
  97 
  98   ciKlass* valid_type(int i) const {
  99     return valid_ciklass(type(i));
 100   }
 101 
 102 #ifndef PRODUCT
 103   void print_data_on(outputStream* st) const;
 104 #endif
 105 };
 106 
 107 class ciCallTypeData : public CallTypeData {
 108 public:
 109   ciCallTypeData(DataLayout* layout) : CallTypeData(layout) {}
 110 
 111   ciTypeStackSlotEntries* args() const { return (ciTypeStackSlotEntries*)CallTypeData::args(); }
 112 
 113   virtual void translate_from(const ProfileData* data) {
 114     args()->translate_type_data_from(data->as_CallTypeData()->args());
 115   }
 116 
 117   ciKlass* valid_argument_type(int i) const {
 118     return args()->valid_type(i);
 119   }
 120 
 121 #ifndef PRODUCT
 122   void print_data_on(outputStream* st) const;
 123 #endif
 124 };
 125 
 126 class ciReceiverTypeData : public ReceiverTypeData {
 127 public:
 128   ciReceiverTypeData(DataLayout* layout) : ReceiverTypeData(layout) {};
 129 
 130   void set_receiver(uint row, ciKlass* recv) {
 131     assert((uint)row < row_limit(), "oob");
 132     set_intptr_at(receiver0_offset + row * receiver_type_row_cell_count,
 133                   (intptr_t) recv);
 134   }
 135 
 136   ciKlass* receiver(uint row) const {
 137     assert((uint)row < row_limit(), "oob");
 138     ciKlass* recv = (ciKlass*)intptr_at(receiver0_offset + row * receiver_type_row_cell_count);
 139     assert(recv == NULL || recv->is_klass(), "wrong type");
 140     return recv;
 141   }
 142 
 143   // Copy & translate from oop based ReceiverTypeData
 144   virtual void translate_from(const ProfileData* data) {
 145     translate_receiver_data_from(data);
 146   }
 147   void translate_receiver_data_from(const ProfileData* data);
 148 #ifndef PRODUCT
 149   void print_data_on(outputStream* st) const;
 150   void print_receiver_data_on(outputStream* st) const;
 151 #endif
 152 };
 153 
 154 class ciVirtualCallData : public VirtualCallData {
 155   // Fake multiple inheritance...  It's a ciReceiverTypeData also.
 156   ciReceiverTypeData* rtd_super() const { return (ciReceiverTypeData*) this; }
 157 
 158 public:
 159   ciVirtualCallData(DataLayout* layout) : VirtualCallData(layout) {};
 160 
 161   void set_receiver(uint row, ciKlass* recv) {
 162     rtd_super()->set_receiver(row, recv);
 163   }
 164 
 165   ciKlass* receiver(uint row) {
 166     return rtd_super()->receiver(row);
 167   }
 168 
 169   // Copy & translate from oop based VirtualCallData
 170   virtual void translate_from(const ProfileData* data) {
 171     rtd_super()->translate_receiver_data_from(data);
 172   }
 173 #ifndef PRODUCT
 174   void print_data_on(outputStream* st) const;
 175 #endif
 176 };
 177 
 178 class ciVirtualCallTypeData : public VirtualCallTypeData {
 179 private:
 180   // Fake multiple inheritance...  It's a ciReceiverTypeData also.
 181   ciReceiverTypeData* rtd_super() const { return (ciReceiverTypeData*) this; }
 182 
 183 public:
 184   ciVirtualCallTypeData(DataLayout* layout) : VirtualCallTypeData(layout) {}
 185 
 186   ciTypeStackSlotEntries* args() const { return (ciTypeStackSlotEntries*)VirtualCallTypeData::args(); }
 187 
 188   void set_receiver(uint row, ciKlass* recv) {
 189     rtd_super()->set_receiver(row, recv);
 190   }
 191 
 192   ciKlass* receiver(uint row) const {
 193     return rtd_super()->receiver(row);
 194   }
 195 
 196   // Copy & translate from oop based VirtualCallData
 197   virtual void translate_from(const ProfileData* data) {
 198     rtd_super()->translate_receiver_data_from(data);
 199     args()->translate_type_data_from(data->as_VirtualCallTypeData()->args());
 200   }
 201 
 202   ciKlass* valid_argument_type(int i) const {
 203     return args()->valid_type(i);
 204   }
 205 
 206 #ifndef PRODUCT
 207   void print_data_on(outputStream* st) const;
 208 #endif
 209 };
 210 
 211 
 212 class ciRetData : public RetData {
 213 public:
 214   ciRetData(DataLayout* layout) : RetData(layout) {};
 215 };
 216 
 217 class ciBranchData : public BranchData {
 218 public:
 219   ciBranchData(DataLayout* layout) : BranchData(layout) {};
 220 };
 221 
 222 class ciArrayData : public ArrayData {
 223 public:
 224   ciArrayData(DataLayout* layout) : ArrayData(layout) {};
 225 };
 226 
 227 class ciMultiBranchData : public MultiBranchData {
 228 public:
 229   ciMultiBranchData(DataLayout* layout) : MultiBranchData(layout) {};
 230 };
 231 
 232 class ciArgInfoData : public ArgInfoData {
 233 public:
 234   ciArgInfoData(DataLayout* layout) : ArgInfoData(layout) {};
 235 };
 236 
 237 // ciMethodData
 238 //
 239 // This class represents a MethodData* in the HotSpot virtual
 240 // machine.
 241 
 242 class ciMethodData : public ciMetadata {
 243   CI_PACKAGE_ACCESS
 244   friend class ciReplay;
 245 
 246 private:
 247   // Size in bytes
 248   int _data_size;
 249   int _extra_data_size;
 250 
 251   // Data entries
 252   intptr_t* _data;
 253 
 254   // Cached hint for data_before()
 255   int _hint_di;
 256 
 257   // Is data attached?  And is it mature?
 258   enum { empty_state, immature_state, mature_state };
 259   u_char _state;
 260 
 261   // Set this true if empty extra_data slots are ever witnessed.
 262   u_char _saw_free_extra_data;
 263 
 264   // Support for interprocedural escape analysis
 265   intx              _eflags;          // flags on escape information
 266   intx              _arg_local;       // bit set of non-escaping arguments
 267   intx              _arg_stack;       // bit set of stack-allocatable arguments
 268   intx              _arg_returned;    // bit set of returned arguments
 269 
 270   // Maturity of the oop when the snapshot is taken.
 271   int _current_mileage;
 272 
 273   // These counters hold the age of MDO in tiered. In tiered we can have the same method
 274   // running at different compilation levels concurrently. So, in order to precisely measure
 275   // its maturity we need separate counters.
 276   int _invocation_counter;
 277   int _backedge_counter;
 278 
 279   // Coherent snapshot of original header.
 280   MethodData _orig;
 281 
 282   ciMethodData(MethodData* md);
 283   ciMethodData();
 284 
 285   // Accessors
 286   int data_size() const { return _data_size; }
 287   int extra_data_size() const { return _extra_data_size; }
 288   intptr_t * data() const { return _data; }
 289 
 290   MethodData* get_MethodData() const {
 291     return (MethodData*)_metadata;
 292   }
 293 
 294   const char* type_string()                      { return "ciMethodData"; }
 295 
 296   void print_impl(outputStream* st);
 297 
 298   DataLayout* data_layout_at(int data_index) const {
 299     assert(data_index % sizeof(intptr_t) == 0, "unaligned");
 300     return (DataLayout*) (((address)_data) + data_index);
 301   }
 302 
 303   bool out_of_bounds(int data_index) {
 304     return data_index >= data_size();
 305   }
 306 
 307   // hint accessors
 308   int      hint_di() const  { return _hint_di; }
 309   void set_hint_di(int di)  {
 310     assert(!out_of_bounds(di), "hint_di out of bounds");
 311     _hint_di = di;
 312   }
 313   ciProfileData* data_before(int bci) {
 314     // avoid SEGV on this edge case
 315     if (data_size() == 0)
 316       return NULL;
 317     int hint = hint_di();
 318     if (data_layout_at(hint)->bci() <= bci)
 319       return data_at(hint);
 320     return first_data();
 321   }
 322 
 323 
 324   // What is the index of the first data entry?
 325   int first_di() { return 0; }
 326 
 327   ciArgInfoData *arg_info() const;
 328 
 329 public:
 330   bool is_method_data() const { return true; }
 331 
 332   bool is_empty()  { return _state == empty_state; }
 333   bool is_mature() { return _state == mature_state; }
 334 
 335   int creation_mileage() { return _orig.creation_mileage(); }
 336   int current_mileage()  { return _current_mileage; }
 337 
 338   int invocation_count() { return _invocation_counter; }
 339   int backedge_count()   { return _backedge_counter;   }
 340   // Transfer information about the method to MethodData*.
 341   // would_profile means we would like to profile this method,
 342   // meaning it's not trivial.
 343   void set_would_profile(bool p);
 344   // Also set the numer of loops and blocks in the method.
 345   // Again, this is used to determine if a method is trivial.
 346   void set_compilation_stats(short loops, short blocks);
 347   // If the compiler finds a profiled type that is known statically
 348   // for sure, set it in the MethodData
 349   void set_argument_type(int bci, int i, ciKlass* k);
 350 
 351   void load_data();
 352 
 353   // Convert a dp (data pointer) to a di (data index).
 354   int dp_to_di(address dp) {
 355     return dp - ((address)_data);
 356   }
 357 
 358   // Get the data at an arbitrary (sort of) data index.
 359   ciProfileData* data_at(int data_index);
 360 
 361   // Walk through the data in order.
 362   ciProfileData* first_data() { return data_at(first_di()); }
 363   ciProfileData* next_data(ciProfileData* current);
 364   bool is_valid(ciProfileData* current) { return current != NULL; }
 365 
 366   // Get the data at an arbitrary bci, or NULL if there is none.
 367   ciProfileData* bci_to_data(int bci);
 368   ciProfileData* bci_to_extra_data(int bci, bool create_if_missing);
 369 
 370   uint overflow_trap_count() const {
 371     return _orig.overflow_trap_count();
 372   }
 373   uint overflow_recompile_count() const {
 374     return _orig.overflow_recompile_count();
 375   }
 376   uint decompile_count() const {
 377     return _orig.decompile_count();
 378   }
 379   uint trap_count(int reason) const {
 380     return _orig.trap_count(reason);
 381   }
 382   uint trap_reason_limit() const { return _orig.trap_reason_limit(); }
 383   uint trap_count_limit()  const { return _orig.trap_count_limit(); }
 384 
 385   // Helpful query functions that decode trap_state.
 386   int has_trap_at(ciProfileData* data, int reason);
 387   int has_trap_at(int bci, int reason) {
 388     return has_trap_at(bci_to_data(bci), reason);
 389   }
 390   int trap_recompiled_at(ciProfileData* data);
 391   int trap_recompiled_at(int bci) {
 392     return trap_recompiled_at(bci_to_data(bci));
 393   }
 394 
 395   void clear_escape_info();
 396   bool has_escape_info();
 397   void update_escape_info();
 398 
 399   void set_eflag(MethodData::EscapeFlag f);
 400   void clear_eflag(MethodData::EscapeFlag f);
 401   bool eflag_set(MethodData::EscapeFlag f) const;
 402 
 403   void set_arg_local(int i);
 404   void set_arg_stack(int i);
 405   void set_arg_returned(int i);
 406   void set_arg_modified(int arg, uint val);
 407 
 408   bool is_arg_local(int i) const;
 409   bool is_arg_stack(int i) const;
 410   bool is_arg_returned(int i) const;
 411   uint arg_modified(int arg) const;
 412 
 413   // Code generation helper
 414   ByteSize offset_of_slot(ciProfileData* data, ByteSize slot_offset_in_data);
 415   int      byte_offset_of_slot(ciProfileData* data, ByteSize slot_offset_in_data) { return in_bytes(offset_of_slot(data, slot_offset_in_data)); }
 416 
 417 #ifndef PRODUCT
 418   // printing support for method data
 419   void print();
 420   void print_data_on(outputStream* st);
 421 #endif
 422   void dump_replay_data(outputStream* out);
 423 };
 424 
 425 #endif // SHARE_VM_CI_CIMETHODDATA_HPP