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