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 Klass* bottom_klass() const { return _bottom_klass; }
54 void set_bottom_klass(Klass* k) { _bottom_klass = k; }
55 Klass** bottom_klass_addr() { return &_bottom_klass; }
56
57 ModuleEntry* module() const;
58 PackageEntry* package() const;
59
60 // Dispatched operation
61 bool can_be_primary_super_slow() const;
62 GrowableArray<Klass*>* compute_secondary_supers(int num_extra_slots,
63 Array<InstanceKlass*>* transitive_interfaces);
64 DEBUG_ONLY(bool is_objArray_klass_slow() const { return true; })
65 int oop_size(oop obj) const;
66
67 // Allocation
68 static Klass* allocate_objArray_klass(ClassLoaderData* loader_data,
69 int n, Klass* element_klass, TRAPS);
70
71 objArrayOop allocate(int length, TRAPS);
72 oop multi_allocate(int rank, jint* sizes, TRAPS);
73
74 // Copying
75 void copy_array(arrayOop s, int src_pos, arrayOop d, int dst_pos, int length, TRAPS);
76
77 // Compute protection domain
78 oop protection_domain() const { return bottom_klass()->protection_domain(); }
79
80 virtual void metaspace_pointers_do(MetaspaceClosure* iter);
81
82 private:
83 // Either oop or narrowOop depending on UseCompressedOops.
84 // must be called from within ObjArrayKlass.cpp
85 void do_copy(arrayOop s, size_t src_offset,
86 arrayOop d, size_t dst_offset,
87 int length, TRAPS);
88 protected:
89 // Returns the ObjArrayKlass for n'th dimension.
90 virtual Klass* array_klass_impl(bool or_null, int n, TRAPS);
91
92 // Returns the array class with this class as element type.
93 virtual Klass* array_klass_impl(bool or_null, TRAPS);
94
95 public:
96
97 static ObjArrayKlass* cast(Klass* k) {
98 return const_cast<ObjArrayKlass*>(cast(const_cast<const Klass*>(k)));
99 }
100
101 static const ObjArrayKlass* cast(const Klass* k) {
102 assert(k->is_objArray_klass(), "cast to ObjArrayKlass");
103 return static_cast<const ObjArrayKlass*>(k);
104 }
105
106 // Sizing
107 static int header_size() { return sizeof(ObjArrayKlass)/wordSize; }
108 int size() const { return ArrayKlass::static_size(header_size()); }
109
110 // Initialization (virtual from Klass)
111 void initialize(TRAPS);
112
113 // Oop fields (and metadata) iterators
114 //
115 // The ObjArrayKlass iterators also visits the Object's klass.
116
117 // Iterate over oop elements and metadata.
118 template <typename T, typename OopClosureType>
119 inline void oop_oop_iterate(oop obj, OopClosureType* closure);
120
121 // Iterate over oop elements and metadata.
122 template <typename T, typename OopClosureType>
123 inline void oop_oop_iterate_reverse(oop obj, OopClosureType* closure);
124
125 // Iterate over oop elements within mr, and metadata.
126 template <typename T, typename OopClosureType>
127 inline void oop_oop_iterate_bounded(oop obj, OopClosureType* closure, MemRegion mr);
128
129 // Iterate over oop elements within [start, end), and metadata.
130 template <typename T, class OopClosureType>
131 inline void oop_oop_iterate_range(objArrayOop a, OopClosureType* closure, int start, int end);
132
133 public:
134 // Iterate over all oop elements.
135 template <typename T, class OopClosureType>
136 inline void oop_oop_iterate_elements(objArrayOop a, OopClosureType* closure);
137
138 private:
139 // Iterate over all oop elements with indices within mr.
140 template <typename T, class OopClosureType>
141 inline void oop_oop_iterate_elements_bounded(objArrayOop a, OopClosureType* closure, void* low, void* high);
142
143 template <typename T, class OopClosureType>
144 inline void oop_oop_iterate_elements_bounded(objArrayOop a, OopClosureType* closure, MemRegion mr);
145
146 public:
147 // JVM support
148 jint compute_modifier_flags(TRAPS) const;
149
150 public:
151 // Printing
152 void print_on(outputStream* st) const;
153 void print_value_on(outputStream* st) const;
154
155 void oop_print_value_on(oop obj, outputStream* st);
156 #ifndef PRODUCT
157 void oop_print_on (oop obj, outputStream* st);
158 #endif //PRODUCT
159
160 const char* internal_name() const;
161
162 // Verification
163 void verify_on(outputStream* st);
164
165 void oop_verify_on(oop obj, outputStream* st);
166 };
167
168 #endif // SHARE_OOPS_OBJARRAYKLASS_HPP