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