1 /*
2 * Copyright (c) 2000, 2021, 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_OOPS_METHODDATA_HPP
26 #define SHARE_OOPS_METHODDATA_HPP
27
28 #include "interpreter/bytecodes.hpp"
29 #include "oops/metadata.hpp"
30 #include "oops/method.hpp"
31 #include "oops/oop.hpp"
32 #include "runtime/atomic.hpp"
33 #include "runtime/mutex.hpp"
34 #include "utilities/align.hpp"
35 #include "utilities/copy.hpp"
36
37 class BytecodeStream;
38
39 // The MethodData object collects counts and other profile information
40 // during zeroth-tier (interpretive) and first-tier execution.
41 // The profile is used later by compilation heuristics. Some heuristics
42 // enable use of aggressive (or "heroic") optimizations. An aggressive
43 // optimization often has a down-side, a corner case that it handles
44 // poorly, but which is thought to be rare. The profile provides
45 // evidence of this rarity for a given method or even BCI. It allows
46 // the compiler to back out of the optimization at places where it
47 // has historically been a poor choice. Other heuristics try to use
48 // specific information gathered about types observed at a given site.
49 //
50 // All data in the profile is approximate. It is expected to be accurate
51 // on the whole, but the system expects occasional inaccuraces, due to
52 // counter overflow, multiprocessor races during data collection, space
53 // limitations, missing MDO blocks, etc. Bad or missing data will degrade
54 // optimization quality but will not affect correctness. Also, each MDO
55 // is marked with its birth-date ("creation_mileage") which can be used
56 // to assess the quality ("maturity") of its data.
57 //
58 // Short (<32-bit) counters are designed to overflow to a known "saturated"
59 // state. Also, certain recorded per-BCI events are given one-bit counters
60 // which overflow to a saturated state which applied to all counters at
61 // that BCI. In other words, there is a small lattice which approximates
62 // the ideal of an infinite-precision counter for each event at each BCI,
63 // and the lattice quickly "bottoms out" in a state where all counters
64 // are taken to be indefinitely large.
65 //
66 // The reader will find many data races in profile gathering code, starting
67 // with invocation counter incrementation. None of these races harm correct
68 // execution of the compiled code.
69
70 // forward decl
71 class ProfileData;
72
73 // DataLayout
74 //
75 // Overlay for generic profiling data.
76 class DataLayout {
77 friend class VMStructs;
78 friend class JVMCIVMStructs;
79
80 private:
81 // Every data layout begins with a header. This header
82 // contains a tag, which is used to indicate the size/layout
83 // of the data, 8 bits of flags, which can be used in any way,
84 // 32 bits of trap history (none/one reason/many reasons),
85 // and a bci, which is used to tie this piece of data to a
86 // specific bci in the bytecodes.
87 union {
88 u8 _bits;
89 struct {
90 u1 _tag;
91 u1 _flags;
92 u2 _bci;
93 u4 _traps;
94 } _struct;
95 } _header;
96
97 // The data layout has an arbitrary number of cells, each sized
98 // to accomodate a pointer or an integer.
99 intptr_t _cells[1];
100
101 // Some types of data layouts need a length field.
102 static bool needs_array_len(u1 tag);
103
104 public:
105 enum {
106 counter_increment = 1
107 };
108
109 enum {
110 cell_size = sizeof(intptr_t)
111 };
112
113 // Tag values
114 enum {
115 no_tag,
116 bit_data_tag,
117 counter_data_tag,
118 jump_data_tag,
119 receiver_type_data_tag,
120 virtual_call_data_tag,
121 ret_data_tag,
122 branch_data_tag,
123 multi_branch_data_tag,
124 arg_info_data_tag,
125 call_type_data_tag,
126 virtual_call_type_data_tag,
127 parameters_type_data_tag,
128 speculative_trap_data_tag
129 };
130
131 enum {
132 // The trap state breaks down as [recompile:1 | reason:31].
133 // This further breakdown is defined in deoptimization.cpp.
134 // See Deoptimization::trap_state_reason for an assert that
135 // trap_bits is big enough to hold reasons < Reason_RECORDED_LIMIT.
136 //
137 // The trap_state is collected only if ProfileTraps is true.
138 trap_bits = 1+31, // 31: enough to distinguish [0..Reason_RECORDED_LIMIT].
139 trap_mask = -1,
140 first_flag = 0
141 };
142
143 // Size computation
144 static int header_size_in_bytes() {
145 return header_size_in_cells() * cell_size;
146 }
147 static int header_size_in_cells() {
148 return LP64_ONLY(1) NOT_LP64(2);
149 }
150
151 static int compute_size_in_bytes(int cell_count) {
152 return header_size_in_bytes() + cell_count * cell_size;
153 }
154
155 // Initialization
156 void initialize(u1 tag, u2 bci, int cell_count);
157
158 // Accessors
159 u1 tag() {
160 return _header._struct._tag;
161 }
162
163 // Return 32 bits of trap state.
164 // The state tells if traps with zero, one, or many reasons have occurred.
165 // It also tells whether zero or many recompilations have occurred.
166 // The associated trap histogram in the MDO itself tells whether
167 // traps are common or not. If a BCI shows that a trap X has
168 // occurred, and the MDO shows N occurrences of X, we make the
169 // simplifying assumption that all N occurrences can be blamed
170 // on that BCI.
171 uint trap_state() const {
172 return _header._struct._traps;
173 }
174
175 void set_trap_state(uint new_state) {
176 assert(ProfileTraps, "used only under +ProfileTraps");
177 uint old_flags = _header._struct._traps;
178 _header._struct._traps = new_state | old_flags;
179 }
180
181 u1 flags() const {
182 return _header._struct._flags;
183 }
184
185 u2 bci() const {
186 return _header._struct._bci;
187 }
188
189 void set_header(u8 value) {
190 _header._bits = value;
191 }
192 u8 header() {
193 return _header._bits;
194 }
195 void set_cell_at(int index, intptr_t value) {
196 _cells[index] = value;
197 }
198 void release_set_cell_at(int index, intptr_t value);
199 intptr_t cell_at(int index) const {
200 return _cells[index];
201 }
202
203 void set_flag_at(u1 flag_number) {
204 _header._struct._flags |= (0x1 << flag_number);
205 }
206 bool flag_at(u1 flag_number) const {
207 return (_header._struct._flags & (0x1 << flag_number)) != 0;
208 }
209
210 // Low-level support for code generation.
211 static ByteSize header_offset() {
212 return byte_offset_of(DataLayout, _header);
213 }
214 static ByteSize tag_offset() {
215 return byte_offset_of(DataLayout, _header._struct._tag);
216 }
217 static ByteSize flags_offset() {
218 return byte_offset_of(DataLayout, _header._struct._flags);
219 }
220 static ByteSize bci_offset() {
221 return byte_offset_of(DataLayout, _header._struct._bci);
222 }
223 static ByteSize cell_offset(int index) {
224 return byte_offset_of(DataLayout, _cells) + in_ByteSize(index * cell_size);
225 }
226 // Return a value which, when or-ed as a byte into _flags, sets the flag.
227 static u1 flag_number_to_constant(u1 flag_number) {
228 DataLayout temp; temp.set_header(0);
229 temp.set_flag_at(flag_number);
230 return temp._header._struct._flags;
231 }
232 // Return a value which, when or-ed as a word into _header, sets the flag.
233 static u8 flag_mask_to_header_mask(uint byte_constant) {
234 DataLayout temp; temp.set_header(0);
235 temp._header._struct._flags = byte_constant;
236 return temp._header._bits;
237 }
238
239 ProfileData* data_in();
240
241 int size_in_bytes() {
242 int cells = cell_count();
243 assert(cells >= 0, "invalid number of cells");
244 return DataLayout::compute_size_in_bytes(cells);
245 }
246 int cell_count();
247
248 // GC support
249 void clean_weak_klass_links(bool always_clean);
250 };
251
252
253 // ProfileData class hierarchy
254 class ProfileData;
255 class BitData;
256 class CounterData;
257 class ReceiverTypeData;
258 class VirtualCallData;
259 class VirtualCallTypeData;
260 class RetData;
261 class CallTypeData;
262 class JumpData;
263 class BranchData;
264 class ArrayData;
265 class MultiBranchData;
266 class ArgInfoData;
267 class ParametersTypeData;
268 class SpeculativeTrapData;
269
270 // ProfileData
271 //
272 // A ProfileData object is created to refer to a section of profiling
273 // data in a structured way.
274 class ProfileData : public ResourceObj {
275 friend class TypeEntries;
276 friend class ReturnTypeEntry;
277 friend class TypeStackSlotEntries;
278 private:
279 enum {
280 tab_width_one = 16,
281 tab_width_two = 36
282 };
283
284 // This is a pointer to a section of profiling data.
285 DataLayout* _data;
286
287 char* print_data_on_helper(const MethodData* md) const;
288
289 protected:
290 DataLayout* data() { return _data; }
291 const DataLayout* data() const { return _data; }
292
293 enum {
294 cell_size = DataLayout::cell_size
295 };
296
297 public:
298 // How many cells are in this?
299 virtual int cell_count() const {
300 ShouldNotReachHere();
301 return -1;
302 }
303
304 // Return the size of this data.
305 int size_in_bytes() {
306 return DataLayout::compute_size_in_bytes(cell_count());
307 }
308
309 protected:
310 // Low-level accessors for underlying data
311 void set_intptr_at(int index, intptr_t value) {
312 assert(0 <= index && index < cell_count(), "oob");
313 data()->set_cell_at(index, value);
314 }
315 void release_set_intptr_at(int index, intptr_t value);
316 intptr_t intptr_at(int index) const {
317 assert(0 <= index && index < cell_count(), "oob");
318 return data()->cell_at(index);
319 }
320 void set_uint_at(int index, uint value) {
321 set_intptr_at(index, (intptr_t) value);
322 }
323 void release_set_uint_at(int index, uint value);
324 uint uint_at(int index) const {
325 return (uint)intptr_at(index);
326 }
327 void set_int_at(int index, int value) {
328 set_intptr_at(index, (intptr_t) value);
329 }
330 void release_set_int_at(int index, int value);
331 int int_at(int index) const {
332 return (int)intptr_at(index);
333 }
334 int int_at_unchecked(int index) const {
335 return (int)data()->cell_at(index);
336 }
337 void set_oop_at(int index, oop value) {
338 set_intptr_at(index, cast_from_oop<intptr_t>(value));
339 }
340 oop oop_at(int index) const {
341 return cast_to_oop(intptr_at(index));
342 }
343
344 void set_flag_at(int flag_number) {
345 data()->set_flag_at(flag_number);
346 }
347 bool flag_at(int flag_number) const {
348 return data()->flag_at(flag_number);
349 }
350
351 // two convenient imports for use by subclasses:
352 static ByteSize cell_offset(int index) {
353 return DataLayout::cell_offset(index);
354 }
355 static int flag_number_to_constant(int flag_number) {
356 return DataLayout::flag_number_to_constant(flag_number);
357 }
358
359 ProfileData(DataLayout* data) {
360 _data = data;
361 }
362
363 public:
364 // Constructor for invalid ProfileData.
365 ProfileData();
366
367 u2 bci() const {
368 return data()->bci();
369 }
370
371 address dp() {
372 return (address)_data;
373 }
374
375 int trap_state() const {
376 return data()->trap_state();
377 }
378 void set_trap_state(int new_state) {
379 data()->set_trap_state(new_state);
380 }
381
382 // Type checking
383 virtual bool is_BitData() const { return false; }
384 virtual bool is_CounterData() const { return false; }
385 virtual bool is_JumpData() const { return false; }
386 virtual bool is_ReceiverTypeData()const { return false; }
387 virtual bool is_VirtualCallData() const { return false; }
388 virtual bool is_RetData() const { return false; }
389 virtual bool is_BranchData() const { return false; }
390 virtual bool is_ArrayData() const { return false; }
391 virtual bool is_MultiBranchData() const { return false; }
392 virtual bool is_ArgInfoData() const { return false; }
393 virtual bool is_CallTypeData() const { return false; }
394 virtual bool is_VirtualCallTypeData()const { return false; }
395 virtual bool is_ParametersTypeData() const { return false; }
396 virtual bool is_SpeculativeTrapData()const { return false; }
397
398
399 BitData* as_BitData() const {
400 assert(is_BitData(), "wrong type");
401 return is_BitData() ? (BitData*) this : NULL;
402 }
403 CounterData* as_CounterData() const {
404 assert(is_CounterData(), "wrong type");
405 return is_CounterData() ? (CounterData*) this : NULL;
406 }
407 JumpData* as_JumpData() const {
408 assert(is_JumpData(), "wrong type");
409 return is_JumpData() ? (JumpData*) this : NULL;
410 }
411 ReceiverTypeData* as_ReceiverTypeData() const {
412 assert(is_ReceiverTypeData(), "wrong type");
413 return is_ReceiverTypeData() ? (ReceiverTypeData*)this : NULL;
414 }
415 VirtualCallData* as_VirtualCallData() const {
416 assert(is_VirtualCallData(), "wrong type");
417 return is_VirtualCallData() ? (VirtualCallData*)this : NULL;
418 }
419 RetData* as_RetData() const {
420 assert(is_RetData(), "wrong type");
421 return is_RetData() ? (RetData*) this : NULL;
422 }
423 BranchData* as_BranchData() const {
424 assert(is_BranchData(), "wrong type");
425 return is_BranchData() ? (BranchData*) this : NULL;
426 }
427 ArrayData* as_ArrayData() const {
428 assert(is_ArrayData(), "wrong type");
429 return is_ArrayData() ? (ArrayData*) this : NULL;
430 }
431 MultiBranchData* as_MultiBranchData() const {
432 assert(is_MultiBranchData(), "wrong type");
433 return is_MultiBranchData() ? (MultiBranchData*)this : NULL;
434 }
435 ArgInfoData* as_ArgInfoData() const {
436 assert(is_ArgInfoData(), "wrong type");
437 return is_ArgInfoData() ? (ArgInfoData*)this : NULL;
438 }
439 CallTypeData* as_CallTypeData() const {
440 assert(is_CallTypeData(), "wrong type");
441 return is_CallTypeData() ? (CallTypeData*)this : NULL;
442 }
443 VirtualCallTypeData* as_VirtualCallTypeData() const {
444 assert(is_VirtualCallTypeData(), "wrong type");
445 return is_VirtualCallTypeData() ? (VirtualCallTypeData*)this : NULL;
446 }
447 ParametersTypeData* as_ParametersTypeData() const {
448 assert(is_ParametersTypeData(), "wrong type");
449 return is_ParametersTypeData() ? (ParametersTypeData*)this : NULL;
450 }
451 SpeculativeTrapData* as_SpeculativeTrapData() const {
452 assert(is_SpeculativeTrapData(), "wrong type");
453 return is_SpeculativeTrapData() ? (SpeculativeTrapData*)this : NULL;
454 }
455
456
457 // Subclass specific initialization
458 virtual void post_initialize(BytecodeStream* stream, MethodData* mdo) {}
459
460 // GC support
461 virtual void clean_weak_klass_links(bool always_clean) {}
462
463 // CI translation: ProfileData can represent both MethodDataOop data
464 // as well as CIMethodData data. This function is provided for translating
465 // an oop in a ProfileData to the ci equivalent. Generally speaking,
466 // most ProfileData don't require any translation, so we provide the null
467 // translation here, and the required translators are in the ci subclasses.
468 virtual void translate_from(const ProfileData* data) {}
469
470 virtual void print_data_on(outputStream* st, const char* extra = NULL) const {
471 ShouldNotReachHere();
472 }
473
474 void print_data_on(outputStream* st, const MethodData* md) const;
475
476 void print_shared(outputStream* st, const char* name, const char* extra) const;
477 void tab(outputStream* st, bool first = false) const;
478 };
479
480 // BitData
481 //
482 // A BitData holds a flag or two in its header.
483 class BitData : public ProfileData {
484 friend class VMStructs;
485 friend class JVMCIVMStructs;
486 protected:
487 enum {
488 // null_seen:
489 // saw a null operand (cast/aastore/instanceof)
490 null_seen_flag = DataLayout::first_flag + 0
491 #if INCLUDE_JVMCI
492 // bytecode threw any exception
493 , exception_seen_flag = null_seen_flag + 1
494 #endif
495 };
496 enum { bit_cell_count = 0 }; // no additional data fields needed.
497 public:
498 BitData(DataLayout* layout) : ProfileData(layout) {
499 }
500
501 virtual bool is_BitData() const { return true; }
502
503 static int static_cell_count() {
504 return bit_cell_count;
505 }
506
507 virtual int cell_count() const {
508 return static_cell_count();
509 }
510
511 // Accessor
512
513 // The null_seen flag bit is specially known to the interpreter.
514 // Consulting it allows the compiler to avoid setting up null_check traps.
515 bool null_seen() { return flag_at(null_seen_flag); }
516 void set_null_seen() { set_flag_at(null_seen_flag); }
517
518 #if INCLUDE_JVMCI
519 // true if an exception was thrown at the specific BCI
520 bool exception_seen() { return flag_at(exception_seen_flag); }
521 void set_exception_seen() { set_flag_at(exception_seen_flag); }
522 #endif
523
524 // Code generation support
525 static int null_seen_byte_constant() {
526 return flag_number_to_constant(null_seen_flag);
527 }
528
529 static ByteSize bit_data_size() {
530 return cell_offset(bit_cell_count);
531 }
532
533 void print_data_on(outputStream* st, const char* extra = NULL) const;
534 };
535
536 // CounterData
537 //
538 // A CounterData corresponds to a simple counter.
539 class CounterData : public BitData {
540 friend class VMStructs;
541 friend class JVMCIVMStructs;
542 protected:
543 enum {
544 count_off,
545 counter_cell_count
546 };
547 public:
548 CounterData(DataLayout* layout) : BitData(layout) {}
549
550 virtual bool is_CounterData() const { return true; }
551
552 static int static_cell_count() {
553 return counter_cell_count;
554 }
555
556 virtual int cell_count() const {
557 return static_cell_count();
558 }
559
560 // Direct accessor
561 int count() const {
562 intptr_t raw_data = intptr_at(count_off);
563 if (raw_data > max_jint) {
564 raw_data = max_jint;
565 } else if (raw_data < min_jint) {
566 raw_data = min_jint;
567 }
568 return int(raw_data);
569 }
570
571 // Code generation support
572 static ByteSize count_offset() {
573 return cell_offset(count_off);
574 }
575 static ByteSize counter_data_size() {
576 return cell_offset(counter_cell_count);
577 }
578
579 void set_count(int count) {
580 set_int_at(count_off, count);
581 }
582
583 void print_data_on(outputStream* st, const char* extra = NULL) const;
584 };
585
586 // JumpData
587 //
588 // A JumpData is used to access profiling information for a direct
589 // branch. It is a counter, used for counting the number of branches,
590 // plus a data displacement, used for realigning the data pointer to
591 // the corresponding target bci.
592 class JumpData : public ProfileData {
593 friend class VMStructs;
594 friend class JVMCIVMStructs;
595 protected:
596 enum {
597 taken_off_set,
598 displacement_off_set,
599 jump_cell_count
600 };
601
602 void set_displacement(int displacement) {
603 set_int_at(displacement_off_set, displacement);
604 }
605
606 public:
607 JumpData(DataLayout* layout) : ProfileData(layout) {
608 assert(layout->tag() == DataLayout::jump_data_tag ||
609 layout->tag() == DataLayout::branch_data_tag, "wrong type");
610 }
611
612 virtual bool is_JumpData() const { return true; }
613
614 static int static_cell_count() {
615 return jump_cell_count;
616 }
617
618 virtual int cell_count() const {
619 return static_cell_count();
620 }
621
622 // Direct accessor
623 uint taken() const {
624 return uint_at(taken_off_set);
625 }
626
627 void set_taken(uint cnt) {
628 set_uint_at(taken_off_set, cnt);
629 }
630
631 // Saturating counter
632 uint inc_taken() {
633 uint cnt = taken() + 1;
634 // Did we wrap? Will compiler screw us??
635 if (cnt == 0) cnt--;
636 set_uint_at(taken_off_set, cnt);
637 return cnt;
638 }
639
640 int displacement() const {
641 return int_at(displacement_off_set);
642 }
643
644 // Code generation support
645 static ByteSize taken_offset() {
646 return cell_offset(taken_off_set);
647 }
648
649 static ByteSize displacement_offset() {
650 return cell_offset(displacement_off_set);
651 }
652
653 // Specific initialization.
654 void post_initialize(BytecodeStream* stream, MethodData* mdo);
655
656 void print_data_on(outputStream* st, const char* extra = NULL) const;
657 };
658
659 // Entries in a ProfileData object to record types: it can either be
660 // none (no profile), unknown (conflicting profile data) or a klass if
661 // a single one is seen. Whether a null reference was seen is also
662 // recorded. No counter is associated with the type and a single type
663 // is tracked (unlike VirtualCallData).
664 class TypeEntries {
665
666 public:
667
668 // A single cell is used to record information for a type:
669 // - the cell is initialized to 0
670 // - when a type is discovered it is stored in the cell
671 // - bit zero of the cell is used to record whether a null reference
672 // was encountered or not
673 // - bit 1 is set to record a conflict in the type information
674
675 enum {
676 null_seen = 1,
677 type_mask = ~null_seen,
678 type_unknown = 2,
679 status_bits = null_seen | type_unknown,
680 type_klass_mask = ~status_bits
681 };
682
683 // what to initialize a cell to
684 static intptr_t type_none() {
685 return 0;
686 }
687
688 // null seen = bit 0 set?
689 static bool was_null_seen(intptr_t v) {
690 return (v & null_seen) != 0;
691 }
692
693 // conflicting type information = bit 1 set?
694 static bool is_type_unknown(intptr_t v) {
695 return (v & type_unknown) != 0;
696 }
697
698 // not type information yet = all bits cleared, ignoring bit 0?
699 static bool is_type_none(intptr_t v) {
700 return (v & type_mask) == 0;
701 }
702
703 // recorded type: cell without bit 0 and 1
704 static intptr_t klass_part(intptr_t v) {
705 intptr_t r = v & type_klass_mask;
706 return r;
707 }
708
709 // type recorded
710 static Klass* valid_klass(intptr_t k) {
711 if (!is_type_none(k) &&
712 !is_type_unknown(k)) {
713 Klass* res = (Klass*)klass_part(k);
714 assert(res != NULL, "invalid");
715 return res;
716 } else {
717 return NULL;
718 }
719 }
720
721 static intptr_t with_status(intptr_t k, intptr_t in) {
722 return k | (in & status_bits);
723 }
724
725 static intptr_t with_status(Klass* k, intptr_t in) {
726 return with_status((intptr_t)k, in);
727 }
728
729 static void print_klass(outputStream* st, intptr_t k);
730
731 protected:
732 // ProfileData object these entries are part of
733 ProfileData* _pd;
734 // offset within the ProfileData object where the entries start
735 const int _base_off;
736
737 TypeEntries(int base_off)
738 : _pd(NULL), _base_off(base_off) {}
739
740 void set_intptr_at(int index, intptr_t value) {
741 _pd->set_intptr_at(index, value);
742 }
743
744 intptr_t intptr_at(int index) const {
745 return _pd->intptr_at(index);
746 }
747
748 public:
749 void set_profile_data(ProfileData* pd) {
750 _pd = pd;
751 }
752 };
753
754 // Type entries used for arguments passed at a call and parameters on
755 // method entry. 2 cells per entry: one for the type encoded as in
756 // TypeEntries and one initialized with the stack slot where the
757 // profiled object is to be found so that the interpreter can locate
758 // it quickly.
759 class TypeStackSlotEntries : public TypeEntries {
760
761 private:
762 enum {
763 stack_slot_entry,
764 type_entry,
765 per_arg_cell_count
766 };
767
768 // offset of cell for stack slot for entry i within ProfileData object
769 int stack_slot_offset(int i) const {
770 return _base_off + stack_slot_local_offset(i);
771 }
772
773 const int _number_of_entries;
774
775 // offset of cell for type for entry i within ProfileData object
776 int type_offset_in_cells(int i) const {
777 return _base_off + type_local_offset(i);
778 }
779
780 public:
781
782 TypeStackSlotEntries(int base_off, int nb_entries)
783 : TypeEntries(base_off), _number_of_entries(nb_entries) {}
784
785 static int compute_cell_count(Symbol* signature, bool include_receiver, int max);
786
787 void post_initialize(Symbol* signature, bool has_receiver, bool include_receiver);
788
789 int number_of_entries() const { return _number_of_entries; }
790
791 // offset of cell for stack slot for entry i within this block of cells for a TypeStackSlotEntries
792 static int stack_slot_local_offset(int i) {
793 return i * per_arg_cell_count + stack_slot_entry;
794 }
795
796 // offset of cell for type for entry i within this block of cells for a TypeStackSlotEntries
797 static int type_local_offset(int i) {
798 return i * per_arg_cell_count + type_entry;
799 }
800
801 // stack slot for entry i
802 uint stack_slot(int i) const {
803 assert(i >= 0 && i < _number_of_entries, "oob");
804 return _pd->uint_at(stack_slot_offset(i));
805 }
806
807 // set stack slot for entry i
808 void set_stack_slot(int i, uint num) {
809 assert(i >= 0 && i < _number_of_entries, "oob");
810 _pd->set_uint_at(stack_slot_offset(i), num);
811 }
812
813 // type for entry i
814 intptr_t type(int i) const {
815 assert(i >= 0 && i < _number_of_entries, "oob");
816 return _pd->intptr_at(type_offset_in_cells(i));
817 }
818
819 // set type for entry i
820 void set_type(int i, intptr_t k) {
821 assert(i >= 0 && i < _number_of_entries, "oob");
822 _pd->set_intptr_at(type_offset_in_cells(i), k);
823 }
824
825 static ByteSize per_arg_size() {
826 return in_ByteSize(per_arg_cell_count * DataLayout::cell_size);
827 }
828
829 static int per_arg_count() {
830 return per_arg_cell_count;
831 }
832
833 ByteSize type_offset(int i) const {
834 return DataLayout::cell_offset(type_offset_in_cells(i));
835 }
836
837 // GC support
838 void clean_weak_klass_links(bool always_clean);
839
840 void print_data_on(outputStream* st) const;
841 };
842
843 // Type entry used for return from a call. A single cell to record the
844 // type.
845 class ReturnTypeEntry : public TypeEntries {
846
847 private:
848 enum {
849 cell_count = 1
850 };
851
852 public:
853 ReturnTypeEntry(int base_off)
854 : TypeEntries(base_off) {}
855
856 void post_initialize() {
857 set_type(type_none());
858 }
859
860 intptr_t type() const {
861 return _pd->intptr_at(_base_off);
862 }
863
864 void set_type(intptr_t k) {
865 _pd->set_intptr_at(_base_off, k);
866 }
867
868 static int static_cell_count() {
869 return cell_count;
870 }
871
872 static ByteSize size() {
873 return in_ByteSize(cell_count * DataLayout::cell_size);
874 }
875
876 ByteSize type_offset() {
877 return DataLayout::cell_offset(_base_off);
878 }
879
880 // GC support
881 void clean_weak_klass_links(bool always_clean);
882
883 void print_data_on(outputStream* st) const;
884 };
885
886 // Entries to collect type information at a call: contains arguments
887 // (TypeStackSlotEntries), a return type (ReturnTypeEntry) and a
888 // number of cells. Because the number of cells for the return type is
889 // smaller than the number of cells for the type of an arguments, the
890 // number of cells is used to tell how many arguments are profiled and
891 // whether a return value is profiled. See has_arguments() and
892 // has_return().
893 class TypeEntriesAtCall {
894 private:
895 static int stack_slot_local_offset(int i) {
896 return header_cell_count() + TypeStackSlotEntries::stack_slot_local_offset(i);
897 }
898
899 static int argument_type_local_offset(int i) {
900 return header_cell_count() + TypeStackSlotEntries::type_local_offset(i);
901 }
902
903 public:
904
905 static int header_cell_count() {
906 return 1;
907 }
908
909 static int cell_count_local_offset() {
910 return 0;
911 }
912
913 static int compute_cell_count(BytecodeStream* stream);
914
915 static void initialize(DataLayout* dl, int base, int cell_count) {
916 int off = base + cell_count_local_offset();
917 dl->set_cell_at(off, cell_count - base - header_cell_count());
918 }
919
920 static bool arguments_profiling_enabled();
921 static bool return_profiling_enabled();
922
923 // Code generation support
924 static ByteSize cell_count_offset() {
925 return in_ByteSize(cell_count_local_offset() * DataLayout::cell_size);
926 }
927
928 static ByteSize args_data_offset() {
929 return in_ByteSize(header_cell_count() * DataLayout::cell_size);
930 }
931
932 static ByteSize stack_slot_offset(int i) {
933 return in_ByteSize(stack_slot_local_offset(i) * DataLayout::cell_size);
934 }
935
936 static ByteSize argument_type_offset(int i) {
937 return in_ByteSize(argument_type_local_offset(i) * DataLayout::cell_size);
938 }
939
940 static ByteSize return_only_size() {
941 return ReturnTypeEntry::size() + in_ByteSize(header_cell_count() * DataLayout::cell_size);
942 }
943
944 };
945
946 // CallTypeData
947 //
948 // A CallTypeData is used to access profiling information about a non
949 // virtual call for which we collect type information about arguments
950 // and return value.
951 class CallTypeData : public CounterData {
952 private:
953 // entries for arguments if any
954 TypeStackSlotEntries _args;
955 // entry for return type if any
956 ReturnTypeEntry _ret;
957
958 int cell_count_global_offset() const {
959 return CounterData::static_cell_count() + TypeEntriesAtCall::cell_count_local_offset();
960 }
961
962 // number of cells not counting the header
963 int cell_count_no_header() const {
964 return uint_at(cell_count_global_offset());
965 }
966
967 void check_number_of_arguments(int total) {
968 assert(number_of_arguments() == total, "should be set in DataLayout::initialize");
969 }
970
971 public:
972 CallTypeData(DataLayout* layout) :
973 CounterData(layout),
974 _args(CounterData::static_cell_count()+TypeEntriesAtCall::header_cell_count(), number_of_arguments()),
975 _ret(cell_count() - ReturnTypeEntry::static_cell_count())
976 {
977 assert(layout->tag() == DataLayout::call_type_data_tag, "wrong type");
978 // Some compilers (VC++) don't want this passed in member initialization list
979 _args.set_profile_data(this);
980 _ret.set_profile_data(this);
981 }
982
983 const TypeStackSlotEntries* args() const {
984 assert(has_arguments(), "no profiling of arguments");
985 return &_args;
986 }
987
988 const ReturnTypeEntry* ret() const {
989 assert(has_return(), "no profiling of return value");
990 return &_ret;
991 }
992
993 virtual bool is_CallTypeData() const { return true; }
994
995 static int static_cell_count() {
996 return -1;
997 }
998
999 static int compute_cell_count(BytecodeStream* stream) {
1000 return CounterData::static_cell_count() + TypeEntriesAtCall::compute_cell_count(stream);
1001 }
1002
1003 static void initialize(DataLayout* dl, int cell_count) {
1004 TypeEntriesAtCall::initialize(dl, CounterData::static_cell_count(), cell_count);
1005 }
1006
1007 virtual void post_initialize(BytecodeStream* stream, MethodData* mdo);
1008
1009 virtual int cell_count() const {
1010 return CounterData::static_cell_count() +
1011 TypeEntriesAtCall::header_cell_count() +
1012 int_at_unchecked(cell_count_global_offset());
1013 }
1014
1015 int number_of_arguments() const {
1016 return cell_count_no_header() / TypeStackSlotEntries::per_arg_count();
1017 }
1018
1019 void set_argument_type(int i, Klass* k) {
1020 assert(has_arguments(), "no arguments!");
1021 intptr_t current = _args.type(i);
1022 _args.set_type(i, TypeEntries::with_status(k, current));
1023 }
1024
1025 void set_return_type(Klass* k) {
1026 assert(has_return(), "no return!");
1027 intptr_t current = _ret.type();
1028 _ret.set_type(TypeEntries::with_status(k, current));
1029 }
1030
1031 // An entry for a return value takes less space than an entry for an
1032 // argument so if the number of cells exceeds the number of cells
1033 // needed for an argument, this object contains type information for
1034 // at least one argument.
1035 bool has_arguments() const {
1036 bool res = cell_count_no_header() >= TypeStackSlotEntries::per_arg_count();
1037 assert (!res || TypeEntriesAtCall::arguments_profiling_enabled(), "no profiling of arguments");
1038 return res;
1039 }
1040
1041 // An entry for a return value takes less space than an entry for an
1042 // argument, so if the remainder of the number of cells divided by
1043 // the number of cells for an argument is not null, a return value
1044 // is profiled in this object.
1045 bool has_return() const {
1046 bool res = (cell_count_no_header() % TypeStackSlotEntries::per_arg_count()) != 0;
1047 assert (!res || TypeEntriesAtCall::return_profiling_enabled(), "no profiling of return values");
1048 return res;
1049 }
1050
1051 // Code generation support
1052 static ByteSize args_data_offset() {
1053 return cell_offset(CounterData::static_cell_count()) + TypeEntriesAtCall::args_data_offset();
1054 }
1055
1056 ByteSize argument_type_offset(int i) {
1057 return _args.type_offset(i);
1058 }
1059
1060 ByteSize return_type_offset() {
1061 return _ret.type_offset();
1062 }
1063
1064 // GC support
1065 virtual void clean_weak_klass_links(bool always_clean) {
1066 if (has_arguments()) {
1067 _args.clean_weak_klass_links(always_clean);
1068 }
1069 if (has_return()) {
1070 _ret.clean_weak_klass_links(always_clean);
1071 }
1072 }
1073
1074 virtual void print_data_on(outputStream* st, const char* extra = NULL) const;
1075 };
1076
1077 // ReceiverTypeData
1078 //
1079 // A ReceiverTypeData is used to access profiling information about a
1080 // dynamic type check. It consists of a counter which counts the total times
1081 // that the check is reached, and a series of (Klass*, count) pairs
1082 // which are used to store a type profile for the receiver of the check.
1083 class ReceiverTypeData : public CounterData {
1084 friend class VMStructs;
1085 friend class JVMCIVMStructs;
1086 protected:
1087 enum {
1088 #if INCLUDE_JVMCI
1089 // Description of the different counters
1090 // ReceiverTypeData for instanceof/checkcast/aastore:
1091 // count is decremented for failed type checks
1092 // JVMCI only: nonprofiled_count is incremented on type overflow
1093 // VirtualCallData for invokevirtual/invokeinterface:
1094 // count is incremented on type overflow
1095 // JVMCI only: nonprofiled_count is incremented on method overflow
1096
1097 // JVMCI is interested in knowing the percentage of type checks involving a type not explicitly in the profile
1098 nonprofiled_count_off_set = counter_cell_count,
1099 receiver0_offset,
1100 #else
1101 receiver0_offset = counter_cell_count,
1102 #endif
1103 count0_offset,
1104 receiver_type_row_cell_count = (count0_offset + 1) - receiver0_offset
1105 };
1106
1107 public:
1108 ReceiverTypeData(DataLayout* layout) : CounterData(layout) {
1109 assert(layout->tag() == DataLayout::receiver_type_data_tag ||
1110 layout->tag() == DataLayout::virtual_call_data_tag ||
1111 layout->tag() == DataLayout::virtual_call_type_data_tag, "wrong type");
1112 }
1113
1114 virtual bool is_ReceiverTypeData() const { return true; }
1115
1116 static int static_cell_count() {
1117 return counter_cell_count + (uint) TypeProfileWidth * receiver_type_row_cell_count JVMCI_ONLY(+ 1);
1118 }
1119
1120 virtual int cell_count() const {
1121 return static_cell_count();
1122 }
1123
1124 // Direct accessors
1125 static uint row_limit() {
1126 return TypeProfileWidth;
1127 }
1128 static int receiver_cell_index(uint row) {
1129 return receiver0_offset + row * receiver_type_row_cell_count;
1130 }
1131 static int receiver_count_cell_index(uint row) {
1132 return count0_offset + row * receiver_type_row_cell_count;
1133 }
1134
1135 Klass* receiver(uint row) const {
1136 assert(row < row_limit(), "oob");
1137
1138 Klass* recv = (Klass*)intptr_at(receiver_cell_index(row));
1139 assert(recv == NULL || recv->is_klass(), "wrong type");
1140 return recv;
1141 }
1142
1143 void set_receiver(uint row, Klass* k) {
1144 assert((uint)row < row_limit(), "oob");
1145 set_intptr_at(receiver_cell_index(row), (uintptr_t)k);
1146 }
1147
1148 uint receiver_count(uint row) const {
1149 assert(row < row_limit(), "oob");
1150 return uint_at(receiver_count_cell_index(row));
1151 }
1152
1153 void set_receiver_count(uint row, uint count) {
1154 assert(row < row_limit(), "oob");
1155 set_uint_at(receiver_count_cell_index(row), count);
1156 }
1157
1158 void clear_row(uint row) {
1159 assert(row < row_limit(), "oob");
1160 // Clear total count - indicator of polymorphic call site.
1161 // The site may look like as monomorphic after that but
1162 // it allow to have more accurate profiling information because
1163 // there was execution phase change since klasses were unloaded.
1164 // If the site is still polymorphic then MDO will be updated
1165 // to reflect it. But it could be the case that the site becomes
1166 // only bimorphic. Then keeping total count not 0 will be wrong.
1167 // Even if we use monomorphic (when it is not) for compilation
1168 // we will only have trap, deoptimization and recompile again
1169 // with updated MDO after executing method in Interpreter.
1170 // An additional receiver will be recorded in the cleaned row
1171 // during next call execution.
1172 //
1173 // Note: our profiling logic works with empty rows in any slot.
1174 // We do sorting a profiling info (ciCallProfile) for compilation.
1175 //
1176 set_count(0);
1177 set_receiver(row, NULL);
1178 set_receiver_count(row, 0);
1179 #if INCLUDE_JVMCI
1180 if (!this->is_VirtualCallData()) {
1181 // if this is a ReceiverTypeData for JVMCI, the nonprofiled_count
1182 // must also be reset (see "Description of the different counters" above)
1183 set_nonprofiled_count(0);
1184 }
1185 #endif
1186 }
1187
1188 // Code generation support
1189 static ByteSize receiver_offset(uint row) {
1190 return cell_offset(receiver_cell_index(row));
1191 }
1192 static ByteSize receiver_count_offset(uint row) {
1193 return cell_offset(receiver_count_cell_index(row));
1194 }
1195 #if INCLUDE_JVMCI
1196 static ByteSize nonprofiled_receiver_count_offset() {
1197 return cell_offset(nonprofiled_count_off_set);
1198 }
1199 uint nonprofiled_count() const {
1200 return uint_at(nonprofiled_count_off_set);
1201 }
1202 void set_nonprofiled_count(uint count) {
1203 set_uint_at(nonprofiled_count_off_set, count);
1204 }
1205 #endif // INCLUDE_JVMCI
1206 static ByteSize receiver_type_data_size() {
1207 return cell_offset(static_cell_count());
1208 }
1209
1210 // GC support
1211 virtual void clean_weak_klass_links(bool always_clean);
1212
1213 void print_receiver_data_on(outputStream* st) const;
1214 void print_data_on(outputStream* st, const char* extra = NULL) const;
1215 };
1216
1217 // VirtualCallData
1218 //
1219 // A VirtualCallData is used to access profiling information about a
1220 // virtual call. For now, it has nothing more than a ReceiverTypeData.
1221 class VirtualCallData : public ReceiverTypeData {
1222 public:
1223 VirtualCallData(DataLayout* layout) : ReceiverTypeData(layout) {
1224 assert(layout->tag() == DataLayout::virtual_call_data_tag ||
1225 layout->tag() == DataLayout::virtual_call_type_data_tag, "wrong type");
1226 }
1227
1228 virtual bool is_VirtualCallData() const { return true; }
1229
1230 static int static_cell_count() {
1231 // At this point we could add more profile state, e.g., for arguments.
1232 // But for now it's the same size as the base record type.
1233 return ReceiverTypeData::static_cell_count();
1234 }
1235
1236 virtual int cell_count() const {
1237 return static_cell_count();
1238 }
1239
1240 // Direct accessors
1241 static ByteSize virtual_call_data_size() {
1242 return cell_offset(static_cell_count());
1243 }
1244
1245 void print_method_data_on(outputStream* st) const NOT_JVMCI_RETURN;
1246 void print_data_on(outputStream* st, const char* extra = NULL) const;
1247 };
1248
1249 // VirtualCallTypeData
1250 //
1251 // A VirtualCallTypeData is used to access profiling information about
1252 // a virtual call for which we collect type information about
1253 // arguments and return value.
1254 class VirtualCallTypeData : public VirtualCallData {
1255 private:
1256 // entries for arguments if any
1257 TypeStackSlotEntries _args;
1258 // entry for return type if any
1259 ReturnTypeEntry _ret;
1260
1261 int cell_count_global_offset() const {
1262 return VirtualCallData::static_cell_count() + TypeEntriesAtCall::cell_count_local_offset();
1263 }
1264
1265 // number of cells not counting the header
1266 int cell_count_no_header() const {
1267 return uint_at(cell_count_global_offset());
1268 }
1269
1270 void check_number_of_arguments(int total) {
1271 assert(number_of_arguments() == total, "should be set in DataLayout::initialize");
1272 }
1273
1274 public:
1275 VirtualCallTypeData(DataLayout* layout) :
1276 VirtualCallData(layout),
1277 _args(VirtualCallData::static_cell_count()+TypeEntriesAtCall::header_cell_count(), number_of_arguments()),
1278 _ret(cell_count() - ReturnTypeEntry::static_cell_count())
1279 {
1280 assert(layout->tag() == DataLayout::virtual_call_type_data_tag, "wrong type");
1281 // Some compilers (VC++) don't want this passed in member initialization list
1282 _args.set_profile_data(this);
1283 _ret.set_profile_data(this);
1284 }
1285
1286 const TypeStackSlotEntries* args() const {
1287 assert(has_arguments(), "no profiling of arguments");
1288 return &_args;
1289 }
1290
1291 const ReturnTypeEntry* ret() const {
1292 assert(has_return(), "no profiling of return value");
1293 return &_ret;
1294 }
1295
1296 virtual bool is_VirtualCallTypeData() const { return true; }
1297
1298 static int static_cell_count() {
1299 return -1;
1300 }
1301
1302 static int compute_cell_count(BytecodeStream* stream) {
1303 return VirtualCallData::static_cell_count() + TypeEntriesAtCall::compute_cell_count(stream);
1304 }
1305
1306 static void initialize(DataLayout* dl, int cell_count) {
1307 TypeEntriesAtCall::initialize(dl, VirtualCallData::static_cell_count(), cell_count);
1308 }
1309
1310 virtual void post_initialize(BytecodeStream* stream, MethodData* mdo);
1311
1312 virtual int cell_count() const {
1313 return VirtualCallData::static_cell_count() +
1314 TypeEntriesAtCall::header_cell_count() +
1315 int_at_unchecked(cell_count_global_offset());
1316 }
1317
1318 int number_of_arguments() const {
1319 return cell_count_no_header() / TypeStackSlotEntries::per_arg_count();
1320 }
1321
1322 void set_argument_type(int i, Klass* k) {
1323 assert(has_arguments(), "no arguments!");
1324 intptr_t current = _args.type(i);
1325 _args.set_type(i, TypeEntries::with_status(k, current));
1326 }
1327
1328 void set_return_type(Klass* k) {
1329 assert(has_return(), "no return!");
1330 intptr_t current = _ret.type();
1331 _ret.set_type(TypeEntries::with_status(k, current));
1332 }
1333
1334 // An entry for a return value takes less space than an entry for an
1335 // argument, so if the remainder of the number of cells divided by
1336 // the number of cells for an argument is not null, a return value
1337 // is profiled in this object.
1338 bool has_return() const {
1339 bool res = (cell_count_no_header() % TypeStackSlotEntries::per_arg_count()) != 0;
1340 assert (!res || TypeEntriesAtCall::return_profiling_enabled(), "no profiling of return values");
1341 return res;
1342 }
1343
1344 // An entry for a return value takes less space than an entry for an
1345 // argument so if the number of cells exceeds the number of cells
1346 // needed for an argument, this object contains type information for
1347 // at least one argument.
1348 bool has_arguments() const {
1349 bool res = cell_count_no_header() >= TypeStackSlotEntries::per_arg_count();
1350 assert (!res || TypeEntriesAtCall::arguments_profiling_enabled(), "no profiling of arguments");
1351 return res;
1352 }
1353
1354 // Code generation support
1355 static ByteSize args_data_offset() {
1356 return cell_offset(VirtualCallData::static_cell_count()) + TypeEntriesAtCall::args_data_offset();
1357 }
1358
1359 ByteSize argument_type_offset(int i) {
1360 return _args.type_offset(i);
1361 }
1362
1363 ByteSize return_type_offset() {
1364 return _ret.type_offset();
1365 }
1366
1367 // GC support
1368 virtual void clean_weak_klass_links(bool always_clean) {
1369 ReceiverTypeData::clean_weak_klass_links(always_clean);
1370 if (has_arguments()) {
1371 _args.clean_weak_klass_links(always_clean);
1372 }
1373 if (has_return()) {
1374 _ret.clean_weak_klass_links(always_clean);
1375 }
1376 }
1377
1378 virtual void print_data_on(outputStream* st, const char* extra = NULL) const;
1379 };
1380
1381 // RetData
1382 //
1383 // A RetData is used to access profiling information for a ret bytecode.
1384 // It is composed of a count of the number of times that the ret has
1385 // been executed, followed by a series of triples of the form
1386 // (bci, count, di) which count the number of times that some bci was the
1387 // target of the ret and cache a corresponding data displacement.
1388 class RetData : public CounterData {
1389 protected:
1390 enum {
1391 bci0_offset = counter_cell_count,
1392 count0_offset,
1393 displacement0_offset,
1394 ret_row_cell_count = (displacement0_offset + 1) - bci0_offset
1395 };
1396
1397 void set_bci(uint row, int bci) {
1398 assert((uint)row < row_limit(), "oob");
1399 set_int_at(bci0_offset + row * ret_row_cell_count, bci);
1400 }
1401 void release_set_bci(uint row, int bci);
1402 void set_bci_count(uint row, uint count) {
1403 assert((uint)row < row_limit(), "oob");
1404 set_uint_at(count0_offset + row * ret_row_cell_count, count);
1405 }
1406 void set_bci_displacement(uint row, int disp) {
1407 set_int_at(displacement0_offset + row * ret_row_cell_count, disp);
1408 }
1409
1410 public:
1411 RetData(DataLayout* layout) : CounterData(layout) {
1412 assert(layout->tag() == DataLayout::ret_data_tag, "wrong type");
1413 }
1414
1415 virtual bool is_RetData() const { return true; }
1416
1417 enum {
1418 no_bci = -1 // value of bci when bci1/2 are not in use.
1419 };
1420
1421 static int static_cell_count() {
1422 return counter_cell_count + (uint) BciProfileWidth * ret_row_cell_count;
1423 }
1424
1425 virtual int cell_count() const {
1426 return static_cell_count();
1427 }
1428
1429 static uint row_limit() {
1430 return BciProfileWidth;
1431 }
1432 static int bci_cell_index(uint row) {
1433 return bci0_offset + row * ret_row_cell_count;
1434 }
1435 static int bci_count_cell_index(uint row) {
1436 return count0_offset + row * ret_row_cell_count;
1437 }
1438 static int bci_displacement_cell_index(uint row) {
1439 return displacement0_offset + row * ret_row_cell_count;
1440 }
1441
1442 // Direct accessors
1443 int bci(uint row) const {
1444 return int_at(bci_cell_index(row));
1445 }
1446 uint bci_count(uint row) const {
1447 return uint_at(bci_count_cell_index(row));
1448 }
1449 int bci_displacement(uint row) const {
1450 return int_at(bci_displacement_cell_index(row));
1451 }
1452
1453 // Interpreter Runtime support
1454 address fixup_ret(int return_bci, MethodData* mdo);
1455
1456 // Code generation support
1457 static ByteSize bci_offset(uint row) {
1458 return cell_offset(bci_cell_index(row));
1459 }
1460 static ByteSize bci_count_offset(uint row) {
1461 return cell_offset(bci_count_cell_index(row));
1462 }
1463 static ByteSize bci_displacement_offset(uint row) {
1464 return cell_offset(bci_displacement_cell_index(row));
1465 }
1466
1467 // Specific initialization.
1468 void post_initialize(BytecodeStream* stream, MethodData* mdo);
1469
1470 void print_data_on(outputStream* st, const char* extra = NULL) const;
1471 };
1472
1473 // BranchData
1474 //
1475 // A BranchData is used to access profiling data for a two-way branch.
1476 // It consists of taken and not_taken counts as well as a data displacement
1477 // for the taken case.
1478 class BranchData : public JumpData {
1479 friend class VMStructs;
1480 friend class JVMCIVMStructs;
1481 protected:
1482 enum {
1483 not_taken_off_set = jump_cell_count,
1484 branch_cell_count
1485 };
1486
1487 void set_displacement(int displacement) {
1488 set_int_at(displacement_off_set, displacement);
1489 }
1490
1491 public:
1492 BranchData(DataLayout* layout) : JumpData(layout) {
1493 assert(layout->tag() == DataLayout::branch_data_tag, "wrong type");
1494 }
1495
1496 virtual bool is_BranchData() const { return true; }
1497
1498 static int static_cell_count() {
1499 return branch_cell_count;
1500 }
1501
1502 virtual int cell_count() const {
1503 return static_cell_count();
1504 }
1505
1506 // Direct accessor
1507 uint not_taken() const {
1508 return uint_at(not_taken_off_set);
1509 }
1510
1511 void set_not_taken(uint cnt) {
1512 set_uint_at(not_taken_off_set, cnt);
1513 }
1514
1515 uint inc_not_taken() {
1516 uint cnt = not_taken() + 1;
1517 // Did we wrap? Will compiler screw us??
1518 if (cnt == 0) cnt--;
1519 set_uint_at(not_taken_off_set, cnt);
1520 return cnt;
1521 }
1522
1523 // Code generation support
1524 static ByteSize not_taken_offset() {
1525 return cell_offset(not_taken_off_set);
1526 }
1527 static ByteSize branch_data_size() {
1528 return cell_offset(branch_cell_count);
1529 }
1530
1531 // Specific initialization.
1532 void post_initialize(BytecodeStream* stream, MethodData* mdo);
1533
1534 void print_data_on(outputStream* st, const char* extra = NULL) const;
1535 };
1536
1537 // ArrayData
1538 //
1539 // A ArrayData is a base class for accessing profiling data which does
1540 // not have a statically known size. It consists of an array length
1541 // and an array start.
1542 class ArrayData : public ProfileData {
1543 friend class VMStructs;
1544 friend class JVMCIVMStructs;
1545 protected:
1546 friend class DataLayout;
1547
1548 enum {
1549 array_len_off_set,
1550 array_start_off_set
1551 };
1552
1553 uint array_uint_at(int index) const {
1554 int aindex = index + array_start_off_set;
1555 return uint_at(aindex);
1556 }
1557 int array_int_at(int index) const {
1558 int aindex = index + array_start_off_set;
1559 return int_at(aindex);
1560 }
1561 oop array_oop_at(int index) const {
1562 int aindex = index + array_start_off_set;
1563 return oop_at(aindex);
1564 }
1565 void array_set_int_at(int index, int value) {
1566 int aindex = index + array_start_off_set;
1567 set_int_at(aindex, value);
1568 }
1569
1570 // Code generation support for subclasses.
1571 static ByteSize array_element_offset(int index) {
1572 return cell_offset(array_start_off_set + index);
1573 }
1574
1575 public:
1576 ArrayData(DataLayout* layout) : ProfileData(layout) {}
1577
1578 virtual bool is_ArrayData() const { return true; }
1579
1580 static int static_cell_count() {
1581 return -1;
1582 }
1583
1584 int array_len() const {
1585 return int_at_unchecked(array_len_off_set);
1586 }
1587
1588 virtual int cell_count() const {
1589 return array_len() + 1;
1590 }
1591
1592 // Code generation support
1593 static ByteSize array_len_offset() {
1594 return cell_offset(array_len_off_set);
1595 }
1596 static ByteSize array_start_offset() {
1597 return cell_offset(array_start_off_set);
1598 }
1599 };
1600
1601 // MultiBranchData
1602 //
1603 // A MultiBranchData is used to access profiling information for
1604 // a multi-way branch (*switch bytecodes). It consists of a series
1605 // of (count, displacement) pairs, which count the number of times each
1606 // case was taken and specify the data displacment for each branch target.
1607 class MultiBranchData : public ArrayData {
1608 friend class VMStructs;
1609 friend class JVMCIVMStructs;
1610 protected:
1611 enum {
1612 default_count_off_set,
1613 default_disaplacement_off_set,
1614 case_array_start
1615 };
1616 enum {
1617 relative_count_off_set,
1618 relative_displacement_off_set,
1619 per_case_cell_count
1620 };
1621
1622 void set_default_displacement(int displacement) {
1623 array_set_int_at(default_disaplacement_off_set, displacement);
1624 }
1625 void set_displacement_at(int index, int displacement) {
1626 array_set_int_at(case_array_start +
1627 index * per_case_cell_count +
1628 relative_displacement_off_set,
1629 displacement);
1630 }
1631
1632 public:
1633 MultiBranchData(DataLayout* layout) : ArrayData(layout) {
1634 assert(layout->tag() == DataLayout::multi_branch_data_tag, "wrong type");
1635 }
1636
1637 virtual bool is_MultiBranchData() const { return true; }
1638
1639 static int compute_cell_count(BytecodeStream* stream);
1640
1641 int number_of_cases() const {
1642 int alen = array_len() - 2; // get rid of default case here.
1643 assert(alen % per_case_cell_count == 0, "must be even");
1644 return (alen / per_case_cell_count);
1645 }
1646
1647 uint default_count() const {
1648 return array_uint_at(default_count_off_set);
1649 }
1650 int default_displacement() const {
1651 return array_int_at(default_disaplacement_off_set);
1652 }
1653
1654 uint count_at(int index) const {
1655 return array_uint_at(case_array_start +
1656 index * per_case_cell_count +
1657 relative_count_off_set);
1658 }
1659 int displacement_at(int index) const {
1660 return array_int_at(case_array_start +
1661 index * per_case_cell_count +
1662 relative_displacement_off_set);
1663 }
1664
1665 // Code generation support
1666 static ByteSize default_count_offset() {
1667 return array_element_offset(default_count_off_set);
1668 }
1669 static ByteSize default_displacement_offset() {
1670 return array_element_offset(default_disaplacement_off_set);
1671 }
1672 static ByteSize case_count_offset(int index) {
1673 return case_array_offset() +
1674 (per_case_size() * index) +
1675 relative_count_offset();
1676 }
1677 static ByteSize case_array_offset() {
1678 return array_element_offset(case_array_start);
1679 }
1680 static ByteSize per_case_size() {
1681 return in_ByteSize(per_case_cell_count) * cell_size;
1682 }
1683 static ByteSize relative_count_offset() {
1684 return in_ByteSize(relative_count_off_set) * cell_size;
1685 }
1686 static ByteSize relative_displacement_offset() {
1687 return in_ByteSize(relative_displacement_off_set) * cell_size;
1688 }
1689
1690 // Specific initialization.
1691 void post_initialize(BytecodeStream* stream, MethodData* mdo);
1692
1693 void print_data_on(outputStream* st, const char* extra = NULL) const;
1694 };
1695
1696 class ArgInfoData : public ArrayData {
1697
1698 public:
1699 ArgInfoData(DataLayout* layout) : ArrayData(layout) {
1700 assert(layout->tag() == DataLayout::arg_info_data_tag, "wrong type");
1701 }
1702
1703 virtual bool is_ArgInfoData() const { return true; }
1704
1705
1706 int number_of_args() const {
1707 return array_len();
1708 }
1709
1710 uint arg_modified(int arg) const {
1711 return array_uint_at(arg);
1712 }
1713
1714 void set_arg_modified(int arg, uint val) {
1715 array_set_int_at(arg, val);
1716 }
1717
1718 void print_data_on(outputStream* st, const char* extra = NULL) const;
1719 };
1720
1721 // ParametersTypeData
1722 //
1723 // A ParametersTypeData is used to access profiling information about
1724 // types of parameters to a method
1725 class ParametersTypeData : public ArrayData {
1726
1727 private:
1728 TypeStackSlotEntries _parameters;
1729
1730 static int stack_slot_local_offset(int i) {
1731 assert_profiling_enabled();
1732 return array_start_off_set + TypeStackSlotEntries::stack_slot_local_offset(i);
1733 }
1734
1735 static int type_local_offset(int i) {
1736 assert_profiling_enabled();
1737 return array_start_off_set + TypeStackSlotEntries::type_local_offset(i);
1738 }
1739
1740 static bool profiling_enabled();
1741 static void assert_profiling_enabled() {
1742 assert(profiling_enabled(), "method parameters profiling should be on");
1743 }
1744
1745 public:
1746 ParametersTypeData(DataLayout* layout) : ArrayData(layout), _parameters(1, number_of_parameters()) {
1747 assert(layout->tag() == DataLayout::parameters_type_data_tag, "wrong type");
1748 // Some compilers (VC++) don't want this passed in member initialization list
1749 _parameters.set_profile_data(this);
1750 }
1751
1752 static int compute_cell_count(Method* m);
1753
1754 virtual bool is_ParametersTypeData() const { return true; }
1755
1756 virtual void post_initialize(BytecodeStream* stream, MethodData* mdo);
1757
1758 int number_of_parameters() const {
1759 return array_len() / TypeStackSlotEntries::per_arg_count();
1760 }
1761
1762 const TypeStackSlotEntries* parameters() const { return &_parameters; }
1763
1764 uint stack_slot(int i) const {
1765 return _parameters.stack_slot(i);
1766 }
1767
1768 void set_type(int i, Klass* k) {
1769 intptr_t current = _parameters.type(i);
1770 _parameters.set_type(i, TypeEntries::with_status((intptr_t)k, current));
1771 }
1772
1773 virtual void clean_weak_klass_links(bool always_clean) {
1774 _parameters.clean_weak_klass_links(always_clean);
1775 }
1776
1777 virtual void print_data_on(outputStream* st, const char* extra = NULL) const;
1778
1779 static ByteSize stack_slot_offset(int i) {
1780 return cell_offset(stack_slot_local_offset(i));
1781 }
1782
1783 static ByteSize type_offset(int i) {
1784 return cell_offset(type_local_offset(i));
1785 }
1786 };
1787
1788 // SpeculativeTrapData
1789 //
1790 // A SpeculativeTrapData is used to record traps due to type
1791 // speculation. It records the root of the compilation: that type
1792 // speculation is wrong in the context of one compilation (for
1793 // method1) doesn't mean it's wrong in the context of another one (for
1794 // method2). Type speculation could have more/different data in the
1795 // context of the compilation of method2 and it's worthwhile to try an
1796 // optimization that failed for compilation of method1 in the context
1797 // of compilation of method2.
1798 // Space for SpeculativeTrapData entries is allocated from the extra
1799 // data space in the MDO. If we run out of space, the trap data for
1800 // the ProfileData at that bci is updated.
1801 class SpeculativeTrapData : public ProfileData {
1802 protected:
1803 enum {
1804 speculative_trap_method,
1805 #ifndef _LP64
1806 // The size of the area for traps is a multiple of the header
1807 // size, 2 cells on 32 bits. Packed at the end of this area are
1808 // argument info entries (with tag
1809 // DataLayout::arg_info_data_tag). The logic in
1810 // MethodData::bci_to_extra_data() that guarantees traps don't
1811 // overflow over argument info entries assumes the size of a
1812 // SpeculativeTrapData is twice the header size. On 32 bits, a
1813 // SpeculativeTrapData must be 4 cells.
1814 padding,
1815 #endif
1816 speculative_trap_cell_count
1817 };
1818 public:
1819 SpeculativeTrapData(DataLayout* layout) : ProfileData(layout) {
1820 assert(layout->tag() == DataLayout::speculative_trap_data_tag, "wrong type");
1821 }
1822
1823 virtual bool is_SpeculativeTrapData() const { return true; }
1824
1825 static int static_cell_count() {
1826 return speculative_trap_cell_count;
1827 }
1828
1829 virtual int cell_count() const {
1830 return static_cell_count();
1831 }
1832
1833 // Direct accessor
1834 Method* method() const {
1835 return (Method*)intptr_at(speculative_trap_method);
1836 }
1837
1838 void set_method(Method* m) {
1839 assert(!m->is_old(), "cannot add old methods");
1840 set_intptr_at(speculative_trap_method, (intptr_t)m);
1841 }
1842
1843 static ByteSize method_offset() {
1844 return cell_offset(speculative_trap_method);
1845 }
1846
1847 virtual void print_data_on(outputStream* st, const char* extra = NULL) const;
1848 };
1849
1850 // MethodData*
1851 //
1852 // A MethodData* holds information which has been collected about
1853 // a method. Its layout looks like this:
1854 //
1855 // -----------------------------
1856 // | header |
1857 // | klass |
1858 // -----------------------------
1859 // | method |
1860 // | size of the MethodData* |
1861 // -----------------------------
1862 // | Data entries... |
1863 // | (variable size) |
1864 // | |
1865 // . .
1866 // . .
1867 // . .
1868 // | |
1869 // -----------------------------
1870 //
1871 // The data entry area is a heterogeneous array of DataLayouts. Each
1872 // DataLayout in the array corresponds to a specific bytecode in the
1873 // method. The entries in the array are sorted by the corresponding
1874 // bytecode. Access to the data is via resource-allocated ProfileData,
1875 // which point to the underlying blocks of DataLayout structures.
1876 //
1877 // During interpretation, if profiling in enabled, the interpreter
1878 // maintains a method data pointer (mdp), which points at the entry
1879 // in the array corresponding to the current bci. In the course of
1880 // intepretation, when a bytecode is encountered that has profile data
1881 // associated with it, the entry pointed to by mdp is updated, then the
1882 // mdp is adjusted to point to the next appropriate DataLayout. If mdp
1883 // is NULL to begin with, the interpreter assumes that the current method
1884 // is not (yet) being profiled.
1885 //
1886 // In MethodData* parlance, "dp" is a "data pointer", the actual address
1887 // of a DataLayout element. A "di" is a "data index", the offset in bytes
1888 // from the base of the data entry array. A "displacement" is the byte offset
1889 // in certain ProfileData objects that indicate the amount the mdp must be
1890 // adjusted in the event of a change in control flow.
1891 //
1892
1893 class CleanExtraDataClosure : public StackObj {
1894 public:
1895 virtual bool is_live(Method* m) = 0;
1896 };
1897
1898
1899 #if INCLUDE_JVMCI
1900 // Encapsulates an encoded speculation reason. These are linked together in
1901 // a list that is atomically appended to during deoptimization. Entries are
1902 // never removed from the list.
1903 // @see jdk.vm.ci.hotspot.HotSpotSpeculationLog.HotSpotSpeculationEncoding
1904 class FailedSpeculation: public CHeapObj<mtCompiler> {
1905 private:
1906 // The length of HotSpotSpeculationEncoding.toByteArray(). The data itself
1907 // is an array embedded at the end of this object.
1908 int _data_len;
1909
1910 // Next entry in a linked list.
1911 FailedSpeculation* _next;
1912
1913 FailedSpeculation(address data, int data_len);
1914
1915 FailedSpeculation** next_adr() { return &_next; }
1916
1917 // Placement new operator for inlining the speculation data into
1918 // the FailedSpeculation object.
1919 void* operator new(size_t size, size_t fs_size) throw();
1920
1921 public:
1922 char* data() { return (char*)(((address) this) + sizeof(FailedSpeculation)); }
1923 int data_len() const { return _data_len; }
1924 FailedSpeculation* next() const { return _next; }
1925
1926 // Atomically appends a speculation from nm to the list whose head is at (*failed_speculations_address).
1927 // Returns false if the FailedSpeculation object could not be allocated.
1928 static bool add_failed_speculation(nmethod* nm, FailedSpeculation** failed_speculations_address, address speculation, int speculation_len);
1929
1930 // Frees all entries in the linked list whose head is at (*failed_speculations_address).
1931 static void free_failed_speculations(FailedSpeculation** failed_speculations_address);
1932 };
1933 #endif
1934
1935 class ciMethodData;
1936
1937 class MethodData : public Metadata {
1938 friend class VMStructs;
1939 friend class JVMCIVMStructs;
1940 private:
1941 friend class ProfileData;
1942 friend class TypeEntriesAtCall;
1943 friend class ciMethodData;
1944
1945 // If you add a new field that points to any metaspace object, you
1946 // must add this field to MethodData::metaspace_pointers_do().
1947
1948 // Back pointer to the Method*
1949 Method* _method;
1950
1951 // Size of this oop in bytes
1952 int _size;
1953
1954 // Cached hint for bci_to_dp and bci_to_data
1955 int _hint_di;
1956
1957 Mutex _extra_data_lock;
1958
1959 MethodData(const methodHandle& method);
1960 public:
1961 static MethodData* allocate(ClassLoaderData* loader_data, const methodHandle& method, TRAPS);
1962
1963 virtual bool is_methodData() const { return true; }
1964 void initialize();
1965
1966 // Whole-method sticky bits and flags
1967 enum {
1968 _trap_hist_limit = 25 JVMCI_ONLY(+5), // decoupled from Deoptimization::Reason_LIMIT
1969 _trap_hist_mask = max_jubyte,
1970 _extra_data_count = 4 // extra DataLayout headers, for trap history
1971 }; // Public flag values
1972
1973 // Compiler-related counters.
1974 class CompilerCounters {
1975 friend class VMStructs;
1976 friend class JVMCIVMStructs;
1977
1978 uint _nof_decompiles; // count of all nmethod removals
1979 uint _nof_overflow_recompiles; // recompile count, excluding recomp. bits
1980 uint _nof_overflow_traps; // trap count, excluding _trap_hist
1981 union {
1982 intptr_t _align;
1983 u1 _array[JVMCI_ONLY(2 *) MethodData::_trap_hist_limit];
1984 } _trap_hist;
1985
1986 public:
1987 CompilerCounters() : _nof_decompiles(0), _nof_overflow_recompiles(0), _nof_overflow_traps(0) {
1988 #ifndef ZERO
1989 // Some Zero platforms do not have expected alignment, and do not use
1990 // this code. static_assert would still fire and fail for them.
1991 static_assert(sizeof(_trap_hist) % HeapWordSize == 0, "align");
1992 #endif
1993 uint size_in_words = sizeof(_trap_hist) / HeapWordSize;
1994 Copy::zero_to_words((HeapWord*) &_trap_hist, size_in_words);
1995 }
1996
1997 // Return (uint)-1 for overflow.
1998 uint trap_count(int reason) const {
1999 assert((uint)reason < JVMCI_ONLY(2*) _trap_hist_limit, "oob");
2000 return (int)((_trap_hist._array[reason]+1) & _trap_hist_mask) - 1;
2001 }
2002
2003 uint inc_trap_count(int reason) {
2004 // Count another trap, anywhere in this method.
2005 assert(reason >= 0, "must be single trap");
2006 assert((uint)reason < JVMCI_ONLY(2*) _trap_hist_limit, "oob");
2007 uint cnt1 = 1 + _trap_hist._array[reason];
2008 if ((cnt1 & _trap_hist_mask) != 0) { // if no counter overflow...
2009 _trap_hist._array[reason] = cnt1;
2010 return cnt1;
2011 } else {
2012 return _trap_hist_mask + (++_nof_overflow_traps);
2013 }
2014 }
2015
2016 uint overflow_trap_count() const {
2017 return _nof_overflow_traps;
2018 }
2019 uint overflow_recompile_count() const {
2020 return _nof_overflow_recompiles;
2021 }
2022 uint inc_overflow_recompile_count() {
2023 return ++_nof_overflow_recompiles;
2024 }
2025 uint decompile_count() const {
2026 return _nof_decompiles;
2027 }
2028 uint inc_decompile_count() {
2029 return ++_nof_decompiles;
2030 }
2031
2032 // Support for code generation
2033 static ByteSize trap_history_offset() {
2034 return byte_offset_of(CompilerCounters, _trap_hist._array);
2035 }
2036 };
2037
2038 private:
2039 CompilerCounters _compiler_counters;
2040
2041 // Support for interprocedural escape analysis, from Thomas Kotzmann.
2042 intx _eflags; // flags on escape information
2043 intx _arg_local; // bit set of non-escaping arguments
2044 intx _arg_stack; // bit set of stack-allocatable arguments
2045 intx _arg_returned; // bit set of returned arguments
2046
2047 int _creation_mileage; // method mileage at MDO creation
2048
2049 // How many invocations has this MDO seen?
2050 // These counters are used to determine the exact age of MDO.
2051 // We need those because in tiered a method can be concurrently
2052 // executed at different levels.
2053 InvocationCounter _invocation_counter;
2054 // Same for backedges.
2055 InvocationCounter _backedge_counter;
2056 // Counter values at the time profiling started.
2057 int _invocation_counter_start;
2058 int _backedge_counter_start;
2059 uint _tenure_traps;
2060 int _invoke_mask; // per-method Tier0InvokeNotifyFreqLog
2061 int _backedge_mask; // per-method Tier0BackedgeNotifyFreqLog
2062
2063 #if INCLUDE_RTM_OPT
2064 // State of RTM code generation during compilation of the method
2065 int _rtm_state;
2066 #endif
2067
2068 // Number of loops and blocks is computed when compiling the first
2069 // time with C1. It is used to determine if method is trivial.
2070 short _num_loops;
2071 short _num_blocks;
2072 // Does this method contain anything worth profiling?
2073 enum WouldProfile {unknown, no_profile, profile};
2074 WouldProfile _would_profile;
2075
2076 #if INCLUDE_JVMCI
2077 // Support for HotSpotMethodData.setCompiledIRSize(int)
2078 int _jvmci_ir_size;
2079 FailedSpeculation* _failed_speculations;
2080 #endif
2081
2082 // Size of _data array in bytes. (Excludes header and extra_data fields.)
2083 int _data_size;
2084
2085 // data index for the area dedicated to parameters. -1 if no
2086 // parameter profiling.
2087 enum { no_parameters = -2, parameters_uninitialized = -1 };
2088 int _parameters_type_data_di;
2089
2090 // Beginning of the data entries
2091 intptr_t _data[1];
2092
2093 // Helper for size computation
2094 static int compute_data_size(BytecodeStream* stream);
2095 static int bytecode_cell_count(Bytecodes::Code code);
2096 static bool is_speculative_trap_bytecode(Bytecodes::Code code);
2097 enum { no_profile_data = -1, variable_cell_count = -2 };
2098
2099 // Helper for initialization
2100 DataLayout* data_layout_at(int data_index) const {
2101 assert(data_index % sizeof(intptr_t) == 0, "unaligned");
2102 return (DataLayout*) (((address)_data) + data_index);
2103 }
2104
2105 // Initialize an individual data segment. Returns the size of
2106 // the segment in bytes.
2107 int initialize_data(BytecodeStream* stream, int data_index);
2108
2109 // Helper for data_at
2110 DataLayout* limit_data_position() const {
2111 return data_layout_at(_data_size);
2112 }
2113 bool out_of_bounds(int data_index) const {
2114 return data_index >= data_size();
2115 }
2116
2117 // Give each of the data entries a chance to perform specific
2118 // data initialization.
2119 void post_initialize(BytecodeStream* stream);
2120
2121 // hint accessors
2122 int hint_di() const { return _hint_di; }
2123 void set_hint_di(int di) {
2124 assert(!out_of_bounds(di), "hint_di out of bounds");
2125 _hint_di = di;
2126 }
2127
2128 DataLayout* data_layout_before(int bci) {
2129 // avoid SEGV on this edge case
2130 if (data_size() == 0)
2131 return NULL;
2132 DataLayout* layout = data_layout_at(hint_di());
2133 if (layout->bci() <= bci)
2134 return layout;
2135 return data_layout_at(first_di());
2136 }
2137
2138 // What is the index of the first data entry?
2139 int first_di() const { return 0; }
2140
2141 ProfileData* bci_to_extra_data_helper(int bci, Method* m, DataLayout*& dp, bool concurrent);
2142 // Find or create an extra ProfileData:
2143 ProfileData* bci_to_extra_data(int bci, Method* m, bool create_if_missing);
2144
2145 // return the argument info cell
2146 ArgInfoData *arg_info();
2147
2148 enum {
2149 no_type_profile = 0,
2150 type_profile_jsr292 = 1,
2151 type_profile_all = 2
2152 };
2153
2154 static bool profile_jsr292(const methodHandle& m, int bci);
2155 static bool profile_unsafe(const methodHandle& m, int bci);
2156 static bool profile_memory_access(const methodHandle& m, int bci);
2157 static int profile_arguments_flag();
2158 static bool profile_all_arguments();
2159 static bool profile_arguments_for_invoke(const methodHandle& m, int bci);
2160 static int profile_return_flag();
2161 static bool profile_all_return();
2162 static bool profile_return_for_invoke(const methodHandle& m, int bci);
2163 static int profile_parameters_flag();
2164 static bool profile_parameters_jsr292_only();
2165 static bool profile_all_parameters();
2166
2167 void clean_extra_data_helper(DataLayout* dp, int shift, bool reset = false);
2168 void verify_extra_data_clean(CleanExtraDataClosure* cl);
2169
2170 public:
2171 void clean_extra_data(CleanExtraDataClosure* cl);
2172
2173 static int header_size() {
2174 return sizeof(MethodData)/wordSize;
2175 }
2176
2177 // Compute the size of a MethodData* before it is created.
2178 static int compute_allocation_size_in_bytes(const methodHandle& method);
2179 static int compute_allocation_size_in_words(const methodHandle& method);
2180 static int compute_extra_data_count(int data_size, int empty_bc_count, bool needs_speculative_traps);
2181
2182 // Determine if a given bytecode can have profile information.
2183 static bool bytecode_has_profile(Bytecodes::Code code) {
2184 return bytecode_cell_count(code) != no_profile_data;
2185 }
2186
2187 // reset into original state
2188 void init();
2189
2190 // My size
2191 int size_in_bytes() const { return _size; }
2192 int size() const { return align_metadata_size(align_up(_size, BytesPerWord)/BytesPerWord); }
2193
2194 int creation_mileage() const { return _creation_mileage; }
2195 void set_creation_mileage(int x) { _creation_mileage = x; }
2196
2197 int invocation_count() {
2198 if (invocation_counter()->carry()) {
2199 return InvocationCounter::count_limit;
2200 }
2201 return invocation_counter()->count();
2202 }
2203 int backedge_count() {
2204 if (backedge_counter()->carry()) {
2205 return InvocationCounter::count_limit;
2206 }
2207 return backedge_counter()->count();
2208 }
2209
2210 int invocation_count_start() {
2211 if (invocation_counter()->carry()) {
2212 return 0;
2213 }
2214 return _invocation_counter_start;
2215 }
2216
2217 int backedge_count_start() {
2218 if (backedge_counter()->carry()) {
2219 return 0;
2220 }
2221 return _backedge_counter_start;
2222 }
2223
2224 int invocation_count_delta() { return invocation_count() - invocation_count_start(); }
2225 int backedge_count_delta() { return backedge_count() - backedge_count_start(); }
2226
2227 void reset_start_counters() {
2228 _invocation_counter_start = invocation_count();
2229 _backedge_counter_start = backedge_count();
2230 }
2231
2232 InvocationCounter* invocation_counter() { return &_invocation_counter; }
2233 InvocationCounter* backedge_counter() { return &_backedge_counter; }
2234
2235 #if INCLUDE_JVMCI
2236 FailedSpeculation** get_failed_speculations_address() {
2237 return &_failed_speculations;
2238 }
2239 #endif
2240
2241 #if INCLUDE_RTM_OPT
2242 int rtm_state() const {
2243 return _rtm_state;
2244 }
2245 void set_rtm_state(RTMState rstate) {
2246 _rtm_state = (int)rstate;
2247 }
2248 void atomic_set_rtm_state(RTMState rstate) {
2249 Atomic::store(&_rtm_state, (int)rstate);
2250 }
2251
2252 static int rtm_state_offset_in_bytes() {
2253 return offset_of(MethodData, _rtm_state);
2254 }
2255 #endif
2256
2257 void set_would_profile(bool p) { _would_profile = p ? profile : no_profile; }
2258 bool would_profile() const { return _would_profile != no_profile; }
2259
2260 int num_loops() const { return _num_loops; }
2261 void set_num_loops(int n) { _num_loops = n; }
2262 int num_blocks() const { return _num_blocks; }
2263 void set_num_blocks(int n) { _num_blocks = n; }
2264
2265 bool is_mature() const; // consult mileage and ProfileMaturityPercentage
2266 static int mileage_of(Method* m);
2267
2268 // Support for interprocedural escape analysis, from Thomas Kotzmann.
2269 enum EscapeFlag {
2270 estimated = 1 << 0,
2271 return_local = 1 << 1,
2272 return_allocated = 1 << 2,
2273 allocated_escapes = 1 << 3,
2274 unknown_modified = 1 << 4
2275 };
2276
2277 intx eflags() { return _eflags; }
2278 intx arg_local() { return _arg_local; }
2279 intx arg_stack() { return _arg_stack; }
2280 intx arg_returned() { return _arg_returned; }
2281 uint arg_modified(int a) { ArgInfoData *aid = arg_info();
2282 assert(aid != NULL, "arg_info must be not null");
2283 assert(a >= 0 && a < aid->number_of_args(), "valid argument number");
2284 return aid->arg_modified(a); }
2285
2286 void set_eflags(intx v) { _eflags = v; }
2287 void set_arg_local(intx v) { _arg_local = v; }
2288 void set_arg_stack(intx v) { _arg_stack = v; }
2289 void set_arg_returned(intx v) { _arg_returned = v; }
2290 void set_arg_modified(int a, uint v) { ArgInfoData *aid = arg_info();
2291 assert(aid != NULL, "arg_info must be not null");
2292 assert(a >= 0 && a < aid->number_of_args(), "valid argument number");
2293 aid->set_arg_modified(a, v); }
2294
2295 void clear_escape_info() { _eflags = _arg_local = _arg_stack = _arg_returned = 0; }
2296
2297 // Location and size of data area
2298 address data_base() const {
2299 return (address) _data;
2300 }
2301 int data_size() const {
2302 return _data_size;
2303 }
2304
2305 int parameters_size_in_bytes() const {
2306 ParametersTypeData* param = parameters_type_data();
2307 return param == NULL ? 0 : param->size_in_bytes();
2308 }
2309
2310 // Accessors
2311 Method* method() const { return _method; }
2312
2313 // Get the data at an arbitrary (sort of) data index.
2314 ProfileData* data_at(int data_index) const;
2315
2316 // Walk through the data in order.
2317 ProfileData* first_data() const { return data_at(first_di()); }
2318 ProfileData* next_data(ProfileData* current) const;
2319 DataLayout* next_data_layout(DataLayout* current) const;
2320 bool is_valid(ProfileData* current) const { return current != NULL; }
2321 bool is_valid(DataLayout* current) const { return current != NULL; }
2322
2323 // Convert a dp (data pointer) to a di (data index).
2324 int dp_to_di(address dp) const {
2325 return dp - ((address)_data);
2326 }
2327
2328 // bci to di/dp conversion.
2329 address bci_to_dp(int bci);
2330 int bci_to_di(int bci) {
2331 return dp_to_di(bci_to_dp(bci));
2332 }
2333
2334 // Get the data at an arbitrary bci, or NULL if there is none.
2335 ProfileData* bci_to_data(int bci);
2336
2337 // Same, but try to create an extra_data record if one is needed:
2338 ProfileData* allocate_bci_to_data(int bci, Method* m) {
2339 ProfileData* data = NULL;
2340 // If m not NULL, try to allocate a SpeculativeTrapData entry
2341 if (m == NULL) {
2342 data = bci_to_data(bci);
2343 }
2344 if (data != NULL) {
2345 return data;
2346 }
2347 data = bci_to_extra_data(bci, m, true);
2348 if (data != NULL) {
2349 return data;
2350 }
2351 // If SpeculativeTrapData allocation fails try to allocate a
2352 // regular entry
2353 data = bci_to_data(bci);
2354 if (data != NULL) {
2355 return data;
2356 }
2357 return bci_to_extra_data(bci, NULL, true);
2358 }
2359
2360 // Add a handful of extra data records, for trap tracking.
2361 DataLayout* extra_data_base() const { return limit_data_position(); }
2362 DataLayout* extra_data_limit() const { return (DataLayout*)((address)this + size_in_bytes()); }
2363 DataLayout* args_data_limit() const { return (DataLayout*)((address)this + size_in_bytes() -
2364 parameters_size_in_bytes()); }
2365 int extra_data_size() const { return (address)extra_data_limit() - (address)extra_data_base(); }
2366 static DataLayout* next_extra(DataLayout* dp);
2367
2368 // Return (uint)-1 for overflow.
2369 uint trap_count(int reason) const {
2370 return _compiler_counters.trap_count(reason);
2371 }
2372 // For loops:
2373 static uint trap_reason_limit() { return _trap_hist_limit; }
2374 static uint trap_count_limit() { return _trap_hist_mask; }
2375 uint inc_trap_count(int reason) {
2376 return _compiler_counters.inc_trap_count(reason);
2377 }
2378
2379 uint overflow_trap_count() const {
2380 return _compiler_counters.overflow_trap_count();
2381 }
2382 uint overflow_recompile_count() const {
2383 return _compiler_counters.overflow_recompile_count();
2384 }
2385 uint inc_overflow_recompile_count() {
2386 return _compiler_counters.inc_overflow_recompile_count();
2387 }
2388 uint decompile_count() const {
2389 return _compiler_counters.decompile_count();
2390 }
2391 uint inc_decompile_count() {
2392 uint dec_count = _compiler_counters.inc_decompile_count();
2393 if (dec_count > (uint)PerMethodRecompilationCutoff) {
2394 method()->set_not_compilable("decompile_count > PerMethodRecompilationCutoff", CompLevel_full_optimization);
2395 }
2396 return dec_count;
2397 }
2398 uint tenure_traps() const {
2399 return _tenure_traps;
2400 }
2401 void inc_tenure_traps() {
2402 _tenure_traps += 1;
2403 }
2404
2405 // Return pointer to area dedicated to parameters in MDO
2406 ParametersTypeData* parameters_type_data() const {
2407 assert(_parameters_type_data_di != parameters_uninitialized, "called too early");
2408 return _parameters_type_data_di != no_parameters ? data_layout_at(_parameters_type_data_di)->data_in()->as_ParametersTypeData() : NULL;
2409 }
2410
2411 int parameters_type_data_di() const {
2412 assert(_parameters_type_data_di != parameters_uninitialized && _parameters_type_data_di != no_parameters, "no args type data");
2413 return _parameters_type_data_di;
2414 }
2415
2416 // Support for code generation
2417 static ByteSize data_offset() {
2418 return byte_offset_of(MethodData, _data[0]);
2419 }
2420
2421 static ByteSize trap_history_offset() {
2422 return byte_offset_of(MethodData, _compiler_counters) + CompilerCounters::trap_history_offset();
2423 }
2424
2425 static ByteSize invocation_counter_offset() {
2426 return byte_offset_of(MethodData, _invocation_counter);
2427 }
2428
2429 static ByteSize backedge_counter_offset() {
2430 return byte_offset_of(MethodData, _backedge_counter);
2431 }
2432
2433 static ByteSize invoke_mask_offset() {
2434 return byte_offset_of(MethodData, _invoke_mask);
2435 }
2436
2437 static ByteSize backedge_mask_offset() {
2438 return byte_offset_of(MethodData, _backedge_mask);
2439 }
2440
2441 static ByteSize parameters_type_data_di_offset() {
2442 return byte_offset_of(MethodData, _parameters_type_data_di);
2443 }
2444
2445 virtual void metaspace_pointers_do(MetaspaceClosure* iter);
2446 virtual MetaspaceObj::Type type() const { return MethodDataType; }
2447
2448 // Deallocation support - no metaspace pointer fields to deallocate
2449 void deallocate_contents(ClassLoaderData* loader_data) {}
2450
2451 // GC support
2452 void set_size(int object_size_in_bytes) { _size = object_size_in_bytes; }
2453
2454 // Printing
2455 void print_on (outputStream* st) const;
2456 void print_value_on(outputStream* st) const;
2457
2458 // printing support for method data
2459 void print_data_on(outputStream* st) const;
2460
2461 const char* internal_name() const { return "{method data}"; }
2462
2463 // verification
2464 void verify_on(outputStream* st);
2465 void verify_data_on(outputStream* st);
2466
2467 static bool profile_parameters_for_method(const methodHandle& m);
2468 static bool profile_arguments();
2469 static bool profile_arguments_jsr292_only();
2470 static bool profile_return();
2471 static bool profile_parameters();
2472 static bool profile_return_jsr292_only();
2473
2474 void clean_method_data(bool always_clean);
2475 void clean_weak_method_links();
2476 Mutex* extra_data_lock() { return &_extra_data_lock; }
2477 };
2478
2479 #endif // SHARE_OOPS_METHODDATA_HPP