1 /*
2 * Copyright (c) 2001, 2012, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 *
23 */
24
25 #ifndef SHARE_VM_CI_CIMETHODDATA_HPP
26 #define SHARE_VM_CI_CIMETHODDATA_HPP
27
28 #include "ci/ciClassList.hpp"
29 #include "ci/ciKlass.hpp"
30 #include "ci/ciObject.hpp"
31 #include "ci/ciUtilities.hpp"
32 #include "oops/methodData.hpp"
33 #include "oops/oop.inline.hpp"
34
35 class ciBitData;
36 class ciCounterData;
37 class ciJumpData;
38 class ciReceiverTypeData;
39 class ciRetData;
40 class ciBranchData;
41 class ciArrayData;
42 class ciMultiBranchData;
43 class ciArgInfoData;
44 class ciCallTypeData;
45 class ciVirtualCallTypeData;
46
47 typedef ProfileData ciProfileData;
48
49 class ciBitData : public BitData {
50 public:
51 ciBitData(DataLayout* layout) : BitData(layout) {};
52 };
53
54 class ciCounterData : public CounterData {
55 public:
56 ciCounterData(DataLayout* layout) : CounterData(layout) {};
57 };
58
59 class ciJumpData : public JumpData {
60 public:
61 ciJumpData(DataLayout* layout) : JumpData(layout) {};
62 };
63
64 class ciTypeEntries {
65 protected:
66 static intptr_t translate_klass(intptr_t k) {
67 Klass* v = TypeEntries::valid_klass(k);
68 if (v != NULL) {
69 ciKlass* klass = CURRENT_ENV->get_klass(v);
70 return TypeEntries::with_status((intptr_t)klass, k);
71 }
72 return TypeEntries::with_status(0, k);
73 }
74
75 public:
76 static ciKlass* valid_ciklass(intptr_t k) {
77 if (!TypeEntries::is_type_none(k) &&
78 !TypeEntries::is_type_unknown(k)) {
79 return (ciKlass*)TypeEntries::klass_part(k);
80 } else {
81 return NULL;
82 }
83 }
84
85 #ifndef PRODUCT
86 static void print_ciklass(outputStream* st, intptr_t k);
87 #endif
88 };
89
90 class ciTypeStackSlotEntries : public TypeStackSlotEntries, ciTypeEntries {
91 public:
92 void translate_type_data_from(const TypeStackSlotEntries* args);
93
94 ciKlass* valid_type(int i) const {
95 return valid_ciklass(type(i));
96 }
97
98 #ifndef PRODUCT
99 void print_data_on(outputStream* st) const;
100 #endif
101 };
102
103 class ciCallTypeData : public CallTypeData {
104 public:
105 ciCallTypeData(DataLayout* layout) : CallTypeData(layout) {}
106
107 ciTypeStackSlotEntries* args() const { return (ciTypeStackSlotEntries*)CallTypeData::args(); }
108
109 virtual void translate_from(const ProfileData* data) {
110 args()->translate_type_data_from(data->as_CallTypeData()->args());
111 }
112
113 ciKlass* valid_argument_type(int i) const {
114 return args()->valid_type(i);
115 }
116
117 #ifndef PRODUCT
118 void print_data_on(outputStream* st) const;
119 #endif
120 };
121
122 class ciReceiverTypeData : public ReceiverTypeData {
123 public:
124 ciReceiverTypeData(DataLayout* layout) : ReceiverTypeData(layout) {};
125
126 void set_receiver(uint row, ciKlass* recv) {
127 assert((uint)row < row_limit(), "oob");
128 set_intptr_at(receiver0_offset + row * receiver_type_row_cell_count,
129 (intptr_t) recv);
130 }
131
132 ciKlass* receiver(uint row) const {
133 assert((uint)row < row_limit(), "oob");
134 ciKlass* recv = (ciKlass*)intptr_at(receiver0_offset + row * receiver_type_row_cell_count);
135 assert(recv == NULL || recv->is_klass(), "wrong type");
136 return recv;
137 }
138
139 // Copy & translate from oop based ReceiverTypeData
140 virtual void translate_from(const ProfileData* data) {
141 translate_receiver_data_from(data);
142 }
143 void translate_receiver_data_from(const ProfileData* data);
144 #ifndef PRODUCT
145 void print_data_on(outputStream* st) const;
146 void print_receiver_data_on(outputStream* st) const;
147 #endif
148 };
149
150 class ciVirtualCallData : public VirtualCallData {
151 // Fake multiple inheritance... It's a ciReceiverTypeData also.
152 ciReceiverTypeData* rtd_super() const { return (ciReceiverTypeData*) this; }
153
154 public:
155 ciVirtualCallData(DataLayout* layout) : VirtualCallData(layout) {};
156
157 void set_receiver(uint row, ciKlass* recv) {
158 rtd_super()->set_receiver(row, recv);
159 }
160
161 ciKlass* receiver(uint row) {
162 return rtd_super()->receiver(row);
163 }
164
165 // Copy & translate from oop based VirtualCallData
166 virtual void translate_from(const ProfileData* data) {
167 rtd_super()->translate_receiver_data_from(data);
168 }
169 #ifndef PRODUCT
170 void print_data_on(outputStream* st) const;
171 #endif
172 };
173
174 class ciVirtualCallTypeData : public VirtualCallTypeData {
175 private:
176 // Fake multiple inheritance... It's a ciReceiverTypeData also.
177 ciReceiverTypeData* rtd_super() const { return (ciReceiverTypeData*) this; }
178
179 public:
180 ciVirtualCallTypeData(DataLayout* layout) : VirtualCallTypeData(layout) {}
181
182 ciTypeStackSlotEntries* args() const { return (ciTypeStackSlotEntries*)VirtualCallTypeData::args(); }
183
184 void set_receiver(uint row, ciKlass* recv) {
185 rtd_super()->set_receiver(row, recv);
186 }
187
188 ciKlass* receiver(uint row) const {
189 return rtd_super()->receiver(row);
190 }
191
192 // Copy & translate from oop based VirtualCallData
193 virtual void translate_from(const ProfileData* data) {
194 rtd_super()->translate_receiver_data_from(data);
195 args()->translate_type_data_from(data->as_VirtualCallTypeData()->args());
196 }
197
198 ciKlass* valid_argument_type(int i) const {
199 return args()->valid_type(i);
200 }
201
202 #ifndef PRODUCT
203 void print_data_on(outputStream* st) const;
204 #endif
205 };
206
207
208 class ciRetData : public RetData {
209 public:
210 ciRetData(DataLayout* layout) : RetData(layout) {};
211 };
212
213 class ciBranchData : public BranchData {
214 public:
215 ciBranchData(DataLayout* layout) : BranchData(layout) {};
216 };
217
218 class ciArrayData : public ArrayData {
219 public:
220 ciArrayData(DataLayout* layout) : ArrayData(layout) {};
221 };
222
223 class ciMultiBranchData : public MultiBranchData {
224 public:
225 ciMultiBranchData(DataLayout* layout) : MultiBranchData(layout) {};
226 };
227
228 class ciArgInfoData : public ArgInfoData {
229 public:
230 ciArgInfoData(DataLayout* layout) : ArgInfoData(layout) {};
231 };
232
233 // ciMethodData
234 //
235 // This class represents a MethodData* in the HotSpot virtual
236 // machine.
237
238 class ciMethodData : public ciMetadata {
239 CI_PACKAGE_ACCESS
240 friend class ciReplay;
241
242 private:
243 // Size in bytes
244 int _data_size;
245 int _extra_data_size;
246
247 // Data entries
248 intptr_t* _data;
249
250 // Cached hint for data_before()
251 int _hint_di;
252
253 // Is data attached? And is it mature?
254 enum { empty_state, immature_state, mature_state };
255 u_char _state;
256
257 // Set this true if empty extra_data slots are ever witnessed.
258 u_char _saw_free_extra_data;
259
260 // Support for interprocedural escape analysis
261 intx _eflags; // flags on escape information
262 intx _arg_local; // bit set of non-escaping arguments
263 intx _arg_stack; // bit set of stack-allocatable arguments
264 intx _arg_returned; // bit set of returned arguments
265
266 // Maturity of the oop when the snapshot is taken.
267 int _current_mileage;
268
269 // These counters hold the age of MDO in tiered. In tiered we can have the same method
270 // running at different compilation levels concurrently. So, in order to precisely measure
271 // its maturity we need separate counters.
272 int _invocation_counter;
273 int _backedge_counter;
274
275 // Coherent snapshot of original header.
276 MethodData _orig;
277
278 ciMethodData(MethodData* md);
279 ciMethodData();
280
281 // Accessors
282 int data_size() const { return _data_size; }
283 int extra_data_size() const { return _extra_data_size; }
284 intptr_t * data() const { return _data; }
285
286 MethodData* get_MethodData() const {
287 return (MethodData*)_metadata;
288 }
289
290 const char* type_string() { return "ciMethodData"; }
291
292 void print_impl(outputStream* st);
293
294 DataLayout* data_layout_at(int data_index) const {
295 assert(data_index % sizeof(intptr_t) == 0, "unaligned");
296 return (DataLayout*) (((address)_data) + data_index);
297 }
298
299 bool out_of_bounds(int data_index) {
300 return data_index >= data_size();
301 }
302
303 // hint accessors
304 int hint_di() const { return _hint_di; }
305 void set_hint_di(int di) {
306 assert(!out_of_bounds(di), "hint_di out of bounds");
307 _hint_di = di;
308 }
309 ciProfileData* data_before(int bci) {
310 // avoid SEGV on this edge case
311 if (data_size() == 0)
312 return NULL;
313 int hint = hint_di();
314 if (data_layout_at(hint)->bci() <= bci)
315 return data_at(hint);
316 return first_data();
317 }
318
319
320 // What is the index of the first data entry?
321 int first_di() { return 0; }
322
323 ciArgInfoData *arg_info() const;
324
325 public:
326 bool is_method_data() const { return true; }
327
328 void set_mature() { _state = mature_state; }
329
330 bool is_empty() { return _state == empty_state; }
331 bool is_mature() { return _state == mature_state; }
332
333 int creation_mileage() { return _orig.creation_mileage(); }
334 int current_mileage() { return _current_mileage; }
335
336 int invocation_count() { return _invocation_counter; }
337 int backedge_count() { return _backedge_counter; }
338 // Transfer information about the method to MethodData*.
339 // would_profile means we would like to profile this method,
340 // meaning it's not trivial.
341 void set_would_profile(bool p);
342 // Also set the numer of loops and blocks in the method.
343 // Again, this is used to determine if a method is trivial.
344 void set_compilation_stats(short loops, short blocks);
345 // If the compiler finds a profiled type is known statically for
346 // sure, set it in the MethodData
347 void set_argument_type(int bci, int i, ciKlass* k);
348
349 void load_data();
350
351 // Convert a dp (data pointer) to a di (data index).
352 int dp_to_di(address dp) {
353 return dp - ((address)_data);
354 }
355
356 // Get the data at an arbitrary (sort of) data index.
357 ciProfileData* data_at(int data_index);
358
359 // Walk through the data in order.
360 ciProfileData* first_data() { return data_at(first_di()); }
361 ciProfileData* next_data(ciProfileData* current);
362 bool is_valid(ciProfileData* current) { return current != NULL; }
363
364 // Get the data at an arbitrary bci, or NULL if there is none.
365 ciProfileData* bci_to_data(int bci);
366 ciProfileData* bci_to_extra_data(int bci, bool create_if_missing);
367
368 uint overflow_trap_count() const {
369 return _orig.overflow_trap_count();
370 }
371 uint overflow_recompile_count() const {
372 return _orig.overflow_recompile_count();
373 }
374 uint decompile_count() const {
375 return _orig.decompile_count();
376 }
377 uint trap_count(int reason) const {
378 return _orig.trap_count(reason);
379 }
380 uint trap_reason_limit() const { return _orig.trap_reason_limit(); }
381 uint trap_count_limit() const { return _orig.trap_count_limit(); }
382
383 // Helpful query functions that decode trap_state.
384 int has_trap_at(ciProfileData* data, int reason);
385 int has_trap_at(int bci, int reason) {
386 return has_trap_at(bci_to_data(bci), reason);
387 }
388 int trap_recompiled_at(ciProfileData* data);
389 int trap_recompiled_at(int bci) {
390 return trap_recompiled_at(bci_to_data(bci));
391 }
392
393 void clear_escape_info();
394 bool has_escape_info();
395 void update_escape_info();
396
397 void set_eflag(MethodData::EscapeFlag f);
398 void clear_eflag(MethodData::EscapeFlag f);
399 bool eflag_set(MethodData::EscapeFlag f) const;
400
401 void set_arg_local(int i);
402 void set_arg_stack(int i);
403 void set_arg_returned(int i);
404 void set_arg_modified(int arg, uint val);
405
406 bool is_arg_local(int i) const;
407 bool is_arg_stack(int i) const;
408 bool is_arg_returned(int i) const;
409 uint arg_modified(int arg) const;
410
411 // Code generation helper
412 ByteSize offset_of_slot(ciProfileData* data, ByteSize slot_offset_in_data);
413 int byte_offset_of_slot(ciProfileData* data, ByteSize slot_offset_in_data) { return in_bytes(offset_of_slot(data, slot_offset_in_data)); }
414
415 #ifndef PRODUCT
416 // printing support for method data
417 void print();
418 void print_data_on(outputStream* st);
419 #endif
420 void dump_replay_data(outputStream* out);
421 };
422
423 #endif // SHARE_VM_CI_CIMETHODDATA_HPP