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(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 // Get the data at an arbitrary (sort of) data index.
140 ciProfileData* ciMethodData::data_at(int data_index) {
141 if (out_of_bounds(data_index)) {
142 return NULL;
143 }
144 DataLayout* data_layout = data_layout_at(data_index);
145
146 switch (data_layout->tag()) {
147 case DataLayout::no_tag:
148 default:
149 ShouldNotReachHere();
150 return NULL;
151 case DataLayout::bit_data_tag:
152 return new ciBitData(data_layout);
153 case DataLayout::counter_data_tag:
154 return new ciCounterData(data_layout);
155 case DataLayout::jump_data_tag:
156 return new ciJumpData(data_layout);
157 case DataLayout::receiver_type_data_tag:
158 return new ciReceiverTypeData(data_layout);
159 case DataLayout::virtual_call_data_tag:
160 return new ciVirtualCallData(data_layout);
161 case DataLayout::ret_data_tag:
162 return new ciRetData(data_layout);
163 case DataLayout::branch_data_tag:
164 return new ciBranchData(data_layout);
165 case DataLayout::multi_branch_data_tag:
166 return new ciMultiBranchData(data_layout);
167 case DataLayout::arg_info_data_tag:
168 return new ciArgInfoData(data_layout);
169 };
170 }
171
172 // Iteration over data.
173 ciProfileData* ciMethodData::next_data(ciProfileData* current) {
174 int current_index = dp_to_di(current->dp());
175 int next_index = current_index + current->size_in_bytes();
176 ciProfileData* next = data_at(next_index);
177 return next;
178 }
179
180 // Translate a bci to its corresponding data, or NULL.
181 ciProfileData* ciMethodData::bci_to_data(int bci) {
182 ciProfileData* data = data_before(bci);
183 for ( ; is_valid(data); data = next_data(data)) {
184 if (data->bci() == bci) {
185 set_hint_di(dp_to_di(data->dp()));
186 return data;
187 } else if (data->bci() > bci) {
188 break;
189 }
190 }
191 // bci_to_extra_data(bci) ...
192 DataLayout* dp = data_layout_at(data_size());
193 DataLayout* end = data_layout_at(data_size() + extra_data_size());
194 for (; dp < end; dp = MethodData::next_extra(dp)) {
195 if (dp->tag() == DataLayout::no_tag) {
196 _saw_free_extra_data = true; // observed an empty slot (common case)
197 return NULL;
198 }
199 if (dp->tag() == DataLayout::arg_info_data_tag) {
200 break; // ArgInfoData is at the end of extra data section.
201 }
202 if (dp->bci() == bci) {
203 assert(dp->tag() == DataLayout::bit_data_tag, "sane");
204 return new ciBitData(dp);
205 }
206 }
207 return NULL;
208 }
209
210 // Conservatively decode the trap_state of a ciProfileData.
211 int ciMethodData::has_trap_at(ciProfileData* data, int reason) {
212 typedef Deoptimization::DeoptReason DR_t;
213 int per_bc_reason
214 = Deoptimization::reason_recorded_per_bytecode_if_any((DR_t) reason);
215 if (trap_count(reason) == 0) {
216 // Impossible for this trap to have occurred, regardless of trap_state.
217 // Note: This happens if the MDO is empty.
218 return 0;
219 } else if (per_bc_reason == Deoptimization::Reason_none) {
220 // We cannot conclude anything; a trap happened somewhere, maybe here.
221 return -1;
222 } else if (data == NULL) {
223 // No profile here, not even an extra_data record allocated on the fly.
224 // If there are empty extra_data records, and there had been a trap,
225 // there would have been a non-null data pointer. If there are no
226 // free extra_data records, we must return a conservative -1.
227 if (_saw_free_extra_data)
228 return 0; // Q.E.D.
229 else
230 return -1; // bail with a conservative answer
231 } else {
232 return Deoptimization::trap_state_has_reason(data->trap_state(), per_bc_reason);
233 }
234 }
235
236 int ciMethodData::trap_recompiled_at(ciProfileData* data) {
237 if (data == NULL) {
238 return (_saw_free_extra_data? 0: -1); // (see previous method)
239 } else {
240 return Deoptimization::trap_state_is_recompiled(data->trap_state())? 1: 0;
241 }
242 }
243
244 void ciMethodData::clear_escape_info() {
245 VM_ENTRY_MARK;
246 MethodData* mdo = get_MethodData();
247 if (mdo != NULL) {
248 mdo->clear_escape_info();
249 ArgInfoData *aid = arg_info();
250 int arg_count = (aid == NULL) ? 0 : aid->number_of_args();
251 for (int i = 0; i < arg_count; i++) {
252 set_arg_modified(i, 0);
253 }
254 }
255 _eflags = _arg_local = _arg_stack = _arg_returned = 0;
256 }
257
258 // copy our escape info to the MethodData* if it exists
259 void ciMethodData::update_escape_info() {
260 VM_ENTRY_MARK;
261 MethodData* mdo = get_MethodData();
262 if ( mdo != NULL) {
263 mdo->set_eflags(_eflags);
264 mdo->set_arg_local(_arg_local);
265 mdo->set_arg_stack(_arg_stack);
266 mdo->set_arg_returned(_arg_returned);
267 int arg_count = mdo->method()->size_of_parameters();
268 for (int i = 0; i < arg_count; i++) {
269 mdo->set_arg_modified(i, arg_modified(i));
270 }
271 }
272 }
273
274 void ciMethodData::set_compilation_stats(short loops, short blocks) {
275 VM_ENTRY_MARK;
276 MethodData* mdo = get_MethodData();
277 if (mdo != NULL) {
278 mdo->set_num_loops(loops);
279 mdo->set_num_blocks(blocks);
280 }
281 }
282
283 void ciMethodData::set_would_profile(bool p) {
284 VM_ENTRY_MARK;
285 MethodData* mdo = get_MethodData();
286 if (mdo != NULL) {
287 mdo->set_would_profile(p);
288 }
289 }
290
291 bool ciMethodData::has_escape_info() {
292 return eflag_set(MethodData::estimated);
293 }
294
295 void ciMethodData::set_eflag(MethodData::EscapeFlag f) {
296 set_bits(_eflags, f);
297 }
298
299 void ciMethodData::clear_eflag(MethodData::EscapeFlag f) {
300 clear_bits(_eflags, f);
301 }
302
303 bool ciMethodData::eflag_set(MethodData::EscapeFlag f) const {
304 return mask_bits(_eflags, f) != 0;
305 }
306
307 void ciMethodData::set_arg_local(int i) {
308 set_nth_bit(_arg_local, i);
309 }
310
311 void ciMethodData::set_arg_stack(int i) {
312 set_nth_bit(_arg_stack, i);
313 }
314
315 void ciMethodData::set_arg_returned(int i) {
316 set_nth_bit(_arg_returned, i);
317 }
318
319 void ciMethodData::set_arg_modified(int arg, uint val) {
320 ArgInfoData *aid = arg_info();
321 if (aid == NULL)
322 return;
323 assert(arg >= 0 && arg < aid->number_of_args(), "valid argument number");
324 aid->set_arg_modified(arg, val);
325 }
326
327 bool ciMethodData::is_arg_local(int i) const {
328 return is_set_nth_bit(_arg_local, i);
329 }
330
331 bool ciMethodData::is_arg_stack(int i) const {
332 return is_set_nth_bit(_arg_stack, i);
333 }
334
335 bool ciMethodData::is_arg_returned(int i) const {
336 return is_set_nth_bit(_arg_returned, i);
337 }
338
339 uint ciMethodData::arg_modified(int arg) const {
340 ArgInfoData *aid = arg_info();
341 if (aid == NULL)
342 return 0;
343 assert(arg >= 0 && arg < aid->number_of_args(), "valid argument number");
344 return aid->arg_modified(arg);
345 }
346
347 ByteSize ciMethodData::offset_of_slot(ciProfileData* data, ByteSize slot_offset_in_data) {
348 // Get offset within MethodData* of the data array
349 ByteSize data_offset = MethodData::data_offset();
350
351 // Get cell offset of the ProfileData within data array
352 int cell_offset = dp_to_di(data->dp());
353
354 // Add in counter_offset, the # of bytes into the ProfileData of counter or flag
355 int offset = in_bytes(data_offset) + cell_offset + in_bytes(slot_offset_in_data);
356
357 return in_ByteSize(offset);
358 }
359
360 ciArgInfoData *ciMethodData::arg_info() const {
361 // Should be last, have to skip all traps.
362 DataLayout* dp = data_layout_at(data_size());
363 DataLayout* end = data_layout_at(data_size() + extra_data_size());
364 for (; dp < end; dp = MethodData::next_extra(dp)) {
365 if (dp->tag() == DataLayout::arg_info_data_tag)
366 return new ciArgInfoData(dp);
367 }
368 return NULL;
369 }
370
371
372 // Implementation of the print method.
373 void ciMethodData::print_impl(outputStream* st) {
374 ciMetadata::print_impl(st);
375 }
376
377 void ciMethodData::dump_replay_data(outputStream* out) {
378 ResourceMark rm;
379 MethodData* mdo = get_MethodData();
380 Method* method = mdo->method();
381 Klass* holder = method->method_holder();
382 out->print("ciMethodData %s %s %s %d %d",
383 holder->name()->as_quoted_ascii(),
384 method->name()->as_quoted_ascii(),
385 method->signature()->as_quoted_ascii(),
386 _state,
387 current_mileage());
388
389 // dump the contents of the MDO header as raw data
390 unsigned char* orig = (unsigned char*)&_orig;
391 int length = sizeof(_orig);
392 out->print(" orig %d", length);
393 for (int i = 0; i < length; i++) {
394 out->print(" %d", orig[i]);
395 }
396
397 // dump the MDO data as raw data
398 int elements = data_size() / sizeof(intptr_t);
399 out->print(" data %d", elements);
400 for (int i = 0; i < elements; i++) {
401 // We could use INTPTR_FORMAT here but that's a zero justified
402 // which makes comparing it with the SA version of this output
403 // harder.
404 #ifdef _LP64
405 out->print(" 0x%" FORMAT64_MODIFIER "x", data()[i]);
406 #else
407 out->print(" 0x%x", data()[i]);
408 #endif
409 }
410
411 // The MDO contained oop references as ciObjects, so scan for those
412 // and emit pairs of offset and klass name so that they can be
413 // reconstructed at runtime. The first round counts the number of
414 // oop references and the second actually emits them.
415 int count = 0;
416 for (int round = 0; round < 2; round++) {
417 if (round == 1) out->print(" oops %d", count);
418 ProfileData* pdata = first_data();
419 for ( ; is_valid(pdata); pdata = next_data(pdata)) {
420 if (pdata->is_ReceiverTypeData()) {
421 ciReceiverTypeData* vdata = (ciReceiverTypeData*)pdata;
422 for (uint i = 0; i < vdata->row_limit(); i++) {
423 ciKlass* k = vdata->receiver(i);
424 if (k != NULL) {
425 if (round == 0) {
426 count++;
427 } else {
428 out->print(" %d %s", dp_to_di(vdata->dp() + in_bytes(vdata->receiver_offset(i))) / sizeof(intptr_t), k->name()->as_quoted_ascii());
429 }
430 }
431 }
432 } else if (pdata->is_VirtualCallData()) {
433 ciVirtualCallData* vdata = (ciVirtualCallData*)pdata;
434 for (uint i = 0; i < vdata->row_limit(); i++) {
435 ciKlass* k = vdata->receiver(i);
436 if (k != NULL) {
437 if (round == 0) {
438 count++;
439 } else {
440 out->print(" %d %s", dp_to_di(vdata->dp() + in_bytes(vdata->receiver_offset(i))) / sizeof(intptr_t), k->name()->as_quoted_ascii());
441 }
442 }
443 }
444 }
445 }
446 }
447 out->cr();
448 }
449
450 #ifndef PRODUCT
451 void ciMethodData::print() {
452 print_data_on(tty);
453 }
454
455 void ciMethodData::print_data_on(outputStream* st) {
456 ResourceMark rm;
457 ciProfileData* data;
458 for (data = first_data(); is_valid(data); data = next_data(data)) {
459 st->print("%d", dp_to_di(data->dp()));
460 st->fill_to(6);
461 data->print_data_on(st);
462 }
463 st->print_cr("--- Extra data:");
464 DataLayout* dp = data_layout_at(data_size());
465 DataLayout* end = data_layout_at(data_size() + extra_data_size());
466 for (; dp < end; dp = MethodData::next_extra(dp)) {
467 if (dp->tag() == DataLayout::no_tag) continue;
468 if (dp->tag() == DataLayout::bit_data_tag) {
469 data = new BitData(dp);
470 } else {
471 assert(dp->tag() == DataLayout::arg_info_data_tag, "must be BitData or ArgInfo");
472 data = new ciArgInfoData(dp);
473 dp = end; // ArgInfoData is at the end of extra data section.
474 }
475 st->print("%d", dp_to_di(data->dp()));
476 st->fill_to(6);
477 data->print_data_on(st);
478 }
479 }
480
481 void ciReceiverTypeData::print_receiver_data_on(outputStream* st) {
482 uint row;
483 int entries = 0;
484 for (row = 0; row < row_limit(); row++) {
485 if (receiver(row) != NULL) entries++;
486 }
487 st->print_cr("count(%u) entries(%u)", count(), entries);
488 for (row = 0; row < row_limit(); row++) {
489 if (receiver(row) != NULL) {
490 tab(st);
491 receiver(row)->print_name_on(st);
492 st->print_cr("(%u)", receiver_count(row));
493 }
494 }
495 }
496
497 void ciReceiverTypeData::print_data_on(outputStream* st) {
498 print_shared(st, "ciReceiverTypeData");
499 print_receiver_data_on(st);
500 }
501
502 void ciVirtualCallData::print_data_on(outputStream* st) {
503 print_shared(st, "ciVirtualCallData");
504 rtd_super()->print_receiver_data_on(st);
505 }
506 #endif