src/share/vm/interpreter/rewriter.cpp

Tue, 24 Jul 2012 10:51:00 -0700

author
twisti
date
Tue, 24 Jul 2012 10:51:00 -0700
changeset 3969
1d7922586cf6
parent 2945
d3b9f2be46ab
child 4037
da91efe96a93
permissions
-rw-r--r--

7023639: JSR 292 method handle invocation needs a fast path for compiled code
6984705: JSR 292 method handle creation should not go through JNI
Summary: remove assembly code for JDK 7 chained method handles
Reviewed-by: jrose, twisti, kvn, mhaupt
Contributed-by: John Rose <john.r.rose@oracle.com>, Christian Thalinger <christian.thalinger@oracle.com>, Michael Haupt <michael.haupt@oracle.com>

     1 /*
     2  * Copyright (c) 1998, 2011, 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  */
    25 #include "precompiled.hpp"
    26 #include "interpreter/bytecodes.hpp"
    27 #include "interpreter/interpreter.hpp"
    28 #include "interpreter/rewriter.hpp"
    29 #include "memory/gcLocker.hpp"
    30 #include "memory/oopFactory.hpp"
    31 #include "memory/resourceArea.hpp"
    32 #include "oops/generateOopMap.hpp"
    33 #include "oops/objArrayOop.hpp"
    34 #include "oops/oop.inline.hpp"
    35 #include "prims/methodComparator.hpp"
    36 #include "prims/methodHandles.hpp"
    38 // Computes a CPC map (new_index -> original_index) for constant pool entries
    39 // that are referred to by the interpreter at runtime via the constant pool cache.
    40 // Also computes a CP map (original_index -> new_index).
    41 // Marks entries in CP which require additional processing.
    42 void Rewriter::compute_index_maps() {
    43   const int length  = _pool->length();
    44   init_cp_map(length);
    45   bool saw_mh_symbol = false;
    46   for (int i = 0; i < length; i++) {
    47     int tag = _pool->tag_at(i).value();
    48     switch (tag) {
    49       case JVM_CONSTANT_InterfaceMethodref:
    50       case JVM_CONSTANT_Fieldref          : // fall through
    51       case JVM_CONSTANT_Methodref         : // fall through
    52       case JVM_CONSTANT_MethodHandle      : // fall through
    53       case JVM_CONSTANT_MethodType        : // fall through
    54       case JVM_CONSTANT_InvokeDynamic     : // fall through
    55         add_cp_cache_entry(i);
    56         break;
    57       case JVM_CONSTANT_Utf8:
    58         if (_pool->symbol_at(i) == vmSymbols::java_lang_invoke_MethodHandle())
    59           saw_mh_symbol = true;
    60         break;
    61     }
    62   }
    64   guarantee((int)_cp_cache_map.length()-1 <= (int)((u2)-1),
    65             "all cp cache indexes fit in a u2");
    67   if (saw_mh_symbol)
    68     _method_handle_invokers.initialize(length, (int)0);
    69 }
    71 // Unrewrite the bytecodes if an error occurs.
    72 void Rewriter::restore_bytecodes() {
    73   int len = _methods->length();
    75   for (int i = len-1; i >= 0; i--) {
    76     methodOop method = (methodOop)_methods->obj_at(i);
    77     scan_method(method, true);
    78   }
    79 }
    81 // Creates a constant pool cache given a CPC map
    82 void Rewriter::make_constant_pool_cache(TRAPS) {
    83   const int length = _cp_cache_map.length();
    84   constantPoolCacheOop cache =
    85       oopFactory::new_constantPoolCache(length, CHECK);
    86   No_Safepoint_Verifier nsv;
    87   cache->initialize(_cp_cache_map);
    88   _pool->set_cache(cache);
    89   cache->set_constant_pool(_pool());
    90 }
    94 // The new finalization semantics says that registration of
    95 // finalizable objects must be performed on successful return from the
    96 // Object.<init> constructor.  We could implement this trivially if
    97 // <init> were never rewritten but since JVMTI allows this to occur, a
    98 // more complicated solution is required.  A special return bytecode
    99 // is used only by Object.<init> to signal the finalization
   100 // registration point.  Additionally local 0 must be preserved so it's
   101 // available to pass to the registration function.  For simplicty we
   102 // require that local 0 is never overwritten so it's available as an
   103 // argument for registration.
   105 void Rewriter::rewrite_Object_init(methodHandle method, TRAPS) {
   106   RawBytecodeStream bcs(method);
   107   while (!bcs.is_last_bytecode()) {
   108     Bytecodes::Code opcode = bcs.raw_next();
   109     switch (opcode) {
   110       case Bytecodes::_return: *bcs.bcp() = Bytecodes::_return_register_finalizer; break;
   112       case Bytecodes::_istore:
   113       case Bytecodes::_lstore:
   114       case Bytecodes::_fstore:
   115       case Bytecodes::_dstore:
   116       case Bytecodes::_astore:
   117         if (bcs.get_index() != 0) continue;
   119         // fall through
   120       case Bytecodes::_istore_0:
   121       case Bytecodes::_lstore_0:
   122       case Bytecodes::_fstore_0:
   123       case Bytecodes::_dstore_0:
   124       case Bytecodes::_astore_0:
   125         THROW_MSG(vmSymbols::java_lang_IncompatibleClassChangeError(),
   126                   "can't overwrite local 0 in Object.<init>");
   127         break;
   128     }
   129   }
   130 }
   133 // Rewrite a classfile-order CP index into a native-order CPC index.
   134 void Rewriter::rewrite_member_reference(address bcp, int offset, bool reverse) {
   135   address p = bcp + offset;
   136   if (!reverse) {
   137     int  cp_index    = Bytes::get_Java_u2(p);
   138     int  cache_index = cp_entry_to_cp_cache(cp_index);
   139     Bytes::put_native_u2(p, cache_index);
   140     if (!_method_handle_invokers.is_empty())
   141       maybe_rewrite_invokehandle(p - 1, cp_index, reverse);
   142   } else {
   143     int cache_index = Bytes::get_native_u2(p);
   144     int pool_index = cp_cache_entry_pool_index(cache_index);
   145     Bytes::put_Java_u2(p, pool_index);
   146     if (!_method_handle_invokers.is_empty())
   147       maybe_rewrite_invokehandle(p - 1, pool_index, reverse);
   148   }
   149 }
   152 // Adjust the invocation bytecode for a signature-polymorphic method (MethodHandle.invoke, etc.)
   153 void Rewriter::maybe_rewrite_invokehandle(address opc, int cp_index, bool reverse) {
   154   if (!reverse) {
   155     if ((*opc) == (u1)Bytecodes::_invokevirtual ||
   156         // allow invokespecial as an alias, although it would be very odd:
   157         (*opc) == (u1)Bytecodes::_invokespecial) {
   158       assert(_pool->tag_at(cp_index).is_method(), "wrong index");
   159       // Determine whether this is a signature-polymorphic method.
   160       if (cp_index >= _method_handle_invokers.length())  return;
   161       int status = _method_handle_invokers[cp_index];
   162       assert(status >= -1 && status <= 1, "oob tri-state");
   163       if (status == 0) {
   164         if (_pool->klass_ref_at_noresolve(cp_index) == vmSymbols::java_lang_invoke_MethodHandle() &&
   165             MethodHandles::is_signature_polymorphic_name(SystemDictionary::MethodHandle_klass(),
   166                                                          _pool->name_ref_at(cp_index)))
   167           status = +1;
   168         else
   169           status = -1;
   170         _method_handle_invokers[cp_index] = status;
   171       }
   172       // We use a special internal bytecode for such methods (if non-static).
   173       // The basic reason for this is that such methods need an extra "appendix" argument
   174       // to transmit the call site's intended call type.
   175       if (status > 0) {
   176         (*opc) = (u1)Bytecodes::_invokehandle;
   177       }
   178     }
   179   } else {
   180     // Do not need to look at cp_index.
   181     if ((*opc) == (u1)Bytecodes::_invokehandle) {
   182       (*opc) = (u1)Bytecodes::_invokevirtual;
   183       // Ignore corner case of original _invokespecial instruction.
   184       // This is safe because (a) the signature polymorphic method was final, and
   185       // (b) the implementation of MethodHandle will not call invokespecial on it.
   186     }
   187   }
   188 }
   191 void Rewriter::rewrite_invokedynamic(address bcp, int offset, bool reverse) {
   192   address p = bcp + offset;
   193   assert(p[-1] == Bytecodes::_invokedynamic, "not invokedynamic bytecode");
   194   if (!reverse) {
   195     int cp_index = Bytes::get_Java_u2(p);
   196     int cpc  = maybe_add_cp_cache_entry(cp_index);  // add lazily
   197     int cpc2 = add_secondary_cp_cache_entry(cpc);
   199     // Replace the trailing four bytes with a CPC index for the dynamic
   200     // call site.  Unlike other CPC entries, there is one per bytecode,
   201     // not just one per distinct CP entry.  In other words, the
   202     // CPC-to-CP relation is many-to-one for invokedynamic entries.
   203     // This means we must use a larger index size than u2 to address
   204     // all these entries.  That is the main reason invokedynamic
   205     // must have a five-byte instruction format.  (Of course, other JVM
   206     // implementations can use the bytes for other purposes.)
   207     Bytes::put_native_u4(p, constantPoolCacheOopDesc::encode_secondary_index(cpc2));
   208     // Note: We use native_u4 format exclusively for 4-byte indexes.
   209   } else {
   210     int cache_index = constantPoolCacheOopDesc::decode_secondary_index(
   211                         Bytes::get_native_u4(p));
   212     int secondary_index = cp_cache_secondary_entry_main_index(cache_index);
   213     int pool_index = cp_cache_entry_pool_index(secondary_index);
   214     assert(_pool->tag_at(pool_index).is_invoke_dynamic(), "wrong index");
   215     // zero out 4 bytes
   216     Bytes::put_Java_u4(p, 0);
   217     Bytes::put_Java_u2(p, pool_index);
   218   }
   219 }
   222 // Rewrite some ldc bytecodes to _fast_aldc
   223 void Rewriter::maybe_rewrite_ldc(address bcp, int offset, bool is_wide,
   224                                  bool reverse) {
   225   if (!reverse) {
   226     assert((*bcp) == (is_wide ? Bytecodes::_ldc_w : Bytecodes::_ldc), "not ldc bytecode");
   227     address p = bcp + offset;
   228     int cp_index = is_wide ? Bytes::get_Java_u2(p) : (u1)(*p);
   229     constantTag tag = _pool->tag_at(cp_index).value();
   230     if (tag.is_method_handle() || tag.is_method_type()) {
   231       int cache_index = cp_entry_to_cp_cache(cp_index);
   232       if (is_wide) {
   233         (*bcp) = Bytecodes::_fast_aldc_w;
   234         assert(cache_index == (u2)cache_index, "index overflow");
   235         Bytes::put_native_u2(p, cache_index);
   236       } else {
   237         (*bcp) = Bytecodes::_fast_aldc;
   238         assert(cache_index == (u1)cache_index, "index overflow");
   239         (*p) = (u1)cache_index;
   240       }
   241     }
   242   } else {
   243     Bytecodes::Code rewritten_bc =
   244               (is_wide ? Bytecodes::_fast_aldc_w : Bytecodes::_fast_aldc);
   245     if ((*bcp) == rewritten_bc) {
   246       address p = bcp + offset;
   247       int cache_index = is_wide ? Bytes::get_native_u2(p) : (u1)(*p);
   248       int pool_index = cp_cache_entry_pool_index(cache_index);
   249       if (is_wide) {
   250         (*bcp) = Bytecodes::_ldc_w;
   251         assert(pool_index == (u2)pool_index, "index overflow");
   252         Bytes::put_Java_u2(p, pool_index);
   253       } else {
   254         (*bcp) = Bytecodes::_ldc;
   255         assert(pool_index == (u1)pool_index, "index overflow");
   256         (*p) = (u1)pool_index;
   257       }
   258     }
   259   }
   260 }
   263 // Rewrites a method given the index_map information
   264 void Rewriter::scan_method(methodOop method, bool reverse) {
   266   int nof_jsrs = 0;
   267   bool has_monitor_bytecodes = false;
   269   {
   270     // We cannot tolerate a GC in this block, because we've
   271     // cached the bytecodes in 'code_base'. If the methodOop
   272     // moves, the bytecodes will also move.
   273     No_Safepoint_Verifier nsv;
   274     Bytecodes::Code c;
   276     // Bytecodes and their length
   277     const address code_base = method->code_base();
   278     const int code_length = method->code_size();
   280     int bc_length;
   281     for (int bci = 0; bci < code_length; bci += bc_length) {
   282       address bcp = code_base + bci;
   283       int prefix_length = 0;
   284       c = (Bytecodes::Code)(*bcp);
   286       // Since we have the code, see if we can get the length
   287       // directly. Some more complicated bytecodes will report
   288       // a length of zero, meaning we need to make another method
   289       // call to calculate the length.
   290       bc_length = Bytecodes::length_for(c);
   291       if (bc_length == 0) {
   292         bc_length = Bytecodes::length_at(method, bcp);
   294         // length_at will put us at the bytecode after the one modified
   295         // by 'wide'. We don't currently examine any of the bytecodes
   296         // modified by wide, but in case we do in the future...
   297         if (c == Bytecodes::_wide) {
   298           prefix_length = 1;
   299           c = (Bytecodes::Code)bcp[1];
   300         }
   301       }
   303       assert(bc_length != 0, "impossible bytecode length");
   305       switch (c) {
   306         case Bytecodes::_lookupswitch   : {
   307 #ifndef CC_INTERP
   308           Bytecode_lookupswitch bc(method, bcp);
   309           (*bcp) = (
   310             bc.number_of_pairs() < BinarySwitchThreshold
   311             ? Bytecodes::_fast_linearswitch
   312             : Bytecodes::_fast_binaryswitch
   313           );
   314 #endif
   315           break;
   316         }
   317         case Bytecodes::_fast_linearswitch:
   318         case Bytecodes::_fast_binaryswitch: {
   319 #ifndef CC_INTERP
   320           (*bcp) = Bytecodes::_lookupswitch;
   321 #endif
   322           break;
   323         }
   324         case Bytecodes::_getstatic      : // fall through
   325         case Bytecodes::_putstatic      : // fall through
   326         case Bytecodes::_getfield       : // fall through
   327         case Bytecodes::_putfield       : // fall through
   328         case Bytecodes::_invokevirtual  : // fall through
   329         case Bytecodes::_invokespecial  : // fall through
   330         case Bytecodes::_invokestatic   :
   331         case Bytecodes::_invokeinterface:
   332         case Bytecodes::_invokehandle   : // if reverse=true
   333           rewrite_member_reference(bcp, prefix_length+1, reverse);
   334           break;
   335         case Bytecodes::_invokedynamic:
   336           rewrite_invokedynamic(bcp, prefix_length+1, reverse);
   337           break;
   338         case Bytecodes::_ldc:
   339         case Bytecodes::_fast_aldc:  // if reverse=true
   340           maybe_rewrite_ldc(bcp, prefix_length+1, false, reverse);
   341           break;
   342         case Bytecodes::_ldc_w:
   343         case Bytecodes::_fast_aldc_w:  // if reverse=true
   344           maybe_rewrite_ldc(bcp, prefix_length+1, true, reverse);
   345           break;
   346         case Bytecodes::_jsr            : // fall through
   347         case Bytecodes::_jsr_w          : nof_jsrs++;                   break;
   348         case Bytecodes::_monitorenter   : // fall through
   349         case Bytecodes::_monitorexit    : has_monitor_bytecodes = true; break;
   350       }
   351     }
   352   }
   354   // Update access flags
   355   if (has_monitor_bytecodes) {
   356     method->set_has_monitor_bytecodes();
   357   }
   359   // The present of a jsr bytecode implies that the method might potentially
   360   // have to be rewritten, so we run the oopMapGenerator on the method
   361   if (nof_jsrs > 0) {
   362     method->set_has_jsrs();
   363     // Second pass will revisit this method.
   364     assert(method->has_jsrs(), "didn't we just set this?");
   365   }
   366 }
   368 // After constant pool is created, revisit methods containing jsrs.
   369 methodHandle Rewriter::rewrite_jsrs(methodHandle method, TRAPS) {
   370   ResourceMark rm(THREAD);
   371   ResolveOopMapConflicts romc(method);
   372   methodHandle original_method = method;
   373   method = romc.do_potential_rewrite(CHECK_(methodHandle()));
   374   if (method() != original_method()) {
   375     // Insert invalid bytecode into original methodOop and set
   376     // interpreter entrypoint, so that a executing this method
   377     // will manifest itself in an easy recognizable form.
   378     address bcp = original_method->bcp_from(0);
   379     *bcp = (u1)Bytecodes::_shouldnotreachhere;
   380     int kind = Interpreter::method_kind(original_method);
   381     original_method->set_interpreter_kind(kind);
   382   }
   384   // Update monitor matching info.
   385   if (romc.monitor_safe()) {
   386     method->set_guaranteed_monitor_matching();
   387   }
   389   return method;
   390 }
   392 void Rewriter::rewrite(instanceKlassHandle klass, TRAPS) {
   393   ResourceMark rm(THREAD);
   394   Rewriter     rw(klass, klass->constants(), klass->methods(), CHECK);
   395   // (That's all, folks.)
   396 }
   399 void Rewriter::rewrite(instanceKlassHandle klass, constantPoolHandle cpool, objArrayHandle methods, TRAPS) {
   400   ResourceMark rm(THREAD);
   401   Rewriter     rw(klass, cpool, methods, CHECK);
   402   // (That's all, folks.)
   403 }
   406 Rewriter::Rewriter(instanceKlassHandle klass, constantPoolHandle cpool, objArrayHandle methods, TRAPS)
   407   : _klass(klass),
   408     _pool(cpool),
   409     _methods(methods)
   410 {
   411   assert(_pool->cache() == NULL, "constant pool cache must not be set yet");
   413   // determine index maps for methodOop rewriting
   414   compute_index_maps();
   416   if (RegisterFinalizersAtInit && _klass->name() == vmSymbols::java_lang_Object()) {
   417     bool did_rewrite = false;
   418     int i = _methods->length();
   419     while (i-- > 0) {
   420       methodOop method = (methodOop)_methods->obj_at(i);
   421       if (method->intrinsic_id() == vmIntrinsics::_Object_init) {
   422         // rewrite the return bytecodes of Object.<init> to register the
   423         // object for finalization if needed.
   424         methodHandle m(THREAD, method);
   425         rewrite_Object_init(m, CHECK);
   426         did_rewrite = true;
   427         break;
   428       }
   429     }
   430     assert(did_rewrite, "must find Object::<init> to rewrite it");
   431   }
   433   // rewrite methods, in two passes
   434   int len = _methods->length();
   436   for (int i = len-1; i >= 0; i--) {
   437     methodOop method = (methodOop)_methods->obj_at(i);
   438     scan_method(method);
   439   }
   441   // allocate constant pool cache, now that we've seen all the bytecodes
   442   make_constant_pool_cache(THREAD);
   444   // Restore bytecodes to their unrewritten state if there are exceptions
   445   // rewriting bytecodes or allocating the cpCache
   446   if (HAS_PENDING_EXCEPTION) {
   447     restore_bytecodes();
   448     return;
   449   }
   450 }
   452 // Relocate jsr/rets in a method.  This can't be done with the rewriter
   453 // stage because it can throw other exceptions, leaving the bytecodes
   454 // pointing at constant pool cache entries.
   455 // Link and check jvmti dependencies while we're iterating over the methods.
   456 // JSR292 code calls with a different set of methods, so two entry points.
   457 void Rewriter::relocate_and_link(instanceKlassHandle this_oop, TRAPS) {
   458   objArrayHandle methods(THREAD, this_oop->methods());
   459   relocate_and_link(this_oop, methods, THREAD);
   460 }
   462 void Rewriter::relocate_and_link(instanceKlassHandle this_oop,
   463                                  objArrayHandle methods, TRAPS) {
   464   int len = methods->length();
   465   for (int i = len-1; i >= 0; i--) {
   466     methodHandle m(THREAD, (methodOop)methods->obj_at(i));
   468     if (m->has_jsrs()) {
   469       m = rewrite_jsrs(m, CHECK);
   470       // Method might have gotten rewritten.
   471       methods->obj_at_put(i, m());
   472     }
   474     // Set up method entry points for compiler and interpreter    .
   475     m->link_method(m, CHECK);
   477     // This is for JVMTI and unrelated to relocator but the last thing we do
   478 #ifdef ASSERT
   479     if (StressMethodComparator) {
   480       static int nmc = 0;
   481       for (int j = i; j >= 0 && j >= i-4; j--) {
   482         if ((++nmc % 1000) == 0)  tty->print_cr("Have run MethodComparator %d times...", nmc);
   483         bool z = MethodComparator::methods_EMCP(m(),
   484                    (methodOop)methods->obj_at(j));
   485         if (j == i && !z) {
   486           tty->print("MethodComparator FAIL: "); m->print(); m->print_codes();
   487           assert(z, "method must compare equal to itself");
   488         }
   489       }
   490     }
   491 #endif //ASSERT
   492   }
   493 }

mercurial