1 /*
  2  * Copyright (c) 1997, 2022, 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 "precompiled.hpp"
 26 #include "jvm_io.h"
 27 #include "cds/archiveHeapLoader.hpp"
 28 #include "cds/heapShared.hpp"
 29 #include "classfile/classLoaderData.inline.hpp"
 30 #include "classfile/classLoaderDataGraph.inline.hpp"
 31 #include "classfile/javaClasses.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 "logging/log.hpp"
 39 #include "memory/metadataFactory.hpp"
 40 #include "memory/metaspaceClosure.hpp"
 41 #include "memory/oopFactory.hpp"
 42 #include "memory/resourceArea.hpp"
 43 #include "memory/universe.hpp"
 44 #include "oops/compressedOops.inline.hpp"
 45 #include "oops/instanceKlass.hpp"
 46 #include "oops/klass.inline.hpp"
 47 #include "oops/objArrayKlass.hpp"
 48 #include "oops/oop.inline.hpp"
 49 #include "oops/oopHandle.inline.hpp"
 50 #include "prims/jvmtiExport.hpp"
 51 #include "runtime/arguments.hpp"
 52 #include "runtime/atomic.hpp"
 53 #include "runtime/handles.inline.hpp"
 54 #include "utilities/macros.hpp"
 55 #include "utilities/powerOfTwo.hpp"
 56 #include "utilities/stack.inline.hpp"
 57 
 58 void Klass::set_java_mirror(Handle m) {
 59   assert(!m.is_null(), "New mirror should never be null.");
 60   assert(_java_mirror.is_empty(), "should only be used to initialize mirror");
 61   _java_mirror = class_loader_data()->add_handle(m);
 62 }
 63 
 64 oop Klass::java_mirror_no_keepalive() const {
 65   return _java_mirror.peek();
 66 }
 67 
 68 void Klass::replace_java_mirror(oop mirror) {
 69   _java_mirror.replace(mirror);
 70 }
 71 
 72 bool Klass::is_cloneable() const {
 73   return _access_flags.is_cloneable_fast() ||
 74          is_subtype_of(vmClasses::Cloneable_klass());
 75 }
 76 
 77 void Klass::set_is_cloneable() {
 78   if (name() == vmSymbols::java_lang_invoke_MemberName()) {
 79     assert(is_final(), "no subclasses allowed");
 80     // MemberName cloning should not be intrinsified and always happen in JVM_Clone.
 81   } else if (is_instance_klass() && InstanceKlass::cast(this)->reference_type() != REF_NONE) {
 82     // Reference cloning should not be intrinsified and always happen in JVM_Clone.
 83   } else {
 84     _access_flags.set_is_cloneable_fast();
 85   }
 86 }
 87 
 88 void Klass::set_name(Symbol* n) {
 89   _name = n;
 90   if (_name != NULL) _name->increment_refcount();
 91 
 92   if (Arguments::is_dumping_archive() && is_instance_klass()) {
 93     SystemDictionaryShared::init_dumptime_info(InstanceKlass::cast(this));
 94   }
 95 }
 96 
 97 bool Klass::is_subclass_of(const Klass* k) const {
 98   // Run up the super chain and check
 99   if (this == k) return true;
100 
101   Klass* t = const_cast<Klass*>(this)->super();
102 
103   while (t != NULL) {
104     if (t == k) return true;
105     t = t->super();
106   }
107   return false;
108 }
109 
110 void Klass::release_C_heap_structures(bool release_constant_pool) {
111   if (_name != NULL) _name->decrement_refcount();
112 }
113 
114 bool Klass::search_secondary_supers(Klass* k) const {
115   // Put some extra logic here out-of-line, before the search proper.
116   // This cuts down the size of the inline method.
117 
118   // This is necessary, since I am never in my own secondary_super list.
119   if (this == k)
120     return true;
121   // Scan the array-of-objects for a match
122   int cnt = secondary_supers()->length();
123   for (int i = 0; i < cnt; i++) {
124     if (secondary_supers()->at(i) == k) {
125       ((Klass*)this)->set_secondary_super_cache(k);
126       return true;
127     }
128   }
129   return false;
130 }
131 
132 // Return self, except for abstract classes with exactly 1
133 // implementor.  Then return the 1 concrete implementation.
134 Klass *Klass::up_cast_abstract() {
135   Klass *r = this;
136   while( r->is_abstract() ) {   // Receiver is abstract?
137     Klass *s = r->subklass();   // Check for exactly 1 subklass
138     if (s == NULL || s->next_sibling() != NULL) // Oops; wrong count; give up
139       return this;              // Return 'this' as a no-progress flag
140     r = s;                    // Loop till find concrete class
141   }
142   return r;                   // Return the 1 concrete class
143 }
144 
145 // Find LCA in class hierarchy
146 Klass *Klass::LCA( Klass *k2 ) {
147   Klass *k1 = this;
148   while( 1 ) {
149     if( k1->is_subtype_of(k2) ) return k2;
150     if( k2->is_subtype_of(k1) ) return k1;
151     k1 = k1->super();
152     k2 = k2->super();
153   }
154 }
155 
156 
157 void Klass::check_valid_for_instantiation(bool throwError, TRAPS) {
158   ResourceMark rm(THREAD);
159   THROW_MSG(throwError ? vmSymbols::java_lang_InstantiationError()
160             : vmSymbols::java_lang_InstantiationException(), external_name());
161 }
162 
163 
164 void Klass::copy_array(arrayOop s, int src_pos, arrayOop d, int dst_pos, int length, TRAPS) {
165   ResourceMark rm(THREAD);
166   assert(s != NULL, "Throw NPE!");
167   THROW_MSG(vmSymbols::java_lang_ArrayStoreException(),
168             err_msg("arraycopy: source type %s is not an array", s->klass()->external_name()));
169 }
170 
171 
172 void Klass::initialize(TRAPS) {
173   ShouldNotReachHere();
174 }
175 
176 Klass* Klass::find_field(Symbol* name, Symbol* sig, fieldDescriptor* fd) const {
177 #ifdef ASSERT
178   tty->print_cr("Error: find_field called on a klass oop."
179                 " Likely error: reflection method does not correctly"
180                 " wrap return value in a mirror object.");
181 #endif
182   ShouldNotReachHere();
183   return NULL;
184 }
185 
186 Method* Klass::uncached_lookup_method(const Symbol* name, const Symbol* signature,
187                                       OverpassLookupMode overpass_mode,
188                                       PrivateLookupMode private_mode) const {
189 #ifdef ASSERT
190   tty->print_cr("Error: uncached_lookup_method called on a klass oop."
191                 " Likely error: reflection method does not correctly"
192                 " wrap return value in a mirror object.");
193 #endif
194   ShouldNotReachHere();
195   return NULL;
196 }
197 
198 void* Klass::operator new(size_t size, ClassLoaderData* loader_data, size_t word_size, TRAPS) throw() {
199   return Metaspace::allocate(loader_data, word_size, MetaspaceObj::ClassType, THREAD);
200 }
201 
202 // "Normal" instantiation is preceded by a MetaspaceObj allocation
203 // which zeros out memory - calloc equivalent.
204 // The constructor is also used from CppVtableCloner,
205 // which doesn't zero out the memory before calling the constructor.
206 Klass::Klass(KlassKind kind) : _kind(kind),
207                                _prototype_header(markWord::prototype()),
208                                _shared_class_path_index(-1) {
209   CDS_ONLY(_shared_class_flags = 0;)
210   CDS_JAVA_HEAP_ONLY(_archived_mirror_index = -1;)
211   _primary_supers[0] = this;
212   set_super_check_offset(in_bytes(primary_supers_offset()));
213 }
214 
215 jint Klass::array_layout_helper(BasicType etype) {
216   assert(etype >= T_BOOLEAN && etype <= T_OBJECT, "valid etype");
217   // Note that T_ARRAY is not allowed here.
218   int  hsize = arrayOopDesc::base_offset_in_bytes(etype);
219   int  esize = type2aelembytes(etype);
220   bool isobj = (etype == T_OBJECT);
221   int  tag   =  isobj ? _lh_array_tag_obj_value : _lh_array_tag_type_value;
222   int lh = array_layout_helper(tag, false, hsize, etype, exact_log2(esize));
223 
224   assert(lh < (int)_lh_neutral_value, "must look like an array layout");
225   assert(layout_helper_is_array(lh), "correct kind");
226   assert(layout_helper_is_objArray(lh) == isobj, "correct kind");
227   assert(layout_helper_is_typeArray(lh) == !isobj, "correct kind");
228   assert(layout_helper_header_size(lh) == hsize, "correct decode");
229   assert(layout_helper_element_type(lh) == etype, "correct decode");
230   assert(1 << layout_helper_log2_element_size(lh) == esize, "correct decode");
231 
232   return lh;
233 }
234 
235 bool Klass::can_be_primary_super_slow() const {
236   if (super() == NULL)
237     return true;
238   else if (super()->super_depth() >= primary_super_limit()-1)
239     return false;
240   else
241     return true;
242 }
243 
244 void Klass::initialize_supers(Klass* k, Array<InstanceKlass*>* transitive_interfaces, TRAPS) {
245   if (k == NULL) {
246     set_super(NULL);
247     _primary_supers[0] = this;
248     assert(super_depth() == 0, "Object must already be initialized properly");
249   } else if (k != super() || k == vmClasses::Object_klass()) {
250     assert(super() == NULL || super() == vmClasses::Object_klass(),
251            "initialize this only once to a non-trivial value");
252     set_super(k);
253     Klass* sup = k;
254     int sup_depth = sup->super_depth();
255     juint my_depth  = MIN2(sup_depth + 1, (int)primary_super_limit());
256     if (!can_be_primary_super_slow())
257       my_depth = primary_super_limit();
258     for (juint i = 0; i < my_depth; i++) {
259       _primary_supers[i] = sup->_primary_supers[i];
260     }
261     Klass* *super_check_cell;
262     if (my_depth < primary_super_limit()) {
263       _primary_supers[my_depth] = this;
264       super_check_cell = &_primary_supers[my_depth];
265     } else {
266       // Overflow of the primary_supers array forces me to be secondary.
267       super_check_cell = &_secondary_super_cache;
268     }
269     set_super_check_offset((address)super_check_cell - (address) this);
270 
271 #ifdef ASSERT
272     {
273       juint j = super_depth();
274       assert(j == my_depth, "computed accessor gets right answer");
275       Klass* t = this;
276       while (!t->can_be_primary_super()) {
277         t = t->super();
278         j = t->super_depth();
279       }
280       for (juint j1 = j+1; j1 < primary_super_limit(); j1++) {
281         assert(primary_super_of_depth(j1) == NULL, "super list padding");
282       }
283       while (t != NULL) {
284         assert(primary_super_of_depth(j) == t, "super list initialization");
285         t = t->super();
286         --j;
287       }
288       assert(j == (juint)-1, "correct depth count");
289     }
290 #endif
291   }
292 
293   if (secondary_supers() == NULL) {
294 
295     // Now compute the list of secondary supertypes.
296     // Secondaries can occasionally be on the super chain,
297     // if the inline "_primary_supers" array overflows.
298     int extras = 0;
299     Klass* p;
300     for (p = super(); !(p == NULL || p->can_be_primary_super()); p = p->super()) {
301       ++extras;
302     }
303 
304     ResourceMark rm(THREAD);  // need to reclaim GrowableArrays allocated below
305 
306     // Compute the "real" non-extra secondaries.
307     GrowableArray<Klass*>* secondaries = compute_secondary_supers(extras, transitive_interfaces);
308     if (secondaries == NULL) {
309       // secondary_supers set by compute_secondary_supers
310       return;
311     }
312 
313     GrowableArray<Klass*>* primaries = new GrowableArray<Klass*>(extras);
314 
315     for (p = super(); !(p == NULL || p->can_be_primary_super()); p = p->super()) {
316       int i;                    // Scan for overflow primaries being duplicates of 2nd'arys
317 
318       // This happens frequently for very deeply nested arrays: the
319       // primary superclass chain overflows into the secondary.  The
320       // secondary list contains the element_klass's secondaries with
321       // an extra array dimension added.  If the element_klass's
322       // secondary list already contains some primary overflows, they
323       // (with the extra level of array-ness) will collide with the
324       // normal primary superclass overflows.
325       for( i = 0; i < secondaries->length(); i++ ) {
326         if( secondaries->at(i) == p )
327           break;
328       }
329       if( i < secondaries->length() )
330         continue;               // It's a dup, don't put it in
331       primaries->push(p);
332     }
333     // Combine the two arrays into a metadata object to pack the array.
334     // The primaries are added in the reverse order, then the secondaries.
335     int new_length = primaries->length() + secondaries->length();
336     Array<Klass*>* s2 = MetadataFactory::new_array<Klass*>(
337                                        class_loader_data(), new_length, CHECK);
338     int fill_p = primaries->length();
339     for (int j = 0; j < fill_p; j++) {
340       s2->at_put(j, primaries->pop());  // add primaries in reverse order.
341     }
342     for( int j = 0; j < secondaries->length(); j++ ) {
343       s2->at_put(j+fill_p, secondaries->at(j));  // add secondaries on the end.
344     }
345 
346   #ifdef ASSERT
347       // We must not copy any NULL placeholders left over from bootstrap.
348     for (int j = 0; j < s2->length(); j++) {
349       assert(s2->at(j) != NULL, "correct bootstrapping order");
350     }
351   #endif
352 
353     set_secondary_supers(s2);
354   }
355 }
356 
357 GrowableArray<Klass*>* Klass::compute_secondary_supers(int num_extra_slots,
358                                                        Array<InstanceKlass*>* transitive_interfaces) {
359   assert(num_extra_slots == 0, "override for complex klasses");
360   assert(transitive_interfaces == NULL, "sanity");
361   set_secondary_supers(Universe::the_empty_klass_array());
362   return NULL;
363 }
364 
365 
366 // superklass links
367 InstanceKlass* Klass::superklass() const {
368   assert(super() == NULL || super()->is_instance_klass(), "must be instance klass");
369   return _super == NULL ? NULL : InstanceKlass::cast(_super);
370 }
371 
372 // subklass links.  Used by the compiler (and vtable initialization)
373 // May be cleaned concurrently, so must use the Compile_lock.
374 // The log parameter is for clean_weak_klass_links to report unlinked classes.
375 Klass* Klass::subklass(bool log) const {
376   // Need load_acquire on the _subklass, because it races with inserts that
377   // publishes freshly initialized data.
378   for (Klass* chain = Atomic::load_acquire(&_subklass);
379        chain != NULL;
380        // Do not need load_acquire on _next_sibling, because inserts never
381        // create _next_sibling edges to dead data.
382        chain = Atomic::load(&chain->_next_sibling))
383   {
384     if (chain->is_loader_alive()) {
385       return chain;
386     } else if (log) {
387       if (log_is_enabled(Trace, class, unload)) {
388         ResourceMark rm;
389         log_trace(class, unload)("unlinking class (subclass): %s", chain->external_name());
390       }
391     }
392   }
393   return NULL;
394 }
395 
396 Klass* Klass::next_sibling(bool log) const {
397   // Do not need load_acquire on _next_sibling, because inserts never
398   // create _next_sibling edges to dead data.
399   for (Klass* chain = Atomic::load(&_next_sibling);
400        chain != NULL;
401        chain = Atomic::load(&chain->_next_sibling)) {
402     // Only return alive klass, there may be stale klass
403     // in this chain if cleaned concurrently.
404     if (chain->is_loader_alive()) {
405       return chain;
406     } else if (log) {
407       if (log_is_enabled(Trace, class, unload)) {
408         ResourceMark rm;
409         log_trace(class, unload)("unlinking class (sibling): %s", chain->external_name());
410       }
411     }
412   }
413   return NULL;
414 }
415 
416 void Klass::set_subklass(Klass* s) {
417   assert(s != this, "sanity check");
418   Atomic::release_store(&_subklass, s);
419 }
420 
421 void Klass::set_next_sibling(Klass* s) {
422   assert(s != this, "sanity check");
423   // Does not need release semantics. If used by cleanup, it will link to
424   // already safely published data, and if used by inserts, will be published
425   // safely using cmpxchg.
426   Atomic::store(&_next_sibling, s);
427 }
428 
429 void Klass::append_to_sibling_list() {
430   if (Universe::is_fully_initialized()) {
431     assert_locked_or_safepoint(Compile_lock);
432   }
433   debug_only(verify();)
434   // add ourselves to superklass' subklass list
435   InstanceKlass* super = superklass();
436   if (super == NULL) return;        // special case: class Object
437   assert((!super->is_interface()    // interfaces cannot be supers
438           && (super->superklass() == NULL || !is_interface())),
439          "an interface can only be a subklass of Object");
440 
441   // Make sure there is no stale subklass head
442   super->clean_subklass();
443 
444   for (;;) {
445     Klass* prev_first_subklass = Atomic::load_acquire(&_super->_subklass);
446     if (prev_first_subklass != NULL) {
447       // set our sibling to be the superklass' previous first subklass
448       assert(prev_first_subklass->is_loader_alive(), "May not attach not alive klasses");
449       set_next_sibling(prev_first_subklass);
450     }
451     // Note that the prev_first_subklass is always alive, meaning no sibling_next links
452     // are ever created to not alive klasses. This is an important invariant of the lock-free
453     // cleaning protocol, that allows us to safely unlink dead klasses from the sibling list.
454     if (Atomic::cmpxchg(&super->_subklass, prev_first_subklass, this) == prev_first_subklass) {
455       return;
456     }
457   }
458   debug_only(verify();)
459 }
460 
461 void Klass::clean_subklass() {
462   for (;;) {
463     // Need load_acquire, due to contending with concurrent inserts
464     Klass* subklass = Atomic::load_acquire(&_subklass);
465     if (subklass == NULL || subklass->is_loader_alive()) {
466       return;
467     }
468     // Try to fix _subklass until it points at something not dead.
469     Atomic::cmpxchg(&_subklass, subklass, subklass->next_sibling());
470   }
471 }
472 
473 void Klass::clean_weak_klass_links(bool unloading_occurred, bool clean_alive_klasses) {
474   if (!ClassUnloading || !unloading_occurred) {
475     return;
476   }
477 
478   Klass* root = vmClasses::Object_klass();
479   Stack<Klass*, mtGC> stack;
480 
481   stack.push(root);
482   while (!stack.is_empty()) {
483     Klass* current = stack.pop();
484 
485     assert(current->is_loader_alive(), "just checking, this should be live");
486 
487     // Find and set the first alive subklass
488     Klass* sub = current->subklass(true);
489     current->clean_subklass();
490     if (sub != NULL) {
491       stack.push(sub);
492     }
493 
494     // Find and set the first alive sibling
495     Klass* sibling = current->next_sibling(true);
496     current->set_next_sibling(sibling);
497     if (sibling != NULL) {
498       stack.push(sibling);
499     }
500 
501     // Clean the implementors list and method data.
502     if (clean_alive_klasses && current->is_instance_klass()) {
503       InstanceKlass* ik = InstanceKlass::cast(current);
504       ik->clean_weak_instanceklass_links();
505 
506       // JVMTI RedefineClasses creates previous versions that are not in
507       // the class hierarchy, so process them here.
508       while ((ik = ik->previous_versions()) != NULL) {
509         ik->clean_weak_instanceklass_links();
510       }
511     }
512   }
513 }
514 
515 void Klass::metaspace_pointers_do(MetaspaceClosure* it) {
516   if (log_is_enabled(Trace, cds)) {
517     ResourceMark rm;
518     log_trace(cds)("Iter(Klass): %p (%s)", this, external_name());
519   }
520 
521   it->push(&_name);
522   it->push(&_secondary_super_cache);
523   it->push(&_secondary_supers);
524   for (int i = 0; i < _primary_super_limit; i++) {
525     it->push(&_primary_supers[i]);
526   }
527   it->push(&_super);
528   if (!Arguments::is_dumping_archive()) {
529     // If dumping archive, these may point to excluded classes. There's no need
530     // to follow these pointers anyway, as they will be set to NULL in
531     // remove_unshareable_info().
532     it->push((Klass**)&_subklass);
533     it->push((Klass**)&_next_sibling);
534     it->push(&_next_link);
535   }
536 
537   vtableEntry* vt = start_of_vtable();
538   for (int i=0; i<vtable_length(); i++) {
539     it->push(vt[i].method_addr());
540   }
541 }
542 
543 #if INCLUDE_CDS
544 void Klass::remove_unshareable_info() {
545   assert (Arguments::is_dumping_archive(),
546           "only called during CDS dump time");
547   JFR_ONLY(REMOVE_ID(this);)
548   if (log_is_enabled(Trace, cds, unshareable)) {
549     ResourceMark rm;
550     log_trace(cds, unshareable)("remove: %s", external_name());
551   }
552 
553   set_subklass(NULL);
554   set_next_sibling(NULL);
555   set_next_link(NULL);
556 
557   // Null out class_loader_data because we don't share that yet.
558   set_class_loader_data(NULL);
559   set_is_shared();
560 }
561 
562 void Klass::remove_java_mirror() {
563   Arguments::assert_is_dumping_archive();
564   if (log_is_enabled(Trace, cds, unshareable)) {
565     ResourceMark rm;
566     log_trace(cds, unshareable)("remove java_mirror: %s", external_name());
567   }
568   // Just null out the mirror.  The class_loader_data() no longer exists.
569   clear_java_mirror_handle();
570 }
571 
572 void Klass::restore_unshareable_info(ClassLoaderData* loader_data, Handle protection_domain, TRAPS) {
573   assert(is_klass(), "ensure C++ vtable is restored");
574   assert(is_shared(), "must be set");
575   JFR_ONLY(RESTORE_ID(this);)
576   if (log_is_enabled(Trace, cds, unshareable)) {
577     ResourceMark rm(THREAD);
578     log_trace(cds, unshareable)("restore: %s", external_name());
579   }
580 
581   // If an exception happened during CDS restore, some of these fields may already be
582   // set.  We leave the class on the CLD list, even if incomplete so that we don't
583   // modify the CLD list outside a safepoint.
584   if (class_loader_data() == NULL) {
585     set_class_loader_data(loader_data);
586 
587     // Add to class loader list first before creating the mirror
588     // (same order as class file parsing)
589     loader_data->add_class(this);
590   }
591 
592   Handle loader(THREAD, loader_data->class_loader());
593   ModuleEntry* module_entry = NULL;
594   Klass* k = this;
595   if (k->is_objArray_klass()) {
596     k = ObjArrayKlass::cast(k)->bottom_klass();
597   }
598   // Obtain klass' module.
599   if (k->is_instance_klass()) {
600     InstanceKlass* ik = (InstanceKlass*) k;
601     module_entry = ik->module();
602   } else {
603     module_entry = ModuleEntryTable::javabase_moduleEntry();
604   }
605   // Obtain java.lang.Module, if available
606   Handle module_handle(THREAD, ((module_entry != NULL) ? module_entry->module() : (oop)NULL));
607 
608   if (this->has_archived_mirror_index()) {
609     ResourceMark rm(THREAD);
610     log_debug(cds, mirror)("%s has raw archived mirror", external_name());
611     if (ArchiveHeapLoader::are_archived_mirrors_available()) {
612       bool present = java_lang_Class::restore_archived_mirror(this, loader, module_handle,
613                                                               protection_domain,
614                                                               CHECK);
615       if (present) {
616         return;
617       }
618     }
619 
620     // No archived mirror data
621     log_debug(cds, mirror)("No archived mirror data for %s", external_name());
622     clear_java_mirror_handle();
623     this->clear_archived_mirror_index();
624   }
625 
626   // Only recreate it if not present.  A previous attempt to restore may have
627   // gotten an OOM later but keep the mirror if it was created.
628   if (java_mirror() == NULL) {
629     ResourceMark rm(THREAD);
630     log_trace(cds, mirror)("Recreate mirror for %s", external_name());
631     java_lang_Class::create_mirror(this, loader, module_handle, protection_domain, Handle(), CHECK);
632   }
633 }
634 #endif // INCLUDE_CDS
635 
636 #if INCLUDE_CDS_JAVA_HEAP
637 oop Klass::archived_java_mirror() {
638   assert(has_archived_mirror_index(), "must have archived mirror");
639   return HeapShared::get_root(_archived_mirror_index);
640 }
641 
642 void Klass::clear_archived_mirror_index() {
643   if (_archived_mirror_index >= 0) {
644     HeapShared::clear_root(_archived_mirror_index);
645   }
646   _archived_mirror_index = -1;
647 }
648 
649 // No GC barrier
650 void Klass::set_archived_java_mirror(oop m) {
651   assert(DumpSharedSpaces, "called only during runtime");
652   _archived_mirror_index = HeapShared::append_root(m);
653 }
654 #endif // INCLUDE_CDS_JAVA_HEAP
655 
656 void Klass::check_array_allocation_length(int length, int max_length, TRAPS) {
657   if (length > max_length) {
658     if (!THREAD->in_retryable_allocation()) {
659       report_java_out_of_memory("Requested array size exceeds VM limit");
660       JvmtiExport::post_array_size_exhausted();
661       THROW_OOP(Universe::out_of_memory_error_array_size());
662     } else {
663       THROW_OOP(Universe::out_of_memory_error_retry());
664     }
665   } else if (length < 0) {
666     THROW_MSG(vmSymbols::java_lang_NegativeArraySizeException(), err_msg("%d", length));
667   }
668 }
669 
670 // Replace the last '+' char with '/'.
671 static char* convert_hidden_name_to_java(Symbol* name) {
672   size_t name_len = name->utf8_length();
673   char* result = NEW_RESOURCE_ARRAY(char, name_len + 1);
674   name->as_klass_external_name(result, (int)name_len + 1);
675   for (int index = (int)name_len; index > 0; index--) {
676     if (result[index] == '+') {
677       result[index] = JVM_SIGNATURE_SLASH;
678       break;
679     }
680   }
681   return result;
682 }
683 
684 // In product mode, this function doesn't have virtual function calls so
685 // there might be some performance advantage to handling InstanceKlass here.
686 const char* Klass::external_name() const {
687   if (is_instance_klass()) {
688     const InstanceKlass* ik = static_cast<const InstanceKlass*>(this);
689     if (ik->is_hidden()) {
690       char* result = convert_hidden_name_to_java(name());
691       return result;
692     }
693   } else if (is_objArray_klass() && ObjArrayKlass::cast(this)->bottom_klass()->is_hidden()) {
694     char* result = convert_hidden_name_to_java(name());
695     return result;
696   }
697   if (name() == NULL)  return "<unknown>";
698   return name()->as_klass_external_name();
699 }
700 
701 const char* Klass::signature_name() const {
702   if (name() == NULL)  return "<unknown>";
703   if (is_objArray_klass() && ObjArrayKlass::cast(this)->bottom_klass()->is_hidden()) {
704     size_t name_len = name()->utf8_length();
705     char* result = NEW_RESOURCE_ARRAY(char, name_len + 1);
706     name()->as_C_string(result, (int)name_len + 1);
707     for (int index = (int)name_len; index > 0; index--) {
708       if (result[index] == '+') {
709         result[index] = JVM_SIGNATURE_DOT;
710         break;
711       }
712     }
713     return result;
714   }
715   return name()->as_C_string();
716 }
717 
718 const char* Klass::external_kind() const {
719   if (is_interface()) return "interface";
720   if (is_abstract()) return "abstract class";
721   return "class";
722 }
723 
724 // Unless overridden, jvmti_class_status has no flags set.
725 jint Klass::jvmti_class_status() const {
726   return 0;
727 }
728 
729 
730 // Printing
731 
732 void Klass::print_on(outputStream* st) const {
733   ResourceMark rm;
734   // print title
735   st->print("%s", internal_name());
736   print_address_on(st);
737   st->cr();
738 }
739 
740 #define BULLET  " - "
741 
742 // Caller needs ResourceMark
743 void Klass::oop_print_on(oop obj, outputStream* st) {
744   // print title
745   st->print_cr("%s ", internal_name());
746   obj->print_address_on(st);
747 
748   if (WizardMode) {
749      // print header
750      obj->mark().print_on(st);
751      st->cr();
752      st->print(BULLET"prototype_header: " INTPTR_FORMAT, _prototype_header.value());
753      st->cr();
754   }
755 
756   // print class
757   st->print(BULLET"klass: ");
758   obj->klass()->print_value_on(st);
759   st->cr();
760 }
761 
762 void Klass::oop_print_value_on(oop obj, outputStream* st) {
763   // print title
764   ResourceMark rm;              // Cannot print in debug mode without this
765   st->print("%s", internal_name());
766   obj->print_address_on(st);
767 }
768 
769 // Verification
770 
771 void Klass::verify_on(outputStream* st) {
772 
773   // This can be expensive, but it is worth checking that this klass is actually
774   // in the CLD graph but not in production.
775   assert(Metaspace::contains((address)this), "Should be");
776 
777   guarantee(this->is_klass(),"should be klass");
778 
779   if (super() != NULL) {
780     guarantee(super()->is_klass(), "should be klass");
781   }
782   if (secondary_super_cache() != NULL) {
783     Klass* ko = secondary_super_cache();
784     guarantee(ko->is_klass(), "should be klass");
785   }
786   for ( uint i = 0; i < primary_super_limit(); i++ ) {
787     Klass* ko = _primary_supers[i];
788     if (ko != NULL) {
789       guarantee(ko->is_klass(), "should be klass");
790     }
791   }
792 
793   if (java_mirror_no_keepalive() != NULL) {
794     guarantee(oopDesc::is_oop(java_mirror_no_keepalive()), "should be instance");
795   }
796 }
797 
798 void Klass::oop_verify_on(oop obj, outputStream* st) {
799   guarantee(oopDesc::is_oop(obj),  "should be oop");
800   guarantee(obj->klass()->is_klass(), "klass field is not a klass");
801 }
802 
803 bool Klass::is_valid(Klass* k) {
804   if (!is_aligned(k, sizeof(MetaWord))) return false;
805   if ((size_t)k < os::min_page_size()) return false;
806 
807   if (!os::is_readable_range(k, k + 1)) return false;
808   if (!Metaspace::contains(k)) return false;
809 
810   if (!Symbol::is_valid(k->name())) return false;
811   return ClassLoaderDataGraph::is_valid(k->class_loader_data());
812 }
813 
814 Method* Klass::method_at_vtable(int index)  {
815 #ifndef PRODUCT
816   assert(index >= 0, "valid vtable index");
817   if (DebugVtables) {
818     verify_vtable_index(index);
819   }
820 #endif
821   return start_of_vtable()[index].method();
822 }
823 
824 
825 #ifndef PRODUCT
826 
827 bool Klass::verify_vtable_index(int i) {
828   int limit = vtable_length()/vtableEntry::size();
829   assert(i >= 0 && i < limit, "index %d out of bounds %d", i, limit);
830   return true;
831 }
832 
833 #endif // PRODUCT
834 
835 // Caller needs ResourceMark
836 // joint_in_module_of_loader provides an optimization if 2 classes are in
837 // the same module to succinctly print out relevant information about their
838 // module name and class loader's name_and_id for error messages.
839 // Format:
840 //   <fully-qualified-external-class-name1> and <fully-qualified-external-class-name2>
841 //                      are in module <module-name>[@<version>]
842 //                      of loader <loader-name_and_id>[, parent loader <parent-loader-name_and_id>]
843 const char* Klass::joint_in_module_of_loader(const Klass* class2, bool include_parent_loader) const {
844   assert(module() == class2->module(), "classes do not have the same module");
845   const char* class1_name = external_name();
846   size_t len = strlen(class1_name) + 1;
847 
848   const char* class2_description = class2->class_in_module_of_loader(true, include_parent_loader);
849   len += strlen(class2_description);
850 
851   len += strlen(" and ");
852 
853   char* joint_description = NEW_RESOURCE_ARRAY_RETURN_NULL(char, len);
854 
855   // Just return the FQN if error when allocating string
856   if (joint_description == NULL) {
857     return class1_name;
858   }
859 
860   jio_snprintf(joint_description, len, "%s and %s",
861                class1_name,
862                class2_description);
863 
864   return joint_description;
865 }
866 
867 // Caller needs ResourceMark
868 // class_in_module_of_loader provides a standard way to include
869 // relevant information about a class, such as its module name as
870 // well as its class loader's name_and_id, in error messages and logging.
871 // Format:
872 //   <fully-qualified-external-class-name> is in module <module-name>[@<version>]
873 //                                         of loader <loader-name_and_id>[, parent loader <parent-loader-name_and_id>]
874 const char* Klass::class_in_module_of_loader(bool use_are, bool include_parent_loader) const {
875   // 1. fully qualified external name of class
876   const char* klass_name = external_name();
877   size_t len = strlen(klass_name) + 1;
878 
879   // 2. module name + @version
880   const char* module_name = "";
881   const char* version = "";
882   bool has_version = false;
883   bool module_is_named = false;
884   const char* module_name_phrase = "";
885   const Klass* bottom_klass = is_objArray_klass() ?
886                                 ObjArrayKlass::cast(this)->bottom_klass() : this;
887   if (bottom_klass->is_instance_klass()) {
888     ModuleEntry* module = InstanceKlass::cast(bottom_klass)->module();
889     if (module->is_named()) {
890       module_is_named = true;
891       module_name_phrase = "module ";
892       module_name = module->name()->as_C_string();
893       len += strlen(module_name);
894       // Use version if exists and is not a jdk module
895       if (module->should_show_version()) {
896         has_version = true;
897         version = module->version()->as_C_string();
898         // Include stlen(version) + 1 for the "@"
899         len += strlen(version) + 1;
900       }
901     } else {
902       module_name = UNNAMED_MODULE;
903       len += UNNAMED_MODULE_LEN;
904     }
905   } else {
906     // klass is an array of primitives, module is java.base
907     module_is_named = true;
908     module_name_phrase = "module ";
909     module_name = JAVA_BASE_NAME;
910     len += JAVA_BASE_NAME_LEN;
911   }
912 
913   // 3. class loader's name_and_id
914   ClassLoaderData* cld = class_loader_data();
915   assert(cld != NULL, "class_loader_data should not be null");
916   const char* loader_name_and_id = cld->loader_name_and_id();
917   len += strlen(loader_name_and_id);
918 
919   // 4. include parent loader information
920   const char* parent_loader_phrase = "";
921   const char* parent_loader_name_and_id = "";
922   if (include_parent_loader &&
923       !cld->is_builtin_class_loader_data()) {
924     oop parent_loader = java_lang_ClassLoader::parent(class_loader());
925     ClassLoaderData *parent_cld = ClassLoaderData::class_loader_data_or_null(parent_loader);
926     // The parent loader's ClassLoaderData could be null if it is
927     // a delegating class loader that has never defined a class.
928     // In this case the loader's name must be obtained via the parent loader's oop.
929     if (parent_cld == NULL) {
930       oop cl_name_and_id = java_lang_ClassLoader::nameAndId(parent_loader);
931       if (cl_name_and_id != NULL) {
932         parent_loader_name_and_id = java_lang_String::as_utf8_string(cl_name_and_id);
933       }
934     } else {
935       parent_loader_name_and_id = parent_cld->loader_name_and_id();
936     }
937     parent_loader_phrase = ", parent loader ";
938     len += strlen(parent_loader_phrase) + strlen(parent_loader_name_and_id);
939   }
940 
941   // Start to construct final full class description string
942   len += ((use_are) ? strlen(" are in ") : strlen(" is in "));
943   len += strlen(module_name_phrase) + strlen(" of loader ");
944 
945   char* class_description = NEW_RESOURCE_ARRAY_RETURN_NULL(char, len);
946 
947   // Just return the FQN if error when allocating string
948   if (class_description == NULL) {
949     return klass_name;
950   }
951 
952   jio_snprintf(class_description, len, "%s %s in %s%s%s%s of loader %s%s%s",
953                klass_name,
954                (use_are) ? "are" : "is",
955                module_name_phrase,
956                module_name,
957                (has_version) ? "@" : "",
958                (has_version) ? version : "",
959                loader_name_and_id,
960                parent_loader_phrase,
961                parent_loader_name_and_id);
962 
963   return class_description;
964 }