1 /*
2 * Copyright (c) 1997, 2025, 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 */
24
25 #include "cds/archiveHeapLoader.hpp"
26 #include "cds/cdsConfig.hpp"
27 #include "cds/heapShared.hpp"
28 #include "classfile/classLoader.hpp"
29 #include "classfile/classLoaderData.inline.hpp"
30 #include "classfile/classLoaderDataGraph.inline.hpp"
31 #include "classfile/javaClasses.inline.hpp"
32 #include "classfile/moduleEntry.hpp"
33 #include "classfile/systemDictionary.hpp"
34 #include "classfile/systemDictionaryShared.hpp"
35 #include "classfile/vmClasses.hpp"
36 #include "classfile/vmSymbols.hpp"
37 #include "gc/shared/collectedHeap.inline.hpp"
38 #include "jvm_io.h"
39 #include "logging/log.hpp"
40 #include "memory/metadataFactory.hpp"
41 #include "memory/metaspaceClosure.hpp"
42 #include "memory/oopFactory.hpp"
43 #include "memory/resourceArea.hpp"
44 #include "memory/universe.hpp"
45 #include "oops/compressedKlass.inline.hpp"
46 #include "oops/compressedOops.inline.hpp"
47 #include "oops/instanceKlass.hpp"
48 #include "oops/klass.inline.hpp"
49 #include "oops/objArrayKlass.hpp"
50 #include "oops/oop.inline.hpp"
51 #include "oops/oopHandle.inline.hpp"
52 #include "prims/jvmtiExport.hpp"
53 #include "runtime/atomic.hpp"
54 #include "runtime/handles.inline.hpp"
55 #include "runtime/perfData.hpp"
56 #include "utilities/macros.hpp"
57 #include "utilities/powerOfTwo.hpp"
58 #include "utilities/rotate_bits.hpp"
59 #include "utilities/stack.inline.hpp"
60
61 void Klass::set_java_mirror(Handle m) {
62 assert(!m.is_null(), "New mirror should never be null.");
63 assert(_java_mirror.is_empty(), "should only be used to initialize mirror");
64 _java_mirror = class_loader_data()->add_handle(m);
65 }
66
67 bool Klass::is_cloneable() const {
68 return _misc_flags.is_cloneable_fast() ||
69 is_subtype_of(vmClasses::Cloneable_klass());
70 }
71
72 void Klass::set_is_cloneable() {
73 if (name() == vmSymbols::java_lang_invoke_MemberName()) {
74 assert(is_final(), "no subclasses allowed");
75 // MemberName cloning should not be intrinsified and always happen in JVM_Clone.
76 } else if (is_instance_klass() && InstanceKlass::cast(this)->reference_type() != REF_NONE) {
77 // Reference cloning should not be intrinsified and always happen in JVM_Clone.
78 } else {
79 _misc_flags.set_is_cloneable_fast(true);
80 }
81 }
82
83 uint8_t Klass::compute_hash_slot(Symbol* n) {
84 uint hash_code;
85 // Special cases for the two superclasses of all Array instances.
86 // Code elsewhere assumes, for all instances of ArrayKlass, that
87 // these two interfaces will be in this order.
88
89 // We ensure there are some empty slots in the hash table between
90 // these two very common interfaces because if they were adjacent
91 // (e.g. Slots 0 and 1), then any other class which hashed to 0 or 1
92 // would result in a probe length of 3.
93 if (n == vmSymbols::java_lang_Cloneable()) {
94 hash_code = 0;
95 } else if (n == vmSymbols::java_io_Serializable()) {
96 hash_code = SECONDARY_SUPERS_TABLE_SIZE / 2;
97 } else {
98 auto s = (const jbyte*) n->bytes();
99 hash_code = java_lang_String::hash_code(s, n->utf8_length());
100 // We use String::hash_code here (rather than e.g.
101 // Symbol::identity_hash()) in order to have a hash code that
102 // does not change from run to run. We want that because the
103 // hash value for a secondary superclass appears in generated
104 // code as a constant.
105
106 // This constant is magic: see Knuth, "Fibonacci Hashing".
107 constexpr uint multiplier
108 = 2654435769; // (uint)(((u8)1 << 32) / ((1 + sqrt(5)) / 2 ))
109 constexpr uint hash_shift = sizeof(hash_code) * 8 - 6;
110 // The leading bits of the least significant half of the product.
111 hash_code = (hash_code * multiplier) >> hash_shift;
112
113 if (StressSecondarySupers) {
114 // Generate many hash collisions in order to stress-test the
115 // linear search fallback.
116 hash_code = hash_code % 3;
117 hash_code = hash_code * (SECONDARY_SUPERS_TABLE_SIZE / 3);
118 }
119 }
120
121 return (hash_code & SECONDARY_SUPERS_TABLE_MASK);
122 }
123
124 void Klass::set_name(Symbol* n) {
125 _name = n;
126
127 if (_name != nullptr) {
128 _name->increment_refcount();
129 }
130
131 {
132 elapsedTimer selftime;
133 selftime.start();
134
135 _hash_slot = compute_hash_slot(n);
136 assert(_hash_slot < SECONDARY_SUPERS_TABLE_SIZE, "required");
137
138 selftime.stop();
139 if (UsePerfData) {
140 ClassLoader::perf_secondary_hash_time()->inc(selftime.ticks());
141 }
142 }
143
144 if (CDSConfig::is_dumping_archive() && is_instance_klass()) {
145 SystemDictionaryShared::init_dumptime_info(InstanceKlass::cast(this));
146 }
147 }
148
149 bool Klass::is_subclass_of(const Klass* k) const {
150 // Run up the super chain and check
151 if (this == k) return true;
152
153 Klass* t = const_cast<Klass*>(this)->super();
154
155 while (t != nullptr) {
156 if (t == k) return true;
157 t = t->super();
158 }
159 return false;
160 }
161
162 void Klass::release_C_heap_structures(bool release_constant_pool) {
163 if (_name != nullptr) _name->decrement_refcount();
164 }
165
166 bool Klass::linear_search_secondary_supers(const Klass* k) const {
167 // Scan the array-of-objects for a match
168 // FIXME: We could do something smarter here, maybe a vectorized
169 // comparison or a binary search, but is that worth any added
170 // complexity?
171 int cnt = secondary_supers()->length();
172 for (int i = 0; i < cnt; i++) {
173 if (secondary_supers()->at(i) == k) {
174 return true;
175 }
176 }
177 return false;
178 }
179
180 // Given a secondary superklass k, an initial array index, and an
181 // occupancy bitmap rotated such that Bit 1 is the next bit to test,
182 // search for k.
183 bool Klass::fallback_search_secondary_supers(const Klass* k, int index, uintx rotated_bitmap) const {
184 // Once the occupancy bitmap is almost full, it's faster to use a
185 // linear search.
186 if (secondary_supers()->length() > SECONDARY_SUPERS_TABLE_SIZE - 2) {
187 return linear_search_secondary_supers(k);
188 }
189
190 // This is conventional linear probing, but instead of terminating
191 // when a null entry is found in the table, we maintain a bitmap
192 // in which a 0 indicates missing entries.
193
194 precond((int)population_count(rotated_bitmap) == secondary_supers()->length());
195
196 // The check for secondary_supers()->length() <= SECONDARY_SUPERS_TABLE_SIZE - 2
197 // at the start of this function guarantees there are 0s in the
198 // bitmap, so this loop eventually terminates.
199 while ((rotated_bitmap & 2) != 0) {
200 if (++index == secondary_supers()->length()) {
201 index = 0;
202 }
203 if (secondary_supers()->at(index) == k) {
204 return true;
205 }
206 rotated_bitmap = rotate_right(rotated_bitmap, 1);
207 }
208 return false;
209 }
210
211 // Return self, except for abstract classes with exactly 1
212 // implementor. Then return the 1 concrete implementation.
213 Klass *Klass::up_cast_abstract() {
214 Klass *r = this;
215 while( r->is_abstract() ) { // Receiver is abstract?
216 Klass *s = r->subklass(); // Check for exactly 1 subklass
217 if (s == nullptr || s->next_sibling() != nullptr) // Oops; wrong count; give up
218 return this; // Return 'this' as a no-progress flag
219 r = s; // Loop till find concrete class
220 }
221 return r; // Return the 1 concrete class
222 }
223
224 // Find LCA in class hierarchy
225 Klass *Klass::LCA( Klass *k2 ) {
226 Klass *k1 = this;
227 while( 1 ) {
228 if( k1->is_subtype_of(k2) ) return k2;
229 if( k2->is_subtype_of(k1) ) return k1;
230 k1 = k1->super();
231 k2 = k2->super();
232 }
233 }
234
235
236 void Klass::check_valid_for_instantiation(bool throwError, TRAPS) {
237 ResourceMark rm(THREAD);
238 THROW_MSG(throwError ? vmSymbols::java_lang_InstantiationError()
239 : vmSymbols::java_lang_InstantiationException(), external_name());
240 }
241
242
243 void Klass::copy_array(arrayOop s, int src_pos, arrayOop d, int dst_pos, int length, TRAPS) {
244 ResourceMark rm(THREAD);
245 assert(s != nullptr, "Throw NPE!");
246 THROW_MSG(vmSymbols::java_lang_ArrayStoreException(),
247 err_msg("arraycopy: source type %s is not an array", s->klass()->external_name()));
248 }
249
250
251 void Klass::initialize(TRAPS) {
252 ShouldNotReachHere();
253 }
254
255 void Klass::initialize_preemptable(TRAPS) {
256 ShouldNotReachHere();
257 }
258
259 Klass* Klass::find_field(Symbol* name, Symbol* sig, fieldDescriptor* fd) const {
260 #ifdef ASSERT
261 tty->print_cr("Error: find_field called on a klass oop."
262 " Likely error: reflection method does not correctly"
263 " wrap return value in a mirror object.");
264 #endif
265 ShouldNotReachHere();
266 return nullptr;
267 }
268
269 Method* Klass::uncached_lookup_method(const Symbol* name, const Symbol* signature,
270 OverpassLookupMode overpass_mode,
271 PrivateLookupMode private_mode) const {
272 #ifdef ASSERT
273 tty->print_cr("Error: uncached_lookup_method called on a klass oop."
274 " Likely error: reflection method does not correctly"
275 " wrap return value in a mirror object.");
276 #endif
277 ShouldNotReachHere();
278 return nullptr;
279 }
280
281 static markWord make_prototype(const Klass* kls) {
282 markWord prototype = markWord::prototype();
283 #ifdef _LP64
284 if (UseCompactObjectHeaders) {
285 // With compact object headers, the narrow Klass ID is part of the mark word.
286 // We therfore seed the mark word with the narrow Klass ID.
287 // Note that only those Klass that can be instantiated have a narrow Klass ID.
288 // For those who don't, we leave the klass bits empty and assert if someone
289 // tries to use those.
290 const narrowKlass nk = CompressedKlassPointers::is_encodable(kls) ?
291 CompressedKlassPointers::encode(const_cast<Klass*>(kls)) : 0;
292 prototype = prototype.set_narrow_klass(nk);
293 }
294 #endif
295 return prototype;
296 }
297
298 Klass::Klass() : _kind(UnknownKlassKind) {
299 assert(CDSConfig::is_dumping_static_archive() || CDSConfig::is_using_archive(), "only for cds");
300 }
301
302 // "Normal" instantiation is preceded by a MetaspaceObj allocation
303 // which zeros out memory - calloc equivalent.
304 // The constructor is also used from CppVtableCloner,
305 // which doesn't zero out the memory before calling the constructor.
306 Klass::Klass(KlassKind kind) : _kind(kind),
307 _prototype_header(make_prototype(this)),
308 _shared_class_path_index(-1) {
309 CDS_ONLY(_shared_class_flags = 0;)
310 CDS_JAVA_HEAP_ONLY(_archived_mirror_index = -1;)
311 _primary_supers[0] = this;
312 set_super_check_offset(in_bytes(primary_supers_offset()));
313 }
314
315 jint Klass::array_layout_helper(BasicType etype) {
316 assert(etype >= T_BOOLEAN && etype <= T_OBJECT, "valid etype");
317 // Note that T_ARRAY is not allowed here.
318 int hsize = arrayOopDesc::base_offset_in_bytes(etype);
319 int esize = type2aelembytes(etype);
320 bool isobj = (etype == T_OBJECT);
321 int tag = isobj ? _lh_array_tag_obj_value : _lh_array_tag_type_value;
322 int lh = array_layout_helper(tag, hsize, etype, exact_log2(esize));
323
324 assert(lh < (int)_lh_neutral_value, "must look like an array layout");
325 assert(layout_helper_is_array(lh), "correct kind");
326 assert(layout_helper_is_objArray(lh) == isobj, "correct kind");
327 assert(layout_helper_is_typeArray(lh) == !isobj, "correct kind");
328 assert(layout_helper_header_size(lh) == hsize, "correct decode");
329 assert(layout_helper_element_type(lh) == etype, "correct decode");
330 assert(1 << layout_helper_log2_element_size(lh) == esize, "correct decode");
331
332 return lh;
333 }
334
335 int Klass::modifier_flags() const {
336 int mods = java_lang_Class::modifiers(java_mirror());
337 assert(mods == compute_modifier_flags(), "should be same");
338 return mods;
339 }
340
341 bool Klass::can_be_primary_super_slow() const {
342 if (super() == nullptr)
343 return true;
344 else if (super()->super_depth() >= primary_super_limit()-1)
345 return false;
346 else
347 return true;
348 }
349
350 void Klass::set_secondary_supers(Array<Klass*>* secondaries, uintx bitmap) {
351 #ifdef ASSERT
352 if (secondaries != nullptr) {
353 uintx real_bitmap = compute_secondary_supers_bitmap(secondaries);
354 assert(bitmap == real_bitmap, "must be");
355 assert(secondaries->length() >= (int)population_count(bitmap), "must be");
356 }
357 #endif
358 _secondary_supers_bitmap = bitmap;
359 _secondary_supers = secondaries;
360
361 if (secondaries != nullptr) {
362 LogMessage(class, load) msg;
363 NonInterleavingLogStream log {LogLevel::Debug, msg};
364 if (log.is_enabled()) {
365 ResourceMark rm;
366 log.print_cr("set_secondary_supers: hash_slot: %d; klass: %s", hash_slot(), external_name());
367 print_secondary_supers_on(&log);
368 }
369 }
370 }
371
372 // Hashed secondary superclasses
373 //
374 // We use a compressed 64-entry hash table with linear probing. We
375 // start by creating a hash table in the usual way, followed by a pass
376 // that removes all the null entries. To indicate which entries would
377 // have been null we use a bitmap that contains a 1 in each position
378 // where an entry is present, 0 otherwise. This bitmap also serves as
379 // a kind of Bloom filter, which in many cases allows us quickly to
380 // eliminate the possibility that something is a member of a set of
381 // secondaries.
382 uintx Klass::hash_secondary_supers(Array<Klass*>* secondaries, bool rewrite) {
383 const int length = secondaries->length();
384
385 if (length == 0) {
386 return SECONDARY_SUPERS_BITMAP_EMPTY;
387 }
388
389 if (length == 1) {
390 int hash_slot = secondaries->at(0)->hash_slot();
391 return uintx(1) << hash_slot;
392 }
393
394 // Invariant: _secondary_supers.length >= population_count(_secondary_supers_bitmap)
395
396 // Don't attempt to hash a table that's completely full, because in
397 // the case of an absent interface linear probing would not
398 // terminate.
399 if (length >= SECONDARY_SUPERS_TABLE_SIZE) {
400 return SECONDARY_SUPERS_BITMAP_FULL;
401 }
402
403 {
404 PerfTraceTime ptt(ClassLoader::perf_secondary_hash_time());
405
406 ResourceMark rm;
407 uintx bitmap = SECONDARY_SUPERS_BITMAP_EMPTY;
408 auto hashed_secondaries = new GrowableArray<Klass*>(SECONDARY_SUPERS_TABLE_SIZE,
409 SECONDARY_SUPERS_TABLE_SIZE, nullptr);
410
411 for (int j = 0; j < length; j++) {
412 Klass* k = secondaries->at(j);
413 hash_insert(k, hashed_secondaries, bitmap);
414 }
415
416 // Pack the hashed secondaries array by copying it into the
417 // secondaries array, sans nulls, if modification is allowed.
418 // Otherwise, validate the order.
419 int i = 0;
420 for (int slot = 0; slot < SECONDARY_SUPERS_TABLE_SIZE; slot++) {
421 bool has_element = ((bitmap >> slot) & 1) != 0;
422 assert(has_element == (hashed_secondaries->at(slot) != nullptr), "");
423 if (has_element) {
424 Klass* k = hashed_secondaries->at(slot);
425 if (rewrite) {
426 secondaries->at_put(i, k);
427 } else if (secondaries->at(i) != k) {
428 assert(false, "broken secondary supers hash table");
429 return SECONDARY_SUPERS_BITMAP_FULL;
430 }
431 i++;
432 }
433 }
434 assert(i == secondaries->length(), "mismatch");
435 postcond((int)population_count(bitmap) == secondaries->length());
436
437 return bitmap;
438 }
439 }
440
441 void Klass::hash_insert(Klass* klass, GrowableArray<Klass*>* secondaries, uintx& bitmap) {
442 assert(bitmap != SECONDARY_SUPERS_BITMAP_FULL, "");
443
444 int dist = 0;
445 for (int slot = klass->hash_slot(); true; slot = (slot + 1) & SECONDARY_SUPERS_TABLE_MASK) {
446 Klass* existing = secondaries->at(slot);
447 assert(((bitmap >> slot) & 1) == (existing != nullptr), "mismatch");
448 if (existing == nullptr) { // no conflict
449 secondaries->at_put(slot, klass);
450 bitmap |= uintx(1) << slot;
451 assert(bitmap != SECONDARY_SUPERS_BITMAP_FULL, "");
452 return;
453 } else {
454 // Use Robin Hood hashing to minimize the worst case search.
455 // Also, every permutation of the insertion sequence produces
456 // the same final Robin Hood hash table, provided that a
457 // consistent tie breaker is used.
458 int existing_dist = (slot - existing->hash_slot()) & SECONDARY_SUPERS_TABLE_MASK;
459 if (existing_dist < dist
460 // This tie breaker ensures that the hash order is maintained.
461 || ((existing_dist == dist)
462 && (uintptr_t(existing) < uintptr_t(klass)))) {
463 Klass* tmp = secondaries->at(slot);
464 secondaries->at_put(slot, klass);
465 klass = tmp;
466 dist = existing_dist;
467 }
468 ++dist;
469 }
470 }
471 }
472
473 Array<Klass*>* Klass::pack_secondary_supers(ClassLoaderData* loader_data,
474 GrowableArray<Klass*>* primaries,
475 GrowableArray<Klass*>* secondaries,
476 uintx& bitmap, TRAPS) {
477 int new_length = primaries->length() + secondaries->length();
478 Array<Klass*>* secondary_supers = MetadataFactory::new_array<Klass*>(loader_data, new_length, CHECK_NULL);
479
480 // Combine the two arrays into a metadata object to pack the array.
481 // The primaries are added in the reverse order, then the secondaries.
482 int fill_p = primaries->length();
483 for (int j = 0; j < fill_p; j++) {
484 secondary_supers->at_put(j, primaries->pop()); // add primaries in reverse order.
485 }
486 for( int j = 0; j < secondaries->length(); j++ ) {
487 secondary_supers->at_put(j+fill_p, secondaries->at(j)); // add secondaries on the end.
488 }
489 #ifdef ASSERT
490 // We must not copy any null placeholders left over from bootstrap.
491 for (int j = 0; j < secondary_supers->length(); j++) {
492 assert(secondary_supers->at(j) != nullptr, "correct bootstrapping order");
493 }
494 #endif
495
496 bitmap = hash_secondary_supers(secondary_supers, /*rewrite=*/true); // rewrites freshly allocated array
497 return secondary_supers;
498 }
499
500 uintx Klass::compute_secondary_supers_bitmap(Array<Klass*>* secondary_supers) {
501 return hash_secondary_supers(secondary_supers, /*rewrite=*/false); // no rewrites allowed
502 }
503
504 uint8_t Klass::compute_home_slot(Klass* k, uintx bitmap) {
505 uint8_t hash = k->hash_slot();
506 if (hash > 0) {
507 return population_count(bitmap << (SECONDARY_SUPERS_TABLE_SIZE - hash));
508 }
509 return 0;
510 }
511
512
513 void Klass::initialize_supers(Klass* k, Array<InstanceKlass*>* transitive_interfaces, TRAPS) {
514 if (k == nullptr) {
515 set_super(nullptr);
516 _primary_supers[0] = this;
517 assert(super_depth() == 0, "Object must already be initialized properly");
518 } else if (k != super() || k == vmClasses::Object_klass()) {
519 assert(super() == nullptr || super() == vmClasses::Object_klass(),
520 "initialize this only once to a non-trivial value");
521 set_super(k);
522 Klass* sup = k;
523 int sup_depth = sup->super_depth();
524 juint my_depth = MIN2(sup_depth + 1, (int)primary_super_limit());
525 if (!can_be_primary_super_slow())
526 my_depth = primary_super_limit();
527 for (juint i = 0; i < my_depth; i++) {
528 _primary_supers[i] = sup->_primary_supers[i];
529 }
530 Klass* *super_check_cell;
531 if (my_depth < primary_super_limit()) {
532 _primary_supers[my_depth] = this;
533 super_check_cell = &_primary_supers[my_depth];
534 } else {
535 // Overflow of the primary_supers array forces me to be secondary.
536 super_check_cell = &_secondary_super_cache;
537 }
538 set_super_check_offset(u4((address)super_check_cell - (address) this));
539
540 #ifdef ASSERT
541 {
542 juint j = super_depth();
543 assert(j == my_depth, "computed accessor gets right answer");
544 Klass* t = this;
545 while (!t->can_be_primary_super()) {
546 t = t->super();
547 j = t->super_depth();
548 }
549 for (juint j1 = j+1; j1 < primary_super_limit(); j1++) {
550 assert(primary_super_of_depth(j1) == nullptr, "super list padding");
551 }
552 while (t != nullptr) {
553 assert(primary_super_of_depth(j) == t, "super list initialization");
554 t = t->super();
555 --j;
556 }
557 assert(j == (juint)-1, "correct depth count");
558 }
559 #endif
560 }
561
562 if (secondary_supers() == nullptr) {
563
564 // Now compute the list of secondary supertypes.
565 // Secondaries can occasionally be on the super chain,
566 // if the inline "_primary_supers" array overflows.
567 int extras = 0;
568 Klass* p;
569 for (p = super(); !(p == nullptr || p->can_be_primary_super()); p = p->super()) {
570 ++extras;
571 }
572
573 ResourceMark rm(THREAD); // need to reclaim GrowableArrays allocated below
574
575 // Compute the "real" non-extra secondaries.
576 GrowableArray<Klass*>* secondaries = compute_secondary_supers(extras, transitive_interfaces);
577 if (secondaries == nullptr) {
578 // secondary_supers set by compute_secondary_supers
579 return;
580 }
581
582 GrowableArray<Klass*>* primaries = new GrowableArray<Klass*>(extras);
583
584 for (p = super(); !(p == nullptr || p->can_be_primary_super()); p = p->super()) {
585 int i; // Scan for overflow primaries being duplicates of 2nd'arys
586
587 // This happens frequently for very deeply nested arrays: the
588 // primary superclass chain overflows into the secondary. The
589 // secondary list contains the element_klass's secondaries with
590 // an extra array dimension added. If the element_klass's
591 // secondary list already contains some primary overflows, they
592 // (with the extra level of array-ness) will collide with the
593 // normal primary superclass overflows.
594 for( i = 0; i < secondaries->length(); i++ ) {
595 if( secondaries->at(i) == p )
596 break;
597 }
598 if( i < secondaries->length() )
599 continue; // It's a dup, don't put it in
600 primaries->push(p);
601 }
602 // Combine the two arrays into a metadata object to pack the array.
603 uintx bitmap = 0;
604 Array<Klass*>* s2 = pack_secondary_supers(class_loader_data(), primaries, secondaries, bitmap, CHECK);
605 set_secondary_supers(s2, bitmap);
606 }
607 }
608
609 GrowableArray<Klass*>* Klass::compute_secondary_supers(int num_extra_slots,
610 Array<InstanceKlass*>* transitive_interfaces) {
611 assert(num_extra_slots == 0, "override for complex klasses");
612 assert(transitive_interfaces == nullptr, "sanity");
613 set_secondary_supers(Universe::the_empty_klass_array(), Universe::the_empty_klass_bitmap());
614 return nullptr;
615 }
616
617
618 // superklass links
619 InstanceKlass* Klass::superklass() const {
620 assert(super() == nullptr || super()->is_instance_klass(), "must be instance klass");
621 return _super == nullptr ? nullptr : InstanceKlass::cast(_super);
622 }
623
624 // subklass links. Used by the compiler (and vtable initialization)
625 // May be cleaned concurrently, so must use the Compile_lock.
626 // The log parameter is for clean_weak_klass_links to report unlinked classes.
627 Klass* Klass::subklass(bool log) const {
628 // Need load_acquire on the _subklass, because it races with inserts that
629 // publishes freshly initialized data.
630 for (Klass* chain = Atomic::load_acquire(&_subklass);
631 chain != nullptr;
632 // Do not need load_acquire on _next_sibling, because inserts never
633 // create _next_sibling edges to dead data.
634 chain = Atomic::load(&chain->_next_sibling))
635 {
636 if (chain->is_loader_alive()) {
637 return chain;
638 } else if (log) {
639 if (log_is_enabled(Trace, class, unload)) {
640 ResourceMark rm;
641 log_trace(class, unload)("unlinking class (subclass): %s", chain->external_name());
642 }
643 }
644 }
645 return nullptr;
646 }
647
648 Klass* Klass::next_sibling(bool log) const {
649 // Do not need load_acquire on _next_sibling, because inserts never
650 // create _next_sibling edges to dead data.
651 for (Klass* chain = Atomic::load(&_next_sibling);
652 chain != nullptr;
653 chain = Atomic::load(&chain->_next_sibling)) {
654 // Only return alive klass, there may be stale klass
655 // in this chain if cleaned concurrently.
656 if (chain->is_loader_alive()) {
657 return chain;
658 } else if (log) {
659 if (log_is_enabled(Trace, class, unload)) {
660 ResourceMark rm;
661 log_trace(class, unload)("unlinking class (sibling): %s", chain->external_name());
662 }
663 }
664 }
665 return nullptr;
666 }
667
668 void Klass::set_subklass(Klass* s) {
669 assert(s != this, "sanity check");
670 Atomic::release_store(&_subklass, s);
671 }
672
673 void Klass::set_next_sibling(Klass* s) {
674 assert(s != this, "sanity check");
675 // Does not need release semantics. If used by cleanup, it will link to
676 // already safely published data, and if used by inserts, will be published
677 // safely using cmpxchg.
678 Atomic::store(&_next_sibling, s);
679 }
680
681 void Klass::append_to_sibling_list() {
682 if (Universe::is_fully_initialized()) {
683 assert_locked_or_safepoint(Compile_lock);
684 }
685 debug_only(verify();)
686 // add ourselves to superklass' subklass list
687 InstanceKlass* super = superklass();
688 if (super == nullptr) return; // special case: class Object
689 assert((!super->is_interface() // interfaces cannot be supers
690 && (super->superklass() == nullptr || !is_interface())),
691 "an interface can only be a subklass of Object");
692
693 // Make sure there is no stale subklass head
694 super->clean_subklass();
695
696 for (;;) {
697 Klass* prev_first_subklass = Atomic::load_acquire(&_super->_subklass);
698 if (prev_first_subklass != nullptr) {
699 // set our sibling to be the superklass' previous first subklass
700 assert(prev_first_subklass->is_loader_alive(), "May not attach not alive klasses");
701 set_next_sibling(prev_first_subklass);
702 }
703 // Note that the prev_first_subklass is always alive, meaning no sibling_next links
704 // are ever created to not alive klasses. This is an important invariant of the lock-free
705 // cleaning protocol, that allows us to safely unlink dead klasses from the sibling list.
706 if (Atomic::cmpxchg(&super->_subklass, prev_first_subklass, this) == prev_first_subklass) {
707 return;
708 }
709 }
710 debug_only(verify();)
711 }
712
713 void Klass::clean_subklass() {
714 for (;;) {
715 // Need load_acquire, due to contending with concurrent inserts
716 Klass* subklass = Atomic::load_acquire(&_subklass);
717 if (subklass == nullptr || subklass->is_loader_alive()) {
718 return;
719 }
720 // Try to fix _subklass until it points at something not dead.
721 Atomic::cmpxchg(&_subklass, subklass, subklass->next_sibling());
722 }
723 }
724
725 void Klass::clean_weak_klass_links(bool unloading_occurred, bool clean_alive_klasses) {
726 if (!ClassUnloading || !unloading_occurred) {
727 return;
728 }
729
730 Klass* root = vmClasses::Object_klass();
731 Stack<Klass*, mtGC> stack;
732
733 stack.push(root);
734 while (!stack.is_empty()) {
735 Klass* current = stack.pop();
736
737 assert(current->is_loader_alive(), "just checking, this should be live");
738
739 // Find and set the first alive subklass
740 Klass* sub = current->subklass(true);
741 current->clean_subklass();
742 if (sub != nullptr) {
743 stack.push(sub);
744 }
745
746 // Find and set the first alive sibling
747 Klass* sibling = current->next_sibling(true);
748 current->set_next_sibling(sibling);
749 if (sibling != nullptr) {
750 stack.push(sibling);
751 }
752
753 // Clean the implementors list and method data.
754 if (clean_alive_klasses && current->is_instance_klass()) {
755 InstanceKlass* ik = InstanceKlass::cast(current);
756 ik->clean_weak_instanceklass_links();
757
758 // JVMTI RedefineClasses creates previous versions that are not in
759 // the class hierarchy, so process them here.
760 while ((ik = ik->previous_versions()) != nullptr) {
761 ik->clean_weak_instanceklass_links();
762 }
763 }
764 }
765 }
766
767 void Klass::metaspace_pointers_do(MetaspaceClosure* it) {
768 if (log_is_enabled(Trace, cds)) {
769 ResourceMark rm;
770 log_trace(cds)("Iter(Klass): %p (%s)", this, external_name());
771 }
772
773 it->push(&_name);
774 it->push(&_secondary_supers);
775 for (int i = 0; i < _primary_super_limit; i++) {
776 it->push(&_primary_supers[i]);
777 }
778 it->push(&_super);
779 if (!CDSConfig::is_dumping_archive()) {
780 // If dumping archive, these may point to excluded classes. There's no need
781 // to follow these pointers anyway, as they will be set to null in
782 // remove_unshareable_info().
783 it->push((Klass**)&_subklass);
784 it->push((Klass**)&_next_sibling);
785 it->push(&_next_link);
786 }
787
788 vtableEntry* vt = start_of_vtable();
789 for (int i=0; i<vtable_length(); i++) {
790 it->push(vt[i].method_addr());
791 }
792 }
793
794 #if INCLUDE_CDS
795 void Klass::remove_unshareable_info() {
796 assert(CDSConfig::is_dumping_archive(),
797 "only called during CDS dump time");
798 JFR_ONLY(REMOVE_ID(this);)
799 if (log_is_enabled(Trace, cds, unshareable)) {
800 ResourceMark rm;
801 log_trace(cds, unshareable)("remove: %s", external_name());
802 }
803
804 // _secondary_super_cache may be updated by an is_subtype_of() call
805 // while ArchiveBuilder is copying metaspace objects. Let's reset it to
806 // null and let it be repopulated at runtime.
807 set_secondary_super_cache(nullptr);
808
809 set_subklass(nullptr);
810 set_next_sibling(nullptr);
811 set_next_link(nullptr);
812
813 // Null out class_loader_data because we don't share that yet.
814 set_class_loader_data(nullptr);
815 set_is_shared();
816
817 // FIXME: validation in Klass::hash_secondary_supers() may fail for shared klasses.
818 // Even though the bitmaps always match, the canonical order of elements in the table
819 // is not guaranteed to stay the same (see tie breaker during Robin Hood hashing in Klass::hash_insert).
820 //assert(compute_secondary_supers_bitmap(secondary_supers()) == _secondary_supers_bitmap, "broken table");
821 }
822
823 void Klass::remove_java_mirror() {
824 assert(CDSConfig::is_dumping_archive(), "sanity");
825 if (log_is_enabled(Trace, cds, unshareable)) {
826 ResourceMark rm;
827 log_trace(cds, unshareable)("remove java_mirror: %s", external_name());
828 }
829
830 #if INCLUDE_CDS_JAVA_HEAP
831 _archived_mirror_index = -1;
832 if (CDSConfig::is_dumping_heap()) {
833 Klass* src_k = ArchiveBuilder::current()->get_source_addr(this);
834 oop orig_mirror = src_k->java_mirror();
835 if (orig_mirror == nullptr) {
836 assert(CDSConfig::is_dumping_final_static_archive(), "sanity");
837 assert(is_instance_klass(), "sanity");
838 assert(InstanceKlass::cast(this)->is_shared_unregistered_class(), "sanity");
839 } else {
840 oop scratch_mirror = HeapShared::scratch_java_mirror(orig_mirror);
841 if (scratch_mirror != nullptr) {
842 _archived_mirror_index = HeapShared::append_root(scratch_mirror);
843 }
844 }
845 }
846 #endif
847
848 // Just null out the mirror. The class_loader_data() no longer exists.
849 clear_java_mirror_handle();
850 }
851
852 void Klass::restore_unshareable_info(ClassLoaderData* loader_data, Handle protection_domain, TRAPS) {
853 assert(is_klass(), "ensure C++ vtable is restored");
854 assert(is_shared(), "must be set");
855 assert(secondary_supers()->length() >= (int)population_count(_secondary_supers_bitmap), "must be");
856 JFR_ONLY(RESTORE_ID(this);)
857 if (log_is_enabled(Trace, cds, unshareable)) {
858 ResourceMark rm(THREAD);
859 oop class_loader = loader_data->class_loader();
860 log_trace(cds, unshareable)("restore: %s with class loader: %s", external_name(),
861 class_loader != nullptr ? class_loader->klass()->external_name() : "boot");
862 }
863
864 // If an exception happened during CDS restore, some of these fields may already be
865 // set. We leave the class on the CLD list, even if incomplete so that we don't
866 // modify the CLD list outside a safepoint.
867 if (class_loader_data() == nullptr) {
868 set_class_loader_data(loader_data);
869
870 // Add to class loader list first before creating the mirror
871 // (same order as class file parsing)
872 loader_data->add_class(this);
873 }
874
875 Handle loader(THREAD, loader_data->class_loader());
876 ModuleEntry* module_entry = nullptr;
877 Klass* k = this;
878 if (k->is_objArray_klass()) {
879 k = ObjArrayKlass::cast(k)->bottom_klass();
880 }
881 // Obtain klass' module.
882 if (k->is_instance_klass()) {
883 InstanceKlass* ik = (InstanceKlass*) k;
884 module_entry = ik->module();
885 } else {
886 module_entry = ModuleEntryTable::javabase_moduleEntry();
887 }
888 // Obtain java.lang.Module, if available
889 Handle module_handle(THREAD, ((module_entry != nullptr) ? module_entry->module() : (oop)nullptr));
890
891 if (this->has_archived_mirror_index()) {
892 ResourceMark rm(THREAD);
893 log_debug(cds, mirror)("%s has raw archived mirror", external_name());
894 if (ArchiveHeapLoader::is_in_use()) {
895 bool present = java_lang_Class::restore_archived_mirror(this, loader, module_handle,
896 protection_domain,
897 CHECK);
898 if (present) {
899 return;
900 }
901 }
902
903 // No archived mirror data
904 log_debug(cds, mirror)("No archived mirror data for %s", external_name());
905 clear_java_mirror_handle();
906 this->clear_archived_mirror_index();
907 }
908
909 // Only recreate it if not present. A previous attempt to restore may have
910 // gotten an OOM later but keep the mirror if it was created.
911 if (java_mirror() == nullptr) {
912 ResourceMark rm(THREAD);
913 log_trace(cds, mirror)("Recreate mirror for %s", external_name());
914 java_lang_Class::create_mirror(this, loader, module_handle, protection_domain, Handle(), CHECK);
915 }
916 }
917 #endif // INCLUDE_CDS
918
919 #if INCLUDE_CDS_JAVA_HEAP
920 oop Klass::archived_java_mirror() {
921 assert(has_archived_mirror_index(), "must have archived mirror");
922 return HeapShared::get_root(_archived_mirror_index);
923 }
924
925 void Klass::clear_archived_mirror_index() {
926 if (_archived_mirror_index >= 0) {
927 HeapShared::clear_root(_archived_mirror_index);
928 }
929 _archived_mirror_index = -1;
930 }
931 #endif // INCLUDE_CDS_JAVA_HEAP
932
933 void Klass::check_array_allocation_length(int length, int max_length, TRAPS) {
934 if (length > max_length) {
935 if (!THREAD->is_in_internal_oome_mark()) {
936 report_java_out_of_memory("Requested array size exceeds VM limit");
937 JvmtiExport::post_array_size_exhausted();
938 THROW_OOP(Universe::out_of_memory_error_array_size());
939 } else {
940 THROW_OOP(Universe::out_of_memory_error_java_heap_without_backtrace());
941 }
942 } else if (length < 0) {
943 THROW_MSG(vmSymbols::java_lang_NegativeArraySizeException(), err_msg("%d", length));
944 }
945 }
946
947 // Replace the last '+' char with '/'.
948 static char* convert_hidden_name_to_java(Symbol* name) {
949 size_t name_len = name->utf8_length();
950 char* result = NEW_RESOURCE_ARRAY(char, name_len + 1);
951 name->as_klass_external_name(result, (int)name_len + 1);
952 for (int index = (int)name_len; index > 0; index--) {
953 if (result[index] == '+') {
954 result[index] = JVM_SIGNATURE_SLASH;
955 break;
956 }
957 }
958 return result;
959 }
960
961 // In product mode, this function doesn't have virtual function calls so
962 // there might be some performance advantage to handling InstanceKlass here.
963 const char* Klass::external_name() const {
964 if (is_instance_klass()) {
965 const InstanceKlass* ik = static_cast<const InstanceKlass*>(this);
966 if (ik->is_hidden()) {
967 char* result = convert_hidden_name_to_java(name());
968 return result;
969 }
970 } else if (is_objArray_klass() && ObjArrayKlass::cast(this)->bottom_klass()->is_hidden()) {
971 char* result = convert_hidden_name_to_java(name());
972 return result;
973 }
974 if (name() == nullptr) return "<unknown>";
975 return name()->as_klass_external_name();
976 }
977
978 const char* Klass::signature_name() const {
979 if (name() == nullptr) return "<unknown>";
980 if (is_objArray_klass() && ObjArrayKlass::cast(this)->bottom_klass()->is_hidden()) {
981 size_t name_len = name()->utf8_length();
982 char* result = NEW_RESOURCE_ARRAY(char, name_len + 1);
983 name()->as_C_string(result, (int)name_len + 1);
984 for (int index = (int)name_len; index > 0; index--) {
985 if (result[index] == '+') {
986 result[index] = JVM_SIGNATURE_DOT;
987 break;
988 }
989 }
990 return result;
991 }
992 return name()->as_C_string();
993 }
994
995 const char* Klass::external_kind() const {
996 if (is_interface()) return "interface";
997 if (is_abstract()) return "abstract class";
998 return "class";
999 }
1000
1001 // Unless overridden, jvmti_class_status has no flags set.
1002 jint Klass::jvmti_class_status() const {
1003 return 0;
1004 }
1005
1006
1007 // Printing
1008
1009 void Klass::print_on(outputStream* st) const {
1010 ResourceMark rm;
1011 // print title
1012 st->print("%s", internal_name());
1013 print_address_on(st);
1014 st->cr();
1015 }
1016
1017 #define BULLET " - "
1018
1019 // Caller needs ResourceMark
1020 void Klass::oop_print_on(oop obj, outputStream* st) {
1021 // print title
1022 st->print_cr("%s ", internal_name());
1023 obj->print_address_on(st);
1024
1025 if (WizardMode) {
1026 // print header
1027 obj->mark().print_on(st);
1028 st->cr();
1029 if (UseCompactObjectHeaders) {
1030 st->print(BULLET"prototype_header: " INTPTR_FORMAT, _prototype_header.value());
1031 st->cr();
1032 }
1033 }
1034
1035 // print class
1036 st->print(BULLET"klass: ");
1037 obj->klass()->print_value_on(st);
1038 st->print(BULLET"flags: "); _misc_flags.print_on(st); st->cr();
1039 st->cr();
1040 }
1041
1042 void Klass::oop_print_value_on(oop obj, outputStream* st) {
1043 // print title
1044 ResourceMark rm; // Cannot print in debug mode without this
1045 st->print("%s", internal_name());
1046 obj->print_address_on(st);
1047 }
1048
1049 // Verification
1050
1051 void Klass::verify_on(outputStream* st) {
1052
1053 // This can be expensive, but it is worth checking that this klass is actually
1054 // in the CLD graph but not in production.
1055 #ifdef ASSERT
1056 if (UseCompressedClassPointers && needs_narrow_id()) {
1057 // Stricter checks for both correct alignment and placement
1058 CompressedKlassPointers::check_encodable(this);
1059 } else {
1060 assert(Metaspace::contains((address)this), "Should be");
1061 }
1062 #endif // ASSERT
1063
1064 guarantee(this->is_klass(),"should be klass");
1065
1066 if (super() != nullptr) {
1067 guarantee(super()->is_klass(), "should be klass");
1068 }
1069 if (secondary_super_cache() != nullptr) {
1070 Klass* ko = secondary_super_cache();
1071 guarantee(ko->is_klass(), "should be klass");
1072 }
1073 for ( uint i = 0; i < primary_super_limit(); i++ ) {
1074 Klass* ko = _primary_supers[i];
1075 if (ko != nullptr) {
1076 guarantee(ko->is_klass(), "should be klass");
1077 }
1078 }
1079
1080 if (java_mirror_no_keepalive() != nullptr) {
1081 guarantee(java_lang_Class::is_instance(java_mirror_no_keepalive()), "should be instance");
1082 }
1083 }
1084
1085 void Klass::oop_verify_on(oop obj, outputStream* st) {
1086 guarantee(oopDesc::is_oop(obj), "should be oop");
1087 guarantee(obj->klass()->is_klass(), "klass field is not a klass");
1088 }
1089
1090 // Note: this function is called with an address that may or may not be a Klass.
1091 // The point is not to assert it is but to check if it could be.
1092 bool Klass::is_valid(Klass* k) {
1093 if (!is_aligned(k, sizeof(MetaWord))) return false;
1094 if ((size_t)k < os::min_page_size()) return false;
1095
1096 if (!os::is_readable_range(k, k + 1)) return false;
1097 if (!Metaspace::contains(k)) return false;
1098
1099 if (!Symbol::is_valid(k->name())) return false;
1100 return ClassLoaderDataGraph::is_valid(k->class_loader_data());
1101 }
1102
1103 Method* Klass::method_at_vtable(int index) {
1104 #ifndef PRODUCT
1105 assert(index >= 0, "valid vtable index");
1106 if (DebugVtables) {
1107 verify_vtable_index(index);
1108 }
1109 #endif
1110 return start_of_vtable()[index].method();
1111 }
1112
1113
1114 #ifndef PRODUCT
1115
1116 bool Klass::verify_vtable_index(int i) {
1117 int limit = vtable_length()/vtableEntry::size();
1118 assert(i >= 0 && i < limit, "index %d out of bounds %d", i, limit);
1119 return true;
1120 }
1121
1122 #endif // PRODUCT
1123
1124 // Caller needs ResourceMark
1125 // joint_in_module_of_loader provides an optimization if 2 classes are in
1126 // the same module to succinctly print out relevant information about their
1127 // module name and class loader's name_and_id for error messages.
1128 // Format:
1129 // <fully-qualified-external-class-name1> and <fully-qualified-external-class-name2>
1130 // are in module <module-name>[@<version>]
1131 // of loader <loader-name_and_id>[, parent loader <parent-loader-name_and_id>]
1132 const char* Klass::joint_in_module_of_loader(const Klass* class2, bool include_parent_loader) const {
1133 assert(module() == class2->module(), "classes do not have the same module");
1134 const char* class1_name = external_name();
1135 size_t len = strlen(class1_name) + 1;
1136
1137 const char* class2_description = class2->class_in_module_of_loader(true, include_parent_loader);
1138 len += strlen(class2_description);
1139
1140 len += strlen(" and ");
1141
1142 char* joint_description = NEW_RESOURCE_ARRAY_RETURN_NULL(char, len);
1143
1144 // Just return the FQN if error when allocating string
1145 if (joint_description == nullptr) {
1146 return class1_name;
1147 }
1148
1149 jio_snprintf(joint_description, len, "%s and %s",
1150 class1_name,
1151 class2_description);
1152
1153 return joint_description;
1154 }
1155
1156 // Caller needs ResourceMark
1157 // class_in_module_of_loader provides a standard way to include
1158 // relevant information about a class, such as its module name as
1159 // well as its class loader's name_and_id, in error messages and logging.
1160 // Format:
1161 // <fully-qualified-external-class-name> is in module <module-name>[@<version>]
1162 // of loader <loader-name_and_id>[, parent loader <parent-loader-name_and_id>]
1163 const char* Klass::class_in_module_of_loader(bool use_are, bool include_parent_loader) const {
1164 // 1. fully qualified external name of class
1165 const char* klass_name = external_name();
1166 size_t len = strlen(klass_name) + 1;
1167
1168 // 2. module name + @version
1169 const char* module_name = "";
1170 const char* version = "";
1171 bool has_version = false;
1172 bool module_is_named = false;
1173 const char* module_name_phrase = "";
1174 const Klass* bottom_klass = is_objArray_klass() ?
1175 ObjArrayKlass::cast(this)->bottom_klass() : this;
1176 if (bottom_klass->is_instance_klass()) {
1177 ModuleEntry* module = InstanceKlass::cast(bottom_klass)->module();
1178 if (module->is_named()) {
1179 module_is_named = true;
1180 module_name_phrase = "module ";
1181 module_name = module->name()->as_C_string();
1182 len += strlen(module_name);
1183 // Use version if exists and is not a jdk module
1184 if (module->should_show_version()) {
1185 has_version = true;
1186 version = module->version()->as_C_string();
1187 // Include stlen(version) + 1 for the "@"
1188 len += strlen(version) + 1;
1189 }
1190 } else {
1191 module_name = UNNAMED_MODULE;
1192 len += UNNAMED_MODULE_LEN;
1193 }
1194 } else {
1195 // klass is an array of primitives, module is java.base
1196 module_is_named = true;
1197 module_name_phrase = "module ";
1198 module_name = JAVA_BASE_NAME;
1199 len += JAVA_BASE_NAME_LEN;
1200 }
1201
1202 // 3. class loader's name_and_id
1203 ClassLoaderData* cld = class_loader_data();
1204 assert(cld != nullptr, "class_loader_data should not be null");
1205 const char* loader_name_and_id = cld->loader_name_and_id();
1206 len += strlen(loader_name_and_id);
1207
1208 // 4. include parent loader information
1209 const char* parent_loader_phrase = "";
1210 const char* parent_loader_name_and_id = "";
1211 if (include_parent_loader &&
1212 !cld->is_builtin_class_loader_data()) {
1213 oop parent_loader = java_lang_ClassLoader::parent(class_loader());
1214 ClassLoaderData *parent_cld = ClassLoaderData::class_loader_data_or_null(parent_loader);
1215 // The parent loader's ClassLoaderData could be null if it is
1216 // a delegating class loader that has never defined a class.
1217 // In this case the loader's name must be obtained via the parent loader's oop.
1218 if (parent_cld == nullptr) {
1219 oop cl_name_and_id = java_lang_ClassLoader::nameAndId(parent_loader);
1220 if (cl_name_and_id != nullptr) {
1221 parent_loader_name_and_id = java_lang_String::as_utf8_string(cl_name_and_id);
1222 }
1223 } else {
1224 parent_loader_name_and_id = parent_cld->loader_name_and_id();
1225 }
1226 parent_loader_phrase = ", parent loader ";
1227 len += strlen(parent_loader_phrase) + strlen(parent_loader_name_and_id);
1228 }
1229
1230 // Start to construct final full class description string
1231 len += ((use_are) ? strlen(" are in ") : strlen(" is in "));
1232 len += strlen(module_name_phrase) + strlen(" of loader ");
1233
1234 char* class_description = NEW_RESOURCE_ARRAY_RETURN_NULL(char, len);
1235
1236 // Just return the FQN if error when allocating string
1237 if (class_description == nullptr) {
1238 return klass_name;
1239 }
1240
1241 jio_snprintf(class_description, len, "%s %s in %s%s%s%s of loader %s%s%s",
1242 klass_name,
1243 (use_are) ? "are" : "is",
1244 module_name_phrase,
1245 module_name,
1246 (has_version) ? "@" : "",
1247 (has_version) ? version : "",
1248 loader_name_and_id,
1249 parent_loader_phrase,
1250 parent_loader_name_and_id);
1251
1252 return class_description;
1253 }
1254
1255 class LookupStats : StackObj {
1256 private:
1257 uint _no_of_samples;
1258 uint _worst;
1259 uint _worst_count;
1260 uint _average;
1261 uint _best;
1262 uint _best_count;
1263 public:
1264 LookupStats() : _no_of_samples(0), _worst(0), _worst_count(0), _average(0), _best(INT_MAX), _best_count(0) {}
1265
1266 ~LookupStats() {
1267 assert(_best <= _worst || _no_of_samples == 0, "sanity");
1268 }
1269
1270 void sample(uint value) {
1271 ++_no_of_samples;
1272 _average += value;
1273
1274 if (_worst < value) {
1275 _worst = value;
1276 _worst_count = 1;
1277 } else if (_worst == value) {
1278 ++_worst_count;
1279 }
1280
1281 if (_best > value) {
1282 _best = value;
1283 _best_count = 1;
1284 } else if (_best == value) {
1285 ++_best_count;
1286 }
1287 }
1288
1289 void print_on(outputStream* st) const {
1290 st->print("best: %2d (%4.1f%%)", _best, (100.0 * _best_count) / _no_of_samples);
1291 if (_best_count < _no_of_samples) {
1292 st->print("; average: %4.1f; worst: %2d (%4.1f%%)",
1293 (1.0 * _average) / _no_of_samples,
1294 _worst, (100.0 * _worst_count) / _no_of_samples);
1295 }
1296 }
1297 };
1298
1299 static void print_positive_lookup_stats(Array<Klass*>* secondary_supers, uintx bitmap, outputStream* st) {
1300 int num_of_supers = secondary_supers->length();
1301
1302 LookupStats s;
1303 for (int i = 0; i < num_of_supers; i++) {
1304 Klass* secondary_super = secondary_supers->at(i);
1305 int home_slot = Klass::compute_home_slot(secondary_super, bitmap);
1306 uint score = 1 + ((i - home_slot) & Klass::SECONDARY_SUPERS_TABLE_MASK);
1307 s.sample(score);
1308 }
1309 st->print("positive_lookup: "); s.print_on(st);
1310 }
1311
1312 static uint compute_distance_to_nearest_zero(int slot, uintx bitmap) {
1313 assert(~bitmap != 0, "no zeroes");
1314 uintx start = rotate_right(bitmap, slot);
1315 return count_trailing_zeros(~start);
1316 }
1317
1318 static void print_negative_lookup_stats(uintx bitmap, outputStream* st) {
1319 LookupStats s;
1320 for (int slot = 0; slot < Klass::SECONDARY_SUPERS_TABLE_SIZE; slot++) {
1321 uint score = compute_distance_to_nearest_zero(slot, bitmap);
1322 s.sample(score);
1323 }
1324 st->print("negative_lookup: "); s.print_on(st);
1325 }
1326
1327 void Klass::print_secondary_supers_on(outputStream* st) const {
1328 if (secondary_supers() != nullptr) {
1329 st->print(" - "); st->print("%d elements;", _secondary_supers->length());
1330 st->print_cr(" bitmap: " UINTX_FORMAT_X_0, _secondary_supers_bitmap);
1331 if (_secondary_supers_bitmap != SECONDARY_SUPERS_BITMAP_EMPTY &&
1332 _secondary_supers_bitmap != SECONDARY_SUPERS_BITMAP_FULL) {
1333 st->print(" - "); print_positive_lookup_stats(secondary_supers(),
1334 _secondary_supers_bitmap, st); st->cr();
1335 st->print(" - "); print_negative_lookup_stats(_secondary_supers_bitmap, st); st->cr();
1336 }
1337 } else {
1338 st->print("null");
1339 }
1340 }
1341
1342 void Klass::on_secondary_supers_verification_failure(Klass* super, Klass* sub, bool linear_result, bool table_result, const char* msg) {
1343 ResourceMark rm;
1344 super->print();
1345 sub->print();
1346 fatal("%s: %s implements %s: linear_search: %d; table_lookup: %d",
1347 msg, sub->external_name(), super->external_name(), linear_result, table_result);
1348 }