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