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