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