-
Notifications
You must be signed in to change notification settings - Fork 393
/
OMRClassEnv.hpp
201 lines (173 loc) · 8.53 KB
/
OMRClassEnv.hpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
/*******************************************************************************
* Copyright (c) 2000, 2021 IBM Corp. and others
*
* This program and the accompanying materials are made available under
* the terms of the Eclipse Public License 2.0 which accompanies this
* distribution and is available at http://eclipse.org/legal/epl-2.0
* or the Apache License, Version 2.0 which accompanies this distribution
* and is available at https://www.apache.org/licenses/LICENSE-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License, v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception [1] and GNU General Public
* License, version 2 with the OpenJDK Assembly Exception [2].
*
* [1] https://www.gnu.org/software/classpath/license.html
* [2] http://openjdk.java.net/legal/assembly-exception.html
*
* SPDX-License-Identifier: EPL-2.0 OR Apache-2.0 OR GPL-2.0 WITH Classpath-exception-2.0 OR LicenseRef-GPL-2.0 WITH Assembly-exception
*******************************************************************************/
#ifndef OMR_CLASSENV_INCL
#define OMR_CLASSENV_INCL
/*
* The following #define and typedef must appear before any #includes in this file
*/
#ifndef OMR_CLASSENV_CONNECTOR
#define OMR_CLASSENV_CONNECTOR
namespace OMR { class ClassEnv; }
namespace OMR { typedef OMR::ClassEnv ClassEnvConnector; }
#endif
#include <stdint.h>
#include "infra/Annotations.hpp"
#include "env/jittypes.h"
#include "env/TRMemory.hpp"
struct OMR_VMThread;
namespace TR { class ClassEnv; }
namespace TR { class Compilation; }
namespace TR { class SymbolReference; }
namespace TR { class TypeLayout; }
namespace TR { class Region; }
class TR_ResolvedMethod;
class TR_Memory;
class TR_PersistentClassInfo;
template <typename ListKind> class List;
namespace OMR
{
class OMR_EXTENSIBLE ClassEnv
{
public:
TR::ClassEnv *self();
// Are classes allocated on the object heap?
//
bool classesOnHeap() { return false; }
// Can class objects be collected by a garbage collector?
//
bool classObjectsMayBeCollected() { return true; }
// Depth of a class from the base class in a hierarchy.
//
uintptr_t classDepthOf(TR_OpaqueClassBlock *clazzPointer) { return 0; }
// Is specified class a string class?
//
bool isStringClass(TR_OpaqueClassBlock *clazz) { return false; }
// Is specified object a string class?
//
bool isStringClass(uintptr_t objectPointer) { return false; }
// Class of specified object address
//
TR_OpaqueClassBlock *classOfObject(OMR_VMThread *vmThread, uintptr_t objectPointer) { return NULL; }
TR_OpaqueClassBlock *classOfObject(TR::Compilation *comp, uintptr_t objectPointer) { return NULL; }
bool isAbstractClass(TR::Compilation *comp, TR_OpaqueClassBlock *clazzPointer) { return false; }
bool isInterfaceClass(TR::Compilation *comp, TR_OpaqueClassBlock *clazzPointer) { return false; }
bool isConcreteClass(TR::Compilation *comp, TR_OpaqueClassBlock *clazzPointer) { return true; }
bool isPrimitiveClass(TR::Compilation *comp, TR_OpaqueClassBlock *clazz) { return false; }
bool isAnonymousClass(TR::Compilation *comp, TR_OpaqueClassBlock *clazz) { return false; }
bool isValueTypeClass(TR_OpaqueClassBlock *) { return false; }
/**
* \brief
* Checks whether instances of the specified class can be trivially initialized by
* "zeroing" their fields
*
* \param clazz
* The class that is to be checked
*
* \return
* `true` if instances of the specified class can be initialized by zeroing their fields;
* `false` otherwise (if some special initialization is required for some fields)
*/
bool isZeroInitializable(TR_OpaqueClassBlock *clazz) { return true; }
bool isPrimitiveArray(TR::Compilation *comp, TR_OpaqueClassBlock *) { return false; }
bool isReferenceArray(TR::Compilation *comp, TR_OpaqueClassBlock *) { return false; }
bool isClassArray(TR::Compilation *comp, TR_OpaqueClassBlock *) { return false; }
bool isClassFinal(TR::Compilation *comp, TR_OpaqueClassBlock *) { return false; }
bool hasFinalizer(TR::Compilation *comp, TR_OpaqueClassBlock *classPointer) { return false; }
bool isClassInitialized(TR::Compilation *comp, TR_OpaqueClassBlock *) { return false; }
bool hasFinalFieldsInClass(TR::Compilation *comp, TR_OpaqueClassBlock *classPointer) { return false; }
bool sameClassLoaders(TR::Compilation *comp, TR_OpaqueClassBlock *, TR_OpaqueClassBlock *) { return false; }
bool isString(TR::Compilation *comp, TR_OpaqueClassBlock *clazz) { return false; }
bool isString(TR::Compilation *comp, uintptr_t objectPointer) { return false; }
bool jitStaticsAreSame(TR::Compilation *comp, TR_ResolvedMethod * method1, int32_t cpIndex1, TR_ResolvedMethod * method2, int32_t cpIndex2) { return false; }
bool jitFieldsAreSame(TR::Compilation *comp, TR_ResolvedMethod * method1, int32_t cpIndex1, TR_ResolvedMethod * method2, int32_t cpIndex2, int32_t isStatic) { return false; }
uintptr_t getArrayElementWidthInBytes(TR::Compilation *comp, TR_OpaqueClassBlock* arrayClass);
uintptr_t persistentClassPointerFromClassPointer(TR::Compilation *comp, TR_OpaqueClassBlock *clazz) { return 0; }
TR_OpaqueClassBlock *objectClass(TR::Compilation *comp, uintptr_t objectPointer) { return NULL; }
TR_OpaqueClassBlock *classFromJavaLangClass(TR::Compilation *comp, uintptr_t objectPointer) { return NULL; }
// 0 <= index < getStringLength
uint16_t getStringCharacter(TR::Compilation *comp, uintptr_t objectPointer, int32_t index) { return 0; }
bool getStringFieldByName(TR::Compilation *, TR::SymbolReference *stringRef, TR::SymbolReference *fieldRef, void* &pResult) { return false; }
int32_t vTableSlot(TR::Compilation *comp, TR_OpaqueMethodBlock *, TR_OpaqueClassBlock *) { return 0; }
int32_t flagValueForPrimitiveTypeCheck(TR::Compilation *comp) { return 0; }
int32_t flagValueForArrayCheck(TR::Compilation *comp) { return 0; }
int32_t flagValueForFinalizerCheck(TR::Compilation *comp) { return 0; }
char *classNameChars(TR::Compilation *, TR::SymbolReference *symRef, int32_t & length);
char *classNameChars(TR::Compilation *, TR_OpaqueClassBlock * clazz, int32_t & length) { return NULL; }
char *classSignature_DEPRECATED(TR::Compilation *comp, TR_OpaqueClassBlock * clazz, int32_t & length, TR_Memory *) { return NULL; }
char *classSignature(TR::Compilation *comp, TR_OpaqueClassBlock * clazz, TR_Memory *) { return NULL; }
/**
* \brief
* Constructs a class signature char string based on the class name
*
* \param[in] name
* The class name
*
* \param[in,out] len
* The input is the length of the class name. Returns the length of the signature
*
* \param[in] comp
* The compilation object
*
* \param[in] allocKind
* The type of the memory allocation
*
* \param[in] clazz
* The class that the class name belongs to
*
* \return
* A class signature char string
*/
char *classNameToSignature(const char *name, int32_t &len, TR::Compilation *comp, TR_AllocationKind allocKind = stackAlloc, TR_OpaqueClassBlock *clazz = NULL);
/**
* Get the virtual function table entry at a specific offset from the class
*
* @param clazz The RAM class pointer to read from
* @param offset An offset into the virtual function table (VFT) of clazz
* @return The entry point of the method at the given offset
*/
intptr_t getVFTEntry(TR::Compilation *comp, TR_OpaqueClassBlock* clazz, int32_t offset);
bool classUnloadAssumptionNeedsRelocation(TR::Compilation *comp);
/** \brief
* Populates a TypeLayout object.
*
* \param region
* The region used to allocate TypeLayout.
*
* \param opaqueClazz
* Class of the type whose layout needs to be populated.
*
* \return
* Returns a NULL pointer.
*/
const TR::TypeLayout* enumerateFields(TR::Region& region, TR_OpaqueClassBlock * clazz, TR::Compilation *comp) { return NULL; }
/**
* @brief Determine if a list of classes contains less than two concrete classes.
* A class is considered concrete if it is not an interface or an abstract class
*
* @param subClasses List of subclasses to be checked.
*
* @return Returns 'true' if the given list of classes contains less than
* 2 concrete classes and false otherwise.
*/
bool containsZeroOrOneConcreteClass(TR::Compilation *comp, List<TR_PersistentClassInfo>* subClasses);
};
}
#endif