1 /* 2 * Copyright (c) 1997, 2018, 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 "classfile/moduleEntry.hpp" 27 #include "classfile/packageEntry.hpp" 28 #include "classfile/symbolTable.hpp" 29 #include "classfile/systemDictionary.hpp" 30 #include "classfile/vmSymbols.hpp" 31 #include "gc/shared/collectedHeap.inline.hpp" 32 #include "gc/shared/specialized_oop_closures.hpp" 33 #include "memory/iterator.inline.hpp" 34 #include "memory/metadataFactory.hpp" 35 #include "memory/metaspaceClosure.hpp" 36 #include "memory/resourceArea.hpp" 37 #include "memory/universe.hpp" 38 #include "oops/arrayKlass.inline.hpp" 39 #include "oops/instanceKlass.hpp" 40 #include "oops/klass.inline.hpp" 41 #include "oops/objArrayKlass.inline.hpp" 42 #include "oops/objArrayOop.inline.hpp" 43 #include "oops/oop.inline.hpp" 44 #include "oops/symbol.hpp" 45 #include "runtime/handles.inline.hpp" 46 #include "runtime/mutexLocker.hpp" 47 #include "utilities/macros.hpp" 48 49 ObjArrayKlass* ObjArrayKlass::allocate(ClassLoaderData* loader_data, int n, Klass* k, Symbol* name, TRAPS) { 50 assert(ObjArrayKlass::header_size() <= InstanceKlass::header_size(), 51 "array klasses must be same size as InstanceKlass"); 52 53 int size = ArrayKlass::static_size(ObjArrayKlass::header_size()); 54 55 return new (loader_data, size, THREAD) ObjArrayKlass(n, k, name); 56 } 57 58 Klass* ObjArrayKlass::allocate_objArray_klass(ClassLoaderData* loader_data, 59 int n, Klass* element_klass, TRAPS) { 60 61 // Eagerly allocate the direct array supertype. 62 Klass* super_klass = NULL; 63 if (!Universe::is_bootstrapping() || SystemDictionary::Object_klass_loaded()) { 64 Klass* element_super = element_klass->super(); 65 if (element_super != NULL) { 66 // The element type has a direct super. E.g., String[] has direct super of Object[]. 67 super_klass = element_super->array_klass_or_null(); 68 bool supers_exist = super_klass != NULL; 69 // Also, see if the element has secondary supertypes. 70 // We need an array type for each. 71 Array<Klass*>* element_supers = element_klass->secondary_supers(); 72 for( int i = element_supers->length()-1; i >= 0; i-- ) { 73 Klass* elem_super = element_supers->at(i); 74 if (elem_super->array_klass_or_null() == NULL) { 75 supers_exist = false; 76 break; 77 } 78 } 79 if (!supers_exist) { 80 // Oops. Not allocated yet. Back out, allocate it, and retry. 81 Klass* ek = NULL; 82 { 83 MutexUnlocker mu(MultiArray_lock); 84 MutexUnlocker mc(Compile_lock); // for vtables 85 super_klass = element_super->array_klass(CHECK_0); 86 for( int i = element_supers->length()-1; i >= 0; i-- ) { 87 Klass* elem_super = element_supers->at(i); 88 elem_super->array_klass(CHECK_0); 89 } 90 // Now retry from the beginning 91 ek = element_klass->array_klass(n, CHECK_0); 92 } // re-lock 93 return ek; 94 } 95 } else { 96 // The element type is already Object. Object[] has direct super of Object. 97 super_klass = SystemDictionary::Object_klass(); 98 } 99 } 100 101 // Create type name for klass. 102 Symbol* name = NULL; 103 if (!element_klass->is_instance_klass() || 104 (name = InstanceKlass::cast(element_klass)->array_name()) == NULL) { 105 106 ResourceMark rm(THREAD); 107 char *name_str = element_klass->name()->as_C_string(); 108 int len = element_klass->name()->utf8_length(); 109 char *new_str = NEW_RESOURCE_ARRAY(char, len + 4); 110 int idx = 0; 111 new_str[idx++] = '['; 112 if (element_klass->is_instance_klass()) { // it could be an array or simple type 113 new_str[idx++] = 'L'; 114 } 115 memcpy(&new_str[idx], name_str, len * sizeof(char)); 116 idx += len; 117 if (element_klass->is_instance_klass()) { 118 new_str[idx++] = ';'; 119 } 120 new_str[idx++] = '\0'; 121 name = SymbolTable::new_permanent_symbol(new_str, CHECK_0); 122 if (element_klass->is_instance_klass()) { 123 InstanceKlass* ik = InstanceKlass::cast(element_klass); 124 ik->set_array_name(name); 125 } 126 } 127 128 // Initialize instance variables 129 ObjArrayKlass* oak = ObjArrayKlass::allocate(loader_data, n, element_klass, name, CHECK_0); 130 131 // Add all classes to our internal class loader list here, 132 // including classes in the bootstrap (NULL) class loader. 133 // GC walks these as strong roots. 134 loader_data->add_class(oak); 135 136 ModuleEntry* module = oak->module(); 137 assert(module != NULL, "No module entry for array"); 138 139 // Call complete_create_array_klass after all instance variables has been initialized. 140 ArrayKlass::complete_create_array_klass(oak, super_klass, module, CHECK_0); 141 142 return oak; 143 } 144 145 ObjArrayKlass::ObjArrayKlass(int n, Klass* element_klass, Symbol* name) : ArrayKlass(name) { 146 this->set_dimension(n); 147 this->set_element_klass(element_klass); 148 // decrement refcount because object arrays are not explicitly freed. The 149 // InstanceKlass array_name() keeps the name counted while the klass is 150 // loaded. 151 name->decrement_refcount(); 152 153 Klass* bk; 154 if (element_klass->is_objArray_klass()) { 155 bk = ObjArrayKlass::cast(element_klass)->bottom_klass(); 156 } else { 157 bk = element_klass; 158 } 159 assert(bk != NULL && (bk->is_instance_klass() || bk->is_typeArray_klass()), "invalid bottom klass"); 160 this->set_bottom_klass(bk); 161 this->set_class_loader_data(bk->class_loader_data()); 162 163 this->set_layout_helper(array_layout_helper(T_OBJECT)); 164 assert(this->is_array_klass(), "sanity"); 165 assert(this->is_objArray_klass(), "sanity"); 166 } 167 168 int ObjArrayKlass::oop_size(oop obj) const { 169 assert(obj->is_objArray(), "must be object array"); 170 return objArrayOop(obj)->object_size(); 171 } 172 173 objArrayOop ObjArrayKlass::allocate(int length, TRAPS) { 174 if (length >= 0) { 175 if (length <= arrayOopDesc::max_array_length(T_OBJECT)) { 176 int size = objArrayOopDesc::object_size(length); 177 return (objArrayOop)CollectedHeap::array_allocate(this, size, length, THREAD); 178 } else { 179 report_java_out_of_memory("Requested array size exceeds VM limit"); 180 JvmtiExport::post_array_size_exhausted(); 181 THROW_OOP_0(Universe::out_of_memory_error_array_size()); 182 } 183 } else { 184 THROW_0(vmSymbols::java_lang_NegativeArraySizeException()); 185 } 186 } 187 188 static int multi_alloc_counter = 0; 189 190 oop ObjArrayKlass::multi_allocate(int rank, jint* sizes, TRAPS) { 191 int length = *sizes; 192 // Call to lower_dimension uses this pointer, so most be called before a 193 // possible GC 194 Klass* ld_klass = lower_dimension(); 195 // If length < 0 allocate will throw an exception. 196 objArrayOop array = allocate(length, CHECK_NULL); 197 objArrayHandle h_array (THREAD, array); 198 if (rank > 1) { 199 if (length != 0) { 200 for (int index = 0; index < length; index++) { 201 ArrayKlass* ak = ArrayKlass::cast(ld_klass); 202 oop sub_array = ak->multi_allocate(rank-1, &sizes[1], CHECK_NULL); 203 h_array->obj_at_put(index, sub_array); 204 } 205 } else { 206 // Since this array dimension has zero length, nothing will be 207 // allocated, however the lower dimension values must be checked 208 // for illegal values. 209 for (int i = 0; i < rank - 1; ++i) { 210 sizes += 1; 211 if (*sizes < 0) { 212 THROW_0(vmSymbols::java_lang_NegativeArraySizeException()); 213 } 214 } 215 } 216 } 217 return h_array(); 218 } 219 220 // Either oop or narrowOop depending on UseCompressedOops. 221 template <class T> void ObjArrayKlass::do_copy(arrayOop s, T* src, 222 arrayOop d, T* dst, int length, TRAPS) { 223 if (oopDesc::equals(s, d)) { 224 // since source and destination are equal we do not need conversion checks. 225 assert(length > 0, "sanity check"); 226 HeapAccess<>::oop_arraycopy(s, d, src, dst, length); 227 } else { 228 // We have to make sure all elements conform to the destination array 229 Klass* bound = ObjArrayKlass::cast(d->klass())->element_klass(); 230 Klass* stype = ObjArrayKlass::cast(s->klass())->element_klass(); 231 if (stype == bound || stype->is_subtype_of(bound)) { 232 // elements are guaranteed to be subtypes, so no check necessary 233 HeapAccess<ARRAYCOPY_DISJOINT>::oop_arraycopy(s, d, src, dst, length); 234 } else { 235 // slow case: need individual subtype checks 236 // note: don't use obj_at_put below because it includes a redundant store check 237 if (!HeapAccess<ARRAYCOPY_DISJOINT | ARRAYCOPY_CHECKCAST>::oop_arraycopy(s, d, src, dst, length)) { 238 THROW(vmSymbols::java_lang_ArrayStoreException()); 239 } 240 } 241 } 242 } 243 244 void ObjArrayKlass::copy_array(arrayOop s, int src_pos, arrayOop d, 245 int dst_pos, int length, TRAPS) { 246 assert(s->is_objArray(), "must be obj array"); 247 248 if (!d->is_objArray()) { 249 THROW(vmSymbols::java_lang_ArrayStoreException()); 250 } 251 252 // Check is all offsets and lengths are non negative 253 if (src_pos < 0 || dst_pos < 0 || length < 0) { 254 // Pass specific exception reason. 255 ResourceMark rm; 256 stringStream ss; 257 if (src_pos < 0) { 258 ss.print("arraycopy source index %i out of bounds for object array[%i].", 259 src_pos, s->length()); 260 } else if (dst_pos < 0) { 261 ss.print("arraycopy destination index %i out of bounds for object array[%i].", 262 dst_pos, d->length()); 263 } else { 264 ss.print("arraycopy length %i is negative.", length); 265 } 266 THROW_MSG(vmSymbols::java_lang_ArrayIndexOutOfBoundsException(), ss.as_string()); 267 } 268 // Check if the ranges are valid 269 if ((((unsigned int) length + (unsigned int) src_pos) > (unsigned int) s->length()) || 270 (((unsigned int) length + (unsigned int) dst_pos) > (unsigned int) d->length())) { 271 // Pass specific exception reason. 272 ResourceMark rm; 273 stringStream ss; 274 if (((unsigned int) length + (unsigned int) src_pos) > (unsigned int) s->length()) { 275 ss.print("arraycopy: last source index %u out of bounds for object array[%i].", 276 (unsigned int) length + (unsigned int) src_pos, s->length()); 277 } else { 278 ss.print("arraycopy: last destination index %u out of bounds for object array[%i].", 279 (unsigned int) length + (unsigned int) dst_pos, d->length()); 280 } 281 THROW_MSG(vmSymbols::java_lang_ArrayIndexOutOfBoundsException(), ss.as_string()); 282 } 283 284 // Special case. Boundary cases must be checked first 285 // This allows the following call: copy_array(s, s.length(), d.length(), 0). 286 // This is correct, since the position is supposed to be an 'in between point', i.e., s.length(), 287 // points to the right of the last element. 288 if (length==0) { 289 return; 290 } 291 if (UseCompressedOops) { 292 narrowOop* const src = objArrayOop(s)->obj_at_addr<narrowOop>(src_pos); 293 narrowOop* const dst = objArrayOop(d)->obj_at_addr<narrowOop>(dst_pos); 294 do_copy<narrowOop>(s, src, d, dst, length, CHECK); 295 } else { 296 oop* const src = objArrayOop(s)->obj_at_addr<oop>(src_pos); 297 oop* const dst = objArrayOop(d)->obj_at_addr<oop>(dst_pos); 298 do_copy<oop> (s, src, d, dst, length, CHECK); 299 } 300 } 301 302 303 Klass* ObjArrayKlass::array_klass_impl(bool or_null, int n, TRAPS) { 304 305 assert(dimension() <= n, "check order of chain"); 306 int dim = dimension(); 307 if (dim == n) return this; 308 309 // lock-free read needs acquire semantics 310 if (higher_dimension_acquire() == NULL) { 311 if (or_null) return NULL; 312 313 ResourceMark rm; 314 JavaThread *jt = (JavaThread *)THREAD; 315 { 316 MutexLocker mc(Compile_lock, THREAD); // for vtables 317 // Ensure atomic creation of higher dimensions 318 MutexLocker mu(MultiArray_lock, THREAD); 319 320 // Check if another thread beat us 321 if (higher_dimension() == NULL) { 322 323 // Create multi-dim klass object and link them together 324 Klass* k = 325 ObjArrayKlass::allocate_objArray_klass(class_loader_data(), dim + 1, this, CHECK_NULL); 326 ObjArrayKlass* ak = ObjArrayKlass::cast(k); 327 ak->set_lower_dimension(this); 328 // use 'release' to pair with lock-free load 329 release_set_higher_dimension(ak); 330 assert(ak->is_objArray_klass(), "incorrect initialization of ObjArrayKlass"); 331 } 332 } 333 } else { 334 CHECK_UNHANDLED_OOPS_ONLY(Thread::current()->clear_unhandled_oops()); 335 } 336 337 ObjArrayKlass *ak = ObjArrayKlass::cast(higher_dimension()); 338 if (or_null) { 339 return ak->array_klass_or_null(n); 340 } 341 return ak->array_klass(n, THREAD); 342 } 343 344 Klass* ObjArrayKlass::array_klass_impl(bool or_null, TRAPS) { 345 return array_klass_impl(or_null, dimension() + 1, THREAD); 346 } 347 348 bool ObjArrayKlass::can_be_primary_super_slow() const { 349 if (!bottom_klass()->can_be_primary_super()) 350 // array of interfaces 351 return false; 352 else 353 return Klass::can_be_primary_super_slow(); 354 } 355 356 GrowableArray<Klass*>* ObjArrayKlass::compute_secondary_supers(int num_extra_slots) { 357 // interfaces = { cloneable_klass, serializable_klass, elemSuper[], ... }; 358 Array<Klass*>* elem_supers = element_klass()->secondary_supers(); 359 int num_elem_supers = elem_supers == NULL ? 0 : elem_supers->length(); 360 int num_secondaries = num_extra_slots + 2 + num_elem_supers; 361 if (num_secondaries == 2) { 362 // Must share this for correct bootstrapping! 363 set_secondary_supers(Universe::the_array_interfaces_array()); 364 return NULL; 365 } else { 366 GrowableArray<Klass*>* secondaries = new GrowableArray<Klass*>(num_elem_supers+2); 367 secondaries->push(SystemDictionary::Cloneable_klass()); 368 secondaries->push(SystemDictionary::Serializable_klass()); 369 for (int i = 0; i < num_elem_supers; i++) { 370 Klass* elem_super = (Klass*) elem_supers->at(i); 371 Klass* array_super = elem_super->array_klass_or_null(); 372 assert(array_super != NULL, "must already have been created"); 373 secondaries->push(array_super); 374 } 375 return secondaries; 376 } 377 } 378 379 bool ObjArrayKlass::compute_is_subtype_of(Klass* k) { 380 if (!k->is_objArray_klass()) 381 return ArrayKlass::compute_is_subtype_of(k); 382 383 ObjArrayKlass* oak = ObjArrayKlass::cast(k); 384 return element_klass()->is_subtype_of(oak->element_klass()); 385 } 386 387 void ObjArrayKlass::initialize(TRAPS) { 388 bottom_klass()->initialize(THREAD); // dispatches to either InstanceKlass or TypeArrayKlass 389 } 390 391 void ObjArrayKlass::metaspace_pointers_do(MetaspaceClosure* it) { 392 ArrayKlass::metaspace_pointers_do(it); 393 it->push(&_element_klass); 394 it->push(&_bottom_klass); 395 } 396 397 // JVM support 398 399 jint ObjArrayKlass::compute_modifier_flags(TRAPS) const { 400 // The modifier for an objectArray is the same as its element 401 if (element_klass() == NULL) { 402 assert(Universe::is_bootstrapping(), "partial objArray only at startup"); 403 return JVM_ACC_ABSTRACT | JVM_ACC_FINAL | JVM_ACC_PUBLIC; 404 } 405 // Return the flags of the bottom element type. 406 jint element_flags = bottom_klass()->compute_modifier_flags(CHECK_0); 407 408 return (element_flags & (JVM_ACC_PUBLIC | JVM_ACC_PRIVATE | JVM_ACC_PROTECTED)) 409 | (JVM_ACC_ABSTRACT | JVM_ACC_FINAL); 410 } 411 412 ModuleEntry* ObjArrayKlass::module() const { 413 assert(bottom_klass() != NULL, "ObjArrayKlass returned unexpected NULL bottom_klass"); 414 // The array is defined in the module of its bottom class 415 return bottom_klass()->module(); 416 } 417 418 PackageEntry* ObjArrayKlass::package() const { 419 assert(bottom_klass() != NULL, "ObjArrayKlass returned unexpected NULL bottom_klass"); 420 return bottom_klass()->package(); 421 } 422 423 // Printing 424 425 void ObjArrayKlass::print_on(outputStream* st) const { 426 #ifndef PRODUCT 427 Klass::print_on(st); 428 st->print(" - instance klass: "); 429 element_klass()->print_value_on(st); 430 st->cr(); 431 #endif //PRODUCT 432 } 433 434 void ObjArrayKlass::print_value_on(outputStream* st) const { 435 assert(is_klass(), "must be klass"); 436 437 element_klass()->print_value_on(st); 438 st->print("[]"); 439 } 440 441 #ifndef PRODUCT 442 443 void ObjArrayKlass::oop_print_on(oop obj, outputStream* st) { 444 ArrayKlass::oop_print_on(obj, st); 445 assert(obj->is_objArray(), "must be objArray"); 446 objArrayOop oa = objArrayOop(obj); 447 int print_len = MIN2((intx) oa->length(), MaxElementPrintSize); 448 for(int index = 0; index < print_len; index++) { 449 st->print(" - %3d : ", index); 450 oa->obj_at(index)->print_value_on(st); 451 st->cr(); 452 } 453 int remaining = oa->length() - print_len; 454 if (remaining > 0) { 455 st->print_cr(" - <%d more elements, increase MaxElementPrintSize to print>", remaining); 456 } 457 } 458 459 #endif //PRODUCT 460 461 void ObjArrayKlass::oop_print_value_on(oop obj, outputStream* st) { 462 assert(obj->is_objArray(), "must be objArray"); 463 st->print("a "); 464 element_klass()->print_value_on(st); 465 int len = objArrayOop(obj)->length(); 466 st->print("[%d] ", len); 467 obj->print_address_on(st); 468 } 469 470 const char* ObjArrayKlass::internal_name() const { 471 return external_name(); 472 } 473 474 475 // Verification 476 477 void ObjArrayKlass::verify_on(outputStream* st) { 478 ArrayKlass::verify_on(st); 479 guarantee(element_klass()->is_klass(), "should be klass"); 480 guarantee(bottom_klass()->is_klass(), "should be klass"); 481 Klass* bk = bottom_klass(); 482 guarantee(bk->is_instance_klass() || bk->is_typeArray_klass(), "invalid bottom klass"); 483 } 484 485 void ObjArrayKlass::oop_verify_on(oop obj, outputStream* st) { 486 ArrayKlass::oop_verify_on(obj, st); 487 guarantee(obj->is_objArray(), "must be objArray"); 488 objArrayOop oa = objArrayOop(obj); 489 for(int index = 0; index < oa->length(); index++) { 490 guarantee(oopDesc::is_oop_or_null(oa->obj_at(index)), "should be oop"); 491 } 492 }