1 /*
2 * Copyright (c) 2017, 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.hpp"
32 #include "gc/shared/collectedHeap.inline.hpp"
33 #include "memory/metadataFactory.hpp"
34 #include "memory/resourceArea.hpp"
35 #include "memory/universe.hpp"
36 #include "oops/instanceKlass.hpp"
37 #include "oops/klass.inline.hpp"
38 #include "oops/objArrayKlass.hpp"
39 #include "oops/objArrayOop.inline.hpp"
40 #include "oops/oop.inline.hpp"
41 #include "oops/arrayKlass.hpp"
42 #include "oops/arrayOop.hpp"
43 #include "oops/valueKlass.hpp"
44 #include "oops/valueArrayOop.hpp"
45 #include "oops/valueArrayOop.inline.hpp"
46 #include "oops/verifyOopClosure.hpp"
47 #include "runtime/handles.inline.hpp"
48 #include "runtime/orderAccess.inline.hpp"
49 #include "utilities/macros.hpp"
50
51 #include "oops/valueArrayKlass.hpp"
52
53 // Allocation...
54
55 ValueArrayKlass::ValueArrayKlass(Klass* element_klass, Symbol* name) : ArrayKlass(name) {
56 assert(element_klass->is_value(), "Expected Value");
57
58 set_element_klass(ValueKlass::cast(element_klass));
59 set_class_loader_data(element_klass->class_loader_data());
60 set_layout_helper(array_layout_helper(ValueKlass::cast(element_klass)));
61
62 assert(is_array_klass(), "sanity");
63 assert(is_valueArray_klass(), "sanity");
64
65 CMH("tweak name symbol refcnt ?")
66 #ifndef PRODUCT
67 if (PrintValueArrayLayout) {
68 print();
69 }
70 #endif
71 }
72
73 ValueKlass* ValueArrayKlass::element_klass() const {
74 return ValueKlass::cast(_element_klass);
75 }
76
77 void ValueArrayKlass::set_element_klass(Klass* k) {
78 _element_klass = k;
79 }
80
81 ValueArrayKlass* ValueArrayKlass::allocate_klass(Klass* element_klass,
82 Symbol* name,
83 TRAPS) {
84 assert(ValueArrayFlatten, "Flatten array required");
85 assert(ValueKlass::cast(element_klass)->is_atomic() || (!ValueArrayAtomicAccess), "Atomic by-default");
86
87 /*
88 * MVT->LWorld, now need to allocate secondaries array types, just like objArrayKlass...
89 * ...so now we are trying out covariant array types, just copy objArrayKlass
90 * TODO refactor any remaining commonality
91 */
92
93 // Eagerly allocate the direct array supertype.
94 Klass* super_klass = NULL;
95 if (!Universe::is_bootstrapping() || SystemDictionary::Object_klass_loaded()) {
96 Klass* element_super = element_klass->super();
97 if (element_super != NULL) {
98 // The element type has a direct super. E.g., String[] has direct super of Object[].
99 super_klass = element_super->array_klass_or_null();
100 bool supers_exist = super_klass != NULL;
101 // Also, see if the element has secondary supertypes.
102 // We need an array type for each.
103 Array<Klass*>* element_supers = element_klass->secondary_supers();
104 for( int i = element_supers->length()-1; i >= 0; i-- ) {
105 Klass* elem_super = element_supers->at(i);
106 if (elem_super->array_klass_or_null() == NULL) {
107 supers_exist = false;
108 break;
109 }
110 }
111 if (!supers_exist) {
112 // Oops. Not allocated yet. Back out, allocate it, and retry.
113 Klass* ek = NULL;
114 {
115 MutexUnlocker mu(MultiArray_lock);
116 MutexUnlocker mc(Compile_lock); // for vtables
117 super_klass = element_super->array_klass(CHECK_0);
118 for( int i = element_supers->length()-1; i >= 0; i-- ) {
119 Klass* elem_super = element_supers->at(i);
120 elem_super->array_klass(CHECK_0);
121 }
122 // Now retry from the beginning
123 ek = element_klass->array_klass(1, CHECK_0);
124 } // re-lock
125 return ValueArrayKlass::cast(ek);
126 }
127 } else {
128 ShouldNotReachHere(); // Value array klass cannot be the object array klass
129 }
130 }
131
132
133 ClassLoaderData* loader_data = element_klass->class_loader_data();
134 int size = ArrayKlass::static_size(ValueArrayKlass::header_size());
135 ValueArrayKlass* vak = new (loader_data, size, THREAD) ValueArrayKlass(element_klass, name);
136 if (vak == NULL) {
137 return NULL;
138 }
139 loader_data->add_class(vak);
140
141 ModuleEntry* module = vak->module();
142 assert(module != NULL, "No module entry for array");
143 complete_create_array_klass(vak, super_klass, module, CHECK_NULL);
144 return vak;
145 }
146
147 ValueArrayKlass* ValueArrayKlass::allocate_klass(Klass* element_klass, TRAPS) {
148 Symbol* name = ArrayKlass::create_element_klass_array_name(element_klass, CHECK_NULL);
149 return allocate_klass(element_klass, name, THREAD);
150 }
151
152 void ValueArrayKlass::initialize(TRAPS) {
153 element_klass()->initialize(THREAD);
154 }
155
156 // Oops allocation...
157 oop ValueArrayKlass::allocate(int length, bool do_zero, TRAPS) {
158 if (length < 0) {
159 THROW_0(vmSymbols::java_lang_NegativeArraySizeException());
160 }
161 if (length > max_elements()) {
162 report_java_out_of_memory("Requested array size exceeds VM limit");
163 JvmtiExport::post_array_size_exhausted();
164 THROW_OOP_0(Universe::out_of_memory_error_array_size());
165 }
166
167 size_t size = valueArrayOopDesc::object_size(layout_helper(), length);
168 if (do_zero) {
169 return CollectedHeap::array_allocate(this, (int)size, length, CHECK_NULL);
170 } else {
171 return CollectedHeap::array_allocate_nozero(this, (int)size, length, CHECK_NULL);
172 }
173 }
174
175
176 oop ValueArrayKlass::multi_allocate(int rank, jint* last_size, TRAPS) {
177 // For valueArrays this is only called for the last dimension
178 assert(rank == 1, "just checking");
179 int length = *last_size;
180 return allocate(length, true, THREAD);
181 }
182
183 jint ValueArrayKlass::array_layout_helper(ValueKlass* vk) {
184 BasicType etype = T_VALUETYPE;
185 int atag = _lh_array_tag_vt_value;
186 int esize = upper_log2(vk->raw_value_byte_size());
187 int hsize = arrayOopDesc::base_offset_in_bytes(etype);
188
189 int lh = (atag << _lh_array_tag_shift)
190 | (hsize << _lh_header_size_shift)
191 | ((int)etype << _lh_element_type_shift)
192 | ((esize) << _lh_log2_element_size_shift);
193
194 assert(lh < (int)_lh_neutral_value, "must look like an array layout");
195 assert(layout_helper_is_array(lh), "correct kind");
196 assert(layout_helper_is_valueArray(lh), "correct kind");
197 assert(!layout_helper_is_typeArray(lh), "correct kind");
198 assert(!layout_helper_is_objArray(lh), "correct kind");
199 assert(layout_helper_header_size(lh) == hsize, "correct decode");
200 assert(layout_helper_element_type(lh) == etype, "correct decode");
201 assert(layout_helper_log2_element_size(lh) == esize, "correct decode");
202 assert((1 << esize) < BytesPerLong || is_aligned(hsize, HeapWordsPerLong), "unaligned base");
203
204 return lh;
205 }
206
207 int ValueArrayKlass::oop_size(oop obj) const {
208 assert(obj->is_valueArray(),"must be a value array");
209 valueArrayOop array = valueArrayOop(obj);
210 return array->object_size();
211 }
212
213 jint ValueArrayKlass::max_elements() const {
214 return arrayOopDesc::max_array_length(arrayOopDesc::header_size(T_VALUETYPE), element_byte_size());
215 }
216
217 oop ValueArrayKlass::protection_domain() const {
218 return element_klass()->protection_domain();
219 }
220
221 void ValueArrayKlass::copy_array(arrayOop s, int src_pos,
222 arrayOop d, int dst_pos, int length, TRAPS) {
223
224 assert(s->is_objArray() || s->is_valueArray(), "must be obj or value array");
225
226 // Check destination
227 if ((!d->is_valueArray()) && (!d->is_objArray())) {
228 THROW(vmSymbols::java_lang_ArrayStoreException());
229 }
230
231 // Check if all offsets and lengths are non negative
232 if (src_pos < 0 || dst_pos < 0 || length < 0) {
233 THROW(vmSymbols::java_lang_ArrayIndexOutOfBoundsException());
234 }
235 // Check if the ranges are valid
236 if ( (((unsigned int) length + (unsigned int) src_pos) > (unsigned int) s->length())
237 || (((unsigned int) length + (unsigned int) dst_pos) > (unsigned int) d->length()) ) {
238 THROW(vmSymbols::java_lang_ArrayIndexOutOfBoundsException());
239 }
240 // Check zero copy
241 if (length == 0)
242 return;
243
244 ArrayKlass* sk = ArrayKlass::cast(s->klass());
245 ArrayKlass* dk = ArrayKlass::cast(d->klass());
246 Klass* d_elem_klass = dk->element_klass();
247 Klass* s_elem_klass = sk->element_klass();
248 /**** CMH: compare and contrast impl, re-factor once we find edge cases... ****/
249
250 if (sk->is_valueArray_klass()) {
251 assert(sk == this, "Unexpected call to copy_array");
252 // Check subtype, all src homogeneous, so just once
253 if (!s_elem_klass->is_subtype_of(d_elem_klass)) {
254 THROW(vmSymbols::java_lang_ArrayStoreException());
255 }
256
257 valueArrayOop sa = valueArrayOop(s);
258 ValueKlass* s_elem_vklass = element_klass();
259
260 // valueArray-to-valueArray
261 if (dk->is_valueArray_klass()) {
262 // element types MUST be exact, subtype check would be dangerous
263 if (dk != this) {
264 THROW(vmSymbols::java_lang_ArrayStoreException());
265 }
266
267 valueArrayOop da = valueArrayOop(d);
268 address dst = (address) da->value_at_addr(dst_pos, layout_helper());
269 address src = (address) sa->value_at_addr(src_pos, layout_helper());
270 if (contains_oops()) {
271 int elem_incr = 1 << log2_element_size();
272 address src_end = src + (length << log2_element_size());
273 while (src < src_end) {
274 s_elem_vklass->value_store(src, dst, element_byte_size(), true, false);
275 src += elem_incr;
276 dst += elem_incr;
277 }
278 } else {
279 // we are basically a type array...don't bother limiting element copy
280 // it would have to be a lot wasted space to be worth value_store() calls, need a setting here ?
281 Copy::conjoint_memory_atomic(src, dst, (size_t)length << log2_element_size());
282 }
283 }
284 else { // valueArray-to-objArray
285 assert(dk->is_objArray_klass(), "Expected objArray here");
286 // Need to allocate each new src elem payload -> dst oop
287 objArrayHandle dh(THREAD, (objArrayOop)d);
288 valueArrayHandle sh(THREAD, sa);
289 int dst_end = dst_pos + length;
290 while (dst_pos < dst_end) {
291 oop o = s_elem_vklass->allocate_instance(CHECK);
292 s_elem_vklass->value_store(sh->value_at_addr(src_pos, layout_helper()),
293 s_elem_vklass->data_for_oop(o), true, true);
294 dh->obj_at_put(dst_pos, o);
295 dst_pos++;
296 src_pos++;
297 }
298 }
299 } else { // objArray-to-valueArray
300 assert(d->is_valueArray(), "objArray copy to valueArray expected");
301
302 ValueKlass* d_elem_vklass = ValueKlass::cast(d_elem_klass);
303 valueArrayOop da = valueArrayOop(d);
304 objArrayOop sa = objArrayOop(s);
305
306 int src_end = src_pos + length;
307 int delem_incr = 1 << dk->log2_element_size();
308 address dst = (address) da->value_at_addr(dst_pos, layout_helper());
309 while (src_pos < src_end) {
310 oop se = sa->obj_at(src_pos);
311 if (se == NULL) {
312 THROW(vmSymbols::java_lang_NullPointerException());
313 }
314 // Check exact type per element
315 if (se->klass() != d_elem_klass) {
316 THROW(vmSymbols::java_lang_ArrayStoreException());
317 }
318 d_elem_vklass->value_store(d_elem_vklass->data_for_oop(se), dst, true, false);
319 dst += delem_incr;
320 src_pos++;
321 }
322 }
323 }
324
325
326 Klass* ValueArrayKlass::array_klass_impl(bool or_null, int n, TRAPS) {
327
328 assert(dimension() <= n, "check order of chain");
329 int dim = dimension();
330 if (dim == n) return this;
331
332 if (higher_dimension() == NULL) {
333 if (or_null) return NULL;
334
335 ResourceMark rm;
336 JavaThread *jt = (JavaThread *)THREAD;
337 {
338 MutexLocker mc(Compile_lock, THREAD); // for vtables
339 // Ensure atomic creation of higher dimensions
340 MutexLocker mu(MultiArray_lock, THREAD);
341
342 // Check if another thread beat us
343 if (higher_dimension() == NULL) {
344
345 // Create multi-dim klass object and link them together
346 Klass* k =
347 ObjArrayKlass::allocate_objArray_klass(class_loader_data(), dim + 1, this, CHECK_NULL);
348 ObjArrayKlass* ak = ObjArrayKlass::cast(k);
349 ak->set_lower_dimension(this);
350 OrderAccess::storestore();
351 set_higher_dimension(ak);
352 assert(ak->is_objArray_klass(), "incorrect initialization of ObjArrayKlass");
353 }
354 }
355 } else {
356 CHECK_UNHANDLED_OOPS_ONLY(Thread::current()->clear_unhandled_oops());
357 }
358
359 ObjArrayKlass *ak = ObjArrayKlass::cast(higher_dimension());
360 if (or_null) {
361 return ak->array_klass_or_null(n);
362 }
363 return ak->array_klass(n, THREAD);
364 }
365
366 Klass* ValueArrayKlass::array_klass_impl(bool or_null, TRAPS) {
367 return array_klass_impl(or_null, dimension() + 1, THREAD);
368 }
369
370 ModuleEntry* ValueArrayKlass::module() const {
371 assert(element_klass() != NULL, "ValueArrayKlass returned unexpected NULL bottom_klass");
372 // The array is defined in the module of its bottom class
373 return element_klass()->module();
374 }
375
376 PackageEntry* ValueArrayKlass::package() const {
377 assert(element_klass() != NULL, "ValuerrayKlass returned unexpected NULL bottom_klass");
378 return element_klass()->package();
379 }
380
381 bool ValueArrayKlass::can_be_primary_super_slow() const {
382 return true;
383 }
384
385 GrowableArray<Klass*>* ValueArrayKlass::compute_secondary_supers(int num_extra_slots,
386 Array<Klass*>* transitive_interfaces) {
387 assert(transitive_interfaces == NULL, "sanity");
388 // interfaces = { cloneable_klass, serializable_klass, elemSuper[], ... };
389 Array<Klass*>* elem_supers = element_klass()->secondary_supers();
390 int num_elem_supers = elem_supers == NULL ? 0 : elem_supers->length();
391 int num_secondaries = num_extra_slots + 2 + num_elem_supers;
392 if (num_secondaries == 2) {
393 // Must share this for correct bootstrapping!
394 set_secondary_supers(Universe::the_array_interfaces_array());
395 return NULL;
396 } else {
397 GrowableArray<Klass*>* secondaries = new GrowableArray<Klass*>(num_elem_supers+2);
398 secondaries->push(SystemDictionary::Cloneable_klass());
399 secondaries->push(SystemDictionary::Serializable_klass());
400 for (int i = 0; i < num_elem_supers; i++) {
401 Klass* elem_super = (Klass*) elem_supers->at(i);
402 Klass* array_super = elem_super->array_klass_or_null();
403 assert(array_super != NULL, "must already have been created");
404 secondaries->push(array_super);
405 }
406 return secondaries;
407 }
408 }
409
410 bool ValueArrayKlass::compute_is_subtype_of(Klass* k) {
411 if (k->is_valueArray_klass() || k->is_objArray_klass()) {
412 return element_klass()->is_subtype_of(ArrayKlass::cast(k)->element_klass());
413 } else {
414 return ArrayKlass::compute_is_subtype_of(k);
415 }
416 }
417
418
419 void ValueArrayKlass::print_on(outputStream* st) const {
420 #ifndef PRODUCT
421 assert(!is_objArray_klass(), "Unimplemented");
422
423 st->print("Value Type Array: ");
424 Klass::print_on(st);
425
426 st->print(" - element klass: ");
427 element_klass()->print_value_on(st);
428 st->cr();
429
430 int elem_size = element_byte_size();
431 st->print(" - element size %i ", elem_size);
432 st->print("aligned layout size %i", 1 << layout_helper_log2_element_size(layout_helper()));
433 st->cr();
434 #endif //PRODUCT
435 }
436
437 void ValueArrayKlass::print_value_on(outputStream* st) const {
438 assert(is_klass(), "must be klass");
439
440 element_klass()->print_value_on(st);
441 st->print("[]");
442 }
443
444
445 #ifndef PRODUCT
446 void ValueArrayKlass::oop_print_on(oop obj, outputStream* st) {
447 ArrayKlass::oop_print_on(obj, st);
448 valueArrayOop va = valueArrayOop(obj);
449 ValueKlass* vk = element_klass();
450 int print_len = MIN2((intx) va->length(), MaxElementPrintSize);
451 for(int index = 0; index < print_len; index++) {
452 int off = (address) va->value_at_addr(index, layout_helper()) - (address) obj;
453 st->print_cr(" - Index %3d offset %3d: ", index, off);
454 oop obj = (oop) ((address)va->value_at_addr(index, layout_helper()) - vk->first_field_offset());
455 FieldPrinter print_field(st, obj);
456 vk->do_nonstatic_fields(&print_field);
457 st->cr();
458 }
459 int remaining = va->length() - print_len;
460 if (remaining > 0) {
461 st->print_cr(" - <%d more elements, increase MaxElementPrintSize to print>", remaining);
462 }
463 }
464 #endif //PRODUCT
465
466 void ValueArrayKlass::oop_print_value_on(oop obj, outputStream* st) {
467 assert(obj->is_valueArray(), "must be valueArray");
468 st->print("a ");
469 element_klass()->print_value_on(st);
470 int len = valueArrayOop(obj)->length();
471 st->print("[%d] ", len);
472 obj->print_address_on(st);
473 if (PrintMiscellaneous && (WizardMode || Verbose)) {
474 int lh = layout_helper();
475 st->print("{");
476 for (int i = 0; i < len; i++) {
477 if (i > 4) {
478 st->print("..."); break;
479 }
480 st->print(" " INTPTR_FORMAT, (intptr_t)(void*)valueArrayOop(obj)->value_at_addr(i , lh));
481 }
482 st->print(" }");
483 }
484 }
485
486 // Verification
487
488 void ValueArrayKlass::oop_verify_on(oop obj, outputStream* st) {
489 ArrayKlass::oop_verify_on(obj, st);
490 guarantee(obj->is_valueArray(), "must be valueArray");
491
492 if (element_klass()->contains_oops()) {
493 valueArrayOop va = valueArrayOop(obj);
494 NoHeaderExtendedOopClosure wrapClosure(&VerifyOopClosure::verify_oop);
495 va->oop_iterate(&wrapClosure);
496 }
497 }
498
499 void ValueArrayKlass::verify_on(outputStream* st) {
500 ArrayKlass::verify_on(st);
501 guarantee(element_klass()->is_value(), "should be value type klass");
502 }