aoqi@0: /*
aoqi@0:  * Copyright (c) 1998, 2014, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  *
aoqi@0:  */
aoqi@0: 
aoqi@0: #ifndef SHARE_VM_INTERPRETER_REWRITER_HPP
aoqi@0: #define SHARE_VM_INTERPRETER_REWRITER_HPP
aoqi@0: 
aoqi@0: #include "memory/allocation.hpp"
aoqi@0: #include "runtime/handles.inline.hpp"
aoqi@0: #include "utilities/growableArray.hpp"
aoqi@0: 
aoqi@0: // The Rewriter adds caches to the constant pool and rewrites bytecode indices
aoqi@0: // pointing into the constant pool for better interpreter performance.
aoqi@0: 
aoqi@0: class Rewriter: public StackObj {
aoqi@0:  private:
aoqi@0:   instanceKlassHandle _klass;
aoqi@0:   constantPoolHandle  _pool;
aoqi@0:   Array<Method*>*     _methods;
aoqi@0:   intArray            _cp_map;
aoqi@0:   intStack            _cp_cache_map;        // for Methodref, Fieldref,
aoqi@0:                                             // InterfaceMethodref and InvokeDynamic
aoqi@0:   intArray            _reference_map;       // maps from cp index to resolved_refs index (or -1)
aoqi@0:   intStack            _resolved_references_map;    // for strings, methodHandle, methodType
aoqi@0:   intStack            _invokedynamic_references_map; // for invokedynamic resolved refs
aoqi@0:   intArray            _method_handle_invokers;
aoqi@0:   int                 _resolved_reference_limit;
aoqi@0: 
aoqi@0:   // For mapping invokedynamic bytecodes, which are discovered during method
aoqi@0:   // scanning.  The invokedynamic entries are added at the end of the cpCache.
aoqi@0:   // If there are any invokespecial/InterfaceMethodref special case bytecodes,
aoqi@0:   // these entries are added before invokedynamic entries so that the
aoqi@0:   // invokespecial bytecode 16 bit index doesn't overflow.
aoqi@0:   intStack            _invokedynamic_cp_cache_map;
aoqi@0: 
aoqi@0:   // For patching.
aoqi@0:   GrowableArray<address>* _patch_invokedynamic_bcps;
aoqi@0:   GrowableArray<int>*     _patch_invokedynamic_refs;
aoqi@0: 
aoqi@0:   void init_maps(int length) {
aoqi@0:     _cp_map.initialize(length, -1);
aoqi@0:     // Choose an initial value large enough that we don't get frequent
aoqi@0:     // calls to grow().
aoqi@0:     _cp_cache_map.initialize(length/2);
aoqi@0:     // Also cache resolved objects, in another different cache.
aoqi@0:     _reference_map.initialize(length, -1);
aoqi@0:     _resolved_references_map.initialize(length/2);
aoqi@0:     _invokedynamic_references_map.initialize(length/2);
aoqi@0:     _resolved_reference_limit = -1;
aoqi@0:     _first_iteration_cp_cache_limit = -1;
aoqi@0: 
aoqi@0:     // invokedynamic specific fields
aoqi@0:     _invokedynamic_cp_cache_map.initialize(length/4);
aoqi@0:     _patch_invokedynamic_bcps = new GrowableArray<address>(length/4);
aoqi@0:     _patch_invokedynamic_refs = new GrowableArray<int>(length/4);
aoqi@0:   }
aoqi@0: 
aoqi@0:   int _first_iteration_cp_cache_limit;
aoqi@0:   void record_map_limits() {
aoqi@0:     // Record initial size of the two arrays generated for the CP cache
aoqi@0:     // relative to walking the constant pool.
aoqi@0:     _first_iteration_cp_cache_limit = _cp_cache_map.length();
aoqi@0:     _resolved_reference_limit = _resolved_references_map.length();
aoqi@0:   }
aoqi@0: 
aoqi@0:   int cp_cache_delta() {
aoqi@0:     // How many cp cache entries were added since recording map limits after
aoqi@0:     // cp cache initialization?
aoqi@0:     assert(_first_iteration_cp_cache_limit != -1, "only valid after first iteration");
aoqi@0:     return _cp_cache_map.length() - _first_iteration_cp_cache_limit;
aoqi@0:   }
aoqi@0: 
aoqi@0:   int  cp_entry_to_cp_cache(int i) { assert(has_cp_cache(i), "oob"); return _cp_map[i]; }
aoqi@0:   bool has_cp_cache(int i) { return (uint)i < (uint)_cp_map.length() && _cp_map[i] >= 0; }
aoqi@0: 
aoqi@0:   int add_map_entry(int cp_index, intArray* cp_map, intStack* cp_cache_map) {
aoqi@0:     assert(cp_map->at(cp_index) == -1, "not twice on same cp_index");
aoqi@0:     int cache_index = cp_cache_map->append(cp_index);
aoqi@0:     cp_map->at_put(cp_index, cache_index);
aoqi@0:     return cache_index;
aoqi@0:   }
aoqi@0: 
aoqi@0:   int add_cp_cache_entry(int cp_index) {
aoqi@0:     assert(_pool->tag_at(cp_index).value() != JVM_CONSTANT_InvokeDynamic, "use indy version");
aoqi@0:     assert(_first_iteration_cp_cache_limit == -1, "do not add cache entries after first iteration");
aoqi@0:     int cache_index = add_map_entry(cp_index, &_cp_map, &_cp_cache_map);
aoqi@0:     assert(cp_entry_to_cp_cache(cp_index) == cache_index, "");
aoqi@0:     assert(cp_cache_entry_pool_index(cache_index) == cp_index, "");
aoqi@0:     return cache_index;
aoqi@0:   }
aoqi@0: 
aoqi@0:   int add_invokedynamic_cp_cache_entry(int cp_index) {
aoqi@0:     assert(_pool->tag_at(cp_index).value() == JVM_CONSTANT_InvokeDynamic, "use non-indy version");
aoqi@0:     assert(_first_iteration_cp_cache_limit >= 0, "add indy cache entries after first iteration");
aoqi@0:     // add to the invokedynamic index map.
aoqi@0:     int cache_index = _invokedynamic_cp_cache_map.append(cp_index);
aoqi@0:     // do not update _cp_map, since the mapping is one-to-many
aoqi@0:     assert(invokedynamic_cp_cache_entry_pool_index(cache_index) == cp_index, "");
aoqi@0:     // this index starts at one but in the bytecode it's appended to the end.
aoqi@0:     return cache_index + _first_iteration_cp_cache_limit;
aoqi@0:   }
aoqi@0: 
aoqi@0:   int invokedynamic_cp_cache_entry_pool_index(int cache_index) {
aoqi@0:     int cp_index = _invokedynamic_cp_cache_map[cache_index];
aoqi@0:     return cp_index;
aoqi@0:   }
aoqi@0: 
aoqi@0:   // add a new CP cache entry beyond the normal cache for the special case of
aoqi@0:   // invokespecial with InterfaceMethodref as cpool operand.
aoqi@0:   int add_invokespecial_cp_cache_entry(int cp_index) {
aoqi@0:     assert(_first_iteration_cp_cache_limit >= 0, "add these special cache entries after first iteration");
aoqi@0:     // Don't add InterfaceMethodref if it already exists at the end.
aoqi@0:     for (int i = _first_iteration_cp_cache_limit; i < _cp_cache_map.length(); i++) {
aoqi@0:      if (cp_cache_entry_pool_index(i) == cp_index) {
aoqi@0:        return i;
aoqi@0:      }
aoqi@0:     }
aoqi@0:     int cache_index = _cp_cache_map.append(cp_index);
aoqi@0:     assert(cache_index >= _first_iteration_cp_cache_limit, "");
aoqi@0:     // do not update _cp_map, since the mapping is one-to-many
aoqi@0:     assert(cp_cache_entry_pool_index(cache_index) == cp_index, "");
aoqi@0:     return cache_index;
aoqi@0:   }
aoqi@0: 
aoqi@0:   int  cp_entry_to_resolved_references(int cp_index) const {
aoqi@0:     assert(has_entry_in_resolved_references(cp_index), "oob");
aoqi@0:     return _reference_map[cp_index];
aoqi@0:   }
aoqi@0:   bool has_entry_in_resolved_references(int cp_index) const {
aoqi@0:     return (uint)cp_index < (uint)_reference_map.length() && _reference_map[cp_index] >= 0;
aoqi@0:   }
aoqi@0: 
aoqi@0:   // add a new entry to the resolved_references map
aoqi@0:   int add_resolved_references_entry(int cp_index) {
aoqi@0:     int ref_index = add_map_entry(cp_index, &_reference_map, &_resolved_references_map);
aoqi@0:     assert(cp_entry_to_resolved_references(cp_index) == ref_index, "");
aoqi@0:     return ref_index;
aoqi@0:   }
aoqi@0: 
aoqi@0:   // add a new entries to the resolved_references map (for invokedynamic and invokehandle only)
aoqi@0:   int add_invokedynamic_resolved_references_entries(int cp_index, int cache_index) {
aoqi@0:     assert(_resolved_reference_limit >= 0, "must add indy refs after first iteration");
aoqi@0:     int ref_index = -1;
aoqi@0:     for (int entry = 0; entry < ConstantPoolCacheEntry::_indy_resolved_references_entries; entry++) {
aoqi@0:       const int index = _resolved_references_map.append(cp_index);  // many-to-one
aoqi@0:       assert(index >= _resolved_reference_limit, "");
aoqi@0:       if (entry == 0) {
aoqi@0:         ref_index = index;
aoqi@0:       }
aoqi@0:       assert((index - entry) == ref_index, "entries must be consecutive");
aoqi@0:       _invokedynamic_references_map.at_put_grow(index, cache_index, -1);
aoqi@0:     }
aoqi@0:     return ref_index;
aoqi@0:   }
aoqi@0: 
aoqi@0:   int resolved_references_entry_to_pool_index(int ref_index) {
aoqi@0:     int cp_index = _resolved_references_map[ref_index];
aoqi@0:     return cp_index;
aoqi@0:   }
aoqi@0: 
aoqi@0:   // Access the contents of _cp_cache_map to determine CP cache layout.
aoqi@0:   int cp_cache_entry_pool_index(int cache_index) {
aoqi@0:     int cp_index = _cp_cache_map[cache_index];
aoqi@0:     return cp_index;
aoqi@0:   }
aoqi@0: 
aoqi@0:   // All the work goes in here:
aoqi@0:   Rewriter(instanceKlassHandle klass, constantPoolHandle cpool, Array<Method*>* methods, TRAPS);
aoqi@0: 
aoqi@0:   void compute_index_maps();
aoqi@0:   void make_constant_pool_cache(TRAPS);
aoqi@0:   void scan_method(Method* m, bool reverse, bool* invokespecial_error);
aoqi@0:   void rewrite_Object_init(methodHandle m, TRAPS);
aoqi@0:   void rewrite_member_reference(address bcp, int offset, bool reverse);
aoqi@0:   void maybe_rewrite_invokehandle(address opc, int cp_index, int cache_index, bool reverse);
aoqi@0:   void rewrite_invokedynamic(address bcp, int offset, bool reverse);
aoqi@0:   void maybe_rewrite_ldc(address bcp, int offset, bool is_wide, bool reverse);
aoqi@0:   void rewrite_invokespecial(address bcp, int offset, bool reverse, bool* invokespecial_error);
aoqi@0: 
aoqi@0:   void patch_invokedynamic_bytecodes();
aoqi@0: 
aoqi@0:   // Do all the work.
aoqi@0:   void rewrite_bytecodes(TRAPS);
aoqi@0: 
aoqi@0:   // Revert bytecodes in case of an exception.
aoqi@0:   void restore_bytecodes();
aoqi@0: 
aoqi@0:   static methodHandle rewrite_jsrs(methodHandle m, TRAPS);
aoqi@0:  public:
aoqi@0:   // Driver routine:
aoqi@0:   static void rewrite(instanceKlassHandle klass, TRAPS);
aoqi@0: };
aoqi@0: 
aoqi@0: #endif // SHARE_VM_INTERPRETER_REWRITER_HPP