1 /*
2  * Copyright (c) 1997, 2014, 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_OBJARRAYKLASS_HPP
26 #define SHARE_VM_OOPS_OBJARRAYKLASS_HPP
27 
28 #include "classfile/classLoaderData.hpp"
29 #include "memory/specialized_oop_closures.hpp"
30 #include "oops/arrayKlass.hpp"
31 #include "utilities/macros.hpp"
32 
33 // ObjArrayKlass is the klass for objArrays
34 
35 class ObjArrayKlass : public ArrayKlass {
36   friend class VMStructs;
37  private:
38   Klass* _element_klass;            // The klass of the elements of this array type
39   Klass* _bottom_klass;             // The one-dimensional type (InstanceKlass or TypeArrayKlass)
40 
41   // Constructor
42   ObjArrayKlass(int n, KlassHandle element_klass, Symbol* name);
43   static ObjArrayKlass* allocate(ClassLoaderData* loader_data, int n, KlassHandle klass_handle, Symbol* name, TRAPS);
44  public:
45   // For dummy objects
ObjArrayKlass()46   ObjArrayKlass() {}
47 
48   // Instance variables
element_klass() const49   Klass* element_klass() const      { return _element_klass; }
set_element_klass(Klass * k)50   void set_element_klass(Klass* k)  { _element_klass = k; }
element_klass_addr()51   Klass** element_klass_addr()      { return &_element_klass; }
52 
bottom_klass() const53   Klass* bottom_klass() const       { return _bottom_klass; }
set_bottom_klass(Klass * k)54   void set_bottom_klass(Klass* k)   { _bottom_klass = k; }
bottom_klass_addr()55   Klass** bottom_klass_addr()       { return &_bottom_klass; }
56 
57   // Compiler/Interpreter offset
element_klass_offset()58   static ByteSize element_klass_offset() { return in_ByteSize(offset_of(ObjArrayKlass, _element_klass)); }
59 
60   // Dispatched operation
61   bool can_be_primary_super_slow() const;
62   GrowableArray<Klass*>* compute_secondary_supers(int num_extra_slots);
63   bool compute_is_subtype_of(Klass* k);
oop_is_objArray_slow() const64   bool oop_is_objArray_slow()  const  { return true; }
65   int oop_size(oop obj) const;
66 
67   // Allocation
68   static Klass* allocate_objArray_klass(ClassLoaderData* loader_data,
69                                           int n, KlassHandle element_klass, TRAPS);
70 
71   objArrayOop allocate(int length, TRAPS);
72   oop multi_allocate(int rank, jint* sizes, TRAPS);
73 
74   // Copying
75   void  copy_array(arrayOop s, int src_pos, arrayOop d, int dst_pos, int length, TRAPS);
76 
77   // Compute protection domain
protection_domain() const78   oop protection_domain() const { return bottom_klass()->protection_domain(); }
79 
80  private:
81   // Either oop or narrowOop depending on UseCompressedOops.
82   // must be called from within ObjArrayKlass.cpp
83   template <class T> void do_copy(arrayOop s, T* src, arrayOop d,
84                                   T* dst, int length, TRAPS);
85  protected:
86   // Returns the ObjArrayKlass for n'th dimension.
87   virtual Klass* array_klass_impl(bool or_null, int n, TRAPS);
88 
89   // Returns the array class with this class as element type.
90   virtual Klass* array_klass_impl(bool or_null, TRAPS);
91 
92  public:
93   // Casting from Klass*
cast(Klass * k)94   static ObjArrayKlass* cast(Klass* k) {
95     assert(k->oop_is_objArray(), "cast to ObjArrayKlass");
96     return (ObjArrayKlass*) k;
97   }
98 
99   // Sizing
header_size()100   static int header_size()                { return sizeof(ObjArrayKlass)/HeapWordSize; }
size() const101   int size() const                        { return ArrayKlass::static_size(header_size()); }
102 
103   // Initialization (virtual from Klass)
104   void initialize(TRAPS);
105 
106   // Garbage collection
107   void oop_follow_contents(oop obj);
108   inline void oop_follow_contents(oop obj, int index);
109   template <class T> inline void objarray_follow_contents(oop obj, int index);
110 
111   int  oop_adjust_pointers(oop obj);
112 
113   // Parallel Scavenge and Parallel Old
114   PARALLEL_GC_DECLS
115 #if INCLUDE_ALL_GCS
116   inline void oop_follow_contents(ParCompactionManager* cm, oop obj, int index);
117   template <class T> inline void
118     objarray_follow_contents(ParCompactionManager* cm, oop obj, int index);
119 #endif // INCLUDE_ALL_GCS
120 
121   // Iterators
oop_oop_iterate(oop obj,ExtendedOopClosure * blk)122   int oop_oop_iterate(oop obj, ExtendedOopClosure* blk) {
123     return oop_oop_iterate_v(obj, blk);
124   }
oop_oop_iterate_m(oop obj,ExtendedOopClosure * blk,MemRegion mr)125   int oop_oop_iterate_m(oop obj, ExtendedOopClosure* blk, MemRegion mr) {
126     return oop_oop_iterate_v_m(obj, blk, mr);
127   }
128 #define ObjArrayKlass_OOP_OOP_ITERATE_DECL(OopClosureType, nv_suffix)   \
129   int oop_oop_iterate##nv_suffix(oop obj, OopClosureType* blk);         \
130   int oop_oop_iterate##nv_suffix##_m(oop obj, OopClosureType* blk,      \
131                                      MemRegion mr);                     \
132   int oop_oop_iterate_range##nv_suffix(oop obj, OopClosureType* blk,    \
133                                      int start, int end);
134 
135   ALL_OOP_OOP_ITERATE_CLOSURES_1(ObjArrayKlass_OOP_OOP_ITERATE_DECL)
136   ALL_OOP_OOP_ITERATE_CLOSURES_2(ObjArrayKlass_OOP_OOP_ITERATE_DECL)
137 
138   // JVM support
139   jint compute_modifier_flags(TRAPS) const;
140 
141  public:
142   // Printing
143   void print_on(outputStream* st) const;
144   void print_value_on(outputStream* st) const;
145 
146   void oop_print_value_on(oop obj, outputStream* st);
147 #ifndef PRODUCT
148   void oop_print_on      (oop obj, outputStream* st);
149 #endif //PRODUCT
150 
151   const char* internal_name() const;
152 
153   // Verification
154   void verify_on(outputStream* st);
155 
156   void oop_verify_on(oop obj, outputStream* st);
157 };
158 
159 #endif // SHARE_VM_OOPS_OBJARRAYKLASS_HPP
160