-
Notifications
You must be signed in to change notification settings - Fork 392
/
OMRLinkage.hpp
441 lines (374 loc) · 14.8 KB
/
OMRLinkage.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
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
/*******************************************************************************
* Copyright (c) 2019, 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_RV_LINKAGE_INCL
#define OMR_RV_LINKAGE_INCL
/*
* The following #define and typedef must appear before any #includes in this file
*/
#ifndef OMR_LINKAGE_CONNECTOR
#define OMR_LINKAGE_CONNECTOR
namespace OMR { namespace RV { class Linkage; } }
namespace OMR { typedef OMR::RV::Linkage LinkageConnector; }
#endif
#include "compiler/codegen/OMRLinkage.hpp"
#include <stddef.h>
#include <stdint.h>
#include "codegen/InstOpCode.hpp"
#include "codegen/RealRegister.hpp"
#include "codegen/Register.hpp"
#include "env/TRMemory.hpp"
class TR_FrontEnd;
namespace TR { class AutomaticSymbol; }
namespace TR { class CodeGenerator; }
namespace TR { class Compilation; }
namespace TR { class Instruction; }
namespace TR { class MemoryReference; }
namespace TR { class Node; }
namespace TR { class ParameterSymbol; }
namespace TR { class RegisterDependencyConditions; }
namespace TR { class ResolvedMethodSymbol; }
namespace TR {
class RVMemoryArgument
{
public:
// @@ TR_ALLOC(TR_Memory::RVMemoryArgument)
TR::Register *argRegister;
TR::MemoryReference *argMemory;
TR::InstOpCode::Mnemonic opCode;
};
// linkage properties
#define CallerCleanup 0x01
#define RightToLeft 0x02
#define IntegersInRegisters 0x04
#define LongsInRegisters 0x08
#define FloatsInRegisters 0x10
// register flags
#define Preserved 0x01
#define IntegerReturn 0x02
#define IntegerArgument 0x04
#define FloatReturn 0x08
#define FloatArgument 0x10
#define CallerAllocatesBackingStore 0x20
#define RV_Reserved 0x40
#define FOR_EACH_REGISTER(machine, block) \
for (int regNum = TR::RealRegister::FirstGPR; regNum <= TR::RealRegister::LastGPR; regNum++) \
{ \
TR::RealRegister *reg \
= machine->getRealRegister((TR::RealRegister::RegNum)regNum); \
{ block; } \
} \
for (int regNum = TR::RealRegister::FirstFPR; regNum <= TR::RealRegister::FirstFPR; regNum++) \
{ \
TR::RealRegister *reg \
= machine->getRealRegister((TR::RealRegister::RegNum)regNum); \
{ block; } \
}
#define FOR_EACH_RESERVED_REGISTER(machine, props, block) \
FOR_EACH_REGISTER(machine, \
if (props._registerFlags[(TR::RealRegister::RegNum)regNum] & RV_Reserved) \
{ block; } \
)
#define FOR_EACH_CALLEE_SAVED_REGISTER(machine, props, block) \
FOR_EACH_REGISTER(machine, \
if (props._registerFlags[(TR::RealRegister::RegNum)regNum] == Preserved) \
{ block; } \
)
#define FOR_EACH_ASSIGNED_CALLEE_SAVED_REGISTER(machine, props, block) \
FOR_EACH_CALLEE_SAVED_REGISTER(machine, props, \
if (reg->getHasBeenAssignedInMethod()) \
{ block; } \
)
struct RVLinkageProperties
{
uint32_t _properties;
uint32_t _registerFlags[TR::RealRegister::NumRegisters];
uint8_t _numIntegerArgumentRegisters;
uint8_t _firstIntegerArgumentRegister;
uint8_t _numFloatArgumentRegisters;
uint8_t _firstFloatArgumentRegister;
TR::RealRegister::RegNum _argumentRegisters[TR::RealRegister::NumRegisters];
uint8_t _firstIntegerReturnRegister;
uint8_t _firstFloatReturnRegister;
TR::RealRegister::RegNum _returnRegisters[TR::RealRegister::NumRegisters];
uint8_t _numAllocatableIntegerRegisters;
uint8_t _numAllocatableFloatRegisters;
TR::RealRegister::RegNum _methodMetaDataRegister;
TR::RealRegister::RegNum _stackPointerRegister;
TR::RealRegister::RegNum _framePointerRegister;
TR::RealRegister::RegNum _computedCallTargetRegister; // for icallVMprJavaSendPatchupVirtual
TR::RealRegister::RegNum _vtableIndexArgumentRegister; // for icallVMprJavaSendPatchupVirtual
TR::RealRegister::RegNum _j9methodArgumentRegister; // for icallVMprJavaSendStatic
uint8_t _numberOfDependencyGPRegisters;
int8_t _offsetToFirstLocal;
uint32_t getNumIntArgRegs() const {return _numIntegerArgumentRegisters;}
uint32_t getNumFloatArgRegs() const {return _numFloatArgumentRegisters;}
uint32_t getProperties() const {return _properties;}
uint32_t getCallerCleanup() const {return (_properties & CallerCleanup);}
uint32_t getRightToLeft() const {return (_properties & RightToLeft);}
uint32_t getIntegersInRegisters() const {return (_properties & IntegersInRegisters);}
uint32_t getLongsInRegisters() const {return (_properties & LongsInRegisters);}
uint32_t getFloatsInRegisters() const {return (_properties & FloatsInRegisters);}
uint32_t getRegisterFlags(TR::RealRegister::RegNum regNum) const
{
return _registerFlags[regNum];
}
uint32_t getPreserved(TR::RealRegister::RegNum regNum) const
{
return (_registerFlags[regNum] & Preserved);
}
uint32_t getIntegerReturn(TR::RealRegister::RegNum regNum) const
{
return (_registerFlags[regNum] & IntegerReturn);
}
uint32_t getIntegerArgument(TR::RealRegister::RegNum regNum) const
{
return (_registerFlags[regNum] & IntegerArgument);
}
uint32_t getFloatReturn(TR::RealRegister::RegNum regNum) const
{
return (_registerFlags[regNum] & FloatReturn);
}
uint32_t getFloatArgument(TR::RealRegister::RegNum regNum) const
{
return (_registerFlags[regNum] & FloatArgument);
}
uint32_t getCallerAllocatesBackingStore(TR::RealRegister::RegNum regNum) const
{
return (_registerFlags[regNum] & CallerAllocatesBackingStore);
}
uint32_t getKilledAndNonReturn(TR::RealRegister::RegNum regNum) const
{
return ((_registerFlags[regNum] & (Preserved | IntegerReturn | FloatReturn)) == 0);
}
// get the indexth integer argument register
TR::RealRegister::RegNum getIntegerArgumentRegister(uint32_t index) const
{
return _argumentRegisters[_firstIntegerArgumentRegister+index];
}
// get the indexth float argument register
TR::RealRegister::RegNum getFloatArgumentRegister(uint32_t index) const
{
return _argumentRegisters[_firstFloatArgumentRegister+index];
}
// get the indexth integer return register
TR::RealRegister::RegNum getIntegerReturnRegister(uint32_t index) const
{
return _returnRegisters[_firstIntegerReturnRegister+index];
}
// get the indexth float return register
TR::RealRegister::RegNum getFloatReturnRegister(uint32_t index) const
{
return _returnRegisters[_firstFloatReturnRegister+index];
}
TR::RealRegister::RegNum getArgument(uint32_t index) const
{
return _argumentRegisters[index];
}
TR::RealRegister::RegNum getReturnRegister(uint32_t index) const
{
return _returnRegisters[index];
}
TR::RealRegister::RegNum getIntegerReturnRegister() const
{
return _returnRegisters[_firstIntegerReturnRegister];
}
TR::RealRegister::RegNum getLongReturnRegister() const
{
return _returnRegisters[_firstIntegerReturnRegister];
}
TR::RealRegister::RegNum getFloatReturnRegister() const
{
return _returnRegisters[_firstFloatReturnRegister];
}
TR::RealRegister::RegNum getDoubleReturnRegister() const
{
return _returnRegisters[_firstFloatReturnRegister];
}
int32_t getNumAllocatableIntegerRegisters() const
{
return _numAllocatableIntegerRegisters;
}
int32_t getNumAllocatableFloatRegisters() const
{
return _numAllocatableFloatRegisters;
}
TR::RealRegister::RegNum getMethodMetaDataRegister() const
{
return _methodMetaDataRegister;
}
TR::RealRegister::RegNum getVMThreadRegister() const
{
return _methodMetaDataRegister;
}
TR::RealRegister::RegNum getStackPointerRegister() const
{
return _stackPointerRegister;
}
TR::RealRegister::RegNum getFramePointerRegister() const
{
return _framePointerRegister;
}
TR::RealRegister::RegNum getComputedCallTargetRegister() const
{
return _computedCallTargetRegister;
}
TR::RealRegister::RegNum getVTableIndexArgumentRegister() const
{
return _vtableIndexArgumentRegister;
}
TR::RealRegister::RegNum getJ9MethodArgumentRegister() const
{
return _j9methodArgumentRegister;
}
int32_t getOffsetToFirstLocal() const {return _offsetToFirstLocal;}
uint32_t getNumberOfDependencyGPRegisters() const {return _numberOfDependencyGPRegisters;}
};
}
namespace OMR
{
namespace RV
{
class OMR_EXTENSIBLE Linkage : public OMR::Linkage
{
public:
/**
* @brief Constructor
* @param[in] cg : CodeGenerator
*/
Linkage (TR::CodeGenerator *cg) : OMR::Linkage(cg) {}
/**
* @brief Parameter has to be on stack or not
* @param[in] parm : parameter symbol
* @return true if the parameter has to be on stack, false otherwise
*/
virtual bool hasToBeOnStack(TR::ParameterSymbol *parm);
/**
* @brief Maps symbols to locations on stack
* @param[in] method : method for which symbols are mapped on stack
*/
virtual void mapStack(TR::ResolvedMethodSymbol *method);
/**
* @brief Maps an automatic symbol to an index on stack
* @param[in] p : automatic symbol
* @param[in/out] stackIndex : index on stack
*/
virtual void mapSingleAutomatic(TR::AutomaticSymbol *p, uint32_t &stackIndex);
/**
* @brief Initializes RV RealRegister linkage
*/
virtual void initRVRealRegisterLinkage();
/**
* @brief Returns a MemoryReference for an outgoing argument
* @param[in] argMemReg : register pointing to address for the outgoing argument
* @param[in] argReg : register for the argument
* @param[in] opCode : instruction OpCode for store to memory
* @param[out] memArg : struct holding memory argument information
* @return MemoryReference for the argument
*/
virtual TR::MemoryReference *getOutgoingArgumentMemRef(TR::Register *argMemReg, TR::Register *argReg, TR::InstOpCode::Mnemonic opCode, TR::RVMemoryArgument &memArg);
/**
* @brief Saves arguments
* @param[in] cursor : instruction cursor
*/
virtual TR::Instruction *saveArguments(TR::Instruction *cursor); // may need more parameters
/**
* @brief Loads up arguments
* @param[in] cursor : instruction cursor
*/
virtual TR::Instruction *loadUpArguments(TR::Instruction *cursor);
/**
* @brief Flushes arguments
* @param[in] cursor : instruction cursor
*/
virtual TR::Instruction *flushArguments(TR::Instruction *cursor);
/**
* @brief Sets parameter linkage register index
* @param[in] method : method symbol
*/
virtual void setParameterLinkageRegisterIndex(TR::ResolvedMethodSymbol *method);
/**
* @brief Pushes integer argument to register
* @return the register holding the argument
*/
TR::Register *pushIntegerWordArg(TR::Node *child);
/**
* @brief Pushes address argument to register
* @return the register holding the argument
*/
TR::Register *pushAddressArg(TR::Node *child);
/**
* @brief Pushes long argument to register
* @return the register holding the argument
*/
TR::Register *pushLongArg(TR::Node *child);
/**
* @brief Pushes float argument to register
* @return the register holding the argument
*/
TR::Register *pushFloatArg(TR::Node *child);
/**
* @brief Pushes double argument to register
* @return the register holding the argument
*/
TR::Register *pushDoubleArg(TR::Node *child);
/**
* @brief Gets RV linkage properties
* @return Linkage properties
*/
virtual const TR::RVLinkageProperties& getProperties() = 0;
/**
* @brief Gets the number of argument registers
* @param[in] kind : register kind
* @return number of argument registers of specified kind
*/
virtual int32_t numArgumentRegisters(TR_RegisterKinds kind);
/**
* @brief Builds method arguments
* @param[in] node : caller node
* @param[in] dependencies : register dependency conditions
*/
virtual int32_t buildArgs(
TR::Node *callNode,
TR::RegisterDependencyConditions *dependencies) = 0;
/**
* @brief Builds direct dispatch to method
* @param[in] node : caller node
*/
virtual TR::Register *buildDirectDispatch(TR::Node *callNode) = 0;
/**
* @brief Builds indirect dispatch to method
* @param[in] node : caller node
*/
virtual TR::Register *buildIndirectDispatch(TR::Node *callNode) = 0;
/**
* @brief Stores parameters passed in linkage registers to the stack where the
* method body expects to find them.
*
* @param[in] cursor : the instruction cursor to begin inserting copy instructions
* @param[in] parmsHaveBeenStored : true if the parameters have been stored to the stack
*
* @return The instruction cursor after copies inserted.
*/
TR::Instruction *copyParametersToHomeLocation(TR::Instruction *cursor, bool parmsHaveBeenStored = false);
};
} // RV
} // OMR
#endif