src/share/vm/oops/klassVtable.hpp

Tue, 09 Apr 2013 09:54:17 -0700

author
iignatyev
date
Tue, 09 Apr 2013 09:54:17 -0700
changeset 4908
b84fd7d73702
parent 4562
8d9fc28831cc
child 5726
69f26e8e09f9
permissions
-rw-r--r--

8007288: Additional WB API for compiler's testing
Reviewed-by: kvn, vlivanov

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

mercurial