1 /*
2 * Copyright (c) 1997, 2019, 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_OOPS_OBJARRAYKLASS_HPP
26 #define SHARE_OOPS_OBJARRAYKLASS_HPP
27
28 #include "classfile/classLoaderData.hpp"
29 #include "oops/arrayKlass.hpp"
30 #include "utilities/macros.hpp"
31
32 // ObjArrayKlass is the klass for objArrays
33
34 class ObjArrayKlass : public ArrayKlass {
35 friend class VMStructs;
36 friend class JVMCIVMStructs;
37
38 public:
39 static const KlassID ID = ObjArrayKlassID;
40
41 private:
42 // If you add a new field that points to any metaspace object, you
43 // must add this field to ObjArrayKlass::metaspace_pointers_do().
44 Klass* _bottom_klass; // The one-dimensional type (InstanceKlass or TypeArrayKlass)
45
46 // Constructor
47 ObjArrayKlass(int n, Klass* element_klass, Symbol* name);
48 static ObjArrayKlass* allocate(ClassLoaderData* loader_data, int n, Klass* k, Symbol* name, TRAPS);
49 public:
50 // For dummy objects
51 ObjArrayKlass() {}
52
53 // if ObjArrayKlass is used to represent an LWorld "Q-type" value type array, the only thing we can give null-free (i.e. not flattened)
54 // ArrayStorageProperties::empty meaning nothing special, array of references (possibly even to value types)
55 ArrayStorageProperties storage_properties();
56
57 Klass* bottom_klass() const { return _bottom_klass; }
58 void set_bottom_klass(Klass* k) { _bottom_klass = k; }
59 Klass** bottom_klass_addr() { return &_bottom_klass; }
60
61 ModuleEntry* module() const;
62 PackageEntry* package() const;
63
64 // Dispatched operation
65 bool can_be_primary_super_slow() const;
66 GrowableArray<Klass*>* compute_secondary_supers(int num_extra_slots,
67 Array<InstanceKlass*>* transitive_interfaces);
68 DEBUG_ONLY(bool is_objArray_klass_slow() const { return true; })
69 int oop_size(oop obj) const;
70
71 // Allocation
72 static Klass* allocate_objArray_klass(ArrayStorageProperties storage_props,
73 int n, Klass* element_klass, TRAPS);
74
75 objArrayOop allocate(int length, TRAPS);
76 oop multi_allocate(int rank, jint* sizes, TRAPS);
77
78 // Copying
79 void copy_array(arrayOop s, int src_pos, arrayOop d, int dst_pos, int length, TRAPS);
80
81 // Compute protection domain
82 oop protection_domain() const { return bottom_klass()->protection_domain(); }
83
84 virtual void metaspace_pointers_do(MetaspaceClosure* iter);
85
86 private:
87 // Either oop or narrowOop depending on UseCompressedOops.
88 // must be called from within ObjArrayKlass.cpp
89 void do_copy(arrayOop s, size_t src_offset,
90 arrayOop d, size_t dst_offset,
91 int length, TRAPS);
92 protected:
93 // Returns the ObjArrayKlass for n'th dimension.
94 virtual Klass* array_klass_impl(ArrayStorageProperties storage_props, bool or_null, int n, TRAPS);
95
96 // Returns the array class with this class as element type.
97 virtual Klass* array_klass_impl(ArrayStorageProperties storage_props, bool or_null, TRAPS);
98
99 public:
100
101 static ObjArrayKlass* cast(Klass* k) {
102 return const_cast<ObjArrayKlass*>(cast(const_cast<const Klass*>(k)));
103 }
104
105 static const ObjArrayKlass* cast(const Klass* k) {
106 assert(k->is_objArray_klass(), "cast to ObjArrayKlass");
107 return static_cast<const ObjArrayKlass*>(k);
108 }
109
110 // Sizing
111 static int header_size() { return sizeof(ObjArrayKlass)/wordSize; }
112 int size() const { return ArrayKlass::static_size(header_size()); }
113
114 // Initialization (virtual from Klass)
115 void initialize(TRAPS);
116
117 // Oop fields (and metadata) iterators
118 //
119 // The ObjArrayKlass iterators also visits the Object's klass.
120
121 // Iterate over oop elements and metadata.
122 template <typename T, typename OopClosureType>
123 inline void oop_oop_iterate(oop obj, OopClosureType* closure);
124
125 // Iterate over oop elements and metadata.
126 template <typename T, typename OopClosureType>
127 inline void oop_oop_iterate_reverse(oop obj, OopClosureType* closure);
128
129 // Iterate over oop elements within mr, and metadata.
130 template <typename T, typename OopClosureType>
131 inline void oop_oop_iterate_bounded(oop obj, OopClosureType* closure, MemRegion mr);
132
133 // Iterate over oop elements within [start, end), and metadata.
134 template <typename T, class OopClosureType>
135 inline void oop_oop_iterate_range(objArrayOop a, OopClosureType* closure, int start, int end);
136
137 public:
138 // Iterate over all oop elements.
139 template <typename T, class OopClosureType>
140 inline void oop_oop_iterate_elements(objArrayOop a, OopClosureType* closure);
141
142 private:
143 // Iterate over all oop elements with indices within mr.
144 template <typename T, class OopClosureType>
145 inline void oop_oop_iterate_elements_bounded(objArrayOop a, OopClosureType* closure, void* low, void* high);
146
147 template <typename T, class OopClosureType>
148 inline void oop_oop_iterate_elements_bounded(objArrayOop a, OopClosureType* closure, MemRegion mr);
149
150 public:
151 // JVM support
152 jint compute_modifier_flags(TRAPS) const;
153
154 public:
155 // Printing
156 void print_on(outputStream* st) const;
157 void print_value_on(outputStream* st) const;
158
159 void oop_print_value_on(oop obj, outputStream* st);
160 #ifndef PRODUCT
161 void oop_print_on (oop obj, outputStream* st);
162 #endif //PRODUCT
163
164 const char* internal_name() const;
165
166 // Verification
167 void verify_on(outputStream* st);
168
169 void oop_verify_on(oop obj, outputStream* st);
170 };
171
172 #endif // SHARE_OOPS_OBJARRAYKLASS_HPP