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