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