1 /*
2 * Copyright (c) 1997, 2024, 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_ARRAYKLASS_HPP
26 #define SHARE_OOPS_ARRAYKLASS_HPP
27
28 #include "oops/klass.hpp"
29
30 class fieldDescriptor;
31 class klassVtable;
32 class ObjArrayKlass;
33
34 // ArrayKlass is the abstract baseclass for all array classes
35
36 class ArrayKlass: public Klass {
37 friend class VMStructs;
38 private:
39 // If you add a new field that points to any metaspace object, you
40 // must add this field to ArrayKlass::metaspace_pointers_do().
41 int _dimension; // This is n'th-dimensional array.
42 ObjArrayKlass* volatile _higher_dimension; // Refers the (n+1)'th-dimensional array (if present).
43 ArrayKlass* volatile _lower_dimension; // Refers the (n-1)'th-dimensional array (if present).
44
45 protected:
46 // Constructors
47 // The constructor with the Symbol argument does the real array
48 // initialization, the other is a dummy
49 ArrayKlass(Symbol* name, KlassKind kind);
50 ArrayKlass();
51
52 void* operator new(size_t size, ClassLoaderData* loader_data, size_t word_size, TRAPS) throw();
53
54 public:
55 // Testing operation
56 DEBUG_ONLY(bool is_array_klass_slow() const { return true; })
57
58 // Returns the ObjArrayKlass for n'th dimension.
59 ArrayKlass* array_klass(int n, TRAPS);
60 ArrayKlass* array_klass_or_null(int n);
61
62 // Returns the array class with this class as element type.
63 ArrayKlass* array_klass(TRAPS);
64 ArrayKlass* array_klass_or_null();
65
66 // Instance variables
67 int dimension() const { return _dimension; }
68 void set_dimension(int dimension) { _dimension = dimension; }
69
70 ObjArrayKlass* higher_dimension() const { return _higher_dimension; }
71 inline ObjArrayKlass* higher_dimension_acquire() const; // load with acquire semantics
72 void set_higher_dimension(ObjArrayKlass* k) { _higher_dimension = k; }
73 inline void release_set_higher_dimension(ObjArrayKlass* k); // store with release semantics
74
75 ArrayKlass* lower_dimension() const { return _lower_dimension; }
76 void set_lower_dimension(ArrayKlass* k) { _lower_dimension = k; }
77
78 // offset of first element, including any padding for the sake of alignment
79 int array_header_in_bytes() const { return layout_helper_header_size(layout_helper()); }
80 int log2_element_size() const { return layout_helper_log2_element_size(layout_helper()); }
81 // type of elements (T_OBJECT for both oop arrays and array-arrays)
82 BasicType element_type() const { return layout_helper_element_type(layout_helper()); }
83
84 virtual InstanceKlass* java_super() const;
85
86 // Allocation
87 // Sizes points to the first dimension of the array, subsequent dimensions
88 // are always in higher memory. The callers of these set that up.
89 virtual oop multi_allocate(int rank, jint* sizes, TRAPS);
90 objArrayOop allocate_arrayArray(int n, int length, TRAPS);
91
92 // find field according to JVM spec 5.4.3.2, returns the klass in which the field is defined
93 Klass* find_field(Symbol* name, Symbol* sig, fieldDescriptor* fd) const;
94
95 // Lookup operations
96 Method* uncached_lookup_method(const Symbol* name,
97 const Symbol* signature,
98 OverpassLookupMode overpass_mode,
99 PrivateLookupMode private_mode = PrivateLookupMode::find) const;
100
101 static ArrayKlass* cast(Klass* k) {
102 return const_cast<ArrayKlass*>(cast(const_cast<const Klass*>(k)));
103 }
104
105 static const ArrayKlass* cast(const Klass* k) {
106 assert(k->is_array_klass(), "cast to ArrayKlass");
107 return static_cast<const ArrayKlass*>(k);
108 }
109
110 GrowableArray<Klass*>* compute_secondary_supers(int num_extra_slots,
111 Array<InstanceKlass*>* transitive_interfaces);
112
113 // Sizing
114 static int static_size(int header_size);
115
116 virtual void metaspace_pointers_do(MetaspaceClosure* iter);
117
118 // Return a handle.
119 static void complete_create_array_klass(ArrayKlass* k, Klass* super_klass, ModuleEntry* module, TRAPS);
120
121
122 // jvm support
123 jint compute_modifier_flags() const;
124
125 // JVMTI support
126 jint jvmti_class_status() const;
127
128 #if INCLUDE_CDS
129 // CDS support - remove and restore oops from metadata. Oops are not shared.
130 virtual void remove_unshareable_info();
131 virtual void remove_java_mirror();
132 void restore_unshareable_info(ClassLoaderData* loader_data, Handle protection_domain, TRAPS);
133 void cds_print_value_on(outputStream* st) const;
134 #endif
135
136 void log_array_class_load(Klass* k);
137 // Printing
138 void print_on(outputStream* st) const;
139 void print_value_on(outputStream* st) const;
140
141 void oop_print_on(oop obj, outputStream* st);
142
143 // Verification
144 void verify_on(outputStream* st);
145
146 void oop_verify_on(oop obj, outputStream* st);
147 };
148
149 #endif // SHARE_OOPS_ARRAYKLASS_HPP