1 /*
2 * Copyright (c) 2011, 2023, 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_OOPS_INSTANCEMIRRORKLASS_HPP
26 #define SHARE_OOPS_INSTANCEMIRRORKLASS_HPP
27
28 #include "classfile/vmClasses.hpp"
29 #include "oops/instanceKlass.hpp"
30 #include "runtime/handles.hpp"
31 #include "utilities/macros.hpp"
32
33 class ClassFileParser;
34
35 // An InstanceMirrorKlass is a specialized InstanceKlass for
36 // java.lang.Class instances. These instances are special because
37 // they contain the static fields of the class in addition to the
38 // normal fields of Class. This means they are variable sized
39 // instances and need special logic for computing their size and for
40 // iteration of their oops.
41
42
43 class InstanceMirrorKlass: public InstanceKlass {
44 friend class VMStructs;
45 friend class InstanceKlass;
46
47 public:
48 static const KlassKind Kind = InstanceMirrorKlassKind;
49
50 private:
51 static int _offset_of_static_fields;
52
53 InstanceMirrorKlass(const ClassFileParser& parser) : InstanceKlass(parser, Kind) {}
54
55 public:
56 InstanceMirrorKlass();
57
58 static InstanceMirrorKlass* cast(Klass* k) {
59 return const_cast<InstanceMirrorKlass*>(cast(const_cast<const Klass*>(k)));
60 }
61
62 static const InstanceMirrorKlass* cast(const Klass* k) {
63 assert(k->is_mirror_instance_klass(), "cast to InstanceMirrorKlass");
64 return static_cast<const InstanceMirrorKlass*>(k);
65 }
66
67 // Returns the size of the instance including the extra static fields.
68 virtual size_t oop_size(oop obj) const;
69
70 // Static field offset is an offset into the Heap, should be converted by
71 // based on UseCompressedOop for traversal
72 static HeapWord* start_of_static_fields(oop obj) {
73 return (HeapWord*)(cast_from_oop<intptr_t>(obj) + offset_of_static_fields());
74 }
75
76 static void init_offset_of_static_fields() {
77 // Cache the offset of the static fields in the Class instance
78 assert(_offset_of_static_fields == 0, "once");
79 _offset_of_static_fields = InstanceMirrorKlass::cast(vmClasses::Class_klass())->size_helper() << LogHeapWordSize;
80 }
81
82 static int offset_of_static_fields() {
83 return _offset_of_static_fields;
84 }
85
86 int compute_static_oop_field_count(oop obj);
87
88 // Given a Klass return the size of the instance
89 size_t instance_size(Klass* k);
90
91 // allocation
92 instanceOop allocate_instance(Klass* k, TRAPS);
93
94 static void serialize_offsets(class SerializeClosure* f) NOT_CDS_RETURN;
95
96 // Oop fields (and metadata) iterators
97 //
98 // The InstanceMirrorKlass iterators also visit the hidden Klass pointer.
99
100 // Iterate over the static fields.
101 template <typename T, class OopClosureType>
102 inline void oop_oop_iterate_statics(oop obj, OopClosureType* closure);
103
104 // Forward iteration
105 // Iterate over the oop fields and metadata.
106 template <typename T, class OopClosureType>
107 inline void oop_oop_iterate(oop obj, OopClosureType* closure);
108
109 // Reverse iteration
110 // Iterate over the oop fields and metadata.
111 template <typename T, class OopClosureType>
112 inline void oop_oop_iterate_reverse(oop obj, OopClosureType* closure);
113
114 // Bounded range iteration
115 // Iterate over the oop fields and metadata.
116 template <typename T, class OopClosureType>
117 inline void oop_oop_iterate_bounded(oop obj, OopClosureType* closure, MemRegion mr);
118
119 private:
120
121 // Iterate over the static fields.
122 template <typename T, class OopClosureType>
123 inline void oop_oop_iterate_statics_bounded(oop obj, OopClosureType* closure, MemRegion mr);
124 };
125
126 #endif // SHARE_OOPS_INSTANCEMIRRORKLASS_HPP