1 /*
2 * Copyright (c) 2018, 2026, 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 #ifndef SHARE_VM_OOPS_FLATARRAYOOP_INLINE_HPP
26 #define SHARE_VM_OOPS_FLATARRAYOOP_INLINE_HPP
27
28 #include "oops/flatArrayOop.hpp"
29
30 #include "classfile/vmSymbols.hpp"
31 #include "oops/access.inline.hpp"
32 #include "oops/flatArrayKlass.hpp"
33 #include "oops/inlineKlass.inline.hpp"
34 #include "oops/oop.inline.hpp"
35 #include "oops/valuePayload.inline.hpp"
36 #include "runtime/globals.hpp"
37
38 inline void* flatArrayOopDesc::base() const { return arrayOopDesc::base(T_FLAT_ELEMENT); }
39
40 inline size_t flatArrayOopDesc::base_offset_in_bytes() {
41 return static_cast<size_t>(arrayOopDesc::base_offset_in_bytes(T_FLAT_ELEMENT));
42 }
43
44 inline void* flatArrayOopDesc::value_at_addr(int index, jint lh) const {
45 assert(is_within_bounds(index), "index out of bounds");
46
47 address array_base = (address) base();
48 size_t offset = value_offset_from_base(index, lh);
49 address addr = array_base + offset;
50 assert(addr >= array_base, "must be");
51 return (void*) addr;
52 }
53
54 inline size_t flatArrayOopDesc::value_offset(int index, jint lh) const {
55 assert(is_within_bounds(index), "index out of bounds");
56 return base_offset_in_bytes() + value_offset_from_base(index, lh);
57 }
58
59 inline size_t flatArrayOopDesc::value_offset_from_base(int index, jint lh) const {
60 assert(is_within_bounds(index), "index out of bounds");
61 return static_cast<size_t>(index) << Klass::layout_helper_log2_element_size(lh);
62 }
63
64 inline int flatArrayOopDesc::object_size(int lh) const {
65 return object_size(lh, length());
66 }
67
68 inline oop flatArrayOopDesc::obj_at(int index) const {
69 fatal("Should not be used with flat arrays");
70 EXCEPTION_MARK;
71 return obj_at(index, THREAD);
72 }
73
74 inline oop flatArrayOopDesc::obj_at(int index, TRAPS) const {
75 assert(is_within_bounds(index), "index %d out of bounds %d", index, length());
76 FlatArrayPayload payload(flatArrayOop(const_cast<flatArrayOopDesc*>(this)), index);
77 return payload.read(THREAD);
78 }
79
80 inline jboolean flatArrayOopDesc::null_marker_of_obj_at(int index) const {
81 EXCEPTION_MARK;
82 return null_marker_of_obj_at(index, THREAD);
83 }
84
85 inline jboolean flatArrayOopDesc::null_marker_of_obj_at(int index, TRAPS) const {
86 assert(is_within_bounds(index), "index %d out of bounds %d", index, length());
87 FlatArrayKlass* faklass = FlatArrayKlass::cast(klass());
88 InlineKlass* vk = InlineKlass::cast(faklass->element_klass());
89 char* this_oop = (char*) (oopDesc*) this;
90 char* val = (char*) value_at_addr(index, faklass->layout_helper());
91 ptrdiff_t offset = val - this_oop + (ptrdiff_t)vk->null_marker_offset_in_payload();
92 return bool_field(offset);
93 }
94
95 inline void flatArrayOopDesc::obj_at_put(int index, oop value) {
96 EXCEPTION_MARK; // What if the caller is not a Java Thread?
97 obj_at_put(index, value, THREAD);
98 }
99
100 inline void flatArrayOopDesc::obj_at_put(int index, oop value, TRAPS) {
101 assert(is_within_bounds(index), "index %d out of bounds %d", index, length());
102 FlatArrayKlass* faklass = FlatArrayKlass::cast(klass());
103 InlineKlass* vk = InlineKlass::cast(faklass->element_klass());
104 if (value != nullptr) {
105 if (value->klass() != vk) {
106 THROW(vmSymbols::java_lang_ArrayStoreException());
107 }
108 } else if(is_null_free_array()) {
109 THROW_MSG(vmSymbols::java_lang_NullPointerException(), "Cannot store null in a null-restricted array");
110 }
111
112 FlatArrayPayload payload(flatArrayOop(this), index, faklass);
113 // The value and klass has already been checked for null compatibility.
114 payload.write_without_nullability_check(inlineOop(value));
115 }
116
117 template <typename OopClosureType>
118 void flatArrayOopDesc::oop_iterate_elements_range(OopClosureType* blk, int start, int end) {
119 FlatArrayKlass* faklass = FlatArrayKlass::cast(klass());
120 if (UseCompressedOops) {
121 faklass->oop_oop_iterate_elements_range<narrowOop>(this, blk, start, end);
122 } else {
123 faklass->oop_oop_iterate_elements_range<oop>(this, blk, start, end);
124 }
125 }
126
127 #endif // SHARE_VM_OOPS_FLATARRAYOOP_INLINE_HPP