1 /*
2 * Copyright (c) 1999, 2025, 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_CI_CIMETADATA_HPP
26 #define SHARE_CI_CIMETADATA_HPP
27
28 #include "ci/ciBaseObject.hpp"
29 #include "ci/ciClassList.hpp"
30 #include "runtime/handles.hpp"
31
32 // ciMetadata
33 //
34 // Compiler interface to metadata object in the VM, not Java object.
35
36 class ciMetadata: public ciBaseObject {
37 CI_PACKAGE_ACCESS
38 friend class ciEnv;
39
40 protected:
41 Metadata* _metadata;
42
43 ciMetadata(): _metadata(nullptr) {}
44 ciMetadata(Metadata* o): _metadata(o) {}
45
46 virtual bool is_classless() const;
47 public:
48 bool is_loaded() const { return _metadata != nullptr || is_classless(); }
49
50 virtual bool is_metadata() const { return true; }
51
52 virtual bool is_type() const { return false; }
53 virtual bool is_return_address() const { return false; }
54 virtual bool is_method() const { return false; }
55 virtual bool is_method_data() const { return false; }
56 virtual bool is_klass() const { return false; }
57 virtual bool is_instance_klass() const { return false; }
58 virtual bool is_inlinetype() const { return false; }
59 virtual bool is_array_klass() const { return false; }
60 virtual bool is_obj_array_klass() const { return false; }
61 virtual bool is_flat_array_klass() const { return false; }
62 virtual bool is_ref_array_klass() const { return false; }
63 virtual bool is_type_array_klass() const { return false; }
64 virtual bool is_early_larval() const { return false; }
65 virtual bool maybe_flat_in_array() const { return false; }
66 virtual void dump_replay_data(outputStream* st) { /* do nothing */ }
67
68 ciMethod* as_method() {
69 assert(is_method(), "bad cast");
70 return (ciMethod*)this;
71 }
72 ciMethodData* as_method_data() {
73 assert(is_method_data(), "bad cast");
74 return (ciMethodData*)this;
75 }
76 ciSymbol* as_symbol() {
77 assert(is_symbol(), "bad cast");
78 return (ciSymbol*)this;
79 }
80 ciType* as_type() {
81 assert(is_type(), "bad cast");
82 return (ciType*)this;
83 }
84 ciReturnAddress* as_return_address() {
85 assert(is_return_address(), "bad cast");
86 return (ciReturnAddress*)this;
87 }
88 ciKlass* as_klass() {
89 assert(is_klass(), "bad cast");
90 return (ciKlass*)this;
91 }
92 ciInstanceKlass* as_instance_klass() {
93 assert(is_instance_klass(), "bad cast");
94 return (ciInstanceKlass*)this;
95 }
96 ciArrayKlass* as_array_klass() {
97 assert(is_array_klass(), "bad cast");
98 return (ciArrayKlass*)this;
99 }
100 ciObjArrayKlass* as_obj_array_klass() {
101 assert(is_obj_array_klass(), "bad cast");
102 return (ciObjArrayKlass*)this;
103 }
104 ciFlatArrayKlass* as_flat_array_klass() {
105 assert(is_flat_array_klass(), "bad cast");
106 return (ciFlatArrayKlass*)this;
107 }
108 ciRefArrayKlass* as_ref_array_klass() {
109 assert(is_ref_array_klass(), "bad cast");
110 return (ciRefArrayKlass*)this;
111 }
112 ciTypeArrayKlass* as_type_array_klass() {
113 assert(is_type_array_klass(), "bad cast");
114 return (ciTypeArrayKlass*)this;
115 }
116 ciInlineKlass* as_inline_klass() {
117 assert(is_inlinetype(), "bad cast");
118 return (ciInlineKlass*)this;
119 }
120
121 Metadata* constant_encoding() { return _metadata; }
122
123 bool equals(const ciMetadata* obj) const { return (this == obj); }
124
125 uint hash() { return ident() * 31; } // ???
126
127 void print(outputStream* st);
128 virtual void print_impl(outputStream* st) {}
129 virtual const char* type_string() { return "ciMetadata"; }
130
131 void print() { print(tty); }
132 void print_metadata(outputStream* st = tty);
133
134 };
135 #endif // SHARE_CI_CIMETADATA_HPP