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 #include "precompiled.hpp"
26 #include "ci/ciMetadata.hpp"
27 #include "ci/ciMethodData.hpp"
28 #include "ci/ciReplay.hpp"
29 #include "ci/ciUtilities.hpp"
30 #include "memory/allocation.inline.hpp"
31 #include "memory/resourceArea.hpp"
32 #include "runtime/deoptimization.hpp"
33 #include "utilities/copy.hpp"
34
35 // ciMethodData
36
37 // ------------------------------------------------------------------
38 // ciMethodData::ciMethodData
39 //
40 ciMethodData::ciMethodData(MethodData* md) : ciMetadata(md) {
41 assert(md != NULL, "no null method data");
42 Copy::zero_to_words((HeapWord*) &_orig, sizeof(_orig) / sizeof(HeapWord));
43 _data = NULL;
44 _data_size = 0;
45 _extra_data_size = 0;
46 _current_mileage = 0;
47 _invocation_counter = 0;
48 _backedge_counter = 0;
49 _state = empty_state;
50 _saw_free_extra_data = false;
51 // Set an initial hint. Don't use set_hint_di() because
52 // first_di() may be out of bounds if data_size is 0.
53 _hint_di = first_di();
54 // Initialize the escape information (to "don't know.");
55 _eflags = _arg_local = _arg_stack = _arg_returned = 0;
56 }
57
58 // ------------------------------------------------------------------
59 // ciMethodData::ciMethodData
60 //
61 // No MethodData*.
62 ciMethodData::ciMethodData() : ciMetadata(NULL) {
63 Copy::zero_to_words((HeapWord*) &_orig, sizeof(_orig) / sizeof(HeapWord));
64 _data = NULL;
65 _data_size = 0;
66 _extra_data_size = 0;
67 _current_mileage = 0;
68 _invocation_counter = 0;
69 _backedge_counter = 0;
70 _state = empty_state;
71 _saw_free_extra_data = false;
72 // Set an initial hint. Don't use set_hint_di() because
73 // first_di() may be out of bounds if data_size is 0.
74 _hint_di = first_di();
75 // Initialize the escape information (to "don't know.");
76 _eflags = _arg_local = _arg_stack = _arg_returned = 0;
77 }
78
79 void ciMethodData::load_data() {
80 MethodData* mdo = get_MethodData();
81 if (mdo == NULL) {
82 return;
83 }
84
85 // To do: don't copy the data if it is not "ripe" -- require a minimum #
86 // of invocations.
87
88 // Snapshot the data -- actually, take an approximate snapshot of
89 // the data. Any concurrently executing threads may be changing the
90 // data as we copy it.
91 Copy::disjoint_words((HeapWord*) mdo,
92 (HeapWord*) &_orig,
93 sizeof(_orig) / HeapWordSize);
94 Arena* arena = CURRENT_ENV->arena();
95 _data_size = mdo->data_size();
96 _extra_data_size = mdo->extra_data_size();
97 int total_size = _data_size + _extra_data_size;
98 _data = (intptr_t *) arena->Amalloc(total_size);
99 Copy::disjoint_words((HeapWord*) mdo->data_base(), (HeapWord*) _data, total_size / HeapWordSize);
100
101 // Traverse the profile data, translating any oops into their
102 // ci equivalents.
103 ResourceMark rm;
104 ciProfileData* ci_data = first_data();
105 ProfileData* data = mdo->first_data();
106 while (is_valid(ci_data)) {
107 ci_data->translate_from(data);
108 ci_data = next_data(ci_data);
109 data = mdo->next_data(data);
110 }
111 // Note: Extra data are all BitData, and do not need translation.
112 _current_mileage = MethodData::mileage_of(mdo->method());
113 _invocation_counter = mdo->invocation_count();
114 _backedge_counter = mdo->backedge_count();
115 _state = mdo->is_mature()? mature_state: immature_state;
116
117 _eflags = mdo->eflags();
118 _arg_local = mdo->arg_local();
119 _arg_stack = mdo->arg_stack();
120 _arg_returned = mdo->arg_returned();
121 #ifndef PRODUCT
122 if (ReplayCompiles) {
123 ciReplay::initialize(this);
124 }
125 #endif
126 }
127
128 void ciReceiverTypeData::translate_receiver_data_from(const ProfileData* data) {
129 for (uint row = 0; row < row_limit(); row++) {
130 Klass* k = data->as_ReceiverTypeData()->receiver(row);
131 if (k != NULL) {
132 ciKlass* klass = CURRENT_ENV->get_klass(k);
133 set_receiver(row, klass);
134 }
135 }
136 }
137
138
139 void ciTypeStackSlotEntries::translate_type_data_from(const TypeStackSlotEntries* entries) {
140 for (int i = 0; i < _number_of_entries; i++) {
141 intptr_t k = entries->type(i);
142 TypeStackSlotEntries::set_type(i, translate_klass(k));
143 }
144 }
145
146 void ciReturnTypeEntry::translate_type_data_from(const ReturnTypeEntry* ret) {
147 intptr_t k = ret->type();
148 set_type(translate_klass(k));
149 }
150
151 // Get the data at an arbitrary (sort of) data index.
152 ciProfileData* ciMethodData::data_at(int data_index) {
153 if (out_of_bounds(data_index)) {
154 return NULL;
155 }
156 DataLayout* data_layout = data_layout_at(data_index);
157
158 switch (data_layout->tag()) {
159 case DataLayout::no_tag:
160 default:
161 ShouldNotReachHere();
162 return NULL;
163 case DataLayout::bit_data_tag:
164 return new ciBitData(data_layout);
165 case DataLayout::counter_data_tag:
166 return new ciCounterData(data_layout);
167 case DataLayout::jump_data_tag:
168 return new ciJumpData(data_layout);
169 case DataLayout::receiver_type_data_tag:
170 return new ciReceiverTypeData(data_layout);
171 case DataLayout::virtual_call_data_tag:
172 return new ciVirtualCallData(data_layout);
173 case DataLayout::ret_data_tag:
174 return new ciRetData(data_layout);
175 case DataLayout::branch_data_tag:
176 return new ciBranchData(data_layout);
177 case DataLayout::multi_branch_data_tag:
178 return new ciMultiBranchData(data_layout);
179 case DataLayout::arg_info_data_tag:
180 return new ciArgInfoData(data_layout);
181 case DataLayout::call_type_data_tag:
182 return new ciCallTypeData(data_layout);
183 case DataLayout::virtual_call_type_data_tag:
184 return new ciVirtualCallTypeData(data_layout);
185 };
186 }
187
188 // Iteration over data.
189 ciProfileData* ciMethodData::next_data(ciProfileData* current) {
190 int current_index = dp_to_di(current->dp());
191 int next_index = current_index + current->size_in_bytes();
192 ciProfileData* next = data_at(next_index);
193 return next;
194 }
195
196 // Translate a bci to its corresponding data, or NULL.
197 ciProfileData* ciMethodData::bci_to_data(int bci) {
198 ciProfileData* data = data_before(bci);
199 for ( ; is_valid(data); data = next_data(data)) {
200 if (data->bci() == bci) {
201 set_hint_di(dp_to_di(data->dp()));
202 return data;
203 } else if (data->bci() > bci) {
204 break;
205 }
206 }
207 // bci_to_extra_data(bci) ...
208 DataLayout* dp = data_layout_at(data_size());
209 DataLayout* end = data_layout_at(data_size() + extra_data_size());
210 for (; dp < end; dp = MethodData::next_extra(dp)) {
211 if (dp->tag() == DataLayout::no_tag) {
212 _saw_free_extra_data = true; // observed an empty slot (common case)
213 return NULL;
214 }
215 if (dp->tag() == DataLayout::arg_info_data_tag) {
216 break; // ArgInfoData is at the end of extra data section.
217 }
218 if (dp->bci() == bci) {
219 assert(dp->tag() == DataLayout::bit_data_tag, "sane");
220 return new ciBitData(dp);
221 }
222 }
223 return NULL;
224 }
225
226 // Conservatively decode the trap_state of a ciProfileData.
227 int ciMethodData::has_trap_at(ciProfileData* data, int reason) {
228 typedef Deoptimization::DeoptReason DR_t;
229 int per_bc_reason
230 = Deoptimization::reason_recorded_per_bytecode_if_any((DR_t) reason);
231 if (trap_count(reason) == 0) {
232 // Impossible for this trap to have occurred, regardless of trap_state.
233 // Note: This happens if the MDO is empty.
234 return 0;
235 } else if (per_bc_reason == Deoptimization::Reason_none) {
236 // We cannot conclude anything; a trap happened somewhere, maybe here.
237 return -1;
238 } else if (data == NULL) {
239 // No profile here, not even an extra_data record allocated on the fly.
240 // If there are empty extra_data records, and there had been a trap,
241 // there would have been a non-null data pointer. If there are no
242 // free extra_data records, we must return a conservative -1.
243 if (_saw_free_extra_data)
244 return 0; // Q.E.D.
245 else
246 return -1; // bail with a conservative answer
247 } else {
248 return Deoptimization::trap_state_has_reason(data->trap_state(), per_bc_reason);
249 }
250 }
251
252 int ciMethodData::trap_recompiled_at(ciProfileData* data) {
253 if (data == NULL) {
254 return (_saw_free_extra_data? 0: -1); // (see previous method)
255 } else {
256 return Deoptimization::trap_state_is_recompiled(data->trap_state())? 1: 0;
257 }
258 }
259
260 void ciMethodData::clear_escape_info() {
261 VM_ENTRY_MARK;
262 MethodData* mdo = get_MethodData();
263 if (mdo != NULL) {
264 mdo->clear_escape_info();
265 ArgInfoData *aid = arg_info();
266 int arg_count = (aid == NULL) ? 0 : aid->number_of_args();
267 for (int i = 0; i < arg_count; i++) {
268 set_arg_modified(i, 0);
269 }
270 }
271 _eflags = _arg_local = _arg_stack = _arg_returned = 0;
272 }
273
274 // copy our escape info to the MethodData* if it exists
275 void ciMethodData::update_escape_info() {
276 VM_ENTRY_MARK;
277 MethodData* mdo = get_MethodData();
278 if ( mdo != NULL) {
279 mdo->set_eflags(_eflags);
280 mdo->set_arg_local(_arg_local);
281 mdo->set_arg_stack(_arg_stack);
282 mdo->set_arg_returned(_arg_returned);
283 int arg_count = mdo->method()->size_of_parameters();
284 for (int i = 0; i < arg_count; i++) {
285 mdo->set_arg_modified(i, arg_modified(i));
286 }
287 }
288 }
289
290 void ciMethodData::set_compilation_stats(short loops, short blocks) {
291 VM_ENTRY_MARK;
292 MethodData* mdo = get_MethodData();
293 if (mdo != NULL) {
294 mdo->set_num_loops(loops);
295 mdo->set_num_blocks(blocks);
296 }
297 }
298
299 void ciMethodData::set_would_profile(bool p) {
300 VM_ENTRY_MARK;
301 MethodData* mdo = get_MethodData();
302 if (mdo != NULL) {
303 mdo->set_would_profile(p);
304 }
305 }
306
307 void ciMethodData::set_argument_type(int bci, int i, ciKlass* k) {
308 VM_ENTRY_MARK;
309 MethodData* mdo = get_MethodData();
310 if (mdo != NULL) {
311 ProfileData* data = mdo->bci_to_data(bci);
312 if (data->is_CallTypeData()) {
313 data->as_CallTypeData()->set_argument_type(i, k->get_Klass());
314 } else {
315 assert(data->is_VirtualCallTypeData(), "no arguments!");
316 data->as_VirtualCallTypeData()->set_argument_type(i, k->get_Klass());
317 }
318 }
319 }
320
321 void ciMethodData::set_return_type(int bci, ciKlass* k) {
322 VM_ENTRY_MARK;
323 MethodData* mdo = get_MethodData();
324 if (mdo != NULL) {
325 ProfileData* data = mdo->bci_to_data(bci);
326 if (data->is_CallTypeData()) {
327 data->as_CallTypeData()->set_return_type(k->get_Klass());
328 } else {
329 assert(data->is_VirtualCallTypeData(), "no arguments!");
330 data->as_VirtualCallTypeData()->set_return_type(k->get_Klass());
331 }
332 }
333 }
334
335 bool ciMethodData::has_escape_info() {
336 return eflag_set(MethodData::estimated);
337 }
338
339 void ciMethodData::set_eflag(MethodData::EscapeFlag f) {
340 set_bits(_eflags, f);
341 }
342
343 void ciMethodData::clear_eflag(MethodData::EscapeFlag f) {
344 clear_bits(_eflags, f);
345 }
346
347 bool ciMethodData::eflag_set(MethodData::EscapeFlag f) const {
348 return mask_bits(_eflags, f) != 0;
349 }
350
351 void ciMethodData::set_arg_local(int i) {
352 set_nth_bit(_arg_local, i);
353 }
354
355 void ciMethodData::set_arg_stack(int i) {
356 set_nth_bit(_arg_stack, i);
357 }
358
359 void ciMethodData::set_arg_returned(int i) {
360 set_nth_bit(_arg_returned, i);
361 }
362
363 void ciMethodData::set_arg_modified(int arg, uint val) {
364 ArgInfoData *aid = arg_info();
365 if (aid == NULL)
366 return;
367 assert(arg >= 0 && arg < aid->number_of_args(), "valid argument number");
368 aid->set_arg_modified(arg, val);
369 }
370
371 bool ciMethodData::is_arg_local(int i) const {
372 return is_set_nth_bit(_arg_local, i);
373 }
374
375 bool ciMethodData::is_arg_stack(int i) const {
376 return is_set_nth_bit(_arg_stack, i);
377 }
378
379 bool ciMethodData::is_arg_returned(int i) const {
380 return is_set_nth_bit(_arg_returned, i);
381 }
382
383 uint ciMethodData::arg_modified(int arg) const {
384 ArgInfoData *aid = arg_info();
385 if (aid == NULL)
386 return 0;
387 assert(arg >= 0 && arg < aid->number_of_args(), "valid argument number");
388 return aid->arg_modified(arg);
389 }
390
391 ByteSize ciMethodData::offset_of_slot(ciProfileData* data, ByteSize slot_offset_in_data) {
392 // Get offset within MethodData* of the data array
393 ByteSize data_offset = MethodData::data_offset();
394
395 // Get cell offset of the ProfileData within data array
396 int cell_offset = dp_to_di(data->dp());
397
398 // Add in counter_offset, the # of bytes into the ProfileData of counter or flag
399 int offset = in_bytes(data_offset) + cell_offset + in_bytes(slot_offset_in_data);
400
401 return in_ByteSize(offset);
402 }
403
404 ciArgInfoData *ciMethodData::arg_info() const {
405 // Should be last, have to skip all traps.
406 DataLayout* dp = data_layout_at(data_size());
407 DataLayout* end = data_layout_at(data_size() + extra_data_size());
408 for (; dp < end; dp = MethodData::next_extra(dp)) {
409 if (dp->tag() == DataLayout::arg_info_data_tag)
410 return new ciArgInfoData(dp);
411 }
412 return NULL;
413 }
414
415
416 // Implementation of the print method.
417 void ciMethodData::print_impl(outputStream* st) {
418 ciMetadata::print_impl(st);
419 }
420
421 void ciMethodData::dump_replay_data(outputStream* out) {
422 ResourceMark rm;
423 MethodData* mdo = get_MethodData();
424 Method* method = mdo->method();
425 Klass* holder = method->method_holder();
426 out->print("ciMethodData %s %s %s %d %d",
427 holder->name()->as_quoted_ascii(),
428 method->name()->as_quoted_ascii(),
429 method->signature()->as_quoted_ascii(),
430 _state,
431 current_mileage());
432
433 // dump the contents of the MDO header as raw data
434 unsigned char* orig = (unsigned char*)&_orig;
435 int length = sizeof(_orig);
436 out->print(" orig %d", length);
437 for (int i = 0; i < length; i++) {
438 out->print(" %d", orig[i]);
439 }
440
441 // dump the MDO data as raw data
442 int elements = data_size() / sizeof(intptr_t);
443 out->print(" data %d", elements);
444 for (int i = 0; i < elements; i++) {
445 // We could use INTPTR_FORMAT here but that's a zero justified
446 // which makes comparing it with the SA version of this output
447 // harder.
448 #ifdef _LP64
449 out->print(" 0x%" FORMAT64_MODIFIER "x", data()[i]);
450 #else
451 out->print(" 0x%x", data()[i]);
452 #endif
453 }
454
455 // The MDO contained oop references as ciObjects, so scan for those
456 // and emit pairs of offset and klass name so that they can be
457 // reconstructed at runtime. The first round counts the number of
458 // oop references and the second actually emits them.
459 int count = 0;
460 for (int round = 0; round < 2; round++) {
461 if (round == 1) out->print(" oops %d", count);
462 ProfileData* pdata = first_data();
463 for ( ; is_valid(pdata); pdata = next_data(pdata)) {
464 if (pdata->is_ReceiverTypeData()) {
465 ciReceiverTypeData* vdata = (ciReceiverTypeData*)pdata;
466 for (uint i = 0; i < vdata->row_limit(); i++) {
467 ciKlass* k = vdata->receiver(i);
468 if (k != NULL) {
469 if (round == 0) {
470 count++;
471 } else {
472 out->print(" %d %s", dp_to_di(vdata->dp() + in_bytes(vdata->receiver_offset(i))) / sizeof(intptr_t), k->name()->as_quoted_ascii());
473 }
474 }
475 }
476 } else if (pdata->is_VirtualCallData()) {
477 ciVirtualCallData* vdata = (ciVirtualCallData*)pdata;
478 for (uint i = 0; i < vdata->row_limit(); i++) {
479 ciKlass* k = vdata->receiver(i);
480 if (k != NULL) {
481 if (round == 0) {
482 count++;
483 } else {
484 out->print(" %d %s", dp_to_di(vdata->dp() + in_bytes(vdata->receiver_offset(i))) / sizeof(intptr_t), k->name()->as_quoted_ascii());
485 }
486 }
487 }
488 }
489 }
490 }
491 out->cr();
492 }
493
494 #ifndef PRODUCT
495 void ciMethodData::print() {
496 print_data_on(tty);
497 }
498
499 void ciMethodData::print_data_on(outputStream* st) {
500 ResourceMark rm;
501 ciProfileData* data;
502 for (data = first_data(); is_valid(data); data = next_data(data)) {
503 st->print("%d", dp_to_di(data->dp()));
504 st->fill_to(6);
505 data->print_data_on(st);
506 }
507 st->print_cr("--- Extra data:");
508 DataLayout* dp = data_layout_at(data_size());
509 DataLayout* end = data_layout_at(data_size() + extra_data_size());
510 for (; dp < end; dp = MethodData::next_extra(dp)) {
511 if (dp->tag() == DataLayout::no_tag) continue;
512 if (dp->tag() == DataLayout::bit_data_tag) {
513 data = new BitData(dp);
514 } else {
515 assert(dp->tag() == DataLayout::arg_info_data_tag, "must be BitData or ArgInfo");
516 data = new ciArgInfoData(dp);
517 dp = end; // ArgInfoData is at the end of extra data section.
518 }
519 st->print("%d", dp_to_di(data->dp()));
520 st->fill_to(6);
521 data->print_data_on(st);
522 }
523 }
524
525 void ciTypeEntries::print_ciklass(outputStream* st, intptr_t k) {
526 if (TypeEntries::is_type_none(k)) {
527 st->print("none");
528 } else if (TypeEntries::is_type_unknown(k)) {
529 st->print("unknown");
530 } else {
531 valid_ciklass(k)->print_name_on(st);
532 }
533 if (TypeEntries::was_null_seen(k)) {
534 st->print(" (null seen)");
535 }
536 }
537
538 void ciTypeStackSlotEntries::print_data_on(outputStream* st) const {
539 for (int i = 0; i < _number_of_entries; i++) {
540 _pd->tab(st);
541 st->print("%d: stack (%u) ", i, stack_slot(i));
542 print_ciklass(st, type(i));
543 st->cr();
544 }
545 }
546
547 void ciReturnTypeEntry::print_data_on(outputStream* st) const {
548 _pd->tab(st);
549 st->print("ret ");
550 print_ciklass(st, type());
551 st->cr();
552 }
553
554 void ciCallTypeData::print_data_on(outputStream* st) const {
555 print_shared(st, "ciCallTypeData");
556 if (has_arguments()) {
557 tab(st, true);
558 st->print("argument types");
559 args()->print_data_on(st);
560 }
561 if (has_return()) {
562 tab(st, true);
563 st->print("return type");
564 ret()->print_data_on(st);
565 }
566 }
567
568 void ciReceiverTypeData::print_receiver_data_on(outputStream* st) const {
569 uint row;
570 int entries = 0;
571 for (row = 0; row < row_limit(); row++) {
572 if (receiver(row) != NULL) entries++;
573 }
574 st->print_cr("count(%u) entries(%u)", count(), entries);
575 for (row = 0; row < row_limit(); row++) {
576 if (receiver(row) != NULL) {
577 tab(st);
578 receiver(row)->print_name_on(st);
579 st->print_cr("(%u)", receiver_count(row));
580 }
581 }
582 }
583
584 void ciReceiverTypeData::print_data_on(outputStream* st) const {
585 print_shared(st, "ciReceiverTypeData");
586 print_receiver_data_on(st);
587 }
588
589 void ciVirtualCallData::print_data_on(outputStream* st) const {
590 print_shared(st, "ciVirtualCallData");
591 rtd_super()->print_receiver_data_on(st);
592 }
593
594 void ciVirtualCallTypeData::print_data_on(outputStream* st) const {
595 print_shared(st, "ciVirtualCallTypeData");
596 rtd_super()->print_receiver_data_on(st);
597 if (has_arguments()) {
598 tab(st, true);
599 st->print("argument types");
600 args()->print_data_on(st);
601 }
602 if (has_return()) {
603 tab(st, true);
604 st->print("return type");
605 ret()->print_data_on(st);
606 }
607 }
608 #endif