annotate src/share/vm/oops/klassVtable.hpp @ 3810:4735d2c84362

7200776: Implement default methods in interfaces Summary: Add generic type analysis and default method selection algorithms Reviewed-by: coleenp, acorn
author kamg
date Thu, 11 Oct 2012 12:25:42 -0400
parents d8ce2825b193
children 8d9fc28831cc
rev   line source
duke@0 1 /*
coleenp@3602 2 * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
duke@0 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@0 4 *
duke@0 5 * This code is free software; you can redistribute it and/or modify it
duke@0 6 * under the terms of the GNU General Public License version 2 only, as
duke@0 7 * published by the Free Software Foundation.
duke@0 8 *
duke@0 9 * This code is distributed in the hope that it will be useful, but WITHOUT
duke@0 10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@0 11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@0 12 * version 2 for more details (a copy is included in the LICENSE file that
duke@0 13 * accompanied this code).
duke@0 14 *
duke@0 15 * You should have received a copy of the GNU General Public License version
duke@0 16 * 2 along with this work; if not, write to the Free Software Foundation,
duke@0 17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@0 18 *
trims@1472 19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
trims@1472 20 * or visit www.oracle.com if you need additional information or have any
trims@1472 21 * questions.
duke@0 22 *
duke@0 23 */
duke@0 24
stefank@1879 25 #ifndef SHARE_VM_OOPS_KLASSVTABLE_HPP
stefank@1879 26 #define SHARE_VM_OOPS_KLASSVTABLE_HPP
stefank@1879 27
stefank@1879 28 #include "memory/allocation.hpp"
stefank@1879 29 #include "oops/oopsHierarchy.hpp"
stefank@1879 30 #include "runtime/handles.hpp"
stefank@1879 31 #include "utilities/growableArray.hpp"
stefank@1879 32
coleenp@3602 33 // A klassVtable abstracts the variable-length vtable that is embedded in InstanceKlass
coleenp@3707 34 // and ArrayKlass. klassVtable objects are used just as convenient transient accessors to the vtable,
duke@0 35 // not to actually hold the vtable data.
duke@0 36 // Note: the klassVtable should not be accessed before the class has been verified
duke@0 37 // (until that point, the vtable is uninitialized).
duke@0 38
duke@0 39 // Currently a klassVtable contains a direct reference to the vtable data, and is therefore
duke@0 40 // not preserved across GCs.
duke@0 41
duke@0 42 class vtableEntry;
duke@0 43
duke@0 44 class klassVtable : public ResourceObj {
duke@0 45 KlassHandle _klass; // my klass
duke@0 46 int _tableOffset; // offset of start of vtable data within klass
duke@0 47 int _length; // length of vtable (number of entries)
duke@0 48 #ifndef PRODUCT
duke@0 49 int _verify_count; // to make verify faster
duke@0 50 #endif
duke@0 51
duke@0 52 // Ordering important, so greater_than (>) can be used as an merge operator.
duke@0 53 enum AccessType {
duke@0 54 acc_private = 0,
duke@0 55 acc_package_private = 1,
duke@0 56 acc_publicprotected = 2
duke@0 57 };
duke@0 58
duke@0 59 public:
duke@0 60 klassVtable(KlassHandle h_klass, void* base, int length) : _klass(h_klass) {
duke@0 61 _tableOffset = (address)base - (address)h_klass(); _length = length;
duke@0 62 }
duke@0 63
duke@0 64 // accessors
duke@0 65 vtableEntry* table() const { return (vtableEntry*)(address(_klass()) + _tableOffset); }
duke@0 66 KlassHandle klass() const { return _klass; }
duke@0 67 int length() const { return _length; }
coleenp@3602 68 inline Method* method_at(int i) const;
coleenp@3602 69 inline Method* unchecked_method_at(int i) const;
coleenp@3602 70 inline Method** adr_method_at(int i) const;
duke@0 71
duke@0 72 // searching; all methods return -1 if not found
coleenp@3602 73 int index_of(Method* m) const { return index_of(m, _length); }
coleenp@2062 74 int index_of_miranda(Symbol* name, Symbol* signature);
duke@0 75
duke@0 76 void initialize_vtable(bool checkconstraints, TRAPS); // initialize vtable of a new klass
duke@0 77
coleenp@2342 78 // CDS/RedefineClasses support - clear vtables so they can be reinitialized
coleenp@2342 79 // at dump time. Clearing gives us an easy way to tell if the vtable has
coleenp@2342 80 // already been reinitialized at dump time (see dump.cpp). Vtables can
coleenp@2342 81 // be initialized at run time by RedefineClasses so dumping the right order
coleenp@2342 82 // is necessary.
coleenp@2342 83 void clear_vtable();
coleenp@2342 84 bool is_initialized();
coleenp@2342 85
coleenp@2342 86 // computes vtable length (in words) and the number of miranda methods
kamg@3810 87 static void compute_vtable_size_and_num_mirandas(
kamg@3810 88 int* vtable_length, int* num_new_mirandas,
kamg@3810 89 GrowableArray<Method*>* all_mirandas, Klass* super,
kamg@3810 90 Array<Method*>* methods, AccessFlags class_flags, Handle classloader,
kamg@3810 91 Symbol* classname, Array<Klass*>* local_interfaces, TRAPS);
duke@0 92
duke@0 93 // RedefineClasses() API support:
duke@0 94 // If any entry of this vtable points to any of old_methods,
duke@0 95 // replace it with the corresponding new_method.
duke@0 96 // trace_name_printed is set to true if the current call has
duke@0 97 // printed the klass name so that other routines in the adjust_*
duke@0 98 // group don't print the klass name.
coleenp@3602 99 void adjust_method_entries(Method** old_methods, Method** new_methods,
duke@0 100 int methods_length, bool * trace_name_printed);
duke@0 101
duke@0 102 // Debugging code
duke@0 103 void print() PRODUCT_RETURN;
duke@0 104 void verify(outputStream* st, bool force = false);
duke@0 105 static void print_statistics() PRODUCT_RETURN;
duke@0 106
duke@0 107 #ifndef PRODUCT
duke@0 108 bool check_no_old_entries();
duke@0 109 void dump_vtable();
duke@0 110 #endif
duke@0 111
duke@0 112 protected:
duke@0 113 friend class vtableEntry;
duke@0 114 private:
acorn@652 115 enum { VTABLE_TRANSITIVE_OVERRIDE_VERSION = 51 } ;
duke@0 116 void copy_vtable_to(vtableEntry* start);
duke@0 117 int initialize_from_super(KlassHandle super);
coleenp@3602 118 int index_of(Method* m, int len) const; // same as index_of, but search only up to len
coleenp@3602 119 void put_method_at(Method* m, int index);
coleenp@3602 120 static bool needs_new_vtable_entry(methodHandle m, Klass* super, Handle classloader, Symbol* classname, AccessFlags access_flags, TRAPS);
duke@0 121
coleenp@3602 122 bool update_inherited_vtable(InstanceKlass* klass, methodHandle target_method, int super_vtable_len, bool checkconstraints, TRAPS);
coleenp@3602 123 InstanceKlass* find_transitive_override(InstanceKlass* initialsuper, methodHandle target_method, int vtable_index,
coleenp@2062 124 Handle target_loader, Symbol* target_classname, Thread* THREAD);
duke@0 125
duke@0 126 // support for miranda methods
duke@0 127 bool is_miranda_entry_at(int i);
kamg@3810 128 void fill_in_mirandas(int* initialized);
coleenp@3602 129 static bool is_miranda(Method* m, Array<Method*>* class_methods, Klass* super);
kamg@3810 130 static void add_new_mirandas_to_lists(
kamg@3810 131 GrowableArray<Method*>* new_mirandas,
kamg@3810 132 GrowableArray<Method*>* all_mirandas,
kamg@3810 133 Array<Method*>* current_interface_methods, Array<Method*>* class_methods,
kamg@3810 134 Klass* super);
kamg@3810 135 static void get_mirandas(
kamg@3810 136 GrowableArray<Method*>* new_mirandas,
kamg@3810 137 GrowableArray<Method*>* all_mirandas, Klass* super,
kamg@3810 138 Array<Method*>* class_methods, Array<Klass*>* local_interfaces);
duke@0 139
duke@0 140 void verify_against(outputStream* st, klassVtable* vt, int index);
coleenp@3602 141 inline InstanceKlass* ik() const;
duke@0 142 };
duke@0 143
duke@0 144
duke@0 145 // private helper class for klassVtable
duke@0 146 // description of entry points:
duke@0 147 // destination is interpreted:
duke@0 148 // from_compiled_code_entry_point -> c2iadapter
duke@0 149 // from_interpreter_entry_point -> interpreter entry point
duke@0 150 // destination is compiled:
duke@0 151 // from_compiled_code_entry_point -> nmethod entry point
duke@0 152 // from_interpreter_entry_point -> i2cadapter
duke@0 153 class vtableEntry VALUE_OBJ_CLASS_SPEC {
duke@0 154 public:
duke@0 155 // size in words
duke@0 156 static int size() {
duke@0 157 return sizeof(vtableEntry) / sizeof(HeapWord);
duke@0 158 }
duke@0 159 static int method_offset_in_bytes() { return offset_of(vtableEntry, _method); }
coleenp@3602 160 Method* method() const { return _method; }
duke@0 161
duke@0 162 private:
coleenp@3602 163 Method* _method;
coleenp@3602 164 void set(Method* method) { assert(method != NULL, "use clear"); _method = method; }
duke@0 165 void clear() { _method = NULL; }
duke@0 166 void print() PRODUCT_RETURN;
duke@0 167 void verify(klassVtable* vt, outputStream* st);
duke@0 168
duke@0 169 friend class klassVtable;
duke@0 170 };
duke@0 171
duke@0 172
coleenp@3602 173 inline Method* klassVtable::method_at(int i) const {
duke@0 174 assert(i >= 0 && i < _length, "index out of bounds");
duke@0 175 assert(table()[i].method() != NULL, "should not be null");
coleenp@3602 176 assert(((Metadata*)table()[i].method())->is_method(), "should be method");
duke@0 177 return table()[i].method();
duke@0 178 }
duke@0 179
coleenp@3602 180 inline Method* klassVtable::unchecked_method_at(int i) const {
duke@0 181 assert(i >= 0 && i < _length, "index out of bounds");
duke@0 182 return table()[i].method();
duke@0 183 }
duke@0 184
coleenp@3602 185 inline Method** klassVtable::adr_method_at(int i) const {
duke@0 186 // Allow one past the last entry to be referenced; useful for loop bounds.
duke@0 187 assert(i >= 0 && i <= _length, "index out of bounds");
coleenp@3602 188 return (Method**)(address(table() + i) + vtableEntry::method_offset_in_bytes());
duke@0 189 }
duke@0 190
duke@0 191 // --------------------------------------------------------------------------------
duke@0 192 class klassItable;
duke@0 193 class itableMethodEntry;
duke@0 194
duke@0 195 class itableOffsetEntry VALUE_OBJ_CLASS_SPEC {
duke@0 196 private:
coleenp@3602 197 Klass* _interface;
duke@0 198 int _offset;
duke@0 199 public:
coleenp@3602 200 Klass* interface_klass() const { return _interface; }
duke@0 201 int offset() const { return _offset; }
duke@0 202
coleenp@3602 203 static itableMethodEntry* method_entry(Klass* k, int offset) { return (itableMethodEntry*)(((address)k) + offset); }
coleenp@3602 204 itableMethodEntry* first_method_entry(Klass* k) { return method_entry(k, _offset); }
duke@0 205
coleenp@3602 206 void initialize(Klass* interf, int offset) { _interface = interf; _offset = offset; }
duke@0 207
duke@0 208 // Static size and offset accessors
duke@0 209 static int size() { return sizeof(itableOffsetEntry) / HeapWordSize; } // size in words
duke@0 210 static int interface_offset_in_bytes() { return offset_of(itableOffsetEntry, _interface); }
duke@0 211 static int offset_offset_in_bytes() { return offset_of(itableOffsetEntry, _offset); }
duke@0 212
duke@0 213 friend class klassItable;
duke@0 214 };
duke@0 215
duke@0 216
duke@0 217 class itableMethodEntry VALUE_OBJ_CLASS_SPEC {
duke@0 218 private:
coleenp@3602 219 Method* _method;
duke@0 220
duke@0 221 public:
coleenp@3602 222 Method* method() const { return _method; }
duke@0 223
duke@0 224 void clear() { _method = NULL; }
duke@0 225
coleenp@3602 226 void initialize(Method* method);
duke@0 227
duke@0 228 // Static size and offset accessors
duke@0 229 static int size() { return sizeof(itableMethodEntry) / HeapWordSize; } // size in words
duke@0 230 static int method_offset_in_bytes() { return offset_of(itableMethodEntry, _method); }
duke@0 231
duke@0 232 friend class klassItable;
duke@0 233 };
duke@0 234
duke@0 235 //
duke@0 236 // Format of an itable
duke@0 237 //
duke@0 238 // ---- offset table ---
coleenp@3602 239 // Klass* of interface 1 \
duke@0 240 // offset to vtable from start of oop / offset table entry
duke@0 241 // ...
coleenp@3602 242 // Klass* of interface n \
duke@0 243 // offset to vtable from start of oop / offset table entry
duke@0 244 // --- vtable for interface 1 ---
coleenp@3602 245 // Method* \
duke@0 246 // compiler entry point / method table entry
duke@0 247 // ...
coleenp@3602 248 // Method* \
duke@0 249 // compiler entry point / method table entry
duke@0 250 // -- vtable for interface 2 ---
duke@0 251 // ...
duke@0 252 //
duke@0 253 class klassItable : public ResourceObj {
duke@0 254 private:
duke@0 255 instanceKlassHandle _klass; // my klass
duke@0 256 int _table_offset; // offset of start of itable data within klass (in words)
duke@0 257 int _size_offset_table; // size of offset table (in itableOffset entries)
duke@0 258 int _size_method_table; // size of methodtable (in itableMethodEntry entries)
duke@0 259
duke@0 260 void initialize_itable_for_interface(int method_table_offset, KlassHandle interf_h, bool checkconstraints, TRAPS);
duke@0 261 public:
duke@0 262 klassItable(instanceKlassHandle klass);
duke@0 263
duke@0 264 itableOffsetEntry* offset_entry(int i) { assert(0 <= i && i <= _size_offset_table, "index out of bounds");
duke@0 265 return &((itableOffsetEntry*)vtable_start())[i]; }
duke@0 266
duke@0 267 itableMethodEntry* method_entry(int i) { assert(0 <= i && i <= _size_method_table, "index out of bounds");
duke@0 268 return &((itableMethodEntry*)method_start())[i]; }
duke@0 269
dcubed@16 270 int size_offset_table() { return _size_offset_table; }
duke@0 271
duke@0 272 // Initialization
duke@0 273 void initialize_itable(bool checkconstraints, TRAPS);
duke@0 274
duke@0 275 // Updates
coleenp@3602 276 void initialize_with_method(Method* m);
duke@0 277
duke@0 278 // RedefineClasses() API support:
duke@0 279 // if any entry of this itable points to any of old_methods,
duke@0 280 // replace it with the corresponding new_method.
duke@0 281 // trace_name_printed is set to true if the current call has
duke@0 282 // printed the klass name so that other routines in the adjust_*
duke@0 283 // group don't print the klass name.
coleenp@3602 284 void adjust_method_entries(Method** old_methods, Method** new_methods,
duke@0 285 int methods_length, bool * trace_name_printed);
duke@0 286
duke@0 287 // Setup of itable
coleenp@3602 288 static int compute_itable_size(Array<Klass*>* transitive_interfaces);
duke@0 289 static void setup_itable_offset_table(instanceKlassHandle klass);
duke@0 290
duke@0 291 // Resolving of method to index
coleenp@3602 292 static int compute_itable_index(Method* m);
jrose@665 293 // ...and back again:
coleenp@3602 294 static Method* method_for_itable_index(Klass* klass, int itable_index);
duke@0 295
duke@0 296 // Debugging/Statistics
duke@0 297 static void print_statistics() PRODUCT_RETURN;
duke@0 298 private:
duke@0 299 intptr_t* vtable_start() const { return ((intptr_t*)_klass()) + _table_offset; }
duke@0 300 intptr_t* method_start() const { return vtable_start() + _size_offset_table * itableOffsetEntry::size(); }
duke@0 301
duke@0 302 // Helper methods
duke@0 303 static int calc_itable_size(int num_interfaces, int num_methods) { return (num_interfaces * itableOffsetEntry::size()) + (num_methods * itableMethodEntry::size()); }
duke@0 304
duke@0 305 // Statistics
duke@0 306 NOT_PRODUCT(static int _total_classes;) // Total no. of classes with itables
duke@0 307 NOT_PRODUCT(static long _total_size;) // Total no. of bytes used for itables
duke@0 308
duke@0 309 static void update_stats(int size) PRODUCT_RETURN NOT_PRODUCT({ _total_classes++; _total_size += size; })
coleenp@3602 310
coleenp@3602 311 public:
coleenp@3602 312 #ifndef PRODUCT
coleenp@3602 313 bool check_no_old_entries();
coleenp@3602 314 #endif
duke@0 315 };
stefank@1879 316
stefank@1879 317 #endif // SHARE_VM_OOPS_KLASSVTABLE_HPP