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