rucc_codegen/lower.rs
1//! The selector: an IR function becomes a machine IR function.
2//!
3//! Design: `spec/10-backend.md` sections 10.2 and 10.3.
4//!
5//! What the matcher in [`crate::select`] does is answer one question about one term. What this
6//! does is ask it: walk a function, decide which terms are worth asking about, and build machine
7//! instructions out of what comes back. Nothing here decides what an IR term lowers to. That is
8//! in `rules/x86-64.rules` and it is proved before it is used, which is the whole point of the
9//! arrangement and the reason this file is short.
10//!
11//! # What it does with an instruction
12//!
13//! It tries the ways the instruction can be shown to the matcher, in order, and takes the first
14//! that a rule fires on. [`crate::term`] is what a way of showing one is, and the order is the
15//! most specific first: an operand that is a constant is offered as a constant before it is
16//! offered as a register, and an operand computed by an instruction of its own is offered as
17//! that instruction before it is offered as a register. A rule that wants an immediate too wide
18//! for the machine has a guard that turns it down, and the search carries on to the way of
19//! showing it that puts the constant in a register, which is the right answer and is one nobody
20//! had to write down.
21//!
22//! A constant is not lowered where it is written. It is materialized where a register for it is
23//! first wanted, which is what keeps a constant that every use folded into an immediate from
24//! leaving a dead instruction behind, and it also gives the value the shortest live range it
25//! could have. The instruction that materializes it comes from the rule set like everything else.
26//!
27//! # What it does not do yet
28//!
29//! Everything is in the general purpose registers, because every rule in the set is about an
30//! integer, so a call that passes a `double` and a function that returns one are both reported
31//! rather than lowered. So is an argument that travels on the stack, on either side of a call,
32//! and so is a call through an address rather than to a name.
33//!
34//! # A call
35//!
36//! Not a rule, because a rule pattern sees one term and what a call's operands are is whatever
37//! the signature made them. [`crate::abi`] builds one instead, out of the same description of the
38//! convention the arguments come from: the values it passes are reads constrained to the
39//! registers the convention places them in, what comes back is a write constrained to the
40//! register it comes back in, and every other register the callee is free to destroy is a write
41//! of that register and nothing else, which is all the allocator needs to keep a value out of it.
42//!
43//! What that costs the frame is an argument area, and nothing after selection could work out how
44//! big, so the size of the widest call is given back with the function. A function that makes no
45//! call at all is a leaf, and a leaf is the function that may use the red zone.
46//!
47//! # Where a block goes
48//!
49//! On the block, which is what machine IR does with an edge and is why the branches need no more
50//! rule language than the arithmetic did. A rule never names a block, so an unconditional jump
51//! has no rule at all and a conditional branch has one that is about its condition and nothing
52//! else. The arms are copied across after the block is filled, arguments and all, because an
53//! argument that is a constant is materialized where a register for it is first wanted and the
54//! end of the block is where an edge wants it.
55//!
56//! What this leaves behind is a function whose blocks are in the order the IR held them and whose
57//! branches are still branches on a register. Turning one into a `test` and a `jcc` is the block
58//! layout's, since which of the two arms falls through is the layout's answer, and [`crate::split`]
59//! has to run before allocation so that every edge carrying a value has somewhere to put it.
60//!
61//! A store and a return are the two things here that write no register. A store is emitted like
62//! everything else and the only difference is that there is no result to put anywhere, so the
63//! operands the target describes are all reads. A return is the same, and what it is for is its
64//! one operand: the target constrains it to the register the caller reads the value out of, and
65//! the allocator is what gets it there. The instruction that leaves is not chosen here at all,
66//! because the epilogue has to give the frame back first and [`crate::finish`] writes that after
67//! allocation, so a return of nothing is lowered to nothing.
68//!
69//! The entry block is the one block whose parameters are not block parameters here. They are the
70//! function's arguments, they are already somewhere when it starts, and [`crate::abi`] is what
71//! says where. An argument that arrives on the stack is reported rather than read, because where
72//! the stack put it is a distance into a frame and no frame exists until after allocation.
73//!
74//! Blocks are walked in the order the function holds them and a value is expected to be defined
75//! before it is used, which is true of the IR this is given because every pass before it keeps
76//! definitions ahead of uses.
77
78use std::collections::{HashMap, HashSet};
79use std::fmt;
80
81use rucc_base::{Interner, Symbol};
82use rucc_diag::Span;
83use rucc_ir::{
84 Abi, AsmOperand, AsmOperands, AttrSet, Block, Def, Extra, Flags, FloatPred, Func, Inst,
85 Linkage, MemOrder, Opcode, Param, PrefetchHint, RmwOp, Type, Value, Visibility,
86};
87use rucc_mir as mir;
88use rucc_target::template::{template_name, template_reg};
89use rucc_target::{
90 Address, CallRegs, Constraint, Convention, OperandDesc, PhysReg, RegClass, Role, VaList,
91 Variadic,
92};
93use rucc_target::{aarch64, x86_64};
94
95use crate::abi::{self, Missing, Refused};
96use crate::coverage::Fired;
97use crate::elsewhere::{Elsewhere, Slot};
98use crate::frame::{Layout, Local};
99use crate::select::{Match, Piece, Pointer, Reach, Rule, Selector};
100use crate::term::{MAX_ARGS, PLAIN, Plan, Shown, Term, Terms};
101use crate::varargs;
102
103/// The instruction a template's `jmp` to a name outside it becomes.
104///
105/// The same instruction [`x86_64::FRAME`] names for the end of a tail call, named here as well
106/// because what reaches this one is a template in a function with no prologue and no epilogue,
107/// which is nothing to do with the frame.
108/// See [`x86_64::Step::Away`].
109const AWAY: &str = "jmp_away";
110
111/// How wide an address is on this target, which is the width a cast between a pointer and an
112/// integer has to be at for the cast to be nothing.
113const ADDRESS_BITS: u32 = 64;
114
115/// How much of a register an operand of an `asm` statement fills, which is the width of its type
116/// with two exceptions. A pointer is an address, and a truth value is the byte it is stored in: a
117/// program that writes `sete %0` into a `_Bool` is asking for exactly that byte, which is what tcc's
118/// own test of the width of one checks.
119fn held_bits(ty: Type) -> u32 {
120 if ty.is_ptr() {
121 ADDRESS_BITS
122 } else if ty.bits() == 1 {
123 8
124 } else {
125 ty.bits()
126 }
127}
128
129/// How many bytes a `long double` takes in memory, and what it is aligned to, which are the same
130/// number and are both more than the ten bytes that mean anything.
131///
132/// The psABI's answer rather than a choice here. `sizeof (long double)` is sixteen on this
133/// machine, so an array of them is laid out this way whatever a slot holding one does, and a slot
134/// that agreed with the array is one fewer thing to get wrong.
135const X87_BYTES: u32 = 16;
136
137/// How many values the x87 stack holds at once.
138///
139/// Eight, which is the machine's number rather than a choice here, and it matters in one place:
140/// the parameters of a block are copied through the stack so that they all move at once, and a
141/// block with more of them than this has nowhere to put the ninth.
142const X87_DEPTH: usize = 8;
143
144/// How far into the buffer of a `__builtin_setjmp` each of the four words it writes is.
145///
146/// The first three are gcc's, measured against gcc 16.2.0 on x86-64 at `-O0`: the frame pointer,
147/// the address control comes back to, and the stack pointer, in that order. The fourth is this
148/// compiler's own. gcc has no word for the answer because it writes a second block that sets the
149/// answer to one and is arrived at from the restore, and this writes the answer through memory
150/// instead, for the reason [`Lowering::saves_place`] gives.
151///
152/// None of the four is an interface. The buffer is the program's memory and its five words are
153/// the front end's promise about how much of it there is, but nothing except the matching restore
154/// ever reads a word of it, and a buffer written by one compiler was never going to be one another
155/// compiler could come back through.
156const JUMP_FRAME: i32 = 0;
157
158/// Where the address control comes back to is. See [`JUMP_FRAME`].
159const JUMP_PC: i32 = 8;
160
161/// Where the stack pointer is. See [`JUMP_FRAME`].
162const JUMP_STACK: i32 = 16;
163
164/// Where the address of the word the answer arrives in is. See [`JUMP_FRAME`].
165const JUMP_ANSWER: i32 = 24;
166
167/// How many bytes the word a `__builtin_setjmp` answers with takes in the frame, and what it is
168/// aligned to, which are the same number because it is one machine word.
169const JUMP_WORD: u32 = 8;
170
171/// How many registers the restore needs to hold things in while it puts the frame back.
172///
173/// Four, and every one of them is a register nothing else in the function may be in, which is why
174/// they are counted here rather than asked for one at a time. See [`Lowering::comes_back`].
175const JUMP_REGS: usize = 4;
176
177/// How many bytes the block `__builtin_apply_args` answers takes, which is a word for where the
178/// arguments in memory are, a word of nothing and then the register save area of a variadic
179/// function. See [`Lowering::save_arguments`].
180const APPLY_ARGS: u32 = 192;
181
182/// How far into that block the registers start, which is how far the save area has moved up.
183const APPLY_REGS: u32 = 16;
184
185/// How many bytes the block `__builtin_apply` answers takes, which is two words and two vectors.
186const APPLY_BACK: u32 = 48;
187
188/// How many bytes a value passes through on its way between a register and the x87 stack.
189///
190/// Eight, because the widest thing that crosses is a `double` or a sixty four bit integer, and
191/// nothing crosses at eighty bits: a value that wide is already in the frame and the stack reaches
192/// it where it is.
193const X87_CROSSING: u32 = 8;
194
195/// Where the rounding field of the x87 control word is and what it has to be set to for the unit
196/// to cut towards zero, which is the one rounding C asks for that the unit does not do by default.
197///
198/// Both bits on is truncate. The field is ORed into the word that was already there rather than
199/// written over it, so the precision control and the exception masks somebody else set stay set.
200const X87_TRUNCATE: i64 = 0x0c00;
201
202/// Whether a type is the one this machine has no register for.
203///
204/// Only the eighty bit float is, and that is a fact about x86-64 rather than about floats: every
205/// other scalar the front end produces is in a general purpose register or a vector one, and this
206/// one is on the x87 stack while it is being worked on and in memory the rest of the time. So it
207/// has no place in [`Lowering::class_of`] and no name in [`crate::term`], and every instruction
208/// that touches one is written out by hand in this file.
209fn on_x87(ty: Type) -> bool {
210 ty.is_scalar() && ty.is_float() && ty.bits() == 80
211}
212
213/// Where one operand of an assembly statement is, on each side of the assembly.
214///
215/// Two registers rather than one, because an operand written `+` is a value that arrives and a
216/// value that leaves and those are two values. The machine IR has one definition per register by
217/// construction, so an instruction of the template that reads the operand and writes it has to name
218/// a different register in each place, and what makes the two one register in the end is the
219/// [`Constraint::Reuse`] the instruction's description carries: the allocator reads it, gives both
220/// the same physical register, and copies the incoming value somewhere first when something else is
221/// still using it.
222///
223/// Most operands have one of the two. An input has only a place it is read from and an output
224/// written `=` has only a place it is written to, and asking either of them for the other is an
225/// operand read where the opcode writes or written where it reads, which [`Lowering::placed`]
226/// refuses.
227#[derive(Debug, Clone, Copy, Default, PartialEq, Eq)]
228struct Place {
229 /// The register the value arrives in, for an operand something reads.
230 read: Option<mir::Reg>,
231 /// The register the value leaves in, for an operand something writes.
232 write: Option<mir::Reg>,
233}
234
235/// Whether that operand of the statement is one the assembly may read, and so where a read of it
236/// gets its value from.
237///
238/// [`bound`] asks this question of an operand a constraint letter named and this asks it of one the
239/// template numbered, which is the same question twice because a two-address instruction reaches
240/// its first source both ways. `mulq %3` reaches `rax` by the letter on the output and libgmp says
241/// what is in it with `"%0"` on an input. `addq %5,%q1` reaches its first source by numbering the
242/// output, and libgmp says what is in it with `"0"` on an input in the same way.
243///
244/// So an output written `=` has no value of its own and is still readable when an input is tied to
245/// it, and the value the read wants is that input's. An output written `+` carries its own value
246/// and answers with that. An output nothing is tied to answers `None`, which is a program that told
247/// the compiler the assembly only writes the operand while the instruction reads it before it
248/// writes it, and is refused where it is asked.
249fn read_as(list: &[AsmOperand<'_>], index: usize) -> Option<Value> {
250 let operand = list.get(index)?;
251 if operand.value.is_some() {
252 return operand.value;
253 }
254 operand.result?;
255 list.iter().find(|entry| entry.tied == Some(index)).and_then(|entry| entry.value)
256}
257
258/// Which of an assembly statement's operands is in that register, for an instruction that reaches
259/// the register without its text saying so.
260///
261/// The constraint is what says so, and it is the only thing in such a statement that could:
262/// `"=a"` is an output in `rax`, `"c"` is an input in `rcx`, an operand that is a local register
263/// variable is in the register its declaration named, and a register nothing names is a register
264/// nobody has said anything about. So a write looks among the outputs and a read among the inputs,
265/// and an output written `+` answers for either, since it is read before it is written. See
266/// [`pinned`], which is the one question asked of both ways of saying it.
267///
268/// The other way a read of such a register is said is a matching constraint. `"=a"` on an output
269/// and `"0"` on an input is the program saying that one register holds the input on the way in and
270/// the output on the way out, and it is how a statement fills a register the instruction reads and
271/// writes without writing the register down twice. The letter is on the output, which has no value
272/// to read, and the value is on the input, which has no letter, and the answer is the output: its
273/// place is read out of the register the input arrived in, and in a template with a loop in it the
274/// place moves on to wherever the last write left it, which is what a read on the next time round
275/// wants. tcc steps a pointer along a string with `lodsb` and `"=&S"` tied to `"0"`, and a read of
276/// the input would start the string again every time round.
277///
278/// And a read of a register an output alone is in is a read of that output, the same as a read of
279/// an output the template numbered. tcc copies a string with `lodsb` and `stosb` and `"=&a"` on an
280/// output nothing is tied to, and what `stosb` stores is what `lodsb` loaded one line up, which is
281/// the output as the template left it rather than anything the statement handed in.
282///
283/// `None` is a register the instruction uses and the statement put nothing in, which is the usual
284/// answer rather than an unusual one. `cpuid` writes four registers and a program that wanted one
285/// of them names one. See [`Lowering::spare`], which is where that one goes.
286fn bound(list: &[AsmOperand<'_>], reg: PhysReg, role: Role) -> Option<usize> {
287 let output =
288 list.iter().position(|operand| operand.result.is_some() && pinned(operand) == Some(reg));
289 if role.is_def() {
290 return output;
291 }
292 // The output first when something is in it on the way in, which is what `+` and a matching
293 // constraint both say, since its place is where a write earlier in the template left it and
294 // the read wants that. See [`read_as`] for what it holds before anything wrote it.
295 let arrives = |at: usize| read_as(list, at).is_some();
296 if let Some(at) = output.filter(|&at| arrives(at)) {
297 return Some(at);
298 }
299 let named = list.iter().position(|operand| {
300 operand.result.is_none() && operand.value.is_some() && pinned(operand) == Some(reg)
301 });
302 named.or(output)
303}
304
305/// The register one of an assembly statement's operands is in, whichever of the two ways said it.
306///
307/// A constraint letter is one way and is the only way a program can say one of the six registers
308/// that have a letter. A local register variable is the other, and it is the only way to say any
309/// of the rest: there is no letter for `r12`, which is the whole reason the extension exists, so
310/// the declaration says it and the front end wrote the name into the constraint. The name is read
311/// against this machine's table here, the same place the letter is read against it, and a name the
312/// machine has not got answers nothing, which leaves the operand where an operand nobody placed
313/// goes.
314///
315/// The sigil gcc allows in front of a name is taken off here, because what a name is written with
316/// is syntax and which register it means is this question.
317fn pinned(operand: &AsmOperand<'_>) -> Option<PhysReg> {
318 match operand.named {
319 Some(name) => {
320 let (reg, _) = x86_64::gpr_named(name.strip_prefix('%').unwrap_or(name))?;
321 Some(reg)
322 }
323 None => operand.fixed.and_then(x86_64::gpr_letter),
324 }
325}
326
327/// Whether a constraint says nothing but what it says on every machine.
328///
329/// [`AsmOperands::read`] gives the x86 meaning to every letter it knows, and most of the letters
330/// mean something else on AArch64: `Q` is an address in one register there rather than one of four
331/// registers, and `a` to `d` name nothing. So an AArch64 statement is taken only with the letters
332/// the two agree on, which are a register, a constant, memory, the immediate ranges and a matching
333/// number, and anything else is refused rather than read as x86. `w` and `Q` are the exceptions.
334/// `w` is a register on both, and which file it is in is decided by the caller with
335/// [`vector_letter`]. `Q` is read as `m` by the caller before the list is read. A
336/// register the front end named in braces is read against AArch64's own names, so what is inside
337/// them is not a letter.
338fn shared_letters(constraint: &str) -> bool {
339 let mut inside = false;
340 constraint.chars().all(|c| match c {
341 '{' => {
342 inside = true;
343 true
344 }
345 '}' => {
346 inside = false;
347 true
348 }
349 _ if inside => true,
350 _ => matches!(
351 c,
352 '=' | '+' | '&' | '%' | 'r' | 'w' | 'Q' | 'm' | 'o' | 'V' | 'g' | 'X' | 'i' | 'n'
353 | 'p' | 'I'..='N' | '0'..='9'
354 ),
355 })
356}
357
358/// A constraint list with every letter outside braces put through `swap`, and what is inside them,
359/// which is a register's name rather than letters, left alone.
360fn letters_outside(constraints: &str, swap: impl Fn(char) -> char) -> String {
361 let mut inside = false;
362 constraints
363 .chars()
364 .map(|c| {
365 match c {
366 '{' => inside = true,
367 '}' => inside = false,
368 _ if !inside => return swap(c),
369 _ => {}
370 }
371 c
372 })
373 .collect()
374}
375
376/// Whether an AArch64 constraint asks for a floating point or vector register, which is what `w`
377/// means there. A register named in braces is not a letter, so a `w` inside one is not read.
378fn vector_letter(constraint: &str) -> bool {
379 let mut inside = false;
380 constraint.chars().any(|c| {
381 match c {
382 '{' => inside = true,
383 '}' => inside = false,
384 _ => {}
385 }
386 !inside && c == 'w'
387 })
388}
389
390/// The x86-64 vector register one entry of a clobber list names, spelled `xmm0` or `ymm0` with or
391/// without the sigil, or nothing for any other entry. Only the sixteen there are without AVX-512,
392/// so `zmm0` and `xmm16` are still refused as names this has no register for.
393fn vector_named(entry: &str) -> Option<PhysReg> {
394 let entry = entry.trim().trim_matches('"');
395 let entry = entry.strip_prefix('%').unwrap_or(entry);
396 let number = entry.strip_prefix("xmm").or_else(|| entry.strip_prefix("ymm"))?;
397 if number.len() > 1 && number.starts_with('0') {
398 return None;
399 }
400 let number: u8 = number.parse().ok()?;
401 (number < 16).then(|| x86_64::xmm(number))
402}
403
404/// Whether a line of a template names, by number, an operand `wanted` says yes to.
405///
406/// `%%` is a percent sign rather than an operand, and a modifier letter may stand between the sign
407/// and the number.
408fn names_one(line: &str, wanted: impl Fn(usize) -> bool) -> bool {
409 let mut rest = line;
410 while let Some(at) = rest.find('%') {
411 let after = &rest[at + 1..];
412 if let Some(escaped) = after.strip_prefix('%') {
413 rest = escaped;
414 continue;
415 }
416 let after = after.strip_prefix(|c: char| c.is_ascii_alphabetic()).unwrap_or(after);
417 let digits = after.len() - after.trim_start_matches(|c: char| c.is_ascii_digit()).len();
418 if after[..digits].parse().is_ok_and(&wanted) {
419 return true;
420 }
421 rest = &after[digits..];
422 }
423 false
424}
425
426/// Why a function could not be lowered.
427///
428/// One reason and then nothing. A function with no rule for something in it is a function this
429/// cannot finish, and the second thing it could not lower is not news.
430#[derive(Debug, Clone, PartialEq, Eq)]
431pub enum Unsupported {
432 /// An instruction no rule fires on.
433 Inst {
434 /// The instruction that stopped it.
435 inst: Inst,
436 /// What the rule file would call it, or nothing if the rule language has no name for it
437 /// at all, which is what an instruction at a width nothing is written about looks like.
438 term: Option<&'static str>,
439 /// The opcode, which is what gets named when the rule language has no word for it.
440 ///
441 /// An opcode the rule language has no word for is exactly the opcode no rule lowers, so
442 /// without this the message would be empty in every case where somebody needs it.
443 opcode: Opcode,
444 /// What it produces, or nothing for an instruction that is only an effect.
445 ty: Option<Type>,
446 },
447 /// A parameter that does not arrive somewhere this can bring it in from.
448 ///
449 /// Not an instruction, which is why it is a separate arm: it is a fact about the signature
450 /// and there is nothing in the body of the function to point at.
451 Argument {
452 /// Its position in the signature.
453 index: usize,
454 /// What is wrong with where it arrives.
455 missing: Missing,
456 },
457 /// A call that passes or gives back a value this cannot put where the convention wants it.
458 Call {
459 /// The call.
460 inst: Inst,
461 /// Which value, and what is wrong with where it travels.
462 refused: Refused,
463 },
464 /// A `return` this cannot put where the convention wants it.
465 ///
466 /// A separate arm from [`Unsupported::Inst`] because it is not an instruction no rule fires
467 /// on. A return of more than one value is built from the convention rather than matched, the
468 /// same way a call is, so what goes wrong with one is what goes wrong with a call and not the
469 /// absence of a rule.
470 Returned {
471 /// The `return`.
472 inst: Inst,
473 /// What is wrong with where one of the values travels.
474 missing: Missing,
475 },
476 /// A stack slot the frame cannot give the bytes it asked for.
477 ///
478 /// Not an instruction no rule covers. An `alloca` is built here rather than matched, so what
479 /// goes wrong with one is what the frame can and cannot hold rather than what the rules spell.
480 Dynamic {
481 /// The `alloca`.
482 inst: Inst,
483 /// What the frame could not do about it.
484 growing: Growing,
485 },
486 /// More parameters of a type that travels on the x87 stack than the stack is deep.
487 ///
488 /// Not an instruction either, for the reason a function's parameter is not one: it is a fact
489 /// about the block and there is nothing in the block to point at. What crosses an edge for one
490 /// of these is the address of where the value is, and the block copies the bytes into a slot
491 /// of its own, all of them through the stack at once so that a block carrying two of them
492 /// swapped is copied in an order that is right. Eight is as many as the stack holds, and a
493 /// ninth would have to be copied before or after the rest, which is the order that could be
494 /// wrong.
495 Phi {
496 /// Which block it arrives at.
497 block: Block,
498 /// How many of them arrive there, which is the whole of what is wrong.
499 count: usize,
500 /// What they are.
501 ty: Type,
502 },
503 /// An `asm` statement this cannot build.
504 ///
505 /// Not an instruction no rule fires on, for the reason a call is not one: what it stands for is
506 /// whatever its template says, and no pattern over terms can read a string.
507 Assembly {
508 /// The `inline_asm`.
509 inst: Inst,
510 /// What about it is not built here yet.
511 refused: Written,
512 },
513 /// A `register long x asm ("...")` naming something this machine has not got.
514 ///
515 /// Not an instruction no rule fires on. There is a rule's worth of instruction here and what
516 /// is wrong is the string beside it, which is a name rather than a term, so the message says
517 /// the name. Which names a machine has is the machine's own question and this is where it is
518 /// asked, at the table a clobber list is read against.
519 Register {
520 /// The `register_value`.
521 inst: Inst,
522 /// The name the program wrote, as it wrote it.
523 name: String,
524 },
525 /// A naked function whose frame is not empty.
526 ///
527 /// Not an instruction no rule fires on, and there is nothing in the body to point at: the
528 /// function asked for no prologue and then wanted bytes only a prologue takes. Refused rather
529 /// than given the bytes anyway, because an offset into a frame nothing set up reaches into
530 /// whatever the caller left below its own stack pointer, which is wrong code that assembles.
531 /// See [`crate::frame::Layout::naked`].
532 Naked {
533 /// How many bytes it wanted, which is the whole of what is wrong.
534 bytes: u32,
535 },
536 /// Something the x86-64 lowering writes by hand and nothing has written for this machine yet.
537 ///
538 /// Refused rather than written with the x86 instructions, which is what the walk would do
539 /// otherwise, since these are the places it names them itself.
540 Unported {
541 /// The instruction, or nothing for the one that is about a signature.
542 inst: Option<Inst>,
543 /// Which of them.
544 what: Unported,
545 },
546}
547
548/// What [`Unsupported::Unported`] is about.
549#[derive(Debug, Clone, Copy, PartialEq, Eq)]
550pub enum Unported {
551 /// The thread pointer on Apple's platforms, which keep it somewhere other than Linux does.
552 Thread,
553 /// A call in a convention the platform has no registers for, which the front end never asks
554 /// for since it reads `ms_abi` and `sysv_abi` on x86-64 alone, and is refused rather than
555 /// made in the wrong one if something else ever does.
556 Convention,
557}
558
559impl Unported {
560 /// The whole message, since there is nothing to put in front of it.
561 #[must_use]
562 pub fn why(self) -> &'static str {
563 match self {
564 Unported::Thread => "the thread pointer is not written for this platform yet",
565 Unported::Convention => {
566 "this calls a function of a calling convention this platform does not have"
567 }
568 }
569 }
570}
571
572/// What about an `asm` statement is not built yet.
573#[derive(Debug, Clone, Copy, PartialEq, Eq)]
574pub enum Written {
575 /// A template with instructions in it.
576 Template,
577 /// An `asm goto`, whose labels make the statement a terminator.
578 Goto,
579 /// An operand this cannot put where the constraint says it goes.
580 Operand,
581 /// A clobber list naming something this has no register for.
582 Clobber,
583 /// A `jmp` out of the function in a function that has an epilogue behind it.
584 Away,
585}
586
587impl Written {
588 /// The rest of the sentence that starts with the statement.
589 #[must_use]
590 pub fn why(self) -> &'static str {
591 match self {
592 // The template is the assembler's to read and there is no assembler here yet, so a
593 // template with anything in it is a string nothing can turn into bytes. An empty one is
594 // no instructions, and no instructions is something this can write.
595 Written::Template => "has instructions in its template, which nothing here assembles",
596 Written::Goto => "jumps to a label, which nothing here builds an edge for",
597 Written::Operand => "has an operand this cannot place",
598 Written::Clobber => "says it destroys a register this has no name for",
599 Written::Away => {
600 "jumps out of the function, which only a function that is `naked` may do, since \
601 anywhere else there is an epilogue behind it to give the frame back"
602 }
603 }
604 }
605}
606
607/// What the frame could not do about a stack slot.
608#[derive(Debug, Clone, Copy, PartialEq, Eq)]
609pub enum Growing {
610 /// An object of a size the number a frame counts bytes in does not reach.
611 Huge,
612 /// A variable length array wanting more alignment than a call leaves the stack pointer with.
613 ///
614 /// Rounding the stack pointer down again after the bytes have been taken would put it
615 /// somewhere no constant reaches the rest of the frame from, so a frame like this needs a
616 /// second base register held for the whole of the function. Nothing here holds one.
617 ///
618 /// [`crate::expand::rounds`] takes the array away before this sees it, by asking for the
619 /// alignment in extra bytes and handing out an address inside them, so what is left of this
620 /// is IR that arrived without going through that pass and the fixed local in
621 /// [`crate::pipeline`] that wants the same thing from the other side.
622 Aligned,
623 /// A variable length array in a function written without a prologue.
624 ///
625 /// A frame that grows is reached from a frame pointer, and establishing one is the first two
626 /// instructions of a prologue that `__attribute__((naked))` asked there be none of. See
627 /// [`crate::frame::Layout::naked`].
628 Naked,
629}
630
631impl Growing {
632 /// The rest of the sentence that starts with the slot.
633 #[must_use]
634 pub fn why(self) -> &'static str {
635 match self {
636 Growing::Huge => "is more bytes than a frame counts",
637 Growing::Aligned => {
638 "wants more alignment than the stack pointer is left on, which needs a base \
639 register nothing here keeps"
640 }
641 Growing::Naked => {
642 "is in a function that is `naked`, which has no prologue to point a frame pointer \
643 at it with"
644 }
645 }
646 }
647}
648
649impl Unsupported {
650 /// The instruction it is about, or nothing for the one arm that is about a signature.
651 ///
652 /// What a caller wants this for is the span. The function knows where every instruction in
653 /// it came from, so a caller holding both can point a message at the line somebody wrote
654 /// rather than at the file as a whole, and nothing here has to carry a span of its own.
655 pub fn inst(&self) -> Option<Inst> {
656 match *self {
657 Unsupported::Inst { inst, .. }
658 | Unsupported::Call { inst, .. }
659 | Unsupported::Returned { inst, .. }
660 | Unsupported::Dynamic { inst, .. }
661 | Unsupported::Assembly { inst, .. }
662 | Unsupported::Register { inst, .. } => Some(inst),
663 Unsupported::Unported { inst, .. } => inst,
664 Unsupported::Argument { .. } | Unsupported::Phi { .. } | Unsupported::Naked { .. } => {
665 None
666 }
667 }
668 }
669}
670
671impl fmt::Display for Unsupported {
672 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
673 match *self {
674 Unsupported::Inst { term: Some(term), .. } => write!(f, "no rule lowers `{term}`"),
675 Unsupported::Inst { term: None, opcode, ty: Some(ty), .. } => {
676 write!(f, "no rule lowers a `{opcode}` producing a `{ty}`")
677 }
678 Unsupported::Inst { term: None, opcode, ty: None, .. } => {
679 write!(f, "no rule lowers a `{opcode}`")
680 }
681 Unsupported::Argument { index, missing } => {
682 write!(f, "parameter {index} {}", missing.why())
683 }
684 Unsupported::Call { refused: Refused { argument: Some(index), missing }, .. } => {
685 write!(f, "argument {index} of this call {}", missing.why())
686 }
687 Unsupported::Call { refused: Refused { argument: None, missing }, .. } => {
688 write!(f, "what this call gives back {}", missing.why())
689 }
690 Unsupported::Returned { missing, .. } => {
691 write!(f, "what this function gives back {}", missing.why())
692 }
693 Unsupported::Dynamic { growing, .. } => {
694 write!(f, "this local {}", growing.why())
695 }
696 Unsupported::Phi { block, count, ty } => {
697 let block = block.index();
698 write!(
699 f,
700 "block{block} takes {count} parameters of type `{ty}` and only {X87_DEPTH} can cross an edge at once"
701 )
702 }
703 Unsupported::Assembly { refused, .. } => write!(f, "this `asm` {}", refused.why()),
704 Unsupported::Unported { what, .. } => f.write_str(what.why()),
705 Unsupported::Register { ref name, .. } => {
706 write!(
707 f,
708 "this object is kept in `{name}`, which is not a register this machine has"
709 )
710 }
711 Unsupported::Naked { bytes } => write!(
712 f,
713 "this function is `naked` and wants {bytes} bytes of frame, which there is no prologue to take"
714 ),
715 }
716 }
717}
718
719impl std::error::Error for Unsupported {}
720
721/// A lowered function, and what the frame needs that the machine IR does not hold.
722#[derive(Debug)]
723pub struct Lowered {
724 /// The function, in machine instructions.
725 pub func: mir::Func,
726 /// What it wants its stack to look like, which is separate from the function so that the two
727 /// can be read and written at the same time.
728 pub stack: Stack,
729 /// Which rules of the table lowered it, which is what `-Zrule-coverage` asks for and what
730 /// `crate::coverage` writes down.
731 pub fired: Fired,
732 /// Which machine IR block each IR block became, indexed by the IR block's own index, and
733 /// nothing for a block the walk never reached.
734 ///
735 /// Here because it is the only place the correspondence exists. Selection makes one block per
736 /// block, in the same order and with the arms in the same order, so anything the IR knows
737 /// about a block can be carried down through this and nothing else, and
738 /// [`crate::weights::carry`] is what does.
739 pub blocks: Vec<Option<mir::Block>>,
740}
741
742/// What a function's stack has to hold, as far as selection is able to say.
743///
744/// All of it is answered here because selection is where a call is built and where an `alloca`
745/// is read, and nothing after it could tell what either of them needed.
746#[derive(Debug, Default)]
747pub struct Stack {
748 /// How many bytes the widest call in the function needs below the stack pointer for the
749 /// arguments it passes there, or `None` for a function that makes no call at all.
750 ///
751 /// `None` is a leaf, which is the function that may use the red zone and the one whose stack
752 /// pointer does not have to be left aligned for anybody.
753 pub calls: Option<u32>,
754 /// The memory the function asked for itself, one entry for every `alloca` in it, in the order
755 /// the walk reached them.
756 pub locals: Vec<Local>,
757 /// Which instruction computes the address of which of those locals.
758 ///
759 /// An address in the frame is a distance from the stack pointer, and there is no frame until
760 /// after allocation, so the instruction is written here with nothing in its displacement and
761 /// [`crate::finish`] writes the number in once [`crate::frame::Frame`] knows it.
762 pub addresses: Vec<(mir::Inst, usize)>,
763 /// Which of those locals is which declaration in the source, for the ones the program declared.
764 ///
765 /// The number is the one the IR function carries and means nothing here. What it is for is the
766 /// debugging information, which has to say where a named local ended up and cannot ask the
767 /// frame directly: the frame knows a local by the order the `alloca` for it was lowered in and
768 /// by nothing else.
769 ///
770 /// Shorter than the list above rather than the same length, because most of what a function
771 /// keeps in its frame is memory an expression wanted somewhere to put.
772 pub declared: Vec<(usize, u32)>,
773 /// Which instruction computes the address of a piece of memory whose size the function works
774 /// out while it runs, which is what a variable length array is.
775 ///
776 /// Waiting on [`crate::finish`] for a different number from the one the addresses above are:
777 /// the bytes were taken off the stack pointer by the instruction in front of this one, so where
778 /// they start is however much of the bottom of the frame belongs to the arguments of a call,
779 /// and that is not known until the frame is.
780 pub dynamic: Vec<mir::Inst>,
781 /// Which instruction takes those bytes off the stack pointer, one for every one of them, in the
782 /// order the walk reached them.
783 ///
784 /// Read by [`crate::finish`] on a command line that asked for the stack to be touched a page at
785 /// a time, which is the one thing that has to find these again: the bytes are in a register by
786 /// then, so the walk down to them is a loop, and a loop is written around an instruction rather
787 /// than in front of a block. Nothing else looks at them, because everything else about a frame
788 /// that grows is answered by the address the instruction below this one computes.
789 pub grown: Vec<mir::Inst>,
790 /// Where the function first moves the stack pointer while it runs, if it does at all.
791 ///
792 /// Two things are read off this. One is whether at all, which is what [`crate::frame::Layout`]
793 /// wants, because a frame that moves its stack pointer has a different shape from one that does
794 /// not and the layout is built before the instructions are looked at again. See `Growing` in
795 /// [`crate::frame`]. The other is where, so that a caller that cannot accept such a frame has
796 /// somewhere to point when it says so.
797 pub grown_at: Option<Inst>,
798 /// Which instruction reads which of the arguments the caller passed on the stack, as how far up
799 /// the caller's argument area it reads.
800 ///
801 /// Waiting on [`crate::finish`] for the same reason the addresses above are, and on one thing
802 /// more: where the caller's argument area is from inside this function depends on whether the
803 /// prologue had to force the stack pointer's alignment, so which register the load reads
804 /// through is not settled here either.
805 pub arguments: Vec<(mir::Inst, u32)>,
806 /// Whether the function asked where its own frame is, which is what `__builtin_frame_address`
807 /// and `__builtin_return_address` both start from.
808 ///
809 /// A function like that keeps a frame pointer whatever the flags say, because the register is
810 /// the answer to the first of them and the start of the walk for every depth above zero. There
811 /// is no other way to reach it: the distance from the stack pointer to the frame is a number
812 /// the layout works out, and what a walk up the chain needs is the link the prologue saved.
813 pub walks_frames: bool,
814 /// Whether the function saved a place for a `__builtin_longjmp` to come back to, which is what
815 /// `__builtin_setjmp` does.
816 ///
817 /// A function like that keeps a frame pointer whatever the flags say as well, and for a reason
818 /// of the same shape: the two registers the restore puts back are the frame pointer and the
819 /// stack pointer, and a frame that did not keep the first of them has nothing in it saying
820 /// where the caller's frame is for the epilogue to find after control has come back.
821 pub saves_place: bool,
822 /// The calls a `tail_call` became that [`crate::tail::jumps`] may turn into a jump, which is
823 /// the ones that passed everything in registers.
824 pub tails: Vec<crate::tail::Tail>,
825 /// How many bytes the prologue takes above the frame record to home the argument registers
826 /// into, which is nothing except in a variadic function on Windows on AArch64.
827 ///
828 /// That convention has no shadow space the caller reserves, so the callee makes its own: the
829 /// first thing its prologue does is take sixty four bytes, which puts `x0` to `x7` directly
830 /// below the arguments the caller left on the stack and makes the whole run one list of words
831 /// a `char *` can walk. See `home` on [`rucc_target::CallRegs`].
832 pub home: u32,
833}
834
835impl Stack {
836 /// The layout given, with the three fields only the lowering knows the answer to filled in.
837 ///
838 /// Everything else in a layout comes from the flags the function is compiled under or from the
839 /// allocation, so this takes one and returns it rather than building one.
840 ///
841 /// A function that saved a place is not a leaf whatever it called. What a leaf buys is the red
842 /// zone, which is the words below the stack pointer nothing else may write, and a function
843 /// control comes back into from a `__builtin_longjmp` has already had something else running
844 /// down there: whatever it called and whatever that called, or a signal handler on the same
845 /// stack. Every one of those has written over the red zone by the time control arrives, so a
846 /// value this function left there would not be there any more.
847 #[must_use]
848 pub fn layout<'a>(&'a self, base: Layout<'a>) -> Layout<'a> {
849 Layout {
850 leaf: self.calls.is_none() && !self.saves_place,
851 outgoing: self.calls.unwrap_or(0),
852 locals: &self.locals,
853 grows: self.grown_at.is_some(),
854 home: self.home,
855 ..base
856 }
857 }
858}
859
860/// The machine IR for that function, for the machine the selector describes.
861///
862/// # Errors
863///
864/// The first instruction no rule fires on, which today is anything at a width the rule set is not
865/// written at, a parameter that does not arrive in a register this can read, or a call that
866/// passes something this cannot put where the convention wants it.
867pub fn func(
868 source: &Func,
869 names: &mut Interner,
870 selector: &'static Selector,
871 conv: &'static CallRegs,
872 elsewhere: &Elsewhere,
873) -> Result<Lowered, Unsupported> {
874 func_for(source, names, selector, conv, elsewhere, true)
875}
876
877/// [`func`], for a build that says whether it writes debugging information. Without it the walk
878/// leaves out which value each declaration holds on the way into each block, since that is read
879/// only for the debugging information.
880///
881/// # Errors
882///
883/// The same as [`func`].
884pub fn func_for(
885 source: &Func,
886 names: &mut Interner,
887 selector: &'static Selector,
888 conv: &'static CallRegs,
889 elsewhere: &Elsewhere,
890 debug: bool,
891) -> Result<Lowered, Unsupported> {
892 Lowering::new(source, names, selector, conv, elsewhere, debug).run()
893}
894
895/// What the matcher settled on for one block, indexed the way the block's instructions are.
896struct Decided {
897 /// What each instruction matched, and nothing for one that matched no rule or was folded
898 /// into a later one.
899 found: Vec<Option<Match<Term>>>,
900 /// How each instruction showed its operands to the matcher, which is what says what it took.
901 plans: Vec<Option<Plan>>,
902 /// The instructions some other instruction took, which are the ones with nothing to write.
903 folded: Vec<Inst>,
904}
905
906/// The instruction in front of an assignment that starts a declaration on a value, and the first
907/// machine instruction after it once the block is filled.
908type Mark = (Option<Inst>, Option<mir::Inst>);
909
910/// One function being lowered.
911struct Lowering<'a> {
912 source: &'a Func,
913 names: &'a mut Interner,
914 out: mir::Func,
915 /// The machine register each IR value is in, once it has one.
916 regs: Vec<Option<mir::Reg>>,
917 /// For a constant that has been written into a register, the block it was written into,
918 /// which is the only block that register is any good in.
919 written: Vec<Option<mir::Block>>,
920 /// How many times each IR value is read, which is what says whether an instruction may be
921 /// folded into the one that reads it.
922 uses: Vec<u32>,
923 /// The block being filled.
924 at: Option<mir::Block>,
925 /// The machine IR block each IR block became.
926 blocks: Vec<Option<mir::Block>>,
927 /// The class an address is in, which is the general purpose one and is not a question: every
928 /// register an addressing mode names holds part of an address, and there is no machine here
929 /// that computes an address anywhere but in this file. Which class a *value* is in is
930 /// [`Lowering::class_of`], and it is a question, because a float is in the other one.
931 gpr: RegClass,
932 /// The machine this selects for.
933 selector: &'static Selector,
934 /// Where the convention this function is compiled for puts things, which is read for the
935 /// arguments and for the calls.
936 conv: &'static CallRegs,
937 /// Which names this function may not work an address out for itself, which is a fact about the
938 /// module and so is worked out before any of this and handed in.
939 elsewhere: &'a Elsewhere,
940 /// Whether the build writes debugging information, which is the one thing that reads which
941 /// value a declaration holds on the way into each block.
942 debug: bool,
943 /// What the function wants its stack to look like, filled in as the walk finds out.
944 stack: Stack,
945 /// What a `va_start` in this function has to write, or nothing for a function that takes no
946 /// arguments its signature does not name.
947 ///
948 /// Worked out once, when the entry block binds the parameters, because every number in it is
949 /// about where those parameters left the walk over the argument registers and there is nowhere
950 /// else that knows.
951 varargs: Option<Varargs>,
952 /// Which of the function's stack objects each eighty bit value lives in, once it has asked
953 /// for one.
954 ///
955 /// One slot per value and it is never given back, which is what makes an eighty bit value
956 /// behave like every other one: it is written once and read wherever it is read, and no two
957 /// of them share a slot the way two of them would share a register. What is in a register is
958 /// the address, and that is worked out again at every use rather than kept, so nothing here
959 /// holds a general purpose register open across a whole function.
960 slots: Vec<Option<usize>>,
961 /// The eight bytes a value passes through between a register and the x87 stack, once
962 /// something has wanted them.
963 ///
964 /// One for the whole function, because every group that uses it is a handful of instructions
965 /// with nothing in between: the bytes are written, read straight back and never looked at
966 /// again, so a second slot would be a second slot holding the same nothing.
967 crossing: Option<usize>,
968 /// The four bytes the control word is saved in and the changed copy written to, once
969 /// something has wanted them.
970 ///
971 /// One for the whole function for the reason above, and four rather than two because it is
972 /// two words: the one the unit had and the one with the rounding field turned to truncate.
973 control: Option<usize>,
974 /// The word a `__builtin_setjmp` in this function answers with, once one has asked for it.
975 ///
976 /// One for the whole function however many saves there are in it, because the word is written
977 /// and read back with nothing in between: the save writes a zero into it and the instruction
978 /// straight after reads it, and the only other thing that ever writes it is a restore arriving
979 /// between those two. Two saves sharing it is two pairs each doing that, and neither can be
980 /// inside the other.
981 answer: Option<usize>,
982 /// The block `__builtin_apply_args` answers the address of, or nothing in a function that holds
983 /// none.
984 ///
985 /// Written once, in the prologue, because what it holds is every argument register as it was
986 /// on the way in, and by the time the walk reaches the call the registers hold whatever the
987 /// function has done since. Every `__builtin_apply_args` in the function answers the same one.
988 applied: Option<usize>,
989 /// Which rules have fired so far.
990 fired: Fired,
991 /// Where each assignment that starts a declaration on a value part of the way through is, by
992 /// the IR block it is in and the instruction in front of it, and which machine instruction
993 /// is the first one after it once the block has been filled. See
994 /// [`rucc_ir::Func::declare_value_from`].
995 marks: HashMap<Block, Vec<Mark>>,
996 /// The frame slot each fixed size `alloca` was given, which a landing pad writes the address
997 /// of again rather than reading the register the rest of the function has it in. See
998 /// [`Self::pad`].
999 frame_slots: HashMap<Value, usize>,
1000 /// The machine call each IR call with an unwind edge became, which [`Self::edges`] pairs with
1001 /// the pad the edge went to. See [`rucc_ir::Opcode::Unwound`].
1002 unwinding: HashMap<Inst, mir::Inst>,
1003}
1004
1005/// What a `va_start` in a variadic function writes into the list it is given.
1006///
1007/// Two shapes, because two conventions describe a list two ways, and [`crate::varargs`] is where
1008/// both are written down. Neither is a set of numbers on its own: where the save area is and where
1009/// the caller's argument area is are distances into a frame that does not exist until after
1010/// allocation, so each is a `lea` [`crate::finish`] fills in.
1011#[derive(Debug, Clone, Copy, PartialEq, Eq)]
1012enum Varargs {
1013 /// The four field list, whose two offsets are settled here and whose two addresses are not.
1014 Fields {
1015 /// Which of the function's stack objects is the register save area.
1016 save: usize,
1017 /// How far up the caller's argument area the first argument the signature does not name is,
1018 /// which is the whole of that area the named ones did not take.
1019 incoming: u32,
1020 /// What `gp_offset` starts at, which is past the general purpose registers the named
1021 /// arguments took.
1022 integers: u32,
1023 /// What `fp_offset` starts at, which is past the vector ones.
1024 floats: u32,
1025 },
1026 /// The AAPCS64 list, whose two offsets count up to zero from the top of each half of the save
1027 /// area. The two tops are addresses in the frame and so is the first field, like the SysV list.
1028 Aapcs {
1029 /// Which of the function's stack objects is the register save area.
1030 save: usize,
1031 /// How far up the caller's argument area the first argument the signature does not name is.
1032 incoming: u32,
1033 /// Where the general purpose half of the save area ends.
1034 integers_end: u32,
1035 /// Where the vector half ends, which is the end of the area.
1036 floats_end: u32,
1037 /// What `__gr_offs` starts at, which is minus the general purpose half the named arguments
1038 /// did not take.
1039 integers: i32,
1040 /// What `__vr_offs` starts at.
1041 floats: i32,
1042 },
1043 /// The list that is a pointer, which is the one address and nothing else.
1044 Pointer {
1045 /// How far up the caller's argument area the first argument the signature does not name is,
1046 /// which on this convention is the word belonging to the position the named ones stopped
1047 /// at.
1048 incoming: u32,
1049 },
1050}
1051
1052/// How far a function's name reaches, narrowed from the linkage the IR gave it.
1053///
1054/// The IR has five and an object file says three, and the two the linker cannot tell apart are
1055/// the two weak ones: which of them a symbol had is a fact the optimizer reads and the linker has
1056/// no way to record. A function is never `Common`, since that is what a tentative definition of an
1057/// object is and there is no tentative definition of a function, and it is written here rather
1058/// than left out so that a linkage added later has to come past this.
1059const fn binding(linkage: Linkage) -> mir::Binding {
1060 match linkage {
1061 Linkage::Internal => mir::Binding::Local,
1062 Linkage::Weak | Linkage::LinkOnce => mir::Binding::Weak,
1063 Linkage::External | Linkage::Common => mir::Binding::Global,
1064 }
1065}
1066
1067/// How far a function's name reaches outside a shared library, carried across unchanged.
1068///
1069/// Nothing is narrowed here the way [`binding`] narrows the linkage, because ELF records all
1070/// three of these and the two enumerations are the same three answers written twice: once in a
1071/// crate that is not allowed to know what an object file is and once in one that is.
1072const fn visibility(visibility: Visibility) -> mir::Visibility {
1073 match visibility {
1074 Visibility::Default => mir::Visibility::Default,
1075 Visibility::Hidden => mir::Visibility::Hidden,
1076 Visibility::Protected => mir::Visibility::Protected,
1077 }
1078}
1079
1080impl<'a> Lowering<'a> {
1081 fn new(
1082 source: &'a Func,
1083 names: &'a mut Interner,
1084 selector: &'static Selector,
1085 conv: &'static CallRegs,
1086 elsewhere: &'a Elsewhere,
1087 debug: bool,
1088 ) -> Self {
1089 let counts = source.counts();
1090 let name = source.name;
1091 let mut uses = vec![0; counts.values];
1092 for block in source.blocks() {
1093 for inst in source.insts(block) {
1094 for &arg in &source[source[inst].args] {
1095 uses[arg.index()] += 1;
1096 }
1097 for call in source.successors(inst) {
1098 for &arg in &source[call.args] {
1099 uses[arg.index()] += 1;
1100 }
1101 }
1102 }
1103 }
1104 let mut out = mir::Func::new(name);
1105 out.align = source.align;
1106 // Carried rather than worked out here, because where a function was declared is a fact
1107 // about the source and this is a long way past it. What wants it is the line table.
1108 out.declared = source.declared;
1109 out.binding = binding(source.linkage);
1110 out.visibility = visibility(source.visibility);
1111 Self {
1112 source,
1113 names,
1114 out,
1115 regs: vec![None; counts.values],
1116 written: vec![None; counts.values],
1117 blocks: vec![None; counts.blocks],
1118 uses,
1119 at: None,
1120 gpr: selector.gpr,
1121 selector,
1122 conv,
1123 elsewhere,
1124 debug,
1125 stack: Stack::default(),
1126 varargs: None,
1127 slots: vec![None; counts.values],
1128 crossing: None,
1129 control: None,
1130 answer: None,
1131 applied: None,
1132 fired: Fired::new(),
1133 marks: HashMap::new(),
1134 frame_slots: HashMap::new(),
1135 unwinding: HashMap::new(),
1136 }
1137 }
1138
1139 fn run(mut self) -> Result<Lowered, Unsupported> {
1140 for value in self.source.values() {
1141 for start in self.source.value_starts(value) {
1142 let Some((block, after)) = self.source.start_place(start) else { continue };
1143 let marks = self.marks.entry(block).or_default();
1144 if !marks.iter().any(|&(have, _)| have == after) {
1145 marks.push((after, None));
1146 }
1147 }
1148 }
1149 // Every block before any of them is filled, because a block that jumps forward has to
1150 // name the block it jumps to and a machine IR block is named by a handle rather than by
1151 // the IR block it came from.
1152 for block in self.source.blocks() {
1153 let out = self.out.create_block();
1154 self.blocks[block.index()] = Some(out);
1155 }
1156 for block in self.order() {
1157 self.block(block)?;
1158 }
1159 // And the name each block an image holds the address of was given, which nothing in the
1160 // walk above would ask for: the `lea` a label address is inside the function needs no
1161 // symbol, and the one thing that does is a relocation in another section.
1162 let named: Vec<(Block, Symbol)> = self.source.named_blocks().collect();
1163 let labels: Vec<(mir::Block, Symbol)> =
1164 named.into_iter().map(|(block, name)| (self.out_block(block), name)).collect();
1165 self.out.labels = labels;
1166 self.naming();
1167 Ok(Lowered { func: self.out, stack: self.stack, fired: self.fired, blocks: self.blocks })
1168 }
1169
1170 /// Which register each declaration the front end kept in a value ended up in, as far as this
1171 /// walk can say, which is the other half of what [`Lowering::new_reg`] writes down as it goes.
1172 ///
1173 /// Two halves because there are two ways a value gets a register here. Most of them ask for a
1174 /// fresh one and that is where `new_reg` catches them, and the rest are put in a register
1175 /// something else chose: a parameter arrives in whichever one the convention handed it, a block
1176 /// parameter in whichever one the edge agreed on, and a result of a rule that names its own
1177 /// registers in the one the rule named. None of those goes past the mint, so this is the map at
1178 /// the end read off the other side, and the two together are every value a declaration is
1179 /// behind.
1180 ///
1181 /// The map on its own would not do, which is why `new_reg` writes down what it writes down: the
1182 /// entry for a constant is cleared every time the walk leaves the block that wrote it, so a
1183 /// local a constant holds is in the map for one block of the function and nowhere else.
1184 fn naming(&mut self) {
1185 let mut named = std::mem::take(&mut self.out.named);
1186 for value in self.source.values() {
1187 let Some(reg) = self.regs[value.index()] else { continue };
1188 named.extend(self.source.value_decls(value).map(|decl| (decl, reg)));
1189 // A start in a block a pass took out was never reached above, and it says nothing
1190 // rather than something about another place.
1191 for start in self.source.value_starts(value) {
1192 let Some((block, after)) = self.source.start_place(start) else { continue };
1193 let first = self.marks.get(&block).and_then(|marks| {
1194 marks.iter().find(|&&(have, _)| have == after).and_then(|&(_, at)| at)
1195 });
1196 if let Some(first) = first {
1197 self.out.starts.push((start.decl, reg, first));
1198 }
1199 }
1200 }
1201 named.sort_unstable();
1202 named.dedup();
1203 self.out.named = named;
1204 self.out.starts.sort_unstable();
1205 self.out.starts.dedup();
1206 // Which of its values a declaration holds on the way into a block, for the blocks where
1207 // two of them are live at once. A block a pass took out says nothing, and neither does a
1208 // value the map above has lost the register of, since that is not the same as having none.
1209 // Only for a build that writes debugging information, since that is all that reads it,
1210 // and on a function of tens of thousands of blocks it is a walk of all of them for every
1211 // local.
1212 let mut entries = Vec::new();
1213 let held = if self.debug { crate::holding::on_entry(self.source) } else { Vec::new() };
1214 for (decl, block, value) in held {
1215 if let (Some(block), Some(reg)) = (self.blocks[block.index()], self.regs[value.index()])
1216 {
1217 entries.push((decl, block, reg));
1218 }
1219 }
1220 entries.sort_unstable();
1221 entries.dedup();
1222 self.out.entries = entries;
1223 }
1224
1225 /// The order the blocks are filled in, which is not the order they are written in.
1226 ///
1227 /// Reverse postorder, because a value is written in a block that dominates every block that
1228 /// reads it and a block in reverse postorder comes before every block it dominates. The order
1229 /// the blocks are written in does not have that property: a block written early can read a
1230 /// value a block below it writes, and reading a value with no register yet mints one, so the
1231 /// register the definition writes later is not the register the read named. Nothing writes the
1232 /// one the read named, and what comes out is a function that loads a stack slot no store ever
1233 /// reached. It is the order this walk goes in rather than the order the blocks come out in,
1234 /// which is what the loop above fixes, so the machine function is still written the way the IR
1235 /// function was.
1236 ///
1237 /// Blocks the entry does not reach come last, in the order they are written in. Nothing runs
1238 /// them and nothing they name is read by anything that does, but they still have to be filled,
1239 /// because a machine block with no terminator is not one the passes below can read.
1240 fn order(&self) -> Vec<Block> {
1241 let Some(entry) = self.source.entry() else { return self.source.blocks().collect() };
1242 let count = self.blocks.len();
1243 let mut succs: Vec<Vec<Block>> = vec![Vec::new(); count];
1244 for block in self.source.blocks() {
1245 let Some(term) = self.source.terminator(block) else { continue };
1246 succs[block.index()] = self.source.successors(term).map(|call| call.block).collect();
1247 }
1248 // An explicit stack, because the depth of the walk is the number of blocks and a function
1249 // built by a generator has as many of those as it likes.
1250 let mut seen = vec![false; count];
1251 let mut order = Vec::with_capacity(count);
1252 let mut stack = vec![(entry, 0usize)];
1253 seen[entry.index()] = true;
1254 while let Some((block, at)) = stack.pop() {
1255 let Some(&next) = succs[block.index()].get(at) else {
1256 order.push(block);
1257 continue;
1258 };
1259 stack.push((block, at + 1));
1260 if !seen[next.index()] {
1261 seen[next.index()] = true;
1262 stack.push((next, 0));
1263 }
1264 }
1265 order.reverse();
1266 order.extend(self.source.blocks().filter(|block| !seen[block.index()]));
1267 order
1268 }
1269
1270 /// One block: its parameters, then every instruction in it that is not folded into another.
1271 fn block(&mut self, block: Block) -> Result<(), Unsupported> {
1272 let out = self.out_block(block);
1273 self.at = Some(out);
1274 if self.source.entry() == Some(block) {
1275 self.arrive(block, out)?;
1276 } else {
1277 let mut arriving = Vec::new();
1278 for ¶m in &self.source[block].params {
1279 // A value with no register to arrive in, which the class would not say, since
1280 // `class_of` puts one of these in the general purpose file on purpose and what it
1281 // means by that is that nothing there can hold it. What crosses the edge for one
1282 // of those is the address of where the value already is, so the parameter is a
1283 // pointer here and the bytes it points at are copied below.
1284 let ty = self.source[param].ty;
1285 let reg = self.out.append_param(out, self.class_of(ty));
1286 self.sized(reg, ty);
1287 self.regs[param.index()] = Some(reg);
1288 if on_x87(ty) {
1289 arriving.push((param, reg));
1290 }
1291 }
1292 self.settle(block, &arriving)?;
1293 }
1294 let kept = self.pad(block)?;
1295
1296 // What each instruction matched, and which instructions were folded into another. The
1297 // decision is made for the whole block before any of it is written, and it is made more
1298 // than once: a value that only some of its readers took has to be put back in a register
1299 // for all of them, and taking it away from those readers changes what they match.
1300 let insts: Vec<Inst> = self.source.insts(block).collect();
1301 let mut refused: HashSet<Value> = HashSet::new();
1302 let mut decided = self.decide(&insts, &refused);
1303 while let Some(value) = self.left_alive(&insts, &decided.plans) {
1304 refused.insert(value);
1305 decided = self.decide(&insts, &refused);
1306 }
1307 let Decided { found, folded, .. } = decided;
1308
1309 // Where each assignment in this block that starts a declaration on a value is, as the
1310 // machine instruction in front of the place its IR instruction left off, or the block
1311 // for one where nothing has been written yet. What comes after it is not known until the
1312 // block is filled, so that is read below.
1313 let wanted: HashSet<Option<Inst>> =
1314 self.marks.get(&block).into_iter().flatten().map(|&(after, _)| after).collect();
1315 let mut reached: Vec<(Option<Inst>, mir::Block, Option<mir::Inst>)> = Vec::new();
1316 for (index, (&inst, matched)) in insts.iter().zip(found).enumerate() {
1317 let before = index.checked_sub(1).map(|index| insts[index]);
1318 if wanted.contains(&before) {
1319 let at = self.at.unwrap_or(out);
1320 reached.push((before, at, self.out.terminator(at)));
1321 }
1322 if folded.contains(&inst) || self.writes_nothing(inst) {
1323 continue;
1324 }
1325 // A call is built from the convention rather than matched, which is why it is the one
1326 // opcode looked at by name here. Through an address it is a different instruction and
1327 // the same convention, so the two arrive at the same place and differ in one line of
1328 // it.
1329 match self.source[inst].opcode {
1330 Opcode::Call | Opcode::CallIndirect => {
1331 self.called(inst)?;
1332 continue;
1333 }
1334 // The exception a landing pad was entered with, which the unwinder left in the
1335 // first return register. Built by name for the reason a named register is.
1336 Opcode::Landing => {
1337 self.landing(inst)?;
1338 continue;
1339 }
1340 // A call and the return behind it, which is what `crate::tail::mark` made it out
1341 // of, and both are built the way they would have been. What makes it a jump is
1342 // written at the very end, once the epilogue is there to jump from.
1343 Opcode::TailCall => {
1344 self.tail_called(inst)?;
1345 continue;
1346 }
1347 // Built from the frame rather than matched, for the same shape of reason a call
1348 // is built from the convention: what a rule replaces a term with is instructions,
1349 // and what an `alloca` needs first is bytes, which the rule language has no way
1350 // to ask for.
1351 Opcode::Alloca => {
1352 self.reserve(inst)?;
1353 continue;
1354 }
1355 // Reading the stack pointer and writing it back, which are the two ends of a scope
1356 // holding a variable length array. Built here for the reason an `alloca` is: the
1357 // value is a register the rule language has no way to name, because what it holds
1358 // is not a value the program computed but where the machine's stack had got to.
1359 // The arguments the function was handed, saved in the prologue, and a call made
1360 // out of them. Built here because neither is a value a rule could say anything
1361 // about: the first is a place in the frame and the second is a call, whose
1362 // arguments are a block of registers rather than values.
1363 Opcode::ApplyArgs => {
1364 self.apply_args(inst)?;
1365 continue;
1366 }
1367 Opcode::Apply => {
1368 self.apply(inst)?;
1369 continue;
1370 }
1371 Opcode::StackSave => {
1372 self.stack_pointer(inst, false)?;
1373 continue;
1374 }
1375 Opcode::StackRestore => {
1376 self.stack_pointer(inst, true)?;
1377 continue;
1378 }
1379 // The address of a name, built here for the same reason an `alloca` is: what a
1380 // rule replaces a term with is instructions over values, and the operand of this
1381 // one is a symbol, which is a thing the rule language has no way to bind and the
1382 // solver has no way to say anything about. There is nothing in `lea sym(%rip)` a
1383 // proof over bitvectors could discharge, because what makes it the right answer
1384 // is the relocation and what the linker does with it.
1385 Opcode::GlobalAddr => {
1386 self.address_of(inst)?;
1387 continue;
1388 }
1389 // The address of a label and the branch that reads one, built here for the same
1390 // reason and for one more. The reason is the same: what the first of them names is
1391 // a block, which is not a value a rule pattern can bind, and there is nothing in
1392 // the distance between two places in one function that a proof over bitvectors
1393 // could discharge. The extra one is that the second is a terminator whose arms are
1394 // not two and not fixed, and a rule says what an instruction reads rather than
1395 // where a block goes.
1396 Opcode::BlockAddr => {
1397 self.block_address(inst)?;
1398 continue;
1399 }
1400 Opcode::IndirectBr => {
1401 self.indirect_branch(inst)?;
1402 continue;
1403 }
1404 // A `switch` that `crate::switch` found dense enough for a table, which is a load
1405 // out of the table and the same jump. Built here for the reasons the jump above
1406 // is, and because what the load reads is a place in this function.
1407 Opcode::Switch => {
1408 self.jump_table(inst)?;
1409 continue;
1410 }
1411 // The pair that saves a place in this function and comes back to it. Built here
1412 // for the reason the address of a label is, and for two more. The reason is the
1413 // same: the first of them writes down where control comes back to, which is a
1414 // place in this function and not a value a rule pattern can bind. The extra ones
1415 // are that each of them is a group of instructions over a buffer the program owns
1416 // rather than one instruction, and that the first of them leaves the block it was
1417 // written in and carries on in a new one, which is a thing no rule can do.
1418 Opcode::SetjmpMarker => {
1419 self.saves_place(inst)?;
1420 continue;
1421 }
1422 Opcode::LongjmpMarker => {
1423 self.comes_back(inst)?;
1424 continue;
1425 }
1426 // Where this thread's own storage starts, built here for a reason of the same
1427 // shape: what it reads is `%fs`, which is not a register the rule language can
1428 // bind and not one a proof over bitvectors could say anything about, because what
1429 // makes the load the right answer is an agreement between the loader and the C
1430 // library rather than any arithmetic.
1431 Opcode::ThreadPointer => {
1432 self.thread_pointer(inst)?;
1433 continue;
1434 }
1435 // Where the stack pointer was on entry, built here because it is an address in
1436 // the caller's argument area, which only the frame knows the distance to.
1437 Opcode::SpEntry => {
1438 self.sp_entry(inst)?;
1439 continue;
1440 }
1441 // What a named machine register holds, built here for the reason above written
1442 // about any register rather than about one: which register it is is a string
1443 // beside the instruction, and a rule matches on an opcode and a type and could
1444 // not see it. There is nothing to prove either, since the answer is the register
1445 // and the instruction is the move that reads it.
1446 Opcode::RegisterValue => {
1447 self.register_value(inst)?;
1448 continue;
1449 }
1450 // Where a frame is and what it returns to, built here for the same reason and one
1451 // more. The reason is the same: what the walk starts from is the frame pointer,
1452 // which is not a register a rule pattern can bind, and there is nothing in reading
1453 // the link the prologue saved that a proof over bitvectors could discharge. The
1454 // extra one is that how long the walk is comes out of a number beside the
1455 // instruction, so one of these is not one instruction but however many the depth
1456 // says, and a rule replaces a term with a term.
1457 Opcode::FrameAddress | Opcode::ReturnAddress => {
1458 self.frames(inst)?;
1459 continue;
1460 }
1461 // Built from the frame for the reason an `alloca` is, and from the convention for
1462 // the reason a call is: three of the four fields it writes are distances that do
1463 // not exist until the frame does, and the fourth is where the walk over the
1464 // argument registers stopped. A function that is not variadic has no such walk to
1465 // report, so it has nothing here and is refused below, which is the right answer
1466 // for a `va_start` in one.
1467 Opcode::VaStart if self.varargs.is_some() => {
1468 self.va_start(inst)?;
1469 continue;
1470 }
1471 // A return of more than one value, which is a structure small enough to come
1472 // back in a pair of registers. Built from the convention for the reason a call
1473 // is: which register each half goes in depends on the halves in front of it,
1474 // because the two register files are walked separately, and a pattern over a term
1475 // cannot see them. A return of one value is a term with a name and a rule, and it
1476 // stays one.
1477 //
1478 // A return of none in a function whose answer went through memory is here too,
1479 // and for a different reason: what it gives back is not written in the IR at all.
1480 // The convention says the address the caller handed over comes back, and only the
1481 // signature says this function was handed one.
1482 //
1483 // And a return of one eighty bit value, for a third reason: what a rule would
1484 // write is an instruction leaving the value in a register, and this one is left on
1485 // the x87 stack instead. A rule could not name that stack any more than any other
1486 // rule about this type could.
1487 //
1488 // And a return the convention asks this side to extend, which a rule has no way to
1489 // know about since the signature is what says so and not the value.
1490 Opcode::Return
1491 if self.source[self.source[inst].args].len() > 1
1492 || self.sret().is_some()
1493 || self.gives_back_x87(inst)
1494 || self.widens_return() =>
1495 {
1496 let values = self.source[self.source[inst].args].to_vec();
1497 self.returned(inst, values)?;
1498 continue;
1499 }
1500 // A cast between a pointer and an integer of the same width, which on this
1501 // machine is every one the front end writes. No instruction at all, so no rule
1502 // could name one.
1503 Opcode::PtrToInt | Opcode::IntToPtr => {
1504 self.rename(inst)?;
1505 continue;
1506 }
1507 // A barrier, which is one instruction or none depending on the ordering. Written
1508 // by name because there is nothing about it a rule could be proved against, the
1509 // way there is nothing to prove about the address of a symbol.
1510 Opcode::Fence => {
1511 self.barrier(inst)?;
1512 continue;
1513 }
1514 // An ordered load or store that `crate::expand::orderings` left alone, which on a
1515 // machine that is not total store order is every one stronger than relaxed. Written
1516 // by name for the barrier's reason: what it adds to the plain access is an ordering.
1517 Opcode::AtomicLoad | Opcode::AtomicStore if self.on_aarch64() => {
1518 self.ordered(inst)?;
1519 continue;
1520 }
1521 // A hint, written by name for the reason a barrier is and one step further: not
1522 // only is there no equality for a proof to discharge, there is nothing about the
1523 // program around it either. Which of the four instructions it is comes out of the
1524 // number the builtin was given, which is beside the instruction rather than in it.
1525 Opcode::Prefetch => {
1526 self.hint(inst)?;
1527 continue;
1528 }
1529 // Stopping, written by name for the first half of the barrier's reason: it
1530 // computes nothing, so there is no term for a rule to replace, and what makes it
1531 // right is what the operating system does with the fault rather than anything a
1532 // proof over bitvectors could discharge.
1533 Opcode::Trap => {
1534 self.trap(inst);
1535 continue;
1536 }
1537 // A compare and exchange, which is written by name because it produces two values
1538 // and a rule produces one. The replacement of a rule is one term, a term names the
1539 // value an instruction computes, and there is no way in that language to say that
1540 // an instruction leaves an answer in one place and a yes or no in another.
1541 Opcode::Cmpxchg => {
1542 self.exchange(inst)?;
1543 continue;
1544 }
1545 // A read modify write, which is written by name for a different reason: it produces
1546 // one value, so a rule could name it, and what it does is not in the head a rule
1547 // matches on. Every one of the thirteen operations is the same opcode at the same
1548 // type and differs only in what is carried beside it, so one pattern would be all
1549 // thirteen patterns. Of the thirteen only the three with an instruction reach here,
1550 // since `crate::retry` turned the rest into loops a long way above this.
1551 Opcode::AtomicRmw => {
1552 self.modify(inst)?;
1553 continue;
1554 }
1555 // An `asm` statement, whose lowering is its template and there is no term for a
1556 // string. Written by name for the reason a barrier is, and before the x87 arm
1557 // below so that an `asm` holding a `long double` is refused as the `asm` it is
1558 // rather than as an instruction nothing computes.
1559 Opcode::InlineAsm => {
1560 // The template is read as x86 assembly, and that reader is the only one there
1561 // is. AArch64 keeps every template as text, and any other machine's `asm` is
1562 // refused here rather than read as the wrong language.
1563 if self.on_aarch64() {
1564 self.spelled(inst)?;
1565 continue;
1566 }
1567 if !std::ptr::eq(self.selector.shapes, &x86_64::MACHINE) {
1568 return Err(self.unsupported(inst));
1569 }
1570 if self.touches_x87(inst) {
1571 self.x87_assembly(inst)?;
1572 continue;
1573 }
1574 self.assembly(inst)?;
1575 continue;
1576 }
1577 // Anything at all with an eighty bit float in it, which is the one arm here
1578 // chosen by a type rather than by an opcode, because what makes these different
1579 // is not what they do but where the value is. A `long double` has no register,
1580 // so it has no name in `crate::term` and no rule could bind one: every one of
1581 // these is a group of instructions over a frame slot, written out below.
1582 //
1583 // Last of the arms, so that a call and a return with one of these in them reach
1584 // the convention first and are refused by it, which is the truer answer: what is
1585 // wrong there is where the value has to travel and not that nothing can compute
1586 // it.
1587 _ if self.touches_x87(inst) => {
1588 self.x87(inst)?;
1589 continue;
1590 }
1591 _ => {}
1592 }
1593 let matched = matched.ok_or_else(|| self.unsupported(inst))?;
1594 self.emit(inst, &matched)?;
1595 // After it is built rather than when it matched, so that what is recorded is the rules
1596 // this function was lowered by and not the rules something was tried with.
1597 self.fired.mark(matched.rule);
1598 }
1599 // Whichever block the walk ended in rather than the one it started in. The two are the
1600 // same block for every function that does not save a place for a `__builtin_longjmp`, and
1601 // where they differ it is the last of them that the terminator and the arms belong to.
1602 // See [`Self::saves_place`].
1603 let last = self.at.expect("a block is being filled");
1604 self.edges(block, last)?;
1605 for (value, reg) in kept {
1606 self.regs[value.index()] = reg;
1607 }
1608 // Now that the block is filled, the instruction after each place an assignment was is the
1609 // first one it holds its value at. One with nothing after it, which a block ending in the
1610 // assignment would be, stays unanswered.
1611 if let Some(marks) = self.marks.get_mut(&block) {
1612 for &(before, at, last) in &reached {
1613 let first = match last {
1614 Some(last) => self.out.next_inst(last),
1615 None => self.out.insts(at).next(),
1616 };
1617 for mark in marks.iter_mut().filter(|(after, _)| *after == before) {
1618 mark.1 = first;
1619 }
1620 }
1621 }
1622 Ok(())
1623 }
1624
1625 /// One call, which is built from the convention rather than matched against the table for the
1626 /// same reason the arguments of the function itself are.
1627 ///
1628 /// The arguments are read before the call is built, which is what materializes a constant
1629 /// argument into a register, since no call passes an immediate.
1630 ///
1631 /// A call to a name and a call through an address are both here, and what tells them apart is
1632 /// the opcode rather than whether a callee was recorded, which is the same thing the verifier
1633 /// reads. Through an address the first operand is the address and the arguments are the ones
1634 /// behind it, and everything after that is the same: where each argument goes, where the value
1635 /// comes back and which registers are gone across it are the convention's answers and the
1636 /// convention does not ask what is being called.
1637 fn called(&mut self, inst: Inst) -> Result<u32, Unsupported> {
1638 let data = &self.source[inst];
1639 let Extra::Call(info) = data.extra else { return Err(self.unsupported(inst)) };
1640 let info = self.source[info];
1641 let indirect = data.opcode == Opcode::CallIndirect;
1642
1643 let values: Vec<Value> = self.source[data.args].to_vec();
1644 let callee = if indirect {
1645 let &address = values.first().ok_or_else(|| self.unsupported(inst))?;
1646 abi::Callee::Through(self.reg_of(address)?)
1647 } else {
1648 let symbol = info.callee.ok_or_else(|| self.unsupported(inst))?;
1649 // A function a declaration said is in a DLL is called through the pointer the loader
1650 // fills in, which is what gcc writes at `-O0`: the pointer into a register and a call
1651 // through the register. gcc at `-O2` and clang call through the pointer in memory,
1652 // which is one instruction shorter and the same call.
1653 match self.elsewhere.slot(symbol) {
1654 Some(slot) => {
1655 let reg = self.out.new_vreg(self.gpr);
1656 self.through_slot(inst, slot, symbol, reg)?;
1657 abi::Callee::Through(reg)
1658 }
1659 None => abi::Callee::Named(symbol),
1660 }
1661 };
1662
1663 // What the ABI asks of each argument, read out before any of them is, because reading one
1664 // borrows the function this is a table in. The ones the signature names are the signature's
1665 // answer and the ones behind them are the call's, which is where a structure passed to a
1666 // variadic callee by value says that its bytes travel: there is no parameter to say it on.
1667 let signature = &self.source[info.signature];
1668 let variadic = signature.variadic;
1669 let named: Vec<Abi> = signature.params.iter().map(|param| param.abi).collect();
1670 let beyond: Vec<Abi> = self.source[info.varargs].to_vec();
1671 // Every value that comes back and not only the first. A structure small enough to travel
1672 // in registers comes back in up to two of them, and which register each half is in is the
1673 // convention's answer, which is why the whole list goes to the same place the arguments do
1674 // rather than to a rule.
1675 let returns: Vec<Type> = signature.return_types().collect();
1676
1677 let mut args = Vec::with_capacity(values.len());
1678 for (index, value) in values.into_iter().skip(usize::from(indirect)).enumerate() {
1679 let abi = named.get(index).or_else(|| beyond.get(index - named.len()));
1680 let abi = abi.copied().unwrap_or_default();
1681 let ty = self.source[value].ty;
1682 // What travels for an eighty bit value is its bytes, so what the call is handed is
1683 // where they are rather than a register they are in, and there is no register they
1684 // could be in. Everything else about it is a sixteen byte object passed by value and
1685 // is built by the same code.
1686 let reg =
1687 if abi::on_the_stack(ty) { self.x87_slot(value) } else { self.reg_of(value)? };
1688 args.push(abi::Passing { ty, reg, abi });
1689 }
1690 let block = self.at.expect("a block is being filled");
1691 let what = abi::Calling {
1692 callee,
1693 args: &args,
1694 returns: &returns,
1695 variadic,
1696 named: named.len(),
1697 at: self.source.span(inst),
1698 };
1699 // The callee's convention and not this function's, since the two differ when either was
1700 // written `ms_abi` or `sysv_abi`: where the arguments go, what the callee leaves alone and
1701 // how much room it is owed above the return address are all the callee's to say, and a
1702 // function of one convention calls functions of the other.
1703 let called = self.source[info.signature].convention;
1704 let conv = self
1705 .conv
1706 .under(called)
1707 .ok_or(Unsupported::Unported { inst: Some(inst), what: Unported::Convention })?;
1708 let made = abi::call(&mut self.out, block, &what, conv, self.selector.abi, self.names)
1709 .map_err(|refused| Unsupported::Call { inst, refused })?;
1710 if self.source.unwinds_to_pad(inst) {
1711 let call = self.out.insts(block).last().expect("the call just built");
1712 self.unwinding.insert(inst, call);
1713 }
1714 let calls = &mut self.stack.calls;
1715 *calls = Some(calls.unwrap_or(0).max(made.outgoing));
1716 // An eighty bit value came back on the x87 stack, and the one thing that has to happen
1717 // before anything else touches that stack is taking it off. So the `fstp` goes here, in
1718 // front of everything the block does next, and after it the value is in its slot and is
1719 // read the way every other one is. A complex one is two of them, the real half on top, so
1720 // taking them off in order leaves each in its own slot and the stack empty.
1721 let results: Vec<Value> = self.source[inst].results().collect();
1722 let types: Vec<Type> = results.iter().map(|&result| self.source[result].ty).collect();
1723 if abi::back_on_x87(&types) {
1724 let span = self.source.span(inst);
1725 for result in results {
1726 let into = self.x87_slot(result);
1727 let into = self.through(into);
1728 self.x87_at("fstp_t", span, into);
1729 }
1730 return Ok(made.outgoing);
1731 }
1732 for (result, ®) in results.into_iter().zip(&made.results) {
1733 self.sized(reg, self.source[result].ty);
1734 self.regs[result.index()] = Some(reg);
1735 }
1736 Ok(made.outgoing)
1737 }
1738
1739 /// One `tail_call`, as the call and a return of what it gave back.
1740 ///
1741 /// The call is written down for [`crate::tail::jumps`] when it can be made after the frame is
1742 /// gone. That is when it put nothing in the argument area, which is the bottom of this frame,
1743 /// and when the answer comes back in registers, since one on the x87 stack is taken off and put
1744 /// back by instructions after the call. A call that is not written down stays a call and a
1745 /// return, which is what the IR said before `crate::tail::mark` read it.
1746 fn tail_called(&mut self, inst: Inst) -> Result<(), Unsupported> {
1747 let outgoing = self.called(inst)?;
1748 let block = self.at.expect("a block is being filled");
1749 let call = self.out.insts(block).last().expect("the call just built");
1750 let values: Vec<Value> = self.source[inst].results().collect();
1751 let x87 = self.x87_values(&values);
1752 self.returned(inst, values)?;
1753 if outgoing == 0 && !x87 && self.sret().is_none() {
1754 let returns = self.out.insts(block).skip_while(|&at| at != call).skip(1).collect();
1755 self.stack.tails.push(crate::tail::Tail { call, returns });
1756 }
1757 Ok(())
1758 }
1759
1760 /// The pointer a function returning through memory was handed, or nothing in a function that
1761 /// was not.
1762 ///
1763 /// It is the first parameter and the signature is what says so, since in the IR it is an
1764 /// ordinary pointer and reads like one everywhere in the body. A function with a signature
1765 /// like that and no entry block has nothing to give back and no body to give it back from.
1766 fn sret(&self) -> Option<Value> {
1767 let first = self.source.signature().params.first()?;
1768 if !matches!(first.abi, Abi::Sret { .. }) {
1769 return None;
1770 }
1771 self.source[self.source.entry()?].params.first().copied()
1772 }
1773
1774 /// One `return` the convention has to write, as the place each value has to be in by the end.
1775 ///
1776 /// One pseudo per value, each a read constrained to a return register, which is what a return
1777 /// of one value already is and is the whole of what either does. The `ret` itself comes from
1778 /// the epilogue for both, long after this, because the frame has to be given back first.
1779 ///
1780 /// The two register files are counted separately, so a structure of a `double` and a `long`
1781 /// leaves the `double` in the first vector register and the `long` in the first integer one
1782 /// rather than in the second of either. That is the same walk `rucc_codegen::abi` makes on
1783 /// the other side of the call, which is what makes the two ends agree.
1784 ///
1785 /// A function whose answer went through memory gives back the address it was handed, in front
1786 /// of nothing else, because a signature that returns that way returns nothing else. That the
1787 /// caller already knows the address is not enough: it is allowed to read the register instead,
1788 /// and a caller that does gets whatever the allocator last left there. In a leaf function that
1789 /// is usually the right answer by accident, and one call in the body is enough to make it a
1790 /// wild pointer, which is why this is written rather than left to luck.
1791 ///
1792 /// Where everything goes is worked out before anything is written, so a return this cannot
1793 /// make leaves no half of one behind.
1794 /// Whether a value this function gives back has to be extended first, which is Apple's arm64
1795 /// asking the callee to fill the 32 bits above a `char` or a `short` by its sign.
1796 fn widens_return(&self) -> bool {
1797 let returns = &self.source.signature().returns;
1798 returns.iter().any(|it| (self.selector.abi.extend)(it.ty, it.abi).is_some())
1799 }
1800
1801 /// Whether what a `return` gives back goes back on the x87 stack, per [`abi::back_on_x87`].
1802 fn gives_back_x87(&self, inst: Inst) -> bool {
1803 self.x87_values(&self.source[self.source[inst].args])
1804 }
1805
1806 /// Whether those values go back on the x87 stack, per [`abi::back_on_x87`].
1807 fn x87_values(&self, values: &[Value]) -> bool {
1808 let types: Vec<Type> = values.iter().map(|&value| self.source[value].ty).collect();
1809 abi::back_on_x87(&types)
1810 }
1811
1812 fn returned(&mut self, inst: Inst, values: Vec<Value>) -> Result<(), Unsupported> {
1813 let (mut ints, mut floats) = (0usize, 0usize);
1814 let mut parts = Vec::with_capacity(values.len() + 1);
1815 // An eighty bit value goes back on the x87 stack, which is where the convention says it is
1816 // and is the one place a value is left rather than put in a register. So the whole of the
1817 // return is an `fld` of its slot, and the stack it leaves the value on is not empty at the
1818 // `ret`, which is the one time in this file that is true and is what the convention asks
1819 // for. What comes after is the epilogue, which gives the frame back and touches nothing in
1820 // the unit. A complex one loads its imaginary half first so that the real half ends up on
1821 // top of it, in `st(0)`, with the imaginary half under it in `st(1)`.
1822 if self.x87_values(&values) && self.sret().is_none() {
1823 let span = self.source.span(inst);
1824 for &value in values.iter().rev() {
1825 let from = self.x87_slot(value);
1826 let from = self.through(from);
1827 self.x87_at("fld_t", span, from);
1828 }
1829 return Ok(());
1830 }
1831 // What the signature says about the bits above a narrow one, which on an ABI that extends
1832 // it is an obligation of this side: the caller reads the whole of the 32 bit register.
1833 let asked: Vec<Abi> = self.source.signature().returns.iter().map(|it| it.abi).collect();
1834 let asked = asked.into_iter().chain(std::iter::repeat(Abi::Plain));
1835 let sret = self.sret().map(|value| (value, Abi::Plain));
1836 for (value, abi) in sret.into_iter().chain(values.into_iter().zip(asked)) {
1837 let ty = self.source[value].ty;
1838 let at = if crate::term::in_vector_file(ty) { &mut floats } else { &mut ints };
1839 // Why it cannot come back, and not only that it cannot. A type that travels nowhere
1840 // says so itself, and a type that travels perfectly well ran out of registers.
1841 let missing = abi::refuses(ty, self.selector.abi).unwrap_or(Missing::NoRoom);
1842 let name =
1843 (self.selector.abi.ret)(ty, *at).ok_or(Unsupported::Returned { inst, missing })?;
1844 *at += 1;
1845 // The register is the target's answer and not one worked out here, the same as it is
1846 // for a return of one value, so that both halves of a pair and every rule that writes
1847 // half of one are reading the same table.
1848 let opcode =
1849 name.strip_prefix(self.selector.prefix()).ok_or_else(|| self.unsupported(inst))?;
1850 let descs = self.selector.operands(opcode).ok_or_else(|| self.unsupported(inst))?;
1851 let [desc] = descs else { return Err(self.unsupported(inst)) };
1852 let widen = (self.selector.abi.extend)(ty, abi).map(|name| self.names.intern(name));
1853 parts.push((self.names.intern(name), self.reg_of(value)?, *desc, widen));
1854 }
1855
1856 let block = self.at.expect("a block is being filled");
1857 let span = self.source.span(inst);
1858 for (opcode, mut reg, desc, widen) in parts {
1859 if let Some(widen) = widen {
1860 let wide = self.out.new_vreg(desc.class);
1861 let build = self.out.build(block, mir::Opcode::new(widen)).at(span);
1862 build.def(wide, desc.class).uses(reg, desc.class).finish();
1863 reg = wide;
1864 }
1865 let operand = mir::Operand {
1866 reg,
1867 class: desc.class,
1868 role: desc.role,
1869 constraint: desc.constraint,
1870 };
1871 self.out.build(block, mir::Opcode::new(opcode)).at(span).operand(operand).finish();
1872 }
1873 Ok(())
1874 }
1875
1876 /// One `alloca`: the bytes it asks for go on the list the frame is laid out from, and the
1877 /// address of them is one instruction.
1878 ///
1879 /// The instruction is a `lea` off the stack pointer, which is the one register that reaches
1880 /// the frame in every function, and its displacement is left at nothing because there is no
1881 /// frame yet. Which instruction is waiting for which local is remembered, and
1882 /// [`crate::finish`] fills the numbers in after [`crate::frame::Frame`] has placed them.
1883 ///
1884 /// There is deliberately no rule for `alloca` and no name for one in [`crate::term`], and
1885 /// that is what stops it being folded into something else. An operand shown as the
1886 /// instruction that computed it is offered to the matcher by its name, so an `alloca` with no
1887 /// name is one no pattern can reach past, and the address it computes is always in a register
1888 /// by the time anything reads it.
1889 fn reserve(&mut self, inst: Inst) -> Result<(), Unsupported> {
1890 let data = &self.source[inst];
1891 // A variable length array carries the size it wants as an operand rather than in the
1892 // instruction, which is the whole of what tells the two apart here.
1893 if let Some(&size) = self.source[data.args].first() {
1894 return self.grow(inst, size);
1895 }
1896 let Extra::Mem(mem) = data.extra else { return Err(self.unsupported(inst)) };
1897 let info = self.source[mem];
1898 let size = u32::try_from(info.size)
1899 .map_err(|_| Unsupported::Dynamic { inst, growing: Growing::Huge })?;
1900 let result = data.first_result.ok_or_else(|| self.unsupported(inst))?;
1901
1902 // At least one, because the frame divides by the alignment and an object with no
1903 // alignment at all is one the front end had nothing to say about rather than one that may
1904 // go anywhere.
1905 let index = self.stack.locals.len();
1906 self.stack.locals.push(Local { size, align: info.align.max(1) });
1907 if let Some(decl) = self.source.mem_decl(mem) {
1908 self.stack.declared.push((index, decl));
1909 }
1910
1911 let block = self.at.expect("a block is being filled");
1912 let reg = self.new_reg(result);
1913 let span = self.source.span(inst);
1914 let lea = self.named(self.selector.frame.lea);
1915 let sp = mir::Operand::read(mir::Reg::physical(self.conv.stack_pointer), self.gpr);
1916 let made =
1917 self.out.build(block, lea).at(span).def(reg, self.gpr).mem(mir::Mem::at(sp)).finish();
1918 self.stack.addresses.push((made, index));
1919 self.frame_slots.insert(result, index);
1920 Ok(())
1921 }
1922
1923 /// The other kind of `alloca`: one whose size the function does not know until it runs, which
1924 /// is what a variable length array is.
1925 ///
1926 /// Nothing about it is a slot the frame laid out, because the frame is laid out once and this
1927 /// happens as often as control reaches the declaration. The bytes come off the stack pointer
1928 /// where the declaration stands, which is two instructions:
1929 ///
1930 /// ```text
1931 /// sub sp, bytes the stack pointer moves down over the memory, which is what takes it
1932 /// lea reg, [sp+n] where the memory starts, which is above the outgoing argument area
1933 /// ```
1934 ///
1935 /// The displacement is left at nothing for the reason the constant kind leaves its own at
1936 /// nothing, and for a different number: that area belongs to the arguments of whatever this
1937 /// function calls, it stays at the bottom of the frame wherever the bottom has moved to, and
1938 /// how big it is is not known until every call in the function has been seen.
1939 ///
1940 /// The bytes are already a multiple of the stack pointer's alignment by the time they arrive,
1941 /// because [`crate::expand::rounds`] rounded them up in the IR, so nothing here has to mask the
1942 /// stack pointer afterwards and the stack pointer stays somewhere a call can be made from.
1943 ///
1944 /// Two instructions here and not always two in the finished function. On a command line that
1945 /// asked for the stack to be touched a page at a time, the subtraction becomes a loop that
1946 /// walks the same distance a page at a time, which [`crate::finish`] writes. That is why the
1947 /// instruction is written down in [`Stack::grown`] as well as left where it is.
1948 ///
1949 /// An array wanting more alignment than the convention leaves the stack pointer with does not
1950 /// reach here asking for it: [`crate::expand::rounds`] gives it the alignment in extra bytes
1951 /// and turns the array into a `ptr_add` of the offset that lands inside them, so what arrives
1952 /// is a block asking for the convention's alignment like any other. The refusal below is what
1953 /// answers IR that came from somewhere other than that pass, since forcing the alignment here
1954 /// would be a second rounding of a register the frame already rounded, and after it no
1955 /// constant reaches the rest of the frame from anywhere. See `Growing` in [`crate::frame`].
1956 fn grow(&mut self, inst: Inst, size: Value) -> Result<(), Unsupported> {
1957 let data = &self.source[inst];
1958 let Extra::Mem(mem) = data.extra else { return Err(self.unsupported(inst)) };
1959 let info = self.source[mem];
1960 if info.align > self.conv.stack_align {
1961 return Err(Unsupported::Dynamic { inst, growing: Growing::Aligned });
1962 }
1963 let result = data.first_result.ok_or_else(|| self.unsupported(inst))?;
1964 let bytes = self.reg_of(size)?;
1965
1966 let block = self.at.expect("a block is being filled");
1967 let span = self.source.span(inst);
1968 let stack = mir::Reg::physical(self.conv.stack_pointer);
1969 let grow = self.named(self.selector.frame.grow);
1970 let took = self
1971 .out
1972 .build(block, grow)
1973 .at(span)
1974 .operand(mir::Operand::write(stack, self.gpr))
1975 .operand(mir::Operand::read(stack, self.gpr))
1976 .operand(mir::Operand::read(bytes, self.gpr))
1977 .finish();
1978 self.stack.grown.push(took);
1979
1980 let reg = self.new_reg(result);
1981 let lea = self.named(self.selector.frame.lea);
1982 let sp = mir::Operand::read(stack, self.gpr);
1983 let made =
1984 self.out.build(block, lea).at(span).def(reg, self.gpr).mem(mir::Mem::at(sp)).finish();
1985 self.stack.dynamic.push(made);
1986 self.stack.grown_at.get_or_insert(inst);
1987 Ok(())
1988 }
1989
1990 /// Where the stack pointer is, kept so that something later can put it back.
1991 ///
1992 /// One move out of the stack pointer and one move into it, which is the whole of what the two
1993 /// halves are. What makes them worth writing is where the front end puts them: a scope holding
1994 /// a variable length array saves the stack pointer as it opens and puts it back as it closes,
1995 /// so a loop declaring one takes its bytes once round rather than once per iteration, and a
1996 /// jump out of the scope gives the bytes back on the way out.
1997 ///
1998 /// The value travels in an ordinary register the allocator hands out, so it may be spilled like
1999 /// any other, and a spill slot in a frame that grows is reached through the frame pointer,
2000 /// which is exactly the register that still means something after the stack pointer has moved.
2001 fn stack_pointer(&mut self, inst: Inst, into: bool) -> Result<(), Unsupported> {
2002 let data = &self.source[inst];
2003 let block = self.at.expect("a block is being filled");
2004 let span = self.source.span(inst);
2005 let stack = mir::Reg::physical(self.conv.stack_pointer);
2006 let mov =
2007 self.selector.frame.moves(self.gpr).expect("a class the target says how to move").mov;
2008 let mov = self.named(mov);
2009 let (write, read) = if into {
2010 let &saved = self.source[data.args].first().ok_or_else(|| self.unsupported(inst))?;
2011 (stack, self.reg_of(saved)?)
2012 } else {
2013 let result = data.first_result.ok_or_else(|| self.unsupported(inst))?;
2014 (self.new_reg(result), stack)
2015 };
2016 self.out
2017 .build(block, mov)
2018 .at(span)
2019 .operand(mir::Operand::write(write, self.gpr))
2020 .operand(mir::Operand::read(read, self.gpr))
2021 .finish();
2022 // Only the write is a move of the stack pointer, and it is the one that makes the frame a
2023 // growing one. A read of it in a function that never writes it back is a function that
2024 // asked where the stack was and did nothing with the answer.
2025 if into {
2026 self.stack.grown_at.get_or_insert(inst);
2027 }
2028 Ok(())
2029 }
2030
2031 /// Whether an instruction has an eighty bit float anywhere in it.
2032 ///
2033 /// Producing one and reading one are the same question here, because what makes one of these
2034 /// different from every other instruction is not the operation but where the value is. A
2035 /// `long double` is on the x87 stack while it is being worked on and in a frame slot the rest
2036 /// of the time, and neither of those is somewhere the operand of a rule could point.
2037 fn touches_x87(&self, inst: Inst) -> bool {
2038 let data = &self.source[inst];
2039 data.results().any(|value| on_x87(self.source[value].ty))
2040 || self.source[data.args].iter().any(|&arg| on_x87(self.source[arg].ty))
2041 }
2042
2043 /// Everything that happens to an eighty bit float, as the group of instructions it is.
2044 ///
2045 /// The first six move one, and every one of those is a load, a store, or a load and a store at
2046 /// two different formats, because that is the whole of what this machine converts with: the
2047 /// x87 has no instruction that turns one thing on its stack into another, so a widening is
2048 /// `fld` of the narrow format and a narrowing is `fstp` of it.
2049 ///
2050 /// The rest work on one, and they are here rather than in a rule for the same reason the six
2051 /// are. An add is a push, a push, the add and a pop, and what passes between those four is the
2052 /// top of a stack nothing allocates from, so there is no value in the middle of the group for
2053 /// a pattern to bind or a replacement to name. The comparison is the same shape with its last
2054 /// two instructions folded into one opcode, which is where the byte it produces comes from.
2055 ///
2056 /// Every group leaves the stack as empty as it found it, which is what `spec/10-backend.md`
2057 /// section 10.8 asks of one and is why nothing in this file has to track a depth: each push
2058 /// below is answered by a pop a line or two later, so no two groups can ever be looking at
2059 /// the same eight registers.
2060 fn x87(&mut self, inst: Inst) -> Result<(), Unsupported> {
2061 match self.source[inst].opcode {
2062 Opcode::Load => self.x87_load(inst),
2063 Opcode::Store => self.x87_store(inst),
2064 Opcode::FPExt => self.x87_widen(inst),
2065 Opcode::FPTrunc => self.x87_narrow(inst),
2066 Opcode::SIToFP => self.x87_from_signed(inst),
2067 Opcode::FPToSI => self.x87_to_signed(inst),
2068 Opcode::FAdd => self.x87_arith(inst, "fadd_p"),
2069 Opcode::FSub => self.x87_arith(inst, "fsubr_p"),
2070 Opcode::FMul => self.x87_arith(inst, "fmul_p"),
2071 Opcode::FDiv => self.x87_arith(inst, "fdivr_p"),
2072 Opcode::FNeg => self.x87_flip(inst),
2073 Opcode::FCmp => self.x87_compare(inst),
2074 Opcode::FConst => self.x87_const(inst),
2075 _ => Err(self.unsupported(inst)),
2076 }
2077 }
2078
2079 /// The eighty bit parameters of a block, copied out of the addresses an edge handed over and
2080 /// into slots of the block's own.
2081 ///
2082 /// What crosses an edge for a value of this type is an address, because the value is sixteen
2083 /// bytes of the frame and no register holds any of it. The block cannot keep that address: a
2084 /// second edge into the same block hands over a second one, and a read after the block would
2085 /// then be a read of whichever edge was taken rather than of one place. So the block has a
2086 /// slot per parameter and the bytes are copied into it here, which is the move on an edge that
2087 /// every other type gets from the allocator.
2088 ///
2089 /// Every load runs before every store and the stores run backwards, so all of the values are
2090 /// on the x87 stack at once and nothing reads a slot another one has already written. That
2091 /// costs nothing in the ordinary case of one parameter and is what makes the back edge of a
2092 /// loop that swaps two of these work. It is also the reason for the limit: the stack is eight
2093 /// deep, and a block with more of these than that is refused rather than copied in an order
2094 /// that could be wrong.
2095 fn settle(&mut self, block: Block, arriving: &[(Value, mir::Reg)]) -> Result<(), Unsupported> {
2096 let Some(&(first, _)) = arriving.first() else { return Ok(()) };
2097 if arriving.len() > X87_DEPTH {
2098 let ty = self.source[first].ty;
2099 return Err(Unsupported::Phi { block, count: arriving.len(), ty });
2100 }
2101 // A block parameter comes from no instruction, so what this points at is the first thing
2102 // in the block, which is where a reader looking for the copy would look.
2103 let first_inst = self.source.insts(block).next();
2104 let span = first_inst.map_or(Span::DUMMY, |it| self.source.span(it));
2105 for &(_, reg) in arriving {
2106 let from = self.through(reg);
2107 self.x87_at("fld_t", span, from);
2108 }
2109 for &(param, _) in arriving.iter().rev() {
2110 let into = self.x87_slot(param);
2111 let into = self.through(into);
2112 self.x87_at("fstp_t", span, into);
2113 }
2114 Ok(())
2115 }
2116
2117 /// The frame slot an eighty bit value lives in, as its address in a fresh register.
2118 ///
2119 /// The slot is the value's for the whole function and is taken the first time somebody asks.
2120 /// The address is worked out again every time, which is a `lea` per use and is deliberate: one
2121 /// address kept in a register from the definition to the last use would hold a general purpose
2122 /// register open across everything in between, and a function with a handful of these in it
2123 /// would spend its registers on addresses of things rather than on things.
2124 fn x87_slot(&mut self, value: Value) -> mir::Reg {
2125 // An argument of the function has a slot already and it is the caller's. The convention
2126 // puts the bytes in the argument area and hands over where they are, so the address that
2127 // arrived is the answer and no second copy of the value is made. Nothing ever writes to a
2128 // value of this type once it exists, so nothing writes to the caller's copy either. A
2129 // parameter of any other block is not this: what arrived there is an address a predecessor
2130 // chose, [`Lowering::settle`] has already copied the bytes out of it, and the slot those
2131 // bytes landed in is the one below.
2132 let entry = self.source.entry();
2133 if let (Def::Param { block, .. }, Some(reg)) =
2134 (self.source[value].def, self.regs[value.index()])
2135 {
2136 if entry == Some(block) {
2137 return reg;
2138 }
2139 }
2140 let index = match self.slots[value.index()] {
2141 Some(index) => index,
2142 None => {
2143 let index = self.stack.locals.len();
2144 self.stack.locals.push(Local { size: X87_BYTES, align: X87_BYTES });
2145 self.slots[value.index()] = Some(index);
2146 index
2147 }
2148 };
2149 let block = self.at.expect("a block is being filled");
2150 self.frame_address(block, index)
2151 }
2152
2153 /// The bytes a value crosses between a register and the x87 stack through, as their address
2154 /// in a fresh register.
2155 fn x87_crossing(&mut self) -> mir::Reg {
2156 let index = match self.crossing {
2157 Some(index) => index,
2158 None => {
2159 let index = self.stack.locals.len();
2160 self.stack.locals.push(Local { size: X87_CROSSING, align: X87_CROSSING });
2161 self.crossing = Some(index);
2162 index
2163 }
2164 };
2165 let block = self.at.expect("a block is being filled");
2166 self.frame_address(block, index)
2167 }
2168
2169 /// The two control words, as the address of the first of them in a fresh register.
2170 fn x87_control(&mut self) -> mir::Reg {
2171 let index = match self.control {
2172 Some(index) => index,
2173 None => {
2174 let index = self.stack.locals.len();
2175 self.stack.locals.push(Local { size: 4, align: 4 });
2176 self.control = Some(index);
2177 index
2178 }
2179 };
2180 let block = self.at.expect("a block is being filled");
2181 self.frame_address(block, index)
2182 }
2183
2184 /// An address held in a register, as the addressing mode that reaches it.
2185 fn through(&self, reg: mir::Reg) -> mir::Mem {
2186 mir::Mem::at(mir::Operand::read(reg, self.gpr))
2187 }
2188
2189 /// One instruction of a group, which names an address and nothing else.
2190 ///
2191 /// Every x87 instruction that moves a value is one of these. What it does to the stack is in
2192 /// the mnemonic rather than in an operand, so there is no register to write down and no
2193 /// register the allocator gets a say in.
2194 fn x87_at(&mut self, name: &str, span: Span, at: mir::Mem) {
2195 let block = self.at.expect("a block is being filled");
2196 let opcode = self.named(name);
2197 self.out.build(block, opcode).at(span).mem(at).finish();
2198 }
2199
2200 /// The one instruction of a group that reaches the program's own memory.
2201 ///
2202 /// A `long double` moves in two instructions with a frame slot at one end of them, and the
2203 /// other end is the address the program wrote. That end is the access, so it is the one that
2204 /// carries what the program said about it, and the trip through the slot is this compiler's
2205 /// own business the way a spill is. See [`Self::carried`].
2206 fn x87_touching(&mut self, name: &str, inst: Inst, at: mir::Mem) {
2207 let block = self.at.expect("a block is being filled");
2208 let opcode = self.named(name);
2209 let (span, flags) = (self.source.span(inst), self.carried(inst));
2210 self.out.build(block, opcode).at(span).flags(flags).mem(at).finish();
2211 }
2212
2213 /// One instruction of a group that names nothing at all.
2214 ///
2215 /// The arithmetic is these. Both of an add's operands are already on the stack when it runs
2216 /// and so is where the answer goes, and the stack is not somewhere an instruction says, so
2217 /// `faddp` has an argument in the assembler's syntax and nothing here for the argument to come
2218 /// from. What it works on is which two pushes came before it, which is a fact about the order
2219 /// of the group and is why the group is written in one place.
2220 fn x87_only(&mut self, name: &str, span: Span) {
2221 let block = self.at.expect("a block is being filled");
2222 let opcode = self.named(name);
2223 self.out.build(block, opcode).at(span).finish();
2224 }
2225
2226 /// A `load` of a `long double`: onto the stack from where it was, and off it into the slot.
2227 ///
2228 /// Two instructions rather than the two general purpose moves the same sixteen bytes would
2229 /// take, because `fld` and `fstp` at this format neither convert nor look: the value goes on
2230 /// in the format it was already in and comes back off in it, so a signalling NaN stays one
2231 /// and nothing is raised. Which is what makes this a copy at all.
2232 fn x87_load(&mut self, inst: Inst) -> Result<(), Unsupported> {
2233 let (args, result) = self.ends(inst)?;
2234 let &address = args.first().ok_or_else(|| self.unsupported(inst))?;
2235 let span = self.source.span(inst);
2236 let from = self.reg_of(address)?;
2237 let from = self.through(from);
2238 let into = self.x87_slot(result);
2239 let into = self.through(into);
2240 self.x87_touching("fld_t", inst, from);
2241 self.x87_at("fstp_t", span, into);
2242 Ok(())
2243 }
2244
2245 /// A `store` of a `long double`: the same pair the other way round.
2246 fn x87_store(&mut self, inst: Inst) -> Result<(), Unsupported> {
2247 let args = self.source[self.source[inst].args].to_vec();
2248 let [value, address] = args[..] else { return Err(self.unsupported(inst)) };
2249 let span = self.source.span(inst);
2250 let from = self.x87_slot(value);
2251 let from = self.through(from);
2252 let into = self.reg_of(address)?;
2253 let into = self.through(into);
2254 self.x87_at("fld_t", span, from);
2255 self.x87_touching("fstp_t", inst, into);
2256 Ok(())
2257 }
2258
2259 /// A `float`, a `double` or an integer becoming a `long double`.
2260 ///
2261 /// Through memory, because the x87 reads memory and nothing else: the value is in a register
2262 /// the machine has and the unit has no way to be handed one, so it is written to the crossing
2263 /// bytes and loaded back at the format that widens it. Every one of these is exact. Sixty four
2264 /// bits of significand and fifteen of exponent hold every `float`, every `double` and every
2265 /// sixty four bit integer outright, so none of the four can round and none can raise.
2266 fn x87_across(
2267 &mut self,
2268 inst: Inst,
2269 put: &'static str,
2270 class: RegClass,
2271 get: &'static str,
2272 ) -> Result<(), Unsupported> {
2273 let (args, result) = self.ends(inst)?;
2274 let &source = args.first().ok_or_else(|| self.unsupported(inst))?;
2275 let span = self.source.span(inst);
2276 let value = self.reg_of(source)?;
2277 let across = self.x87_crossing();
2278 let across = self.through(across);
2279 let into = self.x87_slot(result);
2280 let into = self.through(into);
2281
2282 let block = self.at.expect("a block is being filled");
2283 let store = self.named(put);
2284 self.out.build(block, store).at(span).uses(value, class).mem(across).finish();
2285 self.x87_at(get, span, across);
2286 self.x87_at("fstp_t", span, into);
2287 Ok(())
2288 }
2289
2290 /// A `long double` becoming a `float`, a `double` or an integer.
2291 ///
2292 /// Through memory for the reason above and in the same three instructions backwards. The two
2293 /// that go to a float round to nearest, which is what the control word says unless somebody
2294 /// has changed it and is what C wants. The two that go to an integer do not, which is why they
2295 /// do not come here.
2296 fn x87_back(
2297 &mut self,
2298 inst: Inst,
2299 put: &'static str,
2300 get: &'static str,
2301 class: RegClass,
2302 ) -> Result<(), Unsupported> {
2303 let (args, result) = self.ends(inst)?;
2304 let &source = args.first().ok_or_else(|| self.unsupported(inst))?;
2305 let span = self.source.span(inst);
2306 let from = self.x87_slot(source);
2307 let from = self.through(from);
2308 let across = self.x87_crossing();
2309 let across = self.through(across);
2310
2311 self.x87_at("fld_t", span, from);
2312 self.x87_at(put, span, across);
2313 let block = self.at.expect("a block is being filled");
2314 let reg = self.new_reg(result);
2315 let load = self.named(get);
2316 self.out.build(block, load).at(span).def(reg, class).mem(across).finish();
2317 Ok(())
2318 }
2319
2320 /// An `fpext` up to a `long double`, which is the only direction this machine has one in.
2321 fn x87_widen(&mut self, inst: Inst) -> Result<(), Unsupported> {
2322 let sse = self.conv.sse_class;
2323 match self.source[self.narrow(inst)?].ty.bits() {
2324 32 => self.x87_across(inst, "movss_mr", sse, "fld_s"),
2325 64 => self.x87_across(inst, "movsd_mr", sse, "fld_l"),
2326 _ => Err(self.unsupported(inst)),
2327 }
2328 }
2329
2330 /// An `fptrunc` down from a `long double`, which is the other direction of the same.
2331 fn x87_narrow(&mut self, inst: Inst) -> Result<(), Unsupported> {
2332 let sse = self.conv.sse_class;
2333 let result = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
2334 match self.source[result].ty.bits() {
2335 32 => self.x87_back(inst, "fstp_s", "movss_rm", sse),
2336 64 => self.x87_back(inst, "fstp_l", "movsd_rm", sse),
2337 _ => Err(self.unsupported(inst)),
2338 }
2339 }
2340
2341 /// A `sitofp` up to a `long double`.
2342 ///
2343 /// Thirty two bits and sixty four, and nothing narrower, because C widens an integer to `int`
2344 /// before it converts one and the front end writes that widening down. An unsigned integer is
2345 /// not here at all: `fild` reads its operand as signed, so a value above the signed range
2346 /// comes back short by two to the sixty fourth and has to be added back, which is arithmetic
2347 /// rather than a move and waits with the rest of it.
2348 fn x87_from_signed(&mut self, inst: Inst) -> Result<(), Unsupported> {
2349 let gpr = self.gpr;
2350 match self.source[self.narrow(inst)?].ty.bits() {
2351 32 => self.x87_across(inst, "mov_mr_32", gpr, "fild_l"),
2352 64 => self.x87_across(inst, "mov_mr_64", gpr, "fild_ll"),
2353 _ => Err(self.unsupported(inst)),
2354 }
2355 }
2356
2357 /// An `fptosi` down from a `long double`, which is the one conversion here with no single
2358 /// instruction behind it.
2359 ///
2360 /// C cuts towards zero and the unit rounds the way its control word says, so the store that
2361 /// takes the value off the stack is wrapped in the control word being saved, changed and put
2362 /// back. Five instructions around the one that does the work, and three more moving the word
2363 /// through a register, because this machine has no way to OR a constant into memory at this
2364 /// width. The unit has a shorter answer in `fisttp`, and `spec/10-backend.md` section 10.8
2365 /// says why it is not used: it is SSE3, the x86-64 baseline is not, and there is nothing here
2366 /// that can gate an instruction on a feature yet.
2367 fn x87_to_signed(&mut self, inst: Inst) -> Result<(), Unsupported> {
2368 let (args, result) = self.ends(inst)?;
2369 let &source = args.first().ok_or_else(|| self.unsupported(inst))?;
2370 let (put, get) = match self.source[result].ty.bits() {
2371 32 => ("fistp_l", "mov_rm_32"),
2372 64 => ("fistp_ll", "mov_rm_64"),
2373 _ => return Err(self.unsupported(inst)),
2374 };
2375 let span = self.source.span(inst);
2376 let gpr = self.gpr;
2377 let from = self.x87_slot(source);
2378 let from = self.through(from);
2379 let across = self.x87_crossing();
2380 let across = self.through(across);
2381 let control = self.x87_control();
2382 let saved = self.through(control).plus(0);
2383 let cut = self.through(control).plus(2);
2384
2385 // The word the unit has now, into the first of the two slots and into a register, with the
2386 // rounding field turned to truncate on the way to the second.
2387 self.x87_at("fnstcw", span, saved);
2388 let block = self.at.expect("a block is being filled");
2389 let was = self.out.new_vreg(gpr);
2390 let read = self.named("mov_rm_16");
2391 self.out.build(block, read).at(span).def(was, gpr).mem(saved).finish();
2392 let now = self.out.new_vreg(gpr);
2393 let set = self.named("or_ri_16");
2394 // Two address, which is written out here rather than taken from the two shorthands
2395 // because the shorthands leave an operand unconstrained: this machine ORs into the
2396 // register it read, so the two have to be the same one and only the constraint says so.
2397 self.out
2398 .build(block, set)
2399 .at(span)
2400 .operand(mir::Operand::write(now, gpr).with(Constraint::Reuse(1)))
2401 .operand(mir::Operand::read(was, gpr))
2402 .imm(X87_TRUNCATE)
2403 .finish();
2404 let write = self.named("mov_mr_16");
2405 self.out.build(block, write).at(span).uses(now, gpr).mem(cut).finish();
2406
2407 // The conversion itself, under the changed word, and then the word the unit had put back
2408 // before anything else runs.
2409 self.x87_at("fldcw", span, cut);
2410 self.x87_at("fld_t", span, from);
2411 self.x87_at(put, span, across);
2412 self.x87_at("fldcw", span, saved);
2413
2414 let block = self.at.expect("a block is being filled");
2415 let reg = self.new_reg(result);
2416 let load = self.named(get);
2417 self.out.build(block, load).at(span).def(reg, gpr).mem(across).finish();
2418 Ok(())
2419 }
2420
2421 /// A constant of this type, as the bits of it written into its slot.
2422 ///
2423 /// No x87 instruction at all, which is the surprise here. A slot holding an eighty bit value is
2424 /// the value, so a constant is ten bytes put where the value lives, and the unit never has to
2425 /// see it: whatever reads it will `fld` it out of the slot the way it reads any other one.
2426 ///
2427 /// Ten bytes in two goes, because the machine stores eight at a time and there is no store of
2428 /// an immediate to memory, so each half is put in a register first. The six bytes above the ten
2429 /// are left alone, since nothing reads them: they are the padding that makes the type sixteen
2430 /// wide and they are unspecified in the psABI rather than zero.
2431 ///
2432 /// The other way is a constant pool, an `fldt` of a symbol, and a relocation, which is what a
2433 /// compiler with somewhere to put a literal does. This back end has nowhere to put one yet, and
2434 /// four instructions in the frame is what that costs until it does.
2435 fn x87_const(&mut self, inst: Inst) -> Result<(), Unsupported> {
2436 let Extra::Imm(imm) = self.source[inst].extra else { return Err(self.unsupported(inst)) };
2437 let result = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
2438 let bits = self.source[imm].bits();
2439 let span = self.source.span(inst);
2440 let gpr = self.gpr;
2441 let slot = self.x87_slot(result);
2442 let low = self.through(slot).plus(0);
2443 let high = self.through(slot).plus(8);
2444
2445 let block = self.at.expect("a block is being filled");
2446 for (bytes, at, into) in
2447 [(bits as u64 as i64, low, "64"), (((bits >> 64) & 0xffff) as i64, high, "16")]
2448 {
2449 let held = self.out.new_vreg(gpr);
2450 let put = self.named(&format!("mov_ri_{into}"));
2451 self.out.build(block, put).at(span).def(held, gpr).imm(bytes).finish();
2452 let store = self.named(&format!("mov_mr_{into}"));
2453 self.out.build(block, store).at(span).uses(held, gpr).mem(at).finish();
2454 }
2455 Ok(())
2456 }
2457
2458 /// One arithmetic instruction on two eighty bit values, as the four it takes.
2459 ///
2460 /// The left operand is pushed first and the right one on top of it, so the left ends up
2461 /// underneath and the answer wanted is the one below against the top in that order. Which of
2462 /// the two mnemonics computes that is a question about the spelling rather than about the
2463 /// machine, and the two spellings disagree. Intel's `FSUBP ST(i), ST(0)` is `ST(i) - ST(0)`
2464 /// and is `DE E8+i`, and AT&T's `fsubp` is `DE E0+i`, which is the other subtraction. This
2465 /// compiler writes AT&T and encodes what gas encodes, so what it asks for here is `fsubr_p`
2466 /// and `fdivr_p`, and the `r` is not a reversal of anything the code generator decided.
2467 ///
2468 /// An addition and a multiplication have one form each and do not care, which is why a test
2469 /// that reads the mnemonic back would not have caught this and one that computes a subtraction
2470 /// and checks the answer does.
2471 ///
2472 /// The answer is left where the deeper of the two was and the shallower is gone, which is what
2473 /// the `p` on the mnemonic means, so one push has already been paid back by the time the
2474 /// `fstp` runs and the stack is level again after it.
2475 ///
2476 /// Nothing here is folded and nothing is reused. Two values that are the same value get two
2477 /// pushes of the same slot, and an operand that was just computed is read back out of the slot
2478 /// it was written to rather than left on the stack, which costs a store and a load per
2479 /// instruction in an expression. Keeping a partial result on the stack across the next
2480 /// instruction's operands means knowing how deep the stack is at every point in the block, and
2481 /// that is a different thing from writing a group.
2482 fn x87_arith(&mut self, inst: Inst, with: &'static str) -> Result<(), Unsupported> {
2483 let (args, result) = self.ends(inst)?;
2484 let [left, right] = args[..] else { return Err(self.unsupported(inst)) };
2485 let span = self.source.span(inst);
2486 let left = self.x87_slot(left);
2487 let left = self.through(left);
2488 let right = self.x87_slot(right);
2489 let right = self.through(right);
2490 let into = self.x87_slot(result);
2491 let into = self.through(into);
2492 self.x87_at("fld_t", span, left);
2493 self.x87_at("fld_t", span, right);
2494 self.x87_only(with, span);
2495 self.x87_at("fstp_t", span, into);
2496 Ok(())
2497 }
2498
2499 /// A negation, which is a push, the sign bit turned over and a pop.
2500 ///
2501 /// `fchs` does not read the value as a number, so this is right for a zero, for an infinity
2502 /// and for a NaN, and it raises nothing on any of them. Which is what C asks of a negation and
2503 /// is not what subtracting from zero would give: `0.0L - x` is a different answer at a
2504 /// negative zero and a signalling one at a NaN.
2505 fn x87_flip(&mut self, inst: Inst) -> Result<(), Unsupported> {
2506 let (args, result) = self.ends(inst)?;
2507 let &source = args.first().ok_or_else(|| self.unsupported(inst))?;
2508 let span = self.source.span(inst);
2509 let from = self.x87_slot(source);
2510 let from = self.through(from);
2511 let into = self.x87_slot(result);
2512 let into = self.through(into);
2513 self.x87_at("fld_t", span, from);
2514 self.x87_only("fchs", span);
2515 self.x87_at("fstp_t", span, into);
2516 Ok(())
2517 }
2518
2519 /// A comparison of two eighty bit values, as the two pushes and the one opcode that reads them.
2520 ///
2521 /// The right operand is pushed first and the left one on top of it, which is the other way
2522 /// round from the arithmetic and is because `fucomip` asks about the top against what is under
2523 /// it: the comparison this machine can do is the top's, so the value the predicate is about
2524 /// has to be the top. The pop that gets the loser off the stack and the byte that reads the
2525 /// flags are both inside the opcode, since what passes between those and the comparison is the
2526 /// flags and the flags are not something anything here can name.
2527 ///
2528 /// Which of the ten opcodes, and which way round, is the same table the vector comparisons
2529 /// match against in `rules/x86-64.rules`, and it has to stay the same table: a predicate that
2530 /// picked a different condition here than there would be a `long double` comparison that
2531 /// disagreed with the `double` comparison of the same two numbers, which is the one thing a
2532 /// wider format is not allowed to do.
2533 ///
2534 /// The always false and the always true are refused rather than folded into a constant,
2535 /// because a comparison this machine never has to do is one the optimizer should have removed
2536 /// and an instruction here that quietly agreed with it would hide that it did not.
2537 fn x87_compare(&mut self, inst: Inst) -> Result<(), Unsupported> {
2538 let Extra::FloatPred(pred) = self.source[inst].extra else {
2539 return Err(self.unsupported(inst));
2540 };
2541 let (args, result) = self.ends(inst)?;
2542 let [left, right] = args[..] else { return Err(self.unsupported(inst)) };
2543 // Two of the fourteen need a second byte and an instruction to put the two together,
2544 // because they are two conditions at once: an ordered equal is equal and not unordered,
2545 // and an unordered not equal is either. The opcode carries all of that and says here only
2546 // that it writes somewhere else as well.
2547 let (name, reversed, both) = match pred {
2548 FloatPred::Ogt => ("fucomip_set_a", false, false),
2549 FloatPred::Oge => ("fucomip_set_ae", false, false),
2550 FloatPred::Olt => ("fucomip_set_a", true, false),
2551 FloatPred::Ole => ("fucomip_set_ae", true, false),
2552 FloatPred::One => ("fucomip_set_ne", false, false),
2553 FloatPred::Ord => ("fucomip_set_np", false, false),
2554 FloatPred::Uno => ("fucomip_set_p", false, false),
2555 FloatPred::Ueq => ("fucomip_set_e", false, false),
2556 FloatPred::Ult => ("fucomip_set_b", false, false),
2557 FloatPred::Ule => ("fucomip_set_be", false, false),
2558 FloatPred::Ugt => ("fucomip_set_b", true, false),
2559 FloatPred::Uge => ("fucomip_set_be", true, false),
2560 FloatPred::Oeq => ("fucomip_set_e_and_np", false, true),
2561 FloatPred::Une => ("fucomip_set_ne_or_p", false, true),
2562 FloatPred::False | FloatPred::True => return Err(self.unsupported(inst)),
2563 };
2564 let (top, under) = if reversed { (right, left) } else { (left, right) };
2565
2566 let span = self.source.span(inst);
2567 let gpr = self.gpr;
2568 let under = self.x87_slot(under);
2569 let under = self.through(under);
2570 let top = self.x87_slot(top);
2571 let top = self.through(top);
2572 self.x87_at("fld_t", span, under);
2573 self.x87_at("fld_t", span, top);
2574
2575 let block = self.at.expect("a block is being filled");
2576 let reg = self.new_reg(result);
2577 // Taken before the instruction is started rather than inside it, since both come from the
2578 // same function being built and only one thing at a time may be adding to it.
2579 let spare = both.then(|| self.out.new_vreg(gpr));
2580 let opcode = self.named(name);
2581 let mut build = self.out.build(block, opcode).at(span).def(reg, gpr);
2582 if let Some(spare) = spare {
2583 build = build.def(spare, gpr);
2584 }
2585 build.finish();
2586 Ok(())
2587 }
2588
2589 /// The operands and the one result of an instruction that has exactly one.
2590 fn ends(&self, inst: Inst) -> Result<(&'a [Value], Value), Unsupported> {
2591 let data = &self.source[inst];
2592 let result = data.first_result.ok_or_else(|| self.unsupported(inst))?;
2593 Ok((&self.source[data.args], result))
2594 }
2595
2596 /// The operand of a conversion, which is the end of it that is not the `long double`.
2597 fn narrow(&self, inst: Inst) -> Result<Value, Unsupported> {
2598 let args = &self.source[self.source[inst].args];
2599 args.first().copied().ok_or_else(|| self.unsupported(inst))
2600 }
2601
2602 /// One `va_start`, as the fields of the list it was handed.
2603 ///
2604 /// On the four field list, two of them are numbers this already knows, and each costs an
2605 /// instruction to put in a register before it can be stored, because the machine here has no
2606 /// store of an immediate to memory. The other two are addresses in the frame, and each is a
2607 /// `lea` [`crate::finish`] finishes: the save area is one of the function's own stack objects,
2608 /// and the caller's argument area is where the parameters that had no register came from, which
2609 /// is the same place and the same fixup a parameter past the sixth already uses.
2610 ///
2611 /// On the list that is a pointer it is the second of those four and nothing else, since the
2612 /// whole of what that list says is where the walk is and the walk starts at the first argument
2613 /// the signature does not name. One `lea` and one store.
2614 ///
2615 /// What is written is exactly the fields [`crate::varargs`] describes, in the order they are
2616 /// laid out, so that reading this beside that table is the whole of the check.
2617 fn va_start(&mut self, inst: Inst) -> Result<(), Unsupported> {
2618 let Some(&list) = self.source[self.source[inst].args].first() else {
2619 return Err(self.unsupported(inst));
2620 };
2621 let started = self.varargs.ok_or_else(|| self.unsupported(inst))?;
2622 let list = self.reg_of(list)?;
2623 let block = self.at.expect("a block is being filled");
2624 let span = self.source.span(inst);
2625
2626 let (save, incoming) = match started {
2627 Varargs::Pointer { incoming } => (None, incoming),
2628 Varargs::Fields { save, incoming, integers, floats } => {
2629 let counts = [(varargs::GP_OFFSET, integers), (varargs::FP_OFFSET, floats)];
2630 for (at, count) in counts {
2631 self.store_small(list, at, i64::from(count), span);
2632 }
2633 (Some(save), incoming)
2634 }
2635 Varargs::Aapcs { save, incoming, integers_end, floats_end, integers, floats } => {
2636 let counts =
2637 [(varargs::aapcs::GR_OFFS, integers), (varargs::aapcs::VR_OFFS, floats)];
2638 for (at, count) in counts {
2639 self.store_small(list, at, i64::from(count), span);
2640 }
2641 let overflow = self.overflow(block, incoming, span);
2642 let integers_top = self.frame_address_plus(block, save, integers_end);
2643 let floats_top = self.frame_address_plus(block, save, floats_end);
2644 let fields = [
2645 (varargs::aapcs::STACK, overflow),
2646 (varargs::aapcs::GR_TOP, integers_top),
2647 (varargs::aapcs::VR_TOP, floats_top),
2648 ];
2649 for (at, held) in fields {
2650 self.store_word(list, at, held, span);
2651 }
2652 return Ok(());
2653 }
2654 };
2655
2656 // At the front of the list when that address is the whole of it, and at the field the
2657 // layout gives it when there are four, with the save area behind it.
2658 let overflow = self.overflow(block, incoming, span);
2659 let fields = match save {
2660 None => vec![(0, overflow)],
2661 Some(save) => {
2662 let save = self.frame_address(block, save);
2663 vec![(varargs::OVERFLOW, overflow), (varargs::SAVE_AREA, save)]
2664 }
2665 };
2666 for (at, held) in fields {
2667 self.store_word(list, at, held, span);
2668 }
2669 Ok(())
2670 }
2671
2672 /// The first argument the signature did not name, which is as far up the caller's argument
2673 /// area as the ones it did name reached. Nothing here knows where that area is, so the distance
2674 /// is recorded the way a parameter read out of it is and finished with it.
2675 fn overflow(&mut self, block: mir::Block, incoming: u32, span: Span) -> mir::Reg {
2676 let overflow = self.out.new_vreg(self.gpr);
2677 let lea = self.named(self.selector.frame.lea);
2678 let sp = mir::Operand::read(mir::Reg::physical(self.conv.stack_pointer), self.gpr);
2679 let made = self
2680 .out
2681 .build(block, lea)
2682 .at(span)
2683 .def(overflow, self.gpr)
2684 .mem(mir::Mem::at(sp))
2685 .finish();
2686 self.stack.arguments.push((made, incoming));
2687 overflow
2688 }
2689
2690 /// Writes a small constant into a 32 bit field of a list.
2691 fn store_small(&mut self, list: mir::Reg, at: i64, value: i64, span: Span) {
2692 let block = self.at.expect("a block is being filled");
2693 let held = self.out.new_vreg(self.gpr);
2694 let load = mir::Opcode::new(self.names.intern(self.selector.abi.small));
2695 self.out.build(block, load).at(span).def(held, self.gpr).imm(value).finish();
2696
2697 let head = (self.selector.abi.store)(Type::int(32)).expect("a store of a word");
2698 let store = mir::Opcode::new(self.names.intern(head));
2699 let mem = self.field(list, at);
2700 self.out.build(block, store).at(span).uses(held, self.gpr).mem(mem).finish();
2701 }
2702
2703 /// Writes an address into a pointer field of a list.
2704 fn store_word(&mut self, list: mir::Reg, at: i64, held: mir::Reg, span: Span) {
2705 let block = self.at.expect("a block is being filled");
2706 let head = (self.selector.abi.store)(Type::int(64)).expect("a store of an address");
2707 let store = mir::Opcode::new(self.names.intern(head));
2708 let mem = self.field(list, at);
2709 self.out.build(block, store).at(span).uses(held, self.gpr).mem(mem).finish();
2710 }
2711
2712 /// One field of a list, as the addressing mode that reaches it.
2713 fn field(&self, list: mir::Reg, at: i64) -> mir::Mem {
2714 let base = mir::Operand::read(list, self.gpr);
2715 mir::Mem::at(base).plus(i32::try_from(at).expect("a field of a list is a small offset"))
2716 }
2717
2718 /// The address of a name: one `lea` off the instruction pointer, with the name on it.
2719 ///
2720 /// That is x86-64, and [`Selector::symbols`] is what says so. AArch64 writes the same thing as
2721 /// an `adrp` of the page and an `add` of the low twelve bits, which is one opcode with the name
2722 /// as its own symbol and no addressing mode, and the table read is an `adrp` and an `ldr`.
2723 ///
2724 /// The same instruction an `alloca` gets and for a related reason. An address that is not in
2725 /// the program is a `lea` of an addressing mode that names no register, and the mode carries
2726 /// the symbol so that [`rucc_asm`] can write it relative to `%rip` and leave the relocation
2727 /// for the assembler. Both halves of that already existed: the printer writes `sym(%rip)` and
2728 /// the encoder emits the relocation, because a call to a name the file does not define needed
2729 /// them first.
2730 ///
2731 /// One `mov` and not one `lea` when the name is one [`Elsewhere`] holds, because the distance
2732 /// the `lea` adds to the instruction pointer is a number only a link that puts the name in
2733 /// this program can work out, and the address of a function this file merely declares is not
2734 /// such a number. The load reads the address out of the slot the linker fills in instead. The
2735 /// linker turns it back into the `lea` when the name turns out to have been here all along,
2736 /// so this is not slower in the case that was already right.
2737 ///
2738 /// There is deliberately no name for this in [`crate::term`], which is what stops the address
2739 /// being folded into the instruction that reads it. Folding it is the right thing to do and
2740 /// is what turns a load of a global from two instructions into one, but it is a separate
2741 /// question about addressing modes and issue #282 is it. Until then the address is in a
2742 /// register before anything uses it, which is correct and one instruction longer.
2743 ///
2744 /// What this does not do is give the name anything to refer to. A module carries its globals
2745 /// and nothing writes them out, so a file that defines the variable it reads compiles to a
2746 /// reference the linker cannot resolve. Issue #293 is the other half.
2747 ///
2748 /// A thread-local variable is neither of the two above and is [`Self::thread_address`].
2749 fn address_of(&mut self, inst: Inst) -> Result<(), Unsupported> {
2750 let data = &self.source[inst];
2751 let Extra::Symbol(symbol) = data.extra else { return Err(self.unsupported(inst)) };
2752 let result = data.first_result.ok_or_else(|| self.unsupported(inst))?;
2753 if self.elsewhere.thread(symbol) {
2754 return self.thread_address(inst, symbol, result);
2755 }
2756 if let Some(slot) = self.elsewhere.slot(symbol) {
2757 let reg = self.new_reg(result);
2758 return self.through_slot(inst, slot, symbol, reg);
2759 }
2760
2761 let block = self.at.expect("a block is being filled");
2762 let reg = self.new_reg(result);
2763 let span = self.source.span(inst);
2764 let far = self.elsewhere.holds(symbol);
2765 let symbols = self.selector.symbols;
2766 match if far { symbols.far } else { symbols.near } {
2767 Reach::Mode(name) => {
2768 let mem = if far { mir::Mem::got(symbol) } else { mir::Mem::of(symbol) };
2769 let opcode = self.named(name);
2770 self.out.build(block, opcode).at(span).def(reg, self.gpr).mem(mem).finish();
2771 }
2772 Reach::Own(name) => {
2773 let opcode = self.named(name);
2774 self.out.build(block, opcode).at(span).def(reg, self.gpr).symbol(symbol).finish();
2775 }
2776 }
2777 Ok(())
2778 }
2779
2780 /// The address of a name on COFF that is reached through a pointer, into `reg`.
2781 ///
2782 /// One load of the pointer from the instruction pointer, which is the same instruction the
2783 /// global offset table is read with on the other formats and for much the same reason: the
2784 /// pointer is in this image, so the distance to it is a number the linker has, and what it
2785 /// holds is an address the loader or the runtime writes once the DLL the name is in has been
2786 /// put somewhere. See [`Slot`] for which pointer and who writes it.
2787 ///
2788 /// ```text
2789 /// movq __imp_GetCurrentProcessId(%rip), %rax
2790 /// movq .refptr.environ(%rip), %rax
2791 /// ```
2792 fn through_slot(
2793 &mut self,
2794 inst: Inst,
2795 slot: Slot,
2796 symbol: Symbol,
2797 reg: mir::Reg,
2798 ) -> Result<(), Unsupported> {
2799 let Reach::Mode(name) = self.selector.symbols.far else {
2800 return Err(self.unsupported(inst));
2801 };
2802 let block = self.at.expect("a block is being filled");
2803 let span = self.source.span(inst);
2804 let pointer = slot.name(self.names.resolve(symbol));
2805 let pointer = self.names.intern(&pointer);
2806 let opcode = self.named(name);
2807 self.out
2808 .build(block, opcode)
2809 .at(span)
2810 .def(reg, self.gpr)
2811 .mem(mir::Mem::of(pointer))
2812 .finish();
2813 Ok(())
2814 }
2815
2816 /// The address of a thread-local variable, which is this thread's copy of it.
2817 ///
2818 /// Neither instruction the ordinary case writes would mean anything here. There is no distance
2819 /// to the variable for a `lea` to add, because there is no variable: there is one copy of it per
2820 /// thread and they are at different addresses, so a link asked for the distance to the name
2821 /// refuses rather than picking one. And there is no address for a table slot to hold either, for
2822 /// the same reason.
2823 ///
2824 /// What is the same in every thread is where the variable sits inside the block of storage a
2825 /// thread gets, so that offset is what the link writes down, and the address of the running
2826 /// thread's block is what turns it into an address. x86-64 keeps that address in `%fs`, at the
2827 /// front of the block, so the whole of this is three instructions:
2828 ///
2829 /// ```text
2830 /// movq x@gottpoff(%rip), %off # how far into the block x sits, which the link fills in
2831 /// movq %fs:0, %tp # where this thread's block is, which only the machine knows
2832 /// addq %tp, %off # this thread's copy of x
2833 /// ```
2834 ///
2835 /// That is the initial exec model. It is one instruction longer than what gcc writes at `-O2`
2836 /// in an executable, which folds the addition into the instruction that uses the address, and
2837 /// the difference is issue #282 rather than anything about threads: nothing here folds an
2838 /// address into its reader yet. The link relaxes the first instruction into an immediate when it
2839 /// is making an executable, since it lays the blocks out and therefore knows the number, so the
2840 /// table slot costs nothing in the case that is common.
2841 ///
2842 /// It is not the most general model. A library loaded by `dlopen` gets its storage after the
2843 /// program is already running, and the block this reaches was laid out before it started, so
2844 /// the loader has to find room in that block for the library's variables. glibc keeps a little
2845 /// spare room for exactly this and a library that fits in it loads and runs; one that does not
2846 /// fails to load, with a message saying so. The model with no such limit calls `__tls_get_addr`
2847 /// and is what gcc writes under `-fPIC` by default, and it is issue #1104.
2848 ///
2849 /// So this is the model gcc writes under `-ftls-model=initial-exec`: right for an executable,
2850 /// right for a library the program is linked against, and a load that either works or is
2851 /// refused out loud for a library something opens later. What it is never is quietly wrong.
2852 ///
2853 /// AArch64 Linux is the same three steps. The slot is reached with `adrp` and `ldr` against
2854 /// `:gottprel:`, the thread pointer is `tpidr_el0` read with `mrs`, and the add has three
2855 /// operands. Apple's platforms reach a thread-local variable through a descriptor call instead,
2856 /// which is [`Self::thread_descriptor`].
2857 fn thread_address(
2858 &mut self,
2859 inst: Inst,
2860 symbol: Symbol,
2861 result: Value,
2862 ) -> Result<(), Unsupported> {
2863 if self.elsewhere.described() {
2864 return self.thread_descriptor(inst, symbol, result);
2865 }
2866 if self.elsewhere.indexed() {
2867 return self.thread_indexed(inst, symbol, result);
2868 }
2869 let block = self.at.expect("a block is being filled");
2870 let span = self.source.span(inst);
2871 let gpr = self.gpr;
2872
2873 let offset = self.out.new_vreg(gpr);
2874 match self.selector.symbols.thread {
2875 Reach::Mode(name) => {
2876 let load = self.named(name);
2877 let mem = mir::Mem::thread(symbol);
2878 self.out.build(block, load).at(span).def(offset, gpr).mem(mem).finish();
2879 }
2880 Reach::Own(name) => {
2881 let load = self.named(name);
2882 self.out.build(block, load).at(span).def(offset, gpr).symbol(symbol).finish();
2883 }
2884 }
2885 let pointer = self.out.new_vreg(gpr);
2886 self.read_thread_pointer(block, span, pointer);
2887
2888 // Two address on x86-64, for the reason `x87_to_int` gives: that machine adds into the
2889 // register it read, and only the constraint says the two are the same one.
2890 let reg = self.new_reg(result);
2891 let jumps = self.selector.jumps;
2892 let add = self.named(jumps.add);
2893 let written = mir::Operand::write(reg, gpr);
2894 let written = if jumps.two_address { written.with(Constraint::Reuse(1)) } else { written };
2895 self.out
2896 .build(block, add)
2897 .at(span)
2898 .operand(written)
2899 .operand(mir::Operand::read(offset, gpr))
2900 .operand(mir::Operand::read(pointer, gpr))
2901 .finish();
2902 Ok(())
2903 }
2904
2905 /// A thread-local variable on Mach-O, which is a call.
2906 ///
2907 /// The slot the machine's thread load reads holds the address of the variable's descriptor
2908 /// there, `_v@TLVP` on x86-64 and `_v@TLVPPAGE` with `_v@TLVPPAGEOFF` on AArch64. The first
2909 /// word of the descriptor is the function that finds this thread's copy, and it takes the
2910 /// descriptor's address as its one argument and gives back the copy's address. That is the
2911 /// sequence clang writes on both machines.
2912 ///
2913 /// The call is built as an ordinary call through an address, so it costs what any call costs:
2914 /// everything the convention does not preserve is taken to be gone across it. Apple's function
2915 /// keeps more than that, all but the result and the two scratch registers on AArch64, and
2916 /// taking the fewer registers as gone would be faster. What this gives up is speed, and a
2917 /// function that reads a thread-local is no longer a leaf.
2918 fn thread_descriptor(
2919 &mut self,
2920 inst: Inst,
2921 symbol: Symbol,
2922 result: Value,
2923 ) -> Result<(), Unsupported> {
2924 let block = self.at.expect("a block is being filled");
2925 let span = self.source.span(inst);
2926 let gpr = self.gpr;
2927
2928 let descriptor = self.out.new_vreg(gpr);
2929 match self.selector.symbols.thread {
2930 Reach::Mode(name) => {
2931 let load = self.named(name);
2932 let mem = mir::Mem::thread(symbol);
2933 self.out.build(block, load).at(span).def(descriptor, gpr).mem(mem).finish();
2934 }
2935 Reach::Own(name) => {
2936 let load = self.named(name);
2937 let build = self.out.build(block, load).at(span);
2938 build.def(descriptor, gpr).symbol(symbol).finish();
2939 }
2940 }
2941 let finder = self.out.new_vreg(gpr);
2942 let word = (self.selector.abi.load)(Type::PTR).ok_or_else(|| self.unsupported(inst))?;
2943 let word = mir::Opcode::new(self.names.intern(word));
2944 let mem = mir::Mem::at(mir::Operand::read(descriptor, gpr));
2945 self.out.build(block, word).at(span).def(finder, gpr).mem(mem).finish();
2946
2947 let args = [abi::Passing { ty: Type::PTR, reg: descriptor, abi: Abi::default() }];
2948 let what = abi::Calling {
2949 callee: abi::Callee::Through(finder),
2950 args: &args,
2951 returns: &[Type::PTR],
2952 variadic: false,
2953 named: 1,
2954 at: span,
2955 };
2956 let made = abi::call(&mut self.out, block, &what, self.conv, self.selector.abi, self.names)
2957 .map_err(|refused| Unsupported::Call { inst, refused })?;
2958 let calls = &mut self.stack.calls;
2959 *calls = Some(calls.unwrap_or(0).max(made.outgoing));
2960 let &[reg] = &made.results[..] else { return Err(self.unsupported(inst)) };
2961 self.regs[result.index()] = Some(reg);
2962 Ok(())
2963 }
2964
2965 /// A thread-local variable on Windows, which is four loads and no call.
2966 ///
2967 /// `_tls_index` is this image's slot in the array of `.tls` copies the thread block holds at
2968 /// `%gs:88`, and the variable is as far into this thread's copy as it is into the section. The
2969 /// C runtime defines the index and the linker writes the offset. See [`crate::select::Indexed`] for
2970 /// the four instructions, which are the ones gcc writes.
2971 fn thread_indexed(
2972 &mut self,
2973 inst: Inst,
2974 symbol: Symbol,
2975 result: Value,
2976 ) -> Result<(), Unsupported> {
2977 if let Some(teb) = self.selector.symbols.teb.as_ref() {
2978 return self.thread_from_teb(inst, teb, symbol, result);
2979 }
2980 let Some(indexed) = self.selector.symbols.indexed.as_ref() else {
2981 return Err(Unsupported::Unported { inst: Some(inst), what: Unported::Thread });
2982 };
2983 let block = self.at.expect("a block is being filled");
2984 let span = self.source.span(inst);
2985 let gpr = self.gpr;
2986
2987 let slot = self.out.new_vreg(gpr);
2988 let tls_index = self.names.intern("_tls_index");
2989 let index = self.named(indexed.index);
2990 self.out.build(block, index).at(span).def(slot, gpr).mem(mir::Mem::of(tls_index)).finish();
2991
2992 let array = self.out.new_vreg(gpr);
2993 let load = self.named(indexed.load);
2994 let at = mir::Mem::in_segment(indexed.segment, indexed.at);
2995 self.out.build(block, load).at(span).def(array, gpr).mem(at).finish();
2996
2997 let copy = self.out.new_vreg(gpr);
2998 let mem =
2999 mir::Mem::at(mir::Operand::read(array, gpr)).indexed(mir::Operand::read(slot, gpr), 8);
3000 self.out.build(block, load).at(span).def(copy, gpr).mem(mem).finish();
3001
3002 let reg = self.new_reg(result);
3003 let add = self.named(indexed.add);
3004 let mem = mir::Mem::section(mir::Operand::read(copy, gpr), symbol);
3005 self.out.build(block, add).at(span).def(reg, gpr).mem(mem).finish();
3006 Ok(())
3007 }
3008
3009 /// [`Self::thread_indexed`] on AArch64, where the TEB is in `x18`. See [`crate::select::Teb`]
3010 /// for the instructions, which are the ones clang writes.
3011 fn thread_from_teb(
3012 &mut self,
3013 inst: Inst,
3014 teb: &crate::select::Teb,
3015 symbol: Symbol,
3016 result: Value,
3017 ) -> Result<(), Unsupported> {
3018 let block = self.at.expect("a block is being filled");
3019 let span = self.source.span(inst);
3020 let gpr = self.gpr;
3021
3022 let slot = self.out.new_vreg(gpr);
3023 let tls_index = self.names.intern("_tls_index");
3024 let index = self.named(teb.index);
3025 self.out.build(block, index).at(span).def(slot, gpr).symbol(tls_index).finish();
3026
3027 let array = self.out.new_vreg(gpr);
3028 let load = self.named(teb.array);
3029 self.out.build(block, load).at(span).def(array, gpr).finish();
3030
3031 let reg = self.new_reg(result);
3032 let add = self.named(teb.block);
3033 self.out
3034 .build(block, add)
3035 .at(span)
3036 .operand(mir::Operand::write(reg, gpr))
3037 .operand(mir::Operand::read(array, gpr))
3038 .operand(mir::Operand::read(slot, gpr))
3039 .symbol(symbol)
3040 .finish();
3041 Ok(())
3042 }
3043
3044 /// Refuses the thread pointer where it is not written, which is Mach-O. Apple keeps it in a
3045 /// different register from the one Linux does on both machines, and nothing written for it
3046 /// has been checked on one.
3047 fn threads_written(&self, inst: Inst) -> Result<(), Unsupported> {
3048 if self.elsewhere.described() || self.elsewhere.indexed() {
3049 return Err(Unsupported::Unported { inst: Some(inst), what: Unported::Thread });
3050 }
3051 Ok(())
3052 }
3053
3054 /// The front of this thread's block into `reg`.
3055 ///
3056 /// On x86-64 that is the one thing no instruction can work out: `%fs` is not a register a
3057 /// program can read, and what it points at is a word holding its own address, so reading
3058 /// through it at zero is how the address is come by. AArch64 keeps it in `tpidr_el0`, which
3059 /// `mrs` reads.
3060 fn read_thread_pointer(&mut self, block: mir::Block, span: Span, reg: mir::Reg) {
3061 let gpr = self.gpr;
3062 match self.selector.symbols.pointer {
3063 Pointer::Segment(name, segment) => {
3064 let load = self.named(name);
3065 let at = mir::Mem::in_segment(segment, 0);
3066 self.out.build(block, load).at(span).def(reg, gpr).mem(at).finish();
3067 }
3068 Pointer::Own(name) => {
3069 let read = self.named(name);
3070 self.out.build(block, read).at(span).def(reg, gpr).finish();
3071 }
3072 }
3073 }
3074
3075 /// `&&label`, GNU's address of a label, which is the same `lea` a global gets against a place
3076 /// in this same function.
3077 ///
3078 /// What the two have in common is the whole of the instruction: an address worked out from
3079 /// where the instruction is, which is what `(%rip)` means and is the only way this compiler
3080 /// reaches anything. What they do not have in common is what fills the four bytes in. A
3081 /// global is a name, so the number is a relocation and the linker writes it. A block is a
3082 /// place in this function, so both ends are in one section and the number is known as soon as
3083 /// the blocks have been laid out, which is why `rucc_asm` fills it in the way it fills in a
3084 /// jump rather than leaving a relocation behind.
3085 ///
3086 /// Nothing here says the block is one control can arrive at. That is said by the
3087 /// [`Opcode::IndirectBr`] that reads the address, which lists every block it can arrive at,
3088 /// and by nothing else: an address on its own is a number.
3089 fn block_address(&mut self, inst: Inst) -> Result<(), Unsupported> {
3090 let result = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
3091 let Some(call) = self.source.successors(inst).next() else {
3092 return Err(self.unsupported(inst));
3093 };
3094 let block = self.at.expect("a block is being filled");
3095 let reg = self.new_reg(result);
3096 let span = self.source.span(inst);
3097 let opcode = self.named(self.selector.jumps.near);
3098 let mem = mir::Mem::block(self.out_block(call.block));
3099 self.out.build(block, opcode).at(span).def(reg, self.gpr).mem(mem).finish();
3100 Ok(())
3101 }
3102
3103 /// `goto *p`, GNU's computed goto, which is a jump through a register.
3104 ///
3105 /// Where it goes is not written here and cannot be. Every block it can arrive at is on the
3106 /// block this ends, the way every other arm is, and which of them the address holds is decided
3107 /// while the program runs. So this is one instruction with one operand, and the arms are
3108 /// copied across by [`Self::edges`] like anybody else's.
3109 fn indirect_branch(&mut self, inst: Inst) -> Result<(), Unsupported> {
3110 let data = &self.source[inst];
3111 let &address = self.source[data.args].first().ok_or_else(|| self.unsupported(inst))?;
3112 let reg = self.reg_of(address)?;
3113 let block = self.at.expect("a block is being filled");
3114 let span = self.source.span(inst);
3115 let name = self.selector.branch.indirect;
3116 let opcode = self.named(name);
3117 self.out.build(block, opcode).at(span).operand(mir::Operand::read(reg, self.gpr)).finish();
3118 Ok(())
3119 }
3120
3121 /// A `switch` on an index from zero up, as a jump through a table of this function.
3122 ///
3123 /// Every `switch` that reaches here is one `crate::switch` left behind on purpose: it has
3124 /// already checked the value is inside the table and taken the lowest case off it, so the
3125 /// operand is a 64 bit index, the cases are the values from zero up with gaps where the
3126 /// program had no case, and the default is only where those gaps go. What is written is the
3127 /// shape gcc writes for the same statement in position independent code:
3128 ///
3129 /// ```text
3130 /// leaq table(%rip), %base
3131 /// movslq (%base,%index,4), %offset
3132 /// addq %base, %offset
3133 /// jmp *%offset
3134 /// ```
3135 ///
3136 /// The table holds distances from itself to each arm rather than addresses, which is what
3137 /// lets it be filled in by the assembler with nothing left for a linker to do. Each cell is
3138 /// stored as the place of an arm among this block's successors, which [`Self::edges`] copies
3139 /// across in the IR's own order, the default first and then one per case. See
3140 /// [`mir::Table`] for why a place and not a block.
3141 fn jump_table(&mut self, inst: Inst) -> Result<(), Unsupported> {
3142 let data = &self.source[inst];
3143 let Extra::Switch(info) = data.extra else { return Err(self.unsupported(inst)) };
3144 let &index = self.source[data.args].first().ok_or_else(|| self.unsupported(inst))?;
3145 let ty = self.source[index].ty;
3146 if ty != Type::int(u64::BITS) {
3147 return Err(self.unsupported(inst));
3148 }
3149 let cases = self.source[self.source[info].cases].to_vec();
3150 let mut cells: Vec<u32> = Vec::new();
3151 for (arm, case) in cases.iter().enumerate() {
3152 let at = usize::try_from(case.signed(ty)).map_err(|_| self.unsupported(inst))?;
3153 if at >= cells.len() {
3154 cells.resize(at + 1, 0);
3155 }
3156 cells[at] = u32::try_from(arm + 1).map_err(|_| self.unsupported(inst))?;
3157 }
3158 let reg = self.reg_of(index)?;
3159 let block = self.at.expect("a block is being filled");
3160 let span = self.source.span(inst);
3161 let gpr = self.gpr;
3162 let table = u32::try_from(self.out.tables.len()).expect("fewer tables than that");
3163
3164 let jumps = self.selector.jumps;
3165
3166 let base = self.out.new_vreg(gpr);
3167 let near = self.named(jumps.near);
3168 self.out.build(block, near).at(span).def(base, gpr).mem(mir::Mem::table(table)).finish();
3169 let offset = self.out.new_vreg(gpr);
3170 let cell =
3171 mir::Mem::at(mir::Operand::read(base, gpr)).indexed(mir::Operand::read(reg, gpr), 4);
3172 let load = self.named(jumps.cell);
3173 self.out.build(block, load).at(span).def(offset, gpr).mem(cell).finish();
3174 // Two address on x86-64, for the reason `thread_pointer` gives.
3175 let to = self.out.new_vreg(gpr);
3176 let add = self.named(jumps.add);
3177 let written = mir::Operand::write(to, gpr);
3178 let written = if jumps.two_address { written.with(Constraint::Reuse(1)) } else { written };
3179 self.out
3180 .build(block, add)
3181 .at(span)
3182 .operand(written)
3183 .operand(mir::Operand::read(offset, gpr))
3184 .operand(mir::Operand::read(base, gpr))
3185 .finish();
3186 let jump = self.named(self.selector.branch.indirect);
3187 let jump =
3188 self.out.build(block, jump).at(span).operand(mir::Operand::read(to, gpr)).finish();
3189 self.out.tables.push(mir::Table { jump, cells });
3190 Ok(())
3191 }
3192
3193 /// `__builtin_setjmp`, which writes down where the function is so that a `__builtin_longjmp`
3194 /// somewhere else can bring control back here, and answers zero on the way past.
3195 ///
3196 /// Four words of the buffer, the three gcc writes and one of this compiler's own, and then the
3197 /// block ends: everything after the save in the IR block is put into a new machine IR block,
3198 /// and the address of that block is what went into the buffer. That is the whole reason the
3199 /// block is split here. An address points at a label, a machine IR block is the only thing in
3200 /// this representation that has one, and a save is in the middle of a block rather than at the
3201 /// end of one.
3202 ///
3203 /// # How the answer gets back
3204 ///
3205 /// Through the frame rather than through a register. The save writes a zero into a word of its
3206 /// own frame, puts the address of that word in the buffer, and the new block reads the word
3207 /// back. The restore writes a one through the address it finds in the buffer before it goes.
3208 /// So one load answers zero on the way past and one on the way back, and neither path has to
3209 /// agree with the other about a register.
3210 ///
3211 /// gcc does it the other way round, with a second block that sets the answer to one and is
3212 /// what the restore arrives at. That block is one nothing in the function jumps to, and a
3213 /// machine IR whose blocks are walked from the entry has nowhere to put such a thing: the
3214 /// allocator lays a function out in the line it is going to be emitted in, and a block no edge
3215 /// reaches is not in that line. The word in the frame costs eight bytes of stack and one load,
3216 /// and it needs nothing said anywhere about a block arrived at from outside.
3217 ///
3218 /// # What the allocator is told
3219 ///
3220 /// That every register it hands out is gone at the end of the first block. That is what makes
3221 /// the rest of the function right on the way back: control arrives from a `__builtin_longjmp`
3222 /// in some other function, and the only two registers that puts back are the stack pointer and
3223 /// the frame pointer, so anything this function still wants has to be in the frame those two
3224 /// reach. It is said with a write of every one of those registers, which is the same thing a
3225 /// call says about the registers a callee may destroy, on an instruction with nothing else on
3226 /// it so that the stores above are not caught up in it.
3227 fn saves_place(&mut self, inst: Inst) -> Result<(), Unsupported> {
3228 let data = &self.source[inst];
3229 let result = data.first_result.ok_or_else(|| self.unsupported(inst))?;
3230 let &buffer = self.source[data.args].first().ok_or_else(|| self.unsupported(inst))?;
3231 let span = self.source.span(inst);
3232 let buf = self.reg_of(buffer)?;
3233 let at = self.at.expect("a block is being filled");
3234 let gpr = self.gpr;
3235 let moves = self.selector.frame.moves(gpr).expect("a class the target says how to move");
3236 let store = self.named(moves.store);
3237 let load = self.named(moves.load);
3238 let lea = self.named(self.selector.frame.lea);
3239 let put = self.named(self.selector.frame.imm);
3240 let nothing =
3241 self.selector.frame.pad.expect("a target with an instruction that does nothing");
3242 let nothing = self.named(nothing);
3243 self.stack.saves_place = true;
3244 let answer = self.answer_slot();
3245 let back = self.out.create_block();
3246
3247 // The zero this answers with, into the word a restore writes a one into.
3248 let zero = self.out.new_vreg(gpr);
3249 self.out.build(at, put).at(span).def(zero, gpr).imm(0).finish();
3250 let mem = self.frame_mem();
3251 let made = self.out.build(at, store).at(span).uses(zero, gpr).mem(mem).finish();
3252 self.stack.addresses.push((made, answer));
3253
3254 // The four words: where that word is, where control comes back to, and the two registers
3255 // the restore puts back.
3256 let found = self.frame_address(at, answer);
3257 self.write_word(at, span, store, found, buf, JUMP_ANSWER);
3258 let pc = self.out.new_vreg(gpr);
3259 self.out.build(at, lea).at(span).def(pc, gpr).mem(mir::Mem::block(back)).finish();
3260 self.write_word(at, span, store, pc, buf, JUMP_PC);
3261 let frame = mir::Reg::physical(self.conv.frame_pointer);
3262 self.write_word(at, span, store, frame, buf, JUMP_FRAME);
3263 let stack = mir::Reg::physical(self.conv.stack_pointer);
3264 self.write_word(at, span, store, stack, buf, JUMP_STACK);
3265
3266 // Nothing is in a register past this point, which is what the rest of the function is
3267 // allowed to assume about the way back in.
3268 let gone = self.across_jump();
3269 let mut build = self.out.build(at, nothing).at(span);
3270 for (reg, class) in gone {
3271 build = build.operand(mir::Operand::write(reg, class));
3272 }
3273 build.finish();
3274
3275 // And the rest of the block, which is the block the address above was of.
3276 *self.out.succs_mut(at) = vec![mir::BlockCall::to(back)];
3277 self.at = Some(back);
3278 let reg = self.new_reg(result);
3279 let mem = self.frame_mem();
3280 let made = self.out.build(back, load).at(span).def(reg, gpr).mem(mem).finish();
3281 self.stack.addresses.push((made, answer));
3282 Ok(())
3283 }
3284
3285 /// `__builtin_longjmp`, which reads a buffer a `__builtin_setjmp` filled in and goes there.
3286 ///
3287 /// Everything comes out of the buffer before anything is put back, and the four registers it
3288 /// comes out into are physical ones rather than values the allocator places. Both of those are
3289 /// about the same moment. The stack pointer is one of the things being put back, a value the
3290 /// allocator sent to the stack is reached through the stack pointer, and between the
3291 /// instruction that moves it and the jump there is no stack this function owns any more. A
3292 /// register named outright is a register nothing reloads into and nothing else is in, which is
3293 /// the only way to hold something across that moment.
3294 ///
3295 /// Four of them because that is how many things are in the air at once: where to go, the frame
3296 /// pointer to put back, the one the matching save is to answer with, and one register used
3297 /// twice, first for the address that one is written through and then for the stack pointer.
3298 ///
3299 /// Nothing after this in the block is reached. The marker is not a terminator, for the reason
3300 /// `spec/08-ir.md` gives, so the block goes on and whatever the front end wrote after it is
3301 /// written out and never run.
3302 fn comes_back(&mut self, inst: Inst) -> Result<(), Unsupported> {
3303 let data = &self.source[inst];
3304 let &buffer = self.source[data.args].first().ok_or_else(|| self.unsupported(inst))?;
3305 let span = self.source.span(inst);
3306 let buf = self.reg_of(buffer)?;
3307 let at = self.at.expect("a block is being filled");
3308 let gpr = self.gpr;
3309 let moves = self.selector.frame.moves(gpr).expect("a class the target says how to move");
3310 let load = self.named(moves.load);
3311 let store = self.named(moves.store);
3312 let mov = self.named(moves.mov);
3313 let put = self.named(self.selector.frame.imm);
3314 let jump = self.named(self.selector.branch.indirect);
3315
3316 let held = self.jump_regs();
3317 if held.len() < JUMP_REGS {
3318 return Err(self.unsupported(inst));
3319 }
3320 let pc = mir::Reg::physical(held[0]);
3321 let frame = mir::Reg::physical(held[1]);
3322 let spare = mir::Reg::physical(held[2]);
3323 let one = mir::Reg::physical(held[3]);
3324
3325 self.read_word(at, span, load, pc, buf, JUMP_PC);
3326 self.read_word(at, span, load, frame, buf, JUMP_FRAME);
3327 self.read_word(at, span, load, spare, buf, JUMP_ANSWER);
3328
3329 // What the matching save answers with, written through the address that came out of the
3330 // buffer, because the word it goes in is in the other function's frame and this one has no
3331 // way of knowing where that is.
3332 self.out.build(at, put).at(span).def(one, gpr).imm(1).finish();
3333 let mem = mir::Mem::at(mir::Operand::read(spare, gpr));
3334 self.out.build(at, store).at(span).uses(one, gpr).mem(mem).finish();
3335
3336 // The stack last of the four, so that the register the buffer is reached through is done
3337 // with before the stack it may have been spilled to stops being this function's.
3338 self.read_word(at, span, load, spare, buf, JUMP_STACK);
3339 let stack = mir::Reg::physical(self.conv.stack_pointer);
3340 self.copy(at, span, mov, stack, spare);
3341 let base = mir::Reg::physical(self.conv.frame_pointer);
3342 self.copy(at, span, mov, base, frame);
3343
3344 // And the jump, which reads the two registers just put back as well as the address it
3345 // goes through. Neither of those is printed, because the target's spelling of an indirect
3346 // jump has one argument and it is the first one read. They are there because the code
3347 // control arrives at reaches its frame through them, and because without them the two
3348 // instructions above write registers nothing reads: a scheduler is then free to put the
3349 // jump in front of them, and at `-O2` it does.
3350 self.out
3351 .build(at, jump)
3352 .at(span)
3353 .operand(mir::Operand::read(pc, gpr))
3354 .operand(mir::Operand::read(stack, gpr))
3355 .operand(mir::Operand::read(base, gpr))
3356 .finish();
3357 Ok(())
3358 }
3359
3360 /// One word of the buffer of a `__builtin_setjmp`, written from a register.
3361 fn write_word(
3362 &mut self,
3363 at: mir::Block,
3364 span: Span,
3365 store: mir::Opcode,
3366 from: mir::Reg,
3367 buf: mir::Reg,
3368 word: i32,
3369 ) {
3370 let mem = mir::Mem::at(mir::Operand::read(buf, self.gpr)).plus(word);
3371 self.out.build(at, store).at(span).uses(from, self.gpr).mem(mem).finish();
3372 }
3373
3374 /// One word of that buffer, read back into a register.
3375 fn read_word(
3376 &mut self,
3377 at: mir::Block,
3378 span: Span,
3379 load: mir::Opcode,
3380 into: mir::Reg,
3381 buf: mir::Reg,
3382 word: i32,
3383 ) {
3384 let mem = mir::Mem::at(mir::Operand::read(buf, self.gpr)).plus(word);
3385 self.out.build(at, load).at(span).def(into, self.gpr).mem(mem).finish();
3386 }
3387
3388 /// One register into another, which is the one shape of instruction the builder has no word
3389 /// for because neither operand is a definition of a value or a read of memory.
3390 fn copy(
3391 &mut self,
3392 at: mir::Block,
3393 span: Span,
3394 mov: mir::Opcode,
3395 into: mir::Reg,
3396 from: mir::Reg,
3397 ) {
3398 self.out
3399 .build(at, mov)
3400 .at(span)
3401 .operand(mir::Operand::write(into, self.gpr))
3402 .operand(mir::Operand::read(from, self.gpr))
3403 .finish();
3404 }
3405
3406 /// The word a `__builtin_setjmp` in this function answers with, asked for once and kept.
3407 fn answer_slot(&mut self) -> usize {
3408 match self.answer {
3409 Some(index) => index,
3410 None => {
3411 let index = self.stack.locals.len();
3412 self.stack.locals.push(Local { size: JUMP_WORD, align: JUMP_WORD });
3413 self.answer = Some(index);
3414 index
3415 }
3416 }
3417 }
3418
3419 /// An address in this function's frame with nothing in its displacement, which is what an
3420 /// instruction reaching one of its stack objects is written with until [`crate::finish`] knows
3421 /// where the object is.
3422 fn frame_mem(&self) -> mir::Mem {
3423 mir::Mem::at(mir::Operand::read(mir::Reg::physical(self.conv.stack_pointer), self.gpr))
3424 }
3425
3426 /// Every register the allocator hands out, which is what a `__builtin_setjmp` destroys.
3427 ///
3428 /// Both files, since a `double` live across a save has the same problem an integer does. The
3429 /// two registers a frame is reached through are not here: the restore puts both of them back,
3430 /// which is the whole of what it puts back, and a function whose frame pointer was destroyed
3431 /// by its own save would have nothing left to find its caller with.
3432 fn across_jump(&self) -> Vec<(mir::Reg, RegClass)> {
3433 let mut gone = Vec::new();
3434 for ® in self.conv.int_order {
3435 if reg == self.conv.stack_pointer || reg == self.conv.frame_pointer {
3436 continue;
3437 }
3438 gone.push((mir::Reg::physical(reg), self.gpr));
3439 }
3440 for ® in self.conv.sse_order {
3441 gone.push((mir::Reg::physical(reg), self.conv.sse_class));
3442 }
3443 gone
3444 }
3445
3446 /// The registers a `__builtin_longjmp` may hold things in while it puts a frame back.
3447 ///
3448 /// The ones the allocator hands out, less the two a frame is reached through. The scratch
3449 /// registers are not among them on purpose: the rewriter writes a reload into one of those
3450 /// wherever it likes, and one of these has to survive from the load that fills it to the
3451 /// instruction that reads it however many instructions apart those are.
3452 fn jump_regs(&self) -> Vec<PhysReg> {
3453 self.conv
3454 .int_order
3455 .iter()
3456 .copied()
3457 .filter(|®| {
3458 reg != self.conv.stack_pointer
3459 && reg != self.conv.frame_pointer
3460 && !self.selector.scratch.contains(®)
3461 })
3462 .collect()
3463 }
3464
3465 /// A machine opcode of this target from the name the target gives it.
3466 fn named(&mut self, name: &str) -> mir::Opcode {
3467 mir::Opcode::new(self.names.intern(&format!("{}{name}", self.selector.prefix())))
3468 }
3469
3470 /// `__builtin_frame_address` and `__builtin_return_address`, which are a walk up the chain of
3471 /// saved frame pointers and then one thing read at the end of it.
3472 ///
3473 /// Every frame that kept a frame pointer holds the caller's at the address the register points
3474 /// at, and the address that frame returns to one word above that, which is where the call
3475 /// instruction put it and where the prologue's push left it. So the walk is a load through the
3476 /// register for each link, the frame address is wherever the walk stopped, and the return
3477 /// address is one more load from a word above it. gcc 16.2.0 writes exactly this, measured on
3478 /// x86-64 at `-O2` for depths zero to three of both builtins.
3479 ///
3480 /// The function is given a frame pointer because of this, which is what [`Stack::walks_frames`]
3481 /// carries out to the layout. A depth of zero needs it as the answer and every depth above zero
3482 /// needs it as the start, so there is no case here where it is not wanted.
3483 ///
3484 /// How far the chain actually reaches is the program's business and not this one's. A caller
3485 /// compiled without a frame pointer has no link in it for the walk to follow, so a depth above
3486 /// zero is a promise about how the whole program was built. That is why gcc documents a nonzero
3487 /// depth as unsafe rather than as an answer, and why the depth is refused above a limit in
3488 /// `check/builtin/frame.rs` rather than walked as far as it says.
3489 fn frames(&mut self, inst: Inst) -> Result<(), Unsupported> {
3490 let data = &self.source[inst];
3491 let Extra::Depth(depth) = data.extra else { return Err(self.unsupported(inst)) };
3492 let result = data.first_result.ok_or_else(|| self.unsupported(inst))?;
3493 let returning = data.opcode == Opcode::ReturnAddress;
3494 let block = self.at.expect("a block is being filled");
3495 let span = self.source.span(inst);
3496 let moves =
3497 self.selector.frame.moves(self.gpr).expect("a class the target says how to move");
3498 let load = self.named(moves.load);
3499 self.stack.walks_frames = true;
3500
3501 // Where the walk is up to. The frame pointer to begin with, and the register the last load
3502 // wrote after that.
3503 let reg = self.new_reg(result);
3504 let mut base = mir::Reg::physical(self.conv.frame_pointer);
3505 for link in 0..depth {
3506 // The last load of a walk that is looking for a frame writes the answer itself, which
3507 // is what keeps a walk of so many links that many instructions and not one more.
3508 let ends_here = link + 1 == depth && !returning;
3509 let next = if ends_here { reg } else { self.out.new_vreg(self.gpr) };
3510 let at = mir::Mem::at(mir::Operand::read(base, self.gpr));
3511 self.out.build(block, load).at(span).def(next, self.gpr).mem(at).finish();
3512 base = next;
3513 }
3514
3515 if returning {
3516 let up = i32::try_from(self.conv.return_address).expect("a word above the frame");
3517 let at = mir::Mem::at(mir::Operand::read(base, self.gpr)).plus(up);
3518 self.out.build(block, load).at(span).def(reg, self.gpr).mem(at).finish();
3519 } else if depth == 0 {
3520 // The one case with no load in it at all: the frame this function is running in is the
3521 // register itself, and a physical register is not one the allocator hands out, so the
3522 // answer is a copy of it.
3523 let mov = self.named(moves.mov);
3524 self.out
3525 .build(block, mov)
3526 .at(span)
3527 .operand(mir::Operand::write(reg, self.gpr))
3528 .operand(mir::Operand::read(base, self.gpr))
3529 .finish();
3530 }
3531 Ok(())
3532 }
3533
3534 /// `__builtin_thread_pointer`, which is the front of the block [`Self::thread_address`] adds
3535 /// an offset to.
3536 ///
3537 /// The same one instruction, on its own this time and with nothing to add to it. A program
3538 /// writes this when what it wants is a number that is different in every thread and cheap to
3539 /// come by, rather than a variable of its own in the block, so there is no relocation here and
3540 /// no name for the link to resolve.
3541 fn thread_pointer(&mut self, inst: Inst) -> Result<(), Unsupported> {
3542 self.threads_written(inst)?;
3543 let result = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
3544 let block = self.at.expect("a block is being filled");
3545 let span = self.source.span(inst);
3546 let reg = self.new_reg(result);
3547 self.read_thread_pointer(block, span, reg);
3548 Ok(())
3549 }
3550
3551 /// `__builtin_sponentry`, the stack pointer this function was entered with.
3552 ///
3553 /// On AArch64 that is where the caller's arguments on the stack start, so it is the address
3554 /// of the first of them, recorded at zero the way [`Self::overflow`] records the first one the
3555 /// signature did not name and finished with the rest once the frame is laid out. Sema refuses
3556 /// the builtin on every other machine, and this does too, since on x86-64 the return address
3557 /// sits between the two and zero would be the wrong answer.
3558 fn sp_entry(&mut self, inst: Inst) -> Result<(), Unsupported> {
3559 if !self.on_aarch64() {
3560 return Err(self.unsupported(inst));
3561 }
3562 let result = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
3563 let block = self.at.expect("a block is being filled");
3564 let span = self.source.span(inst);
3565 let reg = self.new_reg(result);
3566 let lea = self.named(self.selector.frame.lea);
3567 let sp = mir::Operand::read(mir::Reg::physical(self.conv.stack_pointer), self.gpr);
3568 let made =
3569 self.out.build(block, lea).at(span).def(reg, self.gpr).mem(mir::Mem::at(sp)).finish();
3570 self.stack.arguments.push((made, 0));
3571 Ok(())
3572 }
3573
3574 /// What a named machine register holds, which is `register long x asm ("rbx");`.
3575 ///
3576 /// One move out of that register, with the register named as itself the way a register a
3577 /// template wrote is named, which is [`Self::itself`] and is the thing #1653 built. What it
3578 /// buys here is what it buys there: the register is part of the instruction the allocator
3579 /// sees, so it is a use the allocator will not have written over first, and the value goes
3580 /// into an ordinary one of its own that everything downstream reads.
3581 ///
3582 /// The whole sixty four bits are moved whatever the type is, because the register is that
3583 /// wide and a narrower type reads the low end of the copy, which is the same low end. A type
3584 /// wider than the register is refused, since there is no register holding it to read. On
3585 /// AArch64 a float may be kept in a vector register, `register double x asm ("d8");`, and it is
3586 /// moved out of that file the same way.
3587 ///
3588 /// A name the machine has not got is refused too, and is the only thing that can be wrong
3589 /// with the string: which register a name means is this machine's question and this is where
3590 /// the question is asked, at the same table `asm` asks about clobbers at. The sigil gcc
3591 /// allows in front of it is taken off here, because what the name is written with is syntax.
3592 fn register_value(&mut self, inst: Inst) -> Result<(), Unsupported> {
3593 let Extra::Symbol(symbol) = self.source[inst].extra else {
3594 return Err(self.unsupported(inst));
3595 };
3596 let result = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
3597 let ty = self.source[result].ty;
3598 let bits = if ty.is_ptr() { ADDRESS_BITS } else { ty.bits() };
3599 if bits > ADDRESS_BITS {
3600 return Err(self.unsupported(inst));
3601 }
3602 let spelled = self.names.resolve(symbol).to_owned();
3603 let bare = spelled.strip_prefix('%').unwrap_or(&spelled);
3604 let named = if self.on_aarch64() {
3605 aarch64::named(bare)
3606 } else if self.class_of(ty) != self.gpr {
3607 return Err(self.unsupported(inst));
3608 } else {
3609 x86_64::gpr_named(bare).map(|(reg, _)| (reg, self.gpr))
3610 };
3611 let Some((held, file)) = named else {
3612 return Err(Unsupported::Register { inst, name: spelled });
3613 };
3614 // A float in a general purpose register, or a number in a vector one, is a register the
3615 // machine has holding a type that is not kept there, and would need a move between the
3616 // files that nothing here makes yet.
3617 if on_x87(ty) || self.class_of(ty) != file {
3618 return Err(self.unsupported(inst));
3619 }
3620 let block = self.at.expect("a block is being filled");
3621 let span = self.source.span(inst);
3622 let mov = self.selector.frame.moves(file).expect("a class the target says how to move").mov;
3623 let mov = self.named(mov);
3624 let into = self.new_reg(result);
3625 self.out
3626 .build(block, mov)
3627 .at(span)
3628 .operand(mir::Operand::write(into, file))
3629 .operand(
3630 mir::Operand::read(mir::Reg::physical(held), file).with(Constraint::Fixed(held)),
3631 )
3632 .finish();
3633 Ok(())
3634 }
3635
3636 /// A conversion that converts nothing: the result is the operand under another type.
3637 ///
3638 /// `ptrtoint` and `inttoptr` at one width are the whole of this. An address on this machine is
3639 /// an integer as wide as the machine addresses, so a cast between the two changes what the
3640 /// type system calls the value and changes nothing about the value, and the register holding
3641 /// it is the register that already held it. The front end never writes either of them at any
3642 /// other width, because it widens or narrows around the cast rather than through it, so the
3643 /// two widths disagreeing here means the IR came from somewhere else and is refused rather
3644 /// than guessed at.
3645 ///
3646 /// Reading the operand first is what materializes it when it is a constant, which is the case
3647 /// that matters: a null pointer is an `inttoptr` of zero, and that zero has to reach a
3648 /// register before anything can call it an address.
3649 fn rename(&mut self, inst: Inst) -> Result<(), Unsupported> {
3650 let data = &self.source[inst];
3651 let [arg] = self.source[data.args] else { return Err(self.unsupported(inst)) };
3652 let result = data.first_result.ok_or_else(|| self.unsupported(inst))?;
3653 if !self.is_address_width(self.source[arg].ty)
3654 || !self.is_address_width(self.source[result].ty)
3655 {
3656 return Err(self.unsupported(inst));
3657 }
3658 let reg = self.reg_of(arg)?;
3659 self.regs[result.index()] = Some(reg);
3660 Ok(())
3661 }
3662
3663 /// One barrier, which on this machine is one instruction at the strongest ordering and no
3664 /// instruction at all at every other one.
3665 ///
3666 /// x86-64 is total store order, so the only reordering the machine does is a store followed by
3667 /// a load of a different address, and the only ordering that forbids that is sequential
3668 /// consistency. An acquire, a release and an acquire release fence are therefore already true
3669 /// of every program running here, and what a program wanted from writing one is that the
3670 /// compiler not move memory accesses across it. The optimizer has finished by the time this
3671 /// runs and nothing below reorders one access past another, so the constraint is already
3672 /// discharged and there is nothing to write.
3673 ///
3674 /// The strongest one is `mfence`, which is what gcc 16.2.0 writes for
3675 /// `__atomic_thread_fence(__ATOMIC_SEQ_CST)` and for `__sync_synchronize`. A locked instruction
3676 /// on the stack is faster on most parts and is what some compilers write instead; it is also a
3677 /// write to memory the program did not ask for, and the plain barrier is the one that says what
3678 /// it means.
3679 ///
3680 /// Written here by name rather than by a rule, for the same reason a `lea` of a symbol is:
3681 /// there is nothing in a barrier that a proof over bitvectors could discharge. It computes
3682 /// nothing, so there is no equality to state, and what makes it the right answer is the memory
3683 /// model, which the rule language cannot talk about.
3684 fn barrier(&mut self, inst: Inst) -> Result<(), Unsupported> {
3685 let Extra::Order(order) = self.source[inst].extra else {
3686 return Err(self.unsupported(inst));
3687 };
3688 // AArch64 is not total store order, so every ordering above relaxed is an instruction
3689 // there. An acquire fence only has to keep later accesses after earlier loads, which is
3690 // `dmb ishld`, and everything stronger is the full `dmb ish` gcc writes for it.
3691 let name = match order {
3692 MemOrder::NotAtomic | MemOrder::Relaxed => return Ok(()),
3693 MemOrder::Acquire if self.on_aarch64() => "fence_acquire",
3694 _ if self.on_aarch64() => self.selector.fence,
3695 MemOrder::SeqCst => self.selector.fence,
3696 _ => return Ok(()),
3697 };
3698 let block = self.at.expect("a block is being filled");
3699 let span = self.source.span(inst);
3700 let fence = self.named(name);
3701 self.out.build(block, fence).at(span).finish();
3702 Ok(())
3703 }
3704
3705 /// The instruction a program stops on, which is one byte pair and no operands.
3706 ///
3707 /// `ud2` is an opcode the manual promises will never be given a meaning, so a processor that
3708 /// reaches it raises the fault for an instruction it does not know, and on Linux that arrives
3709 /// at the program as `SIGILL`. That is what `__builtin_trap` is for: a stop that cannot be
3710 /// caught by anything the program installed for an ordinary error, cannot be returned from,
3711 /// and leaves the address of the fault in the core file.
3712 ///
3713 /// Why not a call to `abort`. It is two bytes against a call and a relocation, it needs no
3714 /// library, and it works in the places this one is written most, which are a kernel and a
3715 /// freestanding program that has no `abort` to call. gcc 16.2.0 writes `ud2` here too.
3716 fn trap(&mut self, inst: Inst) {
3717 let block = self.at.expect("a block is being filled");
3718 let span = self.source.span(inst);
3719 let stop = self.named(self.selector.trap);
3720 self.out.build(block, stop).at(span).finish();
3721 }
3722
3723 /// One hint that an address is about to be used, which is one instruction and no promise.
3724 ///
3725 /// Four instructions on this machine and the locality picks between them, which is what the
3726 /// number means: how much of the data will still be wanted after the access. None of it wanted
3727 /// is `prefetchnta`, which brings the line in without keeping it, and all of it wanted is
3728 /// `prefetcht0`, which brings it as close as the machine can. The two in between are the levels
3729 /// between those. Measured against gcc 16.2.0 on x86-64 rather than read off the manual: zero
3730 /// gives `prefetchnta`, one `prefetcht2`, two `prefetcht1` and three `prefetcht0`.
3731 ///
3732 /// Whether the access will write is not read on x86-64, and that is the machine rather than an
3733 /// omission. The write hint is `prefetchw`, which is not in the base instruction set, and gcc
3734 /// writes it only when the command line said the part has it. So a prefetch for a write is the
3735 /// same instruction as a prefetch for a read, which is what gcc 16.2.0 writes without
3736 /// `-mprfchw`. AArch64 has it in the base set, so there a write picks the four `pst` forms of
3737 /// `prfm` in place of the `pld` ones, at the same levels.
3738 ///
3739 /// The address goes in the addressing mode rather than in an operand, the way a store's does.
3740 /// It is built here as the plainest one there is, a register and nothing else, because what
3741 /// arrives is a value and folding an addition into the mode is a rule's job and no rule reaches
3742 /// this instruction. An address the program computed is therefore one `lea` or one add in front
3743 /// of this, which is what it would have been for the load the hint is about anyway.
3744 fn hint(&mut self, inst: Inst) -> Result<(), Unsupported> {
3745 let Extra::Prefetch(hint) = self.source[inst].extra else {
3746 return Err(self.unsupported(inst));
3747 };
3748 let args: Vec<Value> = self.source[self.source[inst].args].to_vec();
3749 let [address] = args[..] else { return Err(self.unsupported(inst)) };
3750 // AArch64 has the write hint in the base instruction set, and gcc 16.2.0 writes it there.
3751 let write = hint.write && self.on_aarch64();
3752 let name = match (hint.locality, write) {
3753 (0, false) => "prefetch_nta",
3754 (1, false) => "prefetch_t2",
3755 (2, false) => "prefetch_t1",
3756 (PrefetchHint::MOST, false) => "prefetch_t0",
3757 (0, true) => "prefetch_w_nta",
3758 (1, true) => "prefetch_w_t2",
3759 (2, true) => "prefetch_w_t1",
3760 (PrefetchHint::MOST, true) => "prefetch_w_t0",
3761 // Nothing else exists. The checker reads a locality outside the range as zero and the
3762 // verifier refuses one that got here another way, so this is a hint that was built
3763 // rather than checked, and the safe answer for a hint is to write no instruction.
3764 _ => return Err(self.unsupported(inst)),
3765 };
3766 let base = self.reg_of(address)?;
3767 let block = self.at.expect("a block is being filled");
3768 let opcode = self.named(name);
3769 self.out
3770 .build(block, opcode)
3771 .at(self.source.span(inst))
3772 .mem(mir::Mem::at(mir::Operand::read(base, self.gpr)))
3773 .finish();
3774 Ok(())
3775 }
3776
3777 /// One compare and exchange, which is the instruction every other atomic on this machine is
3778 /// built out of.
3779 ///
3780 /// What the IR asks for is: read what is at an address, compare it against a value the program
3781 /// expected, put a second value there if the two were equal, and say both what was read and
3782 /// whether the exchange happened. The machine has exactly that instruction, and the `lock` in
3783 /// front of it is what makes the whole of it one step as far as every other processor is
3784 /// concerned.
3785 ///
3786 /// The ordering is not read here, and that is the memory model rather than an omission. A
3787 /// locked instruction on x86-64 is a full barrier whatever the program asked for, so a relaxed
3788 /// compare and exchange and a sequentially consistent one are the same instruction, and there
3789 /// is nothing weaker to emit for the weaker orderings. The failure ordering is not read for the
3790 /// same reason.
3791 ///
3792 /// The two values it produces are why this is written by name. The one the program compares
3793 /// against and the one it gets back are both `rax`, which the instruction reads and writes
3794 /// without being told, and the table says so with a fixed constraint at each end rather than
3795 /// leaving the allocator to find out. The second value is the byte behind it, which is the zero
3796 /// flag read out by a `sete`, and it is a definition of the same instruction so that the
3797 /// allocator knows the two are live together and never gives the byte the register the answer
3798 /// is in.
3799 fn exchange(&mut self, inst: Inst) -> Result<(), Unsupported> {
3800 let args: Vec<Value> = self.source[self.source[inst].args].to_vec();
3801 let results: Vec<Value> = self.source[inst].results().collect();
3802 let [addr, expected, desired] = args[..] else { return Err(self.unsupported(inst)) };
3803 let [old, exchanged] = results[..] else { return Err(self.unsupported(inst)) };
3804 if self.on_aarch64() {
3805 return self.exchange_a64(inst, [addr, expected, desired], [old, exchanged]);
3806 }
3807
3808 // A value the machine can compare in one instruction, which is an integer or an address at
3809 // one of the four widths it has a compare and exchange for. Anything else is a type this
3810 // has no instruction for rather than a program that is wrong, and the front end refuses it
3811 // before ever getting here.
3812 let ty = self.source[old].ty;
3813 let bits = if ty.is_ptr() { ADDRESS_BITS } else { ty.bits() };
3814 if (!ty.is_int() && !ty.is_ptr()) || !matches!(bits, 8 | 16 | 32 | 64) {
3815 return Err(self.unsupported(inst));
3816 }
3817
3818 let base = self.reg_of(addr)?;
3819 let want = self.reg_of(expected)?;
3820 let put = self.reg_of(desired)?;
3821 let got = self.new_reg(old);
3822 let flag = self.new_reg(exchanged);
3823
3824 let name = format!("cmpxchg_{bits}");
3825 let descs = self.selector.operands(&name).ok_or_else(|| self.unsupported(inst))?;
3826 let block = self.at.expect("a block is being filled");
3827 let opcode = self.named(&name);
3828 let (span, flags) = (self.source.span(inst), self.carried(inst));
3829 let mut build = self.out.build(block, opcode).at(span).flags(flags);
3830 for (desc, reg) in descs.iter().zip([got, flag, want, put]) {
3831 let operand = mir::Operand {
3832 reg,
3833 class: desc.class,
3834 role: desc.role,
3835 constraint: desc.constraint,
3836 };
3837 build = build.operand(operand);
3838 }
3839 build.mem(mir::Mem::at(mir::Operand::read(base, self.gpr))).finish();
3840 Ok(())
3841 }
3842
3843 /// One read modify write, for the three operations this machine does in a single instruction.
3844 ///
3845 /// What the IR asks for is: read what is at an address, do something to it, put the answer back,
3846 /// say what was there before, and let nothing get between the three steps. The machine has
3847 /// `xchg` for putting a value there and `lock xadd` for adding one, and both leave what they
3848 /// found in the register the operand arrived in, which is why the value that comes back and the
3849 /// value that went in are one register here.
3850 ///
3851 /// A subtraction is the add over the negated operand, which is right at every width because the
3852 /// machine's arithmetic wraps and negating then adding is subtracting in two's complement
3853 /// whatever the operands were. The negate is a separate instruction in front, over a register of
3854 /// its own, so that the value the program handed over is not the one written on: an operand may
3855 /// be live after this and a program that read it again would read the negation.
3856 ///
3857 /// The ordering is not read, for the reason the compare and exchange beside this does not read
3858 /// it. `xchg` with memory locks the bus whether it is asked to or not and `lock xadd` is asked
3859 /// to, so both are full barriers on this machine and there is nothing weaker to fall to.
3860 ///
3861 /// Eight of the other ten never arrive, because `crate::retry` turned each of them into a loop
3862 /// around a compare and exchange before anything here saw it. The two that do arrive are the
3863 /// ones on floating values, and they are refused: a compare and exchange of a float wants the
3864 /// value carried through an integer of the same width, and an eighty bit float has no such
3865 /// width. Neither family of builtins can write one yet either, so a program that reaches this
3866 /// refusal is a program that reached an unimplemented builtin first.
3867 fn modify(&mut self, inst: Inst) -> Result<(), Unsupported> {
3868 let Extra::Rmw(op, _) = self.source[inst].extra else {
3869 return Err(self.unsupported(inst));
3870 };
3871 let args: Vec<Value> = self.source[self.source[inst].args].to_vec();
3872 let [addr, operand] = args[..] else { return Err(self.unsupported(inst)) };
3873 let old = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
3874
3875 // A value the machine can exchange in one instruction, which is an integer at one of the
3876 // four widths it has these for. A pointer arrives as an address, so it is an integer by the
3877 // time it is here, and anything else is a type this has no instruction for.
3878 let ty = self.source[old].ty;
3879 if !ty.is_int() || !matches!(ty.bits(), 8 | 16 | 32 | 64) {
3880 return Err(self.unsupported(inst));
3881 }
3882 if self.on_aarch64() {
3883 return self.modify_a64(inst, op, [addr, operand], old);
3884 }
3885 let name = match op {
3886 RmwOp::Xchg => format!("xchg_{}", ty.bits()),
3887 RmwOp::Add | RmwOp::Sub => format!("xadd_{}", ty.bits()),
3888 _ => return Err(self.unsupported(inst)),
3889 };
3890
3891 let base = self.reg_of(addr)?;
3892 let mut put = self.reg_of(operand)?;
3893 let block = self.at.expect("a block is being filled");
3894 let span = self.source.span(inst);
3895 if op == RmwOp::Sub {
3896 let negated = self.out.new_vreg(self.gpr);
3897 let negate = self.named(&format!("neg_r_{}", ty.bits()));
3898 let descs = self
3899 .selector
3900 .operands(&format!("neg_r_{}", ty.bits()))
3901 .ok_or_else(|| self.unsupported(inst))?;
3902 let mut build = self.out.build(block, negate).at(span);
3903 for (desc, reg) in descs.iter().zip([negated, put]) {
3904 build = build.operand(mir::Operand {
3905 reg,
3906 class: desc.class,
3907 role: desc.role,
3908 constraint: desc.constraint,
3909 });
3910 }
3911 build.finish();
3912 put = negated;
3913 }
3914
3915 let got = self.new_reg(old);
3916 let descs = self.selector.operands(&name).ok_or_else(|| self.unsupported(inst))?;
3917 let opcode = self.named(&name);
3918 let flags = self.carried(inst);
3919 let mut build = self.out.build(block, opcode).at(span).flags(flags);
3920 for (desc, reg) in descs.iter().zip([got, put]) {
3921 build = build.operand(mir::Operand {
3922 reg,
3923 class: desc.class,
3924 role: desc.role,
3925 constraint: desc.constraint,
3926 });
3927 }
3928 build.mem(mir::Mem::at(mir::Operand::read(base, self.gpr))).finish();
3929 Ok(())
3930 }
3931
3932 /// The width an AArch64 atomic works at, which is an integer or an address of one of the four
3933 /// widths the exclusive loads and stores have. Anything else is refused.
3934 fn atomic_bits(&self, inst: Inst, ty: Type) -> Result<u32, Unsupported> {
3935 let bits = if ty.is_ptr() { ADDRESS_BITS } else { ty.bits() };
3936 if (!ty.is_int() && !ty.is_ptr()) || !matches!(bits, 8 | 16 | 32 | 64) {
3937 return Err(self.unsupported(inst));
3938 }
3939 Ok(bits)
3940 }
3941
3942 /// One instruction by name, with its operands in the order the table lists them.
3943 fn written_as(&mut self, inst: Inst, name: &str, regs: &[mir::Reg]) -> Result<(), Unsupported> {
3944 let descs = self.selector.operands(name).ok_or_else(|| self.unsupported(inst))?;
3945 if descs.len() != regs.len() {
3946 return Err(self.unsupported(inst));
3947 }
3948 let block = self.at.expect("a block is being filled");
3949 let opcode = self.named(name);
3950 let (span, flags) = (self.source.span(inst), self.carried(inst));
3951 let mut build = self.out.build(block, opcode).at(span).flags(flags);
3952 for (desc, ®) in descs.iter().zip(regs) {
3953 build = build.operand(mir::Operand {
3954 reg,
3955 class: desc.class,
3956 role: desc.role,
3957 constraint: desc.constraint,
3958 });
3959 }
3960 build.finish();
3961 Ok(())
3962 }
3963
3964 /// An acquiring load or a releasing store on AArch64, which is `ldar` or `stlr`.
3965 ///
3966 /// Only a relaxed access became the plain one above this, so what arrives is acquire or
3967 /// stronger for a load and release or stronger for a store. `ldar` and `stlr` are also
3968 /// sequentially consistent with each other, which is why the strongest ordering needs no fence
3969 /// on either side, and is what gcc 16.2.0 writes for all of them.
3970 fn ordered(&mut self, inst: Inst) -> Result<(), Unsupported> {
3971 let args: Vec<Value> = self.source[self.source[inst].args].to_vec();
3972 if self.source[inst].opcode == Opcode::AtomicLoad {
3973 let [addr] = args[..] else { return Err(self.unsupported(inst)) };
3974 let result = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
3975 let bits = self.atomic_bits(inst, self.source[result].ty)?;
3976 let base = self.reg_of(addr)?;
3977 let got = self.new_reg(result);
3978 return self.written_as(inst, &format!("ldar_{bits}"), &[got, base]);
3979 }
3980 let [value, addr] = args[..] else { return Err(self.unsupported(inst)) };
3981 let bits = self.atomic_bits(inst, self.source[value].ty)?;
3982 let put = self.reg_of(value)?;
3983 let base = self.reg_of(addr)?;
3984 self.written_as(inst, &format!("stlr_{bits}"), &[put, base])
3985 }
3986
3987 /// A compare and exchange on AArch64, which is a loop of an exclusive load and store.
3988 ///
3989 /// The loop is one instruction as far as everything below is concerned, so that nothing can
3990 /// be spilled or reloaded between the two exclusive accesses, which would lose the reservation
3991 /// on some parts every time. Its definitions are all early, since they are written before the
3992 /// last read. The acquiring and releasing forms are used whatever the ordering, which is what
3993 /// gcc writes at the strongest one and is never wrong at a weaker one. The yes or no comes out
3994 /// of the status register the store wrote, read as a flag after the loop.
3995 fn exchange_a64(
3996 &mut self,
3997 inst: Inst,
3998 [addr, expected, desired]: [Value; 3],
3999 [old, exchanged]: [Value; 2],
4000 ) -> Result<(), Unsupported> {
4001 let bits = self.atomic_bits(inst, self.source[old].ty)?;
4002 let base = self.reg_of(addr)?;
4003 let want = self.reg_of(expected)?;
4004 let put = self.reg_of(desired)?;
4005 let got = self.new_reg(old);
4006 let flag = self.new_reg(exchanged);
4007 self.written_as(inst, &format!("cmpxchg_{bits}"), &[got, flag, base, want, put])
4008 }
4009
4010 /// A read modify write on AArch64, for the three operations that reach here, each a loop of
4011 /// an exclusive load and store for the reason the compare and exchange above is.
4012 fn modify_a64(
4013 &mut self,
4014 inst: Inst,
4015 op: RmwOp,
4016 [addr, operand]: [Value; 2],
4017 old: Value,
4018 ) -> Result<(), Unsupported> {
4019 let bits = self.atomic_bits(inst, self.source[old].ty)?;
4020 let base = self.reg_of(addr)?;
4021 let put = self.reg_of(operand)?;
4022 let got = self.new_reg(old);
4023 let status = self.out.new_vreg(self.gpr);
4024 match op {
4025 RmwOp::Xchg => {
4026 self.written_as(inst, &format!("xchg_{bits}"), &[got, status, base, put])
4027 }
4028 RmwOp::Add | RmwOp::Sub => {
4029 let name = if op == RmwOp::Add { "xadd" } else { "xsub" };
4030 let new = self.out.new_vreg(self.gpr);
4031 self.written_as(inst, &format!("{name}_{bits}"), &[got, new, status, base, put])
4032 }
4033 _ => Err(self.unsupported(inst)),
4034 }
4035 }
4036
4037 /// One `asm` statement.
4038 ///
4039 /// An empty template is most of the inline assembly in a test suite, and it is not a corner
4040 /// case somebody wrote by accident. A program that wants a value computed where it stands, or a
4041 /// loop the optimizer must not touch, writes `asm volatile ("" : : : "memory")`, and forty
4042 /// years of bug reports about optimizers are full of them. What such a statement asks for is
4043 /// the barrier and the operand places, and no instructions at all.
4044 ///
4045 /// So the operands are the half that is always real: a constraint says where a value has to be,
4046 /// and where it has to be is still true when the template between them is empty.
4047 ///
4048 /// What the constraints ask for, on an empty template, is only ever that two operands share a
4049 /// place. Nothing reads a register no text names, so `"r"` on its own asks for a register and
4050 /// no particular one, and any register at all answers it. A matching constraint is different,
4051 /// because it says the output the assembly leaves is the place the input arrived in, and with
4052 /// no instructions between them that is the input unchanged. So it is a rename and not a move:
4053 /// the value is already in a register and the result is that register.
4054 ///
4055 /// An output nothing is tied to and no instruction writes is whatever the assembly left there,
4056 /// which for a template that writes nothing is whatever was in the register. That is a value
4057 /// the program is not entitled to, and this writes a zero rather than reading one, because the
4058 /// allocator has to be given a definition before a use whatever the program is entitled to.
4059 ///
4060 /// # A template with instructions in it
4061 ///
4062 /// [`x86_64::read`] turns the text into the opcodes this backend already has, which is what
4063 /// `spec/11-asm-objects-debug.md` section 11.1 asks for: the machine is described once, and an
4064 /// instruction a program wrote is looked up in that description rather than copied through to
4065 /// an assembler that has one of its own. So nothing here assembles anything. What it does is
4066 /// put the statement's operands where the opcode holds them, and from there an `asm` statement
4067 /// is ordinary machine code: the allocator picks the registers, the listing and the object file
4068 /// are written from the same table as every other instruction, and a spill around one works
4069 /// because there is nothing left about it for a spill to get wrong.
4070 ///
4071 /// A register the template named in its own text is the one thing in there that is nobody's
4072 /// operand, and it is placed as itself. See [`Self::itself`] for why that is safer here than
4073 /// the thing gcc does, which is to copy the name out and leave the allocator none the wiser.
4074 ///
4075 /// Two things are refused, both for one reason, which is that placing them by a guess gives a
4076 /// program that assembles into something other than what it says.
4077 ///
4078 /// An output the template writes more than once, which is one place with two definitions in it,
4079 /// and the machine IR between here and the allocator has one definition per register by
4080 /// construction. An output tied to an input and written once is not that: it is two registers
4081 /// the description ties together, which is what [`Place`] is about.
4082 ///
4083 /// An operand read where the opcode writes, or written where it reads. An output that has not
4084 /// been written yet is not a value, and an input the assembly writes over is a value something
4085 /// else may still be using.
4086 ///
4087 /// # A register the instruction uses without being told
4088 ///
4089 /// An instruction may reach a register its text does not name, and `cpuid` is all of them at
4090 /// once: the leaf goes in `eax`, the subleaf in `ecx`, and the answer comes back in all four
4091 /// registers. The description holds every bit of that already, so what is left is to say which
4092 /// of the statement's operands is in each of those registers, and the constraint letter is the
4093 /// one thing in an assembly statement that says it. `"=a"` is an output in `rax` and `"c"` is
4094 /// an input in `rcx`, which is why a program writing `cpuid` writes its constraints that way
4095 /// and has no choice about it.
4096 ///
4097 /// A register no letter named is one the statement put nothing in, and that is the usual case
4098 /// rather than an unusual one, since an instruction that answers four questions is written by
4099 /// programs that asked one. A write of one is the register being destroyed and gets a register
4100 /// of its own, which is what tells the allocator to keep everything else out of it. A read of
4101 /// one is a register the instruction looks at and the program never filled, which gets a zero
4102 /// for the reason [`Self::undefined`] gives.
4103 ///
4104 /// # The clobber list
4105 ///
4106 /// Read now, as the registers it names being written by every instruction of the template. By
4107 /// every one rather than by one of them, because the list says the assembly as a whole leaves
4108 /// them ruined and nothing here knows which line did it. Every entry has to be a register this
4109 /// machine has a name for or the statement is refused, since a name nobody read is a register
4110 /// nobody is keeping out of.
4111 ///
4112 /// `memory` and `cc` are the two entries that are not registers and both are skipped. `memory`
4113 /// says the assembly touches storage, which is already true of every `asm` this writes and is
4114 /// nothing a register list could hold. `cc` says it ruins the condition flags, and the flag
4115 /// tracking already has that from the instructions the template was read into, since it takes
4116 /// every instruction it does not recognize as writing them and every instruction here is one
4117 /// this machine describes. `flags` is the name gcc's own register table gives the same thing on
4118 /// this machine, so a program writing it has written `cc` and is read that way: tcc's
4119 /// `tests/tcctest.c` lists both on one statement.
4120 ///
4121 /// A clobber the instruction already writes is left off it. `cpuid` writes all four registers
4122 /// by description, and a statement listing three of them as clobbers as well is saying the
4123 /// same thing twice, which the allocator would read as one register with two definitions.
4124 ///
4125 /// On a template with nothing in it the list is ignored, as it was before, since a template
4126 /// with no instructions ruins nothing whatever it said about what it ruins.
4127 fn assembly(&mut self, inst: Inst) -> Result<(), Unsupported> {
4128 let data = &self.source[inst];
4129 let Extra::Asm(asm) = data.extra else { return Err(self.unsupported(inst)) };
4130 let info = self.source[asm];
4131 if self.jumps_from_text(inst) {
4132 return Err(Unsupported::Assembly { inst, refused: Written::Goto });
4133 }
4134 let refused = || Unsupported::Assembly { inst, refused: Written::Operand };
4135
4136 let constraints = self.names.resolve(info.constraints).to_string();
4137 let results: Vec<Value> = data.results().collect();
4138 let operands = AsmOperands::read(&constraints, &results, &self.source[data.args])
4139 .ok_or_else(refused)?;
4140 let list: Vec<AsmOperand<'_>> = operands.iter().copied().collect();
4141
4142 // Read after the constraints and not before them, because a mnemonic whose suffix the
4143 // program left off is read at the width of the operands it names, and the operands are
4144 // what the constraints are a list of.
4145 let widths: Vec<Option<x86_64::Width>> = list
4146 .iter()
4147 .map(|operand| {
4148 let ty = self.source[operand.result.or(operand.value)?].ty;
4149 if !ty.is_scalar() {
4150 return None;
4151 }
4152 x86_64::Width::of_bits(held_bits(ty))
4153 })
4154 .collect();
4155 // An operand in memory is an address the statement holds and an object the template names,
4156 // so the reader is told which ones those are and spells `%0` for one as the object.
4157 let memory: Vec<bool> = list.iter().map(|operand| operand.memory).collect();
4158 let template = self.names.resolve(info.template).to_string();
4159 // A clobber list naming a vector register goes the way a template this cannot read does.
4160 // The instructions read here are all in the general purpose file, and what keeps the text
4161 // already takes every vector register a call may use away from the allocator across it.
4162 let clobbers = self.names.resolve(info.clobbers);
4163 if clobbers.split(',').any(|entry| vector_named(entry).is_some()) {
4164 return self.kept(inst, &template, &list, &widths, &memory);
4165 }
4166 let steps = if template.trim().is_empty() {
4167 Vec::new()
4168 } else {
4169 match x86_64::read_in(&template, &widths, &memory) {
4170 Some(steps) => steps,
4171 None => return self.kept(inst, &template, &list, &widths, &memory),
4172 }
4173 };
4174
4175 // Which operands the template writes, counted before anything is placed, because the answer
4176 // decides where each of the three below comes from and one instruction may name an operand
4177 // that a later one writes. Which of them any instruction puts in a register at all is
4178 // counted in the same walk, since an operand no instruction reaches that way is one nothing
4179 // has to put anywhere: a constant a template names only as the distance into an address is
4180 // written into the instruction, and a register holding a copy of it would be one nobody
4181 // reads. An operand the address is counted from is reached that way and is counted here for
4182 // that reason, because the walk below it is over the opcode's operands and an address is
4183 // not one of those.
4184 //
4185 // Whether any instruction reads an operand an instruction above it wrote is counted in the
4186 // same walk too. Such a template is one whose instructions have to be written in order with
4187 // each read taken from wherever the last write left the operand, which is what
4188 // [`Self::woven`] does, and so is one that writes an operand twice.
4189 let mut writes = vec![0usize; list.len()];
4190 let mut reads = vec![false; list.len()];
4191 let mut held = vec![false; list.len()];
4192 let mut after = false;
4193 for step in &steps {
4194 // A call out of the template writes every register the convention lets the callee
4195 // leave anything in, and an output pinned to one of those is written by it.
4196 if let x86_64::Step::Call { .. } = step {
4197 for index in self.lost(&list).into_iter().filter_map(|(_, _, index)| index) {
4198 *writes.get_mut(index).ok_or_else(refused)? += 1;
4199 }
4200 continue;
4201 }
4202 let x86_64::Step::Line(line) = step else { continue };
4203 match line.at.and_then(|at| at.base) {
4204 Some(x86_64::Piece::Operand { index, .. }) => {
4205 *held.get_mut(index).ok_or_else(refused)? = true;
4206 after |= writes[index] > 0;
4207 }
4208 Some(x86_64::Piece::Reg { reg, .. }) => {
4209 if let Some(index) = bound(&list, reg, Role::Use) {
4210 *held.get_mut(index).ok_or_else(refused)? = true;
4211 after |= writes[index] > 0;
4212 }
4213 }
4214 _ => {}
4215 }
4216 let mut written = Vec::new();
4217 let form = x86_64::form(line.opcode).ok_or_else(refused)?;
4218 // Which registers the instruction reaches, asked the same way it is asked again when
4219 // the instruction is written. See [`Self::lettered`] for the one opcode whose answer
4220 // comes from the constraint letters rather than from the description.
4221 let lettered = (line.opcode == x86_64::LITERAL).then(|| self.lettered(&list));
4222 let (described, pieces) = match &lettered {
4223 Some((described, pieces)) => (described.as_slice(), pieces.as_slice()),
4224 None => (form.operands(), line.operands.as_slice()),
4225 };
4226 for (desc, piece) in described.iter().zip(pieces) {
4227 // An operand the instruction reaches without its text saying so is the statement's
4228 // only when a constraint letter put something there. One that is nobody's writes
4229 // nothing of the program's, so it is counted nowhere and is dealt with where it is
4230 // placed.
4231 let index = match *piece {
4232 x86_64::Piece::Operand { index, .. } => index,
4233 x86_64::Piece::Implicit { reg } => match bound(&list, reg, desc.role) {
4234 Some(index) => index,
4235 None => continue,
4236 },
4237 x86_64::Piece::Reg { reg, .. } => match bound(&list, reg, desc.role) {
4238 Some(index) => index,
4239 None => continue,
4240 },
4241 };
4242 *held.get_mut(index).ok_or_else(refused)? = true;
4243 if matches!(desc.role, Role::Def | Role::EarlyDef) {
4244 written.push(index);
4245 } else {
4246 *reads.get_mut(index).ok_or_else(refused)? = true;
4247 after |= writes[index] > 0;
4248 }
4249 }
4250 for index in written {
4251 *writes.get_mut(index).ok_or_else(refused)? += 1;
4252 }
4253 }
4254 let woven = after
4255 || writes.iter().any(|&count| count > 1)
4256 || steps.iter().any(|step| !matches!(step, x86_64::Step::Line(_)));
4257
4258 // Where every operand is. Worked out in full before the first instruction is written, since
4259 // reading a value may be what puts it in a register in the first place, and that has to
4260 // happen in front of the assembly rather than in the middle of it.
4261 let mut places: Vec<Place> = vec![Place::default(); list.len()];
4262 for (index, operand) in list.iter().copied().enumerate() {
4263 let Some(result) = operand.result else {
4264 // An input, or an output the assembly was handed the address of, and both are a
4265 // value that arrives in a register and is read out of it, unless no instruction of
4266 // the template reads it out of one.
4267 let value = operand.value.ok_or_else(refused)?;
4268 if held[index] {
4269 places[index].read = Some(self.reg_of(value)?);
4270 }
4271 continue;
4272 };
4273 let ty = self.source[result].ty;
4274 if on_x87(ty) {
4275 return Err(refused());
4276 }
4277 let tied = operands.tied_to(index);
4278 if let Some(from) = tied {
4279 if self.class_of(self.source[from].ty) != self.class_of(ty) {
4280 return Err(refused());
4281 }
4282 places[index].read = Some(self.reg_of(from)?);
4283 }
4284 if writes[index] > 0 {
4285 places[index].write = Some(self.new_reg(result));
4286 continue;
4287 }
4288 match tied {
4289 // The place the input arrived in, which the assembly wrote nothing over. One
4290 // register, so this is a rename rather than a move.
4291 Some(_) => {
4292 let reg = places[index].read.ok_or_else(refused)?;
4293 self.regs[result.index()] = Some(reg);
4294 places[index].write = Some(reg);
4295 }
4296 None => {
4297 self.undefined(inst, result)?;
4298 places[index].write = self.regs[result.index()];
4299 }
4300 }
4301 }
4302
4303 // An output an instruction of the template also reads, which the statement said nothing
4304 // about because an output is what a statement says the other thing about. What it holds
4305 // there is undefined, and a program writing one means it: `sbb %0, %0` in libgmp's
4306 // `add_mssaaaa` subtracts a register from itself and is asking for the borrow bit rather
4307 // than for the number, so whatever the register held, the answer is the same. Undefined is
4308 // not the same as absent though, since the allocator is owed a definition in front of every
4309 // use, so it gets the zero an output nothing wrote gets and for the same reason.
4310 //
4311 // Unless an input could have been in the same register, in which case gcc's allocator puts
4312 // it there whenever it can and a program may have been written against that. tcc's test of
4313 // a call from a template reads its output `"=a" (s)` to pass `"r" (str)` to `getenv`, which
4314 // is only the string because gcc gave the two of them `rax`. So an output nothing has
4315 // written yet reads the one input that could share its place, when there is exactly one.
4316 // One written `&` is written before the inputs are read and shares nothing.
4317 for index in 0..list.len() {
4318 if !reads[index] || places[index].read.is_some() || places[index].write.is_none() {
4319 continue;
4320 }
4321 let reg = match self.shared(&list, index) {
4322 Some(value) => self.reg_of(value)?,
4323 None => self.seeded(inst, list[index])?,
4324 };
4325 places[index].read = Some(reg);
4326 }
4327
4328 // Worked out once for the whole template, since the list is one list and every instruction
4329 // of the template gets it. Not worked out at all for a template with no instructions, which
4330 // is where there is nothing for it to go on.
4331 let clobbers = self.names.resolve(info.clobbers).to_string();
4332 let clobbered =
4333 if steps.is_empty() { Vec::new() } else { Self::clobbered(inst, &clobbers)? };
4334
4335 // A template with a label in it is not one run of instructions, and what it is instead is
4336 // in [`Self::woven`], which is also where a template goes whose instructions read what the
4337 // ones above them wrote. Every other template is what it has always been, which is every
4338 // instruction of it written into the block the statement stands in.
4339 if woven {
4340 return self.woven(inst, &steps, &mut places, &list, &clobbered, &writes);
4341 }
4342 for step in &steps {
4343 let x86_64::Step::Line(line) = step else { continue };
4344 self.instruction(inst, line, &places, &list, &clobbered)?;
4345 }
4346 Ok(())
4347 }
4348
4349 /// A template the reader could not take apart, kept as its text. See [`x86_64::Form::Template`].
4350 ///
4351 /// What the text names is spelled into it here, the way gcc prints it into its listing: a
4352 /// constant as `$5`, or as `5` under the `c` modifier, and the address of a name as the name.
4353 /// An object in memory is the one thing that cannot be spelled yet, since where it is depends on
4354 /// registers nothing has chosen, so it is left as a hole the writer fills and its address is the
4355 /// instruction's memory operand. One is all an instruction has room for, and every template this
4356 /// has met names one at most. A template that names an operand by name rather than by number is
4357 /// refused for now.
4358 ///
4359 /// # An operand in a register
4360 ///
4361 /// Which register is not known until the allocator has run, and the text is written down before
4362 /// then, so an operand in a register is a hole too. It names the instruction's own operand and
4363 /// the width the modifier asked for, or the width of the operand's type when there was none,
4364 /// and the writer spells whatever register the operand ended up in. What the text writes goes
4365 /// in first as definitions and what it reads goes in last as uses, with the registers below in
4366 /// between, so the allocator sees the statement as one instruction with every operand said. An
4367 /// output tied to an input, by `+` or by a number, reuses the input's register, and one written
4368 /// `&` is written early. Anything wider than a general purpose register is refused.
4369 ///
4370 /// A statement written with no colons is basic assembly, where `%` is a character like any
4371 /// other and a register is written `%eax`. The front end keeps no mark of which kind a statement
4372 /// was, so one with no operands and no clobbers is read as basic, which is what gcc would do for
4373 /// every such template but one written with empty colons around it.
4374 ///
4375 /// The registers a call may write are taken as written, see below for why.
4376 fn kept(
4377 &mut self,
4378 inst: Inst,
4379 template: &str,
4380 list: &[AsmOperand<'_>],
4381 widths: &[Option<x86_64::Width>],
4382 memory: &[bool],
4383 ) -> Result<(), Unsupported> {
4384 // Refused as the template it is, since keeping it is what was tried after reading it
4385 // failed, and what could not be kept is what it names rather than any one operand.
4386 let refused = || Unsupported::Assembly { inst, refused: Written::Template };
4387 let data = &self.source[inst];
4388 let Extra::Asm(asm) = data.extra else { return Err(self.unsupported(inst)) };
4389 let clobbers = self.names.resolve(self.source[asm].clobbers).to_string();
4390 let basic = list.is_empty() && clobbers.trim().is_empty();
4391
4392 // Every register a call may leave anything in, as well as the ones the list names. The
4393 // text can write any register it likes without saying so, and tcc's tests do: gcc gets
4394 // away with that at `-O0` because nothing lives in a register between two statements
4395 // there, and taking these away from the allocator across the template is what gives the
4396 // same answer here. Nothing is written to them by this, so a register one template leaves
4397 // a value in is still holding it when the next template reads it.
4398 let a64 = self.on_aarch64();
4399 let mut clobbered: Vec<(PhysReg, RegClass)> =
4400 self.lost(list).into_iter().map(|(reg, class, _)| (reg, class)).collect();
4401 let named = if a64 {
4402 Self::clobbered_a64(inst, &clobbers)?
4403 } else {
4404 Self::clobbered_x86(inst, &clobbers, self.gpr, self.conv.sse_class)?
4405 };
4406 for &(reg, class) in &named {
4407 if !clobbered.iter().any(|&(had, of)| had == reg && of == class) {
4408 clobbered.push((reg, class));
4409 }
4410 }
4411
4412 // The file each operand is in. On AArch64 `w` is a floating point or vector register and an
4413 // input tied to an output is in that output's file. A value whose type puts it in the other
4414 // file would need a move into this one first, which gcc makes and this does not yet, so
4415 // that is refused below.
4416 let mut files = vec![self.gpr; list.len()];
4417 if a64 {
4418 let constraints = self.names.resolve(self.source[asm].constraints);
4419 for (file, entry) in files.iter_mut().zip(constraints.split(',')) {
4420 if vector_letter(entry) {
4421 *file = self.conv.sse_class;
4422 }
4423 }
4424 for index in 0..list.len() {
4425 if let Some(&file) = list[index].tied.and_then(|output| files.get(output)) {
4426 files[index] = file;
4427 }
4428 }
4429 }
4430 let pins: Vec<_> = list.iter().map(|operand| self.pinned_here(operand)).collect();
4431 let pin = |index: usize, file: RegClass| match pins[index] {
4432 Some((at, class)) if class == file => Ok(Some(Constraint::Fixed(at))),
4433 Some(_) => Err(refused()),
4434 None => Ok(None),
4435 };
4436
4437 // The operands in a register, as the instruction's own. An input the text is handed as a
4438 // constant or as the address of a name is spelled into the text instead, when its
4439 // constraint allows a constant at all and no output is tied to it. `"a" (0x1234)` is a
4440 // register holding the number, the way gcc loads it, since the text may ask for `%h0`.
4441 let mut defs: Vec<mir::Operand> = Vec::new();
4442 let mut uses: Vec<mir::Operand> = Vec::new();
4443 let mut def_of: Vec<Option<usize>> = vec![None; list.len()];
4444 let mut use_of: Vec<Option<usize>> = vec![None; list.len()];
4445 if !basic {
4446 for (index, operand) in list.iter().enumerate() {
4447 let Some(result) = operand.result else { continue };
4448 let (ty, file) = (self.source[result].ty, files[index]);
4449 if on_x87(ty) || self.class_of(ty) != file {
4450 return Err(refused());
4451 }
4452 let reg = self.new_reg(result);
4453 let written = if operand.early {
4454 mir::Operand::write_early(reg, file)
4455 } else {
4456 mir::Operand::write(reg, file)
4457 };
4458 def_of[index] = Some(defs.len());
4459 defs.push(match pin(index, file)? {
4460 Some(fixed) => written.with(fixed),
4461 None => written,
4462 });
4463 }
4464 for (index, operand) in list.iter().enumerate() {
4465 let Some(value) = operand.value else { continue };
4466 let spelled = operand.result.is_none()
4467 && operand.tied.is_none()
4468 && operand.immediate
4469 && (self.number(value).is_some() || self.named_address(value).is_some());
4470 // An operand in memory is spelled on AArch64 as the register its address is in,
4471 // which is `[x3]` and is an address every instruction that takes one reads.
4472 if (operand.memory && !a64) || spelled {
4473 continue;
4474 }
4475 let (ty, file) = (self.source[value].ty, files[index]);
4476 if on_x87(ty) || self.class_of(ty) != file {
4477 return Err(refused());
4478 }
4479 let read = mir::Operand::read(self.reg_of(value)?, file);
4480 use_of[index] = Some(uses.len());
4481 uses.push(match pin(index, file)? {
4482 Some(fixed) => read.with(fixed),
4483 None => read,
4484 });
4485 }
4486 }
4487 // Every register a call may write is more than a template can give up when it has more
4488 // operands in registers than the convention keeps across a call. `sodium_sub` in
4489 // libsodium's `utils.c` is one: eight outputs written early and two inputs pinned, against
4490 // the five registers SysV preserves, so an output has nowhere to go and nothing is left to
4491 // carry one to its slot either. gcc gives that template ten registers, and a program that
4492 // writes a register it did not name is only owed what gcc would have done, which here is
4493 // one of the ten. So the registers taken as written without being named are handed back,
4494 // from the end of the convention's order, until the operands fit in what is left. One the
4495 // list names or an operand is pinned to stays where it is. What is left does not count the
4496 // two scratch registers the allocator holds back, since no operand is ever given one of
4497 // those, and counting them left two outputs short above -O0 with nothing to carry them.
4498 let fixed_to: Vec<PhysReg> = defs
4499 .iter()
4500 .chain(&uses)
4501 .filter_map(|operand| match operand.constraint {
4502 Constraint::Fixed(at) => Some(at),
4503 _ => None,
4504 })
4505 .collect();
4506 let wanted = defs.iter().chain(&uses).count() - fixed_to.len();
4507 let int = self.conv.int_class;
4508 let held: &[PhysReg] =
4509 if a64 { &crate::pipeline::AARCH64_SCRATCH } else { &crate::pipeline::SCRATCH };
4510 let free = |clobbered: &[(PhysReg, RegClass)]| {
4511 self.conv
4512 .int_order
4513 .iter()
4514 .filter(|&®| {
4515 !held.contains(®)
4516 && !fixed_to.contains(®)
4517 && !clobbered.contains(&(reg, int))
4518 })
4519 .count()
4520 };
4521 while free(&clobbered) < wanted {
4522 let Some(at) = clobbered.iter().rposition(|&(reg, class)| {
4523 class == int && !named.contains(&(reg, class)) && !fixed_to.contains(®)
4524 }) else {
4525 break;
4526 };
4527 clobbered.remove(at);
4528 }
4529
4530 // A register an output is pinned to is that output's definition and not a clobber as well.
4531 // One an input is pinned to is written as the instruction finishes, the way a call writes
4532 // the register its argument came in, and every other one is written early, since the text
4533 // may write it before it has read its inputs and an input must not be in it.
4534 let mut written: Vec<mir::Operand> = Vec::new();
4535 for (reg, class) in clobbered {
4536 let fixed = |operand: &mir::Operand| {
4537 operand.class == class && operand.constraint == Constraint::Fixed(reg)
4538 };
4539 if defs.iter().any(fixed) {
4540 continue;
4541 }
4542 let reg = mir::Reg::physical(reg);
4543 written.push(if uses.iter().any(fixed) {
4544 mir::Operand::write(reg, class)
4545 } else {
4546 mir::Operand::write_early(reg, class)
4547 });
4548 }
4549 // An output tied to an input is one register, which the definition says by reusing the
4550 // use, or by both being fixed to the same one when the output was pinned.
4551 //
4552 // A reused register is kept from every other input already, since the allocator counts the
4553 // output as taken from where the instruction reads. So `+&` asks for nothing more than `+`,
4554 // and saying it as an early write as well costs a register: the allocator only hands an
4555 // output the register of the input it reuses when the output starts at the instruction, and
4556 // an early one starts a point sooner, so it gets one of its own and a copy in front. Eleven
4557 // operands written that way in xz's range decoder need seventeen registers and run out. The
4558 // one case where `&` still means something is an input reading the same value as the one
4559 // tied, which would be in the same register and read after the output was written.
4560 let first_use = defs.len() + written.len();
4561 for (output, operand) in list.iter().enumerate() {
4562 let Some(def) = def_of[output] else { continue };
4563 let input = if operand.value.is_some() {
4564 Some(output)
4565 } else {
4566 list.iter().position(|entry| entry.tied == Some(output))
4567 };
4568 let Some(read) = input.and_then(|input| use_of[input]) else { continue };
4569 match defs[def].constraint {
4570 Constraint::Fixed(_) => uses[read].constraint = defs[def].constraint,
4571 _ => {
4572 let at = u8::try_from(first_use + read).map_err(|_| refused())?;
4573 defs[def].constraint = Constraint::Reuse(at);
4574 let source = uses[read].reg;
4575 let shared = uses
4576 .iter()
4577 .enumerate()
4578 .any(|(other, operand)| other != read && operand.reg == source);
4579 if defs[def].role == Role::EarlyDef && !shared {
4580 defs[def].role = Role::Def;
4581 }
4582 }
4583 }
4584 }
4585
4586 // A line naming an operand in a register, with an instruction on it the reader knows, is
4587 // one the reader refused for a reason of its own, and keeping it as text would hand the
4588 // assembler what the reader already said no to. `addq %1, %k0` is that: a quadword add
4589 // into half a register. What is kept is a line with an instruction nothing here knows.
4590 let registered = |index: usize| def_of[index].is_some() || use_of[index].is_some();
4591 if !a64 && (0..list.len()).any(registered) {
4592 for line in template.split(['\n', ';']) {
4593 if names_one(line, registered)
4594 && x86_64::known(line, widths, memory)
4595 && x86_64::read_in(line, widths, memory).is_none()
4596 {
4597 return Err(refused());
4598 }
4599 }
4600 }
4601
4602 let mut text = String::with_capacity(template.len());
4603 let mut memory: Option<usize> = None;
4604 if basic {
4605 text.push_str(template);
4606 } else {
4607 let mut chars = template.chars().peekable();
4608 // Inside `{att|intel}`, and past the `|` in it, which is the half nobody reads. AArch64
4609 // has one dialect, and a brace there is a list of vector registers.
4610 let mut dialect = false;
4611 let mut skipped = false;
4612 while let Some(c) = chars.next() {
4613 match c {
4614 '{' if !a64 => {
4615 dialect = true;
4616 continue;
4617 }
4618 '|' if dialect => {
4619 skipped = true;
4620 continue;
4621 }
4622 '}' if dialect => {
4623 dialect = false;
4624 skipped = false;
4625 continue;
4626 }
4627 _ if skipped => continue,
4628 '%' => {}
4629 _ => {
4630 text.push(c);
4631 continue;
4632 }
4633 }
4634 match chars.peek().copied() {
4635 Some(c @ ('%' | '{' | '|' | '}')) => {
4636 chars.next();
4637 text.push(c);
4638 continue;
4639 }
4640 Some('=') => {
4641 chars.next();
4642 text.push_str(&inst.index().to_string());
4643 continue;
4644 }
4645 _ => {}
4646 }
4647 let modifier = match chars.peek().copied() {
4648 Some(c) if c.is_ascii_alphabetic() => {
4649 chars.next();
4650 Some(c)
4651 }
4652 _ => None,
4653 };
4654 let mut digits = String::new();
4655 while let Some(c) = chars.peek().copied().filter(char::is_ascii_digit) {
4656 digits.push(c);
4657 chars.next();
4658 }
4659 let index: usize = digits.parse().map_err(|_| refused())?;
4660 let operand = list.get(index).ok_or_else(refused)?;
4661 if operand.memory && a64 {
4662 let at = use_of[index].map(|at| first_use + at).ok_or_else(refused)?;
4663 if modifier.is_some() {
4664 return Err(refused());
4665 }
4666 text.push('[');
4667 text.push_str(&template_reg(at, 'x'));
4668 text.push(']');
4669 continue;
4670 }
4671 if operand.memory {
4672 if modifier.is_some() || memory.is_some_and(|had| had != index) {
4673 return Err(refused());
4674 }
4675 memory = Some(index);
4676 text.push_str(x86_64::TEMPLATE_MEM);
4677 continue;
4678 }
4679 let placed = def_of[index].or(use_of[index].map(|at| first_use + at));
4680 if let Some(at) = placed {
4681 let value = operand.result.or(operand.value).ok_or_else(refused)?;
4682 let bits = held_bits(self.source[value].ty);
4683 // `w` and `x` are the two names every general purpose register has, and one
4684 // with no modifier is named at the width of its type, as gcc names it. A
4685 // vector register with no modifier is `v`, which is what gcc writes for one
4686 // whatever is in it, and the modifiers name the scalar views of it.
4687 let width = if a64 && files[index] != self.gpr {
4688 match modifier {
4689 None => 'v',
4690 Some(view @ ('b' | 'h' | 's' | 'd' | 'q')) => view,
4691 Some(_) => return Err(refused()),
4692 }
4693 } else if a64 {
4694 match (modifier, bits) {
4695 (None, 8 | 16 | 32) | (Some('w'), _) => 'w',
4696 (None, 64) | (Some('x'), _) => 'x',
4697 _ => return Err(refused()),
4698 }
4699 } else {
4700 match modifier {
4701 None => match held_bits(self.source[value].ty) {
4702 8 => 'b',
4703 16 => 'w',
4704 32 => 'k',
4705 64 => 'q',
4706 _ => return Err(refused()),
4707 },
4708 Some(width @ ('b' | 'w' | 'k' | 'q')) => width,
4709 // The second byte is a name only four registers have, so it is taken for
4710 // an operand pinned to one of them and for nothing the allocator chose.
4711 Some('h') if pinned(operand).and_then(x86_64::gpr_high).is_some() => {
4712 'h'
4713 }
4714 Some(_) => return Err(refused()),
4715 }
4716 };
4717 text.push_str(&template_reg(at, width));
4718 continue;
4719 }
4720 let value = operand.value.ok_or_else(refused)?;
4721 let bare = match modifier {
4722 None => false,
4723 Some('c' | 'P' | 'p') => true,
4724 Some(_) => return Err(refused()),
4725 };
4726 // A constant is bare on AArch64 whatever the modifier, which is how gcc prints one
4727 // there and a form GNU as takes wherever `#` would go.
4728 if !bare && !a64 {
4729 text.push('$');
4730 }
4731 if let Some(number) = self.number(value) {
4732 text.push_str(&number.to_string());
4733 } else if let Some(symbol) = self.named_address(value) {
4734 text.push_str(&template_name(self.names.resolve(symbol)));
4735 } else {
4736 return Err(refused());
4737 }
4738 }
4739 }
4740
4741 // An object in this function's frame is named by where it is in the frame, the way gcc
4742 // names it, rather than by a register its address was put in first. The text may write
4743 // registers it does not declare, and tcc's tests do: one that writes `%ecx` behind the
4744 // compiler's back would otherwise take the address with it.
4745 let mut local = None;
4746 let at = match memory.filter(|_| !a64) {
4747 Some(index) => {
4748 let value = list[index].value.ok_or_else(refused)?;
4749 local = self.local_of(value);
4750 let base = match local {
4751 Some(_) => mir::Reg::physical(self.conv.stack_pointer),
4752 None => self.reg_of(value)?,
4753 };
4754 Some(mir::Mem::at(mir::Operand::read(base, self.gpr)))
4755 }
4756 None => None,
4757 };
4758 let symbol = self.names.intern(&text);
4759 let opcode = self.named(if a64 { aarch64::TEMPLATE } else { x86_64::TEMPLATE });
4760 let block = self.at.expect("a block is being filled");
4761 let span = self.source.span(inst);
4762 let mut build = self.out.build(block, opcode).at(span).symbol(symbol);
4763 for operand in defs.into_iter().chain(written).chain(uses) {
4764 build = build.operand(operand);
4765 }
4766 if let Some(mem) = at {
4767 build = build.mem(mem);
4768 }
4769 let made = build.finish();
4770 if let Some(local) = local {
4771 self.stack.addresses.push((made, local));
4772 }
4773 Ok(())
4774 }
4775
4776 /// The object in this function's frame a value is the address of, for one an `alloca` of a
4777 /// size known here made. See [`Self::reserve`], which is where the `lea` it is found by came
4778 /// from.
4779 fn local_of(&self, value: Value) -> Option<usize> {
4780 let Def::Result { inst, .. } = self.source[value].def else { return None };
4781 if self.source[inst].opcode != Opcode::Alloca
4782 || !self.source[self.source[inst].args].is_empty()
4783 {
4784 return None;
4785 }
4786 let reg = self.regs[value.index()]?;
4787 self.stack.addresses.iter().find_map(|&(made, local)| {
4788 let data = &self.out[made];
4789 let defined = self.out[data.operands].first()?;
4790 (defined.reg == reg).then_some(local)
4791 })
4792 }
4793
4794 /// The name a value is the address of, for one a `global_addr` defined.
4795 fn named_address(&self, value: Value) -> Option<Symbol> {
4796 let Def::Result { inst, .. } = self.source[value].def else { return None };
4797 if self.source[inst].opcode != Opcode::GlobalAddr {
4798 return None;
4799 }
4800 let Extra::Symbol(symbol) = self.source[inst].extra else { return None };
4801 Some(symbol)
4802 }
4803
4804 /// A register holding a zero, for an operand of a template that is read before anything filled
4805 /// it.
4806 ///
4807 /// Two things ask for this and they are the same thing twice. An output the template reads has
4808 /// nothing to be read out of until the instruction that writes it has run, and a loop carries
4809 /// an operand into a block before the instruction that fills it, so both are a use in front of
4810 /// every definition. What the program is owed there is nothing, since the value is undefined
4811 /// either way, and what the allocator is owed is a register something wrote.
4812 fn seeded(&mut self, inst: Inst, operand: AsmOperand<'_>) -> Result<mir::Reg, Unsupported> {
4813 let refused = || Unsupported::Assembly { inst, refused: Written::Operand };
4814 let value = operand.result.or(operand.value).ok_or_else(refused)?;
4815 let class = self.class_of(self.source[value].ty);
4816 if class != self.gpr {
4817 return Err(refused());
4818 }
4819 let block = self.at.expect("a block is being filled");
4820 let reg = self.out.new_vreg(class);
4821 let put = self.named("mov_ri_64");
4822 self.out.build(block, put).at(self.source.span(inst)).def(reg, class).imm(0).finish();
4823 Ok(reg)
4824 }
4825
4826 /// A template with labels in it, as the blocks its jumps leave and arrive at.
4827 ///
4828 /// A statement is an instruction of the IR and stands inside one block, so a template that
4829 /// jumps has to stop being one thing. Each label becomes a block, each jump ends the block it
4830 /// stands in and gives it two arms, and whatever follows the statement goes into whichever
4831 /// block the walk finished in, which is what [`Self::block`] already reads off `self.at` and
4832 /// what [`Self::saves_place`] already does for the same reason.
4833 ///
4834 /// # What is carried between them
4835 ///
4836 /// The machine IR here is in the form where a register is written once, so an operand written
4837 /// inside a loop and read again at the top of it cannot be one register. What arrives at the
4838 /// top is a parameter of that block, and every jump to it carries whichever register held the
4839 /// operand where the jump stands. That is the whole of the bookkeeping: every block a label
4840 /// made takes one parameter for each operand that is in a register at all, in one order, so an
4841 /// arm's arguments and a block's parameters are the same list read twice.
4842 ///
4843 /// Which register an operand is in at each point is kept in the read half of its place, since
4844 /// that is what the instructions below read it out of. An instruction that writes an operand
4845 /// leaves it in the register it wrote, and a jump below carries that one. The block an
4846 /// untaken jump falls into is arrived at one way only and so takes no parameters, and nothing
4847 /// about where the operands are changes there.
4848 ///
4849 /// An operand written by the template and filled by nothing is written as a zero first, for
4850 /// the reason [`Self::undefined`] gives and one more: a jump may carry it before the
4851 /// instruction that fills it has run, and an argument has to be a register something wrote.
4852 ///
4853 /// # The condition state
4854 ///
4855 /// Nothing carries it and nothing has to. The instruction that sets it and the jump that reads
4856 /// it are both written here, next to each other in one block, and what the allocator may put
4857 /// between them is a move, which on this machine leaves the condition state alone. The edge
4858 /// into a block a loop goes back to is a critical edge and `crate::split` gives it a block of
4859 /// its own, so the moves an arm turns into land behind the jump rather than in front of it.
4860 fn woven(
4861 &mut self,
4862 inst: Inst,
4863 steps: &[x86_64::Step],
4864 places: &mut [Place],
4865 list: &[AsmOperand<'_>],
4866 clobbered: &[PhysReg],
4867 writes: &[usize],
4868 ) -> Result<(), Unsupported> {
4869 let refused = || Unsupported::Assembly { inst, refused: Written::Operand };
4870 let span = self.source.span(inst);
4871
4872 // Which operands are carried, which is every one that is in a register at all. An operand
4873 // the template never puts in one, such as a constant it names only as the distance into an
4874 // address, is in the instruction and has nowhere to be carried from.
4875 let mut carried: Vec<(usize, RegClass)> = Vec::new();
4876 for (index, operand) in list.iter().enumerate() {
4877 if places[index].read.is_none() && places[index].write.is_none() {
4878 continue;
4879 }
4880 let value = operand.result.or(operand.value).ok_or_else(refused)?;
4881 let ty = self.source[value].ty;
4882 if on_x87(ty) {
4883 return Err(refused());
4884 }
4885 carried.push((index, self.class_of(ty)));
4886 }
4887
4888 // What each of them holds where the template starts.
4889 for &(index, _) in &carried {
4890 if places[index].read.is_some() {
4891 continue;
4892 }
4893 if writes[index] == 0 {
4894 places[index].read = places[index].write;
4895 continue;
4896 }
4897 places[index].read = Some(self.seeded(inst, list[index])?);
4898 }
4899
4900 // The blocks, made before the walk because a jump forwards names a label the walk has not
4901 // reached yet.
4902 let mut labels: Vec<(&str, mir::Block, Vec<mir::Reg>)> = Vec::new();
4903 for step in steps {
4904 let x86_64::Step::Label(name) = step else { continue };
4905 let block = self.out.create_block();
4906 let mut params = Vec::with_capacity(carried.len());
4907 for &(_, class) in &carried {
4908 params.push(self.out.append_param(block, class));
4909 }
4910 labels.push((name.as_str(), block, params));
4911 }
4912
4913 let mut wrote: Vec<usize> = Vec::new();
4914 for step in steps {
4915 match step {
4916 x86_64::Step::Label(name) => {
4917 let (block, params) = Self::went(&labels, name).ok_or_else(refused)?;
4918 let from = self.at.expect("a block is being filled");
4919 let args = Self::held(places, &carried).ok_or_else(refused)?;
4920 *self.out.succs_mut(from) = vec![mir::BlockCall::with(block, args)];
4921 self.at = Some(block);
4922 for (at, &(index, _)) in carried.iter().enumerate() {
4923 places[index].read = params.get(at).copied();
4924 }
4925 }
4926 x86_64::Step::Jump { opcode, to } => {
4927 let (block, _) = Self::went(&labels, to).ok_or_else(refused)?;
4928 let from = self.at.expect("a block is being filled");
4929 let args = Self::held(places, &carried).ok_or_else(refused)?;
4930 let opcode = self.named(opcode);
4931 self.out.build(from, opcode).at(span).finish();
4932 let next = self.out.create_block();
4933 *self.out.succs_mut(from) =
4934 vec![mir::BlockCall::with(block, args), mir::BlockCall::to(next)];
4935 self.at = Some(next);
4936 }
4937 x86_64::Step::Away { symbol } => {
4938 // Only in a function that is written without a prologue, which is the one
4939 // place the jump means what it says. Anywhere else there is an epilogue behind
4940 // the statement that puts the registers back and gives the frame up, and a
4941 // jump over it goes to the next function with this function's frame still
4942 // taken. The reader already made sure it is the last step of the template, so
4943 // what is left to ask is about the function around it.
4944 if !self.source.attrs.set.contains(AttrSet::NAKED) {
4945 return Err(Unsupported::Assembly { inst, refused: Written::Away });
4946 }
4947 let from = self.at.expect("a block is being filled");
4948 let opcode = self.named(AWAY);
4949 let symbol = self.names.intern(symbol);
4950 self.out.build(from, opcode).at(span).symbol(symbol).finish();
4951 // Nowhere, which is what a jump out of the function leaves behind it and is
4952 // the same list a `ret` leaves. The block after it is made for the walk above
4953 // rather than for the program: the statement may be in the middle of a body
4954 // that goes on being lowered, and what that lowering writes is reached by
4955 // nothing and thrown away with the block.
4956 *self.out.succs_mut(from) = Vec::new();
4957 self.at = Some(self.out.create_block());
4958 }
4959 x86_64::Step::Call { symbol } => {
4960 self.call_out(inst, symbol, places, list, clobbered, &carried, &mut wrote)?;
4961 }
4962 x86_64::Step::Line(line) => {
4963 let form = x86_64::form(line.opcode).ok_or_else(refused)?;
4964 let mut written = Vec::new();
4965 for (desc, piece) in form.operands().iter().zip(&line.operands) {
4966 if !desc.role.is_def() {
4967 continue;
4968 }
4969 let index = match *piece {
4970 x86_64::Piece::Operand { index, .. } => index,
4971 x86_64::Piece::Implicit { reg } => match bound(list, reg, desc.role) {
4972 Some(index) => index,
4973 None => continue,
4974 },
4975 x86_64::Piece::Reg { reg, .. } => match bound(list, reg, desc.role) {
4976 Some(index) => index,
4977 None => continue,
4978 },
4979 };
4980 written.push(index);
4981 }
4982 // A register is written once in this form of the machine IR, so an operand
4983 // an instruction above already wrote is written into a new one here, and what
4984 // reads it below reads that one.
4985 for &index in &written {
4986 if !wrote.contains(&index) {
4987 wrote.push(index);
4988 continue;
4989 }
4990 let &(_, class) =
4991 carried.iter().find(|&&(at, _)| at == index).ok_or_else(refused)?;
4992 let place = places.get_mut(index).ok_or_else(refused)?;
4993 place.write = Some(self.out.new_vreg(class));
4994 }
4995 self.instruction(inst, line, places, list, clobbered)?;
4996 for index in written {
4997 let place = places.get_mut(index).ok_or_else(refused)?;
4998 if place.write.is_some() {
4999 place.read = place.write;
5000 }
5001 }
5002 }
5003 }
5004 }
5005
5006 // Where the walk left each output, which is the parameter of the block a label made when
5007 // the template ends in one and the register an instruction wrote when it does not.
5008 for (index, operand) in list.iter().enumerate() {
5009 let Some(result) = operand.result else { continue };
5010 if let Some(reg) = places[index].read {
5011 self.regs[result.index()] = Some(reg);
5012 }
5013 }
5014 Ok(())
5015 }
5016
5017 /// A template's call to a function somewhere else, as the call the convention makes.
5018 ///
5019 /// The opcode is the one a call written in C becomes, so everything that asks whether a
5020 /// function calls anything gets the answer it would for one: the stack pointer is left aligned
5021 /// at the statement and nothing is kept in the red zone. What is not the same is the operands.
5022 /// Nothing is passed by the convention, since the template put the arguments where it wanted
5023 /// them, and what comes back is whatever an output is pinned to, since that is the only thing
5024 /// the template says about it. Every other register the callee may leave anything in is
5025 /// written here, which is what a program that calls from a template never says and always
5026 /// means.
5027 #[allow(clippy::too_many_arguments)]
5028 fn call_out(
5029 &mut self,
5030 inst: Inst,
5031 symbol: &str,
5032 places: &mut [Place],
5033 list: &[AsmOperand<'_>],
5034 clobbered: &[PhysReg],
5035 carried: &[(usize, RegClass)],
5036 wrote: &mut Vec<usize>,
5037 ) -> Result<(), Unsupported> {
5038 let refused = || Unsupported::Assembly { inst, refused: Written::Operand };
5039 let mut operands = Vec::new();
5040 let mut written = Vec::new();
5041 let lost = self.lost(list);
5042 for &(reg, class, index) in &lost {
5043 let Some(index) = index else {
5044 operands.push(mir::Operand::write(mir::Reg::physical(reg), class));
5045 continue;
5046 };
5047 // Written once in this form of the machine IR, so a second write is a new register,
5048 // the same as for an instruction in [`Self::woven`].
5049 if wrote.contains(&index) {
5050 let &(_, class) =
5051 carried.iter().find(|&&(at, _)| at == index).ok_or_else(refused)?;
5052 places.get_mut(index).ok_or_else(refused)?.write = Some(self.out.new_vreg(class));
5053 } else {
5054 wrote.push(index);
5055 }
5056 let place = places.get(index).ok_or_else(refused)?.write.ok_or_else(refused)?;
5057 operands.push(mir::Operand::write(place, class).with(Constraint::Fixed(reg)));
5058 written.push(index);
5059 }
5060 for ® in clobbered {
5061 if lost.iter().all(|&(gone, class, _)| gone != reg || class != self.gpr) {
5062 operands.push(mir::Operand::write(mir::Reg::physical(reg), self.gpr));
5063 }
5064 }
5065 let block = self.at.expect("a block is being filled");
5066 let span = self.source.span(inst);
5067 let opcode = mir::Opcode::new(self.names.intern(abi::CALL));
5068 let symbol = self.names.intern(symbol);
5069 let mut build = self.out.build(block, opcode).at(span).symbol(symbol);
5070 for operand in operands {
5071 build = build.operand(operand);
5072 }
5073 build.finish();
5074 let calls = &mut self.stack.calls;
5075 *calls = Some(calls.unwrap_or(0));
5076 for index in written {
5077 let place = places.get_mut(index).ok_or_else(refused)?;
5078 place.read = place.write;
5079 }
5080 Ok(())
5081 }
5082
5083 /// Every register a call may leave anything in, with its file and the output pinned to it if
5084 /// one is.
5085 ///
5086 /// A register is asked about with its file, since the two files are numbered from nought alike
5087 /// and a question about `v8` alone would find an output pinned to `x8`.
5088 ///
5089 /// The platform's own convention, whatever this function was written in, since what an `asm`
5090 /// statement calls is an ordinary function of the platform.
5091 fn lost(&self, list: &[AsmOperand<'_>]) -> Vec<(PhysReg, RegClass, Option<usize>)> {
5092 let conv = self.conv.under(Convention::Target).unwrap_or(self.conv);
5093 let ints = conv.int_order.iter().filter(|&®| !conv.preserves_int(reg));
5094 let sses = conv.sse_order.iter().filter(|&®| !conv.preserves_sse(reg));
5095 let written = |reg, class| {
5096 list.iter().position(|operand| {
5097 operand.result.is_some() && self.pinned_here(operand) == Some((reg, class))
5098 })
5099 };
5100 ints.map(|®| (reg, conv.int_class, written(reg, conv.int_class)))
5101 .chain(sses.map(|®| (reg, conv.sse_class, written(reg, conv.sse_class))))
5102 .collect()
5103 }
5104
5105 /// The input an output read before anything wrote it shares its register with, which is the
5106 /// one input that could be in that register, or nothing when there is none or more than one.
5107 ///
5108 /// Could be means nothing ties it elsewhere: it is in a register rather than in memory, no
5109 /// constraint pins it anywhere the output is not, and it is not tied to another output. An
5110 /// output written `&` shares nothing, since the assembly writes it before it reads the inputs.
5111 fn shared(&self, list: &[AsmOperand<'_>], index: usize) -> Option<Value> {
5112 let output = list.get(index)?;
5113 if output.early || output.tied.is_some() {
5114 return None;
5115 }
5116 let class = self.class_of(self.source[output.result?].ty);
5117 let mut fits = list.iter().filter(|operand| {
5118 operand.result.is_none()
5119 && !operand.memory
5120 && operand.tied.is_none()
5121 && operand.value.is_some_and(|value| self.class_of(self.source[value].ty) == class)
5122 && pinned(operand).is_none_or(|reg| pinned(output) == Some(reg))
5123 });
5124 let value = fits.next()?.value;
5125 if fits.next().is_some() {
5126 return None;
5127 }
5128 value
5129 }
5130
5131 /// The block one of the template's labels made, and the parameters it takes.
5132 fn went<'b>(
5133 labels: &'b [(&str, mir::Block, Vec<mir::Reg>)],
5134 name: &str,
5135 ) -> Option<(mir::Block, &'b [mir::Reg])> {
5136 labels
5137 .iter()
5138 .find(|(had, ..)| *had == name)
5139 .map(|(_, block, params)| (*block, params.as_slice()))
5140 }
5141
5142 /// The register each carried operand is in, which is what an arm to a label carries.
5143 fn held(places: &[Place], carried: &[(usize, RegClass)]) -> Option<Vec<mir::Reg>> {
5144 carried.iter().map(|&(index, _)| places.get(index)?.read).collect()
5145 }
5146
5147 /// The registers a clobber list names, in the order it named them.
5148 ///
5149 /// Nothing is dropped. A name this has no register for is refused, because the list is the
5150 /// program telling the compiler which registers it may not leave anything in, and an entry
5151 /// nobody read is a register something may still be left in. See [`Self::assembly`] for the
5152 /// two entries that are not registers and for why they are skipped rather than refused.
5153 fn clobbered(inst: Inst, clobbers: &str) -> Result<Vec<PhysReg>, Unsupported> {
5154 let refused = || Unsupported::Assembly { inst, refused: Written::Clobber };
5155 let mut named = Vec::new();
5156 for entry in clobbers.split(',') {
5157 let entry = entry.trim().trim_matches('"');
5158 // The sigil is optional in a clobber list and means nothing when it is there, unlike
5159 // in a template, where it is what tells a register from an operand.
5160 let entry = entry.strip_prefix('%').unwrap_or(entry);
5161 if entry.is_empty() || matches!(entry, "memory" | "cc" | "flags") {
5162 continue;
5163 }
5164 let (reg, _) = x86_64::gpr_named(entry).ok_or_else(refused)?;
5165 if !named.contains(®) {
5166 named.push(reg);
5167 }
5168 }
5169 Ok(named)
5170 }
5171
5172 /// [`Self::clobbered`] for a template kept as text, where a clobber may also name a vector
5173 /// register, `xmm0` or its wider spelling `ymm0`, which busybox's `xorbuf16_aligned_long` does.
5174 /// Each comes back with the file it is in, since `xmm0` and `rax` are both register nought.
5175 fn clobbered_x86(
5176 inst: Inst,
5177 clobbers: &str,
5178 gpr: RegClass,
5179 sse: RegClass,
5180 ) -> Result<Vec<(PhysReg, RegClass)>, Unsupported> {
5181 let mut named = Vec::new();
5182 let mut general = Vec::new();
5183 for entry in clobbers.split(',') {
5184 match vector_named(entry) {
5185 Some(reg) => {
5186 if !named.contains(&(reg, sse)) {
5187 named.push((reg, sse));
5188 }
5189 }
5190 None => general.push(entry),
5191 }
5192 }
5193 for reg in Self::clobbered(inst, &general.join(","))? {
5194 named.push((reg, gpr));
5195 }
5196 Ok(named)
5197 }
5198
5199 /// [`Self::clobbered`] on AArch64, where a clobber may name a vector register as well as a
5200 /// general purpose one, so each comes back with the file it is in. See [`aarch64::named`].
5201 fn clobbered_a64(inst: Inst, clobbers: &str) -> Result<Vec<(PhysReg, RegClass)>, Unsupported> {
5202 let refused = || Unsupported::Assembly { inst, refused: Written::Clobber };
5203 let mut named = Vec::new();
5204 for entry in clobbers.split(',') {
5205 let entry = entry.trim().trim_matches('"');
5206 if entry.is_empty() || matches!(entry, "memory" | "cc") {
5207 continue;
5208 }
5209 let reg = aarch64::named(entry).ok_or_else(refused)?;
5210 if !named.contains(®) {
5211 named.push(reg);
5212 }
5213 }
5214 Ok(named)
5215 }
5216
5217 /// Whether the machine being lowered for is AArch64.
5218 fn on_aarch64(&self) -> bool {
5219 std::ptr::eq(self.selector.shapes, &aarch64::MACHINE)
5220 }
5221
5222 /// The register an operand is pinned to on the machine being lowered for.
5223 ///
5224 /// [`pinned`] on x86, where it is always a general purpose register. AArch64 has no constraint
5225 /// letter for one register, so there only a local register variable pins anything, and its name
5226 /// is read against [`aarch64::named`], which may put it in either file. The file comes back with
5227 /// the register because the two are numbered from nought alike, and `x8` is not `v8`.
5228 fn pinned_here(&self, operand: &AsmOperand<'_>) -> Option<(PhysReg, RegClass)> {
5229 if !self.on_aarch64() {
5230 return pinned(operand).map(|reg| (reg, self.gpr));
5231 }
5232 let name = operand.named?;
5233 aarch64::named(name.strip_prefix('%').unwrap_or(name))
5234 }
5235
5236 /// An `asm` statement whose operands are `long double` values on the x87 stack.
5237 ///
5238 /// `t` is the top of the stack and `u` is the register under it, and those two letters, or a
5239 /// number tying an input to an output in one of them, are the only places taken here. That is
5240 /// what glibc's old `<bits/mathinline.h>` writes, `fpatan` with `=t`, `0` and `u` and `st(1)`
5241 /// in the clobber list, and it is gcc-torture `execute/990413-2.c`.
5242 ///
5243 /// The group is the shape every other one in [`Self::x87`] has. The inputs are pushed from the
5244 /// deepest up, so the `t` one is pushed last and ends up on top, then the template runs, then
5245 /// the outputs are popped into their slots from the top down. That leaves the stack as empty
5246 /// as it was found only when the template popped every input it was handed and pushed every
5247 /// output it says it leaves, and gcc's rule for these statements says when that is: an input
5248 /// tied to an output or named in the clobber list is one the template pops. So a statement
5249 /// with an input it leaves behind is refused, as is one with an operand anywhere other than
5250 /// `st(0)` and `st(1)`, since nothing here would know what to do with the stack after it.
5251 fn x87_assembly(&mut self, inst: Inst) -> Result<(), Unsupported> {
5252 let data = &self.source[inst];
5253 let Extra::Asm(asm) = data.extra else { return Err(self.unsupported(inst)) };
5254 let info = self.source[asm];
5255 if !self.source[info.targets].is_empty() {
5256 return Err(Unsupported::Assembly { inst, refused: Written::Goto });
5257 }
5258 let refused = || Unsupported::Assembly { inst, refused: Written::Operand };
5259 let constraints = self.names.resolve(info.constraints).to_string();
5260 let results: Vec<Value> = data.results().collect();
5261 let operands = AsmOperands::read(&constraints, &results, &self.source[data.args])
5262 .ok_or_else(refused)?;
5263 let list: Vec<AsmOperand<'_>> = operands.iter().copied().collect();
5264
5265 // Where on the stack each operand is, as a depth from the top.
5266 let letters: Vec<&str> = constraints.split(',').collect();
5267 let mut depths = Vec::with_capacity(list.len());
5268 for (operand, letter) in list.iter().zip(&letters) {
5269 let value = operand.result.or(operand.value).ok_or_else(refused)?;
5270 if operand.memory || !on_x87(self.source[value].ty) {
5271 return Err(refused());
5272 }
5273 let depth = match operand.tied {
5274 Some(output) => *depths.get(output).ok_or_else(refused)?,
5275 None => match letter.trim_start_matches(['=', '+', '&']) {
5276 "t" => 0,
5277 "u" => 1,
5278 _ => return Err(refused()),
5279 },
5280 };
5281 depths.push(depth);
5282 }
5283
5284 // Which depths the clobber list says the template pops.
5285 let clobbers = self.names.resolve(info.clobbers).to_string();
5286 let mut popped = [false; 2];
5287 for entry in clobbers.split(',') {
5288 let entry = entry.trim().trim_matches('"');
5289 let entry = entry.strip_prefix('%').unwrap_or(entry);
5290 match entry {
5291 "" | "memory" | "cc" | "flags" => {}
5292 "st" | "st(0)" => popped[0] = true,
5293 "st(1)" => popped[1] = true,
5294 _ => return Err(Unsupported::Assembly { inst, refused: Written::Clobber }),
5295 }
5296 }
5297
5298 // The inputs, one per depth and from the top down with no gap, and each one popped.
5299 let mut inputs: Vec<Option<Value>> = vec![None; 2];
5300 let mut outputs: Vec<Option<Value>> = vec![None; 2];
5301 for (index, operand) in list.iter().enumerate() {
5302 let depth = depths[index];
5303 if let Some(result) = operand.result {
5304 if outputs[depth].replace(result).is_some() {
5305 return Err(refused());
5306 }
5307 }
5308 let Some(value) = operand.value else { continue };
5309 // An output written `+` is an input tied to itself.
5310 let consumed = operand.result.is_some() || operand.tied.is_some() || popped[depth];
5311 if !consumed {
5312 return Err(refused());
5313 }
5314 if inputs[depth].replace(value).is_some() {
5315 return Err(refused());
5316 }
5317 }
5318 let gapless =
5319 |held: &[Option<Value>]| held.iter().skip_while(|it| it.is_some()).all(Option::is_none);
5320 if !gapless(&inputs) || !gapless(&outputs) {
5321 return Err(refused());
5322 }
5323
5324 // The text, with an operand spelled as the register it is in.
5325 let template = self.names.resolve(info.template).to_string();
5326 let mut text = String::with_capacity(template.len());
5327 let mut chars = template.chars().peekable();
5328 while let Some(c) = chars.next() {
5329 if c != '%' {
5330 text.push(c);
5331 continue;
5332 }
5333 match chars.peek().copied() {
5334 Some('%') => {
5335 chars.next();
5336 text.push('%');
5337 }
5338 Some('=') => {
5339 chars.next();
5340 text.push_str(&inst.index().to_string());
5341 }
5342 Some(digit) if digit.is_ascii_digit() => {
5343 chars.next();
5344 if chars.peek().is_some_and(char::is_ascii_digit) {
5345 return Err(refused());
5346 }
5347 let index = digit.to_digit(10).map_or(usize::MAX, |it| it as usize);
5348 match depths.get(index).ok_or_else(refused)? {
5349 0 => text.push_str("%st"),
5350 depth => text.push_str(&format!("%st({depth})")),
5351 }
5352 }
5353 _ => return Err(refused()),
5354 }
5355 }
5356
5357 let span = self.source.span(inst);
5358 for value in inputs.iter().rev().flatten() {
5359 let from = self.x87_slot(*value);
5360 let from = self.through(from);
5361 self.x87_at("fld_t", span, from);
5362 }
5363 let symbol = self.names.intern(&text);
5364 let opcode = self.named(x86_64::TEMPLATE);
5365 let block = self.at.expect("a block is being filled");
5366 self.out.build(block, opcode).at(span).symbol(symbol).finish();
5367 for value in outputs.iter().flatten() {
5368 let into = self.x87_slot(*value);
5369 let into = self.through(into);
5370 self.x87_at("fstp_t", span, into);
5371 }
5372 Ok(())
5373 }
5374
5375 /// An `asm` statement on AArch64, which is kept as text whatever is in it.
5376 ///
5377 /// Nothing reads AArch64 assembly back into instructions yet, so every template goes the way
5378 /// one the x86 reader could not take apart goes, which is [`Self::kept`]: the text is carried
5379 /// to the listing with a hole for each operand, and the operands are the instruction's own. A
5380 /// constraint with a letter whose meaning differs between the two machines is refused first.
5381 /// See [`shared_letters`].
5382 fn spelled(&mut self, inst: Inst) -> Result<(), Unsupported> {
5383 let data = &self.source[inst];
5384 let Extra::Asm(asm) = data.extra else { return Err(self.unsupported(inst)) };
5385 let info = self.source[asm];
5386 if self.jumps_from_text(inst) {
5387 return Err(Unsupported::Assembly { inst, refused: Written::Goto });
5388 }
5389 let refused = || Unsupported::Assembly { inst, refused: Written::Operand };
5390 let constraints = self.names.resolve(info.constraints).to_string();
5391 if !constraints.split(',').all(shared_letters) {
5392 return Err(refused());
5393 }
5394 // `Q` is memory addressed by one register and nothing else, which is how every operand in
5395 // memory is spelled here already, so it is read as `m`. See [`shared_letters`].
5396 let constraints = letters_outside(&constraints, |c| if c == 'Q' { 'm' } else { c });
5397 let results: Vec<Value> = data.results().collect();
5398 let operands = AsmOperands::read(&constraints, &results, &self.source[data.args])
5399 .ok_or_else(refused)?;
5400 let list: Vec<AsmOperand<'_>> = operands.iter().copied().collect();
5401 let widths = vec![None; list.len()];
5402 let memory: Vec<bool> = list.iter().map(|operand| operand.memory).collect();
5403 let template = self.names.resolve(info.template).to_string();
5404 self.kept(inst, &template, &list, &widths, &memory)
5405 }
5406
5407 /// One instruction of a template, as the machine instruction it was read back into.
5408 fn instruction(
5409 &mut self,
5410 inst: Inst,
5411 line: &x86_64::Line,
5412 places: &[Place],
5413 list: &[AsmOperand<'_>],
5414 clobbered: &[PhysReg],
5415 ) -> Result<(), Unsupported> {
5416 let refused = || Unsupported::Assembly { inst, refused: Written::Operand };
5417 let form = x86_64::form(line.opcode).ok_or_else(refused)?;
5418 // What the instruction reaches and what is in each of them. The description answers the
5419 // first for every opcode but one, and the pieces the template was read into answer the
5420 // second. Bytes a program wrote out itself are the one, since nothing in a number is a
5421 // register anybody could read, so the constraint letters answer both. See
5422 // [`Self::lettered`].
5423 let lettered = (line.opcode == x86_64::LITERAL).then(|| self.lettered(list));
5424 let (described, pieces) = match &lettered {
5425 Some((described, pieces)) => (described.as_slice(), pieces.as_slice()),
5426 None => (form.operands(), line.operands.as_slice()),
5427 };
5428 let mut built = Vec::with_capacity(pieces.len() + clobbered.len());
5429 for (desc, piece) in described.iter().zip(pieces) {
5430 built.push(self.placed(inst, *desc, *piece, places, list)?);
5431 }
5432 // The clobbers go in among the definitions rather than behind the reads, because an operand
5433 // vector in the machine IR is every definition and then every use and what counts them
5434 // reads that order rather than each operand's role.
5435 let defs = built.iter().take_while(|operand| operand.role.is_def()).count();
5436 let mut added = 0usize;
5437 for ® in clobbered {
5438 if described.iter().any(|desc| desc.constraint == Constraint::Fixed(reg)) {
5439 continue;
5440 }
5441 built.insert(defs, mir::Operand::write(mir::Reg::physical(reg), self.gpr));
5442 added += 1;
5443 }
5444 // A constraint tying one operand to another names it by its place in this vector, and the
5445 // clobbers were put in the middle of the vector, so everything behind them moved. The
5446 // description is written against an instruction with no clobbers in it and cannot know
5447 // that, which makes this the one place the two numberings have to be reconciled.
5448 for operand in &mut built {
5449 if let Constraint::Reuse(at) = operand.constraint {
5450 if usize::from(at) >= defs {
5451 let moved = usize::from(at) + added;
5452 operand.constraint =
5453 Constraint::Reuse(u8::try_from(moved).map_err(|_| refused())?);
5454 }
5455 }
5456 }
5457 let at = match line.at {
5458 Some(at) => Some(self.addressed(inst, at, places, list)?),
5459 None => None,
5460 };
5461
5462 let block = self.at.expect("a block is being filled");
5463 let span = self.source.span(inst);
5464 let opcode = self.named(line.opcode);
5465 let mut build = self.out.build(block, opcode).at(span);
5466 for operand in built {
5467 build = build.operand(operand);
5468 }
5469 if let Some(value) = line.imm {
5470 build = build.imm(value);
5471 }
5472 if let Some(mem) = at {
5473 build = build.mem(mem);
5474 }
5475 build.finish();
5476 Ok(())
5477 }
5478
5479 /// The registers a run of bytes reaches, taken from the constraint letters rather than from the
5480 /// description of an opcode.
5481 ///
5482 /// Every other instruction of a template has a description saying which registers it reaches
5483 /// without naming them, and [`Self::assembly`] matches the letters against that. Bytes a program
5484 /// wrote out itself have no such description and could not have one: what the instruction is, is
5485 /// a number, and nothing in a number is a register anything could read. So the letters are the
5486 /// whole of what is known, and they are enough, because a program writing an instruction this
5487 /// way has to say where its operands go for exactly the reason a program writing `cpuid` does.
5488 ///
5489 /// Each register named by a letter gets one entry for the write and one for the read, the same
5490 /// two `cpuid` has, and only the half the statement asked for: a register no output names is not
5491 /// written here and one no input names is not read. The writes come first because that is the
5492 /// order an operand vector in the machine IR is counted in. A register named by nothing is left
5493 /// out rather than given a spare one, which is the difference from `cpuid` and is right for the
5494 /// same reason: `cpuid` writes four registers whatever the program said, and what these bytes
5495 /// touch is known only from what the program said.
5496 fn lettered(&self, list: &[AsmOperand<'_>]) -> (Vec<OperandDesc>, Vec<x86_64::Piece>) {
5497 let mut named: Vec<PhysReg> = Vec::new();
5498 for operand in list {
5499 if let Some(reg) = pinned(operand) {
5500 if !named.contains(®) {
5501 named.push(reg);
5502 }
5503 }
5504 }
5505 let mut described = Vec::with_capacity(named.len() * 2);
5506 let mut pieces = Vec::with_capacity(named.len() * 2);
5507 for role in [Role::Def, Role::Use] {
5508 for ® in &named {
5509 if bound(list, reg, role).is_none() {
5510 continue;
5511 }
5512 let desc = if role.is_def() {
5513 OperandDesc::write(self.gpr)
5514 } else {
5515 OperandDesc::read(self.gpr)
5516 };
5517 described.push(desc.with(Constraint::Fixed(reg)));
5518 pieces.push(x86_64::Piece::Implicit { reg });
5519 }
5520 }
5521 (described, pieces)
5522 }
5523
5524 /// One operand of one instruction of a template, in the register the statement put it in.
5525 fn placed(
5526 &mut self,
5527 inst: Inst,
5528 desc: OperandDesc,
5529 piece: x86_64::Piece,
5530 places: &[Place],
5531 list: &[AsmOperand<'_>],
5532 ) -> Result<mir::Operand, Unsupported> {
5533 let refused = || Unsupported::Assembly { inst, refused: Written::Operand };
5534 // A register the instruction reaches without its text naming it belongs to whichever of the
5535 // statement's operands a constraint letter put there, and to nobody when no letter did.
5536 // There is no width to check in that case: the operand is the register the letter named and
5537 // the instruction does what it does to it, which is what a program writing `"=a"` asked for.
5538 let (index, spelled) = match piece {
5539 x86_64::Piece::Operand { index, width, stated } => (index, Some((width, stated))),
5540 x86_64::Piece::Implicit { reg } => match bound(list, reg, desc.role) {
5541 Some(index) => (index, None),
5542 None => return self.spare(inst, desc),
5543 },
5544 // A register the template named, which belongs to one of the statement's operands when
5545 // a constraint letter put that operand there and to nobody otherwise. Asked in that
5546 // order rather than placed straight away, because `"D" (p)` with `%rdi` in the text is
5547 // the program saying one thing twice, and answering it twice would hand the allocator
5548 // one register holding two values.
5549 x86_64::Piece::Reg { reg, .. } => match bound(list, reg, desc.role) {
5550 Some(index) => (index, None),
5551 None => return self.itself(inst, desc, reg),
5552 },
5553 };
5554 let operand = list.get(index).copied().ok_or_else(refused)?;
5555 // The two halves of an operand written `+`, which arrives in one register and leaves in
5556 // another with the allocator told to make them the same one. Everything else has one of
5557 // the two and asking for the other is the refusal below.
5558 let place = places.get(index).copied().ok_or_else(refused)?;
5559 let reg = match desc.role {
5560 Role::Use => place.read,
5561 Role::Def | Role::EarlyDef => place.write,
5562 }
5563 .ok_or_else(refused)?;
5564
5565 // Read where the opcode reads and written where it writes, which is what the first half of
5566 // this asks. An output has a result and an input has a value, an output written `+` has
5567 // both because it is read before it is written, and an output a matching constraint names
5568 // is read as the input that named it. See [`read_as`].
5569 // An output with neither is read as well, and what it holds there is undefined, which
5570 // [`Self::assembly`] says why and puts a zero in a register for.
5571 let placeable = match desc.role {
5572 Role::Use => read_as(list, index).is_some() || operand.result.is_some(),
5573 Role::Def | Role::EarlyDef => operand.result.is_some(),
5574 };
5575 let ty = match (operand.result, operand.value) {
5576 (Some(result), _) => self.source[result].ty,
5577 (None, Some(value)) => self.source[value].ty,
5578 (None, None) => return Err(refused()),
5579 };
5580 let bits = held_bits(ty);
5581 if !placeable || self.class_of(ty) != desc.class {
5582 return Err(refused());
5583 }
5584 if let Some((width, stated)) = spelled {
5585 // An operand the template wrote a width on may be written by an instruction that fills
5586 // more of the register than the object in it does, and the object is then the low part
5587 // of what was written. That is what gmp asks for when it counts the low zero bits of a
5588 // limb into an `unsigned` and spells the count `%q0`: one quadword instruction writes
5589 // the whole register and the `unsigned` is the bottom of it, which is every bit of an
5590 // answer that cannot exceed sixty four anyway.
5591 //
5592 // An operand read at a width the template wrote is the other way round: the object is
5593 // in the register and the instruction looks at the bottom of it. tcc tests the low bits
5594 // of a `size_t` count with `testb $2,%b4`, and every bit that test reads is one the
5595 // object put there.
5596 //
5597 // A write of less of a register than the object fills is right in one case, which is
5598 // an instruction that reads the register it writes and an operand that arrives with
5599 // the object in it. The top of the register is then the top of the object, and the
5600 // instruction leaves it alone. tcc swaps the bytes of an `unsigned` with `xchgb
5601 // %b0,%h0` and a rotate between two of them, and the swap only ever touches the low
5602 // half.
5603 //
5604 // The two that stay refused are a read of more of a register than its type fills,
5605 // which hands an instruction bits nothing ever put there, and a write of less of one
5606 // that nothing carried the object into, which leaves the top of the object holding
5607 // whatever the register held before. An operand the template left plain is refused
5608 // either way, because what gets spelled for that one is the register at the width of
5609 // its type and no other instruction is the one written down.
5610 let carried = matches!(desc.constraint, Constraint::Reuse(_) | Constraint::Fixed(_))
5611 && read_as(list, index).is_some();
5612 // The other case is the one the machine settles by itself: a write of the low four
5613 // bytes of a register clears the four above them, so a sixty four bit object written
5614 // that way holds the thirty two bit answer and nothing else. tcc loads a word through
5615 // `movl 4(%0),%k0` into a `long` and means exactly that.
5616 let cleared = desc.class == self.gpr && width == x86_64::Width::Long && bits == 64;
5617 let widened = stated && desc.role.is_def() && width.bits() > bits;
5618 let narrowed =
5619 stated && width.bits() < bits && (!desc.role.is_def() || carried || cleared);
5620 if bits != width.bits() && !widened && !narrowed {
5621 return Err(refused());
5622 }
5623 }
5624 // An operand the program pinned is in that register and nowhere else, whatever the opcode
5625 // would have allowed it. That is the whole of what a local register variable asks for, and
5626 // it is the same shape a division already has: the allocator is told the register, puts a
5627 // move in front or behind where it has to, and leaves it out where it does not.
5628 let constraint = match pinned(&operand) {
5629 Some(reg) => Constraint::Fixed(reg),
5630 None => desc.constraint,
5631 };
5632 Ok(mir::Operand { reg, class: desc.class, role: desc.role, constraint })
5633 }
5634
5635 /// A register the template named in its own text.
5636 ///
5637 /// Not one of the statement's operands and not something the allocator handed out. The program
5638 /// wrote `%rbx` in the middle of a template and meant that register, which is what code doing
5639 /// something the constraint letters cannot say is made of: micropython saves the callee-saved
5640 /// registers into a buffer by name because the whole point of the buffer is that those exact
5641 /// registers are in it, and there is no constraint letter for `%rsp`.
5642 ///
5643 /// So it is placed as itself, fixed to the register the template named. What that buys is the
5644 /// thing gcc does not do: the register becomes part of the instruction the allocator sees, so a
5645 /// write of one is a definition it knows about and will not leave anything of the program's
5646 /// across, and a read of one is a use it will not have put something else in first. gcc copies
5647 /// the text out and a register two things believe they own is a wrong program nothing reports.
5648 /// Here the allocator is told, and a program that also named the register in its clobber list
5649 /// says the same thing twice rather than something new.
5650 fn itself(
5651 &mut self,
5652 inst: Inst,
5653 desc: OperandDesc,
5654 reg: PhysReg,
5655 ) -> Result<mir::Operand, Unsupported> {
5656 let refused = Unsupported::Assembly { inst, refused: Written::Operand };
5657 if desc.class != self.gpr {
5658 return Err(refused);
5659 }
5660 Ok(mir::Operand {
5661 reg: mir::Reg::physical(reg),
5662 class: self.gpr,
5663 role: desc.role,
5664 constraint: Constraint::Fixed(reg),
5665 })
5666 }
5667
5668 /// A register an instruction of a template uses and the statement put nothing in.
5669 ///
5670 /// A write of one is the register being destroyed, which is what a clobber list is usually
5671 /// written to say and what an instruction with more answers than the program asked for does
5672 /// anyway: `cpuid` writes all four registers whether or not the statement wanted all four. A
5673 /// register of its own is the whole of what that needs, since a value nothing reads is one the
5674 /// allocator may put anywhere and is told about so that nothing else is put there.
5675 ///
5676 /// A read of one is a register the instruction looks at and the program never filled, which
5677 /// gcc leaves as whatever happened to be there. A zero is written instead, for the reason
5678 /// [`Self::undefined`] gives: the allocator has to be given a definition before a use, and a
5679 /// zero is the one answer that reads the same on every run.
5680 fn spare(&mut self, inst: Inst, desc: OperandDesc) -> Result<mir::Operand, Unsupported> {
5681 let refused = Unsupported::Assembly { inst, refused: Written::Operand };
5682 if desc.class != self.gpr {
5683 return Err(refused);
5684 }
5685 let reg = self.out.new_vreg(desc.class);
5686 if !desc.role.is_def() {
5687 let block = self.at.expect("a block is being filled");
5688 let span = self.source.span(inst);
5689 let put = self.named("mov_ri_64");
5690 self.out.build(block, put).at(span).def(reg, desc.class).imm(0).finish();
5691 }
5692 Ok(mir::Operand { reg, class: desc.class, role: desc.role, constraint: desc.constraint })
5693 }
5694
5695 /// The address one instruction of a template reads or writes.
5696 fn addressed(
5697 &mut self,
5698 inst: Inst,
5699 at: x86_64::At,
5700 places: &[Place],
5701 list: &[AsmOperand<'_>],
5702 ) -> Result<mir::Mem, Unsupported> {
5703 let refused = || Unsupported::Assembly { inst, refused: Written::Operand };
5704 let base = match at.base {
5705 None => None,
5706 Some(x86_64::Piece::Operand { index, .. }) => {
5707 // The register an address is counted from is read and never written, whatever the
5708 // instruction does to what it finds there.
5709 let reg = places.get(index).and_then(|place| place.read).ok_or_else(refused)?;
5710 Some(mir::Operand::read(reg, self.gpr))
5711 }
5712 // A register the template named, counted from as itself. See [`Self::itself`], and note
5713 // that this is the half of it every one of these templates needs: `movq %rax, 16(%rdi)`
5714 // names one register as the thing being stored and another as where to store it. An
5715 // operand a constraint letter put in that register is that operand, for the reason
5716 // [`Self::placed`] gives.
5717 Some(x86_64::Piece::Reg { reg, .. }) => match bound(list, reg, Role::Use) {
5718 Some(index) => {
5719 let reg = places.get(index).and_then(|place| place.read).ok_or_else(refused)?;
5720 Some(mir::Operand::read(reg, self.gpr))
5721 }
5722 None => Some(
5723 mir::Operand::read(mir::Reg::physical(reg), self.gpr)
5724 .with(Constraint::Fixed(reg)),
5725 ),
5726 },
5727 // An address counted from a register the instruction reaches without being told is
5728 // not something this machine has: every addressing mode is written out in the text it
5729 // is part of, so a base that got here another way is a base nothing wrote down.
5730 Some(x86_64::Piece::Implicit { .. }) => return Err(refused()),
5731 };
5732 // A distance the template wrote, or the one in an operand the template pointed at, which is
5733 // the same distance said by something that knows how big a thing is. It has to be a number
5734 // the compiler can read at translation time, since it goes in the instruction rather than
5735 // in a register, and an operand holding anything else is refused rather than put somewhere.
5736 let disp = match at.disp {
5737 x86_64::Disp::Number(disp) => disp,
5738 x86_64::Disp::Operand(index) => {
5739 let value =
5740 list.get(index).and_then(|operand| operand.value).ok_or_else(refused)?;
5741 let number = self.number(value).ok_or_else(refused)?;
5742 i32::try_from(number).map_err(|_| refused())?
5743 }
5744 };
5745 Ok(mir::Mem { base, scale: 1, disp, segment: at.segment, ..mir::Mem::default() })
5746 }
5747
5748 /// The number in that value, for one an `iconst` defined, read at the width of its own type.
5749 ///
5750 /// Signed, because the two things a template asks this for are a distance into an address and
5751 /// the number on an instruction, and both of those are signed wherever they land. A constant
5752 /// whose type is unsigned and whose top bit is set therefore reads as a negative number here,
5753 /// which is the same number and is the reading that fits in the thirty two bits an addressing
5754 /// mode has room for.
5755 fn number(&self, value: Value) -> Option<i128> {
5756 let Def::Result { inst, .. } = self.source[value].def else { return None };
5757 if self.source[inst].opcode != Opcode::IConst {
5758 return None;
5759 }
5760 let Extra::Imm(imm) = self.source[inst].extra else { return None };
5761 let bits = self.source[imm].bits();
5762 let width = self.source[value].ty.bits();
5763 if width == 0 || width > 128 {
5764 return None;
5765 }
5766 let spare = 128 - width;
5767 Some(((bits << spare) as i128) >> spare)
5768 }
5769
5770 /// A register holding a value the program has no claim on, written as a zero.
5771 ///
5772 /// Every other way of saying it costs the same instruction or needs a word the machine IR does
5773 /// not have, and a zero is the one that reads the same on every run.
5774 fn undefined(&mut self, inst: Inst, result: Value) -> Result<(), Unsupported> {
5775 let ty = self.source[result].ty;
5776 let refused = Unsupported::Assembly { inst, refused: Written::Operand };
5777 let bits = held_bits(ty);
5778 if self.class_of(ty) != self.gpr || !matches!(bits, 8 | 16 | 32 | 64) {
5779 return Err(refused);
5780 }
5781 let block = self.at.expect("a block is being filled");
5782 let span = self.source.span(inst);
5783 let reg = self.new_reg(result);
5784 let put = self.named(&format!("mov_ri_{bits}"));
5785 self.out.build(block, put).at(span).def(reg, self.gpr).imm(0).finish();
5786 Ok(())
5787 }
5788
5789 /// Whether a type is the width an address is, which is what makes a cast to or from one free.
5790 fn is_address_width(&self, ty: Type) -> bool {
5791 ty.is_ptr() || (ty.is_int() && ty.bits() == ADDRESS_BITS)
5792 }
5793
5794 /// Where a block goes, which in machine IR is on the block rather than on its terminator.
5795 ///
5796 /// That is why no rule ever names a block: a branch is selected for what it reads and the
5797 /// edges are copied across here, arguments and all. The arguments are read last, after every
5798 /// instruction of the block is written, because an argument that is a constant is
5799 /// materialized where it is first wanted and the end of the block is where an edge wants it.
5800 ///
5801 /// Which is not quite the end. A block that leaves two ways has the branch as its last
5802 /// instruction, and a block that leaves through a register has the indirect jump as its last,
5803 /// and anything appended after either is something it has already jumped past, so a constant
5804 /// materialized here would be a register the block below reads and nothing ever writes. The
5805 /// one that was there is put back on the end when that happened, which is the only reordering
5806 /// anything in this crate does and is why it is remembered before a single argument is read.
5807 fn edges(&mut self, block: Block, out: mir::Block) -> Result<(), Unsupported> {
5808 let Some(term) = self.source.terminator(block) else { return Ok(()) };
5809 // An `asm goto` whose template has nothing in it can only fall through, since there is no
5810 // instruction in it to jump with, so the only edge the machine block gets is the first
5811 // one. The labels it names are still arms in the IR, which is what kept the passes above
5812 // from assuming anything about the way into them, and here they are blocks nothing jumps
5813 // to, the same as a label no `goto` names. One that does have instructions was refused by
5814 // [`Self::jumps_from_text`] before this.
5815 if self.source[term].opcode == Opcode::InlineAsm {
5816 let Some(call) = self.source.successors(term).next() else { return Ok(()) };
5817 let args: Vec<Value> = self.source[call.args].to_vec();
5818 let regs =
5819 args.into_iter().map(|value| self.reg_of(value)).collect::<Result<_, _>>()?;
5820 *self.out.succs_mut(out) = vec![mir::BlockCall::with(self.out_block(call.block), regs)];
5821 return Ok(());
5822 }
5823 // A call's unwind edge, which is not an edge of the machine function at all. The branch was
5824 // never written, so what the block has is the arm control takes when the call returns, and
5825 // the pad is a block with nothing in front of it that the call site table is what reaches.
5826 // See [`Self::pad`] for why that is a block the allocator can be handed.
5827 if let Some(unwound) = self.unwind_edge(term) {
5828 let arms: Vec<rucc_ir::BlockCall> = self.source.successors(term).collect();
5829 let next = arms[1];
5830 let args: Vec<Value> = self.source[next.args].to_vec();
5831 let regs =
5832 args.into_iter().map(|value| self.reg_of(value)).collect::<Result<_, _>>()?;
5833 *self.out.succs_mut(out) = vec![mir::BlockCall::with(self.out_block(next.block), regs)];
5834 let call = self.source.prev_inst(unwound).and_then(|call| self.unwinding.get(&call));
5835 if let Some(&call) = call {
5836 let pad = self.out_block(arms[0].block);
5837 self.out.landings.push((call, pad));
5838 }
5839 return Ok(());
5840 }
5841 let leaves =
5842 matches!(self.source[term].opcode, Opcode::BrIf | Opcode::IndirectBr | Opcode::Switch);
5843 let branch = if leaves { self.out.terminator(out) } else { None };
5844
5845 let calls: Vec<rucc_ir::BlockCall> = self.source.successors(term).collect();
5846 let mut succs = Vec::with_capacity(calls.len());
5847 for call in calls {
5848 let args: Vec<Value> = self.source[call.args].to_vec();
5849 let mut regs = Vec::with_capacity(args.len());
5850 for value in args {
5851 // The address of where the value is rather than the value, for the one type a
5852 // register holds none of. The block on the other side copies the bytes out of it
5853 // into a slot of its own, which is what makes a second edge into the same block
5854 // safe.
5855 let reg = if on_x87(self.source[value].ty) {
5856 self.x87_slot(value)
5857 } else {
5858 self.reg_of(value)?
5859 };
5860 regs.push(reg);
5861 }
5862 succs.push(mir::BlockCall::with(self.out_block(call.block), regs));
5863 }
5864 if let Some(branch) = branch {
5865 if self.out.terminator(out) != Some(branch) {
5866 self.out.remove_inst(branch);
5867 self.out.append_inst(out, branch);
5868 }
5869 }
5870 *self.out.succs_mut(out) = succs;
5871 Ok(())
5872 }
5873
5874 /// The `unwound` a branch reads, when the branch is a call's unwind edge.
5875 fn unwind_edge(&self, inst: Inst) -> Option<Inst> {
5876 let data = &self.source[inst];
5877 if data.opcode != Opcode::BrIf {
5878 return None;
5879 }
5880 let &cond = self.source[data.args].first()?;
5881 match self.source[cond].def {
5882 Def::Result { inst, .. } if self.source[inst].opcode == Opcode::Unwound => Some(inst),
5883 _ => None,
5884 }
5885 }
5886
5887 /// The exception a landing pad was entered with, as a copy out of the register the unwinder
5888 /// left it in, which is the first register a value comes back in.
5889 fn landing(&mut self, inst: Inst) -> Result<(), Unsupported> {
5890 let result = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
5891 let held = *self.conv.int_returns.first().ok_or_else(|| self.unsupported(inst))?;
5892 let block = self.at.expect("a block is being filled");
5893 let span = self.source.span(inst);
5894 let mov = self.selector.frame.moves(self.gpr).expect("a class the target says how to move");
5895 let mov = self.named(mov.mov);
5896 let into = self.new_reg(result);
5897 self.out
5898 .build(block, mov)
5899 .at(span)
5900 .operand(mir::Operand::write(into, self.gpr))
5901 .operand(
5902 mir::Operand::read(mir::Reg::physical(held), self.gpr)
5903 .with(Constraint::Fixed(held)),
5904 )
5905 .finish();
5906 Ok(())
5907 }
5908
5909 /// Makes a landing pad a block that reads nothing from the blocks around it, and says what to
5910 /// put back once it has been filled.
5911 ///
5912 /// The pad has no machine block in front of it, because the edge into it is not one the machine
5913 /// takes: control arrives from the unwinder, with the registers the frame rules at the call put
5914 /// back. So nothing the allocator keeps in a register can reach it, and a value it reads from
5915 /// elsewhere is made again inside it. What a pad reads is the address of each object a handler
5916 /// is owed, which is a slot of the frame, the address of a name, or a constant, and each of
5917 /// those can be written a second time from nothing. Anything else is refused.
5918 ///
5919 /// The registers the rest of the function knows those values by are put back afterwards,
5920 /// which is what the answer is for: the pad's copies are its own.
5921 fn pad(&mut self, block: Block) -> Result<Vec<(Value, Option<mir::Reg>)>, Unsupported> {
5922 let mut kept = Vec::new();
5923 let first = self.source.insts(block).next();
5924 if !first.is_some_and(|inst| self.source[inst].opcode == Opcode::Landing) {
5925 return Ok(kept);
5926 }
5927 let out = self.at.expect("a block is being filled");
5928 let insts: Vec<Inst> = self.source.insts(block).collect();
5929 for inst in insts {
5930 let args: Vec<Value> = self.source[self.source[inst].args].to_vec();
5931 for value in args {
5932 let Def::Result { inst: def, .. } = self.source[value].def else {
5933 return Err(self.unsupported(inst));
5934 };
5935 if self.source.block_of(def) == Some(block)
5936 || kept.iter().any(|&(done, _)| done == value)
5937 {
5938 continue;
5939 }
5940 match self.source[def].opcode {
5941 Opcode::IConst => {}
5942 Opcode::Alloca => {
5943 let &index =
5944 self.frame_slots.get(&value).ok_or_else(|| self.unsupported(def))?;
5945 kept.push((value, self.regs[value.index()]));
5946 let reg = self.out.new_vreg(self.gpr);
5947 self.regs[value.index()] = Some(reg);
5948 let lea = self.named(self.selector.frame.lea);
5949 let sp = mir::Reg::physical(self.conv.stack_pointer);
5950 let sp = mir::Operand::read(sp, self.gpr);
5951 let span = self.source.span(def);
5952 let made = self
5953 .out
5954 .build(out, lea)
5955 .at(span)
5956 .def(reg, self.gpr)
5957 .mem(mir::Mem::at(sp))
5958 .finish();
5959 self.stack.addresses.push((made, index));
5960 }
5961 Opcode::GlobalAddr => {
5962 kept.push((value, self.regs[value.index()]));
5963 self.regs[value.index()] = None;
5964 self.address_of(def)?;
5965 }
5966 _ => return Err(self.unsupported(def)),
5967 }
5968 }
5969 }
5970 Ok(kept)
5971 }
5972
5973 /// Whether an `asm goto` has instructions in its template, which is what it would jump with.
5974 ///
5975 /// One with an empty template is what a program writes to tell the optimizer that control may
5976 /// arrive at a label without saying how, and the torture suite has several of them. It never
5977 /// jumps, so it is written as the statement it would be without its labels and a fall through
5978 /// into its first arm. See [`Self::edges`]. One with anything in it needs the labels it names
5979 /// written into the text and an edge for each of them the allocator knows about, and that is
5980 /// still refused.
5981 fn jumps_from_text(&self, inst: Inst) -> bool {
5982 let Extra::Asm(asm) = self.source[inst].extra else { return false };
5983 let info = self.source[asm];
5984 !self.source[info.targets].is_empty()
5985 && !self.names.resolve(info.template).trim().is_empty()
5986 }
5987
5988 /// The machine IR block an IR block became.
5989 fn out_block(&self, block: Block) -> mir::Block {
5990 self.blocks[block.index()].expect("every block was created before any was filled")
5991 }
5992
5993 /// The parameters of the entry block, which are the function's arguments.
5994 ///
5995 /// They are not block parameters in the machine IR and they cannot be. A block parameter is
5996 /// given its value by a move on the edge into the block, and there is no edge into an entry
5997 /// block, so what arrives in a function is the convention's to say. [`crate::abi`] is what
5998 /// says it.
5999 ///
6000 /// The ones past the last register arrived in the caller's memory and are read out of it, and
6001 /// the loads that read them come back here so that the frame can finish them the way it
6002 /// finishes an `alloca`.
6003 fn arrive(&mut self, block: Block, out: mir::Block) -> Result<(), Unsupported> {
6004 let params = self.source[block].params.clone();
6005 // The type of each is the block's answer and what the ABI asks of it is the signature's,
6006 // and the two lists are the same list: a parameter the classification turned into a
6007 // pointer is a pointer in the block too. A block with more parameters than the signature
6008 // names is not one the front end writes, and each of those is taken as a plain value.
6009 let asked: Vec<Abi> = self.source.signature().params.iter().map(|it| it.abi).collect();
6010 let types: Vec<Param> = params
6011 .iter()
6012 .enumerate()
6013 .map(|(index, &value)| {
6014 let abi = asked.get(index).copied().unwrap_or_default();
6015 Param { ty: self.source[value].ty, abi }
6016 })
6017 .collect();
6018 // A save area for a function that takes arguments its signature does not name, which is a
6019 // block of this function's frame on one convention and the shadow space the caller already
6020 // reserved on the other. Which of the two it is is [`varargs::Area::of`]'s answer and
6021 // [`Self::save_area`] is where the difference is spent.
6022 //
6023 // Apple's AArch64 is neither. Every argument a signature does not name is in the caller's
6024 // memory, so there is nothing to save and the list starts at the first word past the named
6025 // ones.
6026 //
6027 // A function holding `__builtin_apply_args` asks for the same area whether it is variadic
6028 // or not, because what it saves is every argument register, and the area is where the
6029 // walk that binds them says where each one goes.
6030 //
6031 // Windows on AArch64 is the first kind seen from the other side. The caller reserves
6032 // nothing, so the function takes the words it homes its x registers in at the top of its
6033 // own frame, and from inside it that is a shadow space like Windows x64's. So the
6034 // registers the parameters are bound through are [`rucc_target::CallRegs::homed`], and
6035 // the prologue [`crate::finish`] writes takes the bytes before it saves anything.
6036 let variadic = self.source.signature().variadic;
6037 let foreign = self.source.signature().convention != Convention::Target;
6038 let homes = variadic && !foreign && self.conv.home > 0;
6039 let conv = if homes { self.conv.homed() } else { *self.conv };
6040 if homes {
6041 self.stack.home = self.conv.home;
6042 }
6043 let in_memory = self.conv.abi.variadic == Variadic::AlwaysMemory;
6044 let applies = self.saves_arguments();
6045 let area = (variadic && !in_memory || applies).then(|| varargs::Area::of(&conv));
6046 let arrived =
6047 abi::entry(&mut self.out, out, &types, &conv, self.selector.abi, self.names, area)
6048 .map_err(|(index, missing)| Unsupported::Argument { index, missing })?;
6049 for (¶m, reg) in params.iter().zip(&arrived.regs) {
6050 self.regs[param.index()] = Some(*reg);
6051 }
6052 if applies {
6053 self.save_arguments(out, &arrived);
6054 }
6055 // A variadic function of the convention the platform does not call its own has no list
6056 // this can start. Its `va_list` would have to be the other platform's, which is a type C
6057 // has no name for here, and the front end refuses a definition with `...` in it for that
6058 // reason. What is left is an old style definition, which is variadic to a caller and has
6059 // no `...` for a `va_start` to follow, so nothing is set up and a `va_start` that reached
6060 // here all the same would be refused rather than read the wrong list.
6061 let variadic = variadic && !foreign;
6062 if let (true, Some(area)) = (variadic && !in_memory, area) {
6063 self.save_area(out, &arrived, area, conv.shared_positions);
6064 } else if variadic {
6065 let incoming = arrived.beyond.next_multiple_of(self.conv.word);
6066 self.varargs = Some(Varargs::Pointer { incoming });
6067 }
6068 self.stack.arguments.extend(arrived.stack);
6069 Ok(())
6070 }
6071
6072 /// The prologue of a variadic function, which is every argument register it was handed written
6073 /// into the frame.
6074 ///
6075 /// Every one the signature did not name, that is. Which of those hold anything is a thing only
6076 /// the caller knew and there is nothing here to ask, so all of them are written, and the ones a
6077 /// named parameter took are not, because `va_start` sets the two offsets past them and nothing
6078 /// ever reads their slots.
6079 ///
6080 /// What that costs is up to fourteen stores in the prologue of a function that may read none of
6081 /// them, and the convention's answer to that is the count of vector registers in `%al`, which
6082 /// lets a callee skip the eight vector stores when the call passed no floats. Skipping them is a
6083 /// branch in a prologue, and a prologue is written long after this by [`crate::finish`], which
6084 /// has no blocks to branch between. So they are all written every time, which is correct and is
6085 /// what `-O0` costs. Issue #323 is the branch.
6086 ///
6087 /// A vector register is written all sixteen bytes at a time, because a `_Float128` fills one and
6088 /// a `va_arg` of a quad reads the slot back whole. gcc writes the same sixteen with the same
6089 /// instruction, which is what [`crate::varargs`] says a list has to be built out of.
6090 ///
6091 /// The address is computed once into a register rather than written as a displacement off the
6092 /// stack pointer, because a displacement into a frame is not known until after allocation and
6093 /// one `lea` costs less than a fixup list for a dozen stores. It is the same `lea` an `alloca`
6094 /// gets and [`crate::finish`] fills it in the same way.
6095 ///
6096 /// A convention that homes its register arguments has none of that. Its area is the shadow
6097 /// space the caller reserved above the return address, so there is no object to make and no
6098 /// address to work out: each store reaches into the caller's argument area the way the load of
6099 /// a parameter the registers ran out before does, which is the same waiting list and the same
6100 /// fixup. There are at most four of them and none is a vector register, since a float the
6101 /// signature does not name arrived in a general purpose register too and that is the copy the
6102 /// walk reads.
6103 ///
6104 /// Windows on AArch64 homes its registers the same way, in an area the function takes for
6105 /// itself rather than one the caller left, and `shared` is what says a function is one of these.
6106 fn save_area(
6107 &mut self,
6108 out: mir::Block,
6109 arrived: &abi::Arrived,
6110 area: varargs::Area,
6111 shared: bool,
6112 ) {
6113 if shared {
6114 self.varargs = Some(Varargs::Pointer { incoming: arrived.beyond });
6115 let head =
6116 (self.selector.abi.store)(Type::int(64)).expect("a store of a whole register");
6117 let store = mir::Opcode::new(self.names.intern(head));
6118 for &(reg, class, at) in &arrived.spare {
6119 let sp = mir::Operand::read(mir::Reg::physical(self.conv.stack_pointer), self.gpr);
6120 let made =
6121 self.out.build(out, store).uses(reg, class).mem(mir::Mem::at(sp)).finish();
6122 self.stack.arguments.push((made, at));
6123 }
6124 return;
6125 }
6126
6127 let save = self.stack.locals.len();
6128 self.stack.locals.push(Local { size: area.size, align: varargs::VECTOR_SLOT });
6129 let took = |count: usize, float: bool| {
6130 let count = u32::try_from(count).unwrap_or(0).min(area.holds(float));
6131 area.starts_at(float) + count * area.stride(float)
6132 };
6133 let integers = took(arrived.took.0, false);
6134 let floats = took(arrived.took.1, true);
6135 self.varargs = Some(if self.conv.list == VaList::Aapcs {
6136 // Minus what is left of each half, since the two offsets count up to its top.
6137 let left = |at: u32, float: bool| {
6138 i32::try_from(at).unwrap_or(0) - i32::try_from(area.ends_at(float)).unwrap_or(0)
6139 };
6140 Varargs::Aapcs {
6141 save,
6142 incoming: arrived.beyond,
6143 integers_end: area.ends_at(false),
6144 floats_end: area.ends_at(true),
6145 integers: left(integers, false),
6146 floats: left(floats, true),
6147 }
6148 } else {
6149 Varargs::Fields { save, incoming: arrived.beyond, integers, floats }
6150 });
6151
6152 // A vector register is saved all sixteen bytes wide, as a quad is, whatever it held.
6153 let base = self.frame_address(out, save);
6154 for &(reg, class, at) in &arrived.spare {
6155 let ty =
6156 if class == self.gpr { Type::int(64) } else { Type::float(rucc_ir::Float::F128) };
6157 let head = (self.selector.abi.store)(ty).expect("a store of a whole register");
6158 let store = mir::Opcode::new(self.names.intern(head));
6159 let up = i32::try_from(at).expect("a register save area under two gigabytes");
6160 let mem = mir::Mem::at(mir::Operand::read(base, self.gpr)).plus(up);
6161 self.out.build(out, store).uses(reg, class).mem(mem).finish();
6162 }
6163 }
6164
6165 /// Whether the function holds a `__builtin_apply_args`, on a convention this can save the
6166 /// arguments of.
6167 ///
6168 /// Only the one that keeps the two register files apart and saves them the way a SysV list
6169 /// does, since the block is that layout with one word in front of it. On any other the call is
6170 /// refused where it stands, which is [`Self::apply_args`] finding nothing saved.
6171 fn saves_arguments(&self) -> bool {
6172 if self.conv.list != VaList::SysV || self.conv.shared_positions {
6173 return false;
6174 }
6175 let source = self.source;
6176 source
6177 .blocks()
6178 .any(|block| source.insts(block).any(|inst| source[inst].opcode == Opcode::ApplyArgs))
6179 }
6180
6181 /// The prologue of a function holding `__builtin_apply_args`, which is every argument register
6182 /// it was handed and where the arguments in memory start, written into a block of its frame.
6183 ///
6184 /// The block is the one gcc lays out on this convention, so that a program reading it the way
6185 /// gcc's manual says reads the same bytes:
6186 ///
6187 /// ```text
6188 /// 0 where the arguments that came in memory are
6189 /// 8 nothing, so that what follows is sixteen byte aligned
6190 /// 16..64 the six general purpose argument registers, a word each
6191 /// 64..192 the eight vector argument registers, sixteen bytes each
6192 /// ```
6193 ///
6194 /// Which is the register save area of a variadic function with a word and a pad in front, so
6195 /// the offsets are that area's plus sixteen. What is different is that every register is
6196 /// written and not only the ones no parameter took: the one a parameter arrived in is written
6197 /// from the register the parameter was bound to, which holds it untouched because nothing has
6198 /// run yet, and the rest from the pseudos the walk made for them.
6199 fn save_arguments(&mut self, out: mir::Block, arrived: &abi::Arrived) {
6200 let applied = self.stack.locals.len();
6201 self.stack.locals.push(Local { size: APPLY_ARGS, align: varargs::VECTOR_SLOT });
6202 self.applied = Some(applied);
6203 let base = self.frame_address(out, applied);
6204 let overflow = self.overflow(out, 0, Span::DUMMY);
6205 let head = (self.selector.abi.store)(Type::int(64)).expect("a store of an address");
6206 let store = mir::Opcode::new(self.names.intern(head));
6207 let mem = mir::Mem::at(mir::Operand::read(base, self.gpr));
6208 self.out.build(out, store).uses(overflow, self.gpr).mem(mem).finish();
6209
6210 let named = arrived.named.iter().map(|&(index, at)| {
6211 let reg = arrived.regs[index];
6212 let class = self.out.class_of(reg).unwrap_or(self.gpr);
6213 (reg, class, at)
6214 });
6215 let every: Vec<_> = named.chain(arrived.spare.iter().copied()).collect();
6216 for (reg, class, at) in every {
6217 let ty =
6218 if class == self.gpr { Type::int(64) } else { Type::float(rucc_ir::Float::F128) };
6219 let head = (self.selector.abi.store)(ty).expect("a store of a whole register");
6220 let store = mir::Opcode::new(self.names.intern(head));
6221 let up = i32::try_from(at + APPLY_REGS).expect("a block of under two gigabytes");
6222 let mem = mir::Mem::at(mir::Operand::read(base, self.gpr)).plus(up);
6223 self.out.build(out, store).uses(reg, class).mem(mem).finish();
6224 }
6225 }
6226
6227 /// One `__builtin_apply_args`, which is the address of the block the prologue wrote.
6228 fn apply_args(&mut self, inst: Inst) -> Result<(), Unsupported> {
6229 let Some(applied) = self.applied else { return Err(self.unsupported(inst)) };
6230 let result = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
6231 let block = self.at.expect("a block is being filled");
6232 let reg = self.frame_address(block, applied);
6233 self.regs[result.index()] = Some(reg);
6234 Ok(())
6235 }
6236
6237 /// One `__builtin_apply`, which is a call whose arguments are every register in a block
6238 /// `__builtin_apply_args` answered and some bytes of the memory it says the arguments in
6239 /// memory were in.
6240 ///
6241 /// Built as a call of fourteen arguments, six words and eight vectors, which puts each in the
6242 /// register it came out of, and one object of the size the program gave, which is copied into
6243 /// the bottom of the outgoing area the way a structure passed by value is. The call is made as
6244 /// to a variadic function, so the count of vector registers is eight and a variadic callee
6245 /// saves all of them.
6246 ///
6247 /// What comes back is every register a value can come back in, which is two of each file, and
6248 /// they are written into a block of this function's frame whose address is the answer: the two
6249 /// words at 0 and 8 and the two vectors at 16 and 32. An eighty bit value comes back on the x87
6250 /// stack and is not in it, which is the one thing gcc's block holds that this one does not.
6251 fn apply(&mut self, inst: Inst) -> Result<(), Unsupported> {
6252 if self.conv.list != VaList::SysV || self.conv.shared_positions {
6253 return Err(self.unsupported(inst));
6254 }
6255 let values: Vec<Value> = self.source[self.source[inst].args].to_vec();
6256 let [function, saved, size] = values[..] else { return Err(self.unsupported(inst)) };
6257 let size = self.number(size).ok_or_else(|| self.unsupported(inst))?;
6258 let size = u32::try_from(size).map_err(|_| self.unsupported(inst))?;
6259 let result = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
6260 let function = self.reg_of(function)?;
6261 let saved = self.reg_of(saved)?;
6262 let block = self.at.expect("a block is being filled");
6263 let span = self.source.span(inst);
6264
6265 let word = Type::int(64);
6266 let vector = Type::float(rucc_ir::Float::F128);
6267 let area = varargs::Area::of(self.conv);
6268 let load = |ty: Type| (self.selector.abi.load)(ty).expect("a load of a whole register");
6269 let (load_word, load_vector) = (load(word), load(vector));
6270 let mut read = |ty: Type, head: &str, class: RegClass, at: u32| {
6271 let reg = self.out.new_vreg(class);
6272 let opcode = mir::Opcode::new(self.names.intern(head));
6273 let at = i32::try_from(at).expect("a block of under two gigabytes");
6274 let mem = mir::Mem::at(mir::Operand::read(saved, self.gpr)).plus(at);
6275 self.out.build(block, opcode).at(span).def(reg, class).mem(mem).finish();
6276 abi::Passing { ty, reg, abi: Abi::Plain }
6277 };
6278 let sse = self.conv.sse_class;
6279 let gpr = self.gpr;
6280 let mut args = Vec::with_capacity(15);
6281 for (float, ty, head, class) in
6282 [(false, word, load_word, gpr), (true, vector, load_vector, sse)]
6283 {
6284 for index in 0..area.holds(float) {
6285 let at = APPLY_REGS + area.starts_at(float) + index * area.stride(float);
6286 args.push(read(ty, head, class, at));
6287 }
6288 }
6289 if size > 0 {
6290 let memory = read(word, load_word, gpr, 0);
6291 let object =
6292 Abi::ByVal { size: u64::from(size), align: 8, drains: rucc_ir::Drains::Nothing };
6293 args.push(abi::Passing { abi: object, ..memory });
6294 }
6295 let returns = [word, word, vector, vector];
6296 let what = abi::Calling {
6297 callee: abi::Callee::Through(function),
6298 args: &args,
6299 returns: &returns,
6300 variadic: true,
6301 named: args.len(),
6302 at: span,
6303 };
6304 let made = abi::call(&mut self.out, block, &what, self.conv, self.selector.abi, self.names)
6305 .map_err(|refused| Unsupported::Call { inst, refused })?;
6306 let calls = &mut self.stack.calls;
6307 *calls = Some(calls.unwrap_or(0).max(made.outgoing));
6308
6309 let back = self.stack.locals.len();
6310 self.stack.locals.push(Local { size: APPLY_BACK, align: varargs::VECTOR_SLOT });
6311 let base = self.frame_address(block, back);
6312 for ((®, ty), at) in made.results.iter().zip(returns).zip([0, 8, 16, 32]) {
6313 let class = if ty == word { gpr } else { sse };
6314 let head = (self.selector.abi.store)(ty).expect("a store of a whole register");
6315 let store = mir::Opcode::new(self.names.intern(head));
6316 let mem = mir::Mem::at(mir::Operand::read(base, self.gpr)).plus(at);
6317 self.out.build(block, store).at(span).uses(reg, class).mem(mem).finish();
6318 }
6319 let answer = self.frame_address(block, back);
6320 self.regs[result.index()] = Some(answer);
6321 Ok(())
6322 }
6323
6324 /// The address of one of the function's stack objects, in a fresh register.
6325 ///
6326 /// Written with nothing in its displacement, because where an object is in a frame is not known
6327 /// until after allocation, and given to [`crate::finish`] to fill in the way an `alloca` is.
6328 fn frame_address(&mut self, out: mir::Block, local: usize) -> mir::Reg {
6329 self.frame_address_plus(out, local, 0)
6330 }
6331
6332 /// The address some way into a local, which the frame finishes the same way, adding where the
6333 /// local is to what is already there.
6334 fn frame_address_plus(&mut self, out: mir::Block, local: usize, plus: u32) -> mir::Reg {
6335 let reg = self.out.new_vreg(self.gpr);
6336 let lea = self.named(self.selector.frame.lea);
6337 let sp = mir::Operand::read(mir::Reg::physical(self.conv.stack_pointer), self.gpr);
6338 let plus = i32::try_from(plus).expect("an offset into a local under two gigabytes");
6339 let mem = mir::Mem::at(sp).plus(plus);
6340 let made = self.out.build(out, lea).def(reg, self.gpr).mem(mem).finish();
6341 self.stack.addresses.push((made, local));
6342 reg
6343 }
6344
6345 /// Whether an instruction is one no machine instruction is written for where it stands.
6346 ///
6347 /// Four of them, and none is a lowering decision, which is why none is a rule. A constant is
6348 /// written where a register for it is first wanted rather than where the IR put it, and every
6349 /// reader of one may have folded it into an immediate, in which case nowhere is the right
6350 /// place. A return of nothing has nothing to put anywhere: the epilogue gives the frame back
6351 /// and leaves, and it is appended to every block with no successors long after this has
6352 /// finished, so a return with a value is one instruction here and a return without one is
6353 /// none. Unless the value went back through memory, in which case there is something to put
6354 /// somewhere after all and the IR does not carry it: the address the caller handed over has
6355 /// to be in `rax` on the way out, and [`Lowering::returned`] is what writes that.
6356 ///
6357 /// An unconditional jump is the third, and there is even less of it: the edge is on the
6358 /// block, and whether the block it goes to is the next one and needs no jump at all is the
6359 /// block layout's answer rather than this one's.
6360 ///
6361 /// The fourth is a point control does not arrive at, in both of the forms the IR has for it:
6362 /// the `unreachable` terminator the front end puts at the end of a function whose body can run
6363 /// off the bottom, and the `unreachable_hint` a call to `__builtin_unreachable` becomes. What
6364 /// to write for a place nothing reaches is a question with no wrong answer, and nothing is the
6365 /// smallest one and the one gcc 16.2.0 gives at `-O0`. The terminator leaves the block with no
6366 /// successors, so the epilogue lands at the end of it the way it does on any other block that
6367 /// goes nowhere, and the function cannot fall out of its own last instruction into whatever
6368 /// the assembler puts next.
6369 fn writes_nothing(&self, inst: Inst) -> bool {
6370 let data = &self.source[inst];
6371 match data.opcode {
6372 Opcode::IConst | Opcode::Jump | Opcode::Unreachable | Opcode::UnreachableHint => true,
6373 // The question of whether a call unwound and the branch on its answer, neither of which
6374 // is an instruction. See [`Self::edges`].
6375 Opcode::Unwound => true,
6376 Opcode::BrIf => self.unwind_edge(inst).is_some(),
6377 Opcode::Return => self.source[data.args].is_empty() && self.sret().is_none(),
6378 _ => false,
6379 }
6380 }
6381
6382 /// What every instruction in one block matched, with a set of values nobody may take.
6383 ///
6384 /// Backwards, because an instruction that has been folded into a later one does not get to
6385 /// fold anything into itself: the rule that took it only reached one level down, so what is
6386 /// under it is not in the term the matcher saw and cannot be replaced.
6387 fn decide(&self, insts: &[Inst], refused: &HashSet<Value>) -> Decided {
6388 let mut found: Vec<Option<Match<Term>>> = (0..insts.len()).map(|_| None).collect();
6389 let mut plans: Vec<Option<Plan>> = vec![None; insts.len()];
6390 let mut folded: Vec<Inst> = Vec::new();
6391 for (index, &inst) in insts.iter().enumerate().rev() {
6392 if folded.contains(&inst) {
6393 continue;
6394 }
6395 if let Some((plan, matched)) = self.select(inst, refused) {
6396 folded.extend(self.folds(inst, plan));
6397 found[index] = Some(matched);
6398 plans[index] = Some(plan);
6399 }
6400 }
6401 Decided { found, plans, folded }
6402 }
6403
6404 /// A value some of its readers took and some of them did not, which is the one case folding
6405 /// buys nothing.
6406 ///
6407 /// Folding does not delete the instruction that computed a value for anybody else, so a
6408 /// reader that did not take it still needs it in a register and the instruction stays. The
6409 /// reader that did take it now does that work again. Either all of them take it, in which
6410 /// case nothing is left to read it and the instruction goes, or none of them do.
6411 ///
6412 /// The count is over the whole function rather than over the block, since a value read from
6413 /// another block is read from a register there whatever this block decides. An instruction
6414 /// built by name rather than matched, a call being the one that matters, has no plan and so
6415 /// takes nothing, which is the right answer for it as well.
6416 ///
6417 /// The count is kept only for the values this block's instructions take. It used to be a slot
6418 /// for every value in the function, cleared for every block, and on a function of thirty
6419 /// thousand blocks and a hundred and seventy thousand values that clearing was four percent of
6420 /// an optimized compile.
6421 fn left_alive(&self, insts: &[Inst], plans: &[Option<Plan>]) -> Option<Value> {
6422 let mut taken: HashMap<Value, u32> = HashMap::new();
6423 for (&inst, plan) in insts.iter().zip(plans) {
6424 let Some(plan) = plan else { continue };
6425 let args = &self.source[self.source[inst].args];
6426 for (index, &arg) in args.iter().take(MAX_ARGS).enumerate() {
6427 if plan[index] == Shown::Expand {
6428 *taken.entry(arg).or_default() += 1;
6429 }
6430 }
6431 }
6432 for (&inst, plan) in insts.iter().zip(plans) {
6433 let Some(plan) = plan else { continue };
6434 let args = &self.source[self.source[inst].args];
6435 for (index, &arg) in args.iter().take(MAX_ARGS).enumerate() {
6436 if plan[index] == Shown::Expand && taken[&arg] < self.uses[arg.index()] {
6437 return Some(arg);
6438 }
6439 }
6440 }
6441 None
6442 }
6443
6444 /// The rule that fires on an instruction, and what it bound.
6445 ///
6446 /// The plans are tried in order and the first that matches wins, which is the maximal munch
6447 /// `spec/10-backend.md` asks for: a plan that offers more to the matcher is tried before one
6448 /// that offers less.
6449 fn select(&self, inst: Inst, refused: &HashSet<Value>) -> Option<(Plan, Match<Term>)> {
6450 for plan in self.plans(inst, refused) {
6451 let terms = Terms::new(self.source, inst, plan);
6452 if let Some(matched) = self.selector.table.find(&terms, Term::Root) {
6453 return Some((plan, matched));
6454 }
6455 }
6456 None
6457 }
6458
6459 /// Every way this instruction can be shown to the matcher, most offered first.
6460 ///
6461 /// That is every choice of a way to show each operand, with the choice for the first operand
6462 /// changing slowest. The plans are counted out rather than collected, because this is asked
6463 /// for every instruction that is selected and the lists it used to build were an allocation
6464 /// or two per operand.
6465 fn plans(&self, inst: Inst, refused: &HashSet<Value>) -> impl Iterator<Item = Plan> {
6466 let args = &self.source[self.source[inst].args];
6467 let mut ways = [[Shown::Reg; 3]; MAX_ARGS];
6468 let mut counts = [1; MAX_ARGS];
6469 for (index, &arg) in args.iter().enumerate().take(MAX_ARGS) {
6470 let mut count = 0;
6471 if self.foldable(inst, arg, refused) {
6472 ways[index][count] = Shown::Expand;
6473 count += 1;
6474 }
6475 if Terms::new(self.source, inst, PLAIN).constant(arg).is_some() {
6476 ways[index][count] = Shown::Const;
6477 count += 1;
6478 }
6479 ways[index][count] = Shown::Reg;
6480 counts[index] = count + 1;
6481 }
6482 (0..counts.iter().product()).map(move |mut number: usize| {
6483 let mut plan = PLAIN;
6484 for index in (0..MAX_ARGS).rev() {
6485 plan[index] = ways[index][number % counts[index]];
6486 number /= counts[index];
6487 }
6488 plan
6489 })
6490 }
6491
6492 /// Whether an operand may be shown as the instruction that computed it.
6493 ///
6494 /// It has to be in the same block, because a rule that folds one instruction into another
6495 /// moves the work to where the second one is. It has to be something rather than a block
6496 /// parameter, and not a constant, which is shown as a constant instead. And it has to be a
6497 /// value [`Lowering::left_alive`] has not put back, which is how the one reader at a time
6498 /// question is asked here: this says yes to a value with any number of readers, and a value
6499 /// only some of them could take is refused after the fact and asked again.
6500 ///
6501 /// A value with several readers used to be refused outright, on the reasoning that folding
6502 /// does not delete the instruction for anybody else. That reasoning is about the set of
6503 /// readers and was being applied to one reader at a time, which is stricter than it needs to
6504 /// be: when every reader takes it there is nobody left to read it and the instruction goes.
6505 /// An address a store and a load share is the shape that matters, since a memory operand has
6506 /// room for the whole of it and both readers have a memory operand.
6507 fn foldable(&self, into: Inst, value: Value, refused: &HashSet<Value>) -> bool {
6508 let Def::Result { inst, .. } = self.source[value].def else { return false };
6509 if self.source[inst].opcode == Opcode::IConst || refused.contains(&value) {
6510 return false;
6511 }
6512 self.source.block_of(inst).is_some()
6513 && self.source.block_of(inst) == self.source.block_of(into)
6514 }
6515
6516 /// The instructions a match folded into the one it matched.
6517 ///
6518 /// The plan is what says this, not the bindings: a binding is a register or a number either
6519 /// way, and an operand shown as the instruction that computed it is one no rule could have
6520 /// matched without taking that instruction, because the plan offered the matcher nothing
6521 /// else to call it.
6522 fn folds(&self, inst: Inst, plan: Plan) -> Vec<Inst> {
6523 let args = &self.source[self.source[inst].args];
6524 args.iter()
6525 .take(MAX_ARGS)
6526 .enumerate()
6527 .filter(|&(index, _)| plan[index] == Shown::Expand)
6528 .filter_map(|(_, &arg)| match self.source[arg].def {
6529 Def::Result { inst, .. } => Some(inst),
6530 Def::Param { .. } => None,
6531 })
6532 .collect()
6533 }
6534
6535 /// What the IR instruction said about itself that the machine instruction has to keep saying.
6536 ///
6537 /// One flag today. `volatile` says the access happens exactly once and is never moved or
6538 /// merged, and nothing below here can work that out again: a `volatile` load and an ordinary
6539 /// one are the same instruction over the same address, so a pass that puts two accesses
6540 /// together would put these together too. Carried rather than checked here, because the pass
6541 /// that has to refuse is a long way down and this is the last place the answer is known.
6542 ///
6543 /// The instructions this compiler writes for itself get nothing, which is the right answer
6544 /// for all of them: a prologue, a spill and the moves around a call were asked for by the
6545 /// machine rather than by the program.
6546 ///
6547 /// Every access the flag is legal on carries it: the loads and the stores a rule matched,
6548 /// the two ends of a `long double` copy that are the program's own memory, and the compare
6549 /// and exchange and the read modify write. An `asm` statement does not, and it is the one
6550 /// exception on purpose. What the flag says there is that the statement stays even when
6551 /// nothing reads what it wrote, which is a different sentence about a different thing, and
6552 /// every `asm` is already fixed where it stands whether the word was written or not.
6553 fn carried(&self, inst: Inst) -> mir::Flags {
6554 if self.source[inst].flags.contains(Flags::VOLATILE) {
6555 mir::Flags::VOLATILE
6556 } else {
6557 mir::Flags::NONE
6558 }
6559 }
6560
6561 /// Build the machine instructions a match calls for.
6562 fn emit(&mut self, inst: Inst, matched: &Match<Term>) -> Result<(), Unsupported> {
6563 let rule: &Rule = self.selector.table.rule(matched);
6564 self.build(inst, rule.replacement, 0, &matched.bindings, true).map(|_| ())
6565 }
6566
6567 /// Build the machine term that starts at `at`, and give back the position after it and the
6568 /// register it wrote, if it wrote one.
6569 ///
6570 /// The outermost term computes what the IR instruction does, so what it writes is the
6571 /// register of the instruction's result. A term inside another is a step on the way and
6572 /// writes a register of its own, which the term around it then reads. Its operands are read
6573 /// before it is built and it is built before the term around it, so the instructions come
6574 /// out in the order the values are needed.
6575 fn build(
6576 &mut self,
6577 inst: Inst,
6578 pieces: &'static [Piece],
6579 at: usize,
6580 bindings: &[Term],
6581 outermost: bool,
6582 ) -> Result<(usize, Option<mir::Reg>), Unsupported> {
6583 let Some(Piece::App { head, arity }) = pieces.get(at) else {
6584 return Err(self.unsupported(inst));
6585 };
6586 let opcode =
6587 head.strip_prefix(self.selector.prefix()).ok_or_else(|| self.unsupported(inst))?;
6588 let descs = self.selector.operands(opcode).ok_or_else(|| self.unsupported(inst))?;
6589
6590 let mut read = Read::default();
6591 let mut at = at + 1;
6592 for _ in 0..*arity {
6593 at = self.read(inst, pieces, at, bindings, &mut read)?;
6594 }
6595
6596 let writes = descs.iter().take_while(|desc| desc.role.is_def()).count();
6597 if descs.len() - writes != read.regs.len() {
6598 return Err(self.unsupported(inst));
6599 }
6600
6601 // The first thing the instruction writes is what it computes, and any others are
6602 // registers the machine destroys on the way, which are fresh because nothing else is in
6603 // them and nothing reads them. An instruction that writes nothing at all is one whose
6604 // whole purpose is its effect, which is what a store is, and there is no result to put
6605 // anywhere.
6606 let mut regs = Vec::new();
6607 if writes > 0 {
6608 // A term inside another computes a step rather than the result, into a register only
6609 // the term around it reads.
6610 let first = match outermost {
6611 true => {
6612 let result =
6613 self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
6614 self.new_reg(result)
6615 }
6616 false => self.out.new_vreg(descs[0].class),
6617 };
6618 regs.push(first);
6619 // The rest are the registers the machine destroys on the way, and the class each is in
6620 // is the one the instruction's description gives it rather than a guess, so that an
6621 // instruction that wrecks a register in the other file says so.
6622 regs.extend(descs[1..writes].iter().map(|desc| self.out.new_vreg(desc.class)));
6623 } else if !outermost || self.source[inst].first_result.is_some() {
6624 // A rule that throws away a value the IR gave a name to would leave every reader of
6625 // that name with nothing to read, so it is a rule this and the target disagree about.
6626 // So is a term inside another that writes nothing for the one around it to read.
6627 return Err(self.unsupported(inst));
6628 }
6629 let written = regs.first().copied();
6630 regs.extend(read.regs.iter().copied());
6631
6632 let block = self.at.expect("a block is being filled");
6633 let opcode = mir::Opcode::new(self.names.intern(head));
6634 let (span, flags) = (self.source.span(inst), self.carried(inst));
6635 let mut build = self.out.build(block, opcode).at(span).flags(flags);
6636 for (desc, reg) in descs.iter().zip(regs) {
6637 let operand = mir::Operand {
6638 reg,
6639 class: desc.class,
6640 role: desc.role,
6641 constraint: desc.constraint,
6642 };
6643 build = build.operand(operand);
6644 }
6645 if let Some(mem) = read.mem {
6646 build = build.mem(mem);
6647 }
6648 if let Some(imm) = read.imm {
6649 build = build.imm(imm);
6650 }
6651 build.finish();
6652 Ok((at, written))
6653 }
6654
6655 /// Read one argument of a replacement, which is a register, a number, an address or another
6656 /// machine term.
6657 ///
6658 /// Gives back the position after it, because a replacement is flat and an address or a term
6659 /// takes arguments of its own. A machine term is built on the spot, and what is read is the
6660 /// register it wrote.
6661 fn read(
6662 &mut self,
6663 inst: Inst,
6664 pieces: &'static [Piece],
6665 at: usize,
6666 bindings: &[Term],
6667 out: &mut Read,
6668 ) -> Result<usize, Unsupported> {
6669 match pieces.get(at) {
6670 Some(Piece::Int(value)) => {
6671 out.imm = i64::try_from(*value).ok();
6672 Ok(at + 1)
6673 }
6674 // A number the rule worked out of the ones it matched rather than one it wrote down,
6675 // which is an immediate once it has been worked out and is read here as one. It gives
6676 // nothing back when a binding it reads is a register, and a replacement that cannot be
6677 // built is a rule this file and the matcher disagree about, which is what `unsupported`
6678 // is for.
6679 Some(Piece::Computed { work, .. }) => {
6680 let matched: Vec<Option<i128>> = bindings
6681 .iter()
6682 .map(|term| match *term {
6683 Term::Num(value) => Some(value),
6684 _ => None,
6685 })
6686 .collect();
6687 let number = work(&matched).ok_or_else(|| self.unsupported(inst))?;
6688 out.imm = i64::try_from(number).ok();
6689 Ok(at + 1)
6690 }
6691 Some(Piece::Var { index, .. }) => {
6692 match bindings.get(*index) {
6693 Some(&Term::Reg(value)) => {
6694 let reg = self.reg_of(value)?;
6695 out.regs.push(reg);
6696 }
6697 Some(&Term::Num(value)) => out.imm = i64::try_from(value).ok(),
6698 // A pattern binds a register or a number and nothing else, so this is a
6699 // rule the matcher and this file disagree about.
6700 _ => return Err(self.unsupported(inst)),
6701 }
6702 Ok(at + 1)
6703 }
6704 Some(Piece::App { head, .. }) if (self.selector.address)(head).is_none() => {
6705 let (next, reg) = self.build(inst, pieces, at, bindings, false)?;
6706 out.regs.push(reg.ok_or_else(|| self.unsupported(inst))?);
6707 Ok(next)
6708 }
6709 Some(Piece::App { head, arity }) => {
6710 let kind = (self.selector.address)(head).ok_or_else(|| self.unsupported(inst))?;
6711 let mut inner = Read::default();
6712 let mut next = at + 1;
6713 for _ in 0..*arity {
6714 next = self.read(inst, pieces, next, bindings, &mut inner)?;
6715 }
6716 let mem = address(kind, &inner, self.gpr).ok_or_else(|| self.unsupported(inst))?;
6717 out.mem = Some(mem);
6718 Ok(next)
6719 }
6720 None => Err(self.unsupported(inst)),
6721 }
6722 }
6723
6724 /// The register a value is in, materializing it if it is a constant that has not been put in
6725 /// one yet.
6726 ///
6727 /// A constant is written where it is wanted rather than where the IR defined it, and where it
6728 /// is wanted is a block that need not be the one the IR defined it in. So the register holding
6729 /// one is only good inside the block it was written into, and a second block that wants the
6730 /// same constant gets its own. Anything else is a register read where nothing wrote it: the
6731 /// IR guarantees a definition dominates its uses, and this moved the definition.
6732 ///
6733 /// Writing the number again is also the right answer and not merely the safe one. It is one
6734 /// instruction that reads nothing, which is cheaper than holding a register live across a
6735 /// branch for it, and it is what a rematerializing allocator would do with the value anyway.
6736 fn reg_of(&mut self, value: Value) -> Result<mir::Reg, Unsupported> {
6737 let constant = match self.source[value].def {
6738 Def::Result { inst, .. } => {
6739 (self.source[inst].opcode == Opcode::IConst).then_some(inst)
6740 }
6741 Def::Param { .. } => None,
6742 };
6743 let here = self.at.expect("a block is being filled");
6744 if let Some(reg) = self.regs[value.index()] {
6745 if constant.is_none() || self.written[value.index()] == Some(here) {
6746 return Ok(reg);
6747 }
6748 }
6749 if let Some(inst) = constant {
6750 // Cleared so that the register the constant is written into is a new one rather than
6751 // the one the block above wrote, which is still being read up there.
6752 self.regs[value.index()] = None;
6753 // Nothing is refused here. A constant is written on its own, out of the loop over the
6754 // block, and the operands of the rule that writes one are the number and nothing else.
6755 let matched = self
6756 .select(inst, &HashSet::new())
6757 .map(|(_, matched)| matched)
6758 .ok_or_else(|| self.unsupported(inst))?;
6759 self.emit(inst, &matched)?;
6760 // The same mark the loop over the instructions makes, and it has to be made here as
6761 // well because this is the only place a constant is ever selected: the loop skips one
6762 // where the IR wrote it, so a rule that lowers a constant fires from nowhere else and
6763 // would be reported as a rule nothing reaches.
6764 self.fired.mark(matched.rule);
6765 self.written[value.index()] = Some(here);
6766 return Ok(self.regs[value.index()].expect("a constant is written into a register"));
6767 }
6768 Ok(self.new_reg(value))
6769 }
6770
6771 /// Which register file a value of that type lives in.
6772 ///
6773 /// The vector one for the two float widths the machine has scalar instructions for and for the
6774 /// one it only moves, and the general purpose one for everything else. An eighty bit `long
6775 /// double` is in neither, and it is here rather than in the vector class on purpose: it would
6776 /// be put in a register that cannot hold it, and there is no rule that names one, so the
6777 /// instruction computing it is reported. The wrong class would make that a wrong program
6778 /// instead of a refused one.
6779 ///
6780 /// A hundred and twenty eight bit float is in the vector class and fits it exactly, which is
6781 /// the difference. Nothing computes in it, so every arithmetic on one is still reported, and
6782 /// what the class buys is the moves: a register that holds the whole value is a register a
6783 /// spill, a reload and a copy are each one instruction for.
6784 fn class_of(&self, ty: Type) -> RegClass {
6785 if crate::term::in_vector_file(ty) { self.conv.sse_class } else { self.gpr }
6786 }
6787
6788 /// A fresh register for a value, which is what the instruction computing it writes.
6789 ///
6790 /// Any declaration the value is a value of comes with it. Here rather than once at the end over
6791 /// the whole map, because a constant is written again in every block that wants one and the map
6792 /// only remembers the last of those registers, and a local held in a constant is a local that
6793 /// would otherwise be findable in one block of the function and nowhere else.
6794 fn new_reg(&mut self, value: Value) -> mir::Reg {
6795 if let Some(reg) = self.regs[value.index()] {
6796 return reg;
6797 }
6798 let ty = self.source[value].ty;
6799 let reg = self.out.new_vreg(self.class_of(ty));
6800 self.sized(reg, ty);
6801 self.regs[value.index()] = Some(reg);
6802 let source = self.source;
6803 for decl in source.value_decls(value) {
6804 self.out.named.push((decl, reg));
6805 }
6806 reg
6807 }
6808
6809 /// Says how much of its register a value of that type takes, when the register is a vector
6810 /// one, which is what lets a call that keeps only the bottom of one keep the value in it.
6811 fn sized(&mut self, reg: mir::Reg, ty: Type) {
6812 if crate::term::in_vector_file(ty) {
6813 self.out.set_width(reg, abi::float_bytes(ty));
6814 }
6815 }
6816
6817 fn unsupported(&self, inst: Inst) -> Unsupported {
6818 let data = &self.source[inst];
6819 Unsupported::Inst {
6820 inst,
6821 term: Terms::new(self.source, inst, PLAIN).name(inst),
6822 opcode: data.opcode,
6823 ty: data.first_result.map(|result| self.source[result].ty),
6824 }
6825 }
6826}
6827
6828/// What the arguments of one replacement came to.
6829#[derive(Debug, Default)]
6830struct Read {
6831 regs: Vec<mir::Reg>,
6832 imm: Option<i64>,
6833 mem: Option<mir::Mem>,
6834}
6835
6836/// The addressing mode an address constructor's arguments make.
6837///
6838/// One arm per constructor rather than a question asked of the kind, because what the arguments
6839/// mean is the whole of what tells the four apart: the same register is a base in one and an
6840/// index in another, and the same constant is a scale in one and a displacement in another.
6841fn address(kind: Address, read: &Read, gpr: RegClass) -> Option<mir::Mem> {
6842 let mut regs = read.regs.iter().copied().map(|reg| mir::Operand::read(reg, gpr));
6843 match kind {
6844 Address::BaseIndexScale => {
6845 let base = regs.next()?;
6846 let index = regs.next()?;
6847 Some(mir::Mem::at(base).indexed(index, u8::try_from(read.imm?).ok()?))
6848 }
6849 Address::IndexScale => Some(mir::Mem {
6850 base: None,
6851 index: Some(regs.next()?),
6852 scale: u8::try_from(read.imm?).ok()?,
6853 disp: 0,
6854 symbol: None,
6855 block: None,
6856 table: None,
6857 reach: mir::Reach::Itself,
6858 segment: None,
6859 }),
6860 Address::Base => Some(mir::Mem::at(regs.next()?)),
6861 // The rule that writes this has a guard saying the constant fits, so a displacement that
6862 // does not is a rule and a target that disagree rather than a program this cannot compile.
6863 Address::BaseOffset => {
6864 Some(mir::Mem { disp: i32::try_from(read.imm?).ok()?, ..mir::Mem::at(regs.next()?) })
6865 }
6866 }
6867}
6868
6869#[cfg(test)]
6870mod tests {
6871 use rucc_ir::{
6872 AsmInfo, Builder, CallInfo, Flags, InstData, MemInfo, MemOrder, Restrict, Signature, Type,
6873 };
6874 use rucc_regalloc::assign::Env;
6875 use rucc_target::x86_64::{FRAME, REGS, SYSV};
6876
6877 use super::*;
6878 use crate::finish::{Convention, finish};
6879 use crate::frame::{Frame, Incoming, Layout};
6880 use crate::select::x86_64::SELECTOR;
6881
6882 /// A function of as many 64 bit parameters as the test wants, and the block they are in.
6883 fn blank(params: &[Type]) -> (Interner, Func, Block, Vec<Value>) {
6884 let mut names = Interner::new();
6885 let mut func = Func::new(names.intern("f"), Signature::new());
6886 let block = func.create_block();
6887 let values = params.iter().map(|&ty| func.append_param(block, ty)).collect();
6888 (names, func, block, values)
6889 }
6890
6891 /// An ordinary access: not atomic, and aligned enough that nothing here has an opinion.
6892 /// Neither field reaches selection, which is the point of saying it once here.
6893 fn plain() -> MemInfo {
6894 MemInfo {
6895 size: 0,
6896 align: 1,
6897 order: MemOrder::NotAtomic,
6898 tbaa: None,
6899 owns: 0,
6900 restrict: Restrict::NONE,
6901 }
6902 }
6903
6904 /// What the allocator is given: every integer register the convention offers except two, held
6905 /// back so that a move on an edge has somewhere to break a cycle and a spilled value has
6906 /// somewhere to be read into. Which two does not matter, and holding back the last two the
6907 /// convention would reach for leaves every expectation below unchanged.
6908 fn env() -> Env {
6909 const SCRATCH: [PhysReg; 2] = [x86_64::R10, x86_64::R11];
6910 let order: Vec<PhysReg> =
6911 SYSV.int_order.iter().copied().filter(|reg| !SCRATCH.contains(reg)).collect();
6912 Env::new().with(x86_64::GPR, &order, &SCRATCH)
6913 }
6914
6915 /// The machine IR text a function lowers to.
6916 fn lower(names: &mut Interner, source: &Func) -> String {
6917 let out = func(source, names, &SELECTOR, &SYSV, &Elsewhere::default())
6918 .expect("every instruction has a rule");
6919 mir::print_func(&out.func, names, ®S)
6920 }
6921
6922 /// The same function lowered for AArch64, which is the first thing this file writes for a
6923 /// machine other than x86-64. Nothing past selection runs here, so what is checked is that the
6924 /// arguments, the rule and the return all come out named for the machine that was asked for.
6925 #[test]
6926 fn an_addition_lowers_for_aarch64_with_its_own_names() {
6927 let i32 = Type::int(32);
6928 let (mut names, mut func, block, args) = blank(&[i32, i32]);
6929 let mut build = Builder::new(&mut func, block);
6930 let sum = build.binary(Opcode::Add, args[0], args[1], Flags::default());
6931 build.ret(&[sum]);
6932
6933 let conv = &aarch64::AAPCS64;
6934 let selector = &crate::select::aarch64::SELECTOR;
6935 let out = super::func(&func, &mut names, selector, conv, &Elsewhere::default())
6936 .expect("an addition and a return have AArch64 rules");
6937 let text = mir::print_func(&out.func, &names, &aarch64::REGS);
6938 assert!(!text.contains("x64."), "{text}");
6939 assert!(text.contains("= a64.arg_val_32"), "{text}");
6940 assert!(text.contains("= a64.add_rr_32 %0, %1"), "{text}");
6941 assert!(text.contains("a64.ret_val_32 %2"), "{text}");
6942 }
6943
6944 /// Lowers one function for AArch64 and prints it, or says why it could not.
6945 fn lower_a64(names: &mut Interner, func: &Func) -> Result<String, String> {
6946 let conv = &aarch64::AAPCS64;
6947 let selector = &crate::select::aarch64::SELECTOR;
6948 let out = super::func(func, names, selector, conv, &Elsewhere::default())
6949 .map_err(|why| why.to_string())?;
6950 Ok(mir::print_func(&out.func, names, &aarch64::REGS))
6951 }
6952
6953 /// Nothing reads AArch64 assembly back into instructions, so every template there is kept as
6954 /// its text. The operands are the instruction's own, with the output first and the inputs
6955 /// last, a hole in the text asks for the `w` or the `x` name of one, and a vector register the
6956 /// clobber list names is written by it as well as every register a call may leave anything in.
6957 #[test]
6958 fn a_template_on_aarch64_is_kept_as_text_with_its_operands_in_registers() {
6959 let (i32, i64) = (Type::int(32), Type::int(64));
6960 let (mut names, mut source, block, args) = blank(&[i32, i64]);
6961 let out = clobbering(
6962 &mut source,
6963 block,
6964 &mut names,
6965 "add %w0, %w1, #1\n\tstr %2, [sp]",
6966 "=r,r,r",
6967 "d8",
6968 &[args[0], args[1]],
6969 &[i32],
6970 );
6971 let produced = source[out].results().next().expect("one result");
6972 Builder::new(&mut source, block).ret(&[produced]);
6973
6974 // Forty one registers between the output and the inputs: `x0` to `x15`, the sixteen vector
6975 // registers a call does not keep, and `v8`, which is the one the program named.
6976 let text = lower_a64(&mut names, &source).expect("kept as text");
6977 assert!(text.contains("%2:gpr, early $x0, early $x1,"), "{text}");
6978 assert!(text.contains(
6979 "early $v31, early $v8 = a64.template %0, %1, \
6980 @add \u{1}r0w\u{2}, \u{1}r42w\u{2}, #1\n\tstr \u{1}r43x\u{2}, [sp]\n"
6981 ));
6982 }
6983
6984 /// A letter that means one thing on x86 and another on AArch64 is refused there rather than
6985 /// read as x86. `a` to `d` and `S` name one register each on x86 and nothing on AArch64.
6986 #[test]
6987 fn a_constraint_letter_the_two_machines_disagree_about_is_refused_on_aarch64() {
6988 let i64 = Type::int(64);
6989 for constraints in ["=a,r", "=r,S", "=r,c"] {
6990 let (mut names, mut source, block, args) = blank(&[i64]);
6991 let out = clobbering(
6992 &mut source,
6993 block,
6994 &mut names,
6995 "mov %0, %1",
6996 constraints,
6997 "",
6998 &[args[0]],
6999 &[i64],
7000 );
7001 let produced = source[out].results().next().expect("one result");
7002 Builder::new(&mut source, block).ret(&[produced]);
7003 let refused = lower_a64(&mut names, &source).expect_err(constraints);
7004 assert!(refused.contains("has an operand this cannot place"), "{refused}");
7005 }
7006 }
7007
7008 /// `Q` on AArch64 is memory addressed by one register, which is `[x3]` and is how an operand in
7009 /// memory is spelled there already.
7010 #[test]
7011 fn a_q_operand_on_aarch64_is_its_address_in_brackets() {
7012 let (i64, ptr) = (Type::int(64), Type::PTR);
7013 let (mut names, mut source, block, args) = blank(&[ptr]);
7014 let out =
7015 clobbering(&mut source, block, &mut names, "ldr %x0, %1", "=r,Q", "", &args, &[i64]);
7016 let produced = source[out].results().next().expect("one result");
7017 Builder::new(&mut source, block).ret(&[produced]);
7018 let text = lower_a64(&mut names, &source).expect("kept as text");
7019 assert!(text.contains("@ldr \u{1}r0x\u{2}, [\u{1}r"), "{text}");
7020 }
7021
7022 /// `w` on AArch64 is a vector register, named `v` with no modifier the way gcc names it and by
7023 /// its scalar view with one. An integer asked for in one is refused, since it would need a move
7024 /// into that file first.
7025 #[test]
7026 fn a_vector_operand_on_aarch64_is_in_the_vector_file() {
7027 let f64 = Type::float(rucc_ir::Float::F64);
7028 let (mut names, mut source, block, args) = blank(&[f64, f64]);
7029 let out = clobbering(
7030 &mut source,
7031 block,
7032 &mut names,
7033 "fadd %d0, %d1, %d2\n\tmov %0.16b, %0.16b",
7034 "=w,w,w",
7035 "",
7036 &[args[0], args[1]],
7037 &[f64],
7038 );
7039 let produced = source[out].results().next().expect("one result");
7040 Builder::new(&mut source, block).ret(&[produced]);
7041 let text = lower_a64(&mut names, &source).expect("kept as text");
7042 assert!(text.contains("%2:fpr, early $x0,"), "{text}");
7043 assert!(text.contains("@fadd \u{1}r0d\u{2}, \u{1}r"), "{text}");
7044 assert!(text.contains("\n\tmov \u{1}r0v\u{2}.16b, \u{1}r0v\u{2}.16b\n"), "{text}");
7045
7046 let i64 = Type::int(64);
7047 let (mut names, mut source, block, args) = blank(&[i64]);
7048 let out =
7049 clobbering(&mut source, block, &mut names, "fmov %d0, %d1", "=w,w", "", &args, &[i64]);
7050 let produced = source[out].results().next().expect("one result");
7051 Builder::new(&mut source, block).ret(&[produced]);
7052 assert!(lower_a64(&mut names, &source).is_err());
7053 }
7054
7055 #[test]
7056 fn an_addition_of_two_registers_is_one_instruction() {
7057 let i32 = Type::int(32);
7058 let (mut names, mut func, block, args) = blank(&[i32, i32]);
7059 let mut build = Builder::new(&mut func, block);
7060 build.binary(Opcode::Add, args[0], args[1], Flags::default());
7061
7062 assert_eq!(
7063 lower(&mut names, &func),
7064 "mfunc @f {\nblock0:\n %0:gpr($rdi) = x64.arg_val_32\n \
7065 %1:gpr($rsi) = x64.arg_val_32\n %2:gpr(reuse 1) = x64.add_rr_32 %0, %1\n}\n"
7066 );
7067 }
7068
7069 #[test]
7070 fn a_constant_operand_becomes_an_immediate() {
7071 let i32 = Type::int(32);
7072 let (mut names, mut func, block, args) = blank(&[i32]);
7073 let mut build = Builder::new(&mut func, block);
7074 let seven = build.iconst(i32, 7);
7075 build.binary(Opcode::Add, args[0], seven, Flags::default());
7076
7077 // The constant is in the instruction and nothing was written to hold it, which is what
7078 // materializing one where a register for it is wanted buys.
7079 assert_eq!(
7080 lower(&mut names, &func),
7081 "mfunc @f {\nblock0:\n %0:gpr($rdi) = x64.arg_val_32\n \
7082 %1:gpr(reuse 1) = x64.add_ri_32 %0, 7\n}\n"
7083 );
7084 }
7085
7086 #[test]
7087 fn a_constant_too_wide_for_an_immediate_goes_into_a_register() {
7088 let i64 = Type::int(64);
7089 let (mut names, mut func, block, args) = blank(&[i64]);
7090 let mut build = Builder::new(&mut func, block);
7091 let big = build.iconst(i64, i128::from(i32::MAX) + 1);
7092 build.binary(Opcode::Add, args[0], big, Flags::default());
7093
7094 // Nobody wrote this fallback down. The rule that takes an immediate has a guard that
7095 // turns a number this wide down, so it does not fire, and the next way of showing the
7096 // operand puts it in a register.
7097 assert_eq!(
7098 lower(&mut names, &func),
7099 "mfunc @f {\nblock0:\n %0:gpr($rdi) = x64.arg_val_64\n \
7100 %1:gpr = x64.mov_ri_64 2147483648\n %2:gpr(reuse 1) = x64.add_rr_64 %0, %1\n}\n"
7101 );
7102 }
7103
7104 #[test]
7105 fn an_index_calculation_folds_into_an_address() {
7106 let i64 = Type::int(64);
7107 let (mut names, mut func, block, args) = blank(&[i64, i64]);
7108 let mut build = Builder::new(&mut func, block);
7109 let four = build.iconst(i64, 4);
7110 let scaled = build.binary(Opcode::Mul, args[1], four, Flags::default());
7111 build.binary(Opcode::Add, args[0], scaled, Flags::default());
7112
7113 // Three IR instructions and one machine instruction. The multiply is gone because the
7114 // rule that matched reached down and took it.
7115 assert_eq!(
7116 lower(&mut names, &func),
7117 "mfunc @f {\nblock0:\n %0:gpr($rdi) = x64.arg_val_64\n \
7118 %1:gpr($rsi) = x64.arg_val_64\n %2:gpr = x64.lea_64 [%0 + %1*4]\n}\n"
7119 );
7120 }
7121
7122 #[test]
7123 fn an_instruction_every_reader_can_take_is_folded_into_all_of_them() {
7124 let i64 = Type::int(64);
7125 let (mut names, mut func, block, args) = blank(&[i64, i64]);
7126 let mut build = Builder::new(&mut func, block);
7127 let four = build.iconst(i64, 4);
7128 let scaled = build.binary(Opcode::Mul, args[1], four, Flags::default());
7129 let first = build.binary(Opcode::Add, args[0], scaled, Flags::default());
7130 build.binary(Opcode::Add, first, scaled, Flags::default());
7131
7132 // Both readers have room for a scaled index, so both of them take it and nothing is left
7133 // to read the multiply. Three IR instructions become two machine ones, where refusing to
7134 // fold into either reader would have left three.
7135 assert_eq!(
7136 lower(&mut names, &func),
7137 "mfunc @f {\nblock0:\n %0:gpr($rdi) = x64.arg_val_64\n \
7138 %1:gpr($rsi) = x64.arg_val_64\n %2:gpr = x64.lea_64 [%0 + %1*4]\n \
7139 %3:gpr = x64.lea_64 [%2 + %1*4]\n}\n"
7140 );
7141 }
7142
7143 #[test]
7144 fn an_instruction_one_of_its_readers_cannot_take_is_folded_into_none_of_them() {
7145 let i64 = Type::int(64);
7146 let (mut names, mut func, block, args) = blank(&[i64, i64]);
7147 let mut build = Builder::new(&mut func, block);
7148 let four = build.iconst(i64, 4);
7149 let scaled = build.binary(Opcode::Mul, args[1], four, Flags::default());
7150 build.binary(Opcode::Add, args[0], scaled, Flags::default());
7151 build.store(scaled, args[0], plain(), Flags::default());
7152
7153 // The addition has room for the multiply and the store does not: what a store writes is
7154 // a register, and no rule reaches through it. Folding into the addition alone would
7155 // leave the multiply where it is for the store to read and do the work twice, so the
7156 // multiply is put back and both readers read the register it wrote.
7157 let text = lower(&mut names, &func);
7158 assert!(text.contains("x64.lea_64 [%1*4]"), "{text}");
7159 assert!(text.contains("x64.add_rr_64"), "{text}");
7160 }
7161
7162 #[test]
7163 fn a_shift_by_a_register_asks_for_it_in_cl() {
7164 let i32 = Type::int(32);
7165 let (mut names, mut func, block, args) = blank(&[i32, i32]);
7166 let mut build = Builder::new(&mut func, block);
7167 build.binary(Opcode::Shl, args[0], args[1], Flags::default());
7168
7169 // The fixed register is not in the rule. It is what the target says the instruction does
7170 // with its operands, and the allocator is what will act on it.
7171 let text = lower(&mut names, &func);
7172 assert!(text.contains("x64.shl_rcl_32 %0, %1($rcx)"), "{text}");
7173 }
7174
7175 #[test]
7176 fn a_division_names_the_registers_and_the_register_it_destroys() {
7177 let i32 = Type::int(32);
7178 let (mut names, mut func, block, args) = blank(&[i32, i32]);
7179 let mut build = Builder::new(&mut func, block);
7180 build.binary(Opcode::SDiv, args[0], args[1], Flags::default());
7181
7182 // Two definitions, because a division writes the remainder whether anybody wanted it or
7183 // not, and the second one is early because it is destroyed before the operands are read.
7184 let text = lower(&mut names, &func);
7185 assert!(
7186 text.contains("%2:gpr($rax), early %3:gpr($rdx) = x64.idiv_quo_32 %0($rax), %1"),
7187 "{text}"
7188 );
7189 }
7190
7191 #[test]
7192 fn a_load_reads_through_the_register_the_address_is_in() {
7193 let i64 = Type::int(64);
7194 let (mut names, mut func, block, args) = blank(&[i64]);
7195 let mut build = Builder::new(&mut func, block);
7196 build.load(Type::int(32), args[0], plain(), Flags::default());
7197
7198 assert_eq!(
7199 lower(&mut names, &func),
7200 "mfunc @f {\nblock0:\n %0:gpr($rdi) = x64.arg_val_64\n \
7201 %1:gpr = x64.mov_rm_32 [%0]\n}\n"
7202 );
7203 }
7204
7205 #[test]
7206 fn a_store_writes_no_register_and_the_value_it_writes_is_the_one_the_ir_gave_it() {
7207 let (mut names, mut func, block, args) = blank(&[Type::int(32), Type::int(64)]);
7208 let mut build = Builder::new(&mut func, block);
7209 build.store(args[0], args[1], plain(), Flags::default());
7210
7211 // The value is the first parameter and the address is the second, and the instruction
7212 // takes them the other way round. Getting that backwards would compile to a store of the
7213 // address into the value, which is a program that runs and does the wrong thing.
7214 assert_eq!(
7215 lower(&mut names, &func),
7216 "mfunc @f {\nblock0:\n %0:gpr($rdi) = x64.arg_val_32\n \
7217 %1:gpr($rsi) = x64.arg_val_64\n x64.mov_mr_32 %0, [%1]\n}\n"
7218 );
7219 }
7220
7221 #[test]
7222 fn an_address_with_a_constant_added_folds_into_the_access() {
7223 let i64 = Type::int(64);
7224 let (mut names, mut func, block, args) = blank(&[i64]);
7225 let mut build = Builder::new(&mut func, block);
7226 let twelve = build.iconst(i64, 12);
7227 let field = build.binary(Opcode::Add, args[0], twelve, Flags::default());
7228 build.load(Type::int(64), field, plain(), Flags::default());
7229
7230 // Two IR instructions and one machine instruction, which is what every read of a field
7231 // of a structure comes to.
7232 assert_eq!(
7233 lower(&mut names, &func),
7234 "mfunc @f {\nblock0:\n %0:gpr($rdi) = x64.arg_val_64\n \
7235 %1:gpr = x64.mov_rm_64 [%0 + 12]\n}\n"
7236 );
7237 }
7238
7239 #[test]
7240 fn a_displacement_too_wide_to_encode_leaves_the_addition_where_it_is() {
7241 let i64 = Type::int(64);
7242 let (mut names, mut func, block, args) = blank(&[i64]);
7243 let mut build = Builder::new(&mut func, block);
7244 let big = build.iconst(i64, i128::from(i32::MAX) + 1);
7245 let far = build.binary(Opcode::Add, args[0], big, Flags::default());
7246 build.load(Type::int(32), far, plain(), Flags::default());
7247
7248 // A displacement is signed and 32 bits. The rule that folds one has a guard that turns
7249 // this down, so the addition stays and the load reads through what it produced. Nobody
7250 // wrote that fallback: it is the next way of showing the operand.
7251 let text = lower(&mut names, &func);
7252 assert!(text.contains("x64.mov_rm_32 [%2]"), "{text}");
7253 assert!(text.contains("x64.add_rr_64"), "{text}");
7254 }
7255
7256 #[test]
7257 fn a_store_of_a_value_that_was_loaded_is_two_instructions_and_no_arithmetic() {
7258 let i64 = Type::int(64);
7259 let (mut names, mut func, block, args) = blank(&[i64, i64]);
7260 let mut build = Builder::new(&mut func, block);
7261 let got = build.load(Type::int(8), args[0], plain(), Flags::default());
7262 build.store(got, args[1], plain(), Flags::default());
7263
7264 // A load feeding a store is the one place folding would be wrong: an x86-64 `mov` has at
7265 // most one memory operand, and there is no rule that takes two, so the load is left where
7266 // it is and the store reads the register it wrote.
7267 assert_eq!(
7268 lower(&mut names, &func),
7269 "mfunc @f {\nblock0:\n %0:gpr($rdi) = x64.arg_val_64\n \
7270 %1:gpr($rsi) = x64.arg_val_64\n %2:gpr = x64.mov_rm_8 [%0]\n \
7271 x64.mov_mr_8 %2, [%1]\n}\n"
7272 );
7273 }
7274
7275 #[test]
7276 fn an_access_at_a_width_no_rule_is_written_at_is_reported() {
7277 let i64 = Type::int(64);
7278 let (mut names, mut source, block, args) = blank(&[i64]);
7279 let mut build = Builder::new(&mut source, block);
7280 build.load(Type::int(128), args[0], plain(), Flags::default());
7281
7282 // The width is the whole of what is wrong here, so the width is in the message: `load`
7283 // on its own is written about at every other width and would send a reader looking in
7284 // the wrong place.
7285 let failed = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7286 .expect_err("nothing loads 128 bits");
7287 assert_eq!(failed.to_string(), "no rule lowers a `load` producing a `i128`");
7288 }
7289
7290 #[test]
7291 fn a_return_asks_for_the_value_in_the_register_the_caller_reads() {
7292 let (mut names, mut func, block, args) = blank(&[Type::int(32)]);
7293 let mut build = Builder::new(&mut func, block);
7294 build.ret(&[args[0]]);
7295
7296 // The register is not in the rule, the same way `cl` is not in the rule for a shift. It
7297 // is what the target says the instruction does with its operand, and the allocator is
7298 // what will act on it. There is no `ret` here, because giving the frame back has to
7299 // happen between this and leaving and the frame is not worked out yet.
7300 assert_eq!(
7301 lower(&mut names, &func),
7302 "mfunc @f {\nblock0:\n %0:gpr($rdi) = x64.arg_val_32\n \
7303 x64.ret_val_32 %0($rax)\n}\n"
7304 );
7305 }
7306
7307 #[test]
7308 fn a_return_of_two_values_asks_for_the_second_register_as_well() {
7309 let i64 = Type::int(64);
7310 let (mut names, mut func, block, args) = blank(&[i64, i64]);
7311 let mut build = Builder::new(&mut func, block);
7312 build.ret(&[args[0], args[1]]);
7313
7314 // `struct { long a, b; } f(long a, long b)`, after the front end has classified it. Both
7315 // halves are integers, so the second is in the second integer return register, and both
7316 // pseudos say so the same way the one for a single value does.
7317 assert_eq!(
7318 lower(&mut names, &func),
7319 "mfunc @f {\nblock0:\n %0:gpr($rdi) = x64.arg_val_64\n \
7320 %1:gpr($rsi) = x64.arg_val_64\n x64.ret_val_64 %0($rax)\n \
7321 x64.ret_val2_64 %1($rdx)\n}\n"
7322 );
7323 }
7324
7325 #[test]
7326 fn two_values_back_in_different_files_are_both_the_first_of_their_own() {
7327 let f64 = Type::float(rucc_ir::Float::F64);
7328 let (mut names, mut func, block, args) = blank(&[f64, Type::int(64)]);
7329 let mut build = Builder::new(&mut func, block);
7330 build.ret(&[args[0], args[1]]);
7331
7332 // `struct { double a; long b; } f(double a, long b)`. The two files are counted apart, so
7333 // neither half is the second of anything and the `double` is in `xmm0` rather than in the
7334 // register a second `double` would have been in. Getting this wrong is not a crash: the
7335 // caller reads a register nobody wrote, and this is where that is ruled out.
7336 assert_eq!(
7337 lower(&mut names, &func),
7338 "mfunc @f {\nblock0:\n %0:xmm($xmm0) = x64.arg_val_f64\n \
7339 %1:gpr($rdi) = x64.arg_val_64\n x64.ret_val_f64 %0($xmm0)\n \
7340 x64.ret_val_64 %1($rax)\n}\n"
7341 );
7342 }
7343
7344 #[test]
7345 fn two_of_the_same_file_back_take_the_first_two_of_it() {
7346 let f64 = Type::float(rucc_ir::Float::F64);
7347 let (mut names, mut func, block, args) = blank(&[f64, f64]);
7348 let mut build = Builder::new(&mut func, block);
7349 build.ret(&[args[0], args[1]]);
7350
7351 // `struct { double x, y; } f(double x, double y)`, which is the vector half of the pair
7352 // above and counts in its own file the same way.
7353 assert_eq!(
7354 lower(&mut names, &func),
7355 "mfunc @f {\nblock0:\n %0:xmm($xmm0) = x64.arg_val_f64\n \
7356 %1:xmm($xmm1) = x64.arg_val_f64\n x64.ret_val_f64 %0($xmm0)\n \
7357 x64.ret_val2_f64 %1($xmm1)\n}\n"
7358 );
7359 }
7360
7361 /// A function whose answer goes back through memory, with the pointer to the space for it in
7362 /// front of whatever else it takes. Only the signature says it is one.
7363 fn returning_through_memory(params: &[Type]) -> (Interner, Func, Block, Vec<Value>) {
7364 let mut names = Interner::new();
7365 let sret = Abi::Sret { size: 32, align: 8 };
7366 let mut signature = Signature::new().and_param(Param::with_abi(Type::PTR, sret));
7367 signature.params.extend(params.iter().copied().map(Param::new));
7368 let mut func = Func::new(names.intern("f"), signature);
7369 let block = func.create_block();
7370 let space = func.append_param(block, Type::PTR);
7371 let values = std::iter::once(space)
7372 .chain(params.iter().map(|&ty| func.append_param(block, ty)))
7373 .collect();
7374 (names, func, block, values)
7375 }
7376
7377 #[test]
7378 fn the_space_a_return_through_memory_was_given_goes_back_in_the_first_return_register() {
7379 let (mut names, mut func, block, _) = returning_through_memory(&[]);
7380 Builder::new(&mut func, block).ret(&[]);
7381
7382 // `struct big f(void)`, where `big` is too large to come back in registers. The `return`
7383 // carries nothing, because the value went into the space the caller handed over, and the
7384 // document still says that address comes back in `rax`. Nothing in the IR says it, so the
7385 // convention says it, and the pseudo is the one any other pointer return would use.
7386 assert_eq!(
7387 lower(&mut names, &func),
7388 "mfunc @f {\nblock0:\n %0:gpr($rdi) = x64.arg_val_64\n \
7389 x64.ret_val_64 %0($rax)\n}\n"
7390 );
7391 }
7392
7393 #[test]
7394 fn what_the_function_did_in_between_does_not_take_the_register_off_it() {
7395 let (mut names, mut func, block, args) = returning_through_memory(&[Type::int(32)]);
7396 let mut build = Builder::new(&mut func, block);
7397 build.store(args[1], args[0], plain(), Flags::default());
7398 build.ret(&[]);
7399
7400 // The register is a read at the end and not a move at the start, so it is live across
7401 // everything between the two and the allocator has to keep it somewhere. In a function
7402 // with a call in it that somewhere is a callee saved register, and the address comes back
7403 // into `rax` here rather than whatever the last instruction happened to leave there. That
7404 // is issue #333, and a store is enough to show the value outlives the entry block.
7405 let text = lower(&mut names, &func);
7406 assert!(text.contains("x64.mov_mr_32 %1, [%0]"), "{text}");
7407 assert!(text.ends_with(" x64.ret_val_64 %0($rax)\n}\n"), "{text}");
7408 }
7409
7410 #[test]
7411 fn a_pointer_that_is_only_a_pointer_is_not_given_back() {
7412 let (mut names, mut func, block, args) = blank(&[Type::PTR]);
7413 let mut build = Builder::new(&mut func, block);
7414 build.store(args[0], args[0], plain(), Flags::default());
7415 build.ret(&[]);
7416
7417 // `void f(void **p)`. It takes a pointer first and returns nothing, which is the shape of
7418 // the one above and none of its meaning, and what tells them apart is the signature. A
7419 // `void` function leaves `rax` alone.
7420 assert!(!lower(&mut names, &func).contains("ret_val"));
7421 }
7422
7423 #[test]
7424 fn a_return_of_a_constant_puts_it_in_a_register_first() {
7425 let (mut names, mut func, block, _) = blank(&[]);
7426 let mut build = Builder::new(&mut func, block);
7427 let zero = build.iconst(Type::int(32), 0);
7428 build.ret(&[zero]);
7429
7430 // No rule returns an immediate, so the plan that offers one is turned down and the next
7431 // one materializes it. That is `int main(void) { return 0; }` in full, once the epilogue
7432 // is appended to it.
7433 assert_eq!(
7434 lower(&mut names, &func),
7435 "mfunc @f {\nblock0:\n %0:gpr = x64.mov_ri_32 0\n x64.ret_val_32 %0($rax)\n}\n"
7436 );
7437 }
7438
7439 #[test]
7440 fn the_rule_that_writes_a_constant_down_is_recorded_as_a_rule_that_fired() {
7441 let (mut names, mut func, block, _) = blank(&[]);
7442 let mut build = Builder::new(&mut func, block);
7443 let zero = build.iconst(Type::int(32), 0);
7444 build.ret(&[zero]);
7445
7446 // The loop over the instructions passes a constant by, because a constant is written where
7447 // a register for it is first wanted rather than where the IR put it. So the only place a
7448 // rule about one is ever selected is the materialization, and a mark made in the loop
7449 // alone would report every rule about a constant as a rule nothing reaches.
7450 let out = super::func(&func, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7451 .expect("every instruction has a rule");
7452 let rules = &crate::select::x86_64::TABLE.rules;
7453 let fired: Vec<&str> = rules
7454 .iter()
7455 .enumerate()
7456 .filter(|(index, _)| out.fired.has(*index))
7457 .map(|(_, rule)| rule.pattern)
7458 .collect();
7459 assert!(fired.contains(&"(iconst.i32 k)"), "{fired:?}");
7460 }
7461
7462 #[test]
7463 fn a_return_of_nothing_is_no_instruction_at_all() {
7464 let (mut names, mut func, block, _) = blank(&[]);
7465 let mut build = Builder::new(&mut func, block);
7466 build.ret(&[]);
7467
7468 // Every part of leaving a function that returns nothing is the epilogue's, and the
7469 // epilogue goes in after allocation. A block with nothing in it is the right answer here
7470 // rather than a function that could not be lowered.
7471 assert_eq!(lower(&mut names, &func), "mfunc @f {\nblock0:\n}\n");
7472 }
7473
7474 #[test]
7475 fn the_allocator_is_what_moves_the_answer_into_the_return_register() {
7476 let (mut names, mut source, block, _) = blank(&[]);
7477 let mut build = Builder::new(&mut source, block);
7478 let zero = build.iconst(Type::int(32), 0);
7479 build.ret(&[zero]);
7480
7481 let mut out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7482 .expect("every instruction has a rule")
7483 .func;
7484 let env = env();
7485 let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
7486 let frame = Frame::of(&out, &allocation, &Layout::new(&SYSV, REGS));
7487 finish(
7488 &mut out,
7489 &allocation,
7490 &frame,
7491 &Stack::default(),
7492 Convention::new(&SYSV, &FRAME),
7493 &mut names,
7494 );
7495
7496 // `int main(void) { return 0; }` end to end. Nothing here asked for `rax`: the rule said
7497 // the value goes back, the target said where, and the allocator is what made it true. The
7498 // epilogue is what leaves, and this function needs no frame, so it is the return alone.
7499 //
7500 // Two instructions and no copy, which is what a hint buys. The return insists on `rax`,
7501 // so `rax` is the register the allocator tries first for the value the return reads, and
7502 // the constant is written straight into it.
7503 assert_eq!(
7504 mir::print_func(&out, &names, ®S),
7505 "mfunc @f {\nblock0:\n $rax = x64.mov_ri_32 0\n \
7506 x64.ret_val_32 $rax($rax)\n x64.ret\n}\n"
7507 );
7508 }
7509
7510 #[test]
7511 fn a_function_of_two_arguments_is_a_whole_function_now() {
7512 let i32 = Type::int(32);
7513 let (mut names, mut source, block, args) = blank(&[i32, i32]);
7514 let mut build = Builder::new(&mut source, block);
7515 let sum = build.binary(Opcode::Add, args[0], args[1], Flags::default());
7516 build.ret(&[sum]);
7517
7518 let mut out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7519 .expect("every instruction has a rule")
7520 .func;
7521 let env = env();
7522 let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
7523 let frame = Frame::of(&out, &allocation, &Layout::new(&SYSV, REGS));
7524 finish(
7525 &mut out,
7526 &allocation,
7527 &frame,
7528 &Stack::default(),
7529 Convention::new(&SYSV, &FRAME),
7530 &mut names,
7531 );
7532
7533 // `int f(int a, int b) { return a + b; }` end to end, and this is the test the argument
7534 // side exists for. Before it there was no way to write one: the allocator refuses a
7535 // function whose entry block takes parameters, because there is no edge into an entry
7536 // block for the moves that give a block parameter its value to go on.
7537 //
7538 // One move, and it is the one the machine's addition needs rather than one the allocator
7539 // owes anybody. Each argument stays in the register it arrived in, because the pseudo
7540 // that defines it insists on that register and the allocator now tries it first, and the
7541 // sum stays in the register the addition wrote it to until the return reads it out. The
7542 // copy in front of a two address instruction is what makes its destination one of the
7543 // registers it reads, and the source operand keeps its own name because the destination
7544 // is what the encoder writes.
7545 assert_eq!(
7546 mir::print_func(&out, &names, ®S),
7547 "mfunc @f {\nblock0:\n $rdi($rdi) = x64.arg_val_32\n \
7548 $rsi($rsi) = x64.arg_val_32\n \
7549 $rdi(reuse 1) = x64.add_rr_32 $rdi, $rsi\n $rax = x64.mov_rr_64 $rdi\n \
7550 x64.ret_val_32 $rax($rax)\n x64.ret\n}\n"
7551 );
7552 }
7553
7554 #[test]
7555 fn an_argument_with_no_register_left_for_it_is_read_out_of_the_caller_s_stack() {
7556 let i64 = Type::int(64);
7557 let (mut names, mut source, block, args) = blank(&[i64; 7]);
7558 let mut build = Builder::new(&mut source, block);
7559 build.ret(&[args[6]]);
7560
7561 let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7562 .expect("the seventh is read from memory");
7563
7564 // SysV passes six integers in registers and the seventh in the caller's memory, so six of
7565 // these are pseudos that encode to nothing and the seventh is a load that encodes to real
7566 // bytes. Its displacement is nothing here for the reason a local's is: there is no frame
7567 // yet. What the walk hands on is which instruction is waiting, and for how far up the
7568 // caller's argument area, which is the bottom of it because it is the first one there.
7569 assert_eq!(lowered.stack.arguments.len(), 1);
7570 assert_eq!(lowered.stack.arguments[0].1, 0);
7571 let text = mir::print_func(&lowered.func, &names, ®S);
7572 assert!(text.contains("%6:gpr = x64.mov_rm_64 [$rsp]"), "{text}");
7573 assert_eq!(text.matches("x64.arg_val_64").count(), 6, "{text}");
7574 }
7575
7576 #[test]
7577 fn the_frame_is_what_says_how_far_up_the_caller_s_stack_an_argument_is() {
7578 let i64 = Type::int(64);
7579 let (mut names, mut source, block, args) = blank(&[i64; 8]);
7580 let mut build = Builder::new(&mut source, block);
7581 let sum = build.binary(Opcode::Add, args[6], args[7], Flags::default());
7582 build.ret(&[sum]);
7583
7584 let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7585 .expect("both are read from memory");
7586 let stack = lowered.stack;
7587 let mut out = lowered.func;
7588 let env = env();
7589 let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
7590 let layout = stack.layout(Layout::new(&SYSV, REGS));
7591 let frame = Frame::of(&out, &allocation, &layout);
7592 finish(&mut out, &allocation, &frame, &stack, Convention::new(&SYSV, &FRAME), &mut names);
7593
7594 // A leaf that takes no frame, so the stack pointer never moves and the only thing between
7595 // it and the caller's arguments is the return address the call pushed. The seventh
7596 // parameter is at the bottom of the caller's argument area and the eighth is one word
7597 // further up, which is the eight bytes between the two offsets.
7598 let text = mir::print_func(&out, &names, ®S);
7599 assert_eq!(frame.size(), 0);
7600 assert_eq!(frame.incoming(), Incoming::from_stack(8));
7601 assert!(text.contains("x64.mov_rm_64 [$rsp + 8]"), "{text}");
7602 assert!(text.contains("x64.mov_rm_64 [$rsp + 16]"), "{text}");
7603 }
7604
7605 #[test]
7606 fn a_realigned_frame_reaches_the_caller_s_arguments_through_the_frame_pointer() {
7607 let i64 = Type::int(64);
7608 let (mut names, mut source, block, args) = blank(&[i64; 7]);
7609 let wide = slot(&mut source, block, 64, 32);
7610 let mut build = Builder::new(&mut source, block);
7611 build.store(args[6], wide, plain(), Flags::default());
7612 build.ret(&[args[6]]);
7613
7614 let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7615 .expect("every instruction has a rule");
7616 let stack = lowered.stack;
7617 let mut out = lowered.func;
7618 let env = env();
7619 let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
7620 let layout = stack.layout(Layout::new(&SYSV, REGS));
7621 let frame = Frame::of(&out, &allocation, &layout);
7622 finish(&mut out, &allocation, &frame, &stack, Convention::new(&SYSV, &FRAME), &mut names);
7623
7624 // A local wanting thirty two byte alignment makes the prologue force the stack pointer,
7625 // which throws away how far the caller's stack was. So the load the lowering wrote off the
7626 // stack pointer is rewritten to read through the frame pointer, at the one distance that
7627 // survives: the word the prologue pushed the frame pointer into, and the return address
7628 // above it.
7629 let text = mir::print_func(&out, &names, ®S);
7630 assert_eq!(frame.realign(), Some(32));
7631 assert_eq!(frame.incoming(), Incoming::from_frame(16));
7632 assert!(text.contains("x64.mov_rm_64 [$rbp + 16]"), "{text}");
7633 assert!(!text.contains("x64.mov_rm_64 [$rsp"), "{text}");
7634 }
7635
7636 #[test]
7637 fn a_jump_is_the_edge_and_nothing_else() {
7638 let i32 = Type::int(32);
7639 let (mut names, mut source, entry, args) = blank(&[i32]);
7640 let next = source.create_block();
7641 let got = source.append_param(next, i32);
7642 Builder::new(&mut source, entry).jump(next, &[args[0]]);
7643 Builder::new(&mut source, next).ret(&[got]);
7644
7645 // Two blocks and two instructions, and the jump is neither of them. What it was is the
7646 // arm on the first block, and what the arm carries is the argument it was called with.
7647 assert_eq!(
7648 lower(&mut names, &source),
7649 "mfunc @f {\nblock0:\n %0:gpr($rdi) = x64.arg_val_32 block1(%0)\n\n\
7650 block1(%1:gpr):\n x64.ret_val_32 %1($rax)\n}\n"
7651 );
7652 }
7653
7654 /// A block that reads what a block below it writes is filled after it, not before it.
7655 ///
7656 /// The blocks are written entry, `early`, `late`, `exit`, and the entry jumps straight past
7657 /// `early` to `late`, so `late` dominates `early` while sitting below it in the function.
7658 /// Filling them in the order they are written reaches the read in `early` first, and reading
7659 /// a value with no register yet mints one. The cast in `late` is no instruction at all, so
7660 /// what it does is give its answer the register its operand is already in, and that is not
7661 /// the register the read minted. Nothing writes the register the read minted. The printer
7662 /// says `%?` for a register nothing defines, which is what this looks for, and what came out
7663 /// of the real bug was SQLite loading a stack slot no store ever reached.
7664 #[test]
7665 fn a_block_that_reads_what_a_block_below_it_writes_is_filled_after_it() {
7666 let i64 = Type::int(64);
7667 let (mut names, mut source, entry, args) = blank(&[i64, i64]);
7668 let early = source.create_block();
7669 let late = source.create_block();
7670 let exit = source.create_block();
7671
7672 Builder::new(&mut source, entry).jump(late, &[]);
7673 let ptr = cast(&mut source, late, Opcode::IntToPtr, args[0], Type::PTR);
7674 Builder::new(&mut source, early).ret(&[ptr]);
7675 let mut build = Builder::new(&mut source, late);
7676 let cond = build.icmp(rucc_ir::IntPred::Slt, args[0], args[1]);
7677 build.br_if(cond, early, &[], exit, &[]);
7678 Builder::new(&mut source, exit).ret(&[args[1]]);
7679
7680 let text = lower(&mut names, &source);
7681 assert!(!text.contains("%?"), "every register has something that writes it: {text}");
7682 }
7683
7684 /// A constant is written where it is wanted rather than where the IR defined it, and two
7685 /// blocks wanting the same one is two places. Writing it once and reading it in both is a
7686 /// register read where nothing wrote it, unless the block it was written in happens to
7687 /// dominate the other, which nothing here checks and which the second arm of a branch never
7688 /// does. Each block gets its own copy of the number instead.
7689 #[test]
7690 fn a_constant_two_blocks_want_is_written_in_both_of_them() {
7691 let i32 = Type::int(32);
7692 let (mut names, mut source, entry, args) = blank(&[i32, i32]);
7693 let then = source.create_block();
7694 let other = source.create_block();
7695 let join = source.create_block();
7696 let got = source.append_param(join, i32);
7697
7698 let mut build = Builder::new(&mut source, entry);
7699 let seven = build.iconst(i32, 7);
7700 let cond = build.icmp(rucc_ir::IntPred::Slt, args[0], args[1]);
7701 build.br_if(cond, then, &[], other, &[]);
7702 // Both arms want the seven in a register, because a block argument is never an immediate,
7703 // and neither arm dominates the other.
7704 Builder::new(&mut source, then).jump(join, &[seven]);
7705 Builder::new(&mut source, other).jump(join, &[seven]);
7706 Builder::new(&mut source, join).ret(&[got]);
7707
7708 let text = lower(&mut names, &source);
7709 assert_eq!(text.matches("x64.mov_ri_32 7").count(), 2, "one seven per block: {text}");
7710 }
7711
7712 /// An argument on an edge out of a block that leaves two ways is read after every instruction
7713 /// of the block is written, and reading one can write an instruction, which would land after
7714 /// the branch that has already jumped past it. The branch goes back on the end.
7715 #[test]
7716 fn a_constant_an_edge_wants_is_written_before_the_branch_and_not_after_it() {
7717 let i32 = Type::int(32);
7718 let (mut names, mut source, entry, args) = blank(&[i32, i32]);
7719 let then = source.create_block();
7720 let join = source.create_block();
7721 let got = source.append_param(join, i32);
7722
7723 let mut build = Builder::new(&mut source, entry);
7724 let nine = build.iconst(i32, 9);
7725 let cond = build.icmp(rucc_ir::IntPred::Slt, args[0], args[1]);
7726 build.br_if(cond, then, &[], join, &[nine]);
7727 Builder::new(&mut source, then).jump(join, &[args[0]]);
7728 Builder::new(&mut source, join).ret(&[got]);
7729
7730 let out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7731 .expect("every instruction has a rule")
7732 .func;
7733 let entry = out.entry().expect("an entry block");
7734 let last = out.terminator(entry).expect("a block that leaves two ways has a branch");
7735 let branch = names.intern("x64.br_cond_8");
7736 assert_eq!(
7737 out[last].opcode,
7738 mir::Opcode::new(branch),
7739 "the branch is last: {}",
7740 mir::print_func(&out, &names, ®S)
7741 );
7742 }
7743
7744 #[test]
7745 fn a_conditional_branch_is_lowered_to_the_condition_and_nothing_about_where_it_goes() {
7746 let i32 = Type::int(32);
7747 let (mut names, mut source, entry, args) = blank(&[i32, i32]);
7748 let then = source.create_block();
7749 let other = source.create_block();
7750 let mut build = Builder::new(&mut source, entry);
7751 let cond = build.icmp(rucc_ir::IntPred::Slt, args[0], args[1]);
7752 build.br_if(cond, then, &[], other, &[]);
7753 Builder::new(&mut source, then).ret(&[args[0]]);
7754 Builder::new(&mut source, other).ret(&[args[1]]);
7755
7756 // The comparison writes a byte and the branch reads it, and neither says a block. Both
7757 // arms are on the entry block, in the order the branch took them, so the arm that runs
7758 // when the condition holds is the first.
7759 assert_eq!(
7760 lower(&mut names, &source),
7761 "mfunc @f {\nblock0:\n %0:gpr($rdi) = x64.arg_val_32\n \
7762 %1:gpr($rsi) = x64.arg_val_32\n %2:gpr = x64.cmp_set_l_32 %0, %1\n \
7763 x64.br_cond_8 %2, block1, block2\n\n\
7764 block1:\n x64.ret_val_32 %0($rax)\n\n\
7765 block2:\n x64.ret_val_32 %1($rax)\n}\n"
7766 );
7767 }
7768
7769 /// A choice between two values, which is one instruction and no blocks at all.
7770 ///
7771 /// The arms come out the other way round from the IR, because a conditional move overwrites its
7772 /// destination and the destination is the arm taken when the condition does not hold. The
7773 /// condition arrives last for the same reason: it is read by the test in front of the move
7774 /// rather than by the move.
7775 #[test]
7776 fn a_select_is_lowered_to_a_test_and_a_conditional_move() {
7777 let i32 = Type::int(32);
7778 let (mut names, mut source, entry, args) = blank(&[i32, i32]);
7779 let mut build = Builder::new(&mut source, entry);
7780 let cond = build.icmp(rucc_ir::IntPred::Slt, args[0], args[1]);
7781 let picked = build.select(cond, args[0], args[1]);
7782 build.ret(&[picked]);
7783
7784 assert_eq!(
7785 lower(&mut names, &source),
7786 "mfunc @f {\nblock0:\n %0:gpr($rdi) = x64.arg_val_32\n \
7787 %1:gpr($rsi) = x64.arg_val_32\n %2:gpr = x64.cmp_set_l_32 %0, %1\n \
7788 %3:gpr(reuse 1) = x64.test_cmov_ne_32 %1, %0, %2\n \
7789 x64.ret_val_32 %3($rax)\n}\n"
7790 );
7791 }
7792
7793 #[test]
7794 fn a_branch_over_a_block_is_a_whole_function_now() {
7795 let i32 = Type::int(32);
7796 let (mut names, mut source, entry, args) = blank(&[i32, i32]);
7797 let then = source.create_block();
7798 let other = source.create_block();
7799 let join = source.create_block();
7800 let got = source.append_param(join, i32);
7801 let mut build = Builder::new(&mut source, entry);
7802 let cond = build.icmp(rucc_ir::IntPred::Slt, args[0], args[1]);
7803 build.br_if(cond, then, &[], other, &[]);
7804 let mut build = Builder::new(&mut source, then);
7805 let sum = build.binary(Opcode::Add, args[0], args[1], Flags::default());
7806 build.jump(join, &[sum]);
7807 Builder::new(&mut source, other).jump(join, &[args[1]]);
7808 Builder::new(&mut source, join).ret(&[got]);
7809
7810 // `int f(int a, int b) { if (a < b) return a + b; else return b; }` end to end, written
7811 // the way a front end writes it: both arms of the branch are blocks of their own and the
7812 // return is the block they meet at. No edge here is critical, because the two arms out of
7813 // the entry carry nothing and the two arms into the join each leave a block that goes
7814 // nowhere else, so each has its own end to put its move at.
7815 let mut out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7816 .expect("every instruction has a rule")
7817 .func;
7818 assert_eq!(crate::split::critical(&mut out), 0, "no edge here is critical");
7819 let env = env();
7820 let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
7821 let frame = Frame::of(&out, &allocation, &Layout::new(&SYSV, REGS));
7822 finish(
7823 &mut out,
7824 &allocation,
7825 &frame,
7826 &Stack::default(),
7827 Convention::new(&SYSV, &FRAME),
7828 &mut names,
7829 );
7830
7831 // One epilogue, on the join, which is the one block the function leaves from, and the
7832 // moves that give the join its parameter are at the end of each arm. Every register is
7833 // physical and the branch is still a branch on a register, because turning it into a
7834 // `test` and a `jcc` is the block layout's and there is no block layout yet.
7835 let text = mir::print_func(&out, &names, ®S);
7836 assert_eq!(text.matches("x64.ret\n").count(), 1, "{text}");
7837 assert!(text.contains("x64.br_cond_8"), "{text}");
7838 assert!(text.contains("x64.add_rr_32"), "{text}");
7839 assert!(!text.contains('%'), "{text}");
7840 }
7841
7842 #[test]
7843 fn a_critical_edge_is_split_before_the_allocator_ever_sees_it() {
7844 let i32 = Type::int(32);
7845 let (mut names, mut source, entry, args) = blank(&[i32, i32]);
7846 let then = source.create_block();
7847 let join = source.create_block();
7848 let got = source.append_param(join, i32);
7849 let mut build = Builder::new(&mut source, entry);
7850 let cond = build.icmp(rucc_ir::IntPred::Slt, args[0], args[1]);
7851 build.br_if(cond, then, &[], join, &[args[1]]);
7852 Builder::new(&mut source, then).jump(join, &[args[0]]);
7853 let mut build = Builder::new(&mut source, join);
7854 let twice = build.binary(Opcode::Add, got, got, Flags::default());
7855 build.ret(&[twice]);
7856
7857 // The else arm is critical: the entry block leaves two ways and the join is arrived at
7858 // two ways, and the arm carries a value. Without splitting it the allocator asserts,
7859 // because the move that gives the join its parameter would have to run at the end of a
7860 // block that also goes to the other arm.
7861 let mut out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7862 .expect("every instruction has a rule")
7863 .func;
7864 assert_eq!(crate::split::critical(&mut out), 1);
7865 let env = env();
7866 let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
7867 let frame = Frame::of(&out, &allocation, &Layout::new(&SYSV, REGS));
7868 finish(
7869 &mut out,
7870 &allocation,
7871 &frame,
7872 &Stack::default(),
7873 Convention::new(&SYSV, &FRAME),
7874 &mut names,
7875 );
7876
7877 // The block the split added is where the move went, and it is the whole of that block.
7878 let text = mir::print_func(&out, &names, ®S);
7879 assert_eq!(out.block_count(), 4, "{text}");
7880 assert_eq!(text.matches("x64.ret\n").count(), 1, "{text}");
7881 }
7882
7883 #[test]
7884 fn a_call_passes_what_the_convention_says_and_takes_back_what_it_says() {
7885 let i32 = Type::int(32);
7886 let (mut names, mut source, block, args) = blank(&[i32, i32]);
7887 let sig =
7888 source.add_signature(Signature::new().with_params(&[i32, i32]).with_returns(&[i32]));
7889 let callee = names.intern("g");
7890 let call = Builder::new(&mut source, block).call(callee, sig, &[args[0], args[1]]);
7891 let got = source[call].first_result.expect("an integer comes back");
7892 Builder::new(&mut source, block).ret(&[got]);
7893
7894 // `int f(int a, int b) { return g(a, b); }`. The arguments arrived where the call wants
7895 // them, so what the call reads is what arrived, and the whole of the convention is in the
7896 // constraints rather than in a move.
7897 let text = lower(&mut names, &source);
7898 assert!(text.contains("= x64.call %0($rdi), %1($rsi), @g"), "{text}");
7899 assert!(text.contains("x64.ret_val_32 %2($rax)"), "{text}");
7900 // What the call writes is the value that comes back and then every register the callee is
7901 // free to destroy, in both classes, which is the whole of what stops the allocator from
7902 // leaving something in one of them.
7903 assert!(text.contains("%2:gpr($rax), $rcx, $rdx, $r8, $r9, $r10, $r11, $xmm0,"), "{text}");
7904 assert!(text.contains("$xmm15 = x64.call"), "{text}");
7905 }
7906
7907 #[test]
7908 fn what_the_frame_owes_a_call_comes_back_with_the_function() {
7909 let i32 = Type::int(32);
7910 let sig = |source: &mut Func| source.add_signature(Signature::new().with_params(&[i32]));
7911
7912 let (mut names, mut source, block, args) = blank(&[i32]);
7913 let sig = sig(&mut source);
7914 let callee = names.intern("g");
7915 Builder::new(&mut source, block).call(callee, sig, &[args[0]]);
7916 let out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7917 .expect("every instruction has a rule");
7918
7919 // Nothing on the stack, so nothing owed, but not a leaf either: a function that calls
7920 // owes the callee an aligned stack pointer and may not use the red zone.
7921 assert_eq!(out.stack.calls, Some(0));
7922 let layout = out.stack.layout(Layout::new(&SYSV, REGS));
7923 assert!(!layout.leaf);
7924 assert_eq!(layout.outgoing, 0);
7925
7926 // The same call under the other convention owes thirty two bytes for the callee to spill
7927 // its register arguments into, which is a fact about the convention and not about the call.
7928 let out = func(&source, &mut names, &SELECTOR, &x86_64::WIN64, &Elsewhere::default())
7929 .expect("every instruction has a rule");
7930 assert_eq!(out.stack.calls, Some(32));
7931
7932 // And a function that calls nothing is a leaf, which is what says it may use the red zone.
7933 let (mut names, mut source, block, args) = blank(&[i32]);
7934 Builder::new(&mut source, block).ret(&[args[0]]);
7935 let out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7936 .expect("every instruction has a rule");
7937 assert_eq!(out.stack.calls, None);
7938 assert!(out.stack.layout(Layout::new(&SYSV, REGS)).leaf);
7939 }
7940
7941 /// A Windows variadic prologue writes the argument registers the signature did not name into
7942 /// the shadow space the caller already reserved, which makes every argument one run of words up
7943 /// there and a `va_start` the address of the first of them. One `lea` and one store, and no
7944 /// counts, because a list that is a pointer has nowhere to put one and nothing that reads one.
7945 #[test]
7946 fn a_windows_variadic_function_homes_its_spare_registers_in_the_callers_area() {
7947 let mut names = Interner::new();
7948 let params = [Type::int(32), Type::PTR];
7949 let signature = Signature::new().with_params(¶ms).variadic();
7950 let mut source = Func::new(names.intern("f"), signature);
7951 let block = source.create_block();
7952 let values: Vec<Value> = params.iter().map(|&ty| source.append_param(block, ty)).collect();
7953 let mut build = Builder::new(&mut source, block);
7954 let args = build.func().push_values(&values[1..]);
7955 build.inst(InstData { args, ..InstData::new(Opcode::VaStart) }, &[]);
7956 build.ret(&[]);
7957
7958 let out = func(&source, &mut names, &SELECTOR, &x86_64::WIN64, &Elsewhere::default())
7959 .expect("every instruction has a rule");
7960 let text = mir::print_func(&out.func, &names, ®S);
7961
7962 // Two named parameters, so the registers at the next two positions hold arguments nobody
7963 // named and both are written up into the caller's area. The displacement is empty here and
7964 // `finish` fills it in, the same way it does for a parameter the registers ran out before.
7965 assert!(text.contains("($r8) = x64.arg_val_64"), "{text}");
7966 assert!(text.contains("($r9) = x64.arg_val_64"), "{text}");
7967 assert_eq!(text.matches("x64.mov_mr_64").count(), 3, "two homed and one stored: {text}");
7968 assert!(!text.contains("x64.mov_ri_32"), "and no field holds a count: {text}");
7969
7970 // All three waiting on the same fixup, and the last of them is the `lea` the list is given,
7971 // sixteen bytes up, which is where the two arguments the signature does name stopped.
7972 assert_eq!(out.stack.arguments.len(), 3);
7973 assert_eq!(out.stack.arguments[2].1, 16);
7974 }
7975
7976 #[test]
7977 fn a_value_that_outlives_a_call_is_not_left_where_the_call_destroys_it() {
7978 let i32 = Type::int(32);
7979 let (mut names, mut source, block, args) = blank(&[i32]);
7980 let sig = source.add_signature(Signature::new().with_params(&[i32]).with_returns(&[i32]));
7981 let callee = names.intern("g");
7982 let call = Builder::new(&mut source, block).call(callee, sig, &[args[0]]);
7983 let got = source[call].first_result.expect("an integer comes back");
7984 let mut build = Builder::new(&mut source, block);
7985 let sum = build.binary(Opcode::Add, got, args[0], Flags::default());
7986 build.ret(&[sum]);
7987
7988 // `int f(int a) { return g(a) + a; }`, which is the smallest program that asks the
7989 // question: `a` is read after the call and `rdi` is a register the call destroys.
7990 let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7991 .expect("every instruction has a rule");
7992 let layout = lowered.stack.layout(Layout::new(&SYSV, REGS));
7993 let mut out = lowered.func;
7994 let env = env();
7995 let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
7996 let frame = Frame::of(&out, &allocation, &layout);
7997 finish(
7998 &mut out,
7999 &allocation,
8000 &frame,
8001 &Stack::default(),
8002 Convention::new(&SYSV, &FRAME),
8003 &mut names,
8004 );
8005
8006 // It went to a register the callee has to put back, and the prologue and epilogue are what
8007 // put it back, which is the whole bargain the two halves of a convention make.
8008 let text = mir::print_func(&out, &names, ®S);
8009 assert!(text.contains("$rbx"), "{text}");
8010 assert!(!text.contains('%'), "{text}");
8011 assert_eq!(text.matches("x64.call").count(), 1, "{text}");
8012 }
8013
8014 #[test]
8015 fn a_call_with_more_arguments_than_registers_writes_the_rest_into_the_outgoing_area() {
8016 let i64 = Type::int(64);
8017 let (mut names, mut source, block, args) = blank(&[i64]);
8018 let seven = vec![i64; 7];
8019 let sig = source.add_signature(Signature::new().with_params(&seven));
8020 let callee = names.intern("g");
8021 let passed = vec![args[0]; 7];
8022 Builder::new(&mut source, block).call(callee, sig, &passed);
8023
8024 let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8025 .expect("the seventh goes to memory");
8026 // The bytes the call needs are on the layout the frame is worked out from, so that the
8027 // frame reserves as many as the widest call in the function asked for.
8028 assert_eq!(lowered.stack.calls, Some(8));
8029 let text = mir::print_func(&lowered.func, &names, ®S);
8030 assert!(text.contains("x64.mov_mr_64 %0, [$rsp]\n"), "{text}");
8031 }
8032
8033 #[test]
8034 fn a_call_this_cannot_make_is_reported_rather_than_made() {
8035 let (mut names, mut source, block, _) = blank(&[]);
8036 let returns = [Type::float(rucc_ir::Float::F80), Type::int(64)];
8037 let sig = source.add_signature(Signature::new().with_returns(&returns));
8038 let callee = names.intern("g");
8039 Builder::new(&mut source, block).call(callee, sig, &[]);
8040 let failed = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8041 .expect_err("a long double is on the x87");
8042 assert_eq!(failed.to_string(), "what this call gives back is on the x87 stack");
8043 }
8044
8045 /// A `long double` on its own is a different answer, because on its own it comes back on the
8046 /// x87 stack rather than in a register, which is somewhere the call cannot be said to write.
8047 ///
8048 /// So the call gives back nothing at all and the value is taken off the stack by the `fstp`
8049 /// straight after it. That instruction has to be straight after it: the stack is one place and
8050 /// anything else that touched it before this ran would be looking at the value still on it.
8051 #[test]
8052 fn a_call_that_gives_back_a_long_double_takes_it_off_the_stack_at_once() {
8053 let (mut names, mut source, block, _) = blank(&[]);
8054 let long_double = Type::float(rucc_ir::Float::F80);
8055 let sig = source.add_signature(Signature::new().with_returns(&[long_double]));
8056 let callee = names.intern("g");
8057 Builder::new(&mut source, block).call(callee, sig, &[]);
8058
8059 let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8060 .expect("the value comes back in st0");
8061 let text = mir::print_func(&lowered.func, &names, ®S);
8062 let after: Vec<&str> =
8063 text.lines().skip_while(|line| !line.contains("x64.call")).skip(1).collect();
8064 assert_eq!(after[0].trim(), "%0:gpr = x64.lea_64 [$rsp]", "{text}");
8065 assert_eq!(after[1].trim(), "x64.fstp_t [%0]", "{text}");
8066 // And the slot it went into is the sixteen bytes the type takes, like every other one.
8067 assert_eq!(lowered.stack.locals.len(), 1, "{text}");
8068 assert_eq!(lowered.stack.locals[0].size, X87_BYTES);
8069 }
8070
8071 #[test]
8072 fn a_call_through_an_address_goes_through_the_register_the_address_is_in() {
8073 let i32 = Type::int(32);
8074 let (mut names, mut source, block, args) = blank(&[Type::PTR, i32]);
8075 let sig = source.add_signature(Signature::new().with_params(&[i32]).with_returns(&[i32]));
8076 let varargs = source.push_abis(&[]);
8077 let info = source.add_call(CallInfo { callee: None, signature: sig, varargs });
8078 let mut build = Builder::new(&mut source, block);
8079 let inst = InstData {
8080 args: build.func().push_values(&[args[0], args[1]]),
8081 extra: Extra::Call(info),
8082 ..InstData::new(Opcode::CallIndirect)
8083 };
8084 let called = build.inst(inst, &[i32]);
8085 let got = source[called].first_result.expect("an integer comes back");
8086 Builder::new(&mut source, block).ret(&[got]);
8087
8088 // `int f(int (*g)(int), int a) { return g(a); }`. The first operand is the address and
8089 // the arguments are the ones behind it, and everything else about the call is what a call
8090 // to a name would have been.
8091 let text = lower(&mut names, &source);
8092 assert!(text.contains("= x64.call_reg %0, %1($rdi)"), "{text}");
8093 assert!(text.contains("x64.ret_val_32 %2($rax)"), "{text}");
8094 assert!(!text.contains("@g"), "a call through an address names nobody: {text}");
8095 }
8096
8097 #[test]
8098 fn an_instruction_no_rule_covers_is_reported() {
8099 let (mut names, mut source, block, args) = blank(&[Type::PTR]);
8100 let mut build = Builder::new(&mut source, block);
8101 let operands = build.func().push_values(&[args[0]]);
8102 build.inst(InstData { args: operands, ..InstData::new(Opcode::MetaBegin) }, &[]);
8103
8104 // The mark that an object has come into being, which nothing writes an instruction for
8105 // yet: what it needs is a write over a range of the lifetime plane, and that is
8106 // `tamnd/rucc#856`. Nothing about it is a width or a register, so there is nothing for the
8107 // message to add beyond the name.
8108 let failed = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8109 .expect_err("no rule writes the beginning of a lifetime");
8110 assert_eq!(failed.to_string(), "no rule lowers a `meta_begin`");
8111
8112 // It produces nothing, so there is no type in the message and nothing invents one, and the
8113 // instruction comes back so a caller can ask the function where it was.
8114 let inst = failed.inst().expect("the instruction it is about");
8115 assert_eq!(source[inst].opcode, Opcode::MetaBegin);
8116 }
8117
8118 /// A barrier is written by name here, and what it is depends on the ordering and on nothing
8119 /// else. `crate::expand` is where the reasoning about this machine's memory model lives.
8120 #[test]
8121 fn a_barrier_is_one_instruction_at_the_strongest_ordering_and_none_below_it() {
8122 for order in MemOrder::all().filter(|&order| order != MemOrder::NotAtomic) {
8123 let (mut names, mut source, block, _) = blank(&[]);
8124 let mut build = Builder::new(&mut source, block);
8125 build
8126 .inst(InstData { extra: Extra::Order(order), ..InstData::new(Opcode::Fence) }, &[]);
8127
8128 let text = lower(&mut names, &source);
8129 assert_eq!(text.contains("x64.mfence"), order == MemOrder::SeqCst, "{order:?}: {text}");
8130 }
8131 }
8132
8133 /// A compare and exchange is written by name too, and at the width of the value rather than at
8134 /// the width of the address, which is the mistake worth pinning: everything here is a pointer
8135 /// and only the value says how many bytes the instruction touches.
8136 #[test]
8137 fn a_compare_and_exchange_is_one_instruction_at_the_width_of_the_value() {
8138 for bits in [8, 16, 32, 64] {
8139 let ty = Type::int(bits);
8140 let (mut names, mut source, block, args) = blank(&[Type::PTR, ty, ty]);
8141 let mut build = Builder::new(&mut source, block);
8142 let mem = build.func().add_mem(MemInfo {
8143 size: u64::from(bits / 8),
8144 align: bits / 8,
8145 order: MemOrder::SeqCst,
8146 ..plain()
8147 });
8148 let operands = build.func().push_values(&[args[0], args[1], args[2]]);
8149 build.inst(
8150 InstData {
8151 args: operands,
8152 extra: Extra::Mem(mem),
8153 ..InstData::new(Opcode::Cmpxchg)
8154 },
8155 &[ty, Type::I1],
8156 );
8157
8158 // Two values out of one instruction, the first of them in the register the machine
8159 // reads the expected value out of, the second free for the allocator to place. The
8160 // address is the memory operand and neither of the two values is.
8161 let text = lower(&mut names, &source);
8162 let written = format!("%3:gpr($rax), %4:gpr = x64.cmpxchg_{bits} %1($rax), %2, [%0]");
8163 assert!(text.contains(&written), "{bits}: {text}");
8164 }
8165 }
8166
8167 #[test]
8168 fn more_values_back_than_the_convention_has_registers_for_is_reported() {
8169 let i64 = Type::int(64);
8170 let (mut names, mut source, block, args) = blank(&[i64, i64, i64]);
8171 let mut build = Builder::new(&mut source, block);
8172 build.ret(&[args[0], args[1], args[2]]);
8173
8174 // Two integers come back in `rax` and `rdx` and a third has nowhere to go, which is not a
8175 // gap in the rules but the convention saying no. The front end classifies before it gets
8176 // here, so this is the shape that would mean the classification went wrong.
8177 let failed = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8178 .expect_err("only two come back");
8179 assert_eq!(
8180 failed.to_string(),
8181 "what this function gives back takes more registers than this convention has for it"
8182 );
8183
8184 let inst = failed.inst().expect("the instruction it is about");
8185 assert_eq!(source[inst].opcode, Opcode::Return);
8186 }
8187
8188 /// A refusal about a signature has no instruction, which is what makes it the one arm apart.
8189 ///
8190 /// Everything else is about something written somewhere in the body and hands it back so a
8191 /// caller can ask the function where it came from. A parameter arrives before the first
8192 /// instruction runs, so there is nothing in the body to point at and the message is about
8193 /// the function.
8194 #[test]
8195 fn a_refusal_about_a_parameter_has_no_instruction_to_point_at() {
8196 let missing = Unsupported::Argument { index: 0, missing: Missing::OnX87 };
8197 assert_eq!(missing.inst(), None);
8198 }
8199
8200 /// An `alloca` of a fixed size, which is what every local whose address is taken becomes.
8201 fn slot(source: &mut Func, block: Block, size: u64, align: u32) -> Value {
8202 let info = MemInfo { size, align, ..plain() };
8203 let mut build = Builder::new(source, block);
8204 let mem = build.func().add_mem(info);
8205 build.value(InstData { extra: Extra::Mem(mem), ..InstData::new(Opcode::Alloca) }, Type::PTR)
8206 }
8207
8208 #[test]
8209 fn a_local_is_memory_in_the_frame_and_one_instruction_that_says_where() {
8210 let (mut names, mut source, block, _) = blank(&[]);
8211 let slot = slot(&mut source, block, 4, 4);
8212 let mut build = Builder::new(&mut source, block);
8213 let nine = build.iconst(Type::int(32), 9);
8214 build.store(nine, slot, plain(), Flags::default());
8215 let loaded = build.load(Type::int(32), slot, plain(), Flags::default());
8216 build.ret(&[loaded]);
8217
8218 let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8219 .expect("every instruction has a rule");
8220
8221 // Four bytes on the list the frame is laid out from, and the one instruction that reads
8222 // where they went. Its displacement is nothing here because there is no frame yet, and
8223 // which instruction is waiting for which local is what `finish` is handed.
8224 assert_eq!(lowered.stack.locals, vec![Local { size: 4, align: 4 }]);
8225 assert_eq!(lowered.stack.addresses.len(), 1);
8226 assert_eq!(lowered.stack.addresses[0].1, 0);
8227 assert_eq!(
8228 mir::print_func(&lowered.func, &names, ®S),
8229 "mfunc @f {\nblock0:\n %0:gpr = x64.lea_64 [$rsp]\n \
8230 %1:gpr = x64.mov_ri_32 9\n x64.mov_mr_32 %1, [%0]\n \
8231 %2:gpr = x64.mov_rm_32 [%0]\n x64.ret_val_32 %2($rax)\n}\n"
8232 );
8233 }
8234
8235 #[test]
8236 fn a_local_the_program_declared_says_which_declaration_it_is_and_the_rest_say_nothing() {
8237 let (mut names, mut source, block, _) = blank(&[]);
8238 let scratch = slot(&mut source, block, 4, 4);
8239 let mut build = Builder::new(&mut source, block);
8240 let mem = build.func().add_mem(MemInfo { size: 8, align: 8, ..plain() });
8241 let declared = build
8242 .value(InstData { extra: Extra::Mem(mem), ..InstData::new(Opcode::Alloca) }, Type::PTR);
8243 build.func().declare_mem(mem, 41);
8244 build.store(scratch, declared, MemInfo { size: 8, align: 8, ..plain() }, Flags::default());
8245 build.ret(&[]);
8246
8247 let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8248 .expect("every instruction has a rule");
8249
8250 // Two locals and one declaration, held against the order the allocas were lowered in,
8251 // which is the only name a local has by the time the frame places it. The scratch one was
8252 // reached first and is local zero, so the declared one is local one.
8253 assert_eq!(lowered.stack.locals.len(), 2);
8254 assert_eq!(lowered.stack.declared, vec![(1, 41)]);
8255 }
8256
8257 /// A local the program kept in a value comes out saying which register holds it.
8258 ///
8259 /// The other half of the local above, which had a slot. This one has none, so what carries the
8260 /// declaration is the register the instruction computing it writes into.
8261 #[test]
8262 fn a_local_the_program_kept_in_a_value_says_which_register_holds_it() {
8263 let (mut names, mut source, block, _) = blank(&[]);
8264 let mut build = Builder::new(&mut source, block);
8265 let nine = build.iconst(Type::int(32), 9);
8266 let ten = build.iconst(Type::int(32), 10);
8267 let sum = build.binary(Opcode::Add, nine, ten, Flags::default());
8268 build.func().declare_value(sum, 41);
8269 build.ret(&[sum]);
8270
8271 let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8272 .expect("every instruction has a rule");
8273
8274 // One pair and not three. The constants are values the program never declared, and a
8275 // register holding one of those is nobody's. The register is the one the addition writes,
8276 // which the listing under it is what pins down.
8277 assert_eq!(lowered.func.named, vec![(41, mir::Reg::virtual_reg(1))]);
8278 assert_eq!(
8279 mir::print_func(&lowered.func, &names, ®S),
8280 "mfunc @f {\nblock0:\n %0:gpr = x64.mov_ri_32 9\n \
8281 %1:gpr(reuse 1) = x64.add_ri_32 %0, 10\n x64.ret_val_32 %1($rax)\n}\n"
8282 );
8283 }
8284
8285 /// A local held in a constant two blocks want is two registers and both of them are it.
8286 ///
8287 /// Why the declaration is written down as each register is handed out rather than once at the
8288 /// end over the map from values to registers. That map remembers the last register a value was
8289 /// written into, and a constant is written again in every block that wants one, so a local held
8290 /// in one would come out findable in the last block of the function and nowhere else.
8291 #[test]
8292 fn a_local_held_in_a_constant_two_blocks_want_is_named_in_both_of_them() {
8293 let i32 = Type::int(32);
8294 let (mut names, mut source, entry, args) = blank(&[i32, i32]);
8295 let then = source.create_block();
8296 let other = source.create_block();
8297 let join = source.create_block();
8298 let got = source.append_param(join, i32);
8299
8300 let mut build = Builder::new(&mut source, entry);
8301 let seven = build.iconst(i32, 7);
8302 let cond = build.icmp(rucc_ir::IntPred::Slt, args[0], args[1]);
8303 build.func().declare_value(seven, 41);
8304 build.br_if(cond, then, &[], other, &[]);
8305 Builder::new(&mut source, then).jump(join, &[seven]);
8306 Builder::new(&mut source, other).jump(join, &[seven]);
8307 Builder::new(&mut source, join).ret(&[got]);
8308
8309 let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8310 .expect("every instruction has a rule");
8311
8312 let held = &lowered.func.named;
8313 assert_eq!(held.len(), 2, "one register per block that wanted the seven: {held:?}");
8314 assert!(held.iter().all(|&(decl, _)| decl == 41), "{held:?}");
8315 assert_ne!(held[0].1, held[1].1, "the same register in two blocks: {held:?}");
8316 }
8317
8318 /// A parameter the program declared comes out named too, in the register it arrived in.
8319 ///
8320 /// The case the walk over the map at the end is for. A parameter is put in a register the
8321 /// convention chose rather than in a fresh one, so nothing asks the mint for it and the pair
8322 /// would otherwise never be written down.
8323 #[test]
8324 fn a_parameter_the_program_declared_says_which_register_it_arrived_in() {
8325 let i32 = Type::int(32);
8326 let (mut names, mut source, block, args) = blank(&[i32]);
8327 let mut build = Builder::new(&mut source, block);
8328 build.func().declare_value(args[0], 41);
8329 build.ret(&[args[0]]);
8330
8331 let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8332 .expect("every instruction has a rule");
8333
8334 let held = &lowered.func.named;
8335 assert_eq!(held.len(), 1, "one pair for the one parameter: {held:?}");
8336 assert_eq!(held[0].0, 41);
8337 }
8338
8339 /// A function with nothing declared in it says nothing, which is every function compiled
8340 /// without debugging information asked for.
8341 #[test]
8342 fn a_function_the_front_end_named_nothing_in_names_no_registers() {
8343 let (mut names, mut source, block, _) = blank(&[]);
8344 let mut build = Builder::new(&mut source, block);
8345 let nine = build.iconst(Type::int(32), 9);
8346 build.ret(&[nine]);
8347
8348 let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8349 .expect("every instruction has a rule");
8350 assert!(lowered.func.named.is_empty(), "{:?}", lowered.func.named);
8351 }
8352
8353 #[test]
8354 fn the_frame_is_what_fills_the_address_of_a_local_in() {
8355 let (mut names, mut source, block, _) = blank(&[]);
8356 let slot = slot(&mut source, block, 4, 4);
8357 let mut build = Builder::new(&mut source, block);
8358 let nine = build.iconst(Type::int(32), 9);
8359 build.store(nine, slot, plain(), Flags::default());
8360 let loaded = build.load(Type::int(32), slot, plain(), Flags::default());
8361 build.ret(&[loaded]);
8362
8363 let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8364 .expect("every instruction has a rule");
8365 let stack = lowered.stack;
8366 let mut out = lowered.func;
8367 let env = env();
8368 let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
8369 let layout = stack.layout(Layout::new(&SYSV, REGS));
8370 let frame = Frame::of(&out, &allocation, &layout);
8371 finish(&mut out, &allocation, &frame, &stack, Convention::new(&SYSV, &FRAME), &mut names);
8372
8373 // `int f(void) { int x; x = 9; return x; }` with the address of `x` taken, end to end.
8374 // A leaf small enough to live in the red zone takes no frame at all, so the stack pointer
8375 // never moves and the four bytes are below it, which is what the negative offset is. The
8376 // instruction the lowering left with nothing in its displacement now has the answer in it.
8377 let text = mir::print_func(&out, &names, ®S);
8378 assert!(text.contains("$rax = x64.lea_64 [$rsp - 8]"), "{text}");
8379 assert!(!text.contains("x64.sub_ri_64"), "{text}");
8380 assert_eq!(frame.size(), 0);
8381 assert_eq!(frame.local(0), Some(-8));
8382 }
8383
8384 /// An `alloca` whose size is an operand, which is a variable length array.
8385 fn growing(source: &mut Func, block: Block, size: Value, align: u32) -> Value {
8386 let info = MemInfo { size: 0, align, ..plain() };
8387 let mut build = Builder::new(source, block);
8388 let mem = build.func().add_mem(info);
8389 let args = build.func().push_values(&[size]);
8390 build.value(
8391 InstData { args, extra: Extra::Mem(mem), ..InstData::new(Opcode::Alloca) },
8392 Type::PTR,
8393 )
8394 }
8395
8396 #[test]
8397 fn a_stack_slot_whose_size_is_not_known_until_it_runs_takes_the_bytes_off_the_stack_pointer() {
8398 let (mut names, mut source, block, args) = blank(&[Type::int(64)]);
8399 let slot = growing(&mut source, block, args[0], 16);
8400 Builder::new(&mut source, block).ret(&[slot]);
8401
8402 let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8403 .expect("every instruction has a rule");
8404
8405 // The bytes come off the stack pointer where the declaration stands and the address is
8406 // where the stack pointer then is, which is one subtraction and one `lea` rather than a
8407 // slot the frame laid out. Nothing is on the list of locals, because there is nothing
8408 // about this the frame could place.
8409 let text = mir::print_func(&lowered.func, &names, ®S);
8410 assert!(text.contains("$rsp = x64.sub_rr_64 $rsp, %0"), "{text}");
8411 assert!(text.contains("x64.lea_64 [$rsp]"), "{text}");
8412 assert!(lowered.stack.locals.is_empty(), "{text}");
8413 assert_eq!(lowered.stack.dynamic.len(), 1);
8414 assert!(lowered.stack.grown_at.is_some());
8415 }
8416
8417 #[test]
8418 fn a_growing_slot_wanting_more_alignment_than_the_stack_pointer_has_is_reported() {
8419 let (mut names, mut source, block, args) = blank(&[Type::int(64)]);
8420 let slot = growing(&mut source, block, args[0], 32);
8421 Builder::new(&mut source, block).ret(&[slot]);
8422
8423 // Thirty two is more than a call leaves the stack pointer on, so giving it what it asked
8424 // for means masking the stack pointer after moving it, and after that no constant reaches
8425 // the rest of the frame from the frame pointer either. A second pointer held for the
8426 // purpose is what fixes it and there is not one yet.
8427 let failed = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8428 .expect_err("nothing realigns a frame that grows");
8429 assert_eq!(
8430 failed.to_string(),
8431 "this local wants more alignment than the stack pointer is left on, which needs a \
8432 base register nothing here keeps"
8433 );
8434 }
8435
8436 #[test]
8437 fn a_frame_that_grows_reaches_its_own_locals_through_the_frame_pointer() {
8438 let (mut names, mut source, block, args) = blank(&[Type::int(64)]);
8439 let fixed = slot(&mut source, block, 4, 4);
8440 let mut build = Builder::new(&mut source, block);
8441 let nine = build.iconst(Type::int(32), 9);
8442 build.store(nine, fixed, plain(), Flags::default());
8443 let grown = growing(&mut source, block, args[0], 16);
8444 Builder::new(&mut source, block).ret(&[grown]);
8445
8446 let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8447 .expect("every instruction has a rule");
8448 let stack = lowered.stack;
8449 let mut out = lowered.func;
8450 let env = env();
8451 let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
8452 let layout = stack.layout(Layout::new(&SYSV, REGS));
8453 let frame = Frame::of(&out, &allocation, &layout);
8454 finish(&mut out, &allocation, &frame, &stack, Convention::new(&SYSV, &FRAME), &mut names);
8455
8456 // The stack pointer moves in the middle of the function, so the four bytes of the fixed
8457 // local are not a constant away from it any more and the frame pointer is what reaches
8458 // them. The frame keeps one whatever the flags asked for, takes its bytes rather than
8459 // living in the red zone, and the address of the growing slot is off the stack pointer as
8460 // it stands after the subtraction rather than off anything the prologue left.
8461 let text = mir::print_func(&out, &names, ®S);
8462 assert!(frame.grows());
8463 assert!(frame.frame_pointer());
8464 assert!(frame.size() > 0, "{text}");
8465 assert!(text.contains("x64.lea_64 [$rbp"), "{text}");
8466 assert!(text.contains("$rsp = x64.sub_rr_64 $rsp"), "{text}");
8467 assert!(text.contains("x64.lea_64 [$rsp]"), "{text}");
8468 }
8469
8470 #[test]
8471 fn an_address_is_read_written_and_added_to_like_the_integer_it_is() {
8472 let (mut names, mut source, block, args) = blank(&[Type::PTR, Type::int(64)]);
8473 let mut build = Builder::new(&mut source, block);
8474 let stepped = build.func().push_values(&[args[0], args[1]]);
8475 let next =
8476 build.value(InstData { args: stepped, ..InstData::new(Opcode::PtrAdd) }, Type::PTR);
8477 let loaded = build.load(Type::int(32), next, plain(), Flags::default());
8478 build.ret(&[loaded]);
8479
8480 // `int f(int *p, long i) { return *(int *)((char *)p + i); }`. Nothing about this is new
8481 // in the rule set, which is the point: the two addresses arrive in registers because an
8482 // address is an integer as wide as one, and the arithmetic on them is the add it always
8483 // was, so every rule written about an add reaches it.
8484 //
8485 // The add stays its own instruction here rather than folding into the address the load
8486 // reads from. Two registers with no scale on either is the one addressing mode the rules
8487 // have no load through, because the folds that exist are the displacement one and the
8488 // scaled ones, and this is neither. `crate::fold` is what puts the two together, after
8489 // selection, and this is the pair it is handed.
8490 assert_eq!(
8491 lower(&mut names, &source),
8492 "mfunc @f {\nblock0:\n %0:gpr($rdi) = x64.arg_val_64\n \
8493 %1:gpr($rsi) = x64.arg_val_64\n %2:gpr(reuse 1) = x64.add_rr_64 %0, %1\n \
8494 %3:gpr = x64.mov_rm_32 [%2]\n x64.ret_val_32 %3($rax)\n}\n"
8495 );
8496 }
8497
8498 /// The address of a file scope name, which is what every use of a global and every string
8499 /// literal starts from.
8500 fn address_of(source: &mut Func, block: Block, names: &mut Interner, name: &str) -> Value {
8501 let symbol = names.intern(name);
8502 let mut build = Builder::new(source, block);
8503 build.value(
8504 InstData { extra: Extra::Symbol(symbol), ..InstData::new(Opcode::GlobalAddr) },
8505 Type::PTR,
8506 )
8507 }
8508
8509 #[test]
8510 fn the_address_of_a_name_is_one_instruction_carrying_the_name() {
8511 let (mut names, mut source, block, _) = blank(&[]);
8512 let counter = address_of(&mut source, block, &mut names, "counter");
8513 let mut build = Builder::new(&mut source, block);
8514 let loaded = build.load(Type::int(32), counter, plain(), Flags::default());
8515 build.ret(&[loaded]);
8516
8517 // `extern int counter; int f(void) { return counter; }`. The address is an addressing mode
8518 // that names no register and carries the symbol, which is what the assembler writes
8519 // relative to `%rip` and what the object writer leaves a relocation for.
8520 assert_eq!(
8521 lower(&mut names, &source),
8522 "mfunc @f {\nblock0:\n %0:gpr = x64.lea_64 [@counter]\n \
8523 %1:gpr = x64.mov_rm_32 [%0]\n x64.ret_val_32 %1($rax)\n}\n"
8524 );
8525 }
8526
8527 #[test]
8528 fn the_address_of_a_name_outside_the_file_is_read_out_of_the_offset_table() {
8529 let (mut names, mut source, block, _) = blank(&[]);
8530 let away = address_of(&mut source, block, &mut names, "away");
8531 Builder::new(&mut source, block).ret(&[away]);
8532 let elsewhere: Elsewhere = [names.intern("away")].into_iter().collect();
8533
8534 // `extern void away(void); void *f(void) { return away; }`. A load and not an address
8535 // computation, because the distance from here to a name a shared library may be the one
8536 // that defines is not a number any link can work out, and the slot the linker fills in is
8537 // in this program and so is a distance it has.
8538 let out = func(&source, &mut names, &SELECTOR, &SYSV, &elsewhere)
8539 .expect("every instruction has a rule");
8540 assert_eq!(
8541 mir::print_func(&out.func, &names, ®S),
8542 "mfunc @f {\nblock0:\n %0:gpr = x64.mov_rm_64 [got @away]\n \
8543 x64.ret_val_64 %0($rax)\n}\n"
8544 );
8545 }
8546
8547 #[test]
8548 fn the_address_of_a_thread_local_is_an_offset_out_of_the_table_plus_where_this_thread_starts() {
8549 let (mut names, mut source, block, _) = blank(&[]);
8550 let own = address_of(&mut source, block, &mut names, "own");
8551 Builder::new(&mut source, block).ret(&[own]);
8552 let elsewhere = Elsewhere::default().with_threads([names.intern("own")]);
8553
8554 // `extern _Thread_local int own; void *f(void) { return &own; }`. Three instructions where
8555 // the two cases above are one, because there is no address to load or to work out: the
8556 // slot holds how far into a thread's block the variable sits, `%fs:0` is where this
8557 // thread's block starts, and the sum of the two is this thread's copy.
8558 let out = func(&source, &mut names, &SELECTOR, &SYSV, &elsewhere)
8559 .expect("every instruction has a rule");
8560 assert_eq!(
8561 mir::print_func(&out.func, &names, ®S),
8562 "mfunc @f {\nblock0:\n %0:gpr = x64.mov_rm_64 [thread @own]\n \
8563 %1:gpr = x64.mov_rm_64 [fs:0]\n %2:gpr(reuse 1) = x64.add_rr_64 %0, %1\n \
8564 x64.ret_val_64 %2($rax)\n}\n"
8565 );
8566 }
8567
8568 /// The same load with nothing added to it, which is the whole of `__builtin_thread_pointer`.
8569 #[test]
8570 fn the_start_of_this_thread_s_own_storage_is_the_one_load_and_no_arithmetic() {
8571 let (mut names, mut source, block, _) = blank(&[]);
8572 let here =
8573 Builder::new(&mut source, block).value(InstData::new(Opcode::ThreadPointer), Type::PTR);
8574 Builder::new(&mut source, block).ret(&[here]);
8575
8576 let out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8577 .expect("every instruction has a rule");
8578 assert_eq!(
8579 mir::print_func(&out.func, &names, ®S),
8580 "mfunc @f {\nblock0:\n %0:gpr = x64.mov_rm_64 [fs:0]\n \
8581 x64.ret_val_64 %0($rax)\n}\n"
8582 );
8583 }
8584
8585 /// One `asm` statement, with its template and its constraint list written as a program does.
8586 fn assembly(
8587 source: &mut Func,
8588 block: Block,
8589 names: &mut Interner,
8590 template: &str,
8591 constraints: &str,
8592 args: &[Value],
8593 results: &[Type],
8594 ) -> Inst {
8595 clobbering(source, block, names, template, constraints, "memory", args, results)
8596 }
8597
8598 /// The same with a clobber list of its own, for the statements that are about one.
8599 #[allow(clippy::too_many_arguments)]
8600 fn clobbering(
8601 source: &mut Func,
8602 block: Block,
8603 names: &mut Interner,
8604 template: &str,
8605 constraints: &str,
8606 clobbers: &str,
8607 args: &[Value],
8608 results: &[Type],
8609 ) -> Inst {
8610 let info = AsmInfo {
8611 template: names.intern(template),
8612 constraints: names.intern(constraints),
8613 clobbers: names.intern(clobbers),
8614 targets: rucc_ir::BlockCallList::EMPTY,
8615 };
8616 Builder::new(source, block).inline_asm(info, args, results, Flags::VOLATILE)
8617 }
8618
8619 /// What a program asking the processor what it can do writes, which is the instruction whose
8620 /// every operand is a register its text does not name.
8621 #[test]
8622 fn a_template_whose_registers_are_named_by_the_constraints_places_them_from_the_letters() {
8623 let u32 = Type::int(32);
8624 let (mut names, mut source, block, _) = blank(&[]);
8625 let zero = Builder::new(&mut source, block).iconst(u32, 0);
8626 let out = clobbering(
8627 &mut source,
8628 block,
8629 &mut names,
8630 "cpuid",
8631 "=a,a",
8632 "ebx,ecx,edx",
8633 &[zero],
8634 &[u32],
8635 );
8636 let produced = source[out].results().next().expect("one result");
8637 Builder::new(&mut source, block).ret(&[produced]);
8638
8639 // `asm ("cpuid" : "=a" (n) : "a" (0) : "ebx", "ecx", "edx")`, which is the first thing
8640 // every program that has a faster path on some machines writes. Four registers written and
8641 // two read, none of them in the template, all of them out of the description, and the two
8642 // that the letters named are the statement's own. The subleaf is a zero because the
8643 // instruction reads `ecx` and the program said nothing about what is in it. The three
8644 // clobbers are gone because `cpuid` writes those three anyway, and saying it twice is one
8645 // register with two definitions.
8646 assert_eq!(
8647 lower(&mut names, &source),
8648 "mfunc @f {\nblock0:\n %0:gpr = x64.mov_ri_32 0\n \
8649 %1:gpr = x64.mov_ri_64 0\n \
8650 %2:gpr($rax), %3:gpr($rbx), %4:gpr($rcx), %5:gpr($rdx) = x64.cpuid %0($rax), \
8651 %1($rcx)\n x64.ret_val_32 %2($rax)\n}\n"
8652 );
8653 }
8654
8655 /// An operand the program pinned, by declaring the object it comes from `register long x asm
8656 /// ("r12")`. The letter on its own leaves the allocator to pick, and a template that reads the
8657 /// register by name needs the two to be the same register, so the brace is what ties them
8658 /// together. That is the one use of a local register variable the GNU manual calls reliable,
8659 /// and it is what tcc's `tests/tcctest.c` counts on.
8660 #[test]
8661 fn an_operand_the_program_pinned_is_placed_in_the_register_it_named() {
8662 let u64 = Type::int(64);
8663 let (mut names, mut source, block, _) = blank(&[]);
8664 let out =
8665 assembly(&mut source, block, &mut names, "mov $0x4542, %r12", "=r{r12}", &[], &[u64]);
8666 let produced = source[out].results().next().expect("one result");
8667 Builder::new(&mut source, block).ret(&[produced]);
8668
8669 // The template is one instruction the table already has, so it lowers to that instruction
8670 // rather than to text nobody read, and the register it names is the statement's own output
8671 // because the brace put the output there. Without the brace the letter would have let the
8672 // allocator pick, the two `%r12` would have been different registers, and the program would
8673 // have come back with whatever was in the one it picked.
8674 assert_eq!(
8675 lower(&mut names, &source),
8676 "mfunc @f {\nblock0:\n %0:gpr($r12) = x64.mov_ri_64 17730\n \
8677 x64.ret_val_64 %0($rax)\n}\n"
8678 );
8679 }
8680
8681 /// A clobber the instruction does not write itself, which is the case the list is there for.
8682 /// It goes on as a definition of the register, in among the other definitions, because that is
8683 /// the whole of how a machine function says a register is not worth anything after this.
8684 #[test]
8685 fn a_clobber_the_instruction_does_not_write_itself_is_a_definition_of_that_register() {
8686 let (mut names, mut source, block, _) = blank(&[]);
8687 clobbering(&mut source, block, &mut names, "pause", "", "rsi,cc,memory", &[], &[]);
8688 Builder::new(&mut source, block).ret(&[]);
8689
8690 assert_eq!(lower(&mut names, &source), "mfunc @f {\nblock0:\n $rsi = x64.pause\n}\n");
8691 }
8692
8693 /// A clobber naming something this has no register for. Refused rather than dropped, since the
8694 /// list is the program saying which registers it may not leave anything in, and an entry
8695 /// nobody read is a register something may still be left in.
8696 #[test]
8697 fn a_clobber_this_has_no_register_for_is_refused() {
8698 let (mut names, mut source, block, _) = blank(&[]);
8699 clobbering(&mut source, block, &mut names, "pause", "", "zmm0", &[], &[]);
8700 Builder::new(&mut source, block).ret(&[]);
8701
8702 let failed = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8703 .expect_err("there is no such register here");
8704 assert_eq!(
8705 failed.to_string(),
8706 "this `asm` says it destroys a register this has no name for"
8707 );
8708 }
8709
8710 #[test]
8711 fn an_asm_with_an_empty_template_and_no_operands_is_no_instructions() {
8712 let (mut names, mut source, block, _) = blank(&[]);
8713 assembly(&mut source, block, &mut names, "", "", &[], &[]);
8714 Builder::new(&mut source, block).ret(&[]);
8715
8716 // `asm volatile ("" : : : "memory")`, which is a barrier and nothing else. The barrier was
8717 // spent on the optimizer, which has finished by now, so what is left is nothing.
8718 assert_eq!(lower(&mut names, &source), "mfunc @f {\nblock0:\n}\n");
8719 }
8720
8721 #[test]
8722 fn an_output_an_input_is_tied_to_is_the_register_that_input_arrived_in() {
8723 let i32 = Type::int(32);
8724 let (mut names, mut source, block, args) = blank(&[i32]);
8725 let out = assembly(&mut source, block, &mut names, "", "=r,0", &args, &[i32]);
8726 let produced = source[out].results().next().expect("one result");
8727 Builder::new(&mut source, block).ret(&[produced]);
8728
8729 // `asm ("" : "=r" (x) : "0" (x))`, which is how a program stops the optimizer following a
8730 // value without changing it. The two share a place and the template writes nothing over
8731 // it, so the value comes back out of the register it went in.
8732 assert_eq!(
8733 lower(&mut names, &source),
8734 "mfunc @f {\nblock0:\n %0:gpr($rdi) = x64.arg_val_32\n \
8735 x64.ret_val_32 %0($rax)\n}\n"
8736 );
8737 }
8738
8739 #[test]
8740 fn an_output_written_plus_is_the_same_rename() {
8741 let i32 = Type::int(32);
8742 let (mut names, mut source, block, args) = blank(&[i32]);
8743 let out = assembly(&mut source, block, &mut names, "", "+r", &args, &[i32]);
8744 let produced = source[out].results().next().expect("one result");
8745 Builder::new(&mut source, block).ret(&[produced]);
8746
8747 // `asm ("" : "+r" (x))`, which says the same thing in one operand instead of two.
8748 assert_eq!(
8749 lower(&mut names, &source),
8750 "mfunc @f {\nblock0:\n %0:gpr($rdi) = x64.arg_val_32\n \
8751 x64.ret_val_32 %0($rax)\n}\n"
8752 );
8753 }
8754
8755 #[test]
8756 fn an_output_nothing_is_tied_to_is_a_zero() {
8757 let i32 = Type::int(32);
8758 let (mut names, mut source, block, _) = blank(&[]);
8759 let out = assembly(&mut source, block, &mut names, "", "=r", &[], &[i32]);
8760 let produced = source[out].results().next().expect("one result");
8761 Builder::new(&mut source, block).ret(&[produced]);
8762
8763 // `asm ("" : "=r" (y))`, whose answer is whatever the assembly left in the register, and
8764 // an empty template leaves nothing. A definite value rather than a register nothing wrote,
8765 // because the allocator is owed a definition before the use however little the program is.
8766 assert_eq!(
8767 lower(&mut names, &source),
8768 "mfunc @f {\nblock0:\n %0:gpr = x64.mov_ri_32 0\n x64.ret_val_32 %0($rax)\n}\n"
8769 );
8770 }
8771
8772 #[test]
8773 fn a_template_that_is_one_instruction_becomes_that_instruction() {
8774 let (mut names, mut source, block, _) = blank(&[]);
8775 assembly(&mut source, block, &mut names, "pause", "", &[], &[]);
8776 Builder::new(&mut source, block).ret(&[]);
8777
8778 // `asm volatile ("pause")`, which is what every spin lock in every allocator writes. One
8779 // instruction, no operands, and nothing between the template and the machine but the table
8780 // that already says what a `pause` is.
8781 assert_eq!(lower(&mut names, &source), "mfunc @f {\nblock0:\n x64.pause\n}\n");
8782 }
8783
8784 #[test]
8785 fn a_template_that_reads_a_segment_becomes_the_load_it_already_was() {
8786 let i64 = Type::int(64);
8787 let (mut names, mut source, block, _) = blank(&[]);
8788 let out = assembly(&mut source, block, &mut names, "movq %%fs:0, %0", "=r", &[], &[i64]);
8789 let produced = source[out].results().next().expect("one result");
8790 Builder::new(&mut source, block).ret(&[produced]);
8791
8792 // `asm ("movq %%fs:0, %0" : "=r" (tid))`, which is how a program finds the block its own
8793 // thread owns. The same instruction `crate::lower` already writes for a thread-local
8794 // variable, reached this time because a program wrote it out by hand.
8795 assert_eq!(
8796 lower(&mut names, &source),
8797 "mfunc @f {\nblock0:\n %0:gpr = x64.mov_rm_64 [fs:0]\n \
8798 x64.ret_val_64 %0($rax)\n}\n"
8799 );
8800 }
8801
8802 /// A template this cannot read is kept as its text, which is what gcc does with every template.
8803 /// Whether the text is an instruction is the assembler's question, asked when the unit is
8804 /// assembled from its listing.
8805 #[test]
8806 fn a_template_naming_an_instruction_this_machine_has_not_got_is_kept_as_text() {
8807 let (mut names, mut source, block, _) = blank(&[]);
8808 assembly(&mut source, block, &mut names, "hcf", "", &[], &[]);
8809 Builder::new(&mut source, block).ret(&[]);
8810
8811 let printed = lower(&mut names, &source);
8812 assert!(printed.contains("x64.template"), "{printed}");
8813 assert!(printed.contains("@hcf"), "{printed}");
8814 }
8815
8816 /// A template kept as text with an operand in a register reads the operand, and its text holds
8817 /// a hole naming that operand of the instruction, which the writer fills with the register the
8818 /// allocator chose. The input is the instruction's only use, behind every register a call may
8819 /// write.
8820 #[test]
8821 fn a_template_kept_as_text_reads_an_operand_in_a_register_through_a_hole() {
8822 let i32 = Type::int(32);
8823 let (mut names, mut source, block, args) = blank(&[i32]);
8824 assembly(&mut source, block, &mut names, "hcf %0", "r", &[args[0]], &[]);
8825 Builder::new(&mut source, block).ret(&[]);
8826
8827 let printed = lower(&mut names, &source);
8828 let line = printed.lines().find(|line| line.contains("x64.template")).unwrap_or_default();
8829 // Twenty five registers are written ahead of it, so the operand read is the twenty sixth,
8830 // spelled at the width of an `int`.
8831 assert!(line.contains("x64.template %0, @hcf \u{1}r25k\u{2}"), "{printed}");
8832 assert!(line.contains("early $rax"), "{printed}");
8833 }
8834
8835 /// A template kept as text with more outputs than the convention keeps registers across a call
8836 /// gets back as many of the registers a call may write as it needs, from the end of the order,
8837 /// and keeps the rest. Six outputs against five preserved registers is one handed back, which is
8838 /// `r9`. `r11` and `r10` come back ahead of it without counting, since they are the allocator's
8839 /// scratch and no operand is given one, but an output it spills is carried in one of them, which
8840 /// it cannot be while the template claims it. The shape is `sodium_sub` in libsodium, whose
8841 /// `sbbq` into memory the reader has no form for, and before this the allocator ran out of
8842 /// registers on it.
8843 #[test]
8844 fn a_template_kept_as_text_with_more_outputs_than_are_kept_gets_registers_back() {
8845 let i64 = Type::int(64);
8846 let (mut names, mut source, block, _) = blank(&[]);
8847 let outputs = [i64; 6];
8848 let asm = assembly(
8849 &mut source,
8850 block,
8851 &mut names,
8852 "hcf %0, %1, %2, %3, %4, %5",
8853 "=&r,=&r,=&r,=&r,=&r,=&r",
8854 &[],
8855 &outputs,
8856 );
8857 let produced: Vec<Value> = source[asm].results().collect();
8858 Builder::new(&mut source, block).ret(&produced[..1]);
8859
8860 let printed = lower(&mut names, &source);
8861 let line = printed.lines().find(|line| line.contains("x64.template")).unwrap_or_default();
8862 assert!(line.contains("early $r8"), "{printed}");
8863 for reg in ["r9", "r10", "r11"] {
8864 assert!(!line.contains(&format!("early ${reg}")), "{printed}");
8865 }
8866 }
8867
8868 /// A register the template named is placed as itself, fixed to the register the program wrote
8869 /// down. A register a constraint letter names is a different thing and is placed too, which the
8870 /// test above is about: there the statement said which of its own operands is in the register,
8871 /// and a name in the middle of a template says the register and nothing about any operand.
8872 #[test]
8873 fn a_template_naming_a_register_gets_that_register() {
8874 let i64 = Type::int(64);
8875 let (mut names, mut source, block, _) = blank(&[]);
8876 let out = assembly(&mut source, block, &mut names, "movq %%rax, %0", "=r", &[], &[i64]);
8877 let produced = source[out].results().next().expect("one result");
8878 Builder::new(&mut source, block).ret(&[produced]);
8879
8880 // `asm ("movq %%rax, %0" : "=r" (x))`, which is a program reading whatever is in `%rax`.
8881 // The source is the register itself and the destination is one the allocator picks.
8882 assert_eq!(
8883 lower(&mut names, &source),
8884 "mfunc @f {\nblock0:\n %0:gpr = x64.mov_rr_64 $rax($rax)\n \
8885 x64.ret_val_64 %0($rax)\n}\n"
8886 );
8887 }
8888
8889 /// The half of the same thing every register saving template needs. micropython writes the
8890 /// callee-saved registers into a buffer one `movq %%r12, 48(%%rdi)` at a time, and both halves
8891 /// of that line are a register the template named: the one being stored and the one the address
8892 /// is counted from.
8893 #[test]
8894 fn a_template_counting_an_address_from_a_register_it_named_gets_that_register() {
8895 let (mut names, mut source, block, _) = blank(&[]);
8896 assembly(&mut source, block, &mut names, "movq %%r12, 48(%%rdi)", "", &[], &[]);
8897 Builder::new(&mut source, block).ret(&[]);
8898
8899 assert_eq!(
8900 lower(&mut names, &source),
8901 "mfunc @f {\nblock0:\n x64.mov_mr_64 $r12($r12), [$rdi + 48]\n}\n"
8902 );
8903 }
8904
8905 /// A local kept in a named register, which is the same register named as itself and reached
8906 /// from the other side. micropython's collector writes six of these and reads them with
8907 /// ordinary C rather than with a template.
8908 #[test]
8909 fn a_local_kept_in_a_named_register_is_one_move_out_of_it() {
8910 let (mut names, mut source, block, _) = blank(&[]);
8911 let held = names.intern("rbx");
8912 let value = Builder::new(&mut source, block).value(
8913 InstData { extra: Extra::Symbol(held), ..InstData::new(Opcode::RegisterValue) },
8914 Type::int(64),
8915 );
8916 Builder::new(&mut source, block).ret(&[value]);
8917
8918 assert_eq!(
8919 lower(&mut names, &source),
8920 "mfunc @f {\nblock0:\n %0:gpr = x64.mov_rr_64 $rbx($rbx)\n \
8921 x64.ret_val_64 %0($rax)\n}\n"
8922 );
8923 }
8924
8925 /// The sigil gcc allows in front of the name is syntax and comes off, and a name that is not
8926 /// a register of this machine is refused in words that say which name it was.
8927 #[test]
8928 fn a_register_name_is_read_with_or_without_its_sigil_and_refused_when_there_is_no_such_one() {
8929 for written in ["%r12", "r12"] {
8930 let (mut names, mut source, block, _) = blank(&[]);
8931 let held = names.intern(written);
8932 let value = Builder::new(&mut source, block).value(
8933 InstData { extra: Extra::Symbol(held), ..InstData::new(Opcode::RegisterValue) },
8934 Type::int(64),
8935 );
8936 Builder::new(&mut source, block).ret(&[value]);
8937 assert!(lower(&mut names, &source).contains("$r12($r12)"), "{written} is not read");
8938 }
8939
8940 let (mut names, mut source, block, _) = blank(&[]);
8941 let held = names.intern("nowhere");
8942 let value = Builder::new(&mut source, block).value(
8943 InstData { extra: Extra::Symbol(held), ..InstData::new(Opcode::RegisterValue) },
8944 Type::int(64),
8945 );
8946 Builder::new(&mut source, block).ret(&[value]);
8947
8948 let failed = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8949 .expect_err("there is no such register");
8950 assert_eq!(
8951 failed.to_string(),
8952 "this object is kept in `nowhere`, which is not a register this machine has"
8953 );
8954 }
8955
8956 #[test]
8957 fn a_constraint_list_that_does_not_describe_the_operands_is_refused() {
8958 let i32 = Type::int(32);
8959 let (mut names, mut source, block, args) = blank(&[i32]);
8960 assembly(&mut source, block, &mut names, "", "=r", &args, &[]);
8961 Builder::new(&mut source, block).ret(&[]);
8962
8963 // An output with no result to be, which is what the front end never writes and what a
8964 // hand written module can. Refused rather than placed by a guess.
8965 let failed = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8966 .expect_err("the list and the instruction disagree");
8967 assert_eq!(failed.to_string(), "this `asm` has an operand this cannot place");
8968 }
8969
8970 /// A cast between a pointer and an integer, at whatever width the result is asked for.
8971 fn cast(source: &mut Func, block: Block, opcode: Opcode, from: Value, to: Type) -> Value {
8972 let mut build = Builder::new(source, block);
8973 let args = build.func().push_values(&[from]);
8974 build.value(InstData { args, ..InstData::new(opcode) }, to)
8975 }
8976
8977 #[test]
8978 fn a_cast_between_a_pointer_and_an_integer_as_wide_is_no_instruction_at_all() {
8979 let (mut names, mut source, block, args) = blank(&[Type::PTR]);
8980 let number = cast(&mut source, block, Opcode::PtrToInt, args[0], Type::int(64));
8981 Builder::new(&mut source, block).ret(&[number]);
8982
8983 // `long f(void *p) { return (long)p; }`. An address on this machine is an integer as wide
8984 // as the machine addresses, so the cast changes what the type system calls the value and
8985 // changes nothing about the value, and the register holding it is the one that held it.
8986 assert_eq!(
8987 lower(&mut names, &source),
8988 "mfunc @f {\nblock0:\n %0:gpr($rdi) = x64.arg_val_64\n \
8989 x64.ret_val_64 %0($rax)\n}\n"
8990 );
8991 }
8992
8993 #[test]
8994 fn a_null_pointer_is_a_constant_that_reaches_a_register_before_anything_reads_it() {
8995 let (mut names, mut source, block, _) = blank(&[]);
8996 let mut build = Builder::new(&mut source, block);
8997 let zero = build.iconst(Type::int(64), 0);
8998 let null = cast(&mut source, block, Opcode::IntToPtr, zero, Type::PTR);
8999 Builder::new(&mut source, block).ret(&[null]);
9000
9001 // `void *f(void) { return 0; }`. The cast is nothing, and reading its operand is what
9002 // writes the zero down: a constant is materialized where it is wanted rather than where
9003 // the IR defined it, and without the read there would be no instruction at all.
9004 assert_eq!(
9005 lower(&mut names, &source),
9006 "mfunc @f {\nblock0:\n %0:gpr = x64.mov_ri_64 0\n x64.ret_val_64 %0($rax)\n}\n"
9007 );
9008 }
9009
9010 #[test]
9011 fn the_five_linkages_the_ir_has_narrow_to_the_three_an_object_file_can_say() {
9012 let readings = [
9013 (Linkage::External, mir::Binding::Global),
9014 (Linkage::Common, mir::Binding::Global),
9015 (Linkage::Internal, mir::Binding::Local),
9016 (Linkage::Weak, mir::Binding::Weak),
9017 (Linkage::LinkOnce, mir::Binding::Weak),
9018 ];
9019 for (linkage, wanted) in readings {
9020 let (mut names, mut source, block, _) = blank(&[]);
9021 source.linkage = linkage;
9022 Builder::new(&mut source, block).ret(&[]);
9023 let out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
9024 .expect("a return");
9025 // The narrowing is done here rather than where the object is written, because a
9026 // machine function is all the assembler and the writer are ever handed.
9027 assert_eq!(out.func.binding, wanted, "{linkage:?}");
9028 }
9029 }
9030
9031 /// The visibility makes the same trip and is not narrowed on the way, because ELF says all
9032 /// three of them.
9033 ///
9034 /// Here for the reason the linkage above is here. A machine function is the whole of what the
9035 /// assembler and the object writer are handed, so a fact about the symbol that does not get
9036 /// onto one is a fact that is gone by the time anything could write it down, and the way that
9037 /// shows up is a shared library exporting the wrong set of names with nothing said anywhere.
9038 #[test]
9039 fn the_visibility_survives_the_trip_from_the_ir_to_a_machine_function() {
9040 let readings = [
9041 (Visibility::Default, mir::Visibility::Default),
9042 (Visibility::Hidden, mir::Visibility::Hidden),
9043 (Visibility::Protected, mir::Visibility::Protected),
9044 ];
9045 for (visibility, wanted) in readings {
9046 let (mut names, mut source, block, _) = blank(&[]);
9047 source.visibility = visibility;
9048 Builder::new(&mut source, block).ret(&[]);
9049 let out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
9050 .expect("a return");
9051 assert_eq!(out.func.visibility, wanted, "{visibility:?}");
9052 }
9053 }
9054
9055 #[test]
9056 fn a_cast_between_a_pointer_and_a_narrower_integer_is_reported() {
9057 let (mut names, mut source, block, args) = blank(&[Type::PTR]);
9058 let number = cast(&mut source, block, Opcode::PtrToInt, args[0], Type::int(32));
9059 Builder::new(&mut source, block).ret(&[number]);
9060
9061 // The front end never writes one: it casts at the address width and truncates or extends
9062 // around it, so both of those are the rules they always were. IR from somewhere else that
9063 // does write one is refused rather than compiled to a move that keeps the high half.
9064 let failed = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
9065 .expect_err("no rule narrows an address");
9066 assert_eq!(failed.to_string(), "no rule lowers a `ptrtoint` producing a `i32`");
9067 }
9068
9069 /// The type this machine has no register for.
9070 fn long_double() -> Type {
9071 Type::float(rucc_ir::Float::F80)
9072 }
9073
9074 #[test]
9075 fn a_double_widened_and_narrowed_again_goes_out_through_the_frame_and_back() {
9076 let f64 = Type::float(rucc_ir::Float::F64);
9077 let (mut names, mut source, block, args) = blank(&[f64]);
9078 let wide = cast(&mut source, block, Opcode::FPExt, args[0], long_double());
9079 let back = cast(&mut source, block, Opcode::FPTrunc, wide, f64);
9080 Builder::new(&mut source, block).ret(&[back]);
9081
9082 // `double f(double d) { long double x = d; return x; }`. The x87 reads memory and nothing
9083 // else, so the value is written to the crossing slot, loaded at the format that widens it
9084 // and put in the slot the eighty bit value lives in. Coming back is the same three the
9085 // other way. Both slots are addressed by a `lea` with nothing in it yet, which is what
9086 // every address in a frame looks like here until `finish` has the numbers.
9087 assert_eq!(
9088 lower(&mut names, &source),
9089 "mfunc @f {\nblock0:\n \
9090 %0:xmm($xmm0) = x64.arg_val_f64\n \
9091 %1:gpr = x64.lea_64 [$rsp]\n \
9092 %2:gpr = x64.lea_64 [$rsp]\n \
9093 x64.movsd_mr %0, [%1]\n \
9094 x64.fld_l [%1]\n \
9095 x64.fstp_t [%2]\n \
9096 %3:gpr = x64.lea_64 [$rsp]\n \
9097 %4:gpr = x64.lea_64 [$rsp]\n \
9098 x64.fld_t [%3]\n \
9099 x64.fstp_l [%4]\n \
9100 %5:xmm = x64.movsd_rm [%4]\n \
9101 x64.ret_val_f64 %5($xmm0)\n}\n"
9102 );
9103 }
9104
9105 #[test]
9106 fn a_long_double_has_sixteen_bytes_of_its_own_and_keeps_them() {
9107 let f64 = Type::float(rucc_ir::Float::F64);
9108 let (mut names, mut source, block, args) = blank(&[f64]);
9109 let wide = cast(&mut source, block, Opcode::FPExt, args[0], long_double());
9110 let once = cast(&mut source, block, Opcode::FPTrunc, wide, f64);
9111 let twice = cast(&mut source, block, Opcode::FPTrunc, wide, f64);
9112 let mut build = Builder::new(&mut source, block);
9113 let sum = build.binary(Opcode::FAdd, once, twice, Flags::default());
9114 build.ret(&[sum]);
9115
9116 let out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
9117 .expect("every instruction is written");
9118
9119 // Two slots and not four: sixteen bytes for the one eighty bit value, which is what the
9120 // psABI says one takes and is aligned to, and eight for the crossing, which every group
9121 // in the function shares because nothing is ever left in it. The value's slot is its own
9122 // for the whole function, so reading it twice reads the same sixteen bytes.
9123 assert_eq!(
9124 out.stack.locals,
9125 vec![Local { size: 8, align: 8 }, Local { size: 16, align: 16 }]
9126 );
9127 }
9128
9129 #[test]
9130 fn an_integer_becomes_a_long_double_by_being_loaded_as_one() {
9131 let (mut names, mut source, block, args) = blank(&[Type::int(64)]);
9132 let wide = cast(&mut source, block, Opcode::SIToFP, args[0], long_double());
9133 let back =
9134 cast(&mut source, block, Opcode::FPTrunc, wide, Type::float(rucc_ir::Float::F64));
9135 Builder::new(&mut source, block).ret(&[back]);
9136
9137 // `double f(long n) { long double x = n; return x; }`. `fild` is the same push at another
9138 // format, so the conversion is the load and there is no instruction that converts.
9139 let text = lower(&mut names, &source);
9140 assert!(text.contains("x64.mov_mr_64 %0, [%1]"), "{text}");
9141 assert!(text.contains("x64.fild_ll [%1]"), "{text}");
9142 }
9143
9144 #[test]
9145 fn a_long_double_becoming_an_integer_cuts_towards_zero_with_the_control_word() {
9146 let (mut names, mut source, block, args) = blank(&[Type::float(rucc_ir::Float::F64)]);
9147 let wide = cast(&mut source, block, Opcode::FPExt, args[0], long_double());
9148 let whole = cast(&mut source, block, Opcode::FPToSI, wide, Type::int(32));
9149 Builder::new(&mut source, block).ret(&[whole]);
9150
9151 // The one conversion here with no single instruction behind it. C cuts towards zero and
9152 // the unit rounds the way its control word says, so the word is saved, ORed with the two
9153 // bits that mean truncate, loaded, used and put back. Nine instructions for what `fisttp`
9154 // does in one, and `spec/10-backend.md` section 10.8 says why that one is not used.
9155 let text = lower(&mut names, &source);
9156 let group: Vec<&str> = text
9157 .lines()
9158 .map(str::trim)
9159 .filter(|line| line.starts_with("x64.f") || line.contains("_16"))
9160 .collect();
9161 assert_eq!(
9162 group,
9163 [
9164 "x64.fld_l [%1]",
9165 "x64.fstp_t [%2]",
9166 "x64.fnstcw [%5]",
9167 "%6:gpr = x64.mov_rm_16 [%5]",
9168 "%7:gpr(reuse 1) = x64.or_ri_16 %6, 3072",
9169 "x64.mov_mr_16 %7, [%5 + 2]",
9170 "x64.fldcw [%5 + 2]",
9171 "x64.fld_t [%3]",
9172 "x64.fistp_l [%4]",
9173 "x64.fldcw [%5]",
9174 ],
9175 "{text}"
9176 );
9177 }
9178
9179 #[test]
9180 fn a_long_double_is_read_and_written_as_the_bits_it_already_is() {
9181 let (mut names, mut source, block, args) = blank(&[Type::PTR, Type::PTR]);
9182 let mut build = Builder::new(&mut source, block);
9183 let value = build.load(long_double(), args[0], plain(), Flags::default());
9184 build.store(value, args[1], plain(), Flags::default());
9185 build.ret(&[]);
9186
9187 // `void f(long double *a, long double *b) { *b = *a; }`. A copy is a push and a pop at the
9188 // format the value is already in, which neither converts nor looks: a signalling NaN stays
9189 // one and nothing is raised, which is the whole of what makes it a copy.
9190 let text = lower(&mut names, &source);
9191 let group: Vec<&str> =
9192 text.lines().map(str::trim).filter(|line| line.starts_with("x64.f")).collect();
9193 assert_eq!(
9194 group,
9195 ["x64.fld_t [%0]", "x64.fstp_t [%2]", "x64.fld_t [%3]", "x64.fstp_t [%1]"],
9196 "{text}"
9197 );
9198 }
9199
9200 /// Two `long double` values, from two `double` parameters, and the instructions that made
9201 /// them, which every test below this one throws away.
9202 fn two_long_doubles(source: &mut Func, block: Block, args: &[Value]) -> (Value, Value) {
9203 let left = cast(source, block, Opcode::FPExt, args[0], long_double());
9204 let right = cast(source, block, Opcode::FPExt, args[1], long_double());
9205 (left, right)
9206 }
9207
9208 /// The x87 instructions of a function, in order, with everything else dropped.
9209 fn stack_only(text: &str) -> Vec<&str> {
9210 text.lines().map(str::trim).filter(|line| line.contains("x64.f")).collect()
9211 }
9212
9213 /// The two frame slots the last two addresses of a function were taken of, which in a
9214 /// comparison are the two operands in the order they go on the stack.
9215 fn pushed(out: &Lowered) -> Vec<usize> {
9216 let taken: Vec<usize> = out.stack.addresses.iter().map(|&(_, local)| local).collect();
9217 taken[taken.len() - 2..].to_vec()
9218 }
9219
9220 #[test]
9221 fn adding_two_long_doubles_pushes_both_and_leaves_the_answer_in_a_slot() {
9222 let f64 = Type::float(rucc_ir::Float::F64);
9223 let (mut names, mut source, block, args) = blank(&[f64, f64]);
9224 let (left, right) = two_long_doubles(&mut source, block, &args);
9225 let sum =
9226 Builder::new(&mut source, block).binary(Opcode::FAdd, left, right, Flags::default());
9227 let back = cast(&mut source, block, Opcode::FPTrunc, sum, f64);
9228 Builder::new(&mut source, block).ret(&[back]);
9229
9230 // `double f(double a, double b) { return (long double) a + (long double) b; }`. The last
9231 // four lines are the add: both operands pushed, the instruction that names neither of
9232 // them because they are the top two of a stack, and the answer taken off into its slot.
9233 let text = lower(&mut names, &source);
9234 assert_eq!(
9235 stack_only(&text),
9236 [
9237 "x64.fld_l [%2]",
9238 "x64.fstp_t [%3]",
9239 "x64.fld_l [%4]",
9240 "x64.fstp_t [%5]",
9241 "x64.fld_t [%6]",
9242 "x64.fld_t [%7]",
9243 "x64.fadd_p",
9244 "x64.fstp_t [%8]",
9245 "x64.fld_t [%9]",
9246 "x64.fstp_l [%10]",
9247 ],
9248 "{text}"
9249 );
9250 }
9251
9252 #[test]
9253 fn a_subtraction_pushes_the_left_operand_first_and_asks_for_the_att_spelling() {
9254 let f64 = Type::float(rucc_ir::Float::F64);
9255 let (mut names, mut source, block, args) = blank(&[f64, f64]);
9256 let (left, right) = two_long_doubles(&mut source, block, &args);
9257 let less =
9258 Builder::new(&mut source, block).binary(Opcode::FSub, left, right, Flags::default());
9259 let back = cast(&mut source, block, Opcode::FPTrunc, less, f64);
9260 Builder::new(&mut source, block).ret(&[back]);
9261
9262 // The left one goes on first, so it ends up under the right one, and the answer wanted is
9263 // the one below minus the top. In AT&T that is `fsubrp`, since `fsubp` there is `DE E0+i`
9264 // and computes the other one. The `r` says which spelling this is and not which order the
9265 // pushes were in. `crates/rucc/tests/x87.rs` is what says the answer is right, because a
9266 // name is what got this wrong the first time.
9267 let text = lower(&mut names, &source);
9268 assert_eq!(
9269 &stack_only(&text)[4..8],
9270 ["x64.fld_t [%6]", "x64.fld_t [%7]", "x64.fsubr_p", "x64.fstp_t [%8]"],
9271 "{text}"
9272 );
9273 }
9274
9275 #[test]
9276 fn negating_a_long_double_turns_the_sign_over_and_reads_nothing() {
9277 let f64 = Type::float(rucc_ir::Float::F64);
9278 let (mut names, mut source, block, args) = blank(&[f64]);
9279 let wide = cast(&mut source, block, Opcode::FPExt, args[0], long_double());
9280 let flipped = Builder::new(&mut source, block).unary(Opcode::FNeg, wide, long_double());
9281 let back = cast(&mut source, block, Opcode::FPTrunc, flipped, f64);
9282 Builder::new(&mut source, block).ret(&[back]);
9283
9284 // `fchs` and not a subtraction from zero, which would give a different answer at a negative
9285 // zero and would signal at a NaN. It does not read the value as a number at all.
9286 let text = lower(&mut names, &source);
9287 assert_eq!(
9288 &stack_only(&text)[2..5],
9289 ["x64.fld_t [%3]", "x64.fchs", "x64.fstp_t [%4]"],
9290 "{text}"
9291 );
9292 }
9293
9294 #[test]
9295 fn comparing_two_long_doubles_puts_the_left_one_on_top() {
9296 let f64 = Type::float(rucc_ir::Float::F64);
9297 let (mut names, mut source, block, args) = blank(&[f64, f64]);
9298 let (left, right) = two_long_doubles(&mut source, block, &args);
9299 let mut build = Builder::new(&mut source, block);
9300 build.fcmp(FloatPred::Ogt, left, right, Flags::default());
9301 build.ret(&[]);
9302
9303 // `a > b`. `fucomip` asks about the top of the stack against what is under it, so the
9304 // operand the predicate is about has to go on last, which is the other way round from the
9305 // arithmetic above. The pop that clears the loser and the byte that reads the flags are
9306 // both inside the one opcode.
9307 let out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
9308 .expect("every instruction is written");
9309 let slots = pushed(&out);
9310 assert_eq!(slots, [2, 1], "the right operand goes on first and the left one on top");
9311 let text = mir::print_func(&out.func, &names, ®S);
9312 assert_eq!(
9313 &stack_only(&text)[4..],
9314 ["x64.fld_t [%6]", "x64.fld_t [%7]", "%8:gpr = x64.fucomip_set_a"],
9315 "{text}"
9316 );
9317 }
9318
9319 #[test]
9320 fn a_comparison_that_the_machine_has_backwards_swaps_the_two_pushes() {
9321 let f64 = Type::float(rucc_ir::Float::F64);
9322 let (mut names, mut source, block, args) = blank(&[f64, f64]);
9323 let (left, right) = two_long_doubles(&mut source, block, &args);
9324 let mut build = Builder::new(&mut source, block);
9325 build.fcmp(FloatPred::Olt, left, right, Flags::default());
9326 build.ret(&[]);
9327
9328 // `a < b` is `b > a` and this machine has the one condition, so the same opcode runs with
9329 // the operands the other way round. The same trade the vector rules make, and it has to
9330 // be the same one: a `long double` comparison that picked a different condition from the
9331 // `double` comparison of the same two numbers would be wrong at exactly the unordered
9332 // cases the two conditions differ on.
9333 //
9334 // Which slot each push names is the whole of the difference from the test above, and the
9335 // text does not show it, since an address in a frame is a `lea` with nothing in it until
9336 // `finish` has the numbers. So the slots are what is read here.
9337 let out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
9338 .expect("every instruction is written");
9339 let slots = pushed(&out);
9340 assert_eq!(slots, [1, 2], "the left operand goes on first and the right one on top");
9341 let text = mir::print_func(&out.func, &names, ®S);
9342 assert_eq!(
9343 &stack_only(&text)[4..],
9344 ["x64.fld_t [%6]", "x64.fld_t [%7]", "%8:gpr = x64.fucomip_set_a"],
9345 "{text}"
9346 );
9347 }
9348
9349 #[test]
9350 fn an_ordered_equal_needs_a_second_byte_to_put_the_two_conditions_together() {
9351 let f64 = Type::float(rucc_ir::Float::F64);
9352 let (mut names, mut source, block, args) = blank(&[f64, f64]);
9353 let (left, right) = two_long_doubles(&mut source, block, &args);
9354 let mut build = Builder::new(&mut source, block);
9355 build.fcmp(FloatPred::Oeq, left, right, Flags::default());
9356 build.ret(&[]);
9357
9358 // Equal and ordered are two conditions and the flags carry both, so the opcode writes a
9359 // second register as well as the one the value is in and ANDs them together. Said here by
9360 // handing it a spare, since an instruction that wrote a register nothing knew about would
9361 // be an instruction the allocator could put a live value in the way of.
9362 let text = lower(&mut names, &source);
9363 assert!(text.contains("%8:gpr, %9:gpr = x64.fucomip_set_e_and_np"), "{text}");
9364 }
9365
9366 #[test]
9367 fn a_comparison_that_is_never_asked_is_reported() {
9368 let f64 = Type::float(rucc_ir::Float::F64);
9369 let (mut names, mut source, block, args) = blank(&[f64, f64]);
9370 let (left, right) = two_long_doubles(&mut source, block, &args);
9371 let mut build = Builder::new(&mut source, block);
9372 build.fcmp(FloatPred::False, left, right, Flags::default());
9373 build.ret(&[]);
9374
9375 // Always false is a constant and not a comparison, so there is no condition to pick and
9376 // nothing here folds it into one: an instruction that quietly agreed with it would hide
9377 // that the optimizer left a comparison in that it should have taken out.
9378 let failed = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
9379 .expect_err("no condition is always false");
9380 assert_eq!(failed.to_string(), "no rule lowers a `fcmp` producing a `i1`");
9381 }
9382
9383 #[test]
9384 fn a_long_double_constant_is_the_bits_of_it_put_where_the_value_lives() {
9385 let (mut names, mut source, block, args) = blank(&[Type::PTR]);
9386 let mut build = Builder::new(&mut source, block);
9387 // `1.5L`, which is the leading bit and one more of significand, and an exponent of zero.
9388 let one_and_a_half = build.fconst(long_double(), 0x3fff_c000_0000_0000_0000);
9389 build.store(one_and_a_half, args[0], plain(), Flags::default());
9390 build.ret(&[]);
9391
9392 // No x87 instruction at all. A slot holding one of these is the value, so a constant is
9393 // its ten bytes written where the value lives, and whatever reads it does the `fld`.
9394 let text = lower(&mut names, &source);
9395 assert!(text.contains("x64.mov_ri_64 -4611686018427387904"), "{text}");
9396 assert!(text.contains("x64.mov_ri_16 16383"), "{text}");
9397 assert!(text.contains("x64.mov_mr_16 %3, [%1 + 8]"), "{text}");
9398 // The six bytes above the ten are the padding that makes the type sixteen wide, and they
9399 // are unspecified rather than zero, so nothing writes them.
9400 assert_eq!(text.matches("x64.mov_mr").count(), 2, "{text}");
9401 }
9402
9403 #[test]
9404 fn a_negative_long_double_constant_keeps_the_bit_above_its_exponent() {
9405 let (mut names, mut source, block, args) = blank(&[Type::PTR]);
9406 let mut build = Builder::new(&mut source, block);
9407 let minus = build.fconst(long_double(), 0xbfff_c000_0000_0000_0000);
9408 build.store(minus, args[0], plain(), Flags::default());
9409 build.ret(&[]);
9410
9411 // `-1.5L`. The sign is the top bit of the two byte half, so the immediate that half is put
9412 // in a register with is above the signed range of sixteen bits and has to stay there: read
9413 // as a number it would be negative, and it is not a number, it is two bytes.
9414 let text = lower(&mut names, &source);
9415 assert!(text.contains("x64.mov_ri_16 49151"), "{text}");
9416 }
9417
9418 #[test]
9419 fn a_long_double_crosses_an_edge_as_an_address_and_is_copied_where_it_lands() {
9420 let (mut names, mut source, block, args) = blank(&[Type::float(rucc_ir::Float::F64)]);
9421 let wide = cast(&mut source, block, Opcode::FPExt, args[0], long_double());
9422 let next = source.create_block();
9423 let param = source.append_param(next, long_double());
9424 Builder::new(&mut source, block).jump(next, &[wide]);
9425 Builder::new(&mut source, next).ret(&[param]);
9426
9427 // What the edge carries is the address of the slot the value is already in, which is an
9428 // ordinary register the allocator has an opinion about. The block on the other side copies
9429 // the sixteen bytes into a slot of its own before anything reads them, so a second edge
9430 // handing over a second address would still leave one place for a reader to look.
9431 let text = lower(&mut names, &source);
9432 let second: Vec<&str> = text
9433 .lines()
9434 .skip_while(|line| !line.starts_with("block1"))
9435 .skip(1)
9436 .take(3)
9437 .map(str::trim)
9438 .collect();
9439 assert_eq!(
9440 second,
9441 ["x64.fld_t [%4]", "%5:gpr = x64.lea_64 [$rsp]", "x64.fstp_t [%5]"],
9442 "{text}"
9443 );
9444 }
9445
9446 #[test]
9447 fn more_long_doubles_at_a_block_than_the_stack_is_deep_are_reported() {
9448 let f64 = Type::float(rucc_ir::Float::F64);
9449 let (mut names, mut source, block, args) = blank(&[f64]);
9450 let wide = cast(&mut source, block, Opcode::FPExt, args[0], long_double());
9451 let next = source.create_block();
9452 let params: Vec<Value> =
9453 (0..=X87_DEPTH).map(|_| source.append_param(next, long_double())).collect();
9454 let carried: Vec<Value> = params.iter().map(|_| wide).collect();
9455 Builder::new(&mut source, block).jump(next, &carried);
9456 Builder::new(&mut source, next).ret(&[params[0]]);
9457
9458 // The copies go through the x87 stack so that every one of them is read before any of them
9459 // is written, which is what makes a block that swaps two of these right. Nine of them do
9460 // not fit on the stack, and copying the ninth before or after the rest is the order that
9461 // could be wrong, so it is refused instead.
9462 let failed = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
9463 .expect_err("nine do not fit on the stack");
9464 assert_eq!(
9465 failed.to_string(),
9466 "block1 takes 9 parameters of type `f80` and only 8 can cross an edge at once"
9467 );
9468 assert_eq!(failed.inst(), None);
9469 }
9470}