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