annotate src/share/vm/oops/klassVtable.hpp @ 1879:f95d63e2154a

6989984: Use standard include model for Hospot Summary: Replaced MakeDeps and the includeDB files with more standardized solutions. Reviewed-by: coleenp, kvn, kamg
author stefank
date Tue, 23 Nov 2010 13:22:55 -0800
parents c18cbe5936b8
children 3582bf76420e
rev   line source
duke@0 1 /*
stefank@1879 2 * Copyright (c) 1997, 2010, 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
duke@0 33 // A klassVtable abstracts the variable-length vtable that is embedded in instanceKlass
duke@0 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; }
duke@0 68 inline methodOop method_at(int i) const;
duke@0 69 inline methodOop unchecked_method_at(int i) const;
duke@0 70 inline oop* adr_method_at(int i) const;
duke@0 71
duke@0 72 // searching; all methods return -1 if not found
duke@0 73 int index_of(methodOop m) const { return index_of(m, _length); }
duke@0 74 int index_of_miranda(symbolOop name, symbolOop signature);
duke@0 75
duke@0 76 void initialize_vtable(bool checkconstraints, TRAPS); // initialize vtable of a new klass
duke@0 77
duke@0 78 // conputes vtable length (in words) and the number of miranda methods
duke@0 79 static void compute_vtable_size_and_num_mirandas(int &vtable_length, int &num_miranda_methods,
duke@0 80 klassOop super, objArrayOop methods,
acorn@652 81 AccessFlags class_flags, Handle classloader,
acorn@652 82 symbolHandle classname, objArrayOop local_interfaces,
acorn@652 83 TRAPS);
duke@0 84
duke@0 85 // RedefineClasses() API support:
duke@0 86 // If any entry of this vtable points to any of old_methods,
duke@0 87 // replace it with the corresponding new_method.
duke@0 88 // trace_name_printed is set to true if the current call has
duke@0 89 // printed the klass name so that other routines in the adjust_*
duke@0 90 // group don't print the klass name.
duke@0 91 void adjust_method_entries(methodOop* old_methods, methodOop* new_methods,
duke@0 92 int methods_length, bool * trace_name_printed);
duke@0 93
duke@0 94 // Garbage collection
duke@0 95 void oop_follow_contents();
duke@0 96 void oop_adjust_pointers();
duke@0 97
duke@0 98 #ifndef SERIALGC
duke@0 99 // Parallel Old
duke@0 100 void oop_follow_contents(ParCompactionManager* cm);
duke@0 101 void oop_update_pointers(ParCompactionManager* cm);
duke@0 102 void oop_update_pointers(ParCompactionManager* cm,
duke@0 103 HeapWord* beg_addr, HeapWord* end_addr);
duke@0 104 #endif // SERIALGC
duke@0 105
duke@0 106 // Iterators
duke@0 107 void oop_oop_iterate(OopClosure* blk);
duke@0 108 void oop_oop_iterate_m(OopClosure* blk, MemRegion mr);
duke@0 109
duke@0 110 // Debugging code
duke@0 111 void print() PRODUCT_RETURN;
duke@0 112 void verify(outputStream* st, bool force = false);
duke@0 113 static void print_statistics() PRODUCT_RETURN;
duke@0 114
duke@0 115 #ifndef PRODUCT
duke@0 116 bool check_no_old_entries();
duke@0 117 void dump_vtable();
duke@0 118 #endif
duke@0 119
duke@0 120 protected:
duke@0 121 friend class vtableEntry;
duke@0 122 private:
acorn@652 123 enum { VTABLE_TRANSITIVE_OVERRIDE_VERSION = 51 } ;
duke@0 124 void copy_vtable_to(vtableEntry* start);
duke@0 125 int initialize_from_super(KlassHandle super);
duke@0 126 int index_of(methodOop m, int len) const; // same as index_of, but search only up to len
duke@0 127 void put_method_at(methodOop m, int index);
acorn@652 128 static bool needs_new_vtable_entry(methodHandle m, klassOop super, Handle classloader, symbolHandle classname, AccessFlags access_flags, TRAPS);
duke@0 129
acorn@652 130 bool update_inherited_vtable(instanceKlass* klass, methodHandle target_method, int super_vtable_len, bool checkconstraints, TRAPS);
acorn@652 131 instanceKlass* find_transitive_override(instanceKlass* initialsuper, methodHandle target_method, int vtable_index,
acorn@652 132 Handle target_loader, symbolHandle target_classname, Thread* THREAD);
duke@0 133
duke@0 134 // support for miranda methods
duke@0 135 bool is_miranda_entry_at(int i);
duke@0 136 void fill_in_mirandas(int& initialized);
duke@0 137 static bool is_miranda(methodOop m, objArrayOop class_methods, klassOop super);
duke@0 138 static void add_new_mirandas_to_list(GrowableArray<methodOop>* list_of_current_mirandas, objArrayOop current_interface_methods, objArrayOop class_methods, klassOop super);
duke@0 139 static void get_mirandas(GrowableArray<methodOop>* mirandas, klassOop super, objArrayOop class_methods, objArrayOop local_interfaces);
duke@0 140 static int get_num_mirandas(klassOop super, objArrayOop class_methods, objArrayOop local_interfaces);
duke@0 141
duke@0 142
duke@0 143 void verify_against(outputStream* st, klassVtable* vt, int index);
duke@0 144 inline instanceKlass* ik() const;
duke@0 145 };
duke@0 146
duke@0 147
duke@0 148 // private helper class for klassVtable
duke@0 149 // description of entry points:
duke@0 150 // destination is interpreted:
duke@0 151 // from_compiled_code_entry_point -> c2iadapter
duke@0 152 // from_interpreter_entry_point -> interpreter entry point
duke@0 153 // destination is compiled:
duke@0 154 // from_compiled_code_entry_point -> nmethod entry point
duke@0 155 // from_interpreter_entry_point -> i2cadapter
duke@0 156 class vtableEntry VALUE_OBJ_CLASS_SPEC {
duke@0 157 public:
duke@0 158 // size in words
duke@0 159 static int size() {
duke@0 160 return sizeof(vtableEntry) / sizeof(HeapWord);
duke@0 161 }
duke@0 162 static int method_offset_in_bytes() { return offset_of(vtableEntry, _method); }
duke@0 163 methodOop method() const { return _method; }
duke@0 164
duke@0 165 private:
duke@0 166 methodOop _method;
duke@0 167 void set(methodOop method) { assert(method != NULL, "use clear"); _method = method; }
duke@0 168 void clear() { _method = NULL; }
duke@0 169 void print() PRODUCT_RETURN;
duke@0 170 void verify(klassVtable* vt, outputStream* st);
duke@0 171
duke@0 172 friend class klassVtable;
duke@0 173 };
duke@0 174
duke@0 175
duke@0 176 inline methodOop klassVtable::method_at(int i) const {
duke@0 177 assert(i >= 0 && i < _length, "index out of bounds");
duke@0 178 assert(table()[i].method() != NULL, "should not be null");
duke@0 179 assert(oop(table()[i].method())->is_method(), "should be method");
duke@0 180 return table()[i].method();
duke@0 181 }
duke@0 182
duke@0 183 inline methodOop klassVtable::unchecked_method_at(int i) const {
duke@0 184 assert(i >= 0 && i < _length, "index out of bounds");
duke@0 185 return table()[i].method();
duke@0 186 }
duke@0 187
duke@0 188 inline oop* klassVtable::adr_method_at(int i) const {
duke@0 189 // Allow one past the last entry to be referenced; useful for loop bounds.
duke@0 190 assert(i >= 0 && i <= _length, "index out of bounds");
duke@0 191 return (oop*)(address(table() + i) + vtableEntry::method_offset_in_bytes());
duke@0 192 }
duke@0 193
duke@0 194 // --------------------------------------------------------------------------------
duke@0 195 class klassItable;
duke@0 196 class itableMethodEntry;
duke@0 197
duke@0 198 class itableOffsetEntry VALUE_OBJ_CLASS_SPEC {
duke@0 199 private:
duke@0 200 klassOop _interface;
duke@0 201 int _offset;
duke@0 202 public:
duke@0 203 klassOop interface_klass() const { return _interface; }
duke@0 204 int offset() const { return _offset; }
duke@0 205
duke@0 206 static itableMethodEntry* method_entry(klassOop k, int offset) { return (itableMethodEntry*)(((address)k) + offset); }
duke@0 207 itableMethodEntry* first_method_entry(klassOop k) { return method_entry(k, _offset); }
duke@0 208
duke@0 209 void initialize(klassOop interf, int offset) { _interface = interf; _offset = offset; }
duke@0 210
duke@0 211 // Static size and offset accessors
duke@0 212 static int size() { return sizeof(itableOffsetEntry) / HeapWordSize; } // size in words
duke@0 213 static int interface_offset_in_bytes() { return offset_of(itableOffsetEntry, _interface); }
duke@0 214 static int offset_offset_in_bytes() { return offset_of(itableOffsetEntry, _offset); }
duke@0 215
duke@0 216 friend class klassItable;
duke@0 217 };
duke@0 218
duke@0 219
duke@0 220 class itableMethodEntry VALUE_OBJ_CLASS_SPEC {
duke@0 221 private:
duke@0 222 methodOop _method;
duke@0 223
duke@0 224 public:
duke@0 225 methodOop method() const { return _method; }
duke@0 226
duke@0 227 void clear() { _method = NULL; }
duke@0 228
duke@0 229 void initialize(methodOop method);
duke@0 230
duke@0 231 // Static size and offset accessors
duke@0 232 static int size() { return sizeof(itableMethodEntry) / HeapWordSize; } // size in words
duke@0 233 static int method_offset_in_bytes() { return offset_of(itableMethodEntry, _method); }
duke@0 234
duke@0 235 friend class klassItable;
duke@0 236 };
duke@0 237
duke@0 238 //
duke@0 239 // Format of an itable
duke@0 240 //
duke@0 241 // ---- offset table ---
duke@0 242 // klassOop of interface 1 \
duke@0 243 // offset to vtable from start of oop / offset table entry
duke@0 244 // ...
duke@0 245 // klassOop of interface n \
duke@0 246 // offset to vtable from start of oop / offset table entry
duke@0 247 // --- vtable for interface 1 ---
duke@0 248 // methodOop \
duke@0 249 // compiler entry point / method table entry
duke@0 250 // ...
duke@0 251 // methodOop \
duke@0 252 // compiler entry point / method table entry
duke@0 253 // -- vtable for interface 2 ---
duke@0 254 // ...
duke@0 255 //
duke@0 256 class klassItable : public ResourceObj {
duke@0 257 private:
duke@0 258 instanceKlassHandle _klass; // my klass
duke@0 259 int _table_offset; // offset of start of itable data within klass (in words)
duke@0 260 int _size_offset_table; // size of offset table (in itableOffset entries)
duke@0 261 int _size_method_table; // size of methodtable (in itableMethodEntry entries)
duke@0 262
duke@0 263 void initialize_itable_for_interface(int method_table_offset, KlassHandle interf_h, bool checkconstraints, TRAPS);
duke@0 264 public:
duke@0 265 klassItable(instanceKlassHandle klass);
duke@0 266
duke@0 267 itableOffsetEntry* offset_entry(int i) { assert(0 <= i && i <= _size_offset_table, "index out of bounds");
duke@0 268 return &((itableOffsetEntry*)vtable_start())[i]; }
duke@0 269
duke@0 270 itableMethodEntry* method_entry(int i) { assert(0 <= i && i <= _size_method_table, "index out of bounds");
duke@0 271 return &((itableMethodEntry*)method_start())[i]; }
duke@0 272
dcubed@16 273 int size_offset_table() { return _size_offset_table; }
duke@0 274
duke@0 275 // Initialization
duke@0 276 void initialize_itable(bool checkconstraints, TRAPS);
duke@0 277
duke@0 278 // Updates
duke@0 279 void initialize_with_method(methodOop m);
duke@0 280
duke@0 281 // RedefineClasses() API support:
duke@0 282 // if any entry of this itable points to any of old_methods,
duke@0 283 // replace it with the corresponding new_method.
duke@0 284 // trace_name_printed is set to true if the current call has
duke@0 285 // printed the klass name so that other routines in the adjust_*
duke@0 286 // group don't print the klass name.
duke@0 287 void adjust_method_entries(methodOop* old_methods, methodOop* new_methods,
duke@0 288 int methods_length, bool * trace_name_printed);
duke@0 289
duke@0 290 // Garbage collection
duke@0 291 void oop_follow_contents();
duke@0 292 void oop_adjust_pointers();
duke@0 293
duke@0 294 #ifndef SERIALGC
duke@0 295 // Parallel Old
duke@0 296 void oop_follow_contents(ParCompactionManager* cm);
duke@0 297 void oop_update_pointers(ParCompactionManager* cm);
duke@0 298 void oop_update_pointers(ParCompactionManager* cm,
duke@0 299 HeapWord* beg_addr, HeapWord* end_addr);
duke@0 300 #endif // SERIALGC
duke@0 301
duke@0 302 // Iterators
duke@0 303 void oop_oop_iterate(OopClosure* blk);
duke@0 304 void oop_oop_iterate_m(OopClosure* blk, MemRegion mr);
duke@0 305
duke@0 306 // Setup of itable
duke@0 307 static int compute_itable_size(objArrayHandle transitive_interfaces);
duke@0 308 static void setup_itable_offset_table(instanceKlassHandle klass);
duke@0 309
duke@0 310 // Resolving of method to index
duke@0 311 static int compute_itable_index(methodOop m);
jrose@665 312 // ...and back again:
jrose@665 313 static methodOop method_for_itable_index(klassOop klass, int itable_index);
duke@0 314
duke@0 315 // Debugging/Statistics
duke@0 316 static void print_statistics() PRODUCT_RETURN;
duke@0 317 private:
duke@0 318 intptr_t* vtable_start() const { return ((intptr_t*)_klass()) + _table_offset; }
duke@0 319 intptr_t* method_start() const { return vtable_start() + _size_offset_table * itableOffsetEntry::size(); }
duke@0 320
duke@0 321 // Helper methods
duke@0 322 static int calc_itable_size(int num_interfaces, int num_methods) { return (num_interfaces * itableOffsetEntry::size()) + (num_methods * itableMethodEntry::size()); }
duke@0 323
duke@0 324 // Statistics
duke@0 325 NOT_PRODUCT(static int _total_classes;) // Total no. of classes with itables
duke@0 326 NOT_PRODUCT(static long _total_size;) // Total no. of bytes used for itables
duke@0 327
duke@0 328 static void update_stats(int size) PRODUCT_RETURN NOT_PRODUCT({ _total_classes++; _total_size += size; })
duke@0 329 };
stefank@1879 330
stefank@1879 331 #endif // SHARE_VM_OOPS_KLASSVTABLE_HPP