1 /*
2 * Copyright (c) 2017, 2025, 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_FLATARRAYKLASS_HPP
26 #define SHARE_VM_OOPS_FLATARRAYKLASS_HPP
27
28 #include "classfile/classLoaderData.hpp"
29 #include "oops/arrayKlass.hpp"
30 #include "oops/inlineKlass.hpp"
31 #include "utilities/macros.hpp"
32
33 /**
34 * Array of inline types, gives a layout of typeArrayOop, but needs oops iterators
35 */
36 class FlatArrayKlass : public ArrayKlass {
37 friend class VMStructs;
38
39 public:
40 static const KlassKind Kind = FlatArrayKlassKind;
41
42 private:
43 // Constructor
44 FlatArrayKlass(Klass* element_klass, Symbol* name, LayoutKind lk);
45
46 LayoutKind _layout_kind;
47
48 public:
49
50 FlatArrayKlass() {} // used by CppVtableCloner<T>::initialize()
51
52 InlineKlass* element_klass() const { return InlineKlass::cast(_element_klass); }
53 void set_element_klass(Klass* k) { _element_klass = k; }
54
55 LayoutKind layout_kind() const { return _layout_kind; }
56 void set_layout_kind(LayoutKind lk) { _layout_kind = lk; }
57
58 // Casting from Klass*
59 static FlatArrayKlass* cast(Klass* k) {
60 assert(k->is_flatArray_klass(), "cast to FlatArrayKlass");
61 return (FlatArrayKlass*) k;
62 }
63
64 // klass allocation
65 static FlatArrayKlass* allocate_klass(Klass* element_klass, LayoutKind lk, TRAPS);
66
67 void initialize(TRAPS);
68
69 ModuleEntry* module() const;
70 PackageEntry* package() const;
71
72 bool can_be_primary_super_slow() const;
73 GrowableArray<Klass*>* compute_secondary_supers(int num_extra_slots,
74 Array<InstanceKlass*>* transitive_interfaces);
75
76 int element_byte_size() const { return 1 << layout_helper_log2_element_size(_layout_helper); }
77
78 bool is_flatArray_klass_slow() const { return true; }
79
80 bool contains_oops() {
81 return element_klass()->contains_oops();
82 }
83
84 // Override.
85 bool element_access_must_be_atomic() {
86 return element_klass()->must_be_atomic();
87 }
88
89 oop protection_domain() const;
90
91 virtual void metaspace_pointers_do(MetaspaceClosure* iter);
92
93 static jint array_layout_helper(InlineKlass* vklass, LayoutKind lk); // layout helper for values
94
95 // sizing
96 static int header_size() { return sizeof(FlatArrayKlass)/HeapWordSize; }
97 int size() const { return ArrayKlass::static_size(header_size()); }
98
99 jint max_elements() const;
100
101 size_t oop_size(oop obj) const;
102
103 // Oop Allocation
104 flatArrayOop allocate(int length, LayoutKind lk, TRAPS);
105 oop multi_allocate(int rank, jint* sizes, TRAPS);
106
107 // Naming
108 const char* internal_name() const { return external_name(); }
109
110 // Copying
111 void copy_array(arrayOop s, int src_pos, arrayOop d, int dst_pos, int length, TRAPS);
112
113 // GC specific object visitors
114 //
115 // Mark Sweep
116 int oop_ms_adjust_pointers(oop obj);
117
118
119 template <typename T, typename OopClosureType>
120 inline void oop_oop_iterate(oop obj, OopClosureType* closure);
121
122 template <typename T, typename OopClosureType>
123 inline void oop_oop_iterate_reverse(oop obj, OopClosureType* closure);
124
125 template <typename T, typename OopClosureType>
126 inline void oop_oop_iterate_bounded(oop obj, OopClosureType* closure, MemRegion mr);
127
128 template <typename T, class OopClosureType>
129 inline void oop_oop_iterate_elements(flatArrayOop a, OopClosureType* closure);
130
131 private:
132 template <typename T, class OopClosureType>
133 inline void oop_oop_iterate_elements_specialized(flatArrayOop a, OopClosureType* closure);
134
135 template <typename T, class OopClosureType>
136 inline void oop_oop_iterate_elements_bounded(flatArrayOop a, OopClosureType* closure, MemRegion mr);
137
138 template <typename T, class OopClosureType>
139 inline void oop_oop_iterate_elements_specialized_bounded(flatArrayOop a, OopClosureType* closure, void* low, void* high);
140
141 public:
142 jint compute_modifier_flags() const;
143
144 // Printing
145 void print_on(outputStream* st) const;
146 void print_value_on(outputStream* st) const;
147
148 void oop_print_value_on(oop obj, outputStream* st);
149 #ifndef PRODUCT
150 void oop_print_on(oop obj, outputStream* st);
151 #endif
152
153 // Verification
154 void verify_on(outputStream* st);
155 void oop_verify_on(oop obj, outputStream* st);
156 };
157
158 #endif