1 //! Codegen of `asm!` invocations.
7 use rustc_ast::ast::{InlineAsmOptions, InlineAsmTemplatePiece};
8 use rustc_middle::mir::InlineAsmOperand;
9 use rustc_span::Symbol;
10 use rustc_target::asm::*;
12 pub(crate) fn codegen_inline_asm<'tcx>(
13 fx: &mut FunctionCx<'_, '_, 'tcx>,
15 template: &[InlineAsmTemplatePiece],
16 operands: &[InlineAsmOperand<'tcx>],
17 options: InlineAsmOptions,
19 // FIXME add .eh_frame unwind info directives
21 if template[0] == InlineAsmTemplatePiece::String("int $$0x29".to_string()) {
22 let true_ = fx.bcx.ins().iconst(types::I32, 1);
23 fx.bcx.ins().trapnz(true_, TrapCode::User(1));
25 } else if template[0] == InlineAsmTemplatePiece::String("movq %rbx, ".to_string())
28 InlineAsmTemplatePiece::Placeholder { operand_idx: 0, modifier: Some('r'), span: _ }
30 && template[2] == InlineAsmTemplatePiece::String("\n".to_string())
31 && template[3] == InlineAsmTemplatePiece::String("cpuid".to_string())
32 && template[4] == InlineAsmTemplatePiece::String("\n".to_string())
33 && template[5] == InlineAsmTemplatePiece::String("xchgq %rbx, ".to_string())
36 InlineAsmTemplatePiece::Placeholder { operand_idx: 0, modifier: Some('r'), span: _ }
39 assert_eq!(operands.len(), 4);
40 let (leaf, eax_place) = match operands[1] {
41 InlineAsmOperand::InOut { reg, late: true, ref in_value, out_place } => {
44 InlineAsmRegOrRegClass::Reg(InlineAsmReg::X86(X86InlineAsmReg::ax))
47 crate::base::codegen_operand(fx, in_value).load_scalar(fx),
48 crate::base::codegen_place(fx, out_place.unwrap()),
53 let ebx_place = match operands[0] {
54 InlineAsmOperand::Out { reg, late: true, place } => {
57 InlineAsmRegOrRegClass::RegClass(InlineAsmRegClass::X86(
58 X86InlineAsmRegClass::reg
61 crate::base::codegen_place(fx, place.unwrap())
65 let (sub_leaf, ecx_place) = match operands[2] {
66 InlineAsmOperand::InOut { reg, late: true, ref in_value, out_place } => {
69 InlineAsmRegOrRegClass::Reg(InlineAsmReg::X86(X86InlineAsmReg::cx))
72 crate::base::codegen_operand(fx, in_value).load_scalar(fx),
73 crate::base::codegen_place(fx, out_place.unwrap()),
78 let edx_place = match operands[3] {
79 InlineAsmOperand::Out { reg, late: true, place } => {
82 InlineAsmRegOrRegClass::Reg(InlineAsmReg::X86(X86InlineAsmReg::dx))
84 crate::base::codegen_place(fx, place.unwrap())
89 let (eax, ebx, ecx, edx) = crate::intrinsics::codegen_cpuid_call(fx, leaf, sub_leaf);
91 eax_place.write_cvalue(fx, CValue::by_val(eax, fx.layout_of(fx.tcx.types.u32)));
92 ebx_place.write_cvalue(fx, CValue::by_val(ebx, fx.layout_of(fx.tcx.types.u32)));
93 ecx_place.write_cvalue(fx, CValue::by_val(ecx, fx.layout_of(fx.tcx.types.u32)));
94 edx_place.write_cvalue(fx, CValue::by_val(edx, fx.layout_of(fx.tcx.types.u32)));
96 } else if fx.tcx.symbol_name(fx.instance).name.starts_with("___chkstk") {
97 // ___chkstk, ___chkstk_ms and __alloca are only used on Windows
98 crate::trap::trap_unimplemented(fx, "Stack probes are not supported");
99 } else if fx.tcx.symbol_name(fx.instance).name == "__alloca" {
100 crate::trap::trap_unimplemented(fx, "Alloca is not supported");
103 let mut inputs = Vec::new();
104 let mut outputs = Vec::new();
106 let mut asm_gen = InlineAssemblyGenerator {
108 arch: fx.tcx.sess.asm_arch.unwrap(),
112 registers: Vec::new(),
113 stack_slots_clobber: Vec::new(),
114 stack_slots_input: Vec::new(),
115 stack_slots_output: Vec::new(),
116 stack_slot_size: Size::from_bytes(0),
118 asm_gen.allocate_registers();
119 asm_gen.allocate_stack_slots();
121 let inline_asm_index = fx.cx.inline_asm_index.get();
122 fx.cx.inline_asm_index.set(inline_asm_index + 1);
123 let asm_name = format!(
124 "__inline_asm_{}_n{}",
125 fx.cx.cgu_name.as_str().replace('.', "__").replace('-', "_"),
129 let generated_asm = asm_gen.generate_asm_wrapper(&asm_name);
130 fx.cx.global_asm.push_str(&generated_asm);
132 for (i, operand) in operands.iter().enumerate() {
134 InlineAsmOperand::In { reg: _, ref value } => {
136 asm_gen.stack_slots_input[i].unwrap(),
137 crate::base::codegen_operand(fx, value).load_scalar(fx),
140 InlineAsmOperand::Out { reg: _, late: _, place } => {
141 if let Some(place) = place {
143 asm_gen.stack_slots_output[i].unwrap(),
144 crate::base::codegen_place(fx, place),
148 InlineAsmOperand::InOut { reg: _, late: _, ref in_value, out_place } => {
150 asm_gen.stack_slots_input[i].unwrap(),
151 crate::base::codegen_operand(fx, in_value).load_scalar(fx),
153 if let Some(out_place) = out_place {
155 asm_gen.stack_slots_output[i].unwrap(),
156 crate::base::codegen_place(fx, out_place),
160 InlineAsmOperand::Const { value: _ } => todo!(),
161 InlineAsmOperand::SymFn { value: _ } => todo!(),
162 InlineAsmOperand::SymStatic { def_id: _ } => todo!(),
166 call_inline_asm(fx, &asm_name, asm_gen.stack_slot_size, inputs, outputs);
169 struct InlineAssemblyGenerator<'a, 'tcx> {
172 template: &'a [InlineAsmTemplatePiece],
173 operands: &'a [InlineAsmOperand<'tcx>],
174 options: InlineAsmOptions,
175 registers: Vec<Option<InlineAsmReg>>,
176 stack_slots_clobber: Vec<Option<Size>>,
177 stack_slots_input: Vec<Option<Size>>,
178 stack_slots_output: Vec<Option<Size>>,
179 stack_slot_size: Size,
182 impl<'tcx> InlineAssemblyGenerator<'_, 'tcx> {
183 fn allocate_registers(&mut self) {
184 let sess = self.tcx.sess;
185 let map = allocatable_registers(
187 |feature| sess.target_features.contains(&Symbol::intern(feature)),
190 let mut allocated = FxHashMap::<_, (bool, bool)>::default();
191 let mut regs = vec![None; self.operands.len()];
193 // Add explicit registers to the allocated set.
194 for (i, operand) in self.operands.iter().enumerate() {
196 InlineAsmOperand::In { reg: InlineAsmRegOrRegClass::Reg(reg), .. } => {
198 allocated.entry(reg).or_default().0 = true;
200 InlineAsmOperand::Out {
201 reg: InlineAsmRegOrRegClass::Reg(reg), late: true, ..
204 allocated.entry(reg).or_default().1 = true;
206 InlineAsmOperand::Out { reg: InlineAsmRegOrRegClass::Reg(reg), .. }
207 | InlineAsmOperand::InOut { reg: InlineAsmRegOrRegClass::Reg(reg), .. } => {
209 allocated.insert(reg, (true, true));
215 // Allocate out/inout/inlateout registers first because they are more constrained.
216 for (i, operand) in self.operands.iter().enumerate() {
218 InlineAsmOperand::Out {
219 reg: InlineAsmRegOrRegClass::RegClass(class),
223 | InlineAsmOperand::InOut {
224 reg: InlineAsmRegOrRegClass::RegClass(class), ..
226 let mut alloc_reg = None;
227 for ® in &map[&class] {
228 let mut used = false;
229 reg.overlapping_regs(|r| {
230 if allocated.contains_key(&r) {
236 alloc_reg = Some(reg);
241 let reg = alloc_reg.expect("cannot allocate registers");
243 allocated.insert(reg, (true, true));
249 // Allocate in/lateout.
250 for (i, operand) in self.operands.iter().enumerate() {
252 InlineAsmOperand::In { reg: InlineAsmRegOrRegClass::RegClass(class), .. } => {
253 let mut alloc_reg = None;
254 for ® in &map[&class] {
255 let mut used = false;
256 reg.overlapping_regs(|r| {
257 if allocated.get(&r).copied().unwrap_or_default().0 {
263 alloc_reg = Some(reg);
268 let reg = alloc_reg.expect("cannot allocate registers");
270 allocated.entry(reg).or_default().0 = true;
272 InlineAsmOperand::Out {
273 reg: InlineAsmRegOrRegClass::RegClass(class),
277 let mut alloc_reg = None;
278 for ® in &map[&class] {
279 let mut used = false;
280 reg.overlapping_regs(|r| {
281 if allocated.get(&r).copied().unwrap_or_default().1 {
287 alloc_reg = Some(reg);
292 let reg = alloc_reg.expect("cannot allocate registers");
294 allocated.entry(reg).or_default().1 = true;
300 self.registers = regs;
303 fn allocate_stack_slots(&mut self) {
304 let mut slot_size = Size::from_bytes(0);
305 let mut slots_clobber = vec![None; self.operands.len()];
306 let mut slots_input = vec![None; self.operands.len()];
307 let mut slots_output = vec![None; self.operands.len()];
309 let new_slot_fn = |slot_size: &mut Size, reg_class: InlineAsmRegClass| {
311 reg_class.supported_types(self.arch).iter().map(|(ty, _)| ty.size()).max().unwrap();
312 let align = rustc_target::abi::Align::from_bytes(reg_size.bytes()).unwrap();
313 let offset = slot_size.align_to(align);
314 *slot_size = offset + reg_size;
317 let mut new_slot = |x| new_slot_fn(&mut slot_size, x);
319 // Allocate stack slots for saving clobbered registers
320 let abi_clobber = InlineAsmClobberAbi::parse(
322 |feature| self.tcx.sess.target_features.contains(&Symbol::intern(feature)),
323 &self.tcx.sess.target,
328 for (i, reg) in self.registers.iter().enumerate().filter_map(|(i, r)| r.map(|r| (i, r))) {
329 let mut need_save = true;
330 // If the register overlaps with a register clobbered by function call, then
331 // we don't need to save it.
332 for r in abi_clobber {
333 r.overlapping_regs(|r| {
345 slots_clobber[i] = Some(new_slot(reg.reg_class()));
349 // Allocate stack slots for inout
350 for (i, operand) in self.operands.iter().enumerate() {
352 InlineAsmOperand::InOut { reg, out_place: Some(_), .. } => {
353 let slot = new_slot(reg.reg_class());
354 slots_input[i] = Some(slot);
355 slots_output[i] = Some(slot);
361 let slot_size_before_input = slot_size;
362 let mut new_slot = |x| new_slot_fn(&mut slot_size, x);
364 // Allocate stack slots for input
365 for (i, operand) in self.operands.iter().enumerate() {
367 InlineAsmOperand::In { reg, .. }
368 | InlineAsmOperand::InOut { reg, out_place: None, .. } => {
369 slots_input[i] = Some(new_slot(reg.reg_class()));
375 // Reset slot size to before input so that input and output operands can overlap
376 // and save some memory.
377 let slot_size_after_input = slot_size;
378 slot_size = slot_size_before_input;
379 let mut new_slot = |x| new_slot_fn(&mut slot_size, x);
381 // Allocate stack slots for output
382 for (i, operand) in self.operands.iter().enumerate() {
384 InlineAsmOperand::Out { reg, place: Some(_), .. } => {
385 slots_output[i] = Some(new_slot(reg.reg_class()));
391 slot_size = slot_size.max(slot_size_after_input);
393 self.stack_slots_clobber = slots_clobber;
394 self.stack_slots_input = slots_input;
395 self.stack_slots_output = slots_output;
396 self.stack_slot_size = slot_size;
399 fn generate_asm_wrapper(&self, asm_name: &str) -> String {
400 let mut generated_asm = String::new();
401 writeln!(generated_asm, ".globl {}", asm_name).unwrap();
402 writeln!(generated_asm, ".type {},@function", asm_name).unwrap();
403 writeln!(generated_asm, ".section .text.{},\"ax\",@progbits", asm_name).unwrap();
404 writeln!(generated_asm, "{}:", asm_name).unwrap();
406 let is_x86 = matches!(self.arch, InlineAsmArch::X86 | InlineAsmArch::X86_64);
409 generated_asm.push_str(".intel_syntax noprefix\n");
411 Self::prologue(&mut generated_asm, self.arch);
413 // Save clobbered registers
414 if !self.options.contains(InlineAsmOptions::NORETURN) {
415 for (reg, slot) in self
418 .zip(self.stack_slots_clobber.iter().copied())
419 .filter_map(|(r, s)| r.zip(s))
421 Self::save_register(&mut generated_asm, self.arch, reg, slot);
425 // Write input registers
426 for (reg, slot) in self
429 .zip(self.stack_slots_input.iter().copied())
430 .filter_map(|(r, s)| r.zip(s))
432 Self::restore_register(&mut generated_asm, self.arch, reg, slot);
435 if is_x86 && self.options.contains(InlineAsmOptions::ATT_SYNTAX) {
436 generated_asm.push_str(".att_syntax\n");
439 // The actual inline asm
440 for piece in self.template {
442 InlineAsmTemplatePiece::String(s) => {
443 generated_asm.push_str(s);
445 InlineAsmTemplatePiece::Placeholder { operand_idx, modifier, span: _ } => {
446 if self.options.contains(InlineAsmOptions::ATT_SYNTAX) {
447 generated_asm.push('%');
449 self.registers[*operand_idx]
451 .emit(&mut generated_asm, self.arch, *modifier)
456 generated_asm.push('\n');
458 if is_x86 && self.options.contains(InlineAsmOptions::ATT_SYNTAX) {
459 generated_asm.push_str(".intel_syntax noprefix\n");
462 if !self.options.contains(InlineAsmOptions::NORETURN) {
463 // Read output registers
464 for (reg, slot) in self
467 .zip(self.stack_slots_output.iter().copied())
468 .filter_map(|(r, s)| r.zip(s))
470 Self::save_register(&mut generated_asm, self.arch, reg, slot);
473 // Restore clobbered registers
474 for (reg, slot) in self
477 .zip(self.stack_slots_clobber.iter().copied())
478 .filter_map(|(r, s)| r.zip(s))
480 Self::restore_register(&mut generated_asm, self.arch, reg, slot);
483 Self::epilogue(&mut generated_asm, self.arch);
485 Self::epilogue_noreturn(&mut generated_asm, self.arch);
489 generated_asm.push_str(".att_syntax\n");
491 writeln!(generated_asm, ".size {name}, .-{name}", name = asm_name).unwrap();
492 generated_asm.push_str(".text\n");
493 generated_asm.push_str("\n\n");
498 fn prologue(generated_asm: &mut String, arch: InlineAsmArch) {
500 InlineAsmArch::X86 => {
501 generated_asm.push_str(" push ebp\n");
502 generated_asm.push_str(" mov ebp,[esp+8]\n");
504 InlineAsmArch::X86_64 => {
505 generated_asm.push_str(" push rbp\n");
506 generated_asm.push_str(" mov rbp,rdi\n");
508 InlineAsmArch::RiscV32 => {
509 generated_asm.push_str(" addi sp, sp, -8\n");
510 generated_asm.push_str(" sw ra, 4(sp)\n");
511 generated_asm.push_str(" sw s0, 0(sp)\n");
512 generated_asm.push_str(" mv s0, a0\n");
514 InlineAsmArch::RiscV64 => {
515 generated_asm.push_str(" addi sp, sp, -16\n");
516 generated_asm.push_str(" sd ra, 8(sp)\n");
517 generated_asm.push_str(" sd s0, 0(sp)\n");
518 generated_asm.push_str(" mv s0, a0\n");
520 _ => unimplemented!("prologue for {:?}", arch),
524 fn epilogue(generated_asm: &mut String, arch: InlineAsmArch) {
526 InlineAsmArch::X86 => {
527 generated_asm.push_str(" pop ebp\n");
528 generated_asm.push_str(" ret\n");
530 InlineAsmArch::X86_64 => {
531 generated_asm.push_str(" pop rbp\n");
532 generated_asm.push_str(" ret\n");
534 InlineAsmArch::RiscV32 => {
535 generated_asm.push_str(" lw s0, 0(sp)\n");
536 generated_asm.push_str(" lw ra, 4(sp)\n");
537 generated_asm.push_str(" addi sp, sp, 8\n");
538 generated_asm.push_str(" ret\n");
540 InlineAsmArch::RiscV64 => {
541 generated_asm.push_str(" ld s0, 0(sp)\n");
542 generated_asm.push_str(" ld ra, 8(sp)\n");
543 generated_asm.push_str(" addi sp, sp, 16\n");
544 generated_asm.push_str(" ret\n");
546 _ => unimplemented!("epilogue for {:?}", arch),
550 fn epilogue_noreturn(generated_asm: &mut String, arch: InlineAsmArch) {
552 InlineAsmArch::X86 | InlineAsmArch::X86_64 => {
553 generated_asm.push_str(" ud2\n");
555 InlineAsmArch::RiscV32 | InlineAsmArch::RiscV64 => {
556 generated_asm.push_str(" ebreak\n");
558 _ => unimplemented!("epilogue_noreturn for {:?}", arch),
563 generated_asm: &mut String,
569 InlineAsmArch::X86 => {
570 write!(generated_asm, " mov [ebp+0x{:x}], ", offset.bytes()).unwrap();
571 reg.emit(generated_asm, InlineAsmArch::X86, None).unwrap();
572 generated_asm.push('\n');
574 InlineAsmArch::X86_64 => {
575 write!(generated_asm, " mov [rbp+0x{:x}], ", offset.bytes()).unwrap();
576 reg.emit(generated_asm, InlineAsmArch::X86_64, None).unwrap();
577 generated_asm.push('\n');
579 InlineAsmArch::RiscV32 => {
580 generated_asm.push_str(" sw ");
581 reg.emit(generated_asm, InlineAsmArch::RiscV32, None).unwrap();
582 writeln!(generated_asm, ", 0x{:x}(s0)", offset.bytes()).unwrap();
584 InlineAsmArch::RiscV64 => {
585 generated_asm.push_str(" sd ");
586 reg.emit(generated_asm, InlineAsmArch::RiscV64, None).unwrap();
587 writeln!(generated_asm, ", 0x{:x}(s0)", offset.bytes()).unwrap();
589 _ => unimplemented!("save_register for {:?}", arch),
594 generated_asm: &mut String,
600 InlineAsmArch::X86 => {
601 generated_asm.push_str(" mov ");
602 reg.emit(generated_asm, InlineAsmArch::X86, None).unwrap();
603 writeln!(generated_asm, ", [ebp+0x{:x}]", offset.bytes()).unwrap();
605 InlineAsmArch::X86_64 => {
606 generated_asm.push_str(" mov ");
607 reg.emit(generated_asm, InlineAsmArch::X86_64, None).unwrap();
608 writeln!(generated_asm, ", [rbp+0x{:x}]", offset.bytes()).unwrap();
610 InlineAsmArch::RiscV32 => {
611 generated_asm.push_str(" lw ");
612 reg.emit(generated_asm, InlineAsmArch::RiscV32, None).unwrap();
613 writeln!(generated_asm, ", 0x{:x}(s0)", offset.bytes()).unwrap();
615 InlineAsmArch::RiscV64 => {
616 generated_asm.push_str(" ld ");
617 reg.emit(generated_asm, InlineAsmArch::RiscV64, None).unwrap();
618 writeln!(generated_asm, ", 0x{:x}(s0)", offset.bytes()).unwrap();
620 _ => unimplemented!("restore_register for {:?}", arch),
625 fn call_inline_asm<'tcx>(
626 fx: &mut FunctionCx<'_, '_, 'tcx>,
629 inputs: Vec<(Size, Value)>,
630 outputs: Vec<(Size, CPlace<'tcx>)>,
632 let stack_slot = fx.bcx.func.create_stack_slot(StackSlotData {
633 kind: StackSlotKind::ExplicitSlot,
634 size: u32::try_from(slot_size.bytes()).unwrap(),
636 if fx.clif_comments.enabled() {
637 fx.add_comment(stack_slot, "inline asm scratch slot");
640 let inline_asm_func = fx
646 call_conv: CallConv::SystemV,
647 params: vec![AbiParam::new(fx.pointer_type)],
652 let inline_asm_func = fx.module.declare_func_in_func(inline_asm_func, &mut fx.bcx.func);
653 if fx.clif_comments.enabled() {
654 fx.add_comment(inline_asm_func, asm_name);
657 for (offset, value) in inputs {
658 fx.bcx.ins().stack_store(value, stack_slot, i32::try_from(offset.bytes()).unwrap());
661 let stack_slot_addr = fx.bcx.ins().stack_addr(fx.pointer_type, stack_slot, 0);
662 fx.bcx.ins().call(inline_asm_func, &[stack_slot_addr]);
664 for (offset, place) in outputs {
665 let ty = fx.clif_type(place.layout().ty).unwrap();
666 let value = fx.bcx.ins().stack_load(ty, stack_slot, i32::try_from(offset.bytes()).unwrap());
667 place.write_cvalue(fx, CValue::by_val(value, place.layout()));