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_CIOBJECTFACTORY_HPP
26 #define SHARE_CI_CIOBJECTFACTORY_HPP
27
28 #include "ci/ciClassList.hpp"
29 #include "ci/ciObject.hpp"
30 #include "utilities/growableArray.hpp"
31 #include "utilities/vmEnums.hpp"
32
33 // ciObjectFactory
34 //
35 // This class handles requests for the creation of new instances
36 // of ciObject and its subclasses. It contains a caching mechanism
37 // which ensures that for each oop, at most one ciObject is created.
38 // This invariant allows efficient implementation of ciObject.
39 class ciObjectFactory : public ArenaObj {
40 friend class ciEnv;
41
42 private:
43 static volatile bool _initialized;
44 static GrowableArray<ciMetadata*>* _shared_ci_metadata;
45 static ciSymbol* _shared_ci_symbols[];
46 static int _shared_ident_limit;
47
48 Arena* _arena;
49 GrowableArray<ciMetadata*> _ci_metadata;
50 GrowableArray<ciMethod*> _unloaded_methods;
51 GrowableArray<ciKlass*> _unloaded_klasses;
52 GrowableArray<ciInstance*> _unloaded_instances;
53 GrowableArray<ciReturnAddress*> _return_addresses;
54 GrowableArray<ciSymbol*> _symbols; // keep list of symbols created
55 int _next_ident;
56
57 public:
58 struct NonPermObject : public ArenaObj {
59 ciObject* _object;
60 NonPermObject* _next;
61
62 inline NonPermObject(NonPermObject* &bucket, oop key, ciObject* object);
63 ciObject* object() { return _object; }
64 NonPermObject* &next() { return _next; }
65 };
66 private:
67 enum { NON_PERM_BUCKETS = 61 };
68 NonPermObject* _non_perm_bucket[NON_PERM_BUCKETS];
69 int _non_perm_count;
70
71 static int metadata_compare(Metadata* const& key, ciMetadata* const& elt);
72
73 ciObject* create_new_object(oop o);
74 ciMetadata* create_new_metadata(Metadata* o);
75
76 static bool is_equal(NonPermObject* p, oop key) {
77 return p->object()->get_oop() == key;
78 }
79
80 NonPermObject* &find_non_perm(oop key);
81 void insert_non_perm(NonPermObject* &where, oop key, ciObject* obj);
82
83 void init_ident_of(ciBaseObject* obj);
84
85 Arena* arena() { return _arena; }
86
87 void print_contents_impl();
88
89 ciInstance* get_unloaded_instance(ciInstanceKlass* klass);
90
91 public:
92 static bool is_initialized() { return _initialized; }
93
94 static void initialize();
95 void init_shared_objects();
96 void remove_symbols();
97
98 ciObjectFactory(Arena* arena, int expected_size);
99
100 // Get the ciObject corresponding to some oop.
101 ciObject* get(oop key);
102 ciMetadata* get_metadata(Metadata* key);
103 ciMetadata* cached_metadata(Metadata* key);
104 ciSymbol* get_symbol(Symbol* key);
105
106 // Get the ciSymbol corresponding to one of the vmSymbols.
107 static ciSymbol* vm_symbol_at(vmSymbolID index);
108
109 // Get the ciMethod representing an unloaded/unfound method.
110 ciMethod* get_unloaded_method(ciInstanceKlass* holder,
111 ciSymbol* name,
112 ciSymbol* signature,
113 ciInstanceKlass* accessor);
114
115 // Get a ciKlass representing an unloaded klass.
116 ciKlass* get_unloaded_klass(ciKlass* accessing_klass,
117 ciSymbol* name,
118 bool create_if_not_found);
119
120 // Get a ciInstance representing an unresolved klass mirror.
121 ciInstance* get_unloaded_klass_mirror(ciKlass* type);
122
123 // Get a ciInstance representing an unresolved method handle constant.
124 ciInstance* get_unloaded_method_handle_constant(ciKlass* holder,
125 ciSymbol* name,
126 ciSymbol* signature,
127 int ref_kind);
128
129 // Get a ciInstance representing an unresolved method type constant.
130 ciInstance* get_unloaded_method_type_constant(ciSymbol* signature);
131
132
133 ciInstance* get_unloaded_object_constant();
134
135 // Get the ciMethodData representing the methodData for a method
136 // with none.
137 ciMethodData* get_empty_methodData();
138
139 ciReturnAddress* get_return_address(int bci);
140
141 GrowableArray<ciMetadata*>* get_ci_metadata() { return &_ci_metadata; }
142 // RedefineClasses support
143 void metadata_do(MetadataClosure* f);
144
145 void print_contents();
146 void print();
147 };
148
149 #endif // SHARE_CI_CIOBJECTFACTORY_HPP