1 /*
2 * Copyright (c) 1997, 2015, 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 int _vtable_len; // size of vtable for this klass
43
44 protected:
45 // Constructors
46 // The constructor with the Symbol argument does the real array
47 // initialization, the other is a dummy
48 ArrayKlass(Symbol* name);
49 ArrayKlass() { assert(DumpSharedSpaces || UseSharedSpaces, "only for cds"); }
50
51 public:
52 // Testing operation
53 bool oop_is_array_slow() const { return true; }
54
55 // Instance variables
56 int dimension() const { return _dimension; }
57 void set_dimension(int dimension) { _dimension = dimension; }
58
59 Klass* higher_dimension() const { return _higher_dimension; }
60 void set_higher_dimension(Klass* k) { _higher_dimension = k; }
61 Klass** adr_higher_dimension() { return (Klass**)&this->_higher_dimension;}
62
63 Klass* lower_dimension() const { return _lower_dimension; }
64 void set_lower_dimension(Klass* k) { _lower_dimension = k; }
65 Klass** adr_lower_dimension() { return (Klass**)&this->_lower_dimension;}
66
67 // offset of first element, including any padding for the sake of alignment
68 int array_header_in_bytes() const { return layout_helper_header_size(layout_helper()); }
69 int log2_element_size() const { return layout_helper_log2_element_size(layout_helper()); }
70 // type of elements (T_OBJECT for both oop arrays and array-arrays)
71 BasicType element_type() const { return layout_helper_element_type(layout_helper()); }
72
73 virtual Klass* java_super() const;//{ return SystemDictionary::Object_klass(); }
74
75 // Allocation
76 // Sizes points to the first dimension of the array, subsequent dimensions
77 // are always in higher memory. The callers of these set that up.
78 virtual oop multi_allocate(int rank, jint* sizes, TRAPS);
79 objArrayOop allocate_arrayArray(int n, int length, TRAPS);
80
81 // find field according to JVM spec 5.4.3.2, returns the klass in which the field is defined
82 Klass* find_field(Symbol* name, Symbol* sig, fieldDescriptor* fd) const;
83
84 // Lookup operations
85 Method* uncached_lookup_method(Symbol* name, Symbol* signature, OverpassLookupMode overpass_mode) const;
86
87 // Casting from Klass*
88 static ArrayKlass* cast(Klass* k) {
89 assert(k->oop_is_array(), "cast to ArrayKlass");
90 return (ArrayKlass*) k;
91 }
92
93 GrowableArray<Klass*>* compute_secondary_supers(int num_extra_slots);
94 bool compute_is_subtype_of(Klass* k);
95
96 // Sizing
97 static int header_size() { return sizeof(ArrayKlass)/HeapWordSize; }
98 static int static_size(int header_size);
99
100 #if INCLUDE_SERVICES
101 virtual void collect_statistics(KlassSizeStats *sz) const {
102 Klass::collect_statistics(sz);
103 // Do nothing for now, but remember to modify if you add new
104 // stuff to ArrayKlass.
105 }
106 #endif
107
108 // Java vtable
109 klassVtable* vtable() const; // return new klassVtable
110 int vtable_length() const { return _vtable_len; }
111 static int base_vtable_length() { return Universe::base_vtable_size(); }
112 void set_vtable_length(int len) { assert(len == base_vtable_length(), "bad length"); _vtable_len = len; }
113 protected:
114 inline intptr_t* start_of_vtable() const;
115
116 public:
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, KlassHandle super_klass, 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 restore_unshareable_info(ClassLoaderData* loader_data, Handle protection_domain, TRAPS);
134
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 // Array oop iteration macros for declarations.
148 // Used to generate the declarations in the *ArrayKlass header files.
149
150 #define OOP_OOP_ITERATE_DECL_RANGE(OopClosureType, nv_suffix) \
151 int oop_oop_iterate_range##nv_suffix(oop obj, OopClosureType* closure, int start, int end);
152
153 #if INCLUDE_ALL_GCS
154 // Named NO_BACKWARDS because the definition used by *ArrayKlass isn't reversed, see below.
155 #define OOP_OOP_ITERATE_DECL_NO_BACKWARDS(OopClosureType, nv_suffix) \
156 int oop_oop_iterate_backwards##nv_suffix(oop obj, OopClosureType* closure);
157 #endif // INCLUDE_ALL_GCS
158
159
160 // Array oop iteration macros for definitions.
161 // Used to generate the definitions in the *ArrayKlass.inline.hpp files.
162
163 #define OOP_OOP_ITERATE_DEFN_RANGE(KlassType, OopClosureType, nv_suffix) \
164 \
165 int KlassType::oop_oop_iterate_range##nv_suffix(oop obj, OopClosureType* closure, int start, int end) { \
166 return oop_oop_iterate_range<nvs_to_bool(nv_suffix)>(obj, closure, start, end); \
167 }
168
169 #if INCLUDE_ALL_GCS
170 #define OOP_OOP_ITERATE_DEFN_NO_BACKWARDS(KlassType, OopClosureType, nv_suffix) \
171 int KlassType::oop_oop_iterate_backwards##nv_suffix(oop obj, OopClosureType* closure) { \
172 /* No reverse implementation ATM. */ \
173 return oop_oop_iterate<nvs_to_bool(nv_suffix)>(obj, closure); \
174 }
175 #else
176 #define OOP_OOP_ITERATE_DEFN_NO_BACKWARDS(KlassType, OopClosureType, nv_suffix)
177 #endif
178
179 #endif // SHARE_VM_OOPS_ARRAYKLASS_HPP