TPDE
Loading...
Searching...
No Matches
CompilerA64.hpp
1// SPDX-FileCopyrightText: 2025 Contributors to TPDE <https://tpde.org>
2//
3// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
4#pragma once
5
6#include "tpde/AssemblerElf.hpp"
7#include "tpde/AssignmentPartRef.hpp"
8#include "tpde/CompilerBase.hpp"
9#include "tpde/DWARF.hpp"
10#include "tpde/ELF.hpp"
11#include "tpde/arm64/FunctionWriterA64.hpp"
12#include "tpde/base.hpp"
13#include "tpde/util/SmallVector.hpp"
14#include "tpde/util/misc.hpp"
15
16#include <bit>
17#include <disarm64.h>
18
19// Helper macros for assembling in the compiler
20#if defined(ASM) || defined(ASMNC) || defined(ASMC)
21 #error Got definition for ASM macros from somewhere else. Maybe you included compilers for multiple architectures?
22#endif
23
24/// Encode an instruction with an explicit compiler pointer
25#define ASMC(compiler, op, ...) \
26 ((compiler)->text_writer.write_inst(de64_##op(__VA_ARGS__)))
27/// Encode an instruction into this
28#define ASM(...) ASMC(this, __VA_ARGS__)
29/// Encode an instruction without checking that enough space is available
30#define ASMNC(op, ...) \
31 (this->text_writer.write_inst_unchecked(de64_##op(__VA_ARGS__)))
32/// Encode an instruction if the encoding is successful (returns true)
33#define ASMIFC(compiler, op, ...) \
34 ((compiler)->text_writer.try_write_inst(de64_##op(__VA_ARGS__)))
35/// Encode an instruction if the encoding is successful (returns true)
36#define ASMIF(...) ASMIFC(this, __VA_ARGS__)
37
38namespace tpde::a64 {
39
40struct AsmReg : Reg {
41 enum REG : u8 {
42 R0 = 0,
43 R1,
44 R2,
45 R3,
46 R4,
47 R5,
48 R6,
49 R7,
50 R8,
51 R9,
52 R10,
53 R11,
54 R12,
55 R13,
56 R14,
57 R15,
58 R16,
59 R17,
60 R18,
61 R19,
62 R20,
63 R21,
64 R22,
65 R23,
66 R24,
67 R25,
68 R26,
69 R27,
70 R28,
71 R29,
72 FP = 29,
73 R30,
74 LR = 30,
75 SP = 31,
76
77 V0 = 32,
78 V1,
79 V2,
80 V3,
81 V4,
82 V5,
83 V6,
84 V7,
85 V8,
86 V9,
87 V10,
88 V11,
89 V12,
90 V13,
91 V14,
92 V15,
93 V16,
94 V17,
95 V18,
96 V19,
97 V20,
98 V21,
99 V22,
100 V23,
101 V24,
102 V25,
103 V26,
104 V27,
105 V28,
106 V29,
107 V30,
108 V31
109 };
110
111 constexpr explicit AsmReg() : Reg((u8)0xFF) {}
112
113 constexpr AsmReg(const REG id) : Reg((u8)id) {}
114
115 constexpr AsmReg(const Reg base) : Reg(base) {}
116
117 constexpr explicit AsmReg(const u64 id) : Reg(id) {
118 assert(id <= SP || (id >= V0 && id <= V31));
119 }
120
121 operator DA_GReg() const {
122 assert(reg_id < V0);
123 return DA_GReg{reg_id};
124 }
125
126 operator DA_GRegZR() const {
127 assert(reg_id < V0);
128 assert(reg_id != SP); // 31 means SP in our enums
129 return DA_GRegZR{reg_id};
130 }
131
132 operator DA_GRegSP() const {
133 assert(reg_id <= SP);
134 return DA_GRegSP{reg_id};
135 }
136
137 operator DA_VReg() const {
138 assert(reg_id >= V0 && reg_id <= V31);
139 return DA_VReg{static_cast<u8>(reg_id - V0)};
140 }
141};
142
143constexpr static u64
144 create_bitmask(const std::initializer_list<AsmReg::REG> regs) {
145 u64 set = 0;
146 for (const auto reg : regs) {
147 set |= 1ull << reg;
148 }
149 return set;
150}
151
152template <size_t N>
153constexpr static u64 create_bitmask(const std::array<AsmReg, N> regs) {
154 u64 set = 0;
155 for (const auto reg : regs) {
156 set |= 1ull << reg.id();
157 }
158 return set;
159}
160
161/// AArch64 AAPCS calling convention.
162class CCAssignerAAPCS : public CCAssigner {
163 static constexpr CCInfo Info{
164 // we reserve SP,FP,R16 and R17 for our special use cases
165 .allocatable_regs =
166 0xFFFF'FFFF'FFFF'FFFF &
167 ~create_bitmask({AsmReg::SP, AsmReg::FP, AsmReg::R16, AsmReg::R17}),
168 // callee-saved registers
169 .callee_saved_regs = create_bitmask({
170 AsmReg::R19,
171 AsmReg::R20,
172 AsmReg::R21,
173 AsmReg::R22,
174 AsmReg::R23,
175 AsmReg::R24,
176 AsmReg::R25,
177 AsmReg::R26,
178 AsmReg::R27,
179 AsmReg::R28,
180 AsmReg::V8,
181 AsmReg::V9,
182 AsmReg::V10,
183 AsmReg::V11,
184 AsmReg::V12,
185 AsmReg::V13,
186 AsmReg::V14,
187 AsmReg::V15,
188 }),
189 .arg_regs = create_bitmask({
190 AsmReg::R0,
191 AsmReg::R1,
192 AsmReg::R2,
193 AsmReg::R3,
194 AsmReg::R4,
195 AsmReg::R5,
196 AsmReg::R6,
197 AsmReg::R7,
198 AsmReg::R8, // sret register
199 AsmReg::V0,
200 AsmReg::V1,
201 AsmReg::V2,
202 AsmReg::V3,
203 AsmReg::V4,
204 AsmReg::V5,
205 AsmReg::V6,
206 AsmReg::V7,
207 }),
208 };
209
210 // NGRN = Next General-purpose Register Number
211 // NSRN = Next SIMD/FP Register Number
212 // NSAA = Next Stack Argument Address
213 u32 ngrn = 0, nsrn = 0, nsaa = 0;
214 u32 ret_ngrn = 0, ret_nsrn = 0;
215
216public:
217 CCAssignerAAPCS() : CCAssigner(Info) {}
218
219 void reset() override { ngrn = nsrn = nsaa = ret_ngrn = ret_nsrn = 0; }
220
221 void assign_arg(CCAssignment &arg) override {
222 if (arg.byval) [[unlikely]] {
223 nsaa = util::align_up(nsaa, arg.align < 8 ? 8 : arg.align);
224 arg.stack_off = nsaa;
225 nsaa += arg.size;
226 return;
227 }
228
229 if (arg.sret) [[unlikely]] {
230 arg.reg = AsmReg{AsmReg::R8};
231 return;
232 }
233
234 if (arg.bank == RegBank{0}) {
235 if (arg.align > 8) {
236 ngrn = util::align_up(ngrn, 2);
237 }
238 if (ngrn + arg.consecutive < 8) {
239 arg.reg = Reg{AsmReg::R0 + ngrn};
240 ngrn += 1;
241 } else {
242 ngrn = 8;
243 nsaa = util::align_up(nsaa, arg.align < 8 ? 8 : arg.align);
244 arg.stack_off = nsaa;
245 nsaa += 8;
246 }
247 } else {
248 if (nsrn + arg.consecutive < 8) {
249 arg.reg = Reg{AsmReg::V0 + nsrn};
250 nsrn += 1;
251 } else {
252 nsrn = 8;
253 u32 size = util::align_up(arg.size, 8);
254 nsaa = util::align_up(nsaa, size);
255 arg.stack_off = nsaa;
256 nsaa += size;
257 }
258 }
259 }
260
261 u32 get_stack_size() override { return nsaa; }
262
263 void assign_ret(CCAssignment &arg) override {
264 assert(!arg.byval && !arg.sret);
265 if (arg.bank == RegBank{0}) {
266 if (arg.align > 8) {
267 ret_ngrn = util::align_up(ret_ngrn, 2);
268 }
269 if (ret_ngrn + arg.consecutive < 8) {
270 arg.reg = Reg{AsmReg::R0 + ret_ngrn};
271 ret_ngrn += 1;
272 } else {
273 assert(false);
274 }
275 } else {
276 if (ret_nsrn + arg.consecutive < 8) {
277 arg.reg = Reg{AsmReg::V0 + ret_nsrn};
278 ret_nsrn += 1;
279 } else {
280 assert(false);
281 }
282 }
283 }
284};
285
286struct PlatformConfig : CompilerConfigDefault {
287 using Assembler = tpde::elf::AssemblerElfA64;
288 using AsmReg = tpde::a64::AsmReg;
289 using DefaultCCAssigner = CCAssignerAAPCS;
291
292 static constexpr RegBank GP_BANK{0};
293 static constexpr RegBank FP_BANK{1};
294 static constexpr bool FRAME_INDEXING_NEGATIVE = false;
295 static constexpr u32 PLATFORM_POINTER_SIZE = 8;
296 static constexpr u32 NUM_BANKS = 2;
297};
298
299/// Compiler mixin for targeting AArch64.
300template <IRAdaptor Adaptor,
301 typename Derived,
302 template <typename, typename, typename> typename BaseTy =
303 CompilerBase,
304 typename Config = PlatformConfig>
305struct CompilerA64 : BaseTy<Adaptor, Derived, Config> {
306 using Base = BaseTy<Adaptor, Derived, Config>;
307
308 using IRValueRef = typename Base::IRValueRef;
309 using IRBlockRef = typename Base::IRBlockRef;
310 using IRFuncRef = typename Base::IRFuncRef;
311
312 using ScratchReg = typename Base::ScratchReg;
313 using ValuePartRef = typename Base::ValuePartRef;
314 using ValuePart = typename Base::ValuePart;
315 using GenericValuePart = typename Base::GenericValuePart;
316
317 using RegisterFile = typename Base::RegisterFile;
318
319 using CallArg = typename Base::CallArg;
320
321 using Base::derived;
322
323
324 // TODO(ts): make this dependent on the number of callee-saved regs of the
325 // current function or if there is a call in the function?
326 static constexpr u32 NUM_FIXED_ASSIGNMENTS[PlatformConfig::NUM_BANKS] = {5,
327 6};
328
329 // Maximum frame size is 0xfff000, therefore convert overly large static
330 // allocas directly to dynamic allocations.
331 static constexpr u32 MaxStaticAllocaSize = 0x100000;
332
333 enum CPU_FEATURES : u32 {
334 CPU_BASELINE = 0, // ARMV8.0
335 };
336
337 CPU_FEATURES cpu_feats = CPU_BASELINE;
338
339 // When handling function arguments, we need to prevent argument registers
340 // from being handed out as fixed registers
341 //
342 // Additionally, we prevent R0 and R1 from being fixed assignments to
343 // prevent issues with exception handling
344 u64 fixed_assignment_nonallocatable_mask =
345 create_bitmask({AsmReg::R0, AsmReg::R1});
346 u32 func_start_off = 0u, func_prologue_alloc = 0u;
347 /// Offset to the `add sp, sp, XXX` instruction that the argument handling
348 /// uses to access stack arguments if needed
350 AsmReg func_arg_stack_add_reg = AsmReg::make_invalid();
351
352 /// Permanent scratch register, e.g. to materialize constants/offsets. This is
353 /// used by materialize_constant, load_from_stack, spill_reg.
354 AsmReg permanent_scratch_reg = AsmReg::R16;
355
356 u32 scalar_arg_count = 0xFFFF'FFFF, vec_arg_count = 0xFFFF'FFFF;
357 u32 reg_save_frame_off = 0;
358 util::SmallVector<u32, 8> func_ret_offs = {};
359
360 /// Helper class for building call sequences.
361 class CallBuilder : public Base::template CallBuilderBase<CallBuilder> {
362 u32 stack_adjust_off = 0;
363 u32 stack_size = 0;
364 u32 stack_sub = 0;
365
366 void set_stack_used();
367
368 public:
369 /// Constructor.
370 CallBuilder(Derived &compiler, CCAssigner &assigner)
371 : Base::template CallBuilderBase<CallBuilder>(compiler, assigner) {}
372
373 void add_arg_byval(ValuePart &vp, CCAssignment &cca);
374 void add_arg_stack(ValuePart &vp, CCAssignment &cca);
375 void call_impl(std::variant<SymRef, ValuePart> &&);
376 void reset_stack();
377 };
378
379 // for now, always generate an object
380 explicit CompilerA64(Adaptor *adaptor,
381 const CPU_FEATURES cpu_features = CPU_BASELINE)
382 : Base{adaptor}, cpu_feats(cpu_features) {
383 static_assert(std::is_base_of_v<CompilerA64, Derived>);
384 }
385
386 void start_func(u32) {}
387
388 /// Begin prologue, prepare for assigning arguments.
389 void prologue_begin(CCAssigner *cc_assigner);
390 /// Assign argument part. Returns the stack offset if the value should be
391 /// initialized as stack variable.
392 std::optional<i32> prologue_assign_arg_part(ValuePart &&vp, CCAssignment cca);
393 /// Finish prologue.
394 void prologue_end(CCAssigner *cc_assigner);
395
396 // note: this has to call assembler->end_func
397 void finish_func(u32 func_idx);
398
399 // helpers
400
401 void gen_func_epilog();
402
403 void spill_reg(const AsmReg reg, const u32 frame_off, const u32 size);
404
405 void load_from_stack(AsmReg dst,
406 i32 frame_off,
407 u32 size,
408 bool sign_extend = false);
409
410 void load_address_of_stack_var(AsmReg dst, AssignmentPartRef ap);
411
412 /// Load from an base+offset into register, using permanent_scratch_reg for
413 /// large offsets.
414 void load_off(AsmReg dst, AsmReg base, u32 off, u32 size, bool sext = false);
415
416 /// Store a register to base+offset, using permanent_scratch_reg for large
417 /// offsets.
418 void store_off(AsmReg base, u32 off, AsmReg src, u32 size);
419
420 void mov(AsmReg dst, AsmReg src, u32 size);
421
422 GenericValuePart val_spill_slot(AssignmentPartRef ap) {
423 assert(ap.stack_valid() && !ap.variable_ref());
424 return typename GenericValuePart::Expr(AsmReg::R29, ap.frame_off());
425 }
426
427 AsmReg gval_expr_as_reg(GenericValuePart &gv);
428
429 /// Dynamic alloca of a fixed-size region.
430 void alloca_fixed(u64 size, u32 align, ValuePart &res);
431
432 /// Dynamic alloca of a dynamically-sized region (elem_size * count bytes).
433 /// count must have a size of 64 bit.
434 void alloca_dynamic(u64 elem_size,
435 ValuePart &&count,
436 u32 align,
437 ValuePart &res);
438
439 /// Materialize constant into a register.
440 void
441 materialize_constant(const u64 *data, RegBank bank, u32 size, AsmReg dst);
442 /// Materialize constant into a register.
443 void materialize_constant(u64 const_u64, RegBank bank, u32 size, AsmReg dst) {
444 assert(size <= sizeof(const_u64));
445 materialize_constant(&const_u64, bank, size, dst);
446 }
447
448 AsmReg select_fixed_assignment_reg(AssignmentPartRef, IRValueRef);
449
450 /// Jump conditions.
451 struct Jump {
452 // TDOO: naming consistency
453 enum Kind : uint8_t {
454 Jeq, ///< Equal (Z == 1)
455 Jne, ///< Not equal (Z == 0)
456 Jcs, ///< Carry set (C == 1)
457 Jhs = Jcs, ///< Unsigned higher or same (C == 1)
458 Jcc, ///< Carry clear (C == 0)
459 Jlo = Jcc, ///< Unsigned lower (C == 0)
460 Jmi, ///< Minus, negative (N == 1)
461 Jpl, ///< Plus, positive or zero (N == 0)
462 Jvs, ///< Overflow (V == 1)
463 Jvc, ///< No Overflow (V == 0)
464 Jhi, ///< Unsigned higher (C == 1 && Z == 0)
465 Jls, ///< Unsigned lower or same (!(C == 1 && Z == 0))
466 Jge, ///< Signed greater than or equal (N == V)
467 Jlt, ///< Signed less than (N != V)
468 Jgt, ///< Signed greater than (Z == 0 && N == V)
469 Jle, ///< Signed lessthan or equal (!(Z == 0 && N == V))
470 jmp, ///< Unconditional jump
471 Cbz, ///< Compare and branch if zero (Wn or Xn register)
472 Cbnz, ///< Compare and branch if not zero (Wn or Xn register)
473 Tbz, ///< Test single bit and branch if zero (Xn register)
474 Tbnz, ///< Test single bit and branch if not zero (Xn register)
475 };
476
477 Kind kind;
478 AsmReg cmp_reg;
479 bool cmp_is_32;
480 u8 test_bit;
481
482 /// Unconditional branch.
483 constexpr Jump() : kind(Kind::jmp) {}
484
485 /// Unconditional or conditional branch based on flags.
486 constexpr Jump(Kind kind) : kind(kind), cmp_is_32(false), test_bit(0) {
487 assert(kind != Cbz && kind != Cbnz && kind != Tbz && kind != Tbnz);
488 }
489
490 /// Cbz/Cbnz branch.
491 constexpr Jump(Kind kind, AsmReg cmp_reg, bool cmp_is_32)
492 : kind(kind), cmp_reg(cmp_reg), cmp_is_32(cmp_is_32), test_bit(0) {
493 assert(kind == Cbz || kind == Cbnz);
494 }
495
496 /// Tbz/Tbnz branch.
497 constexpr Jump(Kind kind, AsmReg cmp_reg, u8 test_bit)
498 : kind(kind), cmp_reg(cmp_reg), cmp_is_32(false), test_bit(test_bit) {
499 assert(kind == Tbz || kind == Tbnz);
500 }
501
502 constexpr Jump change_kind(Kind new_kind) const {
503 auto cpy = *this;
504 cpy.kind = new_kind;
505 return cpy;
506 }
507 };
508
509 Jump invert_jump(Jump jmp);
510 Jump swap_jump(Jump jmp);
511
512 /// Generate jump instruction to target label.
513 void generate_raw_jump(Jump jmp, Label target);
514
515 /// Convert jump condition to disarms Da64Cond.
516 /// \warning Cbz,Cbnz,Tbz and Tbnz are not supported
517 Da64Cond jump_to_cond(Jump jmp);
518 /// Set dst to 1 if cc is true, otherwise set it to zero
519 void generate_raw_set(Jump cc, AsmReg dst);
520 /// Set all bits of dst to 1 if cc is true, otherwise set dst to zero
521 void generate_raw_mask(Jump cc, AsmReg dst);
522
523 /// Moves true_select into dst if cc is true,
524 /// otherwise move false_select into dst
526 Jump cc, AsmReg dst, AsmReg true_select, AsmReg false_select, bool is_64);
527
528 /// Integer extension. src is not modified.
529 void generate_raw_intext(AsmReg dst, AsmReg src, bool sign, u32 from, u32 to);
530
531 /// Bitfield insert. src is not modified.
532 void generate_raw_bfi(AsmReg dst, AsmReg src, u32 lsb, u32 width) {
533 ASM(BFIx, dst, src, lsb, width);
534 }
535 /// Bitfield insert in zero. src is not modified.
536 void generate_raw_bfiz(AsmReg dst, AsmReg src, u32 lsb, u32 width) {
537 ASM(UBFIZx, dst, src, lsb, width);
538 }
539
540 /// Generate a function call
541 ///
542 /// This will get the arguments into the correct registers according to the
543 /// calling convention, clear non-callee-saved registers from the register
544 /// file (make sure you do not have any fixed assignments left over) and
545 /// fill the result registers (the u8 in the ScratchReg pair indicates the
546 /// register bank)
547 ///
548 /// Targets can be a symbol (call to PLT with relocation), or an indirect
549 /// call to a ValuePart. Result is an optional reference.
550 void generate_call(std::variant<SymRef, ValuePart> &&target,
551 std::span<CallArg> arguments,
552 typename Base::ValueRef *result,
553 bool variable_args = false);
554
555private:
556 /// @internal Emit compare of cmp_reg with case_value.
557 void switch_emit_cmp(AsmReg cmp_reg,
558 AsmReg tmp_reg,
559 u64 case_value,
560 bool width_is_32);
561
562public:
563 /// @internal Jump if cmp_reg equals case_value.
564 void switch_emit_cmpeq(Label case_label,
565 AsmReg cmp_reg,
566 AsmReg tmp_reg,
567 u64 case_value,
568 bool width_is_32);
569 /// @internal Emit bounds check and create jump table.
570 FunctionWriterBase::JumpTable *switch_create_jump_table(Label default_label,
571 AsmReg cmp_reg,
572 AsmReg tmp_reg,
573 u64 low_bound,
574 u64 high_bound,
575 bool width_is_32);
576 /// @internal Jump if cmp_reg is greater than case_value.
577 void switch_emit_binary_step(Label case_label,
578 Label gt_label,
579 AsmReg cmp_reg,
580 AsmReg tmp_reg,
581 u64 case_value,
582 bool width_is_32);
583
584 /// Generate code sequence to load address of sym into a register. This will
585 /// generate a function call for dynamic TLS access models.
586 ScratchReg tls_get_addr(SymRef sym, TLSModel model);
587
588 bool has_cpu_feats(CPU_FEATURES feats) const {
589 return ((cpu_feats & feats) == feats);
590 }
591};
592
593template <IRAdaptor Adaptor,
594 typename Derived,
595 template <typename, typename, typename> class BaseTy,
596 typename Config>
597void CompilerA64<Adaptor, Derived, BaseTy, Config>::CallBuilder::
598 set_stack_used() {
599 if (stack_adjust_off == 0) {
600 this->compiler.text_writer.ensure_space(16);
601 stack_adjust_off = this->compiler.text_writer.offset();
602 this->compiler.text_writer.cur_ptr() += 4;
603 }
604}
605
606template <IRAdaptor Adaptor,
607 typename Derived,
608 template <typename, typename, typename> class BaseTy,
609 typename Config>
610void CompilerA64<Adaptor, Derived, BaseTy, Config>::CallBuilder::add_arg_byval(
611 ValuePart &vp, CCAssignment &cca) {
612 AsmReg ptr_reg = vp.load_to_reg(&this->compiler);
613 // store_off might clobber permanent_scratch_reg.
614 ScratchReg scratch{&this->compiler};
615 AsmReg tmp = scratch.alloc_gp();
616
617 u32 size = cca.size;
618 u32 off = 0;
619 set_stack_used();
620 while (size - off >= 8) {
621 this->compiler.load_off(tmp, ptr_reg, off, 8);
622 this->compiler.store_off(AsmReg{AsmReg::SP}, cca.stack_off + off, tmp, 8);
623 off += 8;
624 }
625 if (size - off >= 4) {
626 this->compiler.load_off(tmp, ptr_reg, off, 4);
627 this->compiler.store_off(AsmReg{AsmReg::SP}, cca.stack_off + off, tmp, 4);
628 off += 4;
629 }
630 if (size - off >= 2) {
631 this->compiler.load_off(tmp, ptr_reg, off, 2);
632 this->compiler.store_off(AsmReg{AsmReg::SP}, cca.stack_off + off, tmp, 2);
633 off += 2;
634 }
635 if (size - off >= 1) {
636 this->compiler.load_off(tmp, ptr_reg, off, 1);
637 this->compiler.store_off(AsmReg{AsmReg::SP}, cca.stack_off + off, tmp, 1);
638 }
639}
640
641template <IRAdaptor Adaptor,
642 typename Derived,
643 template <typename, typename, typename> class BaseTy,
644 typename Config>
645void CompilerA64<Adaptor, Derived, BaseTy, Config>::CallBuilder::add_arg_stack(
646 ValuePart &vp, CCAssignment &cca) {
647 set_stack_used();
648 auto reg = vp.cur_reg_or_load(&this->compiler);
649 this->compiler.store_off(AsmReg{AsmReg::SP}, cca.stack_off, reg, cca.size);
650}
651
652template <IRAdaptor Adaptor,
653 typename Derived,
654 template <typename, typename, typename> class BaseTy,
655 typename Config>
656void CompilerA64<Adaptor, Derived, BaseTy, Config>::CallBuilder::call_impl(
657 std::variant<SymRef, ValuePart> &&target) {
658 u32 sub = 0;
659 if (stack_adjust_off != 0) {
660 auto *text_data = this->compiler.text_writer.begin_ptr();
661 u32 *write_ptr = reinterpret_cast<u32 *>(text_data + stack_adjust_off);
662 u32 stack_size = this->assigner.get_stack_size();
663 sub = util::align_up(stack_size, stack_size < 0x1000 ? 0x10 : 0x1000);
664 *write_ptr = de64_SUBxi(DA_SP, DA_SP, sub);
665 } else {
666 assert(this->assigner.get_stack_size() == 0);
667 }
668
669 // For vector registers, only the lowest half is callee-saved. Evict all
670 // value parts larger than 8 bytes.
671 auto fp_regs = RegisterFile::bank_regs(Config::FP_BANK);
672 auto fp_csrs = fp_regs & this->assigner.get_ccinfo().callee_saved_regs;
673 auto used_fp_csrs = fp_csrs & this->compiler.register_file.used;
674 for (auto reg_id : util::BitSetIterator<>{used_fp_csrs}) {
675 Reg reg{reg_id};
676 ValLocalIdx local_idx = this->compiler.register_file.reg_local_idx(reg);
677 auto part = this->compiler.register_file.reg_part(reg);
678 AssignmentPartRef ap{this->compiler.val_assignment(local_idx), part};
679 if (ap.part_size() > 8) {
680 this->compiler.evict(ap);
681 }
682 }
683
684 if (auto *sym = std::get_if<SymRef>(&target)) {
685 ASMC(&this->compiler, BL, 0);
686 this->compiler.reloc_text(
687 *sym, elf::R_AARCH64_CALL26, this->compiler.text_writer.offset() - 4);
688 } else {
689 ValuePart &tvp = std::get<ValuePart>(target);
690 if (tvp.can_salvage()) {
691 ASMC(&this->compiler, BLR, tvp.salvage(&this->compiler));
692 } else {
693 AsmReg reg = this->compiler.permanent_scratch_reg;
694 tvp.reload_into_specific_fixed(&this->compiler, reg);
695 ASMC(&this->compiler, BLR, reg);
696 }
697 tvp.reset(&this->compiler);
698 }
699
700 if (stack_adjust_off != 0) {
701 ASMC(&this->compiler, ADDxi, DA_SP, DA_SP, sub);
702 }
703}
704
705template <IRAdaptor Adaptor,
706 typename Derived,
707 template <typename, typename, typename> typename BaseTy,
708 typename Config>
710 CCAssigner *cc_assigner) {
711 func_ret_offs.clear();
712 func_start_off = this->text_writer.offset();
713
714 const CCInfo &cc_info = cc_assigner->get_ccinfo();
715
716 // We don't actually generate the prologue here and merely allocate space
717 // for it. Right now, we don't know which callee-saved registers will be
718 // used. While we could pad with nops, we later move the beginning of the
719 // function so that small functions don't have to execute 9 nops.
720 // See finish_func.
721 this->stack.frame_size = 16; // FP, LR
722 {
723 auto csr = cc_info.callee_saved_regs;
724 auto csr_gp = csr & this->register_file.bank_regs(Config::GP_BANK);
725 auto csr_fp = csr & this->register_file.bank_regs(Config::FP_BANK);
726 u32 gp_saves = std::popcount(csr_gp);
727 u32 fp_saves = std::popcount(csr_fp);
728 // LDP/STP can handle two registers of the same bank.
729 u32 reg_save_size = 4 * ((gp_saves + 1) / 2 + (fp_saves + 1) / 2);
730 // TODO: support CSR of Qx/Vx registers, not just Dx
731 this->stack.frame_size += util::align_up(gp_saves * 8 + fp_saves * 8, 16);
732
733 // Reserve space for sub sp, stp x29/x30, and mov x29, sp.
734 func_prologue_alloc = reg_save_size + 12;
735 this->text_writer.ensure_space(func_prologue_alloc);
736 this->text_writer.cur_ptr() += func_prologue_alloc;
737 }
738
739 // TODO(ts): support larger stack alignments?
740
741 if (this->adaptor->cur_is_vararg()) [[unlikely]] {
742 this->stack.frame_used = true;
743 reg_save_frame_off = this->stack.frame_size;
744 // We additionally store a pointer to the stack area, which we can't compute
745 // with a constant offset from the frame pointer. Add 16 bytes to maintain
746 // alignment.
747 this->stack.frame_size += 8 * 8 + 8 * 16 + 16;
748 this->text_writer.ensure_space(4 * 8);
749 ASMNC(STPx, DA_GP(0), DA_GP(1), DA_SP, reg_save_frame_off);
750 ASMNC(STPx, DA_GP(2), DA_GP(3), DA_SP, reg_save_frame_off + 16);
751 ASMNC(STPx, DA_GP(4), DA_GP(5), DA_SP, reg_save_frame_off + 32);
752 ASMNC(STPx, DA_GP(6), DA_GP(7), DA_SP, reg_save_frame_off + 48);
753 ASMNC(STPq, DA_V(0), DA_V(1), DA_SP, reg_save_frame_off + 64);
754 ASMNC(STPq, DA_V(2), DA_V(3), DA_SP, reg_save_frame_off + 96);
755 ASMNC(STPq, DA_V(4), DA_V(5), DA_SP, reg_save_frame_off + 128);
756 ASMNC(STPq, DA_V(6), DA_V(7), DA_SP, reg_save_frame_off + 160);
757 }
758
759 this->func_arg_stack_add_off = ~0u;
760}
761
762template <IRAdaptor Adaptor,
763 typename Derived,
764 template <typename, typename, typename> typename BaseTy,
765 typename Config>
766std::optional<i32>
768 ValuePart &&vp, CCAssignment cca) {
769 if (cca.reg.valid()) [[likely]] {
770 vp.set_value_reg(this, cca.reg);
771 // Mark register as allocatable as soon as it is assigned. If the argument
772 // is unused, the register will be freed immediately and can be used for
773 // later stack arguments.
774 this->register_file.allocatable |= u64{1} << cca.reg.id();
775 return {};
776 }
777
778 AsmReg dst = vp.alloc_reg(this);
779
780 AsmReg stack_reg = AsmReg::R17;
781 // TODO: allocate an actual scratch register for this.
782 assert(!(this->register_file.allocatable & (u64{1} << stack_reg.id())) &&
783 "x17 must not be allocatable");
784 if (this->func_arg_stack_add_off == ~0u) {
785 this->func_arg_stack_add_off = this->text_writer.offset();
786 this->func_arg_stack_add_reg = stack_reg;
787 // Fixed in finish_func when frame size is known
788 ASM(ADDxi, stack_reg, DA_SP, 0);
789 }
790
791 if (cca.byval) {
792 if (!ASMIF(ADDxi, dst, stack_reg, cca.stack_off)) {
793 materialize_constant(cca.stack_off, Config::GP_BANK, 8, dst);
794 ASM(ADDx, dst, stack_reg, dst);
795 }
796 } else {
797 this->load_off(dst, stack_reg, cca.stack_off, cca.size);
798 }
799 return {};
800}
801
802template <IRAdaptor Adaptor,
803 typename Derived,
804 template <typename, typename, typename> typename BaseTy,
805 typename Config>
807 CCAssigner *cc_assigner) {
808 // Hack: we don't know the frame size, so for a va_start(), we cannot easily
809 // compute the offset from the frame pointer. But we have a stack_reg here,
810 // so use it for var args.
811 if (this->adaptor->cur_is_vararg()) [[unlikely]] {
812 this->stack.frame_used = true;
813 AsmReg stack_reg = AsmReg::R17;
814 // TODO: allocate an actual scratch register for this.
815 assert(!(this->register_file.allocatable & (u64{1} << stack_reg.id())) &&
816 "x17 must not be allocatable");
817 if (this->func_arg_stack_add_off == ~0u) {
818 this->func_arg_stack_add_off = this->text_writer.offset();
819 this->func_arg_stack_add_reg = stack_reg;
820 // Fixed in finish_func when frame size is known
821 ASMC(this, ADDxi, stack_reg, DA_SP, 0);
822 }
823 ASM(ADDxi, stack_reg, stack_reg, cc_assigner->get_stack_size());
824 ASM(STRxu, stack_reg, DA_GP(29), this->reg_save_frame_off + 192);
825
826 // TODO: extract ngrn/nsrn from CCAssigner
827 // TODO: this isn't quite accurate, e.g. for (i128, i128, i128, i64, i128),
828 // this should be 8 but will end up with 7.
829 const CCInfo &cc_info = cc_assigner->get_ccinfo();
830 auto arg_regs = this->register_file.allocatable & cc_info.arg_regs;
831 u32 ngrn = 8 - util::cnt_lz<u16>((arg_regs & 0xff) << 8 | 0x80);
832 u32 nsrn = 8 - util::cnt_lz<u16>(((arg_regs >> 32) & 0xff) << 8 | 0x80);
833 this->scalar_arg_count = ngrn;
834 this->vec_arg_count = nsrn;
835 }
836}
837
838template <IRAdaptor Adaptor,
839 typename Derived,
840 template <typename, typename, typename> typename BaseTy,
841 typename Config>
842void CompilerA64<Adaptor, Derived, BaseTy, Config>::finish_func(u32 func_idx) {
843 auto csr = derived()->cur_cc_assigner()->get_ccinfo().callee_saved_regs;
844 u64 saved_regs = this->register_file.clobbered & csr;
845
846 auto stack_reg = DA_SP;
847 if (this->stack.has_dynamic_alloca) {
848 stack_reg = DA_GP(29);
849 }
850
851 auto final_frame_size = util::align_up(this->stack.frame_size, 16);
852 if (final_frame_size > 4095) {
853 // round up to 4k since SUB cannot encode immediates greater than 4095
854 final_frame_size = util::align_up(final_frame_size, 4096);
855 assert(final_frame_size < 16 * 1024 * 1024);
856 }
857
858 bool needs_stack_frame =
859 this->stack.frame_used || this->stack.generated_call ||
860 this->stack.has_dynamic_alloca || saved_regs != 0 ||
861 (this->register_file.clobbered & (u64{1} << AsmReg::LR));
862
863 this->text_writer.eh_begin_fde(this->get_personality_sym());
864
865 u32 prologue_size = 0;
866 if (needs_stack_frame) [[likely]] {
867 // NB: code alignment factor 4, data alignment factor -8.
868 util::SmallVector<u32, 16> prologue;
869 // For small stack frames, remember the state at the very beginning, which
870 // is identical to the state after the post-increment LDP. For large stack
871 // frames, remember the state after the SP adjustment (encoding the
872 // corresponding DW_def_cfa SP, framesize would be >=3 bytes; this way we
873 // can get away with a DW_def_cfa_offset 0 after the ADD).
874 if (!func_ret_offs.empty() && final_frame_size <= 0x1f8) {
875 this->text_writer.eh_write_inst(dwarf::DW_CFA_remember_state);
876 }
877 this->text_writer.eh_write_inst(dwarf::DW_CFA_advance_loc, 1);
878 this->text_writer.eh_write_inst(dwarf::DW_CFA_def_cfa_offset,
879 final_frame_size);
880 if (final_frame_size <= 0x1f8) {
881 prologue.push_back(
882 de64_STPx_pre(DA_GP(29), DA_GP(30), DA_SP, -int(final_frame_size)));
883 prologue.push_back(de64_MOV_SPx(DA_GP(29), DA_SP));
884 } else {
885 if (!func_ret_offs.empty()) {
886 this->text_writer.eh_write_inst(dwarf::DW_CFA_remember_state);
887 }
888 prologue.push_back(de64_SUBxi(DA_SP, DA_SP, final_frame_size));
889 prologue.push_back(de64_STPx(DA_GP(29), DA_GP(30), DA_SP, 0));
890 prologue.push_back(de64_MOV_SPx(DA_GP(29), DA_SP));
891 }
892
893 // Patched below
894 auto fde_prologue_adv_off = this->text_writer.eh_writer.size();
895 this->text_writer.eh_write_inst(dwarf::DW_CFA_advance_loc, 0);
896 this->text_writer.eh_write_inst(dwarf::DW_CFA_def_cfa_register,
897 dwarf::a64::DW_reg_fp);
898 this->text_writer.eh_write_inst(
899 dwarf::DW_CFA_offset, dwarf::a64::DW_reg_fp, final_frame_size / 8);
900 this->text_writer.eh_write_inst(
901 dwarf::DW_CFA_offset, dwarf::a64::DW_reg_lr, final_frame_size / 8 - 1);
902
903 AsmReg last_reg = AsmReg::make_invalid();
904 u32 frame_off = 16;
905 for (auto reg : util::BitSetIterator{saved_regs}) {
906 u8 dwarf_base = reg < 32 ? dwarf::a64::DW_reg_x0 : dwarf::a64::DW_reg_v0;
907 u8 dwarf_reg = dwarf_base + reg % 32;
908 u32 cfa_off = (final_frame_size - frame_off) / 8 - last_reg.valid();
909 if ((dwarf_reg & dwarf::DWARF_CFI_PRIMARY_OPCODE_MASK) == 0) {
910 this->text_writer.eh_write_inst(
911 dwarf::DW_CFA_offset, dwarf_reg, cfa_off);
912 } else {
913 this->text_writer.eh_write_inst(
914 dwarf::DW_CFA_offset_extended, dwarf_reg, cfa_off);
915 }
916
917 if (last_reg.valid()) {
918 const auto reg_bank = this->register_file.reg_bank(AsmReg{reg});
919 const auto last_bank = this->register_file.reg_bank(last_reg);
920 if (reg_bank == last_bank) {
921 if (reg_bank == Config::GP_BANK) {
922 prologue.push_back(
923 de64_STPx(last_reg, AsmReg{reg}, stack_reg, frame_off));
924 } else {
925 prologue.push_back(
926 de64_STPd(last_reg, AsmReg{reg}, stack_reg, frame_off));
927 }
928 frame_off += 16;
929 last_reg = AsmReg::make_invalid();
930 } else {
931 assert(last_bank == Config::GP_BANK && reg_bank == Config::FP_BANK);
932 prologue.push_back(de64_STRxu(last_reg, stack_reg, frame_off));
933 frame_off += 8;
934 last_reg = AsmReg{reg};
935 }
936 } else {
937 last_reg = AsmReg{reg};
938 }
939 }
940
941 if (last_reg.valid()) {
942 if (this->register_file.reg_bank(last_reg) == Config::GP_BANK) {
943 prologue.push_back(de64_STRxu(last_reg, stack_reg, frame_off));
944 } else {
945 assert(this->register_file.reg_bank(last_reg) == Config::FP_BANK);
946 prologue.push_back(de64_STRdu(last_reg, stack_reg, frame_off));
947 }
948 }
949
950 assert(prologue.size() * sizeof(u32) <= func_prologue_alloc);
951
952 assert(prologue.size() < 0x4c);
953 this->text_writer.eh_writer.data()[fde_prologue_adv_off] =
954 dwarf::DW_CFA_advance_loc | (prologue.size() - 1);
955
956 std::memcpy(this->text_writer.begin_ptr() + func_start_off,
957 prologue.data(),
958 prologue.size() * sizeof(u32));
959
960 prologue_size = prologue.size() * sizeof(u32);
961 }
962
963 if (func_arg_stack_add_off != ~0u) {
964 auto *raw_inst_ptr = this->text_writer.begin_ptr() + func_arg_stack_add_off;
965 u32 *inst_ptr = reinterpret_cast<u32 *>(raw_inst_ptr);
966 if (needs_stack_frame) {
967 *inst_ptr = de64_ADDxi(func_arg_stack_add_reg, DA_SP, final_frame_size);
968 } else {
969 *inst_ptr = de64_MOV_SPx(func_arg_stack_add_reg, DA_SP);
970 }
971 }
972
973 if (!func_ret_offs.empty()) {
974 u8 *text_data = this->text_writer.begin_ptr();
975 if (func_ret_offs.back() == this->text_writer.offset() - 4) {
976 this->text_writer.cur_ptr() -= 4;
977 func_ret_offs.pop_back();
978 }
979 for (auto ret_off : func_ret_offs) {
980 u32 *write_ptr = reinterpret_cast<u32 *>(text_data + ret_off);
981 *write_ptr = de64_B((this->text_writer.offset() - ret_off) / 4);
982 }
983
984 // Epilogue mirrors prologue + RET
985 this->text_writer.ensure_space(prologue_size + 4);
986
987 if (this->stack.has_dynamic_alloca) {
988 ASMNC(MOV_SPx, DA_SP, DA_GP(29));
989 }
990
991 AsmReg last_reg = AsmReg::make_invalid();
992 u32 frame_off = 16;
993 for (auto reg : util::BitSetIterator{saved_regs}) {
994 if (last_reg.valid()) {
995 const auto reg_bank = this->register_file.reg_bank(AsmReg{reg});
996 const auto last_bank = this->register_file.reg_bank(last_reg);
997 if (reg_bank == last_bank) {
998 if (reg_bank == Config::GP_BANK) {
999 ASMNC(LDPx, last_reg, AsmReg{reg}, stack_reg, frame_off);
1000 } else {
1001 ASMNC(LDPd, last_reg, AsmReg{reg}, stack_reg, frame_off);
1002 }
1003 frame_off += 16;
1004 last_reg = AsmReg::make_invalid();
1005 } else {
1006 assert(last_bank == Config::GP_BANK && reg_bank == Config::FP_BANK);
1007 ASMNC(LDRxu, last_reg, stack_reg, frame_off);
1008 frame_off += 8;
1009 last_reg = AsmReg{reg};
1010 }
1011 continue;
1012 }
1013
1014 last_reg = AsmReg{reg};
1015 }
1016
1017 if (last_reg.valid()) {
1018 if (this->register_file.reg_bank(last_reg) == Config::GP_BANK) {
1019 ASMNC(LDRxu, last_reg, stack_reg, frame_off);
1020 } else {
1021 ASMNC(LDRdu, last_reg, stack_reg, frame_off);
1022 }
1023 }
1024 if (needs_stack_frame) {
1025 u32 body_start = func_start_off + func_prologue_alloc;
1026 this->text_writer.eh_advance(this->text_writer.offset() - body_start + 4);
1027 this->text_writer.eh_write_inst(dwarf::DW_CFA_restore_state);
1028 if (final_frame_size <= 0x1f8) {
1029 ASMNC(LDPx_post, DA_GP(29), DA_GP(30), DA_SP, final_frame_size);
1030 // CFI is correct here.
1031 } else {
1032 ASMNC(LDPx, DA_GP(29), DA_GP(30), DA_SP, 0);
1033 // CFI is correct here, but we need to update the CFA after the ADD.
1034 ASMNC(ADDxi, DA_SP, DA_SP, final_frame_size);
1035 this->text_writer.eh_write_inst(dwarf::DW_CFA_advance_loc, 1);
1036 this->text_writer.eh_write_inst(dwarf::DW_CFA_def_cfa_offset, 0);
1037 }
1038 }
1039
1040 ASMNC(RET, DA_GP(30));
1041 }
1042
1043 // TODO(ts): honor cur_needs_unwind_info
1044 this->text_writer.remove_prologue_bytes(func_start_off + prologue_size,
1045 func_prologue_alloc - prologue_size);
1046 auto func_size = this->text_writer.offset() - func_start_off;
1047 auto func_sym = this->func_syms[func_idx];
1048 auto func_sec = this->text_writer.get_sec_ref();
1049 this->assembler.sym_def(func_sym, func_sec, func_start_off, func_size);
1050 this->text_writer.eh_end_fde();
1051 this->text_writer.except_encode_func();
1052}
1053
1054template <IRAdaptor Adaptor,
1055 typename Derived,
1056 template <typename, typename, typename> typename BaseTy,
1057 typename Config>
1058void CompilerA64<Adaptor, Derived, BaseTy, Config>::gen_func_epilog() {
1059 // Patched at the end, just reserve the space here.
1060 func_ret_offs.push_back(this->text_writer.offset());
1061 this->text_writer.ensure_space(4); // Single branch to actual epilogue.
1062 this->text_writer.cur_ptr() += 4;
1063}
1064
1065template <IRAdaptor Adaptor,
1066 typename Derived,
1067 template <typename, typename, typename> typename BaseTy,
1068 typename Config>
1069void CompilerA64<Adaptor, Derived, BaseTy, Config>::spill_reg(
1070 const AsmReg reg, const u32 frame_off, const u32 size) {
1071 assert(this->stack.frame_used);
1072 assert((size & (size - 1)) == 0);
1073 assert(util::align_up(frame_off, size) == frame_off);
1074 this->store_off(AsmReg{AsmReg::FP}, frame_off, reg, size);
1075}
1076
1077template <IRAdaptor Adaptor,
1078 typename Derived,
1079 template <typename, typename, typename> typename BaseTy,
1080 typename Config>
1081void CompilerA64<Adaptor, Derived, BaseTy, Config>::load_from_stack(
1082 const AsmReg dst,
1083 const i32 frame_off,
1084 const u32 size,
1085 const bool sign_extend) {
1086 assert(this->stack.frame_used);
1087 assert((size & (size - 1)) == 0);
1088 assert(util::align_up(frame_off, size) == frame_off);
1089 this->load_off(dst, AsmReg{AsmReg::FP}, frame_off, size, sign_extend);
1090}
1091
1092template <IRAdaptor Adaptor,
1093 typename Derived,
1094 template <typename, typename, typename> typename BaseTy,
1095 typename Config>
1096void CompilerA64<Adaptor, Derived, BaseTy, Config>::load_address_of_stack_var(
1097 const AsmReg dst, const AssignmentPartRef ap) {
1098 assert(this->stack.frame_used);
1099 auto frame_off = ap.variable_stack_off();
1100 assert(frame_off >= 0);
1101 if (!ASMIF(ADDxi, dst, DA_GP(29), frame_off)) {
1102 materialize_constant(frame_off, Config::GP_BANK, 4, dst);
1103 ASM(ADDx_uxtw, dst, DA_GP(29), dst, 0);
1104 }
1105}
1106
1107template <IRAdaptor Adaptor,
1108 typename Derived,
1109 template <typename, typename, typename> typename BaseTy,
1110 typename Config>
1112 AsmReg dst, AsmReg base, u32 off, u32 size, bool sext) {
1113 assert(size > 0 && (size & (size - 1)) == 0 && "size must be power of two");
1114 u32 off_mask = 0xfff * size;
1115 if (off & ~off_mask) [[unlikely]] {
1116 // need to calculate this explicitly
1117 AsmReg old_base = base;
1118 base = dst.id() <= AsmReg::R30 ? dst : permanent_scratch_reg;
1119 if (ASMIF(ADDxi, base, old_base, off & ~off_mask)) {
1120 off &= off_mask;
1121 } else {
1122 materialize_constant(off, Config::GP_BANK, 8, base);
1123 ASM(ADDx, base, base, old_base);
1124 off = 0;
1125 }
1126 }
1127
1128 this->text_writer.ensure_space(4);
1129 if (dst.id() <= AsmReg::R30) {
1130 if (!sext) {
1131 switch (size) {
1132 case 1: ASMNC(LDRBu, dst, base, off); break;
1133 case 2: ASMNC(LDRHu, dst, base, off); break;
1134 case 4: ASMNC(LDRwu, dst, base, off); break;
1135 case 8: ASMNC(LDRxu, dst, base, off); break;
1136 default: TPDE_UNREACHABLE("invalid register size");
1137 }
1138 } else {
1139 switch (size) {
1140 case 1: ASMNC(LDRSBwu, dst, base, off); break;
1141 case 2: ASMNC(LDRSHwu, dst, base, off); break;
1142 case 4: ASMNC(LDRSWxu, dst, base, off); break;
1143 case 8: ASMNC(LDRxu, dst, base, off); break;
1144 default: TPDE_UNREACHABLE("invalid register size");
1145 }
1146 }
1147 return;
1148 }
1149
1150 assert(!sext);
1151
1152 switch (size) {
1153 case 1: ASMNC(LDRbu, dst, base, off); break;
1154 case 2: ASMNC(LDRhu, dst, base, off); break;
1155 case 4: ASMNC(LDRsu, dst, base, off); break;
1156 case 8: ASMNC(LDRdu, dst, base, off); break;
1157 case 16: ASMNC(LDRqu, dst, base, off); break;
1158 default: TPDE_UNREACHABLE("invalid register size");
1159 }
1160}
1161
1162template <IRAdaptor Adaptor,
1163 typename Derived,
1164 template <typename, typename, typename> typename BaseTy,
1165 typename Config>
1167 u32 off,
1168 AsmReg src,
1169 u32 size) {
1170 this->text_writer.ensure_space(8);
1171
1172 assert(size > 0 && (size & (size - 1)) == 0 && "size must be power of two");
1173 u32 off_mask = 0xfff * size;
1174 if (off & ~off_mask) [[unlikely]] {
1175 // need to calculate this explicitly
1176 if (ASMIF(ADDxi, permanent_scratch_reg, base, off & ~off_mask)) {
1177 off &= off_mask;
1178 } else {
1179 materialize_constant(off, Config::GP_BANK, 8, permanent_scratch_reg);
1181 off = 0;
1182 }
1183 base = permanent_scratch_reg;
1184 }
1185
1186 if (src.id() <= AsmReg::R30) {
1187 switch (size) {
1188 case 1: ASMNC(STRBu, src, base, off); break;
1189 case 2: ASMNC(STRHu, src, base, off); break;
1190 case 4: ASMNC(STRwu, src, base, off); break;
1191 case 8: ASMNC(STRxu, src, base, off); break;
1192 default: TPDE_UNREACHABLE("invalid srcister size");
1193 }
1194 } else {
1195 switch (size) {
1196 case 1: ASMNC(STRbu, src, base, off); break;
1197 case 2: ASMNC(STRhu, src, base, off); break;
1198 case 4: ASMNC(STRsu, src, base, off); break;
1199 case 8: ASMNC(STRdu, src, base, off); break;
1200 case 16: ASMNC(STRqu, src, base, off); break;
1201 default: TPDE_UNREACHABLE("invalid register size");
1202 }
1203 }
1204}
1205
1206template <IRAdaptor Adaptor,
1207 typename Derived,
1208 template <typename, typename, typename> typename BaseTy,
1209 typename Config>
1210void CompilerA64<Adaptor, Derived, BaseTy, Config>::mov(const AsmReg dst,
1211 const AsmReg src,
1212 const u32 size) {
1213 this->text_writer.ensure_space(4);
1214 assert(dst.valid());
1215 assert(src.valid());
1216 if (dst.id() <= AsmReg::SP && src.id() <= AsmReg::SP) {
1217 assert(dst.id() != AsmReg::SP && src.id() != AsmReg::SP);
1218 if (size > 4) {
1219 ASMNC(MOVx, dst, src);
1220 } else {
1221 ASMNC(MOVw, dst, src);
1222 }
1223 } else if (dst.id() >= AsmReg::V0 && src.id() >= AsmReg::V0) {
1224 ASMNC(ORR16b, dst, src, src);
1225 } else if (dst.id() <= AsmReg::SP) {
1226 assert(dst.id() != AsmReg::SP);
1227 // gp<-vector
1228 assert(src.id() >= AsmReg::V0);
1229 assert(size <= 8);
1230 if (size <= 4) {
1231 ASMNC(FMOVws, dst, src);
1232 } else {
1233 ASMNC(FMOVxd, dst, src);
1234 }
1235 } else {
1236 // vector<-gp
1237 assert(src.id() <= AsmReg::R30);
1238 assert(dst.id() >= AsmReg::V0);
1239 assert(size <= 8);
1240 if (size <= 4) {
1241 ASMNC(FMOVsw, dst, src);
1242 } else {
1243 ASMNC(FMOVdx, dst, src);
1244 }
1245 }
1246}
1247
1248template <IRAdaptor Adaptor,
1249 typename Derived,
1250 template <typename, typename, typename> typename BaseTy,
1251 typename Config>
1252AsmReg CompilerA64<Adaptor, Derived, BaseTy, Config>::gval_expr_as_reg(
1253 GenericValuePart &gv) {
1254 auto &expr = std::get<typename GenericValuePart::Expr>(gv.state);
1255
1256 ScratchReg scratch{derived()};
1257 if (!expr.has_base() && !expr.has_index()) {
1258 AsmReg dst = scratch.alloc_gp();
1259 derived()->materialize_constant(expr.disp, Config::GP_BANK, 8, dst);
1260 expr.disp = 0;
1261 } else if (!expr.has_base() && expr.has_index()) {
1262 AsmReg index_reg = expr.index_reg();
1263 if (std::holds_alternative<ScratchReg>(expr.index)) {
1264 scratch = std::move(std::get<ScratchReg>(expr.index));
1265 } else {
1266 (void)scratch.alloc_gp();
1267 }
1268 AsmReg dst = scratch.cur_reg();
1269 if ((expr.scale & (expr.scale - 1)) == 0) {
1270 const auto shift = util::cnt_tz<u64>(expr.scale);
1271 ASM(LSLxi, dst, index_reg, shift);
1272 } else {
1273 AsmReg tmp2 = permanent_scratch_reg;
1274 derived()->materialize_constant(expr.scale, Config::GP_BANK, 8, tmp2);
1275 ASM(MULx, dst, index_reg, tmp2);
1276 }
1277 } else if (expr.has_base() && expr.has_index()) {
1278 AsmReg base_reg = expr.base_reg();
1279 AsmReg index_reg = expr.index_reg();
1280 if (std::holds_alternative<ScratchReg>(expr.base)) {
1281 scratch = std::move(std::get<ScratchReg>(expr.base));
1282 } else if (std::holds_alternative<ScratchReg>(expr.index)) {
1283 scratch = std::move(std::get<ScratchReg>(expr.index));
1284 } else {
1285 (void)scratch.alloc_gp();
1286 }
1287 AsmReg dst = scratch.cur_reg();
1288 if ((expr.scale & (expr.scale - 1)) == 0) {
1289 const auto shift = util::cnt_tz<u64>(expr.scale);
1290 ASM(ADDx_lsl, dst, base_reg, index_reg, shift);
1291 } else {
1292 AsmReg tmp2 = permanent_scratch_reg;
1293 derived()->materialize_constant(expr.scale, Config::GP_BANK, 8, tmp2);
1294 ASM(MADDx, dst, index_reg, tmp2, base_reg);
1295 }
1296 } else if (expr.has_base() && !expr.has_index()) {
1297 AsmReg base_reg = expr.base_reg();
1298 if (std::holds_alternative<ScratchReg>(expr.base)) {
1299 scratch = std::move(std::get<ScratchReg>(expr.base));
1300 } else {
1301 (void)scratch.alloc_gp();
1302 }
1303 AsmReg dst = scratch.cur_reg();
1304 if (expr.disp != 0 && ASMIF(ADDxi, dst, base_reg, expr.disp)) {
1305 expr.disp = 0;
1306 } else if (dst != base_reg) {
1307 ASM(MOVx, dst, base_reg);
1308 }
1309 } else {
1310 TPDE_UNREACHABLE("inconsistent GenericValuePart::Expr");
1311 }
1312
1313 AsmReg dst = scratch.cur_reg();
1314 if (expr.disp != 0) {
1315 if (!ASMIF(ADDxi, dst, dst, expr.disp)) {
1316 AsmReg tmp2 = permanent_scratch_reg;
1317 derived()->materialize_constant(expr.disp, Config::GP_BANK, 8, tmp2);
1318 ASM(ADDx, dst, dst, tmp2);
1319 }
1320 }
1321
1322 gv.state = std::move(scratch);
1323 return dst;
1324}
1325
1326template <IRAdaptor Adaptor,
1327 typename Derived,
1328 template <typename, typename, typename> typename BaseTy,
1329 typename Config>
1331 u64 size, u32 align, ValuePart &res) {
1332 assert(this->stack.has_dynamic_alloca &&
1333 "function marked as not having dynamic allocas can't have alloca");
1334 assert(align != 0 && (align & (align - 1)) == 0 && "invalid alignment");
1335 size = tpde::util::align_up(size, 16);
1336 AsmReg res_reg = res.alloc_reg(this);
1337 if (size >= 0x10'0000) {
1338 auto tmp = permanent_scratch_reg;
1339 materialize_constant(size, Config::GP_BANK, 8, tmp);
1340 ASM(SUBx_uxtx, res_reg, DA_SP, tmp, 0);
1341 } else if (size >= 0x1000) {
1342 ASM(SUBxi, res_reg, DA_SP, size & 0xff'f000);
1343 if (size & 0xfff) {
1344 ASM(SUBxi, res_reg, res_reg, size & 0xfff);
1345 }
1346 } else {
1347 ASM(SUBxi, res_reg, DA_SP, size & 0xfff);
1348 }
1349
1350 if (align > 16) {
1351 // The stack pointer is always at least 16-byte aligned.
1352 ASM(ANDxi, res_reg, res_reg, ~(u64{align} - 1));
1353 }
1354
1355 if (size > 0) {
1356 ASM(MOV_SPx, DA_SP, res_reg);
1357 }
1358}
1359
1360template <IRAdaptor Adaptor,
1361 typename Derived,
1362 template <typename, typename, typename> typename BaseTy,
1363 typename Config>
1365 u64 elem_size, ValuePart &&count, u32 align, ValuePart &res) {
1366 assert(this->stack.has_dynamic_alloca &&
1367 "function marked as not having dynamic allocas can't have alloca");
1368 assert(align != 0 && (align & (align - 1)) == 0 && "invalid alignment");
1369 AsmReg size_reg = count.has_reg() ? count.cur_reg() : count.load_to_reg(this);
1370 AsmReg res_reg = res.alloc_try_reuse(this, count);
1371
1372 if (elem_size == 0) {
1373 ASM(MOVZw, res_reg, 0);
1374 } else if ((elem_size & (elem_size - 1)) == 0) {
1375 const auto shift = util::cnt_tz(elem_size);
1376 if (shift <= 4) {
1377 ASM(SUBx_uxtx, res_reg, DA_SP, size_reg, shift);
1378 } else {
1379 ASM(LSLxi, res_reg, size_reg, shift);
1380 ASM(SUBx_uxtx, res_reg, DA_SP, res_reg, 0);
1381 }
1382 } else {
1383 auto tmp = permanent_scratch_reg;
1384 materialize_constant(elem_size, Config::GP_BANK, 8, tmp);
1385 ASM(MULx, res_reg, size_reg, tmp);
1386 ASM(SUBx_uxtx, res_reg, DA_SP, res_reg, 0);
1387 }
1388
1389 align = align > 16 ? align : 16;
1390 if (elem_size & (align - 1)) {
1391 ASM(ANDxi, res_reg, res_reg, ~(u64{align} - 1));
1392 }
1393
1394 ASM(MOV_SPx, DA_SP, res_reg);
1395}
1396
1397template <IRAdaptor Adaptor,
1398 typename Derived,
1399 template <typename, typename, typename> typename BaseTy,
1400 typename Config>
1402 const u64 *data, const RegBank bank, const u32 size, AsmReg dst) {
1403 this->text_writer.ensure_space(5 * 4);
1404
1405 const auto const_u64 = data[0];
1406 if (bank == Config::GP_BANK) {
1407 assert(size <= 8);
1408 if (const_u64 == 0) {
1409 ASMNC(MOVZw, dst, 0);
1410 return;
1411 }
1412
1413 this->text_writer.cur_ptr() +=
1414 sizeof(u32) *
1415 de64_MOVconst(reinterpret_cast<u32 *>(this->text_writer.cur_ptr()),
1416 dst,
1417 const_u64);
1418 return;
1419 }
1420
1421 assert(bank == Config::FP_BANK);
1422 // Try instructions that take an immediate
1423 if (size == 4) {
1424 if (ASMIF(FMOVsi, dst, std::bit_cast<float>((u32)const_u64))) {
1425 return;
1426 } else if (ASMIF(MOVId, dst, static_cast<u32>(const_u64))) {
1427 return;
1428 }
1429 } else if (size == 8) {
1430 if (ASMIF(FMOVdi, dst, std::bit_cast<double>(const_u64))) {
1431 return;
1432 } else if (ASMIF(MOVId, dst, const_u64)) {
1433 return;
1434 }
1435 } else if (size == 16) {
1436 const auto high_u64 = data[1];
1437 if (const_u64 == high_u64 && ASMIF(MOVI2d, dst, const_u64)) {
1438 return;
1439 } else if (high_u64 == 0 && ASMIF(MOVId, dst, const_u64)) {
1440 return;
1441 }
1442 }
1443
1444 // We must either load through a GP register of from memory. Both cases need a
1445 // GP register in the common case. We reserve x16/x17 for cases like this.
1446 if (size <= 16) {
1447 this->register_file.mark_clobbered(permanent_scratch_reg);
1448 // Copy from a GP register
1449 // TODO: always load from memory?
1450 if (size <= 8) {
1451 materialize_constant(data, Config::GP_BANK, size, permanent_scratch_reg);
1452 if (size <= 4) {
1453 ASMNC(FMOVsw, dst, permanent_scratch_reg);
1454 } else {
1455 ASMNC(FMOVdx, dst, permanent_scratch_reg);
1456 }
1457 return;
1458 }
1459
1460 auto rodata = this->assembler.get_default_section(SectionKind::ReadOnly);
1461 std::span<const u8> raw_data{reinterpret_cast<const u8 *>(data), size};
1462 auto sym = this->assembler.sym_def_data(
1463 rodata, "", raw_data, 16, Assembler::SymBinding::LOCAL);
1464 this->text_writer.ensure_space(8); // ensure contiguous instructions
1465 this->reloc_text(
1466 sym, elf::R_AARCH64_ADR_PREL_PG_HI21, this->text_writer.offset(), 0);
1467 ASMNC(ADRP, permanent_scratch_reg, 0, 0);
1468 this->reloc_text(
1469 sym, elf::R_AARCH64_LDST128_ABS_LO12_NC, this->text_writer.offset(), 0);
1470 ASMNC(LDRqu, dst, permanent_scratch_reg, 0);
1471 return;
1472 }
1473
1474 TPDE_FATAL("unable to materialize constant");
1475}
1476
1477template <IRAdaptor Adaptor,
1478 typename Derived,
1479 template <typename, typename, typename> typename BaseTy,
1480 typename Config>
1481AsmReg
1482 CompilerA64<Adaptor, Derived, BaseTy, Config>::select_fixed_assignment_reg(
1483 AssignmentPartRef ap, IRValueRef) {
1484 RegBank bank = ap.bank();
1485 if (bank == Config::FP_BANK && ap.part_size() > 8) {
1486 // FP registers can not in general be fixed registers, as only the lowest 8
1487 // bytes are callee-saved.
1488 return AsmReg::make_invalid();
1489 }
1490
1491 // TODO(ts): why is this in here?
1492 assert(bank.id() <= Config::NUM_BANKS);
1493 auto reg_mask = this->register_file.bank_regs(bank);
1494 reg_mask &= ~fixed_assignment_nonallocatable_mask;
1495
1496 const auto find_possible_regs = [this,
1497 reg_mask](const u64 preferred_regs) -> u64 {
1498 // try to first get an unused reg, otherwise an unfixed reg
1499 u64 free_regs = this->register_file.allocatable & ~this->register_file.used;
1500 return free_regs & preferred_regs & reg_mask;
1501 };
1502
1503 u64 possible_regs;
1504 auto csr = derived()->cur_cc_assigner()->get_ccinfo().callee_saved_regs;
1505 if (!this->stack.is_leaf_function) {
1506 // we can only allocated fixed assignments from the callee-saved regs
1507 possible_regs = find_possible_regs(csr);
1508 } else {
1509 // try allocating any non-callee saved register first, except the result
1510 // registers
1511 possible_regs = find_possible_regs(~csr);
1512 if (possible_regs == 0) {
1513 // otherwise fallback to callee-saved regs
1514 possible_regs = find_possible_regs(csr);
1515 }
1516 }
1517
1518 if (possible_regs == 0) {
1519 return AsmReg::make_invalid();
1520 }
1521
1522 // try to first get an unused reg, otherwise an unfixed reg
1523 if ((possible_regs & ~this->register_file.used) != 0) {
1524 return AsmReg{util::cnt_tz(possible_regs & ~this->register_file.used)};
1525 }
1526
1527 for (const auto reg_id : util::BitSetIterator<>{possible_regs}) {
1528 const auto reg = AsmReg{reg_id};
1529
1530 assert(!this->register_file.is_fixed(reg));
1531
1532 const auto local_idx = this->register_file.reg_local_idx(reg);
1533 const auto part = this->register_file.reg_part(reg);
1534 assert(local_idx != Base::INVALID_VAL_LOCAL_IDX);
1535
1536 auto *assignment = this->val_assignment(local_idx);
1537 auto ap = AssignmentPartRef{assignment, part};
1538 if (ap.modified()) {
1539 continue;
1540 }
1541
1542 return reg;
1543 }
1544
1545 return AsmReg::make_invalid();
1546}
1547
1548template <IRAdaptor Adaptor,
1549 typename Derived,
1550 template <typename, typename, typename> class BaseTy,
1551 typename Config>
1552typename CompilerA64<Adaptor, Derived, BaseTy, Config>::Jump
1553 CompilerA64<Adaptor, Derived, BaseTy, Config>::invert_jump(Jump jmp) {
1554 switch (jmp.kind) {
1555 case Jump::Jeq: return jmp.change_kind(Jump::Jne);
1556 case Jump::Jne: return jmp.change_kind(Jump::Jeq);
1557 case Jump::Jcs: return jmp.change_kind(Jump::Jcc);
1558 case Jump::Jcc: return jmp.change_kind(Jump::Jcs);
1559 case Jump::Jmi: return jmp.change_kind(Jump::Jpl);
1560 case Jump::Jpl: return jmp.change_kind(Jump::Jmi);
1561 case Jump::Jvs: return jmp.change_kind(Jump::Jvc);
1562 case Jump::Jvc: return jmp.change_kind(Jump::Jvs);
1563 case Jump::Jhi: return jmp.change_kind(Jump::Jls);
1564 case Jump::Jls: return jmp.change_kind(Jump::Jhi);
1565 case Jump::Jge: return jmp.change_kind(Jump::Jlt);
1566 case Jump::Jlt: return jmp.change_kind(Jump::Jge);
1567 case Jump::Jgt: return jmp.change_kind(Jump::Jle);
1568 case Jump::Jle: return jmp.change_kind(Jump::Jgt);
1569 case Jump::jmp: return jmp;
1570 case Jump::Cbz: return jmp.change_kind(Jump::Cbnz);
1571 case Jump::Cbnz: return jmp.change_kind(Jump::Cbz);
1572 case Jump::Tbz: return jmp.change_kind(Jump::Tbnz);
1573 case Jump::Tbnz: return jmp.change_kind(Jump::Tbz);
1574 default: TPDE_UNREACHABLE("invalid jump kind");
1575 }
1576}
1577
1578template <IRAdaptor Adaptor,
1579 typename Derived,
1580 template <typename, typename, typename> typename BaseTy,
1581 typename Config>
1582typename CompilerA64<Adaptor, Derived, BaseTy, Config>::Jump
1583 CompilerA64<Adaptor, Derived, BaseTy, Config>::swap_jump(Jump jmp) {
1584 switch (jmp.kind) {
1585 case Jump::Jeq: return jmp.change_kind(Jump::Jeq);
1586 case Jump::Jne: return jmp.change_kind(Jump::Jne);
1587 case Jump::Jcc: return jmp.change_kind(Jump::Jhi);
1588 case Jump::Jcs: return jmp.change_kind(Jump::Jls);
1589 case Jump::Jhi: return jmp.change_kind(Jump::Jcc);
1590 case Jump::Jls: return jmp.change_kind(Jump::Jcs);
1591 case Jump::Jge: return jmp.change_kind(Jump::Jle);
1592 case Jump::Jlt: return jmp.change_kind(Jump::Jgt);
1593 case Jump::Jgt: return jmp.change_kind(Jump::Jlt);
1594 case Jump::Jle: return jmp.change_kind(Jump::Jge);
1595 case Jump::jmp: return jmp;
1596 case Jump::Jmi:
1597 case Jump::Jpl:
1598 case Jump::Jvs:
1599 case Jump::Jvc:
1600 case Jump::Cbz:
1601 case Jump::Cbnz:
1602 case Jump::Tbz:
1603 case Jump::Tbnz:
1604 default: TPDE_UNREACHABLE("invalid jump kind for swap_jump");
1605 }
1606}
1607
1608template <IRAdaptor Adaptor,
1609 typename Derived,
1610 template <typename, typename, typename> typename BaseTy,
1611 typename Config>
1613 Jump jmp, Label target_label) {
1614 const auto is_pending = this->text_writer.label_is_pending(target_label);
1615 this->text_writer.ensure_space(4);
1616 if (jmp.kind == Jump::jmp) {
1617 if (is_pending) {
1618 ASMNC(B, 0);
1619 this->text_writer.label_ref(target_label,
1620 this->text_writer.offset() - 4,
1621 LabelFixupKind::AARCH64_BR);
1622 } else {
1623 const auto label_off = this->text_writer.label_offset(target_label);
1624 const auto cur_off = this->text_writer.offset();
1625 assert(cur_off >= label_off);
1626 const auto diff = cur_off - label_off;
1627 assert((diff & 0b11) == 0);
1628 assert(diff < 128 * 1024 * 1024);
1629
1630 ASMNC(B, -static_cast<ptrdiff_t>(diff) / 4);
1631 }
1632 return;
1633 }
1634
1635 if (jmp.kind == Jump::Cbz || jmp.kind == Jump::Cbnz) {
1636 u32 off = 0;
1637 if (!is_pending) {
1638 const auto label_off = this->text_writer.label_offset(target_label);
1639 const auto cur_off = this->text_writer.offset();
1640 assert(cur_off >= label_off);
1641 off = cur_off - label_off;
1642 assert((off & 0b11) == 0);
1643 assert(off < 128 * 1024 * 1024);
1644 }
1645
1646 if (off <= 1024 * 1024) {
1647 auto imm19 = -static_cast<ptrdiff_t>(off) / 4;
1648 if (jmp.kind == Jump::Cbz) {
1649 if (jmp.cmp_is_32) {
1650 ASMNC(CBZw, jmp.cmp_reg, imm19);
1651 } else {
1652 ASMNC(CBZx, jmp.cmp_reg, imm19);
1653 }
1654 } else {
1655 if (jmp.cmp_is_32) {
1656 ASMNC(CBNZw, jmp.cmp_reg, imm19);
1657 } else {
1658 ASMNC(CBNZx, jmp.cmp_reg, imm19);
1659 }
1660 }
1661
1662 if (is_pending) {
1663 this->text_writer.label_ref(target_label,
1664 this->text_writer.offset() - 4,
1665 LabelFixupKind::AARCH64_COND_BR);
1666 }
1667 } else {
1668 assert(!is_pending);
1669 this->text_writer.ensure_space(2 * 4);
1670
1671 if (jmp.kind == Jump::Cbz) {
1672 if (jmp.cmp_is_32) { // need to jump over 2 instructions
1673 ASMNC(CBNZw, jmp.cmp_reg, 2);
1674 } else {
1675 ASMNC(CBNZx, jmp.cmp_reg, 2);
1676 }
1677 } else {
1678 if (jmp.cmp_is_32) {
1679 ASMNC(CBZw, jmp.cmp_reg, 2);
1680 } else {
1681 ASMNC(CBZx, jmp.cmp_reg, 2);
1682 }
1683 }
1684 // + 4 since we already wrote the cb(n)z instruction
1685 ASMNC(B, -static_cast<ptrdiff_t>(off + 4) / 4);
1686 }
1687 return;
1688 }
1689
1690 if (jmp.kind == Jump::Tbz || jmp.kind == Jump::Tbnz) {
1691 u32 off = 0;
1692 if (!is_pending) {
1693 const auto label_off = this->text_writer.label_offset(target_label);
1694 const auto cur_off = this->text_writer.offset();
1695 assert(cur_off >= label_off);
1696 off = cur_off - label_off;
1697 assert((off & 0b11) == 0);
1698 assert(off < 128 * 1024 * 1024);
1699 }
1700
1701 if (off <= 32 * 1024) {
1702 auto imm14 = -static_cast<ptrdiff_t>(off) / 4;
1703 if (jmp.kind == Jump::Tbz) {
1704 ASMNC(TBZ, jmp.cmp_reg, jmp.test_bit, imm14);
1705 } else {
1706 ASMNC(TBNZ, jmp.cmp_reg, jmp.test_bit, imm14);
1707 }
1708
1709 if (is_pending) {
1710 this->text_writer.label_ref(target_label,
1711 this->text_writer.offset() - 4,
1712 LabelFixupKind::AARCH64_TEST_BR);
1713 }
1714 } else {
1715 assert(!is_pending);
1716 this->text_writer.ensure_space(2 * 4);
1717
1718 if (jmp.kind == Jump::Tbz) {
1719 // need to jump over 2 instructions
1720 ASMNC(TBNZ, jmp.cmp_reg, jmp.test_bit, 2);
1721 } else {
1722 ASMNC(TBZ, jmp.cmp_reg, jmp.test_bit, 2);
1723 }
1724 // + 4 since we already wrote the tb(n)z instruction
1725 ASMNC(B, -static_cast<ptrdiff_t>(off + 4) / 4);
1726 }
1727 return;
1728 }
1729
1730 Da64Cond cond, cond_compl;
1731 switch (jmp.kind) {
1732 case Jump::Jeq:
1733 cond = DA_EQ;
1734 cond_compl = DA_NE;
1735 break;
1736 case Jump::Jne:
1737 cond = DA_NE;
1738 cond_compl = DA_EQ;
1739 break;
1740 case Jump::Jcs:
1741 cond = DA_CS;
1742 cond_compl = DA_CC;
1743 break;
1744 case Jump::Jcc:
1745 cond = DA_CC;
1746 cond_compl = DA_CS;
1747 break;
1748 case Jump::Jmi:
1749 cond = DA_MI;
1750 cond_compl = DA_PL;
1751 break;
1752 case Jump::Jpl:
1753 cond = DA_PL;
1754 cond_compl = DA_MI;
1755 break;
1756 case Jump::Jvs:
1757 cond = DA_VS;
1758 cond_compl = DA_VC;
1759 break;
1760 case Jump::Jvc:
1761 cond = DA_VC;
1762 cond_compl = DA_VS;
1763 break;
1764 case Jump::Jhi:
1765 cond = DA_HI;
1766 cond_compl = DA_LS;
1767 break;
1768 case Jump::Jls:
1769 cond = DA_LS;
1770 cond_compl = DA_HI;
1771 break;
1772 case Jump::Jge:
1773 cond = DA_GE;
1774 cond_compl = DA_LT;
1775 break;
1776 case Jump::Jlt:
1777 cond = DA_LT;
1778 cond_compl = DA_GE;
1779 break;
1780 case Jump::Jgt:
1781 cond = DA_GT;
1782 cond_compl = DA_LE;
1783 break;
1784 case Jump::Jle:
1785 cond = DA_LE;
1786 cond_compl = DA_GT;
1787 break;
1788 default: TPDE_UNREACHABLE("invalid jump kind");
1789 }
1790
1791
1792 u32 off = 0;
1793 if (!is_pending) {
1794 const auto label_off = this->text_writer.label_offset(target_label);
1795 const auto cur_off = this->text_writer.offset();
1796 assert(cur_off >= label_off);
1797 off = cur_off - label_off;
1798 assert((off & 0b11) == 0);
1799 assert(off < 128 * 1024 * 1024);
1800 }
1801
1802 if (off <= 1024 * 1024) {
1803 ASMNC(BCOND, cond, -static_cast<ptrdiff_t>(off) / 4);
1804
1805 if (is_pending) {
1806 this->text_writer.label_ref(target_label,
1807 this->text_writer.offset() - 4,
1808 LabelFixupKind::AARCH64_COND_BR);
1809 }
1810 } else {
1811 assert(!is_pending);
1812 this->text_writer.ensure_space(2 * 4);
1813
1814 // 2 to skip over the branch following
1815 ASMNC(BCOND, cond_compl, 2);
1816 // + 4 since we already wrote the branch instruction
1817 ASMNC(B, -static_cast<ptrdiff_t>(off + 4) / 4);
1818 }
1819}
1820template <IRAdaptor Adaptor,
1821 typename Derived,
1822 template <typename, typename, typename> class BaseTy,
1823 typename Config>
1825 switch (jmp.kind) {
1826 case Jump::Jeq: return DA_EQ;
1827 case Jump::Jne: return DA_NE;
1828 case Jump::Jcs: return DA_CS;
1829 case Jump::Jcc: return DA_CC;
1830 case Jump::Jmi: return DA_MI;
1831 case Jump::Jpl: return DA_PL;
1832 case Jump::Jvs: return DA_VS;
1833 case Jump::Jvc: return DA_VC;
1834 case Jump::Jhi: return DA_HI;
1835 case Jump::Jls: return DA_LS;
1836 case Jump::Jge: return DA_GE;
1837 case Jump::Jlt: return DA_LT;
1838 case Jump::Jgt: return DA_GT;
1839 case Jump::Jle: return DA_LE;
1840 case Jump::jmp: return DA_AL;
1841 default: TPDE_UNREACHABLE("invalid jump kind for conversion to Da64Cond");
1842 }
1843}
1844
1845template <IRAdaptor Adaptor,
1846 typename Derived,
1847 template <typename, typename, typename> class BaseTy,
1848 typename Config>
1850 Jump cc, AsmReg dst) {
1851 ASM(CSETw, dst, jump_to_cond(cc));
1852}
1853
1854template <IRAdaptor Adaptor,
1855 typename Derived,
1856 template <typename, typename, typename> class BaseTy,
1857 typename Config>
1859 Jump cc, AsmReg dst) {
1860 ASM(CSETMx, dst, jump_to_cond(cc));
1861}
1862template <IRAdaptor Adaptor,
1863 typename Derived,
1864 template <typename, typename, typename> class BaseTy,
1865 typename Config>
1867 Jump cc, AsmReg dst, AsmReg true_select, AsmReg false_select, bool is_64) {
1868 this->text_writer.ensure_space(4);
1869 Da64Cond cond = jump_to_cond(cc);
1870 if (is_64) {
1871 ASMNC(CSELx, dst, true_select, false_select, cond);
1872 } else {
1873 ASMNC(CSELw, dst, true_select, false_select, cond);
1874 }
1875}
1876
1877template <IRAdaptor Adaptor,
1878 typename Derived,
1879 template <typename, typename, typename> class BaseTy,
1880 typename Config>
1882 AsmReg dst, AsmReg src, bool sign, u32 from, u32 to) {
1883 assert(from < to && to <= 64);
1884 (void)to;
1885 if (sign) {
1886 if (to <= 32) {
1887 ASM(SBFXw, dst, src, 0, from);
1888 } else {
1889 ASM(SBFXx, dst, src, 0, from);
1890 }
1891 } else {
1892 if (to <= 32) {
1893 ASM(UBFXw, dst, src, 0, from);
1894 } else {
1895 ASM(UBFXx, dst, src, 0, from);
1896 }
1897 }
1898}
1899
1900template <IRAdaptor Adaptor,
1901 typename Derived,
1902 template <typename, typename, typename> typename BaseTy,
1903 typename Config>
1905 std::variant<SymRef, ValuePart> &&target,
1906 std::span<CallArg> arguments,
1907 typename Base::ValueRef *result,
1908 bool) {
1909 CCAssignerAAPCS assigner;
1910 CallBuilder cb{*derived(), assigner};
1911 for (auto &arg : arguments) {
1912 cb.add_arg(std::move(arg));
1913 }
1914 cb.call(std::move(target));
1915 if (result) {
1916 cb.add_ret(*result);
1917 }
1918}
1919
1920template <IRAdaptor Adaptor,
1921 typename Derived,
1922 template <typename, typename, typename> typename BaseTy,
1923 typename Config>
1924void CompilerA64<Adaptor, Derived, BaseTy, Config>::switch_emit_cmp(
1925 AsmReg cmp_reg, AsmReg tmp_reg, u64 case_value, bool width_is_32) {
1926 if (width_is_32) {
1927 if (!ASMIF(CMPwi, cmp_reg, case_value)) {
1928 materialize_constant(case_value, Config::GP_BANK, 4, tmp_reg);
1929 ASM(CMPw, cmp_reg, tmp_reg);
1930 }
1931 } else {
1932 if (!ASMIF(CMPxi, cmp_reg, case_value)) {
1933 materialize_constant(case_value, Config::GP_BANK, 4, tmp_reg);
1934 ASM(CMPx, cmp_reg, tmp_reg);
1935 }
1936 }
1937}
1938
1939template <IRAdaptor Adaptor,
1940 typename Derived,
1941 template <typename, typename, typename> typename BaseTy,
1942 typename Config>
1943void CompilerA64<Adaptor, Derived, BaseTy, Config>::switch_emit_cmpeq(
1944 Label case_label,
1945 AsmReg cmp_reg,
1946 AsmReg tmp_reg,
1947 u64 case_value,
1948 bool width_is_32) {
1949 switch_emit_cmp(cmp_reg, tmp_reg, case_value, width_is_32);
1950 generate_raw_jump(Jump::Jeq, case_label);
1951}
1952
1953template <IRAdaptor Adaptor,
1954 typename Derived,
1955 template <typename, typename, typename> typename BaseTy,
1956 typename Config>
1957FunctionWriterBase::JumpTable *
1958 CompilerA64<Adaptor, Derived, BaseTy, Config>::switch_create_jump_table(
1959 Label default_label,
1960 AsmReg cmp_reg,
1961 AsmReg tmp_reg,
1962 u64 low_bound,
1963 u64 high_bound,
1964 bool width_is_32) {
1965 if (low_bound > 0) {
1966 if (width_is_32) {
1967 if (!ASMIF(SUBwi, cmp_reg, cmp_reg, low_bound)) {
1968 materialize_constant(low_bound, Config::GP_BANK, 4, tmp_reg);
1969 ASM(SUBw, cmp_reg, cmp_reg, tmp_reg);
1970 }
1971 } else {
1972 if (!ASMIF(SUBxi, cmp_reg, cmp_reg, low_bound)) {
1973 materialize_constant(low_bound, Config::GP_BANK, 4, tmp_reg);
1974 ASM(SUBx, cmp_reg, cmp_reg, tmp_reg);
1975 }
1976 }
1977 }
1978 switch_emit_cmp(cmp_reg, tmp_reg, high_bound - low_bound, width_is_32);
1979 generate_raw_jump(Jump::Jhi, default_label);
1980
1981 u64 range = high_bound - low_bound + 1;
1982 return &this->text_writer.create_jump_table(
1983 range, cmp_reg, tmp_reg, width_is_32);
1984}
1985
1986template <IRAdaptor Adaptor,
1987 typename Derived,
1988 template <typename, typename, typename> typename BaseTy,
1989 typename Config>
1990void CompilerA64<Adaptor, Derived, BaseTy, Config>::switch_emit_binary_step(
1991 Label case_label,
1992 Label gt_label,
1993 AsmReg cmp_reg,
1994 AsmReg tmp_reg,
1995 u64 case_value,
1996 bool width_is_32) {
1997 switch_emit_cmpeq(case_label, cmp_reg, tmp_reg, case_value, width_is_32);
1998 generate_raw_jump(Jump::Jhi, gt_label);
1999}
2000
2001template <IRAdaptor Adaptor,
2002 typename Derived,
2003 template <typename, typename, typename> typename BaseTy,
2004 typename Config>
2005CompilerA64<Adaptor, Derived, BaseTy, Config>::ScratchReg
2007 SymRef sym, TLSModel model) {
2008 switch (model) {
2009 default: // TODO: implement optimized access for non-gd-model
2010 case TLSModel::GlobalDynamic: {
2011 assert(!this->stack.is_leaf_function);
2012 this->stack.generated_call = true;
2013 ScratchReg r0_scratch{this};
2014 AsmReg r0 = r0_scratch.alloc_specific(AsmReg::R0);
2015 ScratchReg r1_scratch{this};
2016 AsmReg r1 = r1_scratch.alloc_specific(AsmReg::R1);
2017 // The call only clobbers flags, x0, x1, and lr. x0 and x1 are already fixed
2018 // in the scratch registers, so only make sure that lr isn't used otherwise.
2019 if (this->register_file.is_used(Reg{AsmReg::LR})) {
2020 this->evict_reg(Reg{AsmReg::LR});
2021 }
2022
2023 this->text_writer.ensure_space(0x18);
2024 this->reloc_text(
2025 sym, elf::R_AARCH64_TLSDESC_ADR_PAGE21, this->text_writer.offset(), 0);
2026 ASMNC(ADRP, r0, 0, 0);
2027 this->reloc_text(
2028 sym, elf::R_AARCH64_TLSDESC_LD64_LO12, this->text_writer.offset(), 0);
2029 ASMNC(LDRxu, r1, r0, 0);
2030 this->reloc_text(
2031 sym, elf::R_AARCH64_TLSDESC_ADD_LO12, this->text_writer.offset(), 0);
2032 ASMNC(ADDxi, r0, r0, 0);
2033 this->reloc_text(
2034 sym, elf::R_AARCH64_TLSDESC_CALL, this->text_writer.offset(), 0);
2035 ASMNC(BLR, r1);
2036 ASMNC(MRS, r1, 0xde82); // TPIDR_EL0
2037 // TODO: maybe return expr x0+x1.
2038 ASMNC(ADDx, r0, r1, r0);
2039 return r0_scratch;
2040 }
2041 }
2042}
2043
2044} // namespace tpde::a64
Assembler base class.
@ LOCAL
Symbol with local linkage, must be defined.
Helper class to write function text.
AArch64 AAPCS calling convention.
Helper class for building call sequences.
CallBuilder(Derived &compiler, CCAssigner &assigner)
Constructor.
Helper class to write function text for AArch64.
The IRAdaptor specifies the interface with which the IR-independent parts of the compiler interact wi...
Definition IRAdaptor.hpp:91
constexpr Jump(Kind kind, AsmReg cmp_reg, bool cmp_is_32)
Cbz/Cbnz branch.
@ Tbnz
Test single bit and branch if not zero (Xn register)
@ jmp
Unconditional jump.
@ Jge
Signed greater than or equal (N == V)
@ Jls
Unsigned lower or same (!(C == 1 && Z == 0))
@ Jhi
Unsigned higher (C == 1 && Z == 0)
@ Tbz
Test single bit and branch if zero (Xn register)
@ Jmi
Minus, negative (N == 1)
@ Jlo
Unsigned lower (C == 0)
@ Jlt
Signed less than (N != V)
@ Jgt
Signed greater than (Z == 0 && N == V)
@ Jhs
Unsigned higher or same (C == 1)
@ Jvc
No Overflow (V == 0)
@ Cbnz
Compare and branch if not zero (Wn or Xn register)
@ Jle
Signed lessthan or equal (!(Z == 0 && N == V))
@ Jcc
Carry clear (C == 0)
@ Jpl
Plus, positive or zero (N == 0)
@ Cbz
Compare and branch if zero (Wn or Xn register)
constexpr Jump(Kind kind, AsmReg cmp_reg, u8 test_bit)
Tbz/Tbnz branch.
constexpr Jump(Kind kind)
Unconditional or conditional branch based on flags.
constexpr Jump()
Unconditional branch.
Compiler mixin for targeting AArch64.
u32 func_arg_stack_add_off
Offset to the add sp, sp, XXX instruction that the argument handling uses to access stack arguments i...
void alloca_fixed(u64 size, u32 align, ValuePart &res)
Dynamic alloca of a fixed-size region.
void generate_raw_bfiz(AsmReg dst, AsmReg src, u32 lsb, u32 width)
Bitfield insert in zero. src is not modified.
void generate_raw_intext(AsmReg dst, AsmReg src, bool sign, u32 from, u32 to)
Integer extension. src is not modified.
AsmReg permanent_scratch_reg
Permanent scratch register, e.g.
std::optional< i32 > prologue_assign_arg_part(ValuePart &&vp, CCAssignment cca)
Assign argument part.
void load_off(AsmReg dst, AsmReg base, u32 off, u32 size, bool sext=false)
Load from an base+offset into register, using permanent_scratch_reg for large offsets.
void generate_raw_mask(Jump cc, AsmReg dst)
Set all bits of dst to 1 if cc is true, otherwise set dst to zero.
void generate_raw_bfi(AsmReg dst, AsmReg src, u32 lsb, u32 width)
Bitfield insert. src is not modified.
void generate_call(std::variant< SymRef, ValuePart > &&target, std::span< CallArg > arguments, typename Base::ValueRef *result, bool variable_args=false)
Generate a function call.
void generate_raw_jump(Jump jmp, Label target)
Generate jump instruction to target label.
void materialize_constant(const u64 *data, RegBank bank, u32 size, AsmReg dst)
Materialize constant into a register.
void generate_raw_set(Jump cc, AsmReg dst)
Set dst to 1 if cc is true, otherwise set it to zero.
Da64Cond jump_to_cond(Jump jmp)
Convert jump condition to disarms Da64Cond.
void prologue_begin(CCAssigner *cc_assigner)
Begin prologue, prepare for assigning arguments.
void generate_raw_select(Jump cc, AsmReg dst, AsmReg true_select, AsmReg false_select, bool is_64)
Moves true_select into dst if cc is true, otherwise move false_select into dst.
ScratchReg tls_get_addr(SymRef sym, TLSModel model)
Generate code sequence to load address of sym into a register.
void store_off(AsmReg base, u32 off, AsmReg src, u32 size)
Store a register to base+offset, using permanent_scratch_reg for large offsets.
void prologue_end(CCAssigner *cc_assigner)
Finish prologue.
void alloca_dynamic(u64 elem_size, ValuePart &&count, u32 align, ValuePart &res)
Dynamic alloca of a dynamically-sized region (elem_size * count bytes).
void materialize_constant(u64 const_u64, RegBank bank, u32 size, AsmReg dst)
Materialize constant into a register.