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