-
Notifications
You must be signed in to change notification settings - Fork 392
/
FunctionCallData.hpp
223 lines (203 loc) · 10.5 KB
/
FunctionCallData.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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
/*******************************************************************************
* Copyright (c) 2021, 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 TR_FUNCTIONCALLDATA_INCL
#define TR_FUNCTIONCALLDATA_INCL
#include "objectfmt/OMRFunctionCallData.hpp"
#include "infra/Annotations.hpp"
#include "runtime/Runtime.hpp"
namespace TR { class Instruction; }
namespace TR { class SymbolReference; }
namespace TR { class Node; }
namespace TR { class Register; }
namespace TR { class RegisterDependencyConditions; }
namespace TR { class CodeGenerator; }
namespace TR
{
class OMR_EXTENSIBLE FunctionCallData : public OMR::FunctionCallDataConnector
{
public:
/**
* APIs for non-helper function calls
*/
/**
* @param[in] cg : \c TR::CodeGenerator object
* @param[in] methodSymRef : \c TR::SymbolReference of the function to call
* @param[in] callNode : \c TR::Node this function call is associated with
* @param[in] scratchReg : a scratch register to use to emit the dispatch sequence
* @param[in] targetAddress : a specific function address to call that overrides the
* address in the symbol reference; or 0 if none
* @param[in] regDeps : \c TR::RegisterDependency structure for this call
* @param[in] reloKind : the external relocation kind associated with this function call
* @param[in] useSymInstruction : if true then use "Sym" form instructions that take a
* \c TR::SymbolReference; if false then use equivalent form instructions without
* the \c TR::SymbolReference parameter
* @param[in] adjustsFramePointerBy : if non-zero, the adjustment to be made to the internal
* virtual frame pointer by the instruction to perform the function call
* @param[in] useCall : if true, emit a call instruction; if false, emit a jump instruction
*/
FunctionCallData(
TR::CodeGenerator *cg,
TR::SymbolReference *methodSymRef,
TR::Node *callNode,
TR::Register *scratchReg,
uintptr_t targetAddress,
TR::RegisterDependencyConditions *regDeps,
int32_t reloKind,
bool useSymInstruction,
int32_t adjustsFramePointerBy,
bool useCall = true) :
OMR::FunctionCallDataConnector(cg, methodSymRef, callNode, scratchReg, targetAddress,
regDeps, (TR_RuntimeHelper)0, NULL, reloKind, adjustsFramePointerBy, useSymInstruction, NULL, useCall) {}
/**
* @param[in] cg : \c TR::CodeGenerator object
* @param[in] methodSymRef : \c TR::SymbolReference of the function to call
* @param[in] prevInstr : \c TR::Instruction of the previous instruction, if any
* @param[in] scratchReg : a scratch register to use to emit the dispatch sequence
* @param[in] targetAddress : a specific function address to call that overrides the
* address in the symbol reference; or 0 if none
* @param[in] regDeps : \c TR::RegisterDependency structure for this call
* @param[in] reloKind : the external relocation kind associated with this function call
* @param[in] useSymInstruction : if true then use "Sym" form instructions that take a
* \c TR::SymbolReference; if false then use equivalent form instructions without
* the \c TR::SymbolReference parameter
* @param[in] adjustsFramePointerBy : if non-zero, the adjustment to be made to the internal
* virtual frame pointer by the instruction to perform the function call
* @param[in] useCall : if true, emit a call instruction; if false, emit a jump instruction
*/
FunctionCallData(
TR::CodeGenerator *cg,
TR::SymbolReference *methodSymRef,
TR::Instruction *prevInstr,
TR::Register *scratchReg,
uintptr_t targetAddress,
TR::RegisterDependencyConditions *regDeps,
int32_t reloKind,
bool useSymInstruction,
int32_t adjustsFramePointerBy,
bool useCall = true) :
OMR::FunctionCallDataConnector(cg, methodSymRef, NULL, scratchReg, targetAddress,
regDeps, (TR_RuntimeHelper)0, prevInstr, reloKind, adjustsFramePointerBy, useSymInstruction, NULL, useCall) {}
/**
* @param[in] cg : \c TR::CodeGenerator object
* @param[in] methodSymRef : \c TR::SymbolReference of the function to call
* @param[in] callNode : \c TR::Node this function call is associated with
* @param[in] scratchReg : a scratch register to use to emit the dispatch sequence
* @param[in] targetAddress : a specific function address to call that overrides the
* address in the symbol reference; or 0 if none
* @param[in] regDeps : \c TR::RegisterDependency structure for this call
* @param[in] reloKind : the external relocation kind associated with this function call
* @param[in] useSymInstruction : if true then use "Sym" form instructions that take a
* \c TR::SymbolReference; if false then use equivalent form instructions without
* the \c TR::SymbolReference parameter
* @param[in] useCall : if true, emit a call instruction; if false, emit a jump instruction
*/
FunctionCallData(
TR::CodeGenerator *cg,
TR::SymbolReference *methodSymRef,
TR::Node *callNode,
TR::Register *scratchReg,
uintptr_t targetAddress,
TR::RegisterDependencyConditions *regDeps,
int32_t reloKind,
bool useSymInstruction,
bool useCall = true) :
OMR::FunctionCallDataConnector(cg, methodSymRef, callNode, scratchReg, targetAddress,
regDeps, (TR_RuntimeHelper)0, NULL, reloKind, 0, useSymInstruction, NULL, useCall) {}
/**
* @param[in] cg : \c TR::CodeGenerator object
* @param[in] methodSymRef : \c TR::SymbolReference of the function to call
* @param[in] prevInstr : \c TR::Instruction of the previous instruction, if any
* @param[in] scratchReg : a scratch register to use to emit the dispatch sequence
* @param[in] targetAddress : a specific function address to call that overrides the
* address in the symbol reference; or 0 if none
* @param[in] regDeps : \c TR::RegisterDependency structure for this call
* @param[in] reloKind : the external relocation kind associated with this function call
* @param[in] useSymInstruction : if true then use "Sym" form instructions that take a
* \c TR::SymbolReference; if false then use equivalent form instructions without
* the \c TR::SymbolReference parameter
* @param[in] useCall : if true, emit a call instruction; if false, emit a jump instruction
*/
FunctionCallData(
TR::CodeGenerator *cg,
TR::SymbolReference *methodSymRef,
TR::Instruction *prevInstr,
TR::Register *scratchReg,
uintptr_t targetAddress,
TR::RegisterDependencyConditions *regDeps,
int32_t reloKind,
bool useSymInstruction,
bool useCall = true) :
OMR::FunctionCallDataConnector(cg, methodSymRef, NULL, scratchReg, targetAddress,
regDeps, (TR_RuntimeHelper)0, prevInstr, reloKind, 0, useSymInstruction, NULL, useCall) {}
/**
* APIs for helper function calls
*/
/**
* @param[in] cg : \c TR::CodeGenerator object
* @param[in] runtimeHelperIndex : the runtime helper index if calling a helper
* @param[in] callNode : \c TR::Node this function call is associated with
* @param[in] regDeps : \c TR::RegisterDependency structure for this call
* @param[in] useCall : if true, emit a call instruction; if false, emit a jump instruction
*/
FunctionCallData(
TR::CodeGenerator *cg,
TR_RuntimeHelper runtimeHelperIndex,
TR::Node *callNode,
TR::RegisterDependencyConditions *regDeps,
bool useCall = true) :
OMR::FunctionCallDataConnector(cg, NULL, callNode, NULL, 0,
regDeps, runtimeHelperIndex, NULL, TR_NoRelocation, 0, false, NULL, useCall) {}
/**
* @param[in] cg : \c TR::CodeGenerator object
* @param[in] runtimeHelperIndex : the runtime helper index if calling a helper
* @param[in] prevInstr : \c TR::Instruction of the previous instruction, if any
* @param[in] regDeps : \c TR::RegisterDependency structure for this call
* @param[in] useCall : if true, emit a call instruction; if false, emit a jump instruction
*/
FunctionCallData(
TR::CodeGenerator *cg,
TR_RuntimeHelper runtimeHelperIndex,
TR::Instruction *prevInstr,
TR::RegisterDependencyConditions *regDeps,
bool useCall = true) :
OMR::FunctionCallDataConnector(cg, NULL, NULL, NULL, 0,
regDeps, runtimeHelperIndex, prevInstr, TR_NoRelocation, 0, false, NULL, useCall) {}
/**
* APIs for function calls encoded from snippets
*/
/**
* @param[in] methodSymRef : \c TR::SymbolReference of the function to call
* @param[in] callNode : \c TR::Node this function call is associated with
* @param[in] bufferAddress : if non-zero, encode the function call at this address
* @param[in] cg : \c TR::CodeGenerator object
* @param[in] useCall : if true, emit a call instruction; if false, emit a jump instruction
*/
FunctionCallData(
TR::CodeGenerator *cg,
TR::SymbolReference *methodSymRef,
TR::Node *callNode,
uint8_t *bufferAddress,
bool useCall = true) :
OMR::FunctionCallDataConnector(cg, methodSymRef, callNode, NULL, 0, NULL,
(TR_RuntimeHelper)0, NULL, TR_NoRelocation, 0, false, bufferAddress, useCall) {}
};
}
#endif