1 /*
2 * Copyright (c) 1999, 2018, 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/ciCallSite.hpp"
27 #include "ci/ciConstant.hpp"
28 #include "ci/ciField.hpp"
29 #include "ci/ciStreams.hpp"
30 #include "ci/ciUtilities.inline.hpp"
31 #include "runtime/handles.inline.hpp"
32
33 // ciExceptionHandlerStream
34 //
35 // Walk over some selected set of a methods exception handlers.
36
37 // ------------------------------------------------------------------
38 // ciExceptionHandlerStream::count
39 //
40 // How many exception handlers are there in this stream?
41 //
42 // Implementation note: Compiler2 needs this functionality, so I had
43 int ciExceptionHandlerStream::count() {
44 int save_pos = _pos;
45 int save_end = _end;
46
47 int count = 0;
48
49 _pos = -1;
50 _end = _method->_handler_count;
51
52
53 next();
54 while (!is_done()) {
55 count++;
56 next();
57 }
58
59 _pos = save_pos;
60 _end = save_end;
61
62 return count;
63 }
64
65 int ciExceptionHandlerStream::count_remaining() {
66 int save_pos = _pos;
67 int save_end = _end;
68
69 int count = 0;
70
71 while (!is_done()) {
72 count++;
73 next();
74 }
75
76 _pos = save_pos;
77 _end = save_end;
78
79 return count;
80 }
81
82 // ciBytecodeStream
83 //
84 // The class is used to iterate over the bytecodes of a method.
85 // It hides the details of constant pool structure/access by
86 // providing accessors for constant pool items.
87
88 // ------------------------------------------------------------------
89 // ciBytecodeStream::next_wide_or_table
90 //
91 // Special handling for switch ops
92 Bytecodes::Code ciBytecodeStream::next_wide_or_table(Bytecodes::Code bc) {
93 switch (bc) { // Check for special bytecode handling
94 case Bytecodes::_wide:
95 // Special handling for the wide bytcode
96 // Get following bytecode; do not return wide
97 assert(Bytecodes::Code(_pc[0]) == Bytecodes::_wide, "");
98 bc = Bytecodes::java_code(_raw_bc = (Bytecodes::Code)_pc[1]);
99 assert(Bytecodes::wide_length_for(bc) > 2, "must make progress");
100 _pc += Bytecodes::wide_length_for(bc);
101 _was_wide = _pc; // Flag last wide bytecode found
102 assert(is_wide(), "accessor works right");
103 break;
104
105 case Bytecodes::_lookupswitch:
106 _pc++; // Skip wide bytecode
107 _pc += (_start-_pc)&3; // Word align
108 _table_base = (jint*)_pc; // Capture for later usage
109 // table_base[0] is default far_dest
110 // Table has 2 lead elements (default, length), then pairs of u4 values.
111 // So load table length, and compute address at end of table
112 _pc = (address)&_table_base[2+ 2*Bytes::get_Java_u4((address)&_table_base[1])];
113 break;
114
115 case Bytecodes::_tableswitch: {
116 _pc++; // Skip wide bytecode
117 _pc += (_start-_pc)&3; // Word align
118 _table_base = (jint*)_pc; // Capture for later usage
119 // table_base[0] is default far_dest
120 int lo = Bytes::get_Java_u4((address)&_table_base[1]);// Low bound
121 int hi = Bytes::get_Java_u4((address)&_table_base[2]);// High bound
122 int len = hi - lo + 1; // Dense table size
123 _pc = (address)&_table_base[3+len]; // Skip past table
124 break;
125 }
126
127 default:
128 fatal("unhandled bytecode");
129 }
130 return bc;
131 }
132
133 // ------------------------------------------------------------------
134 // ciBytecodeStream::reset_to_bci
135 void ciBytecodeStream::reset_to_bci( int bci ) {
136 _bc_start=_was_wide=0;
137 _pc = _start+bci;
138 }
139
140 // ------------------------------------------------------------------
141 // ciBytecodeStream::force_bci
142 void ciBytecodeStream::force_bci(int bci) {
143 if (bci < 0) {
144 reset_to_bci(0);
145 _bc_start = _start + bci;
146 _bc = EOBC();
147 } else {
148 reset_to_bci(bci);
149 next();
150 }
151 }
152
153
154 // ------------------------------------------------------------------
155 // Constant pool access
156 // ------------------------------------------------------------------
157
158 // ------------------------------------------------------------------
159 // ciBytecodeStream::get_klass_index
160 //
161 // If this bytecodes references a klass, return the index of the
162 // referenced klass.
163 int ciBytecodeStream::get_klass_index() const {
164 switch(cur_bc()) {
165 case Bytecodes::_ldc:
166 return get_index_u1();
167 case Bytecodes::_ldc_w:
168 case Bytecodes::_ldc2_w:
169 case Bytecodes::_checkcast:
170 case Bytecodes::_instanceof:
171 case Bytecodes::_anewarray:
172 case Bytecodes::_multianewarray:
173 case Bytecodes::_new:
174 case Bytecodes::_newarray:
175 return get_index_u2();
176 default:
177 ShouldNotReachHere();
178 return 0;
179 }
180 }
181
182 // ------------------------------------------------------------------
183 // ciBytecodeStream::get_klass
184 //
185 // If this bytecode is a new, newarray, multianewarray, instanceof,
186 // or checkcast, get the referenced klass.
187 ciKlass* ciBytecodeStream::get_klass(bool& will_link) {
188 VM_ENTRY_MARK;
189 constantPoolHandle cpool(_method->get_Method()->constants());
190 return CURRENT_ENV->get_klass_by_index(cpool, get_klass_index(), will_link, _holder);
191 }
192
193 // ------------------------------------------------------------------
194 // ciBytecodeStream::get_constant_raw_index
195 //
196 // If this bytecode is one of the ldc variants, get the index of the
197 // referenced constant.
198 int ciBytecodeStream::get_constant_raw_index() const {
199 // work-alike for Bytecode_loadconstant::raw_index()
200 switch (cur_bc()) {
201 case Bytecodes::_ldc:
202 return get_index_u1();
203 case Bytecodes::_ldc_w:
204 case Bytecodes::_ldc2_w:
205 return get_index_u2();
206 default:
207 ShouldNotReachHere();
208 return 0;
209 }
210 }
211
212 // ------------------------------------------------------------------
213 // ciBytecodeStream::get_constant_pool_index
214 // Decode any reference index into a regular pool index.
215 int ciBytecodeStream::get_constant_pool_index() const {
216 // work-alike for Bytecode_loadconstant::pool_index()
217 int index = get_constant_raw_index();
218 if (has_cache_index()) {
219 VM_ENTRY_MARK;
220 constantPoolHandle cpool(_method->get_Method()->constants());
221 return cpool->object_to_cp_index(index);
222 }
223 return index;
224 }
225
226 // ------------------------------------------------------------------
227 // ciBytecodeStream::get_constant_cache_index
228 // Return the CP cache index, or -1 if there isn't any.
229 int ciBytecodeStream::get_constant_cache_index() const {
230 // work-alike for Bytecode_loadconstant::cache_index()
231 return has_cache_index() ? get_constant_raw_index() : -1;
232 }
233
234 // ------------------------------------------------------------------
235 // ciBytecodeStream::get_constant
236 //
237 // If this bytecode is one of the ldc variants, get the referenced
238 // constant.
239 ciConstant ciBytecodeStream::get_constant() {
240 int pool_index = get_constant_raw_index();
241 int cache_index = -1;
242 if (has_cache_index()) {
243 cache_index = pool_index;
244 pool_index = -1;
245 }
246 VM_ENTRY_MARK;
247 constantPoolHandle cpool(_method->get_Method()->constants());
248 return CURRENT_ENV->get_constant_by_index(cpool, pool_index, cache_index, _holder);
249 }
250
251 // ------------------------------------------------------------------
252 // ciBytecodeStream::get_constant_pool_tag
253 //
254 // If this bytecode is one of the ldc variants, get the referenced
255 // constant.
256 constantTag ciBytecodeStream::get_constant_pool_tag(int index) const {
257 VM_ENTRY_MARK;
258 return _method->get_Method()->constants()->constant_tag_at(index);
259 }
260
261 // ------------------------------------------------------------------
262 // ciBytecodeStream::get_field_index
263 //
264 // If this is a field access bytecode, get the constant pool
265 // index of the referenced field.
266 int ciBytecodeStream::get_field_index() {
267 assert(cur_bc() == Bytecodes::_getfield ||
268 cur_bc() == Bytecodes::_putfield ||
269 cur_bc() == Bytecodes::_getstatic ||
270 cur_bc() == Bytecodes::_putstatic, "wrong bc");
271 return get_index_u2_cpcache();
272 }
273
274
275 // ------------------------------------------------------------------
276 // ciBytecodeStream::get_field
277 //
278 // If this bytecode is one of get_field, get_static, put_field,
279 // or put_static, get the referenced field.
280 ciField* ciBytecodeStream::get_field(bool& will_link) {
281 ciField* f = CURRENT_ENV->get_field_by_index(_holder, get_field_index());
282 will_link = f->will_link(_method, _bc);
283 return f;
284 }
285
286
287 // ------------------------------------------------------------------
288 // ciBytecodeStream::get_declared_field_holder
289 //
290 // Get the declared holder of the currently referenced field.
291 //
292 // Usage note: the holder() of a ciField class returns the canonical
293 // holder of the field, rather than the holder declared in the
294 // bytecodes.
295 //
296 // There is no "will_link" result passed back. The user is responsible
297 // for checking linkability when retrieving the associated field.
298 ciInstanceKlass* ciBytecodeStream::get_declared_field_holder() {
299 VM_ENTRY_MARK;
300 constantPoolHandle cpool(_method->get_Method()->constants());
301 int holder_index = get_field_holder_index();
302 bool ignore;
303 return CURRENT_ENV->get_klass_by_index(cpool, holder_index, ignore, _holder)
304 ->as_instance_klass();
305 }
306
307 // ------------------------------------------------------------------
308 // ciBytecodeStream::get_field_holder_index
309 //
310 // Get the constant pool index of the declared holder of the field
311 // referenced by the current bytecode. Used for generating
312 // deoptimization information.
313 int ciBytecodeStream::get_field_holder_index() {
314 GUARDED_VM_ENTRY(
315 ConstantPool* cpool = _holder->get_instanceKlass()->constants();
316 return cpool->klass_ref_index_at(get_field_index());
317 )
318 }
319
320 // ------------------------------------------------------------------
321 // ciBytecodeStream::get_field_signature_index
322 //
323 // Get the constant pool index of the signature of the field
324 // referenced by the current bytecode. Used for generating
325 // deoptimization information.
326 int ciBytecodeStream::get_field_signature_index() {
327 VM_ENTRY_MARK;
328 ConstantPool* cpool = _holder->get_instanceKlass()->constants();
329 int nt_index = cpool->name_and_type_ref_index_at(get_field_index());
330 return cpool->signature_ref_index_at(nt_index);
331 }
332
333 // ------------------------------------------------------------------
334 // ciBytecodeStream::get_method_index
335 //
336 // If this is a method invocation bytecode, get the constant pool
337 // index of the invoked method.
338 int ciBytecodeStream::get_method_index() {
339 #ifdef ASSERT
340 switch (cur_bc()) {
341 case Bytecodes::_invokeinterface:
342 case Bytecodes::_invokevirtual:
343 case Bytecodes::_invokespecial:
344 case Bytecodes::_invokestatic:
345 case Bytecodes::_invokedynamic:
346 break;
347 default:
348 ShouldNotReachHere();
349 }
350 #endif
351 if (has_index_u4())
352 return get_index_u4(); // invokedynamic
353 return get_index_u2_cpcache();
354 }
355
356 // ------------------------------------------------------------------
357 // ciBytecodeStream::get_method
358 //
359 // If this is a method invocation bytecode, get the invoked method.
360 // Additionally return the declared signature to get more concrete
361 // type information if required (Cf. invokedynamic and invokehandle).
362 ciMethod* ciBytecodeStream::get_method(bool& will_link, ciSignature* *declared_signature_result) {
363 VM_ENTRY_MARK;
364 ciEnv* env = CURRENT_ENV;
365 constantPoolHandle cpool(THREAD, _method->get_Method()->constants());
366 ciMethod* m = env->get_method_by_index(cpool, get_method_index(), cur_bc(), _holder);
367 will_link = m->is_loaded();
368
369 // Use the MethodType stored in the CP cache to create a signature
370 // with correct types (in respect to class loaders).
371 if (has_method_type()) {
372 ciSymbol* sig_sym = env->get_symbol(cpool->symbol_at(get_method_signature_index(cpool)));
373 ciKlass* pool_holder = env->get_klass(cpool->pool_holder());
374 ciMethodType* method_type = get_method_type();
375 ciSignature* declared_signature = new (env->arena()) ciSignature(pool_holder, sig_sym, method_type);
376 (*declared_signature_result) = declared_signature;
377 } else {
378 (*declared_signature_result) = m->signature();
379 }
380 return m;
381 }
382
383 // ------------------------------------------------------------------
384 // ciBytecodeStream::has_appendix
385 //
386 // Returns true if there is an appendix argument stored in the
387 // constant pool cache at the current bci.
388 bool ciBytecodeStream::has_appendix() {
389 VM_ENTRY_MARK;
390 constantPoolHandle cpool(_method->get_Method()->constants());
391 return ConstantPool::has_appendix_at_if_loaded(cpool, get_method_index());
392 }
393
394 // ------------------------------------------------------------------
395 // ciBytecodeStream::get_appendix
396 //
397 // Return the appendix argument stored in the constant pool cache at
398 // the current bci.
399 ciObject* ciBytecodeStream::get_appendix() {
400 VM_ENTRY_MARK;
401 constantPoolHandle cpool(_method->get_Method()->constants());
402 oop appendix_oop = ConstantPool::appendix_at_if_loaded(cpool, get_method_index());
403 return CURRENT_ENV->get_object(appendix_oop);
404 }
405
406 // ------------------------------------------------------------------
407 // ciBytecodeStream::has_method_type
408 //
409 // Returns true if there is a MethodType argument stored in the
410 // constant pool cache at the current bci.
411 bool ciBytecodeStream::has_method_type() {
412 GUARDED_VM_ENTRY(
413 constantPoolHandle cpool(_method->get_Method()->constants());
414 return ConstantPool::has_method_type_at_if_loaded(cpool, get_method_index());
415 )
416 }
417
418 // ------------------------------------------------------------------
419 // ciBytecodeStream::get_method_type
420 //
421 // Return the MethodType stored in the constant pool cache at
422 // the current bci.
423 ciMethodType* ciBytecodeStream::get_method_type() {
424 GUARDED_VM_ENTRY(
425 constantPoolHandle cpool(_method->get_Method()->constants());
426 oop method_type_oop = ConstantPool::method_type_at_if_loaded(cpool, get_method_index());
427 return CURRENT_ENV->get_object(method_type_oop)->as_method_type();
428 )
429 }
430
431 // ------------------------------------------------------------------
432 // ciBytecodeStream::get_declared_method_holder
433 //
434 // Get the declared holder of the currently referenced method.
435 //
436 // Usage note: the holder() of a ciMethod class returns the canonical
437 // holder of the method, rather than the holder declared in the
438 // bytecodes.
439 //
440 // There is no "will_link" result passed back. The user is responsible
441 // for checking linkability when retrieving the associated method.
442 ciKlass* ciBytecodeStream::get_declared_method_holder() {
443 VM_ENTRY_MARK;
444 constantPoolHandle cpool(_method->get_Method()->constants());
445 bool ignore;
446 // report as MethodHandle for invokedynamic, which is syntactically classless
447 if (cur_bc() == Bytecodes::_invokedynamic)
448 return CURRENT_ENV->get_klass_by_name(_holder, ciSymbol::java_lang_invoke_MethodHandle(), false);
449 return CURRENT_ENV->get_klass_by_index(cpool, get_method_holder_index(), ignore, _holder);
450 }
451
452 // ------------------------------------------------------------------
453 // ciBytecodeStream::get_method_holder_index
454 //
455 // Get the constant pool index of the declared holder of the method
456 // referenced by the current bytecode. Used for generating
457 // deoptimization information.
458 int ciBytecodeStream::get_method_holder_index() {
459 ConstantPool* cpool = _method->get_Method()->constants();
460 return cpool->klass_ref_index_at(get_method_index());
461 }
462
463 // ------------------------------------------------------------------
464 // ciBytecodeStream::get_method_signature_index
465 //
466 // Get the constant pool index of the signature of the method
467 // referenced by the current bytecode. Used for generating
468 // deoptimization information.
469 int ciBytecodeStream::get_method_signature_index(const constantPoolHandle& cpool) {
470 GUARDED_VM_ENTRY(
471 const int method_index = get_method_index();
472 const int name_and_type_index = cpool->name_and_type_ref_index_at(method_index);
473 return cpool->signature_ref_index_at(name_and_type_index);
474 )
475 }
476
477 // ------------------------------------------------------------------
478 // ciBytecodeStream::get_resolved_references
479 ciObjArray* ciBytecodeStream::get_resolved_references() {
480 VM_ENTRY_MARK;
481 // Get the constant pool.
482 ConstantPool* cpool = _holder->get_instanceKlass()->constants();
483
484 // Create a resolved references array and return it.
485 return CURRENT_ENV->get_object(cpool->resolved_references())->as_obj_array();
486 }