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