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