1 /*
2 * Copyright (c) 2023 Huawei Device Co., Ltd.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16 #ifndef MAPLEBE_INCLUDE_BE_COMMON_UTILS_H
17 #define MAPLEBE_INCLUDE_BE_COMMON_UTILS_H
18 #include <cstdint>
19 #include "types_def.h"
20 #include "mpl_logging.h"
21
22 namespace maplebe {
23 using namespace maple;
24 constexpr uint32 kOffsetAlignmentOf8Bit = 0;
25 constexpr uint32 kOffsetAlignmentOf16Bit = 1;
26 constexpr uint32 kOffsetAlignmentOf32Bit = 2;
27 constexpr uint32 kOffsetAlignmentOf64Bit = 3;
28 constexpr uint32 kOffsetAlignmentOf128Bit = 4;
29 constexpr uint32 kBaseOffsetAlignment = 3;
30 /*
31 * The constexpr implementations, without assertions. Suitable for using in
32 * constants.
33 */
34 constexpr uint32 k1FConst = 31;
35 constexpr uint32 k0BitSize = 0;
36 constexpr uint32 k1BitSize = 1;
37 constexpr uint32 k2BitSize = 2;
38 constexpr uint32 k3BitSize = 3;
39 constexpr uint32 k4BitSize = 4;
40 constexpr uint32 k5BitSize = 5;
41 constexpr uint32 k6BitSize = 6;
42 constexpr uint32 k7BitSize = 7;
43 constexpr uint32 k8BitSize = 8;
44 constexpr uint32 k12BitSize = 12;
45 constexpr uint32 k15BitSize = 15;
46 constexpr uint32 k16BitSize = 16;
47 constexpr uint32 k24BitSize = 24;
48 constexpr uint32 k32BitSize = 32;
49 constexpr uint32 k40BitSize = 40;
50 constexpr uint32 k48BitSize = 48;
51 constexpr uint32 k56BitSize = 56;
52 constexpr uint32 k64BitSize = 64;
53 constexpr uint32 k128BitSize = 128;
54 constexpr uint32 k256BitSize = 256;
55 constexpr uint32 k512BitSize = 512;
56 constexpr uint32 k1024BitSize = 1024;
57 constexpr uint32 k2048BitSize = 2048;
58
59 constexpr int32 k1FConstInt = 31;
60 constexpr int32 k0BitSizeInt = 0;
61 constexpr int32 k1BitSizeInt = 1;
62 constexpr int32 k2BitSizeInt = 2;
63 constexpr int32 k3BitSizeInt = 3;
64 constexpr int32 k4BitSizeInt = 4;
65 constexpr int32 k5BitSizeInt = 5;
66 constexpr int32 k6BitSizeInt = 6;
67 constexpr int32 k7BitSizeInt = 7;
68 constexpr int32 k8BitSizeInt = 8;
69 constexpr int32 k16BitSizeInt = 16;
70 constexpr int32 k24BitSizeInt = 24;
71 constexpr int32 k32BitSizeInt = 32;
72 constexpr int32 k48BitSizeInt = 48;
73 constexpr int32 k56BitSizeInt = 56;
74 constexpr int32 k64BitSizeInt = 64;
75 constexpr int32 k128BitSizeInt = 128;
76 constexpr int32 k256BitSizeInt = 256;
77 constexpr int32 k512BitSizeInt = 512;
78 constexpr int32 k1024BitSizeInt = 1024;
79
80 constexpr int32 kNegative8BitSize = -8;
81 constexpr int32 kNegative256BitSize = -256;
82 constexpr int32 kNegative512BitSize = -512;
83 constexpr int32 kNegative1024BitSize = -1024;
84
85 constexpr uint32 k0ByteSize = 0;
86 constexpr uint32 k1ByteSize = 1;
87 constexpr uint32 k2ByteSize = 2;
88 constexpr uint32 k3ByteSize = 3;
89 constexpr uint32 k4ByteSize = 4;
90 constexpr uint32 k8ByteSize = 8;
91 constexpr uint32 k9ByteSize = 9;
92 constexpr uint32 k12ByteSize = 12;
93 constexpr uint32 k14ByteSize = 14;
94 constexpr uint32 k15ByteSize = 15;
95 constexpr uint32 k16ByteSize = 16;
96 constexpr uint32 k32ByteSize = 32;
97 constexpr uint32 k64ByteSize = 64;
98
99 constexpr int32 k1ByteSizeInt = 1;
100 constexpr int32 k2ByteSizeInt = 2;
101 constexpr int32 k3ByteSizeInt = 3;
102 constexpr int32 k4ByteSizeInt = 4;
103 constexpr int32 k8ByteSizeInt = 8;
104 constexpr int32 k9ByteSizeInt = 9;
105 constexpr int32 k12ByteSizeInt = 12;
106 constexpr int32 k14ByteSizeInt = 14;
107 constexpr int32 k15ByteSizeInt = 15;
108 constexpr int32 k16ByteSizeInt = 16;
109 constexpr int32 k32ByteSizeInt = 32;
110
111 constexpr uint32 k1EightBytesSize = 8;
112 constexpr uint32 k2EightBytesSize = 16;
113 constexpr uint32 k3EightBytesSize = 24;
114 constexpr uint32 k4EightBytesSize = 32;
115
116 constexpr uint32 k4BitShift = 2; /* 4 is 1 << 2; */
117 constexpr uint32 k8BitShift = 3; /* 8 is 1 << 3; */
118 constexpr uint32 k16BitShift = 4; /* 16 is 1 << 4 */
119
120 constexpr uint32 kDwordSizeTwo = 2;
121
122 constexpr uint32 k4ByteFloatSize = 4;
123 constexpr uint32 k8ByteDoubleSize = 8;
124
125 /* Storage location of operands in one insn */
126 constexpr int32 kInsnFirstOpnd = 0;
127 constexpr int32 kInsnSecondOpnd = 1;
128 constexpr int32 kInsnThirdOpnd = 2;
129 constexpr int32 kInsnFourthOpnd = 3;
130 constexpr int32 kInsnFifthOpnd = 4;
131 constexpr int32 kInsnSixthOpnd = 5;
132 constexpr int32 kInsnSeventhOpnd = 6;
133 constexpr int32 kInsnEighthOpnd = 7;
134 constexpr int32 kInsnMaxOpnd = 8;
135
136 /* Reg of CCLocInfo */
137 constexpr uint32 kFirstReg = 0;
138 constexpr uint32 kSecondReg = 1;
139 constexpr uint32 kThirdReg = 2;
140 constexpr uint32 kFourthReg = 3;
141
142 /* inline asm operand designations */
143 constexpr uint32 kAsmStringOpnd = 0;
144 constexpr uint32 kAsmOutputListOpnd = 1;
145 constexpr uint32 kAsmClobberListOpnd = 2;
146 constexpr uint32 kAsmInputListOpnd = 3;
147 constexpr uint32 kAsmOutputConstraintOpnd = 4;
148 constexpr uint32 kAsmInputConstraintOpnd = 5;
149 constexpr uint32 kAsmOutputRegPrefixOpnd = 6;
150 constexpr uint32 kAsmInputRegPrefixOpnd = 7;
151
152 /* Number of registers */
153 constexpr uint32 kOneRegister = 1;
154 constexpr uint32 kTwoRegister = 2;
155 constexpr uint32 kThreeRegister = 3;
156 constexpr uint32 kFourRegister = 4;
157
158 /* position of an operand within an instruction */
159 constexpr uint32 kOperandPosition0 = 0;
160 constexpr uint32 kOperandPosition1 = 1;
161 constexpr uint32 kOperandPosition2 = 2;
162
163 /* Size of struct for memcpy */
164 constexpr uint32 kParmMemcpySize = 40;
165
166 /* Check whether the value is an even number. */
167 constexpr int32 kDivide2 = 2;
168 constexpr int32 kRegNum2 = 2;
169 constexpr int32 kStepNum2 = 2;
170 constexpr int32 kInsnNum2 = 2;
171 constexpr int32 kOpndNum2 = 2;
172
173 /* alignment in bytes of uint8 */
174 constexpr uint8 kAlignOfU8 = 3;
175
176 /*
177 * if the number of local refvar is less than 12, use stp or str to init local refvar
178 * else call function MCC_InitializeLocalStackRef to init.
179 */
180 constexpr int32 kRefNum12 = 12;
181
182 /* mod function max argument size */
183 constexpr uint32 kMaxModFuncArgSize = 8;
184
185 /* string length of spacial name "__EARetTemp__" */
186 constexpr int32 kEARetTempNameSize = 10;
187
188 /*
189 * Aarch64 data processing instructions have 12 bits of space for values in their instuction word
190 * This is arranged as a four-bit rotate value and an eight-bit immediate value:
191 */
192 constexpr uint32 kMaxImmVal5Bits = 5;
193 constexpr uint32 kMaxImmVal6Bits = 6;
194 constexpr uint32 kMaxImmVal8Bits = 8;
195 constexpr uint32 kMaxImmVal12Bits = 12;
196 constexpr uint32 kMaxImmVal13Bits = 13;
197 constexpr uint32 kMaxImmVal16Bits = 16;
198
199 constexpr int32 kMaxPimm8 = 4095;
200 constexpr int32 kMaxPimm16 = 8190;
201 constexpr int32 kMaxPimm32 = 16380;
202 constexpr int32 kMaxPimm64 = 32760;
203 constexpr int32 kMaxPimm128 = 65520;
204
205 constexpr int32 kMaxPimm[k5BitSize] = {kMaxPimm8, kMaxPimm16, kMaxPimm32, kMaxPimm64, kMaxPimm128};
206 constexpr int32 kMaxPairPimm[k3BitSize] = {k256BitSize, k512BitSize, k512BitSize};
207
208 constexpr int32 kMaxSimm32 = 255;
209 constexpr int32 kMaxSimm32Pair = 252;
210 constexpr int32 kMinSimm32 = kNegative256BitSize;
211 constexpr int32 kMaxSimm64Pair = 504;
212 constexpr int32 kMinSimm64 = kNegative512BitSize;
213
214 constexpr int32 kMax8UnsignedImm = 255;
215 constexpr int32 kMax12UnsignedImm = 4096;
216 constexpr int32 kMax13UnsignedImm = 8192;
217 constexpr int32 kMax16UnsignedImm = 65535;
218
219 /* Dedicated for Vector */
220 constexpr int32 kMinImmVal = -128;
221 constexpr int32 kMaxImmVal = 255;
222
223 /* aarch64 assembly takes up to 24-bits */
224 constexpr uint32 kMaxImmVal24Bits = 24;
225
226 constexpr uint32 kDecimalMax = 10;
227
228 constexpr double kMicroSecPerMilliSec = 1000.0;
229
230 constexpr double kPercent = 100.0;
231
232 enum ConditionCode : uint8 {
233 CC_EQ, /* equal */
234 CC_NE, /* not equal */
235 CC_CS, /* carry set (== HS) */
236 CC_HS, /* unsigned higher or same (== CS) */
237 CC_CC, /* carry clear (== LO) */
238 CC_LO, /* Unsigned lower (== CC) */
239 CC_MI, /* Minus or negative result */
240 CC_PL, /* positive or zero result */
241 CC_VS, /* overflow */
242 CC_VC, /* no overflow */
243 CC_HI, /* unsigned higher */
244 CC_LS, /* unsigned lower or same */
245 CC_GE, /* signed greater than or equal */
246 CC_LT, /* signed less than */
247 CC_GT, /* signed greater than */
248 CC_LE, /* signed less than or equal */
249 CC_AL, /* always, this is the default. usually omitted. */
250 kCcLast
251 };
252
GetReverseCC(ConditionCode cc)253 inline ConditionCode GetReverseCC(ConditionCode cc)
254 {
255 switch (cc) {
256 case CC_NE:
257 return CC_EQ;
258 case CC_EQ:
259 return CC_NE;
260 case CC_HS:
261 return CC_LO;
262 case CC_LO:
263 return CC_HS;
264 case CC_MI:
265 return CC_PL;
266 case CC_PL:
267 return CC_MI;
268 case CC_VS:
269 return CC_VC;
270 case CC_VC:
271 return CC_VS;
272 case CC_HI:
273 return CC_LS;
274 case CC_LS:
275 return CC_HI;
276 case CC_LT:
277 return CC_GE;
278 case CC_GE:
279 return CC_LT;
280 case CC_GT:
281 return CC_LE;
282 case CC_LE:
283 return CC_GT;
284 default:
285 CHECK_FATAL(0, "unknown condition code");
286 }
287 return kCcLast;
288 }
GetReverseBasicCC(ConditionCode cc)289 inline ConditionCode GetReverseBasicCC(ConditionCode cc)
290 {
291 switch (cc) {
292 case CC_NE:
293 return CC_EQ;
294 case CC_EQ:
295 return CC_NE;
296 case CC_LT:
297 return CC_GE;
298 case CC_GE:
299 return CC_LT;
300 case CC_GT:
301 return CC_LE;
302 case CC_LE:
303 return CC_GT;
304 default:
305 CHECK_FATAL(false, "Not support yet.");
306 }
307 return kCcLast;
308 }
309
IsPowerOf2Const(uint64 i)310 inline bool IsPowerOf2Const(uint64 i)
311 {
312 return (i & (i - 1)) == 0;
313 }
314
RoundUpConst(uint64 offset,uint64 align)315 inline uint64 RoundUpConst(uint64 offset, uint64 align)
316 {
317 CHECK_FATAL(offset <= UINT64_MAX - align, "must not be zero");
318 DEBUG_ASSERT(offset + align >= 1, "result must be uint");
319 return (-align) & (offset + align - 1);
320 }
321
IsPowerOf2(uint64 i)322 inline bool IsPowerOf2(uint64 i)
323 {
324 return IsPowerOf2Const(i);
325 }
326
327 /* align must be a power of 2 */
RoundUp(uint64 offset,uint64 align)328 inline uint64 RoundUp(uint64 offset, uint64 align)
329 {
330 if (align == 0) {
331 return offset;
332 }
333 DEBUG_ASSERT(IsPowerOf2(align), "align must be power of 2!");
334 return RoundUpConst(offset, align);
335 }
336
RoundDownConst(int64 offset,int64 align)337 inline int64 RoundDownConst(int64 offset, int64 align)
338 {
339 return (-align) & offset;
340 }
341
342 // align must be a power of 2
RoundDown(int64 offset,int64 align)343 inline int64 RoundDown(int64 offset, int64 align)
344 {
345 if (align == 0) {
346 return offset;
347 }
348 DEBUG_ASSERT(IsPowerOf2(align), "align must be power of 2!");
349 return RoundDownConst(offset, align);
350 }
351
IsAlignedTo(uint64 offset,uint64 align)352 inline bool IsAlignedTo(uint64 offset, uint64 align)
353 {
354 DEBUG_ASSERT(IsPowerOf2(align), "align must be power of 2!");
355 CHECK_FATAL(align > 0, "must not be zero");
356 return (offset & (align - 1)) == 0;
357 }
358 } /* namespace maplebe */
359
360 #endif /* MAPLEBE_INCLUDE_BE_COMMON_UTILS_H */
361