arrayKlass.hpp revision 10159:832fc8bf51cb 
1/*
2 * Copyright (c) 1997, 2016, 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
31class fieldDescriptor;
32class klassVtable;
33
34// ArrayKlass is the abstract baseclass for all array classes
35
36class 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  DEBUG_ONLY(bool is_array_klass_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(const Symbol* name,
86                                 const Symbol* signature,
87                                 OverpassLookupMode overpass_mode) const;
88
89  static ArrayKlass* cast(Klass* k) {
90    return const_cast<ArrayKlass*>(cast(const_cast<const Klass*>(k)));
91  }
92
93  static const ArrayKlass* cast(const Klass* k) {
94    assert(k->is_array_klass(), "cast to ArrayKlass");
95    return static_cast<const ArrayKlass*>(k);
96  }
97
98  GrowableArray<Klass*>* compute_secondary_supers(int num_extra_slots);
99  bool compute_is_subtype_of(Klass* k);
100
101  // Sizing
102  static int header_size()                 { return sizeof(ArrayKlass)/wordSize; }
103  static int static_size(int header_size);
104
105#if INCLUDE_SERVICES
106  virtual void collect_statistics(KlassSizeStats *sz) const {
107    Klass::collect_statistics(sz);
108    // Do nothing for now, but remember to modify if you add new
109    // stuff to ArrayKlass.
110  }
111#endif
112
113  // Java vtable
114  klassVtable* vtable() const;             // return new klassVtable
115  int  vtable_length() const               { return _vtable_len; }
116  static int base_vtable_length()          { return Universe::base_vtable_size(); }
117  void set_vtable_length(int len)          { assert(len == base_vtable_length(), "bad length"); _vtable_len = len; }
118 protected:
119  inline intptr_t* start_of_vtable() const;
120
121 public:
122  // Iterators
123  void array_klasses_do(void f(Klass* k));
124  void array_klasses_do(void f(Klass* k, TRAPS), TRAPS);
125
126  // Return a handle.
127  static void     complete_create_array_klass(ArrayKlass* k, KlassHandle super_klass, TRAPS);
128
129
130  // jvm support
131  jint compute_modifier_flags(TRAPS) const;
132
133  // JVMTI support
134  jint jvmti_class_status() const;
135
136  // CDS support - remove and restore oops from metadata. Oops are not shared.
137  virtual void remove_unshareable_info();
138  virtual void restore_unshareable_info(ClassLoaderData* loader_data, Handle protection_domain, TRAPS);
139
140  // Printing
141  void print_on(outputStream* st) const;
142  void print_value_on(outputStream* st) const;
143
144  void oop_print_on(oop obj, outputStream* st);
145
146  // Verification
147  void verify_on(outputStream* st);
148
149  void oop_verify_on(oop obj, outputStream* st);
150};
151
152// Array oop iteration macros for declarations.
153// Used to generate the declarations in the *ArrayKlass header files.
154
155#define OOP_OOP_ITERATE_DECL_RANGE(OopClosureType, nv_suffix)                                   \
156  void oop_oop_iterate_range##nv_suffix(oop obj, OopClosureType* closure, int start, int end);
157
158#if INCLUDE_ALL_GCS
159// Named NO_BACKWARDS because the definition used by *ArrayKlass isn't reversed, see below.
160#define OOP_OOP_ITERATE_DECL_NO_BACKWARDS(OopClosureType, nv_suffix)            \
161  void oop_oop_iterate_backwards##nv_suffix(oop obj, OopClosureType* closure);
162#endif // INCLUDE_ALL_GCS
163
164
165// Array oop iteration macros for definitions.
166// Used to generate the definitions in the *ArrayKlass.inline.hpp files.
167
168#define OOP_OOP_ITERATE_DEFN_RANGE(KlassType, OopClosureType, nv_suffix)                                  \
169                                                                                                          \
170void KlassType::oop_oop_iterate_range##nv_suffix(oop obj, OopClosureType* closure, int start, int end) {  \
171  oop_oop_iterate_range<nvs_to_bool(nv_suffix)>(obj, closure, start, end);                                \
172}
173
174#if INCLUDE_ALL_GCS
175#define OOP_OOP_ITERATE_DEFN_NO_BACKWARDS(KlassType, OopClosureType, nv_suffix)           \
176void KlassType::oop_oop_iterate_backwards##nv_suffix(oop obj, OopClosureType* closure) {  \
177  /* No reverse implementation ATM. */                                                    \
178  oop_oop_iterate<nvs_to_bool(nv_suffix)>(obj, closure);                                  \
179}
180#else
181#define OOP_OOP_ITERATE_DEFN_NO_BACKWARDS(KlassType, OopClosureType, nv_suffix)
182#endif
183
184#endif // SHARE_VM_OOPS_ARRAYKLASS_HPP
185