1 /*
2 * Copyright (c) 1997, 2017, 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_VM_OOPS_ARRAYKLASS_HPP
26 #define SHARE_VM_OOPS_ARRAYKLASS_HPP
27
28 #include "memory/universe.hpp"
29 #include "oops/klass.hpp"
30
31 class fieldDescriptor;
32 class klassVtable;
33
34 // ArrayKlass is the abstract baseclass for all array classes
35
36 class ArrayKlass: public Klass {
37 friend class VMStructs;
38 private:
39 int _dimension; // This is n'th-dimensional array.
40 Klass* volatile _higher_dimension; // Refers the (n+1)'th-dimensional array (if present).
41 Klass* volatile _lower_dimension; // Refers the (n-1)'th-dimensional array (if present).
42
43 protected:
44 Klass* _element_klass; // The klass of the elements of this array type
45 // The element type must be registered for both object arrays
46 // (incl. object arrays with value type elements) and value type
47 // arrays containing flattened value types. However, the element
48 // type must not be registered for arrays of primitive types.
49 // TODO: Update the class hierarchy so that element klass appears
50 // only in array that contain non-primitive types.
51 // Constructors
52 // The constructor with the Symbol argument does the real array
53 // initialization, the other is a dummy
54 ArrayKlass(Symbol* name);
55 ArrayKlass() { assert(DumpSharedSpaces || UseSharedSpaces, "only for cds"); }
56
57 // Create array_name for element klass, creates a permanent symbol, returns result
58 static Symbol* create_element_klass_array_name(Klass* element_klass, TRAPS);
59
60 public:
61 // Instance variables
62 virtual Klass* element_klass() const { return _element_klass; }
63 virtual void set_element_klass(Klass* k) { _element_klass = k; }
64
65 // Compiler/Interpreter offset
66 static ByteSize element_klass_offset() { return in_ByteSize(offset_of(ArrayKlass, _element_klass)); }
67
68 // Testing operation
69 DEBUG_ONLY(bool is_array_klass_slow() const { return true; })
70
71 // Instance variables
72 int dimension() const { return _dimension; }
73 void set_dimension(int dimension) { _dimension = dimension; }
74
75 Klass* higher_dimension() const { return _higher_dimension; }
76 inline Klass* higher_dimension_acquire() const; // load with acquire semantics
77 void set_higher_dimension(Klass* k) { _higher_dimension = k; }
78 inline void release_set_higher_dimension(Klass* k); // store with release semantics
79 Klass** adr_higher_dimension() { return (Klass**)&this->_higher_dimension;}
80
81 Klass* lower_dimension() const { return _lower_dimension; }
82 void set_lower_dimension(Klass* k) { _lower_dimension = k; }
83 Klass** adr_lower_dimension() { return (Klass**)&this->_lower_dimension;}
84
85 // offset of first element, including any padding for the sake of alignment
86 int array_header_in_bytes() const { return layout_helper_header_size(layout_helper()); }
87 int log2_element_size() const { return layout_helper_log2_element_size(layout_helper()); }
88 // type of elements (T_OBJECT for both oop arrays and array-arrays)
89 BasicType element_type() const { return layout_helper_element_type(layout_helper()); }
90
91 virtual Klass* java_super() const;//{ return SystemDictionary::Object_klass(); }
92
93 // Allocation
94 // Sizes points to the first dimension of the array, subsequent dimensions
95 // are always in higher memory. The callers of these set that up.
96 virtual oop multi_allocate(int rank, jint* sizes, TRAPS);
97 objArrayOop allocate_arrayArray(int n, int length, TRAPS);
98
99 // find field according to JVM spec 5.4.3.2, returns the klass in which the field is defined
100 Klass* find_field(Symbol* name, Symbol* sig, fieldDescriptor* fd) const;
101
102 // Lookup operations
103 Method* uncached_lookup_method(const Symbol* name,
104 const Symbol* signature,
105 OverpassLookupMode overpass_mode) const;
106
107 static ArrayKlass* cast(Klass* k) {
108 return const_cast<ArrayKlass*>(cast(const_cast<const Klass*>(k)));
109 }
110
111 static const ArrayKlass* cast(const Klass* k) {
112 assert(k->is_array_klass(), "cast to ArrayKlass");
113 return static_cast<const ArrayKlass*>(k);
114 }
115
116 GrowableArray<Klass*>* compute_secondary_supers(int num_extra_slots);
117 bool compute_is_subtype_of(Klass* k);
118
119 // Sizing
120 static int static_size(int header_size);
121
122 #if INCLUDE_SERVICES
123 virtual void collect_statistics(KlassSizeStats *sz) const {
124 Klass::collect_statistics(sz);
125 // Do nothing for now, but remember to modify if you add new
126 // stuff to ArrayKlass.
127 }
128 #endif
129
130 // Iterators
131 void array_klasses_do(void f(Klass* k));
132 void array_klasses_do(void f(Klass* k, TRAPS), TRAPS);
133
134 // Return a handle.
135 static void complete_create_array_klass(ArrayKlass* k, Klass* super_klass, ModuleEntry* module, TRAPS);
136
137
138 // jvm support
139 jint compute_modifier_flags(TRAPS) const;
140
141 // JVMTI support
142 jint jvmti_class_status() const;
143
144 // CDS support - remove and restore oops from metadata. Oops are not shared.
145 virtual void remove_unshareable_info();
146 virtual void restore_unshareable_info(ClassLoaderData* loader_data, Handle protection_domain, TRAPS);
147
148 // Printing
149 void print_on(outputStream* st) const;
150 void print_value_on(outputStream* st) const;
151
152 void oop_print_on(oop obj, outputStream* st);
153
154 // Verification
155 void verify_on(outputStream* st);
156
157 void oop_verify_on(oop obj, outputStream* st);
158 };
159
160 // Array oop iteration macros for declarations.
161 // Used to generate the declarations in the *ArrayKlass header files.
162
163 #define OOP_OOP_ITERATE_DECL_RANGE(OopClosureType, nv_suffix) \
164 void oop_oop_iterate_range##nv_suffix(oop obj, OopClosureType* closure, int start, int end);
165
166 #if INCLUDE_ALL_GCS
167 // Named NO_BACKWARDS because the definition used by *ArrayKlass isn't reversed, see below.
168 #define OOP_OOP_ITERATE_DECL_NO_BACKWARDS(OopClosureType, nv_suffix) \
169 void oop_oop_iterate_backwards##nv_suffix(oop obj, OopClosureType* closure);
170 #endif // INCLUDE_ALL_GCS
171
172
173 // Array oop iteration macros for definitions.
174 // Used to generate the definitions in the *ArrayKlass.inline.hpp files.
175
176 #define OOP_OOP_ITERATE_DEFN_RANGE(KlassType, OopClosureType, nv_suffix) \
177 \
178 void KlassType::oop_oop_iterate_range##nv_suffix(oop obj, OopClosureType* closure, int start, int end) { \
179 oop_oop_iterate_range<nvs_to_bool(nv_suffix)>(obj, closure, start, end); \
180 }
181
182 #if INCLUDE_ALL_GCS
183 #define OOP_OOP_ITERATE_DEFN_NO_BACKWARDS(KlassType, OopClosureType, nv_suffix) \
184 void KlassType::oop_oop_iterate_backwards##nv_suffix(oop obj, OopClosureType* closure) { \
185 /* No reverse implementation ATM. */ \
186 oop_oop_iterate<nvs_to_bool(nv_suffix)>(obj, closure); \
187 }
188 #else
189 #define OOP_OOP_ITERATE_DEFN_NO_BACKWARDS(KlassType, OopClosureType, nv_suffix)
190 #endif
191
192 #endif // SHARE_VM_OOPS_ARRAYKLASS_HPP