forked from Shopify/ruby
-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathmod.rs
More file actions
1960 lines (1694 loc) · 74.3 KB
/
mod.rs
File metadata and controls
1960 lines (1694 loc) · 74.3 KB
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
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
use std::mem;
use crate::asm::*;
use crate::asm::x86_64::*;
use crate::codegen::split_patch_point;
use crate::stats::CompileError;
use crate::virtualmem::CodePtr;
use crate::cruby::*;
use crate::backend::lir::*;
use crate::cast::*;
use crate::options::asm_dump;
// Use the x86 register type for this platform
pub type Reg = X86Reg;
/// Convert reg_no for MemBase::Reg into Reg, assuming it's a 64-bit GP register
pub fn mem_base_reg(reg_no: u8) -> Reg {
Reg { num_bits: 64, reg_type: RegType::GP, reg_no }
}
// Callee-saved registers
pub const CFP: Opnd = Opnd::Reg(R13_REG);
pub const EC: Opnd = Opnd::Reg(R12_REG);
pub const SP: Opnd = Opnd::Reg(RBX_REG);
// C argument registers on this platform
pub const C_ARG_OPNDS: [Opnd; 6] = [
Opnd::Reg(RDI_REG),
Opnd::Reg(RSI_REG),
Opnd::Reg(RDX_REG),
Opnd::Reg(RCX_REG),
Opnd::Reg(R8_REG),
Opnd::Reg(R9_REG)
];
// C return value register on this platform
pub const C_RET_REG: Reg = RAX_REG;
pub const C_RET_OPND: Opnd = Opnd::Reg(RAX_REG);
pub const NATIVE_STACK_PTR: Opnd = Opnd::Reg(RSP_REG);
pub const NATIVE_BASE_PTR: Opnd = Opnd::Reg(RBP_REG);
impl CodeBlock {
// The number of bytes that are generated by jmp_ptr
pub fn jmp_ptr_bytes(&self) -> usize { 5 }
}
/// Map Opnd to X86Opnd
impl From<Opnd> for X86Opnd {
fn from(opnd: Opnd) -> Self {
match opnd {
// NOTE: these operand types need to be lowered first
//Value(VALUE), // Immediate Ruby value, may be GC'd, movable
//VReg(usize), // Output of a preceding instruction in this block
Opnd::VReg{..} => panic!("VReg operand made it past register allocation"),
Opnd::UImm(val) => uimm_opnd(val),
Opnd::Imm(val) => imm_opnd(val),
Opnd::Value(VALUE(uimm)) => uimm_opnd(uimm as u64),
// General-purpose register
Opnd::Reg(reg) => X86Opnd::Reg(reg),
// Memory operand with displacement
Opnd::Mem(Mem{ base: MemBase::Reg(reg_no), num_bits, disp }) => {
let reg = X86Reg {
reg_no,
num_bits: 64,
reg_type: RegType::GP
};
mem_opnd(num_bits, X86Opnd::Reg(reg), disp)
}
Opnd::None => panic!(
"Attempted to lower an Opnd::None. This often happens when an out operand was not allocated for an instruction because the output of the instruction was not used. Please ensure you are using the output."
),
_ => panic!("unsupported x86 operand type: {opnd:?}")
}
}
}
/// Also implement going from a reference to an operand for convenience.
impl From<&Opnd> for X86Opnd {
fn from(opnd: &Opnd) -> Self {
X86Opnd::from(*opnd)
}
}
/// List of registers that can be used for register allocation.
/// This has the same number of registers for x86_64 and arm64.
/// SCRATCH0_OPND is excluded.
pub const ALLOC_REGS: &[Reg] = &[
RDI_REG,
RSI_REG,
RDX_REG,
RCX_REG,
R8_REG,
R9_REG,
RAX_REG,
];
/// Special scratch register for intermediate processing. It should be used only by
/// [`Assembler::x86_scratch_split`] or [`Assembler::new_with_scratch_reg`].
const SCRATCH0_OPND: Opnd = Opnd::Reg(R11_REG);
const SCRATCH1_OPND: Opnd = Opnd::Reg(R10_REG);
impl Assembler {
/// Return an Assembler with scratch registers disabled in the backend, and a scratch register.
pub fn new_with_scratch_reg() -> (Self, Opnd) {
(Self::new_with_accept_scratch_reg(true), SCRATCH0_OPND)
}
/// Return true if opnd contains a scratch reg
pub fn has_scratch_reg(opnd: Opnd) -> bool {
Self::has_reg(opnd, SCRATCH0_OPND.unwrap_reg())
}
/// Get the list of registers from which we can allocate on this platform
pub fn get_alloc_regs() -> Vec<Reg> {
ALLOC_REGS.to_vec()
}
/// Get a list of all of the caller-save registers
pub fn get_caller_save_regs() -> Vec<Reg> {
vec![RAX_REG, RCX_REG, RDX_REG, RSI_REG, RDI_REG, R8_REG, R9_REG, R10_REG, R11_REG]
}
/// How many bytes a call and a bare bones [Self::frame_setup] would change native SP
pub fn frame_size() -> i32 {
0x10
}
// These are the callee-saved registers in the x86-64 SysV ABI
// RBX, RSP, RBP, and R12–R15
/// Split IR instructions for the x86 platform
fn x86_split(mut self) -> Assembler
{
let mut asm_local = Assembler::new_with_asm(&self);
let asm = &mut asm_local;
let live_ranges = self.compute_live_ranges();
let mut iterator = self.instruction_iterator();
while let Some((index, mut insn)) = iterator.next(asm) {
let is_load = matches!(insn, Insn::Load { .. } | Insn::LoadInto { .. });
let mut opnd_iter = insn.opnd_iter_mut();
while let Some(opnd) = opnd_iter.next() {
// Lower Opnd::Value to Opnd::VReg or Opnd::UImm
match opnd {
Opnd::Value(value) if !is_load => {
// Since mov(mem64, imm32) sign extends, as_i64() makes sure
// we split when the extended value is different.
*opnd = if !value.special_const_p() || imm_num_bits(value.as_i64()) > 32 {
asm.load(*opnd)
} else {
Opnd::UImm(value.as_u64())
}
}
_ => {},
};
}
// When we split an operand, we can create a new VReg not in `live_ranges`.
// So when we see a VReg with out-of-range index, it's created from splitting
// from the loop above and we know it doesn't outlive the current instruction.
let vreg_outlives_insn = |vreg_idx: VRegId| {
live_ranges
.get(vreg_idx)
.is_some_and(|live_range: &LiveRange| live_range.end() > index)
};
// We are replacing instructions here so we know they are already
// being used. It is okay not to use their output here.
#[allow(unused_must_use)]
match &mut insn {
Insn::Add { left, right, out } |
Insn::Sub { left, right, out } |
Insn::Mul { left, right, out } |
Insn::And { left, right, out } |
Insn::Or { left, right, out } |
Insn::Xor { left, right, out } => {
match (&left, &right, iterator.peek().map(|(_, insn)| insn)) {
// Merge this insn, e.g. `add REG, right -> out`, and `mov REG, out` if possible
(Opnd::Reg(_), Opnd::UImm(value), Some(Insn::Mov { dest, src }))
if out == src && left == dest && live_ranges[out.vreg_idx()].end() == index + 1 && uimm_num_bits(*value) <= 32 => {
*out = *dest;
asm.push_insn(insn);
iterator.next(asm); // Pop merged Insn::Mov
}
(Opnd::Reg(_), Opnd::Reg(_), Some(Insn::Mov { dest, src }))
if out == src && live_ranges[out.vreg_idx()].end() == index + 1 && *dest == *left => {
*out = *dest;
asm.push_insn(insn);
iterator.next(asm); // Pop merged Insn::Mov
}
_ => {
match (*left, *right) {
(Opnd::Mem(_), Opnd::Mem(_)) => {
*left = asm.load(*left);
*right = asm.load(*right);
},
(Opnd::Mem(_), Opnd::UImm(_) | Opnd::Imm(_)) => {
*left = asm.load(*left);
},
// Instruction output whose live range spans beyond this instruction
(Opnd::VReg { idx, .. }, _) => {
if vreg_outlives_insn(idx) {
*left = asm.load(*left);
}
},
// We have to load memory operands to avoid corrupting them
(Opnd::Mem(_), _) => {
*left = asm.load(*left);
},
// We have to load register operands to avoid corrupting them
(Opnd::Reg(_), _) => {
if *left != *out {
*left = asm.load(*left);
}
},
// The first operand can't be an immediate value
(Opnd::UImm(_), _) => {
*left = asm.load(*left);
}
_ => {}
}
asm.push_insn(insn);
}
}
},
Insn::Cmp { left, right } => {
// Replace `cmp REG, 0` (4 bytes) with `test REG, REG` (3 bytes)
// when next IR is `je`, `jne`, `csel_e`, or `csel_ne`
match (&left, &right, iterator.peek().map(|(_, insn)| insn)) {
(Opnd::VReg { .. },
Opnd::UImm(0) | Opnd::Imm(0),
Some(Insn::Je(_) | Insn::Jne(_) | Insn::CSelE { .. } | Insn::CSelNE { .. })) => {
asm.push_insn(Insn::Test { left: *left, right: *left });
}
_ => {
// Split the instruction if `cmp` can't be encoded with given operands
match (&left, &right) {
// One of the operands should not be a memory operand
(Opnd::Mem(_), Opnd::Mem(_)) => {
*right = asm.load(*right);
}
// The left operand needs to be either a register or a memory operand
(Opnd::UImm(_) | Opnd::Imm(_), _) => {
*left = asm.load(*left);
}
_ => {},
}
asm.push_insn(insn);
}
}
},
Insn::Test { left, right } => {
match (&left, &right) {
(Opnd::Mem(_), Opnd::Mem(_)) => {
*right = asm.load(*right);
}
// The first operand can't be an immediate value
(Opnd::UImm(_) | Opnd::Imm(_), _) => {
*left = asm.load(*left);
}
_ => {}
}
asm.push_insn(insn);
},
// These instructions modify their input operand in-place, so we
// may need to load the input value to preserve it
Insn::LShift { opnd, .. } |
Insn::RShift { opnd, .. } |
Insn::URShift { opnd, .. } => {
match opnd {
// Instruction output whose live range spans beyond this instruction
Opnd::VReg { idx, .. } => {
if vreg_outlives_insn(*idx) {
*opnd = asm.load(*opnd);
}
},
// We have to load non-reg operands to avoid corrupting them
Opnd::Mem(_) | Opnd::Reg(_) | Opnd::UImm(_) | Opnd::Imm(_) => {
*opnd = asm.load(*opnd);
},
_ => {}
}
asm.push_insn(insn);
},
Insn::CSelZ { truthy, falsy, .. } |
Insn::CSelNZ { truthy, falsy, .. } |
Insn::CSelE { truthy, falsy, .. } |
Insn::CSelNE { truthy, falsy, .. } |
Insn::CSelL { truthy, falsy, .. } |
Insn::CSelLE { truthy, falsy, .. } |
Insn::CSelG { truthy, falsy, .. } |
Insn::CSelGE { truthy, falsy, .. } => {
match *truthy {
// If we have an instruction output whose live range
// spans beyond this instruction, we have to load it.
Opnd::VReg { idx, .. } => {
if vreg_outlives_insn(idx) {
*truthy = asm.load(*truthy);
}
},
Opnd::UImm(_) | Opnd::Imm(_) => {
*truthy = asm.load(*truthy);
},
// Opnd::Value could have already been split
Opnd::Value(_) if !matches!(truthy, Opnd::VReg { .. }) => {
*truthy = asm.load(*truthy);
},
_ => {}
}
match falsy {
Opnd::UImm(_) | Opnd::Imm(_) => {
*falsy = asm.load(*falsy);
},
_ => {}
}
asm.push_insn(insn);
},
Insn::Mov { dest, src } => {
if let Opnd::Mem(_) = dest {
asm.store(*dest, *src);
} else {
asm.mov(*dest, *src);
}
},
Insn::Not { opnd, .. } => {
match *opnd {
// If we have an instruction output whose live range
// spans beyond this instruction, we have to load it.
Opnd::VReg { idx, .. } => {
if vreg_outlives_insn(idx) {
*opnd = asm.load(*opnd);
}
},
// We have to load memory and register operands to avoid
// corrupting them.
Opnd::Mem(_) | Opnd::Reg(_) => {
*opnd = asm.load(*opnd);
},
// Otherwise we can just reuse the existing operand.
_ => {},
};
asm.push_insn(insn);
},
Insn::CCall { opnds, .. } => {
assert!(opnds.len() <= C_ARG_OPNDS.len());
// Load each operand into the corresponding argument register.
if !opnds.is_empty() {
let mut args: Vec<(Opnd, Opnd)> = vec![];
for (idx, opnd) in opnds.iter_mut().enumerate() {
args.push((C_ARG_OPNDS[idx], *opnd));
}
asm.parallel_mov(args);
}
// Now we push the CCall without any arguments so that it
// just performs the call.
*opnds = vec![];
asm.push_insn(insn);
},
Insn::Lea { .. } => {
// Merge `lea` and `mov` into a single `lea` when possible
match (&insn, iterator.peek().map(|(_, insn)| insn)) {
(Insn::Lea { opnd, out }, Some(Insn::Mov { dest: Opnd::Reg(reg), src }))
if matches!(out, Opnd::VReg { .. }) && out == src && live_ranges[out.vreg_idx()].end() == index + 1 => {
asm.push_insn(Insn::Lea { opnd: *opnd, out: Opnd::Reg(*reg) });
iterator.next(asm); // Pop merged Insn::Mov
}
_ => asm.push_insn(insn),
}
},
_ => {
asm.push_insn(insn);
}
}
}
asm_local
}
/// Split instructions using scratch registers. To maximize the use of the register pool
/// for VRegs, most splits should happen in [`Self::x86_split`]. However, some instructions
/// need to be split with registers after `alloc_regs`, e.g. for `compile_exits`, so
/// this splits them and uses scratch registers for it.
pub fn x86_scratch_split(self) -> Assembler {
/// For some instructions, we want to be able to lower a 64-bit operand
/// without requiring more registers to be available in the register
/// allocator. So we just use the SCRATCH0_OPND register temporarily to hold
/// the value before we immediately use it.
fn split_64bit_immediate(asm: &mut Assembler, opnd: Opnd, scratch_opnd: Opnd) -> Opnd {
match opnd {
Opnd::Imm(value) => {
// 32-bit values will be sign-extended
if imm_num_bits(value) > 32 {
asm.mov(scratch_opnd, opnd);
scratch_opnd
} else {
opnd
}
},
Opnd::UImm(value) => {
// 32-bit values will be sign-extended
if imm_num_bits(value as i64) > 32 {
asm.mov(scratch_opnd, opnd);
scratch_opnd
} else {
Opnd::Imm(value as i64)
}
},
_ => opnd
}
}
/// If a given operand is Opnd::Mem and it uses MemBase::Stack, lower it to MemBase::Reg using a scratch register.
fn split_stack_membase(asm: &mut Assembler, opnd: Opnd, scratch_opnd: Opnd, stack_state: &StackState) -> Opnd {
if let Opnd::Mem(Mem { base: stack_membase @ MemBase::Stack { .. }, disp, num_bits }) = opnd {
let base = Opnd::Mem(stack_state.stack_membase_to_mem(stack_membase));
asm.load_into(scratch_opnd, base);
Opnd::Mem(Mem { base: MemBase::Reg(scratch_opnd.unwrap_reg().reg_no), disp, num_bits })
} else {
opnd
}
}
/// If opnd is Opnd::Mem, set scratch_reg to *opnd. Return Some(Opnd::Mem) if it needs to be written back from scratch_reg.
fn split_memory_write(opnd: &mut Opnd, scratch_opnd: Opnd) -> Option<Opnd> {
if let Opnd::Mem(_) = opnd {
let mem_opnd = opnd.clone();
*opnd = opnd.num_bits().map(|num_bits| scratch_opnd.with_num_bits(num_bits)).unwrap_or(scratch_opnd);
Some(mem_opnd)
} else {
None
}
}
/// If both opnd and other are Opnd::Mem, split opnd with scratch_opnd.
fn split_if_both_memory(asm: &mut Assembler, opnd: Opnd, other: Opnd, scratch_opnd: Opnd) -> Opnd {
if let (Opnd::Mem(_), Opnd::Mem(_)) = (opnd, other) {
asm.load_into(scratch_opnd.with_num_bits(opnd.rm_num_bits()), opnd);
scratch_opnd.with_num_bits(opnd.rm_num_bits())
} else {
opnd
}
}
/// Move src to dst, splitting it with scratch_opnd if it's a Mem-to-Mem move. Skip it if dst == src.
fn asm_mov(asm: &mut Assembler, dst: Opnd, src: Opnd, scratch_opnd: Opnd) {
if dst != src {
if let (Opnd::Mem(_), Opnd::Mem(_)) = (dst, src) {
asm.mov(scratch_opnd, src);
asm.mov(dst, scratch_opnd);
} else {
asm.mov(dst, src);
}
}
}
// Prepare StackState to lower MemBase::Stack
let stack_state = StackState::new(self.stack_base_idx);
let mut asm_local = Assembler::new();
asm_local.accept_scratch_reg = true;
asm_local.stack_base_idx = self.stack_base_idx;
asm_local.label_names = self.label_names.clone();
asm_local.live_ranges = LiveRanges::new(self.live_ranges.len());
// Create one giant block to linearize everything into
asm_local.new_block_without_id();
let asm = &mut asm_local;
// Get linearized instructions with branch parameters expanded into ParallelMov
let linearized_insns = self.linearize_instructions();
for insn in linearized_insns.iter() {
let mut insn = insn.clone();
match &mut insn {
Insn::Add { left, right, out } |
Insn::Sub { left, right, out } |
Insn::And { left, right, out } |
Insn::Or { left, right, out } |
Insn::Xor { left, right, out } => {
*left = split_stack_membase(asm, *left, SCRATCH0_OPND, &stack_state);
*left = split_if_both_memory(asm, *left, *right, SCRATCH0_OPND);
*right = split_stack_membase(asm, *right, SCRATCH1_OPND, &stack_state);
*right = split_64bit_immediate(asm, *right, SCRATCH1_OPND);
let (out, left) = (*out, *left);
asm.push_insn(insn);
asm_mov(asm, out, left, SCRATCH0_OPND);
}
Insn::Mul { left, right, out } => {
*left = split_stack_membase(asm, *left, SCRATCH0_OPND, &stack_state);
*left = split_if_both_memory(asm, *left, *right, SCRATCH0_OPND);
*right = split_stack_membase(asm, *right, SCRATCH1_OPND, &stack_state);
*right = split_64bit_immediate(asm, *right, SCRATCH1_OPND);
// imul doesn't have (Mem, Reg) encoding. Swap left and right in that case.
if let (Opnd::Mem(_), Opnd::Reg(_)) = (&left, &right) {
mem::swap(left, right);
}
let (out, left) = (*out, *left);
asm.push_insn(insn);
asm_mov(asm, out, left, SCRATCH0_OPND);
}
&mut Insn::Not { opnd, out } |
&mut Insn::LShift { opnd, out, .. } |
&mut Insn::RShift { opnd, out, .. } |
&mut Insn::URShift { opnd, out, .. } => {
asm.push_insn(insn);
asm_mov(asm, out, opnd, SCRATCH0_OPND);
}
Insn::Test { left, right } |
Insn::Cmp { left, right } => {
*left = split_stack_membase(asm, *left, SCRATCH1_OPND, &stack_state);
*right = split_stack_membase(asm, *right, SCRATCH0_OPND, &stack_state);
*right = split_if_both_memory(asm, *right, *left, SCRATCH0_OPND);
let num_bits = match right {
Opnd::Imm(value) => Some(imm_num_bits(*value)),
Opnd::UImm(value) => Some(uimm_num_bits(*value)),
_ => None
};
// If the immediate is less than 64 bits (like 32, 16, 8), and the operand
// sizes match, then we can represent it as an immediate in the instruction
// without moving it to a register first.
// IOW, 64 bit immediates must always be moved to a register
// before comparisons, where other sizes may be encoded
// directly in the instruction.
let use_imm = num_bits.is_some() && left.num_bits() == num_bits && num_bits.unwrap() < 64;
if !use_imm {
*right = split_64bit_immediate(asm, *right, SCRATCH0_OPND);
}
asm.push_insn(insn);
}
// For compile_exits, support splitting simple C arguments here
Insn::CCall { opnds, .. } if !opnds.is_empty() => {
for (i, opnd) in opnds.iter().enumerate() {
asm.load_into(C_ARG_OPNDS[i], *opnd);
}
*opnds = vec![];
asm.push_insn(insn);
}
Insn::CSelZ { truthy: left, falsy: right, out } |
Insn::CSelNZ { truthy: left, falsy: right, out } |
Insn::CSelE { truthy: left, falsy: right, out } |
Insn::CSelNE { truthy: left, falsy: right, out } |
Insn::CSelL { truthy: left, falsy: right, out } |
Insn::CSelLE { truthy: left, falsy: right, out } |
Insn::CSelG { truthy: left, falsy: right, out } |
Insn::CSelGE { truthy: left, falsy: right, out } => {
*left = split_stack_membase(asm, *left, SCRATCH1_OPND, &stack_state);
*right = split_stack_membase(asm, *right, SCRATCH0_OPND, &stack_state);
*right = split_if_both_memory(asm, *right, *left, SCRATCH0_OPND);
let mem_out = split_memory_write(out, SCRATCH0_OPND);
asm.push_insn(insn);
if let Some(mem_out) = mem_out {
asm.store(mem_out, SCRATCH0_OPND);
}
}
Insn::Lea { opnd, out } => {
*opnd = split_stack_membase(asm, *opnd, SCRATCH0_OPND, &stack_state);
let mem_out = split_memory_write(out, SCRATCH0_OPND);
asm.push_insn(insn);
if let Some(mem_out) = mem_out {
asm.store(mem_out, SCRATCH0_OPND);
}
}
Insn::LeaJumpTarget { target, out } => {
if let Target::Label(_) = target {
asm.push_insn(Insn::LeaJumpTarget { out: SCRATCH0_OPND, target: target.clone() });
asm.mov(*out, SCRATCH0_OPND);
}
}
Insn::Load { out, opnd } |
Insn::LoadInto { dest: out, opnd } => {
*opnd = split_stack_membase(asm, *opnd, SCRATCH0_OPND, &stack_state);
let mem_out = split_memory_write(out, SCRATCH0_OPND);
asm.push_insn(insn);
if let Some(mem_out) = mem_out {
asm.store(mem_out, SCRATCH0_OPND.with_num_bits(mem_out.rm_num_bits()));
}
}
// Convert Opnd::const_ptr into Opnd::Mem. This split is done here to give
// a register for compile_exits.
&mut Insn::IncrCounter { mem, value } => {
assert!(matches!(mem, Opnd::UImm(_)));
asm.load_into(SCRATCH0_OPND, mem);
asm.incr_counter(Opnd::mem(64, SCRATCH0_OPND, 0), value);
}
&mut Insn::Mov { dest, src } => {
asm_mov(asm, dest, src, SCRATCH0_OPND);
}
// Resolve ParallelMov that couldn't be handled without a scratch register.
Insn::ParallelMov { moves } => {
for (dst, src) in Self::resolve_parallel_moves(&moves, Some(SCRATCH0_OPND)).unwrap() {
asm_mov(asm, dst, src, SCRATCH0_OPND);
}
}
// Handle various operand combinations for spills on compile_exits.
&mut Insn::Store { dest, src } => {
let num_bits = dest.rm_num_bits();
let dest = split_stack_membase(asm, dest, SCRATCH1_OPND, &stack_state);
let src = match src {
Opnd::Reg(_) => src,
Opnd::Mem(_) => {
asm.mov(SCRATCH0_OPND, src);
SCRATCH0_OPND
}
Opnd::Imm(imm) => {
// For 64 bit destinations, 32-bit values will be sign-extended
if num_bits == 64 && imm_num_bits(imm) > 32 {
asm.mov(SCRATCH0_OPND, src);
SCRATCH0_OPND
} else if uimm_num_bits(imm as u64) <= num_bits {
// If the bit string is short enough for the destination, use the unsigned representation.
// Note that 64-bit and negative values are ruled out.
Opnd::UImm(imm as u64)
} else {
src
}
}
Opnd::UImm(imm) => {
// For 64 bit destinations, 32-bit values will be sign-extended
if num_bits == 64 && imm_num_bits(imm as i64) > 32 {
asm.mov(SCRATCH0_OPND, src);
SCRATCH0_OPND
} else {
src.into()
}
}
Opnd::Value(_) => {
asm.load_into(SCRATCH0_OPND, src);
SCRATCH0_OPND
}
src @ (Opnd::None | Opnd::VReg { .. }) => panic!("Unexpected source operand during x86_scratch_split: {src:?}"),
};
asm.store(dest, src);
}
&mut Insn::PatchPoint { ref target, invariant, version } => {
split_patch_point(asm, target, invariant, version);
}
_ => {
asm.push_insn(insn);
}
}
}
asm_local
}
/// Emit platform-specific machine code
pub fn x86_emit(&mut self, cb: &mut CodeBlock) -> Option<Vec<CodePtr>> {
fn emit_csel(
cb: &mut CodeBlock,
truthy: Opnd,
falsy: Opnd,
out: Opnd,
cmov_fn: fn(&mut CodeBlock, X86Opnd, X86Opnd),
cmov_neg: fn(&mut CodeBlock, X86Opnd, X86Opnd)){
// Assert that output is a register
out.unwrap_reg();
// If the truthy value is a memory operand
if let Opnd::Mem(_) = truthy {
if out != falsy {
mov(cb, out.into(), falsy.into());
}
cmov_fn(cb, out.into(), truthy.into());
} else {
if out != truthy {
mov(cb, out.into(), truthy.into());
}
cmov_neg(cb, out.into(), falsy.into());
}
}
fn emit_load_gc_value(cb: &mut CodeBlock, gc_offsets: &mut Vec<CodePtr>, dest_reg: X86Opnd, value: VALUE) {
// Using movabs because mov might write value in 32 bits
movabs(cb, dest_reg, value.0 as _);
// The pointer immediate is encoded as the last part of the mov written out
let ptr_offset = cb.get_write_ptr().sub_bytes(SIZEOF_VALUE);
gc_offsets.push(ptr_offset);
}
// List of GC offsets
let mut gc_offsets: Vec<CodePtr> = Vec::new();
// Buffered list of PosMarker callbacks to fire if codegen is successful
let mut pos_markers: Vec<(usize, CodePtr)> = vec![];
// The write_pos for the last Insn::PatchPoint, if any
let mut last_patch_pos: Option<usize> = None;
// Install a panic hook to dump Assembler with insn_idx on dev builds
let (_hook, mut hook_insn_idx) = AssemblerPanicHook::new(self, 0);
// For each instruction
let mut insn_idx: usize = 0;
assert_eq!(self.basic_blocks.len(), 1, "Assembler should be linearized into a single block before arm64_emit");
let insns = &self.basic_blocks[0].insns;
while let Some(insn) = insns.get(insn_idx) {
// Update insn_idx that is shown on panic
hook_insn_idx.as_mut().map(|idx| idx.lock().map(|mut idx| *idx = insn_idx).unwrap());
match insn {
Insn::Comment(text) => {
cb.add_comment(text);
},
// Write the label at the current position
Insn::Label(target) => {
cb.write_label(target.unwrap_label());
},
// Report back the current position in the generated code
Insn::PosMarker(..) => {
pos_markers.push((insn_idx, cb.get_write_ptr()));
},
Insn::BakeString(text) => {
for byte in text.as_bytes() {
cb.write_byte(*byte);
}
// Add a null-terminator byte for safety (in case we pass
// this to C code)
cb.write_byte(0);
},
// Set up RBP as frame pointer work with unwinding
// (e.g. with Linux `perf record --call-graph fp`)
// and to allow push and pops in the function.
&Insn::FrameSetup { preserved, mut slot_count } => {
// Bump slot_count for alignment if necessary
const { assert!(SIZEOF_VALUE == 8, "alignment logic relies on SIZEOF_VALUE == 8"); }
let total_slots = 2 /* rbp and return address*/ + slot_count + preserved.len();
if total_slots % 2 == 1 {
slot_count += 1;
}
push(cb, RBP);
mov(cb, RBP, RSP);
for reg in preserved {
push(cb, reg.into());
}
if slot_count > 0 {
sub(cb, RSP, uimm_opnd((slot_count * SIZEOF_VALUE) as u64));
}
}
&Insn::FrameTeardown { preserved } => {
let mut preserved_offset = -8;
for reg in preserved {
mov(cb, reg.into(), mem_opnd(64, RBP, preserved_offset));
preserved_offset -= 8;
}
mov(cb, RSP, RBP);
pop(cb, RBP);
}
Insn::Add { left, right, .. } => {
add(cb, left.into(), right.into());
},
Insn::Sub { left, right, .. } => {
sub(cb, left.into(), right.into());
},
Insn::Mul { left, right, .. } => {
imul(cb, left.into(), right.into());
},
Insn::And { left, right, .. } => {
and(cb, left.into(), right.into());
},
Insn::Or { left, right, .. } => {
or(cb, left.into(), right.into());
},
Insn::Xor { left, right, .. } => {
xor(cb, left.into(), right.into());
},
Insn::Not { opnd, .. } => {
not(cb, opnd.into());
},
Insn::LShift { opnd, shift , ..} => {
shl(cb, opnd.into(), shift.into())
},
Insn::RShift { opnd, shift , ..} => {
sar(cb, opnd.into(), shift.into())
},
Insn::URShift { opnd, shift, .. } => {
shr(cb, opnd.into(), shift.into())
},
// This assumes only load instructions can contain references to GC'd Value operands
Insn::Load { opnd, out } |
Insn::LoadInto { dest: out, opnd } => {
match opnd {
Opnd::Value(val) if val.heap_object_p() => {
emit_load_gc_value(cb, &mut gc_offsets, out.into(), *val);
}
_ => mov(cb, out.into(), opnd.into())
}
},
Insn::LoadSExt { opnd, out } => {
movsx(cb, out.into(), opnd.into());
},
Insn::ParallelMov { .. } => unreachable!("{insn:?} should have been lowered at alloc_regs()"),
Insn::Store { dest, src } |
Insn::Mov { dest, src } => {
mov(cb, dest.into(), src.into());
},
// Load effective address
Insn::Lea { opnd, out } => {
lea(cb, out.into(), opnd.into());
},
// Load address of jump target
Insn::LeaJumpTarget { target, out } => {
if let Target::Label(label) = target {
let out = *out;
// Set output to the raw address of the label
cb.label_ref(*label, 7, move |cb, src_addr, dst_addr| {
let disp = dst_addr - src_addr;
lea(cb, out.into(), mem_opnd(8, RIP, disp.try_into().unwrap()));
Ok(())
});
} else {
// Set output to the jump target's raw address
let target_code = target.unwrap_code_ptr();
let target_addr = target_code.raw_addr(cb).as_u64();
// Constant encoded length important for patching
movabs(cb, out.into(), target_addr);
}
},
// Push and pop to/from the C stack
Insn::CPush(opnd) => {
push(cb, opnd.into());
},
Insn::CPushPair(opnd0, opnd1) => {
push(cb, opnd0.into());
push(cb, opnd1.into());
},
Insn::CPop { out } => {
pop(cb, out.into());
},
Insn::CPopInto(opnd) => {
pop(cb, opnd.into());
},
Insn::CPopPairInto(opnd0, opnd1) => {
pop(cb, opnd0.into());
pop(cb, opnd1.into());
},
// C function call
Insn::CCall { fptr, .. } => {
match fptr {
Opnd::UImm(fptr) => {
call_ptr(cb, RAX, *fptr as *const u8);
}
Opnd::Reg(_) => {
call(cb, fptr.into());
}
_ => unreachable!("unsupported ccall fptr: {fptr:?}")
}
},
Insn::CRet(opnd) => {
// TODO: bias allocation towards return register
if *opnd != Opnd::Reg(C_RET_REG) {
mov(cb, RAX, opnd.into());
}
ret(cb);
},
// Compare
Insn::Cmp { left, right } => {
cmp(cb, left.into(), right.into());
}
// Test and set flags
Insn::Test { left, right } => {
test(cb, left.into(), right.into());
}
Insn::JmpOpnd(opnd) => {
jmp_rm(cb, opnd.into());
}
// Conditional jump to a label
Insn::Jmp(target) => {
match *target {
Target::CodePtr(code_ptr) => jmp_ptr(cb, code_ptr),
Target::Label(label) => jmp_label(cb, label),
Target::Block(ref edge) => jmp_label(cb, self.block_label(edge.target)),
Target::SideExit { .. } => unreachable!("Target::SideExit should have been compiled by compile_exits"),
}
}
Insn::Je(target) => {
match *target {
Target::CodePtr(code_ptr) => je_ptr(cb, code_ptr),
Target::Label(label) => je_label(cb, label),
Target::Block(ref edge) => je_label(cb, self.block_label(edge.target)),
Target::SideExit { .. } => unreachable!("Target::SideExit should have been compiled by compile_exits"),
}
}
Insn::Jne(target) => {
match *target {
Target::CodePtr(code_ptr) => jne_ptr(cb, code_ptr),
Target::Label(label) => jne_label(cb, label),
Target::Block(ref edge) => jne_label(cb, self.block_label(edge.target)),
Target::SideExit { .. } => unreachable!("Target::SideExit should have been compiled by compile_exits"),
}
}
Insn::Jl(target) => {
match *target {
Target::CodePtr(code_ptr) => jl_ptr(cb, code_ptr),
Target::Label(label) => jl_label(cb, label),
Target::Block(ref edge) => jl_label(cb, self.block_label(edge.target)),
Target::SideExit { .. } => unreachable!("Target::SideExit should have been compiled by compile_exits"),
}
},
Insn::Jg(target) => {
match *target {
Target::CodePtr(code_ptr) => jg_ptr(cb, code_ptr),
Target::Label(label) => jg_label(cb, label),
Target::Block(ref edge) => jg_label(cb, self.block_label(edge.target)),
Target::SideExit { .. } => unreachable!("Target::SideExit should have been compiled by compile_exits"),
}
},
Insn::Jge(target) => {
match *target {
Target::CodePtr(code_ptr) => jge_ptr(cb, code_ptr),
Target::Label(label) => jge_label(cb, label),
Target::Block(ref edge) => jge_label(cb, self.block_label(edge.target)),
Target::SideExit { .. } => unreachable!("Target::SideExit should have been compiled by compile_exits"),
}
},
Insn::Jbe(target) => {
match *target {
Target::CodePtr(code_ptr) => jbe_ptr(cb, code_ptr),
Target::Label(label) => jbe_label(cb, label),
Target::Block(ref edge) => jbe_label(cb, self.block_label(edge.target)),
Target::SideExit { .. } => unreachable!("Target::SideExit should have been compiled by compile_exits"),
}
},
Insn::Jb(target) => {
match *target {
Target::CodePtr(code_ptr) => jb_ptr(cb, code_ptr),
Target::Label(label) => jb_label(cb, label),
Target::Block(ref edge) => jb_label(cb, self.block_label(edge.target)),
Target::SideExit { .. } => unreachable!("Target::SideExit should have been compiled by compile_exits"),
}
},
Insn::Jz(target) => {
match *target {
Target::CodePtr(code_ptr) => jz_ptr(cb, code_ptr),
Target::Label(label) => jz_label(cb, label),
Target::Block(ref edge) => jz_label(cb, self.block_label(edge.target)),
Target::SideExit { .. } => unreachable!("Target::SideExit should have been compiled by compile_exits"),
}
}
Insn::Jnz(target) => {