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